Developer Guide - Warehousing
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: PreAdvice
A Pre-Advice is a record of the inventory due to arrive at the warehouse. For each Client, the criteria could be different based on the information needed for processing the pre-advice and storing the Inventory in the Warehouse Management System (WMS).
A Pre-Advice contains a Header and Line Detail.
Pre-Advice Header consists of data related to the delivery of the Inventory, such as Delivery Date, Supplier details and Trailer Information.
Pre-Advice Line consists of data related to the Inventory that is due to arrive, such as the Stock Keeping Unit (SKU), Quantity, Batch or Expiry information.
The Pre-Advice API offers two methods to manage Pre-Advice:
Create Pre-Advice
This function allows the creation of a new Pre-Advice that would be sent to the DSV Warehouse Management System (WMS).Feature: Create one or more Pre-Advices to inform DSV of upcoming deliveries. With this method, you can easily and quickly create a Pre-Advice with all the information needed for processing.
Data elements: Head, Receipt (Pre-Advice Header), Receipt Line (Pre-Advice Line), UDF
Update Pre-Advice
This function provides the ability to update the data of the existing Pre-Advice in the DSV Warehouse Management System (WMS).Feature: Update previously created Pre-Advice data. This method provides the ability to update individual elements of one or more Pre-Advices, e.g., change of the Stock Keeping Unit (SKU) to be delivered, quantity or information about supplier.
The update is possible until the start of receipt processing in the DSV Warehouse Management System (WMS).
(When Pre-Advice is in Status Hold or Released)Data elements: Head, Receipt (Pre-Advice Header), Receipt Line (Pre-Advice Line),UDF (User Defined Fields)
API: Despatch
A despatch order 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 despatch order.
A Despatch Order contains a Header and Line Detail.
The Despatch API offers three methods to manage Despatches:
Create Despatch
This function allows the creation of a new Despatch in the DSV Warehouse Management System (WMS).Feature: Create one or more Despatches by informing DSV of the need to ship inventory to clients. This method provides all the information needed to optimize the processes related to the shipment of inventory.
Data elements: Order, Order Invoice, Order Notes, Receiver, Order Line, UDF.
Update Despatch
This function provides the ability to update the data of the existing Despatch in the DSV Warehouse Management System (WMS).Feature: Update previously created Despatch data. This method provides the ability to update individual elements of one or more Orders, e.g., change of Stock Keeping Unit (SKU) to be sent to the client, quantity, delivery address.
The update is possible until the start of the despatch processing in the DSV Warehouse Management System (WMS).
(When despatch order is in Status Hold or Released)Data elements: Order, Order Invoice, Order Notes, Order Line, Receiver, UDF.
Delete Despatch
This function provides the ability to delete an existing Despatch from the DSV Warehouse Management System (WMS).Feature: This method provides the ability to delete a Despatch Order from the DSV Warehouse Management System (WMS).
It is not possible to delete an Order that is being processed in the DSV Warehouse Management System (WMS).
(When the despatch order is in Status Allocated, In-Progress, Picked, Packed, Ready to Load, Complete or Shipped)Data element: Order ID
API: SKU (Stock Keeping Unit)
A Stock Keeping Unit (SKU) is an alphanumeric code created internally by sellers to identify, receive, and locate their product (also known as “stock” or “inventory”). This type of code is more commonly known as a Stock Keeping Unit (SKU - pronounced as skew). It’s best practice for businesses to assign a unique Stock Keeping Unit (SKU) to each one of their products.
The SKU API offers three methods to manage SKUs:
Create SKU
This function allows the creation of a new Stock Keeping Unit (SKU) in DSV Warehouse Management System (WMS).Feature: Create one or more new Stock Keeping Units (SKUs) with full product information via API to inform DSV about the availability of a new item in the assortment.
Data elements: Product, Pack Config, Supplier Product ID, UDF
Update SKU
This function provides the ability to update data on an existing Stock Keeping Unit (SKU) in the DSV Warehouse Management System (WMS).Feature: This method allows you to change the Stock Keeping Unit (SKU) data previously created in the DSV Warehouse Management System (WMS). It is not possible to update certain fields for a Stock Keeping Unit (SKU) when it has stock (Inventory) in the warehouse.
Data elements: Product, Pack Config, Supplier Product ID, UDF.
Delete SKU
This function provides the ability to delete an existing Stock Keeping Unit (SKU) from the DSV Warehouse Management System (WMS).Feature: With this method, you remove the Stock Keeping Unit (SKU) that will no longer delivered to the warehouse from DSV Warehouse Management System (WMS). It is not possible to delete Stock Keeping Unit (SKU) when it has stock (Inventory) in the warehouse.
Data element: SKU ID
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 obtain information about the stock:
Inventory Report
An Inventory Report provides a list of Stock Keeping Units (SKUs) in inventory, with inventory balance and related information for each item. Also possible to group each Stock Keeping Unit (SKU) by unique information, such as available verses unavailable inventory.Inventory Report By SKU
An Inventory Report By Stock Keeping Unit (SKU) provides the available or unavailable quantities of a specific product in warehouse. Also possible to group each Stock Keeping Unit (SKU) by unique information, such as available verses unavailable inventory.Inventory Adjustment
Inventory adjustments are increases or decreases made in inventory to account for theft, loss, breakages, and/or errors in the amount or number of items received. Inventory adjustments are increases and decreases made to inventory to match an item's actual on-hand quantity.
This is triggered for each Stock Keeping Unit (SKU) adjusted.
API: Status Report
Receive notifications about operations related to Pre-Advice, Despatch or Transaction using the Status Report API.
The Status Report API offers three methods of obtain information about operations:
Pre-Advice Status
Feature: Automatically receive notifications of operational status changes for Pre-Advice throughout the receiving process in the Warehouse Management System (WMS).Below are the statuses you will receive:
Hold
Released
In Progress
Complete
Despatch Status
Feature: Automatically receive notifications of operational status changes for Despatch throughout the order preparation process in the Warehouse Management System (WMS).Below are the statuses you will receive:
Hold
Released
Allocated
In Progress
Picked
Packed
Ready to Load
Complete
Shipped
Cancelled
Receive Transaction Status Report
Feature: Get transaction status information.
Data element: Transaction ID
API: Confirmation
Receive confirmation of Receipt and Despatch with details using the Confirmation API.
The Confirmation API offers two methods of obtaining information about confirmations:
Receipt Confirmation
Feature: Automatically receive receipt confirmation with details.Despatch Confirmation
Feature: Automatically receive order confirmation with details.
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.
2 keys are allocated per subscribed product, a “primary key” and a “secondary key”. Only one key (either primary key or secondary key) should be used in the HTTP header “DSV-Subscription-Key”.
Sample key structure: b5c09b92fbf24d62a17caad22227c470
System account (HTTP header: Actor)
For security reasons, you will need to have an active account at DSV. When subscribing to the test API, a user email address and password will be provided by DSV which must be used during tests. In case you haven’t received the credentials latest one business day after the subscription was approved by DSV, please do not hesitate to contact support at SUPPORT.
The system account is a unique token and all requests must contain the HTTP request header: Actor
Login credentials for online portals
When developing against the generic APIs, 2 online portals are 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.
CW demo portal
Online booking and tracking portal where bookings submitted via the test booking API is visible. It is recommended to use the demo portal to verify if the information submitted via the APIs are correctly received by DSV.
Login credentials are provided via email shortly after the first subscription request is sent. Any additional subscription you request for the generic APIs will fall under the same set of credentials.
Postman
Postman is an (online) application that can be used to facilitate the development and testing of the API messages. This in combination with the CW Demo Portal will give a complete overview of the message flow of the different previous explained API messages.