# Filters
To filter the results of a query on the return 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](#filterable-fields-and-allowed-operators) for the full list), like in the generic example below:
```json
{
"{{query_type}}": { ... },
"filter": {
"return": {
"date_from": "...",
"date_to": "...",
"date_field": "...",
"skus_count": {
"gte": ...
}
// ...
},
"return_line_items": {
"quantity": {
"lt": ...
},
"restocked_at": {
"gt": "..."
}
},
"customer": {
"email": {
"not_in": [
"...",
"..."
// ...
]
}
// ...
}
// ...
}
}
```
{% hint style="info" %}
Please find more information on how filters work [here](https://app.gitbook.com/s/ASSiAvbL4nFnkl8plQy2/getting-started/filters).
{% endhint %}
## 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 return resource by, and the associated allowed values and valid operators.
#### `customer` field
| Attribute | Type | Values |
| ----------------- | ------ | --------------------------------------------------------------------------------------- |
| **`ids`** | Object | One of:
"in": \["..."]
"not\_in": \["..."]
|
| **`emails`** | Object | One of:
"in": \["..."]
"not\_in": \["..."]
|
| **`group_names`** | Object | One of:
"in": \["..."]
"not\_in": \["..."]
|
#### `destination_address` field
| Attribute | Type | Values |
| ------------------- | ------- | --------------------------------------------------------------------------------------- |
| **`business`** | Boolean | One of:
true
false
|
| **`cities`** | Object | One of:
"in": \["..."]
"not\_in": \["..."]
|
| **`country_codes`** | Object | One of:
"in": \["..."]
"not\_in": \["..."]
|
| **`geocoded`** | Boolean | One of:
true
false
|
| **`localized`** | Boolean | One of:
true
false
|
| **`state_codes`** | Object | One of:
"in": \["..."]
"not\_in": \["..."]
|
| **`zip_codes`** | Object | One of:
"in": \["..."]
"not\_in": \["..."]
|
#### `origin_address` field
| Attribute | Type | Values |
| ------------------- | ------- | --------------------------------------------------------------------------------------- |
| **`business`** | Boolean | One of:
true
false
|
| **`cities`** | Object | One of:
"in": \["..."]
"not\_in": \["..."]
|
| **`country_codes`** | Object | One of:
"in": \["..."]
"not\_in": \["..."]
|
| **`geocoded`** | Boolean | One of:
true
false
|
| **`localized`** | Boolean | One of:
true
false
|
| **`state_codes`** | Object | One of:
"in": \["..."]
"not\_in": \["..."]
|
| **`zip_codes`** | Object | One of:
"in": \["..."]
"not\_in": \["..."]
|
#### `market` field
| Attribute | Type | Values |
| ------------- | ------ | --------------------------------------------------------------------------------------- |
| **`ids`** | Object | One of:
"in": \["..."]
"not\_in": \["..."]
|
| **`names`** | Object | One of:
"in": \["..."]
"not\_in": \["..."]
|
| **`numbers`** | Object | One of:
"in": \[...]
"not\_in": \[...]
|
#### `return` field
| Attribute | Type | Values |
| ------------------------ | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **`date_from`** | String | e.g.: 2022-07-06T21:41:03Z
No more than 365 days before date\_to. Default is 30 day before the current day, beginning of day.
|
| **`date_to`** | String | e.g.: 2022-07-06T21:41:03Z
No more than 365 days after date\_from. Default is the current day, end of day.
|
| **`date_field`** | String | One of:
current\_date
approved\_at
archived\_at
cancelled\_at
created\_at
received\_at
rejected\_at
shipped\_at
updated\_at
restocked\_at
Default is current\_date.
|
| **`aggregated_details`** | Object | `"query": "..."` |
| **`approved_at`** | Object | One of:
"eq": "..."
"ne": "..."
"gt": "..."
"gte": "..."
"lt": "..."
"lte": "..."
"gt\_lt": \["..."]
"gte\_lte": \["..."]
"gte\_lt": \["..."]
"gt\_lte": \["..."]
|
| **`archived_at`** | Object | One of:
"eq": "..."
"ne": "..."
"gt": "..."
"gte": "..."
"lt": "..."
"lte": "..."
"gt\_lt": \["..."]
"gte\_lte": \["..."]
"gte\_lt": \["..."]
"gt\_lte": \["..."]
|
| **`archived`** | Boolean | One of:
true
false
|
| **`cancelled_at`** | Object | One of:
"eq": "..."
"ne": "..."
"gt": "..."
"gte": "..."
"lt": "..."
"lte": "..."
"gt\_lt": \["..."]
"gte\_lte": \["..."]
"gte\_lt": \["..."]
"gt\_lte": \["..."]
|
| **`created_at`** | Object | One of:
"eq": "..."
"ne": "..."
"gt": "..."
"gte": "..."
"lt": "..."
"lte": "..."
"gt\_lt": \["..."]
"gte\_lte": \["..."]
"gte\_lt": \["..."]
"gt\_lte": \["..."]
|
| **`numbers`** | Object | One of:
"in": \["..."]
"not\_in": \["..."]
|
| **`received_at`** | Object | One of:
"eq": "..."
"ne": "..."
"gt": "..."
"gte": "..."
"lt": "..."
"lte": "..."
"gt\_lt": \["..."]
"gte\_lte": \["..."]
"gte\_lt": \["..."]
"gt\_lte": \["..."]
|
| **`references`** | Object | One of:
"in": \["..."]
"not\_in": \["..."]
|
| **`reference_origins`** | Object | One of:
"in": \["..."]
"not\_in": \["..."]
|
| **`rejected_at`** | Object | One of:
"eq": "..."
"ne": "..."
"gt": "..."
"gte": "..."
"lt": "..."
"lte": "..."
"gt\_lt": \["..."]
"gte\_lte": \["..."]
"gte\_lt": \["..."]
"gt\_lte": \["..."]
|
| **`shipped_at`** | Object | One of:
"eq": "..."
"ne": "..."
"gt": "..."
"gte": "..."
"lt": "..."
"lte": "..."
"gt\_lt": \["..."]
"gte\_lte": \["..."]
"gte\_lt": \["..."]
"gt\_lte": \["..."]
|
| **`statuses`** | Object | One of:
"in": \["..."]
"not\_in": \["..."]
|
| **`updated_at`** | Object | One of:
"eq": "..."
"ne": "..."
"gt": "..."
"gte": "..."
"lt": "..."
"lte": "..."
"gt\_lt": \["..."]
"gte\_lte": \["..."]
"gte\_lt": \["..."]
"gt\_lte": \["..."]
|
| **`current_date`** | Object | One of:
"eq": "..."
"ne": "..."
"gt": "..."
"gte": "..."
"lt": "..."
"lte": "..."
"gt\_lt": \["..."]
"gte\_lte": \["..."]
"gte\_lt": \["..."]
"gt\_lte": \["..."]
|
| **`ids`** | Object | One of:
"in": \["..."]
"not\_in": \["..."]
|
| **`order_ids`** | Object | One of:
"in": \["..."]
"not\_in": \["..."]
|
| **`skus_count`** | Object | One of:
"eq": ...
"ne": ...
"gt": ...
"gte": ...
"lt": ...
"lte": ...
"gt\_lt": \[...]
"gte\_lte": \[...]
"gte\_lt": \[...]
"gt\_lte": \[...]
|
| **`currency_codes`** | Object | One of:
"in": \["..."]
"not\_in": \["..."]
|
#### `return_line_items` field
| Attribute | Type | Values |
| ---------------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **`created_at`** | Object | One of:
"eq": "..."
"ne": "..."
"gt": "..."
"gte": "..."
"lt": "..."
"lte": "..."
"gt\_lt": \["..."]
"gte\_lte": \["..."]
"gte\_lt": \["..."]
"gt\_lte": \["..."]
|
| **`quantity`** | Object | One of:
"eq": ...
"ne": ...
"gt": ...
"gte": ...
"lt": ...
"lte": ...
"gt\_lt": \[...]
"gte\_lte": \[...]
"gte\_lt": \[...]
"gt\_lte": \[...]
|
| **`restocked_at`** | Object | One of:
"eq": "..."
"ne": "..."
"gt": "..."
"gte": "..."
"lt": "..."
"lte": "..."
"gt\_lt": \["..."]
"gte\_lte": \["..."]
"gte\_lt": \["..."]
"gt\_lte": \["..."]
|
| **`updated_at`** | Object | One of:
"eq": "..."
"ne": "..."
"gt": "..."
"gte": "..."
"lt": "..."
"lte": "..."
"gt\_lt": \["..."]
"gte\_lte": \["..."]
"gte\_lt": \["..."]
"gt\_lte": \["..."]
|
| **`line_item_ids`** | Object | One of:
"in": \["..."]
"not\_in": \["..."]
|
| **`line_item_names`** | Object | One of:
"in": \["..."]
"not\_in": \["..."]
|
| **`line_item_codes`** | Object | One of:
"in": \["..."]
"not\_in": \["..."]
|
| **`line_item_item_types`** | Object | One of:
"in": \["..."]
"not\_in": \["..."]
|
| **`line_item_total_amount`** | Object | One of:
"eq": ...
"ne": ...
"gt": ...
"gte": ...
"lt": ...
"lte": ...
"gt\_lt": \[...]
"gte\_lte": \[...]
"gte\_lt": \[...]
"gt\_lte": \[...]
|
| **`line_item_tax_amount`** | Object | One of:
"eq": ...
"ne": ...
"gt": ...
"gte": ...
"lt": ...
"lte": ...
"gt\_lt": \[...]
"gte\_lte": \[...]
"gte\_lt": \[...]
"gt\_lte": \[...]
|
| **`line_item_tax_rate`** | Object | One of:
"eq": ...
"ne": ...
"gt": ...
"gte": ...
"lt": ...
"lte": ...
"gt\_lt": \[...]
"gte\_lte": \[...]
"gte\_lt": \[...]
"gt\_lte": \[...]
|
| **`line_item_updated_at`** | Object | One of:
"eq": "..."
"ne": "..."
"gt": "..."
"gte": "..."
"lt": "..."
"lte": "..."
"gt\_lt": \["..."]
"gte\_lte": \["..."]
"gte\_lt": \["..."]
"gt\_lte": \["..."]
|
#### `stock_location` field
| Attribute | Type | Values |
| ----------------------- | ------ | --------------------------------------------------------------------------------------- |
| **`ids`** | Object | One of:
"in": \["..."]
"not\_in": \["..."]
|
| **`names`** | Object | One of:
"in": \["..."]
"not\_in": \["..."]
|
| **`references`** | Object | One of:
"in": \["..."]
"not\_in": \["..."]
|
| **`reference_origins`** | Object | One of:
"in": \["..."]
"not\_in": \["..."]
|
#### `tags` field
| Attribute | Type | Values |
| ----------- | ------ | --------------------------------------------------------------------------------------- |
| **`ids`** | Object | One of:
"in": \["..."]
"not\_in": \["..."]
|
| **`names`** | Object | One of:
"in": \["..."]
"not\_in": \["..."]
|