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 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.
ApiVersionResource
{
"amp": {
"env": "prod-eu",
"name": "pp-post-internetmarke",
"rev": "4",
"version": "5.3.8"
}
}AppResource(8 operations)
| Query Parameter Name | Example |
|---|---|
amount* | 234274977 |
{
"shopOrderId": "cNbejEklJT",
"walletBalance": 51795
}{
"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."
}{
"shopOrderId": "7k4gWAM7Ed"
}{
"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."
}| Query Parameter Name | Example |
|---|---|
validate | true |
directCheckout | true |
{
"dpi": "DPI203",
"imageID": 232,
"optimizePNG": true,
"productCode": 669,
"type": "AppShoppingCartPNGRequest",
"voucherLayout": "ADDRESS_ZONE"
}{
"link": "https://cute-outset.name/",
"manifestLink": "https://lone-mixture.name",
"shoppingCart": {
"shopOrderId": "uWjAUT6PK5",
"voucherList": [
{
"trackId": "QUwxtVaDKFQKv5O",
"voucherId": "eb0481f4-7ece-4714-b37b-d337c5eb7ec8"
},
{
"trackId": "bqTUlSHWxik3UEv",
"voucherId": "4f9ce5e2-2a6e-4457-9b14-f9e15fdc17c2"
},
{
"trackId": "OgoSJq2dhRLVFsP",
"voucherId": "a946f3c0-10db-4a9e-be1a-922dbf1d29ea"
},
{
"trackId": "EI0dQikVQPQHUaG",
"voucherId": "0e349c11-8794-441b-aa79-fb72c73e51df"
},
{
"trackId": "1hqtCnrCGr9WYSL",
"voucherId": "1b9b6d87-a739-4540-8072-b4418de438fd"
},
{
"trackId": "QHhqORuC8cBnOgt",
"voucherId": "c447312a-0b3b-4bad-bf1c-8a7914667aeb"
},
{
"trackId": "MjsMg4HgXUhprRq",
"voucherId": "4f985eea-d9ae-4722-9a40-27393547bf39"
},
{
"trackId": "sK8SJRV7sLEu9n4",
"voucherId": "86aecfe8-dd16-4ac5-806d-64816e277403"
},
{
"trackId": "2YRvGoDLFlxqrku",
"voucherId": "4a81cfbb-f579-45e4-a4c7-4beb231c06d4"
},
{
"trackId": "QuGo0vs6aph3xcB",
"voucherId": "6e5d2a6c-80dc-4031-9578-06c036a4c83d"
}
]
},
"type": "CheckoutResponse",
"walletBallance": 27576
}{
"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."
}| Query Parameter Name | Example |
|---|---|
validate | false |
directCheckout | false |
{
"createManifest": true,
"createShippingList": "0",
"dpi": "DPI203",
"pageFormatId": 5,
"positions": [
{
"address": {
"receiver": {
"additionalName": "Tremblay, Jacobi and Larkin",
"addressLine1": "9090 Kuvalis Corner",
"addressLine2": "^",
"city": "Janabury",
"country": "AUT",
"name": "Peter Reichert",
"postalCode": "20203"
},
"sender": {
"additionalName": "Lubowitz Group",
"addressLine1": "1333 Rath Light",
"addressLine2": "3rd Floor",
"city": "Martinaville",
"country": "DEU",
"name": "Erma Hilpert",
"postalCode": "20496"
}
},
"imageID": 479,
"position": {
"labelX": 237,
"labelY": 83,
"page": 10
},
"positionType": "AppShoppingCartPosition",
"productCode": 990,
"voucherLayout": "ADDRESS_ZONE"
},
{
"address": {
"receiver": {
"additionalName": "Lesch - Ernser",
"addressLine1": "398 University Avenue",
"addressLine2": "Apartment 4B",
"city": "Keithstead",
"country": "AUT",
"name": "Jimmie Aufderhar",
"postalCode": "18523"
},
"sender": {
"additionalName": "Kuhic LLC",
"addressLine1": "22031 Vida Loop",
"addressLine2": "=",
"city": "Calistaside",
"country": "DEU",
"name": "Paulette Fahey",
"postalCode": "60998"
}
},
"imageID": 199,
"position": {
"labelX": 29,
"labelY": 435,
"page": 2
},
"positionType": "AppShoppingCartPosition",
"productCode": 613,
"voucherLayout": "FRANKING_ZONE"
}
],
"shopOrderId": "588To5gTdv",
"total": 4701,
"type": "AppShoppingCartPDFRequest"
}{
"link": "https://low-gray.net/",
"manifestLink": "https://scientific-duffel.org/",
"shoppingCart": {
"shopOrderId": "BNNQO9DqR9",
"voucherList": [
{
"trackId": "oznLjqGlo8uOA3X",
"voucherId": "c54eb701-caf1-400d-949b-919f0e003e3e"
},
{
"trackId": "cwXfLLSoei13uv0",
"voucherId": "7ac97192-ee89-40e2-880b-685fa932de6b"
},
{
"trackId": "ajcnafmzdcMHrDV",
"voucherId": "38268dbe-909b-470b-a029-64f8265fba25"
},
{
"trackId": "AgfahnusXit9CKc",
"voucherId": "3ce293da-687f-433c-98f6-9add73df3c2b"
},
{
"trackId": "mc23kwpvwhIBFWF",
"voucherId": "00e02186-d995-4bb6-b640-22c768a6296b"
},
{
"trackId": "EGq0cMPtckHA91s",
"voucherId": "0ffb79ee-79fa-4b2a-b99a-f48602c2e117"
},
{
"trackId": "qgtzJesEZIMxS25",
"voucherId": "76e812ac-babf-4156-8fd3-e455ad359a59"
},
{
"trackId": "w0hBEKyTlB8E1Bt",
"voucherId": "79c59066-02a2-4838-9c8c-14a9ea7cc565"
},
{
"trackId": "10Faz20kpU3rMp6",
"voucherId": "3d122369-cb68-4646-929e-98eaaf9508b9"
},
{
"trackId": "mMWjnHKmV2bCdzi",
"voucherId": "cef0549a-c472-4daa-a356-991797d1aae6"
}
]
},
"type": "CheckoutResponse",
"walletBallance": 79247
}{
"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."
}| Query Parameter Name | Example |
|---|---|
shopRetoureId | cillum ad Duis et |
retoureTransactionId | -247380535 |
startDate | 1957-09-24T06:59:30.0Z |
endDate | 1906-11-14T21:15:13.0Z |
{
"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."
}{
"shoppingCart": {
"shopOrderId": "v9HVnfddEy",
"voucherList": [
{
"trackId": "LKIp3EX0Wzfm3xJ",
"voucherId": "945831e1-1e64-4ee6-aada-12fb72a79c89"
},
{
"trackId": "YvTCC8U4Q2FxnnY",
"voucherId": "34580d59-7b2c-4aeb-b640-fc719e5498c2"
},
{
"trackId": "PCJ3G5KHx6vZT9L",
"voucherId": "a598f9b5-51f2-4249-9fab-a6cbe9c2b5f3"
},
{
"trackId": "Lqv4bXaOCXxDdWE",
"voucherId": "01a427b1-4768-4bc1-a7b0-77815dcb2bbe"
},
{
"trackId": "i1GuDi5sxRyAr9q",
"voucherId": "f44f6b8e-fbdd-47ec-b997-173c5394bd12"
},
{
"trackId": "YBbXawt824sVFKr",
"voucherId": "ce534dea-6a8f-4ddc-a50d-cc1a78a2f39d"
},
{
"trackId": "W6AlDfVEX72dQMg",
"voucherId": "1fb4fdeb-bcf1-4898-b73b-ffd52b763561"
},
{
"trackId": "6g4MI3guv6ME3ND",
"voucherId": "1fa7fc73-739a-4fc6-be9d-96a6aebc7fcd"
},
{
"trackId": "1EnzHIMYF7vu5Dx",
"voucherId": "8291851c-f798-4bf2-ab79-2372d90c146d"
},
{
"trackId": "QnpLauaxZ8nmZB6",
"voucherId": "e0d0d27e-6cc5-4243-99ed-b91f15e553c7"
}
]
}
}{
"retoureTransactionId": "GwjEuDmnGNe3",
"shopRetoureId": "57wrr4Ev"
}{
"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."
}{
"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."
}| Query Parameter Name | Example |
|---|---|
types* | ["PUBLIC","PAGE_FORMATS","PUBLIC","PAGE_FORMATS","PAGE_FORMATS"] |
{
"contractProducts": {
"products": [
{
"price": 531,
"productCode": 476
},
{
"price": 1384,
"productCode": 761
}
]
},
"pageFormats": [
{
"description": "Standard printer paper",
"id": 2,
"isAddressPossible": true,
"isImagePossible": false,
"name": "Letter C5",
"pageLayout": {
"labelCount": {
"labelX": 419,
"labelY": 234
},
"labelSpacing": {
"x": 69.3,
"y": 197.8
},
"margin": {
"bottom": 1,
"left": 9.2,
"right": 7,
"top": 4.6
},
"orientation": "LANDSCAPE",
"size": {
"x": 156.7,
"y": 161
}
},
"pageType": "REGULARPAGE"
}
],
"privateCatalog": {
"imageLink": [
{
"link": "https://assured-place.net/",
"linkThumbnail": "https://made-up-yin.com/"
},
{
"link": "https://worldly-formamide.info/",
"linkThumbnail": "https://heartfelt-popularity.com/"
},
{
"link": "https://dependent-deck.net/",
"linkThumbnail": "https://portly-cruelty.org"
},
{
"link": "https://spiteful-rule.net",
"linkThumbnail": "https://best-knuckle.com"
}
]
},
"publicCatalog": {
"items": [
{
"category": "Abstract",
"categoryDescription": "Cute animals",
"categoryId": 10,
"images": [
{
"imageDescription": "Mountains",
"imageID": 83,
"imageSlogan": "Simple and clean",
"links": {
"link": "https://dazzling-stall.net",
"linkThumbnail": "https://arid-haircut.biz"
}
},
{
"imageDescription": "Minimalist shape",
"imageID": 231,
"imageSlogan": "Pure nature",
"links": {
"link": "https://white-airmail.com/",
"linkThumbnail": "https://shady-ribbon.com"
}
}
]
},
{
"category": "Animals",
"categoryDescription": "Cute animals",
"categoryId": 2,
"images": [
{
"imageDescription": "Sunset at sea",
"imageID": 316,
"imageSlogan": "Cutest ever",
"links": {
"link": "https://brisk-overheard.info/",
"linkThumbnail": "https://great-handful.org"
}
},
{
"imageDescription": "Minimalist shape",
"imageID": 1,
"imageSlogan": "Love it",
"links": {
"link": "https://evil-agreement.info",
"linkThumbnail": "https://dapper-reconsideration.org"
}
},
{
"imageDescription": "Sunset at sea",
"imageID": 443,
"imageSlogan": "Cutest ever",
"links": {
"link": "https://livid-stock.com",
"linkThumbnail": "https://steep-bourgeoisie.org"
}
},
{
"imageDescription": "Mountains",
"imageID": 234,
"imageSlogan": "Breathtaking",
"links": {
"link": "https://immaculate-tenant.info/",
"linkThumbnail": "https://filthy-goat.name/"
}
},
{
"imageDescription": "Minimalist shape",
"imageID": 489,
"imageSlogan": "Simple and clean",
"links": {
"link": "https://agitated-cuckoo.biz",
"linkThumbnail": "https://honored-puppet.name"
}
}
]
}
]
}
}{
"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)
{
"client_id": "0dtYhgXpPTlxo3DFVKacsZlhDG85aUfA",
"client_secret": "Vxcyg7owowPx8TUW",
"grant_type": "client_credentials",
"password": "aicLdWEY51ae",
"username": "Penelope_Abernathy98@yahoo.com"
}{
"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."
}{
"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."
}