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": "abc123",
    "order_id": "abc123",
    "warehouse_id": "abc123",
    "address": AddressInput,
    "line_items": [CreateShipmentLineItemInput],
    "labels": [CreateShipmentShippingLabelInput],
    "notify_customer_via_shiphero": true,
    "notify_customer_via_store": true,
    "shipped_off_shiphero": true,
    "profile": "abc123"
  }
}

Response

{
  "data": {
    "shipment_create": {
      "request_id": "abc123",
      "complexity": 987,
      "shipment": Shipment
    }
  }
}