AdminGetPriceListPaginationParams
Parameters used to filter and configure the pagination of the retrieved price lists.
Properties
offset
numberThe number of items to skip when retrieving a list.
Default: 0
limit
numberLimit the number of items returned in the list.
Default: 10
expand
stringComma-separated relations that should be expanded in the returned data.
order
stringThe field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with
-
.id
stringIDs to filter price lists by.
q
stringSearch terms to search price lists' description, name, and customer group's name.
status
PriceListStatus[]Statuses to filter price lists by.
status
PriceListStatus[]name
stringName to filter price lists by.
customer_groups
string[]Filter price lists by their associated customer groups.
description
stringDescription to filter price lists by.
type
PriceListType[]Types to filter price lists by.
type
PriceListType[]created_at
DateComparisonOperatorDate filters to apply on the price lists' created_at
date.
created_at
DateComparisonOperatorcreated_at
date.updated_at
DateComparisonOperatorDate filters to apply on the price lists' updated_at
date.
updated_at
DateComparisonOperatorupdated_at
date.deleted_at
DateComparisonOperatorDate filters to apply on the price lists' deleted_at
date.
deleted_at
DateComparisonOperatordeleted_at
date.Was this section helpful?