Returns inventory items.
Formats
| .json | JSON (default format if no extension is supplied) |
| .js |
Javascript (for use with JSON-P, requires callback parameter)
|
| .csv | Comma Separated Values |
| .tsv | Tab Separated Values |
Parameters
-
where,where_not -
wherefilters products where the supplied fields are true.where_notfilters products where the supplied fields are false. The two parameters can be used together. Multiple fields can be specified by joining them with a comma:where=field1,field2. The fields below may be specified:is_dead -
order -
Orders the results by the specified fields in ascending (
asc) or descending (desc) order. Multiple fields can be specified by joining them with a comma:order=field1.desc,field2.asc. The fields below may be specified:quantity, updated_on -
limit -
Only used for CSV and TSV responses, specifies the number of rows to return. The default value is 50, and the maximum value is 500.
-
page -
The page number to return. Consult the API conventions documentation for more information about pagination.
-
per_page -
The number of objects to include per page. The default value is 50, and the maximum value is 100.