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