# Validate and plan a catalog import

Source: https://docs.fiest.io/api/reference/plan-catalog-import
Canonical sandbox contract: https://docs.fiest.io/openapi.yaml

## POST /v1/restaurants/{restaurantId}/catalog-import/plan

Validates a bounded create-only catalog document and returns a deterministic plan hash. This operation does not write data. Organization-boundary tokens also require fiest.organization.read.

## Authentication

Send an OAuth access token in the `Authorization` header as
`Bearer $FIEST_ACCESS_TOKEN`.

Required scopes: `fiest.restaurant.read`, `fiest.menu.read`, `fiest.catalog.import.write`

## Quick request

```bash
curl --request POST \
  --url 'https://api-sandbox.fiest.io/v1/restaurants/11111111-1111-4111-8111-111111111111/catalog-import/plan' \
  --header 'Authorization: Bearer $FIEST_ACCESS_TOKEN'
```

## Parameters

| Name | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| `restaurantId` | path | Yes | string (uuid) | A restaurant identifier returned by the authorized restaurant list. |

## Success response

### 200 — The validation result and import plan hash.

```json
{
  "data": {
    "restaurantId": "11111111-1111-4111-8111-111111111111",
    "valid": true,
    "planHash": "cccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc",
    "menuName": "Lunch menu",
    "target": {
      "mode": "new_draft",
      "menuPublicId": null,
      "menuName": "Lunch menu",
      "previousCategoryCount": 0,
      "previousItemCount": 0
    },
    "creates": {
      "menus": 1,
      "newMenus": 1,
      "menuCategories": 1,
      "menuItems": 1,
      "optionGroups": 0,
      "options": 0,
      "productCategories": 0,
      "products": 0,
      "combos": 0,
      "comboComponents": 0
    },
    "warnings": [],
    "errors": [],
    "publishesAutomatically": false
  }
}
```

## Error responses

### 400 — The request parameters are invalid.

```json
{
  "error": "invalid_request",
  "message": "The requested date range is invalid.",
  "request_id": "req_sandbox_invalid_request"
}
```

### 401 — The access token is missing, invalid, or expired.

```json
{
  "error": "invalid_token",
  "error_description": "The access token is invalid.",
  "request_id": "req_sandbox_invalid_token"
}
```

### 403 — The authorization has expired or does not include the required scope.

```json
{
  "error": "insufficient_scope",
  "error_description": "The operation requires an OAuth scope that is not granted.",
  "request_id": "req_sandbox_insufficient_scope"
}
```

### 404 — The restaurant or requested resource does not exist or is outside the authorization.

```json
{
  "error": "not_found",
  "request_id": "req_sandbox_not_found"
}
```

### 413 — The JSON request body exceeds one megabyte.

```json
{
  "error": "payload_too_large",
  "request_id": "req_sandbox_payload_too_large"
}
```

### 429 — The partner request limit has been exceeded.

```json
{
  "error": "rate_limited",
  "request_id": "req_sandbox_rate_limited"
}
```

### 503 — The API or one of its required services is unavailable.

```json
{
  "error": "service_unavailable",
  "request_id": "req_sandbox_service_unavailable"
}
```

## Related

- [Quick start](https://docs.fiest.io/api/quickstart)
- [Stable API errors](https://docs.fiest.io/api/reference/errors)
- [OpenAPI 3.1 contract, YAML](https://docs.fiest.io/openapi.yaml)
- [OpenAPI 3.1 contract, JSON](https://docs.fiest.io/openapi.json)
- [Authorize and call the Fiest Partner API](https://docs.fiest.io/api/quickstart)