AdminGetSalesChannelsParams

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

constructor

Parameters

argsunknown[]Required

---

Properties

created_atDateComparisonOperator

Date filters to apply on sales channels' created_at field.

deleted_atDateComparisonOperator

Date filters to apply on sales channels' deleted_at field.

descriptionstring

Description to filter sales channels by.

expandstring

Comma-separated relations that should be expanded in the returned data.

fieldsstring

Comma-separated fields that should be included in the returned data.

idstring

ID to filter sales channels by.

limitnumber

Limit the number of items returned in the list.

Default: 20

namestring

Name to filter sales channels 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 term to search sales channels' names and descriptions.

updated_atDateComparisonOperator

Date filters to apply on sales channels' updated_at field.