Skip to main content

Documentation Portal

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