Fiest Developers

Inspect a catalog import target

Returns the exact state and categories of one user-selected menu. Only inactive draft menus can receive newly created catalog entities.

GET/v1/restaurants/{restaurantId}/catalog-import/targets/{menuPublicId}

Returns the exact state and categories of one user-selected menu. Only inactive draft menus can receive newly created catalog entities. Organization-boundary tokens also require fiest.organization.read.

Quick request

curl -X GET "https://example.com/v1/restaurants/11111111-1111-4111-8111-111111111111/catalog-import/targets/43f64da8-4ec2-4900-b137-1c0927c975d2" \  -H "Authorization: Bearer $FIEST_ACCESS_TOKEN"
{  "data": {    "restaurantId": "11111111-1111-4111-8111-111111111111",    "menu": {      "menuPublicId": "43f64da8-4ec2-4900-b137-1c0927c975d2",      "name": "Lunch menu",      "activeForPos": false,      "onlineOrdering": false,      "categoryCount": 2,      "itemCount": 8    },    "canAddCatalogEntities": true,    "categories": [      {        "categoryPublicId": "af16a392-f8a1-47b4-849f-4d707001e9b1",        "name": "Pizzas",        "itemCount": 8      }    ]  }}

Authorization

fiestOAuth fiest.restaurant.read, fiest.menu.read, fiest.catalog.import.write
AuthorizationBearer <token>

OAuth 2.1 authorization code with PKCE. Partner clients and redirect URIs must be approved by Fiest before use.

In: header

Scope: fiest.restaurant.read, fiest.menu.read, fiest.catalog.import.write

Path Parameters

restaurantId*string

A restaurant identifier returned by the authorized restaurant list.

Formatuuid
menuPublicId*string

The stable menu UUID returned by the menu list.

Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json