Regisztráció Belépés

Fuvarozás API

Fuvarozási rendelések kezelése

Végpontok

GET Egyed lekérése
GET Lista lekérése
GET Csoportos lista lekérése
GET Csomagpontok lekérése
GET Fuvarozók lekérése
GET Futárszolgálati lista
POST Mentés
POST Törlés
POST Lezárás
POST Expert mentés
POST Expert tétel mentés
POST Expert mentés (light)
GET Csomagcímke letöltés
GET Letöltés

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.

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éter	Típus	Kötelező	Leírás
`id`	integer		A 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éter	Típus	Leírás
`list_offset`	integer	Lapozás kezdőpozíciója (alapértelmezett: 0)
`list_condition[identify]`	string	Bizonylatszámra szűrés
`list_condition[status_id]`	integer	Státusz szerinti szűrés
`list_condition[date_create_from]`	string	Létrehozás dátuma (tól), YYYY-MM-DD
`list_condition[date_create_to]`	string	Lé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}

GET /api/transport/list_item_group/

Fuvarozási tételek csoportosított listájának lekérése szűrési lehetőséggel.

Paraméterek

Paraméter	Típus	Kötelező	Leírás
`list_offset`	integer		Lapozás kezdőpozíciója (alapértelmezett: 0)
`list_condition`	object		Szűrési feltételek

Példa kérés

GET https://{tenant}.logzi.com/api/transport/list_item_group/?list_offset=0
X-API-KEY: {api_kulcs}

GET /api/transport/get_postpoints/

Elérhető csomagpontok (pl. csomagautomata, postapont) listájának lekérése.

Paraméterek

Paraméter	Típus	Leírás
`list_offset`	integer	Lapozás kezdőpozíciója (alapértelmezett: 0)
`list_condition`	object	Szűrési feltételek
`params`	object	Kiegészítő paraméterek (pl. futárszolgálat-specifikus beállítások)

Példa kérés

GET https://{tenant}.logzi.com/api/transport/get_postpoints/?list_offset=0
X-API-KEY: {api_kulcs}

GET /api/transport/get_carriers/

Elérhető fuvarozók (szállítók) listájának lekérése.

Paraméterek

Paraméter	Típus	Kötelező	Leírás
`list_offset`	integer		Lapozás kezdőpozíciója (alapértelmezett: 0)
`list_condition`	object		Szűrési feltételek

Példa kérés

GET https://{tenant}.logzi.com/api/transport/get_carriers/?list_offset=0
X-API-KEY: {api_kulcs}

GET /api/transport/get_shipper_service_list/

Futárszolgálati szolgáltatástípusok listájának lekérése (pl. expressz, normál, csomagpont).

Paraméterek

Paraméter	Típus	Kötelező	Leírás
`list_offset`	integer		Lapozás kezdőpozíciója (alapértelmezett: 0)
`list_condition`	object		Szűrési feltételek

Példa kérés

GET https://{tenant}.logzi.com/api/transport/get_shipper_service_list/?list_offset=0
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ípus	Leírás
`id`	integer	Bizonylat azonosítója (null = új)
`company_id`	integer	Cég azonosítója
`company_user_id`	integer	Felhasználó azonosítója
`company_address_id`	integer	Telephely azonosítója
`partner_id`	integer	Vevő/megrendelő partner azonosítója
`receipt_id`	integer	Kapcsolódó bizonylat azonosítója
`delivery_mode`	string	Szállítási mód
`shipper_partner_id`	integer	Futárszolgálat partner azonosítója
`comment_bottom`	string	Megjegyzés

Paraméterek (`params` objektum)

Paraméter	Típus	Kötelező	Leírás
`close`	integer		1 = 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éter	Típus	Kötelező	Leírás
`receipt_id`	integer		A 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éter	Típus	Kötelező	Leírás
`receipt_id`	integer		A 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 }

POST /api/transport/save_expert/

