Creates and updates outbound delivery notification orders for DSV Contract Logistics warehouses.
{
"openapi": "3.0.1",
"info": {
"title": "WMS Delivery Notification (DEMO)",
"description": "Contract Logistics API - WMS Delivery Notification (DEMO) ",
"version": "v1"
},
"servers": [
{
"url": "https://api.dsv.com/cl-demo/delivery/v1"
}
],
"paths": {
"/deliveryNotification": {
"post": {
"tags": [
"Delivery"
],
"summary": "Create Delivery Notification(s)",
"description": "Create Delivery Notification Order(s)",
"operationId": "DeliveryNotification_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/DeliveryNotificationDto"
},
"example": {
"deliveryNotification": [
{
"warehouseId": "a4b11-3a7f06",
"deliveryId": "DI-993",
"purchaseOrder": "PO-0346",
"customerOrderReference": "777XX",
"orderType": "NORMAL",
"shipmentDates": {
"orderDate": "2025-03-25T02:30:00.0000000+00:00",
"requestedShipDate": "2025-03-25T02:30:00.0000000+00:00",
"requestedDeliveryDate": "2025-03-25T02:30:00.0000000+00:00"
},
"incoterms": {
"code": "EXW",
"location": "Denmark"
},
"transportDetails": {
"carrierName": "V1-55",
"carrierMode": "CM1-55",
"deliveryPoint": "D35A-Noida"
},
"delivery": {
"partyId": "PId123456",
"companyName": "DSV",
"addressLine1": "AddressLine1",
"addressLine2": "AddressLine2",
"city": "Copenhagen",
"state": "Capital Region of Denmark",
"zipCode": "1000",
"countryCode": "AF",
"vatNumber": "#123456",
"contactName": "Test",
"contactPhone": "+1123456789",
"contactEmail": "test@gmail.com",
"contactMobile": "+1123456789"
},
"invoice": {
"partyId": "PId123456",
"companyName": "DSV",
"addressLine1": "AddressLine1",
"addressLine2": "AddressLine2",
"city": "Copenhagen",
"state": "Capital Region of Denmark",
"zipCode": "1000",
"countryCode": "AF",
"vatNumber": "#123456",
"contactName": "Test",
"contactPhone": "+1123456789",
"contactEmail": "test@gmail.com",
"contactMobile": "+1123456789"
},
"hub": {
"partyId": "PId123456",
"companyName": "DSV",
"addressLine1": "AddressLine1",
"addressLine2": "AddressLine2",
"city": "Copenhagen",
"state": "Capital Region of Denmark",
"zipCode": "1000",
"countryCode": "AF",
"vatNumber": "#123456",
"contactName": "Test",
"contactPhone": "+1123456789",
"contactEmail": "test@gmail.com",
"contactMobile": "+1123456789"
},
"deliveryDetails": {
"invoiceNumber": "Inv-0155",
"paymentTerms": "EOM",
"textOnDocumentsHeader": "DocumentsHeader",
"textOnDocumentsFooter1": "DocumentsFooter1",
"textOnDocumentsFooter2": "DocumentsFooter2"
},
"additionalInformation": {
"numericFields": [
{
"sequence": 1,
"value": 999999999.999999
}
],
"textFields": [
{
"sequence": 1,
"value": "Value1"
}
]
},
"outboundNotes": [
{
"code": "C12-055",
"text": "txt-055-999438"
}
],
"deliveryItems": [
{
"lineId": 55,
"productId": "P12-055",
"quantity": 100,
"customerProductId": "CP-055",
"conditionOfProduct": "OK1",
"lotId": "LotId-055",
"expirationDaysLeft": 7,
"serialNumbers": [
"SN1234567890",
"SN1234567891"
],
"customerProductDescription1": "CustomerProductDescription1",
"customerProductDescription2": "CustomerProductDescription2",
"customerOrderReference": "CustomerOrderReference",
"productValue": {
"valueOfProduct": 999,
"currency": "AED"
},
"additionalInformation": {
"numericFields": [
{
"sequence": 1,
"value": 999999999.999999
}
],
"textFields": [
{
"sequence": 1,
"value": "Value1"
}
]
},
"outboundNotes": [
{
"code": "C12-055",
"text": "txt-055-999438"
}
]
}
]
}
]
}
}
}
},
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Request contains not valid data.",
"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": "Not authorized.",
"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"
}
}
}
}
},
"403": {
"description": "Lack of privileges to use this method.",
"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": "Internal Server Error.",
"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"
}
}
}
}
}
}
},
"put": {
"tags": [
"Delivery"
],
"summary": "Update Delivery Notification(s)",
"description": "Update existing Delivery Notification Order(s)",
"operationId": "DeliveryNotification_Put",
"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/DeliveryNotificationDto"
},
"example": {
"deliveryNotification": [
{
"warehouseId": "a4b11-3a7f06",
"deliveryId": "DI-993",
"purchaseOrder": "PO-0346",
"customerOrderReference": "777XX",
"orderType": "NORMAL",
"shipmentDates": {
"orderDate": "2025-03-25T02:30:00.0000000+00:00",
"requestedShipDate": "2025-03-25T02:30:00.0000000+00:00",
"requestedDeliveryDate": "2025-03-25T02:30:00.0000000+00:00"
},
"incoterms": {
"code": "EXW",
"location": "Denmark"
},
"transportDetails": {
"carrierName": "V1-55",
"carrierMode": "CM1-55",
"deliveryPoint": "D35A-Noida"
},
"delivery": {
"partyId": "PId123456",
"companyName": "DSV",
"addressLine1": "AddressLine1",
"addressLine2": "AddressLine2",
"city": "Copenhagen",
"state": "Capital Region of Denmark",
"zipCode": "1000",
"countryCode": "AF",
"vatNumber": "#123456",
"contactName": "Test",
"contactPhone": "+1123456789",
"contactEmail": "test@gmail.com",
"contactMobile": "+1123456789"
},
"invoice": {
"partyId": "PId123456",
"companyName": "DSV",
"addressLine1": "AddressLine1",
"addressLine2": "AddressLine2",
"city": "Copenhagen",
"state": "Capital Region of Denmark",
"zipCode": "1000",
"countryCode": "AF",
"vatNumber": "#123456",
"contactName": "Test",
"contactPhone": "+1123456789",
"contactEmail": "test@gmail.com",
"contactMobile": "+1123456789"
},
"hub": {
"partyId": "PId123456",
"companyName": "DSV",
"addressLine1": "AddressLine1",
"addressLine2": "AddressLine2",
"city": "Copenhagen",
"state": "Capital Region of Denmark",
"zipCode": "1000",
"countryCode": "AF",
"vatNumber": "#123456",
"contactName": "Test",
"contactPhone": "+1123456789",
"contactEmail": "test@gmail.com",
"contactMobile": "+1123456789"
},
"deliveryDetails": {
"invoiceNumber": "Inv-0155",
"paymentTerms": "EOM",
"textOnDocumentsHeader": "DocumentsHeader",
"textOnDocumentsFooter1": "DocumentsFooter1",
"textOnDocumentsFooter2": "DocumentsFooter2"
},
"additionalInformation": {
"numericFields": [
{
"sequence": 1,
"value": 999999999.999999
}
],
"textFields": [
{
"sequence": 1,
"value": "Value1"
}
]
},
"outboundNotes": [
{
"code": "C12-055",
"text": "txt-055-999438"
}
],
"deliveryItems": [
{
"lineId": 55,
"productId": "P12-055",
"quantity": 100,
"customerProductId": "CP-055",
"conditionOfProduct": "OK1",
"lotId": "LotId-055",
"expirationDaysLeft": 7,
"serialNumbers": [
"SN1234567890",
"SN1234567891"
],
"customerProductDescription1": "CustomerProductDescription1",
"customerProductDescription2": "CustomerProductDescription2",
"customerOrderReference": "CustomerOrderReference",
"productValue": {
"valueOfProduct": 999,
"currency": "AED"
},
"additionalInformation": {
"numericFields": [
{
"sequence": 1,
"value": 999999999.999999
}
],
"textFields": [
{
"sequence": 1,
"value": "Value1"
}
]
},
"outboundNotes": [
{
"code": "C12-055",
"text": "txt-055-999438"
}
]
}
]
}
]
}
}
}
},
"responses": {
"200": {
"description": "Request submitted successfull.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeliveryNotificationDto"
},
"example": {
"deliveryNotification": [
{
"warehouseId": "a4b11-3a7f06",
"deliveryId": "DI-993",
"purchaseOrder": "PO-0346",
"customerOrderReference": "777XX",
"orderType": "NORMAL",
"shipmentDates": {
"orderDate": "2025-03-25T02:30:00.0000000+00:00",
"requestedShipDate": "2025-03-25T02:30:00.0000000+00:00",
"requestedDeliveryDate": "2025-03-25T02:30:00.0000000+00:00"
},
"incoterms": {
"code": "EXW",
"location": "Denmark"
},
"transportDetails": {
"carrierName": "V1-55",
"carrierMode": "CM1-55",
"deliveryPoint": "D35A-Noida"
},
"delivery": {
"partyId": "PId123456",
"companyName": "DSV",
"addressLine1": "AddressLine1",
"addressLine2": "AddressLine2",
"city": "Copenhagen",
"state": "Capital Region of Denmark",
"zipCode": "1000",
"countryCode": "AF",
"vatNumber": "#123456",
"contactName": "Test",
"contactPhone": "+1123456789",
"contactEmail": "test@gmail.com",
"contactMobile": "+1123456789"
},
"invoice": {
"partyId": "PId123456",
"companyName": "DSV",
"addressLine1": "AddressLine1",
"addressLine2": "AddressLine2",
"city": "Copenhagen",
"state": "Capital Region of Denmark",
"zipCode": "1000",
"countryCode": "AF",
"vatNumber": "#123456",
"contactName": "Test",
"contactPhone": "+1123456789",
"contactEmail": "test@gmail.com",
"contactMobile": "+1123456789"
},
"hub": {
"partyId": "PId123456",
"companyName": "DSV",
"addressLine1": "AddressLine1",
"addressLine2": "AddressLine2",
"city": "Copenhagen",
"state": "Capital Region of Denmark",
"zipCode": "1000",
"countryCode": "AF",
"vatNumber": "#123456",
"contactName": "Test",
"contactPhone": "+1123456789",
"contactEmail": "test@gmail.com",
"contactMobile": "+1123456789"
},
"deliveryDetails": {
"invoiceNumber": "Inv-0155",
"paymentTerms": "EOM",
"textOnDocumentsHeader": "DocumentsHeader",
"textOnDocumentsFooter1": "DocumentsFooter1",
"textOnDocumentsFooter2": "DocumentsFooter2"
},
"additionalInformation": [
{
"numericFields": {
"sequence": 1,
"value": 999999999.999999
},
"textFields": {
"sequence": 1,
"value": "Value1"
}
}
],
"outboundNotes": [
{
"code": "C12-055",
"text": "txt-055-999438"
}
],
"deliveryItems": [
{
"lineId": 55,
"productId": "P12-055",
"quantity": 100,
"customerProductId": "CP-055",
"conditionOfProduct": "OK1",
"lotId": "LotId-055",
"expirationDaysLeft": 7,
"serialNumbers": [
"SN1234567890",
"SN1234567891"
],
"customerProductDescription1": "CustomerProductDescription1",
"customerProductDescription2": "CustomerProductDescription2",
"customerOrderReference": "CustomerOrderReference",
"productValue": {
"valueOfProduct": 999,
"currency": "AED"
},
"additionalInformation": [
{
"numericFields": {
"sequence": 1,
"value": 999999999.999999
},
"textFields": {
"sequence": 1,
"value": "Value1"
}
}
],
"outboundNotes": [
{
"code": "C12-055",
"text": "txt-055-999438"
}
]
}
]
}
]
}
}
}
},
"400": {
"description": "Request contains not valid data.",
"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": "Not authorized.",
"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"
}
}
}
}
},
"403": {
"description": "Lack of privileges to use this method.",
"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": "Internal Server Error.",
"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": {
"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"
}
},
"development": {
"$ref": "#/components/schemas/DevelopmentDTO"
}
}
},
"FieldDTO": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Error name",
"example": "field_name"
},
"message": {
"type": "string",
"description": "Description of error",
"example": "validation error"
},
"code": {
"type": "string",
"description": "Type of error",
"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"
},
"exception": {
"type": "string",
"description": "Dump from exception"
}
}
},
"DeliveryNotificationDto": {
"type": "object",
"properties": {
"deliveryNotification": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeliveryNotificationItemDto"
},
"description": "Delivery Notification"
}
},
"description": "Delivery Notification"
},
"DeliveryNotificationItemDto": {
"required": [
"warehouseId",
"deliveryId",
"deliveryItems"
],
"type": "object",
"properties": {
"warehouseId": {
"maxLength": 20,
"minLength": 0,
"type": "string",
"description": "To be resolved in token database",
"example": "a4b11-3a7f06"
},
"deliveryId": {
"maxLength": 20,
"minLength": 0,
"type": "string",
"description": "Unique order name/number/identifier",
"example": "DI-993"
},
"purchaseOrder": {
"maxLength": 25,
"minLength": 0,
"type": "string",
"description": "Purchase order reference.",
"example": "PO-0346"
},
"customerOrderReference": {
"maxLength": 35,
"minLength": 0,
"type": "string",
"description": "Reference to the order number of customer.",
"example": "777XX"
},
"orderType": {
"$ref": "#/components/schemas/OutboundOrderType"
},
"shipmentDates": {
"$ref": "#/components/schemas/ShipmentDatesDto"
},
"incoterms": {
"$ref": "#/components/schemas/IncotermsDto"
},
"transportDetails": {
"$ref": "#/components/schemas/TransportDetailsDeliveryNotificationDto"
},
"delivery": {
"$ref": "#/components/schemas/AddressDto"
},
"invoice": {
"$ref": "#/components/schemas/AddressDto"
},
"hub": {
"$ref": "#/components/schemas/AddressDto"
},
"deliveryDetails": {
"$ref": "#/components/schemas/DeliveryDetailsDto"
},
"additionalInformation": {
"$ref": "#/components/schemas/AdditionalInformationDto"
},
"outboundNotes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OutboundNoteDto"
},
"description": "Outbound Notes"
},
"deliveryItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeliveryItemDto"
},
"description": "Delivery Items"
}
},
"description": "Delivery Notification Item"
},
"OutboundOrderType": {
"enum": [
"NORMAL",
"RUSH",
"SAMPLE"
],
"type": "string",
"description": ""
},
"ShipmentDatesDto": {
"type": "object",
"properties": {
"orderDate": {
"type": "string",
"description": "The date/time the order was created as supplied by the customer Format: CCYY-MM-DDTHH:mm:ssZ",
"example": "2025-03-25T14:30:00Z"
},
"requestedShipDate": {
"type": "string",
"description": "The date-time the order is due to be shipped to the buyer Format: CCYY-MM-DDTHH:mm:ssZ",
"example": "2025-03-25T14:30:00Z"
},
"requestedDeliveryDate": {
"type": "string",
"description": "The date-time the order is due to be delivered to the buyer Format: CCYY-MM-DDTHH:mm:ssZ",
"example": "2025-03-25T14:30:00Z"
}
},
"description": "Shipment Dates"
},
"IncotermsDto": {
# --- truncated at 32 KB (51 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/dsv/refs/heads/main/openapi/dsv-warehousing-despatch-demo-v1-openapi.json