StoreGetVariantsParams

Parameters used to filter and configure the pagination of the retrieved product variants.

Properties

limitnumber

Limit the number of items returned in the list.

Default: 100

offsetnumber

The number of items to skip when retrieving a list.

Default: 0

idsstring

ID to filter the product variants by.

sales_channel_idstring

Filter product variants by the ID of their associated sales channel.

idstring | string[]

IDs to filter product variants by.

titlestring | string[]

Titles to filter product variants by.

inventory_quantitynumber | NumericalComparisonOperator

Number filters to apply on the product variants' inventory_quantity field.

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.

cart_idstring

Retrieve prices for a cart ID.

region_idstring

Retrieve prices for a region ID.

currency_codestring

Retrieve prices for a currency code.