AdminGetOrdersParams
Parameters used to filter and configure the pagination of the retrieved orders.
Properties
offsetnumberRequiredThe number of items to skip when retrieving a list.
Default: 0
limitnumberRequiredLimit the number of items returned in the list.
Default: 50
expandstringComma-separated relations that should be expanded in the returned data.
fieldsstringComma-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.orderstringThe field to sort retrieved orders by. By default, the sort order is ascending.
To change the order to descending, prefix the field name with
-.qstringSearch term to search orders' shipping address, first name, email, and display ID.
idstringID to filter orders by.
statusstring[]Statuses to filter orders by.
fulfillment_statusstring[]Fulfillment statuses to filter orders by.
payment_statusstring[]Payment statuses to filter orders by.
display_idstringDisplay ID to filter orders by.
cart_idstringCart ID to filter orders by.
customer_idstringCustomer ID to filter orders by.
emailstringEmail to filter orders by.
region_idstring | string[]Regions to filter orders by.
currency_codestringCurrency code to filter orders by.
tax_ratestringTax rate to filter orders by.
sales_channel_idstring[]Sales channel IDs to filter orders by.
canceled_atDateComparisonOperatorDate filters to apply on the orders' canceled_at date.
canceled_atDateComparisonOperatorcanceled_at date.created_atDateComparisonOperatorDate filters to apply on the orders' created_at date.
created_atDateComparisonOperatorcreated_at date.updated_atDateComparisonOperatorDate filters to apply on the orders' updated_at date.
updated_atDateComparisonOperatorupdated_at date.Was this section helpful?