Open Inventory / Docs
EndpointsInventory cyclesResourcesIdInventory counts

Record an inventory count or serialized-unit review

The API runs on your application instance. Schemas and field names come directly from the OpenAPI specification. Session-authenticated requests require a session on that instance.

POST
/resources/{id}/inventory-counts

Bulk counts reconcile either the global balance or one structured location. Serialized items are reviewed through their individual units and may complete the cycle when the submitted whole-item count matches current serialized availability. Every completion appends an inventory-count movement and advances an existing cycle policy.

Authorization

bearerAuth
headerAuthorizationBearer <inv_ token>

Path Parameters

id*string
Formatuuid

Header Parameters

Idempotency-Key?string

UUID identifying one queue operation; safe to reuse for retries.

Formatuuid
X-Organization-ID?string

Organization membership selected for this request. User-bound credentials may select any active membership; standalone tokens may only repeat their pinned organization ID.

Formatuuid

Request Body

application/json
  1. body
countedQuantity*integer

For serialized tracking this must match current availability after individual units have been reviewed or corrected.

Range0 <= value <= 2000000000
locationResourceId?|

Reconcile only this structured stock location when provided.

Formatuuid
countedAt?string
Formatdate-time
note?string
Lengthlength <= 20000

Response Body

Replayed an earlier count with the same Idempotency-Key

application/json
  1. response
count*
movementId?string

Present when the count is newly recorded; replayed counts retain the movement id inside count.

Formatuuid
replayed*boolean
Example Request
curl -X POST 'https://inventory.example.com/api/v1/resources/497f6eca-6276-4993-bfeb-53cbbbba6f08/inventory-counts' \  -H 'Content-Type: application/json' \  -d '{  "countedQuantity": 0}'
Example Response
{  "count": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "resourceId": "026d60bb-63a8-407e-bf67-01dcfc6022e6",    "locationResourceId": "cad4fbcc-0e81-4c59-9f5c-423e9329e3ec",    "expectedQuantity": 0,    "countedQuantity": 0,    "variance": 0,    "countedAt": "2019-08-24T14:15:22Z",    "note": "string",    "movementId": "6d70aa0f-b438-487d-b073-0eb66eb6ab63",    "idempotencyKey": "0c14c6a6-6f50-4d1e-b0c4-b46ff43ba6a1",    "createdBy": "string",    "createdAt": "2019-08-24T14:15:22Z"  },  "movementId": "6d70aa0f-b438-487d-b073-0eb66eb6ab63",  "replayed": true}