Get Facet Category List

Retrieves a list of configured, and optionally available, Facet configurations for the specified category.

GET /commerce/catalog/admin/facets/category

Error

A valid request URL is required to generate request examples

200

{
  "available": [
    {
      "allowsRangeQuery": true,
      "dataType": "<string>",
      "id": "<string>",
      "name": "<string>",
      "type": "<string>"
    }
  ],
  "configured": [
    {
      "auditInfo": {
        "createBy": "<string>",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "updateDate": "2023-11-07T05:31:56Z"
      },
      "categoryCode": "<string>",
      "categoryId": 123,
      "facetId": 123,
      "facetType": "<string>",
      "isHidden": true,
      "order": 123,
      "overrideFacetId": 123,
      "rangeQueries": [
        {
          "rangeValueEnd": null,
          "rangeValueStart": null
        }
      ],
      "source": {
        "allowsRangeQuery": true,
        "dataType": "<string>",
        "id": "<string>",
        "name": "<string>",
        "type": "<string>"
      },
      "validity": {
        "isValid": true,
        "reasonCode": "<string>"
      },
      "valueSortType": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Query Parameters

categoryId · integer<int32>

categoryCode · string

includeAvailable · boolean

validate · boolean

responseFields · string

limits which fields are returned in the response body

Response

200

application/json

OK

available · object[] | null

Facets that are not configured, but COULD BE!

Show child attributes

configured · object[] | null

Facets that are configured

Show child attributes