> ## 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. # Open a plan > Opens a plan in `DRAFT`, always — nothing is ever created already decided. The body is narrowed by `family`: the four supplier families REQUIRE `supplierId` (an order with no supplier cannot be issued, costed, or checked against a negotiated term), a rebalance requires two DIFFERENT shops, a markdown requires the operation's name and its dates — with `endsAt` on or after `startsAt`, a cross-field rule JSON Schema cannot express, so a period running backwards 400s on `endsAt` rather than being visible in this spec. `reference` is what will be quoted in an email to a supplier and is unique across the network. The family and the counterparty are frozen from here on: if either is wrong, cancel the plan and open another. ## OpenAPI ````yaml /openapi.json post /v1/plans 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/plans: post: tags: - Procurement summary: Open a plan description: >- Opens a plan in `DRAFT`, always — nothing is ever created already decided. The body is narrowed by `family`: the four supplier families REQUIRE `supplierId` (an order with no supplier cannot be issued, costed, or checked against a negotiated term), a rebalance requires two DIFFERENT shops, a markdown requires the operation's name and its dates — with `endsAt` on or after `startsAt`, a cross-field rule JSON Schema cannot express, so a period running backwards 400s on `endsAt` rather than being visible in this spec. `reference` is what will be quoted in an email to a supplier and is unique across the network. The family and the counterparty are frozen from here on: if either is wrong, cancel the plan and open another. operationId: createPlan requestBody: required: true content: application/json: schema: oneOf: - type: object properties: id: type: string minLength: 1 reference: type: string minLength: 1 maxLength: 64 name: type: string minLength: 1 maxLength: 255 notes: default: null nullable: true type: string maxLength: 10000 ruleGroupId: default: null nullable: true type: string minLength: 1 deadline: default: null nullable: true 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))$ family: type: string enum: - restock - pre_season_order - supplier_return - supplier_exchange supplierId: type: string minLength: 1 storeId: default: null nullable: true type: string minLength: 1 required: - id - reference - name - family - supplierId - type: object properties: id: type: string minLength: 1 reference: type: string minLength: 1 maxLength: 64 name: type: string minLength: 1 maxLength: 255 notes: default: null nullable: true type: string maxLength: 10000 ruleGroupId: default: null nullable: true type: string minLength: 1 deadline: default: null nullable: true 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))$ family: type: string enum: - rebalance outgoingStoreId: type: string minLength: 1 incomingStoreId: type: string minLength: 1 required: - id - reference - name - family - outgoingStoreId - incomingStoreId - type: object properties: id: type: string minLength: 1 reference: type: string minLength: 1 maxLength: 64 name: type: string minLength: 1 maxLength: 255 notes: default: null nullable: true type: string maxLength: 10000 ruleGroupId: default: null nullable: true type: string minLength: 1 deadline: default: null nullable: true 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))$ family: type: string enum: - markdown eventName: type: string minLength: 1 maxLength: 255 startsAt: 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))$ endsAt: 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))$ required: - id - reference - name - family - eventName - startsAt - endsAt example: id: plan-restock-aigle-33 family: restock reference: RSA-26-0143 name: Réassort Aigle — semaine 33 supplierId: sup-aigle deadline: '2026-08-21T16:00:00.000Z' responses: '201': description: The plan as persisted, in `DRAFT` at version 1. content: application/json: schema: allOf: - oneOf: - type: object properties: id: type: string minLength: 1 reference: type: string minLength: 1 maxLength: 64 name: type: string minLength: 1 maxLength: 255 notes: nullable: true type: string maxLength: 10000 status: type: string enum: - DRAFT - VALIDATED - SENT - RECEIVED - PROPOSED - AGREED - IN_TRANSIT - SETTLED - CREDITED - CLOSED - CANCELLED ruleGroupId: nullable: true type: string minLength: 1 deadline: nullable: true 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))$ issuedDocument: nullable: true type: object properties: kind: type: string enum: - purchase_order - transfer - return_to_vendor - markdown_schedule id: type: string minLength: 1 required: - kind - id additionalProperties: false version: type: integer minimum: 0 exclusiveMinimum: true maximum: 9007199254740991 family: type: string enum: - restock - pre_season_order - supplier_return - supplier_exchange supplierId: type: string minLength: 1 storeId: nullable: true type: string minLength: 1 required: - id - reference - name - notes - status - ruleGroupId - deadline - issuedDocument - version - family - supplierId - storeId additionalProperties: false - type: object properties: id: type: string minLength: 1 reference: type: string minLength: 1 maxLength: 64 name: type: string minLength: 1 maxLength: 255 notes: nullable: true type: string maxLength: 10000 status: type: string enum: - DRAFT - VALIDATED - SENT - RECEIVED - PROPOSED - AGREED - IN_TRANSIT - SETTLED - CREDITED - CLOSED - CANCELLED ruleGroupId: nullable: true type: string minLength: 1 deadline: nullable: true 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))$ issuedDocument: nullable: true type: object properties: kind: type: string enum: - purchase_order - transfer - return_to_vendor - markdown_schedule id: type: string minLength: 1 required: - kind - id additionalProperties: false version: type: integer minimum: 0 exclusiveMinimum: true maximum: 9007199254740991 family: type: string enum: - rebalance outgoingStoreId: type: string minLength: 1 incomingStoreId: type: string minLength: 1 required: - id - reference - name - notes - status - ruleGroupId - deadline - issuedDocument - version - family - outgoingStoreId - incomingStoreId additionalProperties: false - type: object properties: id: type: string minLength: 1 reference: type: string minLength: 1 maxLength: 64 name: type: string minLength: 1 maxLength: 255 notes: nullable: true type: string maxLength: 10000 status: type: string enum: - DRAFT - VALIDATED - SENT - RECEIVED - PROPOSED - AGREED - IN_TRANSIT - SETTLED - CREDITED - CLOSED - CANCELLED ruleGroupId: nullable: true type: string minLength: 1 deadline: nullable: true 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))$ issuedDocument: nullable: true type: object properties: kind: type: string enum: - purchase_order - transfer - return_to_vendor - markdown_schedule id: type: string minLength: 1 required: - kind - id additionalProperties: false version: type: integer minimum: 0 exclusiveMinimum: true maximum: 9007199254740991 family: type: string enum: - markdown eventName: type: string minLength: 1 maxLength: 255 startsAt: 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))$ endsAt: 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))$ required: - id - reference - name - notes - status - ruleGroupId - deadline - issuedDocument - version - family - eventName - startsAt - endsAt additionalProperties: false - type: object properties: version: type: integer minimum: 0 exclusiveMinimum: true maximum: 9007199254740991 required: - version additionalProperties: false description: The plan as persisted, in `DRAFT` at version 1. example: id: plan-restock-aigle-32 family: restock reference: RSA-26-0142 name: Réassort Aigle — semaine 32 notes: null status: DRAFT ruleGroupId: null deadline: '2026-08-14T16:00:00.000Z' supplierId: sup-aigle storeId: null version: 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' '409': description: >- The request conflicts with current state (duplicate id or stale version). 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 `. 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. ````