fluentcart-developer 3.0.0 → 3.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (609) hide show
  1. package/LICENSE.md +26 -26
  2. package/README.md +59 -59
  3. package/dist/cards/fluentcart/templates-native.js +1087 -1087
  4. package/dist/cards/fluentcart/tools.js +2309 -2309
  5. package/dist/skills/fluentcart-developer/SKILL.md +108 -108
  6. package/dist/skills/fluentcart-developer/examples/README.md +30 -30
  7. package/dist/skills/fluentcart-developer/examples/fluentcart-starter-child-theme/fluent-cart/checkout.php +32 -32
  8. package/dist/skills/fluentcart-developer/examples/fluentcart-starter-child-theme/functions.php +40 -40
  9. package/dist/skills/fluentcart-developer/examples/sample-custom-addon/fluentcart-custom-addon.php +113 -113
  10. package/dist/skills/fluentcart-developer/examples/sample-custom-payment-gateway/fluentcart-custom-gateway-example.php +148 -148
  11. package/dist/skills/fluentcart-developer/examples/sample-fee-surcharge-plugin/fluentcart-fee-surcharge.php +38 -38
  12. package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/README.md +22 -22
  13. package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/sample-plugin-with-licensing-sdk.php +79 -79
  14. package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/updater/FluentLicensing.php +303 -303
  15. package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/updater/LicenseSettings.php +566 -566
  16. package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/updater/PluginUpdater.php +304 -304
  17. package/dist/skills/fluentcart-developer/examples/sample-shipping-carrier/fluentcart-custom-shipping-carrier.php +61 -61
  18. package/dist/skills/fluentcart-developer/references/api/authentication.md +452 -452
  19. package/dist/skills/fluentcart-developer/references/api/coupons.md +786 -786
  20. package/dist/skills/fluentcart-developer/references/api/customers.md +889 -889
  21. package/dist/skills/fluentcart-developer/references/api/files.md +609 -609
  22. package/dist/skills/fluentcart-developer/references/api/index.md +432 -432
  23. package/dist/skills/fluentcart-developer/references/api/licensing.md +633 -633
  24. package/dist/skills/fluentcart-developer/references/api/order-bump.md +384 -384
  25. package/dist/skills/fluentcart-developer/references/api/orders.md +814 -814
  26. package/dist/skills/fluentcart-developer/references/api/products.md +866 -866
  27. package/dist/skills/fluentcart-developer/references/api/roles-permissions.md +536 -536
  28. package/dist/skills/fluentcart-developer/references/api/subscriptions.md +827 -827
  29. package/dist/skills/fluentcart-developer/references/database/index.md +44 -44
  30. package/dist/skills/fluentcart-developer/references/database/models/activity.md +178 -178
  31. package/dist/skills/fluentcart-developer/references/database/models/applied-coupon.md +291 -291
  32. package/dist/skills/fluentcart-developer/references/database/models/attribute-group.md +239 -239
  33. package/dist/skills/fluentcart-developer/references/database/models/attribute-relation.md +181 -181
  34. package/dist/skills/fluentcart-developer/references/database/models/attribute-term.md +219 -219
  35. package/dist/skills/fluentcart-developer/references/database/models/cart.md +645 -645
  36. package/dist/skills/fluentcart-developer/references/database/models/coupon.md +427 -427
  37. package/dist/skills/fluentcart-developer/references/database/models/customer-addresses.md +348 -348
  38. package/dist/skills/fluentcart-developer/references/database/models/customer-meta.md +156 -156
  39. package/dist/skills/fluentcart-developer/references/database/models/customer.md +584 -584
  40. package/dist/skills/fluentcart-developer/references/database/models/dynamic-model.md +163 -163
  41. package/dist/skills/fluentcart-developer/references/database/models/label-relationship.md +155 -155
  42. package/dist/skills/fluentcart-developer/references/database/models/label.md +153 -153
  43. package/dist/skills/fluentcart-developer/references/database/models/license-activation.md +182 -182
  44. package/dist/skills/fluentcart-developer/references/database/models/license-meta.md +163 -163
  45. package/dist/skills/fluentcart-developer/references/database/models/license-site.md +208 -208
  46. package/dist/skills/fluentcart-developer/references/database/models/license.md +640 -640
  47. package/dist/skills/fluentcart-developer/references/database/models/meta.md +233 -233
  48. package/dist/skills/fluentcart-developer/references/database/models/order-address.md +391 -391
  49. package/dist/skills/fluentcart-developer/references/database/models/order-download-permission.md +144 -144
  50. package/dist/skills/fluentcart-developer/references/database/models/order-item.md +383 -383
  51. package/dist/skills/fluentcart-developer/references/database/models/order-meta.md +303 -303
  52. package/dist/skills/fluentcart-developer/references/database/models/order-operation.md +158 -158
  53. package/dist/skills/fluentcart-developer/references/database/models/order-promotion-stat.md +175 -175
  54. package/dist/skills/fluentcart-developer/references/database/models/order-promotion.md +250 -250
  55. package/dist/skills/fluentcart-developer/references/database/models/order-tax-rate.md +172 -172
  56. package/dist/skills/fluentcart-developer/references/database/models/order-transaction.md +440 -440
  57. package/dist/skills/fluentcart-developer/references/database/models/order.md +727 -727
  58. package/dist/skills/fluentcart-developer/references/database/models/product-detail.md +397 -397
  59. package/dist/skills/fluentcart-developer/references/database/models/product-download.md +258 -258
  60. package/dist/skills/fluentcart-developer/references/database/models/product-meta.md +153 -153
  61. package/dist/skills/fluentcart-developer/references/database/models/product-variation.md +556 -556
  62. package/dist/skills/fluentcart-developer/references/database/models/product.md +580 -580
  63. package/dist/skills/fluentcart-developer/references/database/models/relationships.md +427 -427
  64. package/dist/skills/fluentcart-developer/references/database/models/scheduled-action.md +175 -175
  65. package/dist/skills/fluentcart-developer/references/database/models/shipping-class.md +148 -148
  66. package/dist/skills/fluentcart-developer/references/database/models/shipping-method.md +280 -280
  67. package/dist/skills/fluentcart-developer/references/database/models/shipping-zone.md +205 -205
  68. package/dist/skills/fluentcart-developer/references/database/models/subscription-meta.md +173 -173
  69. package/dist/skills/fluentcart-developer/references/database/models/subscription.md +528 -528
  70. package/dist/skills/fluentcart-developer/references/database/models/tax-class.md +195 -195
  71. package/dist/skills/fluentcart-developer/references/database/models/tax-rate.md +225 -225
  72. package/dist/skills/fluentcart-developer/references/database/models/user-meta.md +166 -166
  73. package/dist/skills/fluentcart-developer/references/database/models/user.md +220 -220
  74. package/dist/skills/fluentcart-developer/references/database/models.md +404 -404
  75. package/dist/skills/fluentcart-developer/references/database/query-builder.md +860 -860
  76. package/dist/skills/fluentcart-developer/references/database/readme.md +276 -276
  77. package/dist/skills/fluentcart-developer/references/database/schema.md +1002 -1002
  78. package/dist/skills/fluentcart-developer/references/engineering/adding-custom-pages-to-the-customer-dashboard.md +395 -395
  79. package/dist/skills/fluentcart-developer/references/engineering/index.md +4 -4
  80. package/dist/skills/fluentcart-developer/references/engineering.md +4 -4
  81. package/dist/skills/fluentcart-developer/references/getting-started.md +249 -249
  82. package/dist/skills/fluentcart-developer/references/guides/frontend.md +519 -519
  83. package/dist/skills/fluentcart-developer/references/guides/index.md +107 -107
  84. package/dist/skills/fluentcart-developer/references/guides/integrations.md +600 -600
  85. package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/index.md +237 -237
  86. package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/labels-and-tracking.md +481 -481
  87. package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/live-rates.md +269 -269
  88. package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/reference.md +223 -223
  89. package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/settings.md +370 -370
  90. package/dist/skills/fluentcart-developer/references/guides/shipping-carrier.md +237 -237
  91. package/dist/skills/fluentcart-developer/references/guides/subscriptions.md +217 -217
  92. package/dist/skills/fluentcart-developer/references/hooks/actions/admin-and-templates.md +1079 -1079
  93. package/dist/skills/fluentcart-developer/references/hooks/actions/cart-and-checkout.md +1795 -1795
  94. package/dist/skills/fluentcart-developer/references/hooks/actions/customers-and-users.md +327 -327
  95. package/dist/skills/fluentcart-developer/references/hooks/actions/licenses.md +829 -829
  96. package/dist/skills/fluentcart-developer/references/hooks/actions/modules.md +81 -81
  97. package/dist/skills/fluentcart-developer/references/hooks/actions/orders.md +757 -757
  98. package/dist/skills/fluentcart-developer/references/hooks/actions/payments-and-integrations.md +1163 -1163
  99. package/dist/skills/fluentcart-developer/references/hooks/actions/pro-modules.md +219 -219
  100. package/dist/skills/fluentcart-developer/references/hooks/actions/products-and-coupons.md +1019 -1019
  101. package/dist/skills/fluentcart-developer/references/hooks/actions/subscriptions.md +1290 -1290
  102. package/dist/skills/fluentcart-developer/references/hooks/actions.md +16 -16
  103. package/dist/skills/fluentcart-developer/references/hooks/deprecated.md +60 -60
  104. package/dist/skills/fluentcart-developer/references/hooks/filters/cart-and-checkout.md +2032 -2032
  105. package/dist/skills/fluentcart-developer/references/hooks/filters/customers-and-subscriptions.md +1746 -1746
  106. package/dist/skills/fluentcart-developer/references/hooks/filters/integrations-and-advanced.md +2439 -2439
  107. package/dist/skills/fluentcart-developer/references/hooks/filters/modules.md +464 -464
  108. package/dist/skills/fluentcart-developer/references/hooks/filters/orders-and-payments.md +2658 -2658
  109. package/dist/skills/fluentcart-developer/references/hooks/filters/pro-modules.md +502 -502
  110. package/dist/skills/fluentcart-developer/references/hooks/filters/products-and-pricing.md +1785 -1785
  111. package/dist/skills/fluentcart-developer/references/hooks/filters/settings-and-configuration.md +2966 -2966
  112. package/dist/skills/fluentcart-developer/references/hooks/filters.md +14 -14
  113. package/dist/skills/fluentcart-developer/references/hooks/index.md +35 -35
  114. package/dist/skills/fluentcart-developer/references/index.md +625 -625
  115. package/dist/skills/fluentcart-developer/references/modules/fee-system.md +427 -427
  116. package/dist/skills/fluentcart-developer/references/modules/ghost-product-selling.md +440 -440
  117. package/dist/skills/fluentcart-developer/references/modules/index.md +484 -484
  118. package/dist/skills/fluentcart-developer/references/modules/licensing.md +342 -342
  119. package/dist/skills/fluentcart-developer/references/modules/order-bump.md +433 -433
  120. package/dist/skills/fluentcart-developer/references/modules/payment-methods.md +129 -129
  121. package/dist/skills/fluentcart-developer/references/modules/refunds.md +170 -170
  122. package/dist/skills/fluentcart-developer/references/modules/shipping.md +846 -846
  123. package/dist/skills/fluentcart-developer/references/modules/storage.md +986 -986
  124. package/dist/skills/fluentcart-developer/references/modules/subscription-vendor-ids.md +186 -186
  125. package/dist/skills/fluentcart-developer/references/modules/subscriptions.md +678 -678
  126. package/dist/skills/fluentcart-developer/references/payment-methods-integration/index.md +164 -164
  127. package/dist/skills/fluentcart-developer/references/payment-methods-integration/paddle-example.md +1648 -1648
  128. package/dist/skills/fluentcart-developer/references/payment-methods-integration/payment/setting/fields.md +353 -353
  129. package/dist/skills/fluentcart-developer/references/payment-methods-integration/quick-implementation.md +1079 -1079
  130. package/dist/skills/fluentcart-developer/references/payment-methods-integration.md +164 -164
  131. package/dist/skills/fluentcart-developer/references/restapi/checkout.md +573 -573
  132. package/dist/skills/fluentcart-developer/references/restapi/coupons.md +958 -958
  133. package/dist/skills/fluentcart-developer/references/restapi/customer-profile.md +1423 -1423
  134. package/dist/skills/fluentcart-developer/references/restapi/customers.md +1103 -1103
  135. package/dist/skills/fluentcart-developer/references/restapi/dashboard.md +1083 -1083
  136. package/dist/skills/fluentcart-developer/references/restapi/data-export.md +132 -132
  137. package/dist/skills/fluentcart-developer/references/restapi/email-notifications.md +846 -846
  138. package/dist/skills/fluentcart-developer/references/restapi/files.md +313 -313
  139. package/dist/skills/fluentcart-developer/references/restapi/index.md +127 -127
  140. package/dist/skills/fluentcart-developer/references/restapi/integrations.md +1000 -1000
  141. package/dist/skills/fluentcart-developer/references/restapi/inventory.md +192 -192
  142. package/dist/skills/fluentcart-developer/references/restapi/labels-and-attributes.md +797 -797
  143. package/dist/skills/fluentcart-developer/references/restapi/licensing.md +1733 -1733
  144. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-available-shipping-methods.md +30 -30
  145. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-checkout-summary.md +28 -28
  146. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-country-info.md +29 -29
  147. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-order-info.md +28 -28
  148. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-shipping-methods-list-view.md +30 -30
  149. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/login.md +66 -66
  150. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/place-order.md +179 -179
  151. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/apply-coupon.md +83 -83
  152. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/cancel-coupon.md +87 -87
  153. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/check-product-eligibility.md +59 -59
  154. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/create-coupon.md +230 -230
  155. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/delete-coupon.md +29 -29
  156. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/get-coupon-settings.md +20 -20
  157. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/get-coupon.md +27 -27
  158. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/list-coupon-codes.md +20 -20
  159. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/list-coupons.md +37 -37
  160. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/re-apply-coupons.md +75 -75
  161. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/store-coupon-settings.md +40 -40
  162. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/update-coupon.md +133 -133
  163. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/create-address-checkout.md +138 -138
  164. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/create-profile-address.md +119 -119
  165. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/dashboard-overview.md +22 -22
  166. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/delete-profile-address.md +46 -46
  167. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-order-details.md +30 -30
  168. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-portal-sections.md +29 -29
  169. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-profile-details.md +22 -22
  170. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-transaction-billing-address.md +30 -30
  171. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-upgrade-paths.md +31 -31
  172. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/list-downloads.md +29 -29
  173. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/list-orders.md +28 -28
  174. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/make-profile-address-primary.md +55 -55
  175. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/pause-subscription.md +29 -29
  176. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/resume-subscription.md +29 -29
  177. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/save-transaction-billing-address.md +92 -92
  178. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/select-address-for-checkout.md +32 -32
  179. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/update-profile-address.md +115 -115
  180. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/update-profile-details.md +69 -69
  181. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/attach-user.md +50 -50
  182. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/bulk-actions.md +65 -65
  183. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/create-address.md +135 -135
  184. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/create-customer.md +108 -108
  185. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/delete-address.md +62 -62
  186. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/detach-user.md +28 -28
  187. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/find-customer-order.md +27 -27
  188. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-attachable-users.md +20 -20
  189. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer-addresses.md +28 -28
  190. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer-orders.md +37 -37
  191. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer-stats.md +27 -27
  192. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer.md +32 -32
  193. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/list-customers.md +37 -37
  194. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/recalculate-ltv.md +28 -28
  195. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/set-primary-address.md +72 -72
  196. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/update-additional-info.md +55 -55
  197. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/update-address.md +144 -144
  198. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/update-customer.md +123 -123
  199. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/attach-note-to-order.md +49 -49
  200. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/create-all-pages.md +21 -21
  201. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/create-single-page.md +55 -55
  202. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/delete-activity.md +28 -28
  203. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-country-info.md +29 -29
  204. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-dashboard-stats.md +22 -22
  205. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-filter-options.md +31 -31
  206. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-onboarding-data.md +20 -20
  207. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-onboarding-settings.md +20 -20
  208. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-print-templates.md +20 -20
  209. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-search-options.md +27 -27
  210. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-widgets.md +28 -28
  211. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/initialize-app.md +20 -20
  212. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/list-activities.md +33 -33
  213. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/list-attachments.md +21 -21
  214. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/list-countries.md +20 -20
  215. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/mark-activity-read.md +53 -53
  216. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/run-data-backfills.md +21 -21
  217. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/save-onboarding-settings.md +54 -54
  218. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/save-onboarding-tax-settings.md +73 -73
  219. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/save-print-templates.md +64 -64
  220. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/upload-attachment.md +42 -42
  221. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-customers-batch.md +129 -129
  222. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-licenses-batch.md +133 -133
  223. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-orders-batch.md +129 -129
  224. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-subscriptions-batch.md +129 -129
  225. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-customers-export-schema.md +21 -21
  226. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-licenses-export-schema.md +26 -26
  227. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-orders-export-schema.md +21 -21
  228. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-subscriptions-export-schema.md +21 -21
  229. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/enable-notification.md +57 -57
  230. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-digest-settings.md +22 -22
  231. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-notification.md +30 -30
  232. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-reminders.md +22 -22
  233. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-settings.md +22 -22
  234. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-shortcodes.md +22 -22
  235. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/list-notifications.md +20 -20
  236. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/preview-default-template.md +66 -66
  237. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/preview-notification.md +50 -50
  238. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/save-digest-settings.md +101 -101
  239. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/save-reminders.md +162 -162
  240. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/save-settings.md +99 -99
  241. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/send-digest-test.md +47 -47
  242. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/send-manual-reminder.md +51 -51
  243. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/update-notification.md +93 -93
  244. package/dist/skills/fluentcart-developer/references/restapi/operations/files/delete-file.md +31 -31
  245. package/dist/skills/fluentcart-developer/references/restapi/operations/files/get-bucket-list.md +28 -28
  246. package/dist/skills/fluentcart-developer/references/restapi/operations/files/list-files.md +30 -30
  247. package/dist/skills/fluentcart-developer/references/restapi/operations/files/upload-editor-file.md +32 -32
  248. package/dist/skills/fluentcart-developer/references/restapi/operations/files/upload-file.md +34 -34
  249. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/chained-data-request.md +46 -46
  250. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/change-feed-status.md +51 -51
  251. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/delete-feed.md +27 -27
  252. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-dynamic-options.md +29 -29
  253. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-feed-lists.md +27 -27
  254. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-feed-settings.md +27 -27
  255. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-global-feeds.md +20 -20
  256. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-global-settings.md +26 -26
  257. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/install-addon-plugin.md +49 -49
  258. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/list-addons.md +20 -20
  259. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/save-feed-settings.md +52 -52
  260. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/set-global-settings.md +50 -50
  261. package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/bulk-update-stock.md +94 -94
  262. package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/export-inventory.md +81 -81
  263. package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/get-adjustment-history.md +26 -26
  264. package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/get-inventory-stats.md +21 -21
  265. package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/list-inventory.md +33 -33
  266. package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/update-stock.md +75 -75
  267. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/create-attribute-group.md +31 -31
  268. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/create-label.md +31 -31
  269. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/create-terms.md +90 -90
  270. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/delete-attribute-group.md +28 -28
  271. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/delete-attribute-term.md +29 -29
  272. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/get-attribute-group.md +28 -28
  273. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/get-attribute-library.md +20 -20
  274. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/list-attribute-groups.md +32 -32
  275. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/list-attribute-terms.md +33 -33
  276. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/list-labels.md +20 -20
  277. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/reorder-groups.md +51 -51
  278. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/reorder-terms.md +56 -56
  279. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/update-attribute-group.md +37 -37
  280. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/update-attribute-term.md +39 -39
  281. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/update-label-selections.md +32 -32
  282. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/activate-plugin-license.md +41 -41
  283. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/activate-site-admin.md +60 -60
  284. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/deactivate-plugin-license.md +18 -18
  285. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/deactivate-site-admin.md +67 -67
  286. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/deactivate-site-customer.md +47 -47
  287. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/delete-license.md +24 -24
  288. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/extend-license-validity.md +47 -47
  289. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-customer-license-details.md +25 -25
  290. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-customer-licenses-admin.md +26 -26
  291. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-license-activations.md +25 -25
  292. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-license-details.md +25 -25
  293. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-license-site.md +30 -30
  294. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-plugin-license-status.md +18 -18
  295. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-product-license-settings.md +24 -24
  296. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/list-customer-licenses.md +25 -25
  297. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/list-license-sites.md +33 -33
  298. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/list-licenses.md +38 -38
  299. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-activate-license.md +54 -54
  300. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-check-license.md +26 -26
  301. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-deactivate-license.md +46 -46
  302. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-download-license-package.md +23 -23
  303. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-get-license-version.md +26 -26
  304. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/regenerate-license-key.md +24 -24
  305. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/save-product-license-settings.md +193 -193
  306. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/update-license-activation-limit.md +53 -53
  307. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/update-license-status.md +52 -52
  308. package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/create-order-bump.md +47 -47
  309. package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/delete-order-bump.md +25 -25
  310. package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/get-order-bump.md +25 -25
  311. package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/list-order-bumps.md +29 -29
  312. package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/update-order-bump.md +141 -141
  313. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/accept-dispute.md +47 -47
  314. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/bulk-actions.md +72 -72
  315. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/calculate-shipping.md +67 -67
  316. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/calculate-tax.md +98 -98
  317. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/change-customer.md +50 -50
  318. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/charge-now.md +29 -29
  319. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-and-change-customer.md +92 -92
  320. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-custom-order-item.md +68 -68
  321. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-order.md +351 -351
  322. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-renewal-now.md +29 -29
  323. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/delete-order.md +28 -28
  324. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/generate-missing-licenses.md +29 -29
  325. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-order-transactions.md +27 -27
  326. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-order.md +27 -27
  327. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-renewal.md +28 -28
  328. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-shipping-methods.md +28 -28
  329. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-single-transaction.md +28 -28
  330. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/list-order-currencies.md +22 -22
  331. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/list-orders.md +42 -42
  332. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/list-renewals.md +28 -28
  333. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/mark-as-paid.md +61 -61
  334. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/price-order.md +135 -135
  335. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/refund-order.md +72 -72
  336. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/resend-renewal-invoice.md +29 -29
  337. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/skip-renewal.md +48 -48
  338. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/sync-order-statuses.md +28 -28
  339. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/sync-pending-transaction.md +29 -29
  340. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-order-address-id.md +60 -60
  341. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-order-address.md +98 -98
  342. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-order.md +172 -172
  343. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-statuses.md +77 -77
  344. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-subscription-details.md +84 -84
  345. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-transaction-status.md +51 -51
  346. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/void-renewal.md +30 -30
  347. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/create-pdf-template.md +42 -42
  348. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/delete-pdf-template.md +26 -26
  349. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/download-pdf-preview.md +44 -44
  350. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-factory-default-templates.md +19 -19
  351. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-pdf-status.md +21 -21
  352. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-pdf-template.md +26 -26
  353. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-saved-templates.md +21 -21
  354. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-seller-details.md +19 -19
  355. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/list-pdf-templates.md +19 -19
  356. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/save-pdf-template.md +53 -53
  357. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/save-seller-details.md +97 -97
  358. package/dist/skills/fluentcart-developer/references/restapi/operations/products/add-product-terms.md +64 -64
  359. package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-edit-fetch.md +30 -30
  360. package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-insert-products.md +62 -62
  361. package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-update-products.md +59 -59
  362. package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-update-variants.md +83 -83
  363. package/dist/skills/fluentcart-developer/references/restapi/operations/products/change-integration-status.md +64 -64
  364. package/dist/skills/fluentcart-developer/references/restapi/operations/products/create-dummy-products.md +45 -45
  365. package/dist/skills/fluentcart-developer/references/restapi/operations/products/create-product.md +81 -81
  366. package/dist/skills/fluentcart-developer/references/restapi/operations/products/create-variation.md +181 -181
  367. package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-downloadable-file.md +27 -27
  368. package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-product-integration.md +30 -30
  369. package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-product.md +27 -27
  370. package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-taxonomy-term.md +55 -55
  371. package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-upgrade-path.md +27 -27
  372. package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-variation.md +27 -27
  373. package/dist/skills/fluentcart-developer/references/restapi/operations/products/do-bulk-action.md +56 -56
  374. package/dist/skills/fluentcart-developer/references/restapi/operations/products/duplicate-product.md +56 -56
  375. package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-products-by-ids.md +26 -26
  376. package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-taxonomy-terms.md +20 -20
  377. package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-terms-by-parent.md +60 -60
  378. package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-variations-by-ids.md +26 -26
  379. package/dist/skills/fluentcart-developer/references/restapi/operations/products/find-subscription-variants.md +26 -26
  380. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-bundle-info.md +27 -27
  381. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-downloadable-url.md +27 -27
  382. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-max-excerpt-word-count.md +20 -20
  383. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-pricing-widgets.md +27 -27
  384. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product-integration-feeds.md +29 -29
  385. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product-integration-settings.md +31 -31
  386. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product-pricing.md +28 -28
  387. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product.md +28 -28
  388. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-related-products.md +31 -31
  389. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-upgrade-settings.md +27 -27
  390. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-variation-upgrade-paths.md +28 -28
  391. package/dist/skills/fluentcart-developer/references/restapi/operations/products/group-bulk-update-variants.md +103 -103
  392. package/dist/skills/fluentcart-developer/references/restapi/operations/products/list-all-variants.md +26 -26
  393. package/dist/skills/fluentcart-developer/references/restapi/operations/products/list-product-variations.md +26 -26
  394. package/dist/skills/fluentcart-developer/references/restapi/operations/products/list-products.md +34 -34
  395. package/dist/skills/fluentcart-developer/references/restapi/operations/products/remove-shipping-class.md +27 -27
  396. package/dist/skills/fluentcart-developer/references/restapi/operations/products/remove-tax-class.md +27 -27
  397. package/dist/skills/fluentcart-developer/references/restapi/operations/products/save-bundle-info.md +56 -56
  398. package/dist/skills/fluentcart-developer/references/restapi/operations/products/save-product-integration.md +62 -62
  399. package/dist/skills/fluentcart-developer/references/restapi/operations/products/save-upgrade-path.md +78 -78
  400. package/dist/skills/fluentcart-developer/references/restapi/operations/products/search-product-variant-options.md +29 -29
  401. package/dist/skills/fluentcart-developer/references/restapi/operations/products/search-products-by-name.md +28 -28
  402. package/dist/skills/fluentcart-developer/references/restapi/operations/products/search-variants-by-name.md +28 -28
  403. package/dist/skills/fluentcart-developer/references/restapi/operations/products/set-variation-media.md +74 -74
  404. package/dist/skills/fluentcart-developer/references/restapi/operations/products/suggest-sku.md +28 -28
  405. package/dist/skills/fluentcart-developer/references/restapi/operations/products/sync-downloadable-files.md +134 -134
  406. package/dist/skills/fluentcart-developer/references/restapi/operations/products/sync-taxonomy-terms.md +61 -61
  407. package/dist/skills/fluentcart-developer/references/restapi/operations/products/toggle-product-tax-exemption.md +56 -56
  408. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-downloadable-file.md +98 -98
  409. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-inventory.md +56 -56
  410. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-long-desc-editor-mode.md +49 -49
  411. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-manage-stock.md +53 -53
  412. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-product-detail.md +58 -58
  413. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-product-pricing.md +225 -225
  414. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-shipping-class.md +49 -49
  415. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-tax-class.md +49 -49
  416. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-upgrade-path.md +78 -78
  417. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variant-option.md +79 -79
  418. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variant-tax-exemption.md +56 -56
  419. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variation-pricing-table.md +49 -49
  420. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variation.md +105 -105
  421. package/dist/skills/fluentcart-developer/references/restapi/operations/public-shop/get-product-views.md +34 -34
  422. package/dist/skills/fluentcart-developer/references/restapi/operations/public-shop/list-products.md +42 -42
  423. package/dist/skills/fluentcart-developer/references/restapi/operations/public-shop/search-products.md +30 -30
  424. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/channel-rules.md +24 -24
  425. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/country-heat-map.md +22 -22
  426. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/coupon-overview.md +37 -37
  427. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/coupons.md +36 -36
  428. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-insights.md +31 -31
  429. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-overview.md +36 -36
  430. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-repeat.md +35 -35
  431. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-segment-customers.md +36 -36
  432. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-segments.md +30 -30
  433. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-value.md +34 -34
  434. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/dashboard-stats.md +30 -30
  435. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/failed-orders.md +34 -34
  436. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-new-vs-returning-customer.md +34 -34
  437. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-report-by-day-and-hour.md +34 -34
  438. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-report-meta.md +29 -29
  439. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-top-sold-products.md +34 -34
  440. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/future-renewals.md +31 -31
  441. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/generate-retention-snapshots.md +24 -24
  442. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-overview.md +30 -30
  443. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-recent-activities.md +26 -26
  444. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-recent-orders.md +20 -20
  445. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-revenue.md +37 -37
  446. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/installments-at-risk.md +35 -35
  447. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/installments-variations.md +33 -33
  448. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/installments.md +33 -33
  449. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/item-count-distribution.md +34 -34
  450. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/license-chart.md +30 -30
  451. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/license-pie-chart.md +22 -22
  452. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/license-summary.md +22 -22
  453. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/locations.md +43 -43
  454. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-chart.md +37 -37
  455. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-completion-time.md +34 -34
  456. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-mix.md +34 -34
  457. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-value-distribution.md +34 -34
  458. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/payment-methods-disputes.md +38 -38
  459. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/payment-methods-methods.md +36 -36
  460. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/payment-methods.md +37 -37
  461. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-comparison-launch.md +33 -33
  462. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-comparison.md +40 -40
  463. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-detail.md +37 -37
  464. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-sales.md +37 -37
  465. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/refunds-overview.md +37 -37
  466. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/retention-snapshots-step.md +45 -45
  467. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/sales-growth-chart.md +35 -35
  468. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/save-channel-rules.md +73 -73
  469. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/source-channels.md +37 -37
  470. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/sources.md +49 -49
  471. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-cohorts.md +33 -33
  472. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-health.md +30 -30
  473. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-rebuys.md +37 -37
  474. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-retention.md +34 -34
  475. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-variations.md +22 -22
  476. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscriptions-overview.md +37 -37
  477. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/weeks-between-refund.md +34 -34
  478. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/assign-role.md +48 -48
  479. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/delete-role-assignment.md +47 -47
  480. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/get-role.md +25 -25
  481. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/list-managers.md +18 -18
  482. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/list-roles.md +18 -18
  483. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/search-users.md +25 -25
  484. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/update-role.md +43 -43
  485. package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/create-saved-view.md +106 -106
  486. package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/delete-saved-view.md +26 -26
  487. package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/list-saved-views.md +25 -25
  488. package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/update-saved-view.md +83 -83
  489. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/activate-payment-addon.md +44 -44
  490. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/activate-plugin-addon.md +44 -44
  491. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/change-storage-driver-status.md +56 -56
  492. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/check-paypal-webhook.md +26 -26
  493. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/create-storage-bucket.md +63 -63
  494. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/disconnect-payment-method.md +55 -55
  495. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/exchange-paypal-seller-auth-token.md +62 -62
  496. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-active-storage-drivers.md +20 -20
  497. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-checkout-fields.md +22 -22
  498. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-email-shortcodes.md +20 -20
  499. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-mcp-config-snippets.md +26 -26
  500. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-mcp-status.md +20 -20
  501. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-module-settings.md +20 -20
  502. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-payment-method-connection-info.md +26 -26
  503. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-payment-method-settings.md +26 -26
  504. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-permissions.md +22 -22
  505. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-plugin-addons.md +20 -20
  506. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-storage-driver-settings.md +27 -27
  507. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-store-settings.md +26 -26
  508. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/install-mcp-adapter.md +21 -21
  509. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/install-payment-addon.md +60 -60
  510. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/install-plugin-addon.md +64 -64
  511. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/list-all-payment-methods.md +20 -20
  512. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/list-all-storage-drivers.md +20 -20
  513. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/list-storage-buckets.md +67 -67
  514. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/reorder-payment-methods.md +55 -55
  515. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/reset-storage-driver-settings.md +45 -45
  516. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-checkout-fields.md +133 -133
  517. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-confirmation-settings.md +68 -68
  518. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-module-settings.md +68 -68
  519. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-payment-method-design.md +67 -67
  520. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-payment-method-settings.md +58 -58
  521. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-permissions.md +68 -68
  522. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-storage-driver-settings.md +62 -62
  523. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-store-settings.md +239 -239
  524. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/setup-paypal-webhook.md +48 -48
  525. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/toggle-mcp.md +40 -40
  526. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/verify-storage-driver-connection.md +62 -62
  527. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/verify-turnstile-keys.md +55 -55
  528. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/create-shipping-class.md +73 -73
  529. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/create-shipping-method.md +110 -110
  530. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/create-shipping-zone.md +56 -56
  531. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/delete-shipping-class.md +29 -29
  532. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/delete-shipping-method.md +29 -29
  533. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/delete-shipping-zone.md +29 -29
  534. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-class-profile.md +30 -30
  535. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-class.md +29 -29
  536. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-packages.md +22 -22
  537. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-zone.md +27 -27
  538. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-zone-countries.md +22 -22
  539. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-zone-states.md +28 -28
  540. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/list-shipping-classes.md +31 -31
  541. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/list-shipping-zones.md +31 -31
  542. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/save-shipping-packages.md +112 -112
  543. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-shipping-class.md +79 -79
  544. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-shipping-method.md +113 -113
  545. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-shipping-zone.md +62 -62
  546. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-zone-order.md +52 -52
  547. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/cancel-auto-renew.md +30 -30
  548. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/cancel-subscription.md +52 -52
  549. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/confirm-subscription-switch.md +70 -70
  550. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/fetch-subscription-remote.md +28 -28
  551. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/generate-early-payment-link.md +29 -29
  552. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-customer-subscription.md +27 -27
  553. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-or-create-plan.md +69 -69
  554. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-setup-intent-attempts.md +30 -30
  555. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-subscription.md +28 -28
  556. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/initiate-early-payment.md +31 -31
  557. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/list-customer-subscriptions.md +27 -27
  558. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/list-subscriptions.md +39 -39
  559. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/pause-subscription.md +28 -28
  560. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/reactivate-subscription.md +28 -28
  561. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/resume-subscription.md +28 -28
  562. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/switch-payment-method.md +70 -70
  563. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/update-payment-method.md +69 -69
  564. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/update-vendor-ids.md +56 -56
  565. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/verify-vendor-ids.md +56 -56
  566. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/create-tax-class.md +51 -51
  567. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/create-tax-rate.md +117 -117
  568. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-product-override.md +27 -27
  569. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-shipping-tax-override.md +27 -27
  570. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-tax-class.md +28 -28
  571. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-tax-rate.md +27 -27
  572. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-country-tax-id.md +27 -27
  573. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-country-tax-rates.md +28 -28
  574. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-eu-vat-product-overrides.md +20 -20
  575. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-oss-country-rates.md +20 -20
  576. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-preconfigured-tax-rates.md +20 -20
  577. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-product-overrides.md +27 -27
  578. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-tax-settings.md +20 -20
  579. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/list-all-tax-rates.md +20 -20
  580. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/list-tax-classes.md +20 -20
  581. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/list-tax-records.md +37 -37
  582. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/mark-taxes-as-filed.md +58 -58
  583. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/reset-eu-vat-rates.md +21 -21
  584. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-configured-countries.md +57 -57
  585. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-country-tax-id.md +50 -50
  586. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-eu-vat-cross-border-settings.md +127 -127
  587. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-oss-country-rates.md +100 -100
  588. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-product-override.md +110 -110
  589. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-shipping-tax-override.md +52 -52
  590. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-tax-settings.md +166 -166
  591. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/update-country-status.md +54 -54
  592. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/update-tax-rate.md +116 -116
  593. package/dist/skills/fluentcart-developer/references/restapi/order-bumps.md +433 -433
  594. package/dist/skills/fluentcart-developer/references/restapi/orders.md +1212 -1212
  595. package/dist/skills/fluentcart-developer/references/restapi/pdf-templates.md +212 -212
  596. package/dist/skills/fluentcart-developer/references/restapi/products.md +2485 -2485
  597. package/dist/skills/fluentcart-developer/references/restapi/public-shop.md +191 -191
  598. package/dist/skills/fluentcart-developer/references/restapi/reports.md +3773 -3773
  599. package/dist/skills/fluentcart-developer/references/restapi/roles.md +403 -403
  600. package/dist/skills/fluentcart-developer/references/restapi/saved-views.md +136 -136
  601. package/dist/skills/fluentcart-developer/references/restapi/settings.md +1423 -1423
  602. package/dist/skills/fluentcart-developer/references/restapi/shipping.md +905 -905
  603. package/dist/skills/fluentcart-developer/references/restapi/subscriptions.md +1169 -1169
  604. package/dist/skills/fluentcart-developer/references/restapi/tax.md +1551 -1551
  605. package/dist/skills/fluentcart-developer/references/restapi.md +127 -127
  606. package/dist/skills/fluentcart-developer/scripts/cli.js +1 -1
  607. package/dist/version.d.ts +1 -1
  608. package/dist/version.js +1 -1
  609. package/package.json +66 -65
