Für Ihr Development-Team: Binden Sie ParcelDealz ganz einfach über unsere API an.
ParcelDealz lässt sich am einfachsten über unsere API integrieren. Es sind nur wenige Informationen erforderlich und in jedes LVS, ERP oder jede Warenwirtschaft kann diese Schnittstelle integriert werden.
Bringen Sie in Erfahrung, wie Versandlabel bei Ihnen erzeugt und gedruckt werden. Zumeist sind die Carrier mit ihren Schnittstellen im Lagerverwaltungssystem angebunden. Hier bestehen in der Regel schon Routinen um via API ein Label anzufordern und zu drucken!
Wann soll das ParcelDealz Label erzeugt und gedruckt werden?
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.
Eigentlich alle Lagerverwaltungssysteme sind in der Lage Druckbefehle für PDFs auf jeweils konfigurierten Labeldruckern auszuführen und haben dafür bestehende Routinen. Benutzen Sie diese Routinen, um die ParcelDealz Label auf den bestehenden Druckern zu drucken.
API Dokumentation
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. Bsp: „80337“ |
custAddrCountryrequired string non-empty |
Land des Endkunden, für den das ParcelDealz Label erstellt wird. Bsp: „Deutschland“ |
custGenderstring non-empty |
Geschlecht des Endkunden, für den das ParcelDealz Label erstellt wird. Bevorzugt sollte die Information in folgender Kodierung übermittelt werden: „0“ = männlich „1“ = weiblich „2“ = unbekannt/unisex Anderen Geschlechtskennungen, wie bspw. aus der Anrede, sind möglich. 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 |
Eindeutige Artikelnummern der vom Endkunden gekauften Produkte. 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:
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
Bei Problemen mit der Authentifizierung wenden Sie sich an 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.
Beispiel cURL
Sie möchten die ParcelDealz API unkompliziert testen? Dann nehmen Sie zu uns Kontakt auf und Sie erhalten einen API Key.
Als Payload in der Response erhalten Sie das ParcelDealz Label als 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"
]
}'
