@gofynd/fdk-client-javascript 3.21.0 → 3.23.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 (31) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/ApplicationAPIClient.d.ts +1 -1
  4. package/sdk/application/ApplicationClient.d.ts +1 -1
  5. package/sdk/application/Cart/CartApplicationClient.d.ts +4 -4
  6. package/sdk/application/Cart/CartApplicationClient.js +9 -2
  7. package/sdk/partner/OAuthClient.d.ts +3 -3
  8. package/sdk/partner/PartnerAPIClient.d.ts +1 -1
  9. package/sdk/partner/PartnerClient.d.ts +2 -2
  10. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +3 -3
  11. package/sdk/platform/Cart/CartPlatformApplicationClient.js +12 -0
  12. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +21 -0
  13. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +9 -0
  14. package/sdk/platform/Cart/CartPlatformModel.d.ts +7 -0
  15. package/sdk/platform/Cart/CartPlatformModel.js +3 -0
  16. package/sdk/platform/OAuthClient.d.ts +3 -3
  17. package/sdk/platform/Order/OrderPlatformModel.d.ts +24 -0
  18. package/sdk/platform/Order/OrderPlatformModel.js +11 -0
  19. package/sdk/platform/PlatformAPIClient.d.ts +1 -1
  20. package/sdk/platform/PlatformClient.d.ts +2 -2
  21. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +94 -0
  22. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +574 -0
  23. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +70 -1
  24. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +81 -0
  25. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +14 -0
  26. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +85 -0
  27. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1364 -192
  28. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +941 -159
  29. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +10 -1
  30. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +12 -0
  31. package/sdk/public/PublicAPIClient.d.ts +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.
@@ -1190,6 +1211,280 @@ export = ServiceabilityPlatformModel;
1190
1211
  * at delivery partner scheme level.
1191
1212
  * @property {string[]} [sort] - An array of strings specifying sorting preferences.
1192
1213
  */