Fuvarozási bizonylat mentése expert (haladó) módban. Az összes szállítási és csomagadatot explicit meg kell adni — a rendszer nem tölti fel automatikusan a bizonylatból. Ha ma már van nyitott fuvar ugyanehhez a futárszolgálathoz, az új cím ahhoz kerül hozzáadva.

Adatok (`data` objektum)

Mező	Típus	Leírás
`company_id`	integer	Cég azonosítója
`company_user_id`	integer	Felhasználó azonosítója
`partner_id`	integer	Vevő partner azonosítója
`partner_user_id`	integer	Vevő kapcsolattartójának azonosítója
`partner_shipping_id`	integer	Vevő szállítási cím azonosítója
`shipper_partner_id`	integer	Futárszolgálat partner azonosítója
`delivery_mode`	string	Szállítási mód rövid neve (pl. `HD`, `HA`, `PP`)
`quantity`	integer	Csomagok száma
`weight`	number	Súly (gramm)
`cod_amount`	number	Utánvét összege (0 ha nincs utánvét)
`cod_amount_register`	number	Biztosított érték összege
`id`	integer	Bizonylat azonosítója (null vagy 0 = új)
`company_shipping_id`	integer	Saját telephely azonosítója (alapértelmezett: 1)
`shipper_partner_user_id`	integer	Futárszolgálat kapcsolattartójának azonosítója
`receipt_id`	integer	Kapcsolódó bizonylat azonosítója (pl. számla)
`receipt_type_id`	integer	Kapcsolódó bizonylat típusa (8/13/33=számla, 5=megrendelés) — kötelező ha `receipt_id` meg van adva
`receipt_identify`	string	Kapcsolódó bizonylat azonosító szövege (opció a DB-lookup kiváltására)
`parcel_create_label`	integer	Csomagcímke generálása: `1` = igen (alapértelmezett), `0` = nem
`postpoint`	object	Csomagpont adatai (csomagautomata / postapont esetén)
`shipper_service_list`	object	Futárszolgálat-specifikus extra szolgáltatások
`comment_top`	string	Fejléc megjegyzés a fuvarlevélen
`comment_bottom`	string	Lábléc megjegyzés a fuvarlevélen
`partner_comment_top`	string	Partner-szintű fejléc megjegyzés
`address_comment`	string	Szállítási cím megjegyzés (pl. csengő, emelet)
`address_user_name`	string	Átvevő neve a szállítási címen
`jobnumber_id`	integer	Munkaszám azonosítója
`departmentnumber_id`	integer	Részlegszám azonosítója
`direction_id`	integer	Szállítás iránya (alapértelmezett: 1)

Példa kérés

POST https://{tenant}.logzi.com/api/transport/save_expert/
X-API-KEY: {api_kulcs}
Content-Type: application/json

{
  "data": {
    "company_id": 1,
    "company_user_id": 3,
    "company_shipping_id": 1,
    "partner_id": 6,
    "partner_user_id": 12,
    "partner_shipping_id": 8,
    "shipper_partner_id": 2,
    "delivery_mode": "HD",
    "quantity": 1,
    "weight": 2000,
    "cod_amount": 0,
    "cod_amount_register": 15000,
    "receipt_id": 45,
    "receipt_type_id": 8,
    "parcel_create_label": 1,
    "comment_bottom": "Törékeny küldemény"
  }
}

POST /api/transport/save_expert_item/

Csomagcímke generálása egy már meglévő fuvarozási cím bejegyzéshez (transport_address_id). Akkor használatos, ha a fuvar tétele már létezik, de a futárszolgálat-integrációs csomagcímke még hiányzik vagy újra kell generálni.

Adatok (`data` objektum)

Mező	Típus	Leírás
`company_id`	integer	Cég azonosítója
`company_user_id`	integer	Felhasználó azonosítója
`transport_address_id`	integer	A fuvarozási cím bejegyzés azonosítója, amelyhez a csomagcímkét generálni kell
`shipper_partner_id`	integer	Futárszolgálat partner azonosítója
`delivery_mode`	string	Szállítási mód rövid neve (pl. `HD`, `HA`, `PP`)
`quantity`	integer	Csomagok száma
`weight`	number	Súly (gramm)
`parcel_create_label`	integer	Csomagcímke generálása: `1` = igen (alapértelmezett), `0` = nem
`cod_amount`	number	Utánvét összege (alapértelmezett: 0)
`cod_amount_register`	number	Biztosított érték összege (alapértelmezett: 0)
`postpoint`	object	Csomagpont adatai
`shipper_service_list`	object	Futárszolgálat-specifikus extra szolgáltatások

