Shipment Confirmation (CI, Outbound)
These DTOs represent confirmations by the shipper for shipments that have been created in the carrier system and sent to Transporeon via Tour (Cl, Inbound).
It also provides the generated Transporeon IDs (Identifiers) of the Transport and Delivery objects, which are needed for subsequent API calls.
Depending on the individual business process, the shipper can confirm or decline such shipments.
Field Description
Field | Description | Mandatory | Remark |
---|---|---|---|
document_reference | Reference number of document | True | Â |
transport_id | Unique Transporeon ID of the transport | False | This ID is needed for subsequent calls in the carrier API. Not set if the transport is not planned yet. |
transport_number_carrier | Unique carrier reference number of the transport | False | Not set if the transport is not planned yet. |
transport_contract_reference | Contract reference | False | Optional. Not set if the transport is not planned yet. |
delivery_id | Unique Transporeon ID of the delivery | True | This ID is needed for subsequent calls in the carrier API. |
delivery_number_carrier | Unique carrier reference number of the delivery | True | Â |
delivery_contract_reference | Contract reference | False | Â |
status | Shipment has been accepted or declined by the shipper | True | ACCEPTED, DECLINED |
decline_reason | The shipper can provide a reason for declining the shipment | False | This field is only set if the status is DECLINED. |
Â