DSV

DSV WMS Order Status API

Returns the current status of a specific delivery or inbound order in DSV Contract Logistics warehouse management.

GitHub OpenAPI

Documentation

📖
APIReference
https://developer.dsv.com/api-details#api=warehousing-status-demo-v1
📖
Documentation
https://developer.dsv.com/guide-contract-logistics
📖
Documentation
https://developer.dsv.com/apicatalogue-cl
📖
Authentication
https://developer.dsv.com/oauth-guide

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/dsv/refs/heads/main/openapi/dsv-warehousing-status-demo-v1-openapi.json

Other Resources

🔗
PostmanCollection
https://developer.dsv.com/content/WMS%20Notification%20Status%20v1.0%20API.postman_collection.zip

OpenAPI Specification

dsv-warehousing-status-demo-v1-openapi.json Raw ↑ 
{
  "openapi": "3.0.1",
  "info": {
    "title": "WMS Order Status (DEMO)",
    "description": "Contract Logistics API - WMS Order Status",
    "version": "v1"
  },
  "servers": [
    {
      "url": "https://api.dsv.com/cl-demo/status/v1"
    }
  ],
  "paths": {
    "/notification": {
      "post": {
        "tags": [
          "Status"
        ],
        "summary": "Retrieve Order Status on a Delivery or Inbound Notification",
        "description": "This message is sent to retrieve current order status of a specific Delivery or Inbound Order",
        "operationId": "Status_Post",
        "parameters": [
          {
            "name": "api-version",
            "in": "header",
            "description": "api-version",
            "schema": {
              "type": "string"
            },
            "example": 1
          },
          {
            "name": "Authorization",
            "in": "header",
            "description": "OAuth header",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NotificationStatusRequestDto"
              },
              "example": {
                "warehouseId": "36643f9b7c1c48ef",
                "notificationType": "Inbound",
                "notificationId": "IN001"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NotificationStatusResponseDto"
                },
                "example": {
                  "warehouseId": "36643f9b7c1c48ef",
                  "status": "Hold",
                  "notificationType": "Inbound",
                  "notificationId": "IN001",
                  "dateAndTimeOfChange": "2025-03-25T02:30:00.0000000+00:00"
                }
              }
            }
          },
          "400": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorDTO"
                },
                "example": {
                  "code": "ERR12345",
                  "message": "Not found id : 4025988810785188",
                  "fields": [
                    {
                      "name": "field_name",
                      "message": "validation error",
                      "code": "ERR12345"
                    }
                  ],
                  "development": {
                    "message": "string",
                    "exception": "string"
                  }
                }
              }
            }
          },
          "401": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorDTO"
                },
                "example": {
                  "code": "ERR12345",
                  "message": "Not found id : 4025988810785188",
                  "fields": [
                    {
                      "name": "field_name",
                      "message": "validation error",
                      "code": "ERR12345"
                    }
                  ],
                  "development": {
                    "message": "string",
                    "exception": "string"
                  }
                }
              }
            }
          },
          "500": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorDTO"
                },
                "example": {
                  "code": "ERR12345",
                  "message": "Not found id : 4025988810785188",
                  "fields": [
                    {
                      "name": "field_name",
                      "message": "validation error",
                      "code": "ERR12345"
                    }
                  ],
                  "development": {
                    "message": "string",
                    "exception": "string"
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "NotificationStatusResponseDto": {
        "type": "object",
        "properties": {
          "warehouseId": {
            "maxLength": 20,
            "minLength": 0,
            "type": "string",
            "description": "To be resolved in Token database",
            "example": "36643f9b7c1c48ef"
          },
          "status": {
            "$ref": "#/components/schemas/OrderStatus"
          },
          "notificationType": {
            "$ref": "#/components/schemas/NotificationType"
          },
          "notificationId": {
            "maxLength": 20,
            "minLength": 0,
            "type": "string",
            "description": "DeliveryNotification Id or InboundNotification Id",
            "example": "IN001"
          },
          "dateAndTimeOfChange": {
            "type": "string",
            "description": "Format: CCYY-MM-DDTHH:mm:ssZ",
            "example": "2025-03-25T14:30:00Z"
          }
        },
        "description": "Notification Status Response"
      },
      "OrderStatus": {
        "enum": [
          "Hold",
          "Released",
          "InProgress",
          "PreReceived",
          "Complete",
          "Allocated",
          "Picked",
          "Packed",
          "ReadytoLoad",
          "Shipped",
          "Delivered",
          "Cancelled",
          "Awaiting",
          "DutyError",
          "InTransit",
          "Kitting"
        ],
        "type": "string",
        "description": ""
      },
      "NotificationType": {
        "enum": [
          "Inbound",
          "Delivery"
        ],
        "type": "string",
        "description": ""
      },
      "ErrorDTO": {
        "required": [
          "code",
          "message"
        ],
        "type": "object",
        "properties": {
          "code": {
            "minLength": 1,
            "type": "string",
            "description": "Unique error code",
            "example": "ERR12345"
          },
          "message": {
            "minLength": 1,
            "type": "string",
            "description": "Error message passed to the user",
            "example": "Not found id : 4025988810785188"
          },
          "fields": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/FieldDTO"
            },
            "nullable": true
          },
          "development": {
            "$ref": "#/components/schemas/DevelopmentDTO"
          }
        }
      },
      "FieldDTO": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "Error name",
            "nullable": true,
            "example": "field_name"
          },
          "message": {
            "type": "string",
            "description": "Description of error",
            "nullable": true,
            "example": "validation error"
          },
          "code": {
            "type": "string",
            "description": "Type of error",
            "nullable": true,
            "example": "ERR12345"
          }
        }
      },
      "DevelopmentDTO": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "Verbose, plain language description of the problem for the app developer with hints on how to fix it",
            "nullable": true
          },
          "exception": {
            "type": "string",
            "description": "Dump from exception",
            "nullable": true
          }
        }
      },
      "NotificationStatusRequestDto": {
        "required": [
          "warehouseId",
          "notificationType",
          "notificationId"
        ],
        "type": "object",
        "properties": {
          "warehouseId": {
            "maxLength": 20,
            "minLength": 0,
            "type": "string",
            "description": "To be resolved in Token database",
            "example": "36643f9b7c1c48ef"
          },
          "notificationType": {
            "$ref": "#/components/schemas/NotificationType"
          },
          "notificationId": {
            "maxLength": 20,
            "minLength": 0,
            "type": "string",
            "description": "InboundNotification Id or DeliveryNotification Id",
            "example": "IN001"
          }
        },
        "description": "Notification Status Request"
      }
    },
    "securitySchemes": {
      "apiKeyHeader": {
        "type": "apiKey",
        "name": "DSV-Subscription-Key",
        "in": "header"
      },
      "apiKeyQuery": {
        "type": "apiKey",
        "name": "DSV-Subscription-Key",
        "in": "query"
      }
    }
  },
  "security": [
    {
      "apiKeyHeader": []
    },
    {
      "apiKeyQuery": []
    }
  ]
}