@gofynd/fdk-client-javascript 3.22.0 → 3.24.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.
Files changed (38) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/Cart/CartApplicationClient.d.ts +14 -14
  4. package/sdk/application/Cart/CartApplicationClient.js +124 -35
  5. package/sdk/application/Common/CommonApplicationClient.js +1 -1
  6. package/sdk/application/Logistic/LogisticApplicationClient.js +4 -2
  7. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +17 -17
  8. package/sdk/platform/Cart/CartPlatformApplicationClient.js +84 -13
  9. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +121 -0
  10. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +52 -0
  11. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +7 -2
  12. package/sdk/platform/Catalog/CatalogPlatformModel.js +5 -2
  13. package/sdk/platform/Common/CommonPlatformClient.js +1 -1
  14. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +96 -1
  15. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +61 -0
  16. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +0 -12
  17. package/sdk/platform/Content/ContentPlatformApplicationClient.js +0 -81
  18. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +1 -10
  19. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +0 -12
  20. package/sdk/platform/Order/OrderPlatformClient.d.ts +28 -0
  21. package/sdk/platform/Order/OrderPlatformClient.js +179 -3
  22. package/sdk/platform/Order/OrderPlatformModel.d.ts +155 -6
  23. package/sdk/platform/Order/OrderPlatformModel.js +105 -3
  24. package/sdk/platform/Order/OrderPlatformValidator.d.ts +33 -1
  25. package/sdk/platform/Order/OrderPlatformValidator.js +30 -0
  26. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +94 -0
  27. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +574 -0
  28. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +70 -1
  29. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +81 -0
  30. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +14 -0
  31. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +85 -0
  32. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1382 -187
  33. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +955 -155
  34. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +10 -1
  35. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +12 -0
  36. package/sdk/platform/User/UserPlatformModel.d.ts +14 -1
  37. package/sdk/platform/User/UserPlatformModel.js +16 -0
  38. package/sdk/public/Configuration/ConfigurationPublicClient.js +1 -1
@@ -1,4 +1,25 @@
1
1
  export = ServiceabilityPlatformModel;
2
+ /**
3
+ * @typedef GenerateShipmentsAndCourierPartnerResult
4
+ * @property {string} [journey] - Describes the shipment's journey or route.
5
+ * @property {CourierPartnerToServiceability} [to_serviceability]
6
+ * @property {CourierPartnerShipments[]} [shipments] - List of shipments
7
+ * generated for the courier partner.
8
+ * @property {string} [payment_mode] - Specifies the mode of payment for the shipment.
9
+ * @property {string} [to_city] - The destination city for the shipment.
10
+ * @property {boolean} [is_cod_available] - Indicates if cash on delivery (COD)
11
+ * is available.
12
+ */
13
+ /**
14
+ * @typedef CourierPartnerDetails
15
+ * @property {LocationDetailsServiceability} to_serviceability
16
+ * @property {CourierPartnerShipments[]} shipments - A list of shipments for the
17
+ * courier partner request.
18
+ * @property {string} journey - The journey details for the courier partner request.
19
+ * @property {string} [payment_mode] - The payment mode for the courier partner request.
20
+ * @property {boolean} [skip_delivery_rules] - This flag decided whether to run
21
+ * delivery rules configuration for delivery rule fetch or not.
22
+ */
2
23
  /**
3
24
  * @typedef PlatformShipmentsRequestSchema
4
25
  * @property {string} journey - The journey or route for the shipment.
@@ -31,6 +52,7 @@ export = ServiceabilityPlatformModel;
31
52
  * @property {boolean} [is_default] - Whether this is the default fulfillment option.
32
53
  * @property {string} [type] - Type of fulfillment option.
33
54
  * @property {string} [status] - Status of the fulfillment option.
55
+ * @property {FulfillmentOptionDefaultFor} [default_for]
34
56
  * @property {BusinessUnit[]} [business_unit] - Name of the ordering-channel or
35
57
  * business, e.g. storefront, storeos.
36
58
  * @property {FulfillmentStores} [fulfillment_stores]
@@ -1190,6 +1212,280 @@ export = ServiceabilityPlatformModel;
1190
1212
  * at delivery partner scheme level.
1191
1213
  * @property {string[]} [sort] - An array of strings specifying sorting preferences.
1192
1214
  */
