> **Client contract note:** Apply [`shared/response-envelope.md`](../shared/response-envelope.md) to JSON responses after the response-contract release. Legacy wrapper examples below may reflect the prior API; the documented endpoint-specific payload fields are still useful. Not staging-verified.

# ImportExport — Dashboard API

Source: [`modules/ImportExport/Routes/api.php`](https://gitlab.com/alalmiyalhura/outlet/-/blob/main/modules/ImportExport/Routes/api.php) (`main`). Paths shown relative to Laravel API prefix.

**Contract status:** route and middleware verified. Controller-level request schemas and exact success/error JSON have **not yet been verified**; examples are deliberately not fabricated.

## 1. `GET /imports`

**Purpose:** Available imports. **Access/middleware:** auth:sanctum.

| Contract item | Verified detail |
|---|---|
| Path parameters | None |
| Request headers | `Authorization: Bearer <token>` when `auth:sanctum` is required; `Accept: application/json` recommended |
| Query parameters | Not verified from controller |
| Request body and validation | Not verified from FormRequest/controller |
| Success response fields / JSON example | Not verified from presenter/resource |
| Error payload | Not verified from error handler |

## 2. `GET /imports/batches/{id}`

**Purpose:** Import batch. **Access/middleware:** auth:sanctum.

| Contract item | Verified detail |
|---|---|
| Path parameters | `id` |
| Request headers | `Authorization: Bearer <token>` when `auth:sanctum` is required; `Accept: application/json` recommended |
| Query parameters | Not verified from controller |
| Request body and validation | Not verified from FormRequest/controller |
| Success response fields / JSON example | Not verified from presenter/resource |
| Error payload | Not verified from error handler |

## 3. `GET /imports/batches/{id}/errors`

**Purpose:** Batch errors. **Access/middleware:** auth:sanctum.

| Contract item | Verified detail |
|---|---|
| Path parameters | `id` |
| Request headers | `Authorization: Bearer <token>` when `auth:sanctum` is required; `Accept: application/json` recommended |
| Query parameters | Not verified from controller |
| Request body and validation | Not verified from FormRequest/controller |
| Success response fields / JSON example | Not verified from presenter/resource |
| Error payload | Not verified from error handler |

## 4. `GET /imports/{key}/template`

**Purpose:** Import template. **Access/middleware:** auth:sanctum.

| Contract item | Verified detail |
|---|---|
| Path parameters | `key` |
| Request headers | `Authorization: Bearer <token>` when `auth:sanctum` is required; `Accept: application/json` recommended |
| Query parameters | Not verified from controller |
| Request body and validation | Not verified from FormRequest/controller |
| Success response fields / JSON example | Not verified from presenter/resource |
| Error payload | Not verified from error handler |

## 5. `POST /imports/{key}/preview`

**Purpose:** Preview import. **Access/middleware:** auth:sanctum; throttle 20/min.

| Contract item | Verified detail |
|---|---|
| Path parameters | `key` |
| Request headers | `Authorization: Bearer <token>` when `auth:sanctum` is required; `Accept: application/json` recommended |
| Query parameters | Not verified from controller |
| Request body and validation | Not verified from FormRequest/controller |
| Success response fields / JSON example | Not verified from presenter/resource |
| Error payload | Not verified from error handler |

## 6. `POST /imports/{key}`

**Purpose:** Create import. **Access/middleware:** auth:sanctum; throttle 10/min.

| Contract item | Verified detail |
|---|---|
| Path parameters | `key` |
| Request headers | `Authorization: Bearer <token>` when `auth:sanctum` is required; `Accept: application/json` recommended |
| Query parameters | Not verified from controller |
| Request body and validation | Not verified from FormRequest/controller |
| Success response fields / JSON example | Not verified from presenter/resource |
| Error payload | Not verified from error handler |

## 7. `GET /exports`

**Purpose:** Available exports. **Access/middleware:** auth:sanctum.

| Contract item | Verified detail |
|---|---|
| Path parameters | None |
| Request headers | `Authorization: Bearer <token>` when `auth:sanctum` is required; `Accept: application/json` recommended |
| Query parameters | Not verified from controller |
| Request body and validation | Not verified from FormRequest/controller |
| Success response fields / JSON example | Not verified from presenter/resource |
| Error payload | Not verified from error handler |

## 8. `GET /exports/batches/{id}`

**Purpose:** Export batch. **Access/middleware:** auth:sanctum.

| Contract item | Verified detail |
|---|---|
| Path parameters | `id` |
| Request headers | `Authorization: Bearer <token>` when `auth:sanctum` is required; `Accept: application/json` recommended |
| Query parameters | Not verified from controller |
| Request body and validation | Not verified from FormRequest/controller |
| Success response fields / JSON example | Not verified from presenter/resource |
| Error payload | Not verified from error handler |

## 9. `GET /exports/batches/{id}/download`

**Purpose:** Download export. **Access/middleware:** auth:sanctum.

| Contract item | Verified detail |
|---|---|
| Path parameters | `id` |
| Request headers | `Authorization: Bearer <token>` when `auth:sanctum` is required; `Accept: application/json` recommended |
| Query parameters | Not verified from controller |
| Request body and validation | Not verified from FormRequest/controller |
| Success response fields / JSON example | Not verified from presenter/resource |
| Error payload | Not verified from error handler |

## 10. `POST /exports/{key}`

**Purpose:** Create export. **Access/middleware:** auth:sanctum; throttle 10/min.

| Contract item | Verified detail |
|---|---|
| Path parameters | `key` |
| Request headers | `Authorization: Bearer <token>` when `auth:sanctum` is required; `Accept: application/json` recommended |
| Query parameters | Not verified from controller |
| Request body and validation | Not verified from FormRequest/controller |
| Success response fields / JSON example | Not verified from presenter/resource |
| Error payload | Not verified from error handler |

