PlentyONE Shop Docs

Appearance

@plentymarkets/shop-api / ItemSearchParams

Interface: ItemSearchParams ​

Defined in: types/api/itemSearch.ts:5

Extends ​

Properties ​

categoryId? ​

optional categoryId: string

Defined in: types/api/facet.ts:77

Inherited from ​

FacetSearchCriteria.categoryId

categorySlug? ​

optional categorySlug: string

Defined in: types/api/facet.ts:76

Inherited from ​

FacetSearchCriteria.categorySlug

categoryUrlPath? ​

optional categoryUrlPath: string

Defined in: types/api/facet.ts:75

Inherited from ​

FacetSearchCriteria.categoryUrlPath

crossSellingRelation? ​

optional crossSellingRelation: "Accessory" | "ReplacementPart" | "Similar" | "Bundle"

Defined in: types/api/facet.ts:87

Inherited from ​

FacetSearchCriteria.crossSellingRelation

facets? ​

optional facets: string

Defined in: types/api/facet.ts:81

Inherited from ​

FacetSearchCriteria.facets

itemId? ​

optional itemId: string

Defined in: types/api/facet.ts:88

Inherited from ​

FacetSearchCriteria.itemId

itemsPerPage? ​

optional itemsPerPage: number

Defined in: types/api/facet.ts:79

Inherited from ​

FacetSearchCriteria.itemsPerPage

page? ​

optional page: number

Defined in: types/api/facet.ts:78

Inherited from ​

FacetSearchCriteria.page

priceMax? ​

optional priceMax: string

Defined in: types/api/facet.ts:83

Inherited from ​

FacetSearchCriteria.priceMax

priceMin? ​

optional priceMin: string

Defined in: types/api/facet.ts:82

Inherited from ​

FacetSearchCriteria.priceMin

sort? ​

optional sort: string

Defined in: types/api/facet.ts:80

Inherited from ​

FacetSearchCriteria.sort

tagId? ​

optional tagId: string

Defined in: types/api/facet.ts:84

Inherited from ​

FacetSearchCriteria.tagId

tagName? ​

optional tagName: string

Defined in: types/api/facet.ts:85

Inherited from ​

FacetSearchCriteria.tagName

term? ​

optional term: string

Defined in: types/api/itemSearch.ts:6

type? ​

optional type: "category" | "tag" | "cross_selling" | "manufacturer" | "last_seen" | "all" | "live-shopping" | "variation" | "variation-list" | "search"

Defined in: types/api/facet.ts:86

Inherited from ​

FacetSearchCriteria.type