Retrieve a table

Updated:

GET/commerce/{connection_id}/table/{id}

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

Parameters

fieldsstring array
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
connection_idstring required
ID of the connection
idstring required
ID of the Table

Returns

Response fieldTypeRequiredDescription
idstringNo
created_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
namestringNodisplay label of the table eg Table 1 or Patio 4
numberstringNohuman-facing table number shown on the POS string as some systems use alphanumeric labels
descriptionstringNo
is_activebooleanNo
capacitynumberNonumber of seatsguests the table is set up for
location_idstringNoreference to a commerce_location the restaurantsite (reference to CommerceLocation)
floorplan_namestringNofloorplan section or dining area the table belongs to
floorplan_identifierstringNothe providers identifier of that floorplansection
layoutobjectNoposition and shape of the table on its floorplan
layout.xnumberNohorizontal position on the floorplan in the providers floorplan units
layout.ynumberNovertical position on the floorplan in the providers floorplan units
layout.widthnumberNo
layout.heightnumberNo
layout.rotationnumberNodegrees
layout.shapeenumNoValues: ROUND, SQUARE, RECTANGLE, OVAL, OTHER
statusenumNocurrent occupancy Values: AVAILABLE, OCCUPIED, RESERVED, INACTIVE, OTHER
guest_countnumberNonumber of guests currently seated
occupied_atstring (date-time)Nowhen the current party was seated earliest open order (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
salesorder_idsstring[]Noopen orderschecks currently on the table references accounting_salesorder
metadataCommerceMetadata[]No
metadata[].idstringNoThe ID of the custom field definition (from the metadata/metadata endpoint).
metadata[].valueobjectNoThe 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[].namespacestringNo
metadata[].formatenumNoThe 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_dataobjectNo
metadata[].slugstringNoThe 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[].descriptionstringNo
metadata[].is_requiredbooleanNo

Errors

Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).

{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many requests to unified.to API; max requests per minute: N"
}
StatusErrorMeaning
400Bad RequestThe request was malformed or failed validation.
401UnauthorizedThe connection is likely broken; re-authorize it.
403ForbiddenThe connection is missing permissions or scopes.
404Not FoundThe requested resource does not exist.
429Too Many RequestsRate limit exceeded (see the two sources below).
500Internal Server ErrorAn unexpected error occurred.
501Not ImplementedNot supported by this integration.

Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.

429 Too Many Requests

A 429 has two possible sources:

  • The integration's own rate limit, passed through.
  • Unified's workspace limit: a rolling 60 seconds, set by plan, with the message Too many requests to unified.to API; max requests per minute: N.
const options = {
  method: 'GET',
  url: 'https://api.unified.to/commerce/5de520f96e439b002043d8dc/table/5de520f96e439b002043d8d8',
  headers: {
    authorization: 'bearer .....'
  },
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);
Are we missing anything? Let us know
Was this page helpful?