commerce-sdk-isomorphic 2.1.0-dev.0 → 2.1.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.
@@ -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.3<br />
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 - Changing the billing/shipping address can trigger tax recalculation. If the basket's tax mode is internal, the tax is automatically recalculated using tax tables. If the basket's tax mode is external, this query parameter controls tax recalculation as follows:
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 - Changing the billing/shipping address can trigger tax recalculation. If the basket's tax mode is internal, the tax is automatically recalculated using tax tables. If the basket's tax mode is external, this query parameter controls tax recalculation as follows:
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
- following values in the request body are considered by the server:
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: a valid product ID. The purpose of this
2613
+ - `productId`: a valid product ID. The purpose of this
2462
2614
  value is to exchange a variation of a variation product.
2463
- - shipmentId: a valid shipment ID. The purpose of
2615
+ - `shipmentId`: a valid shipment ID. The purpose of
2464
2616
  this value is to move a product item to another shipment.
2465
- - quantity: a number between 0 and 999. The purpose of
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/optionValueId: a valid option value
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. The provided values must be valid
2476
- for the option product that this product item represents. Otherwise
2477
- InvalidProductOptionItemException or
2478
- InvalidProductOptionValueItemException will be thrown.
2479
- custom properties c_\<CUSTOM_NAME\>: a
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
- \<CUSTOM_NAME\> of ProductLineItem. The purpose of this value is to
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 - Updating the quantity of the product item can trigger tax recalculation. If the basket's tax mode is internal, the tax is automatically recalculated using tax tables. If the basket's tax mode is external, this query parameter controls tax recalculation as follows:
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
- following values in the request body are considered by the server:
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: a valid product ID. The purpose of this
2683
+ - `productId`: a valid product ID. The purpose of this
2530
2684
  value is to exchange a variation of a variation product.
2531
- - shipmentId: a valid shipment ID. The purpose of
2685
+ - `shipmentId`: a valid shipment ID. The purpose of
2532
2686
  this value is to move a product item to another shipment.
2533
- - quantity: a number between 0 and 999. The purpose of
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/optionValueId: a valid option value
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. The provided values must be valid
2544
- for the option product that this product item represents. Otherwise
2545
- InvalidProductOptionItemException or
2546
- InvalidProductOptionValueItemException will be thrown.
2547
- custom properties c_\<CUSTOM_NAME\>: a
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
- \<CUSTOM_NAME\> of ProductLineItem. The purpose of this value is to
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 - Updating the quantity of the product item can trigger tax recalculation. If the basket's tax mode is internal, the tax is automatically recalculated using tax tables. If the basket's tax mode is external, this query parameter controls tax recalculation as follows:
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 - Updating the payment instrument can trigger tax recalculation. If the basket's tax mode is internal, the tax is automatically recalculated using tax tables. If the basket's tax mode is external, this query parameter controls tax recalculation as follows:
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 - Updating the payment instrument can trigger tax recalculation. If the basket's tax mode is internal, the tax is automatically recalculated using tax tables. If the basket's tax mode is external, this query parameter controls tax recalculation as follows:
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 - Updating the shipping/billing address can trigger tax recalculation. If the basket's tax mode is internal, the tax is automatically recalculated using tax tables. If the basket's tax mode is external, this query parameter controls tax recalculation as follows:
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 - Updating the shipping/billing address can trigger tax recalculation. If the basket's tax mode is internal, the tax is automatically recalculated using tax tables. If the basket's tax mode is external, this query parameter controls tax recalculation as follows:
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.3<br />
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 - Changing the billing/shipping address can trigger tax recalculation. If the basket's tax mode is internal, the tax is automatically recalculated using tax tables. If the basket's tax mode is external, this query parameter controls tax recalculation as follows:
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 - Changing the billing/shipping address can trigger tax recalculation. If the basket's tax mode is internal, the tax is automatically recalculated using tax tables. If the basket's tax mode is external, this query parameter controls tax recalculation as follows:
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
- following values in the request body are considered by the server:
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: a valid product ID. The purpose of this
6885
+ - `productId`: a valid product ID. The purpose of this
6588
6886
  value is to exchange a variation of a variation product.
6589
- - shipmentId: a valid shipment ID. The purpose of
6887
+ - `shipmentId`: a valid shipment ID. The purpose of
6590
6888
  this value is to move a product item to another shipment.
