Type aliases
Static AsyncCreated
AsyncCreated: {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:276
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/product/shopperProducts/shopperProducts.ts:488
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 BadRequest
BadRequest: {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:245
Static BadRequest1
BadRequest1: {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:247
Static BadRequest2
BadRequest2: {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:251
Static BoolFilter
Bool
Filter: { filters?: Array < Filter > ; operator: string } & {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:379
Static BoolQuery
Bool
Query: { must?: Array < Query > ; mustNot?: Array < Query > ; should?: Array < Query > } & {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:441
Static BundledProduct
Bundled
Product: { id: string ; product: Product ; quantity: number } & {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:230
Static Category
Category
: { categories
?: Array < Category > ; description
?: string ; id
: string ; image
?: string ; name
?: string ; pageDescription
?: string ; pageKeywords
?: string ; pageTitle
?: string ; parentCategoryId
?: string ; parentCategoryTree
?: Array < PathRecord > ; thumbnail
?: string } & {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:45
Static CategoryResult
Category
Result: { data: Array < Category > ; limit: number ; total: number } & {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:59
Static ChangeControlled
ChangeControlled: { createdBy?: string ; creationDate?: any ; lastModifiedBy?: string ; modificationDate?: any } & {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:253
Static ChangeControlledDataType
ChangeControlledDataType: { createdBy?: string ; creationDate?: any ; lastModifiedBy?: string ; modificationDate?: any } & {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:292
Static ClosedObject
ClosedObject: {} & {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:360
Static DateConditionalRequest
DateConditionalRequest: {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:270
Static DateRangeFilter
DateRangeFilter: {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:260
Static DatetimeRangeFilter
DatetimeRangeFilter: {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:290
Static Error
Error: { detail?: string ; instance?: string ; title?: string ; type: string } & {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:299
Static ErrorResponse
ErrorResponse: { detail?: string ; instance?: string ; title?: string ; type: string } & {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:236
Static EtagConditionalRequest
EtagConditionalRequest: {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:274
Static EtagResponse
EtagResponse: {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:262
Static Filter
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:460
Static FilteredQuery
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:396
Static Image
Image: { alt?: string ; disBaseLink?: string ; link: string ; title?: string } & {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:203
Static ImageGroup
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:139
Static IntegerRangeFilter
IntegerRangeFilter: {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:264
Static Inventory
Inventory: { ats?: number ; backorderable?: boolean ; id: string ; inStockDate?: any ; orderable?: boolean ; preorderable?: boolean ; stockLevel?: number } & {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:129
Static L10nString
L10nString: {} & {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:485
Static LocalizedString
LocalizedString: {} & {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:348
Static Master
Master: { masterId: string ; orderable?: boolean ; price?: number ; priceMax?: number ; prices?: {} & {} } & {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:35
Static MatchAllQuery
MatchAllQuery: {} & {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:393
Static Money
Money: { currencyMnemonic?: string ; value?: number } & {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:306
Static MoneyMnemonic
MoneyMnemonic: { currencyMnemonic?: string ; value?: number } & {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:480
Static NestedQuery
Nested
Query: { path: string ; query: Query ; scoreMode?: string } & {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:454
Static NoPropertiesAllowed
NoPropertiesAllowed: {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:374
Static NotFound
NotFound: {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:243
Static NumericRangeFilter
NumericRangeFilter: {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:288
Static OffsetPaginated
OffsetPaginated: {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:282
Static OpenObject
OpenObject: {} & {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:363
Static Option
Option
: { description
?: string ; id
: string ; image
?: string ; name
?: string ; values
?: Array < OptionValue > } & {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:145
Static OptionValue
OptionValue: { default?: boolean ; id: string ; name?: string ; price?: number } & {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:28
Static PaginatedSearchResult
Paginated
SearchResult: { hits?: Array < object > ; limit: number ; offset: any ; query: Query ; sorts?: Array < Sort > ; total: any } & {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:351
Static PaginatedSearchResultBase
Paginated
SearchResultBase: { hits?: Array < object > ; limit: number ; offset: any ; query: Query ; sorts?: Array < Sort > ; total: any } & {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:384
Static PathRecord
PathRecord: { id?: string ; name?: string } & {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:225
Static PriceRange
PriceRange: { maxPrice?: number ; minPrice?: number ; pricebook?: string } & {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:22
Static Product
Product
: { brand
?: string ; bundledProducts
?: Array < BundledProduct > ; currency
?: string ; ean
?: string ; fetchDate
?: number ; id
: string ; imageGroups
?: Array < ImageGroup > ; inventories
?: Array < Inventory > ; inventory
?: Inventory ; longDescription
?: string ; manufacturerName
?: string ; manufacturerSku
?: string ; master
?: Master ; minOrderQuantity
?: number ; name
?: string ; options
?: Array < Option > ; pageDescription
?: string ; pageKeywords
?: string ; pageTitle
?: string ; price
?: number ; priceMax
?: number ; pricePerUnit
?: number ; pricePerUnitMax
?: number ; priceRanges
?: Array < PriceRange > ; prices
?: {} & {} ; primaryCategoryId
?: string ; productLinks
?: Array < ProductLink > ; productPromotions
?: Array < ProductPromotion > ; recommendations
?: Array < Recommendation > ; setProducts
?: Array < Product > ; shortDescription
?: string ; slugUrl
?: string ; stepQuantity
?: number ; tieredPrices
?: Array < ProductPriceTable > ; type
?: ProductType ; unit
?: string ; upc
?: string ; validFrom
?: any ; validTo
?: any ; variants
?: Array < Variant > ; variationAttributes
?: Array < VariationAttribute > ; variationGroups
?: Array < VariationGroup > ; variationValues
?: {} & {} } & {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:153
Static ProductLink
ProductLink: { sourceProductId: string ; sourceProductLink: string ; targetProductId: string ; targetProductLink: string ; type: string } & {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:121
Static ProductPriceTable
ProductPriceTable: { price?: number ; pricebook?: string ; quantity?: number } & {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:16
Static ProductPromotion
ProductPromotion: { calloutMsg: string ; promotionId: string ; promotionalPrice: number } & {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:219
Static ProductResult
Product
Result: { data: Array < Product > ; limit: number ; total: number } & {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:115
Static ProductType
ProductType: { bundle?: boolean ; item?: boolean ; master?: boolean ; option?: boolean ; set?: boolean ; variant?: boolean ; variationGroup?: boolean } & {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:76
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/product/shopperProducts/shopperProducts.ts:325
Static PropertyValueDefinition
Property
ValueDefinition: { description: L10nString ; displayValue: L10nString ; id: string ; position?: number ; value: string }
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:510
Type declaration
id: string
Optional position?: number
value: string
Static Query
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:405
Static QueryFilter
Query
Filter: { query: Query } & {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:401
Static QueryParamsLimit
QueryParamsLimit: {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:366
Static QueryParamsOffset
QueryParamsOffset: {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:368
Static Range2Filter
Range2Filter: { filterMode?: string ; fromField: string ; fromInclusive?: boolean ; fromValue?: any ; toField: string ; toInclusive?: boolean ; toValue?: any } & {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:431
Static RangeFilter
RangeFilter: {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:284
Static RateLimited
RateLimited: {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:278
Static RateLimited2
RateLimited2: {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:280
Static RateLimited3
RateLimited3: {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:266
Static RateLimited4
RateLimited4: {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:286
Static RateLimited5
RateLimited5: {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:272
Static Recommendation
Recommendation
: { calloutMsg
?: string ; image
?: Image ; longDescription
?: string ; name
?: string ; recommendationType
: RecommendationType ; recommendedItemId
?: string ; shortDescription
?: string } & {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:86
Static RecommendationType
RecommendationType: { displayValue: string ; value: number } & {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:71
Static SearchRequest
Search
Request: { limit?: number ; offset?: any ; query: Query ; sorts?: Array < Sort > } & {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:318
Static SearchRequestBase
Search
RequestBase: { limit?: number ; offset?: any ; query: Query ; sorts?: Array < Sort > } & {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:473
Static Selectable
Selectable: {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:372
Static SimpleSearchResult
SimpleSearchResult: { hits?: Array < object > ; limit: number ; offset: any ; total: any } & {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:311
Static SimpleSearchResultBase
SimpleSearchResultBase: { hits?: Array < object > ; limit: number ; offset: any ; total: any } & {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:447
Static SiteSpecific
SiteSpecific: {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:370
Static Sort
Sort: { field: string ; sortOrder?: string } & {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:468
Static SpecifiedPropertiesAllowed
SpecifiedPropertiesAllowed: {} & {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:376
Static SyncCreated
SyncCreated: {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:268
Static TermFilter
TermFilter: { field: string ; operator: string ; values?: Array < any > } & {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:420
Static TermQuery
TermQuery: { fields: Array < string > ; operator: string ; values?: Array < any > } & {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:414
Static TextQuery
TextQuery: { fields: Array < string > ; searchPhrase: string } & {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:426
Static Unauthorized
Unauthorized: {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:249
Static Variant
Variant
: { orderable
?: boolean ; price
?: number ; productId
: string ; tieredPrices
?: Array < ProductPriceTable > ; variationValues
?: {} & {} } & {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:96
Static VariationAttribute
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:65
Static VariationAttributeValue
Variation
AttributeValue: { description?: string ; image?: Image ; imageSwatch?: Image ; name?: string ; orderable?: boolean ; value: string } & {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:210
Static VariationGroup
VariationGroup: { orderable: boolean ; price: number ; productId: string ; variationValues: {} & {} } & {}
Defined in renderedTemplates/product/shopperProducts/shopperProducts.ts:106
**
Example with shopper auth
API Version:import { , ClientConfig, Customer, slasHelpers } from "commerce-sdk"; // or const { , 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 shopperProductsClient = new .ShopperProducts(clientConfig);
Last Updated: