@gofynd/fdk-client-javascript 1.4.10 → 1.4.12

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.
Files changed (39) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/Cart/CartApplicationClient.d.ts +8 -19
  4. package/sdk/application/Cart/CartApplicationClient.js +8 -89
  5. package/sdk/application/Cart/CartApplicationModel.d.ts +1 -178
  6. package/sdk/application/Cart/CartApplicationModel.js +0 -92
  7. package/sdk/application/Cart/CartApplicationValidator.d.ts +1 -20
  8. package/sdk/application/Cart/CartApplicationValidator.js +0 -16
  9. package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +5 -0
  10. package/sdk/application/Configuration/ConfigurationApplicationModel.js +2 -0
  11. package/sdk/application/Logistic/LogisticApplicationModel.js +3 -3
  12. package/sdk/application/Order/OrderApplicationModel.js +1 -1
  13. package/sdk/application/Payment/PaymentApplicationModel.js +2 -2
  14. package/sdk/common/Clickstream.js +34 -15
  15. package/sdk/partner/Webhook/WebhookPartnerModel.js +1 -1
  16. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +8 -20
  17. package/sdk/platform/Cart/CartPlatformApplicationClient.js +8 -92
  18. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +1 -15
  19. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +0 -14
  20. package/sdk/platform/Cart/CartPlatformModel.d.ts +1 -87
  21. package/sdk/platform/Cart/CartPlatformModel.js +0 -88
  22. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +1 -1
  23. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +14 -3
  24. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +27 -3
  25. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +14 -2
  26. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +10 -51
  27. package/sdk/platform/Catalog/CatalogPlatformClient.js +79 -400
  28. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +5 -240
  29. package/sdk/platform/Catalog/CatalogPlatformModel.js +3 -169
  30. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +15 -61
  31. package/sdk/platform/Catalog/CatalogPlatformValidator.js +13 -65
  32. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +5 -0
  33. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +2 -0
  34. package/sdk/platform/Finance/FinancePlatformModel.js +1 -1
  35. package/sdk/platform/Order/OrderPlatformModel.d.ts +90 -39
  36. package/sdk/platform/Order/OrderPlatformModel.js +74 -38
  37. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +38 -4
  38. package/sdk/platform/Payment/PaymentPlatformModel.js +17 -7
  39. package/sdk/platform/Webhook/WebhookPlatformModel.js +1 -1
@@ -26,14 +26,6 @@ export = CatalogPlatformValidator;
26
26
  * @typedef CreateBulkProductUploadJobParam
27
27
  * @property {CatalogPlatformModel.BulkJob} body
28
28
  */
29
- /**
30
- * @typedef CreateCategoriesParam
31
- * @property {CatalogPlatformModel.CategoryRequestBody} body
32
- */
33
- /**
34
- * @typedef CreateDepartmentsParam
35
- * @property {CatalogPlatformModel.DepartmentCreateUpdate} body
36
- */
37
29
  /**
38
30
  * @typedef CreateInventoryExportParam
39
31
  * @property {CatalogPlatformModel.InventoryCreateRequest} body
@@ -125,6 +117,11 @@ export = CatalogPlatformValidator;
125
117
  * @property {string} [q] - Search using hsn code, description, reporting_hsn
126
118
  * @property {string} [type] - Search using type
127
119
  */
120
+ /**
121
+ * @typedef GetAttributeParam
122
+ * @property {string} attributeSlug - Slug of the attribute for which you want
123
+ * to view the details
124
+ */
128
125
  /**
129
126
  * @typedef GetCategoryDataParam
130
127
  * @property {string} uid - Category unique id
@@ -145,11 +142,6 @@ export = CatalogPlatformValidator;
145
142
  * @typedef GetDepartmentDataParam
146
143
  * @property {string} uid - A `uid` is a unique identifier of a department.
147
144
  */
148
- /**
149
- * @typedef GetGenderAttributeParam
150
- * @property {string} attributeSlug - Slug of the attribute for which you want
151
- * to view the genders
152
- */
153
145
  /**
154
146
  * @typedef GetHsnCodeParam
155
147
  * @property {string} id - Unique id
@@ -409,16 +401,6 @@ export = CatalogPlatformValidator;
409
401
  * @property {string} [itemType] - A `item_type` is the identifier of the type
410
402
  * of template required.
411
403
  */
412
- /**
413
- * @typedef UpdateCategoryParam
414
- * @property {string} uid - Category unique id
415
- * @property {CatalogPlatformModel.CategoryRequestBody} body
416
- */
417
- /**
418
- * @typedef UpdateDepartmentParam
419
- * @property {string} uid - A `uid` is a unique identifier of a department.
420
- * @property {CatalogPlatformModel.DepartmentCreateUpdate} body
421
- */
422
404
  /**
423
405
  * @typedef UpdateHsnCodeParam
424
406
  * @property {string} id - Unique id
@@ -486,10 +468,6 @@ declare class CatalogPlatformValidator {
486
468
  static createBulkInventoryJob(): CreateBulkInventoryJobParam;
487
469
  /** @returns {CreateBulkProductUploadJobParam} */
488
470
  static createBulkProductUploadJob(): CreateBulkProductUploadJobParam;
489
- /** @returns {CreateCategoriesParam} */
490
- static createCategories(): CreateCategoriesParam;
491
- /** @returns {CreateDepartmentsParam} */
492
- static createDepartments(): CreateDepartmentsParam;
493
471
  /** @returns {CreateInventoryExportParam} */
494
472
  static createInventoryExport(): CreateInventoryExportParam;
495
473
  /** @returns {CreateInventoryExportJobParam} */
