The Inventory Event Management API allows you to search for inventory events by id or date
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 |
50005 | ERROR | Invalid request parameters |
Retrieve a list of inventory events 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 Created). |
date2 | string The end date to test against (Required when field is Date Created and condition is 7: Between). |
number1 | number The number to test against (Required when field is Inventory Id). *Multi condition parameter name: conditions[n][number1] |
number2 | number The end number to test against (Required when field is Inventory Id). *Multi condition parameter name: conditions[n][number2] |
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 (InventoryEvent) | |
total | integer |
field=1&condition=4&date1=2018-10-01T00%3A00%3A00
{- "response_status": {
- "code": 10001,
- "severity": "SUCCESS",
- "description": "string"
}, - "inventory_events": [
- {
- "product_id": 3453453,
- "dn_sku_id": "13_691",
- "created_at": "2022-01-19T03:34:18",
- "change_type": 4,
- "po_number": "172680",
- "inventory_id": 2435345,
- "po_line_id": 46756,
- "old_qty": 0,
- "new_qty": 1,
- "user": {
- "user_id": 113452,
- "salutation": null,
- "firstname": "David",
- "lastname": "Smith",
- "company_id": null,
- "street": "1522 Junior Avenue",
- "city": "San Francisco",
- "state": "California",
- "ph_number": "+1 518-555-0191",
- "country_code": "US",
- "postcode": "94103",
- "email": "dsmith@testing.test",
- "company": null
}
}
], - "total": 1
}