Skip to main content
Skip to main content

AdminGetSalesChannelsParams

Parameters used to filter and configure the pagination of the retrieved sales channels.

Properties

idstring
ID to filter sales channels by.
qstring
Search term to search sales channels' names and descriptions.
namestring
Name to filter sales channels by.
descriptionstring
Description to filter sales channels by.
Date filters to apply on sales channels' created_at field.
Date filters to apply on sales channels' updated_at field.
Date filters to apply on sales channels' deleted_at field.
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 -.
expandstring
Comma-separated relations that should be expanded in the returned data.
fieldsstring
Comma-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.
offsetnumber
The number of items to skip when retrieving a list.

Default: 0

limitnumber
Limit the number of items returned in the list.

Default: 20

Was this section helpful?