iotoms Docs

List inventory adjustment audit events

GET
/api/v1/reports/audit/inventory

Returns the audit trail of stock adjustments in a date range, optionally for a single itemId. Dates default to today when omitted. Paginated with 0-based page (default 0) and size (default 20).

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Query Parameters

itemId?string

Filter by item ID

from?string

Start date (YYYY-MM-DD), defaults to today

Formatdate
to?string

End date (YYYY-MM-DD), defaults to today

Formatdate
page?integer

Page number, starting at 0. See Paging.

Formatint32
Default0
size?integer

Number of records per page.

Formatint32
Default20

Header Parameters

X-TenantID*string

Your merchant's tenant code — the value typed in the Domain field on the iotoms login screen. See Concepts.

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 stock adjustment events: content holds the entries and page holds size, number (0-based), totalElements and totalPages.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/reports/audit/inventory' \  -H 'X-TenantID: your-tenant-code'
Example Response
{  "status": "string",  "message": "string",  "data": {    "totalElements": 0,    "totalPages": 0,    "first": true,    "last": true,    "size": 0,    "content": [      {        "transactionId": "string",        "cartId": "string",        "businessDate": "2019-08-24",        "grandTotal": 0,        "paymentStatus": "string",        "channel": "string",        "createdAt": "string"      }    ],    "number": 0,    "sort": [      {        "direction": "string",        "nullHandling": "string",        "ascending": true,        "property": "string",        "ignoreCase": true      }    ],    "numberOfElements": 0,    "pageable": {      "offset": 0,      "sort": [        {          "direction": "string",          "nullHandling": "string",          "ascending": true,          "property": "string",          "ignoreCase": true        }      ],      "paged": true,      "pageNumber": 0,      "pageSize": 0,      "unpaged": true    },    "empty": true  }}