6591
- - quantity: a number between 0 and 999. The purpose of
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/optionValueId: a valid option value
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. The provided values must be valid
6602
- for the option product that this product item represents. Otherwise
6603
- InvalidProductOptionItemException or
6604
- InvalidProductOptionValueItemException will be thrown.
6605
- custom properties c_\<CUSTOM_NAME\>: a
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
- \<CUSTOM_NAME\> of ProductLineItem. The purpose of this value is to
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 - Updating the quantity of the product item can trigger tax recalculation. If the basket's tax mode is internal, the tax is automatically recalculated using tax tables. If the basket's tax mode is external, this query parameter controls tax recalculation as follows:
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
- following values in the request body are considered by the server:
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: a valid product ID. The purpose of this
6955
+ - `productId`: a valid product ID. The purpose of this
6656
6956
  value is to exchange a variation of a variation product.
6657
- - shipmentId: a valid shipment ID. The purpose of
6957
+ - `shipmentId`: a valid shipment ID. The purpose of
6658
6958
  this value is to move a product item to another shipment.
6659
- - quantity: a number between 0 and 999. The purpose of
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/optionValueId: a valid option value
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. The provided values must be valid
6670
- for the option product that this product item represents. Otherwise
6671
- InvalidProductOptionItemException or
6672
- InvalidProductOptionValueItemException will be thrown.
6673
- custom properties c_\<CUSTOM_NAME\>: a
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
- \<CUSTOM_NAME\> of ProductLineItem. The purpose of this value is to
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 - Updating the quantity of the product item can trigger tax recalculation. If the basket's tax mode is internal, the tax is automatically recalculated using tax tables. If the basket's tax mode is external, this query parameter controls tax recalculation as follows:
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 - Updating the payment instrument can trigger tax recalculation. If the basket's tax mode is internal, the tax is automatically recalculated using tax tables. If the basket's tax mode is external, this query parameter controls tax recalculation as follows:
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 - Updating the payment instrument can trigger tax recalculation. If the basket's tax mode is internal, the tax is automatically recalculated using tax tables. If the basket's tax mode is external, this query parameter controls tax recalculation as follows:
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 - Updating the shipping/billing address can trigger tax recalculation. If the basket's tax mode is internal, the tax is automatically recalculated using tax tables. If the basket's tax mode is external, this query parameter controls tax recalculation as follows:
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 - Updating the shipping/billing address can trigger tax recalculation. If the basket's tax mode is internal, the tax is automatically recalculated using tax tables. If the basket's tax mode is external, this query parameter controls tax recalculation as follows:
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.26<br />
8554
+ * API Version: 0.0.28<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",
@@ -8305,7 +8613,7 @@ declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters
8305
8613
  * @param parameters - An object containing the parameters for this method.
8306
8614
  * @param organizationId -
8307
8615
  * @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 identifer of the site that a request is being made in the context of. It is strongly recommended to pass in the siteId in the call.
8616
+ * @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`.
8309
8617
  * @param headers - An object literal of key value pairs of the headers to be
8310
8618
  * sent with this request.
8311
8619
  *
@@ -8331,7 +8639,7 @@ declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters
8331
8639
  * @param parameters - An object containing the parameters for this method.
8332
8640
  * @param organizationId -
8333
8641
  * @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 identifer of the site that a request is being made in the context of. It is strongly recommended to pass in the siteId in the call.
8642
+ * @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`.
8335
8643
  * @param headers - An object literal of key value pairs of the headers to be
8336
8644
  * sent with this request.
8337
8645
  * @param rawResponse - Set to true to return entire Response object instead of DTO.
@@ -8359,7 +8667,14 @@ declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters
8359
8667
  * @param parameters - An object containing the parameters for this method.
8360
8668
  * @param organizationId -
8361
8669
  * @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 identifer of the site that a request is being made in the context of. It is strongly recommended to pass in the siteId in the call.
8670
+ * @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`.
8671
+ * @param evaluateContextWithClientIp - Determines whether to evaluate the context using the provided `clientIp`. This property is available with B2C Commerce version 24.7.
8672
+ - If `evaluateContextWithClientIp` is set to `true`:
8673
+ - The `clientIp` is saved and used in subsequent requests.
8674
+
8675
+ - If `evaluateContextWithClientIp` is set to `false`:
8676
+ - The `clientIp` is not saved and will not be used in subsequent requests.
8677
+
8363
8678
  * @param headers - An object literal of key value pairs of the headers to be
8364
8679
  * sent with this request.
8365
8680
  * @param body - The data to send as the request body.
@@ -8372,6 +8687,7 @@ declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters
8372
8687
  organizationId: string;
8373
8688
  usid: string;
8374
8689
  siteId?: string;
8690
+ evaluateContextWithClientIp?: boolean;
8375
8691
  } & {
8376
8692
  [key in `c_${string}`]: any;
8377
8693
  }, ConfigParameters>;
@@ -8387,7 +8703,14 @@ declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters
8387
8703
  * @param parameters - An object containing the parameters for this method.
8388
8704
  * @param organizationId -
8389
8705
  * @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 identifer of the site that a request is being made in the context of. It is strongly recommended to pass in the siteId in the call.
8706
+ * @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`.
8707
+ * @param evaluateContextWithClientIp - Determines whether to evaluate the context using the provided `clientIp`. This property is available with B2C Commerce version 24.7.
8708
+ - If `evaluateContextWithClientIp` is set to `true`:
8709
+ - The `clientIp` is saved and used in subsequent requests.
8710
+
8711
+ - If `evaluateContextWithClientIp` is set to `false`:
8712
+ - The `clientIp` is not saved and will not be used in subsequent requests.
8713
+
8391
8714
  * @param headers - An object literal of key value pairs of the headers to be
