Inventory Management API (1.0)

The Inventory Management (Beta) API allows you to search for sku based inventory or update inventory

Common Authorization Parameters

Each request is authorized using username and password fields passed either as query parameters (for GET/POST operations) or part of the application/x-www-form-urlencoded body (for POST operations).

Error Codes

Each response contains a response_status field containing the following error codes.

Code Severity Description
10001 SUCCESS
30001 ERROR Authentication failed
31000 ERROR API not enabled on your site
40004 WARNING Product ID Not Found
50002 ERROR No conditions specified
50003 ERROR Condition N 'field' is missing
50003 ERROR Condition N 'condition' is missing
50003 ERROR date1 is invalid
50003 ERROR date2 is invalid

Inventory Search

Retrieve a list of inventories based upon your search parameters. The maximum number of rows returned is 100. Use the returned "total" value to determine if you need to paginate using the offset parameter.
You can specify multiple conditions in which case the conditions will be joined with a logical 'AND'.
To use multiple conditions you will need to pass the parameters using the multi condition parameter format:

conditions[n][parameter name]

where n starts at 1 and "parameter name" is the name of the parameter as below.

Request Body schema: application/x-www-form-urlencoded
field
required
integer

The Field the condition is tested against.
Multi condition parameter format: conditions[n][field]

Values

  • 1: Product Code
  • 2: Product Name
  • 3: Supplier
  • 4: Product Id
  • 5: Date Modified
  • 6: Inventory Id
condition
required
integer

The logical test to use.
Multi condition parameter name: conditions[n][condition]

Values

  • 1: ==
  • 2: !=
  • 3: <
  • 4: >
  • 5: <=
  • 6: >=
  • 7: Between
date1
string

The date to test against (Required when field is Date Modified).
The date is in ISO-8601 date format in UTC timezone (YYYY-MM-DDTHH:MM:SS).
Multi condition parameter name: conditions[n][date1]

date2
string

The end date to test against (Required when field is Date Modified and condition is 7: Between).
The date is in ISO-8601 date format in UTC timezone (YYYY-MM-DDTHH:MM:SS).
Multi condition parameter name: conditions[n][date2]

string
string

The string to test against (Required when field is Product Code, Product Name, Supplier, or Product Id). Multi condition parameter name: conditions[n][string]

limit
integer [ 0 .. 100 ]
Default: 100

Limit the number of results returned. The maximum limit is 100

offset
integer
Default: 0

Offset of the results to allow pagination

sortby
integer
Default: 2

What field to sort the results by
Values

  • 1: Product Code
  • 2: Product Name
  • 3: Date Modified

Responses

Request samples

Content type
application/x-www-form-urlencoded
field=5&condition=4&date1=2018-02-01T00%3A00%3A00

Response samples

Content type
application/json
{
  • "response_status": {
    },
  • "inventories": [
    ],
  • "total": 1
}

Update Inventory

Update the inventory amounts for a particular sku. Multiple inventories can be specified in one request using the "multi change format":

changes[n][parameter name] 

where "n" starts at 1, and "parameter name" is the name of the parameter as below.

Request Body schema: application/x-www-form-urlencoded
dn_sku_id
required
string

The unique DecoNetwork identifier for the sku Multi change parameter format: changes[n][dn_sku_id]

inv_on
boolean

True if inventory tracking is on for this sku Multi change parameter format: changes[n][inv_on]

inv_lvl
number

The inventory on hand amount. Multi change parameter format: changes[n][inv_lvl]

inv_warn
number

The inventory low stock waning amount. Multi change parameter format: changes[n][inv_warn]

inv_reorder_to
number

The inventory reorder to level amount. Multi change parameter format: changes[n][inv_reorder_to]

message
string

The reason for the inventory change. Multi change parameter format: changes[n][message]

operator_id
number

The id of the operator making the change. If not specified, the operator with the username/password sent will be used. Multi change parameter format: changes[n][operator_id]

operator_login
string

The login of the operator making the change. Can be used if the id of the operator is unknown. Multi change parameter format: changes[n][operator_login]

Responses

Request samples

Content type
application/x-www-form-urlencoded
dn_sku_id=196171378&inv_lvl=2&operator_login=bob123

Response samples

Content type
application/json
{
  • "response_status": {
    }
}