Comment on page
Order
_sellerId
long?
Seller 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 Orderflags
integer
Special settings for Order in binary form.
📶 BITS
id
long
Primary ID for OrderitemCount
integer
Count of items on OrderlocationAccuracy
double?
Accuratcy for location from GPSlocationDate
timestamp?
Date of GPS location record
📶 EQUALS
, ENUM
, NUMBER
🔽 BOTH
locationLatitude
double?
Latitude value from GPSlocationLongitude
double?
Longitude value from GPSmerchantPrintData
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 Orderpoints
double
Points value for Order
📶 EQUALS
, NUMBER
printData
string
Data for printerstatus
enum
Order status
📶 EQUALS
, ENUM
tags
string[]?
Tags for a Order
📶 EQUALS
, ENUM
tipAmount
double?
Expected tip amount for the ordertotalValueRounded
double
Total rounded value for Orderdupdated
timestamp
Updated date
📶 EQUALS
, ENUM
, NUMBER
🔽 BOTH
versionDate
timestamp
Last modification date and time
📶 EQUALS
, ENUM
, NUMBER
🔽 BOTH
// representation like string
RECEIPT, INVOICE, INVOICE_FROM_RECEIPTS,
CORRECTIVE_INVOICE
{
"_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>
}
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
https://api.dotykacka.cz
/v2/clouds/:cloudId/orders
Get orders
[1] The following entities can be included in the response:
orderItems
- list of order itemsmoneyLogs
- 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.
{
// 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 onlyorderItems.openOrderItems
- withinclude=orderItems
filters open order items as well
Multiple named filters can be used at the same time, f.e.:
namedFilter=openOrders;orderItems.openOrderItems
get
https://api.dotykacka.cz
/v2/clouds/:cloudId/orders/:orderId
Get order
options
https://api.dotykacka.cz
/v2/clouds/:cloudId/orders
Options orders
options
https://api.dotykacka.cz
/v2/clouds/:cloudId/orders/:orderId
Options order
Last modified 1yr ago