Skip to content

Commit 2047556

Browse files
HenrikHLCopilot
andauthored
Apply suggestions from code review
Fix according to review comments Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
1 parent 6ffb15b commit 2047556

1 file changed

Lines changed: 8 additions & 8 deletions

File tree

ebl/v3/README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Publications related to the Bill of Lading API:
1010

1111
<a name="v303"></a>[Release v3.0.3 (TBD 2026)](https://app.swaggerhub.com/apis-docs/dcsaorg/DCSA_EBL/3.0.3)
1212
---
13-
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.
13+
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.
1414
- update API description to include the **Direct Transport Document** amendment flow. Direct Transport Document amendment is optional to support.
1515
- added 3 new endpoints:
1616
- `GET /v3/transport-documents/{transportDocumentReference}/amendment` - fetches a Transport Document amendment
@@ -19,34 +19,34 @@ This is a patch version for the DCSA Bill of Lading API. The primary reason for
1919
- improved property and endpoint descriptions
2020
- update Transport Document amendment endpoint
2121
- added new Direct Transport Document amendment examples
22-
- 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:
22+
- 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:
2323
- `AMENDMENT_RECEIVED` (An amendment to a Transport Document is waiting to be processed)
2424
- `AMENDMENT_CONFIRMED` (An amendment to a Transport Document has been confirmed)
2525
- `AMENDMENT_CANCELLED` (An amendment to a Transport Document is discontinued by consumer)
2626
- `AMENDMENT_DECLINED` (An amendment to a Transport Document is discontinued by provider)
27-
- improved the `CancelShippingInstructionsUpdate` description and content. When using this object - it is either possible to cancel an update or the entire Shipping Instructions
27+
- improved the `CancelShippingInstructionsUpdate` description and content. When using this object, it is possible to cancel either an update or the entire Shipping Instructions.
2828
- `shippingInstructionsStatus` now has 2 new states:
2929
- `CANCELLED` (The Shipping Instructions have been cancelled by Shipper)
3030
- `DECLINED` (The Shipping Instructions have been declined by Carrier)
3131
- Transport Document Notification object now also contains:
3232
- `amendedTransportDocumentStatus`
3333
- `amendedTransportDocument`
34-
- `Shipping Instruction` updates:
34+
- `Shipping Instructions` updates:
3535
- added new `shippingInstructionsRevisionNumber`
3636
- `transportDocumentReference` description updated to reflect `ICS2` requirements
37-
- many description updates (typos and gramatical errors fixed)
37+
- many description updates (typos and grammatical errors fixed)
3838
- `shippingInstructionsStatus` two new status codes added (see above)
3939
- `errorCode` description updated
4040
- `AddressHBL` object created to improve the description for House B/L party objects
4141
- `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)
42-
- 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:
42+
- 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:
4343
- `ShipperShipper` object added
4444
- `OnBehalfOfShipperShipper` object added
4545
- `OnBehalfOfConsigneeShipper` object added
4646
- `notifyPartyShipper` object added
4747
- `partyShipper` object added
4848
- `eblPlatform` added to: `Shipper`, `Consignee`, `ConsigneeShipper`, `Endorsee` and `EndorseeShipper` party objects
49-
- 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`
49+
- 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`
5050
- `sendToPlatform` and `codeListProvider` lists updated with platforms that have been onboarded to the DCSA eBL APIs
5151
- `DOCU` (DocuTrade)
5252
- `AEOT` (AEOTrade)
@@ -58,7 +58,7 @@ This is a patch version for the DCSA Bill of Lading API. The primary reason for
5858
- `descriptionOfGoodsForCustoms` added as part of the `ConsignmentItem` in the SI (only)
5959
- `shippingMarksForCustoms` added as part of the `ConsignmentItem` in the SI (only)
6060
- `innerPackagings` can now have a nested `innerPackagings` to allow multiple innerPackaging-layers
61-
- `role` added to `VesselVoyage` in order to specify the vessel as being: `FIRST_SEA_GOING` (First sea giong vessel) or `MOTHER` (Mother vessel)
61+
- `role` added to `VesselVoyage` in order to specify the vessel as being: `FIRST_SEA_GOING` (First sea-going vessel) or `MOTHER` (Mother vessel)
6262
- the following objects have `addressLines` (an unstructured address object) and `facilityName` added:
6363
- `PlaceOfReceipt`, `PlaceOfDelivery` and `OnwardInlandRouting`
6464
- `chargeName` marked as deprecated - use `extendedChargeName` instead which covers 100 characters (instead of 50 characters)

0 commit comments

Comments
 (0)