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 šŸ”½ 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>,
    "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

NameTypeDescription

cloudId*

integer

ID of the cloud.

Query Parameters

NameTypeDescription

filter

string

Filter conditions.

sort

string

Sort parameter.

page

integer

Page to start with.

limit

integer

Page size (100 records maximum)

Headers

NameTypeDescription

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

NameTypeDescription

cloudId*

integer

ID of the cloud.

entityId*

integer

ID of the product customization to get.

Headers

NameTypeDescription

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

NameTypeDescription

cloudId*

integer

ID of the cloud.

Headers

NameTypeDescription

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

NameTypeDescription

cloudId*

integer

ID of the cloud.

Headers

NameTypeDescription

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

NameTypeDescription

cloudId*

integer

ID of the cloud.

entityId*

integer

ID of the product customization to replace.

Headers

NameTypeDescription

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

NameTypeDescription

cloudId*

integer

ID of the cloud.

entityId*

integer

ID of the product customization to update.

Headers

NameTypeDescription

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

NameTypeDescription

cloudId*

string

ID of the cloud.

entityId*

string

ID of the product customization to delete.

Headers

NameTypeDescription

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

NameTypeDescription

cloudId*

integer

ID of the cloud.

Headers

NameTypeDescription

Authorization*

string

Bearer accessToken

Options product customization

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

Path Parameters

NameTypeDescription

cloudId*

integer

ID of the cloud.

entityId*

integer

ID of the product customization to get the options for.

Headers

NameTypeDescription

Authorization*

string

Bearer accessToken

Last updated