Skip to content

Sd 2890 align on names #634

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

Open
HenrikHL wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Sd 2890 align on names #634

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
9d0c7a1
EBL 3.0: SD-2434: Add metadata to correlate TransportDocuments
HenrikHL May 21, 2026
a9268ca
Fix review comments
HenrikHL May 21, 2026
db7c025
BKG 2.0, EBL 3.0: SD-2890: Change Shipper/Carrier to Consumer/Provider
HenrikHL May 21, 2026
46ffb0f
Fix typos
HenrikHL May 21, 2026
c5ca98d
Merge branch 'master' into SD-2890_Align-on-names
HenrikHL May 21, 2026
aaca233
Fix example uri
HenrikHL May 21, 2026
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
40 changes: 20 additions & 20 deletions bkg/v2/BKG_v2.0.5.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ info:
description: |
<h1>DCSA OpenAPI specification for the Booking process</h1>

This API is intended as an API between a carrier and anyone creating a `Booking`. The process includes:
This API is intended as an API between a provider and anyone creating a `Booking`. The process includes:

- Booking request
- Booking update
Expand Down Expand Up @@ -1503,7 +1503,7 @@ paths:
Cancels the Booking or cancels an Amendment
operationId: cancel-booking
description: |
A shipper initiated cancellation of the `Booking` or `Booking Amendment` with the `bookingReference`. The path can contain a `carrierBookingRequestReference` or a `carrierBookingReference`.
A consumer initiated cancellation of the `Booking` or `Booking Amendment` with the `bookingReference`. The path can contain a `carrierBookingRequestReference` or a `carrierBookingReference`.

This endPoint corresponds with **UseCase 11 - Cancel Booking request by shipper**, **UseCase 9 - Cancel amendment to confirmed Booking** or **UseCase 13 - Cancel confirmed Booking by shipper**.

Expand Down Expand Up @@ -2469,7 +2469,7 @@ components:
- `PENDING_AMENDMENT` (An amendment is required to the Booking)
- `REJECTED` (Booking discontinued by carrier before it has been Confirmed)
- `DECLINED` (Booking discontinued by carrier after it has been Confirmed)
- `CANCELLED` (Booking discontinued by consumer)
- `CANCELLED` (Booking discontinued by shipper)
- `COMPLETED` (The Transport Document this Booking is connected to has been Surrendered for Delivery)
example: RECEIVED
amendedBookingStatus:
Expand All @@ -2480,17 +2480,17 @@ components:

