account_usage_get
ChatGPTUsage and remaining shipments of the account per product in the current billing period: used, remaining and limit, the spend of this API key against its own limit, and the rate limit. A shipment number is counted once per period however often it is tracked. Use it when the user asks how many shipments are left or before tracking a long list of new numbers. Do not tell the user when a used up allowance renews: that depends on when the account is paid. Free. Needs the Account scope on the API key.
air_carriers_list
ChatGPTThe supported airlines with the three-digit air waybill prefix each one issues, their IATA code and operational status. Not needed before tracking: the carrier is detected from the number. Pass search to get only the matching entries, the full list is long. Free.
air_tracking_batch_get
ChatGPTTracking information for up to 20 air shipments in one call, by air waybill numbers: status, route, flights and events of each. The answer lists every number with its shipment, or with an error or PROCESSING message of its own. For one number use container_tracking_get or air_tracking_get. When the user asks about more than one number at once, track them all in one call of container_tracking_batch_get or air_tracking_batch_get (up to 20 numbers per call): the chat then shows one card with a switch between the numbers. Every number is tracked with its full route, however many are asked about. The result is the record the carrier reports: status, route, every event with its date and place, vessels or flights, containers or cargo. It is meant to be shown to the user in full. An empty field or a missing event means the carrier has not reported it yet. A new number can take a few minutes. The tool waits for the carrier on its own. A PROCESSING result means the lookup is still running: tell the user when to ask again and do not call the tool again right away. An error result carries a message written for the user.
air_tracking_get
ChatGPTTracking information for an air shipment by air waybill number: status, route, flights and events. For one number use container_tracking_get or air_tracking_get. When the user asks about more than one number at once, track them all in one call of container_tracking_batch_get or air_tracking_batch_get (up to 20 numbers per call): the chat then shows one card with a switch between the numbers. Every number is tracked with its full route, however many are asked about. The result is the record the carrier reports: status, route, every event with its date and place, vessels or flights, containers or cargo. It is meant to be shown to the user in full. An empty field or a missing event means the carrier has not reported it yet. A new number can take a few minutes. The tool waits for the carrier on its own. A PROCESSING result means the lookup is still running: tell the user when to ask again and do not call the tool again right away. An error result carries a message written for the user.
container_tracking_batch_get
ChatGPTTracking information for up to 20 ocean shipments in one call, by container, bill of lading or booking numbers: status, route, events and vessels of each. The answer lists every number with its shipment, or with an error or PROCESSING message of its own. For one number use container_tracking_get or air_tracking_get. When the user asks about more than one number at once, track them all in one call of container_tracking_batch_get or air_tracking_batch_get (up to 20 numbers per call): the chat then shows one card with a switch between the numbers. Every number is tracked with its full route, however many are asked about. The result is the record the carrier reports: status, route, every event with its date and place, vessels or flights, containers or cargo. It is meant to be shown to the user in full. An empty field or a missing event means the carrier has not reported it yet. A new number can take a few minutes. The tool waits for the carrier on its own. A PROCESSING result means the lookup is still running: tell the user when to ask again and do not call the tool again right away. An error result carries a message written for the user.
container_tracking_get
ChatGPTTracking information for an ocean shipment by container number, bill of lading number or booking number: status, route, events and vessels. For one number use container_tracking_get or air_tracking_get. When the user asks about more than one number at once, track them all in one call of container_tracking_batch_get or air_tracking_batch_get (up to 20 numbers per call): the chat then shows one card with a switch between the numbers. Every number is tracked with its full route, however many are asked about. The result is the record the carrier reports: status, route, every event with its date and place, vessels or flights, containers or cargo. It is meant to be shown to the user in full. An empty field or a missing event means the carrier has not reported it yet. A new number can take a few minutes. The tool waits for the carrier on its own. A PROCESSING result means the lookup is still running: tell the user when to ask again and do not call the tool again right away. An error result carries a message written for the user.
ocean_carriers_list
ChatGPTThe supported ocean carriers with their carrier codes (typically the SCAC), operational status and the kinds of number each one tracks by: container, bill of lading, booking, or a bill of lading or booking together with a container number. Not needed before tracking: the carrier is detected from the number. Pass search to get only the matching entries, the full list is long. Free.