DSV SCM Load Plan API
Creates and manages load plans in the DSV SCM (eDC) platform across transport legs, each leg carrying carrier code, carrier SCAC and DSV's internal Dakosky carrier code.
OpenAPI Specification
{
"openapi": "3.0.1",
"info": {
"title": "Loadplan - SCM",
"description": "SCM Loadplan API",
"version": "v2"
},
"servers": [
{
"url": "https://api.dsv.com/om/loadplans/v2"
}
],
"paths": {
"/loadplan/SearchCriteria": {
"post": {
"tags": [
"LoadPlans"
],
"summary": "7. Search Criteria",
"description": "Search Criteria",
"operationId": "POSTloadplan-SearchCriteria",
"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.Search.SearchRequest"
},
"example": {
"grid": {
"Page": 0,
"PageSize": 0,
"Sorts": [
{
"Member": "string",
"SortDirection": "Ascending"
}
],
"Filters": [
{}
],
"Groups": [
{
"MemberType": "string",
"DisplayContent": {},
"AggregateFunctions": [
{
"AggregateMethodName": "string",
"Caption": "string",
"SourceField": "string",
"FunctionName": "string",
"MemberType": "string",
"ResultFormatString": "string"
}
],
"Member": "string",
"SortDirection": "Ascending"
}
],
"Aggregates": [
{
"Aggregates": [
{
"AggregateMethodName": "string",
"Caption": "string",
"SourceField": "string",
"FunctionName": "string",
"MemberType": "string",
"ResultFormatString": "string"
}
],
"Member": "string"
}
]
},
"criteria": "string"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/eDC.Web.Api.v2.Models.Entities.LoadPlan"
}
},
"example": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"loadPlanNumber": "string",
"state": "Provisional",
"transportMode": "string",
"packingMode": "string",
"freightTerm": "string",
"serviceLevel": "string",
"serviceLevelDescription": "string",
"loadingInstructions": "string",
"shippingInstructions": "string",
"loadingMeters": 0,
"movementType": "string",
"dischargePort": "string",
"loadPort": "string",
"requiredLoadingDate": "2024-02-14T11:31:09.0000000+00:00",
"requiredUnloadingDate": "2024-02-14T11:31:09.0000000+00:00",
"requiredArrivalDate": "2024-02-14T11:31:09.0000000+00:00",
"requiredDepartureDate": "2024-02-14T11:31:09.0000000+00:00",
"cfsClosingDate": "2024-02-14T11:31:09.0000000+00:00",
"vessel": "string",
"voyageFlight": "string",
"cfsClosingDateWeekNumber": 0,
"requiredDepartureWeekNumber": 0,
"requiredArrivalWeekNumber": 0,
"requiredLoadingWeekNumber": 0,
"requiredUnloadingWeekNumber": 0,
"confirmedDate": "2024-02-14T11:31:09.0000000+00:00",
"loadedDate": "2024-02-14T11:31:09.0000000+00:00",
"cancelledDate": "2024-02-14T11:31:09.0000000+00:00",
"source": "string",
"rejectedDate": "2024-02-14T11:31:09.0000000+00:00",
"approvedDate": "2024-02-14T11:31:09.0000000+00:00",
"bookingNumbers": [
"string"
],
"unitOfWeight": "string",
"unitOfVolume": "string",
"totalPackages": 0,
"totalWeight": 0,
"totalVolume": 0,
"volumeCapacity": 0,
"weightCapacity": 0,
"dateModified": "2024-02-14T11:31:09.0000000+00:00",
"userModified": "string",
"dateCreated": "2024-02-14T11:31:09.0000000+00:00",
"userCreated": "string",
"events": [
{
"eventCode": "string",
"description": "string",
"eventDate": "2024-02-14T11:31:09.0000000+00:00",
"reasonCodes": "string",
"eventPlace": "string",
"eventSource": "string",
"qaIssueCode": "string",
"qaIssueNotes": "string",
"qaIssueResolvedDate": "2024-02-14T11:31:09.0000000+00:00",
"vehicleRegistration": "string",
"driverName": "string",
"secondDriver": "string",
"qaIssueCodeDescription": "string",
"externalTrackingLink": "string",
"dateModified": "2024-02-14T11:31:09.0000000+00:00",
"userModified": "string",
"dateCreated": "2024-02-14T11:31:09.0000000+00:00",
"userCreated": "string"
}
],
"notes": [
{
"description": "string",
"noteText": "string",
"noteType": "string",
"noteContext": "string",
"intendedParty": "string",
"read": true,
"source": "string",
"isPublished": true,
"resolvedDate": "2024-02-14T11:31:09.0000000+00:00",
"assignedUser": "string",
"dateModified": "2024-02-14T11:31:09.0000000+00:00",
"userModified": "string",
"dateCreated": "2024-02-14T11:31:09.0000000+00:00",
"userCreated": "string"
}
],
"equipmentTypes": [
{
"type": "string",
"noOfUnits": 0,
"containerNumber": "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:31:09.0000000+00:00",
"userModified": "string",
"dateCreated": "2024-02-14T11:31:09.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:31:09.0000000+00:00",
"userModified": "string",
"dateCreated": "2024-02-14T11:31:09.0000000+00:00",
"userCreated": "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:31:09.0000000+00:00",
"etd": "2024-02-14T11:31:09.0000000+00:00",
"ata": "2024-02-14T11:31:09.0000000+00:00",
"atd": "2024-02-14T11:31:09.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:31:09.0000000+00:00",
"std": "2024-02-14T11:31:09.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:31:09.0000000+00:00",
"userModified": "string",
"dateCreated": "2024-02-14T11:31:09.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:31:09.0000000+00:00",
"userModified": "string",
"dateCreated": "2024-02-14T11:31:09.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:31:09.0000000+00:00",
"userModified": "string",
"dateCreated": "2024-02-14T11:31:09.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:31:09.0000000+00:00",
"userModified": "string",
"dateCreated": "2024-02-14T11:31:09.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:31:09.0000000+00:00",
"userModified": "string",
"dateCreated": "2024-02-14T11:31:09.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:31:09.0000000+00:00",
"userModified": "string",
"dateCreated": "2024-02-14T11:31:09.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:31:09.0000000+00:00",
"userModified": "string",
"dateCreated": "2024-02-14T11:31:09.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:31:09.0000000+00:00",
"userModified": "string",
"dateCreated": "2024-02-14T11:31:09.0000000+00:00",
"userCreated": "string"
}
],
"dateModified": "2024-02-14T11:31:09.0000000+00:00",
"userModified": "string",
"dateCreated": "2024-02-14T11:31:09.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:31:09.0000000+00:00",
"fclStorageDate": "2024-02-14T11:31:09.0000000+00:00",
"emptyRequiredBy": "2024-02-14T11:31:09.0000000+00:00",
"estimatedFCLPickupDate": "2024-02-14T11:31:09.0000000+00:00",
"lclAvailableDate": "2024-02-14T11:31:09.0000000+00:00",
"lclStorageDate": "2024-02-14T11:31:09.0000000+00:00",
"bookedDeliveryDate": "2024-02-14T11:31:09.0000000+00:00",
"requestedDeliveryDate": "2024-02-14T11:31:09.0000000+00:00",
"estimatedDeliveryDate": "2024-02-14T11:31:09.0000000+00:00",
"actualFullDeliveryDate": "2024-02-14T11:31:09.0000000+00:00",
"deliveryTransportAdvisedDate": "2024-02-14T11:31:09.0000000+00:00",
"requestedCollectionDate": "2024-02-14T11:31:09.0000000+00:00",
"estimatedCollectionDate": "2024-02-14T11:31:09.0000000+00:00",
"actualFullPickupDate": "2024-02-14T11:31:09.0000000+00:00",
"portTransportBookedDate": "2024-02-14T11:31:09.0000000+00:00",
"fullLoadPortFreeTime": 0,
"bookingCreatedDate": "2024-02-14T11:31:09.0000000+00:00",
"bookingModifiedDate": "2024-02-14T11:31:09.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:31:09.0000000+00:00",
"emptyReturnedOn": "2024-02-14T11:31:09.0000000+00:00",
"fclWharfGateIn": "2024-02-14T11:31:09.0000000+00:00",
"fclWharfGateOut": "2024-02-14T11:31:09.0000000+00:00",
"fclLoadedDate": "2024-02-14T11:31:09.0000000+00:00",
"fclUnloadedDate": "2024-02-14T11:31:09.0000000+00:00",
"tempSetPointDisplay": "string",
"orderNumbers": "string",
"demurrageBegins": "2024-02-14T11:31:09.0000000+00:00",
"teu": 0,
"estimatedPickupDate": "2024-02-14T11:31:09.0000000+00:00",
"dateModified": "2024-02-14T11:31:09.0000000+00:00",
"userModified": "string",
"dateCreated": "2024-02-14T11:31:09.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:31:09.0000000+00:00",
"userModified": "string",
"dateCreated": "2024-02-14T11:31:09.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:31:09.0000000+00:00",
"userModified": "string",
"dateCreated": "2024-02-14T11:31:09.0000000+00:00",
"userCreated": "string"
}
],
"customFields": [
{
"name": "string",
"type": "string",
"value": "string",
"dateModified": "2024-02-14T11:31:09.0000000+00:00",
"userModified": "string",
"dateCreated": "2024-02-14T11:31:09.0000000+00:00",
"userCreated": "string"
}
],
"events": [
{
"eventCode": "string",
"description": "string",
"eventDate": "2024-02-14T11:31:09.0000000+00:00",
"reasonCodes": "string",
"eventPlace": "string",
"eventSource": "string",
"qaIssueCode": "string",
"qaIssueNotes": "string",
"qaIssueResolvedDate": "2024-02-14T11:31:09.0000000+00:00",
"vehicleRegistration": "string",
"driverName": "string",
"secondDriver": "string",
"qaIssueCodeDescription": "string",
"externalTrackingLink": "string",
"dateModified": "2024-02-14T11:31:09.0000000+00:00",
"userModified": "string",
"dateCreated": "2024-02-14T11:31:09.0000000+00:00",
"userCreated": "string"
}
]
}
],
"bookings": [
{
"bookingNumber": "string",
"externalBookingNumber": "string",
"externalBookingSender": "string",
"state": "Provisional",
"origin": "string",
"destination": "string",
"incoterm": "string",
"additionalTerms": "string",
"additionalTermsUNLOCO": "string",
"freightTerm": "string",
"orderNumbers": "string",
# --- truncated at 32 KB (422 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/dsv/refs/heads/main/openapi/dsv-edc-loadplan-api-v2-openapi.json