April 2023 - Release Notes

Modified on Tue, 25 Jul 2023 at 10:09 AM

Overview

This API release introduces several updates to improve the overall functionality and user experience. The following changes will be implemented:

  1. Overview of replacement of deprecated fields to new fields (for fields that were deprecated prior to May 2023, please refer to this article)

  2. Summary of new fields and the object impacted

  3. Impact on existing fields due to these changes


Please review the detailed information below to understand the changes and how they may affect your implementation. Do note that no old fields were removed as part of this release; they will not receive further updates or support.


Our API documentation can be access here



Live Fields Deprecation (starting May 2023)

As part of our ongoing effort to maintain a clean and efficient API, we are deprecating the following live fields:

Under bill_of_lading object

  • pol_scheduled_arrival_lt: no longer supported; use pol_scheduled_arrival_lt_from_schedule instead for the latest scheduled ETA at POL (captured from the carrier’s sailing schedule).

  • pol_actual_arrival_lt: no longer supported; use pol_actual_arrival_lt_from_ais instead (captured from the satellite AIS).

  • pod_actual_departure_lt: no longer supported; use pod_actual_departure_lt_from_ais instead for the actual time of departure from POD (captured from satellite AIS).

  • pod_scheduled_departure_lt: no longer supported; use pod_scheduled_departure_lt_from_schedule for the latest scheduled departure time from POD (captured from the carrier’s sailing schedule).

sailing_info_tracking

  • pol_actual_departure: no longer supported; use pol_actual_departure_lt_from_ais instead (captured from satellite AIS).

  • pol_actual_arrival_lt: no longer supported; use pol_actual_arrival_lt_from_ais instead (captured from the satellite AIS).

  • pod_actual_departure_lt: no longer supported; use pod_actual_departure_lt_from_ais instead (captured from the satellite AIS).

  • pol_scheduled_arrival_lt: no longer supported; use pol_scheduled_arrival_lt_from_schedule instead (captured from the carrier’s sailing schedule).

  • pod_scheduled_departure_lt: no longer supported; use pod_scheduled_departure_lt_from_schedule instead (captured from the carrier’s sailing schedule)

Please note that no fields are being removed entirely. The deprecated fields will continue functioning but will not receive further updates or support. We recommend transitioning to the new fields introduced in this release.



New Fields Added (starting May 2023)

We are introducing the following new fields to enhance the API's functionality and provide additional data points.

bill_of_lading

  • pol_scheduled_arrival_lt_from_schedule

  • pol_actual_arrival_lt_from_ais

  • pol_scheduled_departure_lt_from_schedule

  • pol_actual_departure_lt_from_ais

  • pod_scheduled_arrival_lt_from_schedule

  • pod_actual_arrival_lt_from_ais

  • pod_scheduled_departure_lt_from_schedule

  • pod_actual_departure_lt_from_ais


Do note that unless explicitly stated, the source of the event under the bill_of_lading object is the carrier/shipping line.


container_event_list

  • vessel_name

  • vessel_imo

sailing_info

  • pol_scheduled_arrival_lt_from_schedule

  • pol_actual_arrival_lt_from_ais

  • pol_scheduled_departure_lt_from_schedule

  • pol_actual_departure_lt_from_ais

  • pod_scheduled_arrival_lt_from_schedule

  • pod_actual_arrival_lt_from_ais

  • pod_scheduled_departure_lt_from_schedule

  • pod_actual_departure_lt_from_ais


These new fields are designed to serve the needs of our users better and provide more accurate and comprehensive data.



Impact on Existing Fields

The addition of new fields will have the following impact on existing fields:

  1. ATA source changes: Due to the source multiplicity, the ATA date stamps will now contain the source of data (that is either AIS or schedule).

  2. Carrier Container Events / Milestones: where the data source is not specified, Portcast uses carrier container tracking as the source, i.e. pod_actual_departure_lt field comes from the carrier container tracking page. Contrast this with pod_actual_arrival_lt_from_ais which is instead captured from a third-party satellite AIS vendor.


Note: we recommend you utilise satellite AIS as the confirmation of the vessel arrival instead of the carrier container tracking. For more information regarding the ATA accuracy, don't hesitate to contact us via support@portcast.io.



Conclusion

Please review these changes and plan for any necessary adjustments in your implementation. We believe these updates will improve the overall API experience and better serve the needs of our users to contextualise the multiplicity of data sources available via Portcast. Should you have any questions or concerns, please do not hesitate to contact our support team. We appreciate your understanding and cooperation as we continue to enhance our API offerings.


https://portcast.stoplight.io/

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select atleast one of the reasons

Feedback sent

We appreciate your effort and will try to fix the article