Choose a version:

inventoryShipmentCreate

mutation

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

Adds a draft shipment to an inventory transfer.

Caution

As of 2026-01, this mutation supports an optional idempotency key using the @idempotent directive. As of 2026-04, the idempotency key is required and must be provided using the @idempotent directive. For more information, see the idempotency documentation.

Anchor to Arguments

Arguments

Anchor to inputinput

•InventoryShipmentCreateInput!

required

The input fields for the inventory shipment.

Was this section helpful?

Anchor to InventoryShipmentCreatePayload returnsInventoryShipmentCreatePayload returns

Anchor to inventoryShipmentinventoryShipment •InventoryShipment: The created inventory shipment.
Anchor to userErrorsuserErrors •[InventoryShipmentCreateUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

inventoryShipmentCreate reference

Mutation Reference

mutation inventoryShipmentCreate($input: InventoryShipmentCreateInput!) {

inventoryShipmentCreate(input: $input) {

inventoryShipment {

# InventoryShipment fields

}

userErrors {

field

message

}

Input

{

"input": {

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

"trackingInput": {

"trackingNumber": "<your-trackingNumber>",

"company": "<your-company>",

"trackingUrl": "https://example.myshopify.com",

"arrivesAt": "2019-09-07T15:50:00Z"

"lineItems": [

{

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

"quantity": 1

}

"dateCreated": "2019-09-07T15:50:00Z"

}

Variables

{
  "input": {
    "movementId": "gid://shopify/<objectName>/10079785100",
    "trackingInput": {
      "trackingNumber": "<your-trackingNumber>",
      "company": "<your-company>",
      "trackingUrl": "https://example.myshopify.com",
      "arrivesAt": "2019-09-07T15:50:00Z"
    },
    "lineItems": [
      {
        "inventoryItemId": "gid://shopify/<objectName>/10079785100",
        "quantity": 1
      }
    ],
    "dateCreated": "2019-09-07T15:50:00Z"
  }
}

Schema

input InventoryShipmentCreateInput {
  movementId: ID!
  trackingInput: InventoryShipmentTrackingInput
  lineItems: [InventoryShipmentLineItemInput!]!
  dateCreated: DateTime
}

input InventoryShipmentTrackingInput {
  trackingNumber: String
  company: String
  trackingUrl: URL
  arrivesAt: DateTime
}

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