Counts

Use the view query parameter (default items) to choose what to return: items, summary, item-options, transactions, counts, count-lines, item-count-lines, valuation, or lots. Responses vary — for example items (paginated SKUs, quantities, costing), transactions (receipts, issues, adjustments), counts (sessions), count-lines (requires countId), item-count-lines (open lines for one SKU; requires itemId), valuation (totals), and lots (requires itemId). Physical counts: view=counts lists count sessions; view=count-lines returns lines for a session (countId required). Other query params include itemId, type, countId, search, status, category, lowStock, and pagination where applicable. Authorization: Bearer ak_.... Required scope includes read:inventory. Pass entityId (query / JSON / x-entity-id).

Query Parameters

Response Body

Body includes action; fields depend on the action. Physical counts: create-count requires countDate (optional notes) and returns { countId } with a line for each active SKU. record-count-line requires countLineId and countedQty. finalize-count requires countId, posts quantity variances, and marks the session completed. Item actions: create-item, receive, issue, adjust, and write-down. Authorization: Bearer ak_.... Required scope includes write:inventory. Pass entityId as above.

Query Parameters

Response Body

Delete a physical count session. Authorization: Bearer ak_.... Required scope includes write:inventory. Requests are scoped to one entity. Pass entityId as a query parameter, JSON field, or x-entity-id header. API keys are already pinned to an entity.

Path Parameters

Query Parameters

Response Body