API stavov objednávky odberateľa

Správa vlastných stavov objednávky odberateľa

Základná URL

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

Každá požiadavka vracia JSON odpoveď. Pri úspešnej odpovedi je result.code == 1, pri chybe result.code == 0. Stav objednávky odberateľa určuje vlastné stavy pracovného postupu objednávok odberateľa — s prispôsobiteľným názvom, farbou a logikou vystavenia faktúry. Tieto stavy je možné označiť na doklade objednávky odberateľa.

GET /api/order_in_customer_status/get

Získanie jedného stavu odberateľa podľa identifikátora.

Parametre dotazu

ParameterTypPovinnéPopis
idintIdentifikátor stavu

Príklad požiadavky

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

Zoznam všetkých stavov objednávky odberateľa.

Nie je potrebný žiadny parameter — vráti všetky stavy.

Príklad požiadavky

GET /api/order_in_customer_status/list
X-API-KEY: {vas_api_kluc}
POST /api/order_in_customer_status/save

Vytvorenie alebo úprava stavu odberateľa. Pre nový stav data[id] = 0.

POST polia — objekt data

PoleTypPovinnéPopis
idint0 = nový stav, >0 = úprava
customer_status_namestringNázov stavu (napr. „Pripravuje sa")
customer_status_colorstringHexadecimálny kód farby (napr. #3498db)
customer_status_keystringJedinečné kľúčové slovo (napr. in_progress)
customer_status_invoiceint1 = v tomto stave je možné vystaviť faktúru
customer_status_sortintPoradie zoradenia

Príklad požiadavky

POST /api/order_in_customer_status/save
X-API-KEY: {vas_api_kluc}
Content-Type: application/json

{
  "data": {
    "id": 0,
    "customer_status_name": "Előkészítés alatt",
    "customer_status_color": "#f39c12",
    "customer_status_key": "preparing",
    "customer_status_invoice": 0,
    "customer_status_sort": 2
  }
}
POST /api/order_in_customer_status/delete

Odstránenie stavu objednávky odberateľa podľa identifikátora.

POST polia — objekt data

PoleTypPovinnéPopis
idintIdentifikátor stavu, ktorý sa má odstrániť

Príklad požiadavky

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

{ "data": { "id": 1 } }

Kontaktuj nás

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

Potrebuješ pomoc?

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

Zaregistruj sa teraz,
zaplať neskôr!

Vyskúšaj 3 dni zadarmo, bez rizika a záväzkov!