ECLs | Hitchhikers

Menus: List

Retrieve all Menus for an account.

path Parameters

accountId

required

string

query Parameters

v required	string A date in `YYYYMMDD` format.
limit	integer <= 50 Default: 10 Number of results to return.
offset	integer Default: 0 Number of results to skip. Used to page through results. Cannot be used together with `pageToken`.

Responses

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": {"count": 0,
"menus": [{"id": "string",
"accountId": "string",
"name": "string",
"title": "string",
"size": 0,
"publish": true,
"language": "string",
"currency": "string",
"sourceUrl": "string",
"sections": [{"id": "string",
"name": "string",
"description": "string",
"items": [{"id": "string",
"name": "string",
"description": "string",
"photo": {"url": "string",
"height": 0,
"width": 0,
"alternateText": "string"
},
"calories": {"type": "FIXED",
"calorie": 0,
"rangeTo": 0
},
"cost": {"type": "PRICE",
"price": "string",
"unit": "string",
"rangeTo": "string",
"other": "string",
"options": [{ }
]
},
"url": "string",
"allergens": ["string"
],
"featuredItem": true,
"spiciness": "string",
"dietaryRestrictions": ["string"
],
"preparationMethods": ["string"
]
}
]
}
]
}
]
}
}

Menus: Create

path Parameters

accountId

required

string

query Parameters

v

required

string

A date in YYYYMMDD format.

Request Body schema: application/json

id	string <= 32 characters List ID.
name	string List name.
title	string List title that appears on listings.
publish	boolean Indicates whether the List should be shown on your listings.
language	string List language in ISO 639-1 format. An ISO 3166-1 alpha-2 country code can optionally be appended to the language. Examples: en, en_GB, fr_CA
currency	string The three-letter ISO 4217 currency code. Defaults to USD.
sourceUrl	string The URL of the source the menu's content is retrieved from.
	Array of objects A list of sections.

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"name": "string",
"title": "string",
"publish": true,
"language": "string",
"currency": "string",
"sourceUrl": "string",
"sections": [{"id": "string",
"name": "string",
"description": "string",
"items": [{"id": "string",
"name": "string",
"description": "string",
"photo": {"url": "string",
"height": 0,
"width": 0,
"alternateText": "string"
},
"calories": {"type": "FIXED",
"calorie": 0,
"rangeTo": 0
},
"cost": {"type": "PRICE",
"price": "string",
"unit": "string",
"rangeTo": "string",
"other": "string",
"options": [{"name": "string",
"price": "string",
"calorie": 0
}
]
},
"url": "string",
"allergens": ["string"
],
"featuredItem": true,
"spiciness": "string",
"dietaryRestrictions": ["string"
],
"preparationMethods": ["string"
]
}
]
}
]
}

Response samples

201
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": {"id": "string"
}
}

Menus: Get

Retrieve a specific Menu.

path Parameters

accountId required	string
listId required	string ID of this List.

query Parameters

v

required

string

A date in YYYYMMDD format.

Responses

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": {"id": "string",
"accountId": "string",
"name": "string",
"title": "string",
"size": 0,
"publish": true,
"language": "string",
"currency": "string",
"sourceUrl": "string",
"sections": [{"id": "string",
"name": "string",
"description": "string",
"items": [{"id": "string",
"name": "string",
"description": "string",
"photo": {"url": "string",
"height": 0,
"width": 0,
"alternateText": "string"
},
"calories": {"type": "FIXED",
"calorie": 0,
"rangeTo": 0
},
"cost": {"type": "PRICE",
"price": "string",
"unit": "string",
"rangeTo": "string",
"other": "string",
"options": [{"name": "string",
"price": "string",
"calorie": 0
}
]
},
"url": "string",
"allergens": ["string"
],
"featuredItem": true,
"spiciness": "string",
"dietaryRestrictions": ["string"
],
"preparationMethods": ["string"
]
}
]
}
]
}
}

Menus: Update

Update an existing Menu.

path Parameters

accountId required	string
listId required	string ID of this List.

query Parameters

v

required

string

A date in YYYYMMDD format.

Request Body schema: application/json

