@gofynd/fdk-client-javascript 3.16.3 → 3.17.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/ApplicationClient.d.ts +0 -2
- package/sdk/application/ApplicationClient.js +0 -2
- package/sdk/application/Cart/CartApplicationClient.d.ts +40 -0
- package/sdk/application/Cart/CartApplicationClient.js +176 -0
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +18 -4
- package/sdk/application/Catalog/CatalogApplicationClient.js +47 -4
- package/sdk/application/Content/ContentApplicationClient.d.ts +21 -1
- package/sdk/application/Content/ContentApplicationClient.js +93 -2
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +11 -21
- package/sdk/application/Logistic/LogisticApplicationClient.js +34 -83
- package/sdk/application/Order/OrderApplicationClient.d.ts +11 -0
- package/sdk/application/Order/OrderApplicationClient.js +50 -0
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +5 -5
- package/sdk/application/Payment/PaymentApplicationClient.js +5 -4
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +84 -0
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +712 -0
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +237 -1
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +157 -0
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +8 -0
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +70 -0
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +74 -12
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +637 -36
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +225 -1
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +147 -0
- package/sdk/platform/Cart/CartPlatformModel.d.ts +952 -5
- package/sdk/platform/Cart/CartPlatformModel.js +598 -2
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +125 -5
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +831 -41
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +205 -7
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +154 -3
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +5 -16
- package/sdk/platform/Catalog/CatalogPlatformClient.js +8 -85
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +1025 -159
- package/sdk/platform/Catalog/CatalogPlatformModel.js +840 -165
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +8 -10
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +3 -12
- package/sdk/platform/Common/CommonPlatformModel.d.ts +18 -1
- package/sdk/platform/Common/CommonPlatformModel.js +14 -0
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +1 -73
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +4 -462
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +7 -45
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +4 -55
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +10 -2
- package/sdk/platform/Communication/CommunicationPlatformModel.js +3 -2
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +14 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +6 -0
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +92 -1
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +54 -0
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +21 -0
- package/sdk/platform/Discount/DiscountPlatformModel.js +9 -0
- package/sdk/platform/Order/OrderPlatformClient.d.ts +27 -19
- package/sdk/platform/Order/OrderPlatformClient.js +176 -108
- package/sdk/platform/Order/OrderPlatformModel.d.ts +359 -45
- package/sdk/platform/Order/OrderPlatformModel.js +218 -44
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +40 -43
- package/sdk/platform/Order/OrderPlatformValidator.js +35 -30
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +14 -3
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +88 -6
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +28 -3
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +22 -2
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +376 -11
- package/sdk/platform/Payment/PaymentPlatformModel.js +243 -10
- package/sdk/platform/PlatformApplicationClient.d.ts +0 -2
- package/sdk/platform/PlatformApplicationClient.js +0 -4
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +0 -13
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +0 -82
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +1 -10
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +0 -12
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +212 -28
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +133 -13
- package/sdk/platform/User/UserPlatformModel.d.ts +2 -2
- package/sdk/platform/User/UserPlatformModel.js +4 -4
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +29 -0
- package/sdk/platform/Webhook/WebhookPlatformModel.js +13 -0
- package/sdk/platform/index.d.ts +0 -1
- package/sdk/platform/index.js +0 -2
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +27 -1
- package/sdk/public/Configuration/ConfigurationPublicModel.js +19 -0
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +29 -0
- package/sdk/public/Webhook/WebhookPublicModel.js +13 -0
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +0 -79
- package/sdk/application/Rewards/RewardsApplicationClient.js +0 -315
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +0 -136
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +0 -976
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +0 -152
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +0 -157
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +0 -387
- package/sdk/platform/Rewards/RewardsPlatformModel.js +0 -410
|
@@ -248,8 +248,7 @@ export = ServiceabilityPlatformModel;
|
|
|
248
248
|
/**
|
|
249
249
|
* @typedef PincodeMOPResult
|
|
250
250
|
* @property {boolean} success - Whether operation was successful.
|
|
251
|
-
* @property {number} status_code - Status code for the response
|
|
252
|
-
* _Deprecated_*
|
|
251
|
+
* @property {number} status_code - Status code for the response.
|
|
253
252
|
* @property {string} batch_id - A unique identifier for the performed batch operation.
|
|
254
253
|
* @property {string} country - Name of the country.
|
|
255
254
|
* @property {string} action - Denotes wether to activate or deavtivate pincodes
|
|
@@ -532,6 +531,9 @@ export = ServiceabilityPlatformModel;
|
|
|
532
531
|
/**
|
|
533
532
|
* @typedef CompanyConfig
|
|
534
533
|
* @property {number} [company_id] - The unique identifier of the company.
|
|
534
|
+
* @property {boolean} [is_rate_card_enabled] - Enables rate card feature at
|
|
535
|
+
* company level. Rate card rule engine runs only if rate card is configured
|
|
536
|
+
* at delivery partner scheme level.
|
|
535
537
|
* @property {string[]} [sort] - Array defining the sorting order.
|
|
536
538
|
* @property {string} [logistics_as_actual] - Defines the logistics control type.
|
|
537
539
|
*/
|
|
@@ -1087,8 +1089,7 @@ export = ServiceabilityPlatformModel;
|
|
|
1087
1089
|
*/
|
|
1088
1090
|
/**
|
|
1089
1091
|
* @typedef GetLocality
|
|
1090
|
-
* @property {Object} [meta] - Additional metadata for the locality
|
|
1091
|
-
* _Deprecated_*
|
|
1092
|
+
* @property {Object} [meta] - Additional metadata for the locality.
|
|
1092
1093
|
* @property {string} [parent_uid] - Unique identifier for the parent locality,
|
|
1093
1094
|
* if applicable.
|
|
1094
1095
|
* @property {string} [id] - A string serving as the unique identifier.
|
|
@@ -1184,6 +1185,9 @@ export = ServiceabilityPlatformModel;
|
|
|
1184
1185
|
*/
|
|
1185
1186
|
/**
|
|
1186
1187
|
* @typedef CompanyConfigurationSchema
|
|
1188
|
+
* @property {boolean} [is_rate_card_enabled] - Enables rate card feature at
|
|
1189
|
+
* company level. Rate card rule engine runs only if rate card is configured
|
|
1190
|
+
* at delivery partner scheme level.
|
|
1187
1191
|
* @property {string[]} [sort] - An array of strings specifying sorting preferences.
|
|
1188
1192
|
*/
|
|
1189
1193
|
/**
|
|
@@ -1540,23 +1544,72 @@ export = ServiceabilityPlatformModel;
|
|
|
1540
1544
|
/**
|
|
1541
1545
|
* @typedef FulfillmentOptionStore
|
|
1542
1546
|
* @property {number} [uid] - Unique identifier for the store.
|
|
1547
|
+
* @property {string} [store_code] - Store code identifier.
|
|
1543
1548
|
* @property {Address} [address]
|
|
1544
1549
|
* @property {number} [company_id] - The unique identifier of the company.
|
|
1545
|
-
* @property {string} [display_name] - Store name displayed in the UI.
|
|
1546
1550
|
* @property {string} [name] - Name of the store.
|
|
1547
|
-
* @property {string} [store_type] - Type of store (e.g., high_street, mall).
|
|
1551
|
+
* @property {string} [store_type] - Type of store (e.g., high_street, mall, warehouse).
|
|
1548
1552
|
* @property {string[]} [tags] - Tags associated with the store.
|
|
1553
|
+
* @property {number} [avg_order_processing_time] - Average order processing
|
|
1554
|
+
* time in seconds.
|
|
1555
|
+
* @property {string} [timezone] - Timezone of the store location.
|
|
1556
|
+
* @property {string[][]} [holiday_list] - List of holidays as date range tuples
|
|
1557
|
+
* [start_date, end_date].
|
|
1558
|
+
* @property {Object} [customfields] - Custom fields associated with the store.
|
|
1559
|
+
* @property {boolean} [is_open] - This field is marked as true when the store
|
|
1560
|
+
* is configured to be closed for every day of the week..
|
|
1561
|
+
* @property {Object} [promise_customfields] - Custom fields related to delivery
|
|
1562
|
+
* promises used when stores have different delivery promises for different days.
|
|
1563
|
+
* @property {StoreDistance} [distance]
|
|
1564
|
+
* @property {StoreTimingDetails} [timing]
|
|
1549
1565
|
*/
|
|
1550
1566
|
/**
|
|
1551
1567
|
* @typedef Address
|
|
1552
|
-
* @property {string} [address1] - Primary address line
|
|
1568
|
+
* @property {string} [address1] - Primary address line, typically containing
|
|
1569
|
+
* street or building information.
|
|
1570
|
+
* @property {string} [address2] - Secondary address line, typically containing
|
|
1571
|
+
* landmark or area information.
|
|
1553
1572
|
* @property {string} [country] - Country where the store is located.
|
|
1554
1573
|
* @property {string} [pincode] - Postal code of the store location.
|
|
1574
|
+
* @property {string} [postal_code] - Postal code or ZIP code of the store location.
|
|
1555
1575
|
* @property {string} [city] - City where the store is located.
|
|
1556
1576
|
* @property {string} [state] - State where the store is located.
|
|
1557
1577
|
* @property {number} [latitude] - Latitude coordinate of the store.
|
|
1558
1578
|
* @property {number} [longitude] - Longitude coordinate of the store.
|
|
1559
|
-
* @property {string} [country_code] - ISO country code of the store location.
|
|
1579
|
+
* @property {string} [country_code] - Two digit ISO country code of the store location.
|
|
1580
|
+
* @property {LatLong} [lat_long] - Geographic coordinates in GeoJSON Point format.
|
|
1581
|
+
*/
|
|
1582
|
+
/**
|
|
1583
|
+
* @typedef LatLong
|
|
1584
|
+
* @property {string} [type] - The type of geographical coordinates.
|
|
1585
|
+
* @property {number[]} [coordinates] - The list of coordinates (latitude and longitude).
|
|
1586
|
+
*/
|
|
1587
|
+
/**
|
|
1588
|
+
* @typedef StoreDistance
|
|
1589
|
+
* @property {number} [value] - Distance value from the user's location.
|
|
1590
|
+
* @property {string} [unit] - Unit of measurement for the distance (e.g., 'm'
|
|
1591
|
+
* for meters, 'km' for kilometers).
|
|
1592
|
+
* @property {string} [reason] - Reason if distance cannot be calculated (e.g.,
|
|
1593
|
+
* 'invalid_customer_location').
|
|
1594
|
+
*/
|
|
1595
|
+
/**
|
|
1596
|
+
* @typedef StoreTimingDetails
|
|
1597
|
+
* @property {StoreTiming[]} [operational_timing] - Operational hours for each
|
|
1598
|
+
* weekday, this is the time when the store is physically open for customers.
|
|
1599
|
+
* @property {StoreTiming[]} [order_acceptance_timing] - Order acceptance hours
|
|
1600
|
+
* for each weekday, this is the time when the store is open for accepting orders.
|
|
1601
|
+
*/
|
|
1602
|
+
/**
|
|
1603
|
+
* @typedef StoreTiming
|
|
1604
|
+
* @property {string} [weekday] - Day of the week.
|
|
1605
|
+
* @property {boolean} [open] - Indicates whether the store is open on this weekday.
|
|
1606
|
+
* @property {Time} [opening] - Opening time for this weekday.
|
|
1607
|
+
* @property {Time} [closing] - Closing time for this weekday.
|
|
1608
|
+
*/
|
|
1609
|
+
/**
|
|
1610
|
+
* @typedef Time
|
|
1611
|
+
* @property {number} [hour] - Hour of the day in 24-hour format (0-23).
|
|
1612
|
+
* @property {number} [minute] - Minute of the hour (0-59).
|
|
1560
1613
|
*/
|
|
1561
1614
|
/**
|
|
1562
1615
|
* @typedef FulfillmentOptionValidate
|
|
@@ -1838,6 +1891,7 @@ export = ServiceabilityPlatformModel;
|
|
|
1838
1891
|
* code-based operations.
|
|
1839
1892
|
* @property {boolean} [mps] - Denotes if the courier partner supports
|
|
1840
1893
|
* multi-part shipment services.
|
|
1894
|
+
* @property {boolean} [b2b] - Denotes if courier partner is business-to-business or not.
|
|
1841
1895
|
* @property {boolean} [ndr] - Indicates if the Non-Delivery Report (NDR)
|
|
1842
1896
|
* feature is supported by the courier partner.
|
|
1843
1897
|
* @property {number} [ndr_attempts] - Number of attempts allowed for resolving
|
|
@@ -2267,8 +2321,7 @@ export = ServiceabilityPlatformModel;
|
|
|
2267
2321
|
* @property {string} [name] - The name of the locality.
|
|
2268
2322
|
* @property {string} [display_name] - The display name of the locality.
|
|
2269
2323
|
* @property {string[]} [parent_ids] - List of parent locality Ids.
|
|
2270
|
-
* @property {Object} [meta] - Additional metadata for the locality
|
|
2271
|
-
* _Deprecated_*
|
|
2324
|
+
* @property {Object} [meta] - Additional metadata for the locality.
|
|
2272
2325
|
* @property {string} [type] - The type of the locality.
|
|
2273
2326
|
* @property {PincodeLatLongData} [lat_long]
|
|
2274
2327
|
* @property {string} [parent_uid] - Unique identifier of the parent locality,
|
|
@@ -2296,8 +2349,7 @@ export = ServiceabilityPlatformModel;
|
|
|
2296
2349
|
* @property {string} [display_name] - A string providing the display name of
|
|
2297
2350
|
* the locality.
|
|
2298
2351
|
* @property {Object} [meta] - An object with additional properties for
|
|
2299
|
-
* metadata, defaulting to an empty object
|
|
2300
|
-
* _Deprecated_*
|
|
2352
|
+
* metadata, defaulting to an empty object.
|
|
2301
2353
|
* @property {string[]} [parent_ids] - A nullable array of strings listing the
|
|
2302
2354
|
* identifiers of parent localities, defaulting to an empty array.
|
|
2303
2355
|
* @property {string} [type] - A string indicating the type of locality.
|
|
@@ -2487,7 +2539,7 @@ export = ServiceabilityPlatformModel;
|
|
|
2487
2539
|
declare class ServiceabilityPlatformModel {
|
|
2488
2540
|
}
|
|
2489
2541
|
declare namespace ServiceabilityPlatformModel {
|
|
2490
|
-
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, 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 };
|
|
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 };
|
|
2491
2543
|
}
|
|
2492
2544
|
/** @returns {PlatformShipmentsRequestSchema} */
|
|
2493
2545
|
declare function PlatformShipmentsRequestSchema(): PlatformShipmentsRequestSchema;
|
|
@@ -3099,8 +3151,7 @@ type PincodeMOPResult = {
|
|
|
3099
3151
|
*/
|
|
3100
3152
|
success: boolean;
|
|
3101
3153
|
/**
|
|
3102
|
-
* - Status code for the response
|
|
3103
|
-
* _Deprecated_*
|
|
3154
|
+
* - Status code for the response.
|
|
3104
3155
|
*/
|
|
3105
3156
|
status_code: number;
|
|
3106
3157
|
/**
|
|
@@ -3829,6 +3880,12 @@ type CompanyConfig = {
|
|
|
3829
3880
|
* - The unique identifier of the company.
|
|
3830
3881
|
*/
|
|
3831
3882
|
company_id?: number;
|
|
3883
|
+
/**
|
|
3884
|
+
* - Enables rate card feature at
|
|
3885
|
+
* company level. Rate card rule engine runs only if rate card is configured
|
|
3886
|
+
* at delivery partner scheme level.
|
|
3887
|
+
*/
|
|
3888
|
+
is_rate_card_enabled?: boolean;
|
|
3832
3889
|
/**
|
|
3833
3890
|
* - Array defining the sorting order.
|
|
3834
3891
|
*/
|
|
@@ -5212,8 +5269,7 @@ type LocalitiesErrorResult = {
|
|
|
5212
5269
|
declare function GetLocality(): GetLocality;
|
|
5213
5270
|
type GetLocality = {
|
|
5214
5271
|
/**
|
|
5215
|
-
* - Additional metadata for the locality
|
|
5216
|
-
* _Deprecated_*
|
|
5272
|
+
* - Additional metadata for the locality.
|
|
5217
5273
|
*/
|
|
5218
5274
|
meta?: any;
|
|
5219
5275
|
/**
|
|
@@ -5424,6 +5480,12 @@ type GetLocalitiesBulkHistory = {
|
|
|
5424
5480
|
/** @returns {CompanyConfigurationSchema} */
|
|
5425
5481
|
declare function CompanyConfigurationSchema(): CompanyConfigurationSchema;
|
|
5426
5482
|
type CompanyConfigurationSchema = {
|
|
5483
|
+
/**
|
|
5484
|
+
* - Enables rate card feature at
|
|
5485
|
+
* company level. Rate card rule engine runs only if rate card is configured
|
|
5486
|
+
* at delivery partner scheme level.
|
|
5487
|
+
*/
|
|
5488
|
+
is_rate_card_enabled?: boolean;
|
|
5427
5489
|
/**
|
|
5428
5490
|
* - An array of strings specifying sorting preferences.
|
|
5429
5491
|
*/
|
|
@@ -6382,35 +6444,71 @@ type FulfillmentOptionStore = {
|
|
|
6382
6444
|
* - Unique identifier for the store.
|
|
6383
6445
|
*/
|
|
6384
6446
|
uid?: number;
|
|
6447
|
+
/**
|
|
6448
|
+
* - Store code identifier.
|
|
6449
|
+
*/
|
|
6450
|
+
store_code?: string;
|
|
6385
6451
|
address?: Address;
|
|
6386
6452
|
/**
|
|
6387
6453
|
* - The unique identifier of the company.
|
|
6388
6454
|
*/
|
|
6389
6455
|
company_id?: number;
|
|
6390
|
-
/**
|
|
6391
|
-
* - Store name displayed in the UI.
|
|
6392
|
-
*/
|
|
6393
|
-
display_name?: string;
|
|
6394
6456
|
/**
|
|
6395
6457
|
* - Name of the store.
|
|
6396
6458
|
*/
|
|
6397
6459
|
name?: string;
|
|
6398
6460
|
/**
|
|
6399
|
-
* - Type of store (e.g., high_street, mall).
|
|
6461
|
+
* - Type of store (e.g., high_street, mall, warehouse).
|
|
6400
6462
|
*/
|
|
6401
6463
|
store_type?: string;
|
|
6402
6464
|
/**
|
|
6403
6465
|
* - Tags associated with the store.
|
|
6404
6466
|
*/
|
|
6405
6467
|
tags?: string[];
|
|
6468
|
+
/**
|
|
6469
|
+
* - Average order processing
|
|
6470
|
+
* time in seconds.
|
|
6471
|
+
*/
|
|
6472
|
+
avg_order_processing_time?: number;
|
|
6473
|
+
/**
|
|
6474
|
+
* - Timezone of the store location.
|
|
6475
|
+
*/
|
|
6476
|
+
timezone?: string;
|
|
6477
|
+
/**
|
|
6478
|
+
* - List of holidays as date range tuples
|
|
6479
|
+
* [start_date, end_date].
|
|
6480
|
+
*/
|
|
6481
|
+
holiday_list?: string[][];
|
|
6482
|
+
/**
|
|
6483
|
+
* - Custom fields associated with the store.
|
|
6484
|
+
*/
|
|
6485
|
+
customfields?: any;
|
|
6486
|
+
/**
|
|
6487
|
+
* - This field is marked as true when the store
|
|
6488
|
+
* is configured to be closed for every day of the week..
|
|
6489
|
+
*/
|
|
6490
|
+
is_open?: boolean;
|
|
6491
|
+
/**
|
|
6492
|
+
* - Custom fields related to delivery
|
|
6493
|
+
* promises used when stores have different delivery promises for different days.
|
|
6494
|
+
*/
|
|
6495
|
+
promise_customfields?: any;
|
|
6496
|
+
distance?: StoreDistance;
|
|
6497
|
+
timing?: StoreTimingDetails;
|
|
6406
6498
|
};
|
|
6407
6499
|
/** @returns {Address} */
|
|
6408
6500
|
declare function Address(): Address;
|
|
6409
6501
|
type Address = {
|
|
6410
6502
|
/**
|
|
6411
|
-
* - Primary address line
|
|
6503
|
+
* - Primary address line, typically containing
|
|
6504
|
+
* street or building information.
|
|
6412
6505
|
*/
|
|
6413
6506
|
address1?: string;
|
|
6507
|
+
/**
|
|
6508
|
+
* - Secondary address line, typically containing
|
|
6509
|
+
* landmark or area information.
|
|
6510
|
+
*/
|
|
6511
|
+
address2?: string;
|
|
6414
6512
|
/**
|
|
6415
6513
|
* - Country where the store is located.
|
|
6416
6514
|
*/
|
|
@@ -6419,6 +6517,10 @@ type Address = {
|
|
|
6419
6517
|
* - Postal code of the store location.
|
|
6420
6518
|
*/
|
|
6421
6519
|
pincode?: string;
|
|
6520
|
+
/**
|
|
6521
|
+
* - Postal code or ZIP code of the store location.
|
|
6522
|
+
*/
|
|
6523
|
+
postal_code?: string;
|
|
6422
6524
|
/**
|
|
6423
6525
|
* - City where the store is located.
|
|
6424
6526
|
*/
|
|
@@ -6436,9 +6538,89 @@ type Address = {
|
|
|
6436
6538
|
*/
|
|
6437
6539
|
longitude?: number;
|
|
6438
6540
|
/**
|
|
6439
|
-
* - ISO country code of the store location.
|
|
6541
|
+
* - Two digit ISO country code of the store location.
|
|
6440
6542
|
*/
|
|
6441
6543
|
country_code?: string;
|
|
6544
|
+
/**
|
|
6545
|
+
* - Geographic coordinates in GeoJSON Point format.
|
|
6546
|
+
*/
|
|
6547
|
+
lat_long?: LatLong;
|
|
6548
|
+
};
|
|
6549
|
+
/** @returns {LatLong} */
|
|
6550
|
+
declare function LatLong(): LatLong;
|
|
6551
|
+
type LatLong = {
|
|
6552
|
+
/**
|
|
6553
|
+
* - The type of geographical coordinates.
|
|
6554
|
+
*/
|
|
6555
|
+
type?: string;
|
|
6556
|
+
/**
|
|
6557
|
+
* - The list of coordinates (latitude and longitude).
|
|
6558
|
+
*/
|
|
6559
|
+
coordinates?: number[];
|
|
6560
|
+
};
|
|
6561
|
+
/** @returns {StoreDistance} */
|
|
6562
|
+
declare function StoreDistance(): StoreDistance;
|
|
6563
|
+
type StoreDistance = {
|
|
6564
|
+
/**
|
|
6565
|
+
* - Distance value from the user's location.
|
|
6566
|
+
*/
|
|
6567
|
+
value?: number;
|
|
6568
|
+
/**
|
|
6569
|
+
* - Unit of measurement for the distance (e.g., 'm'
|
|
6570
|
+
* for meters, 'km' for kilometers).
|
|
6571
|
+
*/
|
|
6572
|
+
unit?: string;
|
|
6573
|
+
/**
|
|
6574
|
+
* - Reason if distance cannot be calculated (e.g.,
|
|
6575
|
+
* 'invalid_customer_location').
|
|
6576
|
+
*/
|
|
6577
|
+
reason?: string;
|
|
6578
|
+
};
|
|
6579
|
+
/** @returns {StoreTimingDetails} */
|
|
6580
|
+
declare function StoreTimingDetails(): StoreTimingDetails;
|
|
6581
|
+
type StoreTimingDetails = {
|
|
6582
|
+
/**
|
|
6583
|
+
* - Operational hours for each
|
|
6584
|
+
* weekday, this is the time when the store is physically open for customers.
|
|
6585
|
+
*/
|
|
6586
|
+
operational_timing?: StoreTiming[];
|
|
6587
|
+
/**
|
|
6588
|
+
* - Order acceptance hours
|
|
6589
|
+
* for each weekday, this is the time when the store is open for accepting orders.
|
|
6590
|
+
*/
|
|
6591
|
+
order_acceptance_timing?: StoreTiming[];
|
|
6592
|
+
};
|
|
6593
|
+
/** @returns {StoreTiming} */
|
|
6594
|
+
declare function StoreTiming(): StoreTiming;
|
|
6595
|
+
type StoreTiming = {
|
|
6596
|
+
/**
|
|
6597
|
+
* - Day of the week.
|
|
6598
|
+
*/
|
|
6599
|
+
weekday?: string;
|
|
6600
|
+
/**
|
|
6601
|
+
* - Indicates whether the store is open on this weekday.
|
|
6602
|
+
*/
|
|
6603
|
+
open?: boolean;
|
|
6604
|
+
/**
|
|
6605
|
+
* - Opening time for this weekday.
|
|
6606
|
+
*/
|
|
6607
|
+
opening?: Time;
|
|
6608
|
+
/**
|
|
6609
|
+
* - Closing time for this weekday.
|
|
6610
|
+
*/
|
|
6611
|
+
closing?: Time;
|
|
6612
|
+
};
|
|
6613
|
+
/** @returns {Time} */
|
|
6614
|
+
declare function Time(): Time;
|
|
6615
|
+
type Time = {
|
|
6616
|
+
/**
|
|
6617
|
+
* - Hour of the day in 24-hour format (0-23).
|
|
6618
|
+
*/
|
|
6619
|
+
hour?: number;
|
|
6620
|
+
/**
|
|
6621
|
+
* - Minute of the hour (0-59).
|
|
6622
|
+
*/
|
|
6623
|
+
minute?: number;
|
|
6442
6624
|
};
|
|
6443
6625
|
/** @returns {FulfillmentOptionValidate} */
|
|
6444
6626
|
declare function FulfillmentOptionValidate(): FulfillmentOptionValidate;
|
|
@@ -7113,6 +7295,10 @@ type CourierPartnerSchemeFeatures = {
|
|
|
7113
7295
|
* multi-part shipment services.
|
|
7114
7296
|
*/
|
|
7115
7297
|
mps?: boolean;
|
|
7298
|
+
/**
|
|
7299
|
+
* - Denotes if courier partner is business-to-business or not.
|
|
7300
|
+
*/
|
|
7301
|
+
b2b?: boolean;
|
|
7116
7302
|
/**
|
|
7117
7303
|
* - Indicates if the Non-Delivery Report (NDR)
|
|
7118
7304
|
* feature is supported by the courier partner.
|
|
@@ -8154,8 +8340,7 @@ type Localities = {
|
|
|
8154
8340
|
*/
|
|
8155
8341
|
parent_ids?: string[];
|
|
8156
8342
|
/**
|
|
8157
|
-
* - Additional metadata for the locality
|
|
8158
|
-
* _Deprecated_*
|
|
8343
|
+
* - Additional metadata for the locality.
|
|
8159
8344
|
*/
|
|
8160
8345
|
meta?: any;
|
|
8161
8346
|
/**
|
|
@@ -8236,8 +8421,7 @@ type LocalityParent = {
|
|
|
8236
8421
|
display_name?: string;
|
|
8237
8422
|
/**
|
|
8238
8423
|
* - An object with additional properties for
|
|
8239
|
-
* metadata, defaulting to an empty object
|
|
8240
|
-
* _Deprecated_*
|
|
8424
|
+
* metadata, defaulting to an empty object.
|
|
8241
8425
|
*/
|
|
8242
8426
|
meta?: any;
|
|
8243
8427
|
/**
|
|
@@ -278,8 +278,7 @@ const Joi = require("joi");
|
|
|
278
278
|
/**
|
|
279
279
|
* @typedef PincodeMOPResult
|
|
280
280
|
* @property {boolean} success - Whether operation was successful.
|
|
281
|
-
* @property {number} status_code - Status code for the response
|
|
282
|
-
* _Deprecated_*
|
|
281
|
+
* @property {number} status_code - Status code for the response.
|
|
283
282
|
* @property {string} batch_id - A unique identifier for the performed batch operation.
|
|
284
283
|
* @property {string} country - Name of the country.
|
|
285
284
|
* @property {string} action - Denotes wether to activate or deavtivate pincodes
|
|
@@ -592,6 +591,9 @@ const Joi = require("joi");
|
|
|
592
591
|
/**
|
|
593
592
|
* @typedef CompanyConfig
|
|
594
593
|
* @property {number} [company_id] - The unique identifier of the company.
|
|
594
|
+
* @property {boolean} [is_rate_card_enabled] - Enables rate card feature at
|
|
595
|
+
* company level. Rate card rule engine runs only if rate card is configured
|
|
596
|
+
* at delivery partner scheme level.
|
|
595
597
|
* @property {string[]} [sort] - Array defining the sorting order.
|
|
596
598
|
* @property {string} [logistics_as_actual] - Defines the logistics control type.
|
|
597
599
|
*/
|
|
@@ -1191,8 +1193,7 @@ const Joi = require("joi");
|
|
|
1191
1193
|
|
|
1192
1194
|
/**
|
|
1193
1195
|
* @typedef GetLocality
|
|
1194
|
-
* @property {Object} [meta] - Additional metadata for the locality
|
|
1195
|
-
* _Deprecated_*
|
|
1196
|
+
* @property {Object} [meta] - Additional metadata for the locality.
|
|
1196
1197
|
* @property {string} [parent_uid] - Unique identifier for the parent locality,
|
|
1197
1198
|
* if applicable.
|
|
1198
1199
|
* @property {string} [id] - A string serving as the unique identifier.
|
|
@@ -1296,6 +1297,9 @@ const Joi = require("joi");
|
|
|
1296
1297
|
|
|
1297
1298
|
/**
|
|
1298
1299
|
* @typedef CompanyConfigurationSchema
|
|
1300
|
+
* @property {boolean} [is_rate_card_enabled] - Enables rate card feature at
|
|
1301
|
+
* company level. Rate card rule engine runs only if rate card is configured
|
|
1302
|
+
* at delivery partner scheme level.
|
|
1299
1303
|
* @property {string[]} [sort] - An array of strings specifying sorting preferences.
|
|
1300
1304
|
*/
|
|
1301
1305
|
|
|
@@ -1690,24 +1694,78 @@ const Joi = require("joi");
|
|
|
1690
1694
|
/**
|
|
1691
1695
|
* @typedef FulfillmentOptionStore
|
|
1692
1696
|
* @property {number} [uid] - Unique identifier for the store.
|
|
1697
|
+
* @property {string} [store_code] - Store code identifier.
|
|
1693
1698
|
* @property {Address} [address]
|
|
1694
1699
|
* @property {number} [company_id] - The unique identifier of the company.
|
|
1695
|
-
* @property {string} [display_name] - Store name displayed in the UI.
|
|
1696
1700
|
* @property {string} [name] - Name of the store.
|
|
1697
|
-
* @property {string} [store_type] - Type of store (e.g., high_street, mall).
|
|
1701
|
+
* @property {string} [store_type] - Type of store (e.g., high_street, mall, warehouse).
|
|
1698
1702
|
* @property {string[]} [tags] - Tags associated with the store.
|
|
1703
|
+
* @property {number} [avg_order_processing_time] - Average order processing
|
|
1704
|
+
* time in seconds.
|
|
1705
|
+
* @property {string} [timezone] - Timezone of the store location.
|
|
1706
|
+
* @property {string[][]} [holiday_list] - List of holidays as date range tuples
|
|
1707
|
+
* [start_date, end_date].
|
|
1708
|
+
* @property {Object} [customfields] - Custom fields associated with the store.
|
|
1709
|
+
* @property {boolean} [is_open] - This field is marked as true when the store
|
|
1710
|
+
* is configured to be closed for every day of the week..
|
|
1711
|
+
* @property {Object} [promise_customfields] - Custom fields related to delivery
|
|
1712
|
+
* promises used when stores have different delivery promises for different days.
|
|
1713
|
+
* @property {StoreDistance} [distance]
|
|
1714
|
+
* @property {StoreTimingDetails} [timing]
|
|
1699
1715
|
*/
|
|
1700
1716
|
|
|
1701
1717
|
/**
|
|
1702
1718
|
* @typedef Address
|
|
1703
|
-
* @property {string} [address1] - Primary address line
|
|
1719
|
+
* @property {string} [address1] - Primary address line, typically containing
|
|
1720
|
+
* street or building information.
|
|
1721
|
+
* @property {string} [address2] - Secondary address line, typically containing
|
|
1722
|
+
* landmark or area information.
|
|
1704
1723
|
* @property {string} [country] - Country where the store is located.
|
|
1705
1724
|
* @property {string} [pincode] - Postal code of the store location.
|
|
1725
|
+
* @property {string} [postal_code] - Postal code or ZIP code of the store location.
|
|
1706
1726
|
* @property {string} [city] - City where the store is located.
|
|
1707
1727
|
* @property {string} [state] - State where the store is located.
|
|
1708
1728
|
* @property {number} [latitude] - Latitude coordinate of the store.
|
|
1709
1729
|
* @property {number} [longitude] - Longitude coordinate of the store.
|
|
1710
|
-
* @property {string} [country_code] - ISO country code of the store location.
|
|
1730
|
+
* @property {string} [country_code] - Two digit ISO country code of the store location.
|
|
1731
|
+
* @property {LatLong} [lat_long] - Geographic coordinates in GeoJSON Point format.
|
|
1732
|
+
*/
|
|
1733
|
+
|
|
1734
|
+
/**
|
|
1735
|
+
* @typedef LatLong
|
|
1736
|
+
* @property {string} [type] - The type of geographical coordinates.
|
|
1737
|
+
* @property {number[]} [coordinates] - The list of coordinates (latitude and longitude).
|
|
1738
|
+
*/
|
|
1739
|
+
|
|
1740
|
+
/**
|
|
1741
|
+
* @typedef StoreDistance
|
|
1742
|
+
* @property {number} [value] - Distance value from the user's location.
|
|
1743
|
+
* @property {string} [unit] - Unit of measurement for the distance (e.g., 'm'
|
|
1744
|
+
* for meters, 'km' for kilometers).
|
|
1745
|
+
* @property {string} [reason] - Reason if distance cannot be calculated (e.g.,
|
|
1746
|
+
* 'invalid_customer_location').
|
|
1747
|
+
*/
|
|
1748
|
+
|
|
1749
|
+
/**
|
|
1750
|
+
* @typedef StoreTimingDetails
|
|
1751
|
+
* @property {StoreTiming[]} [operational_timing] - Operational hours for each
|
|
1752
|
+
* weekday, this is the time when the store is physically open for customers.
|
|
1753
|
+
* @property {StoreTiming[]} [order_acceptance_timing] - Order acceptance hours
|
|
1754
|
+
* for each weekday, this is the time when the store is open for accepting orders.
|
|
1755
|
+
*/
|
|
1756
|
+
|
|
1757
|
+
/**
|
|
1758
|
+
* @typedef StoreTiming
|
|
1759
|
+
* @property {string} [weekday] - Day of the week.
|
|
1760
|
+
* @property {boolean} [open] - Indicates whether the store is open on this weekday.
|
|
1761
|
+
* @property {Time} [opening] - Opening time for this weekday.
|
|
1762
|
+
* @property {Time} [closing] - Closing time for this weekday.
|
|
1763
|
+
*/
|
|
1764
|
+
|
|
1765
|
+
/**
|
|
1766
|
+
* @typedef Time
|
|
1767
|
+
* @property {number} [hour] - Hour of the day in 24-hour format (0-23).
|
|
1768
|
+
* @property {number} [minute] - Minute of the hour (0-59).
|
|
1711
1769
|
*/
|
|
1712
1770
|
|
|
1713
1771
|
/**
|
|
@@ -2025,6 +2083,7 @@ const Joi = require("joi");
|
|
|
2025
2083
|
* code-based operations.
|
|
2026
2084
|
* @property {boolean} [mps] - Denotes if the courier partner supports
|
|
2027
2085
|
* multi-part shipment services.
|
|
2086
|
+
* @property {boolean} [b2b] - Denotes if courier partner is business-to-business or not.
|
|
2028
2087
|
* @property {boolean} [ndr] - Indicates if the Non-Delivery Report (NDR)
|
|
2029
2088
|
* feature is supported by the courier partner.
|
|
2030
2089
|
* @property {number} [ndr_attempts] - Number of attempts allowed for resolving
|
|
@@ -2501,8 +2560,7 @@ const Joi = require("joi");
|
|
|
2501
2560
|
* @property {string} [name] - The name of the locality.
|
|
2502
2561
|
* @property {string} [display_name] - The display name of the locality.
|
|
2503
2562
|
* @property {string[]} [parent_ids] - List of parent locality Ids.
|
|
2504
|
-
* @property {Object} [meta] - Additional metadata for the locality
|
|
2505
|
-
* _Deprecated_*
|
|
2563
|
+
* @property {Object} [meta] - Additional metadata for the locality.
|
|
2506
2564
|
* @property {string} [type] - The type of the locality.
|
|
2507
2565
|
* @property {PincodeLatLongData} [lat_long]
|
|
2508
2566
|
* @property {string} [parent_uid] - Unique identifier of the parent locality,
|
|
@@ -2532,8 +2590,7 @@ const Joi = require("joi");
|
|
|
2532
2590
|
* @property {string} [display_name] - A string providing the display name of
|
|
2533
2591
|
* the locality.
|
|
2534
2592
|
* @property {Object} [meta] - An object with additional properties for
|
|
2535
|
-
* metadata, defaulting to an empty object
|
|
2536
|
-
* _Deprecated_*
|
|
2593
|
+
* metadata, defaulting to an empty object.
|
|
2537
2594
|
* @property {string[]} [parent_ids] - A nullable array of strings listing the
|
|
2538
2595
|
* identifiers of parent localities, defaulting to an empty array.
|
|
2539
2596
|
* @property {string} [type] - A string indicating the type of locality.
|
|
@@ -3424,6 +3481,7 @@ class ServiceabilityPlatformModel {
|
|
|
3424
3481
|
static CompanyConfig() {
|
|
3425
3482
|
return Joi.object({
|
|
3426
3483
|
company_id: Joi.number(),
|
|
3484
|
+
is_rate_card_enabled: Joi.boolean(),
|
|
3427
3485
|
sort: Joi.array().items(Joi.string().allow("")),
|
|
3428
3486
|
logistics_as_actual: Joi.string().allow(""),
|
|
3429
3487
|
});
|
|
@@ -4130,6 +4188,7 @@ class ServiceabilityPlatformModel {
|
|
|
4130
4188
|
/** @returns {CompanyConfigurationSchema} */
|
|
4131
4189
|
static CompanyConfigurationSchema() {
|
|
4132
4190
|
return Joi.object({
|
|
4191
|
+
is_rate_card_enabled: Joi.boolean(),
|
|
4133
4192
|
sort: Joi.array().items(Joi.string().allow("")),
|
|
4134
4193
|
});
|
|
4135
4194
|
}
|
|
@@ -4576,12 +4635,22 @@ class ServiceabilityPlatformModel {
|
|
|
4576
4635
|
static FulfillmentOptionStore() {
|
|
4577
4636
|
return Joi.object({
|
|
4578
4637
|
uid: Joi.number(),
|
|
4638
|
+
store_code: Joi.string().allow(""),
|
|
4579
4639
|
address: ServiceabilityPlatformModel.Address(),
|
|
4580
4640
|
company_id: Joi.number(),
|
|
4581
|
-
display_name: Joi.string().allow(""),
|
|
4582
4641
|
name: Joi.string().allow(""),
|
|
4583
4642
|
store_type: Joi.string().allow(""),
|
|
4584
4643
|
tags: Joi.array().items(Joi.string().allow("")),
|
|
4644
|
+
avg_order_processing_time: Joi.number(),
|
|
4645
|
+
timezone: Joi.string().allow(""),
|
|
4646
|
+
holiday_list: Joi.array().items(
|
|
4647
|
+
Joi.array().items(Joi.string().allow(""))
|
|
4648
|
+
),
|
|
4649
|
+
customfields: Joi.object().pattern(/\S/, Joi.any()),
|
|
4650
|
+
is_open: Joi.boolean(),
|
|
4651
|
+
promise_customfields: Joi.object().pattern(/\S/, Joi.any()),
|
|
4652
|
+
distance: ServiceabilityPlatformModel.StoreDistance(),
|
|
4653
|
+
timing: ServiceabilityPlatformModel.StoreTimingDetails(),
|
|
4585
4654
|
});
|
|
4586
4655
|
}
|
|
4587
4656
|
|
|
@@ -4589,13 +4658,63 @@ class ServiceabilityPlatformModel {
|
|
|
4589
4658
|
static Address() {
|
|
4590
4659
|
return Joi.object({
|
|
4591
4660
|
address1: Joi.string().allow(""),
|
|
4661
|
+
address2: Joi.string().allow(""),
|
|
4592
4662
|
country: Joi.string().allow(""),
|
|
4593
4663
|
pincode: Joi.string().allow(""),
|
|
4664
|
+
postal_code: Joi.string().allow(""),
|
|
4594
4665
|
city: Joi.string().allow(""),
|
|
4595
4666
|
state: Joi.string().allow(""),
|
|
4596
4667
|
latitude: Joi.number(),
|
|
4597
4668
|
longitude: Joi.number(),
|
|
4598
4669
|
country_code: Joi.string().allow(""),
|
|
4670
|
+
lat_long: ServiceabilityPlatformModel.LatLong(),
|
|
4671
|
+
});
|
|
4672
|
+
}
|
|
4673
|
+
|
|
4674
|
+
/** @returns {LatLong} */
|
|
4675
|
+
static LatLong() {
|
|
4676
|
+
return Joi.object({
|
|
4677
|
+
type: Joi.string().allow(""),
|
|
4678
|
+
coordinates: Joi.array().items(Joi.number()),
|
|
4679
|
+
});
|
|
4680
|
+
}
|
|
4681
|
+
|
|
4682
|
+
/** @returns {StoreDistance} */
|
|
4683
|
+
static StoreDistance() {
|
|
4684
|
+
return Joi.object({
|
|
4685
|
+
value: Joi.number().allow(null),
|
|
4686
|
+
unit: Joi.string().allow(""),
|
|
4687
|
+
reason: Joi.string().allow("").allow(null),
|
|
4688
|
+
});
|
|
4689
|
+
}
|
|
4690
|
+
|
|
4691
|
+
/** @returns {StoreTimingDetails} */
|
|
4692
|
+
static StoreTimingDetails() {
|
|
4693
|
+
return Joi.object({
|
|
4694
|
+
operational_timing: Joi.array().items(
|
|
4695
|
+
ServiceabilityPlatformModel.StoreTiming()
|
|
4696
|
+
),
|
|
4697
|
+
order_acceptance_timing: Joi.array().items(
|
|
4698
|
+
ServiceabilityPlatformModel.StoreTiming()
|
|
4699
|
+
),
|
|
4700
|
+
});
|
|
4701
|
+
}
|
|
4702
|
+
|
|
4703
|
+
/** @returns {StoreTiming} */
|
|
4704
|
+
static StoreTiming() {
|
|
4705
|
+
return Joi.object({
|
|
4706
|
+
weekday: Joi.string().allow(""),
|
|
4707
|
+
open: Joi.boolean(),
|
|
4708
|
+
opening: ServiceabilityPlatformModel.Time(),
|
|
4709
|
+
closing: ServiceabilityPlatformModel.Time(),
|
|
4710
|
+
});
|
|
4711
|
+
}
|
|
4712
|
+
|
|
4713
|
+
/** @returns {Time} */
|
|
4714
|
+
static Time() {
|
|
4715
|
+
return Joi.object({
|
|
4716
|
+
hour: Joi.number(),
|
|
4717
|
+
minute: Joi.number(),
|
|
4599
4718
|
});
|
|
4600
4719
|
}
|
|
4601
4720
|
|
|
@@ -4964,6 +5083,7 @@ class ServiceabilityPlatformModel {
|
|
|
4964
5083
|
doorstep_qc: Joi.boolean(),
|
|
4965
5084
|
qr: Joi.boolean(),
|
|
4966
5085
|
mps: Joi.boolean(),
|
|
5086
|
+
b2b: Joi.boolean(),
|
|
4967
5087
|
ndr: Joi.boolean(),
|
|
4968
5088
|
ndr_attempts: Joi.number(),
|
|
4969
5089
|
dangerous_goods: Joi.boolean(),
|