1 of 77

API

Introduction to API v2

The Dotypos API v2 provides programmatic management of entities, requesting data reports, and allows you to perform processing of order directly on Point of Sale system.

First steps

Guides

Getting started

Client Application

Creating Dotypos Account

In order to test your integration, you will probably need to create a new Dotypos Account with the provided testing license key.

Next Steps

Third-party libraries & Postman collection

Authorization

Client Application

The Client Application is used to the differentiation of API usages and allows you to offer the same integration for multiple independent customers.

Connecting Client Application (Refresh Token)

To use the API you need to obtain the Refresh Token first.

Flow description

To retrieve the Refresh Token, you need to redirect the user from your application to the connector web page where the user has to allow access for your application (see the screenshot below). After granting the access, the user will be redirected to the webhook redirect_uri with query parameters which contain the Refresh Token.

Connector web page URL

To obtain the Refresh Token you have to redirect the user to the following web page where the user grants access to your application:

https://admin.dotykacka.cz/client/connect (+ query parameters, see below)

The above URL is not a REST API endpoint. It has to be opened using a web browser to allow users to interact with the page. Your application can start a browser directed to the URL including the query parameters.

List of query parameters

All query parameters except state are required.

Name

Description

client_id

client_secret

scope

Scope of requested access

* is the only supported value now

redirect_uri

Indicates the URI to return the user to after registration is complete

state

(optional)

Connector web page URL format

This is the full web URL to redirect users to for granting access to your application and obtaining the Refresh Token:

https://admin.dotykacka.cz/client/connect?client_id={client_id}&client_secret={client_secret}&scope=*&redirect_uri={webhook}&state=my-state

Query parameters provided to the `redirect_uri` webhook

After granting access the user will be redirected to the provided redirect_uri with the following query parameters:

Name

Description

token

Refresh Token

cloudid

Selected Cloud ID

state

CSRF parameter provided in redirect request

(provided only if presented in redirect request)

If you are using the first version (deprecated now) of the API you need to retrieve new Refresh Token. API v2 Refresh Token is not compatible with API v1 token format.

