Product Management API

The Product Management API enables developers to build apps and integrations for managing your DecoNetwork products.

The Product Management API service provides the following functionality:

• Retrieve a list of products in your DecoNetwork site based on your search parameters.

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

To search for Products:

1. Log into your DecoNetwork website.
2. Browse to Admin > Reports > Product Management Api.
3. Set your search criteria and enter your credentials.
   
   • Field: Specify the field you want to search by. Options are:
     • Date Added: the date the product was added.
     • Date Modified: the date on which the product was last modified.
     • Product Code: the identification code of a particular product style.
     • Product Name: the name of the product.
     • Supplier: the name of the product supplier.
     • Product ID: the unique identification number of a particular product SKU.
   • 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 to filter results by. Used if the Field option selected is a date.
   • String: the value to filter results by. Used if the Field option selected is "Product Code", "Product Name, "Supplier", or "Product ID".
   • 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
     • Added: the date the product was added.
     • Date Modified: the date on which the product was last modified.
     • Product Code: the identification code of a particular product style.
     • Product Name: the name of the product.
   • 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.