Create a draft shipment in the shipment cart.
Create a draft shipment in the shipment cart. › Request Body
Sender address. Omitted → filled from the account default sender.
Recipient address
Packages. Omitted → filled from the account default package.
pickupBranchCode of the pickup branch (parcel point where the sender drops off the shipment), or "1" to use the account default pickup branch. Requires carrierCode.
deliveryBranchCode of the delivery branch (parcel point where the recipient collects the shipment). Requires carrierCode.
autoDeliveryBranchAutomatically pick the nearest delivery point to the recipient address
serviceIdService (tariff) ID. Omitted → cheapest selectable service is chosen automatically.
referenceNumberReference number / variable symbol
currencyCurrency
carrierCodeCarrier code
typePickup type
pickupDatePickup date (Y-m-d), must not be in the past
fromTimeEarliest pickup time (H:i)
Shipment-level additional services
Customs declaration (for international shipments)
Create a draft shipment in the shipment cart. › Responses
Ok.
idID of the created draft shipment
sourceShipment source
referenceNumberReference number / variable symbol, echoed back
errorsBusiness validation messages; null when the draft is valid
ratesComputed price offers; null until the async quote job finishes
modifiedLast modification timestamp (Y-m-d H:i:s)