Open Inventory / Docs
EndpointsInventory cyclesResourcesIdInventory cycle

Retrieve an item's inventory cycle and recent count history

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.

GET
/resources/{id}/inventory-cycle

Authorization

bearerAuth
headerAuthorizationBearer <inv_ token>

Path Parameters

id*string
Formatuuid

Header Parameters

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

Response Body

Inventory cycle, nullable policy, and up to 25 recent counts

application/json
  1. response
cycle*
Example Request
curl -X GET 'https://inventory.example.com/api/v1/resources/497f6eca-6276-4993-bfeb-53cbbbba6f08/inventory-cycle'
Example Response
{  "cycle": {    "resource": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "quantity": 0,      "trackingMode": "bulk"    },    "policy": {      "resourceId": "026d60bb-63a8-407e-bf67-01dcfc6022e6",      "intervalDays": 1,      "enabled": true,      "nextDueAt": "2019-08-24T14:15:22Z",      "lastCompletedAt": "2019-08-24T14:15:22Z",      "createdBy": "string",      "updatedBy": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    },    "history": [      {        "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"      }    ]  }}

Record an inventory count or serialized-unit review POST

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.

Create or replace an item's recurring count policy PUT

Next Page