Overview
In order to update an existing RMA, you can consume the endpoint presented in this article. In order to consume it, you must:
- Be ан authenticated user
For information on how you can authenticate, see: Authentication
After you authenticate and receive a valid token, you must pass it to service calls.
Endpoint
Example for such endpoint for TT server is:
https://tt.api.sellercloud.com/rest/api/Rma/{id}
For your server endpoint will be:
https://{your_server_id}.api.sellercloud.com/rest/api/Rma/{id}
Request
- Method Type: HttpPut
- Authorization: Use Bearer Token (where ‘Token’ is the token received from token authentication)
- Header info: Content-Type: application/json
- Parameters: ID of existing RMA
- Request Body:
| Parameter | Data Type | Description | Is Required |
| Status | enum | RMA Status
(Documentation for the enumerations can be found here: Resources) Do not provide or set to “null” if no update is needed. |
false |
| ApprovalStatus | enum | RMA Approval Status
(Documentation for the enumerations can be found here: Resources) Do not provide or set to “null” if no update is needed. |
false |
| TrackingNumber | string | RMA tracking number
Do not provide or set to “null” if no update is needed. |
false |
| IsExported | bool | RMA ‘Is Exported’ status
Do not provide or set to “null” if no update is needed. |
false |
| QBExported | bool | RMA QB Exported status
Do not provide or set to “null” if no update is needed. |
false |
Response
- If user is authenticated and RMA update is successful, then response will be Status Code 200 => OK
- If user is not authenticated, then response will be Status Code 401 => Not Valid Token
- In case of error, response will be Status Code 500 => Internal Server Error