- `AMENDMENT_RECEIVED` (An amendment has been received and is awaiting to be processed)
- `AMENDMENT_CONFIRMED` (Amendment is confirmed)
- `AMENDMENT_DECLINED` (Amendment discontinued by provider)
- `AMENDMENT_CANCELLED` (Amendment discontinued by consumer)
- `AMENDMENT_DECLINED` (Amendment discontinued by carrier)
- `AMENDMENT_CANCELLED` (Amendment discontinued by shipper)
example: AMENDMENT_RECEIVED
bookingCancellationStatus:
type: string
maxLength: 50
description: |
The status of the latest booking cancellation. If no cancellation has been requested - then this property is empty. Possible values are:
- `CANCELLATION_RECEIVED` (A request to cancel a Confirmed Booking has been received and is awaiting to be processed)
- `CANCELLATION_DECLINED` (Cancellation of the Confirmed Booking has been declined by provider)
- `CANCELLATION_CONFIRMED` (Cancellation of the Confirmed Booking has been confirmed by provider)
- `CANCELLATION_DECLINED` (Cancellation of the Confirmed Booking has been declined by carrier)
- `CANCELLATION_CONFIRMED` (Cancellation of the Confirmed Booking has been confirmed by carrier)
example: CANCELLATION_RECEIVED
carrierBookingRequestReference:
type: string
Expand Down Expand Up @@ -3148,20 +3148,20 @@ components:
transportDocumentReferences:
type: array
description: |
An array of `transportDocumentReference` requested by the Shipper to be associated to this Booking.
An array of `transportDocumentReference` requested by the shipper to be associated to this Booking.
items:
type: string
pattern: ^\S(?:.*\S)?$
maxLength: 20
description: |
The `transportDocumentReference` requested by the Shipper to be associated to this Booking.
The `transportDocumentReference` requested by the shipper to be associated to this Booking.
example: reserved-HHL123
requestedNumberOfTransportDocuments:
type: integer
format: int32
minimum: 1
description: |
The number of `Transport Documents` requested to be linked to this Booking by the Shipper.
The number of `Transport Documents` requested to be linked to this Booking by the shipper.
example: 3
bookingChannelReference:
type: string
Expand Down Expand Up @@ -3550,20 +3550,20 @@ components:
transportDocumentReferences:
type: array
description: |
An array of `transportDocumentReference` requested by the Shipper to be associated to this Booking.
An array of `transportDocumentReference` requested by the shipper to be associated to this Booking.
items:
type: string
pattern: ^\S(?:.*\S)?$
maxLength: 20
description: |
The `transportDocumentReference` requested by the Shipper to be associated to this Booking.
The `transportDocumentReference` requested by the shipper to be associated to this Booking.
example: reserved-HHL123
requestedNumberOfTransportDocuments:
type: integer
format: int32
minimum: 1
description: |
The number of `Transport Documents` requested to be linked to this Booking by the Shipper.
The number of `Transport Documents` requested to be linked to this Booking by the shipper.
example: 3
bookingChannelReference:
type: string
Expand Down Expand Up @@ -3728,7 +3728,7 @@ components:
- `PENDING_AMENDMENT` (An amendment is required to the Booking)
- `REJECTED` (Booking discontinued by carrier before it has been Confirmed)
- `DECLINED` (Booking discontinued by carrier after it has been Confirmed)
- `CANCELLED` (Booking discontinued by consumer)
- `CANCELLED` (Booking discontinued by shipper)
- `COMPLETED` (The Transport Document this Booking is connected to has been Surrendered for Delivery)
example: RECEIVED
amendedBookingStatus:
Expand All @@ -3738,17 +3738,17 @@ components:
The status of latest amendment added to the `Booking`. If no amendment has been requested - then this field is empty. Possible values are:
- `AMENDMENT_RECEIVED` (An amendment has been received and is awaiting to be processed)
- `AMENDMENT_CONFIRMED` (Amendment is confirmed)
- `AMENDMENT_DECLINED` (Amendment discontinued by provider)
- `AMENDMENT_CANCELLED` (Amendment discontinued by consumer)
- `AMENDMENT_DECLINED` (Amendment discontinued by carrier)
- `AMENDMENT_CANCELLED` (Amendment discontinued by shipper)
example: AMENDMENT_RECEIVED
bookingCancellationStatus:
type: string
maxLength: 50
description: |
The status of the latest booking cancellation. If no cancellation has been requested - then this property is empty. Possible values are:
- `CANCELLATION_RECEIVED` (A request to cancel a Confirmed Booking has been received and is awaiting to be processed)
- `CANCELLATION_DECLINED` (Cancellation of the Confirmed Booking has been declined by provider)
- `CANCELLATION_CONFIRMED` (Cancellation of the Confirmed Booking has been confirmed by provider)
- `CANCELLATION_DECLINED` (Cancellation of the Confirmed Booking has been declined by carrier)
- `CANCELLATION_CONFIRMED` (Cancellation of the Confirmed Booking has been confirmed by carrier)
example: CANCELLATION_RECEIVED
receiptTypeAtOrigin:
type: string
Expand Down Expand Up @@ -4034,7 +4034,7 @@ components:
format: int32
minimum: 1
description: |
The number of `Transport Documents` requested to be linked to this Booking by the Shipper.
The number of `Transport Documents` requested to be linked to this Booking by the shipper.
example: 3
bookingChannelReference:
type: string
Expand Down Expand Up @@ -5054,7 +5054,7 @@ components:
type: string
maxLength: 150
description: |
Code to identify the party as provided by the code list provider
Code to identify the party as provided by the `codeListProvider`.
example: MSK
codeListName:
type: string
Expand Down
Loading
Loading