@gofynd/fdk-client-javascript 1.3.11-beta.7 → 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 +1032 -470
- package/sdk/platform/Order/OrderPlatformModel.js +1187 -534
- 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
|
@@ -171,6 +171,11 @@ const Joi = require("joi");
|
|
|
171
171
|
* @property {number} store_id
|
|
172
172
|
*/
|
|
173
173
|
|
|
174
|
+
/**
|
|
175
|
+
* @typedef AllowedTemplatesResponse
|
|
176
|
+
* @property {Templates[]} [template_x_slug]
|
|
177
|
+
*/
|
|
178
|
+
|
|
174
179
|
/**
|
|
175
180
|
* @typedef AnnouncementResponse
|
|
176
181
|
* @property {number} [company_id]
|
|
@@ -231,10 +236,14 @@ const Joi = require("joi");
|
|
|
231
236
|
* @property {Object} category
|
|
232
237
|
* @property {Object} dimension
|
|
233
238
|
* @property {number} quantity
|
|
234
|
-
* @property {Object} [status]
|
|
235
239
|
* @property {Object} weight
|
|
236
240
|
*/
|
|
237
241
|
|
|
242
|
+
/**
|
|
243
|
+
* @typedef ArticleStatusDetails
|
|
244
|
+
* @property {Object} [status]
|
|
245
|
+
*/
|
|
246
|
+
|
|
238
247
|
/**
|
|
239
248
|
* @typedef AttachOrderUser
|
|
240
249
|
* @property {string} fynd_order_id
|
|
@@ -274,16 +283,6 @@ const Joi = require("joi");
|
|
|
274
283
|
* @property {string} [primary_material]
|
|
275
284
|
*/
|
|
276
285
|
|
|
277
|
-
/**
|
|
278
|
-
* @typedef B2BPODetails
|
|
279
|
-
* @property {string} [docker_number]
|
|
280
|
-
* @property {number} [item_base_price]
|
|
281
|
-
* @property {boolean} [partial_can_ret]
|
|
282
|
-
* @property {number} [po_line_amount]
|
|
283
|
-
* @property {number} [po_tax_amount]
|
|
284
|
-
* @property {number} [total_gst_percentage]
|
|
285
|
-
*/
|
|
286
|
-
|
|
287
286
|
/**
|
|
288
287
|
* @typedef BagConfigs
|
|
289
288
|
* @property {boolean} allow_force_return
|
|
@@ -300,7 +299,7 @@ const Joi = require("joi");
|
|
|
300
299
|
* @property {AffiliateDetails} [affiliate_details]
|
|
301
300
|
* @property {Object[]} [applied_promos]
|
|
302
301
|
* @property {Article} [article]
|
|
303
|
-
* @property {
|
|
302
|
+
* @property {ArticleStatusDetails} [article_details]
|
|
304
303
|
* @property {BagStatusHistory[]} [bag_status]
|
|
305
304
|
* @property {BagStatusHistory} [bag_status_history]
|
|
306
305
|
* @property {number} [bag_update_time]
|
|
@@ -332,63 +331,11 @@ const Joi = require("joi");
|
|
|
332
331
|
* @property {Object} [restore_promos]
|
|
333
332
|
* @property {string} [seller_identifier]
|
|
334
333
|
* @property {string} [shipment_id]
|
|
335
|
-
* @property {
|
|
334
|
+
* @property {BagReturnableCancelableStatus} [status]
|
|
336
335
|
* @property {string[]} [tags]
|
|
337
336
|
* @property {string} [type]
|
|
338
337
|
*/
|
|
339
338
|
|
|
340
|
-
/**
|
|
341
|
-
* @typedef BagGST
|
|
342
|
-
* @property {number} [brand_calculated_amount]
|
|
343
|
-
* @property {string} [cgst_gst_fee]
|
|
344
|
-
* @property {number} [cgst_tax_percentage]
|
|
345
|
-
* @property {number} [gst_fee]
|
|
346
|
-
* @property {string} [gst_tag]
|
|
347
|
-
* @property {number} [gst_tax_percentage]
|
|
348
|
-
* @property {string} [gstin_code]
|
|
349
|
-
* @property {string} [hsn_code]
|
|
350
|
-
* @property {string} [hsn_code_id]
|
|
351
|
-
* @property {string} [igst_gst_fee]
|
|
352
|
-
* @property {number} [igst_tax_percentage]
|
|
353
|
-
* @property {boolean} [is_default_hsn_code]
|
|
354
|
-
* @property {string} [sgst_gst_fee]
|
|
355
|
-
* @property {number} [sgst_tax_percentage]
|
|
356
|
-
* @property {number} [tax_collected_at_source]
|
|
357
|
-
* @property {number} [value_of_good]
|
|
358
|
-
*/
|
|
359
|
-
|
|
360
|
-
/**
|
|
361
|
-
* @typedef BagGSTDetails
|
|
362
|
-
* @property {number} brand_calculated_amount
|
|
363
|
-
* @property {string} cgst_gst_fee
|
|
364
|
-
* @property {number} cgst_tax_percentage
|
|
365
|
-
* @property {number} gst_fee
|
|
366
|
-
* @property {string} gst_tag
|
|
367
|
-
* @property {number} gst_tax_percentage
|
|
368
|
-
* @property {string} [gstin_code]
|
|
369
|
-
* @property {string} hsn_code
|
|
370
|
-
* @property {string} hsn_code_id
|
|
371
|
-
* @property {string} igst_gst_fee
|
|
372
|
-
* @property {number} igst_tax_percentage
|
|
373
|
-
* @property {boolean} [is_default_hsn_code]
|
|
374
|
-
* @property {string} sgst_gst_fee
|
|
375
|
-
* @property {number} sgst_tax_percentage
|
|
376
|
-
* @property {number} tax_collected_at_source
|
|
377
|
-
* @property {number} value_of_good
|
|
378
|
-
*/
|
|
379
|
-
|
|
380
|
-
/**
|
|
381
|
-
* @typedef BagMeta
|
|
382
|
-
* @property {B2BPODetails} [b2b_po_details]
|
|
383
|
-
* @property {Object} [custom_json]
|
|
384
|
-
* @property {string} [custom_message]
|
|
385
|
-
* @property {string} [docket_number]
|
|
386
|
-
* @property {Object} [extra_meta]
|
|
387
|
-
* @property {GiftCard} [gift_card]
|
|
388
|
-
* @property {string} [group_id]
|
|
389
|
-
* @property {boolean} [partial_can_ret]
|
|
390
|
-
*/
|
|
391
|
-
|
|
392
339
|
/**
|
|
393
340
|
* @typedef BagPaymentMethods
|
|
394
341
|
* @property {number} [amount]
|
|
@@ -419,15 +366,6 @@ const Joi = require("joi");
|
|
|
419
366
|
* @property {boolean} is_returnable
|
|
420
367
|
*/
|
|
421
368
|
|
|
422
|
-
/**
|
|
423
|
-
* @typedef BagReturnableCancelableStatus1
|
|
424
|
-
* @property {boolean} can_be_cancelled
|
|
425
|
-
* @property {boolean} enable_tracking
|
|
426
|
-
* @property {boolean} is_active
|
|
427
|
-
* @property {boolean} is_customer_return_allowed
|
|
428
|
-
* @property {boolean} is_returnable
|
|
429
|
-
*/
|
|
430
|
-
|
|
431
369
|
/**
|
|
432
370
|
* @typedef Bags
|
|
433
371
|
* @property {string} [affiliate_bag_id] - Application/Affiliate Bag ID,
|
|
@@ -474,6 +412,7 @@ const Joi = require("joi");
|
|
|
474
412
|
* @property {BagStateMapper} [bag_state_mapper]
|
|
475
413
|
* @property {number} [bsh_id]
|
|
476
414
|
* @property {string} [created_at]
|
|
415
|
+
* @property {string} [created_ts]
|
|
477
416
|
* @property {string} [delivery_awb_number]
|
|
478
417
|
* @property {number} [delivery_partner_id]
|
|
479
418
|
* @property {string} [display_name]
|
|
@@ -486,6 +425,7 @@ const Joi = require("joi");
|
|
|
486
425
|
* @property {string} status
|
|
487
426
|
* @property {number} [store_id]
|
|
488
427
|
* @property {string} [updated_at]
|
|
428
|
+
* @property {string} [updated_ts]
|
|
489
429
|
*/
|
|
490
430
|
|
|
491
431
|
/**
|
|
@@ -524,38 +464,30 @@ const Joi = require("joi");
|
|
|
524
464
|
|
|
525
465
|
/**
|
|
526
466
|
* @typedef BillingInfo
|
|
527
|
-
* @property {string}
|
|
467
|
+
* @property {string} [address]
|
|
468
|
+
* @property {string} [address1]
|
|
528
469
|
* @property {string} [address2]
|
|
529
470
|
* @property {string} [alternate_email]
|
|
530
471
|
* @property {string} [alternate_mobile_number]
|
|
531
|
-
* @property {string} city
|
|
532
|
-
* @property {string} country
|
|
472
|
+
* @property {string} [city]
|
|
473
|
+
* @property {string} [country]
|
|
533
474
|
* @property {string} [country_code]
|
|
534
475
|
* @property {string} [customer_code]
|
|
535
476
|
* @property {string} [external_customer_code]
|
|
536
|
-
* @property {string} first_name
|
|
477
|
+
* @property {string} [first_name]
|
|
537
478
|
* @property {string} [floor_no]
|
|
538
479
|
* @property {string} [gender]
|
|
539
480
|
* @property {string} [house_no]
|
|
540
481
|
* @property {string} [last_name]
|
|
541
482
|
* @property {string} [middle_name]
|
|
542
|
-
* @property {string} pincode
|
|
543
|
-
* @property {string} primary_email
|
|
544
|
-
* @property {string} primary_mobile_number
|
|
545
|
-
* @property {string} state
|
|
483
|
+
* @property {string} [pincode]
|
|
484
|
+
* @property {string} [primary_email]
|
|
485
|
+
* @property {string} [primary_mobile_number]
|
|
486
|
+
* @property {string} [state]
|
|
546
487
|
* @property {string} [state_code]
|
|
547
488
|
* @property {string} [title]
|
|
548
489
|
*/
|
|
549
490
|
|
|
550
|
-
/**
|
|
551
|
-
* @typedef BillingStaffDetails
|
|
552
|
-
* @property {string} [employee_code]
|
|
553
|
-
* @property {string} [first_name]
|
|
554
|
-
* @property {string} [last_name]
|
|
555
|
-
* @property {number} [staff_id]
|
|
556
|
-
* @property {string} [user]
|
|
557
|
-
*/
|
|
558
|
-
|
|
559
491
|
/**
|
|
560
492
|
* @typedef Brand
|
|
561
493
|
* @property {number} brand_id
|
|
@@ -573,6 +505,34 @@ const Joi = require("joi");
|
|
|
573
505
|
* @property {string} [start_date]
|
|
574
506
|
*/
|
|
575
507
|
|
|
508
|
+
/**
|
|
509
|
+
* @typedef BulkActionListingData
|
|
510
|
+
* @property {string} [batch_id]
|
|
511
|
+
* @property {string} [bulk_action_type]
|
|
512
|
+
* @property {number} [company_id]
|
|
513
|
+
* @property {string} [created_ts]
|
|
514
|
+
* @property {boolean} [do_invoice_label_generated]
|
|
515
|
+
* @property {string} [file_name]
|
|
516
|
+
* @property {string} [file_url]
|
|
517
|
+
* @property {number} [id]
|
|
518
|
+
* @property {string} [invoice_document_type]
|
|
519
|
+
* @property {string} [invoice_status]
|
|
520
|
+
* @property {boolean} [is_invoiceable]
|
|
521
|
+
* @property {string} [label_document_type]
|
|
522
|
+
* @property {string} [last_selected_invoice_label_type]
|
|
523
|
+
* @property {Object} [meta]
|
|
524
|
+
* @property {ShipmentActionInfo} [shipments_action_info]
|
|
525
|
+
* @property {boolean} [status]
|
|
526
|
+
* @property {string} [store_code]
|
|
527
|
+
* @property {number} [store_id]
|
|
528
|
+
* @property {string} [store_name]
|
|
529
|
+
* @property {number} [updated_ts]
|
|
530
|
+
* @property {string} [uploaded_by]
|
|
531
|
+
* @property {string} [uploaded_on]
|
|
532
|
+
* @property {string} [user_id]
|
|
533
|
+
* @property {string} [user_name]
|
|
534
|
+
*/
|
|
535
|
+
|
|
576
536
|
/**
|
|
577
537
|
* @typedef BulkActionTemplate
|
|
578
538
|
* @property {string} [text]
|
|
@@ -585,24 +545,43 @@ const Joi = require("joi");
|
|
|
585
545
|
*/
|
|
586
546
|
|
|
587
547
|
/**
|
|
588
|
-
* @typedef
|
|
548
|
+
* @typedef BulkFailedResponse
|
|
589
549
|
* @property {string} [error]
|
|
590
550
|
* @property {boolean} [status]
|
|
591
551
|
*/
|
|
592
552
|
|
|
553
|
+
/**
|
|
554
|
+
* @typedef BulkListingResponse
|
|
555
|
+
* @property {BulkActionListingData[]} [data]
|
|
556
|
+
* @property {BulkListinPage} [page]
|
|
557
|
+
* @property {boolean} [success]
|
|
558
|
+
* @property {number} [total_count]
|
|
559
|
+
*/
|
|
560
|
+
|
|
561
|
+
/**
|
|
562
|
+
* @typedef BulkListinPage
|
|
563
|
+
* @property {number} [current]
|
|
564
|
+
* @property {boolean} [has_next]
|
|
565
|
+
* @property {boolean} [has_previous]
|
|
566
|
+
* @property {number} [item_total]
|
|
567
|
+
* @property {number} [size]
|
|
568
|
+
* @property {number} [total]
|
|
569
|
+
* @property {string} [type]
|
|
570
|
+
*/
|
|
571
|
+
|
|
593
572
|
/**
|
|
594
573
|
* @typedef BulkReportsDownloadRequest
|
|
595
574
|
* @property {Object} [custom_filters_for_lane]
|
|
596
575
|
* @property {string} [custom_headers] - Download report with specific headers
|
|
576
|
+
* @property {string} [end_date] - UTC end date in ISO format
|
|
597
577
|
* @property {string[]} [entities] - Download for specific enitites, entities
|
|
598
578
|
* can be bag, shipment or order_id, etc.
|
|
599
579
|
* @property {string} [filter_type]
|
|
600
|
-
* @property {string} [from_date]
|
|
601
580
|
* @property {boolean} [is_cross_company_enabled] - Download lanes for cross company.
|
|
602
581
|
* @property {string} [lane_type]
|
|
603
582
|
* @property {string} [report_type] - Type of report
|
|
583
|
+
* @property {string} [start_date] - UTC start date in ISO format
|
|
604
584
|
* @property {string[]} [store_ids] - Download for specific store ids.
|
|
605
|
-
* @property {string} [to_date]
|
|
606
585
|
*/
|
|
607
586
|
|
|
608
587
|
/**
|
|
@@ -611,6 +590,19 @@ const Joi = require("joi");
|
|
|
611
590
|
* @property {boolean} [success]
|
|
612
591
|
*/
|
|
613
592
|
|
|
593
|
+
/**
|
|
594
|
+
* @typedef BulkStateTransistionRequest
|
|
595
|
+
* @property {string} [file_name]
|
|
596
|
+
* @property {string} [url]
|
|
597
|
+
*/
|
|
598
|
+
|
|
599
|
+
/**
|
|
600
|
+
* @typedef BulkStateTransistionResponse
|
|
601
|
+
* @property {string} [batch_id]
|
|
602
|
+
* @property {string} [message]
|
|
603
|
+
* @property {boolean} [status]
|
|
604
|
+
*/
|
|
605
|
+
|
|
614
606
|
/**
|
|
615
607
|
* @typedef BuyerDetails
|
|
616
608
|
* @property {string} address
|
|
@@ -673,6 +665,12 @@ const Joi = require("joi");
|
|
|
673
665
|
* @property {PhoneDetails[]} [phone]
|
|
674
666
|
*/
|
|
675
667
|
|
|
668
|
+
/**
|
|
669
|
+
* @typedef ConversionRate
|
|
670
|
+
* @property {string} [base]
|
|
671
|
+
* @property {Object} [rates]
|
|
672
|
+
*/
|
|
673
|
+
|
|
676
674
|
/**
|
|
677
675
|
* @typedef CourierPartnerTrackingDetails
|
|
678
676
|
* @property {string} awb - AWB Number
|
|
@@ -780,11 +778,24 @@ const Joi = require("joi");
|
|
|
780
778
|
* @property {string} [total_credited_balance]
|
|
781
779
|
*/
|
|
782
780
|
|
|
781
|
+
/**
|
|
782
|
+
* @typedef Currency
|
|
783
|
+
* @property {string} [currency_code]
|
|
784
|
+
* @property {string} [currency_symbol]
|
|
785
|
+
*/
|
|
786
|
+
|
|
787
|
+
/**
|
|
788
|
+
* @typedef CurrencyInfo
|
|
789
|
+
* @property {ConversionRate} [conversion_rate]
|
|
790
|
+
* @property {OrderingCurrency} [ordering_currency]
|
|
791
|
+
*/
|
|
792
|
+
|
|
783
793
|
/**
|
|
784
794
|
* @typedef CurrentStatus
|
|
785
795
|
* @property {number} [bag_id]
|
|
786
796
|
* @property {BagStateMapper} [bag_state_mapper]
|
|
787
797
|
* @property {string} [created_at]
|
|
798
|
+
* @property {string} [created_ts]
|
|
788
799
|
* @property {string} [delivery_awb_number]
|
|
789
800
|
* @property {number} [delivery_partner_id]
|
|
790
801
|
* @property {number} id
|
|
@@ -804,6 +815,12 @@ const Joi = require("joi");
|
|
|
804
815
|
* @property {ProductsDataUpdates[]} [products]
|
|
805
816
|
*/
|
|
806
817
|
|
|
818
|
+
/**
|
|
819
|
+
* @typedef DateRange
|
|
820
|
+
* @property {string} [from_date]
|
|
821
|
+
* @property {string} [to_date]
|
|
822
|
+
*/
|
|
823
|
+
|
|
807
824
|
/**
|
|
808
825
|
* @typedef Dates
|
|
809
826
|
* @property {string} [delivery_date]
|
|
@@ -870,12 +887,59 @@ const Joi = require("joi");
|
|
|
870
887
|
* @property {string} [track_url]
|
|
871
888
|
*/
|
|
872
889
|
|
|
890
|
+
/**
|
|
891
|
+
* @typedef EInvoiceDetails
|
|
892
|
+
* @property {EInvoiceErrorDetails[]} [error_details]
|
|
893
|
+
* @property {EInvoiceIrnDetails} [irn_details]
|
|
894
|
+
*/
|
|
895
|
+
|
|
896
|
+
/**
|
|
897
|
+
* @typedef EInvoiceErrorDetails
|
|
898
|
+
* @property {string} [error_code]
|
|
899
|
+
* @property {string} error_message
|
|
900
|
+
*/
|
|
901
|
+
|
|
902
|
+
/**
|
|
903
|
+
* @typedef EInvoiceErrorInfo
|
|
904
|
+
* @property {EInvoiceErrorDetails[]} [error_details]
|
|
905
|
+
*/
|
|
906
|
+
|
|
907
|
+
/**
|
|
908
|
+
* @typedef EInvoiceErrorResponse
|
|
909
|
+
* @property {string} [message]
|
|
910
|
+
* @property {EInvoiceErrorResponseData[]} [response_data]
|
|
911
|
+
*/
|
|
912
|
+
|
|
913
|
+
/**
|
|
914
|
+
* @typedef EInvoiceErrorResponseData
|
|
915
|
+
* @property {EInvoiceErrorInfo} [einvoice_info]
|
|
916
|
+
* @property {string} einvoice_type
|
|
917
|
+
* @property {string} message
|
|
918
|
+
* @property {string} shipment_id
|
|
919
|
+
* @property {number} status
|
|
920
|
+
*/
|
|
921
|
+
|
|
922
|
+
/**
|
|
923
|
+
* @typedef EInvoiceErrorResponseDetails
|
|
924
|
+
* @property {string} [message]
|
|
925
|
+
* @property {EInvoiceErrorResponseData[]} response_data
|
|
926
|
+
*/
|
|
927
|
+
|
|
873
928
|
/**
|
|
874
929
|
* @typedef EinvoiceInfo
|
|
875
930
|
* @property {Object} [credit_note]
|
|
876
931
|
* @property {Object} [invoice]
|
|
877
932
|
*/
|
|
878
933
|
|
|
934
|
+
/**
|
|
935
|
+
* @typedef EInvoiceIrnDetails
|
|
936
|
+
* @property {string} ack_dt
|
|
937
|
+
* @property {string} ack_no
|
|
938
|
+
* @property {string} irn
|
|
939
|
+
* @property {string} signed_invoice
|
|
940
|
+
* @property {string} signed_qr_code
|
|
941
|
+
*/
|
|
942
|
+
|
|
879
943
|
/**
|
|
880
944
|
* @typedef EInvoicePortalDetails
|
|
881
945
|
* @property {string} [password]
|
|
@@ -885,14 +949,11 @@ const Joi = require("joi");
|
|
|
885
949
|
|
|
886
950
|
/**
|
|
887
951
|
* @typedef EInvoiceResponseData
|
|
888
|
-
* @property {
|
|
889
|
-
* @property {string}
|
|
890
|
-
* @property {string} [irn]
|
|
952
|
+
* @property {EInvoiceDetails} [einvoice_info]
|
|
953
|
+
* @property {string} einvoice_type
|
|
891
954
|
* @property {string} message
|
|
892
955
|
* @property {string} shipment_id
|
|
893
|
-
* @property {
|
|
894
|
-
* @property {number} [timeout]
|
|
895
|
-
* @property {string} [timeout_unit]
|
|
956
|
+
* @property {number} status
|
|
896
957
|
*/
|
|
897
958
|
|
|
898
959
|
/**
|
|
@@ -902,14 +963,12 @@ const Joi = require("joi");
|
|
|
902
963
|
|
|
903
964
|
/**
|
|
904
965
|
* @typedef EInvoiceRetryResponse
|
|
905
|
-
* @property {string} [message]
|
|
906
966
|
* @property {EInvoiceResponseData[]} response_data
|
|
907
|
-
* @property {boolean} [success]
|
|
908
|
-
* @property {number} success_count
|
|
909
967
|
*/
|
|
910
968
|
|
|
911
969
|
/**
|
|
912
970
|
* @typedef EInvoiceRetryShipmentData
|
|
971
|
+
* @property {string} einvoice_type
|
|
913
972
|
* @property {string} shipment_id
|
|
914
973
|
*/
|
|
915
974
|
|
|
@@ -960,13 +1019,38 @@ const Joi = require("joi");
|
|
|
960
1019
|
|
|
961
1020
|
/**
|
|
962
1021
|
* @typedef ErrorResponse
|
|
963
|
-
* @property {string} error
|
|
1022
|
+
* @property {string} [error]
|
|
964
1023
|
* @property {string} [error_trace]
|
|
965
1024
|
* @property {string} message
|
|
966
1025
|
* @property {number} [status]
|
|
967
1026
|
* @property {boolean} [success]
|
|
968
1027
|
*/
|
|
969
1028
|
|
|
1029
|
+
/**
|
|
1030
|
+
* @typedef FailedOrderLogDetails
|
|
1031
|
+
* @property {string} error_trace
|
|
1032
|
+
* @property {string} exception
|
|
1033
|
+
*/
|
|
1034
|
+
|
|
1035
|
+
/**
|
|
1036
|
+
* @typedef FailedOrderLogs
|
|
1037
|
+
* @property {FailedOrdersItem} items
|
|
1038
|
+
* @property {PageDetails} page
|
|
1039
|
+
*/
|
|
1040
|
+
|
|
1041
|
+
/**
|
|
1042
|
+
* @typedef FailedOrdersItem
|
|
1043
|
+
* @property {LogsChannelDetails} channel
|
|
1044
|
+
* @property {string} created_at
|
|
1045
|
+
* @property {string} display_message
|
|
1046
|
+
* @property {string} error_message
|
|
1047
|
+
* @property {number} log_id
|
|
1048
|
+
* @property {Object} meta
|
|
1049
|
+
* @property {string} method_name
|
|
1050
|
+
* @property {string} order_id
|
|
1051
|
+
* @property {LogPaymentDetails} payment
|
|
1052
|
+
*/
|
|
1053
|
+
|
|
970
1054
|
/**
|
|
971
1055
|
* @typedef FetchCreditBalanceRequestPayload
|
|
972
1056
|
* @property {string} affiliate_id
|
|
@@ -996,6 +1080,20 @@ const Joi = require("joi");
|
|
|
996
1080
|
* @property {string} [value]
|
|
997
1081
|
*/
|
|
998
1082
|
|
|
1083
|
+
/**
|
|
1084
|
+
* @typedef Filters
|
|
1085
|
+
* @property {DateRange} [date_range]
|
|
1086
|
+
* @property {number} [dp_ids]
|
|
1087
|
+
* @property {string} [dp_name]
|
|
1088
|
+
* @property {string} [from_date]
|
|
1089
|
+
* @property {string} [lane]
|
|
1090
|
+
* @property {string} [logo]
|
|
1091
|
+
* @property {string} [selected_shipments]
|
|
1092
|
+
* @property {string} [store_name]
|
|
1093
|
+
* @property {number} [stores]
|
|
1094
|
+
* @property {string} [to_date]
|
|
1095
|
+
*/
|
|
1096
|
+
|
|
999
1097
|
/**
|
|
1000
1098
|
* @typedef FiltersInfo
|
|
1001
1099
|
* @property {FilterInfoOption[]} [options]
|
|
@@ -1006,6 +1104,17 @@ const Joi = require("joi");
|
|
|
1006
1104
|
* @property {string} value
|
|
1007
1105
|
*/
|
|
1008
1106
|
|
|
1107
|
+
/**
|
|
1108
|
+
* @typedef FiltersRequest
|
|
1109
|
+
* @property {DateRange} [date_range]
|
|
1110
|
+
* @property {number} dp_ids
|
|
1111
|
+
* @property {string} dp_name
|
|
1112
|
+
* @property {string} lane
|
|
1113
|
+
* @property {string} [logo]
|
|
1114
|
+
* @property {string} store_name
|
|
1115
|
+
* @property {number} stores
|
|
1116
|
+
*/
|
|
1117
|
+
|
|
1009
1118
|
/**
|
|
1010
1119
|
* @typedef FiltersResponse
|
|
1011
1120
|
* @property {AdvanceFilterInfo} [advance_filter]
|
|
@@ -1070,44 +1179,16 @@ const Joi = require("joi");
|
|
|
1070
1179
|
* @property {string[]} [fynd_order_id]
|
|
1071
1180
|
*/
|
|
1072
1181
|
|
|
1073
|
-
/**
|
|
1074
|
-
* @typedef GenerateInvoiceIDErrorResponse
|
|
1075
|
-
* @property {GenerateInvoiceIDErrorResponseData[]} [items]
|
|
1076
|
-
*/
|
|
1077
|
-
|
|
1078
|
-
/**
|
|
1079
|
-
* @typedef GenerateInvoiceIDErrorResponseData
|
|
1080
|
-
* @property {string} [error_message]
|
|
1081
|
-
* @property {boolean} [invoice_id]
|
|
1082
|
-
* @property {string} [shipment_id]
|
|
1083
|
-
* @property {boolean} [success]
|
|
1084
|
-
*/
|
|
1085
|
-
|
|
1086
|
-
/**
|
|
1087
|
-
* @typedef GenerateInvoiceIDRequest
|
|
1088
|
-
* @property {string[]} shipment_ids
|
|
1089
|
-
*/
|
|
1090
|
-
|
|
1091
|
-
/**
|
|
1092
|
-
* @typedef GenerateInvoiceIDResponse
|
|
1093
|
-
* @property {GenerateInvoiceIDResponseData[]} [items]
|
|
1094
|
-
*/
|
|
1095
|
-
|
|
1096
|
-
/**
|
|
1097
|
-
* @typedef GenerateInvoiceIDResponseData
|
|
1098
|
-
* @property {boolean} [error_message]
|
|
1099
|
-
* @property {string} [invoice_id]
|
|
1100
|
-
* @property {string} [shipment_id]
|
|
1101
|
-
* @property {boolean} [success]
|
|
1102
|
-
*/
|
|
1103
|
-
|
|
1104
1182
|
/**
|
|
1105
1183
|
* @typedef GeneratePosOrderReceiptResponse
|
|
1106
1184
|
* @property {string} [customer_cn_receipt]
|
|
1185
|
+
* @property {string} [customer_cn_receipt_template]
|
|
1107
1186
|
* @property {string} [invoice_receipt]
|
|
1187
|
+
* @property {string} [invoice_receipt_template]
|
|
1108
1188
|
* @property {string} [merchant_cn_receipt]
|
|
1109
1189
|
* @property {string} [order_id]
|
|
1110
1190
|
* @property {string} [payment_receipt]
|
|
1191
|
+
* @property {string} [payment_receipt_template]
|
|
1111
1192
|
* @property {boolean} [success]
|
|
1112
1193
|
*/
|
|
1113
1194
|
|
|
@@ -1122,14 +1203,6 @@ const Joi = require("joi");
|
|
|
1122
1203
|
* @property {BagsPage} page
|
|
1123
1204
|
*/
|
|
1124
1205
|
|
|
1125
|
-
/**
|
|
1126
|
-
* @typedef GiftCard
|
|
1127
|
-
* @property {string} [display_text]
|
|
1128
|
-
* @property {string} [gift_message]
|
|
1129
|
-
* @property {number} [gift_price]
|
|
1130
|
-
* @property {boolean} [is_gift_applied]
|
|
1131
|
-
*/
|
|
1132
|
-
|
|
1133
1206
|
/**
|
|
1134
1207
|
* @typedef GSTDetailsData
|
|
1135
1208
|
* @property {number} brand_calculated_amount
|
|
@@ -1280,6 +1353,37 @@ const Joi = require("joi");
|
|
|
1280
1353
|
* @property {number[]} [item_brand]
|
|
1281
1354
|
*/
|
|
1282
1355
|
|
|
1356
|
+
/**
|
|
1357
|
+
* @typedef JobDetailsData
|
|
1358
|
+
* @property {string} [batch_id]
|
|
1359
|
+
* @property {string} [company_id]
|
|
1360
|
+
* @property {number} [failed_shipments_count]
|
|
1361
|
+
* @property {number} [processing_shipments_count]
|
|
1362
|
+
* @property {string[]} [successful_shipment_ids]
|
|
1363
|
+
* @property {number} [successful_shipments_count]
|
|
1364
|
+
* @property {number} [total_shipments_count]
|
|
1365
|
+
*/
|
|
1366
|
+
|
|
1367
|
+
/**
|
|
1368
|
+
* @typedef JobDetailsResponse
|
|
1369
|
+
* @property {string} [created_ts]
|
|
1370
|
+
* @property {JobDetailsData[]} [data]
|
|
1371
|
+
* @property {Object[]} [failed_records]
|
|
1372
|
+
* @property {string} [file_url]
|
|
1373
|
+
* @property {string} [message]
|
|
1374
|
+
* @property {string} [status]
|
|
1375
|
+
* @property {boolean} [success]
|
|
1376
|
+
* @property {string} [uploaded_by]
|
|
1377
|
+
* @property {string} [uploaded_on]
|
|
1378
|
+
* @property {string} [user_id]
|
|
1379
|
+
*/
|
|
1380
|
+
|
|
1381
|
+
/**
|
|
1382
|
+
* @typedef JobFailedResponse
|
|
1383
|
+
* @property {string} [file_name]
|
|
1384
|
+
* @property {string} [url]
|
|
1385
|
+
*/
|
|
1386
|
+
|
|
1283
1387
|
/**
|
|
1284
1388
|
* @typedef LaneConfigResponse
|
|
1285
1389
|
* @property {SuperLane[]} [super_lanes]
|
|
@@ -1309,6 +1413,111 @@ const Joi = require("joi");
|
|
|
1309
1413
|
* @property {boolean} [mto]
|
|
1310
1414
|
*/
|
|
1311
1415
|
|
|
1416
|
+
/**
|
|
1417
|
+
* @typedef LogPaymentDetails
|
|
1418
|
+
* @property {string} [amount_paid]
|
|
1419
|
+
* @property {string} [payment_mode]
|
|
1420
|
+
*/
|
|
1421
|
+
|
|
1422
|
+
/**
|
|
1423
|
+
* @typedef LogsChannelDetails
|
|
1424
|
+
* @property {string} [channel_id]
|
|
1425
|
+
* @property {string} [channel_shipment_id]
|
|
1426
|
+
* @property {string} [logo]
|
|
1427
|
+
* @property {string} [name]
|
|
1428
|
+
*/
|
|
1429
|
+
|
|
1430
|
+
/**
|
|
1431
|
+
* @typedef Manifest
|
|
1432
|
+
* @property {number} company_id
|
|
1433
|
+
* @property {string} created_at
|
|
1434
|
+
* @property {string} created_by
|
|
1435
|
+
* @property {string} [created_ts]
|
|
1436
|
+
* @property {Filters} [filters]
|
|
1437
|
+
* @property {number} id
|
|
1438
|
+
* @property {boolean} is_active
|
|
1439
|
+
* @property {string} manifest_id
|
|
1440
|
+
* @property {ManifestMeta} [meta]
|
|
1441
|
+
* @property {PDFMeta} [pdf_meta]
|
|
1442
|
+
* @property {string} status
|
|
1443
|
+
* @property {string} uid
|
|
1444
|
+
* @property {string} user_id
|
|
1445
|
+
*/
|
|
1446
|
+
|
|
1447
|
+
/**
|
|
1448
|
+
* @typedef ManifestDetails
|
|
1449
|
+
* @property {number} [additional_shipment_count]
|
|
1450
|
+
* @property {ManifestItemDetails[]} [items]
|
|
1451
|
+
* @property {Manifest[]} [manifest_details]
|
|
1452
|
+
* @property {ManifestPageInfo} [page]
|
|
1453
|
+
*/
|
|
1454
|
+
|
|
1455
|
+
/**
|
|
1456
|
+
* @typedef ManifestFile
|
|
1457
|
+
* @property {string} [bucket]
|
|
1458
|
+
* @property {string} [key]
|
|
1459
|
+
* @property {string} [region]
|
|
1460
|
+
*/
|
|
1461
|
+
|
|
1462
|
+
/**
|
|
1463
|
+
* @typedef ManifestFiltersResponse
|
|
1464
|
+
* @property {FiltersInfo[]} [advance_filter]
|
|
1465
|
+
* @property {FiltersInfo[]} [global_filter]
|
|
1466
|
+
*/
|
|
1467
|
+
|
|
1468
|
+
/**
|
|
1469
|
+
* @typedef ManifestItemDetails
|
|
1470
|
+
* @property {string} [awb_number]
|
|
1471
|
+
* @property {string} [invoice_id]
|
|
1472
|
+
* @property {string} order_id
|
|
1473
|
+
* @property {number} [quantity]
|
|
1474
|
+
* @property {string} [shipment_created_at]
|
|
1475
|
+
* @property {string} shipment_id
|
|
1476
|
+
*/
|
|
1477
|
+
|
|
1478
|
+
/**
|
|
1479
|
+
* @typedef ManifestList
|
|
1480
|
+
* @property {Manifest[]} [items]
|
|
1481
|
+
* @property {ManifestPageInfo} [page]
|
|
1482
|
+
*/
|
|
1483
|
+
|
|
1484
|
+
/**
|
|
1485
|
+
* @typedef ManifestMediaUpdate
|
|
1486
|
+
* @property {number} [code]
|
|
1487
|
+
* @property {string} [entity]
|
|
1488
|
+
* @property {ManifestFile} [file]
|
|
1489
|
+
* @property {string} [link]
|
|
1490
|
+
* @property {string} [media_type]
|
|
1491
|
+
* @property {boolean} [status]
|
|
1492
|
+
*/
|
|
1493
|
+
|
|
1494
|
+
/**
|
|
1495
|
+
* @typedef ManifestMeta
|
|
1496
|
+
* @property {Filters} [filters]
|
|
1497
|
+
* @property {TotalShipmentPricesCount} [total_shipment_prices_count]
|
|
1498
|
+
*/
|
|
1499
|
+
|
|
1500
|
+
/**
|
|
1501
|
+
* @typedef ManifestPageInfo
|
|
1502
|
+
* @property {number} current
|
|
1503
|
+
* @property {boolean} has_next
|
|
1504
|
+
* @property {boolean} has_previous
|
|
1505
|
+
* @property {number} size
|
|
1506
|
+
* @property {number} total
|
|
1507
|
+
* @property {string} type
|
|
1508
|
+
*/
|
|
1509
|
+
|
|
1510
|
+
/**
|
|
1511
|
+
* @typedef ManifestShipmentListing
|
|
1512
|
+
* @property {ManifestItemDetails[]} [items]
|
|
1513
|
+
* @property {string} [lane]
|
|
1514
|
+
* @property {string} [message]
|
|
1515
|
+
* @property {ManifestPageInfo} page
|
|
1516
|
+
* @property {number} status
|
|
1517
|
+
* @property {boolean} success
|
|
1518
|
+
* @property {number} total_count
|
|
1519
|
+
*/
|
|
1520
|
+
|
|
1312
1521
|
/**
|
|
1313
1522
|
* @typedef MarketPlacePdf
|
|
1314
1523
|
* @property {string} [invoice]
|
|
@@ -1324,7 +1533,7 @@ const Joi = require("joi");
|
|
|
1324
1533
|
/**
|
|
1325
1534
|
* @typedef OrderBagArticle
|
|
1326
1535
|
* @property {Object} [identifiers]
|
|
1327
|
-
* @property {
|
|
1536
|
+
* @property {ReturnConfig} [return_config]
|
|
1328
1537
|
* @property {string} [size]
|
|
1329
1538
|
* @property {string} [uid]
|
|
1330
1539
|
*/
|
|
@@ -1381,6 +1590,7 @@ const Joi = require("joi");
|
|
|
1381
1590
|
|
|
1382
1591
|
/**
|
|
1383
1592
|
* @typedef OrderData
|
|
1593
|
+
* @property {string} [created_ts]
|
|
1384
1594
|
* @property {string} fynd_order_id
|
|
1385
1595
|
* @property {Object} [meta]
|
|
1386
1596
|
* @property {string} order_date
|
|
@@ -1399,6 +1609,7 @@ const Joi = require("joi");
|
|
|
1399
1609
|
* @typedef OrderDetailsData
|
|
1400
1610
|
* @property {string} [affiliate_id]
|
|
1401
1611
|
* @property {string} [cod_charges]
|
|
1612
|
+
* @property {string} [created_ts]
|
|
1402
1613
|
* @property {string} fynd_order_id
|
|
1403
1614
|
* @property {Object} [meta]
|
|
1404
1615
|
* @property {string} [order_date]
|
|
@@ -1435,6 +1646,14 @@ const Joi = require("joi");
|
|
|
1435
1646
|
* @property {UserData} user
|
|
1436
1647
|
*/
|
|
1437
1648
|
|
|
1649
|
+
/**
|
|
1650
|
+
* @typedef OrderingCurrency
|
|
1651
|
+
* @property {string} [currency_code]
|
|
1652
|
+
* @property {string} [currency_name]
|
|
1653
|
+
* @property {string} [currency_sub_unit]
|
|
1654
|
+
* @property {string} [currency_symbol]
|
|
1655
|
+
*/
|
|
1656
|
+
|
|
1438
1657
|
/**
|
|
1439
1658
|
* @typedef OrderingStoreDetails
|
|
1440
1659
|
* @property {string} [address]
|
|
@@ -1465,30 +1684,6 @@ const Joi = require("joi");
|
|
|
1465
1684
|
* @property {number} [total_count]
|
|
1466
1685
|
*/
|
|
1467
1686
|
|
|
1468
|
-
/**
|
|
1469
|
-
* @typedef OrderMeta
|
|
1470
|
-
* @property {BillingStaffDetails} [billing_staff_details]
|
|
1471
|
-
* @property {number} [cart_id]
|
|
1472
|
-
* @property {string} [cart_object_id]
|
|
1473
|
-
* @property {string} [comment]
|
|
1474
|
-
* @property {string} [company_logo]
|
|
1475
|
-
* @property {string} [currency_symbol]
|
|
1476
|
-
* @property {string} [customer_note]
|
|
1477
|
-
* @property {string} [employee_id]
|
|
1478
|
-
* @property {Object} [extra_meta]
|
|
1479
|
-
* @property {Object[]} [files]
|
|
1480
|
-
* @property {number} [mongo_cart_id]
|
|
1481
|
-
* @property {string[]} [order_child_entities]
|
|
1482
|
-
* @property {string} [order_platform]
|
|
1483
|
-
* @property {Object[]} [order_tags]
|
|
1484
|
-
* @property {string} [order_type]
|
|
1485
|
-
* @property {number} [ordering_store]
|
|
1486
|
-
* @property {string} [payment_type]
|
|
1487
|
-
* @property {PlatformUserDetails} [platform_user_details]
|
|
1488
|
-
* @property {Object} [staff]
|
|
1489
|
-
* @property {TransactionData} [transaction_data]
|
|
1490
|
-
*/
|
|
1491
|
-
|
|
1492
1687
|
/**
|
|
1493
1688
|
* @typedef OrderPriority
|
|
1494
1689
|
* @property {string} [affiliate_priority_code]
|
|
@@ -1553,12 +1748,30 @@ const Joi = require("joi");
|
|
|
1553
1748
|
* @typedef PageDetails
|
|
1554
1749
|
* @property {number} [current] - Current page number
|
|
1555
1750
|
* @property {boolean} [has_next] - If next page contains any result
|
|
1751
|
+
* @property {boolean} [has_previous] - If previous page contains any result
|
|
1556
1752
|
* @property {number} item_total - Total count of the results present in the
|
|
1557
1753
|
* requested filter
|
|
1558
1754
|
* @property {number} [size] - Page size
|
|
1559
1755
|
* @property {string} [type] - Type of the page
|
|
1560
1756
|
*/
|
|
1561
1757
|
|
|
1758
|
+
/**
|
|
1759
|
+
* @typedef PaginatedStates
|
|
1760
|
+
* @property {StateManagerState[]} [items]
|
|
1761
|
+
* @property {PaginationInfo} [page]
|
|
1762
|
+
*/
|
|
1763
|
+
|
|
1764
|
+
/**
|
|
1765
|
+
* @typedef PaginationInfo
|
|
1766
|
+
* @property {number} [current]
|
|
1767
|
+
* @property {boolean} [has_next]
|
|
1768
|
+
* @property {boolean} [has_previous]
|
|
1769
|
+
* @property {number} [item_total]
|
|
1770
|
+
* @property {number} [size]
|
|
1771
|
+
* @property {number} [total]
|
|
1772
|
+
* @property {string} [type]
|
|
1773
|
+
*/
|
|
1774
|
+
|
|
1562
1775
|
/**
|
|
1563
1776
|
* @typedef PaymentInfo
|
|
1564
1777
|
* @property {PaymentMethod[]} [payment_methods]
|
|
@@ -1603,6 +1816,12 @@ const Joi = require("joi");
|
|
|
1603
1816
|
* @property {string} [po_invoice]
|
|
1604
1817
|
*/
|
|
1605
1818
|
|
|
1819
|
+
/**
|
|
1820
|
+
* @typedef PDFMeta
|
|
1821
|
+
* @property {string} [consent]
|
|
1822
|
+
* @property {ManifestMediaUpdate[]} [media_updates]
|
|
1823
|
+
*/
|
|
1824
|
+
|
|
1606
1825
|
/**
|
|
1607
1826
|
* @typedef PhoneDetails
|
|
1608
1827
|
* @property {number} [country_code]
|
|
@@ -1678,8 +1897,11 @@ const Joi = require("joi");
|
|
|
1678
1897
|
* @typedef PlatformOrderItems
|
|
1679
1898
|
* @property {PlatformBreakupValues[]} [breakup_values]
|
|
1680
1899
|
* @property {PlatformChannel} [channel]
|
|
1900
|
+
* @property {Currency} [currency]
|
|
1901
|
+
* @property {CurrencyInfo} [currency_info]
|
|
1681
1902
|
* @property {Object} [meta]
|
|
1682
1903
|
* @property {string} [order_created_time]
|
|
1904
|
+
* @property {string} [order_created_ts]
|
|
1683
1905
|
* @property {string} [order_id]
|
|
1684
1906
|
* @property {number} [order_value]
|
|
1685
1907
|
* @property {string} [payment_mode]
|
|
@@ -1703,6 +1925,8 @@ const Joi = require("joi");
|
|
|
1703
1925
|
* @property {CompanyDetails} [company_details]
|
|
1704
1926
|
* @property {Object} [coupon]
|
|
1705
1927
|
* @property {string} [credit_note_id]
|
|
1928
|
+
* @property {Currency} [currency]
|
|
1929
|
+
* @property {CurrencyInfo} [currency_info]
|
|
1706
1930
|
* @property {string} [custom_message]
|
|
1707
1931
|
* @property {Object[]} [custom_meta]
|
|
1708
1932
|
* @property {UserDetailsData} [delivery_details]
|
|
@@ -1711,6 +1935,7 @@ const Joi = require("joi");
|
|
|
1711
1935
|
* @property {DPDetailsData} [dp_details]
|
|
1712
1936
|
* @property {boolean} [enable_dp_tracking]
|
|
1713
1937
|
* @property {string} [estimated_sla_time]
|
|
1938
|
+
* @property {string} [estimated_sla_ts]
|
|
1714
1939
|
* @property {string} [forward_shipment_id]
|
|
1715
1940
|
* @property {FulfillingStore} [fulfilling_store]
|
|
1716
1941
|
* @property {number} [fulfilment_priority]
|
|
@@ -1738,7 +1963,8 @@ const Joi = require("joi");
|
|
|
1738
1963
|
* @property {string} [priority_text]
|
|
1739
1964
|
* @property {PlatformDeliveryAddress} [rto_address]
|
|
1740
1965
|
* @property {string} [shipment_created_at]
|
|
1741
|
-
* @property {
|
|
1966
|
+
* @property {string} [shipment_created_ts]
|
|
1967
|
+
* @property {ShipmentLockDetails} [shipment_details]
|
|
1742
1968
|
* @property {string} shipment_id
|
|
1743
1969
|
* @property {string[]} [shipment_images]
|
|
1744
1970
|
* @property {number} [shipment_quantity]
|
|
@@ -1779,14 +2005,6 @@ const Joi = require("joi");
|
|
|
1779
2005
|
* @property {string} [updated_time]
|
|
1780
2006
|
*/
|
|
1781
2007
|
|
|
1782
|
-
/**
|
|
1783
|
-
* @typedef PlatformUserDetails
|
|
1784
|
-
* @property {string} [platform_user_employee_code]
|
|
1785
|
-
* @property {string} [platform_user_first_name]
|
|
1786
|
-
* @property {string} [platform_user_id]
|
|
1787
|
-
* @property {string} [platform_user_last_name]
|
|
1788
|
-
*/
|
|
1789
|
-
|
|
1790
2008
|
/**
|
|
1791
2009
|
* @typedef PointBlankOtpData
|
|
1792
2010
|
* @property {string} [message]
|
|
@@ -1859,6 +2077,30 @@ const Joi = require("joi");
|
|
|
1859
2077
|
* @property {string} [pack_by_date]
|
|
1860
2078
|
*/
|
|
1861
2079
|
|
|
2080
|
+
/**
|
|
2081
|
+
* @typedef ProcessManifest
|
|
2082
|
+
* @property {string} action
|
|
2083
|
+
* @property {FiltersRequest} filters
|
|
2084
|
+
* @property {string} [manifest_id]
|
|
2085
|
+
* @property {string} unique_id
|
|
2086
|
+
*/
|
|
2087
|
+
|
|
2088
|
+
/**
|
|
2089
|
+
* @typedef ProcessManifestItemResponse
|
|
2090
|
+
* @property {ProcessManifestResponse} [items]
|
|
2091
|
+
*/
|
|
2092
|
+
|
|
2093
|
+
/**
|
|
2094
|
+
* @typedef ProcessManifestResponse
|
|
2095
|
+
* @property {string} [action]
|
|
2096
|
+
* @property {number} [company_id]
|
|
2097
|
+
* @property {string} [created_by]
|
|
2098
|
+
* @property {Filters} [filters]
|
|
2099
|
+
* @property {string} [manifest_id]
|
|
2100
|
+
* @property {string} [uid]
|
|
2101
|
+
* @property {string} [user_id]
|
|
2102
|
+
*/
|
|
2103
|
+
|
|
1862
2104
|
/**
|
|
1863
2105
|
* @typedef Products
|
|
1864
2106
|
* @property {string} [identifier] - Product/Bag Article/Item Identifier
|
|
@@ -1969,13 +2211,6 @@ const Joi = require("joi");
|
|
|
1969
2211
|
* @property {string} [unit]
|
|
1970
2212
|
*/
|
|
1971
2213
|
|
|
1972
|
-
/**
|
|
1973
|
-
* @typedef ReturnConfig1
|
|
1974
|
-
* @property {boolean} [returnable]
|
|
1975
|
-
* @property {number} [time]
|
|
1976
|
-
* @property {string} [unit]
|
|
1977
|
-
*/
|
|
1978
|
-
|
|
1979
2214
|
/**
|
|
1980
2215
|
* @typedef RoleBaseStateTransitionMapping
|
|
1981
2216
|
* @property {string[]} [next_statuses]
|
|
@@ -2013,6 +2248,19 @@ const Joi = require("joi");
|
|
|
2013
2248
|
* @property {ProcessingDates} [processing_dates]
|
|
2014
2249
|
*/
|
|
2015
2250
|
|
|
2251
|
+
/**
|
|
2252
|
+
* @typedef ShipmentActionInfo
|
|
2253
|
+
* @property {Object} [failed_invoiced_shipments]
|
|
2254
|
+
* @property {Object[]} [failed_shipments]
|
|
2255
|
+
* @property {string[]} [invoice]
|
|
2256
|
+
* @property {string[]} [invoiceable_shipments]
|
|
2257
|
+
* @property {string[]} [label]
|
|
2258
|
+
* @property {string[]} [processing_invoice_shipments]
|
|
2259
|
+
* @property {string[]} [processing_shipments]
|
|
2260
|
+
* @property {string[]} [successful_invoiced_shipments]
|
|
2261
|
+
* @property {string[]} [successful_shipments]
|
|
2262
|
+
*/
|
|
2263
|
+
|
|
2016
2264
|
/**
|
|
2017
2265
|
* @typedef ShipmentBagReasons
|
|
2018
2266
|
* @property {BagReasons[]} [reasons]
|
|
@@ -2048,14 +2296,11 @@ const Joi = require("joi");
|
|
|
2048
2296
|
|
|
2049
2297
|
/**
|
|
2050
2298
|
* @typedef ShipmentDetails
|
|
2051
|
-
* @property {Object} [action_to_status]
|
|
2052
2299
|
* @property {string} affiliate_shipment_id
|
|
2053
2300
|
* @property {ArticleDetails[]} articles
|
|
2054
2301
|
* @property {string} [box_type]
|
|
2055
2302
|
* @property {number} [dp_id]
|
|
2056
2303
|
* @property {number} fulfillment_id
|
|
2057
|
-
* @property {string} [lock_message]
|
|
2058
|
-
* @property {boolean} [lock_status]
|
|
2059
2304
|
* @property {Object} [meta]
|
|
2060
2305
|
* @property {number} shipments
|
|
2061
2306
|
*/
|
|
@@ -2088,15 +2333,19 @@ const Joi = require("joi");
|
|
|
2088
2333
|
* @property {BagUnit[]} [bags]
|
|
2089
2334
|
* @property {boolean} [can_process]
|
|
2090
2335
|
* @property {ShipmentListingChannel} [channel]
|
|
2336
|
+
* @property {Currency} [currency]
|
|
2337
|
+
* @property {CurrencyInfo} [currency_info]
|
|
2091
2338
|
* @property {string} [customer_note]
|
|
2092
2339
|
* @property {PlatformDeliveryAddress} [delivery_address]
|
|
2093
2340
|
* @property {string} [display_name]
|
|
2094
2341
|
* @property {string} [estimated_sla_time]
|
|
2342
|
+
* @property {string} [estimated_sla_ts]
|
|
2095
2343
|
* @property {ShipmentItemFulFillingStore} [fulfilling_store]
|
|
2096
2344
|
* @property {string} [invoice_id]
|
|
2097
2345
|
* @property {boolean} [lock_status]
|
|
2098
2346
|
* @property {Object} [meta]
|
|
2099
2347
|
* @property {string} [mode_of_payment]
|
|
2348
|
+
* @property {string} [order_created_ts]
|
|
2100
2349
|
* @property {string} [order_date]
|
|
2101
2350
|
* @property {string} order_id
|
|
2102
2351
|
* @property {string} [ordering_channnel]
|
|
@@ -2105,9 +2354,11 @@ const Joi = require("joi");
|
|
|
2105
2354
|
* @property {string} [previous_shipment_id]
|
|
2106
2355
|
* @property {Prices} [prices]
|
|
2107
2356
|
* @property {string} shipment_created_at
|
|
2357
|
+
* @property {string} [shipment_created_ts]
|
|
2108
2358
|
* @property {string} [shipment_id]
|
|
2109
2359
|
* @property {ShipmentStatus} [shipment_status]
|
|
2110
2360
|
* @property {string} [status_created_at]
|
|
2361
|
+
* @property {string} [status_created_ts]
|
|
2111
2362
|
* @property {number} total_bags
|
|
2112
2363
|
* @property {UserDataInfo} [user]
|
|
2113
2364
|
*/
|
|
@@ -2115,7 +2366,7 @@ const Joi = require("joi");
|
|
|
2115
2366
|
/**
|
|
2116
2367
|
* @typedef ShipmentItemFulFillingStore
|
|
2117
2368
|
* @property {string} [address]
|
|
2118
|
-
* @property {string} [brand_store_tags]
|
|
2369
|
+
* @property {string[]} [brand_store_tags]
|
|
2119
2370
|
* @property {string} [city]
|
|
2120
2371
|
* @property {string} code
|
|
2121
2372
|
* @property {number} id
|
|
@@ -2126,40 +2377,7 @@ const Joi = require("joi");
|
|
|
2126
2377
|
* @property {string} [pincode]
|
|
2127
2378
|
* @property {string} [state]
|
|
2128
2379
|
* @property {string} [store_email]
|
|
2129
|
-
|
|
2130
|
-
|
|
2131
|
-
/**
|
|
2132
|
-
* @typedef ShipmentItemMeta
|
|
2133
|
-
* @property {string} [activity_comment]
|
|
2134
|
-
* @property {boolean} [assign_dp_from_sb]
|
|
2135
|
-
* @property {boolean} auto_trigger_dp_assignment_acf
|
|
2136
|
-
* @property {Object} [bag_weight]
|
|
2137
|
-
* @property {Object} [debug_info]
|
|
2138
|
-
* @property {Object} [dp_options]
|
|
2139
|
-
* @property {string} [dp_sort_key]
|
|
2140
|
-
* @property {Object} [ewaybill_info]
|
|
2141
|
-
* @property {string[]} [existing_dp_list]
|
|
2142
|
-
* @property {Object} [external]
|
|
2143
|
-
* @property {Formatted} [formatted]
|
|
2144
|
-
* @property {string} [fulfilment_priority_text]
|
|
2145
|
-
* @property {boolean} [is_international]
|
|
2146
|
-
* @property {boolean} [is_self_ship]
|
|
2147
|
-
* @property {LockData} [lock_data]
|
|
2148
|
-
* @property {string} [order_type]
|
|
2149
|
-
* @property {string} [packaging_name]
|
|
2150
|
-
* @property {string} [parent_dp_id]
|
|
2151
|
-
* @property {Object[]} [pdf_media]
|
|
2152
|
-
* @property {boolean} [same_store_available]
|
|
2153
|
-
* @property {number} [shipment_chargeable_weight]
|
|
2154
|
-
* @property {ShipmentTags[]} [shipment_tags]
|
|
2155
|
-
* @property {number} [shipment_volumetric_weight]
|
|
2156
|
-
* @property {number} [shipment_weight]
|
|
2157
|
-
* @property {string} [shipping_zone]
|
|
2158
|
-
* @property {number} [sla]
|
|
2159
|
-
* @property {string} [store_invoice_updated_date]
|
|
2160
|
-
* @property {Object[]} [tags]
|
|
2161
|
-
* @property {ShipmentTimeStamp} [timestamp]
|
|
2162
|
-
* @property {number} [weight]
|
|
2380
|
+
* @property {string[]} [tags]
|
|
2163
2381
|
*/
|
|
2164
2382
|
|
|
2165
2383
|
/**
|
|
@@ -2178,6 +2396,13 @@ const Joi = require("joi");
|
|
|
2178
2396
|
* @property {string} [name]
|
|
2179
2397
|
*/
|
|
2180
2398
|
|
|
2399
|
+
/**
|
|
2400
|
+
* @typedef ShipmentLockDetails
|
|
2401
|
+
* @property {Object} [action_to_status]
|
|
2402
|
+
* @property {string} [lock_message]
|
|
2403
|
+
* @property {boolean} [lock_status]
|
|
2404
|
+
*/
|
|
2405
|
+
|
|
2181
2406
|
/**
|
|
2182
2407
|
* @typedef ShipmentMeta
|
|
2183
2408
|
* @property {boolean} [assign_dp_from_sb]
|
|
@@ -2269,12 +2494,14 @@ const Joi = require("joi");
|
|
|
2269
2494
|
* @typedef ShipmentStatus
|
|
2270
2495
|
* @property {string[]} [bag_list]
|
|
2271
2496
|
* @property {string} [created_at]
|
|
2497
|
+
* @property {string} [created_ts]
|
|
2272
2498
|
* @property {string} [current_shipment_status]
|
|
2273
2499
|
* @property {Object} [meta]
|
|
2274
2500
|
* @property {string} [shipment_id]
|
|
2275
2501
|
* @property {number} [shipment_status_id]
|
|
2276
2502
|
* @property {string} status
|
|
2277
2503
|
* @property {string} [status_created_at]
|
|
2504
|
+
* @property {string} [status_created_ts]
|
|
2278
2505
|
* @property {string} title
|
|
2279
2506
|
*/
|
|
2280
2507
|
|
|
@@ -2282,6 +2509,7 @@ const Joi = require("joi");
|
|
|
2282
2509
|
* @typedef ShipmentStatusData
|
|
2283
2510
|
* @property {string[]} [bag_list]
|
|
2284
2511
|
* @property {string} [created_at]
|
|
2512
|
+
* @property {string} [created_ts]
|
|
2285
2513
|
* @property {string} [current_shipment_status]
|
|
2286
2514
|
* @property {string} [display_name]
|
|
2287
2515
|
* @property {number} [id]
|
|
@@ -2305,17 +2533,18 @@ const Joi = require("joi");
|
|
|
2305
2533
|
|
|
2306
2534
|
/**
|
|
2307
2535
|
* @typedef ShippingInfo
|
|
2536
|
+
* @property {string} [address]
|
|
2308
2537
|
* @property {string} [address_type]
|
|
2309
|
-
* @property {string} address1
|
|
2538
|
+
* @property {string} [address1]
|
|
2310
2539
|
* @property {string} [address2]
|
|
2311
2540
|
* @property {string} [alternate_email]
|
|
2312
2541
|
* @property {string} [alternate_mobile_number]
|
|
2313
|
-
* @property {string} city
|
|
2314
|
-
* @property {string} country
|
|
2542
|
+
* @property {string} [city]
|
|
2543
|
+
* @property {string} [country]
|
|
2315
2544
|
* @property {string} [country_code]
|
|
2316
2545
|
* @property {string} [customer_code]
|
|
2317
2546
|
* @property {string} [external_customer_code]
|
|
2318
|
-
* @property {string} first_name
|
|
2547
|
+
* @property {string} [first_name]
|
|
2319
2548
|
* @property {string} [floor_no]
|
|
2320
2549
|
* @property {string} [gender]
|
|
2321
2550
|
* @property {Object} [geo_location]
|
|
@@ -2323,12 +2552,12 @@ const Joi = require("joi");
|
|
|
2323
2552
|
* @property {string} [landmark]
|
|
2324
2553
|
* @property {string} [last_name]
|
|
2325
2554
|
* @property {string} [middle_name]
|
|
2326
|
-
* @property {string} pincode
|
|
2327
|
-
* @property {string} primary_email
|
|
2328
|
-
* @property {string} primary_mobile_number
|
|
2555
|
+
* @property {string} [pincode]
|
|
2556
|
+
* @property {string} [primary_email]
|
|
2557
|
+
* @property {string} [primary_mobile_number]
|
|
2329
2558
|
* @property {string} [shipping_type]
|
|
2330
2559
|
* @property {Object[]} [slot]
|
|
2331
|
-
* @property {string} state
|
|
2560
|
+
* @property {string} [state]
|
|
2332
2561
|
* @property {string} [state_code]
|
|
2333
2562
|
* @property {string} [title]
|
|
2334
2563
|
*/
|
|
@@ -2347,6 +2576,50 @@ const Joi = require("joi");
|
|
|
2347
2576
|
* @property {number} shipment_id - ShipmentId
|
|
2348
2577
|
*/
|
|
2349
2578
|
|
|
2579
|
+
/**
|
|
2580
|
+
* @typedef StateManagerFilter
|
|
2581
|
+
* @property {string} [default_value]
|
|
2582
|
+
* @property {string} [description]
|
|
2583
|
+
* @property {string} [display_name]
|
|
2584
|
+
* @property {number} [id]
|
|
2585
|
+
* @property {string} [name]
|
|
2586
|
+
* @property {Object} [options]
|
|
2587
|
+
* @property {string} [type]
|
|
2588
|
+
*/
|
|
2589
|
+
|
|
2590
|
+
/**
|
|
2591
|
+
* @typedef StateManagerState
|
|
2592
|
+
* @property {string} [app_display_name] - The application display name
|
|
2593
|
+
* @property {boolean} [app_facing] - Whether state is for app facing or not
|
|
2594
|
+
* @property {number} [id] - Unique identifier for the state
|
|
2595
|
+
* @property {boolean} [is_active] - Whether state is active or not
|
|
2596
|
+
* @property {string} [journey_type] - Type of the journey
|
|
2597
|
+
* @property {string} [platform_display_name] - The platform display name
|
|
2598
|
+
* @property {string} [state] - The name of the state
|
|
2599
|
+
* @property {string} [state_type] - Type of the state
|
|
2600
|
+
*/
|
|
2601
|
+
|
|
2602
|
+
/**
|
|
2603
|
+
* @typedef StateManagerTask
|
|
2604
|
+
* @property {string} [description]
|
|
2605
|
+
* @property {string} [display_name]
|
|
2606
|
+
* @property {string} [doc_string]
|
|
2607
|
+
* @property {number} [id]
|
|
2608
|
+
* @property {Object} [kwargs]
|
|
2609
|
+
* @property {string} [name]
|
|
2610
|
+
*/
|
|
2611
|
+
|
|
2612
|
+
/**
|
|
2613
|
+
* @typedef StateTransitionFlag
|
|
2614
|
+
* @property {string} [default_value]
|
|
2615
|
+
* @property {string} [description]
|
|
2616
|
+
* @property {string} [display_name]
|
|
2617
|
+
* @property {number} [id]
|
|
2618
|
+
* @property {string} [name]
|
|
2619
|
+
* @property {Object} [options]
|
|
2620
|
+
* @property {string} [type]
|
|
2621
|
+
*/
|
|
2622
|
+
|
|
2350
2623
|
/**
|
|
2351
2624
|
* @typedef StatuesRequest
|
|
2352
2625
|
* @property {string} [exclude_bags_next_state] - State to be change for
|
|
@@ -2520,14 +2793,33 @@ const Joi = require("joi");
|
|
|
2520
2793
|
*/
|
|
2521
2794
|
|
|
2522
2795
|
/**
|
|
2523
|
-
* @typedef TaxInfo
|
|
2524
|
-
* @property {string} [b2b_gstin_number]
|
|
2525
|
-
* @property {string} [gstin]
|
|
2526
|
-
* @property {string} [pan_no]
|
|
2796
|
+
* @typedef TaxInfo
|
|
2797
|
+
* @property {string} [b2b_gstin_number]
|
|
2798
|
+
* @property {string} [gstin]
|
|
2799
|
+
* @property {string} [pan_no]
|
|
2800
|
+
*/
|
|
2801
|
+
|
|
2802
|
+
/**
|
|
2803
|
+
* @typedef TemplateDownloadResponse
|
|
2804
|
+
* @property {string} [file_name]
|
|
2805
|
+
* @property {string} [url]
|
|
2806
|
+
*/
|
|
2807
|
+
|
|
2808
|
+
/**
|
|
2809
|
+
* @typedef Templates
|
|
2810
|
+
* @property {string} [text]
|
|
2811
|
+
* @property {string} [value]
|
|
2812
|
+
*/
|
|
2813
|
+
|
|
2814
|
+
/**
|
|
2815
|
+
* @typedef TotalShipmentPricesCount
|
|
2816
|
+
* @property {number} [shipment_count]
|
|
2817
|
+
* @property {number} [total_price]
|
|
2527
2818
|
*/
|
|
2528
2819
|
|
|
2529
2820
|
/**
|
|
2530
2821
|
* @typedef TrackingList
|
|
2822
|
+
* @property {string} [created_ts]
|
|
2531
2823
|
* @property {boolean} [is_current]
|
|
2532
2824
|
* @property {boolean} [is_passed]
|
|
2533
2825
|
* @property {string} status
|
|
@@ -2535,18 +2827,6 @@ const Joi = require("joi");
|
|
|
2535
2827
|
* @property {string} [time]
|
|
2536
2828
|
*/
|
|
2537
2829
|
|
|
2538
|
-
/**
|
|
2539
|
-
* @typedef TransactionData
|
|
2540
|
-
* @property {number} [amount_paid]
|
|
2541
|
-
* @property {string} [currency]
|
|
2542
|
-
* @property {string} [entity]
|
|
2543
|
-
* @property {string} [payment_id]
|
|
2544
|
-
* @property {string} [status]
|
|
2545
|
-
* @property {string} [terminal_id]
|
|
2546
|
-
* @property {string} [transaction_id]
|
|
2547
|
-
* @property {string} [unique_reference_number]
|
|
2548
|
-
*/
|
|
2549
|
-
|
|
2550
2830
|
/**
|
|
2551
2831
|
* @typedef UpdatePackagingDimensionsPayload
|
|
2552
2832
|
* @property {string} current_status
|
|
@@ -2630,12 +2910,15 @@ const Joi = require("joi");
|
|
|
2630
2910
|
* @property {string} [area]
|
|
2631
2911
|
* @property {string} city
|
|
2632
2912
|
* @property {string} country
|
|
2913
|
+
* @property {string} [country_iso_code]
|
|
2914
|
+
* @property {string} [country_phone_code]
|
|
2633
2915
|
* @property {string} [email]
|
|
2634
2916
|
* @property {string} [landmark]
|
|
2635
2917
|
* @property {string} name
|
|
2636
2918
|
* @property {string} phone
|
|
2637
2919
|
* @property {string} pincode
|
|
2638
2920
|
* @property {string} state
|
|
2921
|
+
* @property {string} [state_code]
|
|
2639
2922
|
*/
|
|
2640
2923
|
|
|
2641
2924
|
/**
|
|
@@ -2893,6 +3176,13 @@ class OrderPlatformModel {
|
|
|
2893
3176
|
});
|
|
2894
3177
|
}
|
|
2895
3178
|
|
|
3179
|
+
/** @returns {AllowedTemplatesResponse} */
|
|
3180
|
+
static AllowedTemplatesResponse() {
|
|
3181
|
+
return Joi.object({
|
|
3182
|
+
template_x_slug: Joi.array().items(OrderPlatformModel.Templates()),
|
|
3183
|
+
});
|
|
3184
|
+
}
|
|
3185
|
+
|
|
2896
3186
|
/** @returns {AnnouncementResponse} */
|
|
2897
3187
|
static AnnouncementResponse() {
|
|
2898
3188
|
return Joi.object({
|
|
@@ -2964,11 +3254,17 @@ class OrderPlatformModel {
|
|
|
2964
3254
|
category: Joi.any().required(),
|
|
2965
3255
|
dimension: Joi.any().required(),
|
|
2966
3256
|
quantity: Joi.number().required(),
|
|
2967
|
-
status: Joi.any().allow(null),
|
|
2968
3257
|
weight: Joi.any().required(),
|
|
2969
3258
|
});
|
|
2970
3259
|
}
|
|
2971
3260
|
|
|
3261
|
+
/** @returns {ArticleStatusDetails} */
|
|
3262
|
+
static ArticleStatusDetails() {
|
|
3263
|
+
return Joi.object({
|
|
3264
|
+
status: Joi.any().allow(null),
|
|
3265
|
+
});
|
|
3266
|
+
}
|
|
3267
|
+
|
|
2972
3268
|
/** @returns {AttachOrderUser} */
|
|
2973
3269
|
static AttachOrderUser() {
|
|
2974
3270
|
return Joi.object({
|
|
@@ -3018,18 +3314,6 @@ class OrderPlatformModel {
|
|
|
3018
3314
|
});
|
|
3019
3315
|
}
|
|
3020
3316
|
|
|
3021
|
-
/** @returns {B2BPODetails} */
|
|
3022
|
-
static B2BPODetails() {
|
|
3023
|
-
return Joi.object({
|
|
3024
|
-
docker_number: Joi.string().allow("").allow(null),
|
|
3025
|
-
item_base_price: Joi.number().allow(null),
|
|
3026
|
-
partial_can_ret: Joi.boolean().allow(null),
|
|
3027
|
-
po_line_amount: Joi.number().allow(null),
|
|
3028
|
-
po_tax_amount: Joi.number().allow(null),
|
|
3029
|
-
total_gst_percentage: Joi.number().allow(null),
|
|
3030
|
-
});
|
|
3031
|
-
}
|
|
3032
|
-
|
|
3033
3317
|
/** @returns {BagConfigs} */
|
|
3034
3318
|
static BagConfigs() {
|
|
3035
3319
|
return Joi.object({
|
|
@@ -3049,7 +3333,7 @@ class OrderPlatformModel {
|
|
|
3049
3333
|
affiliate_details: OrderPlatformModel.AffiliateDetails(),
|
|
3050
3334
|
applied_promos: Joi.array().items(Joi.any()),
|
|
3051
3335
|
article: OrderPlatformModel.Article(),
|
|
3052
|
-
article_details: OrderPlatformModel.
|
|
3336
|
+
article_details: OrderPlatformModel.ArticleStatusDetails(),
|
|
3053
3337
|
bag_status: Joi.array().items(OrderPlatformModel.BagStatusHistory()),
|
|
3054
3338
|
bag_status_history: OrderPlatformModel.BagStatusHistory(),
|
|
3055
3339
|
bag_update_time: Joi.number().allow(null),
|
|
@@ -3083,70 +3367,12 @@ class OrderPlatformModel {
|
|
|
3083
3367
|
restore_promos: Joi.any().allow(null),
|
|
3084
3368
|
seller_identifier: Joi.string().allow("").allow(null),
|
|
3085
3369
|
shipment_id: Joi.string().allow("").allow(null),
|
|
3086
|
-
status: OrderPlatformModel.
|
|
3370
|
+
status: OrderPlatformModel.BagReturnableCancelableStatus(),
|
|
3087
3371
|
tags: Joi.array().items(Joi.string().allow("")),
|
|
3088
3372
|
type: Joi.string().allow("").allow(null),
|
|
3089
3373
|
});
|
|
3090
3374
|
}
|
|
3091
3375
|
|
|
3092
|
-
/** @returns {BagGST} */
|
|
3093
|
-
static BagGST() {
|
|
3094
|
-
return Joi.object({
|
|
3095
|
-
brand_calculated_amount: Joi.number().allow(null),
|
|
3096
|
-
cgst_gst_fee: Joi.string().allow("").allow(null),
|
|
3097
|
-
cgst_tax_percentage: Joi.number().allow(null),
|
|
3098
|
-
gst_fee: Joi.number().allow(null),
|
|
3099
|
-
gst_tag: Joi.string().allow("").allow(null),
|
|
3100
|
-
gst_tax_percentage: Joi.number().allow(null),
|
|
3101
|
-
gstin_code: Joi.string().allow("").allow(null),
|
|
3102
|
-
hsn_code: Joi.string().allow("").allow(null),
|
|
3103
|
-
hsn_code_id: Joi.string().allow("").allow(null),
|
|
3104
|
-
igst_gst_fee: Joi.string().allow("").allow(null),
|
|
3105
|
-
igst_tax_percentage: Joi.number().allow(null),
|
|
3106
|
-
is_default_hsn_code: Joi.boolean().allow(null),
|
|
3107
|
-
sgst_gst_fee: Joi.string().allow("").allow(null),
|
|
3108
|
-
sgst_tax_percentage: Joi.number().allow(null),
|
|
3109
|
-
tax_collected_at_source: Joi.number().allow(null),
|
|
3110
|
-
value_of_good: Joi.number().allow(null),
|
|
3111
|
-
});
|
|
3112
|
-
}
|
|
3113
|
-
|
|
3114
|
-
/** @returns {BagGSTDetails} */
|
|
3115
|
-
static BagGSTDetails() {
|
|
3116
|
-
return Joi.object({
|
|
3117
|
-
brand_calculated_amount: Joi.number().required(),
|
|
3118
|
-
cgst_gst_fee: Joi.string().allow("").required(),
|
|
3119
|
-
cgst_tax_percentage: Joi.number().required(),
|
|
3120
|
-
gst_fee: Joi.number().required(),
|
|
3121
|
-
gst_tag: Joi.string().allow("").required(),
|
|
3122
|
-
gst_tax_percentage: Joi.number().required(),
|
|
3123
|
-
gstin_code: Joi.string().allow("").allow(null),
|
|
3124
|
-
hsn_code: Joi.string().allow("").required(),
|
|
3125
|
-
hsn_code_id: Joi.string().allow("").required(),
|
|
3126
|
-
igst_gst_fee: Joi.string().allow("").required(),
|
|
3127
|
-
igst_tax_percentage: Joi.number().required(),
|
|
3128
|
-
is_default_hsn_code: Joi.boolean().allow(null),
|
|
3129
|
-
sgst_gst_fee: Joi.string().allow("").required(),
|
|
3130
|
-
sgst_tax_percentage: Joi.number().required(),
|
|
3131
|
-
tax_collected_at_source: Joi.number().required(),
|
|
3132
|
-
value_of_good: Joi.number().required(),
|
|
3133
|
-
});
|
|
3134
|
-
}
|
|
3135
|
-
|
|
3136
|
-
/** @returns {BagMeta} */
|
|
3137
|
-
static BagMeta() {
|
|
3138
|
-
return Joi.object({
|
|
3139
|
-
b2b_po_details: OrderPlatformModel.B2BPODetails(),
|
|
3140
|
-
custom_json: Joi.any().allow(null),
|
|
3141
|
-
custom_message: Joi.string().allow("").allow(null),
|
|
3142
|
-
docket_number: Joi.string().allow("").allow(null),
|
|
3143
|
-
extra_meta: Joi.any().allow(null),
|
|
3144
|
-
gift_card: OrderPlatformModel.GiftCard(),
|
|
3145
|
-
group_id: Joi.string().allow("").allow(null),
|
|
3146
|
-
partial_can_ret: Joi.boolean().allow(null),
|
|
3147
|
-
});
|
|
3148
|
-
}
|
|
3149
|
-
|
|
3150
3376
|
/** @returns {BagPaymentMethods} */
|
|
3151
3377
|
static BagPaymentMethods() {
|
|
3152
3378
|
return Joi.object({
|
|
@@ -3185,17 +3411,6 @@ class OrderPlatformModel {
|
|
|
3185
3411
|
});
|
|
3186
3412
|
}
|
|
3187
3413
|
|
|
3188
|
-
/** @returns {BagReturnableCancelableStatus1} */
|
|
3189
|
-
static BagReturnableCancelableStatus1() {
|
|
3190
|
-
return Joi.object({
|
|
3191
|
-
can_be_cancelled: Joi.boolean().required(),
|
|
3192
|
-
enable_tracking: Joi.boolean().required(),
|
|
3193
|
-
is_active: Joi.boolean().required(),
|
|
3194
|
-
is_customer_return_allowed: Joi.boolean().required(),
|
|
3195
|
-
is_returnable: Joi.boolean().required(),
|
|
3196
|
-
});
|
|
3197
|
-
}
|
|
3198
|
-
|
|
3199
3414
|
/** @returns {Bags} */
|
|
3200
3415
|
static Bags() {
|
|
3201
3416
|
return Joi.object({
|
|
@@ -3249,6 +3464,7 @@ class OrderPlatformModel {
|
|
|
3249
3464
|
bag_state_mapper: OrderPlatformModel.BagStateMapper(),
|
|
3250
3465
|
bsh_id: Joi.number().allow(null),
|
|
3251
3466
|
created_at: Joi.string().allow("").allow(null),
|
|
3467
|
+
created_ts: Joi.string().allow("").allow(null),
|
|
3252
3468
|
delivery_awb_number: Joi.string().allow("").allow(null),
|
|
3253
3469
|
delivery_partner_id: Joi.number().allow(null),
|
|
3254
3470
|
display_name: Joi.string().allow("").allow(null),
|
|
@@ -3261,6 +3477,7 @@ class OrderPlatformModel {
|
|
|
3261
3477
|
status: Joi.string().allow("").required(),
|
|
3262
3478
|
store_id: Joi.number().allow(null),
|
|
3263
3479
|
updated_at: Joi.string().allow("").allow(null),
|
|
3480
|
+
updated_ts: Joi.string().allow("").allow(null),
|
|
3264
3481
|
});
|
|
3265
3482
|
}
|
|
3266
3483
|
|
|
@@ -3307,41 +3524,31 @@ class OrderPlatformModel {
|
|
|
3307
3524
|
/** @returns {BillingInfo} */
|
|
3308
3525
|
static BillingInfo() {
|
|
3309
3526
|
return Joi.object({
|
|
3310
|
-
|
|
3527
|
+
address: Joi.string().allow(""),
|
|
3528
|
+
address1: Joi.string().allow(""),
|
|
3311
3529
|
address2: Joi.string().allow(""),
|
|
3312
3530
|
alternate_email: Joi.string().allow(""),
|
|
3313
3531
|
alternate_mobile_number: Joi.string().allow(""),
|
|
3314
|
-
city: Joi.string().allow("")
|
|
3315
|
-
country: Joi.string().allow("")
|
|
3532
|
+
city: Joi.string().allow(""),
|
|
3533
|
+
country: Joi.string().allow(""),
|
|
3316
3534
|
country_code: Joi.string().allow(""),
|
|
3317
3535
|
customer_code: Joi.string().allow(""),
|
|
3318
3536
|
external_customer_code: Joi.string().allow(""),
|
|
3319
|
-
first_name: Joi.string().allow("")
|
|
3537
|
+
first_name: Joi.string().allow(""),
|
|
3320
3538
|
floor_no: Joi.string().allow(""),
|
|
3321
3539
|
gender: Joi.string().allow(""),
|
|
3322
3540
|
house_no: Joi.string().allow(""),
|
|
3323
3541
|
last_name: Joi.string().allow(""),
|
|
3324
3542
|
middle_name: Joi.string().allow(""),
|
|
3325
|
-
pincode: Joi.string().allow("")
|
|
3326
|
-
primary_email: Joi.string().allow("")
|
|
3327
|
-
primary_mobile_number: Joi.string().allow("")
|
|
3328
|
-
state: Joi.string().allow("")
|
|
3543
|
+
pincode: Joi.string().allow(""),
|
|
3544
|
+
primary_email: Joi.string().allow(""),
|
|
3545
|
+
primary_mobile_number: Joi.string().allow(""),
|
|
3546
|
+
state: Joi.string().allow(""),
|
|
3329
3547
|
state_code: Joi.string().allow(""),
|
|
3330
3548
|
title: Joi.string().allow(""),
|
|
3331
3549
|
});
|
|
3332
3550
|
}
|
|
3333
3551
|
|
|
3334
|
-
/** @returns {BillingStaffDetails} */
|
|
3335
|
-
static BillingStaffDetails() {
|
|
3336
|
-
return Joi.object({
|
|
3337
|
-
employee_code: Joi.string().allow("").allow(null),
|
|
3338
|
-
first_name: Joi.string().allow("").allow(null),
|
|
3339
|
-
last_name: Joi.string().allow("").allow(null),
|
|
3340
|
-
staff_id: Joi.number().allow(null),
|
|
3341
|
-
user: Joi.string().allow("").allow(null),
|
|
3342
|
-
});
|
|
3343
|
-
}
|
|
3344
|
-
|
|
3345
3552
|
/** @returns {Brand} */
|
|
3346
3553
|
static Brand() {
|
|
3347
3554
|
return Joi.object({
|
|
@@ -3361,6 +3568,36 @@ class OrderPlatformModel {
|
|
|
3361
3568
|
});
|
|
3362
3569
|
}
|
|
3363
3570
|
|
|
3571
|
+
/** @returns {BulkActionListingData} */
|
|
3572
|
+
static BulkActionListingData() {
|
|
3573
|
+
return Joi.object({
|
|
3574
|
+
batch_id: Joi.string().allow(""),
|
|
3575
|
+
bulk_action_type: Joi.string().allow(""),
|
|
3576
|
+
company_id: Joi.number(),
|
|
3577
|
+
created_ts: Joi.string().allow(""),
|
|
3578
|
+
do_invoice_label_generated: Joi.boolean(),
|
|
3579
|
+
file_name: Joi.string().allow(""),
|
|
3580
|
+
file_url: Joi.string().allow(""),
|
|
3581
|
+
id: Joi.number(),
|
|
3582
|
+
invoice_document_type: Joi.string().allow(""),
|
|
3583
|
+
invoice_status: Joi.string().allow(""),
|
|
3584
|
+
is_invoiceable: Joi.boolean(),
|
|
3585
|
+
label_document_type: Joi.string().allow(""),
|
|
3586
|
+
last_selected_invoice_label_type: Joi.string().allow(""),
|
|
3587
|
+
meta: Joi.any(),
|
|
3588
|
+
shipments_action_info: OrderPlatformModel.ShipmentActionInfo(),
|
|
3589
|
+
status: Joi.boolean(),
|
|
3590
|
+
store_code: Joi.string().allow(""),
|
|
3591
|
+
store_id: Joi.number(),
|
|
3592
|
+
store_name: Joi.string().allow(""),
|
|
3593
|
+
updated_ts: Joi.number(),
|
|
3594
|
+
uploaded_by: Joi.string().allow(""),
|
|
3595
|
+
uploaded_on: Joi.string().allow(""),
|
|
3596
|
+
user_id: Joi.string().allow(""),
|
|
3597
|
+
user_name: Joi.string().allow(""),
|
|
3598
|
+
});
|
|
3599
|
+
}
|
|
3600
|
+
|
|
3364
3601
|
/** @returns {BulkActionTemplate} */
|
|
3365
3602
|
static BulkActionTemplate() {
|
|
3366
3603
|
return Joi.object({
|
|
@@ -3378,27 +3615,50 @@ class OrderPlatformModel {
|
|
|
3378
3615
|
});
|
|
3379
3616
|
}
|
|
3380
3617
|
|
|
3381
|
-
/** @returns {
|
|
3382
|
-
static
|
|
3618
|
+
/** @returns {BulkFailedResponse} */
|
|
3619
|
+
static BulkFailedResponse() {
|
|
3383
3620
|
return Joi.object({
|
|
3384
3621
|
error: Joi.string().allow(""),
|
|
3385
3622
|
status: Joi.boolean(),
|
|
3386
3623
|
});
|
|
3387
3624
|
}
|
|
3388
3625
|
|
|
3626
|
+
/** @returns {BulkListingResponse} */
|
|
3627
|
+
static BulkListingResponse() {
|
|
3628
|
+
return Joi.object({
|
|
3629
|
+
data: Joi.array().items(OrderPlatformModel.BulkActionListingData()),
|
|
3630
|
+
page: OrderPlatformModel.BulkListinPage(),
|
|
3631
|
+
success: Joi.boolean(),
|
|
3632
|
+
total_count: Joi.number(),
|
|
3633
|
+
});
|
|
3634
|
+
}
|
|
3635
|
+
|
|
3636
|
+
/** @returns {BulkListinPage} */
|
|
3637
|
+
static BulkListinPage() {
|
|
3638
|
+
return Joi.object({
|
|
3639
|
+
current: Joi.number(),
|
|
3640
|
+
has_next: Joi.boolean(),
|
|
3641
|
+
has_previous: Joi.boolean(),
|
|
3642
|
+
item_total: Joi.number(),
|
|
3643
|
+
size: Joi.number(),
|
|
3644
|
+
total: Joi.number(),
|
|
3645
|
+
type: Joi.string().allow(""),
|
|
3646
|
+
});
|
|
3647
|
+
}
|
|
3648
|
+
|
|
3389
3649
|
/** @returns {BulkReportsDownloadRequest} */
|
|
3390
3650
|
static BulkReportsDownloadRequest() {
|
|
3391
3651
|
return Joi.object({
|
|
3392
3652
|
custom_filters_for_lane: Joi.any(),
|
|
3393
3653
|
custom_headers: Joi.string().allow(""),
|
|
3654
|
+
end_date: Joi.string().allow(""),
|
|
3394
3655
|
entities: Joi.array().items(Joi.string().allow("")),
|
|
3395
3656
|
filter_type: Joi.string().allow(""),
|
|
3396
|
-
from_date: Joi.string().allow(""),
|
|
3397
3657
|
is_cross_company_enabled: Joi.boolean(),
|
|
3398
3658
|
lane_type: Joi.string().allow(""),
|
|
3399
3659
|
report_type: Joi.string().allow(""),
|
|
3660
|
+
start_date: Joi.string().allow(""),
|
|
3400
3661
|
store_ids: Joi.array().items(Joi.string().allow("")),
|
|
3401
|
-
to_date: Joi.string().allow(""),
|
|
3402
3662
|
});
|
|
3403
3663
|
}
|
|
3404
3664
|
|
|
@@ -3410,6 +3670,23 @@ class OrderPlatformModel {
|
|
|
3410
3670
|
});
|
|
3411
3671
|
}
|
|
3412
3672
|
|
|
3673
|
+
/** @returns {BulkStateTransistionRequest} */
|
|
3674
|
+
static BulkStateTransistionRequest() {
|
|
3675
|
+
return Joi.object({
|
|
3676
|
+
file_name: Joi.string().allow(""),
|
|
3677
|
+
url: Joi.string().allow(""),
|
|
3678
|
+
});
|
|
3679
|
+
}
|
|
3680
|
+
|
|
3681
|
+
/** @returns {BulkStateTransistionResponse} */
|
|
3682
|
+
static BulkStateTransistionResponse() {
|
|
3683
|
+
return Joi.object({
|
|
3684
|
+
batch_id: Joi.string().allow(""),
|
|
3685
|
+
message: Joi.string().allow(""),
|
|
3686
|
+
status: Joi.boolean(),
|
|
3687
|
+
});
|
|
3688
|
+
}
|
|
3689
|
+
|
|
3413
3690
|
/** @returns {BuyerDetails} */
|
|
3414
3691
|
static BuyerDetails() {
|
|
3415
3692
|
return Joi.object({
|
|
@@ -3485,6 +3762,14 @@ class OrderPlatformModel {
|
|
|
3485
3762
|
});
|
|
3486
3763
|
}
|
|
3487
3764
|
|
|
3765
|
+
/** @returns {ConversionRate} */
|
|
3766
|
+
static ConversionRate() {
|
|
3767
|
+
return Joi.object({
|
|
3768
|
+
base: Joi.string().allow(""),
|
|
3769
|
+
rates: Joi.any(),
|
|
3770
|
+
});
|
|
3771
|
+
}
|
|
3772
|
+
|
|
3488
3773
|
/** @returns {CourierPartnerTrackingDetails} */
|
|
3489
3774
|
static CourierPartnerTrackingDetails() {
|
|
3490
3775
|
return Joi.object({
|
|
@@ -3615,12 +3900,29 @@ class OrderPlatformModel {
|
|
|
3615
3900
|
});
|
|
3616
3901
|
}
|
|
3617
3902
|
|
|
3903
|
+
/** @returns {Currency} */
|
|
3904
|
+
static Currency() {
|
|
3905
|
+
return Joi.object({
|
|
3906
|
+
currency_code: Joi.string().allow(""),
|
|
3907
|
+
currency_symbol: Joi.string().allow(""),
|
|
3908
|
+
});
|
|
3909
|
+
}
|
|
3910
|
+
|
|
3911
|
+
/** @returns {CurrencyInfo} */
|
|
3912
|
+
static CurrencyInfo() {
|
|
3913
|
+
return Joi.object({
|
|
3914
|
+
conversion_rate: OrderPlatformModel.ConversionRate(),
|
|
3915
|
+
ordering_currency: OrderPlatformModel.OrderingCurrency(),
|
|
3916
|
+
});
|
|
3917
|
+
}
|
|
3918
|
+
|
|
3618
3919
|
/** @returns {CurrentStatus} */
|
|
3619
3920
|
static CurrentStatus() {
|
|
3620
3921
|
return Joi.object({
|
|
3621
3922
|
bag_id: Joi.number().allow(null),
|
|
3622
3923
|
bag_state_mapper: OrderPlatformModel.BagStateMapper(),
|
|
3623
3924
|
created_at: Joi.string().allow("").allow(null),
|
|
3925
|
+
created_ts: Joi.string().allow("").allow(null),
|
|
3624
3926
|
delivery_awb_number: Joi.string().allow("").allow(null),
|
|
3625
3927
|
delivery_partner_id: Joi.number().allow(null),
|
|
3626
3928
|
id: Joi.number().required(),
|
|
@@ -3645,6 +3947,14 @@ class OrderPlatformModel {
|
|
|
3645
3947
|
});
|
|
3646
3948
|
}
|
|
3647
3949
|
|
|
3950
|
+
/** @returns {DateRange} */
|
|
3951
|
+
static DateRange() {
|
|
3952
|
+
return Joi.object({
|
|
3953
|
+
from_date: Joi.string().allow(""),
|
|
3954
|
+
to_date: Joi.string().allow(""),
|
|
3955
|
+
});
|
|
3956
|
+
}
|
|
3957
|
+
|
|
3648
3958
|
/** @returns {Dates} */
|
|
3649
3959
|
static Dates() {
|
|
3650
3960
|
return Joi.object({
|
|
@@ -3729,6 +4039,64 @@ class OrderPlatformModel {
|
|
|
3729
4039
|
});
|
|
3730
4040
|
}
|
|
3731
4041
|
|
|
4042
|
+
/** @returns {EInvoiceDetails} */
|
|
4043
|
+
static EInvoiceDetails() {
|
|
4044
|
+
return Joi.object({
|
|
4045
|
+
error_details: Joi.array().items(
|
|
4046
|
+
OrderPlatformModel.EInvoiceErrorDetails()
|
|
4047
|
+
),
|
|
4048
|
+
irn_details: OrderPlatformModel.EInvoiceIrnDetails(),
|
|
4049
|
+
});
|
|
4050
|
+
}
|
|
4051
|
+
|
|
4052
|
+
/** @returns {EInvoiceErrorDetails} */
|
|
4053
|
+
static EInvoiceErrorDetails() {
|
|
4054
|
+
return Joi.object({
|
|
4055
|
+
error_code: Joi.string().allow(""),
|
|
4056
|
+
error_message: Joi.string().allow("").required(),
|
|
4057
|
+
});
|
|
4058
|
+
}
|
|
4059
|
+
|
|
4060
|
+
/** @returns {EInvoiceErrorInfo} */
|
|
4061
|
+
static EInvoiceErrorInfo() {
|
|
4062
|
+
return Joi.object({
|
|
4063
|
+
error_details: Joi.array().items(
|
|
4064
|
+
OrderPlatformModel.EInvoiceErrorDetails()
|
|
4065
|
+
),
|
|
4066
|
+
});
|
|
4067
|
+
}
|
|
4068
|
+
|
|
4069
|
+
/** @returns {EInvoiceErrorResponse} */
|
|
4070
|
+
static EInvoiceErrorResponse() {
|
|
4071
|
+
return Joi.object({
|
|
4072
|
+
message: Joi.string().allow(""),
|
|
4073
|
+
response_data: Joi.array().items(
|
|
4074
|
+
OrderPlatformModel.EInvoiceErrorResponseData()
|
|
4075
|
+
),
|
|
4076
|
+
});
|
|
4077
|
+
}
|
|
4078
|
+
|
|
4079
|
+
/** @returns {EInvoiceErrorResponseData} */
|
|
4080
|
+
static EInvoiceErrorResponseData() {
|
|
4081
|
+
return Joi.object({
|
|
4082
|
+
einvoice_info: OrderPlatformModel.EInvoiceErrorInfo(),
|
|
4083
|
+
einvoice_type: Joi.string().allow("").required(),
|
|
4084
|
+
message: Joi.string().allow("").required(),
|
|
4085
|
+
shipment_id: Joi.string().allow("").required(),
|
|
4086
|
+
status: Joi.number().required(),
|
|
4087
|
+
});
|
|
4088
|
+
}
|
|
4089
|
+
|
|
4090
|
+
/** @returns {EInvoiceErrorResponseDetails} */
|
|
4091
|
+
static EInvoiceErrorResponseDetails() {
|
|
4092
|
+
return Joi.object({
|
|
4093
|
+
message: Joi.string().allow(""),
|
|
4094
|
+
response_data: Joi.array()
|
|
4095
|
+
.items(OrderPlatformModel.EInvoiceErrorResponseData())
|
|
4096
|
+
.required(),
|
|
4097
|
+
});
|
|
4098
|
+
}
|
|
4099
|
+
|
|
3732
4100
|
/** @returns {EinvoiceInfo} */
|
|
3733
4101
|
static EinvoiceInfo() {
|
|
3734
4102
|
return Joi.object({
|
|
@@ -3737,6 +4105,17 @@ class OrderPlatformModel {
|
|
|
3737
4105
|
});
|
|
3738
4106
|
}
|
|
3739
4107
|
|
|
4108
|
+
/** @returns {EInvoiceIrnDetails} */
|
|
4109
|
+
static EInvoiceIrnDetails() {
|
|
4110
|
+
return Joi.object({
|
|
4111
|
+
ack_dt: Joi.string().allow("").required(),
|
|
4112
|
+
ack_no: Joi.string().allow("").required(),
|
|
4113
|
+
irn: Joi.string().allow("").required(),
|
|
4114
|
+
signed_invoice: Joi.string().allow("").required(),
|
|
4115
|
+
signed_qr_code: Joi.string().allow("").required(),
|
|
4116
|
+
});
|
|
4117
|
+
}
|
|
4118
|
+
|
|
3740
4119
|
/** @returns {EInvoicePortalDetails} */
|
|
3741
4120
|
static EInvoicePortalDetails() {
|
|
3742
4121
|
return Joi.object({
|
|
@@ -3749,14 +4128,11 @@ class OrderPlatformModel {
|
|
|
3749
4128
|
/** @returns {EInvoiceResponseData} */
|
|
3750
4129
|
static EInvoiceResponseData() {
|
|
3751
4130
|
return Joi.object({
|
|
3752
|
-
|
|
3753
|
-
|
|
3754
|
-
irn: Joi.string().allow(""),
|
|
4131
|
+
einvoice_info: OrderPlatformModel.EInvoiceDetails(),
|
|
4132
|
+
einvoice_type: Joi.string().allow("").required(),
|
|
3755
4133
|
message: Joi.string().allow("").required(),
|
|
3756
4134
|
shipment_id: Joi.string().allow("").required(),
|
|
3757
|
-
|
|
3758
|
-
timeout: Joi.number(),
|
|
3759
|
-
timeout_unit: Joi.string().allow(""),
|
|
4135
|
+
status: Joi.number().required(),
|
|
3760
4136
|
});
|
|
3761
4137
|
}
|
|
3762
4138
|
|
|
@@ -3772,18 +4148,16 @@ class OrderPlatformModel {
|
|
|
3772
4148
|
/** @returns {EInvoiceRetryResponse} */
|
|
3773
4149
|
static EInvoiceRetryResponse() {
|
|
3774
4150
|
return Joi.object({
|
|
3775
|
-
message: Joi.string().allow(""),
|
|
3776
4151
|
response_data: Joi.array()
|
|
3777
4152
|
.items(OrderPlatformModel.EInvoiceResponseData())
|
|
3778
4153
|
.required(),
|
|
3779
|
-
success: Joi.boolean(),
|
|
3780
|
-
success_count: Joi.number().required(),
|
|
3781
4154
|
});
|
|
3782
4155
|
}
|
|
3783
4156
|
|
|
3784
4157
|
/** @returns {EInvoiceRetryShipmentData} */
|
|
3785
4158
|
static EInvoiceRetryShipmentData() {
|
|
3786
4159
|
return Joi.object({
|
|
4160
|
+
einvoice_type: Joi.string().allow("").required(),
|
|
3787
4161
|
shipment_id: Joi.string().allow("").required(),
|
|
3788
4162
|
});
|
|
3789
4163
|
}
|
|
@@ -3843,7 +4217,7 @@ class OrderPlatformModel {
|
|
|
3843
4217
|
/** @returns {ErrorResponse} */
|
|
3844
4218
|
static ErrorResponse() {
|
|
3845
4219
|
return Joi.object({
|
|
3846
|
-
error: Joi.string().allow("")
|
|
4220
|
+
error: Joi.string().allow(""),
|
|
3847
4221
|
error_trace: Joi.string().allow("").allow(null),
|
|
3848
4222
|
message: Joi.string().allow("").allow(null).required(),
|
|
3849
4223
|
status: Joi.number().allow(null),
|
|
@@ -3851,6 +4225,37 @@ class OrderPlatformModel {
|
|
|
3851
4225
|
});
|
|
3852
4226
|
}
|
|
3853
4227
|
|
|
4228
|
+
/** @returns {FailedOrderLogDetails} */
|
|
4229
|
+
static FailedOrderLogDetails() {
|
|
4230
|
+
return Joi.object({
|
|
4231
|
+
error_trace: Joi.string().allow("").allow(null).required(),
|
|
4232
|
+
exception: Joi.string().allow("").allow(null).required(),
|
|
4233
|
+
});
|
|
4234
|
+
}
|
|
4235
|
+
|
|
4236
|
+
/** @returns {FailedOrderLogs} */
|
|
4237
|
+
static FailedOrderLogs() {
|
|
4238
|
+
return Joi.object({
|
|
4239
|
+
items: OrderPlatformModel.FailedOrdersItem().required(),
|
|
4240
|
+
page: OrderPlatformModel.PageDetails().required(),
|
|
4241
|
+
});
|
|
4242
|
+
}
|
|
4243
|
+
|
|
4244
|
+
/** @returns {FailedOrdersItem} */
|
|
4245
|
+
static FailedOrdersItem() {
|
|
4246
|
+
return Joi.object({
|
|
4247
|
+
channel: OrderPlatformModel.LogsChannelDetails().required(),
|
|
4248
|
+
created_at: Joi.string().allow("").required(),
|
|
4249
|
+
display_message: Joi.string().allow("").allow(null).required(),
|
|
4250
|
+
error_message: Joi.string().allow("").allow(null).required(),
|
|
4251
|
+
log_id: Joi.number().required(),
|
|
4252
|
+
meta: Joi.any().allow(null).required(),
|
|
4253
|
+
method_name: Joi.string().allow("").required(),
|
|
4254
|
+
order_id: Joi.string().allow("").required(),
|
|
4255
|
+
payment: OrderPlatformModel.LogPaymentDetails().required(),
|
|
4256
|
+
});
|
|
4257
|
+
}
|
|
4258
|
+
|
|
3854
4259
|
/** @returns {FetchCreditBalanceRequestPayload} */
|
|
3855
4260
|
static FetchCreditBalanceRequestPayload() {
|
|
3856
4261
|
return Joi.object({
|
|
@@ -3888,6 +4293,22 @@ class OrderPlatformModel {
|
|
|
3888
4293
|
});
|
|
3889
4294
|
}
|
|
3890
4295
|
|
|
4296
|
+
/** @returns {Filters} */
|
|
4297
|
+
static Filters() {
|
|
4298
|
+
return Joi.object({
|
|
4299
|
+
date_range: OrderPlatformModel.DateRange(),
|
|
4300
|
+
dp_ids: Joi.number(),
|
|
4301
|
+
dp_name: Joi.string().allow(""),
|
|
4302
|
+
from_date: Joi.string().allow(""),
|
|
4303
|
+
lane: Joi.string().allow(""),
|
|
4304
|
+
logo: Joi.string().allow(""),
|
|
4305
|
+
selected_shipments: Joi.string().allow(""),
|
|
4306
|
+
store_name: Joi.string().allow(""),
|
|
4307
|
+
stores: Joi.number(),
|
|
4308
|
+
to_date: Joi.string().allow(""),
|
|
4309
|
+
});
|
|
4310
|
+
}
|
|
4311
|
+
|
|
3891
4312
|
/** @returns {FiltersInfo} */
|
|
3892
4313
|
static FiltersInfo() {
|
|
3893
4314
|
return Joi.object({
|
|
@@ -3900,6 +4321,19 @@ class OrderPlatformModel {
|
|
|
3900
4321
|
});
|
|
3901
4322
|
}
|
|
3902
4323
|
|
|
4324
|
+
/** @returns {FiltersRequest} */
|
|
4325
|
+
static FiltersRequest() {
|
|
4326
|
+
return Joi.object({
|
|
4327
|
+
date_range: OrderPlatformModel.DateRange(),
|
|
4328
|
+
dp_ids: Joi.number().required(),
|
|
4329
|
+
dp_name: Joi.string().allow("").required(),
|
|
4330
|
+
lane: Joi.string().allow("").required(),
|
|
4331
|
+
logo: Joi.string().allow(""),
|
|
4332
|
+
store_name: Joi.string().allow("").required(),
|
|
4333
|
+
stores: Joi.number().required(),
|
|
4334
|
+
});
|
|
4335
|
+
}
|
|
4336
|
+
|
|
3903
4337
|
/** @returns {FiltersResponse} */
|
|
3904
4338
|
static FiltersResponse() {
|
|
3905
4339
|
return Joi.object({
|
|
@@ -3974,59 +4408,17 @@ class OrderPlatformModel {
|
|
|
3974
4408
|
});
|
|
3975
4409
|
}
|
|
3976
4410
|
|
|
3977
|
-
/** @returns {GenerateInvoiceIDErrorResponse} */
|
|
3978
|
-
static GenerateInvoiceIDErrorResponse() {
|
|
3979
|
-
return Joi.object({
|
|
3980
|
-
items: Joi.array().items(
|
|
3981
|
-
OrderPlatformModel.GenerateInvoiceIDErrorResponseData()
|
|
3982
|
-
),
|
|
3983
|
-
});
|
|
3984
|
-
}
|
|
3985
|
-
|
|
3986
|
-
/** @returns {GenerateInvoiceIDErrorResponseData} */
|
|
3987
|
-
static GenerateInvoiceIDErrorResponseData() {
|
|
3988
|
-
return Joi.object({
|
|
3989
|
-
error_message: Joi.string().allow("").allow(null),
|
|
3990
|
-
invoice_id: Joi.boolean().allow(null),
|
|
3991
|
-
shipment_id: Joi.string().allow(""),
|
|
3992
|
-
success: Joi.boolean(),
|
|
3993
|
-
});
|
|
3994
|
-
}
|
|
3995
|
-
|
|
3996
|
-
/** @returns {GenerateInvoiceIDRequest} */
|
|
3997
|
-
static GenerateInvoiceIDRequest() {
|
|
3998
|
-
return Joi.object({
|
|
3999
|
-
shipment_ids: Joi.array().items(Joi.string().allow("")).required(),
|
|
4000
|
-
});
|
|
4001
|
-
}
|
|
4002
|
-
|
|
4003
|
-
/** @returns {GenerateInvoiceIDResponse} */
|
|
4004
|
-
static GenerateInvoiceIDResponse() {
|
|
4005
|
-
return Joi.object({
|
|
4006
|
-
items: Joi.array().items(
|
|
4007
|
-
OrderPlatformModel.GenerateInvoiceIDResponseData()
|
|
4008
|
-
),
|
|
4009
|
-
});
|
|
4010
|
-
}
|
|
4011
|
-
|
|
4012
|
-
/** @returns {GenerateInvoiceIDResponseData} */
|
|
4013
|
-
static GenerateInvoiceIDResponseData() {
|
|
4014
|
-
return Joi.object({
|
|
4015
|
-
error_message: Joi.boolean().allow(null),
|
|
4016
|
-
invoice_id: Joi.string().allow("").allow(null),
|
|
4017
|
-
shipment_id: Joi.string().allow(""),
|
|
4018
|
-
success: Joi.boolean(),
|
|
4019
|
-
});
|
|
4020
|
-
}
|
|
4021
|
-
|
|
4022
4411
|
/** @returns {GeneratePosOrderReceiptResponse} */
|
|
4023
4412
|
static GeneratePosOrderReceiptResponse() {
|
|
4024
4413
|
return Joi.object({
|
|
4025
4414
|
customer_cn_receipt: Joi.string().allow(""),
|
|
4415
|
+
customer_cn_receipt_template: Joi.string().allow(""),
|
|
4026
4416
|
invoice_receipt: Joi.string().allow(""),
|
|
4417
|
+
invoice_receipt_template: Joi.string().allow(""),
|
|
4027
4418
|
merchant_cn_receipt: Joi.string().allow(""),
|
|
4028
4419
|
order_id: Joi.string().allow(""),
|
|
4029
4420
|
payment_receipt: Joi.string().allow(""),
|
|
4421
|
+
payment_receipt_template: Joi.string().allow(""),
|
|
4030
4422
|
success: Joi.boolean(),
|
|
4031
4423
|
});
|
|
4032
4424
|
}
|
|
@@ -4040,21 +4432,11 @@ class OrderPlatformModel {
|
|
|
4040
4432
|
|
|
4041
4433
|
/** @returns {GetBagsPlatformResponse} */
|
|
4042
4434
|
static GetBagsPlatformResponse() {
|
|
4043
|
-
return Joi.object({
|
|
4044
|
-
items: Joi.array()
|
|
4045
|
-
.items(OrderPlatformModel.BagDetailsPlatformResponse())
|
|
4046
|
-
.required(),
|
|
4047
|
-
page: OrderPlatformModel.BagsPage().required(),
|
|
4048
|
-
});
|
|
4049
|
-
}
|
|
4050
|
-
|
|
4051
|
-
/** @returns {GiftCard} */
|
|
4052
|
-
static GiftCard() {
|
|
4053
|
-
return Joi.object({
|
|
4054
|
-
display_text: Joi.string().allow("").allow(null),
|
|
4055
|
-
gift_message: Joi.string().allow("").allow(null),
|
|
4056
|
-
gift_price: Joi.number().allow(null),
|
|
4057
|
-
is_gift_applied: Joi.boolean().allow(null),
|
|
4435
|
+
return Joi.object({
|
|
4436
|
+
items: Joi.array()
|
|
4437
|
+
.items(OrderPlatformModel.BagDetailsPlatformResponse())
|
|
4438
|
+
.required(),
|
|
4439
|
+
page: OrderPlatformModel.BagsPage().required(),
|
|
4058
4440
|
});
|
|
4059
4441
|
}
|
|
4060
4442
|
|
|
@@ -4229,6 +4611,45 @@ class OrderPlatformModel {
|
|
|
4229
4611
|
});
|
|
4230
4612
|
}
|
|
4231
4613
|
|
|
4614
|
+
/** @returns {JobDetailsData} */
|
|
4615
|
+
static JobDetailsData() {
|
|
4616
|
+
return Joi.object({
|
|
4617
|
+
batch_id: Joi.string().allow(""),
|
|
4618
|
+
company_id: Joi.string().allow(""),
|
|
4619
|
+
failed_shipments_count: Joi.number(),
|
|
4620
|
+
processing_shipments_count: Joi.number(),
|
|
4621
|
+
successful_shipment_ids: Joi.array().items(Joi.string().allow("")),
|
|
4622
|
+
successful_shipments_count: Joi.number(),
|
|
4623
|
+
total_shipments_count: Joi.number(),
|
|
4624
|
+
});
|
|
4625
|
+
}
|
|
4626
|
+
|
|
4627
|
+
/** @returns {JobDetailsResponse} */
|
|
4628
|
+
static JobDetailsResponse() {
|
|
4629
|
+
return Joi.object({
|
|
4630
|
+
created_ts: Joi.string().allow(""),
|
|
4631
|
+
data: Joi.array().items(OrderPlatformModel.JobDetailsData()),
|
|
4632
|
+
failed_records: Joi.array().items(
|
|
4633
|
+
Joi.object().pattern(/\S/, Joi.string().allow(""))
|
|
4634
|
+
),
|
|
4635
|
+
file_url: Joi.string().allow(""),
|
|
4636
|
+
message: Joi.string().allow(""),
|
|
4637
|
+
status: Joi.string().allow(""),
|
|
4638
|
+
success: Joi.boolean(),
|
|
4639
|
+
uploaded_by: Joi.string().allow(""),
|
|
4640
|
+
uploaded_on: Joi.string().allow(""),
|
|
4641
|
+
user_id: Joi.string().allow(""),
|
|
4642
|
+
});
|
|
4643
|
+
}
|
|
4644
|
+
|
|
4645
|
+
/** @returns {JobFailedResponse} */
|
|
4646
|
+
static JobFailedResponse() {
|
|
4647
|
+
return Joi.object({
|
|
4648
|
+
file_name: Joi.string().allow(""),
|
|
4649
|
+
url: Joi.string().allow(""),
|
|
4650
|
+
});
|
|
4651
|
+
}
|
|
4652
|
+
|
|
4232
4653
|
/** @returns {LaneConfigResponse} */
|
|
4233
4654
|
static LaneConfigResponse() {
|
|
4234
4655
|
return Joi.object({
|
|
@@ -4268,6 +4689,135 @@ class OrderPlatformModel {
|
|
|
4268
4689
|
});
|
|
4269
4690
|
}
|
|
4270
4691
|
|
|
4692
|
+
/** @returns {LogPaymentDetails} */
|
|
4693
|
+
static LogPaymentDetails() {
|
|
4694
|
+
return Joi.object({
|
|
4695
|
+
amount_paid: Joi.string().allow("").allow(null),
|
|
4696
|
+
payment_mode: Joi.string().allow("").allow(null),
|
|
4697
|
+
});
|
|
4698
|
+
}
|
|
4699
|
+
|
|
4700
|
+
/** @returns {LogsChannelDetails} */
|
|
4701
|
+
static LogsChannelDetails() {
|
|
4702
|
+
return Joi.object({
|
|
4703
|
+
channel_id: Joi.string().allow("").allow(null),
|
|
4704
|
+
channel_shipment_id: Joi.string().allow("").allow(null),
|
|
4705
|
+
logo: Joi.string().allow("").allow(null),
|
|
4706
|
+
name: Joi.string().allow("").allow(null),
|
|
4707
|
+
});
|
|
4708
|
+
}
|
|
4709
|
+
|
|
4710
|
+
/** @returns {Manifest} */
|
|
4711
|
+
static Manifest() {
|
|
4712
|
+
return Joi.object({
|
|
4713
|
+
company_id: Joi.number().required(),
|
|
4714
|
+
created_at: Joi.string().allow("").required(),
|
|
4715
|
+
created_by: Joi.string().allow("").required(),
|
|
4716
|
+
created_ts: Joi.string().allow(""),
|
|
4717
|
+
filters: OrderPlatformModel.Filters(),
|
|
4718
|
+
id: Joi.number().required(),
|
|
4719
|
+
is_active: Joi.boolean().required(),
|
|
4720
|
+
manifest_id: Joi.string().allow("").required(),
|
|
4721
|
+
meta: OrderPlatformModel.ManifestMeta(),
|
|
4722
|
+
pdf_meta: OrderPlatformModel.PDFMeta(),
|
|
4723
|
+
status: Joi.string().allow("").required(),
|
|
4724
|
+
uid: Joi.string().allow("").required(),
|
|
4725
|
+
user_id: Joi.string().allow("").required(),
|
|
4726
|
+
});
|
|
4727
|
+
}
|
|
4728
|
+
|
|
4729
|
+
/** @returns {ManifestDetails} */
|
|
4730
|
+
static ManifestDetails() {
|
|
4731
|
+
return Joi.object({
|
|
4732
|
+
additional_shipment_count: Joi.number(),
|
|
4733
|
+
items: Joi.array().items(OrderPlatformModel.ManifestItemDetails()),
|
|
4734
|
+
manifest_details: Joi.array().items(OrderPlatformModel.Manifest()),
|
|
4735
|
+
page: OrderPlatformModel.ManifestPageInfo(),
|
|
4736
|
+
});
|
|
4737
|
+
}
|
|
4738
|
+
|
|
4739
|
+
/** @returns {ManifestFile} */
|
|
4740
|
+
static ManifestFile() {
|
|
4741
|
+
return Joi.object({
|
|
4742
|
+
bucket: Joi.string().allow(""),
|
|
4743
|
+
key: Joi.string().allow(""),
|
|
4744
|
+
region: Joi.string().allow(""),
|
|
4745
|
+
});
|
|
4746
|
+
}
|
|
4747
|
+
|
|
4748
|
+
/** @returns {ManifestFiltersResponse} */
|
|
4749
|
+
static ManifestFiltersResponse() {
|
|
4750
|
+
return Joi.object({
|
|
4751
|
+
advance_filter: Joi.array().items(OrderPlatformModel.FiltersInfo()),
|
|
4752
|
+
global_filter: Joi.array().items(OrderPlatformModel.FiltersInfo()),
|
|
4753
|
+
});
|
|
4754
|
+
}
|
|
4755
|
+
|
|
4756
|
+
/** @returns {ManifestItemDetails} */
|
|
4757
|
+
static ManifestItemDetails() {
|
|
4758
|
+
return Joi.object({
|
|
4759
|
+
awb_number: Joi.string().allow(""),
|
|
4760
|
+
invoice_id: Joi.string().allow(""),
|
|
4761
|
+
order_id: Joi.string().allow("").required(),
|
|
4762
|
+
quantity: Joi.number(),
|
|
4763
|
+
shipment_created_at: Joi.string().allow(""),
|
|
4764
|
+
shipment_id: Joi.string().allow("").required(),
|
|
4765
|
+
});
|
|
4766
|
+
}
|
|
4767
|
+
|
|
4768
|
+
/** @returns {ManifestList} */
|
|
4769
|
+
static ManifestList() {
|
|
4770
|
+
return Joi.object({
|
|
4771
|
+
items: Joi.array().items(OrderPlatformModel.Manifest()),
|
|
4772
|
+
page: OrderPlatformModel.ManifestPageInfo(),
|
|
4773
|
+
});
|
|
4774
|
+
}
|
|
4775
|
+
|
|
4776
|
+
/** @returns {ManifestMediaUpdate} */
|
|
4777
|
+
static ManifestMediaUpdate() {
|
|
4778
|
+
return Joi.object({
|
|
4779
|
+
code: Joi.number(),
|
|
4780
|
+
entity: Joi.string().allow(""),
|
|
4781
|
+
file: OrderPlatformModel.ManifestFile(),
|
|
4782
|
+
link: Joi.string().allow(""),
|
|
4783
|
+
media_type: Joi.string().allow(""),
|
|
4784
|
+
status: Joi.boolean(),
|
|
4785
|
+
});
|
|
4786
|
+
}
|
|
4787
|
+
|
|
4788
|
+
/** @returns {ManifestMeta} */
|
|
4789
|
+
static ManifestMeta() {
|
|
4790
|
+
return Joi.object({
|
|
4791
|
+
filters: OrderPlatformModel.Filters(),
|
|
4792
|
+
total_shipment_prices_count: OrderPlatformModel.TotalShipmentPricesCount(),
|
|
4793
|
+
});
|
|
4794
|
+
}
|
|
4795
|
+
|
|
4796
|
+
/** @returns {ManifestPageInfo} */
|
|
4797
|
+
static ManifestPageInfo() {
|
|
4798
|
+
return Joi.object({
|
|
4799
|
+
current: Joi.number().required(),
|
|
4800
|
+
has_next: Joi.boolean().required(),
|
|
4801
|
+
has_previous: Joi.boolean().required(),
|
|
4802
|
+
size: Joi.number().required(),
|
|
4803
|
+
total: Joi.number().required(),
|
|
4804
|
+
type: Joi.string().allow("").required(),
|
|
4805
|
+
});
|
|
4806
|
+
}
|
|
4807
|
+
|
|
4808
|
+
/** @returns {ManifestShipmentListing} */
|
|
4809
|
+
static ManifestShipmentListing() {
|
|
4810
|
+
return Joi.object({
|
|
4811
|
+
items: Joi.array().items(OrderPlatformModel.ManifestItemDetails()),
|
|
4812
|
+
lane: Joi.string().allow(""),
|
|
4813
|
+
message: Joi.string().allow(""),
|
|
4814
|
+
page: OrderPlatformModel.ManifestPageInfo().required(),
|
|
4815
|
+
status: Joi.number().required(),
|
|
4816
|
+
success: Joi.boolean().required(),
|
|
4817
|
+
total_count: Joi.number().required(),
|
|
4818
|
+
});
|
|
4819
|
+
}
|
|
4820
|
+
|
|
4271
4821
|
/** @returns {MarketPlacePdf} */
|
|
4272
4822
|
static MarketPlacePdf() {
|
|
4273
4823
|
return Joi.object({
|
|
@@ -4288,7 +4838,7 @@ class OrderPlatformModel {
|
|
|
4288
4838
|
static OrderBagArticle() {
|
|
4289
4839
|
return Joi.object({
|
|
4290
4840
|
identifiers: Joi.any().allow(null),
|
|
4291
|
-
return_config: OrderPlatformModel.
|
|
4841
|
+
return_config: OrderPlatformModel.ReturnConfig(),
|
|
4292
4842
|
size: Joi.string().allow("").allow(null),
|
|
4293
4843
|
uid: Joi.string().allow("").allow(null),
|
|
4294
4844
|
});
|
|
@@ -4357,6 +4907,7 @@ class OrderPlatformModel {
|
|
|
4357
4907
|
/** @returns {OrderData} */
|
|
4358
4908
|
static OrderData() {
|
|
4359
4909
|
return Joi.object({
|
|
4910
|
+
created_ts: Joi.string().allow(""),
|
|
4360
4911
|
fynd_order_id: Joi.string().allow("").required(),
|
|
4361
4912
|
meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
4362
4913
|
order_date: Joi.string().allow("").required(),
|
|
@@ -4379,6 +4930,7 @@ class OrderPlatformModel {
|
|
|
4379
4930
|
return Joi.object({
|
|
4380
4931
|
affiliate_id: Joi.string().allow("").allow(null),
|
|
4381
4932
|
cod_charges: Joi.string().allow("").allow(null),
|
|
4933
|
+
created_ts: Joi.string().allow("").allow(null),
|
|
4382
4934
|
fynd_order_id: Joi.string().allow("").required(),
|
|
4383
4935
|
meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
4384
4936
|
order_date: Joi.string().allow("").allow(null),
|
|
@@ -4420,6 +4972,16 @@ class OrderPlatformModel {
|
|
|
4420
4972
|
});
|
|
4421
4973
|
}
|
|
4422
4974
|
|
|
4975
|
+
/** @returns {OrderingCurrency} */
|
|
4976
|
+
static OrderingCurrency() {
|
|
4977
|
+
return Joi.object({
|
|
4978
|
+
currency_code: Joi.string().allow(""),
|
|
4979
|
+
currency_name: Joi.string().allow(""),
|
|
4980
|
+
currency_sub_unit: Joi.string().allow(""),
|
|
4981
|
+
currency_symbol: Joi.string().allow(""),
|
|
4982
|
+
});
|
|
4983
|
+
}
|
|
4984
|
+
|
|
4423
4985
|
/** @returns {OrderingStoreDetails} */
|
|
4424
4986
|
static OrderingStoreDetails() {
|
|
4425
4987
|
return Joi.object({
|
|
@@ -4456,32 +5018,6 @@ class OrderPlatformModel {
|
|
|
4456
5018
|
});
|
|
4457
5019
|
}
|
|
4458
5020
|
|
|
4459
|
-
/** @returns {OrderMeta} */
|
|
4460
|
-
static OrderMeta() {
|
|
4461
|
-
return Joi.object({
|
|
4462
|
-
billing_staff_details: OrderPlatformModel.BillingStaffDetails(),
|
|
4463
|
-
cart_id: Joi.number().allow(null),
|
|
4464
|
-
cart_object_id: Joi.string().allow("").allow(null),
|
|
4465
|
-
comment: Joi.string().allow("").allow(null),
|
|
4466
|
-
company_logo: Joi.string().allow("").allow(null),
|
|
4467
|
-
currency_symbol: Joi.string().allow("").allow(null),
|
|
4468
|
-
customer_note: Joi.string().allow("").allow(null),
|
|
4469
|
-
employee_id: Joi.string().allow("").allow(null),
|
|
4470
|
-
extra_meta: Joi.any().allow(null),
|
|
4471
|
-
files: Joi.array().items(Joi.any()),
|
|
4472
|
-
mongo_cart_id: Joi.number().allow(null),
|
|
4473
|
-
order_child_entities: Joi.array().items(Joi.string().allow("")),
|
|
4474
|
-
order_platform: Joi.string().allow("").allow(null),
|
|
4475
|
-
order_tags: Joi.array().items(Joi.any().allow(null)),
|
|
4476
|
-
order_type: Joi.string().allow("").allow(null),
|
|
4477
|
-
ordering_store: Joi.number().allow(null),
|
|
4478
|
-
payment_type: Joi.string().allow("").allow(null),
|
|
4479
|
-
platform_user_details: OrderPlatformModel.PlatformUserDetails(),
|
|
4480
|
-
staff: Joi.any().allow(null),
|
|
4481
|
-
transaction_data: OrderPlatformModel.TransactionData(),
|
|
4482
|
-
});
|
|
4483
|
-
}
|
|
4484
|
-
|
|
4485
5021
|
/** @returns {OrderPriority} */
|
|
4486
5022
|
static OrderPriority() {
|
|
4487
5023
|
return Joi.object({
|
|
@@ -4558,11 +5094,33 @@ class OrderPlatformModel {
|
|
|
4558
5094
|
|
|
4559
5095
|
/** @returns {PageDetails} */
|
|
4560
5096
|
static PageDetails() {
|
|
5097
|
+
return Joi.object({
|
|
5098
|
+
current: Joi.number().allow(null),
|
|
5099
|
+
has_next: Joi.boolean().allow(null),
|
|
5100
|
+
has_previous: Joi.boolean().allow(null),
|
|
5101
|
+
item_total: Joi.number().allow(null).required(),
|
|
5102
|
+
size: Joi.number().allow(null),
|
|
5103
|
+
type: Joi.string().allow("").allow(null),
|
|
5104
|
+
});
|
|
5105
|
+
}
|
|
5106
|
+
|
|
5107
|
+
/** @returns {PaginatedStates} */
|
|
5108
|
+
static PaginatedStates() {
|
|
5109
|
+
return Joi.object({
|
|
5110
|
+
items: Joi.array().items(OrderPlatformModel.StateManagerState()),
|
|
5111
|
+
page: OrderPlatformModel.PaginationInfo(),
|
|
5112
|
+
});
|
|
5113
|
+
}
|
|
5114
|
+
|
|
5115
|
+
/** @returns {PaginationInfo} */
|
|
5116
|
+
static PaginationInfo() {
|
|
4561
5117
|
return Joi.object({
|
|
4562
5118
|
current: Joi.number(),
|
|
4563
5119
|
has_next: Joi.boolean(),
|
|
4564
|
-
|
|
5120
|
+
has_previous: Joi.boolean(),
|
|
5121
|
+
item_total: Joi.number(),
|
|
4565
5122
|
size: Joi.number(),
|
|
5123
|
+
total: Joi.number(),
|
|
4566
5124
|
type: Joi.string().allow(""),
|
|
4567
5125
|
});
|
|
4568
5126
|
}
|
|
@@ -4619,6 +5177,16 @@ class OrderPlatformModel {
|
|
|
4619
5177
|
});
|
|
4620
5178
|
}
|
|
4621
5179
|
|
|
5180
|
+
/** @returns {PDFMeta} */
|
|
5181
|
+
static PDFMeta() {
|
|
5182
|
+
return Joi.object({
|
|
5183
|
+
consent: Joi.string().allow("").allow(null),
|
|
5184
|
+
media_updates: Joi.array().items(
|
|
5185
|
+
OrderPlatformModel.ManifestMediaUpdate()
|
|
5186
|
+
),
|
|
5187
|
+
});
|
|
5188
|
+
}
|
|
5189
|
+
|
|
4622
5190
|
/** @returns {PhoneDetails} */
|
|
4623
5191
|
static PhoneDetails() {
|
|
4624
5192
|
return Joi.object({
|
|
@@ -4709,8 +5277,11 @@ class OrderPlatformModel {
|
|
|
4709
5277
|
OrderPlatformModel.PlatformBreakupValues()
|
|
4710
5278
|
),
|
|
4711
5279
|
channel: OrderPlatformModel.PlatformChannel(),
|
|
5280
|
+
currency: OrderPlatformModel.Currency(),
|
|
5281
|
+
currency_info: OrderPlatformModel.CurrencyInfo(),
|
|
4712
5282
|
meta: Joi.any().allow(null),
|
|
4713
5283
|
order_created_time: Joi.string().allow("").allow(null),
|
|
5284
|
+
order_created_ts: Joi.string().allow("").allow(null),
|
|
4714
5285
|
order_id: Joi.string().allow("").allow(null),
|
|
4715
5286
|
order_value: Joi.number().allow(null),
|
|
4716
5287
|
payment_mode: Joi.string().allow("").allow(null),
|
|
@@ -4740,6 +5311,8 @@ class OrderPlatformModel {
|
|
|
4740
5311
|
company_details: OrderPlatformModel.CompanyDetails(),
|
|
4741
5312
|
coupon: Joi.any().allow(null),
|
|
4742
5313
|
credit_note_id: Joi.string().allow("").allow(null),
|
|
5314
|
+
currency: OrderPlatformModel.Currency(),
|
|
5315
|
+
currency_info: OrderPlatformModel.CurrencyInfo(),
|
|
4743
5316
|
custom_message: Joi.string().allow("").allow(null),
|
|
4744
5317
|
custom_meta: Joi.array().items(Joi.any()),
|
|
4745
5318
|
delivery_details: OrderPlatformModel.UserDetailsData(),
|
|
@@ -4748,6 +5321,7 @@ class OrderPlatformModel {
|
|
|
4748
5321
|
dp_details: OrderPlatformModel.DPDetailsData(),
|
|
4749
5322
|
enable_dp_tracking: Joi.boolean().allow(null),
|
|
4750
5323
|
estimated_sla_time: Joi.string().allow("").allow(null),
|
|
5324
|
+
estimated_sla_ts: Joi.string().allow("").allow(null),
|
|
4751
5325
|
forward_shipment_id: Joi.string().allow("").allow(null),
|
|
4752
5326
|
fulfilling_store: OrderPlatformModel.FulfillingStore(),
|
|
4753
5327
|
fulfilment_priority: Joi.number().allow(null),
|
|
@@ -4775,7 +5349,8 @@ class OrderPlatformModel {
|
|
|
4775
5349
|
priority_text: Joi.string().allow("").allow(null),
|
|
4776
5350
|
rto_address: OrderPlatformModel.PlatformDeliveryAddress(),
|
|
4777
5351
|
shipment_created_at: Joi.string().allow("").allow(null),
|
|
4778
|
-
|
|
5352
|
+
shipment_created_ts: Joi.string().allow("").allow(null),
|
|
5353
|
+
shipment_details: OrderPlatformModel.ShipmentLockDetails(),
|
|
4779
5354
|
shipment_id: Joi.string().allow("").required(),
|
|
4780
5355
|
shipment_images: Joi.array().items(Joi.string().allow("")),
|
|
4781
5356
|
shipment_quantity: Joi.number().allow(null),
|
|
@@ -4823,16 +5398,6 @@ class OrderPlatformModel {
|
|
|
4823
5398
|
});
|
|
4824
5399
|
}
|
|
4825
5400
|
|
|
4826
|
-
/** @returns {PlatformUserDetails} */
|
|
4827
|
-
static PlatformUserDetails() {
|
|
4828
|
-
return Joi.object({
|
|
4829
|
-
platform_user_employee_code: Joi.string().allow("").allow(null),
|
|
4830
|
-
platform_user_first_name: Joi.string().allow("").allow(null),
|
|
4831
|
-
platform_user_id: Joi.string().allow("").allow(null),
|
|
4832
|
-
platform_user_last_name: Joi.string().allow("").allow(null),
|
|
4833
|
-
});
|
|
4834
|
-
}
|
|
4835
|
-
|
|
4836
5401
|
/** @returns {PointBlankOtpData} */
|
|
4837
5402
|
static PointBlankOtpData() {
|
|
4838
5403
|
return Joi.object({
|
|
@@ -4923,6 +5488,36 @@ class OrderPlatformModel {
|
|
|
4923
5488
|
});
|
|
4924
5489
|
}
|
|
4925
5490
|
|
|
5491
|
+
/** @returns {ProcessManifest} */
|
|
5492
|
+
static ProcessManifest() {
|
|
5493
|
+
return Joi.object({
|
|
5494
|
+
action: Joi.string().allow("").required(),
|
|
5495
|
+
filters: OrderPlatformModel.FiltersRequest().required(),
|
|
5496
|
+
manifest_id: Joi.string().allow(""),
|
|
5497
|
+
unique_id: Joi.string().allow("").required(),
|
|
5498
|
+
});
|
|
5499
|
+
}
|
|
5500
|
+
|
|
5501
|
+
/** @returns {ProcessManifestItemResponse} */
|
|
5502
|
+
static ProcessManifestItemResponse() {
|
|
5503
|
+
return Joi.object({
|
|
5504
|
+
items: OrderPlatformModel.ProcessManifestResponse(),
|
|
5505
|
+
});
|
|
5506
|
+
}
|
|
5507
|
+
|
|
5508
|
+
/** @returns {ProcessManifestResponse} */
|
|
5509
|
+
static ProcessManifestResponse() {
|
|
5510
|
+
return Joi.object({
|
|
5511
|
+
action: Joi.string().allow(""),
|
|
5512
|
+
company_id: Joi.number(),
|
|
5513
|
+
created_by: Joi.string().allow(""),
|
|
5514
|
+
filters: OrderPlatformModel.Filters(),
|
|
5515
|
+
manifest_id: Joi.string().allow(""),
|
|
5516
|
+
uid: Joi.string().allow(""),
|
|
5517
|
+
user_id: Joi.string().allow(""),
|
|
5518
|
+
});
|
|
5519
|
+
}
|
|
5520
|
+
|
|
4926
5521
|
/** @returns {Products} */
|
|
4927
5522
|
static Products() {
|
|
4928
5523
|
return Joi.object({
|
|
@@ -5064,15 +5659,6 @@ class OrderPlatformModel {
|
|
|
5064
5659
|
});
|
|
5065
5660
|
}
|
|
5066
5661
|
|
|
5067
|
-
/** @returns {ReturnConfig1} */
|
|
5068
|
-
static ReturnConfig1() {
|
|
5069
|
-
return Joi.object({
|
|
5070
|
-
returnable: Joi.boolean().allow(null),
|
|
5071
|
-
time: Joi.number().allow(null),
|
|
5072
|
-
unit: Joi.string().allow("").allow(null),
|
|
5073
|
-
});
|
|
5074
|
-
}
|
|
5075
|
-
|
|
5076
5662
|
/** @returns {RoleBaseStateTransitionMapping} */
|
|
5077
5663
|
static RoleBaseStateTransitionMapping() {
|
|
5078
5664
|
return Joi.object({
|
|
@@ -5120,6 +5706,26 @@ class OrderPlatformModel {
|
|
|
5120
5706
|
});
|
|
5121
5707
|
}
|
|
5122
5708
|
|
|
5709
|
+
/** @returns {ShipmentActionInfo} */
|
|
5710
|
+
static ShipmentActionInfo() {
|
|
5711
|
+
return Joi.object({
|
|
5712
|
+
failed_invoiced_shipments: Joi.object().pattern(
|
|
5713
|
+
/\S/,
|
|
5714
|
+
Joi.string().allow("")
|
|
5715
|
+
),
|
|
5716
|
+
failed_shipments: Joi.array().items(
|
|
5717
|
+
Joi.object().pattern(/\S/, Joi.string().allow(""))
|
|
5718
|
+
),
|
|
5719
|
+
invoice: Joi.array().items(Joi.string().allow("")),
|
|
5720
|
+
invoiceable_shipments: Joi.array().items(Joi.string().allow("")),
|
|
5721
|
+
label: Joi.array().items(Joi.string().allow("")),
|
|
5722
|
+
processing_invoice_shipments: Joi.array().items(Joi.string().allow("")),
|
|
5723
|
+
processing_shipments: Joi.array().items(Joi.string().allow("")),
|
|
5724
|
+
successful_invoiced_shipments: Joi.array().items(Joi.string().allow("")),
|
|
5725
|
+
successful_shipments: Joi.array().items(Joi.string().allow("")),
|
|
5726
|
+
});
|
|
5727
|
+
}
|
|
5728
|
+
|
|
5123
5729
|
/** @returns {ShipmentBagReasons} */
|
|
5124
5730
|
static ShipmentBagReasons() {
|
|
5125
5731
|
return Joi.object({
|
|
@@ -5166,7 +5772,6 @@ class OrderPlatformModel {
|
|
|
5166
5772
|
/** @returns {ShipmentDetails} */
|
|
5167
5773
|
static ShipmentDetails() {
|
|
5168
5774
|
return Joi.object({
|
|
5169
|
-
action_to_status: Joi.any().allow(null),
|
|
5170
5775
|
affiliate_shipment_id: Joi.string().allow("").required(),
|
|
5171
5776
|
articles: Joi.array()
|
|
5172
5777
|
.items(OrderPlatformModel.ArticleDetails())
|
|
@@ -5174,8 +5779,6 @@ class OrderPlatformModel {
|
|
|
5174
5779
|
box_type: Joi.string().allow("").allow(null),
|
|
5175
5780
|
dp_id: Joi.number().allow(null),
|
|
5176
5781
|
fulfillment_id: Joi.number().required(),
|
|
5177
|
-
lock_message: Joi.string().allow("").allow(null),
|
|
5178
|
-
lock_status: Joi.boolean().allow(null),
|
|
5179
5782
|
meta: Joi.any(),
|
|
5180
5783
|
shipments: Joi.number().required(),
|
|
5181
5784
|
});
|
|
@@ -5218,15 +5821,19 @@ class OrderPlatformModel {
|
|
|
5218
5821
|
bags: Joi.array().items(OrderPlatformModel.BagUnit()),
|
|
5219
5822
|
can_process: Joi.boolean().allow(null),
|
|
5220
5823
|
channel: OrderPlatformModel.ShipmentListingChannel(),
|
|
5824
|
+
currency: OrderPlatformModel.Currency(),
|
|
5825
|
+
currency_info: OrderPlatformModel.CurrencyInfo(),
|
|
5221
5826
|
customer_note: Joi.string().allow("").allow(null),
|
|
5222
5827
|
delivery_address: OrderPlatformModel.PlatformDeliveryAddress(),
|
|
5223
5828
|
display_name: Joi.string().allow("").allow(null),
|
|
5224
5829
|
estimated_sla_time: Joi.string().allow("").allow(null),
|
|
5830
|
+
estimated_sla_ts: Joi.string().allow("").allow(null),
|
|
5225
5831
|
fulfilling_store: OrderPlatformModel.ShipmentItemFulFillingStore(),
|
|
5226
5832
|
invoice_id: Joi.string().allow("").allow(null),
|
|
5227
5833
|
lock_status: Joi.boolean().allow(null),
|
|
5228
5834
|
meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
5229
5835
|
mode_of_payment: Joi.string().allow(""),
|
|
5836
|
+
order_created_ts: Joi.string().allow("").allow(null),
|
|
5230
5837
|
order_date: Joi.string().allow("").allow(null),
|
|
5231
5838
|
order_id: Joi.string().allow("").required(),
|
|
5232
5839
|
ordering_channnel: Joi.string().allow("").allow(null),
|
|
@@ -5235,9 +5842,11 @@ class OrderPlatformModel {
|
|
|
5235
5842
|
previous_shipment_id: Joi.string().allow("").allow(null),
|
|
5236
5843
|
prices: OrderPlatformModel.Prices(),
|
|
5237
5844
|
shipment_created_at: Joi.string().allow("").required(),
|
|
5845
|
+
shipment_created_ts: Joi.string().allow(""),
|
|
5238
5846
|
shipment_id: Joi.string().allow("").allow(null),
|
|
5239
5847
|
shipment_status: OrderPlatformModel.ShipmentStatus(),
|
|
5240
5848
|
status_created_at: Joi.string().allow(""),
|
|
5849
|
+
status_created_ts: Joi.string().allow(""),
|
|
5241
5850
|
total_bags: Joi.number().allow(null).required(),
|
|
5242
5851
|
user: OrderPlatformModel.UserDataInfo(),
|
|
5243
5852
|
});
|
|
@@ -5247,7 +5856,7 @@ class OrderPlatformModel {
|
|
|
5247
5856
|
static ShipmentItemFulFillingStore() {
|
|
5248
5857
|
return Joi.object({
|
|
5249
5858
|
address: Joi.string().allow("").allow(null),
|
|
5250
|
-
brand_store_tags: Joi.string().allow("")
|
|
5859
|
+
brand_store_tags: Joi.array().items(Joi.string().allow("")),
|
|
5251
5860
|
city: Joi.string().allow("").allow(null),
|
|
5252
5861
|
code: Joi.string().allow("").required(),
|
|
5253
5862
|
id: Joi.number().required(),
|
|
@@ -5258,42 +5867,7 @@ class OrderPlatformModel {
|
|
|
5258
5867
|
pincode: Joi.string().allow("").allow(null),
|
|
5259
5868
|
state: Joi.string().allow("").allow(null),
|
|
5260
5869
|
store_email: Joi.string().allow("").allow(null),
|
|
5261
|
-
|
|
5262
|
-
}
|
|
5263
|
-
|
|
5264
|
-
/** @returns {ShipmentItemMeta} */
|
|
5265
|
-
static ShipmentItemMeta() {
|
|
5266
|
-
return Joi.object({
|
|
5267
|
-
activity_comment: Joi.string().allow("").allow(null),
|
|
5268
|
-
assign_dp_from_sb: Joi.boolean().allow(null),
|
|
5269
|
-
auto_trigger_dp_assignment_acf: Joi.boolean().required(),
|
|
5270
|
-
bag_weight: Joi.any().allow(null),
|
|
5271
|
-
debug_info: Joi.any().allow(null),
|
|
5272
|
-
dp_options: Joi.any().allow(null),
|
|
5273
|
-
dp_sort_key: Joi.string().allow("").allow(null),
|
|
5274
|
-
ewaybill_info: Joi.any().allow(null),
|
|
5275
|
-
existing_dp_list: Joi.array().items(Joi.string().allow("")),
|
|
5276
|
-
external: Joi.any().allow(null),
|
|
5277
|
-
formatted: OrderPlatformModel.Formatted(),
|
|
5278
|
-
fulfilment_priority_text: Joi.string().allow("").allow(null),
|
|
5279
|
-
is_international: Joi.boolean().allow(null),
|
|
5280
|
-
is_self_ship: Joi.boolean().allow(null),
|
|
5281
|
-
lock_data: OrderPlatformModel.LockData(),
|
|
5282
|
-
order_type: Joi.string().allow("").allow(null),
|
|
5283
|
-
packaging_name: Joi.string().allow("").allow(null),
|
|
5284
|
-
parent_dp_id: Joi.string().allow("").allow(null),
|
|
5285
|
-
pdf_media: Joi.array().items(Joi.any()),
|
|
5286
|
-
same_store_available: Joi.boolean().allow(null),
|
|
5287
|
-
shipment_chargeable_weight: Joi.number().allow(null),
|
|
5288
|
-
shipment_tags: Joi.array().items(OrderPlatformModel.ShipmentTags()),
|
|
5289
|
-
shipment_volumetric_weight: Joi.number().allow(null),
|
|
5290
|
-
shipment_weight: Joi.number().allow(null),
|
|
5291
|
-
shipping_zone: Joi.string().allow("").allow(null),
|
|
5292
|
-
sla: Joi.number().allow(null),
|
|
5293
|
-
store_invoice_updated_date: Joi.string().allow("").allow(null),
|
|
5294
|
-
tags: Joi.array().items(Joi.any()),
|
|
5295
|
-
timestamp: OrderPlatformModel.ShipmentTimeStamp(),
|
|
5296
|
-
weight: Joi.number().allow(null),
|
|
5870
|
+
tags: Joi.array().items(Joi.string().allow("")),
|
|
5297
5871
|
});
|
|
5298
5872
|
}
|
|
5299
5873
|
|
|
@@ -5317,6 +5891,15 @@ class OrderPlatformModel {
|
|
|
5317
5891
|
});
|
|
5318
5892
|
}
|
|
5319
5893
|
|
|
5894
|
+
/** @returns {ShipmentLockDetails} */
|
|
5895
|
+
static ShipmentLockDetails() {
|
|
5896
|
+
return Joi.object({
|
|
5897
|
+
action_to_status: Joi.any().allow(null),
|
|
5898
|
+
lock_message: Joi.string().allow("").allow(null),
|
|
5899
|
+
lock_status: Joi.boolean().allow(null),
|
|
5900
|
+
});
|
|
5901
|
+
}
|
|
5902
|
+
|
|
5320
5903
|
/** @returns {ShipmentMeta} */
|
|
5321
5904
|
static ShipmentMeta() {
|
|
5322
5905
|
return Joi.object({
|
|
@@ -5423,12 +6006,14 @@ class OrderPlatformModel {
|
|
|
5423
6006
|
return Joi.object({
|
|
5424
6007
|
bag_list: Joi.array().items(Joi.string().allow("")),
|
|
5425
6008
|
created_at: Joi.string().allow("").allow(null),
|
|
6009
|
+
created_ts: Joi.string().allow("").allow(null),
|
|
5426
6010
|
current_shipment_status: Joi.string().allow("").allow(null),
|
|
5427
6011
|
meta: Joi.any().allow(null),
|
|
5428
6012
|
shipment_id: Joi.string().allow("").allow(null),
|
|
5429
6013
|
shipment_status_id: Joi.number().allow(null),
|
|
5430
|
-
status: Joi.string().allow("").required(),
|
|
6014
|
+
status: Joi.string().allow("").allow(null).required(),
|
|
5431
6015
|
status_created_at: Joi.string().allow("").allow(null),
|
|
6016
|
+
status_created_ts: Joi.string().allow("").allow(null),
|
|
5432
6017
|
title: Joi.string().allow("").required(),
|
|
5433
6018
|
});
|
|
5434
6019
|
}
|
|
@@ -5438,6 +6023,7 @@ class OrderPlatformModel {
|
|
|
5438
6023
|
return Joi.object({
|
|
5439
6024
|
bag_list: Joi.array().items(Joi.string().allow("")),
|
|
5440
6025
|
created_at: Joi.string().allow("").allow(null),
|
|
6026
|
+
created_ts: Joi.string().allow("").allow(null),
|
|
5441
6027
|
current_shipment_status: Joi.string().allow("").allow(null),
|
|
5442
6028
|
display_name: Joi.string().allow("").allow(null),
|
|
5443
6029
|
id: Joi.number().allow(null),
|
|
@@ -5467,17 +6053,18 @@ class OrderPlatformModel {
|
|
|
5467
6053
|
/** @returns {ShippingInfo} */
|
|
5468
6054
|
static ShippingInfo() {
|
|
5469
6055
|
return Joi.object({
|
|
6056
|
+
address: Joi.string().allow(""),
|
|
5470
6057
|
address_type: Joi.string().allow(""),
|
|
5471
|
-
address1: Joi.string().allow("")
|
|
6058
|
+
address1: Joi.string().allow(""),
|
|
5472
6059
|
address2: Joi.string().allow(""),
|
|
5473
6060
|
alternate_email: Joi.string().allow(""),
|
|
5474
6061
|
alternate_mobile_number: Joi.string().allow(""),
|
|
5475
|
-
city: Joi.string().allow("")
|
|
5476
|
-
country: Joi.string().allow("")
|
|
6062
|
+
city: Joi.string().allow(""),
|
|
6063
|
+
country: Joi.string().allow(""),
|
|
5477
6064
|
country_code: Joi.string().allow(""),
|
|
5478
6065
|
customer_code: Joi.string().allow(""),
|
|
5479
6066
|
external_customer_code: Joi.string().allow(""),
|
|
5480
|
-
first_name: Joi.string().allow("")
|
|
6067
|
+
first_name: Joi.string().allow(""),
|
|
5481
6068
|
floor_no: Joi.string().allow(""),
|
|
5482
6069
|
gender: Joi.string().allow(""),
|
|
5483
6070
|
geo_location: Joi.any(),
|
|
@@ -5485,12 +6072,12 @@ class OrderPlatformModel {
|
|
|
5485
6072
|
landmark: Joi.string().allow(""),
|
|
5486
6073
|
last_name: Joi.string().allow(""),
|
|
5487
6074
|
middle_name: Joi.string().allow(""),
|
|
5488
|
-
pincode: Joi.string().allow("")
|
|
5489
|
-
primary_email: Joi.string().allow("")
|
|
5490
|
-
primary_mobile_number: Joi.string().allow("")
|
|
6075
|
+
pincode: Joi.string().allow(""),
|
|
6076
|
+
primary_email: Joi.string().allow(""),
|
|
6077
|
+
primary_mobile_number: Joi.string().allow(""),
|
|
5491
6078
|
shipping_type: Joi.string().allow(""),
|
|
5492
6079
|
slot: Joi.array().items(Joi.any()),
|
|
5493
|
-
state: Joi.string().allow("")
|
|
6080
|
+
state: Joi.string().allow(""),
|
|
5494
6081
|
state_code: Joi.string().allow(""),
|
|
5495
6082
|
title: Joi.string().allow(""),
|
|
5496
6083
|
});
|
|
@@ -5511,6 +6098,58 @@ class OrderPlatformModel {
|
|
|
5511
6098
|
});
|
|
5512
6099
|
}
|
|
5513
6100
|
|
|
6101
|
+
/** @returns {StateManagerFilter} */
|
|
6102
|
+
static StateManagerFilter() {
|
|
6103
|
+
return Joi.object({
|
|
6104
|
+
default_value: Joi.string().allow(""),
|
|
6105
|
+
description: Joi.string().allow(""),
|
|
6106
|
+
display_name: Joi.string().allow(""),
|
|
6107
|
+
id: Joi.number(),
|
|
6108
|
+
name: Joi.string().allow(""),
|
|
6109
|
+
options: Joi.object().pattern(/\S/, Joi.any()),
|
|
6110
|
+
type: Joi.string().allow(""),
|
|
6111
|
+
});
|
|
6112
|
+
}
|
|
6113
|
+
|
|
6114
|
+
/** @returns {StateManagerState} */
|
|
6115
|
+
static StateManagerState() {
|
|
6116
|
+
return Joi.object({
|
|
6117
|
+
app_display_name: Joi.string().allow(""),
|
|
6118
|
+
app_facing: Joi.boolean(),
|
|
6119
|
+
id: Joi.number(),
|
|
6120
|
+
is_active: Joi.boolean(),
|
|
6121
|
+
journey_type: Joi.string().allow(""),
|
|
6122
|
+
platform_display_name: Joi.string().allow(""),
|
|
6123
|
+
state: Joi.string().allow(""),
|
|
6124
|
+
state_type: Joi.string().allow(""),
|
|
6125
|
+
});
|
|
6126
|
+
}
|
|
6127
|
+
|
|
6128
|
+
/** @returns {StateManagerTask} */
|
|
6129
|
+
static StateManagerTask() {
|
|
6130
|
+
return Joi.object({
|
|
6131
|
+
description: Joi.string().allow(""),
|
|
6132
|
+
display_name: Joi.string().allow(""),
|
|
6133
|
+
doc_string: Joi.string().allow(""),
|
|
6134
|
+
id: Joi.number(),
|
|
6135
|
+
kwargs: Joi.any(),
|
|
6136
|
+
name: Joi.string().allow(""),
|
|
6137
|
+
});
|
|
6138
|
+
}
|
|
6139
|
+
|
|
6140
|
+
/** @returns {StateTransitionFlag} */
|
|
6141
|
+
static StateTransitionFlag() {
|
|
6142
|
+
return Joi.object({
|
|
6143
|
+
default_value: Joi.string().allow(""),
|
|
6144
|
+
description: Joi.string().allow(""),
|
|
6145
|
+
display_name: Joi.string().allow(""),
|
|
6146
|
+
id: Joi.number(),
|
|
6147
|
+
name: Joi.string().allow(""),
|
|
6148
|
+
options: Joi.object().pattern(/\S/, Joi.any()),
|
|
6149
|
+
type: Joi.string().allow(""),
|
|
6150
|
+
});
|
|
6151
|
+
}
|
|
6152
|
+
|
|
5514
6153
|
/** @returns {StatuesRequest} */
|
|
5515
6154
|
static StatuesRequest() {
|
|
5516
6155
|
return Joi.object({
|
|
@@ -5723,9 +6362,34 @@ class OrderPlatformModel {
|
|
|
5723
6362
|
});
|
|
5724
6363
|
}
|
|
5725
6364
|
|
|
6365
|
+
/** @returns {TemplateDownloadResponse} */
|
|
6366
|
+
static TemplateDownloadResponse() {
|
|
6367
|
+
return Joi.object({
|
|
6368
|
+
file_name: Joi.string().allow(""),
|
|
6369
|
+
url: Joi.string().allow(""),
|
|
6370
|
+
});
|
|
6371
|
+
}
|
|
6372
|
+
|
|
6373
|
+
/** @returns {Templates} */
|
|
6374
|
+
static Templates() {
|
|
6375
|
+
return Joi.object({
|
|
6376
|
+
text: Joi.string().allow(""),
|
|
6377
|
+
value: Joi.string().allow(""),
|
|
6378
|
+
});
|
|
6379
|
+
}
|
|
6380
|
+
|
|
6381
|
+
/** @returns {TotalShipmentPricesCount} */
|
|
6382
|
+
static TotalShipmentPricesCount() {
|
|
6383
|
+
return Joi.object({
|
|
6384
|
+
shipment_count: Joi.number(),
|
|
6385
|
+
total_price: Joi.number(),
|
|
6386
|
+
});
|
|
6387
|
+
}
|
|
6388
|
+
|
|
5726
6389
|
/** @returns {TrackingList} */
|
|
5727
6390
|
static TrackingList() {
|
|
5728
6391
|
return Joi.object({
|
|
6392
|
+
created_ts: Joi.string().allow("").allow(null),
|
|
5729
6393
|
is_current: Joi.boolean().allow(null),
|
|
5730
6394
|
is_passed: Joi.boolean().allow(null),
|
|
5731
6395
|
status: Joi.string().allow("").required(),
|
|
@@ -5734,20 +6398,6 @@ class OrderPlatformModel {
|
|
|
5734
6398
|
});
|
|
5735
6399
|
}
|
|
5736
6400
|
|
|
5737
|
-
/** @returns {TransactionData} */
|
|
5738
|
-
static TransactionData() {
|
|
5739
|
-
return Joi.object({
|
|
5740
|
-
amount_paid: Joi.number().allow(null),
|
|
5741
|
-
currency: Joi.string().allow("").allow(null),
|
|
5742
|
-
entity: Joi.string().allow("").allow(null),
|
|
5743
|
-
payment_id: Joi.string().allow("").allow(null),
|
|
5744
|
-
status: Joi.string().allow("").allow(null),
|
|
5745
|
-
terminal_id: Joi.string().allow("").allow(null),
|
|
5746
|
-
transaction_id: Joi.string().allow("").allow(null),
|
|
5747
|
-
unique_reference_number: Joi.string().allow("").allow(null),
|
|
5748
|
-
});
|
|
5749
|
-
}
|
|
5750
|
-
|
|
5751
6401
|
/** @returns {UpdatePackagingDimensionsPayload} */
|
|
5752
6402
|
static UpdatePackagingDimensionsPayload() {
|
|
5753
6403
|
return Joi.object({
|
|
@@ -5850,12 +6500,15 @@ class OrderPlatformModel {
|
|
|
5850
6500
|
area: Joi.string().allow("").allow(null),
|
|
5851
6501
|
city: Joi.string().allow("").required(),
|
|
5852
6502
|
country: Joi.string().allow("").required(),
|
|
6503
|
+
country_iso_code: Joi.string().allow(""),
|
|
6504
|
+
country_phone_code: Joi.string().allow(""),
|
|
5853
6505
|
email: Joi.string().allow("").allow(null),
|
|
5854
6506
|
landmark: Joi.string().allow("").allow(null),
|
|
5855
6507
|
name: Joi.string().allow("").required(),
|
|
5856
6508
|
phone: Joi.string().allow("").required(),
|
|
5857
6509
|
pincode: Joi.string().allow("").required(),
|
|
5858
6510
|
state: Joi.string().allow("").required(),
|
|
6511
|
+
state_code: Joi.string().allow(""),
|
|
5859
6512
|
});
|
|
5860
6513
|
}
|
|
5861
6514
|
|