DHL Shipment Booking Virtual Sandbox
Virtual API for booking Air, Ocean, Rail, and Road freight shipments.
The DHL Global Forwarding Shipment Booking API enables developers to programmatically book freight shipments across various transport modes. It supports the creation, management, and status tracking of bookings within DHL's global transport management systems.
Use this hosted sandbox to simulate DHL Shipment Booking APIs without authentication, API keys, or extra dependencies. Point your code or SDK to the Beeceptor base URL, preferably through an environment variable or feature flag, and switch back to the production API when ready.
This keeps your integration code consistent across local development, QA, demos, and production.
Use cases:
Use this sandbox to validate shipment booking payloads, handle multi-modal freight requirements, verify status update transitions, and test codelist integration for origin/destination mapping before connecting to DHL production systems.
General(4 operations)
POST
{
"housebillNumber": "SGLA00344",
"externalBookingID": "REF01234",
"modeOfTransport": "AIR",
"shipmentBranchCode": "SIN",
"originLocationCode": "SGSIN",
"originLocationName": "Singapore",
"originCountryCode": "SG",
"destinationLocationCode": "USMIA",
"destinationLocationName": "Miami FL",
"destinationCountryCode": "US",
"requestedPickupDate": "2019-09-02T19:00:00+01:00",
"requestedShippingDate": "2019-09-03T19:00:00+01:00",
"requestedDeliveryDate": "2019-09-05T10:00:00+01:00",
"shipmentType": "LSE",
"shipmentSubType": "STD",
"assembly": false,
"deliveryMode": "DOOR/DOOR",
"serviceLevel": "STD",
"serviceCode": "AA1",
"productCode": "ALC",
"_DGFInsure": false,
"incoterms": "FCA",
"incotermsLocation": "Miami",
"releaseType": "",
"valueOfGoods": 200,
"valueOfGoodsCurrencyCode": "USD",
"insuranceValue": 200,
"insuranceValueCurrencyCode": "USD",
"customer": {
"accountNumber": "USGEE030",
"name": "ACME INT'L INC",
"address": {
"addressLine1": "7600 CORPORATE CENTER DR",
"addressLine2": "SUITE 601",
"postalCode": "33126",
"city": "MIAMI",
"stateProvince": "FL",
"countryCode": "US"
},
"contact": {
"name": "Mr J. Doe",
"phone": "+1 99 999 9999",
"email": "j.doe@acme.com"
}
},
"shipper": {
"accountNumber": "SGSIN6661",
"name": "JJ Electronics",
"address": {
"addressLine1": "20 JOO KOON CIRCLE",
"addressLine2": "",
"postalCode": "629057",
"city": "Singapore",
"stateProvince": "",
"countryCode": "SG"
},
"contact": {
"name": "M Jane",
"phone": "+65 88 888 8888",
"email": "jane.m@jj.com"
}
},
"consignee": {
"accountNumber": "USGEE036",
"name": "ACME INT'L INC",
"address": {
"addressLine1": "7699 CORPORATE CENTER DR",
"addressLine2": "",
"postalCode": "33126",
"city": "MIAMI",
"stateProvince": "FL",
"countryCode": "US"
},
"contact": {
"name": "",
"phone": "",
"email": ""
}
},
"notify": {
"accountNumber": "USBOC996",
"name": "X-COMMERCIAL AIRPLANE",
"address": {
"addressLine1": "",
"addressLine2": "",
"postalCode": "",
"city": "",
"stateProvince": "",
"countryCode": ""
},
"contact": {
"name": "Mr. Xavier",
"phone": "",
"email": "xavier@x-plane.com"
}
},
"goodsLines": [
{
"packageCount": 10,
"packageType": "PLT",
"packageID": "PalletNo12346",
"grossWeight": 50,
"grossWeightUom": "KGM",
"volume": 10.5,
"volumeUom": "MTQ",
"innerPackageCount": 10,
"loadingMeters": 8.5,
"marksAndNumbers": "",
"goodsDescription": "Solid metal",
"commodityCode": "GEN",
"originCountryCode": "PH",
"customsClassification": [
{
"countryCode": "US",
"code": "3304"
},
{
"countryCode": "US",
"code": "3305"
}
],
"dimensions": {
"dimensionsUom": "MTR",
"length": 20.1,
"width": 8,
"height": 8.5
},
"temperatures": {
"requiresTemperatureControl": false,
"requiredMinimum": 8,
"requiredMaximum": 10,
"uom": "CEL"
},
"hazardousMaterial": [
{
"_UNDGNumber": "1266a",
"_IMOClassCode": 3,
"flashpointTemperature": {
"uom": "CEL",
"text": 20
},
"properShippingname": "",
"technicalName": "",
"marinePollutant": "Y",
"packageCount": 10,
"packageType": "PLT",
"grossWeight": 50,
"grossWeightUom": "KGM",
"volume": 10.5,
"volumeUom": "MTQ",
"contact": {
"name": "John Doe",
"phone": "+1 99 999 9999",
"email": "j.doe@acme.com"
}
}
]
}
],
"references": [
{
"type": "CRN",
"number": "ZZ555555"
}
],
"notes": [
{
"type": "CIN",
"text": "Customs Instructions will folllow"
}
],
"service": [
{
"type": "DKI",
"requestedDate": "2019-09-01T08:00:00+01:00"
}
],
"pickup": {
"_DGFPickup": true,
"accountNumber": "SGSIN661",
"name": "James Chang",
"address": {
"addressLine1": "21 JOO KOON CIRCLE",
"addressLine2": "",
"postalCode": "629057",
"city": "Singapore",
"stateProvince": "",
"countryCode": "SG"
},
"contact": {
"name": "",
"phone": "",
"email": ""
}
},
"delivery": {
"_DGFDeliver": false,
"accountNumber": "",
"name": "",
"address": {
"addressLine1": "",
"addressLine2": "",
"postalCode": "",
"city": "",
"stateProvince": "",
"countryCode": ""
},
"contact": {
"name": "",
"phone": "",
"email": ""
}
},
"parties": [
{
"partyType": "DeliveryAgent",
"accountNumber": "SFO"
}
]
}{
"_DGFBookingID": "e309172a-84ce-4a0f-ba9d-3ef4628ebab1",
"status": "Accepted",
"statusURL": "https://bitter-skean.org"
}{
"api-correlation-id": "55f6a5de-27fd-4876-b2f4-a0aaa1f3b3ff",
"detail": "Expired Access Token",
"status": 401,
"title": "Comminor deleo cornu curtus arca degusto catena."
}{
"api-correlation-id": "bb513ee1-d58e-41eb-8330-877b8117d0c2",
"detail": "Depromo aureus sonitus neque aperio.",
"status": 429,
"title": "Too Many Requests"
}{
"api-correlation-id": "7643cb69-6f86-4b0f-a714-89270f75f7e5",
"detail": "Spoliatio sumptus adstringo.",
"status": 500,
"title": "Internal Server Error"
}PATCH
{
"consignee": {
"accountNumber": "mHsDmywh"
},
"goodsLines": [
{
"commodityCode": "GEN",
"customsClassification": [
{
"code": "8708",
"countryCode": "MS"
},
{
"code": "8471",
"countryCode": "MU"
},
{
"code": "8708",
"countryCode": "MX"
}
],
"dimensions": {
"dimensionsUom": "INH",
"height": 398.46,
"length": 426.66,
"width": 262.67
},
"goodsDescription": "Textile Fabrics",
"grossWeight": 1945.5,
"grossWeightUom": "LBR",
"harmonizedCode": "487351",
"hazardousMaterial": [
{
"_IMOClassCode": 8,
"_UNDGNumber": "5",
"contact": {
"email": "Thad9@gmail.com",
"name": "Kristy Kilback",
"phone": "+16567666720"
},
"flashpointTemperature": {
"text": 60,
"uom": "FAH"
},
"grossWeight": 326.13,
"grossWeightUom": "LBR",
"marinePollutant": "S",
"packageCount": 81,
"packageType": "CRT",
"properShippingname": "Compressed Gas",
"technicalName": "[object Object]",
"volume": 27.02,
"volumeUom": "CUB"
},
{
"_IMOClassCode": 2,
"_UNDGNumber": "0",
"contact": {
"email": "Tyrese_Simonis98@yahoo.com",
"name": "Tabitha Marvin",
"phone": "+13709875218"
},
"flashpointTemperature": {
"text": 79,
"uom": "FAH"
},
"grossWeight": 2121.91,
"grossWeightUom": "LBR",
"marinePollutant": "Y",
"packageCount": 2,
"packageType": "PLT",
"properShippingname": "Paint",
"technicalName": "[object Object]",
"volume": 17.18,
"volumeUom": "CUB"
},
{
"_IMOClassCode": 7,
"_UNDGNumber": "2",
"contact": {
"email": "Domenic.Robel98@gmail.com",
"name": "Aaron Mohr",
"phone": "+13587282592"
},
"flashpointTemperature": {
"text": 74,
"uom": "CEL"
},
"grossWeight": 4125.14,
"grossWeightUom": "KGM",
"marinePollutant": "N",
"packageCount": 48,
"packageType": "DRM",
"properShippingname": "Sulfuric acid",
"technicalName": "[object Object]",
"volume": 36.65,
"volumeUom": "CUB"
}
],
"innerPackageCount": 174,
"loadingMeters": 12.56,
"marksAndNumbers": "2OXpbD12",
"originCountryCode": "CX",
"packageCount": 172,
"packageID": "MgIfnvf3Tr",
"packageType": "CRT",
"temperatures": {
"requiredMaximum": 11.6,
"requiredMinimum": -14.3,
"requiresTemperatureControl": true,
"uom": "FAH"
},
"volume": 12.13,
"volumeUom": "CUB"
},
{
"commodityCode": "HAZ",
"customsClassification": [
{
"code": "4901",
"countryCode": "MC"
},
{
"code": "6109",
"countryCode": "MP"
}
],
"dimensions": {
"dimensionsUom": "INH",
"height": 155.12,
"length": 194.46,
"width": 170.64
},
"goodsDescription": "Electronic Components",
"grossWeight": 1809.01,
"grossWeightUom": "KGM",
"harmonizedCode": "444498",
"hazardousMaterial": [
{
"_IMOClassCode": 7,
"_UNDGNumber": "0",
"contact": {
"email": "Lera_Rolfson73@hotmail.com",
"name": "Lee Beer",
"phone": "+12094545294"
},
"flashpointTemperature": {
"text": 66,
"uom": "CEL"
},
"grossWeight": 1916.54,
"grossWeightUom": "LBR",
"marinePollutant": "N",
"packageCount": 48,
"packageType": "BOX",
"properShippingname": "Batteries, Lithium Ion",
"technicalName": "[object Object]",
"volume": 31.31,
"volumeUom": "CUB"
},
{
"_IMOClassCode": 2,
"_UNDGNumber": "6",
"contact": {
"email": "Cassandra.Grady18@hotmail.com",
"name": "Luke Gorczany",
"phone": "+12298236108"
},
"flashpointTemperature": {
"text": 26,
"uom": "FAH"
},
"grossWeight": 4500.23,
"grossWeightUom": "KGM",
"marinePollutant": "Y",
"packageCount": 57,
"packageType": "DRM",
"properShippingname": "Ethanol",
"technicalName": "[object Object]",
"volume": 45.23,
"volumeUom": "MTQ"
},
{
"_IMOClassCode": 8,
"_UNDGNumber": "1",
"contact": {
"email": "Foster.Renner17@gmail.com",
"name": "Dewey Pfeffer",
"phone": "+15777369888"
},
"flashpointTemperature": {
"text": 94,
"uom": "FAH"
},
"grossWeight": 698.5,
"grossWeightUom": "LBR",
"marinePollutant": "N",
"packageCount": 9,
"packageType": "DRM",
"properShippingname": "Compressed Gas",
"technicalName": "[object Object]",
"volume": 25.65,
"volumeUom": "CUB"
},
{
"_IMOClassCode": 8,
"_UNDGNumber": "8",
"contact": {
"email": "Danika70@hotmail.com",
"name": "Jack Kris",
"phone": "+13794904867"
},
"flashpointTemperature": {
"text": 28,
"uom": "CEL"
},
"grossWeight": 402.52,
"grossWeightUom": "KGM",
"marinePollutant": "N",
"packageCount": 22,
"packageType": "PLT",
"properShippingname": "Ethanol",
"technicalName": "[object Object]",
"volume": 49.36,
"volumeUom": "MTQ"
},
{
"_IMOClassCode": 7,
"_UNDGNumber": "3",
"contact": {
"email": "Hank.Herzog93@gmail.com",
"name": "Diane Will",
"phone": "+15356267661"
},
"flashpointTemperature": {
"text": 92,
"uom": "CEL"
},
"grossWeight": 538.66,
"grossWeightUom": "LBR",
"marinePollutant": "Y",
"packageCount": 8,
"packageType": "CRT",
"properShippingname": "Ethanol",
"technicalName": "[object Object]",
"volume": 22.36,
"volumeUom": "CUB"
}
],
"innerPackageCount": 332,
"loadingMeters": 8.32,
"marksAndNumbers": "seawSxE5",
"originCountryCode": "BT",
"packageCount": 129,
"packageID": "96QX6_1H9p",
"packageType": "DRM",
"temperatures": {
"requiredMaximum": 24.8,
"requiredMinimum": -11.7,
"requiresTemperatureControl": false,
"uom": "FAH"
},
"volume": 7.51,
"volumeUom": "MTQ"
},
{
"commodityCode": "GEN",
"customsClassification": [
{
"code": "8708",
"countryCode": "AU"
},
{
"code": "8544",
"countryCode": "IR"
},
{
"code": "8528",
"countryCode": "RU"
},
{
"code": "6109",
"countryCode": "DM"
}
],
"dimensions": {
"dimensionsUom": "MTR",
"height": 396.89,
"length": 123.17,
"width": 242.88
},
"goodsDescription": "Machine Parts",
"grossWeight": 602.55,
"grossWeightUom": "LBR",
"harmonizedCode": "364906",
"hazardousMaterial": [
{
"_IMOClassCode": 7,
"_UNDGNumber": "4",
"contact": {
"email": "Adeline5@hotmail.com",
"name": "Margarita Gislason",
"phone": "+16247921918"
},
"flashpointTemperature": {
"text": 28,
"uom": "CEL"
},
"grossWeight": 2274.8,
"grossWeightUom": "LBR",
"marinePollutant": "S",
"packageCount": 63,
"packageType": "CRT",
"properShippingname": "Ethanol",
"technicalName": "[object Object]",
"volume": 44.29,
"volumeUom": "MTQ"
},
{
"_IMOClassCode": 5,
"_UNDGNumber": "5",
"contact": {
"email": "Lori87@gmail.com",
"name": "Mr. Carroll Balistreri",
"phone": "+16708727651"
},
"flashpointTemperature": {
"text": 69,
"uom": "CEL"
},
"grossWeight": 1430.27,
"grossWeightUom": "KGM",
"marinePollutant": "Y",
"packageCount": 33,
"packageType": "DRM",
"properShippingname": "Compressed Gas",
"technicalName": "[object Object]",
"volume": 30.4,
"volumeUom": "CUB"
},
{
"_IMOClassCode": 6,
"_UNDGNumber": "8",
"contact": {
"email": "Raven.Terry@hotmail.com",
"name": "Alfredo Fritsch",
"phone": "+17108743957"
},
"flashpointTemperature": {
"text": 82,
"uom": "CEL"
},
"grossWeight": 3663.95,
"grossWeightUom": "KGM",
"marinePollutant": "S",
"packageCount": 27,
"packageType": "CRT",
"properShippingname": "Compressed Gas",
"technicalName": "[object Object]",
"volume": 27.38,
"volumeUom": "CUB"
}
],
"innerPackageCount": 469,
"loadingMeters": 4.79,
"marksAndNumbers": "x4TvToZH",
"originCountryCode": "NC",
"packageCount": 127,
"packageID": "6rsZUnuIZY",
"packageType": "DRM",
"temperatures": {
"requiredMaximum": 2.8,
"requiredMinimum": -4.5,
"requiresTemperatureControl": true,
"uom": "CEL"
},
"volume": 48.08,
"volumeUom": "MTQ"
},
{
"commodityCode": "HAZ",
"customsClassification": [
{
"code": "9018",
"countryCode": "MN"
},
{
"code": "3304",
"countryCode": "DK"
},
{
"code": "8544",
"countryCode": "RE"
}
],
"dimensions": {
"dimensionsUom": "INH",
"height": 435.46,
"length": 439.77,
"width": 272.28
},
"goodsDescription": "Machine Parts",
"grossWeight": 1491.76,
"grossWeightUom": "KGM",
"harmonizedCode": "054277",
"hazardousMaterial": [
{
"_IMOClassCode": 4,
"_UNDGNumber": "4",
"contact": {
"email": "Lauriane89@hotmail.com",
"name": "Rene Hayes",
"phone": "+17627138984"
},
"flashpointTemperature": {
"text": 46,
"uom": "FAH"
},
"grossWeight": 2053.4,
"grossWeightUom": "LBR",
"marinePollutant": "S",
"packageCount": 17,
"packageType": "PLT",
"properShippingname": "Batteries, Lithium Ion",
"technicalName": "[object Object]",
"volume": 44.31,
"volumeUom": "MTQ"
},
{
"_IMOClassCode": 7,
"_UNDGNumber": "9",
"contact": {
"email": "Wava96@gmail.com",
"name": "Dr. Shawna Anderson",
"phone": "+18062648857"
},
"flashpointTemperature": {
"text": 29,
"uom": "FAH"
},
"grossWeight": 3922.95,
"grossWeightUom": "KGM",
"marinePollutant": "Y",
"packageCount": 25,
"packageType": "DRM",
"properShippingname": "Batteries, Lithium Ion",
"technicalName": "[object Object]",
"volume": 19.63,
"volumeUom": "CUB"
},
{
"_IMOClassCode": 4,
"_UNDGNumber": "3",
"contact": {
"email": "Daryl57@yahoo.com",
"name": "Clarence Leannon",
"phone": "+13532214404"
},
"flashpointTemperature": {
"text": 65,
"uom": "FAH"
},
"grossWeight": 4415.3,
"grossWeightUom": "KGM",
"marinePollutant": "S",
"packageCount": 48,
"packageType": "PLT",
"properShippingname": "Ethanol",
"technicalName": "[object Object]",
"volume": 37.44,
"volumeUom": "MTQ"
},
{
"_IMOClassCode": 8,
"_UNDGNumber": "8",
"contact": {
"email": "Bernadine1@hotmail.com",
"name": "Carole Boyer",
"phone": "+17678970415"
},
"flashpointTemperature": {
"text": 65,
"uom": "FAH"
},
"grossWeight": 975.27,
"grossWeightUom": "LBR",
"marinePollutant": "S",
"packageCount": 63,
"packageType": "PLT",
"properShippingname": "Batteries, Lithium Ion",
"technicalName": "[object Object]",
"volume": 44.99,
"volumeUom": "CUB"
}
],
"innerPackageCount": 530,
"loadingMeters": 6.66,
"marksAndNumbers": "bdsqijVe",
"originCountryCode": "SI",
"packageCount": 81,
"packageID": "TyMAMeNn31",
"packageType": "PLT",
"temperatures": {
"requiredMaximum": 22,
"requiredMinimum": -11.8,
"requiresTemperatureControl": true,
"uom": "CEL"
},
"volume": 35.94,
"volumeUom": "MTQ"
}
],
"notes": [
{
"text": "Validus iure timor vos.",
"type": "CIN"
},
{
"text": "Laudantium stillicidium sursum.",
"type": "CIN"
},
{
"text": "Termes antepono crur.",
"type": "CIN"
},
{
"text": "Delicate adversus derelinquo ater tenuis asporto spargo aeneus.",
"type": "SHP"
},
{
"text": "Coerceo deduco xiphias synagoga amissio pel administratio amet artificiose viridis.",
"type": "CIN"
}
],
"references": [
{
"number": "0CYUU48B",
"type": "BOL"
},
{
"number": "qVqZpDxN",
"type": "BOL"
}
],
"shipmentBranchCode": "FRA"
}{
"api-correlation-id": "7ac58a3d-fdfc-417b-9a76-3dc93b8dee1d",
"detail": "Stipes perferendis ara corrumpo aggredior magnam ceno antea viriliter.",
"results": [
{
"status": "accepted",
"updateField": "commodi"
},
{
"status": "accepted",
"updateField": "tenuis"
},
{
"status": "accepted",
"updateField": "crux"
},
{
"status": "accepted",
"updateField": "decet"
},
{
"status": "accepted",
"updateField": "dapifer"
}
],
"status": 200
}{
"api-correlation-id": "f11fc4fc-b320-41d3-8544-2e67a1d2b298",
"detail": "Expired Access Token",
"status": 401,
"title": "Adflicto bonus voveo appello ab arx demulceo consequuntur velit bene."
}{
"api-correlation-id": "4dd76ea2-854d-41a4-bca9-9525e2b102b4",
"detail": "Auxilium creator vacuus conduco amita atrox suscipio.",
"results": [
{
"details": "Sulum desipio teres tibi coniuratio arbor.",
"status": "rejected",
"updateField": "alveus"
},
{
"details": "Clam usitas denuo earum iusto rem vesica caelum compono amaritudo.",
"status": "rejected",
"updateField": "spectaculum"
}
],
"status": 403,
"title": "Necessitatibus aestivus stabilis."
}{
"api-correlation-id": "7cfc23bc-29ec-4612-bfc0-1588ccedc914",
"detail": "Vita taedium thesaurus crepusculum benevolentia colo claro crur nostrum.",
"status": "arguo"
}{
"api-correlation-id": "3cf9049d-1a66-4912-83f8-b8854b756c1e",
"detail": "Sonitus civitas adeptio.",
"status": 429,
"title": "Too Many Requests"
}{
"api-correlation-id": "f4978c07-72e7-4e71-9551-47a654b20369",
"detail": "Accusator valeo adulescens benevolentia deorsum tutamen quam capto voluptatum.",
"status": 500,
"title": "Internal Server Error"
}GET
| Query Parameter Name | Example |
|---|---|
_DGFBookingID* | laboris dolor qui |
{
"housebillNumber": "AIAi20rLb1",
"shipmentID": "VzgVDsEguR",
"shipmentTrackingURL": "https://haunting-tuxedo.com/",
"status": "Shipment Created"
}{
"api-correlation-id": "c0aacbd7-7515-4682-8375-1a9d42830af1",
"detail": "Expired Access Token",
"status": 401,
"title": "Caelestis validus totus vito odit sto sint vilis."
}{
"status": "cupiditate",
"title": "Undique spes consuasor cras mollitia ex alioqui distinctio suppono apparatus."
}GET
| Query Parameter Name | Example |
|---|---|
codeListID | CountryCode |
{
"Result": [
{
"description": "chirographum audio curto",
"id": "o0U"
},
{
"description": "suus thorax tamdiu",
"id": "E8L"
}
]
}Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.{
"detail": "Dicta patruus subvenio tamen veritatis thalassinus attero.",
"title": "Absorbeo baiulus vix natus textilis."
}dhllogisticsfreightshippingtransportation