Product
Last updated
Was this helpful?
Last updated
Was this helpful?
Please see the page for more info on the planned changes in validation.
id long?
Product ID - cannot be null in PUT/PATCH methods
📶 EQUALS,ENUM 🔽 NONE
_categoryId long
📶 EQUALS,ENUM 🔽 NONE
_cloudId integer
🔽 NONE
_defaultCourseId long?
📶 EQUALS,ENUM
_eetSubjectId long?
📶 EQUALS,ENUM 🔽 NONE
_supplierId long?
📶 EQUALS,ENUM 🔽 NONE
allergens int[]
Product allergens in the form of numbers. See the Annex II in the .
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
Bit
Name
0
SHORTCUT
1
REQUIRES_QUANTITY_ENTRY
2
REQUIRES_PRICE_ENTRY
3
TIMEABLE
5
MANUAL_SALE_ITEM
6
TIMEABLE_LOCKED
7
JOINT_SALE_ITEM
8
FISCALIZATION_DISABLED
10
ASSEMBLED_ITEM
11
TAKE_AWAY
12
TAKE_AWAY_ITEM
13
SPECIAL
14
WITH_CUSTOMIZATIONS
15
EXEMPTED_VAT
18
UNCERTIFIED_QUANTITY(18)
GET https://api.dotykacka.cz/v2/clouds/:cloudId/products
cloudId*
integer
sort
string
filter
string
page
integer
limit
integer
include
array
Include other entities [1]
If-None-Match
string
ETag to return results only if changed.
Authorization*
string
Bearer accessToken
[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.
GET https://api.dotykacka.cz/v2/clouds/:cloudId/products/:productId
cloudId*
integer
productId*
integer
If-None-Match
string
ETag to return results only if changed.
Authorization*
string
Bearer accessToken
POST https://api.dotykacka.cz/v2/clouds/:cloudId/products
cloudId*
integer
Authorization*
string
Bearer accessToken
array
Array of products. Maximum size 100.
PUT https://api.dotykacka.cz/v2/clouds/:cloudId/products
cloudId*
integer
If-Match
string
ETag to update only if not changed.
Authorization*
string
Bearer accessToken
array
Array of products. Maximum size 100.
PUT https://api.dotykacka.cz/v2/clouds/:cloudId/products/:productId
cloudId*
integer
productId*
integer
If-Match
string
ETag to update only if not changed.
Authorization*
string
Bearer accessToken
object
Product
PATCH https://api.dotykacka.cz/v2/clouds/:cloudId/products/:productId
cloudId*
integer
productId*
integer
If-Match*
string
ETag to update only if not changed.
Authorization*
string
Bearer accessToken
object
Part of product object
DELETE https://api.dotykacka.cz/v2/clouds/:cloudId/products/:productId
cloudId*
integer
productId*
integer
If-Match
string
ETag ignored (temporarily) when deleting an entity.
Authorization*
string
Bearer accessToken
productIsIngredient
string
Strategy when product is an ingredient [1]
productHasIngredients
string
Strategy when product has ingredients [1]
[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 https://api.dotykacka.cz/v2/clouds/:cloudId/products
cloudId*
integer
Authorization*
string
Bearer accessToken
OPTIONS https://api.dotykacka.cz/v2/clouds/:cloudId/products/:productId
cloudId*
integer
productId*
integer
Authorization*
string
Bearer accessToken
stockOverdraft enum
allows to set whether the product can be sold even if its quantity in the stock is equal or less than 0 - or just display a warning in that case
🔽 NONE
unit enum
Product
📶 EQUALS 🔽 NONE
unitMeasurement enum?
for product measurement
🔽 NONE