Table data model
View field support, webhooks, and list parameters for each integration on the Supported Integrations page.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | |
created_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
name | string | No | display label of the table eg Table 1 or Patio 4 |
number | string | No | human-facing table number shown on the POS string as some systems use alphanumeric labels |
description | string | No | |
is_active | boolean | No | |
capacity | number | No | number of seatsguests the table is set up for |
location_id | string | No | reference to a commerce_location the restaurantsite (reference to CommerceLocation) |
floorplan_name | string | No | floorplan section or dining area the table belongs to |
floorplan_identifier | string | No | the providers identifier of that floorplansection |
layout | object | No | position and shape of the table on its floorplan |
layout.x | number | No | horizontal position on the floorplan in the providers floorplan units |
layout.y | number | No | vertical position on the floorplan in the providers floorplan units |
layout.width | number | No | |
layout.height | number | No | |
layout.rotation | number | No | degrees |
layout.shape | enum | No | Values: ROUND, SQUARE, RECTANGLE, OVAL, OTHER |
status | enum | No | current occupancy Values: AVAILABLE, OCCUPIED, RESERVED, INACTIVE, OTHER |
guest_count | number | No | number of guests currently seated |
occupied_at | string (date-time) | No | when the current party was seated earliest open order (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
salesorder_ids | string[] | No | open orderschecks currently on the table references accounting_salesorder |
metadata | CommerceMetadata[] | No | |
metadata[].id | string | No | The ID of the custom field definition (from the metadata/metadata endpoint). |
metadata[].value | object | No | The field's value, typed by format: DATE as ISO-8601 (YYYY-MM-DD, or YYYY-MM-DDTHH:MM:SSZ for date-times); NUMBER, PRICE and CURRENCY as a number; BOOLEAN and YES_NO as true/false; MULTIPLE_SELECT as an array of option values; otherwise a string. |
metadata[].namespace | string | No | |
metadata[].format | enum | No | The data type of the custom field, which determines how value is formatted. Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL |
metadata[].extra_data | object | No | |
metadata[].slug | string | No | The integration's API name (key) of an existing custom field. List valid slugs for this object with the metadata/metadata endpoint; unknown slugs are rejected by the integration. |
metadata[].description | string | No | |
metadata[].is_required | boolean | No |
Are we missing anything? Let us know
Was this page helpful?