Basis-URL
https://{tenant}.logzi.com/api/order_in/
Jede Anfrage liefert eine JSON-Antwort zurück. Bei Erfolg ist result.code == 1, bei einem Fehler result.code == 0.
/api/order_in/get
Abrufen einer einzelnen Kundenbestellung anhand der ID, mit vollständigen Details.
Query-Parameter
| Parameter | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
id | int | Eindeutige Kennung der Bestellung |
Beispielanfrage
GET /api/order_in/get?id=45
X-API-KEY: {ihr_api_schluessel}/api/order_in/list
Paginierbares Abrufen der Liste der Kundenbestellungen mit Filter- und Sortiermöglichkeiten.
Query-Parameter
| Parameter | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
list_offset | int | Paginierungs-Offset (Standard: 0) | |
list_count | int | Anzahl der pro Seite angezeigten Datensätze | |
list_sort[field] | string | Name des Sortierfelds | |
list_sort[sort] | string | Sortierrichtung: ASC oder DESC | |
list_condition[identify] | string | Filterung nach Kennung (LIKE) | |
list_condition[company_name] | string | Filterung nach Partnername (LIKE) | |
list_condition[status_id] | int | Filterung nach Status | |
list_condition[date_create_from] | date | Erstellungsdatum — von (YYYY-MM-DD) | |
list_condition[date_create_to] | date | Erstellungsdatum — bis (YYYY-MM-DD) | |
list_condition[partner_id] | int | Filterung nach Partner-ID |
Beispielanfrage
GET /api/order_in/list?list_offset=0&list_condition[status_id]=1
X-API-KEY: {ihr_api_schluessel}/api/order_in/save
Erstellen oder Ändern einer Kundenbestellung. Für einen neuen Datensatz data[id] = 0.
POST-Felder — Objekt data
| Feld | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
id | int | 0 = neue Bestellung, >0 = Änderung | |
company_id | int | Firmen-ID | |
company_user_id | int | ID des zuständigen Mitarbeiters | |
company_address_id | int | Firmenstandort-ID | |
currency_id | int | Währungs-ID | |
partner_id | int | Partner-/Kunden-ID | |
partner_shipping_id | int | ID der Partner-Lieferadresse | |
date_perform | date | Erfüllungsdatum (YYYY-MM-DD) | |
comment_top | string | Für den Kunden sichtbare Anmerkung | |
comment_bottom | string | Interne Anmerkung | |
jobnumber_id | int | ID der Auftragsnummer | |
project_id | int | Projekt-ID | |
item | array | Array der Positionen (siehe unten) |
Positionsfelder — data[item][]
| Feld | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
product_id | int | Produkt-ID | |
quantity | float | Menge | |
price | float | Netto-Einzelpreis | |
tax_id | int | ID des Steuersatzes | |
price_discount | float | Rabattprozentsatz | |
remove | int | 1 = Position beim Ändern löschen |
POST-Felder — Objekt params (optional)
| Feld | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
close | int | 1 = automatischer Abschluss nach dem Speichern | |
download | int | 1 = PDF-Erstellung nach dem Speichern |
Beispielanfrage
POST /api/order_in/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": 12,
"date_perform": "2024-07-15",
"comment_top": "Kérjük sürgős kezelést.",
"item": [
{ "product_id": 5, "quantity": 10, "price": 8000, "tax_id": 2 }
]
},
"params": { "close": 0, "download": 0 }
}/api/order_in/delete
Löschen einer Kundenbestellung. Nur Bestellungen mit dem Status "offen" können gelöscht werden.
POST-Felder — Objekt data
| Feld | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
receipt_id | int | ID der zu löschenden Bestellung |
Beispielanfrage
POST /api/order_in/delete
X-API-KEY: {ihr_api_schluessel}
Content-Type: application/json
{ "data": { "receipt_id": 45 } }/api/order_in/close
Abschließen einer Kundenbestellung. Nur Bestellungen mit dem Status "offen" (status_id = 1) können abgeschlossen werden.
POST-Felder — Objekt data
| Feld | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
receipt_id | int | ID der abzuschließenden Bestellung |
Beispielanfrage
POST /api/order_in/close
X-API-KEY: {ihr_api_schluessel}
Content-Type: application/json
{ "data": { "receipt_id": 45 } }/api/order_in/success
Markieren einer abgeschlossenen Kundenbestellung als erledigt. Kann nur bei Bestellungen mit dem Status "abgeschlossen" aufgerufen werden.
POST-Felder — Objekt data
| Feld | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
receipt_id | int | ID der als erledigt zu markierenden Bestellung (nur im Status "abgeschlossen") |
Beispielanfrage
POST /api/order_in/success
X-API-KEY: {ihr_api_schluessel}
Content-Type: application/json
{ "data": { "receipt_id": 45 } }/api/order_in/download
Herunterladen des Dokuments einer Kundenbestellung in verschiedenen Formaten.
Query-Parameter
| Parameter | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
receipt_id | int | ID der Bestellung | |
file_type | string | pdf, pdf-string, pdf-string-sample, stream | |
language | string | Name des Sprachordners der Vorlage | |
template_id | int | ID der individuellen Druckvorlage |
Beispielanfrage
GET /api/order_in/download?receipt_id=45&file_type=pdf
X-API-KEY: {ihr_api_schluessel}/api/order_in/change_customer_status
Ändern des Kundenstatus einer Kundenbestellung. Ein Integrations-Webhook wird automatisch ausgelöst, sofern dies nicht deaktiviert wird.
POST-Felder — Objekt data
| Feld | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
receipt_id | int | ID der Bestellung | |
customer_status_id | int | ID des neuen Kundenstatus | |
no_integration_event | int | 1 = kein Integrations-Webhook-Ereignis auslösen |
Beispielanfrage
POST /api/order_in/change_customer_status
X-API-KEY: {ihr_api_schluessel}
Content-Type: application/json
{ "data": { "receipt_id": 45, "customer_status_id": 3 } }/api/order_in/save_shipping
Ändern der Versand- und Zahlungsart einer Bestellung. Optional werden auch die Lieferadressdaten aktualisiert, wenn partner_address_id angegeben wird.
POST-Felder — Objekt data
| Feld | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
receipt_id | int | ID der Bestellung | |
shipping_id | int | ID der neuen Versandart (db_shipping.id) | |
paymod_id | int | ID der neuen Zahlungsart | |
partner_address_id | int | Wenn > 0, wird der Partneradressdatensatz mit den folgenden Adressfeldern aktualisiert | |
country_id | int | Land-ID | |
zip | string | Postleitzahl | |
city | string | Stadt | |
address | string | Straßenname | |
address_number | string | Hausnummer — Punkte werden automatisch entfernt | |
address_building | string | Gebäude — Punkte werden automatisch entfernt | |
address_floor | string | Stockwerk — Punkte werden automatisch entfernt | |
address_door | string | Tür — Punkte werden automatisch entfernt | |
address_stairwell | string | Treppenhaus — Punkte werden automatisch entfernt | |
district | string | Bezirk — Punkte werden automatisch entfernt | |
address_user_name | string | Name des Adressinhabers | |
address_comment | string | Adressanmerkung |
Beispielanfrage — nur Änderung von Versand- und Zahlungsart
POST /api/order_in/save_shipping
X-API-KEY: {ihr_api_schluessel}
Content-Type: application/json
{ "data": { "receipt_id": 45, "shipping_id": 3, "paymod_id": 2 } }Beispielanfrage — Änderung der Versandart + Adressaktualisierung
POST /api/order_in/save_shipping
X-API-KEY: {ihr_api_schluessel}
Content-Type: application/json
{ "data": { "receipt_id": 45, "shipping_id": 3, "paymod_id": 2, "partner_address_id": 12, "country_id": 1, "zip": "1051", "city": "Budapest", "address": "Vörösmarty tér", "address_number": "7", "district": "V" } }Interessierst du dich für unsere Software? Schreib uns einfach!
Jetzt registrieren,
später bezahlen!
