acquia-dam-sdk

acquia-dam-sdk / Components / SearchProductsParams

Interface: SearchProductsParams

Properties¶

expand?¶

optional expand: "attributes"[]

If included, result set will be expanded with additional data

Defined in¶

src/apis/products/requests.ts:107

filters?¶

optional filters: ProductSearchFilter[]

Filters are AND-ed together. To mimic Entries channel export use the exclude_variants filter. To mimic Entries product search page use the exclude_variant and search_parents_via_variants filters.

Defined in¶

src/apis/products/requests.ts:109

limit?¶

optional limit: number

Numeric limit of the total number of results to retrieve

Minumum: 1

Maximum: 100

Default¶

10

Defined in¶

src/apis/products/requests.ts:119

offset?¶

optional offset: number

Starting position of query result set

Minimum: 0

Maximum: 9999

Default¶

0

Defined in¶

src/apis/products/requests.ts:129

query?¶

optional query: string

Optional term that will search for this string in product name or sku

Defined in¶

src/apis/products/requests.ts:131

sort?¶

optional sort: ProductSort

Optional term to sort results

Defined in¶

src/apis/products/requests.ts:133