Whether a work order builds the component, so it is picked instead of its own components.
The components the component is built from.
Show fields
Show fields
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.
Show fields
Show fields
The product’s length, width, and height in a single shared unit, for box sizing.
The first (default) image for this product, if any.Requires:
inventory_readThe product’s weight, for shipping.
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.Show fields
Show fields
Look up a single attribute on this product by its name, if set.Requires:
products_readThe merchant’s unit cost for the product.
The product’s length, width, and height, expressed in a single shared unit.
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
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.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
Arguments
Forward pagination: returns the first N import restrictions (max 100, default 25). Use with
after; mutually exclusive with last/before.Traceable inventory units for this product.Requires:
inventory_readThis product’s inventory level at a single location, if any.Requires:
inventory_readPer-location inventory levels for this product.Requires:
inventory_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.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_readThe variant’s selected option values (e.g. Size: M, Color: Red), ordered by the family’s option positions.
The product’s selling price.
The product family this product belongs to, if any.Requires:
products_readThe product’s weight.
Units of the component built from its own components. The rest ship as the finished component.
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.
Show fields
Show fields
The product’s length, width, and height in a single shared unit, for box sizing.
The first (default) image for this product, if any.Requires:
inventory_readThe product’s weight, for shipping.
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.Show fields
Show fields
Look up a single attribute on this product by its name, if set.Requires:
products_readThe merchant’s unit cost for the product.
The product’s length, width, and height, expressed in a single shared unit.
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
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.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
Arguments
Forward pagination: returns the first N import restrictions (max 100, default 25). Use with
after; mutually exclusive with last/before.Traceable inventory units for this product.Requires:
inventory_readThis product’s inventory level at a single location, if any.Requires:
inventory_readPer-location inventory levels for this product.Requires:
inventory_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.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_readThe variant’s selected option values (e.g. Size: M, Color: Red), ordered by the family’s option positions.
The product’s selling price.
The product family this product belongs to, if any.Requires:
products_readThe product’s weight.