Retrieve Shipment Details

This endpoint will give you ability to retrieve the shipment details

Request

Path Params

box_id

string

required

The boxId, you can get the boxId from the response of create label.

Example:

api_67854dea770a888e3e0dd692

Header Params

Authorization

string

required

You can request for the API KEY from the admin, and append Basic <api key>

Example:

Basic {{apiKey}}

Responses

🟢200 Link Response Success

application/json

Body

message

array[string] | null

optional

This will contain warning and error messages

boxId

string

required

This will contain the boxID which is unique to every shipment

status

string

required

This will contain the status of the shipment (Pending, Failed, Completed)

recipient

object

required

This will contain the recipient details address, and contact person, company

addressLine1

string

required

Street address line 1

addressLine2

string

required

This contains usually Appartment number or unit number

city

string

required

City

stateCode

string

required

State Code usually 2 character long

>= 2 characters<= 2 characters

postalCode

string

required

This contains the 5 digit postal code. Sometime we do have some postal code extension but this is not required

countryCode

string

required

Country Code usually 2 character long

residential

boolean

required

Residential indicator TRUE when the address is a residential and FALSE if the address is a commerial

personName

string

required

The person who will be contact or look for when the package is being deliver

companyName

string | null

optional

The company to be contact for the package delivery

string | null

optional

Email address of the customer

phoneNumber

string

required

Phone number of the recipient used when the package will be deliver

referenceCodes

object

required

reference1

string

required

Customer defined reference

reference2

string

required

This is by default assigned by admin

reference3

string

required

Customer defined reference

parcels

array [object {7}]

required

Array of Objects that specify the parcels or package

length

number

required

The length of the package

width

number

required

The width of the package

height

number

required

The height of the package

dimensionUnit

string

required

DImension unit CM for centimeter and IN for inches

weight

number

required

The actual weight of the package

weightUnit

string

required

Weight unit KG for kilogram and LB for pounds

count

integer

required

Count or Quantity of the label

masterTrackingNumber

string

required

Master tracking number from Fedex

totalCost

number

required

Total Cost- charge to the organization

compiledLabel

string

required

URL to the compiled label

labels

array [object {2}]

required

The list of tracking numbers

trackingNumber

string

required

Assigned tracking number

label

string

required

URL to the label

Example

{
    "message": [
        "Shipment is ready"
    ],
    "boxId": "api_666099dss22qsaasda5d07b6f6",
    "status": "completed",
    "recipient": {
        "addressLine1": "12630 NW 115th AVE",
        "addressLine2": null,
        "city": "Medley",
        "stateCode": "FL",
        "postalCode": "33178",
        "countryCode": "US",
        "residential": false,
        "personName": "Test Company",
        "companyName": "Shipnitro",
        "email": null,
        "phoneNumber": "0123456789"
    },
    "referenceCodes": {
        "reference1": "testReference1",
        "reference2": "test",
        "reference3": "testReference2"
    },
    "parcels": [
        {
            "length": 42.75,
            "width": 27.55,
            "height": 54.15,
            "dimensionUnit": "CM",
            "weight": 10.51,
            "weightUnit": "KG",
            "count": 1
        }
    ],
    "masterTrackingNumber": "796745219924",
    "totalCost": 21.5,
    "compiledLabel": "https://www.staging.shipnitro.com/download/666099dss22qsaasda5d07b6f6?796745219924.pdf",
    "labels": [
        {
            "trackingNumber": "796745219924",
            "label": "https://www.staging.shipnitro.com/download/api_666099dss22qsaasda5d07b6f6/796745219924"
        }
    ]
}

🟠401Unauthorized

🟠404Record Not Found

🔴500Server Error

🟢200Voided Label

🟠424Failed Label

Retrieve Shipment Details

Request

Request samples

Responses