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

Parameter	Data Type	Description	Is Required
id	integer	ID of existing RMA	true

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

{
  2.{
  "ID": 0,
  "CustomerID": "string",
  "CustomerName": "string",
  "ApprovalStatus": 0,
  "StatusCode": 0,
  "CompanyID": 0,
  "CompanyName": "string",
  "OrderNumberOriginal": 0,
  "OriginalOrderTotal": 0,
  "ReplacementOrderId": 0,
  "ShipViaSourceRMAID": "string",
  "ReturnLabelCharges": 0,
  "TrackingNumber": "string",
  "IsExported": true,
  "IsDropShipRMA": true,
  "VendorRmaNumber": "string",
  "CreditMemo": 0,
  "Changes": {
    "CreatedByID": 0,
    "CreatedByName": "string",
    "CreatedOn": "2022-07-13T11:06:15.096Z",
    "LastUpdatedByID": 0,
    "LastUpdatedByName": "string",
    "LastUpdatedOn": "2022-07-13T11:06:15.096Z",
    "ReceivedByID": 0,
    "ReceivedByName": "string",
    "ReceivedOn": "2022-07-13T11:06:15.096Z"
  },
  "Items": [
    {
      "ID": 0,
      "ProductID": "string",
      "DisplayName": "string",
      "QtyOrdered": 0,
      "QtyToReturn": 0,
      "QtyReceived": 0,
      "ReturnResolution": "string",
      "eBayItemID": "string",
      "eBayItemUrl": "string",
      "OriginalOrderID": 0,
      "OriginalOrderItemID": 0,
      "ShippedByID": 0,
      "ShippedByName": "string",
      "ProblemDescription": "string",
      "ReturnReason": 0,
      "RefundAmount": 0,
      "BinName": "string",
      "ApprovalStatus": 0,
      "ReturnedToWarehouseID": 0,
      "BinID": 0,
      "OriginalOrderItemKitItemProductID": "string",
      "ReceiveStatus": 0
    }
  ]
}
}

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