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_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

Parameters

This endpoint doesn't have any parameters.

Fields

FieldDescription
id
numeric string

ID of the product group

product_catalog

Product catalog this product group belongs to

retailer_id
string

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

EdgeDescription

Products that belong to this product group

Error Codes

ErrorDescription
80004There have been too many calls to this ad-account. Wait a bit and try again. For more info, please refer to https://developers.facebook.com/docs/graph-api/overview/rate-limiting.
80009There have been too many calls to this Catalog account. Wait a bit and try again. For more info, please refer to https://developers.facebook.com/docs/graph-api/overview/rate-limiting.
100Invalid parameter
115Invalid field list

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

ParameterDescription
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,
}

Error Codes

ErrorDescription
200Permissions error
100Invalid parameter
190Invalid OAuth 2.0 Access Token
415Two factor authentication required. User have to enter a code from SMS or TOTP code generator to pass 2fac. This could happen when accessing a 2fac-protected asset like a page that is owned by a 2fac-protected business manager.

Deleting

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

Parameters

ParameterDescription
deletion_method
enum {DELETE_ITEMS, ONLY_IF_EMPTY}
Default value: "ONLY_IF_EMPTY"

deletion_method

Return Type

Struct {
success: bool,
}

Error Codes

ErrorDescription
200Permissions error
100Invalid parameter