fluentcart-developer 3.0.0 → 3.0.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 (609) hide show
  1. package/LICENSE.md +26 -26
  2. package/README.md +59 -59
  3. package/dist/cards/fluentcart/templates-native.js +1087 -1087
  4. package/dist/cards/fluentcart/tools.js +2309 -2309
  5. package/dist/skills/fluentcart-developer/SKILL.md +108 -108
  6. package/dist/skills/fluentcart-developer/examples/README.md +30 -30
  7. package/dist/skills/fluentcart-developer/examples/fluentcart-starter-child-theme/fluent-cart/checkout.php +32 -32
  8. package/dist/skills/fluentcart-developer/examples/fluentcart-starter-child-theme/functions.php +40 -40
  9. package/dist/skills/fluentcart-developer/examples/sample-custom-addon/fluentcart-custom-addon.php +113 -113
  10. package/dist/skills/fluentcart-developer/examples/sample-custom-payment-gateway/fluentcart-custom-gateway-example.php +148 -148
  11. package/dist/skills/fluentcart-developer/examples/sample-fee-surcharge-plugin/fluentcart-fee-surcharge.php +38 -38
  12. package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/README.md +22 -22
  13. package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/sample-plugin-with-licensing-sdk.php +79 -79
  14. package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/updater/FluentLicensing.php +303 -303
  15. package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/updater/LicenseSettings.php +566 -566
  16. package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/updater/PluginUpdater.php +304 -304
  17. package/dist/skills/fluentcart-developer/examples/sample-shipping-carrier/fluentcart-custom-shipping-carrier.php +61 -61
  18. package/dist/skills/fluentcart-developer/references/api/authentication.md +452 -452
  19. package/dist/skills/fluentcart-developer/references/api/coupons.md +786 -786
  20. package/dist/skills/fluentcart-developer/references/api/customers.md +889 -889
  21. package/dist/skills/fluentcart-developer/references/api/files.md +609 -609
  22. package/dist/skills/fluentcart-developer/references/api/index.md +432 -432
  23. package/dist/skills/fluentcart-developer/references/api/licensing.md +633 -633
  24. package/dist/skills/fluentcart-developer/references/api/order-bump.md +384 -384
  25. package/dist/skills/fluentcart-developer/references/api/orders.md +814 -814
  26. package/dist/skills/fluentcart-developer/references/api/products.md +866 -866
  27. package/dist/skills/fluentcart-developer/references/api/roles-permissions.md +536 -536
  28. package/dist/skills/fluentcart-developer/references/api/subscriptions.md +827 -827
  29. package/dist/skills/fluentcart-developer/references/database/index.md +44 -44
  30. package/dist/skills/fluentcart-developer/references/database/models/activity.md +178 -178
  31. package/dist/skills/fluentcart-developer/references/database/models/applied-coupon.md +291 -291
  32. package/dist/skills/fluentcart-developer/references/database/models/attribute-group.md +239 -239
  33. package/dist/skills/fluentcart-developer/references/database/models/attribute-relation.md +181 -181
  34. package/dist/skills/fluentcart-developer/references/database/models/attribute-term.md +219 -219
  35. package/dist/skills/fluentcart-developer/references/database/models/cart.md +645 -645
  36. package/dist/skills/fluentcart-developer/references/database/models/coupon.md +427 -427
  37. package/dist/skills/fluentcart-developer/references/database/models/customer-addresses.md +348 -348
  38. package/dist/skills/fluentcart-developer/references/database/models/customer-meta.md +156 -156
  39. package/dist/skills/fluentcart-developer/references/database/models/customer.md +584 -584
  40. package/dist/skills/fluentcart-developer/references/database/models/dynamic-model.md +163 -163
  41. package/dist/skills/fluentcart-developer/references/database/models/label-relationship.md +155 -155
  42. package/dist/skills/fluentcart-developer/references/database/models/label.md +153 -153
  43. package/dist/skills/fluentcart-developer/references/database/models/license-activation.md +182 -182
  44. package/dist/skills/fluentcart-developer/references/database/models/license-meta.md +163 -163
  45. package/dist/skills/fluentcart-developer/references/database/models/license-site.md +208 -208
  46. package/dist/skills/fluentcart-developer/references/database/models/license.md +640 -640
  47. package/dist/skills/fluentcart-developer/references/database/models/meta.md +233 -233
  48. package/dist/skills/fluentcart-developer/references/database/models/order-address.md +391 -391
  49. package/dist/skills/fluentcart-developer/references/database/models/order-download-permission.md +144 -144
  50. package/dist/skills/fluentcart-developer/references/database/models/order-item.md +383 -383
  51. package/dist/skills/fluentcart-developer/references/database/models/order-meta.md +303 -303
  52. package/dist/skills/fluentcart-developer/references/database/models/order-operation.md +158 -158
  53. package/dist/skills/fluentcart-developer/references/database/models/order-promotion-stat.md +175 -175
  54. package/dist/skills/fluentcart-developer/references/database/models/order-promotion.md +250 -250
  55. package/dist/skills/fluentcart-developer/references/database/models/order-tax-rate.md +172 -172
  56. package/dist/skills/fluentcart-developer/references/database/models/order-transaction.md +440 -440
  57. package/dist/skills/fluentcart-developer/references/database/models/order.md +727 -727
  58. package/dist/skills/fluentcart-developer/references/database/models/product-detail.md +397 -397
  59. package/dist/skills/fluentcart-developer/references/database/models/product-download.md +258 -258
  60. package/dist/skills/fluentcart-developer/references/database/models/product-meta.md +153 -153
  61. package/dist/skills/fluentcart-developer/references/database/models/product-variation.md +556 -556
  62. package/dist/skills/fluentcart-developer/references/database/models/product.md +580 -580
  63. package/dist/skills/fluentcart-developer/references/database/models/relationships.md +427 -427
  64. package/dist/skills/fluentcart-developer/references/database/models/scheduled-action.md +175 -175
  65. package/dist/skills/fluentcart-developer/references/database/models/shipping-class.md +148 -148
  66. package/dist/skills/fluentcart-developer/references/database/models/shipping-method.md +280 -280
  67. package/dist/skills/fluentcart-developer/references/database/models/shipping-zone.md +205 -205
  68. package/dist/skills/fluentcart-developer/references/database/models/subscription-meta.md +173 -173
  69. package/dist/skills/fluentcart-developer/references/database/models/subscription.md +528 -528
  70. package/dist/skills/fluentcart-developer/references/database/models/tax-class.md +195 -195
  71. package/dist/skills/fluentcart-developer/references/database/models/tax-rate.md +225 -225
  72. package/dist/skills/fluentcart-developer/references/database/models/user-meta.md +166 -166
  73. package/dist/skills/fluentcart-developer/references/database/models/user.md +220 -220
  74. package/dist/skills/fluentcart-developer/references/database/models.md +404 -404
  75. package/dist/skills/fluentcart-developer/references/database/query-builder.md +860 -860
  76. package/dist/skills/fluentcart-developer/references/database/readme.md +276 -276
  77. package/dist/skills/fluentcart-developer/references/database/schema.md +1002 -1002
  78. package/dist/skills/fluentcart-developer/references/engineering/adding-custom-pages-to-the-customer-dashboard.md +395 -395
  79. package/dist/skills/fluentcart-developer/references/engineering/index.md +4 -4
  80. package/dist/skills/fluentcart-developer/references/engineering.md +4 -4
  81. package/dist/skills/fluentcart-developer/references/getting-started.md +249 -249
  82. package/dist/skills/fluentcart-developer/references/guides/frontend.md +519 -519
  83. package/dist/skills/fluentcart-developer/references/guides/index.md +107 -107
  84. package/dist/skills/fluentcart-developer/references/guides/integrations.md +600 -600
  85. package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/index.md +237 -237
  86. package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/labels-and-tracking.md +481 -481
  87. package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/live-rates.md +269 -269
  88. package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/reference.md +223 -223
  89. package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/settings.md +370 -370
  90. package/dist/skills/fluentcart-developer/references/guides/shipping-carrier.md +237 -237
  91. package/dist/skills/fluentcart-developer/references/guides/subscriptions.md +217 -217
  92. package/dist/skills/fluentcart-developer/references/hooks/actions/admin-and-templates.md +1079 -1079
  93. package/dist/skills/fluentcart-developer/references/hooks/actions/cart-and-checkout.md +1795 -1795
  94. package/dist/skills/fluentcart-developer/references/hooks/actions/customers-and-users.md +327 -327
  95. package/dist/skills/fluentcart-developer/references/hooks/actions/licenses.md +829 -829
  96. package/dist/skills/fluentcart-developer/references/hooks/actions/modules.md +81 -81
  97. package/dist/skills/fluentcart-developer/references/hooks/actions/orders.md +757 -757
  98. package/dist/skills/fluentcart-developer/references/hooks/actions/payments-and-integrations.md +1163 -1163
  99. package/dist/skills/fluentcart-developer/references/hooks/actions/pro-modules.md +219 -219
  100. package/dist/skills/fluentcart-developer/references/hooks/actions/products-and-coupons.md +1019 -1019
  101. package/dist/skills/fluentcart-developer/references/hooks/actions/subscriptions.md +1290 -1290
  102. package/dist/skills/fluentcart-developer/references/hooks/actions.md +16 -16
  103. package/dist/skills/fluentcart-developer/references/hooks/deprecated.md +60 -60
  104. package/dist/skills/fluentcart-developer/references/hooks/filters/cart-and-checkout.md +2032 -2032
  105. package/dist/skills/fluentcart-developer/references/hooks/filters/customers-and-subscriptions.md +1746 -1746
  106. package/dist/skills/fluentcart-developer/references/hooks/filters/integrations-and-advanced.md +2439 -2439
  107. package/dist/skills/fluentcart-developer/references/hooks/filters/modules.md +464 -464
  108. package/dist/skills/fluentcart-developer/references/hooks/filters/orders-and-payments.md +2658 -2658
  109. package/dist/skills/fluentcart-developer/references/hooks/filters/pro-modules.md +502 -502
  110. package/dist/skills/fluentcart-developer/references/hooks/filters/products-and-pricing.md +1785 -1785
  111. package/dist/skills/fluentcart-developer/references/hooks/filters/settings-and-configuration.md +2966 -2966
  112. package/dist/skills/fluentcart-developer/references/hooks/filters.md +14 -14
  113. package/dist/skills/fluentcart-developer/references/hooks/index.md +35 -35
  114. package/dist/skills/fluentcart-developer/references/index.md +625 -625
  115. package/dist/skills/fluentcart-developer/references/modules/fee-system.md +427 -427
  116. package/dist/skills/fluentcart-developer/references/modules/ghost-product-selling.md +440 -440
  117. package/dist/skills/fluentcart-developer/references/modules/index.md +484 -484
  118. package/dist/skills/fluentcart-developer/references/modules/licensing.md +342 -342
  119. package/dist/skills/fluentcart-developer/references/modules/order-bump.md +433 -433
  120. package/dist/skills/fluentcart-developer/references/modules/payment-methods.md +129 -129
  121. package/dist/skills/fluentcart-developer/references/modules/refunds.md +170 -170
  122. package/dist/skills/fluentcart-developer/references/modules/shipping.md +846 -846
  123. package/dist/skills/fluentcart-developer/references/modules/storage.md +986 -986
  124. package/dist/skills/fluentcart-developer/references/modules/subscription-vendor-ids.md +186 -186
  125. package/dist/skills/fluentcart-developer/references/modules/subscriptions.md +678 -678
  126. package/dist/skills/fluentcart-developer/references/payment-methods-integration/index.md +164 -164
  127. package/dist/skills/fluentcart-developer/references/payment-methods-integration/paddle-example.md +1648 -1648
  128. package/dist/skills/fluentcart-developer/references/payment-methods-integration/payment/setting/fields.md +353 -353
  129. package/dist/skills/fluentcart-developer/references/payment-methods-integration/quick-implementation.md +1079 -1079
  130. package/dist/skills/fluentcart-developer/references/payment-methods-integration.md +164 -164
  131. package/dist/skills/fluentcart-developer/references/restapi/checkout.md +573 -573
  132. package/dist/skills/fluentcart-developer/references/restapi/coupons.md +958 -958
  133. package/dist/skills/fluentcart-developer/references/restapi/customer-profile.md +1423 -1423
  134. package/dist/skills/fluentcart-developer/references/restapi/customers.md +1103 -1103
  135. package/dist/skills/fluentcart-developer/references/restapi/dashboard.md +1083 -1083
  136. package/dist/skills/fluentcart-developer/references/restapi/data-export.md +132 -132
  137. package/dist/skills/fluentcart-developer/references/restapi/email-notifications.md +846 -846
  138. package/dist/skills/fluentcart-developer/references/restapi/files.md +313 -313
  139. package/dist/skills/fluentcart-developer/references/restapi/index.md +127 -127
  140. package/dist/skills/fluentcart-developer/references/restapi/integrations.md +1000 -1000
  141. package/dist/skills/fluentcart-developer/references/restapi/inventory.md +192 -192
  142. package/dist/skills/fluentcart-developer/references/restapi/labels-and-attributes.md +797 -797
  143. package/dist/skills/fluentcart-developer/references/restapi/licensing.md +1733 -1733
  144. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-available-shipping-methods.md +30 -30
  145. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-checkout-summary.md +28 -28
  146. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-country-info.md +29 -29
  147. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-order-info.md +28 -28
  148. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-shipping-methods-list-view.md +30 -30
  149. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/login.md +66 -66
  150. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/place-order.md +179 -179
  151. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/apply-coupon.md +83 -83
  152. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/cancel-coupon.md +87 -87
  153. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/check-product-eligibility.md +59 -59
  154. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/create-coupon.md +230 -230
  155. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/delete-coupon.md +29 -29
  156. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/get-coupon-settings.md +20 -20
  157. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/get-coupon.md +27 -27
  158. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/list-coupon-codes.md +20 -20
  159. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/list-coupons.md +37 -37
  160. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/re-apply-coupons.md +75 -75
  161. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/store-coupon-settings.md +40 -40
  162. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/update-coupon.md +133 -133
  163. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/create-address-checkout.md +138 -138
  164. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/create-profile-address.md +119 -119
  165. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/dashboard-overview.md +22 -22
  166. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/delete-profile-address.md +46 -46
  167. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-order-details.md +30 -30
  168. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-portal-sections.md +29 -29
  169. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-profile-details.md +22 -22
  170. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-transaction-billing-address.md +30 -30
  171. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-upgrade-paths.md +31 -31
  172. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/list-downloads.md +29 -29
  173. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/list-orders.md +28 -28
  174. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/make-profile-address-primary.md +55 -55
  175. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/pause-subscription.md +29 -29
  176. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/resume-subscription.md +29 -29
  177. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/save-transaction-billing-address.md +92 -92
  178. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/select-address-for-checkout.md +32 -32
  179. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/update-profile-address.md +115 -115
  180. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/update-profile-details.md +69 -69
  181. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/attach-user.md +50 -50
  182. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/bulk-actions.md +65 -65
  183. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/create-address.md +135 -135
  184. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/create-customer.md +108 -108
  185. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/delete-address.md +62 -62
  186. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/detach-user.md +28 -28
  187. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/find-customer-order.md +27 -27
  188. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-attachable-users.md +20 -20
  189. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer-addresses.md +28 -28
  190. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer-orders.md +37 -37
  191. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer-stats.md +27 -27
  192. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer.md +32 -32
  193. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/list-customers.md +37 -37
  194. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/recalculate-ltv.md +28 -28
  195. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/set-primary-address.md +72 -72
  196. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/update-additional-info.md +55 -55
  197. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/update-address.md +144 -144
  198. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/update-customer.md +123 -123
  199. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/attach-note-to-order.md +49 -49
  200. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/create-all-pages.md +21 -21
  201. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/create-single-page.md +55 -55
  202. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/delete-activity.md +28 -28
  203. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-country-info.md +29 -29
  204. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-dashboard-stats.md +22 -22
  205. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-filter-options.md +31 -31
  206. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-onboarding-data.md +20 -20
  207. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-onboarding-settings.md +20 -20
  208. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-print-templates.md +20 -20
  209. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-search-options.md +27 -27
  210. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-widgets.md +28 -28
  211. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/initialize-app.md +20 -20
  212. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/list-activities.md +33 -33
  213. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/list-attachments.md +21 -21
  214. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/list-countries.md +20 -20
  215. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/mark-activity-read.md +53 -53
  216. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/run-data-backfills.md +21 -21
  217. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/save-onboarding-settings.md +54 -54
  218. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/save-onboarding-tax-settings.md +73 -73
  219. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/save-print-templates.md +64 -64
  220. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/upload-attachment.md +42 -42
  221. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-customers-batch.md +129 -129
  222. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-licenses-batch.md +133 -133
  223. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-orders-batch.md +129 -129
  224. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-subscriptions-batch.md +129 -129
  225. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-customers-export-schema.md +21 -21
  226. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-licenses-export-schema.md +26 -26
  227. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-orders-export-schema.md +21 -21
  228. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-subscriptions-export-schema.md +21 -21
  229. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/enable-notification.md +57 -57
  230. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-digest-settings.md +22 -22
  231. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-notification.md +30 -30
  232. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-reminders.md +22 -22
  233. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-settings.md +22 -22
  234. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-shortcodes.md +22 -22
  235. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/list-notifications.md +20 -20
  236. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/preview-default-template.md +66 -66
  237. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/preview-notification.md +50 -50
  238. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/save-digest-settings.md +101 -101
  239. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/save-reminders.md +162 -162
  240. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/save-settings.md +99 -99
  241. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/send-digest-test.md +47 -47
  242. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/send-manual-reminder.md +51 -51
  243. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/update-notification.md +93 -93
  244. package/dist/skills/fluentcart-developer/references/restapi/operations/files/delete-file.md +31 -31
  245. package/dist/skills/fluentcart-developer/references/restapi/operations/files/get-bucket-list.md +28 -28
  246. package/dist/skills/fluentcart-developer/references/restapi/operations/files/list-files.md +30 -30
  247. package/dist/skills/fluentcart-developer/references/restapi/operations/files/upload-editor-file.md +32 -32
  248. package/dist/skills/fluentcart-developer/references/restapi/operations/files/upload-file.md +34 -34
  249. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/chained-data-request.md +46 -46
  250. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/change-feed-status.md +51 -51
  251. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/delete-feed.md +27 -27
  252. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-dynamic-options.md +29 -29
  253. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-feed-lists.md +27 -27
  254. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-feed-settings.md +27 -27
  255. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-global-feeds.md +20 -20
  256. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-global-settings.md +26 -26
  257. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/install-addon-plugin.md +49 -49
  258. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/list-addons.md +20 -20
  259. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/save-feed-settings.md +52 -52
  260. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/set-global-settings.md +50 -50
  261. package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/bulk-update-stock.md +94 -94
  262. package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/export-inventory.md +81 -81
  263. package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/get-adjustment-history.md +26 -26
  264. package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/get-inventory-stats.md +21 -21
  265. package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/list-inventory.md +33 -33
  266. package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/update-stock.md +75 -75
  267. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/create-attribute-group.md +31 -31
  268. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/create-label.md +31 -31
  269. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/create-terms.md +90 -90
  270. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/delete-attribute-group.md +28 -28
  271. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/delete-attribute-term.md +29 -29
  272. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/get-attribute-group.md +28 -28
  273. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/get-attribute-library.md +20 -20
  274. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/list-attribute-groups.md +32 -32
  275. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/list-attribute-terms.md +33 -33
  276. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/list-labels.md +20 -20
  277. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/reorder-groups.md +51 -51
  278. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/reorder-terms.md +56 -56
  279. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/update-attribute-group.md +37 -37
  280. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/update-attribute-term.md +39 -39
  281. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/update-label-selections.md +32 -32
  282. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/activate-plugin-license.md +41 -41
  283. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/activate-site-admin.md +60 -60
  284. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/deactivate-plugin-license.md +18 -18
  285. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/deactivate-site-admin.md +67 -67
  286. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/deactivate-site-customer.md +47 -47
  287. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/delete-license.md +24 -24
  288. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/extend-license-validity.md +47 -47
  289. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-customer-license-details.md +25 -25
  290. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-customer-licenses-admin.md +26 -26
  291. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-license-activations.md +25 -25
  292. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-license-details.md +25 -25
  293. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-license-site.md +30 -30
  294. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-plugin-license-status.md +18 -18
  295. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-product-license-settings.md +24 -24
  296. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/list-customer-licenses.md +25 -25
  297. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/list-license-sites.md +33 -33
  298. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/list-licenses.md +38 -38
  299. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-activate-license.md +54 -54
  300. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-check-license.md +26 -26
  301. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-deactivate-license.md +46 -46
  302. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-download-license-package.md +23 -23
  303. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-get-license-version.md +26 -26
  304. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/regenerate-license-key.md +24 -24
  305. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/save-product-license-settings.md +193 -193
  306. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/update-license-activation-limit.md +53 -53
  307. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/update-license-status.md +52 -52
  308. package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/create-order-bump.md +47 -47
  309. package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/delete-order-bump.md +25 -25
  310. package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/get-order-bump.md +25 -25
  311. package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/list-order-bumps.md +29 -29
  312. package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/update-order-bump.md +141 -141
  313. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/accept-dispute.md +47 -47
  314. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/bulk-actions.md +72 -72
  315. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/calculate-shipping.md +67 -67
  316. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/calculate-tax.md +98 -98
  317. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/change-customer.md +50 -50
  318. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/charge-now.md +29 -29
  319. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-and-change-customer.md +92 -92
  320. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-custom-order-item.md +68 -68
  321. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-order.md +351 -351
  322. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-renewal-now.md +29 -29
  323. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/delete-order.md +28 -28
  324. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/generate-missing-licenses.md +29 -29
  325. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-order-transactions.md +27 -27
  326. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-order.md +27 -27
  327. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-renewal.md +28 -28
  328. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-shipping-methods.md +28 -28
  329. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-single-transaction.md +28 -28
  330. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/list-order-currencies.md +22 -22
  331. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/list-orders.md +42 -42
  332. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/list-renewals.md +28 -28
  333. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/mark-as-paid.md +61 -61
  334. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/price-order.md +135 -135
  335. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/refund-order.md +72 -72
  336. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/resend-renewal-invoice.md +29 -29
  337. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/skip-renewal.md +48 -48
  338. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/sync-order-statuses.md +28 -28
  339. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/sync-pending-transaction.md +29 -29
  340. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-order-address-id.md +60 -60
  341. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-order-address.md +98 -98
  342. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-order.md +172 -172
  343. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-statuses.md +77 -77
  344. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-subscription-details.md +84 -84
  345. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-transaction-status.md +51 -51
  346. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/void-renewal.md +30 -30
  347. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/create-pdf-template.md +42 -42
  348. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/delete-pdf-template.md +26 -26
  349. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/download-pdf-preview.md +44 -44
  350. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-factory-default-templates.md +19 -19
  351. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-pdf-status.md +21 -21
  352. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-pdf-template.md +26 -26
  353. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-saved-templates.md +21 -21
  354. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-seller-details.md +19 -19
  355. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/list-pdf-templates.md +19 -19
  356. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/save-pdf-template.md +53 -53
  357. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/save-seller-details.md +97 -97
  358. package/dist/skills/fluentcart-developer/references/restapi/operations/products/add-product-terms.md +64 -64
  359. package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-edit-fetch.md +30 -30
  360. package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-insert-products.md +62 -62
  361. package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-update-products.md +59 -59
  362. package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-update-variants.md +83 -83
  363. package/dist/skills/fluentcart-developer/references/restapi/operations/products/change-integration-status.md +64 -64
  364. package/dist/skills/fluentcart-developer/references/restapi/operations/products/create-dummy-products.md +45 -45
  365. package/dist/skills/fluentcart-developer/references/restapi/operations/products/create-product.md +81 -81
  366. package/dist/skills/fluentcart-developer/references/restapi/operations/products/create-variation.md +181 -181
  367. package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-downloadable-file.md +27 -27
  368. package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-product-integration.md +30 -30
  369. package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-product.md +27 -27
  370. package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-taxonomy-term.md +55 -55
  371. package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-upgrade-path.md +27 -27
  372. package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-variation.md +27 -27
  373. package/dist/skills/fluentcart-developer/references/restapi/operations/products/do-bulk-action.md +56 -56
  374. package/dist/skills/fluentcart-developer/references/restapi/operations/products/duplicate-product.md +56 -56
  375. package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-products-by-ids.md +26 -26
  376. package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-taxonomy-terms.md +20 -20
  377. package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-terms-by-parent.md +60 -60
  378. package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-variations-by-ids.md +26 -26
  379. package/dist/skills/fluentcart-developer/references/restapi/operations/products/find-subscription-variants.md +26 -26
  380. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-bundle-info.md +27 -27
  381. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-downloadable-url.md +27 -27
  382. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-max-excerpt-word-count.md +20 -20
  383. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-pricing-widgets.md +27 -27
  384. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product-integration-feeds.md +29 -29
  385. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product-integration-settings.md +31 -31
  386. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product-pricing.md +28 -28
  387. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product.md +28 -28
  388. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-related-products.md +31 -31
  389. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-upgrade-settings.md +27 -27
  390. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-variation-upgrade-paths.md +28 -28
  391. package/dist/skills/fluentcart-developer/references/restapi/operations/products/group-bulk-update-variants.md +103 -103
  392. package/dist/skills/fluentcart-developer/references/restapi/operations/products/list-all-variants.md +26 -26
  393. package/dist/skills/fluentcart-developer/references/restapi/operations/products/list-product-variations.md +26 -26
  394. package/dist/skills/fluentcart-developer/references/restapi/operations/products/list-products.md +34 -34
  395. package/dist/skills/fluentcart-developer/references/restapi/operations/products/remove-shipping-class.md +27 -27
  396. package/dist/skills/fluentcart-developer/references/restapi/operations/products/remove-tax-class.md +27 -27
  397. package/dist/skills/fluentcart-developer/references/restapi/operations/products/save-bundle-info.md +56 -56
  398. package/dist/skills/fluentcart-developer/references/restapi/operations/products/save-product-integration.md +62 -62
  399. package/dist/skills/fluentcart-developer/references/restapi/operations/products/save-upgrade-path.md +78 -78
  400. package/dist/skills/fluentcart-developer/references/restapi/operations/products/search-product-variant-options.md +29 -29
  401. package/dist/skills/fluentcart-developer/references/restapi/operations/products/search-products-by-name.md +28 -28
  402. package/dist/skills/fluentcart-developer/references/restapi/operations/products/search-variants-by-name.md +28 -28
  403. package/dist/skills/fluentcart-developer/references/restapi/operations/products/set-variation-media.md +74 -74
  404. package/dist/skills/fluentcart-developer/references/restapi/operations/products/suggest-sku.md +28 -28
  405. package/dist/skills/fluentcart-developer/references/restapi/operations/products/sync-downloadable-files.md +134 -134
  406. package/dist/skills/fluentcart-developer/references/restapi/operations/products/sync-taxonomy-terms.md +61 -61
  407. package/dist/skills/fluentcart-developer/references/restapi/operations/products/toggle-product-tax-exemption.md +56 -56
  408. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-downloadable-file.md +98 -98
  409. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-inventory.md +56 -56
  410. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-long-desc-editor-mode.md +49 -49
  411. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-manage-stock.md +53 -53
  412. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-product-detail.md +58 -58
  413. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-product-pricing.md +225 -225
  414. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-shipping-class.md +49 -49
  415. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-tax-class.md +49 -49
  416. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-upgrade-path.md +78 -78
  417. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variant-option.md +79 -79
  418. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variant-tax-exemption.md +56 -56
  419. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variation-pricing-table.md +49 -49
  420. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variation.md +105 -105
  421. package/dist/skills/fluentcart-developer/references/restapi/operations/public-shop/get-product-views.md +34 -34
  422. package/dist/skills/fluentcart-developer/references/restapi/operations/public-shop/list-products.md +42 -42
  423. package/dist/skills/fluentcart-developer/references/restapi/operations/public-shop/search-products.md +30 -30
  424. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/channel-rules.md +24 -24
  425. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/country-heat-map.md +22 -22
  426. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/coupon-overview.md +37 -37
  427. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/coupons.md +36 -36
  428. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-insights.md +31 -31
  429. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-overview.md +36 -36
  430. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-repeat.md +35 -35
  431. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-segment-customers.md +36 -36
  432. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-segments.md +30 -30
  433. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-value.md +34 -34
  434. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/dashboard-stats.md +30 -30
  435. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/failed-orders.md +34 -34
  436. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-new-vs-returning-customer.md +34 -34
  437. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-report-by-day-and-hour.md +34 -34
  438. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-report-meta.md +29 -29
  439. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-top-sold-products.md +34 -34
  440. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/future-renewals.md +31 -31
  441. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/generate-retention-snapshots.md +24 -24
  442. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-overview.md +30 -30
  443. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-recent-activities.md +26 -26
  444. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-recent-orders.md +20 -20
  445. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-revenue.md +37 -37
  446. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/installments-at-risk.md +35 -35
  447. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/installments-variations.md +33 -33
  448. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/installments.md +33 -33
  449. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/item-count-distribution.md +34 -34
  450. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/license-chart.md +30 -30
  451. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/license-pie-chart.md +22 -22
  452. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/license-summary.md +22 -22
  453. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/locations.md +43 -43
  454. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-chart.md +37 -37
  455. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-completion-time.md +34 -34
  456. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-mix.md +34 -34
  457. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-value-distribution.md +34 -34
  458. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/payment-methods-disputes.md +38 -38
  459. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/payment-methods-methods.md +36 -36
  460. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/payment-methods.md +37 -37
  461. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-comparison-launch.md +33 -33
  462. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-comparison.md +40 -40
  463. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-detail.md +37 -37
  464. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-sales.md +37 -37
  465. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/refunds-overview.md +37 -37
  466. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/retention-snapshots-step.md +45 -45
  467. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/sales-growth-chart.md +35 -35
  468. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/save-channel-rules.md +73 -73
  469. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/source-channels.md +37 -37
  470. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/sources.md +49 -49
  471. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-cohorts.md +33 -33
  472. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-health.md +30 -30
  473. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-rebuys.md +37 -37
  474. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-retention.md +34 -34
  475. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-variations.md +22 -22
  476. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscriptions-overview.md +37 -37
  477. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/weeks-between-refund.md +34 -34
  478. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/assign-role.md +48 -48
  479. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/delete-role-assignment.md +47 -47
  480. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/get-role.md +25 -25
  481. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/list-managers.md +18 -18
  482. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/list-roles.md +18 -18
  483. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/search-users.md +25 -25
  484. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/update-role.md +43 -43
  485. package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/create-saved-view.md +106 -106
  486. package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/delete-saved-view.md +26 -26
  487. package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/list-saved-views.md +25 -25
  488. package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/update-saved-view.md +83 -83
  489. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/activate-payment-addon.md +44 -44
  490. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/activate-plugin-addon.md +44 -44
  491. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/change-storage-driver-status.md +56 -56
  492. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/check-paypal-webhook.md +26 -26
  493. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/create-storage-bucket.md +63 -63
  494. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/disconnect-payment-method.md +55 -55
  495. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/exchange-paypal-seller-auth-token.md +62 -62
  496. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-active-storage-drivers.md +20 -20
  497. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-checkout-fields.md +22 -22
  498. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-email-shortcodes.md +20 -20
  499. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-mcp-config-snippets.md +26 -26
  500. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-mcp-status.md +20 -20
  501. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-module-settings.md +20 -20
  502. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-payment-method-connection-info.md +26 -26
  503. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-payment-method-settings.md +26 -26
  504. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-permissions.md +22 -22
  505. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-plugin-addons.md +20 -20
  506. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-storage-driver-settings.md +27 -27
  507. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-store-settings.md +26 -26
  508. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/install-mcp-adapter.md +21 -21
  509. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/install-payment-addon.md +60 -60
  510. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/install-plugin-addon.md +64 -64
  511. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/list-all-payment-methods.md +20 -20
  512. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/list-all-storage-drivers.md +20 -20
  513. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/list-storage-buckets.md +67 -67
  514. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/reorder-payment-methods.md +55 -55
  515. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/reset-storage-driver-settings.md +45 -45
  516. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-checkout-fields.md +133 -133
  517. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-confirmation-settings.md +68 -68
  518. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-module-settings.md +68 -68
  519. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-payment-method-design.md +67 -67
  520. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-payment-method-settings.md +58 -58
  521. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-permissions.md +68 -68
  522. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-storage-driver-settings.md +62 -62
  523. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-store-settings.md +239 -239
  524. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/setup-paypal-webhook.md +48 -48
  525. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/toggle-mcp.md +40 -40
  526. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/verify-storage-driver-connection.md +62 -62
  527. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/verify-turnstile-keys.md +55 -55
  528. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/create-shipping-class.md +73 -73
  529. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/create-shipping-method.md +110 -110
  530. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/create-shipping-zone.md +56 -56
  531. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/delete-shipping-class.md +29 -29
  532. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/delete-shipping-method.md +29 -29
  533. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/delete-shipping-zone.md +29 -29
  534. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-class-profile.md +30 -30
  535. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-class.md +29 -29
  536. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-packages.md +22 -22
  537. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-zone.md +27 -27
  538. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-zone-countries.md +22 -22
  539. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-zone-states.md +28 -28
  540. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/list-shipping-classes.md +31 -31
  541. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/list-shipping-zones.md +31 -31
  542. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/save-shipping-packages.md +112 -112
  543. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-shipping-class.md +79 -79
  544. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-shipping-method.md +113 -113
  545. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-shipping-zone.md +62 -62
  546. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-zone-order.md +52 -52
  547. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/cancel-auto-renew.md +30 -30
  548. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/cancel-subscription.md +52 -52
  549. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/confirm-subscription-switch.md +70 -70
  550. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/fetch-subscription-remote.md +28 -28
  551. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/generate-early-payment-link.md +29 -29
  552. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-customer-subscription.md +27 -27
  553. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-or-create-plan.md +69 -69
  554. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-setup-intent-attempts.md +30 -30
  555. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-subscription.md +28 -28
  556. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/initiate-early-payment.md +31 -31
  557. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/list-customer-subscriptions.md +27 -27
  558. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/list-subscriptions.md +39 -39
  559. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/pause-subscription.md +28 -28
  560. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/reactivate-subscription.md +28 -28
  561. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/resume-subscription.md +28 -28
  562. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/switch-payment-method.md +70 -70
  563. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/update-payment-method.md +69 -69
  564. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/update-vendor-ids.md +56 -56
  565. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/verify-vendor-ids.md +56 -56
  566. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/create-tax-class.md +51 -51
  567. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/create-tax-rate.md +117 -117
  568. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-product-override.md +27 -27
  569. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-shipping-tax-override.md +27 -27
  570. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-tax-class.md +28 -28
  571. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-tax-rate.md +27 -27
  572. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-country-tax-id.md +27 -27
  573. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-country-tax-rates.md +28 -28
  574. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-eu-vat-product-overrides.md +20 -20
  575. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-oss-country-rates.md +20 -20
  576. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-preconfigured-tax-rates.md +20 -20
  577. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-product-overrides.md +27 -27
  578. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-tax-settings.md +20 -20
  579. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/list-all-tax-rates.md +20 -20
  580. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/list-tax-classes.md +20 -20
  581. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/list-tax-records.md +37 -37
  582. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/mark-taxes-as-filed.md +58 -58
  583. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/reset-eu-vat-rates.md +21 -21
  584. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-configured-countries.md +57 -57
  585. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-country-tax-id.md +50 -50
  586. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-eu-vat-cross-border-settings.md +127 -127
  587. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-oss-country-rates.md +100 -100
  588. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-product-override.md +110 -110
  589. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-shipping-tax-override.md +52 -52
  590. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-tax-settings.md +166 -166
  591. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/update-country-status.md +54 -54
  592. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/update-tax-rate.md +116 -116
  593. package/dist/skills/fluentcart-developer/references/restapi/order-bumps.md +433 -433
  594. package/dist/skills/fluentcart-developer/references/restapi/orders.md +1212 -1212
  595. package/dist/skills/fluentcart-developer/references/restapi/pdf-templates.md +212 -212
  596. package/dist/skills/fluentcart-developer/references/restapi/products.md +2485 -2485
  597. package/dist/skills/fluentcart-developer/references/restapi/public-shop.md +191 -191
  598. package/dist/skills/fluentcart-developer/references/restapi/reports.md +3773 -3773
  599. package/dist/skills/fluentcart-developer/references/restapi/roles.md +403 -403
  600. package/dist/skills/fluentcart-developer/references/restapi/saved-views.md +136 -136
  601. package/dist/skills/fluentcart-developer/references/restapi/settings.md +1423 -1423
  602. package/dist/skills/fluentcart-developer/references/restapi/shipping.md +905 -905
  603. package/dist/skills/fluentcart-developer/references/restapi/subscriptions.md +1169 -1169
  604. package/dist/skills/fluentcart-developer/references/restapi/tax.md +1551 -1551
  605. package/dist/skills/fluentcart-developer/references/restapi.md +127 -127
  606. package/dist/skills/fluentcart-developer/scripts/cli.js +1 -1
  607. package/dist/version.d.ts +1 -1
  608. package/dist/version.js +1 -1
  609. package/package.json +66 -65
