@gofynd/fdk-client-javascript 1.4.0-beta.1 → 1.4.0-beta.2
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/CartApplicationModel.d.ts +2 -0
- package/sdk/application/Cart/CartApplicationModel.js +2 -0
- package/sdk/application/Order/OrderApplicationModel.d.ts +2 -0
- package/sdk/application/Order/OrderApplicationModel.js +2 -0
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +185 -315
- package/sdk/partner/Theme/ThemePartnerModel.js +182 -222
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +2 -12
- package/sdk/platform/Catalog/CatalogPlatformClient.js +17 -87
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +11 -25
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +4 -17
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +4 -1
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +5 -0
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +2 -0
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +2 -0
- package/sdk/platform/Discount/DiscountPlatformModel.js +2 -0
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +116 -44
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +120 -54
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +0 -12
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +0 -85
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +1 -12
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +0 -14
- package/sdk/platform/Order/OrderPlatformClient.d.ts +11 -61
- package/sdk/platform/Order/OrderPlatformClient.js +87 -481
- package/sdk/platform/Order/OrderPlatformModel.d.ts +442 -171
- package/sdk/platform/Order/OrderPlatformModel.js +483 -169
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +22 -69
- package/sdk/platform/Order/OrderPlatformValidator.js +17 -79
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +103 -21
- package/sdk/platform/Theme/ThemePlatformModel.js +108 -20
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +2 -2
- package/sdk/platform/Webhook/WebhookPlatformClient.js +4 -2
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +21 -27
- package/sdk/platform/Webhook/WebhookPlatformModel.js +30 -27
|
@@ -294,46 +294,89 @@ const Joi = require("joi");
|
|
|
294
294
|
*/
|
|
295
295
|
|
|
296
296
|
/**
|
|
297
|
-
* @typedef
|
|
297
|
+
* @typedef BagData
|
|
298
|
+
* @property {BagDetails[]} [items]
|
|
299
|
+
* @property {BagsPage} [page]
|
|
300
|
+
*/
|
|
301
|
+
|
|
302
|
+
/**
|
|
303
|
+
* @typedef BagDetails
|
|
298
304
|
* @property {AffiliateBagDetails} [affiliate_bag_details]
|
|
299
305
|
* @property {AffiliateDetails} [affiliate_details]
|
|
300
306
|
* @property {Object[]} [applied_promos]
|
|
301
307
|
* @property {Article} [article]
|
|
302
308
|
* @property {ArticleStatusDetails} [article_details]
|
|
309
|
+
* @property {number} [bag_id]
|
|
303
310
|
* @property {BagStatusHistory[]} [bag_status]
|
|
304
311
|
* @property {BagStatusHistory} [bag_status_history]
|
|
305
312
|
* @property {number} [bag_update_time]
|
|
306
313
|
* @property {Brand} [brand]
|
|
314
|
+
* @property {Company} [company]
|
|
307
315
|
* @property {BagStatusHistory} [current_operational_status]
|
|
308
316
|
* @property {BagStatusHistory} [current_status]
|
|
309
317
|
* @property {Dates} [dates]
|
|
318
|
+
* @property {PlatformDeliveryAddress} [delivery_address]
|
|
319
|
+
* @property {DeliverySlotDetails} [delivery_slot]
|
|
310
320
|
* @property {string} [display_name]
|
|
321
|
+
* @property {Object} [dp_details]
|
|
322
|
+
* @property {Object} [einvoice_info]
|
|
311
323
|
* @property {string} [entity_type]
|
|
324
|
+
* @property {Object} [fallback_user]
|
|
312
325
|
* @property {FinancialBreakup[]} [financial_breakup]
|
|
326
|
+
* @property {Store} [fulfilling_store]
|
|
327
|
+
* @property {Object} [fyndstore_emp]
|
|
313
328
|
* @property {GSTDetailsData} [gst_details]
|
|
314
|
-
* @property {
|
|
329
|
+
* @property {string} [id]
|
|
315
330
|
* @property {string} [identifier]
|
|
331
|
+
* @property {InvoiceDetails} [invoice]
|
|
316
332
|
* @property {Item} [item]
|
|
317
333
|
* @property {string} [journey_type]
|
|
318
334
|
* @property {number} [line_number]
|
|
335
|
+
* @property {boolean} [lock_status]
|
|
336
|
+
* @property {string} [manifest_id]
|
|
319
337
|
* @property {Object} [meta]
|
|
338
|
+
* @property {string} [mode_of_payment]
|
|
320
339
|
* @property {number} [no_of_bags_order]
|
|
321
340
|
* @property {string} [operational_status]
|
|
341
|
+
* @property {OrderDetails} [order]
|
|
322
342
|
* @property {string} [order_integration_id]
|
|
343
|
+
* @property {string} [order_type]
|
|
344
|
+
* @property {number} [order_value]
|
|
323
345
|
* @property {Store} [ordering_store]
|
|
324
346
|
* @property {number[]} [original_bag_list]
|
|
325
347
|
* @property {Object} [parent_promo_bags]
|
|
348
|
+
* @property {Object} [payment_methods]
|
|
349
|
+
* @property {string} [payment_type]
|
|
350
|
+
* @property {Object} [payments]
|
|
326
351
|
* @property {Prices} [prices]
|
|
327
|
-
* @property {
|
|
352
|
+
* @property {boolean} [qc_required]
|
|
328
353
|
* @property {number} [quantity]
|
|
329
354
|
* @property {Object[]} [reasons]
|
|
330
355
|
* @property {boolean} [restore_coupon]
|
|
331
356
|
* @property {Object} [restore_promos]
|
|
357
|
+
* @property {PlatformDeliveryAddress} [rto_address]
|
|
332
358
|
* @property {string} [seller_identifier]
|
|
359
|
+
* @property {Shipment} [shipment]
|
|
360
|
+
* @property {ShipmentDetails} [shipment_details]
|
|
361
|
+
* @property {ShipmentGstDetails} [shipment_gst]
|
|
333
362
|
* @property {string} [shipment_id]
|
|
363
|
+
* @property {ShipmentStatusData} [shipment_status]
|
|
364
|
+
* @property {ShipmentStatusData[]} [shipment_status_history]
|
|
334
365
|
* @property {BagReturnableCancelableStatus} [status]
|
|
335
366
|
* @property {string[]} [tags]
|
|
367
|
+
* @property {number} [total_shipment_bags]
|
|
368
|
+
* @property {number} [total_shipments_in_order]
|
|
369
|
+
* @property {string} [transaction_type]
|
|
336
370
|
* @property {string} [type]
|
|
371
|
+
* @property {string} [updated_at]
|
|
372
|
+
* @property {UserDetails} [user]
|
|
373
|
+
* @property {WeightData} [weight]
|
|
374
|
+
*/
|
|
375
|
+
|
|
376
|
+
/**
|
|
377
|
+
* @typedef BagDetailsPlatformResponse
|
|
378
|
+
* @property {BagDetails} [data]
|
|
379
|
+
* @property {number} [status_code]
|
|
337
380
|
*/
|
|
338
381
|
|
|
339
382
|
/**
|
|
@@ -469,15 +512,18 @@ const Joi = require("joi");
|
|
|
469
512
|
* @property {string} [address2]
|
|
470
513
|
* @property {string} [alternate_email]
|
|
471
514
|
* @property {string} [alternate_mobile_number]
|
|
515
|
+
* @property {string} [area]
|
|
472
516
|
* @property {string} [city]
|
|
473
517
|
* @property {string} [country]
|
|
474
518
|
* @property {string} [country_code]
|
|
519
|
+
* @property {string} [country_iso_code] - Country Code in ISO 2 format (e.g. US, IN)
|
|
475
520
|
* @property {string} [customer_code]
|
|
476
521
|
* @property {string} [external_customer_code]
|
|
477
522
|
* @property {string} [first_name]
|
|
478
523
|
* @property {string} [floor_no]
|
|
479
524
|
* @property {string} [gender]
|
|
480
525
|
* @property {string} [house_no]
|
|
526
|
+
* @property {string} [landmark]
|
|
481
527
|
* @property {string} [last_name]
|
|
482
528
|
* @property {string} [middle_name]
|
|
483
529
|
* @property {string} [pincode]
|
|
@@ -490,12 +536,13 @@ const Joi = require("joi");
|
|
|
490
536
|
|
|
491
537
|
/**
|
|
492
538
|
* @typedef Brand
|
|
493
|
-
* @property {number} brand_id
|
|
539
|
+
* @property {number} [brand_id]
|
|
494
540
|
* @property {string} brand_name
|
|
495
|
-
* @property {string} company
|
|
496
|
-
* @property {
|
|
541
|
+
* @property {string} [company]
|
|
542
|
+
* @property {string} [created_on]
|
|
497
543
|
* @property {boolean} [credit_note_allowed]
|
|
498
544
|
* @property {number} [credit_note_expiry_days]
|
|
545
|
+
* @property {number} [id]
|
|
499
546
|
* @property {string} [invoice_prefix]
|
|
500
547
|
* @property {boolean} [is_virtual_invoice]
|
|
501
548
|
* @property {string} [logo]
|
|
@@ -649,6 +696,20 @@ const Joi = require("joi");
|
|
|
649
696
|
* @property {boolean} success - Success
|
|
650
697
|
*/
|
|
651
698
|
|
|
699
|
+
/**
|
|
700
|
+
* @typedef Company
|
|
701
|
+
* @property {string} [agreement_start_date]
|
|
702
|
+
* @property {string} [business_type]
|
|
703
|
+
* @property {string} [company_name]
|
|
704
|
+
* @property {string} [company_type]
|
|
705
|
+
* @property {string} [created_on]
|
|
706
|
+
* @property {string} [gst_number]
|
|
707
|
+
* @property {number} [id]
|
|
708
|
+
* @property {Object} [meta]
|
|
709
|
+
* @property {string} [modified_on]
|
|
710
|
+
* @property {string} [pan_no]
|
|
711
|
+
*/
|
|
712
|
+
|
|
652
713
|
/**
|
|
653
714
|
* @typedef CompanyDetails
|
|
654
715
|
* @property {Object} [address]
|
|
@@ -832,6 +893,15 @@ const Joi = require("joi");
|
|
|
832
893
|
* @property {string} [stormbreaker_uuid]
|
|
833
894
|
*/
|
|
834
895
|
|
|
896
|
+
/**
|
|
897
|
+
* @typedef DeliverySlotDetails
|
|
898
|
+
* @property {string} [date]
|
|
899
|
+
* @property {string} [lower_bound]
|
|
900
|
+
* @property {string} [slot]
|
|
901
|
+
* @property {string} [type]
|
|
902
|
+
* @property {string} [upper_bound]
|
|
903
|
+
*/
|
|
904
|
+
|
|
835
905
|
/**
|
|
836
906
|
* @typedef Dimension
|
|
837
907
|
* @property {string} [height]
|
|
@@ -1161,10 +1231,12 @@ const Joi = require("joi");
|
|
|
1161
1231
|
/**
|
|
1162
1232
|
* @typedef FulfillingStore
|
|
1163
1233
|
* @property {string} address
|
|
1234
|
+
* @property {string} [address1]
|
|
1164
1235
|
* @property {string} city
|
|
1165
1236
|
* @property {string} code
|
|
1166
1237
|
* @property {string} contact_person
|
|
1167
1238
|
* @property {string} country
|
|
1239
|
+
* @property {string} [display_address]
|
|
1168
1240
|
* @property {string} fulfillment_channel
|
|
1169
1241
|
* @property {number} id
|
|
1170
1242
|
* @property {Object} meta
|
|
@@ -1179,6 +1251,37 @@ const Joi = require("joi");
|
|
|
1179
1251
|
* @property {string[]} [fynd_order_id]
|
|
1180
1252
|
*/
|
|
1181
1253
|
|
|
1254
|
+
/**
|
|
1255
|
+
* @typedef GenerateInvoiceIDErrorResponse
|
|
1256
|
+
* @property {GenerateInvoiceIDErrorResponseData[]} [items]
|
|
1257
|
+
*/
|
|
1258
|
+
|
|
1259
|
+
/**
|
|
1260
|
+
* @typedef GenerateInvoiceIDErrorResponseData
|
|
1261
|
+
* @property {string} [error_message]
|
|
1262
|
+
* @property {boolean} [invoice_id]
|
|
1263
|
+
* @property {string} [shipment_id]
|
|
1264
|
+
* @property {boolean} [success]
|
|
1265
|
+
*/
|
|
1266
|
+
|
|
1267
|
+
/**
|
|
1268
|
+
* @typedef GenerateInvoiceIDRequest
|
|
1269
|
+
* @property {string[]} shipment_ids
|
|
1270
|
+
*/
|
|
1271
|
+
|
|
1272
|
+
/**
|
|
1273
|
+
* @typedef GenerateInvoiceIDResponse
|
|
1274
|
+
* @property {GenerateInvoiceIDResponseData[]} [items]
|
|
1275
|
+
*/
|
|
1276
|
+
|
|
1277
|
+
/**
|
|
1278
|
+
* @typedef GenerateInvoiceIDResponseData
|
|
1279
|
+
* @property {boolean} [error_message]
|
|
1280
|
+
* @property {string} [invoice_id]
|
|
1281
|
+
* @property {string} [shipment_id]
|
|
1282
|
+
* @property {boolean} [success]
|
|
1283
|
+
*/
|
|
1284
|
+
|
|
1182
1285
|
/**
|
|
1183
1286
|
* @typedef GeneratePosOrderReceiptResponse
|
|
1184
1287
|
* @property {string} [customer_cn_receipt]
|
|
@@ -1199,8 +1302,8 @@ const Joi = require("joi");
|
|
|
1199
1302
|
|
|
1200
1303
|
/**
|
|
1201
1304
|
* @typedef GetBagsPlatformResponse
|
|
1202
|
-
* @property {
|
|
1203
|
-
* @property {
|
|
1305
|
+
* @property {BagData} [data]
|
|
1306
|
+
* @property {number} [status_code]
|
|
1204
1307
|
*/
|
|
1205
1308
|
|
|
1206
1309
|
/**
|
|
@@ -1309,6 +1412,14 @@ const Joi = require("joi");
|
|
|
1309
1412
|
* @property {InvalidateShipmentCacheNestedResponse[]} [response]
|
|
1310
1413
|
*/
|
|
1311
1414
|
|
|
1415
|
+
/**
|
|
1416
|
+
* @typedef InvoiceDetails
|
|
1417
|
+
* @property {string} [invoice_url]
|
|
1418
|
+
* @property {string} [label_url]
|
|
1419
|
+
* @property {string} [store_invoice_id]
|
|
1420
|
+
* @property {string} [updated_date]
|
|
1421
|
+
*/
|
|
1422
|
+
|
|
1312
1423
|
/**
|
|
1313
1424
|
* @typedef InvoiceInfo
|
|
1314
1425
|
* @property {string} [credit_note_id]
|
|
@@ -1601,8 +1712,37 @@ const Joi = require("joi");
|
|
|
1601
1712
|
|
|
1602
1713
|
/**
|
|
1603
1714
|
* @typedef OrderDetails
|
|
1715
|
+
* @property {string} [affiliate_id]
|
|
1716
|
+
* @property {string} [affiliate_order_date]
|
|
1717
|
+
* @property {string} [affiliate_order_id]
|
|
1718
|
+
* @property {number} [cashback_applied]
|
|
1719
|
+
* @property {number} [cashback_value]
|
|
1720
|
+
* @property {number} [cod_charges]
|
|
1721
|
+
* @property {string} [collect_by]
|
|
1722
|
+
* @property {number} [coupon_value]
|
|
1604
1723
|
* @property {string} [created_at]
|
|
1724
|
+
* @property {string} [created_time]
|
|
1725
|
+
* @property {string} [currency]
|
|
1726
|
+
* @property {number} [delivery_charges]
|
|
1727
|
+
* @property {number} [discount]
|
|
1728
|
+
* @property {number} [fynd_credits]
|
|
1605
1729
|
* @property {string} [fynd_order_id]
|
|
1730
|
+
* @property {Object} [headers]
|
|
1731
|
+
* @property {Object} [meta]
|
|
1732
|
+
* @property {string} [mode_of_payment]
|
|
1733
|
+
* @property {number} [mongo_cart_id]
|
|
1734
|
+
* @property {number} [order_value]
|
|
1735
|
+
* @property {string} [ordering_channel]
|
|
1736
|
+
* @property {string} [ordering_channel_logo]
|
|
1737
|
+
* @property {Object} [payment_methods]
|
|
1738
|
+
* @property {number} [payment_mode_id]
|
|
1739
|
+
* @property {Prices} [prices]
|
|
1740
|
+
* @property {number} [promotion_effective_discount]
|
|
1741
|
+
* @property {string} [refund_by]
|
|
1742
|
+
* @property {TaxDetails} [tax_details]
|
|
1743
|
+
* @property {number} [total_order_value]
|
|
1744
|
+
* @property {string} [transaction_id]
|
|
1745
|
+
* @property {string} [user_id]
|
|
1606
1746
|
*/
|
|
1607
1747
|
|
|
1608
1748
|
/**
|
|
@@ -1657,10 +1797,12 @@ const Joi = require("joi");
|
|
|
1657
1797
|
/**
|
|
1658
1798
|
* @typedef OrderingStoreDetails
|
|
1659
1799
|
* @property {string} [address]
|
|
1800
|
+
* @property {string} [address1]
|
|
1660
1801
|
* @property {string} [city]
|
|
1661
1802
|
* @property {string} [code]
|
|
1662
1803
|
* @property {string} [contact_person]
|
|
1663
1804
|
* @property {string} [country]
|
|
1805
|
+
* @property {string} [display_address]
|
|
1664
1806
|
* @property {number} [id]
|
|
1665
1807
|
* @property {Object} [meta]
|
|
1666
1808
|
* @property {string} [phone]
|
|
@@ -1755,23 +1897,6 @@ const Joi = require("joi");
|
|
|
1755
1897
|
* @property {string} [type] - Type of the page
|
|
1756
1898
|
*/
|
|
1757
1899
|
|
|
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
|
-
|
|
1775
1900
|
/**
|
|
1776
1901
|
* @typedef PaymentInfo
|
|
1777
1902
|
* @property {PaymentMethod[]} [payment_methods]
|
|
@@ -1857,6 +1982,7 @@ const Joi = require("joi");
|
|
|
1857
1982
|
* @property {string} [contact_person]
|
|
1858
1983
|
* @property {string} [country]
|
|
1859
1984
|
* @property {string} [created_at]
|
|
1985
|
+
* @property {string} [display_address]
|
|
1860
1986
|
* @property {string} [email]
|
|
1861
1987
|
* @property {string} [landmark]
|
|
1862
1988
|
* @property {number} [latitude]
|
|
@@ -2239,13 +2365,40 @@ const Joi = require("joi");
|
|
|
2239
2365
|
|
|
2240
2366
|
/**
|
|
2241
2367
|
* @typedef Shipment
|
|
2368
|
+
* @property {string} [affiliate_id]
|
|
2369
|
+
* @property {string} [affiliate_shipment_id]
|
|
2370
|
+
* @property {PlatformDeliveryAddress} [billing_address_json]
|
|
2371
|
+
* @property {string} [created_at]
|
|
2372
|
+
* @property {string} [credit_note_id]
|
|
2373
|
+
* @property {PlatformDeliveryAddress} [delivery_address_json]
|
|
2374
|
+
* @property {string} [delivery_awb_number]
|
|
2375
|
+
* @property {string} [eway_bill_id]
|
|
2242
2376
|
* @property {string} [external_shipment_id]
|
|
2377
|
+
* @property {number} [fulfilment_priority]
|
|
2378
|
+
* @property {string} [fynd_order_id]
|
|
2379
|
+
* @property {ShipmentGstDetails} [gst]
|
|
2380
|
+
* @property {PlatformDeliveryAddress} [hand_over_contact_json]
|
|
2381
|
+
* @property {string} [id]
|
|
2382
|
+
* @property {boolean} [is_active]
|
|
2243
2383
|
* @property {LineItem[]} line_items
|
|
2244
2384
|
* @property {number} location_id
|
|
2385
|
+
* @property {string} [lock_status]
|
|
2245
2386
|
* @property {Object} [meta]
|
|
2246
2387
|
* @property {string} [order_type]
|
|
2388
|
+
* @property {string} [packaging_type]
|
|
2389
|
+
* @property {string} [parent_id]
|
|
2390
|
+
* @property {string} [parent_type]
|
|
2391
|
+
* @property {Object} [pdf_links]
|
|
2392
|
+
* @property {string} [previous_shipment_id]
|
|
2393
|
+
* @property {Prices} [price]
|
|
2247
2394
|
* @property {number} [priority]
|
|
2248
2395
|
* @property {ProcessingDates} [processing_dates]
|
|
2396
|
+
* @property {number} [quantity]
|
|
2397
|
+
* @property {ShipmentStatusData} [status]
|
|
2398
|
+
* @property {string} [store_invoice_id]
|
|
2399
|
+
* @property {string[]} [tags]
|
|
2400
|
+
* @property {string} [type]
|
|
2401
|
+
* @property {string} [vertical]
|
|
2249
2402
|
*/
|
|
2250
2403
|
|
|
2251
2404
|
/**
|
|
@@ -2296,15 +2449,27 @@ const Joi = require("joi");
|
|
|
2296
2449
|
|
|
2297
2450
|
/**
|
|
2298
2451
|
* @typedef ShipmentDetails
|
|
2452
|
+
* @property {Object} [action_to_status]
|
|
2299
2453
|
* @property {string} affiliate_shipment_id
|
|
2300
2454
|
* @property {ArticleDetails[]} articles
|
|
2301
2455
|
* @property {string} [box_type]
|
|
2302
|
-
* @property {
|
|
2456
|
+
* @property {string} [dp_id]
|
|
2457
|
+
* @property {Object} [dp_options]
|
|
2303
2458
|
* @property {number} fulfillment_id
|
|
2459
|
+
* @property {boolean} [lock_status]
|
|
2304
2460
|
* @property {Object} [meta]
|
|
2305
2461
|
* @property {number} shipments
|
|
2306
2462
|
*/
|
|
2307
2463
|
|
|
2464
|
+
/**
|
|
2465
|
+
* @typedef ShipmentGstDetails
|
|
2466
|
+
* @property {number} [brand_calculated_amount]
|
|
2467
|
+
* @property {number} [gst_fee]
|
|
2468
|
+
* @property {number} [gstin_code]
|
|
2469
|
+
* @property {number} [tax_collected_at_source]
|
|
2470
|
+
* @property {number} [value_of_good]
|
|
2471
|
+
*/
|
|
2472
|
+
|
|
2308
2473
|
/**
|
|
2309
2474
|
* @typedef ShipmentHistoryResponse
|
|
2310
2475
|
* @property {HistoryDict[]} activity_history
|
|
@@ -2366,9 +2531,11 @@ const Joi = require("joi");
|
|
|
2366
2531
|
/**
|
|
2367
2532
|
* @typedef ShipmentItemFulFillingStore
|
|
2368
2533
|
* @property {string} [address]
|
|
2534
|
+
* @property {string} [address1]
|
|
2369
2535
|
* @property {string[]} [brand_store_tags]
|
|
2370
2536
|
* @property {string} [city]
|
|
2371
2537
|
* @property {string} code
|
|
2538
|
+
* @property {string} [display_address]
|
|
2372
2539
|
* @property {number} id
|
|
2373
2540
|
* @property {string} [location_type]
|
|
2374
2541
|
* @property {Object} [meta]
|
|
@@ -2516,6 +2683,7 @@ const Joi = require("joi");
|
|
|
2516
2683
|
* @property {Object} [meta]
|
|
2517
2684
|
* @property {string} [shipment_id]
|
|
2518
2685
|
* @property {string} [status]
|
|
2686
|
+
* @property {string} [status_created_at]
|
|
2519
2687
|
*/
|
|
2520
2688
|
|
|
2521
2689
|
/**
|
|
@@ -2539,9 +2707,11 @@ const Joi = require("joi");
|
|
|
2539
2707
|
* @property {string} [address2]
|
|
2540
2708
|
* @property {string} [alternate_email]
|
|
2541
2709
|
* @property {string} [alternate_mobile_number]
|
|
2710
|
+
* @property {string} [area]
|
|
2542
2711
|
* @property {string} [city]
|
|
2543
2712
|
* @property {string} [country]
|
|
2544
2713
|
* @property {string} [country_code]
|
|
2714
|
+
* @property {string} [country_iso_code] - Country Code in ISO 2 format (e.g. US, IN)
|
|
2545
2715
|
* @property {string} [customer_code]
|
|
2546
2716
|
* @property {string} [external_customer_code]
|
|
2547
2717
|
* @property {string} [first_name]
|
|
@@ -2576,50 +2746,6 @@ const Joi = require("joi");
|
|
|
2576
2746
|
* @property {number} shipment_id - ShipmentId
|
|
2577
2747
|
*/
|
|
2578
2748
|
|
|
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
|
-
|
|
2623
2749
|
/**
|
|
2624
2750
|
* @typedef StatuesRequest
|
|
2625
2751
|
* @property {string} [exclude_bags_next_state] - State to be change for
|
|
@@ -2639,7 +2765,6 @@ const Joi = require("joi");
|
|
|
2639
2765
|
* @property {string} address1
|
|
2640
2766
|
* @property {string} [address2]
|
|
2641
2767
|
* @property {number} [alohomora_user_id]
|
|
2642
|
-
* @property {Object} [brand_id]
|
|
2643
2768
|
* @property {string[]} [brand_store_tags]
|
|
2644
2769
|
* @property {string} city
|
|
2645
2770
|
* @property {string} [code]
|
|
@@ -2647,14 +2772,15 @@ const Joi = require("joi");
|
|
|
2647
2772
|
* @property {string} contact_person
|
|
2648
2773
|
* @property {string} country
|
|
2649
2774
|
* @property {string} created_at
|
|
2775
|
+
* @property {string} [display_address]
|
|
2650
2776
|
* @property {string} fulfillment_channel
|
|
2651
2777
|
* @property {boolean} [is_active]
|
|
2652
2778
|
* @property {boolean} [is_archived]
|
|
2653
2779
|
* @property {boolean} [is_enabled_for_recon]
|
|
2654
|
-
* @property {number} latitude
|
|
2780
|
+
* @property {number} [latitude]
|
|
2655
2781
|
* @property {string} location_type
|
|
2656
|
-
* @property {string} login_username
|
|
2657
|
-
* @property {number} longitude
|
|
2782
|
+
* @property {string} [login_username]
|
|
2783
|
+
* @property {number} [longitude]
|
|
2658
2784
|
* @property {string} [mall_area]
|
|
2659
2785
|
* @property {string} [mall_name]
|
|
2660
2786
|
* @property {StoreMeta} meta
|
|
@@ -2664,7 +2790,7 @@ const Joi = require("joi");
|
|
|
2664
2790
|
* @property {number} [parent_store_id]
|
|
2665
2791
|
* @property {number} phone
|
|
2666
2792
|
* @property {string} pincode
|
|
2667
|
-
* @property {string} s_id
|
|
2793
|
+
* @property {string} [s_id]
|
|
2668
2794
|
* @property {string} state
|
|
2669
2795
|
* @property {string} [store_active_from]
|
|
2670
2796
|
* @property {StoreAddress} [store_address_json]
|
|
@@ -2685,6 +2811,7 @@ const Joi = require("joi");
|
|
|
2685
2811
|
* @property {string} country
|
|
2686
2812
|
* @property {string} country_code
|
|
2687
2813
|
* @property {string} created_at
|
|
2814
|
+
* @property {string} [display_address]
|
|
2688
2815
|
* @property {string} [email]
|
|
2689
2816
|
* @property {string} [landmark]
|
|
2690
2817
|
* @property {number} latitude
|
|
@@ -2902,6 +3029,20 @@ const Joi = require("joi");
|
|
|
2902
3029
|
* @property {string} [user_oid]
|
|
2903
3030
|
*/
|
|
2904
3031
|
|
|
3032
|
+
/**
|
|
3033
|
+
* @typedef UserDetails
|
|
3034
|
+
* @property {string} [email]
|
|
3035
|
+
* @property {string} [external_customer_id]
|
|
3036
|
+
* @property {string} [first_name]
|
|
3037
|
+
* @property {string} [gender]
|
|
3038
|
+
* @property {boolean} [is_anonymous_user]
|
|
3039
|
+
* @property {string} [last_name]
|
|
3040
|
+
* @property {Object} [meta]
|
|
3041
|
+
* @property {string} [mobile]
|
|
3042
|
+
* @property {string} [mongo_user_id]
|
|
3043
|
+
* @property {string} [user_oid]
|
|
3044
|
+
*/
|
|
3045
|
+
|
|
2905
3046
|
/**
|
|
2906
3047
|
* @typedef UserDetailsData
|
|
2907
3048
|
* @property {string} address
|
|
@@ -2912,6 +3053,7 @@ const Joi = require("joi");
|
|
|
2912
3053
|
* @property {string} country
|
|
2913
3054
|
* @property {string} [country_iso_code]
|
|
2914
3055
|
* @property {string} [country_phone_code]
|
|
3056
|
+
* @property {string} [display_address]
|
|
2915
3057
|
* @property {string} [email]
|
|
2916
3058
|
* @property {string} [landmark]
|
|
2917
3059
|
* @property {string} name
|
|
@@ -2968,6 +3110,12 @@ const Joi = require("joi");
|
|
|
2968
3110
|
* @property {string} [unit]
|
|
2969
3111
|
*/
|
|
2970
3112
|
|
|
3113
|
+
/**
|
|
3114
|
+
* @typedef WeightData
|
|
3115
|
+
* @property {string} [unit]
|
|
3116
|
+
* @property {number} [value]
|
|
3117
|
+
*/
|
|
3118
|
+
|
|
2971
3119
|
class OrderPlatformModel {
|
|
2972
3120
|
/** @returns {ActionInfo} */
|
|
2973
3121
|
static ActionInfo() {
|
|
@@ -3326,50 +3474,99 @@ class OrderPlatformModel {
|
|
|
3326
3474
|
});
|
|
3327
3475
|
}
|
|
3328
3476
|
|
|
3329
|
-
/** @returns {
|
|
3330
|
-
static
|
|
3477
|
+
/** @returns {BagData} */
|
|
3478
|
+
static BagData() {
|
|
3479
|
+
return Joi.object({
|
|
3480
|
+
items: Joi.array().items(OrderPlatformModel.BagDetails()),
|
|
3481
|
+
page: OrderPlatformModel.BagsPage(),
|
|
3482
|
+
});
|
|
3483
|
+
}
|
|
3484
|
+
|
|
3485
|
+
/** @returns {BagDetails} */
|
|
3486
|
+
static BagDetails() {
|
|
3331
3487
|
return Joi.object({
|
|
3332
3488
|
affiliate_bag_details: OrderPlatformModel.AffiliateBagDetails(),
|
|
3333
3489
|
affiliate_details: OrderPlatformModel.AffiliateDetails(),
|
|
3334
3490
|
applied_promos: Joi.array().items(Joi.any()),
|
|
3335
3491
|
article: OrderPlatformModel.Article(),
|
|
3336
3492
|
article_details: OrderPlatformModel.ArticleStatusDetails(),
|
|
3493
|
+
bag_id: Joi.number().allow(null),
|
|
3337
3494
|
bag_status: Joi.array().items(OrderPlatformModel.BagStatusHistory()),
|
|
3338
3495
|
bag_status_history: OrderPlatformModel.BagStatusHistory(),
|
|
3339
3496
|
bag_update_time: Joi.number().allow(null),
|
|
3340
3497
|
brand: OrderPlatformModel.Brand(),
|
|
3498
|
+
company: OrderPlatformModel.Company(),
|
|
3341
3499
|
current_operational_status: OrderPlatformModel.BagStatusHistory(),
|
|
3342
3500
|
current_status: OrderPlatformModel.BagStatusHistory(),
|
|
3343
3501
|
dates: OrderPlatformModel.Dates(),
|
|
3502
|
+
delivery_address: OrderPlatformModel.PlatformDeliveryAddress(),
|
|
3503
|
+
delivery_slot: OrderPlatformModel.DeliverySlotDetails(),
|
|
3344
3504
|
display_name: Joi.string().allow("").allow(null),
|
|
3505
|
+
dp_details: Joi.any().allow(null),
|
|
3506
|
+
einvoice_info: Joi.any().allow(null),
|
|
3345
3507
|
entity_type: Joi.string().allow("").allow(null),
|
|
3508
|
+
fallback_user: Joi.any().allow(null),
|
|
3346
3509
|
financial_breakup: Joi.array().items(
|
|
3347
3510
|
OrderPlatformModel.FinancialBreakup()
|
|
3348
3511
|
),
|
|
3512
|
+
fulfilling_store: OrderPlatformModel.Store(),
|
|
3513
|
+
fyndstore_emp: Joi.any().allow(null),
|
|
3349
3514
|
gst_details: OrderPlatformModel.GSTDetailsData(),
|
|
3350
|
-
id: Joi.
|
|
3515
|
+
id: Joi.string().allow("").allow(null),
|
|
3351
3516
|
identifier: Joi.string().allow("").allow(null),
|
|
3517
|
+
invoice: OrderPlatformModel.InvoiceDetails(),
|
|
3352
3518
|
item: OrderPlatformModel.Item(),
|
|
3353
|
-
journey_type: Joi.string().allow("")
|
|
3354
|
-
line_number: Joi.number()
|
|
3519
|
+
journey_type: Joi.string().allow(""),
|
|
3520
|
+
line_number: Joi.number(),
|
|
3521
|
+
lock_status: Joi.boolean().allow(null),
|
|
3522
|
+
manifest_id: Joi.string().allow("").allow(null),
|
|
3355
3523
|
meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
3524
|
+
mode_of_payment: Joi.string().allow("").allow(null),
|
|
3356
3525
|
no_of_bags_order: Joi.number().allow(null),
|
|
3357
3526
|
operational_status: Joi.string().allow("").allow(null),
|
|
3527
|
+
order: OrderPlatformModel.OrderDetails(),
|
|
3358
3528
|
order_integration_id: Joi.string().allow("").allow(null),
|
|
3529
|
+
order_type: Joi.string().allow("").allow(null),
|
|
3530
|
+
order_value: Joi.number().allow(null),
|
|
3359
3531
|
ordering_store: OrderPlatformModel.Store(),
|
|
3360
3532
|
original_bag_list: Joi.array().items(Joi.number()),
|
|
3361
3533
|
parent_promo_bags: Joi.any().allow(null),
|
|
3534
|
+
payment_methods: Joi.any().allow(null),
|
|
3535
|
+
payment_type: Joi.string().allow("").allow(null),
|
|
3536
|
+
payments: Joi.any().allow(null),
|
|
3362
3537
|
prices: OrderPlatformModel.Prices(),
|
|
3363
|
-
qc_required: Joi.
|
|
3538
|
+
qc_required: Joi.boolean().allow(null),
|
|
3364
3539
|
quantity: Joi.number().allow(null),
|
|
3365
3540
|
reasons: Joi.array().items(Joi.any()),
|
|
3366
3541
|
restore_coupon: Joi.boolean().allow(null),
|
|
3367
3542
|
restore_promos: Joi.any().allow(null),
|
|
3543
|
+
rto_address: OrderPlatformModel.PlatformDeliveryAddress(),
|
|
3368
3544
|
seller_identifier: Joi.string().allow("").allow(null),
|
|
3545
|
+
shipment: OrderPlatformModel.Shipment(),
|
|
3546
|
+
shipment_details: OrderPlatformModel.ShipmentDetails(),
|
|
3547
|
+
shipment_gst: OrderPlatformModel.ShipmentGstDetails(),
|
|
3369
3548
|
shipment_id: Joi.string().allow("").allow(null),
|
|
3549
|
+
shipment_status: OrderPlatformModel.ShipmentStatusData(),
|
|
3550
|
+
shipment_status_history: Joi.array().items(
|
|
3551
|
+
OrderPlatformModel.ShipmentStatusData()
|
|
3552
|
+
),
|
|
3370
3553
|
status: OrderPlatformModel.BagReturnableCancelableStatus(),
|
|
3371
3554
|
tags: Joi.array().items(Joi.string().allow("")),
|
|
3555
|
+
total_shipment_bags: Joi.number().allow(null),
|
|
3556
|
+
total_shipments_in_order: Joi.number().allow(null),
|
|
3557
|
+
transaction_type: Joi.string().allow("").allow(null),
|
|
3372
3558
|
type: Joi.string().allow("").allow(null),
|
|
3559
|
+
updated_at: Joi.string().allow("").allow(null),
|
|
3560
|
+
user: OrderPlatformModel.UserDetails(),
|
|
3561
|
+
weight: OrderPlatformModel.WeightData(),
|
|
3562
|
+
});
|
|
3563
|
+
}
|
|
3564
|
+
|
|
3565
|
+
/** @returns {BagDetailsPlatformResponse} */
|
|
3566
|
+
static BagDetailsPlatformResponse() {
|
|
3567
|
+
return Joi.object({
|
|
3568
|
+
data: OrderPlatformModel.BagDetails(),
|
|
3569
|
+
status_code: Joi.number(),
|
|
3373
3570
|
});
|
|
3374
3571
|
}
|
|
3375
3572
|
|
|
@@ -3529,15 +3726,18 @@ class OrderPlatformModel {
|
|
|
3529
3726
|
address2: Joi.string().allow(""),
|
|
3530
3727
|
alternate_email: Joi.string().allow(""),
|
|
3531
3728
|
alternate_mobile_number: Joi.string().allow(""),
|
|
3729
|
+
area: Joi.string().allow(""),
|
|
3532
3730
|
city: Joi.string().allow(""),
|
|
3533
3731
|
country: Joi.string().allow(""),
|
|
3534
3732
|
country_code: Joi.string().allow(""),
|
|
3733
|
+
country_iso_code: Joi.string().allow(""),
|
|
3535
3734
|
customer_code: Joi.string().allow(""),
|
|
3536
3735
|
external_customer_code: Joi.string().allow(""),
|
|
3537
3736
|
first_name: Joi.string().allow(""),
|
|
3538
3737
|
floor_no: Joi.string().allow(""),
|
|
3539
3738
|
gender: Joi.string().allow(""),
|
|
3540
3739
|
house_no: Joi.string().allow(""),
|
|
3740
|
+
landmark: Joi.string().allow(""),
|
|
3541
3741
|
last_name: Joi.string().allow(""),
|
|
3542
3742
|
middle_name: Joi.string().allow(""),
|
|
3543
3743
|
pincode: Joi.string().allow(""),
|
|
@@ -3552,12 +3752,13 @@ class OrderPlatformModel {
|
|
|
3552
3752
|
/** @returns {Brand} */
|
|
3553
3753
|
static Brand() {
|
|
3554
3754
|
return Joi.object({
|
|
3555
|
-
brand_id: Joi.number()
|
|
3755
|
+
brand_id: Joi.number(),
|
|
3556
3756
|
brand_name: Joi.string().allow("").required(),
|
|
3557
|
-
company: Joi.string().allow("").
|
|
3558
|
-
created_on: Joi.
|
|
3757
|
+
company: Joi.string().allow("").allow(null),
|
|
3758
|
+
created_on: Joi.string().allow("").allow(null),
|
|
3559
3759
|
credit_note_allowed: Joi.boolean().allow(null),
|
|
3560
3760
|
credit_note_expiry_days: Joi.number().allow(null),
|
|
3761
|
+
id: Joi.number().allow(null),
|
|
3561
3762
|
invoice_prefix: Joi.string().allow("").allow(null),
|
|
3562
3763
|
is_virtual_invoice: Joi.boolean().allow(null),
|
|
3563
3764
|
logo: Joi.string().allow("").allow(null),
|
|
@@ -3742,6 +3943,22 @@ class OrderPlatformModel {
|
|
|
3742
3943
|
});
|
|
3743
3944
|
}
|
|
3744
3945
|
|
|
3946
|
+
/** @returns {Company} */
|
|
3947
|
+
static Company() {
|
|
3948
|
+
return Joi.object({
|
|
3949
|
+
agreement_start_date: Joi.string().allow("").allow(null),
|
|
3950
|
+
business_type: Joi.string().allow("").allow(null),
|
|
3951
|
+
company_name: Joi.string().allow("").allow(null),
|
|
3952
|
+
company_type: Joi.string().allow("").allow(null),
|
|
3953
|
+
created_on: Joi.string().allow("").allow(null),
|
|
3954
|
+
gst_number: Joi.string().allow("").allow(null),
|
|
3955
|
+
id: Joi.number().allow(null),
|
|
3956
|
+
meta: Joi.any().allow(null),
|
|
3957
|
+
modified_on: Joi.string().allow("").allow(null),
|
|
3958
|
+
pan_no: Joi.string().allow("").allow(null),
|
|
3959
|
+
});
|
|
3960
|
+
}
|
|
3961
|
+
|
|
3745
3962
|
/** @returns {CompanyDetails} */
|
|
3746
3963
|
static CompanyDetails() {
|
|
3747
3964
|
return Joi.object({
|
|
@@ -3970,6 +4187,17 @@ class OrderPlatformModel {
|
|
|
3970
4187
|
});
|
|
3971
4188
|
}
|
|
3972
4189
|
|
|
4190
|
+
/** @returns {DeliverySlotDetails} */
|
|
4191
|
+
static DeliverySlotDetails() {
|
|
4192
|
+
return Joi.object({
|
|
4193
|
+
date: Joi.string().allow("").allow(null),
|
|
4194
|
+
lower_bound: Joi.string().allow("").allow(null),
|
|
4195
|
+
slot: Joi.string().allow("").allow(null),
|
|
4196
|
+
type: Joi.string().allow("").allow(null),
|
|
4197
|
+
upper_bound: Joi.string().allow("").allow(null),
|
|
4198
|
+
});
|
|
4199
|
+
}
|
|
4200
|
+
|
|
3973
4201
|
/** @returns {Dimension} */
|
|
3974
4202
|
static Dimension() {
|
|
3975
4203
|
return Joi.object({
|
|
@@ -4387,10 +4615,12 @@ class OrderPlatformModel {
|
|
|
4387
4615
|
static FulfillingStore() {
|
|
4388
4616
|
return Joi.object({
|
|
4389
4617
|
address: Joi.string().allow("").required(),
|
|
4618
|
+
address1: Joi.string().allow("").allow(null),
|
|
4390
4619
|
city: Joi.string().allow("").required(),
|
|
4391
4620
|
code: Joi.string().allow("").required(),
|
|
4392
4621
|
contact_person: Joi.string().allow("").required(),
|
|
4393
4622
|
country: Joi.string().allow("").required(),
|
|
4623
|
+
display_address: Joi.string().allow("").allow(null),
|
|
4394
4624
|
fulfillment_channel: Joi.string().allow("").required(),
|
|
4395
4625
|
id: Joi.number().required(),
|
|
4396
4626
|
meta: Joi.any().required(),
|
|
@@ -4408,6 +4638,51 @@ class OrderPlatformModel {
|
|
|
4408
4638
|
});
|
|
4409
4639
|
}
|
|
4410
4640
|
|
|
4641
|
+
/** @returns {GenerateInvoiceIDErrorResponse} */
|
|
4642
|
+
static GenerateInvoiceIDErrorResponse() {
|
|
4643
|
+
return Joi.object({
|
|
4644
|
+
items: Joi.array().items(
|
|
4645
|
+
OrderPlatformModel.GenerateInvoiceIDErrorResponseData()
|
|
4646
|
+
),
|
|
4647
|
+
});
|
|
4648
|
+
}
|
|
4649
|
+
|
|
4650
|
+
/** @returns {GenerateInvoiceIDErrorResponseData} */
|
|
4651
|
+
static GenerateInvoiceIDErrorResponseData() {
|
|
4652
|
+
return Joi.object({
|
|
4653
|
+
error_message: Joi.string().allow("").allow(null),
|
|
4654
|
+
invoice_id: Joi.boolean().allow(null),
|
|
4655
|
+
shipment_id: Joi.string().allow(""),
|
|
4656
|
+
success: Joi.boolean(),
|
|
4657
|
+
});
|
|
4658
|
+
}
|
|
4659
|
+
|
|
4660
|
+
/** @returns {GenerateInvoiceIDRequest} */
|
|
4661
|
+
static GenerateInvoiceIDRequest() {
|
|
4662
|
+
return Joi.object({
|
|
4663
|
+
shipment_ids: Joi.array().items(Joi.string().allow("")).required(),
|
|
4664
|
+
});
|
|
4665
|
+
}
|
|
4666
|
+
|
|
4667
|
+
/** @returns {GenerateInvoiceIDResponse} */
|
|
4668
|
+
static GenerateInvoiceIDResponse() {
|
|
4669
|
+
return Joi.object({
|
|
4670
|
+
items: Joi.array().items(
|
|
4671
|
+
OrderPlatformModel.GenerateInvoiceIDResponseData()
|
|
4672
|
+
),
|
|
4673
|
+
});
|
|
4674
|
+
}
|
|
4675
|
+
|
|
4676
|
+
/** @returns {GenerateInvoiceIDResponseData} */
|
|
4677
|
+
static GenerateInvoiceIDResponseData() {
|
|
4678
|
+
return Joi.object({
|
|
4679
|
+
error_message: Joi.boolean().allow(null),
|
|
4680
|
+
invoice_id: Joi.string().allow("").allow(null),
|
|
4681
|
+
shipment_id: Joi.string().allow(""),
|
|
4682
|
+
success: Joi.boolean(),
|
|
4683
|
+
});
|
|
4684
|
+
}
|
|
4685
|
+
|
|
4411
4686
|
/** @returns {GeneratePosOrderReceiptResponse} */
|
|
4412
4687
|
static GeneratePosOrderReceiptResponse() {
|
|
4413
4688
|
return Joi.object({
|
|
@@ -4433,10 +4708,8 @@ class OrderPlatformModel {
|
|
|
4433
4708
|
/** @returns {GetBagsPlatformResponse} */
|
|
4434
4709
|
static GetBagsPlatformResponse() {
|
|
4435
4710
|
return Joi.object({
|
|
4436
|
-
|
|
4437
|
-
|
|
4438
|
-
.required(),
|
|
4439
|
-
page: OrderPlatformModel.BagsPage().required(),
|
|
4711
|
+
data: OrderPlatformModel.BagData(),
|
|
4712
|
+
status_code: Joi.number(),
|
|
4440
4713
|
});
|
|
4441
4714
|
}
|
|
4442
4715
|
|
|
@@ -4561,6 +4834,16 @@ class OrderPlatformModel {
|
|
|
4561
4834
|
});
|
|
4562
4835
|
}
|
|
4563
4836
|
|
|
4837
|
+
/** @returns {InvoiceDetails} */
|
|
4838
|
+
static InvoiceDetails() {
|
|
4839
|
+
return Joi.object({
|
|
4840
|
+
invoice_url: Joi.string().allow("").allow(null),
|
|
4841
|
+
label_url: Joi.string().allow("").allow(null),
|
|
4842
|
+
store_invoice_id: Joi.string().allow("").allow(null),
|
|
4843
|
+
updated_date: Joi.string().allow("").allow(null),
|
|
4844
|
+
});
|
|
4845
|
+
}
|
|
4846
|
+
|
|
4564
4847
|
/** @returns {InvoiceInfo} */
|
|
4565
4848
|
static InvoiceInfo() {
|
|
4566
4849
|
return Joi.object({
|
|
@@ -4920,8 +5203,37 @@ class OrderPlatformModel {
|
|
|
4920
5203
|
/** @returns {OrderDetails} */
|
|
4921
5204
|
static OrderDetails() {
|
|
4922
5205
|
return Joi.object({
|
|
5206
|
+
affiliate_id: Joi.string().allow(""),
|
|
5207
|
+
affiliate_order_date: Joi.string().allow("").allow(null),
|
|
5208
|
+
affiliate_order_id: Joi.string().allow(""),
|
|
5209
|
+
cashback_applied: Joi.number().allow(null),
|
|
5210
|
+
cashback_value: Joi.number().allow(null),
|
|
5211
|
+
cod_charges: Joi.number().allow(null),
|
|
5212
|
+
collect_by: Joi.string().allow(""),
|
|
5213
|
+
coupon_value: Joi.number().allow(null),
|
|
4923
5214
|
created_at: Joi.string().allow(""),
|
|
5215
|
+
created_time: Joi.string().allow(""),
|
|
5216
|
+
currency: Joi.string().allow(""),
|
|
5217
|
+
delivery_charges: Joi.number().allow(null),
|
|
5218
|
+
discount: Joi.number().allow(null),
|
|
5219
|
+
fynd_credits: Joi.number().allow(null),
|
|
4924
5220
|
fynd_order_id: Joi.string().allow(""),
|
|
5221
|
+
headers: Joi.any().allow(null),
|
|
5222
|
+
meta: Joi.any().allow(null),
|
|
5223
|
+
mode_of_payment: Joi.string().allow(""),
|
|
5224
|
+
mongo_cart_id: Joi.number().allow(null),
|
|
5225
|
+
order_value: Joi.number(),
|
|
5226
|
+
ordering_channel: Joi.string().allow(""),
|
|
5227
|
+
ordering_channel_logo: Joi.string().allow("").allow(null),
|
|
5228
|
+
payment_methods: Joi.any().allow(null),
|
|
5229
|
+
payment_mode_id: Joi.number().allow(null),
|
|
5230
|
+
prices: OrderPlatformModel.Prices(),
|
|
5231
|
+
promotion_effective_discount: Joi.number().allow(null),
|
|
5232
|
+
refund_by: Joi.string().allow(""),
|
|
5233
|
+
tax_details: OrderPlatformModel.TaxDetails(),
|
|
5234
|
+
total_order_value: Joi.number(),
|
|
5235
|
+
transaction_id: Joi.string().allow("").allow(null),
|
|
5236
|
+
user_id: Joi.string().allow("").allow(null),
|
|
4925
5237
|
});
|
|
4926
5238
|
}
|
|
4927
5239
|
|
|
@@ -4986,10 +5298,12 @@ class OrderPlatformModel {
|
|
|
4986
5298
|
static OrderingStoreDetails() {
|
|
4987
5299
|
return Joi.object({
|
|
4988
5300
|
address: Joi.string().allow("").allow(null),
|
|
5301
|
+
address1: Joi.string().allow("").allow(null),
|
|
4989
5302
|
city: Joi.string().allow("").allow(null),
|
|
4990
5303
|
code: Joi.string().allow("").allow(null),
|
|
4991
5304
|
contact_person: Joi.string().allow("").allow(null),
|
|
4992
5305
|
country: Joi.string().allow("").allow(null),
|
|
5306
|
+
display_address: Joi.string().allow("").allow(null),
|
|
4993
5307
|
id: Joi.number().allow(null),
|
|
4994
5308
|
meta: Joi.any().allow(null),
|
|
4995
5309
|
phone: Joi.string().allow("").allow(null),
|
|
@@ -5104,27 +5418,6 @@ class OrderPlatformModel {
|
|
|
5104
5418
|
});
|
|
5105
5419
|
}
|
|
5106
5420
|
|
|
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() {
|
|
5117
|
-
return Joi.object({
|
|
5118
|
-
current: Joi.number(),
|
|
5119
|
-
has_next: Joi.boolean(),
|
|
5120
|
-
has_previous: Joi.boolean(),
|
|
5121
|
-
item_total: Joi.number(),
|
|
5122
|
-
size: Joi.number(),
|
|
5123
|
-
total: Joi.number(),
|
|
5124
|
-
type: Joi.string().allow(""),
|
|
5125
|
-
});
|
|
5126
|
-
}
|
|
5127
|
-
|
|
5128
5421
|
/** @returns {PaymentInfo} */
|
|
5129
5422
|
static PaymentInfo() {
|
|
5130
5423
|
return Joi.object({
|
|
@@ -5231,6 +5524,7 @@ class OrderPlatformModel {
|
|
|
5231
5524
|
contact_person: Joi.string().allow("").allow(null),
|
|
5232
5525
|
country: Joi.string().allow("").allow(null),
|
|
5233
5526
|
created_at: Joi.string().allow("").allow(null),
|
|
5527
|
+
display_address: Joi.string().allow("").allow(null),
|
|
5234
5528
|
email: Joi.string().allow("").allow(null),
|
|
5235
5529
|
landmark: Joi.string().allow("").allow(null),
|
|
5236
5530
|
latitude: Joi.number().allow(null),
|
|
@@ -5696,13 +5990,40 @@ class OrderPlatformModel {
|
|
|
5696
5990
|
/** @returns {Shipment} */
|
|
5697
5991
|
static Shipment() {
|
|
5698
5992
|
return Joi.object({
|
|
5993
|
+
affiliate_id: Joi.string().allow(""),
|
|
5994
|
+
affiliate_shipment_id: Joi.string().allow("").allow(null),
|
|
5995
|
+
billing_address_json: OrderPlatformModel.PlatformDeliveryAddress(),
|
|
5996
|
+
created_at: Joi.string().allow(""),
|
|
5997
|
+
credit_note_id: Joi.string().allow("").allow(null),
|
|
5998
|
+
delivery_address_json: OrderPlatformModel.PlatformDeliveryAddress(),
|
|
5999
|
+
delivery_awb_number: Joi.string().allow("").allow(null),
|
|
6000
|
+
eway_bill_id: Joi.string().allow("").allow(null),
|
|
5699
6001
|
external_shipment_id: Joi.string().allow(""),
|
|
6002
|
+
fulfilment_priority: Joi.number().allow(null),
|
|
6003
|
+
fynd_order_id: Joi.string().allow(""),
|
|
6004
|
+
gst: OrderPlatformModel.ShipmentGstDetails(),
|
|
6005
|
+
hand_over_contact_json: OrderPlatformModel.PlatformDeliveryAddress(),
|
|
6006
|
+
id: Joi.string().allow(""),
|
|
6007
|
+
is_active: Joi.boolean(),
|
|
5700
6008
|
line_items: Joi.array().items(OrderPlatformModel.LineItem()).required(),
|
|
5701
6009
|
location_id: Joi.number().required(),
|
|
5702
|
-
|
|
6010
|
+
lock_status: Joi.string().allow("").allow(null),
|
|
6011
|
+
meta: Joi.any().allow(null),
|
|
5703
6012
|
order_type: Joi.string().allow(""),
|
|
6013
|
+
packaging_type: Joi.string().allow("").allow(null),
|
|
6014
|
+
parent_id: Joi.string().allow("").allow(null),
|
|
6015
|
+
parent_type: Joi.string().allow("").allow(null),
|
|
6016
|
+
pdf_links: Joi.any().allow(null),
|
|
6017
|
+
previous_shipment_id: Joi.string().allow("").allow(null),
|
|
6018
|
+
price: OrderPlatformModel.Prices(),
|
|
5704
6019
|
priority: Joi.number(),
|
|
5705
6020
|
processing_dates: OrderPlatformModel.ProcessingDates(),
|
|
6021
|
+
quantity: Joi.number().allow(null),
|
|
6022
|
+
status: OrderPlatformModel.ShipmentStatusData(),
|
|
6023
|
+
store_invoice_id: Joi.string().allow("").allow(null),
|
|
6024
|
+
tags: Joi.array().items(Joi.string().allow("")),
|
|
6025
|
+
type: Joi.string().allow("").allow(null),
|
|
6026
|
+
vertical: Joi.string().allow("").allow(null),
|
|
5706
6027
|
});
|
|
5707
6028
|
}
|
|
5708
6029
|
|
|
@@ -5772,18 +6093,32 @@ class OrderPlatformModel {
|
|
|
5772
6093
|
/** @returns {ShipmentDetails} */
|
|
5773
6094
|
static ShipmentDetails() {
|
|
5774
6095
|
return Joi.object({
|
|
6096
|
+
action_to_status: Joi.any().allow(null),
|
|
5775
6097
|
affiliate_shipment_id: Joi.string().allow("").required(),
|
|
5776
6098
|
articles: Joi.array()
|
|
5777
6099
|
.items(OrderPlatformModel.ArticleDetails())
|
|
5778
6100
|
.required(),
|
|
5779
6101
|
box_type: Joi.string().allow("").allow(null),
|
|
5780
|
-
dp_id: Joi.
|
|
6102
|
+
dp_id: Joi.string().allow("").allow(null),
|
|
6103
|
+
dp_options: Joi.any().allow(null),
|
|
5781
6104
|
fulfillment_id: Joi.number().required(),
|
|
6105
|
+
lock_status: Joi.boolean().allow(null),
|
|
5782
6106
|
meta: Joi.any(),
|
|
5783
6107
|
shipments: Joi.number().required(),
|
|
5784
6108
|
});
|
|
5785
6109
|
}
|
|
5786
6110
|
|
|
6111
|
+
/** @returns {ShipmentGstDetails} */
|
|
6112
|
+
static ShipmentGstDetails() {
|
|
6113
|
+
return Joi.object({
|
|
6114
|
+
brand_calculated_amount: Joi.number().allow(null),
|
|
6115
|
+
gst_fee: Joi.number().allow(null),
|
|
6116
|
+
gstin_code: Joi.number().allow(null),
|
|
6117
|
+
tax_collected_at_source: Joi.number().allow(null),
|
|
6118
|
+
value_of_good: Joi.number().allow(null),
|
|
6119
|
+
});
|
|
6120
|
+
}
|
|
6121
|
+
|
|
5787
6122
|
/** @returns {ShipmentHistoryResponse} */
|
|
5788
6123
|
static ShipmentHistoryResponse() {
|
|
5789
6124
|
return Joi.object({
|
|
@@ -5856,9 +6191,11 @@ class OrderPlatformModel {
|
|
|
5856
6191
|
static ShipmentItemFulFillingStore() {
|
|
5857
6192
|
return Joi.object({
|
|
5858
6193
|
address: Joi.string().allow("").allow(null),
|
|
6194
|
+
address1: Joi.string().allow("").allow(null),
|
|
5859
6195
|
brand_store_tags: Joi.array().items(Joi.string().allow("")),
|
|
5860
6196
|
city: Joi.string().allow("").allow(null),
|
|
5861
6197
|
code: Joi.string().allow("").required(),
|
|
6198
|
+
display_address: Joi.string().allow("").allow(null),
|
|
5862
6199
|
id: Joi.number().required(),
|
|
5863
6200
|
location_type: Joi.string().allow("").allow(null),
|
|
5864
6201
|
meta: Joi.any().allow(null),
|
|
@@ -6030,6 +6367,7 @@ class OrderPlatformModel {
|
|
|
6030
6367
|
meta: Joi.any().allow(null),
|
|
6031
6368
|
shipment_id: Joi.string().allow("").allow(null),
|
|
6032
6369
|
status: Joi.string().allow("").allow(null),
|
|
6370
|
+
status_created_at: Joi.string().allow("").allow(null),
|
|
6033
6371
|
});
|
|
6034
6372
|
}
|
|
6035
6373
|
|
|
@@ -6059,9 +6397,11 @@ class OrderPlatformModel {
|
|
|
6059
6397
|
address2: Joi.string().allow(""),
|
|
6060
6398
|
alternate_email: Joi.string().allow(""),
|
|
6061
6399
|
alternate_mobile_number: Joi.string().allow(""),
|
|
6400
|
+
area: Joi.string().allow(""),
|
|
6062
6401
|
city: Joi.string().allow(""),
|
|
6063
6402
|
country: Joi.string().allow(""),
|
|
6064
6403
|
country_code: Joi.string().allow(""),
|
|
6404
|
+
country_iso_code: Joi.string().allow(""),
|
|
6065
6405
|
customer_code: Joi.string().allow(""),
|
|
6066
6406
|
external_customer_code: Joi.string().allow(""),
|
|
6067
6407
|
first_name: Joi.string().allow(""),
|
|
@@ -6098,58 +6438,6 @@ class OrderPlatformModel {
|
|
|
6098
6438
|
});
|
|
6099
6439
|
}
|
|
6100
6440
|
|
|
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
|
-
|
|
6153
6441
|
/** @returns {StatuesRequest} */
|
|
6154
6442
|
static StatuesRequest() {
|
|
6155
6443
|
return Joi.object({
|
|
@@ -6170,10 +6458,9 @@ class OrderPlatformModel {
|
|
|
6170
6458
|
/** @returns {Store} */
|
|
6171
6459
|
static Store() {
|
|
6172
6460
|
return Joi.object({
|
|
6173
|
-
address1: Joi.string().allow("").required(),
|
|
6461
|
+
address1: Joi.string().allow("").allow(null).required(),
|
|
6174
6462
|
address2: Joi.string().allow("").allow(null),
|
|
6175
6463
|
alohomora_user_id: Joi.number().allow(null),
|
|
6176
|
-
brand_id: Joi.any(),
|
|
6177
6464
|
brand_store_tags: Joi.array().items(Joi.string().allow("")),
|
|
6178
6465
|
city: Joi.string().allow("").required(),
|
|
6179
6466
|
code: Joi.string().allow("").allow(null),
|
|
@@ -6181,14 +6468,15 @@ class OrderPlatformModel {
|
|
|
6181
6468
|
contact_person: Joi.string().allow("").required(),
|
|
6182
6469
|
country: Joi.string().allow("").required(),
|
|
6183
6470
|
created_at: Joi.string().allow("").required(),
|
|
6471
|
+
display_address: Joi.string().allow("").allow(null),
|
|
6184
6472
|
fulfillment_channel: Joi.string().allow("").required(),
|
|
6185
6473
|
is_active: Joi.boolean().allow(null),
|
|
6186
6474
|
is_archived: Joi.boolean().allow(null),
|
|
6187
6475
|
is_enabled_for_recon: Joi.boolean().allow(null),
|
|
6188
|
-
latitude: Joi.number().
|
|
6476
|
+
latitude: Joi.number().allow(null),
|
|
6189
6477
|
location_type: Joi.string().allow("").required(),
|
|
6190
|
-
login_username: Joi.string().allow("").
|
|
6191
|
-
longitude: Joi.number().
|
|
6478
|
+
login_username: Joi.string().allow("").allow(null),
|
|
6479
|
+
longitude: Joi.number().allow(null),
|
|
6192
6480
|
mall_area: Joi.string().allow("").allow(null),
|
|
6193
6481
|
mall_name: Joi.string().allow("").allow(null),
|
|
6194
6482
|
meta: OrderPlatformModel.StoreMeta().required(),
|
|
@@ -6198,7 +6486,7 @@ class OrderPlatformModel {
|
|
|
6198
6486
|
parent_store_id: Joi.number().allow(null),
|
|
6199
6487
|
phone: Joi.number().required(),
|
|
6200
6488
|
pincode: Joi.string().allow("").required(),
|
|
6201
|
-
s_id: Joi.string().allow("").
|
|
6489
|
+
s_id: Joi.string().allow("").allow(null),
|
|
6202
6490
|
state: Joi.string().allow("").required(),
|
|
6203
6491
|
store_active_from: Joi.string().allow("").allow(null),
|
|
6204
6492
|
store_address_json: OrderPlatformModel.StoreAddress(),
|
|
@@ -6221,6 +6509,7 @@ class OrderPlatformModel {
|
|
|
6221
6509
|
country: Joi.string().allow("").required(),
|
|
6222
6510
|
country_code: Joi.string().allow("").required(),
|
|
6223
6511
|
created_at: Joi.string().allow("").required(),
|
|
6512
|
+
display_address: Joi.string().allow("").allow(null),
|
|
6224
6513
|
email: Joi.string().allow("").allow(null),
|
|
6225
6514
|
landmark: Joi.string().allow(""),
|
|
6226
6515
|
latitude: Joi.number().required(),
|
|
@@ -6491,6 +6780,22 @@ class OrderPlatformModel {
|
|
|
6491
6780
|
});
|
|
6492
6781
|
}
|
|
6493
6782
|
|
|
6783
|
+
/** @returns {UserDetails} */
|
|
6784
|
+
static UserDetails() {
|
|
6785
|
+
return Joi.object({
|
|
6786
|
+
email: Joi.string().allow("").allow(null),
|
|
6787
|
+
external_customer_id: Joi.string().allow("").allow(null),
|
|
6788
|
+
first_name: Joi.string().allow("").allow(null),
|
|
6789
|
+
gender: Joi.string().allow("").allow(null),
|
|
6790
|
+
is_anonymous_user: Joi.boolean().allow(null),
|
|
6791
|
+
last_name: Joi.string().allow("").allow(null),
|
|
6792
|
+
meta: Joi.any().allow(null),
|
|
6793
|
+
mobile: Joi.string().allow("").allow(null),
|
|
6794
|
+
mongo_user_id: Joi.string().allow("").allow(null),
|
|
6795
|
+
user_oid: Joi.string().allow("").allow(null),
|
|
6796
|
+
});
|
|
6797
|
+
}
|
|
6798
|
+
|
|
6494
6799
|
/** @returns {UserDetailsData} */
|
|
6495
6800
|
static UserDetailsData() {
|
|
6496
6801
|
return Joi.object({
|
|
@@ -6502,6 +6807,7 @@ class OrderPlatformModel {
|
|
|
6502
6807
|
country: Joi.string().allow("").required(),
|
|
6503
6808
|
country_iso_code: Joi.string().allow(""),
|
|
6504
6809
|
country_phone_code: Joi.string().allow(""),
|
|
6810
|
+
display_address: Joi.string().allow("").allow(null),
|
|
6505
6811
|
email: Joi.string().allow("").allow(null),
|
|
6506
6812
|
landmark: Joi.string().allow("").allow(null),
|
|
6507
6813
|
name: Joi.string().allow("").required(),
|
|
@@ -6570,5 +6876,13 @@ class OrderPlatformModel {
|
|
|
6570
6876
|
unit: Joi.string().allow("").allow(null),
|
|
6571
6877
|
});
|
|
6572
6878
|
}
|
|
6879
|
+
|
|
6880
|
+
/** @returns {WeightData} */
|
|
6881
|
+
static WeightData() {
|
|
6882
|
+
return Joi.object({
|
|
6883
|
+
unit: Joi.string().allow("").allow(null),
|
|
6884
|
+
value: Joi.number().allow(null),
|
|
6885
|
+
});
|
|
6886
|
+
}
|
|
6573
6887
|
}
|
|
6574
6888
|
module.exports = OrderPlatformModel;
|