Registrácia Prihlásenie

API pre maloobchodný predaj

Správa dokladov o pokladničnom / maloobchodnom predaji — získanie, uloženie, uzavretie a stiahnutie dokumentu

Koncové body

Autentifikácia

Ku každej API požiadavke je potrebné odoslať hlavičku X-API-KEY.

X-API-KEY: {vas_api_kluc}

Máte ešte otázky?

Napíšte nám tiket, alebo si pozrite naše centrum pomoci.

Ak sa vám páčilo, podeľte sa s ostatnými

Základná URL

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

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.

GET /api/cash_register/get

Získanie jedného dokladu o maloobchodnom predaji na základe identifikátora, s kompletným zoznamom položiek.

Query parametre

ParameterTypPovinnéPopis
idintJedinečný identifikátor dokladu

Príklad požiadavky

GET /api/cash_register/get?id=101
X-API-KEY: {vas_api_kluc}
GET /api/cash_register/list

Získanie stránkovateľného zoznamu dokladov o maloobchodnom predaji s možnosťou filtrovania.

Query parametre

ParameterTypPovinnéPopis
list_offsetintPosun stránkovania (predvolene: 0)
list_countintPočet záznamov na stránku
list_condition[identify]stringFilter podľa čísla dokladu (LIKE)
list_condition[company_name]stringFilter podľa názvu zákazníka (LIKE)
list_condition[status_id]intFilter podľa stavu
list_condition[date_create_from]dateDátum vytvorenia — od (YYYY-MM-DD)
list_condition[date_create_to]dateDátum vytvorenia — do (YYYY-MM-DD)

Príklad požiadavky

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

Vytvorenie alebo úprava dokladu o maloobchodnom predaji. Pre nový doklad data[id] = 0.

POST polia — objekt data

PoleTypPovinnéPopis
idint0 = nový doklad, >0 = úprava
company_idintIdentifikátor firmy
company_user_idintID zodpovedného pracovníka
company_address_idintIdentifikátor prevádzky
currency_idintIdentifikátor meny
paymod_idintIdentifikátor spôsobu platby
partner_idintIdentifikátor partnera/zákazníka
date_performdateDátum plnenia (YYYY-MM-DD)
comment_topstringPoznámka
itemarrayPole položiek (pozri nižšie)

Polia položky — data[item][]

PoleTypPovinnéPopis
product_idintIdentifikátor produktu
quantityfloatMnožstvo
pricefloatBrutto jednotková cena
tax_idintIdentifikátor sadzby DPH
store_idintIdentifikátor skladu
removeint1 = odstránenie položky pri úprave

Príklad požiadavky

POST /api/cash_register/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,
    "paymod_id": 1,
    "item": [
      { "product_id": 5, "quantity": 2, "price": 3990, "tax_id": 2 }
    ]
  }
}
POST /api/cash_register/delete

Odstránenie dokladu o maloobchodnom predaji. Odstrániť možno iba doklad s otvoreným stavom.

POST polia — objekt data

PoleTypPovinnéPopis
receipt_idintIdentifikátor dokladu, ktorý sa má odstrániť

Príklad požiadavky

POST /api/cash_register/delete
X-API-KEY: {vas_api_kluc}
Content-Type: application/json

{ "data": { "receipt_id": 101 } }
POST /api/cash_register/close

Uzavretie dokladu o maloobchodnom predaji. Pri uzavretí sa vykoná pohyb zásob a finančný zápis. Uzavrieť možno iba otvorený doklad (status_id=1).

POST polia — objekt data

PoleTypPovinnéPopis
receipt_idintIdentifikátor dokladu, ktorý sa má uzavrieť

Príklad požiadavky

POST /api/cash_register/close
X-API-KEY: {vas_api_kluc}
Content-Type: application/json

{ "data": { "receipt_id": 101 } }
GET /api/cash_register/download

Stiahnutie dokumentu dokladu o maloobchodnom predaji v rôznych formátoch (PDF, tlačiteľný bloček).

Query parametre

ParameterTypPovinnéPopis
receipt_idintIdentifikátor dokladu
file_typestringpdf, pdf-string, pdf-thermal, pos-thermal, stream
languagestringNázov jazykového priečinka šablóny
template_idintID vlastnej tlačovej šablóny

Príklad požiadavky

GET /api/cash_register/download?receipt_id=101&file_type=pdf
X-API-KEY: {vas_api_kluc}

Kontaktuj nás

Zaujíma ťa náš softvér? Pokojne nám napíš!

Odoslať dopyt

Potrebuješ pomoc?

Ak nevieš nájsť odpoveď a potrebuješ pomoc

Pozri sa do centra pomoci

Zaregistruj sa teraz,
zaplať neskôr!

Vyskúšaj 3 dni zadarmo, bez rizika a záväzkov!
Vytvorenie registrácie
Registrácia