UNunified
commerce
table

Retrieve a table

Changed on

Retrieves a single CommerceTable by its id. Obtain id values from the corresponding list endpoint. Use fields to return only the fields you need.

get/commerce/{connection_id}/table/{id}

Request

Path parameters

connection_idstring required

ID of the connection

idstring required

ID of the Table

Query parameters

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Response

Successful

idstring
created_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

namestring

display label of the table, e.g. "Table 1" or "Patio 4"

numberstring

human-facing table number shown on the POS (string, as some systems use alphanumeric labels)

descriptionstring
is_activeboolean
capacitynumber

number of seats/guests the table is set up for

location_idstring

reference to a commerce_location (the restaurant/site) (reference to CommerceLocation)

floorplan_namestring

floorplan, section or dining area the table belongs to

floorplan_identifierstring

the provider's identifier of that floorplan/section

status'AVAILABLE' | 'OCCUPIED' | 'RESERVED' | 'INACTIVE' | 'OTHER'

current occupancy

guest_countnumber

number of guests currently seated

occupied_atstring date-time

when the current party was seated (earliest open order) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

salesorder_idsstring[]

open orders/checks currently on the table; references accounting_salesorder

rawobject

Changes