Facet

A filter facet for catalog search results.

B2BCatalogERPProcurementRequisitionsSAPSupply Chain

Properties

Name Type Description
name string Facet name.
values array Facet values with counts.
View JSON Schema on GitHub

JSON Schema

catalog-shop-api-facet-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/ariba-guided-buying/refs/heads/main/json-schema/catalog-shop-api-facet-schema.json",
  "title": "Facet",
  "description": "A filter facet for catalog search results.",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Facet name.",
      "example": "Category"
    },
    "values": {
      "type": "array",
      "description": "Facet values with counts.",
      "items": {
        "$ref": "#/components/schemas/FacetValue"
      }
    }
  }
}