Akeda Stock reorder rules API

openapi: 3.2.0
info:
  title: Akeda ERP Client Stock reorder rules API
  version: 0.21.0-core-public
  summary: Проверяемый публичный контракт Go API Akeda ERP
  license:
    name: Proprietary
    identifier: LicenseRef-Akeda-Proprietary
  description: 'Этот контракт описывает API Akeda ERP. Полный исходный файл используют

    проверки живых Go-маршрутов, внутренние клиенты и реестр MCP. Скачиваемый

    клиентский контракт в `/docs` содержит только отобранные внешние методы;

    административные методы кабинета показаны отдельно после входа, а

    платформенные операторские методы остаются во внутреннем источнике.

    Стадия `public` означает обещание совместимости; `preview` допускает

    изменение формы. Аудитория, стадия и `security` — разные признаки:

    наличие метода в полном файле само по себе не выдаёт вызывающему право.

    Сервер отдельно проверяет тип токена, кабинет, scope и права на запись.

    Актуальные числа покрытия берите из генерируемой карты маршрутов и

    каталога покрытия, а не из описательного текста.'
servers:
- url: https://erp.akeda.ru
  description: PROD
security:
- erpUserToken: []
- tenantApiKey: []
- mcpOAuth:
  - akeda:delegate
tags:
- name: Stock reorder rules
  description: Модуль stock (склад) — правила пополнения
