Regisztráció Belépés

Fuvarozás API

Fuvarozási rendelések kezelése

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/transport/
GET /api/transport/get/

Egyedi fuvarozási bizonylat lekérése azonosító alapján.

Paraméterek
ParaméterTípusKötelezőLeírás
idintegerA fuvarozási bizonylat egyedi azonosítója
Példa kérés
GET https://{tenant}.logzi.com/api/transport/get/?id=1
X-API-KEY: {api_kulcs}
GET /api/transport/list/

Fuvarozási bizonylatok listájának lekérése szűrési lehetőséggel.

Paraméterek
ParaméterTípusKötelezőLeírás
list_offsetintegerLapozás kezdőpozíciója (alapértelmezett: 0)
list_condition[identify]stringBizonylatszámra szűrés
list_condition[status_id]integerStátusz szerinti szűrés
list_condition[date_create_from]stringLétrehozás dátuma (tól), YYYY-MM-DD
list_condition[date_create_to]stringLétrehozás dátuma (ig), YYYY-MM-DD
Példa kérés
GET https://{tenant}.logzi.com/api/transport/list/?list_offset=0&list_condition[status_id]=1
X-API-KEY: {api_kulcs}
POST /api/transport/save/

Fuvarozási bizonylat létrehozása vagy módosítása. Ha data[id] értéke null vagy 0, új bizonylat jön létre.

Adatok (data objektum)
MezőTípusKötelezőLeírás
idintegerBizonylat azonosítója (null = új)
company_idintegerCég azonosítója
company_user_idintegerFelhasználó azonosítója
company_address_idintegerTelephely azonosítója
partner_idintegerVevő/megrendelő partner azonosítója
receipt_idintegerKapcsolódó bizonylat azonosítója
delivery_modestringSzállítási mód
shipper_partner_idintegerFutárszolgálat partner azonosítója
comment_bottomstringMegjegyzés
Paraméterek (params objektum)
ParaméterTípusKötelezőLeírás
closeinteger1 = bizonylat lezárása mentés után
Példa kérés
POST https://{tenant}.logzi.com/api/transport/save/
X-API-KEY: {api_kulcs}
Content-Type: application/json

{
  "data": {
    "id": null,
    "partner_id": 6,
    "shipper_partner_id": 2,
    "delivery_mode": "courier",
    "comment_bottom": "Törékeny küldemény"
  },
  "params": { "close": 0 }
}
POST /api/transport/delete/

Fuvarozási bizonylat törlése. Csak nyitott bizonylat törölhető.

Paraméterek
ParaméterTípusKötelezőLeírás
receipt_idintegerA törlendő bizonylat azonosítója
Példa kérés
POST https://{tenant}.logzi.com/api/transport/delete/
X-API-KEY: {api_kulcs}
Content-Type: application/json

{ "receipt_id": 8 }
POST /api/transport/close/

Fuvarozási bizonylat lezárása. Lezárás után a bizonylat nem módosítható.

Paraméterek
ParaméterTípusKötelezőLeírás
receipt_idintegerA lezárandó bizonylat azonosítója
Példa kérés
POST https://{tenant}.logzi.com/api/transport/close/
X-API-KEY: {api_kulcs}
Content-Type: application/json

{ "receipt_id": 8 }
GET /api/transport/download_parcel_label/

Csomagcímke letöltése. Futárszolgálat integráció esetén a futárszolgálat által generált címkét adja vissza.

Paraméterek
ParaméterTípusKötelezőLeírás
receipt_idintegerA fuvarozási bizonylat azonosítója
file_typestringFájl típus: pdf, stream
Példa kérés
GET https://{tenant}.logzi.com/api/transport/download_parcel_label/?receipt_id=8&file_type=pdf
X-API-KEY: {api_kulcs}
GET /api/transport/download/

Fuvarozási bizonylat letöltése PDF formátumban.

Paraméterek
ParaméterTípusKötelezőLeírás
receipt_idintegerA bizonylat azonosítója
file_typestringFájl típus: pdf, pdf-string, stream
languagestringNyelv kódja (pl. hu, en)
template_idintegerNyomtatási sablon azonosítója
Példa kérés
GET https://{tenant}.logzi.com/api/transport/download/?receipt_id=8&file_type=pdf
X-API-KEY: {api_kulcs}

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ó