StoreGetCustomersCustomerOrdersParams
Parameters used to filter and configure the pagination of the retrieved orders.
Properties
limitnumberRequiredLimit the number of items returned in the list.
Default: 10
offsetnumberRequiredThe number of items to skip when retrieving a list.
Default: 0
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.expandstringComma-separated relations that should be expanded in the returned data.
idstringID to filter orders by.
qstringSearch term to search orders' display ID, email, shipping address's first name, customer's first name, customer's last name, and customer's phone number.
statusOrderStatus[]Statuses to filter orders by.
statusOrderStatus[]fulfillment_statusFulfillmentStatus[]Fulfillment statuses to filter orders by.
fulfillment_statusFulfillmentStatus[]payment_statusPaymentStatus[]Payment statuses to filter orders by.
payment_statusPaymentStatus[]display_idstringDisplay ID to filter orders by.
cart_idstringCart ID to filter orders by.
emailstringEmail to filter orders by.
region_idstringRegion ID to filter orders by.
currency_codestringCurrency code to filter orders by.
tax_ratestringTax rate to filter orders by.
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.canceled_atDateComparisonOperatorDate filters to apply on the orders' canceled_at date.
canceled_atDateComparisonOperatorcanceled_at date.Was this section helpful?