fluentcart-developer 2.3.3 → 3.0.0

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 (655) hide show
  1. package/dist/cards/fluentcart/tools.d.ts.map +1 -1
  2. package/dist/cards/fluentcart/tools.js +2368 -2323
  3. package/dist/cards/fluentcart/tools.js.map +1 -1
  4. package/dist/paths.d.ts +1 -1
  5. package/dist/paths.d.ts.map +1 -1
  6. package/dist/paths.js +1 -1
  7. package/dist/paths.js.map +1 -1
  8. package/dist/reference-reader.d.ts +32 -1
  9. package/dist/reference-reader.d.ts.map +1 -1
  10. package/dist/reference-reader.js +111 -22
  11. package/dist/reference-reader.js.map +1 -1
  12. package/dist/server.d.ts.map +1 -1
  13. package/dist/server.js +8 -1
  14. package/dist/server.js.map +1 -1
  15. package/dist/skills/fluentcart-developer/SKILL.md +66 -538
  16. package/dist/skills/fluentcart-developer/references/api/authentication.md +452 -0
  17. package/dist/skills/fluentcart-developer/references/api/coupons.md +786 -0
  18. package/dist/skills/fluentcart-developer/references/api/customers.md +889 -0
  19. package/dist/skills/fluentcart-developer/references/api/files.md +609 -0
  20. package/dist/skills/fluentcart-developer/references/api/index.md +432 -0
  21. package/dist/skills/fluentcart-developer/references/api/licensing.md +633 -0
  22. package/dist/skills/fluentcart-developer/references/api/order-bump.md +384 -0
  23. package/dist/skills/fluentcart-developer/references/api/orders.md +814 -0
  24. package/dist/skills/fluentcart-developer/references/api/products.md +866 -0
  25. package/dist/skills/fluentcart-developer/references/api/roles-permissions.md +536 -0
  26. package/dist/skills/fluentcart-developer/references/api/subscriptions.md +827 -0
  27. package/dist/skills/fluentcart-developer/references/database/index.md +44 -0
  28. package/dist/skills/fluentcart-developer/references/database/models/activity.md +178 -0
  29. package/dist/skills/fluentcart-developer/references/database/models/applied-coupon.md +291 -0
  30. package/dist/skills/fluentcart-developer/references/database/models/attribute-group.md +239 -0
  31. package/dist/skills/fluentcart-developer/references/database/models/attribute-relation.md +181 -0
  32. package/dist/skills/fluentcart-developer/references/database/models/attribute-term.md +219 -0
  33. package/dist/skills/fluentcart-developer/references/database/models/cart.md +645 -0
  34. package/dist/skills/fluentcart-developer/references/database/models/coupon.md +427 -0
  35. package/dist/skills/fluentcart-developer/references/database/models/customer-addresses.md +348 -0
  36. package/dist/skills/fluentcart-developer/references/database/models/customer-meta.md +156 -0
  37. package/dist/skills/fluentcart-developer/references/database/models/customer.md +584 -0
  38. package/dist/skills/fluentcart-developer/references/database/models/dynamic-model.md +163 -0
  39. package/dist/skills/fluentcart-developer/references/database/models/label-relationship.md +155 -0
  40. package/dist/skills/fluentcart-developer/references/database/models/label.md +153 -0
  41. package/dist/skills/fluentcart-developer/references/database/models/license-activation.md +182 -0
  42. package/dist/skills/fluentcart-developer/references/database/models/license-meta.md +163 -0
  43. package/dist/skills/fluentcart-developer/references/database/models/license-site.md +208 -0
  44. package/dist/skills/fluentcart-developer/references/database/models/license.md +640 -0
  45. package/dist/skills/fluentcart-developer/references/database/models/meta.md +233 -0
  46. package/dist/skills/fluentcart-developer/references/database/models/order-address.md +391 -0
  47. package/dist/skills/fluentcart-developer/references/database/models/order-download-permission.md +144 -0
  48. package/dist/skills/fluentcart-developer/references/database/models/order-item.md +383 -0
  49. package/dist/skills/fluentcart-developer/references/database/models/order-meta.md +303 -0
  50. package/dist/skills/fluentcart-developer/references/database/models/order-operation.md +158 -0
  51. package/dist/skills/fluentcart-developer/references/database/models/order-promotion-stat.md +175 -0
  52. package/dist/skills/fluentcart-developer/references/database/models/order-promotion.md +250 -0
  53. package/dist/skills/fluentcart-developer/references/database/models/order-tax-rate.md +172 -0
  54. package/dist/skills/fluentcart-developer/references/database/models/order-transaction.md +440 -0
  55. package/dist/skills/fluentcart-developer/references/database/models/order.md +727 -0
  56. package/dist/skills/fluentcart-developer/references/database/models/product-detail.md +397 -0
  57. package/dist/skills/fluentcart-developer/references/database/models/product-download.md +258 -0
  58. package/dist/skills/fluentcart-developer/references/database/models/product-meta.md +153 -0
  59. package/dist/skills/fluentcart-developer/references/database/models/product-variation.md +556 -0
  60. package/dist/skills/fluentcart-developer/references/database/models/product.md +580 -0
  61. package/dist/skills/fluentcart-developer/references/database/models/relationships.md +427 -0
  62. package/dist/skills/fluentcart-developer/references/database/models/scheduled-action.md +175 -0
  63. package/dist/skills/fluentcart-developer/references/database/models/shipping-class.md +148 -0
  64. package/dist/skills/fluentcart-developer/references/database/models/shipping-method.md +280 -0
  65. package/dist/skills/fluentcart-developer/references/database/models/shipping-zone.md +205 -0
  66. package/dist/skills/fluentcart-developer/references/database/models/subscription-meta.md +173 -0
  67. package/dist/skills/fluentcart-developer/references/database/models/subscription.md +528 -0
  68. package/dist/skills/fluentcart-developer/references/database/models/tax-class.md +195 -0
  69. package/dist/skills/fluentcart-developer/references/database/models/tax-rate.md +225 -0
  70. package/dist/skills/fluentcart-developer/references/database/models/user-meta.md +166 -0
  71. package/dist/skills/fluentcart-developer/references/database/models/user.md +220 -0
  72. package/dist/skills/fluentcart-developer/references/database/models.md +404 -0
  73. package/dist/skills/fluentcart-developer/references/database/query-builder.md +860 -0
  74. package/dist/skills/fluentcart-developer/references/database/readme.md +276 -0
  75. package/dist/skills/fluentcart-developer/references/database/schema.md +1002 -0
  76. package/dist/skills/fluentcart-developer/references/engineering/adding-custom-pages-to-the-customer-dashboard.md +395 -0
  77. package/dist/skills/fluentcart-developer/references/engineering/index.md +4 -0
  78. package/dist/skills/fluentcart-developer/references/engineering.md +4 -0
  79. package/dist/skills/fluentcart-developer/references/getting-started.md +249 -0
  80. package/dist/skills/fluentcart-developer/references/guides/frontend.md +519 -0
  81. package/dist/skills/fluentcart-developer/references/guides/index.md +107 -0
  82. package/dist/skills/fluentcart-developer/references/guides/integrations.md +600 -0
  83. package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/index.md +237 -0
  84. package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/labels-and-tracking.md +481 -0
  85. package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/live-rates.md +269 -0
  86. package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/reference.md +223 -0
  87. package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/settings.md +370 -0
  88. package/dist/skills/fluentcart-developer/references/guides/shipping-carrier.md +237 -0
  89. package/dist/skills/fluentcart-developer/references/{subscription-customization.md → guides/subscriptions.md} +57 -37
  90. package/dist/skills/fluentcart-developer/references/hooks/actions/admin-and-templates.md +1079 -0
  91. package/dist/skills/fluentcart-developer/references/hooks/actions/cart-and-checkout.md +1795 -0
  92. package/dist/skills/fluentcart-developer/references/hooks/actions/customers-and-users.md +327 -0
  93. package/dist/skills/fluentcart-developer/references/hooks/actions/licenses.md +829 -0
  94. package/dist/skills/fluentcart-developer/references/hooks/actions/modules.md +81 -0
  95. package/dist/skills/fluentcart-developer/references/hooks/actions/orders.md +757 -0
  96. package/dist/skills/fluentcart-developer/references/hooks/actions/payments-and-integrations.md +1163 -0
  97. package/dist/skills/fluentcart-developer/references/hooks/actions/pro-modules.md +219 -0
  98. package/dist/skills/fluentcart-developer/references/hooks/actions/products-and-coupons.md +1019 -0
  99. package/dist/skills/fluentcart-developer/references/hooks/actions/subscriptions.md +1290 -0
  100. package/dist/skills/fluentcart-developer/references/hooks/actions.md +16 -0
  101. package/dist/skills/fluentcart-developer/references/hooks/deprecated.md +60 -0
  102. package/dist/skills/fluentcart-developer/references/hooks/filters/cart-and-checkout.md +2032 -0
  103. package/dist/skills/fluentcart-developer/references/hooks/filters/customers-and-subscriptions.md +1746 -0
  104. package/dist/skills/fluentcart-developer/references/hooks/filters/integrations-and-advanced.md +2439 -0
  105. package/dist/skills/fluentcart-developer/references/hooks/filters/modules.md +464 -0
  106. package/dist/skills/fluentcart-developer/references/hooks/filters/orders-and-payments.md +2658 -0
  107. package/dist/skills/fluentcart-developer/references/hooks/filters/pro-modules.md +502 -0
  108. package/dist/skills/fluentcart-developer/references/hooks/filters/products-and-pricing.md +1785 -0
  109. package/dist/skills/fluentcart-developer/references/hooks/filters/settings-and-configuration.md +2966 -0
  110. package/dist/skills/fluentcart-developer/references/hooks/filters.md +14 -0
  111. package/dist/skills/fluentcart-developer/references/hooks/index.md +35 -0
  112. package/dist/skills/fluentcart-developer/references/index.md +625 -0
  113. package/dist/skills/fluentcart-developer/references/{fee-system-guide.md → modules/fee-system.md} +38 -60
  114. package/dist/skills/fluentcart-developer/references/{ghost-product-selling.md → modules/ghost-product-selling.md} +71 -89
  115. package/dist/skills/fluentcart-developer/references/modules/index.md +484 -0
  116. package/dist/skills/fluentcart-developer/references/modules/licensing.md +342 -0
  117. package/dist/skills/fluentcart-developer/references/modules/order-bump.md +433 -0
  118. package/dist/skills/fluentcart-developer/references/modules/payment-methods.md +129 -0
  119. package/dist/skills/fluentcart-developer/references/modules/refunds.md +170 -0
  120. package/dist/skills/fluentcart-developer/references/modules/shipping.md +846 -0
  121. package/dist/skills/fluentcart-developer/references/modules/storage.md +986 -0
  122. package/dist/skills/fluentcart-developer/references/modules/subscription-vendor-ids.md +186 -0
  123. package/dist/skills/fluentcart-developer/references/modules/subscriptions.md +678 -0
  124. package/dist/skills/fluentcart-developer/references/payment-methods-integration/index.md +164 -0
  125. package/dist/skills/fluentcart-developer/references/payment-methods-integration/paddle-example.md +1648 -0
  126. package/dist/skills/fluentcart-developer/references/payment-methods-integration/payment/setting/fields.md +353 -0
  127. package/dist/skills/fluentcart-developer/references/payment-methods-integration/quick-implementation.md +1079 -0
  128. package/dist/skills/fluentcart-developer/references/payment-methods-integration.md +164 -0
  129. package/dist/skills/fluentcart-developer/references/restapi/checkout.md +573 -0
  130. package/dist/skills/fluentcart-developer/references/restapi/coupons.md +958 -0
  131. package/dist/skills/fluentcart-developer/references/restapi/customer-profile.md +1423 -0
  132. package/dist/skills/fluentcart-developer/references/{rest-api-customers.md → restapi/customers.md} +406 -424
  133. package/dist/skills/fluentcart-developer/references/restapi/dashboard.md +1083 -0
  134. package/dist/skills/fluentcart-developer/references/restapi/data-export.md +132 -0
  135. package/dist/skills/fluentcart-developer/references/restapi/email-notifications.md +846 -0
  136. package/dist/skills/fluentcart-developer/references/restapi/files.md +313 -0
  137. package/dist/skills/fluentcart-developer/references/restapi/index.md +127 -0
  138. package/dist/skills/fluentcart-developer/references/restapi/integrations.md +1000 -0
  139. package/dist/skills/fluentcart-developer/references/restapi/inventory.md +192 -0
  140. package/dist/skills/fluentcart-developer/references/restapi/labels-and-attributes.md +797 -0
  141. package/dist/skills/fluentcart-developer/references/restapi/licensing.md +1733 -0
  142. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-available-shipping-methods.md +30 -0
  143. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-checkout-summary.md +28 -0
  144. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-country-info.md +29 -0
  145. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-order-info.md +28 -0
  146. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-shipping-methods-list-view.md +30 -0
  147. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/login.md +66 -0
  148. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/place-order.md +179 -0
  149. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/apply-coupon.md +83 -0
  150. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/cancel-coupon.md +87 -0
  151. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/check-product-eligibility.md +59 -0
  152. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/create-coupon.md +230 -0
  153. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/delete-coupon.md +29 -0
  154. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/get-coupon-settings.md +20 -0
  155. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/get-coupon.md +27 -0
  156. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/list-coupon-codes.md +20 -0
  157. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/list-coupons.md +37 -0
  158. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/re-apply-coupons.md +75 -0
  159. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/store-coupon-settings.md +40 -0
  160. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/update-coupon.md +133 -0
  161. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/create-address-checkout.md +138 -0
  162. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/create-profile-address.md +119 -0
  163. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/dashboard-overview.md +22 -0
  164. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/delete-profile-address.md +46 -0
  165. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-order-details.md +30 -0
  166. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-portal-sections.md +29 -0
  167. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-profile-details.md +22 -0
  168. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-transaction-billing-address.md +30 -0
  169. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-upgrade-paths.md +31 -0
  170. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/list-downloads.md +29 -0
  171. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/list-orders.md +28 -0
  172. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/make-profile-address-primary.md +55 -0
  173. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/pause-subscription.md +29 -0
  174. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/resume-subscription.md +29 -0
  175. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/save-transaction-billing-address.md +92 -0
  176. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/select-address-for-checkout.md +32 -0
  177. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/update-profile-address.md +115 -0
  178. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/update-profile-details.md +69 -0
  179. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/attach-user.md +50 -0
  180. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/bulk-actions.md +65 -0
  181. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/create-address.md +135 -0
  182. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/create-customer.md +108 -0
  183. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/delete-address.md +62 -0
  184. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/detach-user.md +28 -0
  185. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/find-customer-order.md +27 -0
  186. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-attachable-users.md +20 -0
  187. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer-addresses.md +28 -0
  188. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer-orders.md +37 -0
  189. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer-stats.md +27 -0
  190. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer.md +32 -0
  191. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/list-customers.md +37 -0
  192. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/recalculate-ltv.md +28 -0
  193. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/set-primary-address.md +72 -0
  194. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/update-additional-info.md +55 -0
  195. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/update-address.md +144 -0
  196. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/update-customer.md +123 -0
  197. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/attach-note-to-order.md +49 -0
  198. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/create-all-pages.md +21 -0
  199. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/create-single-page.md +55 -0
  200. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/delete-activity.md +28 -0
  201. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-country-info.md +29 -0
  202. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-dashboard-stats.md +22 -0
  203. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-filter-options.md +31 -0
  204. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-onboarding-data.md +20 -0
  205. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-onboarding-settings.md +20 -0
  206. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-print-templates.md +20 -0
  207. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-search-options.md +27 -0
  208. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-widgets.md +28 -0
  209. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/initialize-app.md +20 -0
  210. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/list-activities.md +33 -0
  211. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/list-attachments.md +21 -0
  212. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/list-countries.md +20 -0
  213. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/mark-activity-read.md +53 -0
  214. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/run-data-backfills.md +21 -0
  215. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/save-onboarding-settings.md +54 -0
  216. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/save-onboarding-tax-settings.md +73 -0
  217. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/save-print-templates.md +64 -0
  218. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/upload-attachment.md +42 -0
  219. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-customers-batch.md +129 -0
  220. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-licenses-batch.md +133 -0
  221. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-orders-batch.md +129 -0
  222. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-subscriptions-batch.md +129 -0
  223. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-customers-export-schema.md +21 -0
  224. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-licenses-export-schema.md +26 -0
  225. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-orders-export-schema.md +21 -0
  226. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-subscriptions-export-schema.md +21 -0
  227. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/enable-notification.md +57 -0
  228. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-digest-settings.md +22 -0
  229. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-notification.md +30 -0
  230. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-reminders.md +22 -0
  231. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-settings.md +22 -0
  232. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-shortcodes.md +22 -0
  233. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/list-notifications.md +20 -0
  234. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/preview-default-template.md +66 -0
  235. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/preview-notification.md +50 -0
  236. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/save-digest-settings.md +101 -0
  237. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/save-reminders.md +162 -0
  238. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/save-settings.md +99 -0
  239. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/send-digest-test.md +47 -0
  240. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/send-manual-reminder.md +51 -0
  241. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/update-notification.md +93 -0
  242. package/dist/skills/fluentcart-developer/references/restapi/operations/files/delete-file.md +31 -0
  243. package/dist/skills/fluentcart-developer/references/restapi/operations/files/get-bucket-list.md +28 -0
  244. package/dist/skills/fluentcart-developer/references/restapi/operations/files/list-files.md +30 -0
  245. package/dist/skills/fluentcart-developer/references/restapi/operations/files/upload-editor-file.md +32 -0
  246. package/dist/skills/fluentcart-developer/references/restapi/operations/files/upload-file.md +34 -0
  247. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/chained-data-request.md +46 -0
  248. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/change-feed-status.md +51 -0
  249. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/delete-feed.md +27 -0
  250. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-dynamic-options.md +29 -0
  251. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-feed-lists.md +27 -0
  252. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-feed-settings.md +27 -0
  253. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-global-feeds.md +20 -0
  254. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-global-settings.md +26 -0
  255. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/install-addon-plugin.md +49 -0
  256. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/list-addons.md +20 -0
  257. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/save-feed-settings.md +52 -0
  258. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/set-global-settings.md +50 -0
  259. package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/bulk-update-stock.md +94 -0
  260. package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/export-inventory.md +81 -0
  261. package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/get-adjustment-history.md +26 -0
  262. package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/get-inventory-stats.md +21 -0
  263. package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/list-inventory.md +33 -0
  264. package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/update-stock.md +75 -0
  265. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/create-attribute-group.md +31 -0
  266. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/create-label.md +31 -0
  267. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/create-terms.md +90 -0
  268. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/delete-attribute-group.md +28 -0
  269. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/delete-attribute-term.md +29 -0
  270. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/get-attribute-group.md +28 -0
  271. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/get-attribute-library.md +20 -0
  272. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/list-attribute-groups.md +32 -0
  273. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/list-attribute-terms.md +33 -0
  274. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/list-labels.md +20 -0
  275. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/reorder-groups.md +51 -0
  276. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/reorder-terms.md +56 -0
  277. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/update-attribute-group.md +37 -0
  278. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/update-attribute-term.md +39 -0
  279. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/update-label-selections.md +32 -0
  280. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/activate-plugin-license.md +41 -0
  281. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/activate-site-admin.md +60 -0
  282. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/deactivate-plugin-license.md +18 -0
  283. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/deactivate-site-admin.md +67 -0
  284. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/deactivate-site-customer.md +47 -0
  285. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/delete-license.md +24 -0
  286. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/extend-license-validity.md +47 -0
  287. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-customer-license-details.md +25 -0
  288. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-customer-licenses-admin.md +26 -0
  289. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-license-activations.md +25 -0
  290. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-license-details.md +25 -0
  291. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-license-site.md +30 -0
  292. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-plugin-license-status.md +18 -0
  293. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-product-license-settings.md +24 -0
  294. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/list-customer-licenses.md +25 -0
  295. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/list-license-sites.md +33 -0
  296. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/list-licenses.md +38 -0
  297. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-activate-license.md +54 -0
  298. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-check-license.md +26 -0
  299. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-deactivate-license.md +46 -0
  300. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-download-license-package.md +23 -0
  301. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-get-license-version.md +26 -0
  302. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/regenerate-license-key.md +24 -0
  303. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/save-product-license-settings.md +193 -0
  304. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/update-license-activation-limit.md +53 -0
  305. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/update-license-status.md +52 -0
  306. package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/create-order-bump.md +47 -0
  307. package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/delete-order-bump.md +25 -0
  308. package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/get-order-bump.md +25 -0
  309. package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/list-order-bumps.md +29 -0
  310. package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/update-order-bump.md +141 -0
  311. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/accept-dispute.md +47 -0
  312. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/bulk-actions.md +72 -0
  313. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/calculate-shipping.md +67 -0
  314. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/calculate-tax.md +98 -0
  315. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/change-customer.md +50 -0
  316. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/charge-now.md +29 -0
  317. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-and-change-customer.md +92 -0
  318. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-custom-order-item.md +68 -0
  319. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-order.md +351 -0
  320. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-renewal-now.md +29 -0
  321. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/delete-order.md +28 -0
  322. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/generate-missing-licenses.md +29 -0
  323. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-order-transactions.md +27 -0
  324. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-order.md +27 -0
  325. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-renewal.md +28 -0
  326. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-shipping-methods.md +28 -0
  327. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-single-transaction.md +28 -0
  328. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/list-order-currencies.md +22 -0
  329. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/list-orders.md +42 -0
  330. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/list-renewals.md +28 -0
  331. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/mark-as-paid.md +61 -0
  332. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/price-order.md +135 -0
  333. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/refund-order.md +72 -0
  334. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/resend-renewal-invoice.md +29 -0
  335. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/skip-renewal.md +48 -0
  336. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/sync-order-statuses.md +28 -0
  337. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/sync-pending-transaction.md +29 -0
  338. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-order-address-id.md +60 -0
  339. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-order-address.md +98 -0
  340. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-order.md +172 -0
  341. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-statuses.md +77 -0
  342. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-subscription-details.md +84 -0
  343. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-transaction-status.md +51 -0
  344. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/void-renewal.md +30 -0
  345. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/create-pdf-template.md +42 -0
  346. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/delete-pdf-template.md +26 -0
  347. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/download-pdf-preview.md +44 -0
  348. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-factory-default-templates.md +19 -0
  349. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-pdf-status.md +21 -0
  350. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-pdf-template.md +26 -0
  351. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-saved-templates.md +21 -0
  352. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-seller-details.md +19 -0
  353. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/list-pdf-templates.md +19 -0
  354. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/save-pdf-template.md +53 -0
  355. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/save-seller-details.md +97 -0
  356. package/dist/skills/fluentcart-developer/references/restapi/operations/products/add-product-terms.md +64 -0
  357. package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-edit-fetch.md +30 -0
  358. package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-insert-products.md +62 -0
  359. package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-update-products.md +59 -0
  360. package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-update-variants.md +83 -0
  361. package/dist/skills/fluentcart-developer/references/restapi/operations/products/change-integration-status.md +64 -0
  362. package/dist/skills/fluentcart-developer/references/restapi/operations/products/create-dummy-products.md +45 -0
  363. package/dist/skills/fluentcart-developer/references/restapi/operations/products/create-product.md +81 -0
  364. package/dist/skills/fluentcart-developer/references/restapi/operations/products/create-variation.md +181 -0
  365. package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-downloadable-file.md +27 -0
  366. package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-product-integration.md +30 -0
  367. package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-product.md +27 -0
  368. package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-taxonomy-term.md +55 -0
  369. package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-upgrade-path.md +27 -0
  370. package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-variation.md +27 -0
  371. package/dist/skills/fluentcart-developer/references/restapi/operations/products/do-bulk-action.md +56 -0
  372. package/dist/skills/fluentcart-developer/references/restapi/operations/products/duplicate-product.md +56 -0
  373. package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-products-by-ids.md +26 -0
  374. package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-taxonomy-terms.md +20 -0
  375. package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-terms-by-parent.md +60 -0
  376. package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-variations-by-ids.md +26 -0
  377. package/dist/skills/fluentcart-developer/references/restapi/operations/products/find-subscription-variants.md +26 -0
  378. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-bundle-info.md +27 -0
  379. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-downloadable-url.md +27 -0
  380. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-max-excerpt-word-count.md +20 -0
  381. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-pricing-widgets.md +27 -0
  382. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product-integration-feeds.md +29 -0
  383. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product-integration-settings.md +31 -0
  384. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product-pricing.md +28 -0
  385. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product.md +28 -0
  386. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-related-products.md +31 -0
  387. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-upgrade-settings.md +27 -0
  388. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-variation-upgrade-paths.md +28 -0
  389. package/dist/skills/fluentcart-developer/references/restapi/operations/products/group-bulk-update-variants.md +103 -0
  390. package/dist/skills/fluentcart-developer/references/restapi/operations/products/list-all-variants.md +26 -0
  391. package/dist/skills/fluentcart-developer/references/restapi/operations/products/list-product-variations.md +26 -0
  392. package/dist/skills/fluentcart-developer/references/restapi/operations/products/list-products.md +34 -0
  393. package/dist/skills/fluentcart-developer/references/restapi/operations/products/remove-shipping-class.md +27 -0
  394. package/dist/skills/fluentcart-developer/references/restapi/operations/products/remove-tax-class.md +27 -0
  395. package/dist/skills/fluentcart-developer/references/restapi/operations/products/save-bundle-info.md +56 -0
  396. package/dist/skills/fluentcart-developer/references/restapi/operations/products/save-product-integration.md +62 -0
  397. package/dist/skills/fluentcart-developer/references/restapi/operations/products/save-upgrade-path.md +78 -0
  398. package/dist/skills/fluentcart-developer/references/restapi/operations/products/search-product-variant-options.md +29 -0
  399. package/dist/skills/fluentcart-developer/references/restapi/operations/products/search-products-by-name.md +28 -0
  400. package/dist/skills/fluentcart-developer/references/restapi/operations/products/search-variants-by-name.md +28 -0
  401. package/dist/skills/fluentcart-developer/references/restapi/operations/products/set-variation-media.md +74 -0
  402. package/dist/skills/fluentcart-developer/references/restapi/operations/products/suggest-sku.md +28 -0
  403. package/dist/skills/fluentcart-developer/references/restapi/operations/products/sync-downloadable-files.md +134 -0
  404. package/dist/skills/fluentcart-developer/references/restapi/operations/products/sync-taxonomy-terms.md +61 -0
  405. package/dist/skills/fluentcart-developer/references/restapi/operations/products/toggle-product-tax-exemption.md +56 -0
  406. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-downloadable-file.md +98 -0
  407. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-inventory.md +56 -0
  408. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-long-desc-editor-mode.md +49 -0
  409. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-manage-stock.md +53 -0
  410. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-product-detail.md +58 -0
  411. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-product-pricing.md +225 -0
  412. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-shipping-class.md +49 -0
  413. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-tax-class.md +49 -0
  414. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-upgrade-path.md +78 -0
  415. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variant-option.md +79 -0
  416. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variant-tax-exemption.md +56 -0
  417. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variation-pricing-table.md +49 -0
  418. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variation.md +105 -0
  419. package/dist/skills/fluentcart-developer/references/restapi/operations/public-shop/get-product-views.md +34 -0
  420. package/dist/skills/fluentcart-developer/references/restapi/operations/public-shop/list-products.md +42 -0
  421. package/dist/skills/fluentcart-developer/references/restapi/operations/public-shop/search-products.md +30 -0
  422. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/channel-rules.md +24 -0
  423. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/country-heat-map.md +22 -0
  424. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/coupon-overview.md +37 -0
  425. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/coupons.md +36 -0
  426. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-insights.md +31 -0
  427. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-overview.md +36 -0
  428. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-repeat.md +35 -0
  429. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-segment-customers.md +36 -0
  430. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-segments.md +30 -0
  431. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-value.md +34 -0
  432. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/dashboard-stats.md +30 -0
  433. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/failed-orders.md +34 -0
  434. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-new-vs-returning-customer.md +34 -0
  435. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-report-by-day-and-hour.md +34 -0
  436. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-report-meta.md +29 -0
  437. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-top-sold-products.md +34 -0
  438. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/future-renewals.md +31 -0
  439. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/generate-retention-snapshots.md +24 -0
  440. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-overview.md +30 -0
  441. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-recent-activities.md +26 -0
  442. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-recent-orders.md +20 -0
  443. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-revenue.md +37 -0
  444. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/installments-at-risk.md +35 -0
  445. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/installments-variations.md +33 -0
  446. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/installments.md +33 -0
  447. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/item-count-distribution.md +34 -0
  448. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/license-chart.md +30 -0
  449. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/license-pie-chart.md +22 -0
  450. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/license-summary.md +22 -0
  451. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/locations.md +43 -0
  452. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-chart.md +37 -0
  453. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-completion-time.md +34 -0
  454. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-mix.md +34 -0
  455. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-value-distribution.md +34 -0
  456. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/payment-methods-disputes.md +38 -0
  457. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/payment-methods-methods.md +36 -0
  458. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/payment-methods.md +37 -0
  459. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-comparison-launch.md +33 -0
  460. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-comparison.md +40 -0
  461. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-detail.md +37 -0
  462. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-sales.md +37 -0
  463. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/refunds-overview.md +37 -0
  464. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/retention-snapshots-step.md +45 -0
  465. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/sales-growth-chart.md +35 -0
  466. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/save-channel-rules.md +73 -0
  467. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/source-channels.md +37 -0
  468. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/sources.md +49 -0
  469. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-cohorts.md +33 -0
  470. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-health.md +30 -0
  471. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-rebuys.md +37 -0
  472. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-retention.md +34 -0
  473. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-variations.md +22 -0
  474. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscriptions-overview.md +37 -0
  475. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/weeks-between-refund.md +34 -0
  476. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/assign-role.md +48 -0
  477. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/delete-role-assignment.md +47 -0
  478. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/get-role.md +25 -0
  479. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/list-managers.md +18 -0
  480. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/list-roles.md +18 -0
  481. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/search-users.md +25 -0
  482. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/update-role.md +43 -0
  483. package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/create-saved-view.md +106 -0
  484. package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/delete-saved-view.md +26 -0
  485. package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/list-saved-views.md +25 -0
  486. package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/update-saved-view.md +83 -0
  487. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/activate-payment-addon.md +44 -0
  488. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/activate-plugin-addon.md +44 -0
  489. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/change-storage-driver-status.md +56 -0
  490. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/check-paypal-webhook.md +26 -0
  491. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/create-storage-bucket.md +63 -0
  492. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/disconnect-payment-method.md +55 -0
  493. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/exchange-paypal-seller-auth-token.md +62 -0
  494. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-active-storage-drivers.md +20 -0
  495. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-checkout-fields.md +22 -0
  496. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-email-shortcodes.md +20 -0
  497. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-mcp-config-snippets.md +26 -0
  498. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-mcp-status.md +20 -0
  499. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-module-settings.md +20 -0
  500. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-payment-method-connection-info.md +26 -0
  501. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-payment-method-settings.md +26 -0
  502. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-permissions.md +22 -0
  503. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-plugin-addons.md +20 -0
  504. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-storage-driver-settings.md +27 -0
  505. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-store-settings.md +26 -0
  506. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/install-mcp-adapter.md +21 -0
  507. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/install-payment-addon.md +60 -0
  508. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/install-plugin-addon.md +64 -0
  509. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/list-all-payment-methods.md +20 -0
  510. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/list-all-storage-drivers.md +20 -0
  511. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/list-storage-buckets.md +67 -0
  512. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/reorder-payment-methods.md +55 -0
  513. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/reset-storage-driver-settings.md +45 -0
  514. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-checkout-fields.md +133 -0
  515. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-confirmation-settings.md +68 -0
  516. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-module-settings.md +68 -0
  517. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-payment-method-design.md +67 -0
  518. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-payment-method-settings.md +58 -0
  519. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-permissions.md +68 -0
  520. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-storage-driver-settings.md +62 -0
  521. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-store-settings.md +239 -0
  522. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/setup-paypal-webhook.md +48 -0
  523. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/toggle-mcp.md +40 -0
  524. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/verify-storage-driver-connection.md +62 -0
  525. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/verify-turnstile-keys.md +55 -0
  526. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/create-shipping-class.md +73 -0
  527. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/create-shipping-method.md +110 -0
  528. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/create-shipping-zone.md +56 -0
  529. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/delete-shipping-class.md +29 -0
  530. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/delete-shipping-method.md +29 -0
  531. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/delete-shipping-zone.md +29 -0
  532. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-class-profile.md +30 -0
  533. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-class.md +29 -0
  534. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-packages.md +22 -0
  535. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-zone.md +27 -0
  536. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-zone-countries.md +22 -0
  537. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-zone-states.md +28 -0
  538. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/list-shipping-classes.md +31 -0
  539. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/list-shipping-zones.md +31 -0
  540. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/save-shipping-packages.md +112 -0
  541. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-shipping-class.md +79 -0
  542. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-shipping-method.md +113 -0
  543. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-shipping-zone.md +62 -0
  544. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-zone-order.md +52 -0
  545. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/cancel-auto-renew.md +30 -0
  546. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/cancel-subscription.md +52 -0
  547. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/confirm-subscription-switch.md +70 -0
  548. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/fetch-subscription-remote.md +28 -0
  549. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/generate-early-payment-link.md +29 -0
  550. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-customer-subscription.md +27 -0
  551. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-or-create-plan.md +69 -0
  552. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-setup-intent-attempts.md +30 -0
  553. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-subscription.md +28 -0
  554. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/initiate-early-payment.md +31 -0
  555. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/list-customer-subscriptions.md +27 -0
  556. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/list-subscriptions.md +39 -0
  557. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/pause-subscription.md +28 -0
  558. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/reactivate-subscription.md +28 -0
  559. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/resume-subscription.md +28 -0
  560. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/switch-payment-method.md +70 -0
  561. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/update-payment-method.md +69 -0
  562. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/update-vendor-ids.md +56 -0
  563. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/verify-vendor-ids.md +56 -0
  564. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/create-tax-class.md +51 -0
  565. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/create-tax-rate.md +117 -0
  566. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-product-override.md +27 -0
  567. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-shipping-tax-override.md +27 -0
  568. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-tax-class.md +28 -0
  569. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-tax-rate.md +27 -0
  570. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-country-tax-id.md +27 -0
  571. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-country-tax-rates.md +28 -0
  572. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-eu-vat-product-overrides.md +20 -0
  573. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-oss-country-rates.md +20 -0
  574. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-preconfigured-tax-rates.md +20 -0
  575. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-product-overrides.md +27 -0
  576. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-tax-settings.md +20 -0
  577. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/list-all-tax-rates.md +20 -0
  578. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/list-tax-classes.md +20 -0
  579. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/list-tax-records.md +37 -0
  580. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/mark-taxes-as-filed.md +58 -0
  581. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/reset-eu-vat-rates.md +21 -0
  582. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-configured-countries.md +57 -0
  583. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-country-tax-id.md +50 -0
  584. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-eu-vat-cross-border-settings.md +127 -0
  585. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-oss-country-rates.md +100 -0
  586. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-product-override.md +110 -0
  587. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-shipping-tax-override.md +52 -0
  588. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-tax-settings.md +166 -0
  589. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/update-country-status.md +54 -0
  590. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/update-tax-rate.md +116 -0
  591. package/dist/skills/fluentcart-developer/references/restapi/order-bumps.md +433 -0
  592. package/dist/skills/fluentcart-developer/references/{rest-api-orders.md → restapi/orders.md} +146 -396
  593. package/dist/skills/fluentcart-developer/references/restapi/pdf-templates.md +212 -0
  594. package/dist/skills/fluentcart-developer/references/{rest-api-products.md → restapi/products.md} +354 -566
  595. package/dist/skills/fluentcart-developer/references/restapi/public-shop.md +191 -0
  596. package/dist/skills/fluentcart-developer/references/restapi/reports.md +3773 -0
  597. package/dist/skills/fluentcart-developer/references/restapi/roles.md +403 -0
  598. package/dist/skills/fluentcart-developer/references/restapi/saved-views.md +136 -0
  599. package/dist/skills/fluentcart-developer/references/restapi/settings.md +1423 -0
  600. package/dist/skills/fluentcart-developer/references/{rest-api-shipping.md → restapi/shipping.md} +243 -138
  601. package/dist/skills/fluentcart-developer/references/restapi/subscriptions.md +1169 -0
  602. package/dist/skills/fluentcart-developer/references/restapi/tax.md +1551 -0
  603. package/dist/skills/fluentcart-developer/references/restapi.md +127 -0
  604. package/dist/version.d.ts +1 -1
  605. package/dist/version.js +1 -1
  606. package/package.json +1 -1
  607. package/dist/skills/fluentcart-developer/.claude-plugin/plugin.json +0 -12
  608. package/dist/skills/fluentcart-developer/.mcp.json +0 -11
  609. package/dist/skills/fluentcart-developer/references/action-hooks-admin-templates.md +0 -787
  610. package/dist/skills/fluentcart-developer/references/action-hooks-cart-checkout.md +0 -1355
  611. package/dist/skills/fluentcart-developer/references/action-hooks-customers-users.md +0 -266
  612. package/dist/skills/fluentcart-developer/references/action-hooks-licenses.md +0 -855
  613. package/dist/skills/fluentcart-developer/references/action-hooks-orders.md +0 -631
  614. package/dist/skills/fluentcart-developer/references/action-hooks-payments-integrations.md +0 -963
  615. package/dist/skills/fluentcart-developer/references/action-hooks-products-coupons.md +0 -585
  616. package/dist/skills/fluentcart-developer/references/action-hooks-subscriptions.md +0 -661
  617. package/dist/skills/fluentcart-developer/references/customer-dashboard-endpoints.md +0 -169
  618. package/dist/skills/fluentcart-developer/references/database-models-query-builder.md +0 -194
  619. package/dist/skills/fluentcart-developer/references/database-models-reference.md +0 -604
  620. package/dist/skills/fluentcart-developer/references/database-schema-reference.md +0 -947
  621. package/dist/skills/fluentcart-developer/references/engineering-notes.md +0 -154
  622. package/dist/skills/fluentcart-developer/references/filter-hooks-cart-checkout.md +0 -1202
  623. package/dist/skills/fluentcart-developer/references/filter-hooks-customers-subscriptions.md +0 -902
  624. package/dist/skills/fluentcart-developer/references/filter-hooks-integrations-advanced.md +0 -1598
  625. package/dist/skills/fluentcart-developer/references/filter-hooks-orders-payments.md +0 -1319
  626. package/dist/skills/fluentcart-developer/references/filter-hooks-products-pricing.md +0 -628
  627. package/dist/skills/fluentcart-developer/references/filter-hooks-settings-configuration.md +0 -1177
  628. package/dist/skills/fluentcart-developer/references/fluentcart-developer-guide.md +0 -154
  629. package/dist/skills/fluentcart-developer/references/hooks-complete-index.md +0 -834
  630. package/dist/skills/fluentcart-developer/references/models-complete-index.md +0 -912
  631. package/dist/skills/fluentcart-developer/references/modules-and-extensions-reference.md +0 -224
  632. package/dist/skills/fluentcart-developer/references/order-bump-module.md +0 -163
  633. package/dist/skills/fluentcart-developer/references/paddle-gateway-case-study.md +0 -1931
  634. package/dist/skills/fluentcart-developer/references/payment-gateway-integration.md +0 -761
  635. package/dist/skills/fluentcart-developer/references/rest-api-checkout.md +0 -288
  636. package/dist/skills/fluentcart-developer/references/rest-api-coupons.md +0 -801
  637. package/dist/skills/fluentcart-developer/references/rest-api-customer-profile.md +0 -190
  638. package/dist/skills/fluentcart-developer/references/rest-api-dashboard-utilities.md +0 -219
  639. package/dist/skills/fluentcart-developer/references/rest-api-email-notifications.md +0 -619
  640. package/dist/skills/fluentcart-developer/references/rest-api-files.md +0 -290
  641. package/dist/skills/fluentcart-developer/references/rest-api-integrations.md +0 -324
  642. package/dist/skills/fluentcart-developer/references/rest-api-labels-attributes.md +0 -321
  643. package/dist/skills/fluentcart-developer/references/rest-api-licensing.md +0 -174
  644. package/dist/skills/fluentcart-developer/references/rest-api-order-bumps.md +0 -200
  645. package/dist/skills/fluentcart-developer/references/rest-api-overview.md +0 -131
  646. package/dist/skills/fluentcart-developer/references/rest-api-public-shop.md +0 -172
  647. package/dist/skills/fluentcart-developer/references/rest-api-reference.md +0 -552
  648. package/dist/skills/fluentcart-developer/references/rest-api-reports.md +0 -377
  649. package/dist/skills/fluentcart-developer/references/rest-api-roles-permissions.md +0 -147
  650. package/dist/skills/fluentcart-developer/references/rest-api-settings.md +0 -528
  651. package/dist/skills/fluentcart-developer/references/rest-api-subscriptions.md +0 -938
  652. package/dist/skills/fluentcart-developer/references/rest-api-tax.md +0 -356
  653. package/dist/skills/fluentcart-developer/references/shipping-module-guide.md +0 -126
  654. package/dist/skills/fluentcart-developer/references/software-licensing-sdk.md +0 -228
  655. package/dist/skills/fluentcart-developer/references/storage-drivers-module.md +0 -140