paths:
  /api/v1/stock/reorder-rules:
    get:
      tags:
      - Stock reorder rules
      operationId: stockListReorderRules
      summary: Получить правила пополнения запаса
      description: Отдаются только правила юрлиц, доступных текущему пользователю, а правила без юрлица — пользователю с доступом ко всем юрлицам; count — общее число подходящих правил, а не размер страницы.
      x-akeda-module: stock
      x-akeda-release-stage: preview
      x-akeda-audience: external
      x-akeda-permission: stock:read
      security:
      - erpUserToken: []
      - tenantApiKey: []
      - mcpOAuth:
        - akeda:delegate
      - installationToken: []
      parameters:
      - $ref: '#/components/parameters/TenantHeader'
      - name: business_id
        in: query
        schema:
          $ref: '#/components/schemas/UUID'
      - name: company_id
        in: query
        schema:
          $ref: '#/components/schemas/UUID'
      - name: warehouse_id
        in: query
        schema:
          $ref: '#/components/schemas/UUID'
      - name: product_id
        in: query
        schema:
          $ref: '#/components/schemas/UUID'
      - name: supplier_id
        in: query
        description: 'Предпочтительный поставщик правила: отбор столбца «Поставщик»'
        schema:
          $ref: '#/components/schemas/UUID'
      - name: q
        in: query
        description: Поиск по товару, бизнесу, юрлицу и складу
        schema:
          type: string
      - name: status
        in: query
        schema:
          type: string
          enum:
          - active
          - inactive
      - name: min_from
        in: query
        description: 'Отбор столбца «Минимум»: от, включительно'
        schema:
          type: string
          pattern: ^-?[0-9]+([.,][0-9]+)?$
      - name: min_to
        in: query
        description: 'Отбор столбца «Минимум»: до, включительно'
        schema:
          type: string
          pattern: ^-?[0-9]+([.,][0-9]+)?$
      - name: max_from
        in: query
        description: 'Отбор столбца «Максимум»: от; правило без максимума не подходит'
        schema:
          type: string
          pattern: ^-?[0-9]+([.,][0-9]+)?$
      - name: max_to
        in: query
        description: 'Отбор столбца «Максимум»: до; правило без максимума не подходит'
        schema:
          type: string
          pattern: ^-?[0-9]+([.,][0-9]+)?$
      - name: multiple_from
        in: query
        description: 'Отбор столбца «Кратность»: от; правило без кратности не подходит'
        schema:
          type: string
          pattern: ^-?[0-9]+([.,][0-9]+)?$
      - name: multiple_to
        in: query
        description: 'Отбор столбца «Кратность»: до; правило без кратности не подходит'
        schema:
          type: string
          pattern: ^-?[0-9]+([.,][0-9]+)?$
      - name: lead_from
        in: query
        description: 'Отбор столбца «Срок поставки», дней: от, включительно'
        schema:
          type: string
          pattern: ^-?[0-9]+([.,][0-9]+)?$
      - name: lead_to
        in: query
        description: 'Отбор столбца «Срок поставки», дней: до, включительно'
        schema:
          type: string
          pattern: ^-?[0-9]+([.,][0-9]+)?$
      - name: sort
        in: query
        schema:
          type: string
          enum:
          - business
          - company
          - product
          - warehouse
          - min_qty
          - updated_at
          default: updated_at
      - name: direction
        in: query
        schema:
          type: string
          enum:
          - asc
          - desc
          default: desc
      - name: limit
        in: query
        schema:
          type: integer
          minimum: 1
          maximum: 500
          default: 50
      - name: offset
        in: query
        schema:
          type: integer
          minimum: 0
          default: 0
      responses:
        '200':
          description: Страница правил пополнения
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StockReorderRulePage'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalError'
    put:
      tags:
      - Stock reorder rules
      operationId: stockSaveReorderRule
      summary: Завести или переписать правило пополнения по ключу
      description: 'Заведение-или-перезапись по естественному ключу «бизнес + юрлицо + товар + склад»: если правило с таким ключом уже есть, оно переписывается целиком, иначе заводится новое. Правило принадлежит бизнесу, юрлицо — необязательный разрез, как у остатка: без company_id правило действует на товар бизнеса без юрлица и требует business_id, а с company_id бизнес выводится от юрлица (названный business_id обязан с ним совпасть). Правило без warehouse_id — отдельное правило «на все склады», оно не конфликтует со складским. Идентификатор правила здесь не передаётся и не выбирается: он приходит в ответе. Тело задаёт все поля сразу, пропущенное необязательное поле обнуляется, а is_active по умолчанию true. Чтобы поменять часть полей у известного правила или перенести его на другой ключ, берут PATCH /api/v1/stock/reorder-rules/{id}. При create_only=true существующий ключ возвращает 409 и сохраняет правило без изменений.'
      x-akeda-module: stock
      x-akeda-release-stage: preview
      x-akeda-audience: external
      x-akeda-permission: stock.settings:write
      security:
      - erpUserToken: []
      - tenantApiKey: []
      - mcpOAuth:
        - akeda:delegate
      - installationToken: []
      parameters:
      - $ref: '#/components/parameters/TenantHeader'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StockReorderRuleInput'
      responses:
        '200':
          description: Заведённое или переписанное правило
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StockReorderRule'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '500':
          $ref: '#/components/responses/InternalError'
  /api/v1/stock/reorder-rules/{id}:
    get:
      tags:
      - Stock reorder rules
      operationId: stockGetReorderRule
      summary: Получить правило пополнения
      description: Возвращает правило пополнения запасов.
      x-akeda-module: stock
      x-akeda-release-stage: preview
      x-akeda-audience: external
      x-akeda-permission: stock:read
      security:
      - erpUserToken: []
      - tenantApiKey: []
      - mcpOAuth:
        - akeda:delegate
      - installationToken: []
      parameters:
      - $ref: '#/components/parameters/TenantHeader'
      - name: id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/UUID'
      responses:
        '200':
          description: Правило пополнения
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StockReorderRule'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
    patch:
      tags:
      - Stock reorder rules
      operationId: stockUpdateReorderRule
      summary: Частично изменить существующее правило пополнения
      description: Правка правила, которое уже заведено, по его id. Меняются только переданные поля, остальные сохраняют текущее значение; неизвестный id отвечает 404, а не заводит правило. Ключевые поля business_id, company_id, product_id и warehouse_id тоже правятся — так правило переносят на другой ключ, и если по новому ключу правило уже есть, приходит 409. Новое юрлицо без business_id переносит правило в бизнес этого юрлица. Явный null снимает значение у company_id (правило бизнеса без юрлица), warehouse_id, max_qty, order_multiple и preferred_supplier_id. Для заведения правила берут PUT /api/v1/stock/reorder-rules.
      x-akeda-module: stock
      x-akeda-release-stage: preview
      x-akeda-audience: external
      x-akeda-permission: stock.settings:write
      security:
      - erpUserToken: []
      - tenantApiKey: []
      - mcpOAuth:
        - akeda:delegate
      - installationToken: []
      parameters:
      - $ref: '#/components/parameters/TenantHeader'
      - name: id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/UUID'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StockReorderRulePatch'
      responses:
        '200':
          description: Обновлённое правило
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StockReorderRule'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  responses:
    BadRequest:
      description: Некорректный запрос или нарушение бизнес-правила
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Сессия, ключ или кабинет не подтверждены
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: Текущая роль не имеет требуемого права
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: Запись не найдена или не видима текущему пользователю
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    InternalError:
      description: Внутренняя ошибка без раскрытия server-only деталей
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Conflict:
      description: Конфликт версии, идемпотентности или бизнес-состояния
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    StockReorderRuleInput:
      type: object
      additionalProperties: false
      required:
      - product_id
      - min_qty
      properties:
        business_id:
          oneOf:
          - $ref: '#/components/schemas/UUID'
          - type: 'null'
          description: Бизнес правила; обязателен без company_id, с company_id выводится от юрлица и обязан с ним совпасть
        company_id:
          oneOf:
          - $ref: '#/components/schemas/UUID'
          - type: 'null'
          description: Пропуск или null заводит правило бизнеса без юрлица
        product_id:
          $ref: '#/components/schemas/UUID'
          description: Складская номенклатура — отдельный товар или вариант; семейство вариантов и услуга не принимаются
        warehouse_id:
          oneOf:
          - $ref: '#/components/schemas/UUID'
          - type: 'null'
          description: Пропуск или null заводит правило на все склады; правилу без юрлица годится только склад, не закреплённый за юрлицами
        min_qty:
          type: string
          description: Decimal string неотрицательного порога пополнения.
        max_qty:
          type:
          - string
          - 'null'
          description: Decimal string целевого остатка; не меньше min_qty, null — цель равна порогу.
        order_multiple:
          type:
          - string
          - 'null'
          description: 'Совместимость со старыми правилами: положительная кратность либо null. Новые условия задаются в прайсе поставщика.'
        lead_time_days:
          type: integer
          minimum: 0
          default: 0
        preferred_supplier_id:
          oneOf:
          - $ref: '#/components/schemas/UUID'
          - type: 'null'
        is_active:
          type: boolean
          default: true
        create_only:
          type: boolean
          default: false
          description: 'true создаёт только новое правило: существующий естественный ключ даёт 409 без изменения; false сохраняет прежний режим заведения или перезаписи.'
    StockReorderRule:
      type: object
      additionalProperties: false
      required:
      - id
      - business_id
      - business_name
      - company_id
      - company_name
      - product_id
      - product_sku
      - product_name
      - warehouse_id
      - warehouse_name
      - min_qty
      - max_qty
      - order_multiple
      - lead_time_days
      - preferred_supplier_id
      - preferred_supplier_name
      - is_active
      - updated_at
      properties:
        id:
          $ref: '#/components/schemas/UUID'
        business_id:
          $ref: '#/components/schemas/UUID'
        business_name:
          type: string
        company_id:
          oneOf:
          - $ref: '#/components/schemas/UUID'
          - type: 'null'
          description: null означает правило бизнеса без юрлица
        company_name:
          type: string
          description: Пустая строка у правила без юрлица
        product_id:
          $ref: '#/components/schemas/UUID'
        product_sku:
          type: string
        product_name:
          type: string
        warehouse_id:
          oneOf:
          - $ref: '#/components/schemas/UUID'
          - type: 'null'
          description: null означает правило на все склады
        warehouse_name:
          type: string
        min_qty:
          type: string
          description: 'Порог пополнения: рекомендация появляется, когда доступное количество вместе с ожидаемой поставкой ниже порога.'
        max_qty:
          type:
          - string
          - 'null'
          description: Целевой остаток для пополнения при срабатывании порога; null — пополнять до порога.
        order_multiple:
          type:
          - string
          - 'null'
          description: Сохранённая кратность старого правила. Новые условия партии и кратности задаются в прайсе поставщика.
        lead_time_days:
          type: integer
          minimum: 0
        preferred_supplier_id:
          oneOf:
          - $ref: '#/components/schemas/UUID'
          - type: 'null'
        preferred_supplier_name:
          type: string
        is_active:
          type: boolean
        updated_at:
          type: string
          format: date-time
    StockReorderRulePatch:
      type: object
      additionalProperties: false
      minProperties: 1
      properties:
        business_id:
          $ref: '#/components/schemas/UUID'
        company_id:
          oneOf:
          - $ref: '#/components/schemas/UUID'
          - type: 'null'
          description: null переносит правило в бизнес без юрлица
        product_id:
          $ref: '#/components/schemas/UUID'
        warehouse_id:
          oneOf:
          - $ref: '#/components/schemas/UUID'
          - type: 'null'
        min_qty:
          type: string
          description: Decimal string
        max_qty:
          type:
          - string
          - 'null'
        order_multiple:
          type:
          - string
          - 'null'
        lead_time_days:
          type: integer
          minimum: 0
        preferred_supplier_id:
          oneOf:
          - $ref: '#/components/schemas/UUID'
          - type: 'null'
        is_active:
          type: boolean
    Error:
      type: object
      additionalProperties: false
      required:
      - detail
      properties:
        detail:
          type: string
          description: One human sentence in the request language (Accept-Language, echoed as Content-Language)
        code:
          type: string
          description: Stable module error code when the endpoint defines one
        field:
          type: string
          description: Request body path of the field the refusal is about, e.g. content.commercial.amount or due_date; present when the endpoint names the field
        reason:
          type: string
          description: Machine code of the field refusal reason, e.g. required, format, total_mismatch; present together with field when the endpoint defines reasons
        request_id:
          type: string
          format: uuid
          description: Case id. Always present on 5xx and on any error produced by the server itself; the same value is returned in the X-Request-ID header and recorded in the access log and the incident. Quote it to support instead of the cause, which the response never carries.
    StockReorderRulePage:
      type: object
      additionalProperties: false
      required:
      - count
      - limit
      - offset
      - results
      properties:
        count:
          type: integer
          minimum: 0
          description: Общее число подходящих правил, а не размер страницы
        limit:
          type: integer
          minimum: 1
        offset:
          type: integer
          minimum: 0
        results:
          type: array
          items:
            $ref: '#/components/schemas/StockReorderRule'
    UUID:
      type: string
      format: uuid
  parameters:
    TenantHeader:
      name: X-Tenant
      in: header
      required: true
      description: Slug выбранного кабинета; кабинет не является юрлицом
      schema:
        type: string
        minLength: 1
  securitySchemes:
    erpUserToken:
      type: http
      scheme: bearer
      bearerFormat: go_session
      description: Пользовательский ERP token, полученный через ORY Kratos session bridge
    tenantApiKey:
      type: apiKey
      in: header
      name: X-Api-Key
      description: Tenant-scoped сервисный API-ключ Akeda
    installationToken:
      type: http
      scheme: bearer
      bearerFormat: akeda_installation_token
      description: 'Краткосрочный токен установки приложения (`ai_…`). Выдаёт его человек: публичной двери обмена учётных данных на токен нет и не будет, пока нет брокера долгой половины секрета, асимметричного подтверждения и ограничителя с аудитом неудачных попыток. Токен принимается и в заголовке X-Api-Key, и живёт минуты — вместо показа его ротируют'
    developerSessionToken:
      type: http
      scheme: bearer
      bearerFormat: akeda_developer_session
      description: 'Сессия аккаунта разработчика (`ad_…`). Своя схема, а не пользовательский токен ERP: у разработчика нет кабинета, роли и прав, а хеш этого токена лежит в отдельном хранилище — на кабинетных маршрутах он не находится ничем. Выдаёт его обмен одноразовой ссылки из письма; пароля в этом контуре нет вовсе'
    developerAppKey:
      type: http
      scheme: bearer
      bearerFormat: akeda_developer_app_key
      description: 'Учётные данные приложения (`adk_…`) — это машина конвейера издателя, а не человек. Ключ привязан к ОДНОМУ приложению внешним ключом, и достижимая им поверхность — маршруты `/api/v1/developer` этого приложения. Обменять его на токен установки нельзя: такой двери нет, и ни одного маршрута к данным кабинета за ним не существует. Выпуск, ротацию и отзыв учётных данных этот ключ не выполняет: ключ, умеющий выпустить следующий ключ, не отзывается никогда. Значение показывается один раз, при выдаче; в хранилище лежит хеш'
    mcpOAuth:
      type: oauth2
      description: OAuth 2.1 delegation для MCP; кабинетные права проверяются на каждом вызове
      flows:
        authorizationCode:
          authorizationUrl: https://erp.akeda.ru/oauth2/authorize
          tokenUrl: https://erp.akeda.ru/oauth2/token
          scopes:
            akeda:delegate: Делегировать текущие пользовательские права MCP-подключению
