DHL TMS API Virtual Sandbox

Interface for DHL Transport Management System operations.

The DSC TMS API provides a standardized interface for managing transportation orders within the DHL Transport Management System. It enables developers to integrate order lifecycle management, including creation, updates, and deletion of transportation records.

Use this hosted sandbox to simulate DHL TMS API 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 transportation order payloads, verify status transition logic, test error handling for invalid order data, and simulate the integration workflow between external systems and the DHL TMS backend.

DHL TMS API virtual sandbox is up and running!

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

`https://dhl-tms.mock.beeceptor.com`

Transportation Order(3 operations)

POST

/order

Create a new order

Request Payload

{
  "facilityId": "AU_0195",
  "customerId": "CI1234546",
  "orderNumber": "54321",
  "orderType": "CustomerOrder",
  "customerPurchaseOrderNumber": "string",
  "tariffType": "SBD",
  "priorityCode": "Emergency",
  "carrierService": "APLL",
  "expectedDeliveryDate": "20190801223000",
  "requiredDeliveryDate": "20220105091310",
  "pickupDate": "20190801223000",
  "additionalInformation": "string",
  "addOrRefreshLines": "ADD",
  "shipperLocation": "SHIPPER",
  "receiverLocation": "CONSIGNEE",
  "loadingLocation": "PLAN_FROM",
  "unloadingLocation": "PLAN_TO",
  "incoterms": "DDP",
  "incotermLocation": "TEST",
  "transportMode": "LTL",
  "equipment": "53DV",
  "orderReferences": [
    {
      "orderReferenceType": "ORDER OWNER",
      "orderReferenceValue": "CREATE"
    }
  ],
  "orderRemarks": [
    {
      "orderRemarkType": "COMMENT",
      "orderRemarkValue": "CREATE"
    }
  ],
  "orderInvolvedParties": [
    {
      "orderInvolvedPartyType": "CONSIGNEE",
      "orderInvolvedPartyValue": "CONSIGNEE"
    }
  ],
  "orderStatus": [
    {
      "orderStatusType": "READY_TO_SHIP",
      "orderStatusValue": "READY_TO_SHIP_NEW"
    }
  ],
  "loadingAddress": {
    "description": "string",
    "addressId": "string",
    "name": "Alan Shearer",
    "addressLine1": "123 Another road",
    "addressLine2": "string",
    "addressLine3": "string",
    "city": "Springfield",
    "state": "QLD",
    "postCode": "string",
    "countryCode": "AU",
    "phoneNumber": "+6512345611",
    "email": "alan.shearer@email.com",
    "province": "QUEBEC",
    "latitude": "45.32583",
    "longitude": "-73.29717",
    "locationDescription": "PLAN_FROM",
    "locationCalendar": "string",
    "locationReferences": [
      {
        "locationReferenceType": "SPECIAL INSTRUCTIONS",
        "locationReferenceValue": "CREATE"
      }
    ]
  },
  "shipperAddress": {
    "description": "string",
    "addressId": "string",
    "name": "Alan Shearer",
    "addressLine1": "123 Another road",
    "addressLine2": "string",
    "addressLine3": "string",
    "city": "Springfield",
    "state": "QLD",
    "postCode": "string",
    "countryCode": "AU",
    "phoneNumber": "+6512345611",
    "email": "alan.shearer@email.com",
    "province": "QUEBEC",
    "latitude": "45.32583",
    "longitude": "-73.29717",
    "locationDescription": "PLAN_FROM",
    "locationCalendar": "string",
    "locationReferences": [
      {
        "locationReferenceType": "SPECIAL INSTRUCTIONS",
        "locationReferenceValue": "CREATE"
      }
    ]
  },
  "receiverAddress": {
    "description": "string",
    "addressId": "string",
    "name": "Alan Shearer",
    "addressLine1": "123 Another road",
    "addressLine2": "string",
    "addressLine3": "string",
    "city": "Springfield",
    "state": "QLD",
    "postCode": "string",
    "countryCode": "AU",
    "phoneNumber": "+6512345611",
    "email": "alan.shearer@email.com",
    "province": "QUEBEC",
    "latitude": "45.32583",
    "longitude": "-73.29717",
    "locationDescription": "PLAN_FROM",
    "locationCalendar": "string",
    "locationReferences": [
      {
        "locationReferenceType": "SPECIAL INSTRUCTIONS",
        "locationReferenceValue": "CREATE"
      }
    ]
  },
  "unloadingAddress": {
    "description": "string",
    "addressId": "string",
    "name": "John Smith",
    "addressLine1": "123 My Street",
    "addressLine2": "string",
    "addressLine3": "string",
    "city": "Springfield",
    "state": "QLD",
    "postCode": "string",
    "countryCode": "AU",
    "phoneNumber": "+6512345611",
    "email": "john.smith@somecompany.com",
    "province": "QUEBEC",
    "latitude": "45.32583",
    "longitude": "-73.29717",
    "locationDescription": "PLAN_FROM",
    "locationCalendar": "string",
    "locationReferences": [
      {
        "locationReferenceType": "SPECIAL INSTRUCTIONS",
        "locationReferenceValue": "CREATE"
      }
    ]
  },
  "lineItems": [
    {
      "quantity": 5,
      "unitOfMeasure": "PLT",
      "skuCode": "string",
      "packageCode": "string",
      "commodityCode": "string",
      "volume": 100,
      "volumeUom": "CC",
      "grossWeight": 15,
      "netWeight": 200,
      "weightUom": "string",
      "length": 12,
      "width": 13,
      "height": 14,
      "dimensionUom": "cm",
      "value": 123,
      "currency": "EUR",
      "goodsDescription": "string",
      "dangerousGoods": false,
      "dangerousGoodsType": "DG",
      "storageType": "Ambient",
      "relativePalletQuantity": 15,
      "lineNumber": "OR_API_SIT_0504_001_001",
      "isSplitAllowed": true,
      "handlingUnitType": "TEST_PALLET",
      "orderLineReferences": [
        {
          "orderLineReferenceType": "TEMP_CONTROL",
          "orderLineReferenceValue": "CREATE"
        }
      ],
      "orderLineRemarks": [
        {
          "orderLineRemarkType": "EXPEDITE",
          "orderLineRemarkValue": "CREATE"
        }
      ],
      "orderLineInvolvedParties": [
        {
          "orderLineInvolvedPartyType": "SHIPPER",
          "orderLineInvolvedPartyValue": "SHIPPER"
        }
      ]
    }
  ],
  "products": [
    {
      "skuCode": "TEST_ITEM_1",
      "productDescription": "TEST_ITEM_1",
      "NMFCClass": "125.0",
      "productRemarks": [
        {
          "productRemarkType": "COMMENT",
          "productRemarkValue": "TEST"
        }
      ],
      "commodityCode": "PFF",
      "packageCode": "TEST_ITEM_1",
      "handlingUnitType": "EA",
      "dangerousGoods": true
    }
  ]
}

