Documentation Portal

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 method for the order being refunded.

Yes

OriginalRefundAmount

Decimal

The refund amount in the original Merchant’s 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).

No

ProductCode

String

Product SKU or Product Variant ID according to Merchant configuration. Can be used as Product Identifier instead of CartItemId. In case there are multiple products with the same identifier we will choose one of them arbitrarily.

No

RefundAmount

Decimal

The refund amount for this product line item in customer currency and used for this order payment. If this attribute is not specified, OriginalRefundAmount multiplied by RoundingRate for this product line item should be used to calculate TotalRefundAmount for this order’s refund.

Yes

RefundComments

String

Merchant's 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.

Yes

RefundReason

Object OrderRefundReason

Reason for this product’s refund

No

Sku

String

The field is obsolete, please use ProductCode instead.

No