Deutsche Post INTERNETMARKE Virtual Sandbox

Automate online postage generation and mail product management for Deutsche Post.

The INTERNETMARKE API allows developers to integrate Deutsche Post's online postage services directly into their applications. It supports managing shopping carts, generating postage labels in various formats like PNG and PDF, and handling user-specific postage configurations for mail products.

Use this hosted sandbox to simulate Deutsche Post INTERNETMARKE 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 postage label generation workflows, shopping cart management, wallet balance checks, and PDF/PNG rendering logic. Developers can simulate successful label creation, handle order retrieval by ID, and test error responses for invalid mail product configurations before integrating with production postage services.

Deutsche Post INTERNETMARKE virtual sandbox is up and running!

Use this sandbox URL as the API base in your code to simulate Deutsche Post INTERNETMARKE responses instantly.

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

ApiVersionResource

GET

/

The call can be used to obtain the current version of the API and to confirm that the API is operational. Note that this call does not require authentication, it can also be called via browser.

Request Payload

Response Payload

{
  "amp": {
    "env": "prod-eu",
    "name": "pp-post-internetmarke",
    "rev": "8",
    "version": "9.3.3"
  }
}

AppResource(8 operations)

PUT

/app/wallet

Charge users wallet

Query Parameter Name	Example
`amount`*	`1167679982`

Request Payload

Response Payload

{
  "shopOrderId": "7ZBGFv4d44",
  "walletBalance": 88634
}

{
  "statusCode": "400",
  "title": "Bad Request",
  "detail": "Required request header 'Authorization' for method parameter type String is not present"
}

{
  "statusCode": "401",
  "title": "Unauthorized",
  "detail": "Unauthorized, user account is not valid, is locked, the provided authorization token is not valid or the application is not authorized by user."
}

{
  "statusCode": "403",
  "title": "Forbidden",
  "detail": "Forbidden, user has not enough privileges to perform this request."
}

{
  "statusCode": "404",
  "title": "Not Found",
  "detail": "Wallet not found for account: ACCOUNT12345"
}

{
  "statusCode": "429",
  "title": "Too Many Requests",
  "detail": "Too many requests sent, please try again later.)"
}

{
  "statusCode": "500",
  "title": "Internal Server Error",
  "detail": "Internal Server Error, details about the technical error are provided in the response body. Please contact support if the issue persists."
}

POST

/app/shoppingcart

Initializes a shopping cart and returns the shopOrderId.

Request Payload

Response Payload

{
  "shopOrderId": "1cjgG5MJrd"
}

{
  "statusCode": "400",
  "title": "Bad Request",
  "detail": "Required request header 'Authorization' for method parameter type String is not present"
}

{
  "statusCode": "401",
  "title": "Unauthorized",
  "detail": "Unauthorized, user account is not valid, is locked, the provided authorization token is not valid or the application is not authorized by user."
}

{
  "statusCode": "403",
  "title": "Forbidden",
  "detail": "Forbidden, user has not enough privileges to perform this request."
}

{
  "statusCode": "404",
  "title": "Not Found",
  "detail": "Order not found: ORDERID12345"
}

{
  "statusCode": "429",
  "title": "Too Many Requests",
  "detail": "Too many requests sent, please try again later.)"
}

{
  "statusCode": "500",
  "title": "Internal Server Error",
  "detail": "Internal Server Error, details about the technical error are provided in the response body. Please contact support if the issue persists."
}

POST

/app/shoppingcart/png

Checkouts the PNG shopping cart. Be aware of the different types of schemas for checkout OR preview within the request. Preview does not need addresses. The print format is not relevant at this point.

Query Parameter Name	Example
`validate`	`false`
`directCheckout`	`false`

Request Payload

{
  "dpi": "DPI203",
  "imageID": 162,
  "optimizePNG": true,
  "productCode": 380,
  "type": "AppShoppingCartPNGRequest",
  "voucherLayout": "ADDRESS_ZONE"
}

Response Payload

