Skip to main content

ShipSalesOrderInput

Input to ship a sales order.

input ShipSalesOrderInput {
  allocations: [ShipSalesOrderAllocationInput!]
  delivery: ShipmentBookingInput
  expectedVersion: Int
  id: ID
  idempotencyKey: String
  items: [ShipSalesOrderItemInput!]
  notes: String
  trackingNumber: String
}

Fields​

ShipSalesOrderInput.allocations ● [ShipSalesOrderAllocationInput!] list input​

Exactly which allocations to ship, and how much from each. Preferred for lines split across warehouses.

ShipSalesOrderInput.delivery ● ShipmentBookingInput input​

Book a delivery partner as part of this shipment. If the carrier refuses, the order is left untouched.

ShipSalesOrderInput.expectedVersion ● Int scalar​

The version of the order you last read. The shipment is refused if someone else changed it since.

ShipSalesOrderInput.id ● ID scalar​

Not used: the order id is the mutation's own id argument.

ShipSalesOrderInput.idempotencyKey ● String scalar​

A unique key you generate. Retrying with the same key replays the original shipment instead of shipping twice.

ShipSalesOrderInput.items ● [ShipSalesOrderItemInput!] list input​

Quantity to ship per line, spread over that line's reserved allocations oldest first. Ignored when allocations is set.

ShipSalesOrderInput.notes ● String scalar​

Notes to record on the shipment.

ShipSalesOrderInput.trackingNumber ● String scalar​

Carrier tracking number to record on the shipment.

Member Of​

shipSalesOrder mutation