Alap URL
https://{tenant}.logzi.com/api/product/
Minden kérés JSON választ ad vissza. Sikeres válasz esetén result.code == 1, hiba esetén result.code == 0.
/api/product/get
Egyetlen termék lekérése azonosító, cikkszám vagy vonalkód alapján, teljes részletekkel.
Query paraméterek
| Paraméter | Típus | Kötelező | Leírás |
|---|---|---|---|
id |
int | A termék egyedi azonosítója (vagy használd a partnumber paramétert helyette) |
|
partnumber |
string | Cikkszám szerinti keresés (ha id nincs megadva) |
|
barcode |
string | Vonalkód szerinti keresés | |
store_id |
int | Raktár azonosítója — készletinformáció visszaadásához |
Példa kérés
GET /api/product/get?id=42&store_id=1
X-API-KEY: {az_api_kulcsod}
Példa válasz
{
"result": { "code": 1, "message": "success" },
"data": {
"id": 42,
"partnumber": "TERM-0042",
"name": "Minta termék",
"unit_name": "db",
"tax_name": "27%",
"price": 5000,
"price_brutto": 6350,
"weight": 0.5,
"status_id": 1,
"stock": 120
}
}
/api/product/get_stock
Termék készletinformációjának lekérése raktáranként.
Query paraméterek
| Paraméter | Típus | Kötelező | Leírás |
|---|---|---|---|
id |
int | A termék azonosítója | |
partnumber |
string | Cikkszám szerinti keresés (alternatíva az id helyett) |
|
list_condition[store_id] |
int | Szűrés adott raktárra |
Példa kérés
GET /api/product/get_stock?id=42&list_condition[store_id]=1
X-API-KEY: {az_api_kulcsod}
Példa válasz
{
"result": { "code": 1, "message": "success" },
"data": [
{
"store_id": 1,
"store_name": "Főraktár",
"stock": 120,
"stock_reserved": 5
}
]
}
/api/product/list
Termékek lapozható listájának lekérése szűrési lehetőségekkel.
Query paraméterek
| Paraméter | Típus | Kötelező | Leírás |
|---|---|---|---|
list_offset |
int | Lapozás eltolása (alapértelmezett: 0) | |
list_count |
int | Oldalankénti találatok száma (alapértelmezett: 10) | |
list_condition[partnumber] |
string | Szűrés cikkszámra (LIKE) | |
list_condition[name] |
string | Szűrés terméknévre (LIKE) | |
list_condition[product_category_id] |
int | Szűrés termék kategória ID-re | |
list_condition[status_id] |
int | Szűrés státuszra (1=aktív, 2=inaktív) | |
list_condition[store_id] |
int | Raktárkészlet szűrés — csak az adott raktárban elérhető termékek |
Példa kérés
GET /api/product/list?list_offset=0&list_count=20&list_condition[status_id]=1
X-API-KEY: {az_api_kulcsod}
Példa válasz
{
"result": { "code": 1, "message": "success" },
"data": [
{
"id": 42,
"partnumber": "TERM-0042",
"name": "Minta termék",
"unit_name": "db",
"price": 5000,
"price_brutto": 6350,
"status_id": 1
}
],
"params": {
"list_count": 20,
"list_offset": 0,
"list_all": 158
}
}
/api/product/save
Termék létrehozása vagy módosítása. Új termékhez data[id] = 0, módosításhoz a meglévő ID-t add meg.
POST mezők — data objektum
| Mező | Típus | Kötelező | Leírás |
|---|---|---|---|
id |
int | 0 = új termék, >0 = módosítás | |
partnumber |
string | Cikkszám (egyedi) | |
name |
string | Terméknév | |
product_type_id |
int | Termék típus azonosítója | |
unit_id |
int | Mértékegység azonosítója | |
tax_id |
int | ÁFA kulcs azonosítója | |
price |
decimal | Nettó ár | |
price_brutto |
decimal | Bruttó ár | |
weight |
decimal | Tömeg (kg) | |
description |
string | Termékleírás | |
store_id |
int | Alapértelmezett raktár azonosítója | |
status_id |
int | Státusz (1=aktív, 2=inaktív) |
Példa kérés
POST /api/product/save
X-API-KEY: {az_api_kulcsod}
Content-Type: application/json
{
"data": {
"id": 0,
"partnumber": "TERM-0099",
"name": "Új termék",
"unit_id": 1,
"tax_id": 2,
"price": 5000,
"price_brutto": 6350,
"status_id": 1
}
}
Példa válasz
{
"result": { "code": 1, "message": "success" },
"data": {
"id": 99,
"partnumber": "TERM-0099"
}
}
/api/product/delete
Termék törlése. Csak olyan termék törölhető, amelyhez nem tartozik készletmozgás.
POST mezők — data objektum
| Mező | Típus | Kötelező | Leírás |
|---|---|---|---|
id |
int | A törlendő termék azonosítója |
Példa kérés
POST /api/product/delete
X-API-KEY: {az_api_kulcsod}
Content-Type: application/json
{
"data": {
"id": 42
}
}
Példa válasz
{
"result": { "code": 1, "message": "success" },
"data": {}
}
Érdeklődsz a szoftverünkkel kapcsolatban, írj bátran!
Ha nem találod a választ és szükséged van segítségre
Regisztrációdat hozd létre most,
fizess később!