1215
+ /**
1216
+ * @typedef StorePolygonServiceabilityRequestBody
1217
+ * @property {StorePolygonServiceabilityRequestData} data
1218
+ */
1219
+ /**
1220
+ * @typedef StorePolygonServiceabilityResult
1221
+ * @property {boolean} success - Indicates whether the polygon serviceability
1222
+ * operation was successful.
1223
+ * @property {StorePolygonServiceabilityStoreSummary[]} data - List of stores
1224
+ * for which polygon serviceability was successfully processed.
1225
+ * @property {StorePolygonServiceabilityError[]} errors - List of errors
1226
+ * encountered while processing individual entries, if any.
1227
+ * @property {string} identifier - Unique identifier for the polygon
1228
+ * serviceability request.
1229
+ * @property {StorePolygonServiceabilityError[]} failed_entries - List of
1230
+ * entries that failed during polygon serviceability processing.
1231
+ */
1232
+ /**
1233
+ * @typedef StorePolygonServiceabilityGetResult
1234
+ * @property {boolean} success - Indicates whether the polygon serviceability
1235
+ * fetch operation was successful.
1236
+ * @property {StorePolygonServiceabilityStore[]} data - List of stores with
1237
+ * their polygon-based serviceability details.
1238
+ * @property {StorePolygonServiceabilityError[]} errors - List of errors
1239
+ * encountered while processing individual entries, if any.
1240
+ * @property {string} identifier - Unique identifier for the polygon
1241
+ * serviceability request.
1242
+ * @property {StorePolygonServiceabilityError[]} failed_entries - List of
1243
+ * entries that failed during polygon serviceability processing.
1244
+ * @property {StorePolygonServiceabilityPagination} pagination - Pagination
1245
+ * details for the polygon serviceability result set.
1246
+ */
1247
+ /**
1248
+ * @typedef ZoneProductsBulkPatchDetails
1249
+ * @property {string} file_url - URL of the CSV file containing the zone
1250
+ * products bulk patch data.
1251
+ */
1252
+ /**
1253
+ * @typedef GetZoneProductsBulkPatchResult
1254
+ * @property {string} batch_id - A unique identifier for the performed batch operation.
1255
+ * @property {string} [file_path] - CDN path of the uploaded file.
1256
+ * @property {number} total - Total number of records in the batch.
1257
+ * @property {number} failed - Number of failed records in the batch.
1258
+ * @property {string} [error_file_url] - URL to the error file containing
1259
+ * details of failed records.
1260
+ * @property {string} action - The action performed during the bulk operation.
1261
+ * @property {string} updated_at - Timestamp when the batch was last updated.
1262
+ * @property {string} updated_by - User who last updated the batch.
1263
+ * @property {string} type - Type of the bulk operation.
1264
+ * @property {number} company_id - The unique identifier for the company.
1265
+ * @property {string} application_id - A unique identifier for the sales channel.
1266
+ * @property {string} stage - Current stage of the bulk operation.
1267
+ * @property {number} [partial] - Number of partially processed records.
1268
+ * @property {string} [result_file_url] - URL to the result file after
1269
+ * processing is complete.
1270
+ */
1271
+ /**
1272
+ * @typedef CourierPartnerToServiceability
1273
+ * @property {ServiceabilityLocation} [location]
1274
+ * @property {string} [pincode] - The pincode of the serviceability location.
1275
+ * @property {string} [sector] - The sector of the serviceability location.
1276
+ * @property {string} [country] - The country where the serviceability location
1277
+ * is situated.
1278
+ * @property {string} [country_iso_code] - The ISO code for the country.
1279
+ * @property {string} [state] - The state of the serviceability location.
1280
+ * @property {string} [city] - The city of the serviceability location.
1281
+ */
1282
+ /**
1283
+ * @typedef ServiceabilityLocation
1284
+ * @property {string} longitude - The longitude of the serviceability location.
1285
+ * @property {string} latitude - The latitude of the serviceability location.
1286
+ */
1287
+ /**
1288
+ * @typedef CourierPartnerShipments
1289
+ * @property {PromiseObject} [promise]
1290
+ * @property {boolean} [is_cod_available] - Indicates if cash on delivery (COD)
1291
+ * is available.
1292
+ * @property {boolean} [is_auto_assign] - Specifies if the shipment should be
1293
+ * automatically assigned.
1294
+ * @property {CourierPartnerShipmentsMeta} [meta]
1295
+ * @property {number} [volumetric_weight] - The volumetric weight of the shipment.
1296
+ * @property {number} [weight] - The actual weight of the shipment.
1297
+ * @property {ShipmentCourierPartnersResult[]} [courier_partners] - List of
1298
+ * courier partners associated with the shipment.
1299
+ * @property {number} fulfillment_id - The fulfillment Id.
1300
+ * @property {string} fulfillment_type - Fulfillment Type
1301
+ * @property {string[]} fulfillment_tags - Fulfillment level tags
1302
+ * @property {LocationDetailsServiceability} from_serviceability
1303
+ * @property {CourierPartnerShipmentsArticles[]} articles - A list of articles
1304
+ * in the courier partner shipment.
1305
+ * @property {boolean} is_mto - A boolean indicating if the courier partner
1306
+ * supports Made to Order service.
1307
+ * @property {string[]} ignore_scheme_ids - A list of scheme_id which we want to
1308
+ * ignore in courier_partner assignment.
1309
+ * @property {Object} [error] - Error Details
1310
+ */
1311
+ /**
1312
+ * @typedef PromiseObject
1313
+ * @property {string} [min] - The minimum promised delivery time in ISO 8601 format.
1314
+ * @property {string} [max] - The maximum promised delivery time in ISO 8601 format.
1315
+ * @property {PromiseData} customer_promise
1316
+ * @property {PromiseMeta} meta
1317
+ */
1318
+ /**
1319
+ * @typedef PromiseData
1320
+ * @property {string} [min] - The minimum promised delivery time in ISO 8601 format.
1321
+ * @property {string} [max] - The maximum promised delivery time in ISO 8601 format.
1322
+ */
1323
+ /**
1324
+ * @typedef PromiseMeta
1325
+ * @property {PromiseData} [seller_promise]
1326
+ * @property {CourierPartnerPromiseData} [courier_partner_promise]
1327
+ * @property {PromiseData} [customer_initial_promise]
1328
+ */
1329
+ /**
1330
+ * @typedef CourierPartnerPromiseData
1331
+ * @property {string} [min] - The minimum promised delivery time in ISO 8601 format.
1332
+ * @property {string} [max] - The maximum promised delivery time in ISO 8601 format.
1333
+ * @property {DeliveryTat} [attributes]
1334
+ */
1335
+ /**
1336
+ * @typedef DeliveryTat
1337
+ * @property {DeliveryTatSchema} [tat]
1338
+ */
1339
+ /**
1340
+ * @typedef DeliveryTatSchema
1341
+ * @property {number} [min] - The minimum tat in integer.
1342
+ * @property {number} [max] - The maximum tat in integer.
1343
+ */
1344
+ /**
1345
+ * @typedef CourierPartnerShipmentsMeta
1346
+ * @property {number} [shipment_cost] - The total cost associated with the
1347
+ * shipment, expressed as a floating-point number. This value includes all
1348
+ * applicable charges, such as transportation, handling, and any additional fees.
1349
+ */
1350
+ /**
1351
+ * @typedef ShipmentCourierPartnersResult
1352
+ * @property {string} extension_id - The Id of the courier partner.
1353
+ * @property {string} scheme_id - The scheme Id of the courier partner.
1354
+ * @property {AreaCode} area_code
1355
+ * @property {TAT} tat
1356
+ * @property {string} display_name - The display name of the courier partner.
1357
+ * @property {boolean} is_qc_enabled - A boolean indicating quality control by
1358
+ * the courier partner.
1359
+ * @property {boolean} is_self_ship - A boolean indicating it is self delivery DP support.
1360
+ * @property {boolean} [is_own_account] - Specifies if the courier partner
1361
+ * operates on its own account.
1362
+ * @property {number} [ndr_attempts] - The number of non-delivery report (NDR) attempts.
1363
+ * @property {string} [forward_pickup_cutoff] - Cutoff time for forward pickup (nullable).
1364
+ * @property {string} [reverse_pickup_cutoff] - Cutoff time for reverse pickup (nullable).
1365
+ * @property {number} [qc_shipment_item_quantity] - Quantity of items under
1366
+ * quality control (nullable).
1367
+ * @property {number} [non_qc_shipment_item_quantity] - Quantity of items not
1368
+ * under quality control (nullable).
1369
+ * @property {boolean} [dangerous_goods] - Specifies if the courier partner
1370
+ * operates on dangerous goods.
1371
+ * @property {boolean} [restricted_goods] - Specifies if the courier partner
1372
+ * operates on restricted goods.
1373
+ * @property {boolean} [fragile_goods] - Specifies if the courier partner
1374
+ * operates on fragile goods.
1375
+ * @property {boolean} [cold_storage_goods] - Specifies if the courier partner
1376
+ * operates on cold storage goods.
1377
+ * @property {string} [delivery_type] - Specifies type of courier partner.
1378
+ * @property {boolean} [is_cod] - Specifies if the courier partner operates on
1379
+ * cash on delivery orders.
1380
+ * @property {string} [transport_type] - Mode of transport associated with the
1381
+ * courier partner scheme.
1382
+ */
1383
+ /**
1384
+ * @typedef AreaCode
1385
+ * @property {string} [source] - The starting area code.
1386
+ * @property {string} [destination] - The ending area code.
1387
+ */
1388
+ /**
1389
+ * @typedef TAT
1390
+ * @property {number} [min] - The minimum tat in integer.
1391
+ * @property {number} [max] - The maximum tat in integer.
1392
+ */
1393
+ /**
1394
+ * @typedef LocationDetailsServiceability
1395
+ * @property {string} [pincode] - The pincode of the serviceability location.
1396
+ * @property {string} [sector] - The sector of the serviceability location.
1397
+ * @property {string} [state] - The state of the serviceability location.
1398
+ * @property {string} country - The country of the serviceability location.
1399
+ * @property {string} [city] - The city of the serviceability location.
1400
+ * @property {string} country_iso_code - The ISO code of the country.
1401
+ * @property {ServiceabilityLocation} [location]
1402
+ */
1403
+ /**
1404
+ * @typedef CourierPartnerShipmentsArticles
1405
+ * @property {string} [id] - A string serving as the unique identifier.
1406
+ * @property {Object} [delivery_slots] - Represents the delivery date and time
1407
+ * slots available for an article.
1408
+ * @property {Error} [error]
1409
+ * @property {number} [fulfillment_id] - The fulfillment Id.
1410
+ * @property {string[]} [fulfillment_tags] - Fulfillment level tags
1411
+ * @property {string} [fulfillment_type] - Fulfillment Type
1412
+ * @property {string} [group_id] - The group Id of the article.
1413
+ * @property {boolean} [is_gift] - A boolean indicating if the courier partner
1414
+ * supports gift shipments.
1415
+ * @property {boolean} [is_mto] - Flag indicating whether the shipment is MTO
1416
+ * (Make to Order).
1417
+ * @property {boolean} [is_set] - A boolean indicating whether the article is a set.
1418
+ * @property {number} [manufacturing_time] - The manufacturing time of the article.
1419
+ * @property {string} [manufacturing_time_unit] - The unit of measurement for
1420
+ * manufacturing time.
1421
+ * @property {number} [mto_quantity] - The Made to Order quantity of the article.
1422
+ * @property {string} [sla] - Service level agreement (SLA) for the article,
1423
+ * represented as a date-time
1424
+ * @property {number} [price_marked] - Marked price before discounts.
1425
+ * @property {CourierPartnerArticlesPromise} [promise]
1426
+ * @property {Object} [set] - Additional properties related to sets.
1427
+ * @property {CourierPartnerArticlesReturnReasons} [return_reason]
1428
+ * @property {number} [set_quantity] - It represents the number of set of this article
1429
+ * @property {number} quantity - The quantity of the shipment article.
1430
+ * @property {ArticleWeight} weight
1431
+ * @property {ArticleAttributes} [attributes]
1432
+ * @property {number} category_id - The category Id of the article.
1433
+ * @property {ArticleDimension} dimension
1434
+ * @property {number} brand_id - The brand Id of the article.
1435
+ * @property {number} item_id - The Item Id of the article.
1436
+ * @property {string} size - The size of the article.
1437
+ * @property {string[]} tags - Tags assigned to Item
1438
+ * @property {number} department_id - Department of the item
1439
+ * @property {number} price - Final Price of the article after discounts
1440
+ */
1441
+ /**
1442
+ * @typedef CourierPartnerArticlesPromise
1443
+ * @property {string} [min] - The minimum delivery promise date.
1444
+ * @property {string} [max] - The maximum delivery promise date.
1445
+ */
1446
+ /**
1447
+ * @typedef CourierPartnerArticlesReturnReasons
1448
+ * @property {number} [id] - The unique identifier for the return reason entry.
1449
+ * @property {CourierPartnerArticlesReturnReasonsMeta} [meta]
1450
+ * @property {string[]} [qc_type] - A list of quality check types that apply to
1451
+ * the return reasons.
1452
+ * @property {string[]} [reasons] - A list of return reasons for the article.
1453
+ * @property {boolean} [is_active] - A boolean indicating whether the return
1454
+ * reason is currently active.
1455
+ * @property {string} [display_name] - The display name for the return reason.
1456
+ * @property {string[]} [question_set] - A list of questions associated with the
1457
+ * return reason.
1458
+ * @property {string} [reason_other_text] - Any additional text for other return reasons.
1459
+ */
1460
+ /**
1461
+ * @typedef CourierPartnerArticlesReturnReasonsMeta
1462
+ * @property {boolean} [show_text_area] - A boolean indicating whether a text
1463
+ * area should be displayed for additional input regarding the return reason.
1464
+ */
1465
+ /**
1466
+ * @typedef ArticleWeight
1467
+ * @property {number} shipping - The weight(grams) of the article for shipping
1468
+ * purposes, typically measured in a specified unit.
1469
+ * @property {string} unit - The unit of measurement used for the weight value.
1470
+ * @property {boolean} is_default - A boolean indicating whether this weight is
1471
+ * the default weight for the article.
1472
+ */
1473
+ /**
1474
+ * @typedef ArticleAttributes
1475
+ * @property {string} battery_operated - Yes/no indicating whether the article
1476
+ * is powered by batteries.
1477
+ * @property {string} is_flammable - Yes/no indicating whether the article is
1478
+ * considered flammable or poses a fire hazard.
1479
+ */
1480
+ /**
1481
+ * @typedef ArticleDimension
1482
+ * @property {number} height - The height of the article.
1483
+ * @property {boolean} is_default - A boolean indicating whether this dimension
1484
+ * is the default dimension.
1485
+ * @property {number} length - The length of the article.
1486
+ * @property {string} unit - The unit of measurement used for the dimensions.
1487
+ * @property {number} width - The width of the article.
1488
+ */
1193
1489
  /**
1194
1490
  * @typedef PlatformLocationArticles
1195
1491
  * @property {PlatformLocationArticle[]} articles - List of articles for this
@@ -1386,14 +1682,11 @@ export = ServiceabilityPlatformModel;
1386
1682
  * under quality control (nullable).
1387
1683
  */