@@ -1,846 +1,846 @@
1
- # Email Notifications API
2
-
3
- Configure email notification templates, manage scheduling reminders, preview templates, and update notification settings.
4
-
5
- **Base URL:** `https://your-site.com/wp-json/fluent-cart/v2/email-notification`
6
-
7
- **Policy:** `StoreSensitivePolicy` — Requires `store/sensitive` capability.
8
-
9
- ---
10
-
11
- ## List All Notifications
12
-
13
- GET `/fluent-cart/v2/email-notification`
14
-
15
- Retrieve all registered email notification templates with their current configuration. Returns both default and customized notification settings for orders, subscriptions, and scheduler/reminder actions.
16
-
17
- ### Parameters
18
-
19
- No parameters required.
20
-
21
- ### Response
22
-
23
- ```
24
- {
25
- "data": {
26
- "order_paid_admin": {
27
- "event": "order_paid_done",
28
- "group": "order",
29
- "group_label": "Order Actions",
30
- "title": "Send mail to admin after New Order Paid",
31
- "description": "This email will be sent to the admin after an order is placed.",
32
- "recipient": "admin",
33
- "smartcode_groups": [],
34
- "template_path": "order.paid.admin",
35
- "is_async": false,
36
- "pre_header": "You got a new order on your shop...",
37
- "name": "order_paid_admin",
38
- "settings": {
39
- "active": "yes",
40
- "subject": "New Sales On {{settings.store_name}}",
41
- "is_default_body": "yes",
42
- "email_body": ""
43
- }
44
- },
45
- "order_paid_customer": {
46
- "event": "order_paid",
47
- "group": "order",
48
- "group_label": "Order Actions",
49
- "title": "Purchase receipt to customer",
50
- "description": "This email will be sent to the customer after an order is placed.",
51
- "recipient": "customer",
52
- "smartcode_groups": [],
53
- "template_path": "order.paid.customer",
54
- "is_async": false,
55
- "name": "order_paid_customer",
56
- "settings": {
57
- "active": "yes",
58
- "subject": "Purchase Receipt #{{order.invoice_no}}",
59
- "is_default_body": "yes",
60
- "email_body": ""
61
- }
62
- }
63
- }
64
- }
65
- ```
66
-
67
- ### Available Notifications
68
-
69
- The following notification keys are returned, organized by group:
70
-
71
- **Order Actions (`order` group)**
72
-
73
- | Key | Event | Recipient | Description |
74
- | --- | --- | --- | --- |
75
- | `order_paid_admin` | `order_paid_done` | `admin` | New order paid notification to admin |
76
- | `order_paid_customer` | `order_paid` | `customer` | Purchase receipt to customer |
77
- | `order_refunded_admin` | `order_refunded` | `admin` | Refund notification to admin |
78
- | `order_refunded_customer` | `order_refunded` | `customer` | Refund confirmation to customer |
79
- | `order_shipped_customer` | `shipping_status_changed_to_shipped` | `customer` | Shipping notification to customer |
80
- | `order_delivered_customer` | `shipping_status_changed_to_delivered` | `customer` | Delivery notification to customer |
81
- | `order_placed_admin` | `order_placed_offline` | `admin` | Offline payment order to admin |
82
- | `order_placed_customer` | `order_placed_offline` | `customer` | Offline payment confirmation to customer |
83
-
84
- **Subscription Actions (`subscription` group)**
85
-
86
- | Key | Event | Recipient | Description |
87
- | --- | --- | --- | --- |
88
- | `subscription_renewal_customer` | `subscription_renewed` | `customer` | Renewal confirmation to customer |
89
- | `subscription_renewal_admin` | `subscription_renewed` | `admin` | Renewal notification to admin |
90
- | `subscription_canceled_customer` | `subscription_canceled` | `customer` | Cancellation notice to customer |
91
- | `subscription_canceled_admin` | `subscription_canceled` | `admin` | Cancellation notice to admin |
92
-
93
- **Scheduler / Reminder Actions (`scheduler` group)**
94
-
95
- | Key | Event | Recipient | Description |
96
- | --- | --- | --- | --- |
97
- | `invoice_reminder_overdue_customer` | `invoice_reminder_overdue` | `customer` | Payment reminder to customer |
98
- | `invoice_reminder_overdue_admin` | `invoice_reminder_overdue` | `admin` | Payment reminder copy to admin |
99
- | `subscription_renewal_reminder_customer` | `subscription_renewal_reminder` | `customer` | Upcoming renewal reminder to customer |
100
- | `subscription_renewal_reminder_admin` | `subscription_renewal_reminder` | `admin` | Upcoming renewal reminder copy to admin |
101
- | `subscription_trial_end_reminder_customer` | `subscription_trial_end_reminder` | `customer` | Trial ending soon reminder to customer |
102
- | `subscription_trial_end_reminder_admin` | `subscription_trial_end_reminder` | `admin` | Trial ending soon reminder copy to admin |
103
-
104
- ### Example
105
-
106
- ```
107
- curl -X GET "https://example.com/wp-json/fluent-cart/v2/email-notification" \
108
- -u "username:app_password"
109
- ```
110
-
111
- ---
112
-
113
- ## Get Single Notification
114
-
115
- GET `/fluent-cart/v2/email-notification/{notification}`
116
-
117
- Retrieve a single email notification template by its name, along with available shortcodes for the email editor.
118
-
119
- ### Parameters
120
-
121
- | Parameter | Type | Location | Required | Description |
122
- | --- | --- | --- | --- | --- |
123
- | `notification` | string | path | Yes | The notification key (e.g., `order_paid_customer`, `subscription_renewal_admin`) |
124
-
125
- ### Response
126
-
127
- ```
128
- {
129
- "data": {
130
- "event": "order_paid",
131
- "group": "order",
132
- "group_label": "Order Actions",
133
- "title": "Purchase receipt to customer",
134
- "description": "This email will be sent to the customer after an order is placed.",
135
- "recipient": "customer",
136
- "smartcode_groups": [],
137
- "template_path": "order.paid.customer",
138
- "is_async": false,
139
- "name": "order_paid_customer",
140
- "settings": {
141
- "active": "yes",
142
- "subject": "Purchase Receipt #{{order.invoice_no}}",
143
- "is_default_body": "yes",
144
- "email_body": ""
145
- }
146
- },
147
- "shortcodes": {
148
- "order": {
149
- "title": "Order",
150
- "key": "order",
151
- "shortcodes": {
152
- "{{order.id}}": "Order ID",
153
- "{{order.invoice_no}}": "Order Number",
154
- "{{order.status}}": "Order Status",
155
- "{{order.total_amount_formatted}}": "Order Total Amount (Formatted)"
156
- }
157
- },
158
- "general": {
159
- "title": "General",
160
- "key": "wp",
161
- "shortcodes": {
162
- "{{wp.admin_email}}": "Admin Email",
163
- "{{wp.site_url}}": "Site URL",
164
- "{{wp.site_title}}": "Site Title"
165
- }
166
- },
167
- "customer": {
168
- "title": "Customer",
169
- "key": "customer",
170
- "shortcodes": {
171
- "{{order.billing.first_name}}": "First Name",
172
- "{{order.billing.last_name}}": "Last Name",
173
- "{{order.billing.email}}": "Email"
174
- }
175
- },
176
- "transaction": {
177
- "title": "transaction",
178
- "key": "settings",
179
- "shortcodes": {
180
- "{{transaction.total_formatted}}": "Total Amount (Formatted)",
181
- "{{transaction.payment_method}}": "Payment Method",
182
- "{{transaction.status}}": "Status"
183
- }
184
- },
185
- "settings": {
186
- "title": "Settings",
187
- "key": "settings",
188
- "shortcodes": {
189
- "{{settings.store_name}}": "Store Name",
190
- "{{settings.store_logo}}": "Store Logo"
191
- }
192
- },
193
- "license": {
194
- "title": "License (Loop)",
195
- "key": "license",
196
- "shortcodes": {
197
- "{{license.key}}": "License Key",
198
- "{{license.status}}": "Status"
199
- }
200
- }
201
- }
202
- }
203
- ```
204
-
205
- ### Error Response
206
-
207
- Returned when the notification key is not found:
208
-
209
- ```
210
- {
211
- "message": "Notification Details not found"
212
- }
213
- ```
214
-
215
- ### Example
216
-
217
- ```
218
- curl -X GET "https://example.com/wp-json/fluent-cart/v2/email-notification/order_paid_customer" \
219
- -u "username:app_password"
220
- ```
221
-
222
- ---
223
-
224
- ## Update Notification
225
-
226
- PUT `/fluent-cart/v2/email-notification/{notification}`
227
-
228
- Update an email notification template's settings including subject, body content, and active status.
229
-
230
- ### Parameters
231
-
232
- | Parameter | Type | Location | Required | Description |
233
- | --- | --- | --- | --- | --- |
234
- | `notification` | string | path | Yes | The notification key (e.g., `order_paid_customer`) |
235
- | `settings.subject` | string | body | Yes | Email subject line (max 255 characters). Supports shortcodes like `{{order.invoice_no}}` |
236
- | `settings.email_body` | string | body | No | Custom email body content (HTML). Sanitized with `wp_kses_post` |
237
- | `settings.active` | string | body | No | Enable or disable the notification: `yes` or `no` |
238
- | `settings.is_default_body` | string | body | No | Whether to use the default template body: `yes` or `no`. When set to `yes`, the custom `email_body` is cleared |
239
-
240
- ### Validation Rules
241
-
242
- | Field | Rules |
243
- | --- | --- |
244
- | `settings.subject` | Required, sanitized text, max 255 characters |
245
- | `settings.email_body` | Nullable, string, sanitized with `wp_kses_post` |
246
- | `settings.active` | Nullable, sanitized text |
247
- | `settings.is_default_body` | Nullable, sanitized text |
248
-
249
- ### Response
250
-
251
- ```
252
- {
253
- "message": "Notification updated successfully"
254
- }
255
- ```
256
-
257
- ### Error Response
258
-
259
- ```
260
- {
261
- "message": "Failed to update notification"
262
- }
263
- ```
264
-
265
- ### Example
266
-
267
- ```
268
- curl -X PUT "https://example.com/wp-json/fluent-cart/v2/email-notification/order_paid_customer" \
269
- -u "username:app_password" \
270
- -H "Content-Type: application/json" \
271
- -d '{
272
- "settings": {
273
- "subject": "Your Order #{{order.invoice_no}} is Confirmed!",
274
- "email_body": "<p>Thank you for your purchase, {{order.billing.first_name}}!</p>",
275
- "active": "yes",
276
- "is_default_body": "no"
277
- }
278
- }'
279
- ```
280
-
281
- ---
282
-
283
- ## Enable/Disable Notification
284
-
285
- POST `/fluent-cart/v2/email-notification/enable-notification/{name}`
286
-
287
- Toggle a notification template on or off without modifying other settings.
288
-
289
- ### Parameters
290
-
291
- | Parameter | Type | Location | Required | Description |
292
- | --- | --- | --- | --- | --- |
293
- | `name` | string | path | Yes | The notification key (e.g., `order_paid_admin`) |
294
- | `active` | string | body | Yes | Set to `yes` to enable or `no` to disable the notification |
295
-
296
- ### Response
297
-
298
- ```
299
- {
300
- "message": "Notification updated successfully"
301
- }
302
- ```
303
-
304
- ### Error Response
305
-
306
- ```
307
- {
308
- "message": "Failed to update notification"
309
- }
310
- ```
311
-
312
- ### Example
313
-
314
- ```
315
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/email-notification/enable-notification/order_refunded_admin" \
316
- -u "username:app_password" \
317
- -H "Content-Type: application/json" \
318
- -d '{
319
- "active": "yes"
320
- }'
321
- ```
322
-
323
- ---
324
-
325
- ## Get Shortcodes
326
-
327
- GET `/fluent-cart/v2/email-notification/get-short-codes`
328
-
329
- Retrieve available shortcodes, email template files, and editor buttons for the email notification editor.
330
-
331
- ### Parameters
332
-
333
- No parameters required.
334
-
335
- ### Response
336
-
337
- ```
338
- {
339
- "data": {
340
- "email_templates": [
341
- {
342
- "path": "fluent_cart_order_paid",
343
- "label": "Order Paid"
344
- },
345
- {
346
- "path": "fluent_cart_subscription_renewal",
347
- "label": "Subscription Renewal"
348
- }
349
- ],
350
- "shortcodes": {
351
- "order": {
352
- "title": "Order",
353
- "key": "order",
354
- "shortcodes": {
355
- "{{order.id}}": "Order ID",
356
- "{{order.customer_dashboard_link}}": "Customer Dashboard Link",
357
- "{{order.status}}": "Order Status",
358
- "{{order.invoice_no}}": "Order Number",
359
- "{{order.total_amount_formatted}}": "Order Total Amount (Formatted)",
360
- "{{order.created_at}}": "Order Create Date"
361
- }
362
- },
363
- "general": {
364
- "title": "General",
365
- "key": "wp",
366
- "shortcodes": {
367
- "{{wp.admin_email}}": "Admin Email",
368
- "{{wp.site_url}}": "Site URL",
369
- "{{wp.site_title}}": "Site Title",
370
- "{{user.display_name}}": "User Display Name",
371
- "{{user.user_email}}": "User Email"
372
- }
373
- },
374
- "customer": {
375
- "title": "Customer",
376
- "key": "customer",
377
- "shortcodes": {
378
- "{{order.billing.first_name}}": "First Name",
379
- "{{order.billing.last_name}}": "Last Name",
380
- "{{order.billing.email}}": "Email",
381
- "{{order.billing.city}}": "City",
382
- "{{order.billing.state}}": "State",
383
- "{{order.billing.country}}": "Country"
384
- }
385
- },
386
- "transaction": {
387
- "title": "transaction",
388
- "key": "settings",
389
- "shortcodes": {
390
- "{{transaction.total}}": "Total Amount",
391
- "{{transaction.total_formatted}}": "Total Amount (Formatted)",
392
- "{{transaction.refund_amount}}": "Refund Amount",
393
- "{{transaction.refund_amount_formatted}}": "Refund Amount (Formatted)",
394
- "{{transaction.payment_method}}": "Payment Method",
395
- "{{transaction.card_last_4}}": "Card Last 4",
396
- "{{transaction.card_brand}}": "Card Brand",
397
- "{{transaction.status}}": "Status",
398
- "{{transaction.currency}}": "Currency"
399
- }
400
- },
401
- "settings": {
402
- "title": "Settings",
403
- "key": "settings",
404
- "shortcodes": {
405
- "{{settings.store_name}}": "Store Name",
406
- "{{settings.store_logo}}": "Store Logo",
407
- "{{settings.store_address}}": "Store Address Line 1",
408
- "{{settings.store_address2}}": "Store Address Line 2",
409
- "{{settings.store_country}}": "Store Country",
410
- "{{settings.store_state}}": "Store State",
411
- "{{settings.store_city}}": "Store City",
412
- "{{settings.store_postcode}}": "Store Postcode"
413
- }
414
- },
415
- "license": {
416
- "title": "License (Loop)",
417
- "key": "license",
418
- "shortcodes": {
419
- "{{license.sl}}": "Serial Number",
420
- "{{license.key}}": "License Key",
421
- "{{license.status}}": "Status",
422
- "{{license.product_name}}": "Product Name",
423
- "{{license.variant}}": "Variant",
424
- "{{license.limit}}": "Activation Limit",
425
- "{{license.activation_count}}": "Activation Count",
426
- "{{license.expiration_date}}": "Expiration Date"
427
- }
428
- }
429
- },
430
- "buttons": {
431
- "View Order": "<a href=\"https://example.com/wp-admin/admin.php?page=fluent-cart#/orders/{{order.id}}/view\" style=\"background-color: green; color: #fff; padding: 10px 20px; text-decoration: none; border-radius: 5px;\">View Order</a>"
432
- }
433
- }
434
- }
435
- ```
436
-
437
- ### Example
438
-
439
- ```
440
- curl -X GET "https://example.com/wp-json/fluent-cart/v2/email-notification/get-short-codes" \
441
- -u "username:app_password"
442
- ```
443
-
444
- ---
445
-
446
- ## Get Global Email Settings
447
-
448
- GET `/fluent-cart/v2/email-notification/get-settings`
449
-
450
- Retrieve the global email configuration settings used across all notification emails (sender name, email addresses, footer, etc.).
451
-
452
- ### Parameters
453
-
454
- No parameters required.
455
-
456
- ### Response
457
-
458
- ```
459
- {
460
- "data": {
461
- "from_name": "My Store",
462
- "from_email": "[email&#160;protected]",
463
- "reply_to_name": "",
464
- "reply_to_email": "",
465
- "email_footer": "<p>Thank you for shopping with us!</p>",
466
- "show_email_footer": "yes",
467
- "admin_email": "{{wp.admin_email}}",
468
- "notification_config": {}
469
- },
470
- "shortcodes": [
471
- {
472
- "title": "General",
473
- "key": "wp",
474
- "shortcodes": {
475
- "{{wp.admin_email}}": "Admin Email",
476
- "{{wp.site_url}}": "Site URL",
477
- "{{wp.site_title}}": "Site Title",
478
- "{{user.display_name}}": "User Display Name",
479
- "{{user.user_email}}": "User Email"
480
- }
481
- },
482
- {
483
- "title": "Settings",
484
- "key": "settings",
485
- "shortcodes": {
486
- "{{settings.store_name}}": "Store Name",
487
- "{{settings.store_logo}}": "Store Logo",
488
- "{{settings.store_address}}": "Store Address Line 1"
489
- }
490
- }
491
- ]
492
- }
493
- ```
494
-
495
- ### Example
496
-
497
- ```
498
- curl -X GET "https://example.com/wp-json/fluent-cart/v2/email-notification/get-settings" \
499
- -u "username:app_password"
500
- ```
501
-
502
- ---
503
-
504
- ## Save Global Email Settings
505
-
506
- POST `/fluent-cart/v2/email-notification/save-settings`
507
-
508
- Update the global email configuration settings for all notification emails.
509
-
510
- ### Parameters
511
-
512
- | Parameter | Type | Location | Required | Description |
513
- | --- | --- | --- | --- | --- |
514
- | `from_name` | string | body | Yes | Sender name displayed in emails (max 255 characters) |
515
- | `from_email` | string | body | Yes | Sender email address (must be valid email, max 255 characters) |
516
- | `reply_to_name` | string | body | No | Reply-to name (max 255 characters) |
517
- | `reply_to_email` | string | body | No | Reply-to email address (must be valid email, max 255 characters) |
518
- | `email_footer` | string | body | No | HTML content for the email footer. Sanitized with `wp_kses_post` |
519
- | `admin_email` | string | body | Yes | Admin notification recipient email(s). Supports shortcodes like `{{wp.admin_email}}` |
520
- | `show_email_footer` | string | body | No | Show or hide the email footer: `yes` or `no`. Note: On free plans, this is always forced to `yes` |
521
-
522
- ### Validation Rules
523
-
524
- | Field | Rules |
525
- | --- | --- |
526
- | `from_name` | Required, sanitized text, max 255 characters |
527
- | `from_email` | Required, valid email, max 255 characters |
528
- | `reply_to_name` | Nullable, sanitized text, max 255 characters |
529
- | `reply_to_email` | Nullable, valid email, max 255 characters |
530
- | `email_footer` | Nullable, string, sanitized with `wp_kses_post` |
531
- | `admin_email` | Required, string |
532
- | `show_email_footer` | Nullable, string |
533
-
534
- ### Response
535
-
536
- ```
537
- {
538
- "message": "Email settings saved successfully"
539
- }
540
- ```
541
-
542
- ### Error Response
543
-
544
- ```
545
- {
546
- "message": "Failed to save email settings"
547
- }
548
- ```
549
-
550
- ### Example
551
-
552
- ```
553
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/email-notification/save-settings" \
554
- -u "username:app_password" \
555
- -H "Content-Type: application/json" \
556
- -d '{
557
- "from_name": "My Store",
558
- "from_email": "[email&#160;protected]",
559
- "reply_to_name": "Support",
560
- "reply_to_email": "[email&#160;protected]",
561
- "email_footer": "<p>Thank you for shopping with us!</p>",
562
- "admin_email": "[email&#160;protected]",
563
- "show_email_footer": "yes"
564
- }'
565
- ```
566
-
567
- ---
568
-
569
- ## Get Scheduling Settings
570
-
571
- GET `/fluent-cart/v2/email-notification/reminders`
572
-
573
- Retrieve reminder/scheduling settings for automated email notifications such as payment reminders, renewal reminders, and trial-end reminders. Returns both the current settings and the form field definitions for the reminders tab.
574
-
575
- ### Parameters
576
-
577
- No parameters required.
578
-
579
- ### Response
580
-
581
- ```
582
- {
583
- "settings": {
584
- "reminders_enabled": "yes",
585
- "invoice_reminders_enabled": "yes",
586
- "invoice_reminder_due_days": 3,
587
- "invoice_reminder_overdue_days": "1,3,7",
588
- "yearly_renewal_reminders_enabled": "yes",
589
- "yearly_renewal_reminder_days": 30,
590
- "trial_end_reminders_enabled": "yes",
591
- "trial_end_reminder_days": 3,
592
- "monthly_renewal_reminders_enabled": "no",
593
- "monthly_renewal_reminder_days": 7,
594
- "quarterly_renewal_reminders_enabled": "no",
595
- "quarterly_renewal_reminder_days": 14,
596
- "half_yearly_renewal_reminders_enabled": "no",
597
- "half_yearly_renewal_reminder_days": 14
598
- },
599
- "fields": {
600
- "reminders": { }
601
- }
602
- }
603
- ```
604
-
605
- ### Example
606
-
607
- ```
608
- curl -X GET "https://example.com/wp-json/fluent-cart/v2/email-notification/reminders" \
609
- -u "username:app_password"
610
- ```
611
-
612
- ---
613
-
614
- ## Save Scheduling Settings
615
-
616
- POST `/fluent-cart/v2/email-notification/reminders`
617
-
618
- Update reminder/scheduling settings for automated email notifications. Each reminder type has an enable toggle and a days configuration that controls how many days before the event the reminder is sent.
619
-
620
- ### Parameters
621
-
622
- | Parameter | Type | Location | Required | Description |
623
- | --- | --- | --- | --- | --- |
624
- | `reminders_enabled` | string | body | No | Master toggle for all reminders: `yes` or `no` |
625
- | `invoice_reminders_enabled` | string | body | No | Enable invoice payment reminders: `yes` or `no` |
626
- | `invoice_reminder_due_days` | integer | body | No | Days before due date to send invoice reminder (0-365). Required when `invoice_reminders_enabled` is `yes` |
627
- | `invoice_reminder_overdue_days` | string | body | No | Comma-separated day intervals for overdue reminders (e.g., `1,3,7`) |
628
- | `yearly_renewal_reminders_enabled` | string | body | No | Enable yearly subscription renewal reminders: `yes` or `no` |
629
- | `yearly_renewal_reminder_days` | integer | body | No | Days before renewal to send reminder (7-90). Required when `yearly_renewal_reminders_enabled` is `yes` |
630
- | `trial_end_reminders_enabled` | string | body | No | Enable trial ending reminders: `yes` or `no` |
631
- | `trial_end_reminder_days` | integer | body | No | Days before trial ends to send reminder (1-14). Required when `trial_end_reminders_enabled` is `yes` |
632
- | `monthly_renewal_reminders_enabled` | string | body | No | Enable monthly renewal reminders: `yes` or `no` |
633
- | `monthly_renewal_reminder_days` | integer | body | No | Days before renewal to send reminder (3-28). Required when `monthly_renewal_reminders_enabled` is `yes` |
634
- | `quarterly_renewal_reminders_enabled` | string | body | No | Enable quarterly renewal reminders: `yes` or `no` |
635
- | `quarterly_renewal_reminder_days` | integer | body | No | Days before renewal to send reminder (7-60). Required when `quarterly_renewal_reminders_enabled` is `yes` |
636
- | `half_yearly_renewal_reminders_enabled` | string | body | No | Enable half-yearly renewal reminders: `yes` or `no` |
637
- | `half_yearly_renewal_reminder_days` | integer | body | No | Days before renewal to send reminder (7-60). Required when `half_yearly_renewal_reminders_enabled` is `yes` |
638
-
639
- ### Validation Rules
640
-
641
- Validation for the days fields is conditional -- rules are only enforced when the corresponding toggle is set to `yes`:
642
-
643
- | Toggle Field | Days Field | Rules (when enabled) |
644
- | --- | --- | --- |
645
- | `invoice_reminders_enabled` | `invoice_reminder_due_days` | Integer, min: 0, max: 365 |
646
- | `yearly_renewal_reminders_enabled` | `yearly_renewal_reminder_days` | Integer, min: 7, max: 90 |
647
- | `trial_end_reminders_enabled` | `trial_end_reminder_days` | Integer, min: 1, max: 14 |
648
- | `monthly_renewal_reminders_enabled` | `monthly_renewal_reminder_days` | Integer, min: 3, max: 28 |
649
- | `quarterly_renewal_reminders_enabled` | `quarterly_renewal_reminder_days` | Integer, min: 7, max: 60 |
650
- | `half_yearly_renewal_reminders_enabled` | `half_yearly_renewal_reminder_days` | Integer, min: 7, max: 60 |
651
-
652
- ### Response
653
-
654
- ```
655
- {
656
- "data": { },
657
- "message": "Scheduling settings saved successfully"
658
- }
659
- ```
660
-
661
- ### Error Response
662
-
663
- ```
664
- {
665
- "message": "Failed to save scheduling settings"
666
- }
667
- ```
668
-
669
- ### Example
670
-
671
- ```
672
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/email-notification/reminders" \
673
- -u "username:app_password" \
674
- -H "Content-Type: application/json" \
675
- -d '{
676
- "reminders_enabled": "yes",
677
- "invoice_reminders_enabled": "yes",
678
- "invoice_reminder_due_days": 3,
679
- "invoice_reminder_overdue_days": "1,3,7",
680
- "yearly_renewal_reminders_enabled": "yes",
681
- "yearly_renewal_reminder_days": 30,
682
- "trial_end_reminders_enabled": "yes",
683
- "trial_end_reminder_days": 3,
684
- "monthly_renewal_reminders_enabled": "no",
685
- "monthly_renewal_reminder_days": 7,
686
- "quarterly_renewal_reminders_enabled": "no",
687
- "quarterly_renewal_reminder_days": 14,
688
- "half_yearly_renewal_reminders_enabled": "no",
689
- "half_yearly_renewal_reminder_days": 14
690
- }'
691
- ```
692
-
693
- ---
694
-
695
- ## Preview Notification
696
-
697
- POST `/fluent-cart/v2/email-notification/preview`
698
-
699
- Generate an HTML preview of a custom email notification template. Uses the block editor email body from the notification's saved settings, parses it through the block parser, wraps it in the email template layout, and resolves shortcodes using real or fallback order data.
700
-
701
- ### Parameters
702
-
703
- | Parameter | Type | Location | Required | Description |
704
- | --- | --- | --- | --- | --- |
705
- | `notification_name` | string | body | Yes | The notification key to preview (e.g., `order_paid_customer`) |
706
- | `order_id` | integer | body | No | Specific order ID to use for shortcode data. If not provided or not found, the most recent order is used |
707
-
708
- ### Response
709
-
710
- ```
711
- {
712
- "html": "<!DOCTYPE html><html>...rendered email HTML...</html>"
713
- }
714
- ```
715
-
716
- The `html` field contains the fully rendered email including:
717
-
718
- - The parsed block editor content
719
- - Email header and footer
720
- - Resolved shortcodes (order data, customer info, store settings)
721
-
722
- ### Error Response
723
-
724
- When no notification name is provided:
725
-
726
- ```
727
- {
728
- "message": "No notification name provided."
729
- }
730
- ```
731
-
732
- When the notification key is not found:
733
-
734
- ```
735
- {
736
- "message": "Notification not found."
737
- }
738
- ```
739
-
740
- ### Example
741
-
742
- ```
743
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/email-notification/preview" \
744
- -u "username:app_password" \
745
- -H "Content-Type: application/json" \
746
- -d '{
747
- "notification_name": "order_paid_customer",
748
- "order_id": 42
749
- }'
750
- ```
751
-
752
- ---
753
-
754
- ## Preview Default Template
755
-
756
- POST `/fluent-cart/v2/email-notification/preview-default-template`
757
-
758
- Generate an HTML preview of a default (built-in) email template. Unlike the custom block editor preview, this renders the PHP-based default template using dummy preview data, wrapped in the standard email layout with header and footer.
759
-
760
- ### Parameters
761
-
762
- | Parameter | Type | Location | Required | Description |
763
- | --- | --- | --- | --- | --- |
764
- | `template` | string | body | Yes | The template path name to preview (e.g., `order.paid.customer`, `subscription.renewal.admin`). Corresponds to the `template_path` value from the notification configuration |
765
-
766
- ### Available Template Paths
767
-
768
- | Template Path | Description |
769
- | --- | --- |
770
- | `order.paid.admin` | Admin notification for paid order |
771
- | `order.paid.customer` | Customer receipt for paid order |
772
- | `order.refunded.admin` | Admin notification for refund |
773
- | `order.refunded.customer` | Customer refund confirmation |
774
- | `order.shipped.customer` | Customer shipping notification |
775
- | `order.delivered.customer` | Customer delivery notification |
776
- | `order.placed.admin` | Admin notification for offline payment order |
777
- | `order.placed.customer` | Customer confirmation for offline payment order |
778
- | `order.reminder.overdue.customer` | Customer payment reminder |
779
- | `order.reminder.overdue.admin` | Admin copy of payment reminder |
780
- | `subscription.renewal.customer` | Customer renewal confirmation |
781
- | `subscription.renewal.admin` | Admin renewal notification |
782
- | `subscription.canceled.customer` | Customer cancellation notice |
783
- | `subscription.canceled.admin` | Admin cancellation notice |
784
- | `subscription.reminder.customer` | Customer renewal reminder |
785
- | `subscription.reminder.admin` | Admin copy of renewal reminder |
786
- | `subscription.trial_end.customer` | Customer trial ending reminder |
787
- | `subscription.trial_end.admin` | Admin copy of trial ending reminder |
788
-
789
- ### Response
790
-
791
- ```
792
- {
793
- "data": {
794
- "content": "<!DOCTYPE html><html>...rendered email HTML...</html>"
795
- }
796
- }
797
- ```
798
-
799
- The `content` field contains the fully rendered email HTML with:
800
-
801
- - The default PHP template rendered with dummy preview data
802
- - Email header and footer
803
- - Resolved shortcodes
804
- - All links and buttons disabled (not clickable) via injected CSS
805
-
806
- ### Example
807
-
808
- ```
809
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/email-notification/preview-default-template" \
810
- -u "username:app_password" \
811
- -H "Content-Type: application/json" \
812
- -d '{
813
- "template": "order.paid.customer"
814
- }'
815
- ```
816
-
817
- ---
818
-
819
- ## Notification Object Reference
820
-
821
- Each notification object contains the following properties:
822
-
823
- | Property | Type | Description |
824
- | --- | --- | --- |
825
- | `name` | string | Unique notification key identifier |
826
- | `event` | string | The event hook that triggers this notification |
827
- | `group` | string | Grouping category: `order`, `subscription`, or `scheduler` |
828
- | `group_label` | string | Human-readable group label |
829
- | `title` | string | Descriptive title of the notification |
830
- | `description` | string | Explanation of when this notification is sent |
831
- | `recipient` | string | Target recipient: `admin` or `customer` |
832
- | `smartcode_groups` | array | Additional shortcode groups (extensible via filters) |
833
- | `template_path` | string | Dot-notation path to the default PHP email template |
834
- | `is_async` | boolean | Whether the email is sent asynchronously |
835
- | `pre_header` | string | Email pre-header text (admin notifications only) |
836
- | `manage_toggle` | string | If set to `no`, the notification cannot be toggled off (e.g., offline payment confirmations) |
837
- | `settings` | object | Notification settings (see below) |
838
-
839
- ### Notification Settings Object
840
-
841
- | Property | Type | Description |
842
- | --- | --- | --- |
843
- | `active` | string | Whether the notification is enabled: `yes` or `no` |
844
- | `subject` | string | Email subject line. Supports shortcodes |
845
- | `is_default_body` | string | Whether to use the built-in PHP template: `yes` or `no` |
846
- | `email_body` | string | Custom email body content (HTML). Empty when using default body |
1
+ # Email Notifications API
2
+
3
+ Configure email notification templates, manage scheduling reminders, preview templates, and update notification settings.
4
+
5
+ **Base URL:** `https://your-site.com/wp-json/fluent-cart/v2/email-notification`
6
+
7
+ **Policy:** `StoreSensitivePolicy` — Requires `store/sensitive` capability.
8
+
9
+ ---
10
+
11
+ ## List All Notifications
12
+
13
+ GET `/fluent-cart/v2/email-notification`
14
+
15
+ Retrieve all registered email notification templates with their current configuration. Returns both default and customized notification settings for orders, subscriptions, and scheduler/reminder actions.
16
+
17
+ ### Parameters
18
+
19
+ No parameters required.
20
+
21
+ ### Response
22
+
23
+ ```
24
+ {
25
+ "data": {
26
+ "order_paid_admin": {
27
+ "event": "order_paid_done",
28
+ "group": "order",
29
+ "group_label": "Order Actions",
30
+ "title": "Send mail to admin after New Order Paid",
31
+ "description": "This email will be sent to the admin after an order is placed.",
32
+ "recipient": "admin",
33
+ "smartcode_groups": [],
34
+ "template_path": "order.paid.admin",
35
+ "is_async": false,
36
+ "pre_header": "You got a new order on your shop...",
37
+ "name": "order_paid_admin",
38
+ "settings": {
39
+ "active": "yes",
40
+ "subject": "New Sales On {{settings.store_name}}",
41
+ "is_default_body": "yes",
42
+ "email_body": ""
43
+ }
44
+ },
45
+ "order_paid_customer": {
46
+ "event": "order_paid",
47
+ "group": "order",
48
+ "group_label": "Order Actions",
49
+ "title": "Purchase receipt to customer",
50
+ "description": "This email will be sent to the customer after an order is placed.",
51
+ "recipient": "customer",
52
+ "smartcode_groups": [],
53
+ "template_path": "order.paid.customer",
54
+ "is_async": false,
55
+ "name": "order_paid_customer",
56
+ "settings": {
57
+ "active": "yes",
58
+ "subject": "Purchase Receipt #{{order.invoice_no}}",
59
+ "is_default_body": "yes",
60
+ "email_body": ""
61
+ }
62
+ }
63
+ }
64
+ }
65
+ ```
66
+
67
+ ### Available Notifications
68
+
69
+ The following notification keys are returned, organized by group:
70
+
71
+ **Order Actions (`order` group)**
72
+
73
+ | Key | Event | Recipient | Description |
74
+ | --- | --- | --- | --- |
75
+ | `order_paid_admin` | `order_paid_done` | `admin` | New order paid notification to admin |
76
+ | `order_paid_customer` | `order_paid` | `customer` | Purchase receipt to customer |
77
+ | `order_refunded_admin` | `order_refunded` | `admin` | Refund notification to admin |
78
+ | `order_refunded_customer` | `order_refunded` | `customer` | Refund confirmation to customer |
79
+ | `order_shipped_customer` | `shipping_status_changed_to_shipped` | `customer` | Shipping notification to customer |
80
+ | `order_delivered_customer` | `shipping_status_changed_to_delivered` | `customer` | Delivery notification to customer |
81
+ | `order_placed_admin` | `order_placed_offline` | `admin` | Offline payment order to admin |
82
+ | `order_placed_customer` | `order_placed_offline` | `customer` | Offline payment confirmation to customer |
83
+
84
+ **Subscription Actions (`subscription` group)**
85
+
86
+ | Key | Event | Recipient | Description |
87
+ | --- | --- | --- | --- |
88
+ | `subscription_renewal_customer` | `subscription_renewed` | `customer` | Renewal confirmation to customer |
89
+ | `subscription_renewal_admin` | `subscription_renewed` | `admin` | Renewal notification to admin |
90
+ | `subscription_canceled_customer` | `subscription_canceled` | `customer` | Cancellation notice to customer |
91
+ | `subscription_canceled_admin` | `subscription_canceled` | `admin` | Cancellation notice to admin |
92
+
93
+ **Scheduler / Reminder Actions (`scheduler` group)**
94
+
95
+ | Key | Event | Recipient | Description |
96
+ | --- | --- | --- | --- |
97
+ | `invoice_reminder_overdue_customer` | `invoice_reminder_overdue` | `customer` | Payment reminder to customer |
98
+ | `invoice_reminder_overdue_admin` | `invoice_reminder_overdue` | `admin` | Payment reminder copy to admin |
99
+ | `subscription_renewal_reminder_customer` | `subscription_renewal_reminder` | `customer` | Upcoming renewal reminder to customer |
100
+ | `subscription_renewal_reminder_admin` | `subscription_renewal_reminder` | `admin` | Upcoming renewal reminder copy to admin |
101
+ | `subscription_trial_end_reminder_customer` | `subscription_trial_end_reminder` | `customer` | Trial ending soon reminder to customer |
102
+ | `subscription_trial_end_reminder_admin` | `subscription_trial_end_reminder` | `admin` | Trial ending soon reminder copy to admin |
103
+
104
+ ### Example
105
+
106
+ ```
107
+ curl -X GET "https://example.com/wp-json/fluent-cart/v2/email-notification" \
108
+ -u "username:app_password"
109
+ ```
110
+
111
+ ---
112
+
113
+ ## Get Single Notification
114
+
115
+ GET `/fluent-cart/v2/email-notification/{notification}`
116
+
117
+ Retrieve a single email notification template by its name, along with available shortcodes for the email editor.
118
+
119
+ ### Parameters
120
+
121
+ | Parameter | Type | Location | Required | Description |
122
+ | --- | --- | --- | --- | --- |
123
+ | `notification` | string | path | Yes | The notification key (e.g., `order_paid_customer`, `subscription_renewal_admin`) |
124
+
125
+ ### Response
126
+
127
+ ```
128
+ {
129
+ "data": {
130
+ "event": "order_paid",
131
+ "group": "order",
132
+ "group_label": "Order Actions",
133
+ "title": "Purchase receipt to customer",
134
+ "description": "This email will be sent to the customer after an order is placed.",
135
+ "recipient": "customer",
136
+ "smartcode_groups": [],
137
+ "template_path": "order.paid.customer",
138
+ "is_async": false,
139
+ "name": "order_paid_customer",
140
+ "settings": {
141
+ "active": "yes",
142
+ "subject": "Purchase Receipt #{{order.invoice_no}}",
143
+ "is_default_body": "yes",
144
+ "email_body": ""
145
+ }
146
+ },
147
+ "shortcodes": {
148
+ "order": {
149
+ "title": "Order",
150
+ "key": "order",
151
+ "shortcodes": {
152
+ "{{order.id}}": "Order ID",
153
+ "{{order.invoice_no}}": "Order Number",
154
+ "{{order.status}}": "Order Status",
155
+ "{{order.total_amount_formatted}}": "Order Total Amount (Formatted)"
156
+ }
157
+ },
158
+ "general": {
159
+ "title": "General",
160
+ "key": "wp",
161
+ "shortcodes": {
162
+ "{{wp.admin_email}}": "Admin Email",
163
+ "{{wp.site_url}}": "Site URL",
164
+ "{{wp.site_title}}": "Site Title"
165
+ }
166
+ },
167
+ "customer": {
168
+ "title": "Customer",
169
+ "key": "customer",
170
+ "shortcodes": {
171
+ "{{order.billing.first_name}}": "First Name",
172
+ "{{order.billing.last_name}}": "Last Name",
173
+ "{{order.billing.email}}": "Email"
174
+ }
175
+ },
176
+ "transaction": {
177
+ "title": "transaction",
178
+ "key": "settings",
179
+ "shortcodes": {
180
+ "{{transaction.total_formatted}}": "Total Amount (Formatted)",
181
+ "{{transaction.payment_method}}": "Payment Method",
182
+ "{{transaction.status}}": "Status"
183
+ }
184
+ },
185
+ "settings": {
186
+ "title": "Settings",
187
+ "key": "settings",
188
+ "shortcodes": {
189
+ "{{settings.store_name}}": "Store Name",
190
+ "{{settings.store_logo}}": "Store Logo"
191
+ }
192
+ },
193
+ "license": {
194
+ "title": "License (Loop)",
195
+ "key": "license",
196
+ "shortcodes": {
197
+ "{{license.key}}": "License Key",
198
+ "{{license.status}}": "Status"
199
+ }
200
+ }
201
+ }
202
+ }
203
+ ```
204
+
205
+ ### Error Response
206
+
207
+ Returned when the notification key is not found:
208
+
209
+ ```
210
+ {
211
+ "message": "Notification Details not found"
212
+ }
213
+ ```
214
+
215
+ ### Example
216
+
217
+ ```
218
+ curl -X GET "https://example.com/wp-json/fluent-cart/v2/email-notification/order_paid_customer" \
219
+ -u "username:app_password"
220
+ ```
221
+
222
+ ---
223
+
224
+ ## Update Notification
225
+
226
+ PUT `/fluent-cart/v2/email-notification/{notification}`
227
+
228
+ Update an email notification template's settings including subject, body content, and active status.
229
+
230
+ ### Parameters
231
+
232
+ | Parameter | Type | Location | Required | Description |
233
+ | --- | --- | --- | --- | --- |
234
+ | `notification` | string | path | Yes | The notification key (e.g., `order_paid_customer`) |
235
+ | `settings.subject` | string | body | Yes | Email subject line (max 255 characters). Supports shortcodes like `{{order.invoice_no}}` |
236
+ | `settings.email_body` | string | body | No | Custom email body content (HTML). Sanitized with `wp_kses_post` |
237
+ | `settings.active` | string | body | No | Enable or disable the notification: `yes` or `no` |
238
+ | `settings.is_default_body` | string | body | No | Whether to use the default template body: `yes` or `no`. When set to `yes`, the custom `email_body` is cleared |
239
+
240
+ ### Validation Rules
241
+
242
+ | Field | Rules |
243
+ | --- | --- |
244
+ | `settings.subject` | Required, sanitized text, max 255 characters |
245
+ | `settings.email_body` | Nullable, string, sanitized with `wp_kses_post` |
246
+ | `settings.active` | Nullable, sanitized text |
247
+ | `settings.is_default_body` | Nullable, sanitized text |
248
+
249
+ ### Response
250
+
251
+ ```
252
+ {
253
+ "message": "Notification updated successfully"
254
+ }
255
+ ```
256
+
257
+ ### Error Response
258
+
259
+ ```
260
+ {
261
+ "message": "Failed to update notification"
262
+ }
263
+ ```
264
+
265
+ ### Example
266
+
267
+ ```
268
+ curl -X PUT "https://example.com/wp-json/fluent-cart/v2/email-notification/order_paid_customer" \
269
+ -u "username:app_password" \
270
+ -H "Content-Type: application/json" \
271
+ -d '{
272
+ "settings": {
273
+ "subject": "Your Order #{{order.invoice_no}} is Confirmed!",
274
+ "email_body": "<p>Thank you for your purchase, {{order.billing.first_name}}!</p>",
275
+ "active": "yes",
276
+ "is_default_body": "no"
277
+ }
278
+ }'
279
+ ```
280
+
281
+ ---
282
+
283
+ ## Enable/Disable Notification
284
+
285
+ POST `/fluent-cart/v2/email-notification/enable-notification/{name}`
286
+
287
+ Toggle a notification template on or off without modifying other settings.
288
+
289
+ ### Parameters
290
+
291
+ | Parameter | Type | Location | Required | Description |
292
+ | --- | --- | --- | --- | --- |
293
+ | `name` | string | path | Yes | The notification key (e.g., `order_paid_admin`) |
294
+ | `active` | string | body | Yes | Set to `yes` to enable or `no` to disable the notification |
295
+
296
+ ### Response
297
+
298
+ ```
299
+ {
300
+ "message": "Notification updated successfully"
301
+ }
302
+ ```
303
+
304
+ ### Error Response
305
+
306
+ ```
307
+ {
308
+ "message": "Failed to update notification"
309
+ }
310
+ ```
311
+
312
+ ### Example
313
+
314
+ ```
315
+ curl -X POST "https://example.com/wp-json/fluent-cart/v2/email-notification/enable-notification/order_refunded_admin" \
316
+ -u "username:app_password" \
317
+ -H "Content-Type: application/json" \
318
+ -d '{
319
+ "active": "yes"
320
+ }'
321
+ ```
322
+
323
+ ---
324
+
325
+ ## Get Shortcodes
326
+
327
+ GET `/fluent-cart/v2/email-notification/get-short-codes`
328
+
329
+ Retrieve available shortcodes, email template files, and editor buttons for the email notification editor.
330
+
331
+ ### Parameters
332
+
333
+ No parameters required.
334
+
335
+ ### Response
336
+
337
+ ```
338
+ {
339
+ "data": {
340
+ "email_templates": [
341
+ {
342
+ "path": "fluent_cart_order_paid",
343
+ "label": "Order Paid"
344
+ },
345
+ {
346
+ "path": "fluent_cart_subscription_renewal",
347
+ "label": "Subscription Renewal"
348
+ }
349
+ ],
350
+ "shortcodes": {
351
+ "order": {
352
+ "title": "Order",
353
+ "key": "order",
354
+ "shortcodes": {
355
+ "{{order.id}}": "Order ID",
356
+ "{{order.customer_dashboard_link}}": "Customer Dashboard Link",
357
+ "{{order.status}}": "Order Status",
358
+ "{{order.invoice_no}}": "Order Number",
359
+ "{{order.total_amount_formatted}}": "Order Total Amount (Formatted)",
360
+ "{{order.created_at}}": "Order Create Date"
361
+ }
362
+ },
363
+ "general": {
364
+ "title": "General",
365
+ "key": "wp",
366
+ "shortcodes": {
367
+ "{{wp.admin_email}}": "Admin Email",
368
+ "{{wp.site_url}}": "Site URL",
369
+ "{{wp.site_title}}": "Site Title",
370
+ "{{user.display_name}}": "User Display Name",
371
+ "{{user.user_email}}": "User Email"
372
+ }
373
+ },
374
+ "customer": {
375
+ "title": "Customer",
376
+ "key": "customer",
377
+ "shortcodes": {
378
+ "{{order.billing.first_name}}": "First Name",
379
+ "{{order.billing.last_name}}": "Last Name",
380
+ "{{order.billing.email}}": "Email",
381
+ "{{order.billing.city}}": "City",
382
+ "{{order.billing.state}}": "State",
383
+ "{{order.billing.country}}": "Country"
384
+ }
385
+ },
386
+ "transaction": {
387
+ "title": "transaction",
388
+ "key": "settings",
389
+ "shortcodes": {
390
+ "{{transaction.total}}": "Total Amount",
391
+ "{{transaction.total_formatted}}": "Total Amount (Formatted)",
392
+ "{{transaction.refund_amount}}": "Refund Amount",
393
+ "{{transaction.refund_amount_formatted}}": "Refund Amount (Formatted)",
394
+ "{{transaction.payment_method}}": "Payment Method",
395
+ "{{transaction.card_last_4}}": "Card Last 4",
396
+ "{{transaction.card_brand}}": "Card Brand",
397
+ "{{transaction.status}}": "Status",
398
+ "{{transaction.currency}}": "Currency"
399
+ }
400
+ },
401
+ "settings": {
402
+ "title": "Settings",
403
+ "key": "settings",
404
+ "shortcodes": {
405
+ "{{settings.store_name}}": "Store Name",
406
+ "{{settings.store_logo}}": "Store Logo",
407
+ "{{settings.store_address}}": "Store Address Line 1",
408
+ "{{settings.store_address2}}": "Store Address Line 2",
409
+ "{{settings.store_country}}": "Store Country",
410
+ "{{settings.store_state}}": "Store State",
411
+ "{{settings.store_city}}": "Store City",
412
+ "{{settings.store_postcode}}": "Store Postcode"
413
+ }
414
+ },
415
+ "license": {
416
+ "title": "License (Loop)",
417
+ "key": "license",
418
+ "shortcodes": {
419
+ "{{license.sl}}": "Serial Number",
420
+ "{{license.key}}": "License Key",
421
+ "{{license.status}}": "Status",
422
+ "{{license.product_name}}": "Product Name",
423
+ "{{license.variant}}": "Variant",
424
+ "{{license.limit}}": "Activation Limit",
425
+ "{{license.activation_count}}": "Activation Count",
426
+ "{{license.expiration_date}}": "Expiration Date"
427
+ }
428
+ }
429
+ },
430
+ "buttons": {
431
+ "View Order": "<a href=\"https://example.com/wp-admin/admin.php?page=fluent-cart#/orders/{{order.id}}/view\" style=\"background-color: green; color: #fff; padding: 10px 20px; text-decoration: none; border-radius: 5px;\">View Order</a>"
432
+ }
433
+ }
434
+ }
435
+ ```
436
+
437
+ ### Example
438
+
439
+ ```
440
+ curl -X GET "https://example.com/wp-json/fluent-cart/v2/email-notification/get-short-codes" \
441
+ -u "username:app_password"
442
+ ```
443
+
444
+ ---
445
+
446
+ ## Get Global Email Settings
447
+
448
+ GET `/fluent-cart/v2/email-notification/get-settings`
449
+
450
+ Retrieve the global email configuration settings used across all notification emails (sender name, email addresses, footer, etc.).
451
+
452
+ ### Parameters
453
+
454
+ No parameters required.
455
+
456
+ ### Response
457
+
458
+ ```
459
+ {
460
+ "data": {
461
+ "from_name": "My Store",
462
+ "from_email": "[email&#160;protected]",
463
+ "reply_to_name": "",
464
+ "reply_to_email": "",
465
+ "email_footer": "<p>Thank you for shopping with us!</p>",
466
+ "show_email_footer": "yes",
467
+ "admin_email": "{{wp.admin_email}}",
468
+ "notification_config": {}
469
+ },
470
+ "shortcodes": [
471
+ {
472
+ "title": "General",
473
+ "key": "wp",
474
+ "shortcodes": {
475
+ "{{wp.admin_email}}": "Admin Email",
476
+ "{{wp.site_url}}": "Site URL",
477
+ "{{wp.site_title}}": "Site Title",
478
+ "{{user.display_name}}": "User Display Name",
479
+ "{{user.user_email}}": "User Email"
480
+ }
481
+ },
482
+ {
483
+ "title": "Settings",
484
+ "key": "settings",
485
+ "shortcodes": {
486
+ "{{settings.store_name}}": "Store Name",
487
+ "{{settings.store_logo}}": "Store Logo",
488
+ "{{settings.store_address}}": "Store Address Line 1"
489
+ }
490
+ }
491
+ ]
492
+ }
493
+ ```
494
+
495
+ ### Example
496
+
497
+ ```
498
+ curl -X GET "https://example.com/wp-json/fluent-cart/v2/email-notification/get-settings" \
499
+ -u "username:app_password"
500
+ ```
501
+
502
+ ---
503
+
504
+ ## Save Global Email Settings
505
+
506
+ POST `/fluent-cart/v2/email-notification/save-settings`
507
+
508
+ Update the global email configuration settings for all notification emails.
509
+
510
+ ### Parameters
511
+
512
+ | Parameter | Type | Location | Required | Description |
513
+ | --- | --- | --- | --- | --- |
514
+ | `from_name` | string | body | Yes | Sender name displayed in emails (max 255 characters) |
515
+ | `from_email` | string | body | Yes | Sender email address (must be valid email, max 255 characters) |
516
+ | `reply_to_name` | string | body | No | Reply-to name (max 255 characters) |
517
+ | `reply_to_email` | string | body | No | Reply-to email address (must be valid email, max 255 characters) |
518
+ | `email_footer` | string | body | No | HTML content for the email footer. Sanitized with `wp_kses_post` |
519
+ | `admin_email` | string | body | Yes | Admin notification recipient email(s). Supports shortcodes like `{{wp.admin_email}}` |
520
+ | `show_email_footer` | string | body | No | Show or hide the email footer: `yes` or `no`. Note: On free plans, this is always forced to `yes` |
521
+
522
+ ### Validation Rules
523
+
524
+ | Field | Rules |
525
+ | --- | --- |
526
+ | `from_name` | Required, sanitized text, max 255 characters |
527
+ | `from_email` | Required, valid email, max 255 characters |
528
+ | `reply_to_name` | Nullable, sanitized text, max 255 characters |
529
+ | `reply_to_email` | Nullable, valid email, max 255 characters |
530
+ | `email_footer` | Nullable, string, sanitized with `wp_kses_post` |
531
+ | `admin_email` | Required, string |
532
+ | `show_email_footer` | Nullable, string |
533
+
534
+ ### Response
535
+
536
+ ```
537
+ {
538
+ "message": "Email settings saved successfully"
539
+ }
540
+ ```
541
+
542
+ ### Error Response
543
+
544
+ ```
545
+ {
546
+ "message": "Failed to save email settings"
547
+ }
548
+ ```
549
+
550
+ ### Example
551
+
552
+ ```
553
+ curl -X POST "https://example.com/wp-json/fluent-cart/v2/email-notification/save-settings" \
554
+ -u "username:app_password" \
555
+ -H "Content-Type: application/json" \
556
+ -d '{
557
+ "from_name": "My Store",
558
+ "from_email": "[email&#160;protected]",
559
+ "reply_to_name": "Support",
560
+ "reply_to_email": "[email&#160;protected]",
561
+ "email_footer": "<p>Thank you for shopping with us!</p>",
562
+ "admin_email": "[email&#160;protected]",
563
+ "show_email_footer": "yes"
564
+ }'
565
+ ```
566
+
567
+ ---
568
+
569
+ ## Get Scheduling Settings
570
+
571
+ GET `/fluent-cart/v2/email-notification/reminders`
572
+
573
+ Retrieve reminder/scheduling settings for automated email notifications such as payment reminders, renewal reminders, and trial-end reminders. Returns both the current settings and the form field definitions for the reminders tab.
574
+
575
+ ### Parameters
576
+
577
+ No parameters required.
578
+
579
+ ### Response
580
+
581
+ ```
582
+ {
583
+ "settings": {
584
+ "reminders_enabled": "yes",
585
+ "invoice_reminders_enabled": "yes",
586
+ "invoice_reminder_due_days": 3,
587
+ "invoice_reminder_overdue_days": "1,3,7",
588
+ "yearly_renewal_reminders_enabled": "yes",
589
+ "yearly_renewal_reminder_days": 30,
590
+ "trial_end_reminders_enabled": "yes",
591
+ "trial_end_reminder_days": 3,
592
+ "monthly_renewal_reminders_enabled": "no",
593
+ "monthly_renewal_reminder_days": 7,
594
+ "quarterly_renewal_reminders_enabled": "no",
595
+ "quarterly_renewal_reminder_days": 14,
596
+ "half_yearly_renewal_reminders_enabled": "no",
597
+ "half_yearly_renewal_reminder_days": 14
598
+ },
599
+ "fields": {
600
+ "reminders": { }
601
+ }
602
+ }
603
+ ```
604
+
605
+ ### Example
606
+
607
+ ```
608
+ curl -X GET "https://example.com/wp-json/fluent-cart/v2/email-notification/reminders" \
609
+ -u "username:app_password"
610
+ ```
611
+
612
+ ---
613
+
614
+ ## Save Scheduling Settings
615
+
616
+ POST `/fluent-cart/v2/email-notification/reminders`
617
+
618
+ Update reminder/scheduling settings for automated email notifications. Each reminder type has an enable toggle and a days configuration that controls how many days before the event the reminder is sent.
619
+
620
+ ### Parameters
621
+
622
+ | Parameter | Type | Location | Required | Description |
623
+ | --- | --- | --- | --- | --- |
624
+ | `reminders_enabled` | string | body | No | Master toggle for all reminders: `yes` or `no` |
625
+ | `invoice_reminders_enabled` | string | body | No | Enable invoice payment reminders: `yes` or `no` |
626
+ | `invoice_reminder_due_days` | integer | body | No | Days before due date to send invoice reminder (0-365). Required when `invoice_reminders_enabled` is `yes` |
627
+ | `invoice_reminder_overdue_days` | string | body | No | Comma-separated day intervals for overdue reminders (e.g., `1,3,7`) |
628
+ | `yearly_renewal_reminders_enabled` | string | body | No | Enable yearly subscription renewal reminders: `yes` or `no` |
629
+ | `yearly_renewal_reminder_days` | integer | body | No | Days before renewal to send reminder (7-90). Required when `yearly_renewal_reminders_enabled` is `yes` |
630
+ | `trial_end_reminders_enabled` | string | body | No | Enable trial ending reminders: `yes` or `no` |
631
+ | `trial_end_reminder_days` | integer | body | No | Days before trial ends to send reminder (1-14). Required when `trial_end_reminders_enabled` is `yes` |
632
+ | `monthly_renewal_reminders_enabled` | string | body | No | Enable monthly renewal reminders: `yes` or `no` |
633
+ | `monthly_renewal_reminder_days` | integer | body | No | Days before renewal to send reminder (3-28). Required when `monthly_renewal_reminders_enabled` is `yes` |
634
+ | `quarterly_renewal_reminders_enabled` | string | body | No | Enable quarterly renewal reminders: `yes` or `no` |
635
+ | `quarterly_renewal_reminder_days` | integer | body | No | Days before renewal to send reminder (7-60). Required when `quarterly_renewal_reminders_enabled` is `yes` |
636
+ | `half_yearly_renewal_reminders_enabled` | string | body | No | Enable half-yearly renewal reminders: `yes` or `no` |
637
+ | `half_yearly_renewal_reminder_days` | integer | body | No | Days before renewal to send reminder (7-60). Required when `half_yearly_renewal_reminders_enabled` is `yes` |
638
+
639
+ ### Validation Rules
640
+
641
+ Validation for the days fields is conditional -- rules are only enforced when the corresponding toggle is set to `yes`:
642
+
643
+ | Toggle Field | Days Field | Rules (when enabled) |
644
+ | --- | --- | --- |
645
+ | `invoice_reminders_enabled` | `invoice_reminder_due_days` | Integer, min: 0, max: 365 |
646
+ | `yearly_renewal_reminders_enabled` | `yearly_renewal_reminder_days` | Integer, min: 7, max: 90 |
647
+ | `trial_end_reminders_enabled` | `trial_end_reminder_days` | Integer, min: 1, max: 14 |
648
+ | `monthly_renewal_reminders_enabled` | `monthly_renewal_reminder_days` | Integer, min: 3, max: 28 |
649
+ | `quarterly_renewal_reminders_enabled` | `quarterly_renewal_reminder_days` | Integer, min: 7, max: 60 |
650
+ | `half_yearly_renewal_reminders_enabled` | `half_yearly_renewal_reminder_days` | Integer, min: 7, max: 60 |
651
+
652
+ ### Response
653
+
654
+ ```
655
+ {
656
+ "data": { },
657
+ "message": "Scheduling settings saved successfully"
658
+ }
659
+ ```
660
+
661
+ ### Error Response
662
+
663
+ ```
664
+ {
665
+ "message": "Failed to save scheduling settings"
666
+ }
667
+ ```
668
+
669
+ ### Example
670
+
671
+ ```
672
+ curl -X POST "https://example.com/wp-json/fluent-cart/v2/email-notification/reminders" \
673
+ -u "username:app_password" \
674
+ -H "Content-Type: application/json" \
675
+ -d '{
676
+ "reminders_enabled": "yes",
677
+ "invoice_reminders_enabled": "yes",
678
+ "invoice_reminder_due_days": 3,
679
+ "invoice_reminder_overdue_days": "1,3,7",
680
+ "yearly_renewal_reminders_enabled": "yes",
681
+ "yearly_renewal_reminder_days": 30,
682
+ "trial_end_reminders_enabled": "yes",
683
+ "trial_end_reminder_days": 3,
684
+ "monthly_renewal_reminders_enabled": "no",
685
+ "monthly_renewal_reminder_days": 7,
686
+ "quarterly_renewal_reminders_enabled": "no",
687
+ "quarterly_renewal_reminder_days": 14,
688
+ "half_yearly_renewal_reminders_enabled": "no",
689
+ "half_yearly_renewal_reminder_days": 14
690
+ }'
691
+ ```
692
+
693
+ ---
694
+
695
+ ## Preview Notification
696
+
697
+ POST `/fluent-cart/v2/email-notification/preview`
698
+
699
+ Generate an HTML preview of a custom email notification template. Uses the block editor email body from the notification's saved settings, parses it through the block parser, wraps it in the email template layout, and resolves shortcodes using real or fallback order data.
700
+
701
+ ### Parameters
702
+
703
+ | Parameter | Type | Location | Required | Description |
704
+ | --- | --- | --- | --- | --- |
705
+ | `notification_name` | string | body | Yes | The notification key to preview (e.g., `order_paid_customer`) |
706
+ | `order_id` | integer | body | No | Specific order ID to use for shortcode data. If not provided or not found, the most recent order is used |
707
+
708
+ ### Response
709
+
710
+ ```
711
+ {
712
+ "html": "<!DOCTYPE html><html>...rendered email HTML...</html>"
713
+ }
714
+ ```
715
+
716
+ The `html` field contains the fully rendered email including:
717
+
718
+ - The parsed block editor content
719
+ - Email header and footer
720
+ - Resolved shortcodes (order data, customer info, store settings)
721
+
722
+ ### Error Response
723
+
724
+ When no notification name is provided:
725
+
726
+ ```
727
+ {
728
+ "message": "No notification name provided."
729
+ }
730
+ ```
731
+
732
+ When the notification key is not found:
733
+
734
+ ```
735
+ {
736
+ "message": "Notification not found."
737
+ }
738
+ ```
739
+
740
+ ### Example
741
+
742
+ ```
743
+ curl -X POST "https://example.com/wp-json/fluent-cart/v2/email-notification/preview" \
744
+ -u "username:app_password" \
745
+ -H "Content-Type: application/json" \
746
+ -d '{
747
+ "notification_name": "order_paid_customer",
748
+ "order_id": 42
749
+ }'
750
+ ```
751
+
752
+ ---
753
+
754
+ ## Preview Default Template
755
+
756
+ POST `/fluent-cart/v2/email-notification/preview-default-template`
757
+
758
+ Generate an HTML preview of a default (built-in) email template. Unlike the custom block editor preview, this renders the PHP-based default template using dummy preview data, wrapped in the standard email layout with header and footer.
759
+
760
+ ### Parameters
761
+
762
+ | Parameter | Type | Location | Required | Description |
763
+ | --- | --- | --- | --- | --- |
764
+ | `template` | string | body | Yes | The template path name to preview (e.g., `order.paid.customer`, `subscription.renewal.admin`). Corresponds to the `template_path` value from the notification configuration |
765
+
766
+ ### Available Template Paths
767
+
768
+ | Template Path | Description |
769
+ | --- | --- |
770
+ | `order.paid.admin` | Admin notification for paid order |
771
+ | `order.paid.customer` | Customer receipt for paid order |
772
+ | `order.refunded.admin` | Admin notification for refund |
773
+ | `order.refunded.customer` | Customer refund confirmation |
774
+ | `order.shipped.customer` | Customer shipping notification |
775
+ | `order.delivered.customer` | Customer delivery notification |
776
+ | `order.placed.admin` | Admin notification for offline payment order |
777
+ | `order.placed.customer` | Customer confirmation for offline payment order |
778
+ | `order.reminder.overdue.customer` | Customer payment reminder |
779
+ | `order.reminder.overdue.admin` | Admin copy of payment reminder |
780
+ | `subscription.renewal.customer` | Customer renewal confirmation |
781
+ | `subscription.renewal.admin` | Admin renewal notification |
782
+ | `subscription.canceled.customer` | Customer cancellation notice |
783
+ | `subscription.canceled.admin` | Admin cancellation notice |
784
+ | `subscription.reminder.customer` | Customer renewal reminder |
785
+ | `subscription.reminder.admin` | Admin copy of renewal reminder |
786
+ | `subscription.trial_end.customer` | Customer trial ending reminder |
787
+ | `subscription.trial_end.admin` | Admin copy of trial ending reminder |
788
+
789
+ ### Response
790
+
791
+ ```
792
+ {
793
+ "data": {
794
+ "content": "<!DOCTYPE html><html>...rendered email HTML...</html>"
795
+ }
796
+ }
797
+ ```
798
+
799
+ The `content` field contains the fully rendered email HTML with:
800
+
801
+ - The default PHP template rendered with dummy preview data
802
+ - Email header and footer
803
+ - Resolved shortcodes
804
+ - All links and buttons disabled (not clickable) via injected CSS
805
+
806
+ ### Example
807
+
808
+ ```
809
+ curl -X POST "https://example.com/wp-json/fluent-cart/v2/email-notification/preview-default-template" \
810
+ -u "username:app_password" \
811
+ -H "Content-Type: application/json" \
812
+ -d '{
813
+ "template": "order.paid.customer"
814
+ }'
815
+ ```
816
+
817
+ ---
818
+
819
+ ## Notification Object Reference
820
+
821
+ Each notification object contains the following properties:
822
+
823
+ | Property | Type | Description |
824
+ | --- | --- | --- |
825
+ | `name` | string | Unique notification key identifier |
826
+ | `event` | string | The event hook that triggers this notification |
827
+ | `group` | string | Grouping category: `order`, `subscription`, or `scheduler` |
828
+ | `group_label` | string | Human-readable group label |
829
+ | `title` | string | Descriptive title of the notification |
830
+ | `description` | string | Explanation of when this notification is sent |
831
+ | `recipient` | string | Target recipient: `admin` or `customer` |
832
+ | `smartcode_groups` | array | Additional shortcode groups (extensible via filters) |
833
+ | `template_path` | string | Dot-notation path to the default PHP email template |
834
+ | `is_async` | boolean | Whether the email is sent asynchronously |
835
+ | `pre_header` | string | Email pre-header text (admin notifications only) |
836
+ | `manage_toggle` | string | If set to `no`, the notification cannot be toggled off (e.g., offline payment confirmations) |
837
+ | `settings` | object | Notification settings (see below) |
838
+
839
+ ### Notification Settings Object
840
+
841
+ | Property | Type | Description |
842
+ | --- | --- | --- |
843
+ | `active` | string | Whether the notification is enabled: `yes` or `no` |
844
+ | `subject` | string | Email subject line. Supports shortcodes |
845
+ | `is_default_body` | string | Whether to use the built-in PHP template: `yes` or `no` |
846
+ | `email_body` | string | Custom email body content (HTML). Empty when using default body |