inventoryShipmentUpdateItemQuantities

mutation

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

Updates items on a draft inventory shipment.

Arguments

Anchor to idid • ID!required: The ID of the inventory shipment to update item quantities.
Anchor to itemsitems • [InventoryShipmentUpdateItemQuantitiesInput!]Default:[]: The list of line items to be updated to the shipment.

Was this section helpful?

Anchor to InventoryShipmentUpdateItemQuantitiesPayload returnsInventoryShipmentUpdateItemQuantitiesPayload returns

Anchor to shipmentshipment • InventoryShipment: The inventory shipment with updated item quantities.
Anchor to updatedLineItemsupdatedLineItems • [InventoryShipmentLineItem!]: The updated item quantities.
Anchor to userErrorsuserErrors • [InventoryShipmentUpdateItemQuantitiesUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Mutation Reference

mutation inventoryShipmentUpdateItemQuantities($id: ID!, $items: [InventoryShipmentUpdateItemQuantitiesInput!]) {

inventoryShipmentUpdateItemQuantities(id: $id, items: $items) {

shipment {

# InventoryShipment fields

}

updatedLineItems {

# InventoryShipmentLineItem fields

}

userErrors {

field

message

}

Input

{

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

"items": [

{

"quantity": 1,

"shipmentLineItemId": "gid://shopify/<objectName>/10079785100"

}

]

}

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

input InventoryShipmentUpdateItemQuantitiesInput {
  quantity: Int!
  shipmentLineItemId: ID!
}