Skip to main content
Skip to main content

AdminGetInventoryItemsParams

Parameters used to filter and configure the pagination of the retrieved inventory items.

Properties

idstring | string[]
IDs to filter inventory items by.
qstring
Search terms to search inventory items' sku, title, and description.
location_idstring | string[]
Location IDs to filter inventory items by.
skustring | string[]
SKUs to filter inventory items by.
origin_countrystring | string[]
Origin countries to filter inventory items by.
mid_codestring | string[]
MID codes to filter inventory items by.
materialstring | string[]
Materials to filter inventory items by.
hs_codestring | string[] | StringComparisonOperator
String filters to apply to inventory items' hs_code field.
Number filters to apply to inventory items' weight field.
Number filters to apply to inventory items' length field.
Number filters to apply to inventory items' height field.
Number filters to apply to inventory items' width field.
requires_shippingboolean
Filter inventory items by whether they require shipping.
expandstring
Comma-separated relations that should be expanded in the returned data.
fieldsstring
Comma-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.
offsetnumber
The number of items to skip when retrieving a list.

Default: 0

limitnumber
Limit the number of items returned in the list.

Default: 20

orderstring
The 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?