id	string <= 32 characters List ID.
name	string List name.
title	string List title that appears on listings.
publish	boolean Indicates whether the List should be shown on your listings.
language	string List language in ISO 639-1 format. An ISO 3166-1 alpha-2 country code can optionally be appended to the language. Examples: en, en_GB, fr_CA
currency	string The three-letter ISO 4217 currency code. Defaults to USD.
sourceUrl	string The URL of the source the menu's content is retrieved from.
	Array of objects A list of sections.

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"name": "string",
"title": "string",
"publish": true,
"language": "string",
"currency": "string",
"sourceUrl": "string",
"sections": [{"id": "string",
"name": "string",
"description": "string",
"items": [{"id": "string",
"name": "string",
"description": "string",
"photo": {"url": "string",
"height": 0,
"width": 0,
"alternateText": "string"
},
"calories": {"type": "FIXED",
"calorie": 0,
"rangeTo": 0
},
"cost": {"type": "PRICE",
"price": "string",
"unit": "string",
"rangeTo": "string",
"other": "string",
"options": [{"name": "string",
"price": "string",
"calorie": 0
}
]
},
"url": "string",
"allergens": ["string"
],
"featuredItem": true,
"spiciness": "string",
"dietaryRestrictions": ["string"
],
"preparationMethods": ["string"
]
}
]
}
]
}

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": {"id": "string",
"accountId": "string",
"name": "string",
"title": "string",
"size": 0,
"publish": true,
"language": "string",
"currency": "string",
"sourceUrl": "string",
"sections": [{"id": "string",
"name": "string",
"description": "string",
"items": [{"id": "string",
"name": "string",
"description": "string",
"photo": {"url": "string",
"height": 0,
"width": 0,
"alternateText": "string"
},
"calories": {"type": "FIXED",
"calorie": 0,
"rangeTo": 0
},
"cost": {"type": "PRICE",
"price": "string",
"unit": "string",
"rangeTo": "string",
"other": "string",
"options": [{"name": "string",
"price": "string",
"calorie": 0
}
]
},
"url": "string",
"allergens": ["string"
],
"featuredItem": true,
"spiciness": "string",
"dietaryRestrictions": ["string"
],
"preparationMethods": ["string"
]
}
]
}
]
}
}

Menus: Delete

Delete an existing Menu.

path Parameters

accountId required	string
listId required	string ID of this List.

query Parameters

v

required

string

A date in YYYYMMDD format.

Responses

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": { }
}

Bios: List

Retrieve all Bio Lists for an account.

path Parameters

accountId

required

string

query Parameters

v required	string A date in `YYYYMMDD` format.
limit	integer <= 50 Default: 10 Number of results to return.
offset	integer Default: 0 Number of results to skip. Used to page through results. Cannot be used together with `pageToken`.

Responses

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": {"count": 0,
"bios": [{"id": "string",
"accountId": "string",
"name": "string",
"title": "string",
"size": 0,
"publish": true,
"language": "string",
"sections": [{"id": "string",
"name": "string",
"description": "string",
"items": [{"id": "string",
"name": "string",
"description": "string",
"photo": {"url": "string",
"height": 0,
"width": 0,
"alternateText": "string"
},
"title": "string",
"phone": "string",
"email": "string",
"education": ["string"
],
"certifications": ["string"
],
"services": ["string"
],
"url": "string"
}
]
}
]
}
]
}
}

Bios: Create

Create new Bio List.

path Parameters

accountId

required

string

query Parameters

v

required

string

A date in YYYYMMDD format.

Request Body schema: application/kjson

id	string <= 32 characters List ID.
name	string List name.
title	string List title that appears on listings.
publish	boolean Indicates whether the List should be shown on your listings.
language	string List language in ISO 639-1 format. An ISO 3166-1 alpha-2 country code can optionally be appended to the language. Examples: en, en_GB, fr_CA
	Array of objects A list of sections.

Responses

Request samples

Payload

Content type

application/kjson

{"id": "string",
"name": "string",
"title": "string",
"publish": true,
"language": "string",
"sections": [{"id": "string",
"name": "string",
"description": "string",
"items": [{"id": "string",
"name": "string",
"description": "string",
"photo": {"url": "string",
"height": 0,
"width": 0,
"alternateText": "string"
},
"title": "string",
"phone": "string",
"email": "string",
"education": ["string"
],
"certifications": ["string"
],
"services": ["string"
],
"url": "string"
}
]
}
]
}

Response samples

201
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": {"id": "string"
}
}

Bios: Get

