Fiest Developers

Get a catalog import result

Returns the current result of a previously accepted import action without exposing another restaurant or authorization boundary.

GET/v1/restaurants/{restaurantId}/catalog-import/actions/{actionId}

Returns the current result of a previously accepted import action without exposing another restaurant or authorization boundary. Organization-boundary tokens also require fiest.organization.read; when a token covers several organizations, organization_id must identify an exact organization returned by listOrganizations.

Quick request

curl -X GET "https://example.com/v1/restaurants/11111111-1111-4111-8111-111111111111/catalog-import/actions/aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa?organization_id=33333333-3333-4333-8333-333333333333" \  -H "Authorization: Bearer $FIEST_ACCESS_TOKEN"
{  "data": {    "status": "succeeded",    "result": null  }}

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
actionId*string

The UUID action identifier returned when an import is accepted.

Formatuuid

Query Parameters

organization_id?string

An organizationId returned by GET /v1/organizations. Required for restaurant-scoped calls when a Management portfolio authorization covers more than one organization; omitted for a single-restaurant authorization and optional for a one-organization grant.

Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json