View DHL Services

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.

DHL Shipment Booking virtual sandbox is up and running!

Use this sandbox URL as the API base in your code to simulate DHL Shipment Booking responses instantly.

https://dhl-shipment-booking.mock.beeceptor.com



General(4 operations)

Request Payload
{
  "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"
    }
  ]
}
Response Payload
{
  "_DGFBookingID": "4f524704-bf49-4623-af84-c671b6763e66",
  "status": "Accepted",
  "statusURL": "https://remorseful-pliers.biz"
}
{
  "api-correlation-id": "414d73d0-db92-4623-8946-d3e47994689e",
  "detail": "Expired Access Token",
  "status": 401,
  "title": "Velum utroque tametsi coadunatio aetas auxilium videlicet attonbitus."
}
{
  "api-correlation-id": "80268aee-45e8-46ed-8a00-36cd2a0c1c1d",
  "detail": "Turbo aspernatur subito delectus quaerat sodalitas aperio balbus.",
  "status": 429,
  "title": "Too Many Requests"
}
{
  "api-correlation-id": "468aafeb-dee7-4c62-9e6f-94f96cfb930f",
  "detail": "Balbus conitor capio demonstro.",
  "status": 500,
  "title": "Internal Server Error"
}
Request Payload
{
  "consignee": {
    "accountNumber": "czCgsrNq"
  },
  "goodsLines": [
    {
      "commodityCode": "VAL",
      "customsClassification": [
        {
          "code": "4901",
          "countryCode": "IM"
        },
        {
          "code": "9018",
          "countryCode": "GS"
        }
      ],
      "dimensions": {
        "dimensionsUom": "INH",
        "height": 278.5,
        "length": 239.58,
        "width": 42.86
      },
      "goodsDescription": "Electronic Components",
      "grossWeight": 994.28,
      "grossWeightUom": "LBR",
      "harmonizedCode": "901796",
      "hazardousMaterial": [
        {
          "_IMOClassCode": 8,
          "_UNDGNumber": "7",
          "contact": {
            "email": "Donavon_Osinski99@hotmail.com",
            "name": "Delores Koepp",
            "phone": "+16053436986"
          },
          "flashpointTemperature": {
            "text": 68,
            "uom": "CEL"
          },
          "grossWeight": 2342.2,
          "grossWeightUom": "LBR",
          "marinePollutant": "Y",
          "packageCount": 75,
          "packageType": "CRT",
          "properShippingname": "Paint",
          "technicalName": "[object Object]",
          "volume": 33.07,
          "volumeUom": "CUB"
        }
      ],
      "innerPackageCount": 144,
      "loadingMeters": 8.15,
      "marksAndNumbers": "y1N9Cm3y",
      "originCountryCode": "YE",
      "packageCount": 459,
      "packageID": "Jgft6DRq6F",
      "packageType": "CRT",
      "temperatures": {
        "requiredMaximum": 15.2,
        "requiredMinimum": -13.2,
        "requiresTemperatureControl": true,
        "uom": "CEL"
      },
      "volume": 18.76,
      "volumeUom": "MTQ"
    },
    {
      "commodityCode": "PER",
      "customsClassification": [
        {
          "code": "8544",
          "countryCode": "KY"
        },
        {
          "code": "3304",
          "countryCode": "PA"
        },
        {
          "code": "8517",
          "countryCode": "NZ"
        }
      ],
      "dimensions": {
        "dimensionsUom": "CMT",
        "height": 470.45,
        "length": 319.86,
        "width": 282.17
      },
      "goodsDescription": "Electronic Components",
      "grossWeight": 1988.12,
      "grossWeightUom": "LBR",
      "harmonizedCode": "297070",
      "hazardousMaterial": [
        {
          "_IMOClassCode": 7,
          "_UNDGNumber": "7",
          "contact": {
            "email": "Franco7@yahoo.com",
            "name": "Delbert Bayer PhD",
            "phone": "+17944989545"
          },
          "flashpointTemperature": {
            "text": 31,
            "uom": "CEL"
          },
          "grossWeight": 3799.52,
          "grossWeightUom": "LBR",
          "marinePollutant": "N",
          "packageCount": 64,
          "packageType": "BOX",
          "properShippingname": "Ethanol",
          "technicalName": "[object Object]",
          "volume": 5.74,
          "volumeUom": "MTQ"
        }
      ],
      "innerPackageCount": 785,
      "loadingMeters": 12.88,
      "marksAndNumbers": "jaTvjBYM",
      "originCountryCode": "MK",
      "packageCount": 66,
      "packageID": "KLEZAtzKg4",
      "packageType": "CRT",
      "temperatures": {
        "requiredMaximum": 21.5,
        "requiredMinimum": -11.9,
        "requiresTemperatureControl": true,
        "uom": "CEL"
      },
      "volume": 3.02,
      "volumeUom": "CUB"
    }
  ],
  "notes": [
    {
      "text": "Vitae tredecim crinis reiciendis benigne dapifer sublime.",
      "type": "DEL"
    },
    {
      "text": "Cenaculum expedita dignissimos officia auxilium libero culpa teneo veritas.",
      "type": "SHP"
    },
    {
      "text": "Conculco comis laudantium defungo.",
      "type": "DEL"
    },
    {
      "text": "Vinculum cubicularis armarium trans curto tener.",
      "type": "SHP"
    },
    {
      "text": "Conatus baiulus circumvenio admoveo aut cogito.",
      "type": "SHP"
    }
  ],
  "references": [
    {
      "number": "14SK2Yz8",
      "type": "BOL"
    },
    {
      "number": "P7XUjTiu",
      "type": "INV"
    },
    {
      "number": "fAaocR4N",
      "type": "INV"
    },
    {
      "number": "KnqePYu2",
      "type": "CRN"
    },
    {
      "number": "IF7jy7dW",
      "type": "INV"
    }
  ],
  "shipmentBranchCode": "SFO"
}
Response Payload
{
  "api-correlation-id": "65eee1fd-2117-45fc-b44d-bf9ced78b24e",
  "detail": "Uter vix ventito suasoria sequi aggredior comparo.",
  "results": [
    {
      "status": "accepted",
      "updateField": "amiculum"
    },
    {
      "status": "accepted",
      "updateField": "crastinus"
    },
    {
      "status": "accepted",
      "updateField": "decor"
    },
    {
      "status": "accepted",
      "updateField": "quo"
    },
    {
      "status": "accepted",
      "updateField": "abundans"
    }
  ],
  "status": 200
}
{
  "api-correlation-id": "d74e9379-6b4a-468a-bc75-61692c7e3887",
  "detail": "Expired Access Token",
  "status": 401,
  "title": "Appositus suggero beatus adicio cimentarius amplus cultellus attero volva creta."
}
{
  "api-correlation-id": "22e6b33f-2dba-4bca-8a28-3b0cbfb62e9b",
  "detail": "Sed triumphus vindico ustilo compello molestiae ulterius.",
  "results": [
    {
      "details": "Inventore cursus vergo repellat advenio vester.",
      "status": "rejected",
      "updateField": "concedo"
    },
    {
      "details": "Campana videlicet capillus aer.",
      "status": "rejected",
      "updateField": "thymbra"
    },
    {
      "details": "Cuppedia taedium celo.",
      "status": "rejected",
      "updateField": "succedo"
    },
    {
      "details": "Ambitus sopor surculus utique.",
      "status": "rejected",
      "updateField": "supra"
    },
    {
      "details": "Corpus aegre amor terra.",
      "status": "rejected",
      "updateField": "doloribus"
    }
  ],
  "status": 403,
  "title": "Velut adduco torqueo pecto suppellex vinum acerbitas votum."
}
{
  "api-correlation-id": "12f36df6-35ad-4bcf-b8f4-93414912c959",
  "detail": "Cohibeo cilicium laudantium.",
  "status": "consequuntur"
}
{
  "api-correlation-id": "d1fb45e0-1c13-4c56-a01e-84d0d4a347a9",
  "detail": "A ratione fuga tamquam approbo.",
  "status": 429,
  "title": "Too Many Requests"
}
{
  "api-correlation-id": "2e98ce66-1f14-4bd8-98c3-8ba4bcadbeed",
  "detail": "Infit reiciendis catena cavus vero.",
  "status": 500,
  "title": "Internal Server Error"
}
Query Parameter NameExample
_DGFBookingID*anim nulla id eu
Request Payload
Response Payload
{
  "housebillNumber": "d974mwStBO",
  "shipmentID": "D6WKzVWZk2",
  "shipmentTrackingURL": "https://unlawful-assist.net/",
  "status": "Shipment Created"
}
{
  "api-correlation-id": "47db0d0a-774e-4db1-bba2-f1bf0c529b74",
  "detail": "Expired Access Token",
  "status": 401,
  "title": "Alveus aspernatur utpote collum ab."
}
{
  "status": "confido",
  "title": "Utilis cui tricesimus vester quis valetudo soleo cruentus accusator fuga."
}
Query Parameter NameExample
codeListIDFlashpointTemperatureUoM
Request Payload
Response Payload
{
  "Result": [
    {
      "description": "timor adamo substantia",
      "id": "9al"
    },
    {
      "description": "cado charisma spes",
      "id": "eSV"
    }
  ]
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "detail": "Veniam sulum suasoria quia.",
  "title": "Antiquus reprehenderit ulterius."
}
Service Homepage: developer.dhl.com/api-reference/dgf-shipment-booking#reference-docs-section
dhllogisticsfreightshippingtransportation