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

Was this helpful?

Export as PDF
  1. API Reference
  2. General

Schema

Description of entities, request and response objects.

PreviousPricesNextFlags

Last updated 4 years ago

Was this helpful?

A schema describes Entity, Request, Response, etc objects. Specific properties data type, required fields, filter groups, sort options and describes special cases. Schema is split into two blocks - the first block describes individual fields and the second shows the JSON format.

Description

The example below shows some object properties with descriptions.

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

_cloudId integer 🔽 NONE

_eetSubjectId long? 📶 EQUALS,ENUM 🔽 NONE

deleted boolean Entity deleted 📶 EQUALS,ENUM 🔽 NONE

externalId string? External ID 📶 EQUALS,ENUM 🔽 NONE

flags integer Entity flags - see 📶 BITS 🔽 NONE

name string(180) Entity name 📶 EQUALS,STRING 🔽 BOTH

All internal IDs have an underscore prefix, f.e._cloudId.

All numeric properties are represented as string in JSON.

📶 allowed for a field 🔽 available for a field

Validated properties

Properties of data types followed by question mark (?) are optional. All other properties are mandatory. In special cases there can be a note mark with a number.

Property data type

Descriptiion

name string

NOT NULL

externalId string?

OPTIONAL

id long [1]

Special case with group 1 description below

firstName string? [2]

Special case with group 2 description below

lastName string? [2]

Special case with group 2 description below

companyName string? [2]

Special case with group 2 description below

Properties with [number] have special description below.

[1] ID cannot be null in PUT/PATCH methods [2] One of properties firstName, lastName, companyName cannot be BLANK / EMPTY but other can be EMPTY.

Value

Description

string(400)

String with maximum length of 400

string(200,250)

String length between 200 to 250

string[]

Array of strings

string[1,100]

Array of strings with item count between 1 to 100

string[](1000)

Array of strings with maximum length of 1000 in joined string (with separators)

Cloud ID
EET Subject ID
Flags
filter groups
sort options
Data types