@gofynd/fdk-client-javascript 3.11.0 → 3.13.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 (32) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +16 -6
  4. package/sdk/application/Catalog/CatalogApplicationClient.js +71 -12
  5. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +80 -80
  6. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +48 -48
  7. package/sdk/platform/Cart/CartPlatformModel.d.ts +6 -18
  8. package/sdk/platform/Cart/CartPlatformModel.js +2 -36
  9. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +14 -48
  10. package/sdk/platform/Catalog/CatalogPlatformClient.js +85 -338
  11. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +207 -763
  12. package/sdk/platform/Catalog/CatalogPlatformModel.js +107 -392
  13. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +15 -71
  14. package/sdk/platform/Catalog/CatalogPlatformValidator.js +14 -60
  15. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +36 -0
  16. package/sdk/platform/Order/OrderPlatformApplicationClient.js +252 -0
  17. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +34 -1
  18. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +42 -0
  19. package/sdk/platform/Order/OrderPlatformClient.d.ts +69 -7
  20. package/sdk/platform/Order/OrderPlatformClient.js +453 -7
  21. package/sdk/platform/Order/OrderPlatformModel.d.ts +1938 -493
  22. package/sdk/platform/Order/OrderPlatformModel.js +1238 -506
  23. package/sdk/platform/Order/OrderPlatformValidator.d.ts +162 -16
  24. package/sdk/platform/Order/OrderPlatformValidator.js +111 -9
  25. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +14 -0
  26. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +85 -0
  27. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +17 -1
  28. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +16 -0
  29. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +861 -178
  30. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +534 -84
  31. package/sdk/public/Webhook/WebhookPublicModel.d.ts +5 -0
  32. package/sdk/public/Webhook/WebhookPublicModel.js +2 -0
@@ -1,4 +1,26 @@
1
1
  export = ServiceabilityPlatformModel;
2
+ /**
3
+ * @typedef PlatformShipmentsRequestSchema
4
+ * @property {string} journey - The journey or route for the shipment.
5
+ * @property {PlatformLocationArticles[]} location_articles - A list of articles
6
+ * associated with the shipment location, grouped by fulfillment details.
7
+ * @property {PlatformShipmentsToServiceability} to_serviceability
8
+ * @property {string} [payment_mode] - The payment mode for the shipment,
9
+ * nullable if not applicable.
10
+ */
11
+ /**
12
+ * @typedef PlatformShipmentsResponseSchema
13
+ * @property {boolean} is_cod_available - Flag indicating whether Cash on
14
+ * Delivery (COD) is available for the shipment.
15
+ * @property {PlatformShipmentsSchema[]} shipments - List of shipments generated
16
+ * for the courier partner.
17
+ */
18
+ /**
19
+ * @typedef ShipmentsErrorResult
20
+ * @property {string} [message] - The error message describing the issue.
21
+ * @property {string} type - A string property defining error type
22
+ * @property {string} value - A string property providing value which is causing error
23
+ */
2
24
  /**
3
25
  * @typedef FulfillmentOption
4
26
  * @property {string} [name] - Name of the fulfillment option.
@@ -1163,6 +1185,208 @@ export = ServiceabilityPlatformModel;
1163
1185
  * @typedef CompanyConfigurationSchema
1164
1186
  * @property {string[]} [sort] - An array of strings specifying sorting preferences.
1165
1187
  */
