User Manual

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

Authorization*

string

Bearer accessToken

If-None-Match

string

ETag to return results only if changed.

Get product ingredient by ID

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

Get 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 get.

Headers

Name
Type
Description

Authorization*

string

Bearer accessToken

If-None-Match

string

ETag to return results only if changed.

Create new product ingredients

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

Create a list of new product ingredients.

Path Parameters

Name
Type
Description

cloudId*

integer

ID of the cloud.

Headers

Name
Type
Description

Authorization*

string

Bearer accessToken

Replace or create product ingredients

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

Replace a list of product ingredients.

Path Parameters

Name
Type
Description

cloudId*

integer

ID of the cloud.

Headers

Name
Type
Description

Authorization*

string

Bearer accessToken

If-Match

string

ETag to update only if not changed.

Replace or create product ingredient

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

Replace 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 replace.

Headers

Name
Type
Description

Authorization*

string

Bearer accessToken

If-Match

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

Authorization*

string

Bearer accessToken

If-Match*

string

ETag to update only if not changed.

Delete product ingredient

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

Delete a single product ingredient identified by its ID.

Path Parameters

Name
Type
Description

cloudId*

string

ID of the cloud.

entityId*

string

ID of the product ingredient to delete.

Headers

Name
Type
Description

Authorization*

string

Bearer accessToken

If-Match

string

ETag ignored (temporarily) when deleting an entity.

Options product ingredients

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

PreviousProduct CustomizationNextReservation

Last updated