Shipment Tracking

This endpoint allows you to fetch tracking details for a specific shipment by providing the ID of the shipment the path parameter.

Scopes

shipping.read- Shipping Read Only

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Responses

🟢200Success

application/json

Body

status

integer

optional

Response Status Code

success

boolean

optional

Whether or not the response is successful

data

object

optional

number

optional

This field refers to a unique identifier for the shipment.

order_id

integer

optional

This field refers to a unique identifier for the shipment.

order_reference_id

number | null

optional

This field refers to a reference ID that can be used to look up additional information about the order

type

string

optional

Shipment Type

courier_id

integer

optional

Shipment Courier ID. Find a complete list of Shipment companies here

courier_name

string

optional

Shipment Courier Name

courier_logo

string

optional

Shipment Courier Logo

shipping_number

string

optional

Shipping Number

tracking_number

string

optional

Tracking Number

pickup_id

null

optional

Pickup ID

trackable

boolean

optional

Whether or not the shipment is trackable

tracking_link

string

optional

This field refers to a hyperlink that provides a direct link to the tracking page for the shipment

label

object

optional

status

string

optional

This field refers to the current status of the shipment

history

array [object {3}]

optional

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": null,
    "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": null,
        "create_at": {
          "date": "2023-04-06 11:44:23.000000",
          "timezone_type": 3,
          "timezone": "Asia/Riyadh"
        }
      }
    ]
  }
}

Request

Request samples

Responses