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
| 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 |
To show all active references whose last update status is extraction_failed:
{{baseUrl}}/references?last_update_status=extraction_failed
To show all inactive references under the Bill of Lading 12345678:
{{baseUrl}}/references?active=false&bill_of_lading=12345678
To show all active PIL references created between January 1, 2024 and January 15, 2024:
{{baseUrl}}/references?carrier_code=PCIU&created_start=2024-01-01&created_end=2024-01-15
terminal-sourced milestones that occur while the container is not at the terminal facility (e.g., Customs release or Freight hold)unlocode is UNMAPPABLE instead of null if the location is not in the UNECE databasedescription and mode are incongruentcontainer_iso despite being available in raw data| UN/Locode | Terminal Name | SMDG Code |
|---|---|---|
| USCHS | North Charleston Terminal | NCMT |
| USCHS | Wando Welch Terminal (WWT) | WWMT |
| USCHS | Hugh K. Leatherman Terminal | HLT |
Please contact support if you are interested in taking advantage of this Pro plan offering.
| UN/Locode | Terminal Name | SMDG Code |
|---|---|---|
| USCHS | North Charleston Terminal | NCMT |
| USCHS | Wando Welch Terminal (WWT) | WWMT |
| USCHS | Hugh K. Leatherman Terminal | HLT |
Please contact support if you are interested in taking advantage of this Pro plan offering.