Přístup k ceníkům

GET /api/pricelists

Získání ceníků z databáze.

Požadavek

Příklad: /api/pricelists?orderBy=name
Získá ceníky seřazené dle abecedy.

Odpověď (application/json)

200 OK

Stránka se záznamy typu pricelist.

{
  "items": [
    {
		"id": 2,
		"name": "Black Friday",
		"active": true,
		"def": false,
		"currency": "CZK",
		"percent": 15  
	}
    /* ... */
  ]
}

POST /api/pricelists

Vytvoření nového ceníku.

Požadavek (application/json)

Tělo požadavku musí být JSON objekt, reprezentující nový ceník. Neměl by obsahovat parametr id. ID bude přiděleno při úspěšném zápisu.

Odpověď (application/json)

201 OK CREATED

Tělo odpovědi bude tentýž ceník, ale už v podobě, jak byl zapsán do databáze a s přiděleným kódem.

V http hlavičce Location bude URL k získání ceníku 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/pricelists/{id}

Získání jednoho ceníku s konkrétním ID. ID je v InTouch CRM celé číslo, takže požadavkem:

GET /api/pricelists/15

získáte ceník s kódem 15 (pokud takový existuje).

Odpověď (application/json)

200 OK

Tělo odpovědi bude ceník s požadovaným ID.

404 NOT FOUND

Požadovaný ceník v databázi neexistuje.

PUT /api/pricelists/{id}

Aktualizace ceníku. Existující ceník s ID id bude přepsán daty v těle požadavku.

Požadavek (application/json)

Tělo požadavku musí být JSON objekt, reprezentující nový ceník.

Odpověď (application/json)

200 OK

Tělo odpovědi bude nová verze ceníku, 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ý ceník v adresáři neexistuje.

PATCH /api/pricelists/{id}

Aktualizace ceníku. Existující ceník s ID id bude aktualizován 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 ceníkem, ale stačí poslat jen ty údaje, které chcete změnit.

Příklad:

    PATCH /api/pricelists/15

    { "currency": "EUR" }

U ceníku s kódem 15 dojde ke změně měny na Eura - "EUR" .

Odpověď (application/json)

200 OK

Tělo odpovědi bude nová verze ceníku, 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ý ceník v adresáři neexistuje.

Práce s cenami /api/pricelists/{id}/prices

Zobrazení cen daného ceníku pro včechny produkty. Popis volání API je shodný s používáním připojených souborů ke kontaktům (/api/parties/{id}/files).