- Documentation Portal
- SDK and API
- NotifyOrderRefund (Global-e to Merchant)
NotifyOrderRefund (Global-e to Merchant)
The NotifyOrderRefund method notifies the merchant about Global-e initiated refunds issued to the shopper.
If implemented on the merchant’s site, the Global‑e servers post the information about customer refunds, in cases where such refunds are initiated on the Global‑e side.
Method/URL
https://www.merchant-site-domain/order-refund-url
Parameters
Request
Requests can contain more parameters than listed.
Name | Type | Description | Mandatory |
---|---|---|---|
order | Object | Contains information about order refunds. | Yes |
Object Merchant.OrderRefund
Parameter Name | Type | Description | Mandatory |
---|---|---|---|
| List of | The list of | No |
| String | Unique identifier of the Merchant on Global-e. | No |
| String | Order unique identifier on the Merchant’s site returned from a previous call to the | No |
| String | The Merchant’s Returned Merchandize Authorization Number | No |
| String | Global‑e order unique identifier. | Yes |
| Decimal | The refund amount in the original Merchant currency including the local Merchant’s VAT (currency is specified in | Yes |
| List of | List of | No |
| String | Comments for the order refund | No |
| Object | Reason for the order refund | No |
| String | The RMA number taken from the related Return. | No |
| Decimal | The “Service gesture” amount in the customer’s currency is included in the | No |
| Decimal | The total refund amount in the end customer’s currency used for this order’s payment (currency is specified in InternationalDetails. | Yes |
| String | Code used on the Merchant’s side to identify the web store, as specified in the | No |
Object Merchant.OrderRefundReason
Parameter Name | Type | Description | Mandatory |
---|---|---|---|
| String | Order refund reason name. | |
| String | Code denoting the order refund reason on the Merchant’s site (to be mapped on the Global‑e side). If not mapped, Global‑e internal code will be specified instead. |
Object Merchant.RefundComponent
Parameter Name | Type | Description | Mandatory |
---|---|---|---|
| Decimal | The refund amount in customer currency. | |
| String | Products, Shipping, Duties, | |
| Boolean | Indicates if the component is charged to the Merchant or to Global-e. TRUE - Component is charged to the Merchant (default) FALSE - Component is charged to Global‑e 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 | |
| Decimal | The refund amount in Merchant currency. |
Object Merchant.RefundProduct
Parameter Name | Type | Description | Mandatory |
---|---|---|---|
| String | Identifier of the line item on the Merchant’s site. This property is mandatory and should be equal to the respective Product’s | Yes |
| Decimal | The refund amount in the original Merchant currency including the local Merchant’s VAT for this product line item, before applying any price modifications (i.e. part of or the full value paid by Global-e to the Merchant, as was specified in | |
| String | Product SKU or Product Variant ID according to merchant configuration. Can be used as a Product Identifier instead of | No |
| Decimal | The refund amount for this product line item in customer currency used for the payment of this order | |
| String | Comments for this product’s refund | No |
| Decimal | Product quantity (i.e. a part of the originally ordered quantity) that the refund refers to | |
| Object | Reason for this product’s refund | No |
| String | This field is obsolete. Use | No |
Object Merchant.OrderRefundReason
Parameter Name | Type | Description | Mandatory |
---|---|---|---|
| String | Order refund reason name. | |
| String | Code denoting the order refund reason on the Merchant’s site (to be mapped on the Global‑e side). If not mapped, Global‑e internal code will be specified instead. |
Response
Note
Some response values are encoded and require the merchant to decode them, for example URLs, addresses, emails, and phone numbers.
Name | Type | Description | Mandatory |
---|---|---|---|
Merchant.ResponseInfo | Object | Provides response data regarding the API call. |
Merchant.ResponseInfo
Parameter Name | Type | Description | Mandatory |
---|---|---|---|
| String | Optional response description. In case of an error, this property indicates the error message description. | No |
| String | Error code to be returned when an error occurs. | No |
| String | Order unique identifier on the Merchant’s site | Optional if there was an error, a failure, or if the action is not related to a specific order |
| String | Optional response message. In case of an error, this property indicates the error message text. | No |
| String | Order identifier on the Merchant’s site used for display and reporting purposes only. Unlike the | No |
| String | The total payment amount in | No |
| String | 3-char ISO currency code for the order (if payment was processed in the respective API method call). | No |
| String | Code denoting the order status on the Merchant’s site (to be mapped on the Global‑e side). | Optional if there was an error or failure |
| Boolean | Indicates if the call has succeeded. TRUE - Call succeeded. FALSE - Denotes an error or failure. |
Example
{ "MerchantGUID": "abcdabcd-abcd-abcd-abcd-abcdabcdabcd", "MerchantOrderId": "14123332", "Products": [{ "CartItemId": 12365, "RefundQuantity": "3", "OriginalRefundAmount": "114.5300", "RefundAmount": "170.1000", "RefundReason": { "OrderRefundReasonCode": "DAMAGED-ITEM-CODE", "Name": "Damaged Item" }, "RefundComments": "Fully refunded order" } ], "OrderId": "GE69488861GB", "RefundId": 789, "RMANumber": 6543, "CurrencyCode": “CAD”, "OriginalCurrencyCode": “USD”, "TotalRefundAmount": "170.10", "RefundReason": { "OrderRefundReasonCode": "DAMAGED-ITEM-CODE", "Name": "Damaged Item" }, "RefundComments": "Fully refunded order", "OriginalTotalRefundAmount": "114.53", "ServiceGestureAmount": "0.00", "WebStoreCode": null }