Registrácia Prihlásenie

API objednávok

Správa objednávok zákazníkov — získavanie, vytváranie, úprava, uzatváranie, označenie ako splnené a sťahovanie dokumentov

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/order_in/

Každá požiadavka vracia JSON odpoveď. Pri úspešnej odpovedi je result.code == 1, pri chybe result.code == 0.

GET /api/order_in/get

Získanie jednej objednávky zákazníka podľa identifikátora, s úplnými podrobnosťami.

Query parametre

ParameterTypPovinnéPopis
idintJedinečný identifikátor objednávky

Príklad požiadavky

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

Stránkované získanie zoznamu objednávok zákazníkov s možnosťami filtrovania a triedenia.

Query parametre

ParameterTypPovinnéPopis
list_offsetintPosun stránkovania (predvolené: 0)
list_countintPočet záznamov zobrazených na stránku
list_sort[field]stringNázov poľa na triedenie
list_sort[sort]stringSmer triedenia: ASC alebo DESC
list_condition[identify]stringFiltrovanie podľa identifikátora (LIKE)
list_condition[company_name]stringFiltrovanie podľa názvu partnera (LIKE)
list_condition[status_id]intFiltrovanie 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)
list_condition[partner_id]intFiltrovanie podľa identifikátora partnera

Príklad požiadavky

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

Vytvorenie alebo úprava objednávky zákazníka. Pre nový záznam data[id] = 0.

POST polia — objekt data

PoleTypPovinnéPopis
idint0 = nová objednávka, >0 = úprava
company_idintIdentifikátor firmy
company_user_idintID zodpovedného pracovníka
company_address_idintID prevádzky firmy
currency_idintIdentifikátor meny
partner_idintIdentifikátor partnera/zákazníka
partner_shipping_idintID dodacej adresy partnera
date_performdateDátum plnenia (YYYY-MM-DD)
comment_topstringPoznámka viditeľná pre zákazníka
comment_bottomstringInterná poznámka
jobnumber_idintIdentifikátor pracovného čísla
project_idintIdentifikátor projektu
itemarrayPole položiek (pozri nižšie)

Polia položky — data[item][]

PoleTypPovinnéPopis
product_idintIdentifikátor produktu
quantityfloatMnožstvo
pricefloatČistá jednotková cena
tax_idintIdentifikátor sadzby DPH
price_discountfloatPercento zľavy
removeint1 = odstránenie položky pri úprave

POST polia — objekt params (voliteľné)

PoleTypPovinnéPopis
closeint1 = automatické uzatvorenie po uložení
downloadint1 = generovanie PDF po uložení

Príklad požiadavky

POST /api/order_in/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,
    "date_perform": "2024-07-15",
    "comment_top": "Kérjük sürgős kezelést.",
    "item": [
      { "product_id": 5, "quantity": 10, "price": 8000, "tax_id": 2 }
    ]
  },
  "params": { "close": 0, "download": 0 }
}
POST /api/order_in/delete

Vymazanie objednávky zákazníka. Vymazať možno iba objednávku v otvorenom stave.

POST polia — objekt data

PoleTypPovinnéPopis
receipt_idintIdentifikátor objednávky určenej na vymazanie

Príklad požiadavky

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

{ "data": { "receipt_id": 45 } }
POST /api/order_in/close

Uzatvorenie objednávky zákazníka. Uzavrieť možno iba otvorenú objednávku (status_id = 1).

POST polia — objekt data

PoleTypPovinnéPopis
receipt_idintIdentifikátor objednávky určenej na uzatvorenie

Príklad požiadavky

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

{ "data": { "receipt_id": 45 } }
POST /api/order_in/success

Označenie uzatvorenej objednávky zákazníka ako splnenej. Možno volať iba pri objednávke v uzatvorenom stave.

POST polia — objekt data

PoleTypPovinnéPopis
receipt_idintIdentifikátor objednávky určenej na splnenie (iba v uzatvorenom stave)

Príklad požiadavky

POST /api/order_in/success
X-API-KEY: {vas_api_kluc}
Content-Type: application/json

{ "data": { "receipt_id": 45 } }
GET /api/order_in/download

Stiahnutie dokumentu objednávky zákazníka v rôznych formátoch.

Query parametre

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

Príklad požiadavky

GET /api/order_in/download?receipt_id=45&file_type=pdf
X-API-KEY: {vas_api_kluc}
POST /api/order_in/change_customer_status

Zmena stavu zákazníka objednávky. Integračný webhook sa vygeneruje automaticky, pokiaľ nie je zakázaný.

POST polia — objekt data

PoleTypPovinnéPopis
receipt_idintIdentifikátor objednávky
customer_status_idintIdentifikátor nového stavu zákazníka
no_integration_eventint1 = nespúšťať udalosť integračného webhooku

Príklad požiadavky

POST /api/order_in/change_customer_status
X-API-KEY: {vas_api_kluc}
Content-Type: application/json

{ "data": { "receipt_id": 45, "customer_status_id": 3 } }
POST /api/order_in/save_shipping

Zmena spôsobu dopravy a spôsobu platby objednávky. Voliteľne aktualizuje aj údaje dodacej adresy, ak je zadané partner_address_id.

POST polia — objekt data

PoleTypPovinnéPopis
receipt_idintIdentifikátor objednávky
shipping_idintIdentifikátor nového spôsobu dopravy (db_shipping.id)
paymod_idintIdentifikátor nového spôsobu platby
partner_address_idintAk > 0, aktualizuje záznam adresy partnera nasledujúcimi poľami adresy
country_idintIdentifikátor krajiny
zipstringPSČ
citystringMesto
addressstringNázov ulice, verejného priestranstva
address_numberstringČíslo domu — bodky sa automaticky odstránia
address_buildingstringBudova — bodky sa automaticky odstránia
address_floorstringPoschodie — bodky sa automaticky odstránia
address_doorstringDvere — bodky sa automaticky odstránia
address_stairwellstringSchodisko — bodky sa automaticky odstránia
districtstringObvod — bodky sa automaticky odstránia
address_user_namestringMeno vlastníka adresy
address_commentstringPoznámka k adrese

Príklad požiadavky — iba zmena spôsobu dopravy a platby

POST /api/order_in/save_shipping
X-API-KEY: {vas_api_kluc}
Content-Type: application/json

{ "data": { "receipt_id": 45, "shipping_id": 3, "paymod_id": 2 } }

Príklad požiadavky — zmena spôsobu dopravy + aktualizácia adresy

POST /api/order_in/save_shipping
X-API-KEY: {vas_api_kluc}
Content-Type: application/json

{ "data": { "receipt_id": 45, "shipping_id": 3, "paymod_id": 2, "partner_address_id": 12, "country_id": 1, "zip": "1051", "city": "Budapest", "address": "Vörösmarty tér", "address_number": "7", "district": "V" } }

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