curl --request POST \
--url https://{globale_api_domain}/Order/DispatchOrders \
--header 'Content-Type: application/json' \
--data '
{
"OrderIds": [
"GE11111111GB",
"GE2222211GB"
],
"HubCode": "hub001"
}
'{
"IsSuccess": true,
"ShipperManifests": [
{
"DocumentTypeCode": "3",
"DocumentTypeName": "ShipperManifest",
"DocumentExtension": "pdf",
"URL": "https://assets.global-e.com/documents/04552836-ED8F-4362-AE09-FAB014DAA421.pdf",
"DocumentData": "JVBERi0xLjUNCiW1tbW1DQoxIDAgb2[...]mDQoxNDgzNDkNCiUlRU9G",
"ErrorMessage": null
}
]
}{
"IsSuccess": false,
"ErrorText": "There are no orders valid for dispatch.",
"ShipperManifests": [],
"Errors": null
}{
"IsSuccess": false,
"ErrorText": "Configuration error. Cannot determine source hub. Please contact Global-e TechSuppor.",
"ShipperManifests": [],
"Errors": []
}Dispatch orders (Merchant to Global-e)
The DispatchOrders API provides the necessary carrier manifest, encoded as a base64 byte array, and a printing URL for all orders with printed labels since the last DispatchOrders call.
curl --request POST \
--url https://{globale_api_domain}/Order/DispatchOrders \
--header 'Content-Type: application/json' \
--data '
{
"OrderIds": [
"GE11111111GB",
"GE2222211GB"
],
"HubCode": "hub001"
}
'{
"IsSuccess": true,
"ShipperManifests": [
{
"DocumentTypeCode": "3",
"DocumentTypeName": "ShipperManifest",
"DocumentExtension": "pdf",
"URL": "https://assets.global-e.com/documents/04552836-ED8F-4362-AE09-FAB014DAA421.pdf",
"DocumentData": "JVBERi0xLjUNCiW1tbW1DQoxIDAgb2[...]mDQoxNDgzNDkNCiUlRU9G",
"ErrorMessage": null
}
]
}{
"IsSuccess": false,
"ErrorText": "There are no orders valid for dispatch.",
"ShipperManifests": [],
"Errors": null
}{
"IsSuccess": false,
"ErrorText": "Configuration error. Cannot determine source hub. Please contact Global-e TechSuppor.",
"ShipperManifests": [],
"Errors": []
}Body
Identifies which orders or parcels to dispatch. Supply at least one of ParcelCodes, TrackingNumbers, OrderIds, or MerchantOrderIds. Only one resolution method applies per request: (1) If ParcelCodes is non-empty, only those parcels are dispatched and TrackingNumbers and order identifiers in the same request are ignored. (2) Else if TrackingNumbers is non-empty, only matching parcels are dispatched and order identifiers in the same request are ignored. (3) Else order-level dispatch uses OrderIds and/or MerchantOrderIds (existing behaviour). When both TrackingNumbers and ParcelCodes are sent, ParcelCodes are used. When dispatching by parcel identifiers, only matching parcels are dispatched; the rest of the order stays open.
Your eCommerce order numbers for order-level dispatch when you do not send parcel identifiers. For Shopify, use either the Shopify Order Name (default), e.g. #12345, or the Shopify Order Number, e.g. 12345. Ignored when a non-empty ParcelCodes or TrackingNumbers list is used.
AWB or tracking numbers for the parcels to dispatch. Each number matches a parcel at parcel level, or at order level for single-parcel or consolidated orders where tracking is stored on the order. Parcels must be Received In Hub, belong to your account, and when HubCode is supplied, belong to that hub.
Response
Successful response.
The orders or parcels that could not be dispatched, one entry each. See DispatchOrders error codes.
Show child attributes
Show child attributes