Skip to main content
Skip to main content

StoreGetCustomersCustomerOrdersParams

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

Properties

limitnumberRequired
Limit the number of items returned in the list.

Default: 10

offsetnumberRequired
The number of items to skip when retrieving a list.

Default: 0

fieldsstring
Comma-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.
expandstring
Comma-separated relations that should be expanded in the returned data.
idstring
ID to filter orders by.
qstring
Search 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.
fulfillment_statusFulfillmentStatus[]
Fulfillment statuses to filter orders by.
payment_statusPaymentStatus[]
Payment statuses to filter orders by.
display_idstring
Display ID to filter orders by.
cart_idstring
Cart ID to filter orders by.
emailstring
Email to filter orders by.
region_idstring
Region ID to filter orders by.
currency_codestring
Currency code to filter orders by.
tax_ratestring
Tax rate to filter orders by.
Date filters to apply on the orders' created_at date.
Date filters to apply on the orders' updated_at date.
Date filters to apply on the orders' canceled_at date.
Was this section helpful?