Skip to main content
POST
UpdateRMA
Call the UpdateRMA API to set or update the MerchantRMANumber and send an email to the customer.

Overview

Use the UpdateRMA endpoint to set or update the Return Merchandise Authorization (RMA) number on an existing return, then trigger the RMA confirmation email to the shopper. Send the merchant’s own return authorization number in the MerchantRMANumber field and Global-e stores it against the order. Identify the return by OrderId or MerchantOrderId, and optionally include Global-e’s own RMANumber. This is the API behind the UpdateRMA step of the SFCC GlobaleOrderNotifications job, letting merchants push a return authorization number from their returns or OMS platform back to Global-e for customer-facing return communications.

Body

application/json
OrderId
string

The order ID.

MerchantOrderId
string

The Merchant order ID.

RMANumber
string

The return merchandise authorization number.

MerchantRMANumber
string

The Merchant return merchandise authorization number.

Response

200 - application/json

Merchant.ResponseInfo. Check the Success field; on failure, Message / Description / ErrorCode carry the error details.

Provides API call response info.

Description
string

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

Success
boolean

Indicates if the call has succeeded. TRUE - Call succeeded. FALSE - Denotes an error or failure.