Get Inventory Adjustment Events

Get Inventory Adjustment Events

Retrieves a set of inventory adjustment events.

Note that your datetime filters will be clamped to a maximum range of thirty-one days following the processes laid out in DateTime Handling.

Verb	POST
Endpoint	{base-url}/reports/inventory-adjustments
Max Page Size	100

Request Body

{
  "requestFilter": {
    "organizationIds": [1],
    "accountIds": [1],
    "siteIds": [1],
    "machineIdentifiers": ["1", "PROSE123456789"],
    "startDate": "2021-11-15T18:07:05.477",
    "endDate": "2021-11-15T18:07:05.477"
  },
  "routeFilter": {
    "transactionIdentifiers": ["B1488"]
  }
}

Filters Honored

• RequestFilter
  • organizationIds
  • accountIds
  • siteIds
  • machineIdentifiers
  • startDate
  • endDate
• TransactionFilter
  • transactionIdentifiers

Returns

On Success

The requested list of inventory adjustment events.

Response Body

[
  {
    "eventType": "Adjustment",
    "id": "B1625",
    "adjustmentOccurredAt": "2021-12-15T01:11:24.36",
    "takeOccurredAt": "2021-12-15T01:11:24",
    "timeZone": "America/Chicago",
    "siteId": 567,
    "siteExternalId": "babc188c-a1e5-4ea2-9648-93dbd8c422dd",
    "machineId": 11398,
    "machineExternalId": "MACH-0091",
    "selection": "132",
    "productId": 49998,
    "userId": 14,
    "externalUserIdentifier": "emp-7734",
    "adjustmentSize": 1,
    "newStockLevel": 83
  }
]

Note

adjustmentOccurredAt and takeOccurredAt are UTC despite carrying no Utc suffix. This report predates the naming convention described in DateTime Handling. timeZone is provided for reference but may be null on older records.

On Error

HTTP Code	Error Code	Definition
400	DESERIALIZATION_ERROR	One or more of the provided transactionIdentifiers filter values could not be parsed as a valid transaction identifier.
403	DATA_ACCESS_VIOLATION	One or more of the specified transaction IDs belong to an organization you do not have access to.