DispatchConsolidatedShipment

Returns a list of details for the orders. Can consume a list of Global‑e order IDs.

Method/URL

https://{server_name}/Order/DispatchConsolidatedShipment

Parameters

Request

Include post data list for order IDs and outer boxes amount.

Name	Type	Description	Mandatory
`GetOrdersManifestRequest`	Object `GetOrdersManifestRequest`	Includes order manifest data for the order shipment process.

GetOrdersManifestRequest

Parameters

Parameter Name	Type	Description	Mandatory
`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.	No
`MerchantOrderIds`	List of String	The list of Merchant Order IDs to manifest.	See Note below
`OrderIds`	List of String	The list of order IDs to manifest.	See Note below
`OuterBoxesAmount`	Decimal	The number of outer boxes that are used through the manifest processing for `DispatchConsolidateShipment`.	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: 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 hub code

For more information, see DispatchOrders Error Codes.

Response

Name	Type	Description	Mandatory
`OrderDocumentsResponse`	Object `OrderDocumentsResponse`	Provides order documents for the order shipment process.

OrderDocumentsResponse

Parameter Name	Type	Description	Mandatory
`DeliveryAdviceInformation`	List of `DeliveryAdviceInformation`	List of `DeliveryAdviceInformation` objects that hold the information required for the “Delivery Advice” document.	No
`Documents`	List of `OrderDocument`	List of `OrderDocument` objects that hold the shipping documents. This property is included only in the `GetShippingDocuments` method response.	No
`ErrorText`	String	Description of the error to get documents	No
`IsSuccess`	Boolean	Indicates if API call was successful or not. TRUE- API call was successful FALSE – API call was not successful
`ParcelsTracking`	List of `Merchant.ParcelTracking`	List of the `Merchant.ParcelTracking` objects, each object holds the parcel tracking number and full tracking URL for the relevant shipper (with the parcel tracking number).	No
`ShipperManifests`	List of `OrderDocument`	List of `OrderDocument` objects that hold shipper manifest documents. This property is included only in the `DispatchOrders` method response.	No
`TrackingDetails`	Object `Merchant.TrackingDetails`	Order tracking information.	No

DeliveryAdviceInformation

Parameter Name	Type	Description
`CommercialInvoiceNumber`	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.
`CurrencyCode`	String	3-char ISO currency code related to `TotalValue`
`ParcelCode`	String	Code used to identify the Parcel on the Merchant’s site
`TotalValue`	String	Value of all products in the parcel

Merchant.ParcelTracking

Parameter Name	Type	Description
`ParcelCode`	String	Parcel code.
`ParcelTrackingNumber`	String	The tracking number is used by the selected international shipping method for this parcel.
`ParcelTrackingUrl`	String	Full tracking URL including `ParcelTrackingNumber` used by the selected international shipping method for this parcel.

Merchant.TrackingDetails

Parameter Name	Type	Description
`ShipperName`	String	The shipping method name
`TrackingNumber`	String	The tracking number as the shipper has specified
`TrackingURL`	String	Full tracking URL including the `TrackingNumber` used by the selected international shipping method

OrderDocument

Parameter Name	Type	Description	Mandatory
`CreationDateTime`	DateTime	The date and time the document was created.	No
`DocumentData`	String	Base64 encoded byte array representing the document file content.
`DocumentExtension`	String	Document extension (PDF, ZPL, EPL).
`DocumentReference`	String	The reference provided by the government authorities to this document (such as MRN or ITN number).	No
`DocumentTypeCode`	String	Document type code, this value can be: CommercialInvoice = 1 PackingList = 2 ShipperManifest = 3 Label = 4 VATInvoice = 5 DangerousGoodDeclarationLink = 6 GELabel = 7 CustomerReceiptInvoice = 8 ArchibeLabel = 9 DeliveryAdvice = 10 EAD = 11
`DocumentTypeName`	String	Document type name, e.g. `AWB`, `CommercialInvoiceAndPackingList` or `Manifest`.
`ErrorMessage`	String	Description of the error for this entity (order/parcel) if it happened.	No
`ParcelCode`	String	The parcel code related to the document.	No
`ShippingServiceName`	String	The name of the shipping service for this document (relevant for `DispatchOrders` and `DispatchConsolidatedShipment`).	No
`TrackingNumber`	String	Shipping tracking number associated with the document.	No
`URL`	String	URL of the document.

Examples

Request

{
    "OrderIds":[
       "GE2794623GB",
       "GE2794622GB",
       "GE2794621GB"
     ],
    “OuterBoxesAmount”: 1
}

Documentation Portal

DispatchConsolidatedShipment

Parameters

GetOrdersManifestRequest

Parameters

Error Codes

OrderDocumentsResponse

DeliveryAdviceInformation

Merchant.ParcelTracking

Merchant.TrackingDetails

OrderDocument

Examples

Search results