EBL 3.0: SD-2934: Update What's New for eBL v3.0.3#618
Open
EBL 3.0: SD-2934: Update What's New for eBL v3.0.3#618
Conversation
Review Summary by QodoDocument eBL v3.0.3 release notes with Direct Transport Document amendments
WalkthroughsDescription• Add comprehensive What's New documentation for eBL v3.0.3 • Document Direct Transport Document amendment flow with 3 new endpoints • List new shipping instructions cancellation and status states • Detail party object restructuring and new address fields • Document commodity code and packaging enhancements • Update platform integrations and remove deprecated features Diagramflowchart LR
A["eBL v3.0.3 Release"] --> B["Direct Transport Document<br/>Amendment Flow"]
A --> C["Shipping Instructions<br/>Enhancements"]
A --> D["Party Objects &<br/>Address Updates"]
A --> E["Commodity & Packaging<br/>Improvements"]
B --> B1["3 New Endpoints:<br/>GET/PUT/DELETE"]
B --> B2["Amendment Status<br/>States Added"]
C --> C1["Cancel Capability<br/>Added"]
C --> C2["New Status Codes:<br/>CANCELLED/DECLINED"]
D --> D1["Party Objects<br/>Split & Prefixed"]
D --> D2["addressLines Field<br/>Added"]
E --> E1["Extended HS/Commodity<br/>Codes Support"]
E --> E2["Nested innerPackagings<br/>Support"]
File Changes1. ebl/v3/README.md
|
Code Review by Qodo
1. Notification name typo
|
There was a problem hiding this comment.
Pull request overview
Updates the eBL v3 README “What’s New” content to document the upcoming v3.0.3 patch release changes, primarily focused on Direct Transport Document amendment flow and related schema/description updates.
Changes:
- Refreshes the publications list and removes deprecated sub-doc links.
- Adds a new “Release v3.0.3” section describing new amendment endpoints and schema/status updates.
- Expands release notes with additional object/status/code-list changes for v3.0.3.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - `errorCode` description updated | ||
| - `AddressHBL` object created to improve the description for House B/L party objects | ||
| - `PartyShipper` object created to improve the description for parties provided by the Shipper (as part of the Shipping Instructions) vs parties provided by the carrier (as part of the Transport Document) | ||
| - 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: |
There was a problem hiding this comment.
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: |
| - `notifyPartyShipper` object added | ||
| - `partyShipper` object added | ||
| - `eblPlatform` added to: `Shipper`, `Consignee`, `ConsigneeShipper`, `Endorsee` and `EndorseeShipper` party objects | ||
| - 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` |
There was a problem hiding this comment.
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` |
| - `descriptionOfGoodsForCustoms` added as part of the `ConsignmentItem` in the SI (only) | ||
| - `shippingMarksForCustoms` added as part of the `ConsignmentItem` in the SI (only) | ||
| - `innerPackagings` can now have a nested `innerPackagings` to allow multiple innerPackaging-layers | ||
| - `role` added to `VesselVoyage` in order to specify the vessel as being: `FIRST_SEA_GOING` (First sea giong vessel) or `MOTHER` (Mother vessel) |
There was a problem hiding this comment.
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) |
|
|
||
| <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. |
There was a problem hiding this comment.
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.
Suggested change
| 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. | |
| 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 Shipping Instructions. |
| - 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: |
There was a problem hiding this comment.
Typo: "Transport Transport Document Notification" has a duplicated word, which makes the sentence hard to read. Please correct the phrase (and consider adding "The" to "Following states are possible").
Suggested change
| - 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: |
| - `AMENDMENT_CONFIRMED` (An amendment to a Transport Document has been confirmed) | ||
| - `AMENDMENT_CANCELLED` (An amendment to a Transport Document is discontinued by consumer) | ||
| - `AMENDMENT_DECLINED` (An amendment to a Transport Document is discontinued by provider) | ||
| - improved the `CancelShippingInstructionsUpdate` description and content. When using this object - it is either possible to cancel an update or the entire Shipping Instructions |
There was a problem hiding this comment.
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. |
| - Transport Document Notification object now also contains: | ||
| - `amendedTransportDocumentStatus` | ||
| - `amendedTransportDocument` | ||
| - `Shipping Instruction` updates: |
There was a problem hiding this comment.
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: |
| - `Shipping Instruction` updates: | ||
| - added new `shippingInstructionsRevisionNumber` | ||
| - `transportDocumentReference` description updated to reflect `ICS2` requirements | ||
| - many description updates (typos and gramatical errors fixed) |
There was a problem hiding this comment.
Typo: "gramatical" should be "grammatical".
Suggested change
| - many description updates (typos and gramatical errors fixed) | |
| - many description updates (typos and grammatical errors fixed) |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.