Shipping API Integration: Technical Quickstart for Developers
A shipping API integration connects your system directly to parcel service providers via a REST interface or middleware, providing immediate access to label creation, tracking, and returns processing. For most medium to large retailers, a multi-carrier platform is recommended instead of a single direct connection because it consolidates authentication, versioning, and billing in one location.
Three steps to get started:
- Create a business customer account and API access with the chosen carrier or middleware.
- Activate the sandbox environment and enter test data.
- Send the first label request via a test endpoint and check the response.
Key insights
A functioning shipping API integration requires sandbox testing, OAuth2 authentication, webhooks instead of polling, and a conscious decision between direct connection and middleware.
| Theme | Details |
|---|---|
| First test | Set up sandbox access and test tokens before each production connection. |
| Authentication | Use OAuth2 instead of Basic Auth for new integrations. |
| Status updates | Use webhooks instead of polling to reduce latency and API load. |
| Carrier choice | Check volume thresholds and contract conditions before connecting. |
| Implementation option | Paket International combines multiple carriers and customs processes into one interface. |
Table of Contents
- What technical capabilities does a shipping API offer?
- Which functions determine the integration effort?
- Which parcel delivery services can be connected via API?
- How do you get your first record label inquiry in 60 minutes?
- What security and data protection requirements apply?
- Direct carrier connection or middleware: Which is a better fit?
- What best practices ensure smooth operations in everyday life?
- How does Paket International simplify the technical connection?
- Why is the International package a worthwhile implementation option?
- Where can developers find further documentation?
- Sources
What technical capabilities does a shipping API offer?
A shipping API provides endpoints for the key steps in the shipping process: label creation, tracking, returns, pickup registration, shipping cost calculation, address validation, and customs documentation. Most providers rely on REST with JSON payloads, documented via OpenAPI or Swagger. The E-POSTBUSINESS API, for example, uses precisely this pattern for automated mail processing with bulk mailings.
A typical label request looks something like this in simplified terms:
POST /orders
{
"shipper": {...},
"receiver": {...},
"weight": 2.5,
"product": "V01PAK"
}
The process consists of three steps:
- Validate addresses and package data.
- Send order object via POST.
- Retrieve and print the label URL from the response.
Pro tip: Test each new API version against a sample payload from the official documentation before adding your own fields.
Key endpoints like /orders, /labels, and /manifests form the backbone of almost every carrier API. The manifest step at the end of the day is one of the... most common sources of error in production operation.
Which functions determine the integration effort?
Not every API is equally complex to integrate. Several technical details are crucial and directly influence the effort required:
- Authentication method: OAuth2 saves migration work in the long run compared to Basic Auth.
- Sandbox environment with realistic test data and its own endpoint.
- Rate limits and their documentation to avoid throttling in batch operation.
- Idempotence key for POST requests to prevent duplicate label creation.
- Webhooks for status and tracking updates instead of polling.
- Supported label formats (PDF, ZPL) and returns flow as a separate endpoint.
- Customs and export document APIs for international shipments.
SDKs and pre-built code examples often shorten the initial implementation by several days. It's also worth taking a look at service level agreements and support channels before making a decision, because a provider without reliable response times quickly becomes a risk in case of a problem.
Pro tip: Do not evaluate the documentation by its length, but by whether it contains complete, working sample queries, not just field lists.
Which parcel delivery services can be connected via API?
For the German market, DHL, Deutsche Post, DPD, Hermes, and GLS are the main options nationally, while UPS, FedEx, and DB Schenker supplement the coverage internationally. Each carrier has its own requirements: contract terms, billing numbers, and sometimes fixed volume thresholds.
The DHL Parcel DE Shipping API, for example, is typically aimed at business customers with more than 200 shipments per year and requires a business customer contract including access to the business customer portal. Those below this threshold, or who want to connect multiple carriers simultaneously, almost automatically end up using a central platform.
To be clarified before concluding the contract:
- Which sender and return addresses need to be configured?
- What bank details are required for cash on delivery or additional services?
- Is there a minimum shipment quantity per month or year?
How do you get your first record label inquiry in 60 minutes?
A first working request can often be implemented in under an hour if the correct sequence is followed.
- Conclude a business customer contract and receive access data for the portal.
- Enable sandbox access, usually via a separate endpoint such as
api-sandbox.dhl.com. - Generate API tokens or OAuth2 client credentials.
- Send a test request via Postman Collection or CLI tool.
- First
POST /orders-Submit a request with test data. - Retrieve the label from the response and check it visually.
- Simulate the manifest process (end-of-day closing) before going live.
Typical stumbling blocks on the first attempt:
- 401 error: Token expired or incorrect scope.
- Error 422: Required field missing or incorrect format in address data.
- Empty label URL: Manifest not yet triggered.
Pro tip: Create a Postman collection with all test cases and have it run automatically against the sandbox with every API update; this saves a lot of time during version changes.
| Approach | First test possible after |
|---|---|
| Direct Carrier API | usually 1 to 3 days (after contract approval) |
| Middleware platform | often within hours |
What security and data protection requirements apply?
OAuth2 is now considered the standard for new integrations, and DHL explicitly recommends it over the older Basic Auth variant. API keys remain common for simpler connections but should be rotated regularly.
Several fixed points apply to the GDPR-compliant processing of recipient data:
- Store personal data only for as long as required for the shipping process.
- Maintain access logs (audit logs) for every change to shipment data.
- TLS encryption for all API connections without exception.
- Role and scope management ensures that not every system has access to all endpoints.
Pro tip: Document deletion periods for tracking data contractually with the carrier, not just internally; this prevents disputes during audits.
Webhooks not only reduce server load, they They also reduce latency. compared to repeated polling for status changes, an aspect that is increasingly being assessed in security audits.
Direct carrier connection or middleware: Which is a better fit?
A direct connection to a single carrier provides full control over its specialized functions and can offer better rates for high volumes. The price: Each addition of another parcel service means another set of authentication, versioning, and billing logic.
Middleware consolidates all of this into a single interface. Instead of maintaining five carrier integrations, you communicate with one system that handles the translation.
Without middleware, authentication processes, versioning, and billing management multiply with each additional carrier, an effort that is often underestimated in direct connections.
Key trade-offs at a glance:
- Direct connection: more control, but repeated effort per carrier.
- Middleware: a central platform, but dependence on their feature set.
- With middleware, SLA risk shifts to a single provider, which changes negotiating power in the event of failures.
Pro tip: Calculate the TCO over three years, not just the first year of integration; maintenance costs per carrier add up faster than expected with direct connections.
What best practices ensure smooth operations in everyday life?
A strictly separated sandbox and production environment prevents test orders from generating actual label fees. Postman collections with automated tests should run with every deployment, not just the initial rollout.
- Use webhooks instead of polling for tracking and manifest status.
- Idempotency keys at every
POST /ordersSubmit a request to avoid duplicate labels. - Implement retry strategies with exponential backoff instead of immediate retry.
- Implement signature verification and replay protection for incoming webhook events.
- Maintain an SLA dashboard with error rate, uptime, and label errors per carrier.
Monitoring pays off especially at the end of the day: The manifest step remains one of the most frequent sources of error, which is why it should be treated as an independent, monitored job rather than as a side effect of the last order of the day.
How does Paket International simplify the technical connection?
Paket International combines multi-carrier access, automated customs documentation, and real-time tracking behind a single interface. Instead of connecting DHL, DPD, UPS, and FedEx separately, one system accesses all of them, including transparent cost calculation before label printing.
The onboarding process follows a clear pattern:
- Set up access to the sandbox environment.
- Generate test labels using real carrier formats.
- Activate the production account and connect existing order processes.
- Migrate existing shipment data without interrupting ongoing shipping.
Trust signals such as ISO 27001 alignment, GDPR-compliant data processing, SDKs and documented sample SLAs further facilitate internal approval by security and compliance teams.
Why is the International package a worthwhile implementation option?
Instead of maintaining a new direct connection for each additional carrier, Paket International covers DHL, UPS, FedEx, DPD and DB Schenker via a single API, including automatic customs clearance without manual forms.
This saves time, especially with international shipments: customs documents, pro forma invoices Landed cost calculation runs in the same process as label creation, not as a separate step afterward. Those who already have individual carriers directly connected can gradually migrate their existing logic to the central multi-carrier shipping software without interrupting ongoing shipments. For goods with special requirements, such as... Electronics or FurnitureThe platform also provides suitable shipping profiles directly.
The next step: Request sandbox access, generate test labels and run the existing ordering process against the Paket International API before the production switchover begins.
Where can developers find further documentation?
- DHL Parcel DE Shipping API: Reference for endpoints, sandbox and auth migration.
- Group API Developer Portal: A collection of Shipping, Returns and Tracking APIs with a test environment.
- E-POSTBUSINESS API: Reference for automated mail dispatch via REST/Swagger.
- Webhooks vs. API Polling: A comparison of architectural patterns for status updates.