Registrieren Anmelden

Barcode-Sammel-API

Verwaltung von Sammellisten — Abrufen, Erstellen, Ändern, Abschließen und Statusänderung von Wareneingangs- und Warenausgangssammlungen

Endpunkte

Authentifizierung

Für jede API-Anfrage muss der X-API-KEY-Header gesendet werden.

X-API-KEY: {ihr_api_schluessel}

Haben Sie noch Fragen?

Schreiben Sie uns ein Ticket oder durchsuchen Sie unser Hilfe-Center.

Wenn es Ihnen gefallen hat, teilen Sie es mit anderen

Basis-URL

https://{tenant}.logzi.com/api/collect/

Jede Anfrage liefert eine JSON-Antwort zurück. Bei erfolgreicher Antwort ist result.code == 1, im Fehlerfall result.code == 0.

GET /api/collect/get

Abrufen einer einzelnen Sammelliste anhand der ID, mit vollständigen Details (Positionen, Seriennummern, Lagerplätze, Projekt).

Query-Parameter

Parameter Typ Pflicht Beschreibung
id int Eindeutige ID der Sammelliste

Beispielanfrage

GET /api/collect/get?id=101
X-API-KEY: {ihr_api_schluessel}

Beispielantwort

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "id": 101,
    "identify": "COL-2024-0101",
    "date_create": "2024-05-01 10:00:00",
    "date_update": "2024-05-01 11:30:00",
    "receipt_type_id": 34,
    "status_id": 1,
    "company_id": 1,
    "company_user_id": 3,
    "pallet_based": 0,
    "order_out_identify": "OR-2024-0055",
    "comment_top": "",
    "comment_bottom": "",
    "item": [
      {
        "id": 201,
        "partnumber": "PROD-001",
        "quantity": 5,
        "price": 3000,
        "store_id": 1,
        "store_locality_id": 12,
        "pallet_id": null,
        "checked": 0,
        "status_id": 1
      }
    ]
  }
}
GET /api/collect/list

Paginierbares Abrufen der Liste der Sammellisten mit Filtermöglichkeiten.

Query-Parameter

Parameter Typ Pflicht Beschreibung
list_offset int Paginierungs-Offset (Standard: 0)
list_count int Anzahl der Datensätze pro Seite
list_sort[field] string Name des Sortierfelds
list_sort[sort] string Sortierrichtung: ASC oder DESC
list_condition[identify] string Filter nach Kennung (LIKE)
list_condition[status_id] int Filter nach Status
list_condition[receipt_type_id] int Filter nach Sammlungstyp (32=Wareneingang, 34=Warenausgang)
list_condition[company_user_id] int Filter nach zuständigem Mitarbeiter
list_condition[date_create_from] date Erstellungsdatum — von (YYYY-MM-DD)
list_condition[date_create_to] date Erstellungsdatum — bis (YYYY-MM-DD)
list_condition[partnumber] string Filter nach Artikelnummer (LIKE)
list_condition[order_out_identify] string Filter nach Kennung der Ausgangsbestellung
list_condition[pallet_barcode] string Filter nach Palettenbarcode
list_condition[store_locality_barcode] string Filter nach Lagerplatz-Barcode

Beispielanfrage

GET /api/collect/list?list_offset=0&list_condition[receipt_type_id]=34&list_condition[status_id]=1
X-API-KEY: {ihr_api_schluessel}

Beispielantwort

{
  "result": { "code": 1, "message": "success" },
  "data": [
    {
      "id": 101,
      "identify": "COL-2024-0101",
      "date_create": "2024-05-01 10:00:00",
      "receipt_type_id": 34,
      "status_id": 1,
      "status_name": "Nyitott",
      "company_user_id": 3
    }
  ],
  "params": {
    "list_count": 20,
    "list_offset": 0,
    "list_all": 134
  }
}
POST /api/collect/save

Erstellen oder Ändern einer Sammelliste. Für eine neue Sammlung data[id] = 0 verwenden, für eine Änderung die vorhandene ID angeben.

POST-Felder — data-Objekt

Feld Typ Pflicht Beschreibung
id int 0 = neue Sammelliste, >0 = Änderung
receipt_type_id int Sammlungstyp: 32 = Wareneingang, 34 = Warenausgang
company_id int Kennung des Unternehmens
company_user_id int ID des zuständigen Mitarbeiters
company_address_id int ID des Unternehmensstandorts
pallet_based int 1 = palettenbasierte Sammlung (für jede Position ist pallet_id erforderlich)
order_out_identify string Referenznummer der Ausgangsbestellung
order_in_identify string Referenznummer der Eingangsbestellung
invoice_in_identify string Referenznummer der Eingangsrechnung
delivery_note_in_identify string Referenznummer des Eingangslieferscheins
jobnumber_id int ID der Auftragsnummer
departmentnumber_id int ID der Abteilungsnummer
comment_top string Kommentar (öffentlich)
comment_bottom string Interner Kommentar
item array Array der Positionen (siehe unten)

Positionsfelder — data[item][]

Feld Typ Pflicht Beschreibung
id int 0 = neue Position, >0 = Änderung einer vorhandenen
partnumber string Artikelnummer des Produkts
quantity float Gesammelte Menge
price float Einzelpreis (wird bei leerem Feld anhand der Preisliste ausgefüllt)
store_id int Lager-ID
store_locality_id int Lagerplatz-ID
pallet_id int Paletten-ID
checked int 1 = Position geprüft/gescannt
comment_top string Positionskommentar
serialnumber array Array der Seriennummern (siehe unten)
remove int 1 = Position beim Ändern löschen

