This article describes the beta functionality of the Track by Booking Number endpoint of the Vizion API
What is the Track by Booking Number endpoint?
The Track by Booking Number endpoint creates a container reference for update tracking using a provided booking number as the primary identifier.
Similar to the Track by Bill of Lading endpoint, this will create a parent reference. For every container available under the provided booking number, a child reference will be created to track each individual container.
This feature is in beta testing. For access, please contact support@vizionapi.com.
How do I track by booking number?
To track by the booking number, Support can assist in getting the feature enabled for you.
Once enabled, you will need to POST the following required inputs to the API:
- booking_number: The corresponding booking number issued by a Carrier
- carrier_code: Corresponds to the steamship line that is transporting the bill of lading based on Vizion's carrier codes
Optionally, you can also pass the following:
- callback_url: Enables POSTing of Update Payloads via webhook
- container_id: The container tracking ID. If included, only a container reference will be created to track the provided container restricted by information as it pertains to the specific booking number
For more information, please see the API documentation on tracking by the booking number here.
Frequently Asked Questions
Can I pass a bill of lading number and a booking number together to the Vizion API to create a tracking reference?
No. You cannot provide both a booking_number and bill_of_lading in the request body. In this case, the system will reject your request with a validation message indicating that only a booking_number or bill_of_lading can be provided.
Which carriers are supported when using the Track by Booking endpoint?
At this time, the following carriers are supported:
- CMA
- Evergreen
- Maersk
- MSC
- Ocean Network Express