Order

Order schema

_branchId integer Branch πŸ“Ά EQUALS,ENUM

_cloudId integer Cloud πŸ“Ά EQUALS,ENUM

_courseId long? Course πŸ“Ά EQUALS,ENUM

_customerId long? Customer πŸ“Ά EQUALS,ENUM

_eetSubjectId long? EET subject πŸ“Ά EQUALS,ENUM

_employeeId long? Employee πŸ“Ά EQUALS,ENUM

_relatedInvoiceId long? Order πŸ“Ά EQUALS,ENUM

_relatedOrderId long? Order πŸ“Ά EQUALS,ENUM

_sellerId long? Seller πŸ“Ά EQUALS,ENUM

_tableId long? Table πŸ“Ά EQUALS,ENUM

bkp string? Only for fiscalized Order πŸ“Ά EQUALS,ENUM

canceledDate timestamp? Date of cancel Order πŸ“Ά EQUALS, ENUM, NUMBER πŸ”½ BOTH

completed timestamp? Order is completed. πŸ“Ά EQUALS, ENUM, NUMBER πŸ”½ BOTH

created timestamp Created date of Order πŸ“Ά EQUALS, ENUM, NUMBER πŸ”½ BOTH

currency string(3) Currency code

documentNumber string

documentType enum Type of Order.

externalId string? Id of external application (custom ID)

fik string? Only for fiscalized Order

flags integer Special settings for Order in binary form. πŸ“Ά BITS

id long Primary ID for Order

itemCount integer Count of items on Order

locationAccuracy double? Accuratcy for location from GPS

locationDate timestamp? Date of GPS location record πŸ“Ά EQUALS, ENUM, NUMBER πŸ”½ BOTH

locationLatitude double? Latitude value from GPS

locationLongitude double? Longitude value from GPS

merchantPrintData string?

_cloudId integer Cloud

discountPercent double(100) Represent percent value. Maximum value is 100 (100 = 100%)

display boolean Displayed πŸ“Ά EQUALS, ENUM πŸ”½ BOTH

externalId string πŸ“Ά EQUALS, ENUM

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

name string(100) Name for discount group πŸ“Ά EQUALS, ENUM

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

Discount group scheme

JSON
JSON
{
"_cloudId": <integer>,
"discountPercent": <double>,
"display": <boolean>,
"externalId": <string>,
"id": <long>,
"name": <string>,
"versionDate": <timestamp>
}

get
Get discount groups

https://api.dotykacka.cz/v2/clouds/:cloudId/discount-groups
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
[
{
Response schema
},
...
]
400: Bad Request
​
404: Not Found
​

get
Get discount group

https://api.dotykacka.cz/v2/clouds/:cloudId/discount-groups/:discountGroupId
Request
Response
Request
Path Parameters
discountGroupId
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 discount groups

https://api.dotykacka.cz/v2/clouds/:cloudId/discount-groups
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 discount groups. Maximum size 100.
Response
200: OK
​
400: Bad Request
​

put
Replace or create discount-groups

https://api.dotykacka.cz/v2/clouds/:cloudId/discount-groups
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 discount groups. Maximum size 100.
Response
200: OK
​
400: Bad Request
​

put
Replace or create discount group

https://api.dotykacka.cz/v2/clouds/:cloudId/discount-groups/:discountGroupId
Request
Response
Request
Path Parameters
discountGroupId
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
Discount gorup
Response
200: OK
​
400: Bad Request
​

patch
Partial update of discount group

https://api.dotykacka.cz/v2/clouds/:cloudId/discount-groups/:discountGroupId
Request
Response
Request
Path Parameters
discountGroupId
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
​

options
Options discount groups

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

options
Options discount group

https://api.dotykacka.cz/v2/clouds/:cloudId/discount-groups/:discountGroupId
Request
Response
Request
Path Parameters
discountGroupId
required
integer
​
cloudId
required
integer
​
Headers
Authorization
required
string
​
Response
200: OK
​

note string(1000)? Custom note for order

paid boolean Paid status πŸ“Ά EQUALS, ENUM

parked boolean Parked status πŸ“Ά EQUALS, ENUM

pkp string? Only for fiscalized Order

points double Points value for Order

printData string Data for printer

status enum Order status

tags string[]? Tags for a Order πŸ“Ά EQUALS, ENUM

totalValueRounded double Total rounded value for Orderd

updated timestamp Updated date πŸ“Ά EQUALS, ENUM, NUMBER πŸ”½ BOTH

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

order.documentType (enum)

// representation like string
RECEIPT, INVOICE, INVOICE_FROM_RECEIPTS,
CORRECTIVE_INVOICE

JSON response

{
"_branchId": <integer>,
"_cloudId": <integer>,
"_courseId": <long>,
"_customerId": <long>,
"_eetSubjectId": <long>,
"_employeeId": <long>,
"_relatedInvoiceId": <long>,
"_relatedOrderId": <long>,
"_sellerId": <long>,
"_tableId": <long>,
"bkp": <string>,
"canceledDate": <timestamp>,
"completed": <timestamp>,
"created": <timestamp>,
"currency": <string>,
"documentNumber": <string>,
"documentType": <enum>,
"externalId": <string>,
"fik": <string>,
"flags": <integer>,
"id": <long>,
"itemCount": <integer>,
"locationAccuracy": <double>,
"locationDate": <timestamp>,
"locationLatitude": <double>,
"locationLongitude": <double>,
"note": <string>,
"paid": <boolean>,
"parked": <boolean>,
"pkp": <string>,
"points": <double>,
"printData": <string>,
"status": <enum>,
"totalValueRounded": <double>,
"updated": <timestamp>,
"versionDate": <timestamp>
}

Order flags

Bit

Name

0

CANCELED_PART

1

CANCELED_FULL

2

CANCELLATION

3

FISCALIZATION_REQUIRED

4

MERGED

5

FISCALIZATION_DISABLED

6

PAID_PART

7

FISCALIZATION_SIMPLIFIED

8

VAT_PAYER

9

NON_VAT_PAYER

10

PDF_INVOICE

11

WRITEOFF

12

GASTRO

13

FISCALIZATION_FAILED

14

VAT_PRINT_DISABLED

15

LUNCH_INVITATION

16

DELIVERY

17

MOVED_FROM

18

MOVED_TO

get
Get orders

https://api.dotykacka.cz/v2/clouds/:cloudId/orders
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
include
optional
array
Include other entities [1]
namedFilter
optional
string
Named filters [2]
sort
optional
string
​
filter
optional
string
​
page
optional
integer
​
limit
optional
integer
​
Response
200: OK
[
{
// order schema
}
]

[1] The following entities can be included in the response:

  • orderItems - list of order items

  • moneyLogs - list of money logs

Multiple entities can be included at the same time, f.e.: include=orderItems,moneyLogs

Note that the client must have the proper permissions to read the included entity. The API2 will return HTTP error 403 Forbidden otherwise.

Response when other entities are included

{
// paging data
...
"data": [
{
// order fields
...
"orderItems": [
{
// order item fields
},
...
],
"moneyLogs": [
{
// money log fields
},
...
]
},
...
]
}

[2] The following named filters can be used:

  • openOrders - return open orders only

  • orderItems.openOrderItems - with include=orderItems filters open order items as well

Multiple named filters can be used at the same time, f.e.: namedFilter=openOrders;orderItems.openOrderItems

get
Get order

https://api.dotykacka.cz/v2/clouds/:cloudId/orders/:orderId
Request
Response
Request
Path Parameters
orderId
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
{
// order schema
}

options
Options orders

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

options
Options order

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