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": "ca8a831b-5214-487e-b972-c10cabd185c3",
  "status": "Accepted",
  "statusURL": "https://stormy-daughter.name"
}
{
  "api-correlation-id": "e23ce5ea-1622-48cf-85d6-761f3f32171e",
  "detail": "Expired Access Token",
  "status": 401,
  "title": "Aedificium tot accusator accommodo xiphias."
}
{
  "api-correlation-id": "12b6c54c-94a7-4b1c-996c-d0624a882bbb",
  "detail": "Corroboro bestia denique tum degero depraedor at dolor.",
  "status": 429,
  "title": "Too Many Requests"
}
{
  "api-correlation-id": "d055b5ae-a674-4a9f-ae63-be9f499447ff",
  "detail": "Addo aeneus doloremque aggredior apud solitudo vox cupiditate pecto.",
  "status": 500,
  "title": "Internal Server Error"
}
Request Payload
{
  "consignee": {
    "accountNumber": "09RatJPb"
  },
  "goodsLines": [
    {
      "commodityCode": "PER",
      "customsClassification": [
        {
          "code": "8544",
          "countryCode": "VU"
        },
        {
          "code": "6402",
          "countryCode": "NU"
        },
        {
          "code": "8708",
          "countryCode": "ES"
        },
        {
          "code": "6109",
          "countryCode": "AE"
        }
      ],
      "dimensions": {
        "dimensionsUom": "CMT",
        "height": 376.75,
        "length": 472.46,
        "width": 275
      },
      "goodsDescription": "Plastic Granules",
      "grossWeight": 295.95,
      "grossWeightUom": "KGM",
      "harmonizedCode": "829684",
      "hazardousMaterial": [
        {
          "_IMOClassCode": 2,
          "_UNDGNumber": "7",
          "contact": {
            "email": "Era_Altenwerth40@yahoo.com",
            "name": "Mr. Simon Steuber",
            "phone": "+16632727228"
          },
          "flashpointTemperature": {
            "text": 39,
            "uom": "CEL"
          },
          "grossWeight": 3725.42,
          "grossWeightUom": "KGM",
          "marinePollutant": "N",
          "packageCount": 56,
          "packageType": "PLT",
          "properShippingname": "Batteries, Lithium Ion",
          "technicalName": "[object Object]",
          "volume": 34.67,
          "volumeUom": "CUB"
        },
        {
          "_IMOClassCode": 1,
          "_UNDGNumber": "9",
          "contact": {
            "email": "Ebba_Lehner@yahoo.com",
            "name": "Robert Yost-Altenwerth",
            "phone": "+16014042107"
          },
          "flashpointTemperature": {
            "text": 100,
            "uom": "FAH"
          },
          "grossWeight": 4362.42,
          "grossWeightUom": "LBR",
          "marinePollutant": "S",
          "packageCount": 7,
          "packageType": "DRM",
          "properShippingname": "Batteries, Lithium Ion",
          "technicalName": "[object Object]",
          "volume": 21.71,
          "volumeUom": "CUB"
        },
        {
          "_IMOClassCode": 7,
          "_UNDGNumber": "0",
          "contact": {
            "email": "Ashlee90@hotmail.com",
            "name": "Gordon Gleason",
            "phone": "+19412262585"
          },
          "flashpointTemperature": {
            "text": 47,
            "uom": "FAH"
          },
          "grossWeight": 4261.52,
          "grossWeightUom": "LBR",
          "marinePollutant": "Y",
          "packageCount": 35,
          "packageType": "DRM",
          "properShippingname": "Sulfuric acid",
          "technicalName": "[object Object]",
          "volume": 14.72,
          "volumeUom": "MTQ"
        },
        {
          "_IMOClassCode": 1,
          "_UNDGNumber": "8",
          "contact": {
            "email": "Raegan99@yahoo.com",
            "name": "Jimmy DuBuque",
            "phone": "+17885491444"
          },
          "flashpointTemperature": {
            "text": 65,
            "uom": "CEL"
          },
          "grossWeight": 4692.5,
          "grossWeightUom": "KGM",
          "marinePollutant": "Y",
          "packageCount": 28,
          "packageType": "DRM",
          "properShippingname": "Sulfuric acid",
          "technicalName": "[object Object]",
          "volume": 12.49,
          "volumeUom": "CUB"
        }
      ],
      "innerPackageCount": 333,
      "loadingMeters": 0.65,
      "marksAndNumbers": "W2nYxxST",
      "originCountryCode": "MF",
      "packageCount": 292,
      "packageID": "SBJ0iUW_U9",
      "packageType": "PLT",
      "temperatures": {
        "requiredMaximum": 7.6,
        "requiredMinimum": -9.1,
        "requiresTemperatureControl": false,
        "uom": "CEL"
      },
      "volume": 11.91,
      "volumeUom": "CUB"
    }
  ],
  "notes": [
    {
      "text": "Texo animi triumphus delectatio brevis.",
      "type": "CIN"
    },
    {
      "text": "Iure synagoga cariosus acer decretum tego corrupti sub denego nihil.",
      "type": "DEL"
    },
    {
      "text": "Turpis ducimus thalassinus alveus animadverto solitudo casus.",
      "type": "SHP"
    },
    {
      "text": "Perferendis accommodo acceptus molestias.",
      "type": "DEL"
    }
  ],
  "references": [
    {
      "number": "yVFaNoXl",
      "type": "CRN"
    },
    {
      "number": "ygZtHj7l",
      "type": "INV"
    },
    {
      "number": "uNWWrq5u",
      "type": "BOL"
    }
  ],
  "shipmentBranchCode": "SIN"
}
Response Payload
{
  "api-correlation-id": "c29533b3-6cb8-4712-b0b3-78276bf91918",
  "detail": "Voluptatem solutio perspiciatis cetera debeo cogito vehemens vulnero atrocitas inventore.",
  "results": [
    {
      "status": "accepted",
      "updateField": "soluta"
    },
    {
      "status": "accepted",
      "updateField": "tricesimus"
    }
  ],
  "status": 200
}
{
  "api-correlation-id": "ad892b79-99aa-455e-8cb8-71c01c52803a",
  "detail": "Expired Access Token",
  "status": 401,
  "title": "Crustulum sit aegrotatio thermae."
}
{
  "api-correlation-id": "686318bf-de08-4282-94f4-ea4e40cc1db4",
  "detail": "Ambulo confero cognomen corpus advoco dolorum volaticus.",
  "results": [
    {
      "details": "Vox defleo sit deserunt suspendo maiores solvo.",
      "status": "rejected",
      "updateField": "vapulus"
    }
  ],
  "status": 403,
  "title": "Ipsum bis perspiciatis."
}
{
  "api-correlation-id": "8a0d88ea-a5e4-435b-9dc3-3b64981d56e4",
  "detail": "Abeo temperantia annus adficio corpus.",
  "status": "appono"
}
{
  "api-correlation-id": "041b0389-961d-48ab-b22e-03c0608f90ea",
  "detail": "Tabesco dignissimos demergo animadverto adflicto tripudio conturbo.",
  "status": 429,
  "title": "Too Many Requests"
}
{
  "api-correlation-id": "1a997604-fe09-447e-a401-a14c4e077ed4",
  "detail": "Terra cariosus cohibeo desipio uberrime ocer curso absens illum.",
  "status": 500,
  "title": "Internal Server Error"
}
Query Parameter NameExample
_DGFBookingID*consequat adipisicing cupidatat
Request Payload
Response Payload
{
  "housebillNumber": "LI93uo1K6h",
  "shipmentID": "rHSDPF3j6z",
  "shipmentTrackingURL": "https://slow-birdcage.com/",
  "status": "Shipment Created"
}
{
  "api-correlation-id": "10712f89-a854-44ca-aa1d-1a8c633542c5",
  "detail": "Expired Access Token",
  "status": 401,
  "title": "Deprecator aer clarus turba quisquam."
}
{
  "status": "socius",
  "title": "Armarium abbas delectatio vergo attonbitus coadunatio totam dolorum."
}
Query Parameter NameExample
codeListIDPackageType
Request Payload
Response Payload
{
  "Result": [
    {
      "description": "ulciscor thorax appono",
      "id": "bga"
    },
    {
      "description": "subiungo atque valde",
      "id": "jtH"
    }
  ]
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "detail": "Villa super vox verto dedecor catena substantia supplanto.",
  "title": "Cognatus caritas voluntarius adipiscor validus atqui clamo cruciamentum deleo tamen."
}
Service Homepage: developer.dhl.com/api-reference/dgf-shipment-booking#reference-docs-section
dhllogisticsfreightshippingtransportation