DHL Parcel DE Private Shipping Virtual Sandbox

API for managing private shipping labels and shopping carts for DHL Parcel Germany.

The DHL Parcel DE Private Shipping API enables developers to integrate shipping label creation, shopping cart management, and QR code generation for DHL Parcel services within Germany. It supports the full lifecycle of a shipment, from catalog product selection to label retrieval and format customization.

Use this hosted sandbox to simulate DHL Parcel DE Private Shipping 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 shipping label generation workflows, test shopping cart item structures, verify QR code data payloads, and handle label format variations for different shipment types before integrating with DHL production services.

DHL Parcel DE Private Shipping virtual sandbox is up and running!

Use this sandbox URL as the API base in your code to simulate DHL Parcel DE Private Shipping responses instantly.

`https://dhl-parcel-de-shipping.mock.beeceptor.com`

ProductCatalog(2 operations)

GET

/catalog/{version}/products

Returns available products on the marketplace according to the chosen version of the productcatalog. The version determines the point in time for which available products are requested.

Request Payload

Response Payload

{
  "defaultProduct": "sT8Zyo",
  "pickups": {},
  "products": {},
  "services": {}
}

{
  "code": "Example Error Code",
  "detail": "Error Details"
}

GET

/catalog/{version}/countries

Returns a list of country codes associated to information about the country

Request Payload

Response Payload

{
  "countries": {}
}

{
  "code": "Example Error Code",
  "detail": "Error Details"
}

Purchases(2 operations)

POST

/shopping-carts/pre-paid

Posting a shopping cart on the prepaid endpoint will create a new resource on the server side and will return a complete configured `ShoppingCart` Template. This shopping cart contains an entryURL, pointing to a page on the DHL Online Franking application, which shows the contents of the posted sho

Request Payload

{
  "shoppingcart": {
    "confirmation": {
      "email": "noreply@dhl.com",
      "notifyUrl": "https://www.dhl.de"
    },
    "items": [
      {
        "address": {
          "receiver": {
            "city": "Bonn",
            "country": "DEU",
            "email": "noreply@dhl.com",
            "name2": "Selma Sender",
            "plz": "53113",
            "street": "Sträßchensweg",
            "streetNumber": "1-5"
          },
          "sender": {
            "city": "Bonn",
            "country": "DEU",
            "email": "noreply@dhl.com",
            "name2": "Selma Sender",
            "plz": "53113",
            "street": "Sträßchensweg",
            "streetNumber": "1-5"
          }
        },
        "product": {
          "id": "PAK10.NNAHME"
        },
        "services": {
          "NNAHME": {
            "bic": "TESTDETT000",
            "currency": "EUR",
            "iban": "DEXXXXXXXXXXXXXXXXXXXX",
            "nnamount": "12.00",
            "owner": "Tester",
            "usage": "Test"
          }
        },
        "type": "ShipmentItem"
      }
    ]
  }
}

Response Payload

{
  "shoppingcart": {
    "state": "PREPAID",
    "download": {
      "entryUrl": "https://www.dhl.de/send-parcel/gw/rest/init?token=XXX"
    },
    "confirmation": {
      "notifyUrl": "https://www.dhl.de",
      "email": "noreply@dhl.com"
    },
    "items": [
      {
        "address": {
          "sender": {
            "name2": "Selma Sender",
            "street": "Sträßchensweg",
            "streetNumber": "1-5",
            "plz": "53113",
            "city": "Bonn",
            "country": "DEU",
            "email": "noreply@dhl.com"
          },
          "receiver": {
            "name2": "Selma Sender",
            "street": "Sträßchensweg",
            "streetNumber": "1-5",
            "plz": "53113",
            "city": "Bonn",
            "country": "DEU",
            "email": "noreply@dhl.com"
          }
        },
        "product": {
          "id": "PAK10.NNAHME"
        },
        "state": "PREPAID",
        "position": 0,
        "services": {
          "NNAHME": {
            "currency": "EUR",
            "owner": "Tester",
            "bic": "TESTDETT000",
            "iban": "DEXXXXXXXXXXXXXXXXXXXX",
            "nnamount": "12.00",
            "usage": "Test"
          }
        },
        "prices": [
          {
            "amount": "10.10",
            "tax": "19.00",
            "vat": "1.61",
            "currency": "EUR",
            "id": "PAK10"
          },
          {
            "amount": "6.90",
            "tax": "19.00",
            "vat": "1.10",
            "currency": "EUR",
            "id": "NNAHME"
          }
        ]
      }
    ]
  }
}