Seriennummernfelder — data[item][][serialnumber][]

Feld Typ Pflicht Beschreibung
val string Wert der Seriennummer
expire date Ablaufdatum (YYYY-MM-DD)
qty float Menge für diese Seriennummer

POST-Felder — params-Objekt (optional)

Feld Typ Pflicht Beschreibung
close int 1 = automatischer Abschluss nach dem Speichern
status_change int Automatische Statusänderung auf den angegebenen Status nach dem Speichern

Beispielanfrage

POST /api/collect/save
X-API-KEY: {ihr_api_schluessel}
Content-Type: application/json

{
  "data": {
    "id": 0,
    "receipt_type_id": 34,
    "company_id": 1,
    "company_user_id": 3,
    "order_out_identify": "OR-2024-0055",
    "comment_bottom": "Sürgős kiszedés",
    "item": [
      {
        "partnumber": "PROD-001",
        "quantity": 5,
        "store_id": 1,
        "store_locality_id": 12,
        "checked": 1
      }
    ]
  },
  "params": {
    "close": 0
  }
}

Beispielantwort

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "id": 102,
    "identify": "COL-2024-0102",
    "item": {
      "1": {
        "id": 205,
        "partnumber": "PROD-001"
      }
    }
  }
}
POST /api/collect/delete

Löschen einer Sammelliste. Löschbare Status: offen (1), abgeschlossen (2) sowie die verschiedenen Status während der Bearbeitung (15, 16, 31–36).

POST-Felder — data-Objekt

Feld Typ Pflicht Beschreibung
receipt_id int ID der zu löschenden Sammelliste

Beispielanfrage

POST /api/collect/delete
X-API-KEY: {ihr_api_schluessel}
Content-Type: application/json

{
  "data": {
    "receipt_id": 101
  }
}

Beispielantwort

{
  "result": { "code": 1, "message": "success" },
  "data": {}
}
POST /api/collect/close

Abschließen einer offenen Sammelliste. Der Abschluss führt eine Lagerbewegung durch und validiert die Menge der Positionen. Nur eine Sammlung mit status_id = 1 (offen) kann abgeschlossen werden.

POST-Felder — data-Objekt

Feld Typ Pflicht Beschreibung
receipt_id int ID der abzuschließenden Sammelliste

Beispielanfrage

POST /api/collect/close
X-API-KEY: {ihr_api_schluessel}
Content-Type: application/json

{
  "data": {
    "receipt_id": 101
  }
}

Beispielantwort

{
  "result": { "code": 1, "message": "success" },
  "data": {}
}
POST /api/collect/status_change

Ändern des Status einer Sammelliste zwischen den Schritten des Bearbeitungsprozesses. Der Status 16 (kommissioniert) kann nur bei einer Sammlung vom Typ Warenausgang (34) und nur aus Status 15 gesetzt werden.

POST-Felder — data-Objekt

Feld Typ Pflicht Beschreibung
receipt_id int ID der Sammelliste
status_id int ID des neuen Status
comment_bottom string Aktualisierung des internen Kommentars
company_user_id int Übergabe des zuständigen Mitarbeiters an einen anderen Benutzer

Beispielanfrage

POST /api/collect/status_change
X-API-KEY: {ihr_api_schluessel}
Content-Type: application/json

{
  "data": {
    "receipt_id": 101,
    "status_id": 15,
    "comment_bottom": "Kiszedésre vár"
  }
}

Beispielantwort

{
  "result": { "code": 1, "message": "success" },
  "data": {}
}
GET /api/collect/download

Herunterladen/Generieren des Sammellisten-Dokuments in verschiedenen Formaten (PDF, Base64-String, Stream).

Query-Parameter

Parameter Typ Pflicht Beschreibung
receipt_id int ID der Sammelliste
file_type string Ausgabeformat (siehe unten)
language string Name des Sprachordners der Vorlage (z. B. hungarian)
language_id int Sprach-ID (für die ID-basierte Suche)
template_id int ID einer benutzerdefinierten Druckvorlage

Mögliche Werte für file_type

Wert Beschreibung
pdf Rückgabe eines Base64-kodierten PDFs mit Metadaten
pdf-string Identisch mit pdf — Base64-String + Metadaten
pdf-string-sample Generierung einer Vorschau-PDF
stream Direkter Datei-Stream (Browser-Download)

Beispielanfrage

GET /api/collect/download?receipt_id=101&file_type=pdf
X-API-KEY: {ihr_api_schluessel}

Beispielantwort (file_type=pdf)

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "name": "COL-2024-0101.pdf",
    "content": "JVBERi0xLjQK...",
    "receipt": { ... }
  }
}

Nimm Kontakt mit uns auf

Interessierst du dich für unsere Software? Schreib uns einfach!

Anfrage senden

Brauchst du Hilfe?

Wenn du keine Antwort findest und Unterstützung brauchst

Im Help Center stöbern

Jetzt registrieren,
später bezahlen!

Teste es 3 Tage kostenlos, ohne Risiko und Verpflichtungen!
Registrierung erstellen
Registrieren