Get All RMAs

Overview

In order to get information for many RMAs in a single request, you can consume the endpoint presented in this article. In order to do that, 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 getting RMAs.

Endpoint

Example for such endpoint for TT server:

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

For your server endpoint will be:

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

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 the token authentication)
  • Header info: Content-Type: application/json
  • Parameters:
ParametersData TypeDescriptionIs Required
rMAIDsListList of RMA IDsNo
orderIDsListList of Order IDs related to RMAsNo
companyIDListListList of Company IDs to which the RMAs belongNo
productIDListList of ProductIDs in the RMAsno
rmaStatusesListKey values of RMA Status enumeration (see the enum definition in the enumerations documentation in the link in the end of this document)No
orderSourcesListKey values of Channels enumeration (see the enum definition in the enumerations documentation in the link in the end of this document)No
orderSourceRMAIDstringOrder Source (Channel) RMA IDNo
orderSourceOrderIDsListList of Order Source (Channel) Order IDsNo
trackingNumberstringTracking NumberNo
qBExportedintegerQuickBooks exported status. 0 = No , 1 = Yes , -1 = All.No
dateFromDateTimeRMA Date Create FromNo
dateToDateTimeRMA Date Create ToNo
closedOnFromDateTimeRMA Date Closed On FromNo
closedOnToDateTimeRMA Date Closed On ToNo
returnedOnFromDateTimeRMA Date Returned On FromNo
returnedOnToDateTimeRMA Date Returned On ToNo
lastUpdatedOnFromDateTimeRMA Last Updated On FromNo
lastUpdatedOnТоDateTimeRMA Last Updated On ToNo
pageNumberintegerNumber of pageNo
pageSizeintegerNumber of RMAs per pageNo

Response

  • If the user is authenticated, then the response will be Status Code 200 => OK and RMAs metadata in JSON format
  • If the user is not authenticated, then the response will be Status Code 401 => Not Valid Token
  • In case of an error, the response will be Status Code 500 => Internal Server Error

Response Body Format

Documentation for the enumerations can be found here

Was this article helpful?

Next
Get Single RMA