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 - Field is deprecated use _sourceOrderId ๐Ÿ“ถ EQUALS,ENUM

_sellerId long? Seller ๐Ÿ“ถ EQUALS,ENUM

_sourceOrderId long? Order ๐Ÿ“ถ 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. ๐Ÿ“ถ EQUALS,ENUM

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?

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>,
"_sourceOrderId": <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>,
"merchantPrintData": <string>,
"note": <string>,
"paid": <boolean>,
"parked": <boolean>,
"pkp": <string>,
"points": <double>,
"printData": <string>,
"status": <enum>,
"tags": <string[]>,
"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
โ€‹