Response Payload

{
  "facilityId": "AU_0195",
  "customerId": "CI1234546",
  "orderNumber": "54321",
  "orderType": "CustomerOrder",
  "customerPurchaseOrderNumber": "string",
  "tariffType": "SBD",
  "priorityCode": "Emergency",
  "carrierService": "APLL",
  "expectedDeliveryDate": "20190801223000",
  "requiredDeliveryDate": "20220105091310",
  "pickupDate": "20190801223000",
  "additionalInformation": "string",
  "addOrRefreshLines": "ADD",
  "shipperLocation": "SHIPPER",
  "receiverLocation": "CONSIGNEE",
  "loadingLocation": "PLAN_FROM",
  "unloadingLocation": "PLAN_TO",
  "incoterms": "DDP",
  "incotermLocation": "TEST",
  "transportMode": "LTL",
  "equipment": "53DV",
  "orderReferences": [
    {
      "orderReferenceType": "ORDER OWNER",
      "orderReferenceValue": "CREATE"
    }
  ],
  "orderRemarks": [
    {
      "orderRemarkType": "COMMENT",
      "orderRemarkValue": "CREATE"
    }
  ],
  "orderInvolvedParties": [
    {
      "orderInvolvedPartyType": "CONSIGNEE",
      "orderInvolvedPartyValue": "CONSIGNEE"
    }
  ],
  "orderStatus": [
    {
      "orderStatusType": "READY_TO_SHIP",
      "orderStatusValue": "READY_TO_SHIP_NEW"
    }
  ],
  "loadingAddress": {
    "description": "string",
    "addressId": "string",
    "name": "Alan Shearer",
    "addressLine1": "123 Another road",
    "addressLine2": "string",
    "addressLine3": "string",
    "city": "Springfield",
    "state": "QLD",
    "postCode": "string",
    "countryCode": "AU",
    "phoneNumber": "+6512345611",
    "email": "alan.shearer@email.com",
    "province": "QUEBEC",
    "latitude": "45.32583",
    "longitude": "-73.29717",
    "locationDescription": "PLAN_FROM",
    "locationCalendar": "string",
    "locationReferences": [
      {
        "locationReferenceType": "SPECIAL INSTRUCTIONS",
        "locationReferenceValue": "CREATE"
      }
    ]
  },
  "shipperAddress": {
    "description": "string",
    "addressId": "string",
    "name": "Alan Shearer",
    "addressLine1": "123 Another road",
    "addressLine2": "string",
    "addressLine3": "string",
    "city": "Springfield",
    "state": "QLD",
    "postCode": "string",
    "countryCode": "AU",
    "phoneNumber": "+6512345611",
    "email": "alan.shearer@email.com",
    "province": "QUEBEC",
    "latitude": "45.32583",
    "longitude": "-73.29717",
    "locationDescription": "PLAN_FROM",
    "locationCalendar": "string",
    "locationReferences": [
      {
        "locationReferenceType": "SPECIAL INSTRUCTIONS",
        "locationReferenceValue": "CREATE"
      }
    ]
  },
  "receiverAddress": {
    "description": "string",
    "addressId": "string",
    "name": "Alan Shearer",
    "addressLine1": "123 Another road",
    "addressLine2": "string",
    "addressLine3": "string",
    "city": "Springfield",
    "state": "QLD",
    "postCode": "string",
    "countryCode": "AU",
    "phoneNumber": "+6512345611",
    "email": "alan.shearer@email.com",
    "province": "QUEBEC",
    "latitude": "45.32583",
    "longitude": "-73.29717",
    "locationDescription": "PLAN_FROM",
    "locationCalendar": "string",
    "locationReferences": [
      {
        "locationReferenceType": "SPECIAL INSTRUCTIONS",
        "locationReferenceValue": "CREATE"
      }
    ]
  },
  "unloadingAddress": {
    "description": "string",
    "addressId": "string",
    "name": "John Smith",
    "addressLine1": "123 My Street",
    "addressLine2": "string",
    "addressLine3": "string",
    "city": "Springfield",
    "state": "QLD",
    "postCode": "string",
    "countryCode": "AU",
    "phoneNumber": "+6512345611",
    "email": "john.smith@somecompany.com",
    "province": "QUEBEC",
    "latitude": "45.32583",
    "longitude": "-73.29717",
    "locationDescription": "PLAN_FROM",
    "locationCalendar": "string",
    "locationReferences": [
      {
        "locationReferenceType": "SPECIAL INSTRUCTIONS",
        "locationReferenceValue": "CREATE"
      }
    ]
  },
  "lineItems": [
    {
      "quantity": 5,
      "unitOfMeasure": "PLT",
      "skuCode": "string",
      "packageCode": "string",
      "commodityCode": "string",
      "volume": 100,
      "volumeUom": "CC",
      "grossWeight": 15,
      "netWeight": 200,
      "weightUom": "string",
      "length": 12,
      "width": 13,
      "height": 14,
      "dimensionUom": "cm",
      "value": 123,
      "currency": "EUR",
      "goodsDescription": "string",
      "dangerousGoods": false,
      "dangerousGoodsType": "DG",
      "storageType": "Ambient",
      "relativePalletQuantity": 15,
      "lineNumber": "OR_API_SIT_0504_001_001",
      "isSplitAllowed": true,
      "handlingUnitType": "TEST_PALLET",
      "orderLineReferences": [
        {
          "orderLineReferenceType": "TEMP_CONTROL",
          "orderLineReferenceValue": "CREATE"
        }
      ],
      "orderLineRemarks": [
        {
          "orderLineRemarkType": "EXPEDITE",
          "orderLineRemarkValue": "CREATE"
        }
      ],
      "orderLineInvolvedParties": [
        {
          "orderLineInvolvedPartyType": "SHIPPER",
          "orderLineInvolvedPartyValue": "SHIPPER"
        }
      ]
    }
  ],
  "products": [
    {
      "skuCode": "TEST_ITEM_1",
      "productDescription": "TEST_ITEM_1",
      "NMFCClass": "125.0",
      "productRemarks": [
        {
          "productRemarkType": "COMMENT",
          "productRemarkValue": "TEST"
        }
      ],
      "commodityCode": "PFF",
      "packageCode": "TEST_ITEM_1",
      "handlingUnitType": "EA",
      "dangerousGoods": true
    }
  ],
  "transmissionNumber": "230134907 (Only applicable for certain TMS systems)"
}

