iotoms Docs

Get an inventory exception

GET
/api/v1/inventory/exceptions/{id}

Returns one inventory exception by ID: what failed to move (item, location, quantity, direction), the source document, how often it occurred, whether it can be replayed and, once closed, how it was resolved.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Path Parameters

id*string

ID of the record (UUID).

Formatuuid

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?

The inventory exception as it now stands.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/inventory/exceptions/497f6eca-6276-4993-bfeb-53cbbbba6f08'
Example Response
{  "status": "string",  "message": "string",  "data": {    "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"  }}