1188
+ /**
1189
+ * @typedef PlatformLocationArticles
1190
+ * @property {PlatformLocationArticle[]} articles - List of articles for this
1191
+ * fulfillment location.
1192
+ * @property {number} [fulfillment_location_id] - Unique identifier for the
1193
+ * fulfillment location.
1194
+ * @property {string[]} [fulfillment_tags] - Tags associated with the
1195
+ * fulfillment location.
1196
+ * @property {string} fulfillment_type - Type of fulfillment (e.g., store, warehouse).
1197
+ */
1198
+ /**
1199
+ * @typedef PlatformLocationArticle
1200
+ * @property {number} price - The price of the article.
1201
+ * @property {number} item_id - Unique identifier for the item.
1202
+ * @property {string} size - The size of the article.
1203
+ * @property {number} quantity - The quantity of the article.
1204
+ * @property {ParentItemIdentifiers} [parent_item_identifiers]
1205
+ */
1206
+ /**
1207
+ * @typedef ParentItemIdentifiers
1208
+ * @property {string} identifier - Identifier of the parent item.
1209
+ * @property {string} parent_item_id - Parent item id.
1210
+ * @property {string} parent_item_size - Parent item size.
1211
+ */
1212
+ /**
1213
+ * @typedef PlatformShipmentsToServiceability
1214
+ * @property {string} [pincode] - The pincode of the serviceability location.
1215
+ * @property {string} [sector] - The sector of the serviceability location.
1216
+ * @property {string} [state] - The state of the serviceability location.
1217
+ * @property {string} [country] - The country of the serviceability location.
1218
+ * @property {string} [city] - The city of the serviceability location.
1219
+ * @property {string} [country_iso_code] - The ISO code of the country.
1220
+ */
1221
+ /**
1222
+ * @typedef PlatformShipmentsSchema
1223
+ * @property {string[]} [tags] - Additional tags associated with the shipment.
1224
+ * @property {Packaging} [packaging]
1225
+ * @property {FulfillmentOptionItem} [fulfillment_option]
1226
+ * @property {number} [weight] - The total weight of the shipment.
1227
+ * @property {string} [shipment_type] - The type of shipment.
1228
+ * @property {boolean} [is_auto_assign] - Indicates whether courier partners
1229
+ * should be automatically assigned to this shipment based on the store's
1230
+ * auto-assignment configuration.
1231
+ * @property {number} [volumetric_weight] - Volumetric weight of the shipment.
1232
+ * @property {string[]} [fulfillment_tags] - Tags associated with the fulfillment.
1233
+ * @property {ShipmentsPromise} [promise]
1234
+ * @property {boolean} [is_ewaybill_enabled] - Flag indicating whether an
1235
+ * ewaybill is enabled for the shipment.
1236
+ * @property {boolean} [is_mto] - Flag indicating whether the shipment is MTO
1237
+ * (Make to Order).
1238
+ * @property {ShipmentsArticle[]} [articles] - List of articles in the shipment.
1239
+ * @property {string} [fulfillment_type] - Type of fulfillment (e.g., high_street).
1240
+ * @property {boolean} [mps] - Flag indicating whether MPS (Multi-Part Shipment)
1241
+ * is enabled for the shipment.
1242
+ * @property {number} [fulfillment_location_id] - Unique identifier for the
1243
+ * fulfillment location.
1244
+ * @property {ShipmentsCourierPartner[]} [courier_partners] - List of courier
1245
+ * partners handling the shipment.
1246
+ */
1247
+ /**
1248
+ * @typedef Packaging
1249
+ * @property {string} [name] - The name of the packaging.
1250
+ * @property {string} [id] - A string serving as the unique identifier.
1251
+ * @property {Dimension} [dimension]
1252
+ */
1253
+ /**
1254
+ * @typedef Dimension
1255
+ * @property {number} [length] - Length of the packaging.
1256
+ * @property {number} [width] - Width of the packaging.
1257
+ * @property {number} [height] - Height of the packaging.
1258
+ */
1259
+ /**
1260
+ * @typedef FulfillmentOptionItem
1261
+ * @property {string} [slug] - Unique identifier for the delivery type.
1262
+ * @property {string} [description] - Description of the delivery service.
1263
+ * @property {boolean} [is_default] - Indicates if this is the default delivery option.
1264
+ * @property {string} [id] - Unique ID of the delivery service.
1265
+ * @property {string} [type] - Type of fulfillment option.
1266
+ * @property {string} [name] - Name of the delivery service.
1267
+ */
1268
+ /**
1269
+ * @typedef ShipmentsPromise
1270
+ * @property {string} [min] - The minimum shipment promise time.
1271
+ * @property {string} [max] - The maximum shipment promise time.
1272
+ * @property {CustomerPromise} [customer_promise]
1273
+ * @property {ShipmentPromiseMeta} [meta]
1274
+ */
1275
+ /**
1276
+ * @typedef CustomerPromise
1277
+ * @property {string} [min] - The earliest possible date and time when the
1278
+ * shipment is expected to be delivered. This timestamp is in ISO 8601 format
1279
+ * @property {string} [max] - The latest possible date and time when the
1280
+ * shipment is expected to be delivered. This timestamp is in ISO 8601 format
1281
+ */
1282
+ /**
1283
+ * @typedef ShipmentPromiseMeta
1284
+ * @property {SellerPromise} [seller_promise]
1285
+ * @property {CourierPartnerPromise} [courier_partner_promise]
1286
+ * @property {CustomerInitialPromise} [customer_initial_promise]
1287
+ */
1288
+ /**
1289
+ * @typedef SellerPromise
1290
+ * @property {string} [min] - Minimum seller delivery promise time.
1291
+ * @property {string} [max] - Maximum seller delivery promise time.
1292
+ */
1293
+ /**
1294
+ * @typedef CourierPartnerPromise
1295
+ * @property {string} min - Minimum courier partner delivery promise time.
1296
+ * @property {string} max - Maximum courier partner delivery promise time.
1297
+ * @property {CourierPartnerAttributes} [attributes]
1298
+ */
1299
+ /**
1300
+ * @typedef CourierPartnerAttributes
1301
+ * @property {CourierPartnerTAT} [tat]
1302
+ */
1303
+ /**
1304
+ * @typedef CourierPartnerTAT
1305
+ * @property {number} [min] - Minimum turnaround time.
1306
+ * @property {number} [max] - Maximum turnaround time.
1307
+ */
1308
+ /**
1309
+ * @typedef CustomerInitialPromise
1310
+ * @property {string} [min] - Minimum initial customer delivery promise time.
1311
+ * @property {string} [max] - Maximum initial customer delivery promise time.
1312
+ */
1313
+ /**
1314
+ * @typedef ShipmentsArticle
1315
+ * @property {string} [id] - A string serving as the unique identifier.
1316
+ * @property {number} [quantity] - The quantity of the shipment article.
1317
+ * @property {number} [item_id] - The Item Id of the article.
1318
+ * @property {string} [size] - The size of the article.
1319
+ * @property {number} [price] - Final Price of the article after discounts
1320
+ * @property {number} [price_marked] - Marked price before discounts (nullable).
1321
+ * @property {number} [department_id] - Department of the item
1322
+ * @property {number} [weight] - Weight of the article.
1323
+ * @property {Object} [attributes] - Additional attributes for the article.
1324
+ * @property {number} [category_id] - Category Id of the article.
1325
+ * @property {number} [brand_id] - Brand Id of the article.
1326
+ * @property {ShipmentDimension} [dimension]
1327
+ * @property {string[]} [tags] - List of tags associated with the article.
1328
+ * @property {number} [manufacturing_time] - Time required for manufacturing.
1329
+ * @property {string} [manufacturing_time_unit] - Unit for manufacturing time.
1330
+ * @property {Object} [set] - Additional properties related to sets.
1331
+ * @property {boolean} [is_set] - Indicates if the article is part of a set.
1332
+ * @property {Object} [_custom_json] - Custom JSON metadata.
1333
+ * @property {string} [return_reason] - Reason for returning the article (nullable).
1334
+ * @property {string} [group_id] - Group Id for the article.
1335
+ * @property {ShipmentsMeta} [meta]
1336
+ * @property {boolean} [is_mto] - Indicates whether the article is made-to-order (MTO)
1337
+ * @property {string} [sla] - Service level agreement (SLA) for the article,
1338
+ * represented as a date-time
1339
+ */
1340
+ /**
1341
+ * @typedef ShipmentDimension
1342
+ * @property {number} height - Height of the shipment in centimeters.
1343
+ * @property {number} length - Length of the shipment in centimeters.
1344
+ * @property {number} width - Width of the shipment in centimeters.
1345
+ * @property {boolean} [is_default] - If the dimensions are default.
1346
+ * @property {string} [unit] - Measurement unit for dimensions.
1347
+ */
1348
+ /**
1349
+ * @typedef ShipmentsMeta
1350
+ * @property {boolean} [is_set] - Whether the article is part of a set
1351
+ * @property {Object} [set] - Set details for the article, if applicable
1352
+ * @property {boolean} [is_set_article] - Whether the article is a set item
1353
+ * @property {number} [set_quantity] - Quantity of the set item
1354
+ * @property {string} [split_article_id] - Id of the split article, if applicable
1355
+ * @property {string[]} [promo_ids] - List of promotion Ids applicable to the article
1356
+ */
1357
+ /**
1358
+ * @typedef ShipmentsCourierPartner
1359
+ * @property {string} [extension_id] - A string that uniquely identifies the
1360
+ * courier partner extension.
1361
+ * @property {string} [scheme_id] - Unique identifier for the scheme, used to
1362
+ * fetch or modify scheme details.
1363
+ * @property {AreaCode} [area_code]
1364
+ * @property {TAT} [tat]
1365
+ * @property {string} [display_name] - The display name of the courier partner.
1366
+ * @property {boolean} [is_qc_enabled] - A boolean indicating quality control by
1367
+ * the courier partner.
1368
+ * @property {boolean} [is_self_ship] - Indicates whether the courier account
1369
+ * supports self-shipping (true if it does, false otherwise).
1370
+ * @property {boolean} [is_own_account] - Indicates whether the courier account
1371
+ * is an own account (true if it is, false otherwise).
1372
+ * @property {number} [ndr_attempts] - The number of non-delivery report (NDR) attempts.
1373
+ * @property {string} [forward_pickup_cutoff] - Cutoff time for forward pickup (nullable).
1374
+ * @property {string} [reverse_pickup_cutoff] - Cutoff time for reverse pickup (nullable).
1375
+ * @property {number} [qc_shipment_item_quantity] - Quantity of items under
1376
+ * quality control (nullable).
1377
+ * @property {number} [non_qc_shipment_item_quantity] - Quantity of items not
1378
+ * under quality control (nullable).
1379
+ */
1380
+ /**
1381
+ * @typedef AreaCode
1382
+ * @property {string} [source] - The starting area code.
1383
+ * @property {string} [destination] - The ending area code.
1384
+ */
1385
+ /**
1386
+ * @typedef TAT
1387
+ * @property {number} [min] - The minimum tat in integer.
1388
+ * @property {number} [max] - The maximum tat in integer.
1389
+ */
1166
1390
  /**
1167
1391
  * @typedef BusinessUnit
1168
1392
  * @property {string} [name] - Name of the business unit.
@@ -1194,15 +1418,6 @@ export = ServiceabilityPlatformModel;
1194
1418
  * @property {string} [scheme_id] - Unique identifier for the courier partner scheme.
1195
1419
  * @property {string} [cp_ext_id] - Unique identifier for the courier partner.
1196
1420
  */
