> ## 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. # List the coupon catalogue (code promo) > Returns EVERY authored promo code — active and deactivated alike — each with its terms and its `redemptionCount` from the ledger. This is the operation to reach for when you need a coupon's `id` (codes are what customers type, ids are what `POST /v1/coupons/{id}/deactivate` takes), when you want to know how much of a campaign has been consumed. It is PAGINATED: page with `page`/`pageSize` (max 100) until `page` reaches `pageCount`. Do NOT treat it as a uniqueness check before minting a code: nothing enforces uniqueness on `code`, and listing then creating is a race, not a safeguard (solya-pos#944). It does NOT tell you whether a code applies to a given basket — use `POST /v1/coupons/validate` for that — and it does not list automatic promotions, which live at `GET /v1/promotions`. ## OpenAPI ````yaml /openapi.json get /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: get: tags: - Promotions summary: List the coupon catalogue (code promo) description: >- Returns EVERY authored promo code — active and deactivated alike — each with its terms and its `redemptionCount` from the ledger. This is the operation to reach for when you need a coupon's `id` (codes are what customers type, ids are what `POST /v1/coupons/{id}/deactivate` takes), when you want to know how much of a campaign has been consumed. It is PAGINATED: page with `page`/`pageSize` (max 100) until `page` reaches `pageCount`. Do NOT treat it as a uniqueness check before minting a code: nothing enforces uniqueness on `code`, and listing then creating is a race, not a safeguard (solya-pos#944). It does NOT tell you whether a code applies to a given basket — use `POST /v1/coupons/validate` for that — and it does not list automatic promotions, which live at `GET /v1/promotions`. operationId: listCoupons parameters: - schema: default: 1 type: integer minimum: 1 maximum: 9007199254740991 in: query name: page required: false description: 1-based page index to return. Defaults to 1. - schema: default: 20 type: integer minimum: 1 maximum: 100 in: query name: pageSize required: false description: Rows per page, 1..100. Defaults to 20. responses: '200': description: >- A page of coupons, each with its `active` flag and ledger redemption count. content: application/json: schema: type: object properties: items: type: array items: 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 rows on this page, in the query's sort order. total: type: integer minimum: 0 maximum: 9007199254740991 description: >- Total rows matching the filter across ALL pages, not just this one. page: type: integer minimum: 0 exclusiveMinimum: true maximum: 9007199254740991 description: The 1-based page number served. pageSize: type: integer minimum: 0 exclusiveMinimum: true maximum: 9007199254740991 description: Rows requested per page. pageCount: type: integer minimum: 0 maximum: 9007199254740991 description: >- Total number of pages; stop walking when `page` reaches it. required: - items - total - page - pageSize - pageCount additionalProperties: false description: >- A page of coupons, each with its `active` flag and ledger redemption count. example: items: - 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 total: 1 page: 1 pageSize: 20 pageCount: 1 '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 `. 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. ````