AdminGetInventoryItemsParams
Parameters used to filter and configure the pagination of the retrieved inventory items.
Properties
id
string | string[]IDs to filter inventory items by.
q
stringSearch terms to search inventory items' sku, title, and description.
location_id
string | string[]Location IDs to filter inventory items by.
sku
string | string[]SKUs to filter inventory items by.
origin_country
string | string[]Origin countries to filter inventory items by.
mid_code
string | string[]MID codes to filter inventory items by.
material
string | string[]Materials to filter inventory items by.
hs_code
string | string[] | StringComparisonOperatorString filters to apply to inventory items'
hs_code
field.weight
number | NumericalComparisonOperatorNumber filters to apply to inventory items'
weight
field.length
number | NumericalComparisonOperatorNumber filters to apply to inventory items'
length
field.height
number | NumericalComparisonOperatorNumber filters to apply to inventory items'
height
field.width
number | NumericalComparisonOperatorNumber filters to apply to inventory items'
width
field.requires_shipping
booleanFilter inventory items by whether they require shipping.
expand
stringComma-separated relations that should be expanded in the returned data.
fields
stringComma-separated fields that should be included in the returned data.
if a field is prefixed with
+
it will be added to the default fields, using -
will remove it from the default fields.
without prefix it will replace the entire default fields.offset
numberThe number of items to skip when retrieving a list.
Default: 0
limit
numberLimit the number of items returned in the list.
Default: 20
order
stringThe field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with
-
.Was this section helpful?