Inventory
Requires access scope. Also: The shop must have access to the physical inventory feature preview.
A physical container (bin) at a location where inventory is stored.
This object is available only in the unstable API version and to development stores that have enabled the Physical inventory feature preview.
This object is available only in the unstable API version and to development stores that have enabled the Physical inventory feature preview.
Note: This object is available only in the unstable API version and to development stores that have enabled the <a href="https://shopify.dev/changelog/physical-inventory-feature-preview">Physical inventory feature preview</a>.
Anchor to FieldsFields
- barcode (String)
- id (ID!)
- inventoryBinItems (InventoryBinItemConnection)
- isAvailableForSale (Boolean!)
- isDefault (Boolean!)
- name (String!)
- note (String)
- Anchor to barcodebarcode•String
The barcode of the bin. Unique within its location when present.
- •ID!non-null
A globally-unique ID.
- Anchor to inventoryBinItemsinventory•Inventory
Bin Items Bin Item Connection A paginated list of the inventory items stored in this bin and their quantities.
Show fields
- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to queryquery•String
A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.
Show filters
- Anchor to is_available_for_sale•boolean
Filter by whether inventory in the bin is available for sale.
is_available_for_sale:true- Anchor to is_default_bin•boolean
Filter by whether the bin is the default bin for its location.
is_default_bin:false- Anchor to quantity•integer
Filter by the on-hand quantity of the inventory item in the bin.
quantity:0quantity:>10- Anchor to updated_at•time
Filter by when the on-hand quantity of the inventory item in the bin last changed.
updated_at:>2025-01-01
Example:
Example:
Example:
Example:
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
- Anchor to sortKeysort•Inventory
Key Bin Item Sort Keys Default:BIN_NAME Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.
Show enum values
Arguments
- Anchor to isAvailableForSaleis•Boolean!
Available For Sale non-null Whether inventory in the bin is available for sale.
- Anchor to isDefaultis•Boolean!
Default non-null Whether the bin is the default bin for its location.
- Anchor to namename•String!non-null
The name of the bin. Unique within its location.
- Anchor to notenote•String
A note about the bin.
Anchor to MutationsMutations
- inventoryBinsEdit (InventoryBinsEditPayload)
- •mutation
Creates, updates and deletes inventory bins in a single atomic operation. If any operation fails, no changes are applied.
NoteThis mutation is available only in the unstable API version and to development stores that have enabled the Physical inventory feature preview.
Note:This mutation is available only in the unstable API version and to development stores that have enabled the Physical inventory feature preview.
Note: This mutation is available only in the unstable API version and to development stores that have enabled the <a href="https://shopify.dev/changelog/physical-inventory-feature-preview">Physical inventory feature preview</a>.
Show payload
- Anchor to inputinput•[Inventory
Bins Edit Input!]! required The bin operations to apply. Each entry is exactly one of
create,updateordelete.Show input fields
Arguments