Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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

Large diffs are not rendered by default.

7 changes: 7 additions & 0 deletions bkg/v2/BKG_v2.0.5.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4475,6 +4475,8 @@ components:
- `NI` (Other Notify Party)
- `NAC` (Named Account Customer)
- `CSR` (Carrier customer service representative)

**Note:** If `isNotifyParty` is set in the `Consignee` party, then a `N1` (First Notify Party) conceptually becomes **Second Notify Party** (`N2`) and `N2` (Second Notify Party) conceptually becomes **Other Notify Party** (`NI`). The `Consignee` conceptually becomes **First Notify Party** (`N1`). Any visual representation (e.g. in a PDF) of the `Consignee` as a NotifyParty is not prescribed by the standard (e.g it can be the text: "Same as Consignee" or a copy of the Consignee, etc).
example: DDS
required:
- party
Expand Down Expand Up @@ -4712,6 +4714,11 @@ components:
description: |
A purchase order reference linked to the `Consignee`.
example: HHL007
isNotifyParty:
type: boolean
description: |
Indicates whether the Consignee is also a NotifyParty with identical information. If set to `true` a conceptual 1st notify party identical to the Consignee will exist (any existing 1st NotifyParty conceptually becomes 2nd NotifyParty, any existing 2nd NotifyParty conceptually becomes OtherNotifyParty). The NotifyParty-object will not be affected. Setting this property to `true` does not prescribe what should appear on the printed B/L.
example: true
required:
- partyName

Expand Down
28 changes: 26 additions & 2 deletions ebl/v3/EBL_v3.0.4.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6229,6 +6229,11 @@ components:
description: |
A purchase order reference linked to the `Consignee`.
example: HHL007
isNotifyParty:
type: boolean
description: |
Indicates whether the Consignee is also a NotifyParty with identical information. If set to `true` a conceptual 1st notify party identical to the Consignee will exist (any existing 1st NotifyParty conceptually becomes 2nd NotifyParty, any existing 2nd NotifyParty conceptually becomes OtherNotifyParty). The NotifyParty-object will not be affected. Setting this property to `true` does not prescribe what should appear on the printed B/L.
example: true
required:
- partyName
- identifyingCodes
Expand Down Expand Up @@ -6431,6 +6436,11 @@ components:
description: |
A purchase order reference linked to the `Consignee`.
example: HHL007
isNotifyParty:
type: boolean
description: |
Indicates whether the Consignee is also a NotifyParty with identical information. If set to `true` a conceptual 1st notify party identical to the Consignee will exist (any existing 1st NotifyParty conceptually becomes 2nd NotifyParty, any existing 2nd NotifyParty conceptually becomes OtherNotifyParty). The NotifyParty-object will not be affected. Setting this property to `true` does not prescribe what should appear on the printed B/L.
example: true
required:
- partyName

Expand Down Expand Up @@ -6570,6 +6580,11 @@ components:
A list of contact details
items:
$ref: '#/components/schemas/PartyContactDetail'
isNotifyParty:
type: boolean
description: |
Indicates whether the Endorsee is also a NotifyParty with identical information. If set to `true` a conceptual 1st notify party identical to the Endorsee will exist (any existing 1st NotifyParty conceptually becomes 2nd NotifyParty, any existing 2nd NotifyParty conceptually becomes OtherNotifyParty). The NotifyParty-object will not be affected. Setting this property to `true` does not prescribe what should appear on the printed B/L.
example: true
required:
- partyName
- identifyingCodes
Expand Down Expand Up @@ -6670,6 +6685,11 @@ components:
A list of contact details
items:
$ref: '#/components/schemas/PartyContactDetail'
isNotifyParty:
type: boolean
description: |
Indicates whether the Endorsee is also a NotifyParty with identical information. If set to `true` a conceptual 1st notify party identical to the Endorsee will exist (any existing 1st NotifyParty conceptually becomes 2nd NotifyParty, any existing 2nd NotifyParty conceptually becomes OtherNotifyParty). The NotifyParty-object will not be affected. Setting this property to `true` does not prescribe what should appear on the printed B/L.
example: true
required:
- partyName

