Rules

Gets all authorized catalog rules

Retrieves all authorized catalog rules.

Filtering

This endpoint supports filtering. For general filtering syntax, see Filtering. The following operators and attributes are supported.

Operator	Description	Supported Attributes	Example
eq	Equals. Checks if the values of two operands are equal. If they are, the condition is true.	id,catalog_id,account_ids,customer_ids,channels,tags,pricebook_ids,search_profile_slug	filter=eq(id,some-id)
in	Checks if the values are included in the specified string. If they are, the condition is true.	id,account_ids,customer_ids,channels,tags,pricebook_ids,search_profile_slug	filter=in(account_ids,some-id,another-id)

get/catalogs/rules

Request

Base URL
https://euwest.api.elasticpath.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/elasticpath/apis/catalogs-introduction/docs/catalogs/rules/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

filterstring

This endpoint supports filtering. See Filtering.

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.

Response

The list of 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.