Create shipment orders

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Content-Type

string

required

Authorization

string

required

Body

application/json

accounts

object[]

required

List of account details. A minimum of 1 and a maximum of 3 accounts can be provided.

callerType

enum<string>

required

Type of caller initiating the shipment

Available options:

SHIPPER,

CARRIER,

RSE

parcels

object[]

required

Array containing details for each parcel in the shipment. Maximum of 10 parcels allowed.

parcels.rates

object[]

required

Array of rate information, including base rate and total rate for the parcel.

parcels.serviceType

string

required

Type of service used for the shipment, e.g., ground or express.

parcels.shipFrom

object

required

Address details for either the shipper or recipient.

parcels.shipTo

object

required

Address details for either the shipper or recipient.

parcels.weight

object

required

parcels.dimensions

object

parcels.parcelType

string

Parcel type, reserved for future use.

parcels.serviceAttributes

object[]

List of additional service attributes for the parcel, such as delivery instructions.

parcels.shipmentDate

string

Date and time of the shipment.

parcels.surcharges

object[]

List of surcharges applied to the parcel, such as fuel charges.

Response

200 - application/json

message

string

Analytics

Authorizations

Headers

Body

Response