DSV Booking API is one of 32 APIs that DSV publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Booking. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, and authentication docs.
This API exposes
8 operations
across 8 paths,
and defines 92 schemas.
It is described by OpenAPI 3.2.0, at version v2.
Requests are made against 2 base URLs: https://api.dsv.com/my-demo/booking/v2, https://api.dsv.com/xp/booking/v2.
The identity and technical contract details declared by the specification.
BulkBookingRequest
object
Bulk booking request containing multiple bookings
2 properties
Order
object
Main structure, represents the booking
20 properties
4 required
DangerousGoods
object
This section contains the details of the dangerous goods that need to be provided to DSV to execute a booking that contains dangerous goods. This section can o…
20 properties
7 required
Units
object
Defines the units of measurement (UOM) used for all measurements within the package section. It is recommended to use either all metric or all imperial UOM.
5 properties
RailPortSelectionService
object
The service allows to request the departure/arrival of the cargo on a specified port of loading/discharge. The UN location code is mandatory, the name is optio…
2 properties
Product
object
Dependency rules: - If product.name = "Sea": billOfLading and containerMode are mandatory. - If product.name = "Rail": containerMode is optional; billOfLading…
6 properties
1 required
FieldDTO
object
Field
3 properties
Pickup
object
Name and address of the party shipment is picked up.
2 properties
SeaPortSelectionService
object
The service allows to request the departure/arrival of the cargo on a specified port of loading/discharge. This service can only be selected for bookings with…
2 properties
Party
object
Reserved for future use.
3 properties
1 required
Incoterms
object
Incoterms® describe the rights and obligations applicable between the buyer and seller of the goods being transported. They set out when transfer of liability…
2 properties
2 required
Amount
object
Represents the insurance amount
2 properties
2 required
OrderReference
object
References to be send along booking that can be later on used to identify linked information.
2 properties
2 required
SingleResponseEntityObject
object
PalletExchangeService
object
Instruct DSV to exchange EUR pallets at the collection/delivery location. This service can only be selected for bookings with mode of transport “Road” in some…
2 properties
2 required
BulkBookingResult
object
Result for a single booking in bulk booking response
8 properties
FreightPayer
object
Name and address of the party that receives the freight invoice. This address type is only available for product "Road". If provided for product "Air", "Sea",…
2 properties
Package
object
Contains a single package line with all associated attributes like type, quantity, weight, etc.
25 properties
4 required
Notify
object
Name and address of the party who will be notified
2 properties
Sender
object
Name and address of the party sending the goods (shipper). If address is not already available, it will be created from supplied address data.
2 properties
PortType
object
UN Location code and Name of the departure rail terminal
2 properties
1 required
LabelResponse
object
2 properties
LocalTime
object
The requested pickup/delivery time (end of time window) using the 24 hours format hh:mm:ss
4 properties
CashOnDeliveryService
object
Request DSV to collect payment for the goods you are sending. This service can only be selected for bookings with mode of transport "Road" in some countries. P…
1 property
1 required
Carrier
object
Name and address of the carrier
2 properties
DevelopmentDTO
object
Development
2 properties
ContactPerson
object
All fields related to Contact Person e.g. Name, Phone, email
3 properties
1 required
SpotQuoteNumberService
object
You can fill in the reference received from DSV in a spot quotation to be used for invoicing this booking.
1 property
1 required
CustomsClearance
object
2 properties
FixTimeDeliveryService
object
Container
object
Specify the required containers of a certain type. Additional attributes can be submitted for certain container types. More details on container types can be f…
4 properties
SimpleService
object
This is a subcategory used for additional services of local agreements. Please contact your local DSV contact for more information.
1 property
1 required
BookingParty
object
Name and address of the party that created the booking.
2 properties
DateTimeRange
object
Date with time range. Used e.g., for Pickup Date and Time.
3 properties
1 required
PlaceBookingResponse
object
Contains information about submitted booking
1 property
1 required
ErrorDTO
object
Error
4 properties
2 required
InsuranceService
object
Insure your goods at DSV’s own insurance company. More information about this service can be found at https://www.dsv.com/en/our-solutions/modes-of-transport/v…
2 properties
2 required
Receiver
object
Name and address of the party receiving the shipment (consignee).
2 properties
Services
object
Specifies additional services that can be selected for a booking. Service availability depends on factors such as transport mode, route, and country. Some serv…
33 properties
AirportSelectionService
object
The service allows to request the departure/arrival of the cargo on a specified airport. The airport UN location code is mandatory, the airport name is optiona…
2 properties
PreAdviceService
object
This service will be deprecated. Please use "preAdviceMailPickUp" or "preAdviceMailDelivery"
2 properties
Battery
object
Battery information
2 properties
Parties
object
Contains all parties involved in the booking. See the party definition section for more details.
9 properties
3 required
Address
object
All fields related to the address of the business partner.
13 properties
Delivery
object
Name and address of the party where shipment is delivered
2 properties
B2CService
object
2 properties
BulkBookingResponse
object
Response for bulk booking submission containing results for each booking
4 properties
CarrierCredentials
object
Carrier credentials (specific for Fedex)
3 properties
ChargesTotal
object
2 properties
SpecialCargoLithium
object
Container for Lithium's information. Required if content is LITHIUM
1 property
1 required
Pickup_2
object
Container for the pickup information. If address is left empty, shipment will be picked-up up at sender address.
5 properties
1 required
ServiceOptionsCod
object
Container for Cash On Delivery information. The presence indicates COD is requested.
2 properties
2 required
ShippingLabel
object
2 properties
Reference
object
Container for reference
2 properties
2 required
ServiceOptions
object
Container for shipment service options. Note : You may be subject to automatic insurance based on your account configuration.
6 properties
ProformaInvoice
object
Container for proforma/commercial invoice
2 properties
2 required
PaymentInformation
object
Container for payment information
3 properties
UploadDocumentResponse
object
Container for document upload response
3 properties
ExtraOption
object
Extra option required by specific carrier and service combinations
2 properties
PaymentInformationDetails
object
7 properties
1 required
Charge
object
Container for shipment charge.
6 properties
2 required
CurrencyCodeList
string
Currency Code supported (EUR by default if not provided): CAD - Canadian Dollar CNY - Yuan Renminbi DKK - Danish Krone EUR - Euro GBP - British Pound HKD - Hon…
CarrierCodeList
string
Contact your DSV representative to know possible value
ShipmentDocumentTypeList
string
Shipment Document Type. Could be: PROFORMAINVOICE COMMERCIALINVOICE CUSTOMSDECLARATION CERTIFICATEOFORIGIN PACKINGLISTADR BANKDOCUMENTS DGGOODSDECLARATION OTHE…
Commodity
object
Container for commodity's information
5 properties
2 required
ShipmentLabelResponse
object
11 properties
Carrier_2
object
Container for carrier information
6 properties
2 required
CountryCodeList
string
ISO31661 Country Code
ShipmentNotification
object
3 properties
2 required
ExportCompliance
object
Compliance data required by some trade and customs authorities
3 properties
1 required
PackageType
string
Package type. Could be PARCELS / DOCUMENT / ENVELOPE. PARCELS by default.
ShipmentCreationResponse
object
Container for shipment creation response
3 properties
CancelResponse
object
2 properties
SpecialCargoDryIce
object
Container for Dry Ice's information. Required if content is DRYICE
1 property
LabelResult
object
Container for label
5 properties
ProformaInvoiceLine
object
8 properties
6 required
RegistrationNumber
object
List of registration numbers
2 properties
2 required
SpecialCargoDangerousGoods
object
Container for Dangerous Goods' information. Required if content is DGR or ADR
6 properties
4 required
CurrencyMonetaryType
object
2 properties
2 required
UploadDocument
object
Container for document upload request
5 properties
5 required
ProformaInvoiceTypeList
string
Type of the invoice, Proforma or Commercial. Could be COMMERCIAL / PROFORMA
UploadDocumentRequest
object
Container for document upload request
3 properties
3 required
PackageDetail
object
Container for package
9 properties
1 required
Address_2
object
13 properties
6 required
CarrierDetail
object
Carrier detail
2 properties
DocumentResult
object
Shipment document
4 properties
SpecialCargoAdrLq
object
Container for ADR LQ's information. Required if content is ADRLQ
3 properties
ErrorItem
object
2 properties
Charges
object
4 properties
ShipmentCreationRequest
object
Container for Shipment
19 properties
6 required
SpecialCargo
object
Container for special cargo content's information. Please note that one shipment should hold only one type of 'special cargo content'. Only one type of 'specia…
5 properties
1 required
ProformaInvoiceHeader
object
9 properties
8 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs DSV publishes across the network.
