fluentcart-developer 3.0.0 → 3.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (609) hide show
  1. package/LICENSE.md +26 -26
  2. package/README.md +59 -59
  3. package/dist/cards/fluentcart/templates-native.js +1087 -1087
  4. package/dist/cards/fluentcart/tools.js +2309 -2309
  5. package/dist/skills/fluentcart-developer/SKILL.md +108 -108
  6. package/dist/skills/fluentcart-developer/examples/README.md +30 -30
  7. package/dist/skills/fluentcart-developer/examples/fluentcart-starter-child-theme/fluent-cart/checkout.php +32 -32
  8. package/dist/skills/fluentcart-developer/examples/fluentcart-starter-child-theme/functions.php +40 -40
  9. package/dist/skills/fluentcart-developer/examples/sample-custom-addon/fluentcart-custom-addon.php +113 -113
  10. package/dist/skills/fluentcart-developer/examples/sample-custom-payment-gateway/fluentcart-custom-gateway-example.php +148 -148
  11. package/dist/skills/fluentcart-developer/examples/sample-fee-surcharge-plugin/fluentcart-fee-surcharge.php +38 -38
  12. package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/README.md +22 -22
  13. package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/sample-plugin-with-licensing-sdk.php +79 -79
  14. package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/updater/FluentLicensing.php +303 -303
  15. package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/updater/LicenseSettings.php +566 -566
  16. package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/updater/PluginUpdater.php +304 -304
  17. package/dist/skills/fluentcart-developer/examples/sample-shipping-carrier/fluentcart-custom-shipping-carrier.php +61 -61
  18. package/dist/skills/fluentcart-developer/references/api/authentication.md +452 -452
  19. package/dist/skills/fluentcart-developer/references/api/coupons.md +786 -786
  20. package/dist/skills/fluentcart-developer/references/api/customers.md +889 -889
  21. package/dist/skills/fluentcart-developer/references/api/files.md +609 -609
  22. package/dist/skills/fluentcart-developer/references/api/index.md +432 -432
  23. package/dist/skills/fluentcart-developer/references/api/licensing.md +633 -633
  24. package/dist/skills/fluentcart-developer/references/api/order-bump.md +384 -384
  25. package/dist/skills/fluentcart-developer/references/api/orders.md +814 -814
  26. package/dist/skills/fluentcart-developer/references/api/products.md +866 -866
  27. package/dist/skills/fluentcart-developer/references/api/roles-permissions.md +536 -536
  28. package/dist/skills/fluentcart-developer/references/api/subscriptions.md +827 -827
  29. package/dist/skills/fluentcart-developer/references/database/index.md +44 -44
  30. package/dist/skills/fluentcart-developer/references/database/models/activity.md +178 -178
  31. package/dist/skills/fluentcart-developer/references/database/models/applied-coupon.md +291 -291
  32. package/dist/skills/fluentcart-developer/references/database/models/attribute-group.md +239 -239
  33. package/dist/skills/fluentcart-developer/references/database/models/attribute-relation.md +181 -181
  34. package/dist/skills/fluentcart-developer/references/database/models/attribute-term.md +219 -219
  35. package/dist/skills/fluentcart-developer/references/database/models/cart.md +645 -645
  36. package/dist/skills/fluentcart-developer/references/database/models/coupon.md +427 -427
  37. package/dist/skills/fluentcart-developer/references/database/models/customer-addresses.md +348 -348
  38. package/dist/skills/fluentcart-developer/references/database/models/customer-meta.md +156 -156
  39. package/dist/skills/fluentcart-developer/references/database/models/customer.md +584 -584
  40. package/dist/skills/fluentcart-developer/references/database/models/dynamic-model.md +163 -163
  41. package/dist/skills/fluentcart-developer/references/database/models/label-relationship.md +155 -155
  42. package/dist/skills/fluentcart-developer/references/database/models/label.md +153 -153
  43. package/dist/skills/fluentcart-developer/references/database/models/license-activation.md +182 -182
  44. package/dist/skills/fluentcart-developer/references/database/models/license-meta.md +163 -163
  45. package/dist/skills/fluentcart-developer/references/database/models/license-site.md +208 -208
  46. package/dist/skills/fluentcart-developer/references/database/models/license.md +640 -640
  47. package/dist/skills/fluentcart-developer/references/database/models/meta.md +233 -233
  48. package/dist/skills/fluentcart-developer/references/database/models/order-address.md +391 -391
  49. package/dist/skills/fluentcart-developer/references/database/models/order-download-permission.md +144 -144
  50. package/dist/skills/fluentcart-developer/references/database/models/order-item.md +383 -383
  51. package/dist/skills/fluentcart-developer/references/database/models/order-meta.md +303 -303
  52. package/dist/skills/fluentcart-developer/references/database/models/order-operation.md +158 -158
  53. package/dist/skills/fluentcart-developer/references/database/models/order-promotion-stat.md +175 -175
  54. package/dist/skills/fluentcart-developer/references/database/models/order-promotion.md +250 -250
  55. package/dist/skills/fluentcart-developer/references/database/models/order-tax-rate.md +172 -172
  56. package/dist/skills/fluentcart-developer/references/database/models/order-transaction.md +440 -440
  57. package/dist/skills/fluentcart-developer/references/database/models/order.md +727 -727
  58. package/dist/skills/fluentcart-developer/references/database/models/product-detail.md +397 -397
  59. package/dist/skills/fluentcart-developer/references/database/models/product-download.md +258 -258
  60. package/dist/skills/fluentcart-developer/references/database/models/product-meta.md +153 -153
  61. package/dist/skills/fluentcart-developer/references/database/models/product-variation.md +556 -556
  62. package/dist/skills/fluentcart-developer/references/database/models/product.md +580 -580
  63. package/dist/skills/fluentcart-developer/references/database/models/relationships.md +427 -427
  64. package/dist/skills/fluentcart-developer/references/database/models/scheduled-action.md +175 -175
  65. package/dist/skills/fluentcart-developer/references/database/models/shipping-class.md +148 -148
  66. package/dist/skills/fluentcart-developer/references/database/models/shipping-method.md +280 -280
  67. package/dist/skills/fluentcart-developer/references/database/models/shipping-zone.md +205 -205
  68. package/dist/skills/fluentcart-developer/references/database/models/subscription-meta.md +173 -173
  69. package/dist/skills/fluentcart-developer/references/database/models/subscription.md +528 -528
  70. package/dist/skills/fluentcart-developer/references/database/models/tax-class.md +195 -195
  71. package/dist/skills/fluentcart-developer/references/database/models/tax-rate.md +225 -225
  72. package/dist/skills/fluentcart-developer/references/database/models/user-meta.md +166 -166
  73. package/dist/skills/fluentcart-developer/references/database/models/user.md +220 -220
  74. package/dist/skills/fluentcart-developer/references/database/models.md +404 -404
  75. package/dist/skills/fluentcart-developer/references/database/query-builder.md +860 -860
  76. package/dist/skills/fluentcart-developer/references/database/readme.md +276 -276
  77. package/dist/skills/fluentcart-developer/references/database/schema.md +1002 -1002
  78. package/dist/skills/fluentcart-developer/references/engineering/adding-custom-pages-to-the-customer-dashboard.md +395 -395
  79. package/dist/skills/fluentcart-developer/references/engineering/index.md +4 -4
  80. package/dist/skills/fluentcart-developer/references/engineering.md +4 -4
  81. package/dist/skills/fluentcart-developer/references/getting-started.md +249 -249
  82. package/dist/skills/fluentcart-developer/references/guides/frontend.md +519 -519
  83. package/dist/skills/fluentcart-developer/references/guides/index.md +107 -107
  84. package/dist/skills/fluentcart-developer/references/guides/integrations.md +600 -600
  85. package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/index.md +237 -237
  86. package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/labels-and-tracking.md +481 -481
  87. package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/live-rates.md +269 -269
  88. package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/reference.md +223 -223
  89. package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/settings.md +370 -370
  90. package/dist/skills/fluentcart-developer/references/guides/shipping-carrier.md +237 -237
  91. package/dist/skills/fluentcart-developer/references/guides/subscriptions.md +217 -217
  92. package/dist/skills/fluentcart-developer/references/hooks/actions/admin-and-templates.md +1079 -1079
  93. package/dist/skills/fluentcart-developer/references/hooks/actions/cart-and-checkout.md +1795 -1795
  94. package/dist/skills/fluentcart-developer/references/hooks/actions/customers-and-users.md +327 -327
  95. package/dist/skills/fluentcart-developer/references/hooks/actions/licenses.md +829 -829
  96. package/dist/skills/fluentcart-developer/references/hooks/actions/modules.md +81 -81
  97. package/dist/skills/fluentcart-developer/references/hooks/actions/orders.md +757 -757
  98. package/dist/skills/fluentcart-developer/references/hooks/actions/payments-and-integrations.md +1163 -1163
  99. package/dist/skills/fluentcart-developer/references/hooks/actions/pro-modules.md +219 -219
  100. package/dist/skills/fluentcart-developer/references/hooks/actions/products-and-coupons.md +1019 -1019
  101. package/dist/skills/fluentcart-developer/references/hooks/actions/subscriptions.md +1290 -1290
  102. package/dist/skills/fluentcart-developer/references/hooks/actions.md +16 -16
  103. package/dist/skills/fluentcart-developer/references/hooks/deprecated.md +60 -60
  104. package/dist/skills/fluentcart-developer/references/hooks/filters/cart-and-checkout.md +2032 -2032
  105. package/dist/skills/fluentcart-developer/references/hooks/filters/customers-and-subscriptions.md +1746 -1746
  106. package/dist/skills/fluentcart-developer/references/hooks/filters/integrations-and-advanced.md +2439 -2439
  107. package/dist/skills/fluentcart-developer/references/hooks/filters/modules.md +464 -464
  108. package/dist/skills/fluentcart-developer/references/hooks/filters/orders-and-payments.md +2658 -2658
  109. package/dist/skills/fluentcart-developer/references/hooks/filters/pro-modules.md +502 -502
  110. package/dist/skills/fluentcart-developer/references/hooks/filters/products-and-pricing.md +1785 -1785
  111. package/dist/skills/fluentcart-developer/references/hooks/filters/settings-and-configuration.md +2966 -2966
  112. package/dist/skills/fluentcart-developer/references/hooks/filters.md +14 -14
  113. package/dist/skills/fluentcart-developer/references/hooks/index.md +35 -35
  114. package/dist/skills/fluentcart-developer/references/index.md +625 -625
  115. package/dist/skills/fluentcart-developer/references/modules/fee-system.md +427 -427
  116. package/dist/skills/fluentcart-developer/references/modules/ghost-product-selling.md +440 -440
  117. package/dist/skills/fluentcart-developer/references/modules/index.md +484 -484
  118. package/dist/skills/fluentcart-developer/references/modules/licensing.md +342 -342
  119. package/dist/skills/fluentcart-developer/references/modules/order-bump.md +433 -433
  120. package/dist/skills/fluentcart-developer/references/modules/payment-methods.md +129 -129
  121. package/dist/skills/fluentcart-developer/references/modules/refunds.md +170 -170
  122. package/dist/skills/fluentcart-developer/references/modules/shipping.md +846 -846
  123. package/dist/skills/fluentcart-developer/references/modules/storage.md +986 -986
  124. package/dist/skills/fluentcart-developer/references/modules/subscription-vendor-ids.md +186 -186
  125. package/dist/skills/fluentcart-developer/references/modules/subscriptions.md +678 -678
  126. package/dist/skills/fluentcart-developer/references/payment-methods-integration/index.md +164 -164
  127. package/dist/skills/fluentcart-developer/references/payment-methods-integration/paddle-example.md +1648 -1648
  128. package/dist/skills/fluentcart-developer/references/payment-methods-integration/payment/setting/fields.md +353 -353
  129. package/dist/skills/fluentcart-developer/references/payment-methods-integration/quick-implementation.md +1079 -1079
  130. package/dist/skills/fluentcart-developer/references/payment-methods-integration.md +164 -164
  131. package/dist/skills/fluentcart-developer/references/restapi/checkout.md +573 -573
  132. package/dist/skills/fluentcart-developer/references/restapi/coupons.md +958 -958
  133. package/dist/skills/fluentcart-developer/references/restapi/customer-profile.md +1423 -1423
  134. package/dist/skills/fluentcart-developer/references/restapi/customers.md +1103 -1103
  135. package/dist/skills/fluentcart-developer/references/restapi/dashboard.md +1083 -1083
  136. package/dist/skills/fluentcart-developer/references/restapi/data-export.md +132 -132
  137. package/dist/skills/fluentcart-developer/references/restapi/email-notifications.md +846 -846
  138. package/dist/skills/fluentcart-developer/references/restapi/files.md +313 -313
  139. package/dist/skills/fluentcart-developer/references/restapi/index.md +127 -127
  140. package/dist/skills/fluentcart-developer/references/restapi/integrations.md +1000 -1000
  141. package/dist/skills/fluentcart-developer/references/restapi/inventory.md +192 -192
  142. package/dist/skills/fluentcart-developer/references/restapi/labels-and-attributes.md +797 -797
  143. package/dist/skills/fluentcart-developer/references/restapi/licensing.md +1733 -1733
  144. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-available-shipping-methods.md +30 -30
  145. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-checkout-summary.md +28 -28
  146. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-country-info.md +29 -29
  147. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-order-info.md +28 -28
  148. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-shipping-methods-list-view.md +30 -30
  149. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/login.md +66 -66
  150. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/place-order.md +179 -179
  151. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/apply-coupon.md +83 -83
  152. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/cancel-coupon.md +87 -87
  153. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/check-product-eligibility.md +59 -59
  154. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/create-coupon.md +230 -230
  155. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/delete-coupon.md +29 -29
  156. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/get-coupon-settings.md +20 -20
  157. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/get-coupon.md +27 -27
  158. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/list-coupon-codes.md +20 -20
  159. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/list-coupons.md +37 -37
  160. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/re-apply-coupons.md +75 -75
  161. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/store-coupon-settings.md +40 -40
  162. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/update-coupon.md +133 -133
  163. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/create-address-checkout.md +138 -138
  164. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/create-profile-address.md +119 -119
  165. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/dashboard-overview.md +22 -22
  166. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/delete-profile-address.md +46 -46
  167. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-order-details.md +30 -30
  168. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-portal-sections.md +29 -29
  169. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-profile-details.md +22 -22
  170. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-transaction-billing-address.md +30 -30
  171. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-upgrade-paths.md +31 -31
  172. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/list-downloads.md +29 -29
  173. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/list-orders.md +28 -28
  174. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/make-profile-address-primary.md +55 -55
  175. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/pause-subscription.md +29 -29
  176. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/resume-subscription.md +29 -29
  177. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/save-transaction-billing-address.md +92 -92
  178. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/select-address-for-checkout.md +32 -32
  179. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/update-profile-address.md +115 -115
  180. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/update-profile-details.md +69 -69
  181. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/attach-user.md +50 -50
  182. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/bulk-actions.md +65 -65
  183. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/create-address.md +135 -135
  184. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/create-customer.md +108 -108
  185. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/delete-address.md +62 -62
  186. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/detach-user.md +28 -28
  187. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/find-customer-order.md +27 -27
  188. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-attachable-users.md +20 -20
  189. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer-addresses.md +28 -28
  190. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer-orders.md +37 -37
  191. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer-stats.md +27 -27
  192. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer.md +32 -32
  193. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/list-customers.md +37 -37
  194. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/recalculate-ltv.md +28 -28
  195. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/set-primary-address.md +72 -72
  196. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/update-additional-info.md +55 -55
  197. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/update-address.md +144 -144
  198. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/update-customer.md +123 -123
  199. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/attach-note-to-order.md +49 -49
  200. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/create-all-pages.md +21 -21
  201. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/create-single-page.md +55 -55
  202. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/delete-activity.md +28 -28
  203. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-country-info.md +29 -29
  204. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-dashboard-stats.md +22 -22
  205. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-filter-options.md +31 -31
  206. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-onboarding-data.md +20 -20
  207. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-onboarding-settings.md +20 -20
  208. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-print-templates.md +20 -20
  209. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-search-options.md +27 -27
  210. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-widgets.md +28 -28
  211. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/initialize-app.md +20 -20
  212. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/list-activities.md +33 -33
  213. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/list-attachments.md +21 -21
  214. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/list-countries.md +20 -20
  215. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/mark-activity-read.md +53 -53
  216. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/run-data-backfills.md +21 -21
  217. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/save-onboarding-settings.md +54 -54
  218. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/save-onboarding-tax-settings.md +73 -73
  219. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/save-print-templates.md +64 -64
  220. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/upload-attachment.md +42 -42
  221. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-customers-batch.md +129 -129
  222. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-licenses-batch.md +133 -133
  223. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-orders-batch.md +129 -129
  224. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-subscriptions-batch.md +129 -129
  225. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-customers-export-schema.md +21 -21
  226. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-licenses-export-schema.md +26 -26
  227. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-orders-export-schema.md +21 -21
  228. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-subscriptions-export-schema.md +21 -21
  229. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/enable-notification.md +57 -57
  230. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-digest-settings.md +22 -22
  231. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-notification.md +30 -30
  232. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-reminders.md +22 -22
  233. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-settings.md +22 -22
  234. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-shortcodes.md +22 -22
  235. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/list-notifications.md +20 -20
  236. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/preview-default-template.md +66 -66
  237. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/preview-notification.md +50 -50
  238. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/save-digest-settings.md +101 -101
  239. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/save-reminders.md +162 -162
  240. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/save-settings.md +99 -99
  241. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/send-digest-test.md +47 -47
  242. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/send-manual-reminder.md +51 -51
  243. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/update-notification.md +93 -93
  244. package/dist/skills/fluentcart-developer/references/restapi/operations/files/delete-file.md +31 -31
  245. package/dist/skills/fluentcart-developer/references/restapi/operations/files/get-bucket-list.md +28 -28
  246. package/dist/skills/fluentcart-developer/references/restapi/operations/files/list-files.md +30 -30
  247. package/dist/skills/fluentcart-developer/references/restapi/operations/files/upload-editor-file.md +32 -32
  248. package/dist/skills/fluentcart-developer/references/restapi/operations/files/upload-file.md +34 -34
  249. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/chained-data-request.md +46 -46
  250. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/change-feed-status.md +51 -51
  251. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/delete-feed.md +27 -27
  252. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-dynamic-options.md +29 -29
  253. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-feed-lists.md +27 -27
  254. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-feed-settings.md +27 -27
  255. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-global-feeds.md +20 -20
  256. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-global-settings.md +26 -26
  257. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/install-addon-plugin.md +49 -49
  258. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/list-addons.md +20 -20
  259. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/save-feed-settings.md +52 -52
  260. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/set-global-settings.md +50 -50
  261. package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/bulk-update-stock.md +94 -94
  262. package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/export-inventory.md +81 -81
  263. package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/get-adjustment-history.md +26 -26
  264. package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/get-inventory-stats.md +21 -21
  265. package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/list-inventory.md +33 -33
  266. package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/update-stock.md +75 -75
  267. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/create-attribute-group.md +31 -31
  268. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/create-label.md +31 -31
  269. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/create-terms.md +90 -90
  270. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/delete-attribute-group.md +28 -28
  271. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/delete-attribute-term.md +29 -29
  272. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/get-attribute-group.md +28 -28
  273. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/get-attribute-library.md +20 -20
  274. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/list-attribute-groups.md +32 -32
  275. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/list-attribute-terms.md +33 -33
  276. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/list-labels.md +20 -20
  277. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/reorder-groups.md +51 -51
  278. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/reorder-terms.md +56 -56
  279. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/update-attribute-group.md +37 -37
  280. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/update-attribute-term.md +39 -39
  281. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/update-label-selections.md +32 -32
  282. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/activate-plugin-license.md +41 -41
  283. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/activate-site-admin.md +60 -60
  284. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/deactivate-plugin-license.md +18 -18
  285. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/deactivate-site-admin.md +67 -67
  286. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/deactivate-site-customer.md +47 -47
  287. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/delete-license.md +24 -24
  288. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/extend-license-validity.md +47 -47
  289. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-customer-license-details.md +25 -25
  290. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-customer-licenses-admin.md +26 -26
  291. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-license-activations.md +25 -25
  292. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-license-details.md +25 -25
  293. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-license-site.md +30 -30
  294. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-plugin-license-status.md +18 -18
  295. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-product-license-settings.md +24 -24
  296. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/list-customer-licenses.md +25 -25
  297. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/list-license-sites.md +33 -33
  298. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/list-licenses.md +38 -38
  299. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-activate-license.md +54 -54
  300. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-check-license.md +26 -26
  301. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-deactivate-license.md +46 -46
  302. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-download-license-package.md +23 -23
  303. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-get-license-version.md +26 -26
  304. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/regenerate-license-key.md +24 -24
  305. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/save-product-license-settings.md +193 -193
  306. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/update-license-activation-limit.md +53 -53
  307. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/update-license-status.md +52 -52
  308. package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/create-order-bump.md +47 -47
  309. package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/delete-order-bump.md +25 -25
  310. package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/get-order-bump.md +25 -25
  311. package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/list-order-bumps.md +29 -29
  312. package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/update-order-bump.md +141 -141
  313. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/accept-dispute.md +47 -47
  314. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/bulk-actions.md +72 -72
  315. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/calculate-shipping.md +67 -67
  316. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/calculate-tax.md +98 -98
  317. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/change-customer.md +50 -50
  318. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/charge-now.md +29 -29
  319. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-and-change-customer.md +92 -92
  320. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-custom-order-item.md +68 -68
  321. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-order.md +351 -351
  322. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-renewal-now.md +29 -29
  323. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/delete-order.md +28 -28
  324. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/generate-missing-licenses.md +29 -29
  325. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-order-transactions.md +27 -27
  326. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-order.md +27 -27
  327. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-renewal.md +28 -28
  328. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-shipping-methods.md +28 -28
  329. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-single-transaction.md +28 -28
  330. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/list-order-currencies.md +22 -22
  331. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/list-orders.md +42 -42
  332. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/list-renewals.md +28 -28
  333. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/mark-as-paid.md +61 -61
  334. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/price-order.md +135 -135
  335. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/refund-order.md +72 -72
  336. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/resend-renewal-invoice.md +29 -29
  337. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/skip-renewal.md +48 -48
  338. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/sync-order-statuses.md +28 -28
  339. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/sync-pending-transaction.md +29 -29
  340. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-order-address-id.md +60 -60
  341. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-order-address.md +98 -98
  342. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-order.md +172 -172
  343. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-statuses.md +77 -77
  344. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-subscription-details.md +84 -84
  345. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-transaction-status.md +51 -51
  346. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/void-renewal.md +30 -30
  347. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/create-pdf-template.md +42 -42
  348. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/delete-pdf-template.md +26 -26
  349. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/download-pdf-preview.md +44 -44
  350. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-factory-default-templates.md +19 -19
  351. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-pdf-status.md +21 -21
  352. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-pdf-template.md +26 -26
  353. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-saved-templates.md +21 -21
  354. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-seller-details.md +19 -19
  355. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/list-pdf-templates.md +19 -19
  356. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/save-pdf-template.md +53 -53
  357. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/save-seller-details.md +97 -97
  358. package/dist/skills/fluentcart-developer/references/restapi/operations/products/add-product-terms.md +64 -64
  359. package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-edit-fetch.md +30 -30
  360. package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-insert-products.md +62 -62
  361. package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-update-products.md +59 -59
  362. package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-update-variants.md +83 -83
  363. package/dist/skills/fluentcart-developer/references/restapi/operations/products/change-integration-status.md +64 -64
  364. package/dist/skills/fluentcart-developer/references/restapi/operations/products/create-dummy-products.md +45 -45
  365. package/dist/skills/fluentcart-developer/references/restapi/operations/products/create-product.md +81 -81
  366. package/dist/skills/fluentcart-developer/references/restapi/operations/products/create-variation.md +181 -181
  367. package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-downloadable-file.md +27 -27
  368. package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-product-integration.md +30 -30
  369. package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-product.md +27 -27
  370. package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-taxonomy-term.md +55 -55
  371. package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-upgrade-path.md +27 -27
  372. package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-variation.md +27 -27
  373. package/dist/skills/fluentcart-developer/references/restapi/operations/products/do-bulk-action.md +56 -56
  374. package/dist/skills/fluentcart-developer/references/restapi/operations/products/duplicate-product.md +56 -56
  375. package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-products-by-ids.md +26 -26
  376. package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-taxonomy-terms.md +20 -20
  377. package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-terms-by-parent.md +60 -60
  378. package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-variations-by-ids.md +26 -26
  379. package/dist/skills/fluentcart-developer/references/restapi/operations/products/find-subscription-variants.md +26 -26
  380. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-bundle-info.md +27 -27
  381. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-downloadable-url.md +27 -27
  382. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-max-excerpt-word-count.md +20 -20
  383. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-pricing-widgets.md +27 -27
  384. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product-integration-feeds.md +29 -29
  385. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product-integration-settings.md +31 -31
  386. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product-pricing.md +28 -28
  387. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product.md +28 -28
  388. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-related-products.md +31 -31
  389. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-upgrade-settings.md +27 -27
  390. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-variation-upgrade-paths.md +28 -28
  391. package/dist/skills/fluentcart-developer/references/restapi/operations/products/group-bulk-update-variants.md +103 -103
  392. package/dist/skills/fluentcart-developer/references/restapi/operations/products/list-all-variants.md +26 -26
  393. package/dist/skills/fluentcart-developer/references/restapi/operations/products/list-product-variations.md +26 -26
  394. package/dist/skills/fluentcart-developer/references/restapi/operations/products/list-products.md +34 -34
  395. package/dist/skills/fluentcart-developer/references/restapi/operations/products/remove-shipping-class.md +27 -27
  396. package/dist/skills/fluentcart-developer/references/restapi/operations/products/remove-tax-class.md +27 -27
  397. package/dist/skills/fluentcart-developer/references/restapi/operations/products/save-bundle-info.md +56 -56
  398. package/dist/skills/fluentcart-developer/references/restapi/operations/products/save-product-integration.md +62 -62
  399. package/dist/skills/fluentcart-developer/references/restapi/operations/products/save-upgrade-path.md +78 -78
  400. package/dist/skills/fluentcart-developer/references/restapi/operations/products/search-product-variant-options.md +29 -29
  401. package/dist/skills/fluentcart-developer/references/restapi/operations/products/search-products-by-name.md +28 -28
  402. package/dist/skills/fluentcart-developer/references/restapi/operations/products/search-variants-by-name.md +28 -28
  403. package/dist/skills/fluentcart-developer/references/restapi/operations/products/set-variation-media.md +74 -74
  404. package/dist/skills/fluentcart-developer/references/restapi/operations/products/suggest-sku.md +28 -28
  405. package/dist/skills/fluentcart-developer/references/restapi/operations/products/sync-downloadable-files.md +134 -134
  406. package/dist/skills/fluentcart-developer/references/restapi/operations/products/sync-taxonomy-terms.md +61 -61
  407. package/dist/skills/fluentcart-developer/references/restapi/operations/products/toggle-product-tax-exemption.md +56 -56
  408. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-downloadable-file.md +98 -98
  409. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-inventory.md +56 -56
  410. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-long-desc-editor-mode.md +49 -49
  411. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-manage-stock.md +53 -53
  412. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-product-detail.md +58 -58
  413. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-product-pricing.md +225 -225
  414. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-shipping-class.md +49 -49
  415. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-tax-class.md +49 -49
  416. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-upgrade-path.md +78 -78
  417. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variant-option.md +79 -79
  418. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variant-tax-exemption.md +56 -56
  419. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variation-pricing-table.md +49 -49
  420. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variation.md +105 -105
  421. package/dist/skills/fluentcart-developer/references/restapi/operations/public-shop/get-product-views.md +34 -34
  422. package/dist/skills/fluentcart-developer/references/restapi/operations/public-shop/list-products.md +42 -42
  423. package/dist/skills/fluentcart-developer/references/restapi/operations/public-shop/search-products.md +30 -30
  424. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/channel-rules.md +24 -24
  425. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/country-heat-map.md +22 -22
  426. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/coupon-overview.md +37 -37
  427. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/coupons.md +36 -36
  428. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-insights.md +31 -31
  429. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-overview.md +36 -36
  430. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-repeat.md +35 -35
  431. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-segment-customers.md +36 -36
  432. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-segments.md +30 -30
  433. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-value.md +34 -34
  434. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/dashboard-stats.md +30 -30
  435. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/failed-orders.md +34 -34
  436. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-new-vs-returning-customer.md +34 -34
  437. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-report-by-day-and-hour.md +34 -34
  438. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-report-meta.md +29 -29
  439. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-top-sold-products.md +34 -34
  440. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/future-renewals.md +31 -31
  441. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/generate-retention-snapshots.md +24 -24
  442. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-overview.md +30 -30
  443. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-recent-activities.md +26 -26
  444. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-recent-orders.md +20 -20
  445. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-revenue.md +37 -37
  446. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/installments-at-risk.md +35 -35
  447. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/installments-variations.md +33 -33
  448. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/installments.md +33 -33
  449. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/item-count-distribution.md +34 -34
  450. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/license-chart.md +30 -30
  451. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/license-pie-chart.md +22 -22
  452. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/license-summary.md +22 -22
  453. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/locations.md +43 -43
  454. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-chart.md +37 -37
  455. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-completion-time.md +34 -34
  456. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-mix.md +34 -34
  457. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-value-distribution.md +34 -34
  458. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/payment-methods-disputes.md +38 -38
  459. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/payment-methods-methods.md +36 -36
  460. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/payment-methods.md +37 -37
  461. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-comparison-launch.md +33 -33
  462. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-comparison.md +40 -40
  463. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-detail.md +37 -37
  464. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-sales.md +37 -37
  465. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/refunds-overview.md +37 -37
  466. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/retention-snapshots-step.md +45 -45
  467. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/sales-growth-chart.md +35 -35
  468. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/save-channel-rules.md +73 -73
  469. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/source-channels.md +37 -37
  470. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/sources.md +49 -49
  471. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-cohorts.md +33 -33
  472. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-health.md +30 -30
  473. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-rebuys.md +37 -37
  474. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-retention.md +34 -34
  475. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-variations.md +22 -22
  476. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscriptions-overview.md +37 -37
  477. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/weeks-between-refund.md +34 -34
  478. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/assign-role.md +48 -48
  479. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/delete-role-assignment.md +47 -47
  480. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/get-role.md +25 -25
  481. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/list-managers.md +18 -18
  482. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/list-roles.md +18 -18
  483. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/search-users.md +25 -25
  484. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/update-role.md +43 -43
  485. package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/create-saved-view.md +106 -106
  486. package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/delete-saved-view.md +26 -26
  487. package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/list-saved-views.md +25 -25
  488. package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/update-saved-view.md +83 -83
  489. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/activate-payment-addon.md +44 -44
  490. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/activate-plugin-addon.md +44 -44
  491. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/change-storage-driver-status.md +56 -56
  492. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/check-paypal-webhook.md +26 -26
  493. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/create-storage-bucket.md +63 -63
  494. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/disconnect-payment-method.md +55 -55
  495. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/exchange-paypal-seller-auth-token.md +62 -62
  496. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-active-storage-drivers.md +20 -20
  497. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-checkout-fields.md +22 -22
  498. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-email-shortcodes.md +20 -20
  499. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-mcp-config-snippets.md +26 -26
  500. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-mcp-status.md +20 -20
  501. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-module-settings.md +20 -20
  502. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-payment-method-connection-info.md +26 -26
  503. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-payment-method-settings.md +26 -26
  504. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-permissions.md +22 -22
  505. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-plugin-addons.md +20 -20
  506. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-storage-driver-settings.md +27 -27
  507. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-store-settings.md +26 -26
  508. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/install-mcp-adapter.md +21 -21
  509. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/install-payment-addon.md +60 -60
  510. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/install-plugin-addon.md +64 -64
  511. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/list-all-payment-methods.md +20 -20
  512. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/list-all-storage-drivers.md +20 -20
  513. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/list-storage-buckets.md +67 -67
  514. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/reorder-payment-methods.md +55 -55
  515. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/reset-storage-driver-settings.md +45 -45
  516. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-checkout-fields.md +133 -133
  517. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-confirmation-settings.md +68 -68
  518. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-module-settings.md +68 -68
  519. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-payment-method-design.md +67 -67
  520. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-payment-method-settings.md +58 -58
  521. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-permissions.md +68 -68
  522. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-storage-driver-settings.md +62 -62
  523. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-store-settings.md +239 -239
  524. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/setup-paypal-webhook.md +48 -48
  525. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/toggle-mcp.md +40 -40
  526. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/verify-storage-driver-connection.md +62 -62
  527. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/verify-turnstile-keys.md +55 -55
  528. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/create-shipping-class.md +73 -73
  529. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/create-shipping-method.md +110 -110
  530. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/create-shipping-zone.md +56 -56
  531. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/delete-shipping-class.md +29 -29
  532. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/delete-shipping-method.md +29 -29
  533. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/delete-shipping-zone.md +29 -29
  534. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-class-profile.md +30 -30
  535. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-class.md +29 -29
  536. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-packages.md +22 -22
  537. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-zone.md +27 -27
  538. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-zone-countries.md +22 -22
  539. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-zone-states.md +28 -28
  540. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/list-shipping-classes.md +31 -31
  541. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/list-shipping-zones.md +31 -31
  542. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/save-shipping-packages.md +112 -112
  543. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-shipping-class.md +79 -79
  544. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-shipping-method.md +113 -113
  545. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-shipping-zone.md +62 -62
  546. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-zone-order.md +52 -52
  547. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/cancel-auto-renew.md +30 -30
  548. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/cancel-subscription.md +52 -52
  549. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/confirm-subscription-switch.md +70 -70
  550. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/fetch-subscription-remote.md +28 -28
  551. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/generate-early-payment-link.md +29 -29
  552. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-customer-subscription.md +27 -27
  553. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-or-create-plan.md +69 -69
  554. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-setup-intent-attempts.md +30 -30
  555. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-subscription.md +28 -28
  556. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/initiate-early-payment.md +31 -31
  557. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/list-customer-subscriptions.md +27 -27
  558. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/list-subscriptions.md +39 -39
  559. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/pause-subscription.md +28 -28
  560. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/reactivate-subscription.md +28 -28
  561. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/resume-subscription.md +28 -28
  562. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/switch-payment-method.md +70 -70
  563. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/update-payment-method.md +69 -69
  564. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/update-vendor-ids.md +56 -56
  565. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/verify-vendor-ids.md +56 -56
  566. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/create-tax-class.md +51 -51
  567. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/create-tax-rate.md +117 -117
  568. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-product-override.md +27 -27
  569. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-shipping-tax-override.md +27 -27
  570. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-tax-class.md +28 -28
  571. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-tax-rate.md +27 -27
  572. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-country-tax-id.md +27 -27
  573. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-country-tax-rates.md +28 -28
  574. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-eu-vat-product-overrides.md +20 -20
  575. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-oss-country-rates.md +20 -20
  576. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-preconfigured-tax-rates.md +20 -20
  577. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-product-overrides.md +27 -27
  578. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-tax-settings.md +20 -20
  579. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/list-all-tax-rates.md +20 -20
  580. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/list-tax-classes.md +20 -20
  581. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/list-tax-records.md +37 -37
  582. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/mark-taxes-as-filed.md +58 -58
  583. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/reset-eu-vat-rates.md +21 -21
  584. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-configured-countries.md +57 -57
  585. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-country-tax-id.md +50 -50
  586. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-eu-vat-cross-border-settings.md +127 -127
  587. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-oss-country-rates.md +100 -100
  588. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-product-override.md +110 -110
  589. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-shipping-tax-override.md +52 -52
  590. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-tax-settings.md +166 -166
  591. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/update-country-status.md +54 -54
  592. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/update-tax-rate.md +116 -116
  593. package/dist/skills/fluentcart-developer/references/restapi/order-bumps.md +433 -433
  594. package/dist/skills/fluentcart-developer/references/restapi/orders.md +1212 -1212
  595. package/dist/skills/fluentcart-developer/references/restapi/pdf-templates.md +212 -212
  596. package/dist/skills/fluentcart-developer/references/restapi/products.md +2485 -2485
  597. package/dist/skills/fluentcart-developer/references/restapi/public-shop.md +191 -191
  598. package/dist/skills/fluentcart-developer/references/restapi/reports.md +3773 -3773
  599. package/dist/skills/fluentcart-developer/references/restapi/roles.md +403 -403
  600. package/dist/skills/fluentcart-developer/references/restapi/saved-views.md +136 -136
  601. package/dist/skills/fluentcart-developer/references/restapi/settings.md +1423 -1423
  602. package/dist/skills/fluentcart-developer/references/restapi/shipping.md +905 -905
  603. package/dist/skills/fluentcart-developer/references/restapi/subscriptions.md +1169 -1169
  604. package/dist/skills/fluentcart-developer/references/restapi/tax.md +1551 -1551
  605. package/dist/skills/fluentcart-developer/references/restapi.md +127 -127
  606. package/dist/skills/fluentcart-developer/scripts/cli.js +1 -1
  607. package/dist/version.d.ts +1 -1
  608. package/dist/version.js +1 -1
  609. package/package.json +66 -65
