Product Ingredient

Product Ingredient schema

id long? Product Ingredient ID - cannot be null in PUT/PATCH methods πŸ“Ά EQUALS,ENUM

_cloudId long Cloud ID​

_parentProductId long Parent product ID which the ingredient belongs to πŸ“Ά EQUALS,ENUM

_productId long Product ID for the ingredient πŸ“Ά EQUALS,ENUM

deleted boolean Ingredient deleted πŸ“Ά EQUALS, ENUM πŸ”½ BOTH

quantity double Product amount for the ingredient

unit enum Ingredient unit πŸ“Ά EQUALS

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
Get product ingredients

https://api.dotykacka.cz/v2/clouds/:cloudId/product-ingredients
Get a custom-sorted paginated list of product ingredients matching the filter criteria.
Request
Response
Request
Path Parameters
cloudId
required
integer
ID of the cloud.
Headers
Authorization
required
string
Bearer accessToken
If-None-Match
optional
string
ETag to return results only if changed.
Query Parameters
filter
optional
string
Filter conditions.
sort
optional
string
Sort parameter.
page
optional
integer
Page to start with.
limit
optional
integer
Page size (100 records maximum)
Response
200: OK
​

get
Get product ingredient by ID

https://api.dotykacka.cz/v2/clouds/:cloudId/product-ingredients/:entityId
Get a single product ingredient identified by its ID.
Request
Response
Request
Path Parameters
cloudId
required
integer
ID of the cloud.
entityId
required
integer
ID of the product ingredient to get.
Headers
Authorization
required
string
Bearer accessToken
If-None-Match
optional
string
ETag to return results only if changed.
Response
200: OK
​

post
Create new product ingredients

https://api.dotykacka.cz/v2/clouds/:cloudId/product-ingredients
Create a list of new product ingredients.
Request
Response
Request
Path Parameters
cloudId
required
integer
ID of the cloud.
Headers
Authorization
required
string
Bearer accessToken
Response
200: OK
​

put
Replace or create product ingredients

https://api.dotykacka.cz/v2/clouds/:cloudId/product-ingredients
Replace a list of product ingredients.
Request
Response
Request
Path Parameters
cloudId
required
integer
ID of the cloud.
Headers
Authorization
required
string
Bearer accessToken
If-Match
required
string
ETag to update only if not changed.
Response
200: OK
​

put
Replace or create product ingredient

https://api.dotykacka.cz/v2/clouds/:cloudId/product-ingredients/:entityId
Replace a single product ingredient identified by its ID.
Request
Response
Request
Path Parameters
cloudId
required
integer
ID of the cloud.
entityId
required
integer
ID of the product ingredient to replace.
Headers
Authorization
required
string
Bearer accessToken
If-Match
required
string
ETag to update only if not changed.
Response
200: OK
​

patch
Partial update of product ingredient

https://api.dotykacka.cz/v2/clouds/:cloudId/product-ingredients/:entityId
Update a single product ingredient identified by its ID.
Request
Response
Request
Path Parameters
cloudId
required
integer
ID of the cloud.
entityId
required
integer
ID of the product ingredient to update.
Headers
Authorization
required
string
Bearer accessToken
If-Match
required
string
ETag to update only if not changed.
Response
200: OK
​

delete
Delete product ingredient

https://api.dotykacka.cz/v2/clouds/:cloudId/product-ingredients/:entityId
Delete a single product ingredient identified by its ID.
Request
Response
Request
Path Parameters
cloudId
required
string
ID of the cloud.
entityId
required
string
ID of the product ingredient to delete.
Headers
Authorization
required
string
Bearer accessToken
If-Match
required
string
ETag ignored (temporarily) when deleting an entity.
Response
200: OK
Cake successfully retrieved.
​
404: Not Found
Could not find a cake matching this query.
​

options
Options product ingredients

https://api.dotykacka.cz/v2/clouds/:cloudId/product-ingredients
Request
Response
Request
Path Parameters
cloudId
required
integer
ID of the cloud.
Headers
Authorization
required
string
Bearer accessToken
Response
200: OK
​

options
Options product ingredient

https://api.dotykacka.cz/v2/clouds/:cloudId/product-ingredients/:entityId
Request
Response
Request
Path Parameters
cloudId
required
integer
ID of the cloud.
entityId
required
integer
ID of the product ingredient to get the options for.
Headers
Authorization
required
string
Bearer accessToken
Response
200: OK
​