@commercengine/storefront-sdk 0.3.4 → 0.3.6
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/dist/lib/cart.d.ts +15 -1
- package/dist/lib/cart.js +22 -0
- package/dist/lib/shipping.d.ts +3 -3
- package/dist/lib/shipping.js +1 -1
- package/dist/types/storefront-api-types.d.ts +10 -7
- package/dist/types/storefront.d.ts +574 -220
- package/package.json +1 -1
|
@@ -479,7 +479,7 @@ export interface paths {
|
|
|
479
479
|
patch?: never;
|
|
480
480
|
trace?: never;
|
|
481
481
|
};
|
|
482
|
-
"/
|
|
482
|
+
"/carts/available-coupons": {
|
|
483
483
|
parameters: {
|
|
484
484
|
query?: never;
|
|
485
485
|
header?: never;
|
|
@@ -499,7 +499,7 @@ export interface paths {
|
|
|
499
499
|
patch?: never;
|
|
500
500
|
trace?: never;
|
|
501
501
|
};
|
|
502
|
-
"/
|
|
502
|
+
"/carts/available-promotions": {
|
|
503
503
|
parameters: {
|
|
504
504
|
query?: never;
|
|
505
505
|
header?: never;
|
|
@@ -990,40 +990,43 @@ export interface paths {
|
|
|
990
990
|
patch?: never;
|
|
991
991
|
trace?: never;
|
|
992
992
|
};
|
|
993
|
-
"/
|
|
993
|
+
"/shipping/shipping-methods": {
|
|
994
994
|
parameters: {
|
|
995
995
|
query?: never;
|
|
996
996
|
header?: never;
|
|
997
997
|
path?: never;
|
|
998
998
|
cookie?: never;
|
|
999
999
|
};
|
|
1000
|
+
get?: never;
|
|
1001
|
+
put?: never;
|
|
1000
1002
|
/**
|
|
1001
|
-
*
|
|
1002
|
-
* @description
|
|
1003
|
+
* List available shipping methods
|
|
1004
|
+
* @description Checks whether a given pincode is serviceable and returns all available shipping methods based on delivery address
|
|
1003
1005
|
*/
|
|
1004
|
-
|
|
1005
|
-
put?: never;
|
|
1006
|
-
post?: never;
|
|
1006
|
+
post: operations["get-shipping-methods"];
|
|
1007
1007
|
delete?: never;
|
|
1008
1008
|
options?: never;
|
|
1009
1009
|
head?: never;
|
|
1010
1010
|
patch?: never;
|
|
1011
1011
|
trace?: never;
|
|
1012
1012
|
};
|
|
1013
|
-
"/shipping/
|
|
1013
|
+
"/shipping/serviceability/{pincode}": {
|
|
1014
1014
|
parameters: {
|
|
1015
1015
|
query?: never;
|
|
1016
1016
|
header?: never;
|
|
1017
|
-
path
|
|
1017
|
+
path: {
|
|
1018
|
+
/** @description delivery pincode */
|
|
1019
|
+
pincode: string;
|
|
1020
|
+
};
|
|
1018
1021
|
cookie?: never;
|
|
1019
1022
|
};
|
|
1020
|
-
get?: never;
|
|
1021
|
-
put?: never;
|
|
1022
1023
|
/**
|
|
1023
1024
|
* Check serviceability
|
|
1024
|
-
* @description Checking
|
|
1025
|
+
* @description Checking if delivery is available to the entered pincode based on shipping zones.
|
|
1025
1026
|
*/
|
|
1026
|
-
|
|
1027
|
+
get: operations["check-pincode-serviceability"];
|
|
1028
|
+
put?: never;
|
|
1029
|
+
post?: never;
|
|
1027
1030
|
delete?: never;
|
|
1028
1031
|
options?: never;
|
|
1029
1032
|
head?: never;
|
|
@@ -1182,7 +1185,7 @@ export interface paths {
|
|
|
1182
1185
|
put?: never;
|
|
1183
1186
|
/**
|
|
1184
1187
|
* Register with email
|
|
1185
|
-
* @description The API allows users to register with their email address. This endpoint enables the registration process by requesting the user's email, first name, last name, phone number
|
|
1188
|
+
* @description The API allows users to register with their email address. This endpoint enables the registration process by requesting the user's email, first name, last name, phone number.
|
|
1186
1189
|
* The response will include a message indicating the success or failure of the registration process, as well as additional information such as the user's information, access token and refresh token.
|
|
1187
1190
|
*/
|
|
1188
1191
|
post: operations["register-with-email"];
|
|
@@ -1203,7 +1206,7 @@ export interface paths {
|
|
|
1203
1206
|
put?: never;
|
|
1204
1207
|
/**
|
|
1205
1208
|
* Register with whatsapp
|
|
1206
|
-
* @description The API allows users to register with their WhatsApp. This endpoint enables the registration process by requesting the user's WhatsApp number, first name, last name, email
|
|
1209
|
+
* @description The API allows users to register with their WhatsApp. This endpoint enables the registration process by requesting the user's WhatsApp number, first name, last name, email.
|
|
1207
1210
|
* The response will include a message indicating the success or failure of the registration process, as well as additional information such as the user's information, access token and refresh token.
|
|
1208
1211
|
*
|
|
1209
1212
|
*/
|
|
@@ -1833,6 +1836,8 @@ export interface components {
|
|
|
1833
1836
|
readonly active: boolean;
|
|
1834
1837
|
/** @description Indicates whether the product has stock available */
|
|
1835
1838
|
readonly stock_available: boolean;
|
|
1839
|
+
/** @description Indicates whether the item is being fulfilled as a backorder. When true, the item is not currently in stock and will ship later once inventory is available. This may result in the order being split into multiple shipments, with delays for the backordered portion. */
|
|
1840
|
+
backorder?: boolean;
|
|
1836
1841
|
/** @description Indicates whether this item is associated with any active (product-specific) coupons */
|
|
1837
1842
|
readonly on_offer: boolean;
|
|
1838
1843
|
/** @description Indicates whether the product has any subscription plans avaialble */
|
|
@@ -2142,6 +2147,8 @@ export interface components {
|
|
|
2142
2147
|
short_description: string | null;
|
|
2143
2148
|
readonly active: boolean;
|
|
2144
2149
|
readonly stock_available: boolean;
|
|
2150
|
+
/** @description Indicates whether the item is being fulfilled as a backorder. When true, the item is not currently in stock and will ship later once inventory is available. This may result in the order being split into multiple shipments, with delays for the backordered portion. */
|
|
2151
|
+
backorder?: boolean;
|
|
2145
2152
|
/** @description Indicates whether this item is associated with any active (product-specific) coupons */
|
|
2146
2153
|
readonly on_offer: boolean;
|
|
2147
2154
|
readonly on_promotion: boolean;
|
|
@@ -2210,6 +2217,8 @@ export interface components {
|
|
|
2210
2217
|
short_description: string | null;
|
|
2211
2218
|
active: boolean;
|
|
2212
2219
|
stock_available: boolean;
|
|
2220
|
+
/** @description Indicates whether the item is being fulfilled as a backorder. When true, the item is not currently in stock and will ship later once inventory is available. This may result in the order being split into multiple shipments, with delays for the backordered portion. */
|
|
2221
|
+
backorder?: boolean;
|
|
2213
2222
|
/** @description Indicates whether this item is associated with any active (product-specific) coupons */
|
|
2214
2223
|
on_offer: boolean;
|
|
2215
2224
|
on_subscription: boolean;
|
|
@@ -2224,6 +2233,7 @@ export interface components {
|
|
|
2224
2233
|
promotion: components["schemas"]["ProductPromotion"];
|
|
2225
2234
|
subscription: components["schemas"]["ProductSubscription"][];
|
|
2226
2235
|
associated_options: components["schemas"]["AssociatedOption"] | null;
|
|
2236
|
+
shipping?: components["schemas"]["ProductShipping"];
|
|
2227
2237
|
};
|
|
2228
2238
|
/** @description pagination metadata structure */
|
|
2229
2239
|
Pagination: {
|
|
@@ -2263,17 +2273,10 @@ export interface components {
|
|
|
2263
2273
|
};
|
|
2264
2274
|
/** ProductShipping */
|
|
2265
2275
|
ProductShipping: {
|
|
2266
|
-
|
|
2267
|
-
|
|
2268
|
-
|
|
2269
|
-
|
|
2270
|
-
/** @default false */
|
|
2271
|
-
ships_internationally: boolean;
|
|
2272
|
-
mid_code: string | null;
|
|
2273
|
-
/** @default India */
|
|
2274
|
-
country_of_origin: string | null;
|
|
2275
|
-
tax_type: string | null;
|
|
2276
|
-
tax_rate: number | null;
|
|
2276
|
+
handling_charges_including_tax: number;
|
|
2277
|
+
handling_charges_excluding_tax: number;
|
|
2278
|
+
tax_type: string;
|
|
2279
|
+
tax_rate: number;
|
|
2277
2280
|
} | null;
|
|
2278
2281
|
/** Seo */
|
|
2279
2282
|
Seo: {
|
|
@@ -2566,27 +2569,9 @@ export interface components {
|
|
|
2566
2569
|
*/
|
|
2567
2570
|
expires_at: string | null;
|
|
2568
2571
|
/** @description Information about the promotional offers that have been applied to the cart. */
|
|
2569
|
-
applied_promotions:
|
|
2570
|
-
promotion_id: string;
|
|
2571
|
-
/** @enum {unknown} */
|
|
2572
|
-
promotion_type: "discount" | "free-goods" | "free-shipping" | "buy-x-get-y" | "volume-based";
|
|
2573
|
-
savings: number;
|
|
2574
|
-
product_id: string | null;
|
|
2575
|
-
product_name: string | null;
|
|
2576
|
-
variant_id: string | null;
|
|
2577
|
-
variant_name: string | null;
|
|
2578
|
-
}[];
|
|
2572
|
+
applied_promotions: components["schemas"]["AppliedPromotion"][];
|
|
2579
2573
|
/** @description This key provides details about the savings in cart after coupon have been applied to the cart. */
|
|
2580
|
-
applied_coupons:
|
|
2581
|
-
coupon_id: string;
|
|
2582
|
-
/** @enum {unknown} */
|
|
2583
|
-
coupon_type: "discount" | "free-goods" | "fixed-price" | "free-shipping" | "buy-x-get-y" | "volume-based" | "accelerated-rewards";
|
|
2584
|
-
savings: number;
|
|
2585
|
-
product_id: string | null;
|
|
2586
|
-
product_name: string | null;
|
|
2587
|
-
variant_id: string | null;
|
|
2588
|
-
variant_name: string | null;
|
|
2589
|
-
}[];
|
|
2574
|
+
applied_coupons: components["schemas"]["AppliedCoupon"][];
|
|
2590
2575
|
promotion_savings: number;
|
|
2591
2576
|
coupon_savings: number;
|
|
2592
2577
|
other_savings: number;
|
|
@@ -2612,6 +2597,8 @@ export interface components {
|
|
|
2612
2597
|
product_image_url: string;
|
|
2613
2598
|
/** @description Indicates whether the product is currently in stock. */
|
|
2614
2599
|
stock_available: boolean;
|
|
2600
|
+
/** @description Indicates whether the item is being fulfilled as a backorder. When true, the item is not currently in stock and will ship later once inventory is available. This may result in the order being split into multiple shipments, with delays for the backordered portion. */
|
|
2601
|
+
backorder: boolean;
|
|
2615
2602
|
/** @description Indicates whether the product is currently on offer. */
|
|
2616
2603
|
on_offer: boolean;
|
|
2617
2604
|
/** @description Indicates whether the product is currently on a subscription. */
|
|
@@ -2676,6 +2663,7 @@ export interface components {
|
|
|
2676
2663
|
*/
|
|
2677
2664
|
tax_amount: number;
|
|
2678
2665
|
associated_options: components["schemas"]["AssociatedOption"] | null;
|
|
2666
|
+
attributes: components["schemas"]["ProductAttribute"][];
|
|
2679
2667
|
subscriptions: components["schemas"]["ProductSubscription"][] | null;
|
|
2680
2668
|
};
|
|
2681
2669
|
CustomerAddress: {
|
|
@@ -2709,59 +2697,274 @@ export interface components {
|
|
|
2709
2697
|
code: string;
|
|
2710
2698
|
symbol: string;
|
|
2711
2699
|
};
|
|
2712
|
-
/**
|
|
2713
|
-
|
|
2714
|
-
|
|
2715
|
-
|
|
2716
|
-
|
|
2717
|
-
|
|
2718
|
-
|
|
2719
|
-
|
|
2720
|
-
|
|
2721
|
-
|
|
2722
|
-
|
|
2723
|
-
|
|
2724
|
-
|
|
2725
|
-
|
|
2726
|
-
|
|
2727
|
-
|
|
2728
|
-
/**
|
|
2729
|
-
|
|
2730
|
-
|
|
2731
|
-
|
|
2732
|
-
|
|
2733
|
-
|
|
2734
|
-
|
|
2735
|
-
|
|
2700
|
+
/** DiscountRule */
|
|
2701
|
+
DiscountRule: components["schemas"]["PercentageDiscountRule"] | components["schemas"]["FixedAmountDiscountRule"];
|
|
2702
|
+
/** PercentageDiscountRule */
|
|
2703
|
+
PercentageDiscountRule: {
|
|
2704
|
+
/** @constant */
|
|
2705
|
+
discount_type: "percentage";
|
|
2706
|
+
discount_percent: number;
|
|
2707
|
+
maximum_discount_amount: number | null;
|
|
2708
|
+
products: {
|
|
2709
|
+
product_id: string | null;
|
|
2710
|
+
variant_id: string | null;
|
|
2711
|
+
minimum_quantity: number | null;
|
|
2712
|
+
maximum_quantity: number | null;
|
|
2713
|
+
minimum_value: number | null;
|
|
2714
|
+
maximum_value: number | null;
|
|
2715
|
+
}[];
|
|
2716
|
+
/** @description Array of category ids */
|
|
2717
|
+
category_id: string[];
|
|
2718
|
+
};
|
|
2719
|
+
/** FixedAmountDiscountRule */
|
|
2720
|
+
FixedAmountDiscountRule: {
|
|
2721
|
+
/** @constant */
|
|
2722
|
+
discount_type: "fixed-amount";
|
|
2723
|
+
fixed_discount_amount: number;
|
|
2724
|
+
products: {
|
|
2725
|
+
product_id: string | null;
|
|
2726
|
+
variant_id: string | null;
|
|
2727
|
+
minimum_quantity: number | null;
|
|
2728
|
+
maximum_quantity: number | null;
|
|
2729
|
+
minimum_value: number | null;
|
|
2730
|
+
maximum_value: number | null;
|
|
2731
|
+
}[];
|
|
2732
|
+
/** @description Array of category ids */
|
|
2733
|
+
category_id: string[];
|
|
2736
2734
|
};
|
|
2735
|
+
/** FreeGoodsRule */
|
|
2736
|
+
FreeGoodsRule: components["schemas"]["AutoScaleBasedOnQuantity"] | components["schemas"]["AutoScaleBasedOnAmount"] | components["schemas"]["CustomSlabsBasedOnQuantity"] | components["schemas"]["CustomSlabsBasedOnAmount"];
|
|
2737
|
+
/** AutoScaleBasedOnQuantity */
|
|
2738
|
+
AutoScaleBasedOnQuantity: {
|
|
2739
|
+
/** @constant */
|
|
2740
|
+
spending_criteria_type: "minimum-quantity";
|
|
2741
|
+
products: {
|
|
2742
|
+
product_id: string | null;
|
|
2743
|
+
variant_id: string | null;
|
|
2744
|
+
/** @constant */
|
|
2745
|
+
auto_scale: true;
|
|
2746
|
+
slab: {
|
|
2747
|
+
buy_quantity: number;
|
|
2748
|
+
get_quantity: number;
|
|
2749
|
+
/** @enum {unknown} */
|
|
2750
|
+
condition: "greater-or-equal";
|
|
2751
|
+
};
|
|
2752
|
+
}[];
|
|
2753
|
+
};
|
|
2754
|
+
/** AutoScaleBasedOnAmount */
|
|
2755
|
+
AutoScaleBasedOnAmount: {
|
|
2756
|
+
/** @constant */
|
|
2757
|
+
spending_criteria_type: "minimum-purchase-amount";
|
|
2758
|
+
products: {
|
|
2759
|
+
product_id: string | null;
|
|
2760
|
+
variant_id: string | null;
|
|
2761
|
+
/** @constant */
|
|
2762
|
+
auto_scale: true;
|
|
2763
|
+
slab: {
|
|
2764
|
+
minimum_purchase_amount: number;
|
|
2765
|
+
get_quantity: number;
|
|
2766
|
+
/** @enum {unknown} */
|
|
2767
|
+
condition: "greater-or-equal";
|
|
2768
|
+
};
|
|
2769
|
+
}[];
|
|
2770
|
+
};
|
|
2771
|
+
/** CustomSlabsBasedOnQuantity */
|
|
2772
|
+
CustomSlabsBasedOnQuantity: {
|
|
2773
|
+
/** @constant */
|
|
2774
|
+
spending_criteria_type: "minimum-quantity";
|
|
2775
|
+
products: {
|
|
2776
|
+
product_id: string | null;
|
|
2777
|
+
variant_id: string | null;
|
|
2778
|
+
slabs: {
|
|
2779
|
+
buy_quantity: number;
|
|
2780
|
+
get_quantity: number;
|
|
2781
|
+
/** @enum {unknown} */
|
|
2782
|
+
condition: "greater-or-equal";
|
|
2783
|
+
}[];
|
|
2784
|
+
}[];
|
|
2785
|
+
};
|
|
2786
|
+
/** CustomSlabsBasedOnAmount */
|
|
2787
|
+
CustomSlabsBasedOnAmount: {
|
|
2788
|
+
/** @constant */
|
|
2789
|
+
spending_criteria_type: "minimum-purchase-amount";
|
|
2790
|
+
products: {
|
|
2791
|
+
product_id: string | null;
|
|
2792
|
+
variant_id: string | null;
|
|
2793
|
+
slabs: {
|
|
2794
|
+
minimum_purchase_amount: number;
|
|
2795
|
+
get_quantity: number;
|
|
2796
|
+
/** @enum {unknown} */
|
|
2797
|
+
condition: "greater-or-equal";
|
|
2798
|
+
}[];
|
|
2799
|
+
}[];
|
|
2800
|
+
};
|
|
2801
|
+
/** FixedPriceRule */
|
|
2802
|
+
FixedPriceRule: components["schemas"]["FixedPriceRuleBasedQuantity"] | components["schemas"]["FixedPriceRuleBasedAmount"];
|
|
2803
|
+
/** FixedPriceRuleBasedQuantity */
|
|
2804
|
+
FixedPriceRuleBasedQuantity: {
|
|
2805
|
+
/** @constant */
|
|
2806
|
+
spending_criteria_type: "minimum-quantity";
|
|
2807
|
+
products: {
|
|
2808
|
+
product_id: string | null;
|
|
2809
|
+
variant_id: string | null;
|
|
2810
|
+
minimum_quantity: number;
|
|
2811
|
+
/** @description null means there is no limit. */
|
|
2812
|
+
maximum_quantity: number | null;
|
|
2813
|
+
offer_price: number;
|
|
2814
|
+
}[];
|
|
2815
|
+
};
|
|
2816
|
+
/** FixedPriceRuleBasedAmount */
|
|
2817
|
+
FixedPriceRuleBasedAmount: {
|
|
2818
|
+
/** @constant */
|
|
2819
|
+
spending_criteria_type: "minimum-purchase-amount";
|
|
2820
|
+
products: {
|
|
2821
|
+
product_id: string | null;
|
|
2822
|
+
variant_id: string | null;
|
|
2823
|
+
minimum_purchase_amount: number;
|
|
2824
|
+
/** @description null means there is no limit. */
|
|
2825
|
+
maximum_purchase_amount: number | null;
|
|
2826
|
+
offer_price: number;
|
|
2827
|
+
}[];
|
|
2828
|
+
};
|
|
2829
|
+
/** BuyXGetYRule */
|
|
2830
|
+
BuyXGetYRule: components["schemas"]["BuyXGetYRuleBasedOnQuantity"] | components["schemas"]["BuyXGetYRuleBasedOnAmount"];
|
|
2737
2831
|
/**
|
|
2738
|
-
*
|
|
2739
|
-
* @description
|
|
2832
|
+
* BuyXGetYRuleBasedOnQuantity
|
|
2833
|
+
* @description Additional fields required in addition to marked as required.
|
|
2834
|
+
* 1) buy_product_id or buy_variant_id or buy_from_category_id
|
|
2835
|
+
* 2) get_product_id or get_variant_id or get_from_category_id
|
|
2836
|
+
* 3) get_free_quantity or get_discount_percent
|
|
2740
2837
|
*/
|
|
2741
|
-
|
|
2742
|
-
|
|
2743
|
-
|
|
2744
|
-
|
|
2745
|
-
|
|
2746
|
-
|
|
2747
|
-
|
|
2748
|
-
|
|
2749
|
-
|
|
2750
|
-
|
|
2751
|
-
|
|
2752
|
-
|
|
2753
|
-
|
|
2754
|
-
|
|
2755
|
-
|
|
2756
|
-
|
|
2757
|
-
|
|
2758
|
-
/**
|
|
2759
|
-
|
|
2838
|
+
BuyXGetYRuleBasedOnQuantity: {
|
|
2839
|
+
/** @constant */
|
|
2840
|
+
spending_criteria_type: "minimum-quantity";
|
|
2841
|
+
products: {
|
|
2842
|
+
minimum_quantity: number;
|
|
2843
|
+
buy_product_id: string | null;
|
|
2844
|
+
buy_variant_id: string | null;
|
|
2845
|
+
buy_from_category_id: string | null;
|
|
2846
|
+
get_product_id: string | null;
|
|
2847
|
+
get_variant_id: string | null;
|
|
2848
|
+
get_from_category_id: string | null;
|
|
2849
|
+
get_quantity: number;
|
|
2850
|
+
/** @enum {unknown} */
|
|
2851
|
+
get_offer_type: "discount" | "free";
|
|
2852
|
+
/** @description It can be null for get_offer_type = free */
|
|
2853
|
+
get_discount_percent: number | null;
|
|
2854
|
+
}[];
|
|
2855
|
+
/** @description It can be null for get_offer_type = free */
|
|
2856
|
+
maximum_discount_amount: number | null;
|
|
2857
|
+
};
|
|
2858
|
+
/**
|
|
2859
|
+
* BuyXGetYRuleBasedOnAmount
|
|
2860
|
+
* @description Additional fields required in addition to marked as required.
|
|
2861
|
+
* 1) buy_product_id or buy_variant_id or buy_from_category_id
|
|
2862
|
+
* 2) get_product_id or get_variant_id or get_from_category_id
|
|
2863
|
+
* 3) get_free_quantity or get_discount_percent
|
|
2864
|
+
*/
|
|
2865
|
+
BuyXGetYRuleBasedOnAmount: {
|
|
2866
|
+
/** @constant */
|
|
2867
|
+
spending_criteria_type: "minimum-purchase-amount";
|
|
2868
|
+
products: {
|
|
2869
|
+
minimum_purchase_amount: number;
|
|
2870
|
+
buy_product_id: string | null;
|
|
2871
|
+
buy_variant_id: string | null;
|
|
2872
|
+
buy_from_category_id: string | null;
|
|
2873
|
+
get_product_id: string | null;
|
|
2874
|
+
get_variant_id: string | null;
|
|
2875
|
+
get_from_category_id: string | null;
|
|
2876
|
+
get_quantity: number;
|
|
2877
|
+
/** @enum {unknown} */
|
|
2878
|
+
get_offer_type: "discount" | "free";
|
|
2879
|
+
/** @description It can be null for get_offer_type = free */
|
|
2880
|
+
get_discount_percent: number | null;
|
|
2881
|
+
}[];
|
|
2882
|
+
/** @description It can be null for get_offer_type = free */
|
|
2883
|
+
maximum_discount_amount: number | null;
|
|
2884
|
+
};
|
|
2885
|
+
/** VolumeBasedRule */
|
|
2886
|
+
VolumeBasedRule: {
|
|
2887
|
+
products: {
|
|
2888
|
+
product_id: string | null;
|
|
2889
|
+
variant_id: string | null;
|
|
2890
|
+
slabs: {
|
|
2891
|
+
quantity: number;
|
|
2892
|
+
/** @enum {unknown} */
|
|
2893
|
+
condition: "less-or-equal" | "greater";
|
|
2894
|
+
discount_percent: number;
|
|
2895
|
+
}[];
|
|
2896
|
+
}[];
|
|
2897
|
+
maximum_discount_amount: number | null;
|
|
2898
|
+
};
|
|
2899
|
+
/** AcceleratedRewardRule */
|
|
2900
|
+
AcceleratedRewardRule: {
|
|
2901
|
+
products: {
|
|
2902
|
+
product_id: string | null;
|
|
2903
|
+
variant_id: string | null;
|
|
2904
|
+
minimum_quantity: number | null;
|
|
2905
|
+
minimum_value: number | null;
|
|
2906
|
+
}[];
|
|
2907
|
+
/** @description Array of category ids. */
|
|
2908
|
+
category_id: string[];
|
|
2909
|
+
bonus_loyalty_point: number;
|
|
2910
|
+
};
|
|
2911
|
+
/** CouponPromotionCommonDetail */
|
|
2912
|
+
CouponPromotionCommonDetail: {
|
|
2913
|
+
readonly id: string;
|
|
2914
|
+
name: string;
|
|
2915
|
+
description: string | null;
|
|
2916
|
+
tags: string[] | null;
|
|
2917
|
+
redemption_limits: {
|
|
2918
|
+
total_redemptions: number | null;
|
|
2919
|
+
per_customer_redemptions: number | null;
|
|
2920
|
+
per_coupon_code_redemptions: number | null;
|
|
2921
|
+
} | null;
|
|
2922
|
+
readonly redemption_count: number;
|
|
2923
|
+
/** @default 0 */
|
|
2924
|
+
minimum_order_total: number | null;
|
|
2760
2925
|
/** Format: date-time */
|
|
2761
|
-
|
|
2926
|
+
starts_at: string;
|
|
2762
2927
|
/** Format: date-time */
|
|
2763
|
-
|
|
2928
|
+
expires_at: string | null;
|
|
2764
2929
|
};
|
|
2930
|
+
/** DiscountCouponPromotion */
|
|
2931
|
+
DiscountCouponPromotion: components["schemas"]["CouponPromotionCommonDetail"] & {
|
|
2932
|
+
details: components["schemas"]["DiscountRule"];
|
|
2933
|
+
/** @enum {unknown} */
|
|
2934
|
+
applies_to_product: "all" | "product" | "category";
|
|
2935
|
+
};
|
|
2936
|
+
/** FreeGoodCouponPromotion */
|
|
2937
|
+
FreeGoodCouponPromotion: components["schemas"]["CouponPromotionCommonDetail"] & {
|
|
2938
|
+
details: components["schemas"]["FreeGoodsRule"];
|
|
2939
|
+
/** @enum {unknown} */
|
|
2940
|
+
applies_to_product: "product";
|
|
2941
|
+
};
|
|
2942
|
+
/** FixedPriceCouponPromotion */
|
|
2943
|
+
FixedPriceCouponPromotion: components["schemas"]["CouponPromotionCommonDetail"] & {
|
|
2944
|
+
details: components["schemas"]["FixedPriceRule"];
|
|
2945
|
+
/** @enum {unknown} */
|
|
2946
|
+
applies_to_product: "product";
|
|
2947
|
+
};
|
|
2948
|
+
/** BuyXGetYCouponPromotion */
|
|
2949
|
+
BuyXGetYCouponPromotion: components["schemas"]["CouponPromotionCommonDetail"] & {
|
|
2950
|
+
details: components["schemas"]["BuyXGetYRule"];
|
|
2951
|
+
/** @enum {unknown} */
|
|
2952
|
+
applies_to_product: "product";
|
|
2953
|
+
};
|
|
2954
|
+
/** VolumeBasedCouponPromotion */
|
|
2955
|
+
VolumeBasedCouponPromotion: components["schemas"]["CouponPromotionCommonDetail"] & {
|
|
2956
|
+
details: components["schemas"]["VolumeBasedRule"];
|
|
2957
|
+
/** @enum {unknown} */
|
|
2958
|
+
applies_to_product: "product";
|
|
2959
|
+
};
|
|
2960
|
+
/** AcceleratedRewardCouponPromotion */
|
|
2961
|
+
AcceleratedRewardCouponPromotion: components["schemas"]["CouponPromotionCommonDetail"] & {
|
|
2962
|
+
details: components["schemas"]["AcceleratedRewardRule"];
|
|
2963
|
+
/** @enum {unknown} */
|
|
2964
|
+
applies_to_product: "product" | "category";
|
|
2965
|
+
};
|
|
2966
|
+
/** FreeShipingCouponPromotion */
|
|
2967
|
+
FreeShipingCouponPromotion: components["schemas"]["CouponPromotionCommonDetail"];
|
|
2765
2968
|
/** CreateCustomer */
|
|
2766
2969
|
CreateCustomer: {
|
|
2767
2970
|
business?: components["schemas"]["Business"];
|
|
@@ -2880,30 +3083,9 @@ export interface components {
|
|
|
2880
3083
|
/** Format: double */
|
|
2881
3084
|
coupon_discount_amount?: number | null;
|
|
2882
3085
|
/** @description Information about the promotional offers that have been applied to the cart. */
|
|
2883
|
-
applied_promotions:
|
|
2884
|
-
promotion_id: string;
|
|
2885
|
-
/** @enum {unknown} */
|
|
2886
|
-
promotion_type: "discount" | "free-goods" | "free-shipping" | "buy-x-get-y" | "volume-based";
|
|
2887
|
-
savings: number;
|
|
2888
|
-
product_id: string | null;
|
|
2889
|
-
product_name: string | null;
|
|
2890
|
-
variant_id: string | null;
|
|
2891
|
-
variant_name: string | null;
|
|
2892
|
-
/** @enum {unknown} */
|
|
2893
|
-
scope: "catalog" | "global";
|
|
2894
|
-
applied_sequence: number;
|
|
2895
|
-
}[];
|
|
3086
|
+
applied_promotions: components["schemas"]["AppliedPromotion"][];
|
|
2896
3087
|
/** @description This key provides details about the savings in cart after coupon have been applied to the cart. */
|
|
2897
|
-
applied_coupons:
|
|
2898
|
-
coupon_id: string;
|
|
2899
|
-
/** @enum {unknown} */
|
|
2900
|
-
coupon_type: "discount" | "free-goods" | "fixed-price" | "free-shipping" | "buy-x-get-y" | "volume-based" | "accelerated-rewards";
|
|
2901
|
-
savings: number;
|
|
2902
|
-
product_id: string | null;
|
|
2903
|
-
product_name: string | null;
|
|
2904
|
-
variant_id: string | null;
|
|
2905
|
-
variant_name: string | null;
|
|
2906
|
-
}[];
|
|
3088
|
+
applied_coupons: components["schemas"]["AppliedCoupon"][];
|
|
2907
3089
|
/** Format: float */
|
|
2908
3090
|
promotion_savings?: number;
|
|
2909
3091
|
/** Format: float */
|
|
@@ -2983,50 +3165,57 @@ export interface components {
|
|
|
2983
3165
|
modified_at?: string;
|
|
2984
3166
|
};
|
|
2985
3167
|
OrderItem: {
|
|
2986
|
-
product_id
|
|
2987
|
-
product_name
|
|
2988
|
-
product_image_url
|
|
3168
|
+
product_id: string;
|
|
3169
|
+
product_name: string;
|
|
3170
|
+
product_image_url: string | null;
|
|
2989
3171
|
/** @enum {unknown} */
|
|
2990
|
-
product_type
|
|
2991
|
-
sku
|
|
2992
|
-
slug
|
|
2993
|
-
variant_id
|
|
2994
|
-
variant_name
|
|
2995
|
-
|
|
2996
|
-
|
|
2997
|
-
|
|
2998
|
-
|
|
2999
|
-
|
|
3000
|
-
|
|
3001
|
-
|
|
3002
|
-
|
|
3003
|
-
|
|
3004
|
-
|
|
3172
|
+
product_type: "physical" | "digital" | "bundle";
|
|
3173
|
+
sku: string;
|
|
3174
|
+
slug: string;
|
|
3175
|
+
variant_id: string | null;
|
|
3176
|
+
variant_name: string | null;
|
|
3177
|
+
/** @description
|
|
3178
|
+
* backorder
|
|
3179
|
+
*
|
|
3180
|
+
* Indicates whether the item is being fulfilled as a backorder. When true, the item is not currently in stock and will ship later once inventory is available. This may result in the order being split into multiple shipments, with delays for the backordered portion. */
|
|
3181
|
+
backorder: boolean;
|
|
3182
|
+
on_offer: boolean;
|
|
3183
|
+
on_promotion: boolean;
|
|
3184
|
+
on_subscription: boolean;
|
|
3185
|
+
subscription_plan: string | null;
|
|
3186
|
+
subscription_interval: number | null;
|
|
3187
|
+
subscription_frequency: string | null;
|
|
3188
|
+
quantity: number;
|
|
3189
|
+
free_quantity: number;
|
|
3190
|
+
is_free_item: boolean;
|
|
3191
|
+
price_including_tax: boolean;
|
|
3005
3192
|
/** Format: double */
|
|
3006
|
-
selling_price
|
|
3193
|
+
selling_price: number;
|
|
3007
3194
|
/** Format: double */
|
|
3008
|
-
listing_price
|
|
3195
|
+
listing_price: number;
|
|
3009
3196
|
/** Format: double */
|
|
3010
|
-
selling_price_excluding_tax
|
|
3197
|
+
selling_price_excluding_tax: number;
|
|
3011
3198
|
/** Format: double */
|
|
3012
|
-
promotion_discount_amount
|
|
3199
|
+
promotion_discount_amount: number;
|
|
3013
3200
|
/** Format: double */
|
|
3014
|
-
coupon_discount_amount
|
|
3201
|
+
coupon_discount_amount: number;
|
|
3015
3202
|
/**
|
|
3016
3203
|
* @default GST
|
|
3017
3204
|
* @constant
|
|
3018
3205
|
*/
|
|
3019
3206
|
tax_type: "GST";
|
|
3020
3207
|
/** Format: double */
|
|
3021
|
-
tax_rate
|
|
3208
|
+
tax_rate: number;
|
|
3022
3209
|
/** Format: double */
|
|
3023
|
-
tax_amount
|
|
3210
|
+
tax_amount: number;
|
|
3024
3211
|
/** Format: double */
|
|
3025
|
-
handling_charge_excluding_tax
|
|
3212
|
+
handling_charge_excluding_tax: number;
|
|
3026
3213
|
/** Format: double */
|
|
3027
|
-
handling_charge_tax_rate
|
|
3214
|
+
handling_charge_tax_rate: number;
|
|
3028
3215
|
/** Format: double */
|
|
3029
|
-
handling_charge_including_tax
|
|
3216
|
+
handling_charge_including_tax: number;
|
|
3217
|
+
associated_options?: components["schemas"]["AssociatedOption"] | null;
|
|
3218
|
+
attributes?: components["schemas"]["ProductAttribute"][];
|
|
3030
3219
|
};
|
|
3031
3220
|
/**
|
|
3032
3221
|
* OrderPayment
|
|
@@ -4121,21 +4310,93 @@ export interface components {
|
|
|
4121
4310
|
delivery_pincode: string;
|
|
4122
4311
|
cart_id: string;
|
|
4123
4312
|
};
|
|
4124
|
-
/**
|
|
4125
|
-
|
|
4126
|
-
|
|
4127
|
-
|
|
4128
|
-
|
|
4129
|
-
|
|
4130
|
-
|
|
4131
|
-
|
|
4132
|
-
|
|
4133
|
-
|
|
4134
|
-
|
|
4135
|
-
|
|
4136
|
-
|
|
4137
|
-
|
|
4138
|
-
}
|
|
4313
|
+
/** Coupon */
|
|
4314
|
+
Coupon: (components["schemas"]["DiscountCouponPromotion"] | components["schemas"]["FreeGoodCouponPromotion"] | components["schemas"]["FixedPriceCouponPromotion"] | components["schemas"]["BuyXGetYCouponPromotion"] | components["schemas"]["VolumeBasedCouponPromotion"] | components["schemas"]["FreeShipingCouponPromotion"] | components["schemas"]["AcceleratedRewardCouponPromotion"]) & {
|
|
4315
|
+
/** @enum {unknown} */
|
|
4316
|
+
coupon_type: "discount" | "free-goods" | "fixed-price" | "free-shipping" | "buy-x-get-y" | "volume-based" | "accelerated-rewards";
|
|
4317
|
+
coupon_code: string[];
|
|
4318
|
+
application_rules: {
|
|
4319
|
+
max_applicable_items: number;
|
|
4320
|
+
/** @enum {unknown} */
|
|
4321
|
+
application_priority: "cheapest_first" | "most_expensive_first" | "first_added";
|
|
4322
|
+
} | null;
|
|
4323
|
+
can_be_used_with_promotion: boolean;
|
|
4324
|
+
};
|
|
4325
|
+
/** Promotion */
|
|
4326
|
+
Promotion: (components["schemas"]["DiscountCouponPromotion"] | components["schemas"]["FreeGoodCouponPromotion"] | components["schemas"]["BuyXGetYCouponPromotion"] | components["schemas"]["VolumeBasedCouponPromotion"] | components["schemas"]["FreeShipingCouponPromotion"]) & {
|
|
4327
|
+
/** @enum {unknown} */
|
|
4328
|
+
promotion_type: "discount" | "free-goods" | "free-shipping" | "buy-x-get-y" | "volume-based";
|
|
4329
|
+
can_be_used_with_other_promotion: boolean;
|
|
4330
|
+
};
|
|
4331
|
+
/**
|
|
4332
|
+
* AppliedPromotion
|
|
4333
|
+
* @description Details about an active promotion applied to a cart/order
|
|
4334
|
+
*/
|
|
4335
|
+
AppliedPromotion: {
|
|
4336
|
+
promotion_id: string;
|
|
4337
|
+
/** @enum {unknown} */
|
|
4338
|
+
promotion_type: "discount" | "free-goods" | "free-shipping" | "buy-x-get-y" | "volume-based";
|
|
4339
|
+
savings: number;
|
|
4340
|
+
product_id: string | null;
|
|
4341
|
+
variant_id: string | null;
|
|
4342
|
+
product_name: string | null;
|
|
4343
|
+
variant_name: string | null;
|
|
4344
|
+
applied_sequence: number;
|
|
4345
|
+
scope: string;
|
|
4346
|
+
};
|
|
4347
|
+
/**
|
|
4348
|
+
* AppliedPromotion
|
|
4349
|
+
* @description Details about an active coupon applied to a cart/order
|
|
4350
|
+
*/
|
|
4351
|
+
AppliedCoupon: {
|
|
4352
|
+
coupon_id: string;
|
|
4353
|
+
/** @enum {unknown} */
|
|
4354
|
+
coupon_type: "discount" | "free-goods" | "fixed-price" | "free-shipping" | "buy-x-get-y" | "volume-based" | "accelerated-rewards";
|
|
4355
|
+
savings: number;
|
|
4356
|
+
product_id: string | null;
|
|
4357
|
+
variant_id: string | null;
|
|
4358
|
+
product_name: string | null;
|
|
4359
|
+
variant_name: string | null;
|
|
4360
|
+
};
|
|
4361
|
+
/** RegisterWithEmailPassword */
|
|
4362
|
+
RegisterWithEmailPassword: {
|
|
4363
|
+
/** Format: email */
|
|
4364
|
+
email: string;
|
|
4365
|
+
password: string;
|
|
4366
|
+
confirm_password: string;
|
|
4367
|
+
/** @description 10 digit phone number without country code. */
|
|
4368
|
+
phone?: string | null;
|
|
4369
|
+
/** @description Two-letter code begin with a plus sign prefix that identifies different countries. By default it will be +91 if not provided. */
|
|
4370
|
+
country_code?: string | null;
|
|
4371
|
+
};
|
|
4372
|
+
/** RegisterWithPhonePassword */
|
|
4373
|
+
RegisterWithPhonePassword: {
|
|
4374
|
+
/** @description Two-letter code begin with a plus sign prefix that identifies different countries. By default it will be +91 if not provided. */
|
|
4375
|
+
country_code?: string | null;
|
|
4376
|
+
/** @description 10 digit phone number without country code. */
|
|
4377
|
+
phone: string;
|
|
4378
|
+
password: string;
|
|
4379
|
+
confirm_password: string;
|
|
4380
|
+
email?: string | null;
|
|
4381
|
+
};
|
|
4382
|
+
/** GenerateOtpWithPhone */
|
|
4383
|
+
GenerateOtpWithPhone: {
|
|
4384
|
+
/** @enum {unknown} */
|
|
4385
|
+
channel: "sms" | "whatsapp";
|
|
4386
|
+
/** @description Two-letter code begin with a plus sign prefix that identifies different countries. By default it will be +91 if not provided. */
|
|
4387
|
+
country_code?: string | null;
|
|
4388
|
+
/** @description 10 digit phone number without country code. */
|
|
4389
|
+
phone: string;
|
|
4390
|
+
/** @enum {string} */
|
|
4391
|
+
otp_action: "register" | "reset-password" | "verify-phone" | "update-phone";
|
|
4392
|
+
};
|
|
4393
|
+
/** GenerateOtpWithEmail */
|
|
4394
|
+
GenerateOtpWithEmail: {
|
|
4395
|
+
/** @constant */
|
|
4396
|
+
channel: "email";
|
|
4397
|
+
email: string;
|
|
4398
|
+
/** @enum {string} */
|
|
4399
|
+
otp_action: "register" | "reset-password" | "verify-email" | "update-email";
|
|
4139
4400
|
};
|
|
4140
4401
|
};
|
|
4141
4402
|
responses: {
|
|
@@ -4419,6 +4680,9 @@ export interface operations {
|
|
|
4419
4680
|
};
|
|
4420
4681
|
};
|
|
4421
4682
|
};
|
|
4683
|
+
400: components["responses"]["BadRequest"];
|
|
4684
|
+
401: components["responses"]["Unauthorized"];
|
|
4685
|
+
404: components["responses"]["NotFound"];
|
|
4422
4686
|
};
|
|
4423
4687
|
};
|
|
4424
4688
|
"list-product-reviews": {
|
|
@@ -4686,6 +4950,9 @@ export interface operations {
|
|
|
4686
4950
|
};
|
|
4687
4951
|
};
|
|
4688
4952
|
};
|
|
4953
|
+
400: components["responses"]["BadRequest"];
|
|
4954
|
+
401: components["responses"]["Unauthorized"];
|
|
4955
|
+
404: components["responses"]["NotFound"];
|
|
4689
4956
|
};
|
|
4690
4957
|
};
|
|
4691
4958
|
"get-cart": {
|
|
@@ -4899,7 +5166,7 @@ export interface operations {
|
|
|
4899
5166
|
content: {
|
|
4900
5167
|
"application/json": {
|
|
4901
5168
|
shipping_provider_id: string;
|
|
4902
|
-
courier_company_id
|
|
5169
|
+
courier_company_id: string | null;
|
|
4903
5170
|
};
|
|
4904
5171
|
};
|
|
4905
5172
|
};
|
|
@@ -5194,6 +5461,9 @@ export interface operations {
|
|
|
5194
5461
|
};
|
|
5195
5462
|
};
|
|
5196
5463
|
};
|
|
5464
|
+
400: components["responses"]["BadRequest"];
|
|
5465
|
+
401: components["responses"]["Unauthorized"];
|
|
5466
|
+
404: components["responses"]["NotFound"];
|
|
5197
5467
|
};
|
|
5198
5468
|
};
|
|
5199
5469
|
"remove-gift-card": {
|
|
@@ -5225,12 +5495,18 @@ export interface operations {
|
|
|
5225
5495
|
};
|
|
5226
5496
|
};
|
|
5227
5497
|
};
|
|
5498
|
+
400: components["responses"]["BadRequest"];
|
|
5499
|
+
401: components["responses"]["Unauthorized"];
|
|
5500
|
+
404: components["responses"]["NotFound"];
|
|
5228
5501
|
};
|
|
5229
5502
|
};
|
|
5230
5503
|
"list-coupons": {
|
|
5231
5504
|
parameters: {
|
|
5232
5505
|
query?: never;
|
|
5233
|
-
header?:
|
|
5506
|
+
header?: {
|
|
5507
|
+
/** @description Commercengine customer group id. */
|
|
5508
|
+
ce_customer_group_id?: string | null;
|
|
5509
|
+
};
|
|
5234
5510
|
path?: never;
|
|
5235
5511
|
cookie?: never;
|
|
5236
5512
|
};
|
|
@@ -5251,12 +5527,18 @@ export interface operations {
|
|
|
5251
5527
|
};
|
|
5252
5528
|
};
|
|
5253
5529
|
};
|
|
5530
|
+
400: components["responses"]["BadRequest"];
|
|
5531
|
+
401: components["responses"]["Unauthorized"];
|
|
5532
|
+
404: components["responses"]["NotFound"];
|
|
5254
5533
|
};
|
|
5255
5534
|
};
|
|
5256
5535
|
"list-promotions": {
|
|
5257
5536
|
parameters: {
|
|
5258
5537
|
query?: never;
|
|
5259
|
-
header?:
|
|
5538
|
+
header?: {
|
|
5539
|
+
/** @description Commercengine customer group id. */
|
|
5540
|
+
ce_customer_group_id?: string | null;
|
|
5541
|
+
};
|
|
5260
5542
|
path?: never;
|
|
5261
5543
|
cookie?: never;
|
|
5262
5544
|
};
|
|
@@ -5272,7 +5554,7 @@ export interface operations {
|
|
|
5272
5554
|
message?: string;
|
|
5273
5555
|
success?: boolean;
|
|
5274
5556
|
content?: {
|
|
5275
|
-
promotions?: components["schemas"]["
|
|
5557
|
+
promotions?: components["schemas"]["Promotion"][];
|
|
5276
5558
|
};
|
|
5277
5559
|
};
|
|
5278
5560
|
};
|
|
@@ -5307,6 +5589,9 @@ export interface operations {
|
|
|
5307
5589
|
};
|
|
5308
5590
|
};
|
|
5309
5591
|
};
|
|
5592
|
+
400: components["responses"]["BadRequest"];
|
|
5593
|
+
401: components["responses"]["Unauthorized"];
|
|
5594
|
+
404: components["responses"]["NotFound"];
|
|
5310
5595
|
};
|
|
5311
5596
|
};
|
|
5312
5597
|
"add-to-wishlist": {
|
|
@@ -5343,6 +5628,7 @@ export interface operations {
|
|
|
5343
5628
|
};
|
|
5344
5629
|
};
|
|
5345
5630
|
};
|
|
5631
|
+
400: components["responses"]["BadRequest"];
|
|
5346
5632
|
401: components["responses"]["Unauthorized"];
|
|
5347
5633
|
404: components["responses"]["NotFound"];
|
|
5348
5634
|
};
|
|
@@ -5444,6 +5730,9 @@ export interface operations {
|
|
|
5444
5730
|
};
|
|
5445
5731
|
};
|
|
5446
5732
|
};
|
|
5733
|
+
400: components["responses"]["BadRequest"];
|
|
5734
|
+
401: components["responses"]["Unauthorized"];
|
|
5735
|
+
404: components["responses"]["NotFound"];
|
|
5447
5736
|
};
|
|
5448
5737
|
};
|
|
5449
5738
|
"update-customer": {
|
|
@@ -5517,6 +5806,9 @@ export interface operations {
|
|
|
5517
5806
|
};
|
|
5518
5807
|
};
|
|
5519
5808
|
};
|
|
5809
|
+
400: components["responses"]["BadRequest"];
|
|
5810
|
+
401: components["responses"]["Unauthorized"];
|
|
5811
|
+
404: components["responses"]["NotFound"];
|
|
5520
5812
|
};
|
|
5521
5813
|
};
|
|
5522
5814
|
"create-address": {
|
|
@@ -6141,6 +6433,9 @@ export interface operations {
|
|
|
6141
6433
|
};
|
|
6142
6434
|
};
|
|
6143
6435
|
};
|
|
6436
|
+
400: components["responses"]["BadRequest"];
|
|
6437
|
+
401: components["responses"]["Unauthorized"];
|
|
6438
|
+
404: components["responses"]["NotFound"];
|
|
6144
6439
|
};
|
|
6145
6440
|
};
|
|
6146
6441
|
"list-order-shipments": {
|
|
@@ -6304,6 +6599,9 @@ export interface operations {
|
|
|
6304
6599
|
};
|
|
6305
6600
|
};
|
|
6306
6601
|
};
|
|
6602
|
+
400: components["responses"]["BadRequest"];
|
|
6603
|
+
401: components["responses"]["Unauthorized"];
|
|
6604
|
+
404: components["responses"]["NotFound"];
|
|
6307
6605
|
};
|
|
6308
6606
|
};
|
|
6309
6607
|
"cancel-order": {
|
|
@@ -6388,17 +6686,18 @@ export interface operations {
|
|
|
6388
6686
|
404: components["responses"]["NotFound"];
|
|
6389
6687
|
};
|
|
6390
6688
|
};
|
|
6391
|
-
"
|
|
6689
|
+
"get-shipping-methods": {
|
|
6392
6690
|
parameters: {
|
|
6393
6691
|
query?: never;
|
|
6394
6692
|
header?: never;
|
|
6395
|
-
path
|
|
6396
|
-
/** @description delivery location pincode */
|
|
6397
|
-
pincode: string;
|
|
6398
|
-
};
|
|
6693
|
+
path?: never;
|
|
6399
6694
|
cookie?: never;
|
|
6400
6695
|
};
|
|
6401
|
-
requestBody
|
|
6696
|
+
requestBody: {
|
|
6697
|
+
content: {
|
|
6698
|
+
"application/json": components["schemas"]["CartBasedServiceabilityCheck"];
|
|
6699
|
+
};
|
|
6700
|
+
};
|
|
6402
6701
|
responses: {
|
|
6403
6702
|
/** @description OK */
|
|
6404
6703
|
200: {
|
|
@@ -6407,24 +6706,30 @@ export interface operations {
|
|
|
6407
6706
|
};
|
|
6408
6707
|
content: {
|
|
6409
6708
|
"application/json": {
|
|
6410
|
-
message
|
|
6411
|
-
success
|
|
6709
|
+
message: string;
|
|
6710
|
+
success: boolean;
|
|
6711
|
+
content: components["schemas"]["PincodeServiceability"];
|
|
6412
6712
|
};
|
|
6413
6713
|
};
|
|
6414
6714
|
};
|
|
6715
|
+
400: components["responses"]["BadRequest"];
|
|
6415
6716
|
401: components["responses"]["Unauthorized"];
|
|
6717
|
+
404: components["responses"]["NotFound"];
|
|
6416
6718
|
};
|
|
6417
6719
|
};
|
|
6418
|
-
"
|
|
6720
|
+
"check-pincode-serviceability": {
|
|
6419
6721
|
parameters: {
|
|
6420
6722
|
query?: never;
|
|
6421
6723
|
header?: never;
|
|
6422
|
-
path
|
|
6724
|
+
path: {
|
|
6725
|
+
/** @description delivery pincode */
|
|
6726
|
+
pincode: string;
|
|
6727
|
+
};
|
|
6423
6728
|
cookie?: never;
|
|
6424
6729
|
};
|
|
6425
6730
|
requestBody?: {
|
|
6426
6731
|
content: {
|
|
6427
|
-
"
|
|
6732
|
+
"*/*"?: never;
|
|
6428
6733
|
};
|
|
6429
6734
|
};
|
|
6430
6735
|
responses: {
|
|
@@ -6437,10 +6742,15 @@ export interface operations {
|
|
|
6437
6742
|
"application/json": {
|
|
6438
6743
|
message: string;
|
|
6439
6744
|
success: boolean;
|
|
6440
|
-
content
|
|
6745
|
+
content?: {
|
|
6746
|
+
is_serviceable?: boolean;
|
|
6747
|
+
};
|
|
6441
6748
|
};
|
|
6442
6749
|
};
|
|
6443
6750
|
};
|
|
6751
|
+
400: components["responses"]["BadRequest"];
|
|
6752
|
+
401: components["responses"]["Unauthorized"];
|
|
6753
|
+
404: components["responses"]["NotFound"];
|
|
6444
6754
|
};
|
|
6445
6755
|
};
|
|
6446
6756
|
"get-anonymous-token": {
|
|
@@ -6626,6 +6936,8 @@ export interface operations {
|
|
|
6626
6936
|
};
|
|
6627
6937
|
};
|
|
6628
6938
|
};
|
|
6939
|
+
400: components["responses"]["BadRequest"];
|
|
6940
|
+
401: components["responses"]["Unauthorized"];
|
|
6629
6941
|
};
|
|
6630
6942
|
};
|
|
6631
6943
|
"login-with-password": {
|
|
@@ -6754,11 +7066,9 @@ export interface operations {
|
|
|
6754
7066
|
/** @description A string representing the first name. */
|
|
6755
7067
|
first_name: string;
|
|
6756
7068
|
/** @description A string representing the last name. */
|
|
6757
|
-
last_name?: string;
|
|
7069
|
+
last_name?: string | null;
|
|
6758
7070
|
/** @description A string representing the email address. */
|
|
6759
|
-
email
|
|
6760
|
-
/** @description A string representing the OTP token. */
|
|
6761
|
-
otp_token?: string;
|
|
7071
|
+
email?: string | null;
|
|
6762
7072
|
};
|
|
6763
7073
|
};
|
|
6764
7074
|
};
|
|
@@ -6786,6 +7096,8 @@ export interface operations {
|
|
|
6786
7096
|
};
|
|
6787
7097
|
};
|
|
6788
7098
|
};
|
|
7099
|
+
400: components["responses"]["BadRequest"];
|
|
7100
|
+
401: components["responses"]["Unauthorized"];
|
|
6789
7101
|
};
|
|
6790
7102
|
};
|
|
6791
7103
|
"register-with-email": {
|
|
@@ -6803,11 +7115,9 @@ export interface operations {
|
|
|
6803
7115
|
/** @description A string representing the first name. */
|
|
6804
7116
|
first_name: string;
|
|
6805
7117
|
/** @description A string representing the last name. */
|
|
6806
|
-
last_name?: string;
|
|
7118
|
+
last_name?: string | null;
|
|
6807
7119
|
/** @description A string representing the phone number. */
|
|
6808
|
-
phone
|
|
6809
|
-
/** @description A string representing the OTP token. */
|
|
6810
|
-
otp_token?: string;
|
|
7120
|
+
phone?: string | null;
|
|
6811
7121
|
};
|
|
6812
7122
|
};
|
|
6813
7123
|
};
|
|
@@ -6835,6 +7145,8 @@ export interface operations {
|
|
|
6835
7145
|
};
|
|
6836
7146
|
};
|
|
6837
7147
|
};
|
|
7148
|
+
400: components["responses"]["BadRequest"];
|
|
7149
|
+
401: components["responses"]["Unauthorized"];
|
|
6838
7150
|
};
|
|
6839
7151
|
};
|
|
6840
7152
|
"register-with-whatsapp": {
|
|
@@ -6857,11 +7169,9 @@ export interface operations {
|
|
|
6857
7169
|
/** @description A string representing the first name. */
|
|
6858
7170
|
first_name: string;
|
|
6859
7171
|
/** @description A string representing the last name. */
|
|
6860
|
-
last_name?: string;
|
|
7172
|
+
last_name?: string | null;
|
|
6861
7173
|
/** @description A string representing the email address. */
|
|
6862
|
-
email
|
|
6863
|
-
/** @description A string representing the OTP token. */
|
|
6864
|
-
otp_token?: string;
|
|
7174
|
+
email?: string | null;
|
|
6865
7175
|
};
|
|
6866
7176
|
};
|
|
6867
7177
|
};
|
|
@@ -6889,6 +7199,8 @@ export interface operations {
|
|
|
6889
7199
|
};
|
|
6890
7200
|
};
|
|
6891
7201
|
};
|
|
7202
|
+
400: components["responses"]["BadRequest"];
|
|
7203
|
+
401: components["responses"]["Unauthorized"];
|
|
6892
7204
|
};
|
|
6893
7205
|
};
|
|
6894
7206
|
"register-with-password": {
|
|
@@ -6900,22 +7212,7 @@ export interface operations {
|
|
|
6900
7212
|
};
|
|
6901
7213
|
requestBody: {
|
|
6902
7214
|
content: {
|
|
6903
|
-
"application/json":
|
|
6904
|
-
/** @description Two-letter code begin with a plus sign prefix that identifies different countries. By default it will be +91 if not provided.
|
|
6905
|
-
* Use this key along with phone only. Not necessary for email. */
|
|
6906
|
-
country_code?: string;
|
|
6907
|
-
/** @description 10 digit phone number without country code. */
|
|
6908
|
-
phone: string;
|
|
6909
|
-
/**
|
|
6910
|
-
* Format: email
|
|
6911
|
-
* @description A string representing the email address.
|
|
6912
|
-
*/
|
|
6913
|
-
email: string;
|
|
6914
|
-
/** @description A string representing the user's chosen password. */
|
|
6915
|
-
password: string;
|
|
6916
|
-
/** @description A string representing the confirmation of the chosen password. */
|
|
6917
|
-
confirm_password: string;
|
|
6918
|
-
};
|
|
7215
|
+
"application/json": components["schemas"]["RegisterWithEmailPassword"] | components["schemas"]["RegisterWithPhonePassword"];
|
|
6919
7216
|
};
|
|
6920
7217
|
};
|
|
6921
7218
|
responses: {
|
|
@@ -6942,6 +7239,8 @@ export interface operations {
|
|
|
6942
7239
|
};
|
|
6943
7240
|
};
|
|
6944
7241
|
};
|
|
7242
|
+
400: components["responses"]["BadRequest"];
|
|
7243
|
+
401: components["responses"]["Unauthorized"];
|
|
6945
7244
|
};
|
|
6946
7245
|
};
|
|
6947
7246
|
"get-user-detail": {
|
|
@@ -7050,6 +7349,8 @@ export interface operations {
|
|
|
7050
7349
|
};
|
|
7051
7350
|
};
|
|
7052
7351
|
};
|
|
7352
|
+
400: components["responses"]["BadRequest"];
|
|
7353
|
+
401: components["responses"]["Unauthorized"];
|
|
7053
7354
|
404: components["responses"]["NotFound"];
|
|
7054
7355
|
};
|
|
7055
7356
|
};
|
|
@@ -7066,6 +7367,7 @@ export interface operations {
|
|
|
7066
7367
|
requestBody: {
|
|
7067
7368
|
content: {
|
|
7068
7369
|
"multipart/form-data": {
|
|
7370
|
+
/** Format: binary */
|
|
7069
7371
|
image?: string;
|
|
7070
7372
|
};
|
|
7071
7373
|
};
|
|
@@ -7090,6 +7392,8 @@ export interface operations {
|
|
|
7090
7392
|
};
|
|
7091
7393
|
};
|
|
7092
7394
|
};
|
|
7395
|
+
400: components["responses"]["BadRequest"];
|
|
7396
|
+
401: components["responses"]["Unauthorized"];
|
|
7093
7397
|
404: components["responses"]["NotFound"];
|
|
7094
7398
|
};
|
|
7095
7399
|
};
|
|
@@ -7106,6 +7410,7 @@ export interface operations {
|
|
|
7106
7410
|
requestBody: {
|
|
7107
7411
|
content: {
|
|
7108
7412
|
"multipart/form-data": {
|
|
7413
|
+
/** Format: binary */
|
|
7109
7414
|
image: string;
|
|
7110
7415
|
};
|
|
7111
7416
|
};
|
|
@@ -7130,6 +7435,8 @@ export interface operations {
|
|
|
7130
7435
|
};
|
|
7131
7436
|
};
|
|
7132
7437
|
};
|
|
7438
|
+
400: components["responses"]["BadRequest"];
|
|
7439
|
+
401: components["responses"]["Unauthorized"];
|
|
7133
7440
|
};
|
|
7134
7441
|
};
|
|
7135
7442
|
"remove-profile-image": {
|
|
@@ -7158,6 +7465,9 @@ export interface operations {
|
|
|
7158
7465
|
};
|
|
7159
7466
|
};
|
|
7160
7467
|
};
|
|
7468
|
+
400: components["responses"]["BadRequest"];
|
|
7469
|
+
401: components["responses"]["Unauthorized"];
|
|
7470
|
+
404: components["responses"]["NotFound"];
|
|
7161
7471
|
};
|
|
7162
7472
|
};
|
|
7163
7473
|
"deactivate-user": {
|
|
@@ -7186,6 +7496,9 @@ export interface operations {
|
|
|
7186
7496
|
};
|
|
7187
7497
|
};
|
|
7188
7498
|
};
|
|
7499
|
+
400: components["responses"]["BadRequest"];
|
|
7500
|
+
401: components["responses"]["Unauthorized"];
|
|
7501
|
+
404: components["responses"]["NotFound"];
|
|
7189
7502
|
};
|
|
7190
7503
|
};
|
|
7191
7504
|
"refresh-token": {
|
|
@@ -7314,6 +7627,9 @@ export interface operations {
|
|
|
7314
7627
|
};
|
|
7315
7628
|
};
|
|
7316
7629
|
};
|
|
7630
|
+
400: components["responses"]["BadRequest"];
|
|
7631
|
+
401: components["responses"]["Unauthorized"];
|
|
7632
|
+
404: components["responses"]["NotFound"];
|
|
7317
7633
|
};
|
|
7318
7634
|
};
|
|
7319
7635
|
"reset-password": {
|
|
@@ -7391,6 +7707,9 @@ export interface operations {
|
|
|
7391
7707
|
};
|
|
7392
7708
|
};
|
|
7393
7709
|
};
|
|
7710
|
+
400: components["responses"]["BadRequest"];
|
|
7711
|
+
401: components["responses"]["Unauthorized"];
|
|
7712
|
+
404: components["responses"]["NotFound"];
|
|
7394
7713
|
};
|
|
7395
7714
|
};
|
|
7396
7715
|
"update-notification-preferences": {
|
|
@@ -7431,6 +7750,9 @@ export interface operations {
|
|
|
7431
7750
|
};
|
|
7432
7751
|
};
|
|
7433
7752
|
};
|
|
7753
|
+
400: components["responses"]["BadRequest"];
|
|
7754
|
+
401: components["responses"]["Unauthorized"];
|
|
7755
|
+
404: components["responses"]["NotFound"];
|
|
7434
7756
|
};
|
|
7435
7757
|
};
|
|
7436
7758
|
"create-notification-preferences": {
|
|
@@ -7471,6 +7793,9 @@ export interface operations {
|
|
|
7471
7793
|
};
|
|
7472
7794
|
};
|
|
7473
7795
|
};
|
|
7796
|
+
400: components["responses"]["BadRequest"];
|
|
7797
|
+
401: components["responses"]["Unauthorized"];
|
|
7798
|
+
404: components["responses"]["NotFound"];
|
|
7474
7799
|
};
|
|
7475
7800
|
};
|
|
7476
7801
|
"generate-otp": {
|
|
@@ -7482,22 +7807,7 @@ export interface operations {
|
|
|
7482
7807
|
};
|
|
7483
7808
|
requestBody: {
|
|
7484
7809
|
content: {
|
|
7485
|
-
"application/json":
|
|
7486
|
-
/**
|
|
7487
|
-
* @description The communication channel for sending the OTP.
|
|
7488
|
-
* @enum {string}
|
|
7489
|
-
*/
|
|
7490
|
-
channel: "sms" | "email" | "whatsapp";
|
|
7491
|
-
/** @description Two-letter code begin with a plus sign prefix that identifies different countries. By default it will be +91 if not provided.
|
|
7492
|
-
* Use this key along with phone. Not necessary for email. */
|
|
7493
|
-
country_code?: string;
|
|
7494
|
-
/** @description 10 digit phone number without country code. */
|
|
7495
|
-
phone?: string;
|
|
7496
|
-
/** @description A string representing the email address. */
|
|
7497
|
-
email?: string;
|
|
7498
|
-
/** @enum {string} */
|
|
7499
|
-
otp_action: "login" | "register" | "reset-password" | "verify-phone" | "verify-email" | "update-phone" | "update-email";
|
|
7500
|
-
};
|
|
7810
|
+
"application/json": components["schemas"]["GenerateOtpWithPhone"] | components["schemas"]["GenerateOtpWithEmail"];
|
|
7501
7811
|
};
|
|
7502
7812
|
};
|
|
7503
7813
|
responses: {
|
|
@@ -7522,6 +7832,8 @@ export interface operations {
|
|
|
7522
7832
|
};
|
|
7523
7833
|
};
|
|
7524
7834
|
};
|
|
7835
|
+
400: components["responses"]["BadRequest"];
|
|
7836
|
+
401: components["responses"]["Unauthorized"];
|
|
7525
7837
|
};
|
|
7526
7838
|
};
|
|
7527
7839
|
logout: {
|
|
@@ -7556,6 +7868,9 @@ export interface operations {
|
|
|
7556
7868
|
};
|
|
7557
7869
|
};
|
|
7558
7870
|
};
|
|
7871
|
+
400: components["responses"]["BadRequest"];
|
|
7872
|
+
401: components["responses"]["Unauthorized"];
|
|
7873
|
+
404: components["responses"]["NotFound"];
|
|
7559
7874
|
};
|
|
7560
7875
|
};
|
|
7561
7876
|
"list-user-reviews": {
|
|
@@ -7586,6 +7901,9 @@ export interface operations {
|
|
|
7586
7901
|
};
|
|
7587
7902
|
};
|
|
7588
7903
|
};
|
|
7904
|
+
400: components["responses"]["BadRequest"];
|
|
7905
|
+
401: components["responses"]["Unauthorized"];
|
|
7906
|
+
404: components["responses"]["NotFound"];
|
|
7589
7907
|
};
|
|
7590
7908
|
};
|
|
7591
7909
|
"check-verification-status": {
|
|
@@ -7627,6 +7945,9 @@ export interface operations {
|
|
|
7627
7945
|
};
|
|
7628
7946
|
};
|
|
7629
7947
|
};
|
|
7948
|
+
400: components["responses"]["BadRequest"];
|
|
7949
|
+
401: components["responses"]["Unauthorized"];
|
|
7950
|
+
404: components["responses"]["NotFound"];
|
|
7630
7951
|
};
|
|
7631
7952
|
};
|
|
7632
7953
|
"generate-hash": {
|
|
@@ -7699,6 +8020,9 @@ export interface operations {
|
|
|
7699
8020
|
};
|
|
7700
8021
|
};
|
|
7701
8022
|
};
|
|
8023
|
+
400: components["responses"]["BadRequest"];
|
|
8024
|
+
401: components["responses"]["Unauthorized"];
|
|
8025
|
+
404: components["responses"]["NotFound"];
|
|
7702
8026
|
};
|
|
7703
8027
|
};
|
|
7704
8028
|
"list-saved-cards": {
|
|
@@ -7800,6 +8124,9 @@ export interface operations {
|
|
|
7800
8124
|
};
|
|
7801
8125
|
};
|
|
7802
8126
|
};
|
|
8127
|
+
400: components["responses"]["BadRequest"];
|
|
8128
|
+
401: components["responses"]["Unauthorized"];
|
|
8129
|
+
404: components["responses"]["NotFound"];
|
|
7803
8130
|
};
|
|
7804
8131
|
};
|
|
7805
8132
|
"create-juspay-order": {
|
|
@@ -7924,6 +8251,9 @@ export interface operations {
|
|
|
7924
8251
|
};
|
|
7925
8252
|
};
|
|
7926
8253
|
};
|
|
8254
|
+
400: components["responses"]["BadRequest"];
|
|
8255
|
+
401: components["responses"]["Unauthorized"];
|
|
8256
|
+
404: components["responses"]["NotFound"];
|
|
7927
8257
|
};
|
|
7928
8258
|
};
|
|
7929
8259
|
"list-country-states": {
|
|
@@ -7953,6 +8283,9 @@ export interface operations {
|
|
|
7953
8283
|
};
|
|
7954
8284
|
};
|
|
7955
8285
|
};
|
|
8286
|
+
400: components["responses"]["BadRequest"];
|
|
8287
|
+
401: components["responses"]["Unauthorized"];
|
|
8288
|
+
404: components["responses"]["NotFound"];
|
|
7956
8289
|
};
|
|
7957
8290
|
};
|
|
7958
8291
|
"list-country-pincodes": {
|
|
@@ -7989,6 +8322,9 @@ export interface operations {
|
|
|
7989
8322
|
};
|
|
7990
8323
|
};
|
|
7991
8324
|
};
|
|
8325
|
+
400: components["responses"]["BadRequest"];
|
|
8326
|
+
401: components["responses"]["Unauthorized"];
|
|
8327
|
+
404: components["responses"]["NotFound"];
|
|
7992
8328
|
};
|
|
7993
8329
|
};
|
|
7994
8330
|
"list-returns": {
|
|
@@ -8015,6 +8351,9 @@ export interface operations {
|
|
|
8015
8351
|
};
|
|
8016
8352
|
};
|
|
8017
8353
|
};
|
|
8354
|
+
400: components["responses"]["BadRequest"];
|
|
8355
|
+
401: components["responses"]["Unauthorized"];
|
|
8356
|
+
404: components["responses"]["NotFound"];
|
|
8018
8357
|
};
|
|
8019
8358
|
};
|
|
8020
8359
|
"track-analytics-event": {
|
|
@@ -8042,6 +8381,8 @@ export interface operations {
|
|
|
8042
8381
|
};
|
|
8043
8382
|
};
|
|
8044
8383
|
};
|
|
8384
|
+
400: components["responses"]["BadRequest"];
|
|
8385
|
+
401: components["responses"]["Unauthorized"];
|
|
8045
8386
|
};
|
|
8046
8387
|
};
|
|
8047
8388
|
"subscribe-newsletter": {
|
|
@@ -8071,6 +8412,8 @@ export interface operations {
|
|
|
8071
8412
|
};
|
|
8072
8413
|
};
|
|
8073
8414
|
};
|
|
8415
|
+
400: components["responses"]["BadRequest"];
|
|
8416
|
+
401: components["responses"]["Unauthorized"];
|
|
8074
8417
|
};
|
|
8075
8418
|
};
|
|
8076
8419
|
"list-subscriptions": {
|
|
@@ -8098,6 +8441,9 @@ export interface operations {
|
|
|
8098
8441
|
};
|
|
8099
8442
|
};
|
|
8100
8443
|
};
|
|
8444
|
+
400: components["responses"]["BadRequest"];
|
|
8445
|
+
401: components["responses"]["Unauthorized"];
|
|
8446
|
+
404: components["responses"]["NotFound"];
|
|
8101
8447
|
};
|
|
8102
8448
|
};
|
|
8103
8449
|
"create-subscription": {
|
|
@@ -8128,6 +8474,8 @@ export interface operations {
|
|
|
8128
8474
|
};
|
|
8129
8475
|
};
|
|
8130
8476
|
};
|
|
8477
|
+
400: components["responses"]["BadRequest"];
|
|
8478
|
+
401: components["responses"]["Unauthorized"];
|
|
8131
8479
|
};
|
|
8132
8480
|
};
|
|
8133
8481
|
"get-subscription": {
|
|
@@ -8157,6 +8505,9 @@ export interface operations {
|
|
|
8157
8505
|
};
|
|
8158
8506
|
};
|
|
8159
8507
|
};
|
|
8508
|
+
400: components["responses"]["BadRequest"];
|
|
8509
|
+
401: components["responses"]["Unauthorized"];
|
|
8510
|
+
404: components["responses"]["NotFound"];
|
|
8160
8511
|
};
|
|
8161
8512
|
};
|
|
8162
8513
|
"update-subscription": {
|
|
@@ -8190,6 +8541,9 @@ export interface operations {
|
|
|
8190
8541
|
};
|
|
8191
8542
|
};
|
|
8192
8543
|
};
|
|
8544
|
+
400: components["responses"]["BadRequest"];
|
|
8545
|
+
401: components["responses"]["Unauthorized"];
|
|
8546
|
+
404: components["responses"]["NotFound"];
|
|
8193
8547
|
};
|
|
8194
8548
|
};
|
|
8195
8549
|
}
|