> ## 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. # Get a promotion's full rule definition > Resolves ONE automatic promotion's COMPLETE rule: the reward mechanics the six-field directory projection omits (`skuId` / `minQuantity` / `reward` for a `threshold`, `buySkuId` / `buyQuantity` / `getSkuId` / `getQuantity` / `getDiscountBps` for a `bogo`, `components` / `bundlePriceCents` for a `bundle`) plus its inclusive validity window. This is the READ half of a read-modify-write on a live rule: fetch it here, change only the field you were asked to change, and send the WHOLE object back through `PUT /v1/promotions/{id}` — never reconstruct mechanics from memory, because the PUT is a full replace. 404s when the promotion carries no configured rule: a directory row seeded without one is browsable but not editable, and `PUT /v1/promotions/{id}` plus `POST /v1/promotions/{id}/deactivate` 404 on it for the same reason. ## OpenAPI ````yaml /openapi.json get /v1/promotions/{id}/rule 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/promotions/{id}/rule: get: tags: - Promotions summary: Get a promotion's full rule definition description: >- Resolves ONE automatic promotion's COMPLETE rule: the reward mechanics the six-field directory projection omits (`skuId` / `minQuantity` / `reward` for a `threshold`, `buySkuId` / `buyQuantity` / `getSkuId` / `getQuantity` / `getDiscountBps` for a `bogo`, `components` / `bundlePriceCents` for a `bundle`) plus its inclusive validity window. This is the READ half of a read-modify-write on a live rule: fetch it here, change only the field you were asked to change, and send the WHOLE object back through `PUT /v1/promotions/{id}` — never reconstruct mechanics from memory, because the PUT is a full replace. 404s when the promotion carries no configured rule: a directory row seeded without one is browsable but not editable, and `PUT /v1/promotions/{id}` plus `POST /v1/promotions/{id}/deactivate` 404 on it for the same reason. operationId: getPromotionRule parameters: - schema: type: string minLength: 1 in: path name: id required: true responses: '200': description: The full promotion rule, its validity window as ISO instants. content: application/json: schema: oneOf: - type: object properties: id: type: string minLength: 1 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|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$ 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|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$ type: type: string enum: - bogo buySkuId: type: string pattern: ^[0-9a-f]{64}$ buyQuantity: type: integer minimum: 0 exclusiveMinimum: true maximum: 9007199254740991 getSkuId: type: string pattern: ^[0-9a-f]{64}$ getQuantity: type: integer minimum: 0 exclusiveMinimum: true maximum: 9007199254740991 getDiscountBps: type: integer minimum: 1 maximum: 10000 required: - id - validFrom - validUntil - type - buySkuId - buyQuantity - getSkuId - getQuantity - getDiscountBps additionalProperties: false - type: object properties: id: type: string minLength: 1 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|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$ 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|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$ type: type: string enum: - threshold skuId: type: string pattern: ^[0-9a-f]{64}$ minQuantity: type: integer minimum: 0 exclusiveMinimum: true maximum: 9007199254740991 reward: oneOf: - type: object properties: basis: type: string enum: - percent percentBps: type: integer minimum: 1 maximum: 10000 required: - basis - percentBps additionalProperties: false - type: object properties: basis: type: string enum: - amount amountCents: type: integer minimum: 0 exclusiveMinimum: true maximum: 9007199254740991 required: - basis - amountCents additionalProperties: false required: - id - validFrom - validUntil - type - skuId - minQuantity - reward additionalProperties: false - type: object properties: id: type: string minLength: 1 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|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$ 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|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$ type: type: string enum: - bundle components: minItems: 2 type: array items: type: object properties: skuId: type: string pattern: ^[0-9a-f]{64}$ quantity: type: integer minimum: 0 exclusiveMinimum: true maximum: 9007199254740991 required: - skuId - quantity additionalProperties: false bundlePriceCents: type: integer minimum: 0 maximum: 9007199254740991 required: - id - validFrom - validUntil - type - components - bundlePriceCents additionalProperties: false description: The full promotion rule, its validity window as ISO instants. example: id: promo-threshold-tshirt type: threshold skuId: >- 2f0a30932a471a86d885382399c476bc17fde6e613c42a73e2cf6a760fe4f774 minQuantity: 2 reward: basis: percent percentBps: 1000 validFrom: '2026-01-01T00:00:00.000Z' validUntil: '2026-12-31T00: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' '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. ````