commerce-sdk-isomorphic 2.0.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.
- package/CHANGELOG.md +13 -0
- package/README.md +1 -1
- package/lib/index.cjs.d.ts +3256 -218
- package/lib/index.cjs.js +1 -1
- package/lib/index.esm.d.ts +3256 -218
- package/lib/index.esm.js +1 -1
- package/package.json +5 -5
package/lib/index.esm.d.ts
CHANGED
|
@@ -241,12 +241,6 @@ type OrderAddress = {
|
|
|
241
241
|
} & {
|
|
242
242
|
[key: string]: any;
|
|
243
243
|
};
|
|
244
|
-
type BasketsResult = {
|
|
245
|
-
baskets: Array<Basket>;
|
|
246
|
-
total: number;
|
|
247
|
-
} & {
|
|
248
|
-
[key: string]: any;
|
|
249
|
-
};
|
|
250
244
|
type PriceAdjustmentRequest = {
|
|
251
245
|
discount?: DiscountRequest;
|
|
252
246
|
itemId?: string;
|
|
@@ -579,6 +573,8 @@ type Order = {
|
|
|
579
573
|
externalOrderStatus?: string;
|
|
580
574
|
giftCertificateItems?: Array<GiftCertificateItem>;
|
|
581
575
|
globalPartyId?: string;
|
|
576
|
+
groupedTaxItems?: Array<GroupedTaxItem>;
|
|
577
|
+
guest?: boolean;
|
|
582
578
|
lastModified?: any;
|
|
583
579
|
merchandizeTotalTax?: number;
|
|
584
580
|
notes?: SimpleLink;
|
|
@@ -600,6 +596,7 @@ type Order = {
|
|
|
600
596
|
siteId?: string;
|
|
601
597
|
sourceCode?: string;
|
|
602
598
|
status?: string;
|
|
599
|
+
taxRoundedAtGroup?: boolean;
|
|
603
600
|
taxTotal?: number;
|
|
604
601
|
taxation?: string;
|
|
605
602
|
} & {
|
|
@@ -670,8 +667,8 @@ type ShopperBasketsQueryParameters = {
|
|
|
670
667
|
overrideExisting?: boolean;
|
|
671
668
|
createDestinationBasket?: boolean;
|
|
672
669
|
productItemMergeMode?: string;
|
|
673
|
-
useAsShipping?: boolean;
|
|
674
670
|
removeExternalTax?: boolean;
|
|
671
|
+
useAsShipping?: boolean;
|
|
675
672
|
useAsBilling?: boolean;
|
|
676
673
|
exchange?: boolean;
|
|
677
674
|
};
|
|
@@ -702,12 +699,11 @@ type ShopperBasketsParameters = ShopperBasketsPathParameters & BaseUriParameters
|
|
|
702
699
|
* ```
|
|
703
700
|
*
|
|
704
701
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
705
|
-
* API Version: 2.0.
|
|
702
|
+
* API Version: 2.0.9<br />
|
|
706
703
|
* Last Updated: <br />
|
|
707
704
|
* </span>
|
|
708
|
-
|
|
709
705
|
*
|
|
710
|
-
|
|
706
|
+
*
|
|
711
707
|
*/
|
|
712
708
|
declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters & Record<string, unknown>> {
|
|
713
709
|
// baseUri is not required on ClientConfig, but we know that we provide one in the class constructor
|
|
@@ -716,6 +712,446 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
|
|
|
716
712
|
};
|
|
717
713
|
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/checkout/shopper-baskets/{version}";
|
|
718
714
|
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
715
|
+
static readonly paramKeys: {
|
|
716
|
+
readonly createBasket: readonly [
|
|
717
|
+
"organizationId",
|
|
718
|
+
"taxMode",
|
|
719
|
+
"temporary",
|
|
720
|
+
"siteId",
|
|
721
|
+
"locale"
|
|
722
|
+
];
|
|
723
|
+
readonly createBasketRequired: readonly [
|
|
724
|
+
"organizationId",
|
|
725
|
+
"siteId"
|
|
726
|
+
];
|
|
727
|
+
readonly transferBasket: readonly [
|
|
728
|
+
"organizationId",
|
|
729
|
+
"overrideExisting",
|
|
730
|
+
"siteId",
|
|
731
|
+
"locale"
|
|
732
|
+
];
|
|
733
|
+
readonly transferBasketRequired: readonly [
|
|
734
|
+
"organizationId",
|
|
735
|
+
"siteId"
|
|
736
|
+
];
|
|
737
|
+
readonly mergeBasket: readonly [
|
|
738
|
+
"organizationId",
|
|
739
|
+
"createDestinationBasket",
|
|
740
|
+
"productItemMergeMode",
|
|
741
|
+
"siteId",
|
|
742
|
+
"locale"
|
|
743
|
+
];
|
|
744
|
+
readonly mergeBasketRequired: readonly [
|
|
745
|
+
"organizationId",
|
|
746
|
+
"siteId"
|
|
747
|
+
];
|
|
748
|
+
readonly deleteBasket: readonly [
|
|
749
|
+
"organizationId",
|
|
750
|
+
"basketId",
|
|
751
|
+
"siteId"
|
|
752
|
+
];
|
|
753
|
+
readonly deleteBasketRequired: readonly [
|
|
754
|
+
"organizationId",
|
|
755
|
+
"basketId",
|
|
756
|
+
"siteId"
|
|
757
|
+
];
|
|
758
|
+
readonly getBasket: readonly [
|
|
759
|
+
"organizationId",
|
|
760
|
+
"basketId",
|
|
761
|
+
"siteId",
|
|
762
|
+
"locale"
|
|
763
|
+
];
|
|
764
|
+
readonly getBasketRequired: readonly [
|
|
765
|
+
"organizationId",
|
|
766
|
+
"basketId",
|
|
767
|
+
"siteId"
|
|
768
|
+
];
|
|
769
|
+
readonly updateBasket: readonly [
|
|
770
|
+
"organizationId",
|
|
771
|
+
"basketId",
|
|
772
|
+
"removeExternalTax",
|
|
773
|
+
"siteId",
|
|
774
|
+
"locale"
|
|
775
|
+
];
|
|
776
|
+
readonly updateBasketRequired: readonly [
|
|
777
|
+
"organizationId",
|
|
778
|
+
"basketId",
|
|
779
|
+
"siteId"
|
|
780
|
+
];
|
|
781
|
+
readonly updateAsAgentBasket: readonly [
|
|
782
|
+
"organizationId",
|
|
783
|
+
"basketId",
|
|
784
|
+
"siteId",
|
|
785
|
+
"locale"
|
|
786
|
+
];
|
|
787
|
+
readonly updateAsAgentBasketRequired: readonly [
|
|
788
|
+
"organizationId",
|
|
789
|
+
"basketId",
|
|
790
|
+
"siteId"
|
|
791
|
+
];
|
|
792
|
+
readonly updateBillingAddressForBasket: readonly [
|
|
793
|
+
"organizationId",
|
|
794
|
+
"basketId",
|
|
795
|
+
"useAsShipping",
|
|
796
|
+
"removeExternalTax",
|
|
797
|
+
"siteId",
|
|
798
|
+
"locale"
|
|
799
|
+
];
|
|
800
|
+
readonly updateBillingAddressForBasketRequired: readonly [
|
|
801
|
+
"organizationId",
|
|
802
|
+
"basketId",
|
|
803
|
+
"siteId"
|
|
804
|
+
];
|
|
805
|
+
readonly addCouponToBasket: readonly [
|
|
806
|
+
"organizationId",
|
|
807
|
+
"basketId",
|
|
808
|
+
"siteId",
|
|
809
|
+
"locale"
|
|
810
|
+
];
|
|
811
|
+
readonly addCouponToBasketRequired: readonly [
|
|
812
|
+
"organizationId",
|
|
813
|
+
"basketId",
|
|
814
|
+
"siteId"
|
|
815
|
+
];
|
|
816
|
+
readonly removeCouponFromBasket: readonly [
|
|
817
|
+
"organizationId",
|
|
818
|
+
"basketId",
|
|
819
|
+
"couponItemId",
|
|
820
|
+
"siteId",
|
|
821
|
+
"locale"
|
|
822
|
+
];
|
|
823
|
+
readonly removeCouponFromBasketRequired: readonly [
|
|
824
|
+
"organizationId",
|
|
825
|
+
"basketId",
|
|
826
|
+
"couponItemId",
|
|
827
|
+
"siteId"
|
|
828
|
+
];
|
|
829
|
+
readonly updateCustomerForBasket: readonly [
|
|
830
|
+
"organizationId",
|
|
831
|
+
"basketId",
|
|
832
|
+
"siteId",
|
|
833
|
+
"locale"
|
|
834
|
+
];
|
|
835
|
+
readonly updateCustomerForBasketRequired: readonly [
|
|
836
|
+
"organizationId",
|
|
837
|
+
"basketId",
|
|
838
|
+
"siteId"
|
|
839
|
+
];
|
|
840
|
+
readonly addGiftCertificateItemToBasket: readonly [
|
|
841
|
+
"organizationId",
|
|
842
|
+
"basketId",
|
|
843
|
+
"siteId",
|
|
844
|
+
"locale"
|
|
845
|
+
];
|
|
846
|
+
readonly addGiftCertificateItemToBasketRequired: readonly [
|
|
847
|
+
"organizationId",
|
|
848
|
+
"basketId",
|
|
849
|
+
"siteId"
|
|
850
|
+
];
|
|
851
|
+
readonly removeGiftCertificateItemFromBasket: readonly [
|
|
852
|
+
"organizationId",
|
|
853
|
+
"basketId",
|
|
854
|
+
"giftCertificateItemId",
|
|
855
|
+
"siteId",
|
|
856
|
+
"locale"
|
|
857
|
+
];
|
|
858
|
+
readonly removeGiftCertificateItemFromBasketRequired: readonly [
|
|
859
|
+
"organizationId",
|
|
860
|
+
"basketId",
|
|
861
|
+
"giftCertificateItemId",
|
|
862
|
+
"siteId"
|
|
863
|
+
];
|
|
864
|
+
readonly updateGiftCertificateItemInBasket: readonly [
|
|
865
|
+
"organizationId",
|
|
866
|
+
"basketId",
|
|
867
|
+
"giftCertificateItemId",
|
|
868
|
+
"siteId",
|
|
869
|
+
"locale"
|
|
870
|
+
];
|
|
871
|
+
readonly updateGiftCertificateItemInBasketRequired: readonly [
|
|
872
|
+
"organizationId",
|
|
873
|
+
"basketId",
|
|
874
|
+
"giftCertificateItemId",
|
|
875
|
+
"siteId"
|
|
876
|
+
];
|
|
877
|
+
readonly addItemToBasket: readonly [
|
|
878
|
+
"organizationId",
|
|
879
|
+
"basketId",
|
|
880
|
+
"siteId",
|
|
881
|
+
"locale"
|
|
882
|
+
];
|
|
883
|
+
readonly addItemToBasketRequired: readonly [
|
|
884
|
+
"organizationId",
|
|
885
|
+
"basketId",
|
|
886
|
+
"siteId"
|
|
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
|
+
];
|
|
900
|
+
readonly removeItemFromBasket: readonly [
|
|
901
|
+
"organizationId",
|
|
902
|
+
"basketId",
|
|
903
|
+
"itemId",
|
|
904
|
+
"siteId",
|
|
905
|
+
"locale"
|
|
906
|
+
];
|
|
907
|
+
readonly removeItemFromBasketRequired: readonly [
|
|
908
|
+
"organizationId",
|
|
909
|
+
"basketId",
|
|
910
|
+
"itemId",
|
|
911
|
+
"siteId"
|
|
912
|
+
];
|
|
913
|
+
readonly updateItemInBasket: readonly [
|
|
914
|
+
"organizationId",
|
|
915
|
+
"basketId",
|
|
916
|
+
"itemId",
|
|
917
|
+
"removeExternalTax",
|
|
918
|
+
"siteId",
|
|
919
|
+
"locale"
|
|
920
|
+
];
|
|
921
|
+
readonly updateItemInBasketRequired: readonly [
|
|
922
|
+
"organizationId",
|
|
923
|
+
"basketId",
|
|
924
|
+
"itemId",
|
|
925
|
+
"siteId"
|
|
926
|
+
];
|
|
927
|
+
readonly addTaxesForBasketItem: readonly [
|
|
928
|
+
"organizationId",
|
|
929
|
+
"basketId",
|
|
930
|
+
"itemId",
|
|
931
|
+
"siteId"
|
|
932
|
+
];
|
|
933
|
+
readonly addTaxesForBasketItemRequired: readonly [
|
|
934
|
+
"organizationId",
|
|
935
|
+
"basketId",
|
|
936
|
+
"itemId",
|
|
937
|
+
"siteId"
|
|
938
|
+
];
|
|
939
|
+
readonly addPaymentInstrumentToBasket: readonly [
|
|
940
|
+
"organizationId",
|
|
941
|
+
"basketId",
|
|
942
|
+
"siteId",
|
|
943
|
+
"locale"
|
|
944
|
+
];
|
|
945
|
+
readonly addPaymentInstrumentToBasketRequired: readonly [
|
|
946
|
+
"organizationId",
|
|
947
|
+
"basketId",
|
|
948
|
+
"siteId"
|
|
949
|
+
];
|
|
950
|
+
readonly removePaymentInstrumentFromBasket: readonly [
|
|
951
|
+
"organizationId",
|
|
952
|
+
"basketId",
|
|
953
|
+
"paymentInstrumentId",
|
|
954
|
+
"siteId",
|
|
955
|
+
"locale"
|
|
956
|
+
];
|
|
957
|
+
readonly removePaymentInstrumentFromBasketRequired: readonly [
|
|
958
|
+
"organizationId",
|
|
959
|
+
"basketId",
|
|
960
|
+
"paymentInstrumentId",
|
|
961
|
+
"siteId"
|
|
962
|
+
];
|
|
963
|
+
readonly updatePaymentInstrumentInBasket: readonly [
|
|
964
|
+
"organizationId",
|
|
965
|
+
"basketId",
|
|
966
|
+
"paymentInstrumentId",
|
|
967
|
+
"removeExternalTax",
|
|
968
|
+
"siteId",
|
|
969
|
+
"locale"
|
|
970
|
+
];
|
|
971
|
+
readonly updatePaymentInstrumentInBasketRequired: readonly [
|
|
972
|
+
"organizationId",
|
|
973
|
+
"basketId",
|
|
974
|
+
"paymentInstrumentId",
|
|
975
|
+
"siteId"
|
|
976
|
+
];
|
|
977
|
+
readonly getPaymentMethodsForBasket: readonly [
|
|
978
|
+
"organizationId",
|
|
979
|
+
"basketId",
|
|
980
|
+
"siteId",
|
|
981
|
+
"locale"
|
|
982
|
+
];
|
|
983
|
+
readonly getPaymentMethodsForBasketRequired: readonly [
|
|
984
|
+
"organizationId",
|
|
985
|
+
"basketId",
|
|
986
|
+
"siteId"
|
|
987
|
+
];
|
|
988
|
+
readonly addPriceAdjustmentToBasket: readonly [
|
|
989
|
+
"organizationId",
|
|
990
|
+
"basketId",
|
|
991
|
+
"siteId",
|
|
992
|
+
"locale"
|
|
993
|
+
];
|
|
994
|
+
readonly addPriceAdjustmentToBasketRequired: readonly [
|
|
995
|
+
"organizationId",
|
|
996
|
+
"basketId",
|
|
997
|
+
"siteId"
|
|
998
|
+
];
|
|
999
|
+
readonly removePriceAdjustmentFromBasket: readonly [
|
|
1000
|
+
"organizationId",
|
|
1001
|
+
"basketId",
|
|
1002
|
+
"priceAdjustmentId",
|
|
1003
|
+
"siteId",
|
|
1004
|
+
"locale"
|
|
1005
|
+
];
|
|
1006
|
+
readonly removePriceAdjustmentFromBasketRequired: readonly [
|
|
1007
|
+
"organizationId",
|
|
1008
|
+
"basketId",
|
|
1009
|
+
"priceAdjustmentId",
|
|
1010
|
+
"siteId"
|
|
1011
|
+
];
|
|
1012
|
+
readonly updatePriceAdjustmentInBasket: readonly [
|
|
1013
|
+
"organizationId",
|
|
1014
|
+
"basketId",
|
|
1015
|
+
"priceAdjustmentId",
|
|
1016
|
+
"siteId"
|
|
1017
|
+
];
|
|
1018
|
+
readonly updatePriceAdjustmentInBasketRequired: readonly [
|
|
1019
|
+
"organizationId",
|
|
1020
|
+
"basketId",
|
|
1021
|
+
"priceAdjustmentId",
|
|
1022
|
+
"siteId"
|
|
1023
|
+
];
|
|
1024
|
+
readonly getPriceBooksForBasket: readonly [
|
|
1025
|
+
"organizationId",
|
|
1026
|
+
"basketId",
|
|
1027
|
+
"siteId"
|
|
1028
|
+
];
|
|
1029
|
+
readonly getPriceBooksForBasketRequired: readonly [
|
|
1030
|
+
"organizationId",
|
|
1031
|
+
"basketId",
|
|
1032
|
+
"siteId"
|
|
1033
|
+
];
|
|
1034
|
+
readonly addPriceBooksToBasket: readonly [
|
|
1035
|
+
"organizationId",
|
|
1036
|
+
"basketId",
|
|
1037
|
+
"siteId"
|
|
1038
|
+
];
|
|
1039
|
+
readonly addPriceBooksToBasketRequired: readonly [
|
|
1040
|
+
"organizationId",
|
|
1041
|
+
"basketId",
|
|
1042
|
+
"siteId"
|
|
1043
|
+
];
|
|
1044
|
+
readonly createShipmentForBasket: readonly [
|
|
1045
|
+
"organizationId",
|
|
1046
|
+
"basketId",
|
|
1047
|
+
"siteId",
|
|
1048
|
+
"locale"
|
|
1049
|
+
];
|
|
1050
|
+
readonly createShipmentForBasketRequired: readonly [
|
|
1051
|
+
"organizationId",
|
|
1052
|
+
"basketId",
|
|
1053
|
+
"siteId"
|
|
1054
|
+
];
|
|
1055
|
+
readonly removeShipmentFromBasket: readonly [
|
|
1056
|
+
"organizationId",
|
|
1057
|
+
"basketId",
|
|
1058
|
+
"shipmentId",
|
|
1059
|
+
"siteId",
|
|
1060
|
+
"locale"
|
|
1061
|
+
];
|
|
1062
|
+
readonly removeShipmentFromBasketRequired: readonly [
|
|
1063
|
+
"organizationId",
|
|
1064
|
+
"basketId",
|
|
1065
|
+
"shipmentId",
|
|
1066
|
+
"siteId"
|
|
1067
|
+
];
|
|
1068
|
+
readonly updateShipmentForBasket: readonly [
|
|
1069
|
+
"organizationId",
|
|
1070
|
+
"basketId",
|
|
1071
|
+
"shipmentId",
|
|
1072
|
+
"siteId",
|
|
1073
|
+
"locale"
|
|
1074
|
+
];
|
|
1075
|
+
readonly updateShipmentForBasketRequired: readonly [
|
|
1076
|
+
"organizationId",
|
|
1077
|
+
"basketId",
|
|
1078
|
+
"shipmentId",
|
|
1079
|
+
"siteId"
|
|
1080
|
+
];
|
|
1081
|
+
readonly updateShippingAddressForShipment: readonly [
|
|
1082
|
+
"organizationId",
|
|
1083
|
+
"basketId",
|
|
1084
|
+
"shipmentId",
|
|
1085
|
+
"useAsBilling",
|
|
1086
|
+
"removeExternalTax",
|
|
1087
|
+
"siteId",
|
|
1088
|
+
"locale"
|
|
1089
|
+
];
|
|
1090
|
+
readonly updateShippingAddressForShipmentRequired: readonly [
|
|
1091
|
+
"organizationId",
|
|
1092
|
+
"basketId",
|
|
1093
|
+
"shipmentId",
|
|
1094
|
+
"siteId"
|
|
1095
|
+
];
|
|
1096
|
+
readonly updateShippingMethodForShipment: readonly [
|
|
1097
|
+
"organizationId",
|
|
1098
|
+
"basketId",
|
|
1099
|
+
"shipmentId",
|
|
1100
|
+
"siteId",
|
|
1101
|
+
"locale"
|
|
1102
|
+
];
|
|
1103
|
+
readonly updateShippingMethodForShipmentRequired: readonly [
|
|
1104
|
+
"organizationId",
|
|
1105
|
+
"basketId",
|
|
1106
|
+
"shipmentId",
|
|
1107
|
+
"siteId"
|
|
1108
|
+
];
|
|
1109
|
+
readonly getShippingMethodsForShipment: readonly [
|
|
1110
|
+
"organizationId",
|
|
1111
|
+
"basketId",
|
|
1112
|
+
"shipmentId",
|
|
1113
|
+
"siteId",
|
|
1114
|
+
"locale"
|
|
1115
|
+
];
|
|
1116
|
+
readonly getShippingMethodsForShipmentRequired: readonly [
|
|
1117
|
+
"organizationId",
|
|
1118
|
+
"basketId",
|
|
1119
|
+
"shipmentId",
|
|
1120
|
+
"siteId"
|
|
1121
|
+
];
|
|
1122
|
+
readonly updateAsStorefrontBasket: readonly [
|
|
1123
|
+
"organizationId",
|
|
1124
|
+
"basketId",
|
|
1125
|
+
"exchange",
|
|
1126
|
+
"siteId",
|
|
1127
|
+
"locale"
|
|
1128
|
+
];
|
|
1129
|
+
readonly updateAsStorefrontBasketRequired: readonly [
|
|
1130
|
+
"organizationId",
|
|
1131
|
+
"basketId",
|
|
1132
|
+
"siteId"
|
|
1133
|
+
];
|
|
1134
|
+
readonly getTaxesFromBasket: readonly [
|
|
1135
|
+
"organizationId",
|
|
1136
|
+
"basketId",
|
|
1137
|
+
"siteId"
|
|
1138
|
+
];
|
|
1139
|
+
readonly getTaxesFromBasketRequired: readonly [
|
|
1140
|
+
"organizationId",
|
|
1141
|
+
"basketId",
|
|
1142
|
+
"siteId"
|
|
1143
|
+
];
|
|
1144
|
+
readonly addTaxesForBasket: readonly [
|
|
1145
|
+
"organizationId",
|
|
1146
|
+
"basketId",
|
|
1147
|
+
"siteId"
|
|
1148
|
+
];
|
|
1149
|
+
readonly addTaxesForBasketRequired: readonly [
|
|
1150
|
+
"organizationId",
|
|
1151
|
+
"basketId",
|
|
1152
|
+
"siteId"
|
|
1153
|
+
];
|
|
1154
|
+
};
|
|
719
1155
|
/**
|
|
720
1156
|
* Creates a new basket.
|
|
721
1157
|
|
|
@@ -891,7 +1327,7 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
|
|
|
891
1327
|
};
|
|
892
1328
|
}>, rawResponse?: T): Promise<T extends true ? Response : Basket>;
|
|
893
1329
|
/**
|
|
894
|
-
* 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.
|
|
895
1331
|
|
|
896
1332
|
The following information is merged:
|
|
897
1333
|
- custom attributes on the basket and on all copied records
|
|
@@ -972,7 +1408,7 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
|
|
|
972
1408
|
};
|
|
973
1409
|
}>): Promise<Basket>;
|
|
974
1410
|
/**
|
|
975
|
-
* 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.
|
|
976
1412
|
|
|
977
1413
|
The following information is merged:
|
|
978
1414
|
- custom attributes on the basket and on all copied records
|
|
@@ -1182,6 +1618,7 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
|
|
|
1182
1618
|
* @param parameters - An object containing the parameters for this method.
|
|
1183
1619
|
* @param organizationId - An identifier for the organization the request is being made by.
|
|
1184
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.
|
|
1185
1622
|
* @param siteId -
|
|
1186
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.
|
|
1187
1624
|
Below are some valid examples:
|
|
@@ -1200,6 +1637,7 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
|
|
|
1200
1637
|
parameters?: CompositeParameters<{
|
|
1201
1638
|
organizationId: string;
|
|
1202
1639
|
basketId: string;
|
|
1640
|
+
removeExternalTax?: boolean;
|
|
1203
1641
|
siteId: string;
|
|
1204
1642
|
locale?: string;
|
|
1205
1643
|
} & {
|
|
@@ -1218,6 +1656,7 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
|
|
|
1218
1656
|
* @param parameters - An object containing the parameters for this method.
|
|
1219
1657
|
* @param organizationId - An identifier for the organization the request is being made by.
|
|
1220
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.
|
|
1221
1660
|
* @param siteId -
|
|
1222
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.
|
|
1223
1662
|
Below are some valid examples:
|
|
@@ -1236,6 +1675,7 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
|
|
|
1236
1675
|
parameters?: CompositeParameters<{
|
|
1237
1676
|
organizationId: string;
|
|
1238
1677
|
basketId: string;
|
|
1678
|
+
removeExternalTax?: boolean;
|
|
1239
1679
|
siteId: string;
|
|
1240
1680
|
locale?: string;
|
|
1241
1681
|
} & {
|
|
@@ -1324,9 +1764,7 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
|
|
|
1324
1764
|
* @param organizationId - An identifier for the organization the request is being made by.
|
|
1325
1765
|
* @param basketId - The ID of the basket to be modified.
|
|
1326
1766
|
* @param useAsShipping -
|
|
1327
|
-
* @param removeExternalTax -
|
|
1328
|
-
- true: (default) The basket's tax values are set to null and must be recalculated.
|
|
1329
|
-
- 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.
|
|
1330
1768
|
* @param siteId -
|
|
1331
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.
|
|
1332
1770
|
Below are some valid examples:
|
|
@@ -1365,9 +1803,7 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
|
|
|
1365
1803
|
* @param organizationId - An identifier for the organization the request is being made by.
|
|
1366
1804
|
* @param basketId - The ID of the basket to be modified.
|
|
1367
1805
|
* @param useAsShipping -
|
|
1368
|
-
* @param removeExternalTax -
|
|
1369
|
-
- true: (default) The basket's tax values are set to null and must be recalculated.
|
|
1370
|
-
- 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.
|
|
1371
1807
|
* @param siteId -
|
|
1372
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.
|
|
1373
1809
|
Below are some valid examples:
|
|
@@ -1956,6 +2392,146 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
|
|
|
1956
2392
|
};
|
|
1957
2393
|
body: Array<ProductItem>;
|
|
1958
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>;
|
|
1959
2535
|
/**
|
|
1960
2536
|
* Removes a product item from the basket.
|
|
1961
2537
|
*
|
|
@@ -2029,32 +2605,36 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
|
|
|
2029
2605
|
};
|
|
2030
2606
|
}>, rawResponse?: T): Promise<T extends true ? Response : Basket>;
|
|
2031
2607
|
/**
|
|
2032
|
-
* Updates an item in a basket. The
|
|
2033
|
-
|
|
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:
|
|
2034
2612
|
|
|
2035
|
-
- productId
|
|
2613
|
+
- `productId`: a valid product ID. The purpose of this
|
|
2036
2614
|
value is to exchange a variation of a variation product.
|
|
2037
|
-
- shipmentId
|
|
2615
|
+
- `shipmentId`: a valid shipment ID. The purpose of
|
|
2038
2616
|
this value is to move a product item to another shipment.
|
|
2039
|
-
- quantity
|
|
2617
|
+
- `quantity`: a number between 0 and 999. The purpose of
|
|
2040
2618
|
this value is to change quantity of the product item. If quantity is 0,
|
|
2041
2619
|
the product item is removed.
|
|
2042
|
-
- optionItems
|
|
2620
|
+
- `optionItems`/`optionValueId`: a valid option value
|
|
2043
2621
|
ID. The purpose of this value is to exchange an option value for an
|
|
2044
2622
|
option item of an option product.
|
|
2045
2623
|
This is only possible if the product item is an option product. To change
|
|
2046
2624
|
option values a collection of option items to be changed need to be
|
|
2047
2625
|
provided in property optionItems. Those
|
|
2048
2626
|
optionItems need to contain optionId
|
|
2049
|
-
and optionValueId
|
|
2050
|
-
for the option product that this product item represents. Otherwise
|
|
2051
|
-
InvalidProductOptionItemException or
|
|
2052
|
-
InvalidProductOptionValueItemException
|
|
2053
|
-
custom properties c_\<CUSTOM_NAME
|
|
2627
|
+
and `optionValueId`. The provided values must be valid
|
|
2628
|
+
for the option product that this product item represents. Otherwise,
|
|
2629
|
+
`InvalidProductOptionItemException` or
|
|
2630
|
+
`InvalidProductOptionValueItemException` is thrown.
|
|
2631
|
+
- custom properties `c_\<CUSTOM_NAME\>`: a
|
|
2054
2632
|
value corresponding to the type defined for custom attribute
|
|
2055
|
-
|
|
2633
|
+
`\<CUSTOM_NAME\>` of ProductLineItem. The purpose of this value is to
|
|
2056
2634
|
add or change the value of a custom attribute defined for
|
|
2057
2635
|
ProductLineItem.
|
|
2636
|
+
- `gift`: a boolean value that specifies whether the item is a gift
|
|
2637
|
+
- `giftMessage`: a message for the gift
|
|
2058
2638
|
*
|
|
2059
2639
|
* If you would like to get a raw Response object use the other updateItemInBasket function.
|
|
2060
2640
|
*
|
|
@@ -2063,9 +2643,7 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
|
|
|
2063
2643
|
* @param organizationId - An identifier for the organization the request is being made by.
|
|
2064
2644
|
* @param basketId - The ID of the basket to be modified.
|
|
2065
2645
|
* @param itemId - The ID of the item to be updated.
|
|
2066
|
-
* @param removeExternalTax -
|
|
2067
|
-
- true: (default) The tax values for the product item are set to null and must be recalculated.
|
|
2068
|
-
- 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.
|
|
2069
2647
|
* @param siteId -
|
|
2070
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.
|
|
2071
2649
|
Below are some valid examples:
|
|
@@ -2097,41 +2675,43 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
|
|
|
2097
2675
|
body: ProductItem;
|
|
2098
2676
|
}>): Promise<Basket>;
|
|
2099
2677
|
/**
|
|
2100
|
-
* Updates an item in a basket. The
|
|
2101
|
-
|
|
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:
|
|
2102
2682
|
|
|
2103
|
-
- productId
|
|
2683
|
+
- `productId`: a valid product ID. The purpose of this
|
|
2104
2684
|
value is to exchange a variation of a variation product.
|
|
2105
|
-
- shipmentId
|
|
2685
|
+
- `shipmentId`: a valid shipment ID. The purpose of
|
|
2106
2686
|
this value is to move a product item to another shipment.
|
|
2107
|
-
- quantity
|
|
2687
|
+
- `quantity`: a number between 0 and 999. The purpose of
|
|
2108
2688
|
this value is to change quantity of the product item. If quantity is 0,
|
|
2109
2689
|
the product item is removed.
|
|
2110
|
-
- optionItems
|
|
2690
|
+
- `optionItems`/`optionValueId`: a valid option value
|
|
2111
2691
|
ID. The purpose of this value is to exchange an option value for an
|
|
2112
2692
|
option item of an option product.
|
|
2113
2693
|
This is only possible if the product item is an option product. To change
|
|
2114
2694
|
option values a collection of option items to be changed need to be
|
|
2115
2695
|
provided in property optionItems. Those
|
|
2116
2696
|
optionItems need to contain optionId
|
|
2117
|
-
and optionValueId
|
|
2118
|
-
for the option product that this product item represents. Otherwise
|
|
2119
|
-
InvalidProductOptionItemException or
|
|
2120
|
-
InvalidProductOptionValueItemException
|
|
2121
|
-
custom properties c_\<CUSTOM_NAME
|
|
2697
|
+
and `optionValueId`. The provided values must be valid
|
|
2698
|
+
for the option product that this product item represents. Otherwise,
|
|
2699
|
+
`InvalidProductOptionItemException` or
|
|
2700
|
+
`InvalidProductOptionValueItemException` is thrown.
|
|
2701
|
+
- custom properties `c_\<CUSTOM_NAME\>`: a
|
|
2122
2702
|
value corresponding to the type defined for custom attribute
|
|
2123
|
-
|
|
2703
|
+
`\<CUSTOM_NAME\>` of ProductLineItem. The purpose of this value is to
|
|
2124
2704
|
add or change the value of a custom attribute defined for
|
|
2125
2705
|
ProductLineItem.
|
|
2706
|
+
- `gift`: a boolean value that specifies whether the item is a gift
|
|
2707
|
+
- `giftMessage`: a message for the gift
|
|
2126
2708
|
*
|
|
2127
2709
|
* @param options - An object containing the options for this method.
|
|
2128
2710
|
* @param parameters - An object containing the parameters for this method.
|
|
2129
2711
|
* @param organizationId - An identifier for the organization the request is being made by.
|
|
2130
2712
|
* @param basketId - The ID of the basket to be modified.
|
|
2131
2713
|
* @param itemId - The ID of the item to be updated.
|
|
2132
|
-
* @param removeExternalTax -
|
|
2133
|
-
- true: (default) The tax values for the product item are set to null and must be recalculated.
|
|
2134
|
-
- 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.
|
|
2135
2715
|
* @param siteId -
|
|
2136
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.
|
|
2137
2717
|
Below are some valid examples:
|
|
@@ -2378,9 +2958,7 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
|
|
|
2378
2958
|
* @param organizationId - An identifier for the organization the request is being made by.
|
|
2379
2959
|
* @param basketId - The ID of the basket to be modified.
|
|
2380
2960
|
* @param paymentInstrumentId -
|
|
2381
|
-
* @param removeExternalTax -
|
|
2382
|
-
- true: (default) The basket's tax values are set to null and must be recalculated.
|
|
2383
|
-
- 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.
|
|
2384
2962
|
* @param siteId -
|
|
2385
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.
|
|
2386
2964
|
Below are some valid examples:
|
|
@@ -2419,9 +2997,7 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
|
|
|
2419
2997
|
* @param organizationId - An identifier for the organization the request is being made by.
|
|
2420
2998
|
* @param basketId - The ID of the basket to be modified.
|
|
2421
2999
|
* @param paymentInstrumentId -
|
|
2422
|
-
* @param removeExternalTax -
|
|
2423
|
-
- true: (default) The basket's tax values are set to null and must be recalculated.
|
|
2424
|
-
- 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.
|
|
2425
3001
|
* @param siteId -
|
|
2426
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.
|
|
2427
3003
|
Below are some valid examples:
|
|
@@ -2737,7 +3313,7 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
|
|
|
2737
3313
|
body: PriceAdjustment;
|
|
2738
3314
|
}>, rawResponse?: T): Promise<T extends true ? Response : Basket>;
|
|
2739
3315
|
/**
|
|
2740
|
-
* 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.
|
|
2741
3317
|
*
|
|
2742
3318
|
* If you would like to get a raw Response object use the other getPriceBooksForBasket function.
|
|
2743
3319
|
*
|
|
@@ -2765,7 +3341,7 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
|
|
|
2765
3341
|
};
|
|
2766
3342
|
}>): Promise<PriceBookIds>;
|
|
2767
3343
|
/**
|
|
2768
|
-
* 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.
|
|
2769
3345
|
*
|
|
2770
3346
|
* @param options - An object containing the options for this method.
|
|
2771
3347
|
* @param parameters - An object containing the parameters for this method.
|
|
@@ -2791,7 +3367,7 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
|
|
|
2791
3367
|
};
|
|
2792
3368
|
}>, rawResponse?: T): Promise<T extends true ? Response : PriceBookIds>;
|
|
2793
3369
|
/**
|
|
2794
|
-
* 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.
|
|
2795
3371
|
*
|
|
2796
3372
|
* If you would like to get a raw Response object use the other addPriceBooksToBasket function.
|
|
2797
3373
|
*
|
|
@@ -2821,7 +3397,7 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
|
|
|
2821
3397
|
body: PriceBookIds;
|
|
2822
3398
|
}>): Promise<void>;
|
|
2823
3399
|
/**
|
|
2824
|
-
* 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.
|
|
2825
3401
|
*
|
|
2826
3402
|
* @param options - An object containing the options for this method.
|
|
2827
3403
|
* @param parameters - An object containing the parameters for this method.
|
|
@@ -3125,9 +3701,7 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
|
|
|
3125
3701
|
* @param basketId - The ID of the basket to be modified.
|
|
3126
3702
|
* @param shipmentId - The ID of the shipment to be modified.
|
|
3127
3703
|
* @param useAsBilling -
|
|
3128
|
-
* @param removeExternalTax -
|
|
3129
|
-
- true: (default) The basket's tax values are set to null and must be recalculated.
|
|
3130
|
-
- 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.
|
|
3131
3705
|
* @param siteId -
|
|
3132
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.
|
|
3133
3707
|
Below are some valid examples:
|
|
@@ -3168,9 +3742,7 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
|
|
|
3168
3742
|
* @param basketId - The ID of the basket to be modified.
|
|
3169
3743
|
* @param shipmentId - The ID of the shipment to be modified.
|
|
3170
3744
|
* @param useAsBilling -
|
|
3171
|
-
* @param removeExternalTax -
|
|
3172
|
-
- true: (default) The basket's tax values are set to null and must be recalculated.
|
|
3173
|
-
- 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.
|
|
3174
3746
|
* @param siteId -
|
|
3175
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.
|
|
3176
3748
|
Below are some valid examples:
|
|
@@ -3906,12 +4478,6 @@ declare namespace ShopperBasketsTypes {
|
|
|
3906
4478
|
} & {
|
|
3907
4479
|
[key: string]: any;
|
|
3908
4480
|
};
|
|
3909
|
-
type BasketsResult = {
|
|
3910
|
-
baskets: Array<Basket>;
|
|
3911
|
-
total: number;
|
|
3912
|
-
} & {
|
|
3913
|
-
[key: string]: any;
|
|
3914
|
-
};
|
|
3915
4481
|
type PriceAdjustmentRequest = {
|
|
3916
4482
|
discount?: DiscountRequest;
|
|
3917
4483
|
itemId?: string;
|
|
@@ -4255,6 +4821,8 @@ declare namespace ShopperBasketsTypes {
|
|
|
4255
4821
|
externalOrderStatus?: string;
|
|
4256
4822
|
giftCertificateItems?: Array<GiftCertificateItem>;
|
|
4257
4823
|
globalPartyId?: string;
|
|
4824
|
+
groupedTaxItems?: Array<GroupedTaxItem>;
|
|
4825
|
+
guest?: boolean;
|
|
4258
4826
|
lastModified?: any;
|
|
4259
4827
|
merchandizeTotalTax?: number;
|
|
4260
4828
|
notes?: SimpleLink;
|
|
@@ -4276,6 +4844,7 @@ declare namespace ShopperBasketsTypes {
|
|
|
4276
4844
|
siteId?: string;
|
|
4277
4845
|
sourceCode?: string;
|
|
4278
4846
|
status?: string;
|
|
4847
|
+
taxRoundedAtGroup?: boolean;
|
|
4279
4848
|
taxTotal?: number;
|
|
4280
4849
|
taxation?: string;
|
|
4281
4850
|
} & {
|
|
@@ -4370,8 +4939,8 @@ declare namespace ShopperBasketsTypes {
|
|
|
4370
4939
|
overrideExisting?: boolean;
|
|
4371
4940
|
createDestinationBasket?: boolean;
|
|
4372
4941
|
productItemMergeMode?: string;
|
|
4373
|
-
useAsShipping?: boolean;
|
|
4374
4942
|
removeExternalTax?: boolean;
|
|
4943
|
+
useAsShipping?: boolean;
|
|
4375
4944
|
useAsBilling?: boolean;
|
|
4376
4945
|
exchange?: boolean;
|
|
4377
4946
|
};
|
|
@@ -4402,12 +4971,11 @@ declare namespace ShopperBasketsTypes {
|
|
|
4402
4971
|
* ```
|
|
4403
4972
|
*
|
|
4404
4973
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
4405
|
-
* API Version: 2.0.
|
|
4974
|
+
* API Version: 2.0.9<br />
|
|
4406
4975
|
* Last Updated: <br />
|
|
4407
4976
|
* </span>
|
|
4408
|
-
|
|
4409
4977
|
*
|
|
4410
|
-
|
|
4978
|
+
*
|
|
4411
4979
|
*/
|
|
4412
4980
|
class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters & Record<string, unknown>> {
|
|
4413
4981
|
// baseUri is not required on ClientConfig, but we know that we provide one in the class constructor
|
|
@@ -4416,6 +4984,446 @@ declare namespace ShopperBasketsTypes {
|
|
|
4416
4984
|
};
|
|
4417
4985
|
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/checkout/shopper-baskets/{version}";
|
|
4418
4986
|
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
4987
|
+
static readonly paramKeys: {
|
|
4988
|
+
readonly createBasket: readonly [
|
|
4989
|
+
"organizationId",
|
|
4990
|
+
"taxMode",
|
|
4991
|
+
"temporary",
|
|
4992
|
+
"siteId",
|
|
4993
|
+
"locale"
|
|
4994
|
+
];
|
|
4995
|
+
readonly createBasketRequired: readonly [
|
|
4996
|
+
"organizationId",
|
|
4997
|
+
"siteId"
|
|
4998
|
+
];
|
|
4999
|
+
readonly transferBasket: readonly [
|
|
5000
|
+
"organizationId",
|
|
5001
|
+
"overrideExisting",
|
|
5002
|
+
"siteId",
|
|
5003
|
+
"locale"
|
|
5004
|
+
];
|
|
5005
|
+
readonly transferBasketRequired: readonly [
|
|
5006
|
+
"organizationId",
|
|
5007
|
+
"siteId"
|
|
5008
|
+
];
|
|
5009
|
+
readonly mergeBasket: readonly [
|
|
5010
|
+
"organizationId",
|
|
5011
|
+
"createDestinationBasket",
|
|
5012
|
+
"productItemMergeMode",
|
|
5013
|
+
"siteId",
|
|
5014
|
+
"locale"
|
|
5015
|
+
];
|
|
5016
|
+
readonly mergeBasketRequired: readonly [
|
|
5017
|
+
"organizationId",
|
|
5018
|
+
"siteId"
|
|
5019
|
+
];
|
|
5020
|
+
readonly deleteBasket: readonly [
|
|
5021
|
+
"organizationId",
|
|
5022
|
+
"basketId",
|
|
5023
|
+
"siteId"
|
|
5024
|
+
];
|
|
5025
|
+
readonly deleteBasketRequired: readonly [
|
|
5026
|
+
"organizationId",
|
|
5027
|
+
"basketId",
|
|
5028
|
+
"siteId"
|
|
5029
|
+
];
|
|
5030
|
+
readonly getBasket: readonly [
|
|
5031
|
+
"organizationId",
|
|
5032
|
+
"basketId",
|
|
5033
|
+
"siteId",
|
|
5034
|
+
"locale"
|
|
5035
|
+
];
|
|
5036
|
+
readonly getBasketRequired: readonly [
|
|
5037
|
+
"organizationId",
|
|
5038
|
+
"basketId",
|
|
5039
|
+
"siteId"
|
|
5040
|
+
];
|
|
5041
|
+
readonly updateBasket: readonly [
|
|
5042
|
+
"organizationId",
|
|
5043
|
+
"basketId",
|
|
5044
|
+
"removeExternalTax",
|
|
5045
|
+
"siteId",
|
|
5046
|
+
"locale"
|
|
5047
|
+
];
|
|
5048
|
+
readonly updateBasketRequired: readonly [
|
|
5049
|
+
"organizationId",
|
|
5050
|
+
"basketId",
|
|
5051
|
+
"siteId"
|
|
5052
|
+
];
|
|
5053
|
+
readonly updateAsAgentBasket: readonly [
|
|
5054
|
+
"organizationId",
|
|
5055
|
+
"basketId",
|
|
5056
|
+
"siteId",
|
|
5057
|
+
"locale"
|
|
5058
|
+
];
|
|
5059
|
+
readonly updateAsAgentBasketRequired: readonly [
|
|
5060
|
+
"organizationId",
|
|
5061
|
+
"basketId",
|
|
5062
|
+
"siteId"
|
|
5063
|
+
];
|
|
5064
|
+
readonly updateBillingAddressForBasket: readonly [
|
|
5065
|
+
"organizationId",
|
|
5066
|
+
"basketId",
|
|
5067
|
+
"useAsShipping",
|
|
5068
|
+
"removeExternalTax",
|
|
5069
|
+
"siteId",
|
|
5070
|
+
"locale"
|
|
5071
|
+
];
|
|
5072
|
+
readonly updateBillingAddressForBasketRequired: readonly [
|
|
5073
|
+
"organizationId",
|
|
5074
|
+
"basketId",
|
|
5075
|
+
"siteId"
|
|
5076
|
+
];
|
|
5077
|
+
readonly addCouponToBasket: readonly [
|
|
5078
|
+
"organizationId",
|
|
5079
|
+
"basketId",
|
|
5080
|
+
"siteId",
|
|
5081
|
+
"locale"
|
|
5082
|
+
];
|
|
5083
|
+
readonly addCouponToBasketRequired: readonly [
|
|
5084
|
+
"organizationId",
|
|
5085
|
+
"basketId",
|
|
5086
|
+
"siteId"
|
|
5087
|
+
];
|
|
5088
|
+
readonly removeCouponFromBasket: readonly [
|
|
5089
|
+
"organizationId",
|
|
5090
|
+
"basketId",
|
|
5091
|
+
"couponItemId",
|
|
5092
|
+
"siteId",
|
|
5093
|
+
"locale"
|
|
5094
|
+
];
|
|
5095
|
+
readonly removeCouponFromBasketRequired: readonly [
|
|
5096
|
+
"organizationId",
|
|
5097
|
+
"basketId",
|
|
5098
|
+
"couponItemId",
|
|
5099
|
+
"siteId"
|
|
5100
|
+
];
|
|
5101
|
+
readonly updateCustomerForBasket: readonly [
|
|
5102
|
+
"organizationId",
|
|
5103
|
+
"basketId",
|
|
5104
|
+
"siteId",
|
|
5105
|
+
"locale"
|
|
5106
|
+
];
|
|
5107
|
+
readonly updateCustomerForBasketRequired: readonly [
|
|
5108
|
+
"organizationId",
|
|
5109
|
+
"basketId",
|
|
5110
|
+
"siteId"
|
|
5111
|
+
];
|
|
5112
|
+
readonly addGiftCertificateItemToBasket: readonly [
|
|
5113
|
+
"organizationId",
|
|
5114
|
+
"basketId",
|
|
5115
|
+
"siteId",
|
|
5116
|
+
"locale"
|
|
5117
|
+
];
|
|
5118
|
+
readonly addGiftCertificateItemToBasketRequired: readonly [
|
|
5119
|
+
"organizationId",
|
|
5120
|
+
"basketId",
|
|
5121
|
+
"siteId"
|
|
5122
|
+
];
|
|
5123
|
+
readonly removeGiftCertificateItemFromBasket: readonly [
|
|
5124
|
+
"organizationId",
|
|
5125
|
+
"basketId",
|
|
5126
|
+
"giftCertificateItemId",
|
|
5127
|
+
"siteId",
|
|
5128
|
+
"locale"
|
|
5129
|
+
];
|
|
5130
|
+
readonly removeGiftCertificateItemFromBasketRequired: readonly [
|
|
5131
|
+
"organizationId",
|
|
5132
|
+
"basketId",
|
|
5133
|
+
"giftCertificateItemId",
|
|
5134
|
+
"siteId"
|
|
5135
|
+
];
|
|
5136
|
+
readonly updateGiftCertificateItemInBasket: readonly [
|
|
5137
|
+
"organizationId",
|
|
5138
|
+
"basketId",
|
|
5139
|
+
"giftCertificateItemId",
|
|
5140
|
+
"siteId",
|
|
5141
|
+
"locale"
|
|
5142
|
+
];
|
|
5143
|
+
readonly updateGiftCertificateItemInBasketRequired: readonly [
|
|
5144
|
+
"organizationId",
|
|
5145
|
+
"basketId",
|
|
5146
|
+
"giftCertificateItemId",
|
|
5147
|
+
"siteId"
|
|
5148
|
+
];
|
|
5149
|
+
readonly addItemToBasket: readonly [
|
|
5150
|
+
"organizationId",
|
|
5151
|
+
"basketId",
|
|
5152
|
+
"siteId",
|
|
5153
|
+
"locale"
|
|
5154
|
+
];
|
|
5155
|
+
readonly addItemToBasketRequired: readonly [
|
|
5156
|
+
"organizationId",
|
|
5157
|
+
"basketId",
|
|
5158
|
+
"siteId"
|
|
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
|
+
];
|
|
5172
|
+
readonly removeItemFromBasket: readonly [
|
|
5173
|
+
"organizationId",
|
|
5174
|
+
"basketId",
|
|
5175
|
+
"itemId",
|
|
5176
|
+
"siteId",
|
|
5177
|
+
"locale"
|
|
5178
|
+
];
|
|
5179
|
+
readonly removeItemFromBasketRequired: readonly [
|
|
5180
|
+
"organizationId",
|
|
5181
|
+
"basketId",
|
|
5182
|
+
"itemId",
|
|
5183
|
+
"siteId"
|
|
5184
|
+
];
|
|
5185
|
+
readonly updateItemInBasket: readonly [
|
|
5186
|
+
"organizationId",
|
|
5187
|
+
"basketId",
|
|
5188
|
+
"itemId",
|
|
5189
|
+
"removeExternalTax",
|
|
5190
|
+
"siteId",
|
|
5191
|
+
"locale"
|
|
5192
|
+
];
|
|
5193
|
+
readonly updateItemInBasketRequired: readonly [
|
|
5194
|
+
"organizationId",
|
|
5195
|
+
"basketId",
|
|
5196
|
+
"itemId",
|
|
5197
|
+
"siteId"
|
|
5198
|
+
];
|
|
5199
|
+
readonly addTaxesForBasketItem: readonly [
|
|
5200
|
+
"organizationId",
|
|
5201
|
+
"basketId",
|
|
5202
|
+
"itemId",
|
|
5203
|
+
"siteId"
|
|
5204
|
+
];
|
|
5205
|
+
readonly addTaxesForBasketItemRequired: readonly [
|
|
5206
|
+
"organizationId",
|
|
5207
|
+
"basketId",
|
|
5208
|
+
"itemId",
|
|
5209
|
+
"siteId"
|
|
5210
|
+
];
|
|
5211
|
+
readonly addPaymentInstrumentToBasket: readonly [
|
|
5212
|
+
"organizationId",
|
|
5213
|
+
"basketId",
|
|
5214
|
+
"siteId",
|
|
5215
|
+
"locale"
|
|
5216
|
+
];
|
|
5217
|
+
readonly addPaymentInstrumentToBasketRequired: readonly [
|
|
5218
|
+
"organizationId",
|
|
5219
|
+
"basketId",
|
|
5220
|
+
"siteId"
|
|
5221
|
+
];
|
|
5222
|
+
readonly removePaymentInstrumentFromBasket: readonly [
|
|
5223
|
+
"organizationId",
|
|
5224
|
+
"basketId",
|
|
5225
|
+
"paymentInstrumentId",
|
|
5226
|
+
"siteId",
|
|
5227
|
+
"locale"
|
|
5228
|
+
];
|
|
5229
|
+
readonly removePaymentInstrumentFromBasketRequired: readonly [
|
|
5230
|
+
"organizationId",
|
|
5231
|
+
"basketId",
|
|
5232
|
+
"paymentInstrumentId",
|
|
5233
|
+
"siteId"
|
|
5234
|
+
];
|
|
5235
|
+
readonly updatePaymentInstrumentInBasket: readonly [
|
|
5236
|
+
"organizationId",
|
|
5237
|
+
"basketId",
|
|
5238
|
+
"paymentInstrumentId",
|
|
5239
|
+
"removeExternalTax",
|
|
5240
|
+
"siteId",
|
|
5241
|
+
"locale"
|
|
5242
|
+
];
|
|
5243
|
+
readonly updatePaymentInstrumentInBasketRequired: readonly [
|
|
5244
|
+
"organizationId",
|
|
5245
|
+
"basketId",
|
|
5246
|
+
"paymentInstrumentId",
|
|
5247
|
+
"siteId"
|
|
5248
|
+
];
|
|
5249
|
+
readonly getPaymentMethodsForBasket: readonly [
|
|
5250
|
+
"organizationId",
|
|
5251
|
+
"basketId",
|
|
5252
|
+
"siteId",
|
|
5253
|
+
"locale"
|
|
5254
|
+
];
|
|
5255
|
+
readonly getPaymentMethodsForBasketRequired: readonly [
|
|
5256
|
+
"organizationId",
|
|
5257
|
+
"basketId",
|
|
5258
|
+
"siteId"
|
|
5259
|
+
];
|
|
5260
|
+
readonly addPriceAdjustmentToBasket: readonly [
|
|
5261
|
+
"organizationId",
|
|
5262
|
+
"basketId",
|
|
5263
|
+
"siteId",
|
|
5264
|
+
"locale"
|
|
5265
|
+
];
|
|
5266
|
+
readonly addPriceAdjustmentToBasketRequired: readonly [
|
|
5267
|
+
"organizationId",
|
|
5268
|
+
"basketId",
|
|
5269
|
+
"siteId"
|
|
5270
|
+
];
|
|
5271
|
+
readonly removePriceAdjustmentFromBasket: readonly [
|
|
5272
|
+
"organizationId",
|
|
5273
|
+
"basketId",
|
|
5274
|
+
"priceAdjustmentId",
|
|
5275
|
+
"siteId",
|
|
5276
|
+
"locale"
|
|
5277
|
+
];
|
|
5278
|
+
readonly removePriceAdjustmentFromBasketRequired: readonly [
|
|
5279
|
+
"organizationId",
|
|
5280
|
+
"basketId",
|
|
5281
|
+
"priceAdjustmentId",
|
|
5282
|
+
"siteId"
|
|
5283
|
+
];
|
|
5284
|
+
readonly updatePriceAdjustmentInBasket: readonly [
|
|
5285
|
+
"organizationId",
|
|
5286
|
+
"basketId",
|
|
5287
|
+
"priceAdjustmentId",
|
|
5288
|
+
"siteId"
|
|
5289
|
+
];
|
|
5290
|
+
readonly updatePriceAdjustmentInBasketRequired: readonly [
|
|
5291
|
+
"organizationId",
|
|
5292
|
+
"basketId",
|
|
5293
|
+
"priceAdjustmentId",
|
|
5294
|
+
"siteId"
|
|
5295
|
+
];
|
|
5296
|
+
readonly getPriceBooksForBasket: readonly [
|
|
5297
|
+
"organizationId",
|
|
5298
|
+
"basketId",
|
|
5299
|
+
"siteId"
|
|
5300
|
+
];
|
|
5301
|
+
readonly getPriceBooksForBasketRequired: readonly [
|
|
5302
|
+
"organizationId",
|
|
5303
|
+
"basketId",
|
|
5304
|
+
"siteId"
|
|
5305
|
+
];
|
|
5306
|
+
readonly addPriceBooksToBasket: readonly [
|
|
5307
|
+
"organizationId",
|
|
5308
|
+
"basketId",
|
|
5309
|
+
"siteId"
|
|
5310
|
+
];
|
|
5311
|
+
readonly addPriceBooksToBasketRequired: readonly [
|
|
5312
|
+
"organizationId",
|
|
5313
|
+
"basketId",
|
|
5314
|
+
"siteId"
|
|
5315
|
+
];
|
|
5316
|
+
readonly createShipmentForBasket: readonly [
|
|
5317
|
+
"organizationId",
|
|
5318
|
+
"basketId",
|
|
5319
|
+
"siteId",
|
|
5320
|
+
"locale"
|
|
5321
|
+
];
|
|
5322
|
+
readonly createShipmentForBasketRequired: readonly [
|
|
5323
|
+
"organizationId",
|
|
5324
|
+
"basketId",
|
|
5325
|
+
"siteId"
|
|
5326
|
+
];
|
|
5327
|
+
readonly removeShipmentFromBasket: readonly [
|
|
5328
|
+
"organizationId",
|
|
5329
|
+
"basketId",
|
|
5330
|
+
"shipmentId",
|
|
5331
|
+
"siteId",
|
|
5332
|
+
"locale"
|
|
5333
|
+
];
|
|
5334
|
+
readonly removeShipmentFromBasketRequired: readonly [
|
|
5335
|
+
"organizationId",
|
|
5336
|
+
"basketId",
|
|
5337
|
+
"shipmentId",
|
|
5338
|
+
"siteId"
|
|
5339
|
+
];
|
|
5340
|
+
readonly updateShipmentForBasket: readonly [
|
|
5341
|
+
"organizationId",
|
|
5342
|
+
"basketId",
|
|
5343
|
+
"shipmentId",
|
|
5344
|
+
"siteId",
|
|
5345
|
+
"locale"
|
|
5346
|
+
];
|
|
5347
|
+
readonly updateShipmentForBasketRequired: readonly [
|
|
5348
|
+
"organizationId",
|
|
5349
|
+
"basketId",
|
|
5350
|
+
"shipmentId",
|
|
5351
|
+
"siteId"
|
|
5352
|
+
];
|
|
5353
|
+
readonly updateShippingAddressForShipment: readonly [
|
|
5354
|
+
"organizationId",
|
|
5355
|
+
"basketId",
|
|
5356
|
+
"shipmentId",
|
|
5357
|
+
"useAsBilling",
|
|
5358
|
+
"removeExternalTax",
|
|
5359
|
+
"siteId",
|
|
5360
|
+
"locale"
|
|
5361
|
+
];
|
|
5362
|
+
readonly updateShippingAddressForShipmentRequired: readonly [
|
|
5363
|
+
"organizationId",
|
|
5364
|
+
"basketId",
|
|
5365
|
+
"shipmentId",
|
|
5366
|
+
"siteId"
|
|
5367
|
+
];
|
|
5368
|
+
readonly updateShippingMethodForShipment: readonly [
|
|
5369
|
+
"organizationId",
|
|
5370
|
+
"basketId",
|
|
5371
|
+
"shipmentId",
|
|
5372
|
+
"siteId",
|
|
5373
|
+
"locale"
|
|
5374
|
+
];
|
|
5375
|
+
readonly updateShippingMethodForShipmentRequired: readonly [
|
|
5376
|
+
"organizationId",
|
|
5377
|
+
"basketId",
|
|
5378
|
+
"shipmentId",
|
|
5379
|
+
"siteId"
|
|
5380
|
+
];
|
|
5381
|
+
readonly getShippingMethodsForShipment: readonly [
|
|
5382
|
+
"organizationId",
|
|
5383
|
+
"basketId",
|
|
5384
|
+
"shipmentId",
|
|
5385
|
+
"siteId",
|
|
5386
|
+
"locale"
|
|
5387
|
+
];
|
|
5388
|
+
readonly getShippingMethodsForShipmentRequired: readonly [
|
|
5389
|
+
"organizationId",
|
|
5390
|
+
"basketId",
|
|
5391
|
+
"shipmentId",
|
|
5392
|
+
"siteId"
|
|
5393
|
+
];
|
|
5394
|
+
readonly updateAsStorefrontBasket: readonly [
|
|
5395
|
+
"organizationId",
|
|
5396
|
+
"basketId",
|
|
5397
|
+
"exchange",
|
|
5398
|
+
"siteId",
|
|
5399
|
+
"locale"
|
|
5400
|
+
];
|
|
5401
|
+
readonly updateAsStorefrontBasketRequired: readonly [
|
|
5402
|
+
"organizationId",
|
|
5403
|
+
"basketId",
|
|
5404
|
+
"siteId"
|
|
5405
|
+
];
|
|
5406
|
+
readonly getTaxesFromBasket: readonly [
|
|
5407
|
+
"organizationId",
|
|
5408
|
+
"basketId",
|
|
5409
|
+
"siteId"
|
|
5410
|
+
];
|
|
5411
|
+
readonly getTaxesFromBasketRequired: readonly [
|
|
5412
|
+
"organizationId",
|
|
5413
|
+
"basketId",
|
|
5414
|
+
"siteId"
|
|
5415
|
+
];
|
|
5416
|
+
readonly addTaxesForBasket: readonly [
|
|
5417
|
+
"organizationId",
|
|
5418
|
+
"basketId",
|
|
5419
|
+
"siteId"
|
|
5420
|
+
];
|
|
5421
|
+
readonly addTaxesForBasketRequired: readonly [
|
|
5422
|
+
"organizationId",
|
|
5423
|
+
"basketId",
|
|
5424
|
+
"siteId"
|
|
5425
|
+
];
|
|
5426
|
+
};
|
|
4419
5427
|
/**
|
|
4420
5428
|
* Creates a new basket.
|
|
4421
5429
|
|
|
@@ -4591,7 +5599,7 @@ declare namespace ShopperBasketsTypes {
|
|
|
4591
5599
|
};
|
|
4592
5600
|
}>, rawResponse?: T): Promise<T extends true ? Response : Basket>;
|
|
4593
5601
|
/**
|
|
4594
|
-
* 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.
|
|
4595
5603
|
|
|
4596
5604
|
The following information is merged:
|
|
4597
5605
|
- custom attributes on the basket and on all copied records
|
|
@@ -4672,7 +5680,7 @@ declare namespace ShopperBasketsTypes {
|
|
|
4672
5680
|
};
|
|
4673
5681
|
}>): Promise<Basket>;
|
|
4674
5682
|
/**
|
|
4675
|
-
* 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.
|
|
4676
5684
|
|
|
4677
5685
|
The following information is merged:
|
|
4678
5686
|
- custom attributes on the basket and on all copied records
|
|
@@ -4882,6 +5890,7 @@ declare namespace ShopperBasketsTypes {
|
|
|
4882
5890
|
* @param parameters - An object containing the parameters for this method.
|
|
4883
5891
|
* @param organizationId - An identifier for the organization the request is being made by.
|
|
4884
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.
|
|
4885
5894
|
* @param siteId -
|
|
4886
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.
|
|
4887
5896
|
Below are some valid examples:
|
|
@@ -4900,6 +5909,7 @@ declare namespace ShopperBasketsTypes {
|
|
|
4900
5909
|
parameters?: CompositeParameters<{
|
|
4901
5910
|
organizationId: string;
|
|
4902
5911
|
basketId: string;
|
|
5912
|
+
removeExternalTax?: boolean;
|
|
4903
5913
|
siteId: string;
|
|
4904
5914
|
locale?: string;
|
|
4905
5915
|
} & {
|
|
@@ -4918,6 +5928,7 @@ declare namespace ShopperBasketsTypes {
|
|
|
4918
5928
|
* @param parameters - An object containing the parameters for this method.
|
|
4919
5929
|
* @param organizationId - An identifier for the organization the request is being made by.
|
|
4920
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.
|
|
4921
5932
|
* @param siteId -
|
|
4922
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.
|
|
4923
5934
|
Below are some valid examples:
|
|
@@ -4936,6 +5947,7 @@ declare namespace ShopperBasketsTypes {
|
|
|
4936
5947
|
parameters?: CompositeParameters<{
|
|
4937
5948
|
organizationId: string;
|
|
4938
5949
|
basketId: string;
|
|
5950
|
+
removeExternalTax?: boolean;
|
|
4939
5951
|
siteId: string;
|
|
4940
5952
|
locale?: string;
|
|
4941
5953
|
} & {
|
|
@@ -5024,9 +6036,7 @@ declare namespace ShopperBasketsTypes {
|
|
|
5024
6036
|
* @param organizationId - An identifier for the organization the request is being made by.
|
|
5025
6037
|
* @param basketId - The ID of the basket to be modified.
|
|
5026
6038
|
* @param useAsShipping -
|
|
5027
|
-
* @param removeExternalTax -
|
|
5028
|
-
- true: (default) The basket's tax values are set to null and must be recalculated.
|
|
5029
|
-
- 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.
|
|
5030
6040
|
* @param siteId -
|
|
5031
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.
|
|
5032
6042
|
Below are some valid examples:
|
|
@@ -5065,9 +6075,7 @@ declare namespace ShopperBasketsTypes {
|
|
|
5065
6075
|
* @param organizationId - An identifier for the organization the request is being made by.
|
|
5066
6076
|
* @param basketId - The ID of the basket to be modified.
|
|
5067
6077
|
* @param useAsShipping -
|
|
5068
|
-
* @param removeExternalTax -
|
|
5069
|
-
- true: (default) The basket's tax values are set to null and must be recalculated.
|
|
5070
|
-
- 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.
|
|
5071
6079
|
* @param siteId -
|
|
5072
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.
|
|
5073
6081
|
Below are some valid examples:
|
|
@@ -5656,6 +6664,146 @@ declare namespace ShopperBasketsTypes {
|
|
|
5656
6664
|
};
|
|
5657
6665
|
body: Array<ProductItem>;
|
|
5658
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>;
|
|
5659
6807
|
/**
|
|
5660
6808
|
* Removes a product item from the basket.
|
|
5661
6809
|
*
|
|
@@ -5729,32 +6877,36 @@ declare namespace ShopperBasketsTypes {
|
|
|
5729
6877
|
};
|
|
5730
6878
|
}>, rawResponse?: T): Promise<T extends true ? Response : Basket>;
|
|
5731
6879
|
/**
|
|
5732
|
-
* Updates an item in a basket. The
|
|
5733
|
-
|
|
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:
|
|
5734
6884
|
|
|
5735
|
-
- productId
|
|
6885
|
+
- `productId`: a valid product ID. The purpose of this
|
|
5736
6886
|
value is to exchange a variation of a variation product.
|
|
5737
|
-
- shipmentId
|
|
6887
|
+
- `shipmentId`: a valid shipment ID. The purpose of
|
|
5738
6888
|
this value is to move a product item to another shipment.
|
|
5739
|
-
- quantity
|
|
6889
|
+
- `quantity`: a number between 0 and 999. The purpose of
|
|
5740
6890
|
this value is to change quantity of the product item. If quantity is 0,
|
|
5741
6891
|
the product item is removed.
|
|
5742
|
-
- optionItems
|
|
6892
|
+
- `optionItems`/`optionValueId`: a valid option value
|
|
5743
6893
|
ID. The purpose of this value is to exchange an option value for an
|
|
5744
6894
|
option item of an option product.
|
|
5745
6895
|
This is only possible if the product item is an option product. To change
|
|
5746
6896
|
option values a collection of option items to be changed need to be
|
|
5747
6897
|
provided in property optionItems. Those
|
|
5748
6898
|
optionItems need to contain optionId
|
|
5749
|
-
and optionValueId
|
|
5750
|
-
for the option product that this product item represents. Otherwise
|
|
5751
|
-
InvalidProductOptionItemException or
|
|
5752
|
-
InvalidProductOptionValueItemException
|
|
5753
|
-
custom properties c_\<CUSTOM_NAME
|
|
6899
|
+
and `optionValueId`. The provided values must be valid
|
|
6900
|
+
for the option product that this product item represents. Otherwise,
|
|
6901
|
+
`InvalidProductOptionItemException` or
|
|
6902
|
+
`InvalidProductOptionValueItemException` is thrown.
|
|
6903
|
+
- custom properties `c_\<CUSTOM_NAME\>`: a
|
|
5754
6904
|
value corresponding to the type defined for custom attribute
|
|
5755
|
-
|
|
6905
|
+
`\<CUSTOM_NAME\>` of ProductLineItem. The purpose of this value is to
|
|
5756
6906
|
add or change the value of a custom attribute defined for
|
|
5757
6907
|
ProductLineItem.
|
|
6908
|
+
- `gift`: a boolean value that specifies whether the item is a gift
|
|
6909
|
+
- `giftMessage`: a message for the gift
|
|
5758
6910
|
*
|
|
5759
6911
|
* If you would like to get a raw Response object use the other updateItemInBasket function.
|
|
5760
6912
|
*
|
|
@@ -5763,9 +6915,7 @@ declare namespace ShopperBasketsTypes {
|
|
|
5763
6915
|
* @param organizationId - An identifier for the organization the request is being made by.
|
|
5764
6916
|
* @param basketId - The ID of the basket to be modified.
|
|
5765
6917
|
* @param itemId - The ID of the item to be updated.
|
|
5766
|
-
* @param removeExternalTax -
|
|
5767
|
-
- true: (default) The tax values for the product item are set to null and must be recalculated.
|
|
5768
|
-
- 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.
|
|
5769
6919
|
* @param siteId -
|
|
5770
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.
|
|
5771
6921
|
Below are some valid examples:
|
|
@@ -5797,41 +6947,43 @@ declare namespace ShopperBasketsTypes {
|
|
|
5797
6947
|
body: ProductItem;
|
|
5798
6948
|
}>): Promise<Basket>;
|
|
5799
6949
|
/**
|
|
5800
|
-
* Updates an item in a basket. The
|
|
5801
|
-
|
|
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:
|
|
5802
6954
|
|
|
5803
|
-
- productId
|
|
6955
|
+
- `productId`: a valid product ID. The purpose of this
|
|
5804
6956
|
value is to exchange a variation of a variation product.
|
|
5805
|
-
- shipmentId
|
|
6957
|
+
- `shipmentId`: a valid shipment ID. The purpose of
|
|
5806
6958
|
this value is to move a product item to another shipment.
|
|
5807
|
-
- quantity
|
|
6959
|
+
- `quantity`: a number between 0 and 999. The purpose of
|
|
5808
6960
|
this value is to change quantity of the product item. If quantity is 0,
|
|
5809
6961
|
the product item is removed.
|
|
5810
|
-
- optionItems
|
|
6962
|
+
- `optionItems`/`optionValueId`: a valid option value
|
|
5811
6963
|
ID. The purpose of this value is to exchange an option value for an
|
|
5812
6964
|
option item of an option product.
|
|
5813
6965
|
This is only possible if the product item is an option product. To change
|
|
5814
6966
|
option values a collection of option items to be changed need to be
|
|
5815
6967
|
provided in property optionItems. Those
|
|
5816
6968
|
optionItems need to contain optionId
|
|
5817
|
-
and optionValueId
|
|
5818
|
-
for the option product that this product item represents. Otherwise
|
|
5819
|
-
InvalidProductOptionItemException or
|
|
5820
|
-
InvalidProductOptionValueItemException
|
|
5821
|
-
custom properties c_\<CUSTOM_NAME
|
|
6969
|
+
and `optionValueId`. The provided values must be valid
|
|
6970
|
+
for the option product that this product item represents. Otherwise,
|
|
6971
|
+
`InvalidProductOptionItemException` or
|
|
6972
|
+
`InvalidProductOptionValueItemException` is thrown.
|
|
6973
|
+
- custom properties `c_\<CUSTOM_NAME\>`: a
|
|
5822
6974
|
value corresponding to the type defined for custom attribute
|
|
5823
|
-
|
|
6975
|
+
`\<CUSTOM_NAME\>` of ProductLineItem. The purpose of this value is to
|
|
5824
6976
|
add or change the value of a custom attribute defined for
|
|
5825
6977
|
ProductLineItem.
|
|
6978
|
+
- `gift`: a boolean value that specifies whether the item is a gift
|
|
6979
|
+
- `giftMessage`: a message for the gift
|
|
5826
6980
|
*
|
|
5827
6981
|
* @param options - An object containing the options for this method.
|
|
5828
6982
|
* @param parameters - An object containing the parameters for this method.
|
|
5829
6983
|
* @param organizationId - An identifier for the organization the request is being made by.
|
|
5830
6984
|
* @param basketId - The ID of the basket to be modified.
|
|
5831
6985
|
* @param itemId - The ID of the item to be updated.
|
|
5832
|
-
* @param removeExternalTax -
|
|
5833
|
-
- true: (default) The tax values for the product item are set to null and must be recalculated.
|
|
5834
|
-
- 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.
|
|
5835
6987
|
* @param siteId -
|
|
5836
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.
|
|
5837
6989
|
Below are some valid examples:
|
|
@@ -6078,9 +7230,7 @@ declare namespace ShopperBasketsTypes {
|
|
|
6078
7230
|
* @param organizationId - An identifier for the organization the request is being made by.
|
|
6079
7231
|
* @param basketId - The ID of the basket to be modified.
|
|
6080
7232
|
* @param paymentInstrumentId -
|
|
6081
|
-
* @param removeExternalTax -
|
|
6082
|
-
- true: (default) The basket's tax values are set to null and must be recalculated.
|
|
6083
|
-
- 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.
|
|
6084
7234
|
* @param siteId -
|
|
6085
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.
|
|
6086
7236
|
Below are some valid examples:
|
|
@@ -6119,9 +7269,7 @@ declare namespace ShopperBasketsTypes {
|
|
|
6119
7269
|
* @param organizationId - An identifier for the organization the request is being made by.
|
|
6120
7270
|
* @param basketId - The ID of the basket to be modified.
|
|
6121
7271
|
* @param paymentInstrumentId -
|
|
6122
|
-
* @param removeExternalTax -
|
|
6123
|
-
- true: (default) The basket's tax values are set to null and must be recalculated.
|
|
6124
|
-
- 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.
|
|
6125
7273
|
* @param siteId -
|
|
6126
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.
|
|
6127
7275
|
Below are some valid examples:
|
|
@@ -6437,7 +7585,7 @@ declare namespace ShopperBasketsTypes {
|
|
|
6437
7585
|
body: PriceAdjustment;
|
|
6438
7586
|
}>, rawResponse?: T): Promise<T extends true ? Response : Basket>;
|
|
6439
7587
|
/**
|
|
6440
|
-
* 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.
|
|
6441
7589
|
*
|
|
6442
7590
|
* If you would like to get a raw Response object use the other getPriceBooksForBasket function.
|
|
6443
7591
|
*
|
|
@@ -6465,7 +7613,7 @@ declare namespace ShopperBasketsTypes {
|
|
|
6465
7613
|
};
|
|
6466
7614
|
}>): Promise<PriceBookIds>;
|
|
6467
7615
|
/**
|
|
6468
|
-
* 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.
|
|
6469
7617
|
*
|
|
6470
7618
|
* @param options - An object containing the options for this method.
|
|
6471
7619
|
* @param parameters - An object containing the parameters for this method.
|
|
@@ -6491,7 +7639,7 @@ declare namespace ShopperBasketsTypes {
|
|
|
6491
7639
|
};
|
|
6492
7640
|
}>, rawResponse?: T): Promise<T extends true ? Response : PriceBookIds>;
|
|
6493
7641
|
/**
|
|
6494
|
-
* 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.
|
|
6495
7643
|
*
|
|
6496
7644
|
* If you would like to get a raw Response object use the other addPriceBooksToBasket function.
|
|
6497
7645
|
*
|
|
@@ -6521,7 +7669,7 @@ declare namespace ShopperBasketsTypes {
|
|
|
6521
7669
|
body: PriceBookIds;
|
|
6522
7670
|
}>): Promise<void>;
|
|
6523
7671
|
/**
|
|
6524
|
-
* 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.
|
|
6525
7673
|
*
|
|
6526
7674
|
* @param options - An object containing the options for this method.
|
|
6527
7675
|
* @param parameters - An object containing the parameters for this method.
|
|
@@ -6825,9 +7973,7 @@ declare namespace ShopperBasketsTypes {
|
|
|
6825
7973
|
* @param basketId - The ID of the basket to be modified.
|
|
6826
7974
|
* @param shipmentId - The ID of the shipment to be modified.
|
|
6827
7975
|
* @param useAsBilling -
|
|
6828
|
-
* @param removeExternalTax -
|
|
6829
|
-
- true: (default) The basket's tax values are set to null and must be recalculated.
|
|
6830
|
-
- 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.
|
|
6831
7977
|
* @param siteId -
|
|
6832
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.
|
|
6833
7979
|
Below are some valid examples:
|
|
@@ -6868,9 +8014,7 @@ declare namespace ShopperBasketsTypes {
|
|
|
6868
8014
|
* @param basketId - The ID of the basket to be modified.
|
|
6869
8015
|
* @param shipmentId - The ID of the shipment to be modified.
|
|
6870
8016
|
* @param useAsBilling -
|
|
6871
|
-
* @param removeExternalTax -
|
|
6872
|
-
- true: (default) The basket's tax values are set to null and must be recalculated.
|
|
6873
|
-
- 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.
|
|
6874
8018
|
* @param siteId -
|
|
6875
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.
|
|
6876
8020
|
Below are some valid examples:
|
|
@@ -7247,6 +8391,19 @@ type ShopperContext = {
|
|
|
7247
8391
|
[key: string]: any;
|
|
7248
8392
|
};
|
|
7249
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
|
+
};
|
|
7250
8407
|
} & {
|
|
7251
8408
|
[key: string]: any;
|
|
7252
8409
|
};
|
|
@@ -7365,6 +8522,7 @@ type ShopperContextsPathParameters = {
|
|
|
7365
8522
|
*/
|
|
7366
8523
|
type ShopperContextsQueryParameters = {
|
|
7367
8524
|
siteId?: string;
|
|
8525
|
+
evaluateContextWithClientIp?: boolean;
|
|
7368
8526
|
};
|
|
7369
8527
|
/**
|
|
7370
8528
|
* All parameters that are used by ShopperContexts.
|
|
@@ -7393,12 +8551,11 @@ type ShopperContextsParameters = ShopperContextsPathParameters & BaseUriParamete
|
|
|
7393
8551
|
* ```
|
|
7394
8552
|
*
|
|
7395
8553
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
7396
|
-
* API Version: 0.0.
|
|
8554
|
+
* API Version: 0.0.28<br />
|
|
7397
8555
|
* Last Updated: <br />
|
|
7398
8556
|
* </span>
|
|
7399
|
-
|
|
7400
8557
|
*
|
|
7401
|
-
|
|
8558
|
+
*
|
|
7402
8559
|
*/
|
|
7403
8560
|
declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters & Record<string, unknown>> {
|
|
7404
8561
|
// baseUri is not required on ClientConfig, but we know that we provide one in the class constructor
|
|
@@ -7407,6 +8564,46 @@ declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters
|
|
|
7407
8564
|
};
|
|
7408
8565
|
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/shopper/shopper-context/{version}";
|
|
7409
8566
|
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
8567
|
+
static readonly paramKeys: {
|
|
8568
|
+
readonly getShopperContext: readonly [
|
|
8569
|
+
"organizationId",
|
|
8570
|
+
"usid",
|
|
8571
|
+
"siteId"
|
|
8572
|
+
];
|
|
8573
|
+
readonly getShopperContextRequired: readonly [
|
|
8574
|
+
"organizationId",
|
|
8575
|
+
"usid"
|
|
8576
|
+
];
|
|
8577
|
+
readonly createShopperContext: readonly [
|
|
8578
|
+
"organizationId",
|
|
8579
|
+
"usid",
|
|
8580
|
+
"siteId",
|
|
8581
|
+
"evaluateContextWithClientIp"
|
|
8582
|
+
];
|
|
8583
|
+
readonly createShopperContextRequired: readonly [
|
|
8584
|
+
"organizationId",
|
|
8585
|
+
"usid"
|
|
8586
|
+
];
|
|
8587
|
+
readonly deleteShopperContext: readonly [
|
|
8588
|
+
"organizationId",
|
|
8589
|
+
"usid",
|
|
8590
|
+
"siteId"
|
|
8591
|
+
];
|
|
8592
|
+
readonly deleteShopperContextRequired: readonly [
|
|
8593
|
+
"organizationId",
|
|
8594
|
+
"usid"
|
|
8595
|
+
];
|
|
8596
|
+
readonly updateShopperContext: readonly [
|
|
8597
|
+
"organizationId",
|
|
8598
|
+
"usid",
|
|
8599
|
+
"siteId",
|
|
8600
|
+
"evaluateContextWithClientIp"
|
|
8601
|
+
];
|
|
8602
|
+
readonly updateShopperContextRequired: readonly [
|
|
8603
|
+
"organizationId",
|
|
8604
|
+
"usid"
|
|
8605
|
+
];
|
|
8606
|
+
};
|
|
7410
8607
|
/**
|
|
7411
8608
|
* Gets the shopper's context based on the shopperJWT.
|
|
7412
8609
|
*
|
|
@@ -7416,7 +8613,7 @@ declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters
|
|
|
7416
8613
|
* @param parameters - An object containing the parameters for this method.
|
|
7417
8614
|
* @param organizationId -
|
|
7418
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.
|
|
7419
|
-
* @param siteId - The
|
|
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`.
|
|
7420
8617
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
7421
8618
|
* sent with this request.
|
|
7422
8619
|
*
|
|
@@ -7442,7 +8639,7 @@ declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters
|
|
|
7442
8639
|
* @param parameters - An object containing the parameters for this method.
|
|
7443
8640
|
* @param organizationId -
|
|
7444
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.
|
|
7445
|
-
* @param siteId - The
|
|
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`.
|
|
7446
8643
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
7447
8644
|
* sent with this request.
|
|
7448
8645
|
* @param rawResponse - Set to true to return entire Response object instead of DTO.
|
|
@@ -7470,7 +8667,14 @@ declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters
|
|
|
7470
8667
|
* @param parameters - An object containing the parameters for this method.
|
|
7471
8668
|
* @param organizationId -
|
|
7472
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.
|
|
7473
|
-
* @param siteId - The
|
|
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
|
+
|
|
7474
8678
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
7475
8679
|
* sent with this request.
|
|
7476
8680
|
* @param body - The data to send as the request body.
|
|
@@ -7483,6 +8687,7 @@ declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters
|
|
|
7483
8687
|
organizationId: string;
|
|
7484
8688
|
usid: string;
|
|
7485
8689
|
siteId?: string;
|
|
8690
|
+
evaluateContextWithClientIp?: boolean;
|
|
7486
8691
|
} & {
|
|
7487
8692
|
[key in `c_${string}`]: any;
|
|
7488
8693
|
}, ConfigParameters>;
|
|
@@ -7498,7 +8703,14 @@ declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters
|
|
|
7498
8703
|
* @param parameters - An object containing the parameters for this method.
|
|
7499
8704
|
* @param organizationId -
|
|
7500
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.
|
|
7501
|
-
* @param siteId - The
|
|
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
|
+
|
|
7502
8714
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
7503
8715
|
* sent with this request.
|
|
7504
8716
|
* @param body - The data to send as the request body.
|
|
@@ -7511,6 +8723,7 @@ declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters
|
|
|
7511
8723
|
organizationId: string;
|
|
7512
8724
|
usid: string;
|
|
7513
8725
|
siteId?: string;
|
|
8726
|
+
evaluateContextWithClientIp?: boolean;
|
|
7514
8727
|
} & {
|
|
7515
8728
|
[key in `c_${string}`]: any;
|
|
7516
8729
|
}, ConfigParameters>;
|
|
@@ -7528,7 +8741,7 @@ declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters
|
|
|
7528
8741
|
* @param parameters - An object containing the parameters for this method.
|
|
7529
8742
|
* @param organizationId -
|
|
7530
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.
|
|
7531
|
-
* @param siteId - The
|
|
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`.
|
|
7532
8745
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
7533
8746
|
* sent with this request.
|
|
7534
8747
|
*
|
|
@@ -7554,7 +8767,7 @@ declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters
|
|
|
7554
8767
|
* @param parameters - An object containing the parameters for this method.
|
|
7555
8768
|
* @param organizationId -
|
|
7556
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.
|
|
7557
|
-
* @param siteId - The
|
|
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`.
|
|
7558
8771
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
7559
8772
|
* sent with this request.
|
|
7560
8773
|
* @param rawResponse - Set to true to return entire Response object instead of DTO.
|
|
@@ -7582,7 +8795,14 @@ declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters
|
|
|
7582
8795
|
* @param parameters - An object containing the parameters for this method.
|
|
7583
8796
|
* @param organizationId -
|
|
7584
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.
|
|
7585
|
-
* @param siteId - The
|
|
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
|
+
|
|
7586
8806
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
7587
8807
|
* sent with this request.
|
|
7588
8808
|
* @param body - The data to send as the request body.
|
|
@@ -7595,6 +8815,7 @@ declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters
|
|
|
7595
8815
|
organizationId: string;
|
|
7596
8816
|
usid: string;
|
|
7597
8817
|
siteId?: string;
|
|
8818
|
+
evaluateContextWithClientIp?: boolean;
|
|
7598
8819
|
} & {
|
|
7599
8820
|
[key in `c_${string}`]: any;
|
|
7600
8821
|
}, ConfigParameters>;
|
|
@@ -7610,7 +8831,14 @@ declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters
|
|
|
7610
8831
|
* @param parameters - An object containing the parameters for this method.
|
|
7611
8832
|
* @param organizationId -
|
|
7612
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.
|
|
7613
|
-
* @param siteId - The
|
|
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
|
+
|
|
7614
8842
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
7615
8843
|
* sent with this request.
|
|
7616
8844
|
* @param body - The data to send as the request body.
|
|
@@ -7623,6 +8851,7 @@ declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters
|
|
|
7623
8851
|
organizationId: string;
|
|
7624
8852
|
usid: string;
|
|
7625
8853
|
siteId?: string;
|
|
8854
|
+
evaluateContextWithClientIp?: boolean;
|
|
7626
8855
|
} & {
|
|
7627
8856
|
[key in `c_${string}`]: any;
|
|
7628
8857
|
}, ConfigParameters>;
|
|
@@ -7734,6 +8963,19 @@ declare namespace ShopperContextsTypes {
|
|
|
7734
8963
|
[key: string]: any;
|
|
7735
8964
|
};
|
|
7736
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
|
+
};
|
|
7737
8979
|
} & {
|
|
7738
8980
|
[key: string]: any;
|
|
7739
8981
|
};
|
|
@@ -8007,6 +9249,7 @@ declare namespace ShopperContextsTypes {
|
|
|
8007
9249
|
*/
|
|
8008
9250
|
type ShopperContextsQueryParameters = {
|
|
8009
9251
|
siteId?: string;
|
|
9252
|
+
evaluateContextWithClientIp?: boolean;
|
|
8010
9253
|
};
|
|
8011
9254
|
/**
|
|
8012
9255
|
* All parameters that are used by ShopperContexts.
|
|
@@ -8035,12 +9278,11 @@ declare namespace ShopperContextsTypes {
|
|
|
8035
9278
|
* ```
|
|
8036
9279
|
*
|
|
8037
9280
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
8038
|
-
* API Version: 0.0.
|
|
9281
|
+
* API Version: 0.0.28<br />
|
|
8039
9282
|
* Last Updated: <br />
|
|
8040
9283
|
* </span>
|
|
8041
|
-
|
|
8042
9284
|
*
|
|
8043
|
-
|
|
9285
|
+
*
|
|
8044
9286
|
*/
|
|
8045
9287
|
class ShopperContexts<ConfigParameters extends ShopperContextsParameters & Record<string, unknown>> {
|
|
8046
9288
|
// baseUri is not required on ClientConfig, but we know that we provide one in the class constructor
|
|
@@ -8049,6 +9291,46 @@ declare namespace ShopperContextsTypes {
|
|
|
8049
9291
|
};
|
|
8050
9292
|
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/shopper/shopper-context/{version}";
|
|
8051
9293
|
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
9294
|
+
static readonly paramKeys: {
|
|
9295
|
+
readonly getShopperContext: readonly [
|
|
9296
|
+
"organizationId",
|
|
9297
|
+
"usid",
|
|
9298
|
+
"siteId"
|
|
9299
|
+
];
|
|
9300
|
+
readonly getShopperContextRequired: readonly [
|
|
9301
|
+
"organizationId",
|
|
9302
|
+
"usid"
|
|
9303
|
+
];
|
|
9304
|
+
readonly createShopperContext: readonly [
|
|
9305
|
+
"organizationId",
|
|
9306
|
+
"usid",
|
|
9307
|
+
"siteId",
|
|
9308
|
+
"evaluateContextWithClientIp"
|
|
9309
|
+
];
|
|
9310
|
+
readonly createShopperContextRequired: readonly [
|
|
9311
|
+
"organizationId",
|
|
9312
|
+
"usid"
|
|
9313
|
+
];
|
|
9314
|
+
readonly deleteShopperContext: readonly [
|
|
9315
|
+
"organizationId",
|
|
9316
|
+
"usid",
|
|
9317
|
+
"siteId"
|
|
9318
|
+
];
|
|
9319
|
+
readonly deleteShopperContextRequired: readonly [
|
|
9320
|
+
"organizationId",
|
|
9321
|
+
"usid"
|
|
9322
|
+
];
|
|
9323
|
+
readonly updateShopperContext: readonly [
|
|
9324
|
+
"organizationId",
|
|
9325
|
+
"usid",
|
|
9326
|
+
"siteId",
|
|
9327
|
+
"evaluateContextWithClientIp"
|
|
9328
|
+
];
|
|
9329
|
+
readonly updateShopperContextRequired: readonly [
|
|
9330
|
+
"organizationId",
|
|
9331
|
+
"usid"
|
|
9332
|
+
];
|
|
9333
|
+
};
|
|
8052
9334
|
/**
|
|
8053
9335
|
* Gets the shopper's context based on the shopperJWT.
|
|
8054
9336
|
*
|
|
@@ -8058,7 +9340,7 @@ declare namespace ShopperContextsTypes {
|
|
|
8058
9340
|
* @param parameters - An object containing the parameters for this method.
|
|
8059
9341
|
* @param organizationId -
|
|
8060
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.
|
|
8061
|
-
* @param siteId - The
|
|
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`.
|
|
8062
9344
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
8063
9345
|
* sent with this request.
|
|
8064
9346
|
*
|
|
@@ -8084,7 +9366,7 @@ declare namespace ShopperContextsTypes {
|
|
|
8084
9366
|
* @param parameters - An object containing the parameters for this method.
|
|
8085
9367
|
* @param organizationId -
|
|
8086
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.
|
|
8087
|
-
* @param siteId - The
|
|
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`.
|
|
8088
9370
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
8089
9371
|
* sent with this request.
|
|
8090
9372
|
* @param rawResponse - Set to true to return entire Response object instead of DTO.
|
|
@@ -8112,7 +9394,14 @@ declare namespace ShopperContextsTypes {
|
|
|
8112
9394
|
* @param parameters - An object containing the parameters for this method.
|
|
8113
9395
|
* @param organizationId -
|
|
8114
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.
|
|
8115
|
-
* @param siteId - The
|
|
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
|
+
|
|
8116
9405
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
8117
9406
|
* sent with this request.
|
|
8118
9407
|
* @param body - The data to send as the request body.
|
|
@@ -8125,6 +9414,7 @@ declare namespace ShopperContextsTypes {
|
|
|
8125
9414
|
organizationId: string;
|
|
8126
9415
|
usid: string;
|
|
8127
9416
|
siteId?: string;
|
|
9417
|
+
evaluateContextWithClientIp?: boolean;
|
|
8128
9418
|
} & {
|
|
8129
9419
|
[key in `c_${string}`]: any;
|
|
8130
9420
|
}, ConfigParameters>;
|
|
@@ -8140,7 +9430,14 @@ declare namespace ShopperContextsTypes {
|
|
|
8140
9430
|
* @param parameters - An object containing the parameters for this method.
|
|
8141
9431
|
* @param organizationId -
|
|
8142
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.
|
|
8143
|
-
* @param siteId - The
|
|
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
|
+
|
|
8144
9441
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
8145
9442
|
* sent with this request.
|
|
8146
9443
|
* @param body - The data to send as the request body.
|
|
@@ -8153,6 +9450,7 @@ declare namespace ShopperContextsTypes {
|
|
|
8153
9450
|
organizationId: string;
|
|
8154
9451
|
usid: string;
|
|
8155
9452
|
siteId?: string;
|
|
9453
|
+
evaluateContextWithClientIp?: boolean;
|
|
8156
9454
|
} & {
|
|
8157
9455
|
[key in `c_${string}`]: any;
|
|
8158
9456
|
}, ConfigParameters>;
|
|
@@ -8170,7 +9468,7 @@ declare namespace ShopperContextsTypes {
|
|
|
8170
9468
|
* @param parameters - An object containing the parameters for this method.
|
|
8171
9469
|
* @param organizationId -
|
|
8172
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.
|
|
8173
|
-
* @param siteId - The
|
|
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`.
|
|
8174
9472
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
8175
9473
|
* sent with this request.
|
|
8176
9474
|
*
|
|
@@ -8196,7 +9494,7 @@ declare namespace ShopperContextsTypes {
|
|
|
8196
9494
|
* @param parameters - An object containing the parameters for this method.
|
|
8197
9495
|
* @param organizationId -
|
|
8198
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.
|
|
8199
|
-
* @param siteId - The
|
|
9497
|
+
* @param siteId - The identifier of the site to which the request is being sent. With B2C Commerce release 24.5, all new implementations of Shopper Context require the `siteId` query parameter to be passed. Existing customers with Shopper Context implementations should start including `siteId` going forward. Starting July 31 2024, `siteId` will be required for all customers, and a bad request response code will be returned for requests without a `siteId`.
|
|
8200
9498
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
8201
9499
|
* sent with this request.
|
|
8202
9500
|
* @param rawResponse - Set to true to return entire Response object instead of DTO.
|
|
@@ -8224,7 +9522,14 @@ declare namespace ShopperContextsTypes {
|
|
|
8224
9522
|
* @param parameters - An object containing the parameters for this method.
|
|
8225
9523
|
* @param organizationId -
|
|
8226
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.
|
|
8227
|
-
* @param siteId - The
|
|
9525
|
+
* @param siteId - The identifier of the site to which the request is being sent. With B2C Commerce release 24.5, all new implementations of Shopper Context require the `siteId` query parameter to be passed. Existing customers with Shopper Context implementations should start including `siteId` going forward. Starting July 31 2024, `siteId` will be required for all customers, and a bad request response code will be returned for requests without a `siteId`.
|
|
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
|
+
|
|
8228
9533
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
8229
9534
|
* sent with this request.
|
|
8230
9535
|
* @param body - The data to send as the request body.
|
|
@@ -8237,6 +9542,7 @@ declare namespace ShopperContextsTypes {
|
|
|
8237
9542
|
organizationId: string;
|
|
8238
9543
|
usid: string;
|
|
8239
9544
|
siteId?: string;
|
|
9545
|
+
evaluateContextWithClientIp?: boolean;
|
|
8240
9546
|
} & {
|
|
8241
9547
|
[key in `c_${string}`]: any;
|
|
8242
9548
|
}, ConfigParameters>;
|
|
@@ -8252,7 +9558,14 @@ declare namespace ShopperContextsTypes {
|
|
|
8252
9558
|
* @param parameters - An object containing the parameters for this method.
|
|
8253
9559
|
* @param organizationId -
|
|
8254
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.
|
|
8255
|
-
* @param siteId - The
|
|
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
|
+
|
|
8256
9569
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
8257
9570
|
* sent with this request.
|
|
8258
9571
|
* @param body - The data to send as the request body.
|
|
@@ -8265,6 +9578,7 @@ declare namespace ShopperContextsTypes {
|
|
|
8265
9578
|
organizationId: string;
|
|
8266
9579
|
usid: string;
|
|
8267
9580
|
siteId?: string;
|
|
9581
|
+
evaluateContextWithClientIp?: boolean;
|
|
8268
9582
|
} & {
|
|
8269
9583
|
[key in `c_${string}`]: any;
|
|
8270
9584
|
}, ConfigParameters>;
|
|
@@ -8357,7 +9671,7 @@ type PublicProductListResult = {
|
|
|
8357
9671
|
} & {
|
|
8358
9672
|
[key: string]: any;
|
|
8359
9673
|
};
|
|
8360
|
-
type BasketsResult
|
|
9674
|
+
type BasketsResult = {
|
|
8361
9675
|
baskets?: Array<Basket>;
|
|
8362
9676
|
total: number;
|
|
8363
9677
|
} & {
|
|
@@ -9264,12 +10578,11 @@ type ShopperCustomersParameters = ShopperCustomersPathParameters & BaseUriParame
|
|
|
9264
10578
|
* ```
|
|
9265
10579
|
*
|
|
9266
10580
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
9267
|
-
* API Version: 0.0.
|
|
10581
|
+
* API Version: 0.0.49<br />
|
|
9268
10582
|
* Last Updated: <br />
|
|
9269
10583
|
* </span>
|
|
9270
|
-
|
|
9271
10584
|
*
|
|
9272
|
-
|
|
10585
|
+
*
|
|
9273
10586
|
*/
|
|
9274
10587
|
declare class ShopperCustomers<ConfigParameters extends ShopperCustomersParameters & Record<string, unknown>> {
|
|
9275
10588
|
// baseUri is not required on ClientConfig, but we know that we provide one in the class constructor
|
|
@@ -9278,6 +10591,331 @@ declare class ShopperCustomers<ConfigParameters extends ShopperCustomersParamete
|
|
|
9278
10591
|
};
|
|
9279
10592
|
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/customer/shopper-customers/{version}";
|
|
9280
10593
|
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
10594
|
+
static readonly paramKeys: {
|
|
10595
|
+
readonly registerCustomer: readonly [
|
|
10596
|
+
"organizationId",
|
|
10597
|
+
"siteId"
|
|
10598
|
+
];
|
|
10599
|
+
readonly registerCustomerRequired: readonly [
|
|
10600
|
+
"organizationId",
|
|
10601
|
+
"siteId"
|
|
10602
|
+
];
|
|
10603
|
+
readonly resetPassword: readonly [
|
|
10604
|
+
"organizationId",
|
|
10605
|
+
"siteId"
|
|
10606
|
+
];
|
|
10607
|
+
readonly resetPasswordRequired: readonly [
|
|
10608
|
+
"organizationId",
|
|
10609
|
+
"siteId"
|
|
10610
|
+
];
|
|
10611
|
+
readonly getResetPasswordToken: readonly [
|
|
10612
|
+
"organizationId",
|
|
10613
|
+
"siteId"
|
|
10614
|
+
];
|
|
10615
|
+
readonly getResetPasswordTokenRequired: readonly [
|
|
10616
|
+
"organizationId",
|
|
10617
|
+
"siteId"
|
|
10618
|
+
];
|
|
10619
|
+
readonly registerExternalProfile: readonly [
|
|
10620
|
+
"organizationId",
|
|
10621
|
+
"siteId"
|
|
10622
|
+
];
|
|
10623
|
+
readonly registerExternalProfileRequired: readonly [
|
|
10624
|
+
"organizationId",
|
|
10625
|
+
"siteId"
|
|
10626
|
+
];
|
|
10627
|
+
readonly getExternalProfile: readonly [
|
|
10628
|
+
"organizationId",
|
|
10629
|
+
"externalId",
|
|
10630
|
+
"authenticationProviderId",
|
|
10631
|
+
"siteId"
|
|
10632
|
+
];
|
|
10633
|
+
readonly getExternalProfileRequired: readonly [
|
|
10634
|
+
"organizationId",
|
|
10635
|
+
"externalId",
|
|
10636
|
+
"authenticationProviderId",
|
|
10637
|
+
"siteId"
|
|
10638
|
+
];
|
|
10639
|
+
readonly getCustomer: readonly [
|
|
10640
|
+
"organizationId",
|
|
10641
|
+
"customerId",
|
|
10642
|
+
"siteId"
|
|
10643
|
+
];
|
|
10644
|
+
readonly getCustomerRequired: readonly [
|
|
10645
|
+
"organizationId",
|
|
10646
|
+
"customerId",
|
|
10647
|
+
"siteId"
|
|
10648
|
+
];
|
|
10649
|
+
readonly updateCustomer: readonly [
|
|
10650
|
+
"organizationId",
|
|
10651
|
+
"customerId",
|
|
10652
|
+
"siteId"
|
|
10653
|
+
];
|
|
10654
|
+
readonly updateCustomerRequired: readonly [
|
|
10655
|
+
"organizationId",
|
|
10656
|
+
"customerId",
|
|
10657
|
+
"siteId"
|
|
10658
|
+
];
|
|
10659
|
+
readonly createCustomerAddress: readonly [
|
|
10660
|
+
"organizationId",
|
|
10661
|
+
"customerId",
|
|
10662
|
+
"siteId"
|
|
10663
|
+
];
|
|
10664
|
+
readonly createCustomerAddressRequired: readonly [
|
|
10665
|
+
"organizationId",
|
|
10666
|
+
"customerId",
|
|
10667
|
+
"siteId"
|
|
10668
|
+
];
|
|
10669
|
+
readonly getCustomerAddress: readonly [
|
|
10670
|
+
"organizationId",
|
|
10671
|
+
"customerId",
|
|
10672
|
+
"addressName",
|
|
10673
|
+
"siteId"
|
|
10674
|
+
];
|
|
10675
|
+
readonly getCustomerAddressRequired: readonly [
|
|
10676
|
+
"organizationId",
|
|
10677
|
+
"customerId",
|
|
10678
|
+
"addressName",
|
|
10679
|
+
"siteId"
|
|
10680
|
+
];
|
|
10681
|
+
readonly removeCustomerAddress: readonly [
|
|
10682
|
+
"organizationId",
|
|
10683
|
+
"customerId",
|
|
10684
|
+
"addressName",
|
|
10685
|
+
"siteId"
|
|
10686
|
+
];
|
|
10687
|
+
readonly removeCustomerAddressRequired: readonly [
|
|
10688
|
+
"organizationId",
|
|
10689
|
+
"customerId",
|
|
10690
|
+
"addressName",
|
|
10691
|
+
"siteId"
|
|
10692
|
+
];
|
|
10693
|
+
readonly updateCustomerAddress: readonly [
|
|
10694
|
+
"organizationId",
|
|
10695
|
+
"customerId",
|
|
10696
|
+
"addressName",
|
|
10697
|
+
"siteId"
|
|
10698
|
+
];
|
|
10699
|
+
readonly updateCustomerAddressRequired: readonly [
|
|
10700
|
+
"organizationId",
|
|
10701
|
+
"customerId",
|
|
10702
|
+
"addressName",
|
|
10703
|
+
"siteId"
|
|
10704
|
+
];
|
|
10705
|
+
readonly getCustomerBaskets: readonly [
|
|
10706
|
+
"organizationId",
|
|
10707
|
+
"customerId",
|
|
10708
|
+
"siteId"
|
|
10709
|
+
];
|
|
10710
|
+
readonly getCustomerBasketsRequired: readonly [
|
|
10711
|
+
"organizationId",
|
|
10712
|
+
"customerId",
|
|
10713
|
+
"siteId"
|
|
10714
|
+
];
|
|
10715
|
+
readonly getCustomerOrders: readonly [
|
|
10716
|
+
"organizationId",
|
|
10717
|
+
"customerId",
|
|
10718
|
+
"crossSites",
|
|
10719
|
+
"from",
|
|
10720
|
+
"until",
|
|
10721
|
+
"status",
|
|
10722
|
+
"siteId",
|
|
10723
|
+
"offset",
|
|
10724
|
+
"limit"
|
|
10725
|
+
];
|
|
10726
|
+
readonly getCustomerOrdersRequired: readonly [
|
|
10727
|
+
"organizationId",
|
|
10728
|
+
"customerId",
|
|
10729
|
+
"siteId"
|
|
10730
|
+
];
|
|
10731
|
+
readonly updateCustomerPassword: readonly [
|
|
10732
|
+
"organizationId",
|
|
10733
|
+
"customerId",
|
|
10734
|
+
"siteId"
|
|
10735
|
+
];
|
|
10736
|
+
readonly updateCustomerPasswordRequired: readonly [
|
|
10737
|
+
"organizationId",
|
|
10738
|
+
"customerId",
|
|
10739
|
+
"siteId"
|
|
10740
|
+
];
|
|
10741
|
+
readonly createCustomerPaymentInstrument: readonly [
|
|
10742
|
+
"organizationId",
|
|
10743
|
+
"customerId",
|
|
10744
|
+
"siteId"
|
|
10745
|
+
];
|
|
10746
|
+
readonly createCustomerPaymentInstrumentRequired: readonly [
|
|
10747
|
+
"organizationId",
|
|
10748
|
+
"customerId",
|
|
10749
|
+
"siteId"
|
|
10750
|
+
];
|
|
10751
|
+
readonly deleteCustomerPaymentInstrument: readonly [
|
|
10752
|
+
"organizationId",
|
|
10753
|
+
"customerId",
|
|
10754
|
+
"paymentInstrumentId",
|
|
10755
|
+
"siteId"
|
|
10756
|
+
];
|
|
10757
|
+
readonly deleteCustomerPaymentInstrumentRequired: readonly [
|
|
10758
|
+
"organizationId",
|
|
10759
|
+
"customerId",
|
|
10760
|
+
"paymentInstrumentId",
|
|
10761
|
+
"siteId"
|
|
10762
|
+
];
|
|
10763
|
+
readonly getCustomerPaymentInstrument: readonly [
|
|
10764
|
+
"organizationId",
|
|
10765
|
+
"customerId",
|
|
10766
|
+
"paymentInstrumentId",
|
|
10767
|
+
"siteId"
|
|
10768
|
+
];
|
|
10769
|
+
readonly getCustomerPaymentInstrumentRequired: readonly [
|
|
10770
|
+
"organizationId",
|
|
10771
|
+
"customerId",
|
|
10772
|
+
"paymentInstrumentId",
|
|
10773
|
+
"siteId"
|
|
10774
|
+
];
|
|
10775
|
+
readonly getCustomerProductLists: readonly [
|
|
10776
|
+
"organizationId",
|
|
10777
|
+
"customerId",
|
|
10778
|
+
"siteId"
|
|
10779
|
+
];
|
|
10780
|
+
readonly getCustomerProductListsRequired: readonly [
|
|
10781
|
+
"organizationId",
|
|
10782
|
+
"customerId",
|
|
10783
|
+
"siteId"
|
|
10784
|
+
];
|
|
10785
|
+
readonly createCustomerProductList: readonly [
|
|
10786
|
+
"organizationId",
|
|
10787
|
+
"customerId",
|
|
10788
|
+
"siteId"
|
|
10789
|
+
];
|
|
10790
|
+
readonly createCustomerProductListRequired: readonly [
|
|
10791
|
+
"organizationId",
|
|
10792
|
+
"customerId",
|
|
10793
|
+
"siteId"
|
|
10794
|
+
];
|
|
10795
|
+
readonly deleteCustomerProductList: readonly [
|
|
10796
|
+
"organizationId",
|
|
10797
|
+
"customerId",
|
|
10798
|
+
"listId",
|
|
10799
|
+
"siteId"
|
|
10800
|
+
];
|
|
10801
|
+
readonly deleteCustomerProductListRequired: readonly [
|
|
10802
|
+
"organizationId",
|
|
10803
|
+
"customerId",
|
|
10804
|
+
"listId",
|
|
10805
|
+
"siteId"
|
|
10806
|
+
];
|
|
10807
|
+
readonly getCustomerProductList: readonly [
|
|
10808
|
+
"organizationId",
|
|
10809
|
+
"customerId",
|
|
10810
|
+
"listId",
|
|
10811
|
+
"siteId"
|
|
10812
|
+
];
|
|
10813
|
+
readonly getCustomerProductListRequired: readonly [
|
|
10814
|
+
"organizationId",
|
|
10815
|
+
"customerId",
|
|
10816
|
+
"listId",
|
|
10817
|
+
"siteId"
|
|
10818
|
+
];
|
|
10819
|
+
readonly updateCustomerProductList: readonly [
|
|
10820
|
+
"organizationId",
|
|
10821
|
+
"customerId",
|
|
10822
|
+
"listId",
|
|
10823
|
+
"siteId"
|
|
10824
|
+
];
|
|
10825
|
+
readonly updateCustomerProductListRequired: readonly [
|
|
10826
|
+
"organizationId",
|
|
10827
|
+
"customerId",
|
|
10828
|
+
"listId",
|
|
10829
|
+
"siteId"
|
|
10830
|
+
];
|
|
10831
|
+
readonly createCustomerProductListItem: readonly [
|
|
10832
|
+
"organizationId",
|
|
10833
|
+
"customerId",
|
|
10834
|
+
"listId",
|
|
10835
|
+
"siteId"
|
|
10836
|
+
];
|
|
10837
|
+
readonly createCustomerProductListItemRequired: readonly [
|
|
10838
|
+
"organizationId",
|
|
10839
|
+
"customerId",
|
|
10840
|
+
"listId",
|
|
10841
|
+
"siteId"
|
|
10842
|
+
];
|
|
10843
|
+
readonly deleteCustomerProductListItem: readonly [
|
|
10844
|
+
"organizationId",
|
|
10845
|
+
"customerId",
|
|
10846
|
+
"listId",
|
|
10847
|
+
"itemId",
|
|
10848
|
+
"siteId"
|
|
10849
|
+
];
|
|
10850
|
+
readonly deleteCustomerProductListItemRequired: readonly [
|
|
10851
|
+
"organizationId",
|
|
10852
|
+
"customerId",
|
|
10853
|
+
"listId",
|
|
10854
|
+
"itemId",
|
|
10855
|
+
"siteId"
|
|
10856
|
+
];
|
|
10857
|
+
readonly getCustomerProductListItem: readonly [
|
|
10858
|
+
"organizationId",
|
|
10859
|
+
"customerId",
|
|
10860
|
+
"listId",
|
|
10861
|
+
"itemId",
|
|
10862
|
+
"siteId"
|
|
10863
|
+
];
|
|
10864
|
+
readonly getCustomerProductListItemRequired: readonly [
|
|
10865
|
+
"organizationId",
|
|
10866
|
+
"customerId",
|
|
10867
|
+
"listId",
|
|
10868
|
+
"itemId",
|
|
10869
|
+
"siteId"
|
|
10870
|
+
];
|
|
10871
|
+
readonly updateCustomerProductListItem: readonly [
|
|
10872
|
+
"organizationId",
|
|
10873
|
+
"customerId",
|
|
10874
|
+
"listId",
|
|
10875
|
+
"itemId",
|
|
10876
|
+
"siteId"
|
|
10877
|
+
];
|
|
10878
|
+
readonly updateCustomerProductListItemRequired: readonly [
|
|
10879
|
+
"organizationId",
|
|
10880
|
+
"customerId",
|
|
10881
|
+
"listId",
|
|
10882
|
+
"itemId",
|
|
10883
|
+
"siteId"
|
|
10884
|
+
];
|
|
10885
|
+
readonly getPublicProductListsBySearchTerm: readonly [
|
|
10886
|
+
"organizationId",
|
|
10887
|
+
"email",
|
|
10888
|
+
"firstName",
|
|
10889
|
+
"lastName",
|
|
10890
|
+
"siteId"
|
|
10891
|
+
];
|
|
10892
|
+
readonly getPublicProductListsBySearchTermRequired: readonly [
|
|
10893
|
+
"organizationId",
|
|
10894
|
+
"siteId"
|
|
10895
|
+
];
|
|
10896
|
+
readonly getPublicProductList: readonly [
|
|
10897
|
+
"organizationId",
|
|
10898
|
+
"listId",
|
|
10899
|
+
"siteId"
|
|
10900
|
+
];
|
|
10901
|
+
readonly getPublicProductListRequired: readonly [
|
|
10902
|
+
"organizationId",
|
|
10903
|
+
"listId",
|
|
10904
|
+
"siteId"
|
|
10905
|
+
];
|
|
10906
|
+
readonly getProductListItem: readonly [
|
|
10907
|
+
"organizationId",
|
|
10908
|
+
"listId",
|
|
10909
|
+
"itemId",
|
|
10910
|
+
"siteId"
|
|
10911
|
+
];
|
|
10912
|
+
readonly getProductListItemRequired: readonly [
|
|
10913
|
+
"organizationId",
|
|
10914
|
+
"listId",
|
|
10915
|
+
"itemId",
|
|
10916
|
+
"siteId"
|
|
10917
|
+
];
|
|
10918
|
+
};
|
|
9281
10919
|
/**
|
|
9282
10920
|
* Registers a new customer. The mandatory data are the credentials, profile last name, and email. This requires a JSON Web Token (JWT) which needs to be obtained using the POST /customers/auth API with type \"guest\", or from the Shopper Login (SLAS) API. The return type object for this endpoint is a common customer object shared by multiple Shopper Customer endpoints. In this case, all customer object details are returned, but attributes that are not included in the response, although they might be part of the customer object, are ignored. For example, although address information is included in the customer object, it is not displayed in the response for this endpoint and is ignored.
|
|
9283
10921
|
*
|
|
@@ -9927,7 +11565,7 @@ declare class ShopperCustomers<ConfigParameters extends ShopperCustomersParamete
|
|
|
9927
11565
|
headers?: {
|
|
9928
11566
|
[key: string]: string;
|
|
9929
11567
|
};
|
|
9930
|
-
}>): Promise<BasketsResult
|
|
11568
|
+
}>): Promise<BasketsResult>;
|
|
9931
11569
|
/**
|
|
9932
11570
|
* Gets the baskets of a customer. This endpoint accepts a registered customer ShopperToken (JWT) or a guest customer ShopperToken.
|
|
9933
11571
|
*
|
|
@@ -9953,7 +11591,7 @@ declare class ShopperCustomers<ConfigParameters extends ShopperCustomersParamete
|
|
|
9953
11591
|
headers?: {
|
|
9954
11592
|
[key: string]: string;
|
|
9955
11593
|
};
|
|
9956
|
-
}>, rawResponse?: T): Promise<T extends true ? Response : BasketsResult
|
|
11594
|
+
}>, rawResponse?: T): Promise<T extends true ? Response : BasketsResult>;
|
|
9957
11595
|
/**
|
|
9958
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.
|
|
9959
11597
|
*
|
|
@@ -12276,12 +13914,11 @@ declare namespace ShopperCustomersTypes {
|
|
|
12276
13914
|
* ```
|
|
12277
13915
|
*
|
|
12278
13916
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
12279
|
-
* API Version: 0.0.
|
|
13917
|
+
* API Version: 0.0.49<br />
|
|
12280
13918
|
* Last Updated: <br />
|
|
12281
13919
|
* </span>
|
|
12282
|
-
|
|
12283
13920
|
*
|
|
12284
|
-
|
|
13921
|
+
*
|
|
12285
13922
|
*/
|
|
12286
13923
|
class ShopperCustomers<ConfigParameters extends ShopperCustomersParameters & Record<string, unknown>> {
|
|
12287
13924
|
// baseUri is not required on ClientConfig, but we know that we provide one in the class constructor
|
|
@@ -12290,6 +13927,331 @@ declare namespace ShopperCustomersTypes {
|
|
|
12290
13927
|
};
|
|
12291
13928
|
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/customer/shopper-customers/{version}";
|
|
12292
13929
|
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
13930
|
+
static readonly paramKeys: {
|
|
13931
|
+
readonly registerCustomer: readonly [
|
|
13932
|
+
"organizationId",
|
|
13933
|
+
"siteId"
|
|
13934
|
+
];
|
|
13935
|
+
readonly registerCustomerRequired: readonly [
|
|
13936
|
+
"organizationId",
|
|
13937
|
+
"siteId"
|
|
13938
|
+
];
|
|
13939
|
+
readonly resetPassword: readonly [
|
|
13940
|
+
"organizationId",
|
|
13941
|
+
"siteId"
|
|
13942
|
+
];
|
|
13943
|
+
readonly resetPasswordRequired: readonly [
|
|
13944
|
+
"organizationId",
|
|
13945
|
+
"siteId"
|
|
13946
|
+
];
|
|
13947
|
+
readonly getResetPasswordToken: readonly [
|
|
13948
|
+
"organizationId",
|
|
13949
|
+
"siteId"
|
|
13950
|
+
];
|
|
13951
|
+
readonly getResetPasswordTokenRequired: readonly [
|
|
13952
|
+
"organizationId",
|
|
13953
|
+
"siteId"
|
|
13954
|
+
];
|
|
13955
|
+
readonly registerExternalProfile: readonly [
|
|
13956
|
+
"organizationId",
|
|
13957
|
+
"siteId"
|
|
13958
|
+
];
|
|
13959
|
+
readonly registerExternalProfileRequired: readonly [
|
|
13960
|
+
"organizationId",
|
|
13961
|
+
"siteId"
|
|
13962
|
+
];
|
|
13963
|
+
readonly getExternalProfile: readonly [
|
|
13964
|
+
"organizationId",
|
|
13965
|
+
"externalId",
|
|
13966
|
+
"authenticationProviderId",
|
|
13967
|
+
"siteId"
|
|
13968
|
+
];
|
|
13969
|
+
readonly getExternalProfileRequired: readonly [
|
|
13970
|
+
"organizationId",
|
|
13971
|
+
"externalId",
|
|
13972
|
+
"authenticationProviderId",
|
|
13973
|
+
"siteId"
|
|
13974
|
+
];
|
|
13975
|
+
readonly getCustomer: readonly [
|
|
13976
|
+
"organizationId",
|
|
13977
|
+
"customerId",
|
|
13978
|
+
"siteId"
|
|
13979
|
+
];
|
|
13980
|
+
readonly getCustomerRequired: readonly [
|
|
13981
|
+
"organizationId",
|
|
13982
|
+
"customerId",
|
|
13983
|
+
"siteId"
|
|
13984
|
+
];
|
|
13985
|
+
readonly updateCustomer: readonly [
|
|
13986
|
+
"organizationId",
|
|
13987
|
+
"customerId",
|
|
13988
|
+
"siteId"
|
|
13989
|
+
];
|
|
13990
|
+
readonly updateCustomerRequired: readonly [
|
|
13991
|
+
"organizationId",
|
|
13992
|
+
"customerId",
|
|
13993
|
+
"siteId"
|
|
13994
|
+
];
|
|
13995
|
+
readonly createCustomerAddress: readonly [
|
|
13996
|
+
"organizationId",
|
|
13997
|
+
"customerId",
|
|
13998
|
+
"siteId"
|
|
13999
|
+
];
|
|
14000
|
+
readonly createCustomerAddressRequired: readonly [
|
|
14001
|
+
"organizationId",
|
|
14002
|
+
"customerId",
|
|
14003
|
+
"siteId"
|
|
14004
|
+
];
|
|
14005
|
+
readonly getCustomerAddress: readonly [
|
|
14006
|
+
"organizationId",
|
|
14007
|
+
"customerId",
|
|
14008
|
+
"addressName",
|
|
14009
|
+
"siteId"
|
|
14010
|
+
];
|
|
14011
|
+
readonly getCustomerAddressRequired: readonly [
|
|
14012
|
+
"organizationId",
|
|
14013
|
+
"customerId",
|
|
14014
|
+
"addressName",
|
|
14015
|
+
"siteId"
|
|
14016
|
+
];
|
|
14017
|
+
readonly removeCustomerAddress: readonly [
|
|
14018
|
+
"organizationId",
|
|
14019
|
+
"customerId",
|
|
14020
|
+
"addressName",
|
|
14021
|
+
"siteId"
|
|
14022
|
+
];
|
|
14023
|
+
readonly removeCustomerAddressRequired: readonly [
|
|
14024
|
+
"organizationId",
|
|
14025
|
+
"customerId",
|
|
14026
|
+
"addressName",
|
|
14027
|
+
"siteId"
|
|
14028
|
+
];
|
|
14029
|
+
readonly updateCustomerAddress: readonly [
|
|
14030
|
+
"organizationId",
|
|
14031
|
+
"customerId",
|
|
14032
|
+
"addressName",
|
|
14033
|
+
"siteId"
|
|
14034
|
+
];
|
|
14035
|
+
readonly updateCustomerAddressRequired: readonly [
|
|
14036
|
+
"organizationId",
|
|
14037
|
+
"customerId",
|
|
14038
|
+
"addressName",
|
|
14039
|
+
"siteId"
|
|
14040
|
+
];
|
|
14041
|
+
readonly getCustomerBaskets: readonly [
|
|
14042
|
+
"organizationId",
|
|
14043
|
+
"customerId",
|
|
14044
|
+
"siteId"
|
|
14045
|
+
];
|
|
14046
|
+
readonly getCustomerBasketsRequired: readonly [
|
|
14047
|
+
"organizationId",
|
|
14048
|
+
"customerId",
|
|
14049
|
+
"siteId"
|
|
14050
|
+
];
|
|
14051
|
+
readonly getCustomerOrders: readonly [
|
|
14052
|
+
"organizationId",
|
|
14053
|
+
"customerId",
|
|
14054
|
+
"crossSites",
|
|
14055
|
+
"from",
|
|
14056
|
+
"until",
|
|
14057
|
+
"status",
|
|
14058
|
+
"siteId",
|
|
14059
|
+
"offset",
|
|
14060
|
+
"limit"
|
|
14061
|
+
];
|
|
14062
|
+
readonly getCustomerOrdersRequired: readonly [
|
|
14063
|
+
"organizationId",
|
|
14064
|
+
"customerId",
|
|
14065
|
+
"siteId"
|
|
14066
|
+
];
|
|
14067
|
+
readonly updateCustomerPassword: readonly [
|
|
14068
|
+
"organizationId",
|
|
14069
|
+
"customerId",
|
|
14070
|
+
"siteId"
|
|
14071
|
+
];
|
|
14072
|
+
readonly updateCustomerPasswordRequired: readonly [
|
|
14073
|
+
"organizationId",
|
|
14074
|
+
"customerId",
|
|
14075
|
+
"siteId"
|
|
14076
|
+
];
|
|
14077
|
+
readonly createCustomerPaymentInstrument: readonly [
|
|
14078
|
+
"organizationId",
|
|
14079
|
+
"customerId",
|
|
14080
|
+
"siteId"
|
|
14081
|
+
];
|
|
14082
|
+
readonly createCustomerPaymentInstrumentRequired: readonly [
|
|
14083
|
+
"organizationId",
|
|
14084
|
+
"customerId",
|
|
14085
|
+
"siteId"
|
|
14086
|
+
];
|
|
14087
|
+
readonly deleteCustomerPaymentInstrument: readonly [
|
|
14088
|
+
"organizationId",
|
|
14089
|
+
"customerId",
|
|
14090
|
+
"paymentInstrumentId",
|
|
14091
|
+
"siteId"
|
|
14092
|
+
];
|
|
14093
|
+
readonly deleteCustomerPaymentInstrumentRequired: readonly [
|
|
14094
|
+
"organizationId",
|
|
14095
|
+
"customerId",
|
|
14096
|
+
"paymentInstrumentId",
|
|
14097
|
+
"siteId"
|
|
14098
|
+
];
|
|
14099
|
+
readonly getCustomerPaymentInstrument: readonly [
|
|
14100
|
+
"organizationId",
|
|
14101
|
+
"customerId",
|
|
14102
|
+
"paymentInstrumentId",
|
|
14103
|
+
"siteId"
|
|
14104
|
+
];
|
|
14105
|
+
readonly getCustomerPaymentInstrumentRequired: readonly [
|
|
14106
|
+
"organizationId",
|
|
14107
|
+
"customerId",
|
|
14108
|
+
"paymentInstrumentId",
|
|
14109
|
+
"siteId"
|
|
14110
|
+
];
|
|
14111
|
+
readonly getCustomerProductLists: readonly [
|
|
14112
|
+
"organizationId",
|
|
14113
|
+
"customerId",
|
|
14114
|
+
"siteId"
|
|
14115
|
+
];
|
|
14116
|
+
readonly getCustomerProductListsRequired: readonly [
|
|
14117
|
+
"organizationId",
|
|
14118
|
+
"customerId",
|
|
14119
|
+
"siteId"
|
|
14120
|
+
];
|
|
14121
|
+
readonly createCustomerProductList: readonly [
|
|
14122
|
+
"organizationId",
|
|
14123
|
+
"customerId",
|
|
14124
|
+
"siteId"
|
|
14125
|
+
];
|
|
14126
|
+
readonly createCustomerProductListRequired: readonly [
|
|
14127
|
+
"organizationId",
|
|
14128
|
+
"customerId",
|
|
14129
|
+
"siteId"
|
|
14130
|
+
];
|
|
14131
|
+
readonly deleteCustomerProductList: readonly [
|
|
14132
|
+
"organizationId",
|
|
14133
|
+
"customerId",
|
|
14134
|
+
"listId",
|
|
14135
|
+
"siteId"
|
|
14136
|
+
];
|
|
14137
|
+
readonly deleteCustomerProductListRequired: readonly [
|
|
14138
|
+
"organizationId",
|
|
14139
|
+
"customerId",
|
|
14140
|
+
"listId",
|
|
14141
|
+
"siteId"
|
|
14142
|
+
];
|
|
14143
|
+
readonly getCustomerProductList: readonly [
|
|
14144
|
+
"organizationId",
|
|
14145
|
+
"customerId",
|
|
14146
|
+
"listId",
|
|
14147
|
+
"siteId"
|
|
14148
|
+
];
|
|
14149
|
+
readonly getCustomerProductListRequired: readonly [
|
|
14150
|
+
"organizationId",
|
|
14151
|
+
"customerId",
|
|
14152
|
+
"listId",
|
|
14153
|
+
"siteId"
|
|
14154
|
+
];
|
|
14155
|
+
readonly updateCustomerProductList: readonly [
|
|
14156
|
+
"organizationId",
|
|
14157
|
+
"customerId",
|
|
14158
|
+
"listId",
|
|
14159
|
+
"siteId"
|
|
14160
|
+
];
|
|
14161
|
+
readonly updateCustomerProductListRequired: readonly [
|
|
14162
|
+
"organizationId",
|
|
14163
|
+
"customerId",
|
|
14164
|
+
"listId",
|
|
14165
|
+
"siteId"
|
|
14166
|
+
];
|
|
14167
|
+
readonly createCustomerProductListItem: readonly [
|
|
14168
|
+
"organizationId",
|
|
14169
|
+
"customerId",
|
|
14170
|
+
"listId",
|
|
14171
|
+
"siteId"
|
|
14172
|
+
];
|
|
14173
|
+
readonly createCustomerProductListItemRequired: readonly [
|
|
14174
|
+
"organizationId",
|
|
14175
|
+
"customerId",
|
|
14176
|
+
"listId",
|
|
14177
|
+
"siteId"
|
|
14178
|
+
];
|
|
14179
|
+
readonly deleteCustomerProductListItem: readonly [
|
|
14180
|
+
"organizationId",
|
|
14181
|
+
"customerId",
|
|
14182
|
+
"listId",
|
|
14183
|
+
"itemId",
|
|
14184
|
+
"siteId"
|
|
14185
|
+
];
|
|
14186
|
+
readonly deleteCustomerProductListItemRequired: readonly [
|
|
14187
|
+
"organizationId",
|
|
14188
|
+
"customerId",
|
|
14189
|
+
"listId",
|
|
14190
|
+
"itemId",
|
|
14191
|
+
"siteId"
|
|
14192
|
+
];
|
|
14193
|
+
readonly getCustomerProductListItem: readonly [
|
|
14194
|
+
"organizationId",
|
|
14195
|
+
"customerId",
|
|
14196
|
+
"listId",
|
|
14197
|
+
"itemId",
|
|
14198
|
+
"siteId"
|
|
14199
|
+
];
|
|
14200
|
+
readonly getCustomerProductListItemRequired: readonly [
|
|
14201
|
+
"organizationId",
|
|
14202
|
+
"customerId",
|
|
14203
|
+
"listId",
|
|
14204
|
+
"itemId",
|
|
14205
|
+
"siteId"
|
|
14206
|
+
];
|
|
14207
|
+
readonly updateCustomerProductListItem: readonly [
|
|
14208
|
+
"organizationId",
|
|
14209
|
+
"customerId",
|
|
14210
|
+
"listId",
|
|
14211
|
+
"itemId",
|
|
14212
|
+
"siteId"
|
|
14213
|
+
];
|
|
14214
|
+
readonly updateCustomerProductListItemRequired: readonly [
|
|
14215
|
+
"organizationId",
|
|
14216
|
+
"customerId",
|
|
14217
|
+
"listId",
|
|
14218
|
+
"itemId",
|
|
14219
|
+
"siteId"
|
|
14220
|
+
];
|
|
14221
|
+
readonly getPublicProductListsBySearchTerm: readonly [
|
|
14222
|
+
"organizationId",
|
|
14223
|
+
"email",
|
|
14224
|
+
"firstName",
|
|
14225
|
+
"lastName",
|
|
14226
|
+
"siteId"
|
|
14227
|
+
];
|
|
14228
|
+
readonly getPublicProductListsBySearchTermRequired: readonly [
|
|
14229
|
+
"organizationId",
|
|
14230
|
+
"siteId"
|
|
14231
|
+
];
|
|
14232
|
+
readonly getPublicProductList: readonly [
|
|
14233
|
+
"organizationId",
|
|
14234
|
+
"listId",
|
|
14235
|
+
"siteId"
|
|
14236
|
+
];
|
|
14237
|
+
readonly getPublicProductListRequired: readonly [
|
|
14238
|
+
"organizationId",
|
|
14239
|
+
"listId",
|
|
14240
|
+
"siteId"
|
|
14241
|
+
];
|
|
14242
|
+
readonly getProductListItem: readonly [
|
|
14243
|
+
"organizationId",
|
|
14244
|
+
"listId",
|
|
14245
|
+
"itemId",
|
|
14246
|
+
"siteId"
|
|
14247
|
+
];
|
|
14248
|
+
readonly getProductListItemRequired: readonly [
|
|
14249
|
+
"organizationId",
|
|
14250
|
+
"listId",
|
|
14251
|
+
"itemId",
|
|
14252
|
+
"siteId"
|
|
14253
|
+
];
|
|
14254
|
+
};
|
|
12293
14255
|
/**
|
|
12294
14256
|
* Registers a new customer. The mandatory data are the credentials, profile last name, and email. This requires a JSON Web Token (JWT) which needs to be obtained using the POST /customers/auth API with type \"guest\", or from the Shopper Login (SLAS) API. The return type object for this endpoint is a common customer object shared by multiple Shopper Customer endpoints. In this case, all customer object details are returned, but attributes that are not included in the response, although they might be part of the customer object, are ignored. For example, although address information is included in the customer object, it is not displayed in the response for this endpoint and is ignored.
|
|
12295
14257
|
*
|
|
@@ -14291,10 +16253,10 @@ type ShopperDiscoverySearchParameters = ShopperDiscoverySearchPathParameters & B
|
|
|
14291
16253
|
* API Version: 1.1.6<br />
|
|
14292
16254
|
* Last Updated: <br />
|
|
14293
16255
|
* </span>
|
|
16256
|
+
*
|
|
14294
16257
|
* @beta
|
|
14295
16258
|
*
|
|
14296
16259
|
*
|
|
14297
|
-
|
|
14298
16260
|
*/
|
|
14299
16261
|
declare class ShopperDiscoverySearch<ConfigParameters extends ShopperDiscoverySearchParameters & Record<string, unknown>> {
|
|
14300
16262
|
// baseUri is not required on ClientConfig, but we know that we provide one in the class constructor
|
|
@@ -14303,6 +16265,33 @@ declare class ShopperDiscoverySearch<ConfigParameters extends ShopperDiscoverySe
|
|
|
14303
16265
|
};
|
|
14304
16266
|
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/discovery/query/{version}";
|
|
14305
16267
|
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
16268
|
+
static readonly paramKeys: {
|
|
16269
|
+
readonly retrieveResults: readonly [
|
|
16270
|
+
"organizationId",
|
|
16271
|
+
"channelId",
|
|
16272
|
+
"locale",
|
|
16273
|
+
"offset",
|
|
16274
|
+
"limit"
|
|
16275
|
+
];
|
|
16276
|
+
readonly retrieveResultsRequired: readonly [
|
|
16277
|
+
"organizationId",
|
|
16278
|
+
"channelId",
|
|
16279
|
+
"locale"
|
|
16280
|
+
];
|
|
16281
|
+
readonly getSuggestions: readonly [
|
|
16282
|
+
"organizationId",
|
|
16283
|
+
"channelId",
|
|
16284
|
+
"suggestionTypes",
|
|
16285
|
+
"searchText",
|
|
16286
|
+
"locale"
|
|
16287
|
+
];
|
|
16288
|
+
readonly getSuggestionsRequired: readonly [
|
|
16289
|
+
"organizationId",
|
|
16290
|
+
"channelId",
|
|
16291
|
+
"suggestionTypes",
|
|
16292
|
+
"locale"
|
|
16293
|
+
];
|
|
16294
|
+
};
|
|
14306
16295
|
/**
|
|
14307
16296
|
* This method retrieves search results for a Channel.
|
|
14308
16297
|
*
|
|
@@ -14967,10 +16956,10 @@ declare namespace ShopperDiscoverySearchTypes {
|
|
|
14967
16956
|
* API Version: 1.1.6<br />
|
|
14968
16957
|
* Last Updated: <br />
|
|
14969
16958
|
* </span>
|
|
16959
|
+
*
|
|
14970
16960
|
* @beta
|
|
14971
16961
|
*
|
|
14972
16962
|
*
|
|
14973
|
-
|
|
14974
16963
|
*/
|
|
14975
16964
|
class ShopperDiscoverySearch<ConfigParameters extends ShopperDiscoverySearchParameters & Record<string, unknown>> {
|
|
14976
16965
|
// baseUri is not required on ClientConfig, but we know that we provide one in the class constructor
|
|
@@ -14979,6 +16968,33 @@ declare namespace ShopperDiscoverySearchTypes {
|
|
|
14979
16968
|
};
|
|
14980
16969
|
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/discovery/query/{version}";
|
|
14981
16970
|
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
16971
|
+
static readonly paramKeys: {
|
|
16972
|
+
readonly retrieveResults: readonly [
|
|
16973
|
+
"organizationId",
|
|
16974
|
+
"channelId",
|
|
16975
|
+
"locale",
|
|
16976
|
+
"offset",
|
|
16977
|
+
"limit"
|
|
16978
|
+
];
|
|
16979
|
+
readonly retrieveResultsRequired: readonly [
|
|
16980
|
+
"organizationId",
|
|
16981
|
+
"channelId",
|
|
16982
|
+
"locale"
|
|
16983
|
+
];
|
|
16984
|
+
readonly getSuggestions: readonly [
|
|
16985
|
+
"organizationId",
|
|
16986
|
+
"channelId",
|
|
16987
|
+
"suggestionTypes",
|
|
16988
|
+
"searchText",
|
|
16989
|
+
"locale"
|
|
16990
|
+
];
|
|
16991
|
+
readonly getSuggestionsRequired: readonly [
|
|
16992
|
+
"organizationId",
|
|
16993
|
+
"channelId",
|
|
16994
|
+
"suggestionTypes",
|
|
16995
|
+
"locale"
|
|
16996
|
+
];
|
|
16997
|
+
};
|
|
14982
16998
|
/**
|
|
14983
16999
|
* This method retrieves search results for a Channel.
|
|
14984
17000
|
*
|
|
@@ -15309,12 +17325,11 @@ type ShopperExperienceParameters = ShopperExperiencePathParameters & BaseUriPara
|
|
|
15309
17325
|
* ```
|
|
15310
17326
|
*
|
|
15311
17327
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
15312
|
-
* API Version: 1.0.
|
|
17328
|
+
* API Version: 1.0.5<br />
|
|
15313
17329
|
* Last Updated: <br />
|
|
15314
17330
|
* </span>
|
|
15315
|
-
|
|
15316
17331
|
*
|
|
15317
|
-
|
|
17332
|
+
*
|
|
15318
17333
|
*/
|
|
15319
17334
|
declare class ShopperExperience<ConfigParameters extends ShopperExperienceParameters & Record<string, unknown>> {
|
|
15320
17335
|
// baseUri is not required on ClientConfig, but we know that we provide one in the class constructor
|
|
@@ -15323,6 +17338,36 @@ declare class ShopperExperience<ConfigParameters extends ShopperExperienceParame
|
|
|
15323
17338
|
};
|
|
15324
17339
|
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/experience/shopper-experience/{version}";
|
|
15325
17340
|
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
17341
|
+
static readonly paramKeys: {
|
|
17342
|
+
readonly getPages: readonly [
|
|
17343
|
+
"organizationId",
|
|
17344
|
+
"categoryId",
|
|
17345
|
+
"productId",
|
|
17346
|
+
"aspectTypeId",
|
|
17347
|
+
"aspectAttributes",
|
|
17348
|
+
"parameters",
|
|
17349
|
+
"siteId",
|
|
17350
|
+
"locale"
|
|
17351
|
+
];
|
|
17352
|
+
readonly getPagesRequired: readonly [
|
|
17353
|
+
"organizationId",
|
|
17354
|
+
"aspectTypeId",
|
|
17355
|
+
"siteId"
|
|
17356
|
+
];
|
|
17357
|
+
readonly getPage: readonly [
|
|
17358
|
+
"organizationId",
|
|
17359
|
+
"pageId",
|
|
17360
|
+
"aspectAttributes",
|
|
17361
|
+
"parameters",
|
|
17362
|
+
"siteId",
|
|
17363
|
+
"locale"
|
|
17364
|
+
];
|
|
17365
|
+
readonly getPageRequired: readonly [
|
|
17366
|
+
"organizationId",
|
|
17367
|
+
"pageId",
|
|
17368
|
+
"siteId"
|
|
17369
|
+
];
|
|
17370
|
+
};
|
|
15326
17371
|
/**
|
|
15327
17372
|
* Get Page Designer pages. The results will apply the visibility rules for each page's components, such as personalization or scheduled visibility.
|
|
15328
17373
|
|
|
@@ -15942,12 +17987,11 @@ declare namespace ShopperExperienceTypes {
|
|
|
15942
17987
|
* ```
|
|
15943
17988
|
*
|
|
15944
17989
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
15945
|
-
* API Version: 1.0.
|
|
17990
|
+
* API Version: 1.0.5<br />
|
|
15946
17991
|
* Last Updated: <br />
|
|
15947
17992
|
* </span>
|
|
15948
|
-
|
|
15949
17993
|
*
|
|
15950
|
-
|
|
17994
|
+
*
|
|
15951
17995
|
*/
|
|
15952
17996
|
class ShopperExperience<ConfigParameters extends ShopperExperienceParameters & Record<string, unknown>> {
|
|
15953
17997
|
// baseUri is not required on ClientConfig, but we know that we provide one in the class constructor
|
|
@@ -15956,6 +18000,36 @@ declare namespace ShopperExperienceTypes {
|
|
|
15956
18000
|
};
|
|
15957
18001
|
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/experience/shopper-experience/{version}";
|
|
15958
18002
|
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
18003
|
+
static readonly paramKeys: {
|
|
18004
|
+
readonly getPages: readonly [
|
|
18005
|
+
"organizationId",
|
|
18006
|
+
"categoryId",
|
|
18007
|
+
"productId",
|
|
18008
|
+
"aspectTypeId",
|
|
18009
|
+
"aspectAttributes",
|
|
18010
|
+
"parameters",
|
|
18011
|
+
"siteId",
|
|
18012
|
+
"locale"
|
|
18013
|
+
];
|
|
18014
|
+
readonly getPagesRequired: readonly [
|
|
18015
|
+
"organizationId",
|
|
18016
|
+
"aspectTypeId",
|
|
18017
|
+
"siteId"
|
|
18018
|
+
];
|
|
18019
|
+
readonly getPage: readonly [
|
|
18020
|
+
"organizationId",
|
|
18021
|
+
"pageId",
|
|
18022
|
+
"aspectAttributes",
|
|
18023
|
+
"parameters",
|
|
18024
|
+
"siteId",
|
|
18025
|
+
"locale"
|
|
18026
|
+
];
|
|
18027
|
+
readonly getPageRequired: readonly [
|
|
18028
|
+
"organizationId",
|
|
18029
|
+
"pageId",
|
|
18030
|
+
"siteId"
|
|
18031
|
+
];
|
|
18032
|
+
};
|
|
15959
18033
|
/**
|
|
15960
18034
|
* Get Page Designer pages. The results will apply the visibility rules for each page's components, such as personalization or scheduled visibility.
|
|
15961
18035
|
|
|
@@ -16300,12 +18374,11 @@ type ShopperGiftCertificatesParameters = ShopperGiftCertificatesPathParameters &
|
|
|
16300
18374
|
* ```
|
|
16301
18375
|
*
|
|
16302
18376
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
16303
|
-
* API Version: 1.0.
|
|
18377
|
+
* API Version: 1.0.16<br />
|
|
16304
18378
|
* Last Updated: <br />
|
|
16305
18379
|
* </span>
|
|
16306
|
-
|
|
16307
18380
|
*
|
|
16308
|
-
|
|
18381
|
+
*
|
|
16309
18382
|
*/
|
|
16310
18383
|
declare class ShopperGiftCertificates<ConfigParameters extends ShopperGiftCertificatesParameters & Record<string, unknown>> {
|
|
16311
18384
|
// baseUri is not required on ClientConfig, but we know that we provide one in the class constructor
|
|
@@ -16314,6 +18387,16 @@ declare class ShopperGiftCertificates<ConfigParameters extends ShopperGiftCertif
|
|
|
16314
18387
|
};
|
|
16315
18388
|
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/pricing/shopper-gift-certificates/{version}";
|
|
16316
18389
|
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
18390
|
+
static readonly paramKeys: {
|
|
18391
|
+
readonly getGiftCertificate: readonly [
|
|
18392
|
+
"organizationId",
|
|
18393
|
+
"siteId"
|
|
18394
|
+
];
|
|
18395
|
+
readonly getGiftCertificateRequired: readonly [
|
|
18396
|
+
"organizationId",
|
|
18397
|
+
"siteId"
|
|
18398
|
+
];
|
|
18399
|
+
};
|
|
16317
18400
|
/**
|
|
16318
18401
|
* Action to retrieve an existing gift certificate.
|
|
16319
18402
|
*
|
|
@@ -16777,12 +18860,11 @@ declare namespace ShopperGiftCertificatesTypes {
|
|
|
16777
18860
|
* ```
|
|
16778
18861
|
*
|
|
16779
18862
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
16780
|
-
* API Version: 1.0.
|
|
18863
|
+
* API Version: 1.0.16<br />
|
|
16781
18864
|
* Last Updated: <br />
|
|
16782
18865
|
* </span>
|
|
16783
|
-
|
|
16784
18866
|
*
|
|
16785
|
-
|
|
18867
|
+
*
|
|
16786
18868
|
*/
|
|
16787
18869
|
class ShopperGiftCertificates<ConfigParameters extends ShopperGiftCertificatesParameters & Record<string, unknown>> {
|
|
16788
18870
|
// baseUri is not required on ClientConfig, but we know that we provide one in the class constructor
|
|
@@ -16791,6 +18873,16 @@ declare namespace ShopperGiftCertificatesTypes {
|
|
|
16791
18873
|
};
|
|
16792
18874
|
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/pricing/shopper-gift-certificates/{version}";
|
|
16793
18875
|
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
18876
|
+
static readonly paramKeys: {
|
|
18877
|
+
readonly getGiftCertificate: readonly [
|
|
18878
|
+
"organizationId",
|
|
18879
|
+
"siteId"
|
|
18880
|
+
];
|
|
18881
|
+
readonly getGiftCertificateRequired: readonly [
|
|
18882
|
+
"organizationId",
|
|
18883
|
+
"siteId"
|
|
18884
|
+
];
|
|
18885
|
+
};
|
|
16794
18886
|
/**
|
|
16795
18887
|
* Action to retrieve an existing gift certificate.
|
|
16796
18888
|
*
|
|
@@ -17129,9 +19221,8 @@ type ShopperLoginParameters = ShopperLoginPathParameters & BaseUriParameters & S
|
|
|
17129
19221
|
* API Version: 1.39.22<br />
|
|
17130
19222
|
* Last Updated: <br />
|
|
17131
19223
|
* </span>
|
|
17132
|
-
|
|
17133
19224
|
*
|
|
17134
|
-
|
|
19225
|
+
*
|
|
17135
19226
|
*/
|
|
17136
19227
|
declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Record<string, unknown>> {
|
|
17137
19228
|
// baseUri is not required on ClientConfig, but we know that we provide one in the class constructor
|
|
@@ -17140,6 +19231,145 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
|
|
|
17140
19231
|
};
|
|
17141
19232
|
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/shopper/auth/{version}";
|
|
17142
19233
|
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
19234
|
+
static readonly paramKeys: {
|
|
19235
|
+
readonly authenticateCustomer: readonly [
|
|
19236
|
+
"organizationId"
|
|
19237
|
+
];
|
|
19238
|
+
readonly authenticateCustomerRequired: readonly [
|
|
19239
|
+
"organizationId"
|
|
19240
|
+
];
|
|
19241
|
+
readonly authorizePasswordlessCustomer: readonly [
|
|
19242
|
+
"organizationId"
|
|
19243
|
+
];
|
|
19244
|
+
readonly authorizePasswordlessCustomerRequired: readonly [
|
|
19245
|
+
"organizationId"
|
|
19246
|
+
];
|
|
19247
|
+
readonly logoutCustomer: readonly [
|
|
19248
|
+
"organizationId",
|
|
19249
|
+
"client_id",
|
|
19250
|
+
"refresh_token",
|
|
19251
|
+
"channel_id",
|
|
19252
|
+
"hint"
|
|
19253
|
+
];
|
|
19254
|
+
readonly logoutCustomerRequired: readonly [
|
|
19255
|
+
"organizationId",
|
|
19256
|
+
"client_id",
|
|
19257
|
+
"refresh_token"
|
|
19258
|
+
];
|
|
19259
|
+
readonly authorizeCustomer: readonly [
|
|
19260
|
+
"organizationId",
|
|
19261
|
+
"redirect_uri",
|
|
19262
|
+
"response_type",
|
|
19263
|
+
"client_id",
|
|
19264
|
+
"scope",
|
|
19265
|
+
"state",
|
|
19266
|
+
"usid",
|
|
19267
|
+
"hint",
|
|
19268
|
+
"channel_id",
|
|
19269
|
+
"code_challenge",
|
|
19270
|
+
"ui_locales"
|
|
19271
|
+
];
|
|
19272
|
+
readonly authorizeCustomerRequired: readonly [
|
|
19273
|
+
"organizationId",
|
|
19274
|
+
"redirect_uri",
|
|
19275
|
+
"response_type",
|
|
19276
|
+
"client_id",
|
|
19277
|
+
"code_challenge"
|
|
19278
|
+
];
|
|
19279
|
+
readonly getAccessToken: readonly [
|
|
19280
|
+
"organizationId"
|
|
19281
|
+
];
|
|
19282
|
+
readonly getAccessTokenRequired: readonly [
|
|
19283
|
+
"organizationId"
|
|
19284
|
+
];
|
|
19285
|
+
readonly getSessionBridgeAccessToken: readonly [
|
|
19286
|
+
"organizationId"
|
|
19287
|
+
];
|
|
19288
|
+
readonly getSessionBridgeAccessTokenRequired: readonly [
|
|
19289
|
+
"organizationId"
|
|
19290
|
+
];
|
|
19291
|
+
readonly getTrustedSystemAccessToken: readonly [
|
|
19292
|
+
"organizationId"
|
|
19293
|
+
];
|
|
19294
|
+
readonly getTrustedSystemAccessTokenRequired: readonly [
|
|
19295
|
+
"organizationId"
|
|
19296
|
+
];
|
|
19297
|
+
readonly getTrustedAgentAuthorizationToken: readonly [
|
|
19298
|
+
"organizationId",
|
|
19299
|
+
"client_id",
|
|
19300
|
+
"channel_id",
|
|
19301
|
+
"code_challenge",
|
|
19302
|
+
"login_id",
|
|
19303
|
+
"idp_origin",
|
|
19304
|
+
"redirect_uri",
|
|
19305
|
+
"response_type"
|
|
19306
|
+
];
|
|
19307
|
+
readonly getTrustedAgentAuthorizationTokenRequired: readonly [
|
|
19308
|
+
"organizationId",
|
|
19309
|
+
"client_id",
|
|
19310
|
+
"channel_id",
|
|
19311
|
+
"code_challenge",
|
|
19312
|
+
"login_id",
|
|
19313
|
+
"idp_origin",
|
|
19314
|
+
"redirect_uri",
|
|
19315
|
+
"response_type"
|
|
19316
|
+
];
|
|
19317
|
+
readonly getTrustedAgentAccessToken: readonly [
|
|
19318
|
+
"organizationId"
|
|
19319
|
+
];
|
|
19320
|
+
readonly getTrustedAgentAccessTokenRequired: readonly [
|
|
19321
|
+
"organizationId"
|
|
19322
|
+
];
|
|
19323
|
+
readonly getPasswordResetToken: readonly [
|
|
19324
|
+
"organizationId"
|
|
19325
|
+
];
|
|
19326
|
+
readonly getPasswordResetTokenRequired: readonly [
|
|
19327
|
+
"organizationId"
|
|
19328
|
+
];
|
|
19329
|
+
readonly resetPassword: readonly [
|
|
19330
|
+
"organizationId"
|
|
19331
|
+
];
|
|
19332
|
+
readonly resetPasswordRequired: readonly [
|
|
19333
|
+
"organizationId"
|
|
19334
|
+
];
|
|
19335
|
+
readonly getPasswordLessAccessToken: readonly [
|
|
19336
|
+
"organizationId"
|
|
19337
|
+
];
|
|
19338
|
+
readonly getPasswordLessAccessTokenRequired: readonly [
|
|
19339
|
+
"organizationId"
|
|
19340
|
+
];
|
|
19341
|
+
readonly revokeToken: readonly [
|
|
19342
|
+
"organizationId"
|
|
19343
|
+
];
|
|
19344
|
+
readonly revokeTokenRequired: readonly [
|
|
19345
|
+
"organizationId"
|
|
19346
|
+
];
|
|
19347
|
+
readonly introspectToken: readonly [
|
|
19348
|
+
"organizationId"
|
|
19349
|
+
];
|
|
19350
|
+
readonly introspectTokenRequired: readonly [
|
|
19351
|
+
"organizationId"
|
|
19352
|
+
];
|
|
19353
|
+
readonly getUserInfo: readonly [
|
|
19354
|
+
"organizationId",
|
|
19355
|
+
"channel_id"
|
|
19356
|
+
];
|
|
19357
|
+
readonly getUserInfoRequired: readonly [
|
|
19358
|
+
"organizationId"
|
|
19359
|
+
];
|
|
19360
|
+
readonly getWellknownOpenidConfiguration: readonly [
|
|
19361
|
+
"organizationId"
|
|
19362
|
+
];
|
|
19363
|
+
readonly getWellknownOpenidConfigurationRequired: readonly [
|
|
19364
|
+
"organizationId"
|
|
19365
|
+
];
|
|
19366
|
+
readonly getJwksUri: readonly [
|
|
19367
|
+
"organizationId"
|
|
19368
|
+
];
|
|
19369
|
+
readonly getJwksUriRequired: readonly [
|
|
19370
|
+
"organizationId"
|
|
19371
|
+
];
|
|
19372
|
+
};
|
|
17143
19373
|
/**
|
|
17144
19374
|
* Logs in a shopper with credentials that are managed by a B2C Commerce instance (ECOM). It follows the authorization code grant flow as defined by the OAuth 2.1 standard. It also uses a proof key for code exchange (PKCE).
|
|
17145
19375
|
|
|
@@ -18759,9 +20989,8 @@ declare namespace ShopperLoginTypes {
|
|
|
18759
20989
|
* API Version: 1.39.22<br />
|
|
18760
20990
|
* Last Updated: <br />
|
|
18761
20991
|
* </span>
|
|
18762
|
-
|
|
18763
20992
|
*
|
|
18764
|
-
|
|
20993
|
+
*
|
|
18765
20994
|
*/
|
|
18766
20995
|
class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Record<string, unknown>> {
|
|
18767
20996
|
// baseUri is not required on ClientConfig, but we know that we provide one in the class constructor
|
|
@@ -18770,6 +20999,145 @@ declare namespace ShopperLoginTypes {
|
|
|
18770
20999
|
};
|
|
18771
21000
|
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/shopper/auth/{version}";
|
|
18772
21001
|
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
21002
|
+
static readonly paramKeys: {
|
|
21003
|
+
readonly authenticateCustomer: readonly [
|
|
21004
|
+
"organizationId"
|
|
21005
|
+
];
|
|
21006
|
+
readonly authenticateCustomerRequired: readonly [
|
|
21007
|
+
"organizationId"
|
|
21008
|
+
];
|
|
21009
|
+
readonly authorizePasswordlessCustomer: readonly [
|
|
21010
|
+
"organizationId"
|
|
21011
|
+
];
|
|
21012
|
+
readonly authorizePasswordlessCustomerRequired: readonly [
|
|
21013
|
+
"organizationId"
|
|
21014
|
+
];
|
|
21015
|
+
readonly logoutCustomer: readonly [
|
|
21016
|
+
"organizationId",
|
|
21017
|
+
"client_id",
|
|
21018
|
+
"refresh_token",
|
|
21019
|
+
"channel_id",
|
|
21020
|
+
"hint"
|
|
21021
|
+
];
|
|
21022
|
+
readonly logoutCustomerRequired: readonly [
|
|
21023
|
+
"organizationId",
|
|
21024
|
+
"client_id",
|
|
21025
|
+
"refresh_token"
|
|
21026
|
+
];
|
|
21027
|
+
readonly authorizeCustomer: readonly [
|
|
21028
|
+
"organizationId",
|
|
21029
|
+
"redirect_uri",
|
|
21030
|
+
"response_type",
|
|
21031
|
+
"client_id",
|
|
21032
|
+
"scope",
|
|
21033
|
+
"state",
|
|
21034
|
+
"usid",
|
|
21035
|
+
"hint",
|
|
21036
|
+
"channel_id",
|
|
21037
|
+
"code_challenge",
|
|
21038
|
+
"ui_locales"
|
|
21039
|
+
];
|
|
21040
|
+
readonly authorizeCustomerRequired: readonly [
|
|
21041
|
+
"organizationId",
|
|
21042
|
+
"redirect_uri",
|
|
21043
|
+
"response_type",
|
|
21044
|
+
"client_id",
|
|
21045
|
+
"code_challenge"
|
|
21046
|
+
];
|
|
21047
|
+
readonly getAccessToken: readonly [
|
|
21048
|
+
"organizationId"
|
|
21049
|
+
];
|
|
21050
|
+
readonly getAccessTokenRequired: readonly [
|
|
21051
|
+
"organizationId"
|
|
21052
|
+
];
|
|
21053
|
+
readonly getSessionBridgeAccessToken: readonly [
|
|
21054
|
+
"organizationId"
|
|
21055
|
+
];
|
|
21056
|
+
readonly getSessionBridgeAccessTokenRequired: readonly [
|
|
21057
|
+
"organizationId"
|
|
21058
|
+
];
|
|
21059
|
+
readonly getTrustedSystemAccessToken: readonly [
|
|
21060
|
+
"organizationId"
|
|
21061
|
+
];
|
|
21062
|
+
readonly getTrustedSystemAccessTokenRequired: readonly [
|
|
21063
|
+
"organizationId"
|
|
21064
|
+
];
|
|
21065
|
+
readonly getTrustedAgentAuthorizationToken: readonly [
|
|
21066
|
+
"organizationId",
|
|
21067
|
+
"client_id",
|
|
21068
|
+
"channel_id",
|
|
21069
|
+
"code_challenge",
|
|
21070
|
+
"login_id",
|
|
21071
|
+
"idp_origin",
|
|
21072
|
+
"redirect_uri",
|
|
21073
|
+
"response_type"
|
|
21074
|
+
];
|
|
21075
|
+
readonly getTrustedAgentAuthorizationTokenRequired: readonly [
|
|
21076
|
+
"organizationId",
|
|
21077
|
+
"client_id",
|
|
21078
|
+
"channel_id",
|
|
21079
|
+
"code_challenge",
|
|
21080
|
+
"login_id",
|
|
21081
|
+
"idp_origin",
|
|
21082
|
+
"redirect_uri",
|
|
21083
|
+
"response_type"
|
|
21084
|
+
];
|
|
21085
|
+
readonly getTrustedAgentAccessToken: readonly [
|
|
21086
|
+
"organizationId"
|
|
21087
|
+
];
|
|
21088
|
+
readonly getTrustedAgentAccessTokenRequired: readonly [
|
|
21089
|
+
"organizationId"
|
|
21090
|
+
];
|
|
21091
|
+
readonly getPasswordResetToken: readonly [
|
|
21092
|
+
"organizationId"
|
|
21093
|
+
];
|
|
21094
|
+
readonly getPasswordResetTokenRequired: readonly [
|
|
21095
|
+
"organizationId"
|
|
21096
|
+
];
|
|
21097
|
+
readonly resetPassword: readonly [
|
|
21098
|
+
"organizationId"
|
|
21099
|
+
];
|
|
21100
|
+
readonly resetPasswordRequired: readonly [
|
|
21101
|
+
"organizationId"
|
|
21102
|
+
];
|
|
21103
|
+
readonly getPasswordLessAccessToken: readonly [
|
|
21104
|
+
"organizationId"
|
|
21105
|
+
];
|
|
21106
|
+
readonly getPasswordLessAccessTokenRequired: readonly [
|
|
21107
|
+
"organizationId"
|
|
21108
|
+
];
|
|
21109
|
+
readonly revokeToken: readonly [
|
|
21110
|
+
"organizationId"
|
|
21111
|
+
];
|
|
21112
|
+
readonly revokeTokenRequired: readonly [
|
|
21113
|
+
"organizationId"
|
|
21114
|
+
];
|
|
21115
|
+
readonly introspectToken: readonly [
|
|
21116
|
+
"organizationId"
|
|
21117
|
+
];
|
|
21118
|
+
readonly introspectTokenRequired: readonly [
|
|
21119
|
+
"organizationId"
|
|
21120
|
+
];
|
|
21121
|
+
readonly getUserInfo: readonly [
|
|
21122
|
+
"organizationId",
|
|
21123
|
+
"channel_id"
|
|
21124
|
+
];
|
|
21125
|
+
readonly getUserInfoRequired: readonly [
|
|
21126
|
+
"organizationId"
|
|
21127
|
+
];
|
|
21128
|
+
readonly getWellknownOpenidConfiguration: readonly [
|
|
21129
|
+
"organizationId"
|
|
21130
|
+
];
|
|
21131
|
+
readonly getWellknownOpenidConfigurationRequired: readonly [
|
|
21132
|
+
"organizationId"
|
|
21133
|
+
];
|
|
21134
|
+
readonly getJwksUri: readonly [
|
|
21135
|
+
"organizationId"
|
|
21136
|
+
];
|
|
21137
|
+
readonly getJwksUriRequired: readonly [
|
|
21138
|
+
"organizationId"
|
|
21139
|
+
];
|
|
21140
|
+
};
|
|
18773
21141
|
/**
|
|
18774
21142
|
* Logs in a shopper with credentials that are managed by a B2C Commerce instance (ECOM). It follows the authorization code grant flow as defined by the OAuth 2.1 standard. It also uses a proof key for code exchange (PKCE).
|
|
18775
21143
|
|
|
@@ -20406,12 +22774,11 @@ type ShopperOrdersParameters = ShopperOrdersPathParameters & BaseUriParameters &
|
|
|
20406
22774
|
* ```
|
|
20407
22775
|
*
|
|
20408
22776
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
20409
|
-
* API Version: 0.4.
|
|
22777
|
+
* API Version: 0.4.8<br />
|
|
20410
22778
|
* Last Updated: <br />
|
|
20411
22779
|
* </span>
|
|
20412
|
-
|
|
20413
22780
|
*
|
|
20414
|
-
|
|
22781
|
+
*
|
|
20415
22782
|
*/
|
|
20416
22783
|
declare class ShopperOrders<ConfigParameters extends ShopperOrdersParameters & Record<string, unknown>> {
|
|
20417
22784
|
// baseUri is not required on ClientConfig, but we know that we provide one in the class constructor
|
|
@@ -20420,6 +22787,97 @@ declare class ShopperOrders<ConfigParameters extends ShopperOrdersParameters & R
|
|
|
20420
22787
|
};
|
|
20421
22788
|
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/checkout/shopper-orders/{version}";
|
|
20422
22789
|
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
22790
|
+
static readonly paramKeys: {
|
|
22791
|
+
readonly createOrder: readonly [
|
|
22792
|
+
"organizationId",
|
|
22793
|
+
"siteId",
|
|
22794
|
+
"locale"
|
|
22795
|
+
];
|
|
22796
|
+
readonly createOrderRequired: readonly [
|
|
22797
|
+
"organizationId",
|
|
22798
|
+
"siteId"
|
|
22799
|
+
];
|
|
22800
|
+
readonly getOrder: readonly [
|
|
22801
|
+
"organizationId",
|
|
22802
|
+
"orderNo",
|
|
22803
|
+
"siteId",
|
|
22804
|
+
"locale"
|
|
22805
|
+
];
|
|
22806
|
+
readonly getOrderRequired: readonly [
|
|
22807
|
+
"organizationId",
|
|
22808
|
+
"orderNo",
|
|
22809
|
+
"siteId"
|
|
22810
|
+
];
|
|
22811
|
+
readonly guestOrderLookup: readonly [
|
|
22812
|
+
"organizationId",
|
|
22813
|
+
"orderNo",
|
|
22814
|
+
"siteId",
|
|
22815
|
+
"locale"
|
|
22816
|
+
];
|
|
22817
|
+
readonly guestOrderLookupRequired: readonly [
|
|
22818
|
+
"organizationId",
|
|
22819
|
+
"orderNo",
|
|
22820
|
+
"siteId"
|
|
22821
|
+
];
|
|
22822
|
+
readonly createPaymentInstrumentForOrder: readonly [
|
|
22823
|
+
"organizationId",
|
|
22824
|
+
"orderNo",
|
|
22825
|
+
"siteId",
|
|
22826
|
+
"locale"
|
|
22827
|
+
];
|
|
22828
|
+
readonly createPaymentInstrumentForOrderRequired: readonly [
|
|
22829
|
+
"organizationId",
|
|
22830
|
+
"orderNo",
|
|
22831
|
+
"siteId"
|
|
22832
|
+
];
|
|
22833
|
+
readonly removePaymentInstrumentFromOrder: readonly [
|
|
22834
|
+
"organizationId",
|
|
22835
|
+
"orderNo",
|
|
22836
|
+
"paymentInstrumentId",
|
|
22837
|
+
"siteId",
|
|
22838
|
+
"locale"
|
|
22839
|
+
];
|
|
22840
|
+
readonly removePaymentInstrumentFromOrderRequired: readonly [
|
|
22841
|
+
"organizationId",
|
|
22842
|
+
"orderNo",
|
|
22843
|
+
"paymentInstrumentId",
|
|
22844
|
+
"siteId"
|
|
22845
|
+
];
|
|
22846
|
+
readonly updatePaymentInstrumentForOrder: readonly [
|
|
22847
|
+
"organizationId",
|
|
22848
|
+
"orderNo",
|
|
22849
|
+
"paymentInstrumentId",
|
|
22850
|
+
"siteId",
|
|
22851
|
+
"locale"
|
|
22852
|
+
];
|
|
22853
|
+
readonly updatePaymentInstrumentForOrderRequired: readonly [
|
|
22854
|
+
"organizationId",
|
|
22855
|
+
"orderNo",
|
|
22856
|
+
"paymentInstrumentId",
|
|
22857
|
+
"siteId"
|
|
22858
|
+
];
|
|
22859
|
+
readonly getPaymentMethodsForOrder: readonly [
|
|
22860
|
+
"organizationId",
|
|
22861
|
+
"orderNo",
|
|
22862
|
+
"siteId",
|
|
22863
|
+
"locale"
|
|
22864
|
+
];
|
|
22865
|
+
readonly getPaymentMethodsForOrderRequired: readonly [
|
|
22866
|
+
"organizationId",
|
|
22867
|
+
"orderNo",
|
|
22868
|
+
"siteId"
|
|
22869
|
+
];
|
|
22870
|
+
readonly getTaxesFromOrder: readonly [
|
|
22871
|
+
"organizationId",
|
|
22872
|
+
"orderNo",
|
|
22873
|
+
"siteId"
|
|
22874
|
+
];
|
|
22875
|
+
readonly getTaxesFromOrderRequired: readonly [
|
|
22876
|
+
"organizationId",
|
|
22877
|
+
"orderNo",
|
|
22878
|
+
"siteId"
|
|
22879
|
+
];
|
|
22880
|
+
};
|
|
20423
22881
|
/**
|
|
20424
22882
|
* Submits an order based on a prepared basket. The only considered value from the request body is basketId.
|
|
20425
22883
|
*
|
|
@@ -21865,12 +24323,11 @@ declare namespace ShopperOrdersTypes {
|
|
|
21865
24323
|
* ```
|
|
21866
24324
|
*
|
|
21867
24325
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
21868
|
-
* API Version: 0.4.
|
|
24326
|
+
* API Version: 0.4.8<br />
|
|
21869
24327
|
* Last Updated: <br />
|
|
21870
24328
|
* </span>
|
|
21871
|
-
|
|
21872
24329
|
*
|
|
21873
|
-
|
|
24330
|
+
*
|
|
21874
24331
|
*/
|
|
21875
24332
|
class ShopperOrders<ConfigParameters extends ShopperOrdersParameters & Record<string, unknown>> {
|
|
21876
24333
|
// baseUri is not required on ClientConfig, but we know that we provide one in the class constructor
|
|
@@ -21879,6 +24336,97 @@ declare namespace ShopperOrdersTypes {
|
|
|
21879
24336
|
};
|
|
21880
24337
|
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/checkout/shopper-orders/{version}";
|
|
21881
24338
|
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
24339
|
+
static readonly paramKeys: {
|
|
24340
|
+
readonly createOrder: readonly [
|
|
24341
|
+
"organizationId",
|
|
24342
|
+
"siteId",
|
|
24343
|
+
"locale"
|
|
24344
|
+
];
|
|
24345
|
+
readonly createOrderRequired: readonly [
|
|
24346
|
+
"organizationId",
|
|
24347
|
+
"siteId"
|
|
24348
|
+
];
|
|
24349
|
+
readonly getOrder: readonly [
|
|
24350
|
+
"organizationId",
|
|
24351
|
+
"orderNo",
|
|
24352
|
+
"siteId",
|
|
24353
|
+
"locale"
|
|
24354
|
+
];
|
|
24355
|
+
readonly getOrderRequired: readonly [
|
|
24356
|
+
"organizationId",
|
|
24357
|
+
"orderNo",
|
|
24358
|
+
"siteId"
|
|
24359
|
+
];
|
|
24360
|
+
readonly guestOrderLookup: readonly [
|
|
24361
|
+
"organizationId",
|
|
24362
|
+
"orderNo",
|
|
24363
|
+
"siteId",
|
|
24364
|
+
"locale"
|
|
24365
|
+
];
|
|
24366
|
+
readonly guestOrderLookupRequired: readonly [
|
|
24367
|
+
"organizationId",
|
|
24368
|
+
"orderNo",
|
|
24369
|
+
"siteId"
|
|
24370
|
+
];
|
|
24371
|
+
readonly createPaymentInstrumentForOrder: readonly [
|
|
24372
|
+
"organizationId",
|
|
24373
|
+
"orderNo",
|
|
24374
|
+
"siteId",
|
|
24375
|
+
"locale"
|
|
24376
|
+
];
|
|
24377
|
+
readonly createPaymentInstrumentForOrderRequired: readonly [
|
|
24378
|
+
"organizationId",
|
|
24379
|
+
"orderNo",
|
|
24380
|
+
"siteId"
|
|
24381
|
+
];
|
|
24382
|
+
readonly removePaymentInstrumentFromOrder: readonly [
|
|
24383
|
+
"organizationId",
|
|
24384
|
+
"orderNo",
|
|
24385
|
+
"paymentInstrumentId",
|
|
24386
|
+
"siteId",
|
|
24387
|
+
"locale"
|
|
24388
|
+
];
|
|
24389
|
+
readonly removePaymentInstrumentFromOrderRequired: readonly [
|
|
24390
|
+
"organizationId",
|
|
24391
|
+
"orderNo",
|
|
24392
|
+
"paymentInstrumentId",
|
|
24393
|
+
"siteId"
|
|
24394
|
+
];
|
|
24395
|
+
readonly updatePaymentInstrumentForOrder: readonly [
|
|
24396
|
+
"organizationId",
|
|
24397
|
+
"orderNo",
|
|
24398
|
+
"paymentInstrumentId",
|
|
24399
|
+
"siteId",
|
|
24400
|
+
"locale"
|
|
24401
|
+
];
|
|
24402
|
+
readonly updatePaymentInstrumentForOrderRequired: readonly [
|
|
24403
|
+
"organizationId",
|
|
24404
|
+
"orderNo",
|
|
24405
|
+
"paymentInstrumentId",
|
|
24406
|
+
"siteId"
|
|
24407
|
+
];
|
|
24408
|
+
readonly getPaymentMethodsForOrder: readonly [
|
|
24409
|
+
"organizationId",
|
|
24410
|
+
"orderNo",
|
|
24411
|
+
"siteId",
|
|
24412
|
+
"locale"
|
|
24413
|
+
];
|
|
24414
|
+
readonly getPaymentMethodsForOrderRequired: readonly [
|
|
24415
|
+
"organizationId",
|
|
24416
|
+
"orderNo",
|
|
24417
|
+
"siteId"
|
|
24418
|
+
];
|
|
24419
|
+
readonly getTaxesFromOrder: readonly [
|
|
24420
|
+
"organizationId",
|
|
24421
|
+
"orderNo",
|
|
24422
|
+
"siteId"
|
|
24423
|
+
];
|
|
24424
|
+
readonly getTaxesFromOrderRequired: readonly [
|
|
24425
|
+
"organizationId",
|
|
24426
|
+
"orderNo",
|
|
24427
|
+
"siteId"
|
|
24428
|
+
];
|
|
24429
|
+
};
|
|
21882
24430
|
/**
|
|
21883
24431
|
* Submits an order based on a prepared basket. The only considered value from the request body is basketId.
|
|
21884
24432
|
*
|
|
@@ -22871,12 +25419,11 @@ type ShopperProductsParameters = ShopperProductsPathParameters & BaseUriParamete
|
|
|
22871
25419
|
* ```
|
|
22872
25420
|
*
|
|
22873
25421
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
22874
|
-
* API Version: 0.0.
|
|
25422
|
+
* API Version: 0.0.33<br />
|
|
22875
25423
|
* Last Updated: <br />
|
|
22876
25424
|
* </span>
|
|
22877
|
-
|
|
22878
25425
|
*
|
|
22879
|
-
|
|
25426
|
+
*
|
|
22880
25427
|
*/
|
|
22881
25428
|
declare class ShopperProducts<ConfigParameters extends ShopperProductsParameters & Record<string, unknown>> {
|
|
22882
25429
|
// baseUri is not required on ClientConfig, but we know that we provide one in the class constructor
|
|
@@ -22885,6 +25432,66 @@ declare class ShopperProducts<ConfigParameters extends ShopperProductsParameters
|
|
|
22885
25432
|
};
|
|
22886
25433
|
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/product/shopper-products/{version}";
|
|
22887
25434
|
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
25435
|
+
static readonly paramKeys: {
|
|
25436
|
+
readonly getProducts: readonly [
|
|
25437
|
+
"organizationId",
|
|
25438
|
+
"select",
|
|
25439
|
+
"ids",
|
|
25440
|
+
"inventoryIds",
|
|
25441
|
+
"currency",
|
|
25442
|
+
"expand",
|
|
25443
|
+
"locale",
|
|
25444
|
+
"allImages",
|
|
25445
|
+
"perPricebook",
|
|
25446
|
+
"siteId"
|
|
25447
|
+
];
|
|
25448
|
+
readonly getProductsRequired: readonly [
|
|
25449
|
+
"organizationId",
|
|
25450
|
+
"ids",
|
|
25451
|
+
"siteId"
|
|
25452
|
+
];
|
|
25453
|
+
readonly getProduct: readonly [
|
|
25454
|
+
"organizationId",
|
|
25455
|
+
"id",
|
|
25456
|
+
"select",
|
|
25457
|
+
"inventoryIds",
|
|
25458
|
+
"currency",
|
|
25459
|
+
"expand",
|
|
25460
|
+
"locale",
|
|
25461
|
+
"allImages",
|
|
25462
|
+
"perPricebook",
|
|
25463
|
+
"siteId"
|
|
25464
|
+
];
|
|
25465
|
+
readonly getProductRequired: readonly [
|
|
25466
|
+
"organizationId",
|
|
25467
|
+
"id",
|
|
25468
|
+
"siteId"
|
|
25469
|
+
];
|
|
25470
|
+
readonly getCategories: readonly [
|
|
25471
|
+
"organizationId",
|
|
25472
|
+
"ids",
|
|
25473
|
+
"levels",
|
|
25474
|
+
"locale",
|
|
25475
|
+
"siteId"
|
|
25476
|
+
];
|
|
25477
|
+
readonly getCategoriesRequired: readonly [
|
|
25478
|
+
"organizationId",
|
|
25479
|
+
"ids",
|
|
25480
|
+
"siteId"
|
|
25481
|
+
];
|
|
25482
|
+
readonly getCategory: readonly [
|
|
25483
|
+
"organizationId",
|
|
25484
|
+
"id",
|
|
25485
|
+
"levels",
|
|
25486
|
+
"locale",
|
|
25487
|
+
"siteId"
|
|
25488
|
+
];
|
|
25489
|
+
readonly getCategoryRequired: readonly [
|
|
25490
|
+
"organizationId",
|
|
25491
|
+
"id",
|
|
25492
|
+
"siteId"
|
|
25493
|
+
];
|
|
25494
|
+
};
|
|
22888
25495
|
/**
|
|
22889
25496
|
* Allows access to multiple products by a single request. Only products that are online and assigned to a site catalog are returned. The maximum number of productIDs that can be requested are 24. Along with product details, the availability, product options, images, price, promotions, and variations for the valid products will be included, as appropriate.
|
|
22890
25497
|
*
|
|
@@ -23820,12 +26427,11 @@ declare namespace ShopperProductsTypes {
|
|
|
23820
26427
|
* ```
|
|
23821
26428
|
*
|
|
23822
26429
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
23823
|
-
* API Version: 0.0.
|
|
26430
|
+
* API Version: 0.0.33<br />
|
|
23824
26431
|
* Last Updated: <br />
|
|
23825
26432
|
* </span>
|
|
23826
|
-
|
|
23827
26433
|
*
|
|
23828
|
-
|
|
26434
|
+
*
|
|
23829
26435
|
*/
|
|
23830
26436
|
class ShopperProducts<ConfigParameters extends ShopperProductsParameters & Record<string, unknown>> {
|
|
23831
26437
|
// baseUri is not required on ClientConfig, but we know that we provide one in the class constructor
|
|
@@ -23834,6 +26440,66 @@ declare namespace ShopperProductsTypes {
|
|
|
23834
26440
|
};
|
|
23835
26441
|
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/product/shopper-products/{version}";
|
|
23836
26442
|
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
26443
|
+
static readonly paramKeys: {
|
|
26444
|
+
readonly getProducts: readonly [
|
|
26445
|
+
"organizationId",
|
|
26446
|
+
"select",
|
|
26447
|
+
"ids",
|
|
26448
|
+
"inventoryIds",
|
|
26449
|
+
"currency",
|
|
26450
|
+
"expand",
|
|
26451
|
+
"locale",
|
|
26452
|
+
"allImages",
|
|
26453
|
+
"perPricebook",
|
|
26454
|
+
"siteId"
|
|
26455
|
+
];
|
|
26456
|
+
readonly getProductsRequired: readonly [
|
|
26457
|
+
"organizationId",
|
|
26458
|
+
"ids",
|
|
26459
|
+
"siteId"
|
|
26460
|
+
];
|
|
26461
|
+
readonly getProduct: readonly [
|
|
26462
|
+
"organizationId",
|
|
26463
|
+
"id",
|
|
26464
|
+
"select",
|
|
26465
|
+
"inventoryIds",
|
|
26466
|
+
"currency",
|
|
26467
|
+
"expand",
|
|
26468
|
+
"locale",
|
|
26469
|
+
"allImages",
|
|
26470
|
+
"perPricebook",
|
|
26471
|
+
"siteId"
|
|
26472
|
+
];
|
|
26473
|
+
readonly getProductRequired: readonly [
|
|
26474
|
+
"organizationId",
|
|
26475
|
+
"id",
|
|
26476
|
+
"siteId"
|
|
26477
|
+
];
|
|
26478
|
+
readonly getCategories: readonly [
|
|
26479
|
+
"organizationId",
|
|
26480
|
+
"ids",
|
|
26481
|
+
"levels",
|
|
26482
|
+
"locale",
|
|
26483
|
+
"siteId"
|
|
26484
|
+
];
|
|
26485
|
+
readonly getCategoriesRequired: readonly [
|
|
26486
|
+
"organizationId",
|
|
26487
|
+
"ids",
|
|
26488
|
+
"siteId"
|
|
26489
|
+
];
|
|
26490
|
+
readonly getCategory: readonly [
|
|
26491
|
+
"organizationId",
|
|
26492
|
+
"id",
|
|
26493
|
+
"levels",
|
|
26494
|
+
"locale",
|
|
26495
|
+
"siteId"
|
|
26496
|
+
];
|
|
26497
|
+
readonly getCategoryRequired: readonly [
|
|
26498
|
+
"organizationId",
|
|
26499
|
+
"id",
|
|
26500
|
+
"siteId"
|
|
26501
|
+
];
|
|
26502
|
+
};
|
|
23837
26503
|
/**
|
|
23838
26504
|
* Allows access to multiple products by a single request. Only products that are online and assigned to a site catalog are returned. The maximum number of productIDs that can be requested are 24. Along with product details, the availability, product options, images, price, promotions, and variations for the valid products will be included, as appropriate.
|
|
23839
26505
|
*
|
|
@@ -24295,12 +26961,11 @@ type ShopperPromotionsParameters = ShopperPromotionsPathParameters & BaseUriPara
|
|
|
24295
26961
|
* ```
|
|
24296
26962
|
*
|
|
24297
26963
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
24298
|
-
* API Version: 1.0.
|
|
26964
|
+
* API Version: 1.0.26<br />
|
|
24299
26965
|
* Last Updated: <br />
|
|
24300
26966
|
* </span>
|
|
24301
|
-
|
|
24302
26967
|
*
|
|
24303
|
-
|
|
26968
|
+
*
|
|
24304
26969
|
*/
|
|
24305
26970
|
declare class ShopperPromotions<ConfigParameters extends ShopperPromotionsParameters & Record<string, unknown>> {
|
|
24306
26971
|
// baseUri is not required on ClientConfig, but we know that we provide one in the class constructor
|
|
@@ -24309,6 +26974,32 @@ declare class ShopperPromotions<ConfigParameters extends ShopperPromotionsParame
|
|
|
24309
26974
|
};
|
|
24310
26975
|
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/pricing/shopper-promotions/{version}";
|
|
24311
26976
|
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
26977
|
+
static readonly paramKeys: {
|
|
26978
|
+
readonly getPromotions: readonly [
|
|
26979
|
+
"organizationId",
|
|
26980
|
+
"siteId",
|
|
26981
|
+
"ids",
|
|
26982
|
+
"locale"
|
|
26983
|
+
];
|
|
26984
|
+
readonly getPromotionsRequired: readonly [
|
|
26985
|
+
"organizationId",
|
|
26986
|
+
"siteId",
|
|
26987
|
+
"ids"
|
|
26988
|
+
];
|
|
26989
|
+
readonly getPromotionsForCampaign: readonly [
|
|
26990
|
+
"organizationId",
|
|
26991
|
+
"campaignId",
|
|
26992
|
+
"siteId",
|
|
26993
|
+
"startDate",
|
|
26994
|
+
"endDate",
|
|
26995
|
+
"currency"
|
|
26996
|
+
];
|
|
26997
|
+
readonly getPromotionsForCampaignRequired: readonly [
|
|
26998
|
+
"organizationId",
|
|
26999
|
+
"campaignId",
|
|
27000
|
+
"siteId"
|
|
27001
|
+
];
|
|
27002
|
+
};
|
|
24312
27003
|
/**
|
|
24313
27004
|
* Returns an array of enabled promotions for a list of specified IDs. In the request URL, you can specify up to 50 IDs. If you specify an ID that contains either parentheses or the separator characters, you must URL encode these characters. Each request returns only enabled promotions as the server does not consider promotion qualifiers or schedules.
|
|
24314
27005
|
*
|
|
@@ -24855,12 +27546,11 @@ declare namespace ShopperPromotionsTypes {
|
|
|
24855
27546
|
* ```
|
|
24856
27547
|
*
|
|
24857
27548
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
24858
|
-
* API Version: 1.0.
|
|
27549
|
+
* API Version: 1.0.26<br />
|
|
24859
27550
|
* Last Updated: <br />
|
|
24860
27551
|
* </span>
|
|
24861
|
-
|
|
24862
27552
|
*
|
|
24863
|
-
|
|
27553
|
+
*
|
|
24864
27554
|
*/
|
|
24865
27555
|
class ShopperPromotions<ConfigParameters extends ShopperPromotionsParameters & Record<string, unknown>> {
|
|
24866
27556
|
// baseUri is not required on ClientConfig, but we know that we provide one in the class constructor
|
|
@@ -24869,6 +27559,32 @@ declare namespace ShopperPromotionsTypes {
|
|
|
24869
27559
|
};
|
|
24870
27560
|
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/pricing/shopper-promotions/{version}";
|
|
24871
27561
|
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
27562
|
+
static readonly paramKeys: {
|
|
27563
|
+
readonly getPromotions: readonly [
|
|
27564
|
+
"organizationId",
|
|
27565
|
+
"siteId",
|
|
27566
|
+
"ids",
|
|
27567
|
+
"locale"
|
|
27568
|
+
];
|
|
27569
|
+
readonly getPromotionsRequired: readonly [
|
|
27570
|
+
"organizationId",
|
|
27571
|
+
"siteId",
|
|
27572
|
+
"ids"
|
|
27573
|
+
];
|
|
27574
|
+
readonly getPromotionsForCampaign: readonly [
|
|
27575
|
+
"organizationId",
|
|
27576
|
+
"campaignId",
|
|
27577
|
+
"siteId",
|
|
27578
|
+
"startDate",
|
|
27579
|
+
"endDate",
|
|
27580
|
+
"currency"
|
|
27581
|
+
];
|
|
27582
|
+
readonly getPromotionsForCampaignRequired: readonly [
|
|
27583
|
+
"organizationId",
|
|
27584
|
+
"campaignId",
|
|
27585
|
+
"siteId"
|
|
27586
|
+
];
|
|
27587
|
+
};
|
|
24872
27588
|
/**
|
|
24873
27589
|
* Returns an array of enabled promotions for a list of specified IDs. In the request URL, you can specify up to 50 IDs. If you specify an ID that contains either parentheses or the separator characters, you must URL encode these characters. Each request returns only enabled promotions as the server does not consider promotion qualifiers or schedules.
|
|
24874
27590
|
*
|
|
@@ -25392,12 +28108,11 @@ type ShopperSearchParameters = ShopperSearchPathParameters & BaseUriParameters &
|
|
|
25392
28108
|
* ```
|
|
25393
28109
|
*
|
|
25394
28110
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
25395
|
-
* API Version: 1.0.
|
|
28111
|
+
* API Version: 1.0.41<br />
|
|
25396
28112
|
* Last Updated: <br />
|
|
25397
28113
|
* </span>
|
|
25398
|
-
|
|
25399
28114
|
*
|
|
25400
|
-
|
|
28115
|
+
*
|
|
25401
28116
|
*/
|
|
25402
28117
|
declare class ShopperSearch<ConfigParameters extends ShopperSearchParameters & Record<string, unknown>> {
|
|
25403
28118
|
// baseUri is not required on ClientConfig, but we know that we provide one in the class constructor
|
|
@@ -25406,6 +28121,41 @@ declare class ShopperSearch<ConfigParameters extends ShopperSearchParameters & R
|
|
|
25406
28121
|
};
|
|
25407
28122
|
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/search/shopper-search/{version}/";
|
|
25408
28123
|
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
28124
|
+
static readonly paramKeys: {
|
|
28125
|
+
readonly productSearch: readonly [
|
|
28126
|
+
"organizationId",
|
|
28127
|
+
"select",
|
|
28128
|
+
"siteId",
|
|
28129
|
+
"q",
|
|
28130
|
+
"refine",
|
|
28131
|
+
"sort",
|
|
28132
|
+
"currency",
|
|
28133
|
+
"locale",
|
|
28134
|
+
"expand",
|
|
28135
|
+
"allImages",
|
|
28136
|
+
"perPricebook",
|
|
28137
|
+
"allVariationProperties",
|
|
28138
|
+
"offset",
|
|
28139
|
+
"limit"
|
|
28140
|
+
];
|
|
28141
|
+
readonly productSearchRequired: readonly [
|
|
28142
|
+
"organizationId",
|
|
28143
|
+
"siteId"
|
|
28144
|
+
];
|
|
28145
|
+
readonly getSearchSuggestions: readonly [
|
|
28146
|
+
"organizationId",
|
|
28147
|
+
"siteId",
|
|
28148
|
+
"q",
|
|
28149
|
+
"limit",
|
|
28150
|
+
"currency",
|
|
28151
|
+
"locale"
|
|
28152
|
+
];
|
|
28153
|
+
readonly getSearchSuggestionsRequired: readonly [
|
|
28154
|
+
"organizationId",
|
|
28155
|
+
"siteId",
|
|
28156
|
+
"q"
|
|
28157
|
+
];
|
|
28158
|
+
};
|
|
25409
28159
|
/**
|
|
25410
28160
|
* Provides keyword and refinement search functionality for products. Only returns the product ID, link, and name in
|
|
25411
28161
|
the product search hit. The search result contains only products that are online and assigned to site catalog.
|
|
@@ -26228,12 +28978,11 @@ declare namespace ShopperSearchTypes {
|
|
|
26228
28978
|
* ```
|
|
26229
28979
|
*
|
|
26230
28980
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
26231
|
-
* API Version: 1.0.
|
|
28981
|
+
* API Version: 1.0.41<br />
|
|
26232
28982
|
* Last Updated: <br />
|
|
26233
28983
|
* </span>
|
|
26234
|
-
|
|
26235
28984
|
*
|
|
26236
|
-
|
|
28985
|
+
*
|
|
26237
28986
|
*/
|
|
26238
28987
|
class ShopperSearch<ConfigParameters extends ShopperSearchParameters & Record<string, unknown>> {
|
|
26239
28988
|
// baseUri is not required on ClientConfig, but we know that we provide one in the class constructor
|
|
@@ -26242,6 +28991,41 @@ declare namespace ShopperSearchTypes {
|
|
|
26242
28991
|
};
|
|
26243
28992
|
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/search/shopper-search/{version}/";
|
|
26244
28993
|
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
28994
|
+
static readonly paramKeys: {
|
|
28995
|
+
readonly productSearch: readonly [
|
|
28996
|
+
"organizationId",
|
|
28997
|
+
"select",
|
|
28998
|
+
"siteId",
|
|
28999
|
+
"q",
|
|
29000
|
+
"refine",
|
|
29001
|
+
"sort",
|
|
29002
|
+
"currency",
|
|
29003
|
+
"locale",
|
|
29004
|
+
"expand",
|
|
29005
|
+
"allImages",
|
|
29006
|
+
"perPricebook",
|
|
29007
|
+
"allVariationProperties",
|
|
29008
|
+
"offset",
|
|
29009
|
+
"limit"
|
|
29010
|
+
];
|
|
29011
|
+
readonly productSearchRequired: readonly [
|
|
29012
|
+
"organizationId",
|
|
29013
|
+
"siteId"
|
|
29014
|
+
];
|
|
29015
|
+
readonly getSearchSuggestions: readonly [
|
|
29016
|
+
"organizationId",
|
|
29017
|
+
"siteId",
|
|
29018
|
+
"q",
|
|
29019
|
+
"limit",
|
|
29020
|
+
"currency",
|
|
29021
|
+
"locale"
|
|
29022
|
+
];
|
|
29023
|
+
readonly getSearchSuggestionsRequired: readonly [
|
|
29024
|
+
"organizationId",
|
|
29025
|
+
"siteId",
|
|
29026
|
+
"q"
|
|
29027
|
+
];
|
|
29028
|
+
};
|
|
26245
29029
|
/**
|
|
26246
29030
|
* Provides keyword and refinement search functionality for products. Only returns the product ID, link, and name in
|
|
26247
29031
|
the product search hit. The search result contains only products that are online and assigned to site catalog.
|
|
@@ -26595,12 +29379,11 @@ type ShopperSeoParameters = ShopperSeoPathParameters & BaseUriParameters & Shopp
|
|
|
26595
29379
|
* ```
|
|
26596
29380
|
*
|
|
26597
29381
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
26598
|
-
* API Version: 1.0.
|
|
29382
|
+
* API Version: 1.0.9<br />
|
|
26599
29383
|
* Last Updated: <br />
|
|
26600
29384
|
* </span>
|
|
26601
|
-
|
|
26602
29385
|
*
|
|
26603
|
-
|
|
29386
|
+
*
|
|
26604
29387
|
*/
|
|
26605
29388
|
declare class ShopperSeo<ConfigParameters extends ShopperSeoParameters & Record<string, unknown>> {
|
|
26606
29389
|
// baseUri is not required on ClientConfig, but we know that we provide one in the class constructor
|
|
@@ -26609,6 +29392,19 @@ declare class ShopperSeo<ConfigParameters extends ShopperSeoParameters & Record<
|
|
|
26609
29392
|
};
|
|
26610
29393
|
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/site/shopper-seo/{version}";
|
|
26611
29394
|
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
29395
|
+
static readonly paramKeys: {
|
|
29396
|
+
readonly getUrlMapping: readonly [
|
|
29397
|
+
"organizationId",
|
|
29398
|
+
"urlSegment",
|
|
29399
|
+
"siteId",
|
|
29400
|
+
"locale"
|
|
29401
|
+
];
|
|
29402
|
+
readonly getUrlMappingRequired: readonly [
|
|
29403
|
+
"organizationId",
|
|
29404
|
+
"urlSegment",
|
|
29405
|
+
"siteId"
|
|
29406
|
+
];
|
|
29407
|
+
};
|
|
26612
29408
|
/**
|
|
26613
29409
|
* Gets URL mapping information for a URL that a shopper clicked or typed in. The mapping information is based on URL rules and redirects set up in Business Manager. For more information about prerequisites and sample usage, see [URL Resolution](/docs/commerce/commerce-api/guide/url-resolution.html). You can customize the behavior of this endpoint by using hooks. See the hooks for getUrlMapping in the [Hook List](https://developer.salesforce.com/docs/commerce/commerce-api/guide/hook_list.html).
|
|
26614
29410
|
*
|
|
@@ -27091,12 +29887,11 @@ declare namespace ShopperSeoTypes {
|
|
|
27091
29887
|
* ```
|
|
27092
29888
|
*
|
|
27093
29889
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
27094
|
-
* API Version: 1.0.
|
|
29890
|
+
* API Version: 1.0.9<br />
|
|
27095
29891
|
* Last Updated: <br />
|
|
27096
29892
|
* </span>
|
|
27097
|
-
|
|
27098
29893
|
*
|
|
27099
|
-
|
|
29894
|
+
*
|
|
27100
29895
|
*/
|
|
27101
29896
|
class ShopperSeo<ConfigParameters extends ShopperSeoParameters & Record<string, unknown>> {
|
|
27102
29897
|
// baseUri is not required on ClientConfig, but we know that we provide one in the class constructor
|
|
@@ -27105,6 +29900,19 @@ declare namespace ShopperSeoTypes {
|
|
|
27105
29900
|
};
|
|
27106
29901
|
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/site/shopper-seo/{version}";
|
|
27107
29902
|
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
29903
|
+
static readonly paramKeys: {
|
|
29904
|
+
readonly getUrlMapping: readonly [
|
|
29905
|
+
"organizationId",
|
|
29906
|
+
"urlSegment",
|
|
29907
|
+
"siteId",
|
|
29908
|
+
"locale"
|
|
29909
|
+
];
|
|
29910
|
+
readonly getUrlMappingRequired: readonly [
|
|
29911
|
+
"organizationId",
|
|
29912
|
+
"urlSegment",
|
|
29913
|
+
"siteId"
|
|
29914
|
+
];
|
|
29915
|
+
};
|
|
27108
29916
|
/**
|
|
27109
29917
|
* Gets URL mapping information for a URL that a shopper clicked or typed in. The mapping information is based on URL rules and redirects set up in Business Manager. For more information about prerequisites and sample usage, see [URL Resolution](/docs/commerce/commerce-api/guide/url-resolution.html). You can customize the behavior of this endpoint by using hooks. See the hooks for getUrlMapping in the [Hook List](https://developer.salesforce.com/docs/commerce/commerce-api/guide/hook_list.html).
|
|
27110
29918
|
*
|
|
@@ -27368,13 +30176,13 @@ type ShopperStoresParameters = ShopperStoresPathParameters & BaseUriParameters &
|
|
|
27368
30176
|
* ```
|
|
27369
30177
|
*
|
|
27370
30178
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
27371
|
-
* API Version: 1.0.
|
|
30179
|
+
* API Version: 1.0.15<br />
|
|
27372
30180
|
* Last Updated: <br />
|
|
27373
30181
|
* </span>
|
|
30182
|
+
*
|
|
27374
30183
|
* @beta
|
|
27375
30184
|
*
|
|
27376
30185
|
*
|
|
27377
|
-
|
|
27378
30186
|
*/
|
|
27379
30187
|
declare class ShopperStores<ConfigParameters extends ShopperStoresParameters & Record<string, unknown>> {
|
|
27380
30188
|
// baseUri is not required on ClientConfig, but we know that we provide one in the class constructor
|
|
@@ -27383,8 +30191,46 @@ declare class ShopperStores<ConfigParameters extends ShopperStoresParameters & R
|
|
|
27383
30191
|
};
|
|
27384
30192
|
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/store/shopper-stores/{version}";
|
|
27385
30193
|
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
27386
|
-
|
|
27387
|
-
|
|
30194
|
+
static readonly paramKeys: {
|
|
30195
|
+
readonly searchStores: readonly [
|
|
30196
|
+
"organizationId",
|
|
30197
|
+
"countryCode",
|
|
30198
|
+
"distanceUnit",
|
|
30199
|
+
"latitude",
|
|
30200
|
+
"longitude",
|
|
30201
|
+
"maxDistance",
|
|
30202
|
+
"postalCode",
|
|
30203
|
+
"siteId",
|
|
30204
|
+
"locale",
|
|
30205
|
+
"offset",
|
|
30206
|
+
"limit"
|
|
30207
|
+
];
|
|
30208
|
+
readonly searchStoresRequired: readonly [
|
|
30209
|
+
"organizationId",
|
|
30210
|
+
"siteId"
|
|
30211
|
+
];
|
|
30212
|
+
readonly getStores: readonly [
|
|
30213
|
+
"organizationId",
|
|
30214
|
+
"siteId",
|
|
30215
|
+
"ids",
|
|
30216
|
+
"locale"
|
|
30217
|
+
];
|
|
30218
|
+
readonly getStoresRequired: readonly [
|
|
30219
|
+
"organizationId",
|
|
30220
|
+
"siteId",
|
|
30221
|
+
"ids"
|
|
30222
|
+
];
|
|
30223
|
+
};
|
|
30224
|
+
/**
|
|
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
|
+
|
|
27388
30234
|
*
|
|
27389
30235
|
* If you would like to get a raw Response object use the other searchStores function.
|
|
27390
30236
|
*
|
|
@@ -27435,7 +30281,15 @@ declare class ShopperStores<ConfigParameters extends ShopperStoresParameters & R
|
|
|
27435
30281
|
};
|
|
27436
30282
|
}>): Promise<StoreResult>;
|
|
27437
30283
|
/**
|
|
27438
|
-
* This resource retrieves a list of stores for the given site that are within a configured distance of a geolocation
|
|
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
|
+
|
|
27439
30293
|
*
|
|
27440
30294
|
* @param options - An object containing the options for this method.
|
|
27441
30295
|
* @param parameters - An object containing the parameters for this method.
|
|
@@ -27993,13 +30847,13 @@ declare namespace ShopperStoresTypes {
|
|
|
27993
30847
|
* ```
|
|
27994
30848
|
*
|
|
27995
30849
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
27996
|
-
* API Version: 1.0.
|
|
30850
|
+
* API Version: 1.0.15<br />
|
|
27997
30851
|
* Last Updated: <br />
|
|
27998
30852
|
* </span>
|
|
30853
|
+
*
|
|
27999
30854
|
* @beta
|
|
28000
30855
|
*
|
|
28001
30856
|
*
|
|
28002
|
-
|
|
28003
30857
|
*/
|
|
28004
30858
|
class ShopperStores<ConfigParameters extends ShopperStoresParameters & Record<string, unknown>> {
|
|
28005
30859
|
// baseUri is not required on ClientConfig, but we know that we provide one in the class constructor
|
|
@@ -28008,8 +30862,46 @@ declare namespace ShopperStoresTypes {
|
|
|
28008
30862
|
};
|
|
28009
30863
|
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/store/shopper-stores/{version}";
|
|
28010
30864
|
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
30865
|
+
static readonly paramKeys: {
|
|
30866
|
+
readonly searchStores: readonly [
|
|
30867
|
+
"organizationId",
|
|
30868
|
+
"countryCode",
|
|
30869
|
+
"distanceUnit",
|
|
30870
|
+
"latitude",
|
|
30871
|
+
"longitude",
|
|
30872
|
+
"maxDistance",
|
|
30873
|
+
"postalCode",
|
|
30874
|
+
"siteId",
|
|
30875
|
+
"locale",
|
|
30876
|
+
"offset",
|
|
30877
|
+
"limit"
|
|
30878
|
+
];
|
|
30879
|
+
readonly searchStoresRequired: readonly [
|
|
30880
|
+
"organizationId",
|
|
30881
|
+
"siteId"
|
|
30882
|
+
];
|
|
30883
|
+
readonly getStores: readonly [
|
|
30884
|
+
"organizationId",
|
|
30885
|
+
"siteId",
|
|
30886
|
+
"ids",
|
|
30887
|
+
"locale"
|
|
30888
|
+
];
|
|
30889
|
+
readonly getStoresRequired: readonly [
|
|
30890
|
+
"organizationId",
|
|
30891
|
+
"siteId",
|
|
30892
|
+
"ids"
|
|
30893
|
+
];
|
|
30894
|
+
};
|
|
28011
30895
|
/**
|
|
28012
|
-
* This resource retrieves a list of stores for the given site that are within a configured distance of a geolocation
|
|
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
|
+
|
|
28013
30905
|
*
|
|
28014
30906
|
* If you would like to get a raw Response object use the other searchStores function.
|
|
28015
30907
|
*
|
|
@@ -28060,7 +30952,15 @@ declare namespace ShopperStoresTypes {
|
|
|
28060
30952
|
};
|
|
28061
30953
|
}>): Promise<StoreResult>;
|
|
28062
30954
|
/**
|
|
28063
|
-
* This resource retrieves a list of stores for the given site that are within a configured distance of a geolocation
|
|
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
|
+
|
|
28064
30964
|
*
|
|
28065
30965
|
* @param options - An object containing the options for this method.
|
|
28066
30966
|
* @param parameters - An object containing the parameters for this method.
|
|
@@ -28775,9 +31675,8 @@ declare namespace helpers {
|
|
|
28775
31675
|
* API Version: 1.39.22<br />
|
|
28776
31676
|
* Last Updated: <br />
|
|
28777
31677
|
* </span>
|
|
28778
|
-
|
|
28779
31678
|
*
|
|
28780
|
-
|
|
31679
|
+
*
|
|
28781
31680
|
*/
|
|
28782
31681
|
class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Record<string, unknown>> {
|
|
28783
31682
|
// baseUri is not required on ClientConfig, but we know that we provide one in the class constructor
|
|
@@ -28786,6 +31685,145 @@ declare namespace helpers {
|
|
|
28786
31685
|
};
|
|
28787
31686
|
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/shopper/auth/{version}";
|
|
28788
31687
|
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
31688
|
+
static readonly paramKeys: {
|
|
31689
|
+
readonly authenticateCustomer: readonly [
|
|
31690
|
+
"organizationId"
|
|
31691
|
+
];
|
|
31692
|
+
readonly authenticateCustomerRequired: readonly [
|
|
31693
|
+
"organizationId"
|
|
31694
|
+
];
|
|
31695
|
+
readonly authorizePasswordlessCustomer: readonly [
|
|
31696
|
+
"organizationId"
|
|
31697
|
+
];
|
|
31698
|
+
readonly authorizePasswordlessCustomerRequired: readonly [
|
|
31699
|
+
"organizationId"
|
|
31700
|
+
];
|
|
31701
|
+
readonly logoutCustomer: readonly [
|
|
31702
|
+
"organizationId",
|
|
31703
|
+
"client_id",
|
|
31704
|
+
"refresh_token",
|
|
31705
|
+
"channel_id",
|
|
31706
|
+
"hint"
|
|
31707
|
+
];
|
|
31708
|
+
readonly logoutCustomerRequired: readonly [
|
|
31709
|
+
"organizationId",
|
|
31710
|
+
"client_id",
|
|
31711
|
+
"refresh_token"
|
|
31712
|
+
];
|
|
31713
|
+
readonly authorizeCustomer: readonly [
|
|
31714
|
+
"organizationId",
|
|
31715
|
+
"redirect_uri",
|
|
31716
|
+
"response_type",
|
|
31717
|
+
"client_id",
|
|
31718
|
+
"scope",
|
|
31719
|
+
"state",
|
|
31720
|
+
"usid",
|
|
31721
|
+
"hint",
|
|
31722
|
+
"channel_id",
|
|
31723
|
+
"code_challenge",
|
|
31724
|
+
"ui_locales"
|
|
31725
|
+
];
|
|
31726
|
+
readonly authorizeCustomerRequired: readonly [
|
|
31727
|
+
"organizationId",
|
|
31728
|
+
"redirect_uri",
|
|
31729
|
+
"response_type",
|
|
31730
|
+
"client_id",
|
|
31731
|
+
"code_challenge"
|
|
31732
|
+
];
|
|
31733
|
+
readonly getAccessToken: readonly [
|
|
31734
|
+
"organizationId"
|
|
31735
|
+
];
|
|
31736
|
+
readonly getAccessTokenRequired: readonly [
|
|
31737
|
+
"organizationId"
|
|
31738
|
+
];
|
|
31739
|
+
readonly getSessionBridgeAccessToken: readonly [
|
|
31740
|
+
"organizationId"
|
|
31741
|
+
];
|
|
31742
|
+
readonly getSessionBridgeAccessTokenRequired: readonly [
|
|
31743
|
+
"organizationId"
|
|
31744
|
+
];
|
|
31745
|
+
readonly getTrustedSystemAccessToken: readonly [
|
|
31746
|
+
"organizationId"
|
|
31747
|
+
];
|
|
31748
|
+
readonly getTrustedSystemAccessTokenRequired: readonly [
|
|
31749
|
+
"organizationId"
|
|
31750
|
+
];
|
|
31751
|
+
readonly getTrustedAgentAuthorizationToken: readonly [
|
|
31752
|
+
"organizationId",
|
|
31753
|
+
"client_id",
|
|
31754
|
+
"channel_id",
|
|
31755
|
+
"code_challenge",
|
|
31756
|
+
"login_id",
|
|
31757
|
+
"idp_origin",
|
|
31758
|
+
"redirect_uri",
|
|
31759
|
+
"response_type"
|
|
31760
|
+
];
|
|
31761
|
+
readonly getTrustedAgentAuthorizationTokenRequired: readonly [
|
|
31762
|
+
"organizationId",
|
|
31763
|
+
"client_id",
|
|
31764
|
+
"channel_id",
|
|
31765
|
+
"code_challenge",
|
|
31766
|
+
"login_id",
|
|
31767
|
+
"idp_origin",
|
|
31768
|
+
"redirect_uri",
|
|
31769
|
+
"response_type"
|
|
31770
|
+
];
|
|
31771
|
+
readonly getTrustedAgentAccessToken: readonly [
|
|
31772
|
+
"organizationId"
|
|
31773
|
+
];
|
|
31774
|
+
readonly getTrustedAgentAccessTokenRequired: readonly [
|
|
31775
|
+
"organizationId"
|
|
31776
|
+
];
|
|
31777
|
+
readonly getPasswordResetToken: readonly [
|
|
31778
|
+
"organizationId"
|
|
31779
|
+
];
|
|
31780
|
+
readonly getPasswordResetTokenRequired: readonly [
|
|
31781
|
+
"organizationId"
|
|
31782
|
+
];
|
|
31783
|
+
readonly resetPassword: readonly [
|
|
31784
|
+
"organizationId"
|
|
31785
|
+
];
|
|
31786
|
+
readonly resetPasswordRequired: readonly [
|
|
31787
|
+
"organizationId"
|
|
31788
|
+
];
|
|
31789
|
+
readonly getPasswordLessAccessToken: readonly [
|
|
31790
|
+
"organizationId"
|
|
31791
|
+
];
|
|
31792
|
+
readonly getPasswordLessAccessTokenRequired: readonly [
|
|
31793
|
+
"organizationId"
|
|
31794
|
+
];
|
|
31795
|
+
readonly revokeToken: readonly [
|
|
31796
|
+
"organizationId"
|
|
31797
|
+
];
|
|
31798
|
+
readonly revokeTokenRequired: readonly [
|
|
31799
|
+
"organizationId"
|
|
31800
|
+
];
|
|
31801
|
+
readonly introspectToken: readonly [
|
|
31802
|
+
"organizationId"
|
|
31803
|
+
];
|
|
31804
|
+
readonly introspectTokenRequired: readonly [
|
|
31805
|
+
"organizationId"
|
|
31806
|
+
];
|
|
31807
|
+
readonly getUserInfo: readonly [
|
|
31808
|
+
"organizationId",
|
|
31809
|
+
"channel_id"
|
|
31810
|
+
];
|
|
31811
|
+
readonly getUserInfoRequired: readonly [
|
|
31812
|
+
"organizationId"
|
|
31813
|
+
];
|
|
31814
|
+
readonly getWellknownOpenidConfiguration: readonly [
|
|
31815
|
+
"organizationId"
|
|
31816
|
+
];
|
|
31817
|
+
readonly getWellknownOpenidConfigurationRequired: readonly [
|
|
31818
|
+
"organizationId"
|
|
31819
|
+
];
|
|
31820
|
+
readonly getJwksUri: readonly [
|
|
31821
|
+
"organizationId"
|
|
31822
|
+
];
|
|
31823
|
+
readonly getJwksUriRequired: readonly [
|
|
31824
|
+
"organizationId"
|
|
31825
|
+
];
|
|
31826
|
+
};
|
|
28789
31827
|
/**
|
|
28790
31828
|
* Logs in a shopper with credentials that are managed by a B2C Commerce instance (ECOM). It follows the authorization code grant flow as defined by the OAuth 2.1 standard. It also uses a proof key for code exchange (PKCE).
|
|
28791
31829
|
|