The Inventory Management (Beta) API allows you to search for sku based inventory or update inventory
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).
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 |
50004 | ERROR | Invalid limit or offset |
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.
field required | integer The Field the condition is tested against. Values
|
condition required | integer The logical test to use. Values
|
date1 | string The date to test against (Required when field is Date Modified). |
date2 | string The end date to test against (Required when field is Date Modified and condition is 7: Between). |
number1 | integer When searching by InventoryId or InventoryOn (1=true, 0=false) . |
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] |
include_deleted_products | integer Default: 0 Include deleted products that match the query. Set to 1 to include deleted products. |
include_deleted_skus | integer Default: 0 Include deleted skus belonging to products that match the query. Set to 1 to include deleted skus. |
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: 1 What field to sort the results by
|
object (ResponseStatus) | |
Array of objects (Inventory) An array of inventory objects | |
total | integer Total number of inventories found |
field=5&condition=4&date1=2018-02-01T00%3A00%3A00
{- "response_status": {
- "code": 10001,
- "severity": "SUCCESS",
- "description": "string"
}, - "inventories": [
- {
- "product_name": "Classic T-Shirt",
- "product_id": "215445828",
- "inv_location": "",
- "product_code": "1301",
- "inv_to_order": 0,
- "inv_lvl": 2,
- "product_size": {
- "option_id": 2,
- "name": "Medium",
- "code": "M",
- "sub_sizes": [ ]
}, - "inv_warn": 0,
- "vendor_sku": "B00137024",
- "inv_on": true,
- "product_inv_on": true,
- "inv_on_order_total": 0,
- "dn_vsku_id": "30_886",
- "inv_reorder_to": 0,
- "inv_on_order_po": 0,
- "id": 2350343,
- "supplier": "S&S Activewear",
- "inv_on_order_stk": 0,
- "product_color": {
- "name": "Ash",
- "id": 1306
}, - "dn_sku_id": "215445828_303990748",
- "inv_last_modified": "2022-01-19T03:34:18",
- "sku": "B00137024"
}
], - "total": 1
}
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.
Turning the inventory on for a sku will turn inventory on for the product.
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] |
object (ResponseStatus) |
dn_sku_id=196171378&inv_lvl=2&operator_login=bob123
{- "response_status": {
- "code": 10001,
- "severity": "SUCCESS",
- "description": "string"
}
}