@gofynd/fdk-client-javascript 3.0.0-beta.1 → 3.1.0-beta.1

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 (83) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/Cart/CartApplicationClient.d.ts +14 -14
  4. package/sdk/application/Cart/CartApplicationClient.js +14 -14
  5. package/sdk/application/Content/ContentApplicationClient.d.ts +10 -0
  6. package/sdk/application/Content/ContentApplicationClient.js +53 -0
  7. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -6
  8. package/sdk/application/FileStorage/FileStorageApplicationClient.js +3 -3
  9. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +34 -0
  10. package/sdk/application/Logistic/LogisticApplicationClient.js +136 -0
  11. package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +12 -12
  12. package/sdk/partner/FileStorage/FileStoragePartnerClient.js +12 -12
  13. package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +46 -33
  14. package/sdk/partner/FileStorage/FileStoragePartnerModel.js +41 -25
  15. package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +4 -4
  16. package/sdk/platform/Billing/BillingPlatformClient.d.ts +6 -397
  17. package/sdk/platform/Billing/BillingPlatformClient.js +77 -3215
  18. package/sdk/platform/Billing/BillingPlatformModel.d.ts +417 -3811
  19. package/sdk/platform/Billing/BillingPlatformModel.js +292 -2544
  20. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +12 -451
  21. package/sdk/platform/Billing/BillingPlatformValidator.js +8 -483
  22. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +34 -34
  23. package/sdk/platform/Cart/CartPlatformApplicationClient.js +34 -34
  24. package/sdk/platform/Cart/CartPlatformModel.d.ts +363 -29
  25. package/sdk/platform/Cart/CartPlatformModel.js +203 -31
  26. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +57 -57
  27. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +220 -200
  28. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +121 -91
  29. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +58 -46
  30. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +10 -51
  31. package/sdk/platform/Catalog/CatalogPlatformClient.js +79 -400
  32. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +22 -228
  33. package/sdk/platform/Catalog/CatalogPlatformModel.js +12 -163
  34. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +15 -61
  35. package/sdk/platform/Catalog/CatalogPlatformValidator.js +13 -65
  36. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +4 -8
  37. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +10 -14
  38. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +94 -30
  39. package/sdk/platform/Communication/CommunicationPlatformModel.js +110 -32
  40. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +33 -1
  41. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +62 -0
  42. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +11 -0
  43. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +5 -0
  44. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +12 -2
  45. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +5 -1
  46. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +6 -4
  47. package/sdk/platform/Content/ContentPlatformApplicationClient.js +12 -10
  48. package/sdk/platform/Content/ContentPlatformModel.d.ts +42 -12
  49. package/sdk/platform/Content/ContentPlatformModel.js +43 -13
  50. package/sdk/platform/Finance/FinancePlatformClient.d.ts +28 -28
  51. package/sdk/platform/Finance/FinancePlatformClient.js +28 -28
  52. package/sdk/platform/Order/OrderPlatformClient.d.ts +21 -21
  53. package/sdk/platform/Order/OrderPlatformClient.js +21 -21
  54. package/sdk/platform/Order/OrderPlatformModel.d.ts +1010 -80
  55. package/sdk/platform/Order/OrderPlatformModel.js +665 -70
  56. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +31 -4
  57. package/sdk/platform/Payment/PaymentPlatformModel.js +11 -4
  58. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +1 -1
  59. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +8 -0
  60. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +14 -0
  61. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +6 -0
  62. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +24 -0
  63. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +119 -0
  64. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +194 -23
  65. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +116 -22
  66. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +23 -1
  67. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +16 -0
  68. package/sdk/platform/Share/SharePlatformModel.d.ts +5 -0
  69. package/sdk/platform/Share/SharePlatformModel.js +2 -0
  70. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +10 -12
  71. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +45 -49
  72. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +10 -10
  73. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +12 -12
  74. package/sdk/public/PublicClient.d.ts +0 -2
  75. package/sdk/public/PublicClient.js +0 -4
  76. package/sdk/public/index.d.ts +0 -1
  77. package/sdk/public/index.js +0 -2
  78. package/sdk/public/Billing/BillingPublicClient.d.ts +0 -56
  79. package/sdk/public/Billing/BillingPublicClient.js +0 -397
  80. package/sdk/public/Billing/BillingPublicModel.d.ts +0 -919
  81. package/sdk/public/Billing/BillingPublicModel.js +0 -560
  82. package/sdk/public/Billing/BillingPublicValidator.d.ts +0 -43
  83. package/sdk/public/Billing/BillingPublicValidator.js +0 -50
@@ -19,10 +19,11 @@ export = OrderPlatformModel;
19
19
  */
20
20
  /**
21
21
  * @typedef ErrorResponse
22
- * @property {number} [status]
23
- * @property {boolean} [success]
24
- * @property {string} message
25
- * @property {string} [error_trace]
22
+ * @property {number} [status] - The HTTP status code corresponding to the error.
23
+ * @property {boolean} [success] - Indicates whether the operation was
24
+ * successful. Always false in the case of an error.
25
+ * @property {string} message - A message describing the error that occurred.
26
+ * @property {string} [error_trace] - Error trace of the error that occurred.
26
27
  * @property {string} [error]
27
28
  */
28
29
  /**
@@ -296,9 +297,9 @@ export = OrderPlatformModel;
296
297
  * product’s identifier, such as a SKU, barcode, or another distinct code.
297
298
  * This ensures the product is correctly identified and distinguished from
298
299
  * other items in the system.
299
- * @property {number} [quantity] - The quantity of the product or item,
300
- * specified as an integer. This indicates how many units of the product are
301
- * being referenced or processed, such as the number of items in a bag or shipment.
300
+ * @property {number} [quantity] - The quantity of the product or item. This
301
+ * indicates how many units of the product are being referenced or processed,
302
+ * such as the number of items in a bag or shipment.
302
303
  */
303
304
  /**
304
305
  * @typedef ProductsDataUpdates
@@ -581,6 +582,33 @@ export = OrderPlatformModel;
581
582
  * @property {string} [store_lookup]
582
583
  * @property {AffiliateStoreIdMapping[]} affiliate_store_id_mapping
583
584
  */
585
+ /**
586
+ * @typedef DPConfiguration
587
+ * @property {string} [shipping_by] - Shipping_by denotes dp assignment
588
+ * strategy- if shipping_by is fynd dp assignment would be handled by OMS
589
+ */
590
+ /**
591
+ * @typedef PaymentConfig
592
+ * @property {string} [mode_of_payment] - Specifies the mode through which the
593
+ * payment was collected, serving as an identifier for the payment's origin.
594
+ * @property {string} [source] - The source field identifies the channel through
595
+ * which the order was placed, such as MARKETPLACE, ECOMM.
596
+ */
597
+ /**
598
+ * @typedef CreateOrderConfig
599
+ * @property {DPConfiguration} [dp_configuration]
600
+ * @property {string} [integration_type] - Flag denotes integration type which
601
+ * is used to retrieve specific configurations and application details
602
+ * relevant to channel fulfillment.
603
+ * @property {boolean} [location_reassignment] - Flag denotes if the location
604
+ * for the store needs to be reassigned post cancellation.
605
+ * @property {PaymentConfig} [payment]
606
+ * @property {boolean} [optimal_shipment_creation] - Denotes the shipment
607
+ * breaking strategy. If the flag is set true, the shipment is created using
608
+ * optimal shipment creation strategy based on the servicability & packaging
609
+ * dimensions by OMS .If false, shipment details, including location_id, must
610
+ * be passed to FDK for processing.
611
+ */
584
612
  /**
585
613
  * @typedef CreateOrderPayload
586
614
  * @property {string} affiliate_id
@@ -797,6 +825,14 @@ export = OrderPlatformModel;
797
825
  * @property {OrderDetails} order_details
798
826
  * @property {string[]} [errors]
799
827
  * @property {ShipmentDetail[]} [shipment_details]
828
+ * @property {string} [text] - A label or description of the delivery status,
829
+ * such as 'Expected Delivery Date'.
830
+ * @property {string} [value] - The detailed delivery status or time
831
+ * information, such as 'Arriving on 24 Nov 2022 15:54:00'.
832
+ * @property {string} [color_code] - Hex code for the color representing the
833
+ * delivery status.
834
+ * @property {string} [expected_delivery_date] - The ISO 8601 formatted date and
835
+ * time when the delivery is expected, e.g., '2022-11-24T22:15:54+00:00'.
800
836
  */
801
837
  /**
802
838
  * @typedef OrderStatusResult
@@ -849,15 +885,70 @@ export = OrderPlatformModel;
849
885
  * internal tracking.
850
886
  * @property {string} type - The category or type of the charge.
851
887
  */
