Type aliases
Static AsyncCreated
AsyncCreated: {}
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:264
Static AttributeDefinition
Attribute
Definition: { defaultValue?: PropertyValueDefinition ; description: L10nString ; id?: string ; key?: boolean ; localizable?: boolean ; mandatory?: boolean ; max?: number ; min?: number ; minLength?: number ; multiValueType?: boolean ; name: L10nString ; possibleValues?: Array < PropertyValueDefinition > ; regularExpression?: string ; scale?: number ; searchable?: boolean ; siteSpecific?: boolean ; system?: boolean ; type: string ; unit?: L10nString ; visible?: boolean }
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:205
Type declaration
Optional id?: string
Optional key?: boolean
Optional localizable?: boolean
Optional mandatory?: boolean
Optional max?: number
Optional min?: number
Optional minLength?: number
Optional multiValueType?: boolean
Optional regularExpression?: string
Optional scale?: number
Optional searchable?: boolean
Optional siteSpecific?: boolean
Optional system?: boolean
type: string
Optional visible?: boolean
Static BoolFilter
BoolFilter: { filters?: Array < any > ; operator: string } & {}
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:88
Static BoolQuery
BoolQuery: { must?: Array < any > ; mustNot?: Array < any > ; should?: Array < any > } & {}
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:150
Static BrandSuggestions
BrandSuggestions: {} & {}
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:347
Static CategorySuggestions
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:301
Static ChangeControlled
ChangeControlled: { createdBy?: string ; creationDate?: any ; lastModifiedBy?: string ; modificationDate?: any } & {}
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:241
Static ChangeControlledDataType
ChangeControlledDataType: { createdBy?: string ; creationDate?: any ; lastModifiedBy?: string ; modificationDate?: any } & {}
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:278
Static ClosedObject
ClosedObject: {} & {}
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:71
Static CustomSuggestions
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:377
Static DateConditionalRequest
DateConditionalRequest: {}
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:258
Static DateRangeFilter
DateRangeFilter: {}
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:248
Static DatetimeRangeFilter
DatetimeRangeFilter: {}
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:276
Static Error
Error: { detail?: string ; instance?: string ; title?: string ; type: string } & {}
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:285
Static ErrorResponse
ErrorResponse: { detail?: string ; instance?: string ; title?: string ; type: string } & {}
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:234
Static EtagConditionalRequest
EtagConditionalRequest: {}
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:262
Static EtagResponse
EtagResponse: {}
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:250
Static Filter
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:169
Static FilteredQuery
FilteredQuery: { filter: any ; query: any } & {}
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:105
Static Image
Image: { alt?: string ; disBaseLink?: string ; link: string ; title?: string } & {}
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:416
Static IntegerRangeFilter
IntegerRangeFilter: {}
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:252
Static L10nString
L10nString: {} & {}
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:202
Static LocalizedString
LocalizedString: {} & {}
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:59
Static MatchAllQuery
MatchAllQuery: {} & {}
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:102
Static Money
Money: { currencyMnemonic?: string ; value?: number } & {}
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:17
Static MoneyMnemonic
MoneyMnemonic: { currencyMnemonic?: string ; value?: number } & {}
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:197
Static NestedQuery
NestedQuery: { path: string ; query: any ; scoreMode?: string } & {}
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:163
Static NoPropertiesAllowed
NoPropertiesAllowed: {}
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:83
Static NumericRangeFilter
NumericRangeFilter: {}
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:274
Static OffsetPaginated
OffsetPaginated: {}
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:270
Static OpenObject
OpenObject: {} & {}
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:74
Static PaginatedSearchResult
Paginated
SearchResult: { hits?: Array < object > ; limit: number ; offset: any ; query: any ; sorts?: Array < Sort > ; total: any } & {}
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:62
Static PaginatedSearchResultBase
Paginated
SearchResultBase: { hits?: Array < object > ; limit: number ; offset: any ; query: any ; sorts?: Array < Sort > ; total: any } & {}
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:93
Static ProductRef
ProductRef: { id: string } & {}
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:292
Static ProductSearchHit
Product
SearchHit: { currency?: string ; hitType?: string ; image?: Image ; orderable?: boolean ; price?: number ; priceMax?: number ; prices?: {} & {} ; productId: string ; productName?: string ; productType?: ProductType ; representedProduct?: ProductRef ; representedProducts?: Array < ProductRef > ; variationAttributes?: Array < VariationAttribute > } & {}
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:383
Static ProductSearchRefinement
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:371
Static ProductSearchRefinementValue
Product
SearchRefinementValue: { description?: string ; hitCount: number ; label: string ; presentationId?: string ; value: string ; values?: Array < ProductSearchRefinementValue > } & {}
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:350
Static ProductSearchResult
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:401
Static ProductSearchSortingOption
ProductSearchSortingOption: { id: string ; label: string } & {}
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:359
Static ProductSuggestions
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:325
Static ProductType
ProductType: { bundle?: boolean ; item?: boolean ; master?: boolean ; option?: boolean ; set?: boolean ; variant?: boolean ; variationGroup?: boolean } & {}
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:337
Static PropertyDefinition
Property
Definition: { defaultValue?: PropertyValueDefinition ; description: L10nString ; id?: string ; key?: boolean ; localizable?: boolean ; mandatory?: boolean ; max?: number ; min?: number ; minLength?: number ; multiValueType?: boolean ; name: L10nString ; possibleValues?: Array < PropertyValueDefinition > ; regularExpression?: string ; scale?: number ; searchable?: boolean ; siteSpecific?: boolean ; system?: boolean ; type: string ; unit?: L10nString ; visible?: boolean } & {}
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:36
Static PropertyValueDefinition
Property
ValueDefinition: { description: L10nString ; displayValue: L10nString ; id: string ; position?: number ; value: string }
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:227
Type declaration
id: string
Optional position?: number
value: string
Static Query
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:114
Static QueryFilter
QueryFilter: { query: any } & {}
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:110
Static QueryParamsLimit
QueryParamsLimit: {}
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:77
Static QueryParamsOffset
QueryParamsOffset: {}
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:79
Static Range2Filter
Range2Filter: { filterMode?: string ; fromField: string ; fromInclusive?: boolean ; fromValue?: any ; toField: string ; toInclusive?: boolean ; toValue?: any } & {}
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:140
Static RangeFilter
RangeFilter: { field: string ; from?: any ; fromInclusive?: boolean ; to?: any ; toInclusive?: boolean } & {}
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:182
Static RateLimited
RateLimited: {}
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:266
Static RateLimited2
RateLimited2: {}
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:268
Static RateLimited3
RateLimited3: {}
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:254
Static RateLimited4
RateLimited4: {}
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:272
Static RateLimited5
RateLimited5: {}
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:260
Static SearchRequest
Search
Request: { limit?: number ; offset?: any ; query: any ; sorts?: Array < Sort > } & {}
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:29
Static SearchRequestBase
Search
RequestBase: { limit?: number ; offset?: any ; query: any ; sorts?: Array < Sort > } & {}
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:190
Static SimpleSearchResult
SimpleSearchResult: { hits?: Array < object > ; limit: number ; offset: any ; total: any } & {}
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:22
Static SimpleSearchResultBase
SimpleSearchResultBase: { hits?: Array < object > ; limit: number ; offset: any ; total: any } & {}
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:156
Static SiteSpecific
SiteSpecific: {}
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:81
Static Sort
Sort: { field: string ; sortOrder?: string } & {}
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:177
Static SpecifiedPropertiesAllowed
SpecifiedPropertiesAllowed: {} & {}
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:85
Static SuggestedCategory
SuggestedCategory: { id: string ; name: string ; parentCategoryName: string } & {}
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:331
Static SuggestedPhrase
SuggestedPhrase: { exactMatch: boolean ; phrase: string } & {}
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:314
Static SuggestedProduct
SuggestedProduct: { currency: string ; price: number ; productId: string ; productName: string } & {}
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:307
Static SuggestedTerm
SuggestedTerm: { completed: boolean ; corrected: boolean ; exactMatch: boolean ; value: string } & {}
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:364
Static SuggestedTerms
Suggested
Terms: { originalTerm: string ; terms?: Array < SuggestedTerm > } & {}
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:296
Static Suggestion
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:432
Static SuggestionResult
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:437
Static SyncCreated
SyncCreated: {}
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:256
Static TermFilter
TermFilter: { field: string ; operator: string ; values?: Array < any > } & {}
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:129
Static TermQuery
TermQuery: { fields: Array < string > ; operator: string ; values?: Array < any > } & {}
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:123
Static TextQuery
TextQuery: { fields: Array < string > ; searchPhrase: string } & {}
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:135
Static Unauthorized
Unauthorized: {}
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:445
Static VariationAttribute
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:319
Static VariationAttributeValue
Variation
AttributeValue: { description?: string ; image?: Image ; imageSwatch?: Image ; name?: string ; orderable?: boolean ; value: string } & {}
Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:423
Shopper Search
product search and helpful search suggestions.
Example with shopper auth
API Version: 1.0.29import { Discovery, ClientConfig, Customer, slasHelpers } from "commerce-sdk"; // or const { Discovery, ClientConfig, Customer, slasHelpers } = require("commerce-sdk"); const clientConfig: ClientConfig = { parameters: { clientId: "XXXXXX", organizationId: "XXXX", shortCode: "XXX", siteId: "XX" } }; // must be registered in SLAS. On server, redirectURI is never called const redirectURI = "http://localhost:3000/callback"; const slasClient = new Customer.ShopperLogin(clientConfig); token = await slasHelpers.loginGuestUser(slasClient, { redirectURI }); clientConfig.headers['authorization'] = `Bearer ${token.access_token}`; const shopperSearchClient = new Discovery.ShopperSearch(clientConfig);
Last Updated: