fluentcart-developer 2.3.4 → 3.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (670) hide show
  1. package/LICENSE.md +26 -26
  2. package/README.md +59 -59
  3. package/dist/cards/fluentcart/templates-native.js +1087 -1087
  4. package/dist/cards/fluentcart/tools.d.ts.map +1 -1
  5. package/dist/cards/fluentcart/tools.js +62 -17
  6. package/dist/cards/fluentcart/tools.js.map +1 -1
  7. package/dist/paths.d.ts +1 -1
  8. package/dist/paths.d.ts.map +1 -1
  9. package/dist/paths.js +1 -1
  10. package/dist/paths.js.map +1 -1
  11. package/dist/reference-reader.d.ts +32 -1
  12. package/dist/reference-reader.d.ts.map +1 -1
  13. package/dist/reference-reader.js +111 -22
  14. package/dist/reference-reader.js.map +1 -1
  15. package/dist/server.d.ts.map +1 -1
  16. package/dist/server.js +8 -1
  17. package/dist/server.js.map +1 -1
  18. package/dist/skills/fluentcart-developer/SKILL.md +108 -580
  19. package/dist/skills/fluentcart-developer/examples/README.md +30 -30
  20. package/dist/skills/fluentcart-developer/examples/fluentcart-starter-child-theme/fluent-cart/checkout.php +32 -32
  21. package/dist/skills/fluentcart-developer/examples/fluentcart-starter-child-theme/functions.php +40 -40
  22. package/dist/skills/fluentcart-developer/examples/sample-custom-addon/fluentcart-custom-addon.php +113 -113
  23. package/dist/skills/fluentcart-developer/examples/sample-custom-payment-gateway/fluentcart-custom-gateway-example.php +148 -148
  24. package/dist/skills/fluentcart-developer/examples/sample-fee-surcharge-plugin/fluentcart-fee-surcharge.php +38 -38
  25. package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/README.md +22 -22
  26. package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/sample-plugin-with-licensing-sdk.php +79 -79
  27. package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/updater/FluentLicensing.php +303 -303
  28. package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/updater/LicenseSettings.php +566 -566
  29. package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/updater/PluginUpdater.php +304 -304
  30. package/dist/skills/fluentcart-developer/examples/sample-shipping-carrier/fluentcart-custom-shipping-carrier.php +61 -61
  31. package/dist/skills/fluentcart-developer/references/api/authentication.md +452 -0
  32. package/dist/skills/fluentcart-developer/references/api/coupons.md +786 -0
  33. package/dist/skills/fluentcart-developer/references/api/customers.md +889 -0
  34. package/dist/skills/fluentcart-developer/references/api/files.md +609 -0
  35. package/dist/skills/fluentcart-developer/references/api/index.md +432 -0
  36. package/dist/skills/fluentcart-developer/references/api/licensing.md +633 -0
  37. package/dist/skills/fluentcart-developer/references/api/order-bump.md +384 -0
  38. package/dist/skills/fluentcart-developer/references/api/orders.md +814 -0
  39. package/dist/skills/fluentcart-developer/references/api/products.md +866 -0
  40. package/dist/skills/fluentcart-developer/references/api/roles-permissions.md +536 -0
  41. package/dist/skills/fluentcart-developer/references/api/subscriptions.md +827 -0
  42. package/dist/skills/fluentcart-developer/references/database/index.md +44 -0
  43. package/dist/skills/fluentcart-developer/references/database/models/activity.md +178 -0
  44. package/dist/skills/fluentcart-developer/references/database/models/applied-coupon.md +291 -0
  45. package/dist/skills/fluentcart-developer/references/database/models/attribute-group.md +239 -0
  46. package/dist/skills/fluentcart-developer/references/database/models/attribute-relation.md +181 -0
  47. package/dist/skills/fluentcart-developer/references/database/models/attribute-term.md +219 -0
  48. package/dist/skills/fluentcart-developer/references/database/models/cart.md +645 -0
  49. package/dist/skills/fluentcart-developer/references/database/models/coupon.md +427 -0
  50. package/dist/skills/fluentcart-developer/references/database/models/customer-addresses.md +348 -0
  51. package/dist/skills/fluentcart-developer/references/database/models/customer-meta.md +156 -0
  52. package/dist/skills/fluentcart-developer/references/database/models/customer.md +584 -0
  53. package/dist/skills/fluentcart-developer/references/database/models/dynamic-model.md +163 -0
  54. package/dist/skills/fluentcart-developer/references/database/models/label-relationship.md +155 -0
  55. package/dist/skills/fluentcart-developer/references/database/models/label.md +153 -0
  56. package/dist/skills/fluentcart-developer/references/database/models/license-activation.md +182 -0
  57. package/dist/skills/fluentcart-developer/references/database/models/license-meta.md +163 -0
  58. package/dist/skills/fluentcart-developer/references/database/models/license-site.md +208 -0
  59. package/dist/skills/fluentcart-developer/references/database/models/license.md +640 -0
  60. package/dist/skills/fluentcart-developer/references/database/models/meta.md +233 -0
  61. package/dist/skills/fluentcart-developer/references/database/models/order-address.md +391 -0
  62. package/dist/skills/fluentcart-developer/references/database/models/order-download-permission.md +144 -0
  63. package/dist/skills/fluentcart-developer/references/database/models/order-item.md +383 -0
  64. package/dist/skills/fluentcart-developer/references/database/models/order-meta.md +303 -0
  65. package/dist/skills/fluentcart-developer/references/database/models/order-operation.md +158 -0
  66. package/dist/skills/fluentcart-developer/references/database/models/order-promotion-stat.md +175 -0
  67. package/dist/skills/fluentcart-developer/references/database/models/order-promotion.md +250 -0
  68. package/dist/skills/fluentcart-developer/references/database/models/order-tax-rate.md +172 -0
  69. package/dist/skills/fluentcart-developer/references/database/models/order-transaction.md +440 -0
  70. package/dist/skills/fluentcart-developer/references/database/models/order.md +727 -0
  71. package/dist/skills/fluentcart-developer/references/database/models/product-detail.md +397 -0
  72. package/dist/skills/fluentcart-developer/references/database/models/product-download.md +258 -0
  73. package/dist/skills/fluentcart-developer/references/database/models/product-meta.md +153 -0
  74. package/dist/skills/fluentcart-developer/references/database/models/product-variation.md +556 -0
  75. package/dist/skills/fluentcart-developer/references/database/models/product.md +580 -0
  76. package/dist/skills/fluentcart-developer/references/database/models/relationships.md +427 -0
  77. package/dist/skills/fluentcart-developer/references/database/models/scheduled-action.md +175 -0
  78. package/dist/skills/fluentcart-developer/references/database/models/shipping-class.md +148 -0
  79. package/dist/skills/fluentcart-developer/references/database/models/shipping-method.md +280 -0
  80. package/dist/skills/fluentcart-developer/references/database/models/shipping-zone.md +205 -0
  81. package/dist/skills/fluentcart-developer/references/database/models/subscription-meta.md +173 -0
  82. package/dist/skills/fluentcart-developer/references/database/models/subscription.md +528 -0
  83. package/dist/skills/fluentcart-developer/references/database/models/tax-class.md +195 -0
  84. package/dist/skills/fluentcart-developer/references/database/models/tax-rate.md +225 -0
  85. package/dist/skills/fluentcart-developer/references/database/models/user-meta.md +166 -0
  86. package/dist/skills/fluentcart-developer/references/database/models/user.md +220 -0
  87. package/dist/skills/fluentcart-developer/references/database/models.md +404 -0
  88. package/dist/skills/fluentcart-developer/references/database/query-builder.md +860 -0
  89. package/dist/skills/fluentcart-developer/references/database/readme.md +276 -0
  90. package/dist/skills/fluentcart-developer/references/database/schema.md +1002 -0
  91. package/dist/skills/fluentcart-developer/references/engineering/adding-custom-pages-to-the-customer-dashboard.md +395 -0
  92. package/dist/skills/fluentcart-developer/references/engineering/index.md +4 -0
  93. package/dist/skills/fluentcart-developer/references/engineering.md +4 -0
  94. package/dist/skills/fluentcart-developer/references/getting-started.md +249 -0
  95. package/dist/skills/fluentcart-developer/references/guides/frontend.md +519 -0
  96. package/dist/skills/fluentcart-developer/references/guides/index.md +107 -0
  97. package/dist/skills/fluentcart-developer/references/guides/integrations.md +600 -0
  98. package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/index.md +237 -0
  99. package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/labels-and-tracking.md +481 -0
  100. package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/live-rates.md +269 -0
  101. package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/reference.md +223 -0
  102. package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/settings.md +370 -0
  103. package/dist/skills/fluentcart-developer/references/guides/shipping-carrier.md +237 -0
  104. package/dist/skills/fluentcart-developer/references/{subscription-customization.md → guides/subscriptions.md} +217 -197
  105. package/dist/skills/fluentcart-developer/references/hooks/actions/admin-and-templates.md +1079 -0
  106. package/dist/skills/fluentcart-developer/references/hooks/actions/cart-and-checkout.md +1795 -0
  107. package/dist/skills/fluentcart-developer/references/hooks/actions/customers-and-users.md +327 -0
  108. package/dist/skills/fluentcart-developer/references/hooks/actions/licenses.md +829 -0
  109. package/dist/skills/fluentcart-developer/references/hooks/actions/modules.md +81 -0
  110. package/dist/skills/fluentcart-developer/references/hooks/actions/orders.md +757 -0
  111. package/dist/skills/fluentcart-developer/references/hooks/actions/payments-and-integrations.md +1163 -0
  112. package/dist/skills/fluentcart-developer/references/hooks/actions/pro-modules.md +219 -0
  113. package/dist/skills/fluentcart-developer/references/hooks/actions/products-and-coupons.md +1019 -0
  114. package/dist/skills/fluentcart-developer/references/hooks/actions/subscriptions.md +1290 -0
  115. package/dist/skills/fluentcart-developer/references/hooks/actions.md +16 -0
  116. package/dist/skills/fluentcart-developer/references/hooks/deprecated.md +60 -0
  117. package/dist/skills/fluentcart-developer/references/hooks/filters/cart-and-checkout.md +2032 -0
  118. package/dist/skills/fluentcart-developer/references/hooks/filters/customers-and-subscriptions.md +1746 -0
  119. package/dist/skills/fluentcart-developer/references/hooks/filters/integrations-and-advanced.md +2439 -0
  120. package/dist/skills/fluentcart-developer/references/hooks/filters/modules.md +464 -0
  121. package/dist/skills/fluentcart-developer/references/hooks/filters/orders-and-payments.md +2658 -0
  122. package/dist/skills/fluentcart-developer/references/hooks/filters/pro-modules.md +502 -0
  123. package/dist/skills/fluentcart-developer/references/hooks/filters/products-and-pricing.md +1785 -0
  124. package/dist/skills/fluentcart-developer/references/hooks/filters/settings-and-configuration.md +2966 -0
  125. package/dist/skills/fluentcart-developer/references/hooks/filters.md +14 -0
  126. package/dist/skills/fluentcart-developer/references/hooks/index.md +35 -0
  127. package/dist/skills/fluentcart-developer/references/index.md +625 -0
  128. package/dist/skills/fluentcart-developer/references/{fee-system-guide.md → modules/fee-system.md} +427 -449
  129. package/dist/skills/fluentcart-developer/references/{ghost-product-selling.md → modules/ghost-product-selling.md} +440 -458
  130. package/dist/skills/fluentcart-developer/references/modules/index.md +484 -0
  131. package/dist/skills/fluentcart-developer/references/modules/licensing.md +342 -0
  132. package/dist/skills/fluentcart-developer/references/modules/order-bump.md +433 -0
  133. package/dist/skills/fluentcart-developer/references/modules/payment-methods.md +129 -0
  134. package/dist/skills/fluentcart-developer/references/modules/refunds.md +170 -0
  135. package/dist/skills/fluentcart-developer/references/modules/shipping.md +846 -0
  136. package/dist/skills/fluentcart-developer/references/modules/storage.md +986 -0
  137. package/dist/skills/fluentcart-developer/references/modules/subscription-vendor-ids.md +186 -0
  138. package/dist/skills/fluentcart-developer/references/modules/subscriptions.md +678 -0
  139. package/dist/skills/fluentcart-developer/references/payment-methods-integration/index.md +164 -0
  140. package/dist/skills/fluentcart-developer/references/payment-methods-integration/paddle-example.md +1648 -0
  141. package/dist/skills/fluentcart-developer/references/payment-methods-integration/payment/setting/fields.md +353 -0
  142. package/dist/skills/fluentcart-developer/references/payment-methods-integration/quick-implementation.md +1079 -0
  143. package/dist/skills/fluentcart-developer/references/payment-methods-integration.md +164 -0
  144. package/dist/skills/fluentcart-developer/references/restapi/checkout.md +573 -0
  145. package/dist/skills/fluentcart-developer/references/restapi/coupons.md +958 -0
  146. package/dist/skills/fluentcart-developer/references/restapi/customer-profile.md +1423 -0
  147. package/dist/skills/fluentcart-developer/references/{rest-api-customers.md → restapi/customers.md} +1103 -1121
  148. package/dist/skills/fluentcart-developer/references/restapi/dashboard.md +1083 -0
  149. package/dist/skills/fluentcart-developer/references/restapi/data-export.md +132 -0
  150. package/dist/skills/fluentcart-developer/references/restapi/email-notifications.md +846 -0
  151. package/dist/skills/fluentcart-developer/references/restapi/files.md +313 -0
  152. package/dist/skills/fluentcart-developer/references/restapi/index.md +127 -0
  153. package/dist/skills/fluentcart-developer/references/restapi/integrations.md +1000 -0
  154. package/dist/skills/fluentcart-developer/references/restapi/inventory.md +192 -0
  155. package/dist/skills/fluentcart-developer/references/restapi/labels-and-attributes.md +797 -0
  156. package/dist/skills/fluentcart-developer/references/restapi/licensing.md +1733 -0
  157. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-available-shipping-methods.md +30 -0
  158. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-checkout-summary.md +28 -0
  159. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-country-info.md +29 -0
  160. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-order-info.md +28 -0
  161. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-shipping-methods-list-view.md +30 -0
  162. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/login.md +66 -0
  163. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/place-order.md +179 -0
  164. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/apply-coupon.md +83 -0
  165. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/cancel-coupon.md +87 -0
  166. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/check-product-eligibility.md +59 -0
  167. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/create-coupon.md +230 -0
  168. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/delete-coupon.md +29 -0
  169. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/get-coupon-settings.md +20 -0
  170. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/get-coupon.md +27 -0
  171. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/list-coupon-codes.md +20 -0
  172. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/list-coupons.md +37 -0
  173. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/re-apply-coupons.md +75 -0
  174. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/store-coupon-settings.md +40 -0
  175. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/update-coupon.md +133 -0
  176. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/create-address-checkout.md +138 -0
  177. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/create-profile-address.md +119 -0
  178. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/dashboard-overview.md +22 -0
  179. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/delete-profile-address.md +46 -0
  180. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-order-details.md +30 -0
  181. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-portal-sections.md +29 -0
  182. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-profile-details.md +22 -0
  183. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-transaction-billing-address.md +30 -0
  184. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-upgrade-paths.md +31 -0
  185. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/list-downloads.md +29 -0
  186. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/list-orders.md +28 -0
  187. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/make-profile-address-primary.md +55 -0
  188. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/pause-subscription.md +29 -0
  189. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/resume-subscription.md +29 -0
  190. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/save-transaction-billing-address.md +92 -0
  191. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/select-address-for-checkout.md +32 -0
  192. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/update-profile-address.md +115 -0
  193. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/update-profile-details.md +69 -0
  194. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/attach-user.md +50 -0
  195. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/bulk-actions.md +65 -0
  196. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/create-address.md +135 -0
  197. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/create-customer.md +108 -0
  198. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/delete-address.md +62 -0
  199. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/detach-user.md +28 -0
  200. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/find-customer-order.md +27 -0
  201. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-attachable-users.md +20 -0
  202. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer-addresses.md +28 -0
  203. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer-orders.md +37 -0
  204. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer-stats.md +27 -0
  205. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer.md +32 -0
  206. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/list-customers.md +37 -0
  207. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/recalculate-ltv.md +28 -0
  208. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/set-primary-address.md +72 -0
  209. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/update-additional-info.md +55 -0
  210. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/update-address.md +144 -0
  211. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/update-customer.md +123 -0
  212. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/attach-note-to-order.md +49 -0
  213. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/create-all-pages.md +21 -0
  214. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/create-single-page.md +55 -0
  215. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/delete-activity.md +28 -0
  216. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-country-info.md +29 -0
  217. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-dashboard-stats.md +22 -0
  218. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-filter-options.md +31 -0
  219. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-onboarding-data.md +20 -0
  220. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-onboarding-settings.md +20 -0
  221. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-print-templates.md +20 -0
  222. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-search-options.md +27 -0
  223. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-widgets.md +28 -0
  224. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/initialize-app.md +20 -0
  225. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/list-activities.md +33 -0
  226. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/list-attachments.md +21 -0
  227. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/list-countries.md +20 -0
  228. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/mark-activity-read.md +53 -0
  229. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/run-data-backfills.md +21 -0
  230. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/save-onboarding-settings.md +54 -0
  231. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/save-onboarding-tax-settings.md +73 -0
  232. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/save-print-templates.md +64 -0
  233. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/upload-attachment.md +42 -0
  234. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-customers-batch.md +129 -0
  235. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-licenses-batch.md +133 -0
  236. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-orders-batch.md +129 -0
  237. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-subscriptions-batch.md +129 -0
  238. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-customers-export-schema.md +21 -0
  239. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-licenses-export-schema.md +26 -0
  240. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-orders-export-schema.md +21 -0
  241. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-subscriptions-export-schema.md +21 -0
  242. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/enable-notification.md +57 -0
  243. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-digest-settings.md +22 -0
  244. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-notification.md +30 -0
  245. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-reminders.md +22 -0
  246. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-settings.md +22 -0
  247. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-shortcodes.md +22 -0
  248. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/list-notifications.md +20 -0
  249. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/preview-default-template.md +66 -0
  250. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/preview-notification.md +50 -0
  251. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/save-digest-settings.md +101 -0
  252. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/save-reminders.md +162 -0
  253. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/save-settings.md +99 -0
  254. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/send-digest-test.md +47 -0
  255. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/send-manual-reminder.md +51 -0
  256. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/update-notification.md +93 -0
  257. package/dist/skills/fluentcart-developer/references/restapi/operations/files/delete-file.md +31 -0
  258. package/dist/skills/fluentcart-developer/references/restapi/operations/files/get-bucket-list.md +28 -0
  259. package/dist/skills/fluentcart-developer/references/restapi/operations/files/list-files.md +30 -0
  260. package/dist/skills/fluentcart-developer/references/restapi/operations/files/upload-editor-file.md +32 -0
  261. package/dist/skills/fluentcart-developer/references/restapi/operations/files/upload-file.md +34 -0
  262. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/chained-data-request.md +46 -0
  263. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/change-feed-status.md +51 -0
  264. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/delete-feed.md +27 -0
  265. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-dynamic-options.md +29 -0
  266. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-feed-lists.md +27 -0
  267. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-feed-settings.md +27 -0
  268. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-global-feeds.md +20 -0
  269. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-global-settings.md +26 -0
  270. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/install-addon-plugin.md +49 -0
  271. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/list-addons.md +20 -0
  272. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/save-feed-settings.md +52 -0
  273. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/set-global-settings.md +50 -0
  274. package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/bulk-update-stock.md +94 -0
  275. package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/export-inventory.md +81 -0
  276. package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/get-adjustment-history.md +26 -0
  277. package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/get-inventory-stats.md +21 -0
  278. package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/list-inventory.md +33 -0
  279. package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/update-stock.md +75 -0
  280. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/create-attribute-group.md +31 -0
  281. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/create-label.md +31 -0
  282. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/create-terms.md +90 -0
  283. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/delete-attribute-group.md +28 -0
  284. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/delete-attribute-term.md +29 -0
  285. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/get-attribute-group.md +28 -0
  286. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/get-attribute-library.md +20 -0
  287. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/list-attribute-groups.md +32 -0
  288. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/list-attribute-terms.md +33 -0
  289. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/list-labels.md +20 -0
  290. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/reorder-groups.md +51 -0
  291. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/reorder-terms.md +56 -0
  292. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/update-attribute-group.md +37 -0
  293. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/update-attribute-term.md +39 -0
  294. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/update-label-selections.md +32 -0
  295. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/activate-plugin-license.md +41 -0
  296. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/activate-site-admin.md +60 -0
  297. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/deactivate-plugin-license.md +18 -0
  298. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/deactivate-site-admin.md +67 -0
  299. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/deactivate-site-customer.md +47 -0
  300. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/delete-license.md +24 -0
  301. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/extend-license-validity.md +47 -0
  302. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-customer-license-details.md +25 -0
  303. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-customer-licenses-admin.md +26 -0
  304. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-license-activations.md +25 -0
  305. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-license-details.md +25 -0
  306. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-license-site.md +30 -0
  307. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-plugin-license-status.md +18 -0
  308. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-product-license-settings.md +24 -0
  309. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/list-customer-licenses.md +25 -0
  310. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/list-license-sites.md +33 -0
  311. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/list-licenses.md +38 -0
  312. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-activate-license.md +54 -0
  313. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-check-license.md +26 -0
  314. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-deactivate-license.md +46 -0
  315. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-download-license-package.md +23 -0
  316. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-get-license-version.md +26 -0
  317. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/regenerate-license-key.md +24 -0
  318. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/save-product-license-settings.md +193 -0
  319. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/update-license-activation-limit.md +53 -0
  320. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/update-license-status.md +52 -0
  321. package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/create-order-bump.md +47 -0
  322. package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/delete-order-bump.md +25 -0
  323. package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/get-order-bump.md +25 -0
  324. package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/list-order-bumps.md +29 -0
  325. package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/update-order-bump.md +141 -0
  326. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/accept-dispute.md +47 -0
  327. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/bulk-actions.md +72 -0
  328. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/calculate-shipping.md +67 -0
  329. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/calculate-tax.md +98 -0
  330. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/change-customer.md +50 -0
  331. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/charge-now.md +29 -0
  332. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-and-change-customer.md +92 -0
  333. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-custom-order-item.md +68 -0
  334. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-order.md +351 -0
  335. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-renewal-now.md +29 -0
  336. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/delete-order.md +28 -0
  337. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/generate-missing-licenses.md +29 -0
  338. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-order-transactions.md +27 -0
  339. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-order.md +27 -0
  340. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-renewal.md +28 -0
  341. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-shipping-methods.md +28 -0
  342. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-single-transaction.md +28 -0
  343. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/list-order-currencies.md +22 -0
  344. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/list-orders.md +42 -0
  345. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/list-renewals.md +28 -0
  346. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/mark-as-paid.md +61 -0
  347. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/price-order.md +135 -0
  348. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/refund-order.md +72 -0
  349. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/resend-renewal-invoice.md +29 -0
  350. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/skip-renewal.md +48 -0
  351. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/sync-order-statuses.md +28 -0
  352. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/sync-pending-transaction.md +29 -0
  353. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-order-address-id.md +60 -0
  354. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-order-address.md +98 -0
  355. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-order.md +172 -0
  356. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-statuses.md +77 -0
  357. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-subscription-details.md +84 -0
  358. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-transaction-status.md +51 -0
  359. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/void-renewal.md +30 -0
  360. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/create-pdf-template.md +42 -0
  361. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/delete-pdf-template.md +26 -0
  362. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/download-pdf-preview.md +44 -0
  363. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-factory-default-templates.md +19 -0
  364. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-pdf-status.md +21 -0
  365. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-pdf-template.md +26 -0
  366. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-saved-templates.md +21 -0
  367. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-seller-details.md +19 -0
  368. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/list-pdf-templates.md +19 -0
  369. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/save-pdf-template.md +53 -0
  370. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/save-seller-details.md +97 -0
  371. package/dist/skills/fluentcart-developer/references/restapi/operations/products/add-product-terms.md +64 -0
  372. package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-edit-fetch.md +30 -0
  373. package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-insert-products.md +62 -0
  374. package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-update-products.md +59 -0
  375. package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-update-variants.md +83 -0
  376. package/dist/skills/fluentcart-developer/references/restapi/operations/products/change-integration-status.md +64 -0
  377. package/dist/skills/fluentcart-developer/references/restapi/operations/products/create-dummy-products.md +45 -0
  378. package/dist/skills/fluentcart-developer/references/restapi/operations/products/create-product.md +81 -0
  379. package/dist/skills/fluentcart-developer/references/restapi/operations/products/create-variation.md +181 -0
  380. package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-downloadable-file.md +27 -0
  381. package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-product-integration.md +30 -0
  382. package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-product.md +27 -0
  383. package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-taxonomy-term.md +55 -0
  384. package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-upgrade-path.md +27 -0
  385. package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-variation.md +27 -0
  386. package/dist/skills/fluentcart-developer/references/restapi/operations/products/do-bulk-action.md +56 -0
  387. package/dist/skills/fluentcart-developer/references/restapi/operations/products/duplicate-product.md +56 -0
  388. package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-products-by-ids.md +26 -0
  389. package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-taxonomy-terms.md +20 -0
  390. package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-terms-by-parent.md +60 -0
  391. package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-variations-by-ids.md +26 -0
  392. package/dist/skills/fluentcart-developer/references/restapi/operations/products/find-subscription-variants.md +26 -0
  393. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-bundle-info.md +27 -0
  394. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-downloadable-url.md +27 -0
  395. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-max-excerpt-word-count.md +20 -0
  396. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-pricing-widgets.md +27 -0
  397. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product-integration-feeds.md +29 -0
  398. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product-integration-settings.md +31 -0
  399. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product-pricing.md +28 -0
  400. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product.md +28 -0
  401. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-related-products.md +31 -0
  402. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-upgrade-settings.md +27 -0
  403. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-variation-upgrade-paths.md +28 -0
  404. package/dist/skills/fluentcart-developer/references/restapi/operations/products/group-bulk-update-variants.md +103 -0
  405. package/dist/skills/fluentcart-developer/references/restapi/operations/products/list-all-variants.md +26 -0
  406. package/dist/skills/fluentcart-developer/references/restapi/operations/products/list-product-variations.md +26 -0
  407. package/dist/skills/fluentcart-developer/references/restapi/operations/products/list-products.md +34 -0
  408. package/dist/skills/fluentcart-developer/references/restapi/operations/products/remove-shipping-class.md +27 -0
  409. package/dist/skills/fluentcart-developer/references/restapi/operations/products/remove-tax-class.md +27 -0
  410. package/dist/skills/fluentcart-developer/references/restapi/operations/products/save-bundle-info.md +56 -0
  411. package/dist/skills/fluentcart-developer/references/restapi/operations/products/save-product-integration.md +62 -0
  412. package/dist/skills/fluentcart-developer/references/restapi/operations/products/save-upgrade-path.md +78 -0
  413. package/dist/skills/fluentcart-developer/references/restapi/operations/products/search-product-variant-options.md +29 -0
  414. package/dist/skills/fluentcart-developer/references/restapi/operations/products/search-products-by-name.md +28 -0
  415. package/dist/skills/fluentcart-developer/references/restapi/operations/products/search-variants-by-name.md +28 -0
  416. package/dist/skills/fluentcart-developer/references/restapi/operations/products/set-variation-media.md +74 -0
  417. package/dist/skills/fluentcart-developer/references/restapi/operations/products/suggest-sku.md +28 -0
  418. package/dist/skills/fluentcart-developer/references/restapi/operations/products/sync-downloadable-files.md +134 -0
  419. package/dist/skills/fluentcart-developer/references/restapi/operations/products/sync-taxonomy-terms.md +61 -0
  420. package/dist/skills/fluentcart-developer/references/restapi/operations/products/toggle-product-tax-exemption.md +56 -0
  421. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-downloadable-file.md +98 -0
  422. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-inventory.md +56 -0
  423. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-long-desc-editor-mode.md +49 -0
  424. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-manage-stock.md +53 -0
  425. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-product-detail.md +58 -0
  426. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-product-pricing.md +225 -0
  427. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-shipping-class.md +49 -0
  428. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-tax-class.md +49 -0
  429. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-upgrade-path.md +78 -0
  430. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variant-option.md +79 -0
  431. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variant-tax-exemption.md +56 -0
  432. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variation-pricing-table.md +49 -0
  433. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variation.md +105 -0
  434. package/dist/skills/fluentcart-developer/references/restapi/operations/public-shop/get-product-views.md +34 -0
  435. package/dist/skills/fluentcart-developer/references/restapi/operations/public-shop/list-products.md +42 -0
  436. package/dist/skills/fluentcart-developer/references/restapi/operations/public-shop/search-products.md +30 -0
  437. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/channel-rules.md +24 -0
  438. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/country-heat-map.md +22 -0
  439. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/coupon-overview.md +37 -0
  440. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/coupons.md +36 -0
  441. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-insights.md +31 -0
  442. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-overview.md +36 -0
  443. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-repeat.md +35 -0
  444. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-segment-customers.md +36 -0
  445. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-segments.md +30 -0
  446. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-value.md +34 -0
  447. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/dashboard-stats.md +30 -0
  448. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/failed-orders.md +34 -0
  449. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-new-vs-returning-customer.md +34 -0
  450. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-report-by-day-and-hour.md +34 -0
  451. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-report-meta.md +29 -0
  452. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-top-sold-products.md +34 -0
  453. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/future-renewals.md +31 -0
  454. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/generate-retention-snapshots.md +24 -0
  455. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-overview.md +30 -0
  456. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-recent-activities.md +26 -0
  457. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-recent-orders.md +20 -0
  458. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-revenue.md +37 -0
  459. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/installments-at-risk.md +35 -0
  460. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/installments-variations.md +33 -0
  461. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/installments.md +33 -0
  462. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/item-count-distribution.md +34 -0
  463. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/license-chart.md +30 -0
  464. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/license-pie-chart.md +22 -0
  465. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/license-summary.md +22 -0
  466. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/locations.md +43 -0
  467. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-chart.md +37 -0
  468. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-completion-time.md +34 -0
  469. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-mix.md +34 -0
  470. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-value-distribution.md +34 -0
  471. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/payment-methods-disputes.md +38 -0
  472. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/payment-methods-methods.md +36 -0
  473. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/payment-methods.md +37 -0
  474. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-comparison-launch.md +33 -0
  475. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-comparison.md +40 -0
  476. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-detail.md +37 -0
  477. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-sales.md +37 -0
  478. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/refunds-overview.md +37 -0
  479. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/retention-snapshots-step.md +45 -0
  480. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/sales-growth-chart.md +35 -0
  481. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/save-channel-rules.md +73 -0
  482. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/source-channels.md +37 -0
  483. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/sources.md +49 -0
  484. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-cohorts.md +33 -0
  485. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-health.md +30 -0
  486. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-rebuys.md +37 -0
  487. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-retention.md +34 -0
  488. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-variations.md +22 -0
  489. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscriptions-overview.md +37 -0
  490. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/weeks-between-refund.md +34 -0
  491. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/assign-role.md +48 -0
  492. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/delete-role-assignment.md +47 -0
  493. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/get-role.md +25 -0
  494. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/list-managers.md +18 -0
  495. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/list-roles.md +18 -0
  496. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/search-users.md +25 -0
  497. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/update-role.md +43 -0
  498. package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/create-saved-view.md +106 -0
  499. package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/delete-saved-view.md +26 -0
  500. package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/list-saved-views.md +25 -0
  501. package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/update-saved-view.md +83 -0
  502. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/activate-payment-addon.md +44 -0
  503. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/activate-plugin-addon.md +44 -0
  504. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/change-storage-driver-status.md +56 -0
  505. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/check-paypal-webhook.md +26 -0
  506. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/create-storage-bucket.md +63 -0
  507. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/disconnect-payment-method.md +55 -0
  508. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/exchange-paypal-seller-auth-token.md +62 -0
  509. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-active-storage-drivers.md +20 -0
  510. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-checkout-fields.md +22 -0
  511. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-email-shortcodes.md +20 -0
  512. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-mcp-config-snippets.md +26 -0
  513. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-mcp-status.md +20 -0
  514. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-module-settings.md +20 -0
  515. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-payment-method-connection-info.md +26 -0
  516. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-payment-method-settings.md +26 -0
  517. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-permissions.md +22 -0
  518. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-plugin-addons.md +20 -0
  519. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-storage-driver-settings.md +27 -0
  520. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-store-settings.md +26 -0
  521. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/install-mcp-adapter.md +21 -0
  522. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/install-payment-addon.md +60 -0
  523. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/install-plugin-addon.md +64 -0
  524. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/list-all-payment-methods.md +20 -0
  525. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/list-all-storage-drivers.md +20 -0
  526. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/list-storage-buckets.md +67 -0
  527. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/reorder-payment-methods.md +55 -0
  528. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/reset-storage-driver-settings.md +45 -0
  529. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-checkout-fields.md +133 -0
  530. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-confirmation-settings.md +68 -0
  531. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-module-settings.md +68 -0
  532. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-payment-method-design.md +67 -0
  533. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-payment-method-settings.md +58 -0
  534. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-permissions.md +68 -0
  535. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-storage-driver-settings.md +62 -0
  536. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-store-settings.md +239 -0
  537. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/setup-paypal-webhook.md +48 -0
  538. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/toggle-mcp.md +40 -0
  539. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/verify-storage-driver-connection.md +62 -0
  540. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/verify-turnstile-keys.md +55 -0
  541. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/create-shipping-class.md +73 -0
  542. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/create-shipping-method.md +110 -0
  543. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/create-shipping-zone.md +56 -0
  544. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/delete-shipping-class.md +29 -0
  545. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/delete-shipping-method.md +29 -0
  546. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/delete-shipping-zone.md +29 -0
  547. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-class-profile.md +30 -0
  548. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-class.md +29 -0
  549. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-packages.md +22 -0
  550. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-zone.md +27 -0
  551. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-zone-countries.md +22 -0
  552. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-zone-states.md +28 -0
  553. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/list-shipping-classes.md +31 -0
  554. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/list-shipping-zones.md +31 -0
  555. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/save-shipping-packages.md +112 -0
  556. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-shipping-class.md +79 -0
  557. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-shipping-method.md +113 -0
  558. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-shipping-zone.md +62 -0
  559. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-zone-order.md +52 -0
  560. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/cancel-auto-renew.md +30 -0
  561. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/cancel-subscription.md +52 -0
  562. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/confirm-subscription-switch.md +70 -0
  563. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/fetch-subscription-remote.md +28 -0
  564. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/generate-early-payment-link.md +29 -0
  565. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-customer-subscription.md +27 -0
  566. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-or-create-plan.md +69 -0
  567. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-setup-intent-attempts.md +30 -0
  568. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-subscription.md +28 -0
  569. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/initiate-early-payment.md +31 -0
  570. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/list-customer-subscriptions.md +27 -0
  571. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/list-subscriptions.md +39 -0
  572. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/pause-subscription.md +28 -0
  573. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/reactivate-subscription.md +28 -0
  574. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/resume-subscription.md +28 -0
  575. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/switch-payment-method.md +70 -0
  576. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/update-payment-method.md +69 -0
  577. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/update-vendor-ids.md +56 -0
  578. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/verify-vendor-ids.md +56 -0
  579. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/create-tax-class.md +51 -0
  580. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/create-tax-rate.md +117 -0
  581. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-product-override.md +27 -0
  582. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-shipping-tax-override.md +27 -0
  583. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-tax-class.md +28 -0
  584. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-tax-rate.md +27 -0
  585. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-country-tax-id.md +27 -0
  586. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-country-tax-rates.md +28 -0
  587. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-eu-vat-product-overrides.md +20 -0
  588. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-oss-country-rates.md +20 -0
  589. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-preconfigured-tax-rates.md +20 -0
  590. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-product-overrides.md +27 -0
  591. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-tax-settings.md +20 -0
  592. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/list-all-tax-rates.md +20 -0
  593. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/list-tax-classes.md +20 -0
  594. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/list-tax-records.md +37 -0
  595. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/mark-taxes-as-filed.md +58 -0
  596. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/reset-eu-vat-rates.md +21 -0
  597. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-configured-countries.md +57 -0
  598. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-country-tax-id.md +50 -0
  599. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-eu-vat-cross-border-settings.md +127 -0
  600. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-oss-country-rates.md +100 -0
  601. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-product-override.md +110 -0
  602. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-shipping-tax-override.md +52 -0
  603. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-tax-settings.md +166 -0
  604. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/update-country-status.md +54 -0
  605. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/update-tax-rate.md +116 -0
  606. package/dist/skills/fluentcart-developer/references/restapi/order-bumps.md +433 -0
  607. package/dist/skills/fluentcart-developer/references/{rest-api-orders.md → restapi/orders.md} +1212 -1462
  608. package/dist/skills/fluentcart-developer/references/restapi/pdf-templates.md +212 -0
  609. package/dist/skills/fluentcart-developer/references/{rest-api-products.md → restapi/products.md} +2485 -2697
  610. package/dist/skills/fluentcart-developer/references/restapi/public-shop.md +191 -0
  611. package/dist/skills/fluentcart-developer/references/restapi/reports.md +3773 -0
  612. package/dist/skills/fluentcart-developer/references/restapi/roles.md +403 -0
  613. package/dist/skills/fluentcart-developer/references/restapi/saved-views.md +136 -0
  614. package/dist/skills/fluentcart-developer/references/restapi/settings.md +1423 -0
  615. package/dist/skills/fluentcart-developer/references/{rest-api-shipping.md → restapi/shipping.md} +905 -800
  616. package/dist/skills/fluentcart-developer/references/restapi/subscriptions.md +1169 -0
  617. package/dist/skills/fluentcart-developer/references/restapi/tax.md +1551 -0
  618. package/dist/skills/fluentcart-developer/references/{rest-api-overview.md → restapi.md} +127 -131
  619. package/dist/skills/fluentcart-developer/scripts/cli.js +1 -1
  620. package/dist/version.d.ts +1 -1
  621. package/dist/version.js +1 -1
  622. package/package.json +66 -65
  623. package/dist/skills/fluentcart-developer/.claude-plugin/plugin.json +0 -12
  624. package/dist/skills/fluentcart-developer/.mcp.json +0 -11
  625. package/dist/skills/fluentcart-developer/references/action-hooks-admin-templates.md +0 -787
  626. package/dist/skills/fluentcart-developer/references/action-hooks-cart-checkout.md +0 -1355
  627. package/dist/skills/fluentcart-developer/references/action-hooks-customers-users.md +0 -266
  628. package/dist/skills/fluentcart-developer/references/action-hooks-licenses.md +0 -855
  629. package/dist/skills/fluentcart-developer/references/action-hooks-orders.md +0 -631
  630. package/dist/skills/fluentcart-developer/references/action-hooks-payments-integrations.md +0 -963
  631. package/dist/skills/fluentcart-developer/references/action-hooks-products-coupons.md +0 -585
  632. package/dist/skills/fluentcart-developer/references/action-hooks-subscriptions.md +0 -661
  633. package/dist/skills/fluentcart-developer/references/customer-dashboard-endpoints.md +0 -169
  634. package/dist/skills/fluentcart-developer/references/database-models-query-builder.md +0 -194
  635. package/dist/skills/fluentcart-developer/references/database-models-reference.md +0 -604
  636. package/dist/skills/fluentcart-developer/references/database-schema-reference.md +0 -947
  637. package/dist/skills/fluentcart-developer/references/engineering-notes.md +0 -154
  638. package/dist/skills/fluentcart-developer/references/filter-hooks-cart-checkout.md +0 -1202
  639. package/dist/skills/fluentcart-developer/references/filter-hooks-customers-subscriptions.md +0 -902
  640. package/dist/skills/fluentcart-developer/references/filter-hooks-integrations-advanced.md +0 -1598
  641. package/dist/skills/fluentcart-developer/references/filter-hooks-orders-payments.md +0 -1319
  642. package/dist/skills/fluentcart-developer/references/filter-hooks-products-pricing.md +0 -628
  643. package/dist/skills/fluentcart-developer/references/filter-hooks-settings-configuration.md +0 -1177
  644. package/dist/skills/fluentcart-developer/references/fluentcart-developer-guide.md +0 -154
  645. package/dist/skills/fluentcart-developer/references/hooks-complete-index.md +0 -834
  646. package/dist/skills/fluentcart-developer/references/models-complete-index.md +0 -912
  647. package/dist/skills/fluentcart-developer/references/modules-and-extensions-reference.md +0 -224
  648. package/dist/skills/fluentcart-developer/references/order-bump-module.md +0 -163
  649. package/dist/skills/fluentcart-developer/references/paddle-gateway-case-study.md +0 -1931
  650. package/dist/skills/fluentcart-developer/references/payment-gateway-integration.md +0 -761
  651. package/dist/skills/fluentcart-developer/references/rest-api-checkout.md +0 -288
  652. package/dist/skills/fluentcart-developer/references/rest-api-coupons.md +0 -801
  653. package/dist/skills/fluentcart-developer/references/rest-api-customer-profile.md +0 -190
  654. package/dist/skills/fluentcart-developer/references/rest-api-dashboard-utilities.md +0 -219
  655. package/dist/skills/fluentcart-developer/references/rest-api-email-notifications.md +0 -619
  656. package/dist/skills/fluentcart-developer/references/rest-api-files.md +0 -290
  657. package/dist/skills/fluentcart-developer/references/rest-api-integrations.md +0 -324
  658. package/dist/skills/fluentcart-developer/references/rest-api-labels-attributes.md +0 -321
  659. package/dist/skills/fluentcart-developer/references/rest-api-licensing.md +0 -174
  660. package/dist/skills/fluentcart-developer/references/rest-api-order-bumps.md +0 -200
  661. package/dist/skills/fluentcart-developer/references/rest-api-public-shop.md +0 -172
  662. package/dist/skills/fluentcart-developer/references/rest-api-reference.md +0 -552
  663. package/dist/skills/fluentcart-developer/references/rest-api-reports.md +0 -377
  664. package/dist/skills/fluentcart-developer/references/rest-api-roles-permissions.md +0 -147
  665. package/dist/skills/fluentcart-developer/references/rest-api-settings.md +0 -528
  666. package/dist/skills/fluentcart-developer/references/rest-api-subscriptions.md +0 -938
  667. package/dist/skills/fluentcart-developer/references/rest-api-tax.md +0 -356
  668. package/dist/skills/fluentcart-developer/references/shipping-module-guide.md +0 -126
  669. package/dist/skills/fluentcart-developer/references/software-licensing-sdk.md +0 -228
  670. package/dist/skills/fluentcart-developer/references/storage-drivers-module.md +0 -140
