Skip to main content
POST
Dispatch orders and retrieve carrier manifest
Part of the Shipping Documents API integration guide — see it for when and how to use this endpoint.

Body

application/json
OrderIds
string[]
required

"eCommerce order number" as passed down in the order payload. For Shopify, should be either the Shopify Order Name (default), e.g. #12345; or the Shopify Order Number, e.g. 12345.

HubCode
string

When dispatching from multiple hubs, indicates for a given call which hub the related shipment will be dispatched from.

Response

200 - application/json

Successful response.

IsSuccess
boolean

Indicates whether the API call was successful.

ErrorText
string | null

Description of the error for getting documents.

ShipperManifests
OrderDocument · object[] | null

List of OrderDocument objects that hold shipper manifest documents.

ParcelsTracking
Merchant.ParcelTracking · object[] | null

List of Merchant.ParcelTracking objects, each holding the parcel tracking number and full tracking URL for the relevant shipper (with the parcel tracking number).

TrackingDetails
Merchant.TrackingDetails · object | null

Order tracking information.

DeliveryAdviceInformation
DeliveryAdviceInformation · object[] | null

List of DeliveryAdviceInformation objects that hold the information required for the Delivery Advice document.