Skip to main content
POST
Dispatch orders as a single consolidated shipment
Use this method to dispatch a group of orders that ship together as a single consolidated shipment — one shared manifest and AWB across all the orders in the request. Submit the order IDs to manifest (and the number of outer boxes); Global-e generates the consolidated manifest and returns the associated shipping documents and tracking details.

Error codes

The following error codes may be returned in the response. For more information, see the DispatchOrders error codes.

Body

application/json

Include post data list for order IDs and outer boxes amount.

Includes order manifest data for the order shipment process.

HubCode
string

The Merchant hub code that indicates which hub the parcels or orders are being dispatched from. NOTE: hubCode should be mapped to a Global-e hubId on the Global-e side.

MerchantOrderIds
string[]

The list of Merchant Order IDs to manifest.

OrderIds
string[]

The list of order IDs to manifest.

OuterBoxesAmount
number

The number of outer boxes that are used through the manifest processing for DispatchConsolidatedShipment.

Response

200 - application/json

Successful response.

Provides order documents for the order shipment process.

IsSuccess
boolean

Indicates if the API call was successful or not. TRUE - API call was successful; FALSE - API call was not successful.

ErrorText
string | null

Description of the error to get documents.

Documents
OrderDocument · object[] | null

List of OrderDocument objects that hold the shipping documents, populated by the GetShippingDocuments method.

ShipperManifests
OrderDocument · object[] | null

List of OrderDocument objects that hold shipper manifest documents, including the consolidated shipment manifest.

ParcelsTracking
Merchant.ParcelTracking · object[] | null

List of Merchant.ParcelTracking objects, each object holds 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.