Get RMA Custom Columns

Overview

In order to get information on custom columns for a 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 service call.

  • Have a valid RMA ID

Endpoint

Example for such endpoint for TT server is:

https://tt.api.sellercloud.com/rest/api/Rma/{ID}/CustomColumns

For your server endpoint will be:

https://{your_server_id}.api.sellercloud.com/rest/api/Rma/{ID}/CustomColumns

Request

  • Method Type: HttpPost
  • Authorization: Use Bearer Token + token received from token authentication
  • Header info: Content-Type: application/json
  • Parameters: RMA ID
Parameter Data Type Description Is Required
RMA ID integer Valid RMA ID true

 

Response

  • If user is authenticated and provides a valid RMA ID, then response will be Status Code 200 => OK and an object which will contain all of the custom columns in JSON format
  • If user is not authenticated, then response will be Status Code 401 => Not Valid Token
  • On server response => Status Code 500 => Internal Server Error

Response Format

DataType field represents type of the custom column.

Was this article helpful?