{
  "title": "Bad Request",
  "detail": "Invalid Request",
  "status": 400,
  "instance": "order/1234"
}

{
  "title": "Forbidden Error",
  "detail": "API permission refused",
  "status": 403,
  "instance": "order/1234"
}

PUT

/order

Update an existing order

Request Payload

{
  "facilityId": "AU_0195",
  "customerId": "CI1234546",
  "orderNumber": "54321",
  "orderType": "CustomerOrder",
  "customerPurchaseOrderNumber": "string",
  "tariffType": "SBD",
  "priorityCode": "Emergency",
  "carrierService": "APLL",
  "expectedDeliveryDate": "20190801223000",
  "requiredDeliveryDate": "20220105091310",
  "pickupDate": "20190801223000",
  "additionalInformation": "string",
  "addOrRefreshLines": "ADD",
  "shipperLocation": "SHIPPER",
  "receiverLocation": "CONSIGNEE",
  "loadingLocation": "PLAN_FROM",
  "unloadingLocation": "PLAN_TO",
  "incoterms": "DDP",
  "incotermLocation": "TEST",
  "transportMode": "LTL",
  "equipment": "53DV",
  "orderReferences": [
    {
      "orderReferenceType": "ORDER OWNER",
      "orderReferenceValue": "CREATE"
    }
  ],
  "orderRemarks": [
    {
      "orderRemarkType": "COMMENT",
      "orderRemarkValue": "CREATE"
    }
  ],
  "orderInvolvedParties": [
    {
      "orderInvolvedPartyType": "CONSIGNEE",
      "orderInvolvedPartyValue": "CONSIGNEE"
    }
  ],
  "orderStatus": [
    {
      "orderStatusType": "READY_TO_SHIP",
      "orderStatusValue": "READY_TO_SHIP_NEW"
    }
  ],
  "loadingAddress": {
    "description": "string",
    "addressId": "string",
    "name": "Alan Shearer",
    "addressLine1": "123 Another road",
    "addressLine2": "string",
    "addressLine3": "string",
    "city": "Springfield",
    "state": "QLD",
    "postCode": "string",
    "countryCode": "AU",
    "phoneNumber": "+6512345611",
    "email": "alan.shearer@email.com",
    "province": "QUEBEC",
    "latitude": "45.32583",
    "longitude": "-73.29717",
    "locationDescription": "PLAN_FROM",
    "locationCalendar": "string",
    "locationReferences": [
      {
        "locationReferenceType": "SPECIAL INSTRUCTIONS",
        "locationReferenceValue": "CREATE"
      }
    ]
  },
  "shipperAddress": {
    "description": "string",
    "addressId": "string",
    "name": "Alan Shearer",
    "addressLine1": "123 Another road",
    "addressLine2": "string",
    "addressLine3": "string",
    "city": "Springfield",
    "state": "QLD",
    "postCode": "string",
    "countryCode": "AU",
    "phoneNumber": "+6512345611",
    "email": "alan.shearer@email.com",
    "province": "QUEBEC",
    "latitude": "45.32583",
    "longitude": "-73.29717",
    "locationDescription": "PLAN_FROM",
    "locationCalendar": "string",
    "locationReferences": [
      {
        "locationReferenceType": "SPECIAL INSTRUCTIONS",
        "locationReferenceValue": "CREATE"
      }
    ]
  },
  "receiverAddress": {
    "description": "string",
    "addressId": "string",
    "name": "Alan Shearer",
    "addressLine1": "123 Another road",
    "addressLine2": "string",
    "addressLine3": "string",
    "city": "Springfield",
    "state": "QLD",
    "postCode": "string",
    "countryCode": "AU",
    "phoneNumber": "+6512345611",
    "email": "alan.shearer@email.com",
    "province": "QUEBEC",
    "latitude": "45.32583",
    "longitude": "-73.29717",
    "locationDescription": "PLAN_FROM",
    "locationCalendar": "string",
    "locationReferences": [
      {
        "locationReferenceType": "SPECIAL INSTRUCTIONS",
        "locationReferenceValue": "CREATE"
      }
    ]
  },
  "unloadingAddress": {
    "description": "string",
    "addressId": "string",
    "name": "John Smith",
    "addressLine1": "123 My Street",
    "addressLine2": "string",
    "addressLine3": "string",
    "city": "Springfield",
    "state": "QLD",
    "postCode": "string",
    "countryCode": "AU",
    "phoneNumber": "+6512345611",
    "email": "john.smith@somecompany.com",
    "province": "QUEBEC",
    "latitude": "45.32583",
    "longitude": "-73.29717",
    "locationDescription": "PLAN_FROM",
    "locationCalendar": "string",
    "locationReferences": [
      {
        "locationReferenceType": "SPECIAL INSTRUCTIONS",
        "locationReferenceValue": "CREATE"
      }
    ]
  },
  "lineItems": [
    {
      "quantity": 5,
      "unitOfMeasure": "PLT",
      "skuCode": "string",
      "packageCode": "string",
      "commodityCode": "string",
      "volume": 100,
      "volumeUom": "CC",
      "grossWeight": 15,
      "netWeight": 200,
      "weightUom": "string",
      "length": 12,
      "width": 13,
      "height": 14,
      "dimensionUom": "cm",
      "value": 123,
      "currency": "EUR",
      "goodsDescription": "string",
      "dangerousGoods": false,
      "dangerousGoodsType": "DG",
      "storageType": "Ambient",
      "relativePalletQuantity": 15,
      "lineNumber": "OR_API_SIT_0504_001_001",
      "isSplitAllowed": true,
      "handlingUnitType": "TEST_PALLET",
      "orderLineReferences": [
        {
          "orderLineReferenceType": "TEMP_CONTROL",
          "orderLineReferenceValue": "CREATE"
        }
      ],
      "orderLineRemarks": [
        {
          "orderLineRemarkType": "EXPEDITE",
          "orderLineRemarkValue": "CREATE"
        }
      ],
      "orderLineInvolvedParties": [
        {
          "orderLineInvolvedPartyType": "SHIPPER",
          "orderLineInvolvedPartyValue": "SHIPPER"
        }
      ]
    }
  ],
  "products": [
    {
      "skuCode": "TEST_ITEM_1",
      "productDescription": "TEST_ITEM_1",
      "NMFCClass": "125.0",
      "productRemarks": [
        {
          "productRemarkType": "COMMENT",
          "productRemarkValue": "TEST"
        }
      ],
      "commodityCode": "PFF",
      "packageCode": "TEST_ITEM_1",
      "handlingUnitType": "EA",
      "dangerousGoods": true
    }
  ]
}

