Skip to main content
Skip to main content

StoreGetCustomersCustomerOrdersParams

Parameters used to filter and configure the pagination of 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.
display_idstring
Display ID to filter orders by.
emailstring
Email to filter orders by.
expandstring
Comma-separated relations that should be expanded in the returned data.
fieldsstring
Comma-separated fields that should be included in the returned data.
fulfillment_statusFulfillmentStatus[]
Fulfillment statuses to filter orders by.
idstring
ID to filter orders by.
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

payment_statusPaymentStatus[]
Payment statuses 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.
region_idstring
Region ID to filter orders by.
statusOrderStatus[]
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?