inventoryTransferAddDraftShipment

mutation

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

Adds a draft shipment to an inventory transfer.

Arguments

Anchor to inputinput • InventoryTransferAddShipmentInput!required: The input fields for the inventory shipment.

Was this section helpful?

Anchor to InventoryTransferAddDraftShipmentPayload returnsInventoryTransferAddDraftShipmentPayload returns

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

Was this section helpful?

Mutation Reference

mutation inventoryTransferAddDraftShipment($input: InventoryTransferAddShipmentInput!) {

inventoryTransferAddDraftShipment(input: $input) {

inventoryShipment {

# InventoryShipment fields

}

userErrors {

field

message

}

Input

{

"input": {

"lineItems": [

{

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

"quantity": 1

}

"trackingInput": {

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

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

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

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

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

}

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

input InventoryTransferAddShipmentInput {
  lineItems: [InventoryShipmentLineItemInput!]!
  trackingInput: InventoryShipmentTrackingInput
  transferId: ID!
}

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

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