The ProductVariantGroup is used to group related variants such as Size or Color.
DeleteProductVariantGroup
This service is used to delete a ProductVariantGroup object.
Request Parameters
| Node |
Required |
Data Type |
Description |
| productVariantGroupID |
Yes |
Integer |
The object identifier. |
Return Data
None
GetProductVariantGroup
This service is used to query the ProductVariantGroup object.
Request Parameters
| Node |
Required |
Data Type |
Description |
| productVariantGroupID |
Yes |
Integer |
The object identifier. |
Return Data
| Node |
Data Type |
Description |
| productVariantGroup |
XML |
Container node. |
| createDate |
DateTime |
Creation date. |
| displayOrder |
Integer |
Sort order for display. |
| fieldType |
Integer |
The type of control to display. DropDownList = 1, RadioButtonList = 2, ColorPicker = 3, ImageSwatch = 4 |
| helpText |
XML Locale |
Localized help text. |
| name |
XML Locale |
Localized name. |
| productID |
Integer |
The reference Product identifier this product variant group belongs to. |
| productVariantGroupID |
Integer |
The object identifier. |
| productVariantGroupKey |
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. |
GetProductVariantGroups
This service is used to get all the ProductVariantGroup objects belonging to the Product.
Request Parameters
| Node |
Required |
Data Type |
Description |
| count |
No |
Boolean |
Specify if return data should include total number of records found. |
| productID |
Yes |
Integer |
The Product 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. |
| productVariantGroups |
XML |
Container node |
| productVariantGroup |
XML |
Zero or more productVariantGroup nodes with same data structure as GetProductVariantGroup service return data. |
InsertProductVariantGroup
This service is used to create a new ProductVariantGroup object.
Request Parameters
| Node |
Required |
Data Type |
Description |
| displayOrder |
Yes |
Integer |
Sort order for display. |
| fieldType |
Yes |
Integer |
The type of control to display. DropDownList = 1, RadioButtonList = 2, ColorPicker = 3, ImageSwatch = 4 |
| helpText |
No |
XML Locale |
Localized help text. |
| name |
Yes |
XML Locale |
Localized name. |
| productID |
Yes |
Integer |
The reference Product identifier this product variant group belongs to. |
| productVariantGroupKey |
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 GetProductVariantGroup service return data.
UpdateProductVariantGroup
This service is used to update a ProductVariantGroup object.
Request Parameters
| Node |
Required |
Data Type |
Description |
| displayOrder |
Yes |
Integer |
Sort order for display. |
| fieldType |
Yes |
Integer |
The type of control to display. DropDownList = 1, RadioButtonList = 2, ColorPicker = 3, ImageSwatch = 4 |
| helpText |
No |
XML Locale |
Localized help text. |
| name |
Yes |
XML Locale |
Localized name. |
| productID |
Yes |
Integer |
The reference Product identifier this product variant group belongs to. |
| productVariantGroupID |
Yes |
Integer |
The object identifier. |
| productVariantGroupKey |
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 GetProductVariantGroup service return data.