commerce-sdk-isomorphic 2.1.0-dev.0 → 3.0.0
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 +36 -0
- package/README.md +69 -117
- package/lib/index.cjs.d.ts +623 -179
- package/lib/index.cjs.js +1 -1
- package/lib/index.esm.d.ts +623 -179
- package/lib/index.esm.js +1 -1
- package/package.json +3 -3
package/lib/index.esm.d.ts
CHANGED
|
@@ -241,12 +241,6 @@ type OrderAddress = {
|
|
|
241
241
|
} & {
|
|
242
242
|
[key: string]: any;
|
|
243
243
|
};
|
|
244
|
-
type BasketsResult = {
|
|
245
|
-
baskets: Array<Basket>;
|
|
246
|
-
total: number;
|
|
247
|
-
} & {
|
|
248
|
-
[key: string]: any;
|
|
249
|
-
};
|
|
250
244
|
type PriceAdjustmentRequest = {
|
|
251
245
|
discount?: DiscountRequest;
|
|
252
246
|
itemId?: string;
|
|
@@ -579,6 +573,8 @@ type Order = {
|
|
|
579
573
|
externalOrderStatus?: string;
|
|
580
574
|
giftCertificateItems?: Array<GiftCertificateItem>;
|
|
581
575
|
globalPartyId?: string;
|
|
576
|
+
groupedTaxItems?: Array<GroupedTaxItem>;
|
|
577
|
+
guest?: boolean;
|
|
582
578
|
lastModified?: any;
|
|
583
579
|
merchandizeTotalTax?: number;
|
|
584
580
|
notes?: SimpleLink;
|
|
@@ -600,6 +596,7 @@ type Order = {
|
|
|
600
596
|
siteId?: string;
|
|
601
597
|
sourceCode?: string;
|
|
602
598
|
status?: string;
|
|
599
|
+
taxRoundedAtGroup?: boolean;
|
|
603
600
|
taxTotal?: number;
|
|
604
601
|
taxation?: string;
|
|
605
602
|
} & {
|
|
@@ -670,8 +667,8 @@ type ShopperBasketsQueryParameters = {
|
|
|
670
667
|
overrideExisting?: boolean;
|
|
671
668
|
createDestinationBasket?: boolean;
|
|
672
669
|
productItemMergeMode?: string;
|
|
673
|
-
useAsShipping?: boolean;
|
|
674
670
|
removeExternalTax?: boolean;
|
|
671
|
+
useAsShipping?: boolean;
|
|
675
672
|
useAsBilling?: boolean;
|
|
676
673
|
exchange?: boolean;
|
|
677
674
|
};
|
|
@@ -702,7 +699,7 @@ type ShopperBasketsParameters = ShopperBasketsPathParameters & BaseUriParameters
|
|
|
702
699
|
* ```
|
|
703
700
|
*
|
|
704
701
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
705
|
-
* API Version: 2.0.
|
|
702
|
+
* API Version: 2.0.9<br />
|
|
706
703
|
* Last Updated: <br />
|
|
707
704
|
* </span>
|
|
708
705
|
*
|
|
@@ -772,6 +769,7 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
|
|
|
772
769
|
readonly updateBasket: readonly [
|
|
773
770
|
"organizationId",
|
|
774
771
|
"basketId",
|
|
772
|
+
"removeExternalTax",
|
|
775
773
|
"siteId",
|
|
776
774
|
"locale"
|
|
777
775
|
];
|
|
@@ -887,6 +885,18 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
|
|
|
887
885
|
"basketId",
|
|
888
886
|
"siteId"
|
|
889
887
|
];
|
|
888
|
+
readonly updateItemsInBasket: readonly [
|
|
889
|
+
"organizationId",
|
|
890
|
+
"basketId",
|
|
891
|
+
"removeExternalTax",
|
|
892
|
+
"siteId",
|
|
893
|
+
"locale"
|
|
894
|
+
];
|
|
895
|
+
readonly updateItemsInBasketRequired: readonly [
|
|
896
|
+
"organizationId",
|
|
897
|
+
"basketId",
|
|
898
|
+
"siteId"
|
|
899
|
+
];
|
|
890
900
|
readonly removeItemFromBasket: readonly [
|
|
891
901
|
"organizationId",
|
|
892
902
|
"basketId",
|
|
@@ -1317,7 +1327,7 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
|
|
|
1317
1327
|
};
|
|
1318
1328
|
}>, rawResponse?: T): Promise<T extends true ? Response : Basket>;
|
|
1319
1329
|
/**
|
|
1320
|
-
* Merge data from the previous shopper's basket into the current shopper's active basket and delete the previous shopper's basket. This endpoint doesn't merge Personally Identifiable Information (PII). You must obtain the shopper authorization token via SLAS and you must provide the ‘guest usid‘ in both the ‘/oauth2/login‘ and ‘/oauth2/token‘ calls while fetching the registered user JWT token. After the merge, all basket amounts are recalculated and totaled, including lookups for prices, taxes, shipping, and promotions.
|
|
1330
|
+
* Merge data from the previous shopper's basket into the current shopper's active basket and delete the previous shopper's basket. This endpoint doesn't merge Personally Identifiable Information (PII). You must obtain the shopper authorization token via SLAS and you must provide the ‘guest usid‘ in both the ‘/oauth2/login‘ and ‘/oauth2/token‘ calls while fetching the registered user JWT token. After the merge, all basket amounts are recalculated and totaled, including lookups for prices, taxes, shipping, and promotions, unless hooks are enabled.
|
|
1321
1331
|
|
|
1322
1332
|
The following information is merged:
|
|
1323
1333
|
- custom attributes on the basket and on all copied records
|
|
@@ -1398,7 +1408,7 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
|
|
|
1398
1408
|
};
|
|
1399
1409
|
}>): Promise<Basket>;
|
|
1400
1410
|
/**
|
|
1401
|
-
* Merge data from the previous shopper's basket into the current shopper's active basket and delete the previous shopper's basket. This endpoint doesn't merge Personally Identifiable Information (PII). You must obtain the shopper authorization token via SLAS and you must provide the ‘guest usid‘ in both the ‘/oauth2/login‘ and ‘/oauth2/token‘ calls while fetching the registered user JWT token. After the merge, all basket amounts are recalculated and totaled, including lookups for prices, taxes, shipping, and promotions.
|
|
1411
|
+
* Merge data from the previous shopper's basket into the current shopper's active basket and delete the previous shopper's basket. This endpoint doesn't merge Personally Identifiable Information (PII). You must obtain the shopper authorization token via SLAS and you must provide the ‘guest usid‘ in both the ‘/oauth2/login‘ and ‘/oauth2/token‘ calls while fetching the registered user JWT token. After the merge, all basket amounts are recalculated and totaled, including lookups for prices, taxes, shipping, and promotions, unless hooks are enabled.
|
|
1402
1412
|
|
|
1403
1413
|
The following information is merged:
|
|
1404
1414
|
- custom attributes on the basket and on all copied records
|
|
@@ -1608,6 +1618,7 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
|
|
|
1608
1618
|
* @param parameters - An object containing the parameters for this method.
|
|
1609
1619
|
* @param organizationId - An identifier for the organization the request is being made by.
|
|
1610
1620
|
* @param basketId - The ID of the basket to be modified.
|
|
1621
|
+
* @param removeExternalTax - If `true` (default value), the external tax rates are removed from the basket and set to null. To add external tax rates to a basket, use the `addTaxesForBasket` or `addTaxesForBasketItem` endpoint. The removal of external tax rates depends on the update performed on the basket, for example: an update to the `currency` triggers a removal. Set this parameter to `false` to disable the removal of external tax rates/values.
|
|
1611
1622
|
* @param siteId -
|
|
1612
1623
|
* @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
|
|
1613
1624
|
Below are some valid examples:
|
|
@@ -1626,6 +1637,7 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
|
|
|
1626
1637
|
parameters?: CompositeParameters<{
|
|
1627
1638
|
organizationId: string;
|
|
1628
1639
|
basketId: string;
|
|
1640
|
+
removeExternalTax?: boolean;
|
|
1629
1641
|
siteId: string;
|
|
1630
1642
|
locale?: string;
|
|
1631
1643
|
} & {
|
|
@@ -1644,6 +1656,7 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
|
|
|
1644
1656
|
* @param parameters - An object containing the parameters for this method.
|
|
1645
1657
|
* @param organizationId - An identifier for the organization the request is being made by.
|
|
1646
1658
|
* @param basketId - The ID of the basket to be modified.
|
|
1659
|
+
* @param removeExternalTax - If `true` (default value), the external tax rates are removed from the basket and set to null. To add external tax rates to a basket, use the `addTaxesForBasket` or `addTaxesForBasketItem` endpoint. The removal of external tax rates depends on the update performed on the basket, for example: an update to the `currency` triggers a removal. Set this parameter to `false` to disable the removal of external tax rates/values.
|
|
1647
1660
|
* @param siteId -
|
|
1648
1661
|
* @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
|
|
1649
1662
|
Below are some valid examples:
|
|
@@ -1662,6 +1675,7 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
|
|
|
1662
1675
|
parameters?: CompositeParameters<{
|
|
1663
1676
|
organizationId: string;
|
|
1664
1677
|
basketId: string;
|
|
1678
|
+
removeExternalTax?: boolean;
|
|
1665
1679
|
siteId: string;
|
|
1666
1680
|
locale?: string;
|
|
1667
1681
|
} & {
|
|
@@ -1750,9 +1764,7 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
|
|
|
1750
1764
|
* @param organizationId - An identifier for the organization the request is being made by.
|
|
1751
1765
|
* @param basketId - The ID of the basket to be modified.
|
|
1752
1766
|
* @param useAsShipping -
|
|
1753
|
-
* @param removeExternalTax -
|
|
1754
|
-
- true: (default) The basket's tax values are set to null and must be recalculated.
|
|
1755
|
-
- false: The basket's tax values don't change. Use this setting to prevent an unnecessary external tax call when the billing/shipping address change doesn't affect the tax calculation.
|
|
1767
|
+
* @param removeExternalTax - If `true` (default value), the external tax rates are removed from the basket and set to null. To add external tax rates to a basket, use the `addTaxesForBasket` or `addTaxesForBasketItem` endpoint. The removal of external tax rates depends on the update performed on the basket, for example: an update to the billing/shipping address triggers a removal. Set this parameter to `false` to disable the removal of external tax rates/values.
|
|
1756
1768
|
* @param siteId -
|
|
1757
1769
|
* @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
|
|
1758
1770
|
Below are some valid examples:
|
|
@@ -1791,9 +1803,7 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
|
|
|
1791
1803
|
* @param organizationId - An identifier for the organization the request is being made by.
|
|
1792
1804
|
* @param basketId - The ID of the basket to be modified.
|
|
1793
1805
|
* @param useAsShipping -
|
|
1794
|
-
* @param removeExternalTax -
|
|
1795
|
-
- true: (default) The basket's tax values are set to null and must be recalculated.
|
|
1796
|
-
- false: The basket's tax values don't change. Use this setting to prevent an unnecessary external tax call when the billing/shipping address change doesn't affect the tax calculation.
|
|
1806
|
+
* @param removeExternalTax - If `true` (default value), the external tax rates are removed from the basket and set to null. To add external tax rates to a basket, use the `addTaxesForBasket` or `addTaxesForBasketItem` endpoint. The removal of external tax rates depends on the update performed on the basket, for example: an update to the billing/shipping address triggers a removal. Set this parameter to `false` to disable the removal of external tax rates/values.
|
|
1797
1807
|
* @param siteId -
|
|
1798
1808
|
* @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
|
|
1799
1809
|
Below are some valid examples:
|
|
@@ -2382,6 +2392,146 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
|
|
|
2382
2392
|
};
|
|
2383
2393
|
body: Array<ProductItem>;
|
|
2384
2394
|
}>, rawResponse?: T): Promise<T extends true ? Response : Basket>;
|
|
2395
|
+
/**
|
|
2396
|
+
* Updates multiple items in a basket. This behaviour matches that of updating a
|
|
2397
|
+
single item, but the body contains an array of ProductItems to be updated that are identified by `itemId`.
|
|
2398
|
+
The items to update can include bundled product items, although the
|
|
2399
|
+
kind of update supported for bundled product items is limited to `productId`, `gift`, `giftMessage`
|
|
2400
|
+
and custom properties.
|
|
2401
|
+
The following values in the request body are considered by the server:
|
|
2402
|
+
|
|
2403
|
+
- `itemId` (mandatory): identifies an item to be updated.
|
|
2404
|
+
- `productId`: a valid product ID. The purpose of this
|
|
2405
|
+
value is to change the variation of a variation product.
|
|
2406
|
+
- `shipmentId`: a valid shipment ID. The purpose of
|
|
2407
|
+
this value is to move a product item to another shipment.
|
|
2408
|
+
- `quantity`: a number between 0 and 999. The purpose of
|
|
2409
|
+
this value is to change the quantity of the product item. If the quantity is 0,
|
|
2410
|
+
the product item is removed.
|
|
2411
|
+
- `optionItems`/`optionValueId`: a valid option value
|
|
2412
|
+
ID. The purpose of this value is to exchange an option value for an
|
|
2413
|
+
option item of an option product.
|
|
2414
|
+
This is only possible if the product item is an option product. To change
|
|
2415
|
+
option values, a collection of the option items to be changed must be
|
|
2416
|
+
provided in the property `optionItems`. Those
|
|
2417
|
+
`optionItems` must contain `optionId`
|
|
2418
|
+
and `optionValueId`. The provided values must be valid
|
|
2419
|
+
for the option product that this product item represents. Otherwise,
|
|
2420
|
+
`InvalidProductOptionItemException` or
|
|
2421
|
+
`InvalidProductOptionValueItemException` is thrown.
|
|
2422
|
+
- custom properties `c_\<CUSTOM_NAME\>`: a
|
|
2423
|
+
value corresponding to the type defined for custom attribute
|
|
2424
|
+
`\<CUSTOM_NAME\>` of the ProductLineItem. The purpose of this value is to
|
|
2425
|
+
add or change the value of a custom attribute defined for the
|
|
2426
|
+
ProductLineItem.
|
|
2427
|
+
- `gift`: a boolean value that specifies whether the item is a gift.
|
|
2428
|
+
- `giftMessage`: a message to include with the gift.
|
|
2429
|
+
*
|
|
2430
|
+
* If you would like to get a raw Response object use the other updateItemsInBasket function.
|
|
2431
|
+
*
|
|
2432
|
+
* @param options - An object containing the options for this method.
|
|
2433
|
+
* @param parameters - An object containing the parameters for this method.
|
|
2434
|
+
* @param organizationId - An identifier for the organization the request is being made by.
|
|
2435
|
+
* @param basketId - The ID of the basket to be modified.
|
|
2436
|
+
* @param removeExternalTax - If `true` (default value), the external tax rates are removed from the basket and set to null. To add external tax rates to a basket, use the `addTaxesForBasket` or `addTaxesForBasketItem` endpoint. The removal of external tax rates depends on the update performed on the basket, for example: an update to the product line item quantity triggers a removal. Set this parameter to `false` to disable the removal of external tax rates/values.
|
|
2437
|
+
* @param siteId -
|
|
2438
|
+
* @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
|
|
2439
|
+
Below are some valid examples:
|
|
2440
|
+
- en-US
|
|
2441
|
+
- de-AT
|
|
2442
|
+
- de
|
|
2443
|
+
- default
|
|
2444
|
+
* @param headers - An object literal of key value pairs of the headers to be
|
|
2445
|
+
* sent with this request.
|
|
2446
|
+
* @param body - The data to send as the request body.
|
|
2447
|
+
*
|
|
2448
|
+
* @returns A promise of type Basket.
|
|
2449
|
+
*
|
|
2450
|
+
*/
|
|
2451
|
+
updateItemsInBasket(options: RequireParametersUnlessAllAreOptional<{
|
|
2452
|
+
parameters?: CompositeParameters<{
|
|
2453
|
+
organizationId: string;
|
|
2454
|
+
basketId: string;
|
|
2455
|
+
removeExternalTax?: boolean;
|
|
2456
|
+
siteId: string;
|
|
2457
|
+
locale?: string;
|
|
2458
|
+
} & {
|
|
2459
|
+
[key in `c_${string}`]: any;
|
|
2460
|
+
}, ConfigParameters>;
|
|
2461
|
+
headers?: {
|
|
2462
|
+
[key: string]: string;
|
|
2463
|
+
};
|
|
2464
|
+
body: Array<ProductItem>;
|
|
2465
|
+
}>): Promise<Basket>;
|
|
2466
|
+
/**
|
|
2467
|
+
* Updates multiple items in a basket. This behaviour matches that of updating a
|
|
2468
|
+
single item, but the body contains an array of ProductItems to be updated that are identified by `itemId`.
|
|
2469
|
+
The items to update can include bundled product items, although the
|
|
2470
|
+
kind of update supported for bundled product items is limited to `productId`, `gift`, `giftMessage`
|
|
2471
|
+
and custom properties.
|
|
2472
|
+
The following values in the request body are considered by the server:
|
|
2473
|
+
|
|
2474
|
+
- `itemId` (mandatory): identifies an item to be updated.
|
|
2475
|
+
- `productId`: a valid product ID. The purpose of this
|
|
2476
|
+
value is to change the variation of a variation product.
|
|
2477
|
+
- `shipmentId`: a valid shipment ID. The purpose of
|
|
2478
|
+
this value is to move a product item to another shipment.
|
|
2479
|
+
- `quantity`: a number between 0 and 999. The purpose of
|
|
2480
|
+
this value is to change the quantity of the product item. If the quantity is 0,
|
|
2481
|
+
the product item is removed.
|
|
2482
|
+
- `optionItems`/`optionValueId`: a valid option value
|
|
2483
|
+
ID. The purpose of this value is to exchange an option value for an
|
|
2484
|
+
option item of an option product.
|
|
2485
|
+
This is only possible if the product item is an option product. To change
|
|
2486
|
+
option values, a collection of the option items to be changed must be
|
|
2487
|
+
provided in the property `optionItems`. Those
|
|
2488
|
+
`optionItems` must contain `optionId`
|
|
2489
|
+
and `optionValueId`. The provided values must be valid
|
|
2490
|
+
for the option product that this product item represents. Otherwise,
|
|
2491
|
+
`InvalidProductOptionItemException` or
|
|
2492
|
+
`InvalidProductOptionValueItemException` is thrown.
|
|
2493
|
+
- custom properties `c_\<CUSTOM_NAME\>`: a
|
|
2494
|
+
value corresponding to the type defined for custom attribute
|
|
2495
|
+
`\<CUSTOM_NAME\>` of the ProductLineItem. The purpose of this value is to
|
|
2496
|
+
add or change the value of a custom attribute defined for the
|
|
2497
|
+
ProductLineItem.
|
|
2498
|
+
- `gift`: a boolean value that specifies whether the item is a gift.
|
|
2499
|
+
- `giftMessage`: a message to include with the gift.
|
|
2500
|
+
*
|
|
2501
|
+
* @param options - An object containing the options for this method.
|
|
2502
|
+
* @param parameters - An object containing the parameters for this method.
|
|
2503
|
+
* @param organizationId - An identifier for the organization the request is being made by.
|
|
2504
|
+
* @param basketId - The ID of the basket to be modified.
|
|
2505
|
+
* @param removeExternalTax - If `true` (default value), the external tax rates are removed from the basket and set to null. To add external tax rates to a basket, use the `addTaxesForBasket` or `addTaxesForBasketItem` endpoint. The removal of external tax rates depends on the update performed on the basket, for example: an update to the product line item quantity triggers a removal. Set this parameter to `false` to disable the removal of external tax rates/values.
|
|
2506
|
+
* @param siteId -
|
|
2507
|
+
* @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
|
|
2508
|
+
Below are some valid examples:
|
|
2509
|
+
- en-US
|
|
2510
|
+
- de-AT
|
|
2511
|
+
- de
|
|
2512
|
+
- default
|
|
2513
|
+
* @param headers - An object literal of key value pairs of the headers to be
|
|
2514
|
+
* sent with this request.
|
|
2515
|
+
* @param body - The data to send as the request body.
|
|
2516
|
+
* @param rawResponse - Set to true to return entire Response object instead of DTO.
|
|
2517
|
+
* @returns A promise of type Response if rawResponse is true, a promise of type Basket otherwise.
|
|
2518
|
+
*
|
|
2519
|
+
*/
|
|
2520
|
+
updateItemsInBasket<T extends boolean>(options: RequireParametersUnlessAllAreOptional<{
|
|
2521
|
+
parameters?: CompositeParameters<{
|
|
2522
|
+
organizationId: string;
|
|
2523
|
+
basketId: string;
|
|
2524
|
+
removeExternalTax?: boolean;
|
|
2525
|
+
siteId: string;
|
|
2526
|
+
locale?: string;
|
|
2527
|
+
} & {
|
|
2528
|
+
[key in `c_${string}`]: any;
|
|
2529
|
+
}, ConfigParameters>;
|
|
2530
|
+
headers?: {
|
|
2531
|
+
[key: string]: string;
|
|
2532
|
+
};
|
|
2533
|
+
body: Array<ProductItem>;
|
|
2534
|
+
}>, rawResponse?: T): Promise<T extends true ? Response : Basket>;
|
|
2385
2535
|
/**
|
|
2386
2536
|
* Removes a product item from the basket.
|
|
2387
2537
|
*
|
|
@@ -2455,32 +2605,36 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
|
|
|
2455
2605
|
};
|
|
2456
2606
|
}>, rawResponse?: T): Promise<T extends true ? Response : Basket>;
|
|
2457
2607
|
/**
|
|
2458
|
-
* Updates an item in a basket. The
|
|
2459
|
-
|
|
2608
|
+
* Updates an item in a basket. The item to be updated can be a bundled product item, although the
|
|
2609
|
+
kind of update supported for bundled product items is limited to `productId` (to support
|
|
2610
|
+
variation products), `gift`, `giftMessage` and custom properties.
|
|
2611
|
+
The following values in the request body are considered by the server:
|
|
2460
2612
|
|
|
2461
|
-
- productId
|
|
2613
|
+
- `productId`: a valid product ID. The purpose of this
|
|
2462
2614
|
value is to exchange a variation of a variation product.
|
|
2463
|
-
- shipmentId
|
|
2615
|
+
- `shipmentId`: a valid shipment ID. The purpose of
|
|
2464
2616
|
this value is to move a product item to another shipment.
|
|
2465
|
-
- quantity
|
|
2617
|
+
- `quantity`: a number between 0 and 999. The purpose of
|
|
2466
2618
|
this value is to change quantity of the product item. If quantity is 0,
|
|
2467
2619
|
the product item is removed.
|
|
2468
|
-
- optionItems
|
|
2620
|
+
- `optionItems`/`optionValueId`: a valid option value
|
|
2469
2621
|
ID. The purpose of this value is to exchange an option value for an
|
|
2470
2622
|
option item of an option product.
|
|
2471
2623
|
This is only possible if the product item is an option product. To change
|
|
2472
2624
|
option values a collection of option items to be changed need to be
|
|
2473
2625
|
provided in property optionItems. Those
|
|
2474
2626
|
optionItems need to contain optionId
|
|
2475
|
-
and optionValueId
|
|
2476
|
-
for the option product that this product item represents. Otherwise
|
|
2477
|
-
InvalidProductOptionItemException or
|
|
2478
|
-
InvalidProductOptionValueItemException
|
|
2479
|
-
custom properties c_\<CUSTOM_NAME
|
|
2627
|
+
and `optionValueId`. The provided values must be valid
|
|
2628
|
+
for the option product that this product item represents. Otherwise,
|
|
2629
|
+
`InvalidProductOptionItemException` or
|
|
2630
|
+
`InvalidProductOptionValueItemException` is thrown.
|
|
2631
|
+
- custom properties `c_\<CUSTOM_NAME\>`: a
|
|
2480
2632
|
value corresponding to the type defined for custom attribute
|
|
2481
|
-
|
|
2633
|
+
`\<CUSTOM_NAME\>` of ProductLineItem. The purpose of this value is to
|
|
2482
2634
|
add or change the value of a custom attribute defined for
|
|
2483
2635
|
ProductLineItem.
|
|
2636
|
+
- `gift`: a boolean value that specifies whether the item is a gift
|
|
2637
|
+
- `giftMessage`: a message for the gift
|
|
2484
2638
|
*
|
|
2485
2639
|
* If you would like to get a raw Response object use the other updateItemInBasket function.
|
|
2486
2640
|
*
|
|
@@ -2489,9 +2643,7 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
|
|
|
2489
2643
|
* @param organizationId - An identifier for the organization the request is being made by.
|
|
2490
2644
|
* @param basketId - The ID of the basket to be modified.
|
|
2491
2645
|
* @param itemId - The ID of the item to be updated.
|
|
2492
|
-
* @param removeExternalTax -
|
|
2493
|
-
- true: (default) The tax values for the product item are set to null and must be recalculated.
|
|
2494
|
-
- false: The tax value for the product item will be updated based on the external tax rate (if no tax value was externally computed). Use this setting to prevent an unnecessary external tax call.
|
|
2646
|
+
* @param removeExternalTax - If `true` (default value), the external tax rates are removed from the basket and set to null. To add external tax rates to a basket, use the `addTaxesForBasket` or `addTaxesForBasketItem` endpoint. The removal of external tax rates depends on the update performed on the basket, for example: an update to the product line item quantity triggers a removal. Set this parameter to `false` to disable the removal of external tax rates/values.
|
|
2495
2647
|
* @param siteId -
|
|
2496
2648
|
* @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
|
|
2497
2649
|
Below are some valid examples:
|
|
@@ -2523,41 +2675,43 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
|
|
|
2523
2675
|
body: ProductItem;
|
|
2524
2676
|
}>): Promise<Basket>;
|
|
2525
2677
|
/**
|
|
2526
|
-
* Updates an item in a basket. The
|
|
2527
|
-
|
|
2678
|
+
* Updates an item in a basket. The item to be updated can be a bundled product item, although the
|
|
2679
|
+
kind of update supported for bundled product items is limited to `productId` (to support
|
|
2680
|
+
variation products), `gift`, `giftMessage` and custom properties.
|
|
2681
|
+
The following values in the request body are considered by the server:
|
|
2528
2682
|
|
|
2529
|
-
- productId
|
|
2683
|
+
- `productId`: a valid product ID. The purpose of this
|
|
2530
2684
|
value is to exchange a variation of a variation product.
|
|
2531
|
-
- shipmentId
|
|
2685
|
+
- `shipmentId`: a valid shipment ID. The purpose of
|
|
2532
2686
|
this value is to move a product item to another shipment.
|
|
2533
|
-
- quantity
|
|
2687
|
+
- `quantity`: a number between 0 and 999. The purpose of
|
|
2534
2688
|
this value is to change quantity of the product item. If quantity is 0,
|
|
2535
2689
|
the product item is removed.
|
|
2536
|
-
- optionItems
|
|
2690
|
+
- `optionItems`/`optionValueId`: a valid option value
|
|
2537
2691
|
ID. The purpose of this value is to exchange an option value for an
|
|
2538
2692
|
option item of an option product.
|
|
2539
2693
|
This is only possible if the product item is an option product. To change
|
|
2540
2694
|
option values a collection of option items to be changed need to be
|
|
2541
2695
|
provided in property optionItems. Those
|
|
2542
2696
|
optionItems need to contain optionId
|
|
2543
|
-
and optionValueId
|
|
2544
|
-
for the option product that this product item represents. Otherwise
|
|
2545
|
-
InvalidProductOptionItemException or
|
|
2546
|
-
InvalidProductOptionValueItemException
|
|
2547
|
-
custom properties c_\<CUSTOM_NAME
|
|
2697
|
+
and `optionValueId`. The provided values must be valid
|
|
2698
|
+
for the option product that this product item represents. Otherwise,
|
|
2699
|
+
`InvalidProductOptionItemException` or
|
|
2700
|
+
`InvalidProductOptionValueItemException` is thrown.
|
|
2701
|
+
- custom properties `c_\<CUSTOM_NAME\>`: a
|
|
2548
2702
|
value corresponding to the type defined for custom attribute
|
|
2549
|
-
|
|
2703
|
+
`\<CUSTOM_NAME\>` of ProductLineItem. The purpose of this value is to
|
|
2550
2704
|
add or change the value of a custom attribute defined for
|
|
2551
2705
|
ProductLineItem.
|
|
2706
|
+
- `gift`: a boolean value that specifies whether the item is a gift
|
|
2707
|
+
- `giftMessage`: a message for the gift
|
|
2552
2708
|
*
|
|
2553
2709
|
* @param options - An object containing the options for this method.
|
|
2554
2710
|
* @param parameters - An object containing the parameters for this method.
|
|
2555
2711
|
* @param organizationId - An identifier for the organization the request is being made by.
|
|
2556
2712
|
* @param basketId - The ID of the basket to be modified.
|
|
2557
2713
|
* @param itemId - The ID of the item to be updated.
|
|
2558
|
-
* @param removeExternalTax -
|
|
2559
|
-
- true: (default) The tax values for the product item are set to null and must be recalculated.
|
|
2560
|
-
- false: The tax value for the product item will be updated based on the external tax rate (if no tax value was externally computed). Use this setting to prevent an unnecessary external tax call.
|
|
2714
|
+
* @param removeExternalTax - If `true` (default value), the external tax rates are removed from the basket and set to null. To add external tax rates to a basket, use the `addTaxesForBasket` or `addTaxesForBasketItem` endpoint. The removal of external tax rates depends on the update performed on the basket, for example: an update to the product line item quantity triggers a removal. Set this parameter to `false` to disable the removal of external tax rates/values.
|
|
2561
2715
|
* @param siteId -
|
|
2562
2716
|
* @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
|
|
2563
2717
|
Below are some valid examples:
|
|
@@ -2804,9 +2958,7 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
|
|
|
2804
2958
|
* @param organizationId - An identifier for the organization the request is being made by.
|
|
2805
2959
|
* @param basketId - The ID of the basket to be modified.
|
|
2806
2960
|
* @param paymentInstrumentId -
|
|
2807
|
-
* @param removeExternalTax -
|
|
2808
|
-
- true: (default) The basket's tax values are set to null and must be recalculated.
|
|
2809
|
-
- false: The basket's tax values don't change. Use this setting to prevent an unnecessary external tax call when the payment instrument change doesn't affect the tax calculation.
|
|
2961
|
+
* @param removeExternalTax - If `true` (default value), the external tax rates are removed from the basket and set to null. To add external tax rates to a basket, use the `addTaxesForBasket` or `addTaxesForBasketItem` endpoint. The removal of external tax rates depends on the update performed on the basket, for example: an update to the payment instrument triggers a removal. Set this parameter to `false` to disable the removal of external tax rates/values.
|
|
2810
2962
|
* @param siteId -
|
|
2811
2963
|
* @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
|
|
2812
2964
|
Below are some valid examples:
|
|
@@ -2845,9 +2997,7 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
|
|
|
2845
2997
|
* @param organizationId - An identifier for the organization the request is being made by.
|
|
2846
2998
|
* @param basketId - The ID of the basket to be modified.
|
|
2847
2999
|
* @param paymentInstrumentId -
|
|
2848
|
-
* @param removeExternalTax -
|
|
2849
|
-
- true: (default) The basket's tax values are set to null and must be recalculated.
|
|
2850
|
-
- false: The basket's tax values don't change. Use this setting to prevent an unnecessary external tax call when the payment instrument change doesn't affect the tax calculation.
|
|
3000
|
+
* @param removeExternalTax - If `true` (default value), the external tax rates are removed from the basket and set to null. To add external tax rates to a basket, use the `addTaxesForBasket` or `addTaxesForBasketItem` endpoint. The removal of external tax rates depends on the update performed on the basket, for example: an update to the payment instrument triggers a removal. Set this parameter to `false` to disable the removal of external tax rates/values.
|
|
2851
3001
|
* @param siteId -
|
|
2852
3002
|
* @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
|
|
2853
3003
|
Below are some valid examples:
|
|
@@ -3163,7 +3313,7 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
|
|
|
3163
3313
|
body: PriceAdjustment;
|
|
3164
3314
|
}>, rawResponse?: T): Promise<T extends true ? Response : Basket>;
|
|
3165
3315
|
/**
|
|
3166
|
-
* Gets applicable price books for an existing basket.
|
|
3316
|
+
* ( DEPRECATED ) Gets applicable price books for an existing basket. This endpoint is deprecated. Use [Shopper Context](https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-context?meta=Summary), hooks or `dw.catalog.PriceBookMgr#getApplicablePriceBooks()` instead.
|
|
3167
3317
|
*
|
|
3168
3318
|
* If you would like to get a raw Response object use the other getPriceBooksForBasket function.
|
|
3169
3319
|
*
|
|
@@ -3191,7 +3341,7 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
|
|
|
3191
3341
|
};
|
|
3192
3342
|
}>): Promise<PriceBookIds>;
|
|
3193
3343
|
/**
|
|
3194
|
-
* Gets applicable price books for an existing basket.
|
|
3344
|
+
* ( DEPRECATED ) Gets applicable price books for an existing basket. This endpoint is deprecated. Use [Shopper Context](https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-context?meta=Summary), hooks or `dw.catalog.PriceBookMgr#getApplicablePriceBooks()` instead.
|
|
3195
3345
|
*
|
|
3196
3346
|
* @param options - An object containing the options for this method.
|
|
3197
3347
|
* @param parameters - An object containing the parameters for this method.
|
|
@@ -3217,7 +3367,7 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
|
|
|
3217
3367
|
};
|
|
3218
3368
|
}>, rawResponse?: T): Promise<T extends true ? Response : PriceBookIds>;
|
|
3219
3369
|
/**
|
|
3220
|
-
* This method allows you to put an array of priceBookIds to an existing basket, which will be used for basket calculation.
|
|
3370
|
+
* ( DEPRECATED ) This method allows you to put an array of priceBookIds to an existing basket, which will be used for basket calculation. This endpoint is deprecated. Use [Shopper Context](https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-context?meta=Summary), hooks or `dw.catalog.PriceBookMgr#setApplicablePriceBooks()` instead.
|
|
3221
3371
|
*
|
|
3222
3372
|
* If you would like to get a raw Response object use the other addPriceBooksToBasket function.
|
|
3223
3373
|
*
|
|
@@ -3247,7 +3397,7 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
|
|
|
3247
3397
|
body: PriceBookIds;
|
|
3248
3398
|
}>): Promise<void>;
|
|
3249
3399
|
/**
|
|
3250
|
-
* This method allows you to put an array of priceBookIds to an existing basket, which will be used for basket calculation.
|
|
3400
|
+
* ( DEPRECATED ) This method allows you to put an array of priceBookIds to an existing basket, which will be used for basket calculation. This endpoint is deprecated. Use [Shopper Context](https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-context?meta=Summary), hooks or `dw.catalog.PriceBookMgr#setApplicablePriceBooks()` instead.
|
|
3251
3401
|
*
|
|
3252
3402
|
* @param options - An object containing the options for this method.
|
|
3253
3403
|
* @param parameters - An object containing the parameters for this method.
|
|
@@ -3551,9 +3701,7 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
|
|
|
3551
3701
|
* @param basketId - The ID of the basket to be modified.
|
|
3552
3702
|
* @param shipmentId - The ID of the shipment to be modified.
|
|
3553
3703
|
* @param useAsBilling -
|
|
3554
|
-
* @param removeExternalTax -
|
|
3555
|
-
- true: (default) The basket's tax values are set to null and must be recalculated.
|
|
3556
|
-
- false: The basket's tax values don't change. Use this setting to prevent an unnecessary external tax call when the shipping/billing address change doesn't affect the tax calculation.
|
|
3704
|
+
* @param removeExternalTax - If `true` (default value), the external tax rates are removed from the basket and set to null. To add external tax rates to a basket, use the `addTaxesForBasket` or `addTaxesForBasketItem` endpoint. The removal of external tax rates depends on the update performed on the basket, for example: an update to the shipping/billing address triggers a removal. Set this parameter to `false` to disable the removal of external tax rates/values.
|
|
3557
3705
|
* @param siteId -
|
|
3558
3706
|
* @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
|
|
3559
3707
|
Below are some valid examples:
|
|
@@ -3594,9 +3742,7 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
|
|
|
3594
3742
|
* @param basketId - The ID of the basket to be modified.
|
|
3595
3743
|
* @param shipmentId - The ID of the shipment to be modified.
|
|
3596
3744
|
* @param useAsBilling -
|
|
3597
|
-
* @param removeExternalTax -
|
|
3598
|
-
- true: (default) The basket's tax values are set to null and must be recalculated.
|
|
3599
|
-
- false: The basket's tax values don't change. Use this setting to prevent an unnecessary external tax call when the shipping/billing address change doesn't affect the tax calculation.
|
|
3745
|
+
* @param removeExternalTax - If `true` (default value), the external tax rates are removed from the basket and set to null. To add external tax rates to a basket, use the `addTaxesForBasket` or `addTaxesForBasketItem` endpoint. The removal of external tax rates depends on the update performed on the basket, for example: an update to the shipping/billing address triggers a removal. Set this parameter to `false` to disable the removal of external tax rates/values.
|
|
3600
3746
|
* @param siteId -
|
|
3601
3747
|
* @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
|
|
3602
3748
|
Below are some valid examples:
|
|
@@ -4332,12 +4478,6 @@ declare namespace ShopperBasketsTypes {
|
|
|
4332
4478
|
} & {
|
|
4333
4479
|
[key: string]: any;
|
|
4334
4480
|
};
|
|
4335
|
-
type BasketsResult = {
|
|
4336
|
-
baskets: Array<Basket>;
|
|
4337
|
-
total: number;
|
|
4338
|
-
} & {
|
|
4339
|
-
[key: string]: any;
|
|
4340
|
-
};
|
|
4341
4481
|
type PriceAdjustmentRequest = {
|
|
4342
4482
|
discount?: DiscountRequest;
|
|
4343
4483
|
itemId?: string;
|
|
@@ -4681,6 +4821,8 @@ declare namespace ShopperBasketsTypes {
|
|
|
4681
4821
|
externalOrderStatus?: string;
|
|
4682
4822
|
giftCertificateItems?: Array<GiftCertificateItem>;
|
|
4683
4823
|
globalPartyId?: string;
|
|
4824
|
+
groupedTaxItems?: Array<GroupedTaxItem>;
|
|
4825
|
+
guest?: boolean;
|
|
4684
4826
|
lastModified?: any;
|
|
4685
4827
|
merchandizeTotalTax?: number;
|
|
4686
4828
|
notes?: SimpleLink;
|
|
@@ -4702,6 +4844,7 @@ declare namespace ShopperBasketsTypes {
|
|
|
4702
4844
|
siteId?: string;
|
|
4703
4845
|
sourceCode?: string;
|
|
4704
4846
|
status?: string;
|
|
4847
|
+
taxRoundedAtGroup?: boolean;
|
|
4705
4848
|
taxTotal?: number;
|
|
4706
4849
|
taxation?: string;
|
|
4707
4850
|
} & {
|
|
@@ -4796,8 +4939,8 @@ declare namespace ShopperBasketsTypes {
|
|
|
4796
4939
|
overrideExisting?: boolean;
|
|
4797
4940
|
createDestinationBasket?: boolean;
|
|
4798
4941
|
productItemMergeMode?: string;
|
|
4799
|
-
useAsShipping?: boolean;
|
|
4800
4942
|
removeExternalTax?: boolean;
|
|
4943
|
+
useAsShipping?: boolean;
|
|
4801
4944
|
useAsBilling?: boolean;
|
|
4802
4945
|
exchange?: boolean;
|
|
4803
4946
|
};
|
|
@@ -4828,7 +4971,7 @@ declare namespace ShopperBasketsTypes {
|
|
|
4828
4971
|
* ```
|
|
4829
4972
|
*
|
|
4830
4973
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
4831
|
-
* API Version: 2.0.
|
|
4974
|
+
* API Version: 2.0.9<br />
|
|
4832
4975
|
* Last Updated: <br />
|
|
4833
4976
|
* </span>
|
|
4834
4977
|
*
|
|
@@ -4898,6 +5041,7 @@ declare namespace ShopperBasketsTypes {
|
|
|
4898
5041
|
readonly updateBasket: readonly [
|
|
4899
5042
|
"organizationId",
|
|
4900
5043
|
"basketId",
|
|
5044
|
+
"removeExternalTax",
|
|
4901
5045
|
"siteId",
|
|
4902
5046
|
"locale"
|
|
4903
5047
|
];
|
|
@@ -5013,6 +5157,18 @@ declare namespace ShopperBasketsTypes {
|
|
|
5013
5157
|
"basketId",
|
|
5014
5158
|
"siteId"
|
|
5015
5159
|
];
|
|
5160
|
+
readonly updateItemsInBasket: readonly [
|
|
5161
|
+
"organizationId",
|
|
5162
|
+
"basketId",
|
|
5163
|
+
"removeExternalTax",
|
|
5164
|
+
"siteId",
|
|
5165
|
+
"locale"
|
|
5166
|
+
];
|
|
5167
|
+
readonly updateItemsInBasketRequired: readonly [
|
|
5168
|
+
"organizationId",
|
|
5169
|
+
"basketId",
|
|
5170
|
+
"siteId"
|
|
5171
|
+
];
|
|
5016
5172
|
readonly removeItemFromBasket: readonly [
|
|
5017
5173
|
"organizationId",
|
|
5018
5174
|
"basketId",
|
|
@@ -5443,7 +5599,7 @@ declare namespace ShopperBasketsTypes {
|
|
|
5443
5599
|
};
|
|
5444
5600
|
}>, rawResponse?: T): Promise<T extends true ? Response : Basket>;
|
|
5445
5601
|
/**
|
|
5446
|
-
* Merge data from the previous shopper's basket into the current shopper's active basket and delete the previous shopper's basket. This endpoint doesn't merge Personally Identifiable Information (PII). You must obtain the shopper authorization token via SLAS and you must provide the ‘guest usid‘ in both the ‘/oauth2/login‘ and ‘/oauth2/token‘ calls while fetching the registered user JWT token. After the merge, all basket amounts are recalculated and totaled, including lookups for prices, taxes, shipping, and promotions.
|
|
5602
|
+
* Merge data from the previous shopper's basket into the current shopper's active basket and delete the previous shopper's basket. This endpoint doesn't merge Personally Identifiable Information (PII). You must obtain the shopper authorization token via SLAS and you must provide the ‘guest usid‘ in both the ‘/oauth2/login‘ and ‘/oauth2/token‘ calls while fetching the registered user JWT token. After the merge, all basket amounts are recalculated and totaled, including lookups for prices, taxes, shipping, and promotions, unless hooks are enabled.
|
|
5447
5603
|
|
|
5448
5604
|
The following information is merged:
|
|
5449
5605
|
- custom attributes on the basket and on all copied records
|
|
@@ -5524,7 +5680,7 @@ declare namespace ShopperBasketsTypes {
|
|
|
5524
5680
|
};
|
|
5525
5681
|
}>): Promise<Basket>;
|
|
5526
5682
|
/**
|
|
5527
|
-
* Merge data from the previous shopper's basket into the current shopper's active basket and delete the previous shopper's basket. This endpoint doesn't merge Personally Identifiable Information (PII). You must obtain the shopper authorization token via SLAS and you must provide the ‘guest usid‘ in both the ‘/oauth2/login‘ and ‘/oauth2/token‘ calls while fetching the registered user JWT token. After the merge, all basket amounts are recalculated and totaled, including lookups for prices, taxes, shipping, and promotions.
|
|
5683
|
+
* Merge data from the previous shopper's basket into the current shopper's active basket and delete the previous shopper's basket. This endpoint doesn't merge Personally Identifiable Information (PII). You must obtain the shopper authorization token via SLAS and you must provide the ‘guest usid‘ in both the ‘/oauth2/login‘ and ‘/oauth2/token‘ calls while fetching the registered user JWT token. After the merge, all basket amounts are recalculated and totaled, including lookups for prices, taxes, shipping, and promotions, unless hooks are enabled.
|
|
5528
5684
|
|
|
5529
5685
|
The following information is merged:
|
|
5530
5686
|
- custom attributes on the basket and on all copied records
|
|
@@ -5734,6 +5890,7 @@ declare namespace ShopperBasketsTypes {
|
|
|
5734
5890
|
* @param parameters - An object containing the parameters for this method.
|
|
5735
5891
|
* @param organizationId - An identifier for the organization the request is being made by.
|
|
5736
5892
|
* @param basketId - The ID of the basket to be modified.
|
|
5893
|
+
* @param removeExternalTax - If `true` (default value), the external tax rates are removed from the basket and set to null. To add external tax rates to a basket, use the `addTaxesForBasket` or `addTaxesForBasketItem` endpoint. The removal of external tax rates depends on the update performed on the basket, for example: an update to the `currency` triggers a removal. Set this parameter to `false` to disable the removal of external tax rates/values.
|
|
5737
5894
|
* @param siteId -
|
|
5738
5895
|
* @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
|
|
5739
5896
|
Below are some valid examples:
|
|
@@ -5752,6 +5909,7 @@ declare namespace ShopperBasketsTypes {
|
|
|
5752
5909
|
parameters?: CompositeParameters<{
|
|
5753
5910
|
organizationId: string;
|
|
5754
5911
|
basketId: string;
|
|
5912
|
+
removeExternalTax?: boolean;
|
|
5755
5913
|
siteId: string;
|
|
5756
5914
|
locale?: string;
|
|
5757
5915
|
} & {
|
|
@@ -5770,6 +5928,7 @@ declare namespace ShopperBasketsTypes {
|
|
|
5770
5928
|
* @param parameters - An object containing the parameters for this method.
|
|
5771
5929
|
* @param organizationId - An identifier for the organization the request is being made by.
|
|
5772
5930
|
* @param basketId - The ID of the basket to be modified.
|
|
5931
|
+
* @param removeExternalTax - If `true` (default value), the external tax rates are removed from the basket and set to null. To add external tax rates to a basket, use the `addTaxesForBasket` or `addTaxesForBasketItem` endpoint. The removal of external tax rates depends on the update performed on the basket, for example: an update to the `currency` triggers a removal. Set this parameter to `false` to disable the removal of external tax rates/values.
|
|
5773
5932
|
* @param siteId -
|
|
5774
5933
|
* @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
|
|
5775
5934
|
Below are some valid examples:
|
|
@@ -5788,6 +5947,7 @@ declare namespace ShopperBasketsTypes {
|
|
|
5788
5947
|
parameters?: CompositeParameters<{
|
|
5789
5948
|
organizationId: string;
|
|
5790
5949
|
basketId: string;
|
|
5950
|
+
removeExternalTax?: boolean;
|
|
5791
5951
|
siteId: string;
|
|
5792
5952
|
locale?: string;
|
|
5793
5953
|
} & {
|
|
@@ -5876,9 +6036,7 @@ declare namespace ShopperBasketsTypes {
|
|
|
5876
6036
|
* @param organizationId - An identifier for the organization the request is being made by.
|
|
5877
6037
|
* @param basketId - The ID of the basket to be modified.
|
|
5878
6038
|
* @param useAsShipping -
|
|
5879
|
-
* @param removeExternalTax -
|
|
5880
|
-
- true: (default) The basket's tax values are set to null and must be recalculated.
|
|
5881
|
-
- false: The basket's tax values don't change. Use this setting to prevent an unnecessary external tax call when the billing/shipping address change doesn't affect the tax calculation.
|
|
6039
|
+
* @param removeExternalTax - If `true` (default value), the external tax rates are removed from the basket and set to null. To add external tax rates to a basket, use the `addTaxesForBasket` or `addTaxesForBasketItem` endpoint. The removal of external tax rates depends on the update performed on the basket, for example: an update to the billing/shipping address triggers a removal. Set this parameter to `false` to disable the removal of external tax rates/values.
|
|
5882
6040
|
* @param siteId -
|
|
5883
6041
|
* @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
|
|
5884
6042
|
Below are some valid examples:
|
|
@@ -5917,9 +6075,7 @@ declare namespace ShopperBasketsTypes {
|
|
|
5917
6075
|
* @param organizationId - An identifier for the organization the request is being made by.
|
|
5918
6076
|
* @param basketId - The ID of the basket to be modified.
|
|
5919
6077
|
* @param useAsShipping -
|
|
5920
|
-
* @param removeExternalTax -
|
|
5921
|
-
- true: (default) The basket's tax values are set to null and must be recalculated.
|
|
5922
|
-
- false: The basket's tax values don't change. Use this setting to prevent an unnecessary external tax call when the billing/shipping address change doesn't affect the tax calculation.
|
|
6078
|
+
* @param removeExternalTax - If `true` (default value), the external tax rates are removed from the basket and set to null. To add external tax rates to a basket, use the `addTaxesForBasket` or `addTaxesForBasketItem` endpoint. The removal of external tax rates depends on the update performed on the basket, for example: an update to the billing/shipping address triggers a removal. Set this parameter to `false` to disable the removal of external tax rates/values.
|
|
5923
6079
|
* @param siteId -
|
|
5924
6080
|
* @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
|
|
5925
6081
|
Below are some valid examples:
|
|
@@ -6508,6 +6664,146 @@ declare namespace ShopperBasketsTypes {
|
|
|
6508
6664
|
};
|
|
6509
6665
|
body: Array<ProductItem>;
|
|
6510
6666
|
}>, rawResponse?: T): Promise<T extends true ? Response : Basket>;
|
|
6667
|
+
/**
|
|
6668
|
+
* Updates multiple items in a basket. This behaviour matches that of updating a
|
|
6669
|
+
single item, but the body contains an array of ProductItems to be updated that are identified by `itemId`.
|
|
6670
|
+
The items to update can include bundled product items, although the
|
|
6671
|
+
kind of update supported for bundled product items is limited to `productId`, `gift`, `giftMessage`
|
|
6672
|
+
and custom properties.
|
|
6673
|
+
The following values in the request body are considered by the server:
|
|
6674
|
+
|
|
6675
|
+
- `itemId` (mandatory): identifies an item to be updated.
|
|
6676
|
+
- `productId`: a valid product ID. The purpose of this
|
|
6677
|
+
value is to change the variation of a variation product.
|
|
6678
|
+
- `shipmentId`: a valid shipment ID. The purpose of
|
|
6679
|
+
this value is to move a product item to another shipment.
|
|
6680
|
+
- `quantity`: a number between 0 and 999. The purpose of
|
|
6681
|
+
this value is to change the quantity of the product item. If the quantity is 0,
|
|
6682
|
+
the product item is removed.
|
|
6683
|
+
- `optionItems`/`optionValueId`: a valid option value
|
|
6684
|
+
ID. The purpose of this value is to exchange an option value for an
|
|
6685
|
+
option item of an option product.
|
|
6686
|
+
This is only possible if the product item is an option product. To change
|
|
6687
|
+
option values, a collection of the option items to be changed must be
|
|
6688
|
+
provided in the property `optionItems`. Those
|
|
6689
|
+
`optionItems` must contain `optionId`
|
|
6690
|
+
and `optionValueId`. The provided values must be valid
|
|
6691
|
+
for the option product that this product item represents. Otherwise,
|
|
6692
|
+
`InvalidProductOptionItemException` or
|
|
6693
|
+
`InvalidProductOptionValueItemException` is thrown.
|
|
6694
|
+
- custom properties `c_\<CUSTOM_NAME\>`: a
|
|
6695
|
+
value corresponding to the type defined for custom attribute
|
|
6696
|
+
`\<CUSTOM_NAME\>` of the ProductLineItem. The purpose of this value is to
|
|
6697
|
+
add or change the value of a custom attribute defined for the
|
|
6698
|
+
ProductLineItem.
|
|
6699
|
+
- `gift`: a boolean value that specifies whether the item is a gift.
|
|
6700
|
+
- `giftMessage`: a message to include with the gift.
|
|
6701
|
+
*
|
|
6702
|
+
* If you would like to get a raw Response object use the other updateItemsInBasket function.
|
|
6703
|
+
*
|
|
6704
|
+
* @param options - An object containing the options for this method.
|
|
6705
|
+
* @param parameters - An object containing the parameters for this method.
|
|
6706
|
+
* @param organizationId - An identifier for the organization the request is being made by.
|
|
6707
|
+
* @param basketId - The ID of the basket to be modified.
|
|
6708
|
+
* @param removeExternalTax - If `true` (default value), the external tax rates are removed from the basket and set to null. To add external tax rates to a basket, use the `addTaxesForBasket` or `addTaxesForBasketItem` endpoint. The removal of external tax rates depends on the update performed on the basket, for example: an update to the product line item quantity triggers a removal. Set this parameter to `false` to disable the removal of external tax rates/values.
|
|
6709
|
+
* @param siteId -
|
|
6710
|
+
* @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
|
|
6711
|
+
Below are some valid examples:
|
|
6712
|
+
- en-US
|
|
6713
|
+
- de-AT
|
|
6714
|
+
- de
|
|
6715
|
+
- default
|
|
6716
|
+
* @param headers - An object literal of key value pairs of the headers to be
|
|
6717
|
+
* sent with this request.
|
|
6718
|
+
* @param body - The data to send as the request body.
|
|
6719
|
+
*
|
|
6720
|
+
* @returns A promise of type Basket.
|
|
6721
|
+
*
|
|
6722
|
+
*/
|
|
6723
|
+
updateItemsInBasket(options: RequireParametersUnlessAllAreOptional<{
|
|
6724
|
+
parameters?: CompositeParameters<{
|
|
6725
|
+
organizationId: string;
|
|
6726
|
+
basketId: string;
|
|
6727
|
+
removeExternalTax?: boolean;
|
|
6728
|
+
siteId: string;
|
|
6729
|
+
locale?: string;
|
|
6730
|
+
} & {
|
|
6731
|
+
[key in `c_${string}`]: any;
|
|
6732
|
+
}, ConfigParameters>;
|
|
6733
|
+
headers?: {
|
|
6734
|
+
[key: string]: string;
|
|
6735
|
+
};
|
|
6736
|
+
body: Array<ProductItem>;
|
|
6737
|
+
}>): Promise<Basket>;
|
|
6738
|
+
/**
|
|
6739
|
+
* Updates multiple items in a basket. This behaviour matches that of updating a
|
|
6740
|
+
single item, but the body contains an array of ProductItems to be updated that are identified by `itemId`.
|
|
6741
|
+
The items to update can include bundled product items, although the
|
|
6742
|
+
kind of update supported for bundled product items is limited to `productId`, `gift`, `giftMessage`
|
|
6743
|
+
and custom properties.
|
|
6744
|
+
The following values in the request body are considered by the server:
|
|
6745
|
+
|
|
6746
|
+
- `itemId` (mandatory): identifies an item to be updated.
|
|
6747
|
+
- `productId`: a valid product ID. The purpose of this
|
|
6748
|
+
value is to change the variation of a variation product.
|
|
6749
|
+
- `shipmentId`: a valid shipment ID. The purpose of
|
|
6750
|
+
this value is to move a product item to another shipment.
|
|
6751
|
+
- `quantity`: a number between 0 and 999. The purpose of
|
|
6752
|
+
this value is to change the quantity of the product item. If the quantity is 0,
|
|
6753
|
+
the product item is removed.
|
|
6754
|
+
- `optionItems`/`optionValueId`: a valid option value
|
|
6755
|
+
ID. The purpose of this value is to exchange an option value for an
|
|
6756
|
+
option item of an option product.
|
|
6757
|
+
This is only possible if the product item is an option product. To change
|
|
6758
|
+
option values, a collection of the option items to be changed must be
|
|
6759
|
+
provided in the property `optionItems`. Those
|
|
6760
|
+
`optionItems` must contain `optionId`
|
|
6761
|
+
and `optionValueId`. The provided values must be valid
|
|
6762
|
+
for the option product that this product item represents. Otherwise,
|
|
6763
|
+
`InvalidProductOptionItemException` or
|
|
6764
|
+
`InvalidProductOptionValueItemException` is thrown.
|
|
6765
|
+
- custom properties `c_\<CUSTOM_NAME\>`: a
|
|
6766
|
+
value corresponding to the type defined for custom attribute
|
|
6767
|
+
`\<CUSTOM_NAME\>` of the ProductLineItem. The purpose of this value is to
|
|
6768
|
+
add or change the value of a custom attribute defined for the
|
|
6769
|
+
ProductLineItem.
|
|
6770
|
+
- `gift`: a boolean value that specifies whether the item is a gift.
|
|
6771
|
+
- `giftMessage`: a message to include with the gift.
|
|
6772
|
+
*
|
|
6773
|
+
* @param options - An object containing the options for this method.
|
|
6774
|
+
* @param parameters - An object containing the parameters for this method.
|
|
6775
|
+
* @param organizationId - An identifier for the organization the request is being made by.
|
|
6776
|
+
* @param basketId - The ID of the basket to be modified.
|
|
6777
|
+
* @param removeExternalTax - If `true` (default value), the external tax rates are removed from the basket and set to null. To add external tax rates to a basket, use the `addTaxesForBasket` or `addTaxesForBasketItem` endpoint. The removal of external tax rates depends on the update performed on the basket, for example: an update to the product line item quantity triggers a removal. Set this parameter to `false` to disable the removal of external tax rates/values.
|
|
6778
|
+
* @param siteId -
|
|
6779
|
+
* @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
|
|
6780
|
+
Below are some valid examples:
|
|
6781
|
+
- en-US
|
|
6782
|
+
- de-AT
|
|
6783
|
+
- de
|
|
6784
|
+
- default
|
|
6785
|
+
* @param headers - An object literal of key value pairs of the headers to be
|
|
6786
|
+
* sent with this request.
|
|
6787
|
+
* @param body - The data to send as the request body.
|
|
6788
|
+
* @param rawResponse - Set to true to return entire Response object instead of DTO.
|
|
6789
|
+
* @returns A promise of type Response if rawResponse is true, a promise of type Basket otherwise.
|
|
6790
|
+
*
|
|
6791
|
+
*/
|
|
6792
|
+
updateItemsInBasket<T extends boolean>(options: RequireParametersUnlessAllAreOptional<{
|
|
6793
|
+
parameters?: CompositeParameters<{
|
|
6794
|
+
organizationId: string;
|
|
6795
|
+
basketId: string;
|
|
6796
|
+
removeExternalTax?: boolean;
|
|
6797
|
+
siteId: string;
|
|
6798
|
+
locale?: string;
|
|
6799
|
+
} & {
|
|
6800
|
+
[key in `c_${string}`]: any;
|
|
6801
|
+
}, ConfigParameters>;
|
|
6802
|
+
headers?: {
|
|
6803
|
+
[key: string]: string;
|
|
6804
|
+
};
|
|
6805
|
+
body: Array<ProductItem>;
|
|
6806
|
+
}>, rawResponse?: T): Promise<T extends true ? Response : Basket>;
|
|
6511
6807
|
/**
|
|
6512
6808
|
* Removes a product item from the basket.
|
|
6513
6809
|
*
|
|
@@ -6581,32 +6877,36 @@ declare namespace ShopperBasketsTypes {
|
|
|
6581
6877
|
};
|
|
6582
6878
|
}>, rawResponse?: T): Promise<T extends true ? Response : Basket>;
|
|
6583
6879
|
/**
|
|
6584
|
-
* Updates an item in a basket. The
|
|
6585
|
-
|
|
6880
|
+
* Updates an item in a basket. The item to be updated can be a bundled product item, although the
|
|
6881
|
+
kind of update supported for bundled product items is limited to `productId` (to support
|
|
6882
|
+
variation products), `gift`, `giftMessage` and custom properties.
|
|
6883
|
+
The following values in the request body are considered by the server:
|
|
6586
6884
|
|
|
6587
|
-
- productId
|
|
6885
|
+
- `productId`: a valid product ID. The purpose of this
|
|
6588
6886
|
value is to exchange a variation of a variation product.
|
|
6589
|
-
- shipmentId
|
|
6887
|
+
- `shipmentId`: a valid shipment ID. The purpose of
|
|
6590
6888
|
this value is to move a product item to another shipment.
|
|
6591
|
-
- quantity
|
|
6889
|
+
- `quantity`: a number between 0 and 999. The purpose of
|
|
6592
6890
|
this value is to change quantity of the product item. If quantity is 0,
|
|
6593
6891
|
the product item is removed.
|
|
6594
|
-
- optionItems
|
|
6892
|
+
- `optionItems`/`optionValueId`: a valid option value
|
|
6595
6893
|
ID. The purpose of this value is to exchange an option value for an
|
|
6596
6894
|
option item of an option product.
|
|
6597
6895
|
This is only possible if the product item is an option product. To change
|
|
6598
6896
|
option values a collection of option items to be changed need to be
|
|
6599
6897
|
provided in property optionItems. Those
|
|
6600
6898
|
optionItems need to contain optionId
|
|
6601
|
-
and optionValueId
|
|
6602
|
-
for the option product that this product item represents. Otherwise
|
|
6603
|
-
InvalidProductOptionItemException or
|
|
6604
|
-
InvalidProductOptionValueItemException
|
|
6605
|
-
custom properties c_\<CUSTOM_NAME
|
|
6899
|
+
and `optionValueId`. The provided values must be valid
|
|
6900
|
+
for the option product that this product item represents. Otherwise,
|
|
6901
|
+
`InvalidProductOptionItemException` or
|
|
6902
|
+
`InvalidProductOptionValueItemException` is thrown.
|
|
6903
|
+
- custom properties `c_\<CUSTOM_NAME\>`: a
|
|
6606
6904
|
value corresponding to the type defined for custom attribute
|
|
6607
|
-
|
|
6905
|
+
`\<CUSTOM_NAME\>` of ProductLineItem. The purpose of this value is to
|
|
6608
6906
|
add or change the value of a custom attribute defined for
|
|
6609
6907
|
ProductLineItem.
|
|
6908
|
+
- `gift`: a boolean value that specifies whether the item is a gift
|
|
6909
|
+
- `giftMessage`: a message for the gift
|
|
6610
6910
|
*
|
|
6611
6911
|
* If you would like to get a raw Response object use the other updateItemInBasket function.
|
|
6612
6912
|
*
|
|
@@ -6615,9 +6915,7 @@ declare namespace ShopperBasketsTypes {
|
|
|
6615
6915
|
* @param organizationId - An identifier for the organization the request is being made by.
|
|
6616
6916
|
* @param basketId - The ID of the basket to be modified.
|
|
6617
6917
|
* @param itemId - The ID of the item to be updated.
|
|
6618
|
-
* @param removeExternalTax -
|
|
6619
|
-
- true: (default) The tax values for the product item are set to null and must be recalculated.
|
|
6620
|
-
- false: The tax value for the product item will be updated based on the external tax rate (if no tax value was externally computed). Use this setting to prevent an unnecessary external tax call.
|
|
6918
|
+
* @param removeExternalTax - If `true` (default value), the external tax rates are removed from the basket and set to null. To add external tax rates to a basket, use the `addTaxesForBasket` or `addTaxesForBasketItem` endpoint. The removal of external tax rates depends on the update performed on the basket, for example: an update to the product line item quantity triggers a removal. Set this parameter to `false` to disable the removal of external tax rates/values.
|
|
6621
6919
|
* @param siteId -
|
|
6622
6920
|
* @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
|
|
6623
6921
|
Below are some valid examples:
|
|
@@ -6649,41 +6947,43 @@ declare namespace ShopperBasketsTypes {
|
|
|
6649
6947
|
body: ProductItem;
|
|
6650
6948
|
}>): Promise<Basket>;
|
|
6651
6949
|
/**
|
|
6652
|
-
* Updates an item in a basket. The
|
|
6653
|
-
|
|
6950
|
+
* Updates an item in a basket. The item to be updated can be a bundled product item, although the
|
|
6951
|
+
kind of update supported for bundled product items is limited to `productId` (to support
|
|
6952
|
+
variation products), `gift`, `giftMessage` and custom properties.
|
|
6953
|
+
The following values in the request body are considered by the server:
|
|
6654
6954
|
|
|
6655
|
-
- productId
|
|
6955
|
+
- `productId`: a valid product ID. The purpose of this
|
|
6656
6956
|
value is to exchange a variation of a variation product.
|
|
6657
|
-
- shipmentId
|
|
6957
|
+
- `shipmentId`: a valid shipment ID. The purpose of
|
|
6658
6958
|
this value is to move a product item to another shipment.
|
|
6659
|
-
- quantity
|
|
6959
|
+
- `quantity`: a number between 0 and 999. The purpose of
|
|
6660
6960
|
this value is to change quantity of the product item. If quantity is 0,
|
|
6661
6961
|
the product item is removed.
|
|
6662
|
-
- optionItems
|
|
6962
|
+
- `optionItems`/`optionValueId`: a valid option value
|
|
6663
6963
|
ID. The purpose of this value is to exchange an option value for an
|
|
6664
6964
|
option item of an option product.
|
|
6665
6965
|
This is only possible if the product item is an option product. To change
|
|
6666
6966
|
option values a collection of option items to be changed need to be
|
|
6667
6967
|
provided in property optionItems. Those
|
|
6668
6968
|
optionItems need to contain optionId
|
|
6669
|
-
and optionValueId
|
|
6670
|
-
for the option product that this product item represents. Otherwise
|
|
6671
|
-
InvalidProductOptionItemException or
|
|
6672
|
-
InvalidProductOptionValueItemException
|
|
6673
|
-
custom properties c_\<CUSTOM_NAME
|
|
6969
|
+
and `optionValueId`. The provided values must be valid
|
|
6970
|
+
for the option product that this product item represents. Otherwise,
|
|
6971
|
+
`InvalidProductOptionItemException` or
|
|
6972
|
+
`InvalidProductOptionValueItemException` is thrown.
|
|
6973
|
+
- custom properties `c_\<CUSTOM_NAME\>`: a
|
|
6674
6974
|
value corresponding to the type defined for custom attribute
|
|
6675
|
-
|
|
6975
|
+
`\<CUSTOM_NAME\>` of ProductLineItem. The purpose of this value is to
|
|
6676
6976
|
add or change the value of a custom attribute defined for
|
|
6677
6977
|
ProductLineItem.
|
|
6978
|
+
- `gift`: a boolean value that specifies whether the item is a gift
|
|
6979
|
+
- `giftMessage`: a message for the gift
|
|
6678
6980
|
*
|
|
6679
6981
|
* @param options - An object containing the options for this method.
|
|
6680
6982
|
* @param parameters - An object containing the parameters for this method.
|
|
6681
6983
|
* @param organizationId - An identifier for the organization the request is being made by.
|
|
6682
6984
|
* @param basketId - The ID of the basket to be modified.
|
|
6683
6985
|
* @param itemId - The ID of the item to be updated.
|
|
6684
|
-
* @param removeExternalTax -
|
|
6685
|
-
- true: (default) The tax values for the product item are set to null and must be recalculated.
|
|
6686
|
-
- false: The tax value for the product item will be updated based on the external tax rate (if no tax value was externally computed). Use this setting to prevent an unnecessary external tax call.
|
|
6986
|
+
* @param removeExternalTax - If `true` (default value), the external tax rates are removed from the basket and set to null. To add external tax rates to a basket, use the `addTaxesForBasket` or `addTaxesForBasketItem` endpoint. The removal of external tax rates depends on the update performed on the basket, for example: an update to the product line item quantity triggers a removal. Set this parameter to `false` to disable the removal of external tax rates/values.
|
|
6687
6987
|
* @param siteId -
|
|
6688
6988
|
* @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
|
|
6689
6989
|
Below are some valid examples:
|
|
@@ -6930,9 +7230,7 @@ declare namespace ShopperBasketsTypes {
|
|
|
6930
7230
|
* @param organizationId - An identifier for the organization the request is being made by.
|
|
6931
7231
|
* @param basketId - The ID of the basket to be modified.
|
|
6932
7232
|
* @param paymentInstrumentId -
|
|
6933
|
-
* @param removeExternalTax -
|
|
6934
|
-
- true: (default) The basket's tax values are set to null and must be recalculated.
|
|
6935
|
-
- false: The basket's tax values don't change. Use this setting to prevent an unnecessary external tax call when the payment instrument change doesn't affect the tax calculation.
|
|
7233
|
+
* @param removeExternalTax - If `true` (default value), the external tax rates are removed from the basket and set to null. To add external tax rates to a basket, use the `addTaxesForBasket` or `addTaxesForBasketItem` endpoint. The removal of external tax rates depends on the update performed on the basket, for example: an update to the payment instrument triggers a removal. Set this parameter to `false` to disable the removal of external tax rates/values.
|
|
6936
7234
|
* @param siteId -
|
|
6937
7235
|
* @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
|
|
6938
7236
|
Below are some valid examples:
|
|
@@ -6971,9 +7269,7 @@ declare namespace ShopperBasketsTypes {
|
|
|
6971
7269
|
* @param organizationId - An identifier for the organization the request is being made by.
|
|
6972
7270
|
* @param basketId - The ID of the basket to be modified.
|
|
6973
7271
|
* @param paymentInstrumentId -
|
|
6974
|
-
* @param removeExternalTax -
|
|
6975
|
-
- true: (default) The basket's tax values are set to null and must be recalculated.
|
|
6976
|
-
- false: The basket's tax values don't change. Use this setting to prevent an unnecessary external tax call when the payment instrument change doesn't affect the tax calculation.
|
|
7272
|
+
* @param removeExternalTax - If `true` (default value), the external tax rates are removed from the basket and set to null. To add external tax rates to a basket, use the `addTaxesForBasket` or `addTaxesForBasketItem` endpoint. The removal of external tax rates depends on the update performed on the basket, for example: an update to the payment instrument triggers a removal. Set this parameter to `false` to disable the removal of external tax rates/values.
|
|
6977
7273
|
* @param siteId -
|
|
6978
7274
|
* @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
|
|
6979
7275
|
Below are some valid examples:
|
|
@@ -7289,7 +7585,7 @@ declare namespace ShopperBasketsTypes {
|
|
|
7289
7585
|
body: PriceAdjustment;
|
|
7290
7586
|
}>, rawResponse?: T): Promise<T extends true ? Response : Basket>;
|
|
7291
7587
|
/**
|
|
7292
|
-
* Gets applicable price books for an existing basket.
|
|
7588
|
+
* ( DEPRECATED ) Gets applicable price books for an existing basket. This endpoint is deprecated. Use [Shopper Context](https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-context?meta=Summary), hooks or `dw.catalog.PriceBookMgr#getApplicablePriceBooks()` instead.
|
|
7293
7589
|
*
|
|
7294
7590
|
* If you would like to get a raw Response object use the other getPriceBooksForBasket function.
|
|
7295
7591
|
*
|
|
@@ -7317,7 +7613,7 @@ declare namespace ShopperBasketsTypes {
|
|
|
7317
7613
|
};
|
|
7318
7614
|
}>): Promise<PriceBookIds>;
|
|
7319
7615
|
/**
|
|
7320
|
-
* Gets applicable price books for an existing basket.
|
|
7616
|
+
* ( DEPRECATED ) Gets applicable price books for an existing basket. This endpoint is deprecated. Use [Shopper Context](https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-context?meta=Summary), hooks or `dw.catalog.PriceBookMgr#getApplicablePriceBooks()` instead.
|
|
7321
7617
|
*
|
|
7322
7618
|
* @param options - An object containing the options for this method.
|
|
7323
7619
|
* @param parameters - An object containing the parameters for this method.
|
|
@@ -7343,7 +7639,7 @@ declare namespace ShopperBasketsTypes {
|
|
|
7343
7639
|
};
|
|
7344
7640
|
}>, rawResponse?: T): Promise<T extends true ? Response : PriceBookIds>;
|
|
7345
7641
|
/**
|
|
7346
|
-
* This method allows you to put an array of priceBookIds to an existing basket, which will be used for basket calculation.
|
|
7642
|
+
* ( DEPRECATED ) This method allows you to put an array of priceBookIds to an existing basket, which will be used for basket calculation. This endpoint is deprecated. Use [Shopper Context](https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-context?meta=Summary), hooks or `dw.catalog.PriceBookMgr#setApplicablePriceBooks()` instead.
|
|
7347
7643
|
*
|
|
7348
7644
|
* If you would like to get a raw Response object use the other addPriceBooksToBasket function.
|
|
7349
7645
|
*
|
|
@@ -7373,7 +7669,7 @@ declare namespace ShopperBasketsTypes {
|
|
|
7373
7669
|
body: PriceBookIds;
|
|
7374
7670
|
}>): Promise<void>;
|
|
7375
7671
|
/**
|
|
7376
|
-
* This method allows you to put an array of priceBookIds to an existing basket, which will be used for basket calculation.
|
|
7672
|
+
* ( DEPRECATED ) This method allows you to put an array of priceBookIds to an existing basket, which will be used for basket calculation. This endpoint is deprecated. Use [Shopper Context](https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-context?meta=Summary), hooks or `dw.catalog.PriceBookMgr#setApplicablePriceBooks()` instead.
|
|
7377
7673
|
*
|
|
7378
7674
|
* @param options - An object containing the options for this method.
|
|
7379
7675
|
* @param parameters - An object containing the parameters for this method.
|
|
@@ -7677,9 +7973,7 @@ declare namespace ShopperBasketsTypes {
|
|
|
7677
7973
|
* @param basketId - The ID of the basket to be modified.
|
|
7678
7974
|
* @param shipmentId - The ID of the shipment to be modified.
|
|
7679
7975
|
* @param useAsBilling -
|
|
7680
|
-
* @param removeExternalTax -
|
|
7681
|
-
- true: (default) The basket's tax values are set to null and must be recalculated.
|
|
7682
|
-
- false: The basket's tax values don't change. Use this setting to prevent an unnecessary external tax call when the shipping/billing address change doesn't affect the tax calculation.
|
|
7976
|
+
* @param removeExternalTax - If `true` (default value), the external tax rates are removed from the basket and set to null. To add external tax rates to a basket, use the `addTaxesForBasket` or `addTaxesForBasketItem` endpoint. The removal of external tax rates depends on the update performed on the basket, for example: an update to the shipping/billing address triggers a removal. Set this parameter to `false` to disable the removal of external tax rates/values.
|
|
7683
7977
|
* @param siteId -
|
|
7684
7978
|
* @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
|
|
7685
7979
|
Below are some valid examples:
|
|
@@ -7720,9 +8014,7 @@ declare namespace ShopperBasketsTypes {
|
|
|
7720
8014
|
* @param basketId - The ID of the basket to be modified.
|
|
7721
8015
|
* @param shipmentId - The ID of the shipment to be modified.
|
|
7722
8016
|
* @param useAsBilling -
|
|
7723
|
-
* @param removeExternalTax -
|
|
7724
|
-
- true: (default) The basket's tax values are set to null and must be recalculated.
|
|
7725
|
-
- false: The basket's tax values don't change. Use this setting to prevent an unnecessary external tax call when the shipping/billing address change doesn't affect the tax calculation.
|
|
8017
|
+
* @param removeExternalTax - If `true` (default value), the external tax rates are removed from the basket and set to null. To add external tax rates to a basket, use the `addTaxesForBasket` or `addTaxesForBasketItem` endpoint. The removal of external tax rates depends on the update performed on the basket, for example: an update to the shipping/billing address triggers a removal. Set this parameter to `false` to disable the removal of external tax rates/values.
|
|
7726
8018
|
* @param siteId -
|
|
7727
8019
|
* @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
|
|
7728
8020
|
Below are some valid examples:
|
|
@@ -8099,6 +8391,19 @@ type ShopperContext = {
|
|
|
8099
8391
|
[key: string]: any;
|
|
8100
8392
|
};
|
|
8101
8393
|
clientIp?: string;
|
|
8394
|
+
geoLocation?: {
|
|
8395
|
+
city?: string;
|
|
8396
|
+
country?: string;
|
|
8397
|
+
countryCode?: string;
|
|
8398
|
+
latitude?: number;
|
|
8399
|
+
longitude?: number;
|
|
8400
|
+
metroCode?: string;
|
|
8401
|
+
postalCode?: string;
|
|
8402
|
+
region?: string;
|
|
8403
|
+
regionCode?: string;
|
|
8404
|
+
} & {
|
|
8405
|
+
[key: string]: any;
|
|
8406
|
+
};
|
|
8102
8407
|
} & {
|
|
8103
8408
|
[key: string]: any;
|
|
8104
8409
|
};
|
|
@@ -8217,6 +8522,7 @@ type ShopperContextsPathParameters = {
|
|
|
8217
8522
|
*/
|
|
8218
8523
|
type ShopperContextsQueryParameters = {
|
|
8219
8524
|
siteId?: string;
|
|
8525
|
+
evaluateContextWithClientIp?: boolean;
|
|
8220
8526
|
};
|
|
8221
8527
|
/**
|
|
8222
8528
|
* All parameters that are used by ShopperContexts.
|
|
@@ -8245,7 +8551,7 @@ type ShopperContextsParameters = ShopperContextsPathParameters & BaseUriParamete
|
|
|
8245
8551
|
* ```
|
|
8246
8552
|
*
|
|
8247
8553
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
8248
|
-
* API Version: 0.0.
|
|
8554
|
+
* API Version: 0.0.29<br />
|
|
8249
8555
|
* Last Updated: <br />
|
|
8250
8556
|
* </span>
|
|
8251
8557
|
*
|
|
@@ -8271,7 +8577,8 @@ declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters
|
|
|
8271
8577
|
readonly createShopperContext: readonly [
|
|
8272
8578
|
"organizationId",
|
|
8273
8579
|
"usid",
|
|
8274
|
-
"siteId"
|
|
8580
|
+
"siteId",
|
|
8581
|
+
"evaluateContextWithClientIp"
|
|
8275
8582
|
];
|
|
8276
8583
|
readonly createShopperContextRequired: readonly [
|
|
8277
8584
|
"organizationId",
|
|
@@ -8289,7 +8596,8 @@ declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters
|
|
|
8289
8596
|
readonly updateShopperContext: readonly [
|
|
8290
8597
|
"organizationId",
|
|
8291
8598
|
"usid",
|
|
8292
|
-
"siteId"
|
|
8599
|
+
"siteId",
|
|
8600
|
+
"evaluateContextWithClientIp"
|
|
8293
8601
|
];
|
|
8294
8602
|
readonly updateShopperContextRequired: readonly [
|
|
8295
8603
|
"organizationId",
|
|
@@ -8298,6 +8606,8 @@ declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters
|
|
|
8298
8606
|
};
|
|
8299
8607
|
/**
|
|
8300
8608
|
* Gets the shopper's context based on the shopperJWT.
|
|
8609
|
+
|
|
8610
|
+
With B2C Commerce release 24.5, all endpoints in the Shopper context API will require the `siteId` parameter for new customers. This field is marked as optional for backward compatibility and will be changed to mandatory tentatively by January 2025.
|
|
8301
8611
|
*
|
|
8302
8612
|
* If you would like to get a raw Response object use the other getShopperContext function.
|
|
8303
8613
|
*
|
|
@@ -8305,7 +8615,7 @@ declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters
|
|
|
8305
8615
|
* @param parameters - An object containing the parameters for this method.
|
|
8306
8616
|
* @param organizationId -
|
|
8307
8617
|
* @param usid - The Shopper's unique identifier. It is a required parameter and is part of the response from the Guest or Registered User Shopper Login (SLAS) API call.
|
|
8308
|
-
* @param siteId - The
|
|
8618
|
+
* @param siteId - The identifier of the site to which the request is being sent. With B2C Commerce release 24.5, all new implementations of Shopper Context require the `siteId` query parameter to be passed. Existing customers with Shopper Context implementations should start including `siteId` going forward. Starting January 2025, `siteId` will be required for all customers, and a bad request response code will be returned for requests without a `siteId`.
|
|
8309
8619
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
8310
8620
|
* sent with this request.
|
|
8311
8621
|
*
|
|
@@ -8326,12 +8636,14 @@ declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters
|
|
|
8326
8636
|
}>): Promise<ShopperContext>;
|
|
8327
8637
|
/**
|
|
8328
8638
|
* Gets the shopper's context based on the shopperJWT.
|
|
8639
|
+
|
|
8640
|
+
With B2C Commerce release 24.5, all endpoints in the Shopper context API will require the `siteId` parameter for new customers. This field is marked as optional for backward compatibility and will be changed to mandatory tentatively by January 2025.
|
|
8329
8641
|
*
|
|
8330
8642
|
* @param options - An object containing the options for this method.
|
|
8331
8643
|
* @param parameters - An object containing the parameters for this method.
|
|
8332
8644
|
* @param organizationId -
|
|
8333
8645
|
* @param usid - The Shopper's unique identifier. It is a required parameter and is part of the response from the Guest or Registered User Shopper Login (SLAS) API call.
|
|
8334
|
-
* @param siteId - The
|
|
8646
|
+
* @param siteId - The identifier of the site to which the request is being sent. With B2C Commerce release 24.5, all new implementations of Shopper Context require the `siteId` query parameter to be passed. Existing customers with Shopper Context implementations should start including `siteId` going forward. Starting January 2025, `siteId` will be required for all customers, and a bad request response code will be returned for requests without a `siteId`.
|
|
8335
8647
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
8336
8648
|
* sent with this request.
|
|
8337
8649
|
* @param rawResponse - Set to true to return entire Response object instead of DTO.
|
|
@@ -8352,6 +8664,8 @@ declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters
|
|
|
8352
8664
|
}>, rawResponse?: T): Promise<T extends true ? Response : ShopperContext>;
|
|
8353
8665
|
/**
|
|
8354
8666
|
* Creates the shopper's context based on shopperJWT.
|
|
8667
|
+
|
|
8668
|
+
With B2C Commerce release 24.5, all endpoints in the Shopper context API will require the `siteId` parameter for new customers. This field is marked as optional for backward compatibility and will be changed to mandatory tentatively by January 2025.
|
|
8355
8669
|
*
|
|
8356
8670
|
* If you would like to get a raw Response object use the other createShopperContext function.
|
|
8357
8671
|
*
|
|
@@ -8359,7 +8673,14 @@ declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters
|
|
|
8359
8673
|
* @param parameters - An object containing the parameters for this method.
|
|
8360
8674
|
* @param organizationId -
|
|
8361
8675
|
* @param usid - The Shopper's unique identifier. It is a required parameter and is part of the response from the Guest or Registered User Shopper Login (SLAS) API call.
|
|
8362
|
-
* @param siteId - The
|
|
8676
|
+
* @param siteId - The identifier of the site to which the request is being sent. With B2C Commerce release 24.5, all new implementations of Shopper Context require the `siteId` query parameter to be passed. Existing customers with Shopper Context implementations should start including `siteId` going forward. Starting July 31 2024, `siteId` will be required for all customers, and a bad request response code will be returned for requests without a `siteId`.
|
|
8677
|
+
* @param evaluateContextWithClientIp - Determines whether to evaluate the context using the provided `clientIp`. This property is available with B2C Commerce version 24.7.
|
|
8678
|
+
- If `evaluateContextWithClientIp` is set to `true`:
|
|
8679
|
+
- The `clientIp` is saved and used in subsequent requests.
|
|
8680
|
+
|
|
8681
|
+
- If `evaluateContextWithClientIp` is set to `false`:
|
|
8682
|
+
- The `clientIp` is not saved and will not be used in subsequent requests.
|
|
8683
|
+
|
|
8363
8684
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
8364
8685
|
* sent with this request.
|
|
8365
8686
|
* @param body - The data to send as the request body.
|
|
@@ -8372,6 +8693,7 @@ declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters
|
|
|
8372
8693
|
organizationId: string;
|
|
8373
8694
|
usid: string;
|
|
8374
8695
|
siteId?: string;
|
|
8696
|
+
evaluateContextWithClientIp?: boolean;
|
|
8375
8697
|
} & {
|
|
8376
8698
|
[key in `c_${string}`]: any;
|
|
8377
8699
|
}, ConfigParameters>;
|
|
@@ -8382,12 +8704,21 @@ declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters
|
|
|
8382
8704
|
}>): Promise<void | void>;
|
|
8383
8705
|
/**
|
|
8384
8706
|
* Creates the shopper's context based on shopperJWT.
|
|
8707
|
+
|
|
8708
|
+
With B2C Commerce release 24.5, all endpoints in the Shopper context API will require the `siteId` parameter for new customers. This field is marked as optional for backward compatibility and will be changed to mandatory tentatively by January 2025.
|
|
8385
8709
|
*
|
|
8386
8710
|
* @param options - An object containing the options for this method.
|
|
8387
8711
|
* @param parameters - An object containing the parameters for this method.
|
|
8388
8712
|
* @param organizationId -
|
|
8389
8713
|
* @param usid - The Shopper's unique identifier. It is a required parameter and is part of the response from the Guest or Registered User Shopper Login (SLAS) API call.
|
|
8390
|
-
* @param siteId - The
|
|
8714
|
+
* @param siteId - The identifier of the site to which the request is being sent. With B2C Commerce release 24.5, all new implementations of Shopper Context require the `siteId` query parameter to be passed. Existing customers with Shopper Context implementations should start including `siteId` going forward. Starting July 31 2024, `siteId` will be required for all customers, and a bad request response code will be returned for requests without a `siteId`.
|
|
8715
|
+
* @param evaluateContextWithClientIp - Determines whether to evaluate the context using the provided `clientIp`. This property is available with B2C Commerce version 24.7.
|
|
8716
|
+
- If `evaluateContextWithClientIp` is set to `true`:
|
|
8717
|
+
- The `clientIp` is saved and used in subsequent requests.
|
|
8718
|
+
|
|
8719
|
+
- If `evaluateContextWithClientIp` is set to `false`:
|
|
8720
|
+
- The `clientIp` is not saved and will not be used in subsequent requests.
|
|
8721
|
+
|
|
8391
8722
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
8392
8723
|
* sent with this request.
|
|
8393
8724
|
* @param body - The data to send as the request body.
|
|
@@ -8400,6 +8731,7 @@ declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters
|
|
|
8400
8731
|
organizationId: string;
|
|
8401
8732
|
usid: string;
|
|
8402
8733
|
siteId?: string;
|
|
8734
|
+
evaluateContextWithClientIp?: boolean;
|
|
8403
8735
|
} & {
|
|
8404
8736
|
[key in `c_${string}`]: any;
|
|
8405
8737
|
}, ConfigParameters>;
|
|
@@ -8410,6 +8742,8 @@ declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters
|
|
|
8410
8742
|
}>, rawResponse?: T): Promise<T extends true ? Response : void | void>;
|
|
8411
8743
|
/**
|
|
8412
8744
|
* Gets the shopper's context based on the shopperJWT.
|
|
8745
|
+
|
|
8746
|
+
With B2C Commerce release 24.5, all endpoints in the Shopper context API will require the `siteId` parameter for new customers. This field is marked as optional for backward compatibility and will be changed to mandatory tentatively by January 2025.
|
|
8413
8747
|
*
|
|
8414
8748
|
* If you would like to get a raw Response object use the other deleteShopperContext function.
|
|
8415
8749
|
*
|
|
@@ -8417,7 +8751,7 @@ declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters
|
|
|
8417
8751
|
* @param parameters - An object containing the parameters for this method.
|
|
8418
8752
|
* @param organizationId -
|
|
8419
8753
|
* @param usid - The Shopper's unique identifier. It is a required parameter and is part of the response from the Guest or Registered User Shopper Login (SLAS) API call.
|
|
8420
|
-
* @param siteId - The
|
|
8754
|
+
* @param siteId - The identifier of the site to which the request is being sent. With B2C Commerce release 24.5, all new implementations of Shopper Context require the `siteId` query parameter to be passed. Existing customers with Shopper Context implementations should start including `siteId` going forward. Starting July 31 2024, `siteId` will be required for all customers, and a bad request response code will be returned for requests without a `siteId`.
|
|
8421
8755
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
8422
8756
|
* sent with this request.
|
|
8423
8757
|
*
|
|
@@ -8438,12 +8772,14 @@ declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters
|
|
|
8438
8772
|
}>): Promise<void>;
|
|
8439
8773
|
/**
|
|
8440
8774
|
* Gets the shopper's context based on the shopperJWT.
|
|
8775
|
+
|
|
8776
|
+
With B2C Commerce release 24.5, all endpoints in the Shopper context API will require the `siteId` parameter for new customers. This field is marked as optional for backward compatibility and will be changed to mandatory tentatively by January 2025.
|
|
8441
8777
|
*
|
|
8442
8778
|
* @param options - An object containing the options for this method.
|
|
8443
8779
|
* @param parameters - An object containing the parameters for this method.
|
|
8444
8780
|
* @param organizationId -
|
|
8445
8781
|
* @param usid - The Shopper's unique identifier. It is a required parameter and is part of the response from the Guest or Registered User Shopper Login (SLAS) API call.
|
|
8446
|
-
* @param siteId - The
|
|
8782
|
+
* @param siteId - The identifier of the site to which the request is being sent. With B2C Commerce release 24.5, all new implementations of Shopper Context require the `siteId` query parameter to be passed. Existing customers with Shopper Context implementations should start including `siteId` going forward. Starting July 31 2024, `siteId` will be required for all customers, and a bad request response code will be returned for requests without a `siteId`.
|
|
8447
8783
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
8448
8784
|
* sent with this request.
|
|
8449
8785
|
* @param rawResponse - Set to true to return entire Response object instead of DTO.
|
|
@@ -8464,6 +8800,8 @@ declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters
|
|
|
8464
8800
|
}>, rawResponse?: T): Promise<T extends true ? Response : void>;
|
|
8465
8801
|
/**
|
|
8466
8802
|
* Updates the shopper's context based on the Shopper JWT. If the shopper context exists, it's updated with the patch body. If a `custom qualifier/assignment qualifer` or an `effectiveDateTime` or a `sourceCode` or a `customerGroupIds` is already present in the existing shopper context, its value is replaced by the corresponding value from the patch body. If a `custom qualifers'` or a `assignment qualifiers'` value is set to `null`, it's deleted from existing shopper context. If `effectiveDateTime` or `sourceCode` value is set to an empty string (\"\"), it's deleted from existing shopper context. If `effectiveDateTime` or `sourceCode` value is set to `null`, it's ignored. If an `effectiveDateTime` or `sourceCode` or `custom/assignment qualifiiers'` value is new, it's added to the existing Shopper context. If `customerGroupIds` is set to empty array `[]` the existing value in shopper context is deleted.
|
|
8803
|
+
|
|
8804
|
+
With B2C Commerce release 24.5, all endpoints in the Shopper context API will require the `siteId` parameter for new customers. This field is marked as optional for backward compatibility and will be changed to mandatory tentatively by January 2025.
|
|
8467
8805
|
*
|
|
8468
8806
|
* If you would like to get a raw Response object use the other updateShopperContext function.
|
|
8469
8807
|
*
|
|
@@ -8471,7 +8809,14 @@ declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters
|
|
|
8471
8809
|
* @param parameters - An object containing the parameters for this method.
|
|
8472
8810
|
* @param organizationId -
|
|
8473
8811
|
* @param usid - The Shopper's unique identifier. It is a required parameter and is part of the response from the Guest or Registered User Shopper Login (SLAS) API call.
|
|
8474
|
-
* @param siteId - The
|
|
8812
|
+
* @param siteId - The identifier of the site to which the request is being sent. With B2C Commerce release 24.5, all new implementations of Shopper Context require the `siteId` query parameter to be passed. Existing customers with Shopper Context implementations should start including `siteId` going forward. Starting July 31 2024, `siteId` will be required for all customers, and a bad request response code will be returned for requests without a `siteId`.
|
|
8813
|
+
* @param evaluateContextWithClientIp - Determines whether to evaluate the context using the provided `clientIp`. This property is available with B2C Commerce version 24.7.
|
|
8814
|
+
- If `evaluateContextWithClientIp` is set to `true`:
|
|
8815
|
+
- The `clientIP` is saved and used in subsequent requests.
|
|
8816
|
+
|
|
8817
|
+
- If `evaluateContextWithClientIp` is set to `false`:
|
|
8818
|
+
- The `clientIP` is not saved and will not be used in subsequent requests.
|
|
8819
|
+
|
|
8475
8820
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
8476
8821
|
* sent with this request.
|
|
8477
8822
|
* @param body - The data to send as the request body.
|
|
@@ -8484,6 +8829,7 @@ declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters
|
|
|
8484
8829
|
organizationId: string;
|
|
8485
8830
|
usid: string;
|
|
8486
8831
|
siteId?: string;
|
|
8832
|
+
evaluateContextWithClientIp?: boolean;
|
|
8487
8833
|
} & {
|
|
8488
8834
|
[key in `c_${string}`]: any;
|
|
8489
8835
|
}, ConfigParameters>;
|
|
@@ -8494,12 +8840,21 @@ declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters
|
|
|
8494
8840
|
}>): Promise<ShopperContext>;
|
|
8495
8841
|
/**
|
|
8496
8842
|
* Updates the shopper's context based on the Shopper JWT. If the shopper context exists, it's updated with the patch body. If a `custom qualifier/assignment qualifer` or an `effectiveDateTime` or a `sourceCode` or a `customerGroupIds` is already present in the existing shopper context, its value is replaced by the corresponding value from the patch body. If a `custom qualifers'` or a `assignment qualifiers'` value is set to `null`, it's deleted from existing shopper context. If `effectiveDateTime` or `sourceCode` value is set to an empty string (\"\"), it's deleted from existing shopper context. If `effectiveDateTime` or `sourceCode` value is set to `null`, it's ignored. If an `effectiveDateTime` or `sourceCode` or `custom/assignment qualifiiers'` value is new, it's added to the existing Shopper context. If `customerGroupIds` is set to empty array `[]` the existing value in shopper context is deleted.
|
|
8843
|
+
|
|
8844
|
+
With B2C Commerce release 24.5, all endpoints in the Shopper context API will require the `siteId` parameter for new customers. This field is marked as optional for backward compatibility and will be changed to mandatory tentatively by January 2025.
|
|
8497
8845
|
*
|
|
8498
8846
|
* @param options - An object containing the options for this method.
|
|
8499
8847
|
* @param parameters - An object containing the parameters for this method.
|
|
8500
8848
|
* @param organizationId -
|
|
8501
8849
|
* @param usid - The Shopper's unique identifier. It is a required parameter and is part of the response from the Guest or Registered User Shopper Login (SLAS) API call.
|
|
8502
|
-
* @param siteId - The
|
|
8850
|
+
* @param siteId - The identifier of the site to which the request is being sent. With B2C Commerce release 24.5, all new implementations of Shopper Context require the `siteId` query parameter to be passed. Existing customers with Shopper Context implementations should start including `siteId` going forward. Starting July 31 2024, `siteId` will be required for all customers, and a bad request response code will be returned for requests without a `siteId`.
|
|
8851
|
+
* @param evaluateContextWithClientIp - Determines whether to evaluate the context using the provided `clientIp`. This property is available with B2C Commerce version 24.7.
|
|
8852
|
+
- If `evaluateContextWithClientIp` is set to `true`:
|
|
8853
|
+
- The `clientIP` is saved and used in subsequent requests.
|
|
8854
|
+
|
|
8855
|
+
- If `evaluateContextWithClientIp` is set to `false`:
|
|
8856
|
+
- The `clientIP` is not saved and will not be used in subsequent requests.
|
|
8857
|
+
|
|
8503
8858
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
8504
8859
|
* sent with this request.
|
|
8505
8860
|
* @param body - The data to send as the request body.
|
|
@@ -8512,6 +8867,7 @@ declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters
|
|
|
8512
8867
|
organizationId: string;
|
|
8513
8868
|
usid: string;
|
|
8514
8869
|
siteId?: string;
|
|
8870
|
+
evaluateContextWithClientIp?: boolean;
|
|
8515
8871
|
} & {
|
|
8516
8872
|
[key in `c_${string}`]: any;
|
|
8517
8873
|
}, ConfigParameters>;
|
|
@@ -8623,6 +8979,19 @@ declare namespace ShopperContextsTypes {
|
|
|
8623
8979
|
[key: string]: any;
|
|
8624
8980
|
};
|
|
8625
8981
|
clientIp?: string;
|
|
8982
|
+
geoLocation?: {
|
|
8983
|
+
city?: string;
|
|
8984
|
+
country?: string;
|
|
8985
|
+
countryCode?: string;
|
|
8986
|
+
latitude?: number;
|
|
8987
|
+
longitude?: number;
|
|
8988
|
+
metroCode?: string;
|
|
8989
|
+
postalCode?: string;
|
|
8990
|
+
region?: string;
|
|
8991
|
+
regionCode?: string;
|
|
8992
|
+
} & {
|
|
8993
|
+
[key: string]: any;
|
|
8994
|
+
};
|
|
8626
8995
|
} & {
|
|
8627
8996
|
[key: string]: any;
|
|
8628
8997
|
};
|
|
@@ -8896,6 +9265,7 @@ declare namespace ShopperContextsTypes {
|
|
|
8896
9265
|
*/
|
|
8897
9266
|
type ShopperContextsQueryParameters = {
|
|
8898
9267
|
siteId?: string;
|
|
9268
|
+
evaluateContextWithClientIp?: boolean;
|
|
8899
9269
|
};
|
|
8900
9270
|
/**
|
|
8901
9271
|
* All parameters that are used by ShopperContexts.
|
|
@@ -8924,7 +9294,7 @@ declare namespace ShopperContextsTypes {
|
|
|
8924
9294
|
* ```
|
|
8925
9295
|
*
|
|
8926
9296
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
8927
|
-
* API Version: 0.0.
|
|
9297
|
+
* API Version: 0.0.29<br />
|
|
8928
9298
|
* Last Updated: <br />
|
|
8929
9299
|
* </span>
|
|
8930
9300
|
*
|
|
@@ -8950,7 +9320,8 @@ declare namespace ShopperContextsTypes {
|
|
|
8950
9320
|
readonly createShopperContext: readonly [
|
|
8951
9321
|
"organizationId",
|
|
8952
9322
|
"usid",
|
|
8953
|
-
"siteId"
|
|
9323
|
+
"siteId",
|
|
9324
|
+
"evaluateContextWithClientIp"
|
|
8954
9325
|
];
|
|
8955
9326
|
readonly createShopperContextRequired: readonly [
|
|
8956
9327
|
"organizationId",
|
|
@@ -8968,7 +9339,8 @@ declare namespace ShopperContextsTypes {
|
|
|
8968
9339
|
readonly updateShopperContext: readonly [
|
|
8969
9340
|
"organizationId",
|
|
8970
9341
|
"usid",
|
|
8971
|
-
"siteId"
|
|
9342
|
+
"siteId",
|
|
9343
|
+
"evaluateContextWithClientIp"
|
|
8972
9344
|
];
|
|
8973
9345
|
readonly updateShopperContextRequired: readonly [
|
|
8974
9346
|
"organizationId",
|
|
@@ -8977,6 +9349,8 @@ declare namespace ShopperContextsTypes {
|
|
|
8977
9349
|
};
|
|
8978
9350
|
/**
|
|
8979
9351
|
* Gets the shopper's context based on the shopperJWT.
|
|
9352
|
+
|
|
9353
|
+
With B2C Commerce release 24.5, all endpoints in the Shopper context API will require the `siteId` parameter for new customers. This field is marked as optional for backward compatibility and will be changed to mandatory tentatively by January 2025.
|
|
8980
9354
|
*
|
|
8981
9355
|
* If you would like to get a raw Response object use the other getShopperContext function.
|
|
8982
9356
|
*
|
|
@@ -8984,7 +9358,7 @@ declare namespace ShopperContextsTypes {
|
|
|
8984
9358
|
* @param parameters - An object containing the parameters for this method.
|
|
8985
9359
|
* @param organizationId -
|
|
8986
9360
|
* @param usid - The Shopper's unique identifier. It is a required parameter and is part of the response from the Guest or Registered User Shopper Login (SLAS) API call.
|
|
8987
|
-
* @param siteId - The
|
|
9361
|
+
* @param siteId - The identifier of the site to which the request is being sent. With B2C Commerce release 24.5, all new implementations of Shopper Context require the `siteId` query parameter to be passed. Existing customers with Shopper Context implementations should start including `siteId` going forward. Starting January 2025, `siteId` will be required for all customers, and a bad request response code will be returned for requests without a `siteId`.
|
|
8988
9362
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
8989
9363
|
* sent with this request.
|
|
8990
9364
|
*
|
|
@@ -9005,12 +9379,14 @@ declare namespace ShopperContextsTypes {
|
|
|
9005
9379
|
}>): Promise<ShopperContext>;
|
|
9006
9380
|
/**
|
|
9007
9381
|
* Gets the shopper's context based on the shopperJWT.
|
|
9382
|
+
|
|
9383
|
+
With B2C Commerce release 24.5, all endpoints in the Shopper context API will require the `siteId` parameter for new customers. This field is marked as optional for backward compatibility and will be changed to mandatory tentatively by January 2025.
|
|
9008
9384
|
*
|
|
9009
9385
|
* @param options - An object containing the options for this method.
|
|
9010
9386
|
* @param parameters - An object containing the parameters for this method.
|
|
9011
9387
|
* @param organizationId -
|
|
9012
9388
|
* @param usid - The Shopper's unique identifier. It is a required parameter and is part of the response from the Guest or Registered User Shopper Login (SLAS) API call.
|
|
9013
|
-
* @param siteId - The
|
|
9389
|
+
* @param siteId - The identifier of the site to which the request is being sent. With B2C Commerce release 24.5, all new implementations of Shopper Context require the `siteId` query parameter to be passed. Existing customers with Shopper Context implementations should start including `siteId` going forward. Starting January 2025, `siteId` will be required for all customers, and a bad request response code will be returned for requests without a `siteId`.
|
|
9014
9390
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
9015
9391
|
* sent with this request.
|
|
9016
9392
|
* @param rawResponse - Set to true to return entire Response object instead of DTO.
|
|
@@ -9031,6 +9407,8 @@ declare namespace ShopperContextsTypes {
|
|
|
9031
9407
|
}>, rawResponse?: T): Promise<T extends true ? Response : ShopperContext>;
|
|
9032
9408
|
/**
|
|
9033
9409
|
* Creates the shopper's context based on shopperJWT.
|
|
9410
|
+
|
|
9411
|
+
With B2C Commerce release 24.5, all endpoints in the Shopper context API will require the `siteId` parameter for new customers. This field is marked as optional for backward compatibility and will be changed to mandatory tentatively by January 2025.
|
|
9034
9412
|
*
|
|
9035
9413
|
* If you would like to get a raw Response object use the other createShopperContext function.
|
|
9036
9414
|
*
|
|
@@ -9038,7 +9416,14 @@ declare namespace ShopperContextsTypes {
|
|
|
9038
9416
|
* @param parameters - An object containing the parameters for this method.
|
|
9039
9417
|
* @param organizationId -
|
|
9040
9418
|
* @param usid - The Shopper's unique identifier. It is a required parameter and is part of the response from the Guest or Registered User Shopper Login (SLAS) API call.
|
|
9041
|
-
* @param siteId - The
|
|
9419
|
+
* @param siteId - The identifier of the site to which the request is being sent. With B2C Commerce release 24.5, all new implementations of Shopper Context require the `siteId` query parameter to be passed. Existing customers with Shopper Context implementations should start including `siteId` going forward. Starting July 31 2024, `siteId` will be required for all customers, and a bad request response code will be returned for requests without a `siteId`.
|
|
9420
|
+
* @param evaluateContextWithClientIp - Determines whether to evaluate the context using the provided `clientIp`. This property is available with B2C Commerce version 24.7.
|
|
9421
|
+
- If `evaluateContextWithClientIp` is set to `true`:
|
|
9422
|
+
- The `clientIp` is saved and used in subsequent requests.
|
|
9423
|
+
|
|
9424
|
+
- If `evaluateContextWithClientIp` is set to `false`:
|
|
9425
|
+
- The `clientIp` is not saved and will not be used in subsequent requests.
|
|
9426
|
+
|
|
9042
9427
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
9043
9428
|
* sent with this request.
|
|
9044
9429
|
* @param body - The data to send as the request body.
|
|
@@ -9051,6 +9436,7 @@ declare namespace ShopperContextsTypes {
|
|
|
9051
9436
|
organizationId: string;
|
|
9052
9437
|
usid: string;
|
|
9053
9438
|
siteId?: string;
|
|
9439
|
+
evaluateContextWithClientIp?: boolean;
|
|
9054
9440
|
} & {
|
|
9055
9441
|
[key in `c_${string}`]: any;
|
|
9056
9442
|
}, ConfigParameters>;
|
|
@@ -9061,12 +9447,21 @@ declare namespace ShopperContextsTypes {
|
|
|
9061
9447
|
}>): Promise<void | void>;
|
|
9062
9448
|
/**
|
|
9063
9449
|
* Creates the shopper's context based on shopperJWT.
|
|
9450
|
+
|
|
9451
|
+
With B2C Commerce release 24.5, all endpoints in the Shopper context API will require the `siteId` parameter for new customers. This field is marked as optional for backward compatibility and will be changed to mandatory tentatively by January 2025.
|
|
9064
9452
|
*
|
|
9065
9453
|
* @param options - An object containing the options for this method.
|
|
9066
9454
|
* @param parameters - An object containing the parameters for this method.
|
|
9067
9455
|
* @param organizationId -
|
|
9068
9456
|
* @param usid - The Shopper's unique identifier. It is a required parameter and is part of the response from the Guest or Registered User Shopper Login (SLAS) API call.
|
|
9069
|
-
* @param siteId - The
|
|
9457
|
+
* @param siteId - The identifier of the site to which the request is being sent. With B2C Commerce release 24.5, all new implementations of Shopper Context require the `siteId` query parameter to be passed. Existing customers with Shopper Context implementations should start including `siteId` going forward. Starting July 31 2024, `siteId` will be required for all customers, and a bad request response code will be returned for requests without a `siteId`.
|
|
9458
|
+
* @param evaluateContextWithClientIp - Determines whether to evaluate the context using the provided `clientIp`. This property is available with B2C Commerce version 24.7.
|
|
9459
|
+
- If `evaluateContextWithClientIp` is set to `true`:
|
|
9460
|
+
- The `clientIp` is saved and used in subsequent requests.
|
|
9461
|
+
|
|
9462
|
+
- If `evaluateContextWithClientIp` is set to `false`:
|
|
9463
|
+
- The `clientIp` is not saved and will not be used in subsequent requests.
|
|
9464
|
+
|
|
9070
9465
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
9071
9466
|
* sent with this request.
|
|
9072
9467
|
* @param body - The data to send as the request body.
|
|
@@ -9079,6 +9474,7 @@ declare namespace ShopperContextsTypes {
|
|
|
9079
9474
|
organizationId: string;
|
|
9080
9475
|
usid: string;
|
|
9081
9476
|
siteId?: string;
|
|
9477
|
+
evaluateContextWithClientIp?: boolean;
|
|
9082
9478
|
} & {
|
|
9083
9479
|
[key in `c_${string}`]: any;
|
|
9084
9480
|
}, ConfigParameters>;
|
|
@@ -9089,6 +9485,8 @@ declare namespace ShopperContextsTypes {
|
|
|
9089
9485
|
}>, rawResponse?: T): Promise<T extends true ? Response : void | void>;
|
|
9090
9486
|
/**
|
|
9091
9487
|
* Gets the shopper's context based on the shopperJWT.
|
|
9488
|
+
|
|
9489
|
+
With B2C Commerce release 24.5, all endpoints in the Shopper context API will require the `siteId` parameter for new customers. This field is marked as optional for backward compatibility and will be changed to mandatory tentatively by January 2025.
|
|
9092
9490
|
*
|
|
9093
9491
|
* If you would like to get a raw Response object use the other deleteShopperContext function.
|
|
9094
9492
|
*
|
|
@@ -9096,7 +9494,7 @@ declare namespace ShopperContextsTypes {
|
|
|
9096
9494
|
* @param parameters - An object containing the parameters for this method.
|
|
9097
9495
|
* @param organizationId -
|
|
9098
9496
|
* @param usid - The Shopper's unique identifier. It is a required parameter and is part of the response from the Guest or Registered User Shopper Login (SLAS) API call.
|
|
9099
|
-
* @param siteId - The
|
|
9497
|
+
* @param siteId - The identifier of the site to which the request is being sent. With B2C Commerce release 24.5, all new implementations of Shopper Context require the `siteId` query parameter to be passed. Existing customers with Shopper Context implementations should start including `siteId` going forward. Starting July 31 2024, `siteId` will be required for all customers, and a bad request response code will be returned for requests without a `siteId`.
|
|
9100
9498
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
9101
9499
|
* sent with this request.
|
|
9102
9500
|
*
|
|
@@ -9117,12 +9515,14 @@ declare namespace ShopperContextsTypes {
|
|
|
9117
9515
|
}>): Promise<void>;
|
|
9118
9516
|
/**
|
|
9119
9517
|
* Gets the shopper's context based on the shopperJWT.
|
|
9518
|
+
|
|
9519
|
+
With B2C Commerce release 24.5, all endpoints in the Shopper context API will require the `siteId` parameter for new customers. This field is marked as optional for backward compatibility and will be changed to mandatory tentatively by January 2025.
|
|
9120
9520
|
*
|
|
9121
9521
|
* @param options - An object containing the options for this method.
|
|
9122
9522
|
* @param parameters - An object containing the parameters for this method.
|
|
9123
9523
|
* @param organizationId -
|
|
9124
9524
|
* @param usid - The Shopper's unique identifier. It is a required parameter and is part of the response from the Guest or Registered User Shopper Login (SLAS) API call.
|
|
9125
|
-
* @param siteId - The
|
|
9525
|
+
* @param siteId - The identifier of the site to which the request is being sent. With B2C Commerce release 24.5, all new implementations of Shopper Context require the `siteId` query parameter to be passed. Existing customers with Shopper Context implementations should start including `siteId` going forward. Starting July 31 2024, `siteId` will be required for all customers, and a bad request response code will be returned for requests without a `siteId`.
|
|
9126
9526
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
9127
9527
|
* sent with this request.
|
|
9128
9528
|
* @param rawResponse - Set to true to return entire Response object instead of DTO.
|
|
@@ -9143,6 +9543,8 @@ declare namespace ShopperContextsTypes {
|
|
|
9143
9543
|
}>, rawResponse?: T): Promise<T extends true ? Response : void>;
|
|
9144
9544
|
/**
|
|
9145
9545
|
* Updates the shopper's context based on the Shopper JWT. If the shopper context exists, it's updated with the patch body. If a `custom qualifier/assignment qualifer` or an `effectiveDateTime` or a `sourceCode` or a `customerGroupIds` is already present in the existing shopper context, its value is replaced by the corresponding value from the patch body. If a `custom qualifers'` or a `assignment qualifiers'` value is set to `null`, it's deleted from existing shopper context. If `effectiveDateTime` or `sourceCode` value is set to an empty string (\"\"), it's deleted from existing shopper context. If `effectiveDateTime` or `sourceCode` value is set to `null`, it's ignored. If an `effectiveDateTime` or `sourceCode` or `custom/assignment qualifiiers'` value is new, it's added to the existing Shopper context. If `customerGroupIds` is set to empty array `[]` the existing value in shopper context is deleted.
|
|
9546
|
+
|
|
9547
|
+
With B2C Commerce release 24.5, all endpoints in the Shopper context API will require the `siteId` parameter for new customers. This field is marked as optional for backward compatibility and will be changed to mandatory tentatively by January 2025.
|
|
9146
9548
|
*
|
|
9147
9549
|
* If you would like to get a raw Response object use the other updateShopperContext function.
|
|
9148
9550
|
*
|
|
@@ -9150,7 +9552,14 @@ declare namespace ShopperContextsTypes {
|
|
|
9150
9552
|
* @param parameters - An object containing the parameters for this method.
|
|
9151
9553
|
* @param organizationId -
|
|
9152
9554
|
* @param usid - The Shopper's unique identifier. It is a required parameter and is part of the response from the Guest or Registered User Shopper Login (SLAS) API call.
|
|
9153
|
-
* @param siteId - The
|
|
9555
|
+
* @param siteId - The identifier of the site to which the request is being sent. With B2C Commerce release 24.5, all new implementations of Shopper Context require the `siteId` query parameter to be passed. Existing customers with Shopper Context implementations should start including `siteId` going forward. Starting July 31 2024, `siteId` will be required for all customers, and a bad request response code will be returned for requests without a `siteId`.
|
|
9556
|
+
* @param evaluateContextWithClientIp - Determines whether to evaluate the context using the provided `clientIp`. This property is available with B2C Commerce version 24.7.
|
|
9557
|
+
- If `evaluateContextWithClientIp` is set to `true`:
|
|
9558
|
+
- The `clientIP` is saved and used in subsequent requests.
|
|
9559
|
+
|
|
9560
|
+
- If `evaluateContextWithClientIp` is set to `false`:
|
|
9561
|
+
- The `clientIP` is not saved and will not be used in subsequent requests.
|
|
9562
|
+
|
|
9154
9563
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
9155
9564
|
* sent with this request.
|
|
9156
9565
|
* @param body - The data to send as the request body.
|
|
@@ -9163,6 +9572,7 @@ declare namespace ShopperContextsTypes {
|
|
|
9163
9572
|
organizationId: string;
|
|
9164
9573
|
usid: string;
|
|
9165
9574
|
siteId?: string;
|
|
9575
|
+
evaluateContextWithClientIp?: boolean;
|
|
9166
9576
|
} & {
|
|
9167
9577
|
[key in `c_${string}`]: any;
|
|
9168
9578
|
}, ConfigParameters>;
|
|
@@ -9173,12 +9583,21 @@ declare namespace ShopperContextsTypes {
|
|
|
9173
9583
|
}>): Promise<ShopperContext>;
|
|
9174
9584
|
/**
|
|
9175
9585
|
* Updates the shopper's context based on the Shopper JWT. If the shopper context exists, it's updated with the patch body. If a `custom qualifier/assignment qualifer` or an `effectiveDateTime` or a `sourceCode` or a `customerGroupIds` is already present in the existing shopper context, its value is replaced by the corresponding value from the patch body. If a `custom qualifers'` or a `assignment qualifiers'` value is set to `null`, it's deleted from existing shopper context. If `effectiveDateTime` or `sourceCode` value is set to an empty string (\"\"), it's deleted from existing shopper context. If `effectiveDateTime` or `sourceCode` value is set to `null`, it's ignored. If an `effectiveDateTime` or `sourceCode` or `custom/assignment qualifiiers'` value is new, it's added to the existing Shopper context. If `customerGroupIds` is set to empty array `[]` the existing value in shopper context is deleted.
|
|
9586
|
+
|
|
9587
|
+
With B2C Commerce release 24.5, all endpoints in the Shopper context API will require the `siteId` parameter for new customers. This field is marked as optional for backward compatibility and will be changed to mandatory tentatively by January 2025.
|
|
9176
9588
|
*
|
|
9177
9589
|
* @param options - An object containing the options for this method.
|
|
9178
9590
|
* @param parameters - An object containing the parameters for this method.
|
|
9179
9591
|
* @param organizationId -
|
|
9180
9592
|
* @param usid - The Shopper's unique identifier. It is a required parameter and is part of the response from the Guest or Registered User Shopper Login (SLAS) API call.
|
|
9181
|
-
* @param siteId - The
|
|
9593
|
+
* @param siteId - The identifier of the site to which the request is being sent. With B2C Commerce release 24.5, all new implementations of Shopper Context require the `siteId` query parameter to be passed. Existing customers with Shopper Context implementations should start including `siteId` going forward. Starting July 31 2024, `siteId` will be required for all customers, and a bad request response code will be returned for requests without a `siteId`.
|
|
9594
|
+
* @param evaluateContextWithClientIp - Determines whether to evaluate the context using the provided `clientIp`. This property is available with B2C Commerce version 24.7.
|
|
9595
|
+
- If `evaluateContextWithClientIp` is set to `true`:
|
|
9596
|
+
- The `clientIP` is saved and used in subsequent requests.
|
|
9597
|
+
|
|
9598
|
+
- If `evaluateContextWithClientIp` is set to `false`:
|
|
9599
|
+
- The `clientIP` is not saved and will not be used in subsequent requests.
|
|
9600
|
+
|
|
9182
9601
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
9183
9602
|
* sent with this request.
|
|
9184
9603
|
* @param body - The data to send as the request body.
|
|
@@ -9191,6 +9610,7 @@ declare namespace ShopperContextsTypes {
|
|
|
9191
9610
|
organizationId: string;
|
|
9192
9611
|
usid: string;
|
|
9193
9612
|
siteId?: string;
|
|
9613
|
+
evaluateContextWithClientIp?: boolean;
|
|
9194
9614
|
} & {
|
|
9195
9615
|
[key in `c_${string}`]: any;
|
|
9196
9616
|
}, ConfigParameters>;
|
|
@@ -9283,7 +9703,7 @@ type PublicProductListResult = {
|
|
|
9283
9703
|
} & {
|
|
9284
9704
|
[key: string]: any;
|
|
9285
9705
|
};
|
|
9286
|
-
type BasketsResult
|
|
9706
|
+
type BasketsResult = {
|
|
9287
9707
|
baskets?: Array<Basket>;
|
|
9288
9708
|
total: number;
|
|
9289
9709
|
} & {
|
|
@@ -10190,7 +10610,7 @@ type ShopperCustomersParameters = ShopperCustomersPathParameters & BaseUriParame
|
|
|
10190
10610
|
* ```
|
|
10191
10611
|
*
|
|
10192
10612
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
10193
|
-
* API Version: 0.0.
|
|
10613
|
+
* API Version: 0.0.49<br />
|
|
10194
10614
|
* Last Updated: <br />
|
|
10195
10615
|
* </span>
|
|
10196
10616
|
*
|
|
@@ -11177,7 +11597,7 @@ declare class ShopperCustomers<ConfigParameters extends ShopperCustomersParamete
|
|
|
11177
11597
|
headers?: {
|
|
11178
11598
|
[key: string]: string;
|
|
11179
11599
|
};
|
|
11180
|
-
}>): Promise<BasketsResult
|
|
11600
|
+
}>): Promise<BasketsResult>;
|
|
11181
11601
|
/**
|
|
11182
11602
|
* Gets the baskets of a customer. This endpoint accepts a registered customer ShopperToken (JWT) or a guest customer ShopperToken.
|
|
11183
11603
|
*
|
|
@@ -11203,7 +11623,7 @@ declare class ShopperCustomers<ConfigParameters extends ShopperCustomersParamete
|
|
|
11203
11623
|
headers?: {
|
|
11204
11624
|
[key: string]: string;
|
|
11205
11625
|
};
|
|
11206
|
-
}>, rawResponse?: T): Promise<T extends true ? Response : BasketsResult
|
|
11626
|
+
}>, rawResponse?: T): Promise<T extends true ? Response : BasketsResult>;
|
|
11207
11627
|
/**
|
|
11208
11628
|
* Returns a pageable list of all customer's orders. The default page size is 10. This endpoint accepts a registered customer ShopperToken (JWT) or a guest customer ShopperToken.
|
|
11209
11629
|
*
|
|
@@ -13526,7 +13946,7 @@ declare namespace ShopperCustomersTypes {
|
|
|
13526
13946
|
* ```
|
|
13527
13947
|
*
|
|
13528
13948
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
13529
|
-
* API Version: 0.0.
|
|
13949
|
+
* API Version: 0.0.49<br />
|
|
13530
13950
|
* Last Updated: <br />
|
|
13531
13951
|
* </span>
|
|
13532
13952
|
*
|
|
@@ -16937,7 +17357,7 @@ type ShopperExperienceParameters = ShopperExperiencePathParameters & BaseUriPara
|
|
|
16937
17357
|
* ```
|
|
16938
17358
|
*
|
|
16939
17359
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
16940
|
-
* API Version: 1.0.
|
|
17360
|
+
* API Version: 1.0.5<br />
|
|
16941
17361
|
* Last Updated: <br />
|
|
16942
17362
|
* </span>
|
|
16943
17363
|
*
|
|
@@ -17599,7 +18019,7 @@ declare namespace ShopperExperienceTypes {
|
|
|
17599
18019
|
* ```
|
|
17600
18020
|
*
|
|
17601
18021
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
17602
|
-
* API Version: 1.0.
|
|
18022
|
+
* API Version: 1.0.5<br />
|
|
17603
18023
|
* Last Updated: <br />
|
|
17604
18024
|
* </span>
|
|
17605
18025
|
*
|
|
@@ -17841,8 +18261,6 @@ type GiftCertificate = {
|
|
|
17841
18261
|
};
|
|
17842
18262
|
type GiftCertificateRequest = {
|
|
17843
18263
|
giftCertificateCode: string;
|
|
17844
|
-
} & {
|
|
17845
|
-
[key: string]: any;
|
|
17846
18264
|
};
|
|
17847
18265
|
type RangeFilter$4 = {
|
|
17848
18266
|
[key: string]: any;
|
|
@@ -17986,7 +18404,7 @@ type ShopperGiftCertificatesParameters = ShopperGiftCertificatesPathParameters &
|
|
|
17986
18404
|
* ```
|
|
17987
18405
|
*
|
|
17988
18406
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
17989
|
-
* API Version: 1.0.
|
|
18407
|
+
* API Version: 1.0.17<br />
|
|
17990
18408
|
* Last Updated: <br />
|
|
17991
18409
|
* </span>
|
|
17992
18410
|
*
|
|
@@ -18172,8 +18590,6 @@ declare namespace ShopperGiftCertificatesTypes {
|
|
|
18172
18590
|
};
|
|
18173
18591
|
type GiftCertificateRequest = {
|
|
18174
18592
|
giftCertificateCode: string;
|
|
18175
|
-
} & {
|
|
18176
|
-
[key: string]: any;
|
|
18177
18593
|
};
|
|
18178
18594
|
type ErrorResponse = {
|
|
18179
18595
|
type: string;
|
|
@@ -18472,7 +18888,7 @@ declare namespace ShopperGiftCertificatesTypes {
|
|
|
18472
18888
|
* ```
|
|
18473
18889
|
*
|
|
18474
18890
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
18475
|
-
* API Version: 1.0.
|
|
18891
|
+
* API Version: 1.0.17<br />
|
|
18476
18892
|
* Last Updated: <br />
|
|
18477
18893
|
* </span>
|
|
18478
18894
|
*
|
|
@@ -22386,7 +22802,7 @@ type ShopperOrdersParameters = ShopperOrdersPathParameters & BaseUriParameters &
|
|
|
22386
22802
|
* ```
|
|
22387
22803
|
*
|
|
22388
22804
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
22389
|
-
* API Version: 0.4.
|
|
22805
|
+
* API Version: 0.4.8<br />
|
|
22390
22806
|
* Last Updated: <br />
|
|
22391
22807
|
* </span>
|
|
22392
22808
|
*
|
|
@@ -23935,7 +24351,7 @@ declare namespace ShopperOrdersTypes {
|
|
|
23935
24351
|
* ```
|
|
23936
24352
|
*
|
|
23937
24353
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
23938
|
-
* API Version: 0.4.
|
|
24354
|
+
* API Version: 0.4.8<br />
|
|
23939
24355
|
* Last Updated: <br />
|
|
23940
24356
|
* </span>
|
|
23941
24357
|
*
|
|
@@ -25031,7 +25447,7 @@ type ShopperProductsParameters = ShopperProductsPathParameters & BaseUriParamete
|
|
|
25031
25447
|
* ```
|
|
25032
25448
|
*
|
|
25033
25449
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
25034
|
-
* API Version: 0.0.
|
|
25450
|
+
* API Version: 0.0.33<br />
|
|
25035
25451
|
* Last Updated: <br />
|
|
25036
25452
|
* </span>
|
|
25037
25453
|
*
|
|
@@ -26039,7 +26455,7 @@ declare namespace ShopperProductsTypes {
|
|
|
26039
26455
|
* ```
|
|
26040
26456
|
*
|
|
26041
26457
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
26042
|
-
* API Version: 0.0.
|
|
26458
|
+
* API Version: 0.0.33<br />
|
|
26043
26459
|
* Last Updated: <br />
|
|
26044
26460
|
* </span>
|
|
26045
26461
|
*
|
|
@@ -26422,8 +26838,6 @@ type PromotionResult = {
|
|
|
26422
26838
|
limit: number;
|
|
26423
26839
|
data: Array<Promotion>;
|
|
26424
26840
|
total: number;
|
|
26425
|
-
} & {
|
|
26426
|
-
[key: string]: any;
|
|
26427
26841
|
};
|
|
26428
26842
|
type RangeFilter$8 = {
|
|
26429
26843
|
[key: string]: any;
|
|
@@ -26573,7 +26987,7 @@ type ShopperPromotionsParameters = ShopperPromotionsPathParameters & BaseUriPara
|
|
|
26573
26987
|
* ```
|
|
26574
26988
|
*
|
|
26575
26989
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
26576
|
-
* API Version: 1.0.
|
|
26990
|
+
* API Version: 1.0.27<br />
|
|
26577
26991
|
* Last Updated: <br />
|
|
26578
26992
|
* </span>
|
|
26579
26993
|
*
|
|
@@ -26852,8 +27266,6 @@ declare namespace ShopperPromotionsTypes {
|
|
|
26852
27266
|
limit: number;
|
|
26853
27267
|
data: Array<Promotion>;
|
|
26854
27268
|
total: number;
|
|
26855
|
-
} & {
|
|
26856
|
-
[key: string]: any;
|
|
26857
27269
|
};
|
|
26858
27270
|
type Error = {
|
|
26859
27271
|
type: string;
|
|
@@ -27158,7 +27570,7 @@ declare namespace ShopperPromotionsTypes {
|
|
|
27158
27570
|
* ```
|
|
27159
27571
|
*
|
|
27160
27572
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
27161
|
-
* API Version: 1.0.
|
|
27573
|
+
* API Version: 1.0.27<br />
|
|
27162
27574
|
* Last Updated: <br />
|
|
27163
27575
|
* </span>
|
|
27164
27576
|
*
|
|
@@ -27720,7 +28132,7 @@ type ShopperSearchParameters = ShopperSearchPathParameters & BaseUriParameters &
|
|
|
27720
28132
|
* ```
|
|
27721
28133
|
*
|
|
27722
28134
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
27723
|
-
* API Version: 1.0.
|
|
28135
|
+
* API Version: 1.0.41<br />
|
|
27724
28136
|
* Last Updated: <br />
|
|
27725
28137
|
* </span>
|
|
27726
28138
|
*
|
|
@@ -28590,7 +29002,7 @@ declare namespace ShopperSearchTypes {
|
|
|
28590
29002
|
* ```
|
|
28591
29003
|
*
|
|
28592
29004
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
28593
|
-
* API Version: 1.0.
|
|
29005
|
+
* API Version: 1.0.41<br />
|
|
28594
29006
|
* Last Updated: <br />
|
|
28595
29007
|
* </span>
|
|
28596
29008
|
*
|
|
@@ -28991,7 +29403,7 @@ type ShopperSeoParameters = ShopperSeoPathParameters & BaseUriParameters & Shopp
|
|
|
28991
29403
|
* ```
|
|
28992
29404
|
*
|
|
28993
29405
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
28994
|
-
* API Version: 1.0.
|
|
29406
|
+
* API Version: 1.0.9<br />
|
|
28995
29407
|
* Last Updated: <br />
|
|
28996
29408
|
* </span>
|
|
28997
29409
|
*
|
|
@@ -29499,7 +29911,7 @@ declare namespace ShopperSeoTypes {
|
|
|
29499
29911
|
* ```
|
|
29500
29912
|
*
|
|
29501
29913
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
29502
|
-
* API Version: 1.0.
|
|
29914
|
+
* API Version: 1.0.9<br />
|
|
29503
29915
|
* Last Updated: <br />
|
|
29504
29916
|
* </span>
|
|
29505
29917
|
*
|
|
@@ -29788,7 +30200,7 @@ type ShopperStoresParameters = ShopperStoresPathParameters & BaseUriParameters &
|
|
|
29788
30200
|
* ```
|
|
29789
30201
|
*
|
|
29790
30202
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
29791
|
-
* API Version: 1.0.
|
|
30203
|
+
* API Version: 1.0.15<br />
|
|
29792
30204
|
* Last Updated: <br />
|
|
29793
30205
|
* </span>
|
|
29794
30206
|
*
|
|
@@ -29834,7 +30246,15 @@ declare class ShopperStores<ConfigParameters extends ShopperStoresParameters & R
|
|
|
29834
30246
|
];
|
|
29835
30247
|
};
|
|
29836
30248
|
/**
|
|
29837
|
-
* This resource retrieves a list of stores for the given site that are within a configured distance of a geolocation
|
|
30249
|
+
* This resource retrieves a list of stores for the given site that are within a configured distance of a geolocation:
|
|
30250
|
+
- The distance is interpreted either in miles or kilometers, depending on the `distanceUnit` input parameter.
|
|
30251
|
+
- The location is specified by either directly providing a latitude and longitude coordinate pair, or by providing a country and a postal code. If a postal code is passed, the resource looks in the system's geolocation mappings in Business Manager to find the coordinates for this postal code. If no matching geolocation is found, the resource returns an empty list of stores. If coordinates are passed, the values for country and postal code are ignored.
|
|
30252
|
+
|
|
30253
|
+
To verify site latitude and longitude information in Business Manager:
|
|
30254
|
+
- Navigate to **Merchant Tools -\> Online Marketing -\> Stores**.
|
|
30255
|
+
- Select the applicable site.
|
|
30256
|
+
- In the **Address** tab, verify that valid information is provided in the following fields: **Address**, **City**, **Postal Code**, **State**, and **Country**. For latitude and longitude values, you can manually enter values or provide all field values to auto-populate **Latitude** and **Longitude**. You must provide valid values for all of the previous fields for latitude and longitude to auto-populate **Latitude** and **Longitude** values.
|
|
30257
|
+
|
|
29838
30258
|
*
|
|
29839
30259
|
* If you would like to get a raw Response object use the other searchStores function.
|
|
29840
30260
|
*
|
|
@@ -29885,7 +30305,15 @@ declare class ShopperStores<ConfigParameters extends ShopperStoresParameters & R
|
|
|
29885
30305
|
};
|
|
29886
30306
|
}>): Promise<StoreResult>;
|
|
29887
30307
|
/**
|
|
29888
|
-
* This resource retrieves a list of stores for the given site that are within a configured distance of a geolocation
|
|
30308
|
+
* This resource retrieves a list of stores for the given site that are within a configured distance of a geolocation:
|
|
30309
|
+
- The distance is interpreted either in miles or kilometers, depending on the `distanceUnit` input parameter.
|
|
30310
|
+
- The location is specified by either directly providing a latitude and longitude coordinate pair, or by providing a country and a postal code. If a postal code is passed, the resource looks in the system's geolocation mappings in Business Manager to find the coordinates for this postal code. If no matching geolocation is found, the resource returns an empty list of stores. If coordinates are passed, the values for country and postal code are ignored.
|
|
30311
|
+
|
|
30312
|
+
To verify site latitude and longitude information in Business Manager:
|
|
30313
|
+
- Navigate to **Merchant Tools -\> Online Marketing -\> Stores**.
|
|
30314
|
+
- Select the applicable site.
|
|
30315
|
+
- In the **Address** tab, verify that valid information is provided in the following fields: **Address**, **City**, **Postal Code**, **State**, and **Country**. For latitude and longitude values, you can manually enter values or provide all field values to auto-populate **Latitude** and **Longitude**. You must provide valid values for all of the previous fields for latitude and longitude to auto-populate **Latitude** and **Longitude** values.
|
|
30316
|
+
|
|
29889
30317
|
*
|
|
29890
30318
|
* @param options - An object containing the options for this method.
|
|
29891
30319
|
* @param parameters - An object containing the parameters for this method.
|
|
@@ -30443,7 +30871,7 @@ declare namespace ShopperStoresTypes {
|
|
|
30443
30871
|
* ```
|
|
30444
30872
|
*
|
|
30445
30873
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
30446
|
-
* API Version: 1.0.
|
|
30874
|
+
* API Version: 1.0.15<br />
|
|
30447
30875
|
* Last Updated: <br />
|
|
30448
30876
|
* </span>
|
|
30449
30877
|
*
|
|
@@ -30489,7 +30917,15 @@ declare namespace ShopperStoresTypes {
|
|
|
30489
30917
|
];
|
|
30490
30918
|
};
|
|
30491
30919
|
/**
|
|
30492
|
-
* This resource retrieves a list of stores for the given site that are within a configured distance of a geolocation
|
|
30920
|
+
* This resource retrieves a list of stores for the given site that are within a configured distance of a geolocation:
|
|
30921
|
+
- The distance is interpreted either in miles or kilometers, depending on the `distanceUnit` input parameter.
|
|
30922
|
+
- The location is specified by either directly providing a latitude and longitude coordinate pair, or by providing a country and a postal code. If a postal code is passed, the resource looks in the system's geolocation mappings in Business Manager to find the coordinates for this postal code. If no matching geolocation is found, the resource returns an empty list of stores. If coordinates are passed, the values for country and postal code are ignored.
|
|
30923
|
+
|
|
30924
|
+
To verify site latitude and longitude information in Business Manager:
|
|
30925
|
+
- Navigate to **Merchant Tools -\> Online Marketing -\> Stores**.
|
|
30926
|
+
- Select the applicable site.
|
|
30927
|
+
- In the **Address** tab, verify that valid information is provided in the following fields: **Address**, **City**, **Postal Code**, **State**, and **Country**. For latitude and longitude values, you can manually enter values or provide all field values to auto-populate **Latitude** and **Longitude**. You must provide valid values for all of the previous fields for latitude and longitude to auto-populate **Latitude** and **Longitude** values.
|
|
30928
|
+
|
|
30493
30929
|
*
|
|
30494
30930
|
* If you would like to get a raw Response object use the other searchStores function.
|
|
30495
30931
|
*
|
|
@@ -30540,7 +30976,15 @@ declare namespace ShopperStoresTypes {
|
|
|
30540
30976
|
};
|
|
30541
30977
|
}>): Promise<StoreResult>;
|
|
30542
30978
|
/**
|
|
30543
|
-
* This resource retrieves a list of stores for the given site that are within a configured distance of a geolocation
|
|
30979
|
+
* This resource retrieves a list of stores for the given site that are within a configured distance of a geolocation:
|
|
30980
|
+
- The distance is interpreted either in miles or kilometers, depending on the `distanceUnit` input parameter.
|
|
30981
|
+
- The location is specified by either directly providing a latitude and longitude coordinate pair, or by providing a country and a postal code. If a postal code is passed, the resource looks in the system's geolocation mappings in Business Manager to find the coordinates for this postal code. If no matching geolocation is found, the resource returns an empty list of stores. If coordinates are passed, the values for country and postal code are ignored.
|
|
30982
|
+
|
|
30983
|
+
To verify site latitude and longitude information in Business Manager:
|
|
30984
|
+
- Navigate to **Merchant Tools -\> Online Marketing -\> Stores**.
|
|
30985
|
+
- Select the applicable site.
|
|
30986
|
+
- In the **Address** tab, verify that valid information is provided in the following fields: **Address**, **City**, **Postal Code**, **State**, and **Country**. For latitude and longitude values, you can manually enter values or provide all field values to auto-populate **Latitude** and **Longitude**. You must provide valid values for all of the previous fields for latitude and longitude to auto-populate **Latitude** and **Longitude** values.
|
|
30987
|
+
|
|
30544
30988
|
*
|
|
30545
30989
|
* @param options - An object containing the options for this method.
|
|
30546
30990
|
* @param parameters - An object containing the parameters for this method.
|