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
  • Branch schema
  • Branch flags
  • Get branches
  • Get branch

Was this helpful?

Export as PDF
  1. Entity

Branch

PreviousAttendanceNextCategory

Last updated 3 years ago

Was this helpful?

Branch schema

id integer? Branch ID - cannot be null in PUT/PATCH methods 📶 EQUALS,ENUM 🔽 NONE

_cloudId integer 🔽 NONE

created timestamp? Branch created date and time 📶 EQUALS, ENUM, NUMBER 🔽 BOTH

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

display boolean Branch displayed 📶 EQUALS, ENUM 🔽 BOTH

features long Branch features 📶 BITS 🔽 NONE

flags short Branch flags 📶 BITS 🔽 NONE

name string(100) Branch name 🔽 NONE

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

Branch response

{
    "_cloudId": <integer>,
    "created": <timestamp>,
    "deleted": <boolean>,
    "display": <boolean>,
    "features": <long>,
    "flags": <short>,
    "id": <integer>,
    "name": <string>,
    "versionDate": <timestamp>
}

Branch flags

Bit

Name

0

SUBSTITUTING_BRANCH

1

REPLACED_BRANCH

8

HIDE_STOCK

9

HIDE_PRICES

10

FREE_LICENSE

Get branches

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

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
}
{
    // Response
}

Get branch

GET https://api.dotykacka.cz/v2/clouds/:cloudId/branches/:branchId

Path Parameters

Name
Type
Description

cloudId*

integer

branchId*

integer

Headers

Name
Type
Description

If-None-Match

string

Add ETag to return results only if changed.

Authorization*

string

Bearer accessToken

{
    // Response
}
{
    // Response
}

See the section for more information.

Cloud ID
General