Download Shipping Label

Updated 6 months ago ​by nussi

Overview

In order to download an RMA shipping label, 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)
  • Have a valid ID of an existing RMA
  • Have a valid ID of existing shipping label

Endpoint

Example for such endpoint for TT server is:

https://tt.api.sellercloud.com/rest/api/Rma/{id}/ShippingLabels/{labelId}

For your server endpoint will be:

https://{your_server_id}.api.sellercloud.com/rest/api/Rma/{id}/ShippingLabels/{labelId}

Request

  • Method Type: HttpGet
  • Authorization: Use Bearer Token + token received from token authentication
  • Header info: Content-Type: application/json

Parameter

Data Type

Description

Is Required

id

integer

ID of existing Rma

Yes

labelId

integer

Shipping label id

Yes

Example: https://tt.api.sellercloud.com/rest/api/Rma/{id}/ShippingLabels/{labelId}

Response

  • If user is authenticated and provides valid parameters, then response will be Status Code 200 => OK and encoded array of bytes, which represent the shipping label file content.

That response content should be decoded from base-64 and array of bytes can be used to save and open the file. Name of the file and its extension are stored in the content header

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


How did we do?