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
Manage your PreAdvice in DSV Warehouses via DSV’s PreAdvice API.
The PreAdvice API offers two methods to manage PreAdvices:
Create PreAdvice (generate a new PreAdvice to be sent to the DSV system)
Feature: Create one or more PreAdvices to inform DSV of upcoming deliveries. With this method, you can easily and quickly create a PreAdvice with all the information needed for processing.Data elements: Head, Receipt, Receipt Line, Supplier, UDF
Update PreAdvice (update the data of the existing PreAdvice in the DSV system)
Feature: Update previously created PreAdvice data. This method allows you to correct individual elements of one or more PreAdvices, e.g., change of the SKU to be delivered, quantity or information about supplier. The update is possible until the start of receipt processing.Data elements: Head, Receipt, Receipt Line, Supplier, UDF
API: Despatch
Create, update, delete Despatches via DSV’s Despatch API.
The Despatch API offers three methods to manage Despatches:
Create Despatch (make a new Despatch in the DSV system)
Feature: Create one or more Despatches by informing DSV of the need 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, Order Line, Receiver, UDF.
Update Despatch (update the data of the existing Despatch in the DSV system)
Feature: Update previously created Despatch data. This method allows you to update individual elements of one or more Orders, e.g., change of SKU to be sent to the client, quantity, delivery address. The update is possible until the start of despatch processing.Data elements: Order, Order Invoice, Order Notes, Order Line, Receiver, UDF.
Delete Despatch (delete an existing Despatch from the DSV system)
Feature: This method allows you to delete an Order from the DSV system. It is not possible to delete an Order that is being processed.Data element: Order ID
API: SKU
Manage your SKUs using the SKU API.
The SKU API offers three methods to manage SKUs:
Create SKU (create a new SKU in the DSV system)
Feature: Create one or more new 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 (update data on an existing SKU in the DSV system)
Feature: This method allows you to change the SKU data previously created in the DSV system.Data elements: Product, Pack Config, Supplier Product ID, UDF.
Delete SKU (delete the SKU from the DSV system)
Feature: With this method, you remove the SKU that will no longer delivered to the warehouse from DSV system. It is not possible to delete SKU when it has stock in the warehouse.Data element: SKU ID
API: Inventory
Get information about the stock of products in the warehouse using the Inventory API.
The Inventory API offers three methods of obtain information about the stock:
Inventory Report
Feature: Get notification about the available quantity of individual products in warehouse.Inventory Report by SKU
Feature: Get notification about the available quantity of a specific product in warehouse.Data element: SKU ID
Inventory Adjustment
Feature: Automatically receive stock adjustment notifications for SKUs.
API: Status Report
Receive notifications about operations related to PreAdvice, Despatch or Transaction using the Status Report API.
The Status Report API offers three methods of obtain information about operations:
PreAdvice Status
Feature: Automatically receive notifications of operational status changes for PreAdvice throughout the receiving process.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.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 obtain 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
To facilitate easy development and testing a Postman collection has been created: