shipment_create

Arguments

ArgumentTypeRequiredDefaultDescription
dataCreateShipmentInput!Yes

Return Type

CreateShipmentOutput

Mutation

mutation shipment_create(
  $data: CreateShipmentInput!
) {
  shipment_create(
    data: $data
  ) {
    request_id
    complexity
    shipment {
      ...ShipmentFragment
    }
  }
}

Variables

{
  "data": {
    "customer_account_id": "QWNjb3VudDoxMjM0",
    "order_id": "T3JkZXI6MTIzNA==",
    "warehouse_id": "V2FyZWhvdXNlOjEyMzQ=",
    "address": {address1: "123 Fulfillment Ave", city: "New York", country: "US"},
    "line_items": [[{sku: "BLUE-TEE-M", quantity: 2}]],
    "labels": [[{tracking_number: "1Z999AA10123456784", carrier: "ups"}]],
    "notify_customer_via_shiphero": true,
    "notify_customer_via_store": true,
    "shipped_off_shiphero": true,
    "profile": "default"
  }
}

Response

{
  "data": {
    "shipment_create": {
      "request_id": "UmVjb3JkOjEyMzQ=",
      "complexity": 100,
      "shipment": {id: "U2hpcG1lbnQ6MTIzNA=="}
    }
  }
}