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 Merchant.OrderRefund

Object Merchant.OrderRefund

Parameter Name	Type	Description	Mandatory
`Components`	List of `Merchant.RefundComponent`	The list of `RefundComponent` objects for this order refund.	No
`MerchantGUID`	String	Unique identifier of the Merchant on Global-e.	No
`MerchantOrderId`	String	Order unique identifier on the Merchant’s site returned from a previous call to the `SendOrderToMerchant` method for this order.	No
`MerchantRMANumber`	String	The Merchant’s Returned Merchandize Authorization Number	No
`OrderId`	String	Global‑e order unique identifier.	Yes
`OriginalTotalRefundAmount`	Decimal	The refund amount in the original Merchant currency including the local Merchant’s VAT (currency is specified in `CurrencyCode` property of the respective `Merchant.Order`).	Yes
`Products`	List of `Merchant.RefundProduct`	List of `RefundProduct` objects for this order refund.	No
`RefundComments`	String	Comments for the order refund	No
`RefundReason`	Object `Merchant.OrderRefundReason`	Reason for the order refund	No
`RMANumber`	String	The RMA number taken from the related Return.	No
`ServiceGestureAmount`	Decimal	The “Service gesture” amount in the customer’s currency is included in the `TotalRefundAmount`. “Service gesture” denotes any additional refund granted to the user, on top of the refund related to other components.	No
`TotalRefundAmount`	Decimal	The total refund amount in the end customer’s currency used for this order’s payment (currency is specified in InternationalDetails.`CurrencyCode`property for the respective `Merchant.Order`).	Yes
`WebStoreCode`	String	Code used on the Merchant’s side to identify the web store, as specified in the `WebStoreCode` argument for the `SendCart` method for the cart converted to this order on Global‑e.	No

Object Merchant.OrderRefundReason

Parameter Name	Type	Description	Mandatory
`Name`	String	Order refund reason name.
`OrderRefundReasonCode`	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
`Amount`	Decimal	The refund amount in customer currency.
`ComponentType`	String	Products, Shipping, Duties, `PrepaidReturn` or `ServiceGesture`.
`IsChargedToMerchant`	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 `IsChargedToMerchant`. Exception: A component `PrepaidReturn` – it should always be `IsChargedToMerchant` = TRUE.
`OriginalAmount`	Decimal	The refund amount in Merchant currency.

Object Merchant.RefundProduct

Parameter Name	Type	Description	Mandatory
`CartItemID`	String	Identifier of the line item on the Merchant’s site. This property is mandatory and should be equal to the respective Product’s `CartItemId` originally specified in the `SendCart` API for the order being refunded	Yes
`OriginalRefundAmount`	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 `Merchant.Product.Price` for the respective order.
`ProductCode`	String	Product SKU or Product Variant ID according to merchant configuration. Can be used as a Product Identifier instead of `CartItemId`. If there are multiple products with the same identifier, we choose one of them arbitrarily.	No
`RefundAmount`	Decimal	The refund amount for this product line item in customer currency used for the payment of this order
`RefundComments`	String	Comments for this product’s refund	No
`RefundQuantity`	Decimal	Product quantity (i.e. a part of the originally ordered quantity) that the refund refers to
`RefundReason`	Object `Merchant.OrderRefundReason`	Reason for this product’s refund	No
`Sku`	String	This field is obsolete. Use `ProductCode` instead.	No

Object Merchant.OrderRefundReason

Parameter Name	Type	Description	Mandatory
`Name`	String	Order refund reason name.
`OrderRefundReasonCode`	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.

Contains information about order refunds.

Yes

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 Merchant.ResponseInfo

Merchant.ResponseInfo

Parameter Name	Type	Description	Mandatory
`Description`	String	Optional response description. In case of an error, this property indicates the error message description.	No
`ErrorCode`	String	Error code to be returned when an error occurs.	No
`InternalOrderId`	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
`Message`	String	Optional response message. In case of an error, this property indicates the error message text.	No
`OrderId`	String	Order identifier on the Merchant’s site used for display and reporting purposes only. Unlike the `InternalOrderId`, this identifier is not necessarily unique over time, as the Merchant’s site may potentially reuse it (for example after deleting the old order having the same `OrderId`).	No
`PaymentAmount`	String	The total payment amount in `PaymentCurrency` charged for the order (if payment was processed in the respective API method call).	No
`PaymentCurrencyCode`	String	3-char ISO currency code for the order (if payment was processed in the respective API method call).	No
`StatusCode`	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
`Success`	Boolean	Indicates if the call has succeeded. TRUE - Call succeeded. FALSE - Denotes an error or failure.

Provides response data regarding the API call.

Example

Request

{
    "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
}

Documentation Portal

NotifyOrderRefund (Global-e to Merchant)

Parameters

Object Merchant.OrderRefund

Object Merchant.OrderRefundReason

Object Merchant.RefundComponent

Object Merchant.RefundProduct

Object Merchant.OrderRefundReason

Note

Merchant.ResponseInfo

Example

Search results