Skip to main content
id
string
required

Unique identifier for the object.

created
number
required

Time at which the object was created. Measured in seconds since the Unix epoch.

object
enum<string>
required
Available options:
terminal.location
address
object
required

The physical address of the location.

display_name
string
required

A name for the location that is displayed to customers.

marketing
object
required

Marketing details displayed for the location.

subtype
enum<string> | null
required

A more specific subtype categorisation for the location.

Available options:
bar,
brewery,
coffee_shop,
quick_service,
restaurant,
food_court,
bakery,
clothing,
home,
grocery,
event_venue,
nightclub,
professional_services,
reception,
null
type
enum<string>
required

The category of the location.

Available options:
food_and_beverage,
retail,
entertainment,
services,
building_services
account
string

The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.

deleted
boolean
default:false

Only returned if the object has been deleted.

metadata
object

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.