ShipNitro
  1. API v1 - deprecated do not use
ShipNitro
  • Authentication
  • API v2
    • Getting Shipment Rates
      POST
    • Retrieve Shipment Details
      GET
    • Creating Shipment Labels
      POST
    • Get Current Credit
      GET
    • Getting Tracking number status
      POST
    • Address Validation
      POST
  • API v1 - deprecated do not use
    • Get Labels
      POST
    • Get Rates
      POST
    • Create Label
      POST
    • Get Current Credit
      GET
  • Callbacks
    • v2
      • Customer Create Label Callback
    • v1 - deprecated do not use
      • Callback Part 1
  1. API v1 - deprecated do not use

Get Labels

Deprecated
POST
api/get/label
Get Label endpoint gives you ability to retrieve labels from shipnitro.

Request

Header Params

Body Params application/json

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
Request Request Example
Shell
JavaScript
Java
Swift
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

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"
        }
    ]
}
Modified at 2024-10-24 17:13:51
Previous
API v1 - deprecated do not use
Next
Get Rates
Built with