Skip to main content

ShipmentRatesInput

What to get courier prices for. Give exactly one of an order or a return.

input ShipmentRatesInput {
  lines: [ShipmentRateLineInput!]
  originWarehouseId: String
  parcels: [DeliveryParcelInput!]
  productReturnId: ID
  salesOrderId: ID
}

Fields​

ShipmentRatesInput.lines ● [ShipmentRateLineInput!] list input​

Partial shipment: price only these order lines at these ship-now quantities (in each line's unit; each at most what is left to ship). Sales orders only; omitted = everything left to ship.

ShipmentRatesInput.originWarehouseId ● String scalar​

The ID of the warehouse the shipment leaves.

ShipmentRatesInput.parcels ● [DeliveryParcelInput!] list input​

The parcels to price. Leave out to pack the goods into the organization's boxes.

ShipmentRatesInput.productReturnId ● ID scalar​

The ID of a return to quote a pickup for, from the customer's address to the warehouse.

ShipmentRatesInput.salesOrderId ● ID scalar​

The ID of the sales order.

Member Of​

shipmentRates query