x-akeda-contract-coverage:
- dashboard-metrics
- tasks-lifecycle
- tasks-collaboration
- tasks-workflow
- tasks-organization
- tasks-automation
- tasks-planning
- tasks-project-hub
- tasks-files
- calendar-events
- calendar-availability
- calendar-booking
- calendar-notifications
- calendar-connectors
- chat-conversations
- chat-messages
- chat-receipts
- chat-mentions
- chat-realtime
- core-directories
- core-folders
- core-contacts
- core-products
- core-documents
- core-orders
- core-registers
- core-accounting
- core-ledger
- core-items
- core-employees
- core-employee-operations
- core-currency-rates
- core-preferences
- core-ui-state
- core-external-refs
- core-product-imports
- core-product-exports
- core-gl-opening-imports
- core-reference
- core-change-feed
- finance-accounts
- finance-statements
- finance-transactions
- finance-connectors
- finance-connector-sync
- finance-requisites
- finance-counterparty-terms
- finance-operations
- finance-settlements
- finance-trade
- finance-exchange
- finance-imports
- finance-payment-calendar
- finance-pnl-layouts
- finance-registers
- finance-reports
- crm-pipelines
- crm-deals
- crm-leads
- crm-customers
- crm-links
- crm-inbox
- crm-automation
- crm-analytics
- knowledge-spaces
- knowledge-pages
- knowledge-access
- knowledge-files
- knowledge-search
- files-drives
- files-content
- files-access
- files-uploads
- files-shares
- stock-documents
- stock-inventory
- stock-warehouses
- stock-handling-units
- stock-batches
- stock-product-units
- stock-references
- stock-imports
- stock-exports
- stock-reports
- stock-valuation
- stock-reorder-rules
- stock-settings
- stock-purchasing
- marking-settings
- marking-connections
- marking-products
- marking-codes
- marking-labels
- marking-stock-codes
- marking-orders
- marking-gismt-documents
- marking-boxes
- marketplace-stores
- marketplace-ozon
- marketplace-wildberries
- marketplace-yandex
- marketplace-product-groups
- marketplace-accounting
- marketplace-catalog
- settings-companies
- settings-roles
- settings-members
- settings-fields
- settings-api-keys
- finance-payroll
- finance-report-details
- knowledge-tags
- knowledge-revisions
- knowledge-approval
- chat-attachments
- chat-reactions
- chat-folders
- platform-apps
- platform-app-installations
- platform-app-tokens
- platform-app-deliveries
- platform-app-publishers
- platform-app-publication
- platform-app-rollouts
- platform-app-runtime
- platform-app-access
- platform-app-blocks
- platform-demo-data
- billing-usage
- platform-analytics
- finance-staffing
- platform-tenants
- platform-users
- platform-access
- platform-mcp-publication
- platform-incidents
- platform-health
- settings-apps
- docflow-connections
- docflow-mirror
- docflow-signing
- docflow-actions
- docflow-outgoing
- docflow-intake
- docflow-flow
- docflow-approvals
- docflow-flow-accounting
- mail-accounts
- mail-folders
- mail-messages
- mail-rules
- mail-outbound
- mail-attachments
- billing-plans
- billing-subscriptions
- billing-invoices
- billing-analytics
- settings-subscription
- billing-payments
- billing-public
x-akeda-docs-path: /docs
x-akeda-default-release-stage: internal
x-akeda-default-audience: operator