Skip to content

Fix review comments #550

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.

Sign up for GitHub

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

Merged
HenrikHL merged 2 commits into from
Sep 10, 2025
Merged

Fix review comments #550

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4ffec16
Fix review comments
HenrikHL Sep 10, 2025
dc1d8fb
Fix review comments
HenrikHL Sep 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .stoplight/styleguide.json
View file
Open in desktop

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions ebl/v3/EBL_v3.0.2.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4574,7 +4574,7 @@ components:
description: |
The party allowed to act on behalf of the shipper for documentation purposes.

**Condition:** Either the `address` or a party `identifyingCode` must be provided in the `Shipping Instructions`. If a `displayedAddress` is provided, it must be included in the `Transport Document` instead of the `address`.
**Condition:** Either the `address` or a party `identifyingCode` must be provided in the `Shipping Instructions`.
properties:
partyName:
type: string
Expand Down Expand Up @@ -4730,7 +4730,7 @@ components:
description: |
The party allowed to act on behalf of the consignee for documentation purposes.

**Condition:** Either the `address` or a party `identifyingCode` must be provided in the `Shipping Instructions`. If a `displayedAddress` is provided, it must be included in the `Transport Document` instead of the `address`.
**Condition:** Either the `address` or a party `identifyingCode` must be provided in the `Shipping Instructions`.
properties:
partyName:
type: string
Expand Down
4 changes: 2 additions & 2 deletions ebl/v3/issuance/EBL_ISS_v3.0.2.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2908,7 +2908,7 @@ components:
description: |
The party allowed to act on behalf of the shipper for documentation purposes.

**Condition:** Either the `address` or a party `identifyingCode` must be provided in the `Shipping Instructions`. If a `displayedAddress` is provided, it must be included in the `Transport Document` instead of the `address`.
**Condition:** Either the `address` or a party `identifyingCode` must be provided in the `Shipping Instructions`.
properties:
partyName:
type: string
Expand Down Expand Up @@ -3019,7 +3019,7 @@ components:
description: |
The party allowed to act on behalf of the consignee for documentation purposes.

**Condition:** Either the `address` or a party `identifyingCode` must be provided in the `Shipping Instructions`. If a `displayedAddress` is provided, it must be included in the `Transport Document` instead of the `address`.
**Condition:** Either the `address` or a party `identifyingCode` must be provided in the `Shipping Instructions`.
properties:
partyName:
type: string
Expand Down
93 changes: 84 additions & 9 deletions ebl/v3/surrender/EBL_SUR_v3.0.2.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,13 +145,69 @@ components:
description: |
An API-Version header **MAY** be added to the request (optional); if added it **MUST** only contain **MAJOR** version. API-Version header **MUST** be aligned with the URI version.
schemas:
TransactionParty:
ActorParty:
type: object
title: Transaction Party
title: Actor Party
description: |
Refers to a company or a legal entity.
properties:
eblPlatform:
type: string
pattern: ^\S+$
maxLength: 4
description: |
The eBL platform of the `Actor Party`. The value **MUST** be one of:
- `WAVE` (Wave)
- `CARX` (CargoX)
- `ESSD` (EssDOCS - This value has been **deprecated**. Please use `IDT`)
- `IDT` (ICE Digital Trade)
- `BOLE` (Bolero)
- `EDOX` (EdoxOnline)
- `IQAX` (IQAX)
- `SECR` (Secro)
- `TRGO` (TradeGO)
- `ETEU` (eTEU)
- `TRAC` (Enigio trace:original)
- `BRIT` (BRITC eBL)
- `COVA` (Covantis)
- `ETIT` (e-title)
- `KTNE` (KTNET)
- `CRED` (Credore)
- `BLOC` (BlockPeer Technologies)
- `NONE` (To be used as part of the '**No Party**' object when `actionCode` is `SIGN`, `BLANK ENDORSE` or `SURRENDERED`)
example: BOLE
partyName:
type: string
pattern: ^\S(?:.*\S)?$
maxLength: 70
description: |
Name of the party.
example: Globeteam
identifyingCodes:
type: array
minItems: 1
items:
$ref: '#/components/schemas/IdentifyingCode'
taxLegalReferences:
description: |
A list of `Tax References` for a `Party`
type: array
items:
$ref: '#/components/schemas/TaxLegalReference'
representedParty:
$ref: '#/components/schemas/RepresentedActorParty'
required:
- partyName
- eblPlatform
- identifyingCodes

