Registrácia Prihlásenie

API kompletizácie

Správa dokladov kompletizácie — získavanie, vytváranie, úprava, uzavretie a evidencia spotrebovaných súčiastok na úrovni položiek

Koncové body kompletizácie

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

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/assembly/get

Získanie jedného dokladu kompletizácie na základe identifikátora, spolu s príslušnými spotrebovanými súčiastkami.

Query parametre

Parameter Typ Povinné Popis
id int Jedinečný identifikátor dokladu kompletizácie

Príklad požiadavky

GET /api/assembly/get?id=5
X-API-KEY: {vas_api_kluc}

Príklad odpovede

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "id": 5,
    "identify": "ASM-2024-0005",
    "date_create": "2024-05-08 09:00:00",
    "status_id": 1,
    "store_id": 1,
    "product_id": 42,
    "quantity": 10,
    "company_user_name": "Kovács Péter",
    "item": [
      {
        "product_id": 12,
        "quantity": 20,
        "store_id": 1,
        "store_locality_id": null
      }
    ]
  }
}
GET /api/assembly/list

Stránkovateľné získanie zoznamu dokladov kompletizácie s možnosťami filtrovania.

Query parametre

Parameter Typ Povinné Popis
list_offset int Posun stránkovania (predvolené: 0)
list_condition[identify] string Filtrovanie podľa identifikátora dokladu (LIKE)
list_condition[status_id] int Filtrovanie podľa stavu (1=otvorená, 2=uzavretá)
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/assembly/list?list_offset=0&list_condition[status_id]=1
X-API-KEY: {vas_api_kluc}

Príklad odpovede

{
  "result": { "code": 1, "message": "success" },
  "data": [
    {
      "id": 5,
      "identify": "ASM-2024-0005",
      "date_create": "2024-05-08",
      "status_name": "Nyitott",
      "product_id": 42,
      "quantity": 10,
      "company_user_name": "Kovács Péter"
    }
  ],
  "params": {
    "list_count": 10,
    "list_offset": 0,
    "list_all": 3
  }
}
POST /api/assembly/save

Vytvorenie alebo úprava dokladu kompletizácie. Je potrebné uviesť cieľový sklad, skompletizovaný produkt, vyrobené množstvo a pole spotrebovaných súčiastok. Pre nový doklad uveďte data[id] = 0.

POST polia — objekt data

Pole Typ Povinné Popis
id int 0 = nový doklad, >0 = úprava
company_id int Identifikátor firmy
company_user_id int Identifikátor zodpovedného pracovníka
company_address_id int Identifikátor prevádzky
store_id int Identifikátor cieľového skladu (sem sa uloží skompletizovaný produkt)
product_id int Identifikátor skompletizovaného (hotového) produktu
quantity decimal Vyrobené (zhotovené) množstvo
comment_bottom string Interná poznámka
item array Pole spotrebovaných súčiastok — aspoň jedna položka je povinná (pozri nižšie)

Polia položky — data[item][] (spotrebované súčiastky)

Pole Typ Povinné Popis
product_id int Identifikátor spotrebovanej súčiastky (produktu)
quantity decimal Spotrebované množstvo
store_id int Identifikátor zdrojového skladu (odkiaľ sa súčiastka odoberá)
store_locality_id int Identifikátor skladového miesta
remove int 1 = zmazanie položky pri úprave

POST polia — objekt params (voliteľné)

Pole Typ Povinné Popis
close int 1 = automatické uzavretie po uložení

Príklad požiadavky

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

{
  "data": {
    "id": 0,
    "company_id": 1,
    "company_user_id": 3,
    "store_id": 1,
    "product_id": 42,
    "quantity": 10,
    "item": [
      {
        "product_id": 12,
        "quantity": 20,
        "store_id": 1
      },
      {
        "product_id": 15,
        "quantity": 10,
        "store_id": 1,
        "store_locality_id": 3
      }
    ]
  },
  "params": {
    "close": 0
  }
}

Príklad odpovede

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "id": 6,
    "identify": "ASM-2024-0006"
  }
}
POST /api/assembly/delete

Zmazanie dokladu kompletizácie. Zmazať možno len otvorený doklad (status_id = 1).

POST polia — objekt data

Pole Typ Povinné Popis
receipt_id int Identifikátor dokladu určeného na zmazanie

Príklad požiadavky

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

{
  "data": {
    "receipt_id": 5
  }
}

Príklad odpovede

{
  "result": { "code": 1, "message": "success" },
  "data": {}
}
POST /api/assembly/close

Uzavretie otvoreného dokladu kompletizácie. Uzavretím sa vykoná skladový pohyb: odpočítajú sa spotrebované súčiastky a pripíše sa skompletizovaný produkt na cieľovom sklade. Uzavrieť možno len doklad so status_id = 1 (otvorený).

POST polia — objekt data

Pole Typ Povinné Popis
receipt_id int Identifikátor dokladu určeného na uzavretie

Príklad požiadavky

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

{
  "data": {
    "receipt_id": 5
  }
}

Príklad odpovede

{
  "result": { "code": 1, "message": "success" },
  "data": {}
}

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