Kategorie
Požadavky
Všechny API požadavky musí dodržovat následující formát:
GET /CESTA
Authorization: Váš API token
Accept: application/json
Dostupné požadavky
/categories
Vrátí všechny kategorie daného eshopu.
Dostupné GET parametry
| Parametr | Povinný | Popis |
|---|---|---|
shopId |
Ano | ID eshopu |
id |
Ne | ID kategorie |
offset |
Ne | Místo, od kterého budou záznamy vraceny. Výchozí = 0 |
limit |
Ne | Počet vrácených záznamů |
Ukázková odpověď
{
"code": 200,
"message": "",
"data": [
{
"id": 1,
"name": "Název hlavní kategorie 1",
"alt_name": "Alternativní název",
"description": "Popis",
"meta_description": "Popis do meta hlaviček",
"parent": 0
},
{
"id": 2,
"name": "Podkategorie 1",
"alt_name": "Alternativní název",
"description": "Popis",
"meta_description": "Popis do meta hlaviček",
"parent": 1
}
]
}
Popis parametrů odpovědi
| Parametr | Typ | Popis |
|---|---|---|
id |
int | ID kategorie |
name |
string | Název |
alt_name |
string | Alternativní název |
description |
string | Popis |
meta_description |
string | Popis do HTML meta hlavičky |
parent |
int | ID nadřazené kategorie |
Odpovědi
Všechny odpovědi API jsou ve formátu JSON a mají následjící formát:
{
"code": 200,
"message": "",
"data": []
}
Popis parametrů odpovědi
| Parametr | Typ | Popis |
|---|---|---|
code |
int | Odpovídá kódům HTTP protokolu (tedy kód 200 znamená OK apod.) |
message |
string | Chybová hláška, neprázdná pouze v případě chyby (kód odlišný od 200) |
data |
array | Konkrétní data |