- Documentation Portal
- SDK and API
- General API Reference
- Order Methods
- DispatchOrders
DispatchOrders
Returns manifest documents. Can consume either a list of Global-e order IDs or a list of merchant order IDs. If the optional hubCode parameter is specified, then only the parcels or orders that were sent from the specified hub will be dispatched.
Method/URL
https://{server_name}/Order/DispatchOrdersParameters
Request
Provide post data list of order IDs.
Name | Type | Description | Mandatory |
|---|---|---|---|
| Object | Provides order manifest data for the order shipment process. |
GetOrdersManifestRequest
Parameters
Parameter Name | Type | Description | Mandatory |
|---|---|---|---|
| String | The Merchant hub code that indicates which hub the parcels or orders are being dispatched from. NOTE: | No |
| List of String | The list of Merchant Order IDs to manifest. | See Note below |
| List of String | The list of order IDs to manifest. | See Note below |
| Decimal | The number of outer boxes that are used through the manifest processing for | No |
Error Codes
Error Code | Error Text in response | Description |
|---|---|---|
B001 | Order ID not found | Refers to Order ID provided by the merchants but it does not exist |
B002 | Order cannot be dispatched. Order and/or parcels have the wrong status. | Possible reasons:
|
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 hub code |
For more information, see DispatchOrders Error Codes.
Response
Name | Type | Description | Mandatory |
|---|---|---|---|
| Object | Provides order documents for the order shipment process. |
OrderDocumentsResponse
Parameter Name | Type | Description | Mandatory |
|---|---|---|---|
| List of | List of | No |
| List of | List of | No |
| String | Description of the error to get documents | No |
| Boolean | Indicates if API call was successful or not. TRUE- API call was successful FALSE – API call was not successful | |
| List of | List of the | No |
| List of | List of | No |
| Object | Order tracking information. | No |
DeliveryAdviceInformation
Parameter Name | Type | Description | Mandatory |
|---|---|---|---|
| String | Commercial invoice number of the parcel if it exists on the parcel level, otherwise order commercial invoice number. Can be null if a commercial invoice does not exist for the order. | |
| String | 3-char ISO currency code related to | |
| String | Code used to identify the Parcel on the Merchant’s site | |
| String | Value of all products in the parcel |
Merchant.ParcelTracking
Parameter Name | Type | Description | Mandatory |
|---|---|---|---|
| String | Parcel code. | |
| String | The tracking number is used by the selected international shipping method for this parcel. | |
| String | Full tracking URL including |
Merchant.TrackingDetails
Parameter Name | Type | Description | Mandatory |
|---|---|---|---|
| String | The shipping method name | |
| String | The tracking number as the shipper has specified | |
| String | Full tracking URL including the |
OrderDocument
Parameter Name | Type | Description | Mandatory |
|---|---|---|---|
| DateTime | The date and time the document was created. | No |
| String | Base64 encoded byte array representing the document file content. | |
| String | Document extension (PDF, ZPL, EPL). | |
| String | The reference provided by the government authorities to this document (such as MRN or ITN number). | No |
| String | Document type code, this value can be:
| |
| String | Document type name, e.g. | |
| String | Description of the error for this entity (order/parcel) if it happened. | No |
| String | The parcel code related to the document. | No |
| String | The name of the shipping service for this document (relevant for | No |
| String | Shipping tracking number associated with the document. | No |
| String | URL of the document. |
Examples
Request
Request 1
{
"HubCode": "Store",
"OrderIds": ["GE2794623GB", " GE2794622GB", " GE2794621GB"]
}Request 2
{
"OrderIds": ["2794623", " 2794622", " 2794621"]
}