A location represents a venue (restaurant, wedding venue, etc.). Locations can have many areas or rooms. We do not allow creating, updating, or deleting locations or areas via our API. For assistance with creating, updating, or deleting/canceling a location, please reach out to support@tripleseat.com.
Location Fields Overview
Below you will find a comprehensive list of the fields within the Location Endpoint. The order displayed below is representative of the order in which they are displayed within a response body of a standard GET request.
| Field Name | Description | Response Example - Key | Value |
| “id” | The ID Number for the Location. | “Id”: (Numerics), |
| “name” | The Name of the Location | “name”: “(Alphanumerics)”, |
| “customer_id” | The ID Number for the Tripleseat Customer that the Site belongs to. | “customer_id”: (Numerics), |
| “site_name” | The Name of the Site the Location is nested under. | “name”: “(Alphanumerics)”, |
| “site_id” | The ID Number of the Site the Location is nested under. | “Id”: (Numerics), |
| “room_ids” | Array | An array or “collection” of IDs of the rooms for the Site. |
“room_ids”: [ (Numerics), (Numerics) ], |
| “created_at” | The Date and Timestamp for when the Location was Created. | “created_at”: “MM/DD/YYYY HH:MM AM/PM”, |
| “updated_at” | The Date and Timestamp for when the Location was last Updated. | “updated_at”: “MM/DD/YYYY HH:MM AM/PM”, |
| “currency_code” | The Currency code that is set for the Location. | “currency_code”: “USD”, |
| “custom_fields” | Array | An array or “collection” of assorted fields specific to the Custom Fields set on the Location level. |
“custom_fields”: [ { “id”: (Numerics), “custom_field_name”: “(Alphanumerics)”, “custom_field_id”: (Numerics), “custom_field_required”: (true/false), “custom_field_slug”: “(Alphanumerics)”, “value”: “(Alphanumerics)” |
| “rooms” | Array | An array or “collection” of assorted fields specific to the Rooms for the Location. |
“rooms”: [ { “id”: (Numerics), “name”: “(Alphanumerics)”, “capacity”: (Numerics), “description”: “(Alphanumerics)”, “is_unassigned”: “(true/false)”, “descendants”: [ (Array for any rooms nested under this room) ] |
| “phone_number” | Array | An array or “collection” of assorted fields specific to the Phone Number(s) for the Location. |
“phone_number”: [ { “id”: (Numerics), “number: “(Alphanumerics)”, “phone_number_type”: “(Main/Mobile/Fax/Work/Home/Pager/Skype)”, “extension”: “(Alphanumerics)” } |
| “addresses” | Array | An array or “collection” of assorted fields specific to the Address for the Location. |
“addresses”: [ { “id”: (Numerics), “address1”: “(Alphanumerics)”, “address2”: “(Alphanumerics)”, “city”: “(Alphanumerics)”, “state”: “(State)”, “country”: “(Country)”, “zip_code”: “(Alphanumerics)” } |
| “photos” | Array | An array or “collection” of links to Photos that have been added to the Location’s EventUp listing. There are different sizes/ratios linked in this array. |
“photos”: [ { “original”: “(Link)”, “gallery_thumbnail”: “(Link)”, “gallery”: “(Link)”, “room”: “(Link)”, “Standard_listing”: “(Link)”, “size700x400”: “(Link)” ] |
Request Examples:
As mentioned at the beginning of this article, we do not allow for creating, updating, or deleting via the Locations API; however, you are able to pull this information via a GET request, as shown below:
GET https://api.tripleseat.com/v1/locations.(XML | JSON)
This request will pull all Location information housed within a Site.
GET https://api.tripleseat.com/v1/locations/(Location_ID).(XML | JSON)
This request will pull Location information specific to the ID specified in the request URL.
Comments
0 comments
Article is closed for comments.