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,757 +1,757 @@
1
- # Orders
2
-
3
- All hooks related to order lifecycle, status transitions, payments, shipping, refunds, and order items. These action hooks allow you to respond to key order events in FluentCart.
4
-
5
- Each hook passes an associative array as its single parameter. The `order` value is always an [`\FluentCart\App\Models\Order`](/database/models/order.md) model instance with the [`customer`](/database/models/customer.md), `shipping_address`, and `billing_address` relationships eager-loaded (unless noted otherwise).
6
-
7
- > **Amounts are in cents.** All monetary values (`total`, `refunded_amount`, etc.) are stored as integers in the smallest currency unit. Use `Helper::toDecimal($amount)` to convert for display.
8
-
9
- ---
10
-
11
- ## Order Status Changes
12
-
13
- Fired when the **order status** field changes (e.g. `processing` → `completed`). Both a dynamic, status-specific hook and a generic hook fire on every change.
14
-
15
- ### ` order_status_changed_to_{status} `
16
-
17
- `fluent_cart/order_status_changed_to_{$newStatus}` — Fires when the order status changes to a specific status
18
-
19
- **When it runs:** Fires inside `OrderStatusUpdated::afterDispatch()` whenever the order status type transitions to a new value. The `{$newStatus}` portion is replaced dynamically with the target status, so you can listen for a single status you care about.
20
-
21
- **Available dynamic variants:** `completed`, `canceled`, `processing`, `on-hold`, `failed`
22
-
23
- **Parameters:**
24
-
25
- - `$data` (array): Order status change data
26
-
27
- ```
28
- $data = [
29
- 'order' => $order, // \FluentCart\App\Models\Order (with customer, addresses loaded)
30
- 'old_status' => 'processing', // Previous order status string
31
- 'new_status' => 'completed', // New order status string (matches the dynamic suffix)
32
- 'manageStock' => true, // Whether stock management should be applied
33
- 'activity' => [ // Optional activity log context
34
- 'title' => '',
35
- 'content' => '',
36
- ],
37
- ];
38
- ```
39
-
40
- **Source:** `app/Events/Order/OrderStatusUpdated.php` (line 91)
41
-
42
- **Usage:**
43
-
44
- ```
45
- add_action('fluent_cart/order_status_changed_to_completed', function ($data) {
46
- $order = $data['order'];
47
- // Grant digital access when order completes
48
- grant_digital_access($order->customer_id, $order->id);
49
- }, 10, 1);
50
- ```
51
-
52
- ### ` order_status_changed `
53
-
54
- `fluent_cart/order_status_changed` — Fires on any order status change
55
-
56
- **When it runs:** Fires immediately after the dynamic `order_status_changed_to_{$newStatus}` hook, on every order status transition regardless of the target status. Use this when you need to react to all status changes in a single callback.
57
-
58
- **Parameters:**
59
-
60
- - `$data` (array): Order status change data
61
-
62
- ```
63
- $data = [
64
- 'order' => $order, // \FluentCart\App\Models\Order
65
- 'old_status' => 'processing', // Previous order status
66
- 'new_status' => 'completed', // New order status
67
- 'manageStock' => true, // Whether stock management applies
68
- 'activity' => [
69
- 'title' => '',
70
- 'content' => '',
71
- ],
72
- ];
73
- ```
74
-
75
- **Source:** `app/Events/Order/OrderStatusUpdated.php` (line 92)
76
-
77
- **Usage:**
78
-
79
- ```
80
- add_action('fluent_cart/order_status_changed', function ($data) {
81
- $order = $data['order'];
82
- // Log every status transition
83
- fluent_cart_add_log(
84
- 'Order status changed',
85
- sprintf('Order #%d: %s -> %s', $order->id, $data['old_status'], $data['new_status']),
86
- 'info'
87
- );
88
- }, 10, 1);
89
- ```
90
-
91
- ---
92
-
93
- ## Payment Status Changes
94
-
95
- Fired when the **payment status** field changes (e.g. `pending` → `paid`). Both a dynamic, status-specific hook and a generic hook fire on every change.
96
-
97
- ### ` payment_status_changed_to_{status} `
98
-
99
- `fluent_cart/payment_status_changed_to_{$newStatus}` — Fires when payment status changes to a specific status
100
-
101
- **When it runs:** Fires inside `OrderStatusUpdated::afterDispatch()` when the status change type is `payment_status`. The `{$newStatus}` suffix is replaced dynamically so you can target a single payment state.
102
-
103
- **Available dynamic variants:** `pending`, `paid`, `partially_paid`, `failed`, `refunded`, `partially_refunded`, `authorized`
104
-
105
- **Parameters:**
106
-
107
- - `$data` (array): Payment status change data
108
-
109
- ```
110
- $data = [
111
- 'order' => $order, // \FluentCart\App\Models\Order
112
- 'old_status' => 'pending', // Previous payment status
113
- 'new_status' => 'paid', // New payment status (matches the dynamic suffix)
114
- 'manageStock' => true, // Whether stock management applies
115
- 'activity' => [
116
- 'title' => '',
117
- 'content' => '',
118
- ],
119
- ];
120
- ```
121
-
122
- **Source:** `app/Events/Order/OrderStatusUpdated.php` (line 81)
123
-
124
- **Usage:**
125
-
126
- ```
127
- add_action('fluent_cart/payment_status_changed_to_paid', function ($data) {
128
- $order = $data['order'];
129
- // Trigger fulfillment workflow when payment is confirmed
130
- do_action('my_custom_fulfillment_start', $order->id);
131
- }, 10, 1);
132
- ```
133
-
134
- ### ` payment_status_changed `
135
-
136
- `fluent_cart/payment_status_changed` — Fires on any payment status change
137
-
138
- **When it runs:** Fires immediately after the dynamic `payment_status_changed_to_{$newStatus}` hook, on every payment status transition. Use this when you need a single callback for all payment status changes.
139
-
140
- **Parameters:**
141
-
142
- - `$data` (array): Payment status change data
143
-
144
- ```
145
- $data = [
146
- 'order' => $order, // \FluentCart\App\Models\Order
147
- 'old_status' => 'pending', // Previous payment status
148
- 'new_status' => 'paid', // New payment status
149
- 'manageStock' => true, // Whether stock management applies
150
- 'activity' => [
151
- 'title' => '',
152
- 'content' => '',
153
- ],
154
- ];
155
- ```
156
-
157
- **Source:** `app/Events/Order/OrderStatusUpdated.php` (line 82)
158
-
159
- **Usage:**
160
-
161
- ```
162
- add_action('fluent_cart/payment_status_changed', function ($data) {
163
- $order = $data['order'];
164
- // Send payment status update notification
165
- if ($data['new_status'] === 'paid') {
166
- wp_mail($order->customer->email, 'Payment Confirmed', 'Your payment has been received.');
167
- }
168
- }, 10, 1);
169
- ```
170
-
171
- ---
172
-
173
- ## Shipping Status Changes
174
-
175
- Fired when the **shipping status** field changes (e.g. `unshipped` → `shipped`). Both a dynamic, status-specific hook and a generic hook fire on every change.
176
-
177
- ### ` shipping_status_changed_to_{status} `
178
-
179
- `fluent_cart/shipping_status_changed_to_{$newStatus}` — Fires when shipping status changes to a specific status
180
-
181
- **When it runs:** Fires inside `OrderStatusUpdated::afterDispatch()` when the status change type is `shipping_status`. The `{$newStatus}` suffix is replaced dynamically so you can target a single shipping state.
182
-
183
- **Available dynamic variants:** `unshipped`, `shipped`, `delivered`, `unshippable`
184
-
185
- **Parameters:**
186
-
187
- - `$data` (array): Shipping status change data
188
-
189
- ```
190
- $data = [
191
- 'order' => $order, // \FluentCart\App\Models\Order
192
- 'old_status' => 'unshipped', // Previous shipping status
193
- 'new_status' => 'shipped', // New shipping status (matches the dynamic suffix)
194
- 'manageStock' => true, // Whether stock management applies
195
- 'activity' => [
196
- 'title' => '',
197
- 'content' => '',
198
- ],
199
- ];
200
- ```
201
-
202
- **Source:** `app/Events/Order/OrderStatusUpdated.php` (line 86)
203
-
204
- **Usage:**
205
-
206
- ```
207
- add_action('fluent_cart/shipping_status_changed_to_shipped', function ($data) {
208
- $order = $data['order'];
209
- // Notify customer that their order has shipped
210
- wp_mail(
211
- $order->customer->email,
212
- 'Your Order Has Shipped!',
213
- sprintf('Order #%d has been shipped.', $order->id)
214
- );
215
- }, 10, 1);
216
- ```
217
-
218
- ### ` shipping_status_changed `
219
-
220
- `fluent_cart/shipping_status_changed` — Fires on any shipping status change
221
-
222
- **When it runs:** Fires immediately after the dynamic `shipping_status_changed_to_{$newStatus}` hook, on every shipping status transition. Use this when you need a single callback for all shipping status changes.
223
-
224
- **Parameters:**
225
-
226
- - `$data` (array): Shipping status change data
227
-
228
- ```
229
- $data = [
230
- 'order' => $order, // \FluentCart\App\Models\Order
231
- 'old_status' => 'unshipped', // Previous shipping status
232
- 'new_status' => 'shipped', // New shipping status
233
- 'manageStock' => true, // Whether stock management applies
234
- 'activity' => [
235
- 'title' => '',
236
- 'content' => '',
237
- ],
238
- ];
239
- ```
240
-
241
- **Source:** `app/Events/Order/OrderStatusUpdated.php` (line 87)
242
-
243
- **Usage:**
244
-
245
- ```
246
- add_action('fluent_cart/shipping_status_changed', function ($data) {
247
- $order = $data['order'];
248
- // Log all shipping status transitions
249
- fluent_cart_add_log(
250
- 'Shipping status changed',
251
- sprintf('Order #%d: %s -> %s', $order->id, $data['old_status'], $data['new_status']),
252
- 'info'
253
- );
254
- }, 10, 1);
255
- ```
256
-
257
- ---
258
-
259
- ## Refunds
260
-
261
- Fired during the refund flow after transaction records have been created. The generic `order_refunded` hook fires on every refund, followed by either `order_fully_refunded` or `order_partially_refunded` depending on the refund type. Refund data includes the [Order](/database/models/order.md), [OrderItem](/database/models/order-item.md), [OrderTransaction](/database/models/order-transaction.md), and [Customer](/database/models/customer.md) models.
262
-
263
- ### ` order_refunded `
264
-
265
- `fluent_cart/order_refunded` — Fires after any refund (full or partial)
266
-
267
- **When it runs:** Fires inside `OrderRefund::afterDispatch()` after a refund transaction is recorded and the refund amount is calculated. This hook fires for both full and partial refunds. It fires before the type-specific hooks below.
268
-
269
- **Parameters:**
270
-
271
- - `$data` (array): Refund data
272
-
273
- ```
274
- $data = [
275
- 'order' => $order, // \FluentCart\App\Models\Order
276
- 'refunded_items' => [], // Array of OrderItem models (looked up from refundedItemIds)
277
- 'new_refunded_items' => [], // Raw refunded items array with restore_quantity info
278
- 'refunded_amount' => 5000, // Newly refunded amount in cents
279
- 'manage_stock' => true, // Whether stock should be restored
280
- 'transaction' => $transaction, // \FluentCart\App\Models\OrderTransaction (the refund transaction)
281
- 'customer' => $customer, // \FluentCart\App\Models\Customer
282
- 'type' => 'full', // 'full' or 'partial'
283
- ];
284
- ```
285
-
286
- **Source:** `app/Events/Order/OrderRefund.php` (line 141)
287
-
288
- **Usage:**
289
-
290
- ```
291
- add_action('fluent_cart/order_refunded', function ($data) {
292
- $order = $data['order'];
293
- $amount = \FluentCart\App\Helpers\Helper::toDecimal($data['refunded_amount']);
294
- // Notify admin of any refund
295
- wp_mail(
296
- get_option('admin_email'),
297
- sprintf('Refund on Order #%d', $order->id),
298
- sprintf('A %s refund of %s has been processed.', $data['type'], $amount)
299
- );
300
- }, 10, 1);
301
- ```
302
-
303
- ### ` order_fully_refunded `
304
-
305
- `fluent_cart/order_fully_refunded` — Fires only when an order is fully refunded
306
-
307
- **When it runs:** Fires inside `OrderRefund::afterDispatch()` immediately after the generic `order_refunded` hook, but only when the total refunded amount meets or exceeds the order's total paid amount (i.e. full refund).
308
-
309
- **Parameters:**
310
-
311
- - `$data` (array): Full refund data (identical structure to `order_refunded`)
312
-
313
- ```
314
- $data = [
315
- 'order' => $order, // \FluentCart\App\Models\Order
316
- 'refunded_items' => [], // Array of OrderItem models
317
- 'new_refunded_items' => [], // Raw refunded items with restore_quantity
318
- 'refunded_amount' => 10000, // Refunded amount in cents
319
- 'manage_stock' => true, // Whether stock should be restored
320
- 'transaction' => $transaction, // \FluentCart\App\Models\OrderTransaction
321
- 'customer' => $customer, // \FluentCart\App\Models\Customer
322
- 'type' => 'full', // Always 'full' for this hook
323
- ];
324
- ```
325
-
326
- **Source:** `app/Events/Order/OrderRefund.php` (line 144)
327
-
328
- **Usage:**
329
-
330
- ```
331
- add_action('fluent_cart/order_fully_refunded', function ($data) {
332
- $order = $data['order'];
333
- // Revoke digital access on full refund
334
- update_user_meta($order->customer_id, 'membership_active', false);
335
- }, 10, 1);
336
- ```
337
-
338
- ### ` order_partially_refunded `
339
-
340
- `fluent_cart/order_partially_refunded` — Fires only when an order is partially refunded
341
-
342
- **When it runs:** Fires inside `OrderRefund::afterDispatch()` immediately after the generic `order_refunded` hook, but only when the total refunded amount is less than the order's total paid amount (i.e. partial refund).
343
-
344
- **Parameters:**
345
-
346
- - `$data` (array): Partial refund data (identical structure to `order_refunded`)
347
-
348
- ```
349
- $data = [
350
- 'order' => $order, // \FluentCart\App\Models\Order
351
- 'refunded_items' => [], // Array of OrderItem models
352
- 'new_refunded_items' => [], // Raw refunded items with restore_quantity
353
- 'refunded_amount' => 3000, // Refunded amount in cents
354
- 'manage_stock' => true, // Whether stock should be restored
355
- 'transaction' => $transaction, // \FluentCart\App\Models\OrderTransaction
356
- 'customer' => $customer, // \FluentCart\App\Models\Customer
357
- 'type' => 'partial', // Always 'partial' for this hook
358
- ];
359
- ```
360
-
361
- **Source:** `app/Events/Order/OrderRefund.php` (line 146)
362
-
363
- **Usage:**
364
-
365
- ```
366
- add_action('fluent_cart/order_partially_refunded', function ($data) {
367
- $order = $data['order'];
368
- $customer = $data['customer'];
369
- // Notify customer of partial refund
370
- wp_mail(
371
- $customer->email,
372
- 'Partial Refund Processed',
373
- sprintf('A partial refund has been issued for Order #%d.', $order->id)
374
- );
375
- }, 10, 1);
376
- ```
377
-
378
- ---
379
-
380
- ## Order Items
381
-
382
- Hooks that fire when custom line items on an order are being deleted. These are useful for cleanup or audit logging on custom [OrderItem](/database/models/order-item.md) records.
383
-
384
- ### ` order/before_custom_items_deleted `
385
-
386
- `fluent_cart/order/before_custom_items_deleted` — Fires before custom line items are deleted
387
-
388
- **When it runs:** Fires inside `OrderResource::updateOrderItems()` just before custom order items (flagged as `is_custom`) are permanently deleted from the database. Only fires if the filtered collection of custom items is not empty.
389
-
390
- **Parameters:**
391
-
392
- - `$customItems` (\Illuminate\Support\Collection): Collection of [`\FluentCart\App\Models\OrderItem`](/database/models/order-item.md) models about to be deleted (only items where `is_custom` is true)
393
- - `$order` ([`\FluentCart\App\Models\Order`](/database/models/order.md)): The parent order model
394
-
395
- **Source:** `api/Resource/OrderResource.php` (line 1624)
396
-
397
- **Usage:**
398
-
399
- ```
400
- add_action('fluent_cart/order/before_custom_items_deleted', function ($customItems, $order) {
401
- // Archive custom items before they are removed
402
- foreach ($customItems as $item) {
403
- fluent_cart_add_log(
404
- 'Custom item removed',
405
- sprintf('Item "%s" removed from Order #%d', $item->title, $order->id),
406
- 'info'
407
- );
408
- }
409
- }, 10, 2);
410
- ```
411
-
412
- ### ` order/after_custom_items_deleted `
413
-
414
- `fluent_cart/order/after_custom_items_deleted` — Fires after custom line items are deleted
415
-
416
- **When it runs:** Fires inside `OrderResource::updateOrderItems()` immediately after custom order items have been permanently deleted from the database. The collection still holds the model instances (now removed from DB). Only fires if the collection is not empty.
417
-
418
- **Parameters:**
419
-
420
- - `$customItems` (\Illuminate\Support\Collection): Collection of [`\FluentCart\App\Models\OrderItem`](/database/models/order-item.md) models that were just deleted
421
- - `$order` ([`\FluentCart\App\Models\Order`](/database/models/order.md)): The parent order model
422
-
423
- **Source:** `api/Resource/OrderResource.php` (line 1630)
424
-
425
- **Usage:**
426
-
427
- ```
428
- add_action('fluent_cart/order/after_custom_items_deleted', function ($customItems, $order) {
429
- // Recalculate order totals after custom items removed
430
- $order->recalculateTotals();
431
- }, 10, 2);
432
- ```
433
-
434
- ---
435
-
436
- ## Order Lifecycle
437
-
438
- General lifecycle hooks that fire at key moments during an [Order](/database/models/order.md)'s existence: invoice generation, [Customer](/database/models/customer.md) changes, payment completion, license generation, and receipt viewing.
439
-
440
- ### ` order/invoice_number_added `
441
-
442
- `fluent_cart/order/invoice_number_added` — Fires after an invoice/receipt number is assigned to an order
443
-
444
- **When it runs:** Fires in two places:
445
-
446
- 1. Inside the `Order::booted()` `created` callback, immediately after a new order is persisted to the database with an invoice number already set (when payment status is `paid` at creation time).
447
- 2. Inside `Order::generateReceiptNumber()`, when a receipt number is generated for an existing order that did not previously have one.
448
-
449
- **Parameters:**
450
-
451
- - `$data` (array): Order data
452
-
453
- ```
454
- $data = [
455
- 'order' => $order, // \FluentCart\App\Models\Order
456
- ];
457
- ```
458
-
459
- **Source:** `app/Models/Order.php` (lines 60 and 734)
460
-
461
- **Usage:**
462
-
463
- ```
464
- add_action('fluent_cart/order/invoice_number_added', function ($data) {
465
- $order = $data['order'];
466
- // Sync invoice number to external accounting system
467
- sync_to_accounting($order->id, $order->invoice_no, $order->receipt_number);
468
- }, 10, 1);
469
- ```
470
-
471
- ### ` order_customer_changed `
472
-
473
- `fluent_cart/order_customer_changed` — Fires when the customer assigned to an order changes
474
-
475
- **When it runs:** Fires inside `OrderController::changeCustomer()` after the order (and any child orders and [subscriptions](/database/models/subscription.md)) have been reassigned to a new customer, and both the old and new customer stats have been recounted.
476
-
477
- **Parameters:**
478
-
479
- - `$data` (array): Customer change data
480
-
481
- ```
482
- $data = [
483
- 'order' => $order, // \FluentCart\App\Models\Order
484
- 'old_customer' => $oldCustomer, // \FluentCart\App\Models\Customer|null
485
- 'new_customer' => $newCustomer, // \FluentCart\App\Models\Customer
486
- 'connected_order_ids' => [123, 124], // Array of all order IDs updated (parent + children)
487
- ];
488
- ```
489
-
490
- **Source:** `app/Http/Controllers/OrderController.php` (line 536)
491
-
492
- **Usage:**
493
-
494
- ```
495
- add_action('fluent_cart/order_customer_changed', function ($data) {
496
- $order = $data['order'];
497
- $oldCustomer = $data['old_customer'];
498
- $newCustomer = $data['new_customer'];
499
- // Notify the new customer about the transfer
500
- wp_mail(
501
- $newCustomer->email,
502
- 'Order Transferred to Your Account',
503
- sprintf('Order #%d has been assigned to your account.', $order->id)
504
- );
505
- }, 10, 1);
506
- ```
507
-
508
- ### ` order/generateMissingLicenses `
509
-
510
- `fluent_cart/order/generateMissingLicenses` — Fires when an admin triggers license generation for an order
511
-
512
- **When it runs:** Fires inside `OrderController::generateLicense()` when an admin requests license generation for an order that has fewer licenses than expected. This allows license modules to hook in and create the missing license keys.
513
-
514
- **Parameters:**
515
-
516
- - `$data` (array): Order data
517
-
518
- ```
519
- $data = [
520
- 'order' => $order, // \FluentCart\App\Models\Order (with order_items and licenses loaded)
521
- ];
522
- ```
523
-
524
- **Source:** `app/Http/Controllers/OrderController.php` (line 324)
525
-
526
- **Usage:**
527
-
528
- ```
529
- add_action('fluent_cart/order/generateMissingLicenses', function ($data) {
530
- $order = $data['order'];
531
- // Generate licenses for each eligible order item
532
- foreach ($order->order_items as $item) {
533
- generate_license_key($order->id, $item->product_id);
534
- }
535
- }, 10, 1);
536
- ```
537
-
538
- ### ` order_placed_offline `
539
-
540
- `fluent_cart/order_placed_offline` — Fires when an order is placed via Cash on Delivery or other offline payment
541
-
542
- **When it runs:** Fires inside `CodHandler::processPayment()` after the order and its [transaction](/database/models/order-transaction.md) have been created for an offline/COD payment. The [Order](/database/models/order.md), [Customer](/database/models/customer.md), and transaction data are all available at this point. The order has its `customer`, `shipping_address`, and `billing_address` relationships loaded.
543
-
544
- **Parameters:**
545
-
546
- - `$data` (array): Offline order data
547
-
548
- ```
549
- $data = [
550
- 'order' => $order, // \FluentCart\App\Models\Order
551
- 'customer' => $order->customer ?? [], // \FluentCart\App\Models\Customer or empty array
552
- 'transaction' => $transaction ?? [], // \FluentCart\App\Models\OrderTransaction or empty array
553
- ];
554
- ```
555
-
556
- **Source:** `app/Modules/PaymentMethods/Cod/CodHandler.php` (line 59)
557
-
558
- **Usage:**
559
-
560
- ```
561
- add_action('fluent_cart/order_placed_offline', function ($data) {
562
- $order = $data['order'];
563
- // Notify warehouse of new COD order
564
- wp_mail(
565
- '[email protected]',
566
- sprintf('New COD Order #%d', $order->id),
567
- 'A new Cash on Delivery order needs to be prepared for shipment.'
568
- );
569
- }, 10, 1);
570
- ```
571
-
572
- ### ` order_paid_done `
573
-
574
- `fluent_cart/order_paid_done` — Main lifecycle hook when order payment completes (recommended for integrations)
575
-
576
- **When it runs:** Fires asynchronously via Action Scheduler after an order's payment is confirmed as `paid`. The `OrderPaid` event enqueues a `fluent_cart/order_paid_async_private_handle` async action, which validates the order is still paid, then dispatches this hook. This is the **recommended hook for third-party integrations** because it runs outside the payment gateway request cycle, avoiding race conditions and timeouts. For subscription or renewal orders, the associated [Subscription](/database/models/subscription.md) model is included in the data.
577
-
578
- **Parameters:**
579
-
580
- - `$data` (array): Order payment completion data
581
-
582
- ```
583
- $data = [
584
- 'order' => $order, // \FluentCart\App\Models\Order
585
- 'transaction' => $transaction, // \FluentCart\App\Models\OrderTransaction (latest successful transaction)
586
- 'customer' => $customer, // \FluentCart\App\Models\Customer
587
- 'subscription' => $subscription, // \FluentCart\App\Models\Subscription (only for subscription/renewal orders)
588
- ];
589
- ```
590
-
591
- **Note:** The `subscription` key is only present when the order type is `subscription` or `renewal`.
592
-
593
- **Source:** `app/Hooks/actions.php` (line 170)
594
-
595
- **Usage:**
596
-
597
- ```
598
- add_action('fluent_cart/order_paid_done', function ($data) {
599
- $order = $data['order'];
600
- $customer = $data['customer'];
601
-
602
- // Grant membership access after payment
603
- update_user_meta($customer->user_id, 'membership_active', true);
604
-
605
- // Handle subscription orders differently
606
- if (!empty($data['subscription'])) {
607
- $subscription = $data['subscription'];
608
- update_user_meta($customer->user_id, 'subscription_id', $subscription->id);
609
- }
610
- }, 10, 1);
611
- ```
612
-
613
- ### ` order/receipt_viewed `
614
-
615
- `fluent_cart/order/receipt_viewed` — Fires the first time a customer views their order receipt
616
-
617
- **When it runs:** Fires at the end of receipt rendering (both the `ReceiptRenderer` class and the `receipt_slip.php` view template) when the `$is_first_time` flag is true. This means it only fires once per order, the very first time the receipt page is loaded. Subsequent views do not trigger this hook. The data includes both the [Order](/database/models/order.md) and [OrderOperation](/database/models/order-operation.md) models.
618
-
619
- **Parameters:**
620
-
621
- - `$data` (array): Receipt view data
622
-
623
- ```
624
- $data = [
625
- 'order' => $order, // \FluentCart\App\Models\Order
626
- 'order_operation' => $order_operation, // \FluentCart\App\Models\OrderOperation
627
- ];
628
- ```
629
-
630
- **Source:** `app/Services/Renderer/Receipt/ReceiptRenderer.php` (line 162), `app/Views/invoice/receipt_slip.php` (line 482)
631
-
632
- **Usage:**
633
-
634
- ```
635
- add_action('fluent_cart/order/receipt_viewed', function ($data) {
636
- $order = $data['order'];
637
- // Track receipt view for analytics
638
- fluent_cart_add_log(
639
- 'Receipt viewed',
640
- sprintf('Customer viewed receipt for Order #%d', $order->id),
641
- 'info',
642
- ['module_name' => 'order', 'module_id' => $order->id]
643
- );
644
- }, 10, 1);
645
- ```
646
-
647
- ### ` order_canceled `
648
-
649
- `fluent_cart/order_canceled` — Fires when a renewal order is canceled/voided
650
-
651
- **When it runs:** Fires inside `RenewalController`'s void/cancel flow, immediately after the order's customer stats have been recounted and immediately before the more specific `fluent_cart/renewal_voided` hook (same call site, one line later). Both hooks receive the same payload.
652
-
653
- **Parameters:**
654
-
655
- - `$data` (array): Canceled order data
656
-
657
- ```
658
- $data = [
659
- 'order' => $order, // \FluentCart\App\Models\Order
660
- 'customer' => $order->customer, // \FluentCart\App\Models\Customer
661
- ];
662
- ```
663
-
664
- **Source:** `app/Http/Controllers/RenewalController.php:122`
665
-
666
- **Usage:**
667
-
668
- ```
669
- add_action('fluent_cart/order_canceled', function ($data) {
670
- $order = $data['order'];
671
- fluent_cart_add_log(
672
- 'Order Canceled',
673
- sprintf('Order #%d was canceled/voided.', $order->id),
674
- 'info'
675
- );
676
- }, 10, 1);
677
- ```
678
-
679
- ### ` order_paid_async_private_handle `
680
-
681
- `fluent_cart/order_paid_async_private_handle` — Internal async post-payment hook for non-renewal orders
682
-
683
- **When it runs:** Fires inside `IntegrationEventListener` after an order is confirmed paid, but only when the order's `type` is **not** `renewal`. It is also enqueued as an Action Scheduler job from `OrderPaid`. **You should generally hook into `fluent_cart/order_paid_done` instead of this internal hook.**
684
-
685
- **Parameters:**
686
-
687
- - `$data` (array): Order identifier
688
-
689
- ```
690
- $data = [
691
- 'order_id' => 123, // int — the order ID
692
- ];
693
- ```
694
-
695
- **Source:** `app/Listeners/IntegrationEventListener.php:380`
696
-
697
- **Usage:**
698
-
699
- ```
700
- // Not recommended for third-party use. Use fluent_cart/order_paid_done instead.
701
- add_action('fluent_cart/order_paid_async_private_handle', function ($data) {
702
- $orderId = $data['order_id'];
703
- }, 10, 1);
704
- ```
705
-
706
- ---
707
-
708
- ---
709
-
710
- ## Order Emails
711
-
712
- ### ` email/order_entitlements `
713
-
714
- `fluent_cart/email/order_entitlements` — Print what an order grants in the order email
715
-
716
- **When it runs:** This action fires while FluentCart renders an order email, after the licenses block and before the downloads block. Use it to show what the order grants, for example a membership or course access. It fires in two places:
717
-
718
- - `order_paid_customer`: the default body of the paid-order email to the customer.
719
- - `payment_receipt`: the payment receipt smartcode, which custom email bodies use.
720
-
721
- The output is captured into the email body. **Echo your HTML** and escape your own values. Use inline styles, because email clients drop most CSS.
722
-
723
- The action does not fire for the email preview in the admin, because the preview uses a sample order.
724
-
725
- **Parameters:**
726
-
727
- - `$data` (array): Order and render context
728
-
729
- ```
730
- $data = [
731
- 'order' => $order, // \FluentCart\App\Models\Order
732
- 'context' => 'order_paid_customer', // or 'payment_receipt'
733
- ];
734
- ```
735
-
736
- **Source:**
737
-
738
- - `app/Views/emails/order/paid/customer.php:52`
739
- - `app/Services/ShortCodeParser/Parsers/OrderParser.php:340`
740
-
741
- **Usage:**
742
-
743
- ```
744
- add_action('fluent_cart/email/order_entitlements', function ($data) {
745
- $order = $data['order'];
746
-
747
- $levels = my_plugin_get_levels_for_order($order->id);
748
- if (!$levels) {
749
- return;
750
- }
751
-
752
- echo '<h3 style="margin: 20px 0 10px;">' . esc_html__('Your memberships', 'my-plugin') . '</h3>';
753
- foreach ($levels as $level) {
754
- echo '<p style="margin: 0 0 6px;">' . esc_html($level->title) . '</p>';
755
- }
756
- }, 10, 1);
757
- ```
1
+ # Orders
2
+
3
+ All hooks related to order lifecycle, status transitions, payments, shipping, refunds, and order items. These action hooks allow you to respond to key order events in FluentCart.
4
+
5
+ Each hook passes an associative array as its single parameter. The `order` value is always an [`\FluentCart\App\Models\Order`](/database/models/order.md) model instance with the [`customer`](/database/models/customer.md), `shipping_address`, and `billing_address` relationships eager-loaded (unless noted otherwise).
6
+
7
+ > **Amounts are in cents.** All monetary values (`total`, `refunded_amount`, etc.) are stored as integers in the smallest currency unit. Use `Helper::toDecimal($amount)` to convert for display.
8
+
9
+ ---
10
+
11
+ ## Order Status Changes
12
+
13
+ Fired when the **order status** field changes (e.g. `processing` → `completed`). Both a dynamic, status-specific hook and a generic hook fire on every change.
14
+
15
+ ### ` order_status_changed_to_{status} `
16
+
17
+ `fluent_cart/order_status_changed_to_{$newStatus}` — Fires when the order status changes to a specific status
18
+
19
+ **When it runs:** Fires inside `OrderStatusUpdated::afterDispatch()` whenever the order status type transitions to a new value. The `{$newStatus}` portion is replaced dynamically with the target status, so you can listen for a single status you care about.
20
+
21
+ **Available dynamic variants:** `completed`, `canceled`, `processing`, `on-hold`, `failed`
22
+
23
+ **Parameters:**
24
+
25
+ - `$data` (array): Order status change data
26
+
27
+ ```
28
+ $data = [
29
+ 'order' => $order, // \FluentCart\App\Models\Order (with customer, addresses loaded)
30
+ 'old_status' => 'processing', // Previous order status string
31
+ 'new_status' => 'completed', // New order status string (matches the dynamic suffix)
32
+ 'manageStock' => true, // Whether stock management should be applied
33
+ 'activity' => [ // Optional activity log context
34
+ 'title' => '',
35
+ 'content' => '',
36
+ ],
37
+ ];
38
+ ```
39
+
40
+ **Source:** `app/Events/Order/OrderStatusUpdated.php` (line 91)
41
+
42
+ **Usage:**
43
+
44
+ ```
45
+ add_action('fluent_cart/order_status_changed_to_completed', function ($data) {
46
+ $order = $data['order'];
47
+ // Grant digital access when order completes
48
+ grant_digital_access($order->customer_id, $order->id);
49
+ }, 10, 1);
50
+ ```
51
+
52
+ ### ` order_status_changed `
53
+
54
+ `fluent_cart/order_status_changed` — Fires on any order status change
55
+
56
+ **When it runs:** Fires immediately after the dynamic `order_status_changed_to_{$newStatus}` hook, on every order status transition regardless of the target status. Use this when you need to react to all status changes in a single callback.
57
+
58
+ **Parameters:**
59
+
60
+ - `$data` (array): Order status change data
61
+
62
+ ```
63
+ $data = [
64
+ 'order' => $order, // \FluentCart\App\Models\Order
65
+ 'old_status' => 'processing', // Previous order status
66
+ 'new_status' => 'completed', // New order status
67
+ 'manageStock' => true, // Whether stock management applies
68
+ 'activity' => [
69
+ 'title' => '',
70
+ 'content' => '',
71
+ ],
72
+ ];
73
+ ```
74
+
75
+ **Source:** `app/Events/Order/OrderStatusUpdated.php` (line 92)
76
+
77
+ **Usage:**
78
+
79
+ ```
80
+ add_action('fluent_cart/order_status_changed', function ($data) {
81
+ $order = $data['order'];
82
+ // Log every status transition
83
+ fluent_cart_add_log(
84
+ 'Order status changed',
85
+ sprintf('Order #%d: %s -> %s', $order->id, $data['old_status'], $data['new_status']),
86
+ 'info'
87
+ );
88
+ }, 10, 1);
89
+ ```
90
+
91
+ ---
92
+
93
+ ## Payment Status Changes
94
+
95
+ Fired when the **payment status** field changes (e.g. `pending` → `paid`). Both a dynamic, status-specific hook and a generic hook fire on every change.
96
+
97
+ ### ` payment_status_changed_to_{status} `
98
+
99
+ `fluent_cart/payment_status_changed_to_{$newStatus}` — Fires when payment status changes to a specific status
100
+
101
+ **When it runs:** Fires inside `OrderStatusUpdated::afterDispatch()` when the status change type is `payment_status`. The `{$newStatus}` suffix is replaced dynamically so you can target a single payment state.
102
+
103
+ **Available dynamic variants:** `pending`, `paid`, `partially_paid`, `failed`, `refunded`, `partially_refunded`, `authorized`
104
+
105
+ **Parameters:**
106
+
107
+ - `$data` (array): Payment status change data
108
+
109
+ ```
110
+ $data = [
111
+ 'order' => $order, // \FluentCart\App\Models\Order
112
+ 'old_status' => 'pending', // Previous payment status
113
+ 'new_status' => 'paid', // New payment status (matches the dynamic suffix)
114
+ 'manageStock' => true, // Whether stock management applies
115
+ 'activity' => [
116
+ 'title' => '',
117
+ 'content' => '',
118
+ ],
119
+ ];
120
+ ```
121
+
122
+ **Source:** `app/Events/Order/OrderStatusUpdated.php` (line 81)
123
+
124
+ **Usage:**
125
+
126
+ ```
127
+ add_action('fluent_cart/payment_status_changed_to_paid', function ($data) {
128
+ $order = $data['order'];
129
+ // Trigger fulfillment workflow when payment is confirmed
130
+ do_action('my_custom_fulfillment_start', $order->id);
131
+ }, 10, 1);
132
+ ```
133
+
134
+ ### ` payment_status_changed `
135
+
136
+ `fluent_cart/payment_status_changed` — Fires on any payment status change
137
+
138
+ **When it runs:** Fires immediately after the dynamic `payment_status_changed_to_{$newStatus}` hook, on every payment status transition. Use this when you need a single callback for all payment status changes.
139
+
140
+ **Parameters:**
141
+
142
+ - `$data` (array): Payment status change data
143
+
144
+ ```
145
+ $data = [
146
+ 'order' => $order, // \FluentCart\App\Models\Order
147
+ 'old_status' => 'pending', // Previous payment status
148
+ 'new_status' => 'paid', // New payment status
149
+ 'manageStock' => true, // Whether stock management applies
150
+ 'activity' => [
151
+ 'title' => '',
152
+ 'content' => '',
153
+ ],
154
+ ];
155
+ ```
156
+
157
+ **Source:** `app/Events/Order/OrderStatusUpdated.php` (line 82)
158
+
159
+ **Usage:**
160
+
161
+ ```
162
+ add_action('fluent_cart/payment_status_changed', function ($data) {
163
+ $order = $data['order'];
164
+ // Send payment status update notification
165
+ if ($data['new_status'] === 'paid') {
166
+ wp_mail($order->customer->email, 'Payment Confirmed', 'Your payment has been received.');
167
+ }
168
+ }, 10, 1);
169
+ ```
170
+
171
+ ---
172
+
173
+ ## Shipping Status Changes
174
+
175
+ Fired when the **shipping status** field changes (e.g. `unshipped` → `shipped`). Both a dynamic, status-specific hook and a generic hook fire on every change.
176
+
177
+ ### ` shipping_status_changed_to_{status} `
178
+
179
+ `fluent_cart/shipping_status_changed_to_{$newStatus}` — Fires when shipping status changes to a specific status
180
+
181
+ **When it runs:** Fires inside `OrderStatusUpdated::afterDispatch()` when the status change type is `shipping_status`. The `{$newStatus}` suffix is replaced dynamically so you can target a single shipping state.
182
+
183
+ **Available dynamic variants:** `unshipped`, `shipped`, `delivered`, `unshippable`
184
+
185
+ **Parameters:**
186
+
187
+ - `$data` (array): Shipping status change data
188
+
189
+ ```
190
+ $data = [
191
+ 'order' => $order, // \FluentCart\App\Models\Order
192
+ 'old_status' => 'unshipped', // Previous shipping status
193
+ 'new_status' => 'shipped', // New shipping status (matches the dynamic suffix)
194
+ 'manageStock' => true, // Whether stock management applies
195
+ 'activity' => [
196
+ 'title' => '',
197
+ 'content' => '',
198
+ ],
199
+ ];
200
+ ```
201
+
202
+ **Source:** `app/Events/Order/OrderStatusUpdated.php` (line 86)
203
+
204
+ **Usage:**
205
+
206
+ ```
207
+ add_action('fluent_cart/shipping_status_changed_to_shipped', function ($data) {
208
+ $order = $data['order'];
209
+ // Notify customer that their order has shipped
210
+ wp_mail(
211
+ $order->customer->email,
212
+ 'Your Order Has Shipped!',
213
+ sprintf('Order #%d has been shipped.', $order->id)
214
+ );
215
+ }, 10, 1);
216
+ ```
217
+
218
+ ### ` shipping_status_changed `
219
+
220
+ `fluent_cart/shipping_status_changed` — Fires on any shipping status change
221
+
222
+ **When it runs:** Fires immediately after the dynamic `shipping_status_changed_to_{$newStatus}` hook, on every shipping status transition. Use this when you need a single callback for all shipping status changes.
223
+
224
+ **Parameters:**
225
+
226
+ - `$data` (array): Shipping status change data
227
+
228
+ ```
229
+ $data = [
230
+ 'order' => $order, // \FluentCart\App\Models\Order
231
+ 'old_status' => 'unshipped', // Previous shipping status
232
+ 'new_status' => 'shipped', // New shipping status
233
+ 'manageStock' => true, // Whether stock management applies
234
+ 'activity' => [
235
+ 'title' => '',
236
+ 'content' => '',
237
+ ],
238
+ ];
239
+ ```
240
+
241
+ **Source:** `app/Events/Order/OrderStatusUpdated.php` (line 87)
242
+
243
+ **Usage:**
244
+
245
+ ```
246
+ add_action('fluent_cart/shipping_status_changed', function ($data) {
247
+ $order = $data['order'];
248
+ // Log all shipping status transitions
249
+ fluent_cart_add_log(
250
+ 'Shipping status changed',
251
+ sprintf('Order #%d: %s -> %s', $order->id, $data['old_status'], $data['new_status']),
252
+ 'info'
253
+ );
254
+ }, 10, 1);
255
+ ```
256
+
257
+ ---
258
+
259
+ ## Refunds
260
+
261
+ Fired during the refund flow after transaction records have been created. The generic `order_refunded` hook fires on every refund, followed by either `order_fully_refunded` or `order_partially_refunded` depending on the refund type. Refund data includes the [Order](/database/models/order.md), [OrderItem](/database/models/order-item.md), [OrderTransaction](/database/models/order-transaction.md), and [Customer](/database/models/customer.md) models.
262
+
263
+ ### ` order_refunded `
264
+
265
+ `fluent_cart/order_refunded` — Fires after any refund (full or partial)
266
+
267
+ **When it runs:** Fires inside `OrderRefund::afterDispatch()` after a refund transaction is recorded and the refund amount is calculated. This hook fires for both full and partial refunds. It fires before the type-specific hooks below.
268
+
269
+ **Parameters:**
270
+
271
+ - `$data` (array): Refund data
272
+
273
+ ```
274
+ $data = [
275
+ 'order' => $order, // \FluentCart\App\Models\Order
276
+ 'refunded_items' => [], // Array of OrderItem models (looked up from refundedItemIds)
277
+ 'new_refunded_items' => [], // Raw refunded items array with restore_quantity info
278
+ 'refunded_amount' => 5000, // Newly refunded amount in cents
279
+ 'manage_stock' => true, // Whether stock should be restored
280
+ 'transaction' => $transaction, // \FluentCart\App\Models\OrderTransaction (the refund transaction)
281
+ 'customer' => $customer, // \FluentCart\App\Models\Customer
282
+ 'type' => 'full', // 'full' or 'partial'
283
+ ];
284
+ ```
285
+
286
+ **Source:** `app/Events/Order/OrderRefund.php` (line 141)
287
+
288
+ **Usage:**
289
+
290
+ ```
291
+ add_action('fluent_cart/order_refunded', function ($data) {
292
+ $order = $data['order'];
293
+ $amount = \FluentCart\App\Helpers\Helper::toDecimal($data['refunded_amount']);
294
+ // Notify admin of any refund
295
+ wp_mail(
296
+ get_option('admin_email'),
297
+ sprintf('Refund on Order #%d', $order->id),
298
+ sprintf('A %s refund of %s has been processed.', $data['type'], $amount)
299
+ );
300
+ }, 10, 1);
301
+ ```
302
+
303
+ ### ` order_fully_refunded `
304
+
305
+ `fluent_cart/order_fully_refunded` — Fires only when an order is fully refunded
306
+
307
+ **When it runs:** Fires inside `OrderRefund::afterDispatch()` immediately after the generic `order_refunded` hook, but only when the total refunded amount meets or exceeds the order's total paid amount (i.e. full refund).
308
+
309
+ **Parameters:**
310
+
311
+ - `$data` (array): Full refund data (identical structure to `order_refunded`)
312
+
313
+ ```
314
+ $data = [
315
+ 'order' => $order, // \FluentCart\App\Models\Order
316
+ 'refunded_items' => [], // Array of OrderItem models
317
+ 'new_refunded_items' => [], // Raw refunded items with restore_quantity
318
+ 'refunded_amount' => 10000, // Refunded amount in cents
319
+ 'manage_stock' => true, // Whether stock should be restored
320
+ 'transaction' => $transaction, // \FluentCart\App\Models\OrderTransaction
321
+ 'customer' => $customer, // \FluentCart\App\Models\Customer
322
+ 'type' => 'full', // Always 'full' for this hook
323
+ ];
324
+ ```
325
+
326
+ **Source:** `app/Events/Order/OrderRefund.php` (line 144)
327
+
328
+ **Usage:**
329
+
330
+ ```
331
+ add_action('fluent_cart/order_fully_refunded', function ($data) {
332
+ $order = $data['order'];
333
+ // Revoke digital access on full refund
334
+ update_user_meta($order->customer_id, 'membership_active', false);
335
+ }, 10, 1);
336
+ ```
337
+
338
+ ### ` order_partially_refunded `
339
+
340
+ `fluent_cart/order_partially_refunded` — Fires only when an order is partially refunded
341
+
342
+ **When it runs:** Fires inside `OrderRefund::afterDispatch()` immediately after the generic `order_refunded` hook, but only when the total refunded amount is less than the order's total paid amount (i.e. partial refund).
343
+
344
+ **Parameters:**
345
+
346
+ - `$data` (array): Partial refund data (identical structure to `order_refunded`)
347
+
348
+ ```
349
+ $data = [
350
+ 'order' => $order, // \FluentCart\App\Models\Order
351
+ 'refunded_items' => [], // Array of OrderItem models
352
+ 'new_refunded_items' => [], // Raw refunded items with restore_quantity
353
+ 'refunded_amount' => 3000, // Refunded amount in cents
354
+ 'manage_stock' => true, // Whether stock should be restored
355
+ 'transaction' => $transaction, // \FluentCart\App\Models\OrderTransaction
356
+ 'customer' => $customer, // \FluentCart\App\Models\Customer
357
+ 'type' => 'partial', // Always 'partial' for this hook
358
+ ];
359
+ ```
360
+
361
+ **Source:** `app/Events/Order/OrderRefund.php` (line 146)
362
+
363
+ **Usage:**
364
+
365
+ ```
366
+ add_action('fluent_cart/order_partially_refunded', function ($data) {
367
+ $order = $data['order'];
368
+ $customer = $data['customer'];
369
+ // Notify customer of partial refund
370
+ wp_mail(
371
+ $customer->email,
372
+ 'Partial Refund Processed',
373
+ sprintf('A partial refund has been issued for Order #%d.', $order->id)
374
+ );
375
+ }, 10, 1);
376
+ ```
377
+
378
+ ---
379
+
380
+ ## Order Items
381
+
382
+ Hooks that fire when custom line items on an order are being deleted. These are useful for cleanup or audit logging on custom [OrderItem](/database/models/order-item.md) records.
383
+
384
+ ### ` order/before_custom_items_deleted `
385
+
386
+ `fluent_cart/order/before_custom_items_deleted` — Fires before custom line items are deleted
387
+
388
+ **When it runs:** Fires inside `OrderResource::updateOrderItems()` just before custom order items (flagged as `is_custom`) are permanently deleted from the database. Only fires if the filtered collection of custom items is not empty.
389
+
390
+ **Parameters:**
391
+
392
+ - `$customItems` (\Illuminate\Support\Collection): Collection of [`\FluentCart\App\Models\OrderItem`](/database/models/order-item.md) models about to be deleted (only items where `is_custom` is true)
393
+ - `$order` ([`\FluentCart\App\Models\Order`](/database/models/order.md)): The parent order model
394
+
395
+ **Source:** `api/Resource/OrderResource.php` (line 1624)
396
+
397
+ **Usage:**
398
+
399
+ ```
400
+ add_action('fluent_cart/order/before_custom_items_deleted', function ($customItems, $order) {
401
+ // Archive custom items before they are removed
402
+ foreach ($customItems as $item) {
403
+ fluent_cart_add_log(
404
+ 'Custom item removed',
405
+ sprintf('Item "%s" removed from Order #%d', $item->title, $order->id),
406
+ 'info'
407
+ );
408
+ }
409
+ }, 10, 2);
410
+ ```
411
+
412
+ ### ` order/after_custom_items_deleted `
413
+
414
+ `fluent_cart/order/after_custom_items_deleted` — Fires after custom line items are deleted
415
+
416
+ **When it runs:** Fires inside `OrderResource::updateOrderItems()` immediately after custom order items have been permanently deleted from the database. The collection still holds the model instances (now removed from DB). Only fires if the collection is not empty.
417
+
418
+ **Parameters:**
419
+
420
+ - `$customItems` (\Illuminate\Support\Collection): Collection of [`\FluentCart\App\Models\OrderItem`](/database/models/order-item.md) models that were just deleted
421
+ - `$order` ([`\FluentCart\App\Models\Order`](/database/models/order.md)): The parent order model
422
+
423
+ **Source:** `api/Resource/OrderResource.php` (line 1630)
424
+
425
+ **Usage:**
426
+
427
+ ```
428
+ add_action('fluent_cart/order/after_custom_items_deleted', function ($customItems, $order) {
429
+ // Recalculate order totals after custom items removed
430
+ $order->recalculateTotals();
431
+ }, 10, 2);
432
+ ```
433
+
434
+ ---
435
+
436
+ ## Order Lifecycle
437
+
438
+ General lifecycle hooks that fire at key moments during an [Order](/database/models/order.md)'s existence: invoice generation, [Customer](/database/models/customer.md) changes, payment completion, license generation, and receipt viewing.
439
+
440
+ ### ` order/invoice_number_added `
441
+
442
+ `fluent_cart/order/invoice_number_added` — Fires after an invoice/receipt number is assigned to an order
443
+
444
+ **When it runs:** Fires in two places:
445
+
446
+ 1. Inside the `Order::booted()` `created` callback, immediately after a new order is persisted to the database with an invoice number already set (when payment status is `paid` at creation time).
447
+ 2. Inside `Order::generateReceiptNumber()`, when a receipt number is generated for an existing order that did not previously have one.
448
+
449
+ **Parameters:**
450
+
451
+ - `$data` (array): Order data
452
+
453
+ ```
454
+ $data = [
455
+ 'order' => $order, // \FluentCart\App\Models\Order
456
+ ];
457
+ ```
458
+
459
+ **Source:** `app/Models/Order.php` (lines 60 and 734)
460
+
461
+ **Usage:**
462
+
463
+ ```
464
+ add_action('fluent_cart/order/invoice_number_added', function ($data) {
465
+ $order = $data['order'];
466
+ // Sync invoice number to external accounting system
467
+ sync_to_accounting($order->id, $order->invoice_no, $order->receipt_number);
468
+ }, 10, 1);
469
+ ```
470
+
471
+ ### ` order_customer_changed `
472
+
473
+ `fluent_cart/order_customer_changed` — Fires when the customer assigned to an order changes
474
+
475
+ **When it runs:** Fires inside `OrderController::changeCustomer()` after the order (and any child orders and [subscriptions](/database/models/subscription.md)) have been reassigned to a new customer, and both the old and new customer stats have been recounted.
476
+
477
+ **Parameters:**
478
+
479
+ - `$data` (array): Customer change data
480
+
481
+ ```
482
+ $data = [
483
+ 'order' => $order, // \FluentCart\App\Models\Order
484
+ 'old_customer' => $oldCustomer, // \FluentCart\App\Models\Customer|null
485
+ 'new_customer' => $newCustomer, // \FluentCart\App\Models\Customer
486
+ 'connected_order_ids' => [123, 124], // Array of all order IDs updated (parent + children)
487
+ ];
488
+ ```
489
+
490
+ **Source:** `app/Http/Controllers/OrderController.php` (line 536)
491
+
492
+ **Usage:**
493
+
494
+ ```
495
+ add_action('fluent_cart/order_customer_changed', function ($data) {
496
+ $order = $data['order'];
497
+ $oldCustomer = $data['old_customer'];
498
+ $newCustomer = $data['new_customer'];
499
+ // Notify the new customer about the transfer
500
+ wp_mail(
501
+ $newCustomer->email,
502
+ 'Order Transferred to Your Account',
503
+ sprintf('Order #%d has been assigned to your account.', $order->id)
504
+ );
505
+ }, 10, 1);
506
+ ```
507
+
508
+ ### ` order/generateMissingLicenses `
509
+
510
+ `fluent_cart/order/generateMissingLicenses` — Fires when an admin triggers license generation for an order
511
+
512
+ **When it runs:** Fires inside `OrderController::generateLicense()` when an admin requests license generation for an order that has fewer licenses than expected. This allows license modules to hook in and create the missing license keys.
513
+
514
+ **Parameters:**
515
+
516
+ - `$data` (array): Order data
517
+
518
+ ```
519
+ $data = [
520
+ 'order' => $order, // \FluentCart\App\Models\Order (with order_items and licenses loaded)
521
+ ];
522
+ ```
523
+
524
+ **Source:** `app/Http/Controllers/OrderController.php` (line 324)
525
+
526
+ **Usage:**
527
+
528
+ ```
529
+ add_action('fluent_cart/order/generateMissingLicenses', function ($data) {
530
+ $order = $data['order'];
531
+ // Generate licenses for each eligible order item
532
+ foreach ($order->order_items as $item) {
533
+ generate_license_key($order->id, $item->product_id);
534
+ }
535
+ }, 10, 1);
536
+ ```
537
+
538
+ ### ` order_placed_offline `
539
+
540
+ `fluent_cart/order_placed_offline` — Fires when an order is placed via Cash on Delivery or other offline payment
541
+
542
+ **When it runs:** Fires inside `CodHandler::processPayment()` after the order and its [transaction](/database/models/order-transaction.md) have been created for an offline/COD payment. The [Order](/database/models/order.md), [Customer](/database/models/customer.md), and transaction data are all available at this point. The order has its `customer`, `shipping_address`, and `billing_address` relationships loaded.
543
+
544
+ **Parameters:**
545
+
546
+ - `$data` (array): Offline order data
547
+
548
+ ```
549
+ $data = [
550
+ 'order' => $order, // \FluentCart\App\Models\Order
551
+ 'customer' => $order->customer ?? [], // \FluentCart\App\Models\Customer or empty array
552
+ 'transaction' => $transaction ?? [], // \FluentCart\App\Models\OrderTransaction or empty array
553
+ ];
554
+ ```
555
+
556
+ **Source:** `app/Modules/PaymentMethods/Cod/CodHandler.php` (line 59)
557
+
558
+ **Usage:**
559
+
560
+ ```
561
+ add_action('fluent_cart/order_placed_offline', function ($data) {
562
+ $order = $data['order'];
563
+ // Notify warehouse of new COD order
564
+ wp_mail(
565
+ '[email&#160;protected]',
566
+ sprintf('New COD Order #%d', $order->id),
567
+ 'A new Cash on Delivery order needs to be prepared for shipment.'
568
+ );
569
+ }, 10, 1);
570
+ ```
571
+
572
+ ### ` order_paid_done `
573
+
574
+ `fluent_cart/order_paid_done` — Main lifecycle hook when order payment completes (recommended for integrations)
575
+
576
+ **When it runs:** Fires asynchronously via Action Scheduler after an order's payment is confirmed as `paid`. The `OrderPaid` event enqueues a `fluent_cart/order_paid_async_private_handle` async action, which validates the order is still paid, then dispatches this hook. This is the **recommended hook for third-party integrations** because it runs outside the payment gateway request cycle, avoiding race conditions and timeouts. For subscription or renewal orders, the associated [Subscription](/database/models/subscription.md) model is included in the data.
577
+
578
+ **Parameters:**
579
+
580
+ - `$data` (array): Order payment completion data
581
+
582
+ ```
583
+ $data = [
584
+ 'order' => $order, // \FluentCart\App\Models\Order
585
+ 'transaction' => $transaction, // \FluentCart\App\Models\OrderTransaction (latest successful transaction)
586
+ 'customer' => $customer, // \FluentCart\App\Models\Customer
587
+ 'subscription' => $subscription, // \FluentCart\App\Models\Subscription (only for subscription/renewal orders)
588
+ ];
589
+ ```
590
+
591
+ **Note:** The `subscription` key is only present when the order type is `subscription` or `renewal`.
592
+
593
+ **Source:** `app/Hooks/actions.php` (line 170)
594
+
595
+ **Usage:**
596
+
597
+ ```
598
+ add_action('fluent_cart/order_paid_done', function ($data) {
599
+ $order = $data['order'];
600
+ $customer = $data['customer'];
601
+
602
+ // Grant membership access after payment
603
+ update_user_meta($customer->user_id, 'membership_active', true);
604
+
605
+ // Handle subscription orders differently
606
+ if (!empty($data['subscription'])) {
607
+ $subscription = $data['subscription'];
608
+ update_user_meta($customer->user_id, 'subscription_id', $subscription->id);
609
+ }
610
+ }, 10, 1);
611
+ ```
612
+
613
+ ### ` order/receipt_viewed `
614
+
615
+ `fluent_cart/order/receipt_viewed` — Fires the first time a customer views their order receipt
616
+
617
+ **When it runs:** Fires at the end of receipt rendering (both the `ReceiptRenderer` class and the `receipt_slip.php` view template) when the `$is_first_time` flag is true. This means it only fires once per order, the very first time the receipt page is loaded. Subsequent views do not trigger this hook. The data includes both the [Order](/database/models/order.md) and [OrderOperation](/database/models/order-operation.md) models.
618
+
619
+ **Parameters:**
620
+
621
+ - `$data` (array): Receipt view data
622
+
623
+ ```
624
+ $data = [
625
+ 'order' => $order, // \FluentCart\App\Models\Order
626
+ 'order_operation' => $order_operation, // \FluentCart\App\Models\OrderOperation
627
+ ];
628
+ ```
629
+
630
+ **Source:** `app/Services/Renderer/Receipt/ReceiptRenderer.php` (line 162), `app/Views/invoice/receipt_slip.php` (line 482)
631
+
632
+ **Usage:**
633
+
634
+ ```
635
+ add_action('fluent_cart/order/receipt_viewed', function ($data) {
636
+ $order = $data['order'];
637
+ // Track receipt view for analytics
638
+ fluent_cart_add_log(
639
+ 'Receipt viewed',
640
+ sprintf('Customer viewed receipt for Order #%d', $order->id),
641
+ 'info',
642
+ ['module_name' => 'order', 'module_id' => $order->id]
643
+ );
644
+ }, 10, 1);
645
+ ```
646
+
647
+ ### ` order_canceled `
648
+
649
+ `fluent_cart/order_canceled` — Fires when a renewal order is canceled/voided
650
+
651
+ **When it runs:** Fires inside `RenewalController`'s void/cancel flow, immediately after the order's customer stats have been recounted and immediately before the more specific `fluent_cart/renewal_voided` hook (same call site, one line later). Both hooks receive the same payload.
652
+
653
+ **Parameters:**
654
+
655
+ - `$data` (array): Canceled order data
656
+
657
+ ```
658
+ $data = [
659
+ 'order' => $order, // \FluentCart\App\Models\Order
660
+ 'customer' => $order->customer, // \FluentCart\App\Models\Customer
661
+ ];
662
+ ```
663
+
664
+ **Source:** `app/Http/Controllers/RenewalController.php:122`
665
+
666
+ **Usage:**
667
+
668
+ ```
669
+ add_action('fluent_cart/order_canceled', function ($data) {
670
+ $order = $data['order'];
671
+ fluent_cart_add_log(
672
+ 'Order Canceled',
673
+ sprintf('Order #%d was canceled/voided.', $order->id),
674
+ 'info'
675
+ );
676
+ }, 10, 1);
677
+ ```
678
+
679
+ ### ` order_paid_async_private_handle `
680
+
681
+ `fluent_cart/order_paid_async_private_handle` — Internal async post-payment hook for non-renewal orders
682
+
683
+ **When it runs:** Fires inside `IntegrationEventListener` after an order is confirmed paid, but only when the order's `type` is **not** `renewal`. It is also enqueued as an Action Scheduler job from `OrderPaid`. **You should generally hook into `fluent_cart/order_paid_done` instead of this internal hook.**
684
+
685
+ **Parameters:**
686
+
687
+ - `$data` (array): Order identifier
688
+
689
+ ```
690
+ $data = [
691
+ 'order_id' => 123, // int — the order ID
692
+ ];
693
+ ```
694
+
695
+ **Source:** `app/Listeners/IntegrationEventListener.php:380`
696
+
697
+ **Usage:**
698
+
699
+ ```
700
+ // Not recommended for third-party use. Use fluent_cart/order_paid_done instead.
701
+ add_action('fluent_cart/order_paid_async_private_handle', function ($data) {
702
+ $orderId = $data['order_id'];
703
+ }, 10, 1);
704
+ ```
705
+
706
+ ---
707
+
708
+ ---
709
+
710
+ ## Order Emails
711
+
712
+ ### ` email/order_entitlements `
713
+
714
+ `fluent_cart/email/order_entitlements` — Print what an order grants in the order email
715
+
716
+ **When it runs:** This action fires while FluentCart renders an order email, after the licenses block and before the downloads block. Use it to show what the order grants, for example a membership or course access. It fires in two places:
717
+
718
+ - `order_paid_customer`: the default body of the paid-order email to the customer.
719
+ - `payment_receipt`: the payment receipt smartcode, which custom email bodies use.
720
+
721
+ The output is captured into the email body. **Echo your HTML** and escape your own values. Use inline styles, because email clients drop most CSS.
722
+
723
+ The action does not fire for the email preview in the admin, because the preview uses a sample order.
724
+
725
+ **Parameters:**
726
+
727
+ - `$data` (array): Order and render context
728
+
729
+ ```
730
+ $data = [
731
+ 'order' => $order, // \FluentCart\App\Models\Order
732
+ 'context' => 'order_paid_customer', // or 'payment_receipt'
733
+ ];
734
+ ```
735
+
736
+ **Source:**
737
+
738
+ - `app/Views/emails/order/paid/customer.php:52`
739
+ - `app/Services/ShortCodeParser/Parsers/OrderParser.php:340`
740
+
741
+ **Usage:**
742
+
743
+ ```
744
+ add_action('fluent_cart/email/order_entitlements', function ($data) {
745
+ $order = $data['order'];
746
+
747
+ $levels = my_plugin_get_levels_for_order($order->id);
748
+ if (!$levels) {
749
+ return;
750
+ }
751
+
752
+ echo '<h3 style="margin: 20px 0 10px;">' . esc_html__('Your memberships', 'my-plugin') . '</h3>';
753
+ foreach ($levels as $level) {
754
+ echo '<p style="margin: 0 0 6px;">' . esc_html($level->title) . '</p>';
755
+ }
756
+ }, 10, 1);
757
+ ```