Cosmo Cargo Inc.

Shipping Tracking API

Endpoint

Download schema

Get shipping tracking status

GET

https://api.sh.example.com/v1

/tracking/{trackingNumber}

Retrieve tracking information for a specific shipment.

Get shipping tracking status › path Parameters

trackingNumber

string · pattern: ^[A-Z0-9]{10,20}$ · required

The shipment's tracking number

Get shipping tracking status › Responses

Tracking information found

type

string · const · required

Shipping Tracking type of resource

Const value: shippingTracking

id

string · uuid · required

Unique identifier for the tracking resource

object · required

GET/tracking/{trackingNumber}

const options = {method: 'GET'};

fetch('https://api.sh.example.com/v1/tracking/:trackingNumber', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

Example Responses

{
  "type": "shippingTracking",
  "id": "00000000-0000-0000-0000-000000000000",
  "attributes": {
    "createdAt": "2024-08-25T15:00:00Z",
    "trackingNumber": "trackingNumber",
    "deliveryStatus": "CREATED",
    "notifications": [
      "EMAIL"
    ]
  }
}

json

application/vnd.api+json