Request Parameters
array
required
Array containing the
parcelId of the parcels contained in this shipment.string
required
Approximate expected date and time when the package will leave the fulfillment facility, in ISO 8601 format.
string
required
Approximate expected date and time when the package will arrive at the consolidation hub, in ISO 8601 format.
string
required
Tracking number/code of the first mile dispatch.
string
Identifier of the first mile carrier company (e.g.,
USPS, FedEx, DHL).string
Human-readable description of the dispatch (e.g., “Weekly dispatch”, “Daily shipment”).
Response Fields
string
Unique identifier of this shipment.
string
Status of the shipment. Can be one of:
CREATED- Shipment has been createdSHIPPED- Shipment has been shippedCANCELLED- Shipment was cancelled
array
Array containing the parcel IDs contained in this shipment.
string
Human-readable description of the dispatch.
string
Expected date when the package will leave the fulfillment facility.
string
Expected date when the package will arrive at the consolidation hub.
string
Tracking number or code of the first mile dispatch.
number
Total weight of the shipment in kilograms, generated by summing the weight of all parcels.
string
The merchant ID.
string
Date and time when the shipment was created.
string
Date and time when the shipment was last updated.