1388
1684
  /**
1389
- * @typedef AreaCode
1390
- * @property {string} [source] - The starting area code.
1391
- * @property {string} [destination] - The ending area code.
1392
- */
1393
- /**
1394
- * @typedef TAT
1395
- * @property {number} [min] - The minimum tat in integer.
1396
- * @property {number} [max] - The maximum tat in integer.
1685
+ * @typedef FulfillmentOptionDefaultFor
1686
+ * @property {boolean} [storefront] - If set to true, this fulfillment option
1687
+ * will be default for storefront.
1688
+ * @property {boolean} [storeos] - If set to true, this fulfillment option will
1689
+ * be default for storeos.
1397
1690
  */
1398
1691
  /**
1399
1692
  * @typedef BusinessUnit
@@ -1622,6 +1915,9 @@ export = ServiceabilityPlatformModel;
1622
1915
  * zone, whether it's a list of categories, departments, tags, or item_ids.
1623
1916
  * @property {Object[]} values - List of values representing the products or the
1624
1917
  * type of products selected for the delivery zone.
1918
+ * @property {string} [action] - The action to perform on the product values -
1919
+ * 'add' to add values to the existing list, 'remove' to remove values from
1920
+ * the existing list.
1625
1921
  */
1626
1922
  /**
1627
1923
  * @typedef StoresSchema
@@ -1985,30 +2281,6 @@ export = ServiceabilityPlatformModel;
1985
2281
  * @property {ArticleDeliverySlots} [delivery_slots]
1986
2282
  * @property {ArticleReturnReason} [return_reason]
1987
2283
  */
1988
- /**
1989
- * @typedef ArticleWeight
1990
- * @property {number} shipping - The weight(grams) of the article for shipping
1991
- * purposes, typically measured in a specified unit.
1992
- * @property {string} unit - The unit of measurement used for the weight value.
1993
- * @property {boolean} is_default - A boolean indicating whether this weight is
1994
- * the default weight for the article.
1995
- */
1996
- /**
1997
- * @typedef ArticleAttributes
1998
- * @property {string} battery_operated - Yes/no indicating whether the article
1999
- * is powered by batteries.
2000
- * @property {string} is_flammable - Yes/no indicating whether the article is
2001
- * considered flammable or poses a fire hazard.
2002
- */
2003
- /**
2004
- * @typedef ArticleDimension
2005
- * @property {number} height - The height of the article.
2006
- * @property {boolean} is_default - A boolean indicating whether this dimension
2007
- * is the default dimension.
2008
- * @property {number} length - The length of the article.
2009
- * @property {string} unit - The unit of measurement used for the dimensions.
2010
- * @property {number} width - The width of the article.
2011
- */
2012
2284
  /**
2013
2285
  * @typedef ArticleSet
2014
2286
  * @property {string} [name] - The name of the article set.
@@ -2248,21 +2520,6 @@ export = ServiceabilityPlatformModel;
2248
2520
  * @property {string} [strategy] - The strategy parameter allows users to
2249
2521
  * specify the desired approach or criteria for selecting optimal locations.
2250
2522
  */
2251
- /**
2252
- * @typedef LocationDetailsServiceability
2253
- * @property {string} [pincode] - The pincode of the serviceability location.
2254
- * @property {string} [sector] - The sector of the serviceability location.
2255
- * @property {string} [state] - The state of the serviceability location.
2256
- * @property {string} country - The country of the serviceability location.
2257
- * @property {string} [city] - The city of the serviceability location.
2258
- * @property {string} country_iso_code - The ISO code of the country.
2259
- * @property {ServiceabilityLocation} [location]
2260
- */
2261
- /**
2262
- * @typedef ServiceabilityLocation
2263
- * @property {string} longitude - The longitude of the serviceability location.
2264
- * @property {string} latitude - The latitude of the serviceability location.
2265
- */
2266
2523
  /**
2267
2524
  * @typedef OptimalLocationsArticles
2268
2525
  * @property {number} item_id - Unique identifier for the item.
@@ -2536,11 +2793,152 @@ export = ServiceabilityPlatformModel;
2536
2793
  * @property {number} [total_error_count] - The number of items or entities that
2537
2794
  * encountered errors during the batch processing.
2538
2795
  */
2796
+ /**
2797
+ * @typedef StorePolygonServiceabilityRequestData
2798
+ * @property {StorePolygonServiceabilityStore[]} stores - List of stores for
2799
+ * which polygon-based serviceability is being configured.
2800
+ */
2801
+ /**
2802
+ * @typedef StorePolygonServiceabilityStore
2803
+ * @property {string} store_code - Unique identifier of the store.
2804
+ * @property {string} name - Name of the store.
2805
+ * @property {string} address - Address of the store.
2806
+ * @property {string} area_code - Area code associated with the store.
2807
+ * @property {boolean} is_active - Indicates whether the store is active.
2808
+ * @property {Object} [meta] - Additional metadata associated with the store.
2809
+ * @property {StorePolygonServiceabilityStoreCoordinates} coordinates
2810
+ * @property {StorePolygonServiceabilityConfig[]} serviceabilities - List of
2811
+ * polygon-based serviceability configurations for the store.
2812
+ * @property {string} [created_at] - Timestamp when the store entry was created.
2813
+ * @property {string} [updated_at] - Timestamp when the store entry was last updated.
2814
+ */
2815
+ /**
2816
+ * @typedef StorePolygonServiceabilityStoreCoordinates
2817
+ * @property {number} lng - Longitude of the store.
2818
+ * @property {number} lat - Latitude of the store.
2819
+ */
2820
+ /**
2821
+ * @typedef StorePolygonServiceabilityConfig
2822
+ * @property {string} name - Name of the polygon-based serviceability configuration.
2823
+ * @property {string} serviceability_type - Type of serviceability
2824
+ * configuration. Currently supports quick_commerce.
2825
+ * @property {StorePolygonServiceabilityPolygon} polygon
2826
+ * @property {Object} [meta] - Additional metadata associated with the
2827
+ * serviceability configuration.
2828
+ * @property {boolean} is_active - Indicates whether the serviceability
2829
+ * configuration is active.
2830
+ * @property {string} [uid] - Unique identifier of the serviceability configuration.
2831
+ * @property {string} [created_at] - Timestamp when the serviceability
2832
+ * configuration was created.
2833
+ * @property {string} [updated_at] - Timestamp when the serviceability
2834
+ * configuration was last updated.
2835
+ */
2836
+ /**
2837
+ * @typedef StorePolygonServiceabilityPolygon
2838
+ * @property {string} type - Type of the GeoJSON collection, typically FeatureCollection.
2839
+ * @property {StorePolygonServiceabilityFeature[]} features - List of GeoJSON
2840
+ * features defining the polygon.
2841
+ * @property {StorePolygonServiceabilityAttributes} [attributes]
2842
+ */
2843
+ /**
2844
+ * @typedef StorePolygonServiceabilityFeature
2845
+ * @property {string} type - Type of the feature, typically Feature.
2846
+ * @property {Object} [properties] - Additional properties for the feature.
2847
+ * @property {StorePolygonServiceabilityGeometry} geometry
2848
+ */
2849
+ /**
2850
+ * @typedef StorePolygonServiceabilityGeometry
2851
+ * @property {string} [type] - Type of geometry, typically Polygon.
2852
+ * @property {number[][][]} [coordinates] - List of polygon coordinates as
2853
+ * longitude and latitude pairs.
2854
+ */
2855
+ /**
2856
+ * @typedef StorePolygonServiceabilityAttributes
2857
+ * @property {string} [contour_type] - Type of contour used for the polygon,
2858
+ * either distance-based or manually defined.
2859
+ * @property {number} [travel_distance] - Travel distance used to derive the
2860
+ * polygon contour, typically in meters.
2861
+ * @property {StorePolygonServiceabilityReferenceCoordinates} [reference_coordinates]
2862
+ */
2863
+ /**
2864
+ * @typedef StorePolygonServiceabilityReferenceCoordinates
2865
+ * @property {number} lng - Longitude of the reference point.
2866
+ * @property {number} lat - Latitude of the reference point.
2867
+ */
2868
+ /**
2869
+ * @typedef StorePolygonServiceabilityStoreSummary
2870
+ * @property {string} store_code - Unique identifier of the store.
2871
+ * @property {string} [name] - Name of the store.
2872
+ */
2873
+ /**
2874
+ * @typedef StorePolygonServiceabilityError
2875
+ * @property {string} store_code - Store code identifier.
2876
+ * @property {string} message - Detailed error message describing the validation
2877
+ * failure for a specific record.
2878
+ * @property {string} [error_code] - Error code for the failure.
2879
+ */
2880
+ /**
2881
+ * @typedef StorePolygonServiceabilityPagination
2882
+ * @property {number} page_size - Number of records per page.
2883
+ * @property {number} page_number - The current page number.
2884
+ * @property {boolean} has_next - Indicates whether more pages are available.
2885
+ * @property {number} total_records - Total number of records matching the criteria.
2886
+ */
2539
2887
  declare class ServiceabilityPlatformModel {
2540
2888
  }
