Get Labels - ShipNitro

Request

Header Params

Content-Type

string

required

Example:

application/json

Authorization

string

required

To get an api key, please ask assistance to the site admin.

Example:

Basic {{apiKey}}

Body Params application/json

masterTrackingNumber

string

optional

This is required if the box_id is not available

box_id

string

Box ID

optional

This is required if the masterTrackingNumber is not available

Example:

api_665fa775d95e7e76d2058722

label

object

required

format

enum<string>

required

Determine which format label

Allowed values:

BASE64LINK

Example

{
	"box_id": "api_666099e8f88ccf9a5d07b6f6",
    "label": {
        "format": "LINK"
    }
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://app.shipnitro.com/api/get/label' \
--header 'Authorization: Basic {{apiKey}}' \
--header 'Content-Type: application/json' \
--data-raw '{
	"box_id": "api_666099e8f88ccf9a5d07b6f6",
    "label": {
        "format": "LINK"
    }
}'

Responses

🟢200Success

application/json

Body

message

string

required

box_id

string

required

status

string

required

recipient

object

required

postal_code

string

required

city

string

required

state_code

string

required

address_line1

string

required

address_line2

string

optional

country_code

string

required

person_name

string

required

company_name

string

required

phone_number

string

required

residential

boolean

required

reference_codes

object

required

ref_1

string

required

ref_2

string

required

ref_3

string

required

parcels

array [object {7}]

required

weight

number

required

weight_unit

string

required

height

number

required

length

number

required

width

number

required

dimension_unit

string

required

count

number

required

master_tracking_number

string

required

compiled_label

string

required

labels

array [object {2}]

required

trackingNumber

string

required

label

string

required

Example

{
    "message": "Shipment is ready",
    "box_id": "api_66da7021fc8b9e02f10ff022",
    "status": "completed",
    "recipient": {
        "postal_code": "33436",
        "city": "Boynton Beach",
        "state_code": "FL",
        "address_line1": "11700 South Military Trail Unit",
        "country_code": "US",
        "person_name": "MR test",
        "company_name": "SHOES ON FIRST, INC",
        "phone_number": "0123456789",
        "residential": false
    },
    "reference_codes": {
        "ref_1": "test_reference_1",
        "ref_2": "DevTest",
        "ref_3": "test_reference_2"
    },
    "parcels": [
        {
            "weight": 16.65,
            "width": 46,
            "height": 32,
            "length": 59,
            "weight_unit": "KG",
            "dimension_unit": "CM",
            "count": 5
        }
    ],
    "master_tracking_number": "778410238340",
    "compiled_label": "https://www.shipnitro.com/download/66da7021fc8b9e02f10ff022?778410238340.pdf",
    "labels": [
        {
            "trackingNumber": "778410238340",
            "label": "https://www.shipnitro.com/download/api_66da7021fc8b9e02f10ff022/778410238340"
        },
        {
            "trackingNumber": "778410238350",
            "label": "https://www.shipnitro.com/download/api_66da7021fc8b9e02f10ff022/778410238350"
        },
        {
            "trackingNumber": "778410238361",
            "label": "https://www.shipnitro.com/download/api_66da7021fc8b9e02f10ff022/778410238361"
        },
        {
            "trackingNumber": "778410238372",
            "label": "https://www.shipnitro.com/download/api_66da7021fc8b9e02f10ff022/778410238372"
        },
        {
            "trackingNumber": "778410238383",
            "label": "https://www.shipnitro.com/download/api_66da7021fc8b9e02f10ff022/778410238383"
        }
    ]
}