For your development team: Simply integrate ParcelDealz via our API.
The easiest way to integrate ParcelDealz is via our API. Only a little information is required and this interface can be integrated into any WMS, ERP or merchandise management system.
Find out how your shipping labels are generated and printed. In most cases, the carriers are connected to their interfaces in the warehouse management system. Routines usually already exist here to request and print a label via API!
When should the ParcelDealz label be generated and printed?
Shipping labels are usually printed in the last step of picking at the packing station. The trigger here can be ‘’Order picking completed‘’. The parcel can then be sealed and the shipping label can be printed.
As the ParcelDealz label is not to be stuck on, but is to be attached to the parcel with a carrier film, the request and printing of the label must take place earlier. There are already triggers for this in the respective logistics process/system. The trigger ‘Provision of invoice printing’ should usually be used for this. Whenever invoices or delivery notes are to be enclosed in the process, the parcel is still open and accompanying documents can be added. You should therefore orientate ParcelDealz on the invoice printout of your WMS/WMS.
These processes are different in all warehouses. We will be happy to support you in coordinating this with the right colleagues in your company.
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 each interested publisher with an endpoint for detailed interface testing.
Actually all warehouse management systems are able to execute print commands for PDFs on configured label printers and have existing routines for this. Use these routines to print the ParcelDealz labels on the existing printers.
API Documentation
Get personalized label
POST https://api.parceldealz.com/v1/label
custAddrZiprequired string non-empty | Postcode of the customer for whom the ParcelDealz label is created. Bsp: “80337” |
custAddrCountryrequired string non-empty | Country of the customer for whom the ParcelDealz label is created. Bsp: “Germany” |
custGenderstring non-empty | Gender of the customer for whom the ParcelDealz label is created. The information should preferably be transmitted in the following coding: “0” = male “1” = female “2” = unknown/unisex Other gender identifiers, e.g. 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 article numbers of the products purchased by the end customer. Bsp: “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:
If you have problems with authentication, please 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 publishers 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
Would you like to test the ParcelDealz API in an uncomplicated way? Then get in touch with 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"
]
}'
