API
User Manual
  • Introduction to API v2
  • Guides
    • Getting started
    • Authorization
    • Delivery Notes Integrations
  • API Reference
    • General
      • Data types
        • Validation
        • Prices
      • Schema
      • Flags
      • ETags
        • ETag examples
      • Filtering
      • Sorting
      • Paging
      • Methods
      • HTTP Status Codes
    • Enums
      • Payment methods
      • Units
      • Order status
  • Entity
    • Attendance
    • Branch
    • Category
    • Cloud
    • Course
    • Customer
    • Customer Account
    • Customer Account Log
    • Daily Menu
    • Daily Menu Product
    • Delivery Note
    • Discount group
    • EET subject
    • Employee
    • Money log
    • Order
    • Order item
    • Product
    • Product Customization
    • Product Ingredient
    • Reservation
    • Stock Packaging
    • Supplier
    • Table
    • Tag
    • Tax (VAT rates)
    • Warehouse
    • Warehouse Branch
  • Others
    • Reports
      • Base Sales Report
    • POS actions
    • Release notes
    • Breaking changes
    • Webhook
    • Third-party libraries
  • Migration
    • Migrating from API v1
    • API v1 Services
      • Branch Service
      • Category Service
      • Customer Service
      • Employee Service
      • OAuth2 Login Service
      • POS action service
      • Product Service
      • Reservation Service
      • Sale Service
      • Stock Service
      • Supplier Service
      • Tableseat Service
      • Tag Service
      • Warehouse Service
Powered by GitBook
On this page
  • Order schema
  • Order flags
  • Get orders
  • Get order
  • Options orders
  • Options order

Was this helpful?

Export as PDF
  1. Entity

Order

PreviousMoney logNextOrder item

Last updated 2 months ago

Was this helpful?

Order schema

_branchId integer 📶 EQUALS,ENUM

_cloudId integer 📶 EQUALS,ENUM

_courseId long? 📶 EQUALS,ENUM

_customerId long? 📶 EQUALS,ENUM

_eetSubjectId long? 📶 EQUALS,ENUM

_employeeId long? 📶 EQUALS,ENUM

_relatedInvoiceId long? 📶 EQUALS,ENUM

_relatedOrderId long? - Field is deprecated use _sourceOrderId 📶 EQUALS,ENUM

_sellerId long? Seller ID 📶 EQUALS,ENUM

_sourceOrderId long? 📶 EQUALS,ENUM

_tableId long? 📶 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 📶 EQUALS, ENUM

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

Description

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

19

WELMEC_ENABLED

Scale standard

20

REVERSE_CHARGE

21

CORRECTED

22

USE_ALTERNATIVE_ITEM_NAMES

23

PAID_WITH_ALTERNATIVE_CURRENCY

24

VAT_RECORDS_TOP_DOWN

VAT summary is computed from price with VAT

25

EOS_LOCKED

Can be modified only with EOS flows

26

SK_CANCELED_NONFISCALLY

The original order contains this flag

27

ISSUED_EXTERNALLY

Order was issued externally without employees interaction, and info dialog should be displayed.

28

ISSUED_EXTERNALLY_DISPLAYED

External issue info was displayed.

29

FISCALIZATION_SUCCESSFUL

Get orders

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

Path Parameters

Name
Type
Description

cloudId*

integer

Query Parameters

Name
Type
Description

include

array

Include other entities [1]

namedFilter

string

Named filters [2]

sort

string

filter

string

page

integer

limit

integer

Headers

Name
Type
Description

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

Name
Type
Description

orderId*

integer

cloudId*

integer

Headers

Name
Type
Description

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

Name
Type
Description

cloudId*

integer

Headers

Name
Type
Description

Authorization*

string

Bearer accessToken

Options order

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

Path Parameters

Name
Type
Description

orderId*

integer

cloudId*

integer

Headers

Name
Type
Description

Authorization*

string

Bearer accessToken

Branch ID
Cloud ID
Course ID
Customer ID
EET subject ID
Employee ID
Order ID
Order ID
Order ID
Table ID