@@ -1,1121 +1,1103 @@
1
- # Customers API
2
-
3
- Manage customer records including creating customers, managing addresses, associating WordPress users, and viewing customer order history.
4
-
5
- **Base URL:** `https://your-site.com/wp-json/fluent-cart/v2/customers`
6
-
7
- **Policy:** `CustomerPolicy`
8
-
9
- > All monetary values are in cents (e.g., `$10.00` = `1000`).
10
-
11
- ---
12
-
13
- ## Endpoints Overview
14
-
15
- | Method | Endpoint | Description |
16
- |--------|----------|-------------|
17
- | **Customer CRUD** | | |
18
- | GET | `/customers` | List Customers |
19
- | POST | `/customers` | Create Customer |
20
- | GET | `/customers/{customerId}` | Get Customer |
21
- | PUT | `/customers/{customerId}` | Update Customer |
22
- | PUT | `/customers/{customerId}/additional-info` | Update Additional Info (Labels) |
23
- | POST | `/customers/do-bulk-action` | Bulk Actions |
24
- | **Stats & Orders** | | |
25
- | GET | `/customers/get-stats/{customer}` | Get Customer Stats |
26
- | GET | `/customers/{customerId}/orders` | Get Customer Orders |
27
- | GET | `/customers/{customerId}/order` | Find Customer Order |
28
- | POST | `/customers/{customerId}/recalculate-ltv` | Recalculate Lifetime Value |
29
- | **Address Management** | | |
30
- | GET | `/customers/{customerId}/address` | Get Customer Addresses |
31
- | POST | `/customers/{customerId}/address` | Create Address |
32
- | PUT | `/customers/{customerId}/address` | Update Address |
33
- | DELETE | `/customers/{customerId}/address` | Delete Address |
34
- | POST | `/customers/{customerId}/address/make-primary` | Set Primary Address |
35
- | **User Association** | | |
36
- | GET | `/customers/attachable-user` | Get Attachable Users |
37
- | POST | `/customers/{customerId}/attachable-user` | Attach WordPress User |
38
- | POST | `/customers/{customerId}/detach-user` | Detach WordPress User |
39
-
40
- ---
41
-
42
- ## Customer CRUD
43
-
44
- ### List Customers
45
-
46
- `GET /fluent-cart/v2/customers`
47
-
48
- Retrieve a paginated list of customers with support for searching, sorting, and advanced filtering.
49
-
50
- **Permission:** `customers/view`
51
-
52
- #### Parameters
53
-
54
- | Parameter | Type | Location | Required | Description |
55
- |-----------|------|----------|----------|-------------|
56
- | `search` | string | query | No | Search by customer name, email, or ID. Supports operator syntax (e.g., `id=5`, `ltv>1000`). |
57
- | `per_page` | integer | query | No | Number of items per page (1-199, default: 10) |
58
- | `page` | integer | query | No | Page number for pagination |
59
- | `sort_by` | string | query | No | Column to sort by. Must be a fillable field on the Customer model (default: `id`) |
60
- | `sort_type` | string | query | No | Sort direction: `asc` or `desc` (default: `desc`) |
61
- | `filter_type` | string | query | No | Filter mode: `simple` or `advanced` (default: `simple`) |
62
- | `advanced_filters` | string (JSON) | query | No | JSON-encoded array of advanced filter groups (Pro only). Supports filtering by order items, purchase count, purchase dates, customer name, email, LTV, and labels. |
63
- | `with` | array | query | No | Relationships to eager-load (e.g., `orders`, `labels`, `billing_address`, `shipping_address`) |
64
- | `select` | string/array | query | No | Comma-separated column names or array of columns to select |
65
- | `include_ids` | string/array | query | No | Comma-separated IDs or array of IDs that must be included in results |
66
- | `active_view` | string | query | No | Active tab/view filter |
67
- | `user_tz` | string | query | No | User timezone for date filter conversion |
68
-
69
- #### Response
70
-
71
- ```json
72
- {
73
- "customers": {
74
- "total": 150,
75
- "per_page": 10,
76
- "current_page": 1,
77
- "last_page": 15,
78
- "data": [
79
- {
80
- "id": 1,
81
- "user_id": 5,
82
- "contact_id": null,
83
- "email": "john@example.com",
84
- "first_name": "John",
85
- "last_name": "Doe",
86
- "status": "active",
87
- "purchase_value": { ... },
88
- "purchase_count": 3,
89
- "ltv": 15000,
90
- "first_purchase_date": "2025-01-15 10:30:00",
91
- "last_purchase_date": "2025-06-20 14:00:00",
92
- "aov": 5000,
93
- "notes": "",
94
- "uuid": "a1b2c3d4...",
95
- "country": "US",
96
- "city": "New York",
97
- "state": "NY",
98
- "postcode": "10001",
99
- "created_at": "2025-01-10 08:00:00",
100
- "updated_at": "2025-06-20 14:00:00",
101
- "full_name": "John Doe",
102
- "photo": "https://gravatar.com/avatar/...",
103
- "country_name": "United States",
104
- "formatted_address": { ... },
105
- "user_link": "https://example.com/wp-admin/user-edit.php?user_id=5"
106
- }
107
- ]
108
- }
109
- }
110
- ```
111
-
112
- #### Example
113
-
114
- ```bash
115
- curl -X GET "https://example.com/wp-json/fluent-cart/v2/customers?per_page=20&search=john&sort_by=created_at&sort_type=desc" \
116
- -u "username:app_password"
117
- ```
118
-
119
- ---
120
-
121
- ### Create Customer
122
-
123
- `POST /fluent-cart/v2/customers`
124
-
125
- Create a new customer record. Automatically links to an existing WordPress user if a matching email is found.
126
-
127
- **Permission:** `customers/manage`
128
-
129
- #### Parameters
130
-
131
- | Parameter | Type | Location | Required | Description |
132
- |-----------|------|----------|----------|-------------|
133
- | `email` | string | body | Yes | Customer email address. Must be unique and valid. Max 255 characters. |
134
- | `first_name` | string | body | Conditional | Customer first name. Required when store is not configured for full name mode. Max 255 characters. |
135
- | `last_name` | string | body | No | Customer last name. Max 255 characters. |
136
- | `full_name` | string | body | Conditional | Customer full name. Required when store is configured for full name mode. Max 255 characters. Automatically split into `first_name` and `last_name`. |
137
- | `city` | string | body | No | Customer city |
138
- | `state` | string | body | No | Customer state/province code |
139
- | `postcode` | string | body | No | Customer postal/zip code |
140
- | `country` | string | body | No | Customer country code (e.g., `US`, `GB`) |
141
- | `notes` | string | body | No | Internal notes about the customer |
142
- | `status` | string | body | No | Customer status |
143
- | `user_id` | integer | body | No | WordPress user ID to associate |
144
- | `wp_user` | string | body | No | Set to `yes` to create a new WordPress user account for this customer |
145
- | `aov` | string | body | No | Average order value |
146
- | `user_url` | string | body | No | Customer website URL |
147
-
148
- #### Response
149
-
150
- Success (200):
151
-
152
- ```json
153
- {
154
- "message": "Customer created successfully!",
155
- "data": {
156
- "id": 42,
157
- "user_id": null,
158
- "email": "jane@example.com",
159
- "first_name": "Jane",
160
- "last_name": "Smith",
161
- "status": "active",
162
- "purchase_value": [],
163
- "uuid": "e5f6g7h8...",
164
- "country": "US",
165
- "city": "Boston",
166
- "state": "MA",
167
- "postcode": "02101",
168
- "created_at": "2025-06-20 14:00:00",
169
- "updated_at": "2025-06-20 14:00:00"
170
- }
171
- }
172
- ```
173
-
174
- Error (email already exists):
175
-
176
- ```json
177
- {
178
- "code": 400,
179
- "message": "Customer already exists.",
180
- "data": ""
181
- }
182
- ```
183
-
184
- #### Example
185
-
186
- ```bash
187
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/customers" \
188
- -u "username:app_password" \
189
- -H "Content-Type: application/json" \
190
- -d '{
191
- "first_name": "Jane",
192
- "last_name": "Smith",
193
- "email": "jane@example.com",
194
- "country": "US",
195
- "city": "Boston",
196
- "state": "MA",
197
- "postcode": "02101",
198
- "wp_user": "yes"
199
- }'
200
- ```
201
-
202
- ---
203
-
204
- ### Get Customer
205
-
206
- `GET /fluent-cart/v2/customers/{customerId}`
207
-
208
- Retrieve a single customer by ID with optional eager-loaded relationships.
209
-
210
- **Permission:** `customers/view`
211
-
212
- #### Parameters
213
-
214
- | Parameter | Type | Location | Required | Description |
215
- |-----------|------|----------|----------|-------------|
216
- | `customerId` | integer | path | Yes | The customer ID |
217
- | `with` | array | query | No | Relationships to eager-load (e.g., `orders`, `labels`, `billing_address`, `shipping_address`, `subscriptions`, `wpUser`) |
218
- | `params[customer_only]` | string | query | No | Set to `yes` to return the customer without labels processing |
219
-
220
- #### Response
221
-
222
- ```json
223
- {
224
- "customer": {
225
- "id": 1,
226
- "user_id": 5,
227
- "contact_id": null,
228
- "email": "john@example.com",
229
- "first_name": "John",
230
- "last_name": "Doe",
231
- "status": "active",
232
- "purchase_value": { ... },
233
- "purchase_count": 3,
234
- "ltv": 15000,
235
- "first_purchase_date": "2025-01-15 10:30:00",
236
- "last_purchase_date": "2025-06-20 14:00:00",
237
- "aov": 5000,
238
- "notes": "",
239
- "uuid": "a1b2c3d4...",
240
- "country": "US",
241
- "city": "New York",
242
- "state": "NY",
243
- "postcode": "10001",
244
- "created_at": "2025-01-10 08:00:00",
245
- "updated_at": "2025-06-20 14:00:00",
246
- "full_name": "John Doe",
247
- "photo": "https://gravatar.com/avatar/...",
248
- "country_name": "United States",
249
- "formatted_address": {
250
- "country": "United States",
251
- "state": "New York",
252
- "city": "New York",
253
- "postcode": "10001",
254
- "first_name": "John",
255
- "last_name": "Doe",
256
- "full_name": "John Doe"
257
- },
258
- "user_link": "https://example.com/wp-admin/user-edit.php?user_id=5",
259
- "selected_labels": [1, 3, 7],
260
- "labels": [ ... ]
261
- }
262
- }
263
- ```
264
-
265
- Error (404):
266
-
267
- ```json
268
- {
269
- "message": "Customer not found",
270
- "back_text": "Back to Customer List",
271
- "back_url": "/customers"
272
- }
273
- ```
274
-
275
- #### Example
276
-
277
- ```bash
278
- curl -X GET "https://example.com/wp-json/fluent-cart/v2/customers/1?with[]=labels&with[]=billing_address" \
279
- -u "username:app_password"
280
- ```
281
-
282
- ---
283
-
284
- ### Update Customer
285
-
286
- `PUT /fluent-cart/v2/customers/{customerId}`
287
-
288
- Update an existing customer. If the customer is linked to a WordPress user, the corresponding WP user profile is also updated.
289
-
290
- **Permission:** `customers/manage`
291
-
292
- #### Parameters
293
-
294
- | Parameter | Type | Location | Required | Description |
295
- |-----------|------|----------|----------|-------------|
296
- | `customerId` | integer | path | Yes | The customer ID |
297
- | `email` | string | body | Yes | Customer email address. Must be unique (excluding current customer). Max 255 characters. |
298
- | `first_name` | string | body | Conditional | Customer first name. Required when store is not configured for full name mode. Max 255 characters. |
299
- | `last_name` | string | body | No | Customer last name. Max 255 characters. |
300
- | `full_name` | string | body | Conditional | Customer full name. Required when store is configured for full name mode. Max 255 characters. |
301
- | `city` | string | body | No | Customer city |
302
- | `state` | string | body | No | Customer state/province code |
303
- | `postcode` | string | body | No | Customer postal/zip code |
304
- | `country` | string | body | No | Customer country code |
305
- | `notes` | string | body | No | Internal notes about the customer |
306
- | `status` | string | body | No | Customer status |
307
- | `user_id` | integer | body | No | WordPress user ID |
308
- | `aov` | string | body | No | Average order value |
309
- | `user_url` | string | body | No | Customer website URL |
310
- | `username` | string | body | No | Username |
311
- | `user_nicename` | string | body | No | User nicename |
312
- | `display_name` | string | body | No | Display name |
313
-
314
- #### Response
315
-
316
- Success (200):
317
-
318
- ```json
319
- {
320
- "message": "Customer updated successfully!",
321
- "data": {
322
- "id": 1,
323
- "user_id": 5,
324
- "email": "john@example.com",
325
- "first_name": "John",
326
- "last_name": "Doe",
327
- "status": "active"
328
- }
329
- }
330
- ```
331
-
332
- #### Example
333
-
334
- ```bash
335
- curl -X PUT "https://example.com/wp-json/fluent-cart/v2/customers/1" \
336
- -u "username:app_password" \
337
- -H "Content-Type: application/json" \
338
- -d '{
339
- "first_name": "John",
340
- "last_name": "Doe",
341
- "email": "john@example.com",
342
- "city": "San Francisco",
343
- "state": "CA",
344
- "country": "US"
345
- }'
346
- ```
347
-
348
- ---
349
-
350
- ### Update Additional Info (Labels)
351
-
352
- `PUT /fluent-cart/v2/customers/{customerId}/additional-info`
353
-
354
- Update a customer's labels/tags. Manages the label relationships for a customer by syncing provided label IDs with existing ones.
355
-
356
- **Permission:** `customers/manage`
357
-
358
- #### Parameters
359
-
360
- | Parameter | Type | Location | Required | Description |
361
- |-----------|------|----------|----------|-------------|
362
- | `customerId` | integer | path | Yes | The customer ID |
363
- | `labels` | array | body | Yes | Array of label IDs to assign to the customer. Existing labels not in this array will be removed. |
364
-
365
- #### Response
366
-
367
- Success (200):
368
-
369
- ```json
370
- {
371
- "message": "Customer updated successfully!",
372
- "data": { ... }
373
- }
374
- ```
375
-
376
- #### Example
377
-
378
- ```bash
379
- curl -X PUT "https://example.com/wp-json/fluent-cart/v2/customers/1/additional-info" \
380
- -u "username:app_password" \
381
- -H "Content-Type: application/json" \
382
- -d '{
383
- "labels": [1, 3, 7]
384
- }'
385
- ```
386
-
387
- ---
388
-
389
- ### Bulk Actions
390
-
391
- `POST /fluent-cart/v2/customers/do-bulk-action`
392
-
393
- Perform bulk operations on multiple customers such as deletion or status change.
394
-
395
- **Permission:** `customers/manage`
396
-
397
- #### Parameters
398
-
399
- | Parameter | Type | Location | Required | Description |
400
- |-----------|------|----------|----------|-------------|
401
- | `action` | string | body | Yes | The action to perform. Supported values: `delete_customers`, `change_customer_status` |
402
- | `customer_ids` | array | body | Yes | Array of customer IDs to act upon |
403
- | `new_status` | string | body | Conditional | Required when action is `change_customer_status`. The new status to apply to the selected customers. Must be a valid editable customer status. |
404
-
405
- #### Response
406
-
407
- Success (`delete_customers`):
408
-
409
- ```json
410
- {
411
- "message": "Selected Customers has been deleted permanently",
412
- "data": ""
413
- }
414
- ```
415
-
416
- Success (`change_customer_status`):
417
-
418
- ```json
419
- {
420
- "message": "Customer Status has been changed",
421
- "data": ""
422
- }
423
- ```
424
-
425
- Error (missing selection):
426
-
427
- ```json
428
- {
429
- "code": 403,
430
- "message": "Customers selection is required",
431
- "data": ""
432
- }
433
- ```
434
-
435
- #### Example
436
-
437
- ```bash
438
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/customers/do-bulk-action" \
439
- -u "username:app_password" \
440
- -H "Content-Type: application/json" \
441
- -d '{
442
- "action": "change_customer_status",
443
- "customer_ids": [1, 2, 3],
444
- "new_status": "archived"
445
- }'
446
- ```
447
-
448
- ---
449
-
450
- ## Customer Stats & Orders
451
-
452
- ### Get Customer Stats
453
-
454
- `GET /fluent-cart/v2/customers/get-stats/{customer}`
455
-
456
- Retrieve widget/stats data for a specific customer. Results are extensible via the `fluent_cart/widgets/single_customer` filter.
457
-
458
- **Permission:** `customers/view`
459
-
460
- #### Parameters
461
-
462
- | Parameter | Type | Location | Required | Description |
463
- |-----------|------|----------|----------|-------------|
464
- | `customer` | integer | path | Yes | The customer ID |
465
-
466
- #### Response
467
-
468
- ```json
469
- {
470
- "widgets": []
471
- }
472
- ```
473
-
474
- The `widgets` array is populated by modules and extensions that hook into the `fluent_cart/widgets/single_customer` filter.
475
-
476
- #### Example
477
-
478
- ```bash
479
- curl -X GET "https://example.com/wp-json/fluent-cart/v2/customers/get-stats/1" \
480
- -u "username:app_password"
481
- ```
482
-
483
- ---
484
-
485
- ### Get Customer Orders
486
-
487
- `GET /fluent-cart/v2/customers/{customerId}/orders`
488
-
489
- Retrieve a paginated list of orders belonging to a specific customer. Supports the same filtering and sorting parameters as the main Orders list.
490
-
491
- **Permission:** `customers/view`
492
-
493
- #### Parameters
494
-
495
- | Parameter | Type | Location | Required | Description |
496
- |-----------|------|----------|----------|-------------|
497
- | `customerId` | integer | path | Yes | The customer ID |
498
- | `search` | string | query | No | Search orders by invoice number, customer name/email, or order item title |
499
- | `per_page` | integer | query | No | Number of items per page (1-199, default: 10) |
500
- | `page` | integer | query | No | Page number for pagination |
501
- | `sort_by` | string | query | No | Column to sort by (default: `id`) |
502
- | `sort_type` | string | query | No | Sort direction: `asc` or `desc` (default: `desc`) |
503
- | `filter_type` | string | query | No | Filter mode: `simple` or `advanced` (default: `simple`) |
504
- | `advanced_filters` | string (JSON) | query | No | JSON-encoded array of advanced filter groups |
505
- | `active_view` | string | query | No | Active tab filter (e.g., `on-hold`, `paid`, `completed`, `processing`) |
506
-
507
- #### Response
508
-
509
- ```json
510
- {
511
- "orders": {
512
- "total": 5,
513
- "per_page": 10,
514
- "current_page": 1,
515
- "last_page": 1,
516
- "data": [
517
- {
518
- "id": 101,
519
- "invoice_no": "FCT-0101",
520
- "customer_id": 1,
521
- "status": "completed",
522
- "payment_status": "paid",
523
- "total_amount": 5000
524
- }
525
- ]
526
- }
527
- }
528
- ```
529
-
530
- #### Example
531
-
532
- ```bash
533
- curl -X GET "https://example.com/wp-json/fluent-cart/v2/customers/1/orders?per_page=10&sort_by=created_at&sort_type=desc" \
534
- -u "username:app_password"
535
- ```
536
-
537
- ---
538
-
539
- ### Find Customer Order
540
-
541
- `GET /fluent-cart/v2/customers/{customerId}/order`
542
-
543
- Retrieve all orders for a customer with their filtered order items (line items) eager-loaded.
544
-
545
- **Permission:** `customers/view`
546
-
547
- #### Parameters
548
-
549
- | Parameter | Type | Location | Required | Description |
550
- |-----------|------|----------|----------|-------------|
551
- | `customerId` | integer | path | Yes | The customer ID |
552
-
553
- #### Response
554
-
555
- ```json
556
- {
557
- "data": {
558
- "data": [
559
- {
560
- "id": 101,
561
- "customer_id": 1,
562
- "invoice_no": "FCT-0101",
563
- "total_amount": 5000,
564
- "filtered_order_items": [
565
- {
566
- "id": 1,
567
- "order_id": 101,
568
- "title": "Product Name",
569
- "quantity": 2,
570
- "unit_price": 2500
571
- }
572
- ]
573
- }
574
- ]
575
- }
576
- }
577
- ```
578
-
579
- #### Example
580
-
581
- ```bash
582
- curl -X GET "https://example.com/wp-json/fluent-cart/v2/customers/1/order" \
583
- -u "username:app_password"
584
- ```
585
-
586
- ---
587
-
588
- ### Recalculate Lifetime Value
589
-
590
- `POST /fluent-cart/v2/customers/{customerId}/recalculate-ltv`
591
-
592
- Recalculate a customer's lifetime value (LTV) by summing net payments from all successful orders. Also updates `purchase_count`, `first_purchase_date`, `last_purchase_date`, and `aov` (average order value).
593
-
594
- **Permission:** `customers/manage`
595
-
596
- #### Parameters
597
-
598
- | Parameter | Type | Location | Required | Description |
599
- |-----------|------|----------|----------|-------------|
600
- | `customerId` | integer | path | Yes | The customer ID |
601
-
602
- #### Response
603
-
604
- Success (200):
605
-
606
- ```json
607
- {
608
- "message": "Lifetime value recalculated successfully",
609
- "customer": {
610
- "id": 1,
611
- "email": "john@example.com",
612
- "first_name": "John",
613
- "last_name": "Doe",
614
- "purchase_count": 5,
615
- "ltv": 25000,
616
- "aov": 5000,
617
- "first_purchase_date": "2025-01-15 10:30:00",
618
- "last_purchase_date": "2025-06-20 14:00:00"
619
- }
620
- }
621
- ```
622
-
623
- Error (404):
624
-
625
- ```json
626
- {
627
- "message": "Customer not found."
628
- }
629
- ```
630
-
631
- > The LTV calculation sums `total_paid - total_refund` for each order with a successful payment status. Only net-positive amounts are counted.
632
-
633
- #### Example
634
-
635
- ```bash
636
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/customers/1/recalculate-ltv" \
637
- -u "username:app_password"
638
- ```
639
-
640
- ---
641
-
642
- ## Address Management
643
-
644
- ### Get Customer Addresses
645
-
646
- `GET /fluent-cart/v2/customers/{customerId}/address`
647
-
648
- Retrieve addresses for a customer, optionally filtered by address type. Results are sorted with the primary address first.
649
-
650
- **Permission:** `customers/view`
651
-
652
- #### Parameters
653
-
654
- | Parameter | Type | Location | Required | Description |
655
- |-----------|------|----------|----------|-------------|
656
- | `customerId` | integer | path | Yes | The customer ID |
657
- | `type` | string | query | No | Address type filter: `billing` or `shipping` (default: `billing`) |
658
-
659
- #### Response
660
-
661
- ```json
662
- {
663
- "addresses": [
664
- {
665
- "id": 1,
666
- "customer_id": 1,
667
- "is_primary": 1,
668
- "type": "billing",
669
- "status": "active",
670
- "label": "Home",
671
- "name": "John Doe",
672
- "address_1": "123 Main Street",
673
- "address_2": "Apt 4B",
674
- "city": "New York",
675
- "state": "NY",
676
- "postcode": "10001",
677
- "country": "US",
678
- "phone": "+1-555-0100",
679
- "email": "john@example.com",
680
- "meta": { ... },
681
- "created_at": "2025-01-10 08:00:00",
682
- "updated_at": "2025-06-20 14:00:00",
683
- "formatted_address": {
684
- "country": "United States",
685
- "state": "New York",
686
- "city": "New York",
687
- "postcode": "10001",
688
- "address_1": "123 Main Street",
689
- "address_2": "Apt 4B",
690
- "type": "billing",
691
- "name": "John Doe",
692
- "company_name": "Acme Inc",
693
- "label": "Home",
694
- "phone": "+1-555-0100",
695
- "full_address": "Acme Inc, 123 Main Street, Apt 4B, New York, New York, United States"
696
- },
697
- "company_name": "Acme Inc"
698
- }
699
- ]
700
- }
701
- ```
702
-
703
- #### Example
704
-
705
- ```bash
706
- curl -X GET "https://example.com/wp-json/fluent-cart/v2/customers/1/address?type=billing" \
707
- -u "username:app_password"
708
- ```
709
-
710
- ---
711
-
712
- ### Create Address
713
-
714
- `POST /fluent-cart/v2/customers/{customerId}/address`
715
-
716
- Create a new address for a customer. If no primary address exists for the given type, this address is automatically set as primary. Optionally syncs with an associated order address.
717
-
718
- **Permission:** `customers/manage`
719
-
720
- #### Parameters
721
-
722
- | Parameter | Type | Location | Required | Description |
723
- |-----------|------|----------|----------|-------------|
724
- | `customerId` | integer | path | Yes | The customer ID |
725
- | `name` | string | body | Yes | Full name for the address. Max 255 characters. |
726
- | `email` | string | body | Yes | Email for the address. Max 255 characters. |
727
- | `address_1` | string | body | Yes | Primary street address |
728
- | `address_2` | string | body | No | Secondary address line (apartment, suite, etc.) |
729
- | `city` | string | body | Yes | City. Max 255 characters. |
730
- | `state` | string | body | Conditional | State/province code. May be required depending on store localization settings. |
731
- | `postcode` | string | body | Conditional | Postal/zip code. May be required depending on store localization settings. |
732
- | `country` | string | body | Yes | Country code (e.g., `US`, `GB`) |
733
- | `phone` | string | body | No | Phone number |
734
- | `type` | string | body | Yes | Address type: `billing` or `shipping` |
735
- | `label` | string | body | No | Custom label for the address (e.g., `Home`, `Office`). Max 15 characters. |
736
- | `status` | string | body | No | Address status (default: `active`) |
737
- | `is_primary` | integer | body | No | Set to `1` to make this the primary address (default: `0`) |
738
- | `company_name` | string | body | No | Company name. Max 255 characters. |
739
- | `order_id` | integer | body | No | Order ID to sync this address with. When provided with a primary address, the corresponding order address is also created/updated. |
740
-
741
- #### Response
742
-
743
- Success (200):
744
-
745
- ```json
746
- {
747
- "message": "Billing address created successfully!",
748
- "data": {
749
- "id": 5,
750
- "customer_id": 1,
751
- "is_primary": 0,
752
- "type": "billing",
753
- "status": "active",
754
- "label": "Office",
755
- "name": "John Doe",
756
- "address_1": "456 Business Ave",
757
- "address_2": "",
758
- "city": "New York",
759
- "state": "NY",
760
- "postcode": "10002",
761
- "country": "US",
762
- "phone": "+1-555-0200",
763
- "email": "john@example.com"
764
- }
765
- }
766
- ```
767
-
768
- #### Example
769
-
770
- ```bash
771
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/customers/1/address" \
772
- -u "username:app_password" \
773
- -H "Content-Type: application/json" \
774
- -d '{
775
- "name": "John Doe",
776
- "email": "john@example.com",
777
- "address_1": "456 Business Ave",
778
- "city": "New York",
779
- "state": "NY",
780
- "postcode": "10002",
781
- "country": "US",
782
- "phone": "+1-555-0200",
783
- "type": "billing",
784
- "label": "Office",
785
- "company_name": "Acme Inc"
786
- }'
787
- ```
788
-
789
- ---
790
-
791
- ### Update Address
792
-
793
- `PUT /fluent-cart/v2/customers/{customerId}/address`
794
-
795
- Update an existing customer address by its address record ID. Optionally syncs changes to an associated order address.
796
-
797
- **Permission:** `customers/manage`
798
-
799
- #### Parameters
800
-
801
- | Parameter | Type | Location | Required | Description |
802
- |-----------|------|----------|----------|-------------|
803
- | `customerId` | integer | path | Yes | The customer ID |
804
- | `id` | integer | body | Yes | The address record ID to update |
805
- | `name` | string | body | Yes | Full name for the address. Max 255 characters. |
806
- | `email` | string | body | Yes | Email for the address. Max 255 characters. |
807
- | `address_1` | string | body | Yes | Primary street address |
808
- | `address_2` | string | body | No | Secondary address line |
809
- | `city` | string | body | Yes | City. Max 255 characters. |
810
- | `state` | string | body | Conditional | State/province code. May be required depending on store localization settings. |
811
- | `postcode` | string | body | Conditional | Postal/zip code. May be required depending on store localization settings. |
812
- | `country` | string | body | Yes | Country code |
813
- | `phone` | string | body | No | Phone number |
814
- | `type` | string | body | Yes | Address type: `billing` or `shipping` |
815
- | `label` | string | body | No | Custom label. Max 15 characters. |
816
- | `status` | string | body | No | Address status |
817
- | `is_primary` | integer | body | No | Set to `1` for primary address |
818
- | `company_name` | string | body | No | Company name. Max 255 characters. |
819
- | `order_id` | integer | body | No | Order ID to sync address changes with |
820
-
821
- #### Response
822
-
823
- Success (200):
824
-
825
- ```json
826
- {
827
- "message": "Billing address updated successfully!",
828
- "data": {
829
- "id": 5,
830
- "customer_id": 1,
831
- "is_primary": 0,
832
- "type": "billing",
833
- "name": "John Doe",
834
- "address_1": "789 Updated Street"
835
- }
836
- }
837
- ```
838
-
839
- Error (404):
840
-
841
- ```json
842
- {
843
- "code": 404,
844
- "message": "Address not found, please reload the page and try again!",
845
- "data": ""
846
- }
847
- ```
848
-
849
- #### Example
850
-
851
- ```bash
852
- curl -X PUT "https://example.com/wp-json/fluent-cart/v2/customers/1/address" \
853
- -u "username:app_password" \
854
- -H "Content-Type: application/json" \
855
- -d '{
856
- "id": 5,
857
- "name": "John Doe",
858
- "email": "john@example.com",
859
- "address_1": "789 Updated Street",
860
- "city": "New York",
861
- "state": "NY",
862
- "postcode": "10003",
863
- "country": "US",
864
- "type": "billing"
865
- }'
866
- ```
867
-
868
- ---
869
-
870
- ### Delete Address
871
-
872
- `DELETE /fluent-cart/v2/customers/{customerId}/address`
873
-
874
- Delete a customer address. Primary addresses and the last remaining address cannot be deleted.
875
-
876
- **Permission:** `customers/delete`
877
-
878
- #### Parameters
879
-
880
- | Parameter | Type | Location | Required | Description |
881
- |-----------|------|----------|----------|-------------|
882
- | `customerId` | integer | path | Yes | The customer ID |
883
- | `address[id]` | integer | body/query | Yes | The address record ID to delete |
884
-
885
- #### Response
886
-
887
- Success (200):
888
-
889
- ```json
890
- {
891
- "message": "Address successfully deleted.",
892
- "data": ""
893
- }
894
- ```
895
-
896
- Error (primary address):
897
-
898
- ```json
899
- {
900
- "code": 403,
901
- "message": "Primary address cannot be deleted!",
902
- "data": ""
903
- }
904
- ```
905
-
906
- Error (last address):
907
-
908
- ```json
909
- {
910
- "code": 403,
911
- "message": "At least one address must remain. Address deletion failed!",
912
- "data": ""
913
- }
914
- ```
915
-
916
- #### Example
917
-
918
- ```bash
919
- curl -X DELETE "https://example.com/wp-json/fluent-cart/v2/customers/1/address" \
920
- -u "username:app_password" \
921
- -H "Content-Type: application/json" \
922
- -d '{
923
- "address": {
924
- "id": 5
925
- }
926
- }'
927
- ```
928
-
929
- ---
930
-
931
- ### Set Primary Address
932
-
933
- `POST /fluent-cart/v2/customers/{customerId}/address/make-primary`
934
-
935
- Set a specific address as the primary address for its type. The previous primary address of the same type is automatically demoted.
936
-
937
- **Permission:** `customers/manage`
938
-
939
- #### Parameters
940
-
941
- | Parameter | Type | Location | Required | Description |
942
- |-----------|------|----------|----------|-------------|
943
- | `customerId` | integer | path | Yes | The customer ID |
944
- | `addressId` | integer | body | Yes | The address record ID to make primary |
945
- | `type` | string | body | Yes | Address type: `billing` or `shipping` |
946
-
947
- #### Response
948
-
949
- Success (200):
950
-
951
- ```json
952
- {
953
- "message": "Address successfully set as the primary",
954
- "data": ""
955
- }
956
- ```
957
-
958
- Error (400):
959
-
960
- ```json
961
- {
962
- "code": 400,
963
- "message": "Address set as primary failed.",
964
- "data": ""
965
- }
966
- ```
967
-
968
- #### Example
969
-
970
- ```bash
971
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/customers/1/address/make-primary" \
972
- -u "username:app_password" \
973
- -H "Content-Type: application/json" \
974
- -d '{
975
- "addressId": 5,
976
- "type": "billing"
977
- }'
978
- ```
979
-
980
- ---
981
-
982
- ## User Association
983
-
984
- ### Get Attachable Users
985
-
986
- `GET /fluent-cart/v2/customers/attachable-user`
987
-
988
- Retrieve a list of WordPress users that are not yet associated with any FluentCart customer. Useful for linking existing WP users to customer records.
989
-
990
- **Permission:** `customers/manage`
991
-
992
- #### Response
993
-
994
- ```json
995
- {
996
- "users": [
997
- {
998
- "ID": 10,
999
- "display_name": "Alice Johnson",
1000
- "user_email": "alice@example.com"
1001
- },
1002
- {
1003
- "ID": 15,
1004
- "display_name": "Bob Wilson",
1005
- "user_email": "bob@example.com"
1006
- }
1007
- ]
1008
- }
1009
- ```
1010
-
1011
- #### Example
1012
-
1013
- ```bash
1014
- curl -X GET "https://example.com/wp-json/fluent-cart/v2/customers/attachable-user" \
1015
- -u "username:app_password"
1016
- ```
1017
-
1018
- ---
1019
-
1020
- ### Attach WordPress User
1021
-
1022
- `POST /fluent-cart/v2/customers/{customerId}/attachable-user`
1023
-
1024
- Link a WordPress user to an existing customer record. The customer must not already have a linked user, and the target user must not already be linked to another customer.
1025
-
1026
- **Permission:** `customers/manage`
1027
-
1028
- #### Parameters
1029
-
1030
- | Parameter | Type | Location | Required | Description |
1031
- |-----------|------|----------|----------|-------------|
1032
- | `customerId` | integer | path | Yes | The customer ID |
1033
- | `user_id` | integer | body | Yes | The WordPress user ID to attach. Max 50 characters. Must reference an existing user who is not already linked to a customer. |
1034
-
1035
- #### Response
1036
-
1037
- Success (200):
1038
-
1039
- ```json
1040
- {
1041
- "message": "User attached successfully"
1042
- }
1043
- ```
1044
-
1045
- Error (customer already has user):
1046
-
1047
- ```json
1048
- {
1049
- "message": "Can not attach user"
1050
- }
1051
- ```
1052
-
1053
- Error (user already linked):
1054
-
1055
- ```json
1056
- {
1057
- "code": "rest_request_validation",
1058
- "message": "User already linked to a customer."
1059
- }
1060
- ```
1061
-
1062
- Error (user not found):
1063
-
1064
- ```json
1065
- {
1066
- "code": "rest_request_validation",
1067
- "message": "User not found."
1068
- }
1069
- ```
1070
-
1071
- #### Example
1072
-
1073
- ```bash
1074
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/customers/1/attachable-user" \
1075
- -u "username:app_password" \
1076
- -H "Content-Type: application/json" \
1077
- -d '{
1078
- "user_id": 10
1079
- }'
1080
- ```
1081
-
1082
- ---
1083
-
1084
- ### Detach WordPress User
1085
-
1086
- `POST /fluent-cart/v2/customers/{customerId}/detach-user`
1087
-
1088
- Remove the WordPress user association from a customer record. The customer record itself is preserved; only the `user_id` link is cleared.
1089
-
1090
- **Permission:** `customers/manage`
1091
-
1092
- #### Parameters
1093
-
1094
- | Parameter | Type | Location | Required | Description |
1095
- |-----------|------|----------|----------|-------------|
1096
- | `customerId` | integer | path | Yes | The customer ID |
1097
-
1098
- #### Response
1099
-
1100
- Success (200):
1101
-
1102
- ```json
1103
- {
1104
- "message": "User detached successfully"
1105
- }
1106
- ```
1107
-
1108
- Error (customer not found):
1109
-
1110
- ```json
1111
- {
1112
- "message": "Customer not found."
1113
- }
1114
- ```
1115
-
1116
- #### Example
1117
-
1118
- ```bash
1119
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/customers/1/detach-user" \
1120
- -u "username:app_password"
1121
- ```
1
+ # Customers API
2
+
3
+ Manage customer records including creating customers, managing addresses, associating WordPress users, and viewing customer order history.
4
+
5
+ **Base URL:** `https://your-site.com/wp-json/fluent-cart/v2/customers`
6
+
7
+ **Policy:** `CustomerPolicy`
8
+
9
+ > All monetary values are in **cents** (e.g., `$10.00` = `1000`).
10
+
11
+ ---
12
+
13
+ ## Customer CRUD
14
+
15
+ ### List Customers
16
+
17
+ GET `/fluent-cart/v2/customers`
18
+
19
+ Retrieve a paginated list of customers with support for searching, sorting, and advanced filtering.
20
+
21
+ - **Permission:** `customers/view`
22
+
23
+ #### Parameters
24
+
25
+ | Parameter | Type | Location | Required | Description |
26
+ | --- | --- | --- | --- | --- |
27
+ | `search` | string | query | No | Search by customer name, email, or ID. Supports operator syntax (e.g., `id=5`, `ltv>1000`). |
28
+ | `per_page` | integer | query | No | Number of items per page (1-199, default: 10) |
29
+ | `page` | integer | query | No | Page number for pagination |
30
+ | `sort_by` | string | query | No | Column to sort by. Must be a fillable field on the Customer model (default: `id`) |
31
+ | `sort_type` | string | query | No | Sort direction: `asc` or `desc` (default: `desc`) |
32
+ | `filter_type` | string | query | No | Filter mode: `simple` or `advanced` (default: `simple`) |
33
+ | `advanced_filters` | string (JSON) | query | No | JSON-encoded array of advanced filter groups (Pro only). Supports filtering by order items, purchase count, purchase dates, customer name, email, LTV, and labels. |
34
+ | `with` | array | query | No | Relationships to eager-load (e.g., `orders`, `labels`, `billing_address`, `shipping_address`) |
35
+ | `select` | string/array | query | No | Comma-separated column names or array of columns to select |
36
+ | `include_ids` | string/array | query | No | Comma-separated IDs or array of IDs that must be included in results |
37
+ | `active_view` | string | query | No | Active tab/view filter |
38
+ | `user_tz` | string | query | No | User timezone for date filter conversion |
39
+
40
+ #### Response
41
+
42
+ ```
43
+ {
44
+ "customers": {
45
+ "total": 150,
46
+ "per_page": 10,
47
+ "current_page": 1,
48
+ "last_page": 15,
49
+ "data": [
50
+ {
51
+ "id": 1,
52
+ "user_id": 5,
53
+ "contact_id": null,
54
+ "email": "[email protected]",
55
+ "first_name": "John",
56
+ "last_name": "Doe",
57
+ "status": "active",
58
+ "purchase_value": { ... },
59
+ "purchase_count": 3,
60
+ "ltv": 15000,
61
+ "first_purchase_date": "2025-01-15 10:30:00",
62
+ "last_purchase_date": "2025-06-20 14:00:00",
63
+ "aov": 5000,
64
+ "notes": "",
65
+ "uuid": "a1b2c3d4...",
66
+ "country": "US",
67
+ "city": "New York",
68
+ "state": "NY",
69
+ "postcode": "10001",
70
+ "created_at": "2025-01-10 08:00:00",
71
+ "updated_at": "2025-06-20 14:00:00",
72
+ "full_name": "John Doe",
73
+ "photo": "https://gravatar.com/avatar/...",
74
+ "country_name": "United States",
75
+ "formatted_address": { ... },
76
+ "user_link": "https://example.com/wp-admin/user-edit.php?user_id=5"
77
+ }
78
+ ]
79
+ }
80
+ }
81
+ ```
82
+
83
+ #### Example
84
+
85
+ ```
86
+ curl -X GET "https://example.com/wp-json/fluent-cart/v2/customers?per_page=20&search=john&sort_by=created_at&sort_type=desc" \
87
+ -u "username:app_password"
88
+ ```
89
+
90
+ ---
91
+
92
+ ### Create Customer
93
+
94
+ POST `/fluent-cart/v2/customers`
95
+
96
+ Create a new customer record. Automatically links to an existing WordPress user if a matching email is found.
97
+
98
+ - **Permission:** `customers/manage`
99
+
100
+ #### Parameters
101
+
102
+ | Parameter | Type | Location | Required | Description |
103
+ | --- | --- | --- | --- | --- |
104
+ | `email` | string | body | Yes | Customer email address. Must be unique and valid. Max 255 characters. |
105
+ | `first_name` | string | body | Conditional | Customer first name. Required when store is not configured for full name mode. Max 255 characters. |
106
+ | `last_name` | string | body | No | Customer last name. Max 255 characters. |
107
+ | `full_name` | string | body | Conditional | Customer full name. Required when store is configured for full name mode. Max 255 characters. Automatically split into `first_name` and `last_name`. |
108
+ | `city` | string | body | No | Customer city |
109
+ | `state` | string | body | No | Customer state/province code |
110
+ | `postcode` | string | body | No | Customer postal/zip code |
111
+ | `country` | string | body | No | Customer country code (e.g., `US`, `GB`) |
112
+ | `notes` | string | body | No | Internal notes about the customer |
113
+ | `status` | string | body | No | Customer status |
114
+ | `user_id` | integer | body | No | WordPress user ID to associate |
115
+ | `wp_user` | string | body | No | Set to `yes` to create a new WordPress user account for this customer |
116
+ | `aov` | string | body | No | Average order value |
117
+ | `user_url` | string | body | No | Customer website URL |
118
+
119
+ #### Response
120
+
121
+ **Success (200):**
122
+
123
+ ```
124
+ {
125
+ "message": "Customer created successfully!",
126
+ "data": {
127
+ "id": 42,
128
+ "user_id": null,
129
+ "email": "[email protected]",
130
+ "first_name": "Jane",
131
+ "last_name": "Smith",
132
+ "status": "active",
133
+ "purchase_value": [],
134
+ "uuid": "e5f6g7h8...",
135
+ "country": "US",
136
+ "city": "Boston",
137
+ "state": "MA",
138
+ "postcode": "02101",
139
+ "created_at": "2025-06-20 14:00:00",
140
+ "updated_at": "2025-06-20 14:00:00"
141
+ }
142
+ }
143
+ ```
144
+
145
+ **Error (email already exists):**
146
+
147
+ ```
148
+ {
149
+ "code": 400,
150
+ "message": "Customer already exists.",
151
+ "data": ""
152
+ }
153
+ ```
154
+
155
+ #### Example
156
+
157
+ ```
158
+ curl -X POST "https://example.com/wp-json/fluent-cart/v2/customers" \
159
+ -u "username:app_password" \
160
+ -H "Content-Type: application/json" \
161
+ -d '{
162
+ "first_name": "Jane",
163
+ "last_name": "Smith",
164
+ "email": "[email protected]",
165
+ "country": "US",
166
+ "city": "Boston",
167
+ "state": "MA",
168
+ "postcode": "02101",
169
+ "wp_user": "yes"
170
+ }'
171
+ ```
172
+
173
+ ---
174
+
175
+ ### Get Customer
176
+
177
+ GET `/fluent-cart/v2/customers/{customerId}`
178
+
179
+ Retrieve a single customer by ID with optional eager-loaded relationships.
180
+
181
+ - **Permission:** `customers/view`
182
+
183
+ #### Parameters
184
+
185
+ | Parameter | Type | Location | Required | Description |
186
+ | --- | --- | --- | --- | --- |
187
+ | `customerId` | integer | path | Yes | The customer ID |
188
+ | `with` | array | query | No | Relationships to eager-load (e.g., `orders`, `labels`, `billing_address`, `shipping_address`, `subscriptions`, `wpUser`) |
189
+ | `params[customer_only]` | string | query | No | Set to `yes` to return the customer without labels processing |
190
+
191
+ #### Response
192
+
193
+ ```
194
+ {
195
+ "customer": {
196
+ "id": 1,
197
+ "user_id": 5,
198
+ "contact_id": null,
199
+ "email": "[email protected]",
200
+ "first_name": "John",
201
+ "last_name": "Doe",
202
+ "status": "active",
203
+ "purchase_value": { ... },
204
+ "purchase_count": 3,
205
+ "ltv": 15000,
206
+ "first_purchase_date": "2025-01-15 10:30:00",
207
+ "last_purchase_date": "2025-06-20 14:00:00",
208
+ "aov": 5000,
209
+ "notes": "",
210
+ "uuid": "a1b2c3d4...",
211
+ "country": "US",
212
+ "city": "New York",
213
+ "state": "NY",
214
+ "postcode": "10001",
215
+ "created_at": "2025-01-10 08:00:00",
216
+ "updated_at": "2025-06-20 14:00:00",
217
+ "full_name": "John Doe",
218
+ "photo": "https://gravatar.com/avatar/...",
219
+ "country_name": "United States",
220
+ "formatted_address": {
221
+ "country": "United States",
222
+ "state": "New York",
223
+ "city": "New York",
224
+ "postcode": "10001",
225
+ "first_name": "John",
226
+ "last_name": "Doe",
227
+ "full_name": "John Doe"
228
+ },
229
+ "user_link": "https://example.com/wp-admin/user-edit.php?user_id=5",
230
+ "selected_labels": [1, 3, 7],
231
+ "labels": [ ... ]
232
+ }
233
+ }
234
+ ```
235
+
236
+ **Error (404):**
237
+
238
+ ```
239
+ {
240
+ "message": "Customer not found",
241
+ "back_text": "Back to Customer List",
242
+ "back_url": "/customers"
243
+ }
244
+ ```
245
+
246
+ #### Example
247
+
248
+ ```
249
+ curl -X GET "https://example.com/wp-json/fluent-cart/v2/customers/1?with[]=labels&with[]=billing_address" \
250
+ -u "username:app_password"
251
+ ```
252
+
253
+ ---
254
+
255
+ ### Update Customer
256
+
257
+ PUT `/fluent-cart/v2/customers/{customerId}`
258
+
259
+ Update an existing customer. If the customer is linked to a WordPress user, the corresponding WP user profile is also updated.
260
+
261
+ - **Permission:** `customers/manage`
262
+
263
+ #### Parameters
264
+
265
+ | Parameter | Type | Location | Required | Description |
266
+ | --- | --- | --- | --- | --- |
267
+ | `customerId` | integer | path | Yes | The customer ID |
268
+ | `email` | string | body | Yes | Customer email address. Must be unique (excluding current customer). Max 255 characters. |
269
+ | `first_name` | string | body | Conditional | Customer first name. Required when store is not configured for full name mode. Max 255 characters. |
270
+ | `last_name` | string | body | No | Customer last name. Max 255 characters. |
271
+ | `full_name` | string | body | Conditional | Customer full name. Required when store is configured for full name mode. Max 255 characters. |
272
+ | `city` | string | body | No | Customer city |
273
+ | `state` | string | body | No | Customer state/province code |
274
+ | `postcode` | string | body | No | Customer postal/zip code |
275
+ | `country` | string | body | No | Customer country code |
276
+ | `notes` | string | body | No | Internal notes about the customer |
277
+ | `status` | string | body | No | Customer status |
278
+ | `user_id` | integer | body | No | WordPress user ID |
279
+ | `aov` | string | body | No | Average order value |
280
+ | `user_url` | string | body | No | Customer website URL |
281
+ | `username` | string | body | No | Username |
282
+ | `user_nicename` | string | body | No | User nicename |
283
+ | `display_name` | string | body | No | Display name |
284
+
285
+ #### Response
286
+
287
+ **Success (200):**
288
+
289
+ ```
290
+ {
291
+ "message": "Customer updated successfully!",
292
+ "data": {
293
+ "id": 1,
294
+ "user_id": 5,
295
+ "email": "[email protected]",
296
+ "first_name": "John",
297
+ "last_name": "Doe",
298
+ "status": "active",
299
+ "...": "..."
300
+ }
301
+ }
302
+ ```
303
+
304
+ #### Example
305
+
306
+ ```
307
+ curl -X PUT "https://example.com/wp-json/fluent-cart/v2/customers/1" \
308
+ -u "username:app_password" \
309
+ -H "Content-Type: application/json" \
310
+ -d '{
311
+ "first_name": "John",
312
+ "last_name": "Doe",
313
+ "email": "[email protected]",
314
+ "city": "San Francisco",
315
+ "state": "CA",
316
+ "country": "US"
317
+ }'
318
+ ```
319
+
320
+ ---
321
+
322
+ ### Update Additional Info (Labels)
323
+
324
+ PUT `/fluent-cart/v2/customers/{customerId}/additional-info`
325
+
326
+ Update a customer's labels/tags. Manages the label relationships for a customer by syncing provided label IDs with existing ones.
327
+
328
+ - **Permission:** `customers/manage`
329
+
330
+ #### Parameters
331
+
332
+ | Parameter | Type | Location | Required | Description |
333
+ | --- | --- | --- | --- | --- |
334
+ | `customerId` | integer | path | Yes | The customer ID |
335
+ | `labels` | array | body | Yes | Array of label IDs to assign to the customer. Existing labels not in this array will be removed. |
336
+
337
+ #### Response
338
+
339
+ **Success (200):**
340
+
341
+ ```
342
+ {
343
+ "message": "Customer updated successfully!",
344
+ "data": { ... }
345
+ }
346
+ ```
347
+
348
+ #### Example
349
+
350
+ ```
351
+ curl -X PUT "https://example.com/wp-json/fluent-cart/v2/customers/1/additional-info" \
352
+ -u "username:app_password" \
353
+ -H "Content-Type: application/json" \
354
+ -d '{
355
+ "labels": [1, 3, 7]
356
+ }'
357
+ ```
358
+
359
+ ---
360
+
361
+ ### Bulk Actions
362
+
363
+ POST `/fluent-cart/v2/customers/do-bulk-action`
364
+
365
+ Perform bulk operations on multiple customers such as deletion or status change.
366
+
367
+ - **Permission:** `customers/manage`
368
+
369
+ #### Parameters
370
+
371
+ | Parameter | Type | Location | Required | Description |
372
+ | --- | --- | --- | --- | --- |
373
+ | `action` | string | body | Yes | The action to perform. Supported values: `delete_customers`, `change_customer_status` |
374
+ | `customer_ids` | array | body | Yes | Array of customer IDs to act upon |
375
+ | `new_status` | string | body | Conditional | Required when action is `change_customer_status`. The new status to apply to the selected customers. Must be a valid editable customer status. |
376
+
377
+ #### Response
378
+
379
+ **Success (delete_customers):**
380
+
381
+ ```
382
+ {
383
+ "message": "Selected Customers has been deleted permanently",
384
+ "data": ""
385
+ }
386
+ ```
387
+
388
+ **Success (change_customer_status):**
389
+
390
+ ```
391
+ {
392
+ "message": "Customer Status has been changed",
393
+ "data": ""
394
+ }
395
+ ```
396
+
397
+ **Error (missing selection):**
398
+
399
+ ```
400
+ {
401
+ "code": 403,
402
+ "message": "Customers selection is required",
403
+ "data": ""
404
+ }
405
+ ```
406
+
407
+ #### Example
408
+
409
+ ```
410
+ curl -X POST "https://example.com/wp-json/fluent-cart/v2/customers/do-bulk-action" \
411
+ -u "username:app_password" \
412
+ -H "Content-Type: application/json" \
413
+ -d '{
414
+ "action": "change_customer_status",
415
+ "customer_ids": [1, 2, 3],
416
+ "new_status": "archived"
417
+ }'
418
+ ```
419
+
420
+ ---
421
+
422
+ ## Customer Stats & Orders
423
+
424
+ ### Get Customer Stats
425
+
426
+ GET `/fluent-cart/v2/customers/get-stats/{customer}`
427
+
428
+ Retrieve widget/stats data for a specific customer. Results are extensible via the `fluent_cart/widgets/single_customer` filter.
429
+
430
+ - **Permission:** `customers/view`
431
+
432
+ #### Parameters
433
+
434
+ | Parameter | Type | Location | Required | Description |
435
+ | --- | --- | --- | --- | --- |
436
+ | `customer` | integer | path | Yes | The customer ID |
437
+
438
+ #### Response
439
+
440
+ ```
441
+ {
442
+ "widgets": []
443
+ }
444
+ ```
445
+
446
+ > The `widgets` array is populated by modules and extensions that hook into the `fluent_cart/widgets/single_customer` filter.
447
+
448
+ #### Example
449
+
450
+ ```
451
+ curl -X GET "https://example.com/wp-json/fluent-cart/v2/customers/get-stats/1" \
452
+ -u "username:app_password"
453
+ ```
454
+
455
+ ---
456
+
457
+ ### Get Customer Orders
458
+
459
+ GET `/fluent-cart/v2/customers/{customerId}/orders`
460
+
461
+ Retrieve a paginated list of orders belonging to a specific customer. Supports the same filtering and sorting parameters as the main Orders list.
462
+
463
+ - **Permission:** `customers/view`
464
+
465
+ #### Parameters
466
+
467
+ | Parameter | Type | Location | Required | Description |
468
+ | --- | --- | --- | --- | --- |
469
+ | `customerId` | integer | path | Yes | The customer ID |
470
+ | `search` | string | query | No | Search orders by invoice number, customer name/email, or order item title |
471
+ | `per_page` | integer | query | No | Number of items per page (1-199, default: 10) |
472
+ | `page` | integer | query | No | Page number for pagination |
473
+ | `sort_by` | string | query | No | Column to sort by (default: `id`) |
474
+ | `sort_type` | string | query | No | Sort direction: `asc` or `desc` (default: `desc`) |
475
+ | `filter_type` | string | query | No | Filter mode: `simple` or `advanced` (default: `simple`) |
476
+ | `advanced_filters` | string (JSON) | query | No | JSON-encoded array of advanced filter groups |
477
+ | `active_view` | string | query | No | Active tab filter (e.g., `on-hold`, `paid`, `completed`, `processing`) |
478
+
479
+ #### Response
480
+
481
+ ```
482
+ {
483
+ "orders": {
484
+ "total": 5,
485
+ "per_page": 10,
486
+ "current_page": 1,
487
+ "last_page": 1,
488
+ "data": [
489
+ {
490
+ "id": 101,
491
+ "invoice_no": "FCT-0101",
492
+ "customer_id": 1,
493
+ "status": "completed",
494
+ "payment_status": "paid",
495
+ "total_amount": 5000,
496
+ "...": "..."
497
+ }
498
+ ]
499
+ }
500
+ }
501
+ ```
502
+
503
+ #### Example
504
+
505
+ ```
506
+ curl -X GET "https://example.com/wp-json/fluent-cart/v2/customers/1/orders?per_page=10&sort_by=created_at&sort_type=desc" \
507
+ -u "username:app_password"
508
+ ```
509
+
510
+ ---
511
+
512
+ ### Find Customer Order
513
+
514
+ GET `/fluent-cart/v2/customers/{customerId}/order`
515
+
516
+ Retrieve all orders for a customer with their filtered order items (line items) eager-loaded.
517
+
518
+ - **Permission:** `customers/view`
519
+
520
+ #### Parameters
521
+
522
+ | Parameter | Type | Location | Required | Description |
523
+ | --- | --- | --- | --- | --- |
524
+ | `customerId` | integer | path | Yes | The customer ID |
525
+
526
+ #### Response
527
+
528
+ ```
529
+ {
530
+ "data": {
531
+ "data": [
532
+ {
533
+ "id": 101,
534
+ "customer_id": 1,
535
+ "invoice_no": "FCT-0101",
536
+ "total_amount": 5000,
537
+ "filtered_order_items": [
538
+ {
539
+ "id": 1,
540
+ "order_id": 101,
541
+ "title": "Product Name",
542
+ "quantity": 2,
543
+ "unit_price": 2500,
544
+ "...": "..."
545
+ }
546
+ ],
547
+ "...": "..."
548
+ }
549
+ ]
550
+ }
551
+ }
552
+ ```
553
+
554
+ #### Example
555
+
556
+ ```
557
+ curl -X GET "https://example.com/wp-json/fluent-cart/v2/customers/1/order" \
558
+ -u "username:app_password"
559
+ ```
560
+
561
+ ---
562
+
563
+ ### Recalculate Lifetime Value
564
+
565
+ POST `/fluent-cart/v2/customers/{customerId}/recalculate-ltv`
566
+
567
+ Recalculate a customer's lifetime value (LTV) by summing net payments from all successful orders. Also updates `purchase_count`, `first_purchase_date`, `last_purchase_date`, and `aov` (average order value).
568
+
569
+ - **Permission:** `customers/manage`
570
+
571
+ #### Parameters
572
+
573
+ | Parameter | Type | Location | Required | Description |
574
+ | --- | --- | --- | --- | --- |
575
+ | `customerId` | integer | path | Yes | The customer ID |
576
+
577
+ #### Response
578
+
579
+ **Success (200):**
580
+
581
+ ```
582
+ {
583
+ "message": "Lifetime value recalculated successfully",
584
+ "customer": {
585
+ "id": 1,
586
+ "email": "[email protected]",
587
+ "first_name": "John",
588
+ "last_name": "Doe",
589
+ "purchase_count": 5,
590
+ "ltv": 25000,
591
+ "aov": 5000,
592
+ "first_purchase_date": "2025-01-15 10:30:00",
593
+ "last_purchase_date": "2025-06-20 14:00:00",
594
+ "...": "..."
595
+ }
596
+ }
597
+ ```
598
+
599
+ **Error (404):**
600
+
601
+ ```
602
+ {
603
+ "message": "Customer not found."
604
+ }
605
+ ```
606
+
607
+ > The LTV calculation sums `total_paid - total_refund` for each order with a successful payment status. Only net-positive amounts are counted.
608
+
609
+ #### Example
610
+
611
+ ```
612
+ curl -X POST "https://example.com/wp-json/fluent-cart/v2/customers/1/recalculate-ltv" \
613
+ -u "username:app_password"
614
+ ```
615
+
616
+ ---
617
+
618
+ ## Address Management
619
+
620
+ ### Get Customer Addresses
621
+
622
+ GET `/fluent-cart/v2/customers/{customerId}/address`
623
+
624
+ Retrieve addresses for a customer, optionally filtered by address type. Results are sorted with the primary address first.
625
+
626
+ - **Permission:** `customers/view`
627
+
628
+ #### Parameters
629
+
630
+ | Parameter | Type | Location | Required | Description |
631
+ | --- | --- | --- | --- | --- |
632
+ | `customerId` | integer | path | Yes | The customer ID |
633
+ | `type` | string | query | No | Address type filter: `billing` or `shipping` (default: `billing`) |
634
+
635
+ #### Response
636
+
637
+ ```
638
+ {
639
+ "addresses": [
640
+ {
641
+ "id": 1,
642
+ "customer_id": 1,
643
+ "is_primary": 1,
644
+ "type": "billing",
645
+ "status": "active",
646
+ "label": "Home",
647
+ "name": "John Doe",
648
+ "address_1": "123 Main Street",
649
+ "address_2": "Apt 4B",
650
+ "city": "New York",
651
+ "state": "NY",
652
+ "postcode": "10001",
653
+ "country": "US",
654
+ "phone": "+1-555-0100",
655
+ "email": "[email protected]",
656
+ "meta": { ... },
657
+ "created_at": "2025-01-10 08:00:00",
658
+ "updated_at": "2025-06-20 14:00:00",
659
+ "formatted_address": {
660
+ "country": "United States",
661
+ "state": "New York",
662
+ "city": "New York",
663
+ "postcode": "10001",
664
+ "address_1": "123 Main Street",
665
+ "address_2": "Apt 4B",
666
+ "type": "billing",
667
+ "name": "John Doe",
668
+ "company_name": "Acme Inc",
669
+ "label": "Home",
670
+ "phone": "+1-555-0100",
671
+ "full_address": "Acme Inc, 123 Main Street, Apt 4B, New York, New York, United States"
672
+ },
673
+ "company_name": "Acme Inc"
674
+ }
675
+ ]
676
+ }
677
+ ```
678
+
679
+ #### Example
680
+
681
+ ```
682
+ curl -X GET "https://example.com/wp-json/fluent-cart/v2/customers/1/address?type=billing" \
683
+ -u "username:app_password"
684
+ ```
685
+
686
+ ---
687
+
688
+ ### Create Address
689
+
690
+ POST `/fluent-cart/v2/customers/{customerId}/address`
691
+
692
+ Create a new address for a customer. If no primary address exists for the given type, this address is automatically set as primary. Optionally syncs with an associated order address.
693
+
694
+ - **Permission:** `customers/manage`
695
+
696
+ #### Parameters
697
+
698
+ | Parameter | Type | Location | Required | Description |
699
+ | --- | --- | --- | --- | --- |
700
+ | `customerId` | integer | path | Yes | The customer ID |
701
+ | `name` | string | body | Yes | Full name for the address. Max 255 characters. |
702
+ | `email` | string | body | Yes | Email for the address. Max 255 characters. |
703
+ | `address_1` | string | body | Yes | Primary street address |
704
+ | `address_2` | string | body | No | Secondary address line (apartment, suite, etc.) |
705
+ | `city` | string | body | Yes | City. Max 255 characters. |
706
+ | `state` | string | body | Conditional | State/province code. May be required depending on store localization settings. |
707
+ | `postcode` | string | body | Conditional | Postal/zip code. May be required depending on store localization settings. |
708
+ | `country` | string | body | Yes | Country code (e.g., `US`, `GB`) |
709
+ | `phone` | string | body | No | Phone number |
710
+ | `type` | string | body | Yes | Address type: `billing` or `shipping` |
711
+ | `label` | string | body | No | Custom label for the address (e.g., `Home`, `Office`). Max 15 characters. |
712
+ | `status` | string | body | No | Address status (default: `active`) |
713
+ | `is_primary` | integer | body | No | Set to `1` to make this the primary address (default: `0`) |
714
+ | `company_name` | string | body | No | Company name. Max 255 characters. |
715
+ | `order_id` | integer | body | No | Order ID to sync this address with. When provided with a primary address, the corresponding order address is also created/updated. |
716
+
717
+ #### Response
718
+
719
+ **Success (200):**
720
+
721
+ ```
722
+ {
723
+ "message": "Billing address created successfully!",
724
+ "data": {
725
+ "id": 5,
726
+ "customer_id": 1,
727
+ "is_primary": 0,
728
+ "type": "billing",
729
+ "status": "active",
730
+ "label": "Office",
731
+ "name": "John Doe",
732
+ "address_1": "456 Business Ave",
733
+ "address_2": "",
734
+ "city": "New York",
735
+ "state": "NY",
736
+ "postcode": "10002",
737
+ "country": "US",
738
+ "phone": "+1-555-0200",
739
+ "email": "[email protected]",
740
+ "...": "..."
741
+ }
742
+ }
743
+ ```
744
+
745
+ #### Example
746
+
747
+ ```
748
+ curl -X POST "https://example.com/wp-json/fluent-cart/v2/customers/1/address" \
749
+ -u "username:app_password" \
750
+ -H "Content-Type: application/json" \
751
+ -d '{
752
+ "name": "John Doe",
753
+ "email": "[email protected]",
754
+ "address_1": "456 Business Ave",
755
+ "city": "New York",
756
+ "state": "NY",
757
+ "postcode": "10002",
758
+ "country": "US",
759
+ "phone": "+1-555-0200",
760
+ "type": "billing",
761
+ "label": "Office",
762
+ "company_name": "Acme Inc"
763
+ }'
764
+ ```
765
+
766
+ ---
767
+
768
+ ### Update Address
769
+
770
+ PUT `/fluent-cart/v2/customers/{customerId}/address`
771
+
772
+ Update an existing customer address by its address record ID. Optionally syncs changes to an associated order address.
773
+
774
+ - **Permission:** `customers/manage`
775
+
776
+ #### Parameters
777
+
778
+ | Parameter | Type | Location | Required | Description |
779
+ | --- | --- | --- | --- | --- |
780
+ | `customerId` | integer | path | Yes | The customer ID |
781
+ | `id` | integer | body | Yes | The address record ID to update |
782
+ | `name` | string | body | Yes | Full name for the address. Max 255 characters. |
783
+ | `email` | string | body | Yes | Email for the address. Max 255 characters. |
784
+ | `address_1` | string | body | Yes | Primary street address |
785
+ | `address_2` | string | body | No | Secondary address line |
786
+ | `city` | string | body | Yes | City. Max 255 characters. |
787
+ | `state` | string | body | Conditional | State/province code. May be required depending on store localization settings. |
788
+ | `postcode` | string | body | Conditional | Postal/zip code. May be required depending on store localization settings. |
789
+ | `country` | string | body | Yes | Country code |
790
+ | `phone` | string | body | No | Phone number |
791
+ | `type` | string | body | Yes | Address type: `billing` or `shipping` |
792
+ | `label` | string | body | No | Custom label. Max 15 characters. |
793
+ | `status` | string | body | No | Address status |
794
+ | `is_primary` | integer | body | No | Set to `1` for primary address |
795
+ | `company_name` | string | body | No | Company name. Max 255 characters. |
796
+ | `order_id` | integer | body | No | Order ID to sync address changes with |
797
+
798
+ #### Response
799
+
800
+ **Success (200):**
801
+
802
+ ```
803
+ {
804
+ "message": "Billing address updated successfully!",
805
+ "data": {
806
+ "id": 5,
807
+ "customer_id": 1,
808
+ "is_primary": 0,
809
+ "type": "billing",
810
+ "name": "John Doe",
811
+ "address_1": "789 Updated Street",
812
+ "...": "..."
813
+ }
814
+ }
815
+ ```
816
+
817
+ **Error (404):**
818
+
819
+ ```
820
+ {
821
+ "code": 404,
822
+ "message": "Address not found, please reload the page and try again!",
823
+ "data": ""
824
+ }
825
+ ```
826
+
827
+ #### Example
828
+
829
+ ```
830
+ curl -X PUT "https://example.com/wp-json/fluent-cart/v2/customers/1/address" \
831
+ -u "username:app_password" \
832
+ -H "Content-Type: application/json" \
833
+ -d '{
834
+ "id": 5,
835
+ "name": "John Doe",
836
+ "email": "[email protected]",
837
+ "address_1": "789 Updated Street",
838
+ "city": "New York",
839
+ "state": "NY",
840
+ "postcode": "10003",
841
+ "country": "US",
842
+ "type": "billing"
843
+ }'
844
+ ```
845
+
846
+ ---
847
+
848
+ ### Delete Address
849
+
850
+ DELETE `/fluent-cart/v2/customers/{customerId}/address`
851
+
852
+ Delete a customer address. Primary addresses and the last remaining address cannot be deleted.
853
+
854
+ - **Permission:** `customers/delete`
855
+
856
+ #### Parameters
857
+
858
+ | Parameter | Type | Location | Required | Description |
859
+ | --- | --- | --- | --- | --- |
860
+ | `customerId` | integer | path | Yes | The customer ID |
861
+ | `address[id]` | integer | body/query | Yes | The address record ID to delete |
862
+
863
+ #### Response
864
+
865
+ **Success (200):**
866
+
867
+ ```
868
+ {
869
+ "message": "Address successfully deleted.",
870
+ "data": ""
871
+ }
872
+ ```
873
+
874
+ **Error (primary address):**
875
+
876
+ ```
877
+ {
878
+ "code": 403,
879
+ "message": "Primary address cannot be deleted!",
880
+ "data": ""
881
+ }
882
+ ```
883
+
884
+ **Error (last address):**
885
+
886
+ ```
887
+ {
888
+ "code": 403,
889
+ "message": "At least one address must remain. Address deletion failed!",
890
+ "data": ""
891
+ }
892
+ ```
893
+
894
+ #### Example
895
+
896
+ ```
897
+ curl -X DELETE "https://example.com/wp-json/fluent-cart/v2/customers/1/address" \
898
+ -u "username:app_password" \
899
+ -H "Content-Type: application/json" \
900
+ -d '{
901
+ "address": {
902
+ "id": 5
903
+ }
904
+ }'
905
+ ```
906
+
907
+ ---
908
+
909
+ ### Set Primary Address
910
+
911
+ POST `/fluent-cart/v2/customers/{customerId}/address/make-primary`
912
+
913
+ Set a specific address as the primary address for its type. The previous primary address of the same type is automatically demoted.
914
+
915
+ - **Permission:** `customers/manage`
916
+
917
+ #### Parameters
918
+
919
+ | Parameter | Type | Location | Required | Description |
920
+ | --- | --- | --- | --- | --- |
921
+ | `customerId` | integer | path | Yes | The customer ID |
922
+ | `addressId` | integer | body | Yes | The address record ID to make primary |
923
+ | `type` | string | body | Yes | Address type: `billing` or `shipping` |
924
+
925
+ #### Response
926
+
927
+ **Success (200):**
928
+
929
+ ```
930
+ {
931
+ "message": "Address successfully set as the primary",
932
+ "data": ""
933
+ }
934
+ ```
935
+
936
+ **Error (400):**
937
+
938
+ ```
939
+ {
940
+ "code": 400,
941
+ "message": "Address set as primary failed.",
942
+ "data": ""
943
+ }
944
+ ```
945
+
946
+ #### Example
947
+
948
+ ```
949
+ curl -X POST "https://example.com/wp-json/fluent-cart/v2/customers/1/address/make-primary" \
950
+ -u "username:app_password" \
951
+ -H "Content-Type: application/json" \
952
+ -d '{
953
+ "addressId": 5,
954
+ "type": "billing"
955
+ }'
956
+ ```
957
+
958
+ ---
959
+
960
+ ## User Association
961
+
962
+ ### Get Attachable Users
963
+
964
+ GET `/fluent-cart/v2/customers/attachable-user`
965
+
966
+ Retrieve a list of WordPress users that are not yet associated with any FluentCart customer. Useful for linking existing WP users to customer records.
967
+
968
+ - **Permission:** `customers/manage`
969
+
970
+ #### Parameters
971
+
972
+ No parameters required.
973
+
974
+ #### Response
975
+
976
+ ```
977
+ {
978
+ "users": [
979
+ {
980
+ "ID": 10,
981
+ "display_name": "Alice Johnson",
982
+ "user_email": "[email protected]"
983
+ },
984
+ {
985
+ "ID": 15,
986
+ "display_name": "Bob Wilson",
987
+ "user_email": "[email protected]"
988
+ }
989
+ ]
990
+ }
991
+ ```
992
+
993
+ #### Example
994
+
995
+ ```
996
+ curl -X GET "https://example.com/wp-json/fluent-cart/v2/customers/attachable-user" \
997
+ -u "username:app_password"
998
+ ```
999
+
1000
+ ---
1001
+
1002
+ ### Attach WordPress User
1003
+
1004
+ POST `/fluent-cart/v2/customers/{customerId}/attachable-user`
1005
+
1006
+ Link a WordPress user to an existing customer record. The customer must not already have a linked user, and the target user must not already be linked to another customer.
1007
+
1008
+ - **Permission:** `customers/manage`
1009
+
1010
+ #### Parameters
1011
+
1012
+ | Parameter | Type | Location | Required | Description |
1013
+ | --- | --- | --- | --- | --- |
1014
+ | `customerId` | integer | path | Yes | The customer ID |
1015
+ | `user_id` | integer | body | Yes | The WordPress user ID to attach. Max 50 characters. Must reference an existing user who is not already linked to a customer. |
1016
+
1017
+ #### Response
1018
+
1019
+ **Success (200):**
1020
+
1021
+ ```
1022
+ {
1023
+ "message": "User attached successfully"
1024
+ }
1025
+ ```
1026
+
1027
+ **Error (customer already has user):**
1028
+
1029
+ ```
1030
+ {
1031
+ "message": "Can not attach user"
1032
+ }
1033
+ ```
1034
+
1035
+ **Error (user already linked):**
1036
+
1037
+ ```
1038
+ {
1039
+ "code": "rest_request_validation",
1040
+ "message": "User already linked to a customer."
1041
+ }
1042
+ ```
1043
+
1044
+ **Error (user not found):**
1045
+
1046
+ ```
1047
+ {
1048
+ "code": "rest_request_validation",
1049
+ "message": "User not found."
1050
+ }
1051
+ ```
1052
+
1053
+ #### Example
1054
+
1055
+ ```
1056
+ curl -X POST "https://example.com/wp-json/fluent-cart/v2/customers/1/attachable-user" \
1057
+ -u "username:app_password" \
1058
+ -H "Content-Type: application/json" \
1059
+ -d '{
1060
+ "user_id": 10
1061
+ }'
1062
+ ```
1063
+
1064
+ ---
1065
+
1066
+ ### Detach WordPress User
1067
+
1068
+ POST `/fluent-cart/v2/customers/{customerId}/detach-user`
1069
+
1070
+ Remove the WordPress user association from a customer record. The customer record itself is preserved; only the `user_id` link is cleared.
1071
+
1072
+ - **Permission:** `customers/manage`
1073
+
1074
+ #### Parameters
1075
+
1076
+ | Parameter | Type | Location | Required | Description |
1077
+ | --- | --- | --- | --- | --- |
1078
+ | `customerId` | integer | path | Yes | The customer ID |
1079
+
1080
+ #### Response
1081
+
1082
+ **Success (200):**
1083
+
1084
+ ```
1085
+ {
1086
+ "message": "User detached successfully"
1087
+ }
1088
+ ```
1089
+
1090
+ **Error (customer not found):**
1091
+
1092
+ ```
1093
+ {
1094
+ "message": "Customer not found."
1095
+ }
1096
+ ```
1097
+
1098
+ #### Example
1099
+
1100
+ ```
1101
+ curl -X POST "https://example.com/wp-json/fluent-cart/v2/customers/1/detach-user" \
1102
+ -u "username:app_password"
1103
+ ```