Skip to content

Conversation

@HenrikHL
Copy link
Contributor

@HenrikHL HenrikHL commented Jul 29, 2025

User description

The following issues are included in this PR:
SD-2242: Add Carrier code + Carrier code list proivder to SI
SD-2325: Update eBL Solution Providers lists
SD-2322: Allow more than 2 lines for disaplayedAddress in case of physical B/Ls
SD-2275: Publish Booking v2.0.2
SD-2301: Publish eBL 3.0.1, Issuance 3.0.1, Surrender 3.0.1 and PINT 3.0.0
SD-2320: Clarify partyContactDetails description in Booking
SD-2336: Clarify partyContactDetails description in EBL, Issuance and PINT

Updates all README.md files
Remove Servers from APIs
Remove ISO 8601 reference from APIs
Fix typos and formatting


PR Type

Enhancement


Description

  • Update API versions to 3.0.1 for eBL components

  • Add carrier code fields to Shipping Instructions

  • Update eBL solution provider lists with new platforms

  • Relax physical B/L address line restrictions


Diagram Walkthrough

flowchart LR
  A["API Versions"] --> B["eBL 3.0.1"]
  A --> C["BKG 2.0.2"]
  D["Carrier Codes"] --> E["SCAC/SMDG Support"]
  F["Provider Lists"] --> G["New Platforms"]
  H["Address Rules"] --> I["Physical B/L Flexibility"]
Loading

File Walkthrough

Relevant files
Enhancement
5 files
EBL_ISS_v3.0.1.yaml
Update issuance API to version 3.0.1                                         
+27/-22 
EBL_v3.0.1.yaml
Add carrier codes and update provider lists                           
+65/-6   
EBL_PINT_v3.0.0.yaml
Update PINT API with new providers                                             
+26/-17 
EBL_SUR_v3.0.1.yaml
Update surrender API to version 3.0.1                                       
+16/-9   
BKG_v2.0.2.yaml
Update booking API provider lists                                               
+4/-0     
Documentation
5 files
README.md
Document v3.0.1 release changes                                                   
+8/-3     
README.md
Document v2.0.2 release changes                                                   
+2/-2     
README.md
Document issuance v3.0.1 release                                                 
+10/-0   
README.md
Document surrender v3.0.1 release                                               
+8/-0     
README.md
Document PINT beta snapshot release                                           
+10/-0   
Additional files
1 files
styleguide.json +1/-1     

@qodo-code-review
Copy link

qodo-code-review bot commented Jul 29, 2025

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

🎫 Ticket compliance analysis 🔶

SD-2242 - Partially compliant

Compliant requirements:

  • Add 2 new optional properties in SI: requestedCarrierCode and requestedCarrierCodeListProvider
  • Support carrier identification using standardized codes such as SCAC

Non-compliant requirements:

  • Support both Booking Request and Shipping Instructions with carrier identification (only SI implemented)

Requires further human verification:

  • Enable routing of Shipping Instruction payloads to correct carrier APIs (requires integration testing)

SD-2325 - Fully compliant

Compliant requirements:

  • Add COVA (Covantis) to eBL platforms list
  • Add ETIT (e-title) to eBL platforms list
  • Add KTNE (KTNET) to eBL platforms list
  • Add CRED (Credore) to eBL platforms list
  • Apply updates to SI, ISS, and PINT APIs

SD-2322 - Fully compliant

Compliant requirements:

  • Remove max 2 lines restriction for displayedAddress in physical BLs
  • Allow carriers to determine their own max limit for address lines
  • Apply to Shipper, Consignee, Endorsee, and Notify parties displayed addresses

SD-2275 - Fully compliant

Compliant requirements:

  • Publish Booking 2.0.2

SD-2301 - Fully compliant

Compliant requirements:

  • Publish eBL 3.0.1
  • Release Issuance and Surrender with GitHub comment "No change"
  • Keep eBL, Issuance and Surrender aligned
⏱️ Estimated effort to review: 3 🔵🔵🔵⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ Recommended focus areas for review

Field Naming

The new carrier code fields are named carrierCode and carrierCodeListProvider but the ticket requested requestedCarrierCode and requestedCarrierCodeListProvider. This naming discrepancy should be verified.

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
Pattern Validation

The carrierCode field uses pattern ^\S+$ which allows any non-whitespace characters, but SCAC codes have specific format requirements (4 characters, specific character sets) that should be validated.

pattern: ^\S+$
maxLength: 4

@qodo-code-review
Copy link

qodo-code-review bot commented Jul 29, 2025

PR Code Suggestions ✨

No code suggestions found for the PR.

@HenrikHL HenrikHL merged commit eee5228 into master Jul 31, 2025
1 check passed
@HenrikHL HenrikHL deleted the SD-2242_SD-2325_SD-2322_New-202_and_301_release branch July 31, 2025 09:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants