How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

DSV Shipment details API

The Shipment details API from DSV — 4 operation(s) for shipment details.

DSV Shipment details API is one of 32 APIs that DSV publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Shipment details. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, and authentication docs.

This API exposes 4 operations across 4 paths, and defines 41 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://api.dsv.com/my-demo/tracking/v2, https://api.dsv.com/my-demo/visibility/v1.

4 operations 4 paths 41 schemas 3 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.dsv.com/my-demo/oauth/v1
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

DSV Shipment details API declares 2 security schemes for authenticating requests. An API key is passed in the header as DSV-Subscription-Key (apiKeyHeader). An API key is passed in the query as DSV-Subscription-Key (apiKeyQuery). By default, every request must be authenticated.

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 3 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Shipment details 4
GET
/shipments/bookingId/{bookingId}
Shipment details by DSV Booking ID
getShipmentByBookingId 2 params → 200400404
GET
/shipments/tmsId/{tmsId}
Shipment details by DSV Shipment ID
getShipmentByTmsId 2 params → 200400404
GET
/shipments/reference/{*reference}
Shipment details by Customer reference
getShipmentByReference 2 params → 200400
POST
/shipments/deviceReadings
Get device readings by search filter
Shipment_Post 2 params body → 200400500

Schemas 41

The contract defines 41 schemas that model the data the API accepts and returns. The most detailed are PackageDTO (33 properties), ShipmentDetailsAPI (26 properties), DangerousGoodsDTO (21 properties), EventApiDto (16 properties). Each schema is shown below with its type and property counts.

TransportApiDto
object
This section carries the information about the main transport and some directly associated parameters applicable for "Air", "Sea", "Rail" shipments.
9 properties
IncotermsDTO
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
EventApiDto
object
Track and trace events
16 properties 1 required
CustomsApiDto
object
Customs data
5 properties 1 required
FieldDTO
object
Field
3 properties
Pickup
object
Name and address of the party shipment is picked up.
2 properties
Party
object
Reserved for future use.
3 properties 1 required
ProductApiDto
object
The product section carries the information about the main transport mode and some directly associated parameters, if any.
7 properties 1 required
DateTimeSection
object
Date and time specification for the shipment
2 properties
TypeValueDTO
object
References that can be used to identify linked information. It is allowed to send several references of the same reference type.
2 properties
FreightPayer
object
Name and address of the party that receives the freight invoice.
2 properties
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
BaseParty
object
The forwarder responsible for the transport
2 properties
DangerousGoodsDTO
object
This section contains the details of the dangerous goods in the booking/shipment.
21 properties
LocationApiDto
object
Event location details
3 properties
LocalTime
object
The requested pickup/delivery time (end of time window) using the 24 hours format hh:mm:ss
4 properties
DocumentDto
object
This section contains all document details of Profs of delivery.
7 properties 6 required
Carrier
object
Name and address of the carrier
2 properties
IssueAPI
object
This section contains Issues details from the booking/shipment.
11 properties
DevelopmentDTO
object
Development
2 properties
ContactPerson
object
All fields related to Contact Person e.g. Name, Phone, email
3 properties 1 required
ShipmentDetailsAPI
object
Shipment details
26 properties 5 required
PackageIdentifierDTO
object
This section contains Package identifier details from the booking/shipment.
2 properties
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
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
GoodsApiDto
object
This section contains the details of the goods from the booking/shipment.
13 properties
PackageDTO
object
All package details in the booking/shipment.
33 properties 1 required
ErrorDTO
object
Error
4 properties 2 required
Receiver
object
Name and address of the party receiving the shipment (consignee).
2 properties
ContainerSummaryDTO
object
Summary of container information
4 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
Service
object
This section contains additional Service details from the booking/shipment.
4 properties 2 required
ServiceLevelDTO
object
This section contains details on the requested service level from the "Air", "Sea" or "Rail" booking/shipment
2 properties
DeviceReadingResultModelDto
object
Device reading result model
6 properties
DeviceReadingFilterDto
object
DeviceReadingFilterDto
4 properties
DeviceReadingDto
object
Device reading dto
14 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

dsv-shipment-details-api-openapi.yml Raw ↑

Other APIs DSV publishes across the network.

DSV Booking API
DSV Bookings API
DSV Booking Web Service API
DSV BPO Inbound API
DSV Declarations API
DSV Delivery API
DSV Draft API
DSV E Docs API
DSV Events API
DSV Inbound API
DSV Inventory API
DSV Invoices API
Where this information came from

This is an independent, third-party profile of DSV Shipment details API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.