Terminal Locations
The terminal.location object
Unique identifier for the object.
Time at which the object was created. Measured in seconds since the Unix epoch.
Available options:
terminal.location The physical address of the location.
Show child attributes
Show child attributes
A name for the location that is displayed to customers.
Marketing details displayed for the location.
Show child attributes
Show child attributes
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 The category of the location.
Available options:
food_and_beverage, retail, entertainment, services, building_services The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.
Only returned if the object has been deleted.
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.
Show child attributes
Show child attributes
Was this page helpful?
{
"id": "<string>",
"created": 123,
"object": "terminal.location",
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"country": "<string>",
"postal_code": "<string>",
"state": "<string>"
},
"display_name": "<string>",
"marketing": {
"brand": {
"color": "<string>",
"icon": "<string>"
},
"description": "<string>",
"featured_photo": "<string>",
"photos": [
"<string>"
]
},
"account": "<string>",
"deleted": false,
"metadata": {}
}