inventoryShipmentUpdateItemQuantities

mutation

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

Updates items on an inventory shipment.

Anchor to Arguments

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?

Examples

inventoryShipmentUpdateItemQuantities reference

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": [

{

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

"quantity": 1

}

]

}

Variables

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

Schema

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