Documentation Portal

Unique product line level identifier at order level as provided in GetCheckoutCartInfo and returned in SendOrderToMerchant

SKU code used to identify the product on the Merchant’s site (to be mapped on the Global‑e side)

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.

Preferred if not full product amount (optional) - Total product line refund amount in Merchant currency, if partial will be backwards pro-rated for reconciliation

RefundAmountPercent

(optional) Total product line refund amount in %.

(optional) Total product line refund amount in Customer currency, if partial will be pro-rated for customer values from transaction amounts

The amount must include domestic VAT if applicable.

OrderRefundReasonObject* (see above table)

(optional) provide product line level reason to be logged on the Global‑e side

RefundComments

(optional) provide comments to be logged on the Global‑e side

Success

Boolean

Indicates if the respective API method was successful

Reason

String

Text that optionally describes the reason for the Success status

NotifyOrderRefund

Merchant.OrderRefund

Notifies the merchant about Global-E initiated refund issued to the end customer.

OrderRefundReasonCode

Decimal

Code denoting the order refund reason on the Merchant’s site

Name

String

Order refund reason name

Success

Boolean

Indicates if the call has succeeded. FALSE denotes an error or failure

Code

String

Error code to be returned when an error occurs

Error

String

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

Description

String

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

OrderRefund=

 {
     "OrderId": "GE95135467GB",
    "FullRefund": true
}

OrderRefund=

{
     "OrderId": "GE95135467GB",
     "ShippingRefund": true
}

[]

OrderRefund=

1

Validation – refundProductsList is not null or empty

400

{ Code = "NullParameter", Error = string.Format("Parameter {0} was null", parameterName), Description = string.Format("Please provide a valid value for the {0} parameter", parameterName) }

2

Validation –orderRefundObj is not null

400

{ Code = "NullParameter", Error = string.Format("Parameter {0} was null", parameterName), Description = string.Format("Please provide a valid value for the {0} parameter", parameterName) }

3

Validation – orderId is not null

400

{ Code = "NullParameter", Error = string.Format("Parameter {0} was null", parameterName), Description = string.Format("Please provide a valid value for the {0} parameter", parameterName) }

4

Validation – Multiple refunds

400

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

1

Validation – Order was not found

400

{ Success = false, Reason = string.Format("Order {0} could not be found"}

2

Validation – The order does not belong to the merchant

400

{ Success = false, Reason = string.Format("Order {0} doesn't belong to this merchant", order.OrderId) }

A100

Invalid information schema.

Relevant for technical errors.

A200

n/a

Relevant for logical errors

A300

n/a

(%requested amount in the requested currency%) is greater than the remaining amount available for refund for this order (%remaining refund amount in the requested currency%)

The order log shows the following:

"Error: Cart Item ID (%CartItemID%) was already refunded. Cannot refund the same product more than once"

For each product in the refund request that was NOT previously refunded, the following note should appear in the log/comments: "Info: Cart Item ID (%CartItemID%) can be refunded in a separate refund request"

Requested refund amount %Accumulated Amount% is greater than the remaining amount available for refund for this order %Remaining Available Amount%

A700

Full refund requested but list of RefundProduct is not empty

A800

A full refund was requested but at least one of the components is not empty

When requesting a full refund, no amounts should be provided

A900

The total refund amount must be greater than (or equal to) each refund component amount

A1000

The total refund amount must be greater than (or equal to) the total sum of products to refund

A1100

The total refund amount must be equal to the sum of the refund components

A1200

Refund requests must contain at least one refund component

A1300

Refund quantity must be greater than 0 for all products

The total refund amount must be empty if amounts are not provided for each refunded product