888
+ /**
889
+ * @typedef CurrencyValueSchema
890
+ * @property {number} value - The numerical value of the charge.
891
+ * @property {string} currency - The currency code (e.g., USD, INR).
892
+ */
893
+ /**
894
+ * @typedef AmountSchema
895
+ * @property {CurrencyValueSchema} ordering_currency
896
+ * @property {CurrencyValueSchema} base_currency
897
+ */
898
+ /**
899
+ * @typedef DynamicChargeTaxSchema
900
+ * @property {string} reporting_hsn_code - HSN (Harmonized System of
901
+ * Nomenclature) code for reporting purposes.
902
+ */
903
+ /**
904
+ * @typedef RuleConditionsSchema
905
+ * @property {string} article_tag - The tag for the article.
906
+ * @property {string[]} department - List of applicable departments.
907
+ */
908
+ /**
909
+ * @typedef RuleSchema
910
+ * @property {RuleConditionsSchema} conditions
911
+ */
912
+ /**
913
+ * @typedef DistributionSchema
914
+ * @property {string} type - Type of distribution (single or multi).
915
+ * @property {string} logic - Logic for distribution (apportion, equally).
916
+ * @property {RuleSchema} [rule]
917
+ */
918
+ /**
919
+ * @typedef DistributionLogicSchema
920
+ * @property {string} distribution_level - The level at which the charge is
921
+ * distributed (order, article, shipment).
922
+ * @property {DistributionSchema} distribution
923
+ */
924
+ /**
925
+ * @typedef DynamicChargeSchema
926
+ * @property {string} name - The name of the charge.
927
+ * @property {string} type - The category or type of the charge.
928
+ * @property {string} [code] - An optional code associated with the charge for
929
+ * internal tracking.
930
+ * @property {AmountSchema} amount
931
+ * @property {DynamicChargeTaxSchema} [taxes]
932
+ * @property {Object} [meta] - Meta data of the custom charge.
933
+ * @property {DistributionLogicSchema} [distribution_logic]
934
+ */
852
935
  /**
853
936
  * @typedef LineItem
854
- * @property {Charge[]} charges
937
+ * @property {Charge[]} charges - These are the mandatory charges required
938
+ * during order creation and are integral to the order processing flow. They
939
+ * include fields like amount_paid, discount, and price_marked. The schema for
940
+ * these charges is predefined and remains consistent, ensuring seamless
941
+ * forward mapping in the code.
855
942
  * @property {Object} [meta] - Meta data of the articles or line items.
856
943
  * @property {string} [custom_message] - Meta data of the articles or line items.
857
944
  * @property {number} [quantity] - Quantity of the articles or line items.
858
945
  * @property {string} seller_identifier - Seller identifier of the articles or line items.
859
946
  * @property {string} [external_line_id] - External unique identifier of the
860
947
  * articles or line items.
948
+ * @property {DynamicChargeSchema[]} [dynamic_charges] - (Optional) These are
949
+ * additional charges specified by the client based on specific use cases.
950
+ * They allow for flexibility in adding new fields such as installation_fee,
951
+ * service_charge, or other dynamic costs.
861
952
  */
862
953
  /**
863
954
  * @typedef ProcessingDates
@@ -877,8 +968,12 @@ export = OrderPlatformModel;
877
968
  * @property {ProcessingDates} [processing_dates]
878
969
  * @property {Object} [meta] - Meta data of the shipment.
879
970
  * @property {number} [priority] - Integer value indicating high and low priority.
880
- * @property {number} location_id - Location Identifier or Store/Fulfillment
881
- * Identifier of the shipment.
971
+ * @property {number} [location_id] - Location Identifier or Store/Fulfillment
972
+ * Identifier of the shipment- This field is mandatory when
973
+ * optimal_shipment_creation flag is set to false, indicating that shipments
974
+ * must be associated with a specific location. When
975
+ * `optimal_shipment_creation` is true, the optimal location for order
976
+ * creation would be assigned, location_id becomes optional.
882
977
  * @property {string} [order_type] - The order type of shipment HomeDelivery -
883
978
  * If the customer wants the order home-delivered PickAtStore - If the
884
979
  * customer wants the handover of an order at the store itself.
@@ -910,16 +1005,6 @@ export = OrderPlatformModel;
910
1005
  * @property {Prices} [price]
911
1006
  * @property {ShipmentGstDetails} [gst]
912
1007
  */
913
- /**
914
- * @typedef ShipmentRequestData
915
- * @property {LineItem[]} line_items
916
- * @property {ProcessingDates} [processing_dates]
917
- * @property {Object} [meta] - Meta data of the shipment.
918
- * @property {number} [priority] - Integer value indicating high and low priority.
919
- * @property {string} [order_type] - The order type of shipment HomeDelivery -
920
- * If the customer wants the order home-delivered PickAtStore - If the
921
- * customer wants the handover of an order at the store itself.
922
- */
923
1008
  /**
924
1009
  * @typedef ShippingInfo
925
1010
  * @property {string} [alternate_mobile_number]
@@ -1050,35 +1135,32 @@ export = OrderPlatformModel;
1050
1135
  * @property {string} id
1051
1136
  * @property {string} [logo]
1052
1137
  */
1053
- /**
1054
- * @typedef Config
1055
- * @property {string[]} [lock_states]
1056
- * @property {ConfigPayment} payment
1057
- * @property {ConfigDpConfiguration} [dp_configuration]
1058
- * @property {boolean} [location_reassignment]
1059
- * @property {ConfigApplication} [application]
1060
- * @property {string} [ordering_channel_logo]
1061
- * @property {string} [integration_type]
1062
- */
1063
1138
  /**
1064
1139
  * @typedef CreateOrderAPI
1065
1140
  * @property {Shipment[]} shipments
1066
- * @property {ShipmentRequestData} [shipment_request_data]
1067
1141
  * @property {Object} shipping_info
1068
1142
  * @property {Object} billing_info
1069
1143
  * @property {CurrencyInfo} [currency_info]
1070
1144
  * @property {string} [external_order_id]
1071
1145
  * @property {string} [external_shipment_id]
1072
1146
  * @property {string} [order_type]
1073
- * @property {Charge[]} [charges]
1147
+ * @property {Charge[]} [charges] - These are the mandatory charges required
1148
+ * during order creation and are integral to the order processing flow. They
1149
+ * include fields like amount_paid, discount, and price_marked, etc.. The
1150
+ * schema for these charges is predefined and remains consistent, ensuring
1151
+ * seamless forward mapping in the code.
1074
1152
  * @property {string} [external_creation_date]
1075
1153
  * @property {Object} [meta]
1076
1154
  * @property {TaxInfo} [tax_info]
1077
- * @property {Config} [config]
1155
+ * @property {CreateOrderConfig} [config]
1078
1156
  * @property {PaymentInfo} payment_info
1079
1157
  * @property {UserInfo} [user_info]
1080
1158
  * @property {boolean} [unlock_before_transition]
1081
1159
  * @property {boolean} [lock_after_transition]
1160
+ * @property {DynamicChargeSchema[]} [dynamic_charges] - (Optional) These are
1161
+ * additional charges specified by the client based on specific use cases.
1162
+ * They allow for flexibility in adding new fields such as installation_fee,
1163
+ * service_charge, or other dynamic costs.
1082
1164
  */
1083
1165
  /**
1084
1166
  * @typedef CreateOrderErrorReponse
@@ -1499,18 +1581,18 @@ export = OrderPlatformModel;
1499
1581
  * @typedef DateRange
1500
1582
  * @property {string} [from_date]
1501
1583
  * @property {string} [to_date]
1584
+ * @property {string} [end_date]
1585
+ * @property {string} [start_date]
1502
1586
  */
1503
1587
  /**
1504
1588
  * @typedef Filters
1505
1589
  * @property {DateRange} [date_range]
1506
- * @property {string} [logo]
1507
- * @property {string} [from_date]
1508
1590
  * @property {number} [stores]
1509
- * @property {string} [to_date]
1510
1591
  * @property {string} [dp_name]
1511
- * @property {number} [dp_ids]
1592
+ * @property {string} [dp_ids]
1512
1593
  * @property {string} [lane]
1513
1594
  * @property {string} [selected_shipments]
1595
+ * @property {string} [deselected_shipments]
1514
1596
  * @property {string} [store_name]
1515
1597
  * @property {string} [type]
1516
1598
  */
@@ -1976,6 +2058,239 @@ export = OrderPlatformModel;
1976
2058
  * @property {boolean} [has_next]
1977
2059
  * @property {number} [page_size]
1978
2060
  */