@@ -1,377 +0,0 @@
1
- # Reports API
2
-
3
- Access comprehensive sales analytics, revenue data, order statistics, customer insights, subscription metrics, cohort retention, and product performance reports in FluentCart.
4
-
5
- **Base URL:** `https://your-site.com/wp-json/fluent-cart/v2/reports`
6
- **Policy:** `ReportPolicy`
7
- **Permission:** `reports/view` (accessible to `super_admin`, `manager`, and `accountant` roles)
8
-
9
- > **Monetary Values & Decimal Variations:** All monetary values are in **cents** unless specifically noted (e.g., `sales-growth-chart`, `get-recent-orders`, and `future_installments` return values formatted in dollars decimal). Pro license unlocks custom date ranges; free plan defaults to the last 30 days.
10
-
11
- ---
12
-
13
- ## Standard Report Parameters
14
-
15
- Most report GET endpoints process query parameters via `ReportHelper::processParams()` using the nested `params[...]` object.
16
-
17
- | Parameter | Type | Required | Description |
18
- |-----------|------|----------|-------------|
19
- | `params[startDate]` | string | No | Start date for report period (`YYYY-MM-DD`). Defaults to 30 days ago |
20
- | `params[endDate]` | string | No | End date for report period (`YYYY-MM-DD`). Defaults to today |
21
- | `params[groupKey]` | string | No | Grouping interval: `default` (auto), `daily`, `monthly`, `yearly`, `billing_country`, `shipping_country`, `payment_method`, `payment_status` |
22
- | `params[currency]` | string | No | Currency code (e.g. `USD`). Defaults to store currency |
23
- | `params[filterMode]` | string | No | Mode filter: `live` or `test`. Defaults to store setting |
24
- | `params[variation_ids]` | array | No | Product variation IDs array to filter containing orders |
25
- | `params[compareType]` | string | No | Comparison period: `previous_period`, `previous_month`, `previous_quarter`, `previous_year`, `custom` |
26
- | `params[compareDate]` | string | No | Custom comparison start date (required when `compareType` is `custom`) |
27
- | `params[paymentStatus]` | array | No | Auto-set to report-eligible statuses (`paid`, `partially-paid`, `refunded`, `partially-refunded`) |
28
- | `params[orderTypes]` | array | No | Filter by order type (`one-time`, `subscription`) |
29
- | `params[orderStatus]` | array | No | Order status filter (excluding `on-hold` & `failed` by default) |
30
- | `params[subscriptionType]` | string | No | Subscription type filter (defaults to `subscription`) |
31
-
32
- ---
33
-
34
- ## Endpoints Overview
35
-
36
- | Group | Method | Endpoint | Description |
37
- |-------|--------|----------|-------------|
38
- | **Overview** | GET | `/reports/overview` | 12-month YoY revenue breakdown & top countries |
39
- | **General Reports** | GET | `/reports/fetch-report-meta` | Store currencies, min_date, and store mode |
40
- | | GET | `/reports/quick-order-stats` | Quick summary stats with date range shortcut |
41
- | | GET | `/reports/sales-growth` | Sales growth over custom date range |
42
- | | GET | `/reports/report-overview` | Aggregated order summary & payment method breakdown |
43
- | | GET | `/reports/search-repeat-customer` | Search & paginate repeat customer profiles |
44
- | | GET | `/reports/top-products-sold` | Top products sold via Resource API layer |
45
- | **Revenue Reports** | GET | `/reports/revenue` | Grouped gross/net revenue with period comparisons |
46
- | | GET | `/reports/revenue-by-group` | Revenue grouped by country, gateway, or status |
47
- | **Order Reports** | GET | `/reports/order-value-distribution` | Price range order value breakdown |
48
- | | GET | `/reports/fetch-new-vs-returning-customer` | New vs. returning customer order ratio |
49
- | | GET | `/reports/fetch-order-by-group` | Orders grouped by gateway, country, or status |
50
- | | GET | `/reports/fetch-report-by-day-and-hour` | Heatmap matrix of orders by day of week & hour |
51
- | | GET | `/reports/item-count-distribution` | Distribution of order volume by item counts |
52
- | | GET | `/reports/order-completion-time` | Order processing & completion time analytics |
53
- | | GET | `/reports/order-chart` | Time-series order count chart with comparison |
54
- | **Sales Reports** | GET | `/reports/sales-report` | Complete sales metrics (revenue, orders, items) |
55
- | | GET | `/reports/fetch-top-sold-products` | Best-selling products ranking |
56
- | | GET | `/reports/fetch-top-sold-variants` | Best-selling product variations ranking |
57
- | **Refund Reports** | GET | `/reports/refund-chart` | Time-series refund metrics & summary |
58
- | | GET | `/reports/weeks-between-refund` | Weeks elapsed between order placement & refund |
59
- | | GET | `/reports/refund-data-by-group` | Refund statistics grouped by gateway or country |
60
- | **License Reports** | GET | `/reports/license-chart` | Software license issuance time-series chart |
61
- | | GET | `/reports/license-pie-chart` | License status distribution (active, expired, revoked) |
62
- | | GET | `/reports/license-summary` | Overall license issuance & activation metrics |
63
- | **Dashboard** | GET | `/reports/dashboard-stats` | Summary cards (orders, items, paid value in cents) |
64
- | | GET | `/reports/sales-growth-chart` | Net revenue growth chart (in dollars decimal) |
65
- | | GET | `/reports/country-heat-map` | Country distribution for world map visualization |
66
- | | GET | `/reports/get-recent-orders` | 10 most recent orders (total in dollars decimal) |
67
- | | GET | `/reports/get-recent-activities` | 10 most recent activity log entries |
68
- | | GET | `/reports/get-dashboard-summary` | Product catalog & coupon counts summary |
69
- | **Subscriptions** | GET | `/reports/subscription-chart` | MRR growth & future installment projections |
70
- | | GET | `/reports/daily-signups` | Daily subscription signup counts |
71
- | | GET | `/reports/retention-chart` | Subscription subscriber retention chart |
72
- | | GET | `/reports/future-renewals` | Projected future subscription renewals |
73
- | | GET | `/reports/subscription-retention` | Billing period retention rate metrics |
74
- | | GET | `/reports/subscription-cohorts` | Monthly/yearly cohort retention matrix |
75
- | **Snapshots** | POST | `/reports/retention-snapshots/generate` | Trigger background/sync retention snapshot calculation |
76
- | | GET | `/reports/retention-snapshots/status` | Poll retention snapshot job status |
77
- | **Product/Customer** | GET | `/reports/product-report` | Product performance time-series & summary |
78
- | | GET | `/reports/product-performance` | Ranked product performance chart |
79
- | | GET | `/reports/customer-report` | Customer acquisition & retention time-series |
80
- | | GET | `/reports/sources` | UTM attribution & order traffic source report |
81
-
82
- ---
83
-
84
- ## Overview & General Reports
85
-
86
- ### Get Revenue Overview
87
-
88
- `GET /fluent-cart/v2/reports/overview`
89
-
90
- Year-over-year revenue comparison for the last 12 months vs. prior year. (Covers 30 months of data internally to build 12-month YoY metrics). Top country data is limited to top 5 countries.
91
-
92
- > **Calculation Rules:**
93
- > - Gross Revenue = `total_paid`
94
- > - Net Revenue = `total_paid - total_refund - tax_total - shipping_tax`
95
-
96
- #### Response
97
-
98
- ```json
99
- {
100
- "data": {
101
- "gross_revenue": {
102
- "2025-01": {
103
- "current": 500000,
104
- "prev": 350000,
105
- "yoy_growth": "42.86"
106
- }
107
- },
108
- "gross_revenue_quarterly": {
109
- "Q1-2025": {
110
- "current": 1500000,
111
- "prev_year": 1200000,
112
- "yy_growth": "25.00"
113
- }
114
- },
115
- "gross_summary": {
116
- "total": 6000000,
117
- "total_prev": 4800000,
118
- "yoy_growth": "25.00"
119
- },
120
- "top_country_net": {
121
- "by_month": {
122
- "2025-01": { "US": 300000, "GB": 150000 }
123
- },
124
- "by_countries": { "US": 3600000, "GB": 1800000 }
125
- }
126
- }
127
- }
128
- ```
129
-
130
- ---
131
-
132
- ### Get Quick Order Stats
133
-
134
- `GET /fluent-cart/v2/reports/quick-order-stats`
135
-
136
- #### Parameters
137
-
138
- | Parameter | Type | Location | Required | Description |
139
- |-----------|------|----------|----------|-------------|
140
- | `day_range` | string | query | No | Range shortcut (e.g., `-7 days`, `-30 days`, `this_month`, `all_time`). Default: `-0 days` (today) |
141
-
142
- ---
143
-
144
- ### Search Repeat Customers
145
-
146
- `GET /fluent-cart/v2/reports/search-repeat-customer`
147
-
148
- #### Parameters
149
-
150
- | Parameter | Type | Location | Required | Description |
151
- |-----------|------|----------|----------|-------------|
152
- | `params[per_page]` | integer | query | No | Items per page (default: 15) |
153
- | `params[current_page]` | integer | query | No | Current page number |
154
-
155
- ---
156
-
157
- ## Revenue & Order Reports
158
-
159
- ### Get Revenue Data
160
-
161
- `GET /fluent-cart/v2/reports/revenue`
162
-
163
- Uses Standard Report Parameters to calculate gross/net revenue time-series and period fluctuations.
164
-
165
- #### Response
166
-
167
- ```json
168
- {
169
- "revenueReport": [
170
- {
171
- "year": "2025",
172
- "group": "2025-01",
173
- "gross_revenue": 500000,
174
- "net_revenue": 450000,
175
- "orders": 45
176
- }
177
- ],
178
- "summary": {
179
- "gross_revenue": 6000000,
180
- "net_revenue": 5400000,
181
- "total_orders": 540
182
- },
183
- "fluctuations": {
184
- "gross_revenue": {
185
- "value": 25.0,
186
- "direction": "up"
187
- }
188
- },
189
- "appliedGroupKey": "monthly"
190
- }
191
- ```
192
-
193
- ---
194
-
195
- ### Get Day and Hour Heatmap
196
-
197
- `GET /fluent-cart/v2/reports/fetch-report-by-day-and-hour`
198
-
199
- Returns day-of-week (0-6) and hour-of-day (0-23) matrix data for order density heatmaps.
200
-
201
- ---
202
-
203
- ## Dashboard Reports
204
-
205
- ### Get Dashboard Stats
206
-
207
- `GET /fluent-cart/v2/reports/dashboard-stats`
208
-
209
- #### Response
210
-
211
- ```json
212
- {
213
- "dashBoardStats": {
214
- "total_orders": {
215
- "title": "All Orders",
216
- "icon": "AllOrdersIcon",
217
- "current_count": 540,
218
- "compare_count": 480
219
- },
220
- "paid_orders": {
221
- "title": "Paid Orders",
222
- "icon": "Money",
223
- "current_count": 520,
224
- "compare_count": 460
225
- },
226
- "total_paid_order_items": {
227
- "title": "Paid Order Items",
228
- "icon": "OrderItemsIcon",
229
- "current_count": 1200,
230
- "compare_count": 1050
231
- },
232
- "total_paid_amounts": {
233
- "title": "Order Value (Paid)",
234
- "icon": "OrderValueIcon",
235
- "current_count": 6000000,
236
- "compare_count": 5200000,
237
- "is_cents": true
238
- }
239
- }
240
- }
241
- ```
242
-
243
- ---
244
-
245
- ### Get Sales Growth Chart (Decimal Dollars)
246
-
247
- `GET /fluent-cart/v2/reports/sales-growth-chart`
248
-
249
- > **Note:** Net revenue in this response is returned in **decimal dollars**, not cents (`(total_paid - total_refund - tax_total - shipping_tax) / 100`).
250
-
251
- ```json
252
- {
253
- "salesGrowthChart": [
254
- {
255
- "year": "2025",
256
- "group": "2025-01",
257
- "orders": 45,
258
- "net_revenue": 4500.00
259
- }
260
- ]
261
- }
262
- ```
263
-
264
- ---
265
-
266
- ### Get Recent Orders (Decimal Dollars)
267
-
268
- `GET /fluent-cart/v2/reports/get-recent-orders`
269
-
270
- > **Note:** `total_amount` is returned in **decimal dollars** (`99.99`).
271
-
272
- ```json
273
- {
274
- "recentOrders": [
275
- {
276
- "id": 150,
277
- "customer_id": 42,
278
- "customer_name": "John Doe",
279
- "total_amount": 99.99,
280
- "created_at": "2025-06-15 14:30:00",
281
- "order_items_count": 3
282
- }
283
- ]
284
- }
285
- ```
286
-
287
- ---
288
-
289
- ## Subscription Reports & Retention Snapshots
290
-
291
- ### Get Subscription Chart
292
-
293
- `GET /fluent-cart/v2/reports/subscription-chart`
294
-
295
- > **Note:** `future_installments` is returned in **decimal dollars** (`sum((bill_times - bill_count) * recurring_total) / 100`).
296
-
297
- ```json
298
- {
299
- "currentMetrics": [
300
- {
301
- "year": "2025",
302
- "group": "2025-01",
303
- "subscriptions": 20,
304
- "mrr": 100000
305
- }
306
- ],
307
- "summary": {
308
- "future_installments": 500000.00,
309
- "total_subscriptions": 150
310
- }
311
- }
312
- ```
313
-
314
- ---
315
-
316
- ### Get Subscription Cohorts
317
-
318
- `GET /fluent-cart/v2/reports/subscription-cohorts`
319
-
320
- Tracks subscriber retention over time across signup cohorts. Requires pre-generated retention snapshots.
321
-
322
- #### Parameters
323
-
324
- | Parameter | Type | Location | Required | Description |
325
- |-----------|------|----------|----------|-------------|
326
- | `params[groupBy]` | string | query | No | Cohort interval: `year` (default max 8 years) or `month` (default max 18 months) |
327
- | `params[metric]` | string | query | No | Metric to track (default: `subscribers`) |
328
- | `params[variation_ids]` | array | query | No | Variation IDs array (converted to product IDs internally) |
329
-
330
- ---
331
-
332
- ### Generate Retention Snapshots
333
-
334
- `POST /fluent-cart/v2/reports/retention-snapshots/generate`
335
-
336
- Triggers snapshot generation. Uses WordPress Action Scheduler for background processing if active; otherwise runs synchronously.
337
-
338
- #### Parameters
339
-
340
- | Parameter | Type | Location | Required | Description |
341
- |-----------|------|----------|----------|-------------|
342
- | `product_id` | integer | body | No | Specific product ID. If omitted, generates for all products |
343
-
344
- #### Response (Background Mode)
345
-
346
- ```json
347
- {
348
- "success": true,
349
- "message": "Snapshot generation queued",
350
- "job_id": 1718456789,
351
- "mode": "background"
352
- }
353
- ```
354
-
355
- ---
356
-
357
- ### Check Retention Snapshot Status
358
-
359
- `GET /fluent-cart/v2/reports/retention-snapshots/status`
360
-
361
- #### Parameters
362
-
363
- | Parameter | Type | Location | Required | Description |
364
- |-----------|------|----------|----------|-------------|
365
- | `params[job_id]` | integer | query | Yes | Unix timestamp `job_id` returned from generation endpoint |
366
-
367
- #### Response
368
-
369
- ```json
370
- {
371
- "success": true,
372
- "status": "completed",
373
- "message": "Job completed",
374
- "stats": {},
375
- "data": {}
376
- }
377
- ```
@@ -1,147 +0,0 @@
1
- # Roles & Permissions API (Pro)
2
-
3
- Manage custom store roles (`super_admin`, `manager`, `worker`, `accountant`), assign capabilities to WordPress users, search eligible users, and inspect role permission matrices in FluentCart Pro.
4
-
5
- **Base URL:** `https://your-site.com/wp-json/fluent-cart/v2/roles`
6
- **Policy:** `AdminPolicy` (Requires WordPress `manage_options` / `is_super_admin` capability)
7
-
8
- ---
9
-
10
- ## Endpoints Overview
11
-
12
- | Method | Endpoint | Description |
13
- |--------|----------|-------------|
14
- | GET | `/roles/managers` | List all WordPress users assigned a FluentCart shop role |
15
- | GET | `/roles/user-list` | Search WordPress users eligible for role assignment (excludes WP admins) |
16
- | GET | `/roles` | List available FluentCart role definitions (titles & descriptions) |
17
- | POST | `/roles` | Assign a shop role to a WordPress user (grants `fluent_cart_admin` capability) |
18
- | GET | `/roles/{key}` | Placeholder: Get role details |
19
- | POST | `/roles/{key}` | Placeholder: Update role definition |
20
- | DELETE | `/roles/{key}` | Remove a shop role assignment from a user (removes `fluent_cart_admin`) |
21
-
22
- ---
23
-
24
- ## 1. List & Search Users
25
-
26
- ### List Managers
27
-
28
- `GET /fluent-cart/v2/roles/managers`
29
-
30
- Retrieve all WordPress users who have been assigned a shop role along with their permissions array.
31
-
32
- #### Response
33
-
34
- ```json
35
- {
36
- "managers": [
37
- {
38
- "id": 5,
39
- "email": "manager@example.com",
40
- "display_name": "Jane Manager",
41
- "username": "janemanager",
42
- "shop_role": "manager",
43
- "description": "With All Permissions Except Sensitive Settings",
44
- "registered_at": "2025-03-10 08:00:00",
45
- "role_permissions": [
46
- "store/settings",
47
- "products/view",
48
- "orders/view",
49
- "orders/manage",
50
- "reports/view"
51
- ]
52
- }
53
- ]
54
- }
55
- ```
56
-
57
- ---
58
-
59
- ### Search Eligible Users
60
-
61
- `GET /fluent-cart/v2/roles/user-list`
62
-
63
- Search for WordPress users who can be assigned a shop role.
64
-
65
- > **Exclusion Rule:** WordPress site Administrators (`manage_options`) are automatically excluded from search results since they already possess full store capabilities.
66
-
67
- #### Parameters
68
-
69
- | Parameter | Type | Location | Required | Description |
70
- |-----------|------|----------|----------|-------------|
71
- | `search` | string | query | No | Partial search by display name or email address |
72
- | `user_ids` | string/array | query | No | Include specific user IDs regardless of search term |
73
-
74
- ---
75
-
76
- ## 2. Role Assignments & Definitions
77
-
78
- ### List Roles
79
-
80
- `GET /fluent-cart/v2/roles`
81
-
82
- Retrieve built-in role titles and descriptions (`super_admin`, `manager`, `worker`, `accountant`).
83
-
84
- ---
85
-
86
- ### Assign Role
87
-
88
- `POST /fluent-cart/v2/roles`
89
-
90
- Assigns a role to a user. The user is granted the `fluent_cart_admin` capability and the role key is stored in user meta.
91
-
92
- #### Parameters
93
-
94
- | Parameter | Type | Required | Description |
95
- |-----------|------|----------|-------------|
96
- | `user_id` | integer | Yes | WordPress user ID |
97
- | `role_key` | string | Yes | Role slug (`super_admin`, `manager`, `worker`, `accountant`) |
98
-
99
- #### Response
100
-
101
- ```json
102
- {
103
- "message": "Role synced successfully",
104
- "is_updated": true
105
- }
106
- ```
107
-
108
- ---
109
-
110
- ### Delete Role Assignment
111
-
112
- `DELETE /fluent-cart/v2/roles/{key}`
113
-
114
- Removes the shop role from the specified user and strips the `fluent_cart_admin` capability.
115
-
116
- #### Parameters
117
-
118
- | Parameter | Type | Required | Description |
119
- |-----------|------|----------|-------------|
120
- | `key` | string | Yes (Path) | Role key being removed |
121
- | `user_id` | integer | Yes (Body/Query) | WordPress user ID |
122
-
123
- ---
124
-
125
- ## 3. Built-In Role Definitions & Capability Matrix
126
-
127
- | Role | Key Permissions Included | Key Restrictions |
128
- |------|--------------------------|------------------|
129
- | **Super Admin** | `store/settings`, `store/sensitive`, `products/*`, `customers/*`, `orders/*`, `subscriptions/*`, `licenses/*`, `coupons/*`, `reports/*`, `integrations/*`, `labels/*`, `dashboard_stats/view` | None (Full Access) |
130
- | **Manager** | All Super Admin permissions except sensitive store settings | Excludes `store/sensitive` |
131
- | **Worker** | View access for products, customers, orders, subscriptions, licenses, integrations; manage order statuses; view & manage coupons | No product/customer editing, no report access |
132
- | **Accountant** | View access for products, customers, orders, subscriptions, licenses, coupons, integrations; view & export orders and reports | Read-only with export rights; no management actions |
133
-
134
- ---
135
-
136
- ## Hooks & Extension Filters
137
-
138
- ```php
139
- // Extend or customize available role definitions
140
- add_filter('fluent_cart/permission/all_roles', function($roles) {
141
- $roles['fulfillment_agent'] = [
142
- 'title' => 'Fulfillment Agent',
143
- 'description' => 'Manage orders and shipping statuses only'
144
- ];
145
- return $roles;
146
- });
147
- ```