Skip to main content
GET
/
commerce
/
catalog
/
admin
/
facets
/
category
/
{categoryId}
Error
A valid request URL is required to generate request examples
{
  "configured": [
    {
      "facetId": 123,
      "source": {
        "id": "<string>",
        "type": "<string>",
        "name": "<string>",
        "dataType": "<string>",
        "allowsRangeQuery": true
      },
      "facetType": "<string>",
      "order": 123,
      "categoryId": 123,
      "categoryCode": "<string>",
      "valueSortType": "<string>",
      "overrideFacetId": 123,
      "isHidden": true,
      "validity": {
        "isValid": true,
        "reasonCode": "<string>"
      },
      "rangeQueries": [
        {
          "rangeValueStart": "<unknown>",
          "rangeValueEnd": "<unknown>"
        }
      ],
      "auditInfo": {
        "updateDate": "2023-11-07T05:31:56Z",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "createBy": "<string>"
      }
    }
  ],
  "available": [
    {
      "id": "<string>",
      "type": "<string>",
      "name": "<string>",
      "dataType": "<string>",
      "allowsRangeQuery": true
    }
  ]
}

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

categoryId
integer<int32>
required

Query Parameters

includeAvailable
boolean
validate
boolean
responseFields
string

limits which fields are returned in the response body

Response

Success

configured
object[] | null

Facets that are configured

available
object[] | null

Facets that are not configured, but COULD BE!