> ## Documentation Index
> Fetch the complete documentation index at: https://docs-pos.solya.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a region

> Adds a geographic region to the network directory. This is a back-office MAINTENANCE operation: the created region immediately becomes a selectable grouping stores can be assigned to. The `id` is caller-supplied — pick a stable, URL-safe slug (e.g. `reg-bre`), because it is the handle every other maintenance verb addresses it by; 409s when a region already carries it (a create never overwrites — use the update operation instead). `active` is optional and defaults to `true`; `storeCount` is optional and defaults to `0` (a fresh region holds no stores until one is assigned to it — it is a stored counter, not a live join). PERMISSION TRAP (see solya-pos#950): the route guard accepts `pos.settings.manage`, but the use-case additionally asserts the kernel `config:manage` permission and NO `pos.settings.*` scope maps to it, so a principal authenticated by scopes alone clears the guard and then 403s inside the use-case — only a session whose role carries `config:manage` can actually create.



## OpenAPI

````yaml /openapi.json post /v1/regions
openapi: 3.0.3
info:
  title: Solya POS API
  version: 1.0.0
  description: >-
    The Solya POS backend HTTP surface. Every documented operation is
    agent-ready: it carries an `operationId`, an agent-facing `description`, the
    `pos.*` scopes it enforces (`x-required-permissions`) and an `x-agent-tier`.
    Success responses return the payload as raw JSON; failures return the
    `ErrorResponse` envelope (`{ error: { code, message, statusCode } }`).
servers:
  - url: /
    description: The backend, relative to its deployed origin.
security: []
paths:
  /v1/regions:
    post:
      tags:
        - Network
      summary: Create a region
      description: >-
        Adds a geographic region to the network directory. This is a back-office
        MAINTENANCE operation: the created region immediately becomes a
        selectable grouping stores can be assigned to. The `id` is
        caller-supplied — pick a stable, URL-safe slug (e.g. `reg-bre`), because
        it is the handle every other maintenance verb addresses it by; 409s when
        a region already carries it (a create never overwrites — use the update
        operation instead). `active` is optional and defaults to `true`;
        `storeCount` is optional and defaults to `0` (a fresh region holds no
        stores until one is assigned to it — it is a stored counter, not a live
        join). PERMISSION TRAP (see solya-pos#950): the route guard accepts
        `pos.settings.manage`, but the use-case additionally asserts the kernel
        `config:manage` permission and NO `pos.settings.*` scope maps to it, so
        a principal authenticated by scopes alone clears the guard and then 403s
        inside the use-case — only a session whose role carries `config:manage`
        can actually create.
      operationId: createRegion
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                  minLength: 1
                name:
                  type: string
                  minLength: 1
                code:
                  type: string
                  minLength: 1
                storeCount:
                  default: 0
                  type: integer
                  minimum: 0
                  maximum: 9007199254740991
                active:
                  default: true
                  type: boolean
              required:
                - id
                - name
                - code
              example:
                id: reg-bre
                name: Bretagne
                code: BRE
                storeCount: 0
                active: true
      responses:
        '201':
          description: The created region, exactly as the directory now serves it.
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    minLength: 1
                  name:
                    type: string
                    minLength: 1
                  code:
                    type: string
                    minLength: 1
                  storeCount:
                    type: integer
                    minimum: 0
                    maximum: 9007199254740991
                  active:
                    type: boolean
                required:
                  - id
                  - name
                  - code
                  - storeCount
                  - active
                additionalProperties: false
                description: The created region, exactly as the directory now serves it.
                example:
                  id: reg-bre
                  name: Bretagne
                  code: BRE
                  storeCount: 0
                  active: true
        '400':
          description: >-
            The request failed schema validation; `error.fieldErrors` lists the
            fields.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorResponse'
        '401':
          description: No valid credential was presented — send a bearer token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: The actor is authenticated but lacks the required `pos.*` scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: >-
            The request conflicts with current state (duplicate id or stale
            version).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An unexpected server error — safe to retry idempotent requests.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - bearerAuth: []
components:
  schemas:
    ValidationErrorResponse:
      type: object
      required:
        - error
      additionalProperties: false
      description: >-
        A `VALIDATION_FAILED` envelope carrying the offending fields in
        `fieldErrors`.
      properties:
        error:
          type: object
          required:
            - code
            - message
            - statusCode
          additionalProperties: false
          properties:
            code:
              type: string
              enum:
                - VALIDATION_FAILED
            message:
              type: string
            statusCode:
              type: integer
            fieldErrors:
              type: array
              description: >-
                One entry per rejected field: the field path and why it was
                rejected.
              items:
                type: object
                required:
                  - field
                  - message
                additionalProperties: false
                properties:
                  field:
                    type: string
                    description: Dot-path of the offending field.
                  message:
                    type: string
                    description: Why the field was rejected.
    ErrorResponse:
      type: object
      required:
        - error
      additionalProperties: false
      description: The uniform failure envelope every non-2xx response returns.
      properties:
        error:
          type: object
          required:
            - code
            - message
            - statusCode
          additionalProperties: false
          properties:
            code:
              type: string
              enum:
                - VALIDATION_FAILED
                - UNAUTHORIZED
                - FORBIDDEN
                - NOT_FOUND
                - CONFLICT
                - BUSINESS_RULE_VIOLATION
                - INTERNAL_ERROR
              description: >-
                Machine-readable kernel `ResultCode` — branch on this, not on
                `message`.
            message:
              type: string
              description: >-
                Human-readable explanation. Safe to surface; never leaks server
                internals.
            statusCode:
              type: integer
              description: >-
                The HTTP status, mirrored into the body so a client need not
                read headers.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        `Authorization: Bearer <token>`. Accepts EITHER a Keycloak access token
        (scopes-in-token) OR an opaque POS session token; both resolve to the
        same `pos.*` scope vocabulary the route guards enforce.

````