User Manual

Product Customization

Product Customization schema

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

_categoryId long Category ID 📶 EQUALS,ENUM

_cloudId long Cloud ID

_productId long Product ID 📶 EQUALS,ENUM

_defaultProductIds string[] Default selection of multiple product IDs

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

0

DEFAULT_SELECTION_GRATIS

1

ONE_CHEAPEST_ITEM_GRATIS

2

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

Authorization*

string

Bearer accessToken

If-None-Match

string

ETag to return results only if changed.

Get product customization by ID

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

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

Headers

Name
Type
Description

Authorization*

string

Bearer accessToken

If-None-Match

string

ETag to return results only if changed.

Create new product customizations

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

Create a list of new product customizations.

Path Parameters

Name
Type
Description

cloudId*

integer

ID of the cloud.

Headers

Name
Type
Description

Authorization*

string

Bearer accessToken

Replace or create product customizations

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

Replace a list of product customizations.

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 customization

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

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

Headers

Name
Type
Description

Authorization*

string

Bearer accessToken

If-Match

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

Authorization*

string

Bearer accessToken

If-Match*

string

ETag to update only if not changed.

Delete product customization

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

Delete a single product customization identified by its ID.

Path Parameters

Name
Type
Description

cloudId*

string

ID of the cloud.

entityId*

string

ID of the product customization to delete.

Headers

Name
Type
Description

Authorization*

string

Bearer accessToken

If-Match

string

ETag ignored (temporarily) when deleting an entity.

Options product customizations

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

PreviousProductNextProduct Ingredient

Last updated