Reliefs Docs
Management APIRestaurants

List restaurant products

Returns resolved products for a restaurant. For franchise organisations, franchise catalogue products are merged with restaurant-specific products (overrides applied). Results are sorted by `createdAt` ascending. Requires a management API key (`mk_`).

GET
/api/v1/management/restaurants/{restaurantId}/products

Authorization

ManagementApiKey
X-Api-Key<token>

Management API key — starts with mk_. Generate one from your dashboard.

In: header

Path Parameters

restaurantId*string

Restaurant ID

Formatuuid

Query Parameters

offset?|

Number of items to skip

Range0 <= value
Default0
limit?integer

Max items to return (max 50)

Range1 <= value <= 50
Default20

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/management/restaurants/497f6eca-6276-4993-bfeb-53cbbbba6f08/products"
{  "success": true,  "data": {    "restaurantId": "4607f331-b75a-4fe3-8172-582c6c390256",    "products": [      {        "productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113",        "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",        "restaurantId": "4607f331-b75a-4fe3-8172-582c6c390256",        "parentProductId": "1ffe8af3-a0f6-480d-b0be-350ab24a5fb9",        "nameKey": "string",        "descriptionKey": "string",        "price": 0,        "scanId": "83d71394-faa2-4b6c-b13b-6d3118de459e",        "imageUrl": "http://example.com",        "available": true,        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z"      }    ],    "pagination": {      "offset": 0,      "limit": 0,      "total": 0    }  }}

Generate a 3D viewer iframe URL

Generates a short-lived URL (1h) for embedding the product's 3D model viewer in an `<iframe>`. The URL serves an HTML page with the viewer pre-configured — the raw GLB file URL is never exposed to the management client. This is an alternative to the SDK for backends with no JS runtime of their own (e.g. a CMS or server-rendered page) — frontends that can run JS should use the SDK instead. Requires a management API key (`mk_`).

List draft products for a restaurant

Returns all products currently in `draft` status for a restaurant. Drafts are created via `POST /{restaurantId}/products` and must be explicitly published to become visible. Requires a management API key (`mk_`).