@gofynd/fdk-client-javascript 1.4.15-beta.13 → 1.4.15-beta.15
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 +23 -26
- package/package.json +5 -1
- package/sdk/application/ApplicationClient.d.ts +5 -6
- package/sdk/application/ApplicationClient.js +24 -20
- package/sdk/application/Cart/CartApplicationClient.d.ts +133 -83
- package/sdk/application/Cart/CartApplicationClient.js +444 -76
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +132 -114
- package/sdk/application/Catalog/CatalogApplicationClient.js +209 -126
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +4 -4
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +3 -3
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +58 -36
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +73 -29
- package/sdk/application/Content/ContentApplicationClient.d.ts +95 -66
- package/sdk/application/Content/ContentApplicationClient.js +274 -111
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +11 -11
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +10 -10
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
- package/sdk/application/Finance/FinanceApplicationClient.js +111 -0
- package/sdk/application/Lead/LeadApplicationClient.d.ts +7 -7
- package/sdk/application/Lead/LeadApplicationClient.js +6 -6
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +37 -57
- package/sdk/application/Logistic/LogisticApplicationClient.js +117 -180
- package/sdk/application/Order/OrderApplicationClient.d.ts +63 -21
- package/sdk/application/Order/OrderApplicationClient.js +217 -17
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +179 -149
- package/sdk/application/Payment/PaymentApplicationClient.js +301 -167
- package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
- package/sdk/application/Share/ShareApplicationClient.js +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.js +10 -6
- package/sdk/application/User/UserApplicationClient.d.ts +103 -53
- package/sdk/application/User/UserApplicationClient.js +308 -49
- package/sdk/common/AxiosHelper.js +11 -4
- package/sdk/common/Constant.d.ts +27 -4
- package/sdk/common/Constant.js +33 -6
- package/sdk/common/utils.d.ts +10 -0
- package/sdk/common/utils.js +24 -3
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +46 -16
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +266 -40
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +163 -19
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +158 -14
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +5 -2
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +23 -7
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +9 -9
- package/sdk/partner/Lead/LeadPartnerClient.js +9 -9
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +14 -9
- package/sdk/partner/Lead/LeadPartnerModel.js +19 -17
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +264 -49
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +2116 -252
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +2256 -258
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +1187 -230
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +21 -1
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +218 -13
- package/sdk/partner/PartnerClient.d.ts +5 -2
- package/sdk/partner/PartnerClient.js +21 -7
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +32 -34
- package/sdk/partner/Theme/ThemePartnerClient.js +42 -44
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +142 -43
- package/sdk/partner/Theme/ThemePartnerModel.js +129 -44
- package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +83 -27
- package/sdk/partner/Webhook/WebhookPartnerClient.js +446 -27
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +920 -185
- package/sdk/partner/Webhook/WebhookPartnerModel.js +462 -154
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +5 -0
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +41 -3
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +8 -7
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +17 -11
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +4 -1
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +68 -13
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +44 -6
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +3 -33
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +4 -244
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +49 -145
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +20 -171
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +15 -15
- package/sdk/platform/Billing/BillingPlatformClient.js +18 -18
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
- package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
- package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +266 -203
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +1446 -500
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +729 -100
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +446 -82
- package/sdk/platform/Cart/CartPlatformModel.d.ts +6927 -1396
- package/sdk/platform/Cart/CartPlatformModel.js +3065 -1316
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +433 -248
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1662 -559
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +464 -159
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +304 -87
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +383 -234
- package/sdk/platform/Catalog/CatalogPlatformClient.js +2475 -1557
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +9571 -2674
- package/sdk/platform/Catalog/CatalogPlatformModel.js +5081 -2019
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +364 -117
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +281 -104
- package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -4
- package/sdk/platform/Common/CommonPlatformClient.js +6 -5
- package/sdk/platform/Common/CommonPlatformModel.d.ts +36 -25
- package/sdk/platform/Common/CommonPlatformModel.js +25 -14
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +80 -153
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +102 -541
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +36 -49
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +20 -60
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +189 -43
- package/sdk/platform/Communication/CommunicationPlatformModel.js +165 -42
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +58 -81
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +68 -116
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +291 -249
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +243 -234
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +78 -65
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +101 -88
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +20 -20
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +19 -19
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +68 -34
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +174 -41
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +667 -244
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +474 -155
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +37 -9
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +27 -8
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +366 -280
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1435 -753
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +323 -223
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +335 -205
- package/sdk/platform/Content/ContentPlatformClient.d.ts +304 -106
- package/sdk/platform/Content/ContentPlatformClient.js +1842 -450
- package/sdk/platform/Content/ContentPlatformModel.d.ts +2582 -566
- package/sdk/platform/Content/ContentPlatformModel.js +1426 -558
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +293 -114
- package/sdk/platform/Content/ContentPlatformValidator.js +328 -101
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +59 -23
- package/sdk/platform/Discount/DiscountPlatformClient.js +84 -23
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +403 -110
- package/sdk/platform/Discount/DiscountPlatformModel.js +121 -107
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +56 -36
- package/sdk/platform/Discount/DiscountPlatformValidator.js +29 -19
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +12 -110
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +14 -684
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +5 -94
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -115
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +20 -20
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +22 -22
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +90 -920
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +53 -949
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +10 -10
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +10 -10
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +11 -11
- package/sdk/platform/Lead/LeadPlatformClient.js +11 -11
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +14 -9
- package/sdk/platform/Lead/LeadPlatformModel.js +20 -18
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +56 -9
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +340 -10
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +128 -24
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +81 -19
- package/sdk/platform/Order/OrderPlatformClient.d.ts +517 -160
- package/sdk/platform/Order/OrderPlatformClient.js +1623 -384
- package/sdk/platform/Order/OrderPlatformModel.d.ts +10372 -1587
- package/sdk/platform/Order/OrderPlatformModel.js +5726 -1512
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +539 -123
- package/sdk/platform/Order/OrderPlatformValidator.js +323 -92
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +8 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +11 -9
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +6 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +3 -2
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +77 -25
- package/sdk/platform/Partner/PartnerPlatformModel.js +32 -21
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +144 -219
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +307 -796
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +86 -121
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +80 -138
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +30 -30
- package/sdk/platform/Payment/PaymentPlatformClient.js +30 -30
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +901 -761
- package/sdk/platform/Payment/PaymentPlatformModel.js +663 -583
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
- package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
- package/sdk/platform/PlatformApplicationClient.d.ts +0 -2
- package/sdk/platform/PlatformApplicationClient.js +0 -4
- package/sdk/platform/PlatformClient.d.ts +5 -4
- package/sdk/platform/PlatformClient.js +32 -22
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +526 -69
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +3337 -337
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +603 -38
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +529 -32
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +184 -133
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +780 -491
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +9408 -1666
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +5720 -1765
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +257 -180
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +185 -127
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +7 -7
- package/sdk/platform/Share/SharePlatformApplicationClient.js +7 -7
- package/sdk/platform/Share/SharePlatformModel.d.ts +45 -9
- package/sdk/platform/Share/SharePlatformModel.js +31 -6
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +26 -26
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +38 -29
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +18 -3
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +10 -2
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +4 -4
- package/sdk/platform/Theme/ThemePlatformClient.js +4 -4
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +103 -17
- package/sdk/platform/Theme/ThemePlatformModel.js +92 -23
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +167 -45
- package/sdk/platform/User/UserPlatformApplicationClient.js +950 -67
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +189 -3
- package/sdk/platform/User/UserPlatformApplicationValidator.js +157 -3
- package/sdk/platform/User/UserPlatformModel.d.ts +880 -47
- package/sdk/platform/User/UserPlatformModel.js +607 -46
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +33 -86
- package/sdk/platform/Webhook/WebhookPlatformClient.js +79 -474
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +861 -422
- package/sdk/platform/Webhook/WebhookPlatformModel.js +469 -391
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
- package/sdk/platform/index.d.ts +0 -2
- package/sdk/platform/index.js +0 -4
- package/sdk/public/Catalog/CatalogPublicClient.d.ts +22 -0
- package/sdk/public/Catalog/CatalogPublicClient.js +133 -0
- package/sdk/public/Catalog/CatalogPublicModel.d.ts +158 -0
- package/sdk/public/Catalog/CatalogPublicModel.js +116 -0
- package/sdk/public/Catalog/CatalogPublicValidator.d.ts +55 -0
- package/sdk/public/Catalog/CatalogPublicValidator.js +35 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +5 -4
- package/sdk/public/Configuration/ConfigurationPublicClient.js +9 -8
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +41 -21
- package/sdk/public/Configuration/ConfigurationPublicModel.js +28 -12
- package/sdk/public/Content/ContentPublicClient.d.ts +145 -2
- package/sdk/public/Content/ContentPublicClient.js +1067 -17
- package/sdk/public/Content/ContentPublicModel.d.ts +704 -3
- package/sdk/public/Content/ContentPublicModel.js +751 -3
- package/sdk/public/Content/ContentPublicValidator.d.ts +94 -3
- package/sdk/public/Content/ContentPublicValidator.js +119 -2
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +1 -1
- package/sdk/public/Partner/PartnerPublicModel.d.ts +248 -72
- package/sdk/public/Partner/PartnerPublicModel.js +81 -71
- package/sdk/public/Partner/PartnerPublicValidator.d.ts +2 -2
- package/sdk/public/Partner/PartnerPublicValidator.js +1 -1
- package/sdk/public/PublicClient.d.ts +5 -2
- package/sdk/public/PublicClient.js +16 -6
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +13 -13
- package/sdk/public/Webhook/WebhookPublicClient.js +13 -13
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +249 -67
- package/sdk/public/Webhook/WebhookPublicModel.js +81 -61
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/public/index.d.ts +1 -0
- package/sdk/public/index.js +2 -0
- package/utility.d.ts +3 -0
- package/utility.js +7 -0
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +0 -79
- package/sdk/application/Rewards/RewardsApplicationClient.js +0 -315
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +0 -19
- package/sdk/application/Webhook/WebhookApplicationClient.js +0 -72
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -320
- package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2890
- package/sdk/platform/Finance/FinancePlatformModel.js +0 -2148
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
- package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
- 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 -382
- package/sdk/platform/Rewards/RewardsPlatformModel.js +0 -408
|
@@ -1,6 +1,28 @@
|
|
|
1
1
|
export = ConfigurationPlatformModel;
|
|
2
|
+
/**
|
|
3
|
+
* @typedef CurrencyExchangeResponseV2
|
|
4
|
+
* @property {string} base - The 3-letter ISO 4217 code representing the base currency.
|
|
5
|
+
* @property {string} base_currency_name - The name of the base currency.
|
|
6
|
+
* @property {number} ttl_seconds - Time in seconds for which the exchange rates
|
|
7
|
+
* are valid.
|
|
8
|
+
* @property {CurrencyExchangeItem[]} items - List of exchange rates and currency details.
|
|
9
|
+
* @property {number} total - Total number of currency exchange items.
|
|
10
|
+
*/
|
|
11
|
+
/**
|
|
12
|
+
* @typedef CurrencyExchangeItem
|
|
13
|
+
* @property {string} currency_code - 3-letter ISO 4217 exchange currency code.
|
|
14
|
+
* @property {string} name - Name of the exchange currency
|
|
15
|
+
* @property {number} rate - Exchange rate of the currency with respect to the
|
|
16
|
+
* base currency.
|
|
17
|
+
* @property {string} country_code - ISO 3166 country code.
|
|
18
|
+
* @property {string} country_name - Name of the country using this currency.
|
|
19
|
+
* @property {string} subunit - The name of the subunit for the currency.
|
|
20
|
+
* @property {number} decimal_digits - Number of decimal digits the currency supports.
|
|
21
|
+
* @property {string} symbol - The symbol of the currency.
|
|
22
|
+
*/
|
|
2
23
|
/**
|
|
3
24
|
* @typedef ApplicationInventory
|
|
25
|
+
* @property {SearchConfig} [search]
|
|
4
26
|
* @property {AppInventoryConfig} [inventory]
|
|
5
27
|
* @property {AuthenticationConfig} [authentication]
|
|
6
28
|
* @property {ArticleAssignmentConfig} [article_assignment]
|
|
@@ -10,6 +32,7 @@ export = ConfigurationPlatformModel;
|
|
|
10
32
|
* @property {AppOrderConfig} [order]
|
|
11
33
|
* @property {AppLogisticsConfig} [logistics]
|
|
12
34
|
* @property {PiiMasking} [pii_masking]
|
|
35
|
+
* @property {ChannelCapabilities} [channel_capabilities]
|
|
13
36
|
* @property {string[]} [tags]
|
|
14
37
|
* @property {number} [__v]
|
|
15
38
|
* @property {string} [business] - Indicates the business type for sales channel
|
|
@@ -18,8 +41,7 @@ export = ConfigurationPlatformModel;
|
|
|
18
41
|
* or not for sales channel inventory
|
|
19
42
|
* @property {CommunicationConfig} [communication]
|
|
20
43
|
* @property {string[]} [platforms]
|
|
21
|
-
* @property {string} [_id] - The unique identifier
|
|
22
|
-
* of the sales channel inventory
|
|
44
|
+
* @property {string} [_id] - The unique identifier of the sales channel inventory
|
|
23
45
|
* @property {LoyaltyPointsConfig} [loyalty_points]
|
|
24
46
|
* @property {string} [app] - Current sales channel ID
|
|
25
47
|
* @property {string} [created_at] - ISO 8601 timestamp of sales channel
|
|
@@ -33,13 +55,70 @@ export = ConfigurationPlatformModel;
|
|
|
33
55
|
* @typedef PiiMasking
|
|
34
56
|
* @property {boolean} [enabled]
|
|
35
57
|
*/
|
|
58
|
+
/**
|
|
59
|
+
* @typedef ChannelCapabilities
|
|
60
|
+
* @property {string[]} commerce_model - Commerce model types supported by the
|
|
61
|
+
* sales channel. Defines whether the channel operates as B2C/D2C
|
|
62
|
+
* (business-to-consumer/direct-to-consumer) or B2B (business-to-business).
|
|
63
|
+
* @property {string[]} business_format - Business format types for the sales
|
|
64
|
+
* channel. Options include standard_commerce for traditional e-commerce,
|
|
65
|
+
* quick_commerce for rapid delivery models, and qsr for quick service
|
|
66
|
+
* restaurant operations.
|
|
67
|
+
* @property {OrderingSources[]} ordering_sources - Represents an ordering
|
|
68
|
+
* source that can be associated with a sales channel. Ordering sources define
|
|
69
|
+
* the origin or platform from which orders are placed, enabling tracking and
|
|
70
|
+
* differentiation of orders based on their source.
|
|
71
|
+
* @property {string} [seller_model] - Seller model for the sales channel.
|
|
72
|
+
* single_seller for single seller, marketplace for multiple platforms,
|
|
73
|
+
* cross_selling for franchise-enabled.
|
|
74
|
+
*/
|
|
75
|
+
/**
|
|
76
|
+
* @typedef OrderingSources
|
|
77
|
+
* @property {string} key - Unique identifier slug for the ordering source. Used
|
|
78
|
+
* to reference and identify the source programmatically.
|
|
79
|
+
* @property {string} name - Human-readable display name of the ordering source.
|
|
80
|
+
* Shown in UI for easy identification by users.
|
|
81
|
+
*/
|
|
82
|
+
/**
|
|
83
|
+
* @typedef FstIdentification
|
|
84
|
+
* @property {boolean} [enabled] - Indicates whether search query interpretation
|
|
85
|
+
* is enabled for the application.
|
|
86
|
+
*/
|
|
87
|
+
/**
|
|
88
|
+
* @typedef SkgIdentification
|
|
89
|
+
* @property {boolean} [enabled] - Indicates whether semantic knowledge
|
|
90
|
+
* graph-based search is enabled for the application.
|
|
91
|
+
*/
|
|
92
|
+
/**
|
|
93
|
+
* @typedef QuerySuggestions
|
|
94
|
+
* @property {boolean} [enabled] - Indicates whether to enable or disable query
|
|
95
|
+
* suggestions powered by the GPT model using the current live catalog within
|
|
96
|
+
* the application.
|
|
97
|
+
* @property {number} [max_limit] - Specifies the maximum number of query
|
|
98
|
+
* suggestions that can be returned.
|
|
99
|
+
*/
|
|
100
|
+
/**
|
|
101
|
+
* @typedef SearchConfig
|
|
102
|
+
* @property {FstIdentification} [fst_identification]
|
|
103
|
+
* @property {QuerySuggestions} [query_suggestions]
|
|
104
|
+
* @property {SkgIdentification} [skg_identification]
|
|
105
|
+
*/
|
|
36
106
|
/**
|
|
37
107
|
* @typedef AppInventoryConfig
|
|
108
|
+
* @property {DeliveryStrategy} [delivery_strategy]
|
|
38
109
|
* @property {InventoryBrand} [brand]
|
|
39
110
|
* @property {InventoryStore} [store]
|
|
40
111
|
* @property {InventoryCategory} [category]
|
|
41
112
|
* @property {InventoryPrice} [price]
|
|
42
113
|
* @property {InventoryDiscount} [discount]
|
|
114
|
+
* @property {string} [price_strategy] - Indicates whether price strategy
|
|
115
|
+
* enabled or not in an application.
|
|
116
|
+
* @property {boolean} [international] - Indicates whether internation price
|
|
117
|
+
* factory enabled or not in an application.
|
|
118
|
+
* @property {boolean} [strategy_change_pending] - Indicates whether price
|
|
119
|
+
* strategy change is pending or not in an application.
|
|
120
|
+
* @property {string} [strategy_modified_at] - ISO 8601 timestamp of last known
|
|
121
|
+
* modifications to the sales channel feature configuration
|
|
43
122
|
* @property {boolean} [out_of_stock] - Indicates whether out of stock products
|
|
44
123
|
* are allowed to show up on the website
|
|
45
124
|
* @property {boolean} [only_verified_products] - Show only verified products
|
|
@@ -51,10 +130,6 @@ export = ConfigurationPlatformModel;
|
|
|
51
130
|
* @property {Object[]} [company_store] - List of selling locations whose
|
|
52
131
|
* inventory is available to the sales channel for displaying on the website
|
|
53
132
|
* @property {number} [company_id]
|
|
54
|
-
* @property {boolean} [enable_zone_overlapping] - Power product listing with
|
|
55
|
-
* overlapping zones
|
|
56
|
-
* @property {boolean} [sort_popular_first] - Give preference to popularity over
|
|
57
|
-
* score in product listing sort
|
|
58
133
|
*/
|
|
59
134
|
/**
|
|
60
135
|
* @typedef InventoryBrand
|
|
@@ -129,6 +204,10 @@ export = ConfigurationPlatformModel;
|
|
|
129
204
|
* @property {boolean} [revenue_engine_coupon] - Allow coupon apply and credits
|
|
130
205
|
* together. Default value is false.
|
|
131
206
|
* @property {PanCardConfig} [pan_card]
|
|
207
|
+
* @property {boolean} [engage_enabled] - If this is enabled, user can earn and
|
|
208
|
+
* redeem loyalty points for the sales channel.
|
|
209
|
+
* @property {boolean} [offer_enabled] - If this is enabled, user can apply
|
|
210
|
+
* coupons and promotions for the sales channel.
|
|
132
211
|
*/
|
|
133
212
|
/**
|
|
134
213
|
* @typedef InternationalDeliveryCharges
|
|
@@ -208,6 +287,19 @@ export = ConfigurationPlatformModel;
|
|
|
208
287
|
* @property {boolean} [enabled] - Allow orders to be accepted from the sales channel
|
|
209
288
|
* @property {boolean} [force_reassignment] - Allow force reassigning of an order
|
|
210
289
|
* @property {string} [message] - Reason for reassigning an order
|
|
290
|
+
* @property {ProcessingSchedule} [processing_schedule]
|
|
291
|
+
*/
|
|
292
|
+
/**
|
|
293
|
+
* @typedef ProcessingSchedule
|
|
294
|
+
* @property {boolean} [is_scheduled] - Indicates whether the order processing
|
|
295
|
+
* is scheduled for future.
|
|
296
|
+
* @property {StartAfter} [start_after]
|
|
297
|
+
*/
|
|
298
|
+
/**
|
|
299
|
+
* @typedef StartAfter
|
|
300
|
+
* @property {number} [days] - Number of days to wait before starting the process.
|
|
301
|
+
* @property {number} [hours] - Number of hours to wait before starting the process.
|
|
302
|
+
* @property {number} [minutes] - Number of minutes to wait before starting the process.
|
|
211
303
|
*/
|
|
212
304
|
/**
|
|
213
305
|
* @typedef AppLogisticsConfig
|
|
@@ -223,6 +315,7 @@ export = ConfigurationPlatformModel;
|
|
|
223
315
|
*/
|
|
224
316
|
/**
|
|
225
317
|
* @typedef AppInventoryPartialUpdate
|
|
318
|
+
* @property {SearchConfig} [search]
|
|
226
319
|
* @property {RewardPointsConfig} [reward_points]
|
|
227
320
|
* @property {AppCartConfig} [cart]
|
|
228
321
|
* @property {AppPaymentConfig} [payment]
|
|
@@ -237,24 +330,24 @@ export = ConfigurationPlatformModel;
|
|
|
237
330
|
* @property {number} [company_id] - Numeric ID allotted to a business account
|
|
238
331
|
*/
|
|
239
332
|
/**
|
|
240
|
-
* @typedef
|
|
333
|
+
* @typedef CompanyByBrandsRequestSchema
|
|
241
334
|
* @property {number} brands - Brand UID
|
|
242
335
|
* @property {string} [search_text] - A search field for finding a company by its name
|
|
243
336
|
*/
|
|
244
337
|
/**
|
|
245
|
-
* @typedef
|
|
338
|
+
* @typedef CompanyByBrandsResponseSchema
|
|
246
339
|
* @property {BrandCompanyInfo[]} [items]
|
|
247
340
|
* @property {Page} [page]
|
|
248
341
|
*/
|
|
249
342
|
/**
|
|
250
|
-
* @typedef
|
|
343
|
+
* @typedef StoreByBrandsRequestSchema
|
|
251
344
|
* @property {number} [company_id] - Current company ID for current company
|
|
252
345
|
* stores only. Don't send in case cross-selling (franchise) is enabled.
|
|
253
346
|
* @property {number} brands - Brand UID
|
|
254
347
|
* @property {string} [search_text] - Search store by its name or store code
|
|
255
348
|
*/
|
|
256
349
|
/**
|
|
257
|
-
* @typedef
|
|
350
|
+
* @typedef StoreByBrandsResponseSchema
|
|
258
351
|
* @property {BrandStoreInfo[]} [items]
|
|
259
352
|
* @property {Page} [page]
|
|
260
353
|
*/
|
|
@@ -279,11 +372,11 @@ export = ConfigurationPlatformModel;
|
|
|
279
372
|
* portrait banner
|
|
280
373
|
*/
|
|
281
374
|
/**
|
|
282
|
-
* @typedef
|
|
375
|
+
* @typedef BrandsByCompanyResponseSchema
|
|
283
376
|
* @property {CompanyBrandInfo[]} [brands]
|
|
284
377
|
*/
|
|
285
378
|
/**
|
|
286
|
-
* @typedef
|
|
379
|
+
* @typedef ValidationFailedResponseSchema
|
|
287
380
|
* @property {string} [message] - Response message for failed validation
|
|
288
381
|
*/
|
|
289
382
|
/**
|
|
@@ -310,26 +403,25 @@ export = ConfigurationPlatformModel;
|
|
|
310
403
|
* amount pan card number is expected from customer for order
|
|
311
404
|
*/
|
|
312
405
|
/**
|
|
313
|
-
* @typedef
|
|
406
|
+
* @typedef CreateApplicationRequestSchema
|
|
314
407
|
* @property {App} [app]
|
|
315
408
|
* @property {ApplicationInventory} [configuration]
|
|
316
409
|
* @property {AppDomain} [domain]
|
|
317
410
|
*/
|
|
318
411
|
/**
|
|
319
|
-
* @typedef
|
|
412
|
+
* @typedef CreateAppResponseSchema
|
|
320
413
|
* @property {Application} [app]
|
|
321
414
|
* @property {ApplicationInventory} [configuration]
|
|
322
415
|
*/
|
|
323
416
|
/**
|
|
324
|
-
* @typedef
|
|
417
|
+
* @typedef ApplicationsResponseSchema
|
|
325
418
|
* @property {Application[]} [items]
|
|
326
419
|
* @property {Page} [page]
|
|
327
420
|
*/
|
|
328
421
|
/**
|
|
329
422
|
* @typedef MobileAppConfiguration
|
|
330
423
|
* @property {boolean} [is_active] - Indicates the availability of the mobile build
|
|
331
|
-
* @property {string} [_id] - The unique identifier
|
|
332
|
-
* for mobile application configuration
|
|
424
|
+
* @property {string} [_id] - The unique identifier for mobile application configuration
|
|
333
425
|
* @property {string} [app_name] - Name of the mobile app
|
|
334
426
|
* @property {LandingImage} [landing_image]
|
|
335
427
|
* @property {SplashImage} [splash_image]
|
|
@@ -355,7 +447,7 @@ export = ConfigurationPlatformModel;
|
|
|
355
447
|
* @property {string} [secure_url] - URL where the splash image is hosted
|
|
356
448
|
*/
|
|
357
449
|
/**
|
|
358
|
-
* @typedef
|
|
450
|
+
* @typedef MobileAppConfigRequestSchema
|
|
359
451
|
* @property {string} [app_name] - Name of the mobile app
|
|
360
452
|
* @property {LandingImage} [landing_image]
|
|
361
453
|
* @property {SplashImage} [splash_image]
|
|
@@ -369,7 +461,7 @@ export = ConfigurationPlatformModel;
|
|
|
369
461
|
*/
|
|
370
462
|
/**
|
|
371
463
|
* @typedef BuildVersion
|
|
372
|
-
* @property {string} [_id] -
|
|
464
|
+
* @property {string} [_id] - Primary Identifier of the build version.
|
|
373
465
|
* @property {string} [application] - Application ID of the sales channel
|
|
374
466
|
* @property {string} [platform_type] - Device platform for which the mobile app
|
|
375
467
|
* was built, e.g. android, ios.
|
|
@@ -387,8 +479,8 @@ export = ConfigurationPlatformModel;
|
|
|
387
479
|
*/
|
|
388
480
|
/**
|
|
389
481
|
* @typedef AppSupportedCurrency
|
|
390
|
-
* @property {string} [_id] - The unique identifier
|
|
391
|
-
*
|
|
482
|
+
* @property {string} [_id] - The unique identifier of the currency
|
|
483
|
+
* configuration supported by the application
|
|
392
484
|
* @property {string[]} [supported_currency]
|
|
393
485
|
* @property {string} [application] - Alphanumeric ID allotted to an application
|
|
394
486
|
* (sales channel website) created within a business account.
|
|
@@ -400,16 +492,14 @@ export = ConfigurationPlatformModel;
|
|
|
400
492
|
*/
|
|
401
493
|
/**
|
|
402
494
|
* @typedef DefaultCurrency
|
|
403
|
-
* @property {string} [ref] - The unique identifier
|
|
404
|
-
* of the default currency
|
|
495
|
+
* @property {string} [ref] - The unique identifier of the default currency
|
|
405
496
|
* @property {string} [code] - 3-character code of the default currency, e.g.
|
|
406
497
|
* INR, EUR, USD
|
|
407
498
|
*/
|
|
408
499
|
/**
|
|
409
500
|
* @typedef DomainAdd
|
|
410
501
|
* @property {string} [name] - Full domain name, e.g. uniket.hostx0.de
|
|
411
|
-
* @property {string} [_id] - The unique identifier
|
|
412
|
-
* of the domain
|
|
502
|
+
* @property {string} [_id] - The unique identifier of the domain
|
|
413
503
|
* @property {boolean} [verified] - Domain is verified or not (indicates if A
|
|
414
504
|
* records and TXT records are correct)
|
|
415
505
|
* @property {boolean} [is_primary] - Domain is primary or not (indicates if the
|
|
@@ -421,14 +511,13 @@ export = ConfigurationPlatformModel;
|
|
|
421
511
|
* @property {string[]} [txt_records]
|
|
422
512
|
*/
|
|
423
513
|
/**
|
|
424
|
-
* @typedef
|
|
514
|
+
* @typedef DomainAddRequestSchema
|
|
425
515
|
* @property {DomainAdd} [domain]
|
|
426
516
|
*/
|
|
427
517
|
/**
|
|
428
518
|
* @typedef Domain
|
|
429
519
|
* @property {string} [name] - Full domain name, e.g. newton.com
|
|
430
|
-
* @property {string} [_id] - The unique identifier
|
|
431
|
-
* of the sales channel domain
|
|
520
|
+
* @property {string} [_id] - The unique identifier of the sales channel domain
|
|
432
521
|
* @property {boolean} [verified] - Domain is verified or not. TXT and A records
|
|
433
522
|
* should propagate correctly.
|
|
434
523
|
* @property {boolean} [is_primary] - Domain is primary or not. Primary domain
|
|
@@ -438,14 +527,13 @@ export = ConfigurationPlatformModel;
|
|
|
438
527
|
* @property {string} [message]
|
|
439
528
|
*/
|
|
440
529
|
/**
|
|
441
|
-
* @typedef
|
|
530
|
+
* @typedef DomainsResponseSchema
|
|
442
531
|
* @property {Domain[]} [domains]
|
|
443
532
|
*/
|
|
444
533
|
/**
|
|
445
534
|
* @typedef UpdateDomain
|
|
446
535
|
* @property {string} [name] - Full domain name, e.g. zenz.com
|
|
447
|
-
* @property {string} [_id] - The unique identifier
|
|
448
|
-
* of the domain
|
|
536
|
+
* @property {string} [_id] - The unique identifier of the domain
|
|
449
537
|
* @property {boolean} [verified] - Domain is verified or not (indicates if A
|
|
450
538
|
* records and TXT records are correct)
|
|
451
539
|
* @property {boolean} [is_primary] - Domain is primary or not (indicates if the
|
|
@@ -454,13 +542,13 @@ export = ConfigurationPlatformModel;
|
|
|
454
542
|
* domain (short URL e.g. bit.ly)
|
|
455
543
|
*/
|
|
456
544
|
/**
|
|
457
|
-
* @typedef
|
|
545
|
+
* @typedef UpdateDomainTypeRequestSchema
|
|
458
546
|
* @property {UpdateDomain} [domain]
|
|
459
547
|
* @property {string} [action] - Shows domain is made primary domain for the
|
|
460
548
|
* sales channel or shorlink is created for the sales channel domain
|
|
461
549
|
*/
|
|
462
550
|
/**
|
|
463
|
-
* @typedef
|
|
551
|
+
* @typedef DomainStatusRequestSchema
|
|
464
552
|
* @property {string} [domain_url] - URL of the domain, e.g. uniket.hostx0.de
|
|
465
553
|
*/
|
|
466
554
|
/**
|
|
@@ -470,15 +558,16 @@ export = ConfigurationPlatformModel;
|
|
|
470
558
|
* domain are correctly propagating via DNS servers
|
|
471
559
|
*/
|
|
472
560
|
/**
|
|
473
|
-
* @typedef
|
|
561
|
+
* @typedef DomainStatusResponseSchema
|
|
474
562
|
* @property {boolean} [connected] - Check if domain is live and mapped to
|
|
475
563
|
* appropriate IP of Fynd Servers
|
|
476
564
|
* @property {DomainStatus[]} [status]
|
|
477
565
|
*/
|
|
478
566
|
/**
|
|
479
|
-
* @typedef
|
|
567
|
+
* @typedef DomainSuggestionsRequestSchema
|
|
480
568
|
* @property {string} [domain_url] - Domain url
|
|
481
|
-
* @property {boolean} [
|
|
569
|
+
* @property {boolean} [custom_domain] - Get suggestions for custom domains or
|
|
570
|
+
* Fynd domains
|
|
482
571
|
*/
|
|
483
572
|
/**
|
|
484
573
|
* @typedef DomainSuggestion
|
|
@@ -491,11 +580,11 @@ export = ConfigurationPlatformModel;
|
|
|
491
580
|
* @property {string} [currency] - Custom domain currency. Not present for Fynd domains.
|
|
492
581
|
*/
|
|
493
582
|
/**
|
|
494
|
-
* @typedef
|
|
583
|
+
* @typedef DomainSuggestionsResponseSchema
|
|
495
584
|
* @property {DomainSuggestion[]} [domains] - Domain URL
|
|
496
585
|
*/
|
|
497
586
|
/**
|
|
498
|
-
* @typedef
|
|
587
|
+
* @typedef SuccessMessageResponseSchema
|
|
499
588
|
* @property {boolean} [success] - Shows whether domain was deleted successfully
|
|
500
589
|
* @property {string} [message] - Success message shown to the user (in a string format)
|
|
501
590
|
*/
|
|
@@ -514,7 +603,7 @@ export = ConfigurationPlatformModel;
|
|
|
514
603
|
* @property {string} [name] - Domain URL of current sales channel, e.g. zenz.com
|
|
515
604
|
*/
|
|
516
605
|
/**
|
|
517
|
-
* @typedef
|
|
606
|
+
* @typedef CompaniesResponseSchema
|
|
518
607
|
* @property {AppInventoryCompanies[]} [items]
|
|
519
608
|
* @property {Page} [page]
|
|
520
609
|
*/
|
|
@@ -526,14 +615,14 @@ export = ConfigurationPlatformModel;
|
|
|
526
615
|
* franchisee, distributor, etc.
|
|
527
616
|
*/
|
|
528
617
|
/**
|
|
529
|
-
* @typedef
|
|
618
|
+
* @typedef StoresResponseSchema
|
|
530
619
|
* @property {AppInventoryStores[]} [items]
|
|
531
620
|
* @property {Page} [page]
|
|
532
621
|
*/
|
|
533
622
|
/**
|
|
534
623
|
* @typedef AppInventoryStores
|
|
535
|
-
* @property {string} [_id] - The unique identifier of the store
|
|
536
|
-
*
|
|
624
|
+
* @property {string} [_id] - The unique identifier of the store in the sales
|
|
625
|
+
* channel inventory
|
|
537
626
|
* @property {string} [modified_on] - ISO 8601 timestamp of last known updation
|
|
538
627
|
* to the stores in sales channel inventory
|
|
539
628
|
* @property {number} [uid] - Sales channel inventory store UID
|
|
@@ -551,7 +640,7 @@ export = ConfigurationPlatformModel;
|
|
|
551
640
|
* @property {Object} [integration_type]
|
|
552
641
|
*/
|
|
553
642
|
/**
|
|
554
|
-
* @typedef
|
|
643
|
+
* @typedef FilterOrderingStoreRequestSchema
|
|
555
644
|
* @property {boolean} [all_stores] - Allow all stores from the ordering stores
|
|
556
645
|
* @property {number[]} [deployed_stores]
|
|
557
646
|
* @property {string} [q] - Store code or name of the ordering store
|
|
@@ -564,8 +653,7 @@ export = ConfigurationPlatformModel;
|
|
|
564
653
|
* @property {string} [type] - Permitted values are 'hard' and 'soft'. For hard
|
|
565
654
|
* type delivery, store selection is compulsory. For soft type, delivery store
|
|
566
655
|
* selection is optional.
|
|
567
|
-
* @property {string} [_id] - The unique identifier
|
|
568
|
-
* of the ordering stores
|
|
656
|
+
* @property {string} [_id] - The unique identifier of the ordering stores
|
|
569
657
|
* @property {string} [app] - Alphanumeric ID allotted to an application (sales
|
|
570
658
|
* channel website) created within a business account
|
|
571
659
|
* @property {number} [__v]
|
|
@@ -575,7 +663,7 @@ export = ConfigurationPlatformModel;
|
|
|
575
663
|
* @property {DeploymentMeta} [deployment_meta]
|
|
576
664
|
*/
|
|
577
665
|
/**
|
|
578
|
-
* @typedef
|
|
666
|
+
* @typedef OrderingStoreSelectRequestSchema
|
|
579
667
|
* @property {OrderingStoreSelect} ordering_store
|
|
580
668
|
*/
|
|
581
669
|
/**
|
|
@@ -591,8 +679,7 @@ export = ConfigurationPlatformModel;
|
|
|
591
679
|
* @typedef OtherSellerApplication
|
|
592
680
|
* @property {string} [name] - Name of the other seller's sales channel
|
|
593
681
|
* @property {string} [description] - Basic details about the other seller's sales channel
|
|
594
|
-
* @property {string} [_id] - The unique identifier
|
|
595
|
-
* of the other seller's sales channel
|
|
682
|
+
* @property {string} [_id] - The unique identifier of the other seller's sales channel
|
|
596
683
|
* @property {string} [domain] - Domain URL of the other seller's sales channel
|
|
597
684
|
* @property {OtherSellerCompany} [company]
|
|
598
685
|
* @property {string} [opt_type] - Inventory opted by the other seller's sales
|
|
@@ -604,11 +691,10 @@ export = ConfigurationPlatformModel;
|
|
|
604
691
|
* @property {Page} [page]
|
|
605
692
|
*/
|
|
606
693
|
/**
|
|
607
|
-
* @typedef
|
|
694
|
+
* @typedef OptedApplicationResponseSchema
|
|
608
695
|
* @property {string} [name] - Name of the other seller's sales channel
|
|
609
696
|
* @property {string} [description] - Basic details about the other seller's sales channel
|
|
610
|
-
* @property {string} [_id] - The unique identifier
|
|
611
|
-
* of the other seller's sales channel
|
|
697
|
+
* @property {string} [_id] - The unique identifier of the other seller's sales channel
|
|
612
698
|
* @property {string} [domain] - Domain URL of the other seller's sales channel
|
|
613
699
|
* @property {OptedCompany} [company]
|
|
614
700
|
* @property {OptedInventory} [opted_inventory]
|
|
@@ -655,10 +741,9 @@ export = ConfigurationPlatformModel;
|
|
|
655
741
|
* of other seller's application
|
|
656
742
|
*/
|
|
657
743
|
/**
|
|
658
|
-
* @typedef
|
|
744
|
+
* @typedef TokenResponseSchema
|
|
659
745
|
* @property {Tokens} [tokens]
|
|
660
|
-
* @property {string} [_id] - The unique identifier
|
|
661
|
-
* of the token
|
|
746
|
+
* @property {string} [_id] - The unique identifier of the token
|
|
662
747
|
* @property {string} [application] - Alphanumeric ID allotted to the current
|
|
663
748
|
* application created within the current business account
|
|
664
749
|
* @property {string} [created_at] - ISO 8601 timestamp of token creation
|
|
@@ -839,6 +924,25 @@ export = ConfigurationPlatformModel;
|
|
|
839
924
|
* @property {boolean} [ask_store_address] - Shows whether a form to collect the
|
|
840
925
|
* address of the store, should be displayed upon visiting the website
|
|
841
926
|
*/
|
|
927
|
+
/**
|
|
928
|
+
* @typedef BuyboxFeature
|
|
929
|
+
* @property {boolean} [show_name] - Allow users to see seller/stores name on
|
|
930
|
+
* PDP (product detail page).
|
|
931
|
+
* @property {boolean} [enable_selection] - Allow selection of sellers/stores on
|
|
932
|
+
* PDP (product detail page).
|
|
933
|
+
* @property {boolean} [is_seller_buybox_enabled] - Toggle buybox listing
|
|
934
|
+
* between sellers and stores. True indicates seller listing, while False
|
|
935
|
+
* indicates store listing.
|
|
936
|
+
*/
|
|
937
|
+
/**
|
|
938
|
+
* @typedef DeliveryStrategy
|
|
939
|
+
* @property {string} [value] - Indicates the delivery strategy value.
|
|
940
|
+
*/
|
|
941
|
+
/**
|
|
942
|
+
* @typedef FulfillmentOption
|
|
943
|
+
* @property {number} [count] - Total count of available fulfillment options
|
|
944
|
+
* configured for a specific application.
|
|
945
|
+
*/
|
|
842
946
|
/**
|
|
843
947
|
* @typedef AppFeature
|
|
844
948
|
* @property {ProductDetailFeature} [product_detail]
|
|
@@ -850,8 +954,23 @@ export = ConfigurationPlatformModel;
|
|
|
850
954
|
* @property {QrFeature} [qr]
|
|
851
955
|
* @property {PcrFeature} [pcr]
|
|
852
956
|
* @property {OrderFeature} [order]
|
|
853
|
-
* @property {
|
|
854
|
-
*
|
|
957
|
+
* @property {SecurityFeature} [security]
|
|
958
|
+
* @property {BuyboxFeature} [buybox]
|
|
959
|
+
* @property {DeliveryStrategy} [delivery_strategy]
|
|
960
|
+
* @property {OrderingSources[]} [ordering_sources] - Represents an ordering
|
|
961
|
+
* source that can be associated with a sales channel. Ordering sources define
|
|
962
|
+
* the origin or platform from which orders are placed, enabling tracking and
|
|
963
|
+
* differentiation of orders based on their source.
|
|
964
|
+
* @property {string} [price_strategy] - Indicates whether price strategy
|
|
965
|
+
* enabled or not in an application.
|
|
966
|
+
* @property {boolean} [international] - Indicates whether internation price
|
|
967
|
+
* factory enabled or not in an application.
|
|
968
|
+
* @property {boolean} [strategy_change_pending] - Indicates whether price
|
|
969
|
+
* strategy change is pending or not in an application.
|
|
970
|
+
* @property {string} [strategy_modified_at] - ISO 8601 timestamp of last known
|
|
971
|
+
* modifications to the sales channel feature configuration
|
|
972
|
+
* @property {FulfillmentOption} [fulfillment_option]
|
|
973
|
+
* @property {string} [_id] - The unique identifier for the sales channel features
|
|
855
974
|
* @property {string} [app] - Application ID of the sales channel
|
|
856
975
|
* @property {string} [created_at] - ISO 8601 timestamp showing the date when
|
|
857
976
|
* the features were configured
|
|
@@ -954,17 +1073,28 @@ export = ConfigurationPlatformModel;
|
|
|
954
1073
|
* value is false.
|
|
955
1074
|
*/
|
|
956
1075
|
/**
|
|
957
|
-
* @typedef
|
|
1076
|
+
* @typedef SecurityFeature
|
|
1077
|
+
* @property {AllowedDomain[]} [domains] - List of allowed domains for security
|
|
1078
|
+
* restrictions.
|
|
1079
|
+
*/
|
|
1080
|
+
/**
|
|
1081
|
+
* @typedef AllowedDomain
|
|
1082
|
+
* @property {string} host - The host URL for the allowed domain.
|
|
1083
|
+
* @property {string} [url_scheme] - The protocol/scheme to use for the domain.
|
|
1084
|
+
* Default is https.
|
|
1085
|
+
*/
|
|
1086
|
+
/**
|
|
1087
|
+
* @typedef AppFeatureRequestSchema
|
|
958
1088
|
* @property {AppFeature} [feature]
|
|
959
1089
|
*/
|
|
960
1090
|
/**
|
|
961
|
-
* @typedef
|
|
1091
|
+
* @typedef AppFeatureResponseSchema
|
|
962
1092
|
* @property {AppFeature} [feature]
|
|
963
1093
|
*/
|
|
964
1094
|
/**
|
|
965
1095
|
* @typedef Currency
|
|
966
|
-
* @property {string} [_id] - The unique identifier
|
|
967
|
-
*
|
|
1096
|
+
* @property {string} [_id] - The unique identifier of the current sales channel
|
|
1097
|
+
* supported currency
|
|
968
1098
|
* @property {boolean} [is_active] - Shows currency is enabled or not in current
|
|
969
1099
|
* sales channel
|
|
970
1100
|
* @property {string} [name] - Name of the currency, e.g Indian Rupee
|
|
@@ -1026,11 +1156,9 @@ export = ConfigurationPlatformModel;
|
|
|
1026
1156
|
* @property {boolean} [is_internal] - Indicates whether a sales channel is
|
|
1027
1157
|
* internal or not
|
|
1028
1158
|
* @property {boolean} [is_active] - Indicates sales channel is active or not active
|
|
1029
|
-
* @property {string} [_id] - The unique identifier
|
|
1030
|
-
* of the sales channel
|
|
1159
|
+
* @property {string} [_id] - The unique identifier of the sales channel
|
|
1031
1160
|
* @property {string} [name] - Name of the sales channel, e.g. Zenz Fashion
|
|
1032
|
-
* @property {string} [owner] - The unique identifier
|
|
1033
|
-
* of owner who owns the application
|
|
1161
|
+
* @property {string} [owner] - The unique identifier of owner who owns the application
|
|
1034
1162
|
* @property {number} [company_id] - Numeric ID allotted to a business account
|
|
1035
1163
|
* where the sales channel exists
|
|
1036
1164
|
* @property {string} [token] - Random generated fix length string for sales
|
|
@@ -1067,11 +1195,9 @@ export = ConfigurationPlatformModel;
|
|
|
1067
1195
|
* @property {boolean} [is_internal] - Indicates whether a sales channel is
|
|
1068
1196
|
* internal or not
|
|
1069
1197
|
* @property {boolean} [is_active] - Indicates sales channel is active or not active
|
|
1070
|
-
* @property {string} [_id] - The unique identifier
|
|
1071
|
-
* of the sales channel
|
|
1198
|
+
* @property {string} [_id] - The unique identifier of the sales channel
|
|
1072
1199
|
* @property {string} [name] - Name of the sales channel, e.g. Zenz Fashion
|
|
1073
|
-
* @property {string} [owner] - The unique identifier
|
|
1074
|
-
* of owner who owns the application
|
|
1200
|
+
* @property {string} [owner] - The unique identifier of owner who owns the application
|
|
1075
1201
|
* @property {number} [company_id] - Numeric ID allotted to a business account
|
|
1076
1202
|
* where the sales channel exists
|
|
1077
1203
|
* @property {string} [token] - Random generated fix length string for sales
|
|
@@ -1107,19 +1233,20 @@ export = ConfigurationPlatformModel;
|
|
|
1107
1233
|
* @property {string} [created_at] - ISO 8601 timestamp of when token created
|
|
1108
1234
|
*/
|
|
1109
1235
|
/**
|
|
1110
|
-
* @typedef
|
|
1236
|
+
* @typedef InvalidPayloadRequestSchema
|
|
1111
1237
|
* @property {string} [message] - Error message when request body payload is improper
|
|
1112
1238
|
* @property {boolean} [success] - Flag for required not successfull.
|
|
1113
1239
|
*/
|
|
1114
1240
|
/**
|
|
1115
1241
|
* @typedef Page
|
|
1116
|
-
* @property {number} [item_total] - The total number of items
|
|
1242
|
+
* @property {number} [item_total] - The total number of all items across all pages.
|
|
1117
1243
|
* @property {string} [next_id] - The identifier for the next page.
|
|
1118
1244
|
* @property {boolean} [has_previous] - Indicates whether there is a previous page.
|
|
1119
1245
|
* @property {boolean} [has_next] - Indicates whether there is a next page.
|
|
1120
1246
|
* @property {number} [current] - The current page number.
|
|
1121
|
-
* @property {string} type - The type of the page,
|
|
1247
|
+
* @property {string} type - The type of the page, can be 'cursor' or 'number'.
|
|
1122
1248
|
* @property {number} [size] - The number of items per page.
|
|
1249
|
+
* @property {number} [page_size] - The number of items per page.
|
|
1123
1250
|
*/
|
|
1124
1251
|
/**
|
|
1125
1252
|
* @typedef ApplicationInformation
|
|
@@ -1129,8 +1256,7 @@ export = ConfigurationPlatformModel;
|
|
|
1129
1256
|
* @property {Links[]} [links]
|
|
1130
1257
|
* @property {string} [copyright_text] - Copyright statement usually seen at the
|
|
1131
1258
|
* site's footer
|
|
1132
|
-
* @property {string} [_id] - Unique identifier
|
|
1133
|
-
* the application information
|
|
1259
|
+
* @property {string} [_id] - Unique identifier of the application information
|
|
1134
1260
|
* @property {BusinessHighlights[]} [business_highlights]
|
|
1135
1261
|
* @property {string} [application] - Alphanumeric ID allotted to a sales
|
|
1136
1262
|
* channel application created within a business account
|
|
@@ -1249,8 +1375,7 @@ export = ConfigurationPlatformModel;
|
|
|
1249
1375
|
*/
|
|
1250
1376
|
/**
|
|
1251
1377
|
* @typedef BusinessHighlights
|
|
1252
|
-
* @property {string} [_id] - Unique identifier
|
|
1253
|
-
* the related business
|
|
1378
|
+
* @property {string} [_id] - Unique identifier of the related business
|
|
1254
1379
|
* @property {string} [title] - Title of the business highlight, e.g. Superfast Delivery
|
|
1255
1380
|
* @property {string} [icon] - Hosted URL of icon image representing the
|
|
1256
1381
|
* business highlight
|
|
@@ -1267,19 +1392,18 @@ export = ConfigurationPlatformModel;
|
|
|
1267
1392
|
* @property {SecureUrl} [banner]
|
|
1268
1393
|
* @property {Domain} [domain]
|
|
1269
1394
|
* @property {Domain[]} [domains]
|
|
1270
|
-
* @property {string} [_id] - The unique identifier
|
|
1271
|
-
* for the sales channel details
|
|
1395
|
+
* @property {string} [_id] - The unique identifier for the sales channel details
|
|
1272
1396
|
* @property {string} [slug]
|
|
1273
1397
|
* @property {number} [company_id]
|
|
1274
1398
|
*/
|
|
1275
1399
|
/**
|
|
1276
|
-
* @typedef
|
|
1400
|
+
* @typedef CurrenciesResponseSchema
|
|
1277
1401
|
* @property {Currency[]} [items]
|
|
1278
1402
|
*/
|
|
1279
1403
|
/**
|
|
1280
|
-
* @typedef
|
|
1281
|
-
* @property {string} [_id] - The unique identifier
|
|
1282
|
-
*
|
|
1404
|
+
* @typedef AppCurrencyResponseSchema
|
|
1405
|
+
* @property {string} [_id] - The unique identifier of the currency
|
|
1406
|
+
* configuration supported by the application
|
|
1283
1407
|
* @property {string} [application] - Alphanumeric ID allotted to an application
|
|
1284
1408
|
* (sales channel website) created within a business account
|
|
1285
1409
|
* @property {DefaultCurrency} [default_currency]
|
|
@@ -1300,7 +1424,7 @@ export = ConfigurationPlatformModel;
|
|
|
1300
1424
|
* @property {string} [address1] - Address of the opted store
|
|
1301
1425
|
* @property {StoreLatLong} [lat_long]
|
|
1302
1426
|
* @property {string} [address2] - Address of the opted store
|
|
1303
|
-
* @property {
|
|
1427
|
+
* @property {string} [pincode] - 6-digit PIN code of the opted store location
|
|
1304
1428
|
* @property {string} [country] - Country of the opted store, e.g. India
|
|
1305
1429
|
* @property {string} [city] - City of the opted store, e.g. Mumbai
|
|
1306
1430
|
* @property {string} [sector] - Sector for the opted store.
|
|
@@ -1310,15 +1434,14 @@ export = ConfigurationPlatformModel;
|
|
|
1310
1434
|
/**
|
|
1311
1435
|
* @typedef OrderingStore
|
|
1312
1436
|
* @property {OptedStoreAddress} [address]
|
|
1313
|
-
* @property {string} [_id] - The unique identifier
|
|
1314
|
-
* of the ordering store
|
|
1437
|
+
* @property {string} [_id] - The unique identifier of the ordering store
|
|
1315
1438
|
* @property {number} [uid] - Ordering store UID
|
|
1316
1439
|
* @property {string} [name] - Store name of the ordering store
|
|
1317
1440
|
* @property {string} [display_name] - Display name of the ordering store
|
|
1318
1441
|
* @property {string} [store_type] - Store type of the ordering store, e.g.
|
|
1319
1442
|
* high_street, mall, warehouse
|
|
1320
1443
|
* @property {string} [store_code] - Store code of the ordering store, e.g. MUM-102
|
|
1321
|
-
* @property {
|
|
1444
|
+
* @property {string} [pincode] - 6-digit PIN Code of the ordering store, e.g. 400001
|
|
1322
1445
|
* @property {string} [code] - Code of the ordering store (usually same as Store Code)
|
|
1323
1446
|
*/
|
|
1324
1447
|
/**
|
|
@@ -1330,26 +1453,97 @@ export = ConfigurationPlatformModel;
|
|
|
1330
1453
|
* @property {boolean} [enabled] - Allow ordering stores for current sales channel
|
|
1331
1454
|
* @property {string} [type] - For hard type delivery, store selection is
|
|
1332
1455
|
* compulsory. For soft type, delivery store selection is optional.
|
|
1333
|
-
* @property {string} [_id] - The unique identifier
|
|
1334
|
-
* of the ordering store
|
|
1456
|
+
* @property {string} [_id] - The unique identifier of the ordering store
|
|
1335
1457
|
* @property {string} [app] - Alphanumeric ID allotted to an application (sales
|
|
1336
1458
|
* channel website) created within a business account
|
|
1337
1459
|
* @property {number} [__v] - Version key for tracking ordering stores. Default
|
|
1338
1460
|
* value is zero.
|
|
1339
1461
|
*/
|
|
1340
1462
|
/**
|
|
1341
|
-
* @typedef
|
|
1463
|
+
* @typedef OrderingStoresResponseSchema
|
|
1342
1464
|
* @property {Page} [page]
|
|
1343
1465
|
* @property {OrderingStore[]} [items]
|
|
1344
1466
|
*/
|
|
1467
|
+
/**
|
|
1468
|
+
* @typedef ValidationErrors
|
|
1469
|
+
* @property {ValidationError[]} errors - A list of validation errors in the request.
|
|
1470
|
+
*/
|
|
1471
|
+
/**
|
|
1472
|
+
* @typedef ValidationError
|
|
1473
|
+
* @property {string} message - A brief description of the error encountered.
|
|
1474
|
+
* @property {string} field - The field in the request that caused the error.
|
|
1475
|
+
*/
|
|
1345
1476
|
declare class ConfigurationPlatformModel {
|
|
1346
1477
|
}
|
|
1347
1478
|
declare namespace ConfigurationPlatformModel {
|
|
1348
|
-
export { ApplicationInventory, PiiMasking, AppInventoryConfig, InventoryBrand, InventoryStore, AppStoreRules, InventoryCategory, InventoryPrice, InventoryDiscount, AuthenticationConfig, ArticleAssignmentConfig, ArticleAssignmentRules, StorePriority, AppCartConfig, InternationalDeliveryCharges, DeliveryCharges, Charges, AppPaymentConfig, CallbackUrl, Methods, PaymentModeConfig, PaymentSelectionLock, AppOrderConfig, AppLogisticsConfig, LoyaltyPointsConfig, AppInventoryPartialUpdate, BrandCompanyInfo,
|
|
1479
|
+
export { CurrencyExchangeResponseV2, CurrencyExchangeItem, ApplicationInventory, PiiMasking, ChannelCapabilities, OrderingSources, FstIdentification, SkgIdentification, QuerySuggestions, SearchConfig, AppInventoryConfig, InventoryBrand, InventoryStore, AppStoreRules, InventoryCategory, InventoryPrice, InventoryDiscount, AuthenticationConfig, ArticleAssignmentConfig, ArticleAssignmentRules, StorePriority, AppCartConfig, InternationalDeliveryCharges, DeliveryCharges, Charges, AppPaymentConfig, CallbackUrl, Methods, PaymentModeConfig, PaymentSelectionLock, AppOrderConfig, ProcessingSchedule, StartAfter, AppLogisticsConfig, LoyaltyPointsConfig, AppInventoryPartialUpdate, BrandCompanyInfo, CompanyByBrandsRequestSchema, CompanyByBrandsResponseSchema, StoreByBrandsRequestSchema, StoreByBrandsResponseSchema, BrandStoreInfo, CompanyBrandInfo, BrandsByCompanyResponseSchema, ValidationFailedResponseSchema, NotFound, CommunicationConfig, CommsConfig, PanCardConfig, CreateApplicationRequestSchema, CreateAppResponseSchema, ApplicationsResponseSchema, MobileAppConfiguration, LandingImage, SplashImage, MobileAppConfigRequestSchema, BuildVersionHistory, BuildVersion, AppSupportedCurrency, DefaultCurrency, DomainAdd, DomainAddRequestSchema, Domain, DomainsResponseSchema, UpdateDomain, UpdateDomainTypeRequestSchema, DomainStatusRequestSchema, DomainStatus, DomainStatusResponseSchema, DomainSuggestionsRequestSchema, DomainSuggestion, DomainSuggestionsResponseSchema, SuccessMessageResponseSchema, App, AppDomain, CompaniesResponseSchema, AppInventoryCompanies, StoresResponseSchema, AppInventoryStores, FilterOrderingStoreRequestSchema, DeploymentMeta, OrderingStoreConfig, OrderingStoreSelectRequestSchema, OrderingStoreSelect, OtherSellerCompany, OtherSellerApplication, OtherSellerApplications, OptedApplicationResponseSchema, OptedCompany, OptedInventory, OptType, OptedStore, OptOutInventory, TokenResponseSchema, Tokens, Firebase, Credentials, Ios, Android, Moengage, MoengageCredentials, Segment, SegmentCredentials, Gtm, GtmCredentials, Freshchat, FreshchatCredentials, Safetynet, SafetynetCredentials, FyndRewards, FyndRewardsCredentials, GoogleMap, GoogleMapCredentials, RewardPointsConfig, Credit, Debit, ProductDetailFeature, LaunchPage, LandingPageFeature, ListingPageFeature, RegistrationPageFeature, BuyboxFeature, DeliveryStrategy, FulfillmentOption, AppFeature, HomePageFeature, CommonFeature, InternationalShipping, CommunicationOptinDialogFeature, DeploymentStoreSelectionFeature, ListingPriceFeature, CurrencyFeature, RevenueEngineFeature, FeedbackFeature, CompareProductsFeature, CartFeature, QrFeature, PcrFeature, OrderFeature, SecurityFeature, AllowedDomain, AppFeatureRequestSchema, AppFeatureResponseSchema, Currency, ApplicationWebsite, ApplicationCors, ApplicationAuth, ApplicationRedirections, ApplicationMeta, SecureUrl, Application, ApplicationById, TokenSchemaID, TokenSchema, InvalidPayloadRequestSchema, Page, ApplicationInformation, InformationAddress, InformationPhone, InformationLoc, InformationSupport, InformationSupportPhone, InformationSupportEmail, SocialLinks, FacebookLink, InstagramLink, TwitterLink, PinterestLink, GooglePlusLink, YoutubeLink, LinkedInLink, VimeoLink, BlogLink, Links, BusinessHighlights, ApplicationDetail, CurrenciesResponseSchema, AppCurrencyResponseSchema, StoreLatLong, OptedStoreAddress, OrderingStore, OrderingStores, OrderingStoresResponseSchema, ValidationErrors, ValidationError };
|
|
1349
1480
|
}
|
|
1481
|
+
/** @returns {CurrencyExchangeResponseV2} */
|
|
1482
|
+
declare function CurrencyExchangeResponseV2(): CurrencyExchangeResponseV2;
|
|
1483
|
+
type CurrencyExchangeResponseV2 = {
|
|
1484
|
+
/**
|
|
1485
|
+
* - The 3-letter ISO 4217 code representing the base currency.
|
|
1486
|
+
*/
|
|
1487
|
+
base: string;
|
|
1488
|
+
/**
|
|
1489
|
+
* - The name of the base currency.
|
|
1490
|
+
*/
|
|
1491
|
+
base_currency_name: string;
|
|
1492
|
+
/**
|
|
1493
|
+
* - Time in seconds for which the exchange rates
|
|
1494
|
+
* are valid.
|
|
1495
|
+
*/
|
|
1496
|
+
ttl_seconds: number;
|
|
1497
|
+
/**
|
|
1498
|
+
* - List of exchange rates and currency details.
|
|
1499
|
+
*/
|
|
1500
|
+
items: CurrencyExchangeItem[];
|
|
1501
|
+
/**
|
|
1502
|
+
* - Total number of currency exchange items.
|
|
1503
|
+
*/
|
|
1504
|
+
total: number;
|
|
1505
|
+
};
|
|
1506
|
+
/** @returns {CurrencyExchangeItem} */
|
|
1507
|
+
declare function CurrencyExchangeItem(): CurrencyExchangeItem;
|
|
1508
|
+
type CurrencyExchangeItem = {
|
|
1509
|
+
/**
|
|
1510
|
+
* - 3-letter ISO 4217 exchange currency code.
|
|
1511
|
+
*/
|
|
1512
|
+
currency_code: string;
|
|
1513
|
+
/**
|
|
1514
|
+
* - Name of the exchange currency
|
|
1515
|
+
*/
|
|
1516
|
+
name: string;
|
|
1517
|
+
/**
|
|
1518
|
+
* - Exchange rate of the currency with respect to the
|
|
1519
|
+
* base currency.
|
|
1520
|
+
*/
|
|
1521
|
+
rate: number;
|
|
1522
|
+
/**
|
|
1523
|
+
* - ISO 3166 country code.
|
|
1524
|
+
*/
|
|
1525
|
+
country_code: string;
|
|
1526
|
+
/**
|
|
1527
|
+
* - Name of the country using this currency.
|
|
1528
|
+
*/
|
|
1529
|
+
country_name: string;
|
|
1530
|
+
/**
|
|
1531
|
+
* - The name of the subunit for the currency.
|
|
1532
|
+
*/
|
|
1533
|
+
subunit: string;
|
|
1534
|
+
/**
|
|
1535
|
+
* - Number of decimal digits the currency supports.
|
|
1536
|
+
*/
|
|
1537
|
+
decimal_digits: number;
|
|
1538
|
+
/**
|
|
1539
|
+
* - The symbol of the currency.
|
|
1540
|
+
*/
|
|
1541
|
+
symbol: string;
|
|
1542
|
+
};
|
|
1350
1543
|
/** @returns {ApplicationInventory} */
|
|
1351
1544
|
declare function ApplicationInventory(): ApplicationInventory;
|
|
1352
1545
|
type ApplicationInventory = {
|
|
1546
|
+
search?: SearchConfig;
|
|
1353
1547
|
inventory?: AppInventoryConfig;
|
|
1354
1548
|
authentication?: AuthenticationConfig;
|
|
1355
1549
|
article_assignment?: ArticleAssignmentConfig;
|
|
@@ -1359,6 +1553,7 @@ type ApplicationInventory = {
|
|
|
1359
1553
|
order?: AppOrderConfig;
|
|
1360
1554
|
logistics?: AppLogisticsConfig;
|
|
1361
1555
|
pii_masking?: PiiMasking;
|
|
1556
|
+
channel_capabilities?: ChannelCapabilities;
|
|
1362
1557
|
tags?: string[];
|
|
1363
1558
|
__v?: number;
|
|
1364
1559
|
/**
|
|
@@ -1374,8 +1569,7 @@ type ApplicationInventory = {
|
|
|
1374
1569
|
communication?: CommunicationConfig;
|
|
1375
1570
|
platforms?: string[];
|
|
1376
1571
|
/**
|
|
1377
|
-
* - The unique identifier
|
|
1378
|
-
* of the sales channel inventory
|
|
1572
|
+
* - The unique identifier of the sales channel inventory
|
|
1379
1573
|
*/
|
|
1380
1574
|
_id?: string;
|
|
1381
1575
|
loyalty_points?: LoyaltyPointsConfig;
|
|
@@ -1404,14 +1598,119 @@ declare function PiiMasking(): PiiMasking;
|
|
|
1404
1598
|
type PiiMasking = {
|
|
1405
1599
|
enabled?: boolean;
|
|
1406
1600
|
};
|
|
1601
|
+
/** @returns {ChannelCapabilities} */
|
|
1602
|
+
declare function ChannelCapabilities(): ChannelCapabilities;
|
|
1603
|
+
type ChannelCapabilities = {
|
|
1604
|
+
/**
|
|
1605
|
+
* - Commerce model types supported by the
|
|
1606
|
+
* sales channel. Defines whether the channel operates as B2C/D2C
|
|
1607
|
+
* (business-to-consumer/direct-to-consumer) or B2B (business-to-business).
|
|
1608
|
+
*/
|
|
1609
|
+
commerce_model: string[];
|
|
1610
|
+
/**
|
|
1611
|
+
* - Business format types for the sales
|
|
1612
|
+
* channel. Options include standard_commerce for traditional e-commerce,
|
|
1613
|
+
* quick_commerce for rapid delivery models, and qsr for quick service
|
|
1614
|
+
* restaurant operations.
|
|
1615
|
+
*/
|
|
1616
|
+
business_format: string[];
|
|
1617
|
+
/**
|
|
1618
|
+
* - Represents an ordering
|
|
1619
|
+
* source that can be associated with a sales channel. Ordering sources define
|
|
1620
|
+
* the origin or platform from which orders are placed, enabling tracking and
|
|
1621
|
+
* differentiation of orders based on their source.
|
|
1622
|
+
*/
|
|
1623
|
+
ordering_sources: OrderingSources[];
|
|
1624
|
+
/**
|
|
1625
|
+
* - Seller model for the sales channel.
|
|
1626
|
+
* single_seller for single seller, marketplace for multiple platforms,
|
|
1627
|
+
* cross_selling for franchise-enabled.
|
|
1628
|
+
*/
|
|
1629
|
+
seller_model?: string;
|
|
1630
|
+
};
|
|
1631
|
+
/** @returns {OrderingSources} */
|
|
1632
|
+
declare function OrderingSources(): OrderingSources;
|
|
1633
|
+
type OrderingSources = {
|
|
1634
|
+
/**
|
|
1635
|
+
* - Unique identifier slug for the ordering source. Used
|
|
1636
|
+
* to reference and identify the source programmatically.
|
|
1637
|
+
*/
|
|
1638
|
+
key: string;
|
|
1639
|
+
/**
|
|
1640
|
+
* - Human-readable display name of the ordering source.
|
|
1641
|
+
* Shown in UI for easy identification by users.
|
|
1642
|
+
*/
|
|
1643
|
+
name: string;
|
|
1644
|
+
};
|
|
1645
|
+
/** @returns {FstIdentification} */
|
|
1646
|
+
declare function FstIdentification(): FstIdentification;
|
|
1647
|
+
type FstIdentification = {
|
|
1648
|
+
/**
|
|
1649
|
+
* - Indicates whether search query interpretation
|
|
1650
|
+
* is enabled for the application.
|
|
1651
|
+
*/
|
|
1652
|
+
enabled?: boolean;
|
|
1653
|
+
};
|
|
1654
|
+
/** @returns {SkgIdentification} */
|
|
1655
|
+
declare function SkgIdentification(): SkgIdentification;
|
|
1656
|
+
type SkgIdentification = {
|
|
1657
|
+
/**
|
|
1658
|
+
* - Indicates whether semantic knowledge
|
|
1659
|
+
* graph-based search is enabled for the application.
|
|
1660
|
+
*/
|
|
1661
|
+
enabled?: boolean;
|
|
1662
|
+
};
|
|
1663
|
+
/** @returns {QuerySuggestions} */
|
|
1664
|
+
declare function QuerySuggestions(): QuerySuggestions;
|
|
1665
|
+
type QuerySuggestions = {
|
|
1666
|
+
/**
|
|
1667
|
+
* - Indicates whether to enable or disable query
|
|
1668
|
+
* suggestions powered by the GPT model using the current live catalog within
|
|
1669
|
+
* the application.
|
|
1670
|
+
*/
|
|
1671
|
+
enabled?: boolean;
|
|
1672
|
+
/**
|
|
1673
|
+
* - Specifies the maximum number of query
|
|
1674
|
+
* suggestions that can be returned.
|
|
1675
|
+
*/
|
|
1676
|
+
max_limit?: number;
|
|
1677
|
+
};
|
|
1678
|
+
/** @returns {SearchConfig} */
|
|
1679
|
+
declare function SearchConfig(): SearchConfig;
|
|
1680
|
+
type SearchConfig = {
|
|
1681
|
+
fst_identification?: FstIdentification;
|
|
1682
|
+
query_suggestions?: QuerySuggestions;
|
|
1683
|
+
skg_identification?: SkgIdentification;
|
|
1684
|
+
};
|
|
1407
1685
|
/** @returns {AppInventoryConfig} */
|
|
1408
1686
|
declare function AppInventoryConfig(): AppInventoryConfig;
|
|
1409
1687
|
type AppInventoryConfig = {
|
|
1688
|
+
delivery_strategy?: DeliveryStrategy;
|
|
1410
1689
|
brand?: InventoryBrand;
|
|
1411
1690
|
store?: InventoryStore;
|
|
1412
1691
|
category?: InventoryCategory;
|
|
1413
1692
|
price?: InventoryPrice;
|
|
1414
1693
|
discount?: InventoryDiscount;
|
|
1694
|
+
/**
|
|
1695
|
+
* - Indicates whether price strategy
|
|
1696
|
+
* enabled or not in an application.
|
|
1697
|
+
*/
|
|
1698
|
+
price_strategy?: string;
|
|
1699
|
+
/**
|
|
1700
|
+
* - Indicates whether internation price
|
|
1701
|
+
* factory enabled or not in an application.
|
|
1702
|
+
*/
|
|
1703
|
+
international?: boolean;
|
|
1704
|
+
/**
|
|
1705
|
+
* - Indicates whether price
|
|
1706
|
+
* strategy change is pending or not in an application.
|
|
1707
|
+
*/
|
|
1708
|
+
strategy_change_pending?: boolean;
|
|
1709
|
+
/**
|
|
1710
|
+
* - ISO 8601 timestamp of last known
|
|
1711
|
+
* modifications to the sales channel feature configuration
|
|
1712
|
+
*/
|
|
1713
|
+
strategy_modified_at?: string;
|
|
1415
1714
|
/**
|
|
1416
1715
|
* - Indicates whether out of stock products
|
|
1417
1716
|
* are allowed to show up on the website
|
|
@@ -1438,16 +1737,6 @@ type AppInventoryConfig = {
|
|
|
1438
1737
|
*/
|
|
1439
1738
|
company_store?: any[];
|
|
1440
1739
|
company_id?: number;
|
|
1441
|
-
/**
|
|
1442
|
-
* - Power product listing with
|
|
1443
|
-
* overlapping zones
|
|
1444
|
-
*/
|
|
1445
|
-
enable_zone_overlapping?: boolean;
|
|
1446
|
-
/**
|
|
1447
|
-
* - Give preference to popularity over
|
|
1448
|
-
* score in product listing sort
|
|
1449
|
-
*/
|
|
1450
|
-
sort_popular_first?: boolean;
|
|
1451
1740
|
};
|
|
1452
1741
|
/** @returns {InventoryBrand} */
|
|
1453
1742
|
declare function InventoryBrand(): InventoryBrand;
|
|
@@ -1599,6 +1888,16 @@ type AppCartConfig = {
|
|
|
1599
1888
|
*/
|
|
1600
1889
|
revenue_engine_coupon?: boolean;
|
|
1601
1890
|
pan_card?: PanCardConfig;
|
|
1891
|
+
/**
|
|
1892
|
+
* - If this is enabled, user can earn and
|
|
1893
|
+
* redeem loyalty points for the sales channel.
|
|
1894
|
+
*/
|
|
1895
|
+
engage_enabled?: boolean;
|
|
1896
|
+
/**
|
|
1897
|
+
* - If this is enabled, user can apply
|
|
1898
|
+
* coupons and promotions for the sales channel.
|
|
1899
|
+
*/
|
|
1900
|
+
offer_enabled?: boolean;
|
|
1602
1901
|
};
|
|
1603
1902
|
/** @returns {InternationalDeliveryCharges} */
|
|
1604
1903
|
declare function InternationalDeliveryCharges(): InternationalDeliveryCharges;
|
|
@@ -1747,6 +2046,33 @@ type AppOrderConfig = {
|
|
|
1747
2046
|
* - Reason for reassigning an order
|
|
1748
2047
|
*/
|
|
1749
2048
|
message?: string;
|
|
2049
|
+
processing_schedule?: ProcessingSchedule;
|
|
2050
|
+
};
|
|
2051
|
+
/** @returns {ProcessingSchedule} */
|
|
2052
|
+
declare function ProcessingSchedule(): ProcessingSchedule;
|
|
2053
|
+
type ProcessingSchedule = {
|
|
2054
|
+
/**
|
|
2055
|
+
* - Indicates whether the order processing
|
|
2056
|
+
* is scheduled for future.
|
|
2057
|
+
*/
|
|
2058
|
+
is_scheduled?: boolean;
|
|
2059
|
+
start_after?: StartAfter;
|
|
2060
|
+
};
|
|
2061
|
+
/** @returns {StartAfter} */
|
|
2062
|
+
declare function StartAfter(): StartAfter;
|
|
2063
|
+
type StartAfter = {
|
|
2064
|
+
/**
|
|
2065
|
+
* - Number of days to wait before starting the process.
|
|
2066
|
+
*/
|
|
2067
|
+
days?: number;
|
|
2068
|
+
/**
|
|
2069
|
+
* - Number of hours to wait before starting the process.
|
|
2070
|
+
*/
|
|
2071
|
+
hours?: number;
|
|
2072
|
+
/**
|
|
2073
|
+
* - Number of minutes to wait before starting the process.
|
|
2074
|
+
*/
|
|
2075
|
+
minutes?: number;
|
|
1750
2076
|
};
|
|
1751
2077
|
/** @returns {AppLogisticsConfig} */
|
|
1752
2078
|
declare function AppLogisticsConfig(): AppLogisticsConfig;
|
|
@@ -1771,6 +2097,7 @@ type LoyaltyPointsConfig = {
|
|
|
1771
2097
|
/** @returns {AppInventoryPartialUpdate} */
|
|
1772
2098
|
declare function AppInventoryPartialUpdate(): AppInventoryPartialUpdate;
|
|
1773
2099
|
type AppInventoryPartialUpdate = {
|
|
2100
|
+
search?: SearchConfig;
|
|
1774
2101
|
reward_points?: RewardPointsConfig;
|
|
1775
2102
|
cart?: AppCartConfig;
|
|
1776
2103
|
payment?: AppPaymentConfig;
|
|
@@ -1794,9 +2121,9 @@ type BrandCompanyInfo = {
|
|
|
1794
2121
|
*/
|
|
1795
2122
|
company_id?: number;
|
|
1796
2123
|
};
|
|
1797
|
-
/** @returns {
|
|
1798
|
-
declare function
|
|
1799
|
-
type
|
|
2124
|
+
/** @returns {CompanyByBrandsRequestSchema} */
|
|
2125
|
+
declare function CompanyByBrandsRequestSchema(): CompanyByBrandsRequestSchema;
|
|
2126
|
+
type CompanyByBrandsRequestSchema = {
|
|
1800
2127
|
/**
|
|
1801
2128
|
* - Brand UID
|
|
1802
2129
|
*/
|
|
@@ -1806,15 +2133,15 @@ type CompanyByBrandsRequest = {
|
|
|
1806
2133
|
*/
|
|
1807
2134
|
search_text?: string;
|
|
1808
2135
|
};
|
|
1809
|
-
/** @returns {
|
|
1810
|
-
declare function
|
|
1811
|
-
type
|
|
2136
|
+
/** @returns {CompanyByBrandsResponseSchema} */
|
|
2137
|
+
declare function CompanyByBrandsResponseSchema(): CompanyByBrandsResponseSchema;
|
|
2138
|
+
type CompanyByBrandsResponseSchema = {
|
|
1812
2139
|
items?: BrandCompanyInfo[];
|
|
1813
2140
|
page?: Page;
|
|
1814
2141
|
};
|
|
1815
|
-
/** @returns {
|
|
1816
|
-
declare function
|
|
1817
|
-
type
|
|
2142
|
+
/** @returns {StoreByBrandsRequestSchema} */
|
|
2143
|
+
declare function StoreByBrandsRequestSchema(): StoreByBrandsRequestSchema;
|
|
2144
|
+
type StoreByBrandsRequestSchema = {
|
|
1818
2145
|
/**
|
|
1819
2146
|
* - Current company ID for current company
|
|
1820
2147
|
* stores only. Don't send in case cross-selling (franchise) is enabled.
|
|
@@ -1829,9 +2156,9 @@ type StoreByBrandsRequest = {
|
|
|
1829
2156
|
*/
|
|
1830
2157
|
search_text?: string;
|
|
1831
2158
|
};
|
|
1832
|
-
/** @returns {
|
|
1833
|
-
declare function
|
|
1834
|
-
type
|
|
2159
|
+
/** @returns {StoreByBrandsResponseSchema} */
|
|
2160
|
+
declare function StoreByBrandsResponseSchema(): StoreByBrandsResponseSchema;
|
|
2161
|
+
type StoreByBrandsResponseSchema = {
|
|
1835
2162
|
items?: BrandStoreInfo[];
|
|
1836
2163
|
page?: Page;
|
|
1837
2164
|
};
|
|
@@ -1884,14 +2211,14 @@ type CompanyBrandInfo = {
|
|
|
1884
2211
|
*/
|
|
1885
2212
|
brand_banner_portrait_url?: string;
|
|
1886
2213
|
};
|
|
1887
|
-
/** @returns {
|
|
1888
|
-
declare function
|
|
1889
|
-
type
|
|
2214
|
+
/** @returns {BrandsByCompanyResponseSchema} */
|
|
2215
|
+
declare function BrandsByCompanyResponseSchema(): BrandsByCompanyResponseSchema;
|
|
2216
|
+
type BrandsByCompanyResponseSchema = {
|
|
1890
2217
|
brands?: CompanyBrandInfo[];
|
|
1891
2218
|
};
|
|
1892
|
-
/** @returns {
|
|
1893
|
-
declare function
|
|
1894
|
-
type
|
|
2219
|
+
/** @returns {ValidationFailedResponseSchema} */
|
|
2220
|
+
declare function ValidationFailedResponseSchema(): ValidationFailedResponseSchema;
|
|
2221
|
+
type ValidationFailedResponseSchema = {
|
|
1895
2222
|
/**
|
|
1896
2223
|
* - Response message for failed validation
|
|
1897
2224
|
*/
|
|
@@ -1942,22 +2269,22 @@ type PanCardConfig = {
|
|
|
1942
2269
|
*/
|
|
1943
2270
|
online_threshold_amount?: number;
|
|
1944
2271
|
};
|
|
1945
|
-
/** @returns {
|
|
1946
|
-
declare function
|
|
1947
|
-
type
|
|
2272
|
+
/** @returns {CreateApplicationRequestSchema} */
|
|
2273
|
+
declare function CreateApplicationRequestSchema(): CreateApplicationRequestSchema;
|
|
2274
|
+
type CreateApplicationRequestSchema = {
|
|
1948
2275
|
app?: App;
|
|
1949
2276
|
configuration?: ApplicationInventory;
|
|
1950
2277
|
domain?: AppDomain;
|
|
1951
2278
|
};
|
|
1952
|
-
/** @returns {
|
|
1953
|
-
declare function
|
|
1954
|
-
type
|
|
2279
|
+
/** @returns {CreateAppResponseSchema} */
|
|
2280
|
+
declare function CreateAppResponseSchema(): CreateAppResponseSchema;
|
|
2281
|
+
type CreateAppResponseSchema = {
|
|
1955
2282
|
app?: Application;
|
|
1956
2283
|
configuration?: ApplicationInventory;
|
|
1957
2284
|
};
|
|
1958
|
-
/** @returns {
|
|
1959
|
-
declare function
|
|
1960
|
-
type
|
|
2285
|
+
/** @returns {ApplicationsResponseSchema} */
|
|
2286
|
+
declare function ApplicationsResponseSchema(): ApplicationsResponseSchema;
|
|
2287
|
+
type ApplicationsResponseSchema = {
|
|
1961
2288
|
items?: Application[];
|
|
1962
2289
|
page?: Page;
|
|
1963
2290
|
};
|
|
@@ -1969,8 +2296,7 @@ type MobileAppConfiguration = {
|
|
|
1969
2296
|
*/
|
|
1970
2297
|
is_active?: boolean;
|
|
1971
2298
|
/**
|
|
1972
|
-
* - The unique identifier
|
|
1973
|
-
* for mobile application configuration
|
|
2299
|
+
* - The unique identifier for mobile application configuration
|
|
1974
2300
|
*/
|
|
1975
2301
|
_id?: string;
|
|
1976
2302
|
/**
|
|
@@ -2032,9 +2358,9 @@ type SplashImage = {
|
|
|
2032
2358
|
*/
|
|
2033
2359
|
secure_url?: string;
|
|
2034
2360
|
};
|
|
2035
|
-
/** @returns {
|
|
2036
|
-
declare function
|
|
2037
|
-
type
|
|
2361
|
+
/** @returns {MobileAppConfigRequestSchema} */
|
|
2362
|
+
declare function MobileAppConfigRequestSchema(): MobileAppConfigRequestSchema;
|
|
2363
|
+
type MobileAppConfigRequestSchema = {
|
|
2038
2364
|
/**
|
|
2039
2365
|
* - Name of the mobile app
|
|
2040
2366
|
*/
|
|
@@ -2060,7 +2386,7 @@ type BuildVersionHistory = {
|
|
|
2060
2386
|
declare function BuildVersion(): BuildVersion;
|
|
2061
2387
|
type BuildVersion = {
|
|
2062
2388
|
/**
|
|
2063
|
-
* -
|
|
2389
|
+
* - Primary Identifier of the build version.
|
|
2064
2390
|
*/
|
|
2065
2391
|
_id?: string;
|
|
2066
2392
|
/**
|
|
@@ -2106,8 +2432,8 @@ type BuildVersion = {
|
|
|
2106
2432
|
declare function AppSupportedCurrency(): AppSupportedCurrency;
|
|
2107
2433
|
type AppSupportedCurrency = {
|
|
2108
2434
|
/**
|
|
2109
|
-
* - The unique identifier
|
|
2110
|
-
*
|
|
2435
|
+
* - The unique identifier of the currency
|
|
2436
|
+
* configuration supported by the application
|
|
2111
2437
|
*/
|
|
2112
2438
|
_id?: string;
|
|
2113
2439
|
supported_currency?: string[];
|
|
@@ -2132,8 +2458,7 @@ type AppSupportedCurrency = {
|
|
|
2132
2458
|
declare function DefaultCurrency(): DefaultCurrency;
|
|
2133
2459
|
type DefaultCurrency = {
|
|
2134
2460
|
/**
|
|
2135
|
-
* - The unique identifier
|
|
2136
|
-
* of the default currency
|
|
2461
|
+
* - The unique identifier of the default currency
|
|
2137
2462
|
*/
|
|
2138
2463
|
ref?: string;
|
|
2139
2464
|
/**
|
|
@@ -2150,8 +2475,7 @@ type DomainAdd = {
|
|
|
2150
2475
|
*/
|
|
2151
2476
|
name?: string;
|
|
2152
2477
|
/**
|
|
2153
|
-
* - The unique identifier
|
|
2154
|
-
* of the domain
|
|
2478
|
+
* - The unique identifier of the domain
|
|
2155
2479
|
*/
|
|
2156
2480
|
_id?: string;
|
|
2157
2481
|
/**
|
|
@@ -2176,9 +2500,9 @@ type DomainAdd = {
|
|
|
2176
2500
|
message?: string;
|
|
2177
2501
|
txt_records?: string[];
|
|
2178
2502
|
};
|
|
2179
|
-
/** @returns {
|
|
2180
|
-
declare function
|
|
2181
|
-
type
|
|
2503
|
+
/** @returns {DomainAddRequestSchema} */
|
|
2504
|
+
declare function DomainAddRequestSchema(): DomainAddRequestSchema;
|
|
2505
|
+
type DomainAddRequestSchema = {
|
|
2182
2506
|
domain?: DomainAdd;
|
|
2183
2507
|
};
|
|
2184
2508
|
/** @returns {Domain} */
|
|
@@ -2189,8 +2513,7 @@ type Domain = {
|
|
|
2189
2513
|
*/
|
|
2190
2514
|
name?: string;
|
|
2191
2515
|
/**
|
|
2192
|
-
* - The unique identifier
|
|
2193
|
-
* of the sales channel domain
|
|
2516
|
+
* - The unique identifier of the sales channel domain
|
|
2194
2517
|
*/
|
|
2195
2518
|
_id?: string;
|
|
2196
2519
|
/**
|
|
@@ -2213,9 +2536,9 @@ type Domain = {
|
|
|
2213
2536
|
is_predefined?: boolean;
|
|
2214
2537
|
message?: string;
|
|
2215
2538
|
};
|
|
2216
|
-
/** @returns {
|
|
2217
|
-
declare function
|
|
2218
|
-
type
|
|
2539
|
+
/** @returns {DomainsResponseSchema} */
|
|
2540
|
+
declare function DomainsResponseSchema(): DomainsResponseSchema;
|
|
2541
|
+
type DomainsResponseSchema = {
|
|
2219
2542
|
domains?: Domain[];
|
|
2220
2543
|
};
|
|
2221
2544
|
/** @returns {UpdateDomain} */
|
|
@@ -2226,8 +2549,7 @@ type UpdateDomain = {
|
|
|
2226
2549
|
*/
|
|
2227
2550
|
name?: string;
|
|
2228
2551
|
/**
|
|
2229
|
-
* - The unique identifier
|
|
2230
|
-
* of the domain
|
|
2552
|
+
* - The unique identifier of the domain
|
|
2231
2553
|
*/
|
|
2232
2554
|
_id?: string;
|
|
2233
2555
|
/**
|
|
@@ -2246,9 +2568,9 @@ type UpdateDomain = {
|
|
|
2246
2568
|
*/
|
|
2247
2569
|
is_shortlink?: boolean;
|
|
2248
2570
|
};
|
|
2249
|
-
/** @returns {
|
|
2250
|
-
declare function
|
|
2251
|
-
type
|
|
2571
|
+
/** @returns {UpdateDomainTypeRequestSchema} */
|
|
2572
|
+
declare function UpdateDomainTypeRequestSchema(): UpdateDomainTypeRequestSchema;
|
|
2573
|
+
type UpdateDomainTypeRequestSchema = {
|
|
2252
2574
|
domain?: UpdateDomain;
|
|
2253
2575
|
/**
|
|
2254
2576
|
* - Shows domain is made primary domain for the
|
|
@@ -2256,9 +2578,9 @@ type UpdateDomainTypeRequest = {
|
|
|
2256
2578
|
*/
|
|
2257
2579
|
action?: string;
|
|
2258
2580
|
};
|
|
2259
|
-
/** @returns {
|
|
2260
|
-
declare function
|
|
2261
|
-
type
|
|
2581
|
+
/** @returns {DomainStatusRequestSchema} */
|
|
2582
|
+
declare function DomainStatusRequestSchema(): DomainStatusRequestSchema;
|
|
2583
|
+
type DomainStatusRequestSchema = {
|
|
2262
2584
|
/**
|
|
2263
2585
|
* - URL of the domain, e.g. uniket.hostx0.de
|
|
2264
2586
|
*/
|
|
@@ -2277,9 +2599,9 @@ type DomainStatus = {
|
|
|
2277
2599
|
*/
|
|
2278
2600
|
status?: boolean;
|
|
2279
2601
|
};
|
|
2280
|
-
/** @returns {
|
|
2281
|
-
declare function
|
|
2282
|
-
type
|
|
2602
|
+
/** @returns {DomainStatusResponseSchema} */
|
|
2603
|
+
declare function DomainStatusResponseSchema(): DomainStatusResponseSchema;
|
|
2604
|
+
type DomainStatusResponseSchema = {
|
|
2283
2605
|
/**
|
|
2284
2606
|
* - Check if domain is live and mapped to
|
|
2285
2607
|
* appropriate IP of Fynd Servers
|
|
@@ -2287,17 +2609,18 @@ type DomainStatusResponse = {
|
|
|
2287
2609
|
connected?: boolean;
|
|
2288
2610
|
status?: DomainStatus[];
|
|
2289
2611
|
};
|
|
2290
|
-
/** @returns {
|
|
2291
|
-
declare function
|
|
2292
|
-
type
|
|
2612
|
+
/** @returns {DomainSuggestionsRequestSchema} */
|
|
2613
|
+
declare function DomainSuggestionsRequestSchema(): DomainSuggestionsRequestSchema;
|
|
2614
|
+
type DomainSuggestionsRequestSchema = {
|
|
2293
2615
|
/**
|
|
2294
2616
|
* - Domain url
|
|
2295
2617
|
*/
|
|
2296
2618
|
domain_url?: string;
|
|
2297
2619
|
/**
|
|
2298
|
-
* - Get suggestions for custom domains or
|
|
2620
|
+
* - Get suggestions for custom domains or
|
|
2621
|
+
* Fynd domains
|
|
2299
2622
|
*/
|
|
2300
|
-
|
|
2623
|
+
custom_domain?: boolean;
|
|
2301
2624
|
};
|
|
2302
2625
|
/** @returns {DomainSuggestion} */
|
|
2303
2626
|
declare function DomainSuggestion(): DomainSuggestion;
|
|
@@ -2325,17 +2648,17 @@ type DomainSuggestion = {
|
|
|
2325
2648
|
*/
|
|
2326
2649
|
currency?: string;
|
|
2327
2650
|
};
|
|
2328
|
-
/** @returns {
|
|
2329
|
-
declare function
|
|
2330
|
-
type
|
|
2651
|
+
/** @returns {DomainSuggestionsResponseSchema} */
|
|
2652
|
+
declare function DomainSuggestionsResponseSchema(): DomainSuggestionsResponseSchema;
|
|
2653
|
+
type DomainSuggestionsResponseSchema = {
|
|
2331
2654
|
/**
|
|
2332
2655
|
* - Domain URL
|
|
2333
2656
|
*/
|
|
2334
2657
|
domains?: DomainSuggestion[];
|
|
2335
2658
|
};
|
|
2336
|
-
/** @returns {
|
|
2337
|
-
declare function
|
|
2338
|
-
type
|
|
2659
|
+
/** @returns {SuccessMessageResponseSchema} */
|
|
2660
|
+
declare function SuccessMessageResponseSchema(): SuccessMessageResponseSchema;
|
|
2661
|
+
type SuccessMessageResponseSchema = {
|
|
2339
2662
|
/**
|
|
2340
2663
|
* - Shows whether domain was deleted successfully
|
|
2341
2664
|
*/
|
|
@@ -2376,9 +2699,9 @@ type AppDomain = {
|
|
|
2376
2699
|
*/
|
|
2377
2700
|
name?: string;
|
|
2378
2701
|
};
|
|
2379
|
-
/** @returns {
|
|
2380
|
-
declare function
|
|
2381
|
-
type
|
|
2702
|
+
/** @returns {CompaniesResponseSchema} */
|
|
2703
|
+
declare function CompaniesResponseSchema(): CompaniesResponseSchema;
|
|
2704
|
+
type CompaniesResponseSchema = {
|
|
2382
2705
|
items?: AppInventoryCompanies[];
|
|
2383
2706
|
page?: Page;
|
|
2384
2707
|
};
|
|
@@ -2399,9 +2722,9 @@ type AppInventoryCompanies = {
|
|
|
2399
2722
|
*/
|
|
2400
2723
|
company_type?: string;
|
|
2401
2724
|
};
|
|
2402
|
-
/** @returns {
|
|
2403
|
-
declare function
|
|
2404
|
-
type
|
|
2725
|
+
/** @returns {StoresResponseSchema} */
|
|
2726
|
+
declare function StoresResponseSchema(): StoresResponseSchema;
|
|
2727
|
+
type StoresResponseSchema = {
|
|
2405
2728
|
items?: AppInventoryStores[];
|
|
2406
2729
|
page?: Page;
|
|
2407
2730
|
};
|
|
@@ -2409,8 +2732,8 @@ type StoresResponse = {
|
|
|
2409
2732
|
declare function AppInventoryStores(): AppInventoryStores;
|
|
2410
2733
|
type AppInventoryStores = {
|
|
2411
2734
|
/**
|
|
2412
|
-
* - The unique identifier of the store
|
|
2413
|
-
*
|
|
2735
|
+
* - The unique identifier of the store in the sales
|
|
2736
|
+
* channel inventory
|
|
2414
2737
|
*/
|
|
2415
2738
|
_id?: string;
|
|
2416
2739
|
/**
|
|
@@ -2450,9 +2773,9 @@ type AppInventoryStores = {
|
|
|
2450
2773
|
address?: any;
|
|
2451
2774
|
integration_type?: any;
|
|
2452
2775
|
};
|
|
2453
|
-
/** @returns {
|
|
2454
|
-
declare function
|
|
2455
|
-
type
|
|
2776
|
+
/** @returns {FilterOrderingStoreRequestSchema} */
|
|
2777
|
+
declare function FilterOrderingStoreRequestSchema(): FilterOrderingStoreRequestSchema;
|
|
2778
|
+
type FilterOrderingStoreRequestSchema = {
|
|
2456
2779
|
/**
|
|
2457
2780
|
* - Allow all stores from the ordering stores
|
|
2458
2781
|
*/
|
|
@@ -2482,8 +2805,7 @@ type DeploymentMeta = {
|
|
|
2482
2805
|
*/
|
|
2483
2806
|
type?: string;
|
|
2484
2807
|
/**
|
|
2485
|
-
* - The unique identifier
|
|
2486
|
-
* of the ordering stores
|
|
2808
|
+
* - The unique identifier of the ordering stores
|
|
2487
2809
|
*/
|
|
2488
2810
|
_id?: string;
|
|
2489
2811
|
/**
|
|
@@ -2498,9 +2820,9 @@ declare function OrderingStoreConfig(): OrderingStoreConfig;
|
|
|
2498
2820
|
type OrderingStoreConfig = {
|
|
2499
2821
|
deployment_meta?: DeploymentMeta;
|
|
2500
2822
|
};
|
|
2501
|
-
/** @returns {
|
|
2502
|
-
declare function
|
|
2503
|
-
type
|
|
2823
|
+
/** @returns {OrderingStoreSelectRequestSchema} */
|
|
2824
|
+
declare function OrderingStoreSelectRequestSchema(): OrderingStoreSelectRequestSchema;
|
|
2825
|
+
type OrderingStoreSelectRequestSchema = {
|
|
2504
2826
|
ordering_store: OrderingStoreSelect;
|
|
2505
2827
|
};
|
|
2506
2828
|
/** @returns {OrderingStoreSelect} */
|
|
@@ -2535,8 +2857,7 @@ type OtherSellerApplication = {
|
|
|
2535
2857
|
*/
|
|
2536
2858
|
description?: string;
|
|
2537
2859
|
/**
|
|
2538
|
-
* - The unique identifier
|
|
2539
|
-
* of the other seller's sales channel
|
|
2860
|
+
* - The unique identifier of the other seller's sales channel
|
|
2540
2861
|
*/
|
|
2541
2862
|
_id?: string;
|
|
2542
2863
|
/**
|
|
@@ -2556,9 +2877,9 @@ type OtherSellerApplications = {
|
|
|
2556
2877
|
items?: OtherSellerApplication[];
|
|
2557
2878
|
page?: Page;
|
|
2558
2879
|
};
|
|
2559
|
-
/** @returns {
|
|
2560
|
-
declare function
|
|
2561
|
-
type
|
|
2880
|
+
/** @returns {OptedApplicationResponseSchema} */
|
|
2881
|
+
declare function OptedApplicationResponseSchema(): OptedApplicationResponseSchema;
|
|
2882
|
+
type OptedApplicationResponseSchema = {
|
|
2562
2883
|
/**
|
|
2563
2884
|
* - Name of the other seller's sales channel
|
|
2564
2885
|
*/
|
|
@@ -2568,8 +2889,7 @@ type OptedApplicationResponse = {
|
|
|
2568
2889
|
*/
|
|
2569
2890
|
description?: string;
|
|
2570
2891
|
/**
|
|
2571
|
-
* - The unique identifier
|
|
2572
|
-
* of the other seller's sales channel
|
|
2892
|
+
* - The unique identifier of the other seller's sales channel
|
|
2573
2893
|
*/
|
|
2574
2894
|
_id?: string;
|
|
2575
2895
|
/**
|
|
@@ -2670,13 +2990,12 @@ type OptOutInventory = {
|
|
|
2670
2990
|
*/
|
|
2671
2991
|
company: number[];
|
|
2672
2992
|
};
|
|
2673
|
-
/** @returns {
|
|
2674
|
-
declare function
|
|
2675
|
-
type
|
|
2993
|
+
/** @returns {TokenResponseSchema} */
|
|
2994
|
+
declare function TokenResponseSchema(): TokenResponseSchema;
|
|
2995
|
+
type TokenResponseSchema = {
|
|
2676
2996
|
tokens?: Tokens;
|
|
2677
2997
|
/**
|
|
2678
|
-
* - The unique identifier
|
|
2679
|
-
* of the token
|
|
2998
|
+
* - The unique identifier of the token
|
|
2680
2999
|
*/
|
|
2681
3000
|
_id?: string;
|
|
2682
3001
|
/**
|
|
@@ -3021,6 +3340,43 @@ type RegistrationPageFeature = {
|
|
|
3021
3340
|
*/
|
|
3022
3341
|
ask_store_address?: boolean;
|
|
3023
3342
|
};
|
|
3343
|
+
/** @returns {BuyboxFeature} */
|
|
3344
|
+
declare function BuyboxFeature(): BuyboxFeature;
|
|
3345
|
+
type BuyboxFeature = {
|
|
3346
|
+
/**
|
|
3347
|
+
* - Allow users to see seller/stores name on
|
|
3348
|
+
* PDP (product detail page).
|
|
3349
|
+
*/
|
|
3350
|
+
show_name?: boolean;
|
|
3351
|
+
/**
|
|
3352
|
+
* - Allow selection of sellers/stores on
|
|
3353
|
+
* PDP (product detail page).
|
|
3354
|
+
*/
|
|
3355
|
+
enable_selection?: boolean;
|
|
3356
|
+
/**
|
|
3357
|
+
* - Toggle buybox listing
|
|
3358
|
+
* between sellers and stores. True indicates seller listing, while False
|
|
3359
|
+
* indicates store listing.
|
|
3360
|
+
*/
|
|
3361
|
+
is_seller_buybox_enabled?: boolean;
|
|
3362
|
+
};
|
|
3363
|
+
/** @returns {DeliveryStrategy} */
|
|
3364
|
+
declare function DeliveryStrategy(): DeliveryStrategy;
|
|
3365
|
+
type DeliveryStrategy = {
|
|
3366
|
+
/**
|
|
3367
|
+
* - Indicates the delivery strategy value.
|
|
3368
|
+
*/
|
|
3369
|
+
value?: string;
|
|
3370
|
+
};
|
|
3371
|
+
/** @returns {FulfillmentOption} */
|
|
3372
|
+
declare function FulfillmentOption(): FulfillmentOption;
|
|
3373
|
+
type FulfillmentOption = {
|
|
3374
|
+
/**
|
|
3375
|
+
* - Total count of available fulfillment options
|
|
3376
|
+
* configured for a specific application.
|
|
3377
|
+
*/
|
|
3378
|
+
count?: number;
|
|
3379
|
+
};
|
|
3024
3380
|
/** @returns {AppFeature} */
|
|
3025
3381
|
declare function AppFeature(): AppFeature;
|
|
3026
3382
|
type AppFeature = {
|
|
@@ -3033,9 +3389,39 @@ type AppFeature = {
|
|
|
3033
3389
|
qr?: QrFeature;
|
|
3034
3390
|
pcr?: PcrFeature;
|
|
3035
3391
|
order?: OrderFeature;
|
|
3392
|
+
security?: SecurityFeature;
|
|
3393
|
+
buybox?: BuyboxFeature;
|
|
3394
|
+
delivery_strategy?: DeliveryStrategy;
|
|
3395
|
+
/**
|
|
3396
|
+
* - Represents an ordering
|
|
3397
|
+
* source that can be associated with a sales channel. Ordering sources define
|
|
3398
|
+
* the origin or platform from which orders are placed, enabling tracking and
|
|
3399
|
+
* differentiation of orders based on their source.
|
|
3400
|
+
*/
|
|
3401
|
+
ordering_sources?: OrderingSources[];
|
|
3402
|
+
/**
|
|
3403
|
+
* - Indicates whether price strategy
|
|
3404
|
+
* enabled or not in an application.
|
|
3405
|
+
*/
|
|
3406
|
+
price_strategy?: string;
|
|
3407
|
+
/**
|
|
3408
|
+
* - Indicates whether internation price
|
|
3409
|
+
* factory enabled or not in an application.
|
|
3410
|
+
*/
|
|
3411
|
+
international?: boolean;
|
|
3412
|
+
/**
|
|
3413
|
+
* - Indicates whether price
|
|
3414
|
+
* strategy change is pending or not in an application.
|
|
3415
|
+
*/
|
|
3416
|
+
strategy_change_pending?: boolean;
|
|
3417
|
+
/**
|
|
3418
|
+
* - ISO 8601 timestamp of last known
|
|
3419
|
+
* modifications to the sales channel feature configuration
|
|
3420
|
+
*/
|
|
3421
|
+
strategy_modified_at?: string;
|
|
3422
|
+
fulfillment_option?: FulfillmentOption;
|
|
3036
3423
|
/**
|
|
3037
|
-
* - The unique identifier
|
|
3038
|
-
* for the sales channel features
|
|
3424
|
+
* - The unique identifier for the sales channel features
|
|
3039
3425
|
*/
|
|
3040
3426
|
_id?: string;
|
|
3041
3427
|
/**
|
|
@@ -3234,22 +3620,44 @@ type OrderFeature = {
|
|
|
3234
3620
|
*/
|
|
3235
3621
|
buy_again?: boolean;
|
|
3236
3622
|
};
|
|
3237
|
-
/** @returns {
|
|
3238
|
-
declare function
|
|
3239
|
-
type
|
|
3623
|
+
/** @returns {SecurityFeature} */
|
|
3624
|
+
declare function SecurityFeature(): SecurityFeature;
|
|
3625
|
+
type SecurityFeature = {
|
|
3626
|
+
/**
|
|
3627
|
+
* - List of allowed domains for security
|
|
3628
|
+
* restrictions.
|
|
3629
|
+
*/
|
|
3630
|
+
domains?: AllowedDomain[];
|
|
3631
|
+
};
|
|
3632
|
+
/** @returns {AllowedDomain} */
|
|
3633
|
+
declare function AllowedDomain(): AllowedDomain;
|
|
3634
|
+
type AllowedDomain = {
|
|
3635
|
+
/**
|
|
3636
|
+
* - The host URL for the allowed domain.
|
|
3637
|
+
*/
|
|
3638
|
+
host: string;
|
|
3639
|
+
/**
|
|
3640
|
+
* - The protocol/scheme to use for the domain.
|
|
3641
|
+
* Default is https.
|
|
3642
|
+
*/
|
|
3643
|
+
url_scheme?: string;
|
|
3644
|
+
};
|
|
3645
|
+
/** @returns {AppFeatureRequestSchema} */
|
|
3646
|
+
declare function AppFeatureRequestSchema(): AppFeatureRequestSchema;
|
|
3647
|
+
type AppFeatureRequestSchema = {
|
|
3240
3648
|
feature?: AppFeature;
|
|
3241
3649
|
};
|
|
3242
|
-
/** @returns {
|
|
3243
|
-
declare function
|
|
3244
|
-
type
|
|
3650
|
+
/** @returns {AppFeatureResponseSchema} */
|
|
3651
|
+
declare function AppFeatureResponseSchema(): AppFeatureResponseSchema;
|
|
3652
|
+
type AppFeatureResponseSchema = {
|
|
3245
3653
|
feature?: AppFeature;
|
|
3246
3654
|
};
|
|
3247
3655
|
/** @returns {Currency} */
|
|
3248
3656
|
declare function Currency(): Currency;
|
|
3249
3657
|
type Currency = {
|
|
3250
3658
|
/**
|
|
3251
|
-
* - The unique identifier
|
|
3252
|
-
*
|
|
3659
|
+
* - The unique identifier of the current sales channel
|
|
3660
|
+
* supported currency
|
|
3253
3661
|
*/
|
|
3254
3662
|
_id?: string;
|
|
3255
3663
|
/**
|
|
@@ -3384,8 +3792,7 @@ type Application = {
|
|
|
3384
3792
|
*/
|
|
3385
3793
|
is_active?: boolean;
|
|
3386
3794
|
/**
|
|
3387
|
-
* - The unique identifier
|
|
3388
|
-
* of the sales channel
|
|
3795
|
+
* - The unique identifier of the sales channel
|
|
3389
3796
|
*/
|
|
3390
3797
|
_id?: string;
|
|
3391
3798
|
/**
|
|
@@ -3393,8 +3800,7 @@ type Application = {
|
|
|
3393
3800
|
*/
|
|
3394
3801
|
name?: string;
|
|
3395
3802
|
/**
|
|
3396
|
-
* - The unique identifier
|
|
3397
|
-
* of owner who owns the application
|
|
3803
|
+
* - The unique identifier of owner who owns the application
|
|
3398
3804
|
*/
|
|
3399
3805
|
owner?: string;
|
|
3400
3806
|
/**
|
|
@@ -3468,8 +3874,7 @@ type ApplicationById = {
|
|
|
3468
3874
|
*/
|
|
3469
3875
|
is_active?: boolean;
|
|
3470
3876
|
/**
|
|
3471
|
-
* - The unique identifier
|
|
3472
|
-
* of the sales channel
|
|
3877
|
+
* - The unique identifier of the sales channel
|
|
3473
3878
|
*/
|
|
3474
3879
|
_id?: string;
|
|
3475
3880
|
/**
|
|
@@ -3477,8 +3882,7 @@ type ApplicationById = {
|
|
|
3477
3882
|
*/
|
|
3478
3883
|
name?: string;
|
|
3479
3884
|
/**
|
|
3480
|
-
* - The unique identifier
|
|
3481
|
-
* of owner who owns the application
|
|
3885
|
+
* - The unique identifier of owner who owns the application
|
|
3482
3886
|
*/
|
|
3483
3887
|
owner?: string;
|
|
3484
3888
|
/**
|
|
@@ -3541,9 +3945,9 @@ type TokenSchema = {
|
|
|
3541
3945
|
*/
|
|
3542
3946
|
created_at?: string;
|
|
3543
3947
|
};
|
|
3544
|
-
/** @returns {
|
|
3545
|
-
declare function
|
|
3546
|
-
type
|
|
3948
|
+
/** @returns {InvalidPayloadRequestSchema} */
|
|
3949
|
+
declare function InvalidPayloadRequestSchema(): InvalidPayloadRequestSchema;
|
|
3950
|
+
type InvalidPayloadRequestSchema = {
|
|
3547
3951
|
/**
|
|
3548
3952
|
* - Error message when request body payload is improper
|
|
3549
3953
|
*/
|
|
@@ -3557,7 +3961,7 @@ type InvalidPayloadRequest = {
|
|
|
3557
3961
|
declare function Page(): Page;
|
|
3558
3962
|
type Page = {
|
|
3559
3963
|
/**
|
|
3560
|
-
* - The total number of items
|
|
3964
|
+
* - The total number of all items across all pages.
|
|
3561
3965
|
*/
|
|
3562
3966
|
item_total?: number;
|
|
3563
3967
|
/**
|
|
@@ -3577,13 +3981,17 @@ type Page = {
|
|
|
3577
3981
|
*/
|
|
3578
3982
|
current?: number;
|
|
3579
3983
|
/**
|
|
3580
|
-
* - The type of the page,
|
|
3984
|
+
* - The type of the page, can be 'cursor' or 'number'.
|
|
3581
3985
|
*/
|
|
3582
3986
|
type: string;
|
|
3583
3987
|
/**
|
|
3584
3988
|
* - The number of items per page.
|
|
3585
3989
|
*/
|
|
3586
3990
|
size?: number;
|
|
3991
|
+
/**
|
|
3992
|
+
* - The number of items per page.
|
|
3993
|
+
*/
|
|
3994
|
+
page_size?: number;
|
|
3587
3995
|
};
|
|
3588
3996
|
/** @returns {ApplicationInformation} */
|
|
3589
3997
|
declare function ApplicationInformation(): ApplicationInformation;
|
|
@@ -3598,8 +4006,7 @@ type ApplicationInformation = {
|
|
|
3598
4006
|
*/
|
|
3599
4007
|
copyright_text?: string;
|
|
3600
4008
|
/**
|
|
3601
|
-
* - Unique identifier
|
|
3602
|
-
* the application information
|
|
4009
|
+
* - Unique identifier of the application information
|
|
3603
4010
|
*/
|
|
3604
4011
|
_id?: string;
|
|
3605
4012
|
business_highlights?: BusinessHighlights[];
|
|
@@ -3874,8 +4281,7 @@ type Links = {
|
|
|
3874
4281
|
declare function BusinessHighlights(): BusinessHighlights;
|
|
3875
4282
|
type BusinessHighlights = {
|
|
3876
4283
|
/**
|
|
3877
|
-
* - Unique identifier
|
|
3878
|
-
* the related business
|
|
4284
|
+
* - Unique identifier of the related business
|
|
3879
4285
|
*/
|
|
3880
4286
|
_id?: string;
|
|
3881
4287
|
/**
|
|
@@ -3911,24 +4317,23 @@ type ApplicationDetail = {
|
|
|
3911
4317
|
domain?: Domain;
|
|
3912
4318
|
domains?: Domain[];
|
|
3913
4319
|
/**
|
|
3914
|
-
* - The unique identifier
|
|
3915
|
-
* for the sales channel details
|
|
4320
|
+
* - The unique identifier for the sales channel details
|
|
3916
4321
|
*/
|
|
3917
4322
|
_id?: string;
|
|
3918
4323
|
slug?: string;
|
|
3919
4324
|
company_id?: number;
|
|
3920
4325
|
};
|
|
3921
|
-
/** @returns {
|
|
3922
|
-
declare function
|
|
3923
|
-
type
|
|
4326
|
+
/** @returns {CurrenciesResponseSchema} */
|
|
4327
|
+
declare function CurrenciesResponseSchema(): CurrenciesResponseSchema;
|
|
4328
|
+
type CurrenciesResponseSchema = {
|
|
3924
4329
|
items?: Currency[];
|
|
3925
4330
|
};
|
|
3926
|
-
/** @returns {
|
|
3927
|
-
declare function
|
|
3928
|
-
type
|
|
4331
|
+
/** @returns {AppCurrencyResponseSchema} */
|
|
4332
|
+
declare function AppCurrencyResponseSchema(): AppCurrencyResponseSchema;
|
|
4333
|
+
type AppCurrencyResponseSchema = {
|
|
3929
4334
|
/**
|
|
3930
|
-
* - The unique identifier
|
|
3931
|
-
*
|
|
4335
|
+
* - The unique identifier of the currency
|
|
4336
|
+
* configuration supported by the application
|
|
3932
4337
|
*/
|
|
3933
4338
|
_id?: string;
|
|
3934
4339
|
/**
|
|
@@ -3977,7 +4382,7 @@ type OptedStoreAddress = {
|
|
|
3977
4382
|
/**
|
|
3978
4383
|
* - 6-digit PIN code of the opted store location
|
|
3979
4384
|
*/
|
|
3980
|
-
pincode?:
|
|
4385
|
+
pincode?: string;
|
|
3981
4386
|
/**
|
|
3982
4387
|
* - Country of the opted store, e.g. India
|
|
3983
4388
|
*/
|
|
@@ -4004,8 +4409,7 @@ declare function OrderingStore(): OrderingStore;
|
|
|
4004
4409
|
type OrderingStore = {
|
|
4005
4410
|
address?: OptedStoreAddress;
|
|
4006
4411
|
/**
|
|
4007
|
-
* - The unique identifier
|
|
4008
|
-
* of the ordering store
|
|
4412
|
+
* - The unique identifier of the ordering store
|
|
4009
4413
|
*/
|
|
4010
4414
|
_id?: string;
|
|
4011
4415
|
/**
|
|
@@ -4032,7 +4436,7 @@ type OrderingStore = {
|
|
|
4032
4436
|
/**
|
|
4033
4437
|
* - 6-digit PIN Code of the ordering store, e.g. 400001
|
|
4034
4438
|
*/
|
|
4035
|
-
pincode?:
|
|
4439
|
+
pincode?: string;
|
|
4036
4440
|
/**
|
|
4037
4441
|
* - Code of the ordering store (usually same as Store Code)
|
|
4038
4442
|
*/
|
|
@@ -4058,8 +4462,7 @@ type OrderingStores = {
|
|
|
4058
4462
|
*/
|
|
4059
4463
|
type?: string;
|
|
4060
4464
|
/**
|
|
4061
|
-
* - The unique identifier
|
|
4062
|
-
* of the ordering store
|
|
4465
|
+
* - The unique identifier of the ordering store
|
|
4063
4466
|
*/
|
|
4064
4467
|
_id?: string;
|
|
4065
4468
|
/**
|
|
@@ -4073,9 +4476,29 @@ type OrderingStores = {
|
|
|
4073
4476
|
*/
|
|
4074
4477
|
__v?: number;
|
|
4075
4478
|
};
|
|
4076
|
-
/** @returns {
|
|
4077
|
-
declare function
|
|
4078
|
-
type
|
|
4479
|
+
/** @returns {OrderingStoresResponseSchema} */
|
|
4480
|
+
declare function OrderingStoresResponseSchema(): OrderingStoresResponseSchema;
|
|
4481
|
+
type OrderingStoresResponseSchema = {
|
|
4079
4482
|
page?: Page;
|
|
4080
4483
|
items?: OrderingStore[];
|
|
4081
4484
|
};
|
|
4485
|
+
/** @returns {ValidationErrors} */
|
|
4486
|
+
declare function ValidationErrors(): ValidationErrors;
|
|
4487
|
+
type ValidationErrors = {
|
|
4488
|
+
/**
|
|
4489
|
+
* - A list of validation errors in the request.
|
|
4490
|
+
*/
|
|
4491
|
+
errors: ValidationError[];
|
|
4492
|
+
};
|
|
4493
|
+
/** @returns {ValidationError} */
|
|
4494
|
+
declare function ValidationError(): ValidationError;
|
|
4495
|
+
type ValidationError = {
|
|
4496
|
+
/**
|
|
4497
|
+
* - A brief description of the error encountered.
|
|
4498
|
+
*/
|
|
4499
|
+
message: string;
|
|
4500
|
+
/**
|
|
4501
|
+
* - The field in the request that caused the error.
|
|
4502
|
+
*/
|
|
4503
|
+
field: string;
|
|
4504
|
+
};
|