ELelasticpath
Rules

Validate catalog rules for a given context

Validates catalog rules for a given context and returns a list of matching catalog rules.

post/catalogs/rules/validate

Request

Query parameters

page[limit]integer

The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the page length store setting is used.

page[offset]integer

The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.

Request body

Example request

{
  "data": {
    "search_profile_slug": "vip-search"
  }
}

Response

List of matching catalog rules

Example response

{
  "data": [
    {
      "id": "8dbb35b2-ef04-477e-974d-e5f3abe6faae",
      "attributes": {
        "name": "rule-123",
        "description": "Catalog Rule for most favored customers",
        "schedules": [
          {
            "valid_from": "2020-09-22T09:00:00",
            "valid_to": "2020-09-22T09:00:00"
          }
        ],
        "catalog_id": "d09b4e16-08a5-4f42-817c-6e0d98acbb63",
        "created_at": "2020-09-22T09:00:00",
        "updated_at": "2020-09-22T09:00:00",
        "search_profile_slug": "vip-search"
      },
      "type": "catalog_rule",
      "meta": {
        "similarity_score": 100,
        "resolved_for_shopper": true
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.