fluentcart-developer 3.0.0 → 3.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (612) 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/server.d.ts.map +1 -1
  6. package/dist/server.js +37 -1
  7. package/dist/server.js.map +1 -1
  8. package/dist/skills/fluentcart-developer/SKILL.md +108 -108
  9. package/dist/skills/fluentcart-developer/examples/README.md +30 -30
  10. package/dist/skills/fluentcart-developer/examples/fluentcart-starter-child-theme/fluent-cart/checkout.php +32 -32
  11. package/dist/skills/fluentcart-developer/examples/fluentcart-starter-child-theme/functions.php +40 -40
  12. package/dist/skills/fluentcart-developer/examples/sample-custom-addon/fluentcart-custom-addon.php +113 -113
  13. package/dist/skills/fluentcart-developer/examples/sample-custom-payment-gateway/fluentcart-custom-gateway-example.php +148 -148
  14. package/dist/skills/fluentcart-developer/examples/sample-fee-surcharge-plugin/fluentcart-fee-surcharge.php +38 -38
  15. package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/README.md +22 -22
  16. package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/sample-plugin-with-licensing-sdk.php +79 -79
  17. package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/updater/FluentLicensing.php +303 -303
  18. package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/updater/LicenseSettings.php +566 -566
  19. package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/updater/PluginUpdater.php +304 -304
  20. package/dist/skills/fluentcart-developer/examples/sample-shipping-carrier/fluentcart-custom-shipping-carrier.php +61 -61
  21. package/dist/skills/fluentcart-developer/references/api/authentication.md +452 -452
  22. package/dist/skills/fluentcart-developer/references/api/coupons.md +786 -786
  23. package/dist/skills/fluentcart-developer/references/api/customers.md +889 -889
  24. package/dist/skills/fluentcart-developer/references/api/files.md +609 -609
  25. package/dist/skills/fluentcart-developer/references/api/index.md +432 -432
  26. package/dist/skills/fluentcart-developer/references/api/licensing.md +633 -633
  27. package/dist/skills/fluentcart-developer/references/api/order-bump.md +384 -384
  28. package/dist/skills/fluentcart-developer/references/api/orders.md +814 -814
  29. package/dist/skills/fluentcart-developer/references/api/products.md +866 -866
  30. package/dist/skills/fluentcart-developer/references/api/roles-permissions.md +536 -536
  31. package/dist/skills/fluentcart-developer/references/api/subscriptions.md +827 -827
  32. package/dist/skills/fluentcart-developer/references/database/index.md +44 -44
  33. package/dist/skills/fluentcart-developer/references/database/models/activity.md +178 -178
  34. package/dist/skills/fluentcart-developer/references/database/models/applied-coupon.md +291 -291
  35. package/dist/skills/fluentcart-developer/references/database/models/attribute-group.md +239 -239
  36. package/dist/skills/fluentcart-developer/references/database/models/attribute-relation.md +181 -181
  37. package/dist/skills/fluentcart-developer/references/database/models/attribute-term.md +219 -219
  38. package/dist/skills/fluentcart-developer/references/database/models/cart.md +645 -645
  39. package/dist/skills/fluentcart-developer/references/database/models/coupon.md +427 -427
  40. package/dist/skills/fluentcart-developer/references/database/models/customer-addresses.md +348 -348
  41. package/dist/skills/fluentcart-developer/references/database/models/customer-meta.md +156 -156
  42. package/dist/skills/fluentcart-developer/references/database/models/customer.md +584 -584
  43. package/dist/skills/fluentcart-developer/references/database/models/dynamic-model.md +163 -163
  44. package/dist/skills/fluentcart-developer/references/database/models/label-relationship.md +155 -155
  45. package/dist/skills/fluentcart-developer/references/database/models/label.md +153 -153
  46. package/dist/skills/fluentcart-developer/references/database/models/license-activation.md +182 -182
  47. package/dist/skills/fluentcart-developer/references/database/models/license-meta.md +163 -163
  48. package/dist/skills/fluentcart-developer/references/database/models/license-site.md +208 -208
  49. package/dist/skills/fluentcart-developer/references/database/models/license.md +640 -640
  50. package/dist/skills/fluentcart-developer/references/database/models/meta.md +233 -233
  51. package/dist/skills/fluentcart-developer/references/database/models/order-address.md +391 -391
  52. package/dist/skills/fluentcart-developer/references/database/models/order-download-permission.md +144 -144
  53. package/dist/skills/fluentcart-developer/references/database/models/order-item.md +383 -383
  54. package/dist/skills/fluentcart-developer/references/database/models/order-meta.md +303 -303
  55. package/dist/skills/fluentcart-developer/references/database/models/order-operation.md +158 -158
  56. package/dist/skills/fluentcart-developer/references/database/models/order-promotion-stat.md +175 -175
  57. package/dist/skills/fluentcart-developer/references/database/models/order-promotion.md +250 -250
  58. package/dist/skills/fluentcart-developer/references/database/models/order-tax-rate.md +172 -172
  59. package/dist/skills/fluentcart-developer/references/database/models/order-transaction.md +440 -440
  60. package/dist/skills/fluentcart-developer/references/database/models/order.md +727 -727
  61. package/dist/skills/fluentcart-developer/references/database/models/product-detail.md +397 -397
  62. package/dist/skills/fluentcart-developer/references/database/models/product-download.md +258 -258
  63. package/dist/skills/fluentcart-developer/references/database/models/product-meta.md +153 -153
  64. package/dist/skills/fluentcart-developer/references/database/models/product-variation.md +556 -556
  65. package/dist/skills/fluentcart-developer/references/database/models/product.md +580 -580
  66. package/dist/skills/fluentcart-developer/references/database/models/relationships.md +427 -427
  67. package/dist/skills/fluentcart-developer/references/database/models/scheduled-action.md +175 -175
  68. package/dist/skills/fluentcart-developer/references/database/models/shipping-class.md +148 -148
  69. package/dist/skills/fluentcart-developer/references/database/models/shipping-method.md +280 -280
  70. package/dist/skills/fluentcart-developer/references/database/models/shipping-zone.md +205 -205
  71. package/dist/skills/fluentcart-developer/references/database/models/subscription-meta.md +173 -173
  72. package/dist/skills/fluentcart-developer/references/database/models/subscription.md +528 -528
  73. package/dist/skills/fluentcart-developer/references/database/models/tax-class.md +195 -195
  74. package/dist/skills/fluentcart-developer/references/database/models/tax-rate.md +225 -225
  75. package/dist/skills/fluentcart-developer/references/database/models/user-meta.md +166 -166
  76. package/dist/skills/fluentcart-developer/references/database/models/user.md +220 -220
  77. package/dist/skills/fluentcart-developer/references/database/models.md +404 -404
  78. package/dist/skills/fluentcart-developer/references/database/query-builder.md +860 -860
  79. package/dist/skills/fluentcart-developer/references/database/readme.md +276 -276
  80. package/dist/skills/fluentcart-developer/references/database/schema.md +1002 -1002
  81. package/dist/skills/fluentcart-developer/references/engineering/adding-custom-pages-to-the-customer-dashboard.md +395 -395
  82. package/dist/skills/fluentcart-developer/references/engineering/index.md +4 -4
  83. package/dist/skills/fluentcart-developer/references/engineering.md +4 -4
  84. package/dist/skills/fluentcart-developer/references/getting-started.md +249 -249
  85. package/dist/skills/fluentcart-developer/references/guides/frontend.md +519 -519
  86. package/dist/skills/fluentcart-developer/references/guides/index.md +107 -107
  87. package/dist/skills/fluentcart-developer/references/guides/integrations.md +600 -600
  88. package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/index.md +237 -237
  89. package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/labels-and-tracking.md +481 -481
  90. package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/live-rates.md +269 -269
  91. package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/reference.md +223 -223
  92. package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/settings.md +370 -370
  93. package/dist/skills/fluentcart-developer/references/guides/shipping-carrier.md +237 -237
  94. package/dist/skills/fluentcart-developer/references/guides/subscriptions.md +217 -217
  95. package/dist/skills/fluentcart-developer/references/hooks/actions/admin-and-templates.md +1079 -1079
  96. package/dist/skills/fluentcart-developer/references/hooks/actions/cart-and-checkout.md +1795 -1795
  97. package/dist/skills/fluentcart-developer/references/hooks/actions/customers-and-users.md +327 -327
  98. package/dist/skills/fluentcart-developer/references/hooks/actions/licenses.md +829 -829
  99. package/dist/skills/fluentcart-developer/references/hooks/actions/modules.md +81 -81
  100. package/dist/skills/fluentcart-developer/references/hooks/actions/orders.md +757 -757
  101. package/dist/skills/fluentcart-developer/references/hooks/actions/payments-and-integrations.md +1163 -1163
  102. package/dist/skills/fluentcart-developer/references/hooks/actions/pro-modules.md +219 -219
  103. package/dist/skills/fluentcart-developer/references/hooks/actions/products-and-coupons.md +1019 -1019
  104. package/dist/skills/fluentcart-developer/references/hooks/actions/subscriptions.md +1290 -1290
  105. package/dist/skills/fluentcart-developer/references/hooks/actions.md +16 -16
  106. package/dist/skills/fluentcart-developer/references/hooks/deprecated.md +60 -60
  107. package/dist/skills/fluentcart-developer/references/hooks/filters/cart-and-checkout.md +2032 -2032
  108. package/dist/skills/fluentcart-developer/references/hooks/filters/customers-and-subscriptions.md +1746 -1746
  109. package/dist/skills/fluentcart-developer/references/hooks/filters/integrations-and-advanced.md +2439 -2439
  110. package/dist/skills/fluentcart-developer/references/hooks/filters/modules.md +464 -464
  111. package/dist/skills/fluentcart-developer/references/hooks/filters/orders-and-payments.md +2658 -2658
  112. package/dist/skills/fluentcart-developer/references/hooks/filters/pro-modules.md +502 -502
  113. package/dist/skills/fluentcart-developer/references/hooks/filters/products-and-pricing.md +1785 -1785
  114. package/dist/skills/fluentcart-developer/references/hooks/filters/settings-and-configuration.md +2966 -2966
  115. package/dist/skills/fluentcart-developer/references/hooks/filters.md +14 -14
  116. package/dist/skills/fluentcart-developer/references/hooks/index.md +35 -35
  117. package/dist/skills/fluentcart-developer/references/index.md +625 -625
  118. package/dist/skills/fluentcart-developer/references/modules/fee-system.md +427 -427
  119. package/dist/skills/fluentcart-developer/references/modules/ghost-product-selling.md +440 -440
  120. package/dist/skills/fluentcart-developer/references/modules/index.md +484 -484
  121. package/dist/skills/fluentcart-developer/references/modules/licensing.md +342 -342
  122. package/dist/skills/fluentcart-developer/references/modules/order-bump.md +433 -433
  123. package/dist/skills/fluentcart-developer/references/modules/payment-methods.md +129 -129
  124. package/dist/skills/fluentcart-developer/references/modules/refunds.md +170 -170
  125. package/dist/skills/fluentcart-developer/references/modules/shipping.md +846 -846
  126. package/dist/skills/fluentcart-developer/references/modules/storage.md +986 -986
  127. package/dist/skills/fluentcart-developer/references/modules/subscription-vendor-ids.md +186 -186
  128. package/dist/skills/fluentcart-developer/references/modules/subscriptions.md +678 -678
  129. package/dist/skills/fluentcart-developer/references/payment-methods-integration/index.md +164 -164
  130. package/dist/skills/fluentcart-developer/references/payment-methods-integration/paddle-example.md +1648 -1648
  131. package/dist/skills/fluentcart-developer/references/payment-methods-integration/payment/setting/fields.md +353 -353
  132. package/dist/skills/fluentcart-developer/references/payment-methods-integration/quick-implementation.md +1079 -1079
  133. package/dist/skills/fluentcart-developer/references/payment-methods-integration.md +164 -164
  134. package/dist/skills/fluentcart-developer/references/restapi/checkout.md +573 -573
  135. package/dist/skills/fluentcart-developer/references/restapi/coupons.md +958 -958
  136. package/dist/skills/fluentcart-developer/references/restapi/customer-profile.md +1423 -1423
  137. package/dist/skills/fluentcart-developer/references/restapi/customers.md +1103 -1103
  138. package/dist/skills/fluentcart-developer/references/restapi/dashboard.md +1083 -1083
  139. package/dist/skills/fluentcart-developer/references/restapi/data-export.md +132 -132
  140. package/dist/skills/fluentcart-developer/references/restapi/email-notifications.md +846 -846
  141. package/dist/skills/fluentcart-developer/references/restapi/files.md +313 -313
  142. package/dist/skills/fluentcart-developer/references/restapi/index.md +127 -127
  143. package/dist/skills/fluentcart-developer/references/restapi/integrations.md +1000 -1000
  144. package/dist/skills/fluentcart-developer/references/restapi/inventory.md +192 -192
  145. package/dist/skills/fluentcart-developer/references/restapi/labels-and-attributes.md +797 -797
  146. package/dist/skills/fluentcart-developer/references/restapi/licensing.md +1733 -1733
  147. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-available-shipping-methods.md +30 -30
  148. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-checkout-summary.md +28 -28
  149. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-country-info.md +29 -29
  150. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-order-info.md +28 -28
  151. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-shipping-methods-list-view.md +30 -30
  152. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/login.md +66 -66
  153. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/place-order.md +179 -179
  154. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/apply-coupon.md +83 -83
  155. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/cancel-coupon.md +87 -87
  156. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/check-product-eligibility.md +59 -59
  157. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/create-coupon.md +230 -230
  158. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/delete-coupon.md +29 -29
  159. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/get-coupon-settings.md +20 -20
  160. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/get-coupon.md +27 -27
  161. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/list-coupon-codes.md +20 -20
  162. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/list-coupons.md +37 -37
  163. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/re-apply-coupons.md +75 -75
  164. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/store-coupon-settings.md +40 -40
  165. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/update-coupon.md +133 -133
  166. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/create-address-checkout.md +138 -138
  167. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/create-profile-address.md +119 -119
  168. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/dashboard-overview.md +22 -22
  169. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/delete-profile-address.md +46 -46
  170. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-order-details.md +30 -30
  171. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-portal-sections.md +29 -29
  172. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-profile-details.md +22 -22
  173. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-transaction-billing-address.md +30 -30
  174. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-upgrade-paths.md +31 -31
  175. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/list-downloads.md +29 -29
  176. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/list-orders.md +28 -28
  177. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/make-profile-address-primary.md +55 -55
  178. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/pause-subscription.md +29 -29
  179. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/resume-subscription.md +29 -29
  180. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/save-transaction-billing-address.md +92 -92
  181. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/select-address-for-checkout.md +32 -32
  182. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/update-profile-address.md +115 -115
  183. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/update-profile-details.md +69 -69
  184. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/attach-user.md +50 -50
  185. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/bulk-actions.md +65 -65
  186. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/create-address.md +135 -135
  187. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/create-customer.md +108 -108
  188. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/delete-address.md +62 -62
  189. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/detach-user.md +28 -28
  190. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/find-customer-order.md +27 -27
  191. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-attachable-users.md +20 -20
  192. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer-addresses.md +28 -28
  193. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer-orders.md +37 -37
  194. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer-stats.md +27 -27
  195. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer.md +32 -32
  196. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/list-customers.md +37 -37
  197. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/recalculate-ltv.md +28 -28
  198. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/set-primary-address.md +72 -72
  199. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/update-additional-info.md +55 -55
  200. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/update-address.md +144 -144
  201. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/update-customer.md +123 -123
  202. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/attach-note-to-order.md +49 -49
  203. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/create-all-pages.md +21 -21
  204. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/create-single-page.md +55 -55
  205. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/delete-activity.md +28 -28
  206. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-country-info.md +29 -29
  207. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-dashboard-stats.md +22 -22
  208. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-filter-options.md +31 -31
  209. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-onboarding-data.md +20 -20
  210. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-onboarding-settings.md +20 -20
  211. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-print-templates.md +20 -20
  212. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-search-options.md +27 -27
  213. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-widgets.md +28 -28
  214. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/initialize-app.md +20 -20
  215. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/list-activities.md +33 -33
  216. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/list-attachments.md +21 -21
  217. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/list-countries.md +20 -20
  218. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/mark-activity-read.md +53 -53
  219. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/run-data-backfills.md +21 -21
  220. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/save-onboarding-settings.md +54 -54
  221. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/save-onboarding-tax-settings.md +73 -73
  222. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/save-print-templates.md +64 -64
  223. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/upload-attachment.md +42 -42
  224. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-customers-batch.md +129 -129
  225. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-licenses-batch.md +133 -133
  226. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-orders-batch.md +129 -129
  227. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-subscriptions-batch.md +129 -129
  228. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-customers-export-schema.md +21 -21
  229. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-licenses-export-schema.md +26 -26
  230. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-orders-export-schema.md +21 -21
  231. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-subscriptions-export-schema.md +21 -21
  232. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/enable-notification.md +57 -57
  233. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-digest-settings.md +22 -22
  234. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-notification.md +30 -30
  235. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-reminders.md +22 -22
  236. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-settings.md +22 -22
  237. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-shortcodes.md +22 -22
  238. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/list-notifications.md +20 -20
  239. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/preview-default-template.md +66 -66
  240. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/preview-notification.md +50 -50
  241. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/save-digest-settings.md +101 -101
  242. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/save-reminders.md +162 -162
  243. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/save-settings.md +99 -99
  244. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/send-digest-test.md +47 -47
  245. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/send-manual-reminder.md +51 -51
  246. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/update-notification.md +93 -93
  247. package/dist/skills/fluentcart-developer/references/restapi/operations/files/delete-file.md +31 -31
  248. package/dist/skills/fluentcart-developer/references/restapi/operations/files/get-bucket-list.md +28 -28
  249. package/dist/skills/fluentcart-developer/references/restapi/operations/files/list-files.md +30 -30
  250. package/dist/skills/fluentcart-developer/references/restapi/operations/files/upload-editor-file.md +32 -32
  251. package/dist/skills/fluentcart-developer/references/restapi/operations/files/upload-file.md +34 -34
  252. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/chained-data-request.md +46 -46
  253. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/change-feed-status.md +51 -51
  254. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/delete-feed.md +27 -27
  255. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-dynamic-options.md +29 -29
  256. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-feed-lists.md +27 -27
  257. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-feed-settings.md +27 -27
  258. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-global-feeds.md +20 -20
  259. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-global-settings.md +26 -26
  260. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/install-addon-plugin.md +49 -49
  261. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/list-addons.md +20 -20
  262. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/save-feed-settings.md +52 -52
  263. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/set-global-settings.md +50 -50
  264. package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/bulk-update-stock.md +94 -94
  265. package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/export-inventory.md +81 -81
  266. package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/get-adjustment-history.md +26 -26
  267. package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/get-inventory-stats.md +21 -21
  268. package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/list-inventory.md +33 -33
  269. package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/update-stock.md +75 -75
  270. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/create-attribute-group.md +31 -31
  271. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/create-label.md +31 -31
  272. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/create-terms.md +90 -90
  273. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/delete-attribute-group.md +28 -28
  274. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/delete-attribute-term.md +29 -29
  275. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/get-attribute-group.md +28 -28
  276. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/get-attribute-library.md +20 -20
  277. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/list-attribute-groups.md +32 -32
  278. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/list-attribute-terms.md +33 -33
  279. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/list-labels.md +20 -20
  280. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/reorder-groups.md +51 -51
  281. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/reorder-terms.md +56 -56
  282. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/update-attribute-group.md +37 -37
  283. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/update-attribute-term.md +39 -39
  284. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/update-label-selections.md +32 -32
  285. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/activate-plugin-license.md +41 -41
  286. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/activate-site-admin.md +60 -60
  287. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/deactivate-plugin-license.md +18 -18
  288. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/deactivate-site-admin.md +67 -67
  289. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/deactivate-site-customer.md +47 -47
  290. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/delete-license.md +24 -24
  291. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/extend-license-validity.md +47 -47
  292. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-customer-license-details.md +25 -25
  293. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-customer-licenses-admin.md +26 -26
  294. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-license-activations.md +25 -25
  295. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-license-details.md +25 -25
  296. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-license-site.md +30 -30
  297. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-plugin-license-status.md +18 -18
  298. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-product-license-settings.md +24 -24
  299. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/list-customer-licenses.md +25 -25
  300. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/list-license-sites.md +33 -33
  301. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/list-licenses.md +38 -38
  302. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-activate-license.md +54 -54
  303. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-check-license.md +26 -26
  304. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-deactivate-license.md +46 -46
  305. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-download-license-package.md +23 -23
  306. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-get-license-version.md +26 -26
  307. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/regenerate-license-key.md +24 -24
  308. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/save-product-license-settings.md +193 -193
  309. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/update-license-activation-limit.md +53 -53
  310. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/update-license-status.md +52 -52
  311. package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/create-order-bump.md +47 -47
  312. package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/delete-order-bump.md +25 -25
  313. package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/get-order-bump.md +25 -25
  314. package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/list-order-bumps.md +29 -29
  315. package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/update-order-bump.md +141 -141
  316. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/accept-dispute.md +47 -47
  317. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/bulk-actions.md +72 -72
  318. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/calculate-shipping.md +67 -67
  319. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/calculate-tax.md +98 -98
  320. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/change-customer.md +50 -50
  321. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/charge-now.md +29 -29
  322. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-and-change-customer.md +92 -92
  323. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-custom-order-item.md +68 -68
  324. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-order.md +351 -351
  325. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-renewal-now.md +29 -29
  326. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/delete-order.md +28 -28
  327. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/generate-missing-licenses.md +29 -29
  328. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-order-transactions.md +27 -27
  329. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-order.md +27 -27
  330. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-renewal.md +28 -28
  331. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-shipping-methods.md +28 -28
  332. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-single-transaction.md +28 -28
  333. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/list-order-currencies.md +22 -22
  334. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/list-orders.md +42 -42
  335. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/list-renewals.md +28 -28
  336. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/mark-as-paid.md +61 -61
  337. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/price-order.md +135 -135
  338. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/refund-order.md +72 -72
  339. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/resend-renewal-invoice.md +29 -29
  340. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/skip-renewal.md +48 -48
  341. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/sync-order-statuses.md +28 -28
  342. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/sync-pending-transaction.md +29 -29
  343. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-order-address-id.md +60 -60
  344. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-order-address.md +98 -98
  345. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-order.md +172 -172
  346. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-statuses.md +77 -77
  347. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-subscription-details.md +84 -84
  348. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-transaction-status.md +51 -51
  349. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/void-renewal.md +30 -30
  350. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/create-pdf-template.md +42 -42
  351. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/delete-pdf-template.md +26 -26
  352. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/download-pdf-preview.md +44 -44
  353. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-factory-default-templates.md +19 -19
  354. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-pdf-status.md +21 -21
  355. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-pdf-template.md +26 -26
  356. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-saved-templates.md +21 -21
  357. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-seller-details.md +19 -19
  358. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/list-pdf-templates.md +19 -19
  359. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/save-pdf-template.md +53 -53
  360. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/save-seller-details.md +97 -97
  361. package/dist/skills/fluentcart-developer/references/restapi/operations/products/add-product-terms.md +64 -64
  362. package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-edit-fetch.md +30 -30
  363. package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-insert-products.md +62 -62
  364. package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-update-products.md +59 -59
  365. package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-update-variants.md +83 -83
  366. package/dist/skills/fluentcart-developer/references/restapi/operations/products/change-integration-status.md +64 -64
  367. package/dist/skills/fluentcart-developer/references/restapi/operations/products/create-dummy-products.md +45 -45
  368. package/dist/skills/fluentcart-developer/references/restapi/operations/products/create-product.md +81 -81
  369. package/dist/skills/fluentcart-developer/references/restapi/operations/products/create-variation.md +181 -181
  370. package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-downloadable-file.md +27 -27
  371. package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-product-integration.md +30 -30
  372. package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-product.md +27 -27
  373. package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-taxonomy-term.md +55 -55
  374. package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-upgrade-path.md +27 -27
  375. package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-variation.md +27 -27
  376. package/dist/skills/fluentcart-developer/references/restapi/operations/products/do-bulk-action.md +56 -56
  377. package/dist/skills/fluentcart-developer/references/restapi/operations/products/duplicate-product.md +56 -56
  378. package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-products-by-ids.md +26 -26
  379. package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-taxonomy-terms.md +20 -20
  380. package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-terms-by-parent.md +60 -60
  381. package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-variations-by-ids.md +26 -26
  382. package/dist/skills/fluentcart-developer/references/restapi/operations/products/find-subscription-variants.md +26 -26
  383. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-bundle-info.md +27 -27
  384. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-downloadable-url.md +27 -27
  385. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-max-excerpt-word-count.md +20 -20
  386. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-pricing-widgets.md +27 -27
  387. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product-integration-feeds.md +29 -29
  388. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product-integration-settings.md +31 -31
  389. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product-pricing.md +28 -28
  390. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product.md +28 -28
  391. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-related-products.md +31 -31
  392. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-upgrade-settings.md +27 -27
  393. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-variation-upgrade-paths.md +28 -28
  394. package/dist/skills/fluentcart-developer/references/restapi/operations/products/group-bulk-update-variants.md +103 -103
  395. package/dist/skills/fluentcart-developer/references/restapi/operations/products/list-all-variants.md +26 -26
  396. package/dist/skills/fluentcart-developer/references/restapi/operations/products/list-product-variations.md +26 -26
  397. package/dist/skills/fluentcart-developer/references/restapi/operations/products/list-products.md +34 -34
  398. package/dist/skills/fluentcart-developer/references/restapi/operations/products/remove-shipping-class.md +27 -27
  399. package/dist/skills/fluentcart-developer/references/restapi/operations/products/remove-tax-class.md +27 -27
  400. package/dist/skills/fluentcart-developer/references/restapi/operations/products/save-bundle-info.md +56 -56
  401. package/dist/skills/fluentcart-developer/references/restapi/operations/products/save-product-integration.md +62 -62
  402. package/dist/skills/fluentcart-developer/references/restapi/operations/products/save-upgrade-path.md +78 -78
  403. package/dist/skills/fluentcart-developer/references/restapi/operations/products/search-product-variant-options.md +29 -29
  404. package/dist/skills/fluentcart-developer/references/restapi/operations/products/search-products-by-name.md +28 -28
  405. package/dist/skills/fluentcart-developer/references/restapi/operations/products/search-variants-by-name.md +28 -28
  406. package/dist/skills/fluentcart-developer/references/restapi/operations/products/set-variation-media.md +74 -74
  407. package/dist/skills/fluentcart-developer/references/restapi/operations/products/suggest-sku.md +28 -28
  408. package/dist/skills/fluentcart-developer/references/restapi/operations/products/sync-downloadable-files.md +134 -134
  409. package/dist/skills/fluentcart-developer/references/restapi/operations/products/sync-taxonomy-terms.md +61 -61
  410. package/dist/skills/fluentcart-developer/references/restapi/operations/products/toggle-product-tax-exemption.md +56 -56
  411. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-downloadable-file.md +98 -98
  412. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-inventory.md +56 -56
  413. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-long-desc-editor-mode.md +49 -49
  414. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-manage-stock.md +53 -53
  415. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-product-detail.md +58 -58
  416. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-product-pricing.md +225 -225
  417. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-shipping-class.md +49 -49
  418. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-tax-class.md +49 -49
  419. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-upgrade-path.md +78 -78
  420. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variant-option.md +79 -79
  421. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variant-tax-exemption.md +56 -56
  422. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variation-pricing-table.md +49 -49
  423. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variation.md +105 -105
  424. package/dist/skills/fluentcart-developer/references/restapi/operations/public-shop/get-product-views.md +34 -34
  425. package/dist/skills/fluentcart-developer/references/restapi/operations/public-shop/list-products.md +42 -42
  426. package/dist/skills/fluentcart-developer/references/restapi/operations/public-shop/search-products.md +30 -30
  427. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/channel-rules.md +24 -24
  428. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/country-heat-map.md +22 -22
  429. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/coupon-overview.md +37 -37
  430. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/coupons.md +36 -36
  431. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-insights.md +31 -31
  432. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-overview.md +36 -36
  433. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-repeat.md +35 -35
  434. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-segment-customers.md +36 -36
  435. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-segments.md +30 -30
  436. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-value.md +34 -34
  437. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/dashboard-stats.md +30 -30
  438. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/failed-orders.md +34 -34
  439. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-new-vs-returning-customer.md +34 -34
  440. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-report-by-day-and-hour.md +34 -34
  441. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-report-meta.md +29 -29
  442. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-top-sold-products.md +34 -34
  443. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/future-renewals.md +31 -31
  444. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/generate-retention-snapshots.md +24 -24
  445. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-overview.md +30 -30
  446. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-recent-activities.md +26 -26
  447. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-recent-orders.md +20 -20
  448. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-revenue.md +37 -37
  449. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/installments-at-risk.md +35 -35
  450. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/installments-variations.md +33 -33
  451. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/installments.md +33 -33
  452. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/item-count-distribution.md +34 -34
  453. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/license-chart.md +30 -30
  454. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/license-pie-chart.md +22 -22
  455. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/license-summary.md +22 -22
  456. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/locations.md +43 -43
  457. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-chart.md +37 -37
  458. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-completion-time.md +34 -34
  459. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-mix.md +34 -34
  460. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-value-distribution.md +34 -34
  461. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/payment-methods-disputes.md +38 -38
  462. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/payment-methods-methods.md +36 -36
  463. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/payment-methods.md +37 -37
  464. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-comparison-launch.md +33 -33
  465. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-comparison.md +40 -40
  466. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-detail.md +37 -37
  467. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-sales.md +37 -37
  468. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/refunds-overview.md +37 -37
  469. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/retention-snapshots-step.md +45 -45
  470. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/sales-growth-chart.md +35 -35
  471. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/save-channel-rules.md +73 -73
  472. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/source-channels.md +37 -37
  473. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/sources.md +49 -49
  474. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-cohorts.md +33 -33
  475. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-health.md +30 -30
  476. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-rebuys.md +37 -37
  477. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-retention.md +34 -34
  478. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-variations.md +22 -22
  479. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscriptions-overview.md +37 -37
  480. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/weeks-between-refund.md +34 -34
  481. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/assign-role.md +48 -48
  482. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/delete-role-assignment.md +47 -47
  483. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/get-role.md +25 -25
  484. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/list-managers.md +18 -18
  485. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/list-roles.md +18 -18
  486. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/search-users.md +25 -25
  487. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/update-role.md +43 -43
  488. package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/create-saved-view.md +106 -106
  489. package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/delete-saved-view.md +26 -26
  490. package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/list-saved-views.md +25 -25
  491. package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/update-saved-view.md +83 -83
  492. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/activate-payment-addon.md +44 -44
  493. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/activate-plugin-addon.md +44 -44
  494. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/change-storage-driver-status.md +56 -56
  495. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/check-paypal-webhook.md +26 -26
  496. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/create-storage-bucket.md +63 -63
  497. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/disconnect-payment-method.md +55 -55
  498. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/exchange-paypal-seller-auth-token.md +62 -62
  499. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-active-storage-drivers.md +20 -20
  500. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-checkout-fields.md +22 -22
  501. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-email-shortcodes.md +20 -20
  502. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-mcp-config-snippets.md +26 -26
  503. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-mcp-status.md +20 -20
  504. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-module-settings.md +20 -20
  505. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-payment-method-connection-info.md +26 -26
  506. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-payment-method-settings.md +26 -26
  507. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-permissions.md +22 -22
  508. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-plugin-addons.md +20 -20
  509. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-storage-driver-settings.md +27 -27
  510. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-store-settings.md +26 -26
  511. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/install-mcp-adapter.md +21 -21
  512. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/install-payment-addon.md +60 -60
  513. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/install-plugin-addon.md +64 -64
  514. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/list-all-payment-methods.md +20 -20
  515. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/list-all-storage-drivers.md +20 -20
  516. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/list-storage-buckets.md +67 -67
  517. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/reorder-payment-methods.md +55 -55
  518. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/reset-storage-driver-settings.md +45 -45
  519. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-checkout-fields.md +133 -133
  520. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-confirmation-settings.md +68 -68
  521. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-module-settings.md +68 -68
  522. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-payment-method-design.md +67 -67
  523. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-payment-method-settings.md +58 -58
  524. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-permissions.md +68 -68
  525. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-storage-driver-settings.md +62 -62
  526. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-store-settings.md +239 -239
  527. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/setup-paypal-webhook.md +48 -48
  528. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/toggle-mcp.md +40 -40
  529. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/verify-storage-driver-connection.md +62 -62
  530. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/verify-turnstile-keys.md +55 -55
  531. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/create-shipping-class.md +73 -73
  532. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/create-shipping-method.md +110 -110
  533. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/create-shipping-zone.md +56 -56
  534. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/delete-shipping-class.md +29 -29
  535. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/delete-shipping-method.md +29 -29
  536. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/delete-shipping-zone.md +29 -29
  537. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-class-profile.md +30 -30
  538. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-class.md +29 -29
  539. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-packages.md +22 -22
  540. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-zone.md +27 -27
  541. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-zone-countries.md +22 -22
  542. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-zone-states.md +28 -28
  543. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/list-shipping-classes.md +31 -31
  544. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/list-shipping-zones.md +31 -31
  545. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/save-shipping-packages.md +112 -112
  546. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-shipping-class.md +79 -79
  547. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-shipping-method.md +113 -113
  548. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-shipping-zone.md +62 -62
  549. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-zone-order.md +52 -52
  550. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/cancel-auto-renew.md +30 -30
  551. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/cancel-subscription.md +52 -52
  552. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/confirm-subscription-switch.md +70 -70
  553. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/fetch-subscription-remote.md +28 -28
  554. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/generate-early-payment-link.md +29 -29
  555. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-customer-subscription.md +27 -27
  556. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-or-create-plan.md +69 -69
  557. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-setup-intent-attempts.md +30 -30
  558. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-subscription.md +28 -28
  559. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/initiate-early-payment.md +31 -31
  560. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/list-customer-subscriptions.md +27 -27
  561. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/list-subscriptions.md +39 -39
  562. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/pause-subscription.md +28 -28
  563. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/reactivate-subscription.md +28 -28
  564. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/resume-subscription.md +28 -28
  565. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/switch-payment-method.md +70 -70
  566. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/update-payment-method.md +69 -69
  567. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/update-vendor-ids.md +56 -56
  568. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/verify-vendor-ids.md +56 -56
  569. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/create-tax-class.md +51 -51
  570. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/create-tax-rate.md +117 -117
  571. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-product-override.md +27 -27
  572. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-shipping-tax-override.md +27 -27
  573. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-tax-class.md +28 -28
  574. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-tax-rate.md +27 -27
  575. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-country-tax-id.md +27 -27
  576. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-country-tax-rates.md +28 -28
  577. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-eu-vat-product-overrides.md +20 -20
  578. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-oss-country-rates.md +20 -20
  579. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-preconfigured-tax-rates.md +20 -20
  580. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-product-overrides.md +27 -27
  581. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-tax-settings.md +20 -20
  582. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/list-all-tax-rates.md +20 -20
  583. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/list-tax-classes.md +20 -20
  584. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/list-tax-records.md +37 -37
  585. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/mark-taxes-as-filed.md +58 -58
  586. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/reset-eu-vat-rates.md +21 -21
  587. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-configured-countries.md +57 -57
  588. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-country-tax-id.md +50 -50
  589. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-eu-vat-cross-border-settings.md +127 -127
  590. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-oss-country-rates.md +100 -100
  591. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-product-override.md +110 -110
  592. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-shipping-tax-override.md +52 -52
  593. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-tax-settings.md +166 -166
  594. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/update-country-status.md +54 -54
  595. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/update-tax-rate.md +116 -116
  596. package/dist/skills/fluentcart-developer/references/restapi/order-bumps.md +433 -433
  597. package/dist/skills/fluentcart-developer/references/restapi/orders.md +1212 -1212
  598. package/dist/skills/fluentcart-developer/references/restapi/pdf-templates.md +212 -212
  599. package/dist/skills/fluentcart-developer/references/restapi/products.md +2485 -2485
  600. package/dist/skills/fluentcart-developer/references/restapi/public-shop.md +191 -191
  601. package/dist/skills/fluentcart-developer/references/restapi/reports.md +3773 -3773
  602. package/dist/skills/fluentcart-developer/references/restapi/roles.md +403 -403
  603. package/dist/skills/fluentcart-developer/references/restapi/saved-views.md +136 -136
  604. package/dist/skills/fluentcart-developer/references/restapi/settings.md +1423 -1423
  605. package/dist/skills/fluentcart-developer/references/restapi/shipping.md +905 -905
  606. package/dist/skills/fluentcart-developer/references/restapi/subscriptions.md +1169 -1169
  607. package/dist/skills/fluentcart-developer/references/restapi/tax.md +1551 -1551
  608. package/dist/skills/fluentcart-developer/references/restapi.md +127 -127
  609. package/dist/skills/fluentcart-developer/scripts/cli.js +1 -1
  610. package/dist/version.d.ts +1 -1
  611. package/dist/version.js +1 -1
  612. package/package.json +66 -65
