Inventory Management API

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

The Inventory Management API service provides the following functionality:

• Retrieve a list of SKU-based inventory rows based on your search parameters. The results include supplier inventory levels.
• Update the inventory amount of a product SKU
• Turn inventory tracking on or off for a product SKU

The Inventory 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 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

Prerequisites

• You must be on the Enterprise plan to use this feature
• You must have administrator access to enable and connect to the API
• You must have programming experience

In this article, learn how...

• To retrieve inventory levels for a product SKU
• To update the status of a product SKU

To retrieve inventory levels for a product SKU:

1. Log into your DecoNetwork website.
2. Browse to Admin > Reports > Inventory Management Api.
3. Set your search criteria and enter your credentials.
   
   • Field: Specify the field you want to search by. Options are:
     • Product Code: the identification code of a particular product style.
     • Product Name: the name of a product.
     • Supplier: the supplier name of a product.
     • Product ID: the unique identification number of a product.
     • Date Modified: the date on which the inventory level for the product was last modified.
     • Inventory Id: the unique identification number of a SKU.
     • Inventory On: the condition that a SKU has inventory tracking on. Lets you search for SKUs that have inventory tracking enabled/disabled.
   • 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
   • String: the value to filter results by. Used for all Field options other than "Date Modified".
   • Date 1: the date to filter results by. Used if the Field option selected is "Date Modified".
   • 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:
     • Product Code: the identification code of a particular product style.
     • Product Name: the name of a product.
     • Date Modified: the date on which the inventory level for the product was last modified.
   • 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.

To update the status of a product SKU:

1. Log into your DecoNetwork website.
2. Browse to Admin > Reports > Inventory Management Api.
3. Specify the DecoNetwork SKU ID number and configure the update settings.
   
   • DN SKU Id: the stock-keeping unit identification number.
   • Inv On: lets you turn inventory tracking on/off for this SKU.
   • Location: the coordinate number of the storage bin where the item is located.
   • Inv Level: the number to change the inventory level to.
   • Inv Warn: the inventory level at which a warning email will be sent to relevant team members informing them of low stock.
   • Inv Reorder To: the amount of a product SKU a purchase order will restock the inventory level to.
   • Operator Id: the ID number of the operator making the change. If not specified, the operator with the username/password sent will be used.
   • Operator Login: the login username of the operator making the change. Can be used if the ID of the operator is unknown.
   • 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 Update.