-
Notifications
You must be signed in to change notification settings - Fork 16
EBL 3.0: SD-2934: Update What's New for eBL v3.0.3 #618
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
HenrikHL
wants to merge
1
commit into
master
Choose a base branch
from
SD-2934_ebl-whats-new
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -4,12 +4,64 @@ The DCSA Bill of Lading API is specified on [**SwaggerHub**](https://app.swagger | |||||
|
|
||||||
| Publications related to the Bill of Lading API: | ||||||
| - [Glossary of Terms](https://knowledge.dcsa.org/s/glossary) maintained on the [dcsa.org](https://dcsa.org) website | ||||||
| - [Bill of Lading](https://dcsa.org/standards/ebill-of-lading/) maintained on the [dcsa.org](https://dcsa.org) website (contains documents and publications) | ||||||
| - [Bill of Lading Notification](./notification/) maintained here on GitHub (**DEPRECATED** - now included as part of EBL API) | ||||||
| - [Bill of Lading Issuance](./issuance/) maintained here on GitHub | ||||||
| - [Bill of Lading Issuance Response](./issuance_response/) maintained here on GitHub (**DEPRECATED** - now included as part of EBL Issuance API) | ||||||
| - [Bill of Lading Surrender](./surrender/) maintained here on GitHub | ||||||
| - [Bill of Lading Surrender Response](./surrender_response/) maintained here on GitHub (**DEPRECATED** - now included as part of EBL Surrender API) | ||||||
| - [Bill of Lading](https://dcsa.org/standards/ebill-of-lading) maintained on the [dcsa.org](https://dcsa.org) website (contains documents and publications) | ||||||
| - [Bill of Lading Issuance](./issuance) maintained here on GitHub | ||||||
| - [Bill of Lading Surrender](./surrender) maintained here on GitHub | ||||||
|
|
||||||
| <a name="v303"></a>[Release v3.0.3 (TBD 2026)](https://app.swaggerhub.com/apis-docs/dcsaorg/DCSA_EBL/3.0.3) | ||||||
| --- | ||||||
| This is a patch version for the DCSA Bill of Lading API. The primary reason for this patch is adding the **Direct Transport Document** amendment flow. It is also possible to Cancel a Shipping Instructions. | ||||||
| - update API description to include the **Direct Transport Document** amendment flow. Direct Transport Document amendment is optional to support. | ||||||
| - added 3 new endpoints: | ||||||
| - `GET /v3/transport-documents/{transportDocumentReference}/amendment` - fetches a Transport Document amendment | ||||||
| - `PUT /v3/transport-documents/{transportDocumentReference}/amendment` - updates a Transport Document amendment | ||||||
| - `DELETE /v3/transport-documents/{transportDocumentReference}/amendment` - cancels a Transport Document amendment | ||||||
| - improved property and endpoint descriptions | ||||||
| - update Transport Document amendment endpoint | ||||||
| - added new Direct Transport Document amendment examples | ||||||
| - added `amendedTransportDocumentStatus` to the Transport Transport Document Notification and to the amended Transport Document endpoint (the Transport Document object has **NOT** changed). Following states are possible: | ||||||
|
||||||
| - added `amendedTransportDocumentStatus` to the Transport Transport Document Notification and to the amended Transport Document endpoint (the Transport Document object has **NOT** changed). Following states are possible: | |
| - added `amendedTransportDocumentStatus` to the Transport Document Notification and to the amended Transport Document endpoint (the Transport Document object has **NOT** changed). The following states are possible: |
Copilot
AI
Mar 26, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Phrasing/grammar: this sentence uses a hyphen as punctuation and is missing a period at the end. Consider rewriting to a clearer sentence (e.g., "When using this object, it is possible to cancel either an update or the entire Shipping Instructions.").
Suggested change
| - improved the `CancelShippingInstructionsUpdate` description and content. When using this object - it is either possible to cancel an update or the entire Shipping Instructions | |
| - improved the `CancelShippingInstructionsUpdate` description and content. When using this object, it is possible to cancel either an update or the entire Shipping Instructions. |
Copilot
AI
Mar 26, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Likely typo/inconsistency: elsewhere this README refers to "Shipping Instructions" (plural). Here it says "Shipping Instruction updates"; consider aligning this to the established wording/schema name.
Suggested change
| - `Shipping Instruction` updates: | |
| - `Shipping Instructions` updates: |
Copilot
AI
Mar 26, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Typo: "gramatical" should be "grammatical".
Suggested change
| - many description updates (typos and gramatical errors fixed) | |
| - many description updates (typos and grammatical errors fixed) |
Copilot
AI
Mar 26, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Typo: "descriptrions" should be "descriptions".
Suggested change
| - Party objects previously shared between SI and TD have now been split into two. Objects created for SI have been prefixed with `Shipper` (as they are provided by the shipper). There are no structural changes - only changes to the descriptrions. This goes for: | |
| - Party objects previously shared between SI and TD have now been split into two. Objects created for SI have been prefixed with `Shipper` (as they are provided by the shipper). There are no structural changes - only changes to the descriptions. This goes for: |
Copilot
AI
Mar 26, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Minor formatting: missing space after the comma in "Seller,Buyer", which reduces readability.
Suggested change
| - an unstructured address object called `addressLines` added to the following party objects: `Shipper`, `OnBehalfOfShipper`, `Consignee`, `ConsigneeShipper`, `OnBehalfOfConsignee`, `Endorsee`, `EndorseeShipper`, `CarriersAgentAtDestination`, `NotifyParty`, `Seller`,`Buyer`, `PartyShipper`, `IssuingParty` and `ShippingInstructionsRequestor` | |
| - an unstructured address object called `addressLines` added to the following party objects: `Shipper`, `OnBehalfOfShipper`, `Consignee`, `ConsigneeShipper`, `OnBehalfOfConsignee`, `Endorsee`, `EndorseeShipper`, `CarriersAgentAtDestination`, `NotifyParty`, `Seller`, `Buyer`, `PartyShipper`, `IssuingParty` and `ShippingInstructionsRequestor` |
Copilot
AI
Mar 26, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Typo: "First sea giong vessel" should be "First sea-going vessel" (or "sea going"), i.e., "giong" -> "going".
Suggested change
| - `role` added to `VesselVoyage` in order to specify the vessel as being: `FIRST_SEA_GOING` (First sea giong vessel) or `MOTHER` (Mother vessel) | |
| - `role` added to `VesselVoyage` in order to specify the vessel as being: `FIRST_SEA_GOING` (First sea-going vessel) or `MOTHER` (Mother vessel) |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Grammar/capitalization: "It is also possible to Cancel a Shipping Instructions." reads awkwardly. Consider rephrasing to something like "...possible to cancel Shipping Instructions" (no article) and keep the verb lowercase mid-sentence.