@gofynd/fdk-client-javascript 3.3.6 → 3.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +6 -3
- package/sdk/application/Catalog/CatalogApplicationClient.js +24 -5
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +10 -0
- package/sdk/application/Logistic/LogisticApplicationClient.js +44 -0
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +4 -4
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +2 -2
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +5 -0
- package/sdk/partner/Webhook/WebhookPartnerModel.js +2 -0
- package/sdk/platform/Cart/CartPlatformModel.d.ts +193 -1
- package/sdk/platform/Cart/CartPlatformModel.js +123 -0
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +4 -2
- package/sdk/platform/Catalog/CatalogPlatformClient.js +16 -3
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +33 -2
- package/sdk/platform/Catalog/CatalogPlatformModel.js +17 -2
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +5 -0
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +2 -0
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +17 -1
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +15 -0
- package/sdk/platform/Order/OrderPlatformModel.d.ts +20 -1
- package/sdk/platform/Order/OrderPlatformModel.js +22 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +124 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +800 -33
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +139 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +125 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +2 -2
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +8 -2
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +936 -62
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +591 -33
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +12 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +5 -0
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +36 -0
- package/sdk/platform/User/UserPlatformApplicationClient.js +251 -0
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +38 -1
- package/sdk/platform/User/UserPlatformApplicationValidator.js +42 -0
- package/sdk/platform/User/UserPlatformModel.d.ts +430 -10
- package/sdk/platform/User/UserPlatformModel.js +276 -7
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +10 -0
- package/sdk/platform/Webhook/WebhookPlatformModel.js +4 -0
|
@@ -1,4 +1,73 @@
|
|
|
1
1
|
export = ServiceabilityPlatformModel;
|
|
2
|
+
/**
|
|
3
|
+
* @typedef FulfillmentOption
|
|
4
|
+
* @property {string} [name] - Name of the fulfillment option.
|
|
5
|
+
* @property {string} [slug] - Unique identifier for the fulfillment option.
|
|
6
|
+
* @property {number} [company_id] - The unique identifier of the company.
|
|
7
|
+
* @property {string} [application_id] - The unique identifier of the application.
|
|
8
|
+
* @property {string} [description] - Description of the fulfillment option.
|
|
9
|
+
* @property {boolean} [is_default] - Whether this is the default fulfillment option.
|
|
10
|
+
* @property {string} [type] - Type of fulfillment option.
|
|
11
|
+
* @property {string} [status] - Status of the fulfillment option.
|
|
12
|
+
* @property {BusinessUnit[]} [business_unit]
|
|
13
|
+
* @property {FulfillmentStores} [fulfillment_stores]
|
|
14
|
+
* @property {FulfillmentProducts} [products]
|
|
15
|
+
* @property {CourierPartnerSchemes} [cp_schemes]
|
|
16
|
+
* @property {string} [id] - Unique identifier for the fulfillment option.
|
|
17
|
+
*/
|
|
18
|
+
/**
|
|
19
|
+
* @typedef FulfillmentOptionProducts
|
|
20
|
+
* @property {FulfillmentOptionProduct} [items]
|
|
21
|
+
* @property {Page} [page]
|
|
22
|
+
*/
|
|
23
|
+
/**
|
|
24
|
+
* @typedef FulfillmentOptionStores
|
|
25
|
+
* @property {FulfillmentOptionStore[]} [items] - List of stores with their details.
|
|
26
|
+
* @property {Page} [page]
|
|
27
|
+
*/
|
|
28
|
+
/**
|
|
29
|
+
* @typedef FulfillmentOptionBulkValidate
|
|
30
|
+
* @property {string} [store_type] - Type of store related to fulfillment.
|
|
31
|
+
* @property {string} [file_path] - URL of the uploaded file.
|
|
32
|
+
* @property {string} [action] - Action to be performed, such as import.
|
|
33
|
+
* @property {string} [type] - Entity type being processed.
|
|
34
|
+
* @property {string} [fulfillment_option_slug] - Slug representing the
|
|
35
|
+
* fulfillment option.
|
|
36
|
+
* @property {FulfillmentOptionValidate} [request]
|
|
37
|
+
*/
|
|
38
|
+
/**
|
|
39
|
+
* @typedef FulfillmentOptionBulkValidateData
|
|
40
|
+
* @property {string} [request_id] - Unique id generated for bulk operation.
|
|
41
|
+
*/
|
|
42
|
+
/**
|
|
43
|
+
* @typedef FulfillmentOptionBulk
|
|
44
|
+
* @property {string} [file_path] - The URL of file from which data will be imported.
|
|
45
|
+
* @property {string} [type] - Specifies the type of bulk fulfillment request.
|
|
46
|
+
*/
|
|
47
|
+
/**
|
|
48
|
+
* @typedef FulfillmentOptionBulkData
|
|
49
|
+
* @property {string} [request_id] - Unique identifier for the request.
|
|
50
|
+
* @property {FulfillmentOptionValidate} [request]
|
|
51
|
+
* @property {string} [fulfillment_option_slug] - Slug representing the
|
|
52
|
+
* fulfillment option.
|
|
53
|
+
* @property {string} [file_url] - URL of the uploaded file.
|
|
54
|
+
* @property {number} [total] - Total number of records processed.
|
|
55
|
+
* @property {number} [success] - Number of successful records.
|
|
56
|
+
* @property {number} [failed] - Number of failed records.
|
|
57
|
+
* @property {string} [action] - Action performed in the request.
|
|
58
|
+
* @property {string} [updated_at] - Timestamp of the last update.
|
|
59
|
+
* @property {string} [updated_by] - Identifier of the user who updated the request.
|
|
60
|
+
* @property {string} [type] - Type of the bulk import process.
|
|
61
|
+
* @property {number} [company_id] - The unique identifier of the company.
|
|
62
|
+
* @property {string} [application_id] - The unique identifier of the application.
|
|
63
|
+
* @property {string} [stage] - Current stage of the import process.
|
|
64
|
+
*/
|
|
65
|
+
/**
|
|
66
|
+
* @typedef OperationResponseSchema
|
|
67
|
+
* @property {boolean} success - Indicates if the operation was successful
|
|
68
|
+
* @property {string} [message] - Optional message providing additional
|
|
69
|
+
* information about the operation
|
|
70
|
+
*/
|
|
2
71
|
/**
|
|
3
72
|
* @typedef SelfshipSchema
|
|
4
73
|
* @property {number} tat - Turn around time in the specified unit, used to
|
|
@@ -88,11 +157,13 @@ export = ServiceabilityPlatformModel;
|
|
|
88
157
|
*/
|
|
89
158
|
/**
|
|
90
159
|
* @typedef CreateZoneDataSchema
|
|
160
|
+
* @property {string} [fulfillment_option_slug] - Slug representing the
|
|
161
|
+
* fulfillment option.
|
|
91
162
|
* @property {boolean} is_active - Indicates whether the zone is active or not.
|
|
92
163
|
* @property {string} slug - Slug or URL-friendly version of the zone name.
|
|
93
164
|
* @property {string} name - Name of the zone.
|
|
94
|
-
* @property {number} company_id -
|
|
95
|
-
* @property {string} application_id -
|
|
165
|
+
* @property {number} company_id - The unique identifier of the company.
|
|
166
|
+
* @property {string} application_id - The unique identifier of the application.
|
|
96
167
|
* @property {string[]} geo_areas - List of geographical areas associated with the zone.
|
|
97
168
|
* @property {ZoneStores} stores
|
|
98
169
|
* @property {ZoneProduct} product
|
|
@@ -114,9 +185,11 @@ export = ServiceabilityPlatformModel;
|
|
|
114
185
|
/**
|
|
115
186
|
* @typedef ZoneSchema
|
|
116
187
|
* @property {Object} name - Name of the zone.
|
|
188
|
+
* @property {string} [fulfillment_option_slug] - Slug representing the
|
|
189
|
+
* fulfillment option.
|
|
117
190
|
* @property {Object} slug - Slug identifier for the zone.
|
|
118
|
-
* @property {Object} company_id -
|
|
119
|
-
* @property {Object} application_id -
|
|
191
|
+
* @property {Object} company_id - The unique identifier of the company.
|
|
192
|
+
* @property {Object} application_id - The unique identifier of the application.
|
|
120
193
|
* @property {Object} is_active - Whether the zone is active or not.
|
|
121
194
|
* @property {Object} geo_areas - List of geographical areas associated with the zone.
|
|
122
195
|
* @property {Object} stores - List of stores in the zone, referencing a schema
|
|
@@ -812,7 +885,7 @@ export = ServiceabilityPlatformModel;
|
|
|
812
885
|
* @property {string} [extension_id] - Unique identifier of courier partner extension.
|
|
813
886
|
* @property {string} [scheme_id] - Unique identifier for the scheme, used to
|
|
814
887
|
* fetch or modify scheme details.
|
|
815
|
-
* @property {string} [company_id] -
|
|
888
|
+
* @property {string} [company_id] - The unique identifier of the company.
|
|
816
889
|
* @property {string} name - Name of the scheme.
|
|
817
890
|
* @property {ArithmeticOperations} weight
|
|
818
891
|
* @property {ArithmeticOperations} [volumetric_weight]
|
|
@@ -1077,6 +1150,178 @@ export = ServiceabilityPlatformModel;
|
|
|
1077
1150
|
* @typedef CompanyConfigurationSchema
|
|
1078
1151
|
* @property {string[]} [sort] - An array of strings specifying sorting preferences.
|
|
1079
1152
|
*/
|
|
1153
|
+
/**
|
|
1154
|
+
* @typedef BusinessUnit
|
|
1155
|
+
* @property {string} [name] - Name of the business unit.
|
|
1156
|
+
* @property {boolean} [is_active] - Whether the business unit is active.
|
|
1157
|
+
*/
|
|
1158
|
+
/**
|
|
1159
|
+
* @typedef FulfillmentStores
|
|
1160
|
+
* @property {number[]} [values] - List of store IDs associated with this
|
|
1161
|
+
* fulfillment option.
|
|
1162
|
+
* @property {string} [type] - Whether fulfillment applies to all stores or
|
|
1163
|
+
* specific stores.
|
|
1164
|
+
*/
|
|
1165
|
+
/**
|
|
1166
|
+
* @typedef FulfillmentProducts
|
|
1167
|
+
* @property {number[]} [values] - List of product IDs associated with this
|
|
1168
|
+
* fulfillment option.
|
|
1169
|
+
* @property {string} [type] - Whether fulfillment applies to all products or
|
|
1170
|
+
* specific products.
|
|
1171
|
+
*/
|
|
1172
|
+
/**
|
|
1173
|
+
* @typedef CourierPartnerSchemes
|
|
1174
|
+
* @property {CourierPartnerScheme[]} [values] - List of courier partner schemes
|
|
1175
|
+
* associated with this fulfillment option.
|
|
1176
|
+
* @property {string} [type] - Indicates whether all installed courier schemes
|
|
1177
|
+
* are used or only those specified by the seller.
|
|
1178
|
+
*/
|
|
1179
|
+
/**
|
|
1180
|
+
* @typedef CourierPartnerScheme
|
|
1181
|
+
* @property {string} [scheme_id] - Unique identifier for the courier partner scheme.
|
|
1182
|
+
* @property {string} [cp_ext_id] - Unique identifier for the courier partner.
|
|
1183
|
+
*/
|
|
1184
|
+
/**
|
|
1185
|
+
* @typedef FulfillmentOptionProduct
|
|
1186
|
+
* @property {number} [uid] - Unique identifier for the product.
|
|
1187
|
+
* @property {string} [name] - Name of the product.
|
|
1188
|
+
* @property {string} [slug] - Unique slug identifier for the product.
|
|
1189
|
+
* @property {string} [category_slug] - Slug identifier of the product's category.
|
|
1190
|
+
* @property {number} [category_uid] - Unique identifier for the product's category.
|
|
1191
|
+
* @property {string} [short_description] - Brief description of the product.
|
|
1192
|
+
* @property {string} [description] - Detailed description of the product in HTML format.
|
|
1193
|
+
* @property {number} [brand_uid] - Unique identifier for the brand.
|
|
1194
|
+
* @property {string} [currency] - Currency code used for product pricing.
|
|
1195
|
+
* @property {string} [item_code] - Unique code assigned to the product.
|
|
1196
|
+
* @property {string} [item_type] - Type of product (e.g., standard, set etc.).
|
|
1197
|
+
* @property {NetQuantity} [net_quantity]
|
|
1198
|
+
* @property {boolean} [multi_size] - Indicates if the product supports multiple sizes.
|
|
1199
|
+
* @property {boolean} [is_set] - Indicates if the product is a set of items.
|
|
1200
|
+
* @property {boolean} [is_dependent] - Indicates if the product depends on
|
|
1201
|
+
* another product.
|
|
1202
|
+
* @property {boolean} [is_active] - Status indicating if the product is active.
|
|
1203
|
+
* @property {boolean} [is_image_less_product] - Indicates if the product has no images.
|
|
1204
|
+
* @property {string} [size_guide] - URL or reference to the size guide.
|
|
1205
|
+
* @property {Object} [teaser_tag] - Teaser tag information for the product.
|
|
1206
|
+
* @property {string[]} [highlights] - Key highlights of the product.
|
|
1207
|
+
* @property {string[]} [tags] - Tags associated with the product.
|
|
1208
|
+
* @property {string[]} [product_group_tag] - Group tags assigned to the product.
|
|
1209
|
+
* @property {number[]} [departments] - Department identifiers associated with
|
|
1210
|
+
* the product.
|
|
1211
|
+
* @property {number} [company_id] - The unique identifier of the company.
|
|
1212
|
+
* @property {number[]} [company_ids] - List of company IDs associated with the product.
|
|
1213
|
+
* @property {string} [country_of_origin] - Country where the product is manufactured.
|
|
1214
|
+
* @property {string} [change_request_id] - Identifier for the change request
|
|
1215
|
+
* related to the product.
|
|
1216
|
+
* @property {Trader} [trader]
|
|
1217
|
+
* @property {string} [trader_type] - Type of trader (e.g., Manufacturer, Wholesaler).
|
|
1218
|
+
* @property {ProductPublish} [product_publish]
|
|
1219
|
+
* @property {TaxIdentifier} [tax_identifier]
|
|
1220
|
+
* @property {ReturnConfig} [return_config]
|
|
1221
|
+
* @property {CustomOrder} [custom_order]
|
|
1222
|
+
* @property {Size[]} [sizes] - Available sizes for the product.
|
|
1223
|
+
* @property {string[]} [media] - List of media assets related to the product.
|
|
1224
|
+
* @property {Object} [variant_media] - Media assets for different variants of
|
|
1225
|
+
* the product.
|
|
1226
|
+
* @property {Object} [variants] - Variant-specific details for the product.
|
|
1227
|
+
* @property {number} [no_of_boxes] - Number of boxes required for packaging the product.
|
|
1228
|
+
* @property {Object} [_custom_json] - Custom JSON data associated with the product.
|
|
1229
|
+
*/
|
|
1230
|
+
/**
|
|
1231
|
+
* @typedef NetQuantity
|
|
1232
|
+
* @property {number} [value] - The quantity value of the product.
|
|
1233
|
+
* @property {string} [unit] - The unit of measurement for the quantity.
|
|
1234
|
+
*/
|
|
1235
|
+
/**
|
|
1236
|
+
* @typedef Trader
|
|
1237
|
+
* @property {string} [name] - Name of the trader.
|
|
1238
|
+
* @property {string} [address] - Address of the trader.
|
|
1239
|
+
*/
|
|
1240
|
+
/**
|
|
1241
|
+
* @typedef ProductPublish
|
|
1242
|
+
* @property {string} [product_online_date] - Date when the product went online.
|
|
1243
|
+
* @property {boolean} [is_set] - Indicates if the product is part of a set.
|
|
1244
|
+
*/
|
|
1245
|
+
/**
|
|
1246
|
+
* @typedef TaxIdentifier
|
|
1247
|
+
* @property {string} [hsn_code] - HSN code assigned to the product.
|
|
1248
|
+
* @property {string} [hsn_code_id] - Identifier for the HSN code.
|
|
1249
|
+
* @property {string} [reporting_hsn] - Reporting HSN code.
|
|
1250
|
+
*/
|
|
1251
|
+
/**
|
|
1252
|
+
* @typedef ReturnConfig
|
|
1253
|
+
* @property {boolean} [returnable] - Indicates if the product is returnable.
|
|
1254
|
+
* @property {number} [time] - Time duration allowed for returns.
|
|
1255
|
+
* @property {string} [unit] - Unit of time for return duration.
|
|
1256
|
+
*/
|
|
1257
|
+
/**
|
|
1258
|
+
* @typedef CustomOrder
|
|
1259
|
+
* @property {boolean} [is_custom_order] - Indicates if the product is a custom order.
|
|
1260
|
+
* @property {number} [manufacturing_time] - Time required for manufacturing the product.
|
|
1261
|
+
* @property {string} [manufacturing_time_unit] - Unit of time for manufacturing.
|
|
1262
|
+
*/
|
|
1263
|
+
/**
|
|
1264
|
+
* @typedef Size
|
|
1265
|
+
* @property {string} [size] - Size label of the product.
|
|
1266
|
+
* @property {number} [size_priority] - Priority assigned to the size.
|
|
1267
|
+
* @property {string} [item_dimensions_unit_of_measure] - Unit of measure for
|
|
1268
|
+
* item dimensions.
|
|
1269
|
+
* @property {number} [price_transfer] - Transfer price of the product.
|
|
1270
|
+
* @property {number} [item_height] - Height of the product.
|
|
1271
|
+
* @property {number} [item_length] - Length of the product.
|
|
1272
|
+
* @property {number} [item_width] - Width of the product.
|
|
1273
|
+
* @property {number} [item_weight] - Weight of the product.
|
|
1274
|
+
* @property {string} [item_weight_unit_of_measure] - Unit of measure for item weight.
|
|
1275
|
+
* @property {number} [price] - Selling price of the product.
|
|
1276
|
+
* @property {number} [price_effective] - Effective price after discounts.
|
|
1277
|
+
* @property {boolean} [is_set] - Indicates if the size belongs to a set.
|
|
1278
|
+
* @property {boolean} [track_inventory] - Indicates if inventory tracking is enabled.
|
|
1279
|
+
* @property {Identifier[]} [identifiers] - Unique identifiers associated with the size.
|
|
1280
|
+
* @property {Object} [_custom_json] - Custom JSON data associated with the size.
|
|
1281
|
+
*/
|
|
1282
|
+
/**
|
|
1283
|
+
* @typedef Identifier
|
|
1284
|
+
* @property {string} [gtin_type] - Type of GTIN identifier (e.g., SKU, UPC, EAN).
|
|
1285
|
+
* @property {string} [gtin_value] - Value of the GTIN identifier.
|
|
1286
|
+
* @property {boolean} [primary] - Indicates if this is the primary identifier.
|
|
1287
|
+
*/
|
|
1288
|
+
/**
|
|
1289
|
+
* @typedef Page
|
|
1290
|
+
* @property {number} [item_total] - The total number of all items across all pages.
|
|
1291
|
+
* @property {string} [next_id] - The identifier for the next page.
|
|
1292
|
+
* @property {boolean} [has_previous] - Indicates whether there is a previous page.
|
|
1293
|
+
* @property {boolean} [has_next] - Indicates whether there is a next page.
|
|
1294
|
+
* @property {number} [current] - The current page number.
|
|
1295
|
+
* @property {string} type - The type of the page, such as 'PageType'.
|
|
1296
|
+
* @property {number} [size] - The number of items per page.
|
|
1297
|
+
* @property {number} [page_size] - The number of items per page.
|
|
1298
|
+
*/
|
|
1299
|
+
/**
|
|
1300
|
+
* @typedef FulfillmentOptionStore
|
|
1301
|
+
* @property {number} [uid] - Unique identifier for the store.
|
|
1302
|
+
* @property {Address} [address]
|
|
1303
|
+
* @property {number} [company_id] - The unique identifier of the company.
|
|
1304
|
+
* @property {string} [display_name] - Store name displayed in the UI.
|
|
1305
|
+
* @property {string} [name] - Name of the store.
|
|
1306
|
+
* @property {string} [store_type] - Type of store (e.g., high_street, mall).
|
|
1307
|
+
* @property {string[]} [tags] - Tags associated with the store.
|
|
1308
|
+
*/
|
|
1309
|
+
/**
|
|
1310
|
+
* @typedef Address
|
|
1311
|
+
* @property {string} [address1] - Primary address line.
|
|
1312
|
+
* @property {string} [country] - Country where the store is located.
|
|
1313
|
+
* @property {string} [pincode] - Postal code of the store location.
|
|
1314
|
+
* @property {string} [city] - City where the store is located.
|
|
1315
|
+
* @property {string} [state] - State where the store is located.
|
|
1316
|
+
* @property {number} [latitude] - Latitude coordinate of the store.
|
|
1317
|
+
* @property {number} [longitude] - Longitude coordinate of the store.
|
|
1318
|
+
* @property {string} [country_code] - ISO country code of the store location.
|
|
1319
|
+
*/
|
|
1320
|
+
/**
|
|
1321
|
+
* @typedef FulfillmentOptionValidate
|
|
1322
|
+
* @property {string} [entity_filter_type] - Type of entity filter applied.
|
|
1323
|
+
* @property {string} [fulfillment_option_type] - Type of fulfillment option selected.
|
|
1324
|
+
*/
|
|
1080
1325
|
/**
|
|
1081
1326
|
* @typedef ProductSchema
|
|
1082
1327
|
* @property {string} type - The classification of product type used in the
|
|
@@ -1108,8 +1353,8 @@ export = ServiceabilityPlatformModel;
|
|
|
1108
1353
|
* @property {ListViewProduct} stores
|
|
1109
1354
|
* @property {boolean} is_active - Indicates if the zone is active.
|
|
1110
1355
|
* @property {ListViewProduct} product
|
|
1111
|
-
* @property {number} company_id -
|
|
1112
|
-
* @property {string} application_id -
|
|
1356
|
+
* @property {number} company_id - The unique identifier of the company.
|
|
1357
|
+
* @property {string} application_id - The unique identifier of the application.
|
|
1113
1358
|
* @property {CreatedBy} created_by
|
|
1114
1359
|
* @property {ModifiedBy} modified_by
|
|
1115
1360
|
* @property {string} created_on - The timestamp when the record was created.
|
|
@@ -1139,17 +1384,6 @@ export = ServiceabilityPlatformModel;
|
|
|
1139
1384
|
* @property {string} [name] - Name of the region.
|
|
1140
1385
|
* @property {number} [count] - Count of items in the region.
|
|
1141
1386
|
*/
|
|
1142
|
-
/**
|
|
1143
|
-
* @typedef Page
|
|
1144
|
-
* @property {number} [item_total] - The total number of all items across all pages.
|
|
1145
|
-
* @property {string} [next_id] - The identifier for the next page.
|
|
1146
|
-
* @property {boolean} [has_previous] - Indicates whether there is a previous page.
|
|
1147
|
-
* @property {boolean} [has_next] - Indicates whether there is a next page.
|
|
1148
|
-
* @property {number} [current] - The current page number.
|
|
1149
|
-
* @property {string} type - The type of the page, such as 'PageType'.
|
|
1150
|
-
* @property {number} [size] - The number of items per page.
|
|
1151
|
-
* @property {number} [page_size] - The number of items per page.
|
|
1152
|
-
*/
|
|
1153
1387
|
/**
|
|
1154
1388
|
* @typedef ZoneStores
|
|
1155
1389
|
* @property {Object} type - Type of zone store.
|
|
@@ -2036,8 +2270,184 @@ export = ServiceabilityPlatformModel;
|
|
|
2036
2270
|
declare class ServiceabilityPlatformModel {
|
|
2037
2271
|
}
|
|
2038
2272
|
declare namespace ServiceabilityPlatformModel {
|
|
2039
|
-
export { SelfshipSchema, ServiceabilityErrorResult, UpdateZoneData, ZoneUpdateSuccessResult, ServiceabilityDeleteErrorResult, ZoneDeleteSuccessResult, ListViewSchema, GetZoneByIdSchema, CommonErrorResult, CreateZoneDataSchema, ZoneBulkExport, GetZoneBulkExport, CreateBulkZoneData, ZoneSchema, CreateBulkZoneResult, BulkCreateZoneExport, PincodeMopData, PincodeMOPResult, PincodeMopUpdateAuditError, PincodeMopBulkError, CommonError, PincodeMopBulkData, PincodeBulkViewResult, PincodeCodStatusListingDetails, PincodeCodStatusListingResult, PincodeMopUpdateAuditHistoryDetails, PincodeMopUpdateAuditHistoryResultData, BulkGeoAreaDetails, BulkGeoAreaResult, BulkGeoAreaGetResult, GeoAreaBulkCreationResult, GeoAreaBulkExportResult, GeoAreaRequestBody, GeoAreaErrorResult, GeoAreaResponseBody, GeoAreaPutResponseBody, GeoAreaGetResponseBody, GeoAreaDetails, Error, CourierAccountDetailsBody, CourierPartnerRuleResult, CourierPartnerRule, BulkFailureResult, FailureResult, CourierPartnerRulesListResult, ShipmentCourierPartnerDetails, ShipmentCourierPartnerResult, CompanyConfig, ApplicationConfigPatch, ApplicationConfigPatchResult, BulkRegionJobDetails, BulkRegionResultItemData, BulkRegionResult, StoreRuleConfigData, StoreRuleDataSchema, GetStoreRulesApiResult, CreateStoreRuleDetailsSchema, StoreRuleResultSchema, StoreRuleUpdateResultSchema, CourierAccountResult, CompanyCourierPartnerAccountListResult, PackageMaterial, PackageMaterialNotFound, PackageMaterialsErrorResult, PackageMaterialResult, PackageRule, PackageRuleResult, PackagesListResult, PackageItem, RulePriorityDetails, RulePriorityResult, OptimalLocationsResult, OptimlLocationsRequestSchema, ValidationError, StandardError, CourierPartnerSchemeDetailsModel, CourierPartnerSchemeModelSchema, CourierPartnerSchemeUpdateDetailsSchema, CourierPartnerSchemeList, BulkRegionServiceabilityTatDetails, BulkRegionServiceabilityTatResultItemData, BulkRegionServiceabilityTatResult, GetCountries, GetLocalities, GetCountry, BulkImportLocalitiesDetails, BulkImportLocalitiesResult, BulkErrorResult, LocalitiesBulkExport, LocalitiesBulkExportFetch, LocalitiesErrorResult, GetLocality, ValidateAddress, ErrorResult, ApplicationConfigPut, ApplicationConfigPutDetail, ApplicationConfigGetResult, InstallCourierPartnerResponseSchema, GetLocalitiesBulkHistory, CompanyConfigurationSchema, ProductSchema, StoresSchema, CreatedBy, ModifiedBy, ListViewItems, GeoArea, ListViewProduct, Summary, RegionSchema,
|
|
2273
|
+
export { FulfillmentOption, FulfillmentOptionProducts, FulfillmentOptionStores, FulfillmentOptionBulkValidate, FulfillmentOptionBulkValidateData, FulfillmentOptionBulk, FulfillmentOptionBulkData, OperationResponseSchema, SelfshipSchema, ServiceabilityErrorResult, UpdateZoneData, ZoneUpdateSuccessResult, ServiceabilityDeleteErrorResult, ZoneDeleteSuccessResult, ListViewSchema, GetZoneByIdSchema, CommonErrorResult, CreateZoneDataSchema, ZoneBulkExport, GetZoneBulkExport, CreateBulkZoneData, ZoneSchema, CreateBulkZoneResult, BulkCreateZoneExport, PincodeMopData, PincodeMOPResult, PincodeMopUpdateAuditError, PincodeMopBulkError, CommonError, PincodeMopBulkData, PincodeBulkViewResult, PincodeCodStatusListingDetails, PincodeCodStatusListingResult, PincodeMopUpdateAuditHistoryDetails, PincodeMopUpdateAuditHistoryResultData, BulkGeoAreaDetails, BulkGeoAreaResult, BulkGeoAreaGetResult, GeoAreaBulkCreationResult, GeoAreaBulkExportResult, GeoAreaRequestBody, GeoAreaErrorResult, GeoAreaResponseBody, GeoAreaPutResponseBody, GeoAreaGetResponseBody, GeoAreaDetails, Error, CourierAccountDetailsBody, CourierPartnerRuleResult, CourierPartnerRule, BulkFailureResult, FailureResult, CourierPartnerRulesListResult, ShipmentCourierPartnerDetails, ShipmentCourierPartnerResult, CompanyConfig, ApplicationConfigPatch, ApplicationConfigPatchResult, BulkRegionJobDetails, BulkRegionResultItemData, BulkRegionResult, StoreRuleConfigData, StoreRuleDataSchema, GetStoreRulesApiResult, CreateStoreRuleDetailsSchema, StoreRuleResultSchema, StoreRuleUpdateResultSchema, CourierAccountResult, CompanyCourierPartnerAccountListResult, PackageMaterial, PackageMaterialNotFound, PackageMaterialsErrorResult, PackageMaterialResult, PackageRule, PackageRuleResult, PackagesListResult, PackageItem, RulePriorityDetails, RulePriorityResult, OptimalLocationsResult, OptimlLocationsRequestSchema, ValidationError, StandardError, CourierPartnerSchemeDetailsModel, CourierPartnerSchemeModelSchema, CourierPartnerSchemeUpdateDetailsSchema, CourierPartnerSchemeList, BulkRegionServiceabilityTatDetails, BulkRegionServiceabilityTatResultItemData, BulkRegionServiceabilityTatResult, GetCountries, GetLocalities, GetCountry, BulkImportLocalitiesDetails, BulkImportLocalitiesResult, BulkErrorResult, LocalitiesBulkExport, LocalitiesBulkExportFetch, LocalitiesErrorResult, GetLocality, ValidateAddress, ErrorResult, ApplicationConfigPut, ApplicationConfigPutDetail, ApplicationConfigGetResult, InstallCourierPartnerResponseSchema, GetLocalitiesBulkHistory, CompanyConfigurationSchema, BusinessUnit, FulfillmentStores, FulfillmentProducts, CourierPartnerSchemes, CourierPartnerScheme, FulfillmentOptionProduct, NetQuantity, Trader, ProductPublish, TaxIdentifier, ReturnConfig, CustomOrder, Size, Identifier, Page, FulfillmentOptionStore, Address, FulfillmentOptionValidate, ProductSchema, StoresSchema, CreatedBy, ModifiedBy, ListViewItems, GeoArea, ListViewProduct, Summary, RegionSchema, ZoneStores, ZoneProduct, ZoneBulkItem, PincodeMopUpdateResult, PincodeCodStatusItem, PincodeCodStatusListingSummary, PincodeMopUpdateAuditHistoryPaging, PincodeMopUpdateAuditHistoryResult, Area, GeoAreaResponseDetail, GeoAreaItemResult, AreaExpanded, Country, Region, Page2, CourierPartnerRuleConditions, LocationRule, LocationRuleValues, StringComparisonOperations, IntComparisonOperations, ArithmeticOperations, CourierPartnerRuleCPListResult, CourierPartnerSchemeDefaultTat, CourierPartnerSchemeTat, CourierPartnerSchemeFeatures, CourierPartnerList, ShipmentsCourierPartnersServiceability, CPShipments, ShipmentDimension, ShipmentsArticles, ArticleWeight, ArticleAttributes, ArticleDimension, ArticleSet, ArticleSizeDistribution, SetSize, ArticleDeliverySlots, ArticleReturnReason, CourierPartners, CourierPartnerPromise, CourierPartnerAttributes, CourierPartnerTAT, ShipmentCourierPartners, CourierPartnerConfig, BuyboxRuleConfig, PromiseConfig, StorePromiseAttributeConfig, DeliveryServiceAttributeConfig, BufferField, StorePrioritySchema, StoreRuleConditionSchema, CustomerRadiusSchema, DateOperations, CourierPartnerSchemeModel, PackageMaterialRule, PackageMaterialRuleQuantity, Channel, PackageRuleCategory, PackageRuleProduct, PackageRuleProductTag, PackageRuleDepartmentId, PackageRuleProductAttributes, PackageChannel, StoreFilter, PackageRuleSchema, Quantity, PackagePageInfo, OptimalLocationAssignedStoresResult, OptimalLocationArticlesResult, ArticleAssignment, LocationDetailsServiceability, ServiceabilityLocation, OptimalLocationsArticles, GetCountriesItems, HierarchyItems, CurrencyObject, Localities, PincodeLatLongData, LocalityParent, CountryMetaFields, ApplicationFields, GetCountryFieldsAddress, FieldValidation, FieldValidationRegex, LengthValidation, GetCountryFieldsAddressValues, GetOneOrAll, GetOneOrAllParams, GetOneOrAllPath, GetOneOrAllQuery, GetCountryFieldsAddressTemplateApplication, CountryHierarchy, GetCountryFields, GetCountryFieldsAddressTemplate, LocalityParents, ZoneConfig, PromiseType, InstallCourierPartnerItemsSchema, HistoryObject };
|
|
2040
2274
|
}
|
|
2275
|
+
/** @returns {FulfillmentOption} */
|
|
2276
|
+
declare function FulfillmentOption(): FulfillmentOption;
|
|
2277
|
+
type FulfillmentOption = {
|
|
2278
|
+
/**
|
|
2279
|
+
* - Name of the fulfillment option.
|
|
2280
|
+
*/
|
|
2281
|
+
name?: string;
|
|
2282
|
+
/**
|
|
2283
|
+
* - Unique identifier for the fulfillment option.
|
|
2284
|
+
*/
|
|
2285
|
+
slug?: string;
|
|
2286
|
+
/**
|
|
2287
|
+
* - The unique identifier of the company.
|
|
2288
|
+
*/
|
|
2289
|
+
company_id?: number;
|
|
2290
|
+
/**
|
|
2291
|
+
* - The unique identifier of the application.
|
|
2292
|
+
*/
|
|
2293
|
+
application_id?: string;
|
|
2294
|
+
/**
|
|
2295
|
+
* - Description of the fulfillment option.
|
|
2296
|
+
*/
|
|
2297
|
+
description?: string;
|
|
2298
|
+
/**
|
|
2299
|
+
* - Whether this is the default fulfillment option.
|
|
2300
|
+
*/
|
|
2301
|
+
is_default?: boolean;
|
|
2302
|
+
/**
|
|
2303
|
+
* - Type of fulfillment option.
|
|
2304
|
+
*/
|
|
2305
|
+
type?: string;
|
|
2306
|
+
/**
|
|
2307
|
+
* - Status of the fulfillment option.
|
|
2308
|
+
*/
|
|
2309
|
+
status?: string;
|
|
2310
|
+
business_unit?: BusinessUnit[];
|
|
2311
|
+
fulfillment_stores?: FulfillmentStores;
|
|
2312
|
+
products?: FulfillmentProducts;
|
|
2313
|
+
cp_schemes?: CourierPartnerSchemes;
|
|
2314
|
+
/**
|
|
2315
|
+
* - Unique identifier for the fulfillment option.
|
|
2316
|
+
*/
|
|
2317
|
+
id?: string;
|
|
2318
|
+
};
|
|
2319
|
+
/** @returns {FulfillmentOptionProducts} */
|
|
2320
|
+
declare function FulfillmentOptionProducts(): FulfillmentOptionProducts;
|
|
2321
|
+
type FulfillmentOptionProducts = {
|
|
2322
|
+
items?: FulfillmentOptionProduct;
|
|
2323
|
+
page?: Page;
|
|
2324
|
+
};
|
|
2325
|
+
/** @returns {FulfillmentOptionStores} */
|
|
2326
|
+
declare function FulfillmentOptionStores(): FulfillmentOptionStores;
|
|
2327
|
+
type FulfillmentOptionStores = {
|
|
2328
|
+
/**
|
|
2329
|
+
* - List of stores with their details.
|
|
2330
|
+
*/
|
|
2331
|
+
items?: FulfillmentOptionStore[];
|
|
2332
|
+
page?: Page;
|
|
2333
|
+
};
|
|
2334
|
+
/** @returns {FulfillmentOptionBulkValidate} */
|
|
2335
|
+
declare function FulfillmentOptionBulkValidate(): FulfillmentOptionBulkValidate;
|
|
2336
|
+
type FulfillmentOptionBulkValidate = {
|
|
2337
|
+
/**
|
|
2338
|
+
* - Type of store related to fulfillment.
|
|
2339
|
+
*/
|
|
2340
|
+
store_type?: string;
|
|
2341
|
+
/**
|
|
2342
|
+
* - URL of the uploaded file.
|
|
2343
|
+
*/
|
|
2344
|
+
file_path?: string;
|
|
2345
|
+
/**
|
|
2346
|
+
* - Action to be performed, such as import.
|
|
2347
|
+
*/
|
|
2348
|
+
action?: string;
|
|
2349
|
+
/**
|
|
2350
|
+
* - Entity type being processed.
|
|
2351
|
+
*/
|
|
2352
|
+
type?: string;
|
|
2353
|
+
/**
|
|
2354
|
+
* - Slug representing the
|
|
2355
|
+
* fulfillment option.
|
|
2356
|
+
*/
|
|
2357
|
+
fulfillment_option_slug?: string;
|
|
2358
|
+
request?: FulfillmentOptionValidate;
|
|
2359
|
+
};
|
|
2360
|
+
/** @returns {FulfillmentOptionBulkValidateData} */
|
|
2361
|
+
declare function FulfillmentOptionBulkValidateData(): FulfillmentOptionBulkValidateData;
|
|
2362
|
+
type FulfillmentOptionBulkValidateData = {
|
|
2363
|
+
/**
|
|
2364
|
+
* - Unique id generated for bulk operation.
|
|
2365
|
+
*/
|
|
2366
|
+
request_id?: string;
|
|
2367
|
+
};
|
|
2368
|
+
/** @returns {FulfillmentOptionBulk} */
|
|
2369
|
+
declare function FulfillmentOptionBulk(): FulfillmentOptionBulk;
|
|
2370
|
+
type FulfillmentOptionBulk = {
|
|
2371
|
+
/**
|
|
2372
|
+
* - The URL of file from which data will be imported.
|
|
2373
|
+
*/
|
|
2374
|
+
file_path?: string;
|
|
2375
|
+
/**
|
|
2376
|
+
* - Specifies the type of bulk fulfillment request.
|
|
2377
|
+
*/
|
|
2378
|
+
type?: string;
|
|
2379
|
+
};
|
|
2380
|
+
/** @returns {FulfillmentOptionBulkData} */
|
|
2381
|
+
declare function FulfillmentOptionBulkData(): FulfillmentOptionBulkData;
|
|
2382
|
+
type FulfillmentOptionBulkData = {
|
|
2383
|
+
/**
|
|
2384
|
+
* - Unique identifier for the request.
|
|
2385
|
+
*/
|
|
2386
|
+
request_id?: string;
|
|
2387
|
+
request?: FulfillmentOptionValidate;
|
|
2388
|
+
/**
|
|
2389
|
+
* - Slug representing the
|
|
2390
|
+
* fulfillment option.
|
|
2391
|
+
*/
|
|
2392
|
+
fulfillment_option_slug?: string;
|
|
2393
|
+
/**
|
|
2394
|
+
* - URL of the uploaded file.
|
|
2395
|
+
*/
|
|
2396
|
+
file_url?: string;
|
|
2397
|
+
/**
|
|
2398
|
+
* - Total number of records processed.
|
|
2399
|
+
*/
|
|
2400
|
+
total?: number;
|
|
2401
|
+
/**
|
|
2402
|
+
* - Number of successful records.
|
|
2403
|
+
*/
|
|
2404
|
+
success?: number;
|
|
2405
|
+
/**
|
|
2406
|
+
* - Number of failed records.
|
|
2407
|
+
*/
|
|
2408
|
+
failed?: number;
|
|
2409
|
+
/**
|
|
2410
|
+
* - Action performed in the request.
|
|
2411
|
+
*/
|
|
2412
|
+
action?: string;
|
|
2413
|
+
/**
|
|
2414
|
+
* - Timestamp of the last update.
|
|
2415
|
+
*/
|
|
2416
|
+
updated_at?: string;
|
|
2417
|
+
/**
|
|
2418
|
+
* - Identifier of the user who updated the request.
|
|
2419
|
+
*/
|
|
2420
|
+
updated_by?: string;
|
|
2421
|
+
/**
|
|
2422
|
+
* - Type of the bulk import process.
|
|
2423
|
+
*/
|
|
2424
|
+
type?: string;
|
|
2425
|
+
/**
|
|
2426
|
+
* - The unique identifier of the company.
|
|
2427
|
+
*/
|
|
2428
|
+
company_id?: number;
|
|
2429
|
+
/**
|
|
2430
|
+
* - The unique identifier of the application.
|
|
2431
|
+
*/
|
|
2432
|
+
application_id?: string;
|
|
2433
|
+
/**
|
|
2434
|
+
* - Current stage of the import process.
|
|
2435
|
+
*/
|
|
2436
|
+
stage?: string;
|
|
2437
|
+
};
|
|
2438
|
+
/** @returns {OperationResponseSchema} */
|
|
2439
|
+
declare function OperationResponseSchema(): OperationResponseSchema;
|
|
2440
|
+
type OperationResponseSchema = {
|
|
2441
|
+
/**
|
|
2442
|
+
* - Indicates if the operation was successful
|
|
2443
|
+
*/
|
|
2444
|
+
success: boolean;
|
|
2445
|
+
/**
|
|
2446
|
+
* - Optional message providing additional
|
|
2447
|
+
* information about the operation
|
|
2448
|
+
*/
|
|
2449
|
+
message?: string;
|
|
2450
|
+
};
|
|
2041
2451
|
/** @returns {SelfshipSchema} */
|
|
2042
2452
|
declare function SelfshipSchema(): SelfshipSchema;
|
|
2043
2453
|
type SelfshipSchema = {
|
|
@@ -2248,6 +2658,11 @@ type CommonErrorResult = {
|
|
|
2248
2658
|
/** @returns {CreateZoneDataSchema} */
|
|
2249
2659
|
declare function CreateZoneDataSchema(): CreateZoneDataSchema;
|
|
2250
2660
|
type CreateZoneDataSchema = {
|
|
2661
|
+
/**
|
|
2662
|
+
* - Slug representing the
|
|
2663
|
+
* fulfillment option.
|
|
2664
|
+
*/
|
|
2665
|
+
fulfillment_option_slug?: string;
|
|
2251
2666
|
/**
|
|
2252
2667
|
* - Indicates whether the zone is active or not.
|
|
2253
2668
|
*/
|
|
@@ -2261,11 +2676,11 @@ type CreateZoneDataSchema = {
|
|
|
2261
2676
|
*/
|
|
2262
2677
|
name: string;
|
|
2263
2678
|
/**
|
|
2264
|
-
* -
|
|
2679
|
+
* - The unique identifier of the company.
|
|
2265
2680
|
*/
|
|
2266
2681
|
company_id: number;
|
|
2267
2682
|
/**
|
|
2268
|
-
* -
|
|
2683
|
+
* - The unique identifier of the application.
|
|
2269
2684
|
*/
|
|
2270
2685
|
application_id: string;
|
|
2271
2686
|
/**
|
|
@@ -2311,16 +2726,21 @@ type ZoneSchema = {
|
|
|
2311
2726
|
* - Name of the zone.
|
|
2312
2727
|
*/
|
|
2313
2728
|
name: any;
|
|
2729
|
+
/**
|
|
2730
|
+
* - Slug representing the
|
|
2731
|
+
* fulfillment option.
|
|
2732
|
+
*/
|
|
2733
|
+
fulfillment_option_slug?: string;
|
|
2314
2734
|
/**
|
|
2315
2735
|
* - Slug identifier for the zone.
|
|
2316
2736
|
*/
|
|
2317
2737
|
slug: any;
|
|
2318
2738
|
/**
|
|
2319
|
-
* -
|
|
2739
|
+
* - The unique identifier of the company.
|
|
2320
2740
|
*/
|
|
2321
2741
|
company_id: any;
|
|
2322
2742
|
/**
|
|
2323
|
-
* -
|
|
2743
|
+
* - The unique identifier of the application.
|
|
2324
2744
|
*/
|
|
2325
2745
|
application_id: any;
|
|
2326
2746
|
/**
|
|
@@ -4093,7 +4513,7 @@ type CourierPartnerSchemeModelSchema = {
|
|
|
4093
4513
|
*/
|
|
4094
4514
|
scheme_id?: string;
|
|
4095
4515
|
/**
|
|
4096
|
-
* -
|
|
4516
|
+
* - The unique identifier of the company.
|
|
4097
4517
|
*/
|
|
4098
4518
|
company_id?: string;
|
|
4099
4519
|
/**
|
|
@@ -4698,6 +5118,496 @@ type CompanyConfigurationSchema = {
|
|
|
4698
5118
|
*/
|
|
4699
5119
|
sort?: string[];
|
|
4700
5120
|
};
|
|
5121
|
+
/** @returns {BusinessUnit} */
|
|
5122
|
+
declare function BusinessUnit(): BusinessUnit;
|
|
5123
|
+
type BusinessUnit = {
|
|
5124
|
+
/**
|
|
5125
|
+
* - Name of the business unit.
|
|
5126
|
+
*/
|
|
5127
|
+
name?: string;
|
|
5128
|
+
/**
|
|
5129
|
+
* - Whether the business unit is active.
|
|
5130
|
+
*/
|
|
5131
|
+
is_active?: boolean;
|
|
5132
|
+
};
|
|
5133
|
+
/** @returns {FulfillmentStores} */
|
|
5134
|
+
declare function FulfillmentStores(): FulfillmentStores;
|
|
5135
|
+
type FulfillmentStores = {
|
|
5136
|
+
/**
|
|
5137
|
+
* - List of store IDs associated with this
|
|
5138
|
+
* fulfillment option.
|
|
5139
|
+
*/
|
|
5140
|
+
values?: number[];
|
|
5141
|
+
/**
|
|
5142
|
+
* - Whether fulfillment applies to all stores or
|
|
5143
|
+
* specific stores.
|
|
5144
|
+
*/
|
|
5145
|
+
type?: string;
|
|
5146
|
+
};
|
|
5147
|
+
/** @returns {FulfillmentProducts} */
|
|
5148
|
+
declare function FulfillmentProducts(): FulfillmentProducts;
|
|
5149
|
+
type FulfillmentProducts = {
|
|
5150
|
+
/**
|
|
5151
|
+
* - List of product IDs associated with this
|
|
5152
|
+
* fulfillment option.
|
|
5153
|
+
*/
|
|
5154
|
+
values?: number[];
|
|
5155
|
+
/**
|
|
5156
|
+
* - Whether fulfillment applies to all products or
|
|
5157
|
+
* specific products.
|
|
5158
|
+
*/
|
|
5159
|
+
type?: string;
|
|
5160
|
+
};
|
|
5161
|
+
/** @returns {CourierPartnerSchemes} */
|
|
5162
|
+
declare function CourierPartnerSchemes(): CourierPartnerSchemes;
|
|
5163
|
+
type CourierPartnerSchemes = {
|
|
5164
|
+
/**
|
|
5165
|
+
* - List of courier partner schemes
|
|
5166
|
+
* associated with this fulfillment option.
|
|
5167
|
+
*/
|
|
5168
|
+
values?: CourierPartnerScheme[];
|
|
5169
|
+
/**
|
|
5170
|
+
* - Indicates whether all installed courier schemes
|
|
5171
|
+
* are used or only those specified by the seller.
|
|
5172
|
+
*/
|
|
5173
|
+
type?: string;
|
|
5174
|
+
};
|
|
5175
|
+
/** @returns {CourierPartnerScheme} */
|
|
5176
|
+
declare function CourierPartnerScheme(): CourierPartnerScheme;
|
|
5177
|
+
type CourierPartnerScheme = {
|
|
5178
|
+
/**
|
|
5179
|
+
* - Unique identifier for the courier partner scheme.
|
|
5180
|
+
*/
|
|
5181
|
+
scheme_id?: string;
|
|
5182
|
+
/**
|
|
5183
|
+
* - Unique identifier for the courier partner.
|
|
5184
|
+
*/
|
|
5185
|
+
cp_ext_id?: string;
|
|
5186
|
+
};
|
|
5187
|
+
/** @returns {FulfillmentOptionProduct} */
|
|
5188
|
+
declare function FulfillmentOptionProduct(): FulfillmentOptionProduct;
|
|
5189
|
+
type FulfillmentOptionProduct = {
|
|
5190
|
+
/**
|
|
5191
|
+
* - Unique identifier for the product.
|
|
5192
|
+
*/
|
|
5193
|
+
uid?: number;
|
|
5194
|
+
/**
|
|
5195
|
+
* - Name of the product.
|
|
5196
|
+
*/
|
|
5197
|
+
name?: string;
|
|
5198
|
+
/**
|
|
5199
|
+
* - Unique slug identifier for the product.
|
|
5200
|
+
*/
|
|
5201
|
+
slug?: string;
|
|
5202
|
+
/**
|
|
5203
|
+
* - Slug identifier of the product's category.
|
|
5204
|
+
*/
|
|
5205
|
+
category_slug?: string;
|
|
5206
|
+
/**
|
|
5207
|
+
* - Unique identifier for the product's category.
|
|
5208
|
+
*/
|
|
5209
|
+
category_uid?: number;
|
|
5210
|
+
/**
|
|
5211
|
+
* - Brief description of the product.
|
|
5212
|
+
*/
|
|
5213
|
+
short_description?: string;
|
|
5214
|
+
/**
|
|
5215
|
+
* - Detailed description of the product in HTML format.
|
|
5216
|
+
*/
|
|
5217
|
+
description?: string;
|
|
5218
|
+
/**
|
|
5219
|
+
* - Unique identifier for the brand.
|
|
5220
|
+
*/
|
|
5221
|
+
brand_uid?: number;
|
|
5222
|
+
/**
|
|
5223
|
+
* - Currency code used for product pricing.
|
|
5224
|
+
*/
|
|
5225
|
+
currency?: string;
|
|
5226
|
+
/**
|
|
5227
|
+
* - Unique code assigned to the product.
|
|
5228
|
+
*/
|
|
5229
|
+
item_code?: string;
|
|
5230
|
+
/**
|
|
5231
|
+
* - Type of product (e.g., standard, set etc.).
|
|
5232
|
+
*/
|
|
5233
|
+
item_type?: string;
|
|
5234
|
+
net_quantity?: NetQuantity;
|
|
5235
|
+
/**
|
|
5236
|
+
* - Indicates if the product supports multiple sizes.
|
|
5237
|
+
*/
|
|
5238
|
+
multi_size?: boolean;
|
|
5239
|
+
/**
|
|
5240
|
+
* - Indicates if the product is a set of items.
|
|
5241
|
+
*/
|
|
5242
|
+
is_set?: boolean;
|
|
5243
|
+
/**
|
|
5244
|
+
* - Indicates if the product depends on
|
|
5245
|
+
* another product.
|
|
5246
|
+
*/
|
|
5247
|
+
is_dependent?: boolean;
|
|
5248
|
+
/**
|
|
5249
|
+
* - Status indicating if the product is active.
|
|
5250
|
+
*/
|
|
5251
|
+
is_active?: boolean;
|
|
5252
|
+
/**
|
|
5253
|
+
* - Indicates if the product has no images.
|
|
5254
|
+
*/
|
|
5255
|
+
is_image_less_product?: boolean;
|
|
5256
|
+
/**
|
|
5257
|
+
* - URL or reference to the size guide.
|
|
5258
|
+
*/
|
|
5259
|
+
size_guide?: string;
|
|
5260
|
+
/**
|
|
5261
|
+
* - Teaser tag information for the product.
|
|
5262
|
+
*/
|
|
5263
|
+
teaser_tag?: any;
|
|
5264
|
+
/**
|
|
5265
|
+
* - Key highlights of the product.
|
|
5266
|
+
*/
|
|
5267
|
+
highlights?: string[];
|
|
5268
|
+
/**
|
|
5269
|
+
* - Tags associated with the product.
|
|
5270
|
+
*/
|
|
5271
|
+
tags?: string[];
|
|
5272
|
+
/**
|
|
5273
|
+
* - Group tags assigned to the product.
|
|
5274
|
+
*/
|
|
5275
|
+
product_group_tag?: string[];
|
|
5276
|
+
/**
|
|
5277
|
+
* - Department identifiers associated with
|
|
5278
|
+
* the product.
|
|
5279
|
+
*/
|
|
5280
|
+
departments?: number[];
|
|
5281
|
+
/**
|
|
5282
|
+
* - The unique identifier of the company.
|
|
5283
|
+
*/
|
|
5284
|
+
company_id?: number;
|
|
5285
|
+
/**
|
|
5286
|
+
* - List of company IDs associated with the product.
|
|
5287
|
+
*/
|
|
5288
|
+
company_ids?: number[];
|
|
5289
|
+
/**
|
|
5290
|
+
* - Country where the product is manufactured.
|
|
5291
|
+
*/
|
|
5292
|
+
country_of_origin?: string;
|
|
5293
|
+
/**
|
|
5294
|
+
* - Identifier for the change request
|
|
5295
|
+
* related to the product.
|
|
5296
|
+
*/
|
|
5297
|
+
change_request_id?: string;
|
|
5298
|
+
trader?: Trader;
|
|
5299
|
+
/**
|
|
5300
|
+
* - Type of trader (e.g., Manufacturer, Wholesaler).
|
|
5301
|
+
*/
|
|
5302
|
+
trader_type?: string;
|
|
5303
|
+
product_publish?: ProductPublish;
|
|
5304
|
+
tax_identifier?: TaxIdentifier;
|
|
5305
|
+
return_config?: ReturnConfig;
|
|
5306
|
+
custom_order?: CustomOrder;
|
|
5307
|
+
/**
|
|
5308
|
+
* - Available sizes for the product.
|
|
5309
|
+
*/
|
|
5310
|
+
sizes?: Size[];
|
|
5311
|
+
/**
|
|
5312
|
+
* - List of media assets related to the product.
|
|
5313
|
+
*/
|
|
5314
|
+
media?: string[];
|
|
5315
|
+
/**
|
|
5316
|
+
* - Media assets for different variants of
|
|
5317
|
+
* the product.
|
|
5318
|
+
*/
|
|
5319
|
+
variant_media?: any;
|
|
5320
|
+
/**
|
|
5321
|
+
* - Variant-specific details for the product.
|
|
5322
|
+
*/
|
|
5323
|
+
variants?: any;
|
|
5324
|
+
/**
|
|
5325
|
+
* - Number of boxes required for packaging the product.
|
|
5326
|
+
*/
|
|
5327
|
+
no_of_boxes?: number;
|
|
5328
|
+
/**
|
|
5329
|
+
* - Custom JSON data associated with the product.
|
|
5330
|
+
*/
|
|
5331
|
+
_custom_json?: any;
|
|
5332
|
+
};
|
|
5333
|
+
/** @returns {NetQuantity} */
|
|
5334
|
+
declare function NetQuantity(): NetQuantity;
|
|
5335
|
+
type NetQuantity = {
|
|
5336
|
+
/**
|
|
5337
|
+
* - The quantity value of the product.
|
|
5338
|
+
*/
|
|
5339
|
+
value?: number;
|
|
5340
|
+
/**
|
|
5341
|
+
* - The unit of measurement for the quantity.
|
|
5342
|
+
*/
|
|
5343
|
+
unit?: string;
|
|
5344
|
+
};
|
|
5345
|
+
/** @returns {Trader} */
|
|
5346
|
+
declare function Trader(): Trader;
|
|
5347
|
+
type Trader = {
|
|
5348
|
+
/**
|
|
5349
|
+
* - Name of the trader.
|
|
5350
|
+
*/
|
|
5351
|
+
name?: string;
|
|
5352
|
+
/**
|
|
5353
|
+
* - Address of the trader.
|
|
5354
|
+
*/
|
|
5355
|
+
address?: string;
|
|
5356
|
+
};
|
|
5357
|
+
/** @returns {ProductPublish} */
|
|
5358
|
+
declare function ProductPublish(): ProductPublish;
|
|
5359
|
+
type ProductPublish = {
|
|
5360
|
+
/**
|
|
5361
|
+
* - Date when the product went online.
|
|
5362
|
+
*/
|
|
5363
|
+
product_online_date?: string;
|
|
5364
|
+
/**
|
|
5365
|
+
* - Indicates if the product is part of a set.
|
|
5366
|
+
*/
|
|
5367
|
+
is_set?: boolean;
|
|
5368
|
+
};
|
|
5369
|
+
/** @returns {TaxIdentifier} */
|
|
5370
|
+
declare function TaxIdentifier(): TaxIdentifier;
|
|
5371
|
+
type TaxIdentifier = {
|
|
5372
|
+
/**
|
|
5373
|
+
* - HSN code assigned to the product.
|
|
5374
|
+
*/
|
|
5375
|
+
hsn_code?: string;
|
|
5376
|
+
/**
|
|
5377
|
+
* - Identifier for the HSN code.
|
|
5378
|
+
*/
|
|
5379
|
+
hsn_code_id?: string;
|
|
5380
|
+
/**
|
|
5381
|
+
* - Reporting HSN code.
|
|
5382
|
+
*/
|
|
5383
|
+
reporting_hsn?: string;
|
|
5384
|
+
};
|
|
5385
|
+
/** @returns {ReturnConfig} */
|
|
5386
|
+
declare function ReturnConfig(): ReturnConfig;
|
|
5387
|
+
type ReturnConfig = {
|
|
5388
|
+
/**
|
|
5389
|
+
* - Indicates if the product is returnable.
|
|
5390
|
+
*/
|
|
5391
|
+
returnable?: boolean;
|
|
5392
|
+
/**
|
|
5393
|
+
* - Time duration allowed for returns.
|
|
5394
|
+
*/
|
|
5395
|
+
time?: number;
|
|
5396
|
+
/**
|
|
5397
|
+
* - Unit of time for return duration.
|
|
5398
|
+
*/
|
|
5399
|
+
unit?: string;
|
|
5400
|
+
};
|
|
5401
|
+
/** @returns {CustomOrder} */
|
|
5402
|
+
declare function CustomOrder(): CustomOrder;
|
|
5403
|
+
type CustomOrder = {
|
|
5404
|
+
/**
|
|
5405
|
+
* - Indicates if the product is a custom order.
|
|
5406
|
+
*/
|
|
5407
|
+
is_custom_order?: boolean;
|
|
5408
|
+
/**
|
|
5409
|
+
* - Time required for manufacturing the product.
|
|
5410
|
+
*/
|
|
5411
|
+
manufacturing_time?: number;
|
|
5412
|
+
/**
|
|
5413
|
+
* - Unit of time for manufacturing.
|
|
5414
|
+
*/
|
|
5415
|
+
manufacturing_time_unit?: string;
|
|
5416
|
+
};
|
|
5417
|
+
/** @returns {Size} */
|
|
5418
|
+
declare function Size(): Size;
|
|
5419
|
+
type Size = {
|
|
5420
|
+
/**
|
|
5421
|
+
* - Size label of the product.
|
|
5422
|
+
*/
|
|
5423
|
+
size?: string;
|
|
5424
|
+
/**
|
|
5425
|
+
* - Priority assigned to the size.
|
|
5426
|
+
*/
|
|
5427
|
+
size_priority?: number;
|
|
5428
|
+
/**
|
|
5429
|
+
* - Unit of measure for
|
|
5430
|
+
* item dimensions.
|
|
5431
|
+
*/
|
|
5432
|
+
item_dimensions_unit_of_measure?: string;
|
|
5433
|
+
/**
|
|
5434
|
+
* - Transfer price of the product.
|
|
5435
|
+
*/
|
|
5436
|
+
price_transfer?: number;
|
|
5437
|
+
/**
|
|
5438
|
+
* - Height of the product.
|
|
5439
|
+
*/
|
|
5440
|
+
item_height?: number;
|
|
5441
|
+
/**
|
|
5442
|
+
* - Length of the product.
|
|
5443
|
+
*/
|
|
5444
|
+
item_length?: number;
|
|
5445
|
+
/**
|
|
5446
|
+
* - Width of the product.
|
|
5447
|
+
*/
|
|
5448
|
+
item_width?: number;
|
|
5449
|
+
/**
|
|
5450
|
+
* - Weight of the product.
|
|
5451
|
+
*/
|
|
5452
|
+
item_weight?: number;
|
|
5453
|
+
/**
|
|
5454
|
+
* - Unit of measure for item weight.
|
|
5455
|
+
*/
|
|
5456
|
+
item_weight_unit_of_measure?: string;
|
|
5457
|
+
/**
|
|
5458
|
+
* - Selling price of the product.
|
|
5459
|
+
*/
|
|
5460
|
+
price?: number;
|
|
5461
|
+
/**
|
|
5462
|
+
* - Effective price after discounts.
|
|
5463
|
+
*/
|
|
5464
|
+
price_effective?: number;
|
|
5465
|
+
/**
|
|
5466
|
+
* - Indicates if the size belongs to a set.
|
|
5467
|
+
*/
|
|
5468
|
+
is_set?: boolean;
|
|
5469
|
+
/**
|
|
5470
|
+
* - Indicates if inventory tracking is enabled.
|
|
5471
|
+
*/
|
|
5472
|
+
track_inventory?: boolean;
|
|
5473
|
+
/**
|
|
5474
|
+
* - Unique identifiers associated with the size.
|
|
5475
|
+
*/
|
|
5476
|
+
identifiers?: Identifier[];
|
|
5477
|
+
/**
|
|
5478
|
+
* - Custom JSON data associated with the size.
|
|
5479
|
+
*/
|
|
5480
|
+
_custom_json?: any;
|
|
5481
|
+
};
|
|
5482
|
+
/** @returns {Identifier} */
|
|
5483
|
+
declare function Identifier(): Identifier;
|
|
5484
|
+
type Identifier = {
|
|
5485
|
+
/**
|
|
5486
|
+
* - Type of GTIN identifier (e.g., SKU, UPC, EAN).
|
|
5487
|
+
*/
|
|
5488
|
+
gtin_type?: string;
|
|
5489
|
+
/**
|
|
5490
|
+
* - Value of the GTIN identifier.
|
|
5491
|
+
*/
|
|
5492
|
+
gtin_value?: string;
|
|
5493
|
+
/**
|
|
5494
|
+
* - Indicates if this is the primary identifier.
|
|
5495
|
+
*/
|
|
5496
|
+
primary?: boolean;
|
|
5497
|
+
};
|
|
5498
|
+
/** @returns {Page} */
|
|
5499
|
+
declare function Page(): Page;
|
|
5500
|
+
type Page = {
|
|
5501
|
+
/**
|
|
5502
|
+
* - The total number of all items across all pages.
|
|
5503
|
+
*/
|
|
5504
|
+
item_total?: number;
|
|
5505
|
+
/**
|
|
5506
|
+
* - The identifier for the next page.
|
|
5507
|
+
*/
|
|
5508
|
+
next_id?: string;
|
|
5509
|
+
/**
|
|
5510
|
+
* - Indicates whether there is a previous page.
|
|
5511
|
+
*/
|
|
5512
|
+
has_previous?: boolean;
|
|
5513
|
+
/**
|
|
5514
|
+
* - Indicates whether there is a next page.
|
|
5515
|
+
*/
|
|
5516
|
+
has_next?: boolean;
|
|
5517
|
+
/**
|
|
5518
|
+
* - The current page number.
|
|
5519
|
+
*/
|
|
5520
|
+
current?: number;
|
|
5521
|
+
/**
|
|
5522
|
+
* - The type of the page, such as 'PageType'.
|
|
5523
|
+
*/
|
|
5524
|
+
type: string;
|
|
5525
|
+
/**
|
|
5526
|
+
* - The number of items per page.
|
|
5527
|
+
*/
|
|
5528
|
+
size?: number;
|
|
5529
|
+
/**
|
|
5530
|
+
* - The number of items per page.
|
|
5531
|
+
*/
|
|
5532
|
+
page_size?: number;
|
|
5533
|
+
};
|
|
5534
|
+
/** @returns {FulfillmentOptionStore} */
|
|
5535
|
+
declare function FulfillmentOptionStore(): FulfillmentOptionStore;
|
|
5536
|
+
type FulfillmentOptionStore = {
|
|
5537
|
+
/**
|
|
5538
|
+
* - Unique identifier for the store.
|
|
5539
|
+
*/
|
|
5540
|
+
uid?: number;
|
|
5541
|
+
address?: Address;
|
|
5542
|
+
/**
|
|
5543
|
+
* - The unique identifier of the company.
|
|
5544
|
+
*/
|
|
5545
|
+
company_id?: number;
|
|
5546
|
+
/**
|
|
5547
|
+
* - Store name displayed in the UI.
|
|
5548
|
+
*/
|
|
5549
|
+
display_name?: string;
|
|
5550
|
+
/**
|
|
5551
|
+
* - Name of the store.
|
|
5552
|
+
*/
|
|
5553
|
+
name?: string;
|
|
5554
|
+
/**
|
|
5555
|
+
* - Type of store (e.g., high_street, mall).
|
|
5556
|
+
*/
|
|
5557
|
+
store_type?: string;
|
|
5558
|
+
/**
|
|
5559
|
+
* - Tags associated with the store.
|
|
5560
|
+
*/
|
|
5561
|
+
tags?: string[];
|
|
5562
|
+
};
|
|
5563
|
+
/** @returns {Address} */
|
|
5564
|
+
declare function Address(): Address;
|
|
5565
|
+
type Address = {
|
|
5566
|
+
/**
|
|
5567
|
+
* - Primary address line.
|
|
5568
|
+
*/
|
|
5569
|
+
address1?: string;
|
|
5570
|
+
/**
|
|
5571
|
+
* - Country where the store is located.
|
|
5572
|
+
*/
|
|
5573
|
+
country?: string;
|
|
5574
|
+
/**
|
|
5575
|
+
* - Postal code of the store location.
|
|
5576
|
+
*/
|
|
5577
|
+
pincode?: string;
|
|
5578
|
+
/**
|
|
5579
|
+
* - City where the store is located.
|
|
5580
|
+
*/
|
|
5581
|
+
city?: string;
|
|
5582
|
+
/**
|
|
5583
|
+
* - State where the store is located.
|
|
5584
|
+
*/
|
|
5585
|
+
state?: string;
|
|
5586
|
+
/**
|
|
5587
|
+
* - Latitude coordinate of the store.
|
|
5588
|
+
*/
|
|
5589
|
+
latitude?: number;
|
|
5590
|
+
/**
|
|
5591
|
+
* - Longitude coordinate of the store.
|
|
5592
|
+
*/
|
|
5593
|
+
longitude?: number;
|
|
5594
|
+
/**
|
|
5595
|
+
* - ISO country code of the store location.
|
|
5596
|
+
*/
|
|
5597
|
+
country_code?: string;
|
|
5598
|
+
};
|
|
5599
|
+
/** @returns {FulfillmentOptionValidate} */
|
|
5600
|
+
declare function FulfillmentOptionValidate(): FulfillmentOptionValidate;
|
|
5601
|
+
type FulfillmentOptionValidate = {
|
|
5602
|
+
/**
|
|
5603
|
+
* - Type of entity filter applied.
|
|
5604
|
+
*/
|
|
5605
|
+
entity_filter_type?: string;
|
|
5606
|
+
/**
|
|
5607
|
+
* - Type of fulfillment option selected.
|
|
5608
|
+
*/
|
|
5609
|
+
fulfillment_option_type?: string;
|
|
5610
|
+
};
|
|
4701
5611
|
/** @returns {ProductSchema} */
|
|
4702
5612
|
declare function ProductSchema(): ProductSchema;
|
|
4703
5613
|
type ProductSchema = {
|
|
@@ -4768,11 +5678,11 @@ type ListViewItems = {
|
|
|
4768
5678
|
is_active: boolean;
|
|
4769
5679
|
product: ListViewProduct;
|
|
4770
5680
|
/**
|
|
4771
|
-
* -
|
|
5681
|
+
* - The unique identifier of the company.
|
|
4772
5682
|
*/
|
|
4773
5683
|
company_id: number;
|
|
4774
5684
|
/**
|
|
4775
|
-
* -
|
|
5685
|
+
* - The unique identifier of the application.
|
|
4776
5686
|
*/
|
|
4777
5687
|
application_id: string;
|
|
4778
5688
|
created_by: CreatedBy;
|
|
@@ -4847,42 +5757,6 @@ type RegionSchema = {
|
|
|
4847
5757
|
*/
|
|
4848
5758
|
count?: number;
|
|
4849
5759
|
};
|
|
4850
|
-
/** @returns {Page} */
|
|
4851
|
-
declare function Page(): Page;
|
|
4852
|
-
type Page = {
|
|
4853
|
-
/**
|
|
4854
|
-
* - The total number of all items across all pages.
|
|
4855
|
-
*/
|
|
4856
|
-
item_total?: number;
|
|
4857
|
-
/**
|
|
4858
|
-
* - The identifier for the next page.
|
|
4859
|
-
*/
|
|
4860
|
-
next_id?: string;
|
|
4861
|
-
/**
|
|
4862
|
-
* - Indicates whether there is a previous page.
|
|
4863
|
-
*/
|
|
4864
|
-
has_previous?: boolean;
|
|
4865
|
-
/**
|
|
4866
|
-
* - Indicates whether there is a next page.
|
|
4867
|
-
*/
|
|
4868
|
-
has_next?: boolean;
|
|
4869
|
-
/**
|
|
4870
|
-
* - The current page number.
|
|
4871
|
-
*/
|
|
4872
|
-
current?: number;
|
|
4873
|
-
/**
|
|
4874
|
-
* - The type of the page, such as 'PageType'.
|
|
4875
|
-
*/
|
|
4876
|
-
type: string;
|
|
4877
|
-
/**
|
|
4878
|
-
* - The number of items per page.
|
|
4879
|
-
*/
|
|
4880
|
-
size?: number;
|
|
4881
|
-
/**
|
|
4882
|
-
* - The number of items per page.
|
|
4883
|
-
*/
|
|
4884
|
-
page_size?: number;
|
|
4885
|
-
};
|
|
4886
5760
|
/** @returns {ZoneStores} */
|
|
4887
5761
|
declare function ZoneStores(): ZoneStores;
|
|
4888
5762
|
type ZoneStores = {
|