DCSA Standards Public Reference / Standards / Releases / Bill of Lading / Archive / Bill of Lading v3.0.3
DCSA eBL 3.0.3 - Endpoint Overview
Archived release: Bill of Lading v3.0.3 has been superseded. View the current v3 documentation.
The table maps each use case to the API operation that initiates or communicates it. Notifications are optional; registration of notification endpoints is outside the API contract.
| Use case | Initiated by | Endpoint or action |
|---|---|---|
| UC1: Submit Shipping Instructions | Shipper | POST /v3/shipping-instructions |
| UC2: Request to update Shipping Instructions | Carrier | Carrier action; optionally POST /v3/shipping-instructions-notifications |
| UC3: Submit updated Shipping Instructions | Shipper, Consignee, or Endorsee | PUT /v3/shipping-instructions/{documentReference} |
| UC4: Process updated Shipping Instructions | Carrier | Carrier action; optionally POST /v3/shipping-instructions-notifications |
| UC5: Cancel update to Shipping Instructions | Shipper, Consignee, or Endorsee | PATCH /v3/shipping-instructions/{documentReference} |
| UC6: Publish Draft Transport Document | Carrier | Carrier action; optionally POST /v3/transport-document-notifications |
| UC7: Approve Draft Transport Document | Shipper | PATCH /v3/transport-documents/{transportDocumentReference} |
| UC8: Issue Transport Document | Carrier and eBL Platform | PUT /v3/ebl-issuance-requests; POST /v3/ebl-issuance-responses |
| UC9: Request surrender Transport Document for amendment | Shipper, Consignee, or Endorsee through eBL Platform | POST /v3/ebl-surrender-requests |
| UC10: Process Transport Document surrender request for amendment | Carrier | POST /v3/ebl-surrender-responses |
| UC11: Void original and issue amended Transport Document | Carrier and eBL Platform | Issuance operations; optionally POST /v3/transport-document-notifications |
| UC12: Request surrender Transport Document for delivery | Shipper, Consignee, or Endorsee through eBL Platform | POST /v3/ebl-surrender-requests |
| UC13: Process Transport Document surrender request for delivery | Carrier | POST /v3/ebl-surrender-responses |
| UC14: Confirm Shipping Instructions completed | Carrier | Carrier action; optionally POST /v3/shipping-instructions-notifications |
| UC15: Cancel Shipping Instructions | Shipper, Consignee, or Endorsee | PATCH /v3/shipping-instructions/{documentReference} |
| UC16: Decline Shipping Instructions | Carrier | Carrier action; optionally POST /v3/shipping-instructions-notifications |
| UC17: Request Transport Document amendment | Shipper, Consignee, or Endorsee | PUT /v3/transport-documents/{transportDocumentReference}/amendment |
| UC18: Cancel Transport Document amendment | Shipper, Consignee, or Endorsee | DELETE /v3/transport-documents/{transportDocumentReference}/amendment |
| UC19: Process Transport Document amendment | Carrier | Carrier action; optionally POST /v3/transport-document-notifications |
The current state of Shipping Instructions, Transport Documents, and direct Transport Document amendments is retrieved with GET /v3/shipping-instructions/{documentReference}, GET /v3/transport-documents/{transportDocumentReference}, and GET /v3/transport-documents/{transportDocumentReference}/amendment. The endorsement chain is retrieved with GET /endorsement-chains/{transportDocumentReference}.