inventoryShipmentCreate

Adds a draft shipment to an inventory transfer. 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 inventoryShipmentCreate action (under Inventory).
Fill in the fields below, then reference the result from later steps as {{inventoryshipmentcreate.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 InventoryShipmentCreate($input: InventoryShipmentCreateInput!) {
  inventoryShipmentCreate(input: $input) {
    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.

inputobjectrequired

The input fields for the inventory shipment.

movementIdstringrequired

trackingInputobject4 fields

lineItemsarray<object>required2 fields

dateCreatedstring

barcodestring

json

{
  "input": {
    "movementId": "string",
    "lineItems": [
      {
        "inventoryItemId": "string",
        "quantity": "string"
      }
    ],
    "trackingInput": {
      "trackingNumber": "string",
      "company": "string",
      "trackingUrl": "string",
      "arrivesAt": "string"
    },
    "dateCreated": "string",
    "barcode": "string"
  }
}

Response

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

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?