1197
- /**
1198
- * @typedef FulfillmentOptionItem
1199
- * @property {string} [slug] - Unique identifier for the delivery type.
1200
- * @property {string} [description] - Description of the delivery service.
1201
- * @property {boolean} [is_default] - Indicates if this is the default delivery option.
1202
- * @property {string} [id] - Unique ID of the delivery service.
1203
- * @property {string} [type] - Type of fulfillment option.
1204
- * @property {string} [name] - Name of the delivery service.
1205
- */
1206
1421
  /**
1207
1422
  * @typedef FulfillmentOptionProduct
1208
1423
  * @property {number} [uid] - Unique identifier for the product.
@@ -1680,14 +1895,6 @@ export = ServiceabilityPlatformModel;
1680
1895
  * @property {string} [location_type] - Type of that particular location.
1681
1896
  * @property {ShipmentsArticles[]} [articles] - List of articles in the shipment.
1682
1897
  */
1683
- /**
1684
- * @typedef ShipmentDimension
1685
- * @property {number} height - Height of the shipment in centimeters.
1686
- * @property {number} length - Length of the shipment in centimeters.
1687
- * @property {number} width - Width of the shipment in centimeters.
1688
- * @property {boolean} [is_default] - If the dimensions are default.
1689
- * @property {string} [unit] - Measurement unit for dimensions.
1690
- */
1691
1898
  /**
1692
1899
  * @typedef ShipmentsArticles
1693
1900
  * @property {string} [id] - A string serving as the unique identifier.
@@ -1773,21 +1980,6 @@ export = ServiceabilityPlatformModel;
1773
1980
  * @property {string} [name] - Name of the courier partner.
1774
1981
  * @property {CourierPartnerPromise} [delivery_promise]
1775
1982
  */