8392
8715
  * sent with this request.
8393
8716
  * @param body - The data to send as the request body.
@@ -8400,6 +8723,7 @@ declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters
8400
8723
  organizationId: string;
8401
8724
  usid: string;
8402
8725
  siteId?: string;
8726
+ evaluateContextWithClientIp?: boolean;
8403
8727
  } & {
8404
8728
  [key in `c_${string}`]: any;
8405
8729
  }, ConfigParameters>;
@@ -8417,7 +8741,7 @@ declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters
8417
8741
  * @param parameters - An object containing the parameters for this method.
8418
8742
  * @param organizationId -
8419
8743
  * @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 identifer of the site that a request is being made in the context of. It is strongly recommended to pass in the siteId in the call.
8744
+ * @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
8745
  * @param headers - An object literal of key value pairs of the headers to be
8422
8746
  * sent with this request.
8423
8747
  *
@@ -8443,7 +8767,7 @@ declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters
8443
8767
  * @param parameters - An object containing the parameters for this method.
8444
8768
  * @param organizationId -
8445
8769
  * @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 identifer of the site that a request is being made in the context of. It is strongly recommended to pass in the siteId in the call.
8770
+ * @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
8771
  * @param headers - An object literal of key value pairs of the headers to be
8448
8772
  * sent with this request.
8449
8773
  * @param rawResponse - Set to true to return entire Response object instead of DTO.
@@ -8471,7 +8795,14 @@ declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters
8471
8795
  * @param parameters - An object containing the parameters for this method.
8472
8796
  * @param organizationId -
8473
8797
  * @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 identifer of the site that a request is being made in the context of. It is strongly recommended to pass in the siteId in the call.
8798
+ * @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`.
8799
+ * @param evaluateContextWithClientIp - Determines whether to evaluate the context using the provided `clientIp`. This property is available with B2C Commerce version 24.7.
8800
+ - If `evaluateContextWithClientIp` is set to `true`:
8801
+ - The `clientIP` is saved and used in subsequent requests.
8802
+
8803
+ - If `evaluateContextWithClientIp` is set to `false`:
8804
+ - The `clientIP` is not saved and will not be used in subsequent requests.
8805
+
8475
8806
  * @param headers - An object literal of key value pairs of the headers to be
8476
8807
  * sent with this request.
8477
8808
  * @param body - The data to send as the request body.
@@ -8484,6 +8815,7 @@ declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters
8484
8815
  organizationId: string;
8485
8816
  usid: string;
8486
8817
  siteId?: string;
8818
+ evaluateContextWithClientIp?: boolean;
8487
8819
  } & {
8488
8820
  [key in `c_${string}`]: any;
8489
8821
  }, ConfigParameters>;
@@ -8499,7 +8831,14 @@ declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters
8499
8831
  * @param parameters - An object containing the parameters for this method.
8500
8832
  * @param organizationId -
8501
8833
  * @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 identifer of the site that a request is being made in the context of. It is strongly recommended to pass in the siteId in the call.
8834
+ * @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`.
8835
+ * @param evaluateContextWithClientIp - Determines whether to evaluate the context using the provided `clientIp`. This property is available with B2C Commerce version 24.7.
8836
+ - If `evaluateContextWithClientIp` is set to `true`:
8837
+ - The `clientIP` is saved and used in subsequent requests.
8838
+
8839
+ - If `evaluateContextWithClientIp` is set to `false`:
8840
+ - The `clientIP` is not saved and will not be used in subsequent requests.
8841
+
8503
8842
  * @param headers - An object literal of key value pairs of the headers to be
8504
8843
  * sent with this request.
8505
8844
  * @param body - The data to send as the request body.
@@ -8512,6 +8851,7 @@ declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters
8512
8851
  organizationId: string;
8513
8852
  usid: string;
8514
8853
  siteId?: string;
