API покрывает весь кластер

Любая операция интерфейса доступна снаружи: справочники, остатки, документы, заказ-наряды, расчёты планирования и отчёты.

Принципы контракта

  • Методы по контроллерам

    Адрес метода состоит из раздела и действия: StockDocuments/PostDocument. Ломающее изменение выходит новой версией, предыдущая живёт весь переходный период.

  • Идемпотентность записи

    Операции записи принимают ключ идемпотентности в заголовке. Повторная отправка того же запроса не проводит документ дважды.

  • Пагинация везде

    Списочные методы принимают offset, count, фильтры и сортировку. Ответ содержит элементы и общее количество.

  • Одна организация на запрос

    Каждый запрос выполняется в контексте организации и сессии A3.ID. Запроса без фильтра по организации в системе не существует.

Основные группы методов

  • GETItems/GetItemsНоменклатура с группами, единицами измерения и признаками учёта
  • GETStock/GetBalancesОстатки по измерениям, включая срез на дату
  • GETStock/GetMovementsДвижения с документом-основанием и ссылкой на сторно
  • POSTStockDocuments/CreateDocumentСоздание складского документа любого из тринадцати видов
  • PUTStockDocuments/PostDocumentПроведение документа и запись движений
  • POSTReservations/CreateReservationРезерв с источником и сроком действия
  • GETProductionOrders/GetProductionOrdersЗаказ-наряды со статусом, обеспечением и выпуском
  • POSTPlanning/RunPlanningЗапуск расчёта потребности как фоновой задачи

Пример ответа

Остаток возвращается по всем измерениям учёта сразу: склад, ячейка, партия и характеристика. В Режиме 1 измерения приходят со служебными значениями по умолчанию.

GET Stock/GetBalances?itemId=7f31a0

{
  "items": [
    {
      "warehouseId": "main",
      "cellId": "A-04-12",
      "batchId": "2026-07-14",
      "quantity": 1840.5,
      "reserved": 320,
      "available": 1520.5,
      "averageCost": 412.37,
      "currency": "KZT"
    }
  ],
  "totalCount": 1
}

Вебхуки

Подписка настраивается на уровне организации, каждое сообщение подписано секретом. Доставка повторяется до подтверждения, исходящие события видны в журнале с ручным повтором.

  • StockDocumentPostedСкладской документ проведён
  • StockBalanceChangedОстаток изменился
  • MinimumStockReachedДостигнут минимальный остаток
  • ProductionOrderStatusChangedСтатус заказ-наряда изменён
  • ProductionOutputRegisteredЗарегистрирован выпуск
  • ProductionOrderClosedЗаказ-наряд закрыт
  • PlanningRunCompletedРасчёт планирования завершён
  • MaintenanceRequestStatusChangedСтатус заявки на ремонт изменён
  • EquipmentAvailabilityChangedДоступность оборудования изменилась

Документация открыта

Описание методов, схемы моделей и примеры запросов открыты в документации API. Вход через A3.ID или ключ API организации, ограничение частоты работает на уровне организации.