UNunified
commerce
table

List all tables

Changed on

Returns a list of CommerceTables. Narrow the results with the query parameters before paging, then page through them with limit and offset (the default and maximum page size depend on the integration). Use fields to return only the fields you need and reduce the response size. When the integration supports a total count, it is returned in the X-Total-Count response header. Use each item's id to retrieve, update, or delete it where those operations are supported.

get/commerce/{connection_id}/table

Request

Path parameters

connection_idstring required

ID of the connection

Query parameters

limitnumber
offsetnumber
updated_gtestring

Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

sortstring
orderstring
querystring

Query string to search. eg. email address or name

location_idstring

The location ID to filter by (reference to CommerceLocation)

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