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?
Implement the API call with the identified trigger and submit at least the three mandatory parameters custAddrZip, custAddrCountry und custGenderin the JSON body of a POST RESTful API call.
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 getLabel (1.0)
POST https://api.parceldealz.com/v1/label
custAddrZiprequired string non-empty |
Postal code of the end customer for whom the ParcelDealz label is created. Ex: "80337" |
custAddrCountryrequired string non-empty |
Country of the end customer for whom the ParcelDealz label is created. Ex: " Germany " |
custGenderrequired string non-empty |
Gender of the end customer for whom the ParcelDealz label is created. 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. Ex: "Mr." |
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:
Only the three parameters „custAddrZip“, „custAddrCountry“ and „custGender“ are required. Please make sure that this information is passed as string to avoid this error
In case of problems with authentication contact ParcelDealz
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",
"products":[
"SKU-123",
"SKU-456",
"SKU-789"
]
}'