{
  "code": "Example Error Code",
  "detail": "Error Details"
}

{
  "code": "Example Error Code",
  "detail": "Error Details"
}

{
  "code": "Example Error Code",
  "detail": "Error Details"
}

GET

/shopping-carts/{shoppingCartId}

Loads a created shoppingcart including all items and services.

Request Payload

Response Payload

{
  "shoppingcart": {
    "confirmation": {
      "acceptAgb": true,
      "acceptAtb": false,
      "email": "952JaFQjW7n9Q@JZagHjWQTsFRAwVtJDLKTOWJGNNmSZ.usk",
      "notifyUrl": "https://www.dhl.de"
    },
    "download": {
      "entryUrl": "https://www.dhl.de/int-versenden/gw/rest/init?token=XXX"
    },
    "invoice": {
      "invoice": {
        "addressAddition1": "sit pariatur i",
        "addressAddition2": "proident consectetur",
        "city": "Fort Hortense",
        "country": "GEO",
        "email": "Esta_McLaughlin0@yahoo.com",
        "name1": "Miss",
        "name2": "Marvin Farrell",
        "name3": "sed",
        "phone": "+15575253466",
        "plz": "11666-9519",
        "province": "Nordrhein-Westfalen",
        "street": "E Jefferson Street",
        "streetNumber": "583",
        "type": "veniam deserunt reprehenderit quis"
      },
      "invoiceNumber": "DOF-XXX-XXX"
    },
    "items": [
      {
        "type": "sint dolor ea"
      },
      {
        "type": "dolore Ut commodo labore"
      },
      {
        "type": "esse nulla"
      }
    ],
    "lang": "de",
    "owner": "cillum Duis in",
    "payment": {
      "provider": "caas"
    },
    "shoppingCartId": "qui ad Duisi",
    "state": "INCOMPLETE"
  }
}

{
  "code": "Example Error Code",
  "detail": "Error Details"
}

{
  "code": "Example Error Code",
  "detail": "Error Details"
}

{
  "code": "Example Error Code",
  "detail": "Error Details"
}

Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.

Label Access(6 operations)

GET

/labels/{pakId}

Gets the label pdf or wallet file by PAKID

Query Parameter Name	Example
`withMopsValue`	`false`

Header Name	Example
`accept`*	`"application/json"`

Request Payload

Response Payload

{
  "label": {
    "file": "est ipsum cillum quis irure",
    "name": "in anim",
    "numberOfPages": 64715589,
    "pakId": "Excepteur in ut",
    "type": "ipsum est velit aliquip adipisicing"
  },
  "mopsValue": "ut"
}

{
  "code": "Example Error Code",
  "detail": "Error Details"
}

{
  "code": "Example Error Code",
  "detail": "Error Details"
}

{
  "code": "Example Error Code",
  "detail": "Error Details"
}

{
  "code": "Example Error Code",
  "detail": "Error Details"
}

GET

/labels/{shipmentNumber}

Gets the label pdf or wallet file by a shipment number

Query Parameter Name	Example
`withMopsValue`	`true`

Header Name	Example
`accept`*	`"application/vnd.apple.pkpass"`

Request Payload

Response Payload

{
  "label": {
    "file": "mollit ipsum in anim",
    "name": "voluptate ut",
    "numberOfPages": 28976234,
    "pakId": "nisi enim irure incididunt reprehenderit",
    "type": "in dolor dolore"
  },
  "mopsValue": "nulla in"
}

