Options
All
  • Public
  • Public/Protected
  • All
Menu

Module shopperSearch

Index

Classes

Type aliases

Type aliases

AsyncCreated

AsyncCreated: {}

Type declaration

  • [key: string]: any

AttributeDefinition

AttributeDefinition: { defaultValue?: PropertyValueDefinition; description: L10nString; id?: undefined | string; key?: undefined | false | true; localizable?: undefined | false | true; mandatory?: undefined | false | true; max?: undefined | number; min?: undefined | number; minLength?: undefined | number; multiValueType?: undefined | false | true; name: L10nString; possibleValues?: Array<PropertyValueDefinition>; regularExpression?: undefined | string; scale?: undefined | number; searchable?: undefined | false | true; siteSpecific?: undefined | false | true; system?: undefined | false | true; type: string; unit?: L10nString; visible?: undefined | false | true }

Type declaration

  • Optional defaultValue?: PropertyValueDefinition
  • description: L10nString
  • Optional id?: undefined | string
  • Optional key?: undefined | false | true
  • Optional localizable?: undefined | false | true
  • Optional mandatory?: undefined | false | true
  • Optional max?: undefined | number
  • Optional min?: undefined | number
  • Optional minLength?: undefined | number
  • Optional multiValueType?: undefined | false | true
  • name: L10nString
  • Optional possibleValues?: Array<PropertyValueDefinition>
  • Optional regularExpression?: undefined | string
  • Optional scale?: undefined | number
  • Optional searchable?: undefined | false | true
  • Optional siteSpecific?: undefined | false | true
  • Optional system?: undefined | false | true
  • type: string
  • Optional unit?: L10nString
  • Optional visible?: undefined | false | true

BadRequest

BadRequest: {}

Type declaration

  • [key: string]: any

BoolFilter

BoolFilter: { filters?: Array<Filter>; operator: string } & {}

BoolQuery

BoolQuery: { must?: Array<Query>; mustNot?: Array<Query>; should?: Array<Query> } & {}

BrandSuggestions

BrandSuggestions: {} & {}

CategorySuggestions

CategorySuggestions: { categories?: Array<SuggestedCategory>; suggestedPhrases?: Array<SuggestedPhrase>; suggestedTerms: Array<SuggestedTerms> } & {}

ChangeControlled

ChangeControlled: { createdBy?: undefined | string; creationDate?: any; lastModifiedBy?: undefined | string; modificationDate?: any } & {}

ChangeControlledDataType

ChangeControlledDataType: { createdBy?: undefined | string; creationDate?: any; lastModifiedBy?: undefined | string; modificationDate?: any } & {}

ClosedObject

ClosedObject: {} & {}

CustomSuggestions

CustomSuggestions: { customSuggestion?: undefined | string; suggestedPhrases?: Array<SuggestedPhrase>; suggestedTerms: Array<SuggestedTerms> } & {}

DateConditionalRequest

DateConditionalRequest: {}

Type declaration

  • [key: string]: any

DateRangeFilter

DateRangeFilter: {}

Type declaration

  • [key: string]: any

DatetimeRangeFilter

DatetimeRangeFilter: {}

Type declaration

  • [key: string]: any

Error

Error: { detail?: undefined | string; instance?: undefined | string; title?: undefined | string; type: string } & {}

ErrorResponse

ErrorResponse: { detail?: undefined | string; instance?: undefined | string; title?: undefined | string; type: string } & {}

EtagConditionalRequest

EtagConditionalRequest: {}

Type declaration

  • [key: string]: any

EtagResponse

EtagResponse: {}

Type declaration

  • [key: string]: any

Filter

Filter: { boolFilter?: BoolFilter; queryFilter?: QueryFilter; range2Filter?: Range2Filter; rangeFilter?: RangeFilter; termFilter?: TermFilter } & {}

FilteredQuery

FilteredQuery: { filter: Filter; query: Query } & {}

Image

Image: { alt?: undefined | string; disBaseLink?: undefined | string; link: string; title?: undefined | string } & {}

ImageGroup

ImageGroup: { images: Array<Image>; variationAttributes?: Array<VariationAttribute>; viewType: string } & {}

IntegerRangeFilter

IntegerRangeFilter: {}

Type declaration

  • [key: string]: any

L10nString

L10nString: {} & {}

LocalizedString

LocalizedString: {} & {}

MatchAllQuery

MatchAllQuery: {} & {}

Money

Money: { currencyMnemonic?: undefined | string; value?: undefined | number } & {}

MoneyMnemonic

MoneyMnemonic: { currencyMnemonic?: undefined | string; value?: undefined | number } & {}

NestedQuery

NestedQuery: { path: string; query: Query; scoreMode?: undefined | string } & {}

NoPropertiesAllowed

NoPropertiesAllowed: {}

Type declaration

