AdminGetSalesChannelsParams
Parameters used to filter and configure the pagination of the retrieved sales channels.
Properties
idstringID to filter sales channels by.
qstringSearch term to search sales channels' names and descriptions.
namestringName to filter sales channels by.
descriptionstringDescription to filter sales channels by.
created_atDateComparisonOperatorDate filters to apply on sales channels' created_at field.
created_atDateComparisonOperatorcreated_at field.updated_atDateComparisonOperatorDate filters to apply on sales channels' updated_at field.
updated_atDateComparisonOperatorupdated_at field.deleted_atDateComparisonOperatorDate filters to apply on sales channels' deleted_at field.
deleted_atDateComparisonOperatordeleted_at field.orderstringThe field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with
-.expandstringComma-separated relations that should be expanded in the returned data.
fieldsstringComma-separated fields that should be included in the returned data.
if a field is prefixed with
+ it will be added to the default fields, using - will remove it from the default fields.
without prefix it will replace the entire default fields.offsetnumberThe number of items to skip when retrieving a list.
Default: 0
limitnumberLimit the number of items returned in the list.
Default: 20
Was this section helpful?