BKG 2.0, all EBL 3.0: Create a BKG 2.0.2 and eBL 3.0.1 releases

bkg/v2/BKG_v2.0.2.yaml

@@ -3190,7 +3190,7 @@ components:
         partyContactDetails:
           type: array
           description: |
-            The contact details of the person(s) to contact in relation to the **Booking** (changes, notifications etc.) 
+            The contact details of the Booking requestor(s) to contact in relation to the **Booking** (changes, notifications etc.) 
           items:
             $ref: '#/components/schemas/PartyContactDetail'
         shipmentLocations:
@@ -3576,7 +3576,7 @@ components:
         partyContactDetails:
           type: array
           description: |
-            The contact details of the person(s) to contact in relation to the **Booking** (changes, notifications etc.) 
+            The contact details of the Booking requestor(s) to contact in relation to the **Booking** (changes, notifications etc.) 
           items:
             $ref: '#/components/schemas/PartyContactDetail'
         shipmentLocations:
@@ -4035,7 +4035,7 @@ components:
         partyContactDetails:
           type: array
           description: |
-            The contact details of the person(s) to contact in relation to the **Booking** (changes, notifications etc.) 
+            The contact details of the Booking requestor(s) to contact in relation to the **Booking** (changes, notifications etc.) 
           items:
             $ref: '#/components/schemas/PartyContactDetail'
         shipmentLocations:
@@ -4796,6 +4796,10 @@ components:
             - `ETEU` (eTEU)
             - `TRAC` (Enigio trace:original)
             - `BRIT` (BRITC eBL)
+            - `COVA` (Covantis)
+            - `ETIT` (e-title)
+            - `KTNE` (KTNET)
+            - `CRED` (Credore)
             - `GSBN` (Global Shipping Business Network)
             - `WISE` (WiseTech)
             - `GLEIF` (Global Legal Entity Identifier Foundation)

bkg/v2/README.md

