iotoms Docs

Dismiss an inventory exception

POST
/api/v1/inventory/exceptions/{id}/ignore

Closes an inventory exception without moving any stock, with an optional note.

How to use it

  1. Find the exception in List inventory exceptions.
  2. Send an optional note; the exception becomes IGNORED and no stock moves. Calling it on an already closed exception changes nothing.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Path Parameters

id*string

ID of the record (UUID).

Formatuuid

Header Parameters

Request Body

application/json
  1. body
applyMovement*boolean

true posts the missed stock movement now; false (default) closes it as acknowledged without moving stock.

note?|

Optional note recorded with the resolution; up to 500 characters are kept.

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 POST 'https://beta.iotoms.com/api/v1/inventory/exceptions/497f6eca-6276-4993-bfeb-53cbbbba6f08/ignore' \  -H 'Content-Type: application/json' \  -d '{  "applyMovement": true}'
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"  }}