> ## 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 one coupon under a chosen code

> Mints ONE promo code with the exact `code` string you choose — use this for a named, shareable code (`SAVE10`, `BLACKFRIDAY`); use `POST /v1/coupons/batch` when you need many unguessable one-per-customer codes instead. The `id` is server-minted and returned; the `code` is what the customer presents. `discount` is either `{type:'percentage', rateBps}` in BASIS POINTS (1000 = 10%) or `{type:'fixed', amountCents}` in integer CENTS. `maxRedemptions` caps total uses across all baskets (`1` = single-use), `minBasketCents` is the floor a basket must reach, and the ISO `validFrom`/`validUntil` window is inclusive. NOT idempotent and NOT unique on `code` (solya-pos#944): the `id` is minted server-side per call, so retrying a request whose response you missed creates a SECOND coupon sharing the same customer-facing code, and the till's code-to-coupon lookup then resolves ambiguously between them. There is no 409 to protect you. Retry only after confirming through `GET /v1/coupons` that the first attempt did not land. Creating a code does NOT apply it to anything: it becomes redeemable, and checkout is what consumes a redemption.



## OpenAPI

````yaml /openapi.json post /v1/coupons
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/coupons:
    post:
      tags:
        - Promotions
      summary: Create one coupon under a chosen code
      description: >-
        Mints ONE promo code with the exact `code` string you choose — use this
        for a named, shareable code (`SAVE10`, `BLACKFRIDAY`); use `POST
        /v1/coupons/batch` when you need many unguessable one-per-customer codes
        instead. The `id` is server-minted and returned; the `code` is what the
        customer presents. `discount` is either `{type:'percentage', rateBps}`
        in BASIS POINTS (1000 = 10%) or `{type:'fixed', amountCents}` in integer
        CENTS. `maxRedemptions` caps total uses across all baskets (`1` =
        single-use), `minBasketCents` is the floor a basket must reach, and the
        ISO `validFrom`/`validUntil` window is inclusive. NOT idempotent and NOT
        unique on `code` (solya-pos#944): the `id` is minted server-side per
        call, so retrying a request whose response you missed creates a SECOND
        coupon sharing the same customer-facing code, and the till's
        code-to-coupon lookup then resolves ambiguously between them. There is
        no 409 to protect you. Retry only after confirming through `GET
        /v1/coupons` that the first attempt did not land. Creating a code does
        NOT apply it to anything: it becomes redeemable, and checkout is what
        consumes a redemption.
      operationId: createCoupon
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                code:
                  type: string
                  minLength: 1
                discount:
                  oneOf:
                    - type: object
                      properties:
                        type:
                          type: string
                          enum:
                            - percentage
                        rateBps:
                          type: integer
                          minimum: 0
                          exclusiveMinimum: true
                          maximum: 10000
                      required:
                        - type
                        - rateBps
                    - type: object
                      properties:
                        type:
                          type: string
                          enum:
                            - fixed
                        amountCents:
                          type: integer
                          minimum: 0
                          exclusiveMinimum: true
                          maximum: 9007199254740991
                      required:
                        - type
                        - amountCents
                validFrom:
                  type: string
                  format: date-time
                  pattern: >-
                    ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                validUntil:
                  type: string
                  format: date-time
                  pattern: >-
                    ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                maxRedemptions:
                  type: integer
                  minimum: 0
                  exclusiveMinimum: true
                  maximum: 9007199254740991
                minBasketCents:
                  type: integer
                  minimum: 0
                  maximum: 9007199254740991
              required:
                - code
                - discount
                - validFrom
                - validUntil
                - maxRedemptions
                - minBasketCents
              example:
                code: SAVE10
                discount:
                  type: percentage
                  rateBps: 1000
                validFrom: '2026-01-01T00:00:00.000Z'
                validUntil: '2026-12-31T23:59:59.000Z'
                maxRedemptions: 5
                minBasketCents: 0
      responses:
        '201':
          description: The created coupon, active with a zero redemption count.
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    minLength: 1
                  code:
                    type: string
                    minLength: 1
                  discount:
                    oneOf:
                      - type: object
                        properties:
                          type:
                            type: string
                            enum:
                              - percentage
                          rateBps:
                            type: integer
                            minimum: 0
                            exclusiveMinimum: true
                            maximum: 10000
                        required:
                          - type
                          - rateBps
                        additionalProperties: false
                      - type: object
                        properties:
                          type:
                            type: string
                            enum:
                              - fixed
                          amountCents:
                            type: integer
                            minimum: 0
                            exclusiveMinimum: true
                            maximum: 9007199254740991
                        required:
                          - type
                          - amountCents
                        additionalProperties: false
                  validFrom:
                    type: string
                    format: date-time
                    pattern: >-
                      ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                  validUntil:
                    type: string
                    format: date-time
                    pattern: >-
                      ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                  maxRedemptions:
                    type: integer
                    minimum: 0
                    exclusiveMinimum: true
                    maximum: 9007199254740991
                  minBasketCents:
                    type: integer
                    minimum: 0
                    maximum: 9007199254740991
                  active:
                    type: boolean
                  redemptionCount:
                    type: integer
                    minimum: 0
                    maximum: 9007199254740991
                required:
                  - id
                  - code
                  - discount
                  - validFrom
                  - validUntil
                  - maxRedemptions
                  - minBasketCents
                  - active
                  - redemptionCount
                additionalProperties: false
                description: The created coupon, active with a zero redemption count.
                example:
                  id: cpn-7f3a91c2
                  code: SAVE10
                  discount:
                    type: percentage
                    rateBps: 1000
                  validFrom: '2026-01-01T00:00:00.000Z'
                  validUntil: '2026-12-31T23:59:59.000Z'
                  maxRedemptions: 5
                  minBasketCents: 0
                  active: true
                  redemptionCount: 0
        '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'
        '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.

````