.............................................

- API: Product Data
- API: Inbound Notification
- API: Delivery Notification
- API: Inventory
- API: Status Notification
- Webhook: Confirmation
- Authentication methods
- Postman

.............................................

Developer Guide - Contract Logistics

On this page you will find an overview of the available APIs and the different options offered via each API next to a description of the involved authentication method used in the APIs.

API: Product Data

A Product (SKU) is an alphanumeric code created internally by sellers to identify, receive, and locate their products.

The Product Data API offers two methods to manage Products: 

  • Create Product Data
    Feature: Create one or more new Products (SKUs) with full product information in DSV Warehouse Management System (WMS).

    Data elements: Product, Pallet Structure, Supplier Product ID, Additional Information

  • Update Product Data
    Feature: This method allows you to update the Product (SKU) data previously created in the DSV Warehouse Management System (WMS). It is not possible to update certain fields for a Product (SKU) when it has stock (Inventory) in the warehouse.

    Data elements: Product, Pallet Structure, Supplier Product ID, Additional Information

API: Inbound Notification

An Inbound Notification is information of products and quantities that will arrive at the warehouse. For each client, the criteria could be different based on the information needed for processing the Inbound Notification and storing the Inventory in the Warehouse Management System (WMS).

An Inbound Notification contains a Header and Line Details.
Inbound Notification Header consists of data related to the delivery, such as Delivery Date, Supplier details and Trailer Information.
Inbound Notification Line Details consists of data related to the Inventory that is due to arrive, such as the Product (SKU), Quantity, Lot or Expiry information.

The Inbound Notification API offers two methods to manage Inbound Notifications:

  • Create Inbound Notification
    Feature: Create one or more Inbound Notifications to inform DSV of upcoming deliveries. With this method, you can easily and quickly create an Inbound Notification with all the information needed for processing.

    Data elements: Head, Receipt (Inbound Notification Header), Receipt Line (Inbound Notification Line), Additional Information

  • Update Inbound Notification
    Feature: Update previously created Inbound Notification data. This method allows updating individual elements of one or more Inbound Notifications, e.g., changes to the Product Data (SKU) to be delivered, quantity or supplier information.
    The update is possible until the start of receipt processing in the DSV Warehouse Management System (WMS).
    (When Inbound Notification is in Status Hold or Released that allows updating)

    Data elements: Head, Receipt (Inbound Notification Header), Receipt Line (Inbound Notification Line), Additional Information

API: Delivery Notification

A Delivery Notification in a Warehouse Management System (WMS) is the process of picking, packing, loading, and sending inventory out of a warehouse. For each client, the criteria could be different based on the information needed for processing the Delivery Notification. 
A Delivery Notification contains a Header and Line Details.

The Delivery Notification API offers two methods to manage Delivery Notifications:

  • Create Delivery Notification
    Feature: Create one or more Delivery Notifications to inform DSV to ship products to clients. This method provides all the information needed to optimize the processes related to the shipment of products.

    Data elements: Order, Order Invoice, Order Notes, Receiver, Order Line, Additional Information

  • Update Delivery Notification
    Feature: Update previously created Delivery Notification data. This method provides the ability to update individual elements of one or more orders, e.g., changes to the Product Data (SKU) to be sent to the client, quantity, or delivery address.
    The update is possible until the start of the despatch processing in the DSV Warehouse Management System (WMS).
    (When Delivery Notification is in Status Hold or Released that allows updating)

    Data elements: Order, Order Invoice, Order Notes, Order Line, Receiver, Additional Information

API: Inventory

Inventory refers to the products, materials, or supplies stored in a warehouse before they are shipped, sold, or used in production.

A Warehouse Management System (WMS) can include two types of inventory:

  • Allocatable (Available): Inventory that is available.

  • Unallocatable (Unavailable): Inventory that is unavailable.

Get information about the stock of products (Inventory) in the warehouse using the Inventory API.

The Inventory API offers three methods of obtaining information about the stock:

  • Inventory Report
    Feature: An Inventory Report provides a list of Products (SKUs) in inventory, with inventory balance and related information for each item. The report is sent when system bandwidth is available (maximum once per day).

  • Inventory Report By Product
    Feature: An Inventory Report By Product (SKU) provides the available or unavailable quantities of a specific product in warehouse. The report is sent instantly.

  • Inventory Change - Webhook
    Feature: Inventory Change are adjustments made to the inventory; increases, decreases, availability and changes, to match an item's actual on-hand quantity.
    This is triggered for each Product (SKU) adjusted.

    Data elements: Product details, product attributes (as Lot Id, expiry date etc)

API: Status Notification

Receive notifications about operational status using the Status Notification API.

The Status Notification API offers one method of obtaining information about operations:

  • Notification change
    Feature: Automatically receive notifications of operational status changes throughout the receiving and order preparation process.

    Examples of statuses can be:

    • Hold

    • Released

    • Allocated

    • Picked

    • Packed

    • Ready to Load

    • Shipped

    • In Progress

    • Complete

Webhook: Confirmation

Push notifications of Receipt and Delivery Confirmation from DSV to your selected endpoint via the DSV Webhook offering.

Supplied methods of obtaining information about confirmations:

  • Receipt Confirmation
    Feature: Automatically receive receipt confirmation with details.

    Data elements: Header and line details, details of received stock

  • Delivery Confirmation
    Feature: Automatically receive order confirmation with details.

    Data elements: Header and line details, details of handling units

Authentication methods

  • API key (HTTP header: DSV-Subscription-Key)

    • This key is obtained by subscribing to the API as described in the ‘Developer Guide’.

    • The key can be found in the DSV Developer Portal profile page once the subscription request is approved by DSV.

    • Two keys are allocated per subscribed product, a “primary key” and a “secondary key”. Only one key (either the primary key or secondary key) should be used in the HTTP header “DSV-Subscription-Key”.

      Sample key structure: b5c09b92fbf24d62a17caad22227c470

  • OAuth 2.0 (HTTP header: Authorization)

    • For security reasons, you will need to have an active account at DSV Contract Logistics.

    • Use your DSV Contract Logistics credentials (username & password) together with the DSV-Subscription-Key, available in the DSV Developer Portal profile page once the subscription request is approved by DSV, to request an access token and refresh token from the token endpoint.

    • Include the access token in the header of your API requests for secure access to DSV resources.

    • Renew your access token with the refresh token when it expires, ensuring uninterrupted access.

    • Two keys are allocated per subscribed product, a “primary key” and a “secondary key”. Only one key (either the primary key or secondary key) should be used in the HTTP header “Authorization”.

      Sample Bearer: eyJhbG...

Login credentials for online portals 

When developing against the generic APIs, an online portal is made available for supporting the development process.

  • DSV Developer Portal

    • Main portal for DSV’s APIs covering the API catalogue, technical documentation, developer guides and subscriptions for the different APIs.

    • The API key (HTTP header: DSV-Subscription-Key) is found on the profile page of the portal.

    • Login credentials are selected by the user when signing up to the portal.

Postman

To facilitate easy development and testing Postman collections for each endpoint have been created: