Category

Category schema

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

_cloudId integer Cloud​

_defaultCourseId long? Course πŸ“Ά 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 short 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

tags string[]? Tags list for employee πŸ“Ά EQUALS, ENUM

vat double? Vat rate 1.21 = 21%

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

Category response

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

Category flags

Bit

Name

8

FISCALIZATION_DISABLED

get
Get categories

https://api.dotykacka.cz/v2/clouds/:cloudId/categories
Request
Response
Request
Path Parameters
cloudId
required
integer
​
Headers
If-None-Match
optional
string
ETag to return results only if changed.
Authorization
required
string
Bearer accessToken
Query Parameters
page
optional
integer
​
limit
optional
integer
​
filter
optional
string
​
sort
optional
string
​
Response
200: OK
JSON
JSON
[
{
Category response schema
},
...
]
400: Bad Request
​
404: Not Found
​

get
Get category

https://api.dotykacka.cz/v2/clouds/:cloudId/categories/:categoryId
Request
Response
Request
Path Parameters
categoryId
required
integer
​
cloudId
required
integer
​
Headers
If-None-Match
optional
string
ETag to return results only if changed.
Authorization
required
string
Bearer accessToken
Response
200: OK
​
400: Bad Request
​
404: Not Found
​

post
Create category

https://api.dotykacka.cz/v2/clouds/:cloudId/categories
Request
Response
Request
Path Parameters
cloudId
required
integer
​
Headers
If-Match
required
string
""ETag""
Authorization
required
string
Bearer accessToken
Body Parameters
required
array
Array of categories. Maximum size 100.
Response
200: OK
​
400: Bad Request
​
// Body request minimmum
[
{
"_cloudId": <integer>,
"deleted": <boolean>,
"display": <boolean>,
"flags": <short>,
"hexColor": <string>,
"name": <string>
... Optional is category schema
}
]

put
Replace or create categories

https://api.dotykacka.cz/v2/clouds/:cloudId/categories
Request
Response
Request
Path Parameters
cloudId
required
integer
​
Headers
If-Match
required
string
ETag to update only if not changed.
Authorization
required
string
Bearer accessToken
Body Parameters
required
array
Array of categories. Maximum size 100.
Response
200: OK
​
400: Bad Request
​
// Body request minimmum
[
{
"_cloudId": <integer>,
"deleted": <boolean>,
"display": <boolean>,
"flags": <short>,
"hexColor": <string>,
"id": <long>,
"name": <string>
... Optional is category schema
}
]

put
Replace or create category

https://api.dotykacka.cz/v2/clouds/:cloudId/categories/:categoryId
Request
Response
Request
Path Parameters
categoryId
required
integer
​
cloudId
required
integer
​
Headers
If-Match
required
string
ETag to update only if not changed.
Authorization
required
string
Bearer accessToken
Body Parameters
required
object
Category
Response
200: OK
​
400: Bad Request
​
// Body request minimmum
{
"_cloudId": <integer>,
"deleted": <boolean>,
"display": <boolean>,
"flags": <short>,
"hexColor": <string>,
"id": <long>,
"name": <string>
... Optional is category schema
}

patch
Partial update of category

https://api.dotykacka.cz/v2/clouds/:cloudId/categories/:categoryId
Request
Response
Request
Path Parameters
categoryId
required
integer
​
cloudId
required
integer
​
Headers
If-Match
required
string
ETag to update only if not changed.
Authorization
required
string
Bearer accessToken
Response
200: OK
​
400: Bad Request
​

delete
Delete category

https://api.dotykacka.cz/v2/clouds/:cloudId/categories/:categoryId
Category cannot contains any products (include deleted=true). Only empty category can be deleted. Move products from category via GET/PUT methdos. For GET method use filter=deleted|in|true,false;_categoryId|eq|:categoryId
Request
Response
Request
Path Parameters
categoryId
required
integer
​
cloudId
required
integer
​
Headers
If-Match
optional
string
ETag ignored (temporarily) when deleting an entity.
Authorization
required
string
Bearer accessToken
Response
200: OK
​
409: Conflict
​

options
Options categories

https://api.dotykacka.cz/v2/clouds/:cloudId/categories
Request
Response
Request
Path Parameters
cloudId
required
integer
​
Headers
Authorization
required
string
Bearer accessToken
Response
200: OK
​

options
Options category

https://api.dotykacka.cz/v2/clouds/:cloudId/categories/:categoryId
Request
Response
Request
Path Parameters
categoryId
required
integer
​
cloudId
required
integer
​
Headers
Authorization
required
string
Bearer accessToken
Response
200: OK
​

​