Links

Filters

A comprehensive list of the allowed fields values you can use to filter the results of the queries on the return resource
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 for the full list), like in the generic example below:
{
"{{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": [
"...",
"..."
// ...
]
}
// ...
}
// ...
}
}
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 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.
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": ["..."]
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": [...]

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_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": ["..."]
Last modified 9mo ago