Category

Please see the Breaking changes page for more info on the planned changes in validation.

Category schema

id long? Category ID - cannot be null in PUT/PATCH methods šŸ“¶ EQUALS,ENUM šŸ”½ NONE

_cloudId integer Cloud ID

_defaultCourseId long? Course ID šŸ“¶ EQUALS,ENUM

_eetSubjectId long? EET Subject ID šŸ“¶ EQUALS,ENUM šŸ”½ NONE

deleted boolean Category deleted - cannot be true in POST/PUT/PATCH methods šŸ“¶ EQUALS, ENUM šŸ”½ BOTH

display boolean Category displayed šŸ“¶ EQUALS, ENUM šŸ”½ BOTH

externalId string? External ID šŸ“¶ EQUALS,ENUM šŸ”½ NONE

flags long Category flags šŸ“¶ BITS šŸ”½ NONE

hexColor string(7) Category color

margin string?(180) Category margin

maxDiscount double? Max discount

modifiedBy string?(32) Category modified by

name string(180) Category name šŸ“¶ STRING šŸ”½ BOTH

sortOrder long? Category sort order šŸ”½ BOTH

tags string[]? Tags list for employee šŸ“¶ EQUALS, ENUM

translatedName map<string, string>? A mapping of language codes to translated category names. šŸ”½ NONE

vat double? VAT value (a multiplier from range <1.0; 2.0>, f.e. vat=1.234 corresponds to VAT 23.4%)

For VAT payers this value is validated and it must correspond to one of the configured VAT rates.

versionDate timestamp? Last modification date and time šŸ“¶ EQUALS, ENUM, NUMBER šŸ”½ BOTH

Category response

{
    "_cloudId": <integer>,
    "_defaultCourseId": <long>,    
    "_eetSubjectId": <long>,
    "deleted": <boolean>,
    "display": <boolean>,
    "externalId": <string>,
    "flags": <long>,
    "hexColor": <string>,
    "id": <long>,
    "margin": <string>,
    "maxDiscount": <double>,
    "modifiedBy": <string>,
    "name": <string>,
    "sortOrder": <long>,
    "tags": <string[]>,
    "translatedName": <map<string, string>>,
    "vat": <double>,
    "versionDate": <timestamp>
}

Category flags

Bit

Name

8

FISCALIZATION_DISABLED

Get categories

GET https://api.dotykacka.cz/v2/clouds/:cloudId/categories

Path Parameters

NameTypeDescription

cloudId*

integer

Query Parameters

NameTypeDescription

page

integer

limit

integer

filter

string

sort

string

Headers

NameTypeDescription

If-None-Match

string

ETag to return results only if changed.

Authorization*

string

Bearer accessToken

[
    {
        Category response schema
    },
    ...
]

Get category

GET https://api.dotykacka.cz/v2/clouds/:cloudId/categories/:categoryId

Path Parameters

NameTypeDescription

categoryId*

integer

cloudId*

integer

Headers

NameTypeDescription

If-None-Match

string

ETag to return results only if changed.

Authorization*

string

Bearer accessToken

Create category

POST https://api.dotykacka.cz/v2/clouds/:cloudId/categories

Path Parameters

NameTypeDescription

cloudId*

integer

Headers

NameTypeDescription

Authorization*

string

Bearer accessToken

Request Body

NameTypeDescription

array

Array of categories. Maximum size 100.

// Body request minimmum
[
	{		
		"_cloudId":  <integer>,
    "deleted": <boolean>,
    "display": <boolean>,
    "flags": <short>,
    "hexColor": <string>,
    "name": <string>
		... Optional is category schema
	}	
]

Replace or create categories

PUT https://api.dotykacka.cz/v2/clouds/:cloudId/categories

Path Parameters

NameTypeDescription

cloudId*

integer

Headers

NameTypeDescription

If-Match

string

ETag to update only if not changed.

Authorization*

string

Bearer accessToken

Request Body

NameTypeDescription

array

Array of categories. Maximum size 100.

// Body request minimmum
[
  {	
    "_cloudId":  <integer>,
    "deleted": <boolean>,
    "display": <boolean>,
    "flags": <short>,
    "hexColor": <string>,
    "id": <long>,
    "name": <string>		
  	... Optional is category schema
  }
]

Replace or create category

PUT https://api.dotykacka.cz/v2/clouds/:cloudId/categories/:categoryId

Path Parameters

NameTypeDescription

categoryId*

integer

cloudId*

integer

Headers

NameTypeDescription

If-Match

string

ETag to update only if not changed.

Authorization*

string

Bearer accessToken

Request Body

NameTypeDescription

object

Category

// Body request minimmum
{	
  "_cloudId":  <integer>,
  "deleted": <boolean>,
  "display": <boolean>,
  "flags": <short>,
  "hexColor": <string>,
  "id": <long>,
  "name": <string>	
	... Optional is category schema
}

Partial update of category

PATCH https://api.dotykacka.cz/v2/clouds/:cloudId/categories/:categoryId

Path Parameters

NameTypeDescription

categoryId*

integer

cloudId*

integer

Headers

NameTypeDescription

If-Match*

string

ETag to update only if not changed.

Authorization*

string

Bearer accessToken

Delete category

DELETE https://api.dotykacka.cz/v2/clouds/:cloudId/categories/:categoryId

Category cannot contains any non-deleted products (deleted=false). Only empty category can be deleted. Move products from category via GET/PUT methods. For GET method usefilter=deleted|eq|false;_categoryId|eq|:categoryId

Path Parameters

NameTypeDescription

categoryId*

integer

cloudId*

integer

Headers

NameTypeDescription

If-Match

string

ETag ignored (temporarily) when deleting an entity.

Authorization*

string

Bearer accessToken

Options categories

OPTIONS https://api.dotykacka.cz/v2/clouds/:cloudId/categories

Path Parameters

NameTypeDescription

cloudId*

integer

Headers

NameTypeDescription

Authorization*

string

Bearer accessToken

Options category

OPTIONS https://api.dotykacka.cz/v2/clouds/:cloudId/categories/:categoryId

Path Parameters

NameTypeDescription

categoryId*

integer

cloudId*

integer

Headers

NameTypeDescription

Authorization*

string

Bearer accessToken

Last updated