Shipment Tracking

This endpoint allows you to fetch tracking details for a specific shipment by passing the shipment_id as a path parameter.

Scopes

shipping.read- Shipping Read Only

Request

Authorization

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Path Params

shipment_id

integer

required

Unique identification number assigned to a shipment. List of Shipment IDs from here

Responses

🟢200Success

application/json

Body

status

number

optional

Response status code, a numeric or alphanumeric identifier used to convey the outcome or status of a request, operation, or transaction in various systems and applications, typically indicating whether the action was successful, encountered an error, or resulted in a specific condition.

success

boolean

optional

Response flag, boolean indicator used to signal a particular condition or state in the response of a system or application, often representing the presence or absence of certain conditions or outcomes.

data

object (ShipmentTracking)

optional

number

required

A unique identifier for the shipment. List of shipments can be found here.

order_id

number

required

A unique identifier for the order associated with the shipment. List of orders can be found here

order_reference_id

number | null

required

A unique identifier associated with an order refrence.

type

string

required

Shipment type

courier_id

integer

required

Shipment courier unique identifiation. Find a complete list of Shipment companies here

courier_name

string

required

Shipment courier name.

courier_logo

string

required

Shipment courier logo.

shipping_number

string

required

Shipping number.

tracking_number

string

required

Tracking number.

pickup_id

number | null

required

A unique identifier associated with a pickup.

trackable

boolean

required

Whether or not the shipment is trackable

tracking_link

string

required

A hyperlink that provides a direct link to the tracking page for the shipment

label

object

required

status

string

required

The current status of the shipment

history

array [object {3}]

required

Example

{
    "status": 200,
    "success": true,
    "data": {
        "id": 362985662,
        "order_id": 560695738,
        "order_reference_id": 48927,
        "type": "shipment",
        "courier_id": 1927161457,
        "courier_name": "Shipping App",
        "courier_logo": "https://salla-dev-portal.s3.eu-central-1.amazonaws.com/uploads/Zo3PtoY2KNo3MkpWARHXhK91DUrsEtQJJqpz5PbY.png",
        "shipping_number": "846984645",
        "tracking_number": "43534254",
        "pickup_id": "076543",
        "trackable": true,
        "tracking_link": "https://api.shipengine.com/v1/labels/498498496/track",
        "label": {
            "format": "pdf",
            "url": "https://salla-dev.s3.eu-central-1.amazonaws.com/mKZa/shipping-policy/48102-IPqC9O6ysElWi4ze5148I2ilFABxAKvHggmEG4pB.pdf"
        },
        "status": "delivering",
        "history": [
            {
                "status": "delivering",
                "note": "third note the shipment is on the way",
                "create_at": {
                    "date": "2023-04-06 11:57:51.000000",
                    "timezone_type": 3,
                    "timezone": "Asia/Riyadh"
                }
            },
            {
                "status": "created",
                "note": "second note without sending the status in the request",
                "create_at": {
                    "date": "2023-04-06 11:49:51.000000",
                    "timezone_type": 3,
                    "timezone": "Asia/Riyadh"
                }
            },
            {
                "status": "created",
                "note": "first note without sending the status in the request",
                "create_at": {
                    "date": "2023-04-06 11:49:35.000000",
                    "timezone_type": 3,
                    "timezone": "Asia/Riyadh"
                }
            },
            {
                "status": "created",
                "note": "note about the product",
                "create_at": {
                    "date": "2023-04-06 11:44:23.000000",
                    "timezone_type": 3,
                    "timezone": "Asia/Riyadh"
                }
            }
        ]
    }
}

🟠401Unauthorized

Request

Request samples

Responses