@@ -1,1083 +1,1083 @@
1
- # Dashboard & Utilities API
2
-
3
- Administrative endpoints for dashboard statistics, onboarding setup, app initialization, activity logging, print templates, and utility functions.
4
-
5
- **Base URL:** `https://your-site.com/wp-json/fluent-cart/v2`
6
-
7
- ---
8
-
9
- ## Dashboard
10
-
11
- Overview and statistics endpoints for the admin dashboard.
12
-
13
- **Prefix:** `dashboard`
14
-
15
- ---
16
-
17
- ### Get Onboarding Data
18
-
19
- GET `/fluent-cart/v2/dashboard`
20
-
21
- Retrieve the onboarding checklist with completion status for each setup step. Used to display the getting-started wizard on the dashboard.
22
-
23
- - **Policy:** `AdminPolicy`
24
-
25
- #### Parameters
26
-
27
- No parameters required.
28
-
29
- #### Response
30
-
31
- ```
32
- {
33
- "data": {
34
- "steps": {
35
- "page_setup": {
36
- "title": "Setup Pages",
37
- "text": "Customers to find what they're looking for by organising.",
38
- "icon": "Cart",
39
- "completed": false,
40
- "url": "https://example.com/wp-admin/admin.php?page=fluent-cart#/settings/store-settings/pages_setup"
41
- },
42
- "store_info": {
43
- "title": "Add Details to Store",
44
- "text": "Store details such as addresses, company info etc.",
45
- "icon": "StoreIcon",
46
- "completed": true,
47
- "url": "https://example.com/wp-admin/admin.php?page=fluent-cart#/settings/store-settings"
48
- },
49
- "product_info": {
50
- "title": "Add Your First Product",
51
- "text": "Share your brand story and build trust with customers.",
52
- "icon": "ShoppingCartIcon",
53
- "completed": false,
54
- "url": "https://example.com/wp-admin/admin.php?page=fluent-cart#/products"
55
- },
56
- "setup_payments": {
57
- "title": "Setup Payment Methods",
58
- "text": "Choose from fast & secure online and offline payment.",
59
- "icon": "PaymentIcon",
60
- "completed": true,
61
- "url": "https://example.com/wp-admin/admin.php?page=fluent-cart#/settings/payments"
62
- }
63
- },
64
- "completed": 2
65
- }
66
- }
67
- ```
68
-
69
- #### Completion Logic
70
-
71
- | Step | Completed When |
72
- | --- | --- |
73
- | `page_setup` | All generatable pages (shop, checkout, etc.) have page IDs assigned in store settings |
74
- | `store_info` | Both `store_name` and `store_logo` are set in store settings |
75
- | `product_info` | At least one product exists in the database |
76
- | `setup_payments` | At least one payment gateway is enabled |
77
-
78
- #### Example
79
-
80
- ```
81
- curl -X GET "https://example.com/wp-json/fluent-cart/v2/dashboard" \
82
- -u "username:app_password"
83
- ```
84
-
85
- ---
86
-
87
- ### Get Dashboard Stats
88
-
89
- GET `/fluent-cart/v2/dashboard/stats`
90
-
91
- Retrieve the dashboard tiles: total products, and the orders, net sales and refunds of the last 30 store days. The money tiles show the Revenue report's figures for the same days, in all currencies converted to the base currency, so they match the report they link to.
92
-
93
- - **Policy:** `DashboardPolicy`
94
- - **Permission:** `dashboard_stats/view`
95
-
96
- #### Parameters
97
-
98
- No parameters required.
99
-
100
- #### Response
101
-
102
- ```
103
- {
104
- "stats": [
105
- {
106
- "title": "Total Products",
107
- "current_count": "45",
108
- "icon": "Frame",
109
- "url": "https://example.com/wp-admin/admin.php?page=fluent-cart#/products?active_view=all"
110
- },
111
- {
112
- "title": "Orders",
113
- "current_count": 128,
114
- "icon": "AllOrdersIcon",
115
- "url": "https://example.com/wp-admin/admin.php?page=fluent-cart#/orders"
116
- },
117
- {
118
- "title": "Revenue",
119
- "current_count": 15420.5,
120
- "icon": "Currency",
121
- "url": "https://example.com/wp-admin/admin.php?page=fluent-cart#/reports/revenue",
122
- "has_currency": true,
123
- "currency": "USD",
124
- "excluded_orders": 0
125
- },
126
- {
127
- "title": "Refund",
128
- "current_count": 350,
129
- "icon": "Failed",
130
- "url": "https://example.com/wp-admin/admin.php?page=fluent-cart#/reports/refunds",
131
- "has_currency": true,
132
- "currency": "USD",
133
- "excluded_orders": 0
134
- }
135
- ]
136
- }
137
- ```
138
-
139
- The type of `current_count` differs per tile:
140
-
141
- | Tile | `current_count` | Source |
142
- | --- | --- | --- |
143
- | Total Products | integer string | `COUNT(*)` of products not in `trash` or `auto-draft` |
144
- | Orders | integer | Orders with payment status `paid`, `partially-paid`, `refunded` or `partially-refunded`. $0 orders count. |
145
- | Revenue | number, in major units (decimal) | The Revenue report's `summary.net_sales`: paid − refunds − the tax, shipping and fees the store kept |
146
- | Refund | number, in major units (decimal) | The Revenue report's `summary.total_refunded_amount` (all refunded money) |
147
-
148
- Money tiles also carry `currency` (the base currency) and `excluded_orders`: the number of orders that have no trusted exchange rate. The money tiles leave those orders out; the Orders tile counts them.
149
-
150
- INFO
151
-
152
- - **Orders, Revenue and Refund** cover the last 30 days in the WordPress site timezone, today included (the Revenue report's `last_30` preset).
153
- - Widgets with `has_currency: true` should be formatted with the base currency symbol.
154
- - The whole list passes through the `fluent_cart/dashboard_stats` filter.
155
-
156
- #### Example
157
-
158
- ```
159
- curl -X GET "https://example.com/wp-json/fluent-cart/v2/dashboard/stats" \
160
- -u "username:app_password"
161
- ```
162
-
163
- ---
164
-
165
- ## Onboarding
166
-
167
- Endpoints for the initial store setup wizard.
168
-
169
- **Prefix:** `onboarding`**Policy:** `AdminPolicy`
170
-
171
- ---
172
-
173
- ### Get Onboarding Settings
174
-
175
- GET `/fluent-cart/v2/onboarding`
176
-
177
- Retrieve the current store settings, available pages, and currency options for the onboarding wizard.
178
-
179
- #### Parameters
180
-
181
- No parameters required.
182
-
183
- #### Response
184
-
185
- ```
186
- {
187
- "pages": [
188
- { "label": "Shop", "value": 10 },
189
- { "label": "Checkout", "value": 12 }
190
- ],
191
- "currencies": [
192
- { "label": "United States Dollar ($)", "value": "USD" },
193
- { "label": "Euro (EUR)", "value": "EUR" },
194
- { "label": "British Pound (GBP)", "value": "GBP" }
195
- ],
196
- "default_settings": {
197
- "store_name": "My Store",
198
- "store_logo": "",
199
- "currency": "USD",
200
- "shop_page_id": "10",
201
- "checkout_page_id": "12",
202
- "customer_profile_page_id": ""
203
- },
204
- "tax_settings": {
205
- "enable_tax": "no",
206
- "tax_inclusion": "exclusive",
207
- "eu_method": "",
208
- "vat_number": ""
209
- }
210
- }
211
- ```
212
-
213
- #### Example
214
-
215
- ```
216
- curl -X GET "https://example.com/wp-json/fluent-cart/v2/onboarding" \
217
- -u "username:app_password"
218
- ```
219
-
220
- ---
221
-
222
- ### Save Onboarding Settings
223
-
224
- POST `/fluent-cart/v2/onboarding`
225
-
226
- Save store settings during the onboarding process. Merges submitted values with existing store settings. If a `category` value is provided, dummy products are created asynchronously.
227
-
228
- #### Parameters
229
-
230
- | Parameter | Type | Location | Required | Description |
231
- | --- | --- | --- | --- | --- |
232
- | `store_name` | string | body | No | The store name |
233
- | `store_logo` | string | body | No | URL of the store logo |
234
- | `currency` | string | body | No | Store currency code (e.g., `USD`, `EUR`) |
235
- | `category` | string | body | No | Product category for generating dummy products. Excluded from saved settings but triggers async dummy product creation. |
236
- | *...any store setting key* | mixed | body | No | Any valid store settings field |
237
-
238
- #### Response
239
-
240
- **Success:**
241
-
242
- ```
243
- {
244
- "message": "Store has been updated successfully"
245
- }
246
- ```
247
-
248
- **Error:**
249
-
250
- ```
251
- {
252
- "errors": "Failed to update!"
253
- }
254
- ```
255
-
256
- #### Example
257
-
258
- ```
259
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/onboarding" \
260
- -u "username:app_password" \
261
- -H "Content-Type: application/json" \
262
- -d '{
263
- "store_name": "My Awesome Store",
264
- "store_logo": "https://example.com/wp-content/uploads/logo.png",
265
- "currency": "USD"
266
- }'
267
- ```
268
-
269
- ---
270
-
271
- ### Create All Pages
272
-
273
- POST `/fluent-cart/v2/onboarding/create-pages`
274
-
275
- Create all required store pages (shop, checkout, customer profile, etc.) in bulk. Skips pages that already have valid page IDs assigned. After creation, returns the updated onboarding settings (same response as [Get Onboarding Settings](#get-onboarding-settings)).
276
-
277
- #### Parameters
278
-
279
- No parameters required.
280
-
281
- #### Response
282
-
283
- Same as [Get Onboarding Settings](#get-onboarding-settings) -- returns the updated pages, currencies, and default settings after page creation.
284
-
285
- #### Example
286
-
287
- ```
288
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/onboarding/create-pages" \
289
- -u "username:app_password"
290
- ```
291
-
292
- ---
293
-
294
- ### Create Single Page
295
-
296
- POST `/fluent-cart/v2/onboarding/create-page`
297
-
298
- Create a single store page (e.g., shop, checkout, customer profile) and optionally save the page ID to store settings.
299
-
300
- - **Request Class:** `CreatePageRequest`
301
-
302
- #### Parameters
303
-
304
- | Parameter | Type | Location | Required | Description |
305
- | --- | --- | --- | --- | --- |
306
- | `content` | string | body | Yes | The page key identifier with `_page_id` suffix (e.g., `shop_page_id`, `checkout_page_id`, `customer_profile_page_id`) |
307
- | `page_name` | string | body | Yes | The title for the new WordPress page |
308
- | `save_settings` | boolean | body | No | Whether to save the new page ID to store settings (default: `false`). When `true`, also flushes rewrite rules. |
309
-
310
- #### Response
311
-
312
- **Success:**
313
-
314
- ```
315
- {
316
- "page_id": "156",
317
- "page_name": "Shop",
318
- "link": "https://example.com/shop/"
319
- }
320
- ```
321
-
322
- **Error:**
323
-
324
- ```
325
- {
326
- "message": "Unable to create page"
327
- }
328
- ```
329
-
330
- #### Example
331
-
332
- ```
333
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/onboarding/create-page" \
334
- -u "username:app_password" \
335
- -H "Content-Type: application/json" \
336
- -d '{
337
- "content": "shop_page_id",
338
- "page_name": "Shop",
339
- "save_settings": true
340
- }'
341
- ```
342
-
343
- ---
344
-
345
- ## App Initialization
346
-
347
- Endpoints for initializing the admin SPA and managing media attachments.
348
-
349
- **Prefix:** `app`**Policy:** `AdminPolicy`
350
-
351
- ---
352
-
353
- ### Initialize App
354
-
355
- GET `/fluent-cart/v2/app/init`
356
-
357
- Initialize the admin application by loading REST API configuration, asset URLs, translation strings, and shop configuration. This is the first call made when the admin SPA loads.
358
-
359
- #### Parameters
360
-
361
- No parameters required.
362
-
363
- #### Response
364
-
365
- ```
366
- {
367
- "rest": {
368
- "base_url": "https://example.com/wp-json/",
369
- "url": "https://example.com/wp-json/fluent-cart/v2/",
370
- "nonce": "abc123def456",
371
- "namespace": "fluent-cart",
372
- "version": "v2"
373
- },
374
- "asset_url": "https://example.com/wp-content/plugins/fluent-cart/assets/",
375
- "trans": {
376
- "Dashboard": "Dashboard",
377
- "Products": "Products",
378
- "Orders": "Orders"
379
- },
380
- "shop": {
381
- "currency": "USD",
382
- "currency_sign": "$",
383
- "currency_sign_position": "left",
384
- "decimal_separator": ".",
385
- "thousands_separator": ",",
386
- "number_of_decimals": 2,
387
- "store_name": "My Store",
388
- "store_logo": "https://example.com/wp-content/uploads/logo.png"
389
- }
390
- }
391
- ```
392
-
393
- #### Example
394
-
395
- ```
396
- curl -X GET "https://example.com/wp-json/fluent-cart/v2/app/init" \
397
- -u "username:app_password"
398
- ```
399
-
400
- ---
401
-
402
- ### List Attachments
403
-
404
- GET `/fluent-cart/v2/app/attachments`
405
-
406
- Retrieve all image attachments from the WordPress media library. Used for the media picker in the admin interface.
407
-
408
- #### Parameters
409
-
410
- No parameters required.
411
-
412
- #### Response
413
-
414
- **Success:**
415
-
416
- ```
417
- {
418
- "attachments": [
419
- {
420
- "id": 101,
421
- "title": "product-image",
422
- "url": "https://example.com/wp-content/uploads/2025/01/product-image.jpg"
423
- },
424
- {
425
- "id": 102,
426
- "title": "store-logo",
427
- "url": "https://example.com/wp-content/uploads/2025/01/store-logo.png"
428
- }
429
- ]
430
- }
431
- ```
432
-
433
- **No images found:**
434
-
435
- ```
436
- {
437
- "message": "No Images Found"
438
- }
439
- ```
440
-
441
- #### Example
442
-
443
- ```
444
- curl -X GET "https://example.com/wp-json/fluent-cart/v2/app/attachments" \
445
- -u "username:app_password"
446
- ```
447
-
448
- ---
449
-
450
- ### Upload Attachment
451
-
452
- POST `/fluent-cart/v2/app/upload-attachments`
453
-
454
- Upload an image file to the WordPress media library.
455
-
456
- #### Parameters
457
-
458
- | Parameter | Type | Location | Required | Description |
459
- | --- | --- | --- | --- | --- |
460
- | `file` | file | multipart | Yes | Image file to upload. Only image MIME types are accepted. |
461
-
462
- #### Response
463
-
464
- **Success:**
465
-
466
- ```
467
- {
468
- "id": 103,
469
- "title": "new-product-photo",
470
- "url": "https://example.com/wp-content/uploads/2025/01/new-product-photo.jpg"
471
- }
472
- ```
473
-
474
- **Invalid file type:**
475
-
476
- ```
477
- {
478
- "error": "Error Uploading File"
479
- }
480
- ```
481
-
482
- **No file attached:**
483
-
484
- ```
485
- {
486
- "message": "No File Attached"
487
- }
488
- ```
489
-
490
- #### Example
491
-
492
- ```
493
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/app/upload-attachments" \
494
- -u "username:app_password" \
495
- -F "file=@/path/to/image.jpg"
496
- ```
497
-
498
- ---
499
-
500
- ## Activity Log
501
-
502
- Endpoints for managing system activity logs. Activities track events like order status changes, payment events, API calls, and system errors.
503
-
504
- **Prefix:** `activity`**Policy:** `AdminPolicy`
505
-
506
- ---
507
-
508
- ### List Activities
509
-
510
- GET `/fluent-cart/v2/activity`
511
-
512
- Retrieve a paginated list of activity log entries with filtering and sorting support.
513
-
514
- #### Parameters
515
-
516
- | Parameter | Type | Location | Required | Description |
517
- | --- | --- | --- | --- | --- |
518
- | `search` | string | query | No | Search by ID (prefix with `#`), title, content, or module name |
519
- | `active_view` | string | query | No | Filter by tab: `success`, `warning`, `error`, `failed`, `info`, `api` |
520
- | `sort_by` | string | query | No | Column to sort by (default: `id`) |
521
- | `sort_type` | string | query | No | Sort direction: `asc` or `desc` (default: `desc`) |
522
- | `per_page` | integer | query | No | Results per page, max `200` (default: `10`) |
523
- | `page` | integer | query | No | Page number for pagination |
524
- | `filter_type` | string | query | No | Filter mode: `simple` or `advanced` (default: `simple`) |
525
- | `advanced_filters` | string (JSON) | query | No | JSON-encoded advanced filter groups (requires `filter_type=advanced` and Pro) |
526
-
527
- #### Active View Tabs
528
-
529
- | Tab | Column Filtered | Description |
530
- | --- | --- | --- |
531
- | `success` | `status` | Successful operations |
532
- | `warning` | `status` | Warning events |
533
- | `error` | `status` | Error events |
534
- | `failed` | `status` | Failed operations |
535
- | `info` | `status` | Informational entries |
536
- | `api` | `log_type` | API call logs |
537
-
538
- #### Response
539
-
540
- ```
541
- {
542
- "activities": {
543
- "total": 156,
544
- "per_page": 10,
545
- "current_page": 1,
546
- "last_page": 16,
547
- "data": [
548
- {
549
- "id": 42,
550
- "title": "Order #1024 status changed",
551
- "content": "Order status changed from pending to completed",
552
- "status": "success",
553
- "log_type": "activity",
554
- "module_name": "orders",
555
- "read_status": "unread",
556
- "created_at": "2025-06-15 14:30:00",
557
- "updated_at": "2025-06-15 14:30:00"
558
- }
559
- ]
560
- }
561
- }
562
- ```
563
-
564
- #### Example
565
-
566
- ```
567
- curl -X GET "https://example.com/wp-json/fluent-cart/v2/activity?active_view=error&per_page=20&sort_type=desc" \
568
- -u "username:app_password"
569
- ```
570
-
571
- ---
572
-
573
- ### Delete Activity
574
-
575
- DELETE `/fluent-cart/v2/activity/{id}`
576
-
577
- Delete a specific activity log entry.
578
-
579
- #### Parameters
580
-
581
- | Parameter | Type | Location | Required | Description |
582
- | --- | --- | --- | --- | --- |
583
- | `id` | integer | path | Yes | The activity log entry ID |
584
-
585
- #### Response
586
-
587
- **Success:**
588
-
589
- ```
590
- {
591
- "message": "Activity Deleted Successfully"
592
- }
593
- ```
594
-
595
- **Error:**
596
-
597
- ```
598
- {
599
- "message": "Activity not found"
600
- }
601
- ```
602
-
603
- #### Example
604
-
605
- ```
606
- curl -X DELETE "https://example.com/wp-json/fluent-cart/v2/activity/42" \
607
- -u "username:app_password"
608
- ```
609
-
610
- ---
611
-
612
- ### Mark Activity Read/Unread
613
-
614
- PUT `/fluent-cart/v2/activity/{id}/mark-read`
615
-
616
- Toggle the read status of an activity log entry.
617
-
618
- #### Parameters
619
-
620
- | Parameter | Type | Location | Required | Description |
621
- | --- | --- | --- | --- | --- |
622
- | `id` | integer | path | Yes | The activity log entry ID |
623
- | `status` | string | body | Yes | New read status: `read` or `unread` |
624
-
625
- #### Response
626
-
627
- **Marked as read:**
628
-
629
- ```
630
- {
631
- "message": "Activity Marked as Read"
632
- }
633
- ```
634
-
635
- **Marked as unread:**
636
-
637
- ```
638
- {
639
- "message": "Activity Marked as Unread"
640
- }
641
- ```
642
-
643
- #### Example
644
-
645
- ```
646
- curl -X PUT "https://example.com/wp-json/fluent-cart/v2/activity/42/mark-read" \
647
- -u "username:app_password" \
648
- -H "Content-Type: application/json" \
649
- -d '{"status": "read"}'
650
- ```
651
-
652
- ---
653
-
654
- ## Notes
655
-
656
- Endpoints for managing order notes.
657
-
658
- **Prefix:** `notes`**Policy:** `AdminPolicy`
659
-
660
- ---
661
-
662
- ### Attach Note to Order
663
-
664
- POST `/fluent-cart/v2/notes/attach`
665
-
666
- Add or update a note on an order. The note is stored directly on the order record.
667
-
668
- #### Parameters
669
-
670
- | Parameter | Type | Location | Required | Description |
671
- | --- | --- | --- | --- | --- |
672
- | `order_id` | integer | body | Yes | The order ID to attach the note to |
673
- | `note` | string | body | Yes | The note content (sanitized as text field) |
674
-
675
- #### Response
676
-
677
- **Success:**
678
-
679
- ```
680
- {
681
- "message": "Order Note Updated successfully."
682
- }
683
- ```
684
-
685
- **Error:**
686
-
687
- ```
688
- {
689
- "message": "Failed to update order note."
690
- }
691
- ```
692
-
693
- #### Example
694
-
695
- ```
696
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/notes/attach" \
697
- -u "username:app_password" \
698
- -H "Content-Type: application/json" \
699
- -d '{
700
- "order_id": 1024,
701
- "note": "Customer requested express shipping. Upgraded at no charge."
702
- }'
703
- ```
704
-
705
- ---
706
-
707
- ## Print Templates
708
-
709
- Endpoints for managing invoice, packing slip, and other print templates.
710
-
711
- **Prefix:** `templates`**Policy:** `AdminPolicy`
712
-
713
- ---
714
-
715
- ### Get Print Templates
716
-
717
- GET `/fluent-cart/v2/templates/print-templates`
718
-
719
- Retrieve all available print templates. Returns saved custom templates or falls back to default templates.
720
-
721
- #### Parameters
722
-
723
- No parameters required.
724
-
725
- #### Available Templates
726
-
727
- | Key | Title |
728
- | --- | --- |
729
- | `invoice_template` | Invoice Template |
730
- | `packing_slip` | Packing Slip Template |
731
- | `delivery_slip` | Delivery Slip Template |
732
- | `shipping_slip` | Shipping Slip Template |
733
- | `dispatch_slip` | Dispatch Slip Template |
734
-
735
- #### Response
736
-
737
- ```
738
- {
739
- "templates": [
740
- {
741
- "key": "invoice_template",
742
- "title": "Invoice Template",
743
- "content": "<html>...invoice HTML template with shortcodes...</html>"
744
- },
745
- {
746
- "key": "packing_slip",
747
- "title": "Packing Slip Template",
748
- "content": "<html>...packing slip HTML template...</html>"
749
- },
750
- {
751
- "key": "delivery_slip",
752
- "title": "Delivery Slip Template",
753
- "content": "<html>...delivery slip HTML template...</html>"
754
- },
755
- {
756
- "key": "shipping_slip",
757
- "title": "Shipping Slip Template",
758
- "content": "<html>...shipping slip HTML template...</html>"
759
- },
760
- {
761
- "key": "dispatch_slip",
762
- "title": "Dispatch Slip Template",
763
- "content": "<html>...dispatch slip HTML template...</html>"
764
- }
765
- ]
766
- }
767
- ```
768
-
769
- #### Example
770
-
771
- ```
772
- curl -X GET "https://example.com/wp-json/fluent-cart/v2/templates/print-templates" \
773
- -u "username:app_password"
774
- ```
775
-
776
- ---
777
-
778
- ### Save Print Templates
779
-
780
- PUT `/fluent-cart/v2/templates/print-templates`
781
-
782
- Save customized print templates. Each template's content is sanitized with `wp_kses_post` before saving.
783
-
784
- #### Parameters
785
-
786
- | Parameter | Type | Location | Required | Description |
787
- | --- | --- | --- | --- | --- |
788
- | `templates` | array | body | Yes | Array of template objects to save |
789
- | `templates[].key` | string | body | Yes | Template identifier (e.g., `invoice_template`, `packing_slip`) |
790
- | `templates[].content` | string | body | Yes | HTML template content with shortcodes |
791
-
792
- #### Response
793
-
794
- ```
795
- {
796
- "message": "Template saved successfully"
797
- }
798
- ```
799
-
800
- #### Example
801
-
802
- ```
803
- curl -X PUT "https://example.com/wp-json/fluent-cart/v2/templates/print-templates" \
804
- -u "username:app_password" \
805
- -H "Content-Type: application/json" \
806
- -d '{
807
- "templates": [
808
- {
809
- "key": "invoice_template",
810
- "content": "<html><body><h1>Invoice #{order_id}</h1>...</body></html>"
811
- }
812
- ]
813
- }'
814
- ```
815
-
816
- ---
817
-
818
- ## Widgets
819
-
820
- Dynamic widget data endpoint for contextual UI components.
821
-
822
- ---
823
-
824
- ### Get Widgets
825
-
826
- GET `/fluent-cart/v2/widgets`
827
-
828
- Retrieve dynamic widget data for a specific context. Widgets are loaded via WordPress filters (`fluent_cart/widgets/{filter}`), allowing modules and extensions to register custom widgets.
829
-
830
- - **Policy:** `OrderPolicy`
831
- - **Permission:** `customers/view` OR `orders/view` (any)
832
-
833
- #### Parameters
834
-
835
- | Parameter | Type | Location | Required | Description |
836
- | --- | --- | --- | --- | --- |
837
- | `filter` | string | query | No | Widget context identifier (the `fluent_cart_` prefix is automatically stripped). Example: `single_order_page` |
838
- | `data` | object | query | No | Additional context data passed to the widget filter. For `single_order_page`, must include `order_id`. |
839
-
840
- #### Response
841
-
842
- ```
843
- {
844
- "widgets": [
845
- {
846
- "title": "Customer Lifetime Value",
847
- "value": "$1,250.00",
848
- "type": "stat"
849
- }
850
- ]
851
- }
852
- ```
853
-
854
- **Order not found (when filter is `single_order_page`):**
855
-
856
- ```
857
- {
858
- "message": "Order not found"
859
- }
860
- ```
861
-
862
- #### Example
863
-
864
- ```
865
- curl -X GET "https://example.com/wp-json/fluent-cart/v2/widgets?filter=single_order_page&data[order_id]=1024" \
866
- -u "username:app_password"
867
- ```
868
-
869
- ---
870
-
871
- ## Address Info
872
-
873
- Endpoints for retrieving country and state/province data for address forms.
874
-
875
- **Prefix:** `address-info`**Policy:** `UserPolicy`
876
-
877
- ---
878
-
879
- ### List Countries
880
-
881
- GET `/fluent-cart/v2/address-info/countries`
882
-
883
- Retrieve a list of all available countries formatted as select options.
884
-
885
- #### Parameters
886
-
887
- No parameters required.
888
-
889
- #### Response
890
-
891
- ```
892
- {
893
- "data": [
894
- {
895
- "label": "United States",
896
- "value": "US"
897
- },
898
- {
899
- "label": "United Kingdom",
900
- "value": "GB"
901
- },
902
- {
903
- "label": "Canada",
904
- "value": "CA"
905
- }
906
- ]
907
- }
908
- ```
909
-
910
- #### Example
911
-
912
- ```
913
- curl -X GET "https://example.com/wp-json/fluent-cart/v2/address-info/countries" \
914
- -u "username:app_password"
915
- ```
916
-
917
- ---
918
-
919
- ### Get Country Info
920
-
921
- GET `/fluent-cart/v2/address-info/get-country-info`
922
-
923
- Retrieve detailed information for a specific country including states/provinces and address locale formatting rules. Can identify the country from either a country code or a timezone string.
924
-
925
- #### Parameters
926
-
927
- | Parameter | Type | Location | Required | Description |
928
- | --- | --- | --- | --- | --- |
929
- | `country_code` | string | query | Conditional | Two-letter ISO country code (e.g., `US`, `GB`). Required if `timezone` is not provided. |
930
- | `timezone` | string | query | Conditional | IANA timezone string (e.g., `America/New_York`). Used to guess the country. Takes priority over `country_code`. |
931
-
932
- #### Response
933
-
934
- ```
935
- {
936
- "country_code": "US",
937
- "country_name": "United States",
938
- "states": [
939
- {
940
- "label": "Alabama",
941
- "value": "AL"
942
- },
943
- {
944
- "label": "Alaska",
945
- "value": "AK"
946
- },
947
- {
948
- "label": "California",
949
- "value": "CA"
950
- }
951
- ],
952
- "address_locale": {
953
- "state": {
954
- "label": "State",
955
- "required": true
956
- },
957
- "postcode": {
958
- "label": "ZIP Code",
959
- "required": true
960
- },
961
- "city": {
962
- "label": "City",
963
- "required": true
964
- }
965
- }
966
- }
967
- ```
968
-
969
- INFO
970
-
971
- The `address_locale` object provides localized field labels and requirements that vary by country. For example, the UK uses "Postcode" while the US uses "ZIP Code", and some countries do not require a state/province field.
972
-
973
- #### Example
974
-
975
- ```
976
- # By country code
977
- curl -X GET "https://example.com/wp-json/fluent-cart/v2/address-info/get-country-info?country_code=US" \
978
- -u "username:app_password"
979
-
980
- # By timezone
981
- curl -X GET "https://example.com/wp-json/fluent-cart/v2/address-info/get-country-info?timezone=America/New_York" \
982
- -u "username:app_password"
983
- ```
984
-
985
- ---
986
-
987
- ## Advanced Filters
988
-
989
- Endpoints for retrieving filter options used by the advanced filter UI across orders, customers, products, and labels.
990
-
991
- **Prefix:** `advance_filter`**Policy:** `OrderPolicy`
992
-
993
- ---
994
-
995
- ### Get Filter Options
996
-
997
- GET `/fluent-cart/v2/advance_filter/get-filter-options`
998
-
999
- Retrieve dynamic filter options for the advanced filter dropdowns. Supports loading product variations, labels, and extensible custom data keys via WordPress filters.
1000
-
1001
- - **Permission:** `orders/view` OR `customers/view` OR `products/view` OR `labels/view` (any)
1002
-
1003
- #### Parameters
1004
-
1005
- | Parameter | Type | Location | Required | Description |
1006
- | --- | --- | --- | --- | --- |
1007
- | `remote_data_key` | string | query | Yes | The type of filter options to retrieve. Built-in values: `product_variations`, `labels`. Custom values are resolved via the `fluent_cart/advanced_filter_options_{key}` filter. |
1008
- | `search` | string | query | No | Search query to filter options |
1009
- | `include_ids` | array/string | query | No | Specific IDs to include in results |
1010
- | `limit` | integer | query | No | Maximum number of options to return |
1011
-
1012
- #### Response
1013
-
1014
- ```
1015
- {
1016
- "options": [
1017
- {
1018
- "id": 1,
1019
- "title": "Premium T-Shirt - Small / Red",
1020
- "children": [
1021
- {
1022
- "id": 10,
1023
- "title": "Small / Red"
1024
- },
1025
- {
1026
- "id": 11,
1027
- "title": "Medium / Blue"
1028
- }
1029
- ]
1030
- }
1031
- ]
1032
- }
1033
- ```
1034
-
1035
- INFO
1036
-
1037
- When `remote_data_key` is `product_variations`, options are returned as a tree structure with products as parents and their variations as children. For `labels`, options are returned as a flat list of label objects.
1038
-
1039
- #### Example
1040
-
1041
- ```
1042
- curl -X GET "https://example.com/wp-json/fluent-cart/v2/advance_filter/get-filter-options?remote_data_key=product_variations&search=shirt&limit=20" \
1043
- -u "username:app_password"
1044
- ```
1045
-
1046
- ---
1047
-
1048
- ### Get Search Options
1049
-
1050
- GET `/fluent-cart/v2/forms/search_options`
1051
-
1052
- Retrieve dynamic search/autocomplete options for form fields. Options are resolved via the `fluent_cart/get_dynamic_search_{search_for}` WordPress filter, allowing modules to provide context-specific search data.
1053
-
1054
- - **Policy:** `AdminPolicy`
1055
- - **Permission:** `super_admin`
1056
-
1057
- #### Parameters
1058
-
1059
- | Parameter | Type | Location | Required | Description |
1060
- | --- | --- | --- | --- | --- |
1061
- | `search_for` | string | query | Yes | The type of search options to retrieve (used as the filter key suffix) |
1062
- | `search_by` | string | query | No | Additional search context or query string passed to the filter |
1063
-
1064
- #### Response
1065
-
1066
- ```
1067
- {
1068
- "options": [
1069
- {
1070
- "id": "option_1",
1071
- "label": "Option Label",
1072
- "value": "option_value"
1073
- }
1074
- ]
1075
- }
1076
- ```
1077
-
1078
- #### Example
1079
-
1080
- ```
1081
- curl -X GET "https://example.com/wp-json/fluent-cart/v2/forms/search_options?search_for=products&search_by=shirt" \
1082
- -u "username:app_password"
1083
- ```
1
+ # Dashboard & Utilities API
2
+
3
+ Administrative endpoints for dashboard statistics, onboarding setup, app initialization, activity logging, print templates, and utility functions.
4
+
5
+ **Base URL:** `https://your-site.com/wp-json/fluent-cart/v2`
6
+
7
+ ---
8
+
9
+ ## Dashboard
10
+
11
+ Overview and statistics endpoints for the admin dashboard.
12
+
13
+ **Prefix:** `dashboard`
14
+
15
+ ---
16
+
17
+ ### Get Onboarding Data
18
+
19
+ GET `/fluent-cart/v2/dashboard`
20
+
21
+ Retrieve the onboarding checklist with completion status for each setup step. Used to display the getting-started wizard on the dashboard.
22
+
23
+ - **Policy:** `AdminPolicy`
24
+
25
+ #### Parameters
26
+
27
+ No parameters required.
28
+
29
+ #### Response
30
+
31
+ ```
32
+ {
33
+ "data": {
34
+ "steps": {
35
+ "page_setup": {
36
+ "title": "Setup Pages",
37
+ "text": "Customers to find what they're looking for by organising.",
38
+ "icon": "Cart",
39
+ "completed": false,
40
+ "url": "https://example.com/wp-admin/admin.php?page=fluent-cart#/settings/store-settings/pages_setup"
41
+ },
42
+ "store_info": {
43
+ "title": "Add Details to Store",
44
+ "text": "Store details such as addresses, company info etc.",
45
+ "icon": "StoreIcon",
46
+ "completed": true,
47
+ "url": "https://example.com/wp-admin/admin.php?page=fluent-cart#/settings/store-settings"
48
+ },
49
+ "product_info": {
50
+ "title": "Add Your First Product",
51
+ "text": "Share your brand story and build trust with customers.",
52
+ "icon": "ShoppingCartIcon",
53
+ "completed": false,
54
+ "url": "https://example.com/wp-admin/admin.php?page=fluent-cart#/products"
55
+ },
56
+ "setup_payments": {
57
+ "title": "Setup Payment Methods",
58
+ "text": "Choose from fast & secure online and offline payment.",
59
+ "icon": "PaymentIcon",
60
+ "completed": true,
61
+ "url": "https://example.com/wp-admin/admin.php?page=fluent-cart#/settings/payments"
62
+ }
63
+ },
64
+ "completed": 2
65
+ }
66
+ }
67
+ ```
68
+
69
+ #### Completion Logic
70
+
71
+ | Step | Completed When |
72
+ | --- | --- |
73
+ | `page_setup` | All generatable pages (shop, checkout, etc.) have page IDs assigned in store settings |
74
+ | `store_info` | Both `store_name` and `store_logo` are set in store settings |
75
+ | `product_info` | At least one product exists in the database |
76
+ | `setup_payments` | At least one payment gateway is enabled |
77
+
78
+ #### Example
79
+
80
+ ```
81
+ curl -X GET "https://example.com/wp-json/fluent-cart/v2/dashboard" \
82
+ -u "username:app_password"
83
+ ```
84
+
85
+ ---
86
+
87
+ ### Get Dashboard Stats
88
+
89
+ GET `/fluent-cart/v2/dashboard/stats`
90
+
91
+ Retrieve the dashboard tiles: total products, and the orders, net sales and refunds of the last 30 store days. The money tiles show the Revenue report's figures for the same days, in all currencies converted to the base currency, so they match the report they link to.
92
+
93
+ - **Policy:** `DashboardPolicy`
94
+ - **Permission:** `dashboard_stats/view`
95
+
96
+ #### Parameters
97
+
98
+ No parameters required.
99
+
100
+ #### Response
101
+
102
+ ```
103
+ {
104
+ "stats": [
105
+ {
106
+ "title": "Total Products",
107
+ "current_count": "45",
108
+ "icon": "Frame",
109
+ "url": "https://example.com/wp-admin/admin.php?page=fluent-cart#/products?active_view=all"
110
+ },
111
+ {
112
+ "title": "Orders",
113
+ "current_count": 128,
114
+ "icon": "AllOrdersIcon",
115
+ "url": "https://example.com/wp-admin/admin.php?page=fluent-cart#/orders"
116
+ },
117
+ {
118
+ "title": "Revenue",
119
+ "current_count": 15420.5,
120
+ "icon": "Currency",
121
+ "url": "https://example.com/wp-admin/admin.php?page=fluent-cart#/reports/revenue",
122
+ "has_currency": true,
123
+ "currency": "USD",
124
+ "excluded_orders": 0
125
+ },
126
+ {
127
+ "title": "Refund",
128
+ "current_count": 350,
129
+ "icon": "Failed",
130
+ "url": "https://example.com/wp-admin/admin.php?page=fluent-cart#/reports/refunds",
131
+ "has_currency": true,
132
+ "currency": "USD",
133
+ "excluded_orders": 0
134
+ }
135
+ ]
136
+ }
137
+ ```
138
+
139
+ The type of `current_count` differs per tile:
140
+
141
+ | Tile | `current_count` | Source |
142
+ | --- | --- | --- |
143
+ | Total Products | integer string | `COUNT(*)` of products not in `trash` or `auto-draft` |
144
+ | Orders | integer | Orders with payment status `paid`, `partially-paid`, `refunded` or `partially-refunded`. $0 orders count. |
145
+ | Revenue | number, in major units (decimal) | The Revenue report's `summary.net_sales`: paid − refunds − the tax, shipping and fees the store kept |
146
+ | Refund | number, in major units (decimal) | The Revenue report's `summary.total_refunded_amount` (all refunded money) |
147
+
148
+ Money tiles also carry `currency` (the base currency) and `excluded_orders`: the number of orders that have no trusted exchange rate. The money tiles leave those orders out; the Orders tile counts them.
149
+
150
+ INFO
151
+
152
+ - **Orders, Revenue and Refund** cover the last 30 days in the WordPress site timezone, today included (the Revenue report's `last_30` preset).
153
+ - Widgets with `has_currency: true` should be formatted with the base currency symbol.
154
+ - The whole list passes through the `fluent_cart/dashboard_stats` filter.
155
+
156
+ #### Example
157
+
158
+ ```
159
+ curl -X GET "https://example.com/wp-json/fluent-cart/v2/dashboard/stats" \
160
+ -u "username:app_password"
161
+ ```
162
+
163
+ ---
164
+
165
+ ## Onboarding
166
+
167
+ Endpoints for the initial store setup wizard.
168
+
169
+ **Prefix:** `onboarding`**Policy:** `AdminPolicy`
170
+
171
+ ---
172
+
173
+ ### Get Onboarding Settings
174
+
175
+ GET `/fluent-cart/v2/onboarding`
176
+
177
+ Retrieve the current store settings, available pages, and currency options for the onboarding wizard.
178
+
179
+ #### Parameters
180
+
181
+ No parameters required.
182
+
183
+ #### Response
184
+
185
+ ```
186
+ {
187
+ "pages": [
188
+ { "label": "Shop", "value": 10 },
189
+ { "label": "Checkout", "value": 12 }
190
+ ],
191
+ "currencies": [
192
+ { "label": "United States Dollar ($)", "value": "USD" },
193
+ { "label": "Euro (EUR)", "value": "EUR" },
194
+ { "label": "British Pound (GBP)", "value": "GBP" }
195
+ ],
196
+ "default_settings": {
197
+ "store_name": "My Store",
198
+ "store_logo": "",
199
+ "currency": "USD",
200
+ "shop_page_id": "10",
201
+ "checkout_page_id": "12",
202
+ "customer_profile_page_id": ""
203
+ },
204
+ "tax_settings": {
205
+ "enable_tax": "no",
206
+ "tax_inclusion": "exclusive",
207
+ "eu_method": "",
208
+ "vat_number": ""
209
+ }
210
+ }
211
+ ```
212
+
213
+ #### Example
214
+
215
+ ```
216
+ curl -X GET "https://example.com/wp-json/fluent-cart/v2/onboarding" \
217
+ -u "username:app_password"
218
+ ```
219
+
220
+ ---
221
+
222
+ ### Save Onboarding Settings
223
+
224
+ POST `/fluent-cart/v2/onboarding`
225
+
226
+ Save store settings during the onboarding process. Merges submitted values with existing store settings. If a `category` value is provided, dummy products are created asynchronously.
227
+
228
+ #### Parameters
229
+
230
+ | Parameter | Type | Location | Required | Description |
231
+ | --- | --- | --- | --- | --- |
232
+ | `store_name` | string | body | No | The store name |
233
+ | `store_logo` | string | body | No | URL of the store logo |
234
+ | `currency` | string | body | No | Store currency code (e.g., `USD`, `EUR`) |
235
+ | `category` | string | body | No | Product category for generating dummy products. Excluded from saved settings but triggers async dummy product creation. |
236
+ | *...any store setting key* | mixed | body | No | Any valid store settings field |
237
+
238
+ #### Response
239
+
240
+ **Success:**
241
+
242
+ ```
243
+ {
244
+ "message": "Store has been updated successfully"
245
+ }
246
+ ```
247
+
248
+ **Error:**
249
+
250
+ ```
251
+ {
252
+ "errors": "Failed to update!"
253
+ }
254
+ ```
255
+
256
+ #### Example
257
+
258
+ ```
259
+ curl -X POST "https://example.com/wp-json/fluent-cart/v2/onboarding" \
260
+ -u "username:app_password" \
261
+ -H "Content-Type: application/json" \
262
+ -d '{
263
+ "store_name": "My Awesome Store",
264
+ "store_logo": "https://example.com/wp-content/uploads/logo.png",
265
+ "currency": "USD"
266
+ }'
267
+ ```
268
+
269
+ ---
270
+
271
+ ### Create All Pages
272
+
273
+ POST `/fluent-cart/v2/onboarding/create-pages`
274
+
275
+ Create all required store pages (shop, checkout, customer profile, etc.) in bulk. Skips pages that already have valid page IDs assigned. After creation, returns the updated onboarding settings (same response as [Get Onboarding Settings](#get-onboarding-settings)).
276
+
277
+ #### Parameters
278
+
279
+ No parameters required.
280
+
281
+ #### Response
282
+
283
+ Same as [Get Onboarding Settings](#get-onboarding-settings) -- returns the updated pages, currencies, and default settings after page creation.
284
+
285
+ #### Example
286
+
287
+ ```
288
+ curl -X POST "https://example.com/wp-json/fluent-cart/v2/onboarding/create-pages" \
289
+ -u "username:app_password"
290
+ ```
291
+
292
+ ---
293
+
294
+ ### Create Single Page
295
+
296
+ POST `/fluent-cart/v2/onboarding/create-page`
297
+
298
+ Create a single store page (e.g., shop, checkout, customer profile) and optionally save the page ID to store settings.
299
+
300
+ - **Request Class:** `CreatePageRequest`
301
+
302
+ #### Parameters
303
+
304
+ | Parameter | Type | Location | Required | Description |
305
+ | --- | --- | --- | --- | --- |
306
+ | `content` | string | body | Yes | The page key identifier with `_page_id` suffix (e.g., `shop_page_id`, `checkout_page_id`, `customer_profile_page_id`) |
307
+ | `page_name` | string | body | Yes | The title for the new WordPress page |
308
+ | `save_settings` | boolean | body | No | Whether to save the new page ID to store settings (default: `false`). When `true`, also flushes rewrite rules. |
309
+
310
+ #### Response
311
+
312
+ **Success:**
313
+
314
+ ```
315
+ {
316
+ "page_id": "156",
317
+ "page_name": "Shop",
318
+ "link": "https://example.com/shop/"
319
+ }
320
+ ```
321
+
322
+ **Error:**
323
+
324
+ ```
325
+ {
326
+ "message": "Unable to create page"
327
+ }
328
+ ```
329
+
330
+ #### Example
331
+
332
+ ```
333
+ curl -X POST "https://example.com/wp-json/fluent-cart/v2/onboarding/create-page" \
334
+ -u "username:app_password" \
335
+ -H "Content-Type: application/json" \
336
+ -d '{
337
+ "content": "shop_page_id",
338
+ "page_name": "Shop",
339
+ "save_settings": true
340
+ }'
341
+ ```
342
+
343
+ ---
344
+
345
+ ## App Initialization
346
+
347
+ Endpoints for initializing the admin SPA and managing media attachments.
348
+
349
+ **Prefix:** `app`**Policy:** `AdminPolicy`
350
+
351
+ ---
352
+
353
+ ### Initialize App
354
+
355
+ GET `/fluent-cart/v2/app/init`
356
+
357
+ Initialize the admin application by loading REST API configuration, asset URLs, translation strings, and shop configuration. This is the first call made when the admin SPA loads.
358
+
359
+ #### Parameters
360
+
361
+ No parameters required.
362
+
363
+ #### Response
364
+
365
+ ```
366
+ {
367
+ "rest": {
368
+ "base_url": "https://example.com/wp-json/",
369
+ "url": "https://example.com/wp-json/fluent-cart/v2/",
370
+ "nonce": "abc123def456",
371
+ "namespace": "fluent-cart",
372
+ "version": "v2"
373
+ },
374
+ "asset_url": "https://example.com/wp-content/plugins/fluent-cart/assets/",
375
+ "trans": {
376
+ "Dashboard": "Dashboard",
377
+ "Products": "Products",
378
+ "Orders": "Orders"
379
+ },
380
+ "shop": {
381
+ "currency": "USD",
382
+ "currency_sign": "$",
383
+ "currency_sign_position": "left",
384
+ "decimal_separator": ".",
385
+ "thousands_separator": ",",
386
+ "number_of_decimals": 2,
387
+ "store_name": "My Store",
388
+ "store_logo": "https://example.com/wp-content/uploads/logo.png"
389
+ }
390
+ }
391
+ ```
392
+
393
+ #### Example
394
+
395
+ ```
396
+ curl -X GET "https://example.com/wp-json/fluent-cart/v2/app/init" \
397
+ -u "username:app_password"
398
+ ```
399
+
400
+ ---
401
+
402
+ ### List Attachments
403
+
404
+ GET `/fluent-cart/v2/app/attachments`
405
+
406
+ Retrieve all image attachments from the WordPress media library. Used for the media picker in the admin interface.
407
+
408
+ #### Parameters
409
+
410
+ No parameters required.
411
+
412
+ #### Response
413
+
414
+ **Success:**
415
+
416
+ ```
417
+ {
418
+ "attachments": [
419
+ {
420
+ "id": 101,
421
+ "title": "product-image",
422
+ "url": "https://example.com/wp-content/uploads/2025/01/product-image.jpg"
423
+ },
424
+ {
425
+ "id": 102,
426
+ "title": "store-logo",
427
+ "url": "https://example.com/wp-content/uploads/2025/01/store-logo.png"
428
+ }
429
+ ]
430
+ }
431
+ ```
432
+
433
+ **No images found:**
434
+
435
+ ```
436
+ {
437
+ "message": "No Images Found"
438
+ }
439
+ ```
440
+
441
+ #### Example
442
+
443
+ ```
444
+ curl -X GET "https://example.com/wp-json/fluent-cart/v2/app/attachments" \
445
+ -u "username:app_password"
446
+ ```
447
+
448
+ ---
449
+
450
+ ### Upload Attachment
451
+
452
+ POST `/fluent-cart/v2/app/upload-attachments`
453
+
454
+ Upload an image file to the WordPress media library.
455
+
456
+ #### Parameters
457
+
458
+ | Parameter | Type | Location | Required | Description |
459
+ | --- | --- | --- | --- | --- |
460
+ | `file` | file | multipart | Yes | Image file to upload. Only image MIME types are accepted. |
461
+
462
+ #### Response
463
+
464
+ **Success:**
465
+
466
+ ```
467
+ {
468
+ "id": 103,
469
+ "title": "new-product-photo",
470
+ "url": "https://example.com/wp-content/uploads/2025/01/new-product-photo.jpg"
471
+ }
472
+ ```
473
+
474
+ **Invalid file type:**
475
+
476
+ ```
477
+ {
478
+ "error": "Error Uploading File"
479
+ }
480
+ ```
481
+
482
+ **No file attached:**
483
+
484
+ ```
485
+ {
486
+ "message": "No File Attached"
487
+ }
488
+ ```
489
+
490
+ #### Example
491
+
492
+ ```
493
+ curl -X POST "https://example.com/wp-json/fluent-cart/v2/app/upload-attachments" \
494
+ -u "username:app_password" \
495
+ -F "file=@/path/to/image.jpg"
496
+ ```
497
+
498
+ ---
499
+
500
+ ## Activity Log
501
+
502
+ Endpoints for managing system activity logs. Activities track events like order status changes, payment events, API calls, and system errors.
503
+
504
+ **Prefix:** `activity`**Policy:** `AdminPolicy`
505
+
506
+ ---
507
+
508
+ ### List Activities
509
+
510
+ GET `/fluent-cart/v2/activity`
511
+
512
+ Retrieve a paginated list of activity log entries with filtering and sorting support.
513
+
514
+ #### Parameters
515
+
516
+ | Parameter | Type | Location | Required | Description |
517
+ | --- | --- | --- | --- | --- |
518
+ | `search` | string | query | No | Search by ID (prefix with `#`), title, content, or module name |
519
+ | `active_view` | string | query | No | Filter by tab: `success`, `warning`, `error`, `failed`, `info`, `api` |
520
+ | `sort_by` | string | query | No | Column to sort by (default: `id`) |
521
+ | `sort_type` | string | query | No | Sort direction: `asc` or `desc` (default: `desc`) |
522
+ | `per_page` | integer | query | No | Results per page, max `200` (default: `10`) |
523
+ | `page` | integer | query | No | Page number for pagination |
524
+ | `filter_type` | string | query | No | Filter mode: `simple` or `advanced` (default: `simple`) |
525
+ | `advanced_filters` | string (JSON) | query | No | JSON-encoded advanced filter groups (requires `filter_type=advanced` and Pro) |
526
+
527
+ #### Active View Tabs
528
+
529
+ | Tab | Column Filtered | Description |
530
+ | --- | --- | --- |
531
+ | `success` | `status` | Successful operations |
532
+ | `warning` | `status` | Warning events |
533
+ | `error` | `status` | Error events |
534
+ | `failed` | `status` | Failed operations |
535
+ | `info` | `status` | Informational entries |
536
+ | `api` | `log_type` | API call logs |
537
+
538
+ #### Response
539
+
540
+ ```
541
+ {
542
+ "activities": {
543
+ "total": 156,
544
+ "per_page": 10,
545
+ "current_page": 1,
546
+ "last_page": 16,
547
+ "data": [
548
+ {
549
+ "id": 42,
550
+ "title": "Order #1024 status changed",
551
+ "content": "Order status changed from pending to completed",
552
+ "status": "success",
553
+ "log_type": "activity",
554
+ "module_name": "orders",
555
+ "read_status": "unread",
556
+ "created_at": "2025-06-15 14:30:00",
557
+ "updated_at": "2025-06-15 14:30:00"
558
+ }
559
+ ]
560
+ }
561
+ }
562
+ ```
563
+
564
+ #### Example
565
+
566
+ ```
567
+ curl -X GET "https://example.com/wp-json/fluent-cart/v2/activity?active_view=error&per_page=20&sort_type=desc" \
568
+ -u "username:app_password"
569
+ ```
570
+
571
+ ---
572
+
573
+ ### Delete Activity
574
+
575
+ DELETE `/fluent-cart/v2/activity/{id}`
576
+
577
+ Delete a specific activity log entry.
578
+
579
+ #### Parameters
580
+
581
+ | Parameter | Type | Location | Required | Description |
582
+ | --- | --- | --- | --- | --- |
583
+ | `id` | integer | path | Yes | The activity log entry ID |
584
+
585
+ #### Response
586
+
587
+ **Success:**
588
+
589
+ ```
590
+ {
591
+ "message": "Activity Deleted Successfully"
592
+ }
593
+ ```
594
+
595
+ **Error:**
596
+
597
+ ```
598
+ {
599
+ "message": "Activity not found"
600
+ }
601
+ ```
602
+
603
+ #### Example
604
+
605
+ ```
606
+ curl -X DELETE "https://example.com/wp-json/fluent-cart/v2/activity/42" \
607
+ -u "username:app_password"
608
+ ```
609
+
610
+ ---
611
+
612
+ ### Mark Activity Read/Unread
613
+
614
+ PUT `/fluent-cart/v2/activity/{id}/mark-read`
615
+
616
+ Toggle the read status of an activity log entry.
617
+
618
+ #### Parameters
619
+
620
+ | Parameter | Type | Location | Required | Description |
621
+ | --- | --- | --- | --- | --- |
622
+ | `id` | integer | path | Yes | The activity log entry ID |
623
+ | `status` | string | body | Yes | New read status: `read` or `unread` |
624
+
625
+ #### Response
626
+
627
+ **Marked as read:**
628
+
629
+ ```
630
+ {
631
+ "message": "Activity Marked as Read"
632
+ }
633
+ ```
634
+
635
+ **Marked as unread:**
636
+
637
+ ```
638
+ {
639
+ "message": "Activity Marked as Unread"
640
+ }
641
+ ```
642
+
643
+ #### Example
644
+
645
+ ```
646
+ curl -X PUT "https://example.com/wp-json/fluent-cart/v2/activity/42/mark-read" \
647
+ -u "username:app_password" \
648
+ -H "Content-Type: application/json" \
649
+ -d '{"status": "read"}'
650
+ ```
651
+
652
+ ---
653
+
654
+ ## Notes
655
+
656
+ Endpoints for managing order notes.
657
+
658
+ **Prefix:** `notes`**Policy:** `AdminPolicy`
659
+
660
+ ---
661
+
662
+ ### Attach Note to Order
663
+
664
+ POST `/fluent-cart/v2/notes/attach`
665
+
666
+ Add or update a note on an order. The note is stored directly on the order record.
667
+
668
+ #### Parameters
669
+
670
+ | Parameter | Type | Location | Required | Description |
671
+ | --- | --- | --- | --- | --- |
672
+ | `order_id` | integer | body | Yes | The order ID to attach the note to |
673
+ | `note` | string | body | Yes | The note content (sanitized as text field) |
674
+
675
+ #### Response
676
+
677
+ **Success:**
678
+
679
+ ```
680
+ {
681
+ "message": "Order Note Updated successfully."
682
+ }
683
+ ```
684
+
685
+ **Error:**
686
+
687
+ ```
688
+ {
689
+ "message": "Failed to update order note."
690
+ }
691
+ ```
692
+
693
+ #### Example
694
+
695
+ ```
696
+ curl -X POST "https://example.com/wp-json/fluent-cart/v2/notes/attach" \
697
+ -u "username:app_password" \
698
+ -H "Content-Type: application/json" \
699
+ -d '{
700
+ "order_id": 1024,
701
+ "note": "Customer requested express shipping. Upgraded at no charge."
702
+ }'
703
+ ```
704
+
705
+ ---
706
+
707
+ ## Print Templates
708
+
709
+ Endpoints for managing invoice, packing slip, and other print templates.
710
+
711
+ **Prefix:** `templates`**Policy:** `AdminPolicy`
712
+
713
+ ---
714
+
715
+ ### Get Print Templates
716
+
717
+ GET `/fluent-cart/v2/templates/print-templates`
718
+
719
+ Retrieve all available print templates. Returns saved custom templates or falls back to default templates.
720
+
721
+ #### Parameters
722
+
723
+ No parameters required.
724
+
725
+ #### Available Templates
726
+
727
+ | Key | Title |
728
+ | --- | --- |
729
+ | `invoice_template` | Invoice Template |
730
+ | `packing_slip` | Packing Slip Template |
731
+ | `delivery_slip` | Delivery Slip Template |
732
+ | `shipping_slip` | Shipping Slip Template |
733
+ | `dispatch_slip` | Dispatch Slip Template |
734
+
735
+ #### Response
736
+
737
+ ```
738
+ {
739
+ "templates": [
740
+ {
741
+ "key": "invoice_template",
742
+ "title": "Invoice Template",
743
+ "content": "<html>...invoice HTML template with shortcodes...</html>"
744
+ },
745
+ {
746
+ "key": "packing_slip",
747
+ "title": "Packing Slip Template",
748
+ "content": "<html>...packing slip HTML template...</html>"
749
+ },
750
+ {
751
+ "key": "delivery_slip",
752
+ "title": "Delivery Slip Template",
753
+ "content": "<html>...delivery slip HTML template...</html>"
754
+ },
755
+ {
756
+ "key": "shipping_slip",
757
+ "title": "Shipping Slip Template",
758
+ "content": "<html>...shipping slip HTML template...</html>"
759
+ },
760
+ {
761
+ "key": "dispatch_slip",
762
+ "title": "Dispatch Slip Template",
763
+ "content": "<html>...dispatch slip HTML template...</html>"
764
+ }
765
+ ]
766
+ }
767
+ ```
768
+
769
+ #### Example
770
+
771
+ ```
772
+ curl -X GET "https://example.com/wp-json/fluent-cart/v2/templates/print-templates" \
773
+ -u "username:app_password"
774
+ ```
775
+
776
+ ---
777
+
778
+ ### Save Print Templates
779
+
780
+ PUT `/fluent-cart/v2/templates/print-templates`
781
+
782
+ Save customized print templates. Each template's content is sanitized with `wp_kses_post` before saving.
783
+
784
+ #### Parameters
785
+
786
+ | Parameter | Type | Location | Required | Description |
787
+ | --- | --- | --- | --- | --- |
788
+ | `templates` | array | body | Yes | Array of template objects to save |
789
+ | `templates[].key` | string | body | Yes | Template identifier (e.g., `invoice_template`, `packing_slip`) |
790
+ | `templates[].content` | string | body | Yes | HTML template content with shortcodes |
791
+
792
+ #### Response
793
+
794
+ ```
795
+ {
796
+ "message": "Template saved successfully"
797
+ }
798
+ ```
799
+
800
+ #### Example
801
+
802
+ ```
803
+ curl -X PUT "https://example.com/wp-json/fluent-cart/v2/templates/print-templates" \
804
+ -u "username:app_password" \
805
+ -H "Content-Type: application/json" \
806
+ -d '{
807
+ "templates": [
808
+ {
809
+ "key": "invoice_template",
810
+ "content": "<html><body><h1>Invoice #{order_id}</h1>...</body></html>"
811
+ }
812
+ ]
813
+ }'
814
+ ```
815
+
816
+ ---
817
+
818
+ ## Widgets
819
+
820
+ Dynamic widget data endpoint for contextual UI components.
821
+
822
+ ---
823
+
824
+ ### Get Widgets
825
+
826
+ GET `/fluent-cart/v2/widgets`
827
+
828
+ Retrieve dynamic widget data for a specific context. Widgets are loaded via WordPress filters (`fluent_cart/widgets/{filter}`), allowing modules and extensions to register custom widgets.
829
+
830
+ - **Policy:** `OrderPolicy`
831
+ - **Permission:** `customers/view` OR `orders/view` (any)
832
+
833
+ #### Parameters
834
+
835
+ | Parameter | Type | Location | Required | Description |
836
+ | --- | --- | --- | --- | --- |
837
+ | `filter` | string | query | No | Widget context identifier (the `fluent_cart_` prefix is automatically stripped). Example: `single_order_page` |
838
+ | `data` | object | query | No | Additional context data passed to the widget filter. For `single_order_page`, must include `order_id`. |
839
+
840
+ #### Response
841
+
842
+ ```
843
+ {
844
+ "widgets": [
845
+ {
846
+ "title": "Customer Lifetime Value",
847
+ "value": "$1,250.00",
848
+ "type": "stat"
849
+ }
850
+ ]
851
+ }
852
+ ```
853
+
854
+ **Order not found (when filter is `single_order_page`):**
855
+
856
+ ```
857
+ {
858
+ "message": "Order not found"
859
+ }
860
+ ```
861
+
862
+ #### Example
863
+
864
+ ```
865
+ curl -X GET "https://example.com/wp-json/fluent-cart/v2/widgets?filter=single_order_page&data[order_id]=1024" \
866
+ -u "username:app_password"
867
+ ```
868
+
869
+ ---
870
+
871
+ ## Address Info
872
+
873
+ Endpoints for retrieving country and state/province data for address forms.
874
+
875
+ **Prefix:** `address-info`**Policy:** `UserPolicy`
876
+
877
+ ---
878
+
879
+ ### List Countries
880
+
881
+ GET `/fluent-cart/v2/address-info/countries`
882
+
883
+ Retrieve a list of all available countries formatted as select options.
884
+
885
+ #### Parameters
886
+
887
+ No parameters required.
888
+
889
+ #### Response
890
+
891
+ ```
892
+ {
893
+ "data": [
894
+ {
895
+ "label": "United States",
896
+ "value": "US"
897
+ },
898
+ {
899
+ "label": "United Kingdom",
900
+ "value": "GB"
901
+ },
902
+ {
903
+ "label": "Canada",
904
+ "value": "CA"
905
+ }
906
+ ]
907
+ }
908
+ ```
909
+
910
+ #### Example
911
+
912
+ ```
913
+ curl -X GET "https://example.com/wp-json/fluent-cart/v2/address-info/countries" \
914
+ -u "username:app_password"
915
+ ```
916
+
917
+ ---
918
+
919
+ ### Get Country Info
920
+
921
+ GET `/fluent-cart/v2/address-info/get-country-info`
922
+
923
+ Retrieve detailed information for a specific country including states/provinces and address locale formatting rules. Can identify the country from either a country code or a timezone string.
924
+
925
+ #### Parameters
926
+
927
+ | Parameter | Type | Location | Required | Description |
928
+ | --- | --- | --- | --- | --- |
929
+ | `country_code` | string | query | Conditional | Two-letter ISO country code (e.g., `US`, `GB`). Required if `timezone` is not provided. |
930
+ | `timezone` | string | query | Conditional | IANA timezone string (e.g., `America/New_York`). Used to guess the country. Takes priority over `country_code`. |
931
+
932
+ #### Response
933
+
934
+ ```
935
+ {
936
+ "country_code": "US",
937
+ "country_name": "United States",
938
+ "states": [
939
+ {
940
+ "label": "Alabama",
941
+ "value": "AL"
942
+ },
943
+ {
944
+ "label": "Alaska",
945
+ "value": "AK"
946
+ },
947
+ {
948
+ "label": "California",
949
+ "value": "CA"
950
+ }
951
+ ],
952
+ "address_locale": {
953
+ "state": {
954
+ "label": "State",
955
+ "required": true
956
+ },
957
+ "postcode": {
958
+ "label": "ZIP Code",
959
+ "required": true
960
+ },
961
+ "city": {
962
+ "label": "City",
963
+ "required": true
964
+ }
965
+ }
966
+ }
967
+ ```
968
+
969
+ INFO
970
+
971
+ The `address_locale` object provides localized field labels and requirements that vary by country. For example, the UK uses "Postcode" while the US uses "ZIP Code", and some countries do not require a state/province field.
972
+
973
+ #### Example
974
+
975
+ ```
976
+ # By country code
977
+ curl -X GET "https://example.com/wp-json/fluent-cart/v2/address-info/get-country-info?country_code=US" \
978
+ -u "username:app_password"
979
+
980
+ # By timezone
981
+ curl -X GET "https://example.com/wp-json/fluent-cart/v2/address-info/get-country-info?timezone=America/New_York" \
982
+ -u "username:app_password"
983
+ ```
984
+
985
+ ---
986
+
987
+ ## Advanced Filters
988
+
989
+ Endpoints for retrieving filter options used by the advanced filter UI across orders, customers, products, and labels.
990
+
991
+ **Prefix:** `advance_filter`**Policy:** `OrderPolicy`
992
+
993
+ ---
994
+
995
+ ### Get Filter Options
996
+
997
+ GET `/fluent-cart/v2/advance_filter/get-filter-options`
998
+
999
+ Retrieve dynamic filter options for the advanced filter dropdowns. Supports loading product variations, labels, and extensible custom data keys via WordPress filters.
1000
+
1001
+ - **Permission:** `orders/view` OR `customers/view` OR `products/view` OR `labels/view` (any)
1002
+
1003
+ #### Parameters
1004
+
1005
+ | Parameter | Type | Location | Required | Description |
1006
+ | --- | --- | --- | --- | --- |
1007
+ | `remote_data_key` | string | query | Yes | The type of filter options to retrieve. Built-in values: `product_variations`, `labels`. Custom values are resolved via the `fluent_cart/advanced_filter_options_{key}` filter. |
1008
+ | `search` | string | query | No | Search query to filter options |
1009
+ | `include_ids` | array/string | query | No | Specific IDs to include in results |
1010
+ | `limit` | integer | query | No | Maximum number of options to return |
1011
+
1012
+ #### Response
1013
+
1014
+ ```
1015
+ {
1016
+ "options": [
1017
+ {
1018
+ "id": 1,
1019
+ "title": "Premium T-Shirt - Small / Red",
1020
+ "children": [
1021
+ {
1022
+ "id": 10,
1023
+ "title": "Small / Red"
1024
+ },
1025
+ {
1026
+ "id": 11,
1027
+ "title": "Medium / Blue"
1028
+ }
1029
+ ]
1030
+ }
1031
+ ]
1032
+ }
1033
+ ```
1034
+
1035
+ INFO
1036
+
1037
+ When `remote_data_key` is `product_variations`, options are returned as a tree structure with products as parents and their variations as children. For `labels`, options are returned as a flat list of label objects.
1038
+
1039
+ #### Example
1040
+
1041
+ ```
1042
+ curl -X GET "https://example.com/wp-json/fluent-cart/v2/advance_filter/get-filter-options?remote_data_key=product_variations&search=shirt&limit=20" \
1043
+ -u "username:app_password"
1044
+ ```
1045
+
1046
+ ---
1047
+
1048
+ ### Get Search Options
1049
+
1050
+ GET `/fluent-cart/v2/forms/search_options`
1051
+
1052
+ Retrieve dynamic search/autocomplete options for form fields. Options are resolved via the `fluent_cart/get_dynamic_search_{search_for}` WordPress filter, allowing modules to provide context-specific search data.
1053
+
1054
+ - **Policy:** `AdminPolicy`
1055
+ - **Permission:** `super_admin`
1056
+
1057
+ #### Parameters
1058
+
1059
+ | Parameter | Type | Location | Required | Description |
1060
+ | --- | --- | --- | --- | --- |
1061
+ | `search_for` | string | query | Yes | The type of search options to retrieve (used as the filter key suffix) |
1062
+ | `search_by` | string | query | No | Additional search context or query string passed to the filter |
1063
+
1064
+ #### Response
1065
+
1066
+ ```
1067
+ {
1068
+ "options": [
1069
+ {
1070
+ "id": "option_1",
1071
+ "label": "Option Label",
1072
+ "value": "option_value"
1073
+ }
1074
+ ]
1075
+ }
1076
+ ```
1077
+
1078
+ #### Example
1079
+
1080
+ ```
1081
+ curl -X GET "https://example.com/wp-json/fluent-cart/v2/forms/search_options?search_for=products&search_by=shirt" \
1082
+ -u "username:app_password"
1083
+ ```