API
User Manual
  • Introduction to API v2
  • Guides
    • Getting started
    • Authorization
    • Delivery Notes Integrations
  • API Reference
    • General
      • Data types
        • Validation
        • Prices
      • Schema
      • Flags
      • ETags
        • ETag examples
      • Filtering
      • Sorting
      • Paging
      • Methods
      • HTTP Status Codes
    • Enums
      • Payment methods
      • Units
      • Order status
  • Entity
    • Attendance
    • Branch
    • Category
    • Cloud
    • Course
    • Customer
    • Customer Account
    • Customer Account Log
    • Daily Menu
    • Daily Menu Product
    • Delivery Note
    • Discount group
    • EET subject
    • Employee
    • Money log
    • Order
    • Order item
    • Product
    • Product Customization
    • Product Ingredient
    • Reservation
    • Stock Packaging
    • Supplier
    • Table
    • Tag
    • Tax (VAT rates)
    • Warehouse
    • Warehouse Branch
  • Others
    • Reports
      • Base Sales Report
    • POS actions
    • Release notes
    • Breaking changes
    • Webhook
    • Third-party libraries
  • Migration
    • Migrating from API v1
    • API v1 Services
      • Branch Service
      • Category Service
      • Customer Service
      • Employee Service
      • OAuth2 Login Service
      • POS action service
      • Product Service
      • Reservation Service
      • Sale Service
      • Stock Service
      • Supplier Service
      • Tableseat Service
      • Tag Service
      • Warehouse Service
Powered by GitBook
On this page
  • Discount group schema
  • Get discount groups
  • Get discount group
  • Create discount groups
  • Replace or create discount-groups
  • Replace or create discount group
  • Partial update of discount group
  • Delete discount group
  • Options discount groups
  • Options discount group

Was this helpful?

Export as PDF
  1. Entity

Discount group

PreviousDelivery NoteNextEET subject

Last updated 3 years ago

Was this helpful?

Discount group schema

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

_cloudId integer

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

Cloud