Dispatch consolidated shipment
Dispatches multiple orders that ship together as a single consolidated shipment. Global-e generates the shared manifest and AWB and returns the shipping documents.
Error codes
The following error codes may be returned in the response. For more information, see the DispatchOrders error codes.| Error Code | Error Text in response | Description |
|---|---|---|
| B001 | Order ID not found | Refers to an Order ID provided by the merchant that does not exist. |
| B002 | Order 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. |
| B003 | Order must be dispatched as part of a consolidated shipment | For consolidated post orders. |
| B004 | Order must NOT be dispatched as part of a consolidated shipment | For NON-consolidated post orders. |
| B100 | There are no orders valid for dispatch. | Relevant for dispatch requests that do not contain any valid order for dispatch. |
| B200 | Could 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. |
| B300 | The 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%. | — |
| B400 | Could not create the manifest | Relevant when the hub manifest cannot be created. |
| B401 | Parcel code(s) not found: {parcel code} | — |
| B402 | Tracking number(s) not found: {parcel code} | — |
| B403 | Parcel-level dispatch is not enabled for this merchant | — |
| B404 | At least one of ParcelCodes, TrackingNumbers, OrderIds, or MerchantOrderIds must be provided | — |
| B500 | Could not create AWB | Relevant when the consolidated AWB cannot be created. |
| B600 | Configuration 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. |
| B700 | Unknown failure | Relevant for general errors and unhandled exceptions. |
| B800 | Hub Code is required | Merchant is configured to use multiple hubs per order but did not send a hub code. |
Body
Include post data list for order IDs and outer boxes amount.
Includes order manifest data for the order shipment process.
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.
The list of Merchant Order IDs to manifest.
The list of order IDs to manifest.
The number of outer boxes that are used through the manifest processing for DispatchConsolidatedShipment.
Response
Successful response.
Provides order documents for the order shipment process.
Indicates if the API call was successful or not. TRUE - API call was successful; FALSE - API call was not successful.
Description of the error to get documents.
List of OrderDocument objects that hold the shipping documents, populated by the GetShippingDocuments method.
List of OrderDocument objects that hold shipper manifest documents, including the consolidated shipment manifest.
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).
Order tracking information.
List of DeliveryAdviceInformation objects that hold the information required for the "Delivery Advice" document.

