Přístup ke kategoriím produktů

GET /api/categories

Získání kategorií produktů z databáze.

Požadavek

Příklad: /api/categories?orderBy=name&desc=true
Získá kategorie produktů dle názvu.

Odpověď (application/json)

200 OK

Stránka se záznamy typu category.

{
  "items": [
    {
      "catCode": "chl",
      "name": "Chleby",
      "parent": "pec",
      /* ... */
    }
    /* ... */
  ]
}

POST /api/categories

Vytvoření nové kategorie.

Požadavek (application/json)

Tělo požadavku musí být JSON objekt, reprezentující novou kategorii. Musí obsahovat parametr catCode a name, identifikátor a název nové kategorie.

Odpověď (application/json)

201 OK CREATED

Tělo odpovědi bude tatáž kategorie, ale už v podobě, jaká byla zapsána do databáze.

V http hlavičce Location bude URL k získání kategorie v pozdějších dotazech.

400 BAD REQUEST

Zaslaný objekt neprošel validací a nemůže být zapsán do databáze. Tělo obsahuje standardní chybový JSON s popisem nalezených chyb.

GET /api/categories/{catCode}

Získání jednoho skladu s konkrétním catCode. CatCode je v InTouch CRM text, takže požadavkem:

GET /api/categories/chle

získáte kategorii s kódem chle (pokud taková existuje).

Odpověď (application/json)

200 OK

Tělo odpovědi bude category s požadovaným catCode.

404 NOT FOUND

Požadovaná kategorie v databázi neexistuje.

PUT /api/categories/{catCode}

Aktualizace kategorie. Existující kategorie s catCode catCode bude přepsána daty v těle požadavku.

Požadavek (application/json)

Tělo požadavku musí být JSON objekt, reprezentující novou kateogrii.

Odpověď (application/json)

200 OK

Tělo odpovědi bude nová verze kategorie, jak ji systém zapsal do databáze.

400 BAD REQUEST

Zaslaný objekt neprošel validací a nemůže být zapsán do databáze. Tělo obsahuje standardní chybový JSON s popisem nalezených chyb.

404 NOT FOUND

Aktualizovaná kategorie v databázi neexistuje.

PATCH /api/categories/{catCode}

Aktualizace kategorie. Existující kategorie s catCode catCode bude aktualizována pomocí dat v těle požadavku. Na rozdíl od předchozího volání metodou PUT nemusíte u metody PATCH zasílat kompletní JSON s kategorií, ale stačí poslat jen ty údaje, které chcete změnit.

Příklad:

    PATCH /api/category/chle

    { "name": "Chlebové pečivo" }

U kategorie s kódem chle dojde ke změně názvu na "Chlebové pečivo".

Odpověď (application/json)

200 OK

Tělo odpovědi bude nová verze kategorie, jak ji systém zapsal do databáze.

400 BAD REQUEST

Zaslaný objekt neprošel validací a nemůže být zapsán do databáze. Tělo obsahuje standardní chybový JSON s popisem nalezených chyb.

404 NOT FOUND

Aktualizovaná kategorie v databázi neexistuje.