{
  "link": "https://ragged-epic.com",
  "manifestLink": "https://zany-siege.name",
  "shoppingCart": {
    "shopOrderId": "TP5Xk6PUol",
    "voucherList": [
      {
        "trackId": "OKJAyZG7DnFqaiM",
        "voucherId": "c0639eef-66c7-4140-8aa1-a0118ae3a604"
      },
      {
        "trackId": "Q9fEaB3YkgbYI80",
        "voucherId": "71790868-8019-4b70-a9e5-2e4619409223"
      },
      {
        "trackId": "Nq2PyXxbWsb52ld",
        "voucherId": "db688c91-9771-4040-a18b-251b36fa8fbc"
      },
      {
        "trackId": "Gha83TXloUM5Ew1",
        "voucherId": "7a9a7d77-2080-4df8-aca7-3cf87b31e9bf"
      },
      {
        "trackId": "zaLvL1thVRsMuM2",
        "voucherId": "6da857c2-0e5c-432b-8492-e788339bc32f"
      },
      {
        "trackId": "ZCP2fWVxYC00aL5",
        "voucherId": "7016b806-9e9e-4e9e-b92e-afff37f08bea"
      },
      {
        "trackId": "6iPtQbqiKH4cdKG",
        "voucherId": "a5341e71-92d6-428f-a230-c7d1b926a505"
      },
      {
        "trackId": "2GIzwZ9UCXZhXBx",
        "voucherId": "ebcf8089-cff4-4984-a83c-838835b2cc2c"
      },
      {
        "trackId": "OvMzzltUvDAVJzM",
        "voucherId": "8c8cb0e1-5204-4031-8613-aaae8d2a6c78"
      },
      {
        "trackId": "CIEeiceAA81rRML",
        "voucherId": "0b973257-387d-49a9-9029-dd96aceb73e3"
      }
    ]
  },
  "type": "CheckoutResponse",
  "walletBallance": 26890
}

{
  "statusCode": "400",
  "title": "Bad Request",
  "detail": "Required request header 'Authorization' for method parameter type String is not present"
}

{
  "statusCode": "401",
  "title": "Unauthorized",
  "detail": "Unauthorized, user account is not valid, is locked, the provided authorization token is not valid or the application is not authorized by user."
}

{
  "statusCode": "403",
  "title": "Forbidden",
  "detail": "Forbidden, user has not enough privileges to perform this request."
}

{
  "statusCode": "429",
  "title": "Too Many Requests",
  "detail": "Too many requests sent, please try again later.)"
}

{
  "statusCode": "500",
  "title": "Internal Server Error",
  "detail": "Internal Server Error, details about the technical error are provided in the response body. Please contact support if the issue persists."
}

POST

/app/shoppingcart/pdf

Checkouts the PDF shopping cart. Be aware of the different types of schemas for checkout OR preview within the request. Preview does not need addresses.

Query Parameter Name	Example
`validate`	`false`
`directCheckout`	`false`

Request Payload

