Filters
A comprehensive list of the allowed fields values you can use to filter the results of the queries on the order resource
To filter the results of a query on the order resource add the filter
object to the request payload specifying the fields (and related attributes) you want to filter by and the operators you want to apply on each of them (see the related tables for the full list), like in the generic example below:
Please find more information on how filters work here.
Filterable fields and allowed operators
Please find below the full list of the fields (and related attributes) you can filter the results of the queries on the order resource by, and the associated allowed values and valid operators.
billing_address
field
billing_address
fieldAttribute | Type | Values |
---|---|---|
| Boolean | One of:
|
| Object | One of:
|
| Object | One of:
|
| Boolean | One of:
|
| Boolean | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
customer
field
customer
fieldAttribute | Type | Values |
---|---|---|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
line_items
field
line_items
fieldAttribute | Type | Values |
---|---|---|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object |
Line item options
field
options
fieldAttribute | Type | Values |
---|---|---|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
market
field
market
fieldAttribute | Type | Values |
---|---|---|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
order
field
order
fieldAttribute | Type | Values |
---|---|---|
| String | e.g.: |
| String | e.g.: |
| String | One of:
Default is |
| Boolean | One of:
|
| Boolean | One of:
|
| Boolean | One of:
|
| Boolean | One of:
|
| Boolean | One of:
|
| Boolean | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Boolean | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Boolean | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Boolean | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Boolean | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object |
|
payment_method
field
payment_method
fieldAttribute | Type | Values |
---|---|---|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Boolean | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
refunds
field
refunds
fieldAttribute | Type | Values |
---|---|---|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
shipping_address
field
shipping_address
fieldAttribute | Type | Values |
---|---|---|
| Boolean | One of:
|
| Object | One of:
|
| Object | One of:
|
| Boolean | One of:
|
| Boolean | One of:
|
| Object | One of:
|
| Object | One of:
|
shipments
field
shipments
fieldAttribute | Type | Values |
---|---|---|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
Shipment stock_location
field
stock_location
fieldAttribute | Type | Values |
---|---|---|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
Shipment shipping_method
field
shipping_method
fieldAttribute | Type | Values |
---|---|---|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
Shipment shipping_category
field
shipping_category
fieldAttribute | Type | Values |
---|---|---|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
| Object | One of:
|
Shipment tags
field
tags
fieldAttribute | Type | Values |
---|---|---|
| Object | One of:
|
| Object | One of:
|
tags
field
tags
fieldAttribute | Type | Values |
---|---|---|
| Object | One of:
|
| Object | One of:
|
Last updated