UpdateRMA

Call the UpdateRMA API to set or update the MerchantRMANumber and send an email to the customer.

URL

https://{server_name}/Return/UpdateRMA

Request

Name	Type	Description	Mandatory
updateRMANumber	Object UpdateRMANumber	Provides API call response info.

Parameter Name	Type	Description
`MerchantOrderId`	String	The Merchant order ID.
`MerchantRMANumber`	String	The Merchant return merchandise authorization number.
`OrderId`	String	The order ID.
`RMANumber`	String	The return merchandise authorization number.

Return

Name	Type	Description	Mandatory
merchant.ResponseInfo	Object Merchant.ResponseInfo	Provides API call response info.

Parameter Name	Type	Description	Mandatory
`Description`	String	Optional response description. In case of an error, this property indicates the error message description.	No
`ErrorCode`	String	Error code to be returned when an error occurs.	No
`InternalOrderId`	String	Order unique identifier on the Merchant’s site	Optional if there was an error, a failure, or if the action is not related to a specific order
`Message`	String	Optional response message. In case of an error, this property indicates the error message text.	No
`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`).	No
`PaymentAmount`	String	The total payment amount in `PaymentCurrency` charged for the order (if payment was processed in the respective API method call).	No
`PaymentCurrencyCode`	String	3-char ISO currency code for the order (if payment was processed in the respective API method call).	No
`StatusCode`	String	Code denoting the order status on the Merchant’s site (to be mapped on the Global‑e side).	Optional if there was an error or failure
`Success`	Boolean	Indicates if the call has succeeded. TRUE - Call succeeded. FALSE - Denotes an error or failure.

Documentation Portal