TrackingRequestList

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/terminal49/json-schema/terminal49-tracking-request-list-schema.json",
  "title": "TrackingRequestList",
  "x-generated": "2026-11-09",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/terminal49-tracking-requests-api-openapi.yml#/components/schemas/TrackingRequestList",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/TrackingRequestResource"
      }
    },
    "links": {
      "$ref": "#/$defs/JsonApiLinks"
    }
  },
  "$defs": {
    "JsonApiLinks": {
      "type": "object",
      "properties": {
        "self": {
          "type": "string"
        },
        "first": {
          "type": "string"
        },
        "prev": {
          "type": "string"
        },
        "next": {
          "type": "string"
        },
        "last": {
          "type": "string"
        }
      }
    },
    "TrackingRequestAttributes": {
      "type": "object",
      "properties": {
        "request_number": {
          "type": "string",
          "description": "The Bill of Lading, booking, or container number to track."
        },
        "request_type": {
          "type": "string",
          "enum": [
            "bill_of_lading",
            "booking_number",
            "container"
          ]
        },
        "scac": {
          "type": "string",
          "description": "The carrier SCAC code."
        },
        "ref_numbers": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "status": {
          "type": "string",
          "enum": [
            "pending",
            "created",
            "failed",
            "tracking_stopped"
          ]
        },
        "failed_reason": {
          "type": [
            "string",
            "null"
          ]
        },
        "created_at": {
          "type": "string",
          "format": "date-time"
        }
      }
    },
    "TrackingRequestResource": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "type": {
          "type": "string",
          "enum": [
            "tracking_request"
          ]
        },
        "attributes": {
          "$ref": "#/$defs/TrackingRequestAttributes"
        }
      }
    }
  }
}