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
  • Reservation schema
  • Get reservations
  • Get reservation
  • Create reservations
  • Replace or create reservations
  • Replace or create reservation
  • Partial update of reservation
  • Delete reservation
  • Options reservations
  • Options reservation

Was this helpful?

Export as PDF
  1. Entity

Reservation

PreviousProduct IngredientNextStock Packaging

Last updated 5 months ago

Was this helpful?

Reservation schema

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

_branchId integer 📶 EQUALS,ENUM

_cloudId integer

_customerId long 📶 EQUALS,ENUM

_employeeId long 📶 EQUALS,ENUM

_tableId long 📶 EQUALS,ENUM

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

endDate timestamp End date and time 📶 EQUALS, ENUM, NUMBER 🔽 BOTH

flags integer Reservation flags 📶 BITS

note string? Reservation note

seats short Number of table seats - minimum value is 1, maximum value must be less or equal to the number of seats in the entity (Table.seats).

startDate timestamp Start date and time 📶 EQUALS, ENUM, NUMBER 🔽 BOTH

status enum Reservation status

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

Reservation.status (enum)

// representation like string
NEW, CONFIRMED, CANCELLED

JSON response

{
    "_branchId": <long>,
    "_cloudId": <integer>,
    "_customerId": <long>,
    "_employeeId": <long>,
    "_tableId": <long>,
    "created": <timestamp>,
    "endDate": <timestamp>,
    "flags": <integer>,
    "id": <long>,
    "note": <string>,
    "seats": <short>,
    "startDate": <timestamp>,
    "status": <enum>,
    "versionDate": <timestamp>
}

Get reservations

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

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

[
 {
  // Reservation schema
 }
]

Get reservation

GET https://api.dotykacka.cz/v2/clouds/:cloudId/reservations/:reservationId

Path Parameters

Name
Type
Description

reservationId*

integer

cloudId*

integer

Headers

Name
Type
Description

If-None-Match

string

ETag to return results only if changed.

Authorization*

string

Bearer accessToken

{
    // Reservation schema
}

Create reservations

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

Path Parameters

Name
Type
Description

cloudId*

integer

Headers

Name
Type
Description

Authorization*

string

Bearer accessToken

Request Body

Name
Type
Description

array

Array of reservations. Maximum size 100.

[
    {
        // Reservation schema
        ...
    }
]

Replace or create reservations

PUT https://api.dotykacka.cz/v2/clouds/:cloudId/reservations

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 reservation. Maximum size 100.

[
    {
        // Reservation schema
        ...
    }
]

Replace or create reservation

PUT https://api.dotykacka.cz/v2/clouds/:cloudId/reservations/:reservationId

Path Parameters

Name
Type
Description

reservationId*

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

Reservation

{
    // Reservation schema
}

Partial update of reservation

PATCH https://api.dotykacka.cz/v2/clouds/:cloudId/reservations/:reservationId

Path Parameters

Name
Type
Description

reservationId*

integer

cloudId*

integer

Headers

Name
Type
Description

If-Match*

string

ETag to update only if not changed.

Authorization*

string

Bearer accessToken

Delete reservation

DELETE https://api.dotykacka.cz/v2/clouds/:cloudId/reservation/:reservationId

Path Parameters

Name
Type
Description

reservationId*

integer

cloudId*

integer

Headers

Name
Type
Description

If-Match

string

ETag ignored (temporarily) when deleting an entity.

Authorization*

string

Bearer accessToken

Options reservations

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

Path Parameters

Name
Type
Description

cloudId*

integer

Headers

Name
Type
Description

Authorization*

string

Bearer accessToken

Options reservation

OPTIONS https://api.dotykacka.cz/v2/clouds/:cloudId/reservations/:reservationId

Path Parameters

Name
Type
Description

reservationId*

integer

cloudId*

integer

Headers

Name
Type
Description

Authorization*

string

Bearer accessToken

Branch ID
Cloud ID
Customer ID
Employee ID
Table ID
Table