@@ -528,6 +506,8 @@ declare class CatalogPlatformValidator {
528
506
  static exportInventoryConfig(): ExportInventoryConfigParam;
529
507
  /** @returns {GetAllProductHsnCodesParam} */
530
508
  static getAllProductHsnCodes(): GetAllProductHsnCodesParam;
509
+ /** @returns {GetAttributeParam} */
510
+ static getAttribute(): GetAttributeParam;
531
511
  /** @returns {GetCategoryDataParam} */
532
512
  static getCategoryData(): GetCategoryDataParam;
533
513
  /** @returns {GetCompanyBrandDetailParam} */
@@ -538,8 +518,6 @@ declare class CatalogPlatformValidator {
538
518
  static getCompanyMetrics(): any;
539
519
  /** @returns {GetDepartmentDataParam} */
540
520
  static getDepartmentData(): GetDepartmentDataParam;
541
- /** @returns {GetGenderAttributeParam} */
542
- static getGenderAttribute(): GetGenderAttributeParam;
543
521
  /** @returns {GetHsnCodeParam} */
544
522
  static getHsnCode(): GetHsnCodeParam;
545
523
  /** @returns {GetInventoriesParam} */
@@ -608,10 +586,6 @@ declare class CatalogPlatformValidator {
608
586
  static listProductTemplateExportDetails(): any;
609
587
  /** @returns {ListTemplateBrandTypeValuesParam} */
610
588
  static listTemplateBrandTypeValues(): ListTemplateBrandTypeValuesParam;
611
- /** @returns {UpdateCategoryParam} */
612
- static updateCategory(): UpdateCategoryParam;
613
- /** @returns {UpdateDepartmentParam} */
614
- static updateDepartment(): UpdateDepartmentParam;
615
589
  /** @returns {UpdateHsnCodeParam} */
616
590
  static updateHsnCode(): UpdateHsnCodeParam;
617
591
  /** @returns {UpdateInventoriesParam} */
@@ -632,7 +606,7 @@ declare class CatalogPlatformValidator {
632
606
  static validateProductTemplateSchema(): ValidateProductTemplateSchemaParam;
633
607
  }
634
608
  declare namespace CatalogPlatformValidator {
635
- export { AddInventoryParam, AllSizesParam, BulkHsnCodeParam, CreateBulkInventoryParam, CreateBulkInventoryJobParam, CreateBulkProductUploadJobParam, CreateCategoriesParam, CreateDepartmentsParam, CreateInventoryExportParam, CreateInventoryExportJobParam, CreateMarketplaceOptinParam, CreateProductParam, CreateProductAssetsInBulkParam, CreateProductBundleParam, CreateProductExportJobParam, CreateProductsInBulkParam, CreateSizeGuideParam, DeleteBulkInventoryJobParam, DeleteProductParam, DeleteProductBulkJobParam, DeleteRealtimeInventoryParam, DeleteSizeParam, DownloadInventoryTemplateViewParam, DownloadProductTemplateViewsParam, EditProductParam, ExportInventoryConfigParam, GetAllProductHsnCodesParam, GetCategoryDataParam, GetCompanyBrandDetailParam, GetCompanyDetailParam, GetCompanyMetricsParam, GetDepartmentDataParam, GetGenderAttributeParam, GetHsnCodeParam, GetInventoriesParam, GetInventoryBulkUploadHistoryParam, GetInventoryBySizeParam, GetInventoryBySizeIdentifierParam, GetInventoryExportParam, GetMarketplaceOptinDetailParam, GetMarketplacesParam, GetOptimalLocationsParam, GetProductParam, GetProductAssetsInBulkParam, GetProductAttributesParam, GetProductBulkUploadHistoryParam, GetProductBundleParam, GetProductBundleDetailParam, GetProductExportJobsParam, GetProductSizeParam, GetProductTagsParam, GetProductValidationParam, GetProductsParam, GetSellerInsightsParam, GetSingleProductHSNCodeParam, GetSizeGuideParam, GetSizeGuidesParam, GetStoreDetailParam, GetVariantsOfProductsParam, ListCategoriesParam, ListDepartmentsDataParam, ListHSNCodesParam, ListInventoryExportParam, ListProductTemplateParam, ListProductTemplateCategoriesParam, ListProductTemplateExportDetailsParam, ListTemplateBrandTypeValuesParam, UpdateCategoryParam, UpdateDepartmentParam, UpdateHsnCodeParam, UpdateInventoriesParam, UpdateMarketplaceOptinParam, UpdateProductBundleParam, UpdateRealtimeInventoryParam, UpdateSizeGuideParam, UploadBulkProductsParam, ValidateProductTemplateParam, ValidateProductTemplateSchemaParam };
609
+ export { AddInventoryParam, AllSizesParam, BulkHsnCodeParam, CreateBulkInventoryParam, CreateBulkInventoryJobParam, CreateBulkProductUploadJobParam, CreateInventoryExportParam, CreateInventoryExportJobParam, CreateMarketplaceOptinParam, CreateProductParam, CreateProductAssetsInBulkParam, CreateProductBundleParam, CreateProductExportJobParam, CreateProductsInBulkParam, CreateSizeGuideParam, DeleteBulkInventoryJobParam, DeleteProductParam, DeleteProductBulkJobParam, DeleteRealtimeInventoryParam, DeleteSizeParam, DownloadInventoryTemplateViewParam, DownloadProductTemplateViewsParam, EditProductParam, ExportInventoryConfigParam, GetAllProductHsnCodesParam, GetAttributeParam, GetCategoryDataParam, GetCompanyBrandDetailParam, GetCompanyDetailParam, GetCompanyMetricsParam, GetDepartmentDataParam, GetHsnCodeParam, GetInventoriesParam, GetInventoryBulkUploadHistoryParam, GetInventoryBySizeParam, GetInventoryBySizeIdentifierParam, GetInventoryExportParam, GetMarketplaceOptinDetailParam, GetMarketplacesParam, GetOptimalLocationsParam, GetProductParam, GetProductAssetsInBulkParam, GetProductAttributesParam, GetProductBulkUploadHistoryParam, GetProductBundleParam, GetProductBundleDetailParam, GetProductExportJobsParam, GetProductSizeParam, GetProductTagsParam, GetProductValidationParam, GetProductsParam, GetSellerInsightsParam, GetSingleProductHSNCodeParam, GetSizeGuideParam, GetSizeGuidesParam, GetStoreDetailParam, GetVariantsOfProductsParam, ListCategoriesParam, ListDepartmentsDataParam, ListHSNCodesParam, ListInventoryExportParam, ListProductTemplateParam, ListProductTemplateCategoriesParam, ListProductTemplateExportDetailsParam, ListTemplateBrandTypeValuesParam, UpdateHsnCodeParam, UpdateInventoriesParam, UpdateMarketplaceOptinParam, UpdateProductBundleParam, UpdateRealtimeInventoryParam, UpdateSizeGuideParam, UploadBulkProductsParam, ValidateProductTemplateParam, ValidateProductTemplateSchemaParam };
636
610
  }
637
611
  type AddInventoryParam = {
638
612
  /**
@@ -667,12 +641,6 @@ type CreateBulkInventoryJobParam = {
667
641
  type CreateBulkProductUploadJobParam = {
668
642
  body: CatalogPlatformModel.BulkJob;
669
643
  };
670
- type CreateCategoriesParam = {
671
- body: CatalogPlatformModel.CategoryRequestBody;
672
- };
673
- type CreateDepartmentsParam = {
674
- body: CatalogPlatformModel.DepartmentCreateUpdate;
675
- };
676
644
  type CreateInventoryExportParam = {
677
645
  body: CatalogPlatformModel.InventoryCreateRequest;
678
646
  };
@@ -802,6 +770,13 @@ type GetAllProductHsnCodesParam = {
802
770
  */
803
771
  type?: string;
804
772
  };
773
+ type GetAttributeParam = {
774
+ /**
775
+ * - Slug of the attribute for which you want
776
+ * to view the details
777
+ */
778
+ attributeSlug: string;
779
+ };
805
780
  type GetCategoryDataParam = {
806
781
  /**
807
782
  * - Category unique id
@@ -838,13 +813,6 @@ type GetDepartmentDataParam = {
838
813
  */
839
814
  uid: string;
840
815
  };
841
- type GetGenderAttributeParam = {
842
- /**
843
- * - Slug of the attribute for which you want
844
- * to view the genders
845
- */
846
- attributeSlug: string;
847
- };
848
816
  type GetHsnCodeParam = {
849
817
  /**
850
818
  * - Unique id
@@ -1409,20 +1377,6 @@ type ListTemplateBrandTypeValuesParam = {
1409
1377
  */
1410
1378
  itemType?: string;
1411
1379
  };
1412
- type UpdateCategoryParam = {
1413
- /**
1414
- * - Category unique id
1415
- */
1416
- uid: string;
1417
- body: CatalogPlatformModel.CategoryRequestBody;
1418
- };
1419
- type UpdateDepartmentParam = {
1420
- /**
1421
- * - A `uid` is a unique identifier of a department.
1422
- */
1423
- uid: string;
1424
- body: CatalogPlatformModel.DepartmentCreateUpdate;
1425
- };
1426
1380
  type UpdateHsnCodeParam = {
1427
1381
  /**
1428
1382
  * - Unique id
@@ -35,16 +35,6 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
35
35
  * @property {CatalogPlatformModel.BulkJob} body
36
36
  */
37
37
 
38
- /**
39
- * @typedef CreateCategoriesParam
40
- * @property {CatalogPlatformModel.CategoryRequestBody} body
41
- */
42
-
43
- /**
44
- * @typedef CreateDepartmentsParam
45
- * @property {CatalogPlatformModel.DepartmentCreateUpdate} body
46
- */
47
-
48
38
  /**
49
39
  * @typedef CreateInventoryExportParam
50
40
  * @property {CatalogPlatformModel.InventoryCreateRequest} body
@@ -155,6 +145,12 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
155
145
  * @property {string} [type] - Search using type
156
146
  */
157
147
 
148
+ /**
149
+ * @typedef GetAttributeParam
150
+ * @property {string} attributeSlug - Slug of the attribute for which you want
151
+ * to view the details
152
+ */
153
+
158
154
  /**
159
155
  * @typedef GetCategoryDataParam
160
156
  * @property {string} uid - Category unique id
@@ -180,12 +176,6 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
180
176
  * @property {string} uid - A `uid` is a unique identifier of a department.
181
177
  */
182
178
 
183
- /**
184
- * @typedef GetGenderAttributeParam
185
- * @property {string} attributeSlug - Slug of the attribute for which you want
186
- * to view the genders
187
- */
188
-
189
179
  /**
190
180
  * @typedef GetHsnCodeParam
191
181
  * @property {string} id - Unique id
@@ -479,18 +469,6 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
479
469
  * of template required.
480
470
  */
481
471
 
482
- /**
483
- * @typedef UpdateCategoryParam
484
- * @property {string} uid - Category unique id
485
- * @property {CatalogPlatformModel.CategoryRequestBody} body
486
- */
487
-
488
- /**
489
- * @typedef UpdateDepartmentParam
490
- * @property {string} uid - A `uid` is a unique identifier of a department.
491
- * @property {CatalogPlatformModel.DepartmentCreateUpdate} body
492
- */
493
-
494
472
  /**
495
473
  * @typedef UpdateHsnCodeParam
496
474
  * @property {string} id - Unique id
@@ -600,20 +578,6 @@ class CatalogPlatformValidator {
600
578
  }).required();
601
579
  }
602
580
 
603
- /** @returns {CreateCategoriesParam} */
604
- static createCategories() {
605
- return Joi.object({
606
- body: CatalogPlatformModel.CategoryRequestBody().required(),
607
- }).required();
608
- }
609
-
610
- /** @returns {CreateDepartmentsParam} */
611
- static createDepartments() {
612
- return Joi.object({
613
- body: CatalogPlatformModel.DepartmentCreateUpdate().required(),
614
- }).required();
615
- }
616
-
617
581
  /** @returns {CreateInventoryExportParam} */
618
582
  static createInventoryExport() {
619
583
  return Joi.object({
@@ -758,6 +722,13 @@ class CatalogPlatformValidator {
758
722
  }).required();
759
723
  }
760
724
 
725
+ /** @returns {GetAttributeParam} */
726
+ static getAttribute() {
727
+ return Joi.object({
728
+ attributeSlug: Joi.string().allow("").required(),
729
+ }).required();
730
+ }
731
+
761
732
  /** @returns {GetCategoryDataParam} */
762
733
  static getCategoryData() {
763
734
  return Joi.object({
@@ -793,13 +764,6 @@ class CatalogPlatformValidator {
793
764
  }).required();
794
765
  }
795
766
 
796
- /** @returns {GetGenderAttributeParam} */
797
- static getGenderAttribute() {
798
- return Joi.object({
799
- attributeSlug: Joi.string().allow("").required(),
800
- }).required();
801
- }
802
-
803
767
  /** @returns {GetHsnCodeParam} */
804
768
  static getHsnCode() {
805
769
  return Joi.object({
@@ -1111,22 +1075,6 @@ class CatalogPlatformValidator {
1111
1075
  }).required();
1112
1076
  }
1113
1077
 
1114
- /** @returns {UpdateCategoryParam} */
1115
- static updateCategory() {
1116
- return Joi.object({
1117
- uid: Joi.string().allow("").required(),
1118
- body: CatalogPlatformModel.CategoryRequestBody().required(),
1119
- }).required();
1120
- }
1121
-
1122
- /** @returns {UpdateDepartmentParam} */
1123
- static updateDepartment() {
1124
- return Joi.object({
1125
- uid: Joi.string().allow("").required(),
1126
- body: CatalogPlatformModel.DepartmentCreateUpdate().required(),
1127
- }).required();
1128
- }
1129
-
1130
1078
  /** @returns {UpdateHsnCodeParam} */
1131
1079
  static updateHsnCode() {
1132
1080
  return Joi.object({
@@ -774,6 +774,7 @@ export = ConfigurationPlatformModel;
774
774
  */
775
775
  /**
776
776
  * @typedef GoogleMap
777
+ * @property {boolean} [enabled] - Shows whether Google map integration is enabled or not.
777
778
  * @property {GoogleMapCredentials} [credentials]
778
779
  */
779
780
  /**
@@ -2882,6 +2883,10 @@ type FyndRewardsCredentials = {
2882
2883
  /** @returns {GoogleMap} */
2883
2884
  declare function GoogleMap(): GoogleMap;
2884
2885
  type GoogleMap = {
2886
+ /**
2887
+ * - Shows whether Google map integration is enabled or not.
2888
+ */
2889
+ enabled?: boolean;
2885
2890
  credentials?: GoogleMapCredentials;
2886
2891
  };
2887
2892
  /** @returns {GoogleMapCredentials} */
@@ -876,6 +876,7 @@ const Joi = require("joi");
876
876
 
877
877
  /**
878
878
  * @typedef GoogleMap
879
+ * @property {boolean} [enabled] - Shows whether Google map integration is enabled or not.
879
880
  * @property {GoogleMapCredentials} [credentials]
880
881
  */
881
882
 
@@ -2473,6 +2474,7 @@ class ConfigurationPlatformModel {
2473
2474
  /** @returns {GoogleMap} */
2474
2475
  static GoogleMap() {
2475
2476
  return Joi.object({
2477
+ enabled: Joi.boolean(),
2476
2478
  credentials: ConfigurationPlatformModel.GoogleMapCredentials(),
2477
2479
  });
2478
2480
  }
@@ -1064,7 +1064,7 @@ class FinancePlatformModel {
1064
1064
  code: Joi.string().allow(""),
1065
1065
  symbol: Joi.string().allow(""),
1066
1066
  name: Joi.string().allow(""),
1067
- });
1067
+ }).allow(null);
1068
1068
  }
1069
1069
 
1070
1070
  /** @returns {GenerateReportJson} */
@@ -435,6 +435,33 @@ export = OrderPlatformModel;
435
435
  * @property {string} [store_lookup]
436
436
  * @property {AffiliateStoreIdMapping[]} affiliate_store_id_mapping
437
437
  */
438
+ /**
439
+ * @typedef DPConfiguration
440
+ * @property {string} [shipping_by] - Shipping_by denotes dp assignment
441
+ * strategy- if shipping_by is fynd dp assignment would be handled by OMS
442
+ */
443
+ /**
444
+ * @typedef PaymentConfig
445
+ * @property {string} [mode_of_payment] - Specifies the mode through which the
446
+ * payment was collected, serving as an identifier for the payment's origin.
447
+ * @property {string} [source] - The source field identifies the channel through
448
+ * which the order was placed, such as MARKETPLACE, ECOMM.
449
+ */
450
+ /**
451
+ * @typedef CreateOrderConfig
452
+ * @property {DPConfiguration} [dp_configuration]
453
+ * @property {string} [integration_type] - Flag denotes integration type which
454
+ * is used to retrieve specific configurations and application details
455
+ * relevant to channel fulfillment.
456
+ * @property {boolean} [location_reassignment] - Flag denotes if the location
457
+ * for the store needs to be reassigned post cancellation.
458
+ * @property {PaymentConfig} [payment]
459
+ * @property {boolean} [optimal_shipment_creation] - Denotes the shipment
460
+ * breaking strategy. If the flag is set true, the shipment is created using
461
+ * optimal shipment creation strategy based on the servicability & packaging
462
+ * dimensions by OMS .If false, shipment details, including location_id, must
463
+ * be passed to FDK for processing.
464
+ */
438
465
  /**
439
466
  * @typedef CreateOrderPayload
440
467
  * @property {string} affiliate_id
@@ -683,8 +710,12 @@ export = OrderPlatformModel;
683
710
  * @property {ProcessingDates} [processing_dates]
684
711
  * @property {Object} [meta] - Meta data of the shipment.
685
712
  * @property {number} [priority] - Integer value indicating high and low priority.
686
- * @property {number} location_id - Location Identifier or Store/Fulfillment
687
- * Identifier of the shipment.
713
+ * @property {number} [location_id] - Location Identifier or Store/Fulfillment
714
+ * Identifier of the shipment- This field is mandatory when
715
+ * optimal_shipment_creation flag is set to false, indicating that shipments
716
+ * must be associated with a specific location. When
717
+ * `optimal_shipment_creation` is true, the optimal location for order
718
+ * creation would be assigned, location_id becomes optional.
688
719
  * @property {string} [order_type] - The order type of shipment HomeDelivery -
689
720
  * If the customer wants the order home-delivered PickAtStore - If the
690
721
  * customer wants the handover of an order at the store itself.
@@ -716,16 +747,6 @@ export = OrderPlatformModel;
716
747
  * @property {Prices} [price]
717
748
  * @property {ShipmentGstDetails} [gst]
718
749
  */
719
- /**
720
- * @typedef ShipmentRequestData
721
- * @property {LineItem[]} line_items
722
- * @property {ProcessingDates} [processing_dates]
723
- * @property {Object} [meta] - Meta data of the shipment.
724
- * @property {number} [priority] - Integer value indicating high and low priority.
725
- * @property {string} [order_type] - The order type of shipment HomeDelivery -
726
- * If the customer wants the order home-delivered PickAtStore - If the
727
- * customer wants the handover of an order at the store itself.
728
- */
729
750
  /**
730
751
  * @typedef ShippingInfo
731
752
  * @property {string} [alternate_mobile_number]
@@ -820,7 +841,6 @@ export = OrderPlatformModel;
820
841
  /**
821
842
  * @typedef CreateOrderAPI
822
843
  * @property {Shipment[]} shipments
823
- * @property {ShipmentRequestData} [shipment_request_data]
824
844
  * @property {ShippingInfo} shipping_info
825
845
  * @property {BillingInfo} billing_info
826
846
  * @property {Object} [currency_info]
@@ -829,7 +849,7 @@ export = OrderPlatformModel;
829
849
  * @property {string} [external_creation_date]
830
850
  * @property {Object} [meta]
831
851
  * @property {TaxInfo} [tax_info]
832
- * @property {Object} [config]
852
+ * @property {CreateOrderConfig} [config]
833
853
  * @property {PaymentInfo} payment_info
834
854
  * @property {UserInfo} [user_info]
835
855
  * @property {number} [ordering_store_id]
@@ -3086,7 +3106,7 @@ export = OrderPlatformModel;
3086
3106
  declare class OrderPlatformModel {
3087
3107
  }
3088
3108
  declare namespace OrderPlatformModel {
3089
- export { InvalidateShipmentCachePayload, InvalidateShipmentCacheNestedResponse, InvalidateShipmentCacheResponse, ErrorResponse, StoreReassign, StoreReassignResponse, Entities, UpdateShipmentLockPayload, OriginalFilter, Bags, CheckResponse, UpdateShipmentLockResponse, AnnouncementResponse, AnnouncementsResponse, BaseResponse, Click2CallResponse, ErrorDetail, ProductsReasonsFilters, ProductsReasonsData, ProductsReasons, EntityReasonData, EntitiesReasons, ReasonsData, Products, OrderItemDataUpdates, ProductsDataUpdatesFilters, ProductsDataUpdates, EntitiesDataUpdates, DataUpdates, ShipmentsRequest, StatuesRequest, UpdateShipmentStatusRequest, ShipmentsResponse, StatuesResponse, UpdateShipmentStatusResponseBody, OrderUser, OrderPriority, ArticleDetails, LocationDetails, ShipmentDetails, ShipmentConfig, ShipmentData, MarketPlacePdf, AffiliateBag, UserData, OrderInfo, AffiliateAppConfigMeta, AffiliateAppConfig, AffiliateInventoryArticleAssignmentConfig, AffiliateInventoryPaymentConfig, AffiliateInventoryStoreConfig, AffiliateInventoryOrderConfig, AffiliateInventoryLogisticsConfig, AffiliateInventoryConfig, AffiliateConfig, Affiliate, AffiliateStoreIdMapping, OrderConfig, CreateOrderPayload, CreateOrderResponse, DispatchManifest, SuccessResponse, ActionInfo, GetActionsResponse, HistoryReason, HistoryMeta, HistoryDict, ShipmentHistoryResponse, PostHistoryFilters, PostHistoryData, PostHistoryDict, PostShipmentHistory, SmsDataPayload, SendSmsPayload, OrderDetails, Meta, ShipmentDetail, OrderStatusData, OrderStatusResult, Dimension, UpdatePackagingDimensionsPayload, UpdatePackagingDimensionsResponse, Tax, Charge, LineItem, ProcessingDates, Shipment, ShipmentRequestData, ShippingInfo, BillingInfo, UserInfo, TaxInfo, PaymentMethod, PaymentInfo, CreateOrderAPI, CreateOrderErrorReponse, DpConfiguration, PaymentMethods, CreateChannelPaymentInfo, CreateChannelConfig, CreateChannelConfigData, CreateChannelConifgErrorResponse, CreateChannelConfigResponse, UploadConsent, PlatformOrderUpdate, ResponseDetail, FyndOrderIdList, OrderStatus, BagStateTransitionMap, RoleBaseStateTransitionMapping, FetchCreditBalanceRequestPayload, CreditBalanceInfo, FetchCreditBalanceResponsePayload, RefundModeConfigRequestPayload, RefundOption, RefundModeInfo, RefundModeConfigResponsePayload, AttachUserOtpData, AttachUserInfo, AttachOrderUser, AttachOrderUserResponse, SendUserMobileOTP, PointBlankOtpData, SendUserMobileOtpResponse, VerifyOtpData, VerifyMobileOTP, VerifyOtpResponseData, VerifyOtpResponse, BulkReportsDownloadRequest, BulkReportsDownloadResponse, BulkFailedResponse, BulkStateTransistionRequest, BulkStateTransistionResponse, ShipmentActionInfo, BulkActionListingData, BulkListinPage, BulkListingResponse, JobDetailsData, JobDetailsResponse, JobFailedResponse, ManifestPageInfo, ManifestItemDetails, ManifestShipmentListing, DateRange, Filters, ManifestFile, ManifestMediaUpdate, PDFMeta, TotalShipmentPricesCount, ManifestMeta, Manifest, ManifestList, ManifestDetails, FiltersRequest, ProcessManifest, ProcessManifestResponse, ProcessManifestItemResponse, FilterInfoOption, FiltersInfo, ManifestFiltersResponse, PageDetails, EInvoiceIrnDetails, EInvoiceErrorDetails, EInvoiceDetails, EInvoiceResponseData, EInvoiceRetry, EInvoiceRetryResponse, EInvoiceErrorInfo, EInvoiceErrorResponseData, EInvoiceErrorResponse, EInvoiceErrorResponseDetails, EInvoiceRetryShipmentData, CourierPartnerTrackingDetails, CourierPartnerTrackingResponse, LogsChannelDetails, LogPaymentDetails, FailedOrdersItem, FailedOrderLogs, FailedOrderLogDetails, GenerateInvoiceIDResponseData, GenerateInvoiceIDErrorResponseData, GenerateInvoiceIDRequest, GenerateInvoiceIDResponse, GenerateInvoiceIDErrorResponse, ManifestResponse, ProcessManifestRequest, ManifestItems, ManifestErrorResponse, ConfigData, ConfigUpdatedResponse, FlagData, Flags, Filter, PostHook, PreHook, Config, TransitionConfigCondition, TransitionConfigData, TransitionConfigPayload, Page, BagReasonMeta, QuestionSet, BagReasons, ShipmentBagReasons, ShipmentStatus, UserDataInfo, PlatformDeliveryAddress, ShipmentListingChannel, Prices, Identifier, FinancialBreakup, GSTDetailsData, BagStateMapper, BagStatusHistory, Dimensions, ReturnConfig, Weight, Article, ShipmentListingBrand, ReplacementDetails, AffiliateMeta, AffiliateBagDetails, PlatformArticleAttributes, PlatformItem, Dates, BagReturnableCancelableStatus, BagUnit, ShipmentItemFulFillingStore, Currency, OrderingCurrency, ConversionRate, CurrencyInfo, ShipmentItem, ShipmentInternalPlatformViewResponse, TrackingList, InvoiceInfo, OrderDetailsData, UserDetailsData, PhoneDetails, ContactDetails, CompanyDetails, OrderingStoreDetails, DPDetailsData, BuyerDetails, DebugInfo, EinvoiceInfo, Formatted, ShipmentTags, LockData, ShipmentTimeStamp, ShipmentMeta, PDFLinks, AffiliateDetails, BagConfigs, OrderBagArticle, OrderBrandName, AffiliateBagsDetails, BagPaymentMethods, DiscountRules, ItemCriterias, BuyRules, AppliedPromos, CurrentStatus, OrderBags, FulfillingStore, ShipmentPayments, ShipmentStatusData, ShipmentLockDetails, PlatformShipment, ShipmentInfoResponse, TaxDetails, PaymentInfoData, OrderData, OrderDetailsResponse, SubLane, SuperLane, LaneConfigResponse, PlatformBreakupValues, PlatformChannel, PlatformOrderItems, OrderListingResponse, PlatformTrack, PlatformShipmentTrack, AdvanceFilterInfo, FiltersResponse, URL, FileResponse, BulkActionTemplate, BulkActionTemplateResponse, Reason, PlatformShipmentReasonsResponse, ShipmentResponseReasons, ShipmentReasonsResponse, StoreAddress, EInvoicePortalDetails, StoreEinvoice, StoreEwaybill, StoreGstCredentials, Document, StoreDocuments, StoreMeta, Store, Brand, Item, ArticleStatusDetails, Company, ShipmentGstDetails, DeliverySlotDetails, InvoiceDetails, UserDetails, WeightData, BagDetails, BagDetailsPlatformResponse, BagsPage, BagData, GetBagsPlatformResponse, GeneratePosOrderReceiptResponse, Templates, AllowedTemplatesResponse, TemplateDownloadResponse, Error };
3109
+ export { InvalidateShipmentCachePayload, InvalidateShipmentCacheNestedResponse, InvalidateShipmentCacheResponse, ErrorResponse, StoreReassign, StoreReassignResponse, Entities, UpdateShipmentLockPayload, OriginalFilter, Bags, CheckResponse, UpdateShipmentLockResponse, AnnouncementResponse, AnnouncementsResponse, BaseResponse, Click2CallResponse, ErrorDetail, ProductsReasonsFilters, ProductsReasonsData, ProductsReasons, EntityReasonData, EntitiesReasons, ReasonsData, Products, OrderItemDataUpdates, ProductsDataUpdatesFilters, ProductsDataUpdates, EntitiesDataUpdates, DataUpdates, ShipmentsRequest, StatuesRequest, UpdateShipmentStatusRequest, ShipmentsResponse, StatuesResponse, UpdateShipmentStatusResponseBody, OrderUser, OrderPriority, ArticleDetails, LocationDetails, ShipmentDetails, ShipmentConfig, ShipmentData, MarketPlacePdf, AffiliateBag, UserData, OrderInfo, AffiliateAppConfigMeta, AffiliateAppConfig, AffiliateInventoryArticleAssignmentConfig, AffiliateInventoryPaymentConfig, AffiliateInventoryStoreConfig, AffiliateInventoryOrderConfig, AffiliateInventoryLogisticsConfig, AffiliateInventoryConfig, AffiliateConfig, Affiliate, AffiliateStoreIdMapping, OrderConfig, DPConfiguration, PaymentConfig, CreateOrderConfig, CreateOrderPayload, CreateOrderResponse, DispatchManifest, SuccessResponse, ActionInfo, GetActionsResponse, HistoryReason, HistoryMeta, HistoryDict, ShipmentHistoryResponse, PostHistoryFilters, PostHistoryData, PostHistoryDict, PostShipmentHistory, SmsDataPayload, SendSmsPayload, OrderDetails, Meta, ShipmentDetail, OrderStatusData, OrderStatusResult, Dimension, UpdatePackagingDimensionsPayload, UpdatePackagingDimensionsResponse, Tax, Charge, LineItem, ProcessingDates, Shipment, ShippingInfo, BillingInfo, UserInfo, TaxInfo, PaymentMethod, PaymentInfo, CreateOrderAPI, CreateOrderErrorReponse, DpConfiguration, PaymentMethods, CreateChannelPaymentInfo, CreateChannelConfig, CreateChannelConfigData, CreateChannelConifgErrorResponse, CreateChannelConfigResponse, UploadConsent, PlatformOrderUpdate, ResponseDetail, FyndOrderIdList, OrderStatus, BagStateTransitionMap, RoleBaseStateTransitionMapping, FetchCreditBalanceRequestPayload, CreditBalanceInfo, FetchCreditBalanceResponsePayload, RefundModeConfigRequestPayload, RefundOption, RefundModeInfo, RefundModeConfigResponsePayload, AttachUserOtpData, AttachUserInfo, AttachOrderUser, AttachOrderUserResponse, SendUserMobileOTP, PointBlankOtpData, SendUserMobileOtpResponse, VerifyOtpData, VerifyMobileOTP, VerifyOtpResponseData, VerifyOtpResponse, BulkReportsDownloadRequest, BulkReportsDownloadResponse, BulkFailedResponse, BulkStateTransistionRequest, BulkStateTransistionResponse, ShipmentActionInfo, BulkActionListingData, BulkListinPage, BulkListingResponse, JobDetailsData, JobDetailsResponse, JobFailedResponse, ManifestPageInfo, ManifestItemDetails, ManifestShipmentListing, DateRange, Filters, ManifestFile, ManifestMediaUpdate, PDFMeta, TotalShipmentPricesCount, ManifestMeta, Manifest, ManifestList, ManifestDetails, FiltersRequest, ProcessManifest, ProcessManifestResponse, ProcessManifestItemResponse, FilterInfoOption, FiltersInfo, ManifestFiltersResponse, PageDetails, EInvoiceIrnDetails, EInvoiceErrorDetails, EInvoiceDetails, EInvoiceResponseData, EInvoiceRetry, EInvoiceRetryResponse, EInvoiceErrorInfo, EInvoiceErrorResponseData, EInvoiceErrorResponse, EInvoiceErrorResponseDetails, EInvoiceRetryShipmentData, CourierPartnerTrackingDetails, CourierPartnerTrackingResponse, LogsChannelDetails, LogPaymentDetails, FailedOrdersItem, FailedOrderLogs, FailedOrderLogDetails, GenerateInvoiceIDResponseData, GenerateInvoiceIDErrorResponseData, GenerateInvoiceIDRequest, GenerateInvoiceIDResponse, GenerateInvoiceIDErrorResponse, ManifestResponse, ProcessManifestRequest, ManifestItems, ManifestErrorResponse, ConfigData, ConfigUpdatedResponse, FlagData, Flags, Filter, PostHook, PreHook, Config, TransitionConfigCondition, TransitionConfigData, TransitionConfigPayload, Page, BagReasonMeta, QuestionSet, BagReasons, ShipmentBagReasons, ShipmentStatus, UserDataInfo, PlatformDeliveryAddress, ShipmentListingChannel, Prices, Identifier, FinancialBreakup, GSTDetailsData, BagStateMapper, BagStatusHistory, Dimensions, ReturnConfig, Weight, Article, ShipmentListingBrand, ReplacementDetails, AffiliateMeta, AffiliateBagDetails, PlatformArticleAttributes, PlatformItem, Dates, BagReturnableCancelableStatus, BagUnit, ShipmentItemFulFillingStore, Currency, OrderingCurrency, ConversionRate, CurrencyInfo, ShipmentItem, ShipmentInternalPlatformViewResponse, TrackingList, InvoiceInfo, OrderDetailsData, UserDetailsData, PhoneDetails, ContactDetails, CompanyDetails, OrderingStoreDetails, DPDetailsData, BuyerDetails, DebugInfo, EinvoiceInfo, Formatted, ShipmentTags, LockData, ShipmentTimeStamp, ShipmentMeta, PDFLinks, AffiliateDetails, BagConfigs, OrderBagArticle, OrderBrandName, AffiliateBagsDetails, BagPaymentMethods, DiscountRules, ItemCriterias, BuyRules, AppliedPromos, CurrentStatus, OrderBags, FulfillingStore, ShipmentPayments, ShipmentStatusData, ShipmentLockDetails, PlatformShipment, ShipmentInfoResponse, TaxDetails, PaymentInfoData, OrderData, OrderDetailsResponse, SubLane, SuperLane, LaneConfigResponse, PlatformBreakupValues, PlatformChannel, PlatformOrderItems, OrderListingResponse, PlatformTrack, PlatformShipmentTrack, AdvanceFilterInfo, FiltersResponse, URL, FileResponse, BulkActionTemplate, BulkActionTemplateResponse, Reason, PlatformShipmentReasonsResponse, ShipmentResponseReasons, ShipmentReasonsResponse, StoreAddress, EInvoicePortalDetails, StoreEinvoice, StoreEwaybill, StoreGstCredentials, Document, StoreDocuments, StoreMeta, Store, Brand, Item, ArticleStatusDetails, Company, ShipmentGstDetails, DeliverySlotDetails, InvoiceDetails, UserDetails, WeightData, BagDetails, BagDetailsPlatformResponse, BagsPage, BagData, GetBagsPlatformResponse, GeneratePosOrderReceiptResponse, Templates, AllowedTemplatesResponse, TemplateDownloadResponse, Error };
3090
3110
  }
3091
3111
  /** @returns {InvalidateShipmentCachePayload} */
3092
3112
  declare function InvalidateShipmentCachePayload(): InvalidateShipmentCachePayload;
@@ -3738,6 +3758,54 @@ type OrderConfig = {
3738
3758
  store_lookup?: string;
3739
3759
  affiliate_store_id_mapping: AffiliateStoreIdMapping[];
3740
3760
  };
3761
+ /** @returns {DPConfiguration} */
3762
+ declare function DPConfiguration(): DPConfiguration;
3763
+ type DPConfiguration = {
3764
+ /**
3765
+ * - Shipping_by denotes dp assignment
3766
+ * strategy- if shipping_by is fynd dp assignment would be handled by OMS
3767
+ */
3768
+ shipping_by?: string;
3769
+ };
3770
+ /** @returns {PaymentConfig} */
3771
+ declare function PaymentConfig(): PaymentConfig;
3772
+ type PaymentConfig = {
3773
+ /**
3774
+ * - Specifies the mode through which the
3775
+ * payment was collected, serving as an identifier for the payment's origin.
3776
+ */
3777
+ mode_of_payment?: string;
3778
+ /**
3779
+ * - The source field identifies the channel through
3780
+ * which the order was placed, such as MARKETPLACE, ECOMM.
3781
+ */
3782
+ source?: string;
3783
+ };
3784
+ /** @returns {CreateOrderConfig} */
3785
+ declare function CreateOrderConfig(): CreateOrderConfig;
3786
+ type CreateOrderConfig = {
3787
+ dp_configuration?: DPConfiguration;
3788
+ /**
3789
+ * - Flag denotes integration type which
3790
+ * is used to retrieve specific configurations and application details
3791
+ * relevant to channel fulfillment.
3792
+ */
3793
+ integration_type?: string;
3794
+ /**
3795
+ * - Flag denotes if the location
3796
+ * for the store needs to be reassigned post cancellation.
3797
+ */
3798
+ location_reassignment?: boolean;
3799
+ payment?: PaymentConfig;
3800
+ /**
3801
+ * - Denotes the shipment
3802
+ * breaking strategy. If the flag is set true, the shipment is created using
3803
+ * optimal shipment creation strategy based on the servicability & packaging
3804
+ * dimensions by OMS .If false, shipment details, including location_id, must
3805
+ * be passed to FDK for processing.
3806
+ */
3807
+ optimal_shipment_creation?: boolean;
3808
+ };
3741
3809
  /** @returns {CreateOrderPayload} */
3742
3810
  declare function CreateOrderPayload(): CreateOrderPayload;
3743
3811
  type CreateOrderPayload = {
@@ -4131,9 +4199,13 @@ type Shipment = {
4131
4199
  priority?: number;
4132
4200
  /**
4133
4201
  * - Location Identifier or Store/Fulfillment
4134
- * Identifier of the shipment.
4202
+ * Identifier of the shipment- This field is mandatory when
4203
+ * optimal_shipment_creation flag is set to false, indicating that shipments
4204
+ * must be associated with a specific location. When
4205
+ * `optimal_shipment_creation` is true, the optimal location for order
4206
+ * creation would be assigned, location_id becomes optional.
4135
4207
  */
4136
- location_id: number;
4208
+ location_id?: number;
4137
4209
  /**
4138
4210
  * - The order type of shipment HomeDelivery -
4139
4211
  * If the customer wants the order home-delivered PickAtStore - If the
@@ -4168,26 +4240,6 @@ type Shipment = {
4168
4240
  price?: Prices;
4169
4241
  gst?: ShipmentGstDetails;
4170
4242
  };
4171
- /** @returns {ShipmentRequestData} */
4172
- declare function ShipmentRequestData(): ShipmentRequestData;
4173
- type ShipmentRequestData = {
4174
- line_items: LineItem[];
4175
- processing_dates?: ProcessingDates;
4176
- /**
4177
- * - Meta data of the shipment.
4178
- */
4179
- meta?: any;
4180
- /**
4181
- * - Integer value indicating high and low priority.
4182
- */
4183
- priority?: number;
4184
- /**
4185
- * - The order type of shipment HomeDelivery -
4186
- * If the customer wants the order home-delivered PickAtStore - If the
4187
- * customer wants the handover of an order at the store itself.
4188
- */
4189
- order_type?: string;
4190
- };
4191
4243
  /** @returns {ShippingInfo} */
4192
4244
  declare function ShippingInfo(): ShippingInfo;
4193
4245
  type ShippingInfo = {
@@ -4295,7 +4347,6 @@ type PaymentInfo = {
4295
4347
  declare function CreateOrderAPI(): CreateOrderAPI;
4296
4348
  type CreateOrderAPI = {
4297
4349
  shipments: Shipment[];
4298
- shipment_request_data?: ShipmentRequestData;
4299
4350
  shipping_info: ShippingInfo;
4300
4351
  billing_info: BillingInfo;
4301
4352
  currency_info?: any;
@@ -4304,7 +4355,7 @@ type CreateOrderAPI = {
4304
4355
  external_creation_date?: string;
4305
4356
  meta?: any;
4306
4357
  tax_info?: TaxInfo;
4307
- config?: any;
4358
+ config?: CreateOrderConfig;
4308
4359
  payment_info: PaymentInfo;
4309
4360
  user_info?: UserInfo;
4310
4361
  ordering_store_id?: number;