@commercengine/pos 0.4.4 → 0.4.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/admin-types.d.mts +531 -258
- package/dist/admin-types.mjs +1 -1
- package/dist/index.d.mts +1565 -775
- package/dist/index.mjs +6 -14
- package/dist/index.mjs.map +1 -1
- package/package.json +7 -7
package/dist/index.d.mts
CHANGED
|
@@ -1,5 +1,4 @@
|
|
|
1
1
|
import createClient, { Middleware } from "openapi-fetch";
|
|
2
|
-
|
|
3
2
|
//#region src/types/pos.d.ts
|
|
4
3
|
/**
|
|
5
4
|
* This file was auto-generated by openapi-typescript.
|
|
@@ -11,8 +10,8 @@ type $Read$1<T> = {
|
|
|
11
10
|
type $Write$1<T> = {
|
|
12
11
|
readonly $write: T;
|
|
13
12
|
};
|
|
14
|
-
type Readable<T> = T extends $Write$1<any> ? never : T extends $Read$1<infer U> ? Readable<U> : T extends (infer E)[] ? Readable<E>[] : T extends object ? { [K in keyof T as NonNullable<T[K]> extends $Write$1<any> ? never : K]: Readable<T[K]
|
|
15
|
-
type Writable<T> = T extends $Read$1<any> ? never : T extends $Write$1<infer U> ? Writable<U> : T extends (infer E)[] ? Writable<E>[] : T extends object ? { [K in keyof T as NonNullable<T[K]> extends $Read$1<any> ? never : K]: Writable<T[K]
|
|
13
|
+
type Readable<T> = T extends $Write$1<any> ? never : T extends $Read$1<infer U> ? Readable<U> : T extends (infer E)[] ? Readable<E>[] : T extends object ? { [K in keyof T as NonNullable<T[K]> extends $Write$1<any> ? never : K]: Readable<T[K]>; } : T;
|
|
14
|
+
type Writable<T> = T extends $Read$1<any> ? never : T extends $Write$1<infer U> ? Writable<U> : T extends (infer E)[] ? Writable<E>[] : T extends object ? { [K in keyof T as NonNullable<T[K]> extends $Read$1<any> ? never : K]: Writable<T[K]>; } & { [K in keyof T as NonNullable<T[K]> extends $Read$1<any> ? K : never]?: never; } : T;
|
|
16
15
|
interface paths {
|
|
17
16
|
"/pos/auth/login/email": {
|
|
18
17
|
parameters: {
|
|
@@ -833,26 +832,33 @@ interface paths {
|
|
|
833
832
|
}
|
|
834
833
|
interface components {
|
|
835
834
|
schemas: {
|
|
836
|
-
/** AcceleratedRewardCouponPromotion */
|
|
837
|
-
|
|
835
|
+
/** AcceleratedRewardCouponPromotion */
|
|
836
|
+
AcceleratedRewardCouponPromotion: components["schemas"]["CouponPromotionCommonDetail"] & {
|
|
837
|
+
details: components["schemas"]["AcceleratedRewardRule"];
|
|
838
|
+
/** @enum {unknown} */
|
|
838
839
|
applies_to_product: "product" | "category";
|
|
839
|
-
};
|
|
840
|
+
};
|
|
841
|
+
/** AcceleratedRewardRule */
|
|
840
842
|
AcceleratedRewardRule: {
|
|
841
843
|
products: {
|
|
842
844
|
product_id: string | null;
|
|
843
845
|
variant_id: string | null;
|
|
844
846
|
minimum_quantity: number | null;
|
|
845
847
|
minimum_value: number | null;
|
|
846
|
-
}[];
|
|
848
|
+
}[];
|
|
849
|
+
/** @description Array of category ids. */
|
|
847
850
|
category_id: string[];
|
|
848
851
|
bonus_loyalty_point: number;
|
|
849
|
-
};
|
|
852
|
+
};
|
|
853
|
+
/** AdditionalProductDetails */
|
|
850
854
|
AdditionalProductDetails: {
|
|
851
855
|
description: string | null;
|
|
852
856
|
hsn_code: string | null;
|
|
853
857
|
videos: components["schemas"]["ProductVideo"][];
|
|
854
|
-
shipping: components["schemas"]["ProductShipping"];
|
|
855
|
-
|
|
858
|
+
shipping: components["schemas"]["ProductShipping"];
|
|
859
|
+
/** @description An array of product IDs */
|
|
860
|
+
upselling_product_ids: (string | null)[];
|
|
861
|
+
/** @description An array of product IDs */
|
|
856
862
|
crossselling_product_ids: string[];
|
|
857
863
|
seo: components["schemas"]["Seo"];
|
|
858
864
|
metadata: {
|
|
@@ -879,7 +885,8 @@ interface components {
|
|
|
879
885
|
* @description Details about an active coupon applied to a cart/order
|
|
880
886
|
*/
|
|
881
887
|
AppliedCoupon: {
|
|
882
|
-
coupon_id: string;
|
|
888
|
+
coupon_id: string;
|
|
889
|
+
/** @enum {unknown} */
|
|
883
890
|
coupon_type: "discount" | "free-goods" | "fixed-price" | "free-shipping" | "buy-x-get-y" | "volume-based" | "accelerated-rewards";
|
|
884
891
|
savings: number;
|
|
885
892
|
product_id: string | null;
|
|
@@ -892,7 +899,8 @@ interface components {
|
|
|
892
899
|
* @description Details about an active promotion applied to a cart/order
|
|
893
900
|
*/
|
|
894
901
|
AppliedPromotion: {
|
|
895
|
-
promotion_id: string;
|
|
902
|
+
promotion_id: string;
|
|
903
|
+
/** @enum {unknown} */
|
|
896
904
|
promotion_type: "discount" | "free-goods" | "free-shipping" | "buy-x-get-y" | "volume-based";
|
|
897
905
|
savings: number;
|
|
898
906
|
product_id: string | null;
|
|
@@ -923,29 +931,37 @@ interface components {
|
|
|
923
931
|
*/
|
|
924
932
|
AssociatedOption: {
|
|
925
933
|
[key: string]: components["schemas"]["ColorOption"] | components["schemas"]["SingleSelectOption"];
|
|
926
|
-
};
|
|
934
|
+
};
|
|
935
|
+
/** AutoScaleBasedOnAmount */
|
|
927
936
|
AutoScaleBasedOnAmount: {
|
|
928
|
-
/** @constant */
|
|
937
|
+
/** @constant */
|
|
938
|
+
spending_criteria_type: "minimum-purchase-amount";
|
|
929
939
|
products: {
|
|
930
940
|
product_id: string | null;
|
|
931
|
-
variant_id: string | null;
|
|
941
|
+
variant_id: string | null;
|
|
942
|
+
/** @constant */
|
|
932
943
|
auto_scale: true;
|
|
933
944
|
slab: {
|
|
934
945
|
minimum_purchase_amount: number;
|
|
935
|
-
get_quantity: number;
|
|
946
|
+
get_quantity: number;
|
|
947
|
+
/** @enum {unknown} */
|
|
936
948
|
condition: "greater-or-equal";
|
|
937
949
|
};
|
|
938
950
|
}[];
|
|
939
|
-
};
|
|
951
|
+
};
|
|
952
|
+
/** AutoScaleBasedOnQuantity */
|
|
940
953
|
AutoScaleBasedOnQuantity: {
|
|
941
|
-
/** @constant */
|
|
954
|
+
/** @constant */
|
|
955
|
+
spending_criteria_type: "minimum-quantity";
|
|
942
956
|
products: {
|
|
943
957
|
product_id: string | null;
|
|
944
|
-
variant_id: string | null;
|
|
958
|
+
variant_id: string | null;
|
|
959
|
+
/** @constant */
|
|
945
960
|
auto_scale: true;
|
|
946
961
|
slab: {
|
|
947
962
|
buy_quantity: number;
|
|
948
|
-
get_quantity: number;
|
|
963
|
+
get_quantity: number;
|
|
964
|
+
/** @enum {unknown} */
|
|
949
965
|
condition: "greater-or-equal";
|
|
950
966
|
};
|
|
951
967
|
}[];
|
|
@@ -968,19 +984,24 @@ interface components {
|
|
|
968
984
|
*/
|
|
969
985
|
BooleanAttribute: {
|
|
970
986
|
id: string;
|
|
971
|
-
name: string;
|
|
987
|
+
name: string;
|
|
988
|
+
/** @description A lookup safe version of the name that is lowercased and spaces are replaced with underscores. For instance, if name is `Product Type`, key will be `product_type` */
|
|
972
989
|
key: string;
|
|
973
990
|
/**
|
|
974
991
|
* @description discriminator enum property added by openapi-typescript
|
|
975
992
|
* @enum {string}
|
|
976
993
|
*/
|
|
977
|
-
type: "boolean";
|
|
994
|
+
type: "boolean";
|
|
995
|
+
/** @description For boolean attributes */
|
|
978
996
|
value: boolean;
|
|
979
|
-
};
|
|
997
|
+
};
|
|
998
|
+
/** BuyXGetYCouponPromotion */
|
|
980
999
|
BuyXGetYCouponPromotion: components["schemas"]["CouponPromotionCommonDetail"] & {
|
|
981
|
-
details: components["schemas"]["BuyXGetYRule"];
|
|
1000
|
+
details: components["schemas"]["BuyXGetYRule"];
|
|
1001
|
+
/** @enum {unknown} */
|
|
982
1002
|
applies_to_product: "product";
|
|
983
|
-
};
|
|
1003
|
+
};
|
|
1004
|
+
/** BuyXGetYRule */
|
|
984
1005
|
BuyXGetYRule: components["schemas"]["BuyXGetYRuleBasedOnQuantity"] | components["schemas"]["BuyXGetYRuleBasedOnAmount"];
|
|
985
1006
|
/**
|
|
986
1007
|
* BuyXGetYRuleBasedOnAmount
|
|
@@ -990,7 +1011,8 @@ interface components {
|
|
|
990
1011
|
* 3) get_free_quantity or get_discount_percent
|
|
991
1012
|
*/
|
|
992
1013
|
BuyXGetYRuleBasedOnAmount: {
|
|
993
|
-
/** @constant */
|
|
1014
|
+
/** @constant */
|
|
1015
|
+
spending_criteria_type: "minimum-purchase-amount";
|
|
994
1016
|
products: {
|
|
995
1017
|
minimum_purchase_amount: number;
|
|
996
1018
|
buy_product_id: string | null;
|
|
@@ -999,10 +1021,13 @@ interface components {
|
|
|
999
1021
|
get_product_id: string | null;
|
|
1000
1022
|
get_variant_id: string | null;
|
|
1001
1023
|
get_from_category_id: string | null;
|
|
1002
|
-
get_quantity: number;
|
|
1003
|
-
|
|
1024
|
+
get_quantity: number;
|
|
1025
|
+
/** @enum {unknown} */
|
|
1026
|
+
get_offer_type: "discount" | "free";
|
|
1027
|
+
/** @description It can be null for get_offer_type = free */
|
|
1004
1028
|
get_discount_percent: number | null;
|
|
1005
|
-
}[];
|
|
1029
|
+
}[];
|
|
1030
|
+
/** @description It can be null for get_offer_type = free */
|
|
1006
1031
|
maximum_discount_amount: number | null;
|
|
1007
1032
|
};
|
|
1008
1033
|
/**
|
|
@@ -1013,7 +1038,8 @@ interface components {
|
|
|
1013
1038
|
* 3) get_free_quantity or get_discount_percent
|
|
1014
1039
|
*/
|
|
1015
1040
|
BuyXGetYRuleBasedOnQuantity: {
|
|
1016
|
-
/** @constant */
|
|
1041
|
+
/** @constant */
|
|
1042
|
+
spending_criteria_type: "minimum-quantity";
|
|
1017
1043
|
products: {
|
|
1018
1044
|
minimum_quantity: number;
|
|
1019
1045
|
buy_product_id: string | null;
|
|
@@ -1022,10 +1048,13 @@ interface components {
|
|
|
1022
1048
|
get_product_id: string | null;
|
|
1023
1049
|
get_variant_id: string | null;
|
|
1024
1050
|
get_from_category_id: string | null;
|
|
1025
|
-
get_quantity: number;
|
|
1026
|
-
|
|
1051
|
+
get_quantity: number;
|
|
1052
|
+
/** @enum {unknown} */
|
|
1053
|
+
get_offer_type: "discount" | "free";
|
|
1054
|
+
/** @description It can be null for get_offer_type = free */
|
|
1027
1055
|
get_discount_percent: number | null;
|
|
1028
|
-
}[];
|
|
1056
|
+
}[];
|
|
1057
|
+
/** @description It can be null for get_offer_type = free */
|
|
1029
1058
|
maximum_discount_amount: number | null;
|
|
1030
1059
|
};
|
|
1031
1060
|
/**
|
|
@@ -1037,7 +1066,8 @@ interface components {
|
|
|
1037
1066
|
* @description masked card number
|
|
1038
1067
|
* e.g. ************1111
|
|
1039
1068
|
*/
|
|
1040
|
-
card_number?: string;
|
|
1069
|
+
card_number?: string;
|
|
1070
|
+
/** @enum {string} */
|
|
1041
1071
|
card_type?: "Visa" | "Master Card" | "Rupay" | "American Express";
|
|
1042
1072
|
};
|
|
1043
1073
|
/**
|
|
@@ -1045,11 +1075,17 @@ interface components {
|
|
|
1045
1075
|
* @description This cart model is structured to capture a wide range of details, facilitating accurate representation and management of user shopping carts in an e-commerce platform.
|
|
1046
1076
|
*/
|
|
1047
1077
|
Cart: {
|
|
1048
|
-
/** @description Unique identifier for the cart. */
|
|
1049
|
-
|
|
1050
|
-
|
|
1051
|
-
|
|
1052
|
-
|
|
1078
|
+
/** @description Unique identifier for the cart. */
|
|
1079
|
+
id: string;
|
|
1080
|
+
/** @description Indicates whether the cart is currently active or inactive. */
|
|
1081
|
+
active: boolean;
|
|
1082
|
+
/** @description customer note for shipping or product customization. */
|
|
1083
|
+
customer_note: string | null;
|
|
1084
|
+
/** @description Indicates if a promotion is applied or not. */
|
|
1085
|
+
is_promotion_applied: boolean;
|
|
1086
|
+
/** @description Indicates if a coupon is applied or not. */
|
|
1087
|
+
is_coupon_applied: boolean;
|
|
1088
|
+
/** @description Code of the applied coupon. */
|
|
1053
1089
|
coupon_code: string | null;
|
|
1054
1090
|
/**
|
|
1055
1091
|
* Format: double
|
|
@@ -1085,12 +1121,18 @@ interface components {
|
|
|
1085
1121
|
* Format: double
|
|
1086
1122
|
* @description Subtotal including tax.
|
|
1087
1123
|
*/
|
|
1088
|
-
subtotal_including_tax: number;
|
|
1089
|
-
|
|
1090
|
-
|
|
1091
|
-
|
|
1092
|
-
|
|
1093
|
-
|
|
1124
|
+
subtotal_including_tax: number;
|
|
1125
|
+
/** @description Estimated cost of shipping. */
|
|
1126
|
+
shipping_estimated_cost: number | null;
|
|
1127
|
+
/** @description Discount applied on estimated shipping cost. */
|
|
1128
|
+
shipping_discount_amount: number | null;
|
|
1129
|
+
/** @description Shipping amount chargable to customer. */
|
|
1130
|
+
shipping_amount: number | null;
|
|
1131
|
+
/** @description Shipping tax rate applied on shipping amount. */
|
|
1132
|
+
shipping_tax_rate: number | null;
|
|
1133
|
+
/** @description Tax applied on shipping_amount. */
|
|
1134
|
+
shipping_tax_amount: number | null;
|
|
1135
|
+
/** @description Shipping amount including shipping tax. */
|
|
1094
1136
|
shipping_amount_including_tax: number | null;
|
|
1095
1137
|
fulfillment_preference?: components["schemas"]["FulfillmentPreference"];
|
|
1096
1138
|
estimated_delivery_days: number | null;
|
|
@@ -1098,8 +1140,10 @@ interface components {
|
|
|
1098
1140
|
* Format: double
|
|
1099
1141
|
* @description The additional charge applied to cover the costs associated with processing, packaging, and handling an order. This fee is separate from shipping charges and may include materials, or special handling requirements.
|
|
1100
1142
|
*/
|
|
1101
|
-
handling_charge_excluding_tax: number;
|
|
1102
|
-
|
|
1143
|
+
handling_charge_excluding_tax: number;
|
|
1144
|
+
/** Format: double */
|
|
1145
|
+
handling_charge_tax_amount: number;
|
|
1146
|
+
/** Format: double */
|
|
1103
1147
|
handling_charge_including_tax: number;
|
|
1104
1148
|
/**
|
|
1105
1149
|
* Format: double
|
|
@@ -1120,14 +1164,22 @@ interface components {
|
|
|
1120
1164
|
* Format: double
|
|
1121
1165
|
* @description Amount to be paid by the customer.
|
|
1122
1166
|
*/
|
|
1123
|
-
to_be_paid: number;
|
|
1124
|
-
|
|
1125
|
-
|
|
1126
|
-
|
|
1127
|
-
|
|
1128
|
-
|
|
1129
|
-
|
|
1130
|
-
|
|
1167
|
+
to_be_paid: number;
|
|
1168
|
+
/** @description Number of loyalty points redeemed. */
|
|
1169
|
+
loyalty_points_redeemed: number;
|
|
1170
|
+
/** @description Number of loyalty points earned. */
|
|
1171
|
+
loyalty_points_earned: number;
|
|
1172
|
+
/** @description Number of items in the cart. */
|
|
1173
|
+
cart_items_count: number;
|
|
1174
|
+
/** @description List containing detailed information about each item in the cart. */
|
|
1175
|
+
cart_items: components["schemas"]["CartItem"][];
|
|
1176
|
+
/** @description Details of the billing address. */
|
|
1177
|
+
billing_address: components["schemas"]["CustomerAddress"];
|
|
1178
|
+
/** @description Details of the shipping address. */
|
|
1179
|
+
shipping_address: components["schemas"]["CustomerAddress"];
|
|
1180
|
+
/** @description Details about the currency being used, including `name`, `code`, and `symbol`. */
|
|
1181
|
+
currency: components["schemas"]["Currency"];
|
|
1182
|
+
/** @description Additional metadata associated with the cart. */
|
|
1131
1183
|
metadata: {
|
|
1132
1184
|
[key: string]: string;
|
|
1133
1185
|
} | null;
|
|
@@ -1135,25 +1187,36 @@ interface components {
|
|
|
1135
1187
|
* Format: date-time
|
|
1136
1188
|
* @description ISO 8601 timestamp when this cart expires. After expiry, the cart is no longer valid and a new cart must be created.
|
|
1137
1189
|
*/
|
|
1138
|
-
expires_at: string | null;
|
|
1139
|
-
|
|
1140
|
-
|
|
1141
|
-
|
|
1142
|
-
|
|
1143
|
-
|
|
1144
|
-
|
|
1145
|
-
|
|
1190
|
+
expires_at: string | null;
|
|
1191
|
+
/** @description Information about the promotional offers that have been applied to the cart. */
|
|
1192
|
+
applied_promotions: components["schemas"]["AppliedPromotion"][];
|
|
1193
|
+
/** @description This key provides details about the savings in cart after coupon have been applied to the cart. */
|
|
1194
|
+
applied_coupons: components["schemas"]["AppliedCoupon"][];
|
|
1195
|
+
/** @description List containing detailed information about each shipment in the cart. */
|
|
1196
|
+
shipments: components["schemas"]["CartShipment"][];
|
|
1197
|
+
/** @description Total savings from auto-applied promotions. */
|
|
1198
|
+
promotion_savings: number;
|
|
1199
|
+
/** @description Total savings from the applied coupon code. */
|
|
1200
|
+
coupon_savings: number;
|
|
1201
|
+
/** @description Total savings from loyalty points, credit balance, and other non-promotion/coupon discounts. */
|
|
1202
|
+
other_savings: number;
|
|
1203
|
+
/** @description Combined savings across promotions, coupons, and other discounts (`promotion_savings` + `coupon_savings` + `other_savings`). */
|
|
1204
|
+
total_savings: number;
|
|
1205
|
+
/** @description Free shipping threshold of the cart */
|
|
1146
1206
|
free_shipping_threshold: number | null;
|
|
1147
1207
|
/**
|
|
1148
1208
|
* @description Checkout readiness of the cart. A cart is `ready-for-payment` only when it has items, a valid address, and a fulfillment preference set. Use `status_error_message` for the specific reason when `not-ready-for-payment`.
|
|
1149
1209
|
* @default not-ready-for-payment
|
|
1150
1210
|
* @enum {string}
|
|
1151
1211
|
*/
|
|
1152
|
-
status: "not-ready-for-payment" | "ready-for-payment";
|
|
1212
|
+
status: "not-ready-for-payment" | "ready-for-payment";
|
|
1213
|
+
/** @description Human-readable reason why the cart is not ready for payment. `null` when `status` is `ready-for-payment`. */
|
|
1153
1214
|
status_error_message: string | null;
|
|
1154
|
-
};
|
|
1215
|
+
};
|
|
1216
|
+
/** CartBasedFulfillmentOption */
|
|
1155
1217
|
CartBasedFulfillmentOption: {
|
|
1156
|
-
cart_id: string;
|
|
1218
|
+
cart_id: string;
|
|
1219
|
+
/** @enum {string} */
|
|
1157
1220
|
fulfillment_type?: "delivery" | "collect-in-store";
|
|
1158
1221
|
};
|
|
1159
1222
|
/**
|
|
@@ -1161,28 +1224,41 @@ interface components {
|
|
|
1161
1224
|
* @description This Cart Item model captures the attributes of a cart item, including product details, pricing information, subscription details, and other relevant information related to Cart Item.
|
|
1162
1225
|
*/
|
|
1163
1226
|
CartItem: {
|
|
1164
|
-
/** @description Unique identifier for the product. */
|
|
1227
|
+
/** @description Unique identifier for the product. */
|
|
1228
|
+
product_id: string;
|
|
1229
|
+
/** @description The product variant identifier. `null` if the product has no variants. */
|
|
1165
1230
|
variant_id: string | null;
|
|
1166
1231
|
/**
|
|
1167
1232
|
* @description Stock Keeping Unit, a unique identifier for the product within inventory.
|
|
1168
1233
|
* @example SKU1254
|
|
1169
1234
|
*/
|
|
1170
|
-
sku: string | null;
|
|
1171
|
-
|
|
1172
|
-
|
|
1235
|
+
sku: string | null;
|
|
1236
|
+
/** @description Unique slug for the product */
|
|
1237
|
+
slug: string;
|
|
1238
|
+
/** @description Name of the product. */
|
|
1239
|
+
product_name: string;
|
|
1240
|
+
/** @description Name of the variant. */
|
|
1173
1241
|
variant_name: string | null;
|
|
1174
1242
|
/**
|
|
1175
1243
|
* @example physical
|
|
1176
1244
|
* @enum {string}
|
|
1177
1245
|
*/
|
|
1178
|
-
product_type: "physical" | "digital" | "bundle";
|
|
1179
|
-
|
|
1180
|
-
|
|
1181
|
-
|
|
1182
|
-
|
|
1183
|
-
|
|
1184
|
-
|
|
1185
|
-
|
|
1246
|
+
product_type: "physical" | "digital" | "bundle";
|
|
1247
|
+
/** @description URL pointing to the product image. */
|
|
1248
|
+
product_image_url: string;
|
|
1249
|
+
/** @description Indicates whether the product is currently in stock. */
|
|
1250
|
+
stock_available: boolean;
|
|
1251
|
+
/** @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. */
|
|
1252
|
+
backorder: boolean;
|
|
1253
|
+
/** @description Indicates whether the product is currently on a subscription. */
|
|
1254
|
+
on_subscription: boolean;
|
|
1255
|
+
/** @description Indicates whether the product is part of a promotion. */
|
|
1256
|
+
on_promotion: boolean;
|
|
1257
|
+
/** @description The quantity of the product in the cart. */
|
|
1258
|
+
quantity: number;
|
|
1259
|
+
/** @description Indicates if the product is offered for free. */
|
|
1260
|
+
is_free_item: boolean;
|
|
1261
|
+
/** @description Quantity of the product that is free. */
|
|
1186
1262
|
free_quantity: number;
|
|
1187
1263
|
/**
|
|
1188
1264
|
* Format: double
|
|
@@ -1208,13 +1284,19 @@ interface components {
|
|
|
1208
1284
|
* Format: double
|
|
1209
1285
|
* @example 199
|
|
1210
1286
|
*/
|
|
1211
|
-
selling_price: number;
|
|
1212
|
-
|
|
1287
|
+
selling_price: number;
|
|
1288
|
+
/** Format: double */
|
|
1289
|
+
selling_price_excluding_tax: number;
|
|
1290
|
+
/** @default 1 */
|
|
1213
1291
|
min_order_quantity: number;
|
|
1214
|
-
max_order_quantity: number | null;
|
|
1215
|
-
|
|
1216
|
-
|
|
1217
|
-
|
|
1292
|
+
max_order_quantity: number | null;
|
|
1293
|
+
/** @default 1 */
|
|
1294
|
+
incremental_quantity: number;
|
|
1295
|
+
/** @description Additional cost for shipping associated with the product. */
|
|
1296
|
+
handling_charge_excluding_tax: $Read$1<number>;
|
|
1297
|
+
/** @description Additional cost for shipping associated with the product. */
|
|
1298
|
+
handling_charge_tax_rate: $Read$1<number>;
|
|
1299
|
+
/** @description Additional cost for shipping associated with the product. */
|
|
1218
1300
|
handling_charge_including_tax: $Read$1<number>;
|
|
1219
1301
|
/**
|
|
1220
1302
|
* @description Type of tax applied (e.g., GST).
|
|
@@ -1234,8 +1316,10 @@ interface components {
|
|
|
1234
1316
|
tax_amount: number;
|
|
1235
1317
|
associated_options: components["schemas"]["AssociatedOption"] | null;
|
|
1236
1318
|
attributes: components["schemas"]["ProductAttribute"][];
|
|
1237
|
-
subscriptions: components["schemas"]["ProductSubscription"][] | null;
|
|
1238
|
-
|
|
1319
|
+
subscriptions: components["schemas"]["ProductSubscription"][] | null;
|
|
1320
|
+
/** @description Seller ID. This field is relevant for marketplace type stores only. Will return null for b2b and b2c type stores. */
|
|
1321
|
+
seller_id?: string | null;
|
|
1322
|
+
/** @description Seller detail information. This field is relevant for marketplace type stores only. Will return null for b2b and b2c type stores. */
|
|
1239
1323
|
seller_detail?: components["schemas"]["SellerInfo"] | null;
|
|
1240
1324
|
};
|
|
1241
1325
|
/**
|
|
@@ -1247,13 +1331,17 @@ interface components {
|
|
|
1247
1331
|
shipping_provider_id?: string;
|
|
1248
1332
|
shipping_provider_name?: string;
|
|
1249
1333
|
courier_company_id?: string | null;
|
|
1250
|
-
courier_company_name?: string | null;
|
|
1251
|
-
|
|
1252
|
-
|
|
1334
|
+
courier_company_name?: string | null;
|
|
1335
|
+
/** Format: double */
|
|
1336
|
+
shipping_amount?: number;
|
|
1337
|
+
/** Format: double */
|
|
1338
|
+
shipping_tax_amount?: number;
|
|
1339
|
+
/** Format: double */
|
|
1253
1340
|
shipping_amount_including_tax?: number;
|
|
1254
1341
|
shipment_items_count?: number;
|
|
1255
1342
|
shipment_items?: components["schemas"]["ShipmentItem"][];
|
|
1256
|
-
};
|
|
1343
|
+
};
|
|
1344
|
+
/** Category */
|
|
1257
1345
|
Category: {
|
|
1258
1346
|
id: $Read$1<string>;
|
|
1259
1347
|
name: $Read$1<string>;
|
|
@@ -1262,7 +1350,8 @@ interface components {
|
|
|
1262
1350
|
parent_category_id: $Read$1<string | null>;
|
|
1263
1351
|
product_count: number;
|
|
1264
1352
|
active: boolean;
|
|
1265
|
-
};
|
|
1353
|
+
};
|
|
1354
|
+
/** CollectInStore */
|
|
1266
1355
|
CollectInStore: {
|
|
1267
1356
|
id?: string;
|
|
1268
1357
|
name?: string;
|
|
@@ -1270,7 +1359,8 @@ interface components {
|
|
|
1270
1359
|
collect_eta_minutes?: number;
|
|
1271
1360
|
is_recommended?: boolean;
|
|
1272
1361
|
address?: components["schemas"]["CollectInStoreAddress"];
|
|
1273
|
-
};
|
|
1362
|
+
};
|
|
1363
|
+
/** CollectInStoreAddress */
|
|
1274
1364
|
CollectInStoreAddress: {
|
|
1275
1365
|
name: string;
|
|
1276
1366
|
address_line1: string;
|
|
@@ -1279,15 +1369,18 @@ interface components {
|
|
|
1279
1369
|
pincode: string;
|
|
1280
1370
|
city: string;
|
|
1281
1371
|
state: string;
|
|
1282
|
-
country: string;
|
|
1372
|
+
country: string;
|
|
1373
|
+
/** @default +91 */
|
|
1283
1374
|
country_code: string;
|
|
1284
|
-
};
|
|
1375
|
+
};
|
|
1376
|
+
/** CollectInStoreFulfillment */
|
|
1285
1377
|
CollectInStoreFulfillment: {
|
|
1286
1378
|
/**
|
|
1287
1379
|
* @description discriminator enum property added by openapi-typescript
|
|
1288
1380
|
* @enum {string}
|
|
1289
1381
|
*/
|
|
1290
|
-
fulfillment_type: "collect-in-store";
|
|
1382
|
+
fulfillment_type: "collect-in-store";
|
|
1383
|
+
/** @enum {string} */
|
|
1291
1384
|
preference_type?: $Read$1<"user" | "auto">;
|
|
1292
1385
|
pickup_location_id: string;
|
|
1293
1386
|
pickup_location_name?: $Read$1<string>;
|
|
@@ -1298,7 +1391,8 @@ interface components {
|
|
|
1298
1391
|
*/
|
|
1299
1392
|
ColorAttribute: {
|
|
1300
1393
|
id: string;
|
|
1301
|
-
name: string;
|
|
1394
|
+
name: string;
|
|
1395
|
+
/** @description A lookup safe version of the name that is lowercased and spaces are replaced with underscores. For instance, if name is `Product Type`, key will be `product_type` */
|
|
1302
1396
|
key: string;
|
|
1303
1397
|
/**
|
|
1304
1398
|
* @description discriminator enum property added by openapi-typescript
|
|
@@ -1313,9 +1407,11 @@ interface components {
|
|
|
1313
1407
|
*/
|
|
1314
1408
|
hexcode: string;
|
|
1315
1409
|
}[];
|
|
1316
|
-
};
|
|
1410
|
+
};
|
|
1411
|
+
/** ColorOption */
|
|
1317
1412
|
ColorOption: {
|
|
1318
|
-
/** @description The name of the associated option. */
|
|
1413
|
+
/** @description The name of the associated option. */
|
|
1414
|
+
name: string;
|
|
1319
1415
|
/**
|
|
1320
1416
|
* @description The type of the associated option.
|
|
1321
1417
|
* @constant
|
|
@@ -1326,19 +1422,24 @@ interface components {
|
|
|
1326
1422
|
* Format: color-hex
|
|
1327
1423
|
* @description The hex code of the color (e.g., #000000).
|
|
1328
1424
|
*/
|
|
1329
|
-
hexcode: string;
|
|
1425
|
+
hexcode: string;
|
|
1426
|
+
/** @description The name of the color. */
|
|
1330
1427
|
name: string;
|
|
1331
1428
|
};
|
|
1332
|
-
};
|
|
1429
|
+
};
|
|
1430
|
+
/** Coupon */
|
|
1333
1431
|
Coupon: (components["schemas"]["DiscountCouponPromotion"] | components["schemas"]["FreeGoodCouponPromotion"] | components["schemas"]["FixedPriceCouponPromotion"] | components["schemas"]["BuyXGetYCouponPromotion"] | components["schemas"]["VolumeBasedCouponPromotion"] | components["schemas"]["FreeShipingCouponPromotion"] | components["schemas"]["AcceleratedRewardCouponPromotion"]) & {
|
|
1334
|
-
/** @enum {unknown} */
|
|
1432
|
+
/** @enum {unknown} */
|
|
1433
|
+
coupon_type: "discount" | "free-goods" | "fixed-price" | "free-shipping" | "buy-x-get-y" | "volume-based" | "accelerated-rewards";
|
|
1335
1434
|
coupon_code: string[];
|
|
1336
1435
|
application_rules: {
|
|
1337
|
-
max_applicable_items: number;
|
|
1436
|
+
max_applicable_items: number;
|
|
1437
|
+
/** @enum {unknown} */
|
|
1338
1438
|
application_priority: "cheapest_first" | "most_expensive_first" | "first_added";
|
|
1339
1439
|
} | null;
|
|
1340
1440
|
can_be_used_with_promotion: boolean;
|
|
1341
|
-
};
|
|
1441
|
+
};
|
|
1442
|
+
/** CouponPromotionCommonDetail */
|
|
1342
1443
|
CouponPromotionCommonDetail: {
|
|
1343
1444
|
id: $Read$1<string>;
|
|
1344
1445
|
name: string;
|
|
@@ -1349,22 +1450,32 @@ interface components {
|
|
|
1349
1450
|
per_customer_redemptions: number | null;
|
|
1350
1451
|
per_coupon_code_redemptions: number | null;
|
|
1351
1452
|
} | null;
|
|
1352
|
-
redemption_count: $Read$1<number>;
|
|
1353
|
-
|
|
1354
|
-
|
|
1453
|
+
redemption_count: $Read$1<number>;
|
|
1454
|
+
/** @default 0 */
|
|
1455
|
+
minimum_order_total: number | null;
|
|
1456
|
+
/** Format: date-time */
|
|
1457
|
+
starts_at: string;
|
|
1458
|
+
/** Format: date-time */
|
|
1355
1459
|
expires_at: string | null;
|
|
1356
|
-
};
|
|
1460
|
+
};
|
|
1461
|
+
/** @enum {unknown} */
|
|
1357
1462
|
CouponType: "discount" | "free-goods" | "fixed-price" | "free-shipping" | "buy-x-get-y" | "volume-based" | "accelerated-rewards";
|
|
1358
1463
|
Currency: {
|
|
1359
|
-
/** @example Indian Rupee */
|
|
1360
|
-
|
|
1464
|
+
/** @example Indian Rupee */
|
|
1465
|
+
name: string;
|
|
1466
|
+
/** @example INR */
|
|
1467
|
+
code: string;
|
|
1468
|
+
/** @example ₹ */
|
|
1361
1469
|
symbol: string;
|
|
1362
|
-
};
|
|
1470
|
+
};
|
|
1471
|
+
/** CustomerAddress */
|
|
1363
1472
|
CustomerAddress: {
|
|
1364
1473
|
id?: $Read$1<string | null>;
|
|
1365
1474
|
first_name: string;
|
|
1366
|
-
last_name: string | null;
|
|
1367
|
-
|
|
1475
|
+
last_name: string | null;
|
|
1476
|
+
/** @description Two-letter code begin with a plus sign prefix that identifies different countries. By default it will be +91 if not provided. */
|
|
1477
|
+
country_code: string;
|
|
1478
|
+
/** @description 10 digit phone number without country code. */
|
|
1368
1479
|
phone: string;
|
|
1369
1480
|
email: string;
|
|
1370
1481
|
address_line1: string;
|
|
@@ -1372,11 +1483,16 @@ interface components {
|
|
|
1372
1483
|
landmark: string | null;
|
|
1373
1484
|
pincode: string;
|
|
1374
1485
|
city: string;
|
|
1375
|
-
state: string;
|
|
1376
|
-
|
|
1377
|
-
|
|
1378
|
-
|
|
1379
|
-
|
|
1486
|
+
state: string;
|
|
1487
|
+
/** @constant */
|
|
1488
|
+
country: "India";
|
|
1489
|
+
/** @description Tax Identification Number specific to the country of operation. */
|
|
1490
|
+
tax_identification_number: string | null;
|
|
1491
|
+
/** @description Use in billing & shipping details only. */
|
|
1492
|
+
business_name: string | null;
|
|
1493
|
+
/** @description Indicates if the address is the default billing address for the customer. */
|
|
1494
|
+
is_default_billing?: boolean;
|
|
1495
|
+
/** @description Indicates if the address is the default shipping address for the customer. */
|
|
1380
1496
|
is_default_shipping?: boolean;
|
|
1381
1497
|
is_phone_verified: $Read$1<boolean>;
|
|
1382
1498
|
is_email_verified: $Read$1<boolean>;
|
|
@@ -1385,27 +1501,33 @@ interface components {
|
|
|
1385
1501
|
* @default null
|
|
1386
1502
|
*/
|
|
1387
1503
|
nickname: string | null;
|
|
1388
|
-
} | null;
|
|
1504
|
+
} | null;
|
|
1505
|
+
/** CustomSlabsBasedOnAmount */
|
|
1389
1506
|
CustomSlabsBasedOnAmount: {
|
|
1390
|
-
/** @constant */
|
|
1507
|
+
/** @constant */
|
|
1508
|
+
spending_criteria_type: "minimum-purchase-amount";
|
|
1391
1509
|
products: {
|
|
1392
1510
|
product_id: string | null;
|
|
1393
1511
|
variant_id: string | null;
|
|
1394
1512
|
slabs: {
|
|
1395
1513
|
minimum_purchase_amount: number;
|
|
1396
|
-
get_quantity: number;
|
|
1514
|
+
get_quantity: number;
|
|
1515
|
+
/** @enum {unknown} */
|
|
1397
1516
|
condition: "greater-or-equal";
|
|
1398
1517
|
}[];
|
|
1399
1518
|
}[];
|
|
1400
|
-
};
|
|
1519
|
+
};
|
|
1520
|
+
/** CustomSlabsBasedOnQuantity */
|
|
1401
1521
|
CustomSlabsBasedOnQuantity: {
|
|
1402
|
-
/** @constant */
|
|
1522
|
+
/** @constant */
|
|
1523
|
+
spending_criteria_type: "minimum-quantity";
|
|
1403
1524
|
products: {
|
|
1404
1525
|
product_id: string | null;
|
|
1405
1526
|
variant_id: string | null;
|
|
1406
1527
|
slabs: {
|
|
1407
1528
|
buy_quantity: number;
|
|
1408
|
-
get_quantity: number;
|
|
1529
|
+
get_quantity: number;
|
|
1530
|
+
/** @enum {unknown} */
|
|
1409
1531
|
condition: "greater-or-equal";
|
|
1410
1532
|
}[];
|
|
1411
1533
|
}[];
|
|
@@ -1416,7 +1538,8 @@ interface components {
|
|
|
1416
1538
|
*/
|
|
1417
1539
|
DateAttribute: {
|
|
1418
1540
|
id: string;
|
|
1419
|
-
name: string;
|
|
1541
|
+
name: string;
|
|
1542
|
+
/** @description A lookup safe version of the name that is lowercased and spaces are replaced with underscores. For instance, if name is `Product Type`, key will be `product_type` */
|
|
1420
1543
|
key: string;
|
|
1421
1544
|
/**
|
|
1422
1545
|
* @description discriminator enum property added by openapi-typescript
|
|
@@ -1428,13 +1551,15 @@ interface components {
|
|
|
1428
1551
|
* @description For date attributes
|
|
1429
1552
|
*/
|
|
1430
1553
|
value: string;
|
|
1431
|
-
};
|
|
1554
|
+
};
|
|
1555
|
+
/** DeliveryFulfillment */
|
|
1432
1556
|
DeliveryFulfillment: {
|
|
1433
1557
|
/**
|
|
1434
1558
|
* @description discriminator enum property added by openapi-typescript
|
|
1435
1559
|
* @enum {string}
|
|
1436
1560
|
*/
|
|
1437
|
-
fulfillment_type: "delivery";
|
|
1561
|
+
fulfillment_type: "delivery";
|
|
1562
|
+
/** @enum {string} */
|
|
1438
1563
|
preference_type?: $Read$1<"user" | "auto">;
|
|
1439
1564
|
shipments: {
|
|
1440
1565
|
id: string;
|
|
@@ -1443,18 +1568,23 @@ interface components {
|
|
|
1443
1568
|
courier_company_id?: string | null;
|
|
1444
1569
|
courier_company_name?: $Read$1<string | null>;
|
|
1445
1570
|
}[];
|
|
1446
|
-
};
|
|
1571
|
+
};
|
|
1572
|
+
/** DeliveryOption */
|
|
1447
1573
|
DeliveryOption: {
|
|
1448
|
-
is_serviceable: boolean;
|
|
1574
|
+
is_serviceable: boolean;
|
|
1575
|
+
/** @description free shipping threshold of delivery option */
|
|
1449
1576
|
free_shipping_threshold: number | null;
|
|
1450
1577
|
shipments: {
|
|
1451
1578
|
id: string;
|
|
1452
1579
|
items: components["schemas"]["ShipmentItem"][];
|
|
1453
1580
|
shipping_methods: {
|
|
1454
1581
|
id?: string;
|
|
1455
|
-
name?: string;
|
|
1456
|
-
|
|
1457
|
-
|
|
1582
|
+
name?: string;
|
|
1583
|
+
/** @enum {unknown} */
|
|
1584
|
+
shipping_type?: "auto" | "manual";
|
|
1585
|
+
/** @description shipping amount of manual method or as per recommened courier or range of min-max shipping amount. */
|
|
1586
|
+
shipping_amount?: string;
|
|
1587
|
+
/** @description estimated delivery days of manual method or as per recommened courier or range of min-max estimated delivery days. */
|
|
1458
1588
|
estimated_delivery_days?: string;
|
|
1459
1589
|
courier_companies?: {
|
|
1460
1590
|
id?: string | number;
|
|
@@ -1462,30 +1592,40 @@ interface components {
|
|
|
1462
1592
|
shipping_amount?: number;
|
|
1463
1593
|
estimated_delivery_days?: string;
|
|
1464
1594
|
is_recommended?: boolean;
|
|
1465
|
-
is_hyperlocal?: boolean;
|
|
1595
|
+
is_hyperlocal?: boolean;
|
|
1596
|
+
/** @enum {unknown} */
|
|
1466
1597
|
mode?: "air" | "surface";
|
|
1467
1598
|
rating?: number;
|
|
1468
1599
|
}[];
|
|
1469
1600
|
}[];
|
|
1470
1601
|
}[];
|
|
1471
|
-
};
|
|
1602
|
+
};
|
|
1603
|
+
/** DiscountBasedPromotion */
|
|
1472
1604
|
DiscountBasedPromotion: {
|
|
1473
1605
|
/**
|
|
1474
1606
|
* @description discriminator enum property added by openapi-typescript
|
|
1475
1607
|
* @enum {string}
|
|
1476
1608
|
*/
|
|
1477
|
-
promotion_type: "discount";
|
|
1478
|
-
|
|
1479
|
-
|
|
1609
|
+
promotion_type: "discount";
|
|
1610
|
+
/** @enum {string} */
|
|
1611
|
+
discount_type: "percentage" | "fixed-amount";
|
|
1612
|
+
/** @description '> 0' if discount_type = percentage, otherwise set 0. */
|
|
1613
|
+
discount_percent?: number;
|
|
1614
|
+
/** @description '> 0' if discount_type = fixed-amount, otherwise set 0. */
|
|
1480
1615
|
discount_fixed_amount?: number;
|
|
1481
|
-
};
|
|
1616
|
+
};
|
|
1617
|
+
/** DiscountCouponPromotion */
|
|
1482
1618
|
DiscountCouponPromotion: components["schemas"]["CouponPromotionCommonDetail"] & {
|
|
1483
|
-
details: components["schemas"]["DiscountRule"];
|
|
1619
|
+
details: components["schemas"]["DiscountRule"];
|
|
1620
|
+
/** @enum {unknown} */
|
|
1484
1621
|
applies_to_product: "all" | "product" | "category";
|
|
1485
|
-
};
|
|
1486
|
-
|
|
1622
|
+
};
|
|
1623
|
+
/** DiscountRule */
|
|
1624
|
+
DiscountRule: components["schemas"]["PercentageDiscountRule"] | components["schemas"]["FixedAmountDiscountRule"];
|
|
1625
|
+
/** FixedAmountDiscountRule */
|
|
1487
1626
|
FixedAmountDiscountRule: {
|
|
1488
|
-
/** @constant */
|
|
1627
|
+
/** @constant */
|
|
1628
|
+
discount_type: "fixed-amount";
|
|
1489
1629
|
fixed_discount_amount: number;
|
|
1490
1630
|
products: {
|
|
1491
1631
|
product_id: string | null;
|
|
@@ -1494,13 +1634,17 @@ interface components {
|
|
|
1494
1634
|
maximum_quantity: number | null;
|
|
1495
1635
|
minimum_value: number | null;
|
|
1496
1636
|
maximum_value: number | null;
|
|
1497
|
-
}[];
|
|
1637
|
+
}[];
|
|
1638
|
+
/** @description Array of category ids */
|
|
1498
1639
|
category_id: string[];
|
|
1499
|
-
};
|
|
1640
|
+
};
|
|
1641
|
+
/** FixedPriceCouponPromotion */
|
|
1500
1642
|
FixedPriceCouponPromotion: components["schemas"]["CouponPromotionCommonDetail"] & {
|
|
1501
|
-
details: components["schemas"]["FixedPriceRule"];
|
|
1643
|
+
details: components["schemas"]["FixedPriceRule"];
|
|
1644
|
+
/** @enum {unknown} */
|
|
1502
1645
|
applies_to_product: "product";
|
|
1503
|
-
};
|
|
1646
|
+
};
|
|
1647
|
+
/** FixedPricePromotion */
|
|
1504
1648
|
FixedPricePromotion: {
|
|
1505
1649
|
/**
|
|
1506
1650
|
* @description discriminator enum property added by openapi-typescript
|
|
@@ -1508,43 +1652,58 @@ interface components {
|
|
|
1508
1652
|
*/
|
|
1509
1653
|
promotion_type: "fixed-price";
|
|
1510
1654
|
offer_price: number;
|
|
1511
|
-
};
|
|
1512
|
-
|
|
1655
|
+
};
|
|
1656
|
+
/** FixedPriceRule */
|
|
1657
|
+
FixedPriceRule: components["schemas"]["FixedPriceRuleBasedQuantity"] | components["schemas"]["FixedPriceRuleBasedAmount"];
|
|
1658
|
+
/** FixedPriceRuleBasedAmount */
|
|
1513
1659
|
FixedPriceRuleBasedAmount: {
|
|
1514
|
-
/** @constant */
|
|
1660
|
+
/** @constant */
|
|
1661
|
+
spending_criteria_type: "minimum-purchase-amount";
|
|
1515
1662
|
products: {
|
|
1516
1663
|
product_id: string | null;
|
|
1517
1664
|
variant_id: string | null;
|
|
1518
|
-
minimum_purchase_amount: number;
|
|
1665
|
+
minimum_purchase_amount: number;
|
|
1666
|
+
/** @description null means there is no limit. */
|
|
1519
1667
|
maximum_purchase_amount: number | null;
|
|
1520
1668
|
offer_price: number;
|
|
1521
1669
|
}[];
|
|
1522
|
-
};
|
|
1670
|
+
};
|
|
1671
|
+
/** FixedPriceRuleBasedQuantity */
|
|
1523
1672
|
FixedPriceRuleBasedQuantity: {
|
|
1524
|
-
/** @constant */
|
|
1673
|
+
/** @constant */
|
|
1674
|
+
spending_criteria_type: "minimum-quantity";
|
|
1525
1675
|
products: {
|
|
1526
1676
|
product_id: string | null;
|
|
1527
1677
|
variant_id: string | null;
|
|
1528
|
-
minimum_quantity: number;
|
|
1678
|
+
minimum_quantity: number;
|
|
1679
|
+
/** @description null means there is no limit. */
|
|
1529
1680
|
maximum_quantity: number | null;
|
|
1530
1681
|
offer_price: number;
|
|
1531
1682
|
}[];
|
|
1532
|
-
};
|
|
1683
|
+
};
|
|
1684
|
+
/** FreeGoodCouponPromotion */
|
|
1533
1685
|
FreeGoodCouponPromotion: components["schemas"]["CouponPromotionCommonDetail"] & {
|
|
1534
|
-
details: components["schemas"]["FreeGoodsRule"];
|
|
1686
|
+
details: components["schemas"]["FreeGoodsRule"];
|
|
1687
|
+
/** @enum {unknown} */
|
|
1535
1688
|
applies_to_product: "product";
|
|
1536
|
-
};
|
|
1689
|
+
};
|
|
1690
|
+
/** FreeGoodsPromotion */
|
|
1537
1691
|
FreeGoodsPromotion: {
|
|
1538
1692
|
/**
|
|
1539
1693
|
* @description discriminator enum property added by openapi-typescript
|
|
1540
1694
|
* @enum {string}
|
|
1541
1695
|
*/
|
|
1542
|
-
promotion_type: "free-goods";
|
|
1543
|
-
|
|
1696
|
+
promotion_type: "free-goods";
|
|
1697
|
+
/** @description The quantity of items a customer must buy to receive free goods. */
|
|
1698
|
+
buy_quantity: number;
|
|
1699
|
+
/** @description The quantity of free goods the customer receives. */
|
|
1544
1700
|
get_quantity: number;
|
|
1545
|
-
};
|
|
1546
|
-
|
|
1547
|
-
|
|
1701
|
+
};
|
|
1702
|
+
/** FreeGoodsRule */
|
|
1703
|
+
FreeGoodsRule: components["schemas"]["AutoScaleBasedOnQuantity"] | components["schemas"]["AutoScaleBasedOnAmount"] | components["schemas"]["CustomSlabsBasedOnQuantity"] | components["schemas"]["CustomSlabsBasedOnAmount"];
|
|
1704
|
+
/** FreeShipingCouponPromotion */
|
|
1705
|
+
FreeShipingCouponPromotion: components["schemas"]["CouponPromotionCommonDetail"];
|
|
1706
|
+
/** FulfillmentItem */
|
|
1548
1707
|
FulfillmentItem: {
|
|
1549
1708
|
product_id: string;
|
|
1550
1709
|
product_name: $Read$1<string>;
|
|
@@ -1571,7 +1730,8 @@ interface components {
|
|
|
1571
1730
|
promotion_type?: components["schemas"]["PromotionType"];
|
|
1572
1731
|
reason?: string;
|
|
1573
1732
|
suggestion?: string;
|
|
1574
|
-
};
|
|
1733
|
+
};
|
|
1734
|
+
/** SKU */
|
|
1575
1735
|
Item: {
|
|
1576
1736
|
product_id: string;
|
|
1577
1737
|
variant_id: string | null;
|
|
@@ -1587,11 +1747,13 @@ interface components {
|
|
|
1587
1747
|
product_type: "physical" | "digital" | "bundle";
|
|
1588
1748
|
short_description: string | null;
|
|
1589
1749
|
active: boolean;
|
|
1590
|
-
stock_available: boolean;
|
|
1750
|
+
stock_available: boolean;
|
|
1751
|
+
/** @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. */
|
|
1591
1752
|
backorder?: boolean;
|
|
1592
1753
|
on_subscription: boolean;
|
|
1593
1754
|
on_promotion: boolean;
|
|
1594
|
-
category_ids: string[];
|
|
1755
|
+
category_ids: string[];
|
|
1756
|
+
/** @description Expanded category objects. */
|
|
1595
1757
|
categories?: components["schemas"]["Category"][];
|
|
1596
1758
|
tags: string[] | null;
|
|
1597
1759
|
reviews_count: number;
|
|
@@ -1604,10 +1766,13 @@ interface components {
|
|
|
1604
1766
|
associated_options: components["schemas"]["AssociatedOption"] | null;
|
|
1605
1767
|
shipping?: components["schemas"]["ProductShipping"];
|
|
1606
1768
|
inventory?: components["schemas"]["LotBatchDetail"][];
|
|
1607
|
-
};
|
|
1769
|
+
};
|
|
1770
|
+
/** LotBatchDetail */
|
|
1608
1771
|
LotBatchDetail: {
|
|
1609
|
-
lot_batch: string;
|
|
1610
|
-
|
|
1772
|
+
lot_batch: string;
|
|
1773
|
+
/** Format: date */
|
|
1774
|
+
mfg_date: string | null;
|
|
1775
|
+
/** Format: date */
|
|
1611
1776
|
exp_date: string | null;
|
|
1612
1777
|
manufacturer: string | null;
|
|
1613
1778
|
stock_quantity: number;
|
|
@@ -1618,13 +1783,15 @@ interface components {
|
|
|
1618
1783
|
*/
|
|
1619
1784
|
MultiSelectAttribute: {
|
|
1620
1785
|
id: string;
|
|
1621
|
-
name: string;
|
|
1786
|
+
name: string;
|
|
1787
|
+
/** @description A lookup safe version of the name that is lowercased and spaces are replaced with underscores. For instance, if name is `Product Type`, key will be `product_type` */
|
|
1622
1788
|
key: string;
|
|
1623
1789
|
/**
|
|
1624
1790
|
* @description discriminator enum property added by openapi-typescript
|
|
1625
1791
|
* @enum {string}
|
|
1626
1792
|
*/
|
|
1627
|
-
type: "multi-select";
|
|
1793
|
+
type: "multi-select";
|
|
1794
|
+
/** @description For multi-select attributes */
|
|
1628
1795
|
value: string[];
|
|
1629
1796
|
};
|
|
1630
1797
|
/**
|
|
@@ -1645,17 +1812,22 @@ interface components {
|
|
|
1645
1812
|
*/
|
|
1646
1813
|
NumberAttribute: {
|
|
1647
1814
|
id: string;
|
|
1648
|
-
name: string;
|
|
1815
|
+
name: string;
|
|
1816
|
+
/** @description A lookup safe version of the name that is lowercased and spaces are replaced with underscores. For instance, if name is `Product Type`, key will be `product_type` */
|
|
1649
1817
|
key: string;
|
|
1650
1818
|
/**
|
|
1651
1819
|
* @description discriminator enum property added by openapi-typescript
|
|
1652
1820
|
* @enum {string}
|
|
1653
1821
|
*/
|
|
1654
|
-
type: "number";
|
|
1822
|
+
type: "number";
|
|
1823
|
+
/** @description For numeric attributes */
|
|
1655
1824
|
value: number;
|
|
1656
|
-
};
|
|
1825
|
+
};
|
|
1826
|
+
/** Order */
|
|
1657
1827
|
Order: {
|
|
1658
|
-
/** @description Unique, human-readable order identifier used across all order endpoints. */
|
|
1828
|
+
/** @description Unique, human-readable order identifier used across all order endpoints. */
|
|
1829
|
+
order_number?: string;
|
|
1830
|
+
/** Format: date-time */
|
|
1659
1831
|
order_date?: string;
|
|
1660
1832
|
/**
|
|
1661
1833
|
* @description Current fulfillment status of the order. Progresses from `confirmed` through shipping stages to `complete`.
|
|
@@ -1669,14 +1841,20 @@ interface components {
|
|
|
1669
1841
|
payment_status?: "pending" | "success" | "failed" | "partially_paid";
|
|
1670
1842
|
payment_success_date?: string | null;
|
|
1671
1843
|
customer_note?: string | null;
|
|
1672
|
-
is_promotion_applied?: boolean;
|
|
1673
|
-
|
|
1844
|
+
is_promotion_applied?: boolean;
|
|
1845
|
+
/** Format: double */
|
|
1846
|
+
promotion_discount_amount?: number;
|
|
1847
|
+
/** Format: double */
|
|
1674
1848
|
promotion_discount_percent?: number;
|
|
1675
1849
|
is_coupon_applied?: boolean;
|
|
1676
|
-
coupon_code?: string | null;
|
|
1677
|
-
|
|
1678
|
-
|
|
1679
|
-
|
|
1850
|
+
coupon_code?: string | null;
|
|
1851
|
+
/** Format: double */
|
|
1852
|
+
coupon_discount_amount?: number;
|
|
1853
|
+
/** Format: double */
|
|
1854
|
+
coupon_discount_percent?: number;
|
|
1855
|
+
/** @description Information about the promotional offers that have been applied to the cart. */
|
|
1856
|
+
applied_promotions: components["schemas"]["AppliedPromotion"][];
|
|
1857
|
+
/** @description This key provides details about the savings in cart after coupon have been applied to the cart. */
|
|
1680
1858
|
applied_coupons: components["schemas"]["AppliedCoupon"][];
|
|
1681
1859
|
/**
|
|
1682
1860
|
* Format: float
|
|
@@ -1698,26 +1876,41 @@ interface components {
|
|
|
1698
1876
|
* @description Combined savings across promotions, coupons, and other discounts.
|
|
1699
1877
|
*/
|
|
1700
1878
|
total_savings?: number;
|
|
1701
|
-
on_subscription?: boolean;
|
|
1702
|
-
|
|
1703
|
-
|
|
1704
|
-
|
|
1705
|
-
|
|
1706
|
-
|
|
1707
|
-
|
|
1708
|
-
|
|
1709
|
-
|
|
1879
|
+
on_subscription?: boolean;
|
|
1880
|
+
/** Format: double */
|
|
1881
|
+
subtotal?: number;
|
|
1882
|
+
/** Format: double */
|
|
1883
|
+
item_total_tax?: number;
|
|
1884
|
+
/** Format: double */
|
|
1885
|
+
subtotal_including_tax?: number;
|
|
1886
|
+
/** Format: double */
|
|
1887
|
+
shipping_estimated_cost?: number;
|
|
1888
|
+
/** Format: double */
|
|
1889
|
+
shipping_discount_amount?: number;
|
|
1890
|
+
/** Format: double */
|
|
1891
|
+
shipping_amount?: number;
|
|
1892
|
+
/** Format: double */
|
|
1893
|
+
shipping_tax_rate?: number;
|
|
1894
|
+
/** Format: double */
|
|
1895
|
+
shipping_tax_amount?: number;
|
|
1896
|
+
/** Format: double */
|
|
1710
1897
|
shipping_amount_including_tax?: number;
|
|
1711
1898
|
fulfillment_preference?: components["schemas"]["FulfillmentPreference"];
|
|
1712
|
-
estimated_delivery_days?: number | null;
|
|
1713
|
-
|
|
1714
|
-
|
|
1715
|
-
|
|
1716
|
-
|
|
1899
|
+
estimated_delivery_days?: number | null;
|
|
1900
|
+
/** Format: double */
|
|
1901
|
+
handling_charge_excluding_tax?: number;
|
|
1902
|
+
/** Format: double */
|
|
1903
|
+
handling_charge_tax_amount?: number;
|
|
1904
|
+
/** Format: double */
|
|
1905
|
+
handling_charge_including_tax?: number;
|
|
1906
|
+
/** Format: double */
|
|
1907
|
+
total_tax?: number;
|
|
1908
|
+
/** Format: double */
|
|
1717
1909
|
grand_total?: number;
|
|
1718
1910
|
loyalty_points_earned?: number;
|
|
1719
1911
|
loyalty_points_redeemed?: number;
|
|
1720
|
-
credit_balance_used?: number;
|
|
1912
|
+
credit_balance_used?: number;
|
|
1913
|
+
/** Format: double */
|
|
1721
1914
|
to_be_paid?: number;
|
|
1722
1915
|
order_items_count?: number;
|
|
1723
1916
|
order_items?: components["schemas"]["OrderItem"][];
|
|
@@ -1727,15 +1920,22 @@ interface components {
|
|
|
1727
1920
|
name?: string;
|
|
1728
1921
|
code?: string;
|
|
1729
1922
|
symbol?: string;
|
|
1730
|
-
};
|
|
1923
|
+
};
|
|
1924
|
+
/** @description Additional metadata associated with the order. */
|
|
1731
1925
|
metadata?: {
|
|
1732
1926
|
[key: string]: string;
|
|
1733
|
-
} | null;
|
|
1734
|
-
|
|
1927
|
+
} | null;
|
|
1928
|
+
/** @description Whether the order is eligible for cancellation. Only show the cancel action in your UI when this is `true`. */
|
|
1929
|
+
is_cancellation_allowed?: boolean;
|
|
1930
|
+
/** @description Breakdown of the refund the customer would receive upon cancellation. Only populated when `is_cancellation_allowed` is `true`. */
|
|
1735
1931
|
cancellation_refund_details?: {
|
|
1736
|
-
/** @description loyalty point redeemed will be rollbacked and credited to user account. */
|
|
1737
|
-
|
|
1738
|
-
|
|
1932
|
+
/** @description loyalty point redeemed will be rollbacked and credited to user account. */
|
|
1933
|
+
loyalty_point?: number;
|
|
1934
|
+
/** @description amount that will be refunded to customer. */
|
|
1935
|
+
refundable_amount?: number;
|
|
1936
|
+
/** @description amount deducted from paid amount. */
|
|
1937
|
+
cancellation_charges?: number;
|
|
1938
|
+
/** @description reason for cancellation charges. */
|
|
1739
1939
|
cancellation_charges_reason?: string;
|
|
1740
1940
|
/**
|
|
1741
1941
|
* @description payment mode for refund.
|
|
@@ -1744,7 +1944,8 @@ interface components {
|
|
|
1744
1944
|
payment_mode?: "original-payment-mode" | "bank-transfer" | "nach-mandate";
|
|
1745
1945
|
};
|
|
1746
1946
|
feedback?: string | null;
|
|
1747
|
-
};
|
|
1947
|
+
};
|
|
1948
|
+
/** OrderDetail */
|
|
1748
1949
|
OrderDetail: components["schemas"]["Order"] & {
|
|
1749
1950
|
payments?: components["schemas"]["OrderPayment"][];
|
|
1750
1951
|
shipments?: components["schemas"]["OrderShipment"][];
|
|
@@ -1752,7 +1953,8 @@ interface components {
|
|
|
1752
1953
|
OrderItem: {
|
|
1753
1954
|
product_id: string;
|
|
1754
1955
|
product_name: string;
|
|
1755
|
-
product_image_url: string | null;
|
|
1956
|
+
product_image_url: string | null;
|
|
1957
|
+
/** @enum {unknown} */
|
|
1756
1958
|
product_type: "physical" | "digital" | "bundle";
|
|
1757
1959
|
sku: string;
|
|
1758
1960
|
slug: string;
|
|
@@ -1772,26 +1974,38 @@ interface components {
|
|
|
1772
1974
|
quantity: number;
|
|
1773
1975
|
free_quantity: number;
|
|
1774
1976
|
is_free_item: boolean;
|
|
1775
|
-
price_including_tax: boolean;
|
|
1776
|
-
|
|
1777
|
-
|
|
1778
|
-
|
|
1779
|
-
|
|
1977
|
+
price_including_tax: boolean;
|
|
1978
|
+
/** Format: double */
|
|
1979
|
+
selling_price: number;
|
|
1980
|
+
/** Format: double */
|
|
1981
|
+
listing_price: number;
|
|
1982
|
+
/** Format: double */
|
|
1983
|
+
selling_price_excluding_tax: number;
|
|
1984
|
+
/** Format: double */
|
|
1985
|
+
promotion_discount_amount: number;
|
|
1986
|
+
/** Format: double */
|
|
1780
1987
|
coupon_discount_amount: number;
|
|
1781
1988
|
/**
|
|
1782
1989
|
* @default GST
|
|
1783
1990
|
* @example GST
|
|
1784
1991
|
* @constant
|
|
1785
1992
|
*/
|
|
1786
|
-
tax_type: "GST";
|
|
1787
|
-
|
|
1788
|
-
|
|
1789
|
-
|
|
1790
|
-
|
|
1993
|
+
tax_type: "GST";
|
|
1994
|
+
/** Format: double */
|
|
1995
|
+
tax_rate: number;
|
|
1996
|
+
/** Format: double */
|
|
1997
|
+
tax_amount: number;
|
|
1998
|
+
/** Format: double */
|
|
1999
|
+
handling_charge_excluding_tax: number;
|
|
2000
|
+
/** Format: double */
|
|
2001
|
+
handling_charge_tax_rate: number;
|
|
2002
|
+
/** Format: double */
|
|
1791
2003
|
handling_charge_including_tax: number;
|
|
1792
2004
|
associated_options?: components["schemas"]["AssociatedOption"] | null;
|
|
1793
|
-
attributes?: components["schemas"]["ProductAttribute"][];
|
|
1794
|
-
|
|
2005
|
+
attributes?: components["schemas"]["ProductAttribute"][];
|
|
2006
|
+
/** @description Seller ID. This field is relevant for marketplace type stores only. Will return null for b2b and b2c type stores. */
|
|
2007
|
+
seller_id?: string | null;
|
|
2008
|
+
/** @description Seller detail information. This field is relevant for marketplace type stores only. Will return null for b2b and b2c type stores. */
|
|
1795
2009
|
seller_detail?: components["schemas"]["SellerInfo"] | null;
|
|
1796
2010
|
};
|
|
1797
2011
|
/**
|
|
@@ -1804,10 +2018,14 @@ interface components {
|
|
|
1804
2018
|
* @description Order refund model
|
|
1805
2019
|
*/
|
|
1806
2020
|
OrderRefund: {
|
|
1807
|
-
request_number?: string;
|
|
1808
|
-
|
|
1809
|
-
|
|
1810
|
-
|
|
2021
|
+
request_number?: string;
|
|
2022
|
+
/** Format: double */
|
|
2023
|
+
refund_amount?: number;
|
|
2024
|
+
/** Format: date-time */
|
|
2025
|
+
refund_date?: string;
|
|
2026
|
+
/** @enum {string} */
|
|
2027
|
+
status?: "pending" | "approved" | "success" | "failed";
|
|
2028
|
+
/** @enum {string} */
|
|
1811
2029
|
payment_mode?: "original-payment-mode" | "loyalty-point" | "bank-transfer" | "nach-mandate";
|
|
1812
2030
|
payment_method?: string;
|
|
1813
2031
|
payment_reference_number?: string;
|
|
@@ -1825,21 +2043,30 @@ interface components {
|
|
|
1825
2043
|
total_weight?: number;
|
|
1826
2044
|
total_boxes?: number;
|
|
1827
2045
|
shipment_items_count?: number;
|
|
1828
|
-
shipment_items?: components["schemas"]["ShipmentItem"][];
|
|
1829
|
-
|
|
1830
|
-
|
|
2046
|
+
shipment_items?: components["schemas"]["ShipmentItem"][];
|
|
2047
|
+
/** Format: double */
|
|
2048
|
+
shipping_amount?: number;
|
|
2049
|
+
/** Format: double */
|
|
2050
|
+
shipping_tax_amount?: number;
|
|
2051
|
+
/** Format: double */
|
|
1831
2052
|
shipping_amount_including_tax?: number;
|
|
1832
2053
|
courier_company_name?: string;
|
|
1833
2054
|
shipping_label_url?: string;
|
|
1834
2055
|
awb_no?: string;
|
|
1835
2056
|
tracking_url?: string;
|
|
1836
|
-
eta_delivery?: string;
|
|
1837
|
-
|
|
2057
|
+
eta_delivery?: string;
|
|
2058
|
+
/** Format: date-time */
|
|
2059
|
+
shipped_date?: string;
|
|
2060
|
+
/** Format: date-time */
|
|
1838
2061
|
delivered_date?: string;
|
|
1839
|
-
cancellation_reason?: string;
|
|
1840
|
-
|
|
1841
|
-
|
|
1842
|
-
|
|
2062
|
+
cancellation_reason?: string;
|
|
2063
|
+
/** Format: date-time */
|
|
2064
|
+
created_at?: string;
|
|
2065
|
+
/** Format: date-time */
|
|
2066
|
+
modified_at?: string;
|
|
2067
|
+
/** @description Seller ID. This field is relevant for marketplace type stores only. Will return null for b2b and b2c type stores. */
|
|
2068
|
+
seller_id?: string | null;
|
|
2069
|
+
/** @description Seller detail information. This field is relevant for marketplace type stores only. Will return null for b2b and b2c type stores. */
|
|
1843
2070
|
seller_detail?: components["schemas"]["SellerInfo"] | null;
|
|
1844
2071
|
};
|
|
1845
2072
|
/**
|
|
@@ -1858,13 +2085,15 @@ interface components {
|
|
|
1858
2085
|
previous_page?: number | null;
|
|
1859
2086
|
limit: number;
|
|
1860
2087
|
next_page: number | null;
|
|
1861
|
-
};
|
|
2088
|
+
};
|
|
2089
|
+
/** PartialCollectAndDelivery */
|
|
1862
2090
|
PartialCollectAndDelivery: {
|
|
1863
2091
|
/**
|
|
1864
2092
|
* @description discriminator enum property added by openapi-typescript
|
|
1865
2093
|
* @enum {string}
|
|
1866
2094
|
*/
|
|
1867
|
-
fulfillment_type: "partial-collect-and-delivery";
|
|
2095
|
+
fulfillment_type: "partial-collect-and-delivery";
|
|
2096
|
+
/** @enum {string} */
|
|
1868
2097
|
preference_type?: $Read$1<"user" | "auto">;
|
|
1869
2098
|
"collect-in-store": {
|
|
1870
2099
|
pickup_location_id: string;
|
|
@@ -1884,26 +2113,38 @@ interface components {
|
|
|
1884
2113
|
* @description Common fields in all types of payments.
|
|
1885
2114
|
*/
|
|
1886
2115
|
PaymentInfo: {
|
|
1887
|
-
/** @enum {string} */
|
|
1888
|
-
|
|
1889
|
-
|
|
1890
|
-
|
|
2116
|
+
/** @enum {string} */
|
|
2117
|
+
transaction_type?: "payment" | "refund";
|
|
2118
|
+
request_number?: string;
|
|
2119
|
+
/** Format: double */
|
|
2120
|
+
amount?: number;
|
|
2121
|
+
/** @enum {string} */
|
|
2122
|
+
payment_status?: "pending" | "success" | "failed" | "partially_paid" | "refund_initiated";
|
|
2123
|
+
/** Format: date-time */
|
|
1891
2124
|
payment_date?: string;
|
|
1892
2125
|
payment_reference_number?: string | null;
|
|
1893
2126
|
payment_method?: string | null;
|
|
1894
2127
|
icon_url?: string | null;
|
|
1895
|
-
};
|
|
2128
|
+
};
|
|
2129
|
+
/** PayWithCard */
|
|
1896
2130
|
PayWithCard: {
|
|
1897
|
-
/** @constant */
|
|
1898
|
-
|
|
2131
|
+
/** @constant */
|
|
2132
|
+
payment_mode: "CARD";
|
|
2133
|
+
};
|
|
2134
|
+
/** PayWithCash */
|
|
1899
2135
|
PayWithCash: {
|
|
1900
|
-
/** @constant */
|
|
1901
|
-
|
|
2136
|
+
/** @constant */
|
|
2137
|
+
payment_mode: "CASH";
|
|
2138
|
+
};
|
|
2139
|
+
/** PayWithUPI */
|
|
1902
2140
|
PayWithUpi: {
|
|
1903
|
-
/** @constant */
|
|
1904
|
-
|
|
2141
|
+
/** @constant */
|
|
2142
|
+
payment_mode: "UPI";
|
|
2143
|
+
};
|
|
2144
|
+
/** PercentageDiscountRule */
|
|
1905
2145
|
PercentageDiscountRule: {
|
|
1906
|
-
/** @constant */
|
|
2146
|
+
/** @constant */
|
|
2147
|
+
discount_type: "percentage";
|
|
1907
2148
|
discount_percent: number;
|
|
1908
2149
|
maximum_discount_amount: number | null;
|
|
1909
2150
|
products: {
|
|
@@ -1913,34 +2154,47 @@ interface components {
|
|
|
1913
2154
|
maximum_quantity: number | null;
|
|
1914
2155
|
minimum_value: number | null;
|
|
1915
2156
|
maximum_value: number | null;
|
|
1916
|
-
}[];
|
|
2157
|
+
}[];
|
|
2158
|
+
/** @description Array of category ids */
|
|
1917
2159
|
category_id: string[];
|
|
1918
|
-
};
|
|
2160
|
+
};
|
|
2161
|
+
/** PosDevice */
|
|
1919
2162
|
PosDevice: {
|
|
1920
2163
|
id: $Read$1<string>;
|
|
1921
|
-
name: string;
|
|
1922
|
-
|
|
2164
|
+
name: string;
|
|
2165
|
+
/** @enum {string} */
|
|
2166
|
+
device_type: "pos-terminal";
|
|
2167
|
+
/** @description A Device ID shared by POS device provider. */
|
|
1923
2168
|
external_device_id: $Read$1<string>;
|
|
1924
2169
|
vendor: string;
|
|
1925
2170
|
model_number: string;
|
|
1926
2171
|
mac_address: string | null;
|
|
1927
2172
|
location_id: string;
|
|
1928
|
-
location_name: $Read$1<string>;
|
|
1929
|
-
|
|
2173
|
+
location_name: $Read$1<string>;
|
|
2174
|
+
/** @description Returns a user object if the device is claimed, otherwise returns null. */
|
|
2175
|
+
claimed_by: components["schemas"]["PosDeviceClaimedUser"] | null;
|
|
2176
|
+
/** @enum {string} */
|
|
1930
2177
|
status: $Read$1<"available" | "claimed" | "offline">;
|
|
1931
2178
|
is_busy: $Read$1<boolean>;
|
|
1932
|
-
};
|
|
2179
|
+
};
|
|
2180
|
+
/** PosDeviceClaimedUser */
|
|
1933
2181
|
PosDeviceClaimedUser: {
|
|
1934
2182
|
id: $Read$1<string>;
|
|
1935
2183
|
first_name: string;
|
|
1936
2184
|
last_name: string | null;
|
|
1937
|
-
phone: string;
|
|
2185
|
+
phone: string;
|
|
2186
|
+
/** Format: email */
|
|
1938
2187
|
email: string;
|
|
1939
|
-
};
|
|
2188
|
+
};
|
|
2189
|
+
/** PosLocation */
|
|
1940
2190
|
PosLocation: {
|
|
1941
|
-
/** @description warehouse id */
|
|
1942
|
-
|
|
1943
|
-
|
|
2191
|
+
/** @description warehouse id */
|
|
2192
|
+
id?: $Read$1<string>;
|
|
2193
|
+
/** @description legal name */
|
|
2194
|
+
name: string;
|
|
2195
|
+
/** @enum {unknown} */
|
|
2196
|
+
warehouse_type: "retail-store" | "distribution-center";
|
|
2197
|
+
/** @default true */
|
|
1944
2198
|
active: boolean;
|
|
1945
2199
|
gstin?: string | null;
|
|
1946
2200
|
city: string;
|
|
@@ -1949,8 +2203,10 @@ interface components {
|
|
|
1949
2203
|
landmark?: string | null;
|
|
1950
2204
|
pincode: string;
|
|
1951
2205
|
state: string;
|
|
1952
|
-
country: string;
|
|
1953
|
-
|
|
2206
|
+
country: string;
|
|
2207
|
+
/** @default +91 */
|
|
2208
|
+
country_code: string;
|
|
2209
|
+
/** @description 10 digit number without country code. */
|
|
1954
2210
|
contact_phone: number;
|
|
1955
2211
|
contact_email: string;
|
|
1956
2212
|
is_default?: boolean;
|
|
@@ -1958,13 +2214,17 @@ interface components {
|
|
|
1958
2214
|
seller_warehouse_id?: string | null;
|
|
1959
2215
|
can_receive_stock: boolean;
|
|
1960
2216
|
can_ship_parcel: boolean;
|
|
1961
|
-
can_collect: boolean;
|
|
2217
|
+
can_collect: boolean;
|
|
2218
|
+
/** @description this field will be always true for warehouse_type = retail-store. */
|
|
1962
2219
|
is_checkout_point: boolean;
|
|
1963
2220
|
accepts_returns: boolean;
|
|
1964
2221
|
opening_hours?: string | null;
|
|
1965
|
-
};
|
|
2222
|
+
};
|
|
2223
|
+
/** UpdateCustomerWithEmail */
|
|
1966
2224
|
PosUpdateCustomerWithEmail: {
|
|
1967
|
-
/** Format: email */
|
|
2225
|
+
/** Format: email */
|
|
2226
|
+
email: string;
|
|
2227
|
+
/** @description 10 digit phone number without country code. */
|
|
1968
2228
|
phone?: string | null;
|
|
1969
2229
|
/**
|
|
1970
2230
|
* @description Two-letter code begin with a plus sign prefix that identifies different countries.
|
|
@@ -1973,26 +2233,32 @@ interface components {
|
|
|
1973
2233
|
country_code?: string | null;
|
|
1974
2234
|
first_name?: string | null;
|
|
1975
2235
|
last_name?: string | null;
|
|
1976
|
-
};
|
|
2236
|
+
};
|
|
2237
|
+
/** UpdateCustomerWithId */
|
|
1977
2238
|
PosUpdateCustomerWithId: {
|
|
1978
2239
|
customer_id: string;
|
|
1979
|
-
};
|
|
2240
|
+
};
|
|
2241
|
+
/** UpdateCustomerWithPhone */
|
|
1980
2242
|
PosUpdateCustomerWithPhone: {
|
|
1981
2243
|
/**
|
|
1982
2244
|
* @description Two-letter code begin with a plus sign prefix that identifies different countries. By default it will be +91 if not provided.
|
|
1983
2245
|
* @default +91
|
|
1984
2246
|
*/
|
|
1985
|
-
country_code: string | null;
|
|
1986
|
-
phone
|
|
2247
|
+
country_code: string | null;
|
|
2248
|
+
/** @description 10 digit phone number without country code. */
|
|
2249
|
+
phone: string;
|
|
2250
|
+
/** Format: email */
|
|
1987
2251
|
email?: string | null;
|
|
1988
2252
|
first_name?: string | null;
|
|
1989
2253
|
last_name?: string | null;
|
|
1990
|
-
};
|
|
2254
|
+
};
|
|
2255
|
+
/** PosUser */
|
|
1991
2256
|
PosUser: {
|
|
1992
2257
|
id: string;
|
|
1993
2258
|
first_name: string;
|
|
1994
2259
|
last_name: string | null;
|
|
1995
|
-
phone: string;
|
|
2260
|
+
phone: string;
|
|
2261
|
+
/** Format: email */
|
|
1996
2262
|
email: string;
|
|
1997
2263
|
channel: {
|
|
1998
2264
|
id: string;
|
|
@@ -2012,9 +2278,12 @@ interface components {
|
|
|
2012
2278
|
role_id?: string;
|
|
2013
2279
|
role_name?: string;
|
|
2014
2280
|
}[];
|
|
2015
|
-
};
|
|
2281
|
+
};
|
|
2282
|
+
/** Product */
|
|
2016
2283
|
Product: {
|
|
2017
|
-
/** @description The ID of the product */
|
|
2284
|
+
/** @description The ID of the product */
|
|
2285
|
+
id: string;
|
|
2286
|
+
/** @description Stock Keeping Unit. `null` for products that only have variant-level SKUs. */
|
|
2018
2287
|
sku: string | null;
|
|
2019
2288
|
name: string;
|
|
2020
2289
|
slug: string;
|
|
@@ -2024,41 +2293,61 @@ interface components {
|
|
|
2024
2293
|
* @enum {string}
|
|
2025
2294
|
*/
|
|
2026
2295
|
product_type: "physical" | "digital" | "bundle";
|
|
2027
|
-
active: $Read$1<boolean>;
|
|
2028
|
-
|
|
2029
|
-
|
|
2030
|
-
|
|
2031
|
-
|
|
2032
|
-
|
|
2033
|
-
|
|
2034
|
-
|
|
2296
|
+
active: $Read$1<boolean>;
|
|
2297
|
+
/** @description Indicates whether the product has stock available */
|
|
2298
|
+
stock_available: $Read$1<boolean>;
|
|
2299
|
+
/** @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. */
|
|
2300
|
+
backorder?: boolean;
|
|
2301
|
+
/** @description Indicates whether the product has any subscription plans avaialble */
|
|
2302
|
+
on_subscription: $Read$1<boolean>;
|
|
2303
|
+
/** @description Indicates whether the product is currently on promotion. When true, the `ProductPromotion` object will contain details of the promotion */
|
|
2304
|
+
on_promotion: $Read$1<boolean>;
|
|
2305
|
+
/** @description Indicates whether the product has variants */
|
|
2306
|
+
has_variant: $Read$1<boolean>;
|
|
2307
|
+
/** @description Freeform tags for filtering and search. `null` if no tags are assigned. */
|
|
2308
|
+
tags: string[] | null;
|
|
2309
|
+
/** @description IDs of categories this product belongs to. */
|
|
2310
|
+
category_ids: string[];
|
|
2311
|
+
/** @description Expanded category objects for this product. */
|
|
2035
2312
|
categories: components["schemas"]["Category"][];
|
|
2036
2313
|
/**
|
|
2037
2314
|
* Format: double
|
|
2038
2315
|
* @description Sum of all review ratings. Divide by `reviews_count` to compute the average rating.
|
|
2039
2316
|
*/
|
|
2040
|
-
reviews_rating_sum: number;
|
|
2041
|
-
|
|
2317
|
+
reviews_rating_sum: number;
|
|
2318
|
+
/** @description Total number of customer reviews. */
|
|
2319
|
+
reviews_count: number;
|
|
2320
|
+
/** @description Custom product attributes (e.g., color, size, material) configured in the store. */
|
|
2042
2321
|
attributes: components["schemas"]["ProductAttribute"][];
|
|
2043
|
-
pricing: components["schemas"]["ProductPricing"];
|
|
2322
|
+
pricing: components["schemas"]["ProductPricing"];
|
|
2323
|
+
/** @description Available variant option axes (e.g., Size, Color) with their possible values. Present only when `has_variant` is `true`. */
|
|
2044
2324
|
variant_options: components["schemas"]["VariantOption"][] | null;
|
|
2045
|
-
promotion: components["schemas"]["ProductPromotion"];
|
|
2325
|
+
promotion: components["schemas"]["ProductPromotion"];
|
|
2326
|
+
/** @description Product images ordered by display priority. */
|
|
2046
2327
|
images: components["schemas"]["ProductImage"][];
|
|
2047
|
-
subscription: components["schemas"]["ProductSubscription"][];
|
|
2048
|
-
|
|
2328
|
+
subscription: components["schemas"]["ProductSubscription"][];
|
|
2329
|
+
/** @description Product variants with individual pricing and inventory. Empty array when `has_variant` is `false`. */
|
|
2330
|
+
variants: components["schemas"]["Variant"][];
|
|
2331
|
+
/** @description Component products included in this bundle. Only present when `product_type` is `bundle`. */
|
|
2049
2332
|
bundle_items: components["schemas"]["ProductBundleItem"];
|
|
2050
2333
|
inventory?: components["schemas"]["LotBatchDetail"][];
|
|
2051
2334
|
};
|
|
2052
|
-
ProductAttribute: components["schemas"]["ColorAttribute"] | components["schemas"]["SingleSelectAttribute"] | components["schemas"]["MultiSelectAttribute"] | components["schemas"]["TextAttribute"] | components["schemas"]["DateAttribute"] | components["schemas"]["NumberAttribute"] | components["schemas"]["BooleanAttribute"];
|
|
2335
|
+
ProductAttribute: components["schemas"]["ColorAttribute"] | components["schemas"]["SingleSelectAttribute"] | components["schemas"]["MultiSelectAttribute"] | components["schemas"]["TextAttribute"] | components["schemas"]["DateAttribute"] | components["schemas"]["NumberAttribute"] | components["schemas"]["BooleanAttribute"];
|
|
2336
|
+
/** ProductBundleItem */
|
|
2053
2337
|
ProductBundleItem: ({
|
|
2054
|
-
/** Format: int32 */
|
|
2055
|
-
|
|
2338
|
+
/** Format: int32 */
|
|
2339
|
+
quantity: $Read$1<number>;
|
|
2340
|
+
/** @description The ID of the seller that is selling the bundle item. Appears only in marketplace store.. */
|
|
2341
|
+
seller_id?: string;
|
|
2342
|
+
/** @description The details of the seller that is selling the bundle item. Appears only in marketplace store. */
|
|
2056
2343
|
seller_detail?: components["schemas"]["SellerInfo"];
|
|
2057
|
-
} & components["schemas"]["Item"])[];
|
|
2344
|
+
} & components["schemas"]["Item"])[];
|
|
2345
|
+
/** ProductCategory */
|
|
2058
2346
|
ProductCategory: components["schemas"]["Category"] & {
|
|
2059
2347
|
child_categories: components["schemas"]["Category"][] | null;
|
|
2060
2348
|
};
|
|
2061
|
-
ProductDetail: components["schemas"]["Product"] & components["schemas"]["AdditionalProductDetails"];
|
|
2349
|
+
ProductDetail: components["schemas"]["Product"] & components["schemas"]["AdditionalProductDetails"];
|
|
2350
|
+
/** ProductImage */
|
|
2062
2351
|
ProductImage: {
|
|
2063
2352
|
id: string;
|
|
2064
2353
|
title: string | null;
|
|
@@ -2068,7 +2357,8 @@ interface components {
|
|
|
2068
2357
|
url_thumbnail: string;
|
|
2069
2358
|
url_standard: string;
|
|
2070
2359
|
url_zoom: string;
|
|
2071
|
-
};
|
|
2360
|
+
};
|
|
2361
|
+
/** ProductPricing */
|
|
2072
2362
|
ProductPricing: {
|
|
2073
2363
|
currency: string;
|
|
2074
2364
|
/**
|
|
@@ -2076,18 +2366,24 @@ interface components {
|
|
|
2076
2366
|
* @example GST
|
|
2077
2367
|
* @constant
|
|
2078
2368
|
*/
|
|
2079
|
-
tax_type: "GST";
|
|
2369
|
+
tax_type: "GST";
|
|
2370
|
+
/** Format: double */
|
|
2080
2371
|
tax_rate: number;
|
|
2081
2372
|
/**
|
|
2082
2373
|
* Format: double
|
|
2083
2374
|
* @example false
|
|
2084
2375
|
*/
|
|
2085
|
-
price_including_tax: boolean;
|
|
2086
|
-
|
|
2087
|
-
|
|
2376
|
+
price_including_tax: boolean;
|
|
2377
|
+
/** Format: double */
|
|
2378
|
+
listing_price: number;
|
|
2379
|
+
/** Format: double */
|
|
2380
|
+
selling_price: number;
|
|
2381
|
+
/** @default 1 */
|
|
2088
2382
|
min_order_quantity: number;
|
|
2089
|
-
max_order_quantity: number | null;
|
|
2090
|
-
|
|
2383
|
+
max_order_quantity: number | null;
|
|
2384
|
+
/** @default 1 */
|
|
2385
|
+
incremental_quantity: number;
|
|
2386
|
+
/** Format: double */
|
|
2091
2387
|
selling_price_excluding_tax: number;
|
|
2092
2388
|
};
|
|
2093
2389
|
/**
|
|
@@ -2095,22 +2391,27 @@ interface components {
|
|
|
2095
2391
|
* @description Active promotion on a product. `null` when `on_promotion` is `false`. The `details` field uses `promotion_type` as discriminator to determine the promotion structure.
|
|
2096
2392
|
*/
|
|
2097
2393
|
ProductPromotion: {
|
|
2098
|
-
id: string;
|
|
2394
|
+
id: string;
|
|
2395
|
+
/** Format: date-time */
|
|
2099
2396
|
starts_at: string;
|
|
2100
2397
|
/**
|
|
2101
2398
|
* Format: date-time
|
|
2102
2399
|
* @description When the promotion ends. `null` for promotions with no expiry.
|
|
2103
2400
|
*/
|
|
2104
|
-
expires_at: string | null;
|
|
2401
|
+
expires_at: string | null;
|
|
2402
|
+
/** @description Promotion rules and pricing. Use `promotion_type` to determine the structure: `discount` (percentage/flat off), `fixed-price` (override price), `volume-based` (buy X at Y price), or `free-goods` (buy X get Y free). */
|
|
2105
2403
|
details: components["schemas"]["DiscountBasedPromotion"] | components["schemas"]["FixedPricePromotion"] | components["schemas"]["VolumeBasedPromotion"] | components["schemas"]["FreeGoodsPromotion"];
|
|
2106
|
-
} | null;
|
|
2404
|
+
} | null;
|
|
2405
|
+
/** ProductReview */
|
|
2107
2406
|
ProductReview: {
|
|
2108
2407
|
/**
|
|
2109
2408
|
* Format: double
|
|
2110
2409
|
* @description The rating of the product review. Must be in rang 1-5 (multiple of 0.5)
|
|
2111
2410
|
*/
|
|
2112
|
-
rating?: $Read$1<number>;
|
|
2113
|
-
|
|
2411
|
+
rating?: $Read$1<number>;
|
|
2412
|
+
/** @description The text for the product review. */
|
|
2413
|
+
review_text?: $Read$1<string>;
|
|
2414
|
+
/** @description The name of the reviewer. */
|
|
2114
2415
|
name?: $Read$1<string>;
|
|
2115
2416
|
/**
|
|
2116
2417
|
* Format: email
|
|
@@ -2122,14 +2423,16 @@ interface components {
|
|
|
2122
2423
|
* @description Reviews with approved status will be displayed.
|
|
2123
2424
|
* @enum {string}
|
|
2124
2425
|
*/
|
|
2125
|
-
status?: $Read$1<"approved">;
|
|
2426
|
+
status?: $Read$1<"approved">;
|
|
2427
|
+
/** @default false */
|
|
2126
2428
|
is_featured: boolean;
|
|
2127
2429
|
tags?: string[];
|
|
2128
2430
|
/**
|
|
2129
2431
|
* Format: date-time
|
|
2130
2432
|
* @description The ISO 8601 date-time for when review was first submitted or last modified by the original submitter.
|
|
2131
2433
|
*/
|
|
2132
|
-
review_date?: $Read$1<string>;
|
|
2434
|
+
review_date?: $Read$1<string>;
|
|
2435
|
+
/** @description Product review images ordered by display priority. */
|
|
2133
2436
|
images?: components["schemas"]["ProductImage"][];
|
|
2134
2437
|
videos?: components["schemas"]["ProductVideo"][];
|
|
2135
2438
|
/**
|
|
@@ -2144,35 +2447,46 @@ interface components {
|
|
|
2144
2447
|
* @example 2023-05-25T14:15:22Z
|
|
2145
2448
|
*/
|
|
2146
2449
|
modified_at?: $Read$1<string>;
|
|
2147
|
-
};
|
|
2450
|
+
};
|
|
2451
|
+
/** ProductShipping */
|
|
2148
2452
|
ProductShipping: {
|
|
2149
2453
|
handling_charges_including_tax: number;
|
|
2150
2454
|
handling_charges_excluding_tax: number;
|
|
2151
2455
|
tax_type: string;
|
|
2152
2456
|
tax_rate: number;
|
|
2153
|
-
} | null;
|
|
2457
|
+
} | null;
|
|
2458
|
+
/** ProductSubscription */
|
|
2154
2459
|
ProductSubscription: {
|
|
2155
2460
|
id: string;
|
|
2156
|
-
subscription_plan: string;
|
|
2157
|
-
|
|
2461
|
+
subscription_plan: string;
|
|
2462
|
+
/** Format: double */
|
|
2463
|
+
subscription_price: number;
|
|
2464
|
+
/** @description Billing interval determines the frequency for which the customer is charged for the subscription itself. */
|
|
2158
2465
|
billing_interval: number;
|
|
2159
2466
|
/**
|
|
2160
2467
|
* @example monthly
|
|
2161
2468
|
* @enum {string}
|
|
2162
2469
|
*/
|
|
2163
|
-
billing_frequency: "weekly" | "monthly" | "annually";
|
|
2164
|
-
|
|
2165
|
-
|
|
2470
|
+
billing_frequency: "weekly" | "monthly" | "annually";
|
|
2471
|
+
/** @description Optionally limit the number of times this subscription will invoice the customer. */
|
|
2472
|
+
billing_limit: number;
|
|
2473
|
+
/** @default false */
|
|
2474
|
+
fulfill_separately: boolean;
|
|
2475
|
+
/** @description order interval defines the frequency of when the subscription sends customers the product */
|
|
2166
2476
|
order_interval: number;
|
|
2167
2477
|
/**
|
|
2168
2478
|
* @example monthly
|
|
2169
2479
|
* @enum {string}
|
|
2170
2480
|
*/
|
|
2171
|
-
order_frequency: "weekly" | "monthly" | "annully";
|
|
2172
|
-
|
|
2173
|
-
|
|
2481
|
+
order_frequency: "weekly" | "monthly" | "annully";
|
|
2482
|
+
/** @description By default this is set to unlimited, meaning the subscription will fulfill indefinitely. Changing the Limit to 10 would force the subscription to end after the tenth interval had been fulfilled. */
|
|
2483
|
+
order_limit: number;
|
|
2484
|
+
/** @description The quantity of the plan to which the customer should be subscribed */
|
|
2485
|
+
minimum_quantity: number;
|
|
2486
|
+
/** @description Use in digital product only for trial period */
|
|
2174
2487
|
billing_trial_days: number;
|
|
2175
|
-
};
|
|
2488
|
+
};
|
|
2489
|
+
/** ProductVideo */
|
|
2176
2490
|
ProductVideo: {
|
|
2177
2491
|
title: string | null;
|
|
2178
2492
|
alternate_text: string | null;
|
|
@@ -2180,20 +2494,25 @@ interface components {
|
|
|
2180
2494
|
video_preview_url: string;
|
|
2181
2495
|
video_stream_hls_url: string;
|
|
2182
2496
|
video_stream_dash_url: string;
|
|
2183
|
-
image_thumbnail_url: string;
|
|
2497
|
+
image_thumbnail_url: string;
|
|
2498
|
+
/** @description in seconds */
|
|
2184
2499
|
video_duration: number;
|
|
2185
|
-
};
|
|
2500
|
+
};
|
|
2501
|
+
/** Promotion */
|
|
2186
2502
|
Promotion: (components["schemas"]["DiscountCouponPromotion"] | components["schemas"]["FreeGoodCouponPromotion"] | components["schemas"]["BuyXGetYCouponPromotion"] | components["schemas"]["VolumeBasedCouponPromotion"] | components["schemas"]["FreeShipingCouponPromotion"]) & {
|
|
2187
|
-
/** @enum {unknown} */
|
|
2503
|
+
/** @enum {unknown} */
|
|
2504
|
+
promotion_type: "discount" | "free-goods" | "free-shipping" | "buy-x-get-y" | "volume-based";
|
|
2188
2505
|
can_be_used_with_other_promotion: boolean;
|
|
2189
|
-
};
|
|
2506
|
+
};
|
|
2507
|
+
/** @enum {unknown} */
|
|
2190
2508
|
PromotionType: "discount" | "free-goods" | "free-shipping" | "buy-x-get-y" | "volume-based";
|
|
2191
2509
|
/**
|
|
2192
2510
|
* SearchProduct
|
|
2193
2511
|
* @description Payload for searching products.
|
|
2194
2512
|
*/
|
|
2195
2513
|
SearchProduct: {
|
|
2196
|
-
/** @description String for searching products, considers the first ten words of any given search query. */
|
|
2514
|
+
/** @description String for searching products, considers the first ten words of any given search query. */
|
|
2515
|
+
query: string;
|
|
2197
2516
|
/**
|
|
2198
2517
|
* @description To request a specific page of results.
|
|
2199
2518
|
* @default 1
|
|
@@ -2203,7 +2522,8 @@ interface components {
|
|
|
2203
2522
|
* @description Maximum number of records returned for a page.
|
|
2204
2523
|
* @default 25
|
|
2205
2524
|
*/
|
|
2206
|
-
limit: number;
|
|
2525
|
+
limit: number;
|
|
2526
|
+
/** @description provide list of attributes for specific facets or * for all facets. All attributes supported in the filter parameter are also supported here. */
|
|
2207
2527
|
facets?: string[];
|
|
2208
2528
|
/**
|
|
2209
2529
|
* @description Filter expression(s) to narrow results. Omit for no filtering.
|
|
@@ -2252,14 +2572,16 @@ interface components {
|
|
|
2252
2572
|
* @example product_name:asc
|
|
2253
2573
|
*/
|
|
2254
2574
|
sort?: string[];
|
|
2255
|
-
};
|
|
2575
|
+
};
|
|
2576
|
+
/** SellerInfo */
|
|
2256
2577
|
SellerInfo: {
|
|
2257
2578
|
id: string;
|
|
2258
2579
|
trade_name: string;
|
|
2259
2580
|
legal_name: string;
|
|
2260
2581
|
business_type: string;
|
|
2261
2582
|
tax_identification_number: string;
|
|
2262
|
-
};
|
|
2583
|
+
};
|
|
2584
|
+
/** Seo */
|
|
2263
2585
|
Seo: {
|
|
2264
2586
|
title: string | null;
|
|
2265
2587
|
description: string | null;
|
|
@@ -2279,7 +2601,8 @@ interface components {
|
|
|
2279
2601
|
quantity?: number;
|
|
2280
2602
|
free_quantity?: number;
|
|
2281
2603
|
is_free_item?: boolean;
|
|
2282
|
-
};
|
|
2604
|
+
};
|
|
2605
|
+
/** @enum {unknown} */
|
|
2283
2606
|
ShipmentStatus: "unscheduled" | "schedule_requested" | "scheduled" | "packed" | "shipped" | "in_transit" | "out_for_delivery" | "delivery_attempted" | "undelivered" | "return_to_origin" | "delivered" | "cancelled" | "lost";
|
|
2284
2607
|
/**
|
|
2285
2608
|
* SingleSelectAttribute
|
|
@@ -2287,22 +2610,27 @@ interface components {
|
|
|
2287
2610
|
*/
|
|
2288
2611
|
SingleSelectAttribute: {
|
|
2289
2612
|
id: string;
|
|
2290
|
-
name: string;
|
|
2613
|
+
name: string;
|
|
2614
|
+
/** @description A lookup safe version of the name that is lowercased and spaces are replaced with underscores. For instance, if name is `Product Type`, key will be `product_type` */
|
|
2291
2615
|
key: string;
|
|
2292
2616
|
/**
|
|
2293
2617
|
* @description discriminator enum property added by openapi-typescript
|
|
2294
2618
|
* @enum {string}
|
|
2295
2619
|
*/
|
|
2296
|
-
type: "single-select";
|
|
2620
|
+
type: "single-select";
|
|
2621
|
+
/** @description For single-select attributes */
|
|
2297
2622
|
value: string;
|
|
2298
|
-
};
|
|
2623
|
+
};
|
|
2624
|
+
/** SingleSelectOption */
|
|
2299
2625
|
SingleSelectOption: {
|
|
2300
|
-
/** @description The name of the associated option. */
|
|
2626
|
+
/** @description The name of the associated option. */
|
|
2627
|
+
name: string;
|
|
2301
2628
|
/**
|
|
2302
2629
|
* @description The type of the associated option.
|
|
2303
2630
|
* @constant
|
|
2304
2631
|
*/
|
|
2305
|
-
type: "single-select";
|
|
2632
|
+
type: "single-select";
|
|
2633
|
+
/** @description The value of the associated option */
|
|
2306
2634
|
value: string;
|
|
2307
2635
|
};
|
|
2308
2636
|
/**
|
|
@@ -2311,13 +2639,15 @@ interface components {
|
|
|
2311
2639
|
*/
|
|
2312
2640
|
TextAttribute: {
|
|
2313
2641
|
id: string;
|
|
2314
|
-
name: string;
|
|
2642
|
+
name: string;
|
|
2643
|
+
/** @description A lookup safe version of the name that is lowercased and spaces are replaced with underscores. For instance, if name is `Product Type`, key will be `product_type` */
|
|
2315
2644
|
key: string;
|
|
2316
2645
|
/**
|
|
2317
2646
|
* @description discriminator enum property added by openapi-typescript
|
|
2318
2647
|
* @enum {string}
|
|
2319
2648
|
*/
|
|
2320
|
-
type: "text";
|
|
2649
|
+
type: "text";
|
|
2650
|
+
/** @description For text attributes */
|
|
2321
2651
|
value: string;
|
|
2322
2652
|
};
|
|
2323
2653
|
/**
|
|
@@ -2347,21 +2677,30 @@ interface components {
|
|
|
2347
2677
|
*/
|
|
2348
2678
|
UpiPayment: components["schemas"]["PaymentInfo"] & {
|
|
2349
2679
|
upi_id?: string;
|
|
2350
|
-
};
|
|
2680
|
+
};
|
|
2681
|
+
/** ProductVariant */
|
|
2351
2682
|
Variant: {
|
|
2352
|
-
/** @description variant id */
|
|
2353
|
-
|
|
2683
|
+
/** @description variant id */
|
|
2684
|
+
id: string;
|
|
2685
|
+
/** @description product id */
|
|
2686
|
+
product_id: string;
|
|
2687
|
+
/** @description variant sku */
|
|
2354
2688
|
sku: string | null;
|
|
2355
|
-
slug: string;
|
|
2356
|
-
|
|
2689
|
+
slug: string;
|
|
2690
|
+
/** @description variant name */
|
|
2691
|
+
name: string;
|
|
2692
|
+
/** @description variant name */
|
|
2357
2693
|
product_name: string;
|
|
2358
2694
|
short_description: string | null;
|
|
2359
2695
|
active: $Read$1<boolean>;
|
|
2360
|
-
stock_available: $Read$1<boolean>;
|
|
2696
|
+
stock_available: $Read$1<boolean>;
|
|
2697
|
+
/** @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. */
|
|
2361
2698
|
backorder?: boolean;
|
|
2362
2699
|
on_promotion: $Read$1<boolean>;
|
|
2363
|
-
on_subscription: $Read$1<boolean>;
|
|
2364
|
-
|
|
2700
|
+
on_subscription: $Read$1<boolean>;
|
|
2701
|
+
/** @description Indicates whether a variant is marked as the default variant for a product */
|
|
2702
|
+
is_default: $Read$1<boolean>;
|
|
2703
|
+
/** @description This object contains multiple dynamic keys. Each key is a string derived from the attribute key, and the value is an object of the type `AssociatedOption`. */
|
|
2365
2704
|
associated_options: components["schemas"]["AssociatedOption"];
|
|
2366
2705
|
images: components["schemas"]["ProductImage"][];
|
|
2367
2706
|
videos: components["schemas"]["ProductVideo"][];
|
|
@@ -2369,7 +2708,8 @@ interface components {
|
|
|
2369
2708
|
subscription: components["schemas"]["ProductSubscription"][];
|
|
2370
2709
|
promotion: components["schemas"]["ProductPromotion"];
|
|
2371
2710
|
inventory?: components["schemas"]["LotBatchDetail"][];
|
|
2372
|
-
};
|
|
2711
|
+
};
|
|
2712
|
+
/** VariantDetail */
|
|
2373
2713
|
VariantDetail: components["schemas"]["Variant"] & {
|
|
2374
2714
|
/**
|
|
2375
2715
|
* @example physical
|
|
@@ -2390,10 +2730,14 @@ interface components {
|
|
|
2390
2730
|
metadata: {
|
|
2391
2731
|
[key: string]: string;
|
|
2392
2732
|
} | null;
|
|
2393
|
-
};
|
|
2733
|
+
};
|
|
2734
|
+
/** VariantOption */
|
|
2394
2735
|
VariantOption: {
|
|
2395
|
-
/** @description The name of the associated option. */
|
|
2396
|
-
|
|
2736
|
+
/** @description The name of the associated option. */
|
|
2737
|
+
name: string;
|
|
2738
|
+
/** @description A lookup safe version of the name that is lowercased and spaces are replaced with underscores. For instance, if name is `Product Type`, key will be `product_type` */
|
|
2739
|
+
key: string;
|
|
2740
|
+
/** @enum {string} */
|
|
2397
2741
|
type: "single-select" | "color";
|
|
2398
2742
|
/**
|
|
2399
2743
|
* @description When option_type is color, value will contain an array of objects like:
|
|
@@ -2411,11 +2755,14 @@ interface components {
|
|
|
2411
2755
|
* ```
|
|
2412
2756
|
*/
|
|
2413
2757
|
value: (string | Record<string, never>)[];
|
|
2414
|
-
};
|
|
2758
|
+
};
|
|
2759
|
+
/** VolumeBasedCouponPromotion */
|
|
2415
2760
|
VolumeBasedCouponPromotion: components["schemas"]["CouponPromotionCommonDetail"] & {
|
|
2416
|
-
details: components["schemas"]["VolumeBasedRule"];
|
|
2761
|
+
details: components["schemas"]["VolumeBasedRule"];
|
|
2762
|
+
/** @enum {unknown} */
|
|
2417
2763
|
applies_to_product: "product";
|
|
2418
|
-
};
|
|
2764
|
+
};
|
|
2765
|
+
/** VolumeBasedPromotion */
|
|
2419
2766
|
VolumeBasedPromotion: {
|
|
2420
2767
|
/**
|
|
2421
2768
|
* @description discriminator enum property added by openapi-typescript
|
|
@@ -2423,28 +2770,34 @@ interface components {
|
|
|
2423
2770
|
*/
|
|
2424
2771
|
promotion_type: "volume-based";
|
|
2425
2772
|
slabs: {
|
|
2426
|
-
/** @description The minimum quantity required to qualify for the discount. */
|
|
2773
|
+
/** @description The minimum quantity required to qualify for the discount. */
|
|
2774
|
+
quantity_limit: number;
|
|
2775
|
+
/** @description The percentage discount applied when the quantity limit is reached. */
|
|
2427
2776
|
discount_percent: $Read$1<number>;
|
|
2428
2777
|
}[];
|
|
2429
|
-
};
|
|
2778
|
+
};
|
|
2779
|
+
/** VolumeBasedRule */
|
|
2430
2780
|
VolumeBasedRule: {
|
|
2431
2781
|
products: {
|
|
2432
2782
|
product_id: string | null;
|
|
2433
2783
|
variant_id: string | null;
|
|
2434
2784
|
slabs: {
|
|
2435
|
-
quantity: number;
|
|
2785
|
+
quantity: number;
|
|
2786
|
+
/** @enum {unknown} */
|
|
2436
2787
|
condition: "less-or-equal" | "greater";
|
|
2437
2788
|
discount_percent: number;
|
|
2438
2789
|
}[];
|
|
2439
2790
|
}[];
|
|
2440
2791
|
maximum_discount_amount: number | null;
|
|
2441
|
-
};
|
|
2792
|
+
};
|
|
2793
|
+
/** WalletPayment */
|
|
2442
2794
|
WalletPayment: components["schemas"]["PaymentInfo"] & {
|
|
2443
2795
|
wallet_name?: string;
|
|
2444
2796
|
};
|
|
2445
2797
|
};
|
|
2446
2798
|
responses: {
|
|
2447
|
-
/** @description Bad request */
|
|
2799
|
+
/** @description Bad request */
|
|
2800
|
+
BadRequest: {
|
|
2448
2801
|
headers: {
|
|
2449
2802
|
[name: string]: unknown;
|
|
2450
2803
|
};
|
|
@@ -2456,7 +2809,8 @@ interface components {
|
|
|
2456
2809
|
error?: Record<string, never>;
|
|
2457
2810
|
};
|
|
2458
2811
|
};
|
|
2459
|
-
};
|
|
2812
|
+
};
|
|
2813
|
+
/** @description Requested resource not found */
|
|
2460
2814
|
NotFound: {
|
|
2461
2815
|
headers: {
|
|
2462
2816
|
[name: string]: unknown;
|
|
@@ -2468,31 +2822,38 @@ interface components {
|
|
|
2468
2822
|
code: string;
|
|
2469
2823
|
};
|
|
2470
2824
|
};
|
|
2471
|
-
};
|
|
2825
|
+
};
|
|
2826
|
+
/** @description Not authorized for given operation on the Resource */
|
|
2472
2827
|
Unauthorized: {
|
|
2473
2828
|
headers: {
|
|
2474
2829
|
[name: string]: unknown;
|
|
2475
2830
|
};
|
|
2476
2831
|
content: {
|
|
2477
2832
|
"application/json": {
|
|
2478
|
-
/** @example Not authorized for given operation on the Resource. */
|
|
2479
|
-
|
|
2833
|
+
/** @example Not authorized for given operation on the Resource. */
|
|
2834
|
+
message: string;
|
|
2835
|
+
/** @default false */
|
|
2836
|
+
success: boolean;
|
|
2837
|
+
/** @example unauthorized */
|
|
2480
2838
|
code: string;
|
|
2481
2839
|
};
|
|
2482
2840
|
};
|
|
2483
|
-
};
|
|
2841
|
+
};
|
|
2842
|
+
/** @description Payload accepted */
|
|
2484
2843
|
WebhookAccepted: {
|
|
2485
2844
|
headers: {
|
|
2486
2845
|
[name: string]: unknown;
|
|
2487
2846
|
};
|
|
2488
2847
|
content?: never;
|
|
2489
|
-
};
|
|
2848
|
+
};
|
|
2849
|
+
/** @description Endpoint permanently removed */
|
|
2490
2850
|
WebhookGone: {
|
|
2491
2851
|
headers: {
|
|
2492
2852
|
[name: string]: unknown;
|
|
2493
2853
|
};
|
|
2494
2854
|
content?: never;
|
|
2495
|
-
};
|
|
2855
|
+
};
|
|
2856
|
+
/** @description Temporary server error — we will retry */
|
|
2496
2857
|
WebhookServerError: {
|
|
2497
2858
|
headers: {
|
|
2498
2859
|
[name: string]: unknown;
|
|
@@ -2501,11 +2862,17 @@ interface components {
|
|
|
2501
2862
|
};
|
|
2502
2863
|
};
|
|
2503
2864
|
parameters: {
|
|
2504
|
-
/** @description This param is used to determine product pricing, promotions, and subscription rates. If a valid customer group id is provided, pricing details will be retrieved accordingly. If no matching data is found for the specified customer group id, the system will fall back to the default customer group id. If no data is found for the default group either, the highest applicable price will be returned. */
|
|
2505
|
-
|
|
2506
|
-
|
|
2507
|
-
|
|
2508
|
-
|
|
2865
|
+
/** @description This param is used to determine product pricing, promotions, and subscription rates. If a valid customer group id is provided, pricing details will be retrieved accordingly. If no matching data is found for the specified customer group id, the system will fall back to the default customer group id. If no data is found for the default group either, the highest applicable price will be returned. */
|
|
2866
|
+
CustomerGroupId: string;
|
|
2867
|
+
/** @description This param is used to enable debug mode. If debug mode is enabled, the API will return OTP as well. This is only for development and testing purposes. */
|
|
2868
|
+
DebugMode: boolean;
|
|
2869
|
+
/** @description Number of results per page. */
|
|
2870
|
+
pageLimitParam: number;
|
|
2871
|
+
/** @description page number of pagination list */
|
|
2872
|
+
pageParam: number;
|
|
2873
|
+
/** @description search keyword */
|
|
2874
|
+
searchKeyword: string;
|
|
2875
|
+
/** @description JSON string format: {"field1":"asc", "field2":"desc"} */
|
|
2509
2876
|
sortingParam: string;
|
|
2510
2877
|
};
|
|
2511
2878
|
requestBodies: never;
|
|
@@ -2517,7 +2884,8 @@ interface operations {
|
|
|
2517
2884
|
parameters: {
|
|
2518
2885
|
query?: never;
|
|
2519
2886
|
header?: {
|
|
2520
|
-
/** @description This param is used to enable debug mode. If debug mode is enabled, the API will return OTP as well. This is only for development and testing purposes. */
|
|
2887
|
+
/** @description This param is used to enable debug mode. If debug mode is enabled, the API will return OTP as well. This is only for development and testing purposes. */
|
|
2888
|
+
"x-debug-mode"?: components["parameters"]["DebugMode"];
|
|
2521
2889
|
};
|
|
2522
2890
|
path?: never;
|
|
2523
2891
|
cookie?: never;
|
|
@@ -2531,7 +2899,8 @@ interface operations {
|
|
|
2531
2899
|
};
|
|
2532
2900
|
};
|
|
2533
2901
|
responses: {
|
|
2534
|
-
/** @description OK */
|
|
2902
|
+
/** @description OK */
|
|
2903
|
+
200: {
|
|
2535
2904
|
headers: {
|
|
2536
2905
|
[name: string]: unknown;
|
|
2537
2906
|
};
|
|
@@ -2540,7 +2909,8 @@ interface operations {
|
|
|
2540
2909
|
message: string;
|
|
2541
2910
|
success: boolean;
|
|
2542
2911
|
content: {
|
|
2543
|
-
otp_token: string;
|
|
2912
|
+
otp_token: string;
|
|
2913
|
+
/** @constant */
|
|
2544
2914
|
otp_action: "login";
|
|
2545
2915
|
};
|
|
2546
2916
|
};
|
|
@@ -2554,7 +2924,8 @@ interface operations {
|
|
|
2554
2924
|
parameters: {
|
|
2555
2925
|
query?: never;
|
|
2556
2926
|
header?: {
|
|
2557
|
-
/** @description This param is used to enable debug mode. If debug mode is enabled, the API will return OTP as well. This is only for development and testing purposes. */
|
|
2927
|
+
/** @description This param is used to enable debug mode. If debug mode is enabled, the API will return OTP as well. This is only for development and testing purposes. */
|
|
2928
|
+
"x-debug-mode"?: components["parameters"]["DebugMode"];
|
|
2558
2929
|
};
|
|
2559
2930
|
path?: never;
|
|
2560
2931
|
cookie?: never;
|
|
@@ -2562,7 +2933,8 @@ interface operations {
|
|
|
2562
2933
|
requestBody: {
|
|
2563
2934
|
content: {
|
|
2564
2935
|
"application/json": {
|
|
2565
|
-
location_id: string;
|
|
2936
|
+
location_id: string;
|
|
2937
|
+
/** @description 10 digit phone number without country code. */
|
|
2566
2938
|
phone: string;
|
|
2567
2939
|
/**
|
|
2568
2940
|
* @description Two-letter code begin with a plus sign prefix that identifies different countries. By default it will be +91 if not provided.
|
|
@@ -2573,7 +2945,8 @@ interface operations {
|
|
|
2573
2945
|
};
|
|
2574
2946
|
};
|
|
2575
2947
|
responses: {
|
|
2576
|
-
/** @description OK */
|
|
2948
|
+
/** @description OK */
|
|
2949
|
+
200: {
|
|
2577
2950
|
headers: {
|
|
2578
2951
|
[name: string]: unknown;
|
|
2579
2952
|
};
|
|
@@ -2582,7 +2955,8 @@ interface operations {
|
|
|
2582
2955
|
message: string;
|
|
2583
2956
|
success: boolean;
|
|
2584
2957
|
content: {
|
|
2585
|
-
otp_token: string;
|
|
2958
|
+
otp_token: string;
|
|
2959
|
+
/** @constant */
|
|
2586
2960
|
otp_action: "login";
|
|
2587
2961
|
};
|
|
2588
2962
|
};
|
|
@@ -2596,7 +2970,8 @@ interface operations {
|
|
|
2596
2970
|
parameters: {
|
|
2597
2971
|
query?: never;
|
|
2598
2972
|
header?: {
|
|
2599
|
-
/** @description This param is used to enable debug mode. If debug mode is enabled, the API will return OTP as well. This is only for development and testing purposes. */
|
|
2973
|
+
/** @description This param is used to enable debug mode. If debug mode is enabled, the API will return OTP as well. This is only for development and testing purposes. */
|
|
2974
|
+
"x-debug-mode"?: components["parameters"]["DebugMode"];
|
|
2600
2975
|
};
|
|
2601
2976
|
path?: never;
|
|
2602
2977
|
cookie?: never;
|
|
@@ -2604,7 +2979,8 @@ interface operations {
|
|
|
2604
2979
|
requestBody: {
|
|
2605
2980
|
content: {
|
|
2606
2981
|
"application/json": {
|
|
2607
|
-
location_id: string;
|
|
2982
|
+
location_id: string;
|
|
2983
|
+
/** @description 10 digit phone number without country code linked with WhatsApp. */
|
|
2608
2984
|
phone: string;
|
|
2609
2985
|
/**
|
|
2610
2986
|
* @description Two-letter code begin with a plus sign prefix that identifies different countries. By default it will be +91 if not provided.
|
|
@@ -2615,7 +2991,8 @@ interface operations {
|
|
|
2615
2991
|
};
|
|
2616
2992
|
};
|
|
2617
2993
|
responses: {
|
|
2618
|
-
/** @description OK */
|
|
2994
|
+
/** @description OK */
|
|
2995
|
+
200: {
|
|
2619
2996
|
headers: {
|
|
2620
2997
|
[name: string]: unknown;
|
|
2621
2998
|
};
|
|
@@ -2624,7 +3001,8 @@ interface operations {
|
|
|
2624
3001
|
message: string;
|
|
2625
3002
|
success: boolean;
|
|
2626
3003
|
content: {
|
|
2627
|
-
otp_token: string;
|
|
3004
|
+
otp_token: string;
|
|
3005
|
+
/** @constant */
|
|
2628
3006
|
otp_action: "login";
|
|
2629
3007
|
};
|
|
2630
3008
|
};
|
|
@@ -2643,7 +3021,8 @@ interface operations {
|
|
|
2643
3021
|
};
|
|
2644
3022
|
requestBody?: never;
|
|
2645
3023
|
responses: {
|
|
2646
|
-
/** @description OK */
|
|
3024
|
+
/** @description OK */
|
|
3025
|
+
200: {
|
|
2647
3026
|
headers: {
|
|
2648
3027
|
[name: string]: unknown;
|
|
2649
3028
|
};
|
|
@@ -2672,7 +3051,8 @@ interface operations {
|
|
|
2672
3051
|
};
|
|
2673
3052
|
};
|
|
2674
3053
|
responses: {
|
|
2675
|
-
/** @description OK */
|
|
3054
|
+
/** @description OK */
|
|
3055
|
+
200: {
|
|
2676
3056
|
headers: {
|
|
2677
3057
|
[name: string]: unknown;
|
|
2678
3058
|
};
|
|
@@ -2705,7 +3085,8 @@ interface operations {
|
|
|
2705
3085
|
};
|
|
2706
3086
|
};
|
|
2707
3087
|
responses: {
|
|
2708
|
-
/** @description OK */
|
|
3088
|
+
/** @description OK */
|
|
3089
|
+
200: {
|
|
2709
3090
|
headers: {
|
|
2710
3091
|
[name: string]: unknown;
|
|
2711
3092
|
};
|
|
@@ -2733,7 +3114,9 @@ interface operations {
|
|
|
2733
3114
|
requestBody: {
|
|
2734
3115
|
content: {
|
|
2735
3116
|
"application/json": {
|
|
2736
|
-
/** @description A string representing the one-time password. */
|
|
3117
|
+
/** @description A string representing the one-time password. */
|
|
3118
|
+
otp: string;
|
|
3119
|
+
/** @description A string representing the OTP token. */
|
|
2737
3120
|
otp_token: string;
|
|
2738
3121
|
/**
|
|
2739
3122
|
* @description A string indicating the action to be performed.
|
|
@@ -2744,7 +3127,8 @@ interface operations {
|
|
|
2744
3127
|
};
|
|
2745
3128
|
};
|
|
2746
3129
|
responses: {
|
|
2747
|
-
/** @description OK */
|
|
3130
|
+
/** @description OK */
|
|
3131
|
+
200: {
|
|
2748
3132
|
headers: {
|
|
2749
3133
|
[name: string]: unknown;
|
|
2750
3134
|
};
|
|
@@ -2782,7 +3166,8 @@ interface operations {
|
|
|
2782
3166
|
};
|
|
2783
3167
|
};
|
|
2784
3168
|
responses: {
|
|
2785
|
-
/** @description OK */
|
|
3169
|
+
/** @description OK */
|
|
3170
|
+
200: {
|
|
2786
3171
|
headers: {
|
|
2787
3172
|
[name: string]: unknown;
|
|
2788
3173
|
};
|
|
@@ -2805,14 +3190,16 @@ interface operations {
|
|
|
2805
3190
|
parameters: {
|
|
2806
3191
|
query?: never;
|
|
2807
3192
|
header?: {
|
|
2808
|
-
/** @description This param is used to determine product pricing, promotions, and subscription rates. If a valid customer group id is provided, pricing details will be retrieved accordingly. If no matching data is found for the specified customer group id, the system will fall back to the default customer group id. If no data is found for the default group either, the highest applicable price will be returned. */
|
|
3193
|
+
/** @description This param is used to determine product pricing, promotions, and subscription rates. If a valid customer group id is provided, pricing details will be retrieved accordingly. If no matching data is found for the specified customer group id, the system will fall back to the default customer group id. If no data is found for the default group either, the highest applicable price will be returned. */
|
|
3194
|
+
"x-customer-group-id"?: components["parameters"]["CustomerGroupId"];
|
|
2809
3195
|
};
|
|
2810
3196
|
path?: never;
|
|
2811
3197
|
cookie?: never;
|
|
2812
3198
|
};
|
|
2813
3199
|
requestBody?: never;
|
|
2814
3200
|
responses: {
|
|
2815
|
-
/** @description OK */
|
|
3201
|
+
/** @description OK */
|
|
3202
|
+
200: {
|
|
2816
3203
|
headers: {
|
|
2817
3204
|
[name: string]: unknown;
|
|
2818
3205
|
};
|
|
@@ -2835,14 +3222,16 @@ interface operations {
|
|
|
2835
3222
|
parameters: {
|
|
2836
3223
|
query?: never;
|
|
2837
3224
|
header?: {
|
|
2838
|
-
/** @description This param is used to determine product pricing, promotions, and subscription rates. If a valid customer group id is provided, pricing details will be retrieved accordingly. If no matching data is found for the specified customer group id, the system will fall back to the default customer group id. If no data is found for the default group either, the highest applicable price will be returned. */
|
|
3225
|
+
/** @description This param is used to determine product pricing, promotions, and subscription rates. If a valid customer group id is provided, pricing details will be retrieved accordingly. If no matching data is found for the specified customer group id, the system will fall back to the default customer group id. If no data is found for the default group either, the highest applicable price will be returned. */
|
|
3226
|
+
"x-customer-group-id"?: components["parameters"]["CustomerGroupId"];
|
|
2839
3227
|
};
|
|
2840
3228
|
path?: never;
|
|
2841
3229
|
cookie?: never;
|
|
2842
3230
|
};
|
|
2843
3231
|
requestBody?: never;
|
|
2844
3232
|
responses: {
|
|
2845
|
-
/** @description OK */
|
|
3233
|
+
/** @description OK */
|
|
3234
|
+
200: {
|
|
2846
3235
|
headers: {
|
|
2847
3236
|
[name: string]: unknown;
|
|
2848
3237
|
};
|
|
@@ -2864,19 +3253,22 @@ interface operations {
|
|
|
2864
3253
|
query?: never;
|
|
2865
3254
|
header?: never;
|
|
2866
3255
|
path: {
|
|
2867
|
-
/** @description User ID */
|
|
3256
|
+
/** @description User ID */
|
|
3257
|
+
user_id: string;
|
|
2868
3258
|
};
|
|
2869
3259
|
cookie?: never;
|
|
2870
3260
|
};
|
|
2871
3261
|
requestBody?: never;
|
|
2872
3262
|
responses: {
|
|
2873
|
-
/** @description OK */
|
|
3263
|
+
/** @description OK */
|
|
3264
|
+
200: {
|
|
2874
3265
|
headers: {
|
|
2875
3266
|
[name: string]: unknown;
|
|
2876
3267
|
};
|
|
2877
3268
|
content: {
|
|
2878
3269
|
"application/json": {
|
|
2879
|
-
/** @example cart details */
|
|
3270
|
+
/** @example cart details */
|
|
3271
|
+
message: $Read$1<string>;
|
|
2880
3272
|
success: $Read$1<boolean>;
|
|
2881
3273
|
content: {
|
|
2882
3274
|
cart: components["schemas"]["Cart"];
|
|
@@ -2893,19 +3285,22 @@ interface operations {
|
|
|
2893
3285
|
query?: never;
|
|
2894
3286
|
header?: never;
|
|
2895
3287
|
path: {
|
|
2896
|
-
/** @description Cart ID */
|
|
3288
|
+
/** @description Cart ID */
|
|
3289
|
+
id: string;
|
|
2897
3290
|
};
|
|
2898
3291
|
cookie?: never;
|
|
2899
3292
|
};
|
|
2900
3293
|
requestBody?: never;
|
|
2901
3294
|
responses: {
|
|
2902
|
-
/** @description OK */
|
|
3295
|
+
/** @description OK */
|
|
3296
|
+
200: {
|
|
2903
3297
|
headers: {
|
|
2904
3298
|
[name: string]: unknown;
|
|
2905
3299
|
};
|
|
2906
3300
|
content: {
|
|
2907
3301
|
"application/json": {
|
|
2908
|
-
/** @example cart details */
|
|
3302
|
+
/** @example cart details */
|
|
3303
|
+
message: $Read$1<string>;
|
|
2909
3304
|
success: $Read$1<boolean>;
|
|
2910
3305
|
content: {
|
|
2911
3306
|
cart: components["schemas"]["Cart"];
|
|
@@ -2922,19 +3317,22 @@ interface operations {
|
|
|
2922
3317
|
query?: never;
|
|
2923
3318
|
header?: never;
|
|
2924
3319
|
path: {
|
|
2925
|
-
/** @description Cart ID */
|
|
3320
|
+
/** @description Cart ID */
|
|
3321
|
+
id: string;
|
|
2926
3322
|
};
|
|
2927
3323
|
cookie?: never;
|
|
2928
3324
|
};
|
|
2929
3325
|
requestBody?: never;
|
|
2930
3326
|
responses: {
|
|
2931
|
-
/** @description OK */
|
|
3327
|
+
/** @description OK */
|
|
3328
|
+
200: {
|
|
2932
3329
|
headers: {
|
|
2933
3330
|
[name: string]: unknown;
|
|
2934
3331
|
};
|
|
2935
3332
|
content: {
|
|
2936
3333
|
"application/json": {
|
|
2937
|
-
/** @example All cart items are removed. */
|
|
3334
|
+
/** @example All cart items are removed. */
|
|
3335
|
+
message: $Read$1<string>;
|
|
2938
3336
|
success: $Read$1<boolean>;
|
|
2939
3337
|
};
|
|
2940
3338
|
};
|
|
@@ -2948,10 +3346,12 @@ interface operations {
|
|
|
2948
3346
|
query?: never;
|
|
2949
3347
|
header?: never;
|
|
2950
3348
|
path: {
|
|
2951
|
-
/** @description Cart ID */
|
|
3349
|
+
/** @description Cart ID */
|
|
3350
|
+
id: string;
|
|
2952
3351
|
};
|
|
2953
3352
|
cookie?: never;
|
|
2954
|
-
};
|
|
3353
|
+
};
|
|
3354
|
+
/** @description Update billing and shipping address during checkout */
|
|
2955
3355
|
requestBody: {
|
|
2956
3356
|
content: {
|
|
2957
3357
|
"application/json": {
|
|
@@ -2964,13 +3364,15 @@ interface operations {
|
|
|
2964
3364
|
};
|
|
2965
3365
|
};
|
|
2966
3366
|
responses: {
|
|
2967
|
-
/** @description OK */
|
|
3367
|
+
/** @description OK */
|
|
3368
|
+
200: {
|
|
2968
3369
|
headers: {
|
|
2969
3370
|
[name: string]: unknown;
|
|
2970
3371
|
};
|
|
2971
3372
|
content: {
|
|
2972
3373
|
"application/json": {
|
|
2973
|
-
/** @example Address updated successfully */
|
|
3374
|
+
/** @example Address updated successfully */
|
|
3375
|
+
message: string;
|
|
2974
3376
|
success: boolean;
|
|
2975
3377
|
content: {
|
|
2976
3378
|
cart: components["schemas"]["Cart"];
|
|
@@ -2988,19 +3390,22 @@ interface operations {
|
|
|
2988
3390
|
query?: never;
|
|
2989
3391
|
header?: never;
|
|
2990
3392
|
path: {
|
|
2991
|
-
/** @description Cart ID */
|
|
3393
|
+
/** @description Cart ID */
|
|
3394
|
+
id: string;
|
|
2992
3395
|
};
|
|
2993
3396
|
cookie?: never;
|
|
2994
3397
|
};
|
|
2995
3398
|
requestBody: {
|
|
2996
3399
|
content: {
|
|
2997
3400
|
"application/json": {
|
|
2998
|
-
/** @example FLAT100OFF */
|
|
3401
|
+
/** @example FLAT100OFF */
|
|
3402
|
+
coupon_code: string;
|
|
2999
3403
|
};
|
|
3000
3404
|
};
|
|
3001
3405
|
};
|
|
3002
3406
|
responses: {
|
|
3003
|
-
/** @description OK */
|
|
3407
|
+
/** @description OK */
|
|
3408
|
+
200: {
|
|
3004
3409
|
headers: {
|
|
3005
3410
|
[name: string]: unknown;
|
|
3006
3411
|
};
|
|
@@ -3024,13 +3429,15 @@ interface operations {
|
|
|
3024
3429
|
query?: never;
|
|
3025
3430
|
header?: never;
|
|
3026
3431
|
path: {
|
|
3027
|
-
/** @description Cart ID */
|
|
3432
|
+
/** @description Cart ID */
|
|
3433
|
+
id: string;
|
|
3028
3434
|
};
|
|
3029
3435
|
cookie?: never;
|
|
3030
3436
|
};
|
|
3031
3437
|
requestBody?: never;
|
|
3032
3438
|
responses: {
|
|
3033
|
-
/** @description OK */
|
|
3439
|
+
/** @description OK */
|
|
3440
|
+
200: {
|
|
3034
3441
|
headers: {
|
|
3035
3442
|
[name: string]: unknown;
|
|
3036
3443
|
};
|
|
@@ -3045,7 +3452,8 @@ interface operations {
|
|
|
3045
3452
|
};
|
|
3046
3453
|
};
|
|
3047
3454
|
400: components["responses"]["BadRequest"];
|
|
3048
|
-
401: components["responses"]["Unauthorized"];
|
|
3455
|
+
401: components["responses"]["Unauthorized"];
|
|
3456
|
+
/** @description Not Found */
|
|
3049
3457
|
404: {
|
|
3050
3458
|
headers: {
|
|
3051
3459
|
[name: string]: unknown;
|
|
@@ -3059,7 +3467,8 @@ interface operations {
|
|
|
3059
3467
|
query?: never;
|
|
3060
3468
|
header?: never;
|
|
3061
3469
|
path: {
|
|
3062
|
-
/** @description Cart ID */
|
|
3470
|
+
/** @description Cart ID */
|
|
3471
|
+
id: string;
|
|
3063
3472
|
};
|
|
3064
3473
|
cookie?: never;
|
|
3065
3474
|
};
|
|
@@ -3075,7 +3484,8 @@ interface operations {
|
|
|
3075
3484
|
};
|
|
3076
3485
|
};
|
|
3077
3486
|
responses: {
|
|
3078
|
-
/** @description OK */
|
|
3487
|
+
/** @description OK */
|
|
3488
|
+
200: {
|
|
3079
3489
|
headers: {
|
|
3080
3490
|
[name: string]: unknown;
|
|
3081
3491
|
};
|
|
@@ -3098,13 +3508,15 @@ interface operations {
|
|
|
3098
3508
|
query?: never;
|
|
3099
3509
|
header?: never;
|
|
3100
3510
|
path: {
|
|
3101
|
-
/** @description Cart ID */
|
|
3511
|
+
/** @description Cart ID */
|
|
3512
|
+
id: string;
|
|
3102
3513
|
};
|
|
3103
3514
|
cookie?: never;
|
|
3104
3515
|
};
|
|
3105
3516
|
requestBody?: never;
|
|
3106
3517
|
responses: {
|
|
3107
|
-
/** @description OK */
|
|
3518
|
+
/** @description OK */
|
|
3519
|
+
200: {
|
|
3108
3520
|
headers: {
|
|
3109
3521
|
[name: string]: unknown;
|
|
3110
3522
|
};
|
|
@@ -3119,7 +3531,8 @@ interface operations {
|
|
|
3119
3531
|
};
|
|
3120
3532
|
};
|
|
3121
3533
|
400: components["responses"]["BadRequest"];
|
|
3122
|
-
401: components["responses"]["Unauthorized"];
|
|
3534
|
+
401: components["responses"]["Unauthorized"];
|
|
3535
|
+
/** @description Not Found */
|
|
3123
3536
|
404: {
|
|
3124
3537
|
headers: {
|
|
3125
3538
|
[name: string]: unknown;
|
|
@@ -3133,13 +3546,15 @@ interface operations {
|
|
|
3133
3546
|
query?: never;
|
|
3134
3547
|
header?: never;
|
|
3135
3548
|
path: {
|
|
3136
|
-
/** @description Cart Id */
|
|
3549
|
+
/** @description Cart Id */
|
|
3550
|
+
id: string;
|
|
3137
3551
|
};
|
|
3138
3552
|
cookie?: never;
|
|
3139
3553
|
};
|
|
3140
3554
|
requestBody?: never;
|
|
3141
3555
|
responses: {
|
|
3142
|
-
/** @description OK */
|
|
3556
|
+
/** @description OK */
|
|
3557
|
+
200: {
|
|
3143
3558
|
headers: {
|
|
3144
3559
|
[name: string]: unknown;
|
|
3145
3560
|
};
|
|
@@ -3162,13 +3577,15 @@ interface operations {
|
|
|
3162
3577
|
query?: never;
|
|
3163
3578
|
header?: never;
|
|
3164
3579
|
path: {
|
|
3165
|
-
/** @description Cart Id */
|
|
3580
|
+
/** @description Cart Id */
|
|
3581
|
+
id: string;
|
|
3166
3582
|
};
|
|
3167
3583
|
cookie?: never;
|
|
3168
3584
|
};
|
|
3169
3585
|
requestBody?: never;
|
|
3170
3586
|
responses: {
|
|
3171
|
-
/** @description OK */
|
|
3587
|
+
/** @description OK */
|
|
3588
|
+
200: {
|
|
3172
3589
|
headers: {
|
|
3173
3590
|
[name: string]: unknown;
|
|
3174
3591
|
};
|
|
@@ -3191,7 +3608,8 @@ interface operations {
|
|
|
3191
3608
|
query?: never;
|
|
3192
3609
|
header?: never;
|
|
3193
3610
|
path: {
|
|
3194
|
-
/** @description Cart ID */
|
|
3611
|
+
/** @description Cart ID */
|
|
3612
|
+
id: string;
|
|
3195
3613
|
};
|
|
3196
3614
|
cookie?: never;
|
|
3197
3615
|
};
|
|
@@ -3201,7 +3619,8 @@ interface operations {
|
|
|
3201
3619
|
};
|
|
3202
3620
|
};
|
|
3203
3621
|
responses: {
|
|
3204
|
-
/** @description OK */
|
|
3622
|
+
/** @description OK */
|
|
3623
|
+
200: {
|
|
3205
3624
|
headers: {
|
|
3206
3625
|
[name: string]: unknown;
|
|
3207
3626
|
};
|
|
@@ -3225,7 +3644,8 @@ interface operations {
|
|
|
3225
3644
|
query?: never;
|
|
3226
3645
|
header?: never;
|
|
3227
3646
|
path: {
|
|
3228
|
-
/** @description cart id */
|
|
3647
|
+
/** @description cart id */
|
|
3648
|
+
id: string;
|
|
3229
3649
|
};
|
|
3230
3650
|
cookie?: never;
|
|
3231
3651
|
};
|
|
@@ -3235,7 +3655,8 @@ interface operations {
|
|
|
3235
3655
|
};
|
|
3236
3656
|
};
|
|
3237
3657
|
responses: {
|
|
3238
|
-
/** @description OK */
|
|
3658
|
+
/** @description OK */
|
|
3659
|
+
200: {
|
|
3239
3660
|
headers: {
|
|
3240
3661
|
[name: string]: unknown;
|
|
3241
3662
|
};
|
|
@@ -3259,19 +3680,22 @@ interface operations {
|
|
|
3259
3680
|
query?: never;
|
|
3260
3681
|
header?: never;
|
|
3261
3682
|
path: {
|
|
3262
|
-
/** @description Cart ID */
|
|
3683
|
+
/** @description Cart ID */
|
|
3684
|
+
id: string;
|
|
3263
3685
|
};
|
|
3264
3686
|
cookie?: never;
|
|
3265
3687
|
};
|
|
3266
3688
|
requestBody: {
|
|
3267
3689
|
content: {
|
|
3268
3690
|
"application/json": {
|
|
3269
|
-
/** @example 1000 */
|
|
3691
|
+
/** @example 1000 */
|
|
3692
|
+
loyalty_point_redeemed: number;
|
|
3270
3693
|
};
|
|
3271
3694
|
};
|
|
3272
3695
|
};
|
|
3273
3696
|
responses: {
|
|
3274
|
-
/** @description OK */
|
|
3697
|
+
/** @description OK */
|
|
3698
|
+
200: {
|
|
3275
3699
|
headers: {
|
|
3276
3700
|
[name: string]: unknown;
|
|
3277
3701
|
};
|
|
@@ -3294,13 +3718,15 @@ interface operations {
|
|
|
3294
3718
|
query?: never;
|
|
3295
3719
|
header?: never;
|
|
3296
3720
|
path: {
|
|
3297
|
-
/** @description Cart ID */
|
|
3721
|
+
/** @description Cart ID */
|
|
3722
|
+
id: string;
|
|
3298
3723
|
};
|
|
3299
3724
|
cookie?: never;
|
|
3300
3725
|
};
|
|
3301
3726
|
requestBody?: never;
|
|
3302
3727
|
responses: {
|
|
3303
|
-
/** @description OK */
|
|
3728
|
+
/** @description OK */
|
|
3729
|
+
200: {
|
|
3304
3730
|
headers: {
|
|
3305
3731
|
[name: string]: unknown;
|
|
3306
3732
|
};
|
|
@@ -3315,7 +3741,8 @@ interface operations {
|
|
|
3315
3741
|
};
|
|
3316
3742
|
};
|
|
3317
3743
|
400: components["responses"]["BadRequest"];
|
|
3318
|
-
401: components["responses"]["Unauthorized"];
|
|
3744
|
+
401: components["responses"]["Unauthorized"];
|
|
3745
|
+
/** @description Not Found */
|
|
3319
3746
|
404: {
|
|
3320
3747
|
headers: {
|
|
3321
3748
|
[name: string]: unknown;
|
|
@@ -3329,7 +3756,8 @@ interface operations {
|
|
|
3329
3756
|
query?: never;
|
|
3330
3757
|
header?: never;
|
|
3331
3758
|
path: {
|
|
3332
|
-
/** @description cart id */
|
|
3759
|
+
/** @description cart id */
|
|
3760
|
+
id: string;
|
|
3333
3761
|
};
|
|
3334
3762
|
cookie?: never;
|
|
3335
3763
|
};
|
|
@@ -3339,7 +3767,8 @@ interface operations {
|
|
|
3339
3767
|
};
|
|
3340
3768
|
};
|
|
3341
3769
|
responses: {
|
|
3342
|
-
/** @description OK */
|
|
3770
|
+
/** @description OK */
|
|
3771
|
+
200: {
|
|
3343
3772
|
headers: {
|
|
3344
3773
|
[name: string]: unknown;
|
|
3345
3774
|
};
|
|
@@ -3361,10 +3790,15 @@ interface operations {
|
|
|
3361
3790
|
"pos-list-categories": {
|
|
3362
3791
|
parameters: {
|
|
3363
3792
|
query?: {
|
|
3364
|
-
/** @description search keyword */
|
|
3365
|
-
|
|
3366
|
-
|
|
3367
|
-
|
|
3793
|
+
/** @description search keyword */
|
|
3794
|
+
search?: components["parameters"]["searchKeyword"];
|
|
3795
|
+
/** @description JSON string format: {"field1":"asc", "field2":"desc"} */
|
|
3796
|
+
sort_by?: components["parameters"]["sortingParam"];
|
|
3797
|
+
/** @description return child categories up to nesting level */
|
|
3798
|
+
nested_level?: number;
|
|
3799
|
+
/** @description To return child categories using category id. */
|
|
3800
|
+
parent_category_id?: string;
|
|
3801
|
+
/** @description To return child categories using category slug */
|
|
3368
3802
|
parent_category_slug?: string;
|
|
3369
3803
|
};
|
|
3370
3804
|
header?: never;
|
|
@@ -3373,13 +3807,15 @@ interface operations {
|
|
|
3373
3807
|
};
|
|
3374
3808
|
requestBody?: never;
|
|
3375
3809
|
responses: {
|
|
3376
|
-
/** @description OK */
|
|
3810
|
+
/** @description OK */
|
|
3811
|
+
200: {
|
|
3377
3812
|
headers: {
|
|
3378
3813
|
[name: string]: unknown;
|
|
3379
3814
|
};
|
|
3380
3815
|
content: {
|
|
3381
3816
|
"application/json": {
|
|
3382
|
-
/** @example all categories */
|
|
3817
|
+
/** @example all categories */
|
|
3818
|
+
message: string;
|
|
3383
3819
|
success: boolean;
|
|
3384
3820
|
content: {
|
|
3385
3821
|
categories: components["schemas"]["ProductCategory"][];
|
|
@@ -3396,28 +3832,37 @@ interface operations {
|
|
|
3396
3832
|
"pos-list-products": {
|
|
3397
3833
|
parameters: {
|
|
3398
3834
|
query?: {
|
|
3399
|
-
/** @description page number of pagination list */
|
|
3400
|
-
|
|
3401
|
-
|
|
3402
|
-
|
|
3403
|
-
|
|
3835
|
+
/** @description page number of pagination list */
|
|
3836
|
+
page?: components["parameters"]["pageParam"];
|
|
3837
|
+
/** @description Number of results per page. */
|
|
3838
|
+
limit?: components["parameters"]["pageLimitParam"];
|
|
3839
|
+
/** @description JSON string format: {"field1":"asc", "field2":"desc"} */
|
|
3840
|
+
sort_by?: components["parameters"]["sortingParam"];
|
|
3841
|
+
/** @description filter products by categories ids */
|
|
3842
|
+
category_id?: string[];
|
|
3843
|
+
/** @description filter products by categories slugs */
|
|
3844
|
+
category_slug?: string[];
|
|
3845
|
+
/** @description Determines whether to include or exlude inventory details in response json */
|
|
3404
3846
|
inventory?: boolean;
|
|
3405
3847
|
};
|
|
3406
3848
|
header?: {
|
|
3407
|
-
/** @description This param is used to determine product pricing, promotions, and subscription rates. If a valid customer group id is provided, pricing details will be retrieved accordingly. If no matching data is found for the specified customer group id, the system will fall back to the default customer group id. If no data is found for the default group either, the highest applicable price will be returned. */
|
|
3849
|
+
/** @description This param is used to determine product pricing, promotions, and subscription rates. If a valid customer group id is provided, pricing details will be retrieved accordingly. If no matching data is found for the specified customer group id, the system will fall back to the default customer group id. If no data is found for the default group either, the highest applicable price will be returned. */
|
|
3850
|
+
"x-customer-group-id"?: components["parameters"]["CustomerGroupId"];
|
|
3408
3851
|
};
|
|
3409
3852
|
path?: never;
|
|
3410
3853
|
cookie?: never;
|
|
3411
3854
|
};
|
|
3412
3855
|
requestBody?: never;
|
|
3413
3856
|
responses: {
|
|
3414
|
-
/** @description Success response */
|
|
3857
|
+
/** @description Success response */
|
|
3858
|
+
200: {
|
|
3415
3859
|
headers: {
|
|
3416
3860
|
[name: string]: unknown;
|
|
3417
3861
|
};
|
|
3418
3862
|
content: {
|
|
3419
3863
|
"application/json": {
|
|
3420
|
-
/** @example Products retrieved successfully. */
|
|
3864
|
+
/** @example Products retrieved successfully. */
|
|
3865
|
+
message: string;
|
|
3421
3866
|
success: boolean;
|
|
3422
3867
|
content: {
|
|
3423
3868
|
products: components["schemas"]["Product"][];
|
|
@@ -3433,20 +3878,26 @@ interface operations {
|
|
|
3433
3878
|
"pos-list-crosssell-products": {
|
|
3434
3879
|
parameters: {
|
|
3435
3880
|
query?: {
|
|
3436
|
-
/** @description no of rows per page */
|
|
3437
|
-
|
|
3438
|
-
|
|
3881
|
+
/** @description no of rows per page */
|
|
3882
|
+
limit?: number;
|
|
3883
|
+
/** @description page number in pagination */
|
|
3884
|
+
page?: number;
|
|
3885
|
+
/** @description Product ids of cart items */
|
|
3886
|
+
product_id?: string[];
|
|
3887
|
+
/** @description json to sort records */
|
|
3439
3888
|
sort_by?: string;
|
|
3440
3889
|
};
|
|
3441
3890
|
header?: {
|
|
3442
|
-
/** @description This param is used to determine product pricing, promotions, and subscription rates. If a valid customer group id is provided, pricing details will be retrieved accordingly. If no matching data is found for the specified customer group id, the system will fall back to the default customer group id. If no data is found for the default group either, the highest applicable price will be returned. */
|
|
3891
|
+
/** @description This param is used to determine product pricing, promotions, and subscription rates. If a valid customer group id is provided, pricing details will be retrieved accordingly. If no matching data is found for the specified customer group id, the system will fall back to the default customer group id. If no data is found for the default group either, the highest applicable price will be returned. */
|
|
3892
|
+
"x-customer-group-id"?: components["parameters"]["CustomerGroupId"];
|
|
3443
3893
|
};
|
|
3444
3894
|
path?: never;
|
|
3445
3895
|
cookie?: never;
|
|
3446
3896
|
};
|
|
3447
3897
|
requestBody?: never;
|
|
3448
3898
|
responses: {
|
|
3449
|
-
/** @description Success response */
|
|
3899
|
+
/** @description Success response */
|
|
3900
|
+
200: {
|
|
3450
3901
|
headers: {
|
|
3451
3902
|
[name: string]: unknown;
|
|
3452
3903
|
};
|
|
@@ -3469,7 +3920,8 @@ interface operations {
|
|
|
3469
3920
|
parameters: {
|
|
3470
3921
|
query?: never;
|
|
3471
3922
|
header?: {
|
|
3472
|
-
/** @description This param is used to determine product pricing, promotions, and subscription rates. If a valid customer group id is provided, pricing details will be retrieved accordingly. If no matching data is found for the specified customer group id, the system will fall back to the default customer group id. If no data is found for the default group either, the highest applicable price will be returned. */
|
|
3923
|
+
/** @description This param is used to determine product pricing, promotions, and subscription rates. If a valid customer group id is provided, pricing details will be retrieved accordingly. If no matching data is found for the specified customer group id, the system will fall back to the default customer group id. If no data is found for the default group either, the highest applicable price will be returned. */
|
|
3924
|
+
"x-customer-group-id"?: components["parameters"]["CustomerGroupId"];
|
|
3473
3925
|
};
|
|
3474
3926
|
path?: never;
|
|
3475
3927
|
cookie?: never;
|
|
@@ -3480,7 +3932,8 @@ interface operations {
|
|
|
3480
3932
|
};
|
|
3481
3933
|
};
|
|
3482
3934
|
responses: {
|
|
3483
|
-
/** @description Success response */
|
|
3935
|
+
/** @description Success response */
|
|
3936
|
+
200: {
|
|
3484
3937
|
headers: {
|
|
3485
3938
|
[name: string]: unknown;
|
|
3486
3939
|
};
|
|
@@ -3512,20 +3965,26 @@ interface operations {
|
|
|
3512
3965
|
"pos-list-similar-products": {
|
|
3513
3966
|
parameters: {
|
|
3514
3967
|
query?: {
|
|
3515
|
-
/** @description no of rows per page */
|
|
3516
|
-
|
|
3517
|
-
|
|
3968
|
+
/** @description no of rows per page */
|
|
3969
|
+
limit?: number;
|
|
3970
|
+
/** @description page number in pagination */
|
|
3971
|
+
page?: number;
|
|
3972
|
+
/** @description to retrieve similar products of specified products */
|
|
3973
|
+
product_id?: string[];
|
|
3974
|
+
/** @description json to sort records */
|
|
3518
3975
|
sort_by?: string;
|
|
3519
3976
|
};
|
|
3520
3977
|
header?: {
|
|
3521
|
-
/** @description This param is used to determine product pricing, promotions, and subscription rates. If a valid customer group id is provided, pricing details will be retrieved accordingly. If no matching data is found for the specified customer group id, the system will fall back to the default customer group id. If no data is found for the default group either, the highest applicable price will be returned. */
|
|
3978
|
+
/** @description This param is used to determine product pricing, promotions, and subscription rates. If a valid customer group id is provided, pricing details will be retrieved accordingly. If no matching data is found for the specified customer group id, the system will fall back to the default customer group id. If no data is found for the default group either, the highest applicable price will be returned. */
|
|
3979
|
+
"x-customer-group-id"?: components["parameters"]["CustomerGroupId"];
|
|
3522
3980
|
};
|
|
3523
3981
|
path?: never;
|
|
3524
3982
|
cookie?: never;
|
|
3525
3983
|
};
|
|
3526
3984
|
requestBody?: never;
|
|
3527
3985
|
responses: {
|
|
3528
|
-
/** @description Success response */
|
|
3986
|
+
/** @description Success response */
|
|
3987
|
+
200: {
|
|
3529
3988
|
headers: {
|
|
3530
3989
|
[name: string]: unknown;
|
|
3531
3990
|
};
|
|
@@ -3547,26 +4006,33 @@ interface operations {
|
|
|
3547
4006
|
"pos-list-upsell-products": {
|
|
3548
4007
|
parameters: {
|
|
3549
4008
|
query?: {
|
|
3550
|
-
/** @description no of rows per page */
|
|
3551
|
-
|
|
3552
|
-
|
|
4009
|
+
/** @description no of rows per page */
|
|
4010
|
+
limit?: number;
|
|
4011
|
+
/** @description page number in pagination */
|
|
4012
|
+
page?: number;
|
|
4013
|
+
/** @description Product ids of cart items */
|
|
4014
|
+
product_id?: string[];
|
|
4015
|
+
/** @description json to sort records */
|
|
3553
4016
|
sort_by?: string;
|
|
3554
4017
|
};
|
|
3555
4018
|
header?: {
|
|
3556
|
-
/** @description This param is used to determine product pricing, promotions, and subscription rates. If a valid customer group id is provided, pricing details will be retrieved accordingly. If no matching data is found for the specified customer group id, the system will fall back to the default customer group id. If no data is found for the default group either, the highest applicable price will be returned. */
|
|
4019
|
+
/** @description This param is used to determine product pricing, promotions, and subscription rates. If a valid customer group id is provided, pricing details will be retrieved accordingly. If no matching data is found for the specified customer group id, the system will fall back to the default customer group id. If no data is found for the default group either, the highest applicable price will be returned. */
|
|
4020
|
+
"x-customer-group-id"?: components["parameters"]["CustomerGroupId"];
|
|
3557
4021
|
};
|
|
3558
4022
|
path?: never;
|
|
3559
4023
|
cookie?: never;
|
|
3560
4024
|
};
|
|
3561
4025
|
requestBody?: never;
|
|
3562
4026
|
responses: {
|
|
3563
|
-
/** @description Success response */
|
|
4027
|
+
/** @description Success response */
|
|
4028
|
+
200: {
|
|
3564
4029
|
headers: {
|
|
3565
4030
|
[name: string]: unknown;
|
|
3566
4031
|
};
|
|
3567
4032
|
content: {
|
|
3568
4033
|
"application/json": {
|
|
3569
|
-
/** @description Masssage */
|
|
4034
|
+
/** @description Masssage */
|
|
4035
|
+
message: string;
|
|
3570
4036
|
success: boolean;
|
|
3571
4037
|
content: {
|
|
3572
4038
|
products: components["schemas"]["Item"][];
|
|
@@ -3582,25 +4048,30 @@ interface operations {
|
|
|
3582
4048
|
"pos-get-product-detail": {
|
|
3583
4049
|
parameters: {
|
|
3584
4050
|
query?: {
|
|
3585
|
-
/** @description Determines whether to include or exlude inventory details in response json */
|
|
4051
|
+
/** @description Determines whether to include or exlude inventory details in response json */
|
|
4052
|
+
inventory?: boolean;
|
|
3586
4053
|
};
|
|
3587
4054
|
header?: {
|
|
3588
|
-
/** @description This param is used to determine product pricing, promotions, and subscription rates. If a valid customer group id is provided, pricing details will be retrieved accordingly. If no matching data is found for the specified customer group id, the system will fall back to the default customer group id. If no data is found for the default group either, the highest applicable price will be returned. */
|
|
4055
|
+
/** @description This param is used to determine product pricing, promotions, and subscription rates. If a valid customer group id is provided, pricing details will be retrieved accordingly. If no matching data is found for the specified customer group id, the system will fall back to the default customer group id. If no data is found for the default group either, the highest applicable price will be returned. */
|
|
4056
|
+
"x-customer-group-id"?: components["parameters"]["CustomerGroupId"];
|
|
3589
4057
|
};
|
|
3590
4058
|
path: {
|
|
3591
|
-
/** @description Product ID or product slug. Either is accepted in the path. */
|
|
4059
|
+
/** @description Product ID or product slug. Either is accepted in the path. */
|
|
4060
|
+
product_id: string;
|
|
3592
4061
|
};
|
|
3593
4062
|
cookie?: never;
|
|
3594
4063
|
};
|
|
3595
4064
|
requestBody?: never;
|
|
3596
4065
|
responses: {
|
|
3597
|
-
/** @description Success response */
|
|
4066
|
+
/** @description Success response */
|
|
4067
|
+
200: {
|
|
3598
4068
|
headers: {
|
|
3599
4069
|
[name: string]: unknown;
|
|
3600
4070
|
};
|
|
3601
4071
|
content: {
|
|
3602
4072
|
"application/json": {
|
|
3603
|
-
/** @example Products retrieved successfully. */
|
|
4073
|
+
/** @example Products retrieved successfully. */
|
|
4074
|
+
message: string;
|
|
3604
4075
|
success: boolean;
|
|
3605
4076
|
content: {
|
|
3606
4077
|
product: components["schemas"]["ProductDetail"];
|
|
@@ -3615,21 +4086,28 @@ interface operations {
|
|
|
3615
4086
|
"pos-list-product-reviews": {
|
|
3616
4087
|
parameters: {
|
|
3617
4088
|
query?: {
|
|
3618
|
-
/** @description page number of pagination list */
|
|
3619
|
-
|
|
3620
|
-
|
|
3621
|
-
|
|
4089
|
+
/** @description page number of pagination list */
|
|
4090
|
+
page?: components["parameters"]["pageParam"];
|
|
4091
|
+
/** @description Number of results per page. */
|
|
4092
|
+
limit?: components["parameters"]["pageLimitParam"];
|
|
4093
|
+
/** @description JSON string format: {"field1":"asc", "field2":"desc"} */
|
|
4094
|
+
sort_by?: components["parameters"]["sortingParam"];
|
|
4095
|
+
/** @description search keyword */
|
|
4096
|
+
search?: components["parameters"]["searchKeyword"];
|
|
4097
|
+
/** @description filter review with review tag */
|
|
3622
4098
|
review_tag?: string;
|
|
3623
4099
|
};
|
|
3624
4100
|
header?: never;
|
|
3625
4101
|
path: {
|
|
3626
|
-
/** @description id of a particular product */
|
|
4102
|
+
/** @description id of a particular product */
|
|
4103
|
+
product_id: string;
|
|
3627
4104
|
};
|
|
3628
4105
|
cookie?: never;
|
|
3629
4106
|
};
|
|
3630
4107
|
requestBody?: never;
|
|
3631
4108
|
responses: {
|
|
3632
|
-
/** @description Success response */
|
|
4109
|
+
/** @description Success response */
|
|
4110
|
+
200: {
|
|
3633
4111
|
headers: {
|
|
3634
4112
|
[name: string]: unknown;
|
|
3635
4113
|
};
|
|
@@ -3652,25 +4130,30 @@ interface operations {
|
|
|
3652
4130
|
"pos-list-product-variants": {
|
|
3653
4131
|
parameters: {
|
|
3654
4132
|
query?: {
|
|
3655
|
-
/** @description Determines whether to include or exlude inventory details in response json */
|
|
4133
|
+
/** @description Determines whether to include or exlude inventory details in response json */
|
|
4134
|
+
inventory?: boolean;
|
|
3656
4135
|
};
|
|
3657
4136
|
header?: {
|
|
3658
|
-
/** @description This param is used to determine product pricing, promotions, and subscription rates. If a valid customer group id is provided, pricing details will be retrieved accordingly. If no matching data is found for the specified customer group id, the system will fall back to the default customer group id. If no data is found for the default group either, the highest applicable price will be returned. */
|
|
4137
|
+
/** @description This param is used to determine product pricing, promotions, and subscription rates. If a valid customer group id is provided, pricing details will be retrieved accordingly. If no matching data is found for the specified customer group id, the system will fall back to the default customer group id. If no data is found for the default group either, the highest applicable price will be returned. */
|
|
4138
|
+
"x-customer-group-id"?: components["parameters"]["CustomerGroupId"];
|
|
3659
4139
|
};
|
|
3660
4140
|
path: {
|
|
3661
|
-
/** @description Product ID or product slug. Either is accepted in the path. */
|
|
4141
|
+
/** @description Product ID or product slug. Either is accepted in the path. */
|
|
4142
|
+
product_id: string;
|
|
3662
4143
|
};
|
|
3663
4144
|
cookie?: never;
|
|
3664
4145
|
};
|
|
3665
4146
|
requestBody?: never;
|
|
3666
4147
|
responses: {
|
|
3667
|
-
/** @description Success response */
|
|
4148
|
+
/** @description Success response */
|
|
4149
|
+
200: {
|
|
3668
4150
|
headers: {
|
|
3669
4151
|
[name: string]: unknown;
|
|
3670
4152
|
};
|
|
3671
4153
|
content: {
|
|
3672
4154
|
"application/json": {
|
|
3673
|
-
/** @example Products retrieved successfully. */
|
|
4155
|
+
/** @example Products retrieved successfully. */
|
|
4156
|
+
message: string;
|
|
3674
4157
|
success: boolean;
|
|
3675
4158
|
content: {
|
|
3676
4159
|
variants: components["schemas"]["Variant"][];
|
|
@@ -3685,26 +4168,32 @@ interface operations {
|
|
|
3685
4168
|
"pos-get-variant-detail": {
|
|
3686
4169
|
parameters: {
|
|
3687
4170
|
query?: {
|
|
3688
|
-
/** @description Determines whether to include or exlude inventory details in response json */
|
|
4171
|
+
/** @description Determines whether to include or exlude inventory details in response json */
|
|
4172
|
+
inventory?: boolean;
|
|
3689
4173
|
};
|
|
3690
4174
|
header?: {
|
|
3691
|
-
/** @description This param is used to determine product pricing, promotions, and subscription rates. If a valid customer group id is provided, pricing details will be retrieved accordingly. If no matching data is found for the specified customer group id, the system will fall back to the default customer group id. If no data is found for the default group either, the highest applicable price will be returned. */
|
|
4175
|
+
/** @description This param is used to determine product pricing, promotions, and subscription rates. If a valid customer group id is provided, pricing details will be retrieved accordingly. If no matching data is found for the specified customer group id, the system will fall back to the default customer group id. If no data is found for the default group either, the highest applicable price will be returned. */
|
|
4176
|
+
"x-customer-group-id"?: components["parameters"]["CustomerGroupId"];
|
|
3692
4177
|
};
|
|
3693
4178
|
path: {
|
|
3694
|
-
/** @description Product ID or product slug. Either is accepted in the path. */
|
|
4179
|
+
/** @description Product ID or product slug. Either is accepted in the path. */
|
|
4180
|
+
product_id: string;
|
|
4181
|
+
/** @description Variant ID or variant slug. Either is accepted in the path. */
|
|
3695
4182
|
variant_id: string;
|
|
3696
4183
|
};
|
|
3697
4184
|
cookie?: never;
|
|
3698
4185
|
};
|
|
3699
4186
|
requestBody?: never;
|
|
3700
4187
|
responses: {
|
|
3701
|
-
/** @description Success response */
|
|
4188
|
+
/** @description Success response */
|
|
4189
|
+
200: {
|
|
3702
4190
|
headers: {
|
|
3703
4191
|
[name: string]: unknown;
|
|
3704
4192
|
};
|
|
3705
4193
|
content: {
|
|
3706
4194
|
"application/json": {
|
|
3707
|
-
/** @example Products retrieved successfully. */
|
|
4195
|
+
/** @example Products retrieved successfully. */
|
|
4196
|
+
message: string;
|
|
3708
4197
|
success: boolean;
|
|
3709
4198
|
content: {
|
|
3710
4199
|
variant: components["schemas"]["VariantDetail"];
|
|
@@ -3719,28 +4208,37 @@ interface operations {
|
|
|
3719
4208
|
"pos-list-skus": {
|
|
3720
4209
|
parameters: {
|
|
3721
4210
|
query?: {
|
|
3722
|
-
/** @description page number of pagination list */
|
|
3723
|
-
|
|
3724
|
-
|
|
3725
|
-
|
|
3726
|
-
|
|
4211
|
+
/** @description page number of pagination list */
|
|
4212
|
+
page?: components["parameters"]["pageParam"];
|
|
4213
|
+
/** @description Number of results per page. */
|
|
4214
|
+
limit?: components["parameters"]["pageLimitParam"];
|
|
4215
|
+
/** @description JSON string format: {"field1":"asc", "field2":"desc"} */
|
|
4216
|
+
sort_by?: components["parameters"]["sortingParam"];
|
|
4217
|
+
/** @description filter sku by categories */
|
|
4218
|
+
category_id?: string[];
|
|
4219
|
+
/** @description Determines whether to include or exlude inventory details in response json */
|
|
4220
|
+
inventory?: boolean;
|
|
4221
|
+
/** @description array of sku */
|
|
3727
4222
|
sku?: string[];
|
|
3728
4223
|
};
|
|
3729
4224
|
header?: {
|
|
3730
|
-
/** @description This param is used to determine product pricing, promotions, and subscription rates. If a valid customer group id is provided, pricing details will be retrieved accordingly. If no matching data is found for the specified customer group id, the system will fall back to the default customer group id. If no data is found for the default group either, the highest applicable price will be returned. */
|
|
4225
|
+
/** @description This param is used to determine product pricing, promotions, and subscription rates. If a valid customer group id is provided, pricing details will be retrieved accordingly. If no matching data is found for the specified customer group id, the system will fall back to the default customer group id. If no data is found for the default group either, the highest applicable price will be returned. */
|
|
4226
|
+
"x-customer-group-id"?: components["parameters"]["CustomerGroupId"];
|
|
3731
4227
|
};
|
|
3732
4228
|
path?: never;
|
|
3733
4229
|
cookie?: never;
|
|
3734
4230
|
};
|
|
3735
4231
|
requestBody?: never;
|
|
3736
4232
|
responses: {
|
|
3737
|
-
/** @description Success response */
|
|
4233
|
+
/** @description Success response */
|
|
4234
|
+
200: {
|
|
3738
4235
|
headers: {
|
|
3739
4236
|
[name: string]: unknown;
|
|
3740
4237
|
};
|
|
3741
4238
|
content: {
|
|
3742
4239
|
"application/json": {
|
|
3743
|
-
/** @example SKUs retrieved successfully. */
|
|
4240
|
+
/** @example SKUs retrieved successfully. */
|
|
4241
|
+
message: string;
|
|
3744
4242
|
success: boolean;
|
|
3745
4243
|
content: {
|
|
3746
4244
|
skus: $Read$1<components["schemas"]["Item"][]>;
|
|
@@ -3762,7 +4260,8 @@ interface operations {
|
|
|
3762
4260
|
};
|
|
3763
4261
|
requestBody?: never;
|
|
3764
4262
|
responses: {
|
|
3765
|
-
/** @description OK */
|
|
4263
|
+
/** @description OK */
|
|
4264
|
+
200: {
|
|
3766
4265
|
headers: {
|
|
3767
4266
|
[name: string]: unknown;
|
|
3768
4267
|
};
|
|
@@ -3784,13 +4283,15 @@ interface operations {
|
|
|
3784
4283
|
query?: never;
|
|
3785
4284
|
header?: never;
|
|
3786
4285
|
path: {
|
|
3787
|
-
/** @description device id */
|
|
4286
|
+
/** @description device id */
|
|
4287
|
+
id: string;
|
|
3788
4288
|
};
|
|
3789
4289
|
cookie?: never;
|
|
3790
4290
|
};
|
|
3791
4291
|
requestBody?: never;
|
|
3792
4292
|
responses: {
|
|
3793
|
-
/** @description OK */
|
|
4293
|
+
/** @description OK */
|
|
4294
|
+
200: {
|
|
3794
4295
|
headers: {
|
|
3795
4296
|
[name: string]: unknown;
|
|
3796
4297
|
};
|
|
@@ -3813,13 +4314,15 @@ interface operations {
|
|
|
3813
4314
|
query?: never;
|
|
3814
4315
|
header?: never;
|
|
3815
4316
|
path: {
|
|
3816
|
-
/** @description device id */
|
|
4317
|
+
/** @description device id */
|
|
4318
|
+
id: string;
|
|
3817
4319
|
};
|
|
3818
4320
|
cookie?: never;
|
|
3819
4321
|
};
|
|
3820
4322
|
requestBody?: never;
|
|
3821
4323
|
responses: {
|
|
3822
|
-
/** @description OK */
|
|
4324
|
+
/** @description OK */
|
|
4325
|
+
200: {
|
|
3823
4326
|
headers: {
|
|
3824
4327
|
[name: string]: unknown;
|
|
3825
4328
|
};
|
|
@@ -3850,7 +4353,8 @@ interface operations {
|
|
|
3850
4353
|
};
|
|
3851
4354
|
};
|
|
3852
4355
|
responses: {
|
|
3853
|
-
/** @description OK */
|
|
4356
|
+
/** @description OK */
|
|
4357
|
+
200: {
|
|
3854
4358
|
headers: {
|
|
3855
4359
|
[name: string]: unknown;
|
|
3856
4360
|
};
|
|
@@ -3861,7 +4365,8 @@ interface operations {
|
|
|
3861
4365
|
content: {
|
|
3862
4366
|
summary: {
|
|
3863
4367
|
collect_available: boolean;
|
|
3864
|
-
deliver_available: boolean;
|
|
4368
|
+
deliver_available: boolean;
|
|
4369
|
+
/** @enum {unknown} */
|
|
3865
4370
|
recommended_fulfillment_type: "collect-in-store" | "delivery";
|
|
3866
4371
|
recommended_store?: components["schemas"]["CollectInStore"];
|
|
3867
4372
|
};
|
|
@@ -3885,7 +4390,8 @@ interface operations {
|
|
|
3885
4390
|
};
|
|
3886
4391
|
requestBody?: never;
|
|
3887
4392
|
responses: {
|
|
3888
|
-
/** @description OK */
|
|
4393
|
+
/** @description OK */
|
|
4394
|
+
200: {
|
|
3889
4395
|
headers: {
|
|
3890
4396
|
[name: string]: unknown;
|
|
3891
4397
|
};
|
|
@@ -3912,13 +4418,15 @@ interface operations {
|
|
|
3912
4418
|
requestBody: {
|
|
3913
4419
|
content: {
|
|
3914
4420
|
"application/json": {
|
|
3915
|
-
cart_id: string;
|
|
4421
|
+
cart_id: string;
|
|
4422
|
+
/** @description Optional. if provided, this device will be used for the payment of this order. Otherwise, already claimed device will be used for the payment purpose. */
|
|
3916
4423
|
device_id?: string;
|
|
3917
4424
|
} & (components["schemas"]["PayWithCash"] | components["schemas"]["PayWithUpi"] | components["schemas"]["PayWithCard"]);
|
|
3918
4425
|
};
|
|
3919
4426
|
};
|
|
3920
4427
|
responses: {
|
|
3921
|
-
/** @description OK */
|
|
4428
|
+
/** @description OK */
|
|
4429
|
+
200: {
|
|
3922
4430
|
headers: {
|
|
3923
4431
|
[name: string]: unknown;
|
|
3924
4432
|
};
|
|
@@ -3927,7 +4435,8 @@ interface operations {
|
|
|
3927
4435
|
message: string;
|
|
3928
4436
|
success: boolean;
|
|
3929
4437
|
content: {
|
|
3930
|
-
order: components["schemas"]["Order"];
|
|
4438
|
+
order: components["schemas"]["Order"];
|
|
4439
|
+
/** @description true if to_be_paid > 0, otherwise false for zero value order. */
|
|
3931
4440
|
payment_required: boolean;
|
|
3932
4441
|
};
|
|
3933
4442
|
};
|
|
@@ -3942,23 +4451,29 @@ interface operations {
|
|
|
3942
4451
|
query?: never;
|
|
3943
4452
|
header?: never;
|
|
3944
4453
|
path: {
|
|
3945
|
-
/** @description order number */
|
|
4454
|
+
/** @description order number */
|
|
4455
|
+
order_number: string;
|
|
3946
4456
|
};
|
|
3947
4457
|
cookie?: never;
|
|
3948
4458
|
};
|
|
3949
4459
|
requestBody?: never;
|
|
3950
4460
|
responses: {
|
|
3951
|
-
/** @description OK */
|
|
4461
|
+
/** @description OK */
|
|
4462
|
+
200: {
|
|
3952
4463
|
headers: {
|
|
3953
4464
|
[name: string]: unknown;
|
|
3954
4465
|
};
|
|
3955
4466
|
content: {
|
|
3956
4467
|
"application/json": {
|
|
3957
|
-
/** @default order details */
|
|
4468
|
+
/** @default order details */
|
|
4469
|
+
message: $Read$1<string>;
|
|
3958
4470
|
success: $Read$1<boolean>;
|
|
3959
4471
|
content: {
|
|
3960
|
-
/** @enum {string} */
|
|
3961
|
-
|
|
4472
|
+
/** @enum {string} */
|
|
4473
|
+
status: "pending" | "success" | "failed" | "partially_paid";
|
|
4474
|
+
/** Format: double */
|
|
4475
|
+
amount_paid: number;
|
|
4476
|
+
/** Format: double */
|
|
3962
4477
|
amount_unpaid: number;
|
|
3963
4478
|
is_retry_available: boolean;
|
|
3964
4479
|
};
|
|
@@ -3974,13 +4489,15 @@ interface operations {
|
|
|
3974
4489
|
query?: never;
|
|
3975
4490
|
header?: never;
|
|
3976
4491
|
path: {
|
|
3977
|
-
/** @description User ID */
|
|
4492
|
+
/** @description User ID */
|
|
4493
|
+
id: string;
|
|
3978
4494
|
};
|
|
3979
4495
|
cookie?: never;
|
|
3980
4496
|
};
|
|
3981
4497
|
requestBody?: never;
|
|
3982
4498
|
responses: {
|
|
3983
|
-
/** @description OK */
|
|
4499
|
+
/** @description OK */
|
|
4500
|
+
200: {
|
|
3984
4501
|
headers: {
|
|
3985
4502
|
[name: string]: unknown;
|
|
3986
4503
|
};
|
|
@@ -4290,8 +4807,8 @@ type $Read<T> = {
|
|
|
4290
4807
|
type $Write<T> = {
|
|
4291
4808
|
readonly $write: T;
|
|
4292
4809
|
};
|
|
4293
|
-
type Readable$1<T> = T extends $Write<any> ? never : T extends $Read<infer U> ? Readable$1<U> : T extends (infer E)[] ? Readable$1<E>[] : T extends object ? { [K in keyof T as NonNullable<T[K]> extends $Write<any> ? never : K]: Readable$1<T[K]
|
|
4294
|
-
type Writable$1<T> = T extends $Read<any> ? never : T extends $Write<infer U> ? Writable$1<U> : T extends (infer E)[] ? Writable$1<E>[] : T extends object ? { [K in keyof T as NonNullable<T[K]> extends $Read<any> ? never : K]: Writable$1<T[K]
|
|
4810
|
+
type Readable$1<T> = T extends $Write<any> ? never : T extends $Read<infer U> ? Readable$1<U> : T extends (infer E)[] ? Readable$1<E>[] : T extends object ? { [K in keyof T as NonNullable<T[K]> extends $Write<any> ? never : K]: Readable$1<T[K]>; } : T;
|
|
4811
|
+
type Writable$1<T> = T extends $Read<any> ? never : T extends $Write<infer U> ? Writable$1<U> : T extends (infer E)[] ? Writable$1<E>[] : T extends object ? { [K in keyof T as NonNullable<T[K]> extends $Read<any> ? never : K]: Writable$1<T[K]>; } & { [K in keyof T as NonNullable<T[K]> extends $Read<any> ? K : never]?: never; } : T;
|
|
4295
4812
|
interface paths$1 {
|
|
4296
4813
|
"/pos/catalog/inventories": {
|
|
4297
4814
|
parameters: {
|
|
@@ -4661,7 +5178,8 @@ interface components$1 {
|
|
|
4661
5178
|
* @description Details about an active coupon applied to a cart/order
|
|
4662
5179
|
*/
|
|
4663
5180
|
AppliedCoupon: {
|
|
4664
|
-
coupon_id: string;
|
|
5181
|
+
coupon_id: string;
|
|
5182
|
+
/** @enum {unknown} */
|
|
4665
5183
|
coupon_type: "discount" | "free-goods" | "fixed-price" | "free-shipping" | "buy-x-get-y" | "volume-based" | "accelerated-rewards";
|
|
4666
5184
|
savings: number;
|
|
4667
5185
|
product_id: string | null;
|
|
@@ -4674,7 +5192,8 @@ interface components$1 {
|
|
|
4674
5192
|
* @description Details about an active promotion applied to a cart/order
|
|
4675
5193
|
*/
|
|
4676
5194
|
AppliedPromotion: {
|
|
4677
|
-
promotion_id: string;
|
|
5195
|
+
promotion_id: string;
|
|
5196
|
+
/** @enum {unknown} */
|
|
4678
5197
|
promotion_type: "discount" | "free-goods" | "free-shipping" | "buy-x-get-y" | "volume-based";
|
|
4679
5198
|
savings: number;
|
|
4680
5199
|
product_id: string | null;
|
|
@@ -4695,7 +5214,8 @@ interface components$1 {
|
|
|
4695
5214
|
*/
|
|
4696
5215
|
bank_account_number?: string;
|
|
4697
5216
|
bank_name?: string;
|
|
4698
|
-
};
|
|
5217
|
+
};
|
|
5218
|
+
/** BusinessInfo */
|
|
4699
5219
|
BusinessInfo: {
|
|
4700
5220
|
name?: string;
|
|
4701
5221
|
business_type?: string;
|
|
@@ -4712,9 +5232,11 @@ interface components$1 {
|
|
|
4712
5232
|
* @description masked card number
|
|
4713
5233
|
* e.g. ************1111
|
|
4714
5234
|
*/
|
|
4715
|
-
card_number?: string;
|
|
5235
|
+
card_number?: string;
|
|
5236
|
+
/** @enum {unknown} */
|
|
4716
5237
|
card_type?: "Visa" | "Master Card" | "Rupay";
|
|
4717
|
-
};
|
|
5238
|
+
};
|
|
5239
|
+
/** CheckInventoryResponse */
|
|
4718
5240
|
CheckInventoryResponse: {
|
|
4719
5241
|
allowed_actions?: components$1["schemas"]["InventoryAction"][];
|
|
4720
5242
|
shipment_items?: components$1["schemas"]["ShipmentItem"][];
|
|
@@ -4742,27 +5264,33 @@ interface components$1 {
|
|
|
4742
5264
|
name?: string;
|
|
4743
5265
|
inventory_status?: components$1["schemas"]["InventoryStatus"];
|
|
4744
5266
|
}[];
|
|
4745
|
-
};
|
|
5267
|
+
};
|
|
5268
|
+
/** CollectInStoreFulfillment */
|
|
4746
5269
|
CollectInStoreFulfillment: {
|
|
4747
5270
|
/**
|
|
4748
5271
|
* @description discriminator enum property added by openapi-typescript
|
|
4749
5272
|
* @enum {string}
|
|
4750
5273
|
*/
|
|
4751
|
-
fulfillment_type: "collect-in-store";
|
|
5274
|
+
fulfillment_type: "collect-in-store";
|
|
5275
|
+
/** @enum {string} */
|
|
4752
5276
|
preference_type?: $Read<"user" | "auto">;
|
|
4753
5277
|
pickup_location_id: string;
|
|
4754
5278
|
pickup_location_name?: $Read<string>;
|
|
4755
|
-
};
|
|
5279
|
+
};
|
|
5280
|
+
/** Customer */
|
|
4756
5281
|
Customer: components$1["schemas"]["CustomerInfo"] & {
|
|
4757
5282
|
business?: components$1["schemas"]["BusinessInfo"];
|
|
4758
5283
|
segments?: components$1["schemas"]["CustomerSegment"][];
|
|
4759
5284
|
address?: components$1["schemas"]["CustomerAddress"];
|
|
4760
|
-
};
|
|
5285
|
+
};
|
|
5286
|
+
/** CustomerAddress */
|
|
4761
5287
|
CustomerAddress: {
|
|
4762
5288
|
id?: $Read<string>;
|
|
4763
5289
|
first_name: string;
|
|
4764
|
-
last_name?: string | null;
|
|
4765
|
-
|
|
5290
|
+
last_name?: string | null;
|
|
5291
|
+
/** @description Two-letter code begin with a plus sign prefix that identifies different countries. By default it will be +91 if not provided. */
|
|
5292
|
+
country_code?: string;
|
|
5293
|
+
/** @description 10 digit phone number without country code. */
|
|
4766
5294
|
phone: string;
|
|
4767
5295
|
email: string;
|
|
4768
5296
|
address_line1: string;
|
|
@@ -4770,21 +5298,27 @@ interface components$1 {
|
|
|
4770
5298
|
landmark?: string | null;
|
|
4771
5299
|
pincode: string;
|
|
4772
5300
|
city: string;
|
|
4773
|
-
state: string;
|
|
4774
|
-
|
|
4775
|
-
|
|
5301
|
+
state: string;
|
|
5302
|
+
/** @enum {unknown} */
|
|
5303
|
+
country: "India";
|
|
5304
|
+
/** @description Use in shipping details only for third party. */
|
|
5305
|
+
gstin?: string | null;
|
|
5306
|
+
/** @description Use in shipping details only for third party. */
|
|
4776
5307
|
business_name?: string | null;
|
|
4777
5308
|
is_phone_verified?: $Read<boolean>;
|
|
4778
5309
|
is_email_verified?: $Read<boolean>;
|
|
4779
5310
|
is_default_shipping?: boolean;
|
|
4780
5311
|
is_default_billing?: boolean;
|
|
4781
|
-
};
|
|
5312
|
+
};
|
|
5313
|
+
/** CustomerDetail */
|
|
4782
5314
|
CustomerDetail: components$1["schemas"]["Customer"] & {
|
|
4783
5315
|
loyalty?: components$1["schemas"]["CustomerLoyalty"];
|
|
4784
5316
|
notification_preferences?: components$1["schemas"]["NotificationPreferences"];
|
|
4785
|
-
};
|
|
5317
|
+
};
|
|
5318
|
+
/** CustomerInfo */
|
|
4786
5319
|
CustomerInfo: {
|
|
4787
|
-
/** @description user id */
|
|
5320
|
+
/** @description user id */
|
|
5321
|
+
id?: $Read<string>;
|
|
4788
5322
|
first_name?: string;
|
|
4789
5323
|
last_name?: string;
|
|
4790
5324
|
full_name?: $Read<string>;
|
|
@@ -4795,22 +5329,33 @@ interface components$1 {
|
|
|
4795
5329
|
is_phone_verified?: $Read<boolean>;
|
|
4796
5330
|
is_email_verified?: $Read<boolean>;
|
|
4797
5331
|
is_whatsapp_verified?: $Read<boolean>;
|
|
4798
|
-
status?: components$1["schemas"]["CustomerStatus"];
|
|
4799
|
-
|
|
4800
|
-
|
|
5332
|
+
status?: components$1["schemas"]["CustomerStatus"];
|
|
5333
|
+
/** Format: date-time */
|
|
5334
|
+
created_at?: $Read<string>;
|
|
5335
|
+
/** Format: date-time */
|
|
5336
|
+
modified_at?: $Read<string>;
|
|
5337
|
+
/** Format: date-time */
|
|
4801
5338
|
last_seen?: $Read<string>;
|
|
4802
5339
|
kyc_status?: components$1["schemas"]["KycStatus"];
|
|
4803
5340
|
is_verified?: $Read<boolean>;
|
|
4804
5341
|
tags?: string[];
|
|
4805
|
-
};
|
|
5342
|
+
};
|
|
5343
|
+
/** CustomerLoyalty */
|
|
4806
5344
|
CustomerLoyalty: {
|
|
4807
|
-
membership_number?: string;
|
|
4808
|
-
|
|
4809
|
-
|
|
4810
|
-
|
|
4811
|
-
|
|
4812
|
-
|
|
4813
|
-
|
|
5345
|
+
membership_number?: string;
|
|
5346
|
+
/** @description total points earned within the current loyalty program. */
|
|
5347
|
+
points_earned?: number;
|
|
5348
|
+
/** @description total points redeemed within the current loyalty program. */
|
|
5349
|
+
points_redeemed?: number;
|
|
5350
|
+
/** @description total points available. */
|
|
5351
|
+
points_balance?: number;
|
|
5352
|
+
/** @description The total amount a customer has spent within the current loyalty program, excluding taxes, promotional discounts, and redeemed loyalty points. This value is used to determine tier eligibility and earning points calculation. */
|
|
5353
|
+
total_spent?: number;
|
|
5354
|
+
/** @description The total number of completed orders counted in the current loyalty program. */
|
|
5355
|
+
total_orders?: number;
|
|
5356
|
+
/** @description The total amount a customer has spent across all time, regardless of loyalty program participation. This includes all completed orders and excludes taxes, promotional discounts, and redeemed points. */
|
|
5357
|
+
lifetime_spent?: number;
|
|
5358
|
+
/** @description The total number of completed orders across all time, regardless of loyalty program. */
|
|
4814
5359
|
lifetime_orders?: number;
|
|
4815
5360
|
/**
|
|
4816
5361
|
* Format: date-time
|
|
@@ -4837,40 +5382,49 @@ interface components$1 {
|
|
|
4837
5382
|
total_spent_threshold?: number | null;
|
|
4838
5383
|
total_orders_threshold?: number | null;
|
|
4839
5384
|
};
|
|
4840
|
-
name?: string;
|
|
4841
|
-
|
|
5385
|
+
name?: string;
|
|
5386
|
+
/** @enum {string} */
|
|
5387
|
+
renewal_type?: "yearly" | "never" | "custom";
|
|
5388
|
+
/** @enum {string} */
|
|
4842
5389
|
tier_upgrade_criteria?: "total-spent" | "total-orders" | "custom";
|
|
4843
|
-
};
|
|
5390
|
+
};
|
|
5391
|
+
/** CustomerSegment */
|
|
4844
5392
|
CustomerSegment: {
|
|
4845
5393
|
id?: string;
|
|
4846
5394
|
name?: string;
|
|
4847
|
-
};
|
|
4848
|
-
|
|
5395
|
+
};
|
|
5396
|
+
/** @enum {unknown} */
|
|
5397
|
+
CustomerStatus: "active" | "inactive";
|
|
5398
|
+
/** DeliveryFulfillment */
|
|
4849
5399
|
DeliveryFulfillment: {
|
|
4850
5400
|
/**
|
|
4851
5401
|
* @description discriminator enum property added by openapi-typescript
|
|
4852
5402
|
* @enum {string}
|
|
4853
5403
|
*/
|
|
4854
|
-
fulfillment_type: "delivery";
|
|
5404
|
+
fulfillment_type: "delivery";
|
|
5405
|
+
/** @enum {string} */
|
|
4855
5406
|
preference_type?: $Read<"user" | "auto">;
|
|
4856
5407
|
shipping_provider_id: string | null;
|
|
4857
5408
|
shipping_provider_name?: $Read<string | null>;
|
|
4858
5409
|
courier_company_id?: string | null;
|
|
4859
5410
|
courier_company_name?: $Read<string | null>;
|
|
4860
|
-
};
|
|
5411
|
+
};
|
|
5412
|
+
/** FulfillmentItem */
|
|
4861
5413
|
FulfillmentItem: {
|
|
4862
5414
|
product_id: string;
|
|
4863
5415
|
product_name: $Read<string>;
|
|
4864
5416
|
variant_id: string | null;
|
|
4865
5417
|
variant_name: $Read<string | null>;
|
|
4866
5418
|
quantity: number;
|
|
4867
|
-
};
|
|
5419
|
+
};
|
|
5420
|
+
/** FulfillmentPreference */
|
|
4868
5421
|
FulfillmentPreference: components$1["schemas"]["CollectInStoreFulfillment"] | components$1["schemas"]["DeliveryFulfillment"] | components$1["schemas"]["PartialCollectAndDelivery"];
|
|
4869
5422
|
/**
|
|
4870
5423
|
* InventoryAction
|
|
4871
5424
|
* @enum {unknown}
|
|
4872
5425
|
*/
|
|
4873
|
-
InventoryAction: "create-shipment" | "refund-shortfall" | "wait-for-inventory" | "reject-order";
|
|
5426
|
+
InventoryAction: "create-shipment" | "refund-shortfall" | "wait-for-inventory" | "reject-order";
|
|
5427
|
+
/** InventoryActivity */
|
|
4874
5428
|
InventoryActivity: {
|
|
4875
5429
|
product_id?: string;
|
|
4876
5430
|
product_name?: string;
|
|
@@ -4878,29 +5432,39 @@ interface components$1 {
|
|
|
4878
5432
|
variant_name?: string;
|
|
4879
5433
|
sku?: string;
|
|
4880
5434
|
warehouse_id?: string;
|
|
4881
|
-
warehouse?: components$1["schemas"]["WarehouseBasicDetail"];
|
|
5435
|
+
warehouse?: components$1["schemas"]["WarehouseBasicDetail"];
|
|
5436
|
+
/** @enum {unknown} */
|
|
4882
5437
|
activity_type?: "add" | "reserve" | "reduce" | "adjust" | "update";
|
|
4883
5438
|
quantity?: number;
|
|
4884
5439
|
reason?: string;
|
|
4885
|
-
lot_batch?: string;
|
|
4886
|
-
|
|
5440
|
+
lot_batch?: string;
|
|
5441
|
+
/** Format: date */
|
|
5442
|
+
mfg_date?: string;
|
|
5443
|
+
/** Format: date */
|
|
4887
5444
|
exp_date?: string;
|
|
4888
|
-
manufacturer?: string;
|
|
4889
|
-
|
|
5445
|
+
manufacturer?: string;
|
|
5446
|
+
/** Format: date-time */
|
|
5447
|
+
created_at?: string;
|
|
5448
|
+
/** Format: date-time */
|
|
4890
5449
|
modified_at?: string;
|
|
4891
|
-
};
|
|
5450
|
+
};
|
|
5451
|
+
/** InventoryDetail */
|
|
4892
5452
|
InventoryDetail: components$1["schemas"]["ItemWiseInventory"] & {
|
|
4893
5453
|
details?: components$1["schemas"]["WarehouseWiseInventory"][];
|
|
4894
|
-
};
|
|
5454
|
+
};
|
|
5455
|
+
/** @enum {unknown} */
|
|
4895
5456
|
InventoryStatus: "fulfilled" | "partially-fulfilled" | "not-fulfilled";
|
|
4896
5457
|
/**
|
|
4897
5458
|
* Invoice
|
|
4898
5459
|
* @description Invoice model
|
|
4899
5460
|
*/
|
|
4900
5461
|
Invoice: {
|
|
4901
|
-
invoice_number?: string;
|
|
4902
|
-
|
|
4903
|
-
|
|
5462
|
+
invoice_number?: string;
|
|
5463
|
+
/** Format: date-time */
|
|
5464
|
+
invoice_date?: string;
|
|
5465
|
+
/** @description Invoice Reference Number */
|
|
5466
|
+
irn_number?: string;
|
|
5467
|
+
/** @description Acknowledgement Number */
|
|
4904
5468
|
ack_number?: string;
|
|
4905
5469
|
/**
|
|
4906
5470
|
* Format: date-time
|
|
@@ -4925,8 +5489,10 @@ interface components$1 {
|
|
|
4925
5489
|
igst?: number;
|
|
4926
5490
|
cgst?: number;
|
|
4927
5491
|
sgst?: number;
|
|
4928
|
-
}[];
|
|
4929
|
-
|
|
5492
|
+
}[];
|
|
5493
|
+
/** Format: date-time */
|
|
5494
|
+
created_at?: string;
|
|
5495
|
+
/** Format: date-time */
|
|
4930
5496
|
modified_at?: string;
|
|
4931
5497
|
};
|
|
4932
5498
|
/**
|
|
@@ -4954,7 +5520,8 @@ interface components$1 {
|
|
|
4954
5520
|
batch_number?: string;
|
|
4955
5521
|
expiry?: string;
|
|
4956
5522
|
amount?: number;
|
|
4957
|
-
};
|
|
5523
|
+
};
|
|
5524
|
+
/** ItemWiseInventory */
|
|
4958
5525
|
ItemWiseInventory: {
|
|
4959
5526
|
product_id?: string;
|
|
4960
5527
|
product_name?: string;
|
|
@@ -4963,19 +5530,29 @@ interface components$1 {
|
|
|
4963
5530
|
sku?: string;
|
|
4964
5531
|
track_quantity?: boolean;
|
|
4965
5532
|
allow_backorder?: boolean;
|
|
4966
|
-
track_lot_batch?: boolean;
|
|
4967
|
-
|
|
4968
|
-
|
|
4969
|
-
|
|
4970
|
-
|
|
4971
|
-
|
|
5533
|
+
track_lot_batch?: boolean;
|
|
5534
|
+
/** Format: decimal */
|
|
5535
|
+
low_stock_threshold?: number;
|
|
5536
|
+
/** Format: decimal */
|
|
5537
|
+
received_quantity?: number;
|
|
5538
|
+
/** Format: decimal */
|
|
5539
|
+
reserved_quantity?: number;
|
|
5540
|
+
/** Format: decimal */
|
|
5541
|
+
sold_quantity?: number;
|
|
5542
|
+
/** Format: decimal */
|
|
5543
|
+
adjusted_quantity?: number;
|
|
5544
|
+
/** Format: decimal */
|
|
4972
5545
|
stock_quantity?: number;
|
|
4973
5546
|
images?: components$1["schemas"]["ProductImage"][];
|
|
4974
|
-
};
|
|
4975
|
-
|
|
5547
|
+
};
|
|
5548
|
+
/** @enum {unknown} */
|
|
5549
|
+
KycStatus: "pending" | "approved" | "rejected";
|
|
5550
|
+
/** LotBatchWiseInventory */
|
|
4976
5551
|
LotBatchWiseInventory: components$1["schemas"]["ItemWiseInventory"] & {
|
|
4977
|
-
lot_batch?: string;
|
|
4978
|
-
|
|
5552
|
+
lot_batch?: string;
|
|
5553
|
+
/** Format: date */
|
|
5554
|
+
mfg_date?: string;
|
|
5555
|
+
/** Format: date */
|
|
4979
5556
|
exp_date?: string;
|
|
4980
5557
|
manufacturer?: string;
|
|
4981
5558
|
};
|
|
@@ -5017,45 +5594,65 @@ interface components$1 {
|
|
|
5017
5594
|
* @description Set channel preferences for each type of
|
|
5018
5595
|
*/
|
|
5019
5596
|
NotificationPreferences: {
|
|
5020
|
-
/** @description These notifications are typically critical for user engagement, providing updates, confirmations, or alerts related to their account activities. */
|
|
5021
|
-
|
|
5597
|
+
/** @description These notifications are typically critical for user engagement, providing updates, confirmations, or alerts related to their account activities. */
|
|
5598
|
+
transactional?: components$1["schemas"]["NotificationChannelPreferences"];
|
|
5599
|
+
/** @description These notifications aim to engage users with promotional content and enhance their overall experience with the platform. */
|
|
5600
|
+
promotional?: components$1["schemas"]["NotificationChannelPreferences"];
|
|
5601
|
+
/** @description These notifications are often sent periodically as part of a subscription service. */
|
|
5022
5602
|
newsletter?: components$1["schemas"]["NotificationChannelPreferences"];
|
|
5023
5603
|
};
|
|
5024
5604
|
OpeningHours: {
|
|
5025
5605
|
monday: {
|
|
5026
|
-
/** Format: time */
|
|
5606
|
+
/** Format: time */
|
|
5607
|
+
opening_time: string;
|
|
5608
|
+
/** Format: time */
|
|
5027
5609
|
closing_time: string;
|
|
5028
5610
|
} | null;
|
|
5029
5611
|
tuesday: {
|
|
5030
|
-
/** Format: time */
|
|
5612
|
+
/** Format: time */
|
|
5613
|
+
opening_time: string;
|
|
5614
|
+
/** Format: time */
|
|
5031
5615
|
closing_time: string;
|
|
5032
5616
|
} | null;
|
|
5033
5617
|
wednesday: {
|
|
5034
|
-
/** Format: time */
|
|
5618
|
+
/** Format: time */
|
|
5619
|
+
opening_time: string;
|
|
5620
|
+
/** Format: time */
|
|
5035
5621
|
closing_time: string;
|
|
5036
5622
|
} | null;
|
|
5037
5623
|
thursday: {
|
|
5038
|
-
/** Format: time */
|
|
5624
|
+
/** Format: time */
|
|
5625
|
+
opening_time: string;
|
|
5626
|
+
/** Format: time */
|
|
5039
5627
|
closing_time: string;
|
|
5040
5628
|
} | null;
|
|
5041
5629
|
friday: {
|
|
5042
|
-
/** Format: time */
|
|
5630
|
+
/** Format: time */
|
|
5631
|
+
opening_time: string;
|
|
5632
|
+
/** Format: time */
|
|
5043
5633
|
closing_time: string;
|
|
5044
5634
|
} | null;
|
|
5045
5635
|
saturday: {
|
|
5046
|
-
/** Format: time */
|
|
5636
|
+
/** Format: time */
|
|
5637
|
+
opening_time: string;
|
|
5638
|
+
/** Format: time */
|
|
5047
5639
|
closing_time: string;
|
|
5048
5640
|
} | null;
|
|
5049
5641
|
sunday: {
|
|
5050
|
-
/** Format: time */
|
|
5642
|
+
/** Format: time */
|
|
5643
|
+
opening_time: string;
|
|
5644
|
+
/** Format: time */
|
|
5051
5645
|
closing_time: string;
|
|
5052
5646
|
} | null;
|
|
5053
|
-
};
|
|
5647
|
+
};
|
|
5648
|
+
/** Order */
|
|
5054
5649
|
Order: {
|
|
5055
|
-
order_number?: string;
|
|
5650
|
+
order_number?: string;
|
|
5651
|
+
/** Format: date-time */
|
|
5056
5652
|
order_date?: string;
|
|
5057
5653
|
status?: components$1["schemas"]["OrderStatus"];
|
|
5058
|
-
payment_status?: components$1["schemas"]["PaymentStatus"];
|
|
5654
|
+
payment_status?: components$1["schemas"]["PaymentStatus"];
|
|
5655
|
+
/** Format: date-time */
|
|
5059
5656
|
payment_success_date?: string;
|
|
5060
5657
|
customer_id?: string;
|
|
5061
5658
|
customer_email?: string | null;
|
|
@@ -5064,19 +5661,29 @@ interface components$1 {
|
|
|
5064
5661
|
is_promotion_applied?: boolean;
|
|
5065
5662
|
promotion_discount_amount?: number | null;
|
|
5066
5663
|
is_coupon_applied?: boolean;
|
|
5067
|
-
coupon_code?: string | null;
|
|
5664
|
+
coupon_code?: string | null;
|
|
5665
|
+
/** Format: double */
|
|
5068
5666
|
coupon_discount_amount?: number | null;
|
|
5069
|
-
on_subscription?: boolean;
|
|
5070
|
-
|
|
5071
|
-
|
|
5072
|
-
|
|
5073
|
-
|
|
5074
|
-
|
|
5075
|
-
|
|
5076
|
-
|
|
5667
|
+
on_subscription?: boolean;
|
|
5668
|
+
/** Format: double */
|
|
5669
|
+
subtotal?: number;
|
|
5670
|
+
/** Format: double */
|
|
5671
|
+
item_total_tax?: number;
|
|
5672
|
+
/** Format: double */
|
|
5673
|
+
subtotal_including_tax?: number;
|
|
5674
|
+
/** Format: double */
|
|
5675
|
+
shipping_amount?: number;
|
|
5676
|
+
/** Format: double */
|
|
5677
|
+
shipping_total_tax?: number;
|
|
5678
|
+
/** Format: double */
|
|
5679
|
+
shipping_amount_including_tax?: number;
|
|
5680
|
+
/** Format: double */
|
|
5681
|
+
total_tax?: number;
|
|
5682
|
+
/** Format: double */
|
|
5077
5683
|
grand_total?: number;
|
|
5078
5684
|
loyalty_point_redeemed?: number;
|
|
5079
|
-
credit_balance_used?: number;
|
|
5685
|
+
credit_balance_used?: number;
|
|
5686
|
+
/** Format: double */
|
|
5080
5687
|
to_be_paid?: number;
|
|
5081
5688
|
loyalty_point_earned?: number;
|
|
5082
5689
|
order_items_count?: number;
|
|
@@ -5084,22 +5691,31 @@ interface components$1 {
|
|
|
5084
5691
|
name?: string;
|
|
5085
5692
|
code?: string;
|
|
5086
5693
|
symbol?: string;
|
|
5087
|
-
};
|
|
5088
|
-
|
|
5694
|
+
};
|
|
5695
|
+
/** Format: date-time */
|
|
5696
|
+
created_at?: string;
|
|
5697
|
+
/** Format: date-time */
|
|
5089
5698
|
modified_at?: string;
|
|
5090
|
-
};
|
|
5091
|
-
|
|
5699
|
+
};
|
|
5700
|
+
/** @enum {unknown} */
|
|
5701
|
+
OrderAction: "create-shipment" | "download-invoice" | "inventory-check" | "refresh-payment-status" | "return-replace" | "update-payment-status" | "cancel-order";
|
|
5702
|
+
/** OrderActivity */
|
|
5092
5703
|
OrderActivity: {
|
|
5093
5704
|
activity_type?: $Read<string>;
|
|
5094
5705
|
order_status?: $Read<string>;
|
|
5095
|
-
comment: string;
|
|
5706
|
+
comment: string;
|
|
5707
|
+
/** @enum {unknown} */
|
|
5096
5708
|
user_type?: $Read<"customer" | "admin" | "system">;
|
|
5097
|
-
user_name?: $Read<string>;
|
|
5098
|
-
|
|
5709
|
+
user_name?: $Read<string>;
|
|
5710
|
+
/** Format: date-time */
|
|
5711
|
+
created_at?: $Read<string>;
|
|
5712
|
+
/** Format: date-time */
|
|
5099
5713
|
modified_at?: $Read<string>;
|
|
5100
|
-
};
|
|
5714
|
+
};
|
|
5715
|
+
/** OrderDetail */
|
|
5101
5716
|
OrderDetail: {
|
|
5102
|
-
order_number: string;
|
|
5717
|
+
order_number: string;
|
|
5718
|
+
/** Format: date-time */
|
|
5103
5719
|
order_date: string;
|
|
5104
5720
|
status: components$1["schemas"]["OrderStatus"];
|
|
5105
5721
|
payment_status: components$1["schemas"]["PaymentStatus"];
|
|
@@ -5108,10 +5724,12 @@ interface components$1 {
|
|
|
5108
5724
|
customer_email: string | null;
|
|
5109
5725
|
customer_phone: string | null;
|
|
5110
5726
|
customer_note: string | null;
|
|
5111
|
-
is_promotion_applied: boolean;
|
|
5727
|
+
is_promotion_applied: boolean;
|
|
5728
|
+
/** Format: double */
|
|
5112
5729
|
promotion_discount_amount: number | null;
|
|
5113
5730
|
is_coupon_applied: boolean;
|
|
5114
|
-
coupon_code: string | null;
|
|
5731
|
+
coupon_code: string | null;
|
|
5732
|
+
/** Format: double */
|
|
5115
5733
|
coupon_discount_amount: number | null;
|
|
5116
5734
|
on_subscription: boolean;
|
|
5117
5735
|
fulfillment_preference: components$1["schemas"]["FulfillmentPreference"];
|
|
@@ -5122,19 +5740,32 @@ interface components$1 {
|
|
|
5122
5740
|
};
|
|
5123
5741
|
metadata: {
|
|
5124
5742
|
[key: string]: string;
|
|
5125
|
-
};
|
|
5126
|
-
|
|
5127
|
-
|
|
5128
|
-
|
|
5129
|
-
|
|
5130
|
-
|
|
5131
|
-
|
|
5132
|
-
|
|
5133
|
-
|
|
5134
|
-
|
|
5135
|
-
|
|
5136
|
-
|
|
5137
|
-
|
|
5743
|
+
};
|
|
5744
|
+
/** Format: double */
|
|
5745
|
+
subtotal: number;
|
|
5746
|
+
/** Format: double */
|
|
5747
|
+
subtotal_tax: number;
|
|
5748
|
+
/** Format: double */
|
|
5749
|
+
subtotal_including_tax: number;
|
|
5750
|
+
/** Format: double */
|
|
5751
|
+
shipping_amount: number;
|
|
5752
|
+
/** Format: double */
|
|
5753
|
+
shipping_tax_rate: number;
|
|
5754
|
+
/** Format: double */
|
|
5755
|
+
shipping_total_tax: number;
|
|
5756
|
+
/** Format: double */
|
|
5757
|
+
shipping_amount_including_tax: number;
|
|
5758
|
+
/** Format: double */
|
|
5759
|
+
total_tax: number;
|
|
5760
|
+
/** Format: double */
|
|
5761
|
+
grand_total: number;
|
|
5762
|
+
/** Format: double */
|
|
5763
|
+
loyalty_point_redeemed: number;
|
|
5764
|
+
/** Format: double */
|
|
5765
|
+
credit_balance_used: number;
|
|
5766
|
+
/** Format: double */
|
|
5767
|
+
to_be_paid: number;
|
|
5768
|
+
/** Format: double */
|
|
5138
5769
|
loyalty_point_earned: number;
|
|
5139
5770
|
order_items_count: number;
|
|
5140
5771
|
order_items: components$1["schemas"]["OrderItem"][];
|
|
@@ -5150,10 +5781,13 @@ interface components$1 {
|
|
|
5150
5781
|
applied_coupons: components$1["schemas"]["AppliedCoupon"][];
|
|
5151
5782
|
applied_promotions: components$1["schemas"]["AppliedPromotion"][];
|
|
5152
5783
|
payments: components$1["schemas"]["OrderPayment"][];
|
|
5153
|
-
shipments: components$1["schemas"]["OrderShipment"][];
|
|
5154
|
-
|
|
5784
|
+
shipments: components$1["schemas"]["OrderShipment"][];
|
|
5785
|
+
/** Format: date-time */
|
|
5786
|
+
created_at: string;
|
|
5787
|
+
/** Format: date-time */
|
|
5155
5788
|
modified_at: string;
|
|
5156
|
-
};
|
|
5789
|
+
};
|
|
5790
|
+
/** OrderItem */
|
|
5157
5791
|
OrderItem: {
|
|
5158
5792
|
product_id?: $Read<string>;
|
|
5159
5793
|
product_name?: $Read<string>;
|
|
@@ -5167,16 +5801,26 @@ interface components$1 {
|
|
|
5167
5801
|
subscription_frequency?: $Read<string | null>;
|
|
5168
5802
|
quantity: number;
|
|
5169
5803
|
free_quantity?: $Read<number>;
|
|
5170
|
-
is_free_item?: $Read<boolean>;
|
|
5171
|
-
|
|
5172
|
-
|
|
5173
|
-
|
|
5174
|
-
|
|
5175
|
-
|
|
5176
|
-
|
|
5177
|
-
|
|
5178
|
-
|
|
5179
|
-
|
|
5804
|
+
is_free_item?: $Read<boolean>;
|
|
5805
|
+
/** Format: double */
|
|
5806
|
+
selling_price?: $Read<number>;
|
|
5807
|
+
/** Format: double */
|
|
5808
|
+
listing_price?: $Read<number>;
|
|
5809
|
+
/** Format: double */
|
|
5810
|
+
promotion_discount_amount?: $Read<number>;
|
|
5811
|
+
/** Format: double */
|
|
5812
|
+
coupon_discount_amount?: $Read<number>;
|
|
5813
|
+
/** @enum {unknown} */
|
|
5814
|
+
tax_type?: $Read<"GST">;
|
|
5815
|
+
/** Format: float */
|
|
5816
|
+
tax_rate?: $Read<number>;
|
|
5817
|
+
/** Format: double */
|
|
5818
|
+
tax_amount?: $Read<number>;
|
|
5819
|
+
/** Format: double */
|
|
5820
|
+
handling_charge_excluding_tax?: $Read<number>;
|
|
5821
|
+
/** Format: double */
|
|
5822
|
+
handling_charge_including_tax?: number;
|
|
5823
|
+
/** Format: double */
|
|
5180
5824
|
handling_charge_tax_rate?: number;
|
|
5181
5825
|
variant_id?: string | null;
|
|
5182
5826
|
variant_name?: string | null;
|
|
@@ -5186,7 +5830,9 @@ interface components$1 {
|
|
|
5186
5830
|
* @description order list model
|
|
5187
5831
|
*/
|
|
5188
5832
|
OrderList: {
|
|
5189
|
-
/** @description Order id. Same as order number. */
|
|
5833
|
+
/** @description Order id. Same as order number. */
|
|
5834
|
+
id: string;
|
|
5835
|
+
/** @description Unique number associated with the order. */
|
|
5190
5836
|
order_number: string;
|
|
5191
5837
|
/**
|
|
5192
5838
|
* Format: date-time
|
|
@@ -5194,9 +5840,12 @@ interface components$1 {
|
|
|
5194
5840
|
*/
|
|
5195
5841
|
order_date: string;
|
|
5196
5842
|
status: components$1["schemas"]["OrderStatus"];
|
|
5197
|
-
payment_status: components$1["schemas"]["PaymentStatus"];
|
|
5198
|
-
|
|
5199
|
-
|
|
5843
|
+
payment_status: components$1["schemas"]["PaymentStatus"];
|
|
5844
|
+
/** @description Date and time when the payment for the order was successfully processed. */
|
|
5845
|
+
payment_success_date: string | null;
|
|
5846
|
+
/** @enum {unknown} */
|
|
5847
|
+
fulfillment_type: "collect-in-store" | "delivery";
|
|
5848
|
+
/** @description Indicates whether the order includes subscription items. */
|
|
5200
5849
|
on_subscription: boolean;
|
|
5201
5850
|
/**
|
|
5202
5851
|
* Format: double
|
|
@@ -5217,13 +5866,15 @@ interface components$1 {
|
|
|
5217
5866
|
* Format: double
|
|
5218
5867
|
* @description Amount remaining to be paid for the order.
|
|
5219
5868
|
*/
|
|
5220
|
-
to_be_paid: number;
|
|
5869
|
+
to_be_paid: number;
|
|
5870
|
+
/** @description Total count of items included in the order. */
|
|
5221
5871
|
order_items_count: number;
|
|
5222
5872
|
order_items: components$1["schemas"]["OrderItem"][];
|
|
5223
5873
|
customer_id: string;
|
|
5224
5874
|
customer_note: string | null;
|
|
5225
5875
|
billing_address: components$1["schemas"]["CustomerAddress"];
|
|
5226
|
-
shipping_address: components$1["schemas"]["CustomerAddress"];
|
|
5876
|
+
shipping_address: components$1["schemas"]["CustomerAddress"];
|
|
5877
|
+
/** Format: double */
|
|
5227
5878
|
loyalty_point_earned: number;
|
|
5228
5879
|
coupon_code: string | null;
|
|
5229
5880
|
currency: {
|
|
@@ -5238,8 +5889,10 @@ interface components$1 {
|
|
|
5238
5889
|
};
|
|
5239
5890
|
metadata?: {
|
|
5240
5891
|
[key: string]: string;
|
|
5241
|
-
};
|
|
5242
|
-
|
|
5892
|
+
};
|
|
5893
|
+
/** Format: date-time */
|
|
5894
|
+
created_at: string;
|
|
5895
|
+
/** Format: date-time */
|
|
5243
5896
|
modified_at: string;
|
|
5244
5897
|
};
|
|
5245
5898
|
/**
|
|
@@ -5252,15 +5905,20 @@ interface components$1 {
|
|
|
5252
5905
|
* @description Common fields in all types of payments.
|
|
5253
5906
|
*/
|
|
5254
5907
|
OrderPaymentInfo: {
|
|
5255
|
-
/** @enum {unknown} */
|
|
5256
|
-
|
|
5908
|
+
/** @enum {unknown} */
|
|
5909
|
+
transaction_type?: "payment" | "refund";
|
|
5910
|
+
request_number?: string;
|
|
5911
|
+
/** Format: double */
|
|
5257
5912
|
amount?: number;
|
|
5258
|
-
payment_status?: components$1["schemas"]["PaymentStatus"];
|
|
5913
|
+
payment_status?: components$1["schemas"]["PaymentStatus"];
|
|
5914
|
+
/** Format: date-time */
|
|
5259
5915
|
payment_date?: string;
|
|
5260
|
-
payment_reference_number?: string | null;
|
|
5916
|
+
payment_reference_number?: string | null;
|
|
5917
|
+
/** @enum {unknown} */
|
|
5261
5918
|
payment_method?: "Credit Card" | "Debit Card" | "Netbanking" | "UPI" | "Wallet" | "Loyalty Point" | "IMPS" | "NEFT" | "RTGS";
|
|
5262
5919
|
icon_url?: string;
|
|
5263
|
-
};
|
|
5920
|
+
};
|
|
5921
|
+
/** OrderReceiptJsonFormat */
|
|
5264
5922
|
OrderReceiptJsonFormat: components$1["schemas"]["Order"] & {
|
|
5265
5923
|
billing_address?: components$1["schemas"]["CustomerAddress"];
|
|
5266
5924
|
shipping_address?: components$1["schemas"]["CustomerAddress"];
|
|
@@ -5277,23 +5935,33 @@ interface components$1 {
|
|
|
5277
5935
|
total_weight?: number;
|
|
5278
5936
|
total_boxes?: number | null;
|
|
5279
5937
|
shipment_items_count?: number;
|
|
5280
|
-
shipment_items?: components$1["schemas"]["ShipmentItem"][];
|
|
5281
|
-
|
|
5282
|
-
|
|
5938
|
+
shipment_items?: components$1["schemas"]["ShipmentItem"][];
|
|
5939
|
+
/** Format: double */
|
|
5940
|
+
shipping_amount?: number;
|
|
5941
|
+
/** Format: double */
|
|
5942
|
+
shipping_tax_amount?: number;
|
|
5943
|
+
/** Format: double */
|
|
5283
5944
|
shipping_amount_including_tax?: number;
|
|
5284
5945
|
courier_company_id?: string | null;
|
|
5285
5946
|
courier_company_name?: string | null;
|
|
5286
5947
|
shipping_label_url?: string;
|
|
5287
|
-
awb_no?: string | null;
|
|
5288
|
-
|
|
5289
|
-
|
|
5948
|
+
awb_no?: string | null;
|
|
5949
|
+
/** Format: date-time */
|
|
5950
|
+
eta_delivery?: string | null;
|
|
5951
|
+
/** Format: date-time */
|
|
5952
|
+
shipped_date?: string | null;
|
|
5953
|
+
/** Format: date-time */
|
|
5290
5954
|
delivered_date?: string | null;
|
|
5291
|
-
cancellation_reason?: string | null;
|
|
5292
|
-
|
|
5955
|
+
cancellation_reason?: string | null;
|
|
5956
|
+
/** Format: date-time */
|
|
5957
|
+
created_at?: string;
|
|
5958
|
+
/** Format: date-time */
|
|
5293
5959
|
modified_at?: string;
|
|
5294
|
-
};
|
|
5960
|
+
};
|
|
5961
|
+
/** OrderShipmentDetail */
|
|
5295
5962
|
OrderShipmentDetail: {
|
|
5296
|
-
order_number: string;
|
|
5963
|
+
order_number: string;
|
|
5964
|
+
/** Format: date-time */
|
|
5297
5965
|
order_date: string;
|
|
5298
5966
|
order_status: string;
|
|
5299
5967
|
sales_channel: {
|
|
@@ -5305,7 +5973,8 @@ interface components$1 {
|
|
|
5305
5973
|
customer_name: string;
|
|
5306
5974
|
shipments: components$1["schemas"]["Shipment"][];
|
|
5307
5975
|
allowed_actions: components$1["schemas"]["ShipmentAction"][];
|
|
5308
|
-
};
|
|
5976
|
+
};
|
|
5977
|
+
/** @enum {unknown} */
|
|
5309
5978
|
OrderStatus: "draft" | "awaiting_approval" | "confirmed" | "scheduled_requested" | "partially_scheduled" | "awaiting_shipment" | "shipped" | "partially_shipped" | "undelivered" | "partially_undelivered" | "return_to_origin" | "partially_return_to_origin" | "complete" | "partially_delivered" | "cancelled" | "pending" | "lost";
|
|
5310
5979
|
/**
|
|
5311
5980
|
* Pagination
|
|
@@ -5314,16 +5983,19 @@ interface components$1 {
|
|
|
5314
5983
|
Pagination: {
|
|
5315
5984
|
total_records?: number;
|
|
5316
5985
|
total_pages?: number;
|
|
5317
|
-
previous_page?: ((number | null) | null) | null;
|
|
5986
|
+
previous_page?: ((number | null) | null) | null;
|
|
5987
|
+
/** @default 25 */
|
|
5318
5988
|
limit: number;
|
|
5319
5989
|
next_page?: ((number | null) | null) | null;
|
|
5320
|
-
};
|
|
5990
|
+
};
|
|
5991
|
+
/** PartialCollectAndDelivery */
|
|
5321
5992
|
PartialCollectAndDelivery: {
|
|
5322
5993
|
/**
|
|
5323
5994
|
* @description discriminator enum property added by openapi-typescript
|
|
5324
5995
|
* @enum {string}
|
|
5325
5996
|
*/
|
|
5326
|
-
fulfillment_type: "partial-collect-and-delivery";
|
|
5997
|
+
fulfillment_type: "partial-collect-and-delivery";
|
|
5998
|
+
/** @enum {string} */
|
|
5327
5999
|
preference_type?: $Read<"user" | "auto">;
|
|
5328
6000
|
"collect-in-store": {
|
|
5329
6001
|
pickup_location_id: string;
|
|
@@ -5342,42 +6014,54 @@ interface components$1 {
|
|
|
5342
6014
|
* PaymentStatus
|
|
5343
6015
|
* @enum {unknown}
|
|
5344
6016
|
*/
|
|
5345
|
-
PaymentStatus: "pending" | "success" | "failed" | "partially_paid" | "refund_initiated" | "refunded" | "unsettled" | "settled" | "partially_settled";
|
|
6017
|
+
PaymentStatus: "pending" | "success" | "failed" | "partially_paid" | "refund_initiated" | "refunded" | "unsettled" | "settled" | "partially_settled";
|
|
6018
|
+
/** ProductImage */
|
|
5346
6019
|
ProductImage: {
|
|
5347
6020
|
title?: string | null;
|
|
5348
|
-
alternate_text?: string | null;
|
|
6021
|
+
alternate_text?: string | null;
|
|
6022
|
+
/** Format: int32 */
|
|
5349
6023
|
sort_order?: number;
|
|
5350
6024
|
url_tiny?: string;
|
|
5351
6025
|
url_thumbnail?: string;
|
|
5352
6026
|
url_standard?: string;
|
|
5353
6027
|
url_zoom?: string;
|
|
5354
|
-
file_id?: string;
|
|
6028
|
+
file_id?: string;
|
|
6029
|
+
/** @enum {unknown} */
|
|
5355
6030
|
file_type?: "image";
|
|
5356
|
-
};
|
|
6031
|
+
};
|
|
6032
|
+
/** SalesChannel */
|
|
5357
6033
|
SalesChannel: {
|
|
5358
6034
|
id: string;
|
|
5359
|
-
name: $Read<string>;
|
|
6035
|
+
name: $Read<string>;
|
|
6036
|
+
/** @enum {string} */
|
|
5360
6037
|
kind: "storefront" | "marketplace";
|
|
5361
6038
|
active: $Read<boolean>;
|
|
5362
|
-
};
|
|
6039
|
+
};
|
|
6040
|
+
/** Shipment */
|
|
5363
6041
|
Shipment: components$1["schemas"]["ShipmentInfo"] & {
|
|
5364
6042
|
shipment_items?: components$1["schemas"]["ShipmentItem"][];
|
|
5365
6043
|
} & {
|
|
5366
6044
|
packing?: components$1["schemas"]["ShipmentPackaging"];
|
|
5367
6045
|
} & {
|
|
5368
6046
|
progression?: components$1["schemas"]["ShipmentProgression"][];
|
|
5369
|
-
};
|
|
5370
|
-
|
|
6047
|
+
};
|
|
6048
|
+
/** @enum {unknown} */
|
|
6049
|
+
ShipmentAction: "create-shipment" | "download-invoice" | "inventory-check" | "return-replace" | "update-manual" | "cancel";
|
|
6050
|
+
/** ShipmentActivity */
|
|
5371
6051
|
ShipmentActivity: {
|
|
5372
6052
|
activity_type: string;
|
|
5373
|
-
comment: string;
|
|
6053
|
+
comment: string;
|
|
6054
|
+
/** @enum {unknown} */
|
|
5374
6055
|
status: "success" | "failed";
|
|
5375
6056
|
user_type: string;
|
|
5376
6057
|
user_name: string;
|
|
5377
|
-
details: string | null;
|
|
5378
|
-
|
|
6058
|
+
details: string | null;
|
|
6059
|
+
/** Format: date-time */
|
|
6060
|
+
created_at: string;
|
|
6061
|
+
/** Format: date-time */
|
|
5379
6062
|
modified_at: string;
|
|
5380
|
-
};
|
|
6063
|
+
};
|
|
6064
|
+
/** ShipmentBox */
|
|
5381
6065
|
ShipmentBox: {
|
|
5382
6066
|
box_name?: string;
|
|
5383
6067
|
box_length?: number;
|
|
@@ -5386,9 +6070,11 @@ interface components$1 {
|
|
|
5386
6070
|
box_weight?: number;
|
|
5387
6071
|
items_count?: number | null;
|
|
5388
6072
|
box_count?: number | null;
|
|
5389
|
-
};
|
|
6073
|
+
};
|
|
6074
|
+
/** ShipmentDetail */
|
|
5390
6075
|
ShipmentDetail: {
|
|
5391
|
-
order_number: string;
|
|
6076
|
+
order_number: string;
|
|
6077
|
+
/** Format: date-time */
|
|
5392
6078
|
order_date: string;
|
|
5393
6079
|
order_status: string;
|
|
5394
6080
|
sales_channel: {
|
|
@@ -5400,7 +6086,8 @@ interface components$1 {
|
|
|
5400
6086
|
customer_name?: string | null;
|
|
5401
6087
|
shipment_detail: components$1["schemas"]["Shipment"];
|
|
5402
6088
|
allowed_actions: components$1["schemas"]["ShipmentAction"][];
|
|
5403
|
-
};
|
|
6089
|
+
};
|
|
6090
|
+
/** ShipmentInfo */
|
|
5404
6091
|
ShipmentInfo: {
|
|
5405
6092
|
order_number: string;
|
|
5406
6093
|
order_status: string;
|
|
@@ -5410,12 +6097,18 @@ interface components$1 {
|
|
|
5410
6097
|
status: components$1["schemas"]["ShipmentStatus"];
|
|
5411
6098
|
total_weight: number;
|
|
5412
6099
|
total_boxes: number | null;
|
|
5413
|
-
shipment_items_count: number;
|
|
5414
|
-
|
|
5415
|
-
|
|
5416
|
-
|
|
5417
|
-
|
|
5418
|
-
|
|
6100
|
+
shipment_items_count: number;
|
|
6101
|
+
/** Format: double */
|
|
6102
|
+
shipping_estimated_cost: number;
|
|
6103
|
+
/** Format: double */
|
|
6104
|
+
shipping_discount_amount: number;
|
|
6105
|
+
/** Format: double */
|
|
6106
|
+
shipping_amount: number;
|
|
6107
|
+
/** Format: double */
|
|
6108
|
+
shipping_tax_rate: number;
|
|
6109
|
+
/** Format: double */
|
|
6110
|
+
shipping_tax_amount: number;
|
|
6111
|
+
/** Format: double */
|
|
5419
6112
|
shipping_amount_including_tax: number;
|
|
5420
6113
|
shipping_provider_id: string | null;
|
|
5421
6114
|
shipping_provider_name: string | null;
|
|
@@ -5430,12 +6123,16 @@ interface components$1 {
|
|
|
5430
6123
|
out_for_delivery_date?: string | null;
|
|
5431
6124
|
shipped_date: string | null;
|
|
5432
6125
|
delivered_date: string | null;
|
|
5433
|
-
returned_date: string | null;
|
|
6126
|
+
returned_date: string | null;
|
|
6127
|
+
/** @enum {unknown} */
|
|
5434
6128
|
fulfillment_type: "delivery" | "collect-in-store";
|
|
5435
6129
|
slo: {
|
|
5436
|
-
/** Format: date */
|
|
6130
|
+
/** Format: date */
|
|
6131
|
+
expected_date?: string;
|
|
6132
|
+
/** Format: date */
|
|
5437
6133
|
actual_date?: string;
|
|
5438
|
-
difference?: string;
|
|
6134
|
+
difference?: string;
|
|
6135
|
+
/** @enum {unknown} */
|
|
5439
6136
|
slo_status?: "on-time" | "delay" | "early";
|
|
5440
6137
|
};
|
|
5441
6138
|
cancellation_reason: string | null;
|
|
@@ -5463,9 +6160,11 @@ interface components$1 {
|
|
|
5463
6160
|
sku?: $Read<string>;
|
|
5464
6161
|
quantity: number;
|
|
5465
6162
|
free_quantity?: number;
|
|
5466
|
-
is_free_item?: $Read<boolean>;
|
|
6163
|
+
is_free_item?: $Read<boolean>;
|
|
6164
|
+
/** Format: double */
|
|
5467
6165
|
selling_price?: number;
|
|
5468
|
-
};
|
|
6166
|
+
};
|
|
6167
|
+
/** ShipmentList */
|
|
5469
6168
|
ShipmentList: {
|
|
5470
6169
|
order_number?: string;
|
|
5471
6170
|
sales_channel?: {
|
|
@@ -5473,18 +6172,23 @@ interface components$1 {
|
|
|
5473
6172
|
name?: string;
|
|
5474
6173
|
type?: string;
|
|
5475
6174
|
};
|
|
5476
|
-
} & components$1["schemas"]["ShipmentInfo"];
|
|
6175
|
+
} & components$1["schemas"]["ShipmentInfo"];
|
|
6176
|
+
/** ShipmentPackaging */
|
|
5477
6177
|
ShipmentPackaging: {
|
|
5478
|
-
/** @enum {unknown} */
|
|
6178
|
+
/** @enum {unknown} */
|
|
6179
|
+
package_option?: "Automatic" | "Custom";
|
|
5479
6180
|
boxes_count?: number;
|
|
5480
6181
|
boxes?: components$1["schemas"]["ShipmentBox"][];
|
|
5481
|
-
};
|
|
6182
|
+
};
|
|
6183
|
+
/** ShipmentProgression */
|
|
5482
6184
|
ShipmentProgression: {
|
|
5483
6185
|
status?: components$1["schemas"]["ShipmentStatus"];
|
|
5484
6186
|
is_current?: $Read<boolean>;
|
|
5485
|
-
is_completed?: $Read<boolean>;
|
|
6187
|
+
is_completed?: $Read<boolean>;
|
|
6188
|
+
/** Format: date-time */
|
|
5486
6189
|
completion_date?: string | null;
|
|
5487
|
-
};
|
|
6190
|
+
};
|
|
6191
|
+
/** @enum {unknown} */
|
|
5488
6192
|
ShipmentStatus: "unscheduled" | "schedule_requested" | "scheduled" | "packed" | "shipped" | "in_transit" | "out_for_delivery" | "delivery_attempted" | "undelivered" | "return_to_origin" | "delivered" | "cancelled" | "lost" | "sent_to_store" | "processing" | "ready_to_collect";
|
|
5489
6193
|
/**
|
|
5490
6194
|
* UpiPayment
|
|
@@ -5492,7 +6196,8 @@ interface components$1 {
|
|
|
5492
6196
|
*/
|
|
5493
6197
|
UpiPayment: components$1["schemas"]["OrderPaymentInfo"] & {
|
|
5494
6198
|
upi_id?: string;
|
|
5495
|
-
};
|
|
6199
|
+
};
|
|
6200
|
+
/** WalletPayment */
|
|
5496
6201
|
WalletPayment: components$1["schemas"]["OrderPaymentInfo"] & {
|
|
5497
6202
|
wallet_name?: string;
|
|
5498
6203
|
};
|
|
@@ -5506,9 +6211,13 @@ interface components$1 {
|
|
|
5506
6211
|
* 4) If 'can_receive_stock' is false then 'can_ship_parcel' and 'can_collect' fields should be false.
|
|
5507
6212
|
*/
|
|
5508
6213
|
Warehouse: {
|
|
5509
|
-
/** @description warehouse id */
|
|
5510
|
-
|
|
5511
|
-
|
|
6214
|
+
/** @description warehouse id */
|
|
6215
|
+
id?: $Read<string>;
|
|
6216
|
+
/** @description legal name */
|
|
6217
|
+
name: string;
|
|
6218
|
+
/** @enum {unknown} */
|
|
6219
|
+
warehouse_type: "retail-store" | "distribution-center";
|
|
6220
|
+
/** @default true */
|
|
5512
6221
|
active: boolean;
|
|
5513
6222
|
gstin?: string | null;
|
|
5514
6223
|
city: string;
|
|
@@ -5517,8 +6226,10 @@ interface components$1 {
|
|
|
5517
6226
|
landmark?: string | null;
|
|
5518
6227
|
pincode: string;
|
|
5519
6228
|
state: string;
|
|
5520
|
-
country: string;
|
|
5521
|
-
|
|
6229
|
+
country: string;
|
|
6230
|
+
/** @default +91 */
|
|
6231
|
+
country_code: string;
|
|
6232
|
+
/** @description 10 digit number without country code. */
|
|
5522
6233
|
contact_phone: number;
|
|
5523
6234
|
contact_email: string;
|
|
5524
6235
|
is_default?: boolean;
|
|
@@ -5526,12 +6237,15 @@ interface components$1 {
|
|
|
5526
6237
|
seller_warehouse_id?: string | null;
|
|
5527
6238
|
can_receive_stock: boolean;
|
|
5528
6239
|
can_ship_parcel: boolean;
|
|
5529
|
-
can_collect: boolean;
|
|
6240
|
+
can_collect: boolean;
|
|
6241
|
+
/** @description this field will be always true for warehouse_type = retail-store. */
|
|
5530
6242
|
is_checkout_point: boolean;
|
|
5531
6243
|
accepts_returns: boolean;
|
|
5532
|
-
opening_hours?: components$1["schemas"]["OpeningHours"];
|
|
6244
|
+
opening_hours?: components$1["schemas"]["OpeningHours"];
|
|
6245
|
+
/** @description channels associated with the warehouse */
|
|
5533
6246
|
channels?: $Read<components$1["schemas"]["SalesChannel"][]>;
|
|
5534
|
-
};
|
|
6247
|
+
};
|
|
6248
|
+
/** WarehouseBasicDetail */
|
|
5535
6249
|
WarehouseBasicDetail: {
|
|
5536
6250
|
id?: string;
|
|
5537
6251
|
name?: string;
|
|
@@ -5540,10 +6254,13 @@ interface components$1 {
|
|
|
5540
6254
|
city?: string;
|
|
5541
6255
|
state?: string;
|
|
5542
6256
|
is_default?: boolean;
|
|
5543
|
-
};
|
|
6257
|
+
};
|
|
6258
|
+
/** WarehouseWiseInventory */
|
|
5544
6259
|
WarehouseWiseInventory: {
|
|
5545
|
-
lot_batch?: string;
|
|
5546
|
-
|
|
6260
|
+
lot_batch?: string;
|
|
6261
|
+
/** Format: date */
|
|
6262
|
+
mfg_date?: string;
|
|
6263
|
+
/** Format: date */
|
|
5547
6264
|
exp_date?: string;
|
|
5548
6265
|
manufacturer?: string;
|
|
5549
6266
|
warehouse_id?: string;
|
|
@@ -5557,11 +6274,17 @@ interface components$1 {
|
|
|
5557
6274
|
};
|
|
5558
6275
|
responses: never;
|
|
5559
6276
|
parameters: {
|
|
5560
|
-
/** @description JSON object */
|
|
5561
|
-
|
|
5562
|
-
|
|
5563
|
-
|
|
5564
|
-
|
|
6277
|
+
/** @description JSON object */
|
|
6278
|
+
columnBasedFilters: string;
|
|
6279
|
+
/** @description view to be used to display the data */
|
|
6280
|
+
dataView: "warehouse";
|
|
6281
|
+
/** @description no of rows per page */
|
|
6282
|
+
pageLimit: number;
|
|
6283
|
+
/** @description page number of pagination list */
|
|
6284
|
+
pageNumber: number;
|
|
6285
|
+
/** @description search keyword */
|
|
6286
|
+
searchKeyword: string;
|
|
6287
|
+
/** @description JSON string format: {"field1":"asc", "field2":"desc"} */
|
|
5565
6288
|
sortByOptions: string;
|
|
5566
6289
|
};
|
|
5567
6290
|
requestBodies: never;
|
|
@@ -5572,10 +6295,15 @@ interface operations$1 {
|
|
|
5572
6295
|
"pos-list-inventory": {
|
|
5573
6296
|
parameters: {
|
|
5574
6297
|
query?: {
|
|
5575
|
-
/** @description view to be used to display the data */
|
|
5576
|
-
|
|
5577
|
-
|
|
5578
|
-
|
|
6298
|
+
/** @description view to be used to display the data */
|
|
6299
|
+
view?: components$1["parameters"]["dataView"];
|
|
6300
|
+
/** @description page number of pagination list */
|
|
6301
|
+
page?: components$1["parameters"]["pageNumber"];
|
|
6302
|
+
/** @description no of rows per page */
|
|
6303
|
+
limit?: components$1["parameters"]["pageLimit"];
|
|
6304
|
+
/** @description JSON string format: {"field1":"asc", "field2":"desc"} */
|
|
6305
|
+
sort_by?: components$1["parameters"]["sortByOptions"];
|
|
6306
|
+
/** @description JSON object */
|
|
5579
6307
|
filters?: components$1["parameters"]["columnBasedFilters"];
|
|
5580
6308
|
};
|
|
5581
6309
|
header?: never;
|
|
@@ -5584,7 +6312,8 @@ interface operations$1 {
|
|
|
5584
6312
|
};
|
|
5585
6313
|
requestBody?: never;
|
|
5586
6314
|
responses: {
|
|
5587
|
-
/** @description OK */
|
|
6315
|
+
/** @description OK */
|
|
6316
|
+
200: {
|
|
5588
6317
|
headers: {
|
|
5589
6318
|
[name: string]: unknown;
|
|
5590
6319
|
};
|
|
@@ -5604,9 +6333,13 @@ interface operations$1 {
|
|
|
5604
6333
|
"pos-list-inventory-activity": {
|
|
5605
6334
|
parameters: {
|
|
5606
6335
|
query?: {
|
|
5607
|
-
/** @description page number of pagination list */
|
|
5608
|
-
|
|
5609
|
-
|
|
6336
|
+
/** @description page number of pagination list */
|
|
6337
|
+
page?: components$1["parameters"]["pageNumber"];
|
|
6338
|
+
/** @description no of rows per page */
|
|
6339
|
+
limit?: components$1["parameters"]["pageLimit"];
|
|
6340
|
+
/** @description JSON string format: {"field1":"asc", "field2":"desc"} */
|
|
6341
|
+
sort_by?: components$1["parameters"]["sortByOptions"];
|
|
6342
|
+
/** @description JSON object */
|
|
5610
6343
|
filters?: components$1["parameters"]["columnBasedFilters"];
|
|
5611
6344
|
};
|
|
5612
6345
|
header?: never;
|
|
@@ -5615,7 +6348,8 @@ interface operations$1 {
|
|
|
5615
6348
|
};
|
|
5616
6349
|
requestBody?: never;
|
|
5617
6350
|
responses: {
|
|
5618
|
-
/** @description OK */
|
|
6351
|
+
/** @description OK */
|
|
6352
|
+
200: {
|
|
5619
6353
|
headers: {
|
|
5620
6354
|
[name: string]: unknown;
|
|
5621
6355
|
};
|
|
@@ -5635,8 +6369,11 @@ interface operations$1 {
|
|
|
5635
6369
|
"pos-list-inventory-detail": {
|
|
5636
6370
|
parameters: {
|
|
5637
6371
|
query: {
|
|
5638
|
-
/** @description lot batch of selected productor or variant. */
|
|
5639
|
-
|
|
6372
|
+
/** @description lot batch of selected productor or variant. */
|
|
6373
|
+
lot_batch?: string;
|
|
6374
|
+
/** @description Product Id */
|
|
6375
|
+
product_id: string;
|
|
6376
|
+
/** @description Variant Id */
|
|
5640
6377
|
variant_id?: string;
|
|
5641
6378
|
};
|
|
5642
6379
|
header?: never;
|
|
@@ -5645,7 +6382,8 @@ interface operations$1 {
|
|
|
5645
6382
|
};
|
|
5646
6383
|
requestBody?: never;
|
|
5647
6384
|
responses: {
|
|
5648
|
-
/** @description OK */
|
|
6385
|
+
/** @description OK */
|
|
6386
|
+
200: {
|
|
5649
6387
|
headers: {
|
|
5650
6388
|
[name: string]: unknown;
|
|
5651
6389
|
};
|
|
@@ -5664,10 +6402,15 @@ interface operations$1 {
|
|
|
5664
6402
|
"pos-list-customers": {
|
|
5665
6403
|
parameters: {
|
|
5666
6404
|
query?: {
|
|
5667
|
-
/** @description page number of pagination list */
|
|
5668
|
-
|
|
5669
|
-
|
|
5670
|
-
|
|
6405
|
+
/** @description page number of pagination list */
|
|
6406
|
+
page?: components$1["parameters"]["pageNumber"];
|
|
6407
|
+
/** @description no of rows per page */
|
|
6408
|
+
limit?: components$1["parameters"]["pageLimit"];
|
|
6409
|
+
/** @description JSON object */
|
|
6410
|
+
filters?: components$1["parameters"]["columnBasedFilters"];
|
|
6411
|
+
/** @description JSON string format: {"field1":"asc", "field2":"desc"} */
|
|
6412
|
+
sort_by?: components$1["parameters"]["sortByOptions"];
|
|
6413
|
+
/** @description search keyword */
|
|
5671
6414
|
search?: components$1["parameters"]["searchKeyword"];
|
|
5672
6415
|
};
|
|
5673
6416
|
header?: never;
|
|
@@ -5676,7 +6419,8 @@ interface operations$1 {
|
|
|
5676
6419
|
};
|
|
5677
6420
|
requestBody?: never;
|
|
5678
6421
|
responses: {
|
|
5679
|
-
/** @description OK */
|
|
6422
|
+
/** @description OK */
|
|
6423
|
+
200: {
|
|
5680
6424
|
headers: {
|
|
5681
6425
|
[name: string]: unknown;
|
|
5682
6426
|
};
|
|
@@ -5698,13 +6442,15 @@ interface operations$1 {
|
|
|
5698
6442
|
query?: never;
|
|
5699
6443
|
header?: never;
|
|
5700
6444
|
path: {
|
|
5701
|
-
/** @description Customer Id */
|
|
6445
|
+
/** @description Customer Id */
|
|
6446
|
+
id: string;
|
|
5702
6447
|
};
|
|
5703
6448
|
cookie?: never;
|
|
5704
6449
|
};
|
|
5705
6450
|
requestBody?: never;
|
|
5706
6451
|
responses: {
|
|
5707
|
-
/** @description OK */
|
|
6452
|
+
/** @description OK */
|
|
6453
|
+
200: {
|
|
5708
6454
|
headers: {
|
|
5709
6455
|
[name: string]: unknown;
|
|
5710
6456
|
};
|
|
@@ -5723,10 +6469,15 @@ interface operations$1 {
|
|
|
5723
6469
|
"pos-list-orders": {
|
|
5724
6470
|
parameters: {
|
|
5725
6471
|
query?: {
|
|
5726
|
-
/** @description page number of pagination list */
|
|
5727
|
-
|
|
5728
|
-
|
|
5729
|
-
|
|
6472
|
+
/** @description page number of pagination list */
|
|
6473
|
+
page?: components$1["parameters"]["pageNumber"];
|
|
6474
|
+
/** @description no of rows per page */
|
|
6475
|
+
limit?: components$1["parameters"]["pageLimit"];
|
|
6476
|
+
/** @description JSON object */
|
|
6477
|
+
filters?: components$1["parameters"]["columnBasedFilters"];
|
|
6478
|
+
/** @description JSON string format: {"field1":"asc", "field2":"desc"} */
|
|
6479
|
+
sort_by?: components$1["parameters"]["sortByOptions"];
|
|
6480
|
+
/** @description search keyword */
|
|
5730
6481
|
search?: components$1["parameters"]["searchKeyword"];
|
|
5731
6482
|
};
|
|
5732
6483
|
header?: never;
|
|
@@ -5735,7 +6486,8 @@ interface operations$1 {
|
|
|
5735
6486
|
};
|
|
5736
6487
|
requestBody?: never;
|
|
5737
6488
|
responses: {
|
|
5738
|
-
/** @description OK */
|
|
6489
|
+
/** @description OK */
|
|
6490
|
+
200: {
|
|
5739
6491
|
headers: {
|
|
5740
6492
|
[name: string]: unknown;
|
|
5741
6493
|
};
|
|
@@ -5757,13 +6509,15 @@ interface operations$1 {
|
|
|
5757
6509
|
query?: never;
|
|
5758
6510
|
header?: never;
|
|
5759
6511
|
path: {
|
|
5760
|
-
/** @description order number */
|
|
6512
|
+
/** @description order number */
|
|
6513
|
+
order_number: string;
|
|
5761
6514
|
};
|
|
5762
6515
|
cookie?: never;
|
|
5763
6516
|
};
|
|
5764
6517
|
requestBody?: never;
|
|
5765
6518
|
responses: {
|
|
5766
|
-
/** @description OK */
|
|
6519
|
+
/** @description OK */
|
|
6520
|
+
200: {
|
|
5767
6521
|
headers: {
|
|
5768
6522
|
[name: string]: unknown;
|
|
5769
6523
|
};
|
|
@@ -5784,13 +6538,15 @@ interface operations$1 {
|
|
|
5784
6538
|
query?: never;
|
|
5785
6539
|
header?: never;
|
|
5786
6540
|
path: {
|
|
5787
|
-
/** @description order number */
|
|
6541
|
+
/** @description order number */
|
|
6542
|
+
order_number: string;
|
|
5788
6543
|
};
|
|
5789
6544
|
cookie?: never;
|
|
5790
6545
|
};
|
|
5791
6546
|
requestBody?: never;
|
|
5792
6547
|
responses: {
|
|
5793
|
-
/** @description OK */
|
|
6548
|
+
/** @description OK */
|
|
6549
|
+
200: {
|
|
5794
6550
|
headers: {
|
|
5795
6551
|
[name: string]: unknown;
|
|
5796
6552
|
};
|
|
@@ -5812,13 +6568,15 @@ interface operations$1 {
|
|
|
5812
6568
|
query?: never;
|
|
5813
6569
|
header?: never;
|
|
5814
6570
|
path: {
|
|
5815
|
-
/** @description Order number */
|
|
6571
|
+
/** @description Order number */
|
|
6572
|
+
order_number: string;
|
|
5816
6573
|
};
|
|
5817
6574
|
cookie?: never;
|
|
5818
6575
|
};
|
|
5819
6576
|
requestBody?: never;
|
|
5820
6577
|
responses: {
|
|
5821
|
-
/** @description OK */
|
|
6578
|
+
/** @description OK */
|
|
6579
|
+
200: {
|
|
5822
6580
|
headers: {
|
|
5823
6581
|
[name: string]: unknown;
|
|
5824
6582
|
};
|
|
@@ -5837,17 +6595,20 @@ interface operations$1 {
|
|
|
5837
6595
|
"pos-get-order-invoice": {
|
|
5838
6596
|
parameters: {
|
|
5839
6597
|
query?: {
|
|
5840
|
-
/** @description Response data format */
|
|
6598
|
+
/** @description Response data format */
|
|
6599
|
+
format?: "json" | "pdf";
|
|
5841
6600
|
};
|
|
5842
6601
|
header?: never;
|
|
5843
6602
|
path: {
|
|
5844
|
-
/** @description order number */
|
|
6603
|
+
/** @description order number */
|
|
6604
|
+
order_number: string;
|
|
5845
6605
|
};
|
|
5846
6606
|
cookie?: never;
|
|
5847
6607
|
};
|
|
5848
6608
|
requestBody?: never;
|
|
5849
6609
|
responses: {
|
|
5850
|
-
/** @description OK */
|
|
6610
|
+
/** @description OK */
|
|
6611
|
+
200: {
|
|
5851
6612
|
headers: {
|
|
5852
6613
|
[name: string]: unknown;
|
|
5853
6614
|
};
|
|
@@ -5867,17 +6628,20 @@ interface operations$1 {
|
|
|
5867
6628
|
"pos-get-order-receipt": {
|
|
5868
6629
|
parameters: {
|
|
5869
6630
|
query?: {
|
|
5870
|
-
/** @description Response data format */
|
|
6631
|
+
/** @description Response data format */
|
|
6632
|
+
format?: "json" | "pdf";
|
|
5871
6633
|
};
|
|
5872
6634
|
header?: never;
|
|
5873
6635
|
path: {
|
|
5874
|
-
/** @description order number */
|
|
6636
|
+
/** @description order number */
|
|
6637
|
+
order_number: string;
|
|
5875
6638
|
};
|
|
5876
6639
|
cookie?: never;
|
|
5877
6640
|
};
|
|
5878
6641
|
requestBody?: never;
|
|
5879
6642
|
responses: {
|
|
5880
|
-
/** @description OK */
|
|
6643
|
+
/** @description OK */
|
|
6644
|
+
200: {
|
|
5881
6645
|
headers: {
|
|
5882
6646
|
[name: string]: unknown;
|
|
5883
6647
|
};
|
|
@@ -5899,13 +6663,15 @@ interface operations$1 {
|
|
|
5899
6663
|
query?: never;
|
|
5900
6664
|
header?: never;
|
|
5901
6665
|
path: {
|
|
5902
|
-
/** @description order number */
|
|
6666
|
+
/** @description order number */
|
|
6667
|
+
order_number: string;
|
|
5903
6668
|
};
|
|
5904
6669
|
cookie?: never;
|
|
5905
6670
|
};
|
|
5906
6671
|
requestBody?: never;
|
|
5907
6672
|
responses: {
|
|
5908
|
-
/** @description OK */
|
|
6673
|
+
/** @description OK */
|
|
6674
|
+
200: {
|
|
5909
6675
|
headers: {
|
|
5910
6676
|
[name: string]: unknown;
|
|
5911
6677
|
};
|
|
@@ -5924,10 +6690,15 @@ interface operations$1 {
|
|
|
5924
6690
|
"pos-list-shipments": {
|
|
5925
6691
|
parameters: {
|
|
5926
6692
|
query?: {
|
|
5927
|
-
/** @description page number of pagination list */
|
|
5928
|
-
|
|
5929
|
-
|
|
5930
|
-
|
|
6693
|
+
/** @description page number of pagination list */
|
|
6694
|
+
page?: components$1["parameters"]["pageNumber"];
|
|
6695
|
+
/** @description no of rows per page */
|
|
6696
|
+
limit?: components$1["parameters"]["pageLimit"];
|
|
6697
|
+
/** @description JSON object */
|
|
6698
|
+
filters?: components$1["parameters"]["columnBasedFilters"];
|
|
6699
|
+
/** @description JSON string format: {"field1":"asc", "field2":"desc"} */
|
|
6700
|
+
sort_by?: components$1["parameters"]["sortByOptions"];
|
|
6701
|
+
/** @description search keyword */
|
|
5931
6702
|
search?: components$1["parameters"]["searchKeyword"];
|
|
5932
6703
|
};
|
|
5933
6704
|
header?: never;
|
|
@@ -5936,7 +6707,8 @@ interface operations$1 {
|
|
|
5936
6707
|
};
|
|
5937
6708
|
requestBody?: never;
|
|
5938
6709
|
responses: {
|
|
5939
|
-
/** @description OK */
|
|
6710
|
+
/** @description OK */
|
|
6711
|
+
200: {
|
|
5940
6712
|
headers: {
|
|
5941
6713
|
[name: string]: unknown;
|
|
5942
6714
|
};
|
|
@@ -5958,7 +6730,8 @@ interface operations$1 {
|
|
|
5958
6730
|
query?: never;
|
|
5959
6731
|
header?: never;
|
|
5960
6732
|
path: {
|
|
5961
|
-
/** @description Order Number */
|
|
6733
|
+
/** @description Order Number */
|
|
6734
|
+
order_number: string;
|
|
5962
6735
|
};
|
|
5963
6736
|
cookie?: never;
|
|
5964
6737
|
};
|
|
@@ -5967,16 +6740,20 @@ interface operations$1 {
|
|
|
5967
6740
|
"application/json": {
|
|
5968
6741
|
items: {
|
|
5969
6742
|
sku: string;
|
|
5970
|
-
quantity: number;
|
|
6743
|
+
quantity: number;
|
|
6744
|
+
/** @default 0 */
|
|
5971
6745
|
free_quantity?: number;
|
|
5972
|
-
}[];
|
|
5973
|
-
|
|
6746
|
+
}[];
|
|
6747
|
+
/** @enum {unknown} */
|
|
6748
|
+
payment_method: "original-payment-mode" | "bank-transfer";
|
|
6749
|
+
/** @description required if payment_method = bank-transfer */
|
|
5974
6750
|
bank_account_id?: string | null;
|
|
5975
6751
|
};
|
|
5976
6752
|
};
|
|
5977
6753
|
};
|
|
5978
6754
|
responses: {
|
|
5979
|
-
/** @description OK */
|
|
6755
|
+
/** @description OK */
|
|
6756
|
+
200: {
|
|
5980
6757
|
headers: {
|
|
5981
6758
|
[name: string]: unknown;
|
|
5982
6759
|
};
|
|
@@ -5994,13 +6771,15 @@ interface operations$1 {
|
|
|
5994
6771
|
query?: never;
|
|
5995
6772
|
header?: never;
|
|
5996
6773
|
path: {
|
|
5997
|
-
/** @description Shipment reference number */
|
|
6774
|
+
/** @description Shipment reference number */
|
|
6775
|
+
reference_number: string;
|
|
5998
6776
|
};
|
|
5999
6777
|
cookie?: never;
|
|
6000
6778
|
};
|
|
6001
6779
|
requestBody?: never;
|
|
6002
6780
|
responses: {
|
|
6003
|
-
/** @description OK */
|
|
6781
|
+
/** @description OK */
|
|
6782
|
+
200: {
|
|
6004
6783
|
headers: {
|
|
6005
6784
|
[name: string]: unknown;
|
|
6006
6785
|
};
|
|
@@ -6021,13 +6800,15 @@ interface operations$1 {
|
|
|
6021
6800
|
query?: never;
|
|
6022
6801
|
header?: never;
|
|
6023
6802
|
path: {
|
|
6024
|
-
/** @description Shipment reference number */
|
|
6803
|
+
/** @description Shipment reference number */
|
|
6804
|
+
reference_number: string;
|
|
6025
6805
|
};
|
|
6026
6806
|
cookie?: never;
|
|
6027
6807
|
};
|
|
6028
6808
|
requestBody?: never;
|
|
6029
6809
|
responses: {
|
|
6030
|
-
/** @description OK */
|
|
6810
|
+
/** @description OK */
|
|
6811
|
+
200: {
|
|
6031
6812
|
headers: {
|
|
6032
6813
|
[name: string]: unknown;
|
|
6033
6814
|
};
|
|
@@ -6047,17 +6828,20 @@ interface operations$1 {
|
|
|
6047
6828
|
"pos-get-shipment-invoice": {
|
|
6048
6829
|
parameters: {
|
|
6049
6830
|
query?: {
|
|
6050
|
-
/** @description Response data format */
|
|
6831
|
+
/** @description Response data format */
|
|
6832
|
+
format?: "json" | "pdf";
|
|
6051
6833
|
};
|
|
6052
6834
|
header?: never;
|
|
6053
6835
|
path: {
|
|
6054
|
-
/** @description Shipment reference number */
|
|
6836
|
+
/** @description Shipment reference number */
|
|
6837
|
+
reference_number: string;
|
|
6055
6838
|
};
|
|
6056
6839
|
cookie?: never;
|
|
6057
6840
|
};
|
|
6058
6841
|
requestBody?: never;
|
|
6059
6842
|
responses: {
|
|
6060
|
-
/** @description OK */
|
|
6843
|
+
/** @description OK */
|
|
6844
|
+
200: {
|
|
6061
6845
|
headers: {
|
|
6062
6846
|
[name: string]: unknown;
|
|
6063
6847
|
};
|
|
@@ -6079,7 +6863,8 @@ interface operations$1 {
|
|
|
6079
6863
|
query?: never;
|
|
6080
6864
|
header?: never;
|
|
6081
6865
|
path: {
|
|
6082
|
-
/** @description Shipment reference number */
|
|
6866
|
+
/** @description Shipment reference number */
|
|
6867
|
+
reference_number: string;
|
|
6083
6868
|
};
|
|
6084
6869
|
cookie?: never;
|
|
6085
6870
|
};
|
|
@@ -6092,16 +6877,21 @@ interface operations$1 {
|
|
|
6092
6877
|
courier_company_name?: string;
|
|
6093
6878
|
shipping_label_url?: string;
|
|
6094
6879
|
tracking_url?: string;
|
|
6095
|
-
manual_shipping_charges?: number;
|
|
6096
|
-
|
|
6097
|
-
|
|
6098
|
-
|
|
6880
|
+
manual_shipping_charges?: number;
|
|
6881
|
+
/** Format: date-time */
|
|
6882
|
+
eta_delivery?: string;
|
|
6883
|
+
/** Format: date-time */
|
|
6884
|
+
shipped_date?: string;
|
|
6885
|
+
/** Format: date-time */
|
|
6886
|
+
out_for_delivery_date?: string;
|
|
6887
|
+
/** Format: date-time */
|
|
6099
6888
|
delivered_date?: string;
|
|
6100
6889
|
};
|
|
6101
6890
|
};
|
|
6102
6891
|
};
|
|
6103
6892
|
responses: {
|
|
6104
|
-
/** @description OK */
|
|
6893
|
+
/** @description OK */
|
|
6894
|
+
200: {
|
|
6105
6895
|
headers: {
|
|
6106
6896
|
[name: string]: unknown;
|
|
6107
6897
|
};
|
|
@@ -6145,7 +6935,8 @@ type ApiResult<T> = {
|
|
|
6145
6935
|
data: null;
|
|
6146
6936
|
error: ApiErrorResponse;
|
|
6147
6937
|
response: Response;
|
|
6148
|
-
};
|
|
6938
|
+
};
|
|
6939
|
+
//#endregion
|
|
6149
6940
|
//#region src/types/logger.d.ts
|
|
6150
6941
|
/**
|
|
6151
6942
|
* Logger-related types for Commerce Engine SDKs
|
|
@@ -6155,7 +6946,8 @@ type ApiResult<T> = {
|
|
|
6155
6946
|
*/
|
|
6156
6947
|
interface DebugLoggerFn {
|
|
6157
6948
|
(level: "info" | "warn" | "error", message: string, data?: any): void;
|
|
6158
|
-
}
|
|
6949
|
+
}
|
|
6950
|
+
//#endregion
|
|
6159
6951
|
//#region src/types/config.d.ts
|
|
6160
6952
|
/**
|
|
6161
6953
|
* Base SDK configuration options for any OpenAPI-based SDK
|
|
@@ -6199,7 +6991,8 @@ interface HeaderConfig<T extends Record<string, any>> {
|
|
|
6199
6991
|
* Maps SDK parameter names to HTTP header names
|
|
6200
6992
|
*/
|
|
6201
6993
|
transformations?: Record<keyof T, string>;
|
|
6202
|
-
}
|
|
6994
|
+
}
|
|
6995
|
+
//#endregion
|
|
6203
6996
|
//#region src/base-client.d.ts
|
|
6204
6997
|
/**
|
|
6205
6998
|
* Generic base API client that all Commerce Engine SDKs can extend
|
|
@@ -6269,7 +7062,8 @@ declare class BaseAPIClient<TPaths extends Record<string, any>, THeaders extends
|
|
|
6269
7062
|
* @returns Current default headers
|
|
6270
7063
|
*/
|
|
6271
7064
|
getDefaultHeaders(): THeaders | undefined;
|
|
6272
|
-
}
|
|
7065
|
+
}
|
|
7066
|
+
//#endregion
|
|
6273
7067
|
//#region src/utils/url.d.ts
|
|
6274
7068
|
/**
|
|
6275
7069
|
* Generic URL utility functions for any SDK
|
|
@@ -6278,7 +7072,8 @@ declare class BaseAPIClient<TPaths extends Record<string, any>, THeaders extends
|
|
|
6278
7072
|
* Extract pathname from URL
|
|
6279
7073
|
* Useful for middleware that needs to inspect request paths
|
|
6280
7074
|
*/
|
|
6281
|
-
declare function getPathnameFromUrl(url: string): string;
|
|
7075
|
+
declare function getPathnameFromUrl(url: string): string;
|
|
7076
|
+
//#endregion
|
|
6282
7077
|
//#region src/utils/response.d.ts
|
|
6283
7078
|
/**
|
|
6284
7079
|
* Execute a request and handle the response consistently
|
|
@@ -6295,7 +7090,8 @@ declare function executeRequest<T, M = string, S = boolean>(apiCall: () => Promi
|
|
|
6295
7090
|
};
|
|
6296
7091
|
error?: ApiErrorResponse;
|
|
6297
7092
|
response: Response;
|
|
6298
|
-
}>): Promise<ApiResult<T>>;
|
|
7093
|
+
}>): Promise<ApiResult<T>>;
|
|
7094
|
+
//#endregion
|
|
6299
7095
|
//#region src/middleware/debug.d.ts
|
|
6300
7096
|
/**
|
|
6301
7097
|
* Response utilities for debugging and working with Response objects
|
|
@@ -6386,7 +7182,8 @@ declare function extractRequestBody(request: Request): Promise<any>;
|
|
|
6386
7182
|
* Create debug middleware for openapi-fetch (internal use)
|
|
6387
7183
|
* Enhanced version that combines original functionality with duration tracking
|
|
6388
7184
|
*/
|
|
6389
|
-
declare function createDebugMiddleware(logger?: DebugLoggerFn): Middleware;
|
|
7185
|
+
declare function createDebugMiddleware(logger?: DebugLoggerFn): Middleware;
|
|
7186
|
+
//#endregion
|
|
6390
7187
|
//#region src/middleware/timeout.d.ts
|
|
6391
7188
|
/**
|
|
6392
7189
|
* Timeout middleware for Commerce Engine SDKs
|
|
@@ -6399,26 +7196,19 @@ declare function createDebugMiddleware(logger?: DebugLoggerFn): Middleware; //#e
|
|
|
6399
7196
|
* @returns Middleware object with onRequest handler
|
|
6400
7197
|
*/
|
|
6401
7198
|
declare function createTimeoutMiddleware(timeoutMs: number): {
|
|
6402
|
-
onRequest: ({
|
|
6403
|
-
request
|
|
6404
|
-
}: {
|
|
7199
|
+
onRequest: ({ request }: {
|
|
6405
7200
|
request: Request;
|
|
6406
7201
|
}) => Promise<Request>;
|
|
6407
|
-
onResponse: ({
|
|
6408
|
-
request,
|
|
6409
|
-
response
|
|
6410
|
-
}: {
|
|
7202
|
+
onResponse: ({ request, response }: {
|
|
6411
7203
|
request: Request;
|
|
6412
7204
|
response: Response;
|
|
6413
7205
|
}) => Promise<Response>;
|
|
6414
|
-
onError: ({
|
|
6415
|
-
request,
|
|
6416
|
-
error
|
|
6417
|
-
}: {
|
|
7206
|
+
onError: ({ request, error }: {
|
|
6418
7207
|
request: Request;
|
|
6419
7208
|
error: unknown;
|
|
6420
7209
|
}) => Promise<never>;
|
|
6421
|
-
};
|
|
7210
|
+
};
|
|
7211
|
+
//#endregion
|
|
6422
7212
|
//#region src/middleware/headers.d.ts
|
|
6423
7213
|
/**
|
|
6424
7214
|
* Header transformation and merging utilities for Commerce Engine SDKs
|
|
@@ -6450,7 +7240,7 @@ declare function transformHeaders(headers: Record<string, any>, transformations:
|
|
|
6450
7240
|
* @param transformations - Mapping for header name transformations
|
|
6451
7241
|
* @returns Merged headers object with transformations applied
|
|
6452
7242
|
*/
|
|
6453
|
-
declare function mergeAndTransformHeaders<T extends Record<string, any> = Record<string, any>>(defaultHeaders?: Record<string, any>, methodHeaders?: T, transformations?: Record<string, string>): T;
|
|
7243
|
+
declare function mergeAndTransformHeaders<T extends Record<string, any> = Record<string, any>>(defaultHeaders?: Record<string, any>, methodHeaders?: T, transformations?: Record<string, string>): T;
|
|
6454
7244
|
//#endregion
|
|
6455
7245
|
//#region src/lib/client.d.ts
|
|
6456
7246
|
type CombinedPaths = paths & paths$1;
|
|
@@ -8834,5 +9624,5 @@ declare class PosSDK {
|
|
|
8834
9624
|
getTenantId(): Promise<string | null>;
|
|
8835
9625
|
}
|
|
8836
9626
|
//#endregion
|
|
8837
|
-
export { AcceleratedRewardCouponPromotion, AcceleratedRewardRule, AdditionalProductDetails, ApiErrorResponse, ApiResult, ApplicableCoupon, ApplicablePromotion, AppliedCoupon, AppliedPromotion, AssociatedOption, AutoScaleBasedOnAmount, AutoScaleBasedOnQuantity, BankTransfer, BaseAPIClient, BaseSDKOptions, BooleanAttribute, BrowserTokenStorage, BuyXGetYCouponPromotion, BuyXGetYRule, BuyXGetYRuleBasedOnAmount, BuyXGetYRuleBasedOnQuantity, CardPayment, Cart, CartBasedFulfillmentOptionInput, CartItem, CartShipment, Category, ClaimPosDeviceContent, ClaimPosDevicePathParams, ClaimPosDeviceResponse, CollectInStore, CollectInStoreAddress, CollectInStoreFulfillment, CollectInStoreFulfillmentInput, ColorAttribute, ColorOption, Coupon, CouponPromotionCommonDetail, CouponType, CreatePosOrderBody, CreatePosOrderContent, CreatePosOrderResponse, Currency, CustomSlabsBasedOnAmount, CustomSlabsBasedOnQuantity, CustomerAddress, CustomerAddressInput, DateAttribute, DebugLogger, DebugLoggerFn, DeliveryFulfillment, DeliveryFulfillmentInput, DeliveryOption, DiscountBasedPromotion, DiscountCouponPromotion, DiscountRule, Environment, FixedAmountDiscountRule, FixedPriceCouponPromotion, FixedPricePromotion, FixedPriceRule, FixedPriceRuleBasedAmount, FixedPriceRuleBasedQuantity, FreeGoodCouponPromotion, FreeGoodsPromotion, FreeGoodsRule, FreeShipingCouponPromotion, FulfillmentItem, FulfillmentItemInput, FulfillmentPreference, FulfillmentPreferenceInput, GetPosFulfillmentOptionsBody, GetPosFulfillmentOptionsContent, GetPosFulfillmentOptionsResponse, GetPosUserContent, GetPosUserPathParams, GetPosUserResponse, HeaderConfig, InapplicableCoupon, InapplicablePromotion, Item, ListPosDevicesContent, ListPosDevicesResponse, ListPosLocationsContent, ListPosLocationsResponse, LoginPosDeviceWithEmailBody, LoginPosDeviceWithEmailContent, LoginPosDeviceWithEmailHeaderParams, LoginPosDeviceWithEmailResponse, LoginPosDeviceWithPhoneBody, LoginPosDeviceWithPhoneContent, LoginPosDeviceWithPhoneHeaderParams, LoginPosDeviceWithPhoneResponse, LoginPosDeviceWithWhatsappBody, LoginPosDeviceWithWhatsappContent, LoginPosDeviceWithWhatsappHeaderParams, LoginPosDeviceWithWhatsappResponse, LogoutFromPosDeviceResponse, LotBatchDetail, MemoryTokenStorage, MultiSelectAttribute, NachPayment, NetbankingPayment, NumberAttribute, Order, OrderDetail, OrderItem, OrderPayment, OrderRefund, OrderShipment, Pagination, PairPosDeviceBody, PairPosDeviceContent, PairPosDeviceResponse, PartialCollectAndDelivery, PartialCollectAndDeliveryInput, PayWithCardInput, PayWithCashInput, PayWithUpiInput, PaymentInfo, PercentageDiscountRule, PosAPIClient, PosApplyCouponBody, PosApplyCouponContent, PosApplyCouponPathParams, PosApplyCouponResponse, PosClient, PosCreateCartAddressBody, PosCreateCartAddressContent, PosCreateCartAddressPathParams, PosCreateCartAddressResponse, PosCreateCartBody, PosCreateCartContent, PosCreateCartResponse, PosDeleteCartPathParams, PosDeleteCartResponse, PosDevice, PosDeviceClaimedUser, PosEvaluateCouponsContent, PosEvaluateCouponsPathParams, PosEvaluateCouponsResponse, PosEvaluatePromotionsContent, PosEvaluatePromotionsPathParams, PosEvaluatePromotionsResponse, PosGetCartContent, PosGetCartPathParams, PosGetCartResponse, PosGetPaymentStatusContent, PosGetPaymentStatusPathParams, PosGetPaymentStatusResponse, PosGetProductDetailContent, PosGetProductDetailHeaderParams, PosGetProductDetailPathParams, PosGetProductDetailQuery, PosGetProductDetailResponse, PosGetUserCartContent, PosGetUserCartPathParams, PosGetUserCartResponse, PosGetVariantDetailContent, PosGetVariantDetailHeaderParams, PosGetVariantDetailPathParams, PosGetVariantDetailQuery, PosGetVariantDetailResponse, PosListCategoriesContent, PosListCategoriesQuery, PosListCategoriesResponse, PosListCouponsContent, PosListCouponsHeaderParams, PosListCouponsResponse, PosListCrosssellProductsContent, PosListCrosssellProductsHeaderParams, PosListCrosssellProductsQuery, PosListCrosssellProductsResponse, PosListProductReviewsContent, PosListProductReviewsPathParams, PosListProductReviewsQuery, PosListProductReviewsResponse, PosListProductVariantsContent, PosListProductVariantsHeaderParams, PosListProductVariantsPathParams, PosListProductVariantsQuery, PosListProductVariantsResponse, PosListProductsContent, PosListProductsHeaderParams, PosListProductsQuery, PosListProductsResponse, PosListPromotionsContent, PosListPromotionsHeaderParams, PosListPromotionsResponse, PosListSimilarProductsContent, PosListSimilarProductsHeaderParams, PosListSimilarProductsQuery, PosListSimilarProductsResponse, PosListSkusContent, PosListSkusHeaderParams, PosListSkusQuery, PosListSkusResponse, PosListUpsellProductsContent, PosListUpsellProductsHeaderParams, PosListUpsellProductsQuery, PosListUpsellProductsResponse, PosLocation, PosRedeemCreditBalanceBody, PosRedeemCreditBalanceContent, PosRedeemCreditBalancePathParams, PosRedeemCreditBalanceResponse, PosRedeemLoyaltyPointsBody, PosRedeemLoyaltyPointsContent, PosRedeemLoyaltyPointsPathParams, PosRedeemLoyaltyPointsResponse, PosRemoveCouponContent, PosRemoveCouponPathParams, PosRemoveCouponResponse, PosRemoveCreditBalanceContent, PosRemoveCreditBalancePathParams, PosRemoveCreditBalanceResponse, PosRemoveLoyaltyPointsContent, PosRemoveLoyaltyPointsPathParams, PosRemoveLoyaltyPointsResponse, PosSDK, PosSDK as default, PosSDKOptions, PosSearchProductsBody, PosSearchProductsContent, PosSearchProductsHeaderParams, PosSearchProductsResponse, PosUpdateCartBody, PosUpdateCartContent, PosUpdateCartPathParams, PosUpdateCartResponse, PosUpdateCustomerWithEmailInput, PosUpdateCustomerWithIdInput, PosUpdateCustomerWithPhoneInput, PosUpdateFulfillmentPreferenceBody, PosUpdateFulfillmentPreferenceContent, PosUpdateFulfillmentPreferencePathParams, PosUpdateFulfillmentPreferenceResponse, PosUser, Product, ProductAttribute, ProductBundleItem, ProductCategory, ProductDetail, ProductImage, ProductPricing, ProductPromotion, ProductReview, ProductShipping, ProductSubscription, ProductVideo, Promotion, PromotionType, type Readable, RefreshPosAccessTokenBody, RefreshPosAccessTokenContent, RefreshPosAccessTokenResponse, ResponseUtils, SearchProductInput, SellerInfo, Seo, ShipmentItem, ShipmentStatus, SingleSelectAttribute, SingleSelectOption, SupportedDefaultHeaders, TextAttribute, type TokenStorage, UnclaimPosDeviceContent, UnclaimPosDevicePathParams, UnclaimPosDeviceResponse, UpdateCartItemInput, UpdatePosCartCustomerBody, UpdatePosCartCustomerContent, UpdatePosCartCustomerPathParams, UpdatePosCartCustomerResponse, UpiPayment, type UserInfo, Variant, VariantDetail, VariantOption, VerifyPosLoginOtpBody, VerifyPosLoginOtpContent, VerifyPosLoginOtpResponse, VolumeBasedCouponPromotion, VolumeBasedPromotion, VolumeBasedRule, WalletPayment, type Writable, type components, createDebugMiddleware, createTimeoutMiddleware, executeRequest, extractRequestBody, getPathnameFromUrl, mergeAndTransformHeaders, mergeHeaders, type operations, type paths, transformHeaders };
|
|
9627
|
+
export { type AcceleratedRewardCouponPromotion, type AcceleratedRewardRule, type AdditionalProductDetails, type ApiErrorResponse, type ApiResult, type ApplicableCoupon, type ApplicablePromotion, type AppliedCoupon, type AppliedPromotion, type AssociatedOption, type AutoScaleBasedOnAmount, type AutoScaleBasedOnQuantity, type BankTransfer, type BaseAPIClient, type BaseSDKOptions, type BooleanAttribute, BrowserTokenStorage, type BuyXGetYCouponPromotion, type BuyXGetYRule, type BuyXGetYRuleBasedOnAmount, type BuyXGetYRuleBasedOnQuantity, type CardPayment, type Cart, type CartBasedFulfillmentOptionInput, type CartItem, type CartShipment, type Category, type ClaimPosDeviceContent, type ClaimPosDevicePathParams, type ClaimPosDeviceResponse, type CollectInStore, type CollectInStoreAddress, type CollectInStoreFulfillment, type CollectInStoreFulfillmentInput, type ColorAttribute, type ColorOption, type Coupon, type CouponPromotionCommonDetail, type CouponType, type CreatePosOrderBody, type CreatePosOrderContent, type CreatePosOrderResponse, type Currency, type CustomSlabsBasedOnAmount, type CustomSlabsBasedOnQuantity, type CustomerAddress, type CustomerAddressInput, type DateAttribute, type DebugLogger, type DebugLoggerFn, type DeliveryFulfillment, type DeliveryFulfillmentInput, type DeliveryOption, type DiscountBasedPromotion, type DiscountCouponPromotion, type DiscountRule, Environment, type FixedAmountDiscountRule, type FixedPriceCouponPromotion, type FixedPricePromotion, type FixedPriceRule, type FixedPriceRuleBasedAmount, type FixedPriceRuleBasedQuantity, type FreeGoodCouponPromotion, type FreeGoodsPromotion, type FreeGoodsRule, type FreeShipingCouponPromotion, type FulfillmentItem, type FulfillmentItemInput, type FulfillmentPreference, type FulfillmentPreferenceInput, type GetPosFulfillmentOptionsBody, type GetPosFulfillmentOptionsContent, type GetPosFulfillmentOptionsResponse, type GetPosUserContent, type GetPosUserPathParams, type GetPosUserResponse, type HeaderConfig, type InapplicableCoupon, type InapplicablePromotion, type Item, type ListPosDevicesContent, type ListPosDevicesResponse, type ListPosLocationsContent, type ListPosLocationsResponse, type LoginPosDeviceWithEmailBody, type LoginPosDeviceWithEmailContent, type LoginPosDeviceWithEmailHeaderParams, type LoginPosDeviceWithEmailResponse, type LoginPosDeviceWithPhoneBody, type LoginPosDeviceWithPhoneContent, type LoginPosDeviceWithPhoneHeaderParams, type LoginPosDeviceWithPhoneResponse, type LoginPosDeviceWithWhatsappBody, type LoginPosDeviceWithWhatsappContent, type LoginPosDeviceWithWhatsappHeaderParams, type LoginPosDeviceWithWhatsappResponse, type LogoutFromPosDeviceResponse, type LotBatchDetail, MemoryTokenStorage, type MultiSelectAttribute, type NachPayment, type NetbankingPayment, type NumberAttribute, type Order, type OrderDetail, type OrderItem, type OrderPayment, type OrderRefund, type OrderShipment, type Pagination, type PairPosDeviceBody, type PairPosDeviceContent, type PairPosDeviceResponse, type PartialCollectAndDelivery, type PartialCollectAndDeliveryInput, type PayWithCardInput, type PayWithCashInput, type PayWithUpiInput, type PaymentInfo, type PercentageDiscountRule, PosAPIClient, type PosApplyCouponBody, type PosApplyCouponContent, type PosApplyCouponPathParams, type PosApplyCouponResponse, PosClient, type PosCreateCartAddressBody, type PosCreateCartAddressContent, type PosCreateCartAddressPathParams, type PosCreateCartAddressResponse, type PosCreateCartBody, type PosCreateCartContent, type PosCreateCartResponse, type PosDeleteCartPathParams, type PosDeleteCartResponse, type PosDevice, type PosDeviceClaimedUser, type PosEvaluateCouponsContent, type PosEvaluateCouponsPathParams, type PosEvaluateCouponsResponse, type PosEvaluatePromotionsContent, type PosEvaluatePromotionsPathParams, type PosEvaluatePromotionsResponse, type PosGetCartContent, type PosGetCartPathParams, type PosGetCartResponse, type PosGetPaymentStatusContent, type PosGetPaymentStatusPathParams, type PosGetPaymentStatusResponse, type PosGetProductDetailContent, type PosGetProductDetailHeaderParams, type PosGetProductDetailPathParams, type PosGetProductDetailQuery, type PosGetProductDetailResponse, type PosGetUserCartContent, type PosGetUserCartPathParams, type PosGetUserCartResponse, type PosGetVariantDetailContent, type PosGetVariantDetailHeaderParams, type PosGetVariantDetailPathParams, type PosGetVariantDetailQuery, type PosGetVariantDetailResponse, type PosListCategoriesContent, type PosListCategoriesQuery, type PosListCategoriesResponse, type PosListCouponsContent, type PosListCouponsHeaderParams, type PosListCouponsResponse, type PosListCrosssellProductsContent, type PosListCrosssellProductsHeaderParams, type PosListCrosssellProductsQuery, type PosListCrosssellProductsResponse, type PosListProductReviewsContent, type PosListProductReviewsPathParams, type PosListProductReviewsQuery, type PosListProductReviewsResponse, type PosListProductVariantsContent, type PosListProductVariantsHeaderParams, type PosListProductVariantsPathParams, type PosListProductVariantsQuery, type PosListProductVariantsResponse, type PosListProductsContent, type PosListProductsHeaderParams, type PosListProductsQuery, type PosListProductsResponse, type PosListPromotionsContent, type PosListPromotionsHeaderParams, type PosListPromotionsResponse, type PosListSimilarProductsContent, type PosListSimilarProductsHeaderParams, type PosListSimilarProductsQuery, type PosListSimilarProductsResponse, type PosListSkusContent, type PosListSkusHeaderParams, type PosListSkusQuery, type PosListSkusResponse, type PosListUpsellProductsContent, type PosListUpsellProductsHeaderParams, type PosListUpsellProductsQuery, type PosListUpsellProductsResponse, type PosLocation, type PosRedeemCreditBalanceBody, type PosRedeemCreditBalanceContent, type PosRedeemCreditBalancePathParams, type PosRedeemCreditBalanceResponse, type PosRedeemLoyaltyPointsBody, type PosRedeemLoyaltyPointsContent, type PosRedeemLoyaltyPointsPathParams, type PosRedeemLoyaltyPointsResponse, type PosRemoveCouponContent, type PosRemoveCouponPathParams, type PosRemoveCouponResponse, type PosRemoveCreditBalanceContent, type PosRemoveCreditBalancePathParams, type PosRemoveCreditBalanceResponse, type PosRemoveLoyaltyPointsContent, type PosRemoveLoyaltyPointsPathParams, type PosRemoveLoyaltyPointsResponse, PosSDK, PosSDK as default, PosSDKOptions, type PosSearchProductsBody, type PosSearchProductsContent, type PosSearchProductsHeaderParams, type PosSearchProductsResponse, type PosUpdateCartBody, type PosUpdateCartContent, type PosUpdateCartPathParams, type PosUpdateCartResponse, type PosUpdateCustomerWithEmailInput, type PosUpdateCustomerWithIdInput, type PosUpdateCustomerWithPhoneInput, type PosUpdateFulfillmentPreferenceBody, type PosUpdateFulfillmentPreferenceContent, type PosUpdateFulfillmentPreferencePathParams, type PosUpdateFulfillmentPreferenceResponse, type PosUser, type Product, type ProductAttribute, type ProductBundleItem, type ProductCategory, type ProductDetail, type ProductImage, type ProductPricing, type ProductPromotion, type ProductReview, type ProductShipping, type ProductSubscription, type ProductVideo, type Promotion, type PromotionType, type Readable, type RefreshPosAccessTokenBody, type RefreshPosAccessTokenContent, type RefreshPosAccessTokenResponse, ResponseUtils, type SearchProductInput, type SellerInfo, type Seo, type ShipmentItem, type ShipmentStatus, type SingleSelectAttribute, type SingleSelectOption, SupportedDefaultHeaders, type TextAttribute, type TokenStorage, type UnclaimPosDeviceContent, type UnclaimPosDevicePathParams, type UnclaimPosDeviceResponse, type UpdateCartItemInput, type UpdatePosCartCustomerBody, type UpdatePosCartCustomerContent, type UpdatePosCartCustomerPathParams, type UpdatePosCartCustomerResponse, type UpiPayment, type UserInfo, type Variant, type VariantDetail, type VariantOption, type VerifyPosLoginOtpBody, type VerifyPosLoginOtpContent, type VerifyPosLoginOtpResponse, type VolumeBasedCouponPromotion, type VolumeBasedPromotion, type VolumeBasedRule, type WalletPayment, type Writable, type components, type createDebugMiddleware, type createTimeoutMiddleware, type executeRequest, type extractRequestBody, type getPathnameFromUrl, type mergeAndTransformHeaders, type mergeHeaders, type operations, type paths, type transformHeaders };
|
|
8838
9628
|
//# sourceMappingURL=index.d.mts.map
|