> **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.

# Settings — Outlet API handoff (dashboard)

> **Verification boundary:** The detailed contract below was derived from repository source, not from live HTTP captures. Fields explicitly marked unverified remain open. The earlier route inventory is retained below for cross-checking; where it says “not verified”, the more recent source-reviewed contract takes precedence.

## Controller-reviewed contracts


All URLs relative to `/api/v1/`. Example values are **illustrative**, not captured from a live server. Angle-bracket text means a placeholder, not a literal API value. Error statuses are listed only when supported by controller code.

**Coverage in this document:** 4 endpoints; this is NOT an assertion that the entire module is complete.

## `GET /api/v1/settings/general`

**Purpose:** Read site name, support email, registration switch.
**Access:** Public

| Request field | Type | Required | Validation |
|---|---|---|---|
| — | — | — | No request fields |

**Example request:**

```http
GET /api/v1/settings/general
Content-Type: application/json

{}
```

**Example success response — HTTP 200:**

```json
{
  "data": {
    "site_name": "Outlet",
    "support_email": "help@example.com",
    "registration_open": true
  }
}
```

**Response field types:**

| Field | Type |
|---|---|
| `data.site_name` | string |
| `data.support_email` | string |
| `data.registration_open` | boolean |

**Notes / errors:** Example values illustrative; keys follow GeneralSettings::toArray.