8854
+ evaluateContextWithClientIp?: boolean;
8515
8855
  } & {
8516
8856
  [key in `c_${string}`]: any;
8517
8857
  }, ConfigParameters>;
@@ -8623,6 +8963,19 @@ declare namespace ShopperContextsTypes {
8623
8963
  [key: string]: any;
8624
8964
  };
8625
8965
  clientIp?: string;
8966
+ geoLocation?: {
8967
+ city?: string;
8968
+ country?: string;
8969
+ countryCode?: string;
8970
+ latitude?: number;
8971
+ longitude?: number;
8972
+ metroCode?: string;
8973
+ postalCode?: string;
8974
+ region?: string;
8975
+ regionCode?: string;
8976
+ } & {
8977
+ [key: string]: any;
8978
+ };
8626
8979
  } & {
8627
8980
  [key: string]: any;
8628
8981
  };
@@ -8896,6 +9249,7 @@ declare namespace ShopperContextsTypes {
8896
9249
  */
8897
9250
  type ShopperContextsQueryParameters = {
8898
9251
  siteId?: string;
9252
+ evaluateContextWithClientIp?: boolean;
8899
9253
  };
8900
9254
  /**
8901
9255
  * All parameters that are used by ShopperContexts.
@@ -8924,7 +9278,7 @@ declare namespace ShopperContextsTypes {
8924
9278
  * ```
8925
9279
  *
8926
9280
  * <span style="font-size:.7em; display:block; text-align: right">
8927
- * API Version: 0.0.26<br />
9281
+ * API Version: 0.0.28<br />
8928
9282
  * Last Updated: <br />
8929
9283
  * </span>
8930
9284
  *
@@ -8950,7 +9304,8 @@ declare namespace ShopperContextsTypes {
8950
9304
  readonly createShopperContext: readonly [
8951
9305
  "organizationId",
8952
9306
  "usid",
8953
- "siteId"
9307
+ "siteId",
9308
+ "evaluateContextWithClientIp"
8954
9309
  ];
8955
9310
  readonly createShopperContextRequired: readonly [
8956
9311
  "organizationId",
@@ -8968,7 +9323,8 @@ declare namespace ShopperContextsTypes {
8968
9323
  readonly updateShopperContext: readonly [
8969
9324
  "organizationId",
8970
9325
  "usid",
8971
- "siteId"
9326
+ "siteId",
9327
+ "evaluateContextWithClientIp"
8972
9328
  ];
8973
9329
  readonly updateShopperContextRequired: readonly [
8974
9330
  "organizationId",
@@ -8984,7 +9340,7 @@ declare namespace ShopperContextsTypes {
8984
9340
  * @param parameters - An object containing the parameters for this method.
8985
9341
  * @param organizationId -
8986
9342
  * @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 identifer of the site that a request is being made in the context of. It is strongly recommended to pass in the siteId in the call.
9343
+ * @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`.
8988
9344
  * @param headers - An object literal of key value pairs of the headers to be
8989
9345
  * sent with this request.
8990
9346
  *
@@ -9010,7 +9366,7 @@ declare namespace ShopperContextsTypes {
9010
9366
  * @param parameters - An object containing the parameters for this method.
9011
9367
  * @param organizationId -
9012
9368
  * @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 identifer of the site that a request is being made in the context of. It is strongly recommended to pass in the siteId in the call.
9369
+ * @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`.
9014
9370
  * @param headers - An object literal of key value pairs of the headers to be
9015
9371
  * sent with this request.
9016
9372
  * @param rawResponse - Set to true to return entire Response object instead of DTO.
@@ -9038,7 +9394,14 @@ declare namespace ShopperContextsTypes {
9038
9394
  * @param parameters - An object containing the parameters for this method.
9039
9395
  * @param organizationId -
9040
9396
  * @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 identifer of the site that a request is being made in the context of. It is strongly recommended to pass in the siteId in the call.
9397
+ * @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`.
9398
+ * @param evaluateContextWithClientIp - Determines whether to evaluate the context using the provided `clientIp`. This property is available with B2C Commerce version 24.7.
9399
+ - If `evaluateContextWithClientIp` is set to `true`:
9400
+ - The `clientIp` is saved and used in subsequent requests.
9401
+
9402
+ - If `evaluateContextWithClientIp` is set to `false`:
9403
+ - The `clientIp` is not saved and will not be used in subsequent requests.
9404
+
9042
9405
  * @param headers - An object literal of key value pairs of the headers to be
9043
9406
  * sent with this request.
9044
9407
  * @param body - The data to send as the request body.
@@ -9051,6 +9414,7 @@ declare namespace ShopperContextsTypes {
9051
9414
  organizationId: string;
9052
9415
  usid: string;
9053
9416
  siteId?: string;
9417
+ evaluateContextWithClientIp?: boolean;
9054
9418
  } & {
9055
9419
  [key in `c_${string}`]: any;
9056
9420
  }, ConfigParameters>;
@@ -9066,7 +9430,14 @@ declare namespace ShopperContextsTypes {
9066
9430
  * @param parameters - An object containing the parameters for this method.
9067
9431
  * @param organizationId -
9068
9432
  * @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 identifer of the site that a request is being made in the context of. It is strongly recommended to pass in the siteId in the call.
9433
+ * @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`.
9434
+ * @param evaluateContextWithClientIp - Determines whether to evaluate the context using the provided `clientIp`. This property is available with B2C Commerce version 24.7.
9435
+ - If `evaluateContextWithClientIp` is set to `true`:
9436
+ - The `clientIp` is saved and used in subsequent requests.
9437
+
9438
+ - If `evaluateContextWithClientIp` is set to `false`:
9439
+ - The `clientIp` is not saved and will not be used in subsequent requests.
9440
+
9070
9441
  * @param headers - An object literal of key value pairs of the headers to be
9071
9442
  * sent with this request.
9072
9443
  * @param body - The data to send as the request body.
@@ -9079,6 +9450,7 @@ declare namespace ShopperContextsTypes {
9079
9450
  organizationId: string;
9080
9451
  usid: string;
9081
9452
  siteId?: string;
9453
+ evaluateContextWithClientIp?: boolean;
9082
9454
  } & {
9083
9455
  [key in `c_${string}`]: any;
9084
9456
  }, ConfigParameters>;
@@ -9096,7 +9468,7 @@ declare namespace ShopperContextsTypes {
9096
9468
  * @param parameters - An object containing the parameters for this method.
9097
9469
  * @param organizationId -
9098
9470
  * @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 identifer of the site that a request is being made in the context of. It is strongly recommended to pass in the siteId in the call.
9471
+ * @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
9472
  * @param headers - An object literal of key value pairs of the headers to be
9101
9473
  * sent with this request.
9102
9474
  *
@@ -9122,7 +9494,7 @@ declare namespace ShopperContextsTypes {
9122
9494
  * @param parameters - An object containing the parameters for this method.
9123
9495
  * @param organizationId -
9124
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.
9125
- * @param siteId - The identifer of the site that a request is being made in the context of. It is strongly recommended to pass in the siteId in the call.
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`.
9126
9498
  * @param headers - An object literal of key value pairs of the headers to be
9127
9499
  * sent with this request.
9128
9500
  * @param rawResponse - Set to true to return entire Response object instead of DTO.
@@ -9150,7 +9522,14 @@ declare namespace ShopperContextsTypes {
9150
9522
  * @param parameters - An object containing the parameters for this method.
9151
9523
  * @param organizationId -
9152
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.
9153
- * @param siteId - The identifer of the site that a request is being made in the context of. It is strongly recommended to pass in the siteId in the call.
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`.
9526
+ * @param evaluateContextWithClientIp - Determines whether to evaluate the context using the provided `clientIp`. This property is available with B2C Commerce version 24.7.
9527
+ - If `evaluateContextWithClientIp` is set to `true`:
9528
+ - The `clientIP` is saved and used in subsequent requests.
9529
+
9530
+ - If `evaluateContextWithClientIp` is set to `false`:
9531
+ - The `clientIP` is not saved and will not be used in subsequent requests.
9532
+
9154
9533
  * @param headers - An object literal of key value pairs of the headers to be
9155
9534
  * sent with this request.
9156
9535
  * @param body - The data to send as the request body.
@@ -9163,6 +9542,7 @@ declare namespace ShopperContextsTypes {
9163
9542
  organizationId: string;
9164
9543
  usid: string;
9165
9544
  siteId?: string;
9545
+ evaluateContextWithClientIp?: boolean;
9166
9546
  } & {
9167
9547
  [key in `c_${string}`]: any;
9168
9548
  }, ConfigParameters>;
@@ -9178,7 +9558,14 @@ declare namespace ShopperContextsTypes {
9178
9558
  * @param parameters - An object containing the parameters for this method.
9179
9559
  * @param organizationId -
9180
9560
  * @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 identifer of the site that a request is being made in the context of. It is strongly recommended to pass in the siteId in the call.
9561
+ * @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`.
9562
+ * @param evaluateContextWithClientIp - Determines whether to evaluate the context using the provided `clientIp`. This property is available with B2C Commerce version 24.7.
9563
+ - If `evaluateContextWithClientIp` is set to `true`:
9564
+ - The `clientIP` is saved and used in subsequent requests.
9565
+
9566
+ - If `evaluateContextWithClientIp` is set to `false`:
9567
+ - The `clientIP` is not saved and will not be used in subsequent requests.
9568
+
9182
9569
  * @param headers - An object literal of key value pairs of the headers to be
9183
9570
  * sent with this request.
9184
9571
  * @param body - The data to send as the request body.
@@ -9191,6 +9578,7 @@ declare namespace ShopperContextsTypes {
9191
9578
  organizationId: string;
9192
9579
  usid: string;
9193
9580
  siteId?: string;
9581
+ evaluateContextWithClientIp?: boolean;
9194
9582
  } & {
9195
9583
  [key in `c_${string}`]: any;
9196
9584
  }, ConfigParameters>;
@@ -9283,7 +9671,7 @@ type PublicProductListResult = {
9283
9671
  } & {
9284
9672
  [key: string]: any;
9285
9673
  };
9286
- type BasketsResult$0 = {
9674
+ type BasketsResult = {
9287
9675
  baskets?: Array<Basket>;
9288
9676
  total: number;
9289
9677
  } & {
@@ -10190,7 +10578,7 @@ type ShopperCustomersParameters = ShopperCustomersPathParameters & BaseUriParame
10190
10578
  * ```
10191
10579
  *
10192
10580
  * <span style="font-size:.7em; display:block; text-align: right">
10193
- * API Version: 0.0.48<br />
10581
+ * API Version: 0.0.49<br />
10194
10582
  * Last Updated: <br />
10195
10583
  * </span>
10196
10584
  *
@@ -11177,7 +11565,7 @@ declare class ShopperCustomers<ConfigParameters extends ShopperCustomersParamete
11177
11565
  headers?: {
11178
11566
  [key: string]: string;
11179
11567
  };
11180
- }>): Promise<BasketsResult$0>;
11568
+ }>): Promise<BasketsResult>;
11181
11569
  /**
11182
11570
  * Gets the baskets of a customer. This endpoint accepts a registered customer ShopperToken (JWT) or a guest customer ShopperToken.
11183
11571
  *
@@ -11203,7 +11591,7 @@ declare class ShopperCustomers<ConfigParameters extends ShopperCustomersParamete
11203
11591
  headers?: {
11204
11592
  [key: string]: string;
11205
11593
  };
11206
- }>, rawResponse?: T): Promise<T extends true ? Response : BasketsResult$0>;
11594
+ }>, rawResponse?: T): Promise<T extends true ? Response : BasketsResult>;
11207
11595
  /**
11208
11596
  * 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
11597
  *
@@ -13526,7 +13914,7 @@ declare namespace ShopperCustomersTypes {
13526
13914
  * ```
13527
13915
  *
13528
13916
  * <span style="font-size:.7em; display:block; text-align: right">
13529
- * API Version: 0.0.48<br />
13917
+ * API Version: 0.0.49<br />
13530
13918
  * Last Updated: <br />
13531
13919
  * </span>
13532
13920
  *
@@ -16937,7 +17325,7 @@ type ShopperExperienceParameters = ShopperExperiencePathParameters & BaseUriPara
16937
17325
  * ```
16938
17326
  *
16939
17327
  * <span style="font-size:.7em; display:block; text-align: right">
16940
- * API Version: 1.0.4<br />
17328
+ * API Version: 1.0.5<br />
16941
17329
  * Last Updated: <br />
16942
17330
  * </span>
16943
17331
  *
@@ -17599,7 +17987,7 @@ declare namespace ShopperExperienceTypes {
17599
17987
  * ```
17600
17988
  *
17601
17989
  * <span style="font-size:.7em; display:block; text-align: right">
17602
- * API Version: 1.0.4<br />
17990
+ * API Version: 1.0.5<br />
17603
17991
  * Last Updated: <br />
17604
17992
  * </span>
17605
17993
  *
@@ -17986,7 +18374,7 @@ type ShopperGiftCertificatesParameters = ShopperGiftCertificatesPathParameters &
17986
18374
  * ```
17987
18375
  *
17988
18376
  * <span style="font-size:.7em; display:block; text-align: right">
17989
- * API Version: 1.0.15<br />
18377
+ * API Version: 1.0.16<br />
17990
18378
  * Last Updated: <br />
17991
18379
  * </span>
17992
18380
  *
@@ -18472,7 +18860,7 @@ declare namespace ShopperGiftCertificatesTypes {
18472
18860
  * ```
18473
18861
  *
18474
18862
  * <span style="font-size:.7em; display:block; text-align: right">
18475
- * API Version: 1.0.15<br />
18863
+ * API Version: 1.0.16<br />
18476
18864
  * Last Updated: <br />
18477
18865
  * </span>
18478
18866
  *
@@ -22386,7 +22774,7 @@ type ShopperOrdersParameters = ShopperOrdersPathParameters & BaseUriParameters &
22386
22774
  * ```
22387
22775
  *
22388
22776
  * <span style="font-size:.7em; display:block; text-align: right">
22389
- * API Version: 0.4.7<br />
22777
+ * API Version: 0.4.8<br />
22390
22778
  * Last Updated: <br />
22391
22779
  * </span>
22392
22780
  *
@@ -23935,7 +24323,7 @@ declare namespace ShopperOrdersTypes {
23935
24323
  * ```
23936
24324
  *
23937
24325
  * <span style="font-size:.7em; display:block; text-align: right">
23938
- * API Version: 0.4.7<br />
24326
+ * API Version: 0.4.8<br />
23939
24327
  * Last Updated: <br />
23940
24328
  * </span>
23941
24329
  *
@@ -25031,7 +25419,7 @@ type ShopperProductsParameters = ShopperProductsPathParameters & BaseUriParamete
25031
25419
  * ```
25032
25420
  *
25033
25421
  * <span style="font-size:.7em; display:block; text-align: right">
25034
- * API Version: 0.0.32<br />
25422
+ * API Version: 0.0.33<br />
25035
25423
  * Last Updated: <br />
25036
25424
  * </span>
25037
25425
  *
@@ -26039,7 +26427,7 @@ declare namespace ShopperProductsTypes {
26039
26427
  * ```
26040
26428
  *
26041
26429
  * <span style="font-size:.7em; display:block; text-align: right">
26042
- * API Version: 0.0.32<br />
26430
+ * API Version: 0.0.33<br />
26043
26431
  * Last Updated: <br />
26044
26432
  * </span>
26045
26433
  *
@@ -26573,7 +26961,7 @@ type ShopperPromotionsParameters = ShopperPromotionsPathParameters & BaseUriPara
26573
26961
  * ```
26574
26962
  *
26575
26963
  * <span style="font-size:.7em; display:block; text-align: right">
26576
- * API Version: 1.0.25<br />
26964
+ * API Version: 1.0.26<br />
26577
26965
  * Last Updated: <br />
26578
26966
  * </span>
26579
26967
  *
@@ -27158,7 +27546,7 @@ declare namespace ShopperPromotionsTypes {
27158
27546
  * ```
27159
27547
  *
27160
27548
  * <span style="font-size:.7em; display:block; text-align: right">
27161
- * API Version: 1.0.25<br />
27549
+ * API Version: 1.0.26<br />
27162
27550
  * Last Updated: <br />
27163
27551
  * </span>
27164
27552
  *
@@ -27720,7 +28108,7 @@ type ShopperSearchParameters = ShopperSearchPathParameters & BaseUriParameters &
27720
28108
  * ```
27721
28109
  *
27722
28110
  * <span style="font-size:.7em; display:block; text-align: right">
27723
- * API Version: 1.0.40<br />
28111
+ * API Version: 1.0.41<br />
27724
28112
  * Last Updated: <br />
27725
28113
  * </span>
27726
28114
  *
@@ -28590,7 +28978,7 @@ declare namespace ShopperSearchTypes {
28590
28978
  * ```
28591
28979
  *
28592
28980
  * <span style="font-size:.7em; display:block; text-align: right">
28593
- * API Version: 1.0.40<br />
28981
+ * API Version: 1.0.41<br />
28594
28982
  * Last Updated: <br />
28595
28983
  * </span>
28596
28984
  *
@@ -28991,7 +29379,7 @@ type ShopperSeoParameters = ShopperSeoPathParameters & BaseUriParameters & Shopp
28991
29379
  * ```
28992
29380
  *
28993
29381
  * <span style="font-size:.7em; display:block; text-align: right">
28994
- * API Version: 1.0.8<br />
29382
+ * API Version: 1.0.9<br />
28995
29383
  * Last Updated: <br />
28996
29384
  * </span>
28997
29385
  *
@@ -29499,7 +29887,7 @@ declare namespace ShopperSeoTypes {
29499
29887
  * ```
29500
29888
  *
29501
29889
  * <span style="font-size:.7em; display:block; text-align: right">
29502
- * API Version: 1.0.8<br />
29890
+ * API Version: 1.0.9<br />
29503
29891
  * Last Updated: <br />
29504
29892
  * </span>
29505
29893
  *
@@ -29788,7 +30176,7 @@ type ShopperStoresParameters = ShopperStoresPathParameters & BaseUriParameters &
29788
30176
  * ```
29789
30177
  *
29790
30178
  * <span style="font-size:.7em; display:block; text-align: right">
29791
- * API Version: 1.0.13<br />
30179
+ * API Version: 1.0.15<br />
29792
30180
  * Last Updated: <br />
29793
30181
  * </span>
29794
30182
  *
@@ -29834,7 +30222,15 @@ declare class ShopperStores<ConfigParameters extends ShopperStoresParameters & R
29834
30222
  ];
29835
30223
  };
29836
30224
  /**
29837
- * This resource retrieves a list of stores for the given site that are within a configured distance of a geolocation. The distance is interpreted either in miles or kilometers, depending on the distanceUnit input parameter. The location is specified either by 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 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.
30225
+ * This resource retrieves a list of stores for the given site that are within a configured distance of a geolocation:
30226
+ - The distance is interpreted either in miles or kilometers, depending on the `distanceUnit` input parameter.
30227
+ - 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.
30228
+
30229
+ To verify site latitude and longitude information in Business Manager:
30230
+ - Navigate to **Merchant Tools -\> Online Marketing -\> Stores**.
30231
+ - Select the applicable site.
30232
+ - 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.
30233
+
29838
30234
  *
29839
30235
  * If you would like to get a raw Response object use the other searchStores function.
29840
30236
  *
@@ -29885,7 +30281,15 @@ declare class ShopperStores<ConfigParameters extends ShopperStoresParameters & R
29885
30281
  };
29886
30282
  }>): Promise<StoreResult>;
29887
30283
  /**
29888
- * This resource retrieves a list of stores for the given site that are within a configured distance of a geolocation. The distance is interpreted either in miles or kilometers, depending on the distanceUnit input parameter. The location is specified either by 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 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.
30284
+ * This resource retrieves a list of stores for the given site that are within a configured distance of a geolocation:
30285
+ - The distance is interpreted either in miles or kilometers, depending on the `distanceUnit` input parameter.
30286
+ - 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.
30287
+
30288
+ To verify site latitude and longitude information in Business Manager:
30289
+ - Navigate to **Merchant Tools -\> Online Marketing -\> Stores**.
30290
+ - Select the applicable site.
30291
+ - 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.
30292
+
29889
30293
  *
29890
30294
  * @param options - An object containing the options for this method.
29891
30295
  * @param parameters - An object containing the parameters for this method.
@@ -30443,7 +30847,7 @@ declare namespace ShopperStoresTypes {
30443
30847
  * ```
30444
30848
  *
30445
30849
  * <span style="font-size:.7em; display:block; text-align: right">
30446
- * API Version: 1.0.13<br />
30850
+ * API Version: 1.0.15<br />
30447
30851
  * Last Updated: <br />
30448
30852
  * </span>
30449
30853
  *
@@ -30489,7 +30893,15 @@ declare namespace ShopperStoresTypes {
30489
30893
  ];
30490
30894
  };
30491
30895
  /**
30492
- * This resource retrieves a list of stores for the given site that are within a configured distance of a geolocation. The distance is interpreted either in miles or kilometers, depending on the distanceUnit input parameter. The location is specified either by 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 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.
30896
+ * This resource retrieves a list of stores for the given site that are within a configured distance of a geolocation:
30897
+ - The distance is interpreted either in miles or kilometers, depending on the `distanceUnit` input parameter.
30898
+ - 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.
30899
+
30900
+ To verify site latitude and longitude information in Business Manager:
30901
+ - Navigate to **Merchant Tools -\> Online Marketing -\> Stores**.
30902
+ - Select the applicable site.
30903
+ - 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.
30904
+
30493
30905
  *
30494
30906
  * If you would like to get a raw Response object use the other searchStores function.
30495
30907
  *
@@ -30540,7 +30952,15 @@ declare namespace ShopperStoresTypes {
30540
30952
  };
30541
30953
  }>): Promise<StoreResult>;
30542
30954
  /**
30543
- * This resource retrieves a list of stores for the given site that are within a configured distance of a geolocation. The distance is interpreted either in miles or kilometers, depending on the distanceUnit input parameter. The location is specified either by 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 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.
30955
+ * This resource retrieves a list of stores for the given site that are within a configured distance of a geolocation:
30956
+ - The distance is interpreted either in miles or kilometers, depending on the `distanceUnit` input parameter.
30957
+ - 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.
30958
+
30959
+ To verify site latitude and longitude information in Business Manager:
30960
+ - Navigate to **Merchant Tools -\> Online Marketing -\> Stores**.
30961
+ - Select the applicable site.
30962
+ - 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.
30963
+
30544
30964
  *
30545
30965
  * @param options - An object containing the options for this method.
30546
30966
  * @param parameters - An object containing the parameters for this method.