Retrieve a specific Bios List.

path Parameters

accountId required	string
listId required	string ID of this List.

query Parameters

v

required

string

A date in YYYYMMDD format.

Responses

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": {"id": "string",
"accountId": "string",
"name": "string",
"title": "string",
"size": 0,
"publish": true,
"language": "string",
"sections": [{"id": "string",
"name": "string",
"description": "string",
"items": [{"id": "string",
"name": "string",
"description": "string",
"photo": {"url": "string",
"height": 0,
"width": 0,
"alternateText": "string"
},
"title": "string",
"phone": "string",
"email": "string",
"education": ["string"
],
"certifications": ["string"
],
"services": ["string"
],
"url": "string"
}
]
}
]
}
}

Bios: Update

Update an existing Bios List.

path Parameters

accountId required	string
listId required	string ID of this List.

query Parameters

v

required

string

A date in YYYYMMDD format.

Request Body schema: application/kjson

id	string <= 32 characters List ID.
name	string List name.
title	string List title that appears on listings.
publish	boolean Indicates whether the List should be shown on your listings.
language	string List language in ISO 639-1 format. An ISO 3166-1 alpha-2 country code can optionally be appended to the language. Examples: en, en_GB, fr_CA
	Array of objects A list of sections.

Responses

Request samples

Payload

Content type

application/kjson

{"id": "string",
"name": "string",
"title": "string",
"publish": true,
"language": "string",
"sections": [{"id": "string",
"name": "string",
"description": "string",
"items": [{"id": "string",
"name": "string",
"description": "string",
"photo": {"url": "string",
"height": 0,
"width": 0,
"alternateText": "string"
},
"title": "string",
"phone": "string",
"email": "string",
"education": ["string"
],
"certifications": ["string"
],
"services": ["string"
],
"url": "string"
}
]
}
]
}

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": {"id": "string",
"accountId": "string",
"name": "string",
"title": "string",
"size": 0,
"publish": true,
"language": "string",
"sections": [{"id": "string",
"name": "string",
"description": "string",
"items": [{"id": "string",
"name": "string",
"description": "string",
"photo": {"url": "string",
"height": 0,
"width": 0,
"alternateText": "string"
},
"title": "string",
"phone": "string",
"email": "string",
"education": ["string"
],
"certifications": ["string"
],
"services": ["string"
],
"url": "string"
}
]
}
]
}
}

Bios: Delete

Delete an existing Bios List.

path Parameters

accountId required	string
listId required	string ID of this List.

query Parameters

v

required

string

A date in YYYYMMDD format.

Responses

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": { }
}

Products: List

Retrieve all Product Lists for an account.

path Parameters

accountId

required

string

query Parameters

v required	string A date in `YYYYMMDD` format.
limit	integer <= 50 Default: 10 Number of results to return.
offset	integer Default: 0 Number of results to skip. Used to page through results. Cannot be used together with `pageToken`.

Responses

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": {"count": 0,
"products": [{"id": "string",
"accountId": "string",
"name": "string",
"title": "string",
"size": 0,
"publish": true,
"language": "string",
"currency": "string",
"sections": [{"id": "string",
"name": "string",
"description": "string",
"items": [{"id": "string",
"name": "string",
"description": "string",
"photos": [{"url": null,
"height": null,
"width": null,
"alternateText": null
}
],
"cost": {"type": "PRICE",
"price": "string",
"unit": "string",
"rangeTo": "string",
"other": "string",
"options": [{ }
]
},
"idcode": "string",
"url": "string",
"video": "string",
"duration": {"unit": "MINUTES",
"value": 1
},
"ranking": 0
}
]
}
]
}
]
}
}

Products: Create

Create a new Product List.

path Parameters

accountId

required

string

query Parameters

v

required

string

A date in YYYYMMDD format.

Request Body schema: application/kjson

id	string <= 32 characters List ID.
name	string List name.
title	string List title that appears on listings.
publish	boolean Indicates whether the List should be shown on your listings.
language	string List language in ISO 639-1 format. An ISO 3166-1 alpha-2 country code can optionally be appended to the language. Examples: en, en_GB, fr_CA
currency	string The three-letter ISO 4217 currency code. Defaults to USD.
	Array of objects A list of sections.

Responses

Request samples

Payload

Content type

application/kjson