NumericRangeFilter

NumericRangeFilter: {}

Type declaration

  • [key: string]: any

OffsetPaginated

OffsetPaginated: {}

Type declaration

  • [key: string]: any

OpenObject

OpenObject: {} & {}

PaginatedSearchResult

PaginatedSearchResult: { hits?: Array<object>; limit: number; offset: any; query: Query; sorts?: Array<Sort>; total: any } & {}

PaginatedSearchResultBase

PaginatedSearchResultBase: { hits?: Array<object>; limit: number; offset: any; query: Query; sorts?: Array<Sort>; total: any } & {}

PriceRange

PriceRange: { maxPrice?: undefined | number; minPrice?: undefined | number; pricebook?: undefined | string } & {}

ProductPriceTable

ProductPriceTable: { price?: undefined | number; pricebook?: undefined | string; quantity?: undefined | number } & {}

ProductPromotion

ProductPromotion: { calloutMsg: string; promotionId: string; promotionalPrice: number } & {}

ProductRef

ProductRef: { id: string } & {}

ProductSearchHit

ProductSearchHit: { currency?: undefined | string; hitType?: undefined | string; image?: Image; imageGroups?: Array<ImageGroup>; orderable?: undefined | false | true; price?: undefined | number; priceMax?: undefined | number; priceRanges?: Array<PriceRange>; prices?: {} & {}; productId: string; productName?: undefined | string; productPromotions?: Array<ProductPromotion>; productType?: ProductType; representedProduct?: ProductRef; representedProducts?: Array<ProductRef>; tieredPrices?: Array<ProductPriceTable>; variants?: Array<Variant>; variationAttributes?: Array<VariationAttribute>; variationGroups?: Array<VariationGroup> } & {}

ProductSearchRefinement

ProductSearchRefinement: { attributeId: string; label?: undefined | string; values?: Array<ProductSearchRefinementValue> } & {}

ProductSearchRefinementValue

ProductSearchRefinementValue: { description?: undefined | string; hitCount: number; label: string; presentationId?: undefined | string; value: string; values?: Array<ProductSearchRefinementValue> } & {}

ProductSearchResult

ProductSearchResult: { hits: Array<ProductSearchHit>; limit: number; offset: number; query: string; refinements: Array<ProductSearchRefinement>; searchPhraseSuggestions: Suggestion; selectedRefinements?: {} & {}; selectedSortingOption?: undefined | string; sortingOptions: Array<ProductSearchSortingOption>; total: number } & {}

ProductSearchSortingOption

ProductSearchSortingOption: { id: string; label: string } & {}

ProductSuggestions

ProductSuggestions: { products?: Array<SuggestedProduct>; suggestedPhrases?: Array<SuggestedPhrase>; suggestedTerms: Array<SuggestedTerms> } & {}

ProductType

ProductType: { bundle?: undefined | false | true; item?: undefined | false | true; master?: undefined | false | true; option?: undefined | false | true; set?: undefined | false | true; variant?: undefined | false | true; variationGroup?: undefined | false | true } & {}

PropertyDefinition

PropertyDefinition: { defaultValue?: PropertyValueDefinition; description: L10nString; id?: undefined | string; key?: undefined | false | true; localizable?: undefined | false | true; mandatory?: undefined | false | true; max?: undefined | number; min?: undefined | number; minLength?: undefined | number; multiValueType?: undefined | false | true; name: L10nString; possibleValues?: Array<PropertyValueDefinition>; regularExpression?: undefined | string; scale?: undefined | number; searchable?: undefined | false | true; siteSpecific?: undefined | false | true; system?: undefined | false | true; type: string; unit?: L10nString; visible?: undefined | false | true } & {}

PropertyValueDefinition

PropertyValueDefinition: { description: L10nString; displayValue: L10nString; id: string; position?: undefined | number; value: string }

Type declaration

  • description: L10nString
  • displayValue: L10nString
  • id: string
  • Optional position?: undefined | number
  • value: string

Query

Query: { boolQuery?: BoolQuery; filteredQuery?: FilteredQuery; matchAllQuery?: MatchAllQuery; nestedQuery?: NestedQuery; termQuery?: TermQuery; textQuery?: TextQuery } & {}

QueryFilter

QueryFilter: { query: Query } & {}

QueryParamsLimit

QueryParamsLimit: {}

Type declaration

  • [key: string]: any

QueryParamsOffset

QueryParamsOffset: {}

Type declaration

  • [key: string]: any

Range2Filter

Range2Filter: { filterMode?: undefined | string; fromField: string; fromInclusive?: undefined | false | true; fromValue?: any; toField: string; toInclusive?: undefined | false | true; toValue?: any } & {}

RangeFilter

RangeFilter: { field: string; from?: any; fromInclusive?: undefined | false | true; to?: any; toInclusive?: undefined | false | true } & {}