Response Payload

{
  "facilityId": "AU_0195",
  "customerId": "CI1234546",
  "orderNumber": "54321",
  "orderType": "CustomerOrder",
  "customerPurchaseOrderNumber": "string",
  "tariffType": "SBD",
  "priorityCode": "Emergency",
  "carrierService": "APLL",
  "expectedDeliveryDate": "20190801223000",
  "requiredDeliveryDate": "20220105091310",
  "pickupDate": "20190801223000",
  "additionalInformation": "string",
  "addOrRefreshLines": "ADD",
  "shipperLocation": "SHIPPER",
  "receiverLocation": "CONSIGNEE",
  "loadingLocation": "PLAN_FROM",
  "unloadingLocation": "PLAN_TO",
  "incoterms": "DDP",
  "incotermLocation": "TEST",
  "transportMode": "LTL",
  "equipment": "53DV",
  "orderReferences": [
    {
      "orderReferenceType": "ORDER OWNER",
      "orderReferenceValue": "CREATE"
    }
  ],
  "orderRemarks": [
    {
      "orderRemarkType": "COMMENT",
      "orderRemarkValue": "CREATE"
    }
  ],
  "orderInvolvedParties": [
    {
      "orderInvolvedPartyType": "CONSIGNEE",
      "orderInvolvedPartyValue": "CONSIGNEE"
    }
  ],
  "orderStatus": [
    {
      "orderStatusType": "READY_TO_SHIP",
      "orderStatusValue": "READY_TO_SHIP_NEW"
    }
  ],
  "loadingAddress": {
    "description": "string",
    "addressId": "string",
    "name": "Alan Shearer",
    "addressLine1": "123 Another road",
    "addressLine2": "string",
    "addressLine3": "string",
    "city": "Springfield",
    "state": "QLD",
    "postCode": "string",
    "countryCode": "AU",
    "phoneNumber": "+6512345611",
    "email": "alan.shearer@email.com",
    "province": "QUEBEC",
    "latitude": "45.32583",
    "longitude": "-73.29717",
    "locationDescription": "PLAN_FROM",
    "locationCalendar": "string",
    "locationReferences": [
      {
        "locationReferenceType": "SPECIAL INSTRUCTIONS",
        "locationReferenceValue": "CREATE"
      }
    ]
  },
  "shipperAddress": {
    "description": "string",
    "addressId": "string",
    "name": "Alan Shearer",
    "addressLine1": "123 Another road",
    "addressLine2": "string",
    "addressLine3": "string",
    "city": "Springfield",
    "state": "QLD",
    "postCode": "string",
    "countryCode": "AU",
    "phoneNumber": "+6512345611",
    "email": "alan.shearer@email.com",
    "province": "QUEBEC",
    "latitude": "45.32583",
    "longitude": "-73.29717",
    "locationDescription": "PLAN_FROM",
    "locationCalendar": "string",
    "locationReferences": [
      {
        "locationReferenceType": "SPECIAL INSTRUCTIONS",
        "locationReferenceValue": "CREATE"
      }
    ]
  },
  "receiverAddress": {
    "description": "string",
    "addressId": "string",
    "name": "Alan Shearer",
    "addressLine1": "123 Another road",
    "addressLine2": "string",
    "addressLine3": "string",
    "city": "Springfield",
    "state": "QLD",
    "postCode": "string",
    "countryCode": "AU",
    "phoneNumber": "+6512345611",
    "email": "alan.shearer@email.com",
    "province": "QUEBEC",
    "latitude": "45.32583",
    "longitude": "-73.29717",
    "locationDescription": "PLAN_FROM",
    "locationCalendar": "string",
    "locationReferences": [
      {
        "locationReferenceType": "SPECIAL INSTRUCTIONS",
        "locationReferenceValue": "CREATE"
      }
    ]
  },
  "unloadingAddress": {
    "description": "string",
    "addressId": "string",
    "name": "John Smith",
    "addressLine1": "123 My Street",
    "addressLine2": "string",
    "addressLine3": "string",
    "city": "Springfield",
    "state": "QLD",
    "postCode": "string",
    "countryCode": "AU",
    "phoneNumber": "+6512345611",
    "email": "john.smith@somecompany.com",
    "province": "QUEBEC",
    "latitude": "45.32583",
    "longitude": "-73.29717",
    "locationDescription": "PLAN_FROM",
    "locationCalendar": "string",
    "locationReferences": [
      {
        "locationReferenceType": "SPECIAL INSTRUCTIONS",
        "locationReferenceValue": "CREATE"
      }
    ]
  },
  "lineItems": [
    {
      "quantity": 5,
      "unitOfMeasure": "PLT",
      "skuCode": "string",
      "packageCode": "string",
      "commodityCode": "string",
      "volume": 100,
      "volumeUom": "CC",
      "grossWeight": 15,
      "netWeight": 200,
      "weightUom": "string",
      "length": 12,
      "width": 13,
      "height": 14,
      "dimensionUom": "cm",
      "value": 123,
      "currency": "EUR",
      "goodsDescription": "string",
      "dangerousGoods": false,
      "dangerousGoodsType": "DG",
      "storageType": "Ambient",
      "relativePalletQuantity": 15,
      "lineNumber": "OR_API_SIT_0504_001_001",
      "isSplitAllowed": true,
      "handlingUnitType": "TEST_PALLET",
      "orderLineReferences": [
        {
          "orderLineReferenceType": "TEMP_CONTROL",
          "orderLineReferenceValue": "CREATE"
        }
      ],
      "orderLineRemarks": [
        {
          "orderLineRemarkType": "EXPEDITE",
          "orderLineRemarkValue": "CREATE"
        }
      ],
      "orderLineInvolvedParties": [
        {
          "orderLineInvolvedPartyType": "SHIPPER",
          "orderLineInvolvedPartyValue": "SHIPPER"
        }
      ]
    }
  ],
  "products": [
    {
      "skuCode": "TEST_ITEM_1",
      "productDescription": "TEST_ITEM_1",
      "NMFCClass": "125.0",
      "productRemarks": [
        {
          "productRemarkType": "COMMENT",
          "productRemarkValue": "TEST"
        }
      ],
      "commodityCode": "PFF",
      "packageCode": "TEST_ITEM_1",
      "handlingUnitType": "EA",
      "dangerousGoods": true
    }
  ],
  "transmissionNumber": "230134907 (Only applicable for certain TMS systems)"
}

