# /revolve/products/filters

`POST /api/revolve/products/filters`

Price: 20 credits

List the filters REVOLVE offers on a category or designer listing, with every value that listing accepts: designers, sizes, price brackets, colours, in-stock, pre-order, the per-vertical parameters such as heel height, rise and stretch, and the attribute groups that only apply to some categories (length, cut, neckline, sleeve, sleeve style, pattern). Each group states which product search parameter its values belong to. Country, currency and language control the language the human labels come back in.

## How to use it

Discover the valid filter values for a REVOLVE listing before searching or browsing it. Each group has name, parameter (the field to pass to the REVOLVE product search, category products or brand products endpoints), field (the upstream parameter the group belongs to) and values (value plus its human label). Group names and values stay in English under every language; only the human labels of the values are localised. Groups whose parameter is facets are category-specific attributes; pass their values through the facets field. A listing can offer two colour groups — one under the color parameter and one under facets — because REVOLVE runs two colour vocabularies with different values; tell them apart by field. Which groups a listing offers differs by listing: designer listings offer no in_stock and no preorder group, and a value or group that listing does not offer is rejected rather than ignored.

## Parameters

- `access-token` (string, required)

## Request body

- `timeout` (integer) — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
- `country` (string) — Shipping country the catalog is priced for (default: "US"; one of: "US", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AT", "AU", "AW", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BM", "BN", "BO", "BR", "BS", "BT", "BV", "BW", "BZ", "CA", "CC", "CD", "CF", "CH", "CK", "CL", "CM", "CN", "CO", "CR", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IN", "IO", "IS", "IT", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LS", "LT", "LU", "LV", "MA", "MC", "MD", "ME", "MG", "MK", "ML", "MM", "MN", "MO", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PT", "PY", "QA", "RE", "RO", "RS", "RW", "SA", "SB", "SC", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SR", "ST", "SV", "SX", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UY", "UZ", "VA", "VC", "VE", "VG", "VN", "VU", "WF", "WS", "YT", "ZA", "ZM")
- `currency` (string) — Currency prices are returned in (default: "USD"; one of: "USD", "AED", "ANG", "ARS", "AUD", "BRL", "BSD", "CAD", "CHF", "CLP", "CNY", "COP", "CZK", "DKK", "EUR", "FJD", "GBP", "GTQ", "HKD", "HNL", "HUF", "IDR", "ILS", "INR", "ISK", "JMD", "JPY", "KRW", "KWD", "KZT", "LBP", "LKR", "MAD", "MXN", "MYR", "NOK", "NZD", "PAB", "PEN", "PHP", "PKR", "PLN", "RON", "RSD", "SAR", "SEK", "SGD", "THB", "TND", "TRY", "TTD", "TWD", "UAH", "VND", "XAF", "XCD", "ZAR")
- `language` (string) — Content language (default: "en"; one of: "en", "de", "es", "fr", "it", "pt", "ru", "ar", "ja", "ko", "zh", "ch")
- `count` (integer, required) — Max number of filter groups to return (min: 1)
- `listing` (string, required) — REVOLVE category or designer code, or a listing page URL containing it (examples: "a8e981", "https://www.revolve.com/dresses/br/a8e981/"; minLength: 1)

## Response

### 200 — Successful Response

- `@type` (string) (default: "RevolveFilterGroup")
- `name` (string, required)
- `parameter` (string, required)
- `field` (string, required)
- `values` (array) (default: [])
  - `@type` (string) (default: "RevolveFilterValue")
  - `value` (string, required)
  - `name` (string, nullable)

## Errors

### 422 — Validation Error

The request body did not validate

What to do: Check the fields against this schema. A URN with the wrong prefix is the most common cause.

- `detail` (array)
  - `loc` (array, required)
  - `msg` (string, required)
  - `type` (string, required)
  - `input` (any)
  - `ctx` (object)

### 408

The request ran past its time limit

What to do: Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.

### 412

Listing not found (well-formed but nonexistent category or designer code)

What to do: Retrying will not help: either the entity does not exist, or the input points at a different one.

### 429

Too many requests: a rate limit or a usage window is exhausted

What to do: When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.

### 500

Something broke on our side

What to do: Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.

### 529

Rate limit reached, or the endpoint is overloaded

What to do: Wait at least 30 seconds, then retry.

## Response envelope

Success: Array of objects (may be empty if no results)

Error: Error may coexist with partial results if it occurs mid-execution. Check X-Error header and status code.

Every response carries these headers:

- `X-Error` — Error message text (present only on error)
- `X-Request-ID` — Unique request identifier
- `X-Execution-Time` — Execution time in seconds
- `X-Result-Count` — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
- `X-Total-Available-Results` — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
- `X-Warning` — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
- `X-Retry-After` — Seconds to wait before retrying. Present only on 429.