RecipientParty:
type: object
title: Recipient Party
description: |
Refers to a company or a legal entity.

**Note:** In case this object populates the `recipient` property of the `Transaction` object it is possible to use a '**No Party**' placeholder when the `actionCode` is one of the following values: `SIGN`, `BLANK ENDORSE` or `SURRENDERED` (as none of these `actionCodes` require a `recipient`). A '**No Party**' object MUST be populated with the following values:
**Note:** It is possible to use a '**No Party**' placeholder when the `actionCode` is one of the following values: `SIGN`, `BLANK ENDORSE` or `SURRENDERED` (as none of these `actionCodes` require a `recipient`). A '**No Party**' object MUST be populated with the following values:
```
{
'eblPlatform': 'NONE',
Expand All @@ -170,7 +226,7 @@ components:
pattern: ^\S+$
maxLength: 4
description: |
The eBL platform of the transaction party. The value **MUST** be one of:
The eBL platform of the `Recipient Party`. The value **MUST** be one of:
- `WAVE` (Wave)
- `CARX` (CargoX)
- `ESSD` (EssDOCS - This value has been **deprecated**. Please use `IDT`)
Expand Down Expand Up @@ -209,16 +265,35 @@ components:
items:
$ref: '#/components/schemas/TaxLegalReference'
representedParty:
$ref: '#/components/schemas/RepresentedParty'
$ref: '#/components/schemas/RepresentedRecipientParty'
required:
- partyName
- eblPlatform
- identifyingCodes

RepresentedParty:
RepresentedActorParty:
type: object
title: Represented Party
description: The party on whose behalf the action was performed.
properties:
partyName:
type: string
pattern: ^\S(?:.*\S)?$
maxLength: 70
description: |
Name of the party.
example: Globeteam
identifyingCodes:
type: array
items:
$ref: '#/components/schemas/IdentifyingCode'
required:
- partyName

RepresentedRecipientParty:
type: object
title: Represented Party
description: The party allowed to act on behalf of the `Shipper` or `Consignee` for documentation purposes.
description: The party on whose behalf the action was directed.
properties:
partyName:
type: string
Expand Down Expand Up @@ -263,9 +338,9 @@ components:
Not all actions are applicable to all surrender requests. The combination and order of endorsement chain entries may differ by eBL Solution Provider, based on their rulebook and/or bilateral agreements with carriers.
example: ISSUE
actor:
$ref: '#/components/schemas/TransactionParty'
$ref: '#/components/schemas/ActorParty'
recipient:
$ref: '#/components/schemas/TransactionParty'
$ref: '#/components/schemas/RecipientParty'
required:
- actionDateTime
- actionCode
Expand Down
96 changes: 86 additions & 10 deletions pint/v3/EBL_PINT_v3.0.0.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -953,9 +953,9 @@ components:
When the transaction recipient is residing on the different platform from the transaction actor's platform, the transaction should be followed by the envelope transfer from the actor's (sending) platform to the recipient's (receiving) platform. If the envelope transfer is caused by either `ENDORSE` `actionCode` or `SACC` `actionCode` transaction (where the recipient is on the different platform), the envelope transfer process is NOT causing transfer of possession of the eBL document, but is merely used as notification for the non-repudiation purposes.
example: ISSUE
actor:
$ref: '#/components/schemas/TransactionParty'
$ref: '#/components/schemas/ActorParty'
recipient:
$ref: '#/components/schemas/TransactionParty'
$ref: '#/components/schemas/RecipientParty'
actionDateTime:
type: string
format: date-time
Expand Down Expand Up @@ -986,9 +986,10 @@ components:
- actionCode
- actor
- actionDateTime
TransactionParty:

ActorParty:
type: object
title: Transaction Party
title: Actor Party
description: |
Refers to a company or a legal entity.
properties:
Expand All @@ -1004,7 +1005,7 @@ components:
pattern: ^\S+$
maxLength: 4
description: |
The eBL platform of the transaction party.
The eBL platform of the `Actor Party`.
The value **MUST** be one of:
- `WAVE` (Wave)
- `CARX` (CargoX)
Expand Down Expand Up @@ -1036,16 +1037,91 @@ components:
items:
$ref: '#/components/schemas/TaxLegalReference'
representedParty:
$ref: '#/components/schemas/RepresentedParty'
$ref: '#/components/schemas/RepresentedActorParty'
required:
- partyName
- eblPlatform
- identifyingCodes

RepresentedParty:
RecipientParty:
type: object
title: Recipient Party
description: |
Refers to a company or a legal entity.
properties:
partyName:
type: string
pattern: ^\S(?:.*\S)?$
maxLength: 70
description: |
Name of the party.
example: Globeteam
eblPlatform:
type: string
pattern: ^\S+$
maxLength: 4
description: |
The eBL platform of the `Recipient Party`.
The value **MUST** be one of:
- `WAVE` (Wave)
- `CARX` (CargoX)
- `ESSD` (EssDOCS - This value has been **deprecated**. Please use `IDT`)
- `IDT` (ICE Digital Trade)
- `BOLE` (Bolero)
- `EDOX` (EdoxOnline)
- `IQAX` (IQAX)
- `SECR` (Secro)
- `TRGO` (TradeGO)
- `ETEU` (eTEU)
- `TRAC` (Enigio trace:original)
- `BRIT` (BRITC eBL)
- `COVA` (Covantis)
- `ETIT` (e-title)
- `KTNE` (KTNET)
- `CRED` (Credore)
- `BLOC` (BlockPeer Technologies)
example: BOLE
identifyingCodes:
type: array
minItems: 1
items:
$ref: '#/components/schemas/IdentifyingCode'
taxLegalReferences:
description: |
A list of `Tax References` for a `Party`
type: array
items:
$ref: '#/components/schemas/TaxLegalReference'
representedParty:
$ref: '#/components/schemas/RepresentedRecipientParty'
required:
- partyName
- eblPlatform
- identifyingCodes

RepresentedActorParty:
type: object
title: Represented Party
description: The party on whose behalf the action was performed.
properties:
partyName:
type: string
pattern: ^\S(?:.*\S)?$
maxLength: 70
description: |
Name of the party.
example: Globeteam
identifyingCodes:
type: array
items:
$ref: '#/components/schemas/IdentifyingCode'
required:
- partyName

RepresentedRecipientParty:
type: object
title: Represented Party
description: The party allowed to act on behalf of the `Shipper` or `Consignee` for documentation purposes.
description: The party on whose behalf the action was directed.
properties:
partyName:
type: string
Expand Down Expand Up @@ -3526,7 +3602,7 @@ components:
description: |
The party allowed to act on behalf of the shipper for documentation purposes.

**Condition:** Either the `address` or a party `identifyingCode` must be provided in the `Shipping Instructions`. If a `displayedAddress` is provided, it must be included in the `Transport Document` instead of the `address`.
**Condition:** Either the `address` or a party `identifyingCode` must be provided in the `Shipping Instructions`.
properties:
partyName:
type: string
Expand Down Expand Up @@ -3637,7 +3713,7 @@ components:
description: |
The party allowed to act on behalf of the consignee for documentation purposes.

**Condition:** Either the `address` or a party `identifyingCode` must be provided in the `Shipping Instructions`. If a `displayedAddress` is provided, it must be included in the `Transport Document` instead of the `address`.
**Condition:** Either the `address` or a party `identifyingCode` must be provided in the `Shipping Instructions`.
properties:
partyName:
type: string
Expand Down