Skip to main content
Skip to main content

AdminGetPriceListPaginationParams

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

constructor


Properties

Date filters to apply on the price lists' created_at date.
customer_groupsstring[]
Filter price lists by their associated customer groups.
Date filters to apply on the price lists' deleted_at date.
descriptionstring
Description to filter price lists by.
expandstring
Comma-separated relations that should be expanded in the returned data.
idstring
IDs to filter price lists by.
limitnumber
Limit the number of items returned in the list.

Default: 10

namestring
Name to filter price lists by.
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 terms to search price lists' description, name, and customer group's name.
Statuses to filter price lists by.
Types to filter price lists by.
Date filters to apply on the price lists' updated_at date.
Was this section helpful?