AdminGetStockLocationsParams

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

Properties

qstring

Search term to search stock location names.

idstring | string[]

IDs to filter stock locations by.

namestring | string[]

Names to filter stock locations by.

address_idstring | string[]

Filter stock locations by the ID of their associated addresses.

sales_channel_idstring | string[]

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

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 -.

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