How the item is built from components. Empty unless it is built from components.
Show fields
Show fields
Whether a work order builds the finished product, so the finished product is picked instead of its components.
The components the line item is built from.
Show fields
Show fields
What this component is built from, when it is itself built from components.
What a fulfillment partner needs to identify and ship this component: identity only, no pricing. Readable by the store and the 3PL that ships the group. Null when it never matched a catalog product.
The store’s catalog product for this component, when it matched one. Null when it never matched, the product was deleted, or the caller can’t read the store’s products (e.g. a 3PL). Requires
products_read.Remainder pieces the build credits back to stock. Empty unless the build cuts to size.
Show fields
Show fields
What a fulfillment partner needs to identify and ship this leftover: identity only, no pricing. Readable by the store and the 3PL that ships the group. Null when it never matched a catalog product.
The store’s catalog product for this leftover, when it matched one. Null when it never matched, the product was deleted, or the caller can’t read the store’s products (e.g. a 3PL). Requires
products_read.What a fulfillment partner needs to identify and ship this item: identity only, no pricing. Readable by the store and the 3PL that ships the group. Null when it never matched a catalog product.
Show fields
Show fields
The first (default) image for this product, if any.Requires:
inventory_readThe store’s catalog product for this item, when it matched one. Null when it never matched, the product was deleted, or the caller can’t read the store’s products (e.g. a 3PL). Requires
products_read.Show fields
Show fields
Look up a single attribute on this product by its name, if set.Requires:
products_readShow fields
Show fields
ArgumentsFields
The attribute’s value, resolved to the typed JSON form for its
type — read type to know the shape. E.g. SHORT_TEXT → a string, WEIGHT → { value, unit }, MONEY → { amount, currency }. Null if unset. See AttributeType for each type’s shape.The merchant-defined attributes set on this product.
The first (default) image for this product, if any.Requires:
products_readA paginated list of the product’s images.Requires:
products_readShow fields
Show fields
ArgumentsFields
Forward pagination cursor — returns items after it. Pass an
edges[].cursor or pageInfo.endCursor from a previous page.Backward pagination cursor — returns items before it. Pass an
edges[].cursor or pageInfo.startCursor from a previous page.Forward pagination: returns the first N items (max 100, default 25). Use with
after; mutually exclusive with last/before.Backward pagination: returns the last N items (max 100, default 25). Use with
before; mutually exclusive with first/after.The import restrictions the product trips, one per destination country and rule. Only countries of enabled markets with restriction screening on are screened, and a restriction drops off 21 days after screening last found it.Requires:
markets_readShow fields
Show fields
ArgumentsFields
Forward pagination: returns the first N import restrictions (max 100, default 25). Use with
after; mutually exclusive with last/before.Backward pagination: returns the last N import restrictions (max 100, default 25). Use with
before; mutually exclusive with first/after.Traceable inventory units for this product.Requires:
inventory_readThis product’s inventory level at a single location, if any.Requires:
inventory_readShow fields
Show fields
ArgumentsFields
A fulfillment-oriented view of the product, readable by anyone who can see this level (e.g. a 3PL). For the full product, use
product.Requires: inventory_readThe location these inventory levels are held at.Requires:
locations_readThe full product these inventory levels are for. Only readable by the account that owns the product; use
inventoryProduct otherwise.Requires: products_readPer-location inventory levels for this product.Requires:
inventory_readShow fields
Show fields
ArgumentsFields
Forward pagination cursor — returns items after it. Pass an
edges[].cursor or pageInfo.endCursor from a previous page.Backward pagination cursor — returns items before it. Pass an
edges[].cursor or pageInfo.startCursor from a previous page.Forward pagination: returns the first N items (max 100, default 25). Use with
after; mutually exclusive with last/before.Backward pagination: returns the last N items (max 100, default 25). Use with
before; mutually exclusive with first/after.Publishing per destination country where the product trips an import restriction, or has a publish override. Only countries of enabled markets with restriction screening on are screened. Null when publishing can’t be read.Requires:
markets_readShow fields
Show fields
The merchant’s override: true to publish, false to hide. Null when there is none, so
recommendedPublish applies.Whether the product is published there: the override when set, otherwise
recommendedPublish. Without an override, a market listing function can still change the outcome.Whether Redo publishes the product there when there is no override. False only when the product is restricted there and the store hides restricted products.
Whether the product counts as restricted there: it trips a BLOCKED import restriction, or an ACTION_NEEDED one that is not resolved.
Who set
publishOverride: a team member or an API token. Null when there is no override, when an automation or a change before this field set it, or when the team member has left the team.The product family this product belongs to, if any.Requires:
products_readShow fields
Show fields
Look up a single attribute on this family by its name, if set.Requires:
products_readThe first (default) image for this family, if any.Requires:
products_readA paginated list of the family’s images.Requires:
products_readShow fields
Show fields
Arguments
Forward pagination cursor — returns items after it. Pass an
edges[].cursor or pageInfo.endCursor from a previous page.Backward pagination cursor — returns items before it. Pass an
edges[].cursor or pageInfo.startCursor from a previous page.Forward pagination: returns the first N items (max 100, default 25). Use with
after; mutually exclusive with last/before.A paginated list of the products (variants) in this family.Requires:
products_readShow fields
Show fields
Arguments
Forward pagination cursor — returns items after it. Pass an
edges[].cursor or pageInfo.endCursor from a previous page.Backward pagination cursor — returns items before it. Pass an
edges[].cursor or pageInfo.startCursor from a previous page.Forward pagination: returns the first N items (max 100, default 25). Use with
after; mutually exclusive with last/before.