The INTERNETMARKE is the online-postage for mail products of Deutsche Post AG.
Best for:
Creation, purchase and payment of the following mail products:
- postcards and letter mails domestic (with additional services Registered Mail and Registered Mail with Return Slip)
- postcards and letter mails international (with additional service Registered Mail)
- domestic shipments of small goods
The Deutsche Post INTERNETMARKE API enables the online purchase of INTERNETMARKEN with an individual postage cash account (Portokasse) to the end customer.
Integrate the INTERNETMARKE into your own shop management systems. Frank all your shipments promptly, quickly and directly from your own application.
Your advantages in overview:
- Fast shipping directly from your system
- Easy integration of the interface
- Adaptability of the system to your needs
- Printing via your label printer
In the following chapters we offer you:
- An Overview of the technical API functions
- The technical documentation of the API
- Open API Specification in Reference Docs
- Postman Testsuite in Downloads
- Explanations on using the API with a postage cash account (Portokasse)
- Contact information for further support in chapter Additional Information
- You can obtain information on products and prices by optionally integrating the API Product Web Service (ProdWS)
Scope
The Deutsche Post INTERNETMARKE API offers resources for:
- Usermanagement / cash assigned payment (Portokasse) management
- Internetmarken generation, purchase and reimbursement, and
- the retrieval of print formats, usable graphic motifs and user-specific information.
Note:
When implementing the INTERNETMARKEN API, it makes sense to also integrate the ProductWebService (ProdWS) - this ensures the latest information on products and prices being always available without any further effort.
Using the API
The Deutsche Post INTERNETMARKE API covers:
The AppResource provides functionalities for the purchase and management of INTERNETMARKEN:
- Creation of Internet stamps for single or multiple shipments
- Provision of franking marks as PDF file or PNG graphics (in ZIP file)
- Automatic debiting of transaction costs from the assigned postage cash account
- Providing previews of the franking mark as a PDF or PNG document
- Retrieval of information by using additional services (such as registered mail) for the purpose of creating a posting receipt or using a dispatch list
- Direct top-up of the (previously authenticated) postage cash account via direct debit ( in case of a valid SEPA mandate)
- Retrieval of public and user-specific graphic motifs, contract products and individual prices
- Refund of purchased but unused Internet stamps.
The UserResource enables
- Authorization by using a valid postage cash account (Portokosse)
- Creation of a bearer token for authentication when using subsequent resource paths
- Display of the current credit balance
- Calling up the respective user profile
Note:
Direct top-up of the of postage cash account via the INTERNETMARKEN API is only possible if direct debit data is registered and a currently valid direct debit mandate is available.
The use of an alternative payment method for loading postage cash account (PayPal) is only possible manually via the web interface https://portokasse.deutschepost.de/portokasse/#!/.
The ApiVersionResource is used for
- Request information about the API
- Health check to verify the availability of the web service.
Note:
We recommend implementing and using the health check resource to prevent errors in case the API is not available.
The following table creates transparency about the deprecation dates of previous API versions. To clarify the terms, please see the explanations below.
| API Version | Status | Deprecation Date | Sunset Date |
|---|---|---|---|
| INTERNETMARKE (SOAP) | Deprecated | 01.08.2024 | 31.12.2025 |
| INTERNETMARKE (REST) | Active |
Terms and conditions:
Status "Active": Using this API Version is recommended.
Status "Superseded": The API has been replaced by a new API Version. The API is still supported without limitation. It is recommended to switch to the "Active" API Version.
Status: "Deprecated": The service has been ended (with or without a replacement becoming available). Support for this service is limited to bug fixes only.
Status: "Retired": The API is no longer available since sunset date.
"Deprecation Date": From this date on, the API will be in status "Deprecated". Further development will be only based on security updates and bug fixing.
"Sunset Date": The API is no longer available from this date on.
To support your software development in the best possible way, we offer you our Postman test suite for download here
You can obtain the well-known API tool Postman itself here: Postman API Platform | Sign Up for Free
To use the Postman Collection, please fulfill the following steps:
- The usage requires access to Deutsche Post INTERNETMARKE API that can be requested here
- Import collection into postman (see official documentation from postman learning platform)
- Fill in the Postman environment with your customer-specific data (credentials from developer portal, customer-specific (test-) postage cash account).
Note:
The Postman Collection is not a product component of the Deutsche Post INTERNETMARKE API, but is intended to support you.
We would be pleased to receive feedback (errors, suggestions for improvement, etc.).
To use the Deutsche Post INTERNETMARKE API, you need a postage cash Account ('Portokasse'). We offer you the option of permanently converting a self-registered Portokasse to an unbilled ‘developer postage cash account/Entwickler-Portokasse'.
This Portokasse is for development purposes only and may not be used productively!
Register a new Portokasse in the Portokasse web frontend
Be sure to use a real email address so that you can send and receive messages.
Please do not top up or use this Portokasse for internet stamp creation before the conversion!
To request the conversion, please send an email to it-csp@deutschepost.de
Be sure to provide us with the ID of the portokasse to be converted (visible after successfully registering/logging in to your postage account and the registered email address.
Once the conversion has been completed, you will receive a confirmation email.
Your new Entwickler-Portokasse will be usable immediately in the API then. You can top up to €1,000 (at a time) via the ‘Interne Aufladung (Internal top-Up)’ function in the web frontend.
Remember to approve your business application once in every used Portokasse (productive and developer Portokasse), to be done in the frontend under ‘Meine Daten (My data) -> Geschäftsanwendungen (Business applications)’.
When you use a Portokasse for the first time (token retrieval!), you will receive a corresponding message at your Portokasse email address, additionally you will continue getting a "401" error until approval.
Questions about API availability?
Visit our IT-Portal for up-to-date information on IT service incidents, planned maintenance windows, and general availability. You can also opt-in for push notifications to receive proactive updates.
Questions about API content or functionality?
Use the “Notify” feature on this page to automatically receive updates about functional changes and enhancements to this API. You can also view our most recent announcements under the “Notifications” section at the bottom of this page.
Technical Support & Assistance
For further help, please visit our IT-Portal. There you can open a support ticket and receive direct assistance from DHL Support. To help us resolve your issue quickly, please describe your request in as much detail as possible and include traceable excerpts of your web service communication.
Customer Integration Services (CIS)
Business hours: Monday to Friday, 8 a.m. to 16 p.m.
ProdWS is an additional interface (SOAP API) that allows you to easily retrieve the available or usable product codes with the Internetmarke.
Access to ProdWS can be activated at any time on request.
Note:
If the ProdWS is activated but the products are not retrieved, the service ProdWS will inform you about new products several times a day by e-mail.
If you have decided to use the ProdWS, please inform us in a separate e-mail to pcf-1click@deutschepost.de. Afterwards you will get further instructions and information on using the ProdWS.
Release 1.30
Purely editorial adjustments in descriptions of ,e.g, resource paths, attributes, and examples.
Release 1.29
Professionally
- Introduction of a developer postage cash account to replace the previous test postage account
- Currently valid test postage cash account remain valid until their expiry date
Technically
- Stamps generated with the developer postage cash account contain a ‘sample/Muster’ watermark
Release 1.28
- One-time registration für new REST based application in every postage cash account is necessary. A notification email is sent to the registered email address of the Portokasse with the first use.
- See also section “Explanations on using the API with a postage cash account (Portokasse)”
Release 1.27
- The CashOnDelivery object has been set to deprecated: It can no longer be used due to the discontinuation of the cash on delivery letter service.
- Adjustment of the AppShoppingCartPosition object: Removal of the additionalInfo element due to lack of meaning.
Release 1.26
Documentation Error Fix
Change: The parameter for finalizing shopping carts is "directCheckout".
Details: In the specificaion and documentation, this parameter was previously incorrectly referred to as "finalize". This error has now been corrected, and the documentation now correctly uses the parameter "directCheckout".
Example: https://api-eu.dhl.com/post/de/shipping/im/v1/app/shoppingcart/pdf?directCheckout=true
Notifications
Deutsche Post INTERNETMARKE (Post & Parcel Germany)
There have been content updates on the API Page Deutsche Post INTERNETMARKE (Post & Parcel Germany).
You can have a detailed look at the changes by clicking the following link: Click here
Sincerely,
Your DHL API Developer Portal Team
You are receiving this message because you have subscribed to notifications on the DHL API Developer Portal. If you want to unsubscribe from notifications click here: Cancel Subscription
Deutsche Post INTERNETMARKE (Post & Parcel Germany)
There have been content updates on the API Page Deutsche Post INTERNETMARKE (Post & Parcel Germany).
You can have a detailed look at the changes by clicking the following link: Click here
Sincerely,
Your DHL API Developer Portal Team
You are receiving this message because you have subscribed to notifications on the DHL API Developer Portal. If you want to unsubscribe from notifications click here: Cancel Subscription