{
  "title": "Bad Request",
  "detail": "Invalid Request",
  "status": 400,
  "instance": "order/1234"
}

{
  "title": "Forbidden Error",
  "detail": "API permission refused",
  "status": 403,
  "instance": "order/1234"
}

{
  "title": "Not Found",
  "detail": "Cannot find the requested order",
  "status": 404,
  "instance": "order/1234"
}

DELETE

/order

This API cancels a particular order from the Buejay TMS application.

Query Parameter Name	Example
`facilityId`*	`consequat mollit exercitation`
`customerId`*	`voluptate do consectetur tempor`
`orderNumber`*	`dolor enim laborum veniam`

Request Payload

Response Payload

{
  "customerId": "CID005233",
  "detail": "order/1234",
  "FacilityId": "GB_0044",
  "status": "Order cancelled successfully"
}

{
  "title": "Bad Request",
  "detail": "Invalid Request",
  "status": 400,
  "instance": "order/1234"
}

{
  "title": "Forbidden Error",
  "detail": "API permission refused",
  "status": 403,
  "instance": "order/1234"
}

{
  "title": "Not Found",
  "detail": "Cannot find the requested order",
  "status": 404,
  "instance": "order/1234"
}

Service Homepage: developer.dhl.com/api-reference/transportation-management#reference-docs-section

dhllogisticstransportationtmssupply-chain