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, v prípade chyby result.code == 0.
/api/offer_request/get
Získanie jedného dopytu na ponuku od zákazníka na základe identifikátora, so všetkými podrobnosťami.
Query parametre
| Parameter | Typ | Povinné | Popis |
|---|---|---|---|
id | int | Jedinečný identifikátor dopytu na ponuku |
Príklad požiadavky
GET /api/offer_request/get?id=8
X-API-KEY: {vas_api_kluc}
/api/offer_request/list
Stránkovateľné získanie zoznamu dopytov na ponuku od zákazníkov s možnosťou filtrovania.
Query parametre
| Parameter | Typ | Povinné | Popis |
|---|---|---|---|
list_offset | int | Posun stránkovania (predvolene: 0) | |
list_count | int | Počet záznamov na stránku | |
list_condition[identify] | string | Filter podľa identifikátora (LIKE) | |
list_condition[company_name] | string | Filter podľa názvu partnera (LIKE) | |
list_condition[status_id] | int | Filter podľa stavu | |
list_condition[date_create_from] | date | Dátum vytvorenia — od (YYYY-MM-DD) | |
list_condition[date_create_to] | date | Dátum vytvorenia — do (YYYY-MM-DD) |
Príklad požiadavky
GET /api/offer_request/list?list_offset=0&list_condition[status_id]=1
X-API-KEY: {vas_api_kluc}
/api/offer_request/save
Vytvorenie alebo úprava dopytu na ponuku od zákazníka. Pre nový záznam data[id] = 0.
POST polia — objekt data
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
id | int | 0 = nový dopyt na ponuku, >0 = úprava | |
company_id | int | Identifikátor firmy | |
company_user_id | int | ID zodpovedného pracovníka | |
company_address_id | int | ID prevádzky firmy | |
currency_id | int | Identifikátor meny | |
partner_id | int | Identifikátor partnera/zákazníka | |
comment_top | string | Poznámka | |
comment_bottom | string | Interná poznámka | |
item | array | Pole položiek |
Polia položky — data[item][]
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
product_id | int | Identifikátor produktu | |
quantity | float | Požadované množstvo | |
price | float | Navrhovaná jednotková cena | |
tax_id | int | Identifikátor sadzby DPH | |
remove | int | 1 = odstránenie položky pri úprave |
Príklad požiadavky
POST /api/offer_request/save
X-API-KEY: {vas_api_kluc}
Content-Type: application/json
{
"data": {
"id": 0,
"company_id": 1,
"company_user_id": 3,
"company_address_id": 1,
"currency_id": 1,
"partner_id": 12,
"item": [
{ "product_id": 5, "quantity": 10 }
]
}
}
/api/offer_request/delete
Odstránenie dopytu na ponuku od zákazníka. Odstrániť možno iba záznam s otvoreným stavom.
POST polia — objekt data
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
receipt_id | int | Identifikátor dopytu na ponuku, 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": { "receipt_id": 8 } }
/api/offer_request/close
Uzavretie dopytu na ponuku od zákazníka. Uzavrieť možno iba otvorený záznam (status_id=1).
POST polia — objekt data
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
receipt_id | int | Identifikátor dopytu na ponuku, ktorý sa má uzavrieť |
Príklad požiadavky
POST /api/offer_request/close
X-API-KEY: {vas_api_kluc}
Content-Type: application/json
{ "data": { "receipt_id": 8 } }
/api/offer_request/download
Stiahnutie dokumentu dopytu na ponuku od zákazníka v rôznych formátoch.
Query parametre
| Parameter | Typ | Povinné | Popis |
|---|---|---|---|
receipt_id | int | Identifikátor dopytu na ponuku | |
file_type | string | pdf, pdf-string, pdf-string-sample, stream | |
language | string | Názov jazykového priečinka šablóny | |
template_id | int | ID vlastnej tlačovej šablóny |
Príklad požiadavky
GET /api/offer_request/download?receipt_id=8&file_type=pdf
X-API-KEY: {vas_api_kluc}
Zaregistruj sa teraz,
zaplať neskôr!