User Manual

Discount group

Discount group schema

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

_cloudId integer Cloud

deleted boolean Discount group deleted - cannot be true in POST/PUT/PATCH methods 📶 EQUALS, ENUM 🔽 BOTH

discountPercent double(100) Represent percent value. Maximum value is 100 (100 = 100%)

display boolean Displayed 📶 EQUALS, ENUM 🔽 BOTH

externalId string 📶 EQUALS, ENUM

name string(100) Name for discount group 📶 EQUALS, ENUM

versionDate timestamp? Last modification date and time 📶 EQUALS, ENUM, NUMBER 🔽 BOTH

JSON response

{
    "_cloudId": <integer>,
    "discountPercent": <double>,
    "deleted": <boolean>,
    "display": <boolean>,
    "externalId": <string>,
    "id": <long>,
    "name": <string>,
    "versionDate": <timestamp>

Get discount groups

GET https://api.dotykacka.cz/v2/clouds/:cloudId/discount-groups

Path Parameters

Name
Type
Description

cloudId*

integer

Query Parameters

Name
Type
Description

page

integer

limit

integer

filter

string

sort

string

Headers

Name
Type
Description

If-None-Match

string

ETag to return results only if changed.

Authorization*

string

Bearer accessToken

[
    {
        Response schema
    },
    ...
]

Get discount group

GET https://api.dotykacka.cz/v2/clouds/:cloudId/discount-groups/:discountGroupId

Path Parameters

Name
Type
Description

discountGroupId*

integer

cloudId*

integer

Headers

Name
Type
Description

If-None-Match

string

ETag to return results only if changed.

Authorization*

string

Bearer accessToken

Create discount groups

POST https://api.dotykacka.cz/v2/clouds/:cloudId/discount-groups

Path Parameters

Name
Type
Description

cloudId*

integer

Headers

Name
Type
Description

Authorization*

string

Bearer accessToken

Request Body

Name
Type
Description

*

array

Array of discount groups. Maximum size 100.

Replace or create discount-groups

PUT https://api.dotykacka.cz/v2/clouds/:cloudId/discount-groups

Path Parameters

Name
Type
Description

cloudId*

integer

Headers

Name
Type
Description

If-Match

string

ETag to update only if not changed.

Authorization*

string

Bearer accessToken

Request Body

Name
Type
Description

*

array

Array of discount groups. Maximum size 100.

Replace or create discount group

PUT https://api.dotykacka.cz/v2/clouds/:cloudId/discount-groups/:discountGroupId

Path Parameters

Name
Type
Description

discountGroupId*

integer

cloudId*

integer

Headers

Name
Type
Description

If-Match

string

ETag to update only if not changed.

Authorization*

string

Bearer accessToken

Request Body

Name
Type
Description

*

object

Discount gorup

Partial update of discount group

PATCH https://api.dotykacka.cz/v2/clouds/:cloudId/discount-groups/:discountGroupId

Path Parameters

Name
Type
Description

discountGroupId*

integer

cloudId*

integer

Headers

Name
Type
Description

If-Match*

string

ETag to update only if not changed.

Authorization*

string

Bearer accessToken

Delete discount group

DELETE https://api.dotykacka.cz/v2/clouds/:cloudId/discount-groups/:discountGroupId

Discount group cannot belong to any Customer (deleted=false). First remove discount group for all customers via GET/PUT methods. For GET method use filter=_discountGroupId|eq|discountGroupId

Path Parameters

Name
Type
Description

discountGroupId*

integer

cloudId*

integer

Headers

Name
Type
Description

If-Match

string

ETag ignored (temporarily) when deleting an entity.

Authorization*

string

Bearer accessToken

Options discount groups

OPTIONS https://api.dotykacka.cz/v2/clouds/:cloudId/discount-groups

Path Parameters

Name
Type
Description

cloudId*

integer

Headers

Name
Type
Description

Authorization*

string

Bearer accessToken

Options discount group

OPTIONS https://api.dotykacka.cz/v2/clouds/:cloudId/discount-groups/:discountGroupId

Path Parameters

Name
Type
Description

discountGroupId*

integer

cloudId*

integer

Headers

Name
Type
Description

Authorization*

string

PreviousDelivery NoteNextEET subject

Last updated

Was this helpful?