{
  "createManifest": true,
  "createShippingList": "1",
  "dpi": "DPI300",
  "pageFormatId": 5,
  "positions": [
    {
      "address": {
        "receiver": {
          "additionalName": "Bashirian - Jenkins",
          "addressLine1": "40621 Lindgren Lock",
          "addressLine2": "Apartment 4B",
          "city": "New Susiehaven",
          "country": "CHE",
          "name": "Joanne Kutch",
          "postalCode": "36113"
        },
        "sender": {
          "additionalName": "Mayert Group",
          "addressLine1": "98225 Avenue Road",
          "addressLine2": "-",
          "city": "East Branson",
          "country": "CHE",
          "name": "Danny Stroman",
          "postalCode": "47420"
        }
      },
      "imageID": 403,
      "position": {
        "labelX": 344,
        "labelY": 393,
        "page": 3
      },
      "positionType": "AppShoppingCartPosition",
      "productCode": 683,
      "voucherLayout": "FRANKING_ZONE"
    },
    {
      "address": {
        "receiver": {
          "additionalName": "Haag Group",
          "addressLine1": "960 Pasquale Island",
          "addressLine2": "3rd Floor",
          "city": "Addiestead",
          "country": "CHE",
          "name": "Ms. Tammy Murphy",
          "postalCode": "93421"
        },
        "sender": {
          "additionalName": "Weber Inc",
          "addressLine1": "921 Gudrun Plaza",
          "addressLine2": "3rd Floor",
          "city": "Pocatello",
          "country": "DEU",
          "name": "Damon Murphy I",
          "postalCode": "26282"
        }
      },
      "imageID": 225,
      "position": {
        "labelX": 363,
        "labelY": 65,
        "page": 1
      },
      "positionType": "AppShoppingCartPosition",
      "productCode": 537,
      "voucherLayout": "FRANKING_ZONE"
    },
    {
      "address": {
        "receiver": {
          "additionalName": "Waelchi Inc",
          "addressLine1": "6147 Frami Mall",
          "addressLine2": "Suite 200",
          "city": "Strongsville",
          "country": "AUT",
          "name": "Max Lind",
          "postalCode": "87576"
        },
        "sender": {
          "additionalName": "Rowe - Bode",
          "addressLine1": "500 Estel Landing",
          "addressLine2": "@",
          "city": "Goodwinville",
          "country": "AUT",
          "name": "Mr. Bruce Yundt",
          "postalCode": "06117"
        }
      },
      "imageID": 262,
      "position": {
        "labelX": 478,
        "labelY": 250,
        "page": 8
      },
      "positionType": "AppShoppingCartPosition",
      "productCode": 532,
      "voucherLayout": "FRANKING_ZONE"
    },
    {
      "address": {
        "receiver": {
          "additionalName": "McDermott Group",
          "addressLine1": "509 Canal Street",
          "addressLine2": "Apartment 4B",
          "city": "Lukascester",
          "country": "AUT",
          "name": "Kari Hagenes",
          "postalCode": "35760"
        },
        "sender": {
          "additionalName": "Collier - Purdy",
          "addressLine1": "2995 Lawrence Walks",
          "addressLine2": "Apartment 4B",
          "city": "Fort Emilianostead",
          "country": "AUT",
          "name": "Miss Lisa Dickens",
          "postalCode": "62832"
        }
      },
      "imageID": 98,
      "position": {
        "labelX": 39,
        "labelY": 59,
        "page": 6
      },
      "positionType": "AppShoppingCartPosition",
      "productCode": 137,
      "voucherLayout": "ADDRESS_ZONE"
    },
    {
      "address": {
        "receiver": {
          "additionalName": "Predovic, Schaden and Jerde",
          "addressLine1": "24265 W Oak Street",
          "addressLine2": "3rd Floor",
          "city": "Kirstinfurt",
          "country": "CHE",
          "name": "Stewart Grant-Heathcote",
          "postalCode": "84124"
        },
        "sender": {
          "additionalName": "Lesch - Collins",
          "addressLine1": "69481 County Line Road",
          "addressLine2": "-",
          "city": "Edmond",
          "country": "AUT",
          "name": "Mabel Boyer",
          "postalCode": "61025"
        }
      },
      "imageID": 236,
      "position": {
        "labelX": 225,
        "labelY": 178,
        "page": 2
      },
      "positionType": "AppShoppingCartPosition",
      "productCode": 703,
      "voucherLayout": "ADDRESS_ZONE"
    }
  ],
  "shopOrderId": "TZ9m4qEikr",
  "total": 19337,
  "type": "AppShoppingCartPDFRequest"
}

Response Payload

{
  "link": "https://light-cope.com",
  "manifestLink": "https://fair-pear.name",
  "shoppingCart": {
    "shopOrderId": "N4TRgumgtZ",
    "voucherList": [
      {
        "trackId": "8ARQvkmho1B20PJ",
        "voucherId": "d87af693-be62-4140-8abd-85e466ea167b"
      },
      {
        "trackId": "BK6XuJyvT8gF3al",
        "voucherId": "7069ae62-1a43-427e-a58d-39141586e678"
      },
      {
        "trackId": "miMRfEJcumc91NK",
        "voucherId": "b0f09f11-b746-4d9f-a63a-5678c0d324ae"
      },
      {
        "trackId": "H7PVVjIRmkBNphy",
        "voucherId": "e5fbce14-1be9-41cb-a4ad-52d4a67d5f74"
      },
      {
        "trackId": "Lp7GMDSyde5kOQ0",
        "voucherId": "5202e485-cf64-4381-819a-f81c50f4262a"
      },
      {
        "trackId": "6y1rkzP0h5ePhaY",
        "voucherId": "daece01f-7c8f-4c94-9c77-e665e84182df"
      },
      {
        "trackId": "AFJ8SGlZD4KOaPe",
        "voucherId": "f8ba5c66-ee22-4e3b-b91a-bd3007c48945"
      },
      {
        "trackId": "QJkXtZUDlzt78OJ",
        "voucherId": "9349b57a-79fd-49cf-b51f-1ba6ae3d68f6"
      },
      {
        "trackId": "iyQ5iNDIVyZrfiQ",
        "voucherId": "5defc674-e69b-4b21-a21a-25f2a320de20"
      },
      {
        "trackId": "9HLO0F2MMJKnztm",
        "voucherId": "8945704d-fd19-466b-9769-8d974c42ec60"
      }
    ]
  },
  "type": "CheckoutResponse",
  "walletBallance": 91007
}