2541
2889
  declare namespace ServiceabilityPlatformModel {
2542
- export { PlatformShipmentsRequestSchema, PlatformShipmentsResponseSchema, ShipmentsErrorResult, FulfillmentOption, FulfillmentOptionsList, 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, PlatformLocationArticles, PlatformLocationArticle, ParentItemIdentifiers, PlatformShipmentsToServiceability, PlatformShipmentsSchema, Packaging, Dimension, FulfillmentOptionItem, ShipmentsPromise, CustomerPromise, ShipmentPromiseMeta, SellerPromise, CourierPartnerPromise, CourierPartnerAttributes, CourierPartnerTAT, CustomerInitialPromise, ShipmentsArticle, ShipmentDimension, ShipmentsMeta, ShipmentsCourierPartner, AreaCode, TAT, BusinessUnit, FulfillmentStores, FulfillmentProducts, CourierPartnerSchemes, CourierPartnerScheme, FulfillmentOptionProduct, NetQuantity, Trader, ProductPublish, TaxIdentifier, ReturnConfig, CustomOrder, Size, Identifier, Page, FulfillmentOptionStore, Address, LatLong, StoreDistance, StoreTimingDetails, StoreTiming, Time, 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, DateOperations, ArithmeticOperations, CourierPartnerRuleCPListResult, CourierPartnerSchemeDefaultTat, CourierPartnerSchemeTat, CourierPartnerSchemeFeatures, CourierPartnerList, ShipmentsCourierPartnersServiceability, CPShipments, ShipmentsArticles, ArticleWeight, ArticleAttributes, ArticleDimension, ArticleSet, ArticleSizeDistribution, SetSize, ArticleDeliverySlots, ArticleReturnReason, CourierPartners, ShipmentCourierPartners, CourierPartnerConfig, BuyboxRuleConfig, PromiseConfig, StorePromiseAttributeConfig, DeliveryServiceAttributeConfig, BufferField, StorePrioritySchema, StoreRuleConditionSchema, CustomerRadiusSchema, 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 };
2890
+ export { GenerateShipmentsAndCourierPartnerResult, CourierPartnerDetails, PlatformShipmentsRequestSchema, PlatformShipmentsResponseSchema, ShipmentsErrorResult, FulfillmentOption, FulfillmentOptionsList, 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, StorePolygonServiceabilityRequestBody, StorePolygonServiceabilityResult, StorePolygonServiceabilityGetResult, ZoneProductsBulkPatchDetails, GetZoneProductsBulkPatchResult, CourierPartnerToServiceability, ServiceabilityLocation, CourierPartnerShipments, PromiseObject, PromiseData, PromiseMeta, CourierPartnerPromiseData, DeliveryTat, DeliveryTatSchema, CourierPartnerShipmentsMeta, ShipmentCourierPartnersResult, AreaCode, TAT, LocationDetailsServiceability, CourierPartnerShipmentsArticles, CourierPartnerArticlesPromise, CourierPartnerArticlesReturnReasons, CourierPartnerArticlesReturnReasonsMeta, ArticleWeight, ArticleAttributes, ArticleDimension, PlatformLocationArticles, PlatformLocationArticle, ParentItemIdentifiers, PlatformShipmentsToServiceability, PlatformShipmentsSchema, Packaging, Dimension, FulfillmentOptionItem, ShipmentsPromise, CustomerPromise, ShipmentPromiseMeta, SellerPromise, CourierPartnerPromise, CourierPartnerAttributes, CourierPartnerTAT, CustomerInitialPromise, ShipmentsArticle, ShipmentDimension, ShipmentsMeta, ShipmentsCourierPartner, FulfillmentOptionDefaultFor, BusinessUnit, FulfillmentStores, FulfillmentProducts, CourierPartnerSchemes, CourierPartnerScheme, FulfillmentOptionProduct, NetQuantity, Trader, ProductPublish, TaxIdentifier, ReturnConfig, CustomOrder, Size, Identifier, Page, FulfillmentOptionStore, Address, LatLong, StoreDistance, StoreTimingDetails, StoreTiming, Time, 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, DateOperations, ArithmeticOperations, CourierPartnerRuleCPListResult, CourierPartnerSchemeDefaultTat, CourierPartnerSchemeTat, CourierPartnerSchemeFeatures, CourierPartnerList, ShipmentsCourierPartnersServiceability, CPShipments, ShipmentsArticles, ArticleSet, ArticleSizeDistribution, SetSize, ArticleDeliverySlots, ArticleReturnReason, CourierPartners, ShipmentCourierPartners, CourierPartnerConfig, BuyboxRuleConfig, PromiseConfig, StorePromiseAttributeConfig, DeliveryServiceAttributeConfig, BufferField, StorePrioritySchema, StoreRuleConditionSchema, CustomerRadiusSchema, CourierPartnerSchemeModel, PackageMaterialRule, PackageMaterialRuleQuantity, Channel, PackageRuleCategory, PackageRuleProduct, PackageRuleProductTag, PackageRuleDepartmentId, PackageRuleProductAttributes, PackageChannel, StoreFilter, PackageRuleSchema, Quantity, PackagePageInfo, OptimalLocationAssignedStoresResult, OptimalLocationArticlesResult, ArticleAssignment, 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, StorePolygonServiceabilityRequestData, StorePolygonServiceabilityStore, StorePolygonServiceabilityStoreCoordinates, StorePolygonServiceabilityConfig, StorePolygonServiceabilityPolygon, StorePolygonServiceabilityFeature, StorePolygonServiceabilityGeometry, StorePolygonServiceabilityAttributes, StorePolygonServiceabilityReferenceCoordinates, StorePolygonServiceabilityStoreSummary, StorePolygonServiceabilityError, StorePolygonServiceabilityPagination };
2543
2891
  }
2892
+ /** @returns {GenerateShipmentsAndCourierPartnerResult} */
2893
+ declare function GenerateShipmentsAndCourierPartnerResult(): GenerateShipmentsAndCourierPartnerResult;
2894
+ type GenerateShipmentsAndCourierPartnerResult = {
2895
+ /**
2896
+ * - Describes the shipment's journey or route.
2897
+ */
2898
+ journey?: string;
2899
+ to_serviceability?: CourierPartnerToServiceability;
2900
+ /**
2901
+ * - List of shipments
2902
+ * generated for the courier partner.
2903
+ */
2904
+ shipments?: CourierPartnerShipments[];
2905
+ /**
2906
+ * - Specifies the mode of payment for the shipment.
2907
+ */
2908
+ payment_mode?: string;
2909
+ /**
2910
+ * - The destination city for the shipment.
2911
+ */
2912
+ to_city?: string;
2913
+ /**
2914
+ * - Indicates if cash on delivery (COD)
2915
+ * is available.
2916
+ */
2917
+ is_cod_available?: boolean;
2918
+ };
2919
+ /** @returns {CourierPartnerDetails} */
2920
+ declare function CourierPartnerDetails(): CourierPartnerDetails;
2921
+ type CourierPartnerDetails = {
2922
+ to_serviceability: LocationDetailsServiceability;
2923
+ /**
2924
+ * - A list of shipments for the
2925
+ * courier partner request.
2926
+ */
2927
+ shipments: CourierPartnerShipments[];
2928
+ /**
2929
+ * - The journey details for the courier partner request.
2930
+ */
2931
+ journey: string;
2932
+ /**
2933
+ * - The payment mode for the courier partner request.
2934
+ */
2935
+ payment_mode?: string;
2936
+ /**
2937
+ * - This flag decided whether to run
2938
+ * delivery rules configuration for delivery rule fetch or not.
2939
+ */
2940
+ skip_delivery_rules?: boolean;
2941
+ };
2544
2942
  /** @returns {PlatformShipmentsRequestSchema} */
2545
2943
  declare function PlatformShipmentsRequestSchema(): PlatformShipmentsRequestSchema;
