The ProductVariantGroupOption is the individual selectable options in a product variant group such as Small or Blue.
DeleteProductVariantGroupOption
This service is used to delete a ProductVariantGroupOption object.
Request Parameters
| Node |
Required |
Data Type |
Description |
| productVariantGroupOptionID |
Yes |
Integer |
The object identifier. |
Return Data
None
GetProductVariantGroupOption
This service is used to query the ProductVariantGroupOption object.
Request Parameters
| Node |
Required |
Data Type |
Description |
| productVariantGroupOptionID |
Yes |
Integer |
The object identifier. |
Return Data
| Node |
Data Type |
Description |
| productVariantGroupOption |
XML |
Container node. |
| colorCode |
String |
The color code used if this group option is a color swatch type. |
| createDate |
DateTime |
Creation date. |
| displayOrder |
Integer |
Sort order for display. |
| imageData |
String |
The image data in Base64 encoding if this group option is an image swatch type. |
| imageFile |
String |
The file name saved to disk if this group option is an image swatch type. |
| name |
XML Locale |
Localized name. |
| productVariantGroupID |
Integer |
The reference ProductVariantGroup identifier this product variant group option belongs to. |
| productVariantGroupOptionID |
Integer |
The object identifier. |
| productVariantGroupOptionKey |
String |
A unique key that can be used to uniquely identify this object. This could be a short meaningful text or simply a GUID. |
| updateDate |
DateTime |
Update date. |
GetProductVariantGroupOptions
This service is used to get all the ProductVariantGroupOption objects belonging to the ProductVariantGroup.
Request Parameters
| Node |
Required |
Data Type |
Description |
| count |
No |
Boolean |
Specify if return data should include total number of records found. |
| productVariantGroupID |
Yes |
Integer |
The ProductVariantGroup object identifier. |
| skip |
No |
Integer |
The number of records to skip over for paging purposes. |
| take |
No |
Integer |
The number of records to return for paging purposes. |
Return Data
| Node |
Data Type |
Description |
| totalCount |
Integer |
Number of records found. |
| productVariantGroupOptions |
XML |
Container node |
| productVariantGroupOption |
XML |
Zero or more productVariantGroupOption nodes with same data structure as GetProductVariantGroupOption service return data. |
InsertProductVariantGroupOption
This service is used to create a new ProductVariantGroupOption object.
Request Parameters
| Node |
Required |
Data Type |
Description |
| colorCode |
No |
String |
The color code used if this group option is a color swatch type. |
| displayOrder |
Yes |
Integer |
Sort order for display. |
| imageData |
No |
String |
The image data in Base64 encoding if this group option is an image swatch type. |
| imageFile |
No |
String |
The file name saved to disk if this group option is an image swatch type. |
| name |
No |
XML Locale |
Localized name. |
| productVariantGroupID |
Yes |
Integer |
The reference ProductVariantGroup identifier this product variant group belongs to. |
| productVariantGroupOptionKey |
Yes |
String |
A unique key that can be used to uniquely identify this object. This could be a short meaningful text or simply a GUID. |
Return Data
Same as GetProductVariantGroupOption service return data.
UpdateProductVariantGroupOption
This service is used to update a ProductVariantGroupOption object.
Request Parameters
| Node |
Required |
Data Type |
Description |
| colorCode |
No |
String |
|
| displayOrder |
Yes |
Integer |
Sort order for display. |
| helpText |
No |
XML Locale |
Localized help text. |
| imageData |
No |
String |
The image data in Base64 encoding if this group option is an image swatch type. |
| imageFile |
No |
String |
The file name saved to disk if this group option is an image swatch type. |
| name |
No |
XML Locale |
Localized name. |
| productVariantGroupID |
Yes |
Integer |
The reference ProductVariantGroup identifier this product variant group belongs to. |
| productVariantGroupOptionID |
Yes |
Integer |
The object identifier. |
| productVariantGroupOptionKey |
Yes |
String |
A unique key that can be used to uniquely identify this object. This could be a short meaningful text or simply a GUID. |
Return Data
Same as GetProductVariantGroupOption service return data.