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

# Advance an order

> Advances an order along its lifecycle: `fulfil` an `accepted` order to `fulfilled`, or `cancel` a `captured` / `accepted` order. The order `id` comes from the PATH — a body `orderId` is ignored. Failure conditions: 400 on a malformed body; 404 for an unknown order; 422 on an illegal transition (e.g. fulfilling a still-`captured`, unrouted order).



## OpenAPI

````yaml /openapi.json post /v1/orders/{id}/advance
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/orders/{id}/advance:
    post:
      tags:
        - Orders
      summary: Advance an order
      description: >-
        Advances an order along its lifecycle: `fulfil` an `accepted` order to
        `fulfilled`, or `cancel` a `captured` / `accepted` order. The order `id`
        comes from the PATH — a body `orderId` is ignored. Failure conditions:
        400 on a malformed body; 404 for an unknown order; 422 on an illegal
        transition (e.g. fulfilling a still-`captured`, unrouted order).
      operationId: advanceOrder
      parameters:
        - schema:
            type: string
            minLength: 1
          in: path
          name: id
          required: true
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                action:
                  type: string
                  enum:
                    - fulfil
                    - cancel
              required:
                - action
              example:
                action: fulfil
      responses:
        '200':
          description: The advanced order at its new lifecycle status.
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  channel:
                    type: string
                    enum:
                      - web
                      - marketplace
                      - mobile-app
                      - in-store
                  deliveryMode:
                    type: string
                    enum:
                      - click-and-collect
                      - ship-from-store
                      - endless-aisle
                  customer:
                    type: object
                    properties:
                      customerId:
                        type: string
                        minLength: 1
                      displayName:
                        type: string
                        minLength: 1
                    required:
                      - customerId
                    additionalProperties: false
                  lines:
                    type: array
                    items:
                      type: object
                      properties:
                        skuId:
                          type: string
                          pattern: ^[0-9a-f]{64}$
                        quantity:
                          type: integer
                          minimum: 0
                          exclusiveMinimum: true
                          maximum: 9007199254740991
                        unitPriceCents:
                          type: integer
                          minimum: 0
                          maximum: 9007199254740991
                      required:
                        - skuId
                        - quantity
                        - unitPriceCents
                      additionalProperties: false
                  status:
                    type: string
                    enum:
                      - captured
                      - accepted
                      - fulfilled
                      - cancelled
                      - rejected
                  fulfillingStoreId:
                    nullable: true
                    type: string
                  actorId:
                    type: string
                  capturedAt:
                    type: string
                required:
                  - id
                  - channel
                  - deliveryMode
                  - customer
                  - lines
                  - status
                  - fulfillingStoreId
                  - actorId
                  - capturedAt
                additionalProperties: false
                description: The advanced order at its new lifecycle status.
                example:
                  id: WEB-24810
                  channel: web
                  deliveryMode: click-and-collect
                  customer:
                    customerId: cust-24810
                    displayName: Camille Laurent
                  lines:
                    - skuId: >-
                        f139995b359e2702f33b391acb3d42a419197a7b2c09d04c1fe6d97ecefe4feb
                      quantity: 1
                      unitPriceCents: 11900
                  status: fulfilled
                  fulfillingStoreId: shop-lyon
                  actorId: seller-1
                  capturedAt: '2026-07-28T10:00:00.000Z'
        '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'
        '404':
          description: No resource matches the addressed identifier.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: The request is well-formed but violates a domain rule.
          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.

````