Order

Order schema

_branchId integer Branch ID šŸ“¶ EQUALS,ENUM

_cloudId integer Cloud ID šŸ“¶ EQUALS,ENUM

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

_customerId long? Customer ID šŸ“¶ EQUALS,ENUM

_eetSubjectId long? EET subject ID šŸ“¶ EQUALS,ENUM

_employeeId long? Employee ID šŸ“¶ EQUALS,ENUM

_relatedInvoiceId long? Order ID šŸ“¶ EQUALS,ENUM

_relatedOrderId long? Order ID - Field is deprecated use _sourceOrderId šŸ“¶ EQUALS,ENUM

_sellerId long? Seller ID šŸ“¶ EQUALS,ENUM

_sourceOrderId long? Order ID šŸ“¶ EQUALS,ENUM

_tableId long? Table ID šŸ“¶ 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 šŸ“¶ EQUALS,ENUM, STRING

documentType enum Type of Order. šŸ“¶ EQUALS,ENUM

externalId string? Id of external application (custom ID) šŸ“¶ EQUALS,ENUM

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 šŸ“¶ STRING

paid boolean Paid status šŸ“¶ EQUALS, ENUM

parked boolean Parked status šŸ“¶ EQUALS, ENUM

pkp string? Only for fiscalized Order

points double Points value for Order šŸ“¶ EQUALS, NUMBER

printData string Data for printer

status enum Order status šŸ“¶ EQUALS, ENUM

tags string[]? Tags for a Order šŸ“¶ EQUALS, ENUM

tipAmount double? Expected tip amount for the order

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
EXTERNAL_INVOICE_PAYMENT
CASH_IN
CASH_OUT

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[]>,
    "tipAmount": <double>?,
    "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 orders

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

Path Parameters

NameTypeDescription

cloudId*

integer

Query Parameters

NameTypeDescription

include

array

Include other entities [1]

namedFilter

string

Named filters [2]

sort

string

filter

string

page

integer

limit

integer

Headers

NameTypeDescription

If-None-Match

string

ETag to return results only if changed.

Authorization*

string

Bearer accessToken

[
 {
  // 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 order

GET https://api.dotykacka.cz/v2/clouds/:cloudId/orders/:orderId

Path Parameters

NameTypeDescription

orderId*

integer

cloudId*

integer

Headers

NameTypeDescription

If-None-Match

string

ETag to return results only if changed.

Authorization*

string

Bearer accessToken

{
    // order schema
}

Options orders

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

Path Parameters

NameTypeDescription

cloudId*

integer

Headers

NameTypeDescription

Authorization*

string

Bearer accessToken

Options order

OPTIONS https://api.dotykacka.cz/v2/clouds/:cloudId/orders/:orderId

Path Parameters

NameTypeDescription

orderId*

integer

cloudId*

integer

Headers

NameTypeDescription

Authorization*

string

Bearer accessToken

Last updated