{"id": "string",
"name": "string",
"title": "string",
"publish": true,
"language": "string",
"currency": "string",
"sections": [{"id": "string",
"name": "string",
"description": "string",
"items": [{"id": "string",
"name": "string",
"description": "string",
"photos": [{"url": "string",
"height": 0,
"width": 0,
"alternateText": "string"
}
],
"cost": {"type": "PRICE",
"price": "string",
"unit": "string",
"rangeTo": "string",
"other": "string",
"options": [{"name": "string",
"price": "string",
"calorie": 0
}
]
},
"idcode": "string",
"url": "string",
"video": "string",
"duration": {"unit": "MINUTES",
"value": 1
},
"ranking": 0
}
]
}
]
}

Response samples

201
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": {"id": "string"
}
}

Products: Get

Retrieve a specific Product List.

path Parameters

accountId required	string
listId required	string ID of this List.

query Parameters

v

required

string

A date in YYYYMMDD format.

Responses

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": {"id": "string",
"accountId": "string",
"name": "string",
"title": "string",
"size": 0,
"publish": true,
"language": "string",
"currency": "string",
"sections": [{"id": "string",
"name": "string",
"description": "string",
"items": [{"id": "string",
"name": "string",
"description": "string",
"photos": [{"url": "string",
"height": 0,
"width": 0,
"alternateText": "string"
}
],
"cost": {"type": "PRICE",
"price": "string",
"unit": "string",
"rangeTo": "string",
"other": "string",
"options": [{"name": "string",
"price": "string",
"calorie": 0
}
]
},
"idcode": "string",
"url": "string",
"video": "string",
"duration": {"unit": "MINUTES",
"value": 1
},
"ranking": 0
}
]
}
]
}
}

Products: Update

Update an existing Product List.

path Parameters

accountId required	string
listId required	string ID of this List.

query Parameters

v

required

string

A date in YYYYMMDD format.

Request Body schema: application/kjson

id	string <= 32 characters List ID.
name	string List name.
title	string List title that appears on listings.
publish	boolean Indicates whether the List should be shown on your listings.
language	string List language in ISO 639-1 format. An ISO 3166-1 alpha-2 country code can optionally be appended to the language. Examples: en, en_GB, fr_CA
currency	string The three-letter ISO 4217 currency code. Defaults to USD.
	Array of objects A list of sections.

Responses

Request samples

Payload

Content type

application/kjson

{"id": "string",
"name": "string",
"title": "string",
"publish": true,
"language": "string",
"currency": "string",
"sections": [{"id": "string",
"name": "string",
"description": "string",
"items": [{"id": "string",
"name": "string",
"description": "string",
"photos": [{"url": "string",
"height": 0,
"width": 0,
"alternateText": "string"
}
],
"cost": {"type": "PRICE",
"price": "string",
"unit": "string",
"rangeTo": "string",
"other": "string",
"options": [{"name": "string",
"price": "string",
"calorie": 0
}
]
},
"idcode": "string",
"url": "string",
"video": "string",
"duration": {"unit": "MINUTES",
"value": 1
},
"ranking": 0
}
]
}
]
}

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": {"id": "string",
"accountId": "string",
"name": "string",
"title": "string",
"size": 0,
"publish": true,
"language": "string",
"currency": "string",
"sections": [{"id": "string",
"name": "string",
"description": "string",
"items": [{"id": "string",
"name": "string",
"description": "string",
"photos": [{"url": "string",
"height": 0,
"width": 0,
"alternateText": "string"
}
],
"cost": {"type": "PRICE",
"price": "string",
"unit": "string",
"rangeTo": "string",
"other": "string",
"options": [{"name": "string",
"price": "string",
"calorie": 0
}
]
},
"idcode": "string",
"url": "string",
"video": "string",
"duration": {"unit": "MINUTES",
"value": 1
},
"ranking": 0
}
]
}
]
}
}

Products: Delete

Delete an existing Products List.

path Parameters

accountId required	string
listId required	string ID of this List.

query Parameters

v

required

string

A date in YYYYMMDD format.

Responses

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": { }
}

Events (Legacy): List

Retrieve all Event Lists for an account.

path Parameters

accountId

required

string

query Parameters

v required	string A date in `YYYYMMDD` format.
limit	integer <= 50 Default: 10 Number of results to return.
offset	integer Default: 0 Number of results to skip. Used to page through results. Cannot be used together with `pageToken`.