@@ -7,7 +7,7 @@ Publications related to the Booking API:
 - [Booking Process](https://dcsa.org/standards/booking-process/) contains documents and publications
 - [Booking Notification](./notification/) maintained here on GitHub  (**DEPRECATED** - now included as part of Booking API)
 
-<a name="v202"></a>[Release v2.0.2 (TBD)](https://app.swaggerhub.com/apis-docs/dcsaorg/DCSA_BKG/2.0.2)
+<a name="v202"></a>[Release v2.0.2 (31 July 2025)](https://app.swaggerhub.com/apis-docs/dcsaorg/DCSA_BKG/2.0.2)
 ---
 This is a patch release for the DCSA Booking API. A bug in the `GET`, `PUT` and `PATCH` description has been fixed (chaning the semantics of the endPoints) and a lot of minor changes have been added to this patch, here is a list of changes
 
@@ -26,7 +26,8 @@ This is a patch release for the DCSA Booking API. A bug in the `GET`, `PUT` and
   - `BARGE_TRUCK`(Barge and truck)
   - `BARGE_RAIL`(Barge and rail)
 - We have removed a constraint that was preventing shippers who don't receive notifications to transition from using the carrier booking request reference (CBRR) to using the carrier booking reference (CBR) when the booking is confirmed
-
+- `codeListProvider` updated with the following values: `COVA` (Covantis), `ETIT` (e-title), `KTNE` (KTNET) and `CRED` (Credore)
+- clarifies which party `partyContactDetails` refers to
 Link to [commits included in this patch](https://github.com/dcsaorg/DCSA-OpenAPI/commits/master/bkg/v2/BKG_v2.0.2.yaml?since=2025-04-25&until=2025-07-04)
 
 <a name="v201"></a>[Release v2.0.1 (25 April 2025)](https://app.swaggerhub.com/apis-docs/dcsaorg/DCSA_BKG/2.0.1)

ebl/v3/EBL_v3.0.1.yaml

@@ -2967,14 +2967,14 @@ components:
           description: |
             The status of the `Transport Document`. Possible values are:
 
-            - `DRAFT` (Transport Document is Drafted)
-            - `APPROVED` (Transport Document has been Approved by consumer)
-            - `ISSUED` (Transport Document has been Issued by provider)
-            - `PENDING_SURRENDER_FOR_AMENDMENT` (Transport Document is Pending for Surrender for an Amendment)
-            - `SURRENDER_FOR_AMENDMENT` (Transport Document Surrendered for an Amendment)
+            - `DRAFT` (the Transport Document is currently a Draft)
+            - `APPROVED` (the Transport Document has been Approved by consumer)
+            - `ISSUED` (the Transport Document has been Issued by provider)
+            - `PENDING_SURRENDER_FOR_AMENDMENT` (the Transport Document has a pending Surrender for Amendment)
+            - `SURRENDER_FOR_AMENDMENT` (the Transport Document is Surrendered for Amendment)
             - `VOID` (the Transport Document has been Voided)
-            - `PENDING_SURRENDER_FOR_DELIVERY` (Transport Document pending surrender for Delivery)
-            - `SURRENDER_FOR_DELIVERY` (Transport Document surrendered for Delivery)
+            - `PENDING_SURRENDER_FOR_DELIVERY` (the Transport Document has a pending Surrender for Delivery)
+            - `SURRENDER_FOR_DELIVERY` (the Transport Document is Surrendered for Delivery)
           example: DRAFT
         shippingInstructionsReference:
           type: string
@@ -3183,6 +3183,23 @@ components:
             description: |
               A line of the address to be displayed on the transport document.
             example: 'Strawinskylaan 4117'
+        carrierCode:
+          type: string
+          pattern: ^\S+$
+          maxLength: 4
+          description: |
+            The `SCAC` code (provided by [NMFTA](https://nmfta.org/scac/)) or `SMDG` code (provided by [SMDG](https://smdg.org/documents/smdg-code-lists/smdg-liner-code-list/)) of the carrier the `Shipping Instructions` is intended for. `carrierCodeListProvider` defines which list the `carrierCode` is based upon.
+          example: MMCU
+        carrierCodeListProvider:
+          type: string
+          description: |
+            The code list provider for the `carrierCode`. Possible values are:
+            - `SMDG` (Ship Message Design Group)
+            - `NMFTA` (National Motor Freight Traffic Association)
+          enum:
+            - SMDG
+            - NMFTA
+          example: NMFTA
         placeOfIssue:
           $ref: '#/components/schemas/PlaceOfIssue'
         invoicePayableAt:
@@ -3191,7 +3208,7 @@ components:
           type: array
           minItems: 1
           description: |
-            The contact details of the person(s) to contact in relation to the **Transport Document** (changes, notifications etc.) 
+            The contact details of the Shipping Instructions requestor(s) to contact in relation to the **Transport Document** (changes, notifications etc.)
           items:
             $ref: '#/components/schemas/PartyContactDetail'
         isCarriersAgentAtDestinationRequired:
@@ -3482,6 +3499,23 @@ components:
             description: |
               A line of the address to be displayed on the transport document.
             example: 'Strawinskylaan 4117'
+        carrierCode:
+          type: string
+          pattern: ^\S+$
+          maxLength: 4
+          description: |
+            The `SCAC` code (provided by [NMFTA](https://nmfta.org/scac/)) or `SMDG` code (provided by [SMDG](https://smdg.org/documents/smdg-code-lists/smdg-liner-code-list/)) of the carrier the `Shipping Instructions` is intended for. `carrierCodeListProvider` defines which list the `carrierCode` is based upon.
+          example: MMCU
+        carrierCodeListProvider:
+          type: string
+          description: |
+            The code list provider for the `carrierCode`. Possible values are:
+            - `SMDG` (Ship Message Design Group)
+            - `NMFTA` (National Motor Freight Traffic Association)
+          enum:
+            - SMDG
+            - NMFTA
+          example: NMFTA
         placeOfIssue:
           $ref: '#/components/schemas/PlaceOfIssue'
         invoicePayableAt:
@@ -3490,7 +3524,7 @@ components:
           type: array
           minItems: 1
           description: |
-            The contact details of the person(s) to contact in relation to the **Transport Document** (changes, notifications etc.) 
+            The contact details of the Shipping Instructions requestor(s) to contact in relation to the **Transport Document** (changes, notifications etc.)
           items:
             $ref: '#/components/schemas/PartyContactDetail'
         isCarriersAgentAtDestinationRequired:
@@ -3801,6 +3835,23 @@ components:
             description: |
               A line of the address to be displayed on the transport document.
             example: 'Strawinskylaan 4117'
+        carrierCode:
+          type: string
+          pattern: ^\S+$
+          maxLength: 4
+          description: |
+            The `SCAC` code (provided by [NMFTA](https://nmfta.org/scac/)) or `SMDG` code (provided by [SMDG](https://smdg.org/documents/smdg-code-lists/smdg-liner-code-list/)) of the carrier the `Shipping Instructions` is intended for. `carrierCodeListProvider` defines which list the `carrierCode` is based upon.
+          example: MMCU
+        carrierCodeListProvider:
+          type: string
+          description: |
+            The code list provider for the `carrierCode`. Possible values are:
+            - `SMDG` (Ship Message Design Group)
+            - `NMFTA` (National Motor Freight Traffic Association)
+          enum:
+            - SMDG
+            - NMFTA
+          example: NMFTA
         placeOfIssue:
           $ref: '#/components/schemas/PlaceOfIssue'
         invoicePayableAt:
@@ -3809,7 +3860,7 @@ components:
           type: array
           minItems: 1
           description: |
-            The contact details of the person(s) to contact in relation to the **Transport Document** (changes, notifications etc.) 
+            The contact details of the Shipping Instructions requestor(s) to contact in relation to the **Transport Document** (changes, notifications etc.)
           items:
             $ref: '#/components/schemas/PartyContactDetail'
         isCarriersAgentAtDestinationRequired:
@@ -4463,7 +4514,7 @@ components:
 
             **Conditions:** If provided:
               - the displayed address must be included in the `Transport Document`.
-              - for physical BL (`isElectronic=false`), it is only allowed to provide max 2 lines of 35 characters
+              - for physical BL (`isElectronic=false`), it is only allowed to provide max 2 lines of 35 characters. **Note:** Some carriers may choose to allow more lines, please consult the carrier's API documentation to check if this is the case.
               - for electronic BL (`isElectronic=true`), the limit is 6 lines of 35 characters
               - the order of the items in this array **MUST** be preserved as by the provider of the API.
           items:
@@ -4593,7 +4644,7 @@ components:
 
             **Conditions:** If provided:
               - the displayed address must be included in the `Transport Document`.
-              - for physical BL (`isElectronic=false`), it is only allowed to provide max 2 lines of 35 characters
+              - for physical BL (`isElectronic=false`), it is only allowed to provide max 2 lines of 35 characters. **Note:** Some carriers may choose to allow more lines, please consult the carrier's API documentation to check if this is the case.
               - for electronic BL (`isElectronic=true`), the limit is 6 lines of 35 characters
               - the order of the items in this array **MUST** be preserved as by the provider of the API.
           items:
@@ -4678,7 +4729,7 @@ components:
 
             **Conditions:** If provided:
               - the displayed address must be included in the `Transport Document`.
-              - for physical BL (`isElectronic=false`), it is only allowed to provide max 2 lines of 35 characters
+              - for physical BL (`isElectronic=false`), it is only allowed to provide max 2 lines of 35 characters. **Note:** Some carriers may choose to allow more lines, please consult the carrier's API documentation to check if this is the case.
               - for electronic BL (`isElectronic=true`), the limit is 6 lines of 35 characters
               - the order of the items in this array **MUST** be preserved as by the provider of the API.
           items:
@@ -4798,7 +4849,7 @@ components:
 
             **Conditions:** If provided:
               - the displayed address must be included in the `Transport Document`.
-              - for physical BL (`isElectronic=false`), it is only allowed to provide max 2 lines of 35 characters
+              - for physical BL (`isElectronic=false`), it is only allowed to provide max 2 lines of 35 characters. **Note:** Some carriers may choose to allow more lines, please consult the carrier's API documentation to check if this is the case.
               - for electronic BL (`isElectronic=true`), the limit is 6 lines of 35 characters
               - the order of the items in this array **MUST** be preserved as by the provider of the API.
           items:
@@ -4855,7 +4906,7 @@ components:
 
             **Conditions:** If provided:
               - the displayed address must be included in the `Transport Document`.
-              - for physical BL (`isElectronic=false`), it is only allowed to provide max 2 lines of 35 characters
+              - for physical BL (`isElectronic=false`), it is only allowed to provide max 2 lines of 35 characters. **Note:** Some carriers may choose to allow more lines, please consult the carrier's API documentation to check if this is the case.
               - for electronic BL (`isElectronic=true`), the limit is 6 lines of 35 characters
               - the order of the items in this array **MUST** be preserved as by the provider of the API.
           items:
@@ -4943,6 +4994,10 @@ components:
             - `ETEU` (eTEU)
             - `TRAC` (Enigio trace:original)
             - `BRIT` (BRITC eBL)
+            - `COVA` (Covantis)
+            - `ETIT` (e-title)
+            - `KTNE` (KTNET)
+            - `CRED` (Credore)
 
             **Condition:** Only applicable when `isElectronic=true` and `transportDocumentTypeCode=BOL`. The property **MUST** be absent for paper B/Ls (`isElectronic=false`)
           example: BOLE
@@ -4996,7 +5051,7 @@ components:
 
             **Conditions:** If provided:
               - the displayed address must be included in the `Transport Document`.
-              - for physical BL (`isElectronic=false`), it is only allowed to provide max 2 lines of 35 characters
+              - for physical BL (`isElectronic=false`), it is only allowed to provide max 2 lines of 35 characters. **Note:** Some carriers may choose to allow more lines, please consult the carrier's API documentation to check if this is the case.
               - for electronic BL (`isElectronic=true`), the limit is 6 lines of 35 characters
               - the order of the items in this array **MUST** be preserved as by the provider of the API.
           items:
@@ -5584,6 +5639,10 @@ components:
             - `ETEU` (eTEU)
             - `TRAC` (Enigio trace:original)
             - `BRIT` (BRITC eBL)
+            - `COVA` (Covantis)
+            - `ETIT` (e-title)
+            - `KTNE` (KTNET)
+            - `CRED` (Credore)
             - `GSBN` (Global Shipping Business Network)
             - `WISE` (WiseTech)
             - `GLEIF` (Global Legal Entity Identifier Foundation)
@@ -7636,13 +7695,13 @@ components:
           maxLength: 50
           description: |
             The status of the `Transport Document`. Possible values are:
-            - `DRAFT` (Transport Document is Drafted)
-            - `APPROVED` (Transport Document has been Approved by consumer)
-            - `ISSUED` (Transport Document has been Issued by provider)
-            - `PENDING_SURRENDER_FOR_AMENDMENT` (Transport Document is Pending for Surrender for an Amendment)
-            - `SURRENDERED_FOR_AMENDMENT` (Transport Document Surrendered for an Amendment)
-            - `PENDING_SURRENDER_FOR_DELIVERY` (Transport Document pending surrender for Delivery)
-            - `SURRENDERED_FOR_DELIVERY` (Transport Document surrendered for Delivery)
+            - `DRAFT` (the Transport Document is currently a Draft)
+            - `APPROVED` (the Transport Document has been Approved by consumer)
+            - `ISSUED` (the Transport Document has been Issued by provider)
+            - `PENDING_SURRENDER_FOR_AMENDMENT` (the Transport Document has a pending Surrender for Amendment)
+            - `SURRENDERED_FOR_AMENDMENT` (the Transport Document is Surrendered for Amendment)
+            - `PENDING_SURRENDER_FOR_DELIVERY` (the Transport Document has a pending Surrender for Delivery)
+            - `SURRENDERED_FOR_DELIVERY` (the Transport Document is Surrendered for Delivery)
             - `VOIDED` (the Transport Document has been Voided)
           example: DRAFT
         transportDocumentTypeCode:

ebl/v3/README.md

@@ -11,19 +11,25 @@ Publications related to the Bill of Lading 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)
 
-<a name="v301"></a>[Release v3.0.1 (TBD May 2025)](https://app.swaggerhub.com/apis-docs/dcsaorg/DCSA_EBL/3.0.1)
+<a name="v301"></a>[Release v3.0.1 (31 July 2025)](https://app.swaggerhub.com/apis-docs/dcsaorg/DCSA_EBL/3.0.1)
 ---
 This is a patch version for the DCSA Bill of Lading API. The primary reason for this patch is the `ShippingInstructionRequestor` party and adding a `transportDocumentReference` by Shipper, but other improvements have been added as well:
 ## Schema changes
 - added `shippingInstructionsRequestor` as an optional party
 - added `transportDocumentReference` as an optional property when creating and updating a `Shipping Instructions`
-- remove Servers list that was wrongly added (no Virtual Servers are connected to DCSA APIs)
-- remove `nullable=false` as false is the default
+- removed `nullable=false` as false is the default
+- updated `partyFunctionCode` for the `TransportDocument` as it was wrongly aligned with `ShippingInstructions` (`CS` (Consolidator), `MF` (Manufacturer) and `WH` (Warehouse Keeper) removed)
+- added `carrierCode` and `carrierCodeListProvider` to identify which carrier a ShippingInstructions should be sent to
+
+## Minor changes
+- removed Servers list that was wrongly added (no Virtual Servers are connected to DCSA APIs)
+- added an extra **Note** on the `dispalyedAdress` mentioning that some carriers might allow for more than 2 lines for physical Bill of Ladings
 - updated spelling for Jerr**i**cans -> Jerr**y**cans
 - updated some typos
-- remove the reference to `ISO 8601` (all dateTime fields must comply with [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6))
-- update partyFunction codes for the `TransportDocument` as it was wrongly aligned with `ShippingInstructions` (`CS` (Consolidator), `MF` (Manufacturer) and `WH` (Warehouse Keeper) removed)
+- removed the reference to `ISO 8601` (all dateTime fields must comply with [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6))
 - fixed some formatting in the `transportDocumentStatus` description and some places referring to `Transport Document`
+- `codeListProvider` and `sendToPlatform` updated with the following values: `COVA` (Covantis), `ETIT` (e-title), `KTNE` (KTNET) and `CRED` (Credore)
+- clarifies which party `partyContactDetails` refers to
 
 <a name="v300"></a>[Release v3.0.0 (17 December 2024)](https://app.swaggerhub.com/apis-docs/dcsaorg/DCSA_EBL/3.0.0)
 ---