NotifyOrderRefund

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 Attributes
Order Array of Merchant.OrderRefund objects Contains information about order refunds. + show attributes Components array of Merchant.RefundComponent objects The array of RefundComponent objects for this order refund. + show attributes Amount decimal The refund amount in customer currency. ComponentType string Enum of the following types: 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. MerchantGUID string Unique identifier of the Merchant on Global-e. MerchantOrderId string Order unique identifier on the Merchant’s site returned from a previous call to the SendOrderToMerchant method for this order. MerchantRMANumber string The Merchant’s Returned Merchandize Authorization Number. OrderId string (Mandatory) Global‑e order unique identifier. OriginalTotalRefundAmount decimal (Mandatory) 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. Products List of Merchant.RefundProduct Array of RefundProduct objects for this order refund. + show attributes CartItemID string (Mandatory) 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. 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. MerchantReturnReasonCode string The code of the reason for the product return on the Merchant site. 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. 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. RefundQuantity decimal Product quantity (i.e. a part of the originally ordered quantity) that the refund refers to. RefundReason array of Merchant OrderRefundReason objects Reason for this product’s refund. + show attributes 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. Sku string This field is obsolete. Use ProductCode instead RefundComments string Comments for the order refund. RefundReason Array of Merchant.OrderRefundReason objects Details regarding reason for the order refund. + show attributes 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. RMANumber string The RMA number taken from the related Return. 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. TotalRefundAmount decimal (Mandatory) The total refund amount in the end customer’s currency used for this order’s payment (currency is specified in InternationalDetails.CurrencyCodeproperty for the respective Merchant.Order).

Request Attributes

Order Array of Merchant.OrderRefund objects

Contains information about order refunds.

Components array of Merchant.RefundComponent objects

The array of RefundComponent objects for this order refund.

Amount decimal

The refund amount in customer currency.

ComponentType string

Enum of the following types: 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.

MerchantGUID string

Unique identifier of the Merchant on Global-e.

MerchantOrderId string

Order unique identifier on the Merchant’s site returned from a previous call to the SendOrderToMerchant method for this order.

MerchantRMANumber string

The Merchant’s Returned Merchandize Authorization Number.

OrderId string (Mandatory)

Global‑e order unique identifier.

OriginalTotalRefundAmount decimal (Mandatory)

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.

Products List of Merchant.RefundProduct

Array of RefundProduct objects for this order refund.

CartItemID string (Mandatory)

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.

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.

MerchantReturnReasonCode string

The code of the reason for the product return on the Merchant site.

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.

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.

RefundQuantity decimal

Product quantity (i.e. a part of the originally ordered quantity) that the refund refers to.

RefundReason array of Merchant OrderRefundReason objects

Reason for this product’s refund.

Sku string

This field is obsolete. Use ProductCode instead

RefundComments string

Comments for the order refund.

RefundReason Array of Merchant.OrderRefundReason objects

Details regarding reason for the order refund.

RMANumber string

The RMA number taken from the related Return.

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.

TotalRefundAmount decimal (Mandatory)

The total refund amount in the end customer’s currency used for this order’s payment (currency is specified in InternationalDetails.CurrencyCodeproperty for the respective Merchant.Order).

Response Attributes
Merchant.ResponseInfo object Details regarding reason for the order refund. + show attributes Optional response description. In case of an error, this property indicates the error message description. ErrorCode string Error code to be returned when an error occurs. InternalOrderId string Order unique identifier on the merchant’s site. Message string Optional response message. In case of an error, this property indicates the error message text. 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). PaymentAmount string The total payment amount in PaymentCurrency charged for the order (if payment was processed in the respective API method call). PaymentCurrencyCode string 3-char ISO currency code for the order (if payment was processed in the respective API method call). StatusCode string Code denoting the order status on the Merchant’s site (to be mapped on the Global‑e side).. StatusCode boolean Indicates if the call has succeeded. TRUE - Call succeeded. FALSE - Denotes an error or failure.

Response Attributes

Merchant.ResponseInfo object

Details regarding reason for the order refund.

Optional response description. In case of an error, this property indicates the error message description.

ErrorCode string

Error code to be returned when an error occurs.

InternalOrderId string

Order unique identifier on the merchant’s site.

Message string

Optional response message. In case of an error, this property indicates the error message text.

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).

PaymentAmount string

The total payment amount in PaymentCurrency charged for the order (if payment was processed in the respective API method call).

PaymentCurrencyCode string

3-char ISO currency code for the order (if payment was processed in the respective API method call).

StatusCode string

Code denoting the order status on the Merchant’s site (to be mapped on the Global‑e side)..

StatusCode boolean

Indicates if the call has succeeded.

TRUE - Call succeeded.

FALSE - Denotes an error or failure.

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

Parameters

Example

Search results