{
  "statusCode": "400",
  "title": "Bad Request",
  "detail": "Required request header 'Authorization' for method parameter type String is not present"
}

{
  "statusCode": "401",
  "title": "Unauthorized",
  "detail": "Unauthorized, user account is not valid, is locked, the provided authorization token is not valid or the application is not authorized by user."
}

{
  "statusCode": "403",
  "title": "Forbidden",
  "detail": "Forbidden, user has not enough privileges to perform this request."
}

{
  "statusCode": "429",
  "title": "Too Many Requests",
  "detail": "Too many requests sent, please try again later.)"
}

{
  "statusCode": "500",
  "title": "Internal Server Error",
  "detail": "Internal Server Error, details about the technical error are provided in the response body. Please contact support if the issue persists."
}

GET

/app/retoure

Retrieve retoure state for ordered items corresponding to shopRetoureId or retoureTransactionId

Query Parameter Name	Example
`shopRetoureId`	`sunt`
`retoureTransactionId`	`170132459`
`startDate`	`1924-10-18T01:14:40.0Z`
`endDate`	`1905-12-13T10:36:14.0Z`

Request Payload

Response Payload

{
  "RetrieveRetoureStateResponse": [
    {
      "retoureTransactionId": 15242129,
      "shopRetoureId": "17288644",
      "totalCount": 1,
      "countStillOpen": 0,
      "retourePrice": 95,
      "creationDate": "6102025-190339",
      "serialnumber": "AF188FFFFF",
      "refundedVouchers": [
        {
          "voucherId": "AF188FFFFF0000004F0B",
          "trackId": ""
        }
      ],
      "notRefundedVouchers": [
        {
          "voucherId": "AF188FFFFF0000005F0E",
          "trackId": "AF188FFFEE0000005F0E"
        }
      ]
    }
  ]
}

{
  "statusCode": "400",
  "title": "unknownShopOrderId",
  "detail": "Queued order duplicated for the shopOrderId '123123'"
}

{
  "statusCode": "401",
  "title": "Unauthorized",
  "detail": "Unauthorized, user account is not valid, is locked, the provided authorization token is not valid or the application is not authorized by user."
}

{
  "statusCode": "403",
  "title": "Forbidden",
  "detail": "Forbidden, user has not enough privileges to perform this request."
}

{
  "statusCode": "429",
  "title": "Too Many Requests",
  "detail": "Too many requests sent, please try again later.)"
}

{
  "statusCode": "500",
  "title": "Internal Server Error",
  "detail": "Internal Server Error, details about the technical error are provided in the response body. Please contact support if the issue persists."
}

POST

/app/retoure

Request retoure for ordered items corresponding to all items for shopOrderId or items with specific voucherId or trackId

Request Payload

