AdminGetVariantsParams

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

Properties

qstring

Search term to search product variants' IDs.

limitnumber

Limit the number of items returned in the list.

Default: 20

offsetnumber

The number of items to skip when retrieving a list.

Default: 0

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 product variants by.

titlestring | string[]

Titles to filter product variants by.

inventory_quantitynumber | NumericalComparisonOperator

Number filters to apply on product variants' inventory_quantity field.

cart_idstring

Retrieve prices for a cart ID.

region_idstring

Retrieve prices for a region ID.

currency_codestring

Retrieve prices for a currency code.

customer_idstring

Retrieve prices for a customer ID.