@gofynd/fdk-client-javascript 1.3.11-beta.6 → 1.3.11-beta.8
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/Cart/CartApplicationClient.d.ts +1 -1
- package/sdk/application/Cart/CartApplicationClient.js +5 -3
- package/sdk/application/Cart/CartApplicationModel.d.ts +107 -1
- package/sdk/application/Cart/CartApplicationModel.js +74 -0
- package/sdk/application/Cart/CartApplicationValidator.d.ts +4 -0
- package/sdk/application/Cart/CartApplicationValidator.js +4 -0
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +3 -6
- package/sdk/application/Catalog/CatalogApplicationClient.js +7 -20
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +2 -2
- package/sdk/application/Catalog/CatalogApplicationModel.js +2 -2
- package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +0 -14
- package/sdk/application/Catalog/CatalogApplicationValidator.js +0 -6
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +183 -49
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +173 -31
- package/sdk/application/Content/ContentApplicationClient.d.ts +36 -0
- package/sdk/application/Content/ContentApplicationClient.js +246 -0
- package/sdk/application/Content/ContentApplicationModel.d.ts +208 -1
- package/sdk/application/Content/ContentApplicationModel.js +252 -0
- package/sdk/application/Content/ContentApplicationValidator.d.ts +40 -1
- package/sdk/application/Content/ContentApplicationValidator.js +41 -0
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +67 -0
- package/sdk/application/Logistic/LogisticApplicationClient.js +547 -0
- package/sdk/application/Logistic/LogisticApplicationModel.d.ts +456 -1
- package/sdk/application/Logistic/LogisticApplicationModel.js +488 -0
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +211 -1
- package/sdk/application/Logistic/LogisticApplicationValidator.js +131 -0
- package/sdk/application/Order/OrderApplicationClient.d.ts +3 -3
- package/sdk/application/Order/OrderApplicationClient.js +32 -8
- package/sdk/application/Order/OrderApplicationModel.d.ts +6 -0
- package/sdk/application/Order/OrderApplicationModel.js +6 -0
- package/sdk/application/Order/OrderApplicationValidator.d.ts +20 -0
- package/sdk/application/Order/OrderApplicationValidator.js +8 -0
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +46 -2
- package/sdk/application/Payment/PaymentApplicationClient.js +341 -10
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +493 -186
- package/sdk/application/Payment/PaymentApplicationModel.js +341 -70
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +59 -14
- package/sdk/application/Payment/PaymentApplicationValidator.js +64 -10
- package/sdk/application/PosCart/PosCartApplicationModel.d.ts +34 -1
- package/sdk/application/PosCart/PosCartApplicationModel.js +24 -0
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +1 -1
- package/sdk/application/Theme/ThemeApplicationClient.js +7 -3
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +222 -36
- package/sdk/application/Theme/ThemeApplicationModel.js +322 -26
- package/sdk/application/Theme/ThemeApplicationValidator.d.ts +10 -0
- package/sdk/application/Theme/ThemeApplicationValidator.js +4 -0
- package/sdk/application/User/UserApplicationClient.d.ts +33 -0
- package/sdk/application/User/UserApplicationClient.js +239 -0
- package/sdk/application/User/UserApplicationModel.d.ts +28 -13
- package/sdk/application/User/UserApplicationModel.js +36 -12
- package/sdk/application/User/UserApplicationValidator.d.ts +34 -1
- package/sdk/application/User/UserApplicationValidator.js +36 -0
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +125 -0
- package/sdk/partner/Lead/LeadPartnerClient.js +785 -0
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +1127 -0
- package/sdk/partner/Lead/LeadPartnerModel.js +896 -0
- package/sdk/partner/Lead/LeadPartnerValidator.d.ts +12 -0
- package/sdk/partner/Lead/LeadPartnerValidator.js +67 -0
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +155 -0
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +1195 -0
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +372 -0
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +442 -0
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +16 -0
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +123 -0
- package/sdk/partner/PartnerClient.d.ts +6 -0
- package/sdk/partner/PartnerClient.js +9 -0
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +10 -0
- package/sdk/partner/Theme/ThemePartnerClient.js +80 -0
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +100 -43
- package/sdk/partner/Theme/ThemePartnerModel.js +74 -30
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +1 -0
- package/sdk/partner/Theme/ThemePartnerValidator.js +9 -0
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +99 -0
- package/sdk/partner/Webhook/WebhookPartnerClient.js +753 -0
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +566 -0
- package/sdk/partner/Webhook/WebhookPartnerModel.js +583 -0
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +12 -0
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +74 -0
- package/sdk/partner/index.d.ts +3 -0
- package/sdk/partner/index.js +6 -0
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +2 -2
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +11 -1
- package/sdk/platform/Billing/BillingPlatformClient.js +110 -3
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +67 -1
- package/sdk/platform/Billing/BillingPlatformModel.js +78 -0
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +43 -4
- package/sdk/platform/Billing/BillingPlatformValidator.js +29 -2
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +7 -1
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +4 -0
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +4 -0
- package/sdk/platform/Cart/CartPlatformModel.d.ts +100 -5
- package/sdk/platform/Cart/CartPlatformModel.js +71 -4
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +15 -11
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +52 -21
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +27 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +11 -0
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +26 -4
- package/sdk/platform/Catalog/CatalogPlatformClient.js +173 -7
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +304 -1
- package/sdk/platform/Catalog/CatalogPlatformModel.js +335 -0
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +31 -3
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +27 -2
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +138 -36
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +739 -57
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +128 -3
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +111 -1
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +150 -1
- package/sdk/platform/Communication/CommunicationPlatformModel.js +172 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +8 -2
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +32 -4
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +38 -9
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +42 -8
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +14 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +6 -0
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +8 -8
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +4 -4
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +371 -132
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +288 -77
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +2 -2
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +2 -2
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +391 -0
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +3630 -1059
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +342 -1
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +401 -0
- package/sdk/platform/Content/ContentPlatformClient.d.ts +277 -0
- package/sdk/platform/Content/ContentPlatformClient.js +2000 -0
- package/sdk/platform/Content/ContentPlatformModel.d.ts +1094 -1
- package/sdk/platform/Content/ContentPlatformModel.js +1356 -46
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +238 -0
- package/sdk/platform/Content/ContentPlatformValidator.js +310 -0
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformClient.js +2 -2
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +96 -13
- package/sdk/platform/Discount/DiscountPlatformModel.js +104 -12
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +16 -6
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +117 -8
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +55 -4
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +39 -2
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +16 -5
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +18 -4
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +33 -0
- package/sdk/platform/Finance/FinancePlatformClient.js +240 -0
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +151 -5
- package/sdk/platform/Finance/FinancePlatformModel.js +190 -4
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +38 -1
- package/sdk/platform/Finance/FinancePlatformValidator.js +38 -0
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +38 -28
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +137 -56
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +41 -29
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +33 -21
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +12 -3
- package/sdk/platform/Lead/LeadPlatformModel.js +16 -2
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +23 -1
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +178 -1
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +39 -1
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +32 -0
- package/sdk/platform/Order/OrderPlatformClient.d.ts +202 -31
- package/sdk/platform/Order/OrderPlatformClient.js +2010 -586
- package/sdk/platform/Order/OrderPlatformModel.d.ts +1030 -468
- package/sdk/platform/Order/OrderPlatformModel.js +1176 -523
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +318 -35
- package/sdk/platform/Order/OrderPlatformValidator.js +292 -29
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +119 -13
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +749 -39
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +143 -7
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +133 -6
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +1 -1
- package/sdk/platform/Payment/PaymentPlatformClient.js +1 -1
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +996 -134
- package/sdk/platform/Payment/PaymentPlatformModel.js +721 -58
- package/sdk/platform/PlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/PlatformApplicationClient.js +4 -4
- package/sdk/platform/PlatformClient.d.ts +4 -2
- package/sdk/platform/PlatformClient.js +8 -4
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +142 -66
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +645 -147
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +131 -63
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +126 -47
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +217 -105
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +1136 -347
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +912 -313
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +1071 -355
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +382 -133
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +266 -102
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +11 -1
- package/sdk/platform/Theme/ThemePlatformClient.js +87 -3
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +333 -47
- package/sdk/platform/Theme/ThemePlatformModel.js +395 -35
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +28 -4
- package/sdk/platform/Theme/ThemePlatformValidator.js +21 -2
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +116 -1
- package/sdk/platform/User/UserPlatformApplicationClient.js +931 -85
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +224 -7
- package/sdk/platform/User/UserPlatformApplicationValidator.js +173 -5
- package/sdk/platform/User/UserPlatformModel.d.ts +344 -7
- package/sdk/platform/User/UserPlatformModel.js +256 -5
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +47 -39
- package/sdk/platform/Webhook/WebhookPlatformClient.js +63 -61
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +264 -156
- package/sdk/platform/Webhook/WebhookPlatformModel.js +276 -153
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +7 -10
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +6 -6
- package/sdk/platform/index.d.ts +1 -1
- package/sdk/platform/index.js +2 -2
- package/sdk/public/Billing/BillingPublicClient.d.ts +23 -0
- package/sdk/public/Billing/BillingPublicClient.js +116 -0
- package/sdk/public/Billing/BillingPublicModel.d.ts +92 -0
- package/sdk/public/Billing/BillingPublicModel.js +96 -0
- package/sdk/public/Billing/BillingPublicValidator.d.ts +18 -0
- package/sdk/public/Billing/BillingPublicValidator.js +19 -0
- package/sdk/public/Content/ContentPublicClient.d.ts +22 -0
- package/sdk/public/Content/ContentPublicClient.js +114 -0
- package/sdk/public/Content/ContentPublicModel.d.ts +53 -0
- package/sdk/public/Content/ContentPublicModel.js +60 -0
- package/sdk/public/Content/ContentPublicValidator.d.ts +18 -0
- package/sdk/public/Content/ContentPublicValidator.js +19 -0
- package/sdk/public/PublicClient.d.ts +4 -0
- package/sdk/public/PublicClient.js +8 -0
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +33 -0
- package/sdk/public/Webhook/WebhookPublicClient.js +242 -0
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +147 -1
- package/sdk/public/Webhook/WebhookPublicModel.js +177 -1
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +23 -1
- package/sdk/public/Webhook/WebhookPublicValidator.js +31 -0
- package/sdk/public/index.d.ts +2 -0
- package/sdk/public/index.js +4 -0
|
@@ -152,6 +152,10 @@ export = OrderPlatformModel;
|
|
|
152
152
|
* @property {string} marketplace_store_id
|
|
153
153
|
* @property {number} store_id
|
|
154
154
|
*/
|
|
155
|
+
/**
|
|
156
|
+
* @typedef AllowedTemplatesResponse
|
|
157
|
+
* @property {Templates[]} [template_x_slug]
|
|
158
|
+
*/
|
|
155
159
|
/**
|
|
156
160
|
* @typedef AnnouncementResponse
|
|
157
161
|
* @property {number} [company_id]
|
|
@@ -208,9 +212,12 @@ export = OrderPlatformModel;
|
|
|
208
212
|
* @property {Object} category
|
|
209
213
|
* @property {Object} dimension
|
|
210
214
|
* @property {number} quantity
|
|
211
|
-
* @property {Object} [status]
|
|
212
215
|
* @property {Object} weight
|
|
213
216
|
*/
|
|
217
|
+
/**
|
|
218
|
+
* @typedef ArticleStatusDetails
|
|
219
|
+
* @property {Object} [status]
|
|
220
|
+
*/
|
|
214
221
|
/**
|
|
215
222
|
* @typedef AttachOrderUser
|
|
216
223
|
* @property {string} fynd_order_id
|
|
@@ -245,15 +252,6 @@ export = OrderPlatformModel;
|
|
|
245
252
|
* @property {string} [primary_color_hex]
|
|
246
253
|
* @property {string} [primary_material]
|
|
247
254
|
*/
|
|
248
|
-
/**
|
|
249
|
-
* @typedef B2BPODetails
|
|
250
|
-
* @property {string} [docker_number]
|
|
251
|
-
* @property {number} [item_base_price]
|
|
252
|
-
* @property {boolean} [partial_can_ret]
|
|
253
|
-
* @property {number} [po_line_amount]
|
|
254
|
-
* @property {number} [po_tax_amount]
|
|
255
|
-
* @property {number} [total_gst_percentage]
|
|
256
|
-
*/
|
|
257
255
|
/**
|
|
258
256
|
* @typedef BagConfigs
|
|
259
257
|
* @property {boolean} allow_force_return
|
|
@@ -269,7 +267,7 @@ export = OrderPlatformModel;
|
|
|
269
267
|
* @property {AffiliateDetails} [affiliate_details]
|
|
270
268
|
* @property {Object[]} [applied_promos]
|
|
271
269
|
* @property {Article} [article]
|
|
272
|
-
* @property {
|
|
270
|
+
* @property {ArticleStatusDetails} [article_details]
|
|
273
271
|
* @property {BagStatusHistory[]} [bag_status]
|
|
274
272
|
* @property {BagStatusHistory} [bag_status_history]
|
|
275
273
|
* @property {number} [bag_update_time]
|
|
@@ -301,59 +299,10 @@ export = OrderPlatformModel;
|
|
|
301
299
|
* @property {Object} [restore_promos]
|
|
302
300
|
* @property {string} [seller_identifier]
|
|
303
301
|
* @property {string} [shipment_id]
|
|
304
|
-
* @property {
|
|
302
|
+
* @property {BagReturnableCancelableStatus} [status]
|
|
305
303
|
* @property {string[]} [tags]
|
|
306
304
|
* @property {string} [type]
|
|
307
305
|
*/
|
|
308
|
-
/**
|
|
309
|
-
* @typedef BagGST
|
|
310
|
-
* @property {number} [brand_calculated_amount]
|
|
311
|
-
* @property {string} [cgst_gst_fee]
|
|
312
|
-
* @property {number} [cgst_tax_percentage]
|
|
313
|
-
* @property {number} [gst_fee]
|
|
314
|
-
* @property {string} [gst_tag]
|
|
315
|
-
* @property {number} [gst_tax_percentage]
|
|
316
|
-
* @property {string} [gstin_code]
|
|
317
|
-
* @property {string} [hsn_code]
|
|
318
|
-
* @property {string} [hsn_code_id]
|
|
319
|
-
* @property {string} [igst_gst_fee]
|
|
320
|
-
* @property {number} [igst_tax_percentage]
|
|
321
|
-
* @property {boolean} [is_default_hsn_code]
|
|
322
|
-
* @property {string} [sgst_gst_fee]
|
|
323
|
-
* @property {number} [sgst_tax_percentage]
|
|
324
|
-
* @property {number} [tax_collected_at_source]
|
|
325
|
-
* @property {number} [value_of_good]
|
|
326
|
-
*/
|
|
327
|
-
/**
|
|
328
|
-
* @typedef BagGSTDetails
|
|
329
|
-
* @property {number} brand_calculated_amount
|
|
330
|
-
* @property {string} cgst_gst_fee
|
|
331
|
-
* @property {number} cgst_tax_percentage
|
|
332
|
-
* @property {number} gst_fee
|
|
333
|
-
* @property {string} gst_tag
|
|
334
|
-
* @property {number} gst_tax_percentage
|
|
335
|
-
* @property {string} [gstin_code]
|
|
336
|
-
* @property {string} hsn_code
|
|
337
|
-
* @property {string} hsn_code_id
|
|
338
|
-
* @property {string} igst_gst_fee
|
|
339
|
-
* @property {number} igst_tax_percentage
|
|
340
|
-
* @property {boolean} [is_default_hsn_code]
|
|
341
|
-
* @property {string} sgst_gst_fee
|
|
342
|
-
* @property {number} sgst_tax_percentage
|
|
343
|
-
* @property {number} tax_collected_at_source
|
|
344
|
-
* @property {number} value_of_good
|
|
345
|
-
*/
|
|
346
|
-
/**
|
|
347
|
-
* @typedef BagMeta
|
|
348
|
-
* @property {B2BPODetails} [b2b_po_details]
|
|
349
|
-
* @property {Object} [custom_json]
|
|
350
|
-
* @property {string} [custom_message]
|
|
351
|
-
* @property {string} [docket_number]
|
|
352
|
-
* @property {Object} [extra_meta]
|
|
353
|
-
* @property {GiftCard} [gift_card]
|
|
354
|
-
* @property {string} [group_id]
|
|
355
|
-
* @property {boolean} [partial_can_ret]
|
|
356
|
-
*/
|
|
357
306
|
/**
|
|
358
307
|
* @typedef BagPaymentMethods
|
|
359
308
|
* @property {number} [amount]
|
|
@@ -380,14 +329,6 @@ export = OrderPlatformModel;
|
|
|
380
329
|
* @property {boolean} is_customer_return_allowed
|
|
381
330
|
* @property {boolean} is_returnable
|
|
382
331
|
*/
|
|
383
|
-
/**
|
|
384
|
-
* @typedef BagReturnableCancelableStatus1
|
|
385
|
-
* @property {boolean} can_be_cancelled
|
|
386
|
-
* @property {boolean} enable_tracking
|
|
387
|
-
* @property {boolean} is_active
|
|
388
|
-
* @property {boolean} is_customer_return_allowed
|
|
389
|
-
* @property {boolean} is_returnable
|
|
390
|
-
*/
|
|
391
332
|
/**
|
|
392
333
|
* @typedef Bags
|
|
393
334
|
* @property {string} [affiliate_bag_id] - Application/Affiliate Bag ID,
|
|
@@ -430,6 +371,7 @@ export = OrderPlatformModel;
|
|
|
430
371
|
* @property {BagStateMapper} [bag_state_mapper]
|
|
431
372
|
* @property {number} [bsh_id]
|
|
432
373
|
* @property {string} [created_at]
|
|
374
|
+
* @property {string} [created_ts]
|
|
433
375
|
* @property {string} [delivery_awb_number]
|
|
434
376
|
* @property {number} [delivery_partner_id]
|
|
435
377
|
* @property {string} [display_name]
|
|
@@ -442,6 +384,7 @@ export = OrderPlatformModel;
|
|
|
442
384
|
* @property {string} status
|
|
443
385
|
* @property {number} [store_id]
|
|
444
386
|
* @property {string} [updated_at]
|
|
387
|
+
* @property {string} [updated_ts]
|
|
445
388
|
*/
|
|
446
389
|
/**
|
|
447
390
|
* @typedef BagUnit
|
|
@@ -477,36 +420,29 @@ export = OrderPlatformModel;
|
|
|
477
420
|
*/
|
|
478
421
|
/**
|
|
479
422
|
* @typedef BillingInfo
|
|
480
|
-
* @property {string}
|
|
423
|
+
* @property {string} [address]
|
|
424
|
+
* @property {string} [address1]
|
|
481
425
|
* @property {string} [address2]
|
|
482
426
|
* @property {string} [alternate_email]
|
|
483
427
|
* @property {string} [alternate_mobile_number]
|
|
484
|
-
* @property {string} city
|
|
485
|
-
* @property {string} country
|
|
428
|
+
* @property {string} [city]
|
|
429
|
+
* @property {string} [country]
|
|
486
430
|
* @property {string} [country_code]
|
|
487
431
|
* @property {string} [customer_code]
|
|
488
432
|
* @property {string} [external_customer_code]
|
|
489
|
-
* @property {string} first_name
|
|
433
|
+
* @property {string} [first_name]
|
|
490
434
|
* @property {string} [floor_no]
|
|
491
435
|
* @property {string} [gender]
|
|
492
436
|
* @property {string} [house_no]
|
|
493
437
|
* @property {string} [last_name]
|
|
494
438
|
* @property {string} [middle_name]
|
|
495
|
-
* @property {string} pincode
|
|
496
|
-
* @property {string} primary_email
|
|
497
|
-
* @property {string} primary_mobile_number
|
|
498
|
-
* @property {string} state
|
|
439
|
+
* @property {string} [pincode]
|
|
440
|
+
* @property {string} [primary_email]
|
|
441
|
+
* @property {string} [primary_mobile_number]
|
|
442
|
+
* @property {string} [state]
|
|
499
443
|
* @property {string} [state_code]
|
|
500
444
|
* @property {string} [title]
|
|
501
445
|
*/
|
|
502
|
-
/**
|
|
503
|
-
* @typedef BillingStaffDetails
|
|
504
|
-
* @property {string} [employee_code]
|
|
505
|
-
* @property {string} [first_name]
|
|
506
|
-
* @property {string} [last_name]
|
|
507
|
-
* @property {number} [staff_id]
|
|
508
|
-
* @property {string} [user]
|
|
509
|
-
*/
|
|
510
446
|
/**
|
|
511
447
|
* @typedef Brand
|
|
512
448
|
* @property {number} brand_id
|
|
@@ -523,6 +459,33 @@ export = OrderPlatformModel;
|
|
|
523
459
|
* @property {string} [script_last_ran]
|
|
524
460
|
* @property {string} [start_date]
|
|
525
461
|
*/
|
|
462
|
+
/**
|
|
463
|
+
* @typedef BulkActionListingData
|
|
464
|
+
* @property {string} [batch_id]
|
|
465
|
+
* @property {string} [bulk_action_type]
|
|
466
|
+
* @property {number} [company_id]
|
|
467
|
+
* @property {string} [created_ts]
|
|
468
|
+
* @property {boolean} [do_invoice_label_generated]
|
|
469
|
+
* @property {string} [file_name]
|
|
470
|
+
* @property {string} [file_url]
|
|
471
|
+
* @property {number} [id]
|
|
472
|
+
* @property {string} [invoice_document_type]
|
|
473
|
+
* @property {string} [invoice_status]
|
|
474
|
+
* @property {boolean} [is_invoiceable]
|
|
475
|
+
* @property {string} [label_document_type]
|
|
476
|
+
* @property {string} [last_selected_invoice_label_type]
|
|
477
|
+
* @property {Object} [meta]
|
|
478
|
+
* @property {ShipmentActionInfo} [shipments_action_info]
|
|
479
|
+
* @property {boolean} [status]
|
|
480
|
+
* @property {string} [store_code]
|
|
481
|
+
* @property {number} [store_id]
|
|
482
|
+
* @property {string} [store_name]
|
|
483
|
+
* @property {number} [updated_ts]
|
|
484
|
+
* @property {string} [uploaded_by]
|
|
485
|
+
* @property {string} [uploaded_on]
|
|
486
|
+
* @property {string} [user_id]
|
|
487
|
+
* @property {string} [user_name]
|
|
488
|
+
*/
|
|
526
489
|
/**
|
|
527
490
|
* @typedef BulkActionTemplate
|
|
528
491
|
* @property {string} [text]
|
|
@@ -533,29 +496,57 @@ export = OrderPlatformModel;
|
|
|
533
496
|
* @property {BulkActionTemplate[]} [template_x_slug] - Allowed bulk action template slugs
|
|
534
497
|
*/
|
|
535
498
|
/**
|
|
536
|
-
* @typedef
|
|
499
|
+
* @typedef BulkFailedResponse
|
|
537
500
|
* @property {string} [error]
|
|
538
501
|
* @property {boolean} [status]
|
|
539
502
|
*/
|
|
503
|
+
/**
|
|
504
|
+
* @typedef BulkListingResponse
|
|
505
|
+
* @property {BulkActionListingData[]} [data]
|
|
506
|
+
* @property {BulkListinPage} [page]
|
|
507
|
+
* @property {boolean} [success]
|
|
508
|
+
* @property {number} [total_count]
|
|
509
|
+
*/
|
|
510
|
+
/**
|
|
511
|
+
* @typedef BulkListinPage
|
|
512
|
+
* @property {number} [current]
|
|
513
|
+
* @property {boolean} [has_next]
|
|
514
|
+
* @property {boolean} [has_previous]
|
|
515
|
+
* @property {number} [item_total]
|
|
516
|
+
* @property {number} [size]
|
|
517
|
+
* @property {number} [total]
|
|
518
|
+
* @property {string} [type]
|
|
519
|
+
*/
|
|
540
520
|
/**
|
|
541
521
|
* @typedef BulkReportsDownloadRequest
|
|
542
522
|
* @property {Object} [custom_filters_for_lane]
|
|
543
523
|
* @property {string} [custom_headers] - Download report with specific headers
|
|
524
|
+
* @property {string} [end_date] - UTC end date in ISO format
|
|
544
525
|
* @property {string[]} [entities] - Download for specific enitites, entities
|
|
545
526
|
* can be bag, shipment or order_id, etc.
|
|
546
527
|
* @property {string} [filter_type]
|
|
547
|
-
* @property {string} [from_date]
|
|
548
528
|
* @property {boolean} [is_cross_company_enabled] - Download lanes for cross company.
|
|
549
529
|
* @property {string} [lane_type]
|
|
550
530
|
* @property {string} [report_type] - Type of report
|
|
531
|
+
* @property {string} [start_date] - UTC start date in ISO format
|
|
551
532
|
* @property {string[]} [store_ids] - Download for specific store ids.
|
|
552
|
-
* @property {string} [to_date]
|
|
553
533
|
*/
|
|
554
534
|
/**
|
|
555
535
|
* @typedef BulkReportsDownloadResponse
|
|
556
536
|
* @property {string} [batch_id]
|
|
557
537
|
* @property {boolean} [success]
|
|
558
538
|
*/
|
|
539
|
+
/**
|
|
540
|
+
* @typedef BulkStateTransistionRequest
|
|
541
|
+
* @property {string} [file_name]
|
|
542
|
+
* @property {string} [url]
|
|
543
|
+
*/
|
|
544
|
+
/**
|
|
545
|
+
* @typedef BulkStateTransistionResponse
|
|
546
|
+
* @property {string} [batch_id]
|
|
547
|
+
* @property {string} [message]
|
|
548
|
+
* @property {boolean} [status]
|
|
549
|
+
*/
|
|
559
550
|
/**
|
|
560
551
|
* @typedef BuyerDetails
|
|
561
552
|
* @property {string} address
|
|
@@ -611,6 +602,11 @@ export = OrderPlatformModel;
|
|
|
611
602
|
* @property {string[]} [emails]
|
|
612
603
|
* @property {PhoneDetails[]} [phone]
|
|
613
604
|
*/
|
|
605
|
+
/**
|
|
606
|
+
* @typedef ConversionRate
|
|
607
|
+
* @property {string} [base]
|
|
608
|
+
* @property {Object} [rates]
|
|
609
|
+
*/
|
|
614
610
|
/**
|
|
615
611
|
* @typedef CourierPartnerTrackingDetails
|
|
616
612
|
* @property {string} awb - AWB Number
|
|
@@ -706,11 +702,22 @@ export = OrderPlatformModel;
|
|
|
706
702
|
* @property {string} [reason]
|
|
707
703
|
* @property {string} [total_credited_balance]
|
|
708
704
|
*/
|
|
705
|
+
/**
|
|
706
|
+
* @typedef Currency
|
|
707
|
+
* @property {string} [currency_code]
|
|
708
|
+
* @property {string} [currency_symbol]
|
|
709
|
+
*/
|
|
710
|
+
/**
|
|
711
|
+
* @typedef CurrencyInfo
|
|
712
|
+
* @property {ConversionRate} [conversion_rate]
|
|
713
|
+
* @property {OrderingCurrency} [ordering_currency]
|
|
714
|
+
*/
|
|
709
715
|
/**
|
|
710
716
|
* @typedef CurrentStatus
|
|
711
717
|
* @property {number} [bag_id]
|
|
712
718
|
* @property {BagStateMapper} [bag_state_mapper]
|
|
713
719
|
* @property {string} [created_at]
|
|
720
|
+
* @property {string} [created_ts]
|
|
714
721
|
* @property {string} [delivery_awb_number]
|
|
715
722
|
* @property {number} [delivery_partner_id]
|
|
716
723
|
* @property {number} id
|
|
@@ -728,6 +735,11 @@ export = OrderPlatformModel;
|
|
|
728
735
|
* @property {OrderItemDataUpdates[]} [order_item_status]
|
|
729
736
|
* @property {ProductsDataUpdates[]} [products]
|
|
730
737
|
*/
|
|
738
|
+
/**
|
|
739
|
+
* @typedef DateRange
|
|
740
|
+
* @property {string} [from_date]
|
|
741
|
+
* @property {string} [to_date]
|
|
742
|
+
*/
|
|
731
743
|
/**
|
|
732
744
|
* @typedef Dates
|
|
733
745
|
* @property {string} [delivery_date]
|
|
@@ -785,11 +797,51 @@ export = OrderPlatformModel;
|
|
|
785
797
|
* @property {string} [pincode]
|
|
786
798
|
* @property {string} [track_url]
|
|
787
799
|
*/
|
|
800
|
+
/**
|
|
801
|
+
* @typedef EInvoiceDetails
|
|
802
|
+
* @property {EInvoiceErrorDetails[]} [error_details]
|
|
803
|
+
* @property {EInvoiceIrnDetails} [irn_details]
|
|
804
|
+
*/
|
|
805
|
+
/**
|
|
806
|
+
* @typedef EInvoiceErrorDetails
|
|
807
|
+
* @property {string} [error_code]
|
|
808
|
+
* @property {string} error_message
|
|
809
|
+
*/
|
|
810
|
+
/**
|
|
811
|
+
* @typedef EInvoiceErrorInfo
|
|
812
|
+
* @property {EInvoiceErrorDetails[]} [error_details]
|
|
813
|
+
*/
|
|
814
|
+
/**
|
|
815
|
+
* @typedef EInvoiceErrorResponse
|
|
816
|
+
* @property {string} [message]
|
|
817
|
+
* @property {EInvoiceErrorResponseData[]} [response_data]
|
|
818
|
+
*/
|
|
819
|
+
/**
|
|
820
|
+
* @typedef EInvoiceErrorResponseData
|
|
821
|
+
* @property {EInvoiceErrorInfo} [einvoice_info]
|
|
822
|
+
* @property {string} einvoice_type
|
|
823
|
+
* @property {string} message
|
|
824
|
+
* @property {string} shipment_id
|
|
825
|
+
* @property {number} status
|
|
826
|
+
*/
|
|
827
|
+
/**
|
|
828
|
+
* @typedef EInvoiceErrorResponseDetails
|
|
829
|
+
* @property {string} [message]
|
|
830
|
+
* @property {EInvoiceErrorResponseData[]} response_data
|
|
831
|
+
*/
|
|
788
832
|
/**
|
|
789
833
|
* @typedef EinvoiceInfo
|
|
790
834
|
* @property {Object} [credit_note]
|
|
791
835
|
* @property {Object} [invoice]
|
|
792
836
|
*/
|
|
837
|
+
/**
|
|
838
|
+
* @typedef EInvoiceIrnDetails
|
|
839
|
+
* @property {string} ack_dt
|
|
840
|
+
* @property {string} ack_no
|
|
841
|
+
* @property {string} irn
|
|
842
|
+
* @property {string} signed_invoice
|
|
843
|
+
* @property {string} signed_qr_code
|
|
844
|
+
*/
|
|
793
845
|
/**
|
|
794
846
|
* @typedef EInvoicePortalDetails
|
|
795
847
|
* @property {string} [password]
|
|
@@ -798,14 +850,11 @@ export = OrderPlatformModel;
|
|
|
798
850
|
*/
|
|
799
851
|
/**
|
|
800
852
|
* @typedef EInvoiceResponseData
|
|
801
|
-
* @property {
|
|
802
|
-
* @property {string}
|
|
803
|
-
* @property {string} [irn]
|
|
853
|
+
* @property {EInvoiceDetails} [einvoice_info]
|
|
854
|
+
* @property {string} einvoice_type
|
|
804
855
|
* @property {string} message
|
|
805
856
|
* @property {string} shipment_id
|
|
806
|
-
* @property {
|
|
807
|
-
* @property {number} [timeout]
|
|
808
|
-
* @property {string} [timeout_unit]
|
|
857
|
+
* @property {number} status
|
|
809
858
|
*/
|
|
810
859
|
/**
|
|
811
860
|
* @typedef EInvoiceRetry
|
|
@@ -813,13 +862,11 @@ export = OrderPlatformModel;
|
|
|
813
862
|
*/
|
|
814
863
|
/**
|
|
815
864
|
* @typedef EInvoiceRetryResponse
|
|
816
|
-
* @property {string} [message]
|
|
817
865
|
* @property {EInvoiceResponseData[]} response_data
|
|
818
|
-
* @property {boolean} [success]
|
|
819
|
-
* @property {number} success_count
|
|
820
866
|
*/
|
|
821
867
|
/**
|
|
822
868
|
* @typedef EInvoiceRetryShipmentData
|
|
869
|
+
* @property {string} einvoice_type
|
|
823
870
|
* @property {string} shipment_id
|
|
824
871
|
*/
|
|
825
872
|
/**
|
|
@@ -863,12 +910,34 @@ export = OrderPlatformModel;
|
|
|
863
910
|
*/
|
|
864
911
|
/**
|
|
865
912
|
* @typedef ErrorResponse
|
|
866
|
-
* @property {string} error
|
|
913
|
+
* @property {string} [error]
|
|
867
914
|
* @property {string} [error_trace]
|
|
868
915
|
* @property {string} message
|
|
869
916
|
* @property {number} [status]
|
|
870
917
|
* @property {boolean} [success]
|
|
871
918
|
*/
|
|
919
|
+
/**
|
|
920
|
+
* @typedef FailedOrderLogDetails
|
|
921
|
+
* @property {string} error_trace
|
|
922
|
+
* @property {string} exception
|
|
923
|
+
*/
|
|
924
|
+
/**
|
|
925
|
+
* @typedef FailedOrderLogs
|
|
926
|
+
* @property {FailedOrdersItem} items
|
|
927
|
+
* @property {PageDetails} page
|
|
928
|
+
*/
|
|
929
|
+
/**
|
|
930
|
+
* @typedef FailedOrdersItem
|
|
931
|
+
* @property {LogsChannelDetails} channel
|
|
932
|
+
* @property {string} created_at
|
|
933
|
+
* @property {string} display_message
|
|
934
|
+
* @property {string} error_message
|
|
935
|
+
* @property {number} log_id
|
|
936
|
+
* @property {Object} meta
|
|
937
|
+
* @property {string} method_name
|
|
938
|
+
* @property {string} order_id
|
|
939
|
+
* @property {LogPaymentDetails} payment
|
|
940
|
+
*/
|
|
872
941
|
/**
|
|
873
942
|
* @typedef FetchCreditBalanceRequestPayload
|
|
874
943
|
* @property {string} affiliate_id
|
|
@@ -894,6 +963,19 @@ export = OrderPlatformModel;
|
|
|
894
963
|
* @property {string} [text]
|
|
895
964
|
* @property {string} [value]
|
|
896
965
|
*/
|
|
966
|
+
/**
|
|
967
|
+
* @typedef Filters
|
|
968
|
+
* @property {DateRange} [date_range]
|
|
969
|
+
* @property {number} [dp_ids]
|
|
970
|
+
* @property {string} [dp_name]
|
|
971
|
+
* @property {string} [from_date]
|
|
972
|
+
* @property {string} [lane]
|
|
973
|
+
* @property {string} [logo]
|
|
974
|
+
* @property {string} [selected_shipments]
|
|
975
|
+
* @property {string} [store_name]
|
|
976
|
+
* @property {number} [stores]
|
|
977
|
+
* @property {string} [to_date]
|
|
978
|
+
*/
|
|
897
979
|
/**
|
|
898
980
|
* @typedef FiltersInfo
|
|
899
981
|
* @property {FilterInfoOption[]} [options]
|
|
@@ -903,6 +985,16 @@ export = OrderPlatformModel;
|
|
|
903
985
|
* @property {string} type
|
|
904
986
|
* @property {string} value
|
|
905
987
|
*/
|
|
988
|
+
/**
|
|
989
|
+
* @typedef FiltersRequest
|
|
990
|
+
* @property {DateRange} [date_range]
|
|
991
|
+
* @property {number} dp_ids
|
|
992
|
+
* @property {string} dp_name
|
|
993
|
+
* @property {string} lane
|
|
994
|
+
* @property {string} [logo]
|
|
995
|
+
* @property {string} store_name
|
|
996
|
+
* @property {number} stores
|
|
997
|
+
*/
|
|
906
998
|
/**
|
|
907
999
|
* @typedef FiltersResponse
|
|
908
1000
|
* @property {AdvanceFilterInfo} [advance_filter]
|
|
@@ -962,39 +1054,16 @@ export = OrderPlatformModel;
|
|
|
962
1054
|
* @typedef FyndOrderIdList
|
|
963
1055
|
* @property {string[]} [fynd_order_id]
|
|
964
1056
|
*/
|
|
965
|
-
/**
|
|
966
|
-
* @typedef GenerateInvoiceIDErrorResponse
|
|
967
|
-
* @property {GenerateInvoiceIDErrorResponseData[]} [items]
|
|
968
|
-
*/
|
|
969
|
-
/**
|
|
970
|
-
* @typedef GenerateInvoiceIDErrorResponseData
|
|
971
|
-
* @property {string} [error_message]
|
|
972
|
-
* @property {boolean} [invoice_id]
|
|
973
|
-
* @property {string} [shipment_id]
|
|
974
|
-
* @property {boolean} [success]
|
|
975
|
-
*/
|
|
976
|
-
/**
|
|
977
|
-
* @typedef GenerateInvoiceIDRequest
|
|
978
|
-
* @property {string[]} shipment_ids
|
|
979
|
-
*/
|
|
980
|
-
/**
|
|
981
|
-
* @typedef GenerateInvoiceIDResponse
|
|
982
|
-
* @property {GenerateInvoiceIDResponseData[]} [items]
|
|
983
|
-
*/
|
|
984
|
-
/**
|
|
985
|
-
* @typedef GenerateInvoiceIDResponseData
|
|
986
|
-
* @property {boolean} [error_message]
|
|
987
|
-
* @property {string} [invoice_id]
|
|
988
|
-
* @property {string} [shipment_id]
|
|
989
|
-
* @property {boolean} [success]
|
|
990
|
-
*/
|
|
991
1057
|
/**
|
|
992
1058
|
* @typedef GeneratePosOrderReceiptResponse
|
|
993
1059
|
* @property {string} [customer_cn_receipt]
|
|
1060
|
+
* @property {string} [customer_cn_receipt_template]
|
|
994
1061
|
* @property {string} [invoice_receipt]
|
|
1062
|
+
* @property {string} [invoice_receipt_template]
|
|
995
1063
|
* @property {string} [merchant_cn_receipt]
|
|
996
1064
|
* @property {string} [order_id]
|
|
997
1065
|
* @property {string} [payment_receipt]
|
|
1066
|
+
* @property {string} [payment_receipt_template]
|
|
998
1067
|
* @property {boolean} [success]
|
|
999
1068
|
*/
|
|
1000
1069
|
/**
|
|
@@ -1006,13 +1075,6 @@ export = OrderPlatformModel;
|
|
|
1006
1075
|
* @property {BagDetailsPlatformResponse[]} items
|
|
1007
1076
|
* @property {BagsPage} page
|
|
1008
1077
|
*/
|
|
1009
|
-
/**
|
|
1010
|
-
* @typedef GiftCard
|
|
1011
|
-
* @property {string} [display_text]
|
|
1012
|
-
* @property {string} [gift_message]
|
|
1013
|
-
* @property {number} [gift_price]
|
|
1014
|
-
* @property {boolean} [is_gift_applied]
|
|
1015
|
-
*/
|
|
1016
1078
|
/**
|
|
1017
1079
|
* @typedef GSTDetailsData
|
|
1018
1080
|
* @property {number} brand_calculated_amount
|
|
@@ -1152,6 +1214,34 @@ export = OrderPlatformModel;
|
|
|
1152
1214
|
* @typedef ItemCriterias
|
|
1153
1215
|
* @property {number[]} [item_brand]
|
|
1154
1216
|
*/
|
|
1217
|
+
/**
|
|
1218
|
+
* @typedef JobDetailsData
|
|
1219
|
+
* @property {string} [batch_id]
|
|
1220
|
+
* @property {string} [company_id]
|
|
1221
|
+
* @property {number} [failed_shipments_count]
|
|
1222
|
+
* @property {number} [processing_shipments_count]
|
|
1223
|
+
* @property {string[]} [successful_shipment_ids]
|
|
1224
|
+
* @property {number} [successful_shipments_count]
|
|
1225
|
+
* @property {number} [total_shipments_count]
|
|
1226
|
+
*/
|
|
1227
|
+
/**
|
|
1228
|
+
* @typedef JobDetailsResponse
|
|
1229
|
+
* @property {string} [created_ts]
|
|
1230
|
+
* @property {JobDetailsData[]} [data]
|
|
1231
|
+
* @property {Object[]} [failed_records]
|
|
1232
|
+
* @property {string} [file_url]
|
|
1233
|
+
* @property {string} [message]
|
|
1234
|
+
* @property {string} [status]
|
|
1235
|
+
* @property {boolean} [success]
|
|
1236
|
+
* @property {string} [uploaded_by]
|
|
1237
|
+
* @property {string} [uploaded_on]
|
|
1238
|
+
* @property {string} [user_id]
|
|
1239
|
+
*/
|
|
1240
|
+
/**
|
|
1241
|
+
* @typedef JobFailedResponse
|
|
1242
|
+
* @property {string} [file_name]
|
|
1243
|
+
* @property {string} [url]
|
|
1244
|
+
*/
|
|
1155
1245
|
/**
|
|
1156
1246
|
* @typedef LaneConfigResponse
|
|
1157
1247
|
* @property {SuperLane[]} [super_lanes]
|
|
@@ -1177,6 +1267,99 @@ export = OrderPlatformModel;
|
|
|
1177
1267
|
* @property {boolean} [locked]
|
|
1178
1268
|
* @property {boolean} [mto]
|
|
1179
1269
|
*/
|
|
1270
|
+
/**
|
|
1271
|
+
* @typedef LogPaymentDetails
|
|
1272
|
+
* @property {string} [amount_paid]
|
|
1273
|
+
* @property {string} [payment_mode]
|
|
1274
|
+
*/
|
|
1275
|
+
/**
|
|
1276
|
+
* @typedef LogsChannelDetails
|
|
1277
|
+
* @property {string} [channel_id]
|
|
1278
|
+
* @property {string} [channel_shipment_id]
|
|
1279
|
+
* @property {string} [logo]
|
|
1280
|
+
* @property {string} [name]
|
|
1281
|
+
*/
|
|
1282
|
+
/**
|
|
1283
|
+
* @typedef Manifest
|
|
1284
|
+
* @property {number} company_id
|
|
1285
|
+
* @property {string} created_at
|
|
1286
|
+
* @property {string} created_by
|
|
1287
|
+
* @property {string} [created_ts]
|
|
1288
|
+
* @property {Filters} [filters]
|
|
1289
|
+
* @property {number} id
|
|
1290
|
+
* @property {boolean} is_active
|
|
1291
|
+
* @property {string} manifest_id
|
|
1292
|
+
* @property {ManifestMeta} [meta]
|
|
1293
|
+
* @property {PDFMeta} [pdf_meta]
|
|
1294
|
+
* @property {string} status
|
|
1295
|
+
* @property {string} uid
|
|
1296
|
+
* @property {string} user_id
|
|
1297
|
+
*/
|
|
1298
|
+
/**
|
|
1299
|
+
* @typedef ManifestDetails
|
|
1300
|
+
* @property {number} [additional_shipment_count]
|
|
1301
|
+
* @property {ManifestItemDetails[]} [items]
|
|
1302
|
+
* @property {Manifest[]} [manifest_details]
|
|
1303
|
+
* @property {ManifestPageInfo} [page]
|
|
1304
|
+
*/
|
|
1305
|
+
/**
|
|
1306
|
+
* @typedef ManifestFile
|
|
1307
|
+
* @property {string} [bucket]
|
|
1308
|
+
* @property {string} [key]
|
|
1309
|
+
* @property {string} [region]
|
|
1310
|
+
*/
|
|
1311
|
+
/**
|
|
1312
|
+
* @typedef ManifestFiltersResponse
|
|
1313
|
+
* @property {FiltersInfo[]} [advance_filter]
|
|
1314
|
+
* @property {FiltersInfo[]} [global_filter]
|
|
1315
|
+
*/
|
|
1316
|
+
/**
|
|
1317
|
+
* @typedef ManifestItemDetails
|
|
1318
|
+
* @property {string} [awb_number]
|
|
1319
|
+
* @property {string} [invoice_id]
|
|
1320
|
+
* @property {string} order_id
|
|
1321
|
+
* @property {number} [quantity]
|
|
1322
|
+
* @property {string} [shipment_created_at]
|
|
1323
|
+
* @property {string} shipment_id
|
|
1324
|
+
*/
|
|
1325
|
+
/**
|
|
1326
|
+
* @typedef ManifestList
|
|
1327
|
+
* @property {Manifest[]} [items]
|
|
1328
|
+
* @property {ManifestPageInfo} [page]
|
|
1329
|
+
*/
|
|
1330
|
+
/**
|
|
1331
|
+
* @typedef ManifestMediaUpdate
|
|
1332
|
+
* @property {number} [code]
|
|
1333
|
+
* @property {string} [entity]
|
|
1334
|
+
* @property {ManifestFile} [file]
|
|
1335
|
+
* @property {string} [link]
|
|
1336
|
+
* @property {string} [media_type]
|
|
1337
|
+
* @property {boolean} [status]
|
|
1338
|
+
*/
|
|
1339
|
+
/**
|
|
1340
|
+
* @typedef ManifestMeta
|
|
1341
|
+
* @property {Filters} [filters]
|
|
1342
|
+
* @property {TotalShipmentPricesCount} [total_shipment_prices_count]
|
|
1343
|
+
*/
|
|
1344
|
+
/**
|
|
1345
|
+
* @typedef ManifestPageInfo
|
|
1346
|
+
* @property {number} current
|
|
1347
|
+
* @property {boolean} has_next
|
|
1348
|
+
* @property {boolean} has_previous
|
|
1349
|
+
* @property {number} size
|
|
1350
|
+
* @property {number} total
|
|
1351
|
+
* @property {string} type
|
|
1352
|
+
*/
|
|
1353
|
+
/**
|
|
1354
|
+
* @typedef ManifestShipmentListing
|
|
1355
|
+
* @property {ManifestItemDetails[]} [items]
|
|
1356
|
+
* @property {string} [lane]
|
|
1357
|
+
* @property {string} [message]
|
|
1358
|
+
* @property {ManifestPageInfo} page
|
|
1359
|
+
* @property {number} status
|
|
1360
|
+
* @property {boolean} success
|
|
1361
|
+
* @property {number} total_count
|
|
1362
|
+
*/
|
|
1180
1363
|
/**
|
|
1181
1364
|
* @typedef MarketPlacePdf
|
|
1182
1365
|
* @property {string} [invoice]
|
|
@@ -1190,7 +1373,7 @@ export = OrderPlatformModel;
|
|
|
1190
1373
|
/**
|
|
1191
1374
|
* @typedef OrderBagArticle
|
|
1192
1375
|
* @property {Object} [identifiers]
|
|
1193
|
-
* @property {
|
|
1376
|
+
* @property {ReturnConfig} [return_config]
|
|
1194
1377
|
* @property {string} [size]
|
|
1195
1378
|
* @property {string} [uid]
|
|
1196
1379
|
*/
|
|
@@ -1243,6 +1426,7 @@ export = OrderPlatformModel;
|
|
|
1243
1426
|
*/
|
|
1244
1427
|
/**
|
|
1245
1428
|
* @typedef OrderData
|
|
1429
|
+
* @property {string} [created_ts]
|
|
1246
1430
|
* @property {string} fynd_order_id
|
|
1247
1431
|
* @property {Object} [meta]
|
|
1248
1432
|
* @property {string} order_date
|
|
@@ -1259,6 +1443,7 @@ export = OrderPlatformModel;
|
|
|
1259
1443
|
* @typedef OrderDetailsData
|
|
1260
1444
|
* @property {string} [affiliate_id]
|
|
1261
1445
|
* @property {string} [cod_charges]
|
|
1446
|
+
* @property {string} [created_ts]
|
|
1262
1447
|
* @property {string} fynd_order_id
|
|
1263
1448
|
* @property {Object} [meta]
|
|
1264
1449
|
* @property {string} [order_date]
|
|
@@ -1292,6 +1477,13 @@ export = OrderPlatformModel;
|
|
|
1292
1477
|
* @property {OrderUser} shipping_address
|
|
1293
1478
|
* @property {UserData} user
|
|
1294
1479
|
*/
|
|
1480
|
+
/**
|
|
1481
|
+
* @typedef OrderingCurrency
|
|
1482
|
+
* @property {string} [currency_code]
|
|
1483
|
+
* @property {string} [currency_name]
|
|
1484
|
+
* @property {string} [currency_sub_unit]
|
|
1485
|
+
* @property {string} [currency_symbol]
|
|
1486
|
+
*/
|
|
1295
1487
|
/**
|
|
1296
1488
|
* @typedef OrderingStoreDetails
|
|
1297
1489
|
* @property {string} [address]
|
|
@@ -1319,29 +1511,6 @@ export = OrderPlatformModel;
|
|
|
1319
1511
|
* @property {boolean} [success]
|
|
1320
1512
|
* @property {number} [total_count]
|
|
1321
1513
|
*/
|
|
1322
|
-
/**
|
|
1323
|
-
* @typedef OrderMeta
|
|
1324
|
-
* @property {BillingStaffDetails} [billing_staff_details]
|
|
1325
|
-
* @property {number} [cart_id]
|
|
1326
|
-
* @property {string} [cart_object_id]
|
|
1327
|
-
* @property {string} [comment]
|
|
1328
|
-
* @property {string} [company_logo]
|
|
1329
|
-
* @property {string} [currency_symbol]
|
|
1330
|
-
* @property {string} [customer_note]
|
|
1331
|
-
* @property {string} [employee_id]
|
|
1332
|
-
* @property {Object} [extra_meta]
|
|
1333
|
-
* @property {Object[]} [files]
|
|
1334
|
-
* @property {number} [mongo_cart_id]
|
|
1335
|
-
* @property {string[]} [order_child_entities]
|
|
1336
|
-
* @property {string} [order_platform]
|
|
1337
|
-
* @property {Object[]} [order_tags]
|
|
1338
|
-
* @property {string} [order_type]
|
|
1339
|
-
* @property {number} [ordering_store]
|
|
1340
|
-
* @property {string} [payment_type]
|
|
1341
|
-
* @property {PlatformUserDetails} [platform_user_details]
|
|
1342
|
-
* @property {Object} [staff]
|
|
1343
|
-
* @property {TransactionData} [transaction_data]
|
|
1344
|
-
*/
|
|
1345
1514
|
/**
|
|
1346
1515
|
* @typedef OrderPriority
|
|
1347
1516
|
* @property {string} [affiliate_priority_code]
|
|
@@ -1399,11 +1568,27 @@ export = OrderPlatformModel;
|
|
|
1399
1568
|
* @typedef PageDetails
|
|
1400
1569
|
* @property {number} [current] - Current page number
|
|
1401
1570
|
* @property {boolean} [has_next] - If next page contains any result
|
|
1571
|
+
* @property {boolean} [has_previous] - If previous page contains any result
|
|
1402
1572
|
* @property {number} item_total - Total count of the results present in the
|
|
1403
1573
|
* requested filter
|
|
1404
1574
|
* @property {number} [size] - Page size
|
|
1405
1575
|
* @property {string} [type] - Type of the page
|
|
1406
1576
|
*/
|
|
1577
|
+
/**
|
|
1578
|
+
* @typedef PaginatedStates
|
|
1579
|
+
* @property {StateManagerState[]} [items]
|
|
1580
|
+
* @property {PaginationInfo} [page]
|
|
1581
|
+
*/
|
|
1582
|
+
/**
|
|
1583
|
+
* @typedef PaginationInfo
|
|
1584
|
+
* @property {number} [current]
|
|
1585
|
+
* @property {boolean} [has_next]
|
|
1586
|
+
* @property {boolean} [has_previous]
|
|
1587
|
+
* @property {number} [item_total]
|
|
1588
|
+
* @property {number} [size]
|
|
1589
|
+
* @property {number} [total]
|
|
1590
|
+
* @property {string} [type]
|
|
1591
|
+
*/
|
|
1407
1592
|
/**
|
|
1408
1593
|
* @typedef PaymentInfo
|
|
1409
1594
|
* @property {PaymentMethod[]} [payment_methods]
|
|
@@ -1444,6 +1629,11 @@ export = OrderPlatformModel;
|
|
|
1444
1629
|
* @property {string} label_type
|
|
1445
1630
|
* @property {string} [po_invoice]
|
|
1446
1631
|
*/
|
|
1632
|
+
/**
|
|
1633
|
+
* @typedef PDFMeta
|
|
1634
|
+
* @property {string} [consent]
|
|
1635
|
+
* @property {ManifestMediaUpdate[]} [media_updates]
|
|
1636
|
+
*/
|
|
1447
1637
|
/**
|
|
1448
1638
|
* @typedef PhoneDetails
|
|
1449
1639
|
* @property {number} [country_code]
|
|
@@ -1513,8 +1703,11 @@ export = OrderPlatformModel;
|
|
|
1513
1703
|
* @typedef PlatformOrderItems
|
|
1514
1704
|
* @property {PlatformBreakupValues[]} [breakup_values]
|
|
1515
1705
|
* @property {PlatformChannel} [channel]
|
|
1706
|
+
* @property {Currency} [currency]
|
|
1707
|
+
* @property {CurrencyInfo} [currency_info]
|
|
1516
1708
|
* @property {Object} [meta]
|
|
1517
1709
|
* @property {string} [order_created_time]
|
|
1710
|
+
* @property {string} [order_created_ts]
|
|
1518
1711
|
* @property {string} [order_id]
|
|
1519
1712
|
* @property {number} [order_value]
|
|
1520
1713
|
* @property {string} [payment_mode]
|
|
@@ -1536,6 +1729,8 @@ export = OrderPlatformModel;
|
|
|
1536
1729
|
* @property {CompanyDetails} [company_details]
|
|
1537
1730
|
* @property {Object} [coupon]
|
|
1538
1731
|
* @property {string} [credit_note_id]
|
|
1732
|
+
* @property {Currency} [currency]
|
|
1733
|
+
* @property {CurrencyInfo} [currency_info]
|
|
1539
1734
|
* @property {string} [custom_message]
|
|
1540
1735
|
* @property {Object[]} [custom_meta]
|
|
1541
1736
|
* @property {UserDetailsData} [delivery_details]
|
|
@@ -1544,6 +1739,7 @@ export = OrderPlatformModel;
|
|
|
1544
1739
|
* @property {DPDetailsData} [dp_details]
|
|
1545
1740
|
* @property {boolean} [enable_dp_tracking]
|
|
1546
1741
|
* @property {string} [estimated_sla_time]
|
|
1742
|
+
* @property {string} [estimated_sla_ts]
|
|
1547
1743
|
* @property {string} [forward_shipment_id]
|
|
1548
1744
|
* @property {FulfillingStore} [fulfilling_store]
|
|
1549
1745
|
* @property {number} [fulfilment_priority]
|
|
@@ -1571,7 +1767,8 @@ export = OrderPlatformModel;
|
|
|
1571
1767
|
* @property {string} [priority_text]
|
|
1572
1768
|
* @property {PlatformDeliveryAddress} [rto_address]
|
|
1573
1769
|
* @property {string} [shipment_created_at]
|
|
1574
|
-
* @property {
|
|
1770
|
+
* @property {string} [shipment_created_ts]
|
|
1771
|
+
* @property {ShipmentLockDetails} [shipment_details]
|
|
1575
1772
|
* @property {string} shipment_id
|
|
1576
1773
|
* @property {string[]} [shipment_images]
|
|
1577
1774
|
* @property {number} [shipment_quantity]
|
|
@@ -1608,13 +1805,6 @@ export = OrderPlatformModel;
|
|
|
1608
1805
|
* @property {string} [updated_at]
|
|
1609
1806
|
* @property {string} [updated_time]
|
|
1610
1807
|
*/
|
|
1611
|
-
/**
|
|
1612
|
-
* @typedef PlatformUserDetails
|
|
1613
|
-
* @property {string} [platform_user_employee_code]
|
|
1614
|
-
* @property {string} [platform_user_first_name]
|
|
1615
|
-
* @property {string} [platform_user_id]
|
|
1616
|
-
* @property {string} [platform_user_last_name]
|
|
1617
|
-
*/
|
|
1618
1808
|
/**
|
|
1619
1809
|
* @typedef PointBlankOtpData
|
|
1620
1810
|
* @property {string} [message]
|
|
@@ -1679,6 +1869,27 @@ export = OrderPlatformModel;
|
|
|
1679
1869
|
* @property {Object} [dp_pickup_slot]
|
|
1680
1870
|
* @property {string} [pack_by_date]
|
|
1681
1871
|
*/
|
|
1872
|
+
/**
|
|
1873
|
+
* @typedef ProcessManifest
|
|
1874
|
+
* @property {string} action
|
|
1875
|
+
* @property {FiltersRequest} filters
|
|
1876
|
+
* @property {string} [manifest_id]
|
|
1877
|
+
* @property {string} unique_id
|
|
1878
|
+
*/
|
|
1879
|
+
/**
|
|
1880
|
+
* @typedef ProcessManifestItemResponse
|
|
1881
|
+
* @property {ProcessManifestResponse} [items]
|
|
1882
|
+
*/
|
|
1883
|
+
/**
|
|
1884
|
+
* @typedef ProcessManifestResponse
|
|
1885
|
+
* @property {string} [action]
|
|
1886
|
+
* @property {number} [company_id]
|
|
1887
|
+
* @property {string} [created_by]
|
|
1888
|
+
* @property {Filters} [filters]
|
|
1889
|
+
* @property {string} [manifest_id]
|
|
1890
|
+
* @property {string} [uid]
|
|
1891
|
+
* @property {string} [user_id]
|
|
1892
|
+
*/
|
|
1682
1893
|
/**
|
|
1683
1894
|
* @typedef Products
|
|
1684
1895
|
* @property {string} [identifier] - Product/Bag Article/Item Identifier
|
|
@@ -1773,12 +1984,6 @@ export = OrderPlatformModel;
|
|
|
1773
1984
|
* @property {number} [time]
|
|
1774
1985
|
* @property {string} [unit]
|
|
1775
1986
|
*/
|
|
1776
|
-
/**
|
|
1777
|
-
* @typedef ReturnConfig1
|
|
1778
|
-
* @property {boolean} [returnable]
|
|
1779
|
-
* @property {number} [time]
|
|
1780
|
-
* @property {string} [unit]
|
|
1781
|
-
*/
|
|
1782
1987
|
/**
|
|
1783
1988
|
* @typedef RoleBaseStateTransitionMapping
|
|
1784
1989
|
* @property {string[]} [next_statuses]
|
|
@@ -1811,6 +2016,18 @@ export = OrderPlatformModel;
|
|
|
1811
2016
|
* @property {number} [priority]
|
|
1812
2017
|
* @property {ProcessingDates} [processing_dates]
|
|
1813
2018
|
*/
|
|
2019
|
+
/**
|
|
2020
|
+
* @typedef ShipmentActionInfo
|
|
2021
|
+
* @property {Object} [failed_invoiced_shipments]
|
|
2022
|
+
* @property {Object[]} [failed_shipments]
|
|
2023
|
+
* @property {string[]} [invoice]
|
|
2024
|
+
* @property {string[]} [invoiceable_shipments]
|
|
2025
|
+
* @property {string[]} [label]
|
|
2026
|
+
* @property {string[]} [processing_invoice_shipments]
|
|
2027
|
+
* @property {string[]} [processing_shipments]
|
|
2028
|
+
* @property {string[]} [successful_invoiced_shipments]
|
|
2029
|
+
* @property {string[]} [successful_shipments]
|
|
2030
|
+
*/
|
|
1814
2031
|
/**
|
|
1815
2032
|
* @typedef ShipmentBagReasons
|
|
1816
2033
|
* @property {BagReasons[]} [reasons]
|
|
@@ -1842,14 +2059,11 @@ export = OrderPlatformModel;
|
|
|
1842
2059
|
*/
|
|
1843
2060
|
/**
|
|
1844
2061
|
* @typedef ShipmentDetails
|
|
1845
|
-
* @property {Object} [action_to_status]
|
|
1846
2062
|
* @property {string} affiliate_shipment_id
|
|
1847
2063
|
* @property {ArticleDetails[]} articles
|
|
1848
2064
|
* @property {string} [box_type]
|
|
1849
2065
|
* @property {number} [dp_id]
|
|
1850
2066
|
* @property {number} fulfillment_id
|
|
1851
|
-
* @property {string} [lock_message]
|
|
1852
|
-
* @property {boolean} [lock_status]
|
|
1853
2067
|
* @property {Object} [meta]
|
|
1854
2068
|
* @property {number} shipments
|
|
1855
2069
|
*/
|
|
@@ -1878,15 +2092,19 @@ export = OrderPlatformModel;
|
|
|
1878
2092
|
* @property {BagUnit[]} [bags]
|
|
1879
2093
|
* @property {boolean} [can_process]
|
|
1880
2094
|
* @property {ShipmentListingChannel} [channel]
|
|
2095
|
+
* @property {Currency} [currency]
|
|
2096
|
+
* @property {CurrencyInfo} [currency_info]
|
|
1881
2097
|
* @property {string} [customer_note]
|
|
1882
2098
|
* @property {PlatformDeliveryAddress} [delivery_address]
|
|
1883
2099
|
* @property {string} [display_name]
|
|
1884
2100
|
* @property {string} [estimated_sla_time]
|
|
2101
|
+
* @property {string} [estimated_sla_ts]
|
|
1885
2102
|
* @property {ShipmentItemFulFillingStore} [fulfilling_store]
|
|
1886
2103
|
* @property {string} [invoice_id]
|
|
1887
2104
|
* @property {boolean} [lock_status]
|
|
1888
2105
|
* @property {Object} [meta]
|
|
1889
2106
|
* @property {string} [mode_of_payment]
|
|
2107
|
+
* @property {string} [order_created_ts]
|
|
1890
2108
|
* @property {string} [order_date]
|
|
1891
2109
|
* @property {string} order_id
|
|
1892
2110
|
* @property {string} [ordering_channnel]
|
|
@@ -1895,9 +2113,11 @@ export = OrderPlatformModel;
|
|
|
1895
2113
|
* @property {string} [previous_shipment_id]
|
|
1896
2114
|
* @property {Prices} [prices]
|
|
1897
2115
|
* @property {string} shipment_created_at
|
|
2116
|
+
* @property {string} [shipment_created_ts]
|
|
1898
2117
|
* @property {string} [shipment_id]
|
|
1899
2118
|
* @property {ShipmentStatus} [shipment_status]
|
|
1900
2119
|
* @property {string} [status_created_at]
|
|
2120
|
+
* @property {string} [status_created_ts]
|
|
1901
2121
|
* @property {number} total_bags
|
|
1902
2122
|
* @property {UserDataInfo} [user]
|
|
1903
2123
|
*/
|
|
@@ -1915,39 +2135,7 @@ export = OrderPlatformModel;
|
|
|
1915
2135
|
* @property {string} [pincode]
|
|
1916
2136
|
* @property {string} [state]
|
|
1917
2137
|
* @property {string} [store_email]
|
|
1918
|
-
|
|
1919
|
-
/**
|
|
1920
|
-
* @typedef ShipmentItemMeta
|
|
1921
|
-
* @property {string} [activity_comment]
|
|
1922
|
-
* @property {boolean} [assign_dp_from_sb]
|
|
1923
|
-
* @property {boolean} auto_trigger_dp_assignment_acf
|
|
1924
|
-
* @property {Object} [bag_weight]
|
|
1925
|
-
* @property {Object} [debug_info]
|
|
1926
|
-
* @property {Object} [dp_options]
|
|
1927
|
-
* @property {string} [dp_sort_key]
|
|
1928
|
-
* @property {Object} [ewaybill_info]
|
|
1929
|
-
* @property {string[]} [existing_dp_list]
|
|
1930
|
-
* @property {Object} [external]
|
|
1931
|
-
* @property {Formatted} [formatted]
|
|
1932
|
-
* @property {string} [fulfilment_priority_text]
|
|
1933
|
-
* @property {boolean} [is_international]
|
|
1934
|
-
* @property {boolean} [is_self_ship]
|
|
1935
|
-
* @property {LockData} [lock_data]
|
|
1936
|
-
* @property {string} [order_type]
|
|
1937
|
-
* @property {string} [packaging_name]
|
|
1938
|
-
* @property {string} [parent_dp_id]
|
|
1939
|
-
* @property {Object[]} [pdf_media]
|
|
1940
|
-
* @property {boolean} [same_store_available]
|
|
1941
|
-
* @property {number} [shipment_chargeable_weight]
|
|
1942
|
-
* @property {ShipmentTags[]} [shipment_tags]
|
|
1943
|
-
* @property {number} [shipment_volumetric_weight]
|
|
1944
|
-
* @property {number} [shipment_weight]
|
|
1945
|
-
* @property {string} [shipping_zone]
|
|
1946
|
-
* @property {number} [sla]
|
|
1947
|
-
* @property {string} [store_invoice_updated_date]
|
|
1948
|
-
* @property {Object[]} [tags]
|
|
1949
|
-
* @property {ShipmentTimeStamp} [timestamp]
|
|
1950
|
-
* @property {number} [weight]
|
|
2138
|
+
* @property {string[]} [tags]
|
|
1951
2139
|
*/
|
|
1952
2140
|
/**
|
|
1953
2141
|
* @typedef ShipmentListingBrand
|
|
@@ -1963,6 +2151,12 @@ export = OrderPlatformModel;
|
|
|
1963
2151
|
* @property {string} [logo]
|
|
1964
2152
|
* @property {string} [name]
|
|
1965
2153
|
*/
|
|
2154
|
+
/**
|
|
2155
|
+
* @typedef ShipmentLockDetails
|
|
2156
|
+
* @property {Object} [action_to_status]
|
|
2157
|
+
* @property {string} [lock_message]
|
|
2158
|
+
* @property {boolean} [lock_status]
|
|
2159
|
+
*/
|
|
1966
2160
|
/**
|
|
1967
2161
|
* @typedef ShipmentMeta
|
|
1968
2162
|
* @property {boolean} [assign_dp_from_sb]
|
|
@@ -2048,18 +2242,21 @@ export = OrderPlatformModel;
|
|
|
2048
2242
|
* @typedef ShipmentStatus
|
|
2049
2243
|
* @property {string[]} [bag_list]
|
|
2050
2244
|
* @property {string} [created_at]
|
|
2245
|
+
* @property {string} [created_ts]
|
|
2051
2246
|
* @property {string} [current_shipment_status]
|
|
2052
2247
|
* @property {Object} [meta]
|
|
2053
2248
|
* @property {string} [shipment_id]
|
|
2054
2249
|
* @property {number} [shipment_status_id]
|
|
2055
2250
|
* @property {string} status
|
|
2056
2251
|
* @property {string} [status_created_at]
|
|
2252
|
+
* @property {string} [status_created_ts]
|
|
2057
2253
|
* @property {string} title
|
|
2058
2254
|
*/
|
|
2059
2255
|
/**
|
|
2060
2256
|
* @typedef ShipmentStatusData
|
|
2061
2257
|
* @property {string[]} [bag_list]
|
|
2062
2258
|
* @property {string} [created_at]
|
|
2259
|
+
* @property {string} [created_ts]
|
|
2063
2260
|
* @property {string} [current_shipment_status]
|
|
2064
2261
|
* @property {string} [display_name]
|
|
2065
2262
|
* @property {number} [id]
|
|
@@ -2080,17 +2277,18 @@ export = OrderPlatformModel;
|
|
|
2080
2277
|
*/
|
|
2081
2278
|
/**
|
|
2082
2279
|
* @typedef ShippingInfo
|
|
2280
|
+
* @property {string} [address]
|
|
2083
2281
|
* @property {string} [address_type]
|
|
2084
|
-
* @property {string} address1
|
|
2282
|
+
* @property {string} [address1]
|
|
2085
2283
|
* @property {string} [address2]
|
|
2086
2284
|
* @property {string} [alternate_email]
|
|
2087
2285
|
* @property {string} [alternate_mobile_number]
|
|
2088
|
-
* @property {string} city
|
|
2089
|
-
* @property {string} country
|
|
2286
|
+
* @property {string} [city]
|
|
2287
|
+
* @property {string} [country]
|
|
2090
2288
|
* @property {string} [country_code]
|
|
2091
2289
|
* @property {string} [customer_code]
|
|
2092
2290
|
* @property {string} [external_customer_code]
|
|
2093
|
-
* @property {string} first_name
|
|
2291
|
+
* @property {string} [first_name]
|
|
2094
2292
|
* @property {string} [floor_no]
|
|
2095
2293
|
* @property {string} [gender]
|
|
2096
2294
|
* @property {Object} [geo_location]
|
|
@@ -2098,12 +2296,12 @@ export = OrderPlatformModel;
|
|
|
2098
2296
|
* @property {string} [landmark]
|
|
2099
2297
|
* @property {string} [last_name]
|
|
2100
2298
|
* @property {string} [middle_name]
|
|
2101
|
-
* @property {string} pincode
|
|
2102
|
-
* @property {string} primary_email
|
|
2103
|
-
* @property {string} primary_mobile_number
|
|
2299
|
+
* @property {string} [pincode]
|
|
2300
|
+
* @property {string} [primary_email]
|
|
2301
|
+
* @property {string} [primary_mobile_number]
|
|
2104
2302
|
* @property {string} [shipping_type]
|
|
2105
2303
|
* @property {Object[]} [slot]
|
|
2106
|
-
* @property {string} state
|
|
2304
|
+
* @property {string} [state]
|
|
2107
2305
|
* @property {string} [state_code]
|
|
2108
2306
|
* @property {string} [title]
|
|
2109
2307
|
*/
|
|
@@ -2120,6 +2318,46 @@ export = OrderPlatformModel;
|
|
|
2120
2318
|
* @property {number} phone_number - Phone number for communication
|
|
2121
2319
|
* @property {number} shipment_id - ShipmentId
|
|
2122
2320
|
*/
|
|
2321
|
+
/**
|
|
2322
|
+
* @typedef StateManagerFilter
|
|
2323
|
+
* @property {string} [default_value]
|
|
2324
|
+
* @property {string} [description]
|
|
2325
|
+
* @property {string} [display_name]
|
|
2326
|
+
* @property {number} [id]
|
|
2327
|
+
* @property {string} [name]
|
|
2328
|
+
* @property {Object} [options]
|
|
2329
|
+
* @property {string} [type]
|
|
2330
|
+
*/
|
|
2331
|
+
/**
|
|
2332
|
+
* @typedef StateManagerState
|
|
2333
|
+
* @property {string} [app_display_name] - The application display name
|
|
2334
|
+
* @property {boolean} [app_facing] - Whether state is for app facing or not
|
|
2335
|
+
* @property {number} [id] - Unique identifier for the state
|
|
2336
|
+
* @property {boolean} [is_active] - Whether state is active or not
|
|
2337
|
+
* @property {string} [journey_type] - Type of the journey
|
|
2338
|
+
* @property {string} [platform_display_name] - The platform display name
|
|
2339
|
+
* @property {string} [state] - The name of the state
|
|
2340
|
+
* @property {string} [state_type] - Type of the state
|
|
2341
|
+
*/
|
|
2342
|
+
/**
|
|
2343
|
+
* @typedef StateManagerTask
|
|
2344
|
+
* @property {string} [description]
|
|
2345
|
+
* @property {string} [display_name]
|
|
2346
|
+
* @property {string} [doc_string]
|
|
2347
|
+
* @property {number} [id]
|
|
2348
|
+
* @property {Object} [kwargs]
|
|
2349
|
+
* @property {string} [name]
|
|
2350
|
+
*/
|
|
2351
|
+
/**
|
|
2352
|
+
* @typedef StateTransitionFlag
|
|
2353
|
+
* @property {string} [default_value]
|
|
2354
|
+
* @property {string} [description]
|
|
2355
|
+
* @property {string} [display_name]
|
|
2356
|
+
* @property {number} [id]
|
|
2357
|
+
* @property {string} [name]
|
|
2358
|
+
* @property {Object} [options]
|
|
2359
|
+
* @property {string} [type]
|
|
2360
|
+
*/
|
|
2123
2361
|
/**
|
|
2124
2362
|
* @typedef StatuesRequest
|
|
2125
2363
|
* @property {string} [exclude_bags_next_state] - State to be change for
|
|
@@ -2282,25 +2520,30 @@ export = OrderPlatformModel;
|
|
|
2282
2520
|
* @property {string} [gstin]
|
|
2283
2521
|
* @property {string} [pan_no]
|
|
2284
2522
|
*/
|
|
2523
|
+
/**
|
|
2524
|
+
* @typedef TemplateDownloadResponse
|
|
2525
|
+
* @property {string} [file_name]
|
|
2526
|
+
* @property {string} [url]
|
|
2527
|
+
*/
|
|
2528
|
+
/**
|
|
2529
|
+
* @typedef Templates
|
|
2530
|
+
* @property {string} [text]
|
|
2531
|
+
* @property {string} [value]
|
|
2532
|
+
*/
|
|
2533
|
+
/**
|
|
2534
|
+
* @typedef TotalShipmentPricesCount
|
|
2535
|
+
* @property {number} [shipment_count]
|
|
2536
|
+
* @property {number} [total_price]
|
|
2537
|
+
*/
|
|
2285
2538
|
/**
|
|
2286
2539
|
* @typedef TrackingList
|
|
2540
|
+
* @property {string} [created_ts]
|
|
2287
2541
|
* @property {boolean} [is_current]
|
|
2288
2542
|
* @property {boolean} [is_passed]
|
|
2289
2543
|
* @property {string} status
|
|
2290
2544
|
* @property {string} text
|
|
2291
2545
|
* @property {string} [time]
|
|
2292
2546
|
*/
|
|
2293
|
-
/**
|
|
2294
|
-
* @typedef TransactionData
|
|
2295
|
-
* @property {number} [amount_paid]
|
|
2296
|
-
* @property {string} [currency]
|
|
2297
|
-
* @property {string} [entity]
|
|
2298
|
-
* @property {string} [payment_id]
|
|
2299
|
-
* @property {string} [status]
|
|
2300
|
-
* @property {string} [terminal_id]
|
|
2301
|
-
* @property {string} [transaction_id]
|
|
2302
|
-
* @property {string} [unique_reference_number]
|
|
2303
|
-
*/
|
|
2304
2547
|
/**
|
|
2305
2548
|
* @typedef UpdatePackagingDimensionsPayload
|
|
2306
2549
|
* @property {string} current_status
|
|
@@ -2374,12 +2617,15 @@ export = OrderPlatformModel;
|
|
|
2374
2617
|
* @property {string} [area]
|
|
2375
2618
|
* @property {string} city
|
|
2376
2619
|
* @property {string} country
|
|
2620
|
+
* @property {string} [country_iso_code]
|
|
2621
|
+
* @property {string} [country_phone_code]
|
|
2377
2622
|
* @property {string} [email]
|
|
2378
2623
|
* @property {string} [landmark]
|
|
2379
2624
|
* @property {string} name
|
|
2380
2625
|
* @property {string} phone
|
|
2381
2626
|
* @property {string} pincode
|
|
2382
2627
|
* @property {string} state
|
|
2628
|
+
* @property {string} [state_code]
|
|
2383
2629
|
*/
|
|
2384
2630
|
/**
|
|
2385
2631
|
* @typedef UserInfo
|
|
@@ -2425,7 +2671,7 @@ export = OrderPlatformModel;
|
|
|
2425
2671
|
declare class OrderPlatformModel {
|
|
2426
2672
|
}
|
|
2427
2673
|
declare namespace OrderPlatformModel {
|
|
2428
|
-
export { ActionInfo, AdvanceFilterInfo, Affiliate, AffiliateAppConfig, AffiliateAppConfigMeta, AffiliateBag, AffiliateBagDetails, AffiliateBagsDetails, AffiliateConfig, AffiliateDetails, AffiliateInventoryArticleAssignmentConfig, AffiliateInventoryConfig, AffiliateInventoryLogisticsConfig, AffiliateInventoryOrderConfig, AffiliateInventoryPaymentConfig, AffiliateInventoryStoreConfig, AffiliateMeta, AffiliateStoreIdMapping, AnnouncementResponse, AnnouncementsResponse, AppliedPromos, Article, ArticleDetails, AttachOrderUser, AttachOrderUserResponse, AttachUserInfo, AttachUserOtpData, Attributes,
|
|
2674
|
+
export { ActionInfo, AdvanceFilterInfo, Affiliate, AffiliateAppConfig, AffiliateAppConfigMeta, AffiliateBag, AffiliateBagDetails, AffiliateBagsDetails, AffiliateConfig, AffiliateDetails, AffiliateInventoryArticleAssignmentConfig, AffiliateInventoryConfig, AffiliateInventoryLogisticsConfig, AffiliateInventoryOrderConfig, AffiliateInventoryPaymentConfig, AffiliateInventoryStoreConfig, AffiliateMeta, AffiliateStoreIdMapping, AllowedTemplatesResponse, AnnouncementResponse, AnnouncementsResponse, AppliedPromos, Article, ArticleDetails, ArticleStatusDetails, AttachOrderUser, AttachOrderUserResponse, AttachUserInfo, AttachUserOtpData, Attributes, BagConfigs, BagDetailsPlatformResponse, BagPaymentMethods, BagReasonMeta, BagReasons, BagReturnableCancelableStatus, Bags, BagsPage, BagStateMapper, BagStateTransitionMap, BagStatusHistory, BagUnit, BaseResponse, BillingInfo, Brand, BulkActionListingData, BulkActionTemplate, BulkActionTemplateResponse, BulkFailedResponse, BulkListingResponse, BulkListinPage, BulkReportsDownloadRequest, BulkReportsDownloadResponse, BulkStateTransistionRequest, BulkStateTransistionResponse, BuyerDetails, BuyRules, Charge, CheckResponse, Click2CallResponse, CompanyDetails, ContactDetails, ConversionRate, CourierPartnerTrackingDetails, CourierPartnerTrackingResponse, CreateChannelConfig, CreateChannelConfigData, CreateChannelConfigResponse, CreateChannelConifgErrorResponse, CreateChannelPaymentInfo, CreateOrderAPI, CreateOrderErrorReponse, CreateOrderPayload, CreateOrderResponse, CreditBalanceInfo, Currency, CurrencyInfo, CurrentStatus, DataUpdates, DateRange, Dates, DebugInfo, Dimension, Dimensions, DiscountRules, DispatchManifest, Document, DpConfiguration, DPDetailsData, EInvoiceDetails, EInvoiceErrorDetails, EInvoiceErrorInfo, EInvoiceErrorResponse, EInvoiceErrorResponseData, EInvoiceErrorResponseDetails, EinvoiceInfo, EInvoiceIrnDetails, EInvoicePortalDetails, EInvoiceResponseData, EInvoiceRetry, EInvoiceRetryResponse, EInvoiceRetryShipmentData, Entities, EntitiesDataUpdates, EntitiesReasons, EntityReasonData, Error, ErrorDetail, ErrorResponse, FailedOrderLogDetails, FailedOrderLogs, FailedOrdersItem, FetchCreditBalanceRequestPayload, FetchCreditBalanceResponsePayload, FileResponse, FilterInfoOption, Filters, FiltersInfo, FiltersRequest, FiltersResponse, FinancialBreakup, Formatted, FulfillingStore, FyndOrderIdList, GeneratePosOrderReceiptResponse, GetActionsResponse, GetBagsPlatformResponse, GSTDetailsData, HistoryDict, HistoryMeta, HistoryReason, Identifier, InvalidateShipmentCacheNestedResponse, InvalidateShipmentCachePayload, InvalidateShipmentCacheResponse, InvoiceInfo, Item, ItemCriterias, JobDetailsData, JobDetailsResponse, JobFailedResponse, LaneConfigResponse, LineItem, LocationDetails, LockData, LogPaymentDetails, LogsChannelDetails, Manifest, ManifestDetails, ManifestFile, ManifestFiltersResponse, ManifestItemDetails, ManifestList, ManifestMediaUpdate, ManifestMeta, ManifestPageInfo, ManifestShipmentListing, MarketPlacePdf, Meta, OrderBagArticle, OrderBags, OrderBrandName, OrderConfig, OrderData, OrderDetails, OrderDetailsData, OrderDetailsResponse, OrderInfo, OrderingCurrency, OrderingStoreDetails, OrderItemDataUpdates, OrderListingResponse, OrderPriority, OrderStatus, OrderStatusData, OrderStatusResult, OrderUser, OriginalFilter, Page, PageDetails, PaginatedStates, PaginationInfo, PaymentInfo, PaymentMethod, PaymentMethods, PDFLinks, PDFMeta, PhoneDetails, PlatformArticleAttributes, PlatformBreakupValues, PlatformChannel, PlatformDeliveryAddress, PlatformItem, PlatformOrderItems, PlatformOrderUpdate, PlatformShipment, PlatformShipmentReasonsResponse, PlatformShipmentTrack, PlatformTrack, PointBlankOtpData, PostActivityHistory, PostHistoryData, PostHistoryDict, PostHistoryFilters, PostShipmentHistory, Prices, ProcessingDates, ProcessManifest, ProcessManifestItemResponse, ProcessManifestResponse, Products, ProductsDataUpdates, ProductsDataUpdatesFilters, ProductsReasons, ProductsReasonsData, ProductsReasonsFilters, QuestionSet, Reason, ReasonsData, RefundModeConfigRequestPayload, RefundModeConfigResponsePayload, RefundModeInfo, RefundOption, ReplacementDetails, ResponseDetail, ReturnConfig, RoleBaseStateTransitionMapping, SendSmsPayload, SendUserMobileOTP, SendUserMobileOtpResponse, Shipment, ShipmentActionInfo, ShipmentBagReasons, ShipmentConfig, ShipmentData, ShipmentDetail, ShipmentDetails, ShipmentHistoryResponse, ShipmentInfoResponse, ShipmentInternalPlatformViewResponse, ShipmentItem, ShipmentItemFulFillingStore, ShipmentListingBrand, ShipmentListingChannel, ShipmentLockDetails, ShipmentMeta, ShipmentPayments, ShipmentReasonsResponse, ShipmentResponseReasons, ShipmentsRequest, ShipmentsResponse, ShipmentStatus, ShipmentStatusData, ShipmentTags, ShipmentTimeStamp, ShippingInfo, SmsDataPayload, StateManagerFilter, StateManagerState, StateManagerTask, StateTransitionFlag, StatuesRequest, StatuesResponse, Store, StoreAddress, StoreDocuments, StoreEinvoice, StoreEwaybill, StoreGstCredentials, StoreMeta, StoreReassign, StoreReassignResponse, SubLane, SuccessResponse, SuperLane, Tax, TaxDetails, TaxInfo, TemplateDownloadResponse, Templates, TotalShipmentPricesCount, TrackingList, UpdatePackagingDimensionsPayload, UpdatePackagingDimensionsResponse, UpdateShipmentLockPayload, UpdateShipmentLockResponse, UpdateShipmentStatusRequest, UpdateShipmentStatusResponseBody, UploadConsent, URL, UserData, UserDataInfo, UserDetailsData, UserInfo, VerifyMobileOTP, VerifyOtpData, VerifyOtpResponse, VerifyOtpResponseData, Weight };
|
|
2429
2675
|
}
|
|
2430
2676
|
/** @returns {ActionInfo} */
|
|
2431
2677
|
declare function ActionInfo(): ActionInfo;
|
|
@@ -2598,6 +2844,11 @@ type AffiliateStoreIdMapping = {
|
|
|
2598
2844
|
marketplace_store_id: string;
|
|
2599
2845
|
store_id: number;
|
|
2600
2846
|
};
|
|
2847
|
+
/** @returns {AllowedTemplatesResponse} */
|
|
2848
|
+
declare function AllowedTemplatesResponse(): AllowedTemplatesResponse;
|
|
2849
|
+
type AllowedTemplatesResponse = {
|
|
2850
|
+
template_x_slug?: Templates[];
|
|
2851
|
+
};
|
|
2601
2852
|
/** @returns {AnnouncementResponse} */
|
|
2602
2853
|
declare function AnnouncementResponse(): AnnouncementResponse;
|
|
2603
2854
|
type AnnouncementResponse = {
|
|
@@ -2659,9 +2910,13 @@ type ArticleDetails = {
|
|
|
2659
2910
|
category: any;
|
|
2660
2911
|
dimension: any;
|
|
2661
2912
|
quantity: number;
|
|
2662
|
-
status?: any;
|
|
2663
2913
|
weight: any;
|
|
2664
2914
|
};
|
|
2915
|
+
/** @returns {ArticleStatusDetails} */
|
|
2916
|
+
declare function ArticleStatusDetails(): ArticleStatusDetails;
|
|
2917
|
+
type ArticleStatusDetails = {
|
|
2918
|
+
status?: any;
|
|
2919
|
+
};
|
|
2665
2920
|
/** @returns {AttachOrderUser} */
|
|
2666
2921
|
declare function AttachOrderUser(): AttachOrderUser;
|
|
2667
2922
|
type AttachOrderUser = {
|
|
@@ -2701,16 +2956,6 @@ type Attributes = {
|
|
|
2701
2956
|
primary_color_hex?: string;
|
|
2702
2957
|
primary_material?: string;
|
|
2703
2958
|
};
|
|
2704
|
-
/** @returns {B2BPODetails} */
|
|
2705
|
-
declare function B2BPODetails(): B2BPODetails;
|
|
2706
|
-
type B2BPODetails = {
|
|
2707
|
-
docker_number?: string;
|
|
2708
|
-
item_base_price?: number;
|
|
2709
|
-
partial_can_ret?: boolean;
|
|
2710
|
-
po_line_amount?: number;
|
|
2711
|
-
po_tax_amount?: number;
|
|
2712
|
-
total_gst_percentage?: number;
|
|
2713
|
-
};
|
|
2714
2959
|
/** @returns {BagConfigs} */
|
|
2715
2960
|
declare function BagConfigs(): BagConfigs;
|
|
2716
2961
|
type BagConfigs = {
|
|
@@ -2728,7 +2973,7 @@ type BagDetailsPlatformResponse = {
|
|
|
2728
2973
|
affiliate_details?: AffiliateDetails;
|
|
2729
2974
|
applied_promos?: any[];
|
|
2730
2975
|
article?: Article;
|
|
2731
|
-
article_details?:
|
|
2976
|
+
article_details?: ArticleStatusDetails;
|
|
2732
2977
|
bag_status?: BagStatusHistory[];
|
|
2733
2978
|
bag_status_history?: BagStatusHistory;
|
|
2734
2979
|
bag_update_time?: number;
|
|
@@ -2760,62 +3005,10 @@ type BagDetailsPlatformResponse = {
|
|
|
2760
3005
|
restore_promos?: any;
|
|
2761
3006
|
seller_identifier?: string;
|
|
2762
3007
|
shipment_id?: string;
|
|
2763
|
-
status?:
|
|
3008
|
+
status?: BagReturnableCancelableStatus;
|
|
2764
3009
|
tags?: string[];
|
|
2765
3010
|
type?: string;
|
|
2766
3011
|
};
|
|
2767
|
-
/** @returns {BagGST} */
|
|
2768
|
-
declare function BagGST(): BagGST;
|
|
2769
|
-
type BagGST = {
|
|
2770
|
-
brand_calculated_amount?: number;
|
|
2771
|
-
cgst_gst_fee?: string;
|
|
2772
|
-
cgst_tax_percentage?: number;
|
|
2773
|
-
gst_fee?: number;
|
|
2774
|
-
gst_tag?: string;
|
|
2775
|
-
gst_tax_percentage?: number;
|
|
2776
|
-
gstin_code?: string;
|
|
2777
|
-
hsn_code?: string;
|
|
2778
|
-
hsn_code_id?: string;
|
|
2779
|
-
igst_gst_fee?: string;
|
|
2780
|
-
igst_tax_percentage?: number;
|
|
2781
|
-
is_default_hsn_code?: boolean;
|
|
2782
|
-
sgst_gst_fee?: string;
|
|
2783
|
-
sgst_tax_percentage?: number;
|
|
2784
|
-
tax_collected_at_source?: number;
|
|
2785
|
-
value_of_good?: number;
|
|
2786
|
-
};
|
|
2787
|
-
/** @returns {BagGSTDetails} */
|
|
2788
|
-
declare function BagGSTDetails(): BagGSTDetails;
|
|
2789
|
-
type BagGSTDetails = {
|
|
2790
|
-
brand_calculated_amount: number;
|
|
2791
|
-
cgst_gst_fee: string;
|
|
2792
|
-
cgst_tax_percentage: number;
|
|
2793
|
-
gst_fee: number;
|
|
2794
|
-
gst_tag: string;
|
|
2795
|
-
gst_tax_percentage: number;
|
|
2796
|
-
gstin_code?: string;
|
|
2797
|
-
hsn_code: string;
|
|
2798
|
-
hsn_code_id: string;
|
|
2799
|
-
igst_gst_fee: string;
|
|
2800
|
-
igst_tax_percentage: number;
|
|
2801
|
-
is_default_hsn_code?: boolean;
|
|
2802
|
-
sgst_gst_fee: string;
|
|
2803
|
-
sgst_tax_percentage: number;
|
|
2804
|
-
tax_collected_at_source: number;
|
|
2805
|
-
value_of_good: number;
|
|
2806
|
-
};
|
|
2807
|
-
/** @returns {BagMeta} */
|
|
2808
|
-
declare function BagMeta(): BagMeta;
|
|
2809
|
-
type BagMeta = {
|
|
2810
|
-
b2b_po_details?: B2BPODetails;
|
|
2811
|
-
custom_json?: any;
|
|
2812
|
-
custom_message?: string;
|
|
2813
|
-
docket_number?: string;
|
|
2814
|
-
extra_meta?: any;
|
|
2815
|
-
gift_card?: GiftCard;
|
|
2816
|
-
group_id?: string;
|
|
2817
|
-
partial_can_ret?: boolean;
|
|
2818
|
-
};
|
|
2819
3012
|
/** @returns {BagPaymentMethods} */
|
|
2820
3013
|
declare function BagPaymentMethods(): BagPaymentMethods;
|
|
2821
3014
|
type BagPaymentMethods = {
|
|
@@ -2846,15 +3039,6 @@ type BagReturnableCancelableStatus = {
|
|
|
2846
3039
|
is_customer_return_allowed: boolean;
|
|
2847
3040
|
is_returnable: boolean;
|
|
2848
3041
|
};
|
|
2849
|
-
/** @returns {BagReturnableCancelableStatus1} */
|
|
2850
|
-
declare function BagReturnableCancelableStatus1(): BagReturnableCancelableStatus1;
|
|
2851
|
-
type BagReturnableCancelableStatus1 = {
|
|
2852
|
-
can_be_cancelled: boolean;
|
|
2853
|
-
enable_tracking: boolean;
|
|
2854
|
-
is_active: boolean;
|
|
2855
|
-
is_customer_return_allowed: boolean;
|
|
2856
|
-
is_returnable: boolean;
|
|
2857
|
-
};
|
|
2858
3042
|
/** @returns {Bags} */
|
|
2859
3043
|
declare function Bags(): Bags;
|
|
2860
3044
|
type Bags = {
|
|
@@ -2914,6 +3098,7 @@ type BagStatusHistory = {
|
|
|
2914
3098
|
bag_state_mapper?: BagStateMapper;
|
|
2915
3099
|
bsh_id?: number;
|
|
2916
3100
|
created_at?: string;
|
|
3101
|
+
created_ts?: string;
|
|
2917
3102
|
delivery_awb_number?: string;
|
|
2918
3103
|
delivery_partner_id?: number;
|
|
2919
3104
|
display_name?: string;
|
|
@@ -2926,6 +3111,7 @@ type BagStatusHistory = {
|
|
|
2926
3111
|
status: string;
|
|
2927
3112
|
store_id?: number;
|
|
2928
3113
|
updated_at?: string;
|
|
3114
|
+
updated_ts?: string;
|
|
2929
3115
|
};
|
|
2930
3116
|
/** @returns {BagUnit} */
|
|
2931
3117
|
declare function BagUnit(): BagUnit;
|
|
@@ -2964,37 +3150,29 @@ type BaseResponse = {
|
|
|
2964
3150
|
/** @returns {BillingInfo} */
|
|
2965
3151
|
declare function BillingInfo(): BillingInfo;
|
|
2966
3152
|
type BillingInfo = {
|
|
2967
|
-
|
|
3153
|
+
address?: string;
|
|
3154
|
+
address1?: string;
|
|
2968
3155
|
address2?: string;
|
|
2969
3156
|
alternate_email?: string;
|
|
2970
3157
|
alternate_mobile_number?: string;
|
|
2971
|
-
city
|
|
2972
|
-
country
|
|
3158
|
+
city?: string;
|
|
3159
|
+
country?: string;
|
|
2973
3160
|
country_code?: string;
|
|
2974
3161
|
customer_code?: string;
|
|
2975
3162
|
external_customer_code?: string;
|
|
2976
|
-
first_name
|
|
3163
|
+
first_name?: string;
|
|
2977
3164
|
floor_no?: string;
|
|
2978
3165
|
gender?: string;
|
|
2979
3166
|
house_no?: string;
|
|
2980
3167
|
last_name?: string;
|
|
2981
3168
|
middle_name?: string;
|
|
2982
|
-
pincode
|
|
2983
|
-
primary_email
|
|
2984
|
-
primary_mobile_number
|
|
2985
|
-
state
|
|
3169
|
+
pincode?: string;
|
|
3170
|
+
primary_email?: string;
|
|
3171
|
+
primary_mobile_number?: string;
|
|
3172
|
+
state?: string;
|
|
2986
3173
|
state_code?: string;
|
|
2987
3174
|
title?: string;
|
|
2988
3175
|
};
|
|
2989
|
-
/** @returns {BillingStaffDetails} */
|
|
2990
|
-
declare function BillingStaffDetails(): BillingStaffDetails;
|
|
2991
|
-
type BillingStaffDetails = {
|
|
2992
|
-
employee_code?: string;
|
|
2993
|
-
first_name?: string;
|
|
2994
|
-
last_name?: string;
|
|
2995
|
-
staff_id?: number;
|
|
2996
|
-
user?: string;
|
|
2997
|
-
};
|
|
2998
3176
|
/** @returns {Brand} */
|
|
2999
3177
|
declare function Brand(): Brand;
|
|
3000
3178
|
type Brand = {
|
|
@@ -3012,6 +3190,34 @@ type Brand = {
|
|
|
3012
3190
|
script_last_ran?: string;
|
|
3013
3191
|
start_date?: string;
|
|
3014
3192
|
};
|
|
3193
|
+
/** @returns {BulkActionListingData} */
|
|
3194
|
+
declare function BulkActionListingData(): BulkActionListingData;
|
|
3195
|
+
type BulkActionListingData = {
|
|
3196
|
+
batch_id?: string;
|
|
3197
|
+
bulk_action_type?: string;
|
|
3198
|
+
company_id?: number;
|
|
3199
|
+
created_ts?: string;
|
|
3200
|
+
do_invoice_label_generated?: boolean;
|
|
3201
|
+
file_name?: string;
|
|
3202
|
+
file_url?: string;
|
|
3203
|
+
id?: number;
|
|
3204
|
+
invoice_document_type?: string;
|
|
3205
|
+
invoice_status?: string;
|
|
3206
|
+
is_invoiceable?: boolean;
|
|
3207
|
+
label_document_type?: string;
|
|
3208
|
+
last_selected_invoice_label_type?: string;
|
|
3209
|
+
meta?: any;
|
|
3210
|
+
shipments_action_info?: ShipmentActionInfo;
|
|
3211
|
+
status?: boolean;
|
|
3212
|
+
store_code?: string;
|
|
3213
|
+
store_id?: number;
|
|
3214
|
+
store_name?: string;
|
|
3215
|
+
updated_ts?: number;
|
|
3216
|
+
uploaded_by?: string;
|
|
3217
|
+
uploaded_on?: string;
|
|
3218
|
+
user_id?: string;
|
|
3219
|
+
user_name?: string;
|
|
3220
|
+
};
|
|
3015
3221
|
/** @returns {BulkActionTemplate} */
|
|
3016
3222
|
declare function BulkActionTemplate(): BulkActionTemplate;
|
|
3017
3223
|
type BulkActionTemplate = {
|
|
@@ -3026,12 +3232,31 @@ type BulkActionTemplateResponse = {
|
|
|
3026
3232
|
*/
|
|
3027
3233
|
template_x_slug?: BulkActionTemplate[];
|
|
3028
3234
|
};
|
|
3029
|
-
/** @returns {
|
|
3030
|
-
declare function
|
|
3031
|
-
type
|
|
3235
|
+
/** @returns {BulkFailedResponse} */
|
|
3236
|
+
declare function BulkFailedResponse(): BulkFailedResponse;
|
|
3237
|
+
type BulkFailedResponse = {
|
|
3032
3238
|
error?: string;
|
|
3033
3239
|
status?: boolean;
|
|
3034
3240
|
};
|
|
3241
|
+
/** @returns {BulkListingResponse} */
|
|
3242
|
+
declare function BulkListingResponse(): BulkListingResponse;
|
|
3243
|
+
type BulkListingResponse = {
|
|
3244
|
+
data?: BulkActionListingData[];
|
|
3245
|
+
page?: BulkListinPage;
|
|
3246
|
+
success?: boolean;
|
|
3247
|
+
total_count?: number;
|
|
3248
|
+
};
|
|
3249
|
+
/** @returns {BulkListinPage} */
|
|
3250
|
+
declare function BulkListinPage(): BulkListinPage;
|
|
3251
|
+
type BulkListinPage = {
|
|
3252
|
+
current?: number;
|
|
3253
|
+
has_next?: boolean;
|
|
3254
|
+
has_previous?: boolean;
|
|
3255
|
+
item_total?: number;
|
|
3256
|
+
size?: number;
|
|
3257
|
+
total?: number;
|
|
3258
|
+
type?: string;
|
|
3259
|
+
};
|
|
3035
3260
|
/** @returns {BulkReportsDownloadRequest} */
|
|
3036
3261
|
declare function BulkReportsDownloadRequest(): BulkReportsDownloadRequest;
|
|
3037
3262
|
type BulkReportsDownloadRequest = {
|
|
@@ -3040,13 +3265,16 @@ type BulkReportsDownloadRequest = {
|
|
|
3040
3265
|
* - Download report with specific headers
|
|
3041
3266
|
*/
|
|
3042
3267
|
custom_headers?: string;
|
|
3268
|
+
/**
|
|
3269
|
+
* - UTC end date in ISO format
|
|
3270
|
+
*/
|
|
3271
|
+
end_date?: string;
|
|
3043
3272
|
/**
|
|
3044
3273
|
* - Download for specific enitites, entities
|
|
3045
3274
|
* can be bag, shipment or order_id, etc.
|
|
3046
3275
|
*/
|
|
3047
3276
|
entities?: string[];
|
|
3048
3277
|
filter_type?: string;
|
|
3049
|
-
from_date?: string;
|
|
3050
3278
|
/**
|
|
3051
3279
|
* - Download lanes for cross company.
|
|
3052
3280
|
*/
|
|
@@ -3056,11 +3284,14 @@ type BulkReportsDownloadRequest = {
|
|
|
3056
3284
|
* - Type of report
|
|
3057
3285
|
*/
|
|
3058
3286
|
report_type?: string;
|
|
3287
|
+
/**
|
|
3288
|
+
* - UTC start date in ISO format
|
|
3289
|
+
*/
|
|
3290
|
+
start_date?: string;
|
|
3059
3291
|
/**
|
|
3060
3292
|
* - Download for specific store ids.
|
|
3061
3293
|
*/
|
|
3062
3294
|
store_ids?: string[];
|
|
3063
|
-
to_date?: string;
|
|
3064
3295
|
};
|
|
3065
3296
|
/** @returns {BulkReportsDownloadResponse} */
|
|
3066
3297
|
declare function BulkReportsDownloadResponse(): BulkReportsDownloadResponse;
|
|
@@ -3068,6 +3299,19 @@ type BulkReportsDownloadResponse = {
|
|
|
3068
3299
|
batch_id?: string;
|
|
3069
3300
|
success?: boolean;
|
|
3070
3301
|
};
|
|
3302
|
+
/** @returns {BulkStateTransistionRequest} */
|
|
3303
|
+
declare function BulkStateTransistionRequest(): BulkStateTransistionRequest;
|
|
3304
|
+
type BulkStateTransistionRequest = {
|
|
3305
|
+
file_name?: string;
|
|
3306
|
+
url?: string;
|
|
3307
|
+
};
|
|
3308
|
+
/** @returns {BulkStateTransistionResponse} */
|
|
3309
|
+
declare function BulkStateTransistionResponse(): BulkStateTransistionResponse;
|
|
3310
|
+
type BulkStateTransistionResponse = {
|
|
3311
|
+
batch_id?: string;
|
|
3312
|
+
message?: string;
|
|
3313
|
+
status?: boolean;
|
|
3314
|
+
};
|
|
3071
3315
|
/** @returns {BuyerDetails} */
|
|
3072
3316
|
declare function BuyerDetails(): BuyerDetails;
|
|
3073
3317
|
type BuyerDetails = {
|
|
@@ -3160,6 +3404,12 @@ type ContactDetails = {
|
|
|
3160
3404
|
emails?: string[];
|
|
3161
3405
|
phone?: PhoneDetails[];
|
|
3162
3406
|
};
|
|
3407
|
+
/** @returns {ConversionRate} */
|
|
3408
|
+
declare function ConversionRate(): ConversionRate;
|
|
3409
|
+
type ConversionRate = {
|
|
3410
|
+
base?: string;
|
|
3411
|
+
rates?: any;
|
|
3412
|
+
};
|
|
3163
3413
|
/** @returns {CourierPartnerTrackingDetails} */
|
|
3164
3414
|
declare function CourierPartnerTrackingDetails(): CourierPartnerTrackingDetails;
|
|
3165
3415
|
type CourierPartnerTrackingDetails = {
|
|
@@ -3306,12 +3556,25 @@ type CreditBalanceInfo = {
|
|
|
3306
3556
|
reason?: string;
|
|
3307
3557
|
total_credited_balance?: string;
|
|
3308
3558
|
};
|
|
3559
|
+
/** @returns {Currency} */
|
|
3560
|
+
declare function Currency(): Currency;
|
|
3561
|
+
type Currency = {
|
|
3562
|
+
currency_code?: string;
|
|
3563
|
+
currency_symbol?: string;
|
|
3564
|
+
};
|
|
3565
|
+
/** @returns {CurrencyInfo} */
|
|
3566
|
+
declare function CurrencyInfo(): CurrencyInfo;
|
|
3567
|
+
type CurrencyInfo = {
|
|
3568
|
+
conversion_rate?: ConversionRate;
|
|
3569
|
+
ordering_currency?: OrderingCurrency;
|
|
3570
|
+
};
|
|
3309
3571
|
/** @returns {CurrentStatus} */
|
|
3310
3572
|
declare function CurrentStatus(): CurrentStatus;
|
|
3311
3573
|
type CurrentStatus = {
|
|
3312
3574
|
bag_id?: number;
|
|
3313
3575
|
bag_state_mapper?: BagStateMapper;
|
|
3314
3576
|
created_at?: string;
|
|
3577
|
+
created_ts?: string;
|
|
3315
3578
|
delivery_awb_number?: string;
|
|
3316
3579
|
delivery_partner_id?: number;
|
|
3317
3580
|
id: number;
|
|
@@ -3330,6 +3593,12 @@ type DataUpdates = {
|
|
|
3330
3593
|
order_item_status?: OrderItemDataUpdates[];
|
|
3331
3594
|
products?: ProductsDataUpdates[];
|
|
3332
3595
|
};
|
|
3596
|
+
/** @returns {DateRange} */
|
|
3597
|
+
declare function DateRange(): DateRange;
|
|
3598
|
+
type DateRange = {
|
|
3599
|
+
from_date?: string;
|
|
3600
|
+
to_date?: string;
|
|
3601
|
+
};
|
|
3333
3602
|
/** @returns {Dates} */
|
|
3334
3603
|
declare function Dates(): Dates;
|
|
3335
3604
|
type Dates = {
|
|
@@ -3396,12 +3665,59 @@ type DPDetailsData = {
|
|
|
3396
3665
|
pincode?: string;
|
|
3397
3666
|
track_url?: string;
|
|
3398
3667
|
};
|
|
3668
|
+
/** @returns {EInvoiceDetails} */
|
|
3669
|
+
declare function EInvoiceDetails(): EInvoiceDetails;
|
|
3670
|
+
type EInvoiceDetails = {
|
|
3671
|
+
error_details?: EInvoiceErrorDetails[];
|
|
3672
|
+
irn_details?: EInvoiceIrnDetails;
|
|
3673
|
+
};
|
|
3674
|
+
/** @returns {EInvoiceErrorDetails} */
|
|
3675
|
+
declare function EInvoiceErrorDetails(): EInvoiceErrorDetails;
|
|
3676
|
+
type EInvoiceErrorDetails = {
|
|
3677
|
+
error_code?: string;
|
|
3678
|
+
error_message: string;
|
|
3679
|
+
};
|
|
3680
|
+
/** @returns {EInvoiceErrorInfo} */
|
|
3681
|
+
declare function EInvoiceErrorInfo(): EInvoiceErrorInfo;
|
|
3682
|
+
type EInvoiceErrorInfo = {
|
|
3683
|
+
error_details?: EInvoiceErrorDetails[];
|
|
3684
|
+
};
|
|
3685
|
+
/** @returns {EInvoiceErrorResponse} */
|
|
3686
|
+
declare function EInvoiceErrorResponse(): EInvoiceErrorResponse;
|
|
3687
|
+
type EInvoiceErrorResponse = {
|
|
3688
|
+
message?: string;
|
|
3689
|
+
response_data?: EInvoiceErrorResponseData[];
|
|
3690
|
+
};
|
|
3691
|
+
/** @returns {EInvoiceErrorResponseData} */
|
|
3692
|
+
declare function EInvoiceErrorResponseData(): EInvoiceErrorResponseData;
|
|
3693
|
+
type EInvoiceErrorResponseData = {
|
|
3694
|
+
einvoice_info?: EInvoiceErrorInfo;
|
|
3695
|
+
einvoice_type: string;
|
|
3696
|
+
message: string;
|
|
3697
|
+
shipment_id: string;
|
|
3698
|
+
status: number;
|
|
3699
|
+
};
|
|
3700
|
+
/** @returns {EInvoiceErrorResponseDetails} */
|
|
3701
|
+
declare function EInvoiceErrorResponseDetails(): EInvoiceErrorResponseDetails;
|
|
3702
|
+
type EInvoiceErrorResponseDetails = {
|
|
3703
|
+
message?: string;
|
|
3704
|
+
response_data: EInvoiceErrorResponseData[];
|
|
3705
|
+
};
|
|
3399
3706
|
/** @returns {EinvoiceInfo} */
|
|
3400
3707
|
declare function EinvoiceInfo(): EinvoiceInfo;
|
|
3401
3708
|
type EinvoiceInfo = {
|
|
3402
3709
|
credit_note?: any;
|
|
3403
3710
|
invoice?: any;
|
|
3404
3711
|
};
|
|
3712
|
+
/** @returns {EInvoiceIrnDetails} */
|
|
3713
|
+
declare function EInvoiceIrnDetails(): EInvoiceIrnDetails;
|
|
3714
|
+
type EInvoiceIrnDetails = {
|
|
3715
|
+
ack_dt: string;
|
|
3716
|
+
ack_no: string;
|
|
3717
|
+
irn: string;
|
|
3718
|
+
signed_invoice: string;
|
|
3719
|
+
signed_qr_code: string;
|
|
3720
|
+
};
|
|
3405
3721
|
/** @returns {EInvoicePortalDetails} */
|
|
3406
3722
|
declare function EInvoicePortalDetails(): EInvoicePortalDetails;
|
|
3407
3723
|
type EInvoicePortalDetails = {
|
|
@@ -3412,14 +3728,11 @@ type EInvoicePortalDetails = {
|
|
|
3412
3728
|
/** @returns {EInvoiceResponseData} */
|
|
3413
3729
|
declare function EInvoiceResponseData(): EInvoiceResponseData;
|
|
3414
3730
|
type EInvoiceResponseData = {
|
|
3415
|
-
|
|
3416
|
-
|
|
3417
|
-
irn?: string;
|
|
3731
|
+
einvoice_info?: EInvoiceDetails;
|
|
3732
|
+
einvoice_type: string;
|
|
3418
3733
|
message: string;
|
|
3419
3734
|
shipment_id: string;
|
|
3420
|
-
|
|
3421
|
-
timeout?: number;
|
|
3422
|
-
timeout_unit?: string;
|
|
3735
|
+
status: number;
|
|
3423
3736
|
};
|
|
3424
3737
|
/** @returns {EInvoiceRetry} */
|
|
3425
3738
|
declare function EInvoiceRetry(): EInvoiceRetry;
|
|
@@ -3429,14 +3742,12 @@ type EInvoiceRetry = {
|
|
|
3429
3742
|
/** @returns {EInvoiceRetryResponse} */
|
|
3430
3743
|
declare function EInvoiceRetryResponse(): EInvoiceRetryResponse;
|
|
3431
3744
|
type EInvoiceRetryResponse = {
|
|
3432
|
-
message?: string;
|
|
3433
3745
|
response_data: EInvoiceResponseData[];
|
|
3434
|
-
success?: boolean;
|
|
3435
|
-
success_count: number;
|
|
3436
3746
|
};
|
|
3437
3747
|
/** @returns {EInvoiceRetryShipmentData} */
|
|
3438
3748
|
declare function EInvoiceRetryShipmentData(): EInvoiceRetryShipmentData;
|
|
3439
3749
|
type EInvoiceRetryShipmentData = {
|
|
3750
|
+
einvoice_type: string;
|
|
3440
3751
|
shipment_id: string;
|
|
3441
3752
|
};
|
|
3442
3753
|
/** @returns {Entities} */
|
|
@@ -3505,12 +3816,37 @@ type ErrorDetail = {
|
|
|
3505
3816
|
/** @returns {ErrorResponse} */
|
|
3506
3817
|
declare function ErrorResponse(): ErrorResponse;
|
|
3507
3818
|
type ErrorResponse = {
|
|
3508
|
-
error
|
|
3819
|
+
error?: string;
|
|
3509
3820
|
error_trace?: string;
|
|
3510
3821
|
message: string;
|
|
3511
3822
|
status?: number;
|
|
3512
3823
|
success?: boolean;
|
|
3513
3824
|
};
|
|
3825
|
+
/** @returns {FailedOrderLogDetails} */
|
|
3826
|
+
declare function FailedOrderLogDetails(): FailedOrderLogDetails;
|
|
3827
|
+
type FailedOrderLogDetails = {
|
|
3828
|
+
error_trace: string;
|
|
3829
|
+
exception: string;
|
|
3830
|
+
};
|
|
3831
|
+
/** @returns {FailedOrderLogs} */
|
|
3832
|
+
declare function FailedOrderLogs(): FailedOrderLogs;
|
|
3833
|
+
type FailedOrderLogs = {
|
|
3834
|
+
items: FailedOrdersItem;
|
|
3835
|
+
page: PageDetails;
|
|
3836
|
+
};
|
|
3837
|
+
/** @returns {FailedOrdersItem} */
|
|
3838
|
+
declare function FailedOrdersItem(): FailedOrdersItem;
|
|
3839
|
+
type FailedOrdersItem = {
|
|
3840
|
+
channel: LogsChannelDetails;
|
|
3841
|
+
created_at: string;
|
|
3842
|
+
display_message: string;
|
|
3843
|
+
error_message: string;
|
|
3844
|
+
log_id: number;
|
|
3845
|
+
meta: any;
|
|
3846
|
+
method_name: string;
|
|
3847
|
+
order_id: string;
|
|
3848
|
+
payment: LogPaymentDetails;
|
|
3849
|
+
};
|
|
3514
3850
|
/** @returns {FetchCreditBalanceRequestPayload} */
|
|
3515
3851
|
declare function FetchCreditBalanceRequestPayload(): FetchCreditBalanceRequestPayload;
|
|
3516
3852
|
type FetchCreditBalanceRequestPayload = {
|
|
@@ -3543,6 +3879,20 @@ type FilterInfoOption = {
|
|
|
3543
3879
|
text?: string;
|
|
3544
3880
|
value?: string;
|
|
3545
3881
|
};
|
|
3882
|
+
/** @returns {Filters} */
|
|
3883
|
+
declare function Filters(): Filters;
|
|
3884
|
+
type Filters = {
|
|
3885
|
+
date_range?: DateRange;
|
|
3886
|
+
dp_ids?: number;
|
|
3887
|
+
dp_name?: string;
|
|
3888
|
+
from_date?: string;
|
|
3889
|
+
lane?: string;
|
|
3890
|
+
logo?: string;
|
|
3891
|
+
selected_shipments?: string;
|
|
3892
|
+
store_name?: string;
|
|
3893
|
+
stores?: number;
|
|
3894
|
+
to_date?: string;
|
|
3895
|
+
};
|
|
3546
3896
|
/** @returns {FiltersInfo} */
|
|
3547
3897
|
declare function FiltersInfo(): FiltersInfo;
|
|
3548
3898
|
type FiltersInfo = {
|
|
@@ -3553,6 +3903,17 @@ type FiltersInfo = {
|
|
|
3553
3903
|
type: string;
|
|
3554
3904
|
value: string;
|
|
3555
3905
|
};
|
|
3906
|
+
/** @returns {FiltersRequest} */
|
|
3907
|
+
declare function FiltersRequest(): FiltersRequest;
|
|
3908
|
+
type FiltersRequest = {
|
|
3909
|
+
date_range?: DateRange;
|
|
3910
|
+
dp_ids: number;
|
|
3911
|
+
dp_name: string;
|
|
3912
|
+
lane: string;
|
|
3913
|
+
logo?: string;
|
|
3914
|
+
store_name: string;
|
|
3915
|
+
stores: number;
|
|
3916
|
+
};
|
|
3556
3917
|
/** @returns {FiltersResponse} */
|
|
3557
3918
|
declare function FiltersResponse(): FiltersResponse;
|
|
3558
3919
|
type FiltersResponse = {
|
|
@@ -3617,45 +3978,17 @@ declare function FyndOrderIdList(): FyndOrderIdList;
|
|
|
3617
3978
|
type FyndOrderIdList = {
|
|
3618
3979
|
fynd_order_id?: string[];
|
|
3619
3980
|
};
|
|
3620
|
-
/** @returns {GenerateInvoiceIDErrorResponse} */
|
|
3621
|
-
declare function GenerateInvoiceIDErrorResponse(): GenerateInvoiceIDErrorResponse;
|
|
3622
|
-
type GenerateInvoiceIDErrorResponse = {
|
|
3623
|
-
items?: GenerateInvoiceIDErrorResponseData[];
|
|
3624
|
-
};
|
|
3625
|
-
/** @returns {GenerateInvoiceIDErrorResponseData} */
|
|
3626
|
-
declare function GenerateInvoiceIDErrorResponseData(): GenerateInvoiceIDErrorResponseData;
|
|
3627
|
-
type GenerateInvoiceIDErrorResponseData = {
|
|
3628
|
-
error_message?: string;
|
|
3629
|
-
invoice_id?: boolean;
|
|
3630
|
-
shipment_id?: string;
|
|
3631
|
-
success?: boolean;
|
|
3632
|
-
};
|
|
3633
|
-
/** @returns {GenerateInvoiceIDRequest} */
|
|
3634
|
-
declare function GenerateInvoiceIDRequest(): GenerateInvoiceIDRequest;
|
|
3635
|
-
type GenerateInvoiceIDRequest = {
|
|
3636
|
-
shipment_ids: string[];
|
|
3637
|
-
};
|
|
3638
|
-
/** @returns {GenerateInvoiceIDResponse} */
|
|
3639
|
-
declare function GenerateInvoiceIDResponse(): GenerateInvoiceIDResponse;
|
|
3640
|
-
type GenerateInvoiceIDResponse = {
|
|
3641
|
-
items?: GenerateInvoiceIDResponseData[];
|
|
3642
|
-
};
|
|
3643
|
-
/** @returns {GenerateInvoiceIDResponseData} */
|
|
3644
|
-
declare function GenerateInvoiceIDResponseData(): GenerateInvoiceIDResponseData;
|
|
3645
|
-
type GenerateInvoiceIDResponseData = {
|
|
3646
|
-
error_message?: boolean;
|
|
3647
|
-
invoice_id?: string;
|
|
3648
|
-
shipment_id?: string;
|
|
3649
|
-
success?: boolean;
|
|
3650
|
-
};
|
|
3651
3981
|
/** @returns {GeneratePosOrderReceiptResponse} */
|
|
3652
3982
|
declare function GeneratePosOrderReceiptResponse(): GeneratePosOrderReceiptResponse;
|
|
3653
3983
|
type GeneratePosOrderReceiptResponse = {
|
|
3654
3984
|
customer_cn_receipt?: string;
|
|
3985
|
+
customer_cn_receipt_template?: string;
|
|
3655
3986
|
invoice_receipt?: string;
|
|
3987
|
+
invoice_receipt_template?: string;
|
|
3656
3988
|
merchant_cn_receipt?: string;
|
|
3657
3989
|
order_id?: string;
|
|
3658
3990
|
payment_receipt?: string;
|
|
3991
|
+
payment_receipt_template?: string;
|
|
3659
3992
|
success?: boolean;
|
|
3660
3993
|
};
|
|
3661
3994
|
/** @returns {GetActionsResponse} */
|
|
@@ -3669,14 +4002,6 @@ type GetBagsPlatformResponse = {
|
|
|
3669
4002
|
items: BagDetailsPlatformResponse[];
|
|
3670
4003
|
page: BagsPage;
|
|
3671
4004
|
};
|
|
3672
|
-
/** @returns {GiftCard} */
|
|
3673
|
-
declare function GiftCard(): GiftCard;
|
|
3674
|
-
type GiftCard = {
|
|
3675
|
-
display_text?: string;
|
|
3676
|
-
gift_message?: string;
|
|
3677
|
-
gift_price?: number;
|
|
3678
|
-
is_gift_applied?: boolean;
|
|
3679
|
-
};
|
|
3680
4005
|
/** @returns {GSTDetailsData} */
|
|
3681
4006
|
declare function GSTDetailsData(): GSTDetailsData;
|
|
3682
4007
|
type GSTDetailsData = {
|
|
@@ -3875,6 +4200,37 @@ declare function ItemCriterias(): ItemCriterias;
|
|
|
3875
4200
|
type ItemCriterias = {
|
|
3876
4201
|
item_brand?: number[];
|
|
3877
4202
|
};
|
|
4203
|
+
/** @returns {JobDetailsData} */
|
|
4204
|
+
declare function JobDetailsData(): JobDetailsData;
|
|
4205
|
+
type JobDetailsData = {
|
|
4206
|
+
batch_id?: string;
|
|
4207
|
+
company_id?: string;
|
|
4208
|
+
failed_shipments_count?: number;
|
|
4209
|
+
processing_shipments_count?: number;
|
|
4210
|
+
successful_shipment_ids?: string[];
|
|
4211
|
+
successful_shipments_count?: number;
|
|
4212
|
+
total_shipments_count?: number;
|
|
4213
|
+
};
|
|
4214
|
+
/** @returns {JobDetailsResponse} */
|
|
4215
|
+
declare function JobDetailsResponse(): JobDetailsResponse;
|
|
4216
|
+
type JobDetailsResponse = {
|
|
4217
|
+
created_ts?: string;
|
|
4218
|
+
data?: JobDetailsData[];
|
|
4219
|
+
failed_records?: any[];
|
|
4220
|
+
file_url?: string;
|
|
4221
|
+
message?: string;
|
|
4222
|
+
status?: string;
|
|
4223
|
+
success?: boolean;
|
|
4224
|
+
uploaded_by?: string;
|
|
4225
|
+
uploaded_on?: string;
|
|
4226
|
+
user_id?: string;
|
|
4227
|
+
};
|
|
4228
|
+
/** @returns {JobFailedResponse} */
|
|
4229
|
+
declare function JobFailedResponse(): JobFailedResponse;
|
|
4230
|
+
type JobFailedResponse = {
|
|
4231
|
+
file_name?: string;
|
|
4232
|
+
url?: string;
|
|
4233
|
+
};
|
|
3878
4234
|
/** @returns {LaneConfigResponse} */
|
|
3879
4235
|
declare function LaneConfigResponse(): LaneConfigResponse;
|
|
3880
4236
|
type LaneConfigResponse = {
|
|
@@ -3904,6 +4260,111 @@ type LockData = {
|
|
|
3904
4260
|
locked?: boolean;
|
|
3905
4261
|
mto?: boolean;
|
|
3906
4262
|
};
|
|
4263
|
+
/** @returns {LogPaymentDetails} */
|
|
4264
|
+
declare function LogPaymentDetails(): LogPaymentDetails;
|
|
4265
|
+
type LogPaymentDetails = {
|
|
4266
|
+
amount_paid?: string;
|
|
4267
|
+
payment_mode?: string;
|
|
4268
|
+
};
|
|
4269
|
+
/** @returns {LogsChannelDetails} */
|
|
4270
|
+
declare function LogsChannelDetails(): LogsChannelDetails;
|
|
4271
|
+
type LogsChannelDetails = {
|
|
4272
|
+
channel_id?: string;
|
|
4273
|
+
channel_shipment_id?: string;
|
|
4274
|
+
logo?: string;
|
|
4275
|
+
name?: string;
|
|
4276
|
+
};
|
|
4277
|
+
/** @returns {Manifest} */
|
|
4278
|
+
declare function Manifest(): Manifest;
|
|
4279
|
+
type Manifest = {
|
|
4280
|
+
company_id: number;
|
|
4281
|
+
created_at: string;
|
|
4282
|
+
created_by: string;
|
|
4283
|
+
created_ts?: string;
|
|
4284
|
+
filters?: Filters;
|
|
4285
|
+
id: number;
|
|
4286
|
+
is_active: boolean;
|
|
4287
|
+
manifest_id: string;
|
|
4288
|
+
meta?: ManifestMeta;
|
|
4289
|
+
pdf_meta?: PDFMeta;
|
|
4290
|
+
status: string;
|
|
4291
|
+
uid: string;
|
|
4292
|
+
user_id: string;
|
|
4293
|
+
};
|
|
4294
|
+
/** @returns {ManifestDetails} */
|
|
4295
|
+
declare function ManifestDetails(): ManifestDetails;
|
|
4296
|
+
type ManifestDetails = {
|
|
4297
|
+
additional_shipment_count?: number;
|
|
4298
|
+
items?: ManifestItemDetails[];
|
|
4299
|
+
manifest_details?: Manifest[];
|
|
4300
|
+
page?: ManifestPageInfo;
|
|
4301
|
+
};
|
|
4302
|
+
/** @returns {ManifestFile} */
|
|
4303
|
+
declare function ManifestFile(): ManifestFile;
|
|
4304
|
+
type ManifestFile = {
|
|
4305
|
+
bucket?: string;
|
|
4306
|
+
key?: string;
|
|
4307
|
+
region?: string;
|
|
4308
|
+
};
|
|
4309
|
+
/** @returns {ManifestFiltersResponse} */
|
|
4310
|
+
declare function ManifestFiltersResponse(): ManifestFiltersResponse;
|
|
4311
|
+
type ManifestFiltersResponse = {
|
|
4312
|
+
advance_filter?: FiltersInfo[];
|
|
4313
|
+
global_filter?: FiltersInfo[];
|
|
4314
|
+
};
|
|
4315
|
+
/** @returns {ManifestItemDetails} */
|
|
4316
|
+
declare function ManifestItemDetails(): ManifestItemDetails;
|
|
4317
|
+
type ManifestItemDetails = {
|
|
4318
|
+
awb_number?: string;
|
|
4319
|
+
invoice_id?: string;
|
|
4320
|
+
order_id: string;
|
|
4321
|
+
quantity?: number;
|
|
4322
|
+
shipment_created_at?: string;
|
|
4323
|
+
shipment_id: string;
|
|
4324
|
+
};
|
|
4325
|
+
/** @returns {ManifestList} */
|
|
4326
|
+
declare function ManifestList(): ManifestList;
|
|
4327
|
+
type ManifestList = {
|
|
4328
|
+
items?: Manifest[];
|
|
4329
|
+
page?: ManifestPageInfo;
|
|
4330
|
+
};
|
|
4331
|
+
/** @returns {ManifestMediaUpdate} */
|
|
4332
|
+
declare function ManifestMediaUpdate(): ManifestMediaUpdate;
|
|
4333
|
+
type ManifestMediaUpdate = {
|
|
4334
|
+
code?: number;
|
|
4335
|
+
entity?: string;
|
|
4336
|
+
file?: ManifestFile;
|
|
4337
|
+
link?: string;
|
|
4338
|
+
media_type?: string;
|
|
4339
|
+
status?: boolean;
|
|
4340
|
+
};
|
|
4341
|
+
/** @returns {ManifestMeta} */
|
|
4342
|
+
declare function ManifestMeta(): ManifestMeta;
|
|
4343
|
+
type ManifestMeta = {
|
|
4344
|
+
filters?: Filters;
|
|
4345
|
+
total_shipment_prices_count?: TotalShipmentPricesCount;
|
|
4346
|
+
};
|
|
4347
|
+
/** @returns {ManifestPageInfo} */
|
|
4348
|
+
declare function ManifestPageInfo(): ManifestPageInfo;
|
|
4349
|
+
type ManifestPageInfo = {
|
|
4350
|
+
current: number;
|
|
4351
|
+
has_next: boolean;
|
|
4352
|
+
has_previous: boolean;
|
|
4353
|
+
size: number;
|
|
4354
|
+
total: number;
|
|
4355
|
+
type: string;
|
|
4356
|
+
};
|
|
4357
|
+
/** @returns {ManifestShipmentListing} */
|
|
4358
|
+
declare function ManifestShipmentListing(): ManifestShipmentListing;
|
|
4359
|
+
type ManifestShipmentListing = {
|
|
4360
|
+
items?: ManifestItemDetails[];
|
|
4361
|
+
lane?: string;
|
|
4362
|
+
message?: string;
|
|
4363
|
+
page: ManifestPageInfo;
|
|
4364
|
+
status: number;
|
|
4365
|
+
success: boolean;
|
|
4366
|
+
total_count: number;
|
|
4367
|
+
};
|
|
3907
4368
|
/** @returns {MarketPlacePdf} */
|
|
3908
4369
|
declare function MarketPlacePdf(): MarketPlacePdf;
|
|
3909
4370
|
type MarketPlacePdf = {
|
|
@@ -3920,7 +4381,7 @@ type Meta = {
|
|
|
3920
4381
|
declare function OrderBagArticle(): OrderBagArticle;
|
|
3921
4382
|
type OrderBagArticle = {
|
|
3922
4383
|
identifiers?: any;
|
|
3923
|
-
return_config?:
|
|
4384
|
+
return_config?: ReturnConfig;
|
|
3924
4385
|
size?: string;
|
|
3925
4386
|
uid?: string;
|
|
3926
4387
|
};
|
|
@@ -3977,6 +4438,7 @@ type OrderConfig = {
|
|
|
3977
4438
|
/** @returns {OrderData} */
|
|
3978
4439
|
declare function OrderData(): OrderData;
|
|
3979
4440
|
type OrderData = {
|
|
4441
|
+
created_ts?: string;
|
|
3980
4442
|
fynd_order_id: string;
|
|
3981
4443
|
meta?: any;
|
|
3982
4444
|
order_date: string;
|
|
@@ -3995,6 +4457,7 @@ declare function OrderDetailsData(): OrderDetailsData;
|
|
|
3995
4457
|
type OrderDetailsData = {
|
|
3996
4458
|
affiliate_id?: string;
|
|
3997
4459
|
cod_charges?: string;
|
|
4460
|
+
created_ts?: string;
|
|
3998
4461
|
fynd_order_id: string;
|
|
3999
4462
|
meta?: any;
|
|
4000
4463
|
order_date?: string;
|
|
@@ -4030,6 +4493,14 @@ type OrderInfo = {
|
|
|
4030
4493
|
shipping_address: OrderUser;
|
|
4031
4494
|
user: UserData;
|
|
4032
4495
|
};
|
|
4496
|
+
/** @returns {OrderingCurrency} */
|
|
4497
|
+
declare function OrderingCurrency(): OrderingCurrency;
|
|
4498
|
+
type OrderingCurrency = {
|
|
4499
|
+
currency_code?: string;
|
|
4500
|
+
currency_name?: string;
|
|
4501
|
+
currency_sub_unit?: string;
|
|
4502
|
+
currency_symbol?: string;
|
|
4503
|
+
};
|
|
4033
4504
|
/** @returns {OrderingStoreDetails} */
|
|
4034
4505
|
declare function OrderingStoreDetails(): OrderingStoreDetails;
|
|
4035
4506
|
type OrderingStoreDetails = {
|
|
@@ -4060,30 +4531,6 @@ type OrderListingResponse = {
|
|
|
4060
4531
|
success?: boolean;
|
|
4061
4532
|
total_count?: number;
|
|
4062
4533
|
};
|
|
4063
|
-
/** @returns {OrderMeta} */
|
|
4064
|
-
declare function OrderMeta(): OrderMeta;
|
|
4065
|
-
type OrderMeta = {
|
|
4066
|
-
billing_staff_details?: BillingStaffDetails;
|
|
4067
|
-
cart_id?: number;
|
|
4068
|
-
cart_object_id?: string;
|
|
4069
|
-
comment?: string;
|
|
4070
|
-
company_logo?: string;
|
|
4071
|
-
currency_symbol?: string;
|
|
4072
|
-
customer_note?: string;
|
|
4073
|
-
employee_id?: string;
|
|
4074
|
-
extra_meta?: any;
|
|
4075
|
-
files?: any[];
|
|
4076
|
-
mongo_cart_id?: number;
|
|
4077
|
-
order_child_entities?: string[];
|
|
4078
|
-
order_platform?: string;
|
|
4079
|
-
order_tags?: any[];
|
|
4080
|
-
order_type?: string;
|
|
4081
|
-
ordering_store?: number;
|
|
4082
|
-
payment_type?: string;
|
|
4083
|
-
platform_user_details?: PlatformUserDetails;
|
|
4084
|
-
staff?: any;
|
|
4085
|
-
transaction_data?: TransactionData;
|
|
4086
|
-
};
|
|
4087
4534
|
/** @returns {OrderPriority} */
|
|
4088
4535
|
declare function OrderPriority(): OrderPriority;
|
|
4089
4536
|
type OrderPriority = {
|
|
@@ -4161,6 +4608,10 @@ type PageDetails = {
|
|
|
4161
4608
|
* - If next page contains any result
|
|
4162
4609
|
*/
|
|
4163
4610
|
has_next?: boolean;
|
|
4611
|
+
/**
|
|
4612
|
+
* - If previous page contains any result
|
|
4613
|
+
*/
|
|
4614
|
+
has_previous?: boolean;
|
|
4164
4615
|
/**
|
|
4165
4616
|
* - Total count of the results present in the
|
|
4166
4617
|
* requested filter
|
|
@@ -4175,6 +4626,23 @@ type PageDetails = {
|
|
|
4175
4626
|
*/
|
|
4176
4627
|
type?: string;
|
|
4177
4628
|
};
|
|
4629
|
+
/** @returns {PaginatedStates} */
|
|
4630
|
+
declare function PaginatedStates(): PaginatedStates;
|
|
4631
|
+
type PaginatedStates = {
|
|
4632
|
+
items?: StateManagerState[];
|
|
4633
|
+
page?: PaginationInfo;
|
|
4634
|
+
};
|
|
4635
|
+
/** @returns {PaginationInfo} */
|
|
4636
|
+
declare function PaginationInfo(): PaginationInfo;
|
|
4637
|
+
type PaginationInfo = {
|
|
4638
|
+
current?: number;
|
|
4639
|
+
has_next?: boolean;
|
|
4640
|
+
has_previous?: boolean;
|
|
4641
|
+
item_total?: number;
|
|
4642
|
+
size?: number;
|
|
4643
|
+
total?: number;
|
|
4644
|
+
type?: string;
|
|
4645
|
+
};
|
|
4178
4646
|
/** @returns {PaymentInfo} */
|
|
4179
4647
|
declare function PaymentInfo(): PaymentInfo;
|
|
4180
4648
|
type PaymentInfo = {
|
|
@@ -4219,6 +4687,12 @@ type PDFLinks = {
|
|
|
4219
4687
|
label_type: string;
|
|
4220
4688
|
po_invoice?: string;
|
|
4221
4689
|
};
|
|
4690
|
+
/** @returns {PDFMeta} */
|
|
4691
|
+
declare function PDFMeta(): PDFMeta;
|
|
4692
|
+
type PDFMeta = {
|
|
4693
|
+
consent?: string;
|
|
4694
|
+
media_updates?: ManifestMediaUpdate[];
|
|
4695
|
+
};
|
|
4222
4696
|
/** @returns {PhoneDetails} */
|
|
4223
4697
|
declare function PhoneDetails(): PhoneDetails;
|
|
4224
4698
|
type PhoneDetails = {
|
|
@@ -4295,8 +4769,11 @@ declare function PlatformOrderItems(): PlatformOrderItems;
|
|
|
4295
4769
|
type PlatformOrderItems = {
|
|
4296
4770
|
breakup_values?: PlatformBreakupValues[];
|
|
4297
4771
|
channel?: PlatformChannel;
|
|
4772
|
+
currency?: Currency;
|
|
4773
|
+
currency_info?: CurrencyInfo;
|
|
4298
4774
|
meta?: any;
|
|
4299
4775
|
order_created_time?: string;
|
|
4776
|
+
order_created_ts?: string;
|
|
4300
4777
|
order_id?: string;
|
|
4301
4778
|
order_value?: number;
|
|
4302
4779
|
payment_mode?: string;
|
|
@@ -4320,6 +4797,8 @@ type PlatformShipment = {
|
|
|
4320
4797
|
company_details?: CompanyDetails;
|
|
4321
4798
|
coupon?: any;
|
|
4322
4799
|
credit_note_id?: string;
|
|
4800
|
+
currency?: Currency;
|
|
4801
|
+
currency_info?: CurrencyInfo;
|
|
4323
4802
|
custom_message?: string;
|
|
4324
4803
|
custom_meta?: any[];
|
|
4325
4804
|
delivery_details?: UserDetailsData;
|
|
@@ -4328,6 +4807,7 @@ type PlatformShipment = {
|
|
|
4328
4807
|
dp_details?: DPDetailsData;
|
|
4329
4808
|
enable_dp_tracking?: boolean;
|
|
4330
4809
|
estimated_sla_time?: string;
|
|
4810
|
+
estimated_sla_ts?: string;
|
|
4331
4811
|
forward_shipment_id?: string;
|
|
4332
4812
|
fulfilling_store?: FulfillingStore;
|
|
4333
4813
|
fulfilment_priority?: number;
|
|
@@ -4355,7 +4835,8 @@ type PlatformShipment = {
|
|
|
4355
4835
|
priority_text?: string;
|
|
4356
4836
|
rto_address?: PlatformDeliveryAddress;
|
|
4357
4837
|
shipment_created_at?: string;
|
|
4358
|
-
|
|
4838
|
+
shipment_created_ts?: string;
|
|
4839
|
+
shipment_details?: ShipmentLockDetails;
|
|
4359
4840
|
shipment_id: string;
|
|
4360
4841
|
shipment_images?: string[];
|
|
4361
4842
|
shipment_quantity?: number;
|
|
@@ -4395,14 +4876,6 @@ type PlatformTrack = {
|
|
|
4395
4876
|
updated_at?: string;
|
|
4396
4877
|
updated_time?: string;
|
|
4397
4878
|
};
|
|
4398
|
-
/** @returns {PlatformUserDetails} */
|
|
4399
|
-
declare function PlatformUserDetails(): PlatformUserDetails;
|
|
4400
|
-
type PlatformUserDetails = {
|
|
4401
|
-
platform_user_employee_code?: string;
|
|
4402
|
-
platform_user_first_name?: string;
|
|
4403
|
-
platform_user_id?: string;
|
|
4404
|
-
platform_user_last_name?: string;
|
|
4405
|
-
};
|
|
4406
4879
|
/** @returns {PointBlankOtpData} */
|
|
4407
4880
|
declare function PointBlankOtpData(): PointBlankOtpData;
|
|
4408
4881
|
type PointBlankOtpData = {
|
|
@@ -4475,6 +4948,30 @@ type ProcessingDates = {
|
|
|
4475
4948
|
dp_pickup_slot?: any;
|
|
4476
4949
|
pack_by_date?: string;
|
|
4477
4950
|
};
|
|
4951
|
+
/** @returns {ProcessManifest} */
|
|
4952
|
+
declare function ProcessManifest(): ProcessManifest;
|
|
4953
|
+
type ProcessManifest = {
|
|
4954
|
+
action: string;
|
|
4955
|
+
filters: FiltersRequest;
|
|
4956
|
+
manifest_id?: string;
|
|
4957
|
+
unique_id: string;
|
|
4958
|
+
};
|
|
4959
|
+
/** @returns {ProcessManifestItemResponse} */
|
|
4960
|
+
declare function ProcessManifestItemResponse(): ProcessManifestItemResponse;
|
|
4961
|
+
type ProcessManifestItemResponse = {
|
|
4962
|
+
items?: ProcessManifestResponse;
|
|
4963
|
+
};
|
|
4964
|
+
/** @returns {ProcessManifestResponse} */
|
|
4965
|
+
declare function ProcessManifestResponse(): ProcessManifestResponse;
|
|
4966
|
+
type ProcessManifestResponse = {
|
|
4967
|
+
action?: string;
|
|
4968
|
+
company_id?: number;
|
|
4969
|
+
created_by?: string;
|
|
4970
|
+
filters?: Filters;
|
|
4971
|
+
manifest_id?: string;
|
|
4972
|
+
uid?: string;
|
|
4973
|
+
user_id?: string;
|
|
4974
|
+
};
|
|
4478
4975
|
/** @returns {Products} */
|
|
4479
4976
|
declare function Products(): Products;
|
|
4480
4977
|
type Products = {
|
|
@@ -4606,13 +5103,6 @@ type ReturnConfig = {
|
|
|
4606
5103
|
time?: number;
|
|
4607
5104
|
unit?: string;
|
|
4608
5105
|
};
|
|
4609
|
-
/** @returns {ReturnConfig1} */
|
|
4610
|
-
declare function ReturnConfig1(): ReturnConfig1;
|
|
4611
|
-
type ReturnConfig1 = {
|
|
4612
|
-
returnable?: boolean;
|
|
4613
|
-
time?: number;
|
|
4614
|
-
unit?: string;
|
|
4615
|
-
};
|
|
4616
5106
|
/** @returns {RoleBaseStateTransitionMapping} */
|
|
4617
5107
|
declare function RoleBaseStateTransitionMapping(): RoleBaseStateTransitionMapping;
|
|
4618
5108
|
type RoleBaseStateTransitionMapping = {
|
|
@@ -4659,6 +5149,19 @@ type Shipment = {
|
|
|
4659
5149
|
priority?: number;
|
|
4660
5150
|
processing_dates?: ProcessingDates;
|
|
4661
5151
|
};
|
|
5152
|
+
/** @returns {ShipmentActionInfo} */
|
|
5153
|
+
declare function ShipmentActionInfo(): ShipmentActionInfo;
|
|
5154
|
+
type ShipmentActionInfo = {
|
|
5155
|
+
failed_invoiced_shipments?: any;
|
|
5156
|
+
failed_shipments?: any[];
|
|
5157
|
+
invoice?: string[];
|
|
5158
|
+
invoiceable_shipments?: string[];
|
|
5159
|
+
label?: string[];
|
|
5160
|
+
processing_invoice_shipments?: string[];
|
|
5161
|
+
processing_shipments?: string[];
|
|
5162
|
+
successful_invoiced_shipments?: string[];
|
|
5163
|
+
successful_shipments?: string[];
|
|
5164
|
+
};
|
|
4662
5165
|
/** @returns {ShipmentBagReasons} */
|
|
4663
5166
|
declare function ShipmentBagReasons(): ShipmentBagReasons;
|
|
4664
5167
|
type ShipmentBagReasons = {
|
|
@@ -4695,14 +5198,11 @@ type ShipmentDetail = {
|
|
|
4695
5198
|
/** @returns {ShipmentDetails} */
|
|
4696
5199
|
declare function ShipmentDetails(): ShipmentDetails;
|
|
4697
5200
|
type ShipmentDetails = {
|
|
4698
|
-
action_to_status?: any;
|
|
4699
5201
|
affiliate_shipment_id: string;
|
|
4700
5202
|
articles: ArticleDetails[];
|
|
4701
5203
|
box_type?: string;
|
|
4702
5204
|
dp_id?: number;
|
|
4703
5205
|
fulfillment_id: number;
|
|
4704
|
-
lock_message?: string;
|
|
4705
|
-
lock_status?: boolean;
|
|
4706
5206
|
meta?: any;
|
|
4707
5207
|
shipments: number;
|
|
4708
5208
|
};
|
|
@@ -4735,15 +5235,19 @@ type ShipmentItem = {
|
|
|
4735
5235
|
bags?: BagUnit[];
|
|
4736
5236
|
can_process?: boolean;
|
|
4737
5237
|
channel?: ShipmentListingChannel;
|
|
5238
|
+
currency?: Currency;
|
|
5239
|
+
currency_info?: CurrencyInfo;
|
|
4738
5240
|
customer_note?: string;
|
|
4739
5241
|
delivery_address?: PlatformDeliveryAddress;
|
|
4740
5242
|
display_name?: string;
|
|
4741
5243
|
estimated_sla_time?: string;
|
|
5244
|
+
estimated_sla_ts?: string;
|
|
4742
5245
|
fulfilling_store?: ShipmentItemFulFillingStore;
|
|
4743
5246
|
invoice_id?: string;
|
|
4744
5247
|
lock_status?: boolean;
|
|
4745
5248
|
meta?: any;
|
|
4746
5249
|
mode_of_payment?: string;
|
|
5250
|
+
order_created_ts?: string;
|
|
4747
5251
|
order_date?: string;
|
|
4748
5252
|
order_id: string;
|
|
4749
5253
|
ordering_channnel?: string;
|
|
@@ -4752,9 +5256,11 @@ type ShipmentItem = {
|
|
|
4752
5256
|
previous_shipment_id?: string;
|
|
4753
5257
|
prices?: Prices;
|
|
4754
5258
|
shipment_created_at: string;
|
|
5259
|
+
shipment_created_ts?: string;
|
|
4755
5260
|
shipment_id?: string;
|
|
4756
5261
|
shipment_status?: ShipmentStatus;
|
|
4757
5262
|
status_created_at?: string;
|
|
5263
|
+
status_created_ts?: string;
|
|
4758
5264
|
total_bags: number;
|
|
4759
5265
|
user?: UserDataInfo;
|
|
4760
5266
|
};
|
|
@@ -4773,40 +5279,7 @@ type ShipmentItemFulFillingStore = {
|
|
|
4773
5279
|
pincode?: string;
|
|
4774
5280
|
state?: string;
|
|
4775
5281
|
store_email?: string;
|
|
4776
|
-
|
|
4777
|
-
/** @returns {ShipmentItemMeta} */
|
|
4778
|
-
declare function ShipmentItemMeta(): ShipmentItemMeta;
|
|
4779
|
-
type ShipmentItemMeta = {
|
|
4780
|
-
activity_comment?: string;
|
|
4781
|
-
assign_dp_from_sb?: boolean;
|
|
4782
|
-
auto_trigger_dp_assignment_acf: boolean;
|
|
4783
|
-
bag_weight?: any;
|
|
4784
|
-
debug_info?: any;
|
|
4785
|
-
dp_options?: any;
|
|
4786
|
-
dp_sort_key?: string;
|
|
4787
|
-
ewaybill_info?: any;
|
|
4788
|
-
existing_dp_list?: string[];
|
|
4789
|
-
external?: any;
|
|
4790
|
-
formatted?: Formatted;
|
|
4791
|
-
fulfilment_priority_text?: string;
|
|
4792
|
-
is_international?: boolean;
|
|
4793
|
-
is_self_ship?: boolean;
|
|
4794
|
-
lock_data?: LockData;
|
|
4795
|
-
order_type?: string;
|
|
4796
|
-
packaging_name?: string;
|
|
4797
|
-
parent_dp_id?: string;
|
|
4798
|
-
pdf_media?: any[];
|
|
4799
|
-
same_store_available?: boolean;
|
|
4800
|
-
shipment_chargeable_weight?: number;
|
|
4801
|
-
shipment_tags?: ShipmentTags[];
|
|
4802
|
-
shipment_volumetric_weight?: number;
|
|
4803
|
-
shipment_weight?: number;
|
|
4804
|
-
shipping_zone?: string;
|
|
4805
|
-
sla?: number;
|
|
4806
|
-
store_invoice_updated_date?: string;
|
|
4807
|
-
tags?: any[];
|
|
4808
|
-
timestamp?: ShipmentTimeStamp;
|
|
4809
|
-
weight?: number;
|
|
5282
|
+
tags?: string[];
|
|
4810
5283
|
};
|
|
4811
5284
|
/** @returns {ShipmentListingBrand} */
|
|
4812
5285
|
declare function ShipmentListingBrand(): ShipmentListingBrand;
|
|
@@ -4824,6 +5297,13 @@ type ShipmentListingChannel = {
|
|
|
4824
5297
|
logo?: string;
|
|
4825
5298
|
name?: string;
|
|
4826
5299
|
};
|
|
5300
|
+
/** @returns {ShipmentLockDetails} */
|
|
5301
|
+
declare function ShipmentLockDetails(): ShipmentLockDetails;
|
|
5302
|
+
type ShipmentLockDetails = {
|
|
5303
|
+
action_to_status?: any;
|
|
5304
|
+
lock_message?: string;
|
|
5305
|
+
lock_status?: boolean;
|
|
5306
|
+
};
|
|
4827
5307
|
/** @returns {ShipmentMeta} */
|
|
4828
5308
|
declare function ShipmentMeta(): ShipmentMeta;
|
|
4829
5309
|
type ShipmentMeta = {
|
|
@@ -4922,12 +5402,14 @@ declare function ShipmentStatus(): ShipmentStatus;
|
|
|
4922
5402
|
type ShipmentStatus = {
|
|
4923
5403
|
bag_list?: string[];
|
|
4924
5404
|
created_at?: string;
|
|
5405
|
+
created_ts?: string;
|
|
4925
5406
|
current_shipment_status?: string;
|
|
4926
5407
|
meta?: any;
|
|
4927
5408
|
shipment_id?: string;
|
|
4928
5409
|
shipment_status_id?: number;
|
|
4929
5410
|
status: string;
|
|
4930
5411
|
status_created_at?: string;
|
|
5412
|
+
status_created_ts?: string;
|
|
4931
5413
|
title: string;
|
|
4932
5414
|
};
|
|
4933
5415
|
/** @returns {ShipmentStatusData} */
|
|
@@ -4935,6 +5417,7 @@ declare function ShipmentStatusData(): ShipmentStatusData;
|
|
|
4935
5417
|
type ShipmentStatusData = {
|
|
4936
5418
|
bag_list?: string[];
|
|
4937
5419
|
created_at?: string;
|
|
5420
|
+
created_ts?: string;
|
|
4938
5421
|
current_shipment_status?: string;
|
|
4939
5422
|
display_name?: string;
|
|
4940
5423
|
id?: number;
|
|
@@ -4958,17 +5441,18 @@ type ShipmentTimeStamp = {
|
|
|
4958
5441
|
/** @returns {ShippingInfo} */
|
|
4959
5442
|
declare function ShippingInfo(): ShippingInfo;
|
|
4960
5443
|
type ShippingInfo = {
|
|
5444
|
+
address?: string;
|
|
4961
5445
|
address_type?: string;
|
|
4962
|
-
address1
|
|
5446
|
+
address1?: string;
|
|
4963
5447
|
address2?: string;
|
|
4964
5448
|
alternate_email?: string;
|
|
4965
5449
|
alternate_mobile_number?: string;
|
|
4966
|
-
city
|
|
4967
|
-
country
|
|
5450
|
+
city?: string;
|
|
5451
|
+
country?: string;
|
|
4968
5452
|
country_code?: string;
|
|
4969
5453
|
customer_code?: string;
|
|
4970
5454
|
external_customer_code?: string;
|
|
4971
|
-
first_name
|
|
5455
|
+
first_name?: string;
|
|
4972
5456
|
floor_no?: string;
|
|
4973
5457
|
gender?: string;
|
|
4974
5458
|
geo_location?: any;
|
|
@@ -4976,12 +5460,12 @@ type ShippingInfo = {
|
|
|
4976
5460
|
landmark?: string;
|
|
4977
5461
|
last_name?: string;
|
|
4978
5462
|
middle_name?: string;
|
|
4979
|
-
pincode
|
|
4980
|
-
primary_email
|
|
4981
|
-
primary_mobile_number
|
|
5463
|
+
pincode?: string;
|
|
5464
|
+
primary_email?: string;
|
|
5465
|
+
primary_mobile_number?: string;
|
|
4982
5466
|
shipping_type?: string;
|
|
4983
5467
|
slot?: any[];
|
|
4984
|
-
state
|
|
5468
|
+
state?: string;
|
|
4985
5469
|
state_code?: string;
|
|
4986
5470
|
title?: string;
|
|
4987
5471
|
};
|
|
@@ -5026,6 +5510,74 @@ type SmsDataPayload = {
|
|
|
5026
5510
|
*/
|
|
5027
5511
|
shipment_id: number;
|
|
5028
5512
|
};
|
|
5513
|
+
/** @returns {StateManagerFilter} */
|
|
5514
|
+
declare function StateManagerFilter(): StateManagerFilter;
|
|
5515
|
+
type StateManagerFilter = {
|
|
5516
|
+
default_value?: string;
|
|
5517
|
+
description?: string;
|
|
5518
|
+
display_name?: string;
|
|
5519
|
+
id?: number;
|
|
5520
|
+
name?: string;
|
|
5521
|
+
options?: any;
|
|
5522
|
+
type?: string;
|
|
5523
|
+
};
|
|
5524
|
+
/** @returns {StateManagerState} */
|
|
5525
|
+
declare function StateManagerState(): StateManagerState;
|
|
5526
|
+
type StateManagerState = {
|
|
5527
|
+
/**
|
|
5528
|
+
* - The application display name
|
|
5529
|
+
*/
|
|
5530
|
+
app_display_name?: string;
|
|
5531
|
+
/**
|
|
5532
|
+
* - Whether state is for app facing or not
|
|
5533
|
+
*/
|
|
5534
|
+
app_facing?: boolean;
|
|
5535
|
+
/**
|
|
5536
|
+
* - Unique identifier for the state
|
|
5537
|
+
*/
|
|
5538
|
+
id?: number;
|
|
5539
|
+
/**
|
|
5540
|
+
* - Whether state is active or not
|
|
5541
|
+
*/
|
|
5542
|
+
is_active?: boolean;
|
|
5543
|
+
/**
|
|
5544
|
+
* - Type of the journey
|
|
5545
|
+
*/
|
|
5546
|
+
journey_type?: string;
|
|
5547
|
+
/**
|
|
5548
|
+
* - The platform display name
|
|
5549
|
+
*/
|
|
5550
|
+
platform_display_name?: string;
|
|
5551
|
+
/**
|
|
5552
|
+
* - The name of the state
|
|
5553
|
+
*/
|
|
5554
|
+
state?: string;
|
|
5555
|
+
/**
|
|
5556
|
+
* - Type of the state
|
|
5557
|
+
*/
|
|
5558
|
+
state_type?: string;
|
|
5559
|
+
};
|
|
5560
|
+
/** @returns {StateManagerTask} */
|
|
5561
|
+
declare function StateManagerTask(): StateManagerTask;
|
|
5562
|
+
type StateManagerTask = {
|
|
5563
|
+
description?: string;
|
|
5564
|
+
display_name?: string;
|
|
5565
|
+
doc_string?: string;
|
|
5566
|
+
id?: number;
|
|
5567
|
+
kwargs?: any;
|
|
5568
|
+
name?: string;
|
|
5569
|
+
};
|
|
5570
|
+
/** @returns {StateTransitionFlag} */
|
|
5571
|
+
declare function StateTransitionFlag(): StateTransitionFlag;
|
|
5572
|
+
type StateTransitionFlag = {
|
|
5573
|
+
default_value?: string;
|
|
5574
|
+
description?: string;
|
|
5575
|
+
display_name?: string;
|
|
5576
|
+
id?: number;
|
|
5577
|
+
name?: string;
|
|
5578
|
+
options?: any;
|
|
5579
|
+
type?: string;
|
|
5580
|
+
};
|
|
5029
5581
|
/** @returns {StatuesRequest} */
|
|
5030
5582
|
declare function StatuesRequest(): StatuesRequest;
|
|
5031
5583
|
type StatuesRequest = {
|
|
@@ -5211,27 +5763,34 @@ type TaxInfo = {
|
|
|
5211
5763
|
gstin?: string;
|
|
5212
5764
|
pan_no?: string;
|
|
5213
5765
|
};
|
|
5766
|
+
/** @returns {TemplateDownloadResponse} */
|
|
5767
|
+
declare function TemplateDownloadResponse(): TemplateDownloadResponse;
|
|
5768
|
+
type TemplateDownloadResponse = {
|
|
5769
|
+
file_name?: string;
|
|
5770
|
+
url?: string;
|
|
5771
|
+
};
|
|
5772
|
+
/** @returns {Templates} */
|
|
5773
|
+
declare function Templates(): Templates;
|
|
5774
|
+
type Templates = {
|
|
5775
|
+
text?: string;
|
|
5776
|
+
value?: string;
|
|
5777
|
+
};
|
|
5778
|
+
/** @returns {TotalShipmentPricesCount} */
|
|
5779
|
+
declare function TotalShipmentPricesCount(): TotalShipmentPricesCount;
|
|
5780
|
+
type TotalShipmentPricesCount = {
|
|
5781
|
+
shipment_count?: number;
|
|
5782
|
+
total_price?: number;
|
|
5783
|
+
};
|
|
5214
5784
|
/** @returns {TrackingList} */
|
|
5215
5785
|
declare function TrackingList(): TrackingList;
|
|
5216
5786
|
type TrackingList = {
|
|
5787
|
+
created_ts?: string;
|
|
5217
5788
|
is_current?: boolean;
|
|
5218
5789
|
is_passed?: boolean;
|
|
5219
5790
|
status: string;
|
|
5220
5791
|
text: string;
|
|
5221
5792
|
time?: string;
|
|
5222
5793
|
};
|
|
5223
|
-
/** @returns {TransactionData} */
|
|
5224
|
-
declare function TransactionData(): TransactionData;
|
|
5225
|
-
type TransactionData = {
|
|
5226
|
-
amount_paid?: number;
|
|
5227
|
-
currency?: string;
|
|
5228
|
-
entity?: string;
|
|
5229
|
-
payment_id?: string;
|
|
5230
|
-
status?: string;
|
|
5231
|
-
terminal_id?: string;
|
|
5232
|
-
transaction_id?: string;
|
|
5233
|
-
unique_reference_number?: string;
|
|
5234
|
-
};
|
|
5235
5794
|
/** @returns {UpdatePackagingDimensionsPayload} */
|
|
5236
5795
|
declare function UpdatePackagingDimensionsPayload(): UpdatePackagingDimensionsPayload;
|
|
5237
5796
|
type UpdatePackagingDimensionsPayload = {
|
|
@@ -5343,12 +5902,15 @@ type UserDetailsData = {
|
|
|
5343
5902
|
area?: string;
|
|
5344
5903
|
city: string;
|
|
5345
5904
|
country: string;
|
|
5905
|
+
country_iso_code?: string;
|
|
5906
|
+
country_phone_code?: string;
|
|
5346
5907
|
email?: string;
|
|
5347
5908
|
landmark?: string;
|
|
5348
5909
|
name: string;
|
|
5349
5910
|
phone: string;
|
|
5350
5911
|
pincode: string;
|
|
5351
5912
|
state: string;
|
|
5913
|
+
state_code?: string;
|
|
5352
5914
|
};
|
|
5353
5915
|
/** @returns {UserInfo} */
|
|
5354
5916
|
declare function UserInfo(): UserInfo;
|