Skip to main content
GET
/
api
/
v1
/
omni
/
:app_id
/
:store_group
/
:market
/
:locale
/
facets
/
{facet_keys}
Error
A valid request URL is required to generate request examples
{
  "data": {
    "attributes": {},
    "brands": [
      {
        "id": "<string>",
        "name": "<string>",
        "slug": "<string>"
      }
    ],
    "categories": [
      {
        "attributes": {},
        "full_path_name": [
          "<string>"
        ],
        "id": "<string>",
        "name": "<string>",
        "parent_id": "<string>",
        "redirects": {},
        "sort_order": 123,
        "status": "<string>",
        "sub_categories": "<array>",
        "uri": "<string>"
      }
    ],
    "collections": [
      {
        "children": "<array>",
        "id": "<string>",
        "parent_id": "<string>",
        "title": "<string>",
        "uri": "<string>"
      }
    ],
    "price_range": {
      "max": 123,
      "min": 123
    },
    "series": [
      {
        "id": "<string>",
        "name": "<string>",
        "slug": "<string>"
      }
    ],
    "tags": [
      {
        "id": "<string>",
        "key": "<string>",
        "name": "<string>"
      }
    ],
    "variant_names": [
      "<string>"
    ]
  }
}

Authorizations

Authorization
string
header
required

Type "Bearer" followed by a space and a token.

Path Parameters

app_id
string
required

App ID

store_group
string
required

Store group slug

market
string
required

Market slug

locale
string
required

Locale for translations

facet_keys
string
required

Comma-separated list of facet keys (e.g., attributes,attributes[color|size],variant_names,price,tags,collections,categories,brands,series)

Query Parameters

category_ids
string[]

Comma-separated list of category UUIDs to filter products

collection_ids
string[]

Comma-separated list of collection UUIDs to filter products

skus
string[]

Comma-separated list of product SKUs to filter products

Full text search on products

include_variants
boolean

Include variant attributes in the response

only_available
boolean

Only include facets from available products/variants

include_child_category_products
boolean

Include products from child categories when filtering by category or category_id

Response

OK

data
object