{
  "shoppingCart": {
    "shopOrderId": "hY93XHIXDg",
    "voucherList": [
      {
        "trackId": "45p787AchDQJbfK",
        "voucherId": "55346a53-64e9-46cb-bd9f-209f4f9403ec"
      },
      {
        "trackId": "3HlVDgbXforztYO",
        "voucherId": "5ed83735-a3c8-443c-9dd6-d1fc6f47c4aa"
      },
      {
        "trackId": "SiHCVl5vgU9FbKS",
        "voucherId": "a0087135-c2c1-442e-8cd7-a23c9bce8afb"
      },
      {
        "trackId": "D1evFkCK7k90uyi",
        "voucherId": "458e555f-d99e-403f-9ad8-75d2d1484b34"
      },
      {
        "trackId": "8kQkL9aJQOqaais",
        "voucherId": "253a5ab3-88b1-4918-94ea-1ecd01126350"
      },
      {
        "trackId": "Kj8cmFqBYkvGTMx",
        "voucherId": "0bc45bbb-3efb-4800-9cba-e8d6e7fedcb2"
      },
      {
        "trackId": "wSl3ItZgkWRIWRH",
        "voucherId": "cd3e61f7-692b-4e7c-b82e-f255df0c8522"
      },
      {
        "trackId": "x6Y1BGNN8MbZ2zg",
        "voucherId": "778fab67-4e5a-4082-a8e0-270ca0dc0233"
      },
      {
        "trackId": "Rt4aJXsoQV5EEYL",
        "voucherId": "8a9be6de-3dc2-4291-9588-2c32b6f7f785"
      },
      {
        "trackId": "iUQtHjCFUVcRnN4",
        "voucherId": "eeeb1063-b1b6-4ca7-ba01-240045a3185a"
      }
    ]
  }
}

Response Payload

{
  "retoureTransactionId": "vSwmVv1cTKEi",
  "shopRetoureId": "hcSugwnm"
}

{
  "statusCode": "400",
  "title": "Bad Request",
  "detail": "Required request header 'Authorization' for method parameter type String is not present"
}

{
  "statusCode": "401",
  "title": "Unauthorized",
  "detail": "Unauthorized, user account is not valid, is locked, the provided authorization token is not valid or the application is not authorized by user."
}

{
  "statusCode": "403",
  "title": "Forbidden",
  "detail": "Forbidden, user has not enough privileges to perform this request."
}

{
  "statusCode": "429",
  "title": "Too Many Requests",
  "detail": "Too many requests sent, please try again later.)"
}

{
  "statusCode": "500",
  "title": "Internal Server Error",
  "detail": "Internal Server Error, details about the technical error are provided in the response body. Please contact support if the issue persists."
}

GET

/app/shoppingcart/{shopOrderId}

Retrieves a shopping cart.

Request Payload

Response Payload

{
  "type": "CheckoutShoppingCartAppResponse",
  "link": "https://pcf-next.tcb.deutschepost.de/PcfExtensionWeb/document?keyphase=3&data=GpyUVLv5OfMWrV0KlUyeqIusHgvB9sO7BZ5Sh9m%2FZnI%3D",
  "manifestLink": "",
  "shoppingCart": {
    "shopOrderId": "98276337",
    "voucherList": [
      {
        "voucherId": "A00123C0390000000138",
        "trackId": ""
      }
    ]
  },
  "walletBallance": 42355
}

{
  "statusCode": "400",
  "title": "invalidShopOrderID",
  "detail": "Queued order duplicated for the shopOrderId '123123'"
}

{
  "statusCode": "401",
  "title": "Unauthorized",
  "detail": "Unauthorized, user account is not valid, is locked, the provided authorization token is not valid or the application is not authorized by user."
}

{
  "statusCode": "403",
  "title": "Forbidden",
  "detail": "Forbidden, user has not enough privileges to perform this request."
}

{
  "statusCode": "404",
  "title": "Not Found",
  "detail": "Order not found: ORDERID12345"
}

{
  "statusCode": "429",
  "title": "Too Many Requests",
  "detail": "Too many requests sent, please try again later.)"
}

{
  "statusCode": "500",
  "title": "Internal Server Error",
  "detail": "Internal Server Error, details about the technical error are provided in the response body. Please contact support if the issue persists."
}

GET

/app/catalog

Retrieve catalogs.

Query Parameter Name	Example
`types`*	`["PUBLIC"]`

Request Payload

Response Payload