**Source:** [Settings/Interfaces/Http/Controllers/GeneralSettingsController.php](https://gitlab.com/alalmiyalhura/outlet/-/blob/main/modules/Settings/Interfaces/Http/Controllers/GeneralSettingsController.php)

---

## `PATCH /api/v1/settings/general`

**Purpose:** Partially update general settings.
**Access:** Bearer dashboard token + settings.manage

| Request field | Type | Required | Validation |
|---|---|---|---|
| `site_name` | string | no | sometimes; max:120 |
| `support_email` | email | no | sometimes; email |
| `registration_open` | boolean | no | sometimes; boolean |

**Example request:**

```http
PATCH /api/v1/settings/general
Content-Type: application/json

{
  "site_name": "Outlet",
  "support_email": "help@example.com",
  "registration_open": true
}
```

**Example success response — HTTP 200:**

```json
{
  "data": {
    "site_name": "Outlet",
    "support_email": "help@example.com",
    "registration_open": true
  }
}
```

**Response field types:**

| Field | Type |
|---|---|
| `data.site_name` | string |
| `data.support_email` | string |
| `data.registration_open` | boolean |

**Source:** [Settings/Interfaces/Http/Controllers/GeneralSettingsController.php](https://gitlab.com/alalmiyalhura/outlet/-/blob/main/modules/Settings/Interfaces/Http/Controllers/GeneralSettingsController.php)

---

## `GET /api/v1/admin/settings/localization`

**Purpose:** Read default, enabled, and supported locales.
**Access:** Bearer dashboard token + settings.manage

| Request field | Type | Required | Validation |
|---|---|---|---|
| — | — | — | No request fields |

**Example request:**

```http
GET /api/v1/admin/settings/localization
Content-Type: application/json

{}
```

**Example success response — HTTP 200:**

```json
{
  "data": {
    "default_locale": "ar",
    "enabled_locales": [
      "ar",
      "en"
    ],
    "supported_locales": [
      {
        "code": "ar",
        "native_name": "العربية",
        "dir": "rtl",
        "default": true
      }
    ]
  }
}
```

**Response field types:**

| Field | Type |
|---|---|
| `data.default_locale` | string |
| `data.enabled_locales` | array |
| `data.enabled_locales[]` | string |
| `data.supported_locales` | array |
| `data.supported_locales[].code` | string |
| `data.supported_locales[].native_name` | string |
| `data.supported_locales[].dir` | string |
| `data.supported_locales[].default` | boolean |

**Source:** [Settings/Interfaces/Http/Controllers/Admin/LocalizationSettingsController.php](https://gitlab.com/alalmiyalhura/outlet/-/blob/main/modules/Settings/Interfaces/Http/Controllers/Admin/LocalizationSettingsController.php)

---

## `PATCH /api/v1/admin/settings/localization`

**Purpose:** Change supported default/enabled locales; default must remain enabled.
**Access:** Bearer dashboard token + settings.manage

| Request field | Type | Required | Validation |
|---|---|---|---|
| `default_locale` | string | no | sometimes; one of supported locales |
| `enabled_locales` | array<string> | no | sometimes; list; min:1; distinct supported locales |

**Example request:**

```http
PATCH /api/v1/admin/settings/localization
Content-Type: application/json

{
  "default_locale": "ar",
  "enabled_locales": [
    "ar",
    "en"
  ]
}
```

**Example success response — HTTP 200:**

```json
{
  "data": {
    "default_locale": "ar",
    "enabled_locales": [
      "ar",
      "en"
    ],
    "supported_locales": [
      {
        "code": "ar",
        "native_name": "العربية",
        "dir": "rtl",
        "default": true
      }
    ]
  }
}
```

**Response field types:**

| Field | Type |
|---|---|
| `data.default_locale` | string |
| `data.enabled_locales` | array |
| `data.enabled_locales[]` | string |
| `data.supported_locales` | array |
| `data.supported_locales[].code` | string |
| `data.supported_locales[].native_name` | string |
| `data.supported_locales[].dir` | string |
| `data.supported_locales[].default` | boolean |

**Notes / errors:** Cross-field validation ensures default_locale belongs to resulting enabled_locales.

**Source:** [Settings/Interfaces/Http/Controllers/Admin/LocalizationSettingsController.php](https://gitlab.com/alalmiyalhura/outlet/-/blob/main/modules/Settings/Interfaces/Http/Controllers/Admin/LocalizationSettingsController.php)

---


---

## Earlier route inventory (historical; superseded by contracts above)

# Settings — Outlet API handoff (dashboard)

> **Verification boundary:** The detailed contract below was derived from repository source, not from live HTTP captures. Fields explicitly marked unverified remain open. The earlier route inventory is retained below for cross-checking; where it says “not verified”, the more recent source-reviewed contract takes precedence.

## Controller-reviewed contracts


Verified against GitLab `alalmiyalhura/outlet`, branch `main` (2026-11-22).
Base path: `/api/v1/`. All example data is **illustrative**, not captured from a running server.
Response bodies shown are representative shapes, not promises of specific runtime monetary values, localized strings, or pagination links.

## `GET /api/v1/admin/pricing/settings`

**Purpose:** Read active commission, buyer service fee, and VAT policy used by the dashboard.
**Access:** Bearer dashboard session; settings.manage

### Request fields

| Field | Type | Required | Validation / constraints |
|---|---|---|---|
| — | — | — | No body or documented query fields |

### Example request

```http
GET /api/v1/admin/pricing/settings HTTP/1.1
Accept: application/json
Authorization: Bearer <dashboard-token>
```

### Example success response (HTTP 200)

```json
{
  "data": {
    "fees": {
      "commission_rate": "15.00",
      "buyer_service_fee": {
        "enabled": true,
        "type": "fixed",
        "value": "5.00",
        "unit": "SAR"
      }
    },
    "tax": {
      "enabled": true,
      "vat_rate": "15.00",
      "prices_include_vat": true
    },
    "currency": "SAR",
    "service_fee_types": [
      "fixed",
      "percent"
    ],
    "limits": {
      "commission_rate_max": "<configured percentage limit>",
      "percent_max": "100.00",
      "fixed_service_fee_max": "<configured fixed-fee limit>"
    },
    "display_only_tax": true
  }
}
```

### Response fields

| Field | Type / meaning |
|---|---|
| `data.fees.commission_rate` | decimal percent string |
| `data.fees.buyer_service_fee` | {enabled:boolean,type:fixed|percent,value:decimal string,unit:string} |
| `data.tax` | {enabled:boolean,vat_rate:decimal percent string,prices_include_vat:boolean} |
| `data.currency` | string; data.service_fee_types:string[] |
| `data.limits` | object; data.display_only_tax:boolean |

### Notes, failures and limits

Settings reflect current persisted fee schedule; numeric examples are illustrative.

**Source:** https://gitlab.com/alalmiyalhura/outlet/-/blob/main/modules/Pricing/Interfaces/Http/Controllers/Admin/PricingSettingsController.php

---

## `PATCH /api/v1/admin/pricing/settings`

**Purpose:** Partially update fee and tax schedule, recording actor, optional reason, and a batch of individual changes.
**Access:** Bearer dashboard session; settings.manage; idempotent middleware

### Request fields

| Field | Type | Required | Validation / constraints |
|---|---|---|---|
| `fees` | object | conditional | required_without:tax; allowed keys commission_rate,buyer_service_fee |
| `fees.commission_rate` | string | no | regex ^\d{1,3}(\.\d{1,2})?$; additional domain caps |
| `fees.buyer_service_fee` | object | no | allowed keys enabled,type,value |
| `fees.buyer_service_fee.enabled` | boolean | no | boolean |
| `fees.buyer_service_fee.type` | string | no | fixed|percent |
| `fees.buyer_service_fee.value` | string | no | regex ^\d{1,5}(\.\d{1,2})?$ |
| `tax` | object | conditional | required_without:fees; allowed keys enabled,vat_rate,prices_include_vat |
| `tax.enabled` | boolean | no | boolean |
| `tax.vat_rate` | string | no | regex ^\d{1,3}(\.\d{1,2})?$; additional domain caps |
| `tax.prices_include_vat` | boolean | no | boolean |
| `reason` | string|null | no | max:500 |

### Example request

```http
PATCH /api/v1/admin/pricing/settings HTTP/1.1
Accept: application/json
Authorization: Bearer <dashboard-token>
Content-Type: application/json

{
  "fees": {
    "commission_rate": "12.50",
    "buyer_service_fee": {
      "enabled": true,
      "type": "fixed",
      "value": "5.00"
    }
  },
  "reason": "Updated marketplace fee policy"
}
```

### Example success response (HTTP 200)

```json
{
  "data": {
    "fees": {
      "commission_rate": "15.00",
      "buyer_service_fee": {
        "enabled": true,
        "type": "fixed",
        "value": "5.00",
        "unit": "SAR"
      }
    },
    "tax": {
      "enabled": true,
      "vat_rate": "15.00",
      "prices_include_vat": true
    },
    "currency": "SAR",
    "service_fee_types": [
      "fixed",
      "percent"
    ],
    "limits": {
      "commission_rate_max": "<configured percentage limit>",
      "percent_max": "100.00",
      "fixed_service_fee_max": "<configured fixed-fee limit>"
    },
    "display_only_tax": true,
    "changed": true,
    "batch_id": "<batch identifier>",
    "changes": [
      {
        "setting": "fees.commission_rate",
        "old": {
          "value": "15.00",
          "unit": "percent"
        },
        "new": {
          "value": "12.50",
          "unit": "percent"
        }
      }
    ]
  }
}
```

### Response fields

| Field | Type / meaning |
|---|---|
| `data.changed` | boolean; data.batch_id:string|null |
| `data.changes[]` | {setting:string,old:{value,unit},new:{value,unit}} |
| `All GET settings fields are returned again` | All GET settings fields are returned again |

### Notes, failures and limits

Repeating an unchanged PATCH returns changed=false and empty changes; batch_id is determined by handler. Exact error codes require domain handler audit.

**Source:** https://gitlab.com/alalmiyalhura/outlet/-/blob/main/modules/Pricing/Interfaces/Http/Requests/PricingSettingsRequest.php

---

## `GET /api/v1/admin/pricing/settings/history`

**Purpose:** Paginated audit history for changes to Pricing setting rows.
**Access:** Bearer dashboard session; settings.manage

### Request fields

| Field | Type | Required | Validation / constraints |
|---|---|---|---|
| `per_page` | integer | no | See AuditPageRequest (not yet independently audited) |

### Example request

```http
GET /api/v1/admin/pricing/settings/history HTTP/1.1
Accept: application/json
Authorization: Bearer <dashboard-token>
```

### Example success response (HTTP 200)

```json
{
  "data": [
    {
      "id": 1,
      "event": "updated",
      "changes": [
        {
          "field": "value",
          "old": "15.00",
          "new": "12.50"
        }
      ],
      "actor": {
        "id": 3,
        "name": "Admin"
      },
      "ip_address": "192.0.2.1",
      "at": "2026-11-22T10:00:00+00:00"
    }
  ]
}
```

### Response fields

| Field | Type / meaning |
|---|---|
| `data[] audit row` | id:int,event:string,changes:array,actor:object|null,ip_address:string|null,at:ISO date|null |

### Notes, failures and limits

Pagination and additional filters need AuditPageRequest/AuditPage verification. Example is illustrative.

**Source:** https://gitlab.com/alalmiyalhura/outlet/-/blob/main/modules/Pricing/Interfaces/Http/Controllers/Admin/PricingSettingsController.php

---

## `GET /api/v1/admin/pricing/fee-changes`

**Purpose:** Paginated append-only fee/tax change log with filtering and sorting.
**Access:** Bearer dashboard session; pricing.fees.view

### Request fields

| Field | Type | Required | Validation / constraints |
|---|---|---|---|
| `filter[setting]` | string | no | max:500; comma-separated allowed by query builder |
| `filter[group]` | string | no | fees|tax |
| `filter[actor_id]` | integer | no | min:1 |
| `filter[batch_id]` | string | no | size:32 |
| `filter[from], filter[to]` | date | no | valid date |
| `filter[has_reason]` | string | no | 0|1|true|false |
| `filter[old_value], filter[new_value]` | string | no | max:200 |
| `filter[unit]` | string | no | max:100 |
| `filter[search]` | string | no | max:100 |
| `per_page` | integer | no | 1..100, default 25 |
| `sort` | string | no | created_at,setting,id; - for descending |

### Example request

```http
GET /api/v1/admin/pricing/fee-changes HTTP/1.1
Accept: application/json
Authorization: Bearer <dashboard-token>
```

### Example success response (HTTP 200)

```json
{
  "data": [
    {
      "id": 5,
      "batch_id": "<32-character-batch-id>",
      "setting": "fees.commission_rate",
      "group": "fees",
      "old": {
        "value": "15.00",
        "unit": "percent"
      },
      "new": {
        "value": "12.50",
        "unit": "percent"
      },
      "actor": {
        "id": 3,
        "name": "Admin"
      },
      "reason": "Policy change",
      "at": "2026-11-22T10:00:00+00:00"
    }
  ],
  "links": {
    "first": "<url>",
    "last": "<url>",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "per_page": 25,
    "total": 1
  }
}
```

### Response fields

| Field | Type / meaning |
|---|---|
| `data[]` | PricingPresenter.logRow fields id,batch_id,setting,group,old,new,actor,reason,at |
| `links/meta` | Laravel paginated JsonResource collection |

### Notes, failures and limits

Default sorting -id; sort whitelist from QueryBuilder. Examples illustrative.

**Source:** https://gitlab.com/alalmiyalhura/outlet/-/blob/main/modules/Pricing/Interfaces/Http/Requests/FeeChangesRequest.php

---

## `GET /api/v1/admin/pricing/fee-changes/{id}`

**Purpose:** Read a change, sibling changes in its batch, current policy and recent audit.
**Access:** Bearer dashboard session; pricing.fees.view

### Request fields

| Field | Type | Required | Validation / constraints |
|---|---|---|---|
| `id` | integer | yes | numeric route parameter |

### Example request

```http
GET /api/v1/admin/pricing/fee-changes/{id} HTTP/1.1
Accept: application/json
Authorization: Bearer <dashboard-token>
```

### Example success response (HTTP 200)

```json
{
  "data": {
    "id": 5,
    "batch_id": "<batch-id>",
    "setting": "fees.commission_rate",
    "group": "fees",
    "old": {
      "value": "15.00",
      "unit": "percent"
    },
    "new": {
      "value": "12.50",
      "unit": "percent"
    },
    "actor": {
      "id": 3,
      "name": "Admin"
    },
    "reason": "Policy change",
    "at": "2026-11-22T10:00:00+00:00",
    "batch": [],
    "current_settings": {
      "fees": {
        "commission_rate": "15.00",
        "buyer_service_fee": {
          "enabled": true,
          "type": "fixed",
          "value": "5.00",
          "unit": "SAR"
        }
      },
      "tax": {
        "enabled": true,
        "vat_rate": "15.00",
        "prices_include_vat": true
      }
    },
    "previous_change": null,
    "audit": []
  }
}
```

### Response fields

| Field | Type / meaning |
|---|---|
| `data` | PricingPresenter.logRow fields |
| `data.batch` | array of logRow; data.current_settings:{fees,tax} |
| `data.previous_change` | logRow|null; data.audit: audit row[] |

### Notes, failures and limits

Unknown id -> 404 via findOrFail. Example illustrative.

**Source:** https://gitlab.com/alalmiyalhura/outlet/-/blob/main/modules/Pricing/Interfaces/Http/Controllers/Admin/FeeChangeAdminController.php

---

## `GET /api/v1/admin/pricing/quote-preview`

**Purpose:** Simulate the current fee policy for a cart total and delivery fee; does not persist anything.
**Access:** Bearer dashboard session; pricing.fees.view

### Request fields

| Field | Type | Required | Validation / constraints |
|---|---|---|---|
| `items_total` | string | yes | regex ^\d{1,6}(\.\d{1,2})?$ |
| `delivery_fee` | string|null | no | same amount regex; defaults to 0 |

### Example request

```http
GET /api/v1/admin/pricing/quote-preview HTTP/1.1
Accept: application/json
Authorization: Bearer <dashboard-token>
```

### Example success response (HTTP 200)

```json
{
  "data": {
    "snapshot": "<snapshot object from PriceQuote.toSnapshot()>",
    "currency": "SAR",
    "items_total": "100.00",
    "service_fee": "5.00",
    "service_fee_type": "fixed",
    "service_fee_rate": null,
    "delivery_fee": "10.00",
    "buyer_total": "115.00",
    "commission": "12.50",
    "commission_rate": "12.50",
    "seller_net": "87.50",
    "tax_display": {
      "enabled": true,
      "rate": "15.00",
      "prices_include_vat": true,
      "base": "100.00",
      "amount": "13.04",
      "included_amount": "13.04",
      "note": "<localized note>"
    },
    "lines": [
      {
        "key": "items",
        "label": "<localized label>",
        "amount": "100.00",
        "display": null,
        "informational": false
      },
      {
        "key": "delivery",
        "label": "<localized label>",
        "amount": "10.00",
        "display": null,
        "informational": false,
        "pending": false
      }
    ],
    "total": {
      "label": "<localized total label>",
      "amount": "115.00",
      "note": "<localized note>"
    },
    "seller": {
      "lines": [
        {
          "key": "item_price",
          "label": "<localized label>",
          "amount": "100.00"
        },
        {
          "key": "commission",
          "label": "<localized label>",
          "amount": "-12.50"
        },
        {
          "key": "seller_net",
          "label": "<localized label>",
          "amount": "87.50"
        }
      ],
      "note": "<localized note>"
    }
  }
}
```

### Response fields

| Field | Type / meaning |
|---|---|
| `data.snapshot` | PriceQuote.toSnapshot() object (nested structure needs separate audit) |
| `data.currency` | string; items_total,service_fee,delivery_fee,buyer_total,commission,seller_net: decimal strings |
| `data.tax_display` | object; data.lines: array; data.total: object; data.seller: object |

### Notes, failures and limits

Monetary totals are illustrative and depend on live policy; do not treat sample as formula assertion.

**Source:** https://gitlab.com/alalmiyalhura/outlet/-/blob/main/modules/Pricing/Interfaces/Http/Controllers/Admin/FeeChangeAdminController.php

---

## `GET /api/v1/admin/verification/settings`

**Purpose:** Read current OTP policy.
**Access:** Bearer dashboard session; verification.settings.manage

### Request fields

| Field | Type | Required | Validation / constraints |
|---|---|---|---|
| — | — | — | No body or documented query fields |

### Example request

```http
GET /api/v1/admin/verification/settings HTTP/1.1
Accept: application/json
Authorization: Bearer <dashboard-token>
```

### Example success response (HTTP 200)

```json
{
  "data": {
    "otp_length": 4,
    "otp_ttl_seconds": 300,
    "otp_max_attempts": 5,
    "otp_resend_cooldown_seconds": 60
  }
}
```

### Response fields

| Field | Type / meaning |
|---|---|
| `data.otp_length` | int |
| `data.otp_ttl_seconds` | int |
| `data.otp_max_attempts` | int |
| `data.otp_resend_cooldown_seconds` | int |

### Notes, failures and limits

Values are illustrative, configurable settings.

**Source:** https://gitlab.com/alalmiyalhura/outlet/-/blob/main/modules/Verification/Interfaces/Http/Controllers/Admin/VerificationSettingsController.php

---

## `PATCH /api/v1/admin/verification/settings`

**Purpose:** Partially update OTP policy, audit old/new values.
**Access:** Bearer dashboard session; verification.settings.manage

### Request fields

| Field | Type | Required | Validation / constraints |
|---|---|---|---|
| `otp_length` | integer | no | 4..8 |
| `otp_ttl_seconds` | integer | no | 60..3600 |
| `otp_max_attempts` | integer | no | 1..10 |
| `otp_resend_cooldown_seconds` | integer | no | 0..600 |

### Example request

```http
PATCH /api/v1/admin/verification/settings HTTP/1.1
Accept: application/json
Authorization: Bearer <dashboard-token>
Content-Type: application/json

{
  "otp_length": 6,
  "otp_ttl_seconds": 300
}
```

### Example success response (HTTP 200)

```json
{
  "data": {
    "otp_length": 6,
    "otp_ttl_seconds": 300,
    "otp_max_attempts": 5,
    "otp_resend_cooldown_seconds": 60
  }
}
```

### Response fields

| Field | Type / meaning |
|---|---|
| `data.otp_length` | int |
| `data.otp_ttl_seconds` | int |
| `data.otp_max_attempts` | int |
| `data.otp_resend_cooldown_seconds` | int |

### Notes, failures and limits

Returns full settings, not just changed keys; 422 on validation failures.

**Source:** https://gitlab.com/alalmiyalhura/outlet/-/blob/main/modules/Verification/Interfaces/Http/Controllers/Admin/VerificationSettingsController.php

---

## `GET /api/v1/admin/settings/localization`

**Purpose:** Read default, enabled, and supported locales for dashboard language management.
**Access:** Bearer dashboard session; settings.manage

### Request fields

| Field | Type | Required | Validation / constraints |
|---|---|---|---|
| — | — | — | No body or documented query fields |

### Example request

```http
GET /api/v1/admin/settings/localization HTTP/1.1
Accept: application/json
Authorization: Bearer <dashboard-token>
```

### Example success response (HTTP 200)

```json
{
  "data": {
    "default_locale": "ar",
    "enabled_locales": [
      "ar",
      "en"
    ],
    "supported_locales": [
      {
        "code": "ar",
        "native_name": "العربية",
        "dir": "rtl",
        "default": true
      },
      {
        "code": "en",
        "native_name": "English",
        "dir": "ltr",
        "default": false
      }
    ]
  }
}
```

### Response fields

| Field | Type / meaning |
|---|---|
| `data.default_locale` | string |
| `data.enabled_locales` | string[] |
| `data.supported_locales[]` | {code,native_name,dir,default} |

### Notes, failures and limits

Supported locale list depends on installation.

**Source:** https://gitlab.com/alalmiyalhura/outlet/-/blob/main/modules/Settings/Interfaces/Http/Controllers/Admin/LocalizationSettingsController.php

---

## `PATCH /api/v1/admin/settings/localization`

**Purpose:** Change default and/or enabled locales, preserving the invariant that the default is enabled.
**Access:** Bearer dashboard session; settings.manage

### Request fields

| Field | Type | Required | Validation / constraints |
|---|---|---|---|
| `default_locale` | string | no | one of supported locales |
| `enabled_locales` | array | no | list, min:1 |
| `enabled_locales.*` | string | conditional | required, distinct, supported locale |

### Example request

```http
PATCH /api/v1/admin/settings/localization HTTP/1.1
Accept: application/json
Authorization: Bearer <dashboard-token>
Content-Type: application/json

{
  "default_locale": "en",
  "enabled_locales": [
    "en",
    "ar"
  ]
}
```

### Example success response (HTTP 200)

```json
{
  "data": {
    "default_locale": "en",
    "enabled_locales": [
      "en",
      "ar"
    ],
    "supported_locales": [
      {
        "code": "en",
        "native_name": "English",
        "dir": "ltr",
        "default": true
      },
      {
        "code": "ar",
        "native_name": "العربية",
        "dir": "rtl",
        "default": false
      }
    ]
  }
}
```

### Response fields

| Field | Type / meaning |
|---|---|
| `data.default_locale` | string |
| `data.enabled_locales` | string[] |
| `data.supported_locales[]` | {code,native_name,dir,default} |

### Notes, failures and limits

Post-validation requires default_locale to be in enabled_locales; 422 if not. Changes audited.

**Source:** https://gitlab.com/alalmiyalhura/outlet/-/blob/main/modules/Settings/Interfaces/Http/Requests/UpdateLocalizationSettingsRequest.php

---


---

## Earlier route inventory (historical; superseded by contracts above)

# Settings — Dashboard API

Source: `modules/Settings/Routes/api.php` on GitLab `main`. Paths are relative to the Laravel API prefix. These entries are route-verified; unspecified request and response schemas are **not yet verified**, and should not be implemented from guesses.

## 1. `PATCH /settings/general`

**Purpose:** update general settings. **Access:** settings.manage.

| Input | Contract |
|---|---|
| Path parameters | None |
| Request body / query | Not yet verified from controller and request class |
| Response JSON | Not yet verified from controller/presenter |

## 2. `GET /admin/settings/localization`

**Purpose:** localization. **Access:** settings.manage.

| Input | Contract |
|---|---|
| Path parameters | None |
| Request body / query | Not yet verified from controller and request class |
| Response JSON | Not yet verified from controller/presenter |

## 3. `PATCH /admin/settings/localization`

**Purpose:** update localization. **Access:** settings.manage.

| Input | Contract |
|---|---|
| Path parameters | None |
| Request body / query | Not yet verified from controller and request class |
| Response JSON | Not yet verified from controller/presenter |