{
  "code": "Example Error Code",
  "detail": "Error Details"
}

{
  "code": "Example Error Code",
  "detail": "Error Details"
}

{
  "code": "Example Error Code",
  "detail": "Error Details"
}

{
  "code": "Example Error Code",
  "detail": "Error Details"
}

GET

/labels/{pakId}/qr-code

Gets the MOSEL/MOPS QR-Code for mobile printing services by PAKID

Header Name	Example
`accept`*	`"application/json"`

Request Payload

Response Payload

{
  "qrcode": {
    "file": "Excepteur dolore deserunt",
    "name": "aliquip qui fugiat sunt",
    "numberOfPages": 38995732,
    "pakId": "ea pariatur occaecat",
    "type": "quis"
  }
}

{
  "code": "Example Error Code",
  "detail": "Error Details"
}

{
  "code": "Example Error Code",
  "detail": "Error Details"
}

{
  "code": "Example Error Code",
  "detail": "Error Details"
}

{
  "code": "Example Error Code",
  "detail": "Error Details"
}

{
  "code": "Example Error Code",
  "detail": "Error Details"
}

GET

/labels/{shipmentNumber}/qr-code

Gets the MOSEL/MOPS QR-Code for mobile printing services by shipment number

Header Name	Example
`accept`*	`"text/plain"`

Request Payload

Response Payload

{
  "qrcode": {
    "file": "mollit proident Ut id consequat",
    "name": "ullamco elit Lorem",
    "numberOfPages": 90179118,
    "pakId": "sit",
    "type": "ipsum laboris dolor ea sed"
  }
}

{
  "code": "Example Error Code",
  "detail": "Error Details"
}

{
  "code": "Example Error Code",
  "detail": "Error Details"
}

{
  "code": "Example Error Code",
  "detail": "Error Details"
}

{
  "code": "Example Error Code",
  "detail": "Error Details"
}

{
  "code": "Example Error Code",
  "detail": "Error Details"
}

GET

/labels/{pakId}/{labelFormat}

Gets the label for the shoppingcart by PAKID

Query Parameter Name	Example
`withMopsValue`	`true`

Header Name	Example
`accept`*	`"application/pdf"`

Request Payload

Response Payload

{
  "label": {
    "file": "eu culpa",
    "name": "dolor Duis irure",
    "numberOfPages": -83496134,
    "pakId": "mollit",
    "type": "adipisicing aliquip"
  },
  "mopsValue": "aute tempor sint laboris sit"
}

{
  "code": "Example Error Code",
  "detail": "Error Details"
}

{
  "code": "Example Error Code",
  "detail": "Error Details"
}

{
  "code": "Example Error Code",
  "detail": "Error Details"
}

{
  "code": "Example Error Code",
  "detail": "Error Details"
}

{
  "code": "Example Error Code",
  "detail": "Error Details"
}

GET

/labels/{shipmentNumber}/{labelFormat}

Gets the label for the shoppingcart by shipment number

Query Parameter Name	Example
`withMopsValue`	`false`

Header Name	Example
`accept`*	`"application/pdf"`

Request Payload

Response Payload

{
  "label": {
    "file": "eu consequat pariatur laborum",
    "name": "Duis dolore do",
    "numberOfPages": 96820252,
    "pakId": "labore officia Ut esse",
    "type": "voluptate adipisicing sunt Excepteur"
  },
  "mopsValue": "exercitation magna Lorem"
}

{
  "code": "Example Error Code",
  "detail": "Error Details"
}

{
  "code": "Example Error Code",
  "detail": "Error Details"
}

{
  "code": "Example Error Code",
  "detail": "Error Details"
}

{
  "code": "Example Error Code",
  "detail": "Error Details"
}

{
  "code": "Example Error Code",
  "detail": "Error Details"
}

Service Homepage: developer.dhl.com/api-reference/dhl-parcel-de-private-shipping-post-parcel-germany#reference-docs-section

dhlshippinglogisticsgermanyparcel