{
"Code": "400",
"Error": "The HubCode 'HUB-001' is not mapped to a GlobalE HubId.",
"Description": "Provide a valid hub code.",
"Success": false
}
{
"IsSuccess": false,
"ErrorText": "There are no orders valid for dispatch.",
"ShipperManifests": [],
"Errors": [
{
"OrderID": "GE2794623GB",
"ErrorCode": "B001",
"ErrorText": "Order ID: GE2794623GB - not found.",
"MerchantOrderID": ""
}
]
}
Dispatch consolidated shipment (Merchant to Global-e)
Dispatches multiple orders that ship together as a single consolidated shipment. Global-e generates the shared manifest and AWB and returns the shipping documents.
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
integer
The number of outer boxes that are used through the manifest processing for DispatchConsolidatedShipment. If 0 or not sent, 1 is used. Cannot be greater than the number of parcels in the shipment (error B300).
Response
The consolidated shipment was dispatched. ShipperManifests holds the shipment's documents.
The result of the dispatch: the shipment's documents and the orders that could not be dispatched.
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.
ShipperManifests
OrderDocument · object[]
List of OrderDocument objects that hold shipper manifest documents, including the consolidated shipment manifest.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Global-e Docs","colors":{"primary":"#F15A2B","light":"#F57C00","dark":"#C2451F"},"logo":{"light":"https://mintcdn.com/globale-enterprise/xvASI8IP64Cj0kr_/logo/light.png?fit=max\u0026auto=format\u0026n=xvASI8IP64Cj0kr_\u0026q=85\u0026s=3b5849fa849995b81b219c94b874d44f","dark":"https://mintcdn.com/globale-enterprise/xvASI8IP64Cj0kr_/logo/dark.png?fit=max\u0026auto=format\u0026n=xvASI8IP64Cj0kr_\u0026q=85\u0026s=4b3c45ba5ba14d2aadb54b500e20183c","href":"/introduction"},"favicon":"https://mintcdn.com/globale-enterprise/tw35F3WiyJ8sxtxX/favicon.png?fit=max\u0026auto=format\u0026n=tw35F3WiyJ8sxtxX\u0026q=85\u0026s=261a34ff25dc6eee4c7acf742bba08b5","api":{"playground":{"display":"simple"}},"background":{"decoration":"gradient"},"navbar":{"links":[{"href":"https://status.global-e.com/","label":"Status Page"},{"href":"https://trustcenter.global-e.com","label":"Trust Center"},{"href":"/contact-us","label":"Escalating a Ticket"}]},"styling":{"eyebrows":"breadcrumbs","latex":true},"contextual":{"options":[],"display":"header"},"interaction":{"drilldown":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"globale-enterprise","hasAudioNarration":false,"actualSubdomain":"globale-enterprise","customDomains":["docs.global-e.com"],"gitSource":{"type":"gitlab","owner":"global-e/product","repo":"mintlify-docs","deployBranch":"main","contentDirectory":"enterprise","isPrivate":true,"projectId":84016925,"mountPath":"","label":""},"feedback":{"thumbs":false},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af5fc25cf5b122bc79cef36","clientVersion":"0.0.4142","searchFilterCounts":[{"language":"default","tag":"Documentation","count":473},{"language":"default","tag":"Topics","count":473},{"language":"default","tag":"eCommerce Integration","count":183},{"language":"default","tag":"API Reference","count":82},{"language":"default","tag":"Global-e: The Basics","count":73},{"language":"default","tag":"SDK and API","count":53},{"language":"default","tag":"SFCC","count":48},{"language":"default","tag":"New Returns Portal for All Platforms (Excluding Shopify)","count":44},{"language":"default","tag":"Merchant Portal","count":40},{"language":"default","tag":"New Returns Portal for Shopify","count":38}],"searchSettings":{"maxResults":15}},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","href":"/_mintlify/custom/globale-enterprise/88d32b680e95f6f9/style.css"}],"page":{"pagePath":"api-reference/dispatch-consolidated-shipment","slug":"/api-reference/dispatch-consolidated-shipment","pageMetadata":{"contextual":{"options":[{"title":"View YAML","description":"Open the OpenAPI spec for this endpoint","icon":"file-code","href":"/api-reference/specs/dispatchconsolidatedshipment.yaml"},"download-spec","copy","view","chatgpt","claude"]},"title":"Dispatch consolidated shipment (Merchant to Global-e)","sidebarTitle":"Dispatch consolidated shipment","description":"Dispatches multiple orders that ship together as a single consolidated shipment. Global-e generates the shared manifest and AWB and returns the shipping documents.","openapi":"api-reference/specs/dispatchconsolidatedshipment.yaml POST /Order/DispatchConsolidatedShipment","href":"/api-reference/dispatch-consolidated-shipment"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Dispatches multiple orders that ship together as a single consolidated shipment. Global-e generates the shared manifest and AWB and returns the shipping documents.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,p:`p`,..._provideComponents(),...props.components},{Heading,Warning}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(Warning,{children:_jsxs(_components.p,{children:[`Make sure your integration follows the latest `,_jsx(_components.a,{href:`/api-authentication`,children:`authentication`}),` and `,_jsx(_components.a,{href:`/api-authentication#ip-whitelisting`,children:`IP whitelisting`}),` guidelines.`]})}),`\n`,_jsx(_components.p,{children:`Use this method to dispatch a group of orders as a single consolidated shipment, with one shared manifest and AWB.`}),`\n`,_jsx(Heading,{level:`2`,id:`error-codes`,children:`Error codes`}),`\n`,_jsxs(_components.p,{children:[`This method returns the same error codes as DispatchOrders. See `,_jsx(_components.a,{href:`/shipping-documents-api#dispatchorders-error-codes`,children:`DispatchOrders error codes`}),`.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"contextual":{"options":[{"title":"View YAML","description":"Open the OpenAPI spec for this endpoint","icon":"file-code","href":"/api-reference/specs/dispatchconsolidatedshipment.yaml"},"download-spec","copy","view","chatgpt","claude"]},"title":"Dispatch consolidated shipment (Merchant to Global-e)","sidebarTitle":"Dispatch consolidated shipment","description":"Dispatches multiple orders that ship together as a single consolidated shipment. Global-e generates the shared manifest and AWB and returns the shipping documents.","openapi":"api-reference/specs/dispatchconsolidatedshipment.yaml POST /Order/DispatchConsolidatedShipment","href":"/api-reference/dispatch-consolidated-shipment"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Error codes","slug":"error-codes","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/globale-enterprise/3a1555eec05adf43/feedback-link.js","/_mintlify/custom/globale-enterprise/07a4be9d6ed97624/footer-legal.js","/_mintlify/custom/globale-enterprise/49711f0bc5d1b97e/country-table.js","/_mintlify/custom/globale-enterprise/d9fcdd3337ee5e98/assistant-open-full.js","/_mintlify/custom/globale-enterprise/e7c54d85527e9e47/assistant-share.js"],"openApiReferenceData":{"operation":{"summary":"Dispatch orders as a single consolidated shipment","description":"Dispatches multiple orders that ship together as a single consolidated shipment. Global-e generates the shared manifest and AWB and returns the shipping documents.","operationId":"dispatchConsolidatedShipment","tags":["DispatchConsolidatedShipment"],"requestBody":"669d0954-f299-4b54-bd6a-4dad70f1f9a7","responses":{"200":"5b6e7556-cd10-4cd8-a9ad-424b805e8850","400":"ab312d97-94e0-486d-b291-dcad331f3530","500":"6947b731-a8f5-4560-a9b4-ad6cab83d43d"},"method":"post","type":"path","servers":["d7f07595-7b1e-4c55-99f3-eb37f95a8008"],"security":[],"path":"/Order/DispatchConsolidatedShipment","baseUrlOptions":["https://{globale_api_domain}"],"title":"Dispatch orders as a single consolidated shipment","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"description":"Include post data list for order IDs and outer boxes amount.","content":{"application/json":{"schema":{"type":"object","title":"GetOrdersManifestRequest","description":"Includes order manifest data for the order shipment process.","properties":{"HubCode":{"type":"string","description":"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.","uniqueKey":"HubCode","typeLabel":"string"},"MerchantOrderIds":{"type":"array","description":"The list of Merchant Order IDs to manifest.","items":{"type":"string","uniqueKey":"MerchantOrderIds.items.[INDEX]","typeLabel":"string"},"uniqueKey":"MerchantOrderIds","typeLabel":"string[]"},"OrderIds":{"type":"array","description":"The list of order IDs to manifest.","items":{"type":"string","uniqueKey":"OrderIds.items.[INDEX]","typeLabel":"string"},"uniqueKey":"OrderIds","typeLabel":"string[]"},"OuterBoxesAmount":{"type":"integer","description":"The number of outer boxes that are used through the manifest processing for DispatchConsolidatedShipment. If 0 or not sent, 1 is used. Cannot be greater than the number of parcels in the shipment (error B300).","uniqueKey":"OuterBoxesAmount","typeLabel":"integer"}},"uniqueKey":"","typeLabel":"GetOrdersManifestRequest · object"},"example":{"OrderIds":["GE2794623GB","GE2794622GB","GE2794621GB"],"OuterBoxesAmount":1},"examples":{"Example":{"title":"Example","value":{"OrderIds":["GE2794623GB","GE2794622GB","GE2794621GB"],"OuterBoxesAmount":1}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"5b6e7556-cd10-4cd8-a9ad-424b805e8850":{"description":"The consolidated shipment was dispatched. `ShipperManifests` holds the shipment's documents.","content":{"application/json":{"schema":{"type":"object","title":"ShipperManifestsResponse","description":"The result of the dispatch: the shipment's documents and the orders that could not be dispatched.","properties":{"IsSuccess":{"type":"boolean","description":"Indicates if the API call was successful or not. TRUE - API call was successful; FALSE - API call was not successful.","uniqueKey":"IsSuccess","typeLabel":"boolean"},"ErrorText":{"oneOf":[{"type":"string","description":"Description of the error to get documents.","uniqueKey":"ErrorText.oneOf.0","typeLabel":"string"},{"type":"null","description":"Description of the error to get documents.","uniqueKey":"ErrorText.oneOf.1","typeLabel":"null"}],"uniqueKey":"ErrorText","typeLabel":"string | null"},"ShipperManifests":{"type":"array","description":"List of OrderDocument objects that hold shipper manifest documents, including the consolidated shipment manifest.","items":{"type":"object","title":"OrderDocument","properties":{"DocumentData":{"type":"string","description":"Base64 encoded byte array representing the document file content.","uniqueKey":"ShipperManifests.items.[INDEX].DocumentData","typeLabel":"string"},"DocumentExtension":{"type":"string","description":"Document extension (PDF, ZPL, EPL).","uniqueKey":"ShipperManifests.items.[INDEX].DocumentExtension","typeLabel":"string"},"DocumentTypeCode":{"type":"string","description":"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.","enum":["1","2","3","4","5","6","7","8","9","10","11"],"uniqueKey":"ShipperManifests.items.[INDEX].DocumentTypeCode","typeLabel":"enum\u003cstring>"},"DocumentTypeName":{"type":"string","description":"Document type name, e.g. AWB, CommercialInvoiceAndPackingList or Manifest.","uniqueKey":"ShipperManifests.items.[INDEX].DocumentTypeName","typeLabel":"string"},"ErrorMessage":{"oneOf":[{"type":"string","description":"Description of the error for this entity (order/parcel) if it happened.","uniqueKey":"ShipperManifests.items.[INDEX].ErrorMessage.oneOf.0","typeLabel":"string"},{"type":"null","description":"Description of the error for this entity (order/parcel) if it happened.","uniqueKey":"ShipperManifests.items.[INDEX].ErrorMessage.oneOf.1","typeLabel":"null"}],"uniqueKey":"ShipperManifests.items.[INDEX].ErrorMessage","typeLabel":"string | null"},"ParcelCode":{"oneOf":[{"type":"string","description":"The parcel code related to the document.","uniqueKey":"ShipperManifests.items.[INDEX].ParcelCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"The parcel code related to the document.","uniqueKey":"ShipperManifests.items.[INDEX].ParcelCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"ShipperManifests.items.[INDEX].ParcelCode","typeLabel":"string | null"},"ShippingServiceName":{"oneOf":[{"type":"string","description":"The name of the shipping service for this document (relevant for DispatchOrders and DispatchConsolidatedShipment).","uniqueKey":"ShipperManifests.items.[INDEX].ShippingServiceName.oneOf.0","typeLabel":"string"},{"type":"null","description":"The name of the shipping service for this document (relevant for DispatchOrders and DispatchConsolidatedShipment).","uniqueKey":"ShipperManifests.items.[INDEX].ShippingServiceName.oneOf.1","typeLabel":"null"}],"uniqueKey":"ShipperManifests.items.[INDEX].ShippingServiceName","typeLabel":"string | null"},"URL":{"type":"string","format":"uri","description":"URL of the document.","uniqueKey":"ShipperManifests.items.[INDEX].URL","typeLabel":"string\u003curi>"}},"uniqueKey":"ShipperManifests.items.[INDEX]","typeLabel":"OrderDocument · object"},"uniqueKey":"ShipperManifests","typeLabel":"OrderDocument · object[]"},"Errors":{"type":"array","description":"The orders that could not be dispatched, one entry per order. See [DispatchOrders error codes](/shipping-documents-api#dispatchorders-error-codes).","items":{"type":"object","title":"ShipperManifestError","properties":{"OrderID":{"type":"string","description":"The Global-e order ID the error refers to.","uniqueKey":"Errors.items.[INDEX].OrderID","typeLabel":"string"},"ErrorCode":{"type":"string","example":"B001","description":"The error code. See [DispatchOrders error codes](/shipping-documents-api#dispatchorders-error-codes).","uniqueKey":"Errors.items.[INDEX].ErrorCode","typeLabel":"string"},"ErrorText":{"type":"string","description":"Description of the error.","uniqueKey":"Errors.items.[INDEX].ErrorText","typeLabel":"string"},"MerchantOrderID":{"type":"string","description":"The merchant's order ID for the order. Empty when the order was not found.","uniqueKey":"Errors.items.[INDEX].MerchantOrderID","typeLabel":"string"}},"uniqueKey":"Errors.items.[INDEX]","typeLabel":"ShipperManifestError · object"},"uniqueKey":"Errors","typeLabel":"ShipperManifestError · object[]"}},"uniqueKey":"","typeLabel":"ShipperManifestsResponse · object"},"examples":{"Example":{"title":"Example","value":{"IsSuccess":true,"ErrorText":"\u003cstring>","ShipperManifests":[{"DocumentData":"\u003cstring>","DocumentExtension":"\u003cstring>","DocumentTypeCode":"1","DocumentTypeName":"\u003cstring>","ErrorMessage":"\u003cstring>","ParcelCode":"\u003cstring>","ShippingServiceName":"\u003cstring>","URL":"\u003cstring>"}],"Errors":[{"OrderID":"\u003cstring>","ErrorCode":"B001","ErrorText":"\u003cstring>","MerchantOrderID":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"ab312d97-94e0-486d-b291-dcad331f3530":{"description":"The request was not accepted, for example a `HubCode` that is not mapped to a Global-e hub. No order was processed.","content":{"application/json":{"schema":{"type":"object","title":"ErrorInfo","description":"A request-level failure. The call itself was not accepted, so no order was processed.","properties":{"Code":{"type":"string","description":"Error code.","uniqueKey":"Code","typeLabel":"string"},"Error":{"type":"string","description":"Error message.","uniqueKey":"Error","typeLabel":"string"},"Description":{"type":"string","description":"Error description.","uniqueKey":"Description","typeLabel":"string"},"Success":{"type":"boolean","description":"Always `false` on an error.","uniqueKey":"Success","typeLabel":"boolean"}},"uniqueKey":"","typeLabel":"ErrorInfo · object"},"example":{"Code":"400","Error":"The HubCode 'HUB-001' is not mapped to a GlobalE HubId.","Description":"Provide a valid hub code.","Success":false},"examples":{"Example":{"title":"Example","value":{"Code":"400","Error":"The HubCode 'HUB-001' is not mapped to a GlobalE HubId.","Description":"Provide a valid hub code.","Success":false}}},"exampleType":"examples"}},"exampleType":"examples"},"6947b731-a8f5-4560-a9b4-ad6cab83d43d":{"description":"The dispatch failed. The body has the same shape as a successful response, with `IsSuccess` set to `false`: `ErrorText` describes the failure, and `Errors` lists each order that could not be dispatched.","content":{"application/json":{"schema":{"type":"object","title":"ShipperManifestsResponse","description":"The result of the dispatch: the shipment's documents and the orders that could not be dispatched.","properties":{"IsSuccess":{"type":"boolean","description":"Indicates if the API call was successful or not. TRUE - API call was successful; FALSE - API call was not successful.","uniqueKey":"IsSuccess","typeLabel":"boolean"},"ErrorText":{"oneOf":[{"type":"string","description":"Description of the error to get documents.","uniqueKey":"ErrorText.oneOf.0","typeLabel":"string"},{"type":"null","description":"Description of the error to get documents.","uniqueKey":"ErrorText.oneOf.1","typeLabel":"null"}],"uniqueKey":"ErrorText","typeLabel":"string | null"},"ShipperManifests":{"type":"array","description":"List of OrderDocument objects that hold shipper manifest documents, including the consolidated shipment manifest.","items":{"type":"object","title":"OrderDocument","properties":{"DocumentData":{"type":"string","description":"Base64 encoded byte array representing the document file content.","uniqueKey":"ShipperManifests.items.[INDEX].DocumentData","typeLabel":"string"},"DocumentExtension":{"type":"string","description":"Document extension (PDF, ZPL, EPL).","uniqueKey":"ShipperManifests.items.[INDEX].DocumentExtension","typeLabel":"string"},"DocumentTypeCode":{"type":"string","description":"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.","enum":["1","2","3","4","5","6","7","8","9","10","11"],"uniqueKey":"ShipperManifests.items.[INDEX].DocumentTypeCode","typeLabel":"enum\u003cstring>"},"DocumentTypeName":{"type":"string","description":"Document type name, e.g. AWB, CommercialInvoiceAndPackingList or Manifest.","uniqueKey":"ShipperManifests.items.[INDEX].DocumentTypeName","typeLabel":"string"},"ErrorMessage":{"oneOf":[{"type":"string","description":"Description of the error for this entity (order/parcel) if it happened.","uniqueKey":"ShipperManifests.items.[INDEX].ErrorMessage.oneOf.0","typeLabel":"string"},{"type":"null","description":"Description of the error for this entity (order/parcel) if it happened.","uniqueKey":"ShipperManifests.items.[INDEX].ErrorMessage.oneOf.1","typeLabel":"null"}],"uniqueKey":"ShipperManifests.items.[INDEX].ErrorMessage","typeLabel":"string | null"},"ParcelCode":{"oneOf":[{"type":"string","description":"The parcel code related to the document.","uniqueKey":"ShipperManifests.items.[INDEX].ParcelCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"The parcel code related to the document.","uniqueKey":"ShipperManifests.items.[INDEX].ParcelCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"ShipperManifests.items.[INDEX].ParcelCode","typeLabel":"string | null"},"ShippingServiceName":{"oneOf":[{"type":"string","description":"The name of the shipping service for this document (relevant for DispatchOrders and DispatchConsolidatedShipment).","uniqueKey":"ShipperManifests.items.[INDEX].ShippingServiceName.oneOf.0","typeLabel":"string"},{"type":"null","description":"The name of the shipping service for this document (relevant for DispatchOrders and DispatchConsolidatedShipment).","uniqueKey":"ShipperManifests.items.[INDEX].ShippingServiceName.oneOf.1","typeLabel":"null"}],"uniqueKey":"ShipperManifests.items.[INDEX].ShippingServiceName","typeLabel":"string | null"},"URL":{"type":"string","format":"uri","description":"URL of the document.","uniqueKey":"ShipperManifests.items.[INDEX].URL","typeLabel":"string\u003curi>"}},"uniqueKey":"ShipperManifests.items.[INDEX]","typeLabel":"OrderDocument · object"},"uniqueKey":"ShipperManifests","typeLabel":"OrderDocument · object[]"},"Errors":{"type":"array","description":"The orders that could not be dispatched, one entry per order. See [DispatchOrders error codes](/shipping-documents-api#dispatchorders-error-codes).","items":{"type":"object","title":"ShipperManifestError","properties":{"OrderID":{"type":"string","description":"The Global-e order ID the error refers to.","uniqueKey":"Errors.items.[INDEX].OrderID","typeLabel":"string"},"ErrorCode":{"type":"string","example":"B001","description":"The error code. See [DispatchOrders error codes](/shipping-documents-api#dispatchorders-error-codes).","uniqueKey":"Errors.items.[INDEX].ErrorCode","typeLabel":"string"},"ErrorText":{"type":"string","description":"Description of the error.","uniqueKey":"Errors.items.[INDEX].ErrorText","typeLabel":"string"},"MerchantOrderID":{"type":"string","description":"The merchant's order ID for the order. Empty when the order was not found.","uniqueKey":"Errors.items.[INDEX].MerchantOrderID","typeLabel":"string"}},"uniqueKey":"Errors.items.[INDEX]","typeLabel":"ShipperManifestError · object"},"uniqueKey":"Errors","typeLabel":"ShipperManifestError · object[]"}},"uniqueKey":"","typeLabel":"ShipperManifestsResponse · object"},"example":{"IsSuccess":false,"ErrorText":"There are no orders valid for dispatch.","ShipperManifests":[],"Errors":[{"OrderID":"GE2794623GB","ErrorCode":"B001","ErrorText":"Order ID: GE2794623GB - not found.","MerchantOrderID":""}]},"examples":{"Example":{"title":"Example","value":{"IsSuccess":false,"ErrorText":"There are no orders valid for dispatch.","ShipperManifests":[],"Errors":[{"OrderID":"GE2794623GB","ErrorCode":"B001","ErrorText":"Order ID: GE2794623GB - not found.","MerchantOrderID":""}]}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{},"servers":{"d7f07595-7b1e-4c55-99f3-eb37f95a8008":{"url":"https://{globale_api_domain}","variables":{"globale_api_domain":{"default":"globale_api_domain","description":"Global-e API host, supplied to the merchant by Global-e."}}}}},"originalFileLocation":"api-reference/specs/dispatchconsolidatedshipment.yaml"},"subdomain":"globale-enterprise","siteName":"Global-e Docs","title":"Dispatch consolidated shipment (Merchant to Global-e) - Global-e Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-06T16:37:20.027Z","originalFileLocation":"api-reference/dispatch-consolidated-shipment.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Dispatches multiple orders that ship together as a single consolidated shipment. Global-e generates the shared manifest and AWB and returns the shipping documents.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Global-e Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/globale-enterprise/EOVvyAKmQUMv4BUM/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/globale-enterprise/EOVvyAKmQUMv4BUM/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/globale-enterprise/EOVvyAKmQUMv4BUM/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/globale-enterprise/EOVvyAKmQUMv4BUM/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/globale-enterprise/EOVvyAKmQUMv4BUM/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/globale-enterprise/EOVvyAKmQUMv4BUM/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/globale-enterprise/EOVvyAKmQUMv4BUM/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/globale-enterprise/EOVvyAKmQUMv4BUM/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/globale-enterprise/EOVvyAKmQUMv4BUM/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Dispatch consolidated shipment (Merchant to Global-e) - Global-e Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Dispatches multiple orders that ship together as a single consolidated shipment. Global-e generates the shared manifest and AWB and returns the shipping documents.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Global-e Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.global-e.com/api-reference/dispatch-consolidated-shipment\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://globale-enterprise.mintlify.site/_mintlify/api/og/v2?division=Shipping\u0026amp;title=Dispatch+consolidated+shipment+%28Merchant+to+Global-e%29\u0026amp;description=Dispatches+multiple+orders+that+ship+together+as+a+single+consolidated+shipment.+Global-e+generates+the+shared+manifest+and+AWB+and+returns+the+shipping+documen\u0026amp;theme=0ea9e7954698576748f01fb6\u0026amp;signature=ab3cd92ba41c652ab22cba959f6b89517f7b1eda4ad295a362c4fbb367415cf5\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Dispatch consolidated shipment (Merchant to Global-e) - Global-e Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Dispatches multiple orders that ship together as a single consolidated shipment. Global-e generates the shared manifest and AWB and returns the shipping documents.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://globale-enterprise.mintlify.site/_mintlify/api/og/v2?division=Shipping\u0026amp;title=Dispatch+consolidated+shipment+%28Merchant+to+Global-e%29\u0026amp;description=Dispatches+multiple+orders+that+ship+together+as+a+single+consolidated+shipment.+Global-e+generates+the+shared+manifest+and+AWB+and+returns+the+shipping+documen\u0026amp;theme=0ea9e7954698576748f01fb6\u0026amp;signature=ab3cd92ba41c652ab22cba959f6b89517f7b1eda4ad295a362c4fbb367415cf5\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/globale-enterprise/EOVvyAKmQUMv4BUM/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Global-e Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#F15A2B\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.global-e.com/api-reference/dispatch-consolidated-shipment\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/dispatch-consolidated-shipment.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.global-e.com/#organization\",\"name\":\"Global-e Docs\",\"url\":\"https://docs.global-e.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/globale-enterprise/xvASI8IP64Cj0kr_/logo/light.png?fit=max\u0026auto=format\u0026n=xvASI8IP64Cj0kr_\u0026q=85\u0026s=3b5849fa849995b81b219c94b874d44f\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.global-e.com#website\",\"name\":\"Global-e Docs\",\"url\":\"https://docs.global-e.com\",\"publisher\":{\"@id\":\"https://docs.global-e.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.global-e.com/api-reference/dispatch-consolidated-shipment#webpage\",\"url\":\"https://docs.global-e.com/api-reference/dispatch-consolidated-shipment\",\"name\":\"Dispatch consolidated shipment (Merchant to Global-e)\",\"description\":\"Dispatches multiple orders that ship together as a single consolidated shipment. Global-e generates the shared manifest and AWB and returns the shipping documents.\",\"dateModified\":\"2026-11-06T16:37:20.027Z\",\"isPartOf\":{\"@id\":\"https://docs.global-e.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.global-e.com/api-reference/dispatch-consolidated-shipment#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.global-e.com/api-reference/dispatch-consolidated-shipment#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Shipping\",\"item\":\"https://docs.global-e.com/api-reference/get-shipping-documents\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Dispatch consolidated shipment (Merchant to Global-e)\",\"item\":\"https://docs.global-e.com/api-reference/dispatch-consolidated-shipment\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.global-e.com/api-reference/dispatch-consolidated-shipment#apireference\",\"headline\":\"Dispatch consolidated shipment (Merchant to Global-e)\",\"name\":\"Dispatch consolidated shipment (Merchant to Global-e)\",\"description\":\"Dispatches multiple orders that ship together as a single consolidated shipment. Global-e generates the shared manifest and AWB and returns the shipping documents.\",\"url\":\"https://docs.global-e.com/api-reference/dispatch-consolidated-shipment\",\"mainEntityOfPage\":{\"@id\":\"https://docs.global-e.com/api-reference/dispatch-consolidated-shipment#webpage\"},\"dateModified\":\"2026-11-06T16:37:20.027Z\",\"publisher\":{\"@id\":\"https://docs.global-e.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.global-e.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Global-e Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Global-e Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/dispatch-consolidated-shipment.md","siteName":"Global-e Docs","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/global-e-enablement-platform"}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"API Reference","href":"/api-reference/overview"},{"title":"API Authentication","href":"/api-authentication"}]},{"group":"Shipping","pages":[{"title":"Get shipping documents (Merchant to Global-e)","sidebarTitle":"Get shipping documents","openapi":"api-reference/specs/getshippingdocuments.yaml POST /Order/GetShippingDocuments","href":"/api-reference/get-shipping-documents"},{"title":"Get shipping details (Merchant to Global-e)","sidebarTitle":"Get shipping details","openapi":"api-reference/specs/getshippingdetails.yaml POST /ShippingDetails/GetShippingDetails","href":"/api-reference/get-shipping-details"},{"title":"Get shipping details extended (Merchant to Global-e)","sidebarTitle":"Get shipping details extended","openapi":"api-reference/specs/getshippingdetailsextended.yaml POST /ShippingDetails/GetShippingDetailsExtended","href":"/api-reference/get-shipping-details-extended"},{"title":"Get free shipping banner data (Merchant to Global-e)","sidebarTitle":"Get free shipping banner data","openapi":"api-reference/specs/freeshippingbannerdata.yaml GET /banners/data/free-shipping","href":"/api-reference/get-free-shipping-banner-data"},{"title":"Get free shipping banner data, anonymous (Merchant to Global-e)","sidebarTitle":"Get free shipping banner data (anonymous)","openapi":"api-reference/specs/freeshippingbannerdata.yaml GET /banners/data/{merchantId}/free-shipping","href":"/api-reference/get-free-shipping-banner-data-anonymous"},{"title":"Dispatch orders (Merchant to Global-e)","sidebarTitle":"Dispatch orders","description":"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.","openapi":"api-reference/specs/dispatchorders.yaml POST /Order/DispatchOrders","href":"/api-reference/dispatch-orders"},{"title":"Dispatch consolidated shipment (Merchant to Global-e)","sidebarTitle":"Dispatch consolidated shipment","openapi":"api-reference/specs/dispatchconsolidatedshipment.yaml POST /Order/DispatchConsolidatedShipment","href":"/api-reference/dispatch-consolidated-shipment"},{"title":"Get tracking events (Merchant to Global-e)","sidebarTitle":"Get tracking events","description":"Receive status events on the delivery status of an order — a list of Global-e order IDs and/or tracking numbers (all the same direction), returning their tracking events.","openapi":"api-reference/specs/gettrackingevents.yaml POST /Shipment/GetTrackingEvents","href":"/api-reference/get-tracking-events"},{"title":"Void parcel (Merchant to Global-e)","sidebarTitle":"Void parcel","openapi":"api-reference/specs/voidparcel.yaml POST /Parcel/VoidParcel","href":"/api-reference/void-parcel"},{"title":"Submit bonded information (Merchant to Global-e)","sidebarTitle":"Submit bonded information","openapi":"api-reference/specs/submitbondedinformation.yaml POST /api/merchant/parcels/bonded-information","href":"/api-reference/submit-bonded-information"},{"title":"Upload shipment documents (Merchant to Global-e)","sidebarTitle":"Upload shipment documents","openapi":"api-reference/specs/uploadshipmentdocuments.yaml POST /api/shipments/documents/upload","href":"/api-reference/upload-shipment-documents"},{"title":"Get shipment information (Merchant to Global-e)","sidebarTitle":"Get shipment information","openapi":"api-reference/specs/getshipmentinformation.yaml GET /api/shipments/{trackingNumber}","href":"/api-reference/get-shipment-information"}]},{"group":"Orders","pages":[{"title":"Create order (Merchant to Global-e)","sidebarTitle":"Create order","openapi":"api-reference/specs/createorder.yaml POST /checkout/CreateOrder","href":"/api-reference/create-order"},{"title":"Edit order (Merchant to Global-e)","sidebarTitle":"Edit order","openapi":"api-reference/specs/editorder.yaml POST /api/orders/changes","href":"/api-reference/edit-order"},{"title":"Quote order changes (Merchant to Global-e)","sidebarTitle":"Quote order changes","openapi":"api-reference/specs/editorder.yaml POST /api/orders/changes/quote","href":"/api-reference/edit-order-quote"},{"title":"Update Order Dispatch","openapi":"api-reference/specs/updateorderdispatch.yaml POST /Order/UpdateOrderDispatch","href":"/api-reference/update-order-dispatch"},{"title":"Update parcel status (Merchant to Global-e)","sidebarTitle":"Update parcel status","openapi":"api-reference/specs/updateparcelstatus.yaml POST /orders/{orderId}/parcels/{parcelCode}/statuses","href":"/api-reference/update-parcel-status"},{"title":"Update Order Status","openapi":"api-reference/specs/updateorderstatus.yaml POST /Order/UpdateOrderStatus","href":"/api-reference/update-order-status"},{"title":"Create order refund (Merchant to Global-e)","sidebarTitle":"Create order refund","openapi":"api-reference/specs/createorderrefund.yaml POST /Order/CreateOrderRefund","href":"/api-reference/create-order-refund"},{"title":"Create order platform (Merchant to Global-e)","sidebarTitle":"Create order platform","openapi":"api-reference/specs/createorderplatform.yaml POST /Checkout/CreateOrderPlatform","href":"/api-reference/create-order-platform"},{"title":"Update Order Products (Merchant to Global-e)","sidebarTitle":"Update Order Products","openapi":"api-reference/specs/updateorderproducts.yaml POST /Order/UpdateOrderProducts","href":"/api-reference/update-order-products"},{"title":"UpdateOrderDispatchV2","openapi":"api-reference/specs/updateorderdispatchv2.yaml POST /Order/UpdateOrderDispatchV2","href":"/api-reference/update-order-dispatch-v2"},{"title":"Create Additional Required Documents (Merchant to Global-e)","sidebarTitle":"Create Additional Required Documents","openapi":"api-reference/specs/createadditionalrequireddocuments.yaml POST /additional-required-documents","href":"/api-reference/create-additional-required-documents"},{"title":"Get refund details (Merchant to Global-e)","sidebarTitle":"Get refund details","openapi":"api-reference/specs/getrefunddetails.yaml GET /v1/orders/{orderId}/refunds","href":"/api-reference/get-refund-details"},{"title":"Sending Bulk Emails (Merchant to Global-e)","sidebarTitle":"Sending Bulk Emails","openapi":"api-reference/specs/sendbulkemails.yaml POST /emails","href":"/api-reference/send-bulk-emails"}]},{"group":"Returns","pages":[{"title":"Get return shipping options (Merchant to Global-e)","sidebarTitle":"Get return shipping options","openapi":"api-reference/specs/getreturnshippingoptions.yaml POST /Return/GetReturnShippingOptions","href":"/api-reference/get-return-shipping-options"},{"title":"Get return documents (Merchant to Global-e)","sidebarTitle":"Get return documents","openapi":"api-reference/specs/getreturndocuments.yaml POST /Return/GetReturnDocuments","href":"/api-reference/get-return-documents"},{"title":"Update RMA (Merchant to Global-e)","sidebarTitle":"Update RMA","openapi":"api-reference/specs/updaterma.yaml POST /Return/UpdateRMA","href":"/api-reference/update-rma"}]},{"group":"Gift Cards","pages":[{"title":"Validate gift card","openapi":"api-reference/specs/giftcards.yaml POST /ValidateGiftCard","href":"/api-reference/validate-gift-card"},{"title":"Redeem gift card","openapi":"api-reference/specs/giftcards.yaml POST /RedeemGiftCard","href":"/api-reference/redeem-gift-card"},{"title":"Refund gift card","openapi":"api-reference/specs/giftcards.yaml POST /RefundGiftCard","href":"/api-reference/refund-gift-card"}]},{"group":"Checkout","pages":[{"title":"SendCartV2 (Merchant to Global-e)","sidebarTitle":"SendCartV2","openapi":"api-reference/specs/sendcartv2.yaml POST /Checkout/SendCartV2","href":"/api-reference/send-cart-v2"}]},{"group":"Pricing","pages":[{"title":"Get catalog prices (Merchant to Global-e)","sidebarTitle":"Get catalog prices","openapi":"api-reference/specs/getcatalogprices.yaml POST /Browsing/GetCatalogPrices","href":"/api-reference/get-catalog-prices"},{"title":"GetMerchantPriceDetails (Merchant to Global-e)","sidebarTitle":"GetMerchantPriceDetails","openapi":"api-reference/specs/getmerchantpricedetails.yaml GET /externalapi/GetMerchantPriceDetails","href":"/api-reference/get-merchant-price-details"}]},{"group":"Browsing \u0026 Catalog","pages":[{"title":"Active hub details (Merchant to Global-e)","sidebarTitle":"Active hub details","openapi":"api-reference/specs/activehubdetails.yaml POST /Browsing/ActiveHubDetails","href":"/api-reference/active-hub-details"},{"title":"App settings (Merchant to Global-e)","sidebarTitle":"App settings","openapi":"api-reference/specs/appsettings.yaml POST /Browsing/AppSettings","href":"/api-reference/app-settings"},{"title":"App version (Merchant to Global-e)","sidebarTitle":"App version","openapi":"api-reference/specs/appversion.yaml POST /Browsing/AppVersion","href":"/api-reference/app-version"},{"title":"Countries (Merchant to Global-e)","sidebarTitle":"Countries","openapi":"api-reference/specs/countries.yaml POST /Browsing/Countries","href":"/api-reference/countries"},{"title":"Country coefficients (Merchant to Global-e)","sidebarTitle":"Country coefficients","openapi":"api-reference/specs/countrycoefficients.yaml POST /Browsing/CountryCoefficients","href":"/api-reference/country-coefficients"},{"title":"Currencies (Merchant to Global-e)","sidebarTitle":"Currencies","openapi":"api-reference/specs/currencies.yaml POST /Browsing/Currencies","href":"/api-reference/currencies"},{"title":"Currency Rates (Merchant to Global-e)","sidebarTitle":"Currency Rates","openapi":"api-reference/specs/currencyrates.yaml POST /Browsing/CurrencyRates","href":"/api-reference/currency-rates"},{"title":"Location by IP (Merchant to Global-e)","sidebarTitle":"Location by IP","openapi":"api-reference/specs/locationbyip.yaml POST /Browsing/LocationByIP","href":"/api-reference/location-by-ip"},{"title":"Location default culture (Merchant to Global-e)","sidebarTitle":"Location default culture","openapi":"api-reference/specs/locationdefaultculture.yaml POST /Browsing/LocationDefaultCulture","href":"/api-reference/location-default-culture"},{"title":"Locations Default Cultures List (Merchant to Global-e)","sidebarTitle":"Locations Default Cultures List","openapi":"api-reference/specs/locationsdefaultcultureslist.yaml POST /Browsing/LocationsDefaultCulturesList","href":"/api-reference/locations-default-cultures-list"},{"title":"Product Countries (Merchant to Global-e)","sidebarTitle":"Product Countries","openapi":"api-reference/specs/productcountries.yaml POST /Browsing/ProductCountryS","href":"/api-reference/product-countries"},{"title":"Recent Product Countries (Merchant to Global-e)","sidebarTitle":"Recent Product Countries","openapi":"api-reference/specs/recentproductcountries.yaml POST /Browsing/RecentProductCountryS","href":"/api-reference/recent-product-countries"},{"title":"Regions (Merchant to Global-e)","sidebarTitle":"Regions","openapi":"api-reference/specs/regions.yaml POST /Browsing/Regions","href":"/api-reference/regions"},{"title":"Rounding rules (Merchant to Global-e)","sidebarTitle":"Rounding rules","openapi":"api-reference/specs/roundingrules.yaml POST /Browsing/RoundingRules","href":"/api-reference/rounding-rules"},{"title":"Save products list (Merchant to Global-e)","sidebarTitle":"Save products list","openapi":"api-reference/specs/saveproductslist.yaml POST /Browsing/SaveProductsList","href":"/api-reference/save-products-list"},{"title":"Save Products Bulk (Merchant to Global-e)","sidebarTitle":"Save Products Bulk","openapi":"api-reference/specs/saveproductsbulk.yaml POST /Bulk/SaveProductsBulk","href":"/api-reference/save-products-bulk"},{"title":"Shipping Options (Merchant to Global-e)","sidebarTitle":"Shipping Options","openapi":"api-reference/specs/shippingoptions.yaml POST /Browsing/ShippingOptions","href":"/api-reference/shipping-options"},{"title":"VAT Category Countries (Merchant to Global-e)","sidebarTitle":"VAT Category Countries","openapi":"api-reference/specs/vatcategorycountries.yaml POST /Browsing/VATCategoryCountryS","href":"/api-reference/vat-category-countries"}]},{"group":"Subscriptions","pages":[{"title":"Get subscription and payment reference details (Merchant to Global-e)","sidebarTitle":"Get subscription and payment reference details","openapi":"api-reference/specs/getsubscriptionandpaymentreferencedetails.yaml GET /Payments/Subscriptions/{merchantGuid}","href":"/api-reference/get-subscription-and-payment-reference-details"},{"title":"Subscription notifications (Subscription Manager to Global-e)","sidebarTitle":"Subscription notifications","openapi":"api-reference/specs/subscriptionnotifications.yaml POST /subscriptions/notifications","href":"/api-reference/subscription-notifications"},{"title":"Calculate billing summary (Subscription Manager to Global-e)","sidebarTitle":"Calculate billing summary","openapi":"api-reference/specs/billingsummarycalculate.yaml POST /subscriptions/billing-summary/calculate","href":"/api-reference/calculate-billing-summary"},{"title":"Create recurring payment (Subscription Manager to Global-e)","sidebarTitle":"Create recurring payment","openapi":"api-reference/specs/recurringpayments.yaml POST /subscriptions/recurringPayments","href":"/api-reference/create-recurring-payment"},{"title":"Update a subscription (Subscription Manager to Global-e)","sidebarTitle":"Update a subscription","openapi":"api-reference/specs/updatesubscription.yaml PATCH /subscriptions/{subscriptionId}","href":"/api-reference/update-subscription"}]},{"group":"Webhooks","pages":[{"group":"Orders","pages":[{"title":"Send Order To Merchant (Global-e to Merchant)","sidebarTitle":"Send Order To Merchant","openapi":"api-reference/specs/sendordertomerchant.yaml POST /order-update-create-url","href":"/api-reference/send-order-to-merchant"},{"title":"Send additional required documents to merchant (Global-e to Merchant)","sidebarTitle":"Send additional required documents to merchant","openapi":"api-reference/specs/sendadditionalrequireddocumentstomerchant.yaml POST /send-additional-required-documents-url","href":"/api-reference/send-additional-required-documents-to-merchant"},{"title":"Notify order refund (Global-e to Merchant)","sidebarTitle":"Notify order refund","openapi":"api-reference/specs/notifyorderrefund.yaml POST /order-refund-url","href":"/api-reference/notify-order-refund"},{"title":"Update Order Shipping Info (Global-e to Merchant)","sidebarTitle":"Update Order Shipping Info","openapi":"api-reference/specs/updateordershippinginfo.yaml POST /order-shipping-info-update-only-url","href":"/api-reference/update-order-shipping-info"},{"title":"Update Order Status (Global-e to Merchant)","sidebarTitle":"Update Order Status","openapi":"api-reference/specs/updateorderstatusfromglobale.yaml POST /order-status-update-url","href":"/api-reference/update-order-status-from-globale"},{"title":"Send RMA Info to Merchant (Global-e to Merchant)","sidebarTitle":"Send RMA Info to Merchant","openapi":"api-reference/specs/sendrmainfomerchant.yaml POST /rma-info-to-merchant-url","href":"/api-reference/send-rma-info-merchant"},{"title":"Perform Order Payment (Global-e to Merchant)","sidebarTitle":"Perform Order Payment","openapi":"api-reference/specs/performorderpayment.yaml POST /order-payment-only-url","href":"/api-reference/perform-order-payment"}]},{"group":"Checkout \u0026 Cart","pages":[{"title":"Get Checkout Cart Info (Global-e to Merchant)","sidebarTitle":"Get Checkout Cart Info","openapi":"api-reference/specs/getcheckoutcartinfo.yaml GET /get-checkout-cart-info-url","href":"/api-reference/get-checkout-cart-info"},{"title":"Validate Stock (Global-e to Merchant)","sidebarTitle":"Validate Stock","openapi":"api-reference/specs/validatestock.yaml POST /checkout-validate-cart-stock-url","href":"/api-reference/validate-stock"},{"title":"ValidateVoucher (Global-e to Merchant)","sidebarTitle":"ValidateVoucher","openapi":"api-reference/specs/validatevoucher.yaml POST /checkout-validate-cart-voucher-url","href":"/api-reference/validate-voucher"},{"title":"Client apply loyalty vouchers (Global-e to Merchant)","sidebarTitle":"Client apply loyalty vouchers","openapi":"api-reference/specs/clientapplyloyaltyvouchers.yaml POST /ClientApplyLoyaltyVouchers","href":"/api-reference/client-apply-loyalty-vouchers"},{"title":"RemoveRestrictedProducts (Global-e to Merchant)","sidebarTitle":"RemoveRestrictedProducts","openapi":"api-reference/specs/removerestrictedproducts.yaml POST /remove-restricted-products-url","href":"/api-reference/remove-restricted-products"}]},{"group":"Fulfillment","pages":[{"title":"Update Parcel Dispatch","openapi":"api-reference/specs/updateparceldispatch.yaml POST /UpdateParcelDispatch","href":"/api-reference/update-parcel-dispatch"}]},{"group":"Subscriptions","pages":[{"title":"Recurring payment notifications (Global-e to Subscription Manager)","sidebarTitle":"Recurring payment notifications","openapi":"api-reference/specs/recurringpaymentnotifications.yaml POST /subscriptions/recurringPayments/notifications","href":"/api-reference/recurring-payment-notifications"}]}]},{"group":"Shared Objects","pages":[{"title":"Attributes","href":"/api-reference/objects/attributes"},{"title":"BillingDetails","href":"/api-reference/objects/billing-details"},{"title":"Brand","href":"/api-reference/objects/brand"},{"title":"Category","href":"/api-reference/objects/category"},{"title":"DiscountsList","href":"/api-reference/objects/discounts-list"},{"title":"Parcel","href":"/api-reference/objects/parcel"},{"title":"ShippingDetails","href":"/api-reference/objects/shipping-details"},{"title":"UserIdNumberType","href":"/api-reference/objects/user-id-number-type"},{"title":"VATRateType","href":"/api-reference/objects/vat-rate-type"}]}]}]},"basePath":"","title":"Dispatch consolidated shipment (Merchant to Global-e) - Global-e Docs","buildId":"dpl_G2Qd45vZZ7MkBiGF9yYx8ZsbbKXX","deploymentId":"dpl_G2Qd45vZZ7MkBiGF9yYx8ZsbbKXX","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-NXj-Rqjv.js","utils-m0thOP-_.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-D13EKcfm.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema--XTdfsEb.js","snippetPresets-D3s4lmAH.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-ChURybxL.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DL8CiXq2.js","shallow-DI2-YB2E.js","getApiPlaygroundDisplay-DxbW7b_y.js","CodeSnippet-CiNYS0pP.js","CodeSnippets-BT87bThu.js","Page-DSpdRuhM.js","getPastedJson-F_g_IrFQ.js","icon-CCIG5BAs.js","MethodPill-DY3E0jwx.js","DuplicateIcon-BN88xnEg.js","createIcon-VCCc5HO5.js","DynamicMarkdown-CaSwclgK.js","SectionHeading-DXV8nWhc.js","axios-vUo_bRtp.js","Markdown-CV32Re6G.js","clsx-5ydLOnhV.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-pFDdfjRe.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BUGO5bPJ.js"]}