commerce-sdk-isomorphic 1.12.0 → 1.13.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +10 -0
- package/lib/index.cjs.d.ts +333 -465
- package/lib/index.cjs.js +1 -1
- package/lib/index.esm.d.ts +333 -465
- package/lib/index.esm.js +1 -1
- package/package.json +1 -1
package/lib/index.cjs.d.ts
CHANGED
|
@@ -697,7 +697,7 @@ type ShopperBasketsParameters = ShopperBasketsPathParameters & BaseUriParameters
|
|
|
697
697
|
* ```
|
|
698
698
|
*
|
|
699
699
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
700
|
-
* API Version: 2.0.
|
|
700
|
+
* API Version: 2.0.3<br />
|
|
701
701
|
* Last Updated: <br />
|
|
702
702
|
* </span>
|
|
703
703
|
|
|
@@ -4397,7 +4397,7 @@ declare namespace ShopperBasketsTypes {
|
|
|
4397
4397
|
* ```
|
|
4398
4398
|
*
|
|
4399
4399
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
4400
|
-
* API Version: 2.0.
|
|
4400
|
+
* API Version: 2.0.3<br />
|
|
4401
4401
|
* Last Updated: <br />
|
|
4402
4402
|
* </span>
|
|
4403
4403
|
|
|
@@ -17584,7 +17584,7 @@ type ShopperLoginParameters = ShopperLoginPathParameters & BaseUriParameters & S
|
|
|
17584
17584
|
* ```
|
|
17585
17585
|
*
|
|
17586
17586
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
17587
|
-
* API Version: 1.39.
|
|
17587
|
+
* API Version: 1.39.22<br />
|
|
17588
17588
|
* Last Updated: <br />
|
|
17589
17589
|
* </span>
|
|
17590
17590
|
|
|
@@ -19214,7 +19214,7 @@ declare namespace ShopperLoginTypes {
|
|
|
19214
19214
|
* ```
|
|
19215
19215
|
*
|
|
19216
19216
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
19217
|
-
* API Version: 1.39.
|
|
19217
|
+
* API Version: 1.39.22<br />
|
|
19218
19218
|
* Last Updated: <br />
|
|
19219
19219
|
* </span>
|
|
19220
19220
|
|
|
@@ -24400,6 +24400,36 @@ type PromotionResult = {
|
|
|
24400
24400
|
type RangeFilter$8 = {
|
|
24401
24401
|
[key: string]: any;
|
|
24402
24402
|
};
|
|
24403
|
+
type BoolFilter$8 = {
|
|
24404
|
+
filters?: Array<any>;
|
|
24405
|
+
operator: string;
|
|
24406
|
+
} & {
|
|
24407
|
+
[key: string]: any;
|
|
24408
|
+
};
|
|
24409
|
+
type MatchAllQuery$8 = {} & {
|
|
24410
|
+
[key: string]: any;
|
|
24411
|
+
};
|
|
24412
|
+
type FilteredQuery$8 = {
|
|
24413
|
+
filter: any;
|
|
24414
|
+
query: any;
|
|
24415
|
+
} & {
|
|
24416
|
+
[key: string]: any;
|
|
24417
|
+
};
|
|
24418
|
+
type QueryFilter$8 = {
|
|
24419
|
+
query: any;
|
|
24420
|
+
} & {
|
|
24421
|
+
[key: string]: any;
|
|
24422
|
+
};
|
|
24423
|
+
type Query$8 = {
|
|
24424
|
+
boolQuery?: BoolQuery$7;
|
|
24425
|
+
filteredQuery?: FilteredQuery$8;
|
|
24426
|
+
matchAllQuery?: MatchAllQuery$8;
|
|
24427
|
+
nestedQuery?: NestedQuery$7;
|
|
24428
|
+
termQuery?: TermQuery$7;
|
|
24429
|
+
textQuery?: TextQuery$7;
|
|
24430
|
+
} & {
|
|
24431
|
+
[key: string]: any;
|
|
24432
|
+
};
|
|
24403
24433
|
type TermQuery$8 = {
|
|
24404
24434
|
fields: Array<string>;
|
|
24405
24435
|
operator: string;
|
|
@@ -24407,12 +24437,30 @@ type TermQuery$8 = {
|
|
|
24407
24437
|
} & {
|
|
24408
24438
|
[key: string]: any;
|
|
24409
24439
|
};
|
|
24440
|
+
type TermFilter$8 = {
|
|
24441
|
+
field: string;
|
|
24442
|
+
operator: string;
|
|
24443
|
+
values?: Array<any>;
|
|
24444
|
+
} & {
|
|
24445
|
+
[key: string]: any;
|
|
24446
|
+
};
|
|
24410
24447
|
type TextQuery$8 = {
|
|
24411
24448
|
fields: Array<string>;
|
|
24412
24449
|
searchPhrase: string;
|
|
24413
24450
|
} & {
|
|
24414
24451
|
[key: string]: any;
|
|
24415
24452
|
};
|
|
24453
|
+
type Range2Filter$8 = {
|
|
24454
|
+
filterMode?: string;
|
|
24455
|
+
fromField: string;
|
|
24456
|
+
fromInclusive?: boolean;
|
|
24457
|
+
fromValue?: any;
|
|
24458
|
+
toField: string;
|
|
24459
|
+
toInclusive?: boolean;
|
|
24460
|
+
toValue?: any;
|
|
24461
|
+
} & {
|
|
24462
|
+
[key: string]: any;
|
|
24463
|
+
};
|
|
24416
24464
|
type BoolQuery$8 = {
|
|
24417
24465
|
must?: Array<any>;
|
|
24418
24466
|
mustNot?: Array<any>;
|
|
@@ -24427,6 +24475,15 @@ type NestedQuery$8 = {
|
|
|
24427
24475
|
} & {
|
|
24428
24476
|
[key: string]: any;
|
|
24429
24477
|
};
|
|
24478
|
+
type Filter$8 = {
|
|
24479
|
+
boolFilter?: BoolFilter$8;
|
|
24480
|
+
queryFilter?: QueryFilter$8;
|
|
24481
|
+
range2Filter?: Range2Filter$8;
|
|
24482
|
+
rangeFilter?: RangeFilter$8;
|
|
24483
|
+
termFilter?: TermFilter$8;
|
|
24484
|
+
} & {
|
|
24485
|
+
[key: string]: any;
|
|
24486
|
+
};
|
|
24430
24487
|
type Sort$8 = {
|
|
24431
24488
|
field: string;
|
|
24432
24489
|
sortOrder?: string;
|
|
@@ -25196,115 +25253,13 @@ declare namespace ShopperPromotionsTypes {
|
|
|
25196
25253
|
}>, rawResponse?: T): Promise<T extends true ? Response : PromotionResult>;
|
|
25197
25254
|
}
|
|
25198
25255
|
}
|
|
25199
|
-
type
|
|
25200
|
-
|
|
25201
|
-
|
|
25202
|
-
|
|
25203
|
-
[key: string]: any;
|
|
25204
|
-
};
|
|
25205
|
-
type MatchAllQuery$9 = {} & {
|
|
25206
|
-
[key: string]: any;
|
|
25207
|
-
};
|
|
25208
|
-
type FilteredQuery$9 = {
|
|
25209
|
-
filter: any;
|
|
25210
|
-
query: any;
|
|
25211
|
-
} & {
|
|
25212
|
-
[key: string]: any;
|
|
25213
|
-
};
|
|
25214
|
-
type QueryFilter$9 = {
|
|
25215
|
-
query: any;
|
|
25216
|
-
} & {
|
|
25217
|
-
[key: string]: any;
|
|
25218
|
-
};
|
|
25219
|
-
type Query$9 = {
|
|
25220
|
-
boolQuery?: BoolQuery$8;
|
|
25221
|
-
filteredQuery?: FilteredQuery$9;
|
|
25222
|
-
matchAllQuery?: MatchAllQuery$9;
|
|
25223
|
-
nestedQuery?: NestedQuery$8;
|
|
25224
|
-
termQuery?: TermQuery$8;
|
|
25225
|
-
textQuery?: TextQuery$8;
|
|
25226
|
-
} & {
|
|
25227
|
-
[key: string]: any;
|
|
25228
|
-
};
|
|
25229
|
-
type TermQuery$9 = {
|
|
25230
|
-
fields: Array<string>;
|
|
25231
|
-
operator: string;
|
|
25232
|
-
values?: Array<any>;
|
|
25233
|
-
} & {
|
|
25234
|
-
[key: string]: any;
|
|
25235
|
-
};
|
|
25236
|
-
type TermFilter$9 = {
|
|
25237
|
-
field: string;
|
|
25238
|
-
operator: string;
|
|
25239
|
-
values?: Array<any>;
|
|
25240
|
-
} & {
|
|
25241
|
-
[key: string]: any;
|
|
25242
|
-
};
|
|
25243
|
-
type TextQuery$9 = {
|
|
25244
|
-
fields: Array<string>;
|
|
25245
|
-
searchPhrase: string;
|
|
25246
|
-
} & {
|
|
25247
|
-
[key: string]: any;
|
|
25248
|
-
};
|
|
25249
|
-
type Range2Filter$9 = {
|
|
25250
|
-
filterMode?: string;
|
|
25251
|
-
fromField: string;
|
|
25252
|
-
fromInclusive?: boolean;
|
|
25253
|
-
fromValue?: any;
|
|
25254
|
-
toField: string;
|
|
25255
|
-
toInclusive?: boolean;
|
|
25256
|
-
toValue?: any;
|
|
25257
|
-
} & {
|
|
25258
|
-
[key: string]: any;
|
|
25259
|
-
};
|
|
25260
|
-
type BoolQuery$9 = {
|
|
25261
|
-
must?: Array<any>;
|
|
25262
|
-
mustNot?: Array<any>;
|
|
25263
|
-
should?: Array<any>;
|
|
25264
|
-
} & {
|
|
25265
|
-
[key: string]: any;
|
|
25266
|
-
};
|
|
25267
|
-
type NestedQuery$9 = {
|
|
25268
|
-
path: string;
|
|
25269
|
-
query: any;
|
|
25270
|
-
scoreMode?: string;
|
|
25271
|
-
} & {
|
|
25272
|
-
[key: string]: any;
|
|
25273
|
-
};
|
|
25274
|
-
type Filter$9 = {
|
|
25275
|
-
boolFilter?: BoolFilter$9;
|
|
25276
|
-
queryFilter?: QueryFilter$9;
|
|
25277
|
-
range2Filter?: Range2Filter$9;
|
|
25278
|
-
rangeFilter?: RangeFilter$8;
|
|
25279
|
-
termFilter?: TermFilter$9;
|
|
25280
|
-
} & {
|
|
25281
|
-
[key: string]: any;
|
|
25282
|
-
};
|
|
25283
|
-
type Sort$9 = {
|
|
25284
|
-
field: string;
|
|
25285
|
-
sortOrder?: string;
|
|
25286
|
-
} & {
|
|
25287
|
-
[key: string]: any;
|
|
25288
|
-
};
|
|
25289
|
-
type RangeFilter$9 = {
|
|
25290
|
-
field: string;
|
|
25291
|
-
from?: any;
|
|
25292
|
-
fromInclusive?: boolean;
|
|
25293
|
-
to?: any;
|
|
25294
|
-
toInclusive?: boolean;
|
|
25256
|
+
type ProductPriceTable$0 = {
|
|
25257
|
+
price?: number;
|
|
25258
|
+
pricebook?: string;
|
|
25259
|
+
quantity?: number;
|
|
25295
25260
|
} & {
|
|
25296
25261
|
[key: string]: any;
|
|
25297
25262
|
};
|
|
25298
|
-
type L10nString$8 = {} & {
|
|
25299
|
-
[key: string]: any;
|
|
25300
|
-
};
|
|
25301
|
-
type PropertyValueDefinition$8 = {
|
|
25302
|
-
description: L10nString$8;
|
|
25303
|
-
displayValue: L10nString$8;
|
|
25304
|
-
id: string;
|
|
25305
|
-
position?: number;
|
|
25306
|
-
value: string;
|
|
25307
|
-
};
|
|
25308
25263
|
type ProductRef = {
|
|
25309
25264
|
id: string;
|
|
25310
25265
|
} & {
|
|
@@ -25316,6 +25271,13 @@ type SuggestedTerms = {
|
|
|
25316
25271
|
} & {
|
|
25317
25272
|
[key: string]: any;
|
|
25318
25273
|
};
|
|
25274
|
+
type PriceRange$0 = {
|
|
25275
|
+
maxPrice?: number;
|
|
25276
|
+
minPrice?: number;
|
|
25277
|
+
pricebook?: string;
|
|
25278
|
+
} & {
|
|
25279
|
+
[key: string]: any;
|
|
25280
|
+
};
|
|
25319
25281
|
type CategorySuggestions = {
|
|
25320
25282
|
categories?: Array<SuggestedCategory>;
|
|
25321
25283
|
suggestedPhrases?: Array<SuggestedPhrase>;
|
|
@@ -25324,7 +25286,7 @@ type CategorySuggestions = {
|
|
|
25324
25286
|
[key: string]: any;
|
|
25325
25287
|
};
|
|
25326
25288
|
type SuggestedProduct = {
|
|
25327
|
-
currency:
|
|
25289
|
+
currency: any;
|
|
25328
25290
|
price: number;
|
|
25329
25291
|
productId: string;
|
|
25330
25292
|
productName: string;
|
|
@@ -25369,6 +25331,28 @@ type ProductType$1 = {
|
|
|
25369
25331
|
} & {
|
|
25370
25332
|
[key: string]: any;
|
|
25371
25333
|
};
|
|
25334
|
+
type Variant$1 = {
|
|
25335
|
+
orderable?: boolean;
|
|
25336
|
+
price?: number;
|
|
25337
|
+
productId: string;
|
|
25338
|
+
tieredPrices?: Array<ProductPriceTable$0>;
|
|
25339
|
+
variationValues?: {} & {
|
|
25340
|
+
[key: string]: any;
|
|
25341
|
+
};
|
|
25342
|
+
productPromotions?: Array<ProductPromotion$0>;
|
|
25343
|
+
} & {
|
|
25344
|
+
[key: string]: any;
|
|
25345
|
+
};
|
|
25346
|
+
type VariationGroup$1 = {
|
|
25347
|
+
orderable: boolean;
|
|
25348
|
+
price: number;
|
|
25349
|
+
productId: string;
|
|
25350
|
+
variationValues: {} & {
|
|
25351
|
+
[key: string]: any;
|
|
25352
|
+
};
|
|
25353
|
+
} & {
|
|
25354
|
+
[key: string]: any;
|
|
25355
|
+
};
|
|
25372
25356
|
type BrandSuggestions = {} & {
|
|
25373
25357
|
[key: string]: any;
|
|
25374
25358
|
};
|
|
@@ -25388,6 +25372,13 @@ type ProductSearchSortingOption = {
|
|
|
25388
25372
|
} & {
|
|
25389
25373
|
[key: string]: any;
|
|
25390
25374
|
};
|
|
25375
|
+
type ImageGroup$1 = {
|
|
25376
|
+
images: Array<Image$0>;
|
|
25377
|
+
variationAttributes?: Array<VariationAttribute$1>;
|
|
25378
|
+
viewType: string;
|
|
25379
|
+
} & {
|
|
25380
|
+
[key: string]: any;
|
|
25381
|
+
};
|
|
25391
25382
|
type SuggestedTerm = {
|
|
25392
25383
|
completed: boolean;
|
|
25393
25384
|
corrected: boolean;
|
|
@@ -25411,7 +25402,7 @@ type CustomSuggestions = {
|
|
|
25411
25402
|
[key: string]: any;
|
|
25412
25403
|
};
|
|
25413
25404
|
type ProductSearchHit = {
|
|
25414
|
-
currency?:
|
|
25405
|
+
currency?: any;
|
|
25415
25406
|
hitType?: string;
|
|
25416
25407
|
image?: Image$0;
|
|
25417
25408
|
orderable?: boolean;
|
|
@@ -25426,6 +25417,12 @@ type ProductSearchHit = {
|
|
|
25426
25417
|
representedProduct?: ProductRef;
|
|
25427
25418
|
representedProducts?: Array<ProductRef>;
|
|
25428
25419
|
variationAttributes?: Array<VariationAttribute$1>;
|
|
25420
|
+
imageGroups?: Array<ImageGroup$1>;
|
|
25421
|
+
priceRanges?: Array<PriceRange$0>;
|
|
25422
|
+
productPromotions?: Array<ProductPromotion$0>;
|
|
25423
|
+
tieredPrices?: Array<ProductPriceTable$0>;
|
|
25424
|
+
variants?: Array<Variant$1>;
|
|
25425
|
+
variationGroups?: Array<VariationGroup$1>;
|
|
25429
25426
|
} & {
|
|
25430
25427
|
[key: string]: any;
|
|
25431
25428
|
};
|
|
@@ -25463,6 +25460,13 @@ type VariationAttributeValue$1 = {
|
|
|
25463
25460
|
} & {
|
|
25464
25461
|
[key: string]: any;
|
|
25465
25462
|
};
|
|
25463
|
+
type ProductPromotion$1 = {
|
|
25464
|
+
calloutMsg: string;
|
|
25465
|
+
promotionId: string;
|
|
25466
|
+
promotionalPrice: number;
|
|
25467
|
+
} & {
|
|
25468
|
+
[key: string]: any;
|
|
25469
|
+
};
|
|
25466
25470
|
type Suggestion$0 = {
|
|
25467
25471
|
suggestedPhrases?: Array<SuggestedPhrase>;
|
|
25468
25472
|
suggestedTerms: Array<SuggestedTerms>;
|
|
@@ -25488,13 +25492,17 @@ type ShopperSearchPathParameters = {
|
|
|
25488
25492
|
* All query parameters that are used by at least one ShopperSearch method.
|
|
25489
25493
|
*/
|
|
25490
25494
|
type ShopperSearchQueryParameters = {
|
|
25491
|
-
|
|
25495
|
+
select?: any;
|
|
25496
|
+
siteId?: any;
|
|
25492
25497
|
q?: string;
|
|
25493
25498
|
refine?: Array<string>;
|
|
25494
25499
|
sort?: string;
|
|
25495
|
-
currency?:
|
|
25496
|
-
locale?:
|
|
25500
|
+
currency?: any;
|
|
25501
|
+
locale?: any;
|
|
25497
25502
|
expand?: Array<string>;
|
|
25503
|
+
allImages?: boolean;
|
|
25504
|
+
perPricebook?: boolean;
|
|
25505
|
+
allVariationProperties?: boolean;
|
|
25498
25506
|
offset?: any;
|
|
25499
25507
|
limit?: number;
|
|
25500
25508
|
};
|
|
@@ -25525,7 +25533,7 @@ type ShopperSearchParameters = ShopperSearchPathParameters & BaseUriParameters &
|
|
|
25525
25533
|
* ```
|
|
25526
25534
|
*
|
|
25527
25535
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
25528
|
-
* API Version: 1.0.
|
|
25536
|
+
* API Version: 1.0.38<br />
|
|
25529
25537
|
* Last Updated: <br />
|
|
25530
25538
|
* </span>
|
|
25531
25539
|
|
|
@@ -25547,7 +25555,8 @@ declare class ShopperSearch<ConfigParameters extends ShopperSearchParameters & R
|
|
|
25547
25555
|
*
|
|
25548
25556
|
* @param options - An object containing the options for this method.
|
|
25549
25557
|
* @param parameters - An object containing the parameters for this method.
|
|
25550
|
-
* @param organizationId -
|
|
25558
|
+
* @param organizationId -
|
|
25559
|
+
* @param select - The property selector declaring which fields are included into the response payload. You can specify a single field name, a comma-separated list of names, or work with wildcards.You can also sepcify Array Operations and filter expressions.The actual selector value must be enclosed within parentheses.
|
|
25551
25560
|
* @param siteId -
|
|
25552
25561
|
* @param q - The query phrase to search for. For example to search for a product "shirt", type q=shirt.
|
|
25553
25562
|
* @param refine - Parameter that represents a refinement attribute or values pair. Refinement attribute ID and
|
|
@@ -25564,7 +25573,10 @@ declare class ShopperSearch<ConfigParameters extends ShopperSearchParameters & R
|
|
|
25564
25573
|
* @param sort - The ID of the sorting option to sort the search hits.
|
|
25565
25574
|
* @param currency - The currency mnemonic specified for price. This parameter is effective only if the returned results contain prices.
|
|
25566
25575
|
* @param locale -
|
|
25567
|
-
* @param expand - The expand parameter. A list with the allowed values (availability, images, prices, represented_products, variations).
|
|
25576
|
+
* @param expand - The expand parameter. A comma-separated list with the allowed values (availability, images, prices, represented_products, variations, promotions, custom_properties). The expand parameter `availability, images, prices, represented_products, variations` is used as the default value when no expand parameter is provided. The value `none` can be used to turn off all expand options. The expand values `promotions` and `custom_properties` are optional and are available from version 24.3 and 24.4, respectively.
|
|
25577
|
+
* @param allImages - When this flag is passed along with the expand parameter `images` in the request, a property named `imageGroups`, which contains an image model, is returned in the response. If the flag is set to `true`, the whole image model is returned. If it is set to `false`, the returned image model contains only matching images. If no flag is passed in the request, the response does not include the `imageGroups property`. This parameter is available from version 24.3.
|
|
25578
|
+
* @param perPricebook - When this flag is passed as `true` in the request, along with the expand parameter `prices`, then per PriceBook prices and tiered prices (if available) are returned. This parameter is available from version 24.3.
|
|
25579
|
+
* @param allVariationProperties - The flag that indicates which variation properties are to be included in the result. When the flag is passed as `true` along with the expand parameter `variations` in the request, all variation properties (`variationAttributes`, `variationGroups`, and `variants`) are returned. When it is passed as `false` along with the expand parameter `variations` in the request, only the default property (`variationAttributes`) is returned. This parameter is available from version 24.3.
|
|
25568
25580
|
* @param offset -
|
|
25569
25581
|
* @param limit - Maximum records to retrieve per request, not to exceed 200. Defaults to 25.
|
|
25570
25582
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
@@ -25576,13 +25588,17 @@ declare class ShopperSearch<ConfigParameters extends ShopperSearchParameters & R
|
|
|
25576
25588
|
productSearch(options?: RequireParametersUnlessAllAreOptional<{
|
|
25577
25589
|
parameters?: CompositeParameters<{
|
|
25578
25590
|
organizationId: string;
|
|
25579
|
-
|
|
25591
|
+
select?: any;
|
|
25592
|
+
siteId: any;
|
|
25580
25593
|
q?: string;
|
|
25581
25594
|
refine?: Array<string>;
|
|
25582
25595
|
sort?: string;
|
|
25583
|
-
currency?:
|
|
25584
|
-
locale?:
|
|
25596
|
+
currency?: any;
|
|
25597
|
+
locale?: any;
|
|
25585
25598
|
expand?: Array<string>;
|
|
25599
|
+
allImages?: boolean;
|
|
25600
|
+
perPricebook?: boolean;
|
|
25601
|
+
allVariationProperties?: boolean;
|
|
25586
25602
|
offset?: any;
|
|
25587
25603
|
limit?: number;
|
|
25588
25604
|
} & {
|
|
@@ -25598,7 +25614,8 @@ declare class ShopperSearch<ConfigParameters extends ShopperSearchParameters & R
|
|
|
25598
25614
|
*
|
|
25599
25615
|
* @param options - An object containing the options for this method.
|
|
25600
25616
|
* @param parameters - An object containing the parameters for this method.
|
|
25601
|
-
* @param organizationId -
|
|
25617
|
+
* @param organizationId -
|
|
25618
|
+
* @param select - The property selector declaring which fields are included into the response payload. You can specify a single field name, a comma-separated list of names, or work with wildcards.You can also sepcify Array Operations and filter expressions.The actual selector value must be enclosed within parentheses.
|
|
25602
25619
|
* @param siteId -
|
|
25603
25620
|
* @param q - The query phrase to search for. For example to search for a product "shirt", type q=shirt.
|
|
25604
25621
|
* @param refine - Parameter that represents a refinement attribute or values pair. Refinement attribute ID and
|
|
@@ -25615,7 +25632,10 @@ declare class ShopperSearch<ConfigParameters extends ShopperSearchParameters & R
|
|
|
25615
25632
|
* @param sort - The ID of the sorting option to sort the search hits.
|
|
25616
25633
|
* @param currency - The currency mnemonic specified for price. This parameter is effective only if the returned results contain prices.
|
|
25617
25634
|
* @param locale -
|
|
25618
|
-
* @param expand - The expand parameter. A list with the allowed values (availability, images, prices, represented_products, variations).
|
|
25635
|
+
* @param expand - The expand parameter. A comma-separated list with the allowed values (availability, images, prices, represented_products, variations, promotions, custom_properties). The expand parameter `availability, images, prices, represented_products, variations` is used as the default value when no expand parameter is provided. The value `none` can be used to turn off all expand options. The expand values `promotions` and `custom_properties` are optional and are available from version 24.3 and 24.4, respectively.
|
|
25636
|
+
* @param allImages - When this flag is passed along with the expand parameter `images` in the request, a property named `imageGroups`, which contains an image model, is returned in the response. If the flag is set to `true`, the whole image model is returned. If it is set to `false`, the returned image model contains only matching images. If no flag is passed in the request, the response does not include the `imageGroups property`. This parameter is available from version 24.3.
|
|
25637
|
+
* @param perPricebook - When this flag is passed as `true` in the request, along with the expand parameter `prices`, then per PriceBook prices and tiered prices (if available) are returned. This parameter is available from version 24.3.
|
|
25638
|
+
* @param allVariationProperties - The flag that indicates which variation properties are to be included in the result. When the flag is passed as `true` along with the expand parameter `variations` in the request, all variation properties (`variationAttributes`, `variationGroups`, and `variants`) are returned. When it is passed as `false` along with the expand parameter `variations` in the request, only the default property (`variationAttributes`) is returned. This parameter is available from version 24.3.
|
|
25619
25639
|
* @param offset -
|
|
25620
25640
|
* @param limit - Maximum records to retrieve per request, not to exceed 200. Defaults to 25.
|
|
25621
25641
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
@@ -25627,13 +25647,17 @@ declare class ShopperSearch<ConfigParameters extends ShopperSearchParameters & R
|
|
|
25627
25647
|
productSearch<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
|
|
25628
25648
|
parameters?: CompositeParameters<{
|
|
25629
25649
|
organizationId: string;
|
|
25630
|
-
|
|
25650
|
+
select?: any;
|
|
25651
|
+
siteId: any;
|
|
25631
25652
|
q?: string;
|
|
25632
25653
|
refine?: Array<string>;
|
|
25633
25654
|
sort?: string;
|
|
25634
|
-
currency?:
|
|
25635
|
-
locale?:
|
|
25655
|
+
currency?: any;
|
|
25656
|
+
locale?: any;
|
|
25636
25657
|
expand?: Array<string>;
|
|
25658
|
+
allImages?: boolean;
|
|
25659
|
+
perPricebook?: boolean;
|
|
25660
|
+
allVariationProperties?: boolean;
|
|
25637
25661
|
offset?: any;
|
|
25638
25662
|
limit?: number;
|
|
25639
25663
|
} & {
|
|
@@ -25650,7 +25674,7 @@ declare class ShopperSearch<ConfigParameters extends ShopperSearchParameters & R
|
|
|
25650
25674
|
*
|
|
25651
25675
|
* @param options - An object containing the options for this method.
|
|
25652
25676
|
* @param parameters - An object containing the parameters for this method.
|
|
25653
|
-
* @param organizationId -
|
|
25677
|
+
* @param organizationId -
|
|
25654
25678
|
* @param siteId -
|
|
25655
25679
|
* @param q - The search phrase (q) for which suggestions are evaluated. Search suggestions are determined when the search phrase input is at least three (default) characters long. The value is configurable in the Business Manager.
|
|
25656
25680
|
* @param limit - The maximum number of suggestions made per request. If no value is defined, by default five suggestions per suggestion type are evaluated. This affects all types of suggestions (category, product, brand, and custom suggestions).
|
|
@@ -25665,11 +25689,11 @@ declare class ShopperSearch<ConfigParameters extends ShopperSearchParameters & R
|
|
|
25665
25689
|
getSearchSuggestions(options?: RequireParametersUnlessAllAreOptional<{
|
|
25666
25690
|
parameters?: CompositeParameters<{
|
|
25667
25691
|
organizationId: string;
|
|
25668
|
-
siteId:
|
|
25692
|
+
siteId: any;
|
|
25669
25693
|
q: string;
|
|
25670
25694
|
limit?: number;
|
|
25671
|
-
currency?:
|
|
25672
|
-
locale?:
|
|
25695
|
+
currency?: any;
|
|
25696
|
+
locale?: any;
|
|
25673
25697
|
} & {
|
|
25674
25698
|
[key in `c_${string}`]: any;
|
|
25675
25699
|
}, ConfigParameters>;
|
|
@@ -25682,7 +25706,7 @@ declare class ShopperSearch<ConfigParameters extends ShopperSearchParameters & R
|
|
|
25682
25706
|
*
|
|
25683
25707
|
* @param options - An object containing the options for this method.
|
|
25684
25708
|
* @param parameters - An object containing the parameters for this method.
|
|
25685
|
-
* @param organizationId -
|
|
25709
|
+
* @param organizationId -
|
|
25686
25710
|
* @param siteId -
|
|
25687
25711
|
* @param q - The search phrase (q) for which suggestions are evaluated. Search suggestions are determined when the search phrase input is at least three (default) characters long. The value is configurable in the Business Manager.
|
|
25688
25712
|
* @param limit - The maximum number of suggestions made per request. If no value is defined, by default five suggestions per suggestion type are evaluated. This affects all types of suggestions (category, product, brand, and custom suggestions).
|
|
@@ -25697,11 +25721,11 @@ declare class ShopperSearch<ConfigParameters extends ShopperSearchParameters & R
|
|
|
25697
25721
|
getSearchSuggestions<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
|
|
25698
25722
|
parameters?: CompositeParameters<{
|
|
25699
25723
|
organizationId: string;
|
|
25700
|
-
siteId:
|
|
25724
|
+
siteId: any;
|
|
25701
25725
|
q: string;
|
|
25702
25726
|
limit?: number;
|
|
25703
|
-
currency?:
|
|
25704
|
-
locale?:
|
|
25727
|
+
currency?: any;
|
|
25728
|
+
locale?: any;
|
|
25705
25729
|
} & {
|
|
25706
25730
|
[key in `c_${string}`]: any;
|
|
25707
25731
|
}, ConfigParameters>;
|
|
@@ -25801,239 +25825,31 @@ declare namespace ShopperSearchTypes {
|
|
|
25801
25825
|
constructor(config: ClientConfigInit<Params>);
|
|
25802
25826
|
static readonly defaults: Pick<Required<ClientConfigInit<never>>, "transformRequest">;
|
|
25803
25827
|
}
|
|
25804
|
-
type
|
|
25805
|
-
|
|
25806
|
-
|
|
25828
|
+
type ErrorResponse = {
|
|
25829
|
+
type: string;
|
|
25830
|
+
title?: string;
|
|
25831
|
+
detail?: string;
|
|
25832
|
+
instance?: string;
|
|
25807
25833
|
} & {
|
|
25808
25834
|
[key: string]: any;
|
|
25809
25835
|
};
|
|
25810
|
-
type
|
|
25811
|
-
|
|
25812
|
-
|
|
25813
|
-
|
|
25814
|
-
|
|
25836
|
+
type ChangeControlled = {
|
|
25837
|
+
creationDate?: any;
|
|
25838
|
+
modificationDate?: any;
|
|
25839
|
+
createdBy?: string;
|
|
25840
|
+
lastModifiedBy?: string;
|
|
25815
25841
|
} & {
|
|
25816
25842
|
[key: string]: any;
|
|
25817
25843
|
};
|
|
25818
|
-
type
|
|
25819
|
-
|
|
25820
|
-
|
|
25821
|
-
|
|
25822
|
-
|
|
25844
|
+
type ChangeControlledDataType = {
|
|
25845
|
+
creationDate?: any;
|
|
25846
|
+
modificationDate?: any;
|
|
25847
|
+
createdBy?: string;
|
|
25848
|
+
lastModifiedBy?: string;
|
|
25823
25849
|
} & {
|
|
25824
25850
|
[key: string]: any;
|
|
25825
25851
|
};
|
|
25826
|
-
type
|
|
25827
|
-
defaultValue?: PropertyValueDefinition$8;
|
|
25828
|
-
id?: string;
|
|
25829
|
-
name: L10nString$8;
|
|
25830
|
-
description: L10nString$8;
|
|
25831
|
-
key?: boolean;
|
|
25832
|
-
localizable?: boolean;
|
|
25833
|
-
mandatory?: boolean;
|
|
25834
|
-
max?: number;
|
|
25835
|
-
minLength?: number;
|
|
25836
|
-
min?: number;
|
|
25837
|
-
multiValueType?: boolean;
|
|
25838
|
-
regularExpression?: string;
|
|
25839
|
-
scale?: number;
|
|
25840
|
-
searchable?: boolean;
|
|
25841
|
-
siteSpecific?: boolean;
|
|
25842
|
-
system?: boolean;
|
|
25843
|
-
unit?: L10nString$8;
|
|
25844
|
-
possibleValues?: Array<PropertyValueDefinition$8>;
|
|
25845
|
-
type: string;
|
|
25846
|
-
visible?: boolean;
|
|
25847
|
-
} & {
|
|
25848
|
-
[key: string]: any;
|
|
25849
|
-
};
|
|
25850
|
-
type LocalizedString = {} & {
|
|
25851
|
-
[key: string]: any;
|
|
25852
|
-
};
|
|
25853
|
-
type PaginatedSearchResult = {
|
|
25854
|
-
query: any;
|
|
25855
|
-
sorts?: Array<Sort$9>;
|
|
25856
|
-
limit: number;
|
|
25857
|
-
hits?: Array<object>;
|
|
25858
|
-
offset: any;
|
|
25859
|
-
total: any;
|
|
25860
|
-
} & {
|
|
25861
|
-
[key: string]: any;
|
|
25862
|
-
};
|
|
25863
|
-
type ClosedObject = {} & {
|
|
25864
|
-
[key: string]: any;
|
|
25865
|
-
};
|
|
25866
|
-
type OpenObject = {} & {
|
|
25867
|
-
[key: string]: any;
|
|
25868
|
-
};
|
|
25869
|
-
type NoPropertiesAllowed = {};
|
|
25870
|
-
type SpecifiedPropertiesAllowed = {} & {
|
|
25871
|
-
[key: string]: any;
|
|
25872
|
-
};
|
|
25873
|
-
type BoolFilter = {
|
|
25874
|
-
filters?: Array<any>;
|
|
25875
|
-
operator: string;
|
|
25876
|
-
} & {
|
|
25877
|
-
[key: string]: any;
|
|
25878
|
-
};
|
|
25879
|
-
type PaginatedSearchResultBase = {
|
|
25880
|
-
query: any;
|
|
25881
|
-
sorts?: Array<Sort$9>;
|
|
25882
|
-
limit: number;
|
|
25883
|
-
hits?: Array<object>;
|
|
25884
|
-
offset: any;
|
|
25885
|
-
total: any;
|
|
25886
|
-
} & {
|
|
25887
|
-
[key: string]: any;
|
|
25888
|
-
};
|
|
25889
|
-
type MatchAllQuery = {} & {
|
|
25890
|
-
[key: string]: any;
|
|
25891
|
-
};
|
|
25892
|
-
type FilteredQuery = {
|
|
25893
|
-
filter: any;
|
|
25894
|
-
query: any;
|
|
25895
|
-
} & {
|
|
25896
|
-
[key: string]: any;
|
|
25897
|
-
};
|
|
25898
|
-
type QueryFilter = {
|
|
25899
|
-
query: any;
|
|
25900
|
-
} & {
|
|
25901
|
-
[key: string]: any;
|
|
25902
|
-
};
|
|
25903
|
-
type Query = {
|
|
25904
|
-
boolQuery?: BoolQuery$9;
|
|
25905
|
-
filteredQuery?: FilteredQuery;
|
|
25906
|
-
matchAllQuery?: MatchAllQuery;
|
|
25907
|
-
nestedQuery?: NestedQuery$9;
|
|
25908
|
-
termQuery?: TermQuery$9;
|
|
25909
|
-
textQuery?: TextQuery$9;
|
|
25910
|
-
} & {
|
|
25911
|
-
[key: string]: any;
|
|
25912
|
-
};
|
|
25913
|
-
type TermQuery = {
|
|
25914
|
-
fields: Array<string>;
|
|
25915
|
-
operator: string;
|
|
25916
|
-
values?: Array<any>;
|
|
25917
|
-
} & {
|
|
25918
|
-
[key: string]: any;
|
|
25919
|
-
};
|
|
25920
|
-
type TermFilter = {
|
|
25921
|
-
field: string;
|
|
25922
|
-
operator: string;
|
|
25923
|
-
values?: Array<any>;
|
|
25924
|
-
} & {
|
|
25925
|
-
[key: string]: any;
|
|
25926
|
-
};
|
|
25927
|
-
type TextQuery = {
|
|
25928
|
-
fields: Array<string>;
|
|
25929
|
-
searchPhrase: string;
|
|
25930
|
-
} & {
|
|
25931
|
-
[key: string]: any;
|
|
25932
|
-
};
|
|
25933
|
-
type Range2Filter = {
|
|
25934
|
-
filterMode?: string;
|
|
25935
|
-
fromField: string;
|
|
25936
|
-
fromInclusive?: boolean;
|
|
25937
|
-
fromValue?: any;
|
|
25938
|
-
toField: string;
|
|
25939
|
-
toInclusive?: boolean;
|
|
25940
|
-
toValue?: any;
|
|
25941
|
-
} & {
|
|
25942
|
-
[key: string]: any;
|
|
25943
|
-
};
|
|
25944
|
-
type BoolQuery = {
|
|
25945
|
-
must?: Array<any>;
|
|
25946
|
-
mustNot?: Array<any>;
|
|
25947
|
-
should?: Array<any>;
|
|
25948
|
-
} & {
|
|
25949
|
-
[key: string]: any;
|
|
25950
|
-
};
|
|
25951
|
-
type SimpleSearchResultBase = {
|
|
25952
|
-
limit: number;
|
|
25953
|
-
hits?: Array<object>;
|
|
25954
|
-
offset: any;
|
|
25955
|
-
total: any;
|
|
25956
|
-
} & {
|
|
25957
|
-
[key: string]: any;
|
|
25958
|
-
};
|
|
25959
|
-
type NestedQuery = {
|
|
25960
|
-
path: string;
|
|
25961
|
-
query: any;
|
|
25962
|
-
scoreMode?: string;
|
|
25963
|
-
} & {
|
|
25964
|
-
[key: string]: any;
|
|
25965
|
-
};
|
|
25966
|
-
type Filter = {
|
|
25967
|
-
boolFilter?: BoolFilter;
|
|
25968
|
-
queryFilter?: QueryFilter;
|
|
25969
|
-
range2Filter?: Range2Filter;
|
|
25970
|
-
rangeFilter?: RangeFilter$9;
|
|
25971
|
-
termFilter?: TermFilter;
|
|
25972
|
-
} & {
|
|
25973
|
-
[key: string]: any;
|
|
25974
|
-
};
|
|
25975
|
-
type Sort = {
|
|
25976
|
-
field: string;
|
|
25977
|
-
sortOrder?: string;
|
|
25978
|
-
} & {
|
|
25979
|
-
[key: string]: any;
|
|
25980
|
-
};
|
|
25981
|
-
type RangeFilter = {
|
|
25982
|
-
field: string;
|
|
25983
|
-
from?: any;
|
|
25984
|
-
fromInclusive?: boolean;
|
|
25985
|
-
to?: any;
|
|
25986
|
-
toInclusive?: boolean;
|
|
25987
|
-
} & {
|
|
25988
|
-
[key: string]: any;
|
|
25989
|
-
};
|
|
25990
|
-
type SearchRequestBase = {
|
|
25991
|
-
limit?: number;
|
|
25992
|
-
query: any;
|
|
25993
|
-
sorts?: Array<Sort>;
|
|
25994
|
-
offset?: any;
|
|
25995
|
-
} & {
|
|
25996
|
-
[key: string]: any;
|
|
25997
|
-
};
|
|
25998
|
-
type MoneyMnemonic = {
|
|
25999
|
-
currencyMnemonic?: string;
|
|
26000
|
-
value?: number;
|
|
26001
|
-
} & {
|
|
26002
|
-
[key: string]: any;
|
|
26003
|
-
};
|
|
26004
|
-
type L10nString = {} & {
|
|
26005
|
-
[key: string]: any;
|
|
26006
|
-
};
|
|
26007
|
-
type AttributeDefinition = {
|
|
26008
|
-
defaultValue?: PropertyValueDefinition$8;
|
|
26009
|
-
id?: string;
|
|
26010
|
-
name: L10nString;
|
|
26011
|
-
description: L10nString;
|
|
26012
|
-
key?: boolean;
|
|
26013
|
-
localizable?: boolean;
|
|
26014
|
-
mandatory?: boolean;
|
|
26015
|
-
max?: number;
|
|
26016
|
-
minLength?: number;
|
|
26017
|
-
min?: number;
|
|
26018
|
-
multiValueType?: boolean;
|
|
26019
|
-
regularExpression?: string;
|
|
26020
|
-
scale?: number;
|
|
26021
|
-
searchable?: boolean;
|
|
26022
|
-
siteSpecific?: boolean;
|
|
26023
|
-
system?: boolean;
|
|
26024
|
-
unit?: L10nString;
|
|
26025
|
-
possibleValues?: Array<PropertyValueDefinition$8>;
|
|
26026
|
-
type: string;
|
|
26027
|
-
visible?: boolean;
|
|
26028
|
-
};
|
|
26029
|
-
type PropertyValueDefinition = {
|
|
26030
|
-
description: L10nString;
|
|
26031
|
-
displayValue: L10nString;
|
|
26032
|
-
id: string;
|
|
26033
|
-
position?: number;
|
|
26034
|
-
value: string;
|
|
26035
|
-
};
|
|
26036
|
-
type ErrorResponse = {
|
|
25852
|
+
type Error = {
|
|
26037
25853
|
type: string;
|
|
26038
25854
|
title?: string;
|
|
26039
25855
|
detail?: string;
|
|
@@ -26041,27 +25857,10 @@ declare namespace ShopperSearchTypes {
|
|
|
26041
25857
|
} & {
|
|
26042
25858
|
[key: string]: any;
|
|
26043
25859
|
};
|
|
26044
|
-
type
|
|
26045
|
-
|
|
26046
|
-
|
|
26047
|
-
|
|
26048
|
-
lastModifiedBy?: string;
|
|
26049
|
-
} & {
|
|
26050
|
-
[key: string]: any;
|
|
26051
|
-
};
|
|
26052
|
-
type ChangeControlledDataType = {
|
|
26053
|
-
creationDate?: any;
|
|
26054
|
-
modificationDate?: any;
|
|
26055
|
-
createdBy?: string;
|
|
26056
|
-
lastModifiedBy?: string;
|
|
26057
|
-
} & {
|
|
26058
|
-
[key: string]: any;
|
|
26059
|
-
};
|
|
26060
|
-
type Error = {
|
|
26061
|
-
type: string;
|
|
26062
|
-
title?: string;
|
|
26063
|
-
detail?: string;
|
|
26064
|
-
instance?: string;
|
|
25860
|
+
type ProductPriceTable = {
|
|
25861
|
+
price?: number;
|
|
25862
|
+
pricebook?: string;
|
|
25863
|
+
quantity?: number;
|
|
26065
25864
|
} & {
|
|
26066
25865
|
[key: string]: any;
|
|
26067
25866
|
};
|
|
@@ -26076,6 +25875,13 @@ declare namespace ShopperSearchTypes {
|
|
|
26076
25875
|
} & {
|
|
26077
25876
|
[key: string]: any;
|
|
26078
25877
|
};
|
|
25878
|
+
type PriceRange = {
|
|
25879
|
+
maxPrice?: number;
|
|
25880
|
+
minPrice?: number;
|
|
25881
|
+
pricebook?: string;
|
|
25882
|
+
} & {
|
|
25883
|
+
[key: string]: any;
|
|
25884
|
+
};
|
|
26079
25885
|
type CategorySuggestions = {
|
|
26080
25886
|
categories?: Array<SuggestedCategory>;
|
|
26081
25887
|
suggestedPhrases?: Array<SuggestedPhrase>;
|
|
@@ -26084,7 +25890,7 @@ declare namespace ShopperSearchTypes {
|
|
|
26084
25890
|
[key: string]: any;
|
|
26085
25891
|
};
|
|
26086
25892
|
type SuggestedProduct = {
|
|
26087
|
-
currency:
|
|
25893
|
+
currency: any;
|
|
26088
25894
|
price: number;
|
|
26089
25895
|
productId: string;
|
|
26090
25896
|
productName: string;
|
|
@@ -26129,6 +25935,28 @@ declare namespace ShopperSearchTypes {
|
|
|
26129
25935
|
} & {
|
|
26130
25936
|
[key: string]: any;
|
|
26131
25937
|
};
|
|
25938
|
+
type Variant = {
|
|
25939
|
+
orderable?: boolean;
|
|
25940
|
+
price?: number;
|
|
25941
|
+
productId: string;
|
|
25942
|
+
tieredPrices?: Array<ProductPriceTable>;
|
|
25943
|
+
variationValues?: {} & {
|
|
25944
|
+
[key: string]: any;
|
|
25945
|
+
};
|
|
25946
|
+
productPromotions?: Array<ProductPromotion$1>;
|
|
25947
|
+
} & {
|
|
25948
|
+
[key: string]: any;
|
|
25949
|
+
};
|
|
25950
|
+
type VariationGroup = {
|
|
25951
|
+
orderable: boolean;
|
|
25952
|
+
price: number;
|
|
25953
|
+
productId: string;
|
|
25954
|
+
variationValues: {} & {
|
|
25955
|
+
[key: string]: any;
|
|
25956
|
+
};
|
|
25957
|
+
} & {
|
|
25958
|
+
[key: string]: any;
|
|
25959
|
+
};
|
|
26132
25960
|
type BrandSuggestions = {} & {
|
|
26133
25961
|
[key: string]: any;
|
|
26134
25962
|
};
|
|
@@ -26148,6 +25976,13 @@ declare namespace ShopperSearchTypes {
|
|
|
26148
25976
|
} & {
|
|
26149
25977
|
[key: string]: any;
|
|
26150
25978
|
};
|
|
25979
|
+
type ImageGroup = {
|
|
25980
|
+
images: Array<Image$1>;
|
|
25981
|
+
variationAttributes?: Array<VariationAttribute>;
|
|
25982
|
+
viewType: string;
|
|
25983
|
+
} & {
|
|
25984
|
+
[key: string]: any;
|
|
25985
|
+
};
|
|
26151
25986
|
type SuggestedTerm = {
|
|
26152
25987
|
completed: boolean;
|
|
26153
25988
|
corrected: boolean;
|
|
@@ -26171,7 +26006,7 @@ declare namespace ShopperSearchTypes {
|
|
|
26171
26006
|
[key: string]: any;
|
|
26172
26007
|
};
|
|
26173
26008
|
type ProductSearchHit = {
|
|
26174
|
-
currency?:
|
|
26009
|
+
currency?: any;
|
|
26175
26010
|
hitType?: string;
|
|
26176
26011
|
image?: Image$1;
|
|
26177
26012
|
orderable?: boolean;
|
|
@@ -26186,6 +26021,12 @@ declare namespace ShopperSearchTypes {
|
|
|
26186
26021
|
representedProduct?: ProductRef;
|
|
26187
26022
|
representedProducts?: Array<ProductRef>;
|
|
26188
26023
|
variationAttributes?: Array<VariationAttribute>;
|
|
26024
|
+
imageGroups?: Array<ImageGroup>;
|
|
26025
|
+
priceRanges?: Array<PriceRange>;
|
|
26026
|
+
productPromotions?: Array<ProductPromotion$1>;
|
|
26027
|
+
tieredPrices?: Array<ProductPriceTable>;
|
|
26028
|
+
variants?: Array<Variant>;
|
|
26029
|
+
variationGroups?: Array<VariationGroup>;
|
|
26189
26030
|
} & {
|
|
26190
26031
|
[key: string]: any;
|
|
26191
26032
|
};
|
|
@@ -26223,6 +26064,13 @@ declare namespace ShopperSearchTypes {
|
|
|
26223
26064
|
} & {
|
|
26224
26065
|
[key: string]: any;
|
|
26225
26066
|
};
|
|
26067
|
+
type ProductPromotion = {
|
|
26068
|
+
calloutMsg: string;
|
|
26069
|
+
promotionId: string;
|
|
26070
|
+
promotionalPrice: number;
|
|
26071
|
+
} & {
|
|
26072
|
+
[key: string]: any;
|
|
26073
|
+
};
|
|
26226
26074
|
type Suggestion = {
|
|
26227
26075
|
suggestedPhrases?: Array<SuggestedPhrase>;
|
|
26228
26076
|
suggestedTerms: Array<SuggestedTerms>;
|
|
@@ -26248,13 +26096,17 @@ declare namespace ShopperSearchTypes {
|
|
|
26248
26096
|
* All query parameters that are used by at least one ShopperSearch method.
|
|
26249
26097
|
*/
|
|
26250
26098
|
type ShopperSearchQueryParameters = {
|
|
26251
|
-
|
|
26099
|
+
select?: any;
|
|
26100
|
+
siteId?: any;
|
|
26252
26101
|
q?: string;
|
|
26253
26102
|
refine?: Array<string>;
|
|
26254
26103
|
sort?: string;
|
|
26255
|
-
currency?:
|
|
26256
|
-
locale?:
|
|
26104
|
+
currency?: any;
|
|
26105
|
+
locale?: any;
|
|
26257
26106
|
expand?: Array<string>;
|
|
26107
|
+
allImages?: boolean;
|
|
26108
|
+
perPricebook?: boolean;
|
|
26109
|
+
allVariationProperties?: boolean;
|
|
26258
26110
|
offset?: any;
|
|
26259
26111
|
limit?: number;
|
|
26260
26112
|
};
|
|
@@ -26285,7 +26137,7 @@ declare namespace ShopperSearchTypes {
|
|
|
26285
26137
|
* ```
|
|
26286
26138
|
*
|
|
26287
26139
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
26288
|
-
* API Version: 1.0.
|
|
26140
|
+
* API Version: 1.0.38<br />
|
|
26289
26141
|
* Last Updated: <br />
|
|
26290
26142
|
* </span>
|
|
26291
26143
|
|
|
@@ -26307,7 +26159,8 @@ declare namespace ShopperSearchTypes {
|
|
|
26307
26159
|
*
|
|
26308
26160
|
* @param options - An object containing the options for this method.
|
|
26309
26161
|
* @param parameters - An object containing the parameters for this method.
|
|
26310
|
-
* @param organizationId -
|
|
26162
|
+
* @param organizationId -
|
|
26163
|
+
* @param select - The property selector declaring which fields are included into the response payload. You can specify a single field name, a comma-separated list of names, or work with wildcards.You can also sepcify Array Operations and filter expressions.The actual selector value must be enclosed within parentheses.
|
|
26311
26164
|
* @param siteId -
|
|
26312
26165
|
* @param q - The query phrase to search for. For example to search for a product "shirt", type q=shirt.
|
|
26313
26166
|
* @param refine - Parameter that represents a refinement attribute or values pair. Refinement attribute ID and
|
|
@@ -26324,7 +26177,10 @@ declare namespace ShopperSearchTypes {
|
|
|
26324
26177
|
* @param sort - The ID of the sorting option to sort the search hits.
|
|
26325
26178
|
* @param currency - The currency mnemonic specified for price. This parameter is effective only if the returned results contain prices.
|
|
26326
26179
|
* @param locale -
|
|
26327
|
-
* @param expand - The expand parameter. A list with the allowed values (availability, images, prices, represented_products, variations).
|
|
26180
|
+
* @param expand - The expand parameter. A comma-separated list with the allowed values (availability, images, prices, represented_products, variations, promotions, custom_properties). The expand parameter `availability, images, prices, represented_products, variations` is used as the default value when no expand parameter is provided. The value `none` can be used to turn off all expand options. The expand values `promotions` and `custom_properties` are optional and are available from version 24.3 and 24.4, respectively.
|
|
26181
|
+
* @param allImages - When this flag is passed along with the expand parameter `images` in the request, a property named `imageGroups`, which contains an image model, is returned in the response. If the flag is set to `true`, the whole image model is returned. If it is set to `false`, the returned image model contains only matching images. If no flag is passed in the request, the response does not include the `imageGroups property`. This parameter is available from version 24.3.
|
|
26182
|
+
* @param perPricebook - When this flag is passed as `true` in the request, along with the expand parameter `prices`, then per PriceBook prices and tiered prices (if available) are returned. This parameter is available from version 24.3.
|
|
26183
|
+
* @param allVariationProperties - The flag that indicates which variation properties are to be included in the result. When the flag is passed as `true` along with the expand parameter `variations` in the request, all variation properties (`variationAttributes`, `variationGroups`, and `variants`) are returned. When it is passed as `false` along with the expand parameter `variations` in the request, only the default property (`variationAttributes`) is returned. This parameter is available from version 24.3.
|
|
26328
26184
|
* @param offset -
|
|
26329
26185
|
* @param limit - Maximum records to retrieve per request, not to exceed 200. Defaults to 25.
|
|
26330
26186
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
@@ -26336,13 +26192,17 @@ declare namespace ShopperSearchTypes {
|
|
|
26336
26192
|
productSearch(options?: RequireParametersUnlessAllAreOptional<{
|
|
26337
26193
|
parameters?: CompositeParameters<{
|
|
26338
26194
|
organizationId: string;
|
|
26339
|
-
|
|
26195
|
+
select?: any;
|
|
26196
|
+
siteId: any;
|
|
26340
26197
|
q?: string;
|
|
26341
26198
|
refine?: Array<string>;
|
|
26342
26199
|
sort?: string;
|
|
26343
|
-
currency?:
|
|
26344
|
-
locale?:
|
|
26200
|
+
currency?: any;
|
|
26201
|
+
locale?: any;
|
|
26345
26202
|
expand?: Array<string>;
|
|
26203
|
+
allImages?: boolean;
|
|
26204
|
+
perPricebook?: boolean;
|
|
26205
|
+
allVariationProperties?: boolean;
|
|
26346
26206
|
offset?: any;
|
|
26347
26207
|
limit?: number;
|
|
26348
26208
|
} & {
|
|
@@ -26358,7 +26218,8 @@ declare namespace ShopperSearchTypes {
|
|
|
26358
26218
|
*
|
|
26359
26219
|
* @param options - An object containing the options for this method.
|
|
26360
26220
|
* @param parameters - An object containing the parameters for this method.
|
|
26361
|
-
* @param organizationId -
|
|
26221
|
+
* @param organizationId -
|
|
26222
|
+
* @param select - The property selector declaring which fields are included into the response payload. You can specify a single field name, a comma-separated list of names, or work with wildcards.You can also sepcify Array Operations and filter expressions.The actual selector value must be enclosed within parentheses.
|
|
26362
26223
|
* @param siteId -
|
|
26363
26224
|
* @param q - The query phrase to search for. For example to search for a product "shirt", type q=shirt.
|
|
26364
26225
|
* @param refine - Parameter that represents a refinement attribute or values pair. Refinement attribute ID and
|
|
@@ -26375,7 +26236,10 @@ declare namespace ShopperSearchTypes {
|
|
|
26375
26236
|
* @param sort - The ID of the sorting option to sort the search hits.
|
|
26376
26237
|
* @param currency - The currency mnemonic specified for price. This parameter is effective only if the returned results contain prices.
|
|
26377
26238
|
* @param locale -
|
|
26378
|
-
* @param expand - The expand parameter. A list with the allowed values (availability, images, prices, represented_products, variations).
|
|
26239
|
+
* @param expand - The expand parameter. A comma-separated list with the allowed values (availability, images, prices, represented_products, variations, promotions, custom_properties). The expand parameter `availability, images, prices, represented_products, variations` is used as the default value when no expand parameter is provided. The value `none` can be used to turn off all expand options. The expand values `promotions` and `custom_properties` are optional and are available from version 24.3 and 24.4, respectively.
|
|
26240
|
+
* @param allImages - When this flag is passed along with the expand parameter `images` in the request, a property named `imageGroups`, which contains an image model, is returned in the response. If the flag is set to `true`, the whole image model is returned. If it is set to `false`, the returned image model contains only matching images. If no flag is passed in the request, the response does not include the `imageGroups property`. This parameter is available from version 24.3.
|
|
26241
|
+
* @param perPricebook - When this flag is passed as `true` in the request, along with the expand parameter `prices`, then per PriceBook prices and tiered prices (if available) are returned. This parameter is available from version 24.3.
|
|
26242
|
+
* @param allVariationProperties - The flag that indicates which variation properties are to be included in the result. When the flag is passed as `true` along with the expand parameter `variations` in the request, all variation properties (`variationAttributes`, `variationGroups`, and `variants`) are returned. When it is passed as `false` along with the expand parameter `variations` in the request, only the default property (`variationAttributes`) is returned. This parameter is available from version 24.3.
|
|
26379
26243
|
* @param offset -
|
|
26380
26244
|
* @param limit - Maximum records to retrieve per request, not to exceed 200. Defaults to 25.
|
|
26381
26245
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
@@ -26387,13 +26251,17 @@ declare namespace ShopperSearchTypes {
|
|
|
26387
26251
|
productSearch<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
|
|
26388
26252
|
parameters?: CompositeParameters<{
|
|
26389
26253
|
organizationId: string;
|
|
26390
|
-
|
|
26254
|
+
select?: any;
|
|
26255
|
+
siteId: any;
|
|
26391
26256
|
q?: string;
|
|
26392
26257
|
refine?: Array<string>;
|
|
26393
26258
|
sort?: string;
|
|
26394
|
-
currency?:
|
|
26395
|
-
locale?:
|
|
26259
|
+
currency?: any;
|
|
26260
|
+
locale?: any;
|
|
26396
26261
|
expand?: Array<string>;
|
|
26262
|
+
allImages?: boolean;
|
|
26263
|
+
perPricebook?: boolean;
|
|
26264
|
+
allVariationProperties?: boolean;
|
|
26397
26265
|
offset?: any;
|
|
26398
26266
|
limit?: number;
|
|
26399
26267
|
} & {
|
|
@@ -26410,7 +26278,7 @@ declare namespace ShopperSearchTypes {
|
|
|
26410
26278
|
*
|
|
26411
26279
|
* @param options - An object containing the options for this method.
|
|
26412
26280
|
* @param parameters - An object containing the parameters for this method.
|
|
26413
|
-
* @param organizationId -
|
|
26281
|
+
* @param organizationId -
|
|
26414
26282
|
* @param siteId -
|
|
26415
26283
|
* @param q - The search phrase (q) for which suggestions are evaluated. Search suggestions are determined when the search phrase input is at least three (default) characters long. The value is configurable in the Business Manager.
|
|
26416
26284
|
* @param limit - The maximum number of suggestions made per request. If no value is defined, by default five suggestions per suggestion type are evaluated. This affects all types of suggestions (category, product, brand, and custom suggestions).
|
|
@@ -26425,11 +26293,11 @@ declare namespace ShopperSearchTypes {
|
|
|
26425
26293
|
getSearchSuggestions(options?: RequireParametersUnlessAllAreOptional<{
|
|
26426
26294
|
parameters?: CompositeParameters<{
|
|
26427
26295
|
organizationId: string;
|
|
26428
|
-
siteId:
|
|
26296
|
+
siteId: any;
|
|
26429
26297
|
q: string;
|
|
26430
26298
|
limit?: number;
|
|
26431
|
-
currency?:
|
|
26432
|
-
locale?:
|
|
26299
|
+
currency?: any;
|
|
26300
|
+
locale?: any;
|
|
26433
26301
|
} & {
|
|
26434
26302
|
[key in `c_${string}`]: any;
|
|
26435
26303
|
}, ConfigParameters>;
|
|
@@ -26442,7 +26310,7 @@ declare namespace ShopperSearchTypes {
|
|
|
26442
26310
|
*
|
|
26443
26311
|
* @param options - An object containing the options for this method.
|
|
26444
26312
|
* @param parameters - An object containing the parameters for this method.
|
|
26445
|
-
* @param organizationId -
|
|
26313
|
+
* @param organizationId -
|
|
26446
26314
|
* @param siteId -
|
|
26447
26315
|
* @param q - The search phrase (q) for which suggestions are evaluated. Search suggestions are determined when the search phrase input is at least three (default) characters long. The value is configurable in the Business Manager.
|
|
26448
26316
|
* @param limit - The maximum number of suggestions made per request. If no value is defined, by default five suggestions per suggestion type are evaluated. This affects all types of suggestions (category, product, brand, and custom suggestions).
|
|
@@ -26457,11 +26325,11 @@ declare namespace ShopperSearchTypes {
|
|
|
26457
26325
|
getSearchSuggestions<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
|
|
26458
26326
|
parameters?: CompositeParameters<{
|
|
26459
26327
|
organizationId: string;
|
|
26460
|
-
siteId:
|
|
26328
|
+
siteId: any;
|
|
26461
26329
|
q: string;
|
|
26462
26330
|
limit?: number;
|
|
26463
|
-
currency?:
|
|
26464
|
-
locale?:
|
|
26331
|
+
currency?: any;
|
|
26332
|
+
locale?: any;
|
|
26465
26333
|
} & {
|
|
26466
26334
|
[key in `c_${string}`]: any;
|
|
26467
26335
|
}, ConfigParameters>;
|
|
@@ -26471,57 +26339,57 @@ declare namespace ShopperSearchTypes {
|
|
|
26471
26339
|
}>, rawResponse?: T): Promise<T extends true ? Response : SuggestionResult>;
|
|
26472
26340
|
}
|
|
26473
26341
|
}
|
|
26474
|
-
type BoolFilter$
|
|
26475
|
-
filters?: Array<Filter$
|
|
26342
|
+
type BoolFilter$9 = {
|
|
26343
|
+
filters?: Array<Filter$8>;
|
|
26476
26344
|
operator: string;
|
|
26477
26345
|
} & {
|
|
26478
26346
|
[key: string]: any;
|
|
26479
26347
|
};
|
|
26480
|
-
type MatchAllQuery$
|
|
26348
|
+
type MatchAllQuery$9 = {} & {
|
|
26481
26349
|
[key: string]: any;
|
|
26482
26350
|
};
|
|
26483
|
-
type FilteredQuery$
|
|
26484
|
-
filter: Filter$
|
|
26485
|
-
query: Query$
|
|
26351
|
+
type FilteredQuery$9 = {
|
|
26352
|
+
filter: Filter$8;
|
|
26353
|
+
query: Query$8;
|
|
26486
26354
|
} & {
|
|
26487
26355
|
[key: string]: any;
|
|
26488
26356
|
};
|
|
26489
|
-
type QueryFilter$
|
|
26490
|
-
query: Query$
|
|
26357
|
+
type QueryFilter$9 = {
|
|
26358
|
+
query: Query$8;
|
|
26491
26359
|
} & {
|
|
26492
26360
|
[key: string]: any;
|
|
26493
26361
|
};
|
|
26494
|
-
type Query$
|
|
26495
|
-
boolQuery?: BoolQuery$
|
|
26496
|
-
filteredQuery?: FilteredQuery$
|
|
26497
|
-
matchAllQuery?: MatchAllQuery$
|
|
26498
|
-
nestedQuery?: NestedQuery$
|
|
26499
|
-
termQuery?: TermQuery$
|
|
26500
|
-
textQuery?: TextQuery$
|
|
26362
|
+
type Query$9 = {
|
|
26363
|
+
boolQuery?: BoolQuery$8;
|
|
26364
|
+
filteredQuery?: FilteredQuery$9;
|
|
26365
|
+
matchAllQuery?: MatchAllQuery$9;
|
|
26366
|
+
nestedQuery?: NestedQuery$8;
|
|
26367
|
+
termQuery?: TermQuery$8;
|
|
26368
|
+
textQuery?: TextQuery$8;
|
|
26501
26369
|
} & {
|
|
26502
26370
|
[key: string]: any;
|
|
26503
26371
|
};
|
|
26504
|
-
type TermQuery$
|
|
26372
|
+
type TermQuery$9 = {
|
|
26505
26373
|
fields: Array<string>;
|
|
26506
26374
|
operator: string;
|
|
26507
26375
|
values?: Array<any>;
|
|
26508
26376
|
} & {
|
|
26509
26377
|
[key: string]: any;
|
|
26510
26378
|
};
|
|
26511
|
-
type TermFilter$
|
|
26379
|
+
type TermFilter$9 = {
|
|
26512
26380
|
field: string;
|
|
26513
26381
|
operator: string;
|
|
26514
26382
|
values?: Array<any>;
|
|
26515
26383
|
} & {
|
|
26516
26384
|
[key: string]: any;
|
|
26517
26385
|
};
|
|
26518
|
-
type TextQuery$
|
|
26386
|
+
type TextQuery$9 = {
|
|
26519
26387
|
fields: Array<string>;
|
|
26520
26388
|
searchPhrase: string;
|
|
26521
26389
|
} & {
|
|
26522
26390
|
[key: string]: any;
|
|
26523
26391
|
};
|
|
26524
|
-
type Range2Filter$
|
|
26392
|
+
type Range2Filter$9 = {
|
|
26525
26393
|
filterMode?: string;
|
|
26526
26394
|
fromField: string;
|
|
26527
26395
|
fromInclusive?: boolean;
|
|
@@ -26532,36 +26400,36 @@ type Range2Filter$10 = {
|
|
|
26532
26400
|
} & {
|
|
26533
26401
|
[key: string]: any;
|
|
26534
26402
|
};
|
|
26535
|
-
type BoolQuery$
|
|
26536
|
-
must?: Array<Query$
|
|
26537
|
-
mustNot?: Array<Query$
|
|
26538
|
-
should?: Array<Query$
|
|
26403
|
+
type BoolQuery$9 = {
|
|
26404
|
+
must?: Array<Query$9>;
|
|
26405
|
+
mustNot?: Array<Query$9>;
|
|
26406
|
+
should?: Array<Query$9>;
|
|
26539
26407
|
} & {
|
|
26540
26408
|
[key: string]: any;
|
|
26541
26409
|
};
|
|
26542
|
-
type NestedQuery$
|
|
26410
|
+
type NestedQuery$9 = {
|
|
26543
26411
|
path: string;
|
|
26544
|
-
query: Query$
|
|
26412
|
+
query: Query$9;
|
|
26545
26413
|
scoreMode?: string;
|
|
26546
26414
|
} & {
|
|
26547
26415
|
[key: string]: any;
|
|
26548
26416
|
};
|
|
26549
|
-
type Filter$
|
|
26550
|
-
boolFilter?: BoolFilter$
|
|
26551
|
-
queryFilter?: QueryFilter$
|
|
26552
|
-
range2Filter?: Range2Filter$
|
|
26553
|
-
rangeFilter?: RangeFilter$
|
|
26554
|
-
termFilter?: TermFilter$
|
|
26417
|
+
type Filter$9 = {
|
|
26418
|
+
boolFilter?: BoolFilter$9;
|
|
26419
|
+
queryFilter?: QueryFilter$9;
|
|
26420
|
+
range2Filter?: Range2Filter$9;
|
|
26421
|
+
rangeFilter?: RangeFilter$8;
|
|
26422
|
+
termFilter?: TermFilter$9;
|
|
26555
26423
|
} & {
|
|
26556
26424
|
[key: string]: any;
|
|
26557
26425
|
};
|
|
26558
|
-
type Sort$
|
|
26426
|
+
type Sort$9 = {
|
|
26559
26427
|
field: string;
|
|
26560
26428
|
sortOrder?: string;
|
|
26561
26429
|
} & {
|
|
26562
26430
|
[key: string]: any;
|
|
26563
26431
|
};
|
|
26564
|
-
type RangeFilter$
|
|
26432
|
+
type RangeFilter$9 = {
|
|
26565
26433
|
field: string;
|
|
26566
26434
|
from?: any;
|
|
26567
26435
|
fromInclusive?: boolean;
|
|
@@ -26570,12 +26438,12 @@ type RangeFilter$10 = {
|
|
|
26570
26438
|
} & {
|
|
26571
26439
|
[key: string]: any;
|
|
26572
26440
|
};
|
|
26573
|
-
type L10nString$
|
|
26441
|
+
type L10nString$8 = {} & {
|
|
26574
26442
|
[key: string]: any;
|
|
26575
26443
|
};
|
|
26576
|
-
type PropertyValueDefinition$
|
|
26577
|
-
description: L10nString$
|
|
26578
|
-
displayValue: L10nString$
|
|
26444
|
+
type PropertyValueDefinition$8 = {
|
|
26445
|
+
description: L10nString$8;
|
|
26446
|
+
displayValue: L10nString$8;
|
|
26579
26447
|
id: string;
|
|
26580
26448
|
position?: number;
|
|
26581
26449
|
value: string;
|
|
@@ -26636,7 +26504,7 @@ type ShopperSeoParameters = ShopperSeoPathParameters & BaseUriParameters & Shopp
|
|
|
26636
26504
|
* ```
|
|
26637
26505
|
*
|
|
26638
26506
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
26639
|
-
* API Version: 1.0.
|
|
26507
|
+
* API Version: 1.0.6<br />
|
|
26640
26508
|
* Last Updated: <br />
|
|
26641
26509
|
* </span>
|
|
26642
26510
|
|
|
@@ -26828,17 +26696,17 @@ declare namespace ShopperSeoTypes {
|
|
|
26828
26696
|
};
|
|
26829
26697
|
type SearchRequest = {
|
|
26830
26698
|
limit?: number;
|
|
26831
|
-
query: Query$
|
|
26832
|
-
sorts?: Array<Sort$
|
|
26699
|
+
query: Query$9;
|
|
26700
|
+
sorts?: Array<Sort$9>;
|
|
26833
26701
|
offset?: any;
|
|
26834
26702
|
} & {
|
|
26835
26703
|
[key: string]: any;
|
|
26836
26704
|
};
|
|
26837
26705
|
type PropertyDefinition = {
|
|
26838
|
-
defaultValue?: PropertyValueDefinition$
|
|
26706
|
+
defaultValue?: PropertyValueDefinition$8;
|
|
26839
26707
|
id?: string;
|
|
26840
|
-
name: L10nString$
|
|
26841
|
-
description: L10nString$
|
|
26708
|
+
name: L10nString$8;
|
|
26709
|
+
description: L10nString$8;
|
|
26842
26710
|
key?: boolean;
|
|
26843
26711
|
localizable?: boolean;
|
|
26844
26712
|
mandatory?: boolean;
|
|
@@ -26851,8 +26719,8 @@ declare namespace ShopperSeoTypes {
|
|
|
26851
26719
|
searchable?: boolean;
|
|
26852
26720
|
siteSpecific?: boolean;
|
|
26853
26721
|
system?: boolean;
|
|
26854
|
-
unit?: L10nString$
|
|
26855
|
-
possibleValues?: Array<PropertyValueDefinition$
|
|
26722
|
+
unit?: L10nString$8;
|
|
26723
|
+
possibleValues?: Array<PropertyValueDefinition$8>;
|
|
26856
26724
|
type: string;
|
|
26857
26725
|
visible?: boolean;
|
|
26858
26726
|
} & {
|
|
@@ -26862,8 +26730,8 @@ declare namespace ShopperSeoTypes {
|
|
|
26862
26730
|
[key: string]: any;
|
|
26863
26731
|
};
|
|
26864
26732
|
type PaginatedSearchResult = {
|
|
26865
|
-
query: Query$
|
|
26866
|
-
sorts?: Array<Sort$
|
|
26733
|
+
query: Query$9;
|
|
26734
|
+
sorts?: Array<Sort$9>;
|
|
26867
26735
|
limit: number;
|
|
26868
26736
|
hits?: Array<object>;
|
|
26869
26737
|
offset: any;
|
|
@@ -26882,14 +26750,14 @@ declare namespace ShopperSeoTypes {
|
|
|
26882
26750
|
[key: string]: any;
|
|
26883
26751
|
};
|
|
26884
26752
|
type BoolFilter = {
|
|
26885
|
-
filters?: Array<Filter$
|
|
26753
|
+
filters?: Array<Filter$9>;
|
|
26886
26754
|
operator: string;
|
|
26887
26755
|
} & {
|
|
26888
26756
|
[key: string]: any;
|
|
26889
26757
|
};
|
|
26890
26758
|
type PaginatedSearchResultBase = {
|
|
26891
|
-
query: Query$
|
|
26892
|
-
sorts?: Array<Sort$
|
|
26759
|
+
query: Query$9;
|
|
26760
|
+
sorts?: Array<Sort$9>;
|
|
26893
26761
|
limit: number;
|
|
26894
26762
|
hits?: Array<object>;
|
|
26895
26763
|
offset: any;
|
|
@@ -26901,23 +26769,23 @@ declare namespace ShopperSeoTypes {
|
|
|
26901
26769
|
[key: string]: any;
|
|
26902
26770
|
};
|
|
26903
26771
|
type FilteredQuery = {
|
|
26904
|
-
filter: Filter$
|
|
26905
|
-
query: Query$
|
|
26772
|
+
filter: Filter$9;
|
|
26773
|
+
query: Query$9;
|
|
26906
26774
|
} & {
|
|
26907
26775
|
[key: string]: any;
|
|
26908
26776
|
};
|
|
26909
26777
|
type QueryFilter = {
|
|
26910
|
-
query: Query$
|
|
26778
|
+
query: Query$9;
|
|
26911
26779
|
} & {
|
|
26912
26780
|
[key: string]: any;
|
|
26913
26781
|
};
|
|
26914
26782
|
type Query = {
|
|
26915
|
-
boolQuery?: BoolQuery$
|
|
26783
|
+
boolQuery?: BoolQuery$9;
|
|
26916
26784
|
filteredQuery?: FilteredQuery;
|
|
26917
26785
|
matchAllQuery?: MatchAllQuery;
|
|
26918
|
-
nestedQuery?: NestedQuery$
|
|
26919
|
-
termQuery?: TermQuery$
|
|
26920
|
-
textQuery?: TextQuery$
|
|
26786
|
+
nestedQuery?: NestedQuery$9;
|
|
26787
|
+
termQuery?: TermQuery$9;
|
|
26788
|
+
textQuery?: TextQuery$9;
|
|
26921
26789
|
} & {
|
|
26922
26790
|
[key: string]: any;
|
|
26923
26791
|
};
|
|
@@ -26978,7 +26846,7 @@ declare namespace ShopperSeoTypes {
|
|
|
26978
26846
|
boolFilter?: BoolFilter;
|
|
26979
26847
|
queryFilter?: QueryFilter;
|
|
26980
26848
|
range2Filter?: Range2Filter;
|
|
26981
|
-
rangeFilter?: RangeFilter$
|
|
26849
|
+
rangeFilter?: RangeFilter$9;
|
|
26982
26850
|
termFilter?: TermFilter;
|
|
26983
26851
|
} & {
|
|
26984
26852
|
[key: string]: any;
|
|
@@ -27016,7 +26884,7 @@ declare namespace ShopperSeoTypes {
|
|
|
27016
26884
|
[key: string]: any;
|
|
27017
26885
|
};
|
|
27018
26886
|
type AttributeDefinition = {
|
|
27019
|
-
defaultValue?: PropertyValueDefinition$
|
|
26887
|
+
defaultValue?: PropertyValueDefinition$8;
|
|
27020
26888
|
id?: string;
|
|
27021
26889
|
name: L10nString;
|
|
27022
26890
|
description: L10nString;
|
|
@@ -27033,7 +26901,7 @@ declare namespace ShopperSeoTypes {
|
|
|
27033
26901
|
siteSpecific?: boolean;
|
|
27034
26902
|
system?: boolean;
|
|
27035
26903
|
unit?: L10nString;
|
|
27036
|
-
possibleValues?: Array<PropertyValueDefinition$
|
|
26904
|
+
possibleValues?: Array<PropertyValueDefinition$8>;
|
|
27037
26905
|
type: string;
|
|
27038
26906
|
visible?: boolean;
|
|
27039
26907
|
};
|
|
@@ -27132,7 +27000,7 @@ declare namespace ShopperSeoTypes {
|
|
|
27132
27000
|
* ```
|
|
27133
27001
|
*
|
|
27134
27002
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
27135
|
-
* API Version: 1.0.
|
|
27003
|
+
* API Version: 1.0.6<br />
|
|
27136
27004
|
* Last Updated: <br />
|
|
27137
27005
|
* </span>
|
|
27138
27006
|
|
|
@@ -27808,7 +27676,7 @@ declare namespace helpers {
|
|
|
27808
27676
|
* ```
|
|
27809
27677
|
*
|
|
27810
27678
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
27811
|
-
* API Version: 1.39.
|
|
27679
|
+
* API Version: 1.39.22<br />
|
|
27812
27680
|
* Last Updated: <br />
|
|
27813
27681
|
* </span>
|
|
27814
27682
|
|