AdminGetPriceListsPriceListProductsParams

Parameters used to filter and configure the pagination of the retrieved products associated with a price list.

Properties

idstring | string[]

ID to filter products by.

qstring

Search term to search products' title, description, product variant's title and sku, and product collection's title.

statusProductStatus[]

Statuses to filter products by.

collection_idstring[]

Filter products by their associated collection ID.

tagsstring[]

Tags to filter products by.

titlestring

Title to filter products by.

descriptionstring

Description to filter products by.

handlestring

Handle to filter products by.

is_giftcardboolean

Filter products by whether they're gift cards.

typestring

Type to filter products by.

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

created_atDateComparisonOperator

Date filters to apply on the products' created_at date.

updated_atDateComparisonOperator

Date filters to apply on the products' updated_at date.

deleted_atDateComparisonOperator

Date filters to apply on the products' deleted_at date.

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 products returned in the list. Default is 50.

Default: 20