Skip to main content
Anchor to InventoryBinItemSortKeys

InventoryBinItemSortKeys

enum

The set of valid sort keys for the InventoryBinItem query.

Sort the bins the inventory item is assigned to first, then by bin name.

Sort by the bin_name value.

Sort by the quantity value.

Sort by the updated_at value.


Was this section helpful?

•ARGUMENT

A physical container (bin) at a location where inventory is stored.


Note

This object is available only in the unstable API version and to development stores that have enabled the Physical inventory feature preview.


•ARGUMENT

An inventory item represents the inventory for a product variant. It holds the stock keeping unit (SKU), whether quantities are tracked, shipping requirements, and customs information.

Use the inventoryLevels field to get the inventory level for each location that stocks the item, and the level's quantities field to read its inventory quantities by name. Quantity names represent the inventory states that merchants use to track inventory.

Learn more about inventory object relationships.

•ARGUMENT

The quantities of an inventory item at a location.

onHand is summed across every bin at the location. available, committed, and incoming are location-level quantities and aren't tracked per bin.


Note

This object is available only in the unstable API version and to development stores that have enabled the Physical inventory feature preview.



Was this section helpful?