2061
+ /**
2062
+ * @typedef ConfigData
2063
+ * @property {boolean} [acknowledged] - Indicates whether the update operation
2064
+ * was acknowledged by the database.
2065
+ * @property {boolean} [is_upserted] - Indicates whether the update operation
2066
+ * resulted in an upsert (an update or insert).
2067
+ * @property {boolean} [is_inserted] - Indicates whether the update operation
2068
+ * resulted in a new document being inserted.
2069
+ */
2070
+ /**
2071
+ * @typedef ConfigUpdatedResponse
2072
+ * @property {ConfigData[]} data - The result of the config update operation,
2073
+ * including whether it was acknowledged, upserted, or inserted.
2074
+ * @property {boolean} success - Indicates whether the config update operation
2075
+ * was successful.
2076
+ */
2077
+ /**
2078
+ * @typedef FlagData
2079
+ * @property {Object} [value]
2080
+ * @property {Object} [filter]
2081
+ */
2082
+ /**
2083
+ * @typedef Flags
2084
+ * @property {FlagData[]} [allow_partial_transition] - Indicates whether a
2085
+ * partial transition of bags to the next state is permissible, allowing some
2086
+ * bags to progress while others remain in the current state.
2087
+ * @property {FlagData[]} [can_break_entity] - Specifies whether bags within a
2088
+ * shipment, set,cdf or entity can be broken individually or as a group. If
2089
+ * set to false, all bags within the entity must remain together and
2090
+ * transition together to the same state.
2091
+ * @property {FlagData[]} [allowed_bag_updates] - Specifies which fields are
2092
+ * permitted to be updated at the bag level. Allowed fields are:
2093
+ *
2094
+ * - Meta
2095
+ * - Pdf_links
2096
+ * - Affiliate_meta
2097
+ * - Delivery_awb_number
2098
+ * - Store_invoice_id
2099
+ * - Store_id
2100
+ * - Return_store_id
2101
+ * - Eway_bill_id
2102
+ *
2103
+ * @property {FlagData[]} [allowed_bag_status_updates] - Specifies which fields
2104
+ * are permitted to be updated at the bag status level. Allowed fields are:
2105
+ *
2106
+ * - Json
2107
+ *
2108
+ * @property {FlagData[]} [allowed_entity_updates] - Specifies which fields are
2109
+ * permitted to be updated at shipment level. Allowed fields are:
2110
+ *
2111
+ * - Meta
2112
+ * - Pdf_links
2113
+ * - Affiliate_meta
2114
+ * - Delivery_awb_number
2115
+ * - Store_invoice_id
2116
+ * - Store_id
2117
+ * - Return_store_id
2118
+ * - Eway_bill_id
2119
+ * - Logistics_meta
2120
+ *
2121
+ * @property {FlagData[]} [allowed_entity_status_updates] - Specifies which
2122
+ * fields are permitted to be updated at the Entity status level. Allowed fields are:
2123
+ *
2124
+ * - Json
2125
+ *
2126
+ * @property {FlagData[]} [status_update_type] - Describes the type of journey
2127
+ * associated with the particular status of the shipment. Possible values are:
2128
+ *
2129
+ * - Positive
2130
+ * - Negative
2131
+ *
2132
+ * @property {FlagData[]} [is_bag_status_reason_allowed] - Indicates whether a
2133
+ * reason at the product level should be allowed for a particular status.
2134
+ * @property {FlagData[]} [is_entity_status_reason_allowed] - Indicates whether
2135
+ * a reason at the shipment level should be allowed for a particular status.
2136
+ * @property {FlagData[]} [transition_strategy] - This flag is used to define
2137
+ * the shipment breaking strategy. Possible values are:
2138
+ *
2139
+ * - Break_shipment_based_on_location_reassignment
2140
+ * - Break_shipment_based_on_groups
2141
+ * - Break_shipment_based_on_stormbreaker
2142
+ */
2143
+ /**
2144
+ * @typedef Filter
2145
+ * @property {string} [order_type] - Indicates the type or category of the order.
2146
+ *
2147
+ * - PickAtStore: Pick from store
2148
+ * - HomeDelivery: Home delivery
2149
+ * - Digital: Digital
2150
+ *
2151
+ * @property {boolean} [is_partial_transition] - Specifies whether a partial
2152
+ * transition of the order is allowed, allowing some components to progress
2153
+ * while others remain in the current state.
2154
+ * @property {boolean} [auto_trigger_dp_assignment_acf] - Indicates whether the
2155
+ * assignment of a designated person is automatically triggered in the context of ACF.
2156
+ * @property {string} [lock_status] - Indicates the current locking status of
2157
+ * the shipment.
2158
+ *
2159
+ * - `complete`: Complete shipment lock
2160
+ * - `operational`: Operational shipment lock
2161
+ * - `None`: No lock on shipment
2162
+ *
2163
+ * @property {boolean} [lock_after_transition] - Specifies whether locking is
2164
+ * required after transitioning to the next status. lock_after_transition :
2165
+ * true - Lock Transition enabled lock_after_transition : false - Lock
2166
+ * Transition set false
2167
+ * @property {boolean} [resume_tasks_after_unlock] - Indicates whether tasks
2168
+ * should resume automatically after unlocking, such as DP assignment task and
2169
+ * invoicing task.
2170
+ * @property {boolean} [is_invoice_id_present] - Indicates whether an invoice ID
2171
+ * is present for the order.
2172
+ * @property {boolean} [is_credit_note_generated] - Indicates whether a credit
2173
+ * note has been generated for the order.
2174
+ * @property {boolean} [fulfill_virtual_invoice] - Specifies whether an
2175
+ * automated virtual invoice ID is associated with the order.
2176
+ * @property {string} [next_status] - Indicates the next status to which the
2177
+ * order will transition.
2178
+ * @property {boolean} [is_hook_enabled] - Indicates whether a task is enabled
2179
+ * for the order.
2180
+ * @property {boolean} [pos_credit_note_check] - Specifies whether a credit note
2181
+ * check is performed in a point of sale (POS) scenario.
2182
+ * @property {string} [order_platform] - Specifies the platform on which the
2183
+ * order was placed.
2184
+ *
2185
+ * - `platform-pos`: POS
2186
+ * - `platform-site`: WEB
2187
+ * - `openapi`: OPENAPI
2188
+ * - `marketplace`: MARKETPLACE
2189
+ *
2190
+ * @property {string} [refund_type] - Indicates the type of refund associated
2191
+ * with the order.
2192
+ *
2193
+ * - `credit_note`: CREDIT_NOTE
2194
+ * - `source`: SOURCE
2195
+ * - `bank_transfer`: BANK
2196
+ * - `manual_refund`: MANUAL_REFUND
2197
+ *
2198
+ * @property {boolean} [is_non_pos_platform] - Specifies whether the platform is
2199
+ * non-point of sale (POS) in nature.
2200
+ * @property {boolean} [is_self_ship] - Indicates whether the order is
2201
+ * self-shipped by the seller.
2202
+ * @property {string} [seller_country_code] - Specifies the country code of the seller.
2203
+ *
2204
+ * - `seller_country_code`: US
2205
+ * - `seller_country_code`: UK
2206
+ * - `seller_country_code`: IN
2207
+ *
2208
+ * @property {string} [customer_country_code] - Specifies the country code of the seller.
2209
+ *
2210
+ * - `customer_country_code`: US
2211
+ * - `customer_country_code`: UK
2212
+ * - `customer_country_code`: IN
2213
+ *
2214
+ * @property {boolean} [is_test_order] - Indicates whether the order is a test
2215
+ * order used for testing purposes - `is_test_order` : True - indicates test order
2216
+ * @property {string[]} [task_trigger_condition] - Specifies trigger conditions:
2217
+ *
2218
+ * - `status_update`: Status Update
2219
+ * - `data_update`: Data Update
2220
+ */
2221
+ /**
2222
+ * @typedef PostHook
2223
+ * @property {string} task - Name of the hook that has to be added
2224
+ * @property {Object} [kwargs] - Additional parameters for the hook
2225
+ * @property {Filter} [filters] - Filters for scope selection.
2226
+ */
2227
+ /**
2228
+ * @typedef PreHook
2229
+ * @property {string} task - Name of the hook that has to be added
2230
+ * @property {Object} [kwargs] - Additional parameters for the hook
2231
+ * @property {Filter} [filters] - Filter
2232
+ */
2233
+ /**
2234
+ * @typedef Config
2235
+ * @property {string} [from_state] - Source state from which state transition
2236
+ * will take place
2237
+ * @property {string} [to_state] - Target state to which state transition will take place
2238
+ * @property {PreHook[]} [pre_hooks] - Tasks to be run before state transition
2239
+ * @property {PostHook[]} [post_hooks] - Tasks to be run after state transition
2240
+ * @property {Flags} [flags] - Various flags related to the transition. These
2241
+ * include options and settings that influence the behavior of the state
2242
+ * transition, such as whether partial transitions are allowed or whether the
2243
+ * transition can break the entity.
2244
+ */
2245
+ /**
2246
+ * @typedef TransitionConfigCondition
2247
+ * @property {string} app_id - The unique identifier of the application to which
2248
+ * the configuration applies.
2249
+ * @property {string} ordering_channel - The channel through which the order was
2250
+ * placed, such as ECOMM or another specified channel.
2251
+ * @property {string} entity - The type of entity that the configuration pertains to.
2252
+ */
2253
+ /**
2254
+ * @typedef TransitionConfigData
2255
+ * @property {TransitionConfigCondition} [conditions] - Conditions that must be
2256
+ * met for the ESM config to be applied.
2257
+ * @property {Config[]} [configs] - The configuration settings for the entity
2258
+ * transition. This includes pre_hooks, post_hooks, and flags for each
2259
+ * transition state.
2260
+ */
2261
+ /**
2262
+ * @typedef TransitionConfigPayload
2263
+ * @property {TransitionConfigData} [data]
2264
+ */
2265
+ /**
2266
+ * @typedef ProcessManifestRequest
2267
+ * @property {string} [action] - Expected Actions: [save, process,
2268
+ * pdf_generated,invalidate,pdf_failed,complete]
2269
+ * @property {Filters} [filters]
2270
+ * @property {string} [unique_id] - Unique Id.
2271
+ */
2272
+ /**
2273
+ * @typedef ManifestResponse
2274
+ * @property {ManifestItems} [items]
2275
+ */
2276
+ /**
2277
+ * @typedef ManifestItems
2278
+ * @property {Filters} [filters]
2279
+ * @property {string} [manifest_id] - Id of the manifest.
2280
+ * @property {string} [unique_id] - Unique Id.
2281
+ * @property {number} [company_id] - Id of the company.
2282
+ * @property {string} [dp_id] - Shipment with the specific courier partner Id.
2283
+ * @property {string} [courier_partner_slug] - Courier partner slug
2284
+ * @property {string} [action] - Expected Actions: [Save, Process, Pdf
2285
+ * Generated, Invalidate, Pdf Failed, Complete]
2286
+ * @property {string} [created_by] - Created date of the manifest.
2287
+ * @property {string} [user_id] - Id of user.
2288
+ */
2289
+ /**
2290
+ * @typedef ManifestErrorResponse
2291
+ * @property {boolean} [success] - Success State.
2292
+ * @property {string} [error] - Error String.
2293
+ */
1979
2294
  /**
1980
2295
  * @typedef Page
1981
2296
  * @property {number} [item_total] - The total number of items on the page.
@@ -2632,6 +2947,7 @@ export = OrderPlatformModel;
2632
2947
  * @property {string} [contact_person] - Name of the contact person
2633
2948
  * @property {string} [state] - State where the store is located.
2634
2949
  * @property {string} [city] - City where the store is located.
2950
+ * @property {string} [store_email] - Email address of store
2635
2951
  */
