---
title: "GetFacets"
method: GET
path: "/api/products/facets"
---

# GetFacets

`GET /api/products/facets`

## Request

- Base URL: `https://api.caddence.golf`
- URL: `https://api.caddence.golf/api/products/facets`
- Auth: none declared

## Query parameters

- `search` string, nullable: Search query
- `retailer` string, nullable: Filter by retailer
- `brand` string, nullable: Filter by brand
- `product_type` string, nullable: Filter by product type
- `category` string, nullable: Filter by category
- `hand` string, nullable: Filter by hand: LH or RH
- `loft` string, nullable: Filter by loft / club number
- `flex` string, nullable: Filter by flex
- `shaft_material` string, nullable: Filter by shaft material: steel, graphite
- `condition` string, nullable: Filter by condition
- `gender` string, nullable: Filter by gender: ladies, junior, mens
- `min_price` number, nullable: Minimum price
- `max_price` number, nullable: Maximum price
- `min_retailers` integer, nullable: Minimum number of retailers
- `include_out_of_stock` boolean: Include out-of-stock products (default true)

## Response `200`

Request fulfilled, document follows

- FacetsResponse
  - `total` integer, required: Products matching all filters
  - `brands` FacetBucket[], required
    - `value` string, required
    - `count` integer, required
  - `product_types` FacetBucket[], required
    - `value` string, required
    - `count` integer, required
  - `hands` FacetBucket[], required
    - `value` string, required
    - `count` integer, required
  - `flexes` FacetBucket[], required: Raw variant flex strings
    - `value` string, required
    - `count` integer, required
  - `shaft_materials` FacetBucket[], required
    - `value` string, required
    - `count` integer, required
  - `lofts` LoftFacetBucket[], required
    - `product_type` string, required
    - `loft` string, nullable
    - `club_number` string, nullable
    - `count` integer, required
  - `conditions` object, required: Products with new / used stock under the other filters
  - `price_min` number, nullable: Lowest current price, other filters on
  - `price_max` number, nullable: Highest current price, other filters on

## Other responses

- `400`: Bad request syntax or unsupported method

---

[API](https://skmtc.dev/caddence/apis/golf-product-api.md) · [All operations](https://skmtc.dev/caddence/apis/golf-product-api/llms.txt) · [OpenAPI document](https://skmtc.dev/caddence/apis/golf-product-api/revisions/adef6c56f7c0?raw)