TrackingMore · Schema

Tracking

A shipment tracking record in TrackingMore

LogisticsShippingTrackingParcelsWebhooksEcommerce

Properties

Name	Type	Description
id	string	Unique tracking identifier
tracking_number	string	Shipment tracking number
courier_code	string	Carrier/courier code (e.g., usps, ups, fedex, dhl)
order_id	string	Associated internal order ID
title	string	Custom title or label for this tracking
customer_name	string	Name of the customer
customer_email	string	Customer email address
note	string	Free-form note about this shipment
status	string	Current tracking status
substatus	string	Detailed sub-status code
origin_country	string	ISO 3166-1 alpha-2 origin country code
destination_country	string	ISO 3166-1 alpha-2 destination country code
created_at	string	Timestamp when this tracking was created
updated_at	string	Timestamp of last update
last_event	string	Description of the most recent tracking event
last_update_time	string	Time of the most recent carrier update
origin_info	object	Tracking events at the origin
destination_info	object	Tracking events at the destination

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api.trackingmore.com/v4/schemas/tracking",
  "title": "Tracking",
  "description": "A shipment tracking record in TrackingMore",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique tracking identifier"
    },
    "tracking_number": {
      "type": "string",
      "description": "Shipment tracking number"
    },
    "courier_code": {
      "type": "string",
      "description": "Carrier/courier code (e.g., usps, ups, fedex, dhl)"
    },
    "order_id": {
      "type": "string",
      "description": "Associated internal order ID"
    },
    "title": {
      "type": "string",
      "description": "Custom title or label for this tracking"
    },
    "customer_name": {
      "type": "string",
      "description": "Name of the customer"
    },
    "customer_email": {
      "type": "string",
      "format": "email",
      "description": "Customer email address"
    },
    "note": {
      "type": "string",
      "description": "Free-form note about this shipment"
    },
    "status": {
      "type": "string",
      "description": "Current tracking status",
      "enum": [
        "pending",
        "inforeceived",
        "transit",
        "pickup",
        "delivered",
        "undelivered",
        "exception",
        "expired",
        "notfound"
      ]
    },
    "substatus": {
      "type": "string",
      "description": "Detailed sub-status code"
    },
    "origin_country": {
      "type": "string",
      "description": "ISO 3166-1 alpha-2 origin country code"
    },
    "destination_country": {
      "type": "string",
      "description": "ISO 3166-1 alpha-2 destination country code"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp when this tracking was created"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp of last update"
    },
    "last_event": {
      "type": "string",
      "description": "Description of the most recent tracking event"
    },
    "last_update_time": {
      "type": "string",
      "format": "date-time",
      "description": "Time of the most recent carrier update"
    },
    "origin_info": {
      "type": "object",
      "description": "Tracking events at the origin",
      "properties": {
        "trackinfo": {
          "type": "array",
          "items": { "$ref": "#/$defs/TrackingEvent" }
        }
      }
    },
    "destination_info": {
      "type": "object",
      "description": "Tracking events at the destination",
      "properties": {
        "trackinfo": {
          "type": "array",
          "items": { "$ref": "#/$defs/TrackingEvent" }
        }
      }
    }
  },
  "required": ["tracking_number", "courier_code"],
  "$defs": {
    "TrackingEvent": {
      "type": "object",
      "description": "A single tracking checkpoint event",
      "properties": {
        "checkpoint_date": {
          "type": "string",
          "format": "date-time",
          "description": "Date and time of this checkpoint"
        },
        "location": {
          "type": "string",
          "description": "Location description"
        },
        "checkpoint_status": {
          "type": "string",
          "description": "Status at this checkpoint"
        },
        "substatus": {
          "type": "string",
          "description": "Detailed sub-status"
        },
        "details": {
          "type": "string",
          "description": "Human-readable event description"
        }
      }
    }
  }
}