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
  • Tag schema
  • Get tags
  • Get tag
  • Create tags
  • Options tags
  • Options tag

Was this helpful?

Export as PDF
  1. Entity

Tag

PreviousTableNextTax (VAT rates)

Last updated 5 months ago

Was this helpful?

Tag schema

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

_cloudId integer

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

display boolean Tag displayed 📶 EQUALS, ENUM 🔽 BOTH

externalId string? External ID 📶 EQUALS,ENUM

name string(650) Tag name - must not be empty and must be unique. The name must not contain any of these characters: ,^?*()[]$ and also it cannot start with a dot "." when creating a new Tag (tags .dailymenu and .portion are allowed). 📶 STRING 🔽 BOTH

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

JSON response

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

Get tags

GET https://api.dotykacka.cz/v2/clouds/:cloudId/tags

Path Parameters

Name
Type
Description

cloudId*

integer

Query Parameters

Name
Type
Description

sort

string

filter

string

page

integer

limit

integer

Headers

Name
Type
Description

If-None-Match

string

ETag to return results only if changed.

Authorization*

string

Bearer accessToken

[
 {
  // tag schema
 }
]

Get tag

GET https://api.dotykacka.cz/v2/clouds/:cloudId/tags/:tagId

Path Parameters

Name
Type
Description

tagId*

integer

cloudId*

integer

Headers

Name
Type
Description

If-None-Match

string

ETag to return results only if changed.

Authorization*

string

Bearer accessToken

{
    // tag schema
}

Create tags

POST https://api.dotykacka.cz/v2/clouds/:cloudId/tags

Path Parameters

Name
Type
Description

cloudId*

integer

Headers

Name
Type
Description

Authorization*

string

Bearer accessToken

Request Body

Name
Type
Description

array

Array of tags. Maximum size 100.

[
    {
        // tag schema
    }
]

Options tags

OPTIONS https://api.dotykacka.cz/v2/clouds/:cloudId/tags

Path Parameters

Name
Type
Description

cloudId*

integer

Headers

Name
Type
Description

Authorization*

string

Bearer accessToken

Options tag

OPTIONS https://api.dotykacka.cz/v2/clouds/:cloudId/tags/:tagId

Path Parameters

Name
Type
Description

tagId*

integer

cloudId*

integer

Headers

Name
Type
Description

Authorization*

string

Bearer accessToken

Cloud ID