Get Single RMA

Overview

In order to get information for a single 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

As soon as you do authentication and receive a valid token, it needs to be passed to the call for receiving a single RMA.

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

Information about expected request parameters can be found on swagger UI https://tt/api.sellercloud.com/rest/swagger.

  • Method Type: HttpGet
  • Authorization: Use Bearer Token (where ‘Token’ is the token received from token authentication)
  • Header info: Content-Type: application/json
  • Parameters: ID of the RMA
ParameterData TypeDescriptionIs Required
idintegerID of existing RMAtrue

Example: https://tt.api.sellercloud.com/rest/api/Rma/81

Response

  • If user is authenticated and provides a valid ID of an RMA, then response will be Status Code 200 => OK and RMA metadata in JSON format returned in the response body
  • 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

Response Body Format

Documentation for the enumerations can be found here: https://sellercloud.com/developer/dev-category/resources/

Was this article helpful?

Next
Receive RMA Items