Get RMA Shipping Insurance Providers List

Updated 9 months ago ​by nussi

Overview

In order to get information for the possible RMA shipping insurance providers, 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.

Endpoint

Example for such endpoint for TT server is:

​​https://tt.api.sellercloud.com/rest/api/Rma/{id}/ShippingLabels/InsuranceProviders?shippingCarrier={carrier}

For your server endpoint will be:

​​https://{your_server_id}.api.sellercloud.com/rest/api/Rma/{id}/ShippingLabels/InsuranceProviders?shippingCarrier={carrier}

Request

  • Method Type: HttpGet
  • Authorization: Use Bearer Token (where 'Token' is the token received from the token authentication)
  • Header info: Content-Type: application/json

Parameter

Data Type

Description

Is Required

id

integer

ID of existing Rma

Yes

shippingCarrier

string

Shipping carrier Key

List of possible values can be obtained from service "/ShippingLabels/Carriers.

Yes

Example: https://tt.api.sellercloud.com/rest/api/Rma/1/ShippingLabels/InsuranceProviders?shippingCarrier=UPS

Response

  • If user is authenticated, then response will be Status Code 200 => OK and list of possible RMA shipping insurance providers in JSON format 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

[
  {
    "Key": 0,
    "Value": "string"
  }
]

How did we do?