Graph API Version
Product Group
You use product groups to distinguish products that are identical but have variations such as color, material, size or pattern.
They make it easier for customers to find additional colors, styles, or patterns of a particular product. Product Groups are the way you group all product variants.
Submit Variant Data
- Ensure you have a separate product for each variant, each with their own unique ID.
- Each variant must have have the same
item_group_iddefined in the product feed - You must supply a unique image for items that differ by
color,material, orpattern. - The
linkattribute should lead to a landing page where that particular variant is preselected.
Reading
A Product Group object
Parameters
This endpoint doesn't have any parameters.Fields
| Field | Description |
|---|---|
idnumeric string | ID of the product group |
product_catalog | Product catalog this product group belongs to |
retailer_idstring | Retailer ID of the product group |
variants | The list of product variants and their options in the order theyneed to be displayed on the UI |
Edges
| Edge | Description |
|---|---|
Products that belong to this product group |
Error Codes
| Error | Description |
|---|---|
| 100 | Invalid parameter |
Creating
You can't perform this operation on this endpoint.
Updating
You can update a ProductGroup by making a POST request to
/{product_group_id}.Parameters
| Parameter | Description |
|---|---|
default_product_idnumeric string or integer | The default product to show from the group of products |
variantslist<Object> | The list of product variants and their options in the order they need to be displayed on the UI |
Return Type
This endpoint supports read-after-write and will read the node to which you POSTed.
Struct {}
success: bool, Error Codes
| Error | Description |
|---|---|
| 200 | Permissions error |
| 100 | Invalid parameter |
Deleting
You can delete a ProductGroup by making a DELETE request to
/{product_group_id}.Parameters
Return Type
Struct {}
success: bool, Error Codes
| Error | Description |
|---|---|
| 100 | Invalid parameter |
| 200 | Permissions error |