TIP If your application is internal and single purpose only you can use a dummy url (e.g. https://dotykacka.cz) and copy the token value from the url after the redirection. Don't use this for external client implementations.

Signing into API v2 (Access Token)

To call any of the authenticated API v2 endpoints you need to obtain the Access Token first.

Get Access Token

POST https://api.dotykacka.cz/v2/signin/token

Returns Access Token for a provided Refresh Token. Default validity of Access Token is one hour (not guaranteed). The request body must be in the JSON format (form-data is not accepted and returns error).

Headers

Name

Type

Description

Authorization*

string

User $refreshToken

Request Body

Name

Type

Description

_cloudId

string

Cloud ID, should be specified to get access to the most endpoints

{
    "accessToken": "eyJ0.eyJ1.eyJ2..."
}

{}

Access Token without Cloud ID (special case)

JSON body

{
}

Access Token with Cloud ID (standard use-case)

To get access to all endpoints (standard use-case) you need to retrieve the Access Token for the specific cloud. This is done by specifying the cloud ID in the request JSON body.

JSON body

{
    "_cloudId": {cloudId}
}

Access Token usage

For each API v2 authenticated request, you need to include the Access Token in the HTTP request headers:

Authorization: Bearer {AccessToken}

This is described with every endpoint method in the documentation.

Delivery Notes Integrations

Electronic delivery notes and Remittances are primarily for suppliers to provide their customers with electronic delivery notes and remittances, and easy stock in.

Purpose of this guide is to ease the integration of a supplier's system with the Dotykacka platform. The customers can then benefit from a smooth cooperation between the two systems which will save their time otherwise consumed by updating products and stock quantities in a delivery note manually item-by-item.

Flow description

The supplier prepares the delivery note XML and uploads it via the API2 (steps to setup and invoke the API2 are described in this guide).
When the XML document is uploaded, it will show up in the customer's Warehouse application.
From there, optionally, the customer can alter selling prices and quantities before confirming to stock in the items.
When confirmed, the application will automatically update product prices and quantities of stock items in the customer's warehouse and it will also set the delivery note status to Stacked.

Register your application

We will provide you a Client ID and Client Secret, and a testing license key.

Setup for testing

The steps in this section are very simplified to help you to experiment with the API as quickly as possible but should not be used in production.

For testing, create a new Dotypos Account with the provided testing license key.
Prepare the connector URL (replace variables {} with client ID and secret):
https://admin.dotykacka.cz/client/connect?client_id={client_id}&client_secret={client_secret}&scope=*&redirect_uri=https://dotykacka.cz
Open the URL in a browser and grant access to your testing cloud.
Note down the Refresh Token returned in the URL after you get redirected to dotykacka.cz
(redirect URL: https://dotykacka.cz?token={RefreshToken}&cloudid={cloudId})

Setup for production

Here are some hints to make your application better prepared for the production.

Your application should generate the connector URL query parameters and use the full URL to redirect users automatically.
The redirect_uri in the connector URL should be an URL of your webhook that will process the response.
The Refresh Token should be stored safely in your application (never expires).

Obtain the Access Token

send API request POST https://test.api.dotykacka.cz/v2/signin/token
- with header: Authorization: User {RefreshToken}
- and header: Content-Type: application/json
- and JSON body: { "_cloudId": {cloudId} }
parse the response body (JSON) so as to get the value for the key "accessToken"

The Access Token...

is valid for a limited time only and when it expires, it must be renewed via this endpoint again.
allows access only to the Cloud ID specified in the body of the request that returned it.
must be specified when calling any other API v2 endpoint in the headers:
Authorization: Bearer {AccessToken}

Check the access

During the development stage of your integration code you can call the following endpoint to check you have the right access token with access to the given cloud:

GET https://api.dotykacka.cz/v2/clouds/{cloudId}

Do not forget to add the request header Authorization: Bearer {AccessToken}

If it responds with http status 200 and a cloud info in the body, then you are prepared and ready to call other endpoints.

It is not needed to check the access in production code so we recommend skipping this step for a better performance of your integration code.

Uploading Delivery notes

You can upload a delivery note in a XML format by using the API call.

Call: POST /v2/clouds/{cloudId}/branches/{branchId}/delivery-note-uploads

In case the XML file is not accepted, please make sure it is valid according to the XSD.

Managing Products

You can manage, filter and sort products by using the API calls.

When updating multiple entities, keep the same order in the PUT request as it was in the GET response that returned the ETag.

For endpoints working with a list of entities (POST/PUT), the order of entities in the response is the same as it was sent in the request .

The POST method does not expect an ID so it always creates new products.

The PUT method requires an ID so you need to generate one when you want to create a product using the PUT method.

The JSON samples labeled "Body request minimum" under the POST and PUT requests show the minimum set of fields that are required to create a new product.

When changing an entity via the PATCH endpoint, you can send only the fields that you want to update, f.e. to change the product name send body {"name": "New name"}.

API Reference

General

Data types

Timestamp

Timestamp (timestamp) values in filters and in the request body are accepted in these formats:

Unix time

ISO 8601 (UTC)

ISO 8601 (custom time zone)

Number

All numbers (short, integer, double, long) in the response are represented as strings for safe compatibility with JavaScript or systems with no support for long numbers.

Validation

Some properites have special validation rules.

vatId

Is required/optional by schema definitions in entity description and validated by specific regex.

Allowed chars in URL

Only the allowed characters are permitted in the URL. The URL structure is not validated, nevertheless we recommend providing only a valid URL.

HTTP URL

Prices

Limitations

Most of the values representing price are stored as a double precision internally. That means that the numbers have a 15 decimal digits precision.

Rounding

Do not round any price value when creating or updating an entity. The prices are usually rounded when they are shown in the Dotykacka Application, but they should be stored as precise as possible in the entities. The difference can be unnoticeable for small amounts of goods, but it can result in rounding errors for many items when a report is calculated for a wider time interval.

Let's demonstrate the difference on a product of sell price 50 CZK with 21% VAT. If you set the price without VAT:

not rounded, i.e. 41.3223140495868 CZK, then you sell 1,000 pcs for 50,000 CZK (expected)
rounded on 2 places, i.e. 41.32 CZK, then you sell 1,000 pcs for 49,997 CZK (41.32*1.21*1000)

Here the difference of 3 CZK is quite visible so we advise setting precise prices without rounding.

Schema

Description of entities, request and response objects.

A schema describes Entity, Request, Response, etc objects. Specific properties data type, required fields, filter groups, sort options and describes special cases. Schema is split into two blocks - the first block describes individual fields and the second shows the JSON format.

Description

The example below shows some object properties with descriptions.

id long Entity ID - cannot be null in PUT/PATCH methods 📶 EQUALS,ENUM 🔽 NONE

deleted boolean Entity deleted 📶 EQUALS,ENUM 🔽 NONE

externalId string? External ID 📶 EQUALS,ENUM 🔽 NONE

name string(180) Entity name 📶 EQUALS,STRING 🔽 BOTH

All internal IDs have an underscore prefix, f.e._cloudId.

All numeric properties are represented as string in JSON.

Validated properties

Properties of data types followed by question mark (?) are optional. All other properties are mandatory. In special cases there can be a note mark with a number.

Property data type

Descriptiion

name string

NOT NULL

externalId string?

OPTIONAL

id long [1]

Special case with group 1 description below

firstName string? [2]

Special case with group 2 description below

lastName string? [2]

Special case with group 2 description below

companyName string? [2]

Special case with group 2 description below

Properties with [number] have special description below.

[1] ID cannot be null in PUT/PATCH methods [2] One of properties firstName, lastName, companyName cannot be BLANK / EMPTY but other can be EMPTY.

Value

Description

string(400)

String with maximum length of 400

string(200,250)

String length between 200 to 250

string[]

Array of strings

string[1,100]

Array of strings with item count between 1 to 100

string[](1000)

Array of strings with maximum length of 1000 in joined string (with separators)

Flags

Flags are one or more boolean values stored in a single number field.

Operations on Flags

This page lists all known flags for each entity which has a flags field. The numbers shown next to each flag are bit ordinal numbers counted from the least significant bit. If a bit is set (1) in the flags field then the corresponding flag is set. If the bit is not set (0) then the flag is not set.

Example

Let's have an entity with flags equal to 257 (the API expects a decimal representation). So 257 = 2^8 + 2^0 meaning that flags for bits 0 and 8 are set, all others are unset.

Keep in mind that when you change a single flag via the PATCH or PUT methods you must keep other flags unchanged. If you send only the value corresponding to a single flag all other flags will be cleared (unset).

The API requests and responses work with a decimal representation and use a signed data types, so you might get a negative value if the most significant bit is set in the flags field. See the flags data type in the entity schema.

Obtaining a flag value

To get the flag value from the bit ordinal number take 1 and shift it left by the bit number, i.e. 1^bit

Example: value for bit 8 flag, Java syntax:

flagValue = 1 << 8; // flagValue == 256

Checking if a flag is set

To check if a flag is set do a binary AND operation with the flag value and compare the result with a zero, i.e. flags AND 1^bit != 0

Example: flags = 257, checking bit 8 flag, Java syntax:

boolean isFlagSet = (257 & (1 << 8)) != 0; // isFlagSet == true

Adding (set) a flag

To set a flag while keeping state of other flags you can use the binary OR operation with the flag value, i.e. flags = flags OR 1^bit

Example: setting bit 8 flag, Java syntax:

flags |= 1 << 8;

Clearing (unset) a flag

To unset a flag while keeping state of other flags you can use the binary AND operation with a binary complement of the flag value, i.e. flags = flags AND NEG 1^bit

Example: clearing bit 8 flag, Java syntax:

flags &= ~(1 << 8);

Toggling (flip) a flag

To toggle a flag while keeping state of other flags you can use the binary XOR operation with the flag value, i.e. flags = flags XOR 1^bit

Example: toggling bit 8 flag, Java syntax:

flags ^= 1 << 8;

ETags

ETags ensure atomicity of changes, bring control over possible problems, and they transfer the responsibility for the solutions to the integrators.

What is an ETag

The ETag response-header field is an identifier of the current version of the entity or entities.

The If-None-Match request-header field helps save bandwidth, as the API does not need to resend a full response if the content has not changed.

The If-Match request-header field helps prevent simultaneous updates of a resource from overwriting by a third party.

HTTP Response

The API returns the "ETag" header in the response of all entity-based endpoints for all HTTP methods.

HTTP Request

Some endpoints require "If-Match" or support "If-None-Match" headers in the request. Use the GET method to obtain the current ETag value.

GET - support "If-None-Match" header and return empty response if entities have not been changed.
POST - no ETag value is required or supported in the request headers.
PUT, PATCH - require the ETag value in the "If-Match" header and fail if entities were changed.
DELETE - no ETag value is now required in the "If-Match" header (temporal only - will be required).

The endpoints returning a list of entities calculate a single ETag value from all the entities in the returned list. So if any entity in the response is changed, the returned ETag value will be different.

When sending a list of entities via the PUT/PATCH method, make sure their IDs and their order are the same as in the GET response which was used to obtain the ETag for this PUT request.

For GET endpoints supporting paging, the ETag is calculated from entities of the current page.

For GET endpoints supporting fused entities, the ETag is calculated from the main entities only (sub-entities are not taken into account and must be updated via their own endpoint if needed).

200 OK (Any method when finished successfully)
304 Not Modified (GET method with "If-None-Match" header if the entity has not been changed)
404 Not Found (GET method did not find any matching entity)
409 Conflict (PUT/PATCH method on entity failed "versionDate" verification)
412 Precondition Failed (PUT/PATCH method with "If-Match" header when entity has been changed)
428 Precondition Required (PUT/PATCH method was not called with ETag in the "If-Match" header)
500 Internal Server Error (Any method unexpectedly failed)

Filtering

Almost all endpoints what returns list of data. Supports filter query parameter with paging combination.

Filter query parameter

filter=attribute|operation|value;attribute2|operation|value

Only specific properties support some filter groups.

Filter groups

Filter operations

Filtering `null` values

To filter null or not null values a special keywords were introduced. They can be used in the filter in the place of a value.

Values null and notnull can be used together with custom filter values in filters, i.e externalId|notin|42,null will return only those entities with externalId not equal to 42 and not null at the same time.

The operators eq and ne are just a special case of operators in and notin respectively. It means that the results will be the same if you replace the in operator with eq when filtering a single value.

These special values cannot be used for the deleted attributes. See the next paragraph for more information.

Filtering `deleted`

There is a special behavior for filtering attributes deleted. The keywords "null" and "notnull" are not supported. The null values are considered as "not deleted" automatically, so there is no need to support null and not null filtering. If you ask the API to return not deleted entities only, it will automatically return entities with deleted false or deleted null. See the examples below.

For boolean attributes you can use 0 instead of false, and 1 instead of true.

Filter examples

Sorting

Sort query parameter

sort=attribute,attribute2,-attribute3

Sort examples

Paging

With paging query parameters you can change the size of response data array and iterate response loading.

Paging query parameters

Examples: page=1 , page=1&limit=20

Paging response structure

currentPage Int The current page.

perPage Int Maximum items (limit) on a page.

totalItemsOnPage Int Number of items on the actual page.

totalItemsCount Int? Total items count for the whole data. It may be null for some entities [1].

firstPage Int The first page. It should always be equal to 1.

lastPage Int? The last page. It can be null for some entities [1]. It will be equal to 0 in the future if there are no data but now the API2 returns HTTP 404 Not Found.

nextPage Int? The next page or null if on the last page.

prevPage Int? The previous page or null if on the first page.

data List The list of entities.

[1] Some endpoints do not count all the records because it would negatively impact the performance. Endpoints for the following entities return totalItemsCount=null and lastPage=null currently (but it can change in the future):

In such situations you can advance to the next page and repeat until you get a result with totalItemsOnPage < perPage or an HTTP error 404 Not Found.

Paging examples

HTTP Status Codes

2xx

3xx

4xx

[1] The error response for status codes 401 and 403 has an extra field reason so as to further differentiate the situations programmatically. The value is an enumeration and can be one of these:

5xx

Enums

Payment methods

List of supported payment methods

Please be aware, that the list of payment methods is not complete and you can expect more values in responses.

Entity

Others

Reports

Migration

API v1 Services

Customer Account Log

Defines a transaction on a customer account.

Please note that for credit operations, it is the responsibility of the integrator to create tax documents.

Customer account log schema

_cloudId integer Cloud ID 📶 EQUALS,ENUM

_customerAccountId long? Customer account ID 📶 EQUALS,ENUM

_employeeId long? Employee ID 📶 EQUALS,ENUM

_moneyLogId long? Money log ID 📶 EQUALS,ENUM

_orderId long? Order ID 📶 EQUALS,ENUM

_previousCustomerAccountLogId long? Previous customer account log ID 📶 EQUALS,ENUM

amount BigDecimal The amout of the transaction 📶 NUMBER

balance BigDecimal The account balance after the transaction 📶 NUMBER

created timestamp Timestamp of created record 📶 EQUALS,ENUM,NUMBER

currency string Three-letter currency according to ISO 4217 📶 STRING 🔽 BOTH

id long Customer account log ID 📶 EQUALS,ENUM

note string Custom note for the transaction

source string Identification of the source where the transaction took place

type enum Account log type, supported values: "top-up", "payment", "refund" 📶 STRING 🔽 BOTH

JSON response

{
    "_customerAccountId": <long>,
    "_employeeId": <long>,
    "_moneyLogId": <long>,
    "_orderId": <long>,
    "_previousCustomerAccountLogId": <long>,
    "amount": <BigDecimal>,
    "balance": <BigDecimal>,
    "created": <timestamp>,
    "currency": <string>,
    "id": <long>,
    "note": <string>,
    "source": <string>,
    "type": <enum>
}

Create customer account log

POST https://api.dotykacka.cz/v2/clouds/:cloudId/customer-account-logs

This EP requires an existing customer account as specified by _customerAccountId.

Path Parameters

Name

Type

Description

cloudId*

integer

Headers

Name

Type

Description

Authorization*

string

Bearer accessToken

Create customer account (if needed) and log

POST https://api.dotykacka.cz/v2/clouds/:cloudId/customers/:customerId/accounts/:accountType/logs

If the customer does not have the default account, create it first. Then create the account log.

Path Parameters

Name

Type

Description

cloudId*

integer

customerId

long

accountType

string

valid value: default

Headers

Name

Type

Description

Authorization*

string

Bearer accessToken

Get customer account logs for customer

GET https://api.dotykacka.cz/v2/clouds/:cloudId/customers/:customerId/accounts/:accountType/logs

Path Parameters

Name

Type

Description

cloudId*

integer

customerId

long

accountType

string

valid value: default

Headers

Name

Type

Description

Authorization*

string

Bearer accessToken

Query Parameters

Name

Type

Description

sort

string

page

integer

filter

string

limit

integer

Get customer account log by ID for customer

GET https://api.dotykacka.cz/v2/clouds/:cloudId/customers/:customerId/accounts/:accountType/logs/:customerAccountLogId

Path Parameters

Name

Type

Description

cloudId*

integer

customerId

long

accountType

string

valid value: default

customerAccountLogId

long

Headers

Name

Type

Description

Authorization*

string

Bearer accessToken

Get customer account log by ID

GET https://api.dotykacka.cz/v2/clouds/:cloudId/customer-account-logs/:customerAccountLogId

Path Parameters

Name

Type

Description

cloudId*

integer

customerAccountLogId

long

Headers

Name

Type

Description

Authorization*

string

Bearer accessToken

Search customer account logs

GET https://api.dotykacka.cz/v2/clouds/:cloudId/customer-account-logs

Path Parameters

Name

Type

Description

cloudId*

integer

Headers

Name

Type

Description

Authorization*

string

Bearer accessToken

Query Parameters

Name

Type

Description

sort

string

page

integer

filter

string

limit

integer

Delivery Note

Endpoints here allow you to upload delivery notes and filter information about those that were successfully imported.

Delivery Note schema

id long Delivery note ID 📶 EQUALS,ENUM

currency string(3) Currency from xml element DEASDV.DOCUMENT.CURRENCY

created timestamp? Created date and time from xml element DEASDV.DOCUMENT.CREATED 📶 EQUALS,ENUM,NUMBER 🔽 BOTH

deleted boolean Delivery note deleted 📶 EQUALS,ENUM 🔽 BOTH

documentId string(180) Document ID from xml attribute DEASDV.DOCUMENT.id 📶 EQUALS,ENUM,STRING

documentNumber string(18) Document number from xml element DEASDV.DOCUMENT.DOCUMENT_NUMBER

expeditionDate timestamp? Expedition date and time from xml element DEASDV.DOCUMENT.EXPEDITION_DATE 📶 EQUALS,ENUM,NUMBER 🔽 BOTH

status integer Status 📶 EQUALS,ENUM

supplierName string(180) Supplier name from xml element DEASDV.DOCUMENT.SUPPLIER.NAME

text string Text from xml element DEASDV.DOCUMENT.TEXT

url string(256) Public URL that can be used to download the XML document. The file downloaded represents only the DOCUMENT section from the imported file so it cannot be re-uploaded as-is (uploaded files must have the DEASDV root element).

versionDate timestamp? Last modification date and time 📶 EQUALS,ENUM,NUMBER 🔽 BOTH

DeliveryNote type

DeliveryNote response

Delivery note XML file structure

Below is a simplified structure only. For the complete definition of the document structure please see the attached XSD below.

Supported units (UNIT)

Piece, Points
Milligram, Gram, Decagram, Kilogram, Pound, Ounce, Quintal, Tone
Millimeter, Centimeter, Meter, Kilometer, Inch, Mile
SquareMeter, SquareFoot
Milliliter, Centiliter, Deciliter, Liter, UsGallon, UkGallon, CubicFoot, Hectoliter, CubicMeter
Second, Minute, Hour, Day, Week, Month, Year

Delivery note XSD file

The complete description of the XML file structure can be found in the attached file below:

Upload delivery note

POST https://api.dotykacka.cz/v2/clouds/:cloudId/branches/:branchId/delivery-note-uploads

Path Parameters

Headers

Request Body

You can download a sample XML and modify it for your needs. The attached sample file contains two documents of types DELIVERY_NOTE and RETURN respectively.

Validations

Maximum size of the XML file is set to 60MB.
The uploaded XML file must have s single DEASDV root element
Document id attribute must be a valid UUID in the form "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
Document TYPE must be "DELIVERY_NOTE" (default when null) or "RETURN" (remittance)
Document CURRENCY must be in the ISO 4217 format
Item UNIT must be a valid unit name - see the Supported units (UNIT)

Delivery notes (`<TYPE>DELIVERY_NOTE</TYPE>`)

Item PRICE_WITHOUT_VAT must not be null
Item PRICE_WITH_VAT must not be null
Item VAT_RATE must not be null

Remittances (`<TYPE>RETURN</TYPE>`)

Item AMOUNT cannot be positive
Item PRICE_WITHOUT_VAT must be null
Item PRICE_WITH_VAT must be null
Item VAT_RATE must be null

Get delivery notes

GET https://api.dotykacka.cz/v2/clouds/:cloudId/delivery-notes

Path Parameters

Query Parameters

Headers

Get delivery note

GET https://api.dotykacka.cz/v2/clouds/:cloudId/delivery-notes/:deliveryNoteId

Path Parameters

Headers

Options delivery notes

OPTIONS https://api.dotykacka.cz/v2/clouds/:cloudId/delivery-notes

Path Parameters

Headers

Options delivery note

OPTIONS https://api.dotykacka.cz/v2/clouds/:cloudId/delivery-notes/:deliveryNoteId

Path Parameters

Headers

Tax (VAT rates)

Configuration of various taxes. Currently the only supported type is VAT.

Tax schema

_cloudId long Cloud ID

created timestamp? Timestamp of entity creation 📶 EQUALS,ENUM,NUMBER 🔽 BOTH

deleted boolean If entity is deleted 📶 EQUALS,ENUM

flags short Flags for the tax 📶 BITS

id long? Entity ID - cannot be null in PUT/PATCH methods 📶 EQUALS,ENUM

name string? Name of the tax 📶 STRING 🔽 BOTH

value double Value of tax in percent, f.e. 20 = 20%. Must be in range <0; 100> and it must be unique - having two entities with the same value is not allowed (exempted rate is an exception). 🔽 BOTH

versionDate timestamp? Last modification date and time 📶 EQUALS,ENUM,NUMBER 🔽 BOTH

JSON response

{
    "_cloudId": <integer>,
    "created": <timestamp>,
    "deleted": <boolean>,
    "flags": <integer>,
    "id": <long>,
    "name": <string>,
    "value": <double>,
    "versionDate": <timestamp>
}

Tax flags

Bit

Name

TAKE_AWAY_RATE

EXEMPTED_RATE

DELIVERY_DEFAULT_RATE

If flag EXEMPTED_RATE is set, the value must be 0.

Get taxes

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

Path Parameters

Name

Type

Description

cloudId

integer

Query Parameters

Name

Type

Description

sort

string

filter

string

page

string

limit

string

Headers

Name

Type

Description

Authorization

string

Bearer accessToken

[
 {
  // response schema
 }
]

Get tax

GET https://api.dotykacka.cz/v2/clouds/:cloudId/taxes/:taxId

Path Parameters

Name

Type

Description

taxId

integer

cloudId

integer

Headers

Name

Description

Authorization*

string

Bearer accessToken

If-Match

string

ETag to update only if not changed.

[
 {
  // response schema
 }

Headers

Name

Type

Description

Authorization

string

Bearer accessToken

Options taxes

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

Path Parameters

Name

Type

Description

cloudId

integer

Headers

Name

Type

Description

Authorization

string

Bearer accessToken

Options tax

OPTIONS https://api.dotykacka.cz/v2/clouds/:cloudId/taxes/:taxId

Path Parameters

Name

Type

Description

taxId

integer

cloudId

integer

Headers

Name

Type

Description

Authorization

string

Bearer accessToken

Stock Packaging

Stock packaging schema

_cloudId integer Cloud ID

_productId long Product ID - stock item product 📶 EQUALS,ENUM

deleted boolean Stock packaging deleted - cannot be true in POST/PUT/PATCH methods 📶 EQUALS, ENUM 🔽 BOTH

ean string[]? EAN codes 📶 EQUALS, ENUM

id long? Stock packaging ID - cannot be null in PUT/PATCH methods 📶 EQUALS,ENUM

name string(400) Product name 📶 STRING🔽 BOTH

plu string[]? PLU codes 📶 EQUALS, ENUM

quantity double Quantity of stock packaging

unit enum Unit of stock packaging must be in the same group as the stock item product with _productId

versionDate timestamp? Last modification date and time 📶 EQUALS, ENUM, NUMBER 🔽 BOTH

Stock packaging response

{
    "_cloudId": <integer>,
    "_productId": <long>,
    "deleted": <boolean>
    "ean": <string[]>,
    "id": <long>,
    "name": <string>,
    "plu": <string[]>,
    "quantity": <double>,
    "unit": <enum>,
    "versionDate": <timestamp>
}

Get stock packagings

GET https://api.dotykacka.cz/v2/clouds/:cloudId/stock-packagings

Path Parameters

Name

Type

Description

cloudId*

integer

Query Parameters

Name

Type

Description

sort

string

filter

string

page

integer

limit

integer

Headers

Name

Type

Description

Authorization*

string

Bearer accessToken

Get stock packaging

GET https://api.dotykacka.cz/v2/clouds/:cloudId/stock-packagings/:stockPackagingId

Path Parameters

Name

Type

Description

cloudId*

integer

stockPackagingId*

long

Headers

Name

Type

Description

Authorization*

string

Bearer accessToken

Create stock packagings

POST https://api.dotykacka.cz/v2/clouds/:cloudId/stock-packagings

Path Parameters

Name

Type

Description

cloudId*

integer

Headers

Name

Type

Description

Auhtorization*

string

Bearer accessToken

Request Body

Name

Type

Description

If-Match*

string

Etag to update only if not changed.

Authorization*

string

Authorization*

string

Bearer accessToken

Delete stock packaging

DELETE https://api.dotykacka.cz/v2/clouds/:cloudId/stock-packagings/:stockPackagingId

Path Parameters

Name

Type

Description

cloudId*

integer

stockPackagingId*

long

Headers

Name

Type

Description

Authorization*

string

Bearer accessToken

Options stock packagings

OPTIONS https://api.dotykacka.cz/v2/clouds/:cloudId/stock-packagings

Path Parameters

Name

Type

Description

cloudId*

integer

Headers

Name

Type

Description

Authorization*

string

Bearer accessToken

Options stock packaging

OPTIONS https://api.dotykacka.cz/v2/clouds/:cloudId/stock-packagings/:stockPackagingId

Path Parameters

Name

Type

Description

cloudId*

integer

stockPackagingId*

long

Headers

Name

Type

Description

Authorization*

string

Bearer accessToken

Order

Order schema

_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 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

CANCELED_PART

CANCELED_FULL

CANCELLATION

FISCALIZATION_REQUIRED

MERGED

FISCALIZATION_DISABLED

PAID_PART

FISCALIZATION_SIMPLIFIED

VAT_PAYER

NON_VAT_PAYER

PDF_INVOICE

WRITEOFF

GASTRO

FISCALIZATION_FAILED

VAT_PRINT_DISABLED

LUNCH_INVITATION

DELIVERY

MOVED_FROM

MOVED_TO

WELMEC_ENABLED

Scale standard

REVERSE_CHARGE

CORRECTED

USE_ALTERNATIVE_ITEM_NAMES

PAID_WITH_ALTERNATIVE_CURRENCY

VAT_RECORDS_TOP_DOWN

VAT summary is computed from price with VAT

EOS_LOCKED

Can be modified only with EOS flows

SK_CANCELED_NONFISCALLY

The original order contains this flag

ISSUED_EXTERNALLY

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

ISSUED_EXTERNALLY_DISPLAYED

External issue info was displayed.

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

Customer

Customer schema

id long? Customer ID - cannot be null in PUT/PATCH methods 📶 EQUALS,ENUM

_discountGroupId long? Discount group ID 📶 EQUALS,ENUM

_sellerId long? Seller ID 📶 EQUALS,ENUM

addressLine1 string(180) Address line 1 📶 STRING

addressLine2 string?(180) Address line 2 📶 STRING

barcode string(50) Bar code 📶 EQUALS,ENUM

birthday timestamp? The date of birth

city string?(255) City 📶 EQUALS,STRING

companyId string(255) Customer company ID (CZ: IČO, PL: REGON) 📶 STRING

companyName string(180) [1] Customer company name 📶 STRING 🔽 BOTH

country string?(10) Country code 📶 STRING

created timestamp? Customer created date and time 📶 EQUALS, ENUM, NUMBER 🔽 BOTH

deleted boolean Customer deleted - cannot be true in POST/PUT/PATCH methods 📶 EQUALS, ENUM 🔽 BOTH

display boolean Customer displayed 📶 EQUALS, ENUM 🔽 BOTH

email string(100) E-mail address 📶 STRING

expireDate timestamp? Customer expire date and time 📶 EQUALS, ENUM, NUMBER 🔽 BOTH

externalId string?(256) External ID 📶 EQUALS,ENUM

firstName string(180) [1] First name 📶 STRING 🔽 BOTH

flags long Customer flags 📶 BITS

headerPrint string(256) Header for printing

hexColor string(7) Product color

internalNote string(1000) Internal note

lastName string(180) [1] Last name 📶 STRING 🔽 BOTH

modifiedBy string?(32) Customer modified by

note string?(500) Customer note

phone string(20) Phone 📶 STRING

points double Customer points - must be greater than or equal to 0 📶 NUMBER

tags string[](255) Tags for a customer, must not contain any of these characters: ,^?*()[]$ 📶 EQUALS, ENUM

versionDate timestamp? Last modification date and time 📶 EQUALS, ENUM, NUMBER 🔽 BOTH

zip string(20) ZIP code 📶 STRING

[1] Properties firstName, lastName and companyName must not be blank. At least one of these properties must contain a non-blank value.

JSON response

{
    "_cloudId": <integer>,
    "_discountGroupId": <integer>,
    "_sellerId": <long>,
    "addressLine1": <string>,
    "addressLine2": <string>,
    "barcode": <string>,
    "birthday": <timestamp>,
    "city": <string>,
    "companyId": <string>,
    "companyName": <string>,
    "country":  <string>,
    "created": <timestamp>,
    "deleted": <boolean>,
    "display": <boolean>,
    "email": <string>,
    "expireDate": <timestamp>,
    "externalId": <string>,
    "firstName": <string>,
    "flags": <long>,
    "headerPrint": <string>,
    "hexColor": <string>,
    "id": <long>,
    "internalNote": <string>,
    "lastName": <string>,
    "modifiedBy": <string>,
    "note": <string>,
    "phone":<string>,
    "points": <double>,
    "tags": <string[]>,
    "vatId": <string>,
    "versionDate": <timestamp>,
    "zip": <string>
}

Get customers

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

Path Parameters

Name

Type

Description

cloudId*

integer

Query Parameters

Name

Type

Description

page

integer

limit

integer

filter

string

sort

string

Headers

Name

Type

Name

Type

Description

cloudId*

integer

Headers

Name

Type

Description

Authorization*

string

Bearer accessToken

Request Body

Name

Type

Description

array

Array of Customer object

// Body request minimmum
[
    {
        "_cloudId": <integer>,
        "addressLine1": <string>,
        "barcode": <string>,
        "companyId": <string>,
        "companyName": <string>,
        "deleted": <boolean>,
        "display": <boolean>,
        "email": <string>,
        "firstName": <string>,
        "headerPrint": <string>,
        "hexColor": <string>,
        "internalNote": <string>,
        "lastName": <string>,
        "phone":<string>,
        "points": <double>,
        "tags": <string[]>,
        "vatId": <string>,
        "zip": <string>,
    }
]

// Body request minimmum
[
    {
        "_cloudId": <integer>,
        "addressLine1": <string>,
        "barcode": <string>,
        "companyId": <string>,
        "companyName": <string>,
        "deleted": <boolean>,
        "display": <boolean>,
        "email": <string>,
        "firstName": <string>,
        "headerPrint": <string>,
        "hexColor": <string>,
        "id": <long>,
        "internalNote": <string>,
        "lastName": <string>,
        "phone":<string>,
        "points": <double>,
        "tags": <string[]>,
        "vatId": <string>,
        "zip": <string>,
    }
]

Replace or create customer

PUT https://api.dotykacka.cz/v2/clouds/:cloudId/customers/:customerId

Path Parameters

Name

Type

Description

customerId*

integer

cloudId*

integer

Headers

Name

Type

Description

If-Match

string

ETag to update only if not changed.

Authorization*

string

Bearer accessToken

Request Body

Name

Type

Description

object

Customer object

// Body request minimmum
{
    "_cloudId": <integer>,
    "addressLine1": <string>,
    "barcode": <string>,
    "companyId": <string>,
    "companyName": <string>,
    "deleted": <boolean>,
    "display": <boolean>,
    "email": <string>,
    "firstName": <string>,
    "headerPrint": <string>,
    "hexColor": <string>,
    "id": <long>,
    "internalNote": <string>,
    "lastName": <string>,
    "phone":<string>,
    "points": <double>,
    "tags": <string[]>,
    "vatId": <string>,
    "zip": <string>,
}

Partial update of Customer

PATCH https://api.dotykacka.cz/v2/clouds/:cloudId/customers/:customerId

Path Parameters

Name

Type

Description

customerId*

integer

cloudId*

integer

Headers

Name

Type

Description

If-Match*

string

ETag to update only if not changed.

Authorization*

string

Headers

Name

Type

Description

If-Match

string

ETag ignored (temporarily) when deleting an entity.

Authorization*

string

Bearer accessToken

Options customers

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

Path Parameters

Name

Type

Description

cloudId*

integer

Headers

Name

Type

Description

Authorization*

string

Bearer accessToken

Options customer

OPTIONS https://api.dotykacka.cz/v2/clouds/:cloudId/customers/:customerId

Path Parameters

Name

Type

Description

customerId*

integer

cloudId*

integer

Headers

Name

Type

Description

Authorization*

string

Bearer accessToken

Product Ingredient

Product Ingredient schema

id long? Product Ingredient ID - cannot be null in PUT/PATCH methods 📶 EQUALS,ENUM

deleted boolean Ingredient deleted 📶 EQUALS, ENUM 🔽 BOTH

quantity double Product amount for the ingredient

versionDate timestamp? Last modification date and time 📶 EQUALS, ENUM, NUMBER 🔽 BOTH

JSON response

{
    "_cloudId": <integer>,
    "_parentProductId": <long>,
    "_productId": <long>,
    "deleted": <boolean>,
    "id": <long>,
    "quantity": <double>,
    "unit": <enum>,
    "versionDate": <timestamp>
}

Get product ingredients

GET https://api.dotykacka.cz/v2/clouds/:cloudId/product-ingredients

Get a custom-sorted paginated list of product ingredients matching the filter criteria.

Path Parameters

Name

Type

Description

cloudId*

integer

ID of the cloud.

Query Parameters

Name

Type

Description

filter

string

Filter conditions.

sort

string

Sort parameter.

page

integer

Page to start with.

limit

integer

Page size (100 records maximum)

Headers

Name

Type

Description

POST https://api.dotykacka.cz/v2/clouds/:cloudId/product-ingredients

Create a list of new product ingredients.

Path Parameters

Name

Type

Description

cloudId*

string

ETag to update only if not changed.

Partial update of product ingredient

PATCH https://api.dotykacka.cz/v2/clouds/:cloudId/product-ingredients/:entityId

Update a single product ingredient identified by its ID.

Path Parameters

Name

Type

Description

cloudId*

integer

ID of the cloud.

entityId*

integer

ID of the product ingredient to update.

Headers

Name

Type

Description

OPTIONS https://api.dotykacka.cz/v2/clouds/:cloudId/product-ingredients

Path Parameters

Name

Type

Description

cloudId*

integer

ID of the cloud.

Headers

Name

Type

Description

Authorization*

string

Bearer accessToken

Options product ingredient

OPTIONS https://api.dotykacka.cz/v2/clouds/:cloudId/product-ingredients/:entityId

Path Parameters

Name

Type

Description

cloudId*

integer

ID of the cloud.

entityId*

integer

ID of the product ingredient to get the options for.

Headers

Name

Type

Description

Authorization*

string

Bearer accessToken

Order item

Order item schema

_sellerId long? Seller ID 📶 EQUALS,ENUM

alternativeName string? Product alternative name

billedUnitPriceWithVat double Unit price with vat after discount

billedUnitPriceWithoutVat double Unit price without vat after discount

canceledDate timestamp? Date of item canceled 📶 EQUALS, ENUM, NUMBER 🔽 BOTH

completed timestamp? Date of item (Order) completed 📶 EQUALS, ENUM, NUMBER 🔽 BOTH

created timestamp Date of item created (added to Order) 📶 EQUALS, ENUM, NUMBER 🔽 BOTH

currency string(3) Currency code

discountPercent double Discount percent

discountPermitted boolean Enabled discount 📶 EQUALS, ENUM

ean string[] EAN for item (from product) 📶 EQUALS, ENUM

flags integer Special settings for Order item in binary form. 📶 BITS

id long Primary ID for Order item 📶 EQUALS, ENUM

name string Name of item / product. 📶 STRING 🔽 BOTH

note string Note for item 📶 STRING

onSale boolean Is item on sale 📶 EQUALS, ENUM

packaging double Packaging value for item / product

parked boolean Is item parked 📶 EQUALS, ENUM

points double Points value for Order item

preparationDuration integer? The time in seconds needed to prepare the product

quantity double Quantity of item / product

stockDeduct boolean 📶 EQUALS, ENUM

subtitle string 📶 STRING

tags string[] Tags for item 📶 EQUALS, ENUM

totalPriceWithVat double Total is with quantity

totalPriceWithoutVat double Total is with quantity

unitPriceWithVat double Unit price with vat before discount

unitPriceWithoutVat double Unit price without vat before discount

unitPurchasePrice double Value of purchase price per unit

updated timestamp Date updated 📶 EQUALS, ENUM, NUMBER 🔽 BOTH

vat double Vat rate

versionDate timestamp Last modification date and time 📶 EQUALS, ENUM, NUMBER 🔽 BOTH

JSON response

{
    "_branchId": <integer>,
    "_categoryId": <long>,
    "_cloudId": <integer>,
    "_courseId": <long>,
    "_customerId": <long>,
    "_eetSubjectId": <long>,
    "_employeeId": <long>,
    "_orderId": <long>,
    "_productId": <long>,
    "_relatedOrderItemId": <long>,
    "_sellerId": <long>,
    "alternativeName": <string>,
    "billedUnitPriceWithVat": <double>,
    "billedUnitPriceWithoutVat": <double>,
    "canceledDate": <timestamp>,
    "completed": <timestamp>,
    "created": <timestamp>,
    "currency": <string>,
    "discountPercent": <double>,
    "discountPermitted": <boolean>,
    "ean": <string[]>,
    "flags": <integer>,
    "id": <long>,
    "name": <string>,
    "note": <string>,
    "onSale": <boolean>,
    "packaging": <double>,
    "parked": <boolean>,
    "points": <double>,
    "preparationDuration": <integer>,
    "quantity": <double>,
    "stockDeduct": <boolean>,
    "subtitle": <string>,
    "tags": <string[]>,
    "totalPriceWithVat": <double>,
    "totalPriceWithoutVat": <double>,
    "unit": <enum>,
    "unitPriceWithVat": <double>,
    "unitPriceWithoutVat": <double>,
    "unitPurchasePrice": <double>,
    "updated": <timestamp>,
    "vat": <double>,
    "versionDate": <timestamp>,
    // and for GET methods also:
    "orderItemCustomizations": [
      <Customization>, ...
    ]
}

Customization

{
    "_branchId": <integer>,
    "_cloudId": <integer>,
    "_orderId": <long>,
    "_orderItemId": <long>,
    "_productCustomizationId": <long>,
    "_productId": <long>,
    "alternativeName": <string>,
    "canceledDate": <timestamp>,
    "created": <timestamp>,
    "defaultSelection": <string>,
    "discountValue": <double>,
    "flags": <long>,
    "id": <long>,
    "name": <string>,
    "preparationDuration": <integer>,
    "purchasePriceWithoutVat": <double>,
    "quantity": <double>,
    "unit": <enum>,
    "unitPriceWithVat": <double>,
    "vat": <double>,
    "versionDate": <timestamp>
}

ETag to return results only if changed.

Authorization*

string

Bearer accessToken

[
 {
  // tag schema
 }
]

Get order item

GET https://api.dotykacka.cz/v2/clouds/:cloudId/order-items/:orderItemId

This endpoint includes customizations in an additional field orderItemCustomizations of type list.

Path Parameters

Name

Type

Description

orderItemId*

string

cloudId*

string

Headers

Name

Type

Description

If-None-Match

string

ETag to return results only if changed.

Authorization*

string

Bearer accessToken

{
    // tag schema
}

Options order items

OPTIONS https://api.dotykacka.cz/v2/clouds/:cloudId/order-items

Path Parameters

Name

Type

Description

cloudId*

integer

Headers

Name

Type

Description

Authorization*

string

Bearer accessToken

Options order item

OPTIONS https://api.dotykacka.cz/v2/clouds/:cloudId/order-items/:orderItemId

Path Parameters

Name

Type

Description

orderItemId*

integer

cloudId*

integer

Headers

Name

Type

Description

Authorization*

string

Bearer accessToken

Reservation

Reservation schema

id long? Reservation ID - cannot be null in PUT/PATCH methods 📶 EQUALS,ENUM

created timestamp? Reservation created date and time 📶 EQUALS, ENUM, NUMBER 🔽 BOTH

endDate timestamp End date and time 📶 EQUALS, ENUM, NUMBER 🔽 BOTH

flags integer Reservation flags 📶 BITS

note string? Reservation note

startDate timestamp Start date and time 📶 EQUALS, ENUM, NUMBER 🔽 BOTH

status enum Reservation status

versionDate timestamp? Last modification date and time 📶 EQUALS, ENUM, NUMBER 🔽 BOTH

Reservation.status (enum)

// representation like string
NEW, CONFIRMED, CANCELLED

JSON response

{
    "_branchId": <long>,
    "_cloudId": <integer>,
    "_customerId": <long>,
    "_employeeId": <long>,
    "_tableId": <long>,
    "created": <timestamp>,
    "endDate": <timestamp>,
    "flags": <integer>,
    "id": <long>,
    "note": <string>,
    "seats": <short>,
    "startDate": <timestamp>,
    "status": <enum>,
    "versionDate": <timestamp>
}

Get reservations

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

Path Parameters

Name

Type

Description

cloudId*

integer

Query Parameters

Name

Type

Description

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

[
 {
  // Reservation schema
 }
]

Get reservation

GET https://api.dotykacka.cz/v2/clouds/:cloudId/reservations/:reservationId

Path Parameters

Name

Type

Description

reservationId*

integer

cloudId*

integer

Headers

Name

Type

Description

If-None-Match

string

ETag to return results only if changed.

Authorization*

string

Bearer accessToken

{
    // Reservation schema
}

Create reservations

POST https://api.dotykacka.cz/v2/clouds/:cloudId/reservations

Path Parameters

Name

Type

Description

cloudId*

integer

Headers

Name

Type

Description

Authorization*

string

Bearer accessToken

Request Body

Name

Type

Description

array

Array of reservations. Maximum size 100.

[
    {
        // Reservation schema
        ...
    }
]

[
    {
        // Reservation schema
        ...
    }
]

Replace or create reservation

PUT https://api.dotykacka.cz/v2/clouds/:cloudId/reservations/:reservationId

Path Parameters

Name

Type

Description

reservationId*

integer

cloudId*

integer

Headers

Name

Type

Description

If-Match

string

ETag to update only if not changed.

Authorization*

string

Bearer accessToken

Request Body

Name

Type

Description

object

Reservation

{
    // Reservation schema
}

Type

Description

Authorization*

string

Bearer accessToken

Options reservation

OPTIONS https://api.dotykacka.cz/v2/clouds/:cloudId/reservations/:reservationId

Path Parameters

Name

Type

Description

reservationId*

integer

cloudId*

integer

Headers

Name

Type

Description

Authorization*

string

Bearer accessToken

Product Customization

Product Customization schema

id long? Product Customization ID - cannot be null in PUT/PATCH methods 📶 EQUALS,ENUM

deleted boolean Customization deleted 📶 EQUALS, ENUM 🔽 BOTH

flags integer Customization flags 📶 BITS

maxSelected integer Maximum selected items count

minSelected integer Minimum selected items count

name string?(400) Customization name 📶 STRING 🔽 BOTH

priceLevel enum? Define which price level use.

sortOrder long Customization sort order 🔽 BOTH

translatedName map<string, string>? A mapping of language codes to translated customization names. 🔽 NONE

versionDate timestamp? Last modification date and time 📶 EQUALS, ENUM, NUMBER 🔽 BOTH

ProductCustomization.priceLevel (enum)

// representation as string
B, C, D, E

priceLevels are only applicable in Poland. Settings for other countries are not reflected.

{
    "_categoryId": <long>,
    "_cloudId": <integer>,
    "_productId": <long>,
    "_defaultProductIds": [<long>, ... ],
    "deleted": <boolean>,
    "flags": <integer>,
    "id": <long>,
    "maxSelected": <integer>,
    "minSelected": <integer>,
    "name": <string>,
    "sortOrder": <integer>,
    "translatedName": <map<string, string>>,
    "versionDate": <timestamp>
}

Product customization flags

Bit

Name

DEFAULT_SELECTION_GRATIS

ONE_CHEAPEST_ITEM_GRATIS

ALL_ITEMS_GRATIS

Get product customizations

GET https://api.dotykacka.cz/v2/clouds/:cloudId/product-customizations

Get a custom-sorted paginated list of product customizations matching the filter criteria.

Path Parameters

Name

Type

Description

cloudId*

integer

ID of the cloud.

Query Parameters

Name

Type

Description

filter

string

Filter conditions.

sort

string

Sort parameter.

page

integer

Page to start with.

limit

integer

Page size (100 records maximum)

Headers

Name

Type

Description

POST https://api.dotykacka.cz/v2/clouds/:cloudId/product-customizations

Create a list of new product customizations.

Path Parameters

Name

Type

Description

cloudId*

string

ETag to update only if not changed.

Partial update of product customization

PATCH https://api.dotykacka.cz/v2/clouds/:cloudId/product-customizations/:entityId

Update a single product customization identified by its ID.

Path Parameters

Name

Type

Description

cloudId*

integer

ID of the cloud.

entityId*

integer

ID of the product customization to update.

Headers

Name

Type

Description

OPTIONS https://api.dotykacka.cz/v2/clouds/:cloudId/product-customizations

Path Parameters

Name

Type

Description

cloudId*

integer

ID of the cloud.

Headers

Name

Type

Description

Authorization*

string

Bearer accessToken

Options product customization

OPTIONS https://api.dotykacka.cz/v2/clouds/:cloudId/product-customizations/:entityId

Path Parameters

Name

Type

Description

cloudId*

integer

ID of the cloud.

entityId*

integer

ID of the product customization to get the options for.

Headers

Name

Type

Description

Authorization*

string

Bearer accessToken

Discount group

Discount group schema

id long? ID - cannot be null in PUT/PATCH methods 📶 EQUALS,ENUM

deleted boolean Discount group deleted - cannot be true in POST/PUT/PATCH methods 📶 EQUALS, ENUM 🔽 BOTH

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

display boolean Displayed 📶 EQUALS, ENUM 🔽 BOTH

externalId string 📶 EQUALS, ENUM

name string(100) Name for discount group 📶 EQUALS, ENUM

versionDate timestamp? Last modification date and time 📶 EQUALS, ENUM, NUMBER 🔽 BOTH

JSON response

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

Get discount groups

GET https://api.dotykacka.cz/v2/clouds/:cloudId/discount-groups

Path Parameters

Name

Type

Description

cloudId*

integer

Query Parameters

Name

Type

Description

page

integer

limit

integer

filter

string

sort

string

Headers

Name

Type

Description

If-None-Match

string

ETag to return results only if changed.

Authorization*

string

Bearer accessToken

[
    {
        Response schema
    },
    ...
]

Type

Description

Authorization*

string

Bearer accessToken

Request Body

Name

Type

Description

If-Match

string

ETag to update only if not changed.

Authorization*

string

Authorization*

string

Bearer accessToken

Delete discount group

DELETE https://api.dotykacka.cz/v2/clouds/:cloudId/discount-groups/:discountGroupId

Discount group cannot belong to any Customer (deleted=false). First remove discount group for all customers via GET/PUT methods. For GET method use filter=_discountGroupId|eq|discountGroupId

Path Parameters

Name

Type

Description

discountGroupId*

integer

cloudId*

integer

Headers

Name

Type

Description

If-Match

string

ETag ignored (temporarily) when deleting an entity.

Authorization*

string

Bearer accessToken

Options discount groups

OPTIONS https://api.dotykacka.cz/v2/clouds/:cloudId/discount-groups

Path Parameters

Name

Type

Description

cloudId*

integer

Headers

Name

Type

Description

Authorization*

string

Bearer accessToken

Options discount group

OPTIONS https://api.dotykacka.cz/v2/clouds/:cloudId/discount-groups/:discountGroupId

Path Parameters

Name

Type

Description

discountGroupId*

integer

cloudId*

integer

Headers

Name

Type

Description

Authorization*

string

Supplier

Supplier schema

id long? Supplier ID - cannot be null in PUT/PATCH methods 📶 EQUALS,ENUM 🔽 NONE

addressLine1 string(180) Address line 1 📶 EQUALS,STRING 🔽 NONE

addressLine2 string?(180) Address line 2 📶 EQUALS,STRING 🔽 NONE

city string(100) City 📶 EQUALS,STRING 🔽 NONE

companyId string(255) Supplier company ID (CZ: IČO, PL: REGON) 📶 EQUALS,ENUM 🔽 NONE

country string?(10) Country code 📶 EQUALS,ENUM 🔽 NONE

deleted boolean Supplier deleted - cannot be true in POST/PUT/PATCH methods 📶 EQUALS, ENUM 🔽 BOTH

deliveryNoteIds string?() Delivery note IDs 🔽 NONE

display boolean Supplier displayed 📶 EQUALS, ENUM 🔽 BOTH

email string(100) E-mail address 🔽 NONE

externalId string?(256) External ID 📶 EQUALS,ENUM 🔽 NONE

name string(180) Supplier name 📶 EQUALS,STRING 🔽 BOTH

phone string(20) Phone number 🔽 NONE

versionDate timestamp? Last modification date and time 📶 EQUALS, ENUM, NUMBER 🔽 BOTH

zip string(20) ZIP code 📶 EQUALS,ENUM 🔽 NONE

Supplier response

{
    "_cloudId": <integer>,
    "addressLine1": <string>,
    "addressLine2": <string>,
    "city": <string>,
    "companyId": <string>,
    "country": <string>,
    "deleted": <boolean>,
    "deliveryNoteIds": <string>,
    "display": <boolean>,
    "email": <string>,
    "externalId": null,
    "id": <long>,
    "name": <string>,
    "phone": <string>,
    "vatId": <string>,
    "versionDate": <timestamp>,
    "zip": <string>
}

Get suppliers

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

Get a custom-sorted paginated list of suppliers matching the filter criteria.

Path Parameters

Name

Type

Description

cloudId*

integer

ID of the cloud.

Query Parameters

Name

Type

Description

filter

string

Filter conditions.

sort

string

Sort parameter.

page

integer

Page to start with.

limit

integer

Page size (100 records maximum)

Headers

Name

Type

Description

POST https://api.dotykacka.cz/v2/clouds/:cloudId/suppliers

Create a list of new suppliers.

Path Parameters

Name

Type

Description

cloudId*

string

ETag to update only if not changed.

Partial update of supplier

PATCH https://api.dotykacka.cz/v2/clouds/:cloudId/suppliers/:entityId

Update a single supplier identified by its ID.

Path Parameters

Name

Type

Description

cloudId*

integer

ID of the cloud.

entityId*

integer

ID of the supplier to update.

Headers

Name

Type

Description

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

Path Parameters

Name

Type

Description

cloudId*

integer

ID of the cloud.

Headers

Name

Type

Description

Authorization*

string

Bearer accessToken

Options supplier

OPTIONS https://api.dotykacka.cz/v2/clouds/:cloudId/suppliers/:entityId

Path Parameters

Name

Type

Description

cloudId*

integer

ID of the cloud.

entityId*

integer

ID of the supplier to get the options for.

Headers

Name

Type

Description

Authorization*

string

Bearer accessToken

Warehouse Branch

The warehouse branch is an M:N relation entity between branches and warehouses. A branch can be configured to see many warehouses and a warehouse can be seen by many branches.

Warehouse-Branches schema

id long? Warehouse branch ID - cannot be null in PUT/PATCH methods 📶 EQUALS,ENUM

_warehouseId long Warehouse 📶 EQUALS,ENUM

flags integer Warehouse branch flags 📶 BITS

visible boolean [1] Whether the branch can see the warehouse 📶 EQUALS, ENUM

subscribed boolean [1] Whether the branch is subscribed for warehouse updates 📶 EQUALS, ENUM

version timestamp? Version date and time 📶 EQUALS, ENUM, NUMBER 🔽 BOTH

versionDate timestamp? Last modification date and time 📶 EQUALS, ENUM, NUMBER 🔽 BOTH

[1] In order to be allowed to set visible to true the subscribed must be true as well.

Warehouse-Branches response

{
    "_branchId": <integer>,
    "_cloudId": <integer>,
    "_warehouseId": <long>,
    "flags": <integer>,
    "id": <long>,
    "subscribed": <boolean>,
    "version": <timestamp>,
    "versionDate": <timestamp>,
    "visible": <boolean>
}

Get warehouse branches

GET https://api.dotykacka.cz/v2/clouds/:cloudId/warehouse-branches

Get a custom-sorted paginated list of warehouse branches matching the filter criteria.

Path Parameters

Name

Type

Description

cloudId*

integer

ID of the cloud.

Query Parameters

Name

Type

Description

sort

string

Sort parameter.

filter

string

Filter conditions.

page

integer

Page to start with.

limit

integer

Page size (100 records maximum)

Headers

Name

Type

Description

If-None-Match

string

ETag to return results only if changed.

Authorization*

string

Bearer accessToken

Get warehouse branch

GET https://api.dotykacka.cz/v2/clouds/:cloudId/warehouse-branches/:warehouseBranchId

Get a single warehouse branch identified by its ID.

Path Parameters

Name

Type

Description

cloudId*

integer

ID of the cloud.

warehouseBranchId*

integer

ID of the warehouse branch to get.

Headers

Name

Type

Description

If-None-Match

string

ETag to return results only if changed.

Authorization*

string

Bearer accessToken

{
    //Warehouse scheme
}

Create new warehouse branch

POST https://api.dotykacka.cz/v2/clouds/:cloudId/warehouse-branches

Create a list of new warehouse branches. An error is returned if the entity with the same _branchId and _warehouseId exists. Use PUT or PATCH for the entity with the required IDs in such cases.

Path Parameters

Name

Type

Description

cloudId*

Product schema

id long? Product ID - cannot be null in PUT/PATCH methods 📶 EQUALS,ENUM 🔽 NONE

alternativeName string? Product alternative name

currency string?(3) Currency code 🔽 NONE

deleted boolean Product deleted - cannot be true in POST/PUT/PATCH methods 📶 EQUALS, ENUM 🔽 BOTH

deliveryNoteIds string? Delivery note IDs 🔽 NONE

description string?(1000) Product description 🔽 NONE

discountPercent double Discount percent 🔽 NONE

discountPermitted boolean Discount permitted 📶 EQUALS, ENUM

display boolean Product displayed 📶 EQUALS, ENUM 🔽 BOTH

ean string[]? EAN codes 📶 EQUALS, ENUM 🔽 BOTH (sort by the first EAN code in the list)

externalId string? External ID 📶 EQUALS,ENUM 🔽 NONE

features string[] Product features like spicy, vegan etc. primarily used for EOS

flags integer Product flags 📶 BITS 🔽 NONE

hexColor string(7) Product color 🔽 NONE

imageUrl string? Product image for EOS services. The value of this field can only be deleted by setting it to null. Non-null values will be ignored.

margin string?(50) Product margin as an exact value (plain number without a currency symbol) or a percentage (number followed by a '%' sign). If the percentage format is used the margin must be <= 100%. 🔽 NONE

marginMin double? Minimal margin 🔽 NONE

modifiedBy string?(32) Product modified by 🔽 NONE

name string(400) Product name 📶 STRING🔽 BOTH

notes string[]?(1000) Product notes 🔽 NONE

onSale boolean Discount offer 📶 EQUALS, ENUM

packageItem double? Item's package 🔽 NONE

packaging double Number of items in a package 🔽 NONE

packagingMeasurement double? Measurement packaging for product 🔽 NONE

packagingPriceWithVat double? Price of the packaging with VAT primarily used for EOS 🔽 NONE

plu string[]? PLU codes 🔽 EQUALS, ENUM 🔽 BOTH (sort by the first PLU code in the list)

points double Points for buying the product 🔽 NONE

preparationDuration integer? The time in seconds needed to prepare the product 🔽 NONE

priceInPointsdouble Price value in points

priceWithVat double? Price with VAT 📶 EQUALS, ENUM 🔽 BOTH

priceWithVatB double? Alternative price with vat B

priceWithVatC double? Alternative price with vat C

priceWithVatD double? Alternative price with vat D

priceWithVatE double? Alternative price with vat E

priceWithoutVat double Price without VAT 🔽 BOTH

purchasePriceWithoutVat ~~double?~~ ~~Purchase price without VAT~~ 🔽 NONE

This field has been deprecated. It is ignored in update requests and not returned in responses.

requiresPriceEntry boolean Product requires price entry - must be set the same as the flag REQUIRES_PRICE_ENTRY because both values are used by our systems. 📶 EQUALS, ENUM

sortOrder long? Product sort order 🔽 NONE

stockDeduct boolean Product is deducted from Warehouse 📶 EQUALS, ENUM

subtitle string?(500) Product subtitle 🔽 NONE

supplierProductCode string? Supplier's product code 🔽 NONE

tags string[]? Tags for a product, must not contain any of these characters: ,^?*()[]$ 📶 EQUALS, ENUM

translatedDescription map<string, string>? A mapping of language codes to translated product descriptions. 🔽 NONE

translatedName map<string, string>? A mapping of language codes to translated product names. 🔽 NONE

vat double VAT value (a multiplier from range <1.0; 2.0>, f.e. vat=1.234 corresponds to VAT 23.4%) 📶 EQUALS 🔽 BOTH

~~For VAT payers this value is validated and it must correspond to one of the configured VAT rates.~~

versionDate timestamp? Last modification date and time 📶 EQUALS, ENUM, NUMBER 🔽 BOTH

Product.stockOverdraft (enum)

Product response

Product flags

Get products

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

Path Parameters

Query Parameters

Headers

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

customizations- list of customizations
ingredients - list of ingredients

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

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

Get product

Path Parameters

Headers

Request Body

[1] Can be one of the following: ERROR, PRESERVE, DELETE. An example BODY can look like this:

If no request BODY is sent (default) or a JSON object with the strategy ERROR is sent and the product has own ingredients or is an ingredient of another product then the API returns an error response with status 409 Conflict with a BODY like in this example:

If a request with a strategy DELETE is issued and the product has own ingredients or is an ingredient of another product then the related ingredients are deleted. If a request with a strategy PRESERVE is issued then no ingredients are deleted (ingredients will be preserved).

If a request with a strategy DELETE is issued and the user does not have the permission to delete ingredients then the API returns the following error response:

Options products

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

Path Parameters

Headers

Options product

OPTIONS https://api.dotykacka.cz/v2/clouds/:cloudId/products/:productId

Path Parameters

Headers

Warehouse

Warehouse schema

id long? Warehouse ID - cannot be null in PUT/PATCH methods 📶 EQUALS,ENUM 🔽 NONE

barcode string?(180) Bar code 📶 EQUALS,ENUM 🔽 NONE

deleted boolean Category deleted - cannot be true in POST/PUT/PATCH methods 📶 EQUALS, ENUM 🔽 BOTH

enabled boolean Warehouse enabled 📶 EQUALS, ENUM

hexColor string?(7) Warehouse color 🔽 NONE

name string(180) Warehouse name 📶 EQUALS,STRING 🔽 BOTH

versionDate timestamp? Last modification date and time 📶 EQUALS,ENUM,NUMBER 🔽 BOTH

Warehouse response

Get warehouses

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

Path Parameters

Query Parameters

Headers

Get warehouse

Path Parameters

Headers

StockUp schema

currency string? Currency to be set for the operation (default if not specified: CZK)

invoiceNumber string Invoice number - must not be empty

note string? Custom note

updatePurchasePrice boolean Update product purchase prices

items array[1,100] Array of items to stock up (see below)

Nested array of items

externalId string? [1] External ID

purchasePrice double? Purchase price

quantity double Items quantity

sellPrice double? Product sell price

[1] One of _productId or externalId must not be null.

StockUp request

Stockup to warehouse

POST https://api.dotykacka.cz/v2/clouds/:cloudId/warehouses/:warehouseId/stockups

Path Parameters

Headers

Request Body

Transfer schema

currency string? Currency to be set for the operation (default if not specified: CZK)

invoiceNumber string Invoice number - must not be empty

note string? Custom note

updatePurchasePrice boolean Update product purchase prices

items array[1,100] Array of items to transfer (see below)

Nested array of items

externalId string? [1] External ID

purchasePrice double? Purchase price

quantity double Items quantity

[1] One of _productId or externalId must not be null.

Transfer request

Transfer to warehouse

POST https://api.dotykacka.cz/v2/clouds/:cloudId/warehouses/:warehouseId/transfers

Path Parameters

Headers

Request Body

Sale schema

currency string? Currency to be set for the operation (default if not specified: CZK)

items array[1,100] Array of items to sell (see below)

Nested array of items

externalId string? [1] External ID

note string? Custom note

quantity double Items quantity

[1] One of _productId or externalId must not be null.

Sale request

Sale product on warehouse

POST https://api.dotykacka.cz/v2/clouds/:cloudId/warehouses/:warehouseId/sales

Path Parameters

Headers

Request Body

Stock-taking schema

note string? Custom note.

stockTakingDate timestamp The date and time of the stock-taking.

items array Array of items for the stock-taking (see below)

Nested array of items

_productId long The product ID.

quantity BigDecimal The new quantity of the product in the warehouse.

Stock-taking request

Perform a stock-taking

POST https://api.dotykacka.cz/v2/clouds/:cloudId/warehouses/:warehouseId/stock-takings

Perform the stock-taking action for the specified warehouse and products. The stockTakingDate must be after the last stock-taking date (see the next endpoint) and it cannot be in the future.

This endpoint is asynchronous - the status of the operation can be monitored by a GET request on the statusWebhookUrl from the response.

Path Parameters

Headers

Request Body

Response

Response from the GET request on the URL from `statusWebhookUrl`

Possible values of the status field:

PROCESSING
FINISHED
FAILED

Possible values of the reason field:

STOCK_TAKING_DATE_IN_FUTURE
PRODUCT_DOES_NOT_EXIST
PRODUCT_STOCK_TAKING_IN_FUTURE
PRODUCT_STOCK_TAKING_AFTER_DATE
UNEXPECTED

Examples:

Get last stock-taking dates schema

_productIds array Array of product IDs to get the last stock-taking dates for.

Get last stock-taking dates request

Get last stock-taking dates

POST https://api.dotykacka.cz/v2/clouds/:cloudId/warehouses/:warehouseId/stock-taking-dates

Get last stock-taking dates for the specified warehouse and products. These dates can be used to prepare a valid stockTakingDate for the stock-taking endpoint.

Path Parameters

Headers

Request Body

Response

Note: Only the products that participated in any stock-taking in the history are included in the response. Products without any stock-taking will not be mentioned in the response.

Release notes

2025-04-02

Fixes

Fix minor issues and internal improvements in the API.

2025-03-27

Fixes

Fix minor issues and internal improvements in the API.

2025-03-05

Fixes

Fix minor issues and internal improvements in the API.

2025-02-19

Fixes

Fix minor issues and internal improvements in the API.

2025-02-12

New

Fixes

Fix minor issues and internal improvements in the API.

2025-02-05

Fixes

Fix minor issues and internal improvements in the API.

2025-01-29

Fixes

Fix minor issues and internal improvements in the API.

2025-01-22

Fixes

Fix minor issues and internal improvements in the API.

2025-01-15

Fixes

Fix minor issues and internal improvements in the API.

2025-01-09

Fixes

Fix minor issues and internal improvements in the API.

2024-12-19

Fixes

Fix minor issues and internal improvements in the API.

2024-12-17

Fixes

Fix minor issues and internal improvements in the API.

2024-12-11

New

Fixes

Fix minor issues and internal improvements in the API.

2024-12-04

Fixes

Fix minor issues and internal improvements in the API.

2024-11-28

New

Response code is returned when the order is issued, but fiscalization failed.

2024-11-27

Fixes

Fix minor issues and internal improvements in the API.

2024-11-20

Fixes

Fix minor issues and internal improvements in the API.

2024-11-13

New

Fixes

Fix minor issues and internal improvements in the API.

2024-11-07

Fixes

Fix minor issues and internal improvements in the API.

2024-11-06

Fixes

Fix minor issues and internal improvements in the API.

2024-10-30

Fixes

Fix minor issues and internal improvements in the API.

2024-10-23

Fixes

Fix minor issues and internal improvements in the API.

2024-10-16

Fixes

Fix minor issues and internal improvements in the API.

2024-10-09

Fixes

Fix minor issues and internal improvements in the API.

2024-09-25

Fixes

2024-09-16

Fixes

Issues caused by deprecation of the field purchase price without VAT on 2024-09-11.

2024-09-12

Breaking change for POS Actions in Slovakia

Dotypos Cash Register App 2.10

Adds handling for new fiscal printer failure state in Slovakia.

New BLOCKED_BY_FAILED_PRINT error code.
New pass-through error for failed fiscal print.

2024-09-11

New

Fixes

Fix minor issues and internal improvements in the API.

2024-08-28

New

Fixes

Fix minor issues and internal improvements in the API.

2024-08-21

New

Fixes

Fix minor issues and internal improvements in the API.

2024-08-14

New

Fixes

Fix minor issues and internal improvements in the API.

2024-08-07

Fixes

Fix minor issues and internal improvements in the API.

2024-07-31

Fixes

Fix minor issues and internal improvements in the API.

2024-07-24

Fixes

Fix minor issues and internal improvements in the API.

2024-07-17

Fixes

Fix minor issues and internal improvements in the API.

2024-06-26

Fixes

Fix minor issues and internal improvements in the API.

2024-06-21

Fixes

Fix minor issues and internal improvements in the API.

2024-06-19

Fixes

Fix minor issues and internal improvements in the API.

2024-06-12

New

2024-06-04

Fixes

Fix minor issues and internal improvements in the API.

2024-05-29

Fixes

Fix minor issues and internal improvements in the API.

2024-05-10

Fixes

Fix minor issues and internal improvements in the API.

2024-05-03

Fixes

Fix minor issues and internal improvements in the API.

2024-04-24

New

Fixes

Fix minor issues and internal improvements in the API.

2024-04-17

Fixes

Fix minor issues and internal improvements in the API.

2024-04-11

Fixes

2024-04-10

Fixes

Fix minor issues and internal improvements in the API.

2024-03-27

Fixes

Fix minor issues and internal improvements in the API.

2024-03-20

Fixes

Fix minor issues and internal improvements in the API.

2024-03-13

Fixes

Fix minor issues and internal improvements in the API.

2024-03-06

Fixes

Fix minor issues and internal improvements in the API.

2024-02-28

Fixes

Fix minor issues and internal improvements in the API.

2024-02-21

Fixes

Fix minor issues and internal improvements in the API.

2024-02-14

Fixes

Fix minor issues and internal improvements in the API.

2024-02-08

New

Fixes

Fix minor issues and internal improvements in the API.

2024-02-06

Fixes

Fix minor issues and internal improvements in the API.

2024-02-01

New

Fixes

Fix minor issues and internal improvements in the API.

2024-01-17

Fixes

Fix minor issues and internal improvements in the API.

2024-01-05

Fixes

Fix minor issues and internal improvements in the API.

2024-01-03

Fixes

Fix minor issues and internal improvements in the API.

2023-12-07

Fixes

Fix minor issues and internal improvements in the API.

2023-12-06

Fixes

Fix minor issues and internal improvements in the API.

2023-11-22

Fixes

Fix minor issues and internal improvements in the API.

2023-11-15

New

2023-11-07

Fixes

Fix minor issues and internal improvements in the API.

2023-11-01

Fixes

Fix minor issues and internal improvements in the API.

2023-10-25

Fixes

Fix minor issues and internal improvements in the API.

2023-10-18

Fixes

Fix minor issues and internal improvements in the API.

2023-10-11

Fixes

Fix minor issues and internal improvements in the API.

2023-10-04

Fixes

2023-09-27

Fixes

Fix minor issues and internal improvements in the API.

2023-09-26

Fixes

Fix minor issues and internal improvements in the API.

2023-09-21

Fixes

Fix minor issues and internal improvements in the API.

2023-09-20

Fixes

Fix minor issues and internal improvements in the API.

2023-09-13

Fixes

Fix minor issues and internal improvements in the API.

2023-09-06

Fixes

Fix minor issues and internal improvements in the API.

2023-08-30

Fixes

Fix minor issues and internal improvements in the API.

2023-08-18

Fixes

Fix minor issues and internal improvements in the API.

2023-07-19

Fixes

Fix minor issues and internal improvements in the API.

2023-06-28

Fixes

2023-06-21

Fixes

Fix minor issues and internal improvements in the API.

2023-06-14

Fixes

Fix minor issues and internal improvements in the API.

2023-06-07

Fixes

Fix minor issues and internal improvements in the API.

2023-06-01

Fixes

2023-05-30

Fixes

Fix minor issues and internal improvements in the API.

2023-05-24

Fixes

Fix minor issues and internal improvements in the API.

2023-05-17

Fixes

Fix minor issues and internal improvements in the API.

2023-05-10

Fixes

2023-05-03

Fixes

Fix minor issues and internal improvements in the API.

2023-04-26

Fixes

2023-04-19

Fixes

Fix minor issues and internal improvements in the API.

2023-04-12

Fixes

Fix minor issues and internal improvements in the API.

2023-03-29

Fixes

Fix minor issues and internal improvements in the API.

2023-03-22

Fixes

Fix minor issues and internal improvements in the API.

2023-03-15

Fixes

Fix minor issues and internal improvements in the API.

2023-03-09

Fixes

Fix minor issues and internal improvements in the API.

2023-03-01

Fixes

Fix minor issues and internal improvements in the API.

2023-02-22

Fixes

Fix minor issues and internal improvements in the API.

2023-02-16

Fixes

Fix minor issues and internal improvements in the API.

2023-02-08

New

Fixes

Fix minor issues and internal improvements in the API.

2023-02-01

Fixes

Fix minor issues and internal improvements in the API.

2023-01-25

Fixes

Fix minor issues and internal improvements in the API.

2023-01-24

New

2023-01-18

New

Fixes

Fix minor issues and internal improvements in the API.

2023-01-11

New

2023-01-04

New

Fixes

Fix minor issues and internal improvements in the API.

2023-01-02

New

2022-12-21

Fixes

Fix minor issues and internal improvements in the API.

2022-12-14

Fixes

Fix minor issues and internal improvements in the API.

2022-12-07

New

2022-11-30

New

Allow deleting reservations for a deleted table.

Fixes

Fix minor issues and internal improvements in the API.

2022-11-25

Fixes

2022-11-23

Fixes

Fix minor issues and internal improvements in the API.

2022-11-16

New

Fixes

Fix minor issues and internal improvements in the API.

2022-11-09

Fixes

Fix minor issues and internal improvements in the API.

2022-11-03

New

Add action for order cancellation

Fixes

Fix and improve remote printing

2022-11-02

New

Add supported filters and sortings:
- - sortOrder 🔽 BOTH
- - sortOrder 🔽 BOTH
- - note 📶 STRING
  - status 📶 EQUALS,ENUM
  - documentNumber 📶 EQUALS,ENUM, STRING
  - points 📶 EQUALS,NUMBER
  - externalId 📶 EQUALS,ENUM
- - note 📶 STRING
  - subtitle 📶 STRING
- Table
  - seats 📶 EQUALS,NUMBER 🔽 BOTH
  - locationName 📶 EQUALS,ENUM 🔽 BOTH

2022-10-19

New

2022-10-12

Fixes

Fix minor issues and internal improvements in the API.

2022-10-05

Fixes

Fix minor issues and internal improvements in the API.

2022-10-03

New

2022-09-28

Fixes

Fix minor issues and internal improvements in the API.

2022-09-08

New

2022-08-23

New

2022-06-27

Fixes

Describe request not allowed in Slovakia.

2022-06-08

New

Fixes

Fix few typos.
Make docs a bit more clear.

2022-03-29

Fixes

Fix minor issues and internal improvements in the API.

2022-03-16

Fixes

Fix minor issues and internal improvements in the API.

2022-01-13

New

Fixes

Fix minor issues and internal improvements in the API.

2021-12-17

New

Fixes

Fix minor issues and internal improvements in the API.

2021-12-08

Fixes

Fix filtering of timestamp values with time zone.

2021-12-01

New

Fixes

Products with many customizations synchronized with Bolt correctly.
Do not allow deleting and permission editing for administrator accounts.

2021-11-09

New

Fixes

2021-11-01

New

2021-10-20

New

2021-10-12

New

Performance improvements.

Fixes

Fix minor issues in the API and in the documentation.

2021-09-29

New

Document ID is generated if null when importing Delivery notes.
Product customization can be excluded from publication in EOS.

Fixes

Fix validation of the document ID format (UUID) in the delivery note XML.

2021-09-22

Fixes

Deny access to clouds that have allowed=false.

2021-09-08

New

Add filters and sort:
- Category
  - name 📶 STRING 🔽 BOTH
- Tag
  - name 📶 STRING🔽 BOTH
- Employee
  - name 📶 STRING🔽 BOTH
  - email 📶 STRING🔽 BOTH
- MoneyLog
  - transactionType 📶 EQUALS, ENUM
  - paymentTypeId 📶 EQUALS, ENUM
- Customer
  - companyName 📶 STRING🔽 BOTH
  - firstName 📶 STRING🔽 BOTH
  - lastName 📶 STRING🔽 BOTH
- Order
  - documentType 📶 EQUALS, ENUM
- OrderItem
  - name 📶 STRING 🔽 BOTH
- Course
  - name 📶 STRING 🔽 BOTH
- Table
  - name 📶 STRING 🔽 BOTH
  - type 📶 EQUALS, ENUM

Fixes

Fix bug causing invalid response object for some clients.

2021-08-10

Fixes

Fix minor issues.

2021-08-02

Fixes

Rollback the change that wrapped the downloaded XML document inside a <DEASDV> tag.

2021-07-30

New

Fixes

2021-07-23

New

Fixes

2021-06-30

2021-06-21

Fixes

2021-06-18

New

2021-06-09

New

2021-05-04

Fixes

2021-04-28

New

Fixes

2021-04-23

New

Add support for takeaway on items.
Add support for order takeaway.

2021-04-21

New

Fixes

2021-04-14

Fixes

2021-04-13

New

Fixes

2021-04-12

New

Add support for changing items' courses.
Add support for course preparation command.

2021-03-30

Fixes

Fix error when deleting an Employee.

2021-03-25

New

Changes

2021-02-26

New

Fixes

2021-02-03

Changes

2020-12-16

New

2020-11-11

New

Create/update product ingredients and product customizations.
Filter to get open orders and open order items.
Delivery notes importing.

2020-10-30

Changes

2020-10-23

Changes

Fixes

Improved performance when paging these entities: Orders, Order items and Money logs.

Base Sales Report

Base Sales Report schema

Simplified JSON response

{
    "created": <timestamp>,
    "from": <timestamp>,
    "to": <timestamp>,
    "registerName": <string>,
    "moneyTransactionInfo": {
        "currency": <string>,
        "saleCount": <integer>,
        "saleValue": <double>,
        "rawSaleValue": <double>,
        "cancelCount": <integer>,
        "cancelValue": <double>,
        "rawCancelValue": <double>,
        "cashAdvanceCount": <integer>,
        "cashAdvanceValue": <double>,
        "rawCashAdvanceValue": <double>,
        "cashInCount": <integer>,
        "cashInValue": <double>,
        "rawCashInValue": <double>,
        "cashOutCount": <integer>,
        "cashOutValue": <double>,
        "rawCashOutValue": <double>,
        "alternativeCurrencySalesAmount": {
            "amount": <double>,
            "currencyCode": <string>
        },
        "alternativeCurrencyCancelAmount": {
            "amount": <double>,
            "currencyCode": <string>
        },
        "alternativeCurrencyCashAdvanceAmount": {
            "amount": <double>,
            "currencyCode": <string>
        },
        "alternativeCurrencyCashInAmount": {
            "amount": <double>,
            "currencyCode": <string>
        },
        "alternativeCurrencyCashOutAmount": {
            "amount": <double>,
            "currencyCode": <string>
        }
    },
    "revenue": {
        "totalWithVat": <double>,
        "totalVat": <double>,
        "totalWithoutVat": <double>,
        "vatInfo": [ ... ],
        "paymentTypeInfo": [ ... ]
    },
    "discounts": [ ... ],
    "cashInOutTransactions": [ ... ],
    "categorySales": [ ... ],
    "productSales": [ ... ],
    "tagSales": [ ... ],
    "employeeSales": [ ... ],
    "customerSales": [ ... ],
    "proxySales": [ ... ],
    "takeawaySales": [ ... ],
    "fiscalizationSales": [ ... ],
    "receiptInfo": [ ... ],
    "employeePayments": [ ... ],
    "employeeTips": [ ... ],
    "paymentMethodTips": [ ... ],
    "writeoffs": [
        {
            "productId": <long>,
            "name": <string>,
            "count": <double>,
            "pricePurchaseWithoutVat": <double>,
            "unit": <string>,
            "currency": <string>
        },
        ...
    ]
}

Field descriptions

created timestamp Report created date and time

from timestamp Report start date and time

to timestamp Report end date and time

registerName string Branch name

moneyTransactionInfo.currency string Money transactions - primary currency

moneyTransactionInfo.saleCount integer Money transactions - sales count

moneyTransactionInfo.saleValue double Money transactions - sales value

moneyTransactionInfo.rawSaleValue double Money transactions - sales value in alternative currency

moneyTransactionInfo.cancelCount integer Money transactions - cancelled count

moneyTransactionInfo.cancelValue double Money transactions - cancelled value

moneyTransactionInfo.rawCancelValue double Money transactions - cancelled value in alternative currency

moneyTransactionInfo.cashAdvanceCount integer Money transactions - cash advance count

moneyTransactionInfo.cashAdvanceValue double Money transactions - cash advance value

moneyTransactionInfo.rawCashAdvanceValue double Money transactions - cash advance value in alternative currency

moneyTransactionInfo.cashInCount integer Money transactions - cash in count

moneyTransactionInfo.cashInValue double Money transactions - cash in value

moneyTransactionInfo.rawCashInValue double Money transactions - cash in value in alternative currency

moneyTransactionInfo.cashOutCount integer Money transactions - cash out count

moneyTransactionInfo.cashOutValue double Money transactions - cash out value

moneyTransactionInfo.rawCashOutValue double Money transactions - cash out value in alternative currency

moneyTransactionInfo.alternativeCurrencySalesAmount.amount double Money transactions - sales amount in alternative currency

moneyTransactionInfo.alternativeCurrencyCancelAmount.amount double Money transactions - cancellations amount in alternative currency

moneyTransactionInfo.alternativeCurrencyCashAdvanceAmount.amount double Money transactions - cash advance in alternative currency

moneyTransactionInfo.alternativeCurrencyCashInAmount.amount double Money transactions - cash in amount in alternative currency

moneyTransactionInfo.alternativeCurrencyCashOutAmount.amount double Money transactions - cash out amount in alternative currency

revenue.totalWithVat double Revenue - total value with VAT

revenue.totalVat double Revenue - total VAT value

revenue.totalWithoutVat double Revenue - total value without VAT

revenue.vatInfo.rate double Revenue - VAT rate

revenue.vatInfo.base double Revenue - VAT base value

revenue.vatInfo.value double Revenue - VAT value

revenue.vatInfo.special double Revenue - VAT special

revenue.paymentTypeInfo.typeId integer Revenue - payment type id

revenue.paymentTypeInfo.count integer Revenue - count for the payment type

revenue.paymentTypeInfo.total double Revenue - total value for the payment type

revenue.paymentTypeInfo.rawTotal double Revenue - total value for the payment type in alternative currency

revenue.paymentTypeInfo.currency string Revenue - alternative currency for the rawTotal

discounts.employee.name string Discounts - employee name

discounts.employee.id long Discounts - employee ID

discounts.count integer Discounts - count

discounts.value double Discounts - value

discounts.valueWithoutVat double Discounts - value without VAT

cashInOutTransactions.id long Cash in/out transactions - money log ID

cashInOutTransactions.dir boolean Cash in/out transactions - always false (unused)

cashInOutTransactions.created timestamp Cash in/out transactions - money log created

cashInOutTransactions.employee.name string Cash in/out transactions - employee name

cashInOutTransactions.employee.id long Cash in/out transactions - employee ID

cashInOutTransactions.value double Cash in/out transactions - money log value

cashInOutTransactions.note string Cash in/out transactions - money log note

categorySales.value double Sales by category - value

categorySales.valueWithoutNonPurchase double Sales by category - value without non purchase

categorySales.purchaseValue double Sales by category - purchase value

categorySales.valueWithoutVAT double Sales by category - value without VAT

categorySales.valueWithoutNonPurchaseWithoutVAT double Sales by category - value without non purchase without VAT

categorySales.purchaseValueWithoutVAT double Sales by category - purchase value without VAT

categorySales.id long Sales by category - category ID

categorySales.name string Sales by category - category name

productSales.value double Sales by product - value

productSales.valueWithoutNonPurchase double Sales by product - value without non purchase

productSales.purchaseValue double Sales by product - purchase value

productSales.valueWithoutVAT double Sales by product - value without VAT

productSales.valueWithoutNonPurchaseWithoutVAT double Sales by product - value without non purchase without VAT

productSales.purchaseValueWithoutVAT double Sales by product - purchase value without VAT

productSales.id long Sales by product - product ID

productSales.name string Sales by product - product name

productSales.count integer Sales by product - items count

productSales.unit enum Sales by product - item units

productSales.categoryId long Sales by product - category ID

tagSales.value double Sales by tag - value

tagSales.valueWithoutNonPurchase double Sales by tag - value without non purchase

tagSales.purchaseValue double Sales by tag - purchase value

tagSales.valueWithoutVAT double Sales by tag - value without VAT

tagSales.valueWithoutNonPurchaseWithoutVAT double Sales by tag - value without non purchase without VAT

tagSales.purchaseValueWithoutVAT double Sales by tag - purchase value without VAT

tagSales.name string Sales by tag - tag name

employeeSales.value double Sales by employee - value

employeeSales.valueWithoutNonPurchase double Sales by employee - value without non purchase

employeeSales.purchaseValue double Sales by employee - purchase value

employeeSales.valueWithoutVAT double Sales by employee - value without VAT

employeeSales.valueWithoutNonPurchaseWithoutVAT double Sales by employee - value without non purchase without VAT

employeeSales.purchaseValueWithoutVAT double Sales by employee - purchase value without VAT

employeeSales.id long Sales by employee - employee ID

employeeSales.name string Sales by employee - employee name

customerSales.value double Sales by customer - value

customerSales.valueWithoutNonPurchase double Sales by customer - value without non purchase

customerSales.purchaseValue double Sales by customer - purchase value

customerSales.valueWithoutVAT double Sales by customer - value without VAT

customerSales.valueWithoutNonPurchaseWithoutVAT double Sales by customer - value without non purchase without VAT

customerSales.purchaseValueWithoutVAT double Sales by customer - purchase value without VAT

customerSales.id long Sales by customer - customer ID

customerSales.name string Sales by customer - customer name

proxySales.value double Sales by EET subject - value

proxySales.valueWithoutNonPurchase double Sales by EET subject - value without non purchase

proxySales.purchaseValue double Sales by EET subject - purchase value

proxySales.valueWithoutVAT double Sales by EET subject - value without VAT

proxySales.valueWithoutNonPurchaseWithoutVAT double Sales by EET subject - value without non purchase without VAT

proxySales.purchaseValueWithoutVAT double Sales by EET subject - purchase value without VAT

proxySales.id long Sales by EET subject - EET subject ID

proxySales.name string Sales by EET subject - EET subject name

takeawaySales.value double Sales by take-away/eat-in - value

takeawaySales.valueWithoutNonPurchase double Sales by take-away/eat-in - value without non purchase

takeawaySales.purchaseValue double Sales by take-away/eat-in - purchase value

takeawaySales.valueWithoutVAT double Sales by take-away/eat-in - value without VAT

takeawaySales.valueWithoutNonPurchaseWithoutVAT double Sales by take-away/eat-in - value without non purchase without VAT

takeawaySales.purchaseValueWithoutVAT double Sales by take-away/eat-in - purchase value without VAT

takeawaySales.id integer Sales by take-away/eat-in - 1 = take-away, 0 = eat-in

fiscalizationSales.value double Sales by fiscalization - value

fiscalizationSales.valueWithoutNonPurchase double Sales by fiscalization - value without non purchase

fiscalizationSales.purchaseValue double Sales by fiscalization - purchase value

fiscalizationSales.valueWithoutVAT double Sales by fiscalization - value without VAT

fiscalizationSales.valueWithoutNonPurchaseWithoutVAT double Sales by fiscalization - value without non purchase without VAT

fiscalizationSales.purchaseValueWithoutVAT double Sales by fiscalization - purchase value without VAT

fiscalizationSales.id integer Sales by fiscalization - 1 = fiscalization required, 0 = not required

receiptInfo.type string Order items - item type: "cancelled", "cancellation", "unpaid", "total"

receiptInfo.value double Order items - value of items of the given type

receiptInfo.count integer Order items - count of items of the given type

employeePayments.employeeId long Payments by employee - Employee ID

employeePayments.employeeName string Payments by employee - Employee name

employeePayments.paymentMethodId integer Payments by employee - Payment method ID

employeePayments.count integer Payments by employee - Count of payments

employeePayments.total double Payments by employee - Total value of payments

employeePayments.rawTotal double Payments by employee - Total value of payments in alternative currency

employeePayments.currency string Payments by employee - Alternative currency for the rawTotal

employeeTips.name string Tips by employee - Employee name

employeeTips.currency string Tips by employee - Alternative currency

employeeTips.tipAmount double Tips by employee - Total value of tips for the employee in the alternative currency.

employeeTips.tipAmountMainCurrency double Tips by employee - Total value of tips for the employee in the main currency.

paymentMethodTips.name string Tips by payment methods - Payment method name (localized using the lang query parameter)

paymentMethodTips.currency string Tips by payment methods - Alternative currency

paymentMethodTips.tipAmount double Tips by payment methods - Total value of tips for the payment method in the alternative currency.

paymentMethodTips.tipAmountMainCurrency double Tips by payment methods - Total value of tips for the payment method in the main currency.

writeoffs.productId long Written off items - product ID

writeoffs.name string Written off items - product name

writeoffs.count double Written off items - count (quantity)

writeoffs.pricePurchaseWithoutVat double Written off items - purchase price without VAT

writeoffs.unit string Written off items - unit of the quantity

writeoffs.currency string Written off items - currency of the purchase price

Generate the base sales report

GET https://api.dotykacka.cz/v2/clouds/:cloudId/branches/:branchId/sales-report

Generate the base sales report.

Path Parameters

Name

Type

Description

cloudId

integer

ID of the cloud.

branchId

integer

ID of the branch.

Query Parameters

Name

Type

Description

vatPayer

boolean

Whether you are a VAT payer or not.

dateFrom

string

Interval start date as an ISO date-time with zone offset or a time-stamp in milliseconds.

dateTo

string

Interval end date as an ISO date-time with zone offset or a time-stamp in milliseconds.

_sellerId

number

Seller ID used as a filter or null to count all the sellers.

lang

string

2-letter lowercase ISO language code.

Headers

Name

Type

Description

Authorization

string

Bearer accessToken

{
    "created": <timestamp>,
    "from": <timestamp>,
    "to": <timestamp>,
    "registerName": <string>,
    "moneyTransactionInfo": {
        "currency": <string>,
        "saleCount": <integer>,
        "saleValue": <double>,
        "cancelCount": <integer>,
        "cancelValue": <double>,
        "cashAdvanceCount": <integer>,
        "cashAdvanceValue": <double>,
        "cashInCount": <integer>,
        "cashInValue": <double>,
        "cashOutCount": <integer>,
        "cashOutValue": <double>,
        "alternativeCurrencySalesAmount": {
            "amount": <double>,
            "currencyCode": <string>
        },
        "alternativeCurrencyCancelAmount": {
            "amount": <double>,
            "currencyCode": <string>
        },
        "alternativeCurrencyCashAdvanceAmount": {
            "amount": <double>,
            "currencyCode": <string>
        },
        "alternativeCurrencyCashInAmount": {
            "amount": <double>,
            "currencyCode": <string>
        },
        "alternativeCurrencyCashOutAmount": {
            "amount": <double>,
            "currencyCode": <string>
        }
    },
    "revenue": {
        "totalWithVat": <double>,
        "totalVat": <double>,
        "totalWithoutVat": <double>,
        "vatInfo": [
            {
                "rate": <double>,
                "base": <double>,
                "value": <double>,
                "special": <double>
            }
        ],
        "paymentTypeInfo": [
            {
                "typeId": <integer>,
                "count": <integer>,
                "total": <double>,
                "rawTotal": <double>,
                "currency": <string>
            }
        ]
    },
    "discounts": [
        {
            "employee": {
                "name": <string>,
                "id": <integer>
            },
            "count": <integer>,
            "value": <double>,
            "valueWithoutVat": <double>
        }
    ],
    "cashInOutTransactions": [
        {
            "id": <integer>,
            "dir": <boolean>,
            "created": <timestamp>,
            "employee": {
                "name": <string>,
                "id": <integer>
            },
            "value": <double>,
            "note": <string>
        }
    ],
    "categorySales": [
        {
            "value": <double>,
            "valueWithoutNonPurchase": <double>,
            "purchaseValue": <double>,
            "valueWithoutVAT": <double>,
            "valueWithoutNonPurchaseWithoutVAT": <double>,
            "purchaseValueWithoutVAT": <double>,
            "id": <integer>,
            "name": <string>
        }
    ],
    "productSales": [
        {
            "value": <double>,
            "valueWithoutNonPurchase": <double>,
            "purchaseValue": <double>,
            "valueWithoutVAT": <double>,
            "valueWithoutNonPurchaseWithoutVAT": <double>,
            "purchaseValueWithoutVAT": <double>,
            "id": <integer>,
            "name": <string>,
            "count": <number>,
            "unit": <enum>,
            "categoryId": <integer>
        }
    ],
    "tagSales": [
        {
            "value": <double>,
            "valueWithoutNonPurchase": <double>,
            "purchaseValue": <double>,
            "valueWithoutVAT": <double>,
            "valueWithoutNonPurchaseWithoutVAT": <double>,
            "purchaseValueWithoutVAT": <double>,
            "name": <string>
        }
    ],
    "employeeSales": [
        {
            "value": <double>,
            "valueWithoutNonPurchase": <double>,
            "purchaseValue": <double>,
            "valueWithoutVAT": <double>,
            "valueWithoutNonPurchaseWithoutVAT": <double>,
            "purchaseValueWithoutVAT": <double>,
            "id": <integer>,
            "name": <string>
        }
    ],
    "customerSales": [
        {
            "value": <double>,
            "valueWithoutNonPurchase": <double>,
            "purchaseValue": <double>,
            "valueWithoutVAT": <double>,
            "valueWithoutNonPurchaseWithoutVAT": <double>,
            "purchaseValueWithoutVAT": <double>,
            "id": <integer>,
            "name": <string>
        }
    ],
    "proxySales": [
        {
            "value": <double>,
            "valueWithoutNonPurchase": <double>,
            "purchaseValue": <double>,
            "valueWithoutVAT": <double>,
            "valueWithoutNonPurchaseWithoutVAT": <double>,
            "purchaseValueWithoutVAT": <double>,
            "id": <integer>,
            "name": <string>
        }
    ],
    "takeawaySales": [
        {
            "value": <double>,
            "valueWithoutNonPurchase": <double>,
            "purchaseValue": <double>,
            "valueWithoutVAT": <double>,
            "valueWithoutNonPurchaseWithoutVAT": <double>,
            "purchaseValueWithoutVAT": <double>,
            "id": <integer>
        }
    ],
    "fiscalizationSales": [
        {
            "value": <double>,
            "valueWithoutNonPurchase": <double>,
            "purchaseValue": <double>,
            "valueWithoutVAT": <double>,
            "valueWithoutNonPurchaseWithoutVAT": <double>,
            "purchaseValueWithoutVAT": <double>,
            "id": <integer>
        }
    ],
    "receiptInfo": [
        {
            "type": "cancelled",
            "value": <double>,
            "count": <integer>
        },
        {
            "type": "cancellation",
            "value": <double>,
            "count": <integer>
        },
        {
            "type": "unpaid",
            "value": <double>,
            "count": <integer>
        },
        {
            "type": "total",
            "value": <double>,
            "count": <integer>
        }
    ],
    "employeePayments": [
        {
            "employeeId": <integer>,
            "employeeName": <string>,
            "paymentMethodId": <integer>,
            "count": <integer>,
            "total": <double>,
            "rawTotal": <double>,
            "currency": <string>
        }
    ],
    "employeeTips": [
        {
            "name": <string>,
            "currency": <string>,
            "tipAmount": <double>,
            "tipAmountMainCurrency": <double>
        }
    ],
    "paymentMethodTips": [
        {
            "name": <string>,
            "currency": <string>,
            "tipAmount": <double>,
            "tipAmountMainCurrency": <double>
        }
    ],
    "writeoffs": [
        {
            "productId": <long>,
            "name": <string>,
            "count": <double>,
            "pricePurchaseWithoutVat": <double>,
            "unit": <string>,
            "currency": <string>
        }
    ]
}

POS actions

Send action to specific branch

Send action directly to a branch device and response will send to webhook. Branch device must be turned on.

Response header Response-url contains webhook URL from request body. If you don't sent webhook in request or webhook is null, response body contains response from default webhook URL.

If the default URL is used and the target device doesn't process the request within 21 seconds, a response 404 Not Found is returned.

The number of requests when using the default webhook URL is limited to one request running at same time for the same combination of userId, clientId, cloudId, branchId.

When the limit is exceeded response code 429 - Too Many Requests is returned.

Note that integers in responses from POS Actions are NOT sent as strings.

Result codes

Response status code is primary OK 200. For correct status use code properties in webhook response.

Represent the result of processing. There are NOT the response codes.

Code

Value

Description

CODE_OK

100

CODE_OTHER

1001

REQUEST_ERROR

1002

CONFIGURATION_ERROR

Current configuration of cash register does not allow to perform requested POS action.

1003

MISSING_ACTION

Your request is missing action parameter

1004

UNKNOWN_ACTION

Requested action is unknown or no more supported

1005

DATA_FORMAT_ERROR

1006

LICENSE_ERROR

License of the Cash Register is not sufficient to perform requested POS action.

1007

EXPIRED_REQUEST

validity of request is expired

1008

USER_NOT_FOUND

user-id of request was not found in App

1009

ACTION_NOT_ALLOWED_FOR_COUNTRY

1.242+ Executed action is not allowed for current POS country.

1999

SERVER_ERROR

2001

ORDER_LOCKED

Requested order is locked to another service/user

2002

ORDER_NOT_FOUND

Order with given id not found

2003

ORDER_PAYMENT_METHOD_NOT_FOUND

Payment method with given id not found

2004

ORDER_PAID

Order is already paid

2005

ORDER_ISSUED

Order is already issued

2006

ORDER_NOT_ISSUED

Order is not issued yet

2007

INVALID_PRINT_EMAIL

SK print-email is required to be a valid email for give print-type.

2008

INVALID_PRINT_TYPE

SK print-type none is not supported.

2009

ORDER_NOT_EMPTY

Order is not empty, there are some items in it.

2010

ORDER_ALREADY_CANCELED

Order can't be canceled as it is already canceled.

2011

EOS_ORDER

Order is created by EOS, it can't be modified

2999

ORDER_OTHER

3001

REGISTER_CLOSED

Cash Register is closed. You need to open the cash register to be able to do any order modifications.

4001

PRODUCT_NOT_FOUND

Requested product was not found in database of Cash Register

5001

ORDER_ITEM_NOT_FOUND

The item of the selected order is not presented on the order.

5002

ORDER_ITEM_LOW_QUANTITY

Requested change cannot be performed due to low quantity of order item.

5003

ORDER_ITEM_NEGATIVE_QUANTITY

Requested change cannot be performed due to negative quantity change in request.

6001

ORDER_TRANSITION_UNKNOWN

The requested transition is not known (maybe old version of Dotypos App).

6002

ORDER_TRANSITION_DENIED

The requeste transition could not be performed.

7001

COURSE_CHANGE_NOT_ALLOWED_FOR_PRODUCT

The specified course is not allowed for the given product.

7002

COURSE_CHANGE_ITEM_ALREADY_PREPARED

Unable to change item's course because this item has already been prepared.

8001

TAKE_AWAY_NOT_ENABLED

Takeaway is disabled on POS.

8002

TAKE_AWAY_NOT_ALLOWED_FOR_PRODUCT

Takeaway is not allowed for given product (see response for details).

8003

TAKE_AWAY_NOT_ALLOWED_FOR_ORDER

Takeaway is not allowed for whole orders.

8004

TAKE_AWAY_NOT_ENABLED_FOR_ORDERS_WITH_NO_TAKEAWAY_ITEMS

Unable to set the order as takeaway because the order does not contain any items with takeaway allowed.

10001

CUSTOMIZATION_NOT_FOUND

No customization found for the given id (see response for details).

10002

CUSTOMIZATION_CATEGORY_NOT_FOUND

No customization category found for the given id (see response for details).

10003

PRODUCT_NOT_FOUND (when working with customizations)

No product found for the given id (see response for details).

10004

PRODUCT_NOT_FOUND_IN_CUSTOMIZATION

Product with given id couldn't be found in given customization (see response for details).

10005

INVALID_SELECTED_QUANTITY

The given quantity of a product is not within customization's bounds (see response for details).

70302001

BLOCKED_BY_FAILED_PRINT

2.10+ SK Order fiscalization failed because previous fiscal document is not printed. It must be printed first by Print last document action

70302002

ISSUED_FISCALIZATION_FAILED

2.12+ SK Order issued, but fiscalization failed.

Basic request format

All request shares some basic parameters listed below. For better readability are those parameters are not shown in all methods.

{
  "action": <string>,
  "webhook": <string>,
  "validity": <long>, // Unix timestamp
  "idempotency-key": <string> | null
}

action string Name of action

webhook string? Webhook URL for action response

validity long? Validity of request in Unix timestamp. If the time on cash register is greater than this value, the request will not be performed with response code 1007

idempotency-key string? (Since Dotypos 2.1) Optional identification of a webhook call. It provides way for you to identify retried (same) webhook calls. When webhook parameter is filled, Dotypos will call the given URL with the Idempotency-Key header containing this value. If you do not specify idempotency-key, it will be automatically generated and sent.

Hello (1.239.8+)

{
  "action": "order/hello"
}

Returns basic POS metadata can be used for POS liveness checks, timezone configuration, or time shift.

Response format

{
    "device": <string>,
    "timezone": <string>,
    "version:": {
        "id": <string>, // "com.touchpo.android"
        "code": <long>,
        "name": <string>,
    },
    "code": <int>,
    "deviceTimestamp": <long> // Current UTC timestamp of device (in ms)
}

Create order

{
  "action": "order/create",
  "customer-id": <long>, // _customerId 
  "discount-percent": <double>, // 20 = 20%
  "table-id": <long>, // _tableId
  "user-id": <long>, // _employeeId
  "note": <string>,
  "external-id": <string>,
  "items": [...],
  "lock": <boolean>
}

customer-id long? The value corresponds to _customerId

discount-percent double? (1.238.12+) Value of discount in percent value: 20 = 20%

table-id long? The value corresponds to _tableId

user-id long? The value corresponds to _employeeId

note string? Personal note to order

external-id string? External id of the order

lock boolean? (1.234+) If set to true the order will be locked for 45 s for external changes

Update order

{
  "action": "order/update",
  "order-id": <long>, // _orderId
  "customer-id": <long>, // _customerId
  "discount-percent": <double>, // 20 = 20%
  "note": <string>,
  "lock": <boolean>
}

customer-id long? The value corresponds to _customerId

discount-percent double? Value of discount in percent value: 20 = 20%

note string? Personal note to order

order-id long Order ID for action. The value corresponds to _orderId

lock boolean? (1.234+) If se to true the order will be locked for 45 s for external changes

Add order items

{
    "action": "order/add-item",
    "order-id": <long>, //_orderId
    "items": [
        {
            "id": <long>, // _productId
            "qty": <doble>, // quantity
            "note": <string>,
            "discount-percent": <double>, // 20 = 20%
            "manual-price": <double>,
            "manual-points": <double>,
            "tags": <string[]>,
            "course-id": <long> | null,
            "customizations": [{
                "product-customization-id": <long>, // _productCustomizationId
                "product-id": <long>, // _productId
                "manual-price": <double>,
            }],
            "take-away": <boolean>
        }
    ],
    "lock": <boolean>
}

order-id long Order ID for action. The value corresponds to _orderId

lock boolean? (1.234+) If set to true the order will be locked for 45 s for external changes

Item

id long Corresponds to _productId

qty double Item / product quantity

note string? Note for item / product

discount-percent double? Value of discount in percent value: 20 = 20%

manual-price double? Product price

manual-points double? Points

tags string[]? Note for item

course-id long? Id of a course. Since Dotypos 1.237

Item Customization

Dotypos 1.234+ required

product-customization-id long Corresponds to _productCustomizationId

product-id long Corresponds to _productId

manual-price double? Customization item price override (default behavior if null or empty) Since Dotypos 2.9

take-away boolean? Whether to sell this item as takeaway. Since Dotypos 1.237.

Split order (1.234)

{
  "action": "order/split",
  "order-id": <long>, // _orderId
  "customer-id": <long>, // _customerId 
  "table-id": <long>, // _tableId
  "note": <string>,
  "split-items": [
    {
      "id": "123",
      "qty": "12"
    }
  ],
  "lock": <boolean>
}

order-id long Order ID of order to split. The value corresponds to _orderId

customer-id long? The value corresponds to _customerId

table-id long? The value corresponds to _tableId

note string? Personal note to order

lock boolean? If set to true the newly created order will be locked for 45 s for external changes

Issue order

Not allowed in following countries: Slovakia.

We allow you to invoke optional notifications displayed for staff on the POS for issued orders via POS Action. If you want to use this feature, contact us. We will enable functionality for your API application.

Since Dotypos 1.241

{
  "action": "order/issue",
  "order-id": <long>, // _orderId
  "print-config": {},
  "print-email": <string>,
  "print-type": <string>,
  "take-away": <boolean>
}

order-id long Order ID for action. The value corresponds to _orderId

print-email string? Email for print type

take-away boolean? Whether to issue this order as takeaway. Since Dotypos 1.237.

Pay issued order

Not allowed in following countries: Slovakia.

{
  "action": "order/pay",
  "order-id": <long>, // _orderId
  "payment-method-id": <long> // paymentTypeId
}

order-id long Order ID for action. The value corresponds to _orderId

Create and issue order (1.234)

Not allowed in following countries: Slovakia.

Since Dotypos 1.241

{
  "action": "order/create-issue",
  "customer-id": <long>, // _customerId 
  "discount-percent": <double>, // 20 = 20%
  "table-id": <long>, // _tableId
  "user-id": <long>, // _employeeId
  "note": <string>,
  "external-id": <string>,
  "items": [...],
  "payment-method-id": <long>, // paymentTypeId
  "take-away": <boolean>
}

customer-id long? The value corresponds to _customerId

discount-percent double? (1.238.12+) Value of discount in percent value: 20 = 20%

table-id long? The value corresponds to _tableId

user-id long? The value corresponds to _employeeId

note string? Personal note to order

external-id string? External id of the order

take-away boolean? Whether to issue this order as takeaway. Since Dotypos 1.237.

Create, issue and pay order (1.234)

Since Dotypos 1.241

{
  "action": "order/create-issue-pay",
  "customer-id": <long>, // _customerId
  "discount-percent": <double>, // 20 = 20% 
  "table-id": <long>, // _tableId
  "user-id": <long>, // _employeeId
  "note": <string>,
  "external-id": <string>,
  "items": [...],
  "payment-method-id": <long>, // paymentTypeId
  "print-append": <string>,
  "print-config": {},
  "print-email": <string>,
  "print-type": <string>,
  "take-away": <boolean>
}

customer-id long? The value corresponds to _customerId

discount-percent double? (1.238.12+) Value of discount in percent value: 20 = 20%

table-id long? The value corresponds to _tableId

user-id long? The value corresponds to _employeeId

note string? Personal note to order

external-id string? External id of the order

print-append string? Text to be appended to printout

print-email string? Email for print type

take-away boolean? Whether to issue this order as takeaway. Since Dotypos 1.237.

Split and issue order (1.234)

Not allowed in following countries: Slovakia.

Since Dotypos 1.241

{
  "action": "order/split-issue",
  "order-id": <long>, // _orderId
  "customer-id": <long>, // _customerId 
  "table-id": <long>, // _tableId
  "note": <string>,
  "split-items": [
    {
      "id": "123",
      "qty": "12"
    }
  ],
  "print-config": {},
  "print-email": <string>,
  "print-type": <string>,
  "lock": <boolean>,
  "take-away": <boolean>
}

order-id long Order ID of order to split. The value corresponds to _orderId

customer-id long? The value corresponds to _customerId

table-id long? The value corresponds to _tableId

note string? Personal note to order

print-email string? Email for print type

lock boolean? If set to true the original order will be locked for 45 s for external changes

take-away boolean? Whether to issue this order as takeaway. Since Dotypos 1.237.

Split, issue and pay order (1.234)

Since Dotypos 1.241

{
  "action": "order/split-issue-pay",
  "order-id": <long>, // _orderId
  "customer-id": <long>, // _customerId 
  "table-id": <long>, // _tableId
  "note": <string>,
  "split-items": [
    {
      "id": "123",
      "qty": "12"
    }
  ],
  "print-config": {},
  "print-email": <string>,
  "print-type": <string>,
  "payment-method-id": <long>, // paymentTypeId
  "lock": <boolean>,
  "take-away": <boolean>
}

order-id long Order ID of order to split. The value corresponds to _orderId

customer-id long? The value corresponds to _customerId

table-id long? The value corresponds to _tableId

note string? Personal note to order

print-email string? Email for print type

lock boolean? If set to true the original order will be locked for 45 s for external changes

take-away boolean? Whether to issue this order as takeaway. Since Dotypos 1.237.

Issue and pay

Since Dotypos 1.241

{
  "action": "order/issue-and-pay",
  "order-id": <long>, // _orderId
  "payment-method-id": <long>, // paymentTypeId
  "print-append": <string>,
  "print-config": {},
  "print-email": <string>,
  "print-type": <string>,
  "take-away": <boolean>
}

order-id long Order ID for action. The value corresponds to _orderId

print-append string? Text to be appended to printout

print-email string? Email for print type

take-away boolean? Whether to issue this order as takeaway. Since Dotypos 1.237.

Cancel order (1.243+)

{
  "action": "order/cancel",
  "order-id": <long> // _orderId
}

order-id long Order ID for action. The value corresponds to _orderId. Order must be empty - it can't have any items.

Change order status (1.234+, WIP)

{
  "action": "order/perform-status-transition",
  "order-id": <long>, // _orderId
  "status-transition": <string>
}

This endpoint is in active development phase. List of available transitions and their limitations could be changed in any further release of Dotypos App.

order-id long Order ID for action. The value corresponds to _orderId

Get list of open orders (1.235+)

{
  "action": "order/list",
  "table-id": <long>
}

table-id long? Table ID, list all orders if not presented, null for orders outside table

Change item's course (1.237+)

If there are multiple course changes for the same item, only the last is applied.

{
  "action": "order/change-item-course",
  "order-id": <long>,
  "course-changes":[{
    "order-item-id": <long>,
    "new-course-id": <long> | null
  }]
}

order-id long ID of the order.

Course Change

order-item-id long ID of an order item.

new-course-id long? ID of a new course for the given item within an order.

Prepare next course (1.237+)

Response field next-course-id describes the next available response for this order.

{
  "action": "order/prepare-next-course",
  "order-id": <long>
}

order-id long ID of an order.

Print last document (SK, 2.10+)

Usable only in case of failed fiscal print - in case BLOCKED_BY_FAILED print error on order issue or in case of pass-through error 100,007

Request:

{
    "action": "sk/print-last-document"
}

Response

{
    "resultCode": <integer>,
}

ResultCode

Name

Description

DOCUMENT_PRINTED

Failed document was printed, fiscalization is fixed and new documents can be issued

INVALID_COUNTRY

Call was made not for SK register, call is noop in this case

NO_DOCUMENT_TO_PRINT

Nothing was printed as no document was failed. Fiscalization is working correctly and new documents can be issued

Set/unset item(s) as takeaway (1.237+)

If there are multiple takeaway changes for the same order item, only the last one will be applied.

{
    "action": "order/set-item-takeaway",
    "take-away-changes": [{
        "order-item-id": <long>, // id of an order item, NOT product
        "take-away": <boolean>
    }],
    "order-id": <long>
}

order-id long ID of an order.

Takeaway change

order-item-id long ID of and order item.

take-away boolean Whether this item should be set as takeaway.

Shared types

Print type

local

Print on device printer

remote

none

Dont print SK - change Not allowed in Slovakia. Returns an error.

Print config

{
    "characters": <integer>,
    "codepage": <byte>,
    "print-mini": <boolean>,
    "print-logo": <boolean>,
    "cut": <boolean>,
    "append-lines": <integer>,
    "font": <integer>
}

characters integer? Width of print in characters

codepage byte?

print-mini boolean? Print in mini mode or standart

print-logo boolean? 1.243+ Print logo on receipt (if the logo is configured for any receipt print task in the register)

cut boolean? Is cut supported

append-lines integer? Number of lines appended to print

font integer(0,1)? Font type

Pass-through error (1.242+)

An error that occured during Order processing but didn't cause the processing to fail. Might be interpreted as a warning to the user.

{
    "code": <integer>,
    "description": <string>,
    "localized-description": <string>
}

code integer Error code.

description string General description of a pass-through error in English.

localized-description string Localized description of a pass-through error in language specified in the request. If no language is specified in the request, defaults to POS' language.

Possible pass-through errors

code

description

100001

SK Fiscal receipt file not found. Usually when order is successfully fiscalized, but the fiscal module didn't fill the path to the receipt file. The fiscal receipt was probably printed locally.

100002

SK Fiscal receipt email not sent. Email with fiscal receipt couldn't have been sent. print-png field of response should contain the Base64 encoded receipt file instead (see next).

100003

SK Fiscal receipt base64 creation failed. Could not encode the receipt file in Base64. print-png field in response is null. In case this happens, the receipt file won't be deleted from POS (it can be retrieved manually - contact support).

100004

SK Fiscal receipt possibly incomplete. Might happen when the fiscal module haven't finished writing/creating the receipt file even after extensive amount of time.

The electronic receipt sent to customer might have been incomplete. The receipt file won't be deleted from POS (it can be retrieved manually - contact support).

100005

SK Fiscal receipt possibly old. When the receipt file we found was created more than 60 seconds prior to the processing. The electronic receipt sent to customer might not be the correct one. The receipt file won't be deleted from POS (it can be retrieved manually - contact support).

100006

Can't obtain fiscal receipt printout. Fiscal receipts can be printed only locally (fiscal receipt is printed only on paper by fiscal the printer)

100007

SK Fiscal print of the order failed. Order is fiscalized, but next actions on fiscal printer will fail. It is required to solve this by calling Print last document action

Response schema (default)

{
    "order": {
        "id": <long>,
        "bkp": <string>,
        "completed": <timestamp>,
        "canceled-date": <timestamp>, // 1.243+
        "currency": <string(3)>,
        "customer-id": <long>, // _customerI
        "course-id": <long>, // 1.234+
        "user-id": <long>, // _employeeId
        "external-id": <string>,
        "fik": <string>,
        "flags": <integer>,
        "created": <timestamp>,
        "note": <string>,
        "order-number": <string?>, // 1.243+
        "order-series-id": <string>,
        "paid": <boolean>,
        "pkp": <string>,
        "points": <double>,
        "table-id": <long>, // _tableId
        "price-total": <double>,
        "locked-until": <timestamp>,
        "status": <string> // 1.234+
    },
    "next-course-id": <long> | null,
    "items": [
        {
            "id": <long>, // _orderItemId
            "price-with-vat": {
                "unit-billed": <double>,
                "total": <double>,
                "unit": <double>
            },
            "price-without-vat": {
                "unit-billed": <double>,
                "total": <double>,
                "unit": <double>
            },
            "customizations": [],
            "course-id": <long>, // 1.234+
            "name": <string>,
            "packaging": <double>,
            "points": <double>,
            "product-id": <long>, // _productId
            "price-in-points": <double>, // 1.234+
            "qty": <double>,
            "tags": <string[]>,
            "vat": <double>,
            "take-away": <boolean>
        }
    ],
    "print": [string],
    "print-png": <string?>, // 1.242+
    "code": <integer>,
    "pass-through-errors": [PassThroughError], // 1.242+
    "deviceTimestamp": <long> // 1.239.8+
}

print [string] Contains the base64 representation of receipt. 1.243+ If the register has configured multiple receipt print tasks, there will be added print content for each of them. All configured filters and print configurations for the task will be applied. Fiscalized receipt content is added only if it is available, otherwise print won't be added and pass-through-errors will contain error 100006.

print-png string? 1.242+, SK Contains the base64 representation of a receipt returned by the fiscal module when print-type: "remote" or when print-type: "email" and email sending fails.

Multiple orders response schema

{
    "orders": [
        {
            "order": {
                "id": <long>,
                "bkp": <string>,
                "completed": <timestamp>,
                "currency": <string(3)>,
                "customer-id": <long>, // _customerI
                "course-id": <long>, // 1.234+
                "user-id": <long>, // _employeeId
                "external-id": <string>,
                "fik": <string>,
                "flags": <integer>,
                "created": <timestamp>,
                "note": <string>,
                "order-number": <string?>, // 2.0
                "order-series-id": "0",
                "paid": <boolean>,
                "pkp": <string>,
                "points": <double>,
                "table-id": <long>, // _tableId
                "price-total": <double>,
                "locked-until": <timestamp>,
                "status": <string> // 1.234+
            },
            "items": [
                {
                    "id": <long>, // _orderItemId
                    "price-with-vat": {
                        "unit-billed": <double>,
                        "total": <double>,
                        "unit": <double>
                    },
                    "price-without-vat": {
                        "unit-billed": <double>,
                        "total": <double>,
                        "unit": <double>
                    },
                    "customizations": [],
                    "course-id": <long>, // 1.234+
                    "name": <string>,
                    "packaging": <double>,
                    "points": <double>,
                    "product-id": <long>, // _productId
                    "price-in-points": <double>, // 1.234+
                    "qty": <double>,
                    "tags": <string[]>,
                    "vat": <double>,
                    "take-away": <boolean>
                }
            ]
        }
    ],
    "code": <int>,
    "deviceTimestamp": <long> // 1.239.8+
}

Pos actions

POST https://api.dotykacka.cz/v2/clouds/:cloudId/branches/:branchId/pos-actions

Path Parameters

Name

Type

Description

branchId

integer

cloudId

integer

Headers

Name

Type

Description

Authorization

string

Bearer accessToken

Request Body

Name

Type

Description

array

Some of action request schema

API

Introduction to API v2

First steps

Guides

Getting started

Client Application

Creating Dotypos Account

Next Steps

Third-party libraries & Postman collection

Authorization

Client Application

Connecting Client Application (Refresh Token)

Flow description

Connector web page URL

List of query parameters

Connector web page URL format

Query parameters provided to the redirect_uri webhook

Signing into API v2 (Access Token)

Get Access Token

Headers

Request Body

Access Token without Cloud ID (special case)

Access Token with Cloud ID (standard use-case)

Access Token usage

Delivery Notes Integrations

Flow description

Register your application

Setup for testing

Setup for production

Obtain the Access Token

The Access Token...

Check the access

Uploading Delivery notes

Managing Products

API Reference

General

Data types

Timestamp

Unix time

ISO 8601 (UTC)

ISO 8601 (custom time zone)

Number

Validation

vatId

Allowed chars in URL

HTTP URL

Prices

Limitations

Rounding

Schema

Description

Validated properties

Flags

Operations on Flags

Example

Obtaining a flag value

Checking if a flag is set

Adding (set) a flag

Clearing (unset) a flag

Toggling (flip) a flag

ETags

What is an ETag

HTTP Response

HTTP Request

HTTP Status Codes (ETag-related)

Filtering

Filter query parameter

Filter groups

Filter operations

Filtering null values

Filtering deleted

Filter examples

Sorting

Sort query parameter

Sort examples

Paging

Paging query parameters

Paging response structure

Paging examples

HTTP Status Codes

Query parameters provided to the `redirect_uri` webhook

Filtering `null` values

Filtering `deleted`

Query parameters provided to the `redirect_uri` webhook