2636
2952
  /**
2637
2953
  * @typedef DPDetailsData
@@ -2957,6 +3273,7 @@ export = OrderPlatformModel;
2957
3273
  * @property {string} contact_person
2958
3274
  * @property {string} state
2959
3275
  * @property {string} city
3276
+ * @property {string} [store_email] - Email of the recipient associated with the store
2960
3277
  */
2961
3278
  /**
2962
3279
  * @typedef ShipmentPayments
@@ -2998,6 +3315,7 @@ export = OrderPlatformModel;
2998
3315
  * transaction, this is essential for referencing individual payments.
2999
3316
  * @property {string} [display_name] - The name of the payment method as it
3000
3317
  * should be displayed to the user.
3318
+ * @property {Object} [transaction_data] - All necessary data for transaction received
3001
3319
  */
3002
3320
  /**
3003
3321
  * @typedef PlatformShipment
@@ -3009,6 +3327,7 @@ export = OrderPlatformModel;
3009
3327
  * @property {string} [shipment_status] - Status of the shipment indicating its
3010
3328
  * current stage
3011
3329
  * @property {GSTDetailsData} [gst_details]
3330
+ * @property {OrderStatusData} [order_status]
3012
3331
  * @property {Object} [delivery_slot] - Delivery slot details
3013
3332
  * @property {OrderDetailsData} [order]
3014
3333
  * @property {UserDataInfo} [user]
@@ -3693,7 +4012,7 @@ export = OrderPlatformModel;
3693
4012
  declare class OrderPlatformModel {
3694
4013
  }
3695
4014
  declare namespace OrderPlatformModel {
3696
- export { InvalidateShipmentCachePayload, InvalidateShipmentCacheNestedResponse, InvalidateShipmentCacheResponse, ErrorResponse, LogErrorResponse, QuestionErrorResponse, RefundStateConfigurationByPaymentType, PostRefundStateConfiguration, PostRefundStateConfigurationResponse, GetRefundStateConfigurationResponse, RefundStates, GetRefundStates, RefundStateManualWithoutMessage, RefundStateManualWithMessage, RefundStateManualWithMessageData, RefundStateConfigurationManualSchema, RefundStateConfigurationManualSchemaResponse, RefundSubOption, RefundBreakup, RefundOptionShipmentResponse, CurrencySchema, RefundOptionsSchemaResponse, StoreReassign, StoreReassignResponse, Entities, UpdateShipmentLockPayload, OriginalFilter, Bags, CheckResponse, UpdateShipmentLockResponse, AnnouncementResponse, AnnouncementsResponse, Click2CallResponse, ErrorDetail, ProductsReasonsFilters, ProductsReasonsData, ProductsReasons, EntityReasonData, EntitiesReasons, ReasonsData, Products, OrderItemDataUpdates, ProductsDataUpdatesFilters, ProductsDataUpdates, EntitiesDataUpdates, RepricedProductsDataUpdates, DataUpdates, TransitionComments, ShipmentsRequest, StatuesRequest, ActionRequest, UpdateShipmentStatusRequest, UpdateShipmentActionRequest, 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, RefundInformation, HistoryReason, HistoryMeta, HistoryDict, ShipmentHistoryResponse, PostHistoryFilters, PostHistoryData, PostHistoryDict, PostShipmentHistory, SmsDataPayload, SendSmsPayload, OrderDetails, Meta, ShipmentDetail, OrderStatusData, OrderStatusResult, SendSmsResponse, Dimension, UpdatePackagingDimensionsPayload, UpdatePackagingDimensionsResponse, Tax, Amount, Charge, LineItem, ProcessingDates, Shipment, ShipmentRequestData, ShippingInfo, BillingInfo, UserInfo, TaxInfo, PaymentMethod, PaymentInfo, CurrencyInfoCurrency, CurrencyInfoConversionRate, CurrencyInfo, ConfigPayment, ConfigDpConfiguration, ConfigApplication, Config, CreateOrderAPI, CreateOrderErrorReponse, DpConfiguration, PaymentMethods, CreateChannelPaymentInfo, CreateChannelConfig, CreateChannelConfigData, CreateChannelConifgErrorResponse, CreateChannelConfigResponse, UploadConsent, PlatformOrderUpdate, ResponseDetail, OrderData, OrderUpdatePayload, OrderUpdateResponseDetail, FyndOrderIdList, OrderStatus, BagStateTransitionMap, RoleBaseStateTransitionMapping, FetchCreditBalanceRequestPayload, CreditBalanceInfo, FetchCreditBalanceResponsePayload, RefundModeConfigRequestPayload, RefundOption, RefundModeInfoFormat, RefundModeInfo, RefundModeConfigResponsePayload, AttachUserOtpData, AttachUserInfo, AttachOrderUser, AttachOrderUserResponse, AttachOrderUserErrorResponse, SendUserMobileOTP, PointBlankOtpData, SendUserMobileOtpResponse, VerifyOtpData, VerifyMobileOTP, VerifyOtpResponseData, VerifyOtpResponse, VerifyOtpErrorResponseData, VerifyOtpErrorResponse, 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, OptionItem, SuperLaneItem, RuleLaneConfigResponse, RuleLaneConfigResponseSchema, RuleLaneConfigErrorResponse, QuestionSetItem, Reason, RuleRequest, RuleResponse, RuleUpdateRequest, Condition, RuleMeta, RuleAction, Department, L3, Error, RuleSuccessResponse, UpdateRulePositionRequest, RuleListResponse, RuleItem, RuleParametersResponse, ParameterResponse, RuleListRequest, ErrorGenericWithStatus, RuleListItem, RuleError, RuleErrorResponse, PageInfo, Page, BagReasonMeta, QuestionSet, BagReasons, ShipmentBagReasons, ShipmentStatus, UserDataInfo, Address, ShipmentListingChannel, Prices, ChargeDistributionSchema, ChargeDistributionLogic, ChargeAmountCurrency, ChargeAmount, PriceAdjustmentCharge, Identifier, FinancialBreakup, GSTDetailsData, BagStateMapper, BagStatusHistory, Dimensions, ReturnConfig, Weight, Article, ShipmentListingBrand, ReplacementDetails, AffiliateMeta, AffiliateBagDetails, PlatformArticleAttributes, PlatformItem, Dates, BagReturnableCancelableStatus, BagUnit, ShipmentItemFulFillingStore, Currency, OrderingCurrency, ConversionRate, 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, PriceMinMax, ItemPriceDetails, FreeGiftItems, AppliedFreeArticles, AppliedPromos, CurrentStatus, OrderBags, FulfillingStore, ShipmentPayments, ShipmentStatusData, ShipmentLockDetails, ShipmentPaymentInfoData, PlatformShipment, ShipmentInfoResponse, TaxDetails, PaymentInfoData, OrderDetailsResponse, SubLane, SuperLane, LaneConfigResponse, PlatformBreakupValues, PlatformChannel, PlatformOrderItems, OrderListingResponse, PlatformTrack, PlatformShipmentTrack, AdvanceFilterInfo, FilterOptions, FiltersList, GlobalFiltersResponse, ViewDetails, ParentViews, UserViewsResponse, UserViewPosition, CreateUpdateDeleteResponse, FiltersResponse, URL, FileResponse, BulkActionTemplate, BulkActionTemplateResponse, PlatformShipmentReasonsResponse, ShipmentResponseReasons, ShipmentReasonsResponse, StoreAddress, EInvoicePortalDetails, StoreEinvoice, StoreEwaybill, StoreGstCredentials, Document, StoreDocuments, StoreMeta, Store, Brand, Attributes, Item, ArticleStatusDetails, Company, ShipmentGstDetails, DeliverySlotDetails, InvoiceDetails, UserDetails, WeightData, BagDetails, BagDetailsPlatformResponse, BagsPage, BagData, GetBagsPlatformResponse, GeneratePosOrderReceiptResponse, Templates, AllowedTemplatesResponse, CDN, Upload, TemplateDownloadResponse };
4015
+ export { InvalidateShipmentCachePayload, InvalidateShipmentCacheNestedResponse, InvalidateShipmentCacheResponse, ErrorResponse, LogErrorResponse, QuestionErrorResponse, RefundStateConfigurationByPaymentType, PostRefundStateConfiguration, PostRefundStateConfigurationResponse, GetRefundStateConfigurationResponse, RefundStates, GetRefundStates, RefundStateManualWithoutMessage, RefundStateManualWithMessage, RefundStateManualWithMessageData, RefundStateConfigurationManualSchema, RefundStateConfigurationManualSchemaResponse, RefundSubOption, RefundBreakup, RefundOptionShipmentResponse, CurrencySchema, RefundOptionsSchemaResponse, StoreReassign, StoreReassignResponse, Entities, UpdateShipmentLockPayload, OriginalFilter, Bags, CheckResponse, UpdateShipmentLockResponse, AnnouncementResponse, AnnouncementsResponse, Click2CallResponse, ErrorDetail, ProductsReasonsFilters, ProductsReasonsData, ProductsReasons, EntityReasonData, EntitiesReasons, ReasonsData, Products, OrderItemDataUpdates, ProductsDataUpdatesFilters, ProductsDataUpdates, EntitiesDataUpdates, RepricedProductsDataUpdates, DataUpdates, TransitionComments, ShipmentsRequest, StatuesRequest, ActionRequest, UpdateShipmentStatusRequest, UpdateShipmentActionRequest, 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, RefundInformation, HistoryReason, HistoryMeta, HistoryDict, ShipmentHistoryResponse, PostHistoryFilters, PostHistoryData, PostHistoryDict, PostShipmentHistory, SmsDataPayload, SendSmsPayload, OrderDetails, Meta, ShipmentDetail, OrderStatusData, OrderStatusResult, SendSmsResponse, Dimension, UpdatePackagingDimensionsPayload, UpdatePackagingDimensionsResponse, Tax, Amount, Charge, CurrencyValueSchema, AmountSchema, DynamicChargeTaxSchema, RuleConditionsSchema, RuleSchema, DistributionSchema, DistributionLogicSchema, DynamicChargeSchema, LineItem, ProcessingDates, Shipment, ShippingInfo, BillingInfo, UserInfo, TaxInfo, PaymentMethod, PaymentInfo, CurrencyInfoCurrency, CurrencyInfoConversionRate, CurrencyInfo, ConfigPayment, ConfigDpConfiguration, ConfigApplication, CreateOrderAPI, CreateOrderErrorReponse, DpConfiguration, PaymentMethods, CreateChannelPaymentInfo, CreateChannelConfig, CreateChannelConfigData, CreateChannelConifgErrorResponse, CreateChannelConfigResponse, UploadConsent, PlatformOrderUpdate, ResponseDetail, OrderData, OrderUpdatePayload, OrderUpdateResponseDetail, FyndOrderIdList, OrderStatus, BagStateTransitionMap, RoleBaseStateTransitionMapping, FetchCreditBalanceRequestPayload, CreditBalanceInfo, FetchCreditBalanceResponsePayload, RefundModeConfigRequestPayload, RefundOption, RefundModeInfoFormat, RefundModeInfo, RefundModeConfigResponsePayload, AttachUserOtpData, AttachUserInfo, AttachOrderUser, AttachOrderUserResponse, AttachOrderUserErrorResponse, SendUserMobileOTP, PointBlankOtpData, SendUserMobileOtpResponse, VerifyOtpData, VerifyMobileOTP, VerifyOtpResponseData, VerifyOtpResponse, VerifyOtpErrorResponseData, VerifyOtpErrorResponse, 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, OptionItem, SuperLaneItem, RuleLaneConfigResponse, RuleLaneConfigResponseSchema, RuleLaneConfigErrorResponse, QuestionSetItem, Reason, RuleRequest, RuleResponse, RuleUpdateRequest, Condition, RuleMeta, RuleAction, Department, L3, Error, RuleSuccessResponse, UpdateRulePositionRequest, RuleListResponse, RuleItem, RuleParametersResponse, ParameterResponse, RuleListRequest, ErrorGenericWithStatus, RuleListItem, RuleError, RuleErrorResponse, PageInfo, ConfigData, ConfigUpdatedResponse, FlagData, Flags, Filter, PostHook, PreHook, Config, TransitionConfigCondition, TransitionConfigData, TransitionConfigPayload, ProcessManifestRequest, ManifestResponse, ManifestItems, ManifestErrorResponse, Page, BagReasonMeta, QuestionSet, BagReasons, ShipmentBagReasons, ShipmentStatus, UserDataInfo, Address, ShipmentListingChannel, Prices, ChargeDistributionSchema, ChargeDistributionLogic, ChargeAmountCurrency, ChargeAmount, PriceAdjustmentCharge, Identifier, FinancialBreakup, GSTDetailsData, BagStateMapper, BagStatusHistory, Dimensions, ReturnConfig, Weight, Article, ShipmentListingBrand, ReplacementDetails, AffiliateMeta, AffiliateBagDetails, PlatformArticleAttributes, PlatformItem, Dates, BagReturnableCancelableStatus, BagUnit, ShipmentItemFulFillingStore, Currency, OrderingCurrency, ConversionRate, 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, PriceMinMax, ItemPriceDetails, FreeGiftItems, AppliedFreeArticles, AppliedPromos, CurrentStatus, OrderBags, FulfillingStore, ShipmentPayments, ShipmentStatusData, ShipmentLockDetails, ShipmentPaymentInfoData, PlatformShipment, ShipmentInfoResponse, TaxDetails, PaymentInfoData, OrderDetailsResponse, SubLane, SuperLane, LaneConfigResponse, PlatformBreakupValues, PlatformChannel, PlatformOrderItems, OrderListingResponse, PlatformTrack, PlatformShipmentTrack, AdvanceFilterInfo, FilterOptions, FiltersList, GlobalFiltersResponse, ViewDetails, ParentViews, UserViewsResponse, UserViewPosition, CreateUpdateDeleteResponse, FiltersResponse, URL, FileResponse, BulkActionTemplate, BulkActionTemplateResponse, PlatformShipmentReasonsResponse, ShipmentResponseReasons, ShipmentReasonsResponse, StoreAddress, EInvoicePortalDetails, StoreEinvoice, StoreEwaybill, StoreGstCredentials, Document, StoreDocuments, StoreMeta, Store, Brand, Attributes, Item, ArticleStatusDetails, Company, ShipmentGstDetails, DeliverySlotDetails, InvoiceDetails, UserDetails, WeightData, BagDetails, BagDetailsPlatformResponse, BagsPage, BagData, GetBagsPlatformResponse, GeneratePosOrderReceiptResponse, Templates, AllowedTemplatesResponse, CDN, Upload, TemplateDownloadResponse };
3697
4016
  }
3698
4017
  /** @returns {InvalidateShipmentCachePayload} */
