AdminGetProductsVariantsParams

Properties

idstring | string[]

IDs to filter product variants by.

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.

expandstring

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

offsetnumber

The number of items to skip when retrieving a list.

Default: 0

limitnumber

Limit the number of items returned in the list.

Default: 100

qstring

Search term to search product variants' title, sku, and products' title.

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

inventory_quantitynumber | NumericalComparisonOperator

Number filters to apply on product variants' inventory_quantity field.

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.

created_atDateComparisonOperator

Date filters to apply on the product variants' created_at date.

updated_atDateComparisonOperator

Date filters to apply on the product variants' updated_at date.