Create Shipping Label

Updated 3 months ago ​by nussi

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:
{
"Weight": {
"Pounds": 0,
"Ounces": 0
},
"Dimensions": {
"Width": 0,
"Height": 0,
"Length": 0
},
"ShippingCarrier": "string",
"ShippingService": 0,
"PackageType": "string",
"InsuranceProvider": "string",
"InsuranceAmount": 0,
"DeliveryConfirmation": "None",
"ShipFromAddress": {
"Business": "string",
"ContactName": "string",
"Country": "string",
"City": "string",
"State": "string",
"Region": "string",
"ZipCode": "string",
"Address": "string",
"Phone": "string",
"Fax": "string",
"IsModified": true
},
"ShipToAddress": {
"Business": "string",
"ContactName": "string",
"Country": "string",
"City": "string",
"State": "string",
"Region": "string",
"ZipCode": "string",
"Address": "string",
"Phone": "string",
"Fax": "string",
"IsModified": true
}
}

Parameter

Data Type

Description

Is Required

Weight.Pounds

decimal

Weight pounds

true

Weight.Ounces

decimal

Weight ounces

true

Dimensions.Width

decimal

Dimensions width

true

Dimensions.Height

decimal

Dimensions height

true

Dimensions.Length

decimal

Dimenstions length

true

ShippingCarrier

string

Shipping carrier

Default value is configured in the RMA defaults system configuration.

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

false

ShippingService

string

Shipping service

Default value is configured in the RMA defaults system configuration.

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

false

PackageType

string

Package type

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

false

InsuranceProvider

string

Insurance provider

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

false

InsuranceAmount

decimal

Insurance amount

false

DeliveryConfirmation

integer

Delivery confirmation (accessory)

Possible values:

0 = None

1 = Signature_Required

2 = Adult_Signature_Required

false

ShipFromAddress

Address

Ship from address

false

ShipToAddress

Address

Ship to address

false

[Address.Business]

string

Business name

false

[Address.Country]

string

Country code two letter

false

[Address.City]

string

City

false

[Address.State]

string

State

false

[Address.Region]

string

Region

false

[Address.ZipCode]

string

ZipCode

false

[Address.Address]

string

Address

false

[Address.Phone]

string

Phone

false

[Address.Fax]

string

Fax

false

[Address.IsModified]

N/A

N/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


How did we do?