Skip to main content
Skip to main content

AdminListOrdersSelector

Filters to apply on the retrieved orders.

constructor


Properties

Date filters to apply on the orders' canceled_at date.
cart_idstring
Cart ID to filter orders by.
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.
fulfillment_statusstring[]
Fulfillment statuses to filter orders by.
idstring
ID to filter orders by.
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.
Date filters to apply on the orders' updated_at date.
Was this section helpful?