@@ -1,727 +1,727 @@
1
- # Order Model
2
-
3
- | DB Table Name | {wp_db_prefix}_fct_orders |
4
- | --- | --- |
5
- | Schema | [Check Schema](/database/schema.md#fct-orders-table) |
6
- | Source File | fluent-cart/app/Models/Order.php |
7
- | Name Space | FluentCart\App\Models |
8
- | Class | FluentCart\App\Models\Order |
9
-
10
- ## Traits
11
-
12
- `CanSearch`, `HasActivity` and `CanUpdateBatch`. `HasActivity` supplies the `activities` relation; `CanSearch` supplies the search scopes; `CanUpdateBatch` supplies `Order::batchUpdate()`.
13
-
14
- ## Attributes
15
-
16
- | Attribute | Data Type | Comment |
17
- | --- | --- | --- |
18
- | id | Integer | Primary Key |
19
- | status | String | Order status (draft, pending, processing, completed, etc.) |
20
- | parent_id | Integer | Parent order ID (for renewals/child orders) |
21
- | receipt_number | Integer | Receipt number |
22
- | invoice_no | String | Invoice number |
23
- | fulfillment_type | String | Fulfillment type (physical, digital) |
24
- | type | String | Order type (subscription, renewal, etc.) |
25
- | mode | String | Order mode (live, test) |
26
- | shipping_status | String | Shipping status |
27
- | customer_id | Integer | Customer ID (cast to integer) |
28
- | payment_method | String | Payment method |
29
- | payment_status | String | Payment status |
30
- | payment_method_title | String | Payment method title |
31
- | currency | String | Currency code |
32
- | fee_total | Double | Surcharges on the order, in cents (cast to double) |
33
- | rate | Decimal | DECIMAL(24,12) base-to-presentment exchange rate, frozen at order time |
34
- | tax_behavior | Integer | Cast to integer |
35
- | subtotal | Integer | Subtotal in cents (cast to double) |
36
- | discount_tax | Integer | Discount tax in cents (cast to double) |
37
- | manual_discount_total | Integer | Manual discount total in cents (cast to double) |
38
- | coupon_discount_total | Integer | Coupon discount total in cents (cast to double) |
39
- | shipping_tax | Integer | Shipping tax in cents (cast to double) |
40
- | shipping_total | Integer | Shipping total in cents (cast to double) |
41
- | tax_total | Integer | Tax total in cents (cast to double) |
42
- | total_amount | Integer | Total amount in cents (cast to double) |
43
- | total_paid | Integer | Total paid in cents |
44
- | total_refund | Integer | Total refund in cents |
45
- | rate | Decimal | Exchange rate |
46
- | tax_behavior | Integer | Tax behavior (0=no_tax, 1=exclusive, 2=inclusive) |
47
- | note | Text | Order notes |
48
- | ip_address | Text | Customer IP address |
49
- | completed_at | Date Time | Completion timestamp |
50
- | refunded_at | Date Time | Refund timestamp |
51
- | uuid | String | Unique identifier |
52
- | config | JSON | Order configuration (auto-encoded/decoded via accessor/mutator) |
53
- | created_at | Date Time | Creation timestamp |
54
- | updated_at | Date Time | Last update timestamp |
55
-
56
- ## Usage
57
-
58
- Please check [Model Basic](/database/models.md) for Common methods.
59
-
60
- ### Accessing Attributes
61
-
62
- ```
63
- $order = FluentCart\App\Models\Order::find(1);
64
-
65
- $order->id; // returns order ID
66
- $order->status; // returns order status
67
- $order->total_amount; // returns total amount in cents
68
- $order->currency; // returns currency code
69
- $order->customer_id; // returns customer ID
70
- ```
71
-
72
- ## Methods
73
-
74
- Along with Global Model methods, this model has few helper methods.
75
-
76
- ### updateStatus($key, $newStatus)
77
-
78
- Set the given status column and save. Returns early without saving when the value has not changed. Stamps `completed_at` when `status` becomes `completed`, and `refunded_at` when `payment_status` becomes `refunded`. It fires no hooks — use `StatusHelper` when listeners should run.
79
-
80
- - Parameters: `$key` (String) - the status column, `status` or `payment_status`, `$newStatus` (String) - New status
81
- - Returns `FluentCart\App\Models\Order` - the order instance
82
-
83
- ```
84
- $order = FluentCart\App\Models\Order::find(1);
85
- $order->updateStatus('status', 'completed');
86
- ```
87
-
88
- ### updatePaymentStatus($newStatus)
89
-
90
- Update payment status
91
-
92
- - Parameters: `$newStatus` (String) - New payment status
93
- - Returns `FluentCart\App\Models\Order` - Updated order instance
94
-
95
- ```
96
- $order = FluentCart\App\Models\Order::find(1);
97
- $order->updatePaymentStatus('paid');
98
- ```
99
-
100
- ### getMeta($metaKey, $defaultValue = false)
101
-
102
- Get order meta value
103
-
104
- - Parameters: `$metaKey` (String) - Meta key, `$defaultValue` (Mixed) - Default value
105
- - Returns `Mixed` - Meta value or default
106
-
107
- ```
108
- $order = FluentCart\App\Models\Order::find(1);
109
- $metaValue = $order->getMeta('custom_field', 'default');
110
- ```
111
-
112
- ### updateMeta($metaKey, $value)
113
-
114
- Update order meta value
115
-
116
- - Parameters: `$metaKey` (String) - Meta key, `$value` (Mixed) - Meta value
117
- - Returns `FluentCart\App\Models\OrderMeta` - Meta instance
118
-
119
- ```
120
- $order = FluentCart\App\Models\Order::find(1);
121
- $meta = $order->updateMeta('custom_field', 'new_value');
122
- ```
123
-
124
- ### deleteMeta($metaKey)
125
-
126
- Delete order meta
127
-
128
- - Parameters: `$metaKey` (String) - Meta key
129
- - Returns `Boolean` - True if deleted
130
-
131
- ```
132
- $order = FluentCart\App\Models\Order::find(1);
133
- $deleted = $order->deleteMeta('custom_field');
134
- ```
135
-
136
- ### getTotalPaidAmount()
137
-
138
- Get total paid amount from succeeded transactions
139
-
140
- - Returns `Integer` - Total paid amount in cents
141
-
142
- ```
143
- $order = FluentCart\App\Models\Order::find(1);
144
- $totalPaid = $order->getTotalPaidAmount();
145
- ```
146
-
147
- ### getTotalRefundAmount()
148
-
149
- Get total refund amount from refunded transactions
150
-
151
- - Returns `Integer` - Total refund amount in cents
152
-
153
- ```
154
- $order = FluentCart\App\Models\Order::find(1);
155
- $totalRefund = $order->getTotalRefundAmount();
156
- ```
157
-
158
- ### recountTotalPaidAndRefund()
159
-
160
- Recount total paid and refund amounts. Updates `total_refund` and sets `payment_status` to refunded or partially refunded as appropriate.
161
-
162
- - Returns `FluentCart\App\Models\Order` - Updated order instance
163
-
164
- ```
165
- $order = FluentCart\App\Models\Order::find(1);
166
- $order->recountTotalPaidAndRefund();
167
- ```
168
-
169
- ### syncOrderAfterRefund($type, $refundedAmount)
170
-
171
- Sync order after refund
172
-
173
- - Parameters: `$type` (String) - Refund type ('full' or 'partial'), `$refundedAmount` (Integer) - Refund amount
174
- - Returns `FluentCart\App\Models\Order` - Updated order instance
175
-
176
- ```
177
- $order = FluentCart\App\Models\Order::find(1);
178
- $order->syncOrderAfterRefund('full', 1000);
179
- ```
180
-
181
- ### updateRefundedItems($refundedItemIds, $refundedAmount)
182
-
183
- Update refunded items. Distributes refund amount proportionally across the specified order items.
184
-
185
- - Parameters: `$refundedItemIds` (Array) - Order item IDs, `$refundedAmount` (Integer) - Refund amount
186
-
187
- ```
188
- $order = FluentCart\App\Models\Order::find(1);
189
- $order->updateRefundedItems([1, 2, 3], 1000);
190
- ```
191
-
192
- ### recountTotalPaid()
193
-
194
- Recount total paid amount (paid minus refunded)
195
-
196
- - Returns `FluentCart\App\Models\Order` - Updated order instance
197
-
198
- ```
199
- $order = FluentCart\App\Models\Order::find(1);
200
- $order->recountTotalPaid();
201
- ```
202
-
203
- ### getLatestTransactionAttribute()
204
-
205
- Get latest non-refund transaction (accessor, accessed as `latest_transaction` attribute)
206
-
207
- - Returns `FluentCart\App\Models\OrderTransaction|null` - Latest transaction
208
-
209
- ```
210
- $order = FluentCart\App\Models\Order::find(1);
211
- $transaction = $order->latest_transaction;
212
- ```
213
-
214
- ### isSubscription()
215
-
216
- Check if order is subscription
217
-
218
- - Returns `Boolean` - True if order has subscription items
219
-
220
- ```
221
- $order = FluentCart\App\Models\Order::find(1);
222
- $isSubscription = $order->isSubscription();
223
- ```
224
-
225
- ### getViewUrl($type = 'customer')
226
-
227
- Get order view URL
228
-
229
- - Parameters: `$type` (String) - View type ('customer' or 'admin')
230
- - Returns `String` - View URL
231
-
232
- ```
233
- $order = FluentCart\App\Models\Order::find(1);
234
- $viewUrl = $order->getViewUrl('admin');
235
- ```
236
-
237
- ### getLatestTransaction()
238
-
239
- Get latest non-refund transaction (method call, unlike the accessor attribute)
240
-
241
- - Returns `FluentCart\App\Models\OrderTransaction|null` - Latest transaction
242
-
243
- ```
244
- $order = FluentCart\App\Models\Order::find(1);
245
- $transaction = $order->getLatestTransaction();
246
- ```
247
-
248
- ### currentSubscription()
249
-
250
- Get current active subscription for this order
251
-
252
- - Returns `FluentCart\App\Models\Subscription|null` - Current active subscription
253
-
254
- ```
255
- $order = FluentCart\App\Models\Order::find(1);
256
- $subscription = $order->currentSubscription();
257
- ```
258
-
259
- ### getDownloads($scope = 'email')
260
-
261
- Get order downloads. Returns downloadable files associated with the order items, filtered by product variation authorization.
262
-
263
- - Parameters: `$scope` (String) - Download scope
264
- - Returns `Array` - Download data
265
-
266
- ```
267
- $order = FluentCart\App\Models\Order::find(1);
268
- $downloads = $order->getDownloads('email');
269
- ```
270
-
271
- ### getLicenses($with = ['product', 'productVariant'])
272
-
273
- Get order licenses (requires Pro and active license module)
274
-
275
- - Parameters: `$with` (Array) - Relationships to eager load (default: `['product', 'productVariant']`)
276
- - Returns `Illuminate\Database\Eloquent\Collection|null` - Licenses collection or null if module inactive
277
-
278
- ```
279
- $order = FluentCart\App\Models\Order::find(1);
280
- $licenses = $order->getLicenses(['product', 'productVariant']);
281
- ```
282
-
283
- ### getDownloadsById($orderId)
284
-
285
- Get downloads for a specific order by ID
286
-
287
- - Parameters: `$orderId` (Integer) - Order ID
288
- - Returns `Array` - Download data
289
-
290
- ```
291
- $order = FluentCart\App\Models\Order::find(1);
292
- $downloads = $order->getDownloadsById(42);
293
- ```
294
-
295
- ### getReceiptViewUrl() and getReceiptDownloadUrl()
296
-
297
- Build the customer-facing receipt links — one to view the receipt in the browser, one to download it.
298
-
299
- - Returns `String`
300
-
301
- ```
302
- $order = FluentCart\App\Models\Order::find(1);
303
-
304
- $view = $order->getReceiptViewUrl();
305
- $download = $order->getReceiptDownloadUrl();
306
- ```
307
-
308
- ### addLog($title, $description = '', $type = 'info', $by = '')
309
-
310
- Add order log
311
-
312
- - Parameters: `$title` (String) - Log title, `$description` (String) - Description, `$type` (String) - Log type, `$by` (String) - Created by
313
-
314
- ```
315
- $order = FluentCart\App\Models\Order::find(1);
316
- $order->addLog('Status Updated', 'Order status changed to completed', 'info', 'admin');
317
- ```
318
-
319
- ### canBeRefunded()
320
-
321
- Check if order can be refunded. Returns false if the order has been upgraded to another order.
322
-
323
- - Returns `Boolean` - True if order can be refunded
324
-
325
- ```
326
- $order = FluentCart\App\Models\Order::find(1);
327
- $canBeRefunded = $order->canBeRefunded();
328
- ```
329
-
330
- ### generateReceiptNumber()
331
-
332
- Claims the next receipt number atomically, so concurrent requests cannot take the same one. A losing request discards its candidate, which means the sequence can contain gaps. Fires `fluent_cart/order/invoice_number_added` once a number is assigned.
333
-
334
- Generate receipt number and invoice number if not already set
335
-
336
- - Returns `FluentCart\App\Models\Order` - Updated order instance
337
-
338
- ```
339
- $order = FluentCart\App\Models\Order::find(1);
340
- $order->generateReceiptNumber();
341
- ```
342
-
343
- ### canBeDeleted()
344
-
345
- Check if order can be deleted. Test-mode orders can always be deleted. For live orders:
346
-
347
- - the status must be `canceled` or `on-hold`, otherwise a `WP_Error` names the status
348
- - a successfully-paid order is blocked unless its `total_amount` is `0`, so free and unpaid cancelled orders delete but a paid one does not
349
- - an order of `type = 'subscription'` is blocked while a subscription on its `parent_order_id` is still `active`
350
-
351
- The result passes through the `fluent_cart/order_can_be_deleted` filter, so an integration can relax or tighten any of it.
352
-
353
- - Returns `Boolean|WP_Error` - True if order can be deleted, or WP_Error with reason
354
-
355
- ```
356
- $order = FluentCart\App\Models\Order::find(1);
357
- $canBeDeleted = $order->canBeDeleted();
358
- if (is_wp_error($canBeDeleted)) {
359
- echo $canBeDeleted->get_error_message();
360
- }
361
- ```
362
-
363
- ### Items and fees
364
-
365
- | Method | Returns |
366
- | --- | --- |
367
- | `getProductItems()` | the order's product line items, excluding fee lines |
368
- | `getAppliedFees()` | applied fees as a plain array, for display |
369
-
370
- Fee lines are `order_items` rows with `payment_type = 'fee'`, also reachable as the `feeItems` relation.
371
-
372
- ### Review links
373
-
374
- | Method | Returns |
375
- | --- | --- |
376
- | `getOrderReviewUrl()` | the review link for this order |
377
- | `Order::reviewUrlForHash($hash)` | the same link built from an order hash, for email and webhook contexts where no order instance is loaded |
378
-
379
- ### Tax and B2B
380
-
381
- Thirteen helpers read the order's frozen tax snapshot rather than recomputing it:
382
-
383
- | Method | Returns |
384
- | --- | --- |
385
- | `getBusinessInfo()` | the buyer's business details |
386
- | `getStoreBusinessInfo()` | five seller fields from the order's `store_business_info` meta snapshot, each falling back to live store settings |
387
- | `isB2BOrder()` | whether the order was placed as a business |
388
- | `getPrimaryOrderTaxRate()` | the main tax rate applied |
389
- | `getReversedTaxTotal()` | tax reversed under a reverse charge |
390
- | `isReverseChargeTaxOrder()` | whether reverse charge applied |
391
- | `getOrderRcMode()` | the reverse-charge mode |
392
- | `getDisplayTaxLines()` | tax lines for display |
393
- | `getDisplayShippingTaxLines()` | shipping tax lines for display |
394
- | `getCustomerTaxNumber()` | the buyer's tax number |
395
- | `hasValidatedCustomerTaxNumber()` | whether that number was validated |
396
- | `getCustomerTaxName()` | the label for the buyer's tax number in their country |
397
- | `getMoRVatRemovedAmount()` | VAT removed under a merchant-of-record arrangement |
398
- | `netAmount()` | the order total net of tax |
399
-
400
- ### generateOrderUuid()
401
-
402
- Static. Produces the order's public `uuid`, and runs on the `creating` event, so a new order gets one without the caller doing anything.
403
-
404
- ## Relations
405
-
406
- This model has the following relationships that you can use
407
-
408
- ### parentOrder
409
-
410
- Access the parent order.
411
-
412
- - Returns `FluentCart\App\Models\Order`
413
-
414
- ```
415
- $order = FluentCart\App\Models\Order::find(1);
416
- $parentOrder = $order->parentOrder;
417
- ```
418
-
419
- ### children
420
-
421
- Access the child orders.
422
-
423
- - Returns `Illuminate\Database\Eloquent\Collection` of `FluentCart\App\Models\Order`
424
-
425
- ```
426
- $order = FluentCart\App\Models\Order::find(1);
427
- $children = $order->children;
428
- ```
429
-
430
- ### transactions
431
-
432
- Access the order transactions.
433
-
434
- - Returns `Illuminate\Database\Eloquent\Collection` of `FluentCart\App\Models\OrderTransaction`
435
-
436
- ```
437
- $order = FluentCart\App\Models\Order::find(1);
438
- $transactions = $order->transactions;
439
- ```
440
-
441
- ### subscriptions
442
-
443
- Access the order subscriptions.
444
-
445
- - Returns `Illuminate\Database\Eloquent\Collection` of `FluentCart\App\Models\Subscription`
446
-
447
- ```
448
- $order = FluentCart\App\Models\Order::find(1);
449
- $subscriptions = $order->subscriptions;
450
- ```
451
-
452
- ### order_items
453
-
454
- Access the order items.
455
-
456
- - Returns `Illuminate\Database\Eloquent\Collection` of `FluentCart\App\Models\OrderItem`
457
-
458
- ```
459
- $order = FluentCart\App\Models\Order::find(1);
460
- $items = $order->order_items;
461
- ```
462
-
463
- ### filteredOrderItems
464
-
465
- Access the filtered order items based on priority rules for payment_type (onetime > subscription > adjustment).
466
-
467
- - Returns `Illuminate\Database\Eloquent\Collection` of `FluentCart\App\Models\OrderItem`
468
-
469
- ```
470
- $order = FluentCart\App\Models\Order::find(1);
471
- $filteredItems = $order->filteredOrderItems;
472
- ```
473
-
474
- ### customer
475
-
476
- Access the customer.
477
-
478
- - Returns `FluentCart\App\Models\Customer`
479
-
480
- ```
481
- $order = FluentCart\App\Models\Order::find(1);
482
- $customer = $order->customer;
483
- ```
484
-
485
- ### orderMeta
486
-
487
- Access the order metadata.
488
-
489
- - Returns `Illuminate\Database\Eloquent\Collection` of `FluentCart\App\Models\OrderMeta`
490
-
491
- ```
492
- $order = FluentCart\App\Models\Order::find(1);
493
- $meta = $order->orderMeta;
494
- ```
495
-
496
- ### orderTaxRates
497
-
498
- Access the order tax rates.
499
-
500
- - Returns `Illuminate\Database\Eloquent\Collection` of `FluentCart\App\Models\OrderTaxRate`
501
-
502
- ```
503
- $order = FluentCart\App\Models\Order::find(1);
504
- $taxRates = $order->orderTaxRates;
505
- ```
506
-
507
- ### appliedCoupons
508
-
509
- Access the applied coupons.
510
-
511
- - Returns `Illuminate\Database\Eloquent\Collection` of `FluentCart\App\Models\AppliedCoupon`
512
-
513
- ```
514
- $order = FluentCart\App\Models\Order::find(1);
515
- $appliedCoupons = $order->appliedCoupons;
516
- ```
517
-
518
- ### usedCoupons
519
-
520
- Access the used coupons (through the applied coupons intermediate table).
521
-
522
- - Returns `Illuminate\Database\Eloquent\Collection` of `FluentCart\App\Models\Coupon`
523
-
524
- ```
525
- $order = FluentCart\App\Models\Order::find(1);
526
- $usedCoupons = $order->usedCoupons;
527
- ```
528
-
529
- ### shipping_address
530
-
531
- Access the shipping address.
532
-
533
- - Returns `FluentCart\App\Models\OrderAddress`
534
-
535
- ```
536
- $order = FluentCart\App\Models\Order::find(1);
537
- $address = $order->shipping_address;
538
- ```
539
-
540
- ### billing_address
541
-
542
- Access the billing address.
543
-
544
- - Returns `FluentCart\App\Models\OrderAddress`
545
-
546
- ```
547
- $order = FluentCart\App\Models\Order::find(1);
548
- $address = $order->billing_address;
549
- ```
550
-
551
- ### order_addresses
552
-
553
- Access the order addresses.
554
-
555
- - Returns `Illuminate\Database\Eloquent\Collection` of `FluentCart\App\Models\OrderAddress`
556
-
557
- ```
558
- $order = FluentCart\App\Models\Order::find(1);
559
- $addresses = $order->order_addresses;
560
- ```
561
-
562
- ### licenses
563
-
564
- Access the order licenses.
565
-
566
- - Returns `Illuminate\Database\Eloquent\Collection` of `FluentCartPro\App\Modules\Licensing\Models\License`
567
-
568
- ```
569
- $order = FluentCart\App\Models\Order::find(1);
570
- $licenses = $order->licenses;
571
- ```
572
-
573
- ### labels
574
-
575
- Access the order labels (morph many relationship).
576
-
577
- - Returns `Illuminate\Database\Eloquent\Collection` of `FluentCart\App\Models\LabelRelationship`
578
-
579
- ```
580
- $order = FluentCart\App\Models\Order::find(1);
581
- $labels = $order->labels;
582
- ```
583
-
584
- ### renewals
585
-
586
- Access the order renewals (child orders of type 'renewal', excluding canceled, failed, and on-hold).
587
-
588
- - Returns `Illuminate\Database\Eloquent\Collection` of `FluentCart\App\Models\Order`
589
-
590
- ```
591
- $order = FluentCart\App\Models\Order::find(1);
592
- $renewals = $order->renewals;
593
- ```
594
-
595
- ### orderOperation
596
-
597
- Access the order operation record.
598
-
599
- - Returns `FluentCart\App\Models\OrderOperation`
600
-
601
- ```
602
- $order = FluentCart\App\Models\Order::find(1);
603
- $operation = $order->orderOperation;
604
- ```
605
-
606
- ## Scopes
607
-
608
- This model has the following scopes that you can use
609
-
610
- ### searchBy($search)
611
-
612
- Search orders by query. Searches across order ID, status, total amount, payment status, payment method, invoice number, order item titles, and customer name/email.
613
-
614
- - Parameters: `$search` (String) - Search query
615
-
616
- ```
617
- $orders = FluentCart\App\Models\Order::searchBy('john')->get();
618
- ```
619
-
620
- ### ofPaymentStatus($status)
621
-
622
- Get orders by payment status
623
-
624
- - Parameters: `$status` (String) - Payment status
625
-
626
- ```
627
- $orders = FluentCart\App\Models\Order::ofPaymentStatus('paid')->get();
628
- ```
629
-
630
- ### ofOrderStatus($status)
631
-
632
- Get orders by order status
633
-
634
- - Parameters: `$status` (String) - Order status
635
-
636
- ```
637
- $orders = FluentCart\App\Models\Order::ofOrderStatus('completed')->get();
638
- ```
639
-
640
- ### ofShippingStatus($status)
641
-
642
- Get orders by shipping status
643
-
644
- - Parameters: `$status` (String) - Shipping status
645
-
646
- ```
647
- $orders = FluentCart\App\Models\Order::ofShippingStatus('shipped')->get();
648
- ```
649
-
650
- ### ofOrderType($type)
651
-
652
- Get orders by order type
653
-
654
- - Parameters: `$type` (String) - Order type
655
-
656
- ```
657
- $orders = FluentCart\App\Models\Order::ofOrderType('payment')->get();
658
- ```
659
-
660
- ### ofPaymentMethod($methodName)
661
-
662
- Get orders by payment method
663
-
664
- - Parameters: `$methodName` (String) - Payment method name
665
-
666
- ```
667
- $orders = FluentCart\App\Models\Order::ofPaymentMethod('stripe')->get();
668
- ```
669
-
670
- ### applyCustomFilters($filters)
671
-
672
- Apply custom filters
673
-
674
- - Parameters: `$filters` (Array) - Filter array
675
-
676
- ```
677
- $orders = FluentCart\App\Models\Order::applyCustomFilters([
678
- 'status' => ['value' => ['completed', 'processing']]
679
- ])->get();
680
- ```
681
-
682
- ## Usage Examples
683
-
684
- ### Creating an Order
685
-
686
- ```
687
- use FluentCart\App\Models\Order;
688
-
689
- $order = Order::create([
690
- 'customer_id' => 1,
691
- 'status' => 'pending',
692
- 'payment_method' => 'stripe',
693
- 'currency' => 'USD',
694
- 'total_amount' => 9999 // $99.99 in cents
695
- ]);
696
- ```
697
-
698
- ### Retrieving Orders
699
-
700
- ```
701
- // Get orders by payment status
702
- $orders = Order::ofPaymentStatus('paid')->get();
703
-
704
- // Get order by ID
705
- $order = Order::find(1);
706
-
707
- // Get order with items and customer
708
- $order = Order::with(['order_items', 'customer'])->find(1);
709
- ```
710
-
711
- ### Updating an Order
712
-
713
- ```
714
- $order = Order::find(1);
715
- $order->status = 'completed';
716
- $order->completed_at = now();
717
- $order->save();
718
- ```
719
-
720
- ### Deleting an Order
721
-
722
- ```
723
- $order = Order::find(1);
724
- $order->delete();
725
- ```
726
-
727
- ---
1
+ # Order Model
2
+
3
+ | DB Table Name | {wp_db_prefix}_fct_orders |
4
+ | --- | --- |
5
+ | Schema | [Check Schema](/database/schema.md#fct-orders-table) |
6
+ | Source File | fluent-cart/app/Models/Order.php |
7
+ | Name Space | FluentCart\App\Models |
8
+ | Class | FluentCart\App\Models\Order |
9
+
10
+ ## Traits
11
+
12
+ `CanSearch`, `HasActivity` and `CanUpdateBatch`. `HasActivity` supplies the `activities` relation; `CanSearch` supplies the search scopes; `CanUpdateBatch` supplies `Order::batchUpdate()`.
13
+
14
+ ## Attributes
15
+
16
+ | Attribute | Data Type | Comment |
17
+ | --- | --- | --- |
18
+ | id | Integer | Primary Key |
19
+ | status | String | Order status (draft, pending, processing, completed, etc.) |
20
+ | parent_id | Integer | Parent order ID (for renewals/child orders) |
21
+ | receipt_number | Integer | Receipt number |
22
+ | invoice_no | String | Invoice number |
23
+ | fulfillment_type | String | Fulfillment type (physical, digital) |
24
+ | type | String | Order type (subscription, renewal, etc.) |
25
+ | mode | String | Order mode (live, test) |
26
+ | shipping_status | String | Shipping status |
27
+ | customer_id | Integer | Customer ID (cast to integer) |
28
+ | payment_method | String | Payment method |
29
+ | payment_status | String | Payment status |
30
+ | payment_method_title | String | Payment method title |
31
+ | currency | String | Currency code |
32
+ | fee_total | Double | Surcharges on the order, in cents (cast to double) |
33
+ | rate | Decimal | DECIMAL(24,12) base-to-presentment exchange rate, frozen at order time |
34
+ | tax_behavior | Integer | Cast to integer |
35
+ | subtotal | Integer | Subtotal in cents (cast to double) |
36
+ | discount_tax | Integer | Discount tax in cents (cast to double) |
37
+ | manual_discount_total | Integer | Manual discount total in cents (cast to double) |
38
+ | coupon_discount_total | Integer | Coupon discount total in cents (cast to double) |
39
+ | shipping_tax | Integer | Shipping tax in cents (cast to double) |
40
+ | shipping_total | Integer | Shipping total in cents (cast to double) |
41
+ | tax_total | Integer | Tax total in cents (cast to double) |
42
+ | total_amount | Integer | Total amount in cents (cast to double) |
43
+ | total_paid | Integer | Total paid in cents |
44
+ | total_refund | Integer | Total refund in cents |
45
+ | rate | Decimal | Exchange rate |
46
+ | tax_behavior | Integer | Tax behavior (0=no_tax, 1=exclusive, 2=inclusive) |
47
+ | note | Text | Order notes |
48
+ | ip_address | Text | Customer IP address |
49
+ | completed_at | Date Time | Completion timestamp |
50
+ | refunded_at | Date Time | Refund timestamp |
51
+ | uuid | String | Unique identifier |
52
+ | config | JSON | Order configuration (auto-encoded/decoded via accessor/mutator) |
53
+ | created_at | Date Time | Creation timestamp |
54
+ | updated_at | Date Time | Last update timestamp |
55
+
56
+ ## Usage
57
+
58
+ Please check [Model Basic](/database/models.md) for Common methods.
59
+
60
+ ### Accessing Attributes
61
+
62
+ ```
63
+ $order = FluentCart\App\Models\Order::find(1);
64
+
65
+ $order->id; // returns order ID
66
+ $order->status; // returns order status
67
+ $order->total_amount; // returns total amount in cents
68
+ $order->currency; // returns currency code
69
+ $order->customer_id; // returns customer ID
70
+ ```
71
+
72
+ ## Methods
73
+
74
+ Along with Global Model methods, this model has few helper methods.
75
+
76
+ ### updateStatus($key, $newStatus)
77
+
78
+ Set the given status column and save. Returns early without saving when the value has not changed. Stamps `completed_at` when `status` becomes `completed`, and `refunded_at` when `payment_status` becomes `refunded`. It fires no hooks — use `StatusHelper` when listeners should run.
79
+
80
+ - Parameters: `$key` (String) - the status column, `status` or `payment_status`, `$newStatus` (String) - New status
81
+ - Returns `FluentCart\App\Models\Order` - the order instance
82
+
83
+ ```
84
+ $order = FluentCart\App\Models\Order::find(1);
85
+ $order->updateStatus('status', 'completed');
86
+ ```
87
+
88
+ ### updatePaymentStatus($newStatus)
89
+
90
+ Update payment status
91
+
92
+ - Parameters: `$newStatus` (String) - New payment status
93
+ - Returns `FluentCart\App\Models\Order` - Updated order instance
94
+
95
+ ```
96
+ $order = FluentCart\App\Models\Order::find(1);
97
+ $order->updatePaymentStatus('paid');
98
+ ```
99
+
100
+ ### getMeta($metaKey, $defaultValue = false)
101
+
102
+ Get order meta value
103
+
104
+ - Parameters: `$metaKey` (String) - Meta key, `$defaultValue` (Mixed) - Default value
105
+ - Returns `Mixed` - Meta value or default
106
+
107
+ ```
108
+ $order = FluentCart\App\Models\Order::find(1);
109
+ $metaValue = $order->getMeta('custom_field', 'default');
110
+ ```
111
+
112
+ ### updateMeta($metaKey, $value)
113
+
114
+ Update order meta value
115
+
116
+ - Parameters: `$metaKey` (String) - Meta key, `$value` (Mixed) - Meta value
117
+ - Returns `FluentCart\App\Models\OrderMeta` - Meta instance
118
+
119
+ ```
120
+ $order = FluentCart\App\Models\Order::find(1);
121
+ $meta = $order->updateMeta('custom_field', 'new_value');
122
+ ```
123
+
124
+ ### deleteMeta($metaKey)
125
+
126
+ Delete order meta
127
+
128
+ - Parameters: `$metaKey` (String) - Meta key
129
+ - Returns `Boolean` - True if deleted
130
+
131
+ ```
132
+ $order = FluentCart\App\Models\Order::find(1);
133
+ $deleted = $order->deleteMeta('custom_field');
134
+ ```
135
+
136
+ ### getTotalPaidAmount()
137
+
138
+ Get total paid amount from succeeded transactions
139
+
140
+ - Returns `Integer` - Total paid amount in cents
141
+
142
+ ```
143
+ $order = FluentCart\App\Models\Order::find(1);
144
+ $totalPaid = $order->getTotalPaidAmount();
145
+ ```
146
+
147
+ ### getTotalRefundAmount()
148
+
149
+ Get total refund amount from refunded transactions
150
+
151
+ - Returns `Integer` - Total refund amount in cents
152
+
153
+ ```
154
+ $order = FluentCart\App\Models\Order::find(1);
155
+ $totalRefund = $order->getTotalRefundAmount();
156
+ ```
157
+
158
+ ### recountTotalPaidAndRefund()
159
+
160
+ Recount total paid and refund amounts. Updates `total_refund` and sets `payment_status` to refunded or partially refunded as appropriate.
161
+
162
+ - Returns `FluentCart\App\Models\Order` - Updated order instance
163
+
164
+ ```
165
+ $order = FluentCart\App\Models\Order::find(1);
166
+ $order->recountTotalPaidAndRefund();
167
+ ```
168
+
169
+ ### syncOrderAfterRefund($type, $refundedAmount)
170
+
171
+ Sync order after refund
172
+
173
+ - Parameters: `$type` (String) - Refund type ('full' or 'partial'), `$refundedAmount` (Integer) - Refund amount
174
+ - Returns `FluentCart\App\Models\Order` - Updated order instance
175
+
176
+ ```
177
+ $order = FluentCart\App\Models\Order::find(1);
178
+ $order->syncOrderAfterRefund('full', 1000);
179
+ ```
180
+
181
+ ### updateRefundedItems($refundedItemIds, $refundedAmount)
182
+
183
+ Update refunded items. Distributes refund amount proportionally across the specified order items.
184
+
185
+ - Parameters: `$refundedItemIds` (Array) - Order item IDs, `$refundedAmount` (Integer) - Refund amount
186
+
187
+ ```
188
+ $order = FluentCart\App\Models\Order::find(1);
189
+ $order->updateRefundedItems([1, 2, 3], 1000);
190
+ ```
191
+
192
+ ### recountTotalPaid()
193
+
194
+ Recount total paid amount (paid minus refunded)
195
+
196
+ - Returns `FluentCart\App\Models\Order` - Updated order instance
197
+
198
+ ```
199
+ $order = FluentCart\App\Models\Order::find(1);
200
+ $order->recountTotalPaid();
201
+ ```
202
+
203
+ ### getLatestTransactionAttribute()
204
+
205
+ Get latest non-refund transaction (accessor, accessed as `latest_transaction` attribute)
206
+
207
+ - Returns `FluentCart\App\Models\OrderTransaction|null` - Latest transaction
208
+
209
+ ```
210
+ $order = FluentCart\App\Models\Order::find(1);
211
+ $transaction = $order->latest_transaction;
212
+ ```
213
+
214
+ ### isSubscription()
215
+
216
+ Check if order is subscription
217
+
218
+ - Returns `Boolean` - True if order has subscription items
219
+
220
+ ```
221
+ $order = FluentCart\App\Models\Order::find(1);
222
+ $isSubscription = $order->isSubscription();
223
+ ```
224
+
225
+ ### getViewUrl($type = 'customer')
226
+
227
+ Get order view URL
228
+
229
+ - Parameters: `$type` (String) - View type ('customer' or 'admin')
230
+ - Returns `String` - View URL
231
+
232
+ ```
233
+ $order = FluentCart\App\Models\Order::find(1);
234
+ $viewUrl = $order->getViewUrl('admin');
235
+ ```
236
+
237
+ ### getLatestTransaction()
238
+
239
+ Get latest non-refund transaction (method call, unlike the accessor attribute)
240
+
241
+ - Returns `FluentCart\App\Models\OrderTransaction|null` - Latest transaction
242
+
243
+ ```
244
+ $order = FluentCart\App\Models\Order::find(1);
245
+ $transaction = $order->getLatestTransaction();
246
+ ```
247
+
248
+ ### currentSubscription()
249
+
250
+ Get current active subscription for this order
251
+
252
+ - Returns `FluentCart\App\Models\Subscription|null` - Current active subscription
253
+
254
+ ```
255
+ $order = FluentCart\App\Models\Order::find(1);
256
+ $subscription = $order->currentSubscription();
257
+ ```
258
+
259
+ ### getDownloads($scope = 'email')
260
+
261
+ Get order downloads. Returns downloadable files associated with the order items, filtered by product variation authorization.
262
+
263
+ - Parameters: `$scope` (String) - Download scope
264
+ - Returns `Array` - Download data
265
+
266
+ ```
267
+ $order = FluentCart\App\Models\Order::find(1);
268
+ $downloads = $order->getDownloads('email');
269
+ ```
270
+
271
+ ### getLicenses($with = ['product', 'productVariant'])
272
+
273
+ Get order licenses (requires Pro and active license module)
274
+
275
+ - Parameters: `$with` (Array) - Relationships to eager load (default: `['product', 'productVariant']`)
276
+ - Returns `Illuminate\Database\Eloquent\Collection|null` - Licenses collection or null if module inactive
277
+
278
+ ```
279
+ $order = FluentCart\App\Models\Order::find(1);
280
+ $licenses = $order->getLicenses(['product', 'productVariant']);
281
+ ```
282
+
283
+ ### getDownloadsById($orderId)
284
+
285
+ Get downloads for a specific order by ID
286
+
287
+ - Parameters: `$orderId` (Integer) - Order ID
288
+ - Returns `Array` - Download data
289
+
290
+ ```
291
+ $order = FluentCart\App\Models\Order::find(1);
292
+ $downloads = $order->getDownloadsById(42);
293
+ ```
294
+
295
+ ### getReceiptViewUrl() and getReceiptDownloadUrl()
296
+
297
+ Build the customer-facing receipt links — one to view the receipt in the browser, one to download it.
298
+
299
+ - Returns `String`
300
+
301
+ ```
302
+ $order = FluentCart\App\Models\Order::find(1);
303
+
304
+ $view = $order->getReceiptViewUrl();
305
+ $download = $order->getReceiptDownloadUrl();
306
+ ```
307
+
308
+ ### addLog($title, $description = '', $type = 'info', $by = '')
309
+
310
+ Add order log
311
+
312
+ - Parameters: `$title` (String) - Log title, `$description` (String) - Description, `$type` (String) - Log type, `$by` (String) - Created by
313
+
314
+ ```
315
+ $order = FluentCart\App\Models\Order::find(1);
316
+ $order->addLog('Status Updated', 'Order status changed to completed', 'info', 'admin');
317
+ ```
318
+
319
+ ### canBeRefunded()
320
+
321
+ Check if order can be refunded. Returns false if the order has been upgraded to another order.
322
+
323
+ - Returns `Boolean` - True if order can be refunded
324
+
325
+ ```
326
+ $order = FluentCart\App\Models\Order::find(1);
327
+ $canBeRefunded = $order->canBeRefunded();
328
+ ```
329
+
330
+ ### generateReceiptNumber()
331
+
332
+ Claims the next receipt number atomically, so concurrent requests cannot take the same one. A losing request discards its candidate, which means the sequence can contain gaps. Fires `fluent_cart/order/invoice_number_added` once a number is assigned.
333
+
334
+ Generate receipt number and invoice number if not already set
335
+
336
+ - Returns `FluentCart\App\Models\Order` - Updated order instance
337
+
338
+ ```
339
+ $order = FluentCart\App\Models\Order::find(1);
340
+ $order->generateReceiptNumber();
341
+ ```
342
+
343
+ ### canBeDeleted()
344
+
345
+ Check if order can be deleted. Test-mode orders can always be deleted. For live orders:
346
+
347
+ - the status must be `canceled` or `on-hold`, otherwise a `WP_Error` names the status
348
+ - a successfully-paid order is blocked unless its `total_amount` is `0`, so free and unpaid cancelled orders delete but a paid one does not
349
+ - an order of `type = 'subscription'` is blocked while a subscription on its `parent_order_id` is still `active`
350
+
351
+ The result passes through the `fluent_cart/order_can_be_deleted` filter, so an integration can relax or tighten any of it.
352
+
353
+ - Returns `Boolean|WP_Error` - True if order can be deleted, or WP_Error with reason
354
+
355
+ ```
356
+ $order = FluentCart\App\Models\Order::find(1);
357
+ $canBeDeleted = $order->canBeDeleted();
358
+ if (is_wp_error($canBeDeleted)) {
359
+ echo $canBeDeleted->get_error_message();
360
+ }
361
+ ```
362
+
363
+ ### Items and fees
364
+
365
+ | Method | Returns |
366
+ | --- | --- |
367
+ | `getProductItems()` | the order's product line items, excluding fee lines |
368
+ | `getAppliedFees()` | applied fees as a plain array, for display |
369
+
370
+ Fee lines are `order_items` rows with `payment_type = 'fee'`, also reachable as the `feeItems` relation.
371
+
372
+ ### Review links
373
+
374
+ | Method | Returns |
375
+ | --- | --- |
376
+ | `getOrderReviewUrl()` | the review link for this order |
377
+ | `Order::reviewUrlForHash($hash)` | the same link built from an order hash, for email and webhook contexts where no order instance is loaded |
378
+
379
+ ### Tax and B2B
380
+
381
+ Thirteen helpers read the order's frozen tax snapshot rather than recomputing it:
382
+
383
+ | Method | Returns |
384
+ | --- | --- |
385
+ | `getBusinessInfo()` | the buyer's business details |
386
+ | `getStoreBusinessInfo()` | five seller fields from the order's `store_business_info` meta snapshot, each falling back to live store settings |
387
+ | `isB2BOrder()` | whether the order was placed as a business |
388
+ | `getPrimaryOrderTaxRate()` | the main tax rate applied |
389
+ | `getReversedTaxTotal()` | tax reversed under a reverse charge |
390
+ | `isReverseChargeTaxOrder()` | whether reverse charge applied |
391
+ | `getOrderRcMode()` | the reverse-charge mode |
392
+ | `getDisplayTaxLines()` | tax lines for display |
393
+ | `getDisplayShippingTaxLines()` | shipping tax lines for display |
394
+ | `getCustomerTaxNumber()` | the buyer's tax number |
395
+ | `hasValidatedCustomerTaxNumber()` | whether that number was validated |
396
+ | `getCustomerTaxName()` | the label for the buyer's tax number in their country |
397
+ | `getMoRVatRemovedAmount()` | VAT removed under a merchant-of-record arrangement |
398
+ | `netAmount()` | the order total net of tax |
399
+
400
+ ### generateOrderUuid()
401
+
402
+ Static. Produces the order's public `uuid`, and runs on the `creating` event, so a new order gets one without the caller doing anything.
403
+
404
+ ## Relations
405
+
406
+ This model has the following relationships that you can use
407
+
408
+ ### parentOrder
409
+
410
+ Access the parent order.
411
+
412
+ - Returns `FluentCart\App\Models\Order`
413
+
414
+ ```
415
+ $order = FluentCart\App\Models\Order::find(1);
416
+ $parentOrder = $order->parentOrder;
417
+ ```
418
+
419
+ ### children
420
+
421
+ Access the child orders.
422
+
423
+ - Returns `Illuminate\Database\Eloquent\Collection` of `FluentCart\App\Models\Order`
424
+
425
+ ```
426
+ $order = FluentCart\App\Models\Order::find(1);
427
+ $children = $order->children;
428
+ ```
429
+
430
+ ### transactions
431
+
432
+ Access the order transactions.
433
+
434
+ - Returns `Illuminate\Database\Eloquent\Collection` of `FluentCart\App\Models\OrderTransaction`
435
+
436
+ ```
437
+ $order = FluentCart\App\Models\Order::find(1);
438
+ $transactions = $order->transactions;
439
+ ```
440
+
441
+ ### subscriptions
442
+
443
+ Access the order subscriptions.
444
+
445
+ - Returns `Illuminate\Database\Eloquent\Collection` of `FluentCart\App\Models\Subscription`
446
+
447
+ ```
448
+ $order = FluentCart\App\Models\Order::find(1);
449
+ $subscriptions = $order->subscriptions;
450
+ ```
451
+
452
+ ### order_items
453
+
454
+ Access the order items.
455
+
456
+ - Returns `Illuminate\Database\Eloquent\Collection` of `FluentCart\App\Models\OrderItem`
457
+
458
+ ```
459
+ $order = FluentCart\App\Models\Order::find(1);
460
+ $items = $order->order_items;
461
+ ```
462
+
463
+ ### filteredOrderItems
464
+
465
+ Access the filtered order items based on priority rules for payment_type (onetime > subscription > adjustment).
466
+
467
+ - Returns `Illuminate\Database\Eloquent\Collection` of `FluentCart\App\Models\OrderItem`
468
+
469
+ ```
470
+ $order = FluentCart\App\Models\Order::find(1);
471
+ $filteredItems = $order->filteredOrderItems;
472
+ ```
473
+
474
+ ### customer
475
+
476
+ Access the customer.
477
+
478
+ - Returns `FluentCart\App\Models\Customer`
479
+
480
+ ```
481
+ $order = FluentCart\App\Models\Order::find(1);
482
+ $customer = $order->customer;
483
+ ```
484
+
485
+ ### orderMeta
486
+
487
+ Access the order metadata.
488
+
489
+ - Returns `Illuminate\Database\Eloquent\Collection` of `FluentCart\App\Models\OrderMeta`
490
+
491
+ ```
492
+ $order = FluentCart\App\Models\Order::find(1);
493
+ $meta = $order->orderMeta;
494
+ ```
495
+
496
+ ### orderTaxRates
497
+
498
+ Access the order tax rates.
499
+
500
+ - Returns `Illuminate\Database\Eloquent\Collection` of `FluentCart\App\Models\OrderTaxRate`
501
+
502
+ ```
503
+ $order = FluentCart\App\Models\Order::find(1);
504
+ $taxRates = $order->orderTaxRates;
505
+ ```
506
+
507
+ ### appliedCoupons
508
+
509
+ Access the applied coupons.
510
+
511
+ - Returns `Illuminate\Database\Eloquent\Collection` of `FluentCart\App\Models\AppliedCoupon`
512
+
513
+ ```
514
+ $order = FluentCart\App\Models\Order::find(1);
515
+ $appliedCoupons = $order->appliedCoupons;
516
+ ```
517
+
518
+ ### usedCoupons
519
+
520
+ Access the used coupons (through the applied coupons intermediate table).
521
+
522
+ - Returns `Illuminate\Database\Eloquent\Collection` of `FluentCart\App\Models\Coupon`
523
+
524
+ ```
525
+ $order = FluentCart\App\Models\Order::find(1);
526
+ $usedCoupons = $order->usedCoupons;
527
+ ```
528
+
529
+ ### shipping_address
530
+
531
+ Access the shipping address.
532
+
533
+ - Returns `FluentCart\App\Models\OrderAddress`
534
+
535
+ ```
536
+ $order = FluentCart\App\Models\Order::find(1);
537
+ $address = $order->shipping_address;
538
+ ```
539
+
540
+ ### billing_address
541
+
542
+ Access the billing address.
543
+
544
+ - Returns `FluentCart\App\Models\OrderAddress`
545
+
546
+ ```
547
+ $order = FluentCart\App\Models\Order::find(1);
548
+ $address = $order->billing_address;
549
+ ```
550
+
551
+ ### order_addresses
552
+
553
+ Access the order addresses.
554
+
555
+ - Returns `Illuminate\Database\Eloquent\Collection` of `FluentCart\App\Models\OrderAddress`
556
+
557
+ ```
558
+ $order = FluentCart\App\Models\Order::find(1);
559
+ $addresses = $order->order_addresses;
560
+ ```
561
+
562
+ ### licenses
563
+
564
+ Access the order licenses.
565
+
566
+ - Returns `Illuminate\Database\Eloquent\Collection` of `FluentCartPro\App\Modules\Licensing\Models\License`
567
+
568
+ ```
569
+ $order = FluentCart\App\Models\Order::find(1);
570
+ $licenses = $order->licenses;
571
+ ```
572
+
573
+ ### labels
574
+
575
+ Access the order labels (morph many relationship).
576
+
577
+ - Returns `Illuminate\Database\Eloquent\Collection` of `FluentCart\App\Models\LabelRelationship`
578
+
579
+ ```
580
+ $order = FluentCart\App\Models\Order::find(1);
581
+ $labels = $order->labels;
582
+ ```
583
+
584
+ ### renewals
585
+
586
+ Access the order renewals (child orders of type 'renewal', excluding canceled, failed, and on-hold).
587
+
588
+ - Returns `Illuminate\Database\Eloquent\Collection` of `FluentCart\App\Models\Order`
589
+
590
+ ```
591
+ $order = FluentCart\App\Models\Order::find(1);
592
+ $renewals = $order->renewals;
593
+ ```
594
+
595
+ ### orderOperation
596
+
597
+ Access the order operation record.
598
+
599
+ - Returns `FluentCart\App\Models\OrderOperation`
600
+
601
+ ```
602
+ $order = FluentCart\App\Models\Order::find(1);
603
+ $operation = $order->orderOperation;
604
+ ```
605
+
606
+ ## Scopes
607
+
608
+ This model has the following scopes that you can use
609
+
610
+ ### searchBy($search)
611
+
612
+ Search orders by query. Searches across order ID, status, total amount, payment status, payment method, invoice number, order item titles, and customer name/email.
613
+
614
+ - Parameters: `$search` (String) - Search query
615
+
616
+ ```
617
+ $orders = FluentCart\App\Models\Order::searchBy('john')->get();
618
+ ```
619
+
620
+ ### ofPaymentStatus($status)
621
+
622
+ Get orders by payment status
623
+
624
+ - Parameters: `$status` (String) - Payment status
625
+
626
+ ```
627
+ $orders = FluentCart\App\Models\Order::ofPaymentStatus('paid')->get();
628
+ ```
629
+
630
+ ### ofOrderStatus($status)
631
+
632
+ Get orders by order status
633
+
634
+ - Parameters: `$status` (String) - Order status
635
+
636
+ ```
637
+ $orders = FluentCart\App\Models\Order::ofOrderStatus('completed')->get();
638
+ ```
639
+
640
+ ### ofShippingStatus($status)
641
+
642
+ Get orders by shipping status
643
+
644
+ - Parameters: `$status` (String) - Shipping status
645
+
646
+ ```
647
+ $orders = FluentCart\App\Models\Order::ofShippingStatus('shipped')->get();
648
+ ```
649
+
650
+ ### ofOrderType($type)
651
+
652
+ Get orders by order type
653
+
654
+ - Parameters: `$type` (String) - Order type
655
+
656
+ ```
657
+ $orders = FluentCart\App\Models\Order::ofOrderType('payment')->get();
658
+ ```
659
+
660
+ ### ofPaymentMethod($methodName)
661
+
662
+ Get orders by payment method
663
+
664
+ - Parameters: `$methodName` (String) - Payment method name
665
+
666
+ ```
667
+ $orders = FluentCart\App\Models\Order::ofPaymentMethod('stripe')->get();
668
+ ```
669
+
670
+ ### applyCustomFilters($filters)
671
+
672
+ Apply custom filters
673
+
674
+ - Parameters: `$filters` (Array) - Filter array
675
+
676
+ ```
677
+ $orders = FluentCart\App\Models\Order::applyCustomFilters([
678
+ 'status' => ['value' => ['completed', 'processing']]
679
+ ])->get();
680
+ ```
681
+
682
+ ## Usage Examples
683
+
684
+ ### Creating an Order
685
+
686
+ ```
687
+ use FluentCart\App\Models\Order;
688
+
689
+ $order = Order::create([
690
+ 'customer_id' => 1,
691
+ 'status' => 'pending',
692
+ 'payment_method' => 'stripe',
693
+ 'currency' => 'USD',
694
+ 'total_amount' => 9999 // $99.99 in cents
695
+ ]);
696
+ ```
697
+
698
+ ### Retrieving Orders
699
+
700
+ ```
701
+ // Get orders by payment status
702
+ $orders = Order::ofPaymentStatus('paid')->get();
703
+
704
+ // Get order by ID
705
+ $order = Order::find(1);
706
+
707
+ // Get order with items and customer
708
+ $order = Order::with(['order_items', 'customer'])->find(1);
709
+ ```
710
+
711
+ ### Updating an Order
712
+
713
+ ```
714
+ $order = Order::find(1);
715
+ $order->status = 'completed';
716
+ $order->completed_at = now();
717
+ $order->save();
718
+ ```
719
+
720
+ ### Deleting an Order
721
+
722
+ ```
723
+ $order = Order::find(1);
724
+ $order->delete();
725
+ ```
726
+
727
+ ---