iotoms Docs

List inventory exceptions

GET
/api/v1/inventory/exceptions

Returns stock movements that should have happened and did not, such as a sale that did not deduct stock or a return that was not restocked. Filter by status; paginated with 0-based page and size (default 20).

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Query Parameters

status?string

Optional: OPEN, RESOLVED or IGNORED. Omit to list all.

Value in"OPEN""RESOLVED""IGNORED"
page?integer

Page number, starting at 0. See Paging.

Formatint32
Default0
size?integer

Number of records per page.

Formatint32
Default20

Header Parameters

Response Body

OK

*/*
  1. response
status*string

Outcome of the call: SUCCESS when the request worked, ERROR when it did not.

message*string

Short human-readable message describing the result, for logs or display; do not parse it.

data?

One page of inventory exceptions, most recently seen first, with paging details and the total open count.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/inventory/exceptions'
Example Response
{  "status": "string",  "message": "string",  "data": {    "content": [      {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "exceptionType": "REGISTER_LOCATION_UNSET",        "exceptionTypeLabel": "string",        "status": "OPEN",        "referenceType": "string",        "referenceId": "string",        "itemId": "string",        "itemName": "string",        "locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",        "locationName": "string",        "quantity": 0,        "adjustmentType": "string",        "movementReason": "string",        "businessDate": "2019-08-24",        "detail": "string",        "occurrenceCount": 0,        "replayable": true,        "firstSeenAt": "2019-08-24T14:15:22Z",        "lastSeenAt": "2019-08-24T14:15:22Z",        "raisedBy": "string",        "resolvedAt": "2019-08-24T14:15:22Z",        "resolvedBy": "string",        "resolution": "APPLIED",        "resolutionNote": "string"      }    ],    "page": 0,    "size": 0,    "totalElements": 0,    "totalPages": 0,    "openCount": 0  }}