DSV SCM eDocs API
Adds and retrieves electronic documents against SCM orders, bookings and shipments in the DSV eDC platform.
OpenAPI Specification
{
"openapi": "3.0.1",
"info": {
"title": "eDOCS - SCM",
"description": "SCM eDOCS API",
"version": "v2"
},
"servers": [
{
"url": "https://api.dsv.com/om/edocs/v2"
}
],
"paths": {
"/EDocs": {
"post": {
"tags": [
"EDocs"
],
"summary": "1. Add eDOC",
"description": "Add eDOC",
"operationId": "Add-eDOC",
"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.Entities.StorageDoc"
},
"example": {
"id": "string",
"data": "string",
"parentTableCode": "string",
"parentNumber": "string",
"secondaryParentNumber": "string",
"extension": "string",
"docType": "string",
"description": "string",
"fileName": "string",
"isPublished": true,
"intendedParties": "string",
"size": 0,
"actualUpload": "string",
"dateModified": "string",
"userModified": "string",
"dateCreated": "string",
"userCreated": "string",
"uniqueFileName": true
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/EDocs/Upload/{storageId}": {
"post": {
"tags": [
"EDocs"
],
"summary": "2. Upload eDoc using storageId",
"description": "Upload eDoc using storageId",
"operationId": "Upload-eDoc-using-storageId",
"parameters": [
{
"name": "storageId",
"in": "path",
"description": "Format - uuid.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "authorization",
"in": "header",
"description": "DSV Authorization header",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/EDocs/Download/{storageId}": {
"get": {
"tags": [
"EDocs"
],
"summary": "3. Download eDoc by storageId",
"description": "Download eDoc by storageId",
"operationId": "Download-eDoc-by-storageId",
"parameters": [
{
"name": "storageId",
"in": "path",
"description": "Format - uuid.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "authorization",
"in": "header",
"description": "DSV Authorization header",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/EDocs/{id}": {
"get": {
"tags": [
"EDocs"
],
"summary": "4. Get eDocs metadata by Id",
"description": "Get eDocs metadata by Id",
"operationId": "Get-eDocs-metadata-by-Id",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Format - uuid.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "authorization",
"in": "header",
"description": "DSV Authorization header",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/EDocs/{type}/{parentNumber}/{secondaryParentNumber}": {
"get": {
"tags": [
"EDocs"
],
"summary": "5. Get eDocs by parentNumber and secondaryParentNum",
"description": "Get eDocs by parentNumber and secondaryParentNum",
"operationId": "Get-eDocs-by-parentNumber-and-secondaryParentNumber",
"parameters": [
{
"name": "type",
"in": "path",
"description": "Format - int32.",
"required": true,
"schema": {
"enum": [
"NON",
"ORD",
"ORI",
"OIC",
"BOK",
"BCS",
"SHP",
"CON",
"PTT",
"KDT",
"INV",
"PCK",
"ORG",
"SCN",
"JCN",
"CIH",
"CIL",
"EDM",
"ETL",
"ANN",
"DOC",
"NOT",
"BKC",
"PMD",
"ADN",
"PDG",
"CGR",
"LPL",
"OLM",
"PCT",
"BKT",
"JOI"
],
"type": "string"
}
},
{
"name": "parentNumber",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "secondaryParentNumber",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "authorization",
"in": "header",
"description": "DSV Authorization header",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
}
},
"components": {
"schemas": {
"eDC.Domain.Enums.BookingConsolState": {
"enum": [
"Provisional",
"Confirmed"
],
"type": "string",
"format": "int32"
},
"eDC.Domain.Enums.BookingState": {
"enum": [
"Provisional",
"PreBooked",
"Rejected",
"Booked",
"Approved",
"Confirmed",
"Parked",
"Transmitted",
"PendingConsolidation",
"Planning",
"Planned",
"Consolidated",
"PendingCollection",
"Collected",
"OnHand",
"DepartedOriginCFS",
"Shipped",
"Arrived",
"CustomsCommenced",
"CustomsCleared",
"AvailableDestinationCFS",
"PendingDelivery",
"DepartedDestinationCFS",
"Handover",
"Delivered",
"Suspended",
"Cancelled"
],
"type": "string",
"format": "int32"
},
"eDC.Domain.Enums.CargoReceiptState": {
"enum": [
"Pending",
"Received",
"Putaway",
"Loaded"
],
"type": "string",
"format": "int32"
},
"eDC.Domain.Enums.ContainerState": {
"enum": [
"Provisional",
"ReleasedCY",
"PickupBooked",
"PickedUp",
"GateIn",
"Loaded",
"Shipped",
"Arrived",
"Unloaded",
"DeliveryBooked",
"GateOut",
"Delivered",
"EmptyReadyForReturn",
"EmptyReturned"
],
"type": "string",
"format": "int32"
},
"eDC.Domain.Enums.KpiStatus": {
"enum": [
"None",
"InProgress",
"CompletedOnSchedule",
"Due",
"OverDue"
],
"type": "string",
"format": "int32"
},
"eDC.Domain.Enums.LoadPlanState": {
"enum": [
"Provisional",
"Submitted",
"Rejected",
"Approved",
"Confirmed",
"Accepted",
"Loaded",
"Declined",
"Cancelled"
],
"type": "string",
"format": "int32"
},
"eDC.Domain.Enums.LoadPlanType": {
"enum": [
"PLAN",
"CONSOL"
],
"type": "string",
"format": "int32"
},
"eDC.Domain.Enums.ModuleType": {
"enum": [
"Order",
"Shipment",
"Booking",
"ShipmentContainer",
"ShipmentPackLine",
"ConsolContainer",
"OrderLine",
"BookingPackLine",
"EDI",
"OrderLineManager",
"Announcement",
"Document",
"Note",
"BookingContainer",
"OrderPackLine",
"LoadPlan",
"EventMilestone",
"Company",
"ExceptionPanelConfiguration",
"Unspecified"
],
"type": "string",
"format": "int32"
},
"eDC.Domain.Enums.OrderEventCode": {
"enum": [
"ADD",
"ATS",
"DTS",
"CNF",
"UCF",
"ONH",
"EEX",
"OUD",
"FUP",
"CAI",
"QA",
"GR",
"CAN",
"UCA",
"UPD",
"ATB",
"DFB",
"CCI"
],
"type": "string",
"format": "int32"
},
"eDC.Domain.Enums.OrderState": {
"enum": [
"Provisional",
"Open",
"Confirmed",
"OnHand",
"BookingProvisional",
"BookingPreBooked",
"BookingBooked",
"BookingRejected",
"BookingApproved",
"BookingConfirmed",
"BookingParked",
"PendingConsolidation",
"Planning",
"Planned",
"Consolidated",
"PendingCollection",
"Collected",
"BookingOnHand",
"DepartedOriginCFS",
"Shipped",
"Arrived",
"CustomsCommenced",
"CustomsCleared",
"AvailableDestinationCFS",
"PendingDelivery",
"DepartedDestinationCFS",
"Handover",
"Delivered",
"Fulfilled",
"Suspended",
"Cancelled"
],
"type": "string",
"format": "int32"
},
"eDC.Domain.Enums.PackingStatus": {
"enum": [
"PND",
"DLV",
"CAN"
],
"type": "string",
"format": "int32"
},
"eDC.Domain.Enums.PackingType": {
"enum": [
"Individual",
"Aggregated",
"ExportLoad"
],
"type": "string",
"format": "int32"
},
"eDC.Domain.Enums.ShipmentState": {
"enum": [
"Booked",
"PendingConsolidation",
"Planning",
"Planned",
"Consolidated",
"Accepted",
"PendingCollection",
"Collected",
"OnHand",
"DepartedOriginCFS",
"Shipped",
"Arrived",
"CustomsCommenced",
"CustomsCleared",
"AvailableDestinationCFS",
"PendingDelivery",
"DepartedDestinationCFS",
"Handover",
"Delivered",
"Declined",
"Suspended",
"Cancelled"
],
"type": "string",
"format": "int32"
},
"eDC.Domain.Enums.SplitMode": {
"enum": [
"None",
"Manual",
"Auto"
],
"type": "string",
"format": "int32"
},
"eDC.Domain.Enums.SubscriptionType": {
"enum": [
"All",
"Include",
"Exclude"
],
"type": "string",
"format": "int32"
},
"eDC.Domain.Enums.TableCode3": {
"enum": [
"NON",
"ORD",
"ORI",
"OIC",
"BOK",
"BCS",
"SHP",
"CON",
"PTT",
"KDT",
"INV",
"PCK",
"ORG",
"SCN",
"JCN",
"CIH",
"CIL",
"EDM",
"ETL",
"ANN",
"DOC",
"NOT",
"BKC",
"PMD",
"ADN",
"PDG",
"CGR",
"LPL",
"OLM",
"PCT",
"BKT",
"JOI",
"EPC"
],
"type": "string",
"format": "int32"
},
"eDC.Web.Api.v2.Controllers.ChangeStateRequest": {
"type": "object",
"properties": {
"bookingNumber": {
"type": "string",
"description": "Booking Number",
"nullable": true
},
"state": {
"$ref": "#/components/schemas/eDC.Domain.Enums.BookingState"
},
"note": {
"type": "string",
"description": "Notes",
"nullable": true
},
"intendedParty": {
"type": "string",
"description": "Intended Party",
"nullable": true
}
},
"additionalProperties": false
},
"eDC.Web.Api.v2.Controllers.LoadPlanChangeStateRequest": {
"type": "object",
"properties": {
"loadPlanNumber": {
"type": "string",
"nullable": true
},
"state": {
"$ref": "#/components/schemas/eDC.Domain.Enums.LoadPlanState"
},
"note": {
"type": "string",
"nullable": true
},
"intendedParty": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"eDC.Web.Api.v2.Models.CustomField": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"type": {
"type": "string",
"nullable": true
},
"value": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"eDC.Web.Api.v2.Models.Entities.AdditionalReference": {
"type": "object",
"properties": {
"type": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"value": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"eDC.Web.Api.v2.Models.Entities.Address": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name",
"nullable": true
},
"address1": {
"type": "string",
"description": "Address line 1",
"nullable": true
},
"address2": {
"type": "string",
"description": "Address line 2",
"nullable": true
},
"address3": {
"type": "string",
"description": "Address line 3",
"nullable": true
},
"unloco": {
"type": "string",
"nullable": true
},
"nearestPort": {
"type": "string",
"nullable": true
},
"city": {
"type": "string",
"description": "City",
"nullable": true
},
"state": {
"type": "string",
"description": "State",
"nullable": true
},
"postCode": {
"type": "string",
"description": "Postal code",
"nullable": true
},
"countryCode": {
"type": "string",
"description": "2-Letter Country Code",
"nullable": true
},
"country": {
"type": "string",
"description": "Country",
"nullable": true
},
"addressCode": {
"type": "string",
"description": "Address Code",
"nullable": true
},
"lockUNLOCO": {
"type": "boolean"
},
"longitude": {
"type": "number",
"description": "Longitude",
"format": "double",
"nullable": true
},
"latitude": {
"type": "number",
"description": "Latitude",
"format": "double",
"nullable": true
},
"dateModified": {
"type": "string",
"description": "Date Modified",
"format": "date-time",
"nullable": true
},
"userModified": {
"type": "string",
"description": "User Modified",
"nullable": true
},
"dateCreated": {
"type": "string",
"description": "Creation Date",
"format": "date-time",
"nullable": true
},
"userCreated": {
"type": "string",
"description": "User creating the address",
"nullable": true
}
},
"additionalProperties": false
},
"eDC.Web.Api.v2.Models.Entities.Booking": {
"type": "object",
"properties": {
"bookingNumber": {
"type": "string",
"description": "Booking Number",
"nullable": true
},
"externalBookingNumber": {
"type": "string",
"description": "External Booking Number",
"nullable": true
},
"externalBookingSender": {
"type": "string",
"description": "External Booking Sender",
"nullable": true
},
"state": {
"$ref": "#/components/schemas/eDC.Domain.Enums.BookingState"
},
"origin": {
"type": "string",
"description": "Origin of the Booking",
"nullable": true
},
"destination": {
"type": "string",
"description": "Destination of the Booking",
"nullable": true
},
"incoterm": {
"type": "string",
"description": "Incoterm of the Booking",
"nullable": true
},
"additionalTerms": {
"type": "string",
"description": "Additional Terms of the Booking",
"nullable": true
},
"additionalTermsUNLOCO": {
"type": "string",
"description": "UN Location Code",
"nullable": true
},
"freightTerm": {
"type": "string",
"description": "Freight Terms",
"nullable": true
},
"orderNumbers": {
"type": "string",
"description": "Order Numbers",
"nullable": true
},
"unitOfWeight": {
"type": "string",
"description": "Unit of Measure for Weight",
"nullable": true
},
"weight": {
"type": "number",
"description": "Weight",
"format": "double"
},
"unitOfVolume": {
"type": "string",
"description": "Unit of Measure for Volume",
"nullable": true
},
"volume": {
"type": "number",
"description": "Volume",
"format": "double"
},
"noOfPieces": {
"type": "integer",
"description": "Number of Pieces",
"format": "int32"
},
"orderCurrency": {
"type": "string",
"description": "Currency for the Order",
"nullable": true
},
"totalValue": {
"type": "number",
"description": "Total Value of the Order",
"format": "double"
},
"packingWeight": {
"type": "number",
"description": "Packing Weight",
"format": "double"
},
"packingVolume": {
"type": "number",
"description": "Packing Volume",
"format": "double"
},
"transitWarehouse": {
"type": "string",
"description": "Transit Warehouse",
"nullable": true
},
"onHandDate": {
"type": "string",
"description": "On Hand Date",
"format": "date-time",
"nullable": true
},
"preBooked": {
"type": "string",
"format": "date-time",
"nullable": true
},
"bookedDate": {
"type": "string",
"description": "Date of Booking",
"format": "date-time",
"nullable": true
},
"rejectedDate": {
"type": "string",
"description": "Date of Booking Rejection",
"format": "date-time",
"nullable": true
},
"approvedDate": {
"type": "string",
"description": "Date of Booking Approval",
"format": "date-time",
"nullable": true
},
"confirmedDate": {
"type": "string",
"description": "Date of Booking Confirmation",
"format": "date-time",
"nullable": true
},
"cancelledDate": {
"type": "string",
"description": "Date of Booking Cancellation",
"format": "date-time",
"nullable": true
},
"countOfTEU": {
"type": "number",
"description": "TEU count",
"format": "double"
},
"countOf20FT": {
"type": "integer",
"description": "Count of 20ft Container",
"format": "int32"
},
"countOf40FT": {
"type": "integer",
"description": "Count of 40ft Container",
"format": "int32"
},
"countOf45FT": {
"type": "integer",
"description": "Count of 45ft Container",
"format": "int32"
},
"source": {
"type": "string",
"description": "Source",
"nullable": true
},
"systemID": {
"type": "string",
"description": "System ID",
"format": "uuid",
"nullable": true
},
"isApprovalRequired": {
"type": "boolean",
"description": "Boolean if Approval is required"
},
"transitWarehouseDescription": {
"type": "string",
"description": "Transit Warehouse Description",
"nullable": true
},
"estimatedDeliveryDate": {
"type": "string",
"description": "Estimated Delivery Date",
"format": "date-time",
"nullable": true
},
"collectionRequiredDate": {
"type": "string",
"description": "Collection Required Date",
"format": "date-time",
"nullable": true
},
"collectionRequiredDateBy": {
"type": "string",
"description": "Collection Required Date By",
"format": "date-time",
"nullable": true
},
"deliveryRequiredDate": {
"type": "string",
"description": "Delivery Required Date",
"format": "date-time",
"nullable": true
},
"deliveryRequiredDateBy": {
"type": "string",
"description": "Delivery Required Date By",
"format": "date-time",
"nullable": true
},
"isCancelled": {
"type": "boolean",
"description": "Boolean if cancelled"
},
"shipmentNumbers": {
"type": "string",
"description": "Shipment Number",
"nullable": true
},
"noOfContainers": {
"type": "integer",
"description": "Number of Containers",
"format": "int32"
},
"ownership": {
"type": "string",
"description": "Ownership",
"nullable": true
},
"bookingDeliveryInstructions": {
"type": "string",
"description": "Booking Delivery Instruction",
"nullable": true
},
"requiredDepartureWeekNumber": {
"type": "integer",
"description": "Required Departure Week Number",
"format": "int32",
"nullable": true
},
"requiredArrivalWeekNumber": {
"type": "integer",
"description": "Required Arrival Week Number",
"format": "int32",
"nullable": true
},
"cargoReadyDateWeekNumber": {
"type": "integer",
"description": "Cargo Ready Date Week Number",
"format": "int32",
"nullable": true
},
"deliveryDateWeekNumber": {
"type": "integer",
"description": "Delivery Date Week Number",
"format": "int32",
"nullable": true
},
"estimatedDeliveryToOriginCFSWeekNumber": {
"type": "integer",
"description": "Estimated Delivery To Origin CFS Week Number",
"format": "int32",
"nullable": true
},
"supplierRef": {
"type": "string",
"description": "Supplier Reference",
"nullable": true
},
"requiredExFactory": {
"type": "string",
"description": "Required Ex Works Date",
"format": "date-time",
"nullable": true
},
"requiredInStore": {
"type": "string",
"description": "Required in Store Date",
"format": "date-time",
"nullable": true
},
"requestedDepartureDate": {
"type": "string",
"description": "Requested Departure Date",
"format": "date-time",
"nullable": true
},
"requestedArrivalDate": {
"type": "string",
"description": "Requested Arrival Date",
"format": "date-time",
"nullable": true
},
"transportMode": {
"type": "string",
"description": "Mode of Transport",
"nullable": true
},
"containerMode": {
"type": "string",
"description": "Container Mode",
"nullable": true
},
"goodsDescription": {
"type": "string",
"description": "Description of Goods",
"nullable": true
},
"marksAndNumbers": {
"type": "string",
"description": "Marks and Numbers",
"nullable": true
},
"bookingInstructions": {
"type": "string",
"description": "Booking Instructions",
"nullable": true
},
"loadingMeters": {
"type": "number",
"description": "Loading Meters",
"format": "double"
},
"commodityCode": {
"type": "string",
"description": "Commodity Code",
"nullable": true
},
"plannerCode": {
"type": "string",
"description": "Planner Code",
"nullable": true
},
"plannerEmail": {
"type": "string",
"description": "Planner Email",
"nullable": true
},
"loadPort": {
"type": "string",
"description": "Port of loading",
"nullable": true
},
"dischargePort": {
"type": "string",
"description": "Port of discharge",
"nullable": true
},
"sdocComplete": {
"type": "string",
"format": "date-time",
"nullable": true
},
"estimatedDeliveryToOriginCFS": {
"type": "string",
"description": "Estimated Delivery To Origin CFS Date",
"format": "date-time",
"nullable": true
},
"isPickupRequired": {
"type": "boolean",
"description": "Boolean for Pickup required"
},
"shippingInstructions": {
"type": "string",
"description": "Shipment Instructions",
"nullable": true
},
"customerDivision": {
"type": "string",
"nullable": true
},
"carrierSpaceReservation": {
"type": "string",
"format": "date-time",
"nullable": true
},
"followUpDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"dateModified": {
"type": "string",
"description": "Date Modified",
"format": "date-time",
"nullable": true
},
"userModified": {
"type": "string",
"description": "User Modified",
"nullable": true
},
"dateCreated": {
"type": "string",
"description": "Date Created",
"format": "date-time",
"nullable": true
},
"userCreated": {
"type": "string",
"description": "User Created",
"nullable": true
},
"isSuspended": {
"type": "boolean"
},
"suspendedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"loadPlanNumber": {
"type": "string",
"nullable": true
},
"shipmentNumber": {
"type": "string",
"nullable": true
},
"temperatureControl": {
"$ref": "#/components/schemas/eDC.Web.Api.v2.Models.Entities.TemperatureControl"
},
"customFields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/eDC.Web.Api.v2.Models.Entities.GenCustomAddOnValue"
},
"description": "Custom Fields",
"nullable": true
},
"additionalReferences": {
"type": "array",
"items": {
"$ref": "#/components/schemas/eDC.Web.Api.v2.Models.Entities.AdditionalReference"
},
"nullable": true
},
"parties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/eDC.Web.Api.v2.Models.Entities.Company"
},
"description": "Parties",
"nullable": true
},
"packLines": {
"type": "array",
"items": {
"$ref": "#/components/schemas/eDC.Web.Api.v2.Models.Entities.JobPackLine"
},
"description": "Pack Lines",
"nullable": true
},
"equipmentTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/eDC.Web.Api.v2.Models.Entities.EquipmentType"
},
"description": "Equipment Types",
"nullable": true
},
"notes": {
"type": "array",
"items": {
"$ref": "#/com
# --- truncated at 32 KB (147 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/dsv/refs/heads/main/openapi/dsv-edc-edocs-api-v2-openapi.json