StoreGetCustomersCustomerOrdersParams
Parameters used to filter and configure the pagination of the retrieved orders.
constructor
Properties
canceled_at
DateComparisonOperatorDate filters to apply on the orders' canceled_at
date.
canceled_at
DateComparisonOperatorcanceled_at
date.cart_id
stringCart ID to filter orders by.
created_at
DateComparisonOperatorDate filters to apply on the orders' created_at
date.
created_at
DateComparisonOperatorcreated_at
date.currency_code
stringCurrency code to filter orders by.
display_id
stringDisplay ID to filter orders by.
email
stringEmail to filter orders by.
expand
stringComma-separated relations that should be expanded in the returned data.
fields
stringComma-separated fields that should be included in the returned data.
fulfillment_status
FulfillmentStatus[]Fulfillment statuses to filter orders by.
fulfillment_status
FulfillmentStatus[]id
stringID to filter orders by.
limit
numberRequiredLimit the number of items returned in the list.
Default: 10
offset
numberRequiredThe number of items to skip when retrieving a list.
Default: 0
payment_status
PaymentStatus[]Payment statuses to filter orders by.
payment_status
PaymentStatus[]q
stringSearch 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_id
stringRegion ID to filter orders by.
status
OrderStatus[]Statuses to filter orders by.
status
OrderStatus[]tax_rate
stringTax rate to filter orders by.
updated_at
DateComparisonOperatorDate filters to apply on the orders' updated_at
date.
updated_at
DateComparisonOperatorupdated_at
date.Was this section helpful?