AdminGetInventoryItemsParams

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

constructor

Parameters

argsunknown[]Required

---

Properties

expandstring

Comma-separated relations that should be expanded in the returned data.

fieldsstring

Comma-separated fields that should be included in the returned data.

heightnumber | NumericalComparisonOperator

Number filters to apply to inventory items' height field.

hs_codestring | string[] | StringComparisonOperator

String filters to apply to inventory items' hs_code field.

idstring | string[]

IDs to filter inventory items by.

lengthnumber | NumericalComparisonOperator

Number filters to apply to inventory items' length field.

limitnumber

Limit the number of items returned in the list.

Default: 20

location_idstring | string[]

Location IDs to filter inventory items by.

materialstring | string[]

Materials to filter inventory items by.

mid_codestring | string[]

MID codes to filter inventory items by.

offsetnumber

The number of items to skip when retrieving a list.

Default: 0

origin_countrystring | string[]

Origin countries to filter inventory items by.

qstring

Search terms to search inventory items' sku, title, and description.

requires_shippingboolean

Filter inventory items by whether they require shipping.

skustring | string[]

SKUs to filter inventory items by.

weightnumber | NumericalComparisonOperator

Number filters to apply to inventory items' weight field.

widthnumber | NumericalComparisonOperator

Number filters to apply to inventory items' width field.