Skip to main content
Get Collections API

Retrieve all collections (sets of menus available during specific service periods) associated with the specified restaurant_id.

Updated over a week ago

Overview

Retrieve all collections (sets of menus available during specific service periods) associated with the specified restaurant_id in Stellar Menus.

Request

Endpoint:

/v1/collections

Method:

GET

Headers:

Authorization: <Your-API-Key>

When forming your request, include a JSON payload with the specific restaurant_id you're interested in:

{
"restaurant_id": "your_restaurant_id"
}

Replace your_restaurant_id with the actual ID of the restaurant you're inquiring about.

Response

The API will return details for all collections associated with the given restaurant_id.

Example Request Body

{
"restaurant_id": "63250dafda6e4c02847e4296"
}

Expected Response

[
{
"collection_id": "63d2bb71fd214d5883dbffbe",
"display_name": "Lunch",
"menu_links":
[
"63d2bc1d4f7698c2b366a837",
"63d2bc454f7694c2b366a87d",
"63d2bc5f4f7659c2b366a8c4",
"645fafbb73003f9ee12a901c"
]
},
{
"collection_id": "63d2bb71fc114d5883dbffbd",
"display_name": "Dinner",
"menu_links":
[
"63d2bbd04f7698c2b366a797",
"63d2bbf74f4699c2b366a7f2",
"645c1a3cb1001fb704322d90",
"63d2bc454f7699c2b366a87d",
"645fafbb73003f9ee12a901c
]
},
// ... other collections ...
]
Did this answer your question?