DSV

DSV SCM Events API

Writes milestone events into the DSV SCM (eDC) platform. Notably exposes POST /event/ServiceProvider so a third-party service provider — not only the account owner — can post events into DSV's chain, the clearest multi-party write path DSV publishes.

OpenAPI Specification

dsv-edc-events-api-v2-openapi.json Raw ↑
{
  "openapi": "3.0.1",
  "info": {
    "title": "Events - SCM",
    "description": "SCM Events API",
    "version": "v2"
  },
  "servers": [
    {
      "url": "https://api.dsv.com/om/events/v2"
    }
  ],
  "paths": {
    "/event": {
      "post": {
        "tags": [
          "Events"
        ],
        "summary": "1. Create Events",
        "description": "Create Events",
        "operationId": "POSTevent",
        "parameters": [
          {
            "name": "authorization",
            "in": "header",
            "description": "DSV Authorization header",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/eDC.Web.Api.v2.Models.EventRequest"
              },
              "example": {
                "module": "string",
                "entityNumber": "string",
                "secondaryNumber": "string",
                "eventCode": "string",
                "description": "string",
                "eventDate": "2024-02-14T11:49:51.0000000+00:00",
                "reasonCodes": "string",
                "eventPlace": "string",
                "eventSource": "string",
                "qaIssueCode": "string",
                "qaIssueNotes": "string",
                "qaIssueResolvedDate": "2024-02-14T11:49:51.0000000+00:00",
                "vehicleRegistration": "string",
                "driverName": "string",
                "secondDriver": "string",
                "note": "string",
                "locationCode": "string",
                "reference": "string",
                "intendedParties": "string",
                "externalTrackingLink": "string",
                "customFields": [
                  {
                    "name": "string",
                    "type": "string",
                    "value": "string"
                  }
                ],
                "references": [
                  {
                    "type": "string",
                    "value": "string",
                    "customField": true,
                    "customFieldType": "string"
                  }
                ],
                "transportLegs": [
                  {
                    "transportMode": "string",
                    "consolMode": "string",
                    "consolNumber": "string",
                    "masterBill": "string",
                    "bookingReference": "string",
                    "agentsReference": "string",
                    "customsReference": "string",
                    "prepaidCollect": "string",
                    "loadPort": "string",
                    "dischargePort": "string",
                    "portOfFirstArrival": "string",
                    "eta": "2024-02-14T11:49:51.0000000+00:00",
                    "etd": "2024-02-14T11:49:51.0000000+00:00",
                    "ata": "2024-02-14T11:49:51.0000000+00:00",
                    "atd": "2024-02-14T11:49:51.0000000+00:00",
                    "vessel": "string",
                    "voyageFlight": "string",
                    "fullLoadPortFreeTime": 0,
                    "oceanCarrier": "string",
                    "airCarrier": "string",
                    "weight": {
                      "value": 0,
                      "unit": "string"
                    },
                    "volume": {
                      "value": 0,
                      "unit": "string"
                    },
                    "chargeable": {
                      "value": 0,
                      "unit": "string"
                    },
                    "releaseType": "string",
                    "teuCount": 0,
                    "countOfTEU": 0,
                    "countOf20FT": 0,
                    "countOf40FT": 0,
                    "countOf45FT": 0,
                    "stageNumber": "string",
                    "sta": "2024-02-14T11:49:51.0000000+00:00",
                    "std": "2024-02-14T11:49:51.0000000+00:00",
                    "qualifier": "string",
                    "legOrder": 0,
                    "legType": "string",
                    "carrierCode": "string",
                    "carrierSCAC": "string",
                    "carrierDakoskyCode": "string",
                    "carrierNationality": "string",
                    "localCarrierCode": "string",
                    "serviceLevel": "string",
                    "legNotes": "string",
                    "imoNumber": "string",
                    "status": "string",
                    "definedBy": "string",
                    "charterRoute": "string",
                    "isCharter": true,
                    "isLinked": true,
                    "isMainCarriage": true,
                    "isPlannedLeg": true,
                    "numberOfShipments": 0,
                    "numberOfPackages": 0,
                    "numberOfOriginalBills": 0,
                    "numberOfCopyBills": 0,
                    "linkReference": "string",
                    "ownerCodeInternal": "string",
                    "ownerCodeExternal": "string",
                    "source": "string",
                    "sendingAgent": {
                      "type": "string",
                      "code": "string",
                      "externalCode": "string",
                      "isActive": true,
                      "fullName": "string",
                      "closestPort": "string",
                      "currency": "string",
                      "phoneNumber": "string",
                      "email": "string",
                      "vatNumber": "string",
                      "registeredNumber": "string",
                      "ediCode": "string",
                      "address": {
                        "name": "string",
                        "address1": "string",
                        "address2": "string",
                        "address3": "string",
                        "unloco": "string",
                        "city": "string",
                        "state": "string",
                        "postCode": "string",
                        "countryCode": "string",
                        "country": "string",
                        "addressCode": "string",
                        "lockUNLOCO": true,
                        "longitude": 0,
                        "latitude": 0,
                        "dateModified": "2024-02-14T11:49:51.0000000+00:00",
                        "userModified": "string",
                        "dateCreated": "2024-02-14T11:49:51.0000000+00:00",
                        "userCreated": "string"
                      },
                      "contact": {
                        "type": "string",
                        "name": "string",
                        "title": "string",
                        "phone": "string",
                        "mobile": "string",
                        "fax": "string",
                        "email": "string"
                      },
                      "additionalReferences": [
                        {
                          "type": "string",
                          "description": "string",
                          "value": "string"
                        }
                      ],
                      "dateModified": "2024-02-14T11:49:51.0000000+00:00",
                      "userModified": "string",
                      "dateCreated": "2024-02-14T11:49:51.0000000+00:00",
                      "userCreated": "string"
                    },
                    "receivingAgent": {
                      "type": "string",
                      "code": "string",
                      "externalCode": "string",
                      "isActive": true,
                      "fullName": "string",
                      "closestPort": "string",
                      "currency": "string",
                      "phoneNumber": "string",
                      "email": "string",
                      "vatNumber": "string",
                      "registeredNumber": "string",
                      "ediCode": "string",
                      "address": {
                        "name": "string",
                        "address1": "string",
                        "address2": "string",
                        "address3": "string",
                        "unloco": "string",
                        "city": "string",
                        "state": "string",
                        "postCode": "string",
                        "countryCode": "string",
                        "country": "string",
                        "addressCode": "string",
                        "lockUNLOCO": true,
                        "longitude": 0,
                        "latitude": 0,
                        "dateModified": "2024-02-14T11:49:51.0000000+00:00",
                        "userModified": "string",
                        "dateCreated": "2024-02-14T11:49:51.0000000+00:00",
                        "userCreated": "string"
                      },
                      "contact": {
                        "type": "string",
                        "name": "string",
                        "title": "string",
                        "phone": "string",
                        "mobile": "string",
                        "fax": "string",
                        "email": "string"
                      },
                      "additionalReferences": [
                        {
                          "type": "string",
                          "description": "string",
                          "value": "string"
                        }
                      ],
                      "dateModified": "2024-02-14T11:49:51.0000000+00:00",
                      "userModified": "string",
                      "dateCreated": "2024-02-14T11:49:51.0000000+00:00",
                      "userCreated": "string"
                    },
                    "carrier": {
                      "type": "string",
                      "code": "string",
                      "externalCode": "string",
                      "isActive": true,
                      "fullName": "string",
                      "closestPort": "string",
                      "currency": "string",
                      "phoneNumber": "string",
                      "email": "string",
                      "vatNumber": "string",
                      "registeredNumber": "string",
                      "ediCode": "string",
                      "address": {
                        "name": "string",
                        "address1": "string",
                        "address2": "string",
                        "address3": "string",
                        "unloco": "string",
                        "city": "string",
                        "state": "string",
                        "postCode": "string",
                        "countryCode": "string",
                        "country": "string",
                        "addressCode": "string",
                        "lockUNLOCO": true,
                        "longitude": 0,
                        "latitude": 0,
                        "dateModified": "2024-02-14T11:49:51.0000000+00:00",
                        "userModified": "string",
                        "dateCreated": "2024-02-14T11:49:51.0000000+00:00",
                        "userCreated": "string"
                      },
                      "contact": {
                        "type": "string",
                        "name": "string",
                        "title": "string",
                        "phone": "string",
                        "mobile": "string",
                        "fax": "string",
                        "email": "string"
                      },
                      "additionalReferences": [
                        {
                          "type": "string",
                          "description": "string",
                          "value": "string"
                        }
                      ],
                      "dateModified": "2024-02-14T11:49:51.0000000+00:00",
                      "userModified": "string",
                      "dateCreated": "2024-02-14T11:49:51.0000000+00:00",
                      "userCreated": "string"
                    },
                    "parties": [
                      {
                        "type": "string",
                        "code": "string",
                        "externalCode": "string",
                        "isActive": true,
                        "fullName": "string",
                        "closestPort": "string",
                        "currency": "string",
                        "phoneNumber": "string",
                        "email": "string",
                        "vatNumber": "string",
                        "registeredNumber": "string",
                        "ediCode": "string",
                        "address": {
                          "name": "string",
                          "address1": "string",
                          "address2": "string",
                          "address3": "string",
                          "unloco": "string",
                          "city": "string",
                          "state": "string",
                          "postCode": "string",
                          "countryCode": "string",
                          "country": "string",
                          "addressCode": "string",
                          "lockUNLOCO": true,
                          "longitude": 0,
                          "latitude": 0,
                          "dateModified": "2024-02-14T11:49:51.0000000+00:00",
                          "userModified": "string",
                          "dateCreated": "2024-02-14T11:49:51.0000000+00:00",
                          "userCreated": "string"
                        },
                        "contact": {
                          "type": "string",
                          "name": "string",
                          "title": "string",
                          "phone": "string",
                          "mobile": "string",
                          "fax": "string",
                          "email": "string"
                        },
                        "additionalReferences": [
                          {
                            "type": "string",
                            "description": "string",
                            "value": "string"
                          }
                        ],
                        "dateModified": "2024-02-14T11:49:51.0000000+00:00",
                        "userModified": "string",
                        "dateCreated": "2024-02-14T11:49:51.0000000+00:00",
                        "userCreated": "string"
                      }
                    ],
                    "dateModified": "2024-02-14T11:49:51.0000000+00:00",
                    "userModified": "string",
                    "dateCreated": "2024-02-14T11:49:51.0000000+00:00",
                    "userCreated": "string"
                  }
                ],
                "containers": [
                  {
                    "containerNumber": "string",
                    "interimContainerNumber": "string",
                    "state": "Provisional",
                    "isShipperOwned": true,
                    "containerMode": "string",
                    "containerStatus": "string",
                    "sealNumber": "string",
                    "additionalSealNumber": "string",
                    "additional2SealNumber": "string",
                    "containerCount": 0,
                    "dunnageWeight": 0,
                    "grossWeight": 0,
                    "unitOfweight": "string",
                    "tareWeight": 0,
                    "containerCommodityCode": "string",
                    "movementType": "string",
                    "equipmentType": "string",
                    "fclAvailableDate": "2024-02-14T11:49:51.0000000+00:00",
                    "fclStorageDate": "2024-02-14T11:49:51.0000000+00:00",
                    "emptyRequiredBy": "2024-02-14T11:49:51.0000000+00:00",
                    "estimatedFCLPickupDate": "2024-02-14T11:49:51.0000000+00:00",
                    "lclAvailableDate": "2024-02-14T11:49:51.0000000+00:00",
                    "lclStorageDate": "2024-02-14T11:49:51.0000000+00:00",
                    "bookedDeliveryDate": "2024-02-14T11:49:51.0000000+00:00",
                    "requestedDeliveryDate": "2024-02-14T11:49:51.0000000+00:00",
                    "estimatedDeliveryDate": "2024-02-14T11:49:51.0000000+00:00",
                    "actualFullDeliveryDate": "2024-02-14T11:49:51.0000000+00:00",
                    "deliveryTransportAdvisedDate": "2024-02-14T11:49:51.0000000+00:00",
                    "requestedCollectionDate": "2024-02-14T11:49:51.0000000+00:00",
                    "estimatedCollectionDate": "2024-02-14T11:49:51.0000000+00:00",
                    "actualFullPickupDate": "2024-02-14T11:49:51.0000000+00:00",
                    "portTransportBookedDate": "2024-02-14T11:49:51.0000000+00:00",
                    "fullLoadPortFreeTime": 0,
                    "bookingCreatedDate": "2024-02-14T11:49:51.0000000+00:00",
                    "bookingModifiedDate": "2024-02-14T11:49:51.0000000+00:00",
                    "bookingCreatedUser": "string",
                    "bookingModifiedUser": "string",
                    "volume": 0,
                    "temperatureControlled": true,
                    "refrigerationType": "string",
                    "tempSetPoint": 0,
                    "tempSetPointUnit": "string",
                    "goodsDescription": "string",
                    "isoType": "string",
                    "emptyPickupNumber": "string",
                    "exportPortTransportReference": "string",
                    "exportSlotBookingReference": "string",
                    "importReleaseNumber": "string",
                    "importPortTransportReference": "string",
                    "importSlotBookingReference": "string",
                    "emptyReturnReference": "string",
                    "emptyReleasedFromCY": "2024-02-14T11:49:51.0000000+00:00",
                    "emptyReturnedOn": "2024-02-14T11:49:51.0000000+00:00",
                    "fclWharfGateIn": "2024-02-14T11:49:51.0000000+00:00",
                    "fclWharfGateOut": "2024-02-14T11:49:51.0000000+00:00",
                    "fclLoadedDate": "2024-02-14T11:49:51.0000000+00:00",
                    "fclUnloadedDate": "2024-02-14T11:49:51.0000000+00:00",
                    "tempSetPointDisplay": "string",
                    "orderNumbers": "string",
                    "demurrageBegins": "2024-02-14T11:49:51.0000000+00:00",
                    "teu": 0,
                    "estimatedPickupDate": "2024-02-14T11:49:51.0000000+00:00",
                    "dateModified": "2024-02-14T11:49:51.0000000+00:00",
                    "userModified": "string",
                    "dateCreated": "2024-02-14T11:49:51.0000000+00:00",
                    "userCreated": "string",
                    "parties": [
                      {
                        "type": "string",
                        "code": "string",
                        "externalCode": "string",
                        "isActive": true,
                        "fullName": "string",
                        "closestPort": "string",
                        "currency": "string",
                        "phoneNumber": "string",
                        "email": "string",
                        "vatNumber": "string",
                        "registeredNumber": "string",
                        "ediCode": "string",
                        "address": {
                          "name": "string",
                          "address1": "string",
                          "address2": "string",
                          "address3": "string",
                          "unloco": "string",
                          "city": "string",
                          "state": "string",
                          "postCode": "string",
                          "countryCode": "string",
                          "country": "string",
                          "addressCode": "string",
                          "lockUNLOCO": true,
                          "longitude": 0,
                          "latitude": 0,
                          "dateModified": "2024-02-14T11:49:51.0000000+00:00",
                          "userModified": "string",
                          "dateCreated": "2024-02-14T11:49:51.0000000+00:00",
                          "userCreated": "string"
                        },
                        "contact": {
                          "type": "string",
                          "name": "string",
                          "title": "string",
                          "phone": "string",
                          "mobile": "string",
                          "fax": "string",
                          "email": "string"
                        },
                        "additionalReferences": [
                          {
                            "type": "string",
                            "description": "string",
                            "value": "string"
                          }
                        ],
                        "dateModified": "2024-02-14T11:49:51.0000000+00:00",
                        "userModified": "string",
                        "dateCreated": "2024-02-14T11:49:51.0000000+00:00",
                        "userCreated": "string"
                      }
                    ],
                    "customFields": [
                      {
                        "name": "string",
                        "type": "string",
                        "value": "string",
                        "dateModified": "2024-02-14T11:49:51.0000000+00:00",
                        "userModified": "string",
                        "dateCreated": "2024-02-14T11:49:51.0000000+00:00",
                        "userCreated": "string"
                      }
                    ],
                    "events": [
                      {
                        "eventCode": "string",
                        "description": "string",
                        "eventDate": "2024-02-14T11:49:51.0000000+00:00",
                        "reasonCodes": "string",
                        "eventPlace": "string",
                        "eventSource": "string",
                        "qaIssueCode": "string",
                        "qaIssueNotes": "string",
                        "qaIssueResolvedDate": "2024-02-14T11:49:51.0000000+00:00",
                        "vehicleRegistration": "string",
                        "driverName": "string",
                        "secondDriver": "string",
                        "qaIssueCodeDescription": "string",
                        "externalTrackingLink": "string",
                        "dateModified": "2024-02-14T11:49:51.0000000+00:00",
                        "userModified": "string",
                        "dateCreated": "2024-02-14T11:49:51.0000000+00:00",
                        "userCreated": "string"
                      }
                    ]
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "example": {
                  "EventCreated": true,
                  "ID": "7c6c3c04-6106-4ec1-255f-08dc2c5c0d8f"
                }
              }
            }
          }
        }
      }
    },
    "/event/ServiceProvider": {
      "post": {
        "tags": [
          "Events"
        ],
        "summary": "2. Create Events as a Service Provider",
        "description": "Create Events as a Service Provider",
        "operationId": "POSTevent-ServiceProvider",
        "parameters": [
          {
            "name": "authorization",
            "in": "header",
            "description": "DSV Authorization header",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/eDC.Web.Api.v2.Models.EventRequest"
              },
              "example": {
                "module": "string",
                "entityNumber": "string",
                "secondaryNumber": "string",
                "eventCode": "string",
                "description": "string",
                "eventDate": "2024-02-14T11:49:51.0000000+00:00",
                "reasonCodes": "string",
                "eventPlace": "string",
                "eventSource": "string",
                "qaIssueCode": "string",
                "qaIssueNotes": "string",
                "qaIssueResolvedDate": "2024-02-14T11:49:51.0000000+00:00",
                "vehicleRegistration": "string",
                "driverName": "string",
                "secondDriver": "string",
                "note": "string",
                "locationCode": "string",
                "reference": "string",
                "intendedParties": "string",
                "externalTrackingLink": "string",
                "customFields": [
                  {
                    "name": "string",
                    "type": "string",
                    "value": "string"
                  }
                ],
                "references": [
                  {
                    "type": "string",
                    "value": "string",
                    "customField": true,
                    "customFieldType": "string"
                  }
                ],
                "transportLegs": [
                  {
                    "transportMode": "string",
                    "consolMode": "string",
                    "consolNumber": "string",
                    "masterBill": "string",
                    "bookingReference": "string",
                    "agentsReference": "string",
                    "customsReference": "string",
                    "prepaidCollect": "string",
                    "loadPort": "string",
                    "dischargePort": "string",
                    "portOfFirstArrival": "string",
                    "eta": "2024-02-14T11:49:51.0000000+00:00",
                    "etd": "2024-02-14T11:49:51.0000000+00:00",
                    "ata": "2024-02-14T11:49:51.0000000+00:00",
                    "atd": "2024-02-14T11:49:51.0000000+00:00",
                    "vessel": "string",
                    "voyageFlight": "string",
                    "fullLoadPortFreeTime": 0,
                    "oceanCarrier": "string",
                    "airCarrier": "string",
                    "weight": {
                      "value": 0,
                      "unit": "string"
                    },
                    "volume": {
                      "value": 0,
                      "unit": "string"
                    },
                    "chargeable": {
                      "value": 0,
                      "unit": "string"
                    },
                    "releaseType": "string",
                    "teuCount": 0,
                    "countOfTEU": 0,
                    "countOf20FT": 0,
                    "countOf40FT": 0,
                    "countOf45FT": 0,
                    "stageNumber": "string",
                    "sta": "2024-02-14T11:49:51.0000000+00:00",
                    "std": "2024-02-14T11:49:51.0000000+00:00",
                    "qualifier": "string",
                    "legOrder": 0,
                    "legType": "string",
                    "carrierCode": "string",
                    "carrierSCAC": "string",
                    "carrierDakoskyCode": "string",
                    "carrierNationality": "string",
                    "localCarrierCode": "string",
                    "serviceLevel": "string",
                    "legNotes": "string",
                    "imoNumber": "string",
                    "status": "string",
                    "definedBy": "string",
                    "charterRoute": "string",
                    "isCharter": true,
                    "isLinked": true,
                    "isMainCarriage": true,
                    "isPlannedLeg": true,
                    "numberOfShipments": 0,
                    "numberOfPackages": 0,
                    "numberOfOriginalBills": 0,
                    "numberOfCopyBills": 0,
                    "linkReference": "string",
                    "ownerCodeInternal": "string",
                    "ownerCodeExternal": "string",
                    "source": "string",
                    "sendingAgent": {
                      "type": "string",
                      "code": "string",
                      "externalCode": "string",
                      "isActive": true,
                      "fullName": "string",
                      "closestPort": "string",
                      "currency": "string",
                      "phoneNumber": "string",
                      "email": "string",
                      "vatNumber": "string",
                      "registeredNumber": "string",
                      "ediCode": "string",
                      "address": {
                        "name": "string",
                        "address1": "string",
                        "address2": "string",
                        "address3": "string",
                        "unloco": "string",
                        "city": "string",
                        "state": "string",
                        "postCode": "string",
                        "countryCode": "string",
                        "country": "string",
                        "addressCode": "string",
                        "lockUNLOCO": true,
                        "longitude": 0,
                        "latitude": 0,
                        "dateModified": "2024-02-14T11:49:51.0000000+00:00",
                        "userModified": "string",
                        "dateCreated": "2024-02-14T11:49:51.0000000+00:00",
                        "userCreated": "string"
                      },
                      "contact": {
                        "type": "string",
                        "name": "string",
                        "title": "string",
                        "phone": "string",
                        "mobile": "string",
                        "fax": "string",
                        "email": "string"
                      },
                      "additionalReferences": [
                        {
                          "type": "string",
                          "description": "string",
                          "value": "string"
                        }
                      ],
                      "dateModified": "2024-02-14T11:49:51.0000000+00:00",
                      "userModified": "string",
                      "dateCreated": "2024-02-14T11:49:51.0000000+00:00",
                      "userCreated": "string"
                    },
                    "receivingAgent": {
                      "type": "string",
                      "code": "string",
                      "externalCode": "string",
                      "isActive": true,
                      "fullName": "string",
                      "closestPort": "string",
                      "currency": "string",
                      "phoneNumber": "string",
                      "email": "string",
                      "vatNumber": "string",
                      "registeredNumber": "string",
                      "ediCode": "string",
                      "address": {
                        "name": "string",
                        "address1": "string",
                        "address2": "string",
                        "address3": "string",
                        "unloco": "string",
                        "city": "string",
                        "state": "string",
                        "postCode": "string",
                        "countryCode": "string",
                        "country": "string",
                        "addressCode": "string",
                        "lockUNLOCO": true,
                        "longitude": 0,
                        "latitude": 0,
                        "dateModified": "2024-02-14T11:49:51.0000000+00:00",
                        "userM

# --- truncated at 32 KB (190 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/dsv/refs/heads/main/openapi/dsv-edc-events-api-v2-openapi.json