Inventory Events Management API

The Inventory Events Management API enables developers to build apps and integrations for managing your DecoNetwork inventory events.

The Inventory Events Management API service provides the following functionality:

• Retrieve a list of inventory events for a specified date or date range.
• Retrieve a list of inventory events for a specific ID or ID range

The Inventory Events Management API app not only gives you access to the API. It also demonstrates the supported functionality through an API console to make it easier for developers to learn how to use the Inventory Event Management API. The console provides a GUI that enables a developer to interact with the API to see the response with live API calls. Using this API console, a developer can:

• See what information is required and what parameters are needed in their API queries
• Test queries and view results in the browser

In this article, learn how to...

• Search for inventory events for a specific date/date range
• Search for inventory events for a specific ID/ID range

Search for inventory events for a specific date/date range:

1. Log into your DecoNetwork website.
2. Browse to Admin > Reports > Inventory Events Management API.
3. Set your search criteria and enter your credentials.
   
   • Field: Select Date Created.

     Date Created is the date on which an inventory event occurred.

   • Condition: the condition to filter the results by. Options are:
     • ==: equal to
     • !=: not equal to
     • <: less than
     • >: greater than
     • <=: less than or equal to
     • >=: greater than or equal to
     • Between: between the values of
   • Date 1: the date used to filter results. If the Condition selected is "Between", this will serve as the starting date.
   • Date 2: the ending date used to filter results. This is applicable only if the Condition selected is "Between".
   • Limit: limit the number of search results returned. The maximum limit is 100.
   • Offset: used to paginate results. (For example, if you want to retrieve records 50 through to 75, you would set Limit to 25 and set Offset to 50).
   • Sort By: the field to sort the search results by. Options are:
     • Date Created: the date on which inventory events occur.
     • InventoryId: the identification number of inventory events.
   • Username: the username of the account to use when connecting to the API.
   • Password: the password of the account to use when connecting to the API.
4. Click Search.

Search for inventory events for a specific ID/ID range:

1. Log into your DecoNetwork website.
2. Browse to Admin > Reports > Inventory Events Management API.
3. Set your search criteria and enter your credentials.
   
   • Field: Select InventoryId.

     InventoryId is the identification number of an inventory event.

   • Condition: the condition to filter the results by. Options are:
     • ==: equal to
     • !=: not equal to
     • <: less than
     • >: greater than
     • <=: less than or equal to
     • >=: greater than or equal to
     • Between: between the values of
   • Number 1: the ID number used to filter results. If the Condition selected is "Between", this will be the starting ID.
   • Number 2: the ending ID used to filter results. This is applicable only if the Condition selected is "Between".
   • Limit: limit the number of search results returned. The maximum limit is 100.
   • Offset: used to paginate results. (For example, if you want to retrieve records 50 through to 75, you would set Limit to 25 and set Offset to 50).
   • Sort By: the field to sort the search results by. Options are:
     • Date Created: the date on which inventory events occur.
     • InventoryId: the identification number of inventory events.
   • Username: the username of the account to use when connecting to the API.
   • Password: the password of the account to use when connecting to the API.
4. Click Search.