DSV SCM Booking API
Creates and searches bookings in the DSV SCM (eDC) platform, including original/copy bill of lading counts, carrier SCAC and carrier contract numbers.
OpenAPI Specification
{
"openapi": "3.0.1",
"info": {
"title": "Booking - SCM",
"description": "SCM booking API",
"version": "v2"
},
"servers": [
{
"url": "https://api.dsv.com/om/bookings/v2"
}
],
"paths": {
"/Bookings/SearchCriteria": {
"post": {
"tags": [
"Bookings"
],
"summary": "1. Search for Bookings by criteria",
"description": "1. Search for Bookings by criteria",
"operationId": "Search-for-Bookings-by-criteria",
"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": {
"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"
}
]
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/Bookings/{bookingNumber}": {
"get": {
"tags": [
"Bookings"
],
"summary": "2. Get Bookings by booking number",
"description": "2. Get Bookings by booking number",
"operationId": "Get-Bookings-by-booking-number",
"parameters": [
{
"name": "bookingNumber",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "authorization",
"in": "header",
"description": "DSV Authorization header",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/eDC.Web.Api.v2.Models.Entities.Booking"
}
},
"example": {
"Header": {
"MessageId": "0f6b70c8-2c26-4d1d-9b9e-03a68fec52f0",
"TimeStamp": "2022-11-01T12:00:00.0000000+00:00",
"Source": {
"ApplicationCode": "CUSTOMER_SYSTEM",
"EnterpriseCode": "CUSTOMER_APPLICATION",
"Environment": "QA"
},
"Target": {
"ApplicationCode": "eDC",
"EnterpriseCode": "DSV",
"Environment": "QA"
},
"Function": "New"
},
"Booking": {
"ExternalBookingNumber": "BOKEXT014a",
"ExternalBookingSender": "SKUIRRELS",
"Incoterm": "EXW",
"AdditionalTerms": "PETAH",
"SupplierReference": "sup-ref",
"TransportMode": "SEA",
"ContainerMode": "FCL",
"RequestedDepartureDate": "2022-11-01T12:00:00.0000000+00:00",
"RequestedArrivalDate": "2022-11-01T12:00:00.0000000+00:00",
"LoadPort": "ILPET",
"DischargePort": "ILPET",
"GoodsDescription": "Pharmaceuticals",
"MarksAndNumbers": "marks here",
"BookingInstructions": "Pickup and Delivery Transprt Instructions",
"ShippingInstructions": "shipping instructions",
"CustomerDivision": "Parts",
"EquipmentTypes": [
{
"Type": "40HC",
"NoOfUnits": 1,
"ContainerNumber": "CBHU2204309"
}
],
"EstimatedDeliveryToOriginCFS": "2022-11-01T12:00:00.0000000+00:00",
"IsPickupRequired": true,
"CollectionRequiredDate": "2022-11-01T12:00:00.0000000+00:00",
"CollectionRequiredDateBy": "2022-11-01T06:00:00.0000000+00:00",
"DeliveryRequiredDate": "2022-11-01T12:00:00.0000000+00:00",
"DeliveryRequiredDateBy": "2022-11-01T08:00:00.0000000+00:00",
"PackLinesMethod": "patch",
"PackLines": [
{
"PackageCount": 1,
"PackType": "CTN",
"ContainerPackingOrder": 0,
"Weight": 0,
"UnitOfWeight": "KG",
"Length": 10,
"Height": 10,
"Width": 10,
"UnitOfDimension": "CM",
"Volume": 0.001,
"UnitOfVolume": "M3",
"RefNumber": null,
"Description": null,
"HarmonisedCode": null,
"CommodityCode": null,
"ContainerNumber": "CBHU2204309",
"LoadingMeters": 0,
"MarksAndNumbers": null,
"ProductCode": null,
"DangerousGoodsRef": null,
"NoOfPallets": 0,
"PackIdentifier": null,
"Sequence": 0,
"Stackable": false,
"PackageMarks": null,
"DangerousGoods": {
"Regulation": "REG",
"HazardClass": null,
"AdditionalHazardClass": null,
"ClassificationCode": null,
"UNDGNumber": "UNDG001",
"Variant": null,
"PSN": null,
"TechnicalName": null,
"Labels": null,
"PackingGroup": null,
"UpperPlate": null,
"LowerPlate": null,
"NumberOfPackages": null,
"PackageType": null,
"PackagingInstruction": null,
"TransportMeansCategory": null,
"GrossWeight": 0,
"NetWeight": 0,
"ExplosiveWeight": 0,
"UnitOfWeight": null,
"FlashPointTemperature": null,
"FlashPointTemperatureUnit": null,
"FlashPointDescription": null,
"TremCardNumber": null,
"EMSNumber": null,
"MFAGNumber": null,
"MarinePollutant": null,
"LimitedQuantity": false,
"TunnelCode": null,
"Remarks": null,
"ContactName": null,
"ContactEmail": null
},
"InnerPackLines": [],
"CustomFields": []
}
],
"Parties": [
{
"Type": "Consignor",
"Code": "5001ACME-IL",
"FullName": "ACME PHARMACEUTICAL INDUST (PHARMA)",
"ClosestPort": null,
"Currency": null,
"PhoneNumber": null,
"Email": null,
"Address": {
"Name": "ACME PHARMACEUTICAL INDUST (PHARMA)",
"Address1": "5 Squirrel Street",
"Address2": null,
"Address3": null,
"UNLOCO": "ILPET",
"City": "PETAH TIKVA",
"State": null,
"PostCode": "49131",
"CountryCode": "IL",
"Country": "ISREAL",
"AddressCode": "Default",
"Longitude": null,
"Latitude": null
}
},
{
"Type": "Consignee",
"Code": "ACME",
"FullName": "ACME PHARMACEUTICAL INDUST (PHARMA)",
"PhoneNumber": null,
"Email": null,
"Address": {
"Name": "ACME PHARMACEUTICAL INDUST (PHARMA)",
"Address1": "5 Squirrel Street",
"Address2": null,
"Address3": null,
"UNLOCO": "ILPET",
"City": "PETAH TIKVA",
"State": null,
"PostCode": "49131",
"CountryCode": "IL",
"Country": "ISREAL",
"AddressCode": "Default",
"Longitude": null,
"Latitude": null
}
},
{
"Type": "DeliveryTo",
"Code": "5001ACME-IL",
"FullName": "ACME PHARMACEUTICAL INDUST (PHARMA)",
"PhoneNumber": null,
"Email": null,
"Address": {
"Name": "ACME PHARMACEUTICAL INDUST (PHARMA)",
"Address1": "5 Squirrel Street",
"Address2": null,
"Address3": null,
"UNLOCO": "ILPET",
"City": "PETAH TIKVA",
"State": null,
"PostCode": "49131",
"CountryCode": "IL",
"Country": "ISREAL",
"AddressCode": "Default",
"Longitude": null,
"Latitude": null
}
},
{
"Type": "PickupFrom",
"Code": "6409938278",
"FullName": "DHL FREIGHT BELGIUM N V",
"PhoneNumber": "1454203949",
"Email": null,
"Address": {
"Name": "DHL FREIGHT BELGIUM N V",
"Address1": "2 Brandekensweg",
"Address2": "add2",
"Address3": null,
"UNLOCO": null,
"City": "Schelle",
"State": null,
"PostCode": "2630",
"CountryCode": "BE",
"Country": null,
"AddressCode": "Default",
"Longitude": null,
"Latitude": null
}
}
],
"Notes": [
{
"Description": "SpecialInstructions",
"NoteText": "note content",
"IntendedParty": "Customer, InternalDSV"
}
],
"CustomFields": [
{
"Name": "Documents_Ready_On_Collection",
"Type": "String",
"Value": "YES"
},
{
"Name": "Temperature_Range",
"Type": "String",
"Value": "General Cargo"
}
],
"Orders": [
{
"OrderNumber": "ORDEXT0001",
"SplitNumber": 0,
"OrderType": "SO",
"ParentOrderNumber": null,
"OrderDate": "2022-09-20T06:51:50.0000000+00:00",
"GoodsDescription": "goods",
"TransportMode": "SEA",
"ContainerMode": "LCL",
"ServiceLevel": "STD",
"RequiredExWorks": "2022-09-20T06:51:50.0000000+00:00",
"RequiredInStore": "2022-09-20T06:51:50.0000000+00:00",
"OriginCountry": "GB",
"Incoterm": "CIF",
"AdditionalTerms": "COLLECT",
"AdditionalTermsUNLOCO": null,
"ActualVolume": 20,
"UnitOfVolume": "CM3",
"ActualWeight": 30,
"UnitOfWeight": "KG",
"TotalPacks": 5,
"TotalQuantity": 181765,
"FollowUpDate": "2022-11-01T12:00:00.0000000+00:00",
"PortOfLoading": "GBFXT",
"PortOfDischarge": "USNYC",
"Currency": "USD",
"TotalValue": 492895.94,
"OnHandDate": "2022-11-01T12:00:00.0000000+00:00",
"PlannerCode": "planner code",
"PlannerEmail": null,
"WarehouseReceiptNumber": "WR001",
"VehicleRegistration": "VR001",
"TrailerNumber": "TR001",
"Seal": "SL001",
"ManifestNumber": "MF001",
"BookedInNumber": "BI001",
"DispatchedDate": null,
"EstimatedReceiptDate": "2022-11-01T12:00:00.0000000+00:00",
"BookedInDate": "2022-11-01T12:00:00.0000000+00:00",
"CutOffDate": "2022-11-01T12:00:00.0000000+00:00",
"InvoiceDate": "2022-11-01T12:00:00.0000000+00:00",
"InvoiceNumber": "IN001",
"ConfirmedDate": "2022-11-01T12:00:00.0000000+00:00",
"ConfirmationNumber": "CN001",
"ContractNumber": "C001",
"GoodsReceiptNumber": "GR001",
"GoodsReceiptDate": "2022-11-01T12:00:00.0000000+00:00",
"AuthorisedBy": "auth by",
"AuthorisedToShip": "2022-11-01T12:00:00.0000000+00:00",
"RevisionNumber": 0,
"EarliestShipDate": "2022-11-01T12:00:00.0000000+00:00",
"LatestShipDate": "2022-11-01T12:00:00.0000000+00:00",
"OrderLines": [
{
"LineNo": 10,
"Partno": "000000000010015389",
"Description": "FAMOTIDINE tab.USP 100*20mg",
"UnitOfQuantity": "ST",
"Quantity": 87661,
"QtyInvoiced": 87661,
"QtyBooked": null,
"QtyReceived": null,
"QtyShipped": 87661,
"Volume": 0,
"UnitOfVolume": "",
"Weight": 0,
"UnitOfWeight": "",
"ItemPrice": 1.22,
"LinePrice": 106946.42,
"Length": 0,
"Width": 0,
"Height": 0,
"DimUnit": "",
"DangerousGoodsRef": null,
"ContainerNumber": null,
"HarmonisedCode": null,
"PackLineId": null,
"InvoiceNumber": null,
"ConfirmationNumber": null,
"SpecialInstructions": null,
"AdditionalInformation": null,
"LineWeight": 0,
"LineVolume": 0,
"ContractNumber": null,
"OriginCountry": null,
"DecimalPlaces": 0,
"QuantityPerUnit": 0,
"NetWeight": 0,
"TransportMode": "",
"EarliestShipDate": "2022-11-01T12:00:00.0000000+00:00",
"LatestShipDate": "2022-11-01T12:00:00.0000000+00:00",
"FreightClass": "FC",
"ServiceLevel": "STD",
"Inners": {
"Value": 10.5,
"Unit": "PC"
},
"Outers": {
"Value": 20.5,
"Unit": "PC"
},
"Parties": [],
"EstimatedExWorksDate": null,
"RequiredExWorks": null,
"RequiredInStore": null,
"CustomFields": []
}
],
"PackLines": [],
"CustomFields": [
{
"Name": "invoice_number",
"Type": "STR",
"Value": "0090863377"
}
],
"Notes": [
{
"Description": "UserNote",
"NoteText": "note content",
"IntendedParty": "Customer, InternalDSV"
}
],
"Parties": [
{
"Type": "Buyer",
"Code": "0000402271",
"FullName": "ACTAVIS INTERNATIONAL LTD",
"ClosestPort": null,
"Currency": null,
"PhoneNumber": null,
"Email": null,
"VATNumber": null,
"RegisteredNumber": null,
"EDICode": "DP-ICC4400",
"ExternalCode": "IL201001",
"Address": {
"Name": "ACME Pharmaceuticals USA, Inc.",
"Address1": "400 Interpace Parkway",
"Address2": null,
"Address3": null,
"UNLOCO": null,
"City": "Parsippany, NJ",
"State": null,
"PostCode": "07054",
"CountryCode": "US",
"Country": null,
"AddressCode": "400 Interpace Parkway",
"Longitude": null,
"Latitude": null
}
},
{
"Type": "Supplier",
"Code": "SM23ACME-HR",
"FullName": "SM23ACME-HR",
"ClosestPort": null,
"Currency": null,
"PhoneNumber": null,
"Email": null,
"VATNumber": null,
"RegisteredNumber": null,
"Address": null
},
{
"Type": "PickupFrom",
"Code": "SM239902",
"FullName": "SM239902",
"ClosestPort": null,
"Currency": null,
"PhoneNumber": null,
"Email": null,
"VATNumber": null,
"RegisteredNumber": null,
"Address": null
}
]
}
],
"Documents": [
{
"IntendedParties": "Customer,InternalDSV",
"FileName": "packages",
"Extension": "json",
"DocType": "POD",
"IsPublished": true,
"UniqueFileName": true,
"Description": "UserNote",
"Data": "ewogICJuYW1lIjogImVkYyIsCiAgImRlc2NyaXB0aW9uIjogImVEQyBTeXN0ZW0iLAogICJyZXBvc2l0b3J5IjogewogICAgInR5cGUiOiAidGZzIgogIH0sCiAgInNjcmlwdHMiOiB7CiAgICAid2F0Y2gtY29udHJvbHMiOiAid2VicGFjayAtLWNvbmZpZyB3ZWJwYWNrLmNvbnRyb2xzLmNvbmZpZy5qcyAtLXdhdGNoIiwKICAgICJ0ZXN0IjogImphc21pbmUtbm9kZSBzcGVjIiwKICAgICJtYWludGVuYW5jZS1wYWdlIjogImd1bHAgYnVpbGQ6bWFpbnRlbmFuY2UtcGFnZSIsCiAgICAiYm9va2luZy10ZW1wbGF0ZXMiOiAiZ3VscCBidWlsZDpib29raW5nLXRlbXBsYXRlcyIKICB9LAogICJyZWFkbWUiOiAiTm8gcmVhZG1lIiwKICAibGljZW5zZSI6ICJOTFBMIiwKICAiZGV2RGVwZW5kZW5jaWVzIjogewogICAgImJhYmVsLWxvYWRlciI6ICJeNy4xLjQiLAogICAgImd1bHAiOiAiXjMuOS4xIiwKICAgICJndWxwLWlubGluZS1jc3MiOiAiXjMuMC4wIiwKICAgICJndWxwLXByZXByb2Nlc3MiOiAiXjEuMi4wIiwKICAgICJndWxwLXJlbmFtZSI6ICJeMS4yLjIiLAogICAgImh0bWwtbG9hZGVyIjogIl4wLjUuNSIsCiAgICAiaW5saW5lciI6ICJeMS4xMC4xIiwKICAgICJqYXNtaW5lLW5vZGUiOiAiXjEuMTUuMCIsCiAgICAid2VicGFjayI6ICJeNC40LjEiLAogICAgIndlYnBhY2stY2xpIjogIl4yLjAuMTMiLAogICAgIndlYnBhY2stbm90aWZpZXIiOiAiXjEuNi4wIgogIH0sCiAgImRlcGVuZGVuY2llcyI6IHsKICAgICJub2RlIjogIl4xMS4xNS4wIiwKICAgICJudm0iOiAiMC4wLjQiCiAgfQp9Cg=="
}
]
}
}
}
}
}
}
}
},
"/Bookings/ChangeState": {
"post": {
"tags": [
"Bookings"
],
"summary": "3. Change state by booking number",
"description": "3. Change state by booking number",
"operationId": "Change-state-by-booking-number",
"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.Controllers.ChangeStateRequest"
},
"example": {
"bookingNumber": "string",
"state": "Provisional",
"note": "string",
"intendedParty": "string"
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/Bookings": {
"post": {
"tags": [
"Bookings"
],
"summary": "4. Create or Update Booking(s)",
"description": "Create or Update Booking(s)",
"operationId": "POSTapi-public-v2-Bookings",
"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.Booking"
},
"example": {
"Header": {
"MessageId": "0f6b70c8-2c26-4d1d-9b9e-03a68fec52f0",
"TimeStamp": "2022-11-01T12:00:00.0000000+00:00",
"Source": {
"ApplicationCode": "CUSTOMER_SYSTEM",
"EnterpriseCode": "CUSTOMER_APPLICATION",
"Environment": "QA"
},
"Target": {
"ApplicationCode": "eDC",
"EnterpriseCode": "DSV",
"Environment": "QA"
},
"Function": "New"
},
"Booking": {
"ExternalBookingNumber": "BOKEXT014a",
"ExternalBookingSender": "SKUIRRELS",
"Incoterm": "EXW",
"AdditionalTerms": "PETAH",
"SupplierReference": "sup-ref",
"TransportMode": "SEA",
"ContainerMode": "FCL",
"RequestedDepartureDate": "2022-11-01T12:00:00.0000000+00:00",
"RequestedArrivalDate": "2022-11-01T12:00:00.0000000+00:00",
"LoadPort": "ILPET",
"DischargePort": "ILPET",
"GoodsDescription": "Pharmaceuticals",
"MarksAndNumbers": "marks here",
"BookingInstructions": "Pickup and Delivery Transprt Instructions",
"ShippingInstructions": "shipping instructions",
"CustomerDivision": "Parts",
"EquipmentTypes": [
{
"Type": "40HC",
"NoOfUnits": 1,
"ContainerNumber": "CBHU2204309"
}
],
"EstimatedDeliveryToOriginCFS": "2022-11-01T12:00:00.0000000+00:00",
"IsPickupRequired": true,
"CollectionRequiredDate": "2022-11-01T12:00:00.0000000+00:00",
"CollectionRequiredDateBy": "2022-11-01T06:00:00.0000000+00:00",
"DeliveryRequiredDate": "2022-11-01T12:00:00.0000000+00:00",
"DeliveryRequiredDateBy": "2022-11-01T08:00:00.0000000+00:00",
"PackLinesMethod": "patch",
"PackLines": [
{
"PackageCount": 1,
"PackType": "CTN",
"ContainerPackingOrder": 0,
"Weight": 0,
"UnitOfWeight": "KG",
"Length": 10,
"Height": 10,
"Width": 10,
"UnitOfDimension": "CM",
"Volume": 0.001,
"UnitOfVolume": "M3",
"RefNumber": null,
"Description": null,
"HarmonisedCode": null,
"CommodityCode": null,
"ContainerNumber": "CBHU2204309",
"LoadingMeters": 0,
"MarksAndNumbers": null,
"ProductCode": null,
"DangerousGoodsRef": null,
"NoOfPallets": 0,
"PackIdentifier": null,
"Sequence": 0,
"Stackable": false,
"PackageMarks": null,
"DangerousGoods": {
"Regulation": "REG",
"HazardClass": null,
"AdditionalHazardClass": null,
"ClassificationCode": null,
"UNDGNumber": "UNDG001",
"Variant": null,
"PSN": null,
"TechnicalName": null,
"Labels": null,
"PackingGroup": null,
"UpperPlate": null,
"LowerPlate": null,
"NumberOfPackages": null,
"PackageType": null,
"PackagingInstruction": null,
"TransportMeansCategory": null,
"GrossWeight": 0,
"NetWeight": 0,
"ExplosiveWeight": 0,
"UnitOfWeight": null,
"FlashPointTemperature": null,
"FlashPointTemperatureUnit": null,
"FlashPointDescription": null,
"TremCardNumber": null,
"EMSNumber": null,
"MFAGNumber": null,
"MarinePollutant": null,
"LimitedQuantity": false,
"TunnelCode": null,
"Remarks": null,
"ContactName": null,
"ContactEmail": null
},
"InnerPackLines": [],
"CustomFields": []
}
],
"Parties": [
{
"Type": "Consignor",
"Code": "5001ACME-IL",
"FullName": "ACME PHARMACEUTICAL INDUST (PHARMA)",
"ClosestPort": null,
"Currency": null,
"PhoneNumber": null,
"Email": null,
"Address": {
"Name": "ACME PHARMACEUTICAL INDUST (PHARMA)",
"Address1": "5 Squirrel Street",
"Address2": null,
"Address3": null,
"UNLOCO": "ILPET",
"City": "PETAH TIKVA",
"State": null,
"PostCode": "49131",
"CountryCode": "IL",
"Country": "ISREAL",
"AddressCode": "Default",
"Longitude": null,
"Latitude": null
}
},
{
"Type": "Consignee",
"Code": "ACME",
"FullName": "ACME PHARMACEUTICAL INDUST (PHARMA)",
"PhoneNumber": null,
"Email": null,
# --- truncated at 32 KB (211 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/dsv/refs/heads/main/openapi/dsv-edc-booking-api-v2-openapi.json