Inventory
Requires access scope.
Represents a single line item within an inventory shipment.
Anchor to FieldsFields
- acceptedQuantity (Int!)
- id (ID!)
- inventoryItem (InventoryItem)
- quantity (Int!)
- rejectedQuantity (Int!)
- unreceivedQuantity (Int!)
- Anchor to acceptedQuantityaccepted•Int!
Quantity non-null The quantity of items that were accepted in this shipment line item.
- •ID!non-null
A globally-unique ID.
- Anchor to inventoryIteminventory•Inventory
Item Item The inventory item associated with this line item.
Show fields
- Anchor to quantityquantity•Int!non-null
The quantity of items in this shipment line item.
- Anchor to rejectedQuantityrejected•Int!
Quantity non-null The quantity of items that were rejected in this shipment line item.
- Anchor to unreceivedQuantityunreceived•Int!
Quantity non-null The total quantity of units that haven't been accepted, rejected, or marked as canceled in this shipment line item.
Anchor to MutationsMutations
- inventoryShipmentAddItems (InventoryShipmentAddItemsPayload)
- inventoryShipmentUpdateItemQuantities (InventoryShipmentUpdateItemQuantitiesPayload)
- •mutation
Adds items to an inventory shipment.
CautionAs of 2026-01, this mutation supports an optional idempotency key using the
@idempotentdirective. As of 2026-04, the idempotency key is required and must be provided using the@idempotentdirective. For more information, see the idempotency documentation.Caution:As of 2026-01, this mutation supports an optional idempotency key using the
@idempotentdirective. As of 2026-04, the idempotency key is required and must be provided using the@idempotentdirective. For more information, see the idempotency documentation.Caution: As of 2026-01, this mutation supports an optional idempotency key using the <code>@idempotent</code> directive. As of 2026-04, the idempotency key is required and must be provided using the <code>@idempotent</code> directive. For more information, see the <a href="https://shopify.dev/docs/api/usage/idempotent-requests">idempotency documentation</a>.
Show payload
- •ID!required
The ID of the inventory shipment to modify.
- Anchor to lineItemsline•[Inventory
Items Shipment Line Item Input!]! required The list of line items to add to the inventory shipment.
Show input fields
Arguments
- •ID!
- •mutation
Updates items on an inventory shipment.
Show payload
- •ID!required
The ID of the inventory shipment to update item quantities.
- Anchor to itemsitems•[Inventory
Shipment Update Item Quantities Input!] Default:[] The list of line items to be updated to the shipment.
Show input fields
Arguments
- •ID!