Shop Administrace Aktivace Byznys Programu

Produkty

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

/products

Vrátí všechny produkty daného eshopu.

Dostupné GET parametry

Parametr Povinný Popis
shopId Ano ID eshopu
id Ne ID produktu
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 produktu",
            "description": "Popis produktu.",
            "description_html": "<p>Popis produktu s <strong>HTML</strong>.</p>",
            "code": null,
            "ean": null,
            "available": true,
            "main_image_id": 1,
            "manufacturer": null,
            "variants": [
                {
                    "id": 1,
                    "code": "TE14357956",
                    "parameter": "",
                    "value": "",
                    "price": 123,
                    "price_vat": 149,
                    "wholesale_price": 44.6256,
                    "wholesale_price_vat": 54,
                    "vat": 21,
                    "quantity": 1,
                    "available": true
                }
            ],
            "images": [
                {
                    "id": 1,
                    "url": "https://domena.tld/url_obrazku.jpg"
                }
            ],
            "categories": [
                1
            ],
            "restrictions": [
                {
                    "id": 1,
                    "name": "NSFW"
                }
            ]
        }
    ]
}            

Popis parametrů odpovědi

Parametr Typ Popis
id int ID produktu
name string Název
description string Popis
description_html string Popis s HTML
code string|null Kód produktu
ean string|null EAN kód produktu
available bool Dostupnost produktu
main_image_id int|null ID hlavního obrázku
manufacturer string|null Výrobce
variants Variant[] Varianty (velikostní, barevné aj.)
images array Obrázky
categories array ID kategorií
restrictions array Restrikce (NSFW, Neklopit, Zbraně, Alkohol, aj.)

Popis parametrů typu Variant

Parametr Typ Popis
id int ID varianty
code string Kód
parameter string Název parametru (např. barva)
value string Název varianty (např. červená)
price float Cena bez DPH
price_vat float Cena včetně DPH
wholesale_price float VOC bez DPH
wholesale_price_vat float VOC včetně DPH
vat int Sazba DPH
quantity int Počet kusů skladem
available bool Dostupnost
/products/availability

Vrátí dostupnost jednotlivých variant produktů.

Dostupné GET parametry

Parametr Povinný Popis
shopId Ano ID eshopu
id Ne ID varianty
productId Ne ID produktu (vrátí jeho varianty)
offset Ne Místo, od kterého budou záznamy vráceny. Výchozí = 0
limit Ne Počet vrácených záznamů

Ukázková odpověď

{
  "code": 200,
  "message": "",
  "data": [
    {
      "id": 1,
      "available": true,
      "availability_type": "Skladem - Expedice ihned",
      "quantity": 12,
      "delivery_date": 3
    },
    {
      "id": 2,
      "available": false,
      "availability_type": "Není skladem",
      "quantity": 0,
      "delivery_date": null
    }
  ]
}            

Popis parametrů odpovědi

Parametr Typ Popis
id int ID varianty produktu
available bool Dostupnost
availability_type string Typ dostupnosti
quantity int Počet kusů skladem
delivery_date int|null Termín dodání (počet dní)

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