inventoryShipmentAddItems

Adds items to an inventory shipment. Caution: As of 2026-01, this mutation supports an optional idempotency key using the @idempotent directive.

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the inventoryShipmentAddItems action (under Inventory).
Fill in the fields below, then reference the result from later steps as {{inventoryshipmentadditems.response.data}}.

Query

This is the mutation the action sends by default. Edit it in the step's Query field to change which fields come back.

graphql

mutation InventoryShipmentAddItems($id: ID!, $lineItems: [InventoryShipmentLineItemInput!]!) {
  inventoryShipmentAddItems(id: $id, lineItems: $lineItems) {
    addedItems {
      acceptedQuantity
      id
      inventoryItem {
        countryCodeOfOrigin
        createdAt
        duplicateSkuCount
        harmonizedSystemCode
        id
        inventoryHistoryUrl
        legacyResourceId
        locationsCount
        measurement
        provinceCodeOfOrigin
        requiresShipping
        sku
        tracked
        trackedEditable
        unitCost
        updatedAt
        variant
      }
      quantity
      rejectedQuantity
      unreceivedQuantity
    }
    inventoryShipment {
      barcode
      dateCreated
      dateReceived
      dateShipped
      id
      lineItemTotalQuantity
      name
      status
      totalAcceptedQuantity
      totalReceivedQuantity
      totalRejectedQuantity
      tracking {
        arrivesAt
        company
        trackingNumber
        trackingUrl
      }
    }
    userErrors {
      code
      field
      message
    }
  }
}

Variables

Pass these as a JSON object in the step's Variables field.

idstringrequired

The ID of the inventory shipment to modify.

lineItemsarray<object>required

The list of line items to add to the inventory shipment.

inventoryItemIdstringrequired

quantitynumberrequired

json

{
  "id": "string",
  "lineItems": [
    {
      "inventoryItemId": "string",
      "quantity": 0
    }
  ]
}

Response

Read the result with {{inventoryshipmentadditems.response.data.data.inventoryShipmentAddItems}}. If the API returns errors, the step fails and they are at {{inventoryshipmentadditems.response.data.errors}}.

addedItemsarray<object>

acceptedQuantityobject

idobject

inventoryItemobject

quantityobject

rejectedQuantityobject

unreceivedQuantityobject

inventoryShipmentobject

barcodestring

dateCreatedstring

dateReceivedstring

dateShippedstring

idstring

lineItemTotalQuantitynumber

namestring

statusstring

One ofDRAFTIN_TRANSITPARTIALLY_RECEIVEDRECEIVEDOTHER

totalAcceptedQuantitynumber

totalReceivedQuantitynumber

totalRejectedQuantitynumber

trackingobject4 fields

userErrorsarray<object>

codeobject

fieldobject

messageobject

Need more? See the Shopify guide for connection setup and behaviour shared by every action.

Was this page helpful?