> ## Documentation Index > Fetch the complete documentation index at: https://docs.solya.app/llms.txt > Use this file to discover all available pages before exploring further. # List AI recommendations enriched with shopName, brandId, collectionId, and sizeIds for direct plan creation > BFF-style aggregate list endpoint that extends the base /intelligence/decision-vectors response with plan-context enrichments: shopName (human-readable label), and sizeIds (available size taxonomy IDs for that variant in that shop, from the stock snapshot layer). brandId and collectionId are already present on the base decision vector. An agent can use this endpoint to discover what to restock/rebalance/markdown and immediately construct a plan — variantId, shopId, brandId, collectionId, and sizeIds are all available in one call. sizeIds is the list of taxonomy size IDs with stock in the specific variant/shop pair; pass each as sizeId when adding items to an inventory plan. Filter by domain, variantId, or shopId. Per-shop access scoping is enforced. Returns the flat envelope: { success, data: [...], meta: { total, page, pageSize } }. ## OpenAPI ````yaml /openapi.json get /api/intelligence/recommendations/full openapi: 3.0.3 info: contact: email: dev@solya.io name: Solya Team description: >- # Solya API Solya is a fashion retail inventory management platform for buyers and merchandisers. This API exposes all capabilities needed to manage the inventory lifecycle: catalog browsing, risk detection, plan creation (Restock / Markdown / Rebalance), analytics queries, and data-platform operations. ## Authentication Three authentication schemes are supported: | Scheme | Header | Use case | |---|---|---| | **BearerAuth** | `Authorization: Bearer ` | Human users via the Solya web app (NextAuth session) | | **InternalBearerAuth** | `Authorization: Bearer ` | Internal jobs and cron tasks (static token per service) | | **ServiceAccountToken** | `Authorization: Bearer solya_sa_*` | LLM agents and programmatic clients (opaque token created via Settings) | All endpoints except `GET /api/health` require one of the above. See [Agent authentication guide](/docs/api/AGENT_AUTH.md) for the Service Account token flow. ## Response format Every endpoint returns an `ActionResponse` envelope: **Success:** ```json { "success": true, "data": { ... } } ``` **Error:** ```json { "success": false, "errorCode": "PLAN_NOT_FOUND", "error": "Human-readable message" } ``` The `errorCode` is a stable machine-readable string (see common error codes below). The `error` field is for human display only and may change between versions. ## Pagination List endpoints accept `page` (1-indexed, default 1) and `pageSize` (default 20, max 100). Responses include a `total` field with the total number of matching records. ``` GET /api/shops?page=2&pageSize=50 → { "success": true, "data": { "data": [...], "total": 120, "page": 2, "pageSize": 50 } } ``` ## Common error codes | HTTP status | errorCode | Meaning | |---|---|---| | 401 | `UNAUTHORIZED` | Token missing, expired, or invalid | | 403 | `FORBIDDEN` | Token valid but lacks the required permission or scope | | 404 | `NOT_FOUND` | Requested resource does not exist | | 409 | `BUSINESS_RULE_VIOLATION` | Business rule blocked the operation (see response details) | | 422 | `VALIDATION_ERROR` | Input failed Zod schema validation | | 429 | `RATE_LIMIT_EXCEEDED` | Rate limit hit (100 req/min per token) | | 500 | `INTERNAL_ERROR` | Unexpected server error | ## Rate limiting Default limit: **100 requests per minute** per authentication token. When the limit is exceeded the API returns HTTP 429 with `errorCode: "RATE_LIMIT_EXCEEDED"`. Agents should implement exponential back-off and respect the `Retry-After` header when present. ## Further reading See the [Agent guide](/docs/api/AGENT_GUIDE.md) for end-to-end workflows, call-chaining patterns, and anti-patterns to avoid. license: name: Proprietary url: https://solya.app/terms title: Solya API version: 1.0.0 x-ai-context: >- Solya is a fashion retail inventory management platform for retailers. Core concepts: - **Organization** (tenant): every endpoint is scoped by organizationId extracted from the token. - **Shop**: a physical point of sale belonging to the organization. - **ProductVariant**: a SKU — a product variant with size and color. - **Plan**: a Restock / Markdown / Rebalance grouping PlanItems to orchestrate inventory decisions. Typical agent workflow: 1. List the organization's shops — GET /api/shops 2. List variants at risk (stockout, overstock, slow-mover) — GET /api/inventory/risks 3. Create a plan — POST /api/restock-plans, /api/markdown-plans, or /api/rebalance-plans 4. Add items to the plan — POST /api/restock-plans/{planId}/items (or equivalent for other plan types) 5. Validate / submit the plan via the corresponding action endpoint Auth: use a Service Account token (see /docs/api/AGENT_AUTH.md). The token is created by an org admin via Settings and has the format solya_sa_<43 base64url chars>. All responses follow the ActionResponse envelope: - Success: { success: true, data: T } - Error: { success: false, errorCode: string, error: string } Use the errorCode field to drive retry logic or surface user-facing messages. servers: - description: Current environment url: https://app.solya.app security: - BearerAuth: [] tags: - description: >- Health and liveness endpoints. Use GET /api/health to verify the service is reachable before starting a workflow. No authentication required. name: System - description: >- Physical points of sale belonging to the organization. Supports listing, creation, update, and deactivation. Shops are referenced by all Plan types (Restock, Markdown, Rebalance) and by every inventory analytics endpoint. name: Shops - description: >- Product brands configured for the organization. Brands are used to filter catalog queries and analytics. Supports CRUD operations. name: Brands - description: >- The product catalog: style-level entities grouping one or more ProductVariants. Supports listing with rich filter options (brand, family, gender, season) and individual retrieval. name: Products - description: >- SKU-level product entities (a Product with a specific size and color). Variants are the atomic unit referenced by PlanItems, inventory risk alerts, and analytics queries. name: Variants - description: >- Curated product groupings used for seasonal assortment management. A Collection groups Variants and can be referenced when creating or filtering Plans. name: Collections - description: >- Current on-hand stock records per Variant per Shop. Used to understand the live inventory position before creating a restock or rebalance plan. name: Inventory Items - description: >- AI-detected inventory risk signals: stockout risk, overstock, slow-movers, and displaced stock. The primary input for agents building recommendation-driven plans. Supports filtering by shop, brand, risk type, and severity. name: Inventory Risks - description: >- AI-generated restock quantity recommendations per Variant per Shop. Consumed by agents to pre-populate Restock plan items. Based on sales velocity, stock coverage, and lead time. name: Recommendations - Restock - description: >- AI-generated markdown discount recommendations for slow-moving or overstock Variants. Consumed by agents to pre-populate Markdown plan items. Includes recommended discount rate and expected clearance timeline. name: Recommendations - Markdown - description: >- AI-generated stock transfer recommendations between shops to balance supply with demand. Consumed by agents to pre-populate Rebalance plan items. name: Recommendations - Rebalance - description: >- Historical sales transaction lines at the Variant + Shop + date level. Used by analytics and by the AI recommendation engine. Supports date-range and multi-dimensional filtering. name: Sales Lines - description: >- Purchase order lines tracking inbound stock from suppliers. Combined with stock and sales data to compute forward coverage and restock needs. name: Order Lines - description: >- Inventory movement records (transfers, returns, adjustments). Used to reconcile the stock ledger and audit stock changes between shops. name: Movement Lines - description: >- Running stock balance log per Variant per Shop. Provides a point-in-time view of stock levels and is the source of truth for coverage computations. name: Stock Ledger - description: >- Rebalance plans orchestrate stock transfers between shops. Supports creating plans, adding Variant items with proposed transfer quantities, reviewing, and submitting. Business rules are evaluated on item addition. name: Plans - Rebalance - description: >- Restock plans (order plans) orchestrate purchase orders to suppliers. Supports creating sessions, adding Variant items with proposed order quantities, reviewing totals, and submitting. Integrates with the order plan workflow. name: Plans - Restock - description: >- Autocomplete and typeahead search endpoints for catalog dimensions: products, brands, shops, sizes, families, genders, and more. Designed for fast UI search (low latency, small result sets). Use catalog list endpoints for full paginated access. name: Search - description: >- Manage file-based data ingestion: upload CSV/XLSX files, poll ingestion status, list historical ingestion runs, and trigger batch reprocessing. Used by the data team to import POS data and catalog updates. name: Data Platform - File Ingestions - description: >- Organization-level configuration for the data platform: data source connections, POS integration settings, and ingestion schedules. Requires elevated permissions. name: Data Platform - Settings - description: >- Configuration of automated inventory alerts: threshold-based rules that monitor stock levels, sales velocity, and coverage gaps. Supports CRUD for alert definitions; alert evaluation runs are triggered by the data platform scheduler. name: Data Platform - Alerts - description: >- Endpoints designed for LLM agents and programmatic clients. These endpoints expose agent-optimized response shapes. Authenticate with a Service Account token (format: solya_sa_*) created via Settings → API Tokens. name: Agent externalDocs: description: >- Complete guide for LLM agents and programmatic clients: authentication, pagination patterns, ActionResponse interpretation, call chaining, business rule error handling. url: /docs/api/AGENT_GUIDE.md paths: /api/intelligence/recommendations/full: get: tags: - Intelligence summary: >- List AI recommendations enriched with shopName, brandId, collectionId, and sizeIds for direct plan creation description: >- BFF-style aggregate list endpoint that extends the base /intelligence/decision-vectors response with plan-context enrichments: shopName (human-readable label), and sizeIds (available size taxonomy IDs for that variant in that shop, from the stock snapshot layer). brandId and collectionId are already present on the base decision vector. An agent can use this endpoint to discover what to restock/rebalance/markdown and immediately construct a plan — variantId, shopId, brandId, collectionId, and sizeIds are all available in one call. sizeIds is the list of taxonomy size IDs with stock in the specific variant/shop pair; pass each as sizeId when adding items to an inventory plan. Filter by domain, variantId, or shopId. Per-shop access scoping is enforced. Returns the flat envelope: { success, data: [...], meta: { total, page, pageSize } }. operationId: listRecommendationsFull parameters: - in: query name: page required: false schema: default: 1 description: 'Page number, 1-indexed (default: 1)' maximum: 9007199254740991 minimum: 1 type: integer - in: query name: pageSize required: false schema: default: 20 description: 'Number of items per page, max 100 (default: 20)' maximum: 100 minimum: 1 type: integer - in: query name: variantId required: false schema: description: Filter by variant ID type: string - in: query name: shopId required: false schema: description: Filter by shop ID type: string - in: query name: domain required: false schema: description: 'Filter by decision domain: restock, rebalance, or markdown' enum: - restock - rebalance - markdown type: string responses: '200': content: application/json: examples: sample: summary: >- Two enriched recommendations with shop labels and available sizes value: data: - allowedActions: - restock brandId: brand-uuid-adidas collectionId: coll-uuid-fw25 createdAt: '2025-09-15T06:00:00.000Z' deficit_units: 12 domain: restock forbiddenActions: [] scores: deficit_score: null overstock_risk: 0.05 restock_urgency: 0.91 stockout_risk: 0.85 surplus_score: null transfer_urgency: null shopId: shop-uuid-paris shopName: Paris Flagship sizeIds: - size-uuid-40 - size-uuid-41 - size-uuid-42 snapshotDate: '2025-09-15' surplus_units: null updatedAt: '2025-09-15T06:00:00.000Z' variantId: var-uuid-001 - allowedActions: - rebalance brandId: brand-uuid-nike collectionId: null createdAt: '2025-09-15T06:00:00.000Z' deficit_units: null domain: rebalance forbiddenActions: [] scores: deficit_score: 0.2 overstock_risk: null restock_urgency: null stockout_risk: null surplus_score: 0.8 transfer_urgency: 0.75 shopId: shop-uuid-lyon shopName: Lyon Bellecour sizeIds: - size-uuid-m - size-uuid-l snapshotDate: '2025-09-15' surplus_units: 8 updatedAt: '2025-09-15T06:00:00.000Z' variantId: var-uuid-002 meta: page: 1 pageSize: 20 total: 1240 success: true schema: properties: data: description: Page of items items: properties: allowedActions: description: List of allowed actions for this vector items: type: string type: array brandId: description: >- Brand identifier of the variant (null when not available in the gold layer). Pass directly to POST /restock-plans as brandId to create a plan without name matching. nullable: true type: string collectionId: description: >- Collection identifier of the variant (null when not available in the gold layer). Pass directly to POST /restock-plans as collectionId to create a plan without name matching. nullable: true type: string createdAt: description: ISO-8601 creation timestamp type: string deficit_units: description: >- Number of units below the target stock level (restock/rebalance domains only). Positive value indicates a shortfall that may warrant a restock or inbound rebalance action. Null for markdown and other domains. nullable: true type: number domain: description: 'Decision domain: restock, rebalance, or markdown' enum: - restock - rebalance - markdown type: string forbiddenActions: description: List of forbidden actions for this vector items: type: string type: array scores: description: JSONB scores object from the decision vector properties: deficit_score: description: Deficit score in [0,1] nullable: true type: number overstock_risk: description: Overstock risk score in [0,1] nullable: true type: number restock_urgency: description: Restock urgency score in [0,1] nullable: true type: number stockout_risk: description: Stockout risk score in [0,1] nullable: true type: number surplus_score: description: Surplus score in [0,1] nullable: true type: number transfer_urgency: description: Transfer urgency score in [0,1] nullable: true type: number required: - restock_urgency - stockout_risk - overstock_risk - surplus_score - deficit_score - transfer_urgency type: object shopId: description: Shop identifier type: string shopName: description: >- Human-readable shop name, resolved from the shops directory nullable: true type: string sizeIds: description: >- Size taxonomy IDs available for this variant in this specific shop, resolved from the stock snapshot layer. Pass each sizeId alongside variantId when adding items to an inventory plan. Empty when no stock snapshot is found for this variant/shop combination. items: type: string type: array snapshotDate: description: ISO-8601 date of the snapshot, e.g. 2025-09-15 type: string surplus_units: description: >- Number of units above the target stock level (rebalance domain only). Positive value indicates excess stock that may warrant an outbound rebalance action. Null for restock, markdown, and other domains. nullable: true type: number updatedAt: description: ISO-8601 last update timestamp type: string variantId: description: Variant identifier type: string required: - variantId - shopId - snapshotDate - domain - scores - allowedActions - forbiddenActions - createdAt - updatedAt - brandId - collectionId - shopName - sizeIds type: object type: array meta: description: Pagination metadata properties: page: description: Current page number (1-indexed) type: number pageSize: description: Number of items per page type: number total: description: Total number of items matching the filters type: number required: - total - page - pageSize type: object success: enum: - true type: boolean required: - success - data - meta type: object description: Successful response '400': description: Validation error '401': description: Unauthorized '500': description: Internal server error security: - BearerAuth: [] components: securitySchemes: BearerAuth: bearerFormat: JWT description: >- User session token issued by NextAuth. For human users accessing Solya via the web application. scheme: bearer type: http ````