Preview Product Rule

Previews a new product rule by searching for products in the admin index that meet the rule criteria

POST /commerce/rules/product/evaluate/preview

Error

A valid request URL is required to generate request examples

200

{
  "facets": [
    {
      "facetType": "<string>",
      "field": "<string>",
      "label": "<string>",
      "values": [
        {
          "childrenFacetValues": [
            {}
          ],
          "count": 123,
          "filterValue": "<string>",
          "isApplied": true,
          "isDisplayed": true,
          "label": "<string>",
          "parentFacetValue": "<string>",
          "rangeQueryValueEnd": "<string>",
          "rangeQueryValueStart": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "items": [
    {}
  ],
  "nextCursorMark": "<string>",
  "pageCount": 123,
  "pageSize": 123,
  "searchRedirect": "<string>",
  "startIndex": 123,
  "totalCount": 123
}

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Query Parameters

sortBy · string

pageSize · integer<int32>

startIndex · integer<int32> · default: 0

fieldList · string

responseFields · string

limits which fields are returned in the response body

Body

application/json

code · string | null

Unique identifier of the ProductRule. System-supplied and read-only.

description · string | null

ProductRule description

expression · object

Category

Show child attributes

name · string | null

ProductRule name

scope · string | null

Response

200

application/json

Success

facets · object[] | null

Show child attributes

items · object[] | null

Show child attributes

nextCursorMark · string | null

pageCount · integer<int32>

pageSize · integer<int32>

searchRedirect · string | null

startIndex · integer<int32>

totalCount · integer<int32>