Skip to main content

ShipmentBookingInput

The delivery booking details sent with a ship: the delivery partner, the selected rate, the parcels, the recipient and the pickup window.

input ShipmentBookingInput {
  applyRateToOrderShipping: Boolean
  carrierName: String
  deliveryPartnerConfigId: ID!
  notes: String
  parcels: [DeliveryParcelInput!]
  pickupWindowEnd: DateTime
  pickupWindowStart: DateTime
  providerQuoteRef: String
  quotedAmount: String
  quotedCurrency: String
  quotedParcels: [DeliveryParcelInput!]
  recipient: ShipmentRecipientInput
  serviceLevelCode: String
  serviceLevelName: String
  trackingNumber: String
}

Fields​

ShipmentBookingInput.applyRateToOrderShipping ● Boolean scalar​

Ship command only: also make the selected rate the order's shipping charge. The server prices the selection itself, and refuses the ship, with nothing booked and no stock moved, when the charge may not change.

ShipmentBookingInput.carrierName ● String scalar​

The carrier's name.

ShipmentBookingInput.deliveryPartnerConfigId ● ID! non-null scalar​

The ID of the delivery partner configuration to book with.

ShipmentBookingInput.notes ● String scalar​

Notes for the booking. At most 1000 characters.

ShipmentBookingInput.parcels ● [DeliveryParcelInput!] list input​

The parcels to book. Without parcels, each shipment is packed on its own.

ShipmentBookingInput.pickupWindowEnd ● DateTime scalar​

End of the pickup window.

ShipmentBookingInput.pickupWindowStart ● DateTime scalar​

Start of the pickup window.

ShipmentBookingInput.providerQuoteRef ● String scalar​

The provider's reference for the selected rate.

ShipmentBookingInput.quotedAmount ● String scalar​

The rate staff picked, which is the seller's cost, as a decimal string. The server prices the selection itself; this amount is never charged as sent.

ShipmentBookingInput.quotedCurrency ● String scalar​

ISO 4217 currency code of quotedAmount.

ShipmentBookingInput.quotedParcels ● [DeliveryParcelInput!] list input​

The parcels the selected rate was priced for (the rate option's parcels). Without parcels, each shipment is packed on its own and books these only when it still packs to them; otherwise it books its own boxes without the quote reference and amount.

ShipmentBookingInput.recipient ● ShipmentRecipientInput input​

Who the shipment is delivered to.

ShipmentBookingInput.serviceLevelCode ● String scalar​

The carrier's service level code.

ShipmentBookingInput.serviceLevelName ● String scalar​

The carrier's service level name.

ShipmentBookingInput.trackingNumber ● String scalar​

For custom couriers: the tracking number from the courier. At most 120 characters.

Member Of​

bookReturnPickup mutation ● BookShipmentForShippedGoodsInput input ● SchedulePickupInput input ● ShipSalesOrderInput input