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.
Nr | Feld | Typ | Max.Länge | Bemerkung
|
---|
1 | Satzart | C | | Festwert DELIVERY_GET
| 2 | Lieferungsnummer | I | 8 | Optional. Falls angegeben wird nur die angegebene Lieferung zurückgegeben.
| 3 | Firma Nr | I | 8 | Interne Nummer der Firma, wie unter Verwaltung → Firma anzeigen und ändern
| 4 | Kunde Nr | I | 8 | Optional.
| 5 | Lieferdatum Von | D | 8 | Optional.
| 6 | Lieferdatum Bis | D | 8 | Optional.
| 7 | Nur ausgegebene | I | 8 | 1 = Es werden nur Lieferungen zurück gegeben, welche nach dem Anlegen oder Ändern schon gedruckt oder gesendet wurden.
| 8 | Rückgabe-Format | C | 20 | 0 oder nicht angegeben = CSV-Datei, 1 = ZIP-Datei mit den Lieferungen im PDF-Format und einer CSV-Datei result.csv.
| 9 | Nur geänderte | I | 8 | 1 = 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.
| 10 | Systemname | C | 20 | Name des externen Systems. Unter diesem Namen wird Datum und Uhrzeit der letzten Abfrage in Collmex gespeichert.
| 11 | Briefpapier nicht verwenden | I | 8 | 1 = Bei der Erzeugung der PDF-Dateien wird kein Briefpapier eingebunden.
| 12 | Kundenauftrag Nr | I | 8 | Optional. Nummer des Kundenauftrags, auf den sich die Lieferung bezieht.
| 13 | Versandart Nr | I | 8 | Optional. Nummer der Versandart.
| 14 | Als ausgegeben kennzeichnen | I | 8 | 1 = Die zurück gegebenen Lieferungen werden als ausgegeben gekennzeichnet und erscheinen in der Folge nicht mehr in der Sammelausgabe mit gesetztem Kennzeichen 'Ausgabe erforderlich'. Nutzen Sie diese Option, wenn Sie die Lieferungen extern ausgeben und eine Ausgabe in Collmex nicht mehr erforderlich ist.
|
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
|