Responses

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": {"count": 0,
"events": [{"id": "string",
"accountId": "string",
"name": "string",
"title": "string",
"size": 0,
"publish": true,
"language": "string",
"sections": [{"id": "string",
"name": "string",
"description": "string",
"items": [{"id": "string",
"name": "string",
"description": "string",
"type": "string",
"starts": "2019-08-24",
"ends": "2019-08-24",
"photos": [{"url": null,
"height": null,
"width": null,
"alternateText": null
}
],
"url": "string",
"video": "string"
}
]
}
]
}
]
}
}

Events (Legacy): Create

Create a new Event List.

path Parameters

accountId

required

string

query Parameters

v

required

string

A date in YYYYMMDD format.

Request Body schema: application/kjson

id	string <= 32 characters List ID.
name	string List name.
title	string List title that appears on listings.
publish	boolean Indicates whether the List should be shown on your listings.
language	string List language in ISO 639-1 format. An ISO 3166-1 alpha-2 country code can optionally be appended to the language. Examples: en, en_GB, fr_CA
	Array of objects A list of sections. However, Calendars cannot have more than one section.

Responses

Request samples

Payload

Content type

application/kjson

{"id": "string",
"name": "string",
"title": "string",
"publish": true,
"language": "string",
"sections": [{"id": "string",
"name": "string",
"description": "string",
"items": [{"id": "string",
"name": "string",
"description": "string",
"type": "string",
"starts": "2019-08-24",
"ends": "2019-08-24",
"photos": [{"url": "string",
"height": 0,
"width": 0,
"alternateText": "string"
}
],
"url": "string",
"video": "string"
}
]
}
]
}

Response samples

201
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": {"id": "string"
}
}

Events (Legacy): Get

Retrieve a specific Event List.

path Parameters

accountId required	string
listId required	string ID of this List.

query Parameters

v

required

string

A date in YYYYMMDD format.

Responses

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": {"id": "string",
"accountId": "string",
"name": "string",
"title": "string",
"size": 0,
"publish": true,
"language": "string",
"sections": [{"id": "string",
"name": "string",
"description": "string",
"items": [{"id": "string",
"name": "string",
"description": "string",
"type": "string",
"starts": "2019-08-24",
"ends": "2019-08-24",
"photos": [{"url": "string",
"height": 0,
"width": 0,
"alternateText": "string"
}
],
"url": "string",
"video": "string"
}
]
}
]
}
}

Events (Legacy): Update

Update an existing Event List.

path Parameters

accountId required	string
listId required	string ID of this List.

query Parameters

v

required

string

A date in YYYYMMDD format.

Request Body schema: application/kjson

id	string <= 32 characters List ID.
name	string List name.
title	string List title that appears on listings.
publish	boolean Indicates whether the List should be shown on your listings.
language	string List language in ISO 639-1 format. An ISO 3166-1 alpha-2 country code can optionally be appended to the language. Examples: en, en_GB, fr_CA
	Array of objects A list of sections. However, Calendars cannot have more than one section.

Responses

Request samples

Payload

Content type

application/kjson

{"id": "string",
"name": "string",
"title": "string",
"publish": true,
"language": "string",
"sections": [{"id": "string",
"name": "string",
"description": "string",
"items": [{"id": "string",
"name": "string",
"description": "string",
"type": "string",
"starts": "2019-08-24",
"ends": "2019-08-24",
"photos": [{"url": "string",
"height": 0,
"width": 0,
"alternateText": "string"
}
],
"url": "string",
"video": "string"
}
]
}
]
}

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": {"id": "string",
"accountId": "string",
"name": "string",
"title": "string",
"size": 0,
"publish": true,
"language": "string",
"sections": [{"id": "string",
"name": "string",
"description": "string",
"items": [{"id": "string",
"name": "string",
"description": "string",
"type": "string",
"starts": "2019-08-24",
"ends": "2019-08-24",
"photos": [{"url": "string",
"height": 0,
"width": 0,
"alternateText": "string"
}
],
"url": "string",
"video": "string"
}
]
}
]
}
}

Events (Legacy): Delete

Delete an existing Event List.

path Parameters

accountId required	string
listId required	string ID of this List.

query Parameters

v

required

string

A date in YYYYMMDD format.

Responses

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": { }
}