1214
+ /**
1215
+ * @typedef StorePolygonServiceabilityRequestBody
1216
+ * @property {StorePolygonServiceabilityRequestData} data
1217
+ */
1218
+ /**
1219
+ * @typedef StorePolygonServiceabilityResult
1220
+ * @property {boolean} success - Indicates whether the polygon serviceability
1221
+ * operation was successful.
1222
+ * @property {StorePolygonServiceabilityStoreSummary[]} data - List of stores
1223
+ * for which polygon serviceability was successfully processed.
1224
+ * @property {StorePolygonServiceabilityError[]} errors - List of errors
1225
+ * encountered while processing individual entries, if any.
1226
+ * @property {string} identifier - Unique identifier for the polygon
1227
+ * serviceability request.
1228
+ * @property {StorePolygonServiceabilityError[]} failed_entries - List of
1229
+ * entries that failed during polygon serviceability processing.
1230
+ */
1231
+ /**
1232
+ * @typedef StorePolygonServiceabilityGetResult
1233
+ * @property {boolean} success - Indicates whether the polygon serviceability
1234
+ * fetch operation was successful.
1235
+ * @property {StorePolygonServiceabilityStore[]} data - List of stores with
1236
+ * their polygon-based serviceability details.
1237
+ * @property {StorePolygonServiceabilityError[]} errors - List of errors
1238
+ * encountered while processing individual entries, if any.
1239
+ * @property {string} identifier - Unique identifier for the polygon
1240
+ * serviceability request.
1241
+ * @property {StorePolygonServiceabilityError[]} failed_entries - List of
1242
+ * entries that failed during polygon serviceability processing.
1243
+ * @property {StorePolygonServiceabilityPagination} pagination - Pagination
1244
+ * details for the polygon serviceability result set.
1245
+ */
1246
+ /**
1247
+ * @typedef ZoneProductsBulkPatchDetails
1248
+ * @property {string} file_url - URL of the CSV file containing the zone
1249
+ * products bulk patch data.
1250
+ */
1251
+ /**
1252
+ * @typedef GetZoneProductsBulkPatchResult
1253
+ * @property {string} batch_id - A unique identifier for the performed batch operation.
1254
+ * @property {string} [file_path] - CDN path of the uploaded file.
1255
+ * @property {number} total - Total number of records in the batch.
1256
+ * @property {number} failed - Number of failed records in the batch.
1257
+ * @property {string} [error_file_url] - URL to the error file containing
1258
+ * details of failed records.
1259
+ * @property {string} action - The action performed during the bulk operation.
1260
+ * @property {string} updated_at - Timestamp when the batch was last updated.
1261
+ * @property {string} updated_by - User who last updated the batch.
1262
+ * @property {string} type - Type of the bulk operation.
1263
+ * @property {number} company_id - The unique identifier for the company.
1264
+ * @property {string} application_id - A unique identifier for the sales channel.
1265
+ * @property {string} stage - Current stage of the bulk operation.
1266
+ * @property {number} [partial] - Number of partially processed records.
1267
+ * @property {string} [result_file_url] - URL to the result file after
1268
+ * processing is complete.
1269
+ */
1270
+ /**
1271
+ * @typedef CourierPartnerToServiceability
1272
+ * @property {ServiceabilityLocation} [location]
1273
+ * @property {string} [pincode] - The pincode of the serviceability location.
1274
+ * @property {string} [sector] - The sector of the serviceability location.
1275
+ * @property {string} [country] - The country where the serviceability location
1276
+ * is situated.
1277
+ * @property {string} [country_iso_code] - The ISO code for the country.
1278
+ * @property {string} [state] - The state of the serviceability location.
1279
+ * @property {string} [city] - The city of the serviceability location.
1280
+ */
1281
+ /**
1282
+ * @typedef ServiceabilityLocation
1283
+ * @property {string} longitude - The longitude of the serviceability location.
1284
+ * @property {string} latitude - The latitude of the serviceability location.
1285
+ */
1286
+ /**
1287
+ * @typedef CourierPartnerShipments
1288
+ * @property {PromiseObject} [promise]
1289
+ * @property {boolean} [is_cod_available] - Indicates if cash on delivery (COD)
1290
+ * is available.
1291
+ * @property {boolean} [is_auto_assign] - Specifies if the shipment should be
1292
+ * automatically assigned.
1293
+ * @property {CourierPartnerShipmentsMeta} [meta]
1294
+ * @property {number} [volumetric_weight] - The volumetric weight of the shipment.
1295
+ * @property {number} [weight] - The actual weight of the shipment.
1296
+ * @property {ShipmentCourierPartnersResult[]} [courier_partners] - List of
1297
+ * courier partners associated with the shipment.
1298
+ * @property {number} fulfillment_id - The fulfillment Id.
1299
+ * @property {string} fulfillment_type - Fulfillment Type
1300
+ * @property {string[]} fulfillment_tags - Fulfillment level tags
1301
+ * @property {LocationDetailsServiceability} from_serviceability
1302
+ * @property {CourierPartnerShipmentsArticles[]} articles - A list of articles
1303
+ * in the courier partner shipment.
1304
+ * @property {boolean} is_mto - A boolean indicating if the courier partner
1305
+ * supports Made to Order service.
1306
+ * @property {string[]} ignore_scheme_ids - A list of scheme_id which we want to
1307
+ * ignore in courier_partner assignment.
1308
+ * @property {Object} [error] - Error Details
1309
+ */
1310
+ /**
1311
+ * @typedef PromiseObject
1312
+ * @property {string} [min] - The minimum promised delivery time in ISO 8601 format.
1313
+ * @property {string} [max] - The maximum promised delivery time in ISO 8601 format.
1314
+ * @property {PromiseData} customer_promise
1315
+ * @property {PromiseMeta} meta
1316
+ */
1317
+ /**
1318
+ * @typedef PromiseData
1319
+ * @property {string} [min] - The minimum promised delivery time in ISO 8601 format.
1320
+ * @property {string} [max] - The maximum promised delivery time in ISO 8601 format.
1321
+ */
1322
+ /**
1323
+ * @typedef PromiseMeta
1324
+ * @property {PromiseData} [seller_promise]
1325
+ * @property {CourierPartnerPromiseData} [courier_partner_promise]
1326
+ * @property {PromiseData} [customer_initial_promise]
1327
+ */
1328
+ /**
1329
+ * @typedef CourierPartnerPromiseData
1330
+ * @property {string} [min] - The minimum promised delivery time in ISO 8601 format.
1331
+ * @property {string} [max] - The maximum promised delivery time in ISO 8601 format.
1332
+ * @property {DeliveryTat} [attributes]
1333
+ */
1334
+ /**
1335
+ * @typedef DeliveryTat
1336
+ * @property {DeliveryTatSchema} [tat]
1337
+ */
1338
+ /**
1339
+ * @typedef DeliveryTatSchema
1340
+ * @property {number} [min] - The minimum tat in integer.
1341
+ * @property {number} [max] - The maximum tat in integer.
1342
+ */
1343
+ /**
1344
+ * @typedef CourierPartnerShipmentsMeta
1345
+ * @property {number} [shipment_cost] - The total cost associated with the
1346
+ * shipment, expressed as a floating-point number. This value includes all
1347
+ * applicable charges, such as transportation, handling, and any additional fees.
1348
+ */
1349
+ /**
1350
+ * @typedef ShipmentCourierPartnersResult
1351
+ * @property {string} extension_id - The Id of the courier partner.
1352
+ * @property {string} scheme_id - The scheme Id of the courier partner.
1353
+ * @property {AreaCode} area_code
1354
+ * @property {TAT} tat
1355
+ * @property {string} display_name - The display name of the courier partner.
1356
+ * @property {boolean} is_qc_enabled - A boolean indicating quality control by
1357
+ * the courier partner.
1358
+ * @property {boolean} is_self_ship - A boolean indicating it is self delivery DP support.
1359
+ * @property {boolean} [is_own_account] - Specifies if the courier partner
1360
+ * operates on its own account.
1361
+ * @property {number} [ndr_attempts] - The number of non-delivery report (NDR) attempts.
1362
+ * @property {string} [forward_pickup_cutoff] - Cutoff time for forward pickup (nullable).
1363
+ * @property {string} [reverse_pickup_cutoff] - Cutoff time for reverse pickup (nullable).
1364
+ * @property {number} [qc_shipment_item_quantity] - Quantity of items under
1365
+ * quality control (nullable).
1366
+ * @property {number} [non_qc_shipment_item_quantity] - Quantity of items not
1367
+ * under quality control (nullable).
1368
+ * @property {boolean} [dangerous_goods] - Specifies if the courier partner
1369
+ * operates on dangerous goods.
1370
+ * @property {boolean} [restricted_goods] - Specifies if the courier partner
1371
+ * operates on restricted goods.
1372
+ * @property {boolean} [fragile_goods] - Specifies if the courier partner
1373
+ * operates on fragile goods.
1374
+ * @property {boolean} [cold_storage_goods] - Specifies if the courier partner
1375
+ * operates on cold storage goods.
1376
+ * @property {string} [delivery_type] - Specifies type of courier partner.
1377
+ * @property {boolean} [is_cod] - Specifies if the courier partner operates on
1378
+ * cash on delivery orders.
1379
+ * @property {string} [transport_type] - Mode of transport associated with the
1380
+ * courier partner scheme.
1381
+ */
1382
+ /**
1383
+ * @typedef AreaCode
1384
+ * @property {string} [source] - The starting area code.
1385
+ * @property {string} [destination] - The ending area code.
1386
+ */
1387
+ /**
1388
+ * @typedef TAT
1389
+ * @property {number} [min] - The minimum tat in integer.
1390
+ * @property {number} [max] - The maximum tat in integer.
1391
+ */
1392
+ /**
1393
+ * @typedef LocationDetailsServiceability
1394
+ * @property {string} [pincode] - The pincode of the serviceability location.
1395
+ * @property {string} [sector] - The sector of the serviceability location.
1396
+ * @property {string} [state] - The state of the serviceability location.
1397
+ * @property {string} country - The country of the serviceability location.
1398
+ * @property {string} [city] - The city of the serviceability location.
1399
+ * @property {string} country_iso_code - The ISO code of the country.
1400
+ * @property {ServiceabilityLocation} [location]
1401
+ */
1402
+ /**
1403
+ * @typedef CourierPartnerShipmentsArticles
1404
+ * @property {string} [id] - A string serving as the unique identifier.
1405
+ * @property {Object} [delivery_slots] - Represents the delivery date and time
1406
+ * slots available for an article.
1407
+ * @property {Error} [error]
1408
+ * @property {number} [fulfillment_id] - The fulfillment Id.
1409
+ * @property {string[]} [fulfillment_tags] - Fulfillment level tags
1410
+ * @property {string} [fulfillment_type] - Fulfillment Type
1411
+ * @property {string} [group_id] - The group Id of the article.
1412
+ * @property {boolean} [is_gift] - A boolean indicating if the courier partner
1413
+ * supports gift shipments.
1414
+ * @property {boolean} [is_mto] - Flag indicating whether the shipment is MTO
1415
+ * (Make to Order).
1416
+ * @property {boolean} [is_set] - A boolean indicating whether the article is a set.
1417
+ * @property {number} [manufacturing_time] - The manufacturing time of the article.
1418
+ * @property {string} [manufacturing_time_unit] - The unit of measurement for
1419
+ * manufacturing time.
1420
+ * @property {number} [mto_quantity] - The Made to Order quantity of the article.
1421
+ * @property {string} [sla] - Service level agreement (SLA) for the article,
1422
+ * represented as a date-time
1423
+ * @property {number} [price_marked] - Marked price before discounts.
1424
+ * @property {CourierPartnerArticlesPromise} [promise]
1425
+ * @property {Object} [set] - Additional properties related to sets.
1426
+ * @property {CourierPartnerArticlesReturnReasons} [return_reason]
1427
+ * @property {number} [set_quantity] - It represents the number of set of this article
1428
+ * @property {number} quantity - The quantity of the shipment article.
1429
+ * @property {ArticleWeight} weight
1430
+ * @property {ArticleAttributes} [attributes]
1431
+ * @property {number} category_id - The category Id of the article.
1432
+ * @property {ArticleDimension} dimension
1433
+ * @property {number} brand_id - The brand Id of the article.
1434
+ * @property {number} item_id - The Item Id of the article.
1435
+ * @property {string} size - The size of the article.
1436
+ * @property {string[]} tags - Tags assigned to Item
1437
+ * @property {number} department_id - Department of the item
1438
+ * @property {number} price - Final Price of the article after discounts
1439
+ */
1440
+ /**
1441
+ * @typedef CourierPartnerArticlesPromise
1442
+ * @property {string} [min] - The minimum delivery promise date.
1443
+ * @property {string} [max] - The maximum delivery promise date.
1444
+ */
1445
+ /**
1446
+ * @typedef CourierPartnerArticlesReturnReasons
1447
+ * @property {number} [id] - The unique identifier for the return reason entry.
1448
+ * @property {CourierPartnerArticlesReturnReasonsMeta} [meta]
1449
+ * @property {string[]} [qc_type] - A list of quality check types that apply to
1450
+ * the return reasons.
1451
+ * @property {string[]} [reasons] - A list of return reasons for the article.
1452
+ * @property {boolean} [is_active] - A boolean indicating whether the return
1453
+ * reason is currently active.
1454
+ * @property {string} [display_name] - The display name for the return reason.
1455
+ * @property {string[]} [question_set] - A list of questions associated with the
1456
+ * return reason.
1457
+ * @property {string} [reason_other_text] - Any additional text for other return reasons.
1458
+ */
1459
+ /**
1460
+ * @typedef CourierPartnerArticlesReturnReasonsMeta
1461
+ * @property {boolean} [show_text_area] - A boolean indicating whether a text
1462
+ * area should be displayed for additional input regarding the return reason.
1463
+ */
1464
+ /**
1465
+ * @typedef ArticleWeight
1466
+ * @property {number} shipping - The weight(grams) of the article for shipping
1467
+ * purposes, typically measured in a specified unit.
1468
+ * @property {string} unit - The unit of measurement used for the weight value.
1469
+ * @property {boolean} is_default - A boolean indicating whether this weight is
1470
+ * the default weight for the article.
1471
+ */
1472
+ /**
1473
+ * @typedef ArticleAttributes
1474
+ * @property {string} battery_operated - Yes/no indicating whether the article
1475
+ * is powered by batteries.
1476
+ * @property {string} is_flammable - Yes/no indicating whether the article is
1477
+ * considered flammable or poses a fire hazard.
1478
+ */
1479
+ /**
1480
+ * @typedef ArticleDimension
1481
+ * @property {number} height - The height of the article.
1482
+ * @property {boolean} is_default - A boolean indicating whether this dimension
1483
+ * is the default dimension.
1484
+ * @property {number} length - The length of the article.
1485
+ * @property {string} unit - The unit of measurement used for the dimensions.
1486
+ * @property {number} width - The width of the article.
1487
+ */
1193
1488
  /**
1194
1489
  * @typedef PlatformLocationArticles
1195
1490
  * @property {PlatformLocationArticle[]} articles - List of articles for this
@@ -1385,16 +1680,6 @@ export = ServiceabilityPlatformModel;
1385
1680
  * @property {number} [non_qc_shipment_item_quantity] - Quantity of items not
1386
1681
  * under quality control (nullable).
1387
1682
  */