@@ -1,1000 +1,1000 @@
1
- # Integrations API
2
-
3
- Manage third-party integrations, configure integration feeds, and set up product-specific integration settings.
4
-
5
- **Base URL:** `https://your-site.com/wp-json/fluent-cart/v2`
6
-
7
- **Policies:** `IntegrationPolicy` (global), `ProductPolicy` (product-level)
8
-
9
- ---
10
-
11
- ## Global Integrations
12
-
13
- Endpoints for managing available add-ons and their global configuration settings. These control the overall connection and authentication for each integration provider (e.g., FluentCRM, FluentSMTP, Webhooks).
14
-
15
- ---
16
-
17
- ### List Available Add-ons
18
-
19
- GET `/fluent-cart/v2/integration/addons`
20
-
21
- Retrieve the list of all available integration add-ons, including their installation status and metadata.
22
-
23
- - **Permission:** `integrations/view`
24
- - **Controller:** `AddonsController@getAddons`
25
-
26
- #### Parameters
27
-
28
- *This endpoint does not accept any parameters.*
29
-
30
- #### Response
31
-
32
- ```
33
- {
34
- "addons": {
35
- "fluent-crm": {
36
- "installable": "fluent-crm",
37
- "enabled": true,
38
- "title": "FluentCRM",
39
- "logo": "https://example.com/wp-content/plugins/fluent-cart/assets/images/integrations/fluentcrm.svg",
40
- "categories": ["crm", "core", "marketing"],
41
- "description": "The most powerful email marketing automation plugin for WordPress."
42
- },
43
- "fluent-smtp": {
44
- "installable": "fluent-smtp",
45
- "enabled": false,
46
- "title": "FluentSMTP",
47
- "logo": "...",
48
- "categories": ["core", "marketing"],
49
- "description": "A free WordPress SMTP plugin to send emails via multiple providers."
50
- },
51
- "webhook": {
52
- "title": "Webhook",
53
- "description": "Send data anywhere via webhook",
54
- "logo": "...",
55
- "enabled": true,
56
- "is_pro": true,
57
- "is_pro_active": true,
58
- "categories": ["core"]
59
- }
60
- }
61
- }
62
- ```
63
-
64
- **Add-on Object Properties:**
65
-
66
- | Property | Type | Description |
67
- | --- | --- | --- |
68
- | `installable` | string | Plugin slug for WordPress.org installation (absent for pro add-ons) |
69
- | `enabled` | boolean | Whether the add-on's underlying plugin is active |
70
- | `title` | string | Display name of the add-on |
71
- | `logo` | string | URL to the add-on's logo image |
72
- | `categories` | array | Category tags (e.g., `core`, `crm`, `marketing`, `community`, `lms`) |
73
- | `description` | string | Human-readable description |
74
- | `is_pro` | boolean | Whether the add-on requires a Pro license (only present for premium add-ons) |
75
- | `is_pro_active` | boolean | Whether the Pro license is currently active (only present for premium add-ons) |
76
-
77
- #### Example
78
-
79
- ```
80
- curl -X GET "https://example.com/wp-json/fluent-cart/v2/integration/addons" \
81
- -u "username:app_password"
82
- ```
83
-
84
- ---
85
-
86
- ### Get Global Integration Settings
87
-
88
- GET `/fluent-cart/v2/integration/global-settings`
89
-
90
- Retrieve global configuration settings for a specific integration provider. Used to get API key configuration, authentication fields, and current saved values.
91
-
92
- - **Permission:** `integrations/view`
93
- - **Controller:** `IntegrationController@getGlobalSettings`
94
-
95
- #### Parameters
96
-
97
- | Parameter | Type | Location | Required | Description |
98
- | --- | --- | --- | --- | --- |
99
- | `settings_key` | string | query | Yes | The integration provider key (e.g., `fluent-crm`, `webhook`) |
100
-
101
- #### Response
102
-
103
- ```
104
- {
105
- "integration": {
106
- "api_key": "••••••••",
107
- "api_url": "https://example.com",
108
- "status": true
109
- },
110
- "settings": {
111
- "fields": [
112
- {
113
- "key": "api_key",
114
- "label": "API Key",
115
- "type": "password",
116
- "required": true
117
- }
118
- ],
119
- "save_button_text": "Save Settings",
120
- "valid_message": "Your API Key is valid",
121
- "invalid_message": "Your API Key is not valid"
122
- }
123
- }
124
- ```
125
-
126
- #### Example
127
-
128
- ```
129
- curl -X GET "https://example.com/wp-json/fluent-cart/v2/integration/global-settings?settings_key=fluent-crm" \
130
- -u "username:app_password"
131
- ```
132
-
133
- ---
134
-
135
- ### Save Global Integration Settings
136
-
137
- POST `/fluent-cart/v2/integration/global-settings`
138
-
139
- Save or update global configuration settings for a specific integration provider (e.g., API keys, authentication credentials).
140
-
141
- - **Permission:** `integrations/manage`
142
- - **Controller:** `IntegrationController@setGlobalSettings`
143
-
144
- #### Parameters
145
-
146
- | Parameter | Type | Location | Required | Description |
147
- | --- | --- | --- | --- | --- |
148
- | `settings_key` | string | body | Yes | The integration provider key |
149
- | `integration` | object | body | Yes | The settings data to save (fields vary by provider) |
150
-
151
- #### Response
152
-
153
- The response is handled by the integration provider via the `fluent_cart/integration/save_global_integration_settings_{settings_key}` hook. A typical success response:
154
-
155
- ```
156
- {
157
- "message": "Settings saved successfully",
158
- "status": true
159
- }
160
- ```
161
-
162
- #### Example
163
-
164
- ```
165
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/integration/global-settings" \
166
- -u "username:app_password" \
167
- -H "Content-Type: application/json" \
168
- -d '{
169
- "settings_key": "fluent-crm",
170
- "integration": {
171
- "api_key": "your-api-key",
172
- "api_url": "https://example.com"
173
- }
174
- }'
175
- ```
176
-
177
- ---
178
-
179
- ### Install and Activate Add-on Plugin
180
-
181
- POST `/fluent-cart/v2/integration/feed/install-plugin`
182
-
183
- Install and activate a supported integration plugin from the WordPress.org repository. Only whitelisted plugins can be installed through this endpoint.
184
-
185
- - **Permission:** `integrations/manage`
186
- - **Controller:** `AddonsController@installAndActivate`
187
-
188
- #### Parameters
189
-
190
- | Parameter | Type | Location | Required | Description |
191
- | --- | --- | --- | --- | --- |
192
- | `addon` | string | body | Yes | The plugin slug to install. Allowed values: `fluent-crm`, `fluent-smtp`, `fluent-community`, `fluent-security`, `fluentform`, `fluent-support` |
193
-
194
- #### Response
195
-
196
- ```
197
- {
198
- "message": "Addon installation started successfully.",
199
- "redirect": "https://example.com/wp-admin/admin.php?page=fluent-cart#/integrations"
200
- }
201
- ```
202
-
203
- #### Error Response
204
-
205
- ```
206
- {
207
- "message": "This addon cannot be installed at this time"
208
- }
209
- ```
210
-
211
- #### Example
212
-
213
- ```
214
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/integration/feed/install-plugin" \
215
- -u "username:app_password" \
216
- -H "Content-Type: application/json" \
217
- -d '{"addon": "fluent-crm"}'
218
- ```
219
-
220
- ---
221
-
222
- ## Integration Feeds
223
-
224
- Integration feeds define the data mapping and conditional logic that connects FluentCart order events to third-party services. Feeds are configured at the global level and fire on all matching orders.
225
-
226
- ---
227
-
228
- ### List Global Integration Feeds
229
-
230
- GET `/fluent-cart/v2/integration/global-feeds`
231
-
232
- Retrieve all configured global integration feeds along with the list of available integrations that support global scope.
233
-
234
- - **Permission:** `integrations/view`
235
- - **Controller:** `IntegrationController@getFeeds`
236
-
237
- #### Parameters
238
-
239
- *This endpoint does not accept any parameters.*
240
-
241
- #### Response
242
-
243
- ```
244
- {
245
- "feeds": [
246
- {
247
- "id": 42,
248
- "name": "Add to FluentCRM list",
249
- "enabled": "yes",
250
- "provider": "fluent-crm",
251
- "feed": {
252
- "name": "Add to FluentCRM list",
253
- "enabled": "yes",
254
- "list_id": "2",
255
- "list_name": "Customers",
256
- "merge_fields": {},
257
- "conditionals": {
258
- "conditions": [],
259
- "status": false,
260
- "type": "all"
261
- }
262
- },
263
- "scope": "global"
264
- }
265
- ],
266
- "available_integrations": {
267
- "fluent-crm": {
268
- "title": "FluentCRM",
269
- "logo": "...",
270
- "enabled": true,
271
- "scopes": ["global", "product"],
272
- "description": "..."
273
- }
274
- },
275
- "all_module_config_url": "https://example.com/wp-admin/admin.php?page=fluent-cart#/integrations"
276
- }
277
- ```
278
-
279
- **Feed Object Properties:**
280
-
281
- | Property | Type | Description |
282
- | --- | --- | --- |
283
- | `id` | integer | Unique feed ID |
284
- | `name` | string | Display name of the feed |
285
- | `enabled` | string | Status: `yes` or `no` |
286
- | `provider` | string | Integration provider key |
287
- | `feed` | object | Full feed configuration data including field mappings and conditionals |
288
- | `scope` | string | Always `global` for this endpoint |
289
-
290
- #### Example
291
-
292
- ```
293
- curl -X GET "https://example.com/wp-json/fluent-cart/v2/integration/global-feeds" \
294
- -u "username:app_password"
295
- ```
296
-
297
- ---
298
-
299
- ### Get Feed Settings
300
-
301
- GET `/fluent-cart/v2/integration/global-feeds/settings`
302
-
303
- Retrieve the settings form schema, saved values, and available shortcodes for a specific integration feed. Used to populate the feed editor when creating or editing a global feed.
304
-
305
- - **Permission:** `integrations/view`
306
- - **Controller:** `IntegrationController@getSettings`
307
-
308
- #### Parameters
309
-
310
- | Parameter | Type | Location | Required | Description |
311
- | --- | --- | --- | --- | --- |
312
- | `integration_name` | string | query | Yes | The integration provider key (e.g., `fluent-crm`, `webhook`) |
313
- | `integration_id` | integer | query | No | The feed ID to load existing settings for editing. Omit to get defaults for a new feed. |
314
-
315
- #### Response
316
-
317
- ```
318
- {
319
- "settings": {
320
- "conditionals": {
321
- "conditions": [],
322
- "status": false,
323
- "type": "all"
324
- },
325
- "enabled": "yes",
326
- "list_id": "",
327
- "list_name": "",
328
- "name": "",
329
- "merge_fields": {}
330
- },
331
- "settings_fields": {
332
- "fields": [
333
- {
334
- "key": "name",
335
- "label": "Feed Name",
336
- "type": "text",
337
- "required": true
338
- },
339
- {
340
- "key": "list_id",
341
- "label": "Contact List",
342
- "type": "select",
343
- "required": true,
344
- "options": []
345
- }
346
- ]
347
- },
348
- "shortcodes": {},
349
- "inputs": {},
350
- "merge_fields": {}
351
- }
352
- ```
353
-
354
- **Response Properties:**
355
-
356
- | Property | Type | Description |
357
- | --- | --- | --- |
358
- | `settings` | object | Current feed settings values (defaults for new, saved values for existing) |
359
- | `settings_fields` | object | Form schema defining the feed editor fields |
360
- | `shortcodes` | object | Available shortcodes for dynamic field mapping |
361
- | `inputs` | object | Checkout input fields available for mapping |
362
- | `merge_fields` | object/boolean | Merge fields for the selected list (if applicable) |
363
-
364
- #### Example
365
-
366
- ```
367
- # Get defaults for a new feed
368
- curl -X GET "https://example.com/wp-json/fluent-cart/v2/integration/global-feeds/settings?integration_name=fluent-crm" \
369
- -u "username:app_password"
370
-
371
- # Load existing feed for editing
372
- curl -X GET "https://example.com/wp-json/fluent-cart/v2/integration/global-feeds/settings?integration_name=fluent-crm&integration_id=42" \
373
- -u "username:app_password"
374
- ```
375
-
376
- ---
377
-
378
- ### Save Feed Settings
379
-
380
- POST `/fluent-cart/v2/integration/global-feeds/settings`
381
-
382
- Create a new integration feed or update an existing one. Validates required fields defined by the integration provider before saving.
383
-
384
- - **Permission:** `integrations/manage`
385
- - **Controller:** `IntegrationController@saveSettings`
386
-
387
- #### Parameters
388
-
389
- | Parameter | Type | Location | Required | Description |
390
- | --- | --- | --- | --- | --- |
391
- | `integration_name` | string | body | Yes | The integration provider key (e.g., `fluent-crm`) |
392
- | `integration_id` | integer | body | No | The existing feed ID to update. Omit to create a new feed. |
393
- | `integration` | string (JSON) | body | Yes | JSON-encoded feed settings data containing field mappings, conditionals, and configuration |
394
-
395
- **The `integration` JSON string should contain:**
396
-
397
- | Property | Type | Required | Description |
398
- | --- | --- | --- | --- |
399
- | `name` | string | Yes | Display name for the feed |
400
- | `enabled` | string | Yes | Status: `yes` or `no` |
401
- | `list_id` | string | Varies | Target list ID (provider-specific) |
402
- | `list_name` | string | No | Target list name |
403
- | `merge_fields` | object | No | Field mapping configuration |
404
- | `conditionals` | object | No | Conditional logic settings |
405
-
406
- #### Response
407
-
408
- ```
409
- {
410
- "message": "Integration has been successfully saved",
411
- "integration_id": 42,
412
- "integration_name": "fluent-crm",
413
- "created": true,
414
- "feedData": {
415
- "name": "Add to customers list",
416
- "enabled": "yes",
417
- "list_id": "2",
418
- "merge_fields": {}
419
- }
420
- }
421
- ```
422
-
423
- **Response Properties:**
424
-
425
- | Property | Type | Description |
426
- | --- | --- | --- |
427
- | `message` | string | Success message |
428
- | `integration_id` | integer/null | The feed ID (null for newly created feeds before refresh) |
429
- | `integration_name` | string | The integration provider key |
430
- | `created` | boolean | `true` if a new feed was created, `false` if an existing one was updated |
431
- | `feedData` | object | The validated and saved feed data |
432
-
433
- #### Error Response (Validation)
434
-
435
- ```
436
- {
437
- "message": "Please fill up the required fields:",
438
- "errors": {
439
- "name": "Feed Name is required.",
440
- "list_id": "Contact List is required."
441
- }
442
- }
443
- ```
444
-
445
- #### Example
446
-
447
- ```
448
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/integration/global-feeds/settings" \
449
- -u "username:app_password" \
450
- -H "Content-Type: application/json" \
451
- -d '{
452
- "integration_name": "fluent-crm",
453
- "integration": "{\"name\":\"Add to customers\",\"enabled\":\"yes\",\"list_id\":\"2\",\"list_name\":\"Customers\",\"merge_fields\":{},\"conditionals\":{\"conditions\":[],\"status\":false,\"type\":\"all\"}}"
454
- }'
455
- ```
456
-
457
- ---
458
-
459
- ### Change Feed Status
460
-
461
- POST `/fluent-cart/v2/integration/global-feeds/change-status/{integration_id}`
462
-
463
- Toggle a global integration feed on or off without modifying its configuration.
464
-
465
- - **Permission:** `integrations/manage`
466
- - **Controller:** `IntegrationController@changeStatus`
467
-
468
- #### Parameters
469
-
470
- | Parameter | Type | Location | Required | Description |
471
- | --- | --- | --- | --- | --- |
472
- | `integration_id` | integer | path | Yes | The feed ID to update |
473
- | `status` | string | body | Yes | New status: `yes` (enable) or `no` (disable) |
474
-
475
- #### Response
476
-
477
- ```
478
- {
479
- "message": "Integration status updated successfully.",
480
- "meta": {
481
- "name": "Add to customers list",
482
- "enabled": "yes",
483
- "list_id": "2",
484
- "merge_fields": {}
485
- }
486
- }
487
- ```
488
-
489
- #### Example
490
-
491
- ```
492
- # Disable a feed
493
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/integration/global-feeds/change-status/42" \
494
- -u "username:app_password" \
495
- -H "Content-Type: application/json" \
496
- -d '{"status": "no"}'
497
- ```
498
-
499
- ---
500
-
501
- ### Delete Feed
502
-
503
- DELETE `/fluent-cart/v2/integration/global-feeds/{integration_id}`
504
-
505
- Permanently delete a global integration feed.
506
-
507
- - **Permission:** `integrations/delete`
508
- - **Controller:** `IntegrationController@deleteSettings`
509
-
510
- #### Parameters
511
-
512
- | Parameter | Type | Location | Required | Description |
513
- | --- | --- | --- | --- | --- |
514
- | `integration_id` | integer | path | Yes | The feed ID to delete |
515
-
516
- #### Response
517
-
518
- ```
519
- {
520
- "message": "Integration has been deleted successfully.",
521
- "id": 42
522
- }
523
- ```
524
-
525
- #### Example
526
-
527
- ```
528
- curl -X DELETE "https://example.com/wp-json/fluent-cart/v2/integration/global-feeds/42" \
529
- -u "username:app_password"
530
- ```
531
-
532
- ---
533
-
534
- ### Get Feed Merge Fields (Lists)
535
-
536
- GET `/fluent-cart/v2/integration/feed/lists`
537
-
538
- Retrieve the merge fields (field mapping options) for a specific integration provider and list. Called when a user selects a target list in the feed editor to load the available mapping fields.
539
-
540
- - **Permission:** `integrations/view`
541
- - **Controller:** `IntegrationController@lists`
542
-
543
- #### Parameters
544
-
545
- | Parameter | Type | Location | Required | Description |
546
- | --- | --- | --- | --- | --- |
547
- | `integration_name` | string | query | Yes | The integration provider key (e.g., `fluent-crm`) |
548
- | `list_id` | string | query | No | The target list ID to fetch merge fields for |
549
-
550
- #### Response
551
-
552
- ```
553
- {
554
- "merge_fields": [
555
- {
556
- "key": "email",
557
- "label": "Email",
558
- "type": "text",
559
- "required": true
560
- },
561
- {
562
- "key": "first_name",
563
- "label": "First Name",
564
- "type": "text",
565
- "required": false
566
- },
567
- {
568
- "key": "last_name",
569
- "label": "Last Name",
570
- "type": "text",
571
- "required": false
572
- }
573
- ]
574
- }
575
- ```
576
-
577
- #### Example
578
-
579
- ```
580
- curl -X GET "https://example.com/wp-json/fluent-cart/v2/integration/feed/lists?integration_name=fluent-crm&list_id=2" \
581
- -u "username:app_password"
582
- ```
583
-
584
- ---
585
-
586
- ### Get Dynamic Options
587
-
588
- GET `/fluent-cart/v2/integration/feed/dynamic_options`
589
-
590
- Fetch dynamic select options for integration feed fields. Supports WordPress post type searches and provider-specific dynamic option lookups. Used by the feed editor to populate dropdown fields asynchronously.
591
-
592
- - **Permission:** `integrations/view`
593
- - **Controller:** `IntegrationController@getDynamicOptions`
594
-
595
- #### Parameters
596
-
597
- | Parameter | Type | Location | Required | Description |
598
- | --- | --- | --- | --- | --- |
599
- | `option_key` | string | query | Yes | The type of options to fetch (e.g., `post_type` for WordPress posts, or a provider-specific key) |
600
- | `sub_option_key` | string | query | Conditional | Required when `option_key` is `post_type`. Specifies the post type slug (e.g., `post`, `page`, `fluent-products`) |
601
- | `search` | string | query | No | Search term to filter results |
602
- | `values` | array | query | No | Array of pre-selected IDs to ensure they are included in the response |
603
-
604
- #### Response
605
-
606
- ```
607
- {
608
- "options": [
609
- {
610
- "id": "123",
611
- "title": "Example Product"
612
- },
613
- {
614
- "id": "456",
615
- "title": "Another Product"
616
- }
617
- ]
618
- }
619
- ```
620
-
621
- #### Example
622
-
623
- ```
624
- # Search WordPress posts by post type
625
- curl -X GET "https://example.com/wp-json/fluent-cart/v2/integration/feed/dynamic_options?option_key=post_type&sub_option_key=page&search=about" \
626
- -u "username:app_password"
627
-
628
- # Fetch provider-specific options
629
- curl -X GET "https://example.com/wp-json/fluent-cart/v2/integration/feed/dynamic_options?option_key=fluentcrm_tags&search=vip" \
630
- -u "username:app_password"
631
- ```
632
-
633
- ---
634
-
635
- ### Chained Data Request
636
-
637
- POST `/fluent-cart/v2/integration/feed/chained`
638
-
639
- Handle chained/dependent data requests for integration feeds. Used when selecting a value in one feed field needs to dynamically load options for another field. The behavior is entirely handled by the integration provider through the `fluent_cart/integration/chained_{route}` hook.
640
-
641
- - **Permission:** `integrations/manage`
642
- - **Controller:** `IntegrationController@chained`
643
-
644
- #### Parameters
645
-
646
- | Parameter | Type | Location | Required | Description |
647
- | --- | --- | --- | --- | --- |
648
- | `route` | string | body | Yes | The chained route identifier, determines which integration provider handles the request |
649
- | *(additional)* | mixed | body | Varies | Additional parameters depend on the integration provider and the chained route |
650
-
651
- #### Response
652
-
653
- The response format depends on the integration provider handling the chained route. A typical response:
654
-
655
- ```
656
- {
657
- "options": [
658
- {
659
- "id": "1",
660
- "label": "Option A"
661
- },
662
- {
663
- "id": "2",
664
- "label": "Option B"
665
- }
666
- ]
667
- }
668
- ```
669
-
670
- #### Example
671
-
672
- ```
673
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/integration/feed/chained" \
674
- -u "username:app_password" \
675
- -H "Content-Type: application/json" \
676
- -d '{
677
- "route": "fluent-crm",
678
- "list_id": "2"
679
- }'
680
- ```
681
-
682
- ---
683
-
684
- ## Product Integrations
685
-
686
- Product-level integrations allow you to configure integration feeds that only fire for orders containing a specific product. This enables per-product customization of CRM tagging, webhook payloads, and other integration behaviors.
687
-
688
- **Base URL:** `https://your-site.com/wp-json/fluent-cart/v2/products/{product_id}/integrations`
689
-
690
- **Policy:** `ProductPolicy`
691
-
692
- ---
693
-
694
- ### List Product Integration Feeds
695
-
696
- GET `/fluent-cart/v2/products/{productId}/integrations`
697
-
698
- Retrieve all integration feeds configured for a specific product, along with available product-scoped integrations.
699
-
700
- - **Permission:** `products/view`
701
- - **Controller:** `ProductIntegrationsController@getFeeds`
702
-
703
- #### Parameters
704
-
705
- | Parameter | Type | Location | Required | Description |
706
- | --- | --- | --- | --- | --- |
707
- | `productId` | integer | path | Yes | The product ID |
708
-
709
- #### Response
710
-
711
- ```
712
- {
713
- "feeds": [
714
- {
715
- "id": 15,
716
- "name": "Tag VIP buyers",
717
- "enabled": "yes",
718
- "provider": "fluent-crm",
719
- "feed": {
720
- "name": "Tag VIP buyers",
721
- "enabled": "yes",
722
- "list_id": "3",
723
- "list_name": "VIP Customers",
724
- "merge_fields": {},
725
- "conditional_variation_ids": [101, 102],
726
- "conditionals": {
727
- "conditions": [],
728
- "status": false,
729
- "type": "all"
730
- }
731
- },
732
- "scope": "product"
733
- }
734
- ],
735
- "available_integrations": {
736
- "fluent-crm": {
737
- "title": "FluentCRM",
738
- "logo": "...",
739
- "enabled": true,
740
- "scopes": ["global", "product"]
741
- }
742
- },
743
- "all_module_config_url": "https://example.com/wp-admin/admin.php?page=fluent-cart#/integrations"
744
- }
745
- ```
746
-
747
- #### Example
748
-
749
- ```
750
- curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/123/integrations" \
751
- -u "username:app_password"
752
- ```
753
-
754
- ---
755
-
756
- ### Get Product Integration Settings
757
-
758
- GET `/fluent-cart/v2/products/{product_id}/integrations/{integration_name}/settings`
759
-
760
- Retrieve the feed editor settings for a specific integration provider, scoped to a product. Returns form schema, saved values, available shortcodes, and the product's variation list for conditional targeting.
761
-
762
- - **Permission:** `products/view`
763
- - **Controller:** `ProductIntegrationsController@getProductIntegrationSettings`
764
-
765
- #### Parameters
766
-
767
- | Parameter | Type | Location | Required | Description |
768
- | --- | --- | --- | --- | --- |
769
- | `product_id` | integer | path | Yes | The product ID |
770
- | `integration_name` | string | path | Yes | The integration provider key (e.g., `fluent-crm`) |
771
- | `integration_id` | integer | query | No | The existing feed ID to load for editing. Omit for new feed defaults. |
772
-
773
- #### Response
774
-
775
- ```
776
- {
777
- "settings": {
778
- "conditionals": {
779
- "conditions": [],
780
- "status": false,
781
- "type": "all"
782
- },
783
- "enabled": "yes",
784
- "list_id": "",
785
- "list_name": "",
786
- "name": "",
787
- "merge_fields": {},
788
- "conditional_variation_ids": []
789
- },
790
- "settings_fields": {
791
- "fields": [
792
- {
793
- "key": "name",
794
- "label": "Feed Name",
795
- "type": "text",
796
- "required": true
797
- }
798
- ]
799
- },
800
- "shortcodes": {},
801
- "inputs": {},
802
- "merge_fields": {},
803
- "product_variations": [
804
- {
805
- "id": 101,
806
- "title": "Basic Plan"
807
- },
808
- {
809
- "id": 102,
810
- "title": "Pro Plan"
811
- }
812
- ],
813
- "scope": "product"
814
- }
815
- ```
816
-
817
- **Additional Properties (compared to global feed settings):**
818
-
819
- | Property | Type | Description |
820
- | --- | --- | --- |
821
- | `product_variations` | array | List of the product's variations (`id` and `title`), used for targeting specific variations |
822
- | `scope` | string | Always `product` for this endpoint |
823
- | `settings.conditional_variation_ids` | array | Array of variation IDs this feed should apply to (empty means all variations) |
824
-
825
- #### Example
826
-
827
- ```
828
- # Get defaults for a new product feed
829
- curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/123/integrations/fluent-crm/settings" \
830
- -u "username:app_password"
831
-
832
- # Load existing product feed for editing
833
- curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/123/integrations/fluent-crm/settings?integration_id=15" \
834
- -u "username:app_password"
835
- ```
836
-
837
- ---
838
-
839
- ### Save Product Integration Feed
840
-
841
- POST `/fluent-cart/v2/products/{product_id}/integrations`
842
-
843
- Create a new product-level integration feed or update an existing one. Validates required fields and associates the feed with the specified product.
844
-
845
- - **Permission:** `products/edit`
846
- - **Controller:** `ProductIntegrationsController@saveProductIntegration`
847
-
848
- #### Parameters
849
-
850
- | Parameter | Type | Location | Required | Description |
851
- | --- | --- | --- | --- | --- |
852
- | `product_id` | integer | path | Yes | The product ID |
853
- | `integration_name` | string | body | Yes | The integration provider key (e.g., `fluent-crm`) |
854
- | `integration_id` | integer | body | No | Existing feed ID to update. Omit to create a new feed. |
855
- | `integration` | string (JSON) | body | Yes | JSON-encoded feed settings data |
856
-
857
- **The `integration` JSON string should contain:**
858
-
859
- | Property | Type | Required | Description |
860
- | --- | --- | --- | --- |
861
- | `name` | string | Yes | Display name for the feed |
862
- | `enabled` | string | Yes | Status: `yes` or `no` |
863
- | `list_id` | string | Varies | Target list ID (provider-specific) |
864
- | `merge_fields` | object | No | Field mapping configuration |
865
- | `conditional_variation_ids` | array | No | Array of variation IDs to restrict this feed to. Empty array means all variations. |
866
- | `conditionals` | object | No | Conditional logic settings |
867
-
868
- #### Response
869
-
870
- ```
871
- {
872
- "message": "Integration has been successfully saved",
873
- "integration_id": 15,
874
- "integration_name": "fluent-crm",
875
- "created": true,
876
- "feedData": {
877
- "name": "Tag VIP buyers",
878
- "enabled": "yes",
879
- "list_id": "3",
880
- "conditional_variation_ids": [101]
881
- }
882
- }
883
- ```
884
-
885
- #### Error Response
886
-
887
- ```
888
- {
889
- "message": "Product not found"
890
- }
891
- ```
892
-
893
- ```
894
- {
895
- "message": "Please fill up the required fields:",
896
- "errors": {
897
- "name": "Feed Name is required."
898
- }
899
- }
900
- ```
901
-
902
- #### Example
903
-
904
- ```
905
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/123/integrations" \
906
- -u "username:app_password" \
907
- -H "Content-Type: application/json" \
908
- -d '{
909
- "integration_name": "fluent-crm",
910
- "integration": "{\"name\":\"Tag VIP buyers\",\"enabled\":\"yes\",\"list_id\":\"3\",\"conditional_variation_ids\":[101],\"merge_fields\":{},\"conditionals\":{\"conditions\":[],\"status\":false,\"type\":\"all\"}}"
911
- }'
912
- ```
913
-
914
- ---
915
-
916
- ### Change Product Feed Status
917
-
918
- POST `/fluent-cart/v2/products/{product_id}/integrations/feed/change-status`
919
-
920
- Toggle a product-level integration feed on or off.
921
-
922
- - **Permission:** `products/edit`
923
- - **Controller:** `ProductIntegrationsController@changeStatus`
924
-
925
- #### Parameters
926
-
927
- | Parameter | Type | Location | Required | Description |
928
- | --- | --- | --- | --- | --- |
929
- | `product_id` | integer | path | Yes | The product ID (from URL) |
930
- | `product_id` | integer | body | Yes | The product ID (must also be provided in the request body) |
931
- | `notification_id` | integer | body | Yes | The feed ID to toggle |
932
- | `status` | string | body | Yes | New status: `yes` (enable) or `no` (disable) |
933
-
934
- #### Response
935
-
936
- ```
937
- {
938
- "message": "Integration status has been updated"
939
- }
940
- ```
941
-
942
- #### Error Response
943
-
944
- ```
945
- {
946
- "message": "Product ID and Notification ID are required"
947
- }
948
- ```
949
-
950
- ```
951
- {
952
- "message": "Notification not found"
953
- }
954
- ```
955
-
956
- #### Example
957
-
958
- ```
959
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/123/integrations/feed/change-status" \
960
- -u "username:app_password" \
961
- -H "Content-Type: application/json" \
962
- -d '{
963
- "product_id": 123,
964
- "notification_id": 15,
965
- "status": "no"
966
- }'
967
- ```
968
-
969
- ---
970
-
971
- ### Delete Product Integration Feed
972
-
973
- DELETE `/fluent-cart/v2/products/{product_id}/integrations/{integration_id}`
974
-
975
- Permanently delete a product-level integration feed.
976
-
977
- - **Permission:** `products/delete`
978
- - **Controller:** `ProductIntegrationsController@deleteProductIntegration`
979
-
980
- #### Parameters
981
-
982
- | Parameter | Type | Location | Required | Description |
983
- | --- | --- | --- | --- | --- |
984
- | `product_id` | integer | path | Yes | The product ID |
985
- | `integration_id` | integer | path | Yes | The feed ID to delete |
986
-
987
- #### Response
988
-
989
- ```
990
- {
991
- "message": "Integration deleted successfully"
992
- }
993
- ```
994
-
995
- #### Example
996
-
997
- ```
998
- curl -X DELETE "https://example.com/wp-json/fluent-cart/v2/products/123/integrations/15" \
999
- -u "username:app_password"
1000
- ```
1
+ # Integrations API
2
+
3
+ Manage third-party integrations, configure integration feeds, and set up product-specific integration settings.
4
+
5
+ **Base URL:** `https://your-site.com/wp-json/fluent-cart/v2`
6
+
7
+ **Policies:** `IntegrationPolicy` (global), `ProductPolicy` (product-level)
8
+
9
+ ---
10
+
11
+ ## Global Integrations
12
+
13
+ Endpoints for managing available add-ons and their global configuration settings. These control the overall connection and authentication for each integration provider (e.g., FluentCRM, FluentSMTP, Webhooks).
14
+
15
+ ---
16
+
17
+ ### List Available Add-ons
18
+
19
+ GET `/fluent-cart/v2/integration/addons`
20
+
21
+ Retrieve the list of all available integration add-ons, including their installation status and metadata.
22
+
23
+ - **Permission:** `integrations/view`
24
+ - **Controller:** `AddonsController@getAddons`
25
+
26
+ #### Parameters
27
+
28
+ *This endpoint does not accept any parameters.*
29
+
30
+ #### Response
31
+
32
+ ```
33
+ {
34
+ "addons": {
35
+ "fluent-crm": {
36
+ "installable": "fluent-crm",
37
+ "enabled": true,
38
+ "title": "FluentCRM",
39
+ "logo": "https://example.com/wp-content/plugins/fluent-cart/assets/images/integrations/fluentcrm.svg",
40
+ "categories": ["crm", "core", "marketing"],
41
+ "description": "The most powerful email marketing automation plugin for WordPress."
42
+ },
43
+ "fluent-smtp": {
44
+ "installable": "fluent-smtp",
45
+ "enabled": false,
46
+ "title": "FluentSMTP",
47
+ "logo": "...",
48
+ "categories": ["core", "marketing"],
49
+ "description": "A free WordPress SMTP plugin to send emails via multiple providers."
50
+ },
51
+ "webhook": {
52
+ "title": "Webhook",
53
+ "description": "Send data anywhere via webhook",
54
+ "logo": "...",
55
+ "enabled": true,
56
+ "is_pro": true,
57
+ "is_pro_active": true,
58
+ "categories": ["core"]
59
+ }
60
+ }
61
+ }
62
+ ```
63
+
64
+ **Add-on Object Properties:**
65
+
66
+ | Property | Type | Description |
67
+ | --- | --- | --- |
68
+ | `installable` | string | Plugin slug for WordPress.org installation (absent for pro add-ons) |
69
+ | `enabled` | boolean | Whether the add-on's underlying plugin is active |
70
+ | `title` | string | Display name of the add-on |
71
+ | `logo` | string | URL to the add-on's logo image |
72
+ | `categories` | array | Category tags (e.g., `core`, `crm`, `marketing`, `community`, `lms`) |
73
+ | `description` | string | Human-readable description |
74
+ | `is_pro` | boolean | Whether the add-on requires a Pro license (only present for premium add-ons) |
75
+ | `is_pro_active` | boolean | Whether the Pro license is currently active (only present for premium add-ons) |
76
+
77
+ #### Example
78
+
79
+ ```
80
+ curl -X GET "https://example.com/wp-json/fluent-cart/v2/integration/addons" \
81
+ -u "username:app_password"
82
+ ```
83
+
84
+ ---
85
+
86
+ ### Get Global Integration Settings
87
+
88
+ GET `/fluent-cart/v2/integration/global-settings`
89
+
90
+ Retrieve global configuration settings for a specific integration provider. Used to get API key configuration, authentication fields, and current saved values.
91
+
92
+ - **Permission:** `integrations/view`
93
+ - **Controller:** `IntegrationController@getGlobalSettings`
94
+
95
+ #### Parameters
96
+
97
+ | Parameter | Type | Location | Required | Description |
98
+ | --- | --- | --- | --- | --- |
99
+ | `settings_key` | string | query | Yes | The integration provider key (e.g., `fluent-crm`, `webhook`) |
100
+
101
+ #### Response
102
+
103
+ ```
104
+ {
105
+ "integration": {
106
+ "api_key": "••••••••",
107
+ "api_url": "https://example.com",
108
+ "status": true
109
+ },
110
+ "settings": {
111
+ "fields": [
112
+ {
113
+ "key": "api_key",
114
+ "label": "API Key",
115
+ "type": "password",
116
+ "required": true
117
+ }
118
+ ],
119
+ "save_button_text": "Save Settings",
120
+ "valid_message": "Your API Key is valid",
121
+ "invalid_message": "Your API Key is not valid"
122
+ }
123
+ }
124
+ ```
125
+
126
+ #### Example
127
+
128
+ ```
129
+ curl -X GET "https://example.com/wp-json/fluent-cart/v2/integration/global-settings?settings_key=fluent-crm" \
130
+ -u "username:app_password"
131
+ ```
132
+
133
+ ---
134
+
135
+ ### Save Global Integration Settings
136
+
137
+ POST `/fluent-cart/v2/integration/global-settings`
138
+
139
+ Save or update global configuration settings for a specific integration provider (e.g., API keys, authentication credentials).
140
+
141
+ - **Permission:** `integrations/manage`
142
+ - **Controller:** `IntegrationController@setGlobalSettings`
143
+
144
+ #### Parameters
145
+
146
+ | Parameter | Type | Location | Required | Description |
147
+ | --- | --- | --- | --- | --- |
148
+ | `settings_key` | string | body | Yes | The integration provider key |
149
+ | `integration` | object | body | Yes | The settings data to save (fields vary by provider) |
150
+
151
+ #### Response
152
+
153
+ The response is handled by the integration provider via the `fluent_cart/integration/save_global_integration_settings_{settings_key}` hook. A typical success response:
154
+
155
+ ```
156
+ {
157
+ "message": "Settings saved successfully",
158
+ "status": true
159
+ }
160
+ ```
161
+
162
+ #### Example
163
+
164
+ ```
165
+ curl -X POST "https://example.com/wp-json/fluent-cart/v2/integration/global-settings" \
166
+ -u "username:app_password" \
167
+ -H "Content-Type: application/json" \
168
+ -d '{
169
+ "settings_key": "fluent-crm",
170
+ "integration": {
171
+ "api_key": "your-api-key",
172
+ "api_url": "https://example.com"
173
+ }
174
+ }'
175
+ ```
176
+
177
+ ---
178
+
179
+ ### Install and Activate Add-on Plugin
180
+
181
+ POST `/fluent-cart/v2/integration/feed/install-plugin`
182
+
183
+ Install and activate a supported integration plugin from the WordPress.org repository. Only whitelisted plugins can be installed through this endpoint.
184
+
185
+ - **Permission:** `integrations/manage`
186
+ - **Controller:** `AddonsController@installAndActivate`
187
+
188
+ #### Parameters
189
+
190
+ | Parameter | Type | Location | Required | Description |
191
+ | --- | --- | --- | --- | --- |
192
+ | `addon` | string | body | Yes | The plugin slug to install. Allowed values: `fluent-crm`, `fluent-smtp`, `fluent-community`, `fluent-security`, `fluentform`, `fluent-support` |
193
+
194
+ #### Response
195
+
196
+ ```
197
+ {
198
+ "message": "Addon installation started successfully.",
199
+ "redirect": "https://example.com/wp-admin/admin.php?page=fluent-cart#/integrations"
200
+ }
201
+ ```
202
+
203
+ #### Error Response
204
+
205
+ ```
206
+ {
207
+ "message": "This addon cannot be installed at this time"
208
+ }
209
+ ```
210
+
211
+ #### Example
212
+
213
+ ```
214
+ curl -X POST "https://example.com/wp-json/fluent-cart/v2/integration/feed/install-plugin" \
215
+ -u "username:app_password" \
216
+ -H "Content-Type: application/json" \
217
+ -d '{"addon": "fluent-crm"}'
218
+ ```
219
+
220
+ ---
221
+
222
+ ## Integration Feeds
223
+
224
+ Integration feeds define the data mapping and conditional logic that connects FluentCart order events to third-party services. Feeds are configured at the global level and fire on all matching orders.
225
+
226
+ ---
227
+
228
+ ### List Global Integration Feeds
229
+
230
+ GET `/fluent-cart/v2/integration/global-feeds`
231
+
232
+ Retrieve all configured global integration feeds along with the list of available integrations that support global scope.
233
+
234
+ - **Permission:** `integrations/view`
235
+ - **Controller:** `IntegrationController@getFeeds`
236
+
237
+ #### Parameters
238
+
239
+ *This endpoint does not accept any parameters.*
240
+
241
+ #### Response
242
+
243
+ ```
244
+ {
245
+ "feeds": [
246
+ {
247
+ "id": 42,
248
+ "name": "Add to FluentCRM list",
249
+ "enabled": "yes",
250
+ "provider": "fluent-crm",
251
+ "feed": {
252
+ "name": "Add to FluentCRM list",
253
+ "enabled": "yes",
254
+ "list_id": "2",
255
+ "list_name": "Customers",
256
+ "merge_fields": {},
257
+ "conditionals": {
258
+ "conditions": [],
259
+ "status": false,
260
+ "type": "all"
261
+ }
262
+ },
263
+ "scope": "global"
264
+ }
265
+ ],
266
+ "available_integrations": {
267
+ "fluent-crm": {
268
+ "title": "FluentCRM",
269
+ "logo": "...",
270
+ "enabled": true,
271
+ "scopes": ["global", "product"],
272
+ "description": "..."
273
+ }
274
+ },
275
+ "all_module_config_url": "https://example.com/wp-admin/admin.php?page=fluent-cart#/integrations"
276
+ }
277
+ ```
278
+
279
+ **Feed Object Properties:**
280
+
281
+ | Property | Type | Description |
282
+ | --- | --- | --- |
283
+ | `id` | integer | Unique feed ID |
284
+ | `name` | string | Display name of the feed |
285
+ | `enabled` | string | Status: `yes` or `no` |
286
+ | `provider` | string | Integration provider key |
287
+ | `feed` | object | Full feed configuration data including field mappings and conditionals |
288
+ | `scope` | string | Always `global` for this endpoint |
289
+
290
+ #### Example
291
+
292
+ ```
293
+ curl -X GET "https://example.com/wp-json/fluent-cart/v2/integration/global-feeds" \
294
+ -u "username:app_password"
295
+ ```
296
+
297
+ ---
298
+
299
+ ### Get Feed Settings
300
+
301
+ GET `/fluent-cart/v2/integration/global-feeds/settings`
302
+
303
+ Retrieve the settings form schema, saved values, and available shortcodes for a specific integration feed. Used to populate the feed editor when creating or editing a global feed.
304
+
305
+ - **Permission:** `integrations/view`
306
+ - **Controller:** `IntegrationController@getSettings`
307
+
308
+ #### Parameters
309
+
310
+ | Parameter | Type | Location | Required | Description |
311
+ | --- | --- | --- | --- | --- |
312
+ | `integration_name` | string | query | Yes | The integration provider key (e.g., `fluent-crm`, `webhook`) |
313
+ | `integration_id` | integer | query | No | The feed ID to load existing settings for editing. Omit to get defaults for a new feed. |
314
+
315
+ #### Response
316
+
317
+ ```
318
+ {
319
+ "settings": {
320
+ "conditionals": {
321
+ "conditions": [],
322
+ "status": false,
323
+ "type": "all"
324
+ },
325
+ "enabled": "yes",
326
+ "list_id": "",
327
+ "list_name": "",
328
+ "name": "",
329
+ "merge_fields": {}
330
+ },
331
+ "settings_fields": {
332
+ "fields": [
333
+ {
334
+ "key": "name",
335
+ "label": "Feed Name",
336
+ "type": "text",
337
+ "required": true
338
+ },
339
+ {
340
+ "key": "list_id",
341
+ "label": "Contact List",
342
+ "type": "select",
343
+ "required": true,
344
+ "options": []
345
+ }
346
+ ]
347
+ },
348
+ "shortcodes": {},
349
+ "inputs": {},
350
+ "merge_fields": {}
351
+ }
352
+ ```
353
+
354
+ **Response Properties:**
355
+
356
+ | Property | Type | Description |
357
+ | --- | --- | --- |
358
+ | `settings` | object | Current feed settings values (defaults for new, saved values for existing) |
359
+ | `settings_fields` | object | Form schema defining the feed editor fields |
360
+ | `shortcodes` | object | Available shortcodes for dynamic field mapping |
361
+ | `inputs` | object | Checkout input fields available for mapping |
362
+ | `merge_fields` | object/boolean | Merge fields for the selected list (if applicable) |
363
+
364
+ #### Example
365
+
366
+ ```
367
+ # Get defaults for a new feed
368
+ curl -X GET "https://example.com/wp-json/fluent-cart/v2/integration/global-feeds/settings?integration_name=fluent-crm" \
369
+ -u "username:app_password"
370
+
371
+ # Load existing feed for editing
372
+ curl -X GET "https://example.com/wp-json/fluent-cart/v2/integration/global-feeds/settings?integration_name=fluent-crm&integration_id=42" \
373
+ -u "username:app_password"
374
+ ```
375
+
376
+ ---
377
+
378
+ ### Save Feed Settings
379
+
380
+ POST `/fluent-cart/v2/integration/global-feeds/settings`
381
+
382
+ Create a new integration feed or update an existing one. Validates required fields defined by the integration provider before saving.
383
+
384
+ - **Permission:** `integrations/manage`
385
+ - **Controller:** `IntegrationController@saveSettings`
386
+
387
+ #### Parameters
388
+
389
+ | Parameter | Type | Location | Required | Description |
390
+ | --- | --- | --- | --- | --- |
391
+ | `integration_name` | string | body | Yes | The integration provider key (e.g., `fluent-crm`) |
392
+ | `integration_id` | integer | body | No | The existing feed ID to update. Omit to create a new feed. |
393
+ | `integration` | string (JSON) | body | Yes | JSON-encoded feed settings data containing field mappings, conditionals, and configuration |
394
+
395
+ **The `integration` JSON string should contain:**
396
+
397
+ | Property | Type | Required | Description |
398
+ | --- | --- | --- | --- |
399
+ | `name` | string | Yes | Display name for the feed |
400
+ | `enabled` | string | Yes | Status: `yes` or `no` |
401
+ | `list_id` | string | Varies | Target list ID (provider-specific) |
402
+ | `list_name` | string | No | Target list name |
403
+ | `merge_fields` | object | No | Field mapping configuration |
404
+ | `conditionals` | object | No | Conditional logic settings |
405
+
406
+ #### Response
407
+
408
+ ```
409
+ {
410
+ "message": "Integration has been successfully saved",
411
+ "integration_id": 42,
412
+ "integration_name": "fluent-crm",
413
+ "created": true,
414
+ "feedData": {
415
+ "name": "Add to customers list",
416
+ "enabled": "yes",
417
+ "list_id": "2",
418
+ "merge_fields": {}
419
+ }
420
+ }
421
+ ```
422
+
423
+ **Response Properties:**
424
+
425
+ | Property | Type | Description |
426
+ | --- | --- | --- |
427
+ | `message` | string | Success message |
428
+ | `integration_id` | integer/null | The feed ID (null for newly created feeds before refresh) |
429
+ | `integration_name` | string | The integration provider key |
430
+ | `created` | boolean | `true` if a new feed was created, `false` if an existing one was updated |
431
+ | `feedData` | object | The validated and saved feed data |
432
+
433
+ #### Error Response (Validation)
434
+
435
+ ```
436
+ {
437
+ "message": "Please fill up the required fields:",
438
+ "errors": {
439
+ "name": "Feed Name is required.",
440
+ "list_id": "Contact List is required."
441
+ }
442
+ }
443
+ ```
444
+
445
+ #### Example
446
+
447
+ ```
448
+ curl -X POST "https://example.com/wp-json/fluent-cart/v2/integration/global-feeds/settings" \
449
+ -u "username:app_password" \
450
+ -H "Content-Type: application/json" \
451
+ -d '{
452
+ "integration_name": "fluent-crm",
453
+ "integration": "{\"name\":\"Add to customers\",\"enabled\":\"yes\",\"list_id\":\"2\",\"list_name\":\"Customers\",\"merge_fields\":{},\"conditionals\":{\"conditions\":[],\"status\":false,\"type\":\"all\"}}"
454
+ }'
455
+ ```
456
+
457
+ ---
458
+
459
+ ### Change Feed Status
460
+
461
+ POST `/fluent-cart/v2/integration/global-feeds/change-status/{integration_id}`
462
+
463
+ Toggle a global integration feed on or off without modifying its configuration.
464
+
465
+ - **Permission:** `integrations/manage`
466
+ - **Controller:** `IntegrationController@changeStatus`
467
+
468
+ #### Parameters
469
+
470
+ | Parameter | Type | Location | Required | Description |
471
+ | --- | --- | --- | --- | --- |
472
+ | `integration_id` | integer | path | Yes | The feed ID to update |
473
+ | `status` | string | body | Yes | New status: `yes` (enable) or `no` (disable) |
474
+
475
+ #### Response
476
+
477
+ ```
478
+ {
479
+ "message": "Integration status updated successfully.",
480
+ "meta": {
481
+ "name": "Add to customers list",
482
+ "enabled": "yes",
483
+ "list_id": "2",
484
+ "merge_fields": {}
485
+ }
486
+ }
487
+ ```
488
+
489
+ #### Example
490
+
491
+ ```
492
+ # Disable a feed
493
+ curl -X POST "https://example.com/wp-json/fluent-cart/v2/integration/global-feeds/change-status/42" \
494
+ -u "username:app_password" \
495
+ -H "Content-Type: application/json" \
496
+ -d '{"status": "no"}'
497
+ ```
498
+
499
+ ---
500
+
501
+ ### Delete Feed
502
+
503
+ DELETE `/fluent-cart/v2/integration/global-feeds/{integration_id}`
504
+
505
+ Permanently delete a global integration feed.
506
+
507
+ - **Permission:** `integrations/delete`
508
+ - **Controller:** `IntegrationController@deleteSettings`
509
+
510
+ #### Parameters
511
+
512
+ | Parameter | Type | Location | Required | Description |
513
+ | --- | --- | --- | --- | --- |
514
+ | `integration_id` | integer | path | Yes | The feed ID to delete |
515
+
516
+ #### Response
517
+
518
+ ```
519
+ {
520
+ "message": "Integration has been deleted successfully.",
521
+ "id": 42
522
+ }
523
+ ```
524
+
525
+ #### Example
526
+
527
+ ```
528
+ curl -X DELETE "https://example.com/wp-json/fluent-cart/v2/integration/global-feeds/42" \
529
+ -u "username:app_password"
530
+ ```
531
+
532
+ ---
533
+
534
+ ### Get Feed Merge Fields (Lists)
535
+
536
+ GET `/fluent-cart/v2/integration/feed/lists`
537
+
538
+ Retrieve the merge fields (field mapping options) for a specific integration provider and list. Called when a user selects a target list in the feed editor to load the available mapping fields.
539
+
540
+ - **Permission:** `integrations/view`
541
+ - **Controller:** `IntegrationController@lists`
542
+
543
+ #### Parameters
544
+
545
+ | Parameter | Type | Location | Required | Description |
546
+ | --- | --- | --- | --- | --- |
547
+ | `integration_name` | string | query | Yes | The integration provider key (e.g., `fluent-crm`) |
548
+ | `list_id` | string | query | No | The target list ID to fetch merge fields for |
549
+
550
+ #### Response
551
+
552
+ ```
553
+ {
554
+ "merge_fields": [
555
+ {
556
+ "key": "email",
557
+ "label": "Email",
558
+ "type": "text",
559
+ "required": true
560
+ },
561
+ {
562
+ "key": "first_name",
563
+ "label": "First Name",
564
+ "type": "text",
565
+ "required": false
566
+ },
567
+ {
568
+ "key": "last_name",
569
+ "label": "Last Name",
570
+ "type": "text",
571
+ "required": false
572
+ }
573
+ ]
574
+ }
575
+ ```
576
+
577
+ #### Example
578
+
579
+ ```
580
+ curl -X GET "https://example.com/wp-json/fluent-cart/v2/integration/feed/lists?integration_name=fluent-crm&list_id=2" \
581
+ -u "username:app_password"
582
+ ```
583
+
584
+ ---
585
+
586
+ ### Get Dynamic Options
587
+
588
+ GET `/fluent-cart/v2/integration/feed/dynamic_options`
589
+
590
+ Fetch dynamic select options for integration feed fields. Supports WordPress post type searches and provider-specific dynamic option lookups. Used by the feed editor to populate dropdown fields asynchronously.
591
+
592
+ - **Permission:** `integrations/view`
593
+ - **Controller:** `IntegrationController@getDynamicOptions`
594
+
595
+ #### Parameters
596
+
597
+ | Parameter | Type | Location | Required | Description |
598
+ | --- | --- | --- | --- | --- |
599
+ | `option_key` | string | query | Yes | The type of options to fetch (e.g., `post_type` for WordPress posts, or a provider-specific key) |
600
+ | `sub_option_key` | string | query | Conditional | Required when `option_key` is `post_type`. Specifies the post type slug (e.g., `post`, `page`, `fluent-products`) |
601
+ | `search` | string | query | No | Search term to filter results |
602
+ | `values` | array | query | No | Array of pre-selected IDs to ensure they are included in the response |
603
+
604
+ #### Response
605
+
606
+ ```
607
+ {
608
+ "options": [
609
+ {
610
+ "id": "123",
611
+ "title": "Example Product"
612
+ },
613
+ {
614
+ "id": "456",
615
+ "title": "Another Product"
616
+ }
617
+ ]
618
+ }
619
+ ```
620
+
621
+ #### Example
622
+
623
+ ```
624
+ # Search WordPress posts by post type
625
+ curl -X GET "https://example.com/wp-json/fluent-cart/v2/integration/feed/dynamic_options?option_key=post_type&sub_option_key=page&search=about" \
626
+ -u "username:app_password"
627
+
628
+ # Fetch provider-specific options
629
+ curl -X GET "https://example.com/wp-json/fluent-cart/v2/integration/feed/dynamic_options?option_key=fluentcrm_tags&search=vip" \
630
+ -u "username:app_password"
631
+ ```
632
+
633
+ ---
634
+
635
+ ### Chained Data Request
636
+
637
+ POST `/fluent-cart/v2/integration/feed/chained`
638
+
639
+ Handle chained/dependent data requests for integration feeds. Used when selecting a value in one feed field needs to dynamically load options for another field. The behavior is entirely handled by the integration provider through the `fluent_cart/integration/chained_{route}` hook.
640
+
641
+ - **Permission:** `integrations/manage`
642
+ - **Controller:** `IntegrationController@chained`
643
+
644
+ #### Parameters
645
+
646
+ | Parameter | Type | Location | Required | Description |
647
+ | --- | --- | --- | --- | --- |
648
+ | `route` | string | body | Yes | The chained route identifier, determines which integration provider handles the request |
649
+ | *(additional)* | mixed | body | Varies | Additional parameters depend on the integration provider and the chained route |
650
+
651
+ #### Response
652
+
653
+ The response format depends on the integration provider handling the chained route. A typical response:
654
+
655
+ ```
656
+ {
657
+ "options": [
658
+ {
659
+ "id": "1",
660
+ "label": "Option A"
661
+ },
662
+ {
663
+ "id": "2",
664
+ "label": "Option B"
665
+ }
666
+ ]
667
+ }
668
+ ```
669
+
670
+ #### Example
671
+
672
+ ```
673
+ curl -X POST "https://example.com/wp-json/fluent-cart/v2/integration/feed/chained" \
674
+ -u "username:app_password" \
675
+ -H "Content-Type: application/json" \
676
+ -d '{
677
+ "route": "fluent-crm",
678
+ "list_id": "2"
679
+ }'
680
+ ```
681
+
682
+ ---
683
+
684
+ ## Product Integrations
685
+
686
+ Product-level integrations allow you to configure integration feeds that only fire for orders containing a specific product. This enables per-product customization of CRM tagging, webhook payloads, and other integration behaviors.
687
+
688
+ **Base URL:** `https://your-site.com/wp-json/fluent-cart/v2/products/{product_id}/integrations`
689
+
690
+ **Policy:** `ProductPolicy`
691
+
692
+ ---
693
+
694
+ ### List Product Integration Feeds
695
+
696
+ GET `/fluent-cart/v2/products/{productId}/integrations`
697
+
698
+ Retrieve all integration feeds configured for a specific product, along with available product-scoped integrations.
699
+
700
+ - **Permission:** `products/view`
701
+ - **Controller:** `ProductIntegrationsController@getFeeds`
702
+
703
+ #### Parameters
704
+
705
+ | Parameter | Type | Location | Required | Description |
706
+ | --- | --- | --- | --- | --- |
707
+ | `productId` | integer | path | Yes | The product ID |
708
+
709
+ #### Response
710
+
711
+ ```
712
+ {
713
+ "feeds": [
714
+ {
715
+ "id": 15,
716
+ "name": "Tag VIP buyers",
717
+ "enabled": "yes",
718
+ "provider": "fluent-crm",
719
+ "feed": {
720
+ "name": "Tag VIP buyers",
721
+ "enabled": "yes",
722
+ "list_id": "3",
723
+ "list_name": "VIP Customers",
724
+ "merge_fields": {},
725
+ "conditional_variation_ids": [101, 102],
726
+ "conditionals": {
727
+ "conditions": [],
728
+ "status": false,
729
+ "type": "all"
730
+ }
731
+ },
732
+ "scope": "product"
733
+ }
734
+ ],
735
+ "available_integrations": {
736
+ "fluent-crm": {
737
+ "title": "FluentCRM",
738
+ "logo": "...",
739
+ "enabled": true,
740
+ "scopes": ["global", "product"]
741
+ }
742
+ },
743
+ "all_module_config_url": "https://example.com/wp-admin/admin.php?page=fluent-cart#/integrations"
744
+ }
745
+ ```
746
+
747
+ #### Example
748
+
749
+ ```
750
+ curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/123/integrations" \
751
+ -u "username:app_password"
752
+ ```
753
+
754
+ ---
755
+
756
+ ### Get Product Integration Settings
757
+
758
+ GET `/fluent-cart/v2/products/{product_id}/integrations/{integration_name}/settings`
759
+
760
+ Retrieve the feed editor settings for a specific integration provider, scoped to a product. Returns form schema, saved values, available shortcodes, and the product's variation list for conditional targeting.
761
+
762
+ - **Permission:** `products/view`
763
+ - **Controller:** `ProductIntegrationsController@getProductIntegrationSettings`
764
+
765
+ #### Parameters
766
+
767
+ | Parameter | Type | Location | Required | Description |
768
+ | --- | --- | --- | --- | --- |
769
+ | `product_id` | integer | path | Yes | The product ID |
770
+ | `integration_name` | string | path | Yes | The integration provider key (e.g., `fluent-crm`) |
771
+ | `integration_id` | integer | query | No | The existing feed ID to load for editing. Omit for new feed defaults. |
772
+
773
+ #### Response
774
+
775
+ ```
776
+ {
777
+ "settings": {
778
+ "conditionals": {
779
+ "conditions": [],
780
+ "status": false,
781
+ "type": "all"
782
+ },
783
+ "enabled": "yes",
784
+ "list_id": "",
785
+ "list_name": "",
786
+ "name": "",
787
+ "merge_fields": {},
788
+ "conditional_variation_ids": []
789
+ },
790
+ "settings_fields": {
791
+ "fields": [
792
+ {
793
+ "key": "name",
794
+ "label": "Feed Name",
795
+ "type": "text",
796
+ "required": true
797
+ }
798
+ ]
799
+ },
800
+ "shortcodes": {},
801
+ "inputs": {},
802
+ "merge_fields": {},
803
+ "product_variations": [
804
+ {
805
+ "id": 101,
806
+ "title": "Basic Plan"
807
+ },
808
+ {
809
+ "id": 102,
810
+ "title": "Pro Plan"
811
+ }
812
+ ],
813
+ "scope": "product"
814
+ }
815
+ ```
816
+
817
+ **Additional Properties (compared to global feed settings):**
818
+
819
+ | Property | Type | Description |
820
+ | --- | --- | --- |
821
+ | `product_variations` | array | List of the product's variations (`id` and `title`), used for targeting specific variations |
822
+ | `scope` | string | Always `product` for this endpoint |
823
+ | `settings.conditional_variation_ids` | array | Array of variation IDs this feed should apply to (empty means all variations) |
824
+
825
+ #### Example
826
+
827
+ ```
828
+ # Get defaults for a new product feed
829
+ curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/123/integrations/fluent-crm/settings" \
830
+ -u "username:app_password"
831
+
832
+ # Load existing product feed for editing
833
+ curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/123/integrations/fluent-crm/settings?integration_id=15" \
834
+ -u "username:app_password"
835
+ ```
836
+
837
+ ---
838
+
839
+ ### Save Product Integration Feed
840
+
841
+ POST `/fluent-cart/v2/products/{product_id}/integrations`
842
+
843
+ Create a new product-level integration feed or update an existing one. Validates required fields and associates the feed with the specified product.
844
+
845
+ - **Permission:** `products/edit`
846
+ - **Controller:** `ProductIntegrationsController@saveProductIntegration`
847
+
848
+ #### Parameters
849
+
850
+ | Parameter | Type | Location | Required | Description |
851
+ | --- | --- | --- | --- | --- |
852
+ | `product_id` | integer | path | Yes | The product ID |
853
+ | `integration_name` | string | body | Yes | The integration provider key (e.g., `fluent-crm`) |
854
+ | `integration_id` | integer | body | No | Existing feed ID to update. Omit to create a new feed. |
855
+ | `integration` | string (JSON) | body | Yes | JSON-encoded feed settings data |
856
+
857
+ **The `integration` JSON string should contain:**
858
+
859
+ | Property | Type | Required | Description |
860
+ | --- | --- | --- | --- |
861
+ | `name` | string | Yes | Display name for the feed |
862
+ | `enabled` | string | Yes | Status: `yes` or `no` |
863
+ | `list_id` | string | Varies | Target list ID (provider-specific) |
864
+ | `merge_fields` | object | No | Field mapping configuration |
865
+ | `conditional_variation_ids` | array | No | Array of variation IDs to restrict this feed to. Empty array means all variations. |
866
+ | `conditionals` | object | No | Conditional logic settings |
867
+
868
+ #### Response
869
+
870
+ ```
871
+ {
872
+ "message": "Integration has been successfully saved",
873
+ "integration_id": 15,
874
+ "integration_name": "fluent-crm",
875
+ "created": true,
876
+ "feedData": {
877
+ "name": "Tag VIP buyers",
878
+ "enabled": "yes",
879
+ "list_id": "3",
880
+ "conditional_variation_ids": [101]
881
+ }
882
+ }
883
+ ```
884
+
885
+ #### Error Response
886
+
887
+ ```
888
+ {
889
+ "message": "Product not found"
890
+ }
891
+ ```
892
+
893
+ ```
894
+ {
895
+ "message": "Please fill up the required fields:",
896
+ "errors": {
897
+ "name": "Feed Name is required."
898
+ }
899
+ }
900
+ ```
901
+
902
+ #### Example
903
+
904
+ ```
905
+ curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/123/integrations" \
906
+ -u "username:app_password" \
907
+ -H "Content-Type: application/json" \
908
+ -d '{
909
+ "integration_name": "fluent-crm",
910
+ "integration": "{\"name\":\"Tag VIP buyers\",\"enabled\":\"yes\",\"list_id\":\"3\",\"conditional_variation_ids\":[101],\"merge_fields\":{},\"conditionals\":{\"conditions\":[],\"status\":false,\"type\":\"all\"}}"
911
+ }'
912
+ ```
913
+
914
+ ---
915
+
916
+ ### Change Product Feed Status
917
+
918
+ POST `/fluent-cart/v2/products/{product_id}/integrations/feed/change-status`
919
+
920
+ Toggle a product-level integration feed on or off.
921
+
922
+ - **Permission:** `products/edit`
923
+ - **Controller:** `ProductIntegrationsController@changeStatus`
924
+
925
+ #### Parameters
926
+
927
+ | Parameter | Type | Location | Required | Description |
928
+ | --- | --- | --- | --- | --- |
929
+ | `product_id` | integer | path | Yes | The product ID (from URL) |
930
+ | `product_id` | integer | body | Yes | The product ID (must also be provided in the request body) |
931
+ | `notification_id` | integer | body | Yes | The feed ID to toggle |
932
+ | `status` | string | body | Yes | New status: `yes` (enable) or `no` (disable) |
933
+
934
+ #### Response
935
+
936
+ ```
937
+ {
938
+ "message": "Integration status has been updated"
939
+ }
940
+ ```
941
+
942
+ #### Error Response
943
+
944
+ ```
945
+ {
946
+ "message": "Product ID and Notification ID are required"
947
+ }
948
+ ```
949
+
950
+ ```
951
+ {
952
+ "message": "Notification not found"
953
+ }
954
+ ```
955
+
956
+ #### Example
957
+
958
+ ```
959
+ curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/123/integrations/feed/change-status" \
960
+ -u "username:app_password" \
961
+ -H "Content-Type: application/json" \
962
+ -d '{
963
+ "product_id": 123,
964
+ "notification_id": 15,
965
+ "status": "no"
966
+ }'
967
+ ```
968
+
969
+ ---
970
+
971
+ ### Delete Product Integration Feed
972
+
973
+ DELETE `/fluent-cart/v2/products/{product_id}/integrations/{integration_id}`
974
+
975
+ Permanently delete a product-level integration feed.
976
+
977
+ - **Permission:** `products/delete`
978
+ - **Controller:** `ProductIntegrationsController@deleteProductIntegration`
979
+
980
+ #### Parameters
981
+
982
+ | Parameter | Type | Location | Required | Description |
983
+ | --- | --- | --- | --- | --- |
984
+ | `product_id` | integer | path | Yes | The product ID |
985
+ | `integration_id` | integer | path | Yes | The feed ID to delete |
986
+
987
+ #### Response
988
+
989
+ ```
990
+ {
991
+ "message": "Integration deleted successfully"
992
+ }
993
+ ```
994
+
995
+ #### Example
996
+
997
+ ```
998
+ curl -X DELETE "https://example.com/wp-json/fluent-cart/v2/products/123/integrations/15" \
999
+ -u "username:app_password"
1000
+ ```