Lieferantenbestellungs-API

Verwaltung von Lieferantenbestellungen — Abruf, Erstellung, Änderung, Abschluss und Dokumentendownload

Basis-URL

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

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

GET/api/order_out/get

Abrufen einer einzelnen Lieferantenbestellung anhand der ID, mit vollständigen Details.

Query-Parameter

ParameterTypPflichtfeldBeschreibung
idintEindeutige ID der Lieferantenbestellung

Beispielanfrage

GET /api/order_out/get?id=55
X-API-KEY: {ihr_api_schluessel}
GET/api/order_out/list

Paginierbarer Abruf der Liste der Lieferantenbestellungen mit Filtermöglichkeiten.

Query-Parameter

ParameterTypPflichtfeldBeschreibung
list_offsetintOffset der Paginierung (Standard: 0)
list_countintAnzahl der Datensätze pro Seite
list_sort[field]stringName des Sortierfelds
list_sort[sort]stringSortierrichtung: ASC oder DESC
list_condition[identify]stringFilter nach Kennung (LIKE)
list_condition[company_name]stringFilter nach Lieferantenname (LIKE)
list_condition[status_id]intFilter nach Status
list_condition[date_create_from]dateErstellungsdatum — von (JJJJ-MM-TT)
list_condition[date_create_to]dateErstellungsdatum — bis (JJJJ-MM-TT)
list_condition[partner_id]intFilter nach Lieferanten-Partner-ID

Beispielanfrage

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

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

POST-Felder — data-Objekt

FeldTypPflichtfeldBeschreibung
idint0 = neue Bestellung, >0 = Änderung
company_idintFirmen-ID
company_user_idintID des zuständigen Mitarbeiters
company_address_idintID des Firmenstandorts
currency_idintWährungs-ID
partner_idintID des Lieferanten-Partners
date_performdateLieferfrist (JJJJ-MM-TT)
comment_topstringFür den Lieferanten sichtbarer Kommentar
comment_bottomstringInterner Kommentar
jobnumber_idintID der Auftragsnummer
project_idintProjekt-ID
itemarrayArray der Positionen (siehe unten)

Positionsfelder — data[item][]

FeldTypPflichtfeldBeschreibung
product_idintProdukt-ID
quantityfloatBestellte Menge
pricefloatNetto-Einzelpreis
tax_idintID des USt-Satzes
price_discountfloatRabattprozentsatz
store_idintID des Ziellagers
removeint1 = Position bei Änderung löschen

POST-Felder — params-Objekt (optional)

FeldTypPflichtfeldBeschreibung
closeint1 = automatischer Abschluss nach dem Speichern
downloadint1 = PDF-Generierung nach dem Speichern

Beispielanfrage

POST /api/order_out/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,
    "currency_id": 1,
    "partner_id": 8,
    "date_perform": "2024-07-01",
    "item": [
      { "product_id": 2, "quantity": 100, "price": 500, "tax_id": 2 }
    ]
  }
}

Beispielantwort

{
  "result": { "code": 1, "message": "success" },
  "data": { "id": 56, "identify": "SZR-2024-0056" }
}
POST/api/order_out/delete

Löschen einer Lieferantenbestellung. Nur offene Bestellungen (status_id=1) können gelöscht werden.

POST-Felder — data-Objekt

FeldTypPflichtfeldBeschreibung
receipt_idintID der zu löschenden Bestellung

Beispielanfrage

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

{ "data": { "receipt_id": 55 } }
POST/api/order_out/close

Abschließen einer Lieferantenbestellung. Nur offene Bestellungen (status_id=1) können abgeschlossen werden.

POST-Felder — data-Objekt

FeldTypPflichtfeldBeschreibung
receipt_idintID der abzuschließenden Bestellung

Beispielanfrage

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

{ "data": { "receipt_id": 55 } }
GET/api/order_out/download

Herunterladen des Dokuments einer Lieferantenbestellung in verschiedenen Formaten.

Query-Parameter

ParameterTypPflichtfeldBeschreibung
receipt_idintID der Bestellung
file_typestringpdf, pdf-string, pdf-string-sample, stream
languagestringName des Sprachordners der Vorlage (z. B. hungarian)
template_idintID der individuellen Druckvorlage

Beispielanfrage

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

Nimm Kontakt mit uns auf

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

Brauchst du Hilfe?

Wenn du keine Antwort findest und Unterstützung brauchst

Jetzt registrieren,
später bezahlen!

Teste es 3 Tage kostenlos, ohne Risiko und Verpflichtungen!