1388
- /**
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.
1397
- */
1398
1683
  /**
1399
1684
  * @typedef BusinessUnit
1400
1685
  * @property {string} [name] - Name of the business unit.
@@ -1622,6 +1907,9 @@ export = ServiceabilityPlatformModel;
1622
1907
  * zone, whether it's a list of categories, departments, tags, or item_ids.
1623
1908
  * @property {Object[]} values - List of values representing the products or the
1624
1909
  * type of products selected for the delivery zone.
1910
+ * @property {string} [action] - The action to perform on the product values -
1911
+ * 'add' to add values to the existing list, 'remove' to remove values from
1912
+ * the existing list.
1625
1913
  */
1626
1914
  /**
1627
1915
  * @typedef StoresSchema
@@ -1985,30 +2273,6 @@ export = ServiceabilityPlatformModel;
1985
2273
  * @property {ArticleDeliverySlots} [delivery_slots]
1986
2274
  * @property {ArticleReturnReason} [return_reason]
1987
2275
  */
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
2276
  /**
2013
2277
  * @typedef ArticleSet
2014
2278
  * @property {string} [name] - The name of the article set.
@@ -2248,21 +2512,6 @@ export = ServiceabilityPlatformModel;
2248
2512
  * @property {string} [strategy] - The strategy parameter allows users to
2249
2513
  * specify the desired approach or criteria for selecting optimal locations.
2250
2514
  */
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
2515
  /**
2267
2516
  * @typedef OptimalLocationsArticles
2268
2517
  * @property {number} item_id - Unique identifier for the item.
@@ -2536,11 +2785,152 @@ export = ServiceabilityPlatformModel;
2536
2785
  * @property {number} [total_error_count] - The number of items or entities that
2537
2786
  * encountered errors during the batch processing.
2538
2787
  */
2788
+ /**
2789
+ * @typedef StorePolygonServiceabilityRequestData
2790
+ * @property {StorePolygonServiceabilityStore[]} stores - List of stores for
2791
+ * which polygon-based serviceability is being configured.
2792
+ */
2793
+ /**
2794
+ * @typedef StorePolygonServiceabilityStore
2795
+ * @property {string} store_code - Unique identifier of the store.
2796
+ * @property {string} name - Name of the store.
2797
+ * @property {string} address - Address of the store.
2798
+ * @property {string} area_code - Area code associated with the store.
2799
+ * @property {boolean} is_active - Indicates whether the store is active.
2800
+ * @property {Object} [meta] - Additional metadata associated with the store.
2801
+ * @property {StorePolygonServiceabilityStoreCoordinates} coordinates
2802
+ * @property {StorePolygonServiceabilityConfig[]} serviceabilities - List of
2803
+ * polygon-based serviceability configurations for the store.
2804
+ * @property {string} [created_at] - Timestamp when the store entry was created.
2805
+ * @property {string} [updated_at] - Timestamp when the store entry was last updated.
2806
+ */
2807
+ /**
2808
+ * @typedef StorePolygonServiceabilityStoreCoordinates
2809
+ * @property {number} lng - Longitude of the store.
2810
+ * @property {number} lat - Latitude of the store.
2811
+ */
2812
+ /**
2813
+ * @typedef StorePolygonServiceabilityConfig
2814
+ * @property {string} name - Name of the polygon-based serviceability configuration.
2815
+ * @property {string} serviceability_type - Type of serviceability
2816
+ * configuration. Currently supports quick_commerce.
2817
+ * @property {StorePolygonServiceabilityPolygon} polygon
2818
+ * @property {Object} [meta] - Additional metadata associated with the
2819
+ * serviceability configuration.
2820
+ * @property {boolean} is_active - Indicates whether the serviceability
2821
+ * configuration is active.
2822
+ * @property {string} [uid] - Unique identifier of the serviceability configuration.
2823
+ * @property {string} [created_at] - Timestamp when the serviceability
2824
+ * configuration was created.
2825
+ * @property {string} [updated_at] - Timestamp when the serviceability
2826
+ * configuration was last updated.
2827
+ */
2828
+ /**
2829
+ * @typedef StorePolygonServiceabilityPolygon
2830
+ * @property {string} type - Type of the GeoJSON collection, typically FeatureCollection.
2831
+ * @property {StorePolygonServiceabilityFeature[]} features - List of GeoJSON
2832
+ * features defining the polygon.
2833
+ * @property {StorePolygonServiceabilityAttributes} [attributes]
2834
+ */
2835
+ /**
2836
+ * @typedef StorePolygonServiceabilityFeature
2837
+ * @property {string} type - Type of the feature, typically Feature.
2838
+ * @property {Object} [properties] - Additional properties for the feature.
2839
+ * @property {StorePolygonServiceabilityGeometry} geometry
2840
+ */
2841
+ /**
2842
+ * @typedef StorePolygonServiceabilityGeometry
2843
+ * @property {string} [type] - Type of geometry, typically Polygon.
2844
+ * @property {number[][][]} [coordinates] - List of polygon coordinates as
2845
+ * longitude and latitude pairs.
2846
+ */
2847
+ /**
2848
+ * @typedef StorePolygonServiceabilityAttributes
2849
+ * @property {string} [contour_type] - Type of contour used for the polygon,
2850
+ * either distance-based or manually defined.
2851
+ * @property {number} [travel_distance] - Travel distance used to derive the
2852
+ * polygon contour, typically in meters.
2853
+ * @property {StorePolygonServiceabilityReferenceCoordinates} [reference_coordinates]
2854
+ */
2855
+ /**
2856
+ * @typedef StorePolygonServiceabilityReferenceCoordinates
2857
+ * @property {number} lng - Longitude of the reference point.
2858
+ * @property {number} lat - Latitude of the reference point.
2859
+ */
2860
+ /**
2861
+ * @typedef StorePolygonServiceabilityStoreSummary
2862
+ * @property {string} store_code - Unique identifier of the store.
2863
+ * @property {string} [name] - Name of the store.
2864
+ */
2865
+ /**
2866
+ * @typedef StorePolygonServiceabilityError
2867
+ * @property {string} store_code - Store code identifier.
2868
+ * @property {string} message - Detailed error message describing the validation
2869
+ * failure for a specific record.
2870
+ * @property {string} [error_code] - Error code for the failure.
2871
+ */
2872
+ /**
2873
+ * @typedef StorePolygonServiceabilityPagination
2874
+ * @property {number} page_size - Number of records per page.
2875
+ * @property {number} page_number - The current page number.
2876
+ * @property {boolean} has_next - Indicates whether more pages are available.
2877
+ * @property {number} total_records - Total number of records matching the criteria.
2878
+ */
2539
2879
  declare class ServiceabilityPlatformModel {
2540
2880
  }
