Download OpenAPI specification:Download
Depending on the type of list returned, the 'items' will be of varying formats. Examples:
{
"name": "Chocolate Croissant",
"cost": { ... },
"description": "A tantalizing treat",
"photo": {
"url": "http://www.yext-static.com/cms/chocolate-croissant.jpg",
"height": 250,
"width": 250
}
"calories": {
"type": "RANGE",
"calorie": 300,
"rangeTo": 350
}
}
{
"name": "Dr. Allan Sicignano",
"description": "Dr. Allan Sicignano is at the forefront of modern chiropractor techniques...",
"photo": {"url": "http://www.yext-static.com/cms/dr-allan-sicignano.jpg", "height": 250, "width": 250},
"education": [
"Bachelor of Science, Cambridge University",
"USD Medical School"
],
"certifications": [
"Chiropractory United",
"Verified Provider"
],
"services": [
"Spinal Decompression"
],
"url": "http://www.superchiro.com"
}
{
"name": "Black & Decker MOUSE Detail Sander with Dust Collection",
"cost": { ... },
"photos": [
{"url": "http://www.yext-static.com/cms/detail-sander.jpg", "height": 250, "width": 250},
{"url": "http://www.yext-static.com/cms/detail-sander2.jpg", "height": 250, "width": 250}
],
"video": "http://www.youtube.com/watch?v=cGW0XKYeM6o",
"url": "http://www.kmart.com/deal-of-the-day/dap-120000000279845"
}
{
"type": "Concert",
"name": "Gaelic Storm",
"starts": "2012-08-23T20:00-05",
"ends": "2012-08-24T00:00-05",
"description": "$20 tickets. Doors at 8pm, show at 9pm.",
"photos": [
{"url": "http://www.yext-static.com/cms/detail-sander.jpg", "height": 250, "width": 250},
{"url": "http://www.yext-static.com/cms/detail-sander2.jpg", "height": 250, "width": 250}
],
"video": "http://www.youtube.com/watch?v=jtCEvGxZVIM",
"url": "http://www.boweryballroom.com/event/125975"
}
The Cost structure is used in Menus and Products. The customer is able to specify four types of costs:
Seperately, the customer is able to specify options on the Cost. For example:
[{"Small", "9.00"}, {"Medium", "11.00"}, {"Large", "13.00"}]
[{"Bacon", "1.00"}, {"Avocado", "2.00"}]
Example Cost Substructure:
{
"type": "PRICE",
"price": "9.50",
"unit": "Per Sandwich",
"rangeTo": "",
"other": "",
"options": [
{"name": "Bacon", "price": "1.00", "calorie": 150},
{"name": "Avocado", "price": "2.00", "calorie": 60}
]
}
The Calories structure is used in Menus only. You are able to display calories in two ways:
Example Calorie Substructure:
{
"type": "RANGE",
"calorie": 250,
"rangeTo": 500
}
Use Get List to retrieve Enhanced Content List (ECL) content in the following use cases:
pid | string Publisher secure ID. This value will be provided to you. |
listingId | string Publisher listing ID |
yextId | string The Yext listing ID |
listId | string ECL ID (Yext-assigned) |
type | string Enum: "MENU" "PRODUCTS" "BIOS" "EVENTS" Type of lists to return |
template | string This parameter specifies the template to use when rendering the List content. Yext will provide a list of your available templates. Yext configures each template with the type of data that it accepts -- for example, the template "mobile-menu" may be configured to render all Lists on a listing of type MENU.
|
format | string Enum: "html" "json" An alternative way to specify the desired content type of the response |
{- "response": {
- "id": "string",
- "name": "string",
- "description": "string",
- "type": "MENU",
- "size": 0,
- "sourceUrl": "string",
- "sections": [
- {
- "name": "string",
- "description": "string",
- "items": [ ]
}
]
}
}