@gofynd/fdk-client-javascript 1.4.15-beta.3 → 1.4.15-beta.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/ApplicationClient.d.ts +0 -2
- package/sdk/application/ApplicationClient.js +0 -2
- package/sdk/application/Cart/CartApplicationClient.d.ts +48 -68
- package/sdk/application/Cart/CartApplicationClient.js +304 -114
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +58 -59
- package/sdk/application/Catalog/CatalogApplicationClient.js +437 -30
- package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
- package/sdk/application/Common/CommonApplicationClient.js +22 -1
- package/sdk/application/Communication/CommunicationApplicationClient.js +29 -0
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +20 -20
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +157 -10
- package/sdk/application/Content/ContentApplicationClient.d.ts +30 -19
- package/sdk/application/Content/ContentApplicationClient.js +297 -28
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +8 -8
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +50 -7
- package/sdk/application/Lead/LeadApplicationClient.d.ts +2 -2
- package/sdk/application/Lead/LeadApplicationClient.js +74 -1
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +15 -35
- package/sdk/application/Logistic/LogisticApplicationClient.js +159 -87
- package/sdk/application/Order/OrderApplicationClient.d.ts +12 -22
- package/sdk/application/Order/OrderApplicationClient.js +195 -47
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +87 -87
- package/sdk/application/Payment/PaymentApplicationClient.js +473 -46
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -13
- package/sdk/application/Rewards/RewardsApplicationClient.js +75 -7
- package/sdk/application/Share/ShareApplicationClient.js +96 -0
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +2 -2
- package/sdk/application/Theme/ThemeApplicationClient.js +66 -4
- package/sdk/application/User/UserApplicationClient.d.ts +10 -10
- package/sdk/application/User/UserApplicationClient.js +418 -6
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +16 -3
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +12 -86
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +24 -582
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +19 -116
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +14 -121
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +1 -8
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +4 -51
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +2 -2
- package/sdk/partner/Lead/LeadPartnerClient.js +2 -2
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerModel.js +15 -15
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +20 -126
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +20 -970
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +167 -1200
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +160 -571
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +0 -10
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +7 -121
- package/sdk/partner/OAuthClient.js +1 -0
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +10 -8
- package/sdk/partner/Theme/ThemePartnerClient.js +16 -14
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +39 -135
- package/sdk/partner/Theme/ThemePartnerModel.js +38 -114
- package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -28
- package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -103
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +179 -612
- package/sdk/partner/Webhook/WebhookPartnerModel.js +150 -253
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +0 -1
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -11
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +4 -5
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +8 -14
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +9 -59
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +4 -40
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +32 -2
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +243 -3
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +130 -11
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +152 -12
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +39 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +35 -0
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
- package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +388 -443
- package/sdk/platform/Billing/BillingPlatformModel.js +263 -280
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +18 -16
- package/sdk/platform/Billing/BillingPlatformValidator.js +9 -8
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +103 -134
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +115 -419
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +65 -118
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +44 -109
- package/sdk/platform/Cart/CartPlatformModel.d.ts +1298 -5037
- package/sdk/platform/Cart/CartPlatformModel.js +1217 -1976
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +183 -209
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +400 -457
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +142 -185
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +78 -96
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +117 -154
- package/sdk/platform/Catalog/CatalogPlatformClient.js +172 -292
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +1647 -6385
- package/sdk/platform/Catalog/CatalogPlatformModel.js +1680 -3217
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +31 -72
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +24 -50
- package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -3
- package/sdk/platform/Common/CommonPlatformClient.js +2 -3
- package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
- package/sdk/platform/Common/CommonPlatformModel.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +17 -16
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +17 -16
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +8 -8
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +8 -8
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +33 -43
- package/sdk/platform/Communication/CommunicationPlatformModel.js +34 -38
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +42 -46
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +43 -47
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +223 -223
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +212 -210
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +33 -46
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +54 -67
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +24 -45
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +30 -134
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +131 -283
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +97 -219
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +9 -37
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +8 -27
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +141 -124
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +422 -449
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +141 -179
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +130 -168
- package/sdk/platform/Content/ContentPlatformClient.d.ts +106 -142
- package/sdk/platform/Content/ContentPlatformClient.js +336 -523
- package/sdk/platform/Content/ContentPlatformModel.d.ts +395 -1241
- package/sdk/platform/Content/ContentPlatformModel.js +390 -521
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +117 -168
- package/sdk/platform/Content/ContentPlatformValidator.js +108 -162
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +12 -14
- package/sdk/platform/Discount/DiscountPlatformClient.js +12 -14
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +13 -13
- package/sdk/platform/Discount/DiscountPlatformModel.js +12 -12
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +36 -94
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +60 -462
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +15 -62
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +13 -75
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +19 -19
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +21 -21
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +101 -370
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +84 -313
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +320 -0
- package/sdk/platform/Finance/FinancePlatformClient.js +2333 -0
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +2890 -0
- package/sdk/platform/Finance/FinancePlatformModel.js +2148 -0
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +284 -0
- package/sdk/platform/Finance/FinancePlatformValidator.js +354 -0
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +2 -2
- package/sdk/platform/Lead/LeadPlatformClient.js +2 -2
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +5 -5
- package/sdk/platform/Lead/LeadPlatformModel.js +16 -16
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +6 -17
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +7 -85
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +24 -95
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +19 -39
- package/sdk/platform/Order/OrderPlatformClient.d.ts +96 -153
- package/sdk/platform/Order/OrderPlatformClient.js +198 -416
- package/sdk/platform/Order/OrderPlatformModel.d.ts +1286 -7619
- package/sdk/platform/Order/OrderPlatformModel.js +1265 -3922
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +109 -270
- package/sdk/platform/Order/OrderPlatformValidator.js +77 -135
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +7 -9
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
- package/sdk/platform/Partner/PartnerPlatformModel.js +8 -8
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +105 -93
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +141 -129
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +48 -48
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +48 -48
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
- package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +319 -333
- package/sdk/platform/Payment/PaymentPlatformModel.js +278 -288
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
- package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
- package/sdk/platform/PlatformClient.d.ts +2 -0
- package/sdk/platform/PlatformClient.js +4 -0
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +9 -9
- package/sdk/platform/Rewards/RewardsPlatformModel.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +36 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +41 -132
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +17 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +14 -34
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +46 -40
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +64 -58
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +612 -1845
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +554 -886
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +46 -42
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +28 -26
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.js +2 -2
- package/sdk/platform/Share/SharePlatformModel.d.ts +5 -36
- package/sdk/platform/Share/SharePlatformModel.js +4 -27
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +4 -8
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +0 -5
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +0 -2
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +13 -76
- package/sdk/platform/Theme/ThemePlatformModel.js +17 -57
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/User/UserPlatformApplicationClient.js +12 -12
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/User/UserPlatformApplicationValidator.js +2 -2
- package/sdk/platform/User/UserPlatformModel.d.ts +21 -21
- package/sdk/platform/User/UserPlatformModel.js +23 -23
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +78 -25
- package/sdk/platform/Webhook/WebhookPlatformClient.js +470 -75
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +427 -720
- package/sdk/platform/Webhook/WebhookPlatformModel.js +386 -410
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +55 -10
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +72 -12
- package/sdk/platform/index.d.ts +1 -0
- package/sdk/platform/index.js +2 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -3
- package/sdk/public/Configuration/ConfigurationPublicClient.js +21 -6
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +9 -9
- package/sdk/public/Configuration/ConfigurationPublicModel.js +6 -6
- package/sdk/public/Content/ContentPublicClient.d.ts +2 -112
- package/sdk/public/Content/ContentPublicClient.js +20 -791
- package/sdk/public/Content/ContentPublicModel.d.ts +3 -549
- package/sdk/public/Content/ContentPublicModel.js +3 -649
- package/sdk/public/Content/ContentPublicValidator.d.ts +3 -69
- package/sdk/public/Content/ContentPublicValidator.js +2 -88
- package/sdk/public/Partner/PartnerPublicClient.js +15 -0
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +48 -8
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +21 -21
- package/sdk/public/Webhook/WebhookPublicModel.js +15 -15
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +0 -29
- package/sdk/application/Finance/FinanceApplicationClient.js +0 -105
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
export = ServiceabilityPlatformModel;
|
|
2
2
|
/**
|
|
3
|
-
* @typedef
|
|
3
|
+
* @typedef UpdateZoneConfigRequest
|
|
4
4
|
* @property {string} [serviceability_type]
|
|
5
5
|
*/
|
|
6
6
|
/**
|
|
7
|
-
* @typedef
|
|
7
|
+
* @typedef ServiceabilityErrorResponse
|
|
8
8
|
* @property {string} message
|
|
9
9
|
* @property {string} value
|
|
10
10
|
* @property {string} type
|
|
@@ -16,13 +16,13 @@ export = ServiceabilityPlatformModel;
|
|
|
16
16
|
* @property {string} channel_type
|
|
17
17
|
*/
|
|
18
18
|
/**
|
|
19
|
-
* @typedef
|
|
20
|
-
* @property {
|
|
19
|
+
* @typedef ApplicationServiceabilityConfigResponse
|
|
20
|
+
* @property {ServiceabilityErrorResponse} [error]
|
|
21
21
|
* @property {ApplicationServiceabilityConfig} [data]
|
|
22
22
|
* @property {boolean} success
|
|
23
23
|
*/
|
|
24
24
|
/**
|
|
25
|
-
* @typedef
|
|
25
|
+
* @typedef EntityRegionView_Request
|
|
26
26
|
* @property {string[]} sub_type
|
|
27
27
|
* @property {string[]} [parent_id]
|
|
28
28
|
*/
|
|
@@ -41,7 +41,7 @@ export = ServiceabilityPlatformModel;
|
|
|
41
41
|
* @property {number} current
|
|
42
42
|
*/
|
|
43
43
|
/**
|
|
44
|
-
* @typedef
|
|
44
|
+
* @typedef getAppRegionZonesResponse
|
|
45
45
|
* @property {PageSchema[]} page
|
|
46
46
|
* @property {ListViewItems[]} items
|
|
47
47
|
*/
|
|
@@ -60,7 +60,7 @@ export = ServiceabilityPlatformModel;
|
|
|
60
60
|
* @property {string} name
|
|
61
61
|
*/
|
|
62
62
|
/**
|
|
63
|
-
* @typedef
|
|
63
|
+
* @typedef EntityRegionView_Response
|
|
64
64
|
* @property {EntityRegionView_Error} error
|
|
65
65
|
* @property {EntityRegionView_page} page
|
|
66
66
|
* @property {EntityRegionView_Items[]} data
|
|
@@ -106,7 +106,7 @@ export = ServiceabilityPlatformModel;
|
|
|
106
106
|
* @property {ListViewChannels[]} channels - The name of the zone.
|
|
107
107
|
*/
|
|
108
108
|
/**
|
|
109
|
-
* @typedef
|
|
109
|
+
* @typedef ListViewResponse
|
|
110
110
|
* @property {ZoneDataItem} page
|
|
111
111
|
* @property {ListViewItems[]} items
|
|
112
112
|
*/
|
|
@@ -119,7 +119,7 @@ export = ServiceabilityPlatformModel;
|
|
|
119
119
|
* @property {number} current
|
|
120
120
|
*/
|
|
121
121
|
/**
|
|
122
|
-
* @typedef
|
|
122
|
+
* @typedef CompanyStoreView_Response
|
|
123
123
|
* @property {CompanyStoreView_PageItems[]} page
|
|
124
124
|
* @property {Object[]} [items]
|
|
125
125
|
*/
|
|
@@ -130,9 +130,8 @@ export = ServiceabilityPlatformModel;
|
|
|
130
130
|
*/
|
|
131
131
|
/**
|
|
132
132
|
* @typedef ZoneProductTypes
|
|
133
|
-
* @property {string} type
|
|
134
|
-
*
|
|
135
|
-
* @property {string[]} tags - List of product tags.
|
|
133
|
+
* @property {string} type
|
|
134
|
+
* @property {string[]} tags
|
|
136
135
|
*/
|
|
137
136
|
/**
|
|
138
137
|
* @typedef ZoneMappingDetailType
|
|
@@ -141,8 +140,8 @@ export = ServiceabilityPlatformModel;
|
|
|
141
140
|
*/
|
|
142
141
|
/**
|
|
143
142
|
* @typedef ZoneMappingType
|
|
144
|
-
* @property {string} country
|
|
145
|
-
* @property {string[]} regions
|
|
143
|
+
* @property {string} country
|
|
144
|
+
* @property {string[]} regions
|
|
146
145
|
*/
|
|
147
146
|
/**
|
|
148
147
|
* @typedef ZoneMappingRegions
|
|
@@ -154,89 +153,78 @@ export = ServiceabilityPlatformModel;
|
|
|
154
153
|
*/
|
|
155
154
|
/**
|
|
156
155
|
* @typedef UpdateZoneData
|
|
157
|
-
* @property {string} zone_id
|
|
158
|
-
* @property {string} name
|
|
159
|
-
* @property {string} slug
|
|
160
|
-
*
|
|
161
|
-
* @property {
|
|
162
|
-
* @property {
|
|
163
|
-
* @property {GetZoneDataViewChannels[]} channels - Channels for which the zone is active.
|
|
156
|
+
* @property {string} zone_id
|
|
157
|
+
* @property {string} name
|
|
158
|
+
* @property {string} slug
|
|
159
|
+
* @property {number} company_id
|
|
160
|
+
* @property {boolean} is_active
|
|
161
|
+
* @property {GetZoneDataViewChannels[]} channels
|
|
164
162
|
* @property {ZoneProductTypes} product
|
|
165
|
-
* @property {number[]} store_ids
|
|
166
|
-
* @property {string} region_type
|
|
167
|
-
* @property {ZoneMappingType[]} mapping
|
|
163
|
+
* @property {number[]} store_ids
|
|
164
|
+
* @property {string} region_type
|
|
165
|
+
* @property {ZoneMappingType[]} mapping
|
|
168
166
|
*/
|
|
169
167
|
/**
|
|
170
|
-
* @typedef
|
|
168
|
+
* @typedef ZoneUpdateRequest
|
|
171
169
|
* @property {string} identifier
|
|
172
170
|
* @property {UpdateZoneData} data
|
|
173
171
|
*/
|
|
174
172
|
/**
|
|
175
|
-
* @typedef
|
|
173
|
+
* @typedef ZoneSuccessResponse
|
|
176
174
|
* @property {number} status_code
|
|
177
175
|
* @property {boolean} success
|
|
178
176
|
*/
|
|
179
177
|
/**
|
|
180
178
|
* @typedef GetZoneDataViewItems
|
|
181
|
-
* @property {string} zone_id
|
|
182
|
-
* @property {string} name
|
|
183
|
-
* @property {string} slug
|
|
184
|
-
*
|
|
185
|
-
* @property {
|
|
186
|
-
* @property {
|
|
187
|
-
* (true) or inactive (false).
|
|
188
|
-
* @property {GetZoneDataViewChannels[]} channels - A list of channels available
|
|
189
|
-
* within this zone.
|
|
179
|
+
* @property {string} zone_id
|
|
180
|
+
* @property {string} name
|
|
181
|
+
* @property {string} slug
|
|
182
|
+
* @property {number} [company_id]
|
|
183
|
+
* @property {boolean} is_active
|
|
184
|
+
* @property {GetZoneDataViewChannels[]} channels
|
|
190
185
|
* @property {ZoneProductTypes} product
|
|
191
|
-
* @property {number[]} store_ids
|
|
192
|
-
* @property {string} [region_type]
|
|
193
|
-
* @property {ZoneMappingType[]} mapping
|
|
194
|
-
*
|
|
195
|
-
* @property {string} [assignment_preference] - The preferred method for
|
|
196
|
-
* assigning stores or products to the zone.
|
|
197
|
-
* @property {number} stores_count - The total number of stores assigned to this zone.
|
|
186
|
+
* @property {number[]} store_ids
|
|
187
|
+
* @property {string} [region_type]
|
|
188
|
+
* @property {ZoneMappingType[]} mapping
|
|
189
|
+
* @property {number} stores_count
|
|
198
190
|
*/
|
|
199
191
|
/**
|
|
200
|
-
* @typedef
|
|
192
|
+
* @typedef GetSingleZoneDataViewResponse
|
|
201
193
|
* @property {GetZoneDataViewItems} data
|
|
202
194
|
*/
|
|
203
195
|
/**
|
|
204
196
|
* @typedef GetZoneByIdSchema
|
|
205
|
-
* @property {string} zone_id
|
|
206
|
-
* @property {string} name
|
|
207
|
-
* @property {string} slug
|
|
208
|
-
*
|
|
209
|
-
* @property {
|
|
210
|
-
* @property {
|
|
211
|
-
* @property {GetZoneDataViewChannels[]} channels - Channels for which the zone is active.
|
|
197
|
+
* @property {string} zone_id
|
|
198
|
+
* @property {string} name
|
|
199
|
+
* @property {string} slug
|
|
200
|
+
* @property {number} [company_id]
|
|
201
|
+
* @property {boolean} is_active
|
|
202
|
+
* @property {GetZoneDataViewChannels[]} channels
|
|
212
203
|
* @property {ZoneProductTypes} product
|
|
213
|
-
* @property {number[]} store_ids
|
|
214
|
-
* @property {string} region_type
|
|
204
|
+
* @property {number[]} store_ids
|
|
205
|
+
* @property {string} region_type
|
|
215
206
|
* @property {ZoneMappingDetailType[]} mapping - Country to region mapping for the zone.
|
|
216
|
-
* @property {number} [stores_count]
|
|
217
207
|
*/
|
|
218
208
|
/**
|
|
219
209
|
* @typedef CreateZoneData
|
|
220
|
-
* @property {string} name
|
|
221
|
-
* @property {string} slug
|
|
222
|
-
*
|
|
223
|
-
* @property {
|
|
224
|
-
*
|
|
225
|
-
* @property {
|
|
226
|
-
* @property {
|
|
227
|
-
* @property {
|
|
228
|
-
* @property {
|
|
229
|
-
* @property {ZoneMappingType[]} mapping - Country to region mapping for the zone.
|
|
230
|
-
* @property {ZoneProductTypes} [product]
|
|
210
|
+
* @property {string} name
|
|
211
|
+
* @property {string} slug
|
|
212
|
+
* @property {number} company_id
|
|
213
|
+
* @property {boolean} is_active
|
|
214
|
+
* @property {GetZoneDataViewChannels[]} channels
|
|
215
|
+
* @property {number[]} store_ids
|
|
216
|
+
* @property {ZoneProductTypes} product
|
|
217
|
+
* @property {string} region_type
|
|
218
|
+
* @property {ZoneMappingType[]} mapping
|
|
231
219
|
*/
|
|
232
220
|
/**
|
|
233
|
-
* @typedef
|
|
234
|
-
* @property {number}
|
|
221
|
+
* @typedef ZoneResponse
|
|
222
|
+
* @property {number} status_code
|
|
235
223
|
* @property {string} zone_id
|
|
236
224
|
* @property {boolean} success
|
|
237
225
|
*/
|
|
238
226
|
/**
|
|
239
|
-
* @typedef
|
|
227
|
+
* @typedef GetZoneFromPincodeViewRequest
|
|
240
228
|
* @property {string} country
|
|
241
229
|
* @property {string} pincode
|
|
242
230
|
*/
|
|
@@ -251,17 +239,17 @@ export = ServiceabilityPlatformModel;
|
|
|
251
239
|
* @property {number[]} store_ids
|
|
252
240
|
*/
|
|
253
241
|
/**
|
|
254
|
-
* @typedef
|
|
242
|
+
* @typedef GetZoneFromPincodeViewResponse
|
|
255
243
|
* @property {string} serviceability_type
|
|
256
244
|
* @property {Zone[]} zones
|
|
257
245
|
*/
|
|
258
246
|
/**
|
|
259
|
-
* @typedef
|
|
247
|
+
* @typedef GetZoneFromApplicationIdViewResponse
|
|
260
248
|
* @property {ZoneDataItem[]} page
|
|
261
249
|
* @property {ListViewItems[]} items
|
|
262
250
|
*/
|
|
263
251
|
/**
|
|
264
|
-
* @typedef
|
|
252
|
+
* @typedef ServiceabilityPageResponse
|
|
265
253
|
* @property {string} [type]
|
|
266
254
|
* @property {boolean} [has_next]
|
|
267
255
|
* @property {number} [item_total]
|
|
@@ -274,32 +262,32 @@ export = ServiceabilityPlatformModel;
|
|
|
274
262
|
* @property {number} [country_code]
|
|
275
263
|
*/
|
|
276
264
|
/**
|
|
277
|
-
* @typedef
|
|
265
|
+
* @typedef ManagerResponse
|
|
278
266
|
* @property {string} [email]
|
|
279
267
|
* @property {MobileNo} [mobile_no]
|
|
280
268
|
* @property {string} [name]
|
|
281
269
|
*/
|
|
282
270
|
/**
|
|
283
|
-
* @typedef
|
|
271
|
+
* @typedef ModifiedByResponse
|
|
284
272
|
* @property {string} [username]
|
|
285
273
|
* @property {string} [user_id]
|
|
286
274
|
*/
|
|
287
275
|
/**
|
|
288
|
-
* @typedef
|
|
276
|
+
* @typedef IntegrationTypeResponse
|
|
289
277
|
* @property {string} [inventory]
|
|
290
278
|
* @property {string} [order]
|
|
291
279
|
*/
|
|
292
280
|
/**
|
|
293
|
-
* @typedef
|
|
281
|
+
* @typedef ProductReturnConfigResponse
|
|
294
282
|
* @property {boolean} [on_same_store]
|
|
295
283
|
*/
|
|
296
284
|
/**
|
|
297
|
-
* @typedef
|
|
285
|
+
* @typedef ContactNumberResponse
|
|
298
286
|
* @property {string} [number]
|
|
299
287
|
* @property {number} [country_code]
|
|
300
288
|
*/
|
|
301
289
|
/**
|
|
302
|
-
* @typedef
|
|
290
|
+
* @typedef AddressResponse
|
|
303
291
|
* @property {string} [city]
|
|
304
292
|
* @property {string} [address1]
|
|
305
293
|
* @property {number} [pincode]
|
|
@@ -311,25 +299,25 @@ export = ServiceabilityPlatformModel;
|
|
|
311
299
|
* @property {number} [longitude]
|
|
312
300
|
*/
|
|
313
301
|
/**
|
|
314
|
-
* @typedef
|
|
302
|
+
* @typedef CreatedByResponse
|
|
315
303
|
* @property {string} [username]
|
|
316
304
|
* @property {string} [user_id]
|
|
317
305
|
*/
|
|
318
306
|
/**
|
|
319
|
-
* @typedef
|
|
307
|
+
* @typedef EwayBillResponse
|
|
320
308
|
* @property {boolean} [enabled]
|
|
321
309
|
*/
|
|
322
310
|
/**
|
|
323
|
-
* @typedef
|
|
311
|
+
* @typedef EinvoiceResponse
|
|
324
312
|
* @property {boolean} [enabled]
|
|
325
313
|
*/
|
|
326
314
|
/**
|
|
327
|
-
* @typedef
|
|
328
|
-
* @property {
|
|
329
|
-
* @property {
|
|
315
|
+
* @typedef GstCredentialsResponse
|
|
316
|
+
* @property {EwayBillResponse} [e_waybill]
|
|
317
|
+
* @property {EinvoiceResponse} [e_invoice]
|
|
330
318
|
*/
|
|
331
319
|
/**
|
|
332
|
-
* @typedef
|
|
320
|
+
* @typedef WarningsResponse
|
|
333
321
|
* @property {string} [store_address]
|
|
334
322
|
*/
|
|
335
323
|
/**
|
|
@@ -338,14 +326,14 @@ export = ServiceabilityPlatformModel;
|
|
|
338
326
|
* @property {number} [hour]
|
|
339
327
|
*/
|
|
340
328
|
/**
|
|
341
|
-
* @typedef
|
|
329
|
+
* @typedef TimmingResponse
|
|
342
330
|
* @property {boolean} [open]
|
|
343
331
|
* @property {string} [weekday]
|
|
344
332
|
* @property {OpeningClosing} [closing]
|
|
345
333
|
* @property {OpeningClosing} [opening]
|
|
346
334
|
*/
|
|
347
335
|
/**
|
|
348
|
-
* @typedef
|
|
336
|
+
* @typedef DocumentsResponse
|
|
349
337
|
* @property {string} [legal_name]
|
|
350
338
|
* @property {string} [value]
|
|
351
339
|
* @property {string} [type]
|
|
@@ -365,108 +353,99 @@ export = ServiceabilityPlatformModel;
|
|
|
365
353
|
* @property {boolean} [assign_dp_from_sb]
|
|
366
354
|
*/
|
|
367
355
|
/**
|
|
368
|
-
* @typedef
|
|
356
|
+
* @typedef LogisticsResponse
|
|
369
357
|
* @property {boolean} [override]
|
|
370
358
|
* @property {Dp} [dp]
|
|
371
359
|
*/
|
|
372
360
|
/**
|
|
373
|
-
* @typedef
|
|
361
|
+
* @typedef ItemResponse
|
|
374
362
|
* @property {string} [created_on]
|
|
375
|
-
* @property {
|
|
376
|
-
* @property {
|
|
377
|
-
* @property {
|
|
363
|
+
* @property {ManagerResponse} [manager]
|
|
364
|
+
* @property {ModifiedByResponse} [modified_by]
|
|
365
|
+
* @property {IntegrationTypeResponse} [integration_type]
|
|
378
366
|
* @property {string} [verified_on]
|
|
379
|
-
* @property {
|
|
380
|
-
* @property {
|
|
381
|
-
* @property {
|
|
367
|
+
* @property {ProductReturnConfigResponse} [product_return_config]
|
|
368
|
+
* @property {ContactNumberResponse[]} [contact_numbers]
|
|
369
|
+
* @property {ModifiedByResponse} [verified_by]
|
|
382
370
|
* @property {string} [stage]
|
|
383
|
-
* @property {
|
|
371
|
+
* @property {AddressResponse} [address]
|
|
384
372
|
* @property {string} [modified_on]
|
|
385
|
-
* @property {
|
|
386
|
-
* @property {
|
|
373
|
+
* @property {CreatedByResponse} [created_by]
|
|
374
|
+
* @property {GstCredentialsResponse} [gst_credentials]
|
|
387
375
|
* @property {string} [display_name]
|
|
388
376
|
* @property {number} [company_id]
|
|
389
377
|
* @property {number} [uid]
|
|
390
|
-
* @property {Object} [_custom_json]
|
|
378
|
+
* @property {Object} [_custom_json]
|
|
391
379
|
* @property {string} [code]
|
|
392
|
-
* @property {
|
|
380
|
+
* @property {WarningsResponse} [warnings]
|
|
393
381
|
* @property {string} [name]
|
|
394
|
-
* @property {
|
|
395
|
-
* @property {
|
|
382
|
+
* @property {TimmingResponse[]} [timing]
|
|
383
|
+
* @property {DocumentsResponse[]} [documents]
|
|
396
384
|
* @property {string} [store_type]
|
|
397
385
|
* @property {string} [sub_type]
|
|
398
386
|
* @property {number} [company]
|
|
399
387
|
* @property {string} [_cls]
|
|
400
|
-
* @property {
|
|
388
|
+
* @property {LogisticsResponse} [logistics]
|
|
401
389
|
* @property {string[]} [notification_emails]
|
|
402
390
|
*/
|
|
403
391
|
/**
|
|
404
|
-
* @typedef
|
|
405
|
-
* @property {
|
|
406
|
-
* @property {
|
|
392
|
+
* @typedef GetStoresViewResponse
|
|
393
|
+
* @property {ServiceabilityPageResponse} page
|
|
394
|
+
* @property {ItemResponse[]} [items]
|
|
407
395
|
*/
|
|
408
396
|
/**
|
|
409
397
|
* @typedef PincodeMopData
|
|
410
|
-
* @property {number[]} pincodes
|
|
411
|
-
* @property {string} country
|
|
412
|
-
* @property {string} action
|
|
413
|
-
* for COD mode of payment.
|
|
398
|
+
* @property {number[]} pincodes
|
|
399
|
+
* @property {string} country
|
|
400
|
+
* @property {string} action
|
|
414
401
|
*/
|
|
415
402
|
/**
|
|
416
|
-
* @typedef
|
|
417
|
-
* @property {number} pincode
|
|
418
|
-
* @property {string} channel_id
|
|
419
|
-
* @property {string} country
|
|
420
|
-
* @property {boolean} is_active
|
|
421
|
-
* is active or not.
|
|
403
|
+
* @typedef PincodeMopUpdateResponse
|
|
404
|
+
* @property {number} pincode
|
|
405
|
+
* @property {string} channel_id
|
|
406
|
+
* @property {string} country
|
|
407
|
+
* @property {boolean} is_active
|
|
422
408
|
*/
|
|
423
409
|
/**
|
|
424
|
-
* @typedef
|
|
425
|
-
* @property {boolean} success
|
|
426
|
-
* @property {number} status_code
|
|
427
|
-
* @property {string} batch_id
|
|
428
|
-
* @property {string} country
|
|
429
|
-
* @property {string} action
|
|
430
|
-
*
|
|
431
|
-
* @property {
|
|
432
|
-
* @property {PincodeMopUpdateResult[]} [updated_pincodes] - Details of the
|
|
433
|
-
* updated pincodes.
|
|
410
|
+
* @typedef PincodeMOPresponse
|
|
411
|
+
* @property {boolean} success
|
|
412
|
+
* @property {number} status_code
|
|
413
|
+
* @property {string} batch_id
|
|
414
|
+
* @property {string} country
|
|
415
|
+
* @property {string} action
|
|
416
|
+
* @property {number[]} [pincodes]
|
|
417
|
+
* @property {PincodeMopUpdateResponse[]} [updated_pincodes]
|
|
434
418
|
*/
|
|
435
419
|
/**
|
|
436
420
|
* @typedef CommonError
|
|
437
|
-
* @property {string} [status_code]
|
|
421
|
+
* @property {string} [status_code]
|
|
438
422
|
* @property {Object} [error]
|
|
439
|
-
* @property {string} [success]
|
|
423
|
+
* @property {string} [success]
|
|
440
424
|
*/
|
|
441
425
|
/**
|
|
442
426
|
* @typedef PincodeMopBulkData
|
|
443
|
-
* @property {string} batch_id
|
|
444
|
-
* @property {string} s3_url
|
|
427
|
+
* @property {string} batch_id
|
|
428
|
+
* @property {string} s3_url
|
|
445
429
|
*/
|
|
446
430
|
/**
|
|
447
|
-
* @typedef
|
|
431
|
+
* @typedef PincodeBulkViewResponse
|
|
448
432
|
* @property {string} batch_id
|
|
449
|
-
* @property {string} s3_url
|
|
433
|
+
* @property {string} s3_url
|
|
450
434
|
*/
|
|
451
435
|
/**
|
|
452
|
-
* @typedef
|
|
453
|
-
* @property {string} [country]
|
|
454
|
-
* @property {boolean} [is_active]
|
|
455
|
-
* @property {number} [pincode]
|
|
436
|
+
* @typedef PincodeCodStatusListingRequest
|
|
437
|
+
* @property {string} [country]
|
|
438
|
+
* @property {boolean} [is_active]
|
|
439
|
+
* @property {number} [pincode]
|
|
456
440
|
* @property {number} [current]
|
|
457
441
|
* @property {number} [page_size]
|
|
458
442
|
*/
|
|
459
443
|
/**
|
|
460
|
-
* @typedef
|
|
461
|
-
* @property {
|
|
462
|
-
* @property {
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
* @typedef PincodeCodStatusListingResult
|
|
466
|
-
* @property {string} country - Name of the country.
|
|
467
|
-
* @property {PincodeCodStatusListingResult[]} data - List of pincode details.
|
|
468
|
-
* @property {boolean} success - Denotes if the request was successful or not.
|
|
469
|
-
* @property {Error[]} [errors] - List of error object in case of unsuccessful response.
|
|
444
|
+
* @typedef PincodeCodStatusListingResponse
|
|
445
|
+
* @property {string} country
|
|
446
|
+
* @property {PincodeCodStatusListingResponse[]} data
|
|
447
|
+
* @property {boolean} success
|
|
448
|
+
* @property {Error[]} [errors]
|
|
470
449
|
* @property {PincodeCodStatusListingPage} page
|
|
471
450
|
* @property {PincodeCodStatusListingSummary} summary
|
|
472
451
|
*/
|
|
@@ -486,13 +465,13 @@ export = ServiceabilityPlatformModel;
|
|
|
486
465
|
*/
|
|
487
466
|
/**
|
|
488
467
|
* @typedef PincodeCodStatusListingSummary
|
|
489
|
-
* @property {number} total_active_pincodes
|
|
490
|
-
* @property {number} total_inactive_pincodes
|
|
468
|
+
* @property {number} total_active_pincodes
|
|
469
|
+
* @property {number} total_inactive_pincodes
|
|
491
470
|
*/
|
|
492
471
|
/**
|
|
493
|
-
* @typedef
|
|
494
|
-
* @property {string} entity_type
|
|
495
|
-
* @property {string} [file_name]
|
|
472
|
+
* @typedef PincodeMopUpdateAuditHistoryRequest
|
|
473
|
+
* @property {string} entity_type
|
|
474
|
+
* @property {string} [file_name]
|
|
496
475
|
*/
|
|
497
476
|
/**
|
|
498
477
|
* @typedef PincodeMopUpdateAuditHistoryPaging
|
|
@@ -503,22 +482,21 @@ export = ServiceabilityPlatformModel;
|
|
|
503
482
|
* @property {number} [item_total]
|
|
504
483
|
*/
|
|
505
484
|
/**
|
|
506
|
-
* @typedef
|
|
507
|
-
* @property {string} [batch_id]
|
|
508
|
-
* @property {string} [entity_type]
|
|
509
|
-
* @property {string} [error_file_s3_url]
|
|
510
|
-
* @property {string} [s3_url]
|
|
511
|
-
* @property {string} [file_name]
|
|
485
|
+
* @typedef PincodeMopUpdateAuditHistoryResponse
|
|
486
|
+
* @property {string} [batch_id]
|
|
487
|
+
* @property {string} [entity_type]
|
|
488
|
+
* @property {string} [error_file_s3_url]
|
|
489
|
+
* @property {string} [s3_url]
|
|
490
|
+
* @property {string} [file_name]
|
|
512
491
|
* @property {string} [updated_at]
|
|
513
492
|
* @property {string} [updated_by]
|
|
514
|
-
* @property {boolean} [success]
|
|
493
|
+
* @property {boolean} [success]
|
|
515
494
|
*/
|
|
516
495
|
/**
|
|
517
|
-
* @typedef
|
|
518
|
-
* @property {string} [entity_type]
|
|
496
|
+
* @typedef PincodeMopUpdateAuditHistoryResponseData
|
|
497
|
+
* @property {string} [entity_type]
|
|
519
498
|
* @property {PincodeMopUpdateAuditHistoryPaging} page
|
|
520
|
-
* @property {
|
|
521
|
-
* the uploaded files.
|
|
499
|
+
* @property {PincodeMopUpdateAuditHistoryResponse[]} data
|
|
522
500
|
*/
|
|
523
501
|
/**
|
|
524
502
|
* @typedef ArithmeticOperations
|
|
@@ -545,49 +523,34 @@ export = ServiceabilityPlatformModel;
|
|
|
545
523
|
* @property {string[]} [payment_mode]
|
|
546
524
|
* @property {SchemeRulesFeatures} [feature]
|
|
547
525
|
*/
|
|
548
|
-
/**
|
|
549
|
-
* @typedef CourierAccountUpdateDetails
|
|
550
|
-
* @property {string} extension_id - Unique identifier of courier partner extension.
|
|
551
|
-
* @property {string} scheme_id - Unique identifier of courier partner scheme.
|
|
552
|
-
* @property {boolean} is_self_ship - Denotes if the account is of self delivery type.
|
|
553
|
-
* @property {string} stage - Denotes whether the account is in enabled or disabled stage.
|
|
554
|
-
* @property {boolean} is_own_account - Denotes whether it is the seller's own
|
|
555
|
-
* account or not.
|
|
556
|
-
*/
|
|
557
526
|
/**
|
|
558
527
|
* @typedef CourierAccount
|
|
559
|
-
* @property {
|
|
560
|
-
* @property {string}
|
|
561
|
-
* @property {string}
|
|
562
|
-
*
|
|
563
|
-
* @property {string}
|
|
564
|
-
* @property {boolean}
|
|
565
|
-
* @property {string} stage - Denotes whether the account is in enabled or disabled stage.
|
|
566
|
-
* @property {boolean} is_own_account - Denotes whether it is the seller's own
|
|
567
|
-
* account or not.
|
|
568
|
-
* @property {CourierPartnerSchemeModel} scheme_rules
|
|
528
|
+
* @property {string} extension_id
|
|
529
|
+
* @property {string} account_id
|
|
530
|
+
* @property {string} scheme_id
|
|
531
|
+
* @property {boolean} is_self_ship
|
|
532
|
+
* @property {string} stage
|
|
533
|
+
* @property {boolean} is_own_account
|
|
569
534
|
*/
|
|
570
535
|
/**
|
|
571
|
-
* @typedef
|
|
572
|
-
* @property {string} extension_id
|
|
573
|
-
* @property {string} [account_id]
|
|
574
|
-
*
|
|
575
|
-
* @property {
|
|
576
|
-
* @property {
|
|
577
|
-
* @property {
|
|
578
|
-
* @property {boolean} is_own_account - Denotes whether it is the seller's own
|
|
579
|
-
* account or not.
|
|
536
|
+
* @typedef CourierAccountRequestBody
|
|
537
|
+
* @property {string} extension_id
|
|
538
|
+
* @property {string} [account_id]
|
|
539
|
+
* @property {string} scheme_id
|
|
540
|
+
* @property {boolean} is_self_ship
|
|
541
|
+
* @property {string} stage
|
|
542
|
+
* @property {boolean} is_own_account
|
|
580
543
|
*/
|
|
581
544
|
/**
|
|
582
|
-
* @typedef
|
|
583
|
-
* @property {string} value
|
|
584
|
-
* @property {string} message
|
|
585
|
-
* @property {string} type
|
|
545
|
+
* @typedef ErrorResponse
|
|
546
|
+
* @property {string} value
|
|
547
|
+
* @property {string} message
|
|
548
|
+
* @property {string} type
|
|
586
549
|
*/
|
|
587
550
|
/**
|
|
588
|
-
* @typedef
|
|
589
|
-
* @property {boolean} success
|
|
590
|
-
* @property {
|
|
551
|
+
* @typedef CourierPartnerAccountFailureResponse
|
|
552
|
+
* @property {boolean} success
|
|
553
|
+
* @property {ErrorResponse[]} error
|
|
591
554
|
*/
|
|
592
555
|
/**
|
|
593
556
|
* @typedef Page
|
|
@@ -600,38 +563,31 @@ export = ServiceabilityPlatformModel;
|
|
|
600
563
|
* @property {number} [size] - The number of items per page.
|
|
601
564
|
*/
|
|
602
565
|
/**
|
|
603
|
-
* @typedef
|
|
604
|
-
* @property {string} account_id
|
|
605
|
-
*
|
|
606
|
-
* @property {
|
|
607
|
-
* @property {
|
|
608
|
-
* @property {Object} [scheme_rules] - Denotes the scheme rules associated with
|
|
609
|
-
* the courier partner account.
|
|
566
|
+
* @typedef CourierPartnerRuleCPListResponse
|
|
567
|
+
* @property {string} [account_id]
|
|
568
|
+
* @property {string} [extension_id]
|
|
569
|
+
* @property {boolean} [is_self_ship]
|
|
570
|
+
* @property {Object} [scheme_rules]
|
|
610
571
|
*/
|
|
611
572
|
/**
|
|
612
|
-
* @typedef
|
|
613
|
-
* @property {boolean} is_active
|
|
614
|
-
*
|
|
615
|
-
* @property {
|
|
616
|
-
* @property {
|
|
617
|
-
* @property {
|
|
618
|
-
* @property {
|
|
619
|
-
* @property {
|
|
620
|
-
*
|
|
621
|
-
* @property {string}
|
|
622
|
-
* @property {
|
|
623
|
-
*
|
|
624
|
-
* @property {
|
|
625
|
-
* is modified.
|
|
626
|
-
* @property {string} name - Name for the courier partner rule.
|
|
627
|
-
* @property {string} type - The type of the rule.
|
|
628
|
-
* @property {CourierPartnerRuleCPListResult[]} [cp_list]
|
|
573
|
+
* @typedef CourierPartnerRuleResponse
|
|
574
|
+
* @property {boolean} [is_active]
|
|
575
|
+
* @property {string} [application_id]
|
|
576
|
+
* @property {number} [company_id]
|
|
577
|
+
* @property {CourierPartnerRuleConditions} [conditions]
|
|
578
|
+
* @property {string[]} [sort]
|
|
579
|
+
* @property {Object} [created_by]
|
|
580
|
+
* @property {string} [id]
|
|
581
|
+
* @property {Object} [modified_by]
|
|
582
|
+
* @property {string} [modified_on]
|
|
583
|
+
* @property {string} [name]
|
|
584
|
+
* @property {string} [type]
|
|
585
|
+
* @property {CourierPartnerRuleCPListResponse[]} [cp_list]
|
|
629
586
|
*/
|
|
630
587
|
/**
|
|
631
588
|
* @typedef CourierPartnerList
|
|
632
|
-
* @property {string} extension_id
|
|
633
|
-
* @property {string} account_id
|
|
634
|
-
* and company id combination.
|
|
589
|
+
* @property {string} extension_id
|
|
590
|
+
* @property {string} account_id
|
|
635
591
|
*/
|
|
636
592
|
/**
|
|
637
593
|
* @typedef LocationRuleValues
|
|
@@ -639,7 +595,7 @@ export = ServiceabilityPlatformModel;
|
|
|
639
595
|
* @property {string} [sub_type]
|
|
640
596
|
* @property {string} [name]
|
|
641
597
|
* @property {string} [display_name]
|
|
642
|
-
* @property {string
|
|
598
|
+
* @property {string} [parent_id]
|
|
643
599
|
* @property {string[]} [parent_ids]
|
|
644
600
|
*/
|
|
645
601
|
/**
|
|
@@ -676,168 +632,86 @@ export = ServiceabilityPlatformModel;
|
|
|
676
632
|
*/
|
|
677
633
|
/**
|
|
678
634
|
* @typedef CourierPartnerRule
|
|
679
|
-
* @property {boolean} is_active
|
|
680
|
-
*
|
|
681
|
-
* @property {
|
|
682
|
-
* @property {string} name - Name for the courier partner rule.
|
|
635
|
+
* @property {boolean} is_active
|
|
636
|
+
* @property {CourierPartnerList[]} [cp_list]
|
|
637
|
+
* @property {string} name
|
|
683
638
|
* @property {CourierPartnerRuleConditions} conditions
|
|
684
|
-
* @property {string[]} sort
|
|
685
|
-
* @property {string} [type] - Denotes the type of the rule.
|
|
639
|
+
* @property {string[]} sort
|
|
686
640
|
*/
|
|
687
641
|
/**
|
|
688
|
-
* @typedef
|
|
642
|
+
* @typedef FailureResponse
|
|
689
643
|
* @property {boolean} success
|
|
690
|
-
* @property {
|
|
644
|
+
* @property {ErrorResponse[]} error
|
|
691
645
|
*/
|
|
692
646
|
/**
|
|
693
|
-
* @typedef
|
|
694
|
-
* @property {
|
|
647
|
+
* @typedef CourierPartnerRulesListResponse
|
|
648
|
+
* @property {CourierPartnerRuleResponse[]} items
|
|
695
649
|
* @property {Page} page
|
|
696
650
|
*/
|
|
697
|
-
/**
|
|
698
|
-
* @typedef ShipmentsArticles
|
|
699
|
-
* @property {number} [item_id] - Unique identifier of the item.
|
|
700
|
-
* @property {number} [category_id] - Unique identifier of the category.
|
|
701
|
-
* @property {number} [brand_id] - Unique identifier of the brand.
|
|
702
|
-
* @property {number} [department_id] - Unique identifier of the department.
|
|
703
|
-
* @property {string[]} [tags] - Tags associated with the item.
|
|
704
|
-
*/
|
|
705
|
-
/**
|
|
706
|
-
* @typedef ShipmentDimension
|
|
707
|
-
* @property {number} height - Height of the shipment in centimeters.
|
|
708
|
-
* @property {number} length - Length of the shipment in centimeters.
|
|
709
|
-
* @property {number} width - Width of the shipment in centimeters.
|
|
710
|
-
*/
|
|
711
|
-
/**
|
|
712
|
-
* @typedef Shipments
|
|
713
|
-
* @property {string} [id] - Unique identifier of the shipment.
|
|
714
|
-
* @property {number} [location_id] - Unique identifier of the selling location.
|
|
715
|
-
* @property {string[]} [location_tags] - Tags associated with the selling location.
|
|
716
|
-
* @property {number} [shipment_weight] - Weight of the shipment.
|
|
717
|
-
* @property {number} [shipment_volumetric_weight] - Volumetric weight of the shipment.
|
|
718
|
-
* @property {number} [shipment_cost] - Total Cost of the shipment.
|
|
719
|
-
* @property {ShipmentDimension} [shipment_dimension]
|
|
720
|
-
* @property {string[]} [courier_partner_schemes] - A List of courier schemes.
|
|
721
|
-
* @property {ShipmentsArticles[]} [articles] - List of articles in the shipment.
|
|
722
|
-
*/
|
|
723
|
-
/**
|
|
724
|
-
* @typedef ShipmentCourierPartnerDetails
|
|
725
|
-
* @property {ShipmentsCourierPartnersServiceability} from_location
|
|
726
|
-
* @property {ShipmentsCourierPartnersServiceability} to_location
|
|
727
|
-
* @property {Shipments[]} [shipments] - List of shipments.
|
|
728
|
-
* @property {string} [journey] - Journey type of the shipment forward or return.
|
|
729
|
-
* @property {string} [payment_mode] - Payment mode opted for the shipment.
|
|
730
|
-
*/
|
|
731
|
-
/**
|
|
732
|
-
* @typedef CourierPartnerPromise
|
|
733
|
-
* @property {string} min - The earliest possible timestamp.
|
|
734
|
-
* @property {string} max - The latest possible timestamp.
|
|
735
|
-
*/
|
|
736
|
-
/**
|
|
737
|
-
* @typedef CourierPartners
|
|
738
|
-
* @property {string} [extension_id] - Unique identifier of courier partner extension.
|
|
739
|
-
* @property {string} [scheme_id] - Unique identifier of courier partner scheme.
|
|
740
|
-
* @property {string} [name] - Name of the courier partner.
|
|
741
|
-
* @property {CourierPartnerPromise} [delivery_promise]
|
|
742
|
-
*/
|
|
743
|
-
/**
|
|
744
|
-
* @typedef ShipmentCourierPartners
|
|
745
|
-
* @property {string} [id] - Unique identifier of the shipment.
|
|
746
|
-
* @property {CourierPartners[]} [courier_partners] - Courier partners of the shipment.
|
|
747
|
-
*/
|
|
748
|
-
/**
|
|
749
|
-
* @typedef ShipmentCourierPartnerResult
|
|
750
|
-
* @property {CourierPartners[]} [courier_partners]
|
|
751
|
-
* @property {ShipmentCourierPartners[]} [shipments]
|
|
752
|
-
*/
|
|
753
|
-
/**
|
|
754
|
-
* @typedef ShipmentsCourierPartnersServiceability
|
|
755
|
-
* @property {string} [pincode] - Postal code or PIN code of the address area.
|
|
756
|
-
* @property {string} [sector_code] - Specifies the sector or district code of
|
|
757
|
-
* the address if applicable.
|
|
758
|
-
* @property {string} [state_code] - Indicates the state or province code of the address.
|
|
759
|
-
* @property {string} [city_code] - Denote the city or municipality code of the address.
|
|
760
|
-
* @property {string} country_code - ISO2 code for the country of the address.
|
|
761
|
-
*/
|
|
762
651
|
/**
|
|
763
652
|
* @typedef CompanyConfig
|
|
764
|
-
* @property {string[]} rule_ids
|
|
765
|
-
* @property {string[]} sort
|
|
766
|
-
* @property {
|
|
767
|
-
* rule configuration plan is subscribed by the seller for which mode.
|
|
768
|
-
* @property {number} company_id - Unique identifier of the company.
|
|
769
|
-
* @property {string} [application_id] - Unique identifier of the sales channel.
|
|
653
|
+
* @property {string[]} rule_ids
|
|
654
|
+
* @property {string[]} sort
|
|
655
|
+
* @property {boolean} [logistics_as_actual]
|
|
770
656
|
*/
|
|
771
657
|
/**
|
|
772
658
|
* @typedef ZoneConfig
|
|
773
|
-
* @property {string} [serviceability_type]
|
|
774
|
-
* @property {number} [active_count] - Count of active delivery zones associated
|
|
775
|
-
* with the sales channel.
|
|
776
|
-
* @property {number} [total_count] - Count of total delivery zones associated
|
|
777
|
-
* with the sales channel.
|
|
659
|
+
* @property {string} [serviceability_type]
|
|
778
660
|
*/
|
|
779
661
|
/**
|
|
780
662
|
* @typedef ApplicationConfig
|
|
781
|
-
* @property {string[]} [rule_ids]
|
|
782
|
-
* @property {string[]} [sort]
|
|
663
|
+
* @property {string[]} [rule_ids]
|
|
664
|
+
* @property {string[]} [sort]
|
|
783
665
|
* @property {ZoneConfig} [zones]
|
|
784
666
|
*/
|
|
785
667
|
/**
|
|
786
|
-
* @typedef
|
|
787
|
-
* @property {string} [file_path]
|
|
788
|
-
* @property {string} country
|
|
789
|
-
*
|
|
790
|
-
* @property {string}
|
|
791
|
-
* @property {string} region - Region of the country for which import or export
|
|
792
|
-
* is triggered.
|
|
668
|
+
* @typedef BulkRegionJobSerializer
|
|
669
|
+
* @property {string} [file_path]
|
|
670
|
+
* @property {string} country
|
|
671
|
+
* @property {string} action
|
|
672
|
+
* @property {string} region
|
|
793
673
|
*/
|
|
794
674
|
/**
|
|
795
|
-
* @typedef
|
|
796
|
-
* @property {string}
|
|
797
|
-
* @property {number} [failed]
|
|
675
|
+
* @typedef BulkRegionResponseItemData
|
|
676
|
+
* @property {string} file_path
|
|
677
|
+
* @property {number} [failed]
|
|
798
678
|
* @property {Object[]} [failed_records]
|
|
799
|
-
* @property {string} action
|
|
800
|
-
* @property {string} batch_id
|
|
801
|
-
* @property {string} country
|
|
802
|
-
*
|
|
803
|
-
* @property {
|
|
804
|
-
*
|
|
805
|
-
* @property {
|
|
806
|
-
*
|
|
807
|
-
|
|
808
|
-
|
|
809
|
-
* @
|
|
810
|
-
|
|
811
|
-
/**
|
|
812
|
-
* @typedef BulkRegionResult
|
|
813
|
-
* @property {BulkRegionResultItemData[]} items
|
|
679
|
+
* @property {string} action
|
|
680
|
+
* @property {string} batch_id
|
|
681
|
+
* @property {string} country
|
|
682
|
+
* @property {number} [success]
|
|
683
|
+
* @property {string} region
|
|
684
|
+
* @property {string} status
|
|
685
|
+
* @property {number} [total]
|
|
686
|
+
* @property {string} [error_file_path]
|
|
687
|
+
*/
|
|
688
|
+
/**
|
|
689
|
+
* @typedef BulkRegionResponse
|
|
690
|
+
* @property {BulkRegionResponseItemData[]} items
|
|
814
691
|
* @property {Page} page
|
|
815
692
|
*/
|
|
816
693
|
/**
|
|
817
|
-
* @typedef
|
|
694
|
+
* @typedef SelfShipResponse
|
|
818
695
|
* @property {boolean} is_active
|
|
819
696
|
* @property {number} tat
|
|
820
697
|
*/
|
|
821
698
|
/**
|
|
822
699
|
* @typedef ApplicationSelfShipConfig
|
|
823
|
-
* @property {
|
|
700
|
+
* @property {Object} [self_ship]
|
|
824
701
|
*/
|
|
825
702
|
/**
|
|
826
|
-
* @typedef
|
|
827
|
-
* @property {
|
|
703
|
+
* @typedef ApplicationSelfShipConfigResponse
|
|
704
|
+
* @property {ServiceabilityErrorResponse} [error]
|
|
828
705
|
* @property {ApplicationSelfShipConfig} [data]
|
|
829
706
|
* @property {boolean} success
|
|
830
707
|
*/
|
|
831
708
|
/**
|
|
832
709
|
* @typedef StoreRuleConfigData
|
|
833
|
-
* @property {string[]} [rule_ids]
|
|
834
|
-
* @property {string[]} [type_based_priority]
|
|
835
|
-
*
|
|
836
|
-
* @property {
|
|
837
|
-
*
|
|
838
|
-
* @property {StorePrioritySchema[]} [store_priority] - Priority of explicit
|
|
839
|
-
* stores to be used for sorting of stores.
|
|
840
|
-
* @property {string[]} [sort] - Criteria on which the selected stores should be sorted.
|
|
710
|
+
* @property {string[]} [rule_ids]
|
|
711
|
+
* @property {string[]} [type_based_priority]
|
|
712
|
+
* @property {string[]} [tag_based_priority]
|
|
713
|
+
* @property {StorePrioritySchema[]} [store_priority]
|
|
714
|
+
* @property {string[]} [sort]
|
|
841
715
|
*/
|
|
842
716
|
/**
|
|
843
717
|
* @typedef CustomerRadiusSchema
|
|
@@ -863,81 +737,69 @@ export = ServiceabilityPlatformModel;
|
|
|
863
737
|
*/
|
|
864
738
|
/**
|
|
865
739
|
* @typedef StoreRuleDataSchema
|
|
866
|
-
* @property {string} [id]
|
|
867
|
-
* @property {string} [name]
|
|
868
|
-
* @property {number} [company_id]
|
|
869
|
-
* @property {string} [application_id]
|
|
870
|
-
* @property {string[]} [type_based_priority]
|
|
871
|
-
*
|
|
872
|
-
* @property {
|
|
873
|
-
*
|
|
874
|
-
* @property {StorePrioritySchema[]} [store_priority] - Priority of explicit
|
|
875
|
-
* stores to be used for sorting of stores.
|
|
876
|
-
* @property {string[]} [sort] - Criteria on which the selected stores should be sorted.
|
|
740
|
+
* @property {string} [id]
|
|
741
|
+
* @property {string} [name]
|
|
742
|
+
* @property {number} [company_id]
|
|
743
|
+
* @property {string} [application_id]
|
|
744
|
+
* @property {string[]} [type_based_priority]
|
|
745
|
+
* @property {string[]} [tag_based_priority]
|
|
746
|
+
* @property {StorePrioritySchema[]} [store_priority]
|
|
747
|
+
* @property {string[]} [sort]
|
|
877
748
|
* @property {StoreRuleConditionSchema} [conditions]
|
|
878
|
-
* @property {boolean} [is_active]
|
|
749
|
+
* @property {boolean} [is_active]
|
|
879
750
|
*/
|
|
880
751
|
/**
|
|
881
752
|
* @typedef StorePrioritySchema
|
|
882
|
-
* @property {
|
|
883
|
-
* @property {string} [name]
|
|
753
|
+
* @property {string} [id]
|
|
754
|
+
* @property {string} [name]
|
|
884
755
|
*/
|
|
885
756
|
/**
|
|
886
|
-
* @typedef
|
|
757
|
+
* @typedef GetStoreRulesApiResponse
|
|
887
758
|
* @property {StoreRuleDataSchema[]} [items]
|
|
888
759
|
* @property {Page} [page]
|
|
889
760
|
*/
|
|
890
761
|
/**
|
|
891
|
-
* @typedef
|
|
892
|
-
* @property {string} [name]
|
|
893
|
-
* @property {boolean} [is_active]
|
|
762
|
+
* @typedef CreateStoreRuleRequestSchema
|
|
763
|
+
* @property {string} [name]
|
|
764
|
+
* @property {boolean} [is_active]
|
|
894
765
|
* @property {StoreRuleConditionSchema} [conditions]
|
|
895
|
-
* @property {string[]} [type_based_priority]
|
|
896
|
-
*
|
|
897
|
-
* @property {
|
|
898
|
-
*
|
|
899
|
-
|
|
900
|
-
|
|
901
|
-
* @
|
|
902
|
-
|
|
903
|
-
|
|
904
|
-
* @
|
|
905
|
-
* @property {string} [
|
|
906
|
-
* @property {string} [
|
|
907
|
-
* @property {
|
|
908
|
-
* @property {string[]} [
|
|
909
|
-
* used in the rule for sorting of stores.
|
|
910
|
-
* @property {string[]} [tag_based_priority] - Priority of the store tags to be
|
|
911
|
-
* used in the rule for sorting of stores.
|
|
912
|
-
* @property {StorePrioritySchema[]} [store_priority] - Priority of explicit
|
|
913
|
-
* stores to be used for sorting of stores.
|
|
914
|
-
* @property {string[]} [sort] - Criteria on which the selected stores should be sorted.
|
|
766
|
+
* @property {string[]} [type_based_priority]
|
|
767
|
+
* @property {string[]} [tag_based_priority]
|
|
768
|
+
* @property {StorePrioritySchema[]} [store_priority]
|
|
769
|
+
* @property {string[]} [sort]
|
|
770
|
+
*/
|
|
771
|
+
/**
|
|
772
|
+
* @typedef StoreRuleResponseSchema
|
|
773
|
+
* @property {string} [id]
|
|
774
|
+
* @property {string} [name]
|
|
775
|
+
* @property {string} [type]
|
|
776
|
+
* @property {string[]} [type_based_priority]
|
|
777
|
+
* @property {string[]} [tag_based_priority]
|
|
778
|
+
* @property {StorePrioritySchema[]} [store_priority]
|
|
779
|
+
* @property {string[]} [sort]
|
|
915
780
|
* @property {StoreRuleConditionSchema} [conditions]
|
|
916
|
-
* @property {boolean} [is_active]
|
|
917
|
-
*/
|
|
918
|
-
/**
|
|
919
|
-
* @typedef
|
|
920
|
-
* @property {string} [id]
|
|
921
|
-
* @property {string} [name]
|
|
922
|
-
* @property {string} [type]
|
|
923
|
-
* @property {string[]} [type_based_priority]
|
|
924
|
-
*
|
|
925
|
-
* @property {
|
|
926
|
-
*
|
|
927
|
-
* @property {StorePrioritySchema[]} [store_priority] - Priority of explicit
|
|
928
|
-
* stores to be used for sorting of stores.
|
|
929
|
-
* @property {string[]} [sort] - Criteria on which the selected stores should be sorted.
|
|
781
|
+
* @property {boolean} [is_active]
|
|
782
|
+
*/
|
|
783
|
+
/**
|
|
784
|
+
* @typedef StoreRuleUpdateResponseSchema
|
|
785
|
+
* @property {string} [id]
|
|
786
|
+
* @property {string} [name]
|
|
787
|
+
* @property {string} [type]
|
|
788
|
+
* @property {string[]} [type_based_priority]
|
|
789
|
+
* @property {string[]} [tag_based_priority]
|
|
790
|
+
* @property {StorePrioritySchema[]} [store_priority]
|
|
791
|
+
* @property {string[]} [sort]
|
|
930
792
|
* @property {StoreRuleConditionSchema} [conditions]
|
|
931
|
-
* @property {boolean} [is_active]
|
|
932
|
-
* @property {number} [company_id]
|
|
933
|
-
* @property {string} [application_id]
|
|
793
|
+
* @property {boolean} [is_active]
|
|
794
|
+
* @property {number} [company_id]
|
|
795
|
+
* @property {string} [application_id]
|
|
934
796
|
*/
|
|
935
797
|
/**
|
|
936
798
|
* @typedef ServiceabilityModel
|
|
937
799
|
* @property {number} lm_cod_limit
|
|
938
800
|
* @property {boolean} is_qc
|
|
939
|
-
* @property {string}
|
|
940
|
-
* @property {string}
|
|
801
|
+
* @property {string} pickup_cutoff
|
|
802
|
+
* @property {string} route_code
|
|
941
803
|
* @property {boolean} is_first_mile
|
|
942
804
|
* @property {boolean} is_return
|
|
943
805
|
* @property {boolean} is_installation
|
|
@@ -966,136 +828,112 @@ export = ServiceabilityPlatformModel;
|
|
|
966
828
|
*/
|
|
967
829
|
/**
|
|
968
830
|
* @typedef CourierPartnerSchemeModel
|
|
969
|
-
* @property {string}
|
|
970
|
-
* @property {string}
|
|
971
|
-
* @property {string} scheme_id - Unique identifier of courier partner scheme.
|
|
972
|
-
* @property {ArithmeticOperations} [volumetric_weight]
|
|
831
|
+
* @property {string} extension_id
|
|
832
|
+
* @property {string} scheme_id
|
|
973
833
|
* @property {ArithmeticOperations} weight
|
|
974
|
-
* @property {string} transport_type
|
|
975
|
-
*
|
|
976
|
-
* @property {string}
|
|
977
|
-
*
|
|
978
|
-
* @property {string}
|
|
979
|
-
* courier partner scheme.
|
|
980
|
-
* @property {string[]} payment_mode - Mode of payment associated with the
|
|
981
|
-
* courier partner scheme.
|
|
982
|
-
* @property {string} stage - Denotes whether the courier partner scheme is in
|
|
983
|
-
* enabled or disabled stage.
|
|
834
|
+
* @property {string} transport_type
|
|
835
|
+
* @property {string} region
|
|
836
|
+
* @property {string} delivery_type
|
|
837
|
+
* @property {string[]} payment_mode
|
|
838
|
+
* @property {string} stage
|
|
984
839
|
* @property {CourierPartnerSchemeFeatures} feature
|
|
985
840
|
*/
|
|
986
841
|
/**
|
|
987
|
-
* @typedef
|
|
988
|
-
* @property {
|
|
989
|
-
* @property {string}
|
|
990
|
-
* @property {
|
|
991
|
-
*
|
|
992
|
-
* @property {
|
|
993
|
-
* @property {
|
|
994
|
-
* @property {string} stage - Denotes whether the account is in enabled or disabled stage.
|
|
995
|
-
* @property {boolean} is_own_account - Denotes whether it is the seller's own
|
|
996
|
-
* account or not.
|
|
997
|
-
* @property {CourierPartnerSchemeModel} [scheme_rules]
|
|
842
|
+
* @typedef CourierAccountResponse
|
|
843
|
+
* @property {string} account_id
|
|
844
|
+
* @property {string} scheme_id
|
|
845
|
+
* @property {boolean} is_self_ship
|
|
846
|
+
* @property {string} stage
|
|
847
|
+
* @property {boolean} is_own_account
|
|
848
|
+
* @property {CourierPartnerSchemeModel} scheme_rules
|
|
998
849
|
*/
|
|
999
850
|
/**
|
|
1000
|
-
* @typedef
|
|
1001
|
-
* @property {
|
|
851
|
+
* @typedef CompanyCourierPartnerAccountListResponse
|
|
852
|
+
* @property {CourierAccountResponse[]} items
|
|
1002
853
|
* @property {Page} page
|
|
1003
854
|
*/
|
|
1004
855
|
/**
|
|
1005
856
|
* @typedef PackageMaterial
|
|
1006
|
-
* @property {string} name
|
|
1007
|
-
* @property {number} width
|
|
1008
|
-
* @property {number} height
|
|
1009
|
-
* @property {number} length
|
|
1010
|
-
* @property {PackageMaterialRule[]} [rules]
|
|
1011
|
-
*
|
|
1012
|
-
* @property {number
|
|
1013
|
-
* @property {number}
|
|
1014
|
-
* @property {
|
|
1015
|
-
* @property {string}
|
|
1016
|
-
* @property {string}
|
|
1017
|
-
* @property {
|
|
1018
|
-
* @property {
|
|
1019
|
-
* @property {
|
|
1020
|
-
*
|
|
1021
|
-
* @property {
|
|
1022
|
-
*
|
|
1023
|
-
|
|
1024
|
-
|
|
1025
|
-
*
|
|
1026
|
-
* @property {
|
|
1027
|
-
*
|
|
1028
|
-
|
|
1029
|
-
|
|
1030
|
-
* @
|
|
1031
|
-
* @property {
|
|
1032
|
-
* @property {
|
|
1033
|
-
* @property {number
|
|
1034
|
-
*
|
|
1035
|
-
* @property {number}
|
|
1036
|
-
* @property {
|
|
1037
|
-
* @property {
|
|
1038
|
-
* @property {
|
|
1039
|
-
* @property {
|
|
1040
|
-
*
|
|
1041
|
-
* @property {
|
|
1042
|
-
* @property {number}
|
|
1043
|
-
* @property {number}
|
|
1044
|
-
* @property {
|
|
1045
|
-
* @property {string} size - Physical size of the packaging.
|
|
1046
|
-
* @property {string[]} [media] - Image urls associated with the packaging material.
|
|
1047
|
-
* @property {Channel[]} channels - Sales channel where packaging is applicable.
|
|
1048
|
-
* @property {boolean} [track_inventory] - Denotes if the track of the inventory
|
|
1049
|
-
* should be kept.
|
|
1050
|
-
* @property {string} status - Current status of the packaging material, if it
|
|
1051
|
-
* is active or inactive.
|
|
1052
|
-
* @property {number} [max_weight] - Maximum weight holding capacity.
|
|
1053
|
-
* @property {number} [package_vol_weight] - Volumetric weight that a packaging
|
|
1054
|
-
* material can carry.
|
|
1055
|
-
* @property {boolean} [auto_calculate] - Denotes whether the volumetric weight
|
|
1056
|
-
* should be auto calculated or not.
|
|
857
|
+
* @property {string} name
|
|
858
|
+
* @property {number} width
|
|
859
|
+
* @property {number} height
|
|
860
|
+
* @property {number} length
|
|
861
|
+
* @property {PackageMaterialRule[]} [rules]
|
|
862
|
+
* @property {number[]} store_ids
|
|
863
|
+
* @property {number} weight
|
|
864
|
+
* @property {number} error_rate
|
|
865
|
+
* @property {string} package_type
|
|
866
|
+
* @property {string} size
|
|
867
|
+
* @property {string[]} [media]
|
|
868
|
+
* @property {Channel[]} channels
|
|
869
|
+
* @property {boolean} [track_inventory]
|
|
870
|
+
* @property {string} status
|
|
871
|
+
* @property {number} [max_weight]
|
|
872
|
+
* @property {number} [package_vol_weight]
|
|
873
|
+
* @property {boolean} [auto_calculate]
|
|
874
|
+
*/
|
|
875
|
+
/**
|
|
876
|
+
* @typedef PackageMaterialResponse
|
|
877
|
+
* @property {string} name
|
|
878
|
+
* @property {string} [id]
|
|
879
|
+
* @property {number} [item_id]
|
|
880
|
+
* @property {number} width
|
|
881
|
+
* @property {number} height
|
|
882
|
+
* @property {number} length
|
|
883
|
+
* @property {PackageMaterialRule[]} [rules]
|
|
884
|
+
* @property {number[]} store_ids
|
|
885
|
+
* @property {number} weight
|
|
886
|
+
* @property {number} error_rate
|
|
887
|
+
* @property {string} package_type
|
|
888
|
+
* @property {string} size
|
|
889
|
+
* @property {string[]} [media]
|
|
890
|
+
* @property {Channel[]} channels
|
|
891
|
+
* @property {boolean} [track_inventory]
|
|
892
|
+
* @property {string} status
|
|
893
|
+
* @property {number} [max_weight]
|
|
894
|
+
* @property {number} [package_vol_weight]
|
|
895
|
+
* @property {boolean} [auto_calculate]
|
|
1057
896
|
*/
|
|
1058
897
|
/**
|
|
1059
898
|
* @typedef PackageMaterialRule
|
|
1060
|
-
* @property {string} [rule_id]
|
|
899
|
+
* @property {string} [rule_id]
|
|
1061
900
|
* @property {PackageMaterialRuleQuantity} [quantity]
|
|
1062
|
-
* @property {number} [weight]
|
|
901
|
+
* @property {number} [weight]
|
|
1063
902
|
*/
|
|
1064
903
|
/**
|
|
1065
904
|
* @typedef PackageRule
|
|
1066
|
-
* @property {string} name
|
|
1067
|
-
* @property {number} company_id
|
|
1068
|
-
* @property {string} type
|
|
1069
|
-
* @property {boolean} [is_active]
|
|
905
|
+
* @property {string} name
|
|
906
|
+
* @property {number} company_id
|
|
907
|
+
* @property {string} type
|
|
908
|
+
* @property {boolean} [is_active]
|
|
1070
909
|
* @property {PackageRuleProductTag} [product_tag]
|
|
1071
910
|
* @property {PackageRuleProduct} [product_id]
|
|
1072
911
|
* @property {PackageRuleCategory} [category_id]
|
|
1073
912
|
*/
|
|
1074
913
|
/**
|
|
1075
|
-
* @typedef
|
|
1076
|
-
* @property {string} [id]
|
|
1077
|
-
* @property {string} name
|
|
1078
|
-
* @property {number} company_id
|
|
1079
|
-
*
|
|
1080
|
-
* @property {
|
|
1081
|
-
* @property {boolean} [is_active] - Denotes if the rule is active or inactive.
|
|
914
|
+
* @typedef PackageRuleResponse
|
|
915
|
+
* @property {string} [id]
|
|
916
|
+
* @property {string} name
|
|
917
|
+
* @property {number} company_id
|
|
918
|
+
* @property {string} type
|
|
919
|
+
* @property {boolean} [is_active]
|
|
1082
920
|
* @property {PackageRuleProductTag} [product_tag]
|
|
1083
921
|
* @property {PackageRuleProduct} [product_id]
|
|
1084
922
|
* @property {PackageRuleCategory} [category_id]
|
|
1085
923
|
*/
|
|
1086
924
|
/**
|
|
1087
925
|
* @typedef Channel
|
|
1088
|
-
* @property {string} [type]
|
|
1089
|
-
* @property {string} [id]
|
|
926
|
+
* @property {string} [type]
|
|
927
|
+
* @property {string} [id]
|
|
1090
928
|
*/
|
|
1091
929
|
/**
|
|
1092
930
|
* @typedef PackageMaterialRuleList
|
|
1093
|
-
* @property {
|
|
931
|
+
* @property {PackageRuleResponse} [items]
|
|
1094
932
|
* @property {Page} [page]
|
|
1095
933
|
*/
|
|
1096
934
|
/**
|
|
1097
935
|
* @typedef PackageMaterialList
|
|
1098
|
-
* @property {
|
|
936
|
+
* @property {PackageMaterialResponse} [items]
|
|
1099
937
|
* @property {Page} [page]
|
|
1100
938
|
*/
|
|
1101
939
|
/**
|
|
@@ -1112,18 +950,17 @@ export = ServiceabilityPlatformModel;
|
|
|
1112
950
|
*/
|
|
1113
951
|
/**
|
|
1114
952
|
* @typedef PackageMaterialRuleQuantity
|
|
1115
|
-
* @property {number} [min]
|
|
1116
|
-
* @property {number} [max]
|
|
953
|
+
* @property {number} [min]
|
|
954
|
+
* @property {number} [max]
|
|
1117
955
|
*/
|
|
1118
956
|
/**
|
|
1119
|
-
* @typedef
|
|
1120
|
-
* @property {string} rule_id
|
|
1121
|
-
* @property {number} priority
|
|
957
|
+
* @typedef RulePriorityRequest
|
|
958
|
+
* @property {string} rule_id
|
|
959
|
+
* @property {number} priority
|
|
1122
960
|
*/
|
|
1123
961
|
/**
|
|
1124
|
-
* @typedef
|
|
1125
|
-
* @property {boolean} [success]
|
|
1126
|
-
* changes successfully or not.
|
|
962
|
+
* @typedef RulePriorityResponse
|
|
963
|
+
* @property {boolean} [success]
|
|
1127
964
|
*/
|
|
1128
965
|
/**
|
|
1129
966
|
* @typedef ArticleAssignment
|
|
@@ -1150,7 +987,7 @@ export = ServiceabilityPlatformModel;
|
|
|
1150
987
|
* @typedef OptimalLocationsArticles
|
|
1151
988
|
* @property {number} item_id
|
|
1152
989
|
* @property {string} size
|
|
1153
|
-
* @property {
|
|
990
|
+
* @property {string} quantity
|
|
1154
991
|
* @property {string} [group_id]
|
|
1155
992
|
* @property {boolean} [is_primary_item]
|
|
1156
993
|
* @property {Object} [meta]
|
|
@@ -1160,15 +997,15 @@ export = ServiceabilityPlatformModel;
|
|
|
1160
997
|
* @property {number} [seller_id]
|
|
1161
998
|
*/
|
|
1162
999
|
/**
|
|
1163
|
-
* @typedef
|
|
1000
|
+
* @typedef OptimlLocationsRequestSchema
|
|
1164
1001
|
* @property {string} channel_id
|
|
1165
1002
|
* @property {string} channel_type
|
|
1166
1003
|
* @property {string} [channel_identifier]
|
|
1167
1004
|
* @property {LocationDetailsServiceability} to_serviceability
|
|
1168
|
-
* @property {OptimalLocationsArticles
|
|
1005
|
+
* @property {OptimalLocationsArticles} [article]
|
|
1169
1006
|
*/
|
|
1170
1007
|
/**
|
|
1171
|
-
* @typedef
|
|
1008
|
+
* @typedef OptimalLocationArticlesResponse
|
|
1172
1009
|
* @property {number} item_id
|
|
1173
1010
|
* @property {string} size
|
|
1174
1011
|
* @property {number} quantity
|
|
@@ -1185,37 +1022,28 @@ export = ServiceabilityPlatformModel;
|
|
|
1185
1022
|
* @property {string} uid
|
|
1186
1023
|
*/
|
|
1187
1024
|
/**
|
|
1188
|
-
* @typedef
|
|
1025
|
+
* @typedef OptimalLocationAssignedStoresResponse
|
|
1189
1026
|
* @property {number} store_id
|
|
1190
|
-
* @property {
|
|
1191
|
-
*/
|
|
1192
|
-
/**
|
|
1193
|
-
* @typedef OptimalLocationsResult
|
|
1194
|
-
* @property {OptimalLocationAssignedStoresResult[]} assigned_stores
|
|
1195
|
-
* @property {ErrorResult[]} [faulty_articles]
|
|
1196
|
-
*/
|
|
1197
|
-
/**
|
|
1198
|
-
* @typedef ValidationError
|
|
1199
|
-
* @property {string} message - A brief description of the error encountered.
|
|
1200
|
-
* @property {string} field - The field in the request that caused the error.
|
|
1027
|
+
* @property {OptimalLocationArticlesResponse[]} articles
|
|
1201
1028
|
*/
|
|
1202
1029
|
/**
|
|
1203
|
-
* @typedef
|
|
1204
|
-
* @property {
|
|
1030
|
+
* @typedef OptimalLocationsResponse
|
|
1031
|
+
* @property {OptimalLocationAssignedStoresResponse[]} assigned_stores
|
|
1032
|
+
* @property {ErrorResponse[]} [faulty_articles]
|
|
1205
1033
|
*/
|
|
1206
1034
|
declare class ServiceabilityPlatformModel {
|
|
1207
1035
|
}
|
|
1208
1036
|
declare namespace ServiceabilityPlatformModel {
|
|
1209
|
-
export {
|
|
1037
|
+
export { UpdateZoneConfigRequest, ServiceabilityErrorResponse, ApplicationServiceabilityConfig, ApplicationServiceabilityConfigResponse, EntityRegionView_Request, EntityRegionView_Error, EntityRegionView_page, getAppRegionZonesResponse, PageSchema, EntityRegionView_Items, EntityRegionView_Response, ListViewSummary, ZoneDataItem, ListViewProduct, ListViewChannels, ListViewItems, ListViewResponse, CompanyStoreView_PageItems, CompanyStoreView_Response, GetZoneDataViewChannels, ZoneProductTypes, ZoneMappingDetailType, ZoneMappingType, ZoneMappingRegions, UpdateZoneData, ZoneUpdateRequest, ZoneSuccessResponse, GetZoneDataViewItems, GetSingleZoneDataViewResponse, GetZoneByIdSchema, CreateZoneData, ZoneResponse, GetZoneFromPincodeViewRequest, Zone, GetZoneFromPincodeViewResponse, GetZoneFromApplicationIdViewResponse, ServiceabilityPageResponse, MobileNo, ManagerResponse, ModifiedByResponse, IntegrationTypeResponse, ProductReturnConfigResponse, ContactNumberResponse, AddressResponse, CreatedByResponse, EwayBillResponse, EinvoiceResponse, GstCredentialsResponse, WarningsResponse, OpeningClosing, TimmingResponse, DocumentsResponse, Dp, LogisticsResponse, ItemResponse, GetStoresViewResponse, PincodeMopData, PincodeMopUpdateResponse, PincodeMOPresponse, CommonError, PincodeMopBulkData, PincodeBulkViewResponse, PincodeCodStatusListingRequest, PincodeCodStatusListingResponse, Error, PincodeCodStatusListingPage, PincodeCodStatusListingSummary, PincodeMopUpdateAuditHistoryRequest, PincodeMopUpdateAuditHistoryPaging, PincodeMopUpdateAuditHistoryResponse, PincodeMopUpdateAuditHistoryResponseData, ArithmeticOperations, SchemeRulesFeatures, SchemeRules, CourierAccount, CourierAccountRequestBody, ErrorResponse, CourierPartnerAccountFailureResponse, Page, CourierPartnerRuleCPListResponse, CourierPartnerRuleResponse, CourierPartnerList, LocationRuleValues, LocationRule, StringComparisonOperations, IntComparisonOperations, CourierPartnerRuleConditions, CourierPartnerRule, FailureResponse, CourierPartnerRulesListResponse, CompanyConfig, ZoneConfig, ApplicationConfig, BulkRegionJobSerializer, BulkRegionResponseItemData, BulkRegionResponse, SelfShipResponse, ApplicationSelfShipConfig, ApplicationSelfShipConfigResponse, StoreRuleConfigData, CustomerRadiusSchema, StoreRuleConditionSchema, StoreRuleDataSchema, StorePrioritySchema, GetStoreRulesApiResponse, CreateStoreRuleRequestSchema, StoreRuleResponseSchema, StoreRuleUpdateResponseSchema, ServiceabilityModel, CourierPartnerSchemeFeatures, CourierPartnerSchemeModel, CourierAccountResponse, CompanyCourierPartnerAccountListResponse, PackageMaterial, PackageMaterialResponse, PackageMaterialRule, PackageRule, PackageRuleResponse, Channel, PackageMaterialRuleList, PackageMaterialList, PackageRuleProduct, PackageRuleProductTag, PackageRuleCategory, PackageMaterialRuleQuantity, RulePriorityRequest, RulePriorityResponse, ArticleAssignment, ServiceabilityLocation, LocationDetailsServiceability, OptimalLocationsArticles, OptimlLocationsRequestSchema, OptimalLocationArticlesResponse, OptimalLocationAssignedStoresResponse, OptimalLocationsResponse };
|
|
1210
1038
|
}
|
|
1211
|
-
/** @returns {
|
|
1212
|
-
declare function
|
|
1213
|
-
type
|
|
1039
|
+
/** @returns {UpdateZoneConfigRequest} */
|
|
1040
|
+
declare function UpdateZoneConfigRequest(): UpdateZoneConfigRequest;
|
|
1041
|
+
type UpdateZoneConfigRequest = {
|
|
1214
1042
|
serviceability_type?: string;
|
|
1215
1043
|
};
|
|
1216
|
-
/** @returns {
|
|
1217
|
-
declare function
|
|
1218
|
-
type
|
|
1044
|
+
/** @returns {ServiceabilityErrorResponse} */
|
|
1045
|
+
declare function ServiceabilityErrorResponse(): ServiceabilityErrorResponse;
|
|
1046
|
+
type ServiceabilityErrorResponse = {
|
|
1219
1047
|
message: string;
|
|
1220
1048
|
value: string;
|
|
1221
1049
|
type: string;
|
|
@@ -1227,16 +1055,16 @@ type ApplicationServiceabilityConfig = {
|
|
|
1227
1055
|
serviceability_type: string;
|
|
1228
1056
|
channel_type: string;
|
|
1229
1057
|
};
|
|
1230
|
-
/** @returns {
|
|
1231
|
-
declare function
|
|
1232
|
-
type
|
|
1233
|
-
error?:
|
|
1058
|
+
/** @returns {ApplicationServiceabilityConfigResponse} */
|
|
1059
|
+
declare function ApplicationServiceabilityConfigResponse(): ApplicationServiceabilityConfigResponse;
|
|
1060
|
+
type ApplicationServiceabilityConfigResponse = {
|
|
1061
|
+
error?: ServiceabilityErrorResponse;
|
|
1234
1062
|
data?: ApplicationServiceabilityConfig;
|
|
1235
1063
|
success: boolean;
|
|
1236
1064
|
};
|
|
1237
|
-
/** @returns {
|
|
1238
|
-
declare function
|
|
1239
|
-
type
|
|
1065
|
+
/** @returns {EntityRegionView_Request} */
|
|
1066
|
+
declare function EntityRegionView_Request(): EntityRegionView_Request;
|
|
1067
|
+
type EntityRegionView_Request = {
|
|
1240
1068
|
sub_type: string[];
|
|
1241
1069
|
parent_id?: string[];
|
|
1242
1070
|
};
|
|
@@ -1256,9 +1084,9 @@ type EntityRegionView_page = {
|
|
|
1256
1084
|
size: number;
|
|
1257
1085
|
current: number;
|
|
1258
1086
|
};
|
|
1259
|
-
/** @returns {
|
|
1260
|
-
declare function
|
|
1261
|
-
type
|
|
1087
|
+
/** @returns {getAppRegionZonesResponse} */
|
|
1088
|
+
declare function getAppRegionZonesResponse(): getAppRegionZonesResponse;
|
|
1089
|
+
type getAppRegionZonesResponse = {
|
|
1262
1090
|
page: PageSchema[];
|
|
1263
1091
|
items: ListViewItems[];
|
|
1264
1092
|
};
|
|
@@ -1278,9 +1106,9 @@ type EntityRegionView_Items = {
|
|
|
1278
1106
|
uid: string;
|
|
1279
1107
|
name: string;
|
|
1280
1108
|
};
|
|
1281
|
-
/** @returns {
|
|
1282
|
-
declare function
|
|
1283
|
-
type
|
|
1109
|
+
/** @returns {EntityRegionView_Response} */
|
|
1110
|
+
declare function EntityRegionView_Response(): EntityRegionView_Response;
|
|
1111
|
+
type EntityRegionView_Response = {
|
|
1284
1112
|
error: EntityRegionView_Error;
|
|
1285
1113
|
page: EntityRegionView_page;
|
|
1286
1114
|
data: EntityRegionView_Items[];
|
|
@@ -1357,9 +1185,9 @@ type ListViewItems = {
|
|
|
1357
1185
|
*/
|
|
1358
1186
|
channels: ListViewChannels[];
|
|
1359
1187
|
};
|
|
1360
|
-
/** @returns {
|
|
1361
|
-
declare function
|
|
1362
|
-
type
|
|
1188
|
+
/** @returns {ListViewResponse} */
|
|
1189
|
+
declare function ListViewResponse(): ListViewResponse;
|
|
1190
|
+
type ListViewResponse = {
|
|
1363
1191
|
page: ZoneDataItem;
|
|
1364
1192
|
items: ListViewItems[];
|
|
1365
1193
|
};
|
|
@@ -1372,9 +1200,9 @@ type CompanyStoreView_PageItems = {
|
|
|
1372
1200
|
size: number;
|
|
1373
1201
|
current: number;
|
|
1374
1202
|
};
|
|
1375
|
-
/** @returns {
|
|
1376
|
-
declare function
|
|
1377
|
-
type
|
|
1203
|
+
/** @returns {CompanyStoreView_Response} */
|
|
1204
|
+
declare function CompanyStoreView_Response(): CompanyStoreView_Response;
|
|
1205
|
+
type CompanyStoreView_Response = {
|
|
1378
1206
|
page: CompanyStoreView_PageItems[];
|
|
1379
1207
|
items?: any[];
|
|
1380
1208
|
};
|
|
@@ -1387,14 +1215,7 @@ type GetZoneDataViewChannels = {
|
|
|
1387
1215
|
/** @returns {ZoneProductTypes} */
|
|
1388
1216
|
declare function ZoneProductTypes(): ZoneProductTypes;
|
|
1389
1217
|
type ZoneProductTypes = {
|
|
1390
|
-
/**
|
|
1391
|
-
* - Denotes if the zone is applicable for all the
|
|
1392
|
-
* products or specific products.
|
|
1393
|
-
*/
|
|
1394
1218
|
type: string;
|
|
1395
|
-
/**
|
|
1396
|
-
* - List of product tags.
|
|
1397
|
-
*/
|
|
1398
1219
|
tags: string[];
|
|
1399
1220
|
};
|
|
1400
1221
|
/** @returns {ZoneMappingDetailType} */
|
|
@@ -1412,13 +1233,7 @@ type ZoneMappingDetailType = {
|
|
|
1412
1233
|
/** @returns {ZoneMappingType} */
|
|
1413
1234
|
declare function ZoneMappingType(): ZoneMappingType;
|
|
1414
1235
|
type ZoneMappingType = {
|
|
1415
|
-
/**
|
|
1416
|
-
* - Uid for the country.
|
|
1417
|
-
*/
|
|
1418
1236
|
country: string;
|
|
1419
|
-
/**
|
|
1420
|
-
* - List of region uid for the given country.
|
|
1421
|
-
*/
|
|
1422
1237
|
regions: string[];
|
|
1423
1238
|
};
|
|
1424
1239
|
/** @returns {ZoneMappingRegions} */
|
|
@@ -1445,208 +1260,89 @@ type ZoneMappingRegions = {
|
|
|
1445
1260
|
/** @returns {UpdateZoneData} */
|
|
1446
1261
|
declare function UpdateZoneData(): UpdateZoneData;
|
|
1447
1262
|
type UpdateZoneData = {
|
|
1448
|
-
/**
|
|
1449
|
-
* - Unique identifier for the zone.
|
|
1450
|
-
*/
|
|
1451
1263
|
zone_id: string;
|
|
1452
|
-
/**
|
|
1453
|
-
* - Name for the zone.
|
|
1454
|
-
*/
|
|
1455
1264
|
name: string;
|
|
1456
|
-
/**
|
|
1457
|
-
* - A human-readable and unique identifier for the
|
|
1458
|
-
* zone, derived from the name.
|
|
1459
|
-
*/
|
|
1460
1265
|
slug: string;
|
|
1461
|
-
/**
|
|
1462
|
-
* - Company id associated with the zone.
|
|
1463
|
-
*/
|
|
1464
1266
|
company_id: number;
|
|
1465
|
-
/**
|
|
1466
|
-
* - A flag indicating whether the zone is active.
|
|
1467
|
-
*/
|
|
1468
1267
|
is_active: boolean;
|
|
1469
|
-
/**
|
|
1470
|
-
* - Channels for which the zone is active.
|
|
1471
|
-
*/
|
|
1472
1268
|
channels: GetZoneDataViewChannels[];
|
|
1473
1269
|
product: ZoneProductTypes;
|
|
1474
|
-
/**
|
|
1475
|
-
* - A list of store identifiers associated with the zone.
|
|
1476
|
-
*/
|
|
1477
1270
|
store_ids: number[];
|
|
1478
|
-
/**
|
|
1479
|
-
* - Type of region that belongs in the zone.
|
|
1480
|
-
*/
|
|
1481
1271
|
region_type: string;
|
|
1482
|
-
/**
|
|
1483
|
-
* - Country to region mapping for the zone.
|
|
1484
|
-
*/
|
|
1485
1272
|
mapping: ZoneMappingType[];
|
|
1486
1273
|
};
|
|
1487
|
-
/** @returns {
|
|
1488
|
-
declare function
|
|
1489
|
-
type
|
|
1274
|
+
/** @returns {ZoneUpdateRequest} */
|
|
1275
|
+
declare function ZoneUpdateRequest(): ZoneUpdateRequest;
|
|
1276
|
+
type ZoneUpdateRequest = {
|
|
1490
1277
|
identifier: string;
|
|
1491
1278
|
data: UpdateZoneData;
|
|
1492
1279
|
};
|
|
1493
|
-
/** @returns {
|
|
1494
|
-
declare function
|
|
1495
|
-
type
|
|
1280
|
+
/** @returns {ZoneSuccessResponse} */
|
|
1281
|
+
declare function ZoneSuccessResponse(): ZoneSuccessResponse;
|
|
1282
|
+
type ZoneSuccessResponse = {
|
|
1496
1283
|
status_code: number;
|
|
1497
1284
|
success: boolean;
|
|
1498
1285
|
};
|
|
1499
1286
|
/** @returns {GetZoneDataViewItems} */
|
|
1500
1287
|
declare function GetZoneDataViewItems(): GetZoneDataViewItems;
|
|
1501
1288
|
type GetZoneDataViewItems = {
|
|
1502
|
-
/**
|
|
1503
|
-
* - The unique identifier for the zone.
|
|
1504
|
-
*/
|
|
1505
1289
|
zone_id: string;
|
|
1506
|
-
/**
|
|
1507
|
-
* - The name of the zone for easy identification.
|
|
1508
|
-
*/
|
|
1509
1290
|
name: string;
|
|
1510
|
-
/**
|
|
1511
|
-
* - A URL-friendly version of the zone’s name, used for
|
|
1512
|
-
* routing or linking.
|
|
1513
|
-
*/
|
|
1514
1291
|
slug: string;
|
|
1515
|
-
/**
|
|
1516
|
-
* - The ID of the company associated with this zone.
|
|
1517
|
-
*/
|
|
1518
1292
|
company_id?: number;
|
|
1519
|
-
/**
|
|
1520
|
-
* - A flag indicating whether the zone is active
|
|
1521
|
-
* (true) or inactive (false).
|
|
1522
|
-
*/
|
|
1523
1293
|
is_active: boolean;
|
|
1524
|
-
/**
|
|
1525
|
-
* - A list of channels available
|
|
1526
|
-
* within this zone.
|
|
1527
|
-
*/
|
|
1528
1294
|
channels: GetZoneDataViewChannels[];
|
|
1529
1295
|
product: ZoneProductTypes;
|
|
1530
|
-
/**
|
|
1531
|
-
* - A collection of store IDs linked to this zone.
|
|
1532
|
-
*/
|
|
1533
1296
|
store_ids: number[];
|
|
1534
|
-
/**
|
|
1535
|
-
* - The type of region the zone represents.
|
|
1536
|
-
*/
|
|
1537
1297
|
region_type?: string;
|
|
1538
|
-
/**
|
|
1539
|
-
* - A list of mappings defining
|
|
1540
|
-
* relationships between this zone and other entities.
|
|
1541
|
-
*/
|
|
1542
1298
|
mapping: ZoneMappingType[];
|
|
1543
|
-
/**
|
|
1544
|
-
* - The preferred method for
|
|
1545
|
-
* assigning stores or products to the zone.
|
|
1546
|
-
*/
|
|
1547
|
-
assignment_preference?: string;
|
|
1548
|
-
/**
|
|
1549
|
-
* - The total number of stores assigned to this zone.
|
|
1550
|
-
*/
|
|
1551
1299
|
stores_count: number;
|
|
1552
1300
|
};
|
|
1553
|
-
/** @returns {
|
|
1554
|
-
declare function
|
|
1555
|
-
type
|
|
1301
|
+
/** @returns {GetSingleZoneDataViewResponse} */
|
|
1302
|
+
declare function GetSingleZoneDataViewResponse(): GetSingleZoneDataViewResponse;
|
|
1303
|
+
type GetSingleZoneDataViewResponse = {
|
|
1556
1304
|
data: GetZoneDataViewItems;
|
|
1557
1305
|
};
|
|
1558
1306
|
/** @returns {GetZoneByIdSchema} */
|
|
1559
1307
|
declare function GetZoneByIdSchema(): GetZoneByIdSchema;
|
|
1560
1308
|
type GetZoneByIdSchema = {
|
|
1561
|
-
/**
|
|
1562
|
-
* - Unique identifier for the zone.
|
|
1563
|
-
*/
|
|
1564
1309
|
zone_id: string;
|
|
1565
|
-
/**
|
|
1566
|
-
* - Name for the zone.
|
|
1567
|
-
*/
|
|
1568
1310
|
name: string;
|
|
1569
|
-
/**
|
|
1570
|
-
* - A human-readable and unique identifier for the
|
|
1571
|
-
* zone, derived from the name.
|
|
1572
|
-
*/
|
|
1573
1311
|
slug: string;
|
|
1574
|
-
/**
|
|
1575
|
-
* - Company id associated with the zone.
|
|
1576
|
-
*/
|
|
1577
1312
|
company_id?: number;
|
|
1578
|
-
/**
|
|
1579
|
-
* - A flag indicating whether the zone is active.
|
|
1580
|
-
*/
|
|
1581
1313
|
is_active: boolean;
|
|
1582
|
-
/**
|
|
1583
|
-
* - Channels for which the zone is active.
|
|
1584
|
-
*/
|
|
1585
1314
|
channels: GetZoneDataViewChannels[];
|
|
1586
1315
|
product: ZoneProductTypes;
|
|
1587
|
-
/**
|
|
1588
|
-
* - A list of store identifiers associated with the zone.
|
|
1589
|
-
*/
|
|
1590
1316
|
store_ids: number[];
|
|
1591
|
-
/**
|
|
1592
|
-
* - Type of region that belongs in the zone.
|
|
1593
|
-
*/
|
|
1594
1317
|
region_type: string;
|
|
1595
1318
|
/**
|
|
1596
1319
|
* - Country to region mapping for the zone.
|
|
1597
1320
|
*/
|
|
1598
1321
|
mapping: ZoneMappingDetailType[];
|
|
1599
|
-
stores_count?: number;
|
|
1600
1322
|
};
|
|
1601
1323
|
/** @returns {CreateZoneData} */
|
|
1602
1324
|
declare function CreateZoneData(): CreateZoneData;
|
|
1603
1325
|
type CreateZoneData = {
|
|
1604
|
-
/**
|
|
1605
|
-
* - Name of the zone.
|
|
1606
|
-
*/
|
|
1607
1326
|
name: string;
|
|
1608
|
-
/**
|
|
1609
|
-
* - A human-readable and unique identifier for the
|
|
1610
|
-
* zone, derived from the name.
|
|
1611
|
-
*/
|
|
1612
1327
|
slug: string;
|
|
1613
|
-
/**
|
|
1614
|
-
* - Unique identifier of the company for which
|
|
1615
|
-
* the zone is created.
|
|
1616
|
-
*/
|
|
1617
1328
|
company_id: number;
|
|
1618
|
-
/**
|
|
1619
|
-
* - A flag indicating whether the zone is active.
|
|
1620
|
-
*/
|
|
1621
1329
|
is_active: boolean;
|
|
1622
|
-
/**
|
|
1623
|
-
* - Channels for which the zone is active.
|
|
1624
|
-
*/
|
|
1625
1330
|
channels: GetZoneDataViewChannels[];
|
|
1626
|
-
/**
|
|
1627
|
-
* - A list of store identifiers associated with the zone.
|
|
1628
|
-
*/
|
|
1629
1331
|
store_ids: number[];
|
|
1630
|
-
|
|
1631
|
-
* - Type of region that belongs in the zone.
|
|
1632
|
-
*/
|
|
1332
|
+
product: ZoneProductTypes;
|
|
1633
1333
|
region_type: string;
|
|
1634
|
-
/**
|
|
1635
|
-
* - Country to region mapping for the zone.
|
|
1636
|
-
*/
|
|
1637
1334
|
mapping: ZoneMappingType[];
|
|
1638
|
-
product?: ZoneProductTypes;
|
|
1639
1335
|
};
|
|
1640
|
-
/** @returns {
|
|
1641
|
-
declare function
|
|
1642
|
-
type
|
|
1643
|
-
status_code
|
|
1336
|
+
/** @returns {ZoneResponse} */
|
|
1337
|
+
declare function ZoneResponse(): ZoneResponse;
|
|
1338
|
+
type ZoneResponse = {
|
|
1339
|
+
status_code: number;
|
|
1644
1340
|
zone_id: string;
|
|
1645
1341
|
success: boolean;
|
|
1646
1342
|
};
|
|
1647
|
-
/** @returns {
|
|
1648
|
-
declare function
|
|
1649
|
-
type
|
|
1343
|
+
/** @returns {GetZoneFromPincodeViewRequest} */
|
|
1344
|
+
declare function GetZoneFromPincodeViewRequest(): GetZoneFromPincodeViewRequest;
|
|
1345
|
+
type GetZoneFromPincodeViewRequest = {
|
|
1650
1346
|
country: string;
|
|
1651
1347
|
pincode: string;
|
|
1652
1348
|
};
|
|
@@ -1661,21 +1357,21 @@ type Zone = {
|
|
|
1661
1357
|
is_active: boolean;
|
|
1662
1358
|
store_ids: number[];
|
|
1663
1359
|
};
|
|
1664
|
-
/** @returns {
|
|
1665
|
-
declare function
|
|
1666
|
-
type
|
|
1360
|
+
/** @returns {GetZoneFromPincodeViewResponse} */
|
|
1361
|
+
declare function GetZoneFromPincodeViewResponse(): GetZoneFromPincodeViewResponse;
|
|
1362
|
+
type GetZoneFromPincodeViewResponse = {
|
|
1667
1363
|
serviceability_type: string;
|
|
1668
1364
|
zones: Zone[];
|
|
1669
1365
|
};
|
|
1670
|
-
/** @returns {
|
|
1671
|
-
declare function
|
|
1672
|
-
type
|
|
1366
|
+
/** @returns {GetZoneFromApplicationIdViewResponse} */
|
|
1367
|
+
declare function GetZoneFromApplicationIdViewResponse(): GetZoneFromApplicationIdViewResponse;
|
|
1368
|
+
type GetZoneFromApplicationIdViewResponse = {
|
|
1673
1369
|
page: ZoneDataItem[];
|
|
1674
1370
|
items: ListViewItems[];
|
|
1675
1371
|
};
|
|
1676
|
-
/** @returns {
|
|
1677
|
-
declare function
|
|
1678
|
-
type
|
|
1372
|
+
/** @returns {ServiceabilityPageResponse} */
|
|
1373
|
+
declare function ServiceabilityPageResponse(): ServiceabilityPageResponse;
|
|
1374
|
+
type ServiceabilityPageResponse = {
|
|
1679
1375
|
type?: string;
|
|
1680
1376
|
has_next?: boolean;
|
|
1681
1377
|
item_total?: number;
|
|
@@ -1688,39 +1384,39 @@ type MobileNo = {
|
|
|
1688
1384
|
number?: string;
|
|
1689
1385
|
country_code?: number;
|
|
1690
1386
|
};
|
|
1691
|
-
/** @returns {
|
|
1692
|
-
declare function
|
|
1693
|
-
type
|
|
1387
|
+
/** @returns {ManagerResponse} */
|
|
1388
|
+
declare function ManagerResponse(): ManagerResponse;
|
|
1389
|
+
type ManagerResponse = {
|
|
1694
1390
|
email?: string;
|
|
1695
1391
|
mobile_no?: MobileNo;
|
|
1696
1392
|
name?: string;
|
|
1697
1393
|
};
|
|
1698
|
-
/** @returns {
|
|
1699
|
-
declare function
|
|
1700
|
-
type
|
|
1394
|
+
/** @returns {ModifiedByResponse} */
|
|
1395
|
+
declare function ModifiedByResponse(): ModifiedByResponse;
|
|
1396
|
+
type ModifiedByResponse = {
|
|
1701
1397
|
username?: string;
|
|
1702
1398
|
user_id?: string;
|
|
1703
1399
|
};
|
|
1704
|
-
/** @returns {
|
|
1705
|
-
declare function
|
|
1706
|
-
type
|
|
1400
|
+
/** @returns {IntegrationTypeResponse} */
|
|
1401
|
+
declare function IntegrationTypeResponse(): IntegrationTypeResponse;
|
|
1402
|
+
type IntegrationTypeResponse = {
|
|
1707
1403
|
inventory?: string;
|
|
1708
1404
|
order?: string;
|
|
1709
1405
|
};
|
|
1710
|
-
/** @returns {
|
|
1711
|
-
declare function
|
|
1712
|
-
type
|
|
1406
|
+
/** @returns {ProductReturnConfigResponse} */
|
|
1407
|
+
declare function ProductReturnConfigResponse(): ProductReturnConfigResponse;
|
|
1408
|
+
type ProductReturnConfigResponse = {
|
|
1713
1409
|
on_same_store?: boolean;
|
|
1714
1410
|
};
|
|
1715
|
-
/** @returns {
|
|
1716
|
-
declare function
|
|
1717
|
-
type
|
|
1411
|
+
/** @returns {ContactNumberResponse} */
|
|
1412
|
+
declare function ContactNumberResponse(): ContactNumberResponse;
|
|
1413
|
+
type ContactNumberResponse = {
|
|
1718
1414
|
number?: string;
|
|
1719
1415
|
country_code?: number;
|
|
1720
1416
|
};
|
|
1721
|
-
/** @returns {
|
|
1722
|
-
declare function
|
|
1723
|
-
type
|
|
1417
|
+
/** @returns {AddressResponse} */
|
|
1418
|
+
declare function AddressResponse(): AddressResponse;
|
|
1419
|
+
type AddressResponse = {
|
|
1724
1420
|
city?: string;
|
|
1725
1421
|
address1?: string;
|
|
1726
1422
|
pincode?: number;
|
|
@@ -1731,31 +1427,31 @@ type AddressResult = {
|
|
|
1731
1427
|
latitude?: number;
|
|
1732
1428
|
longitude?: number;
|
|
1733
1429
|
};
|
|
1734
|
-
/** @returns {
|
|
1735
|
-
declare function
|
|
1736
|
-
type
|
|
1430
|
+
/** @returns {CreatedByResponse} */
|
|
1431
|
+
declare function CreatedByResponse(): CreatedByResponse;
|
|
1432
|
+
type CreatedByResponse = {
|
|
1737
1433
|
username?: string;
|
|
1738
1434
|
user_id?: string;
|
|
1739
1435
|
};
|
|
1740
|
-
/** @returns {
|
|
1741
|
-
declare function
|
|
1742
|
-
type
|
|
1436
|
+
/** @returns {EwayBillResponse} */
|
|
1437
|
+
declare function EwayBillResponse(): EwayBillResponse;
|
|
1438
|
+
type EwayBillResponse = {
|
|
1743
1439
|
enabled?: boolean;
|
|
1744
1440
|
};
|
|
1745
|
-
/** @returns {
|
|
1746
|
-
declare function
|
|
1747
|
-
type
|
|
1441
|
+
/** @returns {EinvoiceResponse} */
|
|
1442
|
+
declare function EinvoiceResponse(): EinvoiceResponse;
|
|
1443
|
+
type EinvoiceResponse = {
|
|
1748
1444
|
enabled?: boolean;
|
|
1749
1445
|
};
|
|
1750
|
-
/** @returns {
|
|
1751
|
-
declare function
|
|
1752
|
-
type
|
|
1753
|
-
e_waybill?:
|
|
1754
|
-
e_invoice?:
|
|
1446
|
+
/** @returns {GstCredentialsResponse} */
|
|
1447
|
+
declare function GstCredentialsResponse(): GstCredentialsResponse;
|
|
1448
|
+
type GstCredentialsResponse = {
|
|
1449
|
+
e_waybill?: EwayBillResponse;
|
|
1450
|
+
e_invoice?: EinvoiceResponse;
|
|
1755
1451
|
};
|
|
1756
|
-
/** @returns {
|
|
1757
|
-
declare function
|
|
1758
|
-
type
|
|
1452
|
+
/** @returns {WarningsResponse} */
|
|
1453
|
+
declare function WarningsResponse(): WarningsResponse;
|
|
1454
|
+
type WarningsResponse = {
|
|
1759
1455
|
store_address?: string;
|
|
1760
1456
|
};
|
|
1761
1457
|
/** @returns {OpeningClosing} */
|
|
@@ -1764,17 +1460,17 @@ type OpeningClosing = {
|
|
|
1764
1460
|
minute?: number;
|
|
1765
1461
|
hour?: number;
|
|
1766
1462
|
};
|
|
1767
|
-
/** @returns {
|
|
1768
|
-
declare function
|
|
1769
|
-
type
|
|
1463
|
+
/** @returns {TimmingResponse} */
|
|
1464
|
+
declare function TimmingResponse(): TimmingResponse;
|
|
1465
|
+
type TimmingResponse = {
|
|
1770
1466
|
open?: boolean;
|
|
1771
1467
|
weekday?: string;
|
|
1772
1468
|
closing?: OpeningClosing;
|
|
1773
1469
|
opening?: OpeningClosing;
|
|
1774
1470
|
};
|
|
1775
|
-
/** @returns {
|
|
1776
|
-
declare function
|
|
1777
|
-
type
|
|
1471
|
+
/** @returns {DocumentsResponse} */
|
|
1472
|
+
declare function DocumentsResponse(): DocumentsResponse;
|
|
1473
|
+
type DocumentsResponse = {
|
|
1778
1474
|
legal_name?: string;
|
|
1779
1475
|
value?: string;
|
|
1780
1476
|
type?: string;
|
|
@@ -1794,207 +1490,110 @@ type Dp = {
|
|
|
1794
1490
|
transport_mode?: string;
|
|
1795
1491
|
assign_dp_from_sb?: boolean;
|
|
1796
1492
|
};
|
|
1797
|
-
/** @returns {
|
|
1798
|
-
declare function
|
|
1799
|
-
type
|
|
1493
|
+
/** @returns {LogisticsResponse} */
|
|
1494
|
+
declare function LogisticsResponse(): LogisticsResponse;
|
|
1495
|
+
type LogisticsResponse = {
|
|
1800
1496
|
override?: boolean;
|
|
1801
1497
|
dp?: Dp;
|
|
1802
1498
|
};
|
|
1803
|
-
/** @returns {
|
|
1804
|
-
declare function
|
|
1805
|
-
type
|
|
1499
|
+
/** @returns {ItemResponse} */
|
|
1500
|
+
declare function ItemResponse(): ItemResponse;
|
|
1501
|
+
type ItemResponse = {
|
|
1806
1502
|
created_on?: string;
|
|
1807
|
-
manager?:
|
|
1808
|
-
modified_by?:
|
|
1809
|
-
integration_type?:
|
|
1503
|
+
manager?: ManagerResponse;
|
|
1504
|
+
modified_by?: ModifiedByResponse;
|
|
1505
|
+
integration_type?: IntegrationTypeResponse;
|
|
1810
1506
|
verified_on?: string;
|
|
1811
|
-
product_return_config?:
|
|
1812
|
-
contact_numbers?:
|
|
1813
|
-
verified_by?:
|
|
1507
|
+
product_return_config?: ProductReturnConfigResponse;
|
|
1508
|
+
contact_numbers?: ContactNumberResponse[];
|
|
1509
|
+
verified_by?: ModifiedByResponse;
|
|
1814
1510
|
stage?: string;
|
|
1815
|
-
address?:
|
|
1511
|
+
address?: AddressResponse;
|
|
1816
1512
|
modified_on?: string;
|
|
1817
|
-
created_by?:
|
|
1818
|
-
gst_credentials?:
|
|
1513
|
+
created_by?: CreatedByResponse;
|
|
1514
|
+
gst_credentials?: GstCredentialsResponse;
|
|
1819
1515
|
display_name?: string;
|
|
1820
1516
|
company_id?: number;
|
|
1821
1517
|
uid?: number;
|
|
1822
|
-
/**
|
|
1823
|
-
* - Custom JSON for internal usage
|
|
1824
|
-
*/
|
|
1825
1518
|
_custom_json?: any;
|
|
1826
1519
|
code?: string;
|
|
1827
|
-
warnings?:
|
|
1520
|
+
warnings?: WarningsResponse;
|
|
1828
1521
|
name?: string;
|
|
1829
|
-
timing?:
|
|
1830
|
-
documents?:
|
|
1522
|
+
timing?: TimmingResponse[];
|
|
1523
|
+
documents?: DocumentsResponse[];
|
|
1831
1524
|
store_type?: string;
|
|
1832
1525
|
sub_type?: string;
|
|
1833
1526
|
company?: number;
|
|
1834
1527
|
_cls?: string;
|
|
1835
|
-
logistics?:
|
|
1528
|
+
logistics?: LogisticsResponse;
|
|
1836
1529
|
notification_emails?: string[];
|
|
1837
1530
|
};
|
|
1838
|
-
/** @returns {
|
|
1839
|
-
declare function
|
|
1840
|
-
type
|
|
1841
|
-
page:
|
|
1842
|
-
items?:
|
|
1531
|
+
/** @returns {GetStoresViewResponse} */
|
|
1532
|
+
declare function GetStoresViewResponse(): GetStoresViewResponse;
|
|
1533
|
+
type GetStoresViewResponse = {
|
|
1534
|
+
page: ServiceabilityPageResponse;
|
|
1535
|
+
items?: ItemResponse[];
|
|
1843
1536
|
};
|
|
1844
1537
|
/** @returns {PincodeMopData} */
|
|
1845
1538
|
declare function PincodeMopData(): PincodeMopData;
|
|
1846
1539
|
type PincodeMopData = {
|
|
1847
|
-
/**
|
|
1848
|
-
* - A list of pincodes.
|
|
1849
|
-
*/
|
|
1850
1540
|
pincodes: number[];
|
|
1851
|
-
/**
|
|
1852
|
-
* - Name of the country.
|
|
1853
|
-
*/
|
|
1854
1541
|
country: string;
|
|
1855
|
-
/**
|
|
1856
|
-
* - Denotes wether to activate or deavtivate pincodes
|
|
1857
|
-
* for COD mode of payment.
|
|
1858
|
-
*/
|
|
1859
1542
|
action: string;
|
|
1860
1543
|
};
|
|
1861
|
-
/** @returns {
|
|
1862
|
-
declare function
|
|
1863
|
-
type
|
|
1864
|
-
/**
|
|
1865
|
-
* - Pincode of the region.
|
|
1866
|
-
*/
|
|
1544
|
+
/** @returns {PincodeMopUpdateResponse} */
|
|
1545
|
+
declare function PincodeMopUpdateResponse(): PincodeMopUpdateResponse;
|
|
1546
|
+
type PincodeMopUpdateResponse = {
|
|
1867
1547
|
pincode: number;
|
|
1868
|
-
/**
|
|
1869
|
-
* - Unique identifier of the sales channel.
|
|
1870
|
-
*/
|
|
1871
1548
|
channel_id: string;
|
|
1872
|
-
/**
|
|
1873
|
-
* - Country name.
|
|
1874
|
-
*/
|
|
1875
1549
|
country: string;
|
|
1876
|
-
/**
|
|
1877
|
-
* - Denotes whether the pincode mode of payment
|
|
1878
|
-
* is active or not.
|
|
1879
|
-
*/
|
|
1880
1550
|
is_active: boolean;
|
|
1881
1551
|
};
|
|
1882
|
-
/** @returns {
|
|
1883
|
-
declare function
|
|
1884
|
-
type
|
|
1885
|
-
/**
|
|
1886
|
-
* - Denotes if the action was successful or not.
|
|
1887
|
-
*/
|
|
1552
|
+
/** @returns {PincodeMOPresponse} */
|
|
1553
|
+
declare function PincodeMOPresponse(): PincodeMOPresponse;
|
|
1554
|
+
type PincodeMOPresponse = {
|
|
1888
1555
|
success: boolean;
|
|
1889
|
-
/**
|
|
1890
|
-
* - Status code for the response.
|
|
1891
|
-
*/
|
|
1892
1556
|
status_code: number;
|
|
1893
|
-
/**
|
|
1894
|
-
* - Unique identifier identifying the perticular request.
|
|
1895
|
-
*/
|
|
1896
1557
|
batch_id: string;
|
|
1897
|
-
/**
|
|
1898
|
-
* - Name of the country.
|
|
1899
|
-
*/
|
|
1900
1558
|
country: string;
|
|
1901
|
-
/**
|
|
1902
|
-
* - Denotes wether to activate or deavtivate pincodes
|
|
1903
|
-
* for COD mode of payment.
|
|
1904
|
-
*/
|
|
1905
1559
|
action: string;
|
|
1906
|
-
/**
|
|
1907
|
-
* - List of pincodes.
|
|
1908
|
-
*/
|
|
1909
1560
|
pincodes?: number[];
|
|
1910
|
-
|
|
1911
|
-
* - Details of the
|
|
1912
|
-
* updated pincodes.
|
|
1913
|
-
*/
|
|
1914
|
-
updated_pincodes?: PincodeMopUpdateResult[];
|
|
1561
|
+
updated_pincodes?: PincodeMopUpdateResponse[];
|
|
1915
1562
|
};
|
|
1916
1563
|
/** @returns {CommonError} */
|
|
1917
1564
|
declare function CommonError(): CommonError;
|
|
1918
1565
|
type CommonError = {
|
|
1919
|
-
/**
|
|
1920
|
-
* - Status code for the error.
|
|
1921
|
-
*/
|
|
1922
1566
|
status_code?: string;
|
|
1923
1567
|
error?: any;
|
|
1924
|
-
/**
|
|
1925
|
-
* - Whether operation was successful.
|
|
1926
|
-
*/
|
|
1927
1568
|
success?: string;
|
|
1928
1569
|
};
|
|
1929
1570
|
/** @returns {PincodeMopBulkData} */
|
|
1930
1571
|
declare function PincodeMopBulkData(): PincodeMopBulkData;
|
|
1931
1572
|
type PincodeMopBulkData = {
|
|
1932
|
-
/**
|
|
1933
|
-
* - Unique identifier for the request.
|
|
1934
|
-
*/
|
|
1935
1573
|
batch_id: string;
|
|
1936
|
-
/**
|
|
1937
|
-
* - CDN url for the uploaded file.
|
|
1938
|
-
*/
|
|
1939
1574
|
s3_url: string;
|
|
1940
1575
|
};
|
|
1941
|
-
/** @returns {
|
|
1942
|
-
declare function
|
|
1943
|
-
type
|
|
1576
|
+
/** @returns {PincodeBulkViewResponse} */
|
|
1577
|
+
declare function PincodeBulkViewResponse(): PincodeBulkViewResponse;
|
|
1578
|
+
type PincodeBulkViewResponse = {
|
|
1944
1579
|
batch_id: string;
|
|
1945
|
-
/**
|
|
1946
|
-
* - CDN url for the uploaded file.
|
|
1947
|
-
*/
|
|
1948
1580
|
s3_url: string;
|
|
1949
1581
|
};
|
|
1950
|
-
/** @returns {
|
|
1951
|
-
declare function
|
|
1952
|
-
type
|
|
1953
|
-
/**
|
|
1954
|
-
* - Name of the country.
|
|
1955
|
-
*/
|
|
1582
|
+
/** @returns {PincodeCodStatusListingRequest} */
|
|
1583
|
+
declare function PincodeCodStatusListingRequest(): PincodeCodStatusListingRequest;
|
|
1584
|
+
type PincodeCodStatusListingRequest = {
|
|
1956
1585
|
country?: string;
|
|
1957
|
-
/**
|
|
1958
|
-
* - Search based on the active or inactive flag.
|
|
1959
|
-
*/
|
|
1960
1586
|
is_active?: boolean;
|
|
1961
|
-
/**
|
|
1962
|
-
* - Search based on the pincode.
|
|
1963
|
-
*/
|
|
1964
1587
|
pincode?: number;
|
|
1965
1588
|
current?: number;
|
|
1966
1589
|
page_size?: number;
|
|
1967
1590
|
};
|
|
1968
|
-
/** @returns {
|
|
1969
|
-
declare function
|
|
1970
|
-
type
|
|
1971
|
-
/**
|
|
1972
|
-
* - Denoted if the pincode is active or not.
|
|
1973
|
-
*/
|
|
1974
|
-
active?: boolean;
|
|
1975
|
-
/**
|
|
1976
|
-
* - Name of the pincode.
|
|
1977
|
-
*/
|
|
1978
|
-
pincode?: string;
|
|
1979
|
-
};
|
|
1980
|
-
/** @returns {PincodeCodStatusListingResult} */
|
|
1981
|
-
declare function PincodeCodStatusListingResult(): PincodeCodStatusListingResult;
|
|
1982
|
-
type PincodeCodStatusListingResult = {
|
|
1983
|
-
/**
|
|
1984
|
-
* - Name of the country.
|
|
1985
|
-
*/
|
|
1591
|
+
/** @returns {PincodeCodStatusListingResponse} */
|
|
1592
|
+
declare function PincodeCodStatusListingResponse(): PincodeCodStatusListingResponse;
|
|
1593
|
+
type PincodeCodStatusListingResponse = {
|
|
1986
1594
|
country: string;
|
|
1987
|
-
|
|
1988
|
-
* - List of pincode details.
|
|
1989
|
-
*/
|
|
1990
|
-
data: PincodeCodStatusListingResult[];
|
|
1991
|
-
/**
|
|
1992
|
-
* - Denotes if the request was successful or not.
|
|
1993
|
-
*/
|
|
1595
|
+
data: PincodeCodStatusListingResponse[];
|
|
1994
1596
|
success: boolean;
|
|
1995
|
-
/**
|
|
1996
|
-
* - List of error object in case of unsuccessful response.
|
|
1997
|
-
*/
|
|
1998
1597
|
errors?: Error[];
|
|
1999
1598
|
page: PincodeCodStatusListingPage;
|
|
2000
1599
|
summary: PincodeCodStatusListingSummary;
|
|
@@ -2018,25 +1617,13 @@ type PincodeCodStatusListingPage = {
|
|
|
2018
1617
|
/** @returns {PincodeCodStatusListingSummary} */
|
|
2019
1618
|
declare function PincodeCodStatusListingSummary(): PincodeCodStatusListingSummary;
|
|
2020
1619
|
type PincodeCodStatusListingSummary = {
|
|
2021
|
-
/**
|
|
2022
|
-
* - Count of the total active pincodes.
|
|
2023
|
-
*/
|
|
2024
1620
|
total_active_pincodes: number;
|
|
2025
|
-
/**
|
|
2026
|
-
* - Count of the total inactive pincodes.
|
|
2027
|
-
*/
|
|
2028
1621
|
total_inactive_pincodes: number;
|
|
2029
1622
|
};
|
|
2030
|
-
/** @returns {
|
|
2031
|
-
declare function
|
|
2032
|
-
type
|
|
2033
|
-
/**
|
|
2034
|
-
* - Type of the entity requested.
|
|
2035
|
-
*/
|
|
1623
|
+
/** @returns {PincodeMopUpdateAuditHistoryRequest} */
|
|
1624
|
+
declare function PincodeMopUpdateAuditHistoryRequest(): PincodeMopUpdateAuditHistoryRequest;
|
|
1625
|
+
type PincodeMopUpdateAuditHistoryRequest = {
|
|
2036
1626
|
entity_type: string;
|
|
2037
|
-
/**
|
|
2038
|
-
* - Name of the file.
|
|
2039
|
-
*/
|
|
2040
1627
|
file_name?: string;
|
|
2041
1628
|
};
|
|
2042
1629
|
/** @returns {PincodeMopUpdateAuditHistoryPaging} */
|
|
@@ -2048,49 +1635,24 @@ type PincodeMopUpdateAuditHistoryPaging = {
|
|
|
2048
1635
|
has_next?: boolean;
|
|
2049
1636
|
item_total?: number;
|
|
2050
1637
|
};
|
|
2051
|
-
/** @returns {
|
|
2052
|
-
declare function
|
|
2053
|
-
type
|
|
2054
|
-
/**
|
|
2055
|
-
* - Uniquie identifier of the request.
|
|
2056
|
-
*/
|
|
1638
|
+
/** @returns {PincodeMopUpdateAuditHistoryResponse} */
|
|
1639
|
+
declare function PincodeMopUpdateAuditHistoryResponse(): PincodeMopUpdateAuditHistoryResponse;
|
|
1640
|
+
type PincodeMopUpdateAuditHistoryResponse = {
|
|
2057
1641
|
batch_id?: string;
|
|
2058
|
-
/**
|
|
2059
|
-
* - Type of the entity requested.
|
|
2060
|
-
*/
|
|
2061
1642
|
entity_type?: string;
|
|
2062
|
-
/**
|
|
2063
|
-
* - URL for the error file.
|
|
2064
|
-
*/
|
|
2065
1643
|
error_file_s3_url?: string;
|
|
2066
|
-
/**
|
|
2067
|
-
* - CDN url for the file uploaded.
|
|
2068
|
-
*/
|
|
2069
1644
|
s3_url?: string;
|
|
2070
|
-
/**
|
|
2071
|
-
* - Name of the file.
|
|
2072
|
-
*/
|
|
2073
1645
|
file_name?: string;
|
|
2074
1646
|
updated_at?: string;
|
|
2075
1647
|
updated_by?: string;
|
|
2076
|
-
/**
|
|
2077
|
-
* - Denotes if the request was successfully processed.
|
|
2078
|
-
*/
|
|
2079
1648
|
success?: boolean;
|
|
2080
1649
|
};
|
|
2081
|
-
/** @returns {
|
|
2082
|
-
declare function
|
|
2083
|
-
type
|
|
2084
|
-
/**
|
|
2085
|
-
* - Type of the entity requested.
|
|
2086
|
-
*/
|
|
1650
|
+
/** @returns {PincodeMopUpdateAuditHistoryResponseData} */
|
|
1651
|
+
declare function PincodeMopUpdateAuditHistoryResponseData(): PincodeMopUpdateAuditHistoryResponseData;
|
|
1652
|
+
type PincodeMopUpdateAuditHistoryResponseData = {
|
|
2087
1653
|
entity_type?: string;
|
|
2088
1654
|
page: PincodeMopUpdateAuditHistoryPaging;
|
|
2089
|
-
|
|
2090
|
-
* - History records of
|
|
2091
|
-
* the uploaded files.
|
|
2092
|
-
*/
|
|
2093
|
-
data: PincodeMopUpdateAuditHistoryResult[];
|
|
1655
|
+
data: PincodeMopUpdateAuditHistoryResponse[];
|
|
2094
1656
|
};
|
|
2095
1657
|
/** @returns {ArithmeticOperations} */
|
|
2096
1658
|
declare function ArithmeticOperations(): ArithmeticOperations;
|
|
@@ -2120,120 +1682,38 @@ type SchemeRules = {
|
|
|
2120
1682
|
payment_mode?: string[];
|
|
2121
1683
|
feature?: SchemeRulesFeatures;
|
|
2122
1684
|
};
|
|
2123
|
-
/** @returns {CourierAccountUpdateDetails} */
|
|
2124
|
-
declare function CourierAccountUpdateDetails(): CourierAccountUpdateDetails;
|
|
2125
|
-
type CourierAccountUpdateDetails = {
|
|
2126
|
-
/**
|
|
2127
|
-
* - Unique identifier of courier partner extension.
|
|
2128
|
-
*/
|
|
2129
|
-
extension_id: string;
|
|
2130
|
-
/**
|
|
2131
|
-
* - Unique identifier of courier partner scheme.
|
|
2132
|
-
*/
|
|
2133
|
-
scheme_id: string;
|
|
2134
|
-
/**
|
|
2135
|
-
* - Denotes if the account is of self delivery type.
|
|
2136
|
-
*/
|
|
2137
|
-
is_self_ship: boolean;
|
|
2138
|
-
/**
|
|
2139
|
-
* - Denotes whether the account is in enabled or disabled stage.
|
|
2140
|
-
*/
|
|
2141
|
-
stage: string;
|
|
2142
|
-
/**
|
|
2143
|
-
* - Denotes whether it is the seller's own
|
|
2144
|
-
* account or not.
|
|
2145
|
-
*/
|
|
2146
|
-
is_own_account: boolean;
|
|
2147
|
-
};
|
|
2148
1685
|
/** @returns {CourierAccount} */
|
|
2149
1686
|
declare function CourierAccount(): CourierAccount;
|
|
2150
1687
|
type CourierAccount = {
|
|
2151
|
-
/**
|
|
2152
|
-
* - Company id associated with the account.
|
|
2153
|
-
*/
|
|
2154
|
-
company_id: number;
|
|
2155
|
-
/**
|
|
2156
|
-
* - Unique identifier of courier partner extension.
|
|
2157
|
-
*/
|
|
2158
1688
|
extension_id: string;
|
|
2159
|
-
/**
|
|
2160
|
-
* - Unique identifier of courier partner scheme
|
|
2161
|
-
* and company id combination.
|
|
2162
|
-
*/
|
|
2163
1689
|
account_id: string;
|
|
2164
|
-
/**
|
|
2165
|
-
* - Unique identifier of courier partner scheme.
|
|
2166
|
-
*/
|
|
2167
1690
|
scheme_id: string;
|
|
2168
|
-
/**
|
|
2169
|
-
* - Denotes if the account is of self delivery type.
|
|
2170
|
-
*/
|
|
2171
1691
|
is_self_ship: boolean;
|
|
2172
|
-
/**
|
|
2173
|
-
* - Denotes whether the account is in enabled or disabled stage.
|
|
2174
|
-
*/
|
|
2175
1692
|
stage: string;
|
|
2176
|
-
/**
|
|
2177
|
-
* - Denotes whether it is the seller's own
|
|
2178
|
-
* account or not.
|
|
2179
|
-
*/
|
|
2180
1693
|
is_own_account: boolean;
|
|
2181
|
-
scheme_rules: CourierPartnerSchemeModel;
|
|
2182
1694
|
};
|
|
2183
|
-
/** @returns {
|
|
2184
|
-
declare function
|
|
2185
|
-
type
|
|
2186
|
-
/**
|
|
2187
|
-
* - Unique identifier of courier partner extension.
|
|
2188
|
-
*/
|
|
1695
|
+
/** @returns {CourierAccountRequestBody} */
|
|
1696
|
+
declare function CourierAccountRequestBody(): CourierAccountRequestBody;
|
|
1697
|
+
type CourierAccountRequestBody = {
|
|
2189
1698
|
extension_id: string;
|
|
2190
|
-
/**
|
|
2191
|
-
* - Unique identifier of courier partner scheme
|
|
2192
|
-
* and company id combination.
|
|
2193
|
-
*/
|
|
2194
1699
|
account_id?: string;
|
|
2195
|
-
/**
|
|
2196
|
-
* - Unique identifier of courier partner scheme.
|
|
2197
|
-
*/
|
|
2198
1700
|
scheme_id: string;
|
|
2199
|
-
/**
|
|
2200
|
-
* - Denotes if the account is of self delivery type.
|
|
2201
|
-
*/
|
|
2202
1701
|
is_self_ship: boolean;
|
|
2203
|
-
/**
|
|
2204
|
-
* - Denotes whether the account is in enabled or disabled stage.
|
|
2205
|
-
*/
|
|
2206
1702
|
stage: string;
|
|
2207
|
-
/**
|
|
2208
|
-
* - Denotes whether it is the seller's own
|
|
2209
|
-
* account or not.
|
|
2210
|
-
*/
|
|
2211
1703
|
is_own_account: boolean;
|
|
2212
1704
|
};
|
|
2213
|
-
/** @returns {
|
|
2214
|
-
declare function
|
|
2215
|
-
type
|
|
2216
|
-
/**
|
|
2217
|
-
* - Fields containing the error.
|
|
2218
|
-
*/
|
|
1705
|
+
/** @returns {ErrorResponse} */
|
|
1706
|
+
declare function ErrorResponse(): ErrorResponse;
|
|
1707
|
+
type ErrorResponse = {
|
|
2219
1708
|
value: string;
|
|
2220
|
-
/**
|
|
2221
|
-
* - Description of the error.
|
|
2222
|
-
*/
|
|
2223
1709
|
message: string;
|
|
2224
|
-
/**
|
|
2225
|
-
* - Type of the error.
|
|
2226
|
-
*/
|
|
2227
1710
|
type: string;
|
|
2228
1711
|
};
|
|
2229
|
-
/** @returns {
|
|
2230
|
-
declare function
|
|
2231
|
-
type
|
|
2232
|
-
/**
|
|
2233
|
-
* - Denotes whether the request is a success or failure.
|
|
2234
|
-
*/
|
|
1712
|
+
/** @returns {CourierPartnerAccountFailureResponse} */
|
|
1713
|
+
declare function CourierPartnerAccountFailureResponse(): CourierPartnerAccountFailureResponse;
|
|
1714
|
+
type CourierPartnerAccountFailureResponse = {
|
|
2235
1715
|
success: boolean;
|
|
2236
|
-
error:
|
|
1716
|
+
error: ErrorResponse[];
|
|
2237
1717
|
};
|
|
2238
1718
|
/** @returns {Page} */
|
|
2239
1719
|
declare function Page(): Page;
|
|
@@ -2267,89 +1747,34 @@ type Page = {
|
|
|
2267
1747
|
*/
|
|
2268
1748
|
size?: number;
|
|
2269
1749
|
};
|
|
2270
|
-
/** @returns {
|
|
2271
|
-
declare function
|
|
2272
|
-
type
|
|
2273
|
-
|
|
2274
|
-
|
|
2275
|
-
|
|
2276
|
-
*/
|
|
2277
|
-
account_id: string;
|
|
2278
|
-
/**
|
|
2279
|
-
* - Unique identifier of courier partner extension.
|
|
2280
|
-
*/
|
|
2281
|
-
extension_id: string;
|
|
2282
|
-
/**
|
|
2283
|
-
* - Denotes if the account is of self delivery type.
|
|
2284
|
-
*/
|
|
2285
|
-
is_self_ship: boolean;
|
|
2286
|
-
/**
|
|
2287
|
-
* - Denotes the scheme rules associated with
|
|
2288
|
-
* the courier partner account.
|
|
2289
|
-
*/
|
|
1750
|
+
/** @returns {CourierPartnerRuleCPListResponse} */
|
|
1751
|
+
declare function CourierPartnerRuleCPListResponse(): CourierPartnerRuleCPListResponse;
|
|
1752
|
+
type CourierPartnerRuleCPListResponse = {
|
|
1753
|
+
account_id?: string;
|
|
1754
|
+
extension_id?: string;
|
|
1755
|
+
is_self_ship?: boolean;
|
|
2290
1756
|
scheme_rules?: any;
|
|
2291
1757
|
};
|
|
2292
|
-
/** @returns {
|
|
2293
|
-
declare function
|
|
2294
|
-
type
|
|
2295
|
-
|
|
2296
|
-
|
|
2297
|
-
|
|
2298
|
-
|
|
2299
|
-
|
|
2300
|
-
/**
|
|
2301
|
-
* - Unique identifier of the sales channel.
|
|
2302
|
-
*/
|
|
2303
|
-
application_id: string;
|
|
2304
|
-
/**
|
|
2305
|
-
* - Unique identifier of the company.
|
|
2306
|
-
*/
|
|
2307
|
-
company_id: number;
|
|
2308
|
-
conditions: CourierPartnerRuleConditions;
|
|
2309
|
-
/**
|
|
2310
|
-
* - Sort Strategy of the courier partners.
|
|
2311
|
-
*/
|
|
2312
|
-
sort: string[];
|
|
2313
|
-
/**
|
|
2314
|
-
* - The Fynd account used to create the courier
|
|
2315
|
-
* partner rule.
|
|
2316
|
-
*/
|
|
1758
|
+
/** @returns {CourierPartnerRuleResponse} */
|
|
1759
|
+
declare function CourierPartnerRuleResponse(): CourierPartnerRuleResponse;
|
|
1760
|
+
type CourierPartnerRuleResponse = {
|
|
1761
|
+
is_active?: boolean;
|
|
1762
|
+
application_id?: string;
|
|
1763
|
+
company_id?: number;
|
|
1764
|
+
conditions?: CourierPartnerRuleConditions;
|
|
1765
|
+
sort?: string[];
|
|
2317
1766
|
created_by?: any;
|
|
2318
|
-
|
|
2319
|
-
* - Unique identifier of the courier partner rule.
|
|
2320
|
-
*/
|
|
2321
|
-
id: string;
|
|
2322
|
-
/**
|
|
2323
|
-
* - The Fynd account used to modify the
|
|
2324
|
-
* courier partner rule.
|
|
2325
|
-
*/
|
|
1767
|
+
id?: string;
|
|
2326
1768
|
modified_by?: any;
|
|
2327
|
-
/**
|
|
2328
|
-
* - The datetime at which courier partner rule
|
|
2329
|
-
* is modified.
|
|
2330
|
-
*/
|
|
2331
1769
|
modified_on?: string;
|
|
2332
|
-
|
|
2333
|
-
|
|
2334
|
-
|
|
2335
|
-
name: string;
|
|
2336
|
-
/**
|
|
2337
|
-
* - The type of the rule.
|
|
2338
|
-
*/
|
|
2339
|
-
type: string;
|
|
2340
|
-
cp_list?: CourierPartnerRuleCPListResult[];
|
|
1770
|
+
name?: string;
|
|
1771
|
+
type?: string;
|
|
1772
|
+
cp_list?: CourierPartnerRuleCPListResponse[];
|
|
2341
1773
|
};
|
|
2342
1774
|
/** @returns {CourierPartnerList} */
|
|
2343
1775
|
declare function CourierPartnerList(): CourierPartnerList;
|
|
2344
1776
|
type CourierPartnerList = {
|
|
2345
|
-
/**
|
|
2346
|
-
* - Unique identifier of courier partner extension.
|
|
2347
|
-
*/
|
|
2348
1777
|
extension_id: string;
|
|
2349
|
-
/**
|
|
2350
|
-
* - Unique identifier of courier partner scheme
|
|
2351
|
-
* and company id combination.
|
|
2352
|
-
*/
|
|
2353
1778
|
account_id: string;
|
|
2354
1779
|
};
|
|
2355
1780
|
/** @returns {LocationRuleValues} */
|
|
@@ -2359,7 +1784,7 @@ type LocationRuleValues = {
|
|
|
2359
1784
|
sub_type?: string;
|
|
2360
1785
|
name?: string;
|
|
2361
1786
|
display_name?: string;
|
|
2362
|
-
parent_id?: string
|
|
1787
|
+
parent_id?: string;
|
|
2363
1788
|
parent_ids?: string[];
|
|
2364
1789
|
};
|
|
2365
1790
|
/** @returns {LocationRule} */
|
|
@@ -2401,383 +1826,97 @@ type CourierPartnerRuleConditions = {
|
|
|
2401
1826
|
/** @returns {CourierPartnerRule} */
|
|
2402
1827
|
declare function CourierPartnerRule(): CourierPartnerRule;
|
|
2403
1828
|
type CourierPartnerRule = {
|
|
2404
|
-
/**
|
|
2405
|
-
* - Denotes whether the given courier partner
|
|
2406
|
-
* rule is inactive or active.
|
|
2407
|
-
*/
|
|
2408
1829
|
is_active: boolean;
|
|
2409
|
-
/**
|
|
2410
|
-
* - A list of courier partners.
|
|
2411
|
-
*/
|
|
2412
1830
|
cp_list?: CourierPartnerList[];
|
|
2413
|
-
/**
|
|
2414
|
-
* - Name for the courier partner rule.
|
|
2415
|
-
*/
|
|
2416
1831
|
name: string;
|
|
2417
1832
|
conditions: CourierPartnerRuleConditions;
|
|
2418
|
-
/**
|
|
2419
|
-
* - Sort Strategy for the courier partners.
|
|
2420
|
-
*/
|
|
2421
1833
|
sort: string[];
|
|
2422
|
-
/**
|
|
2423
|
-
* - Denotes the type of the rule.
|
|
2424
|
-
*/
|
|
2425
|
-
type?: string;
|
|
2426
1834
|
};
|
|
2427
|
-
/** @returns {
|
|
2428
|
-
declare function
|
|
2429
|
-
type
|
|
1835
|
+
/** @returns {FailureResponse} */
|
|
1836
|
+
declare function FailureResponse(): FailureResponse;
|
|
1837
|
+
type FailureResponse = {
|
|
2430
1838
|
success: boolean;
|
|
2431
|
-
error:
|
|
1839
|
+
error: ErrorResponse[];
|
|
2432
1840
|
};
|
|
2433
|
-
/** @returns {
|
|
2434
|
-
declare function
|
|
2435
|
-
type
|
|
2436
|
-
items:
|
|
1841
|
+
/** @returns {CourierPartnerRulesListResponse} */
|
|
1842
|
+
declare function CourierPartnerRulesListResponse(): CourierPartnerRulesListResponse;
|
|
1843
|
+
type CourierPartnerRulesListResponse = {
|
|
1844
|
+
items: CourierPartnerRuleResponse[];
|
|
2437
1845
|
page: Page;
|
|
2438
1846
|
};
|
|
2439
|
-
/** @returns {ShipmentsArticles} */
|
|
2440
|
-
declare function ShipmentsArticles(): ShipmentsArticles;
|
|
2441
|
-
type ShipmentsArticles = {
|
|
2442
|
-
/**
|
|
2443
|
-
* - Unique identifier of the item.
|
|
2444
|
-
*/
|
|
2445
|
-
item_id?: number;
|
|
2446
|
-
/**
|
|
2447
|
-
* - Unique identifier of the category.
|
|
2448
|
-
*/
|
|
2449
|
-
category_id?: number;
|
|
2450
|
-
/**
|
|
2451
|
-
* - Unique identifier of the brand.
|
|
2452
|
-
*/
|
|
2453
|
-
brand_id?: number;
|
|
2454
|
-
/**
|
|
2455
|
-
* - Unique identifier of the department.
|
|
2456
|
-
*/
|
|
2457
|
-
department_id?: number;
|
|
2458
|
-
/**
|
|
2459
|
-
* - Tags associated with the item.
|
|
2460
|
-
*/
|
|
2461
|
-
tags?: string[];
|
|
2462
|
-
};
|
|
2463
|
-
/** @returns {ShipmentDimension} */
|
|
2464
|
-
declare function ShipmentDimension(): ShipmentDimension;
|
|
2465
|
-
type ShipmentDimension = {
|
|
2466
|
-
/**
|
|
2467
|
-
* - Height of the shipment in centimeters.
|
|
2468
|
-
*/
|
|
2469
|
-
height: number;
|
|
2470
|
-
/**
|
|
2471
|
-
* - Length of the shipment in centimeters.
|
|
2472
|
-
*/
|
|
2473
|
-
length: number;
|
|
2474
|
-
/**
|
|
2475
|
-
* - Width of the shipment in centimeters.
|
|
2476
|
-
*/
|
|
2477
|
-
width: number;
|
|
2478
|
-
};
|
|
2479
|
-
/** @returns {Shipments} */
|
|
2480
|
-
declare function Shipments(): Shipments;
|
|
2481
|
-
type Shipments = {
|
|
2482
|
-
/**
|
|
2483
|
-
* - Unique identifier of the shipment.
|
|
2484
|
-
*/
|
|
2485
|
-
id?: string;
|
|
2486
|
-
/**
|
|
2487
|
-
* - Unique identifier of the selling location.
|
|
2488
|
-
*/
|
|
2489
|
-
location_id?: number;
|
|
2490
|
-
/**
|
|
2491
|
-
* - Tags associated with the selling location.
|
|
2492
|
-
*/
|
|
2493
|
-
location_tags?: string[];
|
|
2494
|
-
/**
|
|
2495
|
-
* - Weight of the shipment.
|
|
2496
|
-
*/
|
|
2497
|
-
shipment_weight?: number;
|
|
2498
|
-
/**
|
|
2499
|
-
* - Volumetric weight of the shipment.
|
|
2500
|
-
*/
|
|
2501
|
-
shipment_volumetric_weight?: number;
|
|
2502
|
-
/**
|
|
2503
|
-
* - Total Cost of the shipment.
|
|
2504
|
-
*/
|
|
2505
|
-
shipment_cost?: number;
|
|
2506
|
-
shipment_dimension?: ShipmentDimension;
|
|
2507
|
-
/**
|
|
2508
|
-
* - A List of courier schemes.
|
|
2509
|
-
*/
|
|
2510
|
-
courier_partner_schemes?: string[];
|
|
2511
|
-
/**
|
|
2512
|
-
* - List of articles in the shipment.
|
|
2513
|
-
*/
|
|
2514
|
-
articles?: ShipmentsArticles[];
|
|
2515
|
-
};
|
|
2516
|
-
/** @returns {ShipmentCourierPartnerDetails} */
|
|
2517
|
-
declare function ShipmentCourierPartnerDetails(): ShipmentCourierPartnerDetails;
|
|
2518
|
-
type ShipmentCourierPartnerDetails = {
|
|
2519
|
-
from_location: ShipmentsCourierPartnersServiceability;
|
|
2520
|
-
to_location: ShipmentsCourierPartnersServiceability;
|
|
2521
|
-
/**
|
|
2522
|
-
* - List of shipments.
|
|
2523
|
-
*/
|
|
2524
|
-
shipments?: Shipments[];
|
|
2525
|
-
/**
|
|
2526
|
-
* - Journey type of the shipment forward or return.
|
|
2527
|
-
*/
|
|
2528
|
-
journey?: string;
|
|
2529
|
-
/**
|
|
2530
|
-
* - Payment mode opted for the shipment.
|
|
2531
|
-
*/
|
|
2532
|
-
payment_mode?: string;
|
|
2533
|
-
};
|
|
2534
|
-
/** @returns {CourierPartnerPromise} */
|
|
2535
|
-
declare function CourierPartnerPromise(): CourierPartnerPromise;
|
|
2536
|
-
type CourierPartnerPromise = {
|
|
2537
|
-
/**
|
|
2538
|
-
* - The earliest possible timestamp.
|
|
2539
|
-
*/
|
|
2540
|
-
min: string;
|
|
2541
|
-
/**
|
|
2542
|
-
* - The latest possible timestamp.
|
|
2543
|
-
*/
|
|
2544
|
-
max: string;
|
|
2545
|
-
};
|
|
2546
|
-
/** @returns {CourierPartners} */
|
|
2547
|
-
declare function CourierPartners(): CourierPartners;
|
|
2548
|
-
type CourierPartners = {
|
|
2549
|
-
/**
|
|
2550
|
-
* - Unique identifier of courier partner extension.
|
|
2551
|
-
*/
|
|
2552
|
-
extension_id?: string;
|
|
2553
|
-
/**
|
|
2554
|
-
* - Unique identifier of courier partner scheme.
|
|
2555
|
-
*/
|
|
2556
|
-
scheme_id?: string;
|
|
2557
|
-
/**
|
|
2558
|
-
* - Name of the courier partner.
|
|
2559
|
-
*/
|
|
2560
|
-
name?: string;
|
|
2561
|
-
delivery_promise?: CourierPartnerPromise;
|
|
2562
|
-
};
|
|
2563
|
-
/** @returns {ShipmentCourierPartners} */
|
|
2564
|
-
declare function ShipmentCourierPartners(): ShipmentCourierPartners;
|
|
2565
|
-
type ShipmentCourierPartners = {
|
|
2566
|
-
/**
|
|
2567
|
-
* - Unique identifier of the shipment.
|
|
2568
|
-
*/
|
|
2569
|
-
id?: string;
|
|
2570
|
-
/**
|
|
2571
|
-
* - Courier partners of the shipment.
|
|
2572
|
-
*/
|
|
2573
|
-
courier_partners?: CourierPartners[];
|
|
2574
|
-
};
|
|
2575
|
-
/** @returns {ShipmentCourierPartnerResult} */
|
|
2576
|
-
declare function ShipmentCourierPartnerResult(): ShipmentCourierPartnerResult;
|
|
2577
|
-
type ShipmentCourierPartnerResult = {
|
|
2578
|
-
courier_partners?: CourierPartners[];
|
|
2579
|
-
shipments?: ShipmentCourierPartners[];
|
|
2580
|
-
};
|
|
2581
|
-
/** @returns {ShipmentsCourierPartnersServiceability} */
|
|
2582
|
-
declare function ShipmentsCourierPartnersServiceability(): ShipmentsCourierPartnersServiceability;
|
|
2583
|
-
type ShipmentsCourierPartnersServiceability = {
|
|
2584
|
-
/**
|
|
2585
|
-
* - Postal code or PIN code of the address area.
|
|
2586
|
-
*/
|
|
2587
|
-
pincode?: string;
|
|
2588
|
-
/**
|
|
2589
|
-
* - Specifies the sector or district code of
|
|
2590
|
-
* the address if applicable.
|
|
2591
|
-
*/
|
|
2592
|
-
sector_code?: string;
|
|
2593
|
-
/**
|
|
2594
|
-
* - Indicates the state or province code of the address.
|
|
2595
|
-
*/
|
|
2596
|
-
state_code?: string;
|
|
2597
|
-
/**
|
|
2598
|
-
* - Denote the city or municipality code of the address.
|
|
2599
|
-
*/
|
|
2600
|
-
city_code?: string;
|
|
2601
|
-
/**
|
|
2602
|
-
* - ISO2 code for the country of the address.
|
|
2603
|
-
*/
|
|
2604
|
-
country_code: string;
|
|
2605
|
-
};
|
|
2606
1847
|
/** @returns {CompanyConfig} */
|
|
2607
1848
|
declare function CompanyConfig(): CompanyConfig;
|
|
2608
1849
|
type CompanyConfig = {
|
|
2609
|
-
/**
|
|
2610
|
-
* - A list for courier partner rules.
|
|
2611
|
-
*/
|
|
2612
1850
|
rule_ids: string[];
|
|
2613
|
-
/**
|
|
2614
|
-
* - Sort strategy for the courier partners.
|
|
2615
|
-
*/
|
|
2616
1851
|
sort: string[];
|
|
2617
|
-
|
|
2618
|
-
* - Depicts if the courier partner
|
|
2619
|
-
* rule configuration plan is subscribed by the seller for which mode.
|
|
2620
|
-
*/
|
|
2621
|
-
logistics_as_actual?: string;
|
|
2622
|
-
/**
|
|
2623
|
-
* - Unique identifier of the company.
|
|
2624
|
-
*/
|
|
2625
|
-
company_id: number;
|
|
2626
|
-
/**
|
|
2627
|
-
* - Unique identifier of the sales channel.
|
|
2628
|
-
*/
|
|
2629
|
-
application_id?: string;
|
|
1852
|
+
logistics_as_actual?: boolean;
|
|
2630
1853
|
};
|
|
2631
1854
|
/** @returns {ZoneConfig} */
|
|
2632
1855
|
declare function ZoneConfig(): ZoneConfig;
|
|
2633
1856
|
type ZoneConfig = {
|
|
2634
|
-
/**
|
|
2635
|
-
* - Serviceability type of the delivery zone.
|
|
2636
|
-
*/
|
|
2637
1857
|
serviceability_type?: string;
|
|
2638
|
-
/**
|
|
2639
|
-
* - Count of active delivery zones associated
|
|
2640
|
-
* with the sales channel.
|
|
2641
|
-
*/
|
|
2642
|
-
active_count?: number;
|
|
2643
|
-
/**
|
|
2644
|
-
* - Count of total delivery zones associated
|
|
2645
|
-
* with the sales channel.
|
|
2646
|
-
*/
|
|
2647
|
-
total_count?: number;
|
|
2648
1858
|
};
|
|
2649
1859
|
/** @returns {ApplicationConfig} */
|
|
2650
1860
|
declare function ApplicationConfig(): ApplicationConfig;
|
|
2651
1861
|
type ApplicationConfig = {
|
|
2652
|
-
/**
|
|
2653
|
-
* - A list of courier partner rules.
|
|
2654
|
-
*/
|
|
2655
1862
|
rule_ids?: string[];
|
|
2656
|
-
/**
|
|
2657
|
-
* - Strategy adopted to sort the courier partners.
|
|
2658
|
-
*/
|
|
2659
1863
|
sort?: string[];
|
|
2660
1864
|
zones?: ZoneConfig;
|
|
2661
1865
|
};
|
|
2662
|
-
/** @returns {
|
|
2663
|
-
declare function
|
|
2664
|
-
type
|
|
2665
|
-
/**
|
|
2666
|
-
* - CDN path of the uploaded csv file for bulk import.
|
|
2667
|
-
*/
|
|
1866
|
+
/** @returns {BulkRegionJobSerializer} */
|
|
1867
|
+
declare function BulkRegionJobSerializer(): BulkRegionJobSerializer;
|
|
1868
|
+
type BulkRegionJobSerializer = {
|
|
2668
1869
|
file_path?: string;
|
|
2669
|
-
/**
|
|
2670
|
-
* - Country for which the tat or serviceability is
|
|
2671
|
-
* to be imported or exported.
|
|
2672
|
-
*/
|
|
2673
1870
|
country: string;
|
|
2674
|
-
|
|
2675
|
-
|
|
2676
|
-
|
|
2677
|
-
|
|
2678
|
-
|
|
2679
|
-
|
|
2680
|
-
|
|
2681
|
-
*/
|
|
2682
|
-
region: string;
|
|
2683
|
-
};
|
|
2684
|
-
/** @returns {BulkRegionResultItemData} */
|
|
2685
|
-
declare function BulkRegionResultItemData(): BulkRegionResultItemData;
|
|
2686
|
-
type BulkRegionResultItemData = {
|
|
2687
|
-
/**
|
|
2688
|
-
* - CDN path of the file which was used for bulk import.
|
|
2689
|
-
*/
|
|
2690
|
-
file_path?: string;
|
|
2691
|
-
/**
|
|
2692
|
-
* - Count of the failed records.
|
|
2693
|
-
*/
|
|
1871
|
+
action: string;
|
|
1872
|
+
region: string;
|
|
1873
|
+
};
|
|
1874
|
+
/** @returns {BulkRegionResponseItemData} */
|
|
1875
|
+
declare function BulkRegionResponseItemData(): BulkRegionResponseItemData;
|
|
1876
|
+
type BulkRegionResponseItemData = {
|
|
1877
|
+
file_path: string;
|
|
2694
1878
|
failed?: number;
|
|
2695
1879
|
failed_records?: any[];
|
|
2696
|
-
/**
|
|
2697
|
-
* - Denotes the import or export action performed.
|
|
2698
|
-
*/
|
|
2699
1880
|
action: string;
|
|
2700
|
-
/**
|
|
2701
|
-
* - Unique id to identify the import or export query.
|
|
2702
|
-
*/
|
|
2703
1881
|
batch_id: string;
|
|
2704
|
-
/**
|
|
2705
|
-
* - Country for which the import or export action is
|
|
2706
|
-
* performed.
|
|
2707
|
-
*/
|
|
2708
1882
|
country: string;
|
|
2709
|
-
/**
|
|
2710
|
-
* - Denoted if the import or export was successful
|
|
2711
|
-
* or failure.
|
|
2712
|
-
*/
|
|
2713
1883
|
success?: number;
|
|
2714
|
-
/**
|
|
2715
|
-
* - Region of the country for which import or export
|
|
2716
|
-
* is triggered.
|
|
2717
|
-
*/
|
|
2718
1884
|
region: string;
|
|
2719
|
-
/**
|
|
2720
|
-
* - Current status of the import or export action performed.
|
|
2721
|
-
*/
|
|
2722
1885
|
status: string;
|
|
2723
|
-
/**
|
|
2724
|
-
* - Count of total records.
|
|
2725
|
-
*/
|
|
2726
1886
|
total?: number;
|
|
2727
|
-
/**
|
|
2728
|
-
* - Path of the error file.
|
|
2729
|
-
*/
|
|
2730
1887
|
error_file_path?: string;
|
|
2731
1888
|
};
|
|
2732
|
-
/** @returns {
|
|
2733
|
-
declare function
|
|
2734
|
-
type
|
|
2735
|
-
items:
|
|
1889
|
+
/** @returns {BulkRegionResponse} */
|
|
1890
|
+
declare function BulkRegionResponse(): BulkRegionResponse;
|
|
1891
|
+
type BulkRegionResponse = {
|
|
1892
|
+
items: BulkRegionResponseItemData[];
|
|
2736
1893
|
page: Page;
|
|
2737
1894
|
};
|
|
2738
|
-
/** @returns {
|
|
2739
|
-
declare function
|
|
2740
|
-
type
|
|
1895
|
+
/** @returns {SelfShipResponse} */
|
|
1896
|
+
declare function SelfShipResponse(): SelfShipResponse;
|
|
1897
|
+
type SelfShipResponse = {
|
|
2741
1898
|
is_active: boolean;
|
|
2742
1899
|
tat: number;
|
|
2743
1900
|
};
|
|
2744
1901
|
/** @returns {ApplicationSelfShipConfig} */
|
|
2745
1902
|
declare function ApplicationSelfShipConfig(): ApplicationSelfShipConfig;
|
|
2746
1903
|
type ApplicationSelfShipConfig = {
|
|
2747
|
-
self_ship?:
|
|
1904
|
+
self_ship?: any;
|
|
2748
1905
|
};
|
|
2749
|
-
/** @returns {
|
|
2750
|
-
declare function
|
|
2751
|
-
type
|
|
2752
|
-
error?:
|
|
1906
|
+
/** @returns {ApplicationSelfShipConfigResponse} */
|
|
1907
|
+
declare function ApplicationSelfShipConfigResponse(): ApplicationSelfShipConfigResponse;
|
|
1908
|
+
type ApplicationSelfShipConfigResponse = {
|
|
1909
|
+
error?: ServiceabilityErrorResponse;
|
|
2753
1910
|
data?: ApplicationSelfShipConfig;
|
|
2754
1911
|
success: boolean;
|
|
2755
1912
|
};
|
|
2756
1913
|
/** @returns {StoreRuleConfigData} */
|
|
2757
1914
|
declare function StoreRuleConfigData(): StoreRuleConfigData;
|
|
2758
1915
|
type StoreRuleConfigData = {
|
|
2759
|
-
/**
|
|
2760
|
-
* - List of rule ids which are active in the application.
|
|
2761
|
-
*/
|
|
2762
1916
|
rule_ids?: string[];
|
|
2763
|
-
/**
|
|
2764
|
-
* - Priority of the store type to be
|
|
2765
|
-
* used in the basic prioritization sorting of stores.
|
|
2766
|
-
*/
|
|
2767
1917
|
type_based_priority?: string[];
|
|
2768
|
-
/**
|
|
2769
|
-
* - Priority of the store tags to be
|
|
2770
|
-
* used in the basic prioritization sorting of stores.
|
|
2771
|
-
*/
|
|
2772
1918
|
tag_based_priority?: string[];
|
|
2773
|
-
/**
|
|
2774
|
-
* - Priority of explicit
|
|
2775
|
-
* stores to be used for sorting of stores.
|
|
2776
|
-
*/
|
|
2777
1919
|
store_priority?: StorePrioritySchema[];
|
|
2778
|
-
/**
|
|
2779
|
-
* - Criteria on which the selected stores should be sorted.
|
|
2780
|
-
*/
|
|
2781
1920
|
sort?: string[];
|
|
2782
1921
|
};
|
|
2783
1922
|
/** @returns {CustomerRadiusSchema} */
|
|
@@ -2807,183 +1946,66 @@ type StoreRuleConditionSchema = {
|
|
|
2807
1946
|
/** @returns {StoreRuleDataSchema} */
|
|
2808
1947
|
declare function StoreRuleDataSchema(): StoreRuleDataSchema;
|
|
2809
1948
|
type StoreRuleDataSchema = {
|
|
2810
|
-
/**
|
|
2811
|
-
* - Id of the rule.
|
|
2812
|
-
*/
|
|
2813
1949
|
id?: string;
|
|
2814
|
-
/**
|
|
2815
|
-
* - Name of the rule.
|
|
2816
|
-
*/
|
|
2817
1950
|
name?: string;
|
|
2818
|
-
/**
|
|
2819
|
-
* - Company id for which the rule is created.
|
|
2820
|
-
*/
|
|
2821
1951
|
company_id?: number;
|
|
2822
|
-
/**
|
|
2823
|
-
* - Application id for which the rule is created.
|
|
2824
|
-
*/
|
|
2825
1952
|
application_id?: string;
|
|
2826
|
-
/**
|
|
2827
|
-
* - Priority of the store type to be
|
|
2828
|
-
* used in the basic prioritization sorting of stores.
|
|
2829
|
-
*/
|
|
2830
1953
|
type_based_priority?: string[];
|
|
2831
|
-
/**
|
|
2832
|
-
* - Priority of the store tags to be
|
|
2833
|
-
* used in the basic prioritization sorting of stores.
|
|
2834
|
-
*/
|
|
2835
1954
|
tag_based_priority?: string[];
|
|
2836
|
-
/**
|
|
2837
|
-
* - Priority of explicit
|
|
2838
|
-
* stores to be used for sorting of stores.
|
|
2839
|
-
*/
|
|
2840
1955
|
store_priority?: StorePrioritySchema[];
|
|
2841
|
-
/**
|
|
2842
|
-
* - Criteria on which the selected stores should be sorted.
|
|
2843
|
-
*/
|
|
2844
1956
|
sort?: string[];
|
|
2845
1957
|
conditions?: StoreRuleConditionSchema;
|
|
2846
|
-
/**
|
|
2847
|
-
* - Denotes whether the rule is active or inactive.
|
|
2848
|
-
*/
|
|
2849
1958
|
is_active?: boolean;
|
|
2850
1959
|
};
|
|
2851
1960
|
/** @returns {StorePrioritySchema} */
|
|
2852
1961
|
declare function StorePrioritySchema(): StorePrioritySchema;
|
|
2853
1962
|
type StorePrioritySchema = {
|
|
2854
|
-
|
|
2855
|
-
* - Id of the store.
|
|
2856
|
-
*/
|
|
2857
|
-
id?: number;
|
|
2858
|
-
/**
|
|
2859
|
-
* - Name of the store.
|
|
2860
|
-
*/
|
|
1963
|
+
id?: string;
|
|
2861
1964
|
name?: string;
|
|
2862
1965
|
};
|
|
2863
|
-
/** @returns {
|
|
2864
|
-
declare function
|
|
2865
|
-
type
|
|
1966
|
+
/** @returns {GetStoreRulesApiResponse} */
|
|
1967
|
+
declare function GetStoreRulesApiResponse(): GetStoreRulesApiResponse;
|
|
1968
|
+
type GetStoreRulesApiResponse = {
|
|
2866
1969
|
items?: StoreRuleDataSchema[];
|
|
2867
1970
|
page?: Page;
|
|
2868
1971
|
};
|
|
2869
|
-
/** @returns {
|
|
2870
|
-
declare function
|
|
2871
|
-
type
|
|
2872
|
-
/**
|
|
2873
|
-
* - Name of the rule.
|
|
2874
|
-
*/
|
|
1972
|
+
/** @returns {CreateStoreRuleRequestSchema} */
|
|
1973
|
+
declare function CreateStoreRuleRequestSchema(): CreateStoreRuleRequestSchema;
|
|
1974
|
+
type CreateStoreRuleRequestSchema = {
|
|
2875
1975
|
name?: string;
|
|
2876
|
-
/**
|
|
2877
|
-
* - Denotes if the rule is active or not.
|
|
2878
|
-
*/
|
|
2879
1976
|
is_active?: boolean;
|
|
2880
1977
|
conditions?: StoreRuleConditionSchema;
|
|
2881
|
-
/**
|
|
2882
|
-
* - Priority of the store type to be
|
|
2883
|
-
* used in the basic prioritization sorting of stores.
|
|
2884
|
-
*/
|
|
2885
1978
|
type_based_priority?: string[];
|
|
2886
|
-
/**
|
|
2887
|
-
* - Priority of the store tags to be
|
|
2888
|
-
* used in the basic prioritization sorting of stores.
|
|
2889
|
-
*/
|
|
2890
1979
|
tag_based_priority?: string[];
|
|
2891
|
-
/**
|
|
2892
|
-
* - Priority of explicit
|
|
2893
|
-
* stores to be used for sorting of stores.
|
|
2894
|
-
*/
|
|
2895
1980
|
store_priority?: StorePrioritySchema[];
|
|
2896
|
-
/**
|
|
2897
|
-
* - Criteria on which the selected stores should be sorted.
|
|
2898
|
-
*/
|
|
2899
1981
|
sort?: string[];
|
|
2900
1982
|
};
|
|
2901
|
-
/** @returns {
|
|
2902
|
-
declare function
|
|
2903
|
-
type
|
|
2904
|
-
/**
|
|
2905
|
-
* - Id of the rule created.
|
|
2906
|
-
*/
|
|
1983
|
+
/** @returns {StoreRuleResponseSchema} */
|
|
1984
|
+
declare function StoreRuleResponseSchema(): StoreRuleResponseSchema;
|
|
1985
|
+
type StoreRuleResponseSchema = {
|
|
2907
1986
|
id?: string;
|
|
2908
|
-
/**
|
|
2909
|
-
* - Name of the rule created.
|
|
2910
|
-
*/
|
|
2911
1987
|
name?: string;
|
|
2912
|
-
/**
|
|
2913
|
-
* - Type of the rule created.
|
|
2914
|
-
*/
|
|
2915
1988
|
type?: string;
|
|
2916
|
-
/**
|
|
2917
|
-
* - Priority of the store type to be
|
|
2918
|
-
* used in the rule for sorting of stores.
|
|
2919
|
-
*/
|
|
2920
1989
|
type_based_priority?: string[];
|
|
2921
|
-
/**
|
|
2922
|
-
* - Priority of the store tags to be
|
|
2923
|
-
* used in the rule for sorting of stores.
|
|
2924
|
-
*/
|
|
2925
1990
|
tag_based_priority?: string[];
|
|
2926
|
-
/**
|
|
2927
|
-
* - Priority of explicit
|
|
2928
|
-
* stores to be used for sorting of stores.
|
|
2929
|
-
*/
|
|
2930
1991
|
store_priority?: StorePrioritySchema[];
|
|
2931
|
-
/**
|
|
2932
|
-
* - Criteria on which the selected stores should be sorted.
|
|
2933
|
-
*/
|
|
2934
1992
|
sort?: string[];
|
|
2935
1993
|
conditions?: StoreRuleConditionSchema;
|
|
2936
|
-
/**
|
|
2937
|
-
* - Denotes if the rule is active or inactive.
|
|
2938
|
-
*/
|
|
2939
1994
|
is_active?: boolean;
|
|
2940
1995
|
};
|
|
2941
|
-
/** @returns {
|
|
2942
|
-
declare function
|
|
2943
|
-
type
|
|
2944
|
-
/**
|
|
2945
|
-
* - Id of the rule created.
|
|
2946
|
-
*/
|
|
1996
|
+
/** @returns {StoreRuleUpdateResponseSchema} */
|
|
1997
|
+
declare function StoreRuleUpdateResponseSchema(): StoreRuleUpdateResponseSchema;
|
|
1998
|
+
type StoreRuleUpdateResponseSchema = {
|
|
2947
1999
|
id?: string;
|
|
2948
|
-
/**
|
|
2949
|
-
* - Name of the rule created.
|
|
2950
|
-
*/
|
|
2951
2000
|
name?: string;
|
|
2952
|
-
/**
|
|
2953
|
-
* - Type of the rule created.
|
|
2954
|
-
*/
|
|
2955
2001
|
type?: string;
|
|
2956
|
-
/**
|
|
2957
|
-
* - Priority of the store type to be
|
|
2958
|
-
* used in the rule for sorting of stores.
|
|
2959
|
-
*/
|
|
2960
2002
|
type_based_priority?: string[];
|
|
2961
|
-
/**
|
|
2962
|
-
* - Priority of the store tags to be
|
|
2963
|
-
* used in the rule for sorting of stores.
|
|
2964
|
-
*/
|
|
2965
2003
|
tag_based_priority?: string[];
|
|
2966
|
-
/**
|
|
2967
|
-
* - Priority of explicit
|
|
2968
|
-
* stores to be used for sorting of stores.
|
|
2969
|
-
*/
|
|
2970
2004
|
store_priority?: StorePrioritySchema[];
|
|
2971
|
-
/**
|
|
2972
|
-
* - Criteria on which the selected stores should be sorted.
|
|
2973
|
-
*/
|
|
2974
2005
|
sort?: string[];
|
|
2975
2006
|
conditions?: StoreRuleConditionSchema;
|
|
2976
|
-
/**
|
|
2977
|
-
* - Denotes if the rule is active or inactive.
|
|
2978
|
-
*/
|
|
2979
2007
|
is_active?: boolean;
|
|
2980
|
-
/**
|
|
2981
|
-
* - Company id for which the rule is created.
|
|
2982
|
-
*/
|
|
2983
2008
|
company_id?: number;
|
|
2984
|
-
/**
|
|
2985
|
-
* - Application id for which the rule is created.
|
|
2986
|
-
*/
|
|
2987
2009
|
application_id?: string;
|
|
2988
2010
|
};
|
|
2989
2011
|
/** @returns {ServiceabilityModel} */
|
|
@@ -2991,8 +2013,8 @@ declare function ServiceabilityModel(): ServiceabilityModel;
|
|
|
2991
2013
|
type ServiceabilityModel = {
|
|
2992
2014
|
lm_cod_limit: number;
|
|
2993
2015
|
is_qc: boolean;
|
|
2994
|
-
pickup_cutoff
|
|
2995
|
-
route_code
|
|
2016
|
+
pickup_cutoff: string;
|
|
2017
|
+
route_code: string;
|
|
2996
2018
|
is_first_mile: boolean;
|
|
2997
2019
|
is_return: boolean;
|
|
2998
2020
|
is_installation: boolean;
|
|
@@ -3023,314 +2045,101 @@ type CourierPartnerSchemeFeatures = {
|
|
|
3023
2045
|
/** @returns {CourierPartnerSchemeModel} */
|
|
3024
2046
|
declare function CourierPartnerSchemeModel(): CourierPartnerSchemeModel;
|
|
3025
2047
|
type CourierPartnerSchemeModel = {
|
|
3026
|
-
/**
|
|
3027
|
-
* - Name of the scheme.
|
|
3028
|
-
*/
|
|
3029
|
-
name?: string;
|
|
3030
|
-
/**
|
|
3031
|
-
* - Unique identifier of courier partner extension.
|
|
3032
|
-
*/
|
|
3033
2048
|
extension_id: string;
|
|
3034
|
-
/**
|
|
3035
|
-
* - Unique identifier of courier partner scheme.
|
|
3036
|
-
*/
|
|
3037
2049
|
scheme_id: string;
|
|
3038
|
-
volumetric_weight?: ArithmeticOperations;
|
|
3039
2050
|
weight: ArithmeticOperations;
|
|
3040
|
-
/**
|
|
3041
|
-
* - Mode of transport associated with the
|
|
3042
|
-
* courier partner scheme.
|
|
3043
|
-
*/
|
|
3044
2051
|
transport_type: string;
|
|
3045
|
-
/**
|
|
3046
|
-
* - Serviceable region associated with the courier
|
|
3047
|
-
* partner scheme.
|
|
3048
|
-
*/
|
|
3049
2052
|
region: string;
|
|
3050
|
-
/**
|
|
3051
|
-
* - Type of delivery associated with the
|
|
3052
|
-
* courier partner scheme.
|
|
3053
|
-
*/
|
|
3054
2053
|
delivery_type: string;
|
|
3055
|
-
/**
|
|
3056
|
-
* - Mode of payment associated with the
|
|
3057
|
-
* courier partner scheme.
|
|
3058
|
-
*/
|
|
3059
2054
|
payment_mode: string[];
|
|
3060
|
-
/**
|
|
3061
|
-
* - Denotes whether the courier partner scheme is in
|
|
3062
|
-
* enabled or disabled stage.
|
|
3063
|
-
*/
|
|
3064
2055
|
stage: string;
|
|
3065
2056
|
feature: CourierPartnerSchemeFeatures;
|
|
3066
2057
|
};
|
|
3067
|
-
/** @returns {
|
|
3068
|
-
declare function
|
|
3069
|
-
type
|
|
3070
|
-
/**
|
|
3071
|
-
* - Company id associated with the account.
|
|
3072
|
-
*/
|
|
3073
|
-
company_id: number;
|
|
3074
|
-
/**
|
|
3075
|
-
* - Unique identifier of courier partner extension.
|
|
3076
|
-
*/
|
|
3077
|
-
extension_id?: string;
|
|
3078
|
-
/**
|
|
3079
|
-
* - Unique identifier of courier partner scheme
|
|
3080
|
-
* and company id combination.
|
|
3081
|
-
*/
|
|
2058
|
+
/** @returns {CourierAccountResponse} */
|
|
2059
|
+
declare function CourierAccountResponse(): CourierAccountResponse;
|
|
2060
|
+
type CourierAccountResponse = {
|
|
3082
2061
|
account_id: string;
|
|
3083
|
-
/**
|
|
3084
|
-
* - Unique identifier of courier partner scheme.
|
|
3085
|
-
*/
|
|
3086
2062
|
scheme_id: string;
|
|
3087
|
-
/**
|
|
3088
|
-
* - Denotes if the account is of self delivery type.
|
|
3089
|
-
*/
|
|
3090
2063
|
is_self_ship: boolean;
|
|
3091
|
-
/**
|
|
3092
|
-
* - Denotes whether the account is in enabled or disabled stage.
|
|
3093
|
-
*/
|
|
3094
2064
|
stage: string;
|
|
3095
|
-
/**
|
|
3096
|
-
* - Denotes whether it is the seller's own
|
|
3097
|
-
* account or not.
|
|
3098
|
-
*/
|
|
3099
2065
|
is_own_account: boolean;
|
|
3100
|
-
scheme_rules
|
|
2066
|
+
scheme_rules: CourierPartnerSchemeModel;
|
|
3101
2067
|
};
|
|
3102
|
-
/** @returns {
|
|
3103
|
-
declare function
|
|
3104
|
-
type
|
|
3105
|
-
items:
|
|
2068
|
+
/** @returns {CompanyCourierPartnerAccountListResponse} */
|
|
2069
|
+
declare function CompanyCourierPartnerAccountListResponse(): CompanyCourierPartnerAccountListResponse;
|
|
2070
|
+
type CompanyCourierPartnerAccountListResponse = {
|
|
2071
|
+
items: CourierAccountResponse[];
|
|
3106
2072
|
page: Page;
|
|
3107
2073
|
};
|
|
3108
2074
|
/** @returns {PackageMaterial} */
|
|
3109
2075
|
declare function PackageMaterial(): PackageMaterial;
|
|
3110
2076
|
type PackageMaterial = {
|
|
3111
|
-
/**
|
|
3112
|
-
* - Name of the packaging material.
|
|
3113
|
-
*/
|
|
3114
2077
|
name: string;
|
|
3115
|
-
/**
|
|
3116
|
-
* - Width of the packaging material dimentions in centimeter.
|
|
3117
|
-
*/
|
|
3118
2078
|
width: number;
|
|
3119
|
-
/**
|
|
3120
|
-
* - Height of the packaging material dimentions in centimeter.
|
|
3121
|
-
*/
|
|
3122
2079
|
height: number;
|
|
3123
|
-
/**
|
|
3124
|
-
* - Length of the packaging material dimentions in centimeter.
|
|
3125
|
-
*/
|
|
3126
2080
|
length: number;
|
|
3127
|
-
/**
|
|
3128
|
-
* - Product group rules associated
|
|
3129
|
-
* with the packaging.
|
|
3130
|
-
*/
|
|
3131
2081
|
rules?: PackageMaterialRule[];
|
|
3132
|
-
/**
|
|
3133
|
-
* - Store ids where the packaging is avaiable.
|
|
3134
|
-
*/
|
|
3135
2082
|
store_ids: number[];
|
|
3136
|
-
/**
|
|
3137
|
-
* - Package's weight in gram.
|
|
3138
|
-
*/
|
|
3139
2083
|
weight: number;
|
|
3140
|
-
/**
|
|
3141
|
-
* - Error Rate associated with the packaging dimensions.
|
|
3142
|
-
*/
|
|
3143
2084
|
error_rate: number;
|
|
3144
|
-
/**
|
|
3145
|
-
* - Type of package material.
|
|
3146
|
-
*/
|
|
3147
2085
|
package_type: string;
|
|
3148
|
-
/**
|
|
3149
|
-
* - Physical size of the packaging.
|
|
3150
|
-
*/
|
|
3151
2086
|
size: string;
|
|
3152
|
-
/**
|
|
3153
|
-
* - Image urls associated with the packaging material.
|
|
3154
|
-
*/
|
|
3155
2087
|
media?: string[];
|
|
3156
|
-
/**
|
|
3157
|
-
* - Sales channel where packaging is applicable.
|
|
3158
|
-
*/
|
|
3159
2088
|
channels: Channel[];
|
|
3160
|
-
/**
|
|
3161
|
-
* - Denotes if the track of the inventory
|
|
3162
|
-
* should be kept.
|
|
3163
|
-
*/
|
|
3164
2089
|
track_inventory?: boolean;
|
|
3165
|
-
/**
|
|
3166
|
-
* - Current status of the packaging material, if it
|
|
3167
|
-
* is active or inactive.
|
|
3168
|
-
*/
|
|
3169
2090
|
status: string;
|
|
3170
|
-
/**
|
|
3171
|
-
* - Maximum weight holding capacity.
|
|
3172
|
-
*/
|
|
3173
2091
|
max_weight?: number;
|
|
3174
|
-
/**
|
|
3175
|
-
* - Volumetric weight that a packaging
|
|
3176
|
-
* material can carry.
|
|
3177
|
-
*/
|
|
3178
2092
|
package_vol_weight?: number;
|
|
3179
|
-
/**
|
|
3180
|
-
* - Denotes whether the volumetric weight
|
|
3181
|
-
* should be auto calculated or not.
|
|
3182
|
-
*/
|
|
3183
2093
|
auto_calculate?: boolean;
|
|
3184
2094
|
};
|
|
3185
|
-
/** @returns {
|
|
3186
|
-
declare function
|
|
3187
|
-
type
|
|
3188
|
-
/**
|
|
3189
|
-
* - Name of the packaging material.
|
|
3190
|
-
*/
|
|
2095
|
+
/** @returns {PackageMaterialResponse} */
|
|
2096
|
+
declare function PackageMaterialResponse(): PackageMaterialResponse;
|
|
2097
|
+
type PackageMaterialResponse = {
|
|
3191
2098
|
name: string;
|
|
3192
|
-
/**
|
|
3193
|
-
* - Id of the packaging material.
|
|
3194
|
-
*/
|
|
3195
2099
|
id?: string;
|
|
3196
|
-
/**
|
|
3197
|
-
* - Unique identifier of an item associated with
|
|
3198
|
-
* the packaging material.
|
|
3199
|
-
*/
|
|
3200
2100
|
item_id?: number;
|
|
3201
|
-
/**
|
|
3202
|
-
* - Company id associated with the packaging material.
|
|
3203
|
-
*/
|
|
3204
|
-
company_id?: number;
|
|
3205
|
-
/**
|
|
3206
|
-
* - Width of the packaging material dimentions in centimeter.
|
|
3207
|
-
*/
|
|
3208
2101
|
width: number;
|
|
3209
|
-
/**
|
|
3210
|
-
* - Height of the packaging material dimentions in centimeter.
|
|
3211
|
-
*/
|
|
3212
2102
|
height: number;
|
|
3213
|
-
/**
|
|
3214
|
-
* - Length of the packaging material dimentions in centimeter.
|
|
3215
|
-
*/
|
|
3216
2103
|
length: number;
|
|
3217
|
-
/**
|
|
3218
|
-
* - Product group rules associated
|
|
3219
|
-
* with the packaging.
|
|
3220
|
-
*/
|
|
3221
2104
|
rules?: PackageMaterialRule[];
|
|
3222
|
-
/**
|
|
3223
|
-
* - Store ids where the packaging is avaiable.
|
|
3224
|
-
*/
|
|
3225
2105
|
store_ids: number[];
|
|
3226
|
-
/**
|
|
3227
|
-
* - Package's weight in gram.
|
|
3228
|
-
*/
|
|
3229
2106
|
weight: number;
|
|
3230
|
-
/**
|
|
3231
|
-
* - Error Rate associated with the packaging dimensions.
|
|
3232
|
-
*/
|
|
3233
2107
|
error_rate: number;
|
|
3234
|
-
/**
|
|
3235
|
-
* - Type of package material.
|
|
3236
|
-
*/
|
|
3237
2108
|
package_type: string;
|
|
3238
|
-
/**
|
|
3239
|
-
* - Physical size of the packaging.
|
|
3240
|
-
*/
|
|
3241
2109
|
size: string;
|
|
3242
|
-
/**
|
|
3243
|
-
* - Image urls associated with the packaging material.
|
|
3244
|
-
*/
|
|
3245
2110
|
media?: string[];
|
|
3246
|
-
/**
|
|
3247
|
-
* - Sales channel where packaging is applicable.
|
|
3248
|
-
*/
|
|
3249
2111
|
channels: Channel[];
|
|
3250
|
-
/**
|
|
3251
|
-
* - Denotes if the track of the inventory
|
|
3252
|
-
* should be kept.
|
|
3253
|
-
*/
|
|
3254
2112
|
track_inventory?: boolean;
|
|
3255
|
-
/**
|
|
3256
|
-
* - Current status of the packaging material, if it
|
|
3257
|
-
* is active or inactive.
|
|
3258
|
-
*/
|
|
3259
2113
|
status: string;
|
|
3260
|
-
/**
|
|
3261
|
-
* - Maximum weight holding capacity.
|
|
3262
|
-
*/
|
|
3263
2114
|
max_weight?: number;
|
|
3264
|
-
/**
|
|
3265
|
-
* - Volumetric weight that a packaging
|
|
3266
|
-
* material can carry.
|
|
3267
|
-
*/
|
|
3268
2115
|
package_vol_weight?: number;
|
|
3269
|
-
/**
|
|
3270
|
-
* - Denotes whether the volumetric weight
|
|
3271
|
-
* should be auto calculated or not.
|
|
3272
|
-
*/
|
|
3273
2116
|
auto_calculate?: boolean;
|
|
3274
2117
|
};
|
|
3275
2118
|
/** @returns {PackageMaterialRule} */
|
|
3276
2119
|
declare function PackageMaterialRule(): PackageMaterialRule;
|
|
3277
2120
|
type PackageMaterialRule = {
|
|
3278
|
-
/**
|
|
3279
|
-
* - Unique identifier of the package rule.
|
|
3280
|
-
*/
|
|
3281
2121
|
rule_id?: string;
|
|
3282
2122
|
quantity?: PackageMaterialRuleQuantity;
|
|
3283
|
-
/**
|
|
3284
|
-
* - Volumetric weight in gram.
|
|
3285
|
-
*/
|
|
3286
2123
|
weight?: number;
|
|
3287
2124
|
};
|
|
3288
2125
|
/** @returns {PackageRule} */
|
|
3289
2126
|
declare function PackageRule(): PackageRule;
|
|
3290
2127
|
type PackageRule = {
|
|
3291
|
-
/**
|
|
3292
|
-
* - Name of the package rule.
|
|
3293
|
-
*/
|
|
3294
2128
|
name: string;
|
|
3295
|
-
/**
|
|
3296
|
-
* - Unique identifier of the company.
|
|
3297
|
-
*/
|
|
3298
2129
|
company_id: number;
|
|
3299
|
-
/**
|
|
3300
|
-
* - Type of the rule.
|
|
3301
|
-
*/
|
|
3302
2130
|
type: string;
|
|
3303
|
-
/**
|
|
3304
|
-
* - Denotes if the rule is active or inactive.
|
|
3305
|
-
*/
|
|
3306
2131
|
is_active?: boolean;
|
|
3307
2132
|
product_tag?: PackageRuleProductTag;
|
|
3308
2133
|
product_id?: PackageRuleProduct;
|
|
3309
2134
|
category_id?: PackageRuleCategory;
|
|
3310
2135
|
};
|
|
3311
|
-
/** @returns {
|
|
3312
|
-
declare function
|
|
3313
|
-
type
|
|
3314
|
-
/**
|
|
3315
|
-
* - Unique id of a package rule.
|
|
3316
|
-
*/
|
|
2136
|
+
/** @returns {PackageRuleResponse} */
|
|
2137
|
+
declare function PackageRuleResponse(): PackageRuleResponse;
|
|
2138
|
+
type PackageRuleResponse = {
|
|
3317
2139
|
id?: string;
|
|
3318
|
-
/**
|
|
3319
|
-
* - Name of a package rule.
|
|
3320
|
-
*/
|
|
3321
2140
|
name: string;
|
|
3322
|
-
/**
|
|
3323
|
-
* - Unique identifier of a company associated
|
|
3324
|
-
* with the package rule.
|
|
3325
|
-
*/
|
|
3326
2141
|
company_id: number;
|
|
3327
|
-
/**
|
|
3328
|
-
* - Type of the rule created.
|
|
3329
|
-
*/
|
|
3330
2142
|
type: string;
|
|
3331
|
-
/**
|
|
3332
|
-
* - Denotes if the rule is active or inactive.
|
|
3333
|
-
*/
|
|
3334
2143
|
is_active?: boolean;
|
|
3335
2144
|
product_tag?: PackageRuleProductTag;
|
|
3336
2145
|
product_id?: PackageRuleProduct;
|
|
@@ -3339,25 +2148,19 @@ type PackageRuleResult = {
|
|
|
3339
2148
|
/** @returns {Channel} */
|
|
3340
2149
|
declare function Channel(): Channel;
|
|
3341
2150
|
type Channel = {
|
|
3342
|
-
/**
|
|
3343
|
-
* - Type of the channel.
|
|
3344
|
-
*/
|
|
3345
2151
|
type?: string;
|
|
3346
|
-
/**
|
|
3347
|
-
* - Unique identifier of the channel.
|
|
3348
|
-
*/
|
|
3349
2152
|
id?: string;
|
|
3350
2153
|
};
|
|
3351
2154
|
/** @returns {PackageMaterialRuleList} */
|
|
3352
2155
|
declare function PackageMaterialRuleList(): PackageMaterialRuleList;
|
|
3353
2156
|
type PackageMaterialRuleList = {
|
|
3354
|
-
items?:
|
|
2157
|
+
items?: PackageRuleResponse;
|
|
3355
2158
|
page?: Page;
|
|
3356
2159
|
};
|
|
3357
2160
|
/** @returns {PackageMaterialList} */
|
|
3358
2161
|
declare function PackageMaterialList(): PackageMaterialList;
|
|
3359
2162
|
type PackageMaterialList = {
|
|
3360
|
-
items?:
|
|
2163
|
+
items?: PackageMaterialResponse;
|
|
3361
2164
|
page?: Page;
|
|
3362
2165
|
};
|
|
3363
2166
|
/** @returns {PackageRuleProduct} */
|
|
@@ -3378,34 +2181,18 @@ type PackageRuleCategory = {
|
|
|
3378
2181
|
/** @returns {PackageMaterialRuleQuantity} */
|
|
3379
2182
|
declare function PackageMaterialRuleQuantity(): PackageMaterialRuleQuantity;
|
|
3380
2183
|
type PackageMaterialRuleQuantity = {
|
|
3381
|
-
/**
|
|
3382
|
-
* - Minimum product's quantity that a packaging can contain.
|
|
3383
|
-
*/
|
|
3384
2184
|
min?: number;
|
|
3385
|
-
/**
|
|
3386
|
-
* - Maximum product's quantity that a packaging can contain.
|
|
3387
|
-
*/
|
|
3388
2185
|
max?: number;
|
|
3389
2186
|
};
|
|
3390
|
-
/** @returns {
|
|
3391
|
-
declare function
|
|
3392
|
-
type
|
|
3393
|
-
/**
|
|
3394
|
-
* - Rule id whose priority needs to be changed.
|
|
3395
|
-
*/
|
|
2187
|
+
/** @returns {RulePriorityRequest} */
|
|
2188
|
+
declare function RulePriorityRequest(): RulePriorityRequest;
|
|
2189
|
+
type RulePriorityRequest = {
|
|
3396
2190
|
rule_id: string;
|
|
3397
|
-
/**
|
|
3398
|
-
* - New priority of the rule.
|
|
3399
|
-
*/
|
|
3400
2191
|
priority: number;
|
|
3401
2192
|
};
|
|
3402
|
-
/** @returns {
|
|
3403
|
-
declare function
|
|
3404
|
-
type
|
|
3405
|
-
/**
|
|
3406
|
-
* - Denotes if the priority of the rule is
|
|
3407
|
-
* changes successfully or not.
|
|
3408
|
-
*/
|
|
2193
|
+
/** @returns {RulePriorityResponse} */
|
|
2194
|
+
declare function RulePriorityResponse(): RulePriorityResponse;
|
|
2195
|
+
type RulePriorityResponse = {
|
|
3409
2196
|
success?: boolean;
|
|
3410
2197
|
};
|
|
3411
2198
|
/** @returns {ArticleAssignment} */
|
|
@@ -3464,7 +2251,7 @@ declare function OptimalLocationsArticles(): OptimalLocationsArticles;
|
|
|
3464
2251
|
type OptimalLocationsArticles = {
|
|
3465
2252
|
item_id: number;
|
|
3466
2253
|
size: string;
|
|
3467
|
-
quantity:
|
|
2254
|
+
quantity: string;
|
|
3468
2255
|
group_id?: string;
|
|
3469
2256
|
is_primary_item?: boolean;
|
|
3470
2257
|
meta?: any;
|
|
@@ -3473,18 +2260,18 @@ type OptimalLocationsArticles = {
|
|
|
3473
2260
|
assign_locations: number[];
|
|
3474
2261
|
seller_id?: number;
|
|
3475
2262
|
};
|
|
3476
|
-
/** @returns {
|
|
3477
|
-
declare function
|
|
3478
|
-
type
|
|
2263
|
+
/** @returns {OptimlLocationsRequestSchema} */
|
|
2264
|
+
declare function OptimlLocationsRequestSchema(): OptimlLocationsRequestSchema;
|
|
2265
|
+
type OptimlLocationsRequestSchema = {
|
|
3479
2266
|
channel_id: string;
|
|
3480
2267
|
channel_type: string;
|
|
3481
2268
|
channel_identifier?: string;
|
|
3482
2269
|
to_serviceability: LocationDetailsServiceability;
|
|
3483
|
-
|
|
2270
|
+
article?: OptimalLocationsArticles;
|
|
3484
2271
|
};
|
|
3485
|
-
/** @returns {
|
|
3486
|
-
declare function
|
|
3487
|
-
type
|
|
2272
|
+
/** @returns {OptimalLocationArticlesResponse} */
|
|
2273
|
+
declare function OptimalLocationArticlesResponse(): OptimalLocationArticlesResponse;
|
|
2274
|
+
type OptimalLocationArticlesResponse = {
|
|
3488
2275
|
item_id: number;
|
|
3489
2276
|
size: string;
|
|
3490
2277
|
quantity: number;
|
|
@@ -3500,35 +2287,15 @@ type OptimalLocationArticlesResult = {
|
|
|
3500
2287
|
_id: string;
|
|
3501
2288
|
uid: string;
|
|
3502
2289
|
};
|
|
3503
|
-
/** @returns {
|
|
3504
|
-
declare function
|
|
3505
|
-
type
|
|
2290
|
+
/** @returns {OptimalLocationAssignedStoresResponse} */
|
|
2291
|
+
declare function OptimalLocationAssignedStoresResponse(): OptimalLocationAssignedStoresResponse;
|
|
2292
|
+
type OptimalLocationAssignedStoresResponse = {
|
|
3506
2293
|
store_id: number;
|
|
3507
|
-
articles:
|
|
3508
|
-
};
|
|
3509
|
-
/** @returns {OptimalLocationsResult} */
|
|
3510
|
-
declare function OptimalLocationsResult(): OptimalLocationsResult;
|
|
3511
|
-
type OptimalLocationsResult = {
|
|
3512
|
-
assigned_stores: OptimalLocationAssignedStoresResult[];
|
|
3513
|
-
faulty_articles?: ErrorResult[];
|
|
3514
|
-
};
|
|
3515
|
-
/** @returns {ValidationError} */
|
|
3516
|
-
declare function ValidationError(): ValidationError;
|
|
3517
|
-
type ValidationError = {
|
|
3518
|
-
/**
|
|
3519
|
-
* - A brief description of the error encountered.
|
|
3520
|
-
*/
|
|
3521
|
-
message: string;
|
|
3522
|
-
/**
|
|
3523
|
-
* - The field in the request that caused the error.
|
|
3524
|
-
*/
|
|
3525
|
-
field: string;
|
|
2294
|
+
articles: OptimalLocationArticlesResponse[];
|
|
3526
2295
|
};
|
|
3527
|
-
/** @returns {
|
|
3528
|
-
declare function
|
|
3529
|
-
type
|
|
3530
|
-
|
|
3531
|
-
|
|
3532
|
-
*/
|
|
3533
|
-
message: string;
|
|
2296
|
+
/** @returns {OptimalLocationsResponse} */
|
|
2297
|
+
declare function OptimalLocationsResponse(): OptimalLocationsResponse;
|
|
2298
|
+
type OptimalLocationsResponse = {
|
|
2299
|
+
assigned_stores: OptimalLocationAssignedStoresResponse[];
|
|
2300
|
+
faulty_articles?: ErrorResponse[];
|
|
3534
2301
|
};
|