inventory
Requires access scope. Also: The user must have permission to manage inventory.
Adds items to an inventory shipment.
As of 2026-01, this mutation supports an optional idempotency key using the @idempotent directive.
As of 2026-04, the idempotency key is required and must be provided using the @idempotent directive.
For more information, see the idempotency documentation.
As of 2026-01, this mutation supports an optional idempotency key using the @idempotent directive.
As of 2026-04, the idempotency key is required and must be provided using the @idempotent directive.
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>.
Arguments
- id (ID!)
- lineItems ([InventoryShipmentLineItemInput!]!)
- •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.
- addedItems ([InventoryShipmentLineItem!])
- inventoryShipment (InventoryShipment)
- userErrors ([InventoryShipmentAddItemsUserError!]!)
- Anchor to addedItemsadded•[Inventory
Items Shipment Line Item!] The list of added line items.
- Anchor to inventoryShipmentinventory•Inventory
Shipment Shipment The inventory shipment with the added items.
- Anchor to userErrorsuser•[Inventory
Errors Shipment Add Items User Error!]! non-null The list of errors that occurred from executing the mutation.