{ "openapi": "3.1.0", "info": { "title": "Cubic API", "version": "1.0.0", "summary": "Read-only API for Cubic customers to query their shipments.", "description": "Read-only REST API for Cubic customers to query their own shipments: status, route and milestones, carrier and bill numbers, containers, packages and parcel tracking.\n\nDocumentation: https://developers.gocubic.io. For AI agents: https://developers.gocubic.io/llms.txt (index) and https://developers.gocubic.io/llms-full.txt (everything in one file).\n\n## Conventions\n\n- Send `Authorization: Bearer `, with the key in the `CUBIC_API_KEY` environment variable. One key belongs to one customer account.\n- Call `GET /me` first to verify the key.\n- JSON only, camelCase keys. Enum values are case-sensitive (`OceanFCL`, `EXW`).\n- `null` or an empty list means \"not known yet\" or \"does not apply\"; never an error.\n- Milestone dates are local calendar dates (`yyyy-MM-dd`, optional local `HH:mm` time) with no time zone. `createdAt`, `updatedAt` and `cancelledAt` are ISO 8601 UTC timestamps.\n- Units are as recorded, not normalised. Always read `unit`.\n- Cursor pagination: follow `nextCursor` until it is `null`.\n- 60 requests per minute per key. On `429` wait `Retry-After` seconds.\n- Errors are RFC 9457 `application/problem+json` with a `code` and a `hint` that says how to fix the request." }, "externalDocs": { "description": "Guides, recipes and the llms.txt index", "url": "https://developers.gocubic.io" }, "servers": [ { "url": "https://api.gocubic.io/v1", "description": "Production" } ], "security": [ { "bearerAuth": [] } ], "tags": [ { "name": "Account", "description": "Verify the API key and see which account it belongs to." }, { "name": "Shipments", "description": "Read the account's shipments." }, { "name": "Meta", "description": "The API description itself." } ], "paths": { "/me": { "get": { "operationId": "getMe", "tags": [ "Account" ], "summary": "Verify the API key", "description": "Returns the account and the key behind the request. Call it first.", "responses": { "200": { "description": "The key is valid.", "headers": { "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Me" }, "examples": { "me": { "$ref": "#/components/examples/me" } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/shipments": { "get": { "operationId": "listShipments", "tags": [ "Shipments" ], "summary": "List shipments", "description": "Lists the account's shipments, most recently updated first. Filters combine with AND. Each item is the full Shipment object — the same as the detail endpoint — so do not fetch each shipment again.", "parameters": [ { "name": "limit", "in": "query", "description": "Page size.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "cursor", "in": "query", "description": "The `nextCursor` of the previous page, unchanged. Opaque: do not build, decode or modify it. Send it with the same filters as the request that produced it.", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Only shipments with this status. Repeat the parameter to match any of several: `?status=Active&status=Delivered`.", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentStatus" } }, "examples": { "one": { "summary": "One status", "value": [ "Active" ] }, "several": { "summary": "Any of several statuses", "value": [ "Active", "Delivered" ] } } }, { "name": "updatedSince", "in": "query", "description": "Only shipments whose `updatedAt` is at or after this ISO 8601 timestamp. For polling: store the greatest `updatedAt` you have seen and pass it back. The boundary shipment is returned again, so upsert by `reference`.", "schema": { "type": "string", "format": "date-time" }, "example": "2026-07-29T06:40:00Z" }, { "name": "createdSince", "in": "query", "description": "Only shipments whose `createdAt` is at or after this ISO 8601 timestamp.", "schema": { "type": "string", "format": "date-time" }, "example": "2026-07-01T00:00:00Z" }, { "name": "tag", "in": "query", "description": "Only shipments carrying exactly this tag. Tags are the customer's own labels, in practice PO numbers.", "schema": { "type": "string" }, "example": "PO-8841" }, { "name": "search", "in": "query", "description": "Free-text search across the reference, tags, master bill / air waybill numbers, container numbers, and Amazon FBA and reference IDs.", "schema": { "type": "string" }, "example": "CSNU1234567" } ], "responses": { "200": { "description": "A page of shipments. `data` is empty when nothing matches.", "headers": { "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentList" }, "examples": { "page": { "$ref": "#/components/examples/shipmentListPage" }, "lastPage": { "$ref": "#/components/examples/shipmentListEmpty" } } } } }, "400": { "$ref": "#/components/responses/BadListRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/shipments/{reference}": { "get": { "operationId": "getShipment", "tags": [ "Shipments" ], "summary": "Get a shipment", "description": "Returns one shipment by its Cubic reference. To find a shipment by a PO number, container, master bill or FBA ID, use `GET /shipments?search=` instead.", "parameters": [ { "name": "reference", "in": "path", "required": true, "description": "The Cubic reference.", "schema": { "type": "string" }, "example": "QB10293" } ], "responses": { "200": { "description": "The shipment.", "headers": { "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" }, "examples": { "oceanFcl": { "$ref": "#/components/examples/oceanFcl" }, "oceanLcl": { "$ref": "#/components/examples/oceanLcl" }, "oceanDdp": { "$ref": "#/components/examples/oceanDdp" }, "airFreight": { "$ref": "#/components/examples/airFreight" }, "airCourier": { "$ref": "#/components/examples/airCourier" }, "landTruck": { "$ref": "#/components/examples/landTruck" } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/ShipmentNotFound" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" } } } }, "/openapi.json": { "get": { "operationId": "getOpenApiDocument", "tags": [ "Meta" ], "summary": "Get the OpenAPI document", "description": "This document. No authentication. Also published at https://developers.gocubic.io/openapi.json.", "security": [], "responses": { "200": { "description": "The OpenAPI 3.1 document.", "content": { "application/json": { "schema": { "type": "object", "description": "An OpenAPI 3.1 document." }, "examples": { "document": { "summary": "Abbreviated", "value": { "openapi": "3.1.0", "info": { "title": "Cubic API", "version": "1.0.0" } } } } } } } } } } }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "description": "API key sent as `Authorization: Bearer cubic_live_`. Customers create and revoke keys at https://app.gocubic.io/settings/api-keys; a key is shown once, at creation. Keep it in the `CUBIC_API_KEY` environment variable." } }, "headers": { "RateLimit-Limit": { "description": "Requests allowed per minute for this key (60).", "schema": { "type": "integer" }, "example": 60 }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" }, "example": 57 }, "RateLimit-Reset": { "description": "Seconds until the current window resets.", "schema": { "type": "integer" }, "example": 42 }, "Retry-After": { "description": "Seconds to wait before retrying. Sent with `429` responses.", "schema": { "type": "integer" }, "example": 17 } }, "responses": { "Unauthorized": { "description": "The API key is missing (`missing_api_key`) or not valid (`invalid_api_key`).", "headers": { "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "missing_api_key": { "$ref": "#/components/examples/missing_api_key" }, "invalid_api_key": { "$ref": "#/components/examples/invalid_api_key" } } } } }, "BadListRequest": { "description": "A query parameter is not valid (`invalid_parameter`, with `parameter` naming it) or the cursor is not usable (`invalid_cursor`).", "headers": { "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "invalid_parameter": { "$ref": "#/components/examples/invalid_parameter" }, "invalid_cursor": { "$ref": "#/components/examples/invalid_cursor" } } } } }, "ShipmentNotFound": { "description": "No shipment with this reference exists on the key's account (`shipment_not_found`). The same response is returned for shipments that belong to other accounts.", "headers": { "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "shipment_not_found": { "$ref": "#/components/examples/shipment_not_found" } } } } }, "RateLimited": { "description": "More than 60 requests in a minute on this key (`rate_limited`). Wait `Retry-After` seconds and retry.", "headers": { "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "rate_limited": { "$ref": "#/components/examples/rate_limited" } } } } }, "InternalError": { "description": "Unexpected server error (`internal_error`). Retry with exponential backoff.", "headers": { "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "examples": { "internal_error": { "$ref": "#/components/examples/internal_error" } } } } } }, "examples": { "me": { "summary": "A valid key", "value": { "account": { "name": "Brightwell Home Ltd" }, "apiKey": { "name": "Inventory sync", "prefix": "cubic_live_9f3k", "createdAt": "2026-09-01T08:15:00Z" } } }, "shipmentListPage": { "summary": "A page with more to follow", "value": { "data": [ { "reference": "QB53310", "status": "Active", "serviceType": "AirFreight", "mode": "Air", "incoterms": "EXW", "tags": [ "PO-77104" ], "descriptionOfGoods": "Servo motor assemblies", "insured": true, "bookingConfirmedByCarrier": true, "origin": { "city": "Hanoi", "state": null, "countryCode": "VN", "code": null, "fulfillmentCenter": null, "coordinates": { "lat": 21.0285, "lon": 105.8542 }, "name": "Red River Precision Components JSC", "type": "ShippingParty" }, "portOfLoading": { "city": "Hanoi", "state": null, "countryCode": "VN", "code": "HAN", "fulfillmentCenter": null, "coordinates": { "lat": 21.2212, "lon": 105.8072 }, "name": "Noi Bai International Airport", "type": "Airport" }, "portOfDischarge": { "city": "Chicago", "state": "IL", "countryCode": "US", "code": "ORD", "fulfillmentCenter": null, "coordinates": { "lat": 41.9742, "lon": -87.9073 }, "name": "Chicago O'Hare International Airport", "type": "Airport" }, "destination": { "city": "Elk Grove Village", "state": "IL", "countryCode": "US", "code": null, "fulfillmentCenter": null, "coordinates": { "lat": 42.0039, "lon": -87.9703 }, "name": "Lakeshore Robotics Inc.", "type": "ShippingParty" }, "carrier": { "name": "Qatar Airways", "type": "Airline" }, "booking": { "bookingNumber": null, "masterBill": "157-48213905", "houseBill": "HAN26091187", "cargoCutoff": null, "shippingInstructionCutoff": null, "destinationPortFreeDays": null, "emptyContainerReturnFreeDays": null }, "parcels": null, "amazon": null, "cargo": { "totalWeight": { "value": 168, "unit": "KG" }, "totalVolume": { "value": 1.344, "unit": "CubicMeter" }, "chargeableWeight": { "value": 224, "unit": "KG" }, "stackable": true, "containers": [], "packages": [ { "type": "Box", "quantity": 14, "hazardous": false, "weight": { "value": 12, "unit": "KG" }, "length": { "value": 60, "unit": "Centimeter" }, "width": { "value": 40, "unit": "Centimeter" }, "height": { "value": 40, "unit": "Centimeter" } } ] }, "milestones": [ { "place": { "city": "Hanoi", "state": null, "countryCode": "VN", "code": null, "fulfillmentCenter": null, "coordinates": { "lat": 21.0285, "lon": 105.8542 }, "name": "Red River Precision Components JSC", "type": "ShippingParty" }, "warehouseType": null, "cargoReadyDate": "2026-09-14", "arrival": null, "departure": { "date": "2026-09-14", "time": null, "actual": true }, "transportToNext": { "vessel": null, "voyageNumber": null, "flightNumber": null, "carrier": null, "mode": "Truck" }, "type": "Pickup", "completed": true }, { "place": { "city": "Hanoi", "state": null, "countryCode": "VN", "code": "HAN", "fulfillmentCenter": null, "coordinates": { "lat": 21.2212, "lon": 105.8072 }, "name": "Noi Bai International Airport", "type": "Airport" }, "warehouseType": null, "cargoReadyDate": null, "arrival": { "date": "2026-09-15", "time": null, "actual": true }, "departure": { "date": "2026-09-16", "time": "23:55", "actual": true }, "transportToNext": { "vessel": null, "voyageNumber": null, "flightNumber": "QR8955", "carrier": { "name": "Qatar Airways", "type": "Airline" }, "mode": "Flight" }, "type": "OriginPort", "completed": true }, { "place": { "city": "Doha", "state": null, "countryCode": "QA", "code": "DOH", "fulfillmentCenter": null, "coordinates": { "lat": 25.2731, "lon": 51.6081 }, "name": "Hamad International Airport", "type": "Airport" }, "warehouseType": null, "cargoReadyDate": null, "arrival": { "date": "2026-09-17", "time": "04:10", "actual": true }, "departure": { "date": "2026-09-18", "time": "08:30", "actual": true }, "transportToNext": { "vessel": null, "voyageNumber": null, "flightNumber": "QR8141", "carrier": { "name": "Qatar Airways", "type": "Airline" }, "mode": "Flight" }, "type": "TransshipmentPort", "completed": true }, { "place": { "city": "Chicago", "state": "IL", "countryCode": "US", "code": "ORD", "fulfillmentCenter": null, "coordinates": { "lat": 41.9742, "lon": -87.9073 }, "name": "Chicago O'Hare International Airport", "type": "Airport" }, "warehouseType": null, "cargoReadyDate": null, "arrival": { "date": "2026-09-18", "time": "15:05", "actual": true }, "departure": null, "transportToNext": { "vessel": null, "voyageNumber": null, "flightNumber": null, "carrier": null, "mode": "Truck" }, "type": "DestinationPort", "completed": true }, { "place": { "city": "Elk Grove Village", "state": "IL", "countryCode": "US", "code": null, "fulfillmentCenter": null, "coordinates": { "lat": 42.0039, "lon": -87.9703 }, "name": "Lakeshore Robotics Inc.", "type": "ShippingParty" }, "warehouseType": null, "cargoReadyDate": null, "arrival": { "date": "2026-09-22", "time": null, "actual": false }, "departure": null, "transportToNext": null, "type": "Delivery", "completed": false } ], "currentMilestoneIndex": 3, "cancelledAt": null, "createdAt": "2026-09-09T07:22:00Z", "updatedAt": "2026-09-18T20:41:00Z" }, { "reference": "QB51907", "status": "Active", "serviceType": "OceanLCL", "mode": "Ocean", "incoterms": "EXW", "tags": [ "PO-5512" ], "descriptionOfGoods": "Cotton bed linen", "insured": false, "bookingConfirmedByCarrier": true, "origin": { "city": "Mumbai", "state": null, "countryCode": "IN", "code": null, "fulfillmentCenter": null, "coordinates": { "lat": 19.076, "lon": 72.8777 }, "name": "Kavya Textiles Pvt. Ltd.", "type": "ShippingParty" }, "portOfLoading": { "city": "Navi Mumbai", "state": null, "countryCode": "IN", "code": "INNSA", "fulfillmentCenter": null, "coordinates": { "lat": 18.95, "lon": 72.95 }, "name": "Nhava Sheva", "type": "Seaport" }, "portOfDischarge": { "city": "Hamburg", "state": null, "countryCode": "DE", "code": "DEHAM", "fulfillmentCenter": null, "coordinates": { "lat": 53.5078, "lon": 9.9667 }, "name": "Hamburg", "type": "Seaport" }, "destination": { "city": "Berlin", "state": null, "countryCode": "DE", "code": null, "fulfillmentCenter": null, "coordinates": { "lat": 52.52, "lon": 13.405 }, "name": "Nordlicht Wohnen GmbH", "type": "ShippingParty" }, "carrier": { "name": "Hapag-Lloyd", "type": "ShippingLine" }, "booking": { "bookingNumber": null, "masterBill": "HLCUBO1260845517", "houseBill": "BOM2608377", "cargoCutoff": "2026-09-02", "shippingInstructionCutoff": null, "destinationPortFreeDays": null, "emptyContainerReturnFreeDays": null }, "parcels": null, "amazon": null, "cargo": { "totalWeight": { "value": 1860, "unit": "KG" }, "totalVolume": { "value": 10.08, "unit": "CubicMeter" }, "chargeableWeight": null, "stackable": false, "containers": [ { "number": "HLXU8231457", "type": "FortyFtHighCube", "sealNumber": "HL4471902" } ], "packages": [ { "type": "Pallet", "quantity": 6, "hazardous": false, "weight": { "value": 310, "unit": "KG" }, "length": { "value": 120, "unit": "Centimeter" }, "width": { "value": 100, "unit": "Centimeter" }, "height": { "value": 140, "unit": "Centimeter" } } ] }, "milestones": [ { "place": { "city": "Mumbai", "state": null, "countryCode": "IN", "code": null, "fulfillmentCenter": null, "coordinates": { "lat": 19.076, "lon": 72.8777 }, "name": "Kavya Textiles Pvt. Ltd.", "type": "ShippingParty" }, "warehouseType": null, "cargoReadyDate": "2026-08-28", "arrival": null, "departure": { "date": "2026-08-31", "time": null, "actual": true }, "transportToNext": { "vessel": null, "voyageNumber": null, "flightNumber": null, "carrier": null, "mode": "Truck" }, "type": "Pickup", "completed": true }, { "place": null, "warehouseType": "CFS", "cargoReadyDate": null, "arrival": { "date": "2026-08-31", "time": null, "actual": true }, "departure": { "date": "2026-09-03", "time": null, "actual": true }, "transportToNext": { "vessel": null, "voyageNumber": null, "flightNumber": null, "carrier": null, "mode": "Truck" }, "type": "IntermediaryWarehouse", "completed": true }, { "place": { "city": "Navi Mumbai", "state": null, "countryCode": "IN", "code": "INNSA", "fulfillmentCenter": null, "coordinates": { "lat": 18.95, "lon": 72.95 }, "name": "Nhava Sheva", "type": "Seaport" }, "warehouseType": null, "cargoReadyDate": null, "arrival": { "date": "2026-09-03", "time": null, "actual": true }, "departure": { "date": "2026-09-06", "time": null, "actual": true }, "transportToNext": { "vessel": "BERLIN EXPRESS", "voyageNumber": "2635W", "flightNumber": null, "carrier": { "name": "Hapag-Lloyd", "type": "ShippingLine" }, "mode": "Voyage" }, "type": "OriginPort", "completed": true }, { "place": { "city": "Hamburg", "state": null, "countryCode": "DE", "code": "DEHAM", "fulfillmentCenter": null, "coordinates": { "lat": 53.5078, "lon": 9.9667 }, "name": "Hamburg", "type": "Seaport" }, "warehouseType": null, "cargoReadyDate": null, "arrival": { "date": "2026-09-29", "time": null, "actual": false }, "departure": null, "transportToNext": { "vessel": null, "voyageNumber": null, "flightNumber": null, "carrier": null, "mode": "Truck" }, "type": "DestinationPort", "completed": false }, { "place": null, "warehouseType": "DeconsolidationWarehouse", "cargoReadyDate": null, "arrival": { "date": "2026-10-01", "time": null, "actual": false }, "departure": null, "transportToNext": { "vessel": null, "voyageNumber": null, "flightNumber": null, "carrier": null, "mode": "Truck" }, "type": "IntermediaryWarehouse", "completed": false }, { "place": { "city": "Berlin", "state": null, "countryCode": "DE", "code": null, "fulfillmentCenter": null, "coordinates": { "lat": 52.52, "lon": 13.405 }, "name": "Nordlicht Wohnen GmbH", "type": "ShippingParty" }, "warehouseType": null, "cargoReadyDate": null, "arrival": { "date": "2026-10-05", "time": null, "actual": false }, "departure": null, "transportToNext": null, "type": "Delivery", "completed": false } ], "currentMilestoneIndex": 2, "cancelledAt": null, "createdAt": "2026-08-19T13:04:00Z", "updatedAt": "2026-09-15T21:48:00Z" } ], "nextCursor": "eyJ1IjoiMjAyNi0wOS0xNVQyMTo0ODowMFoiLCJyIjoiUUI1MTkwNyJ9" } }, "shipmentListEmpty": { "summary": "No matches, or past the last page", "value": { "data": [], "nextCursor": null } }, "oceanFcl": { "summary": "Ocean FCL, booked", "value": { "reference": "QB48213", "status": "Active", "serviceType": "OceanFCL", "mode": "Ocean", "incoterms": "FOB", "tags": [ "PO-20931", "PO-20932" ], "descriptionOfGoods": "Stainless steel cookware", "insured": true, "bookingConfirmedByCarrier": true, "origin": { "city": "Ningbo", "state": null, "countryCode": "CN", "code": null, "fulfillmentCenter": null, "coordinates": { "lat": 29.8683, "lon": 121.544 }, "name": "Ningbo Hengda Housewares Co., Ltd.", "type": "ShippingParty" }, "portOfLoading": { "city": "Ningbo", "state": null, "countryCode": "CN", "code": "CNNGB", "fulfillmentCenter": null, "coordinates": { "lat": 29.9333, "lon": 121.85 }, "name": "Ningbo", "type": "Seaport" }, "portOfDischarge": { "city": "Felixstowe", "state": null, "countryCode": "GB", "code": "GBFXT", "fulfillmentCenter": null, "coordinates": { "lat": 51.9536, "lon": 1.3511 }, "name": "Felixstowe", "type": "Seaport" }, "destination": { "city": "Daventry", "state": null, "countryCode": "GB", "code": null, "fulfillmentCenter": null, "coordinates": { "lat": 52.2578, "lon": -1.1628 }, "name": "Brightwell Home Ltd", "type": "ShippingParty" }, "carrier": { "name": "Maersk", "type": "ShippingLine" }, "booking": { "bookingNumber": "243817265", "masterBill": null, "houseBill": null, "cargoCutoff": "2026-10-01", "shippingInstructionCutoff": "2026-09-29", "destinationPortFreeDays": 7, "emptyContainerReturnFreeDays": 10 }, "parcels": null, "amazon": null, "cargo": { "totalWeight": { "value": 31840, "unit": "KG" }, "totalVolume": { "value": 132.6, "unit": "CubicMeter" }, "chargeableWeight": null, "stackable": null, "containers": [ { "number": null, "type": "FortyFtHighCube", "sealNumber": null }, { "number": null, "type": "FortyFtHighCube", "sealNumber": null } ], "packages": [] }, "milestones": [ { "place": { "city": "Ningbo", "state": null, "countryCode": "CN", "code": null, "fulfillmentCenter": null, "coordinates": { "lat": 29.8683, "lon": 121.544 }, "name": "Ningbo Hengda Housewares Co., Ltd.", "type": "ShippingParty" }, "warehouseType": null, "cargoReadyDate": "2026-09-28", "arrival": null, "departure": { "date": "2026-09-29", "time": null, "actual": false }, "transportToNext": { "vessel": null, "voyageNumber": null, "flightNumber": null, "carrier": null, "mode": "Truck" }, "type": "Pickup", "completed": false }, { "place": { "city": "Ningbo", "state": null, "countryCode": "CN", "code": "CNNGB", "fulfillmentCenter": null, "coordinates": { "lat": 29.9333, "lon": 121.85 }, "name": "Ningbo", "type": "Seaport" }, "warehouseType": null, "cargoReadyDate": null, "arrival": { "date": "2026-09-29", "time": null, "actual": false }, "departure": { "date": "2026-10-04", "time": null, "actual": false }, "transportToNext": { "vessel": "MAERSK HERRERA", "voyageNumber": "640W", "flightNumber": null, "carrier": { "name": "Maersk", "type": "ShippingLine" }, "mode": "Voyage" }, "type": "OriginPort", "completed": false }, { "place": { "city": "Gelang Patah", "state": null, "countryCode": "MY", "code": "MYTPP", "fulfillmentCenter": null, "coordinates": { "lat": 1.3631, "lon": 103.5483 }, "name": "Tanjung Pelepas", "type": "Seaport" }, "warehouseType": null, "cargoReadyDate": null, "arrival": { "date": "2026-10-11", "time": null, "actual": false }, "departure": { "date": "2026-10-14", "time": null, "actual": false }, "transportToNext": { "vessel": null, "voyageNumber": null, "flightNumber": null, "carrier": { "name": "Maersk", "type": "ShippingLine" }, "mode": "Voyage" }, "type": "TransshipmentPort", "completed": false }, { "place": { "city": "Felixstowe", "state": null, "countryCode": "GB", "code": "GBFXT", "fulfillmentCenter": null, "coordinates": { "lat": 51.9536, "lon": 1.3511 }, "name": "Felixstowe", "type": "Seaport" }, "warehouseType": null, "cargoReadyDate": null, "arrival": { "date": "2026-11-08", "time": null, "actual": false }, "departure": null, "transportToNext": { "vessel": null, "voyageNumber": null, "flightNumber": null, "carrier": null, "mode": "Truck" }, "type": "DestinationPort", "completed": false }, { "place": { "city": "Daventry", "state": null, "countryCode": "GB", "code": null, "fulfillmentCenter": null, "coordinates": { "lat": 52.2578, "lon": -1.1628 }, "name": "Brightwell Home Ltd", "type": "ShippingParty" }, "warehouseType": null, "cargoReadyDate": null, "arrival": { "date": "2026-11-11", "time": null, "actual": false }, "departure": null, "transportToNext": null, "type": "Delivery", "completed": false } ], "currentMilestoneIndex": 0, "cancelledAt": null, "createdAt": "2026-09-08T09:31:00Z", "updatedAt": "2026-09-17T02:15:00Z" } }, "oceanLcl": { "summary": "Ocean LCL, on the water", "value": { "reference": "QB51907", "status": "Active", "serviceType": "OceanLCL", "mode": "Ocean", "incoterms": "EXW", "tags": [ "PO-5512" ], "descriptionOfGoods": "Cotton bed linen", "insured": false, "bookingConfirmedByCarrier": true, "origin": { "city": "Mumbai", "state": null, "countryCode": "IN", "code": null, "fulfillmentCenter": null, "coordinates": { "lat": 19.076, "lon": 72.8777 }, "name": "Kavya Textiles Pvt. Ltd.", "type": "ShippingParty" }, "portOfLoading": { "city": "Navi Mumbai", "state": null, "countryCode": "IN", "code": "INNSA", "fulfillmentCenter": null, "coordinates": { "lat": 18.95, "lon": 72.95 }, "name": "Nhava Sheva", "type": "Seaport" }, "portOfDischarge": { "city": "Hamburg", "state": null, "countryCode": "DE", "code": "DEHAM", "fulfillmentCenter": null, "coordinates": { "lat": 53.5078, "lon": 9.9667 }, "name": "Hamburg", "type": "Seaport" }, "destination": { "city": "Berlin", "state": null, "countryCode": "DE", "code": null, "fulfillmentCenter": null, "coordinates": { "lat": 52.52, "lon": 13.405 }, "name": "Nordlicht Wohnen GmbH", "type": "ShippingParty" }, "carrier": { "name": "Hapag-Lloyd", "type": "ShippingLine" }, "booking": { "bookingNumber": null, "masterBill": "HLCUBO1260845517", "houseBill": "BOM2608377", "cargoCutoff": "2026-09-02", "shippingInstructionCutoff": null, "destinationPortFreeDays": null, "emptyContainerReturnFreeDays": null }, "parcels": null, "amazon": null, "cargo": { "totalWeight": { "value": 1860, "unit": "KG" }, "totalVolume": { "value": 10.08, "unit": "CubicMeter" }, "chargeableWeight": null, "stackable": false, "containers": [ { "number": "HLXU8231457", "type": "FortyFtHighCube", "sealNumber": "HL4471902" } ], "packages": [ { "type": "Pallet", "quantity": 6, "hazardous": false, "weight": { "value": 310, "unit": "KG" }, "length": { "value": 120, "unit": "Centimeter" }, "width": { "value": 100, "unit": "Centimeter" }, "height": { "value": 140, "unit": "Centimeter" } } ] }, "milestones": [ { "place": { "city": "Mumbai", "state": null, "countryCode": "IN", "code": null, "fulfillmentCenter": null, "coordinates": { "lat": 19.076, "lon": 72.8777 }, "name": "Kavya Textiles Pvt. Ltd.", "type": "ShippingParty" }, "warehouseType": null, "cargoReadyDate": "2026-08-28", "arrival": null, "departure": { "date": "2026-08-31", "time": null, "actual": true }, "transportToNext": { "vessel": null, "voyageNumber": null, "flightNumber": null, "carrier": null, "mode": "Truck" }, "type": "Pickup", "completed": true }, { "place": null, "warehouseType": "CFS", "cargoReadyDate": null, "arrival": { "date": "2026-08-31", "time": null, "actual": true }, "departure": { "date": "2026-09-03", "time": null, "actual": true }, "transportToNext": { "vessel": null, "voyageNumber": null, "flightNumber": null, "carrier": null, "mode": "Truck" }, "type": "IntermediaryWarehouse", "completed": true }, { "place": { "city": "Navi Mumbai", "state": null, "countryCode": "IN", "code": "INNSA", "fulfillmentCenter": null, "coordinates": { "lat": 18.95, "lon": 72.95 }, "name": "Nhava Sheva", "type": "Seaport" }, "warehouseType": null, "cargoReadyDate": null, "arrival": { "date": "2026-09-03", "time": null, "actual": true }, "departure": { "date": "2026-09-06", "time": null, "actual": true }, "transportToNext": { "vessel": "BERLIN EXPRESS", "voyageNumber": "2635W", "flightNumber": null, "carrier": { "name": "Hapag-Lloyd", "type": "ShippingLine" }, "mode": "Voyage" }, "type": "OriginPort", "completed": true }, { "place": { "city": "Hamburg", "state": null, "countryCode": "DE", "code": "DEHAM", "fulfillmentCenter": null, "coordinates": { "lat": 53.5078, "lon": 9.9667 }, "name": "Hamburg", "type": "Seaport" }, "warehouseType": null, "cargoReadyDate": null, "arrival": { "date": "2026-09-29", "time": null, "actual": false }, "departure": null, "transportToNext": { "vessel": null, "voyageNumber": null, "flightNumber": null, "carrier": null, "mode": "Truck" }, "type": "DestinationPort", "completed": false }, { "place": null, "warehouseType": "DeconsolidationWarehouse", "cargoReadyDate": null, "arrival": { "date": "2026-10-01", "time": null, "actual": false }, "departure": null, "transportToNext": { "vessel": null, "voyageNumber": null, "flightNumber": null, "carrier": null, "mode": "Truck" }, "type": "IntermediaryWarehouse", "completed": false }, { "place": { "city": "Berlin", "state": null, "countryCode": "DE", "code": null, "fulfillmentCenter": null, "coordinates": { "lat": 52.52, "lon": 13.405 }, "name": "Nordlicht Wohnen GmbH", "type": "ShippingParty" }, "warehouseType": null, "cargoReadyDate": null, "arrival": { "date": "2026-10-05", "time": null, "actual": false }, "departure": null, "transportToNext": null, "type": "Delivery", "completed": false } ], "currentMilestoneIndex": 2, "cancelledAt": null, "createdAt": "2026-08-19T13:04:00Z", "updatedAt": "2026-09-15T21:48:00Z" } }, "oceanDdp": { "summary": "Ocean DDP to Amazon with parcels, arrived at the port of discharge", "value": { "reference": "QB10293", "status": "Active", "serviceType": "OceanDDP", "mode": "Ocean", "incoterms": "EXW", "tags": [ "PO-8841" ], "descriptionOfGoods": "Yoga mats", "insured": true, "bookingConfirmedByCarrier": true, "origin": { "city": "Shenzhen", "state": null, "countryCode": "CN", "code": null, "fulfillmentCenter": null, "coordinates": { "lat": 22.5, "lon": 114.1 }, "name": "Shenzhen Lotus Sports Goods Co., Ltd.", "type": "ShippingParty" }, "portOfLoading": { "city": "Shenzhen", "state": null, "countryCode": "CN", "code": "CNYTN", "fulfillmentCenter": null, "coordinates": { "lat": 22.5667, "lon": 114.2833 }, "name": "Yantian", "type": "Seaport" }, "portOfDischarge": { "city": "Long Beach", "state": "CA", "countryCode": "US", "code": "USLGB", "fulfillmentCenter": null, "coordinates": { "lat": 33.7542, "lon": -118.2165 }, "name": "Long Beach", "type": "Seaport" }, "destination": { "city": "Moreno Valley", "state": "CA", "countryCode": "US", "code": null, "fulfillmentCenter": "Amazon", "coordinates": { "lat": 33.9, "lon": -117.25 }, "name": "ONT8", "type": "FulfillmentCenter" }, "carrier": { "name": "COSCO", "type": "ShippingLine" }, "booking": { "bookingNumber": null, "masterBill": "COSU6412345670", "houseBill": "SZX2607001", "cargoCutoff": "2026-07-05", "shippingInstructionCutoff": null, "destinationPortFreeDays": null, "emptyContainerReturnFreeDays": null }, "parcels": { "carrier": "UPS", "trackingNumbers": [ "1Z84R2E70312345678", "1Z84R2E70312345687", "1Z84R2E70312345696" ] }, "amazon": { "fbaIds": [ "FBA18K4TQ9ZB" ], "referenceIds": [ "7KQ2M9XA" ] }, "cargo": { "totalWeight": { "value": 1082, "unit": "KG" }, "totalVolume": { "value": 6.486, "unit": "CubicMeter" }, "chargeableWeight": null, "stackable": null, "containers": [ { "number": "CSNU1234567", "type": "FortyFtHighCube", "sealNumber": "CN8812045" } ], "packages": [ { "type": "Box", "quantity": 62, "hazardous": false, "weight": { "value": 17.45, "unit": "KG" }, "length": { "value": 48, "unit": "Centimeter" }, "width": { "value": 48, "unit": "Centimeter" }, "height": { "value": 45.4, "unit": "Centimeter" } } ] }, "milestones": [ { "place": { "city": "Shenzhen", "state": null, "countryCode": "CN", "code": null, "fulfillmentCenter": null, "coordinates": { "lat": 22.5, "lon": 114.1 }, "name": "Shenzhen Lotus Sports Goods Co., Ltd.", "type": "ShippingParty" }, "warehouseType": null, "cargoReadyDate": "2026-07-03", "arrival": null, "departure": { "date": "2026-07-03", "time": null, "actual": true }, "transportToNext": { "vessel": null, "voyageNumber": null, "flightNumber": null, "carrier": null, "mode": "Truck" }, "type": "Pickup", "completed": true }, { "place": null, "warehouseType": "ConsolidationWarehouse", "cargoReadyDate": null, "arrival": { "date": "2026-07-03", "time": null, "actual": true }, "departure": { "date": "2026-07-06", "time": null, "actual": true }, "transportToNext": { "vessel": null, "voyageNumber": null, "flightNumber": null, "carrier": null, "mode": "Truck" }, "type": "IntermediaryWarehouse", "completed": true }, { "place": { "city": "Shenzhen", "state": null, "countryCode": "CN", "code": "CNYTN", "fulfillmentCenter": null, "coordinates": { "lat": 22.5667, "lon": 114.2833 }, "name": "Yantian", "type": "Seaport" }, "warehouseType": null, "cargoReadyDate": null, "arrival": { "date": "2026-07-06", "time": null, "actual": true }, "departure": { "date": "2026-07-09", "time": null, "actual": true }, "transportToNext": { "vessel": "COSCO SHIPPING ANDES", "voyageNumber": "027E", "flightNumber": null, "carrier": { "name": "COSCO", "type": "ShippingLine" }, "mode": "Voyage" }, "type": "OriginPort", "completed": true }, { "place": { "city": "Long Beach", "state": "CA", "countryCode": "US", "code": "USLGB", "fulfillmentCenter": null, "coordinates": { "lat": 33.7542, "lon": -118.2165 }, "name": "Long Beach", "type": "Seaport" }, "warehouseType": null, "cargoReadyDate": null, "arrival": { "date": "2026-07-28", "time": "08:00", "actual": true }, "departure": null, "transportToNext": { "vessel": null, "voyageNumber": null, "flightNumber": null, "carrier": null, "mode": "Truck" }, "type": "DestinationPort", "completed": true }, { "place": null, "warehouseType": "DeconsolidationWarehouse", "cargoReadyDate": null, "arrival": { "date": "2026-07-31", "time": null, "actual": false }, "departure": null, "transportToNext": { "vessel": null, "voyageNumber": null, "flightNumber": null, "carrier": null, "mode": "Truck" }, "type": "IntermediaryWarehouse", "completed": false }, { "place": { "city": "Moreno Valley", "state": "CA", "countryCode": "US", "code": null, "fulfillmentCenter": "Amazon", "coordinates": { "lat": 33.9, "lon": -117.25 }, "name": "ONT8", "type": "FulfillmentCenter" }, "warehouseType": null, "cargoReadyDate": null, "arrival": { "date": "2026-08-04", "time": null, "actual": false }, "departure": null, "transportToNext": null, "type": "Delivery", "completed": false } ], "currentMilestoneIndex": 3, "cancelledAt": null, "createdAt": "2026-06-28T10:12:00Z", "updatedAt": "2026-07-29T06:40:00Z" } }, "airFreight": { "summary": "Air freight with a transshipment, landed at the destination airport", "value": { "reference": "QB53310", "status": "Active", "serviceType": "AirFreight", "mode": "Air", "incoterms": "EXW", "tags": [ "PO-77104" ], "descriptionOfGoods": "Servo motor assemblies", "insured": true, "bookingConfirmedByCarrier": true, "origin": { "city": "Hanoi", "state": null, "countryCode": "VN", "code": null, "fulfillmentCenter": null, "coordinates": { "lat": 21.0285, "lon": 105.8542 }, "name": "Red River Precision Components JSC", "type": "ShippingParty" }, "portOfLoading": { "city": "Hanoi", "state": null, "countryCode": "VN", "code": "HAN", "fulfillmentCenter": null, "coordinates": { "lat": 21.2212, "lon": 105.8072 }, "name": "Noi Bai International Airport", "type": "Airport" }, "portOfDischarge": { "city": "Chicago", "state": "IL", "countryCode": "US", "code": "ORD", "fulfillmentCenter": null, "coordinates": { "lat": 41.9742, "lon": -87.9073 }, "name": "Chicago O'Hare International Airport", "type": "Airport" }, "destination": { "city": "Elk Grove Village", "state": "IL", "countryCode": "US", "code": null, "fulfillmentCenter": null, "coordinates": { "lat": 42.0039, "lon": -87.9703 }, "name": "Lakeshore Robotics Inc.", "type": "ShippingParty" }, "carrier": { "name": "Qatar Airways", "type": "Airline" }, "booking": { "bookingNumber": null, "masterBill": "157-48213905", "houseBill": "HAN26091187", "cargoCutoff": null, "shippingInstructionCutoff": null, "destinationPortFreeDays": null, "emptyContainerReturnFreeDays": null }, "parcels": null, "amazon": null, "cargo": { "totalWeight": { "value": 168, "unit": "KG" }, "totalVolume": { "value": 1.344, "unit": "CubicMeter" }, "chargeableWeight": { "value": 224, "unit": "KG" }, "stackable": true, "containers": [], "packages": [ { "type": "Box", "quantity": 14, "hazardous": false, "weight": { "value": 12, "unit": "KG" }, "length": { "value": 60, "unit": "Centimeter" }, "width": { "value": 40, "unit": "Centimeter" }, "height": { "value": 40, "unit": "Centimeter" } } ] }, "milestones": [ { "place": { "city": "Hanoi", "state": null, "countryCode": "VN", "code": null, "fulfillmentCenter": null, "coordinates": { "lat": 21.0285, "lon": 105.8542 }, "name": "Red River Precision Components JSC", "type": "ShippingParty" }, "warehouseType": null, "cargoReadyDate": "2026-09-14", "arrival": null, "departure": { "date": "2026-09-14", "time": null, "actual": true }, "transportToNext": { "vessel": null, "voyageNumber": null, "flightNumber": null, "carrier": null, "mode": "Truck" }, "type": "Pickup", "completed": true }, { "place": { "city": "Hanoi", "state": null, "countryCode": "VN", "code": "HAN", "fulfillmentCenter": null, "coordinates": { "lat": 21.2212, "lon": 105.8072 }, "name": "Noi Bai International Airport", "type": "Airport" }, "warehouseType": null, "cargoReadyDate": null, "arrival": { "date": "2026-09-15", "time": null, "actual": true }, "departure": { "date": "2026-09-16", "time": "23:55", "actual": true }, "transportToNext": { "vessel": null, "voyageNumber": null, "flightNumber": "QR8955", "carrier": { "name": "Qatar Airways", "type": "Airline" }, "mode": "Flight" }, "type": "OriginPort", "completed": true }, { "place": { "city": "Doha", "state": null, "countryCode": "QA", "code": "DOH", "fulfillmentCenter": null, "coordinates": { "lat": 25.2731, "lon": 51.6081 }, "name": "Hamad International Airport", "type": "Airport" }, "warehouseType": null, "cargoReadyDate": null, "arrival": { "date": "2026-09-17", "time": "04:10", "actual": true }, "departure": { "date": "2026-09-18", "time": "08:30", "actual": true }, "transportToNext": { "vessel": null, "voyageNumber": null, "flightNumber": "QR8141", "carrier": { "name": "Qatar Airways", "type": "Airline" }, "mode": "Flight" }, "type": "TransshipmentPort", "completed": true }, { "place": { "city": "Chicago", "state": "IL", "countryCode": "US", "code": "ORD", "fulfillmentCenter": null, "coordinates": { "lat": 41.9742, "lon": -87.9073 }, "name": "Chicago O'Hare International Airport", "type": "Airport" }, "warehouseType": null, "cargoReadyDate": null, "arrival": { "date": "2026-09-18", "time": "15:05", "actual": true }, "departure": null, "transportToNext": { "vessel": null, "voyageNumber": null, "flightNumber": null, "carrier": null, "mode": "Truck" }, "type": "DestinationPort", "completed": true }, { "place": { "city": "Elk Grove Village", "state": "IL", "countryCode": "US", "code": null, "fulfillmentCenter": null, "coordinates": { "lat": 42.0039, "lon": -87.9703 }, "name": "Lakeshore Robotics Inc.", "type": "ShippingParty" }, "warehouseType": null, "cargoReadyDate": null, "arrival": { "date": "2026-09-22", "time": null, "actual": false }, "departure": null, "transportToNext": null, "type": "Delivery", "completed": false } ], "currentMilestoneIndex": 3, "cancelledAt": null, "createdAt": "2026-09-09T07:22:00Z", "updatedAt": "2026-09-18T20:41:00Z" } }, "airCourier": { "summary": "Air courier, delivered", "value": { "reference": "QB54002", "status": "Delivered", "serviceType": "AirCourier", "mode": "Air", "incoterms": "EXW", "tags": [], "descriptionOfGoods": "Leather handbag samples", "insured": false, "bookingConfirmedByCarrier": true, "origin": { "city": "Istanbul", "state": null, "countryCode": "TR", "code": null, "fulfillmentCenter": null, "coordinates": { "lat": 41.0082, "lon": 28.9784 }, "name": "Anatolia Leather Workshop", "type": "ShippingParty" }, "portOfLoading": null, "portOfDischarge": null, "destination": { "city": "Tel Aviv-Yafo", "state": null, "countryCode": "IL", "code": null, "fulfillmentCenter": null, "coordinates": { "lat": 32.0853, "lon": 34.7818 }, "name": "Studio Noa Ltd.", "type": "ShippingParty" }, "carrier": { "name": "DHL", "type": "Courier" }, "booking": { "bookingNumber": null, "masterBill": null, "houseBill": null, "cargoCutoff": null, "shippingInstructionCutoff": null, "destinationPortFreeDays": null, "emptyContainerReturnFreeDays": null }, "parcels": { "carrier": "DHL", "trackingNumbers": [ "4839201754", "4839201765" ] }, "amazon": null, "cargo": { "totalWeight": { "value": 16.4, "unit": "KG" }, "totalVolume": null, "chargeableWeight": { "value": 16.5, "unit": "KG" }, "stackable": null, "containers": [], "packages": [ { "type": "Box", "quantity": 2, "hazardous": false, "weight": { "value": 8.2, "unit": "KG" }, "length": null, "width": null, "height": null } ] }, "milestones": [ { "place": { "city": "Istanbul", "state": null, "countryCode": "TR", "code": null, "fulfillmentCenter": null, "coordinates": { "lat": 41.0082, "lon": 28.9784 }, "name": "Anatolia Leather Workshop", "type": "ShippingParty" }, "warehouseType": null, "cargoReadyDate": "2026-09-07", "arrival": null, "departure": { "date": "2026-09-08", "time": null, "actual": true }, "transportToNext": { "vessel": null, "voyageNumber": null, "flightNumber": null, "carrier": { "name": "DHL", "type": "Courier" }, "mode": "Flight" }, "type": "Pickup", "completed": true }, { "place": { "city": "Tel Aviv-Yafo", "state": null, "countryCode": "IL", "code": null, "fulfillmentCenter": null, "coordinates": { "lat": 32.0853, "lon": 34.7818 }, "name": "Studio Noa Ltd.", "type": "ShippingParty" }, "warehouseType": null, "cargoReadyDate": null, "arrival": { "date": "2026-09-11", "time": "14:20", "actual": true }, "departure": null, "transportToNext": null, "type": "Delivery", "completed": true } ], "currentMilestoneIndex": 1, "cancelledAt": null, "createdAt": "2026-09-04T11:50:00Z", "updatedAt": "2026-09-11T11:26:00Z" } }, "landTruck": { "summary": "Land truck LTL with a border crossing, before pickup", "value": { "reference": "QB52764", "status": "Active", "serviceType": "LandTruckLTL", "mode": "Land", "incoterms": null, "tags": [ "PO-3307" ], "descriptionOfGoods": "Injection-moulded cooler lids", "insured": false, "bookingConfirmedByCarrier": false, "origin": { "city": "Apodaca", "state": null, "countryCode": "MX", "code": null, "fulfillmentCenter": null, "coordinates": { "lat": 25.7815, "lon": -100.1886 }, "name": "Industrias Regio Plasticos S.A. de C.V.", "type": "ShippingParty" }, "portOfLoading": null, "portOfDischarge": null, "destination": { "city": "Dallas", "state": "TX", "countryCode": "US", "code": null, "fulfillmentCenter": null, "coordinates": { "lat": 32.7767, "lon": -96.797 }, "name": "Trinity Outdoor Supply LLC", "type": "ShippingParty" }, "carrier": null, "booking": { "bookingNumber": null, "masterBill": null, "houseBill": null, "cargoCutoff": null, "shippingInstructionCutoff": null, "destinationPortFreeDays": null, "emptyContainerReturnFreeDays": null }, "parcels": null, "amazon": null, "cargo": { "totalWeight": { "value": 7600, "unit": "LB" }, "totalVolume": { "value": 533.3, "unit": "CubicFeet" }, "chargeableWeight": null, "stackable": false, "containers": [], "packages": [ { "type": "Pallet", "quantity": 8, "hazardous": false, "weight": { "value": 950, "unit": "LB" }, "length": { "value": 48, "unit": "Inch" }, "width": { "value": 40, "unit": "Inch" }, "height": { "value": 60, "unit": "Inch" } } ] }, "milestones": [ { "place": { "city": "Apodaca", "state": null, "countryCode": "MX", "code": null, "fulfillmentCenter": null, "coordinates": { "lat": 25.7815, "lon": -100.1886 }, "name": "Industrias Regio Plasticos S.A. de C.V.", "type": "ShippingParty" }, "warehouseType": null, "cargoReadyDate": "2026-09-21", "arrival": null, "departure": { "date": "2026-09-22", "time": null, "actual": false }, "transportToNext": { "vessel": null, "voyageNumber": null, "flightNumber": null, "carrier": null, "mode": "Truck" }, "type": "Pickup", "completed": false }, { "place": null, "warehouseType": null, "cargoReadyDate": null, "arrival": { "date": "2026-09-23", "time": null, "actual": false }, "departure": null, "transportToNext": { "vessel": null, "voyageNumber": null, "flightNumber": null, "carrier": null, "mode": "Truck" }, "type": "BorderCrossing", "completed": false }, { "place": { "city": "Dallas", "state": "TX", "countryCode": "US", "code": null, "fulfillmentCenter": null, "coordinates": { "lat": 32.7767, "lon": -96.797 }, "name": "Trinity Outdoor Supply LLC", "type": "ShippingParty" }, "warehouseType": null, "cargoReadyDate": null, "arrival": { "date": "2026-09-25", "time": null, "actual": false }, "departure": null, "transportToNext": null, "type": "Delivery", "completed": false } ], "currentMilestoneIndex": 0, "cancelledAt": null, "createdAt": "2026-09-15T16:08:00Z", "updatedAt": "2026-09-18T09:12:00Z" } }, "missing_api_key": { "summary": "Missing API key", "value": { "type": "https://developers.gocubic.io/errors/missing-api-key", "title": "Missing API key", "status": 401, "code": "missing_api_key", "detail": "The request has no Authorization header.", "hint": "Send 'Authorization: Bearer '. Create a key at https://app.gocubic.io/settings/api-keys." } }, "invalid_api_key": { "summary": "Invalid API key", "value": { "type": "https://developers.gocubic.io/errors/invalid-api-key", "title": "Invalid API key", "status": 401, "code": "invalid_api_key", "detail": "The key in the Authorization header is not recognised or was revoked.", "hint": "Send 'Authorization: Bearer '. Create a key at https://app.gocubic.io/settings/api-keys." } }, "shipment_not_found": { "summary": "Shipment not found", "value": { "type": "https://developers.gocubic.io/errors/shipment-not-found", "title": "Shipment not found", "status": 404, "code": "shipment_not_found", "detail": "No shipment with reference 'QB99999' exists on this account.", "hint": "Check the reference (for example 'QB10293'). To look a shipment up by PO number, container, master bill or FBA ID, call GET /v1/shipments?search=." } }, "invalid_parameter": { "summary": "Invalid parameter", "value": { "type": "https://developers.gocubic.io/errors/invalid-parameter", "title": "Invalid parameter", "status": 400, "code": "invalid_parameter", "detail": "'Shipped' is not a valid value for 'status'.", "hint": "Use one of: Active, Delivered, Cancelled. Repeat the parameter to filter by several statuses.", "parameter": "status" } }, "invalid_cursor": { "summary": "Invalid cursor", "value": { "type": "https://developers.gocubic.io/errors/invalid-cursor", "title": "Invalid cursor", "status": 400, "code": "invalid_cursor", "detail": "The cursor is malformed or was issued for a different set of filters.", "hint": "Restart pagination: repeat the request without 'cursor', then follow 'nextCursor' from each response." } }, "rate_limited": { "summary": "Rate limit exceeded", "value": { "type": "https://developers.gocubic.io/errors/rate-limited", "title": "Rate limit exceeded", "status": 429, "code": "rate_limited", "detail": "This key has made more than 60 requests in the last minute.", "hint": "Wait the number of seconds in the 'Retry-After' header, then retry the same request." } }, "internal_error": { "summary": "Internal error", "value": { "type": "https://developers.gocubic.io/errors/internal-error", "title": "Internal error", "status": 500, "code": "internal_error", "detail": "An unexpected error occurred while handling the request.", "hint": "Retry with exponential backoff. The request itself is not the problem." } } }, "schemas": { "Me": { "type": "object", "description": "The account and API key behind the request.", "required": [ "account", "apiKey" ], "properties": { "account": { "type": "object", "description": "The customer account the key belongs to. Every response is scoped to this account.", "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Account (company) name." } } }, "apiKey": { "type": "object", "description": "The API key used for this request.", "required": [ "name", "prefix", "createdAt" ], "properties": { "name": { "type": "string", "description": "The label given to the key when it was created." }, "prefix": { "type": "string", "description": "The leading characters of the key, starting with `cubic_live_`. Safe to log; identifies which key is in use without revealing it." }, "createdAt": { "type": "string", "format": "date-time", "description": "When the key was created. ISO 8601, UTC." } } } } }, "ShipmentList": { "type": "object", "description": "One page of shipments.", "required": [ "data", "nextCursor" ], "properties": { "data": { "type": "array", "description": "Shipments on this page, most recently updated first. Each item is the full Shipment object, identical to the detail endpoint. May be empty.", "items": { "$ref": "#/components/schemas/Shipment" } }, "nextCursor": { "type": [ "string", "null" ], "description": "Opaque cursor for the next page. Pass it back unchanged as `cursor` together with the same filters. `null` means this is the last page." } } }, "Shipment": { "type": "object", "description": "A shipment. Every key listed here is always present; a value that is not known yet is `null` and a list with nothing in it is `[]`. `null` means \"not known yet\" or \"does not apply to this shipment\"; it is never an error. A value that is not known yet can appear on a later read.", "required": [ "reference", "status", "serviceType", "mode", "incoterms", "tags", "descriptionOfGoods", "insured", "bookingConfirmedByCarrier", "origin", "portOfLoading", "portOfDischarge", "destination", "carrier", "booking", "parcels", "amazon", "cargo", "milestones", "currentMilestoneIndex", "cancelledAt", "createdAt", "updatedAt" ], "properties": { "reference": { "type": "string", "description": "Cubic reference. Unique, stable, and the identifier used in `GET /shipments/{reference}`.", "examples": [ "QB10293" ] }, "status": { "$ref": "#/components/schemas/ShipmentStatus" }, "serviceType": { "$ref": "#/components/schemas/ServiceType" }, "mode": { "type": "string", "enum": [ "Ocean", "Air", "Land" ], "description": "Transport mode of the main leg, implied by `serviceType`." }, "incoterms": { "type": [ "string", "null" ], "enum": [ "FOB", "EXW", null ], "description": "Who arranges the origin pickup. `EXW`: Cubic collects the cargo from the supplier. `FOB`: the supplier delivers the cargo to the port of loading. It says nothing about duties or door delivery, and it coexists with a DDP/DDU `serviceType`. `null` when not recorded." }, "tags": { "type": "array", "description": "The customer's own tags on the shipment — in practice purchase order numbers. Filter on one with the `tag` query parameter. Empty when none.", "items": { "type": "string" }, "examples": [ [ "PO-8841" ] ] }, "descriptionOfGoods": { "type": [ "string", "null" ], "description": "Free-text description of the goods." }, "insured": { "type": "boolean", "description": "Whether the shipment is insured." }, "bookingConfirmedByCarrier": { "type": "boolean", "description": "Whether the carrier has confirmed the booking." }, "origin": { "description": "Where the cargo is collected.", "oneOf": [ { "$ref": "#/components/schemas/Place" }, { "type": "null" } ] }, "portOfLoading": { "description": "Port of loading: the seaport or airport where the main leg starts. `null` when the route has no port (for example land shipments, or courier shipments that list only pickup and delivery).", "oneOf": [ { "$ref": "#/components/schemas/Place" }, { "type": "null" } ] }, "portOfDischarge": { "description": "Port of discharge: the seaport or airport where the main leg ends. Some routes have no `DestinationPort` milestone; then this is the `Delivery` milestone's place if that is a port (door-to-port shipments), otherwise `null`. Never assume it is set.", "oneOf": [ { "$ref": "#/components/schemas/Place" }, { "type": "null" } ] }, "destination": { "description": "Where the cargo is delivered. May itself be a port (door-to-port), an Amazon fulfilment centre, or an address.", "oneOf": [ { "$ref": "#/components/schemas/Place" }, { "type": "null" } ] }, "carrier": { "description": "The main carrier: the shipping line for ocean, the airline for air, the courier company for `AirCourier`. Always `null` for land shipments, and `null` on other shipments until known. Individual legs carry their own `carrier` in `milestones[].transportToNext`.", "oneOf": [ { "$ref": "#/components/schemas/Carrier" }, { "type": "null" } ] }, "booking": { "$ref": "#/components/schemas/Booking" }, "parcels": { "description": "Last-mile parcel tracking. `null` when there is none. Present on courier shipments and on many DDP/DDU shipments.", "oneOf": [ { "$ref": "#/components/schemas/Parcels" }, { "type": "null" } ] }, "amazon": { "description": "Amazon inbound identifiers. `null` when there are none.", "oneOf": [ { "$ref": "#/components/schemas/Amazon" }, { "type": "null" } ] }, "cargo": { "$ref": "#/components/schemas/Cargo" }, "milestones": { "type": "array", "description": "The route, in order, from `Pickup` to `Delivery`. The milestone types present vary by shipment: never look a milestone up by index, and never assume a given type exists (some routes have no `DestinationPort`, courier shipments may have only `Pickup` and `Delivery`).", "items": { "$ref": "#/components/schemas/Milestone" } }, "currentMilestoneIndex": { "type": "integer", "minimum": 0, "description": "Index in `milestones` of the last milestone with `completed: true` — where the shipment is, or the milestone it last left. `0` when no milestone is completed yet. The shipment is on its way to the next milestone once this one has an actual `departure`." }, "cancelledAt": { "type": [ "string", "null" ], "format": "date-time", "description": "When the shipment was cancelled. ISO 8601, UTC. `null` unless cancelled." }, "createdAt": { "type": "string", "format": "date-time", "description": "When the shipment was created. ISO 8601, UTC." }, "updatedAt": { "type": "string", "format": "date-time", "description": "When anything on the shipment last changed. ISO 8601, UTC. The list is sorted by this, newest first; store the greatest value seen and pass it as `updatedSince` to poll for changes." } } }, "ShipmentStatus": { "type": "string", "enum": [ "Active", "Delivered", "Cancelled" ], "description": "Derived status; the first matching rule wins. `Cancelled`: `cancelledAt` is set. `Delivered`: the `Delivery` milestone has an actual arrival. `Active`: everything else. For where an active shipment is, read `currentMilestoneIndex` and `milestones`." }, "ServiceType": { "type": "string", "enum": [ "OceanFCL", "OceanFCLExpress", "OceanLCL", "OceanLCLExpress", "OceanDDU", "OceanDDP", "AirFreight", "AirCourier", "AirDDU", "AirDDP", "LandTruckFTL", "LandTruckLTL", "LandRailFCL", "LandRailLCL", "LandTruck" ], "description": "The service booked. `Express` variants have the same shape as their base type. `DDP`/`DDU` are door-to-door services with duties paid/unpaid. `LandTruck` is a legacy value found only on historical shipments; new land shipments use `LandTruckFTL` or `LandTruckLTL`." }, "Place": { "type": "object", "description": "A location. Only `type` is guaranteed; every other member may be `null`. `null` means \"not known yet\" or \"does not apply to this shipment\"; it is never an error. A value that is not known yet can appear on a later read.", "required": [ "name", "type", "city", "state", "countryCode", "code", "fulfillmentCenter", "coordinates" ], "properties": { "name": { "type": [ "string", "null" ], "description": "Display name: the company or site name for a `ShippingParty`, the port or airport name for ports, the fulfilment centre code (for example `ONT8`) for a `FulfillmentCenter`." }, "type": { "type": "string", "enum": [ "ShippingParty", "FulfillmentCenter", "Seaport", "Airport", "InlandTerminal", "ManualAddress" ], "description": "Kind of place. `ShippingParty` is a supplier, consignee or warehouse address; `ManualAddress` is a free-typed address." }, "city": { "type": [ "string", "null" ], "description": "City." }, "state": { "type": [ "string", "null" ], "description": "State, province or region, where the country uses one." }, "countryCode": { "type": [ "string", "null" ], "description": "ISO 3166-1 alpha-2 country code.", "examples": [ "CN" ] }, "code": { "type": [ "string", "null" ], "description": "UN/LOCODE for a `Seaport` or `InlandTerminal` (for example `USLGB`), IATA code for an `Airport` (for example `ORD`). `null` for every other type." }, "fulfillmentCenter": { "type": [ "string", "null" ], "description": "The fulfilment network the place belongs to (for example `Amazon`) when `type` is `FulfillmentCenter`; otherwise `null`.", "examples": [ "Amazon" ] }, "coordinates": { "description": "Where the place is on the map, or `null` when not known.", "oneOf": [ { "$ref": "#/components/schemas/Coordinates" }, { "type": "null" } ] } } }, "Coordinates": { "type": "object", "description": "WGS 84 coordinates in decimal degrees.", "required": [ "lat", "lon" ], "properties": { "lat": { "type": "number", "description": "Latitude.", "minimum": -90, "maximum": 90 }, "lon": { "type": "number", "description": "Longitude.", "minimum": -180, "maximum": 180 } } }, "Carrier": { "type": "object", "description": "A carrier.", "required": [ "name", "type" ], "properties": { "name": { "type": "string", "description": "Carrier name.", "examples": [ "COSCO" ] }, "type": { "type": "string", "enum": [ "ShippingLine", "Airline", "Courier" ], "description": "Kind of carrier." } } }, "Booking": { "type": "object", "description": "Booking and bill-of-lading details. The object is always present; land and courier shipments usually have every member `null`. `null` means \"not known yet\" or \"does not apply to this shipment\"; it is never an error. A value that is not known yet can appear on a later read.", "required": [ "bookingNumber", "masterBill", "houseBill", "cargoCutoff", "shippingInstructionCutoff", "destinationPortFreeDays", "emptyContainerReturnFreeDays" ], "properties": { "bookingNumber": { "type": [ "string", "null" ], "description": "The carrier's booking number. Often `null` even on ocean shipments." }, "masterBill": { "type": [ "string", "null" ], "description": "Master bill number: the ocean master bill of lading (MBL) or the air master air waybill (MAWB). Searchable with `search`.", "examples": [ "COSU6412345670" ] }, "houseBill": { "type": [ "string", "null" ], "description": "House bill number: the ocean house bill of lading (HBL) or the air house air waybill (HAWB).", "examples": [ "SZX2607001" ] }, "cargoCutoff": { "type": [ "string", "null" ], "description": "Latest date the cargo can be delivered to the port or terminal for the booked departure. Local calendar date at the place it refers to, `yyyy-MM-dd`. It has no time zone; do not convert it.", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "examples": [ "2026-07-05" ] }, "shippingInstructionCutoff": { "type": [ "string", "null" ], "description": "Latest date the shipping instructions can be submitted to the carrier. Local calendar date at the place it refers to, `yyyy-MM-dd`. It has no time zone; do not convert it.", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "examples": [ "2026-07-05" ] }, "destinationPortFreeDays": { "type": [ "integer", "null" ], "minimum": 0, "description": "Free days at the port of discharge before storage/demurrage charges start." }, "emptyContainerReturnFreeDays": { "type": [ "integer", "null" ], "minimum": 0, "description": "Free days to return the empty container before detention charges start." } } }, "Parcels": { "type": "object", "description": "Last-mile parcel tracking. Appears on courier shipments and on many DDP/DDU shipments, where it can hold dozens of tracking numbers.", "required": [ "carrier", "trackingNumbers" ], "properties": { "carrier": { "type": [ "string", "null" ], "description": "The parcel carrier. Known values: `UPS`, `FedEx`, `DHL`, `TNT`, `DPD_UK`, `DPD_DE`. This is an open set — new values can appear without notice, so do not reject unknown ones.", "examples": [ "UPS", "FedEx", "DHL", "TNT", "DPD_UK", "DPD_DE" ] }, "trackingNumbers": { "type": "array", "description": "The parcel carrier's tracking numbers.", "items": { "type": "string" } } } }, "Amazon": { "type": "object", "description": "Amazon inbound identifiers. Both lists are searchable with `search`.", "required": [ "fbaIds", "referenceIds" ], "properties": { "fbaIds": { "type": "array", "description": "Amazon FBA shipment IDs.", "items": { "type": "string" }, "examples": [ [ "FBA18K4TQ9ZB" ] ] }, "referenceIds": { "type": "array", "description": "Amazon reference IDs.", "items": { "type": "string" }, "examples": [ [ "7KQ2M9XA" ] ] } } }, "Weight": { "type": "object", "description": "A weight in the unit it was recorded in. Units are passed through, not normalised: always read `unit`.", "required": [ "value", "unit" ], "properties": { "value": { "type": "number", "description": "Magnitude, in `unit`." }, "unit": { "type": "string", "enum": [ "KG", "LB" ], "description": "Kilograms or pounds." } } }, "Length": { "type": "object", "description": "A length in the unit it was recorded in. Units are passed through, not normalised: always read `unit`.", "required": [ "value", "unit" ], "properties": { "value": { "type": "number", "description": "Magnitude, in `unit`." }, "unit": { "type": "string", "enum": [ "Centimeter", "Inch", "Millimeter", "Meter" ], "description": "Unit of `value`." } } }, "Volume": { "type": "object", "description": "A volume in the unit it was recorded in. Units are passed through, not normalised: always read `unit`.", "required": [ "value", "unit" ], "properties": { "value": { "type": "number", "description": "Magnitude, in `unit`." }, "unit": { "type": "string", "enum": [ "CubicMeter", "CubicFeet" ], "description": "Cubic metres or cubic feet." } } }, "Cargo": { "type": "object", "description": "What is being shipped. The object is always present. Units vary between shipments and even between members of one shipment; convert yourself if you need a single unit.", "required": [ "totalWeight", "totalVolume", "chargeableWeight", "stackable", "containers", "packages" ], "properties": { "totalWeight": { "description": "Total gross weight of the shipment.", "oneOf": [ { "$ref": "#/components/schemas/Weight" }, { "type": "null" } ] }, "totalVolume": { "description": "Total volume of the shipment.", "oneOf": [ { "$ref": "#/components/schemas/Volume" }, { "type": "null" } ] }, "chargeableWeight": { "description": "Chargeable weight. Air and courier shipments only; always `null` for ocean and land.", "oneOf": [ { "$ref": "#/components/schemas/Weight" }, { "type": "null" } ] }, "stackable": { "type": [ "boolean", "null" ], "description": "Whether the cargo can be stacked. `null` when not recorded." }, "containers": { "type": "array", "description": "Ocean (and rail) containers. Empty for air, courier and truck shipments. On FCL shipments these are the customer's own containers. On LCL, DDP and DDU shipments the container is a shared consolidation container: its number is useful for tracking the vessel leg, but the box and its other contents do not belong to the customer — do not count it as \"their container\".", "items": { "$ref": "#/components/schemas/Container" } }, "packages": { "type": "array", "description": "Package lines. Each line is `quantity` identical packages. May be empty, notably on FCL shipments.", "items": { "$ref": "#/components/schemas/Package" } } } }, "Container": { "type": "object", "description": "A container. `null` means \"not known yet\" or \"does not apply to this shipment\"; it is never an error. A value that is not known yet can appear on a later read.", "required": [ "number", "type", "sealNumber" ], "properties": { "number": { "type": [ "string", "null" ], "description": "Container number (ISO 6346). `null` until a container is assigned, which can be well after booking. Searchable with `search`.", "examples": [ "CSNU1234567" ] }, "type": { "type": [ "string", "null" ], "enum": [ "TwentyFt", "FortyFt", "FortyFtHighCube", "FortyFtTempControl", "FortyFiveFtHighCube", null ], "description": "Container size and kind." }, "sealNumber": { "type": [ "string", "null" ], "description": "Seal number." } } }, "Package": { "type": "object", "description": "A line of identical packages. `weight`, `length`, `width` and `height` describe ONE package, not the line; multiply by `quantity` for the line total. Courier shipments often carry weight only.", "required": [ "type", "quantity", "hazardous", "weight", "length", "width", "height" ], "properties": { "type": { "type": [ "string", "null" ], "enum": [ "Pallet", "Box", null ], "description": "Kind of package." }, "quantity": { "type": [ "integer", "null" ], "minimum": 1, "description": "Number of identical packages on this line." }, "hazardous": { "type": [ "boolean", "null" ], "description": "Whether the packages contain hazardous goods." }, "weight": { "description": "Weight of one package.", "oneOf": [ { "$ref": "#/components/schemas/Weight" }, { "type": "null" } ] }, "length": { "description": "Length of one package.", "oneOf": [ { "$ref": "#/components/schemas/Length" }, { "type": "null" } ] }, "width": { "description": "Width of one package.", "oneOf": [ { "$ref": "#/components/schemas/Length" }, { "type": "null" } ] }, "height": { "description": "Height of one package.", "oneOf": [ { "$ref": "#/components/schemas/Length" }, { "type": "null" } ] } } }, "MilestoneDate": { "type": "object", "description": "An arrival or departure. `date` and `time` are local to the place of the milestone — they carry no time zone and must not be shifted to UTC.", "required": [ "date", "time", "actual" ], "properties": { "date": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "description": "Local calendar date, `yyyy-MM-dd`.", "examples": [ "2026-07-28" ] }, "time": { "type": [ "string", "null" ], "description": "Local time, 24-hour `HH:mm`. `null` when only the date is known.", "pattern": "^\\d{2}:\\d{2}$", "examples": [ "08:00" ] }, "actual": { "type": "boolean", "description": "`true`: it happened on this date. `false`: this is an estimate (ETA/ETD) and can change on any later read." } } }, "TransportToNext": { "type": "object", "description": "The leg that leaves a milestone and ends at the next milestone in the list. `null` means \"not known yet\" or \"does not apply to this shipment\"; it is never an error. A value that is not known yet can appear on a later read.", "required": [ "mode", "vessel", "voyageNumber", "flightNumber", "carrier" ], "properties": { "mode": { "type": [ "string", "null" ], "enum": [ "Truck", "Voyage", "Flight", "Rail", null ], "description": "How the cargo moves on this leg. `Voyage` is a sea leg." }, "vessel": { "type": [ "string", "null" ], "description": "Vessel name. `Voyage` legs only.", "examples": [ "COSCO SHIPPING ANDES" ] }, "voyageNumber": { "type": [ "string", "null" ], "description": "Voyage number. `Voyage` legs only.", "examples": [ "027E" ] }, "flightNumber": { "type": [ "string", "null" ], "description": "Flight number. `Flight` legs only; each flight leg of a transshipped air route has its own.", "examples": [ "QR8955" ] }, "carrier": { "description": "The carrier operating this leg. Can differ from the shipment's main `carrier`, for example on an air route flown by two airlines.", "oneOf": [ { "$ref": "#/components/schemas/Carrier" }, { "type": "null" } ] } } }, "Milestone": { "type": "object", "description": "One point on the route. Every milestone has the same keys. `null` means \"not known yet\" or \"does not apply to this shipment\"; it is never an error. A value that is not known yet can appear on a later read.", "required": [ "type", "place", "warehouseType", "cargoReadyDate", "arrival", "departure", "completed", "transportToNext" ], "properties": { "type": { "type": "string", "enum": [ "Pickup", "OriginPort", "TransshipmentPort", "DestinationPort", "InlandTerminal", "BorderCrossing", "IntermediaryWarehouse", "Delivery" ], "description": "Role of the milestone. For air shipments `OriginPort`, `TransshipmentPort` and `DestinationPort` are airports. A `Delivery` milestone's place may itself be a port (door-to-port)." }, "place": { "description": "Where the milestone is. Always `null` for `IntermediaryWarehouse` and `BorderCrossing` milestones — only their type is given.", "oneOf": [ { "$ref": "#/components/schemas/Place" }, { "type": "null" } ] }, "warehouseType": { "type": [ "string", "null" ], "enum": [ "CFS", "ConsolidationWarehouse", "DeconsolidationWarehouse", null ], "description": "Kind of warehouse, on `IntermediaryWarehouse` milestones. `CFS` is a container freight station. `null` on every other milestone type." }, "cargoReadyDate": { "type": [ "string", "null" ], "description": "When the supplier has the cargo ready for collection. Set on the `Pickup` milestone only. Local calendar date at the place it refers to, `yyyy-MM-dd`. It has no time zone; do not convert it.", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "examples": [ "2026-07-05" ] }, "arrival": { "description": "Arrival at this milestone. `null` on the `Pickup` milestone and whenever no date is known.", "oneOf": [ { "$ref": "#/components/schemas/MilestoneDate" }, { "type": "null" } ] }, "departure": { "description": "Departure from this milestone. `null` on the `Delivery` milestone and whenever no date is known.", "oneOf": [ { "$ref": "#/components/schemas/MilestoneDate" }, { "type": "null" } ] }, "completed": { "type": "boolean", "description": "Whether the shipment has reached this milestone: picked up for `Pickup`, arrived for every other type." }, "transportToNext": { "description": "The leg leaving this milestone. `null` on the last milestone.", "oneOf": [ { "$ref": "#/components/schemas/TransportToNext" }, { "type": "null" } ] } } }, "Problem": { "type": "object", "description": "RFC 9457 problem details, served as `application/problem+json`. Branch on `code`; follow `hint` to fix the request.", "required": [ "type", "title", "status", "code", "detail", "hint" ], "properties": { "type": { "type": "string", "format": "uri", "description": "URI of the documentation for this error." }, "title": { "type": "string", "description": "Short, stable summary of the error." }, "status": { "type": "integer", "description": "The HTTP status code, repeated." }, "code": { "type": "string", "enum": [ "missing_api_key", "invalid_api_key", "shipment_not_found", "invalid_parameter", "invalid_cursor", "rate_limited", "internal_error" ], "description": "Machine-readable error code. Stable; branch on this." }, "detail": { "type": "string", "description": "What went wrong with this particular request." }, "hint": { "type": "string", "description": "How to fix the request. Written to be followed by an AI agent." }, "parameter": { "type": "string", "description": "The offending query parameter. Present only when `code` is `invalid_parameter`." } } } } } }