SAP Commerce Cloud · Schema

ProductSearchPage

B2BB2CCommerceCustomer ExperienceEcommerceOmnichannelRetail

Properties

Name Type Description
products array
pagination object
sorts array
freeTextSearch string Search query that was executed
currentQuery object
facets array Search facets for filtering
breadcrumbs array
View JSON Schema on GitHub

JSON Schema

sap-commerce-cloud-productsearchpage-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ProductSearchPage",
  "title": "ProductSearchPage",
  "type": "object",
  "properties": {
    "products": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Product"
      }
    },
    "pagination": {
      "$ref": "#/components/schemas/Pagination"
    },
    "sorts": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Sort"
      }
    },
    "freeTextSearch": {
      "type": "string",
      "description": "Search query that was executed"
    },
    "currentQuery": {
      "type": "object",
      "properties": {
        "query": {
          "type": "object",
          "properties": {
            "value": {
              "type": "string"
            }
          }
        },
        "url": {
          "type": "string"
        }
      }
    },
    "facets": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Facet"
      },
      "description": "Search facets for filtering"
    },
    "breadcrumbs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Breadcrumb"
      }
    }
  }
}