Get All RMAs By Saved View

Updated 3 weeks ago ​by nussi

Overview

This endpoint is used for getting RMAs in bulk, using a saved view. A saved view for RMAs must be created on the Manage RMAs page in the new Sellercloud UI.

The advantages of using this endpoint for getting RMAs are as follows:

  • Ease of use: You can set your filters once, save them as a saved view, and then easily utilize those same filters when getting RMAs by simply referencing that saved view ID.
  • Flexibility: The filters available in the new SellerCloud UI are numerous and extremely flexible.

In order to get information for RMAs by saved view, you can consume the endpoint presented in this article. However in order to do that, you must:

  1. Be an authenticated user. For information on how you can authenticate, see: Authentication. As soon as you authenticate and receive a valid token, it needs to be passed on this call for getting RMAs.
  2. Have a valid ID of a currently existing saved view. For information on how you can get existing saved views, see Get RMA Saved Views

Endpoint

The endpoint for the TT server would be:

https://tt.api.sellercloud.com/rest/api/Rma/getallbyview?request.ViewID=100&request.pageNumber=1&request.pageSize=50

For your server, the endpoint will be:

https://{your_server_id}.api.sellercloud.com/rest/api/Rma/GetAllByView?request.ViewID=100&request.pageNumber=1&request.pageSize=50

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 + token received from token authentication
  • Header info: Content-Type: application/json
  • Parameters:

Parameters

Data Type

Description

Is Required

pageNumber

integer

Page number

Yes

pageSize

integer

Number of RMAs per page

NOTE:

Maximum number of RMAs that can be pulled with a single call is 50.

Yes

viewID

integer

ID of existing saved view

Yes

Response

  • If user is authenticated and provides a valid page number and page size, then response will be Status Code 200 => OK and RMAs metadata in JSON format
  {
"Items": [
{
"Items": [
{
"CustomerID": 0,
"FirstName": "string",
"LastName": "string",
"CustomerFirstName": "string",
"CustomerLastName": "string",
"UserID": 0,
"CreatedOn": "2020-11-06T13:55:00.736Z",
"ClosedOn": "2020-11-06T13:55:00.736Z",
"ReceivedOn": "2020-11-06T13:55:00.736Z",
"CreatedBy": "string",
"RMAStatusCode": 0,
"OrderSource": 0,
"OrderSourceRMAID": "string",
"Reason": 0,
"ReceivedStatus": 0,
"Resolution": 0,
"TotalRefunded": 0,
"Company": "string",
"CompanyID": 0,
"Exported": 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": "2020-11-06T13:55:00.736Z",
"QtyReturned": 0,
"QtyReceived": 0
}
],
"ID": 0
}
],
"TotalResults": 0
}
],
"TotalResults": 0
}

  • If user is not authenticated, then response will be Status Code 401 => Not Valid Token
  • On server error response => Status Code 500 => Internal Server Error

Enumeration values can be found in this section here: https://developer.sellercloud.com/category/pqa1htn09q-resources


How did we do?