The order-level refund details, as a URL-encoded, JSON-serialized OrderRefundDetails object — passed in the query string, not in the request body. Only OrderId is required. See the integration guide for the object's fields.
The product line quantity to refund. If the amount attributes are not specified, a full refund is initiated for (product unit * quantity). For returnable products, use "null" for the refund attribute. Mandatory if appeasements are not enabled.
Preferred if not full product amount - The total product line refund amount in Merchant currency, if partial will be backward pro-rated for reconciliation.
If partial, the total product line refund amount in Customer currency will be pro-rated for customer values from transaction amounts. The amount must include domestic VAT, if applicable.
Add comments about the refund for logging on the Global-e side.
Response
Refund processed. The same envelope carries both successful and processing-error outcomes — distinguished by Success. On a processing error, Success is false and NotifyOrderRefund is null.
Notifies the merchant about Global-E initiated refund issued to the end customer.
Show child attributes
{"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":""},"chroma":{"collectionId":"512fb028-3e65-4b3e-a3cf-b3550e4b3bb3","liveDeploymentHistoryId":"6ae36b0095eb8a3e5a09981b","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae36b0095eb8a3e5a09981b"},"feedback":{"thumbs":false},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae36b0095eb8a3e5a09981b","clientVersion":"0.0.4043","searchFilterCounts":[{"language":"default","tag":"Documentation","count":477},{"language":"default","tag":"Topics","count":477},{"language":"default","tag":"eCommerce Integration","count":182},{"language":"default","tag":"API Reference","count":80},{"language":"default","tag":"Global-e: The Basics","count":74},{"language":"default","tag":"SDK and API","count":53},{"language":"default","tag":"SFCC","count":48},{"language":"default","tag":"Merchant Portal","count":44},{"language":"default","tag":"New Returns Portal for All Platforms (Excluding Shopify)","count":44},{"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":"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":"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":"llms-txt-v2","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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","href":"/_mintlify/custom/globale-enterprise/bdd88c3538cea5b1/style.css"}],"page":{"pagePath":"api-reference/create-order-refund","slug":"/api-reference/create-order-refund","pageMetadata":{"contextual":{"options":[{"title":"View YAML","description":"Open the OpenAPI spec for this endpoint","icon":"file-code","href":"/api-reference/specs/createorderrefund.yaml"},"download-spec","copy","view","chatgpt","claude"]},"title":"Create order refund (Merchant to Global-e)","sidebarTitle":"Create order refund","description":"Issues a refund for the specified order, optionally including a product list and/or components (service gesture, shipping, Duties \u0026 Taxes).","openapi":"api-reference/specs/createorderrefund.yaml POST /Order/CreateOrderRefund","href":"/api-reference/create-order-refund"},"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: \"Issues a refund for the specified order, optionally including a product list and/or components (service gesture, shipping, Duties \u0026 Taxes).\"\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{jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,p:`p`,..._provideComponents(),...props.components},{Note}=_components;if(!Note)_missingMdxReference(`Note`,true);return _jsx(Note,{children:_jsxs(_components.p,{children:[`Part of the `,_jsx(_components.a,{href:`/refunds-via-api`,children:`Refunds`}),` integration guide — see it for when and how to use this endpoint.`]})})}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/createorderrefund.yaml"},"download-spec","copy","view","chatgpt","claude"]},"title":"Create order refund (Merchant to Global-e)","sidebarTitle":"Create order refund","description":"Issues a refund for the specified order, optionally including a product list and/or components (service gesture, shipping, Duties \u0026 Taxes).","openapi":"api-reference/specs/createorderrefund.yaml POST /Order/CreateOrderRefund","href":"/api-reference/create-order-refund"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"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"],"openApiReferenceData":{"operation":{"summary":"Create a refund for an order","description":"Issues a refund for the specified order, optionally including a product list and/or components (service gesture, shipping, Duties \u0026 Taxes).","operationId":"createOrderRefund","tags":["CreateOrderRefund"],"x-codeSamples":[{"lang":"cURL","source":"curl --request POST \\\n --url 'https://{globale_api_domain}/Order/CreateOrderRefund?orderRefund={\"OrderId\":\"GE95135467GB\",\"FullRefund\":false,\"TotalRefundAmount\":\"320\",\"RefundReason\":{\"OrderRefundReasonCode\":null,\"Name\":\"Undefined\"}}' \\\n --header 'Content-Type: application/json' \\\n --data '[{\"CartItemId\":\"1381109\",\"RefundQuantity\":null,\"RefundAmount\":\"320\"}]'"}],"parameters":["7e84826a-f599-4812-9f21-0f2e6465a177"],"requestBody":"510621bb-58c1-4b36-b970-fa9104e538a1","responses":{"200":"31182723-03ca-4223-9802-53e64e218adb","400":"62aa7834-3850-4762-91a7-878af4fe16d8"},"method":"post","type":"path","servers":["b04f4125-72f9-4356-8f3a-104b32ca3809"],"security":[],"path":"/Order/CreateOrderRefund","baseUrlOptions":["https://{globale_api_domain}"],"title":"Create a refund for an order","codeSamples":[{"lang":"cURL","source":"curl --request POST \\\n --url 'https://{globale_api_domain}/Order/CreateOrderRefund?orderRefund={\"OrderId\":\"GE95135467GB\",\"FullRefund\":false,\"TotalRefundAmount\":\"320\",\"RefundReason\":{\"OrderRefundReasonCode\":null,\"Name\":\"Undefined\"}}' \\\n --header 'Content-Type: application/json' \\\n --data '[{\"CartItemId\":\"1381109\",\"RefundQuantity\":null,\"RefundAmount\":\"320\"}]'"}],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{"7e84826a-f599-4812-9f21-0f2e6465a177":{"name":"orderRefund","in":"query","required":true,"description":"The order-level refund details, as a **URL-encoded, JSON-serialized `OrderRefundDetails` object** — passed in the query string, **not** in the request body. Only `OrderId` is required. See the integration guide for the object's fields.","schema":{"type":"string","example":"{\"OrderId\":\"GE95135467GB\",\"FullRefund\":false,\"TotalRefundAmount\":\"320\",\"RefundReason\":{\"OrderRefundReasonCode\":null,\"Name\":\"Undefined\"}}","isRequired":true,"description":"The order-level refund details, as a **URL-encoded, JSON-serialized `OrderRefundDetails` object** — passed in the query string, **not** in the request body. Only `OrderId` is required. See the integration guide for the object's fields.","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","title":"RefundProduct","description":"A product line to refund. One of CartItemId or ProductCode is required.","properties":{"CartItemId":{"type":"string","description":"The unique product line identifier at the order level, as provided in GetCheckoutCartInfo and returned in SendOrderToMerchant (Global-e to Merchant).","uniqueKey":"items.[INDEX].CartItemId","typeLabel":"string"},"ProductCode":{"type":"string","description":"The code of the product. This can be either the SKU or the ProductCodeSecondary. Mandatory if CartItemId is not specified.","uniqueKey":"items.[INDEX].ProductCode","typeLabel":"string"},"RefundQuantity":{"oneOf":[{"type":"string","description":"The product line quantity to refund. If the amount attributes are not specified, a full refund is initiated for (product unit * quantity). For returnable products, use \"null\" for the refund attribute. Mandatory if appeasements are not enabled.","uniqueKey":"items.[INDEX].RefundQuantity.oneOf.0","typeLabel":"string"},{"type":"null","description":"The product line quantity to refund. If the amount attributes are not specified, a full refund is initiated for (product unit * quantity). For returnable products, use \"null\" for the refund attribute. Mandatory if appeasements are not enabled.","uniqueKey":"items.[INDEX].RefundQuantity.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].RefundQuantity","typeLabel":"string | null"},"OriginalRefundAmount":{"type":"string","description":"Preferred if not full product amount - The total product line refund amount in Merchant currency, if partial will be backward pro-rated for reconciliation.","uniqueKey":"items.[INDEX].OriginalRefundAmount","typeLabel":"string"},"RefundAmountPercent":{"type":"string","description":"The total product line refund amount, in %.","uniqueKey":"items.[INDEX].RefundAmountPercent","typeLabel":"string"},"RefundAmount":{"type":"string","description":"If partial, the total product line refund amount in Customer currency will be pro-rated for customer values from transaction amounts. The amount must include domestic VAT, if applicable.","uniqueKey":"items.[INDEX].RefundAmount","typeLabel":"string"},"RefundReason":{"type":"object","title":"OrderRefundReasonObject","properties":{"OrderRefundReasonCode":{"oneOf":[{"type":"string","description":"Code denoting the order refund reason on the Merchant site (for mapping on the Global-e side)","uniqueKey":"items.[INDEX].RefundReason.OrderRefundReasonCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"Code denoting the order refund reason on the Merchant site (for mapping on the Global-e side)","uniqueKey":"items.[INDEX].RefundReason.OrderRefundReasonCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].RefundReason.OrderRefundReasonCode","typeLabel":"string | null"},"Name":{"type":"string","description":"The name of the order refund reason.","uniqueKey":"items.[INDEX].RefundReason.Name","typeLabel":"string"}},"description":"Provide the product line refund reason for logging on the Global-e side.","uniqueKey":"items.[INDEX].RefundReason","typeLabel":"OrderRefundReasonObject · object"},"RefundComments":{"type":"string","description":"Add comments about the refund for logging on the Global-e side.","uniqueKey":"items.[INDEX].RefundComments","typeLabel":"string"}},"uniqueKey":"items.[INDEX]","typeLabel":"RefundProduct · object"},"uniqueKey":"","typeLabel":"RefundProduct · object[]"},"example":[{"CartItemId":"1381109","RefundQuantity":null,"RefundAmount":"320"}],"examples":{"Example":{"title":"Example","value":[{"CartItemId":"1381109","RefundQuantity":null,"RefundAmount":"320"}]}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"31182723-03ca-4223-9802-53e64e218adb":{"description":"Refund processed. The same envelope carries both successful and processing-error outcomes — distinguished by `Success`. On a processing error, `Success` is false and `NotifyOrderRefund` is null.","content":{"application/json":{"schema":{"type":"object","title":"OrderRefundInfo","description":"Refund response envelope.","properties":{"Success":{"type":"boolean","description":"Indicates if the respective API method was successful","uniqueKey":"Success","typeLabel":"boolean"},"Reason":{"type":"string","description":"Text that optionally describes the reason for the Success status","uniqueKey":"Reason","typeLabel":"string"},"NotifyOrderRefund":{"oneOf":[{"type":"object","title":"Merchant.OrderRefund","description":"Notifies the merchant about Global-E initiated refund issued to the end customer.","properties":{"Components":{"type":"array","description":"List of RefundComponent objects for this order refund","items":{"type":"object","title":"Merchant.RefundComponent","properties":{"Amount":{"type":"string","description":"The refund amount in customer currency","uniqueKey":"NotifyOrderRefund.oneOf.0.Components.items.[INDEX].Amount","typeLabel":"string"},"ComponentType":{"type":"string","description":"Products, Shipping, Duties, PrepaidReturn or ServiceGesture.","uniqueKey":"NotifyOrderRefund.oneOf.0.Components.items.[INDEX].ComponentType","typeLabel":"string"},"IsChargedToMerchant":{"type":"string","description":"If this component is charged to the merchant, the flag is TRUE (default). If this component is charged to Global-E, the flag is FALSE. If the same component is split between charged to the merchant and charged to Global-E, it should appear twice, each time with a different value in IsChargedToMerchant. Exception is a component PrepaidReturn – it should always be IsChargedToMerchant = TRUE","uniqueKey":"NotifyOrderRefund.oneOf.0.Components.items.[INDEX].IsChargedToMerchant","typeLabel":"string"},"OriginalAmount":{"type":"string","description":"The refund amount in merchant currency","uniqueKey":"NotifyOrderRefund.oneOf.0.Components.items.[INDEX].OriginalAmount","typeLabel":"string"},"RefundAmount":{"type":"string","description":"The refund amount for this product line item in the end customer's currency used for this order's payment","uniqueKey":"NotifyOrderRefund.oneOf.0.Components.items.[INDEX].RefundAmount","typeLabel":"string"}},"uniqueKey":"NotifyOrderRefund.oneOf.0.Components.items.[INDEX]","typeLabel":"Merchant.RefundComponent · object"},"uniqueKey":"NotifyOrderRefund.oneOf.0.Components","typeLabel":"Merchant.RefundComponent · object[]"},"FullRefund":{"type":"boolean","description":"The flag indicating that the full refund of the order should be performed (product,shipping,taxes)","uniqueKey":"NotifyOrderRefund.oneOf.0.FullRefund","typeLabel":"boolean"},"MerchantGUID":{"type":"string","description":"Unique identifier of the Merchant on Global-e","uniqueKey":"NotifyOrderRefund.oneOf.0.MerchantGUID","typeLabel":"string"},"MerchantOrderId":{"type":"string","description":"Unique order identifier on the Merchant's site","uniqueKey":"NotifyOrderRefund.oneOf.0.MerchantOrderId","typeLabel":"string"},"OrderId":{"type":"string","description":"Global-e order unique identifier","uniqueKey":"NotifyOrderRefund.oneOf.0.OrderId","typeLabel":"string"},"OriginalTotalRefundAmount":{"type":"string","description":"The refund amount in the original Merchant's currency including the local Merchant's VAT","uniqueKey":"NotifyOrderRefund.oneOf.0.OriginalTotalRefundAmount","typeLabel":"string"},"Products":{"type":"array","description":"List of Refund Product objects for this order refund","items":{"type":"object","title":"Merchant.RefundProduct","properties":{"CartItemId":{"type":"string","description":"Identifier of the line item on the Merchant's site","uniqueKey":"NotifyOrderRefund.oneOf.0.Products.items.[INDEX].CartItemId","typeLabel":"string"},"OriginalRefundAmount":{"type":"string","description":"Refund the amount in the original Merchant's currency including the local Merchant's VAT for this product line item, before applying any price modifications","uniqueKey":"NotifyOrderRefund.oneOf.0.Products.items.[INDEX].OriginalRefundAmount","typeLabel":"string"},"RefundAmount":{"type":"string","description":"The refund amount for this product line item in the end customer's currency used for this order's payment","uniqueKey":"NotifyOrderRefund.oneOf.0.Products.items.[INDEX].RefundAmount","typeLabel":"string"},"RefundComments":{"type":"string","description":"Comments for this product's refund","uniqueKey":"NotifyOrderRefund.oneOf.0.Products.items.[INDEX].RefundComments","typeLabel":"string"},"RefundQuantity":{"type":"string","description":"Product quantity","uniqueKey":"NotifyOrderRefund.oneOf.0.Products.items.[INDEX].RefundQuantity","typeLabel":"string"},"RefundReason":{"type":"object","title":"Merchant.OrderRefundReason","properties":{"Name":{"type":"string","description":"The name of the order refund reason.","uniqueKey":"NotifyOrderRefund.oneOf.0.Products.items.[INDEX].RefundReason.Name","typeLabel":"string"},"OrderRefundReasonCode":{"oneOf":[{"type":"string","description":"Code denoting the order refund reason on the Merchant site (for mapping on the Global-e side)","uniqueKey":"NotifyOrderRefund.oneOf.0.Products.items.[INDEX].RefundReason.OrderRefundReasonCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"Code denoting the order refund reason on the Merchant site (for mapping on the Global-e side)","uniqueKey":"NotifyOrderRefund.oneOf.0.Products.items.[INDEX].RefundReason.OrderRefundReasonCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"NotifyOrderRefund.oneOf.0.Products.items.[INDEX].RefundReason.OrderRefundReasonCode","typeLabel":"string | null"}},"description":"Reason for this product's refund","uniqueKey":"NotifyOrderRefund.oneOf.0.Products.items.[INDEX].RefundReason","typeLabel":"Merchant.OrderRefundReason · object"},"sku":{"type":"string","description":"SKU code used to identify the product on the Merchant's side (to be mapped on the Global-e side)","uniqueKey":"NotifyOrderRefund.oneOf.0.Products.items.[INDEX].sku","typeLabel":"string"}},"uniqueKey":"NotifyOrderRefund.oneOf.0.Products.items.[INDEX]","typeLabel":"Merchant.RefundProduct · object"},"uniqueKey":"NotifyOrderRefund.oneOf.0.Products","typeLabel":"Merchant.RefundProduct · object[]"},"RefundAsGiftCard":{"type":"boolean","description":"Identifies whether or not the refund was provided as a gift card","uniqueKey":"NotifyOrderRefund.oneOf.0.RefundAsGiftCard","typeLabel":"boolean"},"RefundComments":{"type":"string","description":"Comments for the order refund","uniqueKey":"NotifyOrderRefund.oneOf.0.RefundComments","typeLabel":"string"},"RefundId":{"type":"string","description":"Recorded refund id on the Global-e side","uniqueKey":"NotifyOrderRefund.oneOf.0.RefundId","typeLabel":"string"},"RefundReason":{"type":"object","title":"Merchant.OrderRefundReason","properties":{"Name":{"type":"string","description":"The name of the order refund reason.","uniqueKey":"NotifyOrderRefund.oneOf.0.RefundReason.Name","typeLabel":"string"},"OrderRefundReasonCode":{"oneOf":[{"type":"string","description":"Code denoting the order refund reason on the Merchant site (for mapping on the Global-e side)","uniqueKey":"NotifyOrderRefund.oneOf.0.RefundReason.OrderRefundReasonCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"Code denoting the order refund reason on the Merchant site (for mapping on the Global-e side)","uniqueKey":"NotifyOrderRefund.oneOf.0.RefundReason.OrderRefundReasonCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"NotifyOrderRefund.oneOf.0.RefundReason.OrderRefundReasonCode","typeLabel":"string | null"}},"description":"Reason for the order refund","uniqueKey":"NotifyOrderRefund.oneOf.0.RefundReason","typeLabel":"Merchant.OrderRefundReason · object"},"ServiceGestureAmount":{"type":"string","description":"\"Service gesture\" amount in the customer's currency is included in TotalRefundAmount.","uniqueKey":"NotifyOrderRefund.oneOf.0.ServiceGestureAmount","typeLabel":"string"},"TotalGiftCardsRefundAmountinMerchantCurrency":{"type":"string","description":"The total refund amount to the gift card, in the merchant's currency","uniqueKey":"NotifyOrderRefund.oneOf.0.TotalGiftCardsRefundAmountinMerchantCurrency","typeLabel":"string"},"TotalRefundAmount":{"type":"string","description":"The total refund amount in the end customer's currency used for this order's payment","uniqueKey":"NotifyOrderRefund.oneOf.0.TotalRefundAmount","typeLabel":"string"},"WebStoreCode":{"oneOf":[{"type":"string","description":"Code used on the merchant's side to identify the web store","uniqueKey":"NotifyOrderRefund.oneOf.0.WebStoreCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"Code used on the merchant's side to identify the web store","uniqueKey":"NotifyOrderRefund.oneOf.0.WebStoreCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"NotifyOrderRefund.oneOf.0.WebStoreCode","typeLabel":"string | null"},"WebStoreInstanceCode":{"type":"string","description":"Code used on the merchant's side to identify the web store instance where the current cart is originating from","uniqueKey":"NotifyOrderRefund.oneOf.0.WebStoreInstanceCode","typeLabel":"string"},"TotalGiftCardsRefundAmount":{"type":"string","description":"Total refund to gift card (from the documented example).","uniqueKey":"NotifyOrderRefund.oneOf.0.TotalGiftCardsRefundAmount","typeLabel":"string"},"GiftCardsData":{"type":"object","title":"GiftCardsData","properties":{"BalanceInCustomerCurrency":{"type":"number","description":"The gift card balance in the customer's currency.","uniqueKey":"NotifyOrderRefund.oneOf.0.GiftCardsData.BalanceInCustomerCurrency","typeLabel":"number"},"BalanceInGiftCardCurrency":{"type":"number","description":"The gift card balance in the gift card's currency.","uniqueKey":"NotifyOrderRefund.oneOf.0.GiftCardsData.BalanceInGiftCardCurrency","typeLabel":"number"},"BalanceUsedInCardCurrency":{"type":"number","description":"The balance used from the gift card in the gift card currency","uniqueKey":"NotifyOrderRefund.oneOf.0.GiftCardsData.BalanceUsedInCardCurrency","typeLabel":"number"},"BalanceUsedInCustomerCurrency":{"type":"number","description":"The balance used from the gift card in the customer's currency","uniqueKey":"NotifyOrderRefund.oneOf.0.GiftCardsData.BalanceUsedInCustomerCurrency","typeLabel":"number"},"CardFields":{"type":"object","description":"An object containing the following card details: CardId giftCardBalanceToUse","uniqueKey":"NotifyOrderRefund.oneOf.0.GiftCardsData.CardFields","typeLabel":"object"},"CardId":{"type":"number","description":"Gift card's unique identifier","uniqueKey":"NotifyOrderRefund.oneOf.0.GiftCardsData.CardId","typeLabel":"number"},"CustomerCurrencyMode":{"type":"string","description":"The code for the customer's currency","uniqueKey":"NotifyOrderRefund.oneOf.0.GiftCardsData.CustomerCurrencyMode","typeLabel":"string"},"ErrorCode":{"type":"string","description":"The error code","uniqueKey":"NotifyOrderRefund.oneOf.0.GiftCardsData.ErrorCode","typeLabel":"string"},"ErrorText":{"type":"string","description":"Text describing the error.","uniqueKey":"NotifyOrderRefund.oneOf.0.GiftCardsData.ErrorText","typeLabel":"string"},"GiftCardCurrencyCode":{"type":"string","description":"The code for the gift card's currency","uniqueKey":"NotifyOrderRefund.oneOf.0.GiftCardsData.GiftCardCurrencyCode","typeLabel":"string"},"IsRefundSuccess":{"type":"boolean","description":"Indicates if the refund was successful or not.","uniqueKey":"NotifyOrderRefund.oneOf.0.GiftCardsData.IsRefundSuccess","typeLabel":"boolean"},"GiftCardType":{"type":"number","description":"Number indicating the type of gift card","uniqueKey":"NotifyOrderRefund.oneOf.0.GiftCardsData.GiftCardType","typeLabel":"number"},"OriginalTotalRefundAmount":{"type":"string","description":"The refund amount in the original Merchant's currency including the local Merchant's VAT","uniqueKey":"NotifyOrderRefund.oneOf.0.GiftCardsData.OriginalTotalRefundAmount","typeLabel":"string"},"RedeemTransactionId":{"type":"string","description":"The gift card redemption's transaction identifier.","uniqueKey":"NotifyOrderRefund.oneOf.0.GiftCardsData.RedeemTransactionId","typeLabel":"string"},"RefundedBalanceInCustomerCurrency":{"type":"number","description":"The refunded balance in the customer's selected currency","uniqueKey":"NotifyOrderRefund.oneOf.0.GiftCardsData.RefundedBalanceInCustomerCurrency","typeLabel":"number"},"RefundeBalanceInGiftCardCurrency":{"type":"number","description":"The refunded balance in the currency of the gift card","uniqueKey":"NotifyOrderRefund.oneOf.0.GiftCardsData.RefundeBalanceInGiftCardCurrency","typeLabel":"number"}},"description":"Gift card refund details (from the documented example). NOTE: the running source returns this as an array; see review §2.","uniqueKey":"NotifyOrderRefund.oneOf.0.GiftCardsData","typeLabel":"GiftCardsData · object"}},"uniqueKey":"NotifyOrderRefund.oneOf.0","typeLabel":"Merchant.OrderRefund · object"},{"type":"null","uniqueKey":"NotifyOrderRefund.oneOf.1","typeLabel":"null"}],"uniqueKey":"NotifyOrderRefund","typeLabel":"Merchant.OrderRefund · object | null"}},"uniqueKey":"","typeLabel":"OrderRefundInfo · object"},"examples":{"success":{"title":"success","value":{"Success":true,"Reason":"Refund generated with id 67961","NotifyOrderRefund":{"MerchantOrderId":"orderid123","RefundId":"67961","MerchantGUID":"39a4ffdsfds-f6324b-41ce-afdsfa-c8ef18234132","Products":[{"CartItemId":"2","RefundQuantity":"1","OriginalRefundAmount":"31.2707","RefundAmount":"60.9500","RefundReason":{"OrderRefundReasonCode":null,"Name":"Undefined"},"RefundComments":"Damaged shipment but the customer kept it"}],"Components":[{"Amount":"60.95","OriginalAmount":"31.27","IsChargedToMerchant":"TRUE","ComponentType":"Products"}],"OrderId":"GE95135467GB","TotalRefundAmount":"60.95","RefundReason":{"OrderRefundReasonCode":null,"Name":"Undefined"},"RefundComments":"Damaged shipment but the customer kept it","OriginalTotalRefundAmount":"31.27","ServiceGestureAmount":"0","WebStoreCode":null,"WebStoreInstanceCode":"GlobalEDefaultStoreInstance","FullRefund":false,"TotalGiftCardsRefundAmount":"100.0000","GiftCardsData":{"CardId":"1234","BalanceInGiftCardCurrency":18.39,"BalanceInCustomerCurrency":290.21,"GiftCardCurrencyCode":"EUR","CustomerCurrencyMode":"EUR","BalanceUsedInCardCurrency":39,"BalanceUsedInCustomerCurrency":387.8,"RedeemTransactionId":"1987489732938","CardIdFields":{"CardId":"498784937","giftCardBalanceToUse":"100"}}}}},"processingError":{"title":"processingError","value":{"Success":false,"Reason":"Processing error detail","NotifyOrderRefund":null}}},"exampleType":"examples"}},"exampleType":"examples"},"62aa7834-3850-4762-91a7-878af4fe16d8":{"description":"Validation error. Depending on merchant configuration the body is either an `ErrorInfo` object (`Code`/`Error`/`Description`) or a `ResponseInfo` object (`Success`/`Reason`). Clients should accept both — see review §2.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"ErrorInfo","description":"Error response (Code / Error / Description form).","properties":{"Code":{"type":"string","description":"Error code to be returned when an error occurs","uniqueKey":"oneOf.0.Code","typeLabel":"string"},"Error":{"type":"string","description":"In case of an error, this property indicates the error message text","uniqueKey":"oneOf.0.Error","typeLabel":"string"},"Description":{"type":"string","description":"In case of an error, this property indicates the error message description","uniqueKey":"oneOf.0.Description","typeLabel":"string"},"Success":{"type":"boolean","description":"Indicates if the call has succeeded. FALSE denotes an error or failure","uniqueKey":"oneOf.0.Success","typeLabel":"boolean"}},"uniqueKey":"oneOf.0","typeLabel":"ErrorInfo · object"},{"type":"object","title":"ResponseInfo","description":"Error response (Success / Reason form).","properties":{"Success":{"type":"boolean","description":"FALSE on error.","uniqueKey":"oneOf.1.Success","typeLabel":"boolean"},"Reason":{"type":"string","description":"Text describing the failure.","uniqueKey":"oneOf.1.Reason","typeLabel":"string"}},"uniqueKey":"oneOf.1","typeLabel":"ResponseInfo · object"}],"uniqueKey":"","typeLabel":"ErrorInfo · object | ResponseInfo · object"},"examples":{"nullParameter":{"title":"nullParameter","value":{"Code":"NullParameter","Error":"Parameter {0} was null","Description":"Please provide a valid value for the {0} parameter"}},"multiRefundDisallowed":{"title":"multiRefundDisallowed","value":{"Code":"MULTI_REFUND_DISALLOWED","Error":"Multiple refund requests are disallowed for this order and reason","Description":"This refund request is rejected because multiple refunds are disallowed for the same order and the same reason code"}},"orderNotFound":{"title":"orderNotFound","value":{"Success":false,"Reason":"Order {0} could not be found"}},"orderDoesNotBelong":{"title":"orderDoesNotBelong","value":{"Success":false,"Reason":"Order {0} doesn't belong to this merchant"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{},"servers":{"b04f4125-72f9-4356-8f3a-104b32ca3809":{"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/createorderrefund.yaml"},"subdomain":"globale-enterprise","siteName":"Global-e Docs","title":"Create order refund (Merchant to Global-e) - Global-e Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-27T11:31:48.593Z","originalFileLocation":"api-reference/create-order-refund.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=\"Issues a refund for the specified order, optionally including a product list and/or components (service gesture, shipping, Duties \u0026amp; Taxes).\">\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=\"Create order refund (Merchant to Global-e) - Global-e Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Issues a refund for the specified order, optionally including a product list and/or components (service gesture, shipping, Duties \u0026amp; Taxes).\">\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/create-order-refund\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://globale-enterprise.mintlify.app/_mintlify/api/og/v2?division=Orders\u0026amp;title=Create+order+refund+%28Merchant+to+Global-e%29\u0026amp;description=Issues+a+refund+for+the+specified+order%2C+optionally+including+a+product+list+and%2For+components+%28service+gesture%2C+shipping%2C+Duties+%26+Taxes%29.\u0026amp;theme=ba448c405b24dd48494124de\u0026amp;signature=904b989b4d82abffa864a6996b6dac7ce081e045566dca01f871dc27e2e147cf\">\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=\"Create order refund (Merchant to Global-e) - Global-e Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Issues a refund for the specified order, optionally including a product list and/or components (service gesture, shipping, Duties \u0026amp; Taxes).\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://globale-enterprise.mintlify.app/_mintlify/api/og/v2?division=Orders\u0026amp;title=Create+order+refund+%28Merchant+to+Global-e%29\u0026amp;description=Issues+a+refund+for+the+specified+order%2C+optionally+including+a+product+list+and%2For+components+%28service+gesture%2C+shipping%2C+Duties+%26+Taxes%29.\u0026amp;theme=ba448c405b24dd48494124de\u0026amp;signature=904b989b4d82abffa864a6996b6dac7ce081e045566dca01f871dc27e2e147cf\">\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/create-order-refund\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/create-order-refund.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/create-order-refund#webpage\",\"url\":\"https://docs.global-e.com/api-reference/create-order-refund\",\"name\":\"Create order refund (Merchant to Global-e)\",\"description\":\"Issues a refund for the specified order, optionally including a product list and/or components (service gesture, shipping, Duties \u0026 Taxes).\",\"dateModified\":\"2026-09-27T11:31:48.593Z\",\"isPartOf\":{\"@id\":\"https://docs.global-e.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.global-e.com/api-reference/create-order-refund#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.global-e.com/api-reference/create-order-refund#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Orders\",\"item\":\"https://docs.global-e.com/api-reference/create-order\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create order refund (Merchant to Global-e)\",\"item\":\"https://docs.global-e.com/api-reference/create-order-refund\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.global-e.com/api-reference/create-order-refund#apireference\",\"headline\":\"Create order refund (Merchant to Global-e)\",\"name\":\"Create order refund (Merchant to Global-e)\",\"description\":\"Issues a refund for the specified order, optionally including a product list and/or components (service gesture, shipping, Duties \u0026 Taxes).\",\"url\":\"https://docs.global-e.com/api-reference/create-order-refund\",\"mainEntityOfPage\":{\"@id\":\"https://docs.global-e.com/api-reference/create-order-refund#webpage\"},\"dateModified\":\"2026-09-27T11:31:48.593Z\",\"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\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","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":"Dispatch orders (Merchant to Global-e)","sidebarTitle":"Dispatch orders","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","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","description":"The UpdateOrderStatus API lets you cancel an order with a reason (and notify the customer accordingly) or move an order to a processing status (used by Global‑e or specific cases not covered in this guide). This guide focuses on cancelling orders prior to dispatch.","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","description":"This API starts the process of creating an order in the Global-e system.","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":"Create order refund (Merchant to Global-e) - Global-e Docs","buildId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","deploymentId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-B7XKH4J3.js","utils-lOYzL7z-.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DF6jUUIM.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dpsj5f7C.js","snippetPresets-CYeiDe8v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CUFz1YZ_.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D8H_iLS4.js","shallow-DdluZBHX.js","getApiPlaygroundDisplay-B9922vev.js","CodeSnippet-CMoRNGYs.js","CodeSnippets-DwyrPHuw.js","Page-DSVu9Ucl.js","getPastedJson-G-zIvlHh.js","icon-B03fnEy0.js","MethodPill-CW7teklc.js","DuplicateIcon-CtO8eekd.js","createIcon-DZTKdM_A.js","DynamicMarkdown-D5M2At0B.js","SectionHeading-C_2NaA2U.js","axios-vUo_bRtp.js","Markdown-D7QRHV3m.js","clsx-D1Z-ELXV.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-lvhuD9Du.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CKfC4ywL.js"]}