2541
2881
  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 };
2882
+ 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, 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
2883
  }
2884
+ /** @returns {GenerateShipmentsAndCourierPartnerResult} */
2885
+ declare function GenerateShipmentsAndCourierPartnerResult(): GenerateShipmentsAndCourierPartnerResult;
2886
+ type GenerateShipmentsAndCourierPartnerResult = {
2887
+ /**
2888
+ * - Describes the shipment's journey or route.
2889
+ */
2890
+ journey?: string;
2891
+ to_serviceability?: CourierPartnerToServiceability;
2892
+ /**
2893
+ * - List of shipments
2894
+ * generated for the courier partner.
2895
+ */
2896
+ shipments?: CourierPartnerShipments[];
2897
+ /**
2898
+ * - Specifies the mode of payment for the shipment.
2899
+ */
2900
+ payment_mode?: string;
2901
+ /**
2902
+ * - The destination city for the shipment.
2903
+ */
2904
+ to_city?: string;
2905
+ /**
2906
+ * - Indicates if cash on delivery (COD)
2907
+ * is available.
2908
+ */
2909
+ is_cod_available?: boolean;
2910
+ };
2911
+ /** @returns {CourierPartnerDetails} */
2912
+ declare function CourierPartnerDetails(): CourierPartnerDetails;
2913
+ type CourierPartnerDetails = {
2914
+ to_serviceability: LocationDetailsServiceability;
2915
+ /**
2916
+ * - A list of shipments for the
2917
+ * courier partner request.
2918
+ */
2919
+ shipments: CourierPartnerShipments[];
2920
+ /**
2921
+ * - The journey details for the courier partner request.
2922
+ */
2923
+ journey: string;
2924
+ /**
2925
+ * - The payment mode for the courier partner request.
2926
+ */
2927
+ payment_mode?: string;
2928
+ /**
2929
+ * - This flag decided whether to run
2930
+ * delivery rules configuration for delivery rule fetch or not.
2931
+ */
2932
+ skip_delivery_rules?: boolean;
2933
+ };
2544
2934
  /** @returns {PlatformShipmentsRequestSchema} */
2545
2935
  declare function PlatformShipmentsRequestSchema(): PlatformShipmentsRequestSchema;
