{ "openapi": "3.0.3", "info": { "title": "Air Tracking API", "description": "REST API for real-time tracking of air cargo shipments by air waybill number, as well as checking airline support capabilities.\n\nAn AWB names its airline in its own three-digit prefix, so the waybill number is the only thing to send. The response carries the shipment's current status, the milestones it has passed, the flights and airports on its route and the estimated time of arrival.\n\nOcean freight is a separate product with a document of its own: `container-tracking-api-v1.json`.\n\nFull documentation: https://developer.tracking.one/air/air-tracking-api/", "version": "1.0.0" }, "servers": [ { "url": "https://api.tracking.one", "description": "Api Endpoint" } ], "paths": { "/v1/shipments/air": { "get": { "tags": ["Air Tracking API v1"], "summary": "Get Air Shipment Tracking Information", "description": "Retrieves the current status, itinerary legs, cargo details, and milestone history of an air cargo shipment by its air waybill number.", "operationId": "getAirShipment", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "number", "in": "query", "required": true, "description": "Air waybill number - a three-digit airline prefix followed by eight digits.", "schema": { "type": "string" }, "example": "001-27868153" }, { "name": "routePath", "in": "query", "required": false, "description": "Flag to request the flown track and the live transport position of every route segment.", "schema": { "type": "boolean", "default": false }, "example": true } ], "responses": { "200": { "description": "Successful shipment tracking response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentResponse" }, "example": { "success": true, "statusCode": "OK", "shipment": { "type": "AWB", "number": "001-27868153", "carrier": { "code": "AF", "name": "Air France" }, "updatedAt": "2026-08-19T05:40:06", "status": "NOTIFIED", "locations": [ { "id": "LNZ", "name": "Linz Airport", "nearestCity": "Linz", "iata": "LNZ", "icao": "LOWL", "unLocode": null, "codeFromCarrier": "LNZ", "state": "Upper-Austria", "countryCode": "AT", "country": "Austria", "lat": 48.2332000732, "lng": 14.1875, "timezone": "Europe/Vienna" }, { "id": "NRT", "name": "Narita International Airport", "nearestCity": "Tokyo", "iata": "NRT", "icao": "RJAA", "unLocode": null, "codeFromCarrier": "NRT", "state": "Chiba", "countryCode": "JP", "country": "Japan", "lat": 35.7647018433, "lng": 140.3860015869, "timezone": "Asia/Tokyo" }, { "id": "CDG", "name": "Charles de Gaulle International Airport", "nearestCity": "Paris", "iata": "CDG", "icao": "LFPG", "unLocode": null, "codeFromCarrier": "CDG", "state": "Ile-de-France", "countryCode": "FR", "country": "France", "lat": 49.0127983093, "lng": 2.5499999523, "timezone": "Europe/Paris" }, { "id": "HND", "name": "Tokyo International Airport", "nearestCity": "Tokyo", "iata": "HND", "icao": "RJTT", "unLocode": null, "codeFromCarrier": "HND", "state": "Tokyo", "countryCode": "JP", "country": "Japan", "lat": 35.5522994995, "lng": 139.7799987793, "timezone": "Asia/Tokyo" } ], "departure": { "location": "LNZ", "estimated": "2026-08-15T11:00:00", "actual": "2026-08-15T11:18:00" }, "arrival": { "location": "NRT", "estimated": "2026-08-18T07:00:00", "actual": "2026-08-18T08:07:00" }, "cargo": { "pieces": 2, "weightKg": 260.8 }, "routeSegments": [ { "sequence": 1, "departure": { "location": "LNZ", "estimated": "2026-08-15T11:00:00", "actual": "2026-08-15T11:18:00" }, "arrival": { "location": "CDG", "estimated": "2026-08-16T04:00:00", "actual": "2026-08-16T07:56:00" }, "cargo": { "pieces": 2, "weightKg": 260.8 }, "transport": { "mode": "TRUCK", "number": "AF0363D" }, "track": [ { "lat": 48.23013, "lng": 14.1883 }, { "lat": 48.18913000000002, "lng": 14.10818 }, { "lat": 48.18420000000003, "lng": 14.01757 }, { "lat": 48.18932000000002, "lng": 13.926650000000006 }, { "lat": 48.176730000000035, "lng": 13.83685000000001 }, { "lat": 48.17799, "lng": 13.743190000000018 }, { "lat": 48.19141999999999, "lng": 13.653300000000028 }, { "lat": 48.237849999999966, "lng": 13.574370000000027 }, { "lat": 48.27519999999999, "lng": 13.491800000000019 }, { "lat": 48.31774999999999, "lng": 13.411760000000028 }, { "lat": 48.15443000000003, "lng": 11.817420000000022 }, { "lat": 48.17777000000004, "lng": 11.729920000000027 }, { "lat": 48.21255000000002, "lng": 11.643750000000026 }, { "lat": 48.22680000000005, "lng": 11.554060000000021 }, { "lat": 48.20934000000002, "lng": 11.465670000000014 }, { "lat": 48.22109999999999, "lng": 11.369520000000009 }, { "lat": 48.26713999999997, "lng": 11.291220000000012 }, { "lat": 48.30676999999997, "lng": 11.209050000000016 }, { "lat": 48.355380000000004, "lng": 11.131610000000022 }, { "lat": 48.396690000000014, "lng": 11.05079000000002 }, { "lat": 48.45647000000013, "lng": 9.960759999999992 }, { "lat": 48.972080000000226, "lng": 8.445779999999985 }, { "lat": 48.937090000000204, "lng": 8.361729999999985 }, { "lat": 48.88766000000019, "lng": 8.285119999999987 }, { "lat": 48.8291000000002, "lng": 8.215659999999987 }, { "lat": 48.82737000000022, "lng": 8.125649999999984 }, { "lat": 48.84361000000028, "lng": 8.03604999999999 }, { "lat": 48.832690000000305, "lng": 7.9465799999999875 }, { "lat": 48.833370000000315, "lng": 7.856509999999992 }, { "lat": 48.83540000000032, "lng": 7.766109999999991 }, { "lat": 48.76642000000033, "lng": 7.706419999999987 }, { "lat": 48.77053000000035, "lng": 7.614509999999991 }, { "lat": 48.76957000000037, "lng": 7.520959999999987 }, { "lat": 48.77637000000039, "lng": 7.430199999999986 }, { "lat": 48.76712000000037, "lng": 7.339739999999987 }, { "lat": 48.775790000000356, "lng": 7.24998999999999 }, { "lat": 48.809740000000374, "lng": 7.165779999999991 }, { "lat": 48.88955000000038, "lng": 7.12362999999999 }, { "lat": 48.96633000000038, "lng": 7.074089999999994 }, { "lat": 49.04240000000046, "lng": 7.025749999999993 }, { "lat": 49.06524000000047, "lng": 6.937819999999991 }, { "lat": 49.107350000000444, "lng": 6.857499999999989 }, { "lat": 49.13721000000042, "lng": 6.76719999999999 }, { "lat": 49.13214000000043, "lng": 6.676819999999991 }, { "lat": 49.13376000000044, "lng": 6.57971999999999 }, { "lat": 49.138850000000424, "lng": 6.487649999999987 }, { "lat": 49.13907000000042, "lng": 6.397589999999988 }, { "lat": 49.12832000000039, "lng": 6.308079999999989 }, { "lat": 49.18497000000043, "lng": 6.237359999999984 }, { "lat": 49.19691000000042, "lng": 6.148109999999989 }, { "lat": 49.02925000000038, "lng": 4.53502 }, { "lat": 49.03417000000039, "lng": 4.444690000000001 }, { "lat": 49.03577000000039, "lng": 4.354610000000001 }, { "lat": 49.06884000000039, "lng": 4.270830000000002 }, { "lat": 49.14128000000043, "lng": 4.2154000000000025 }, { "lat": 49.189730000000445, "lng": 4.138820000000001 }, { "lat": 49.21078000000044, "lng": 4.050970000000001 }, { "lat": 49.24215000000044, "lng": 3.966360000000001 }, { "lat": 49.238920000000434, "lng": 3.876270000000001 }, { "lat": 49.21159000000042, "lng": 3.790160000000003 }, { "lat": 49.1568200000004, "lng": 3.7187300000000016 }, { "lat": 49.1426800000004, "lng": 3.6289400000000027 }, { "lat": 49.12666000000039, "lng": 3.5384600000000015 }, { "lat": 49.10079000000038, "lng": 3.4500500000000014 }, { "lat": 49.077230000000384, "lng": 3.3631000000000006 }, { "lat": 49.046890000000396, "lng": 3.2781399999999996 }, { "lat": 49.03661000000041, "lng": 3.1878800000000003 }, { "lat": 48.994260000000445, "lng": 3.1083899999999995 }, { "lat": 48.94177000000044, "lng": 3.0340899999999995 }, { "lat": 48.90964000000043, "lng": 2.9496100000000016 }, { "lat": 48.916130000000436, "lng": 2.859660000000004 }, { "lat": 48.954180000000434, "lng": 2.778040000000003 }, { "lat": 48.94898000000041, "lng": 2.6881200000000023 }, { "lat": 49.00754000000038, "lng": 2.619049999999999 }, { "lat": 49.013530000000365, "lng": 2.550199999999997 } ] }, { "sequence": 2, "departure": { "location": "CDG", "estimated": "2026-08-16T23:00:00", "actual": "2026-08-16T23:20:00" }, "arrival": { "location": "HND", "estimated": "2026-08-17T19:40:00", "actual": "2026-08-17T18:59:00" }, "cargo": { "pieces": 2, "weightKg": 260.8 }, "transport": { "mode": "AIR", "number": "AF0274" }, "track": [ { "lat": 49.0127983093, "lng": 2.5499999523 }, { "lat": 50.503, "lng": 6.55 }, { "lat": 51.611, "lng": 9.55 }, { "lat": 52.703, "lng": 12.55 }, { "lat": 53.774, "lng": 15.55 }, { "lat": 54.125, "lng": 16.55 }, { "lat": 54.816, "lng": 18.55 }, { "lat": 55.492, "lng": 20.55 }, { "lat": 56.15, "lng": 22.55 }, { "lat": 56.789, "lng": 24.55 }, { "lat": 57.408, "lng": 26.55 }, { "lat": 57.709, "lng": 27.55 }, { "lat": 58.293, "lng": 29.55 }, { "lat": 58.576, "lng": 30.55 }, { "lat": 58.852, "lng": 31.55 }, { "lat": 59.122, "lng": 32.55 }, { "lat": 59.385, "lng": 33.55 }, { "lat": 59.641, "lng": 34.55 }, { "lat": 59.889, "lng": 35.55 }, { "lat": 60.13, "lng": 36.55 }, { "lat": 60.364, "lng": 37.55 }, { "lat": 60.59, "lng": 38.55 }, { "lat": 60.808, "lng": 39.55 }, { "lat": 61.018, "lng": 40.55 }, { "lat": 61.22, "lng": 41.55 }, { "lat": 61.413, "lng": 42.55 }, { "lat": 61.598, "lng": 43.55 }, { "lat": 61.773, "lng": 44.55 }, { "lat": 61.941, "lng": 45.55 }, { "lat": 62.099, "lng": 46.55 }, { "lat": 62.248, "lng": 47.55 }, { "lat": 62.388, "lng": 48.55 }, { "lat": 62.518, "lng": 49.55 }, { "lat": 62.639, "lng": 50.55 }, { "lat": 62.75, "lng": 51.55 }, { "lat": 62.852, "lng": 52.55 }, { "lat": 62.944, "lng": 53.55 }, { "lat": 63.026, "lng": 54.55 }, { "lat": 63.097, "lng": 55.55 }, { "lat": 63.159, "lng": 56.55 }, { "lat": 63.211, "lng": 57.55 }, { "lat": 63.252, "lng": 58.55 }, { "lat": 63.283, "lng": 59.55 }, { "lat": 63.303, "lng": 60.55 }, { "lat": 63.313, "lng": 61.55 }, { "lat": 63.313, "lng": 62.55 }, { "lat": 63.302, "lng": 63.55 }, { "lat": 63.28, "lng": 64.55 }, { "lat": 63.248, "lng": 65.55 }, { "lat": 63.205, "lng": 66.55 }, { "lat": 63.151, "lng": 67.55 }, { "lat": 63.087, "lng": 68.55 }, { "lat": 63.011, "lng": 69.55 }, { "lat": 62.925, "lng": 70.55 }, { "lat": 62.828, "lng": 71.55 }, { "lat": 62.721, "lng": 72.55 }, { "lat": 62.602, "lng": 73.55 }, { "lat": 62.473, "lng": 74.55 }, { "lat": 62.333, "lng": 75.55 }, { "lat": 62.183, "lng": 76.55 }, { "lat": 62.021, "lng": 77.55 }, { "lat": 61.849, "lng": 78.55 }, { "lat": 61.667, "lng": 79.55 }, { "lat": 61.473, "lng": 80.55 }, { "lat": 61.269, "lng": 81.55 }, { "lat": 61.055, "lng": 82.55 }, { "lat": 60.83, "lng": 83.55 }, { "lat": 60.595, "lng": 84.55 }, { "lat": 60.35, "lng": 85.55 }, { "lat": 60.094, "lng": 86.55 }, { "lat": 59.829, "lng": 87.55 }, { "lat": 59.553, "lng": 88.55 }, { "lat": 59.267, "lng": 89.55 }, { "lat": 58.972, "lng": 90.55 }, { "lat": 58.666, "lng": 91.55 }, { "lat": 58.352, "lng": 92.55 }, { "lat": 58.027, "lng": 93.55 }, { "lat": 57.693, "lng": 94.55 }, { "lat": 57.35, "lng": 95.55 }, { "lat": 56.998, "lng": 96.55 }, { "lat": 56.637, "lng": 97.55 }, { "lat": 56.267, "lng": 98.55 }, { "lat": 55.888, "lng": 99.55 }, { "lat": 55.5, "lng": 100.55 }, { "lat": 55.104, "lng": 101.55 }, { "lat": 54.7, "lng": 102.55 }, { "lat": 54.288, "lng": 103.55 }, { "lat": 53.867, "lng": 104.55 }, { "lat": 53.439, "lng": 105.55 }, { "lat": 53.004, "lng": 106.55 }, { "lat": 52.561, "lng": 107.55 }, { "lat": 51.653, "lng": 109.55 }, { "lat": 51.189, "lng": 110.55 }, { "lat": 50.717, "lng": 111.55 }, { "lat": 50.24, "lng": 112.55 }, { "lat": 49.756, "lng": 113.55 }, { "lat": 48.77, "lng": 115.55 }, { "lat": 47.762, "lng": 117.55 }, { "lat": 46.733, "lng": 119.55 }, { "lat": 45.684, "lng": 121.55 }, { "lat": 44.618, "lng": 123.55 }, { "lat": 44.079, "lng": 124.55 }, { "lat": 42.99, "lng": 126.55 }, { "lat": 41.333, "lng": 129.55 }, { "lat": 39.653, "lng": 132.55 }, { "lat": 37.39, "lng": 136.55 }, { "lat": 35.5522994995, "lng": 139.7799987793 } ] }, { "sequence": 3, "departure": { "location": "HND", "estimated": "2026-08-18T04:00:00", "actual": "2026-08-18T03:30:00" }, "arrival": { "location": "NRT", "estimated": "2026-08-18T07:00:00", "actual": "2026-08-18T08:07:00" }, "cargo": { "pieces": 2, "weightKg": 260.8 }, "transport": { "mode": "TRUCK", "number": "AF0756L" }, "track": [ { "lat": 35.553372, "lng": 139.779282 }, { "lat": 35.64093400000001, "lng": 139.80233800000002 }, { "lat": 35.64475900000002, "lng": 139.8963290000001 }, { "lat": 35.68824599999999, "lng": 139.97809400000006 }, { "lat": 35.64911999999998, "lng": 140.05938600000013 }, { "lat": 35.68109099999999, "lng": 140.1441220000002 }, { "lat": 35.686961, "lng": 140.23439100000027 }, { "lat": 35.74132299999997, "lng": 140.3083170000004 }, { "lat": 35.764443, "lng": 140.38600200000036 } ] } ], "events": [ { "sequence": 1, "code": "BKD", "description": "Booked", "location": "LNZ", "dateTime": { "estimated": null, "actual": "2026-08-14T08:26:38" }, "transport": { "mode": "AIR", "number": null }, "cargo": { "pieces": 2, "weightKg": 250 } }, { "sequence": 2, "code": "FWB", "description": "FWB processing", "location": "LNZ", "dateTime": { "estimated": null, "actual": "2026-08-14T19:07:00" }, "transport": { "mode": "AIR", "number": null }, "cargo": { "pieces": 2, "weightKg": 260.8 } }, { "sequence": 3, "code": "FOH", "description": "Freight on hand", "location": "LNZ", "dateTime": { "estimated": null, "actual": "2026-08-14T19:08:00" }, "transport": { "mode": "AIR", "number": null }, "cargo": { "pieces": 2, "weightKg": 260.8 } }, { "sequence": 4, "code": "RCS", "description": "Receiving from shipper", "location": "LNZ", "dateTime": { "estimated": null, "actual": "2026-08-15T08:26:00" }, "transport": { "mode": "AIR", "number": null }, "cargo": { "pieces": 2, "weightKg": 260.8 } }, { "sequence": 5, "code": "DEP", "description": "Departure", "location": "LNZ", "dateTime": { "estimated": null, "actual": "2026-08-15T11:18:00" }, "transport": { "mode": "TRUCK", "number": "AF0363D" }, "cargo": { "pieces": 2, "weightKg": 260.8 } }, { "sequence": 6, "code": "ARR", "description": "Arrival", "location": "CDG", "dateTime": { "estimated": null, "actual": "2026-08-16T07:56:00" }, "transport": { "mode": "TRUCK", "number": "AF0363D" }, "cargo": { "pieces": 2, "weightKg": 260.8 } }, { "sequence": 7, "code": "RCF", "description": "Receiving from flight", "location": "CDG", "dateTime": { "estimated": null, "actual": "2026-08-16T12:25:00" }, "transport": { "mode": "AIR", "number": "AF0363D" }, "cargo": { "pieces": 2, "weightKg": 260.8 } }, { "sequence": 8, "code": "DEP", "description": "Departure", "location": "CDG", "dateTime": { "estimated": null, "actual": "2026-08-16T23:20:00" }, "transport": { "mode": "AIR", "number": "AF0274" }, "cargo": { "pieces": 2, "weightKg": 260.8 } }, { "sequence": 9, "code": "ARR", "description": "Arrival", "location": "HND", "dateTime": { "estimated": null, "actual": "2026-08-17T18:59:00" }, "transport": { "mode": "AIR", "number": "AF0274" }, "cargo": { "pieces": 2, "weightKg": 260.8 } }, { "sequence": 10, "code": "RCF", "description": "Receiving from flight", "location": "HND", "dateTime": { "estimated": null, "actual": "2026-08-17T21:27:00" }, "transport": { "mode": "AIR", "number": "AF0274" }, "cargo": { "pieces": 2, "weightKg": 260.8 } }, { "sequence": 11, "code": "DEP", "description": "Departure", "location": "HND", "dateTime": { "estimated": null, "actual": "2026-08-18T03:30:00" }, "transport": { "mode": "TRUCK", "number": "AF0756L" }, "cargo": { "pieces": 2, "weightKg": 260.8 } }, { "sequence": 12, "code": "RCF", "description": "Receiving from flight", "location": "NRT", "dateTime": { "estimated": null, "actual": "2026-08-18T08:07:00" }, "transport": { "mode": "AIR", "number": "AF0756L" }, "cargo": { "pieces": 2, "weightKg": 260.8 } }, { "sequence": 13, "code": "NFD", "description": "Notification", "location": "NRT", "dateTime": { "estimated": null, "actual": "2026-08-18T08:07:00" }, "transport": { "mode": "AIR", "number": null }, "cargo": { "pieces": 2, "weightKg": 260.8 } } ] } } } } }, "401": { "description": "Unauthorized - Missing or invalid Bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/carriers/air": { "get": { "tags": ["Air Tracking API v1"], "summary": "Get Supported Airlines", "description": "Retrieves the list of supported airlines along with their air waybill prefixes and operational statuses. Authorization is not required.", "operationId": "getAirCarriers", "security": [], "responses": { "200": { "description": "List of airlines retrieved successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AirlineListResponse" }, "example": { "status": "success", "message": "OK", "data": [ { "name": "Air France", "prefix": "057", "code": "AF", "maintenance": false }, { "name": "KLM Royal Dutch Airlines", "prefix": "074", "code": "KL", "maintenance": false }, { "name": "Lufthansa Cargo", "prefix": "020", "code": "LH", "maintenance": false }, { "name": "Emirates SkyCargo", "prefix": "176", "code": "EK", "maintenance": false } ] } } } } } } } }, "components": { "securitySchemes": { "BearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "opaque", "description": "HTTP Bearer token authorization header." } }, "schemas": { "ErrorResponse": { "type": "object", "description": "Standard API error response wrapper.", "properties": { "message": { "type": "string", "description": "Detailed human-readable error description.", "example": "Invalid or expired Bearer token provided." } }, "required": ["message"] }, "AirlineInfo": { "type": "object", "description": "Airline supported by the air tracking product.", "properties": { "name": { "type": "string", "nullable": true, "description": "Airline name.", "example": "Air France" }, "prefix": { "type": "string", "nullable": true, "description": "Three-digit IATA airline accounting prefix - the first block of an air waybill number.", "example": "057" }, "code": { "type": "string", "nullable": true, "description": "Two-character IATA airline designator.", "example": "AF" }, "maintenance": { "type": "boolean", "description": "Flag indicating whether tracking for this airline is temporarily unavailable.", "example": false } }, "required": ["name", "prefix", "code", "maintenance"] }, "AirlineListResponse": { "type": "object", "description": "Top-level envelope of the supported airlines response.", "properties": { "status": { "type": "string", "enum": ["success", "error"], "description": "Envelope status of the request.", "example": "success" }, "message": { "type": "string", "description": "Human-readable envelope message.", "example": "OK" }, "data": { "type": "array", "description": "Supported airlines, sorted by name.", "items": { "$ref": "#/components/schemas/AirlineInfo" } } }, "required": ["status", "message", "data"] }, "Coordinates": { "type": "object", "description": "Geographic point in decimal degrees.", "properties": { "lat": { "type": "number", "nullable": true, "format": "double", "description": "Latitude angle in decimal degrees.", "example": 48.23013 }, "lng": { "type": "number", "nullable": true, "format": "double", "description": "Longitude angle in decimal degrees.", "example": 14.1883 } }, "required": ["lat", "lng"] }, "TransportPosition": { "type": "object", "description": "Live position of the aircraft or truck currently carrying the cargo. Returned only when `routePath=true`, and only while the leg is under way.", "nullable": true, "properties": { "lat": { "type": "number", "nullable": true, "format": "double", "description": "Latitude angle in decimal degrees.", "example": 31.2044 }, "lng": { "type": "number", "nullable": true, "format": "double", "description": "Longitude angle in decimal degrees.", "example": 121.9 }, "heading": { "type": "number", "nullable": true, "format": "double", "description": "Course over ground in degrees, clockwise from true north.", "example": 214 }, "altitude": { "type": "number", "nullable": true, "format": "double", "description": "Altitude above sea level in metres.", "example": 10668 }, "speed": { "type": "number", "nullable": true, "format": "double", "description": "Ground speed in kilometres per hour.", "example": 842 }, "updatedAt": { "type": "string", "nullable": true, "format": "date-time", "description": "Timestamp the position was reported at.", "example": "2026-08-17T05:38:00" } } }, "Location": { "type": "object", "description": "Airport or handling location. Locations are listed once under `shipment.locations` and referenced by their `id` everywhere else in the payload.", "properties": { "id": { "type": "string", "nullable": true, "description": "Identifier the rest of the payload references this location by.", "example": "LNZ" }, "name": { "type": "string", "nullable": true, "description": "Official airport or facility name.", "example": "Linz Airport" }, "nearestCity": { "type": "string", "nullable": true, "description": "City the location serves.", "example": "Linz" }, "iata": { "type": "string", "nullable": true, "description": "IATA three-letter location code.", "example": "LNZ" }, "icao": { "type": "string", "nullable": true, "description": "ICAO four-letter location code.", "example": "LOWL" }, "unLocode": { "type": "string", "nullable": true, "description": "United Nations Code for Trade and Transport Locations (UN/LOCODE).", "example": "ATLNZ" }, "codeFromCarrier": { "type": "string", "nullable": true, "description": "Location code exactly as the airline reported it.", "example": "LNZ" }, "state": { "type": "string", "nullable": true, "description": "State, province, or district name.", "example": "Upper-Austria" }, "countryCode": { "type": "string", "nullable": true, "description": "ISO 3166-1 alpha-2 two-letter country code.", "example": "AT" }, "country": { "type": "string", "nullable": true, "description": "Full country name.", "example": "Austria" }, "lat": { "type": "number", "nullable": true, "format": "double", "description": "Latitude angle in decimal degrees.", "example": 48.2332000732 }, "lng": { "type": "number", "nullable": true, "format": "double", "description": "Longitude angle in decimal degrees.", "example": 14.1875 }, "timezone": { "type": "string", "nullable": true, "description": "IANA time zone identifier of the location.", "example": "Europe/Vienna" } }, "required": ["id"] }, "CarrierRef": { "type": "object", "description": "Airline the air waybill was issued by.", "nullable": true, "properties": { "name": { "type": "string", "nullable": true, "description": "Airline name.", "example": "Air France" }, "code": { "type": "string", "nullable": true, "description": "Two-character IATA airline designator.", "example": "AF" } } }, "Transport": { "type": "object", "description": "Conveyance carrying the cargo on a leg.", "nullable": true, "properties": { "mode": { "type": "string", "nullable": true, "enum": ["AIR", "TRUCK"], "description": "Mode of transportation. Possible values:\n\n* `AIR` - Flight leg\n* `TRUCK` - Road feeder service leg, flown under a flight number by the airline", "example": "AIR" }, "number": { "type": "string", "nullable": true, "description": "Flight or road feeder service number.", "example": "AF0274" } }, "required": ["mode"] }, "DepartureArrival": { "type": "object", "description": "Estimated (scheduled) and actual timing of a departure or an arrival.", "nullable": true, "properties": { "location": { "type": "string", "nullable": true, "description": "Identifier of the location, matching an `id` in `shipment.locations`.", "example": "LNZ" }, "estimated": { "type": "string", "nullable": true, "format": "date-time", "description": "Estimated or scheduled timestamp.", "example": "2026-08-15T11:00:00" }, "actual": { "type": "string", "nullable": true, "format": "date-time", "description": "Actual timestamp, `null` until the movement has happened.", "example": "2026-08-15T11:18:00" } } }, "EventPoint": { "type": "object", "description": "Departure or arrival point announced by an event. Carries the estimate only - the actual timestamp of the event itself lives in `dateTime`.", "nullable": true, "properties": { "location": { "type": "string", "nullable": true, "description": "Identifier of the location, matching an `id` in `shipment.locations`.", "example": "CDG" }, "estimated": { "type": "string", "nullable": true, "format": "date-time", "description": "Estimated or scheduled timestamp.", "example": "2026-08-16T04:00:00" } } }, "CargoUnit": { "type": "object", "description": "Single loading unit the cargo is carried in.", "properties": { "type": { "type": "string", "nullable": true, "description": "Unit type, for example a unit load device or a loose piece.", "example": "ULD" }, "number": { "type": "string", "nullable": true, "description": "Unit identifier as reported by the airline.", "example": "AKE12345AF" }, "pieces": { "type": "integer", "nullable": true, "description": "Number of pieces inside the unit.", "example": 2 } } }, "Cargo": { "type": "object", "description": "Cargo volume as reported at this point of the shipment.", "nullable": true, "properties": { "pieces": { "type": "integer", "nullable": true, "description": "Number of pieces.", "example": 2 }, "weightKg": { "type": "number", "nullable": true, "format": "double", "description": "Gross weight in kilograms.", "example": 260.8 }, "units": { "type": "array", "nullable": true, "description": "Loading units the cargo is made up of, when the airline breaks it down.", "items": { "$ref": "#/components/schemas/CargoUnit" } } } }, "RouteSegment": { "type": "object", "description": "Single leg of the itinerary, in chronological order.", "properties": { "sequence": { "type": "integer", "nullable": true, "description": "Sequential order number of the leg.", "example": 1 }, "departure": { "$ref": "#/components/schemas/DepartureArrival" }, "arrival": { "$ref": "#/components/schemas/DepartureArrival" }, "cargo": { "$ref": "#/components/schemas/Cargo" }, "transport": { "$ref": "#/components/schemas/Transport" }, "transportPosition": { "$ref": "#/components/schemas/TransportPosition" }, "track": { "type": "array", "nullable": true, "description": "Coordinate waypoints of the path flown or driven on this leg, oldest first. Returned only when `routePath=true`.", "items": { "$ref": "#/components/schemas/Coordinates" } } } }, "EventDateTime": { "type": "object", "description": "Timing of an event.", "nullable": true, "properties": { "estimated": { "type": "string", "nullable": true, "format": "date-time", "description": "Estimated or scheduled timestamp of the event." }, "actual": { "type": "string", "nullable": true, "format": "date-time", "description": "Actual timestamp of the event.", "example": "2026-08-14T08:26:38" } } }, "ShipmentEvent": { "type": "object", "description": "Single milestone in the air waybill life-cycle.", "properties": { "sequence": { "type": "integer", "nullable": true, "description": "Sequential order number of the event.", "example": 1 }, "code": { "type": "string", "nullable": true, "description": "IATA cargo status code. The set depends on the airline; the codes returned most often are:\n\n* `BKD` - Booked\n* `RCS` - Receiving from shipper\n* `FOH` - Freight on hand\n* `MAN` - Manifest\n* `PRE` - Preparing for loading\n* `DEP` - Departure\n* `ARR` - Arrival\n* `RCF` - Receiving from flight\n* `AWD` - Documents delivery to the consignee\n* `AWR` - Receiving documents at this location\n* `NFD` - Notification\n* `DLV` - Delivery\n* `FWB` - FWB processing\n* `RCD` - Receiving\n* `RCT` - Receiving from another airline\n* `TFD` - Transfer to another airline\n* `TRM` - Transfer to another airline\n* `CCD` - Customs clearance\n* `TGC` - Transfer to Customs/Government control\n* `DIS` - Discrepancy\n* `RFF` - Removed from flight", "example": "RCS" }, "description": { "type": "string", "nullable": true, "description": "Human-readable description of the status code.", "example": "Receiving from shipper" }, "location": { "type": "string", "nullable": true, "description": "Identifier of the location the event happened at, matching an `id` in `shipment.locations`.", "example": "LNZ" }, "dateTime": { "$ref": "#/components/schemas/EventDateTime" }, "departure": { "$ref": "#/components/schemas/EventPoint" }, "arrival": { "$ref": "#/components/schemas/EventPoint" }, "transport": { "$ref": "#/components/schemas/Transport" }, "cargo": { "$ref": "#/components/schemas/Cargo" } } }, "Shipment": { "type": "object", "description": "Air waybill master entity containing locations, itinerary legs, and the event history.", "properties": { "type": { "type": "string", "nullable": true, "enum": ["AWB"], "description": "Type of the tracked reference. Air tracking accepts air waybill numbers only.", "example": "AWB" }, "number": { "type": "string", "nullable": true, "description": "Air waybill number, airline prefix included.", "example": "001-27868153" }, "carrier": { "$ref": "#/components/schemas/CarrierRef" }, "updatedAt": { "type": "string", "nullable": true, "format": "date-time", "description": "Timestamp the shipment data was last refreshed at.", "example": "2026-08-19T05:40:06" }, "status": { "type": "string", "nullable": true, "enum": [ "BOOKED", "RECEIVED", "DEPARTED", "IN_TRANSIT", "ARRIVED", "NOTIFIED", "DELIVERED", "CANCELLED", "NULL" ], "description": "Current shipment status. Possible values:\n\n* `BOOKED` - Shipment booked with the airline\n* `RECEIVED` - Cargo received from the shipper\n* `DEPARTED` - Cargo departed on a flight\n* `IN_TRANSIT` - Cargo is on its way, one or more legs completed\n* `ARRIVED` - Cargo arrived at the destination airport\n* `NOTIFIED` - Consignee notified that the cargo is ready for pickup\n* `DELIVERED` - Cargo delivered to the consignee\n* `CANCELLED` - Shipment cancelled\n* `NULL` - Airline reported no status at all", "example": "NOTIFIED" }, "locations": { "type": "array", "nullable": true, "description": "Every location the payload refers to, listed once and referenced by `id` from the itinerary, the events, and the departure and arrival blocks.", "items": { "$ref": "#/components/schemas/Location" } }, "departure": { "$ref": "#/components/schemas/DepartureArrival" }, "arrival": { "$ref": "#/components/schemas/DepartureArrival" }, "cargo": { "$ref": "#/components/schemas/Cargo" }, "routeSegments": { "type": "array", "nullable": true, "description": "Itinerary legs in chronological order.", "items": { "$ref": "#/components/schemas/RouteSegment" } }, "transport": { "$ref": "#/components/schemas/Transport" }, "events": { "type": "array", "nullable": true, "description": "Milestone history in chronological order.", "items": { "$ref": "#/components/schemas/ShipmentEvent" } } }, "required": ["type", "number", "status"] }, "ShipmentResponse": { "type": "object", "description": "Top-level API envelope response for air waybill tracking.", "properties": { "success": { "type": "boolean", "description": "Flag indicating whether the shipment was tracked successfully.", "example": true }, "statusCode": { "type": "string", "enum": [ "OK", "MISSING_REQUIRED_PARAMETER", "INVALID_NUMBER", "CARRIER_NOT_SUPPORTED", "CARRIER_UNDER_MAINTENANCE", "CARRIER_NO_RESPONSE", "SHIPMENT_NOT_FOUND", "INTERNAL_SERVER_ERROR" ], "description": "Processing result of the request. Possible values:\n\n* `OK` - Request processed successfully\n* `MISSING_REQUIRED_PARAMETER` - The required `number` query parameter is absent\n* `INVALID_NUMBER` - The supplied value is not a valid air waybill number (a 3-digit airline prefix followed by 8 digits)\n* `CARRIER_NOT_SUPPORTED` - The airline the prefix belongs to is not supported\n* `CARRIER_UNDER_MAINTENANCE` - The airline is temporarily unavailable for tracking\n* `CARRIER_NO_RESPONSE` - The airline did not answer the tracking request in time\n* `SHIPMENT_NOT_FOUND` - The airline has no shipment under this air waybill number\n* `INTERNAL_SERVER_ERROR` - Unexpected processing error", "example": "OK" }, "shipment": { "$ref": "#/components/schemas/Shipment" } }, "required": ["success", "statusCode", "shipment"] } } } }