Expand Down Expand Up @@ -10951,8 +10971,10 @@ components:
List of up to 3 `Notify Parties`. The first item in the list is the **First Notify Party** (`N1`), the second item is the **Second Notify Party** (`N2`) and the last item is the **Other Notify Party** (`NI`).

**Condition:** If provided:
- Mandatory for To Order BLs, `isToOrder=true`
- Mandatory for To Order BLs, `isToOrder=true`, unless `isNotifyParty` in `Consignee` or `Endorsee` is set to `true`, in which case the `notifyParties` property can be omitted.
- The order of the items in this array **MUST** be preserved as by the provider of the API.

**Note:** If `isNotifyParty` is set in either `Consignee` or `Endorsee` parties, then 1st item in the list conceptually becomes **Second Notify Party** (`N2`) and any other items in the list conceptually becomes **Other Notify Party** (`NI`). The `Consignee` or `Endorsee` conceptually becomes **First Notify Party** (`N1`).
items:
$ref: '#/components/schemas/NotifyPartyShipper'
shippingInstructionsRequestor:
Expand Down Expand Up @@ -11024,8 +11046,10 @@ components:
List of up to 3 `Notify Parties`. The first item in the list is the **First Notify Party** (`N1`), the second item is the **Second Notify Party** (`N2`) and the last item is the **Other Notify Party** (`NI`).

**Condition:** If provided:
- Mandatory for To Order BLs, `isToOrder=true`
- Mandatory for To Order BLs, `isToOrder=true`, unless `isNotifyParty` in `Consignee` or `Endorsee` is set to `true`, in which case the `notifyParties` property can be omitted.
- The order of the items in this array **MUST** be preserved as by the provider of the API.

**Note:** If `isNotifyParty` is set in either `Consignee` or `Endorsee` parties, then 1st item in the list conceptually becomes **Second Notify Party** (`N2`) and any other items in the list conceptually becomes **Other Notify Party** (`NI`). The `Consignee` or `Endorsee` conceptually becomes **First Notify Party** (`N1`). Any visual representation (e.g. in a PDF) of the `Consignee` / `Endorsee` as a NotifyParty is not prescribed by the standard (e.g it can be the text: "Same as Consignee/Endorsee" or a copy of the Consignee/Endorsee, etc).
items:
$ref: '#/components/schemas/NotifyParty'
other:
Expand Down
16 changes: 14 additions & 2 deletions ebl/v3/issuance/EBL_ISS_v3.0.4.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3463,6 +3463,11 @@ components:
description: |
A purchase order reference linked to the `Consignee`.
example: HHL007
isNotifyParty:
type: boolean
description: |
Indicates whether the Consignee is also a NotifyParty with identical information. If set to `true` a conceptual 1st notify party identical to the Consignee will exist (any existing 1st NotifyParty conceptually becomes 2nd NotifyParty, any existing 2nd NotifyParty conceptually becomes OtherNotifyParty). The NotifyParty-object will not be affected. Setting this property to `true` does not prescribe what should appear on the printed B/L.
example: true
required:
- partyName
- identifyingCodes
Expand Down Expand Up @@ -3592,6 +3597,11 @@ components:
A list of contact details
items:
$ref: '#/components/schemas/PartyContactDetail'
isNotifyParty:
type: boolean
description: |
Indicates whether the Endorsee is also a NotifyParty with identical information. If set to `true` a conceptual 1st notify party identical to the Endorsee will exist (any existing 1st NotifyParty conceptually becomes 2nd NotifyParty, any existing 2nd NotifyParty conceptually becomes OtherNotifyParty). The NotifyParty-object will not be affected. Setting this property to `true` does not prescribe what should appear on the printed B/L.
example: true
required:
- partyName
- identifyingCodes
Expand Down Expand Up @@ -4007,8 +4017,10 @@ components:
List of up to 3 `Notify Parties`. The first item in the list is the **First Notify Party** (`N1`), the second item is the **Second Notify Party** (`N2`) and the last item is the **Other Notify Party** (`NI`).

