AdminGetOrdersParams

Parameters used to filter and configure the pagination of the retrieved orders.

Properties

canceled_atDateComparisonOperator

Date filters to apply on the orders' canceled_at date.

cart_idstring

Cart ID to filter orders by.

created_atDateComparisonOperator

Date filters to apply on the orders' created_at date.

currency_codestring

Currency code to filter orders by.

customer_idstring

Customer ID to filter orders by.

display_idstring

Display ID to filter orders by.

emailstring

Email to filter orders 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.

fulfillment_statusstring[]

Fulfillment statuses to filter orders by.

idstring

ID to filter orders by.

limitnumberRequired

Limit the number of items returned in the list.

Default: 50

offsetnumberRequired

The number of items to skip when retrieving a list.

Default: 0

payment_statusstring[]

Payment statuses to filter orders by.

qstring

Search term to search orders' shipping address, first name, email, and display ID.

region_idstring | string[]

Regions to filter orders by.

sales_channel_idstring[]

Sales channel IDs to filter orders by.

statusstring[]

Statuses to filter orders by.

tax_ratestring

Tax rate to filter orders by.

updated_atDateComparisonOperator

Date filters to apply on the orders' updated_at date.