The API covers the whole cluster

Any operation in the interface is available from outside: catalogs, balances, documents, production orders, planning runs and reports.

Contract principles

  • Methods by controller

    A method path consists of a section and an action: StockDocuments/PostDocument. A breaking change ships as a new version, and the previous one lives through the whole transition period.

  • Idempotent writes

    Write operations accept an idempotency key in a header. Sending the same request again does not post the document twice.

  • Pagination everywhere

    List methods accept offset, count, filters and sorting. The response contains the items and the total count.

  • One organization per request

    Each request runs in the context of an organization and an A3.ID session. There is no request in the system without an organization filter.

Main method groups

  • GETItems/GetItemsItems with groups, units of measure and tracking attributes
  • GETStock/GetBalancesBalances by dimension, including a snapshot as of a date
  • GETStock/GetMovementsMovements with the source document and a link to the reversal
  • POSTStockDocuments/CreateDocumentCreating a stock document of any of the thirteen kinds
  • PUTStockDocuments/PostDocumentPosting a document and writing movements
  • POSTReservations/CreateReservationA reservation with a source and an expiry date
  • GETProductionOrders/GetProductionOrdersProduction orders with status, provision and output
  • POSTPlanning/RunPlanningStarting a requirements calculation as a background task

Sample response

The balance is returned across all accounting dimensions at once: warehouse, cell, batch and characteristic. In Mode 1 the dimensions come with default service values.

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
}

Webhooks

The subscription is set up at the organization level, and each message is signed with a secret. Delivery is retried until confirmed, and outgoing events are visible in a log with manual retry.

  • StockDocumentPostedStock document posted
  • StockBalanceChangedBalance changed
  • MinimumStockReachedMinimum stock reached
  • ProductionOrderStatusChangedProduction order status changed
  • ProductionOutputRegisteredOutput registered
  • ProductionOrderClosedProduction order closed
  • PlanningRunCompletedPlanning run completed
  • MaintenanceRequestStatusChangedMaintenance request status changed
  • EquipmentAvailabilityChangedEquipment availability changed

The documentation is open

Method descriptions, model schemas and sample requests are open in the API documentation. Sign-in via A3.ID or an organization API key, and rate limiting works at the organization level.