The /references endpoint has been updated to allow for filtering by multiple criteria, including inactive references using query parameters. This is a non-breaking change
Permitted Filter Conditions
Key
Description
container_id
Filter results based on a specific container ID
bill_of_lading
Filter results based on a specific Bill of Lading
booking_number
Filter results based on a specific Booking Number
carrier_code
Filter results based on a specific Carrier
active
Filter results based on whether the reference is active or inactive
created_start
Filter results based on when it was created
created_end
Filter results based on when it was created
last_update_status
Filter results based on a reference's last_update_status
Examples:
To show all active references whose last update status is extraction_failed:
Terminal Events: Capture additional terminal-sourced milestones that occur while the container is not at the terminal facility (e.g., Customs release or Freight hold)
Track by Booking & MBL: Continuously check for newly added containers until the vessel departs from the origin port
Vessel Reporting: Report robust vessel details when no vessel name is provided
Rail Location Reporting: Represent that a location's unlocode is UNMAPPABLE instead of null if the location is not in the UNECE database
Bugs squashed
CMA: Fix bug where a milestone's standardized description and mode are incongruent
Maersk: Bug fix for some cases of location objects not populating
HMM: Fix when some containers would not return container_iso despite being available in raw data
Standardizations
CMA: Implement additional hold, gate in and gate out standardizations
Hyundai Merchant Marine: Implement additional discharge and hold standardizations
Yang-Ming: Implement additional standardizations for gate out, load, and discharge milestones