This is a technical implementation guide to the DCSA electronic Bill of Lading (EBL) standard version 3.0. The audience of this document is technical teams of DCSA adopting organizations.
POST
request to create a Shipping Instructions.GET
response.202
(Accepted) containing only the shippingInstructionsReference
.RECEIVED
)GET
request to retrieve the Shipping Instructions.202
(Accepted) / 404
(Not Found) / 409
(Conflict) without content.updatedContent=true
(before Shipping Instructions is in state RECEIVED
)GET
request with the updatedContent
query parameter set to true
to retrieve the updated Shipping Instructions.404
(Not Found) as no update exists.RECEIVED
)GET
Transport Document request to retrieve the Transport Document.404
(Not Found) as no Transport Document exists.RECEIVED
.shippingInstructions
property) is included, also containing feedbackINFO
feedback in the root but not within the Shipping Instructions, or the other way around).id
or previous notification id
can be reused.
RECEIVED
)GET
request to retrieve the Shipping Instructions.200
(Ok) with the content of the Shipping Instructions (or a 202
(Accepted) / 409
(Conflict) in case the Carrier is in the middle of processing the Shipping Instructions).
Feedbacks
property in the Shipping Instructions.GET
requests MAY return different feedback (e.g. the Carrier MAY still be processing the Shipping Instructions asynchronously).updatedContent=true
(after Shipping Instructions is in state RECEIVED
)GET
request with the updatedContent
query parameter set to true
to retrieve the updated Shipping Instructions.404
(Not Found) as no update exists.RECEIVED
)GET
Transport Document request to retrieve the Transport Document.200
(Ok) with the content of the Transport Document (or a 202
(Accepted) in case the Carrier is in the middle of processing the Transport Document).404
(Not Found).Back to Table of Content ⬆️
PENDING_UPDATE
.Shipping Instructions
property) is included, MUST also contain feedback.INFO
feedback in the root but not within the Shipping Instructions, or the other way around).id
or previous notification id
can be reused.
PENDING_UPDATE
)GET
request to retrieve the Shipping Instructions.200
(Ok) with the content of the Shipping Instructions (or a 202
(Accepted) / 409
(Conflict) in case the Carrier is in the middle of processing the Shipping Instructions).
GET
requests MAY return different feedback (e.g. the Carrier MAY still be processing the Shipping Instructions asynchronously).updatedContent=true
(after Shipping Instructions is in state PENDING_UPDATE
)GET
request with the updatedContent
query parameter set to true
to retrieve the updated Shipping Instructions.404
(Not Found) as no update exists after the status has changed to PENDING_UPDATE
.PENDING_UPDATE
)GET
Transport Document request to retrieve the Transport Document.200
(Ok) with the content of the Transport Document (or a 202
(Accepted) in case the Carrier is in the middle of processing the Transport Document).404
(Not Found).PUT
request to update a Shipping Instructions.GET
response.202
(Accepted).
404
(Not Found) is returned if the carrierBookingRequestReference
is not known.409
(Conflict) is returned if the Carrier is processing a Shipping Instructions request.RECEIVED
or PENDING_UPDATE
).RECEIVED
and updated Shipping Instructions is not yet in state UPDATE_RECEIVED
)GET
request to retrieve the Shipping Instructions.200
(Ok) with the content of the Shipping Instructions (or a 202
(Accepted) / 409
(Conflict) in case the Carrier is in the middle of processing the Shipping Instructions).
GET
requests MAY return different feedback (e.g. the Carrier MAY still be processing the Shipping Instructions asynchronously).PENDING_UPDATE
and updated Shipping Instructions is not yet in state UPDATE_RECEIVED
)GET
request to retrieve the Shipping Instructions.200
(Ok) with the content of the Shipping Instructions (or a 202
(Accepted) / 409
(Conflict) in case the Carrier is in the middle of processing the Shipping Instructions).
GET
requests MAY return different feedback (e.g. the Carrier MAY still be processing the Shipping Instructions asynchronously).updatedContent=true
(Shipping Instructions is in state RECEIVED
or PENDING_UPDATE
and before updated Shipping Instructions is in state UPDATE_RECEIVED
)GET
request with the updatedContent
query parameter set to true
to retrieve the updated Shipping Instructions.404
(Not Found) as no update exists after the status has changed to PENDING_UPDATE
and before the update is in state UPDATE_RECEIVED
.RECEIVED
or PENDING_UPDATE
and before updated Shipping Instructions is in state UPDATE_RECEIVED
)GET
Transport Document request to retrieve the Transport Document.200
(Ok) with the content of the Transport Document (or a 202
(Accepted) in case the Carrier is in the middle of processing the Transport Document).404
(Not Found).UPDATE_RECEIVED
(the Shipping Instructions state is unchanged).Shipping Instructions
property) is included, also containing feedback (mandatory if Shipping Instructions state is PENDING_UPDATE
and optional if the Shipping Instructions state is RECEIVED
)Updated Shipping Instructions
property) is included, optionally containing feedbackINFO
feedback in the root but not within the updated Shipping Instructions, or the other way around).id
or previous notification id
can be reused.
UPDATE_RECEIVED
)GET
request to retrieve the Shipping Instructions.200
(Ok) with the content of the Shipping Instructions (or a 202
(Accepted) / 409
(Conflict) in case the Carrier is in the middle of processing the Shipping Instructions).
GET
requests MAY return different feedback (e.g. the Carrier MAY still be processing the Shipping Instructions asynchronously).updatedContent=true
(after updated Shipping Instructions is in state UPDATE_RECEIVED
)GET
request with the updatedContent
query parameter set to true
to retrieve the updated Shipping Instructions.200
(Ok) with the content of the updated Shipping Instructions (or a 202
(Accepted) / 409
(Conflict) in case the Carrier is in the middle of processing the updated Shipping Instructions).
GET
requests MAY return different feedback (e.g. the Carrier MAY still be processing the updated Shipping Instructions asynchronously).RECEIVED
or PENDING_UPDATE
and before updated Shipping Instructions is in state UPDATE_RECEIVED
)GET
Transport Document request to retrieve the Transport Document.200
(Ok) with the content of the Transport Document (or a 202
(Accepted) in case the Carrier is in the middle of processing the Transport Document).404
(Not Found).The Carrier changes the Shipping Instructions state to RECEIVED
.
The Carrier changes the updated Shipping Instructions state to UPDATE_CONFIRMED
.
The update now becomes the confirmed Shipping Instructions (the Shipping Instructions
property and the Updated Shipping Instructions
property now contain the same value).
The Carrier sends a notification to the Shipper.
Shipping Instructions
property) is included, also containing optional feedback connected to the Shipping InstructionsUpdated Shipping Instructions
property) is included, also containing optional feedback connected to the updateINFO
feedback in the root but not within the Shipping Instructions, or the other way around).The Carrier MAY resend the notification, a different notification id
or previous notification id
can be reused.
The Carrier leaves the Shipping Instructions state unchanged (it can be RECEIVED
or PENDING_UPDATE
)
The Carrier changes the updated Shipping Instructions state to UPDATE_DECLINED
.
The Carrier sends a notification to the Shipper.
Shipping Instructions
property) is included, also containing optional feedback connected to the Shipping InstructionsUpdated Shipping Instructions
property) is included, also containing optional feedback connected to the updateINFO
feedback in the root but not within the Shipping Instructions, or the other way around).The Carrier MAY resend the notification, a different notification id
or previous notification id
can be reused.
xxx
CONFIRMED
.AMENDMENT_CONFIRMED
.booking
property and the amendedBooking
property now contain the same value).
@george: maybe you have a better way of writing this?booking
property) is included, also containing optional feedback connected to the confirmed bookingamendedBooking
property) is included, also containing optional feedback connected to the amendmentINFO
feedback in the root but not within the booking, or the other way around).id
or previous notification id
can be reused.
AMENDMENT_CONFIRMED
)GET
request to retrieve the Shipping Instructions.200
(Ok) with the content of the Shipping Instructions (or a 202
(Accepted) / 409
(Conflict) in case the Carrier is in the middle of processing the Shipping Instructions).
GET
requests MAY return different feedback (e.g. the Carrier MAY still be processing the Shipping Instructions asynchronously).updatedContent=true
(after updated Shipping Instructions is in state AMENDMENT_CONFIRMED
)The Shipper sends a GET
request with the updatedContent
query parameter set to true
to retrieve the updated Shipping Instructions.
The Carrier responds with 200
(Ok) with the content of the updated Shipping Instructions (or a 202
(Accepted) / 409
(Conflict) in case the Carrier is in the middle of processing the Shipping Instructions).
Subsequent GET
requests MAY return different feedback (e.g. the Carrier MAY still be processing the Shipping Instructions asynchronously).
@george: not sure about the above sentence
The Shipper sends a PUT
request to update a Shipping Instructions.
The Carrier MUST perform the schema validation, to ensure that if it accepts the Shipping Instructions it can subsequently return it as a valid GET
response.
The Carrier MAY also perform other validations or processing synchronously, optionally resulting in the collection of feedback.
If validations succeed, the Carrier responds with an empty 202
(Accepted).
404
(Not Found) is returned if the carrierBookingRequestReference
is not known.409
(Conflict) is returned if the Carrier is processing a Shipping Instructions request.Shipping Instructions state is unchanged (it is still in RECEIVED
or PENDING_UPDATE
).
The Carrier changes the Shipping Instructions state to REJECTED
.
The Carrier sends a notification to the Shipper.
Shipping Instructions
property) is included, also containing feedbackINFO
feedback in the root but not within the Shipping Instructions, or the other way around).The Carrier MAY resend the notification, a different notification id
or previous notification id
can be reused.
REJECTED
)GET
request to retrieve the Shipping Instructions.200
(Ok) with the content of the Shipping Instructions (or a 202
(Accepted) / 409
(Conflict) in case the Carrier is in the middle of processing the Shipping Instructions).
GET
requests MAY return different feedback (e.g. the Carrier MAY still be processing the Shipping Instructions asynchronously).updatedContent=true
(after Shipping Instructions is in state REJECTED
)GET
request with the updatedContent
query parameter set to true
to retrieve the updated Shipping Instructions.404
(Not Found) as no update exists before the Shipping Instructions is confirmed.CONFIRMED
.amendedBooking
state.bookingCancellation
state.amendedBooking
state and bookingCancellation
state.Shipping Instructions
property) is included, also containing feedbackamendedBooking
property) is clearedINFO
feedback in the root but not within the Shipping Instructions, or the other way around).id
or previous notification id
can be reused.
amendedBooking
property) is clearedCONFIRMED
)GET
request to retrieve the Shipping Instructions.200
(Ok) with the content of the Shipping Instructions (or a 202
(Accepted) / 409
(Conflict) in case the Carrier is in the middle of processing the Shipping Instructions).
GET
requests MAY return different feedback (e.g. the Carrier MAY still be processing the Shipping Instructions asynchronously).updatedContent=true
(after Shipping Instructions is in state CONFIRMED
)GET
request with the updatedContent
query parameter set to true
to retrieve the updated Shipping Instructions.200
(Ok) with the content of the updated Shipping Instructions (or a 202
(Accepted) / 409
(Conflict) in case the Carrier is in the middle of processing the Shipping Instructions).
404
(Not Found)GET
requests MAY return different feedback (e.g. the Carrier MAY still be processing the Shipping Instructions asynchronously).PENDING_AMENDMENT
.amendedBooking
state.bookingCancellation
state.Shipping Instructions
property) is included, it MUST contain feedback.amendedBooking
property) is cleared.INFO
feedback in the root but not within the Shipping Instructions, or the other way around).id
or previous notification id
can be reused.
PENDING_AMENDMENT
)GET
request to retrieve the Shipping Instructions.200
(Ok) with the content of the Shipping Instructions (or a 202
(Accepted) / 409
(Conflict) in case the Carrier is in the middle of processing the Shipping Instructions).
GET
requests MAY return different feedback (e.g. the Carrier MAY still be processing the Shipping Instructions asynchronously).updatedContent=true
(after Shipping Instructions is in state PENDING_AMENDMENT
)GET
request with the updatedContent
query parameter set to true
to retrieve the updated Shipping Instructions.404
(Not Found) as a possible update has been cleared.PUT
request to update a Shipping Instructions.GET
response.202
(Accepted).
404
(Not Found) is returned if the carrierBookingReference
is not known.409
(Conflict) is returned if the Carrier is processing a Shipping Instructions request.CONFIRMED
or PENDING_AMENDMENT
).AMENDMENT_CONFIRMED
, AMENDMENT_DECLINED
or {empty} in case there is no ongoing update).CONFIRMED
and before it is in AMENDMENT_RECEIVED
)GET
request to retrieve the Shipping Instructions.200
(Ok) with the content of the confirmed Shipping Instructions (not the update) (or a 202
(Accepted) / 409
(Conflict) in case the Carrier is in the middle of processing the Shipping Instructions).
GET
requests MAY return different feedback (e.g. the Carrier MAY still be processing the Shipping Instructions asynchronously).PENDING_AMENDMENT
and before it is in AMENDMENT_RECEIVED
)GET
request to retrieve the Shipping Instructions.200
(Ok) with the content of the confirmed Shipping Instructions (not the update) (or a 202
(Accepted) / 409
(Conflict) in case the Carrier is in the middle of processing the Shipping Instructions).
GET
requests MAY return different feedback (e.g. the Carrier MAY still be processing the Shipping Instructions asynchronously).updatedContent=true
(Shipping Instructions is in state CONFIRMED
and before it is in AMENDMENT_RECEIVED
)GET
request with the updatedContent
query parameter set to true
to retrieve the updated Shipping Instructions.200
(Ok) with the content of the confirmed or declined update (or a 202
(Accepted) / 409
(Conflict) in case the Carrier is in the middle of processing the Shipping Instructions).
GET
requests MAY return different feedback (e.g. the Carrier MAY still be processing the Shipping Instructions asynchronously).
@george: not sure about the above sentence404
(Not Found) as there is no update (or a 202
(Accepted) / 409
(Conflict) in case the Carrier is in the middle of processing the Shipping Instructions).updatedContent=true
(Shipping Instructions is in state PENDING_AMENDMENT
and before it is in AMENDMENT_RECEIVED
)GET
request with the updatedContent
query parameter set to true
to retrieve the updated Shipping Instructions.404
(Not Found) as there is no update.CONFIRMED
or PENDING_AMENDMENT
).AMENDMENT_RECEIVED
.Shipping Instructions
property) is included, also containing optional feedback connected to the confirmed Shipping Instructions (if the confirmed Shipping Instructions is in state PENDING_AMENDMENT
- the feedback is mandatory)amendedBooking
property) is included, also containing optional feedback connected to the updateINFO
feedback in the root but not within the Shipping Instructions, or the other way around).id
or previous notification id
can be reused.
AMENDMENT_RECEIVED
)GET
request to retrieve the confirmed Shipping Instructions.200
(Ok) with the content of the confirmed Shipping Instructions (or a 202
(Accepted) / 409
(Conflict) in case the Carrier is in the middle of processing the Shipping Instructions).
PENDING_AMENDMENT
- the feedback is mandatory)GET
requests MAY return different feedback (e.g. the Carrier MAY still be processing the Shipping Instructions asynchronously).
@george: not sure about the above sentenceupdatedContent=true
(after updated Shipping Instructions is in state AMENDMENT_RECEIVED
)GET
request with the updatedContent
query parameter set to true
to retrieve the updated Shipping Instructions.200
(Ok) with the content of the updated Shipping Instructions (or a 202
(Accepted) / 409
(Conflict) in case the Carrier is in the middle of processing the Shipping Instructions).
GET
requests MAY return different feedback (e.g. the Carrier MAY still be processing the Shipping Instructions asynchronously).CONFIRMED
.AMENDMENT_CONFIRMED
.Shipping Instructions
property and the amendedBooking
property now contain the same value).
@george: maybe you have a better way of writing this?Shipping Instructions
property) is included, also containing optional feedback connected to the confirmed Shipping InstructionsamendedBooking
property) is included, also containing optional feedback connected to the updateINFO
feedback in the root but not within the Shipping Instructions, or the other way around).id
or previous notification id
can be reused.
AMENDMENT_CONFIRMED
)GET
request to retrieve the Shipping Instructions.200
(Ok) with the content of the Shipping Instructions (or a 202
(Accepted) / 409
(Conflict) in case the Carrier is in the middle of processing the Shipping Instructions).
GET
requests MAY return different feedback (e.g. the Carrier MAY still be processing the Shipping Instructions asynchronously).updatedContent=true
(after updated Shipping Instructions is in state AMENDMENT_CONFIRMED
)GET
request with the updatedContent
query parameter set to true
to retrieve the updated Shipping Instructions.200
(Ok) with the content of the updated Shipping Instructions (or a 202
(Accepted) / 409
(Conflict) in case the Carrier is in the middle of processing the Shipping Instructions).
GET
requests MAY return different feedback (e.g. the Carrier MAY still be processing the Shipping Instructions asynchronously).
@george: not sure about the above sentenceCONFIRMED
or PENDING_AMENDMENT
).AMENDMENT_DECLINED
.Shipping Instructions
property) is included, also containing optional feedback connected to the confirmed Shipping Instructions (if the confirmed Shipping Instructions is in state PENDING_AMENDMENT
- the feedback is mandatory)amendedBooking
property) is included, also containing optional feedback connected to the updateINFO
feedback in the root but not within the Shipping Instructions, or the other way around).id
or previous notification id
can be reused.
AMENDMENT_DECLINED
)GET
request to retrieve the Shipping Instructions.200
(Ok) with the content of the confirmed Shipping Instructions (or a 202
(Accepted) / 409
(Conflict) in case the Carrier is in the middle of processing the Shipping Instructions).
PENDING_AMENDMENT
- the feedback is mandatory)GET
requests MAY return different feedback (e.g. the Carrier MAY still be processing the Shipping Instructions asynchronously).updatedContent=true
(after updated Shipping Instructions is in state AMENDMENT_DECLINED
)GET
request with the updatedContent
query parameter set to true
to retrieve the updated Shipping Instructions.200
(Ok) with the content of the updated Shipping Instructions (or a 202
(Accepted) / 409
(Conflict) in case the Carrier is in the middle of processing the Shipping Instructions).
GET
requests MAY return different feedback (e.g. the Carrier MAY still be processing the Shipping Instructions asynchronously).
@george: not sure about the above sentencePATCH
request to cancel a Shipping Instructions update.202
(Accepted).
404
(Not Found) is returned if the carrierBookingReference
is not known.409
(Conflict) is returned if the Carrier is processing a Shipping Instructions request.CONFIRMED
or PENDING_AMENDMENT
).AMENDMENT_RECEIVED
).CONFIRMED
or PENDING_AMENDMENT
and before it is in AMENDMENT_CANCELLED
)GET
request to retrieve the Shipping Instructions.200
(Ok) with the content of the confirmed Shipping Instructions (or a 202
(Accepted) / 409
(Conflict) in case the Carrier is in the middle of processing the Shipping Instructions).
PENDING_AMENDMENT
- the feedback is mandatory)GET
requests MAY return different feedback (e.g. the Carrier MAY still be processing the Shipping Instructions asynchronously).updatedContent=true
(Shipping Instructions is in state CONFIRMED
or PENDING_AMENDMENT
and before it is in AMENDMENT_CANCELLED
)GET
request with the updatedContent
query parameter set to true
to retrieve the updated Shipping Instructions.200
(Ok) with the content of the updated Shipping Instructions (or a 202
(Accepted) / 409
(Conflict) in case the Carrier is in the middle of processing the Shipping Instructions).
GET
requests MAY return different feedback (e.g. the Carrier MAY still be processing the Shipping Instructions asynchronously).CONFIRMED
or PENDING_AMENDMENT
).AMENDMENT_CANCELLED
.Shipping Instructions
property) is included, also containing optional feedback connected to the confirmed Shipping Instructions (if the confirmed Shipping Instructions is in state PENDING_AMENDMENT
- the feedback is mandatory)amendedBooking
property) is included, also containing optional feedback connected to the updateINFO
feedback in the root but not within the Shipping Instructions, or the other way around).id
or previous notification id
can be reused.
AMENDMENT_CANCELLED
)GET
request to retrieve the Shipping Instructions.200
(Ok) with the content of the confirmed Shipping Instructions (or a 202
(Accepted) / 409
(Conflict) in case the Carrier is in the middle of processing the Shipping Instructions).
PENDING_AMENDMENT
- the feedback is mandatory)GET
requests MAY return different feedback (e.g. the Carrier MAY still be processing the Shipping Instructions asynchronously).updatedContent=true
(after updated Shipping Instructions is in state AMENDMENT_CANCELLED
)GET
request with the updatedContent
query parameter set to true
to retrieve the updated Shipping Instructions.200
(Ok) with the content of the updated Shipping Instructions (or a 202
(Accepted) / 409
(Conflict) in case the Carrier is in the middle of processing the Shipping Instructions).
GET
requests MAY return different feedback (e.g. the Carrier MAY still be processing the Shipping Instructions asynchronously).CONFIRMED
or PENDING_AMENDMENT
).AMENDMENT_RECEIVED
.Shipping Instructions
property) is included, also containing optional feedback connected to the confirmed Shipping Instructions (if the confirmed Shipping Instructions is in state PENDING_AMENDMENT
- the feedback is mandatory)amendedBooking
property) is included, also containing optional feedback connected to the updateINFO
feedback in the root but not within the Shipping Instructions, or the other way around).id
or previous notification id
can be reused.
AMENDMENT_RECEIVED
)GET
request to retrieve the Shipping Instructions.200
(Ok) with the content of the confirmed Shipping Instructions (or a 202
(Accepted) / 409
(Conflict) in case the Carrier is in the middle of processing the Shipping Instructions).
PENDING_AMENDMENT
- the feedback is mandatory)GET
requests MAY return different feedback (e.g. the Carrier MAY still be processing the Shipping Instructions asynchronously).updatedContent=true
(after amended cancellation is declined and updated Shipping Instructions is in state AMENDMENT_RECEIVED
)GET
request with the updatedContent
query parameter set to true
to retrieve the updated Shipping Instructions.200
(Ok) with the content of the updated Shipping Instructions (or a 202
(Accepted) / 409
(Conflict) in case the Carrier is in the middle of processing the Shipping Instructions).
GET
requests MAY return different feedback (e.g. the Carrier MAY still be processing the Shipping Instructions asynchronously).DECLINED
.AMENDMENT_DECLINED
.Shipping Instructions
property) is included, also containing optional feedback connected to the confirmed Shipping InstructionsamendedBooking
property) is included, also containing optional feedback connected to the updateINFO
feedback in the root but not within the Shipping Instructions, or the other way around).id
or previous notification id
can be reused.
DECLINED
)GET
request to retrieve the Shipping Instructions.200
(Ok) with the content of the confirmed Shipping Instructions (or a 202
(Accepted) / 409
(Conflict) in case the Carrier is in the middle of processing the Shipping Instructions).
GET
requests MAY return different feedback (e.g. the Carrier MAY still be processing the Shipping Instructions asynchronously).updatedContent=true
(after Shipping Instructions is in state `DECLINED)GET
request with the updatedContent
query parameter set to true
to retrieve the updated Shipping Instructions.200
(Ok) with the content of the updated Shipping Instructions (or a 202
(Accepted) / 409
(Conflict) in case the Carrier is in the middle of processing the Shipping Instructions).
GET
requests MAY return different feedback (e.g. the Carrier MAY still be processing the Shipping Instructions asynchronously).404
(Not Found) as there is no update (or a 202
(Accepted) / 409
(Conflict) in case the Carrier is in the middle of processing the Shipping Instructions).PATCH
request to cancel a Shipping Instructions.202
(Accepted).
404
(Not Found) is returned if the carrierBookingRequestReference
is not known.409
(Conflict) is returned if the Carrier is processing a Shipping Instructions request.RECEIVED
, PENDING_UPDATE
or UPDATE_RECEIVED
).RECEIVED
, PENDING_UPDATE
or UPDATE_RECEIVED
and before it is in state CANCELLED
)GET
request to retrieve the Shipping Instructions.200
(Ok) with the content of the confirmed Shipping Instructions (or a 202
(Accepted) / 409
(Conflict) in case the Carrier is in the middle of processing the Shipping Instructions).
PENDING_UPDATE
- the feedback is mandatory)GET
requests MAY return different feedback (e.g. the Carrier MAY still be processing the Shipping Instructions asynchronously).updatedContent=true
(Shipping Instructions is in state RECEIVED
, PENDING_UPDATE
or UPDATE_RECEIVED
and before it is in state CANCELLED
)GET
request with the updatedContent
query parameter set to true
to retrieve the updated Shipping Instructions.404
(Not Found) as no update exists before the Shipping Instructions is confirmed.CANCELLED
).Shipping Instructions
property) is included, also containing optional feedback (if the confirmed Shipping Instructions is in state PENDING_UPDATE
- the feedback is mandatory)INFO
feedback in the root but not within the Shipping Instructions, or the other way around).id
or previous notification id
can be reused.
CANCELLED
)GET
request to retrieve the Shipping Instructions.200
(Ok) with the content of the confirmed Shipping Instructions (or a 202
(Accepted) / 409
(Conflict) in case the Carrier is in the middle of processing the Shipping Instructions).
GET
requests MAY return different feedback (e.g. the Carrier MAY still be processing the Shipping Instructions asynchronously).updatedContent=true
(Shipping Instructions is in state CANCELLED
)GET
request with the updatedContent
query parameter set to true
to retrieve the updated Shipping Instructions.404
(Not Found) as no update exists before the Shipping Instructions is confirmed.RECEIVED
, PENDING_UPDATE
or UPDATE_RECEIVED
).Shipping Instructions
property) is included, also containing optional feedback (if the confirmed Shipping Instructions is in state PENDING_UPDATE
- the feedback is mandatory)INFO
feedback in the root but not within the Shipping Instructions, or the other way around).id
or previous notification id
can be reused.
RECEIVED
, PENDING_UPDATE
or UPDATE_RECEIVED
)GET
request to retrieve the Shipping Instructions.200
(Ok) with the content of the confirmed Shipping Instructions (or a 202
(Accepted) / 409
(Conflict) in case the Carrier is in the middle of processing the Shipping Instructions).
PENDING_UPDATE
- the feedback is mandatory)GET
requests MAY return different feedback (e.g. the Carrier MAY still be processing the Shipping Instructions asynchronously).updatedContent=true
(Shipping Instructions is in state RECEIVED
, PENDING_UPDATE
or UPDATE_RECEIVED
)GET
request with the updatedContent
query parameter set to true
to retrieve the updated Shipping Instructions.404
(Not Found) as no update exists before the Shipping Instructions is confirmed.COMPLETED
.Shipping Instructions
property) is included, also containing optional feedback connected to the confirmed Shipping InstructionsamendedBooking
property) is included, also containing optional feedback connected to the updateINFO
feedback in the root but not within the Shipping Instructions, or the other way around).id
or previous notification id
can be reused.
COMPLETED
)GET
request to retrieve the completed Shipping Instructions.200
(Ok) with the content of the confirmed Shipping Instructions (or a 202
(Accepted) / 409
(Conflict) in case the Carrier is in the middle of processing the Shipping Instructions).
GET
requests MAY return different feedback (e.g. the Carrier MAY still be processing the Shipping Instructions asynchronously).updatedContent=true
(after Shipping Instructions is in state COMPLETED
)GET
request with the updatedContent
query parameter set to true
to retrieve the updated Shipping Instructions.200
(Ok) with the content of the updated Shipping Instructions (or a 202
(Accepted) / 409
(Conflict) in case the Carrier is in the middle of processing the Shipping Instructions).
GET
requests MAY return different feedback (e.g. the Carrier MAY still be processing the Shipping Instructions asynchronously).404
(Not Found) as there is no update (or a 202
(Accepted) / 409
(Conflict) in case the Carrier is in the middle of processing the Shipping Instructions).PATCH
request to cancel a confirmed Shipping Instructions.202
(Accepted).
404
(Not Found) is returned if the carrierBookingReference
is not known.409
(Conflict) is returned if the Carrier is processing a Shipping Instructions request.CONFIRMED
or PENDING_AMENDMENT
CONFIRMED
or PENDING_AMENDMENT
and before Shipping Instructions cancellation is in CANCELLATION_RECEIVED
)GET
request to retrieve the Shipping Instructions.200
(Ok) with the content of the confirmed Shipping Instructions (or a 202
(Accepted) / 409
(Conflict) in case the Carrier is in the middle of processing the Shipping Instructions).
PENDING_AMENDMENT
- the feedback is mandatory)GET
requests MAY return different feedback (e.g. the Carrier MAY still be processing the Shipping Instructions asynchronously).updatedContent=true
(Shipping Instructions is in state CONFIRMED
or PENDING_AMENDMENT
and before Shipping Instructions cancellation is in CANCELLATION_RECEIVED
)GET
request with the updatedContent
query parameter set to true
to retrieve the updated Shipping Instructions.200
(Ok) with the content of the updated Shipping Instructions (or a 202
(Accepted) / 409
(Conflict) in case the Carrier is in the middle of processing the Shipping Instructions).
GET
requests MAY return different feedback (e.g. the Carrier MAY still be processing the Shipping Instructions asynchronously).404
(Not Found) as there is no update (or a 202
(Accepted) / 409
(Conflict) in case the Carrier is in the middle of processing the Shipping Instructions).CONFIRMED
or PENDING_AMENDMENT
).CANCELLATION_RECEIVED
.Shipping Instructions
property) is included, also containing optional feedback connected to the confirmed Shipping Instructions (if the confirmed Shipping Instructions is in state PENDING_AMENDMENT
- the feedback is mandatory)amendedBooking
property) is included (if it exists), also containing optional feedback connected to the updateINFO
feedback in the root but not within the Shipping Instructions, or the other way around).id
or previous notification id
can be reused.
CANCELLATION_RECEIVED
)GET
request to retrieve the Shipping Instructions.200
(Ok) with the content of the confirmed Shipping Instructions (or a 202
(Accepted) / 409
(Conflict) in case the Carrier is in the middle of processing the Shipping Instructions).
PENDING_AMENDMENT
- the feedback is mandatory)GET
requests MAY return different feedback (e.g. the Carrier MAY still be processing the Shipping Instructions asynchronously).updatedContent=true
(after Shipping Instructions cancellation is in state CANCELLATION_RECEIVED
)GET
request with the updatedContent
query parameter set to true
to retrieve the updated Shipping Instructions.200
(Ok) with the content of the updated Shipping Instructions (or a 202
(Accepted) / 409
(Conflict) in case the Carrier is in the middle of processing the Shipping Instructions).
GET
requests MAY return different feedback (e.g. the Carrier MAY still be processing the Shipping Instructions asynchronously).404
(Not Found) as there is no update (or a 202
(Accepted) / 409
(Conflict) in case the Carrier is in the middle of processing the Shipping Instructions).CANCELLED
.AMENDMENT_CANCELLED
.CANCELLATION_CONFIRMED
.Shipping Instructions
property) is included, also containing optional feedback connected to the confirmed Shipping InstructionsamendedBooking
property) is included (if it exists), also containing optional feedback connected to the updateINFO
feedback in the root but not within the Shipping Instructions, or the other way around).id
or previous notification id
can be reused.
CANCELLATION_CONFIRMED
)GET
request to retrieve the Shipping Instructions.200
(Ok) with the content of the confirmed Shipping Instructions (or a 202
(Accepted) / 409
(Conflict) in case the Carrier is in the middle of processing the Shipping Instructions).
GET
requests MAY return different feedback (e.g. the Carrier MAY still be processing the Shipping Instructions asynchronously).updatedContent=true
(after Shipping Instructions cancellation is in state CANCELLATION_RECEIVED
)GET
request with the updatedContent
query parameter set to true
to retrieve the updated Shipping Instructions.200
(Ok) with the content of the updated Shipping Instructions (or a 202
(Accepted) / 409
(Conflict) in case the Carrier is in the middle of processing the Shipping Instructions).
GET
requests MAY return different feedback (e.g. the Carrier MAY still be processing the Shipping Instructions asynchronously).404
(Not Found) as there is no update (or a 202
(Accepted) / 409
(Conflict) in case the Carrier is in the middle of processing the Shipping Instructions).CONFIRMED
or PENDING_AMENDMENT
).CANCELLATION_DECLINED
.Shipping Instructions
property) is included, also containing optional feedback connected to the confirmed Shipping Instructions (if the confirmed Shipping Instructions is in state PENDING_AMENDMENT
- the feedback is mandatory)amendedBooking
property) is included (if it exists), also containing optional feedback connected to the updateINFO
feedback in the root but not within the Shipping Instructions, or the other way around).id
or previous notification id
can be reused.
CANCELLATION_DECLINED
)GET
request to retrieve the Shipping Instructions.200
(Ok) with the content of the confirmed Shipping Instructions (or a 202
(Accepted) / 409
(Conflict) in case the Carrier is in the middle of processing the Shipping Instructions).
GET
requests MAY return different feedback (e.g. the Carrier MAY still be processing the Shipping Instructions asynchronously).updatedContent=true
(after Shipping Instructions cancellation is in state CANCELLATION_DECLINED
)GET
request with the updatedContent
query parameter set to true
to retrieve the updated Shipping Instructions.200
(Ok) with the content of the updated Shipping Instructions (or a 202
(Accepted) / 409
(Conflict) in case the Carrier is in the middle of processing the Shipping Instructions).
GET
requests MAY return different feedback (e.g. the Carrier MAY still be processing the Shipping Instructions asynchronously).404
(Not Found) as there is no update (or a 202
(Accepted) / 409
(Conflict) in case the Carrier is in the middle of processing the Shipping Instructions).Back to Table of Content ⬆️