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.
Error CodeError Text in responseDescription
B001Order ID not foundRefers to an Order ID provided by the merchant that does not exist.
B002Order cannot be dispatched.Order and/or parcels have the wrong status. Possible reasons: Order AWB generation has failed; Order yet to be processed with GetShippingDocuments; Order already dispatched.
B003Order must be dispatched as part of a consolidated shipmentFor consolidated post orders.
B004Order must NOT be dispatched as part of a consolidated shipmentFor NON-consolidated post orders.
B100There are no orders valid for dispatch.Relevant for dispatch requests that do not contain any valid order for dispatch.
B200Could not determine the destination hub. Either none or more than one hub was found.Relevant for consolidated shipment dispatch requests that contain orders associated with more than one hub.
B300The number of outer boxes cannot be greater than the number of parcels. The total number of parcels is %Number of Parcels% and the number of outer boxes is %Number of outer boxes%.
B400Could not create the manifestRelevant when the hub manifest cannot be created.
B401Parcel code(s) not found: {parcel code}
B402Tracking number(s) not found: {parcel code}
B403Parcel-level dispatch is not enabled for this merchant
B404At least one of ParcelCodes, TrackingNumbers, OrderIds, or MerchantOrderIds must be provided
B500Could not create AWBRelevant when the consolidated AWB cannot be created.
B600Configuration error. Cannot determine source hub. Please contact Global-e TechSupport.There is a configuration error on the Global-e side — more than one merchant hub is configured.
B700Unknown failureRelevant for general errors and unhandled exceptions.
B800Hub Code is requiredMerchant is configured to use multiple hubs per order but did not send a hub code.

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.