AdminGetPriceListsPriceListProductsParams

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

constructor

Parameters

argsunknown[]Required

---

Properties

collection_idstring[]

Filter products by their associated collection ID.

created_atDateComparisonOperator

Date filters to apply on the products' created_at date.

deleted_atDateComparisonOperator

Date filters to apply on the products' deleted_at date.

descriptionstring

Description to filter products by.

expandstring

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

fieldsstring

Comma-separated fields that should be included in the returned data.

handlestring

Handle to filter products by.

idstring

ID to filter products by.

is_giftcardstring

Filter products by whether they're gift cards.

limitnumber

Limit the number of products returned in the list. Default is 50.

Default: 20

offsetnumber

The number of items to skip when retrieving a list.

Default: 0

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

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.

tagsstring[]

Tags to filter products by.

titlestring

Title to filter products by.

typestring

Type to filter products by.

updated_atDateComparisonOperator

Date filters to apply on the products' updated_at date.