For your development team: Easily connect ParcelDealz via our API.
ParcelDealz is easiest to integrate via our API. Only a few pieces of information are required and this interface can be integrated into any LVS, ERP or merchandise management system.
Find out how shipping labels are generated and printed at your company. In most cases, the carriers are connected with their interfaces in the warehouse management system. As a rule, routines already exist here to request and print a label via API!
When should the ParcelDealz label be generated and printed?
Implementieren Sie den API Call mit dem identifizierten Trigger und übermitteln Sie mindestens die zwei obligatorischen Parameter custAddrZip und custAddrCountry im JSON Body eines POST RESTful API Calls.
ParcelDealz stellt jedem interessierten Versender einen Endpoint für ein ausführliches Schnittstellentesting bereit.
Actually all warehouse management systems are able to execute print commands for PDFs on respectively configured label printers and have existing routines for this purpose. Use these routines to print ParcelDealz labels on the existing printers.
API Documentation
Get personalized label
POST https://api.parceldealz.com/v1/label
custAddrZiprequired string non-empty |
Postleitzahl des Endkunden, für den das ParcelDealz Label erstellt wird. Ex: "80337" |
custAddrCountryrequired string non-empty |
Country of the end customer for whom the ParcelDealz label is created. Ex: " Germany " |
custGenderstring non-empty |
Geschlecht des Endkunden, für den das ParcelDealz Label erstellt wird. Preferably, the information should be transmitted in the following coding: "0" = male "1" = female "2" = unknown/unisex Other gender identifiers, such as from the salutation, are possible. Bsp: „2“ |
custNamestring non-empty |
Name des Endkunden, vorzugsweise nur der Vorname. Bsp: „Theodor“ |
custB2Bboolean |
Zur Identifizierung von B2B-Kunden Bsp: „true“ |
productsarray of strings |
Unique item numbers of the products purchased by the end customer. Ex: „0123479272552-2“ |
Authentication
Authorization: X-API-Key
Payload Example:
Content type: application/json
{
"custAddrZip":"12345",
"custAddrCountry":"Deutschland",
"custGender":"0",
"products":[
"SKU-123",
"SKU-456",
"SKU-789"
]
}
Responses:
Lediglich die zwei Parameter „custAddrZip“ und „custAddrCountry“ sind required. Bitte stellen Sie sicher, dass diese Informationen als string übergeben werden, um diesen Fehler zu vermeiden
In case of problems with authentication contact ParcelDealz
Zu viele Anfragen – dies passiert, wenn Versender über 5 Anfragen die Sekunde oder 200 Anfragen pro Minute senden.
Diese Response erhalten Sie, wenn wir kein Label generieren konnten. Ursache hierfür kann auch sein, dass es nicht ausreichend viele Kampagnen gibt. Bitte wenden Sie sich diesbezüglich an uns.
Example cURL
Sie möchten die ParcelDealz API unkompliziert testen? Dann nehmen Sie zu uns Kontakt auf und Sie erhalten einen API Key.
As a payload in the response you will receive the ParcelDealz label as a PDF.
curl --location --request POST https://test.parceldealz.com/v1/label \
--header 'Content-Type: application/json' \
--header 'x-api-key: XXXXXXXXXXXXXXXX' \
--output 'ParcelDealz_Sample_Label.pdf' \
--data-raw '{
"custAddrZip":"12345",
"custAddrCountry":"Deutschland",
"custGender":"0",
"custName":"Theodor",
"custB2B":"false",
"products":[
"SKU-123",
"SKU-456",
"SKU-789"
]
}'
