Interface ICommerceRequest

A Search API commerce request.

Index

Properties

Properties

Optional catalogId

catalogId: string

The unique identifier of the catalog to query.

Example: 46bc4275-e613-4dd5-b1ea-3e5aca1bcd9d

Optional filter

filter: string

A mandatory query expression to apply if the commerce request affects the query. Example: @storeid==1001

Optional operation

operation: "selectCatalogObjects" | "excludeCatalogObjects"

The way the commerce request should affect query results. Example: selectCatalogObjects

Hierarchy

  • ICommerceRequest