2546
2944
  type PlatformShipmentsRequestSchema = {
@@ -2625,6 +3023,7 @@ type FulfillmentOption = {
2625
3023
  * - Status of the fulfillment option.
2626
3024
  */
2627
3025
  status?: string;
3026
+ default_for?: FulfillmentOptionDefaultFor;
2628
3027
  /**
2629
3028
  * - Name of the ordering-channel or
2630
3029
  * business, e.g. storefront, storeos.
@@ -5491,42 +5890,723 @@ type CompanyConfigurationSchema = {
5491
5890
  */
5492
5891
  sort?: string[];
5493
5892
  };
5494
- /** @returns {PlatformLocationArticles} */
5495
- declare function PlatformLocationArticles(): PlatformLocationArticles;
5496
- type PlatformLocationArticles = {
5893
+ /** @returns {StorePolygonServiceabilityRequestBody} */
5894
+ declare function StorePolygonServiceabilityRequestBody(): StorePolygonServiceabilityRequestBody;
5895
+ type StorePolygonServiceabilityRequestBody = {
5896
+ data: StorePolygonServiceabilityRequestData;
5897
+ };
5898
+ /** @returns {StorePolygonServiceabilityResult} */
5899
+ declare function StorePolygonServiceabilityResult(): StorePolygonServiceabilityResult;
5900
+ type StorePolygonServiceabilityResult = {
5497
5901
  /**
5498
- * - List of articles for this
5499
- * fulfillment location.
5902
+ * - Indicates whether the polygon serviceability
5903
+ * operation was successful.
5500
5904
  */
5501
- articles: PlatformLocationArticle[];
5905
+ success: boolean;
5502
5906
  /**
5503
- * - Unique identifier for the
5504
- * fulfillment location.
5907
+ * - List of stores
5908
+ * for which polygon serviceability was successfully processed.
5505
5909
  */
5506
- fulfillment_location_id: number;
5910
+ data: StorePolygonServiceabilityStoreSummary[];
5507
5911
  /**
5508
- * - Tags associated with the
5509
- * fulfillment location.
5912
+ * - List of errors
5913
+ * encountered while processing individual entries, if any.
5510
5914
  */
5511
- fulfillment_tags?: string[];
5915
+ errors: StorePolygonServiceabilityError[];
5512
5916
  /**
5513
- * - Type of fulfillment (e.g., store, warehouse).
5917
+ * - Unique identifier for the polygon
5918
+ * serviceability request.
5514
5919
  */
5515
- fulfillment_type: string;
5920
+ identifier: string;
5921
+ /**
5922
+ * - List of
5923
+ * entries that failed during polygon serviceability processing.
5924
+ */
5925
+ failed_entries: StorePolygonServiceabilityError[];
5516
5926
  };
5517
- /** @returns {PlatformLocationArticle} */
5518
- declare function PlatformLocationArticle(): PlatformLocationArticle;
5519
- type PlatformLocationArticle = {
5927
+ /** @returns {StorePolygonServiceabilityGetResult} */
5928
+ declare function StorePolygonServiceabilityGetResult(): StorePolygonServiceabilityGetResult;
5929
+ type StorePolygonServiceabilityGetResult = {
5520
5930
  /**
5521
- * - The price of the article.
5931
+ * - Indicates whether the polygon serviceability
5932
+ * fetch operation was successful.
5522
5933
  */
5523
- price: number;
5934
+ success: boolean;
5524
5935
  /**
5525
- * - Unique identifier for the item.
5936
+ * - List of stores with
5937
+ * their polygon-based serviceability details.
5526
5938
  */
5527
- item_id: number;
5939
+ data: StorePolygonServiceabilityStore[];
5528
5940
  /**
5529
- * - The size of the article.
5941
+ * - List of errors
5942
+ * encountered while processing individual entries, if any.
5943
+ */
5944
+ errors: StorePolygonServiceabilityError[];
5945
+ /**
5946
+ * - Unique identifier for the polygon
5947
+ * serviceability request.
5948
+ */
5949
+ identifier: string;
5950
+ /**
5951
+ * - List of
5952
+ * entries that failed during polygon serviceability processing.
5953
+ */
5954
+ failed_entries: StorePolygonServiceabilityError[];
5955
+ /**
5956
+ * - Pagination
5957
+ * details for the polygon serviceability result set.
5958
+ */
5959
+ pagination: StorePolygonServiceabilityPagination;
5960
+ };
5961
+ /** @returns {ZoneProductsBulkPatchDetails} */
5962
+ declare function ZoneProductsBulkPatchDetails(): ZoneProductsBulkPatchDetails;
5963
+ type ZoneProductsBulkPatchDetails = {
5964
+ /**
5965
+ * - URL of the CSV file containing the zone
5966
+ * products bulk patch data.
5967
+ */
5968
+ file_url: string;
5969
+ };
5970
+ /** @returns {GetZoneProductsBulkPatchResult} */
5971
+ declare function GetZoneProductsBulkPatchResult(): GetZoneProductsBulkPatchResult;
5972
+ type GetZoneProductsBulkPatchResult = {
5973
+ /**
5974
+ * - A unique identifier for the performed batch operation.
5975
+ */
5976
+ batch_id: string;
5977
+ /**
5978
+ * - CDN path of the uploaded file.
5979
+ */
5980
+ file_path?: string;
5981
+ /**
5982
+ * - Total number of records in the batch.
5983
+ */
5984
+ total: number;
5985
+ /**
5986
+ * - Number of failed records in the batch.
5987
+ */
5988
+ failed: number;
5989
+ /**
5990
+ * - URL to the error file containing
5991
+ * details of failed records.
5992
+ */
5993
+ error_file_url?: string;
5994
+ /**
5995
+ * - The action performed during the bulk operation.
5996
+ */
5997
+ action: string;
5998
+ /**
5999
+ * - Timestamp when the batch was last updated.
6000
+ */
6001
+ updated_at: string;
6002
+ /**
6003
+ * - User who last updated the batch.
6004
+ */
6005
+ updated_by: string;
6006
+ /**
6007
+ * - Type of the bulk operation.
6008
+ */
6009
+ type: string;
6010
+ /**
6011
+ * - The unique identifier for the company.
6012
+ */
6013
+ company_id: number;
6014
+ /**
6015
+ * - A unique identifier for the sales channel.
6016
+ */
6017
+ application_id: string;
6018
+ /**
6019
+ * - Current stage of the bulk operation.
6020
+ */
6021
+ stage: string;
6022
+ /**
6023
+ * - Number of partially processed records.
6024
+ */
6025
+ partial?: number;
6026
+ /**
6027
+ * - URL to the result file after
6028
+ * processing is complete.
6029
+ */
6030
+ result_file_url?: string;
6031
+ };
6032
+ /** @returns {CourierPartnerToServiceability} */
6033
+ declare function CourierPartnerToServiceability(): CourierPartnerToServiceability;
6034
+ type CourierPartnerToServiceability = {
6035
+ location?: ServiceabilityLocation;
6036
+ /**
6037
+ * - The pincode of the serviceability location.
6038
+ */
6039
+ pincode?: string;
6040
+ /**
6041
+ * - The sector of the serviceability location.
6042
+ */
6043
+ sector?: string;
6044
+ /**
6045
+ * - The country where the serviceability location
6046
+ * is situated.
6047
+ */
6048
+ country?: string;
6049
+ /**
6050
+ * - The ISO code for the country.
6051
+ */
6052
+ country_iso_code?: string;
6053
+ /**
6054
+ * - The state of the serviceability location.
6055
+ */
6056
+ state?: string;
6057
+ /**
6058
+ * - The city of the serviceability location.
6059
+ */
6060
+ city?: string;
6061
+ };
6062
+ /** @returns {ServiceabilityLocation} */
6063
+ declare function ServiceabilityLocation(): ServiceabilityLocation;
6064
+ type ServiceabilityLocation = {
6065
+ /**
6066
+ * - The longitude of the serviceability location.
6067
+ */
6068
+ longitude: string;
6069
+ /**
6070
+ * - The latitude of the serviceability location.
6071
+ */
6072
+ latitude: string;
6073
+ };
6074
+ /** @returns {CourierPartnerShipments} */
6075
+ declare function CourierPartnerShipments(): CourierPartnerShipments;
6076
+ type CourierPartnerShipments = {
6077
+ promise?: PromiseObject;
6078
+ /**
6079
+ * - Indicates if cash on delivery (COD)
6080
+ * is available.
6081
+ */
6082
+ is_cod_available?: boolean;
6083
+ /**
6084
+ * - Specifies if the shipment should be
6085
+ * automatically assigned.
6086
+ */
6087
+ is_auto_assign?: boolean;
6088
+ meta?: CourierPartnerShipmentsMeta;
6089
+ /**
6090
+ * - The volumetric weight of the shipment.
6091
+ */
6092
+ volumetric_weight?: number;
6093
+ /**
6094
+ * - The actual weight of the shipment.
6095
+ */
6096
+ weight?: number;
6097
+ /**
6098
+ * - List of
6099
+ * courier partners associated with the shipment.
6100
+ */
6101
+ courier_partners?: ShipmentCourierPartnersResult[];
6102
+ /**
6103
+ * - The fulfillment Id.
6104
+ */
6105
+ fulfillment_id: number;
6106
+ /**
6107
+ * - Fulfillment Type
6108
+ */
6109
+ fulfillment_type: string;
6110
+ /**
6111
+ * - Fulfillment level tags
6112
+ */
6113
+ fulfillment_tags: string[];
6114
+ from_serviceability: LocationDetailsServiceability;
6115
+ /**
6116
+ * - A list of articles
6117
+ * in the courier partner shipment.
6118
+ */
6119
+ articles: CourierPartnerShipmentsArticles[];
6120
+ /**
6121
+ * - A boolean indicating if the courier partner
6122
+ * supports Made to Order service.
6123
+ */
6124
+ is_mto: boolean;
6125
+ /**
6126
+ * - A list of scheme_id which we want to
6127
+ * ignore in courier_partner assignment.
6128
+ */
6129
+ ignore_scheme_ids: string[];
6130
+ /**
6131
+ * - Error Details
6132
+ */
6133
+ error?: any;
6134
+ };
6135
+ /** @returns {PromiseObject} */
6136
+ declare function PromiseObject(): PromiseObject;
6137
+ type PromiseObject = {
6138
+ /**
6139
+ * - The minimum promised delivery time in ISO 8601 format.
6140
+ */
6141
+ min?: string;
6142
+ /**
6143
+ * - The maximum promised delivery time in ISO 8601 format.
6144
+ */
6145
+ max?: string;
6146
+ customer_promise: PromiseData;
6147
+ meta: PromiseMeta;
6148
+ };
6149
+ /** @returns {PromiseData} */
6150
+ declare function PromiseData(): PromiseData;
6151
+ type PromiseData = {
6152
+ /**
6153
+ * - The minimum promised delivery time in ISO 8601 format.
6154
+ */
6155
+ min?: string;
6156
+ /**
6157
+ * - The maximum promised delivery time in ISO 8601 format.
6158
+ */
6159
+ max?: string;
6160
+ };
6161
+ /** @returns {PromiseMeta} */
6162
+ declare function PromiseMeta(): PromiseMeta;
6163
+ type PromiseMeta = {
6164
+ seller_promise?: PromiseData;
6165
+ courier_partner_promise?: CourierPartnerPromiseData;
6166
+ customer_initial_promise?: PromiseData;
6167
+ };
6168
+ /** @returns {CourierPartnerPromiseData} */
6169
+ declare function CourierPartnerPromiseData(): CourierPartnerPromiseData;
6170
+ type CourierPartnerPromiseData = {
6171
+ /**
6172
+ * - The minimum promised delivery time in ISO 8601 format.
6173
+ */
6174
+ min?: string;
6175
+ /**
6176
+ * - The maximum promised delivery time in ISO 8601 format.
6177
+ */
6178
+ max?: string;
6179
+ attributes?: DeliveryTat;
6180
+ };
6181
+ /** @returns {DeliveryTat} */
6182
+ declare function DeliveryTat(): DeliveryTat;
6183
+ type DeliveryTat = {
6184
+ tat?: DeliveryTatSchema;
6185
+ };
6186
+ /** @returns {DeliveryTatSchema} */
6187
+ declare function DeliveryTatSchema(): DeliveryTatSchema;
6188
+ type DeliveryTatSchema = {
6189
+ /**
6190
+ * - The minimum tat in integer.
6191
+ */
6192
+ min?: number;
6193
+ /**
6194
+ * - The maximum tat in integer.
6195
+ */
6196
+ max?: number;
6197
+ };
6198
+ /** @returns {CourierPartnerShipmentsMeta} */
6199
+ declare function CourierPartnerShipmentsMeta(): CourierPartnerShipmentsMeta;
6200
+ type CourierPartnerShipmentsMeta = {
6201
+ /**
6202
+ * - The total cost associated with the
6203
+ * shipment, expressed as a floating-point number. This value includes all
6204
+ * applicable charges, such as transportation, handling, and any additional fees.
6205
+ */
6206
+ shipment_cost?: number;
6207
+ };
6208
+ /** @returns {ShipmentCourierPartnersResult} */
6209
+ declare function ShipmentCourierPartnersResult(): ShipmentCourierPartnersResult;
6210
+ type ShipmentCourierPartnersResult = {
6211
+ /**
6212
+ * - The Id of the courier partner.
6213
+ */
6214
+ extension_id: string;
6215
+ /**
6216
+ * - The scheme Id of the courier partner.
6217
+ */
6218
+ scheme_id: string;
6219
+ area_code: AreaCode;
6220
+ tat: TAT;
6221
+ /**
6222
+ * - The display name of the courier partner.
6223
+ */
6224
+ display_name: string;
6225
+ /**
6226
+ * - A boolean indicating quality control by
6227
+ * the courier partner.
6228
+ */
6229
+ is_qc_enabled: boolean;
6230
+ /**
6231
+ * - A boolean indicating it is self delivery DP support.
6232
+ */
6233
+ is_self_ship: boolean;
6234
+ /**
6235
+ * - Specifies if the courier partner
6236
+ * operates on its own account.
6237
+ */
6238
+ is_own_account?: boolean;
6239
+ /**
6240
+ * - The number of non-delivery report (NDR) attempts.
6241
+ */
6242
+ ndr_attempts?: number;
6243
+ /**
6244
+ * - Cutoff time for forward pickup (nullable).
6245
+ */
6246
+ forward_pickup_cutoff?: string;
6247
+ /**
6248
+ * - Cutoff time for reverse pickup (nullable).
6249
+ */
6250
+ reverse_pickup_cutoff?: string;
6251
+ /**
6252
+ * - Quantity of items under
6253
+ * quality control (nullable).
6254
+ */
6255
+ qc_shipment_item_quantity?: number;
6256
+ /**
6257
+ * - Quantity of items not
6258
+ * under quality control (nullable).
6259
+ */
6260
+ non_qc_shipment_item_quantity?: number;
6261
+ /**
6262
+ * - Specifies if the courier partner
6263
+ * operates on dangerous goods.
6264
+ */
6265
+ dangerous_goods?: boolean;
6266
+ /**
6267
+ * - Specifies if the courier partner
6268
+ * operates on restricted goods.
6269
+ */
6270
+ restricted_goods?: boolean;
6271
+ /**
6272
+ * - Specifies if the courier partner
6273
+ * operates on fragile goods.
6274
+ */
6275
+ fragile_goods?: boolean;
6276
+ /**
6277
+ * - Specifies if the courier partner
6278
+ * operates on cold storage goods.
6279
+ */
6280
+ cold_storage_goods?: boolean;
6281
+ /**
6282
+ * - Specifies type of courier partner.
6283
+ */
6284
+ delivery_type?: string;
6285
+ /**
6286
+ * - Specifies if the courier partner operates on
6287
+ * cash on delivery orders.
6288
+ */
6289
+ is_cod?: boolean;
6290
+ /**
6291
+ * - Mode of transport associated with the
6292
+ * courier partner scheme.
6293
+ */
6294
+ transport_type?: string;
6295
+ };
6296
+ /** @returns {AreaCode} */
6297
+ declare function AreaCode(): AreaCode;
6298
+ type AreaCode = {
6299
+ /**
6300
+ * - The starting area code.
6301
+ */
6302
+ source?: string;
6303
+ /**
6304
+ * - The ending area code.
6305
+ */
6306
+ destination?: string;
6307
+ };
6308
+ /** @returns {TAT} */
6309
+ declare function TAT(): TAT;
6310
+ type TAT = {
6311
+ /**
6312
+ * - The minimum tat in integer.
6313
+ */
6314
+ min?: number;
6315
+ /**
6316
+ * - The maximum tat in integer.
6317
+ */
6318
+ max?: number;
6319
+ };
6320
+ /** @returns {LocationDetailsServiceability} */
6321
+ declare function LocationDetailsServiceability(): LocationDetailsServiceability;
6322
+ type LocationDetailsServiceability = {
6323
+ /**
6324
+ * - The pincode of the serviceability location.
6325
+ */
6326
+ pincode?: string;
6327
+ /**
6328
+ * - The sector of the serviceability location.
6329
+ */
6330
+ sector?: string;
6331
+ /**
6332
+ * - The state of the serviceability location.
6333
+ */
6334
+ state?: string;
6335
+ /**
6336
+ * - The country of the serviceability location.
6337
+ */
6338
+ country: string;
6339
+ /**
6340
+ * - The city of the serviceability location.
6341
+ */
6342
+ city?: string;
6343
+ /**
6344
+ * - The ISO code of the country.
6345
+ */
6346
+ country_iso_code: string;
6347
+ location?: ServiceabilityLocation;
6348
+ };
6349
+ /** @returns {CourierPartnerShipmentsArticles} */
6350
+ declare function CourierPartnerShipmentsArticles(): CourierPartnerShipmentsArticles;
6351
+ type CourierPartnerShipmentsArticles = {
6352
+ /**
6353
+ * - A string serving as the unique identifier.
6354
+ */
6355
+ id?: string;
6356
+ /**
6357
+ * - Represents the delivery date and time
6358
+ * slots available for an article.
6359
+ */
6360
+ delivery_slots?: any;
6361
+ error?: Error;
6362
+ /**
6363
+ * - The fulfillment Id.
6364
+ */
6365
+ fulfillment_id?: number;
6366
+ /**
6367
+ * - Fulfillment level tags
6368
+ */
6369
+ fulfillment_tags?: string[];
6370
+ /**
6371
+ * - Fulfillment Type
6372
+ */
6373
+ fulfillment_type?: string;
6374
+ /**
6375
+ * - The group Id of the article.
6376
+ */
6377
+ group_id?: string;
6378
+ /**
6379
+ * - A boolean indicating if the courier partner
6380
+ * supports gift shipments.
6381
+ */
6382
+ is_gift?: boolean;
6383
+ /**
6384
+ * - Flag indicating whether the shipment is MTO
6385
+ * (Make to Order).
6386
+ */
6387
+ is_mto?: boolean;
6388
+ /**
6389
+ * - A boolean indicating whether the article is a set.
6390
+ */
6391
+ is_set?: boolean;
6392
+ /**
6393
+ * - The manufacturing time of the article.
6394
+ */
6395
+ manufacturing_time?: number;
6396
+ /**
6397
+ * - The unit of measurement for
6398
+ * manufacturing time.
6399
+ */
6400
+ manufacturing_time_unit?: string;
6401
+ /**
6402
+ * - The Made to Order quantity of the article.
6403
+ */
6404
+ mto_quantity?: number;
6405
+ /**
6406
+ * - Service level agreement (SLA) for the article,
6407
+ * represented as a date-time
6408
+ */
6409
+ sla?: string;
6410
+ /**
6411
+ * - Marked price before discounts.
6412
+ */
6413
+ price_marked?: number;
6414
+ promise?: CourierPartnerArticlesPromise;
6415
+ /**
6416
+ * - Additional properties related to sets.
6417
+ */
6418
+ set?: any;
6419
+ return_reason?: CourierPartnerArticlesReturnReasons;
6420
+ /**
6421
+ * - It represents the number of set of this article
6422
+ */
6423
+ set_quantity?: number;
6424
+ /**
6425
+ * - The quantity of the shipment article.
6426
+ */
6427
+ quantity: number;
6428
+ weight: ArticleWeight;
6429
+ attributes?: ArticleAttributes;
6430
+ /**
6431
+ * - The category Id of the article.
6432
+ */
6433
+ category_id: number;
6434
+ dimension: ArticleDimension;
6435
+ /**
6436
+ * - The brand Id of the article.
6437
+ */
6438
+ brand_id: number;
6439
+ /**
6440
+ * - The Item Id of the article.
6441
+ */
6442
+ item_id: number;
6443
+ /**
6444
+ * - The size of the article.
6445
+ */
6446
+ size: string;
6447
+ /**
6448
+ * - Tags assigned to Item
6449
+ */
6450
+ tags: string[];
6451
+ /**
6452
+ * - Department of the item
6453
+ */
6454
+ department_id: number;
6455
+ /**
6456
+ * - Final Price of the article after discounts
6457
+ */
6458
+ price: number;
6459
+ };
6460
+ /** @returns {CourierPartnerArticlesPromise} */
6461
+ declare function CourierPartnerArticlesPromise(): CourierPartnerArticlesPromise;
6462
+ type CourierPartnerArticlesPromise = {
6463
+ /**
6464
+ * - The minimum delivery promise date.
6465
+ */
6466
+ min?: string;
6467
+ /**
6468
+ * - The maximum delivery promise date.
6469
+ */
6470
+ max?: string;
6471
+ };
6472
+ /** @returns {CourierPartnerArticlesReturnReasons} */
6473
+ declare function CourierPartnerArticlesReturnReasons(): CourierPartnerArticlesReturnReasons;
6474
+ type CourierPartnerArticlesReturnReasons = {
6475
+ /**
6476
+ * - The unique identifier for the return reason entry.
6477
+ */
6478
+ id?: number;
6479
+ meta?: CourierPartnerArticlesReturnReasonsMeta;
6480
+ /**
6481
+ * - A list of quality check types that apply to
6482
+ * the return reasons.
6483
+ */
6484
+ qc_type?: string[];
6485
+ /**
6486
+ * - A list of return reasons for the article.
6487
+ */
6488
+ reasons?: string[];
6489
+ /**
6490
+ * - A boolean indicating whether the return
6491
+ * reason is currently active.
6492
+ */
6493
+ is_active?: boolean;
6494
+ /**
6495
+ * - The display name for the return reason.
6496
+ */
6497
+ display_name?: string;
6498
+ /**
6499
+ * - A list of questions associated with the
6500
+ * return reason.
6501
+ */
6502
+ question_set?: string[];
6503
+ /**
6504
+ * - Any additional text for other return reasons.
6505
+ */
6506
+ reason_other_text?: string;
6507
+ };
6508
+ /** @returns {CourierPartnerArticlesReturnReasonsMeta} */
6509
+ declare function CourierPartnerArticlesReturnReasonsMeta(): CourierPartnerArticlesReturnReasonsMeta;
6510
+ type CourierPartnerArticlesReturnReasonsMeta = {
6511
+ /**
6512
+ * - A boolean indicating whether a text
6513
+ * area should be displayed for additional input regarding the return reason.
6514
+ */
6515
+ show_text_area?: boolean;
6516
+ };
6517
+ /** @returns {ArticleWeight} */
6518
+ declare function ArticleWeight(): ArticleWeight;
6519
+ type ArticleWeight = {
6520
+ /**
6521
+ * - The weight(grams) of the article for shipping
6522
+ * purposes, typically measured in a specified unit.
6523
+ */
6524
+ shipping: number;
6525
+ /**
6526
+ * - The unit of measurement used for the weight value.
6527
+ */
6528
+ unit: string;
6529
+ /**
6530
+ * - A boolean indicating whether this weight is
6531
+ * the default weight for the article.
6532
+ */
6533
+ is_default: boolean;
6534
+ };
6535
+ /** @returns {ArticleAttributes} */
6536
+ declare function ArticleAttributes(): ArticleAttributes;
6537
+ type ArticleAttributes = {
6538
+ /**
6539
+ * - Yes/no indicating whether the article
6540
+ * is powered by batteries.
6541
+ */
6542
+ battery_operated: string;
6543
+ /**
6544
+ * - Yes/no indicating whether the article is
6545
+ * considered flammable or poses a fire hazard.
6546
+ */
6547
+ is_flammable: string;
6548
+ };
6549
+ /** @returns {ArticleDimension} */
6550
+ declare function ArticleDimension(): ArticleDimension;
6551
+ type ArticleDimension = {
6552
+ /**
6553
+ * - The height of the article.
6554
+ */
6555
+ height: number;
6556
+ /**
6557
+ * - A boolean indicating whether this dimension
6558
+ * is the default dimension.
6559
+ */
6560
+ is_default: boolean;
6561
+ /**
6562
+ * - The length of the article.
6563
+ */
6564
+ length: number;
6565
+ /**
6566
+ * - The unit of measurement used for the dimensions.
6567
+ */
6568
+ unit: string;
6569
+ /**
6570
+ * - The width of the article.
6571
+ */
6572
+ width: number;
6573
+ };
6574
+ /** @returns {PlatformLocationArticles} */
6575
+ declare function PlatformLocationArticles(): PlatformLocationArticles;
6576
+ type PlatformLocationArticles = {
6577
+ /**
6578
+ * - List of articles for this
6579
+ * fulfillment location.
6580
+ */
6581
+ articles: PlatformLocationArticle[];
6582
+ /**
6583
+ * - Unique identifier for the
6584
+ * fulfillment location.
6585
+ */
6586
+ fulfillment_location_id: number;
6587
+ /**
6588
+ * - Tags associated with the
6589
+ * fulfillment location.
6590
+ */
6591
+ fulfillment_tags?: string[];
6592
+ /**
6593
+ * - Type of fulfillment (e.g., store, warehouse).
6594
+ */
6595
+ fulfillment_type: string;
6596
+ };
6597
+ /** @returns {PlatformLocationArticle} */
6598
+ declare function PlatformLocationArticle(): PlatformLocationArticle;
6599
+ type PlatformLocationArticle = {
6600
+ /**
6601
+ * - The price of the article.
6602
+ */
6603
+ price: number;
6604
+ /**
6605
+ * - Unique identifier for the item.
6606
+ */
6607
+ item_id: number;
6608
+ /**
6609
+ * - The size of the article.
5530
6610
  */
5531
6611
  size: string;
5532
6612
  /**
@@ -6000,29 +7080,19 @@ type ShipmentsCourierPartner = {
6000
7080
  */
6001
7081
  non_qc_shipment_item_quantity?: number;
6002
7082
  };
6003
- /** @returns {AreaCode} */
6004
- declare function AreaCode(): AreaCode;
6005
- type AreaCode = {
6006
- /**
6007
- * - The starting area code.
6008
- */
6009
- source?: string;
6010
- /**
6011
- * - The ending area code.
6012
- */
6013
- destination?: string;
6014
- };
6015
- /** @returns {TAT} */
6016
- declare function TAT(): TAT;
6017
- type TAT = {
7083
+ /** @returns {FulfillmentOptionDefaultFor} */
7084
+ declare function FulfillmentOptionDefaultFor(): FulfillmentOptionDefaultFor;
7085
+ type FulfillmentOptionDefaultFor = {
6018
7086
  /**
6019
- * - The minimum tat in integer.
7087
+ * - If set to true, this fulfillment option
7088
+ * will be default for storefront.
6020
7089
  */
6021
- min?: number;
7090
+ storefront?: boolean;
6022
7091
  /**
6023
- * - The maximum tat in integer.
7092
+ * - If set to true, this fulfillment option will
7093
+ * be default for storeos.
6024
7094
  */
6025
- max?: number;
7095
+ storeos?: boolean;
6026
7096
  };
6027
7097
  /** @returns {BusinessUnit} */
6028
7098
  declare function BusinessUnit(): BusinessUnit;
@@ -6647,6 +7717,12 @@ type ProductSchema = {
6647
7717
  * type of products selected for the delivery zone.
6648
7718
  */
6649
7719
  values: any[];
7720
+ /**
7721
+ * - The action to perform on the product values -
7722
+ * 'add' to add values to the existing list, 'remove' to remove values from
7723
+ * the existing list.
7724
+ */
7725
+ action?: string;
6650
7726
  };
6651
7727
  /** @returns {StoresSchema} */
6652
7728
  declare function StoresSchema(): StoresSchema;
@@ -7546,63 +8622,6 @@ type ShipmentsArticles = {
7546
8622
  delivery_slots?: ArticleDeliverySlots;
7547
8623
  return_reason?: ArticleReturnReason;
7548
8624
  };
7549
- /** @returns {ArticleWeight} */
7550
- declare function ArticleWeight(): ArticleWeight;
7551
- type ArticleWeight = {
7552
- /**
7553
- * - The weight(grams) of the article for shipping
7554
- * purposes, typically measured in a specified unit.
7555
- */
7556
- shipping: number;
7557
- /**
7558
- * - The unit of measurement used for the weight value.
7559
- */
7560
- unit: string;
7561
- /**
7562
- * - A boolean indicating whether this weight is
7563
- * the default weight for the article.
7564
- */
7565
- is_default: boolean;
7566
- };
7567
- /** @returns {ArticleAttributes} */
7568
- declare function ArticleAttributes(): ArticleAttributes;
7569
- type ArticleAttributes = {
7570
- /**
7571
- * - Yes/no indicating whether the article
7572
- * is powered by batteries.
7573
- */
7574
- battery_operated: string;
7575
- /**
7576
- * - Yes/no indicating whether the article is
7577
- * considered flammable or poses a fire hazard.
7578
- */
7579
- is_flammable: string;
7580
- };
7581
- /** @returns {ArticleDimension} */
7582
- declare function ArticleDimension(): ArticleDimension;
7583
- type ArticleDimension = {
7584
- /**
7585
- * - The height of the article.
7586
- */
7587
- height: number;
7588
- /**
7589
- * - A boolean indicating whether this dimension
7590
- * is the default dimension.
7591
- */
7592
- is_default: boolean;
7593
- /**
7594
- * - The length of the article.
7595
- */
7596
- length: number;
7597
- /**
7598
- * - The unit of measurement used for the dimensions.
7599
- */
7600
- unit: string;
7601
- /**
7602
- * - The width of the article.
7603
- */
7604
- width: number;
7605
- };
7606
8625
  /** @returns {ArticleSet} */
7607
8626
  declare function ArticleSet(): ArticleSet;
7608
8627
  type ArticleSet = {
@@ -8136,47 +9155,6 @@ type ArticleAssignment = {
8136
9155
  */
8137
9156
  strategy?: string;
8138
9157
  };
8139
- /** @returns {LocationDetailsServiceability} */
8140
- declare function LocationDetailsServiceability(): LocationDetailsServiceability;
8141
- type LocationDetailsServiceability = {
8142
- /**
8143
- * - The pincode of the serviceability location.
8144
- */
8145
- pincode?: string;
8146
- /**
8147
- * - The sector of the serviceability location.
8148
- */
8149
- sector?: string;
8150
- /**
8151
- * - The state of the serviceability location.
8152
- */
8153
- state?: string;
8154
- /**
8155
- * - The country of the serviceability location.
8156
- */
8157
- country: string;
8158
- /**
8159
- * - The city of the serviceability location.
8160
- */
8161
- city?: string;
8162
- /**
8163
- * - The ISO code of the country.
8164
- */
8165
- country_iso_code: string;
8166
- location?: ServiceabilityLocation;
8167
- };
8168
- /** @returns {ServiceabilityLocation} */
8169
- declare function ServiceabilityLocation(): ServiceabilityLocation;
8170
- type ServiceabilityLocation = {
8171
- /**
8172
- * - The longitude of the serviceability location.
8173
- */
8174
- longitude: string;
8175
- /**
8176
- * - The latitude of the serviceability location.
8177
- */
8178
- latitude: string;
8179
- };
8180
9158
  /** @returns {OptimalLocationsArticles} */
8181
9159
  declare function OptimalLocationsArticles(): OptimalLocationsArticles;
8182
9160
  type OptimalLocationsArticles = {
@@ -8846,3 +9824,220 @@ type HistoryObject = {
8846
9824
  */
8847
9825
  total_error_count?: number;
8848
9826
  };
9827
+ /** @returns {StorePolygonServiceabilityRequestData} */
9828
+ declare function StorePolygonServiceabilityRequestData(): StorePolygonServiceabilityRequestData;
9829
+ type StorePolygonServiceabilityRequestData = {
9830
+ /**
9831
+ * - List of stores for
9832
+ * which polygon-based serviceability is being configured.
9833
+ */
9834
+ stores: StorePolygonServiceabilityStore[];
9835
+ };
9836
+ /** @returns {StorePolygonServiceabilityStore} */
9837
+ declare function StorePolygonServiceabilityStore(): StorePolygonServiceabilityStore;
9838
+ type StorePolygonServiceabilityStore = {
9839
+ /**
9840
+ * - Unique identifier of the store.
9841
+ */
9842
+ store_code: string;
9843
+ /**
9844
+ * - Name of the store.
9845
+ */
9846
+ name: string;
9847
+ /**
9848
+ * - Address of the store.
9849
+ */
9850
+ address: string;
9851
+ /**
9852
+ * - Area code associated with the store.
9853
+ */
9854
+ area_code: string;
9855
+ /**
9856
+ * - Indicates whether the store is active.
9857
+ */
9858
+ is_active: boolean;
9859
+ /**
9860
+ * - Additional metadata associated with the store.
9861
+ */
9862
+ meta?: any;
9863
+ coordinates: StorePolygonServiceabilityStoreCoordinates;
9864
+ /**
9865
+ * - List of
9866
+ * polygon-based serviceability configurations for the store.
9867
+ */
9868
+ serviceabilities: StorePolygonServiceabilityConfig[];
9869
+ /**
9870
+ * - Timestamp when the store entry was created.
9871
+ */
9872
+ created_at?: string;
9873
+ /**
9874
+ * - Timestamp when the store entry was last updated.
9875
+ */
9876
+ updated_at?: string;
9877
+ };
9878
+ /** @returns {StorePolygonServiceabilityStoreCoordinates} */
9879
+ declare function StorePolygonServiceabilityStoreCoordinates(): StorePolygonServiceabilityStoreCoordinates;
9880
+ type StorePolygonServiceabilityStoreCoordinates = {
9881
+ /**
9882
+ * - Longitude of the store.
9883
+ */
9884
+ lng: number;
9885
+ /**
9886
+ * - Latitude of the store.
9887
+ */
9888
+ lat: number;
9889
+ };
9890
+ /** @returns {StorePolygonServiceabilityConfig} */
9891
+ declare function StorePolygonServiceabilityConfig(): StorePolygonServiceabilityConfig;
9892
+ type StorePolygonServiceabilityConfig = {
9893
+ /**
9894
+ * - Name of the polygon-based serviceability configuration.
9895
+ */
9896
+ name: string;
9897
+ /**
9898
+ * - Type of serviceability
9899
+ * configuration. Currently supports quick_commerce.
9900
+ */
9901
+ serviceability_type: string;
9902
+ polygon: StorePolygonServiceabilityPolygon;
9903
+ /**
9904
+ * - Additional metadata associated with the
9905
+ * serviceability configuration.
9906
+ */
9907
+ meta?: any;
9908
+ /**
9909
+ * - Indicates whether the serviceability
9910
+ * configuration is active.
9911
+ */
9912
+ is_active: boolean;
9913
+ /**
9914
+ * - Unique identifier of the serviceability configuration.
9915
+ */
9916
+ uid?: string;
9917
+ /**
9918
+ * - Timestamp when the serviceability
9919
+ * configuration was created.
9920
+ */
9921
+ created_at?: string;
9922
+ /**
9923
+ * - Timestamp when the serviceability
9924
+ * configuration was last updated.
9925
+ */
9926
+ updated_at?: string;
9927
+ };
9928
+ /** @returns {StorePolygonServiceabilityPolygon} */
9929
+ declare function StorePolygonServiceabilityPolygon(): StorePolygonServiceabilityPolygon;
9930
+ type StorePolygonServiceabilityPolygon = {
9931
+ /**
9932
+ * - Type of the GeoJSON collection, typically FeatureCollection.
9933
+ */
9934
+ type: string;
9935
+ /**
9936
+ * - List of GeoJSON
9937
+ * features defining the polygon.
9938
+ */
9939
+ features: StorePolygonServiceabilityFeature[];
9940
+ attributes?: StorePolygonServiceabilityAttributes;
9941
+ };
9942
+ /** @returns {StorePolygonServiceabilityFeature} */
9943
+ declare function StorePolygonServiceabilityFeature(): StorePolygonServiceabilityFeature;
9944
+ type StorePolygonServiceabilityFeature = {
9945
+ /**
9946
+ * - Type of the feature, typically Feature.
9947
+ */
9948
+ type: string;
9949
+ /**
9950
+ * - Additional properties for the feature.
9951
+ */
9952
+ properties?: any;
9953
+ geometry: StorePolygonServiceabilityGeometry;
9954
+ };
9955
+ /** @returns {StorePolygonServiceabilityGeometry} */
9956
+ declare function StorePolygonServiceabilityGeometry(): StorePolygonServiceabilityGeometry;
9957
+ type StorePolygonServiceabilityGeometry = {
9958
+ /**
9959
+ * - Type of geometry, typically Polygon.
9960
+ */
9961
+ type?: string;
9962
+ /**
9963
+ * - List of polygon coordinates as
9964
+ * longitude and latitude pairs.
9965
+ */
9966
+ coordinates?: number[][][];
9967
+ };
9968
+ /** @returns {StorePolygonServiceabilityAttributes} */
9969
+ declare function StorePolygonServiceabilityAttributes(): StorePolygonServiceabilityAttributes;
9970
+ type StorePolygonServiceabilityAttributes = {
9971
+ /**
9972
+ * - Type of contour used for the polygon,
9973
+ * either distance-based or manually defined.
9974
+ */
9975
+ contour_type?: string;
9976
+ /**
9977
+ * - Travel distance used to derive the
9978
+ * polygon contour, typically in meters.
9979
+ */
9980
+ travel_distance?: number;
9981
+ reference_coordinates?: StorePolygonServiceabilityReferenceCoordinates;
9982
+ };
9983
+ /** @returns {StorePolygonServiceabilityReferenceCoordinates} */
9984
+ declare function StorePolygonServiceabilityReferenceCoordinates(): StorePolygonServiceabilityReferenceCoordinates;
9985
+ type StorePolygonServiceabilityReferenceCoordinates = {
9986
+ /**
9987
+ * - Longitude of the reference point.
9988
+ */
9989
+ lng: number;
9990
+ /**
9991
+ * - Latitude of the reference point.
9992
+ */
9993
+ lat: number;
9994
+ };
9995
+ /** @returns {StorePolygonServiceabilityStoreSummary} */
9996
+ declare function StorePolygonServiceabilityStoreSummary(): StorePolygonServiceabilityStoreSummary;
9997
+ type StorePolygonServiceabilityStoreSummary = {
9998
+ /**
9999
+ * - Unique identifier of the store.
10000
+ */
10001
+ store_code: string;
10002
+ /**
10003
+ * - Name of the store.
10004
+ */
10005
+ name?: string;
10006
+ };
10007
+ /** @returns {StorePolygonServiceabilityError} */
10008
+ declare function StorePolygonServiceabilityError(): StorePolygonServiceabilityError;
10009
+ type StorePolygonServiceabilityError = {
10010
+ /**
10011
+ * - Store code identifier.
10012
+ */
10013
+ store_code: string;
10014
+ /**
10015
+ * - Detailed error message describing the validation
10016
+ * failure for a specific record.
10017
+ */
10018
+ message: string;
10019
+ /**
10020
+ * - Error code for the failure.
10021
+ */
10022
+ error_code?: string;
10023
+ };
10024
+ /** @returns {StorePolygonServiceabilityPagination} */
10025
+ declare function StorePolygonServiceabilityPagination(): StorePolygonServiceabilityPagination;
10026
+ type StorePolygonServiceabilityPagination = {
10027
+ /**
10028
+ * - Number of records per page.
10029
+ */
10030
+ page_size: number;
10031
+ /**
10032
+ * - The current page number.
10033
+ */
10034
+ page_number: number;
10035
+ /**
10036
+ * - Indicates whether more pages are available.
10037
+ */
10038
+ has_next: boolean;
10039
+ /**
10040
+ * - Total number of records matching the criteria.
10041
+ */
10042
+ total_records: number;
10043
+ };