Merchant ID

Tenant ID

References for a shipment, provided by the merchant.

The partner_order_reference is mandatory but not required to be unique. It is usually the customer facing order number.

The partner_shipment_reference must be unique for every shipment. It is mandatory, but is copied from partner_order_reference if it is not provided.

If a single order has multiple shipments, then they will share the partner_order_reference but have unique partner_shipment_reference.

Payment details including the total value of the shipment and any pending Cash on Delivery amount.

Provide the scheduled_from and scheduled_to to choose the scheduled date along with start and end time.

Example: "collection": { "scheduled_from": "2022-01-01'T'10:00:00.000Z", "scheduled_to": "2022-01-01'T'12:00:00.000Z" }

The delivery options chosen for the shipment, including the delivery type and schedule.

Provide the scheduled_from and scheduled_to to choose the scheduled date along with start and end time.

Example: "collection": { "scheduled_from": "2022-01-01'T'10:00:00.000Z", "scheduled_to": "2022-01-01'T'12:00:00.000Z" }

A free-form address for pickup.

A free-form address for dropoff.

List of parcels in a B2C shipment.

List of packages of type pallet or carton in a B2B shipment.

Custom attributes in the form of a map:

{"attribute1" : "value1", "attribute2" : "value2"}