2546
2936
  type PlatformShipmentsRequestSchema = {
@@ -5491,38 +5881,719 @@ type CompanyConfigurationSchema = {
5491
5881
  */
5492
5882
  sort?: string[];
5493
5883
  };
5494
- /** @returns {PlatformLocationArticles} */
5495
- declare function PlatformLocationArticles(): PlatformLocationArticles;
5496
- type PlatformLocationArticles = {
5884
+ /** @returns {StorePolygonServiceabilityRequestBody} */
5885
+ declare function StorePolygonServiceabilityRequestBody(): StorePolygonServiceabilityRequestBody;
5886
+ type StorePolygonServiceabilityRequestBody = {
5887
+ data: StorePolygonServiceabilityRequestData;
5888
+ };
5889
+ /** @returns {StorePolygonServiceabilityResult} */
5890
+ declare function StorePolygonServiceabilityResult(): StorePolygonServiceabilityResult;
5891
+ type StorePolygonServiceabilityResult = {
5497
5892
  /**
5498
- * - List of articles for this
5499
- * fulfillment location.
5893
+ * - Indicates whether the polygon serviceability
5894
+ * operation was successful.
5500
5895
  */
5501
- articles: PlatformLocationArticle[];
5896
+ success: boolean;
5502
5897
  /**
5503
- * - Unique identifier for the
5504
- * fulfillment location.
5898
+ * - List of stores
5899
+ * for which polygon serviceability was successfully processed.
5505
5900
  */
5506
- fulfillment_location_id: number;
5901
+ data: StorePolygonServiceabilityStoreSummary[];
5507
5902
  /**
5508
- * - Tags associated with the
5509
- * fulfillment location.
5903
+ * - List of errors
5904
+ * encountered while processing individual entries, if any.
5510
5905
  */
5511
- fulfillment_tags?: string[];
5906
+ errors: StorePolygonServiceabilityError[];
5512
5907
  /**
5513
- * - Type of fulfillment (e.g., store, warehouse).
5908
+ * - Unique identifier for the polygon
5909
+ * serviceability request.
5514
5910
  */
5515
- fulfillment_type: string;
5911
+ identifier: string;
5912
+ /**
5913
+ * - List of
5914
+ * entries that failed during polygon serviceability processing.
5915
+ */
5916
+ failed_entries: StorePolygonServiceabilityError[];
5516
5917
  };
5517
- /** @returns {PlatformLocationArticle} */
5518
- declare function PlatformLocationArticle(): PlatformLocationArticle;
5519
- type PlatformLocationArticle = {
5918
+ /** @returns {StorePolygonServiceabilityGetResult} */
5919
+ declare function StorePolygonServiceabilityGetResult(): StorePolygonServiceabilityGetResult;
5920
+ type StorePolygonServiceabilityGetResult = {
5520
5921
  /**
5521
- * - The price of the article.
5922
+ * - Indicates whether the polygon serviceability
5923
+ * fetch operation was successful.
5522
5924
  */
5523
- price: number;
5925
+ success: boolean;
5524
5926
  /**
5525
- * - Unique identifier for the item.
5927
+ * - List of stores with
5928
+ * their polygon-based serviceability details.
5929
+ */
5930
+ data: StorePolygonServiceabilityStore[];
5931
+ /**
5932
+ * - List of errors
5933
+ * encountered while processing individual entries, if any.
5934
+ */
5935
+ errors: StorePolygonServiceabilityError[];
5936
+ /**
5937
+ * - Unique identifier for the polygon
5938
+ * serviceability request.
5939
+ */
5940
+ identifier: string;
5941
+ /**
5942
+ * - List of
5943
+ * entries that failed during polygon serviceability processing.
5944
+ */
5945
+ failed_entries: StorePolygonServiceabilityError[];
5946
+ /**
5947
+ * - Pagination
5948
+ * details for the polygon serviceability result set.
5949
+ */
5950
+ pagination: StorePolygonServiceabilityPagination;
5951
+ };
5952
+ /** @returns {ZoneProductsBulkPatchDetails} */
5953
+ declare function ZoneProductsBulkPatchDetails(): ZoneProductsBulkPatchDetails;
5954
+ type ZoneProductsBulkPatchDetails = {
5955
+ /**
5956
+ * - URL of the CSV file containing the zone
5957
+ * products bulk patch data.
5958
+ */
5959
+ file_url: string;
5960
+ };
5961
+ /** @returns {GetZoneProductsBulkPatchResult} */
5962
+ declare function GetZoneProductsBulkPatchResult(): GetZoneProductsBulkPatchResult;
5963
+ type GetZoneProductsBulkPatchResult = {
5964
+ /**
5965
+ * - A unique identifier for the performed batch operation.
5966
+ */
5967
+ batch_id: string;
5968
+ /**
5969
+ * - CDN path of the uploaded file.
5970
+ */
5971
+ file_path?: string;
5972
+ /**
5973
+ * - Total number of records in the batch.
5974
+ */
5975
+ total: number;
5976
+ /**
5977
+ * - Number of failed records in the batch.
5978
+ */
5979
+ failed: number;
5980
+ /**
5981
+ * - URL to the error file containing
5982
+ * details of failed records.
5983
+ */
5984
+ error_file_url?: string;
5985
+ /**
5986
+ * - The action performed during the bulk operation.
5987
+ */
5988
+ action: string;
5989
+ /**
5990
+ * - Timestamp when the batch was last updated.
5991
+ */
5992
+ updated_at: string;
5993
+ /**
5994
+ * - User who last updated the batch.
5995
+ */
5996
+ updated_by: string;
5997
+ /**
5998
+ * - Type of the bulk operation.
5999
+ */
6000
+ type: string;
6001
+ /**
6002
+ * - The unique identifier for the company.
6003
+ */
6004
+ company_id: number;
6005
+ /**
6006
+ * - A unique identifier for the sales channel.
6007
+ */
6008
+ application_id: string;
6009
+ /**
6010
+ * - Current stage of the bulk operation.
6011
+ */
6012
+ stage: string;
6013
+ /**
6014
+ * - Number of partially processed records.
6015
+ */
6016
+ partial?: number;
6017
+ /**
6018
+ * - URL to the result file after
6019
+ * processing is complete.
6020
+ */
6021
+ result_file_url?: string;
6022
+ };
6023
+ /** @returns {CourierPartnerToServiceability} */
6024
+ declare function CourierPartnerToServiceability(): CourierPartnerToServiceability;
6025
+ type CourierPartnerToServiceability = {
6026
+ location?: ServiceabilityLocation;
6027
+ /**
6028
+ * - The pincode of the serviceability location.
6029
+ */
6030
+ pincode?: string;
6031
+ /**
6032
+ * - The sector of the serviceability location.
6033
+ */
6034
+ sector?: string;
6035
+ /**
6036
+ * - The country where the serviceability location
6037
+ * is situated.
6038
+ */
6039
+ country?: string;
6040
+ /**
6041
+ * - The ISO code for the country.
6042
+ */
6043
+ country_iso_code?: string;
6044
+ /**
6045
+ * - The state of the serviceability location.
6046
+ */
6047
+ state?: string;
6048
+ /**
6049
+ * - The city of the serviceability location.
6050
+ */
6051
+ city?: string;
6052
+ };
6053
+ /** @returns {ServiceabilityLocation} */
6054
+ declare function ServiceabilityLocation(): ServiceabilityLocation;
6055
+ type ServiceabilityLocation = {
6056
+ /**
6057
+ * - The longitude of the serviceability location.
6058
+ */
6059
+ longitude: string;
6060
+ /**
6061
+ * - The latitude of the serviceability location.
6062
+ */
6063
+ latitude: string;
6064
+ };
6065
+ /** @returns {CourierPartnerShipments} */
6066
+ declare function CourierPartnerShipments(): CourierPartnerShipments;
6067
+ type CourierPartnerShipments = {
6068
+ promise?: PromiseObject;
6069
+ /**
6070
+ * - Indicates if cash on delivery (COD)
6071
+ * is available.
6072
+ */
6073
+ is_cod_available?: boolean;
6074
+ /**
6075
+ * - Specifies if the shipment should be
6076
+ * automatically assigned.
6077
+ */
6078
+ is_auto_assign?: boolean;
6079
+ meta?: CourierPartnerShipmentsMeta;
6080
+ /**
6081
+ * - The volumetric weight of the shipment.
6082
+ */
6083
+ volumetric_weight?: number;
6084
+ /**
6085
+ * - The actual weight of the shipment.
6086
+ */
6087
+ weight?: number;
6088
+ /**
6089
+ * - List of
6090
+ * courier partners associated with the shipment.
6091
+ */
6092
+ courier_partners?: ShipmentCourierPartnersResult[];
6093
+ /**
6094
+ * - The fulfillment Id.
6095
+ */
6096
+ fulfillment_id: number;
6097
+ /**
6098
+ * - Fulfillment Type
6099
+ */
6100
+ fulfillment_type: string;
6101
+ /**
6102
+ * - Fulfillment level tags
6103
+ */
6104
+ fulfillment_tags: string[];
6105
+ from_serviceability: LocationDetailsServiceability;
6106
+ /**
6107
+ * - A list of articles
6108
+ * in the courier partner shipment.
6109
+ */
6110
+ articles: CourierPartnerShipmentsArticles[];
6111
+ /**
6112
+ * - A boolean indicating if the courier partner
6113
+ * supports Made to Order service.
6114
+ */
6115
+ is_mto: boolean;
6116
+ /**
6117
+ * - A list of scheme_id which we want to
6118
+ * ignore in courier_partner assignment.
6119
+ */
6120
+ ignore_scheme_ids: string[];
6121
+ /**
6122
+ * - Error Details
6123
+ */
6124
+ error?: any;
6125
+ };
6126
+ /** @returns {PromiseObject} */
6127
+ declare function PromiseObject(): PromiseObject;
6128
+ type PromiseObject = {
6129
+ /**
6130
+ * - The minimum promised delivery time in ISO 8601 format.
6131
+ */
6132
+ min?: string;
6133
+ /**
6134
+ * - The maximum promised delivery time in ISO 8601 format.
6135
+ */
6136
+ max?: string;
6137
+ customer_promise: PromiseData;
6138
+ meta: PromiseMeta;
6139
+ };
6140
+ /** @returns {PromiseData} */
6141
+ declare function PromiseData(): PromiseData;
6142
+ type PromiseData = {
6143
+ /**
6144
+ * - The minimum promised delivery time in ISO 8601 format.
6145
+ */
6146
+ min?: string;
6147
+ /**
6148
+ * - The maximum promised delivery time in ISO 8601 format.
6149
+ */
6150
+ max?: string;
6151
+ };
6152
+ /** @returns {PromiseMeta} */
6153
+ declare function PromiseMeta(): PromiseMeta;
6154
+ type PromiseMeta = {
6155
+ seller_promise?: PromiseData;
6156
+ courier_partner_promise?: CourierPartnerPromiseData;
6157
+ customer_initial_promise?: PromiseData;
6158
+ };
6159
+ /** @returns {CourierPartnerPromiseData} */
6160
+ declare function CourierPartnerPromiseData(): CourierPartnerPromiseData;
6161
+ type CourierPartnerPromiseData = {
6162
+ /**
6163
+ * - The minimum promised delivery time in ISO 8601 format.
6164
+ */
6165
+ min?: string;
6166
+ /**
6167
+ * - The maximum promised delivery time in ISO 8601 format.
6168
+ */
6169
+ max?: string;
6170
+ attributes?: DeliveryTat;
6171
+ };
6172
+ /** @returns {DeliveryTat} */
6173
+ declare function DeliveryTat(): DeliveryTat;
6174
+ type DeliveryTat = {
6175
+ tat?: DeliveryTatSchema;
6176
+ };
6177
+ /** @returns {DeliveryTatSchema} */
6178
+ declare function DeliveryTatSchema(): DeliveryTatSchema;
6179
+ type DeliveryTatSchema = {
6180
+ /**
6181
+ * - The minimum tat in integer.
6182
+ */
6183
+ min?: number;
6184
+ /**
6185
+ * - The maximum tat in integer.
6186
+ */
6187
+ max?: number;
6188
+ };
6189
+ /** @returns {CourierPartnerShipmentsMeta} */
6190
+ declare function CourierPartnerShipmentsMeta(): CourierPartnerShipmentsMeta;
6191
+ type CourierPartnerShipmentsMeta = {
6192
+ /**
6193
+ * - The total cost associated with the
6194
+ * shipment, expressed as a floating-point number. This value includes all
6195
+ * applicable charges, such as transportation, handling, and any additional fees.
6196
+ */
6197
+ shipment_cost?: number;
6198
+ };
6199
+ /** @returns {ShipmentCourierPartnersResult} */
6200
+ declare function ShipmentCourierPartnersResult(): ShipmentCourierPartnersResult;
6201
+ type ShipmentCourierPartnersResult = {
6202
+ /**
6203
+ * - The Id of the courier partner.
6204
+ */
6205
+ extension_id: string;
6206
+ /**
6207
+ * - The scheme Id of the courier partner.
6208
+ */
6209
+ scheme_id: string;
6210
+ area_code: AreaCode;
6211
+ tat: TAT;
6212
+ /**
6213
+ * - The display name of the courier partner.
6214
+ */
6215
+ display_name: string;
6216
+ /**
6217
+ * - A boolean indicating quality control by
6218
+ * the courier partner.
6219
+ */
6220
+ is_qc_enabled: boolean;
6221
+ /**
6222
+ * - A boolean indicating it is self delivery DP support.
6223
+ */
6224
+ is_self_ship: boolean;
6225
+ /**
6226
+ * - Specifies if the courier partner
6227
+ * operates on its own account.
6228
+ */
6229
+ is_own_account?: boolean;
6230
+ /**
6231
+ * - The number of non-delivery report (NDR) attempts.
6232
+ */
6233
+ ndr_attempts?: number;
6234
+ /**
6235
+ * - Cutoff time for forward pickup (nullable).
6236
+ */
6237
+ forward_pickup_cutoff?: string;
6238
+ /**
6239
+ * - Cutoff time for reverse pickup (nullable).
6240
+ */
6241
+ reverse_pickup_cutoff?: string;
6242
+ /**
6243
+ * - Quantity of items under
6244
+ * quality control (nullable).
6245
+ */
6246
+ qc_shipment_item_quantity?: number;
6247
+ /**
6248
+ * - Quantity of items not
6249
+ * under quality control (nullable).
6250
+ */
6251
+ non_qc_shipment_item_quantity?: number;
6252
+ /**
6253
+ * - Specifies if the courier partner
6254
+ * operates on dangerous goods.
6255
+ */
6256
+ dangerous_goods?: boolean;
6257
+ /**
6258
+ * - Specifies if the courier partner
6259
+ * operates on restricted goods.
6260
+ */
6261
+ restricted_goods?: boolean;
6262
+ /**
6263
+ * - Specifies if the courier partner
6264
+ * operates on fragile goods.
6265
+ */
6266
+ fragile_goods?: boolean;
6267
+ /**
6268
+ * - Specifies if the courier partner
6269
+ * operates on cold storage goods.
6270
+ */
6271
+ cold_storage_goods?: boolean;
6272
+ /**
6273
+ * - Specifies type of courier partner.
6274
+ */
6275
+ delivery_type?: string;
6276
+ /**
6277
+ * - Specifies if the courier partner operates on
6278
+ * cash on delivery orders.
6279
+ */
6280
+ is_cod?: boolean;
6281
+ /**
6282
+ * - Mode of transport associated with the
6283
+ * courier partner scheme.
6284
+ */
6285
+ transport_type?: string;
6286
+ };
6287
+ /** @returns {AreaCode} */
6288
+ declare function AreaCode(): AreaCode;
6289
+ type AreaCode = {
6290
+ /**
6291
+ * - The starting area code.
6292
+ */
6293
+ source?: string;
6294
+ /**
6295
+ * - The ending area code.
6296
+ */
6297
+ destination?: string;
6298
+ };
6299
+ /** @returns {TAT} */
6300
+ declare function TAT(): TAT;
6301
+ type TAT = {
6302
+ /**
6303
+ * - The minimum tat in integer.
6304
+ */
6305
+ min?: number;
6306
+ /**
6307
+ * - The maximum tat in integer.
6308
+ */
6309
+ max?: number;
6310
+ };
6311
+ /** @returns {LocationDetailsServiceability} */
6312
+ declare function LocationDetailsServiceability(): LocationDetailsServiceability;
6313
+ type LocationDetailsServiceability = {
6314
+ /**
6315
+ * - The pincode of the serviceability location.
6316
+ */
6317
+ pincode?: string;
6318
+ /**
6319
+ * - The sector of the serviceability location.
6320
+ */
6321
+ sector?: string;
6322
+ /**
6323
+ * - The state of the serviceability location.
6324
+ */
6325
+ state?: string;
6326
+ /**
6327
+ * - The country of the serviceability location.
6328
+ */
6329
+ country: string;
6330
+ /**
6331
+ * - The city of the serviceability location.
6332
+ */
6333
+ city?: string;
6334
+ /**
6335
+ * - The ISO code of the country.
6336
+ */
6337
+ country_iso_code: string;
6338
+ location?: ServiceabilityLocation;
6339
+ };
6340
+ /** @returns {CourierPartnerShipmentsArticles} */
6341
+ declare function CourierPartnerShipmentsArticles(): CourierPartnerShipmentsArticles;
6342
+ type CourierPartnerShipmentsArticles = {
6343
+ /**
6344
+ * - A string serving as the unique identifier.
6345
+ */
6346
+ id?: string;
6347
+ /**
6348
+ * - Represents the delivery date and time
6349
+ * slots available for an article.
6350
+ */
6351
+ delivery_slots?: any;
6352
+ error?: Error;
6353
+ /**
6354
+ * - The fulfillment Id.
6355
+ */
6356
+ fulfillment_id?: number;
6357
+ /**
6358
+ * - Fulfillment level tags
6359
+ */
6360
+ fulfillment_tags?: string[];
6361
+ /**
6362
+ * - Fulfillment Type
6363
+ */
6364
+ fulfillment_type?: string;
6365
+ /**
6366
+ * - The group Id of the article.
6367
+ */
6368
+ group_id?: string;
6369
+ /**
6370
+ * - A boolean indicating if the courier partner
6371
+ * supports gift shipments.
6372
+ */
6373
+ is_gift?: boolean;
6374
+ /**
6375
+ * - Flag indicating whether the shipment is MTO
6376
+ * (Make to Order).
6377
+ */
6378
+ is_mto?: boolean;
6379
+ /**
6380
+ * - A boolean indicating whether the article is a set.
6381
+ */
6382
+ is_set?: boolean;
6383
+ /**
6384
+ * - The manufacturing time of the article.
6385
+ */
6386
+ manufacturing_time?: number;
6387
+ /**
6388
+ * - The unit of measurement for
6389
+ * manufacturing time.
6390
+ */
6391
+ manufacturing_time_unit?: string;
6392
+ /**
6393
+ * - The Made to Order quantity of the article.
6394
+ */
6395
+ mto_quantity?: number;
6396
+ /**
6397
+ * - Service level agreement (SLA) for the article,
6398
+ * represented as a date-time
6399
+ */
6400
+ sla?: string;
6401
+ /**
6402
+ * - Marked price before discounts.
6403
+ */
6404
+ price_marked?: number;
6405
+ promise?: CourierPartnerArticlesPromise;
6406
+ /**
6407
+ * - Additional properties related to sets.
6408
+ */
6409
+ set?: any;
6410
+ return_reason?: CourierPartnerArticlesReturnReasons;
6411
+ /**
6412
+ * - It represents the number of set of this article
6413
+ */
6414
+ set_quantity?: number;
6415
+ /**
6416
+ * - The quantity of the shipment article.
6417
+ */
6418
+ quantity: number;
6419
+ weight: ArticleWeight;
6420
+ attributes?: ArticleAttributes;
6421
+ /**
6422
+ * - The category Id of the article.
6423
+ */
6424
+ category_id: number;
6425
+ dimension: ArticleDimension;
6426
+ /**
6427
+ * - The brand Id of the article.
6428
+ */
6429
+ brand_id: number;
6430
+ /**
6431
+ * - The Item Id of the article.
6432
+ */
6433
+ item_id: number;
6434
+ /**
6435
+ * - The size of the article.
6436
+ */
6437
+ size: string;
6438
+ /**
6439
+ * - Tags assigned to Item
6440
+ */
6441
+ tags: string[];
6442
+ /**
6443
+ * - Department of the item
6444
+ */
6445
+ department_id: number;
6446
+ /**
6447
+ * - Final Price of the article after discounts
6448
+ */
6449
+ price: number;
6450
+ };
6451
+ /** @returns {CourierPartnerArticlesPromise} */
6452
+ declare function CourierPartnerArticlesPromise(): CourierPartnerArticlesPromise;
6453
+ type CourierPartnerArticlesPromise = {
6454
+ /**
6455
+ * - The minimum delivery promise date.
6456
+ */
6457
+ min?: string;
6458
+ /**
6459
+ * - The maximum delivery promise date.
6460
+ */
6461
+ max?: string;
6462
+ };
6463
+ /** @returns {CourierPartnerArticlesReturnReasons} */
6464
+ declare function CourierPartnerArticlesReturnReasons(): CourierPartnerArticlesReturnReasons;
6465
+ type CourierPartnerArticlesReturnReasons = {
6466
+ /**
6467
+ * - The unique identifier for the return reason entry.
6468
+ */
6469
+ id?: number;
6470
+ meta?: CourierPartnerArticlesReturnReasonsMeta;
6471
+ /**
6472
+ * - A list of quality check types that apply to
6473
+ * the return reasons.
6474
+ */
6475
+ qc_type?: string[];
6476
+ /**
6477
+ * - A list of return reasons for the article.
6478
+ */
6479
+ reasons?: string[];
6480
+ /**
6481
+ * - A boolean indicating whether the return
6482
+ * reason is currently active.
6483
+ */
6484
+ is_active?: boolean;
6485
+ /**
6486
+ * - The display name for the return reason.
6487
+ */
6488
+ display_name?: string;
6489
+ /**
6490
+ * - A list of questions associated with the
6491
+ * return reason.
6492
+ */
6493
+ question_set?: string[];
6494
+ /**
6495
+ * - Any additional text for other return reasons.
6496
+ */
6497
+ reason_other_text?: string;
6498
+ };
6499
+ /** @returns {CourierPartnerArticlesReturnReasonsMeta} */
6500
+ declare function CourierPartnerArticlesReturnReasonsMeta(): CourierPartnerArticlesReturnReasonsMeta;
6501
+ type CourierPartnerArticlesReturnReasonsMeta = {
6502
+ /**
6503
+ * - A boolean indicating whether a text
6504
+ * area should be displayed for additional input regarding the return reason.
6505
+ */
6506
+ show_text_area?: boolean;
6507
+ };
6508
+ /** @returns {ArticleWeight} */
6509
+ declare function ArticleWeight(): ArticleWeight;
6510
+ type ArticleWeight = {
6511
+ /**
6512
+ * - The weight(grams) of the article for shipping
6513
+ * purposes, typically measured in a specified unit.
6514
+ */
6515
+ shipping: number;
6516
+ /**
6517
+ * - The unit of measurement used for the weight value.
6518
+ */
6519
+ unit: string;
6520
+ /**
6521
+ * - A boolean indicating whether this weight is
6522
+ * the default weight for the article.
6523
+ */
6524
+ is_default: boolean;
6525
+ };
6526
+ /** @returns {ArticleAttributes} */
6527
+ declare function ArticleAttributes(): ArticleAttributes;
6528
+ type ArticleAttributes = {
6529
+ /**
6530
+ * - Yes/no indicating whether the article
6531
+ * is powered by batteries.
6532
+ */
6533
+ battery_operated: string;
6534
+ /**
6535
+ * - Yes/no indicating whether the article is
6536
+ * considered flammable or poses a fire hazard.
6537
+ */
6538
+ is_flammable: string;
6539
+ };
6540
+ /** @returns {ArticleDimension} */
6541
+ declare function ArticleDimension(): ArticleDimension;
6542
+ type ArticleDimension = {
6543
+ /**
6544
+ * - The height of the article.
6545
+ */
6546
+ height: number;
6547
+ /**
6548
+ * - A boolean indicating whether this dimension
6549
+ * is the default dimension.
6550
+ */
6551
+ is_default: boolean;
6552
+ /**
6553
+ * - The length of the article.
6554
+ */
6555
+ length: number;
6556
+ /**
6557
+ * - The unit of measurement used for the dimensions.
6558
+ */
6559
+ unit: string;
6560
+ /**
6561
+ * - The width of the article.
6562
+ */
6563
+ width: number;
6564
+ };
6565
+ /** @returns {PlatformLocationArticles} */
6566
+ declare function PlatformLocationArticles(): PlatformLocationArticles;
6567
+ type PlatformLocationArticles = {
6568
+ /**
6569
+ * - List of articles for this
6570
+ * fulfillment location.
6571
+ */
6572
+ articles: PlatformLocationArticle[];
6573
+ /**
6574
+ * - Unique identifier for the
6575
+ * fulfillment location.
6576
+ */
6577
+ fulfillment_location_id: number;
6578
+ /**
6579
+ * - Tags associated with the
6580
+ * fulfillment location.
6581
+ */
6582
+ fulfillment_tags?: string[];
6583
+ /**
6584
+ * - Type of fulfillment (e.g., store, warehouse).
6585
+ */
6586
+ fulfillment_type: string;
6587
+ };
6588
+ /** @returns {PlatformLocationArticle} */
6589
+ declare function PlatformLocationArticle(): PlatformLocationArticle;
6590
+ type PlatformLocationArticle = {
6591
+ /**
6592
+ * - The price of the article.
6593
+ */
6594
+ price: number;
6595
+ /**
6596
+ * - Unique identifier for the item.
5526
6597
  */
5527
6598
  item_id: number;
5528
6599
  /**
@@ -6000,30 +7071,6 @@ type ShipmentsCourierPartner = {
6000
7071
  */
6001
7072
  non_qc_shipment_item_quantity?: number;
6002
7073
  };
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 = {
6018
- /**
6019
- * - The minimum tat in integer.
6020
- */
6021
- min?: number;
6022
- /**
6023
- * - The maximum tat in integer.
6024
- */
6025
- max?: number;
6026
- };
6027
7074
  /** @returns {BusinessUnit} */
6028
7075
  declare function BusinessUnit(): BusinessUnit;
6029
7076
  type BusinessUnit = {
@@ -6647,6 +7694,12 @@ type ProductSchema = {
6647
7694
  * type of products selected for the delivery zone.
6648
7695
  */
6649
7696
  values: any[];
7697
+ /**
7698
+ * - The action to perform on the product values -
7699
+ * 'add' to add values to the existing list, 'remove' to remove values from
7700
+ * the existing list.
7701
+ */
7702
+ action?: string;
6650
7703
  };
6651
7704
  /** @returns {StoresSchema} */
6652
7705
  declare function StoresSchema(): StoresSchema;
@@ -7546,63 +8599,6 @@ type ShipmentsArticles = {
7546
8599
  delivery_slots?: ArticleDeliverySlots;
7547
8600
  return_reason?: ArticleReturnReason;
7548
8601
  };
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
8602
  /** @returns {ArticleSet} */
7607
8603
  declare function ArticleSet(): ArticleSet;
7608
8604
  type ArticleSet = {
@@ -8136,47 +9132,6 @@ type ArticleAssignment = {
8136
9132
  */
8137
9133
  strategy?: string;
8138
9134
  };
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
9135
  /** @returns {OptimalLocationsArticles} */
8181
9136
  declare function OptimalLocationsArticles(): OptimalLocationsArticles;
8182
9137
  type OptimalLocationsArticles = {
@@ -8846,3 +9801,220 @@ type HistoryObject = {
8846
9801
  */
8847
9802
  total_error_count?: number;
8848
9803
  };
9804
+ /** @returns {StorePolygonServiceabilityRequestData} */
9805
+ declare function StorePolygonServiceabilityRequestData(): StorePolygonServiceabilityRequestData;
9806
+ type StorePolygonServiceabilityRequestData = {
9807
+ /**
9808
+ * - List of stores for
9809
+ * which polygon-based serviceability is being configured.
9810
+ */
9811
+ stores: StorePolygonServiceabilityStore[];
9812
+ };
9813
+ /** @returns {StorePolygonServiceabilityStore} */
9814
+ declare function StorePolygonServiceabilityStore(): StorePolygonServiceabilityStore;
9815
+ type StorePolygonServiceabilityStore = {
9816
+ /**
9817
+ * - Unique identifier of the store.
9818
+ */
9819
+ store_code: string;
9820
+ /**
9821
+ * - Name of the store.
9822
+ */
9823
+ name: string;
9824
+ /**
9825
+ * - Address of the store.
9826
+ */
9827
+ address: string;
9828
+ /**
9829
+ * - Area code associated with the store.
9830
+ */
9831
+ area_code: string;
9832
+ /**
9833
+ * - Indicates whether the store is active.
9834
+ */
9835
+ is_active: boolean;
9836
+ /**
9837
+ * - Additional metadata associated with the store.
9838
+ */
9839
+ meta?: any;
9840
+ coordinates: StorePolygonServiceabilityStoreCoordinates;
9841
+ /**
9842
+ * - List of
9843
+ * polygon-based serviceability configurations for the store.
9844
+ */
9845
+ serviceabilities: StorePolygonServiceabilityConfig[];
9846
+ /**
9847
+ * - Timestamp when the store entry was created.
9848
+ */
9849
+ created_at?: string;
9850
+ /**
9851
+ * - Timestamp when the store entry was last updated.
9852
+ */
9853
+ updated_at?: string;
9854
+ };
9855
+ /** @returns {StorePolygonServiceabilityStoreCoordinates} */
9856
+ declare function StorePolygonServiceabilityStoreCoordinates(): StorePolygonServiceabilityStoreCoordinates;
9857
+ type StorePolygonServiceabilityStoreCoordinates = {
9858
+ /**
9859
+ * - Longitude of the store.
9860
+ */
9861
+ lng: number;
9862
+ /**
9863
+ * - Latitude of the store.
9864
+ */
9865
+ lat: number;
9866
+ };
9867
+ /** @returns {StorePolygonServiceabilityConfig} */
9868
+ declare function StorePolygonServiceabilityConfig(): StorePolygonServiceabilityConfig;
9869
+ type StorePolygonServiceabilityConfig = {
9870
+ /**
9871
+ * - Name of the polygon-based serviceability configuration.
9872
+ */
9873
+ name: string;
9874
+ /**
9875
+ * - Type of serviceability
9876
+ * configuration. Currently supports quick_commerce.
9877
+ */
9878
+ serviceability_type: string;
9879
+ polygon: StorePolygonServiceabilityPolygon;
9880
+ /**
9881
+ * - Additional metadata associated with the
9882
+ * serviceability configuration.
9883
+ */
9884
+ meta?: any;
9885
+ /**
9886
+ * - Indicates whether the serviceability
9887
+ * configuration is active.
9888
+ */
9889
+ is_active: boolean;
9890
+ /**
9891
+ * - Unique identifier of the serviceability configuration.
9892
+ */
9893
+ uid?: string;
9894
+ /**
9895
+ * - Timestamp when the serviceability
9896
+ * configuration was created.
9897
+ */
9898
+ created_at?: string;
9899
+ /**
9900
+ * - Timestamp when the serviceability
9901
+ * configuration was last updated.
9902
+ */
9903
+ updated_at?: string;
9904
+ };
9905
+ /** @returns {StorePolygonServiceabilityPolygon} */
9906
+ declare function StorePolygonServiceabilityPolygon(): StorePolygonServiceabilityPolygon;
9907
+ type StorePolygonServiceabilityPolygon = {
9908
+ /**
9909
+ * - Type of the GeoJSON collection, typically FeatureCollection.
9910
+ */
9911
+ type: string;
9912
+ /**
9913
+ * - List of GeoJSON
9914
+ * features defining the polygon.
9915
+ */
9916
+ features: StorePolygonServiceabilityFeature[];
9917
+ attributes?: StorePolygonServiceabilityAttributes;
9918
+ };
9919
+ /** @returns {StorePolygonServiceabilityFeature} */
9920
+ declare function StorePolygonServiceabilityFeature(): StorePolygonServiceabilityFeature;
9921
+ type StorePolygonServiceabilityFeature = {
9922
+ /**
9923
+ * - Type of the feature, typically Feature.
9924
+ */
9925
+ type: string;
9926
+ /**
9927
+ * - Additional properties for the feature.
9928
+ */
9929
+ properties?: any;
9930
+ geometry: StorePolygonServiceabilityGeometry;
9931
+ };
9932
+ /** @returns {StorePolygonServiceabilityGeometry} */
9933
+ declare function StorePolygonServiceabilityGeometry(): StorePolygonServiceabilityGeometry;
9934
+ type StorePolygonServiceabilityGeometry = {
9935
+ /**
9936
+ * - Type of geometry, typically Polygon.
9937
+ */
9938
+ type?: string;
9939
+ /**
9940
+ * - List of polygon coordinates as
9941
+ * longitude and latitude pairs.
9942
+ */
9943
+ coordinates?: number[][][];
9944
+ };
9945
+ /** @returns {StorePolygonServiceabilityAttributes} */
9946
+ declare function StorePolygonServiceabilityAttributes(): StorePolygonServiceabilityAttributes;
9947
+ type StorePolygonServiceabilityAttributes = {
9948
+ /**
9949
+ * - Type of contour used for the polygon,
9950
+ * either distance-based or manually defined.
9951
+ */
9952
+ contour_type?: string;
9953
+ /**
9954
+ * - Travel distance used to derive the
9955
+ * polygon contour, typically in meters.
9956
+ */
9957
+ travel_distance?: number;
9958
+ reference_coordinates?: StorePolygonServiceabilityReferenceCoordinates;
9959
+ };
9960
+ /** @returns {StorePolygonServiceabilityReferenceCoordinates} */
9961
+ declare function StorePolygonServiceabilityReferenceCoordinates(): StorePolygonServiceabilityReferenceCoordinates;
9962
+ type StorePolygonServiceabilityReferenceCoordinates = {
9963
+ /**
9964
+ * - Longitude of the reference point.
9965
+ */
9966
+ lng: number;
9967
+ /**
9968
+ * - Latitude of the reference point.
9969
+ */
9970
+ lat: number;
9971
+ };
9972
+ /** @returns {StorePolygonServiceabilityStoreSummary} */
9973
+ declare function StorePolygonServiceabilityStoreSummary(): StorePolygonServiceabilityStoreSummary;
9974
+ type StorePolygonServiceabilityStoreSummary = {
9975
+ /**
9976
+ * - Unique identifier of the store.
9977
+ */
9978
+ store_code: string;
9979
+ /**
9980
+ * - Name of the store.
9981
+ */
9982
+ name?: string;
9983
+ };
9984
+ /** @returns {StorePolygonServiceabilityError} */
9985
+ declare function StorePolygonServiceabilityError(): StorePolygonServiceabilityError;
9986
+ type StorePolygonServiceabilityError = {
9987
+ /**
9988
+ * - Store code identifier.
9989
+ */
9990
+ store_code: string;
9991
+ /**
9992
+ * - Detailed error message describing the validation
9993
+ * failure for a specific record.
9994
+ */
9995
+ message: string;
9996
+ /**
9997
+ * - Error code for the failure.
9998
+ */
9999
+ error_code?: string;
10000
+ };
10001
+ /** @returns {StorePolygonServiceabilityPagination} */
10002
+ declare function StorePolygonServiceabilityPagination(): StorePolygonServiceabilityPagination;
10003
+ type StorePolygonServiceabilityPagination = {
10004
+ /**
10005
+ * - Number of records per page.
10006
+ */
10007
+ page_size: number;
10008
+ /**
10009
+ * - The current page number.
10010
+ */
10011
+ page_number: number;
10012
+ /**
10013
+ * - Indicates whether more pages are available.
10014
+ */
10015
+ has_next: boolean;
10016
+ /**
10017
+ * - Total number of records matching the criteria.
10018
+ */
10019
+ total_records: number;
10020
+ };