1776
- /**
1777
- * @typedef CourierPartnerPromise
1778
- * @property {string} min - Minimum courier partner delivery promise time.
1779
- * @property {string} max - Maximum courier partner delivery promise time.
1780
- * @property {CourierPartnerAttributes} [attributes]
1781
- */
1782
- /**
1783
- * @typedef CourierPartnerAttributes
1784
- * @property {CourierPartnerTAT} [tat]
1785
- */
1786
- /**
1787
- * @typedef CourierPartnerTAT
1788
- * @property {number} [min] - Minimum turnaround time.
1789
- * @property {number} [max] - Maximum turnaround time.
1790
- */
1791
1983
  /**
1792
1984
  * @typedef ShipmentCourierPartners
1793
1985
  * @property {string} [id] - A string serving as the unique identifier.
@@ -2292,8 +2484,57 @@ export = ServiceabilityPlatformModel;
2292
2484
  declare class ServiceabilityPlatformModel {
2293
2485
  }
2294
2486
  declare namespace ServiceabilityPlatformModel {
2295
- export { 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, BusinessUnit, FulfillmentStores, FulfillmentProducts, CourierPartnerSchemes, CourierPartnerScheme, FulfillmentOptionItem, FulfillmentOptionProduct, NetQuantity, Trader, ProductPublish, TaxIdentifier, ReturnConfig, CustomOrder, Size, Identifier, Page, FulfillmentOptionStore, Address, FulfillmentOptionValidate, ProductSchema, StoresSchema, CreatedBy, ModifiedBy, ListViewItems, GeoArea, ListViewProduct, Summary, RegionSchema, ZoneStores, ZoneProduct, ZoneBulkItem, PincodeMopUpdateResult, PincodeCodStatusItem, PincodeCodStatusListingSummary, PincodeMopUpdateAuditHistoryPaging, PincodeMopUpdateAuditHistoryResult, Area, GeoAreaResponseDetail, GeoAreaItemResult, AreaExpanded, Country, Region, Page2, CourierPartnerRuleConditions, LocationRule, LocationRuleValues, StringComparisonOperations, IntComparisonOperations, ArithmeticOperations, CourierPartnerRuleCPListResult, CourierPartnerSchemeDefaultTat, CourierPartnerSchemeTat, CourierPartnerSchemeFeatures, CourierPartnerList, ShipmentsCourierPartnersServiceability, CPShipments, ShipmentDimension, ShipmentsArticles, ArticleWeight, ArticleAttributes, ArticleDimension, ArticleSet, ArticleSizeDistribution, SetSize, ArticleDeliverySlots, ArticleReturnReason, CourierPartners, CourierPartnerPromise, CourierPartnerAttributes, CourierPartnerTAT, ShipmentCourierPartners, CourierPartnerConfig, BuyboxRuleConfig, PromiseConfig, StorePromiseAttributeConfig, DeliveryServiceAttributeConfig, BufferField, StorePrioritySchema, StoreRuleConditionSchema, CustomerRadiusSchema, DateOperations, CourierPartnerSchemeModel, PackageMaterialRule, PackageMaterialRuleQuantity, Channel, PackageRuleCategory, PackageRuleProduct, PackageRuleProductTag, PackageRuleDepartmentId, PackageRuleProductAttributes, PackageChannel, StoreFilter, PackageRuleSchema, Quantity, PackagePageInfo, OptimalLocationAssignedStoresResult, OptimalLocationArticlesResult, ArticleAssignment, LocationDetailsServiceability, ServiceabilityLocation, OptimalLocationsArticles, GetCountriesItems, HierarchyItems, CurrencyObject, Localities, PincodeLatLongData, LocalityParent, CountryMetaFields, ApplicationFields, GetCountryFieldsAddress, FieldValidation, FieldValidationRegex, LengthValidation, GetCountryFieldsAddressValues, GetOneOrAll, GetOneOrAllParams, GetOneOrAllPath, GetOneOrAllQuery, GetCountryFieldsAddressTemplateApplication, CountryHierarchy, GetCountryFields, GetCountryFieldsAddressTemplate, LocalityParents, ZoneConfig, PromiseType, InstallCourierPartnerItemsSchema, HistoryObject };
2487
+ 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, FulfillmentOptionValidate, ProductSchema, StoresSchema, CreatedBy, ModifiedBy, ListViewItems, GeoArea, ListViewProduct, Summary, RegionSchema, ZoneStores, ZoneProduct, ZoneBulkItem, PincodeMopUpdateResult, PincodeCodStatusItem, PincodeCodStatusListingSummary, PincodeMopUpdateAuditHistoryPaging, PincodeMopUpdateAuditHistoryResult, Area, GeoAreaResponseDetail, GeoAreaItemResult, AreaExpanded, Country, Region, Page2, CourierPartnerRuleConditions, LocationRule, LocationRuleValues, StringComparisonOperations, IntComparisonOperations, ArithmeticOperations, CourierPartnerRuleCPListResult, CourierPartnerSchemeDefaultTat, CourierPartnerSchemeTat, CourierPartnerSchemeFeatures, CourierPartnerList, ShipmentsCourierPartnersServiceability, CPShipments, ShipmentsArticles, ArticleWeight, ArticleAttributes, ArticleDimension, ArticleSet, ArticleSizeDistribution, SetSize, ArticleDeliverySlots, ArticleReturnReason, CourierPartners, ShipmentCourierPartners, CourierPartnerConfig, BuyboxRuleConfig, PromiseConfig, StorePromiseAttributeConfig, DeliveryServiceAttributeConfig, BufferField, StorePrioritySchema, StoreRuleConditionSchema, CustomerRadiusSchema, DateOperations, CourierPartnerSchemeModel, PackageMaterialRule, PackageMaterialRuleQuantity, Channel, PackageRuleCategory, PackageRuleProduct, PackageRuleProductTag, PackageRuleDepartmentId, PackageRuleProductAttributes, PackageChannel, StoreFilter, PackageRuleSchema, Quantity, PackagePageInfo, OptimalLocationAssignedStoresResult, OptimalLocationArticlesResult, ArticleAssignment, LocationDetailsServiceability, ServiceabilityLocation, OptimalLocationsArticles, GetCountriesItems, HierarchyItems, CurrencyObject, Localities, PincodeLatLongData, LocalityParent, CountryMetaFields, ApplicationFields, GetCountryFieldsAddress, FieldValidation, FieldValidationRegex, LengthValidation, GetCountryFieldsAddressValues, GetOneOrAll, GetOneOrAllParams, GetOneOrAllPath, GetOneOrAllQuery, GetCountryFieldsAddressTemplateApplication, CountryHierarchy, GetCountryFields, GetCountryFieldsAddressTemplate, LocalityParents, ZoneConfig, PromiseType, InstallCourierPartnerItemsSchema, HistoryObject };
2296
2488
  }
2489
+ /** @returns {PlatformShipmentsRequestSchema} */
2490
+ declare function PlatformShipmentsRequestSchema(): PlatformShipmentsRequestSchema;
2491
+ type PlatformShipmentsRequestSchema = {
2492
+ /**
2493
+ * - The journey or route for the shipment.
2494
+ */
2495
+ journey: string;
2496
+ /**
2497
+ * - A list of articles
2498
+ * associated with the shipment location, grouped by fulfillment details.
2499
+ */
2500
+ location_articles: PlatformLocationArticles[];
2501
+ to_serviceability: PlatformShipmentsToServiceability;
2502
+ /**
2503
+ * - The payment mode for the shipment,
2504
+ * nullable if not applicable.
2505
+ */
2506
+ payment_mode?: string;
2507
+ };
2508
+ /** @returns {PlatformShipmentsResponseSchema} */
2509
+ declare function PlatformShipmentsResponseSchema(): PlatformShipmentsResponseSchema;
2510
+ type PlatformShipmentsResponseSchema = {
2511
+ /**
2512
+ * - Flag indicating whether Cash on
2513
+ * Delivery (COD) is available for the shipment.
2514
+ */
2515
+ is_cod_available: boolean;
2516
+ /**
2517
+ * - List of shipments generated
2518
+ * for the courier partner.
2519
+ */
2520
+ shipments: PlatformShipmentsSchema[];
2521
+ };
2522
+ /** @returns {ShipmentsErrorResult} */
2523
+ declare function ShipmentsErrorResult(): ShipmentsErrorResult;
2524
+ type ShipmentsErrorResult = {
2525
+ /**
2526
+ * - The error message describing the issue.
2527
+ */
2528
+ message?: string;
2529
+ /**
2530
+ * - A string property defining error type
2531
+ */
2532
+ type: string;
2533
+ /**
2534
+ * - A string property providing value which is causing error
2535
+ */
2536
+ value: string;
2537
+ };
2297
2538
  /** @returns {FulfillmentOption} */
2298
2539
  declare function FulfillmentOption(): FulfillmentOption;
