Skip to main contentThis documentation uses the following standardized data types to describe fields in API requests and webhook notifications.
Data types
string
Text string. Used for generic textual values.
Note on date/time formats: Fields of type string may contain dates and times in the legacy format YYYY-MM-DD hh:mm:ss (example: 2025-12-04 14:30:00). The timezone of these values follows the one set in API Settings.
string<date>
String containing a date in ISO 8601 format (example: 2025-12-04). This type represents a date without time or timezone information.
string<date-time>
String containing date and time in ISO 8601 format with embedded timezone (example: 2025-12-04T14:30:00+01:00).
Unlike the legacy string format, this type explicitly includes the timezone of the restaurant/venue associated with the entity, ensuring correct time interpretation regardless of API settings.
boolean
Boolean value that can be represented in two ways:
- Pure boolean:
false or true
- Numeric or numeric string:
0/"0" (false) or 1/"1" (true)
Important note: For internal handling and backwards compatibility reasons, boolean values may be returned in any of the formats above. Make sure your code properly handles all representations.
integer
Whole number without decimals.
Important note: For internal handling and backwards compatibility reasons, integer values may be returned as numerical strings (example: "123" instead of 123). Implement appropriate conversion when processing these fields.
number
Decimal number (example: 12.50 for a price).
Important note: Like integer, number values may be returned as numerical strings (example: "12.50" instead of 12.50). Implement appropriate conversion when processing these fields.
object
Structured object containing multiple fields/properties. The specific structure is detailed in the documentation of each endpoint or webhook.
array
Vector/array containing a collection of elements. The type of contained elements is specified in the documentation (example: array<object>, array<string>). 