Inventory Event Management API (1.0)

The Inventory Event Management API allows you to search for inventory events by id or date

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
50004 ERROR Invalid limit or offset

Inventory Event Search

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.

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: Date Created
  • 2: 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 Created).
The date is in ISO-8601 format, 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 Created and condition is 7: Between).
The date is in ISO-8601 format, UTC timezone (YYYY-MM-DDTHH:MM:SS).
Multi condition parameter name: conditions[n][date2]

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
Values

  • 1: Date Created
  • 2: Inventory Id

Responses

Response Schema: application/json
object (ResponseStatus)
Array of objects (InventoryEvent)
total
integer

Request samples

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

Response samples

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