Skip to main content
POST
Dispatch orders as a single consolidated shipment
Make sure your integration follows the latest authentication and IP whitelisting guidelines.
Use this method to dispatch a group of orders as a single consolidated shipment, with one shared manifest and AWB.

Error codes

This method returns the same error codes as DispatchOrders. See 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
integer

The number of outer boxes that are used through the manifest processing for DispatchConsolidatedShipment. If 0 or not sent, 1 is used. Cannot be greater than the number of parcels in the shipment (error B300).

Response

The consolidated shipment was dispatched. ShipperManifests holds the shipment's documents.

The result of the dispatch: the shipment's documents and the orders that could not be dispatched.

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.

ShipperManifests
OrderDocument · object[]

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

Errors
ShipperManifestError · object[]

The orders that could not be dispatched, one entry per order. See DispatchOrders error codes.