Collmex API: Lieferungen abfragen

Die Abfrage von Lieferungen erfolgt über die Satzart DELIVERY_GET. Die Abfrage ist insbesondere dafür gedacht, die Lieferungen in einem eigenen Format an den Kunden zu übermitteln oder an einen Fulfillment-Dienstleister weiter zu geben. Dazu werden die neu angelegten oder geänderten Lieferungen periodisch (z.B. einmal am Tag) abgefragt und extern weiter verarbeitet.

NrFeldTypMax.LängeBemerkung
1SatzartC Festwert DELIVERY_GET
2LieferungsnummerI8Optional. Falls angegeben wird nur die angegebene Lieferung zurückgegeben.
3Firma NrI8Interne Nummer der Firma, wie unter Verwaltung → Firma anzeigen und ändern
4Kunde NrI8Optional.
5Lieferdatum VonD8Optional.
6Lieferdatum BisD8Optional.
7Nur ausgegebeneI81 = Es werden nur Lieferungen zurück gegeben, welche nach dem Anlegen oder Ändern schon gedruckt oder gesendet wurden.
8Rückgabe-FormatC200 oder nicht angegeben = CSV-Datei, 1 = ZIP-Datei mit den Lieferungen im PDF-Format und einer CSV-Datei result.csv.
9Nur geänderteI81 = Es werden nur Lieferungen zurückgegeben, die sich seit der letzten DELIVERY_GET-Abfrage des im nächsten Feld angegebenen Systems geändert haben oder neu angelegt wurden.
10SystemnameC20Name des externen Systems. Unter diesem Namen wird Datum und Uhrzeit der letzten Abfrage in Collmex gespeichert.
11Briefpapier nicht verwendenI81 = Bei der Erzeugung der PDF-Dateien wird kein Briefpapier eingebunden.
12Kundenauftrag NrI8Optional. Nummer des Kundenauftrags, auf den sich die Lieferung bezieht.
13Versandart NrI8Optional. Nummer der Versandart.

Das Ergebnis der Abfrage ist für jede Lieferung ein Satz der Satzart CMXDLV. Falls als Rückgabe-Format '1' gewählt wurde, gibt Collmex eine ZIP-Datei zurück. In dieser ZIP-Datei ist jede Lieferung im PDF-Format enthalten. Der Dateiname ist 'DeliveryXXXX.pdf', wobei XXXX die Lieferungsnummer ist. In der ZIP-Datei sind zusätzlich die Lieferungen in der CSV-Datei result.csv im Format CMXDLV enthalten.

Siehe auch: Collmex API Inhalt