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

destination_address field

origin_address field

market field

return field

return_line_items field

stock_location field

tags field