Skip to main content

Queries

  • product — Fetch a single product by its id.
  • productFamilies — List product families.
  • productFamily — Fetch a single product family by its id.
  • products — List products, optionally filtered by product family.

Mutations

Objects

  • Attribute — A typed attribute defined by the merchant and attached to a product or product family.
  • Dimensions — A product’s length, width, and height expressed in a single shared unit.
  • Product — A specific sellable product (a variant under a product family).
  • ProductFamily — A merchant catalog item — a group of related products (variants).
  • ProductFamilyImage — An image attached to a product family.
  • ProductFamilyOption — A variant option (e.g. Size, Color) for a product family, with its allowed values.
  • ProductImage — An image attached to a specific product (variant).
  • ProductOptionValue — A variant’s selected value for one of its family’s options (e.g. Size: M).
  • Weight — A weight as a { value, unit } pair, e.g. { value: 1.5, unit: KILOGRAM }.

Input objects

Enums

  • AttributeType — The data type of a merchant-defined attribute. Determines the JSON shape of the attribute’s value (documented on each enum value).
  • DimensionUnit — A unit of length used to express a product’s dimensions.
  • ProductFamilySortKey — A field this list can be ordered by; pass to the list’s orderBy argument and pair with reverse to flip direction.
  • ProductSortKey — A field this list can be ordered by; pass to the list’s orderBy argument and pair with reverse to flip direction.
  • WeightUnit — A unit of mass used to express a product’s weight.