{
  "contractProducts": {
    "products": [
      {
        "price": 3985,
        "productCode": 164
      },
      {
        "price": 2015,
        "productCode": 725
      },
      {
        "price": 3822,
        "productCode": 680
      },
      {
        "price": 4985,
        "productCode": 313
      }
    ]
  },
  "pageFormats": [
    {
      "description": "Postcard format",
      "id": 4,
      "isAddressPossible": true,
      "isImagePossible": true,
      "name": "DIN A4 plain",
      "pageLayout": {
        "labelCount": {
          "labelX": 477,
          "labelY": 299
        },
        "labelSpacing": {
          "x": 49.7,
          "y": 26.6
        },
        "margin": {
          "bottom": 6.4,
          "left": 5.2,
          "right": 9.9,
          "top": 2.9
        },
        "orientation": "PORTRAIT",
        "size": {
          "x": 130.6,
          "y": 60.5
        }
      },
      "pageType": "LABELPAGE"
    },
    {
      "description": "Postcard format",
      "id": 1,
      "isAddressPossible": false,
      "isImagePossible": true,
      "name": "Letter C5",
      "pageLayout": {
        "labelCount": {
          "labelX": 440,
          "labelY": 418
        },
        "labelSpacing": {
          "x": 159.3,
          "y": 81.3
        },
        "margin": {
          "bottom": 9.9,
          "left": 5.8,
          "right": 2,
          "top": 7.8
        },
        "orientation": "PORTRAIT",
        "size": {
          "x": 62.5,
          "y": 125
        }
      },
      "pageType": "LABELPAGE"
    },
    {
      "description": "Postcard format",
      "id": 1,
      "isAddressPossible": true,
      "isImagePossible": true,
      "name": "A6 postcard",
      "pageLayout": {
        "labelCount": {
          "labelX": 56,
          "labelY": 307
        },
        "labelSpacing": {
          "x": 114.6,
          "y": 191.9
        },
        "margin": {
          "bottom": 10,
          "left": 10,
          "right": 5.1,
          "top": 1.9
        },
        "orientation": "LANDSCAPE",
        "size": {
          "x": 169.1,
          "y": 109.6
        }
      },
      "pageType": "LABELPAGE"
    },
    {
      "description": "Postcard format",
      "id": 5,
      "isAddressPossible": true,
      "isImagePossible": true,
      "name": "A6 postcard",
      "pageLayout": {
        "labelCount": {
          "labelX": 145,
          "labelY": 304
        },
        "labelSpacing": {
          "x": 98.1,
          "y": 70.2
        },
        "margin": {
          "bottom": 5.6,
          "left": 3.6,
          "right": 7.1,
          "top": 6.2
        },
        "orientation": "PORTRAIT",
        "size": {
          "x": 61.1,
          "y": 64
        }
      },
      "pageType": "REGULARPAGE"
    },
    {
      "description": "Postcard format",
      "id": 2,
      "isAddressPossible": false,
      "isImagePossible": true,
      "name": "Letter C5",
      "pageLayout": {
        "labelCount": {
          "labelX": 337,
          "labelY": 145
        },
        "labelSpacing": {
          "x": 134.6,
          "y": 72.2
        },
        "margin": {
          "bottom": 7.7,
          "left": 9,
          "right": 4.3,
          "top": 5.3
        },
        "orientation": "PORTRAIT",
        "size": {
          "x": 34.3,
          "y": 129.1
        }
      },
      "pageType": "ENVELOPE"
    }
  ],
  "privateCatalog": {
    "imageLink": [
      {
        "link": "https://rectangular-unibody.biz/",
        "linkThumbnail": "https://free-effector.org"
      },
      {
        "link": "https://responsible-desk.name/",
        "linkThumbnail": "https://ill-colonialism.info/"
      }
    ]
  },
  "publicCatalog": {
    "items": [
      {
        "category": "Nature",
        "categoryDescription": "Cute animals",
        "categoryId": 5,
        "images": [
          {
            "imageDescription": "Flower bouquet",
            "imageID": 102,
            "imageSlogan": "Love it",
            "links": {
              "link": "https://quick-creature.net",
              "linkThumbnail": "https://black-riser.com"
            }
          },
          {
            "imageDescription": "Funny kitten",
            "imageID": 7,
            "imageSlogan": "Pure nature",
            "links": {
              "link": "https://warmhearted-signature.biz/",
              "linkThumbnail": "https://sad-squid.info"
            }
          },
          {
            "imageDescription": "Flower bouquet",
            "imageID": 140,
            "imageSlogan": "Cutest ever",
            "links": {
              "link": "https://some-sprinkles.org/",
              "linkThumbnail": "https://ecstatic-birdcage.info"
            }
          }
        ]
      },
      {
        "category": "Animals",
        "categoryDescription": "Cute animals",
        "categoryId": 8,
        "images": [
          {
            "imageDescription": "Flower bouquet",
            "imageID": 310,
            "imageSlogan": "Pure nature",
            "links": {
              "link": "https://poor-reboot.info",
              "linkThumbnail": "https://icy-climb.biz"
            }
          }
        ]
      }
    ]
  }
}

