AdminGetOrdersParams
Parameters used to filter and configure the pagination of the retrieved orders.
constructor
Properties
canceled_atDateComparisonOperatorDate filters to apply on the orders' canceled_at date.
canceled_atDateComparisonOperatorcanceled_at date.cart_idstringCart ID to filter orders by.
created_atDateComparisonOperatorDate filters to apply on the orders' created_at date.
created_atDateComparisonOperatorcreated_at date.currency_codestringCurrency code to filter orders by.
customer_idstringCustomer ID to filter orders by.
display_idstringDisplay ID to filter orders by.
emailstringEmail to filter orders by.
expandstringComma-separated relations that should be expanded in the returned data.
fieldsstringComma-separated fields that should be included in the returned data.
fulfillment_statusstring[]Fulfillment statuses to filter orders by.
idstringID to filter orders by.
limitnumberRequiredLimit the number of items returned in the list.
Default: 50
offsetnumberRequiredThe number of items to skip when retrieving a list.
Default: 0
payment_statusstring[]Payment statuses to filter orders by.
qstringSearch 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_ratestringTax rate to filter orders by.
updated_atDateComparisonOperatorDate filters to apply on the orders' updated_at date.
updated_atDateComparisonOperatorupdated_at date.Was this section helpful?