API reference
A valid request URL is required to generate request examples{
"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>"
}Add Facet
Adds a new Facet to a category in a catalog.
A valid request URL is required to generate request examples{
"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>"
}Documentation Index
Fetch the complete documentation index at: https://docs.kibocommerce.com/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
JWT Authorization header using the Bearer scheme.
Query Parameters
limits which fields are returned in the response body
Body
The definition of a Facet
Show child attributes
Show child attributes
The category that the facet is being configured at
The category that the facet is being configured at
The unique identifier for the facet definition
The type of facet. Allowable values are: Value, RangeQuery Must be a valid value for DataType defined in FacetTypeConst.
Indicates whether the facet is hidden for the given category
Used to order the display of the facets within a section
The ID of a parent category's facet being overriden
List of ranges if the Facet is of type Range
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Determines how the facet values will be sorted in the store. Must be a valid value for DataType defined in FacetValueSortTypeConst. Allowable values are: CountAscending, CountDescending, ValuesAscending, ValuesDescending, AttributeDefinition, AttributeDefinitionDescending. The default if no value is specified will be CountDescending.
Response
Success
The definition of a Facet
Show child attributes
Show child attributes
The category that the facet is being configured at
The category that the facet is being configured at
The unique identifier for the facet definition
The type of facet. Allowable values are: Value, RangeQuery Must be a valid value for DataType defined in FacetTypeConst.
Indicates whether the facet is hidden for the given category
Used to order the display of the facets within a section
The ID of a parent category's facet being overriden
List of ranges if the Facet is of type Range
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Determines how the facet values will be sorted in the store. Must be a valid value for DataType defined in FacetValueSortTypeConst. Allowable values are: CountAscending, CountDescending, ValuesAscending, ValuesDescending, AttributeDefinition, AttributeDefinitionDescending. The default if no value is specified will be CountDescending.