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
@@ -0,0 +1,34 @@
1
+ # GET Get Order Mix
2
+
3
+ ## `GET /reports/order-mix`
4
+
5
+ **GET Get Order Mix**
6
+
7
+ Splits the period's orders four ways: sale type, order status, discounted orders, and physical orders by shipping status. Counts and percent shares only; no money fields.
8
+
9
+ Every split adds up to `total`. `share` is a percent of `total`, except `fulfillment.statuses[].share`, which is a percent of `fulfillment.orders` (physical orders only). Orders with no shipping status count as `unshipped`.
10
+
11
+ **Permission:** `reports/view` · **Policy:** `ReportPolicy`
12
+
13
+ - **operationId:** `getOrderMix`
14
+ - **tags:** Reports
15
+
16
+ ### Parameters
17
+
18
+ | Name | In | Required | Type | Description |
19
+ | --- | --- | --- | --- | --- |
20
+ | `params[startDate]` | query | no | string | First day of the range, store timezone (`YYYY-MM-DD`). |
21
+ | `params[endDate]` | query | no | string | Last day of the range, store timezone (`YYYY-MM-DD`). |
22
+ | `params[rangeKey]` | query | no | string | Preset range. Overrides the dates. |
23
+ | `params[currency]` | query | no | string | 3-letter currency code. `__all__` converts every currency to the base currency. Default: base currency. |
24
+ | `params[filterMode]` | query | no | string | Only live or only test orders. Without it, both count. |
25
+ | `params[variation_ids][]` | query | no | array | Only orders that contain these variation IDs. |
26
+ | `params[orderTypes][]` | query | no | array | Only these sale types. `renewal` leaves out installment payments. |
27
+
28
+ ### Responses
29
+
30
+ | Status | Description |
31
+ | --- | --- |
32
+ | `200` | Successful response |
33
+ | `401` | Not authenticated. The request carried no valid WordPress credentials. |
34
+ | `403` | Authenticated, but the user lacks the required capability. |
@@ -0,0 +1,34 @@
1
+ # GET Get Order Value Distribution
2
+
3
+ ## `GET /reports/order-value-distribution`
4
+
5
+ **GET Get Order Value Distribution**
6
+
7
+ Counts the orders in the range by order total, in steps of 100 in the report currency. A bucket key such as `100-200` means a total above 100.00 and up to 200.00 (`total_amount`, cents 10001-20000). Every value is an order count.
8
+
9
+ **Requires FluentCart Pro.** Without Pro this route is not registered and returns 404.
10
+
11
+ **Permission:** `reports/view` · **Policy:** `ReportPolicy`
12
+
13
+ - **operationId:** `getOrderValueDistribution`
14
+ - **tags:** Reports
15
+
16
+ ### Parameters
17
+
18
+ | Name | In | Required | Type | Description |
19
+ | --- | --- | --- | --- | --- |
20
+ | `params[startDate]` | query | no | string | First day of the range (Y-m-d), store timezone. |
21
+ | `params[endDate]` | query | no | string | Last day of the range (Y-m-d), store timezone. |
22
+ | `params[rangeKey]` | query | no | string | Preset range. Overrides the dates. |
23
+ | `params[currency]` | query | no | string | 3-letter currency code, or `__all__` for all currencies converted to the base currency. Default: the base currency. |
24
+ | `params[filterMode]` | query | no | string | Live or test orders only. Default: both. |
25
+ | `params[variation_ids][]` | query | no | array | Only orders that contain one of these variation IDs. |
26
+ | `params[orderTypes][]` | query | no | array | Sale types to include. Default: all. |
27
+
28
+ ### Responses
29
+
30
+ | Status | Description |
31
+ | --- | --- |
32
+ | `200` | Successful response |
33
+ | `401` | Not authenticated. The request carried no valid WordPress credentials. |
34
+ | `403` | Authenticated, but the user lacks the required capability. |
@@ -0,0 +1,38 @@
1
+ # GET Get Payment Method Disputes
2
+
3
+ ## `GET /reports/payment-methods/disputes`
4
+
5
+ **GET Get Payment Method Disputes**
6
+
7
+ Returns disputes per payment gateway, with totals and the previous period's totals. `dispute_amount` is in decimal currency units (not cents). `dispute_rate` is a percent.
8
+
9
+ `disputed_orders` counts orders placed in the range whose charge was disputed (failed orders included). `disputes_lost` and `dispute_amount` count lost-dispute transactions dated in the range. `dispute_rate` = disputed orders / (orders + failed disputed orders) x 100. A saved-card payment counts under the gateway that charged it.
10
+
11
+ **Requires FluentCart Pro.** Without Pro this route is not registered and returns 404.
12
+
13
+ **Permission:** `reports/view` · **Policy:** `ReportPolicy`
14
+
15
+ - **operationId:** `getPaymentMethodsDisputes`
16
+ - **tags:** Reports
17
+
18
+ ### Parameters
19
+
20
+ | Name | In | Required | Type | Description |
21
+ | --- | --- | --- | --- | --- |
22
+ | `params[startDate]` | query | no | string | First day of the range (Y-m-d), store timezone. |
23
+ | `params[endDate]` | query | no | string | Last day of the range (Y-m-d), store timezone. |
24
+ | `params[rangeKey]` | query | no | string | Preset range. Overrides the dates. |
25
+ | `params[currency]` | query | no | string | 3-letter currency code, or `__all__` for all currencies converted to the base currency. Default: the base currency. |
26
+ | `params[filterMode]` | query | no | string | Live or test orders only. Default: both. |
27
+ | `params[variation_ids][]` | query | no | array | Only orders that contain one of these variation IDs. |
28
+ | `params[compareType]` | query | no | string | Comparison period type. |
29
+ | `params[compareDate]` | query | no | string | Comparison start date (Y-m-d). Needed with `compareType`. |
30
+ | `params[orderTypes][]` | query | no | array | Sale types to include. Default: all. |
31
+
32
+ ### Responses
33
+
34
+ | Status | Description |
35
+ | --- | --- |
36
+ | `200` | Successful response |
37
+ | `401` | Not authenticated. The request carried no valid WordPress credentials. |
38
+ | `403` | Authenticated, but the user lacks the required capability. |
@@ -0,0 +1,36 @@
1
+ # GET Get Payment Method Types
2
+
3
+ ## `GET /reports/payment-methods/methods`
4
+
5
+ **GET Get Payment Method Types**
6
+
7
+ Returns net sales by the card brand or payment method type that each order's charge recorded (Visa, PayPal, SEPA Direct Debit, ...). `net_sales` is in decimal currency units (not cents) and uses the Revenue report's net sales.
8
+
9
+ Orders with no recognised brand or method are left out of `rows`. `orders` is the number of orders that had one, and `coverage` is that number as a percent of all report orders in the range. `net_share` is a percent of the net sales in `rows`.
10
+
11
+ **Requires FluentCart Pro.** Without Pro this route is not registered and returns 404.
12
+
13
+ **Permission:** `reports/view` · **Policy:** `ReportPolicy`
14
+
15
+ - **operationId:** `getPaymentMethodsMethods`
16
+ - **tags:** Reports
17
+
18
+ ### Parameters
19
+
20
+ | Name | In | Required | Type | Description |
21
+ | --- | --- | --- | --- | --- |
22
+ | `params[startDate]` | query | no | string | First day of the range (Y-m-d), store timezone. |
23
+ | `params[endDate]` | query | no | string | Last day of the range (Y-m-d), store timezone. |
24
+ | `params[rangeKey]` | query | no | string | Preset range. Overrides the dates. |
25
+ | `params[currency]` | query | no | string | 3-letter currency code, or `__all__` for all currencies converted to the base currency. Default: the base currency. |
26
+ | `params[filterMode]` | query | no | string | Live or test orders only. Default: both. |
27
+ | `params[variation_ids][]` | query | no | array | Only orders that contain one of these variation IDs. |
28
+ | `params[orderTypes][]` | query | no | array | Sale types to include. Default: all. |
29
+
30
+ ### Responses
31
+
32
+ | Status | Description |
33
+ | --- | --- |
34
+ | `200` | Successful response |
35
+ | `401` | Not authenticated. The request carried no valid WordPress credentials. |
36
+ | `403` | Authenticated, but the user lacks the required capability. |
@@ -0,0 +1,37 @@
1
+ # GET Get Payment Methods
2
+
3
+ ## `GET /reports/payment-methods`
4
+
5
+ **GET Get Payment Methods**
6
+
7
+ Returns orders, money, refunds, failures and failing subscriptions per payment gateway, the totals, the previous period's totals and net sales by gateway over time. Amounts are decimal currency units; `net_sales` is the Revenue report's net sales.
8
+
9
+ A saved-card payment counts under the gateway that charged it. Disputes per gateway and sales by card brand are FluentCart Pro reports (`reports/payment-methods/disputes`, `reports/payment-methods/methods`); this endpoint removes the dispute fields from `rows` and `previous`, and keeps only `totals.dispute_rate`. `failing_subscriptions` and `mrr_at_risk` describe open-ended subscriptions failing or past due now, with no date filter. `success_rate` = orders / (orders + recorded failed charges). `previous` is `null` without a comparison.
10
+
11
+ **Permission:** `reports/view` · **Policy:** `ReportPolicy`
12
+
13
+ - **operationId:** `getPaymentMethods`
14
+ - **tags:** Reports
15
+
16
+ ### Parameters
17
+
18
+ | Name | In | Required | Type | Description |
19
+ | --- | --- | --- | --- | --- |
20
+ | `params[startDate]` | query | no | string | First day of the range, store timezone (`YYYY-MM-DD`). |
21
+ | `params[endDate]` | query | no | string | Last day of the range, store timezone (`YYYY-MM-DD`). |
22
+ | `params[rangeKey]` | query | no | string | Preset range. Overrides the dates. |
23
+ | `params[groupKey]` | query | no | string | Chart bucket: `daily`, `monthly`, `yearly`, or `default` (picked from the range length). |
24
+ | `params[currency]` | query | no | string | 3-letter currency code. `__all__` converts every currency to the base currency. Default: base currency. |
25
+ | `params[filterMode]` | query | no | string | Only live or only test orders. Without it, both count. |
26
+ | `params[variation_ids][]` | query | no | array | Only orders that contain these variation IDs. |
27
+ | `params[compareType]` | query | no | string | Comparison period. |
28
+ | `params[compareDate]` | query | no | string | Start of the comparison range when `compareType` is `custom`. |
29
+ | `params[orderTypes][]` | query | no | array | Only these sale types. `renewal` leaves out installment payments. |
30
+
31
+ ### Responses
32
+
33
+ | Status | Description |
34
+ | --- | --- |
35
+ | `200` | Successful response |
36
+ | `401` | Not authenticated. The request carried no valid WordPress credentials. |
37
+ | `403` | Authenticated, but the user lacks the required capability. |
@@ -0,0 +1,33 @@
1
+ # GET Get Product Comparison Since Launch
2
+
3
+ ## `GET /reports/product-comparison-launch`
4
+
5
+ **GET Get Product Comparison Since Launch**
6
+
7
+ For each compared item, returns net sales and units per store month from its launch month. `net` is in cents and uses the Revenue report's net sales. The date range is ignored.
8
+
9
+ The launch month is the first of three months in a row with net sales; a younger item launches with its first month with net sales. Months run to the item's last month with a sale, at most 60. `launched_at` and `months` are empty when the item has no paid sale.
10
+
11
+ **Requires FluentCart Pro.** Without Pro this route is not registered and returns 404.
12
+
13
+ **Permission:** `reports/view` · **Policy:** `ReportPolicy`
14
+
15
+ - **operationId:** `getProductComparisonLaunch`
16
+ - **tags:** Reports
17
+
18
+ ### Parameters
19
+
20
+ | Name | In | Required | Type | Description |
21
+ | --- | --- | --- | --- | --- |
22
+ | `items[]` | query | yes | array | Item keys, top-level: `p:<product_id>` or `v:<variation_id>`. At most 6. |
23
+ | `params[currency]` | query | no | string | 3-letter currency code, or `__all__` for all currencies converted to the base currency. Default: the base currency. |
24
+ | `params[filterMode]` | query | no | string | Live or test orders only. Default: both. |
25
+ | `params[orderTypes][]` | query | no | array | Sale types to include. Default: all. |
26
+
27
+ ### Responses
28
+
29
+ | Status | Description |
30
+ | --- | --- |
31
+ | `200` | Successful response |
32
+ | `401` | Not authenticated. The request carried no valid WordPress credentials. |
33
+ | `403` | Authenticated, but the user lacks the required capability. |
@@ -0,0 +1,40 @@
1
+ # GET Get Product Comparison
2
+
3
+ ## `GET /reports/product-comparison`
4
+
5
+ **GET Get Product Comparison**
6
+
7
+ Compares up to 6 products or variations side by side: a summary, a chart per period, subscriptions and customer overlap. Summary and chart money fields are in cents; subscription `mrr` values are in decimal currency units.
8
+
9
+ Each line takes its share of the order's net sales (the Revenue report's net sales). `new_net` comes from non-renewal orders; `renewal_net` and `installment_net` split renewal orders. A $0 order counts as an order, but `customers` and `new_customers` count paid customers only. `overlap` pairs use item indexes: of `from`'s customers in the range, `both` have ever bought `to`, and `to_first` bought `to` first.
10
+
11
+ **Requires FluentCart Pro.** Without Pro this route is not registered and returns 404.
12
+
13
+ **Permission:** `reports/view` · **Policy:** `ReportPolicy`
14
+
15
+ - **operationId:** `getProductComparison`
16
+ - **tags:** Reports
17
+
18
+ ### Parameters
19
+
20
+ | Name | In | Required | Type | Description |
21
+ | --- | --- | --- | --- | --- |
22
+ | `items[]` | query | yes | array | Item keys, top-level: `p:<product_id>` for a whole product, `v:<variation_id>` for one variation. At most 6; others are dropped. |
23
+ | `params[startDate]` | query | no | string | First day of the range (Y-m-d), store timezone. |
24
+ | `params[endDate]` | query | no | string | Last day of the range (Y-m-d), store timezone. |
25
+ | `params[rangeKey]` | query | no | string | Preset range. Overrides the dates. |
26
+ | `params[currency]` | query | no | string | 3-letter currency code, or `__all__` for all currencies converted to the base currency. Default: the base currency. |
27
+ | `params[filterMode]` | query | no | string | Live or test orders only. Default: both. |
28
+ | `params[variation_ids][]` | query | no | array | Only orders that contain one of these variation IDs. |
29
+ | `params[compareType]` | query | no | string | Comparison period type. |
30
+ | `params[compareDate]` | query | no | string | Comparison start date (Y-m-d). Needed with `compareType`. |
31
+ | `params[groupKey]` | query | no | string | Chart bucket size. Default: picked from the range length. |
32
+ | `params[orderTypes][]` | query | no | array | Sale types to include. Default: all. |
33
+
34
+ ### Responses
35
+
36
+ | Status | Description |
37
+ | --- | --- |
38
+ | `200` | Successful response |
39
+ | `401` | Not authenticated. The request carried no valid WordPress credentials. |
40
+ | `403` | Authenticated, but the user lacks the required capability. |
@@ -0,0 +1,37 @@
1
+ # GET Get Product Detail
2
+
3
+ ## `GET /reports/product-detail`
4
+
5
+ **GET Get Product Detail**
6
+
7
+ Returns the detail of one product: its paid orders in the range, the products bought in the same orders, and its subscriptions. Subscription `mrr` values are in decimal currency units (not cents).
8
+
9
+ Orders count only paid orders (`total_paid` > 0) that are not renewals. `bought_together` lists at most 5 products; `share` is the percent of this product's orders that also hold the other product. `subscriptions` covers every variant of the product: live count and MRR now, and renewals paid and lost in the range. It is `null` when no variant or subscription of the product is found.
10
+
11
+ **Requires FluentCart Pro.** Without Pro this route is not registered and returns 404.
12
+
13
+ **Permission:** `reports/view` · **Policy:** `ReportPolicy`
14
+
15
+ - **operationId:** `getProductDetail`
16
+ - **tags:** Reports
17
+
18
+ ### Parameters
19
+
20
+ | Name | In | Required | Type | Description |
21
+ | --- | --- | --- | --- | --- |
22
+ | `product_id` | query | yes | integer | The product (post) ID. Top-level, not inside `params`. |
23
+ | `params[startDate]` | query | no | string | First day of the range (Y-m-d), store timezone. |
24
+ | `params[endDate]` | query | no | string | Last day of the range (Y-m-d), store timezone. |
25
+ | `params[rangeKey]` | query | no | string | Preset range. Overrides the dates. |
26
+ | `params[currency]` | query | no | string | 3-letter currency code, or `__all__` for all currencies converted to the base currency. Default: the base currency. |
27
+ | `params[filterMode]` | query | no | string | Live or test orders only. Default: both. |
28
+ | `params[orderTypes][]` | query | no | array | Sale types to include. Default: all. |
29
+ | `params[variation_ids][]` | query | no | array | Limit to these variants of the product. Default: all of its variants. |
30
+
31
+ ### Responses
32
+
33
+ | Status | Description |
34
+ | --- | --- |
35
+ | `200` | Successful response |
36
+ | `401` | Not authenticated. The request carried no valid WordPress credentials. |
37
+ | `403` | Authenticated, but the user lacks the required capability. |
@@ -0,0 +1,37 @@
1
+ # GET Get Product Sales
2
+
3
+ ## `GET /reports/product-sales`
4
+
5
+ **GET Get Product Sales**
6
+
7
+ Returns one row per product with its variations, the totals and a chart. Each order's payment, refunds and net sales are shared across its lines by line amount. Amounts are integers in cents; `net` is the Revenue report's net sales.
8
+
9
+ `net` splits into `new_net` (non-renewal orders), `renewal_net` and `installment_net`. `units` leaves out signup-fee and fee lines. A $0 order counts as an order; `customers` and `new_customers` count paid orders only. `refund_rate` is `refunds` / `gross` as a percent. With a comparison, `previous` holds the comparison totals and each product gets `previous_net`; else `previous` and `previous_net` are `null`. Lines with no variation (fees, custom items) count in `summary` only.
10
+
11
+ **Permission:** `reports/view` · **Policy:** `ReportPolicy`
12
+
13
+ - **operationId:** `getProductSales`
14
+ - **tags:** Reports
15
+
16
+ ### Parameters
17
+
18
+ | Name | In | Required | Type | Description |
19
+ | --- | --- | --- | --- | --- |
20
+ | `params[startDate]` | query | no | string | First day of the range, store timezone (`YYYY-MM-DD`). |
21
+ | `params[endDate]` | query | no | string | Last day of the range, store timezone (`YYYY-MM-DD`). |
22
+ | `params[rangeKey]` | query | no | string | Preset range. Overrides the dates. |
23
+ | `params[groupKey]` | query | no | string | Chart bucket: `daily`, `monthly`, `yearly`, or `default` (picked from the range length). |
24
+ | `params[currency]` | query | no | string | 3-letter currency code. `__all__` converts every currency to the base currency. Default: base currency. |
25
+ | `params[filterMode]` | query | no | string | Only live or only test orders. Without it, both count. |
26
+ | `params[variation_ids][]` | query | no | array | Only orders that contain these variation IDs. |
27
+ | `params[compareType]` | query | no | string | Comparison period. |
28
+ | `params[compareDate]` | query | no | string | Start of the comparison range when `compareType` is `custom`. |
29
+ | `params[orderTypes][]` | query | no | array | Only these sale types. `renewal` leaves out installment payments. |
30
+
31
+ ### Responses
32
+
33
+ | Status | Description |
34
+ | --- | --- |
35
+ | `200` | Successful response |
36
+ | `401` | Not authenticated. The request carried no valid WordPress credentials. |
37
+ | `403` | Authenticated, but the user lacks the required capability. |
@@ -0,0 +1,37 @@
1
+ # GET Get Refunds Overview
2
+
3
+ ## `GET /reports/refunds-overview`
4
+
5
+ **GET Get Refunds Overview**
6
+
7
+ Returns the refunds made in the period: totals, full vs partial, a chart, splits by sale type and payment method, reasons and refund rates. Amounts are decimal currency units.
8
+
9
+ Money out counts on the refund date, on orders of any date. Refund rates divide by the orders placed in the period: `refund_rate_cohort` (period orders refunded at all), `refund_rate_orders` (orders refunded in the period / orders placed), `refund_rate_amount` (refunded amount / paid amount). A rate is `null` when no orders were placed. `median_days` counts store calendar days from order to its first refund. `by_product` (the 10 most refunded products, by order date) is a FluentCart Pro report: it appears only when the `fluent_cart/report/refund_products` filter returns true. With a comparison, `fluctuations` gives rates as a point difference and other keys as a percent change (`null` when the previous value is 0).
10
+
11
+ **Permission:** `reports/view` · **Policy:** `ReportPolicy`
12
+
13
+ - **operationId:** `getRefundsOverview`
14
+ - **tags:** Reports
15
+
16
+ ### Parameters
17
+
18
+ | Name | In | Required | Type | Description |
19
+ | --- | --- | --- | --- | --- |
20
+ | `params[startDate]` | query | no | string | First day of the range, store timezone (`YYYY-MM-DD`). |
21
+ | `params[endDate]` | query | no | string | Last day of the range, store timezone (`YYYY-MM-DD`). |
22
+ | `params[rangeKey]` | query | no | string | Preset range. Overrides the dates. |
23
+ | `params[groupKey]` | query | no | string | Chart bucket: `daily`, `monthly`, `yearly`, or `default` (picked from the range length). |
24
+ | `params[currency]` | query | no | string | 3-letter currency code. `__all__` converts every currency to the base currency. Default: base currency. |
25
+ | `params[filterMode]` | query | no | string | Only live or only test orders. Without it, both count. |
26
+ | `params[variation_ids][]` | query | no | array | Only orders that contain these variation IDs. |
27
+ | `params[compareType]` | query | no | string | Comparison period. |
28
+ | `params[compareDate]` | query | no | string | Start of the comparison range when `compareType` is `custom`. |
29
+ | `params[orderTypes][]` | query | no | array | Only these sale types. `renewal` leaves out installment payments. |
30
+
31
+ ### Responses
32
+
33
+ | Status | Description |
34
+ | --- | --- |
35
+ | `200` | Successful response |
36
+ | `401` | Not authenticated. The request carried no valid WordPress credentials. |
37
+ | `403` | Authenticated, but the user lacks the required capability. |
@@ -0,0 +1,45 @@
1
+ # POST Retention Snapshot Step
2
+
3
+ ## `POST /reports/retention-snapshots/step`
4
+
5
+ **POST Retention Snapshot Step**
6
+
7
+ Runs the next step of the build that `POST /reports/retention-snapshots/generate` started. Send the `token` from the generate response. Each step builds one range of customer IDs into a build table and returns `done: false`. The last step publishes the build in place of the old snapshots, releases the lock and returns `done: true` with `message` and `stats` (`total_records`, `unique_cohorts`, `unique_periods`, `unique_products`).
8
+
9
+ Call this endpoint in a loop until `done` is `true` or `success` is `false`. Errors return HTTP 200 with `success: false` and a `code`:
10
+
11
+ - `no_build`: no build is running. Call generate again.
12
+ - `already_running`: the `token` does not match the running build.
13
+ - `failed`: the step threw an error. The build stops and the lock is released. The old snapshots stay.
14
+
15
+ **Permission:** `reports/view` · **Policy:** `ReportPolicy`
16
+
17
+ - **operationId:** `retentionSnapshotStep`
18
+ - **tags:** Reports
19
+
20
+ ### Request body
21
+
22
+ `application/json`
23
+
24
+ ```json
25
+ {
26
+ "type": "object",
27
+ "required": [
28
+ "token"
29
+ ],
30
+ "properties": {
31
+ "token": {
32
+ "type": "string",
33
+ "description": "The `token` from the generate response."
34
+ }
35
+ }
36
+ }
37
+ ```
38
+
39
+ ### Responses
40
+
41
+ | Status | Description |
42
+ | --- | --- |
43
+ | `200` | Successful response |
44
+ | `401` | Not authenticated. The request carried no valid WordPress credentials. |
45
+ | `403` | Authenticated, but the user lacks the required capability. |
@@ -0,0 +1,35 @@
1
+ # GET Get Sales Growth Chart
2
+
3
+ ## `GET /reports/sales-growth-chart`
4
+
5
+ **GET Get Sales Growth Chart**
6
+
7
+ Returns orders and net sales per day, month or year in the range. `net_revenue` is the Revenue report's net sales, as a decimal.
8
+
9
+ Counts orders in the report payment statuses. On-hold and failed orders are left out by default. The range end is clamped to today.
10
+
11
+ **Permission:** `reports/view` · **Policy:** `ReportPolicy`
12
+
13
+ - **operationId:** `getSalesGrowthChart`
14
+ - **tags:** Reports
15
+
16
+ ### Parameters
17
+
18
+ | Name | In | Required | Type | Description |
19
+ | --- | --- | --- | --- | --- |
20
+ | `params[startDate]` | query | no | string | First store day of the range (Y-m-d). |
21
+ | `params[endDate]` | query | no | string | Last store day of the range (Y-m-d). |
22
+ | `params[rangeKey]` | query | no | string | Preset range relative to today. Overrides the dates. |
23
+ | `params[groupKey]` | query | no | string | Chart bucket. `default` picks daily (up to 91 days), monthly (up to 365 days) or yearly. |
24
+ | `params[currency]` | query | no | string | 3-letter currency code. Defaults to the base currency. `__all__` converts every currency to the base currency. |
25
+ | `params[filterMode]` | query | no | string | Count only live or only test orders. Both when omitted. |
26
+ | `params[variation_ids][]` | query | no | array | Product variation IDs to filter by. |
27
+ | `params[orderStatus][]` | query | no | array | Order statuses to leave out. Defaults to `on-hold` and `failed`; `all` also gives that default. |
28
+
29
+ ### Responses
30
+
31
+ | Status | Description |
32
+ | --- | --- |
33
+ | `200` | Successful response |
34
+ | `401` | Not authenticated. The request carried no valid WordPress credentials. |
35
+ | `403` | Authenticated, but the user lacks the required capability. |
@@ -0,0 +1,73 @@
1
+ # POST Save Channel Rules
2
+
3
+ ## `POST /reports/channel-rules`
4
+
5
+ **POST Save Channel Rules**
6
+
7
+ Replaces the store's custom channel rules and own domains, then returns the saved values. Invalid rules, conditions and domains are dropped without an error.
8
+
9
+ Also needs the `store/settings` permission; without it the route returns 403. Limits: 20 rules, 5 groups per rule, 5 conditions per group, 20 domains. A rule needs a name (max 60 characters) and one valid condition. `field` is `source`, `medium`, `campaign` or `domain`; `operator` is `is`, `contains` or `starts_with`; `value` is lower-cased, max 100 characters (a pasted URL keeps only its host, without `www.`). Keep a rule's `id` (a-z, 0-9, max 12) to keep its channel history; a missing or repeated id gets a new one. A rule sent as `{name, conditions: [...]}` is read as one group.
10
+
11
+ **Requires FluentCart Pro.** Without Pro this route is not registered and returns 404.
12
+
13
+ **Permission:** `reports/view` · **Policy:** `ReportPolicy`
14
+
15
+ - **operationId:** `saveChannelRules`
16
+ - **tags:** Reports
17
+
18
+ ### Request body
19
+
20
+ `application/json`
21
+
22
+ ```json
23
+ {
24
+ "type": "object",
25
+ "properties": {
26
+ "rules": {
27
+ "type": "array",
28
+ "items": {
29
+ "type": "object"
30
+ },
31
+ "example": [
32
+ {
33
+ "id": "a1b2c3d4",
34
+ "name": "Partner newsletter",
35
+ "groups": [
36
+ [
37
+ {
38
+ "field": "source",
39
+ "operator": "is",
40
+ "value": "partner"
41
+ },
42
+ {
43
+ "field": "medium",
44
+ "operator": "is",
45
+ "value": "email"
46
+ }
47
+ ]
48
+ ]
49
+ }
50
+ ],
51
+ "description": "Top-level. Rules: `{id?, name, groups: [[{field, operator, value}]]}`."
52
+ },
53
+ "own_domains": {
54
+ "type": "array",
55
+ "items": {
56
+ "type": "string"
57
+ },
58
+ "example": [
59
+ "shop.example.com"
60
+ ],
61
+ "description": "Top-level. The store's own domains, e.g. `shop.example.com`."
62
+ }
63
+ }
64
+ }
65
+ ```
66
+
67
+ ### Responses
68
+
69
+ | Status | Description |
70
+ | --- | --- |
71
+ | `200` | Successful response |
72
+ | `401` | Not authenticated. The request carried no valid WordPress credentials. |
73
+ | `403` | Authenticated, but the user lacks the required capability. |
@@ -0,0 +1,37 @@
1
+ # GET Get Source Channels
2
+
3
+ ## `GET /reports/source-channels`
4
+
5
+ **GET Get Source Channels**
6
+
7
+ Returns the new customers won per marketing channel (email, paid, social, AI, search, referral, campaign, direct) with first-order net, lifetime value, repeat and refund rates, tracking coverage and a chart. Amounts are integers in cents; net figures are the Revenue report's net sales.
8
+
9
+ A new customer is one whose first paid purchase falls in the range. The channel comes from the store's own rules first, then the UTM tags, then the referrer. Custom channel rules come from FluentCart Pro (the `fluent_cart/report/channel_rules` filter); custom channels come first, with their `label`; built-in channels have `label` `null`. Pro's `filter_type` and `advanced_filters` apply here too. `coverage.tracked` is customers not in `direct`. `chart[]` holds new customers per channel key per bucket.
10
+
11
+ **Permission:** `reports/view` · **Policy:** `ReportPolicy`
12
+
13
+ - **operationId:** `getSourceChannels`
14
+ - **tags:** Reports
15
+
16
+ ### Parameters
17
+
18
+ | Name | In | Required | Type | Description |
19
+ | --- | --- | --- | --- | --- |
20
+ | `params[startDate]` | query | no | string | First day of the range, store timezone (`YYYY-MM-DD`). |
21
+ | `params[endDate]` | query | no | string | Last day of the range, store timezone (`YYYY-MM-DD`). |
22
+ | `params[rangeKey]` | query | no | string | Preset range. Overrides the dates. |
23
+ | `params[groupKey]` | query | no | string | Chart bucket: `daily`, `monthly`, `yearly`, or `default` (picked from the range length). |
24
+ | `params[currency]` | query | no | string | 3-letter currency code. `__all__` converts every currency to the base currency. Default: base currency. |
25
+ | `params[filterMode]` | query | no | string | Only live or only test orders. Without it, both count. |
26
+ | `params[variation_ids][]` | query | no | array | Only orders that contain these variation IDs. |
27
+ | `params[orderTypes][]` | query | no | array | Only these sale types. `renewal` leaves out installment payments. |
28
+ | `params[filter_type]` | query | no | string | Pro. Advanced filter mode, passed to the `fluent_cart/report/sources_query` filter. |
29
+ | `params[advanced_filters]` | query | no | string | Pro. Advanced filter conditions (JSON), applied by FluentCart Pro. |
30
+
31
+ ### Responses
32
+
33
+ | Status | Description |
34
+ | --- | --- |
35
+ | `200` | Successful response |
36
+ | `401` | Not authenticated. The request carried no valid WordPress credentials. |
37
+ | `403` | Authenticated, but the user lacks the required capability. |
@@ -0,0 +1,49 @@
1
+ # GET Get Source Report
2
+
3
+ ## `GET /reports/sources`
4
+
5
+ **GET Get Source Report**
6
+
7
+ Returns orders and money grouped by UTM tags, and with FluentCart Pro also by product, variation, period or referrer. Amounts are decimal currency units; `net_sales` is the Revenue report's net sales.
8
+
9
+ Only orders with the grouped source data count (a `utm_source`, or a referrer for `referrer`), unless `include_none` adds a `(none)` row. UTM values group case-insensitively, with `_`, `-` and spaces treated alike. `totals` come from the order set, not from adding rows. `first_order_net` is the net of first orders (one-time or new subscription); `later_net` is the net of their renewals, any date.
10
+
11
+ The groupings `product`, `variation`, `day`, `week`, `month` and `referrer` need FluentCart Pro (the `fluent_cart/report/source_groupings` filter); without it they fall back to `campaign_source_medium`. Pro also applies `filter_type` and `advanced_filters` through the `fluent_cart/report/sources_query` filter.
12
+
13
+ With `page`, one page of rows comes back with `pagination`; a period grouping then also returns every period in `chart`. With a comparison, `fluctuations` is keyed by `utm_key` and holds `previous_<field>` and `<field>_fluctuation` (percent) for `orders`, `gross_sales`, `net_sales`, `average_order`, `average_net_order`; a row new in this period reads `100`.
14
+
15
+ **Permission:** `reports/view` · **Policy:** `ReportPolicy`
16
+
17
+ - **operationId:** `getSourceReport`
18
+ - **tags:** Reports
19
+
20
+ ### Parameters
21
+
22
+ | Name | In | Required | Type | Description |
23
+ | --- | --- | --- | --- | --- |
24
+ | `params[startDate]` | query | no | string | First day of the range, store timezone (`YYYY-MM-DD`). |
25
+ | `params[endDate]` | query | no | string | Last day of the range, store timezone (`YYYY-MM-DD`). |
26
+ | `params[rangeKey]` | query | no | string | Preset range. Overrides the dates. |
27
+ | `params[currency]` | query | no | string | 3-letter currency code. `__all__` converts every currency to the base currency. Default: base currency. |
28
+ | `params[filterMode]` | query | no | string | Only live or only test orders. Without it, both count. |
29
+ | `params[variation_ids][]` | query | no | array | Only orders that contain these variation IDs. |
30
+ | `params[compareType]` | query | no | string | Comparison period. |
31
+ | `params[compareDate]` | query | no | string | Start of the comparison range when `compareType` is `custom`. |
32
+ | `params[orderTypes][]` | query | no | array | Only these sale types. `renewal` leaves out installment payments. |
33
+ | `params[group_by]` | query | no | string | Grouping. Default `campaign_source_medium`. `product`, `variation`, `day`, `week`, `month`, `referrer` need Pro. |
34
+ | `params[include_none]` | query | no | boolean | Add a `(none)` row for orders without source data. |
35
+ | `params[page]` | query | no | integer | Page number. Without it, every row comes back. |
36
+ | `params[per_page]` | query | no | integer | Rows per page, 10 to 150. Default 50. |
37
+ | `params[search]` | query | no | string | Filter rows by label (with `page`). |
38
+ | `params[sort_by]` | query | no | string | Sort field (with `page`). |
39
+ | `params[sort_order]` | query | no | string | `asc` or `desc` (default). |
40
+ | `params[filter_type]` | query | no | string | Pro. Advanced filter mode, passed to the `fluent_cart/report/sources_query` filter. |
41
+ | `params[advanced_filters]` | query | no | string | Pro. Advanced filter conditions (JSON), applied by FluentCart Pro. |
42
+
43
+ ### Responses
44
+
45
+ | Status | Description |
46
+ | --- | --- |
47
+ | `200` | Successful response |
48
+ | `401` | Not authenticated. The request carried no valid WordPress credentials. |
49
+ | `403` | Authenticated, but the user lacks the required capability. |
@@ -0,0 +1,33 @@
1
+ # GET Get Subscription Cohorts
2
+
3
+ ## `GET /reports/subscription-cohorts`
4
+
5
+ **GET Get Subscription Cohorts**
6
+
7
+ Returns subscription cohort retention from the retention snapshots table, by start month or start year. MRR values are decimals.
8
+
9
+ The date range does not apply: month view shows the last 24 months of cohorts, year view every year. One currency only (`__all__` is read as the base currency). `metric=mrr`, `billingInterval` and `rebuyAdjusted` need FluentCart Pro (`fluent_cart/report/cohort_options`); without it the metric is `subscribers` and `full` is false. Build the snapshots with `POST /reports/retention-snapshots/generate`.
10
+
11
+ **Permission:** `reports/view` · **Policy:** `ReportPolicy`
12
+
13
+ - **operationId:** `getSubscriptionCohorts`
14
+ - **tags:** Reports
15
+
16
+ ### Parameters
17
+
18
+ | Name | In | Required | Type | Description |
19
+ | --- | --- | --- | --- | --- |
20
+ | `params[currency]` | query | no | string | 3-letter currency code. Defaults to the base currency. `__all__` is read as the base currency. |
21
+ | `params[variation_ids][]` | query | no | array | Product variation IDs to filter by. |
22
+ | `params[groupBy]` | query | no | string | Cohort size. Default `year`. |
23
+ | `params[metric]` | query | no | string | Metric to show (Pro). Default `subscribers`. |
24
+ | `params[billingInterval]` | query | no | string | Only cohorts of this billing interval (Pro). |
25
+ | `params[rebuyAdjusted]` | query | no | boolean | Count a cancel-and-rebuy as retained (Pro). |
26
+
27
+ ### Responses
28
+
29
+ | Status | Description |
30
+ | --- | --- |
31
+ | `200` | Successful response |
32
+ | `401` | Not authenticated. The request carried no valid WordPress credentials. |
33
+ | `403` | Authenticated, but the user lacks the required capability. |