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 transmit at least the two mandatory parameters custAddrZip and custAddrCountry in the JSON body of a POST RESTful API call.
ParcelDealz provides every interested publisher an endpoint for extensive interface testing.
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 |
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 " |
custGenderstring 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. Bsp: „2“ |
custNamestring non-empty |
Name of the end customer, preferably only the first name. Bsp: „Theodor“ |
custB2Bboolean |
For the identification of B2B customers 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:
In case of problems with authentication contact ParcelDealz
No parcel insert can be provided for this requested parcel
Timeout if no response is received from the server after 5 seconds
Only the two parameters ‘custAddrZip’ and ‘custAddrCountry’ are required. Please ensure that this information is passed as a string to avoid this error
Too many requests - this happens when senders send more than 5 requests per second or 200 requests per minute.
You will receive this response if we were unable to generate a label. This may also be due to the fact that there are not enough campaigns. Please contact us in this regard.
Example cURL
You would like to test the ParcelDealz API in an uncomplicated way? Then contact us and you will receive an 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"
]
}'
