Regisztráció Belépés

Szállítói rendelés API

Szállítói rendelések kezelése — lekérés, létrehozás, módosítás, lezárás és dokumentum letöltés

Végpontok

Authentikáció

Minden API kéréshez szükséges az X-API-KEY header küldése.

X-API-KEY: {az_api_kulcsod}

Maradt még kérdésed?

Írj ticketet nekünk, vagy nézz körbe a keresőnkben.

Ha tetszett, oszd meg másokkal

Alap URL

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

Minden kérés JSON választ ad vissza. Sikeres válasz esetén result.code == 1, hiba esetén result.code == 0.

GET/api/order_out/get

Egyetlen szállítói rendelés lekérése azonosító alapján, teljes részletekkel.

Query paraméterek

ParaméterTípusKötelezőLeírás
idintA szállítói rendelés egyedi azonosítója

Példa kérés

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

Szállítói rendelések listájának lapozható lekérése szűrési lehetőségekkel.

Query paraméterek

ParaméterTípusKötelezőLeírás
list_offsetintLapozás eltolása (alapértelmezett: 0)
list_countintOldalanként megjelenő rekordok száma
list_sort[field]stringRendezési mező neve
list_sort[sort]stringRendezés iránya: ASC vagy DESC
list_condition[identify]stringSzűrés azonosítóra (LIKE)
list_condition[company_name]stringSzűrés szállító nevére (LIKE)
list_condition[status_id]intSzűrés státuszra
list_condition[date_create_from]dateLétrehozás dátuma — tól (YYYY-MM-DD)
list_condition[date_create_to]dateLétrehozás dátuma — ig (YYYY-MM-DD)
list_condition[partner_id]intSzűrés szállító partner ID-re

Példa kérés

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

Szállítói rendelés létrehozása vagy módosítása. Új rendeléshez data[id] = 0, módosításhoz a meglévő ID-t add meg.

POST mezők — data objektum

MezőTípusKötelezőLeírás
idint0 = új rendelés, >0 = módosítás
company_idintCég azonosítója
company_user_idintFelelős munkatárs ID
company_address_idintCég telephely ID
currency_idintPénznem azonosítója
partner_idintSzállító partner azonosítója
date_performdateSzállítási határidő (YYYY-MM-DD)
comment_topstringSzállítónak látható megjegyzés
comment_bottomstringBelső megjegyzés
jobnumber_idintMunkaszám azonosítója
project_idintProjekt azonosítója
itemarrayTételek tömbje (ld. alább)

Tétel mezők — data[item][]

MezőTípusKötelezőLeírás
product_idintTermék azonosítója
quantityfloatRendelt mennyiség
pricefloatNettó egységár
tax_idintÁFA kulcs azonosítója
price_discountfloatKedvezmény százaléka
store_idintCélraktár azonosítója
removeint1 = tétel törlése módosításkor

POST mezők — params objektum (opcionális)

MezőTípusKötelezőLeírás
closeint1 = mentés után automatikus lezárás
downloadint1 = mentés után PDF generálás

Példa kérés

POST /api/order_out/save
X-API-KEY: {az_api_kulcsod}
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 }
    ]
  }
}

Példa válasz

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

Szállítói rendelés törlése. Csak nyitott (status_id=1) rendelés törölhető.

POST mezők — data objektum

MezőTípusKötelezőLeírás
receipt_idintA törlendő rendelés azonosítója

Példa kérés

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

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

Szállítói rendelés lezárása. Csak nyitott (status_id=1) rendelés zárható le.

POST mezők — data objektum

MezőTípusKötelezőLeírás
receipt_idintA lezárandó rendelés azonosítója

Példa kérés

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

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

Szállítói rendelés dokumentumának letöltése különböző formátumokban.

Query paraméterek

ParaméterTípusKötelezőLeírás
receipt_idintA rendelés azonosítója
file_typestringpdf, pdf-string, pdf-string-sample, stream
languagestringSablon nyelvi mappa neve (pl. hungarian)
template_idintEgyedi nyomtatási sablon ID

Példa kérés

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

Vedd fel a kapcsolatot velünk

Érdeklődsz a szoftverünkkel kapcsolatban, írj bátran!

Érdeklődés küldése

Segítségre van szükséged?

Ha nem találod a választ és szükséged van segítségre

Nézz körbe a help centerben

Regisztrációdat hozd létre most,
fizess később!

Próbáld ki 3 napig ingyen, kockázatok és kötöttségek nélkül!
Regisztráció készítése
Regisztráció