{
  "statusCode": "400",
  "title": "Bad Request",
  "detail": "Required request header 'Authorization' for method parameter type String is not present"
}

{
  "statusCode": "401",
  "title": "Unauthorized",
  "detail": "Unauthorized, user account is not valid, is locked, the provided authorization token is not valid or the application is not authorized by user."
}

{
  "statusCode": "403",
  "title": "Forbidden",
  "detail": "Forbidden, user has not enough privileges to perform this request."
}

{
  "statusCode": "404",
  "title": "Not Found",
  "detail": "Catalog not found: CATALOG12345"
}

{
  "statusCode": "429",
  "title": "Too Many Requests",
  "detail": "Too many requests sent, please try again later.)"
}

{
  "statusCode": "500",
  "title": "Internal Server Error",
  "detail": "Internal Server Error, details about the technical error are provided in the response body. Please contact support if the issue persists."
}

UserResource(2 operations)

POST

/user

__This request is the precondition for almost all other calls!__ The call provides you with the Bearer token which is then used for all other calls. Here is how: The client makes a POST request to the 'user' resource by adding the following parameters using the application/x-www-form-urlencoded

Request Payload

{
  "client_id": "zxfhQL1Skdppc7RDhz5QlgYzKlNcnZZW",
  "client_secret": "N45RXlBGTGGJFqkI",
  "grant_type": "client_credentials",
  "password": "knhTsaNuqAKq",
  "username": "Earl_DuBuque47@gmail.com"
}

Response Payload

{
  "access_token": "BnN6L2SeyMjKcIMGhgaaUO6GNAIMBtdqmG7klJKbcIo=",
  "walletBalance": 2446814,
  "infoMessage": "",
  "token_type": "BearerToken",
  "expires_in": 3000,
  "issued_at": "Wed, 03 Apr 2024 08:37:17 GMT",
  "external_customer_id": "DHL-0123",
  "authenticated_user": "max.mustermann@deutschepost.de"
}

{
  "statusCode": "400",
  "title": "Bad Request",
  "detail": "Required request header 'Authorization' for method parameter type String is not present"
}

{
  "statusCode": "401",
  "title": "Unauthorized",
  "detail": "Unauthorized, user account is not valid, is locked, the provided authorization token is not valid or the application is not authorized by user."
}

{
  "statusCode": "429",
  "title": "Too Many Requests",
  "detail": "Too many requests sent, please try again later.)"
}

{
  "statusCode": "500",
  "title": "Internal Server Error",
  "detail": "Internal Server Error, details about the technical error are provided in the response body. Please contact support if the issue persists."
}

GET

/user/profile

The client retrieves certain settings about his user profile.

Request Payload

Response Payload

{
  "ekp": "6123456789",
  "company": "Deutsche Post AG - TCB",
  "title": "",
  "invoiceType": "ONLINE",
  "invoiceFrequency": "DAILY",
  "mail": "max.mustermann@deutschepost.de",
  "firstname": "Max",
  "lastname": "Mustermann",
  "street": "Hauptstrasse",
  "houseNo": "5",
  "zip": "33602",
  "city": "Teststadt",
  "country": "DEU",
  "phone": "01234567890122",
  "pobox": "4711",
  "poboxZip": "51119",
  "poboxCity": "Bonn"
}

{
  "statusCode": "400",
  "title": "Bad Request",
  "detail": "Required request header 'Authorization' for method parameter type String is not present"
}

{
  "statusCode": "401",
  "title": "Unauthorized",
  "detail": "Unauthorized, user account is not valid, is locked, the provided authorization token is not valid or the application is not authorized by user."
}

{
  "statusCode": "429",
  "title": "Too Many Requests",
  "detail": "Too many requests sent, please try again later.)"
}

{
  "statusCode": "500",
  "title": "Internal Server Error",
  "detail": "Internal Server Error, details about the technical error are provided in the response body. Please contact support if the issue persists."
}

Service Homepage: developer.dhl.com/api-reference/deutsche-post-internetmarke-post-parcel-germany#reference-docs-section

dhlpostageshippinglogisticsecommerce