AdminGetStockLocationsParams

Parameters used to filter and configure the pagination of the retrieved stock locations.

constructor

Parameters

argsunknown[]Required

---

Properties

address_idstring | string[]

Filter stock locations by the ID of their associated addresses.

expandstring

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

fieldsstring

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

idstring | string[]

IDs to filter stock locations by.

limitnumber

Limit the number of items returned in the list.

Default: 20

namestring | string[]

Names to filter stock locations by.

offsetnumber

The number of items to skip when retrieving a list.

Default: 0

sales_channel_idstring | string[]

Filter stock locations by the ID of their associated sales channels.