3699
4018
  declare function InvalidateShipmentCachePayload(): InvalidateShipmentCachePayload;
@@ -3728,9 +4047,22 @@ type InvalidateShipmentCacheResponse = {
3728
4047
  /** @returns {ErrorResponse} */
3729
4048
  declare function ErrorResponse(): ErrorResponse;
3730
4049
  type ErrorResponse = {
4050
+ /**
4051
+ * - The HTTP status code corresponding to the error.
4052
+ */
3731
4053
  status?: number;
4054
+ /**
4055
+ * - Indicates whether the operation was
4056
+ * successful. Always false in the case of an error.
4057
+ */
3732
4058
  success?: boolean;
4059
+ /**
4060
+ * - A message describing the error that occurred.
4061
+ */
3733
4062
  message: string;
4063
+ /**
4064
+ * - Error trace of the error that occurred.
4065
+ */
3734
4066
  error_trace?: string;
3735
4067
  error?: string;
3736
4068
  };
@@ -4216,9 +4548,9 @@ type ProductsDataUpdatesFilters = {
4216
4548
  */
4217
4549
  identifier?: string;
4218
4550
  /**
4219
- * - The quantity of the product or item,
4220
- * specified as an integer. This indicates how many units of the product are
4221
- * being referenced or processed, such as the number of items in a bag or shipment.
4551
+ * - The quantity of the product or item. This
4552
+ * indicates how many units of the product are being referenced or processed,
4553
+ * such as the number of items in a bag or shipment.
4222
4554
  */
4223
4555
  quantity?: number;
4224
4556
  };
@@ -4611,6 +4943,54 @@ type OrderConfig = {
4611
4943
  store_lookup?: string;
4612
4944
  affiliate_store_id_mapping: AffiliateStoreIdMapping[];
4613
4945
  };
4946
+ /** @returns {DPConfiguration} */
4947
+ declare function DPConfiguration(): DPConfiguration;
4948
+ type DPConfiguration = {
4949
+ /**
4950
+ * - Shipping_by denotes dp assignment
4951
+ * strategy- if shipping_by is fynd dp assignment would be handled by OMS
4952
+ */
4953
+ shipping_by?: string;
4954
+ };
4955
+ /** @returns {PaymentConfig} */
4956
+ declare function PaymentConfig(): PaymentConfig;
4957
+ type PaymentConfig = {
4958
+ /**
4959
+ * - Specifies the mode through which the
4960
+ * payment was collected, serving as an identifier for the payment's origin.
4961
+ */
4962
+ mode_of_payment?: string;
4963
+ /**
4964
+ * - The source field identifies the channel through
4965
+ * which the order was placed, such as MARKETPLACE, ECOMM.
4966
+ */
4967
+ source?: string;
4968
+ };
4969
+ /** @returns {CreateOrderConfig} */
4970
+ declare function CreateOrderConfig(): CreateOrderConfig;
4971
+ type CreateOrderConfig = {
4972
+ dp_configuration?: DPConfiguration;
4973
+ /**
4974
+ * - Flag denotes integration type which
4975
+ * is used to retrieve specific configurations and application details
4976
+ * relevant to channel fulfillment.
4977
+ */
4978
+ integration_type?: string;
4979
+ /**
4980
+ * - Flag denotes if the location
4981
+ * for the store needs to be reassigned post cancellation.
4982
+ */
4983
+ location_reassignment?: boolean;
4984
+ payment?: PaymentConfig;
4985
+ /**
4986
+ * - Denotes the shipment
4987
+ * breaking strategy. If the flag is set true, the shipment is created using
4988
+ * optimal shipment creation strategy based on the servicability & packaging
4989
+ * dimensions by OMS .If false, shipment details, including location_id, must
4990
+ * be passed to FDK for processing.
4991
+ */
4992
+ optimal_shipment_creation?: boolean;
4993
+ };
4614
4994
  /** @returns {CreateOrderPayload} */
4615
4995
  declare function CreateOrderPayload(): CreateOrderPayload;
4616
4996
  type CreateOrderPayload = {
@@ -4953,6 +5333,26 @@ type OrderStatusData = {
4953
5333
  order_details: OrderDetails;
4954
5334
  errors?: string[];
4955
5335
  shipment_details?: ShipmentDetail[];
5336
+ /**
5337
+ * - A label or description of the delivery status,
5338
+ * such as 'Expected Delivery Date'.
5339
+ */
5340
+ text?: string;
5341
+ /**
5342
+ * - The detailed delivery status or time
5343
+ * information, such as 'Arriving on 24 Nov 2022 15:54:00'.
5344
+ */
5345
+ value?: string;
5346
+ /**
5347
+ * - Hex code for the color representing the
5348
+ * delivery status.
5349
+ */
5350
+ color_code?: string;
5351
+ /**
5352
+ * - The ISO 8601 formatted date and
5353
+ * time when the delivery is expected, e.g., '2022-11-24T22:15:54+00:00'.
5354
+ */
5355
+ expected_delivery_date?: string;
4956
5356
  };
4957
5357
  /** @returns {OrderStatusResult} */
4958
5358
  declare function OrderStatusResult(): OrderStatusResult;
@@ -5025,9 +5425,107 @@ type Charge = {
5025
5425
  */
5026
5426
  type: string;
5027
5427
  };
5428
+ /** @returns {CurrencyValueSchema} */
5429
+ declare function CurrencyValueSchema(): CurrencyValueSchema;
5430
+ type CurrencyValueSchema = {
5431
+ /**
5432
+ * - The numerical value of the charge.
5433
+ */
5434
+ value: number;
5435
+ /**
5436
+ * - The currency code (e.g., USD, INR).
5437
+ */
5438
+ currency: string;
5439
+ };
5440
+ /** @returns {AmountSchema} */
5441
+ declare function AmountSchema(): AmountSchema;
5442
+ type AmountSchema = {
5443
+ ordering_currency: CurrencyValueSchema;
5444
+ base_currency: CurrencyValueSchema;
5445
+ };
5446
+ /** @returns {DynamicChargeTaxSchema} */
5447
+ declare function DynamicChargeTaxSchema(): DynamicChargeTaxSchema;
5448
+ type DynamicChargeTaxSchema = {
5449
+ /**
5450
+ * - HSN (Harmonized System of
5451
+ * Nomenclature) code for reporting purposes.
5452
+ */
5453
+ reporting_hsn_code: string;
5454
+ };
5455
+ /** @returns {RuleConditionsSchema} */
5456
+ declare function RuleConditionsSchema(): RuleConditionsSchema;
5457
+ type RuleConditionsSchema = {
5458
+ /**
5459
+ * - The tag for the article.
5460
+ */
5461
+ article_tag: string;
5462
+ /**
5463
+ * - List of applicable departments.
5464
+ */
5465
+ department: string[];
5466
+ };
5467
+ /** @returns {RuleSchema} */
5468
+ declare function RuleSchema(): RuleSchema;
5469
+ type RuleSchema = {
5470
+ conditions: RuleConditionsSchema;
5471
+ };
5472
+ /** @returns {DistributionSchema} */
5473
+ declare function DistributionSchema(): DistributionSchema;
5474
+ type DistributionSchema = {
5475
+ /**
5476
+ * - Type of distribution (single or multi).
5477
+ */
5478
+ type: string;
5479
+ /**
5480
+ * - Logic for distribution (apportion, equally).
5481
+ */
5482
+ logic: string;
5483
+ rule?: RuleSchema;
5484
+ };
5485
+ /** @returns {DistributionLogicSchema} */
5486
+ declare function DistributionLogicSchema(): DistributionLogicSchema;
5487
+ type DistributionLogicSchema = {
5488
+ /**
5489
+ * - The level at which the charge is
5490
+ * distributed (order, article, shipment).
5491
+ */
5492
+ distribution_level: string;
5493
+ distribution: DistributionSchema;
5494
+ };
5495
+ /** @returns {DynamicChargeSchema} */
5496
+ declare function DynamicChargeSchema(): DynamicChargeSchema;
5497
+ type DynamicChargeSchema = {
5498
+ /**
5499
+ * - The name of the charge.
5500
+ */
5501
+ name: string;
5502
+ /**
5503
+ * - The category or type of the charge.
5504
+ */
5505
+ type: string;
5506
+ /**
5507
+ * - An optional code associated with the charge for
5508
+ * internal tracking.
5509
+ */
5510
+ code?: string;
5511
+ amount: AmountSchema;
5512
+ taxes?: DynamicChargeTaxSchema;
5513
+ /**
5514
+ * - Meta data of the custom charge.
5515
+ */
5516
+ meta?: any;
5517
+ distribution_logic?: DistributionLogicSchema;
5518
+ };
5028
5519
  /** @returns {LineItem} */
5029
5520
  declare function LineItem(): LineItem;
5030
5521
  type LineItem = {
5522
+ /**
5523
+ * - These are the mandatory charges required
5524
+ * during order creation and are integral to the order processing flow. They
5525
+ * include fields like amount_paid, discount, and price_marked. The schema for
5526
+ * these charges is predefined and remains consistent, ensuring seamless
5527
+ * forward mapping in the code.
5528
+ */
5031
5529
  charges: Charge[];
5032
5530
  /**
5033
5531
  * - Meta data of the articles or line items.
@@ -5050,6 +5548,13 @@ type LineItem = {
5050
5548
  * articles or line items.
5051
5549
  */
5052
5550
  external_line_id?: string;
5551
+ /**
5552
+ * - (Optional) These are
5553
+ * additional charges specified by the client based on specific use cases.
5554
+ * They allow for flexibility in adding new fields such as installation_fee,
5555
+ * service_charge, or other dynamic costs.
5556
+ */
5557
+ dynamic_charges?: DynamicChargeSchema[];
5053
5558
  };
5054
5559
  /** @returns {ProcessingDates} */
5055
5560
  declare function ProcessingDates(): ProcessingDates;
@@ -5082,9 +5587,13 @@ type Shipment = {
5082
5587
  priority?: number;
5083
5588
  /**
5084
5589
  * - Location Identifier or Store/Fulfillment
5085
- * Identifier of the shipment.
5590
+ * Identifier of the shipment- This field is mandatory when
5591
+ * optimal_shipment_creation flag is set to false, indicating that shipments
5592
+ * must be associated with a specific location. When
5593
+ * `optimal_shipment_creation` is true, the optimal location for order
5594
+ * creation would be assigned, location_id becomes optional.
5086
5595
  */
5087
- location_id: number;
5596
+ location_id?: number;
5088
5597
  /**
5089
5598
  * - The order type of shipment HomeDelivery -
5090
5599
  * If the customer wants the order home-delivered PickAtStore - If the
@@ -5119,26 +5628,6 @@ type Shipment = {
5119
5628
  price?: Prices;
5120
5629
  gst?: ShipmentGstDetails;
5121
5630
  };
5122
- /** @returns {ShipmentRequestData} */
5123
- declare function ShipmentRequestData(): ShipmentRequestData;
5124
- type ShipmentRequestData = {
5125
- line_items: LineItem[];
5126
- processing_dates?: ProcessingDates;
5127
- /**
5128
- * - Meta data of the shipment.
5129
- */
5130
- meta?: any;
5131
- /**
5132
- * - Integer value indicating high and low priority.
5133
- */
5134
- priority?: number;
5135
- /**
5136
- * - The order type of shipment HomeDelivery -
5137
- * If the customer wants the order home-delivered PickAtStore - If the
5138
- * customer wants the handover of an order at the store itself.
5139
- */
5140
- order_type?: string;
5141
- };
5142
5631
  /** @returns {ShippingInfo} */
5143
5632
  declare function ShippingInfo(): ShippingInfo;
5144
5633
  type ShippingInfo = {
@@ -5281,37 +5770,39 @@ type ConfigApplication = {
5281
5770
  id: string;
5282
5771
  logo?: string;
5283
5772
  };
5284
- /** @returns {Config} */
5285
- declare function Config(): Config;
5286
- type Config = {
5287
- lock_states?: string[];
5288
- payment: ConfigPayment;
5289
- dp_configuration?: ConfigDpConfiguration;
5290
- location_reassignment?: boolean;
5291
- application?: ConfigApplication;
5292
- ordering_channel_logo?: string;
5293
- integration_type?: string;
5294
- };
5295
5773
  /** @returns {CreateOrderAPI} */
5296
5774
  declare function CreateOrderAPI(): CreateOrderAPI;
5297
5775
  type CreateOrderAPI = {
5298
5776
  shipments: Shipment[];
5299
- shipment_request_data?: ShipmentRequestData;
5300
5777
  shipping_info: any;
5301
5778
  billing_info: any;
5302
5779
  currency_info?: CurrencyInfo;
5303
5780
  external_order_id?: string;
5304
5781
  external_shipment_id?: string;
5305
5782
  order_type?: string;
5783
+ /**
5784
+ * - These are the mandatory charges required
5785
+ * during order creation and are integral to the order processing flow. They
5786
+ * include fields like amount_paid, discount, and price_marked, etc.. The
5787
+ * schema for these charges is predefined and remains consistent, ensuring
5788
+ * seamless forward mapping in the code.
5789
+ */
5306
5790
  charges?: Charge[];
5307
5791
  external_creation_date?: string;
5308
5792
  meta?: any;
5309
5793
  tax_info?: TaxInfo;
5310
- config?: Config;
5794
+ config?: CreateOrderConfig;
5311
5795
  payment_info: PaymentInfo;
5312
5796
  user_info?: UserInfo;
5313
5797
  unlock_before_transition?: boolean;
5314
5798
  lock_after_transition?: boolean;
5799
+ /**
5800
+ * - (Optional) These are
5801
+ * additional charges specified by the client based on specific use cases.
5802
+ * They allow for flexibility in adding new fields such as installation_fee,
5803
+ * service_charge, or other dynamic costs.
5804
+ */
5805
+ dynamic_charges?: DynamicChargeSchema[];
5315
5806
  };
5316
5807
  /** @returns {CreateOrderErrorReponse} */
5317
5808
  declare function CreateOrderErrorReponse(): CreateOrderErrorReponse;
@@ -5851,19 +6342,19 @@ declare function DateRange(): DateRange;
5851
6342
  type DateRange = {
5852
6343
  from_date?: string;
5853
6344
  to_date?: string;
6345
+ end_date?: string;
6346
+ start_date?: string;
5854
6347
  };
5855
6348
  /** @returns {Filters} */
5856
6349
  declare function Filters(): Filters;
5857
6350
  type Filters = {
5858
6351
  date_range?: DateRange;
5859
- logo?: string;
5860
- from_date?: string;
5861
6352
  stores?: number;
5862
- to_date?: string;
5863
6353
  dp_name?: string;
5864
- dp_ids?: number;
6354
+ dp_ids?: string;
5865
6355
  lane?: string;
5866
6356
  selected_shipments?: string;
6357
+ deselected_shipments?: string;
5867
6358
  store_name?: string;
5868
6359
  type?: string;
5869
6360
  };
@@ -6454,6 +6945,432 @@ type PageInfo = {
6454
6945
  has_next?: boolean;
6455
6946
  page_size?: number;
6456
6947
  };
6948
+ /** @returns {ConfigData} */
6949
+ declare function ConfigData(): ConfigData;
6950
+ type ConfigData = {
6951
+ /**
6952
+ * - Indicates whether the update operation
6953
+ * was acknowledged by the database.
6954
+ */
6955
+ acknowledged?: boolean;
6956
+ /**
6957
+ * - Indicates whether the update operation
6958
+ * resulted in an upsert (an update or insert).
6959
+ */
6960
+ is_upserted?: boolean;
6961
+ /**
6962
+ * - Indicates whether the update operation
6963
+ * resulted in a new document being inserted.
6964
+ */
6965
+ is_inserted?: boolean;
6966
+ };
6967
+ /** @returns {ConfigUpdatedResponse} */
6968
+ declare function ConfigUpdatedResponse(): ConfigUpdatedResponse;
6969
+ type ConfigUpdatedResponse = {
6970
+ /**
6971
+ * - The result of the config update operation,
6972
+ * including whether it was acknowledged, upserted, or inserted.
6973
+ */
6974
+ data: ConfigData[];
6975
+ /**
6976
+ * - Indicates whether the config update operation
6977
+ * was successful.
6978
+ */
6979
+ success: boolean;
6980
+ };
6981
+ /** @returns {FlagData} */
6982
+ declare function FlagData(): FlagData;
6983
+ type FlagData = {
6984
+ value?: any;
6985
+ filter?: any;
6986
+ };
6987
+ /** @returns {Flags} */
6988
+ declare function Flags(): Flags;
6989
+ type Flags = {
6990
+ /**
6991
+ * - Indicates whether a
6992
+ * partial transition of bags to the next state is permissible, allowing some
6993
+ * bags to progress while others remain in the current state.
6994
+ */
6995
+ allow_partial_transition?: FlagData[];
6996
+ /**
6997
+ * - Specifies whether bags within a
6998
+ * shipment, set,cdf or entity can be broken individually or as a group. If
6999
+ * set to false, all bags within the entity must remain together and
7000
+ * transition together to the same state.
7001
+ */
7002
+ can_break_entity?: FlagData[];
7003
+ /**
7004
+ * - Specifies which fields are
7005
+ * permitted to be updated at the bag level. Allowed fields are:
7006
+ *
7007
+ * - Meta
7008
+ * - Pdf_links
7009
+ * - Affiliate_meta
7010
+ * - Delivery_awb_number
7011
+ * - Store_invoice_id
7012
+ * - Store_id
7013
+ * - Return_store_id
7014
+ * - Eway_bill_id
7015
+ */
7016
+ allowed_bag_updates?: FlagData[];
7017
+ /**
7018
+ * - Specifies which fields
7019
+ * are permitted to be updated at the bag status level. Allowed fields are:
7020
+ *
7021
+ * - Json
7022
+ */
7023
+ allowed_bag_status_updates?: FlagData[];
7024
+ /**
7025
+ * - Specifies which fields are
7026
+ * permitted to be updated at shipment level. Allowed fields are:
7027
+ *
7028
+ * - Meta
7029
+ * - Pdf_links
7030
+ * - Affiliate_meta
7031
+ * - Delivery_awb_number
7032
+ * - Store_invoice_id
7033
+ * - Store_id
7034
+ * - Return_store_id
7035
+ * - Eway_bill_id
7036
+ * - Logistics_meta
7037
+ */
7038
+ allowed_entity_updates?: FlagData[];
7039
+ /**
7040
+ * - Specifies which
7041
+ * fields are permitted to be updated at the Entity status level. Allowed fields are:
7042
+ *
7043
+ * - Json
7044
+ */
7045
+ allowed_entity_status_updates?: FlagData[];
7046
+ /**
7047
+ * - Describes the type of journey
7048
+ * associated with the particular status of the shipment. Possible values are:
7049
+ *
7050
+ * - Positive
7051
+ * - Negative
7052
+ */
7053
+ status_update_type?: FlagData[];
7054
+ /**
7055
+ * - Indicates whether a
7056
+ * reason at the product level should be allowed for a particular status.
7057
+ */
7058
+ is_bag_status_reason_allowed?: FlagData[];
7059
+ /**
7060
+ * - Indicates whether
7061
+ * a reason at the shipment level should be allowed for a particular status.
7062
+ */
7063
+ is_entity_status_reason_allowed?: FlagData[];
7064
+ /**
7065
+ * - This flag is used to define
7066
+ * the shipment breaking strategy. Possible values are:
7067
+ *
7068
+ * - Break_shipment_based_on_location_reassignment
7069
+ * - Break_shipment_based_on_groups
7070
+ * - Break_shipment_based_on_stormbreaker
7071
+ */
7072
+ transition_strategy?: FlagData[];
7073
+ };
7074
+ /** @returns {Filter} */
7075
+ declare function Filter(): Filter;
7076
+ type Filter = {
7077
+ /**
7078
+ * - Indicates the type or category of the order.
7079
+ *
7080
+ * - PickAtStore: Pick from store
7081
+ * - HomeDelivery: Home delivery
7082
+ * - Digital: Digital
7083
+ */
7084
+ order_type?: string;
7085
+ /**
7086
+ * - Specifies whether a partial
7087
+ * transition of the order is allowed, allowing some components to progress
7088
+ * while others remain in the current state.
7089
+ */
7090
+ is_partial_transition?: boolean;
7091
+ /**
7092
+ * - Indicates whether the
7093
+ * assignment of a designated person is automatically triggered in the context of ACF.
7094
+ */
7095
+ auto_trigger_dp_assignment_acf?: boolean;
7096
+ /**
7097
+ * - Indicates the current locking status of
7098
+ * the shipment.
7099
+ *
7100
+ * - `complete`: Complete shipment lock
7101
+ * - `operational`: Operational shipment lock
7102
+ * - `None`: No lock on shipment
7103
+ */
7104
+ lock_status?: string;
7105
+ /**
7106
+ * - Specifies whether locking is
7107
+ * required after transitioning to the next status. lock_after_transition :
7108
+ * true - Lock Transition enabled lock_after_transition : false - Lock
7109
+ * Transition set false
7110
+ */
7111
+ lock_after_transition?: boolean;
7112
+ /**
7113
+ * - Indicates whether tasks
7114
+ * should resume automatically after unlocking, such as DP assignment task and
7115
+ * invoicing task.
7116
+ */
7117
+ resume_tasks_after_unlock?: boolean;
7118
+ /**
7119
+ * - Indicates whether an invoice ID
7120
+ * is present for the order.
7121
+ */
7122
+ is_invoice_id_present?: boolean;
7123
+ /**
7124
+ * - Indicates whether a credit
7125
+ * note has been generated for the order.
7126
+ */
7127
+ is_credit_note_generated?: boolean;
7128
+ /**
7129
+ * - Specifies whether an
7130
+ * automated virtual invoice ID is associated with the order.
7131
+ */
7132
+ fulfill_virtual_invoice?: boolean;
7133
+ /**
7134
+ * - Indicates the next status to which the
7135
+ * order will transition.
7136
+ */
7137
+ next_status?: string;
7138
+ /**
7139
+ * - Indicates whether a task is enabled
7140
+ * for the order.
7141
+ */
7142
+ is_hook_enabled?: boolean;
7143
+ /**
7144
+ * - Specifies whether a credit note
7145
+ * check is performed in a point of sale (POS) scenario.
7146
+ */
7147
+ pos_credit_note_check?: boolean;
7148
+ /**
7149
+ * - Specifies the platform on which the
7150
+ * order was placed.
7151
+ *
7152
+ * - `platform-pos`: POS
7153
+ * - `platform-site`: WEB
7154
+ * - `openapi`: OPENAPI
7155
+ * - `marketplace`: MARKETPLACE
7156
+ */
7157
+ order_platform?: string;
7158
+ /**
7159
+ * - Indicates the type of refund associated
7160
+ * with the order.
7161
+ *
7162
+ * - `credit_note`: CREDIT_NOTE
7163
+ * - `source`: SOURCE
7164
+ * - `bank_transfer`: BANK
7165
+ * - `manual_refund`: MANUAL_REFUND
7166
+ */
7167
+ refund_type?: string;
7168
+ /**
7169
+ * - Specifies whether the platform is
7170
+ * non-point of sale (POS) in nature.
7171
+ */
7172
+ is_non_pos_platform?: boolean;
7173
+ /**
7174
+ * - Indicates whether the order is
7175
+ * self-shipped by the seller.
7176
+ */
7177
+ is_self_ship?: boolean;
7178
+ /**
7179
+ * - Specifies the country code of the seller.
7180
+ *
7181
+ * - `seller_country_code`: US
7182
+ * - `seller_country_code`: UK
7183
+ * - `seller_country_code`: IN
7184
+ */
7185
+ seller_country_code?: string;
7186
+ /**
7187
+ * - Specifies the country code of the seller.
7188
+ *
7189
+ * - `customer_country_code`: US
7190
+ * - `customer_country_code`: UK
7191
+ * - `customer_country_code`: IN
7192
+ */
7193
+ customer_country_code?: string;
7194
+ /**
7195
+ * - Indicates whether the order is a test
7196
+ * order used for testing purposes - `is_test_order` : True - indicates test order
7197
+ */
7198
+ is_test_order?: boolean;
7199
+ /**
7200
+ * - Specifies trigger conditions:
7201
+ *
7202
+ * - `status_update`: Status Update
7203
+ * - `data_update`: Data Update
7204
+ */
7205
+ task_trigger_condition?: string[];
7206
+ };
7207
+ /** @returns {PostHook} */
7208
+ declare function PostHook(): PostHook;
7209
+ type PostHook = {
7210
+ /**
7211
+ * - Name of the hook that has to be added
7212
+ */
7213
+ task: string;
7214
+ /**
7215
+ * - Additional parameters for the hook
7216
+ */
7217
+ kwargs?: any;
7218
+ /**
7219
+ * - Filters for scope selection.
7220
+ */
7221
+ filters?: Filter;
7222
+ };
7223
+ /** @returns {PreHook} */
7224
+ declare function PreHook(): PreHook;
7225
+ type PreHook = {
7226
+ /**
7227
+ * - Name of the hook that has to be added
7228
+ */
7229
+ task: string;
7230
+ /**
7231
+ * - Additional parameters for the hook
7232
+ */
7233
+ kwargs?: any;
7234
+ /**
7235
+ * - Filter
7236
+ */
7237
+ filters?: Filter;
7238
+ };
7239
+ /** @returns {Config} */
7240
+ declare function Config(): Config;
7241
+ type Config = {
7242
+ /**
7243
+ * - Source state from which state transition
7244
+ * will take place
7245
+ */
7246
+ from_state?: string;
7247
+ /**
7248
+ * - Target state to which state transition will take place
7249
+ */
7250
+ to_state?: string;
7251
+ /**
7252
+ * - Tasks to be run before state transition
7253
+ */
7254
+ pre_hooks?: PreHook[];
7255
+ /**
7256
+ * - Tasks to be run after state transition
7257
+ */
7258
+ post_hooks?: PostHook[];
7259
+ /**
7260
+ * - Various flags related to the transition. These
7261
+ * include options and settings that influence the behavior of the state
7262
+ * transition, such as whether partial transitions are allowed or whether the
7263
+ * transition can break the entity.
7264
+ */
7265
+ flags?: Flags;
7266
+ };
7267
+ /** @returns {TransitionConfigCondition} */
7268
+ declare function TransitionConfigCondition(): TransitionConfigCondition;
7269
+ type TransitionConfigCondition = {
7270
+ /**
7271
+ * - The unique identifier of the application to which
7272
+ * the configuration applies.
7273
+ */
7274
+ app_id: string;
7275
+ /**
7276
+ * - The channel through which the order was
7277
+ * placed, such as ECOMM or another specified channel.
7278
+ */
7279
+ ordering_channel: string;
7280
+ /**
7281
+ * - The type of entity that the configuration pertains to.
7282
+ */
7283
+ entity: string;
7284
+ };
7285
+ /** @returns {TransitionConfigData} */
7286
+ declare function TransitionConfigData(): TransitionConfigData;
7287
+ type TransitionConfigData = {
7288
+ /**
7289
+ * - Conditions that must be
7290
+ * met for the ESM config to be applied.
7291
+ */
7292
+ conditions?: TransitionConfigCondition;
7293
+ /**
7294
+ * - The configuration settings for the entity
7295
+ * transition. This includes pre_hooks, post_hooks, and flags for each
7296
+ * transition state.
7297
+ */
7298
+ configs?: Config[];
7299
+ };
7300
+ /** @returns {TransitionConfigPayload} */
7301
+ declare function TransitionConfigPayload(): TransitionConfigPayload;
7302
+ type TransitionConfigPayload = {
7303
+ data?: TransitionConfigData;
7304
+ };
7305
+ /** @returns {ProcessManifestRequest} */
7306
+ declare function ProcessManifestRequest(): ProcessManifestRequest;
7307
+ type ProcessManifestRequest = {
7308
+ /**
7309
+ * - Expected Actions: [save, process,
7310
+ * pdf_generated,invalidate,pdf_failed,complete]
7311
+ */
7312
+ action?: string;
7313
+ filters?: Filters;
7314
+ /**
7315
+ * - Unique Id.
7316
+ */
7317
+ unique_id?: string;
7318
+ };
7319
+ /** @returns {ManifestResponse} */
7320
+ declare function ManifestResponse(): ManifestResponse;
7321
+ type ManifestResponse = {
7322
+ items?: ManifestItems;
7323
+ };
7324
+ /** @returns {ManifestItems} */
7325
+ declare function ManifestItems(): ManifestItems;
7326
+ type ManifestItems = {
7327
+ filters?: Filters;
7328
+ /**
7329
+ * - Id of the manifest.
7330
+ */
7331
+ manifest_id?: string;
7332
+ /**
7333
+ * - Unique Id.
7334
+ */
7335
+ unique_id?: string;
7336
+ /**
7337
+ * - Id of the company.
7338
+ */
7339
+ company_id?: number;
7340
+ /**
7341
+ * - Shipment with the specific courier partner Id.
7342
+ */
7343
+ dp_id?: string;
7344
+ /**
7345
+ * - Courier partner slug
7346
+ */
7347
+ courier_partner_slug?: string;
7348
+ /**
7349
+ * - Expected Actions: [Save, Process, Pdf
7350
+ * Generated, Invalidate, Pdf Failed, Complete]
7351
+ */
7352
+ action?: string;
7353
+ /**
7354
+ * - Created date of the manifest.
7355
+ */
7356
+ created_by?: string;
7357
+ /**
7358
+ * - Id of user.
7359
+ */
7360
+ user_id?: string;
7361
+ };
7362
+ /** @returns {ManifestErrorResponse} */
7363
+ declare function ManifestErrorResponse(): ManifestErrorResponse;
7364
+ type ManifestErrorResponse = {
7365
+ /**
7366
+ * - Success State.
7367
+ */
7368
+ success?: boolean;
7369
+ /**
7370
+ * - Error String.
7371
+ */
7372
+ error?: string;
7373
+ };
6457
7374
  /** @returns {Page} */
6458
7375
  declare function Page(): Page;
6459
7376
  type Page = {
@@ -8042,6 +8959,10 @@ type OrderingStoreDetails = {
8042
8959
  * - City where the store is located.
8043
8960
  */
8044
8961
  city?: string;
8962
+ /**
8963
+ * - Email address of store
8964
+ */
8965
+ store_email?: string;
8045
8966
  };
8046
8967
  /** @returns {DPDetailsData} */
8047
8968
  declare function DPDetailsData(): DPDetailsData;
@@ -8649,6 +9570,10 @@ type FulfillingStore = {
8649
9570
  contact_person: string;
8650
9571
  state: string;
8651
9572
  city: string;
9573
+ /**
9574
+ * - Email of the recipient associated with the store
9575
+ */
9576
+ store_email?: string;
8652
9577
  };
8653
9578
  /** @returns {ShipmentPayments} */
8654
9579
  declare function ShipmentPayments(): ShipmentPayments;
@@ -8730,6 +9655,10 @@ type ShipmentPaymentInfoData = {
8730
9655
  * should be displayed to the user.
8731
9656
  */
8732
9657
  display_name?: string;
9658
+ /**
9659
+ * - All necessary data for transaction received
9660
+ */
9661
+ transaction_data?: any;
8733
9662
  };
8734
9663
  /** @returns {PlatformShipment} */
8735
9664
  declare function PlatformShipment(): PlatformShipment;
@@ -8754,6 +9683,7 @@ type PlatformShipment = {
8754
9683
  */
8755
9684
  shipment_status?: string;
8756
9685
  gst_details?: GSTDetailsData;
9686
+ order_status?: OrderStatusData;
8757
9687
  /**
8758
9688
  * - Delivery slot details
8759
9689
  */