Registrieren Anmelden

Bestandsreservierung API

Verwaltung von Bestandsreservierungen — Abruf, Erstellung, Änderung, Abschluss und Dokumenten-Download

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/reserve/

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

GET /api/reserve/get

Abruf einer einzelnen Bestandsreservierung anhand der ID, mit vollständigen Details (Positionen, Bestandsdaten, Projekt).

Query-Parameter

Parameter Typ Pflicht Beschreibung
id int Eindeutige ID der Bestandsreservierung

Beispielanfrage

GET /api/reserve/get?id=23
X-API-KEY: {ihr_api_schluessel}

Beispielantwort

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "id": 23,
    "identify": "RES-2024-0023",
    "date_create": "2024-05-05 09:15:00",
    "date_perform": "2024-05-20",
    "status_id": 1,
    "partner_company_name": "Minta Kft.",
    "price_brutto": 95000,
    "price_netto": 74803,
    "price_tax": 20197,
    "currency_name": "HUF",
    "item": [
      {
        "product_id": 8,
        "quantity": 5,
        "price": 14961,
        "price_brutto": 19000
      }
    ]
  }
}
GET /api/reserve/list

Paginierter Abruf der Liste der Bestandsreservierungen mit Filtermöglichkeiten.

Query-Parameter

Parameter Typ Pflicht Beschreibung
list_offset int Paginierungs-Offset (Standard: 0)
list_condition[identify] string Filter nach Identifikator (LIKE)
list_condition[company_name] string Filter nach Partnername (LIKE)
list_condition[status_id] int Filter nach Status (1=offen, 2=abgeschlossen)
list_condition[status_ids] array Filter nach mehreren Status gleichzeitig
list_condition[date_create_from] date Erstellungsdatum — von (YYYY-MM-DD)
list_condition[date_create_to] date Erstellungsdatum — bis (YYYY-MM-DD)
list_condition[date_perform_from] date Erfüllungsdatum — von (YYYY-MM-DD)
list_condition[date_perform_to] date Erfüllungsdatum — bis (YYYY-MM-DD)
list_condition[partner_id] int Filter nach Partner-ID
list_condition[company_user_id] int Filter nach zuständigem Mitarbeiter (ID)
list_condition[partnumber] string Filter nach Artikelnummer oder Barcode (LIKE)
list_condition[comment_top] string Filter nach für den Kunden sichtbarer Anmerkung (LIKE)
list_condition[comment_bottom] string Filter nach interner Anmerkung (LIKE)

Beispielanfrage

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

Beispielantwort

{
  "result": { "code": 1, "message": "success" },
  "data": [
    {
      "id": 23,
      "identify": "RES-2024-0023",
      "date_create": "2024-05-05",
      "status_name": "Nyitott",
      "partner_company_name": "Minta Kft.",
      "price_brutto": 95000
    }
  ],
  "params": {
    "list_count": 10,
    "list_offset": 0,
    "list_all": 12
  }
}
POST /api/reserve/save

Erstellung oder Änderung einer Bestandsreservierung. Für eine neue Reservierung data[id] = 0, zur Änderung die bestehende ID angeben.

POST-Felder — Objekt data

Feld Typ Pflicht Beschreibung
id int 0 = neue Bestandsreservierung, >0 = Änderung
company_id int ID der Firma
company_user_id int ID des zuständigen Mitarbeiters
company_address_id int ID der Firmenniederlassung
date_perform datetime Erfüllungsdatum (YYYY-MM-DD HH:MM:SS)
currency_id int ID der Währung
partner_id int ID des Partners/Kunden
partner_user_id int ID des Partner-Ansprechpartners
partner_shipping_id int ID der Lieferadresse des Partners
currency_exchange decimal Wechselkurs (Standard: 1)
comment_top string Für den Kunden sichtbare Anmerkung
comment_bottom string Interne Anmerkung
jobnumber_id int ID der Auftragsnummer
departmentnumber_id int ID der Abteilungsnummer
project_id int ID des Projekts
source_receipt_id int ID des Quellbelegs
source_receipt_type_id int ID des Quellbelegtyps
item array Array der Positionen — mindestens eine Position ist Pflicht (siehe unten)

Positionsfelder — data[item][]

Feld Typ Pflicht Beschreibung
id int 0 = neue Position, >0 = Änderung einer bestehenden Position
product_id int ID des Produkts
store_id int ID des Lagers
store_locality_id int ID des Lagerplatzes
pallet_id int ID der Palette
quantity decimal Menge
tax_id int ID des Steuersatzes
price decimal Nettoeinzelpreis
price_discount decimal Rabatt-/Aufschlagprozentsatz
stock_change int Kennzeichen für Bestandsbewegung
comment_top string Anmerkung zur Position
remove int 1 = Position bei Änderung löschen

POST-Felder — Objekt params (optional)

Feld Typ Pflicht Beschreibung
close int 1 = automatischer Abschluss nach dem Speichern
download int 1 = PDF-Generierung nach dem Speichern

Beispielanfrage

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

{
  "data": {
    "id": 0,
    "company_id": 1,
    "company_user_id": 3,
    "company_address_id": 1,
    "date_perform": "2024-06-20 00:00:00",
    "partner_id": 12,
    "currency_id": 1,
    "item": [
      {
        "id": 0,
        "product_id": 8,
        "store_id": 1,
        "quantity": 5,
        "tax_id": 2,
        "price": 14961
      }
    ]
  },
  "params": {
    "close": 0,
    "download": 0
  }
}

Beispielantwort

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "id": 24,
    "identify": "RES-2024-0024"
  }
}
POST /api/reserve/delete

Löschen einer Bestandsreservierung. Nur ein Beleg mit status_id = 1 (offen) oder status_id = 2 (abgeschlossen) kann gelöscht werden.

POST-Felder — Objekt data

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

Beispielanfrage

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

{
  "data": {
    "receipt_id": 23
  }
}

Beispielantwort

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

Abschluss einer offenen Bestandsreservierung. Nur ein Beleg mit status_id = 1 (offen) kann abgeschlossen werden.

POST-Felder — Objekt data

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

Beispielanfrage

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

{
  "data": {
    "receipt_id": 23
  }
}

Beispielantwort

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

Generierung des Dokuments einer Bestandsreservierung in verschiedenen Formaten (PDF, Base64-String, Stream).

Query-Parameter

Parameter Typ Pflicht Beschreibung
receipt_id int ID der Bestandsreservierung
file_type string Ausgabeformat (siehe unten)
language string Name des Sprachordners der Vorlage (z. B. hungarian)
language_id int ID der Sprache (Standard: 1)
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 (Download im Browser)

Beispielanfrage

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

Beispielantwort (file_type=pdf)

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "name": "RES-2024-0023.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