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,395 +1,395 @@
1
- # /engineering/adding-custom-pages-to-the-customer-dashboard
2
-
3
- The FluentCart customer portal is a Vue 3 single-page app. Dashboard, purchase history, subscriptions, licenses, downloads, profile — all client-side routes in one bundle, shipped by core.
4
-
5
- That is a fine architecture right up until an add-on needs a tab in it. A wallet plugin wants a **Wallet** page. A helpdesk wants **Support**. A payment add-on wants **Payment Methods**. None of them can compile Vue components into core's bundle, and none of them should have to.
6
-
7
- So `addCustomerDashboardEndpoint()` exists, and the interesting part is not the API — it is three lines long — but the routing trick underneath that lets a server-rendered page live inside a client-rendered app without either one knowing about the other.
8
-
9
- ## One call
10
-
11
- ```
12
- add_action('fluent_cart/init', function () {
13
- fluent_cart_api()->addCustomerDashboardEndpoint('acme-wallet', [
14
- 'title' => __('Wallet', 'my-plugin'),
15
- 'icon_svg' => '<svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 20 20" fill="none"><path d="M3 6h14v10H3z" fill="currentColor"/></svg>',
16
- 'render_callback' => function () {
17
- echo do_shortcode('[my_wallet_widget]');
18
- },
19
- ]);
20
- });
21
- ```
22
-
23
- That is the whole integration. You now have:
24
-
25
- - a **Wallet** item in the portal's left nav, sitting just above *Profile*,
26
- - a working URL at `/account/acme-wallet` (whatever your customer dashboard page slug is),
27
- - the portal's header, avatar block, nav, logout button, and responsive behaviour wrapped around your content,
28
- - correct active-tab highlighting when a customer is on your page,
29
- - no rewrite rule to register, no permalink flush, no `template_redirect` hook, no Vue, no build step.
30
-
31
- Two things in that snippet are doing more work than they look like they are.
32
-
33
- **`fluent_cart/init` is the hook to use.** It fires from `boot/app.php:40`:
34
-
35
- ```
36
- add_action('plugins_loaded', function () use ($app) {
37
- do_action('fluentcart_loaded', $app);
38
-
39
- add_action('init', function () use ($app) {
40
- DBMigrator::maybeMigrateDBChanges();
41
- do_action('fluent_cart/init', $app); // ← you are here
42
- // ...
43
- });
44
- });
45
- ```
46
-
47
- It runs inside WordPress's `init`, after migrations, and it only fires **if FluentCart is loaded at all**. That is the whole point: inside that callback, FluentCart is present, booted, and its globals are defined. You do not need `function_exists()`, you do not need `class_exists()`, and you do not need to guess a priority — if FluentCart isn't active, your callback simply never runs and your plugin does nothing, which is exactly the behaviour you wanted from the guard anyway. The `$app` container instance is passed as the first argument if you need it.
48
-
49
- Attach your listener at the top level of your plugin file (or anywhere before `init`) and you're done. Registering later than `init` — inside `wp`, `template_redirect`, or `wp_enqueue_scripts` — is too late: by then the portal may already be rendering its menu, and your tab silently isn't there.
50
-
51
- **`fluent_cart_api()` is the public entry point.** It's a global function defined in `boot/globals.php` returning the `FluentCart\Api\FluentCartGeneralApi` singleton. Prefer it over reaching into the class directly — it is the surface we treat as public API, and it keeps your code free of `FluentCart\…` class references that would fatal on a site where the plugin is missing. The alternative, `\FluentCart\Api\FluentCartGeneralApi::getInstance()`, is the same object; you'll see it in older integrations written before the helper existed.
52
-
53
- ## The second form: hand it a WordPress page
54
-
55
- `render_callback` is one of two ways to fill the page. The other is `page_id` — you point the endpoint at an ordinary WordPress page and let core render it:
56
-
57
- ```
58
- add_action('fluent_cart/init', function () {
59
- fluent_cart_api()->addCustomerDashboardEndpoint('help', [
60
- 'title' => __('Help', 'my-plugin'),
61
- 'page_id' => get_option('my_plugin_help_page_id'),
62
- ]);
63
- });
64
- ```
65
-
66
- Core runs a one-post `WP_Query`, renders `the_content()` inside a `.fluent-cart-custom-page-content` wrapper, and calls `wp_reset_postdata()`. The page's own template, header, and sidebar are *not* used — only its content — which is exactly what you want for something that has to sit inside the portal shell. If the ID doesn't resolve, the customer sees "No content found!". `render_callback` wins if you pass both.
67
-
68
- This is the right form whenever the page is really *content* — a help page, a terms summary, an onboarding note, a page built in the block editor. A site owner can edit it without touching your plugin, and you didn't have to write a renderer.
69
-
70
- ### Make the Account page its parent
71
-
72
- Here's the part that makes `page_id` genuinely pleasant, and it's easy to miss.
73
-
74
- Set the endpoint page's **parent** to your Account (customer dashboard) page in the Page Attributes panel, and give it a **slug matching the endpoint slug**. WordPress then builds the page's permalink as `/account/help/` — which is byte-for-byte the URL the portal nav already points at.
75
-
76
- You don't have to do this. But when you don't, the page has two addresses: its real permalink somewhere else on the site, and the portal URL. When you do, there is exactly one URL, and it is the portal one. Concretely:
77
-
78
- - The page's **View** link in wp-admin opens it inside the portal, in the shell, with the nav highlighted — not as a bare page on the theme's template.
79
- - Yoast/breadcrumbs/menus/search all point at the portal URL, because it *is* the permalink.
80
- - The site owner can find and edit the page in **Pages** like any other page, nested under Account in the list view where they'd expect it.
81
-
82
- I checked this end-to-end on a live install rather than trusting the reasoning. Creating a page with `post_parent` set to the Account page and slug `fct-doc-test` gives `get_page_link()` → `https://cart.lab/account/fct-doc-test/`, and `URL::getCustomerDashboardUrl('fct-doc-test')` → the same path. Requesting it as a logged-in customer returns 200 and the response contains the page's content inside `.fluent-cart-custom-page-content`, wrapped in the portal shell, with `active_customer_menu` on `.fct-customer-nav-item-fct-doc-test`. The SPA mount point `data-fluent-cart-customer-profile-app` is absent, exactly as the branch in `renderCustomerAppContainer()` predicts.
83
-
84
- Why does this work at all? Because of the wildcard rewrite rule covered under *How a URL becomes your callback* below: `^account/(.+)?$` is registered with `'top'` priority, so it wins before WordPress's own page-hierarchy rules ever get a look. The request resolves to the *Account* page, the portal boots, and the path segment `help` is matched against the endpoint map. Your child page is never resolved as a page by WordPress — core loads its content deliberately, by ID.
85
-
86
- A child page without a registered endpoint is unreachable
87
-
88
- That same rewrite rule is unconditional. Park a page under Account and *don't* register a matching endpoint, and the page becomes a dead end: the request still resolves to the Account page, `maybeCustomEndpointContent()` finds nothing, so core boots the Vue SPA — whose router has no such route. The customer gets the portal shell with nothing in it, and the page's own content never renders.
89
-
90
- Verified: an orphan child page at `/account/fct-orphan/` returned 200 with the SPA mount point present and its own content nowhere in the response.
91
-
92
- So the page and the endpoint registration are a pair. If your plugin creates the page on activation, register the endpoint unconditionally on `fluent_cart/init` — not behind a setting that can be switched off while the page stays published.
93
-
94
- One cosmetic note while you're here: `URL::getCustomerDashboardUrl()` builds the nav link *without* a trailing slash, and WordPress canonicalises to the trailing slash form. So the first click on your tab costs a 301. This is true for every custom endpoint, `page_id` or callback, and is harmless — just don't be puzzled by the redirect in your network tab.
95
-
96
- ## What the call actually does
97
-
98
- `addCustomerDashboardEndpoint()` (`api/FluentCartGeneralApi.php:25`) validates its arguments and then registers **two filters**. That is it. There is no registry object, no custom post type, no route table.
99
-
100
- ```
101
- add_filter('fluent_cart/global_customer_menu_items', /* insert nav item */);
102
- add_filter('fluent_cart/customer_portal/custom_endpoints', /* register slug => callback */);
103
- ```
104
-
105
- The first filter puts a nav item in the menu. The second one puts your slug in a map the portal consults at render time. The split matters: the menu is rendered on *every* portal page, while the endpoint map is only consulted when the requested path doesn't belong to core.
106
-
107
- You can call those two filters directly and skip the API entirely — they're documented under [customer & subscription filters](/hooks/filters/customers-and-subscriptions.md). The wrapper exists because getting the nav-item array shape, the URL builder, and the CSS class right by hand is three chances to be subtly wrong, and one of them is load-bearing in a way that isn't obvious. More on that in a moment.
108
-
109
- ## How a URL becomes your callback
110
-
111
- This is the part worth understanding, because it explains every constraint that follows.
112
-
113
- Three details in that flow do all the work.
114
-
115
- **The rewrite rule is a wildcard, registered once.** On `init`, `CustomerProfileHandler::register()` adds a single rule (`CustomerProfileHandler.php:43-55`):
116
-
117
- ```
118
- add_rewrite_rule(
119
- '^' . $pageSlug . '/(.+)?$',
120
- 'index.php?page_id=' . $customerProfilePageId,
121
- 'top'
122
- );
123
- ```
124
-
125
- Everything under the dashboard slug resolves to the same WordPress page. That is why your endpoint needs no rewrite rule of its own and why you never have to flush permalinks — a new slug is not new routing, it is new *content* on routing that already exists. It also means "does this path exist?" is a question core answers in PHP at render time, not something the rewrite layer knows about.
126
-
127
- The `'top'` argument is what makes the parent-page trick work: this rule is inserted ahead of WordPress's own rules, including page hierarchy. A real child page sitting at `/account/help/` never gets resolved as a page — the wildcard claims the URL first, and core loads that page's content by ID instead. The same priority is why an unregistered child page is unreachable: there is no fallback path back to normal page resolution.
128
-
129
- `getCustomerDashboardPageSlug()` derives that prefix from `get_page_link()` minus the home URL, so it is the page's **full path**, not just its post slug. Nest the Account page itself under `/my/` and the rule becomes `^my/account/(.+)?$`. It handles that correctly; just don't assume the prefix is a single segment when you're parsing `$wp->request` yourself.
130
-
131
- **Only the first path segment is matched.** `maybeCustomEndpointContent()` (`CustomerProfileHandler.php:154`) strips the dashboard page slug, splits what's left on `/`, and `array_shift()`s the first segment. `/account/acme-wallet` and `/account/acme-wallet/transactions/42` both resolve to the endpoint `acme-wallet`. The remaining segments are **discarded** — they are not passed to your callback. If you want sub-routes, read them yourself:
132
-
133
- ```
134
- 'render_callback' => function () {
135
- global $wp;
136
-
137
- // Slice off everything up to and including your own slug, rather than
138
- // assuming a fixed offset — the dashboard prefix can be more than one
139
- // segment if the Account page is nested.
140
- $segments = explode('/', trim($wp->request, '/'));
141
- $position = array_search('acme-wallet', $segments, true);
142
- $subPath = $position === false ? [] : array_slice($segments, $position + 1);
143
-
144
- if (!empty($subPath) && $subPath[0] === 'transactions') {
145
- echo my_plugin_render_transactions();
146
- return;
147
- }
148
-
149
- echo do_shortcode('[my_wallet_widget]');
150
- }
151
- ```
152
-
153
- **When your endpoint matches, the SPA does not boot.** Look at the branch in `renderCustomerAppContainer()` (`CustomerProfileHandler.php:130-145`):
154
-
155
- ```
156
- $customEndpointContent = $this->maybeCustomEndpointContent();
157
-
158
- if (!$customEndpointContent) {
159
- (new static())->enqueueStyles();
160
- }
161
-
162
- add_action('fluent_cart/customer_app', function () use ($customEndpointContent) {
163
- if ($customEndpointContent) {
164
- echo $customEndpointContent; // your output
165
- } else {
166
- AssetLoader::loadCustomerDashboardAssets();
167
- $this->renderCustomerApp(); // <div data-fluent-cart-customer-profile-app>
168
- }
169
- });
170
- ```
171
-
172
- Your page and core's SPA are mutually exclusive. Core's page renders the mount point and enqueues the bundle; your page renders your HTML and doesn't. That is a deliberate trade — you inherit the shell, not the runtime — and it is the source of the asset rules below.
173
-
174
- ## The link is a full page load, on purpose
175
-
176
- Core's own nav items carry the CSS class `fct_route`. On `DOMContentLoaded`, `Start.js:342` walks every `a.fct_route`, resolves the href against the Vue router, and if the router matches, calls `preventDefault()` and pushes the route client-side.
177
-
178
- Your nav item is given the class `fct-menu-item-` instead. It is never picked up by that listener, so clicking it is an ordinary browser navigation — full page load, PHP renders, your callback runs.
179
-
180
- This is not an oversight. If your link were tagged `fct_route`, one of two things would happen: the router wouldn't match the path and the click would fall through to a normal navigation anyway (harmless but accidental), or — worse — a future core route would start matching your slug and swallow the click into a 404 inside the SPA. Opting out of the interceptor is what makes a server-rendered page safe to embed in a client-rendered app.
181
-
182
- The practical consequence: **navigating to your page costs a full page load, and navigating away from it costs another one.** For a page a customer visits occasionally, that is the correct trade. For something they'd tab in and out of constantly, it isn't — see *When not to use this* at the end.
183
-
184
- ## What the API refuses to do
185
-
186
- Two guard clauses, both of which `throw`:
187
-
188
- ```
189
- $reserved = ['dashboard', 'purchase-history', 'subscriptions', 'licenses', 'downloads', 'profile'];
190
-
191
- if (in_array($slug, $reserved)) {
192
- throw new \Exception(/* ... */);
193
- }
194
-
195
- if (!isset($args['render_callback']) && !isset($args['page_id'])) {
196
- throw new \Exception(/* ... */);
197
- }
198
- ```
199
-
200
- An empty slug throws too. Because `fluent_cart/init` fires on every request, an uncaught exception here is a **fatal on every page load of the site**, not a quiet failure on the portal. If your slug is anything other than a hard-coded literal — a setting, a filter, a slug derived from a post — wrap the call:
201
-
202
- ```
203
- try {
204
- fluent_cart_api()->addCustomerDashboardEndpoint($slug, $args);
205
- } catch (\Exception $e) {
206
- // log it, skip the tab, keep the site up
207
- }
208
- ```
209
-
210
- ### The reserved list is shorter than the route list
211
-
212
- Here is a sharp edge that is easy to walk into. The reserved list has six entries. The SPA's router (`Start.js`) has ten routes, including:
213
-
214
- | Route | Reserved? |
215
- | --- | --- |
216
- | `/purchase-history` | yes |
217
- | `/subscriptions` | yes |
218
- | `/downloads`, `/licenses`, `/profile` | yes |
219
- | `/order/:order_id` | **no** |
220
- | `/subscription/:subscription_uuid` | **no** |
221
-
222
- `URL::getCustomerOrderUrl()` builds links to `/{dashboard}/order/{uuid}` — a real, linked-to route in every order confirmation. But `order` is not in the reserved list, so `addCustomerDashboardEndpoint('order', …)` is accepted without complaint, and from then on every order-detail link renders *your* page instead. Same for `subscription` (singular — the plural is reserved, the singular isn't).
223
-
224
- Don't rely on the guard to protect you. **Namespace your slug.** `acme-wallet` beats `wallet`, and it costs you nothing.
225
-
226
- ## What you own
227
-
228
- The shell is core's. Everything inside it is yours, including the parts that are easy to forget.
229
-
230
- ### Escaping
231
-
232
- Your callback's output is echoed with escaping explicitly suppressed:
233
-
234
- ```
235
- echo $customEndpointContent; // @phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
236
- ```
237
-
238
- Core cannot escape it — you are returning HTML by design. So every dynamic value inside your callback goes through `esc_html()`, `esc_attr()`, `esc_url()`, or `wp_kses()` before it reaches the buffer. There is no second line of defence behind you.
239
-
240
- The `page_id` form is exempt: that content goes through `the_content()` and WordPress's normal filters, so it is no more and no less trusted than any other page on the site.
241
-
242
- ### Authorization
243
-
244
- The portal gates on `is_user_logged_in()` and nothing else. Any logged-in user reaches any registered endpoint. If your page shows data belonging to a customer, resolve *which* customer from the session rather than from anything in the request:
245
-
246
- ```
247
- 'render_callback' => function () {
248
- $customer = \FluentCart\Api\Resource\CustomerResource::getCurrentCustomer();
249
-
250
- if (!$customer) {
251
- echo '<p>' . esc_html__('No customer record found.', 'my-plugin') . '</p>';
252
- return;
253
- }
254
-
255
- // Query by $customer->id — never by an id from $_GET.
256
- echo my_plugin_render_wallet($customer->id);
257
- }
258
- ```
259
-
260
- `getCurrentCustomer()` returns `null` for logged-out users and is memoised per request, so calling it repeatedly inside your renderer is free.
261
-
262
- ### Assets
263
-
264
- This is the one that surprises people. On a custom-endpoint page:
265
-
266
- **Loaded:** `customer-profile-global.scss` — the portal shell, the nav, and the full set of `--fct-customer-dashboard-*` CSS custom properties.
267
-
268
- **Not loaded:** `customer-profile.scss` and `Start.js`. `enqueueStyles()` is skipped and `AssetLoader::loadCustomerDashboardAssets()` is never called, which also means the `fluent_cart/customer_dashboard/enqueue_assets` action does not fire on your page, and `window.fluentcart_customer_profile_vars` does not exist. Anything you were hoping to borrow from core's bundle — Element Plus, the REST config, the translation strings — is absent.
269
-
270
- Enqueue your own, conditionally:
271
-
272
- ```
273
- add_action('wp_enqueue_scripts', function () {
274
- global $wp;
275
- if (strpos($wp->request ?? '', '/acme-wallet') === false) {
276
- return;
277
- }
278
-
279
- wp_enqueue_style('acme-wallet', plugins_url('assets/wallet.css', __FILE__), [], '1.0.0');
280
- wp_enqueue_script('acme-wallet', plugins_url('assets/wallet.js', __FILE__), [], '1.0.0', true);
281
- });
282
- ```
283
-
284
- To look native without importing core's stylesheet, style against the custom properties the shell already defines:
285
-
286
- ```
287
- .acme-wallet-card {
288
- color: var(--fct-customer-dashboard-text-color);
289
- border: 1px solid var(--fct-customer-dashboard-border-color);
290
- border-radius: 8px;
291
- padding: 16px;
292
- }
293
-
294
- .acme-wallet-card h3 {
295
- color: var(--fct-customer-dashboard-title-color);
296
- }
297
- ```
298
-
299
- Those variables inherit from the store's theme colors, including the ones a site owner sets through the shortcode's `colors` attribute. Hard-coded hex values will drift the moment someone rebrands; these won't.
300
-
301
- ### Icons
302
-
303
- `icon_svg` is rendered through `wp_kses()` against a deliberately tight allowlist (`fct_allowed_svg_tags`): `svg`, `path`, and `g`, with only geometry and stroke/fill attributes. No `title`, no `defs`, no `use`, no inline `style`. Give the SVG `width="20" height="20"` and `fill="currentColor"` so it picks up the nav's active and hover states, and strip anything decorative before pasting it in — it will be silently removed otherwise.
304
-
305
- If your icon doesn't survive the allowlist, `icon_url` takes an image URL instead. Only one of the two is used; `icon_svg` wins if both are set.
306
-
307
- ## Two real integrations
308
-
309
- **Fluent Support** adds a Support tab that renders its existing portal shortcode (`FluentCart.php:241`):
310
-
311
- ```
312
- fluent_cart_api()->addCustomerDashboardEndpoint('fluent-support', [
313
- 'title' => __('Support', 'fluent-support'),
314
- 'render_callback' => function () {
315
- echo do_shortcode('[fluent_support_portal]');
316
- },
317
- 'priority' => 'high'
318
- ]);
319
- ```
320
-
321
- Note `'priority' => 'high'`. `addCustomerDashboardEndpoint()` reads exactly four keys — `title`, `icon_svg`, `icon_url`, and `render_callback`/`page_id` — so `priority` is silently ignored. It does nothing, and it has never done anything. Menu order is not configurable through this API.
322
-
323
- **Credex** does the same for a wallet — hooking WordPress's own `init` and guarding with `class_exists()`:
324
-
325
- ```
326
- add_action('init', [$this, 'addCredexMenuInFluentCart']);
327
-
328
- public function addCredexMenuInFluentCart()
329
- {
330
- if (!class_exists('\FluentCart\Api\FluentCartGeneralApi')) {
331
- return;
332
- }
333
-
334
- \FluentCart\Api\FluentCartGeneralApi::getInstance()->addCustomerDashboardEndpoint('wallet', [
335
- 'title' => __('Wallet', 'credex'),
336
- 'render_callback' => function () {
337
- echo do_shortcode('[credex_user_wallet]');
338
- },
339
- ]);
340
- }
341
- ```
342
-
343
- This works, and it is what you'll find in the wild. Written today it would be four lines shorter — `fluent_cart/init` makes the guard redundant, and `fluent_cart_api()` makes the class reference unnecessary:
344
-
345
- ```
346
- add_action('fluent_cart/init', [$this, 'addCredexMenuInFluentCart']);
347
-
348
- public function addCredexMenuInFluentCart()
349
- {
350
- fluent_cart_api()->addCustomerDashboardEndpoint('credex-wallet', [
351
- 'title' => __('Wallet', 'credex'),
352
- 'render_callback' => function () {
353
- echo do_shortcode('[credex_user_wallet]');
354
- },
355
- ]);
356
- }
357
- ```
358
-
359
- Both integrations wrap an existing shortcode. That is the shape this API is built for: you already have a rendering path, and you want it to appear inside the portal chrome rather than on a standalone page.
360
-
361
- ## Where your tab lands
362
-
363
- Each registration inserts its item **immediately before `profile`** in the menu array. Two add-ons registering on the same hook therefore end up in the order their filters ran, both above Profile — so relative order between add-ons is plugin load order, which is alphabetical by directory name and not something you should build on.
364
-
365
- If placement genuinely matters, hook `fluent_cart/global_customer_menu_items` at a late priority and reorder the array yourself. Bear in mind that `licenses` is unset unless Pro is active with the license module on, and `subscriptions` is unset for customers who have none — so write reordering code that tolerates missing keys.
366
-
367
- Active-tab highlighting needs nothing from you. When your endpoint matches, `maybeCustomEndpointContent()` filters `fluent_cart/customer_portal/active_tab` to your slug, and the inline script in `customer_app.php` adds `.active_customer_menu` to `.fct-customer-nav-item-`.
368
-
369
- ## Checklist
370
-
371
- - [ ] Registered inside `add_action('fluent_cart/init', …)` — no `function_exists()` or `class_exists()` guard needed
372
- - [ ] Called through `fluent_cart_api()`, not the class directly
373
- - [ ] Namespaced slug — not `wallet`, `order`, `subscription`, or anything else a core route might claim
374
- - [ ] Wrapped in `try/catch` if the slug isn't a literal
375
- - [ ] Using `page_id` if the page is editable content, with the Account page as its **parent** and its slug matching the endpoint slug
376
- - [ ] No child page parked under Account without a matching endpoint registered
377
- - [ ] Every dynamic value in the callback escaped
378
- - [ ] Customer resolved from the session, never from the request
379
- - [ ] Assets enqueued conditionally — nothing from core's bundle is available
380
- - [ ] Styled against `--fct-customer-dashboard-*`, not hard-coded colors
381
- - [ ] Icon reduced to `svg`/`path`/`g` with `fill="currentColor"`
382
-
383
- ## When not to use this
384
-
385
- `addCustomerDashboardEndpoint()` gives you a **whole page** reached by a **full page load**. Two cases where that's the wrong tool:
386
-
387
- **You want a section inside an existing portal page** — a block on the profile page, extra rows under an order. Use `fluent_cart/customer_portal/profile_sections` and the dynamic per-slug section filter instead. Those render inside the SPA, so they need no navigation at all and cost no page load.
388
-
389
- **You want a genuinely interactive app** — something with client-side state that a customer moves in and out of. A full page load on every entry and exit will be felt. Consider whether the work belongs on your own page template outside the portal, linked from a portal tab.
390
-
391
- For everything else — a wallet, a support inbox, saved payment methods, a membership summary, a help page — one PHP call is the entire integration: `render_callback` when you have a renderer, `page_id` when a site owner should own the content. The routing was already there. All this API does is tell it your name.
392
-
393
- ---
394
-
395
- *Source references: `api/FluentCartGeneralApi.php`, `app/Hooks/Handlers/ShortCodes/CustomerProfileHandler.php`, `app/Modules/Templating/AssetLoader.php`, `resources/public/customer-profile/Start.js`. Filter documentation: [customer & subscription filters](/hooks/filters/customers-and-subscriptions.md).*
1
+ # /engineering/adding-custom-pages-to-the-customer-dashboard
2
+
3
+ The FluentCart customer portal is a Vue 3 single-page app. Dashboard, purchase history, subscriptions, licenses, downloads, profile — all client-side routes in one bundle, shipped by core.
4
+
5
+ That is a fine architecture right up until an add-on needs a tab in it. A wallet plugin wants a **Wallet** page. A helpdesk wants **Support**. A payment add-on wants **Payment Methods**. None of them can compile Vue components into core's bundle, and none of them should have to.
6
+
7
+ So `addCustomerDashboardEndpoint()` exists, and the interesting part is not the API — it is three lines long — but the routing trick underneath that lets a server-rendered page live inside a client-rendered app without either one knowing about the other.
8
+
9
+ ## One call
10
+
11
+ ```
12
+ add_action('fluent_cart/init', function () {
13
+ fluent_cart_api()->addCustomerDashboardEndpoint('acme-wallet', [
14
+ 'title' => __('Wallet', 'my-plugin'),
15
+ 'icon_svg' => '<svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 20 20" fill="none"><path d="M3 6h14v10H3z" fill="currentColor"/></svg>',
16
+ 'render_callback' => function () {
17
+ echo do_shortcode('[my_wallet_widget]');
18
+ },
19
+ ]);
20
+ });
21
+ ```
22
+
23
+ That is the whole integration. You now have:
24
+
25
+ - a **Wallet** item in the portal's left nav, sitting just above *Profile*,
26
+ - a working URL at `/account/acme-wallet` (whatever your customer dashboard page slug is),
27
+ - the portal's header, avatar block, nav, logout button, and responsive behaviour wrapped around your content,
28
+ - correct active-tab highlighting when a customer is on your page,
29
+ - no rewrite rule to register, no permalink flush, no `template_redirect` hook, no Vue, no build step.
30
+
31
+ Two things in that snippet are doing more work than they look like they are.
32
+
33
+ **`fluent_cart/init` is the hook to use.** It fires from `boot/app.php:40`:
34
+
35
+ ```
36
+ add_action('plugins_loaded', function () use ($app) {
37
+ do_action('fluentcart_loaded', $app);
38
+
39
+ add_action('init', function () use ($app) {
40
+ DBMigrator::maybeMigrateDBChanges();
41
+ do_action('fluent_cart/init', $app); // ← you are here
42
+ // ...
43
+ });
44
+ });
45
+ ```
46
+
47
+ It runs inside WordPress's `init`, after migrations, and it only fires **if FluentCart is loaded at all**. That is the whole point: inside that callback, FluentCart is present, booted, and its globals are defined. You do not need `function_exists()`, you do not need `class_exists()`, and you do not need to guess a priority — if FluentCart isn't active, your callback simply never runs and your plugin does nothing, which is exactly the behaviour you wanted from the guard anyway. The `$app` container instance is passed as the first argument if you need it.
48
+
49
+ Attach your listener at the top level of your plugin file (or anywhere before `init`) and you're done. Registering later than `init` — inside `wp`, `template_redirect`, or `wp_enqueue_scripts` — is too late: by then the portal may already be rendering its menu, and your tab silently isn't there.
50
+
51
+ **`fluent_cart_api()` is the public entry point.** It's a global function defined in `boot/globals.php` returning the `FluentCart\Api\FluentCartGeneralApi` singleton. Prefer it over reaching into the class directly — it is the surface we treat as public API, and it keeps your code free of `FluentCart\…` class references that would fatal on a site where the plugin is missing. The alternative, `\FluentCart\Api\FluentCartGeneralApi::getInstance()`, is the same object; you'll see it in older integrations written before the helper existed.
52
+
53
+ ## The second form: hand it a WordPress page
54
+
55
+ `render_callback` is one of two ways to fill the page. The other is `page_id` — you point the endpoint at an ordinary WordPress page and let core render it:
56
+
57
+ ```
58
+ add_action('fluent_cart/init', function () {
59
+ fluent_cart_api()->addCustomerDashboardEndpoint('help', [
60
+ 'title' => __('Help', 'my-plugin'),
61
+ 'page_id' => get_option('my_plugin_help_page_id'),
62
+ ]);
63
+ });
64
+ ```
65
+
66
+ Core runs a one-post `WP_Query`, renders `the_content()` inside a `.fluent-cart-custom-page-content` wrapper, and calls `wp_reset_postdata()`. The page's own template, header, and sidebar are *not* used — only its content — which is exactly what you want for something that has to sit inside the portal shell. If the ID doesn't resolve, the customer sees "No content found!". `render_callback` wins if you pass both.
67
+
68
+ This is the right form whenever the page is really *content* — a help page, a terms summary, an onboarding note, a page built in the block editor. A site owner can edit it without touching your plugin, and you didn't have to write a renderer.
69
+
70
+ ### Make the Account page its parent
71
+
72
+ Here's the part that makes `page_id` genuinely pleasant, and it's easy to miss.
73
+
74
+ Set the endpoint page's **parent** to your Account (customer dashboard) page in the Page Attributes panel, and give it a **slug matching the endpoint slug**. WordPress then builds the page's permalink as `/account/help/` — which is byte-for-byte the URL the portal nav already points at.
75
+
76
+ You don't have to do this. But when you don't, the page has two addresses: its real permalink somewhere else on the site, and the portal URL. When you do, there is exactly one URL, and it is the portal one. Concretely:
77
+
78
+ - The page's **View** link in wp-admin opens it inside the portal, in the shell, with the nav highlighted — not as a bare page on the theme's template.
79
+ - Yoast/breadcrumbs/menus/search all point at the portal URL, because it *is* the permalink.
80
+ - The site owner can find and edit the page in **Pages** like any other page, nested under Account in the list view where they'd expect it.
81
+
82
+ I checked this end-to-end on a live install rather than trusting the reasoning. Creating a page with `post_parent` set to the Account page and slug `fct-doc-test` gives `get_page_link()` → `https://cart.lab/account/fct-doc-test/`, and `URL::getCustomerDashboardUrl('fct-doc-test')` → the same path. Requesting it as a logged-in customer returns 200 and the response contains the page's content inside `.fluent-cart-custom-page-content`, wrapped in the portal shell, with `active_customer_menu` on `.fct-customer-nav-item-fct-doc-test`. The SPA mount point `data-fluent-cart-customer-profile-app` is absent, exactly as the branch in `renderCustomerAppContainer()` predicts.
83
+
84
+ Why does this work at all? Because of the wildcard rewrite rule covered under *How a URL becomes your callback* below: `^account/(.+)?$` is registered with `'top'` priority, so it wins before WordPress's own page-hierarchy rules ever get a look. The request resolves to the *Account* page, the portal boots, and the path segment `help` is matched against the endpoint map. Your child page is never resolved as a page by WordPress — core loads its content deliberately, by ID.
85
+
86
+ A child page without a registered endpoint is unreachable
87
+
88
+ That same rewrite rule is unconditional. Park a page under Account and *don't* register a matching endpoint, and the page becomes a dead end: the request still resolves to the Account page, `maybeCustomEndpointContent()` finds nothing, so core boots the Vue SPA — whose router has no such route. The customer gets the portal shell with nothing in it, and the page's own content never renders.
89
+
90
+ Verified: an orphan child page at `/account/fct-orphan/` returned 200 with the SPA mount point present and its own content nowhere in the response.
91
+
92
+ So the page and the endpoint registration are a pair. If your plugin creates the page on activation, register the endpoint unconditionally on `fluent_cart/init` — not behind a setting that can be switched off while the page stays published.
93
+
94
+ One cosmetic note while you're here: `URL::getCustomerDashboardUrl()` builds the nav link *without* a trailing slash, and WordPress canonicalises to the trailing slash form. So the first click on your tab costs a 301. This is true for every custom endpoint, `page_id` or callback, and is harmless — just don't be puzzled by the redirect in your network tab.
95
+
96
+ ## What the call actually does
97
+
98
+ `addCustomerDashboardEndpoint()` (`api/FluentCartGeneralApi.php:25`) validates its arguments and then registers **two filters**. That is it. There is no registry object, no custom post type, no route table.
99
+
100
+ ```
101
+ add_filter('fluent_cart/global_customer_menu_items', /* insert nav item */);
102
+ add_filter('fluent_cart/customer_portal/custom_endpoints', /* register slug => callback */);
103
+ ```
104
+
105
+ The first filter puts a nav item in the menu. The second one puts your slug in a map the portal consults at render time. The split matters: the menu is rendered on *every* portal page, while the endpoint map is only consulted when the requested path doesn't belong to core.
106
+
107
+ You can call those two filters directly and skip the API entirely — they're documented under [customer & subscription filters](/hooks/filters/customers-and-subscriptions.md). The wrapper exists because getting the nav-item array shape, the URL builder, and the CSS class right by hand is three chances to be subtly wrong, and one of them is load-bearing in a way that isn't obvious. More on that in a moment.
108
+
109
+ ## How a URL becomes your callback
110
+
111
+ This is the part worth understanding, because it explains every constraint that follows.
112
+
113
+ Three details in that flow do all the work.
114
+
115
+ **The rewrite rule is a wildcard, registered once.** On `init`, `CustomerProfileHandler::register()` adds a single rule (`CustomerProfileHandler.php:43-55`):
116
+
117
+ ```
118
+ add_rewrite_rule(
119
+ '^' . $pageSlug . '/(.+)?$',
120
+ 'index.php?page_id=' . $customerProfilePageId,
121
+ 'top'
122
+ );
123
+ ```
124
+
125
+ Everything under the dashboard slug resolves to the same WordPress page. That is why your endpoint needs no rewrite rule of its own and why you never have to flush permalinks — a new slug is not new routing, it is new *content* on routing that already exists. It also means "does this path exist?" is a question core answers in PHP at render time, not something the rewrite layer knows about.
126
+
127
+ The `'top'` argument is what makes the parent-page trick work: this rule is inserted ahead of WordPress's own rules, including page hierarchy. A real child page sitting at `/account/help/` never gets resolved as a page — the wildcard claims the URL first, and core loads that page's content by ID instead. The same priority is why an unregistered child page is unreachable: there is no fallback path back to normal page resolution.
128
+
129
+ `getCustomerDashboardPageSlug()` derives that prefix from `get_page_link()` minus the home URL, so it is the page's **full path**, not just its post slug. Nest the Account page itself under `/my/` and the rule becomes `^my/account/(.+)?$`. It handles that correctly; just don't assume the prefix is a single segment when you're parsing `$wp->request` yourself.
130
+
131
+ **Only the first path segment is matched.** `maybeCustomEndpointContent()` (`CustomerProfileHandler.php:154`) strips the dashboard page slug, splits what's left on `/`, and `array_shift()`s the first segment. `/account/acme-wallet` and `/account/acme-wallet/transactions/42` both resolve to the endpoint `acme-wallet`. The remaining segments are **discarded** — they are not passed to your callback. If you want sub-routes, read them yourself:
132
+
133
+ ```
134
+ 'render_callback' => function () {
135
+ global $wp;
136
+
137
+ // Slice off everything up to and including your own slug, rather than
138
+ // assuming a fixed offset — the dashboard prefix can be more than one
139
+ // segment if the Account page is nested.
140
+ $segments = explode('/', trim($wp->request, '/'));
141
+ $position = array_search('acme-wallet', $segments, true);
142
+ $subPath = $position === false ? [] : array_slice($segments, $position + 1);
143
+
144
+ if (!empty($subPath) && $subPath[0] === 'transactions') {
145
+ echo my_plugin_render_transactions();
146
+ return;
147
+ }
148
+
149
+ echo do_shortcode('[my_wallet_widget]');
150
+ }
151
+ ```
152
+
153
+ **When your endpoint matches, the SPA does not boot.** Look at the branch in `renderCustomerAppContainer()` (`CustomerProfileHandler.php:130-145`):
154
+
155
+ ```
156
+ $customEndpointContent = $this->maybeCustomEndpointContent();
157
+
158
+ if (!$customEndpointContent) {
159
+ (new static())->enqueueStyles();
160
+ }
161
+
162
+ add_action('fluent_cart/customer_app', function () use ($customEndpointContent) {
163
+ if ($customEndpointContent) {
164
+ echo $customEndpointContent; // your output
165
+ } else {
166
+ AssetLoader::loadCustomerDashboardAssets();
167
+ $this->renderCustomerApp(); // <div data-fluent-cart-customer-profile-app>
168
+ }
169
+ });
170
+ ```
171
+
172
+ Your page and core's SPA are mutually exclusive. Core's page renders the mount point and enqueues the bundle; your page renders your HTML and doesn't. That is a deliberate trade — you inherit the shell, not the runtime — and it is the source of the asset rules below.
173
+
174
+ ## The link is a full page load, on purpose
175
+
176
+ Core's own nav items carry the CSS class `fct_route`. On `DOMContentLoaded`, `Start.js:342` walks every `a.fct_route`, resolves the href against the Vue router, and if the router matches, calls `preventDefault()` and pushes the route client-side.
177
+
178
+ Your nav item is given the class `fct-menu-item-` instead. It is never picked up by that listener, so clicking it is an ordinary browser navigation — full page load, PHP renders, your callback runs.
179
+
180
+ This is not an oversight. If your link were tagged `fct_route`, one of two things would happen: the router wouldn't match the path and the click would fall through to a normal navigation anyway (harmless but accidental), or — worse — a future core route would start matching your slug and swallow the click into a 404 inside the SPA. Opting out of the interceptor is what makes a server-rendered page safe to embed in a client-rendered app.
181
+
182
+ The practical consequence: **navigating to your page costs a full page load, and navigating away from it costs another one.** For a page a customer visits occasionally, that is the correct trade. For something they'd tab in and out of constantly, it isn't — see *When not to use this* at the end.
183
+
184
+ ## What the API refuses to do
185
+
186
+ Two guard clauses, both of which `throw`:
187
+
188
+ ```
189
+ $reserved = ['dashboard', 'purchase-history', 'subscriptions', 'licenses', 'downloads', 'profile'];
190
+
191
+ if (in_array($slug, $reserved)) {
192
+ throw new \Exception(/* ... */);
193
+ }
194
+
195
+ if (!isset($args['render_callback']) && !isset($args['page_id'])) {
196
+ throw new \Exception(/* ... */);
197
+ }
198
+ ```
199
+
200
+ An empty slug throws too. Because `fluent_cart/init` fires on every request, an uncaught exception here is a **fatal on every page load of the site**, not a quiet failure on the portal. If your slug is anything other than a hard-coded literal — a setting, a filter, a slug derived from a post — wrap the call:
201
+
202
+ ```
203
+ try {
204
+ fluent_cart_api()->addCustomerDashboardEndpoint($slug, $args);
205
+ } catch (\Exception $e) {
206
+ // log it, skip the tab, keep the site up
207
+ }
208
+ ```
209
+
210
+ ### The reserved list is shorter than the route list
211
+
212
+ Here is a sharp edge that is easy to walk into. The reserved list has six entries. The SPA's router (`Start.js`) has ten routes, including:
213
+
214
+ | Route | Reserved? |
215
+ | --- | --- |
216
+ | `/purchase-history` | yes |
217
+ | `/subscriptions` | yes |
218
+ | `/downloads`, `/licenses`, `/profile` | yes |
219
+ | `/order/:order_id` | **no** |
220
+ | `/subscription/:subscription_uuid` | **no** |
221
+
222
+ `URL::getCustomerOrderUrl()` builds links to `/{dashboard}/order/{uuid}` — a real, linked-to route in every order confirmation. But `order` is not in the reserved list, so `addCustomerDashboardEndpoint('order', …)` is accepted without complaint, and from then on every order-detail link renders *your* page instead. Same for `subscription` (singular — the plural is reserved, the singular isn't).
223
+
224
+ Don't rely on the guard to protect you. **Namespace your slug.** `acme-wallet` beats `wallet`, and it costs you nothing.
225
+
226
+ ## What you own
227
+
228
+ The shell is core's. Everything inside it is yours, including the parts that are easy to forget.
229
+
230
+ ### Escaping
231
+
232
+ Your callback's output is echoed with escaping explicitly suppressed:
233
+
234
+ ```
235
+ echo $customEndpointContent; // @phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
236
+ ```
237
+
238
+ Core cannot escape it — you are returning HTML by design. So every dynamic value inside your callback goes through `esc_html()`, `esc_attr()`, `esc_url()`, or `wp_kses()` before it reaches the buffer. There is no second line of defence behind you.
239
+
240
+ The `page_id` form is exempt: that content goes through `the_content()` and WordPress's normal filters, so it is no more and no less trusted than any other page on the site.
241
+
242
+ ### Authorization
243
+
244
+ The portal gates on `is_user_logged_in()` and nothing else. Any logged-in user reaches any registered endpoint. If your page shows data belonging to a customer, resolve *which* customer from the session rather than from anything in the request:
245
+
246
+ ```
247
+ 'render_callback' => function () {
248
+ $customer = \FluentCart\Api\Resource\CustomerResource::getCurrentCustomer();
249
+
250
+ if (!$customer) {
251
+ echo '<p>' . esc_html__('No customer record found.', 'my-plugin') . '</p>';
252
+ return;
253
+ }
254
+
255
+ // Query by $customer->id — never by an id from $_GET.
256
+ echo my_plugin_render_wallet($customer->id);
257
+ }
258
+ ```
259
+
260
+ `getCurrentCustomer()` returns `null` for logged-out users and is memoised per request, so calling it repeatedly inside your renderer is free.
261
+
262
+ ### Assets
263
+
264
+ This is the one that surprises people. On a custom-endpoint page:
265
+
266
+ **Loaded:** `customer-profile-global.scss` — the portal shell, the nav, and the full set of `--fct-customer-dashboard-*` CSS custom properties.
267
+
268
+ **Not loaded:** `customer-profile.scss` and `Start.js`. `enqueueStyles()` is skipped and `AssetLoader::loadCustomerDashboardAssets()` is never called, which also means the `fluent_cart/customer_dashboard/enqueue_assets` action does not fire on your page, and `window.fluentcart_customer_profile_vars` does not exist. Anything you were hoping to borrow from core's bundle — Element Plus, the REST config, the translation strings — is absent.
269
+
270
+ Enqueue your own, conditionally:
271
+
272
+ ```
273
+ add_action('wp_enqueue_scripts', function () {
274
+ global $wp;
275
+ if (strpos($wp->request ?? '', '/acme-wallet') === false) {
276
+ return;
277
+ }
278
+
279
+ wp_enqueue_style('acme-wallet', plugins_url('assets/wallet.css', __FILE__), [], '1.0.0');
280
+ wp_enqueue_script('acme-wallet', plugins_url('assets/wallet.js', __FILE__), [], '1.0.0', true);
281
+ });
282
+ ```
283
+
284
+ To look native without importing core's stylesheet, style against the custom properties the shell already defines:
285
+
286
+ ```
287
+ .acme-wallet-card {
288
+ color: var(--fct-customer-dashboard-text-color);
289
+ border: 1px solid var(--fct-customer-dashboard-border-color);
290
+ border-radius: 8px;
291
+ padding: 16px;
292
+ }
293
+
294
+ .acme-wallet-card h3 {
295
+ color: var(--fct-customer-dashboard-title-color);
296
+ }
297
+ ```
298
+
299
+ Those variables inherit from the store's theme colors, including the ones a site owner sets through the shortcode's `colors` attribute. Hard-coded hex values will drift the moment someone rebrands; these won't.
300
+
301
+ ### Icons
302
+
303
+ `icon_svg` is rendered through `wp_kses()` against a deliberately tight allowlist (`fct_allowed_svg_tags`): `svg`, `path`, and `g`, with only geometry and stroke/fill attributes. No `title`, no `defs`, no `use`, no inline `style`. Give the SVG `width="20" height="20"` and `fill="currentColor"` so it picks up the nav's active and hover states, and strip anything decorative before pasting it in — it will be silently removed otherwise.
304
+
305
+ If your icon doesn't survive the allowlist, `icon_url` takes an image URL instead. Only one of the two is used; `icon_svg` wins if both are set.
306
+
307
+ ## Two real integrations
308
+
309
+ **Fluent Support** adds a Support tab that renders its existing portal shortcode (`FluentCart.php:241`):
310
+
311
+ ```
312
+ fluent_cart_api()->addCustomerDashboardEndpoint('fluent-support', [
313
+ 'title' => __('Support', 'fluent-support'),
314
+ 'render_callback' => function () {
315
+ echo do_shortcode('[fluent_support_portal]');
316
+ },
317
+ 'priority' => 'high'
318
+ ]);
319
+ ```
320
+
321
+ Note `'priority' => 'high'`. `addCustomerDashboardEndpoint()` reads exactly four keys — `title`, `icon_svg`, `icon_url`, and `render_callback`/`page_id` — so `priority` is silently ignored. It does nothing, and it has never done anything. Menu order is not configurable through this API.
322
+
323
+ **Credex** does the same for a wallet — hooking WordPress's own `init` and guarding with `class_exists()`:
324
+
325
+ ```
326
+ add_action('init', [$this, 'addCredexMenuInFluentCart']);
327
+
328
+ public function addCredexMenuInFluentCart()
329
+ {
330
+ if (!class_exists('\FluentCart\Api\FluentCartGeneralApi')) {
331
+ return;
332
+ }
333
+
334
+ \FluentCart\Api\FluentCartGeneralApi::getInstance()->addCustomerDashboardEndpoint('wallet', [
335
+ 'title' => __('Wallet', 'credex'),
336
+ 'render_callback' => function () {
337
+ echo do_shortcode('[credex_user_wallet]');
338
+ },
339
+ ]);
340
+ }
341
+ ```
342
+
343
+ This works, and it is what you'll find in the wild. Written today it would be four lines shorter — `fluent_cart/init` makes the guard redundant, and `fluent_cart_api()` makes the class reference unnecessary:
344
+
345
+ ```
346
+ add_action('fluent_cart/init', [$this, 'addCredexMenuInFluentCart']);
347
+
348
+ public function addCredexMenuInFluentCart()
349
+ {
350
+ fluent_cart_api()->addCustomerDashboardEndpoint('credex-wallet', [
351
+ 'title' => __('Wallet', 'credex'),
352
+ 'render_callback' => function () {
353
+ echo do_shortcode('[credex_user_wallet]');
354
+ },
355
+ ]);
356
+ }
357
+ ```
358
+
359
+ Both integrations wrap an existing shortcode. That is the shape this API is built for: you already have a rendering path, and you want it to appear inside the portal chrome rather than on a standalone page.
360
+
361
+ ## Where your tab lands
362
+
363
+ Each registration inserts its item **immediately before `profile`** in the menu array. Two add-ons registering on the same hook therefore end up in the order their filters ran, both above Profile — so relative order between add-ons is plugin load order, which is alphabetical by directory name and not something you should build on.
364
+
365
+ If placement genuinely matters, hook `fluent_cart/global_customer_menu_items` at a late priority and reorder the array yourself. Bear in mind that `licenses` is unset unless Pro is active with the license module on, and `subscriptions` is unset for customers who have none — so write reordering code that tolerates missing keys.
366
+
367
+ Active-tab highlighting needs nothing from you. When your endpoint matches, `maybeCustomEndpointContent()` filters `fluent_cart/customer_portal/active_tab` to your slug, and the inline script in `customer_app.php` adds `.active_customer_menu` to `.fct-customer-nav-item-`.
368
+
369
+ ## Checklist
370
+
371
+ - [ ] Registered inside `add_action('fluent_cart/init', …)` — no `function_exists()` or `class_exists()` guard needed
372
+ - [ ] Called through `fluent_cart_api()`, not the class directly
373
+ - [ ] Namespaced slug — not `wallet`, `order`, `subscription`, or anything else a core route might claim
374
+ - [ ] Wrapped in `try/catch` if the slug isn't a literal
375
+ - [ ] Using `page_id` if the page is editable content, with the Account page as its **parent** and its slug matching the endpoint slug
376
+ - [ ] No child page parked under Account without a matching endpoint registered
377
+ - [ ] Every dynamic value in the callback escaped
378
+ - [ ] Customer resolved from the session, never from the request
379
+ - [ ] Assets enqueued conditionally — nothing from core's bundle is available
380
+ - [ ] Styled against `--fct-customer-dashboard-*`, not hard-coded colors
381
+ - [ ] Icon reduced to `svg`/`path`/`g` with `fill="currentColor"`
382
+
383
+ ## When not to use this
384
+
385
+ `addCustomerDashboardEndpoint()` gives you a **whole page** reached by a **full page load**. Two cases where that's the wrong tool:
386
+
387
+ **You want a section inside an existing portal page** — a block on the profile page, extra rows under an order. Use `fluent_cart/customer_portal/profile_sections` and the dynamic per-slug section filter instead. Those render inside the SPA, so they need no navigation at all and cost no page load.
388
+
389
+ **You want a genuinely interactive app** — something with client-side state that a customer moves in and out of. A full page load on every entry and exit will be felt. Consider whether the work belongs on your own page template outside the portal, linked from a portal tab.
390
+
391
+ For everything else — a wallet, a support inbox, saved payment methods, a membership summary, a help page — one PHP call is the entire integration: `render_callback` when you have a renderer, `page_id` when a site owner should own the content. The routing was already there. All this API does is tell it your name.
392
+
393
+ ---
394
+
395
+ *Source references: `api/FluentCartGeneralApi.php`, `app/Hooks/Handlers/ShortCodes/CustomerProfileHandler.php`, `app/Modules/Templating/AssetLoader.php`, `resources/public/customer-profile/Start.js`. Filter documentation: [customer & subscription filters](/hooks/filters/customers-and-subscriptions.md).*