Inventory
Requires access scope, or access scope for the Physical inventory feature preview. Also: The user must have permission to view inventory counts.
Represents an inventory count operation for auditing and adjusting stock levels at a specific location.
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
- closedAt (DateTime)
- compareDigest (String!)
- createdAt (DateTime!)
- createdBy (StaffMember)
- id (ID!)
- lineItems (InventoryCountLineItemConnection!)
- lineItemsCount (Count)
- locationSnapshot (LocationSnapshot!)
- name (String!)
- note (String)
- plannedAt (DateTime)
- status (InventoryCountStatus!)
- tags ([String!]!)
- title (String)
- Anchor to closedAtclosed•Date
At Time The date and time the count was closed. A count is closed when it's completed or canceled.
- Anchor to compareDigestcompare•String!
Digest non-null The data stored in the resource, represented as a digest.
- Anchor to createdAtcreated•Date
At Time! non-null The date and time the count was created.
- Anchor to createdBycreated•Staff
By Member The staff member who created the count.
Show fields
- •ID!non-null
A globally-unique ID.
- Anchor to lineItemsline•Inventory
Items Count Line Item Connection! non-null The line items included in this count.
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 reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
Arguments
- Anchor to lineItemsCountline•Count
Items Count The number of line items in this count.
Show fields
- Anchor to locationSnapshotlocation•Location
Snapshot Snapshot! non-null A snapshot of the count's location.
Show fields
- Anchor to namename•String!non-null
The display name for the count.
- Anchor to notenote•String
A note about the count.
- Anchor to plannedAtplanned•Date
At Time The planned date for the count.
- Anchor to statusstatus•Inventory
Count Status! non-null The derived status of the count.
Show enum values
- •[String!]!non-null
A list of tags associated with the count.
- Anchor to titletitle•String
The title of the count.
Anchor to QueriesQueries
- inventoryCount (InventoryCount)
- inventoryCounts (InventoryCountConnection!)
- •query
Returns an InventoryCount object by ID.
Show fields
- •ID!required
The ID of the inventory count.
Arguments
- •ID!
- •query
Returns a paginated list of inventory counts for the shop.
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 reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
Arguments
Anchor to MutationsMutations
- inventoryCountAddItems (InventoryCountAddItemsPayload)
- inventoryCountCancel (InventoryCountCancelPayload)
- inventoryCountComplete (InventoryCountCompletePayload)
- inventoryCountCreate (InventoryCountCreatePayload)
- inventoryCountRecordObservations (InventoryCountRecordObservationsPayload)
- inventoryCountRemoveItems (InventoryCountRemoveItemsPayload)
- inventoryCountRequestReview (InventoryCountRequestReviewPayload)
- inventoryCountUpdateLocation (InventoryCountUpdateLocationPayload)
- inventoryCountUpdateMetadata (InventoryCountUpdateMetadataPayload)
- •mutation
Adds inventory items to an existing inventory count.
Show payload
- •ID!required
The ID of the inventory count.
- Anchor to lineItemsline•[Inventory
Items Count Line Item Input!]! required The line items to add to the count.
Show input fields
Arguments
- •ID!
- •mutation
Cancels an open inventory count. This operation is irreversible.
Show payload
- •ID!required
The ID of the inventory count.
Arguments
- •ID!
- •mutation
Marks an inventory count as completed and applies any inventory adjustments based on the counted quantities. This operation is irreversible.
Show payload
- Anchor to compareDigestcompare•String
Digest The
value obtained from a previous query. Provide this with updates to ensure the resource is modified safely.- •ID!required
The ID of the inventory count.
Arguments
- •mutation
Creates an inventory count for auditing and adjusting stock levels at a specific location.
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 completecomplete•BooleanDefault:false
When true, the count is created already completed and its results are posted immediately and generate inventory adjustments. Defaults to false, which creates an open count to be worked on.
- Anchor to lineItemsline•[Inventory
Items Count Line Item Input!] Default:[] The line items to include in the count.
Show input fields
- Anchor to locationIdlocation•ID!
Id required The ID of the location for the count.
- Anchor to metadatametadata•Inventory
Count Metadata Input The metadata associated with the count.
Show input fields
Arguments
- •mutation
Records observations for items in an inventory count as counted quantities. Each observation input identifies an inventory item by its ID; if the item is not yet on the count, a line is created for it. Each delta quantity for an observation adds to the item's total quantity.
Show payload
- •ID!required
The ID of the inventory count.
- Anchor to observationsobservations•[Inventory
Count Observation Input!]! required The observations to record.
Show input fields
Arguments
- •ID!
- •mutation
Removes line items from an existing inventory count.
Show payload
- Anchor to compareDigestcompare•String
Digest The
value obtained from a previous query. Provide this with updates to ensure the resource is modified safely.- •ID!required
The ID of the inventory count.
- Anchor to lineItemIdsline•[ID!]!
Item Ids required The IDs of the line items to remove from the count.
Arguments
- •mutation
Requests or withdraws a review of an inventory count. Requesting a review marks the count as ready to be reviewed; withdrawing it removes that request.
Show payload
- •ID!required
The ID of the inventory count.
- Anchor to requestedrequested•Boolean!required
Whether a review is requested. Pass
trueto request a review andfalseto withdraw the request.
Arguments
- •ID!
- •mutation
Changes the location of an inventory count. Only allowed while the count is open and has no line items.
Show payload
- •ID!required
The ID of the inventory count.
- Anchor to locationIdlocation•ID!
Id required The ID of the location to move the count to.
Arguments
- •ID!
- •mutation
Updates metadata for an inventory count.
Show payload
- •ID!required
The ID of the inventory count.
- Anchor to metadatametadata•Inventory
Count Metadata Input! required The metadata to set on the count.
Show input fields
Arguments
- •ID!