Create Shipping Label

Overview

In order to create new 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

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

For your server endpoint will be:

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

Request

  • Method Type: HttpPost
  • Authorization: Use Bearer Token (where ‘Token’ is the token received from token authentication)
  • Header info: Content-Type: application/json
  • Parameters: ID of existing RMA
  • Request Body:

ParameterData TypeDescriptionIs Required
Weight.PoundsdecimalWeight poundstrue
Weight.OuncesdecimalWeight ouncestrue
Dimensions.WidthdecimalDimensions widthtrue
Dimensions.HeightdecimalDimensions heighttrue
Dimensions.LengthdecimalDimenstions lengthtrue
ShippingCarrierstringShipping carrier

Default value is configured in the RMA defaults system configuration.

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

false
ShippingServicestringShipping service

Default value is configured in the RMA defaults system configuration.

List of possible values can be obtained from service “/ShippingLabels/Services”.

false
PackageTypestringPackage type

List of possible values can be obtained from service “/ShippingLabels/PackageTypes

false
InsuranceProviderstringInsurance provider

List of possible values can be obtained from service “/ShippingLabels/IsuranceProviders

false
InsuranceAmountdecimalInsurance amountfalse
DeliveryConfirmationintegerDelivery confirmation (accessory)

Possible values:

0 = None

1 = Signature_Required

2 = Adult_Signature_Required

false
ShipFromAddressAddressShip from addressfalse
ShipToAddressAddressShip to addressfalse
[Address.Business]stringBusiness namefalse
[Address.Country]stringCountry code two letterfalse
[Address.City]stringCityfalse
[Address.State]stringStatefalse
[Address.Region]stringRegionfalse
[Address.ZipCode]stringZipCodefalse
[Address.Address]stringAddressfalse
[Address.Phone]stringPhonefalse
[Address.Fax]stringFaxfalse
[Address.IsModified]N/AN/A (Should be omitted)N/A

Response

  • If user is authenticated and create shipping label is successful, then response will be Status Code 200 => OK and ID of the created label is returned.
  • 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

Was this article helpful?

Next
REST Api Changes (2020)