A product group aggregates products that share an option or modifier (the group's grouping customization). Each member product represents a single choice of that customization, such as a different color of the same item.
Product groups power the option-based product gallery: each variant is displayed as its own gallery card, and sibling members are linked together on the product page so site visitors can switch between choices.
Ordered list of choice IDs that defines the display order of members in the storefront. Members are sorted in members according to this order. Choice IDs not listed here are appended after the listed ones, sorted alphabetically by choice name, with choice ID as a tiebreaker.
Date and time the product group was created.
Custom field data for the product group.
Extended fields must be configured in the app dashboard before they can be accessed with API calls.
Details of the customization referenced by groupingCustomizationId, such as its name and render type.
Returned only when "GROUPING_CUSTOMIZATION" is passed in the fields array of the request.
ID of the shared option or modifier (customization) that defines the grouping attribute. For example, the ID of the "Color" option.
Can't be changed after creation.
Unique human-friendly identifier for the product group, useful for external catalog sync systems that need a stable, externally managed identifier.
Unlike the auto-generated id, the handle can be set when creating a product group. Unique per site. If not provided during creation, a random UUID is generated. Can't be changed after creation.
Product group ID.
Product Group media.
Members of the product group, sorted according to choiceOrder. Each member entry represents a product, its derived choice for the group's grouping customization, and its membership status.
Read-only. To add or remove members, call Assign Products to Product Group or Unassign Products from Product Group.
Product group name. For example, "Classic T-Shirt".
Revision number, which increments by 1 each time the product group is updated. To prevent conflicting changes, the current revision must be passed when updating the product group.
Ignored when creating a product group.
Tags assigned to the product group. Use tags to organize and filter product groups in queries.
Date and time the product group was last updated.