Példa kérés

POST https://{tenant}.logzi.com/api/transport/save_expert_item/
X-API-KEY: {api_kulcs}
Content-Type: application/json

{
  "data": {
    "company_id": 1,
    "company_user_id": 3,
    "transport_address_id": 57,
    "shipper_partner_id": 2,
    "delivery_mode": "HD",
    "quantity": 1,
    "weight": 2000,
    "cod_amount": 0,
    "cod_amount_register": 15000,
    "parcel_create_label": 1
  }
}

POST /api/transport/save_expert_light/

Fuvarozási bizonylat mentése egyszerűsített módban. A partner, cím, utánvét és súlyadatokat a rendszer automatikusan kinyeri a megadott bizonylatból (megrendelés / számla / gyűjtő). A futárszolgálat és szállítási mód automatikusan kerül meghatározásra a megrendelés szállítási beállításaiból, de felülírható.

Adatok (`data` objektum)

Mező	Típus	Leírás
`company_id`	integer	Cég azonosítója
`receipt_id`	integer	A forrásbizonylat azonosítója (megrendelés, számla stb.)
`receipt_type_id`	integer	A forrásbizonylat típusa: `5` = megrendelés, `8`/`13`/`33` = számla, `32`/`34` = gyűjtő
`shipper_partner_id`	integer	Futárszolgálat partner azonosítója — felülírja a bizonylatból automatikusan meghatározott értéket
`delivery_mode`	string	Szállítási mód rövid neve (pl. `HD`, `HA`) — felülírja az automatikusan meghatározott értéket

Példa kérés

POST https://{tenant}.logzi.com/api/transport/save_expert_light/
X-API-KEY: {api_kulcs}
Content-Type: application/json

{
  "data": {
    "company_id": 1,
    "receipt_id": 45,
    "receipt_type_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éter	Típus	Leírás
`receipt_id`	integer	A fuvarozási bizonylat azonosítója
`receipt_type_id`	integer	A bizonylat típusának azonosítója
`file_type`	string	Fájl típus: `pdf`, `pdf-string`
`language`	string	Nyelv kódja (alapértelmezett: `hungarian`)

Példa kérés

GET https://{tenant}.logzi.com/api/transport/download_parcel_label/?receipt_id=8&receipt_type_id=11&file_type=pdf
X-API-KEY: {api_kulcs}

GET /api/transport/download/

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

Paraméterek

Paraméter	Típus	Leírás
`receipt_id`	integer	A bizonylat azonosítója
`file_type`	string	Fájl típus: `pdf`, `pdf-string`, `pdf-string-sample`, `parcel-manifest`, `stream`
`language`	string	Nyelv neve (pl. `hungarian`, `english`)
`language_id`	integer	Nyelv azonosítója (alternatíva a `language` paraméterhez)
`template_id`	integer	Nyomtatá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ó

Fuvarozás API

Alap URL

Paraméterek

Példa kérés

Paraméterek

Példa kérés

Paraméterek

Példa kérés

Paraméterek

Példa kérés

Paraméterek

Példa kérés

Paraméterek

Példa kérés

Adatok (data objektum)

Paraméterek (params objektum)

Példa kérés

Paraméterek

Példa kérés

Paraméterek

Példa kérés

Adatok (data objektum)

Példa kérés

Adatok (data objektum)

Példa kérés

Adatok (data objektum)

Példa kérés

Paraméterek

Példa kérés

Paraméterek

Példa kérés

Adatok (`data` objektum)

Paraméterek (`params` objektum)

Adatok (`data` objektum)

Adatok (`data` objektum)

Adatok (`data` objektum)