**Conditions:** If provided:
- mandatory for To Order BLs, `isToOrder=true`
- the order of the items in this array **MUST** be preserved as by the provider of the API.
- Mandatory for To Order BLs, `isToOrder=true`, unless `isNotifyParty` in `Consignee` or `Endorsee` is set to `true`, in which case the `notifyParties` property can be omitted.
- The order of the items in this array **MUST** be preserved as by the provider of the API.
Comment thread
HenrikHL marked this conversation as resolved.

**Note:** If `isNotifyParty` is set in either `Consignee` or `Endorsee` parties, then 1st item in the list conceptually becomes **Second Notify Party** (`N2`) and any other items in the list conceptually becomes **Other Notify Party** (`NI`). The `Consignee` or `Endorsee` conceptually becomes **First Notify Party** (`N1`). Any visual representation (e.g. in a PDF) of the `Consignee` / `Endorsee` as a NotifyParty is not prescribed by the standard (e.g it can be the text: "Same as Consignee/Endorsee" or a copy of the Consignee/Endorsee, etc).
items:
$ref: '#/components/schemas/NotifyParty'
other:
Expand Down
16 changes: 14 additions & 2 deletions pint/v3/EBL_PINT_v3.0.0.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4210,6 +4210,11 @@ components:
description: |
A purchase order reference linked to the `Consignee`.
example: HHL007
isNotifyParty:
type: boolean
description: |
Indicates whether the Consignee is also a NotifyParty with identical information. If set to `true` a conceptual 1st notify party identical to the Consignee will exist (any existing 1st NotifyParty conceptually becomes 2nd NotifyParty, any existing 2nd NotifyParty conceptually becomes OtherNotifyParty). The NotifyParty-object will not be affected. Setting this property to `true` does not prescribe what should appear on the printed B/L.
example: true
required:
- partyName
- identifyingCodes
Expand Down Expand Up @@ -4339,6 +4344,11 @@ components:
A list of contact details
items:
$ref: '#/components/schemas/PartyContactDetail'
isNotifyParty:
type: boolean
description: |
Indicates whether the Endorsee is also a NotifyParty with identical information. If set to `true` a conceptual 1st notify party identical to the Endorsee will exist (any existing 1st NotifyParty conceptually becomes 2nd NotifyParty, any existing 2nd NotifyParty conceptually becomes OtherNotifyParty). The NotifyParty-object will not be affected. Setting this property to `true` does not prescribe what should appear on the printed B/L.
example: true
required:
- partyName
- identifyingCodes
Expand Down Expand Up @@ -4673,8 +4683,10 @@ components:
List of up to 3 `Notify Parties`. The first item in the list is the **First Notify Party** (`N1`), the second item is the **Second Notify Party** (`N2`) and the last item is the **Other Notify Party** (`NI`).

**Conditions:** If provided:
- mandatory for To Order BLs, `isToOrder=true`
- the order of the items in this array **MUST** be preserved as by the provider of the API.
- Mandatory for To Order BLs, `isToOrder=true`, unless `isNotifyParty` in `Consignee` or `Endorsee` is set to `true`, in which case the `notifyParties` property can be omitted.
- The order of the items in this array **MUST** be preserved as by the provider of the API.
Comment thread
HenrikHL marked this conversation as resolved.

**Note:** If `isNotifyParty` is set in either `Consignee` or `Endorsee` parties, then 1st item in the list conceptually becomes **Second Notify Party** (`N2`) and any other items in the list conceptually becomes **Other Notify Party** (`NI`). The `Consignee` or `Endorsee` conceptually becomes **First Notify Party** (`N1`). Any visual representation (e.g. in a PDF) of the `Consignee` / `Endorsee` as a NotifyParty is not prescribed by the standard (e.g it can be the text: "Same as Consignee/Endorsee" or a copy of the Consignee/Endorsee, etc).
items:
$ref: '#/components/schemas/NotifyParty'
other:
Expand Down
Loading