Retrieve Shipment Details

GET

api/v2/shipments/{box_id}

This endpoint will give you ability to retrieve the shipment details

Request

Path Params

Header Params

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://app.shipnitro.com/api/v2/shipments/api_67854dea770a888e3e0dd692' \
--header 'Authorization: Basic {{apiKey}}'

Responses

🟢200 Link Response Success

application/json

Body

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

Modified at 2025-01-13 17:35:45

Getting Shipment Rates

Creating Shipment Labels