Choose a version:

inventoryShipmentAddItems

mutation

Requires write_inventory_shipments access scope. Also: The user must have permission to manage inventory.

Adds items to an inventory shipment.

Arguments

Anchor to idid •ID! required: The ID of the inventory shipment to modify.
Anchor to lineItemslineItems •[InventoryShipmentLineItemInput!]! required: The list of line items to add to the inventory shipment.

Was this section helpful?

Anchor to InventoryShipmentAddItemsPayload returnsInventoryShipmentAddItemsPayload returns

Anchor to addedItemsaddedItems •[InventoryShipmentLineItem!]: The list of added line items.
Anchor to inventoryShipmentinventoryShipment •InventoryShipment: The inventory shipment with the added items.
Anchor to userErrorsuserErrors •[InventoryShipmentAddItemsUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Mutation Reference

mutation inventoryShipmentAddItems($id: ID!, $lineItems: [InventoryShipmentLineItemInput!]!) {

inventoryShipmentAddItems(id: $id, lineItems: $lineItems) {

addedItems {

# InventoryShipmentLineItem fields

}

inventoryShipment {

# InventoryShipment fields

}

userErrors {

field

message

}

Input

{

"id": "gid://shopify/<objectName>/10079785100",

"lineItems": [

{

"inventoryItemId": "gid://shopify/<objectName>/10079785100",

"quantity": 1

}

]

}

{
  "id": "gid://shopify/<objectName>/10079785100",
  "lineItems": [
    {
      "inventoryItemId": "gid://shopify/<objectName>/10079785100",
      "quantity": 1
    }
  ]
}

input InventoryShipmentLineItemInput {
  inventoryItemId: ID!
  quantity: Int!
}