2299
2540
  type FulfillmentOption = {
@@ -5175,161 +5416,657 @@ type CompanyConfigurationSchema = {
5175
5416
  */
5176
5417
  sort?: string[];
5177
5418
  };
5178
- /** @returns {BusinessUnit} */
5179
- declare function BusinessUnit(): BusinessUnit;
5180
- type BusinessUnit = {
5419
+ /** @returns {PlatformLocationArticles} */
5420
+ declare function PlatformLocationArticles(): PlatformLocationArticles;
5421
+ type PlatformLocationArticles = {
5181
5422
  /**
5182
- * - Name of the business unit.
5423
+ * - List of articles for this
5424
+ * fulfillment location.
5183
5425
  */
5184
- name?: string;
5426
+ articles: PlatformLocationArticle[];
5185
5427
  /**
5186
- * - Whether the business unit is active.
5428
+ * - Unique identifier for the
5429
+ * fulfillment location.
5187
5430
  */
5188
- is_active?: boolean;
5189
- };
5190
- /** @returns {FulfillmentStores} */
5191
- declare function FulfillmentStores(): FulfillmentStores;
5192
- type FulfillmentStores = {
5431
+ fulfillment_location_id?: number;
5193
5432
  /**
5194
- * - List of store IDs associated with this
5195
- * fulfillment option.
5433
+ * - Tags associated with the
5434
+ * fulfillment location.
5196
5435
  */
5197
- values?: number[];
5436
+ fulfillment_tags?: string[];
5198
5437
  /**
5199
- * - Whether fulfillment applies to all stores or
5200
- * specific stores.
5438
+ * - Type of fulfillment (e.g., store, warehouse).
5201
5439
  */
5202
- type?: string;
5440
+ fulfillment_type: string;
5203
5441
  };
5204
- /** @returns {FulfillmentProducts} */
5205
- declare function FulfillmentProducts(): FulfillmentProducts;
5206
- type FulfillmentProducts = {
5442
+ /** @returns {PlatformLocationArticle} */
5443
+ declare function PlatformLocationArticle(): PlatformLocationArticle;
5444
+ type PlatformLocationArticle = {
5207
5445
  /**
5208
- * - List of product IDs associated with this
5209
- * fulfillment option.
5446
+ * - The price of the article.
5210
5447
  */
5211
- values?: number[];
5448
+ price: number;
5212
5449
  /**
5213
- * - Whether fulfillment applies to all products or
5214
- * specific products.
5450
+ * - Unique identifier for the item.
5215
5451
  */
5216
- type?: string;
5217
- };
5218
- /** @returns {CourierPartnerSchemes} */
5219
- declare function CourierPartnerSchemes(): CourierPartnerSchemes;
5220
- type CourierPartnerSchemes = {
5452
+ item_id: number;
5221
5453
  /**
5222
- * - List of courier partner schemes
5223
- * associated with this fulfillment option.
5454
+ * - The size of the article.
5224
5455
  */
5225
- values?: CourierPartnerScheme[];
5456
+ size: string;
5226
5457
  /**
5227
- * - Indicates whether all installed courier schemes
5228
- * are used or only those specified by the seller.
5458
+ * - The quantity of the article.
5229
5459
  */
5230
- type?: string;
5460
+ quantity: number;
5461
+ parent_item_identifiers?: ParentItemIdentifiers;
5231
5462
  };
5232
- /** @returns {CourierPartnerScheme} */
5233
- declare function CourierPartnerScheme(): CourierPartnerScheme;
5234
- type CourierPartnerScheme = {
5463
+ /** @returns {ParentItemIdentifiers} */
5464
+ declare function ParentItemIdentifiers(): ParentItemIdentifiers;
5465
+ type ParentItemIdentifiers = {
5235
5466
  /**
5236
- * - Unique identifier for the courier partner scheme.
5467
+ * - Identifier of the parent item.
5237
5468
  */
5238
- scheme_id?: string;
5469
+ identifier: string;
5239
5470
  /**
5240
- * - Unique identifier for the courier partner.
5471
+ * - Parent item id.
5241
5472
  */
5242
- cp_ext_id?: string;
5473
+ parent_item_id: string;
5474
+ /**
5475
+ * - Parent item size.
5476
+ */
5477
+ parent_item_size: string;
5243
5478
  };
5244
- /** @returns {FulfillmentOptionItem} */
5245
- declare function FulfillmentOptionItem(): FulfillmentOptionItem;
5246
- type FulfillmentOptionItem = {
5479
+ /** @returns {PlatformShipmentsToServiceability} */
5480
+ declare function PlatformShipmentsToServiceability(): PlatformShipmentsToServiceability;
5481
+ type PlatformShipmentsToServiceability = {
5247
5482
  /**
5248
- * - Unique identifier for the delivery type.
5483
+ * - The pincode of the serviceability location.
5249
5484
  */
5250
- slug?: string;
5485
+ pincode?: string;
5251
5486
  /**
5252
- * - Description of the delivery service.
5487
+ * - The sector of the serviceability location.
5253
5488
  */
5254
- description?: string;
5489
+ sector?: string;
5255
5490
  /**
5256
- * - Indicates if this is the default delivery option.
5491
+ * - The state of the serviceability location.
5257
5492
  */
5258
- is_default?: boolean;
5493
+ state?: string;
5259
5494
  /**
5260
- * - Unique ID of the delivery service.
5495
+ * - The country of the serviceability location.
5261
5496
  */
5262
- id?: string;
5497
+ country?: string;
5263
5498
  /**
5264
- * - Type of fulfillment option.
5499
+ * - The city of the serviceability location.
5265
5500
  */
5266
- type?: string;
5501
+ city?: string;
5267
5502
  /**
5268
- * - Name of the delivery service.
5503
+ * - The ISO code of the country.
5269
5504
  */
5270
- name?: string;
5505
+ country_iso_code?: string;
5271
5506
  };
5272
- /** @returns {FulfillmentOptionProduct} */
5273
- declare function FulfillmentOptionProduct(): FulfillmentOptionProduct;
5274
- type FulfillmentOptionProduct = {
5507
+ /** @returns {PlatformShipmentsSchema} */
5508
+ declare function PlatformShipmentsSchema(): PlatformShipmentsSchema;
5509
+ type PlatformShipmentsSchema = {
5275
5510
  /**
5276
- * - Unique identifier for the product.
5511
+ * - Additional tags associated with the shipment.
5277
5512
  */
5278
- uid?: number;
5513
+ tags?: string[];
5514
+ packaging?: Packaging;
5515
+ fulfillment_option?: FulfillmentOptionItem;
5279
5516
  /**
5280
- * - Name of the product.
5517
+ * - The total weight of the shipment.
5281
5518
  */
5282
- name?: string;
5519
+ weight?: number;
5283
5520
  /**
5284
- * - Unique slug identifier for the product.
5521
+ * - The type of shipment.
5285
5522
  */
5286
- slug?: string;
5523
+ shipment_type?: string;
5287
5524
  /**
5288
- * - Slug identifier of the product's category.
5525
+ * - Indicates whether courier partners
5526
+ * should be automatically assigned to this shipment based on the store's
5527
+ * auto-assignment configuration.
5289
5528
  */
5290
- category_slug?: string;
5529
+ is_auto_assign?: boolean;
5291
5530
  /**
5292
- * - Unique identifier for the product's category.
5531
+ * - Volumetric weight of the shipment.
5293
5532
  */
5294
- category_uid?: number;
5533
+ volumetric_weight?: number;
5295
5534
  /**
5296
- * - Brief description of the product.
5535
+ * - Tags associated with the fulfillment.
5297
5536
  */
5298
- short_description?: string;
5537
+ fulfillment_tags?: string[];
5538
+ promise?: ShipmentsPromise;
5299
5539
  /**
5300
- * - Detailed description of the product in HTML format.
5540
+ * - Flag indicating whether an
5541
+ * ewaybill is enabled for the shipment.
5301
5542
  */
5302
- description?: string;
5543
+ is_ewaybill_enabled?: boolean;
5303
5544
  /**
5304
- * - Unique identifier for the brand.
5545
+ * - Flag indicating whether the shipment is MTO
5546
+ * (Make to Order).
5305
5547
  */
5306
- brand_uid?: number;
5548
+ is_mto?: boolean;
5307
5549
  /**
5308
- * - Currency code used for product pricing.
5550
+ * - List of articles in the shipment.
5309
5551
  */
5310
- currency?: string;
5552
+ articles?: ShipmentsArticle[];
5311
5553
  /**
5312
- * - Unique code assigned to the product.
5554
+ * - Type of fulfillment (e.g., high_street).
5313
5555
  */
5314
- item_code?: string;
5556
+ fulfillment_type?: string;
5315
5557
  /**
5316
- * - Type of product (e.g., standard, set etc.).
5558
+ * - Flag indicating whether MPS (Multi-Part Shipment)
5559
+ * is enabled for the shipment.
5317
5560
  */
5318
- item_type?: string;
5319
- net_quantity?: NetQuantity;
5561
+ mps?: boolean;
5320
5562
  /**
5321
- * - Indicates if the product supports multiple sizes.
5563
+ * - Unique identifier for the
5564
+ * fulfillment location.
5322
5565
  */
5323
- multi_size?: boolean;
5566
+ fulfillment_location_id?: number;
5324
5567
  /**
5325
- * - Indicates if the product is a set of items.
5568
+ * - List of courier
5569
+ * partners handling the shipment.
5326
5570
  */
5327
- is_set?: boolean;
5571
+ courier_partners?: ShipmentsCourierPartner[];
5572
+ };
5573
+ /** @returns {Packaging} */
5574
+ declare function Packaging(): Packaging;
5575
+ type Packaging = {
5328
5576
  /**
5329
- * - Indicates if the product depends on
5330
- * another product.
5577
+ * - The name of the packaging.
5331
5578
  */
5332
- is_dependent?: boolean;
5579
+ name?: string;
5580
+ /**
5581
+ * - A string serving as the unique identifier.
5582
+ */
5583
+ id?: string;
5584
+ dimension?: Dimension;
5585
+ };
5586
+ /** @returns {Dimension} */
5587
+ declare function Dimension(): Dimension;
5588
+ type Dimension = {
5589
+ /**
5590
+ * - Length of the packaging.
5591
+ */
5592
+ length?: number;
5593
+ /**
5594
+ * - Width of the packaging.
5595
+ */
5596
+ width?: number;
5597
+ /**
5598
+ * - Height of the packaging.
5599
+ */
5600
+ height?: number;
5601
+ };
5602
+ /** @returns {FulfillmentOptionItem} */
5603
+ declare function FulfillmentOptionItem(): FulfillmentOptionItem;
5604
+ type FulfillmentOptionItem = {
5605
+ /**
5606
+ * - Unique identifier for the delivery type.
5607
+ */
5608
+ slug?: string;
5609
+ /**
5610
+ * - Description of the delivery service.
5611
+ */
5612
+ description?: string;
5613
+ /**
5614
+ * - Indicates if this is the default delivery option.
5615
+ */
5616
+ is_default?: boolean;
5617
+ /**
5618
+ * - Unique ID of the delivery service.
5619
+ */
5620
+ id?: string;
5621
+ /**
5622
+ * - Type of fulfillment option.
5623
+ */
5624
+ type?: string;
5625
+ /**
5626
+ * - Name of the delivery service.
5627
+ */
5628
+ name?: string;
5629
+ };
5630
+ /** @returns {ShipmentsPromise} */
5631
+ declare function ShipmentsPromise(): ShipmentsPromise;
5632
+ type ShipmentsPromise = {
5633
+ /**
5634
+ * - The minimum shipment promise time.
5635
+ */
5636
+ min?: string;
5637
+ /**
5638
+ * - The maximum shipment promise time.
5639
+ */
5640
+ max?: string;
5641
+ customer_promise?: CustomerPromise;
5642
+ meta?: ShipmentPromiseMeta;
5643
+ };
5644
+ /** @returns {CustomerPromise} */
5645
+ declare function CustomerPromise(): CustomerPromise;
5646
+ type CustomerPromise = {
5647
+ /**
5648
+ * - The earliest possible date and time when the
5649
+ * shipment is expected to be delivered. This timestamp is in ISO 8601 format
5650
+ */
5651
+ min?: string;
5652
+ /**
5653
+ * - The latest possible date and time when the
5654
+ * shipment is expected to be delivered. This timestamp is in ISO 8601 format
5655
+ */
5656
+ max?: string;
5657
+ };
5658
+ /** @returns {ShipmentPromiseMeta} */
5659
+ declare function ShipmentPromiseMeta(): ShipmentPromiseMeta;
5660
+ type ShipmentPromiseMeta = {
5661
+ seller_promise?: SellerPromise;
5662
+ courier_partner_promise?: CourierPartnerPromise;
5663
+ customer_initial_promise?: CustomerInitialPromise;
5664
+ };
5665
+ /** @returns {SellerPromise} */
5666
+ declare function SellerPromise(): SellerPromise;
5667
+ type SellerPromise = {
5668
+ /**
5669
+ * - Minimum seller delivery promise time.
5670
+ */
5671
+ min?: string;
5672
+ /**
5673
+ * - Maximum seller delivery promise time.
5674
+ */
5675
+ max?: string;
5676
+ };
5677
+ /** @returns {CourierPartnerPromise} */
5678
+ declare function CourierPartnerPromise(): CourierPartnerPromise;
5679
+ type CourierPartnerPromise = {
5680
+ /**
5681
+ * - Minimum courier partner delivery promise time.
5682
+ */
5683
+ min: string;
5684
+ /**
5685
+ * - Maximum courier partner delivery promise time.
5686
+ */
5687
+ max: string;
5688
+ attributes?: CourierPartnerAttributes;
5689
+ };
5690
+ /** @returns {CourierPartnerAttributes} */
5691
+ declare function CourierPartnerAttributes(): CourierPartnerAttributes;
5692
+ type CourierPartnerAttributes = {
5693
+ tat?: CourierPartnerTAT;
5694
+ };
5695
+ /** @returns {CourierPartnerTAT} */
5696
+ declare function CourierPartnerTAT(): CourierPartnerTAT;
5697
+ type CourierPartnerTAT = {
5698
+ /**
5699
+ * - Minimum turnaround time.
5700
+ */
5701
+ min?: number;
5702
+ /**
5703
+ * - Maximum turnaround time.
5704
+ */
5705
+ max?: number;
5706
+ };
5707
+ /** @returns {CustomerInitialPromise} */
5708
+ declare function CustomerInitialPromise(): CustomerInitialPromise;
5709
+ type CustomerInitialPromise = {
5710
+ /**
5711
+ * - Minimum initial customer delivery promise time.
5712
+ */
5713
+ min?: string;
5714
+ /**
5715
+ * - Maximum initial customer delivery promise time.
5716
+ */
5717
+ max?: string;
5718
+ };
5719
+ /** @returns {ShipmentsArticle} */
5720
+ declare function ShipmentsArticle(): ShipmentsArticle;
5721
+ type ShipmentsArticle = {
5722
+ /**
5723
+ * - A string serving as the unique identifier.
5724
+ */
5725
+ id?: string;
5726
+ /**
5727
+ * - The quantity of the shipment article.
5728
+ */
5729
+ quantity?: number;
5730
+ /**
5731
+ * - The Item Id of the article.
5732
+ */
5733
+ item_id?: number;
5734
+ /**
5735
+ * - The size of the article.
5736
+ */
5737
+ size?: string;
5738
+ /**
5739
+ * - Final Price of the article after discounts
5740
+ */
5741
+ price?: number;
5742
+ /**
5743
+ * - Marked price before discounts (nullable).
5744
+ */
5745
+ price_marked?: number;
5746
+ /**
5747
+ * - Department of the item
5748
+ */
5749
+ department_id?: number;
5750
+ /**
5751
+ * - Weight of the article.
5752
+ */
5753
+ weight?: number;
5754
+ /**
5755
+ * - Additional attributes for the article.
5756
+ */
5757
+ attributes?: any;
5758
+ /**
5759
+ * - Category Id of the article.
5760
+ */
5761
+ category_id?: number;
5762
+ /**
5763
+ * - Brand Id of the article.
5764
+ */
5765
+ brand_id?: number;
5766
+ dimension?: ShipmentDimension;
5767
+ /**
5768
+ * - List of tags associated with the article.
5769
+ */
5770
+ tags?: string[];
5771
+ /**
5772
+ * - Time required for manufacturing.
5773
+ */
5774
+ manufacturing_time?: number;
5775
+ /**
5776
+ * - Unit for manufacturing time.
5777
+ */
5778
+ manufacturing_time_unit?: string;
5779
+ /**
5780
+ * - Additional properties related to sets.
5781
+ */
5782
+ set?: any;
5783
+ /**
5784
+ * - Indicates if the article is part of a set.
5785
+ */
5786
+ is_set?: boolean;
5787
+ /**
5788
+ * - Custom JSON metadata.
5789
+ */
5790
+ _custom_json?: any;
5791
+ /**
5792
+ * - Reason for returning the article (nullable).
5793
+ */
5794
+ return_reason?: string;
5795
+ /**
5796
+ * - Group Id for the article.
5797
+ */
5798
+ group_id?: string;
5799
+ meta?: ShipmentsMeta;
5800
+ /**
5801
+ * - Indicates whether the article is made-to-order (MTO)
5802
+ */
5803
+ is_mto?: boolean;
5804
+ /**
5805
+ * - Service level agreement (SLA) for the article,
5806
+ * represented as a date-time
5807
+ */
5808
+ sla?: string;
5809
+ };
5810
+ /** @returns {ShipmentDimension} */
5811
+ declare function ShipmentDimension(): ShipmentDimension;
5812
+ type ShipmentDimension = {
5813
+ /**
5814
+ * - Height of the shipment in centimeters.
5815
+ */
5816
+ height: number;
5817
+ /**
5818
+ * - Length of the shipment in centimeters.
5819
+ */
5820
+ length: number;
5821
+ /**
5822
+ * - Width of the shipment in centimeters.
5823
+ */
5824
+ width: number;
5825
+ /**
5826
+ * - If the dimensions are default.
5827
+ */
5828
+ is_default?: boolean;
5829
+ /**
5830
+ * - Measurement unit for dimensions.
5831
+ */
5832
+ unit?: string;
5833
+ };
5834
+ /** @returns {ShipmentsMeta} */
5835
+ declare function ShipmentsMeta(): ShipmentsMeta;
5836
+ type ShipmentsMeta = {
5837
+ /**
5838
+ * - Whether the article is part of a set
5839
+ */
5840
+ is_set?: boolean;
5841
+ /**
5842
+ * - Set details for the article, if applicable
5843
+ */
5844
+ set?: any;
5845
+ /**
5846
+ * - Whether the article is a set item
5847
+ */
5848
+ is_set_article?: boolean;
5849
+ /**
5850
+ * - Quantity of the set item
5851
+ */
5852
+ set_quantity?: number;
5853
+ /**
5854
+ * - Id of the split article, if applicable
5855
+ */
5856
+ split_article_id?: string;
5857
+ /**
5858
+ * - List of promotion Ids applicable to the article
5859
+ */
5860
+ promo_ids?: string[];
5861
+ };
5862
+ /** @returns {ShipmentsCourierPartner} */
5863
+ declare function ShipmentsCourierPartner(): ShipmentsCourierPartner;
5864
+ type ShipmentsCourierPartner = {
5865
+ /**
5866
+ * - A string that uniquely identifies the
5867
+ * courier partner extension.
5868
+ */
5869
+ extension_id?: string;
5870
+ /**
5871
+ * - Unique identifier for the scheme, used to
5872
+ * fetch or modify scheme details.
5873
+ */
5874
+ scheme_id?: string;
5875
+ area_code?: AreaCode;
5876
+ tat?: TAT;
5877
+ /**
5878
+ * - The display name of the courier partner.
5879
+ */
5880
+ display_name?: string;
5881
+ /**
5882
+ * - A boolean indicating quality control by
5883
+ * the courier partner.
5884
+ */
5885
+ is_qc_enabled?: boolean;
5886
+ /**
5887
+ * - Indicates whether the courier account
5888
+ * supports self-shipping (true if it does, false otherwise).
5889
+ */
5890
+ is_self_ship?: boolean;
5891
+ /**
5892
+ * - Indicates whether the courier account
5893
+ * is an own account (true if it is, false otherwise).
5894
+ */
5895
+ is_own_account?: boolean;
5896
+ /**
5897
+ * - The number of non-delivery report (NDR) attempts.
5898
+ */
5899
+ ndr_attempts?: number;
5900
+ /**
5901
+ * - Cutoff time for forward pickup (nullable).
5902
+ */
5903
+ forward_pickup_cutoff?: string;
5904
+ /**
5905
+ * - Cutoff time for reverse pickup (nullable).
5906
+ */
5907
+ reverse_pickup_cutoff?: string;
5908
+ /**
5909
+ * - Quantity of items under
5910
+ * quality control (nullable).
5911
+ */
5912
+ qc_shipment_item_quantity?: number;
5913
+ /**
5914
+ * - Quantity of items not
5915
+ * under quality control (nullable).
5916
+ */
5917
+ non_qc_shipment_item_quantity?: number;
5918
+ };
5919
+ /** @returns {AreaCode} */
5920
+ declare function AreaCode(): AreaCode;
5921
+ type AreaCode = {
5922
+ /**
5923
+ * - The starting area code.
5924
+ */
5925
+ source?: string;
5926
+ /**
5927
+ * - The ending area code.
5928
+ */
5929
+ destination?: string;
5930
+ };
5931
+ /** @returns {TAT} */
5932
+ declare function TAT(): TAT;
5933
+ type TAT = {
5934
+ /**
5935
+ * - The minimum tat in integer.
5936
+ */
5937
+ min?: number;
5938
+ /**
5939
+ * - The maximum tat in integer.
5940
+ */
5941
+ max?: number;
5942
+ };
5943
+ /** @returns {BusinessUnit} */
5944
+ declare function BusinessUnit(): BusinessUnit;
5945
+ type BusinessUnit = {
5946
+ /**
5947
+ * - Name of the business unit.
5948
+ */
5949
+ name?: string;
5950
+ /**
5951
+ * - Whether the business unit is active.
5952
+ */
5953
+ is_active?: boolean;
5954
+ };
5955
+ /** @returns {FulfillmentStores} */
5956
+ declare function FulfillmentStores(): FulfillmentStores;
5957
+ type FulfillmentStores = {
5958
+ /**
5959
+ * - List of store IDs associated with this
5960
+ * fulfillment option.
5961
+ */
5962
+ values?: number[];
5963
+ /**
5964
+ * - Whether fulfillment applies to all stores or
5965
+ * specific stores.
5966
+ */
5967
+ type?: string;
5968
+ };
5969
+ /** @returns {FulfillmentProducts} */
5970
+ declare function FulfillmentProducts(): FulfillmentProducts;
5971
+ type FulfillmentProducts = {
5972
+ /**
5973
+ * - List of product IDs associated with this
5974
+ * fulfillment option.
5975
+ */
5976
+ values?: number[];
5977
+ /**
5978
+ * - Whether fulfillment applies to all products or
5979
+ * specific products.
5980
+ */
5981
+ type?: string;
5982
+ };
5983
+ /** @returns {CourierPartnerSchemes} */
5984
+ declare function CourierPartnerSchemes(): CourierPartnerSchemes;
5985
+ type CourierPartnerSchemes = {
5986
+ /**
5987
+ * - List of courier partner schemes
5988
+ * associated with this fulfillment option.
5989
+ */
5990
+ values?: CourierPartnerScheme[];
5991
+ /**
5992
+ * - Indicates whether all installed courier schemes
5993
+ * are used or only those specified by the seller.
5994
+ */
5995
+ type?: string;
5996
+ };
5997
+ /** @returns {CourierPartnerScheme} */
5998
+ declare function CourierPartnerScheme(): CourierPartnerScheme;
5999
+ type CourierPartnerScheme = {
6000
+ /**
6001
+ * - Unique identifier for the courier partner scheme.
6002
+ */
6003
+ scheme_id?: string;
6004
+ /**
6005
+ * - Unique identifier for the courier partner.
6006
+ */
6007
+ cp_ext_id?: string;
6008
+ };
6009
+ /** @returns {FulfillmentOptionProduct} */
6010
+ declare function FulfillmentOptionProduct(): FulfillmentOptionProduct;
6011
+ type FulfillmentOptionProduct = {
6012
+ /**
6013
+ * - Unique identifier for the product.
6014
+ */
6015
+ uid?: number;
6016
+ /**
6017
+ * - Name of the product.
6018
+ */
6019
+ name?: string;
6020
+ /**
6021
+ * - Unique slug identifier for the product.
6022
+ */
6023
+ slug?: string;
6024
+ /**
6025
+ * - Slug identifier of the product's category.
6026
+ */
6027
+ category_slug?: string;
6028
+ /**
6029
+ * - Unique identifier for the product's category.
6030
+ */
6031
+ category_uid?: number;
6032
+ /**
6033
+ * - Brief description of the product.
6034
+ */
6035
+ short_description?: string;
6036
+ /**
6037
+ * - Detailed description of the product in HTML format.
6038
+ */
6039
+ description?: string;
6040
+ /**
6041
+ * - Unique identifier for the brand.
6042
+ */
6043
+ brand_uid?: number;
6044
+ /**
6045
+ * - Currency code used for product pricing.
6046
+ */
6047
+ currency?: string;
6048
+ /**
6049
+ * - Unique code assigned to the product.
6050
+ */
6051
+ item_code?: string;
6052
+ /**
6053
+ * - Type of product (e.g., standard, set etc.).
6054
+ */
6055
+ item_type?: string;
6056
+ net_quantity?: NetQuantity;
6057
+ /**
6058
+ * - Indicates if the product supports multiple sizes.
6059
+ */
6060
+ multi_size?: boolean;
6061
+ /**
6062
+ * - Indicates if the product is a set of items.
6063
+ */
6064
+ is_set?: boolean;
6065
+ /**
6066
+ * - Indicates if the product depends on
6067
+ * another product.
6068
+ */
6069
+ is_dependent?: boolean;
5333
6070
  /**
5334
6071
  * - Status indicating if the product is active.
5335
6072
  */
@@ -6510,30 +7247,6 @@ type CPShipments = {
6510
7247
  */
6511
7248
  articles?: ShipmentsArticles[];
6512
7249
  };
6513
- /** @returns {ShipmentDimension} */
6514
- declare function ShipmentDimension(): ShipmentDimension;
6515
- type ShipmentDimension = {
6516
- /**
6517
- * - Height of the shipment in centimeters.
6518
- */
6519
- height: number;
6520
- /**
6521
- * - Length of the shipment in centimeters.
6522
- */
6523
- length: number;
6524
- /**
6525
- * - Width of the shipment in centimeters.
6526
- */
6527
- width: number;
6528
- /**
6529
- * - If the dimensions are default.
6530
- */
6531
- is_default?: boolean;
6532
- /**
6533
- * - Measurement unit for dimensions.
6534
- */
6535
- unit?: string;
6536
- };
6537
7250
  /** @returns {ShipmentsArticles} */
6538
7251
  declare function ShipmentsArticles(): ShipmentsArticles;
6539
7252
  type ShipmentsArticles = {
@@ -6746,36 +7459,6 @@ type CourierPartners = {
6746
7459
  name?: string;
6747
7460
  delivery_promise?: CourierPartnerPromise;
6748
7461
  };
6749
- /** @returns {CourierPartnerPromise} */
6750
- declare function CourierPartnerPromise(): CourierPartnerPromise;
6751
- type CourierPartnerPromise = {
6752
- /**
6753
- * - Minimum courier partner delivery promise time.
6754
- */
6755
- min: string;
6756
- /**
6757
- * - Maximum courier partner delivery promise time.
6758
- */
6759
- max: string;
6760
- attributes?: CourierPartnerAttributes;
6761
- };
6762
- /** @returns {CourierPartnerAttributes} */
6763
- declare function CourierPartnerAttributes(): CourierPartnerAttributes;
6764
- type CourierPartnerAttributes = {
6765
- tat?: CourierPartnerTAT;
6766
- };
6767
- /** @returns {CourierPartnerTAT} */
6768
- declare function CourierPartnerTAT(): CourierPartnerTAT;
6769
- type CourierPartnerTAT = {
6770
- /**
6771
- * - Minimum turnaround time.
6772
- */
6773
- min?: number;
6774
- /**
6775
- * - Maximum turnaround time.
6776
- */
6777
- max?: number;
6778
- };
6779
7462
  /** @returns {ShipmentCourierPartners} */
6780
7463
  declare function ShipmentCourierPartners(): ShipmentCourierPartners;
6781
7464
  type ShipmentCourierPartners = {