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

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.

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

manage_inventoryboolean

Filter product variants by whether their inventory is managed or not.

allow_backorderboolean

Filter product variants by whether they are allowed to be backordered or not.

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.