Marketing 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_id defined in the product feed
  • You must supply a unique image for items that differ by color, material, or pattern.
  • The link attribute should lead to a landing page where that particular variant is preselected.

Reading

A Product Group object

Permissions

Developers usually request these permissions for this endpoint:

Marketing Apps
  • manage_pages
  • pages_show_list
  • business_management
Page management Apps
No data
Other Apps
No data

Parameters

This endpoint doesn't have any parameters.

Fields

FieldDescription
id
numeric string

ID of the product group

Default
product_catalog
ProductCatalog

Product catalog this product group belongs to

retailer_id
string

Retailer ID of the product group

Default
variants
list<ProductVariant>

The list of product variants and their options in the order theyneed to be displayed on the UI

Edges

EdgeDescription

products

Products that belong to this product group

Validation Rules

ErrorDescription
100Invalid parameter
200Permissions error

Creating

You can make a POST request to product_groups edge from the following paths:
When posting to this edge, a ProductGroup will be created.

Permissions

Developers usually request these permissions for this endpoint:

Marketing Apps
  • ads_management
  • manage_pages
Page management Apps
  • manage_pages
  • pages_show_list
Other Apps
No data

Parameters

NameDescription
retailer_id
string

Retailer defined unique identifier for this item

Required
variants
list<Object>

The list of product variants and their options in the order they need to be displayed on the UI

product_field
string

Product field

Required
label
string

Label

Required
options
list<string>

Options

Required

Return Type

This endpoint supports read-after-write and will read the node represented by id in the return type.
Struct {
id: numeric string,
}
You may perform a POST request to the following edge from this node:

Validation Rules

ErrorDescription
100Invalid parameter
200Permissions error

Updating

You can update a ProductGroup by making a POST request to /{product_group_id}.

Permissions

Developers usually request these permissions for this endpoint:

Marketing Apps
  • manage_pages
Page management Apps
  • manage_pages
  • pages_show_list
Other Apps
No data

Parameters

NameDescription
default_product_id
numeric string or integer

The default product to show from the group of products

variants
list<Object>

The list of product variants and their options in the order they need to be displayed on the UI

product_field
string

Product field

Required
label
string

Label

Required
options
list<string>

Options

Required

Return Type

This endpoint supports read-after-write and will read the node to which you POSTed.
Struct {
success: bool,
}

Validation Rules

ErrorDescription
100Invalid parameter
200Permissions error

Deleting

You can delete a ProductGroup by making a DELETE request to /{product_group_id}.

Permissions

Developers usually request these permissions for this endpoint:

Marketing Apps
  • manage_pages
Page management Apps
  • manage_pages
Other Apps
No data

Parameters

This endpoint doesn't have any parameters.

Return Type

Struct {
success: bool,
}

Validation Rules

ErrorDescription
100Invalid parameter
200Permissions error