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:
Parameters | Data Type | Description | Is Required |
rMAIDs | List | List of RMA IDs | No |
orderIDs | List | List of Order IDs related to RMAs | No |
companyIDList | List | List of Company IDs to which the RMAs belong | No |
productID | List | List of ProductIDs in the RMAs | no |
rmaStatuses | List | Key values of RMA Status enumeration (see the enum definition in the enumerations documentation in the link in the end of this document) | No |
orderSources | List | Key values of Channels enumeration (see the enum definition in the enumerations documentation in the link in the end of this document) | No |
orderSourceRMAID | string | Order Source (Channel) RMA ID | No |
orderSourceOrderIDs | List | List of Order Source (Channel) Order IDs | No |
trackingNumber | string | Tracking Number | No |
qBExported | integer | QuickBooks exported status. 0 = No , 1 = Yes , -1 = All. | No |
dateFrom | DateTime | RMA Date Create From | No |
dateTo | DateTime | RMA Date Create To | No |
closedOnFrom | DateTime | RMA Date Closed On From | No |
closedOnTo | DateTime | RMA Date Closed On To | No |
returnedOnFrom | DateTime | RMA Date Returned On From | No |
returnedOnTo | DateTime | RMA Date Returned On To | No |
lastUpdatedOnFrom | DateTime | RMA Last Updated On From | No |
lastUpdatedOnТо | DateTime | RMA Last Updated On To | No |
pageNumber | integer | Number of page | No |
pageSize | integer | Number of RMAs per page | No |
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
{ "Items": [ { "CustomerID": 0, "FirstName": "string", "LastName": "string", "CustomerFirstName": "string", "CustomerLastName": "string", "UserID": 0, "CreatedOn": "2022-07-13T11:06:15.085Z", "ClosedOn": "2022-07-13T11:06:15.085Z", "ReceivedOn": "2022-07-13T11:06:15.085Z", "CreatedBy": "string", "ApprovalStatus": 0, "RMAStatusCode": 0, "OrderSource": 0, "OrderSourceRMAID": "string", "Reason": 0, "ReceivedStatus": 0, "TotalRefunded": 0, "Company": "string", "CompanyID": 0, "Exported": 0, "CustomerUserName": "string", "TrackingNumber": "string", "RefundStatus": 10, "ReturnLabelCharges": 0, "Items": [ { "ID": 0, "RMAID": 0, "OrderID": 0, "SKU": "string", "RMANoteContains": "string", "SerialNumber": "string", "Reason": 0, "ReasonName": "string", "Resolution": 0, "ReceivedStatus": "string", "RefundStatus": 0, "RefundStatusName": "string", "OrderSubType": 0, "OrderSubtypeName": "string", "OrderSourceOrderID": "string", "OrderSource": 0, "EnabledOnChannels": [ 0 ], "Company": "string", "CompanyID": 0, "ReturnedOn": "2022-07-13T11:06:15.085Z", "QtyReturned": 0, "QtyReceived": 0, "ReturnedToWarehouseID": 0, "WarehouseBinID": 0, "ProblemDescription": "string" } ], "ReturnNotes": [ { "EntityID": 0, "Category": 0, "NoteID": 0, "Note": "string", "AuditDate": "2022-07-13T11:06:15.085Z", "CreatedBy": 0, "CreatedByName": "string", "CreatedByEmail": "string" } ], "ReplacementOrderId": 0, "ID": 0 } ], "TotalResults": 0 }
Documentation for the enumerations can be found here