ParcelDealz API

Q: 200 OK

RESPONSE SCHEMA: application/pdf object

Q: 422 Missing Required Information

Lediglich die drei Parameter “custAddrZip” , “custAddrCountry” und “custGender” sind required . Bitte stellen Sie sicher, dass diese Informationen als s tring übergeben werden, um diesen Fehler zu vermeiden

ParcelDealz API

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.

System & Trigger identifizieren

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?

Versandetiketten werden üblicherweise im letzten Schritt der Kommissionierung am Packplatz gedruckt. Der Trigger kann hier sein “Kommissionierung abgeschlossen”. Damit kann das Paket verschlossen werden und das Versandlabel kann gedruckt werden.

Da das ParcelDealz Label nicht aufgeklebt werden soll, sondern mit Trägerfolie dem Paket beigelegt werden soll, muss die Anfrage und der Druck des Labels früher erfolgen. Auch dafür gibt es bereits Trigger im jeweiligen Logistikprozess/System. Üblicherweise soll hierfür der Trigger “Bereitstellung des Rechnungsdrucks” verwendet werden. Wann immer im Prozess Rechnungen oder Lieferscheine beigelegt werden sollen, ist das Paket noch geöffnet und Warenbegleitpapiere können zugeführt werden. Orientieren Sie sich daher bei ParcelDealz am Rechnungsdruck ihres LVS/WMS.

Diese Abläufe sind in allen Lagern verschieden. Wir unterstützen Sie gerne dabei diese Abstimmung mit den richtigen Kollegen in ihrem Unternehmen durchzuführen.

API implementieren

Implementieren Sie den API Call mit dem identifizierten Trigger und übermitteln Sie mindestens die drei obligatorischen Parameter custAddrZip, custAddrCountry und custGender im JSON Body eines POST RESTful API Calls.

ParcelDealz stellt jedem interessierten Versender einen Endpoint für ein ausführliches Schnittstellentesting bereit.

Druckroutine konfigurieren

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 getLabel (1.0)

POST https://api.parceldealz.com/v1/label

custAddrZip

required

string non-empty

Postleitzahl des Endkunden, für den das ParcelDealz Label erstellt wird.

Bsp: “80337”

custAddrCountry

required

string non-empty

Land des Endkunden, für den das ParcelDealz Label erstellt wird.

Bsp: “Deutschland”

custGender

required

string 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: “Herr”

products

array 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:

200 OK

RESPONSE SCHEMA: application/pdf

object

422 Missing Required Information

Lediglich die drei Parameter “custAddrZip”, “custAddrCountry” und “custGender” sind required. Bitte stellen Sie sicher, dass diese Informationen als string übergeben werden, um diesen Fehler zu vermeiden

401 Unauthorized

Bei Problemen mit der Authentifizierung wenden Sie sich an ParcelDealz

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",
   "products":[
      "SKU-123",
      "SKU-456",
      "SKU-789"
   ]
}'

Beispiel Output

Dummy ParcelDealz Label Bitte beachten Sie, dass kein Targeting bei den Test-Calls stattfindet. Es wird inhaltlich immer das selbe Label ausgegeben. Dieser Test-Endpoint dient nur zum Testen des Workflows bei der Implementierung.