AdminGetPriceListPaginationParams

Parameters used to filter and configure the pagination of the retrieved price lists.

Properties

offsetnumber

The number of items to skip when retrieving a list.

Default: 0

limitnumber

Limit the number of items returned in the list.

Default: 10

expandstring

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

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

idstring

IDs to filter price lists by.

qstring

Search terms to search price lists' description, name, and customer group's name.

statusPriceListStatus[]

Statuses to filter price lists by.

namestring

Name to filter price lists by.

customer_groupsstring[]

Filter price lists by their associated customer groups.

descriptionstring

Description to filter price lists by.

typePriceListType[]

Types to filter price lists by.

created_atDateComparisonOperator

Date filters to apply on the price lists' created_at date.

updated_atDateComparisonOperator

Date filters to apply on the price lists' updated_at date.

deleted_atDateComparisonOperator

Date filters to apply on the price lists' deleted_at date.