Základná URL
https://{tenant}.logzi.com/api/offer_request/
Každá požiadavka vracia odpoveď vo formáte JSON. Pri úspešnej odpovedi je result.code == 1, pri chybe result.code == 0. API pre dopyty na ponuku umožňuje evidenciu, uzatváranie, sťahovanie a hromadné zaznamenávanie dokladov dopytov na ponuku zasielaných zákazníkom.
/api/offer_request/get
Získanie jedného dokladu dopytu na ponuku podľa identifikátora.
Query parametre
| Parameter | Typ | Povinné | Popis |
|---|---|---|---|
id | int | Identifikátor dokladu |
Príklad požiadavky
GET /api/offer_request/get?id=1
X-API-KEY: {vas_api_kluc}
/api/offer_request/list
Stránkovaný zoznam dopytov na ponuku.
Query parametre
| Parameter | Typ | Povinné | Popis |
|---|---|---|---|
list_count | int | Maximálny počet vrátených záznamov | |
list_offset | int | Posun stránkovania (predvolené: 0) | |
list_condition | object | Objekt filtračných podmienok | |
list_sort | object | Objekt podmienok zoradenia |
Príklad požiadavky
GET /api/offer_request/list?list_offset=0&list_count=50
X-API-KEY: {vas_api_kluc}
/api/offer_request/download
Stiahnutie dokladu dopytu na ponuku vo formáte PDF alebo v inom formáte.
Query parametre
| Parameter | Typ | Povinné | Popis |
|---|---|---|---|
file_type | string | Typ súboru (napr. pdf) | |
receipt_id | int | Identifikátor dokladu | |
language | string | Jazyk dokladu (napr. hu) | |
language_id | int | Identifikátor jazyka | |
template_id | int | Identifikátor tlačovej šablóny |
Príklad požiadavky
GET /api/offer_request/download?file_type=pdf&receipt_id=1&language=hu
X-API-KEY: {vas_api_kluc}
/api/offer_request/save_bulk
Uloženie viacerých dokladov dopytu na ponuku naraz.
POST polia — pole data
V poli data je možné zadať údaje viacerých dokladov naraz na hromadné zaznamenanie.
Príklad požiadavky
POST /api/offer_request/save_bulk
X-API-KEY: {vas_api_kluc}
Content-Type: application/json
{ "data": [ { "partner_id": 1 }, { "partner_id": 2 } ] }
/api/offer_request/close
Uzavretie dokladu dopytu na ponuku.
POST polia — objekt data
V objekte data je potrebné uviesť identifikátor dokladu, ktorý sa má uzavrieť.
Príklad požiadavky
POST /api/offer_request/close
X-API-KEY: {vas_api_kluc}
Content-Type: application/json
{ "data": { "id": 1 } }
/api/offer_request/delete
Odstránenie dokladu dopytu na ponuku.
POST polia — objekt data
V objekte data je potrebné uviesť údaje dokladu, ktorý sa má odstrániť.
Príklad požiadavky
POST /api/offer_request/delete
X-API-KEY: {vas_api_kluc}
Content-Type: application/json
{ "data": { "id": 1 } }
Zaregistruj sa teraz,
zaplať neskôr!