RateLimited

RateLimited: {}

Type declaration

  • [key: string]: any

RateLimited2

RateLimited2: {}

Type declaration

  • [key: string]: any

RateLimited3

RateLimited3: {}

Type declaration

  • [key: string]: any

RateLimited4

RateLimited4: {}

Type declaration

  • [key: string]: any

RateLimited5

RateLimited5: {}

Type declaration

  • [key: string]: any

SearchRequest

SearchRequest: { limit?: undefined | number; offset?: any; query: Query; sorts?: Array<Sort> } & {}

SearchRequestBase

SearchRequestBase: { limit?: undefined | number; offset?: any; query: Query; sorts?: Array<Sort> } & {}

Selectable

Selectable: {}

Type declaration

  • [key: string]: any

ShopperSearchParameters

ShopperSearchParameters: ShopperSearchPathParameters & BaseUriParameters & ShopperSearchQueryParameters

All parameters that are used by ShopperSearch.

ShopperSearchPathParameters

ShopperSearchPathParameters: { organizationId?: undefined | string }

All path parameters that are used by at least one ShopperSearch method.

Type declaration

  • Optional organizationId?: undefined | string

ShopperSearchQueryParameters

ShopperSearchQueryParameters: { allImages?: undefined | false | true; allVariationProperties?: undefined | false | true; currency?: undefined | string; expand?: Array<string>; limit?: undefined | number; locale?: undefined | string; offset?: any; perPricebook?: undefined | false | true; q?: undefined | string; refine?: Array<string>; select?: undefined | string; siteId?: undefined | string; sort?: undefined | string }

All query parameters that are used by at least one ShopperSearch method.

Type declaration

  • Optional allImages?: undefined | false | true
  • Optional allVariationProperties?: undefined | false | true
  • Optional currency?: undefined | string
  • Optional expand?: Array<string>
  • Optional limit?: undefined | number
  • Optional locale?: undefined | string
  • Optional offset?: any
  • Optional perPricebook?: undefined | false | true
  • Optional q?: undefined | string
  • Optional refine?: Array<string>
  • Optional select?: undefined | string
  • Optional siteId?: undefined | string
  • Optional sort?: undefined | string

SimpleSearchResult

SimpleSearchResult: { hits?: Array<object>; limit: number; offset: any; total: any } & {}

SimpleSearchResultBase

SimpleSearchResultBase: { hits?: Array<object>; limit: number; offset: any; total: any } & {}

SiteSpecific

SiteSpecific: {}

Type declaration

  • [key: string]: any

Sort

Sort: { field: string; sortOrder?: undefined | string } & {}

SpecifiedPropertiesAllowed

SpecifiedPropertiesAllowed: {} & {}

SuggestedCategory

SuggestedCategory: { id: string; name: string; parentCategoryName: string } & {}

SuggestedPhrase

SuggestedPhrase: { exactMatch: boolean; phrase: string } & {}

SuggestedProduct

SuggestedProduct: { currency: string; price: number; productId: string; productName: string } & {}

SuggestedTerm

SuggestedTerm: { completed: boolean; corrected: boolean; exactMatch: boolean; value: string } & {}

SuggestedTerms

SuggestedTerms: { originalTerm: string; terms?: Array<SuggestedTerm> } & {}

Suggestion

Suggestion: { suggestedPhrases?: Array<SuggestedPhrase>; suggestedTerms: Array<SuggestedTerms> } & {}

SuggestionResult

SuggestionResult: { brandSuggestions?: BrandSuggestions; categorySuggestions?: CategorySuggestions; customSuggestion?: CustomSuggestions; productSuggestions?: ProductSuggestions; searchPhrase: string } & {}

SyncCreated

SyncCreated: {}

Type declaration

  • [key: string]: any

TermFilter

TermFilter: { field: string; operator: string; values?: Array<any> } & {}

TermQuery

TermQuery: { fields: Array<string>; operator: string; values?: Array<any> } & {}

TextQuery

TextQuery: { fields: Array<string>; searchPhrase: string } & {}

Unauthorized

Unauthorized: {}

Type declaration

  • [key: string]: any

Variant

Variant: { orderable?: undefined | false | true; price?: undefined | number; productId: string; productPromotions?: Array<ProductPromotion>; tieredPrices?: Array<ProductPriceTable>; variationValues?: {} & {} } & {}

VariationAttribute

VariationAttribute: { id: string; name?: undefined | string; values?: Array<VariationAttributeValue> } & {}

VariationAttributeValue

VariationAttributeValue: { description?: undefined | string; image?: Image; imageSwatch?: Image; name?: undefined | string; orderable?: undefined | false | true; value: string } & {}

VariationGroup

VariationGroup: { orderable: boolean; price: number; productId: string; variationValues: {} & {} } & {}

Generated using TypeDoc