fluentcart-developer 2.3.4 → 3.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (670) hide show
  1. package/LICENSE.md +26 -26
  2. package/README.md +59 -59
  3. package/dist/cards/fluentcart/templates-native.js +1087 -1087
  4. package/dist/cards/fluentcart/tools.d.ts.map +1 -1
  5. package/dist/cards/fluentcart/tools.js +62 -17
  6. package/dist/cards/fluentcart/tools.js.map +1 -1
  7. package/dist/paths.d.ts +1 -1
  8. package/dist/paths.d.ts.map +1 -1
  9. package/dist/paths.js +1 -1
  10. package/dist/paths.js.map +1 -1
  11. package/dist/reference-reader.d.ts +32 -1
  12. package/dist/reference-reader.d.ts.map +1 -1
  13. package/dist/reference-reader.js +111 -22
  14. package/dist/reference-reader.js.map +1 -1
  15. package/dist/server.d.ts.map +1 -1
  16. package/dist/server.js +8 -1
  17. package/dist/server.js.map +1 -1
  18. package/dist/skills/fluentcart-developer/SKILL.md +108 -580
  19. package/dist/skills/fluentcart-developer/examples/README.md +30 -30
  20. package/dist/skills/fluentcart-developer/examples/fluentcart-starter-child-theme/fluent-cart/checkout.php +32 -32
  21. package/dist/skills/fluentcart-developer/examples/fluentcart-starter-child-theme/functions.php +40 -40
  22. package/dist/skills/fluentcart-developer/examples/sample-custom-addon/fluentcart-custom-addon.php +113 -113
  23. package/dist/skills/fluentcart-developer/examples/sample-custom-payment-gateway/fluentcart-custom-gateway-example.php +148 -148
  24. package/dist/skills/fluentcart-developer/examples/sample-fee-surcharge-plugin/fluentcart-fee-surcharge.php +38 -38
  25. package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/README.md +22 -22
  26. package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/sample-plugin-with-licensing-sdk.php +79 -79
  27. package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/updater/FluentLicensing.php +303 -303
  28. package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/updater/LicenseSettings.php +566 -566
  29. package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/updater/PluginUpdater.php +304 -304
  30. package/dist/skills/fluentcart-developer/examples/sample-shipping-carrier/fluentcart-custom-shipping-carrier.php +61 -61
  31. package/dist/skills/fluentcart-developer/references/api/authentication.md +452 -0
  32. package/dist/skills/fluentcart-developer/references/api/coupons.md +786 -0
  33. package/dist/skills/fluentcart-developer/references/api/customers.md +889 -0
  34. package/dist/skills/fluentcart-developer/references/api/files.md +609 -0
  35. package/dist/skills/fluentcart-developer/references/api/index.md +432 -0
  36. package/dist/skills/fluentcart-developer/references/api/licensing.md +633 -0
  37. package/dist/skills/fluentcart-developer/references/api/order-bump.md +384 -0
  38. package/dist/skills/fluentcart-developer/references/api/orders.md +814 -0
  39. package/dist/skills/fluentcart-developer/references/api/products.md +866 -0
  40. package/dist/skills/fluentcart-developer/references/api/roles-permissions.md +536 -0
  41. package/dist/skills/fluentcart-developer/references/api/subscriptions.md +827 -0
  42. package/dist/skills/fluentcart-developer/references/database/index.md +44 -0
  43. package/dist/skills/fluentcart-developer/references/database/models/activity.md +178 -0
  44. package/dist/skills/fluentcart-developer/references/database/models/applied-coupon.md +291 -0
  45. package/dist/skills/fluentcart-developer/references/database/models/attribute-group.md +239 -0
  46. package/dist/skills/fluentcart-developer/references/database/models/attribute-relation.md +181 -0
  47. package/dist/skills/fluentcart-developer/references/database/models/attribute-term.md +219 -0
  48. package/dist/skills/fluentcart-developer/references/database/models/cart.md +645 -0
  49. package/dist/skills/fluentcart-developer/references/database/models/coupon.md +427 -0
  50. package/dist/skills/fluentcart-developer/references/database/models/customer-addresses.md +348 -0
  51. package/dist/skills/fluentcart-developer/references/database/models/customer-meta.md +156 -0
  52. package/dist/skills/fluentcart-developer/references/database/models/customer.md +584 -0
  53. package/dist/skills/fluentcart-developer/references/database/models/dynamic-model.md +163 -0
  54. package/dist/skills/fluentcart-developer/references/database/models/label-relationship.md +155 -0
  55. package/dist/skills/fluentcart-developer/references/database/models/label.md +153 -0
  56. package/dist/skills/fluentcart-developer/references/database/models/license-activation.md +182 -0
  57. package/dist/skills/fluentcart-developer/references/database/models/license-meta.md +163 -0
  58. package/dist/skills/fluentcart-developer/references/database/models/license-site.md +208 -0
  59. package/dist/skills/fluentcart-developer/references/database/models/license.md +640 -0
  60. package/dist/skills/fluentcart-developer/references/database/models/meta.md +233 -0
  61. package/dist/skills/fluentcart-developer/references/database/models/order-address.md +391 -0
  62. package/dist/skills/fluentcart-developer/references/database/models/order-download-permission.md +144 -0
  63. package/dist/skills/fluentcart-developer/references/database/models/order-item.md +383 -0
  64. package/dist/skills/fluentcart-developer/references/database/models/order-meta.md +303 -0
  65. package/dist/skills/fluentcart-developer/references/database/models/order-operation.md +158 -0
  66. package/dist/skills/fluentcart-developer/references/database/models/order-promotion-stat.md +175 -0
  67. package/dist/skills/fluentcart-developer/references/database/models/order-promotion.md +250 -0
  68. package/dist/skills/fluentcart-developer/references/database/models/order-tax-rate.md +172 -0
  69. package/dist/skills/fluentcart-developer/references/database/models/order-transaction.md +440 -0
  70. package/dist/skills/fluentcart-developer/references/database/models/order.md +727 -0
  71. package/dist/skills/fluentcart-developer/references/database/models/product-detail.md +397 -0
  72. package/dist/skills/fluentcart-developer/references/database/models/product-download.md +258 -0
  73. package/dist/skills/fluentcart-developer/references/database/models/product-meta.md +153 -0
  74. package/dist/skills/fluentcart-developer/references/database/models/product-variation.md +556 -0
  75. package/dist/skills/fluentcart-developer/references/database/models/product.md +580 -0
  76. package/dist/skills/fluentcart-developer/references/database/models/relationships.md +427 -0
  77. package/dist/skills/fluentcart-developer/references/database/models/scheduled-action.md +175 -0
  78. package/dist/skills/fluentcart-developer/references/database/models/shipping-class.md +148 -0
  79. package/dist/skills/fluentcart-developer/references/database/models/shipping-method.md +280 -0
  80. package/dist/skills/fluentcart-developer/references/database/models/shipping-zone.md +205 -0
  81. package/dist/skills/fluentcart-developer/references/database/models/subscription-meta.md +173 -0
  82. package/dist/skills/fluentcart-developer/references/database/models/subscription.md +528 -0
  83. package/dist/skills/fluentcart-developer/references/database/models/tax-class.md +195 -0
  84. package/dist/skills/fluentcart-developer/references/database/models/tax-rate.md +225 -0
  85. package/dist/skills/fluentcart-developer/references/database/models/user-meta.md +166 -0
  86. package/dist/skills/fluentcart-developer/references/database/models/user.md +220 -0
  87. package/dist/skills/fluentcart-developer/references/database/models.md +404 -0
  88. package/dist/skills/fluentcart-developer/references/database/query-builder.md +860 -0
  89. package/dist/skills/fluentcart-developer/references/database/readme.md +276 -0
  90. package/dist/skills/fluentcart-developer/references/database/schema.md +1002 -0
  91. package/dist/skills/fluentcart-developer/references/engineering/adding-custom-pages-to-the-customer-dashboard.md +395 -0
  92. package/dist/skills/fluentcart-developer/references/engineering/index.md +4 -0
  93. package/dist/skills/fluentcart-developer/references/engineering.md +4 -0
  94. package/dist/skills/fluentcart-developer/references/getting-started.md +249 -0
  95. package/dist/skills/fluentcart-developer/references/guides/frontend.md +519 -0
  96. package/dist/skills/fluentcart-developer/references/guides/index.md +107 -0
  97. package/dist/skills/fluentcart-developer/references/guides/integrations.md +600 -0
  98. package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/index.md +237 -0
  99. package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/labels-and-tracking.md +481 -0
  100. package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/live-rates.md +269 -0
  101. package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/reference.md +223 -0
  102. package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/settings.md +370 -0
  103. package/dist/skills/fluentcart-developer/references/guides/shipping-carrier.md +237 -0
  104. package/dist/skills/fluentcart-developer/references/{subscription-customization.md → guides/subscriptions.md} +217 -197
  105. package/dist/skills/fluentcart-developer/references/hooks/actions/admin-and-templates.md +1079 -0
  106. package/dist/skills/fluentcart-developer/references/hooks/actions/cart-and-checkout.md +1795 -0
  107. package/dist/skills/fluentcart-developer/references/hooks/actions/customers-and-users.md +327 -0
  108. package/dist/skills/fluentcart-developer/references/hooks/actions/licenses.md +829 -0
  109. package/dist/skills/fluentcart-developer/references/hooks/actions/modules.md +81 -0
  110. package/dist/skills/fluentcart-developer/references/hooks/actions/orders.md +757 -0
  111. package/dist/skills/fluentcart-developer/references/hooks/actions/payments-and-integrations.md +1163 -0
  112. package/dist/skills/fluentcart-developer/references/hooks/actions/pro-modules.md +219 -0
  113. package/dist/skills/fluentcart-developer/references/hooks/actions/products-and-coupons.md +1019 -0
  114. package/dist/skills/fluentcart-developer/references/hooks/actions/subscriptions.md +1290 -0
  115. package/dist/skills/fluentcart-developer/references/hooks/actions.md +16 -0
  116. package/dist/skills/fluentcart-developer/references/hooks/deprecated.md +60 -0
  117. package/dist/skills/fluentcart-developer/references/hooks/filters/cart-and-checkout.md +2032 -0
  118. package/dist/skills/fluentcart-developer/references/hooks/filters/customers-and-subscriptions.md +1746 -0
  119. package/dist/skills/fluentcart-developer/references/hooks/filters/integrations-and-advanced.md +2439 -0
  120. package/dist/skills/fluentcart-developer/references/hooks/filters/modules.md +464 -0
  121. package/dist/skills/fluentcart-developer/references/hooks/filters/orders-and-payments.md +2658 -0
  122. package/dist/skills/fluentcart-developer/references/hooks/filters/pro-modules.md +502 -0
  123. package/dist/skills/fluentcart-developer/references/hooks/filters/products-and-pricing.md +1785 -0
  124. package/dist/skills/fluentcart-developer/references/hooks/filters/settings-and-configuration.md +2966 -0
  125. package/dist/skills/fluentcart-developer/references/hooks/filters.md +14 -0
  126. package/dist/skills/fluentcart-developer/references/hooks/index.md +35 -0
  127. package/dist/skills/fluentcart-developer/references/index.md +625 -0
  128. package/dist/skills/fluentcart-developer/references/{fee-system-guide.md → modules/fee-system.md} +427 -449
  129. package/dist/skills/fluentcart-developer/references/{ghost-product-selling.md → modules/ghost-product-selling.md} +440 -458
  130. package/dist/skills/fluentcart-developer/references/modules/index.md +484 -0
  131. package/dist/skills/fluentcart-developer/references/modules/licensing.md +342 -0
  132. package/dist/skills/fluentcart-developer/references/modules/order-bump.md +433 -0
  133. package/dist/skills/fluentcart-developer/references/modules/payment-methods.md +129 -0
  134. package/dist/skills/fluentcart-developer/references/modules/refunds.md +170 -0
  135. package/dist/skills/fluentcart-developer/references/modules/shipping.md +846 -0
  136. package/dist/skills/fluentcart-developer/references/modules/storage.md +986 -0
  137. package/dist/skills/fluentcart-developer/references/modules/subscription-vendor-ids.md +186 -0
  138. package/dist/skills/fluentcart-developer/references/modules/subscriptions.md +678 -0
  139. package/dist/skills/fluentcart-developer/references/payment-methods-integration/index.md +164 -0
  140. package/dist/skills/fluentcart-developer/references/payment-methods-integration/paddle-example.md +1648 -0
  141. package/dist/skills/fluentcart-developer/references/payment-methods-integration/payment/setting/fields.md +353 -0
  142. package/dist/skills/fluentcart-developer/references/payment-methods-integration/quick-implementation.md +1079 -0
  143. package/dist/skills/fluentcart-developer/references/payment-methods-integration.md +164 -0
  144. package/dist/skills/fluentcart-developer/references/restapi/checkout.md +573 -0
  145. package/dist/skills/fluentcart-developer/references/restapi/coupons.md +958 -0
  146. package/dist/skills/fluentcart-developer/references/restapi/customer-profile.md +1423 -0
  147. package/dist/skills/fluentcart-developer/references/{rest-api-customers.md → restapi/customers.md} +1103 -1121
  148. package/dist/skills/fluentcart-developer/references/restapi/dashboard.md +1083 -0
  149. package/dist/skills/fluentcart-developer/references/restapi/data-export.md +132 -0
  150. package/dist/skills/fluentcart-developer/references/restapi/email-notifications.md +846 -0
  151. package/dist/skills/fluentcart-developer/references/restapi/files.md +313 -0
  152. package/dist/skills/fluentcart-developer/references/restapi/index.md +127 -0
  153. package/dist/skills/fluentcart-developer/references/restapi/integrations.md +1000 -0
  154. package/dist/skills/fluentcart-developer/references/restapi/inventory.md +192 -0
  155. package/dist/skills/fluentcart-developer/references/restapi/labels-and-attributes.md +797 -0
  156. package/dist/skills/fluentcart-developer/references/restapi/licensing.md +1733 -0
  157. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-available-shipping-methods.md +30 -0
  158. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-checkout-summary.md +28 -0
  159. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-country-info.md +29 -0
  160. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-order-info.md +28 -0
  161. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-shipping-methods-list-view.md +30 -0
  162. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/login.md +66 -0
  163. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/place-order.md +179 -0
  164. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/apply-coupon.md +83 -0
  165. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/cancel-coupon.md +87 -0
  166. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/check-product-eligibility.md +59 -0
  167. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/create-coupon.md +230 -0
  168. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/delete-coupon.md +29 -0
  169. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/get-coupon-settings.md +20 -0
  170. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/get-coupon.md +27 -0
  171. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/list-coupon-codes.md +20 -0
  172. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/list-coupons.md +37 -0
  173. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/re-apply-coupons.md +75 -0
  174. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/store-coupon-settings.md +40 -0
  175. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/update-coupon.md +133 -0
  176. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/create-address-checkout.md +138 -0
  177. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/create-profile-address.md +119 -0
  178. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/dashboard-overview.md +22 -0
  179. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/delete-profile-address.md +46 -0
  180. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-order-details.md +30 -0
  181. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-portal-sections.md +29 -0
  182. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-profile-details.md +22 -0
  183. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-transaction-billing-address.md +30 -0
  184. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-upgrade-paths.md +31 -0
  185. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/list-downloads.md +29 -0
  186. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/list-orders.md +28 -0
  187. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/make-profile-address-primary.md +55 -0
  188. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/pause-subscription.md +29 -0
  189. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/resume-subscription.md +29 -0
  190. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/save-transaction-billing-address.md +92 -0
  191. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/select-address-for-checkout.md +32 -0
  192. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/update-profile-address.md +115 -0
  193. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/update-profile-details.md +69 -0
  194. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/attach-user.md +50 -0
  195. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/bulk-actions.md +65 -0
  196. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/create-address.md +135 -0
  197. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/create-customer.md +108 -0
  198. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/delete-address.md +62 -0
  199. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/detach-user.md +28 -0
  200. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/find-customer-order.md +27 -0
  201. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-attachable-users.md +20 -0
  202. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer-addresses.md +28 -0
  203. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer-orders.md +37 -0
  204. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer-stats.md +27 -0
  205. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer.md +32 -0
  206. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/list-customers.md +37 -0
  207. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/recalculate-ltv.md +28 -0
  208. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/set-primary-address.md +72 -0
  209. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/update-additional-info.md +55 -0
  210. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/update-address.md +144 -0
  211. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/update-customer.md +123 -0
  212. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/attach-note-to-order.md +49 -0
  213. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/create-all-pages.md +21 -0
  214. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/create-single-page.md +55 -0
  215. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/delete-activity.md +28 -0
  216. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-country-info.md +29 -0
  217. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-dashboard-stats.md +22 -0
  218. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-filter-options.md +31 -0
  219. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-onboarding-data.md +20 -0
  220. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-onboarding-settings.md +20 -0
  221. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-print-templates.md +20 -0
  222. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-search-options.md +27 -0
  223. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-widgets.md +28 -0
  224. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/initialize-app.md +20 -0
  225. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/list-activities.md +33 -0
  226. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/list-attachments.md +21 -0
  227. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/list-countries.md +20 -0
  228. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/mark-activity-read.md +53 -0
  229. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/run-data-backfills.md +21 -0
  230. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/save-onboarding-settings.md +54 -0
  231. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/save-onboarding-tax-settings.md +73 -0
  232. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/save-print-templates.md +64 -0
  233. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/upload-attachment.md +42 -0
  234. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-customers-batch.md +129 -0
  235. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-licenses-batch.md +133 -0
  236. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-orders-batch.md +129 -0
  237. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-subscriptions-batch.md +129 -0
  238. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-customers-export-schema.md +21 -0
  239. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-licenses-export-schema.md +26 -0
  240. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-orders-export-schema.md +21 -0
  241. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-subscriptions-export-schema.md +21 -0
  242. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/enable-notification.md +57 -0
  243. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-digest-settings.md +22 -0
  244. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-notification.md +30 -0
  245. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-reminders.md +22 -0
  246. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-settings.md +22 -0
  247. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-shortcodes.md +22 -0
  248. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/list-notifications.md +20 -0
  249. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/preview-default-template.md +66 -0
  250. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/preview-notification.md +50 -0
  251. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/save-digest-settings.md +101 -0
  252. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/save-reminders.md +162 -0
  253. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/save-settings.md +99 -0
  254. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/send-digest-test.md +47 -0
  255. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/send-manual-reminder.md +51 -0
  256. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/update-notification.md +93 -0
  257. package/dist/skills/fluentcart-developer/references/restapi/operations/files/delete-file.md +31 -0
  258. package/dist/skills/fluentcart-developer/references/restapi/operations/files/get-bucket-list.md +28 -0
  259. package/dist/skills/fluentcart-developer/references/restapi/operations/files/list-files.md +30 -0
  260. package/dist/skills/fluentcart-developer/references/restapi/operations/files/upload-editor-file.md +32 -0
  261. package/dist/skills/fluentcart-developer/references/restapi/operations/files/upload-file.md +34 -0
  262. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/chained-data-request.md +46 -0
  263. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/change-feed-status.md +51 -0
  264. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/delete-feed.md +27 -0
  265. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-dynamic-options.md +29 -0
  266. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-feed-lists.md +27 -0
  267. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-feed-settings.md +27 -0
  268. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-global-feeds.md +20 -0
  269. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-global-settings.md +26 -0
  270. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/install-addon-plugin.md +49 -0
  271. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/list-addons.md +20 -0
  272. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/save-feed-settings.md +52 -0
  273. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/set-global-settings.md +50 -0
  274. package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/bulk-update-stock.md +94 -0
  275. package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/export-inventory.md +81 -0
  276. package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/get-adjustment-history.md +26 -0
  277. package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/get-inventory-stats.md +21 -0
  278. package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/list-inventory.md +33 -0
  279. package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/update-stock.md +75 -0
  280. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/create-attribute-group.md +31 -0
  281. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/create-label.md +31 -0
  282. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/create-terms.md +90 -0
  283. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/delete-attribute-group.md +28 -0
  284. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/delete-attribute-term.md +29 -0
  285. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/get-attribute-group.md +28 -0
  286. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/get-attribute-library.md +20 -0
  287. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/list-attribute-groups.md +32 -0
  288. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/list-attribute-terms.md +33 -0
  289. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/list-labels.md +20 -0
  290. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/reorder-groups.md +51 -0
  291. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/reorder-terms.md +56 -0
  292. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/update-attribute-group.md +37 -0
  293. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/update-attribute-term.md +39 -0
  294. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/update-label-selections.md +32 -0
  295. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/activate-plugin-license.md +41 -0
  296. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/activate-site-admin.md +60 -0
  297. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/deactivate-plugin-license.md +18 -0
  298. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/deactivate-site-admin.md +67 -0
  299. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/deactivate-site-customer.md +47 -0
  300. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/delete-license.md +24 -0
  301. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/extend-license-validity.md +47 -0
  302. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-customer-license-details.md +25 -0
  303. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-customer-licenses-admin.md +26 -0
  304. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-license-activations.md +25 -0
  305. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-license-details.md +25 -0
  306. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-license-site.md +30 -0
  307. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-plugin-license-status.md +18 -0
  308. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-product-license-settings.md +24 -0
  309. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/list-customer-licenses.md +25 -0
  310. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/list-license-sites.md +33 -0
  311. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/list-licenses.md +38 -0
  312. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-activate-license.md +54 -0
  313. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-check-license.md +26 -0
  314. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-deactivate-license.md +46 -0
  315. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-download-license-package.md +23 -0
  316. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-get-license-version.md +26 -0
  317. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/regenerate-license-key.md +24 -0
  318. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/save-product-license-settings.md +193 -0
  319. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/update-license-activation-limit.md +53 -0
  320. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/update-license-status.md +52 -0
  321. package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/create-order-bump.md +47 -0
  322. package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/delete-order-bump.md +25 -0
  323. package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/get-order-bump.md +25 -0
  324. package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/list-order-bumps.md +29 -0
  325. package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/update-order-bump.md +141 -0
  326. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/accept-dispute.md +47 -0
  327. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/bulk-actions.md +72 -0
  328. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/calculate-shipping.md +67 -0
  329. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/calculate-tax.md +98 -0
  330. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/change-customer.md +50 -0
  331. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/charge-now.md +29 -0
  332. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-and-change-customer.md +92 -0
  333. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-custom-order-item.md +68 -0
  334. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-order.md +351 -0
  335. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-renewal-now.md +29 -0
  336. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/delete-order.md +28 -0
  337. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/generate-missing-licenses.md +29 -0
  338. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-order-transactions.md +27 -0
  339. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-order.md +27 -0
  340. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-renewal.md +28 -0
  341. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-shipping-methods.md +28 -0
  342. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-single-transaction.md +28 -0
  343. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/list-order-currencies.md +22 -0
  344. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/list-orders.md +42 -0
  345. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/list-renewals.md +28 -0
  346. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/mark-as-paid.md +61 -0
  347. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/price-order.md +135 -0
  348. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/refund-order.md +72 -0
  349. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/resend-renewal-invoice.md +29 -0
  350. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/skip-renewal.md +48 -0
  351. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/sync-order-statuses.md +28 -0
  352. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/sync-pending-transaction.md +29 -0
  353. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-order-address-id.md +60 -0
  354. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-order-address.md +98 -0
  355. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-order.md +172 -0
  356. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-statuses.md +77 -0
  357. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-subscription-details.md +84 -0
  358. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-transaction-status.md +51 -0
  359. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/void-renewal.md +30 -0
  360. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/create-pdf-template.md +42 -0
  361. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/delete-pdf-template.md +26 -0
  362. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/download-pdf-preview.md +44 -0
  363. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-factory-default-templates.md +19 -0
  364. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-pdf-status.md +21 -0
  365. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-pdf-template.md +26 -0
  366. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-saved-templates.md +21 -0
  367. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-seller-details.md +19 -0
  368. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/list-pdf-templates.md +19 -0
  369. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/save-pdf-template.md +53 -0
  370. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/save-seller-details.md +97 -0
  371. package/dist/skills/fluentcart-developer/references/restapi/operations/products/add-product-terms.md +64 -0
  372. package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-edit-fetch.md +30 -0
  373. package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-insert-products.md +62 -0
  374. package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-update-products.md +59 -0
  375. package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-update-variants.md +83 -0
  376. package/dist/skills/fluentcart-developer/references/restapi/operations/products/change-integration-status.md +64 -0
  377. package/dist/skills/fluentcart-developer/references/restapi/operations/products/create-dummy-products.md +45 -0
  378. package/dist/skills/fluentcart-developer/references/restapi/operations/products/create-product.md +81 -0
  379. package/dist/skills/fluentcart-developer/references/restapi/operations/products/create-variation.md +181 -0
  380. package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-downloadable-file.md +27 -0
  381. package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-product-integration.md +30 -0
  382. package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-product.md +27 -0
  383. package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-taxonomy-term.md +55 -0
  384. package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-upgrade-path.md +27 -0
  385. package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-variation.md +27 -0
  386. package/dist/skills/fluentcart-developer/references/restapi/operations/products/do-bulk-action.md +56 -0
  387. package/dist/skills/fluentcart-developer/references/restapi/operations/products/duplicate-product.md +56 -0
  388. package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-products-by-ids.md +26 -0
  389. package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-taxonomy-terms.md +20 -0
  390. package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-terms-by-parent.md +60 -0
  391. package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-variations-by-ids.md +26 -0
  392. package/dist/skills/fluentcart-developer/references/restapi/operations/products/find-subscription-variants.md +26 -0
  393. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-bundle-info.md +27 -0
  394. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-downloadable-url.md +27 -0
  395. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-max-excerpt-word-count.md +20 -0
  396. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-pricing-widgets.md +27 -0
  397. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product-integration-feeds.md +29 -0
  398. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product-integration-settings.md +31 -0
  399. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product-pricing.md +28 -0
  400. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product.md +28 -0
  401. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-related-products.md +31 -0
  402. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-upgrade-settings.md +27 -0
  403. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-variation-upgrade-paths.md +28 -0
  404. package/dist/skills/fluentcart-developer/references/restapi/operations/products/group-bulk-update-variants.md +103 -0
  405. package/dist/skills/fluentcart-developer/references/restapi/operations/products/list-all-variants.md +26 -0
  406. package/dist/skills/fluentcart-developer/references/restapi/operations/products/list-product-variations.md +26 -0
  407. package/dist/skills/fluentcart-developer/references/restapi/operations/products/list-products.md +34 -0
  408. package/dist/skills/fluentcart-developer/references/restapi/operations/products/remove-shipping-class.md +27 -0
  409. package/dist/skills/fluentcart-developer/references/restapi/operations/products/remove-tax-class.md +27 -0
  410. package/dist/skills/fluentcart-developer/references/restapi/operations/products/save-bundle-info.md +56 -0
  411. package/dist/skills/fluentcart-developer/references/restapi/operations/products/save-product-integration.md +62 -0
  412. package/dist/skills/fluentcart-developer/references/restapi/operations/products/save-upgrade-path.md +78 -0
  413. package/dist/skills/fluentcart-developer/references/restapi/operations/products/search-product-variant-options.md +29 -0
  414. package/dist/skills/fluentcart-developer/references/restapi/operations/products/search-products-by-name.md +28 -0
  415. package/dist/skills/fluentcart-developer/references/restapi/operations/products/search-variants-by-name.md +28 -0
  416. package/dist/skills/fluentcart-developer/references/restapi/operations/products/set-variation-media.md +74 -0
  417. package/dist/skills/fluentcart-developer/references/restapi/operations/products/suggest-sku.md +28 -0
  418. package/dist/skills/fluentcart-developer/references/restapi/operations/products/sync-downloadable-files.md +134 -0
  419. package/dist/skills/fluentcart-developer/references/restapi/operations/products/sync-taxonomy-terms.md +61 -0
  420. package/dist/skills/fluentcart-developer/references/restapi/operations/products/toggle-product-tax-exemption.md +56 -0
  421. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-downloadable-file.md +98 -0
  422. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-inventory.md +56 -0
  423. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-long-desc-editor-mode.md +49 -0
  424. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-manage-stock.md +53 -0
  425. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-product-detail.md +58 -0
  426. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-product-pricing.md +225 -0
  427. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-shipping-class.md +49 -0
  428. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-tax-class.md +49 -0
  429. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-upgrade-path.md +78 -0
  430. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variant-option.md +79 -0
  431. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variant-tax-exemption.md +56 -0
  432. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variation-pricing-table.md +49 -0
  433. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variation.md +105 -0
  434. package/dist/skills/fluentcart-developer/references/restapi/operations/public-shop/get-product-views.md +34 -0
  435. package/dist/skills/fluentcart-developer/references/restapi/operations/public-shop/list-products.md +42 -0
  436. package/dist/skills/fluentcart-developer/references/restapi/operations/public-shop/search-products.md +30 -0
  437. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/channel-rules.md +24 -0
  438. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/country-heat-map.md +22 -0
  439. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/coupon-overview.md +37 -0
  440. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/coupons.md +36 -0
  441. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-insights.md +31 -0
  442. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-overview.md +36 -0
  443. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-repeat.md +35 -0
  444. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-segment-customers.md +36 -0
  445. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-segments.md +30 -0
  446. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-value.md +34 -0
  447. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/dashboard-stats.md +30 -0
  448. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/failed-orders.md +34 -0
  449. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-new-vs-returning-customer.md +34 -0
  450. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-report-by-day-and-hour.md +34 -0
  451. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-report-meta.md +29 -0
  452. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-top-sold-products.md +34 -0
  453. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/future-renewals.md +31 -0
  454. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/generate-retention-snapshots.md +24 -0
  455. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-overview.md +30 -0
  456. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-recent-activities.md +26 -0
  457. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-recent-orders.md +20 -0
  458. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-revenue.md +37 -0
  459. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/installments-at-risk.md +35 -0
  460. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/installments-variations.md +33 -0
  461. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/installments.md +33 -0
  462. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/item-count-distribution.md +34 -0
  463. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/license-chart.md +30 -0
  464. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/license-pie-chart.md +22 -0
  465. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/license-summary.md +22 -0
  466. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/locations.md +43 -0
  467. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-chart.md +37 -0
  468. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-completion-time.md +34 -0
  469. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-mix.md +34 -0
  470. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-value-distribution.md +34 -0
  471. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/payment-methods-disputes.md +38 -0
  472. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/payment-methods-methods.md +36 -0
  473. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/payment-methods.md +37 -0
  474. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-comparison-launch.md +33 -0
  475. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-comparison.md +40 -0
  476. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-detail.md +37 -0
  477. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-sales.md +37 -0
  478. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/refunds-overview.md +37 -0
  479. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/retention-snapshots-step.md +45 -0
  480. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/sales-growth-chart.md +35 -0
  481. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/save-channel-rules.md +73 -0
  482. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/source-channels.md +37 -0
  483. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/sources.md +49 -0
  484. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-cohorts.md +33 -0
  485. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-health.md +30 -0
  486. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-rebuys.md +37 -0
  487. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-retention.md +34 -0
  488. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-variations.md +22 -0
  489. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscriptions-overview.md +37 -0
  490. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/weeks-between-refund.md +34 -0
  491. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/assign-role.md +48 -0
  492. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/delete-role-assignment.md +47 -0
  493. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/get-role.md +25 -0
  494. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/list-managers.md +18 -0
  495. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/list-roles.md +18 -0
  496. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/search-users.md +25 -0
  497. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/update-role.md +43 -0
  498. package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/create-saved-view.md +106 -0
  499. package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/delete-saved-view.md +26 -0
  500. package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/list-saved-views.md +25 -0
  501. package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/update-saved-view.md +83 -0
  502. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/activate-payment-addon.md +44 -0
  503. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/activate-plugin-addon.md +44 -0
  504. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/change-storage-driver-status.md +56 -0
  505. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/check-paypal-webhook.md +26 -0
  506. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/create-storage-bucket.md +63 -0
  507. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/disconnect-payment-method.md +55 -0
  508. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/exchange-paypal-seller-auth-token.md +62 -0
  509. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-active-storage-drivers.md +20 -0
  510. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-checkout-fields.md +22 -0
  511. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-email-shortcodes.md +20 -0
  512. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-mcp-config-snippets.md +26 -0
  513. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-mcp-status.md +20 -0
  514. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-module-settings.md +20 -0
  515. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-payment-method-connection-info.md +26 -0
  516. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-payment-method-settings.md +26 -0
  517. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-permissions.md +22 -0
  518. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-plugin-addons.md +20 -0
  519. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-storage-driver-settings.md +27 -0
  520. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-store-settings.md +26 -0
  521. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/install-mcp-adapter.md +21 -0
  522. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/install-payment-addon.md +60 -0
  523. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/install-plugin-addon.md +64 -0
  524. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/list-all-payment-methods.md +20 -0
  525. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/list-all-storage-drivers.md +20 -0
  526. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/list-storage-buckets.md +67 -0
  527. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/reorder-payment-methods.md +55 -0
  528. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/reset-storage-driver-settings.md +45 -0
  529. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-checkout-fields.md +133 -0
  530. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-confirmation-settings.md +68 -0
  531. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-module-settings.md +68 -0
  532. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-payment-method-design.md +67 -0
  533. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-payment-method-settings.md +58 -0
  534. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-permissions.md +68 -0
  535. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-storage-driver-settings.md +62 -0
  536. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-store-settings.md +239 -0
  537. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/setup-paypal-webhook.md +48 -0
  538. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/toggle-mcp.md +40 -0
  539. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/verify-storage-driver-connection.md +62 -0
  540. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/verify-turnstile-keys.md +55 -0
  541. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/create-shipping-class.md +73 -0
  542. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/create-shipping-method.md +110 -0
  543. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/create-shipping-zone.md +56 -0
  544. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/delete-shipping-class.md +29 -0
  545. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/delete-shipping-method.md +29 -0
  546. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/delete-shipping-zone.md +29 -0
  547. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-class-profile.md +30 -0
  548. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-class.md +29 -0
  549. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-packages.md +22 -0
  550. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-zone.md +27 -0
  551. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-zone-countries.md +22 -0
  552. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-zone-states.md +28 -0
  553. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/list-shipping-classes.md +31 -0
  554. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/list-shipping-zones.md +31 -0
  555. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/save-shipping-packages.md +112 -0
  556. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-shipping-class.md +79 -0
  557. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-shipping-method.md +113 -0
  558. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-shipping-zone.md +62 -0
  559. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-zone-order.md +52 -0
  560. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/cancel-auto-renew.md +30 -0
  561. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/cancel-subscription.md +52 -0
  562. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/confirm-subscription-switch.md +70 -0
  563. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/fetch-subscription-remote.md +28 -0
  564. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/generate-early-payment-link.md +29 -0
  565. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-customer-subscription.md +27 -0
  566. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-or-create-plan.md +69 -0
  567. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-setup-intent-attempts.md +30 -0
  568. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-subscription.md +28 -0
  569. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/initiate-early-payment.md +31 -0
  570. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/list-customer-subscriptions.md +27 -0
  571. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/list-subscriptions.md +39 -0
  572. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/pause-subscription.md +28 -0
  573. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/reactivate-subscription.md +28 -0
  574. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/resume-subscription.md +28 -0
  575. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/switch-payment-method.md +70 -0
  576. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/update-payment-method.md +69 -0
  577. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/update-vendor-ids.md +56 -0
  578. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/verify-vendor-ids.md +56 -0
  579. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/create-tax-class.md +51 -0
  580. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/create-tax-rate.md +117 -0
  581. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-product-override.md +27 -0
  582. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-shipping-tax-override.md +27 -0
  583. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-tax-class.md +28 -0
  584. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-tax-rate.md +27 -0
  585. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-country-tax-id.md +27 -0
  586. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-country-tax-rates.md +28 -0
  587. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-eu-vat-product-overrides.md +20 -0
  588. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-oss-country-rates.md +20 -0
  589. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-preconfigured-tax-rates.md +20 -0
  590. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-product-overrides.md +27 -0
  591. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-tax-settings.md +20 -0
  592. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/list-all-tax-rates.md +20 -0
  593. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/list-tax-classes.md +20 -0
  594. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/list-tax-records.md +37 -0
  595. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/mark-taxes-as-filed.md +58 -0
  596. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/reset-eu-vat-rates.md +21 -0
  597. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-configured-countries.md +57 -0
  598. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-country-tax-id.md +50 -0
  599. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-eu-vat-cross-border-settings.md +127 -0
  600. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-oss-country-rates.md +100 -0
  601. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-product-override.md +110 -0
  602. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-shipping-tax-override.md +52 -0
  603. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-tax-settings.md +166 -0
  604. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/update-country-status.md +54 -0
  605. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/update-tax-rate.md +116 -0
  606. package/dist/skills/fluentcart-developer/references/restapi/order-bumps.md +433 -0
  607. package/dist/skills/fluentcart-developer/references/{rest-api-orders.md → restapi/orders.md} +1212 -1462
  608. package/dist/skills/fluentcart-developer/references/restapi/pdf-templates.md +212 -0
  609. package/dist/skills/fluentcart-developer/references/{rest-api-products.md → restapi/products.md} +2485 -2697
  610. package/dist/skills/fluentcart-developer/references/restapi/public-shop.md +191 -0
  611. package/dist/skills/fluentcart-developer/references/restapi/reports.md +3773 -0
  612. package/dist/skills/fluentcart-developer/references/restapi/roles.md +403 -0
  613. package/dist/skills/fluentcart-developer/references/restapi/saved-views.md +136 -0
  614. package/dist/skills/fluentcart-developer/references/restapi/settings.md +1423 -0
  615. package/dist/skills/fluentcart-developer/references/{rest-api-shipping.md → restapi/shipping.md} +905 -800
  616. package/dist/skills/fluentcart-developer/references/restapi/subscriptions.md +1169 -0
  617. package/dist/skills/fluentcart-developer/references/restapi/tax.md +1551 -0
  618. package/dist/skills/fluentcart-developer/references/{rest-api-overview.md → restapi.md} +127 -131
  619. package/dist/skills/fluentcart-developer/scripts/cli.js +1 -1
  620. package/dist/version.d.ts +1 -1
  621. package/dist/version.js +1 -1
  622. package/package.json +66 -65
  623. package/dist/skills/fluentcart-developer/.claude-plugin/plugin.json +0 -12
  624. package/dist/skills/fluentcart-developer/.mcp.json +0 -11
  625. package/dist/skills/fluentcart-developer/references/action-hooks-admin-templates.md +0 -787
  626. package/dist/skills/fluentcart-developer/references/action-hooks-cart-checkout.md +0 -1355
  627. package/dist/skills/fluentcart-developer/references/action-hooks-customers-users.md +0 -266
  628. package/dist/skills/fluentcart-developer/references/action-hooks-licenses.md +0 -855
  629. package/dist/skills/fluentcart-developer/references/action-hooks-orders.md +0 -631
  630. package/dist/skills/fluentcart-developer/references/action-hooks-payments-integrations.md +0 -963
  631. package/dist/skills/fluentcart-developer/references/action-hooks-products-coupons.md +0 -585
  632. package/dist/skills/fluentcart-developer/references/action-hooks-subscriptions.md +0 -661
  633. package/dist/skills/fluentcart-developer/references/customer-dashboard-endpoints.md +0 -169
  634. package/dist/skills/fluentcart-developer/references/database-models-query-builder.md +0 -194
  635. package/dist/skills/fluentcart-developer/references/database-models-reference.md +0 -604
  636. package/dist/skills/fluentcart-developer/references/database-schema-reference.md +0 -947
  637. package/dist/skills/fluentcart-developer/references/engineering-notes.md +0 -154
  638. package/dist/skills/fluentcart-developer/references/filter-hooks-cart-checkout.md +0 -1202
  639. package/dist/skills/fluentcart-developer/references/filter-hooks-customers-subscriptions.md +0 -902
  640. package/dist/skills/fluentcart-developer/references/filter-hooks-integrations-advanced.md +0 -1598
  641. package/dist/skills/fluentcart-developer/references/filter-hooks-orders-payments.md +0 -1319
  642. package/dist/skills/fluentcart-developer/references/filter-hooks-products-pricing.md +0 -628
  643. package/dist/skills/fluentcart-developer/references/filter-hooks-settings-configuration.md +0 -1177
  644. package/dist/skills/fluentcart-developer/references/fluentcart-developer-guide.md +0 -154
  645. package/dist/skills/fluentcart-developer/references/hooks-complete-index.md +0 -834
  646. package/dist/skills/fluentcart-developer/references/models-complete-index.md +0 -912
  647. package/dist/skills/fluentcart-developer/references/modules-and-extensions-reference.md +0 -224
  648. package/dist/skills/fluentcart-developer/references/order-bump-module.md +0 -163
  649. package/dist/skills/fluentcart-developer/references/paddle-gateway-case-study.md +0 -1931
  650. package/dist/skills/fluentcart-developer/references/payment-gateway-integration.md +0 -761
  651. package/dist/skills/fluentcart-developer/references/rest-api-checkout.md +0 -288
  652. package/dist/skills/fluentcart-developer/references/rest-api-coupons.md +0 -801
  653. package/dist/skills/fluentcart-developer/references/rest-api-customer-profile.md +0 -190
  654. package/dist/skills/fluentcart-developer/references/rest-api-dashboard-utilities.md +0 -219
  655. package/dist/skills/fluentcart-developer/references/rest-api-email-notifications.md +0 -619
  656. package/dist/skills/fluentcart-developer/references/rest-api-files.md +0 -290
  657. package/dist/skills/fluentcart-developer/references/rest-api-integrations.md +0 -324
  658. package/dist/skills/fluentcart-developer/references/rest-api-labels-attributes.md +0 -321
  659. package/dist/skills/fluentcart-developer/references/rest-api-licensing.md +0 -174
  660. package/dist/skills/fluentcart-developer/references/rest-api-order-bumps.md +0 -200
  661. package/dist/skills/fluentcart-developer/references/rest-api-public-shop.md +0 -172
  662. package/dist/skills/fluentcart-developer/references/rest-api-reference.md +0 -552
  663. package/dist/skills/fluentcart-developer/references/rest-api-reports.md +0 -377
  664. package/dist/skills/fluentcart-developer/references/rest-api-roles-permissions.md +0 -147
  665. package/dist/skills/fluentcart-developer/references/rest-api-settings.md +0 -528
  666. package/dist/skills/fluentcart-developer/references/rest-api-subscriptions.md +0 -938
  667. package/dist/skills/fluentcart-developer/references/rest-api-tax.md +0 -356
  668. package/dist/skills/fluentcart-developer/references/shipping-module-guide.md +0 -126
  669. package/dist/skills/fluentcart-developer/references/software-licensing-sdk.md +0 -228
  670. package/dist/skills/fluentcart-developer/references/storage-drivers-module.md +0 -140
@@ -1,2697 +1,2485 @@
1
- # Products API
2
-
3
- Manage your product catalog including creating products, managing variations, downloadable files, bundles, upgrade paths, tax/shipping classes, stock management, and product integrations.
4
-
5
- **Base URL:** `https://your-site.com/wp-json/fluent-cart/v2/products`
6
-
7
- **Policy:** `ProductPolicy`
8
-
9
- > All monetary values are in cents (e.g., `$10.00` = `1000`).
10
-
11
- ---
12
-
13
- ## Endpoints Overview
14
-
15
- | Method | Endpoint | Description |
16
- |--------|----------|-------------|
17
- | **Product CRUD** | | |
18
- | GET | `/products` | List Products |
19
- | GET | `/products/{product}` | Get Product |
20
- | POST | `/products` | Create Product |
21
- | DELETE | `/products/{product}` | Delete Product |
22
- | GET | `/products/{productId}/pricing` | Get Product Pricing |
23
- | POST | `/products/{postId}/pricing` | Update Product Pricing |
24
- | **Search & Lookup** | | |
25
- | GET | `/products/searchProductByName` | Search Products by Name |
26
- | GET | `/products/searchVariantByName` | Search Variants by Name |
27
- | GET | `/products/search-product-variant-options` | Search Product Variant Options |
28
- | GET | `/products/findSubscriptionVariants` | Find Subscription Variants |
29
- | GET | `/products/fetchProductsByIds` | Fetch Products by IDs |
30
- | GET | `/products/fetchVariationsByIds` | Fetch Variations by IDs |
31
- | GET | `/products/suggest-sku` | Suggest SKU |
32
- | GET | `/products/get-max-excerpt-word-count` | Get Max Excerpt Word Count |
33
- | GET | `/products/fetch-term` | Fetch Taxonomy Terms |
34
- | POST | `/products/fetch-term-by-parent` | Fetch Terms by Parent |
35
- | **Bulk Operations** | | |
36
- | POST | `/products/bulk-insert` | Bulk Insert Products |
37
- | GET | `/products/bulk-edit-data` | Bulk Edit Fetch |
38
- | POST | `/products/bulk-update` | Bulk Update Products |
39
- | POST | `/products/do-bulk-action` | Do Bulk Action |
40
- | POST | `/products/variants/bulk-update` | Bulk Update Variants |
41
- | POST | `/products/variants/group-bulk-update` | Group Bulk Update Variants |
42
- | POST | `/products/create-dummy` | Create Dummy Products |
43
- | **Product Details** | | |
44
- | POST | `/products/{productId}/duplicate` | Duplicate Product |
45
- | GET | `/products/{productId}/related-products` | Get Related Products |
46
- | POST | `/products/{postId}/update-long-desc-editor-mode` | Update Long Description Editor Mode |
47
- | POST | `/products/{postId}/update-variant-option` | Update Variant Option |
48
- | POST | `/products/detail/{detailId}` | Update Product Detail |
49
- | POST | `/products/add-product-terms` | Add Product Terms |
50
- | POST | `/products/sync-taxonomy-term/{postId}` | Sync Taxonomy Terms |
51
- | POST | `/products/delete-taxonomy-term/{postId}` | Delete Taxonomy Term |
52
- | GET | `/products/{productId}/pricing-widgets` | Get Pricing Widgets |
53
- | **Bundles** | | |
54
- | GET | `/products/get-bundle-info/{productId}` | Get Bundle Info |
55
- | POST | `/products/save-bundle-info/{variationId}` | Save Bundle Info |
56
- | **Upgrade Paths** | | |
57
- | GET | `/products/{id}/upgrade-paths` | Get Upgrade Settings |
58
- | POST | `/products/{id}/upgrade-path` | Save Upgrade Path |
59
- | POST | `/products/upgrade-path/{id}/update` | Update Upgrade Path |
60
- | DELETE | `/products/upgrade-path/{id}/delete` | Delete Upgrade Path |
61
- | GET | `/products/variation/{variantId}/upgrade-paths` | Get Variation Upgrade Paths |
62
- | **Tax & Shipping Classes** | | |
63
- | POST | `/products/{postId}/tax-exempt` | Set Product Tax Exemption |
64
- | POST | `/products/variants/{variantId}/tax-exempt` | Set Variant Tax Exemption |
65
- | POST | `/products/{postId}/tax-class` | Update Tax Class |
66
- | POST | `/products/{postId}/tax-class/remove` | Remove Tax Class |
67
- | POST | `/products/{postId}/shipping-class` | Update Shipping Class |
68
- | POST | `/products/{postId}/shipping-class/remove` | Remove Shipping Class |
69
- | **Stock Management** | | |
70
- | PUT | `/products/{postId}/update-inventory/{variantId}` | Update Inventory |
71
- | PUT | `/products/{postId}/update-manage-stock` | Update Manage Stock Setting |
72
- | **Downloadables** | | |
73
- | POST | `/products/{postId}/sync-downloadable-files` | Sync Downloadable Files |
74
- | PUT | `/products/{downloadableId}/update` | Update Downloadable File |
75
- | DELETE | `/products/{downloadableId}/delete` | Delete Downloadable File |
76
- | GET | `/products/getDownloadableUrl/{downloadableId}` | Get Downloadable URL |
77
- | **Variations** | | |
78
- | GET | `/products/variants` | List Product Variations |
79
- | POST | `/products/variants` | Create Variation |
80
- | POST | `/products/variants/{variantId}` | Update Variation |
81
- | DELETE | `/products/variants/{variantId}` | Delete Variation |
82
- | POST | `/products/variants/{variantId}/setMedia` | Set Variation Media |
83
- | PUT | `/products/variants/{variantId}/pricing-table` | Update Variation Pricing Table |
84
- | GET | `/variants` | List All Variants |
85
- | **Integrations** | | |
86
- | GET | `/products/{productId}/integrations` | Get Product Integration Feeds |
87
- | GET | `/products/{product_id}/integrations/{integration_name}/settings` | Get Product Integration Settings |
88
- | POST | `/products/{product_id}/integrations` | Save Product Integration (also updates, via `integration_id`) |
89
- | DELETE | `/products/{product_id}/integrations/{integration_id}` | Delete Product Integration |
90
-
91
- ---
92
-
93
- ## Product CRUD & Listing
94
-
95
- ### List Products
96
-
97
- `GET /fluent-cart/v2/products`
98
-
99
- Retrieve a paginated list of products with filtering, sorting, and search capabilities.
100
-
101
- **Permission:** `products/view`
102
-
103
- #### Parameters
104
-
105
- | Parameter | Type | Location | Required | Description |
106
- |-----------|------|----------|----------|-------------|
107
- | `search` | string | query | No | Search by product title, ID, or variation title |
108
- | `per_page` | integer | query | No | Number of results per page (default: 10) |
109
- | `page` | integer | query | No | Page number for pagination |
110
- | `sort_by` | string | query | No | Column to sort by (default: `ID`) |
111
- | `sort_type` | string | query | No | Sort direction: `asc` or `desc` (default: `desc`) |
112
- | `active_view` | string | query | No | Filter tab: `publish`, `draft`, `physical`, `digital`, `subscribable`, `not_subscribable`, `bundle`, `non_bundle` |
113
- | `filter_type` | string | query | No | `simple` or `advanced` |
114
- | `with` | array | query | No | Relations to eager load |
115
- | `search_groups` | array | query | No | Advanced filter groups for complex queries |
116
-
117
- #### Response
118
-
119
- ```json
120
- {
121
- "products": {
122
- "total": 50,
123
- "per_page": 10,
124
- "current_page": 1,
125
- "last_page": 5,
126
- "data": [
127
- {
128
- "ID": 123,
129
- "post_title": "Example Product",
130
- "post_status": "publish",
131
- "post_date": "2025-01-15 12:00:00",
132
- "view_url": "https://example.com/product/example-product",
133
- "edit_url": "https://example.com/wp-admin/admin.php?page=fluent-cart#/products/123"
134
- }
135
- ]
136
- }
137
- }
138
- ```
139
-
140
- #### Example
141
-
142
- ```bash
143
- curl -X GET "https://example.com/wp-json/fluent-cart/v2/products?search=widget&per_page=20&active_view=publish" \
144
- -u "username:app_password"
145
- ```
146
-
147
- ---
148
-
149
- ### Get Product
150
-
151
- `GET /fluent-cart/v2/products/{product}`
152
-
153
- Retrieve a single product by ID.
154
-
155
- **Permission:** `products/view`
156
-
157
- #### Parameters
158
-
159
- | Parameter | Type | Location | Required | Description |
160
- |-----------|------|----------|----------|-------------|
161
- | `product` | integer | path | Yes | The product ID |
162
- | `with` | array | query | No | Relations to eager load (e.g., `["detail", "variants", "product_menu"]`) |
163
-
164
- #### Response
165
-
166
- ```json
167
- {
168
- "product": {
169
- "ID": 123,
170
- "post_title": "Example Product",
171
- "post_status": "publish",
172
- "post_excerpt": "Short description",
173
- "post_content": "Full description"
174
- },
175
- "product_menu": []
176
- }
177
- ```
178
-
179
- #### Example
180
-
181
- ```bash
182
- curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/123?with[]=detail&with[]=variants" \
183
- -u "username:app_password"
184
- ```
185
-
186
- ---
187
-
188
- ### Create Product
189
-
190
- `POST /fluent-cart/v2/products`
191
-
192
- Create a new product. A default variation is automatically created with the product.
193
-
194
- **Permission:** `products/create`
195
-
196
- **Request Class:** `ProductCreateRequest`
197
-
198
- #### Parameters
199
-
200
- | Parameter | Type | Location | Required | Description |
201
- |-----------|------|----------|----------|-------------|
202
- | `post_title` | string | body | Yes | Product title (max 200 characters) |
203
- | `post_status` | string | body | No | Post status (e.g., `draft`, `publish`) |
204
- | `detail.fulfillment_type` | string | body | No | `physical` or `digital` (default: `digital`) |
205
- | `detail.other_info.is_bundle_product` | string | body | No | `yes` or `no` (default: `no`) |
206
-
207
- #### Response
208
-
209
- ```json
210
- {
211
- "data": {
212
- "ID": 124,
213
- "variant": {
214
- "id": 456,
215
- "post_id": 124,
216
- "variation_title": "Example Product",
217
- "stock_status": "in-stock",
218
- "payment_type": "onetime",
219
- "total_stock": 1,
220
- "available": 1,
221
- "fulfillment_type": "digital"
222
- },
223
- "product_details": { ... }
224
- },
225
- "message": "Product has been created successfully"
226
- }
227
- ```
228
-
229
- #### Example
230
-
231
- ```bash
232
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/products" \
233
- -u "username:app_password" \
234
- -H "Content-Type: application/json" \
235
- -d '{
236
- "post_title": "New Digital Product",
237
- "post_status": "draft",
238
- "detail": {
239
- "fulfillment_type": "digital"
240
- }
241
- }'
242
- ```
243
-
244
- ---
245
-
246
- ### Delete Product
247
-
248
- `DELETE /fluent-cart/v2/products/{product}`
249
-
250
- Delete a product and all associated data.
251
-
252
- **Permission:** `products/delete`
253
-
254
- #### Parameters
255
-
256
- | Parameter | Type | Location | Required | Description |
257
- |-----------|------|----------|----------|-------------|
258
- | `product` | integer | path | Yes | The product ID to delete |
259
-
260
- #### Response
261
-
262
- ```json
263
- {
264
- "message": "Product deleted successfully"
265
- }
266
- ```
267
-
268
- #### Example
269
-
270
- ```bash
271
- curl -X DELETE "https://example.com/wp-json/fluent-cart/v2/products/123" \
272
- -u "username:app_password"
273
- ```
274
-
275
- ---
276
-
277
- ### Get Product Pricing
278
-
279
- `GET /fluent-cart/v2/products/{productId}/pricing`
280
-
281
- Retrieve the full product details including pricing, variants, downloadable files, and taxonomy information.
282
-
283
- **Permission:** `products/view`
284
-
285
- #### Parameters
286
-
287
- | Parameter | Type | Location | Required | Description |
288
- |-----------|------|----------|----------|-------------|
289
- | `productId` | integer | path | Yes | The product ID |
290
- | `with` | array | query | No | Additional relations (e.g., `["product_menu"]`) |
291
-
292
- #### Response
293
-
294
- ```json
295
- {
296
- "product": {
297
- "ID": 123,
298
- "post_title": "Example Product",
299
- "post_status": "publish",
300
- "post_excerpt": "Short description",
301
- "featured_image_id": 456,
302
- "view_url": "https://example.com/product/example",
303
- "edit_url": "https://example.com/wp-admin/admin.php?page=fluent-cart#/products/123",
304
- "detail": {
305
- "id": 1,
306
- "post_id": 123,
307
- "fulfillment_type": "digital",
308
- "variation_type": "simple",
309
- "manage_stock": 0,
310
- "manage_downloadable": 0,
311
- "other_info": { ... }
312
- },
313
- "variants": [
314
- {
315
- "id": 789,
316
- "post_id": 123,
317
- "variation_title": "Default Plan",
318
- "item_price": 1000,
319
- "compare_price": 0,
320
- "stock_status": "in-stock",
321
- "other_info": { ... },
322
- "media": []
323
- }
324
- ],
325
- "downloadable_files": []
326
- },
327
- "product_menu": "",
328
- "taxonomies": [
329
- {
330
- "name": "product-categories",
331
- "label": "Product Categories",
332
- "terms": [],
333
- "labels": { ... }
334
- }
335
- ]
336
- }
337
- ```
338
-
339
- #### Example
340
-
341
- ```bash
342
- curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/123/pricing?with[]=product_menu" \
343
- -u "username:app_password"
344
- ```
345
-
346
- ---
347
-
348
- ### Update Product Pricing
349
-
350
- `POST /fluent-cart/v2/products/{postId}/pricing`
351
-
352
- Update a product's pricing, details, variants, and other metadata.
353
-
354
- **Permission:** `products/edit`
355
-
356
- **Request Class:** `ProductUpdateRequest`
357
-
358
- #### Parameters
359
-
360
- | Parameter | Type | Location | Required | Description |
361
- |-----------|------|----------|----------|-------------|
362
- | `postId` | integer | path | Yes | The product post ID |
363
- | `post_title` | string | body | Yes | Product title (max 200 characters) |
364
- | `post_status` | string | body | Yes | Status: `draft`, `publish`, `future` |
365
- | `post_date` | string | body | Conditional | Required when `post_status` is `future`. Must be a future date (GMT) |
366
- | `post_excerpt` | string | body | No | Product short description (limited by `excerpt_length` filter, default 55 words) |
367
- | `post_content` | string | body | No | Product long description (HTML allowed) |
368
- | `post_name` | string | body | No | Product URL slug |
369
- | `comment_status` | string | body | No | Comment status (max 100 chars) |
370
- | `detail.fulfillment_type` | string | body | Yes | `physical` or `digital` |
371
- | `detail.variation_type` | string | body | Yes | `simple` or `simple_variations` |
372
- | `detail.manage_stock` | integer | body | No | `0` or `1` |
373
- | `detail.manage_downloadable` | integer | body | No | `0` or `1` |
374
- | `detail.default_variation_id` | integer | body | No | Default variation ID |
375
- | `detail.stock_availability` | string | body | No | Stock availability status |
376
- | `detail.other_info.group_pricing_by` | string | body | No | `payment_type`, `repeat_interval`, or `none` |
377
- | `detail.other_info.sold_individually` | string | body | No | `yes` or `no` |
378
- | `detail.other_info.use_pricing_table` | string | body | No | Enable pricing table display |
379
- | `detail.other_info.shipping_class` | integer | body | No | Shipping class ID (validated) |
380
- | `detail.other_info.tax_class` | integer | body | No | Tax class ID (validated) |
381
- | `detail.other_info.active_editor` | string | body | No | Active editor mode |
382
- | `variants` | array | body | Conditional | Array of variant objects (required for simple type when publishing) |
383
- | `variants.*.variation_title` | string | body | Yes | Variation title (max 200 chars) |
384
- | `variants.*.post_id` | integer | body | Yes | Parent product post ID |
385
- | `variants.*.item_price` | number | body | No | Price in cents (min: 0) |
386
- | `variants.*.compare_price` | number | body | No | Compare-at price in cents (must be >= `item_price`) |
387
- | `variants.*.manage_cost` | string | body | No | Enable cost tracking |
388
- | `variants.*.item_cost` | number | body | Conditional | Required if `manage_cost` is `true` |
389
- | `variants.*.serial_index` | integer | body | No | Display order index |
390
- | `variants.*.sku` | string | body | No | SKU (max 30 chars, must be unique) |
391
- | `variants.*.fulfillment_type` | string | body | No | `physical` or `digital` |
392
- | `variants.*.other_info.payment_type` | string | body | Yes | `onetime` or `subscription` |
393
- | `variants.*.other_info.description` | string | body | No | Variant description (max 255 chars) |
394
- | `variants.*.other_info.repeat_interval` | string | body | Conditional | Required for subscriptions. e.g., `monthly`, `yearly` |
395
- | `variants.*.other_info.times` | string | body | No | Number of billing cycles |
396
- | `variants.*.other_info.trial_days` | string | body | No | Trial period in days (max 365) |
397
- | `variants.*.other_info.billing_summary` | string | body | No | Billing summary text (max 255 chars) |
398
- | `variants.*.other_info.manage_setup_fee` | string | body | Conditional | Required for subscriptions: `yes` or `no` |
399
- | `variants.*.other_info.signup_fee` | number | body | Conditional | Setup fee in cents. Required if `manage_setup_fee` is `yes` |
400
- | `variants.*.other_info.signup_fee_name` | string | body | Conditional | Setup fee label (max 100 chars). Required if `manage_setup_fee` is `yes` |
401
- | `variants.*.other_info.installment` | string | body | No | Enable installment: `yes` or `no` |
402
- | `product_terms` | object | body | No | Taxonomy term IDs (e.g., `{"product-categories": [1, 2]}`) |
403
- | `gallery` | array | body | No | Gallery images array with `id`, `url`, `title` |
404
- | `metaValue` | mixed | body | No | Additional metadata |
405
-
406
- #### Response
407
-
408
- ```json
409
- {
410
- "data": { ... },
411
- "message": "Product updated successfully"
412
- }
413
- ```
414
-
415
- #### Example
416
-
417
- ```bash
418
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/123/pricing" \
419
- -u "username:app_password" \
420
- -H "Content-Type: application/json" \
421
- -d '{
422
- "post_title": "Updated Product",
423
- "post_status": "publish",
424
- "detail": {
425
- "fulfillment_type": "digital",
426
- "variation_type": "simple"
427
- },
428
- "variants": [
429
- {
430
- "id": 789,
431
- "post_id": 123,
432
- "variation_title": "Default Plan",
433
- "item_price": 1999,
434
- "other_info": {
435
- "payment_type": "onetime"
436
- }
437
- }
438
- ]
439
- }'
440
- ```
441
-
442
- ---
443
-
444
- ## Product Search & Lookup
445
-
446
- ### Search Products by Name
447
-
448
- `GET /fluent-cart/v2/products/searchProductByName`
449
-
450
- Search for published products by name. Returns products formatted for select dropdowns.
451
-
452
- **Permission:** `products/view`
453
-
454
- #### Parameters
455
-
456
- | Parameter | Type | Location | Required | Description |
457
- |-----------|------|----------|----------|-------------|
458
- | `name` | string | query | No | Product name to search for |
459
- | `url_mode` | string | query | No | URL mode flag |
460
- | `termId` | integer | query | No | Filter by taxonomy term ID (`product-categories`) |
461
-
462
- #### Response
463
-
464
- ```json
465
- {
466
- "products": [
467
- {
468
- "ID": 123,
469
- "post_title": "Example Product",
470
- "wpTerms": [...]
471
- }
472
- ]
473
- }
474
- ```
475
-
476
- #### Example
477
-
478
- ```bash
479
- curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/searchProductByName?name=widget" \
480
- -u "username:app_password"
481
- ```
482
-
483
- ---
484
-
485
- ### Search Variants by Name
486
-
487
- `GET /fluent-cart/v2/products/searchVariantByName`
488
-
489
- Search for published product variants by name. Returns a hierarchical product > variants structure.
490
-
491
- **Permission:** `products/view`
492
-
493
- #### Parameters
494
-
495
- | Parameter | Type | Location | Required | Description |
496
- |-----------|------|----------|----------|-------------|
497
- | `name` | string | query | No | Product/variant name to search |
498
- | `search` | string | query | No | Alternative search parameter (used if `name` is empty) |
499
- | `ids` | array | query | No | Array of product IDs to include |
500
-
501
- #### Response
502
-
503
- ```json
504
- [
505
- {
506
- "value": 123,
507
- "label": "Example Product",
508
- "children": [
509
- {
510
- "value": 456,
511
- "label": "Monthly Plan"
512
- },
513
- {
514
- "value": 457,
515
- "label": "Yearly Plan"
516
- }
517
- ]
518
- }
519
- ]
520
- ```
521
-
522
- #### Example
523
-
524
- ```bash
525
- curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/searchVariantByName?name=pro" \
526
- -u "username:app_password"
527
- ```
528
-
529
- ---
530
-
531
- ### Search Product Variant Options
532
-
533
- `GET /fluent-cart/v2/products/search-product-variant-options`
534
-
535
- Search for product variants suitable for selection (e.g., in order creation). Filters out out-of-stock items.
536
-
537
- **Permission:** `products/view`
538
-
539
- #### Parameters
540
-
541
- | Parameter | Type | Location | Required | Description |
542
- |-----------|------|----------|----------|-------------|
543
- | `search` | string | query | No | Search term for product/variant title |
544
- | `include_ids` | array | query | No | Variation IDs to always include in results |
545
- | `scopes` | array | query | No | Model scopes to apply |
546
- | `subscription_status` | string | query | No | `not_subscribable` to exclude subscription variants |
547
-
548
- #### Response
549
-
550
- ```json
551
- {
552
- "products": [
553
- {
554
- "value": "product_123",
555
- "label": "Example Product",
556
- "children": [
557
- {
558
- "value": 456,
559
- "label": "Monthly Plan"
560
- }
561
- ]
562
- }
563
- ]
564
- }
565
- ```
566
-
567
- #### Example
568
-
569
- ```bash
570
- curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/search-product-variant-options?search=pro&subscription_status=not_subscribable" \
571
- -u "username:app_password"
572
- ```
573
-
574
- ---
575
-
576
- ### Find Subscription Variants
577
-
578
- `GET /fluent-cart/v2/products/findSubscriptionVariants`
579
-
580
- Search for product variants that have a subscription payment type.
581
-
582
- **Permission:** `products/view`
583
-
584
- #### Parameters
585
-
586
- | Parameter | Type | Location | Required | Description |
587
- |-----------|------|----------|----------|-------------|
588
- | `name` | string | query | No | Variant title to search |
589
-
590
- #### Response
591
-
592
- ```json
593
- [
594
- {
595
- "id": 456,
596
- "title": "Monthly Subscription"
597
- },
598
- {
599
- "id": 457,
600
- "title": "Yearly Subscription"
601
- }
602
- ]
603
- ```
604
-
605
- #### Example
606
-
607
- ```bash
608
- curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/findSubscriptionVariants?name=monthly" \
609
- -u "username:app_password"
610
- ```
611
-
612
- ---
613
-
614
- ### Fetch Products by IDs
615
-
616
- `GET /fluent-cart/v2/products/fetchProductsByIds`
617
-
618
- Retrieve products by an array of IDs. Returns products with their detail relation.
619
-
620
- **Permission:** `products/view`
621
-
622
- #### Parameters
623
-
624
- | Parameter | Type | Location | Required | Description |
625
- |-----------|------|----------|----------|-------------|
626
- | `productIds` | array | query | Yes | Array of product IDs to fetch |
627
-
628
- #### Response
629
-
630
- ```json
631
- {
632
- "products": [
633
- {
634
- "ID": 123,
635
- "post_title": "Example Product",
636
- "detail": { ... }
637
- }
638
- ]
639
- }
640
- ```
641
-
642
- #### Example
643
-
644
- ```bash
645
- curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/fetchProductsByIds?productIds[]=123&productIds[]=456" \
646
- -u "username:app_password"
647
- ```
648
-
649
- ---
650
-
651
- ### Fetch Variations by IDs
652
-
653
- `GET /fluent-cart/v2/products/fetchVariationsByIds`
654
-
655
- Retrieve variations by an array of IDs. Returns simplified label/value pairs.
656
-
657
- **Permission:** `products/view`
658
-
659
- #### Parameters
660
-
661
- | Parameter | Type | Location | Required | Description |
662
- |-----------|------|----------|----------|-------------|
663
- | `productIds` | array | query | Yes | Array of variation IDs to fetch |
664
-
665
- #### Response
666
-
667
- ```json
668
- {
669
- "products": [
670
- {
671
- "value": 456,
672
- "label": "Monthly Plan"
673
- },
674
- {
675
- "value": 457,
676
- "label": "Yearly Plan"
677
- }
678
- ]
679
- }
680
- ```
681
-
682
- #### Example
683
-
684
- ```bash
685
- curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/fetchVariationsByIds?productIds[]=456&productIds[]=457" \
686
- -u "username:app_password"
687
- ```
688
-
689
- ---
690
-
691
- ### Suggest SKU
692
-
693
- `GET /fluent-cart/v2/products/suggest-sku`
694
-
695
- Generate a unique SKU suggestion based on product and variant titles.
696
-
697
- **Permission:** `products/view`
698
-
699
- #### Parameters
700
-
701
- | Parameter | Type | Location | Required | Description |
702
- |-----------|------|----------|----------|-------------|
703
- | `title` | string | query | Yes | Product title to base SKU on |
704
- | `variant_title` | string | query | No | Variant title to include in SKU |
705
- | `exclude_id` | integer | query | No | Variation ID to exclude from uniqueness check |
706
-
707
- #### Response
708
-
709
- ```json
710
- {
711
- "sku": "EXA-PRO-MON"
712
- }
713
- ```
714
-
715
- #### Example
716
-
717
- ```bash
718
- curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/suggest-sku?title=Example%20Product&variant_title=Monthly" \
719
- -u "username:app_password"
720
- ```
721
-
722
- ---
723
-
724
- ### Get Max Excerpt Word Count
725
-
726
- `GET /fluent-cart/v2/products/get-max-excerpt-word-count`
727
-
728
- Returns the maximum allowed word count for product excerpts (controlled by the WordPress `excerpt_length` filter).
729
-
730
- **Permission:** `products/view`
731
-
732
- #### Response
733
-
734
- ```json
735
- {
736
- "count": 55
737
- }
738
- ```
739
-
740
- #### Example
741
-
742
- ```bash
743
- curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/get-max-excerpt-word-count" \
744
- -u "username:app_password"
745
- ```
746
-
747
- ---
748
-
749
- ### Fetch Taxonomy Terms
750
-
751
- `GET /fluent-cart/v2/products/fetch-term`
752
-
753
- Retrieve all registered taxonomies and their terms for product categorization.
754
-
755
- **Permission:** `products/view`
756
-
757
- #### Response
758
-
759
- ```json
760
- {
761
- "taxonomies": [
762
- {
763
- "name": "product-categories",
764
- "label": "Product Categories",
765
- "terms": [
766
- {
767
- "value": 1,
768
- "label": "Software",
769
- "children": []
770
- }
771
- ]
772
- },
773
- {
774
- "name": "product-brands",
775
- "label": "Product Brands",
776
- "terms": []
777
- }
778
- ]
779
- }
780
- ```
781
-
782
- #### Example
783
-
784
- ```bash
785
- curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/fetch-term" \
786
- -u "username:app_password"
787
- ```
788
-
789
- ---
790
-
791
- ### Fetch Terms by Parent
792
-
793
- `POST /fluent-cart/v2/products/fetch-term-by-parent`
794
-
795
- Retrieve taxonomy terms filtered by parent term IDs.
796
-
797
- **Permission:** `products/view`
798
-
799
- #### Parameters
800
-
801
- | Parameter | Type | Location | Required | Description |
802
- |-----------|------|----------|----------|-------------|
803
- | `parents` | array | body | Yes | Array of parent term IDs |
804
- | `listeners` | array | body | Yes | Array of taxonomy names to retrieve terms for |
805
-
806
- #### Response
807
-
808
- ```json
809
- {
810
- "data": {
811
- "product-categories": [
812
- {
813
- "value": 5,
814
- "label": "Sub Category"
815
- }
816
- ]
817
- }
818
- }
819
- ```
820
-
821
- #### Example
822
-
823
- ```bash
824
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/fetch-term-by-parent" \
825
- -u "username:app_password" \
826
- -H "Content-Type: application/json" \
827
- -d '{
828
- "parents": [1, 2],
829
- "listeners": ["product-categories"]
830
- }'
831
- ```
832
-
833
- ---
834
-
835
- ## Bulk Operations
836
-
837
- ### Bulk Insert Products
838
-
839
- `POST /fluent-cart/v2/products/bulk-insert`
840
-
841
- Insert multiple products at once. Maximum 10 products per request.
842
-
843
- **Permission:** `products/create`
844
-
845
- #### Parameters
846
-
847
- | Parameter | Type | Location | Required | Description |
848
- |-----------|------|----------|----------|-------------|
849
- | `products` | array | body | Yes | Array of product data objects (max 10) |
850
-
851
- #### Response
852
-
853
- ```json
854
- {
855
- "message": "3 product(s) created successfully",
856
- "created": [ ... ],
857
- "errors": []
858
- }
859
- ```
860
-
861
- #### Example
862
-
863
- ```bash
864
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/bulk-insert" \
865
- -u "username:app_password" \
866
- -H "Content-Type: application/json" \
867
- -d '{
868
- "products": [
869
- {
870
- "post_title": "Product A",
871
- "detail": { "fulfillment_type": "digital" }
872
- },
873
- {
874
- "post_title": "Product B",
875
- "detail": { "fulfillment_type": "physical" }
876
- }
877
- ]
878
- }'
879
- ```
880
-
881
- ---
882
-
883
- ### Bulk Edit Fetch
884
-
885
- `GET /fluent-cart/v2/products/bulk-edit-data`
886
-
887
- Fetch products formatted for the bulk editing spreadsheet view.
888
-
889
- **Permission:** `products/edit`
890
-
891
- #### Parameters
892
-
893
- Standard filter parameters (see List Products).
894
-
895
- #### Response
896
-
897
- ```json
898
- {
899
- "products": [ ... ],
900
- "columns": [ ... ]
901
- }
902
- ```
903
-
904
- #### Example
905
-
906
- ```bash
907
- curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/bulk-edit-data" \
908
- -u "username:app_password"
909
- ```
910
-
911
- ---
912
-
913
- ### Bulk Update Products
914
-
915
- `POST /fluent-cart/v2/products/bulk-update`
916
-
917
- Update multiple products at once from the bulk edit view. Maximum 10 products per request.
918
-
919
- **Permission:** `products/edit`
920
-
921
- #### Parameters
922
-
923
- | Parameter | Type | Location | Required | Description |
924
- |-----------|------|----------|----------|-------------|
925
- | `products` | array | body | Yes | Array of product data objects to update (max 10) |
926
-
927
- #### Response
928
-
929
- ```json
930
- {
931
- "message": "3 product(s) updated successfully",
932
- "updated": [ ... ],
933
- "errors": []
934
- }
935
- ```
936
-
937
- #### Example
938
-
939
- ```bash
940
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/bulk-update" \
941
- -u "username:app_password" \
942
- -H "Content-Type: application/json" \
943
- -d '{
944
- "products": [
945
- {
946
- "ID": 123,
947
- "post_title": "Updated Title A"
948
- }
949
- ]
950
- }'
951
- ```
952
-
953
- ---
954
-
955
- ### Do Bulk Action
956
-
957
- `POST /fluent-cart/v2/products/do-bulk-action`
958
-
959
- Perform bulk actions on selected products (e.g., publish, draft, delete).
960
-
961
- **Permission:** `products/edit`
962
-
963
- #### Parameters
964
-
965
- | Parameter | Type | Location | Required | Description |
966
- |-----------|------|----------|----------|-------------|
967
- | `action` | string | body | Yes | The bulk action to perform |
968
- | `product_ids` | array | body | Yes | Array of product IDs to act on |
969
-
970
- #### Response
971
-
972
- ```json
973
- {
974
- "message": "Bulk action completed successfully"
975
- }
976
- ```
977
-
978
- #### Example
979
-
980
- ```bash
981
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/do-bulk-action" \
982
- -u "username:app_password" \
983
- -H "Content-Type: application/json" \
984
- -d '{
985
- "action": "publish",
986
- "product_ids": [123, 456, 789]
987
- }'
988
- ```
989
-
990
- ---
991
-
992
- ### Bulk Update Variants
993
-
994
- `POST /fluent-cart/v2/products/variants/bulk-update`
995
-
996
- Update price and status fields on multiple product variants in one request. All targeted variants must belong to the same product.
997
-
998
- - Rows in the payload that target the same variant ID are **merged (last field wins)**.
999
- - The batch is applied inside a single locked transaction.
1000
- - The `item_price` / `compare_price` relationship is enforced in both directions — raising `item_price` above an existing `compare_price` clears `compare_price`, and a `compare_price` below `item_price` is rejected back to `0`.
1001
- - Up to **500 update rows** per request; additional rows are silently dropped.
1002
- - `item_price` and `compare_price` are **cents** (`2999` for $29.99). Sending `29.99` creates a 29-cent price.
1003
-
1004
- **Permission:** `products/edit`
1005
-
1006
- #### Parameters
1007
-
1008
- | Parameter | Type | Location | Required | Description |
1009
- |-----------|------|----------|----------|-------------|
1010
- | `updates` | array | body | **Yes** | Variant updates. Each row needs `id` plus at least one of `item_price`, `compare_price`, `item_status` |
1011
-
1012
- Each entry in `updates`:
1013
-
1014
- | Field | Type | Description |
1015
- |-------|------|-------------|
1016
- | `id` | integer | Variant ID |
1017
- | `item_price` | number | Sale price in cents |
1018
- | `compare_price` | number | Compare-at price in cents |
1019
- | `item_status` | string | Variant status |
1020
-
1021
- #### Response
1022
-
1023
- ```json
1024
- { "message": "Variants updated successfully.", "updated": 2 }
1025
- ```
1026
-
1027
- #### Example
1028
-
1029
- ```bash
1030
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/variants/bulk-update" \
1031
- -u "username:app_password" \
1032
- -H "Content-Type: application/json" \
1033
- -d '{"updates":[{"id":5,"item_price":2999},{"id":6,"compare_price":5999,"item_status":"active"}]}'
1034
- ```
1035
-
1036
- ---
1037
-
1038
- ### Group Bulk Update Variants
1039
-
1040
- `POST /fluent-cart/v2/products/variants/group-bulk-update`
1041
-
1042
- Apply a partial (PATCH-style) update to a **group** of variants at once. Any field left null or omitted is skipped for every variant in the group; only the non-null fields are written.
1043
-
1044
- - For `other_info`, only the supplied non-null sub-keys are **merged** into each variant's existing JSON rather than replacing it.
1045
- - All variants in `variant_ids` must belong to the same product.
1046
- - `sku` can only be set when **exactly one** variant is targeted (SKUs must stay unique).
1047
-
1048
- **Permission:** `products/edit`
1049
-
1050
- #### Parameters
1051
-
1052
- | Parameter | Type | Location | Required | Description |
1053
- |-----------|------|----------|----------|-------------|
1054
- | `variant_ids` | array | body | **Yes** | Variant IDs to update. All must belong to the same product |
1055
- | `sku` | string | body | No | New SKU. Only when exactly one ID is targeted. Empty string clears it |
1056
- | `item_price` | number | body | No | Sale price in cents, applied to every targeted variant |
1057
- | `compare_price` | number | body | No | Compare-at price in cents. Ignored per-row if below that row's effective `item_price` |
1058
- | `manage_stock` | integer | body | No | `0` or `1` — track stock for the targeted variants |
1059
- | `total_stock` | integer | body | No | New total stock quantity |
1060
- | `fulfillment_type` | string | body | No | `physical` or `digital` |
1061
- | `manage_cost` | string | body | No | `"true"` or `"false"` — track cost of goods |
1062
- | `item_cost` | number | body | No | Cost of goods in cents |
1063
- | `other_info` | object | body | No | Partial delta merged into each variant's `other_info` (e.g. `payment_type`, `repeat_interval`, `signup_fee`) |
1064
-
1065
- #### Example
1066
-
1067
- ```bash
1068
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/variants/group-bulk-update" \
1069
- -u "username:app_password" \
1070
- -H "Content-Type: application/json" \
1071
- -d '{"variant_ids":[5,6,7],"fulfillment_type":"digital","other_info":{"payment_type":"subscription","repeat_interval":"monthly"}}'
1072
- ```
1073
-
1074
- ---
1075
-
1076
- ### Create Dummy Products
1077
-
1078
- `POST /fluent-cart/v2/products/create-dummy`
1079
-
1080
- Create sample/demo products for testing or onboarding purposes.
1081
-
1082
- **Permission:** `products/create`
1083
-
1084
- #### Parameters
1085
-
1086
- | Parameter | Type | Location | Required | Description |
1087
- |-----------|------|----------|----------|-------------|
1088
- | `category` | string | body | No | Product category for dummy products |
1089
- | `index` | integer | body | No | Index for dummy product generation |
1090
-
1091
- #### Response
1092
-
1093
- Returns the created dummy product data.
1094
-
1095
- #### Example
1096
-
1097
- ```bash
1098
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/create-dummy" \
1099
- -u "username:app_password" \
1100
- -H "Content-Type: application/json" \
1101
- -d '{
1102
- "category": "digital",
1103
- "index": 1
1104
- }'
1105
- ```
1106
-
1107
- ---
1108
-
1109
- ## Product Details & Configuration
1110
-
1111
- ### Duplicate Product
1112
-
1113
- `POST /fluent-cart/v2/products/{productId}/duplicate`
1114
-
1115
- Duplicate a product with options to include or exclude certain settings. The new product is saved as a draft.
1116
-
1117
- **Permission:** `products/create`
1118
-
1119
- #### Parameters
1120
-
1121
- | Parameter | Type | Location | Required | Description |
1122
- |-----------|------|----------|----------|-------------|
1123
- | `productId` | integer | path | Yes | The product ID to duplicate |
1124
- | `import_stock_management` | string | body | No | Include stock management settings (`true`/`false`) |
1125
- | `import_license_settings` | string | body | No | Include license settings (`true`/`false`) |
1126
- | `import_downloadable_files` | string | body | No | Include downloadable files (`true`/`false`) |
1127
-
1128
- #### Response
1129
-
1130
- ```json
1131
- {
1132
- "product_id": 125,
1133
- "message": "Product duplicated successfully. The new product has been saved as a draft."
1134
- }
1135
- ```
1136
-
1137
- #### Example
1138
-
1139
- ```bash
1140
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/123/duplicate" \
1141
- -u "username:app_password" \
1142
- -H "Content-Type: application/json" \
1143
- -d '{
1144
- "import_stock_management": "true",
1145
- "import_license_settings": "true",
1146
- "import_downloadable_files": "false"
1147
- }'
1148
- ```
1149
-
1150
- ---
1151
-
1152
- ### Get Related Products
1153
-
1154
- `GET /fluent-cart/v2/products/{productId}/related-products`
1155
-
1156
- Retrieve products related to a given product based on shared categories or brands.
1157
-
1158
- **Permission:** `products/view`
1159
-
1160
- #### Parameters
1161
-
1162
- | Parameter | Type | Location | Required | Description |
1163
- |-----------|------|----------|----------|-------------|
1164
- | `productId` | integer | path | Yes | The product ID |
1165
- | `related_by_categories` | boolean | query | No | Include products from same categories |
1166
- | `related_by_brands` | boolean | query | No | Include products from same brands |
1167
- | `order_by` | string | query | No | Sort order (default: `title_asc`) |
1168
- | `posts_per_page` | integer | query | No | Number of related products to return (default: 6) |
1169
-
1170
- #### Response
1171
-
1172
- ```json
1173
- {
1174
- "products": [
1175
- {
1176
- "ID": 456,
1177
- "post_title": "Related Product",
1178
- "post_status": "publish"
1179
- }
1180
- ]
1181
- }
1182
- ```
1183
-
1184
- #### Example
1185
-
1186
- ```bash
1187
- curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/123/related-products?related_by_categories=true&posts_per_page=4" \
1188
- -u "username:app_password"
1189
- ```
1190
-
1191
- ---
1192
-
1193
- ### Update Long Description Editor Mode
1194
-
1195
- `POST /fluent-cart/v2/products/{postId}/update-long-desc-editor-mode`
1196
-
1197
- Switch the long description editor between modes (e.g., visual, code).
1198
-
1199
- **Permission:** `products/edit`
1200
-
1201
- #### Parameters
1202
-
1203
- | Parameter | Type | Location | Required | Description |
1204
- |-----------|------|----------|----------|-------------|
1205
- | `postId` | integer | path | Yes | The product post ID |
1206
- | `active_editor` | string | body | Yes | The editor mode to set |
1207
-
1208
- #### Response
1209
-
1210
- ```json
1211
- {
1212
- "message": "Editor mode updated successfully"
1213
- }
1214
- ```
1215
-
1216
- #### Example
1217
-
1218
- ```bash
1219
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/123/update-long-desc-editor-mode" \
1220
- -u "username:app_password" \
1221
- -H "Content-Type: application/json" \
1222
- -d '{"active_editor": "visual"}'
1223
- ```
1224
-
1225
- ---
1226
-
1227
- ### Update Variant Option
1228
-
1229
- `POST /fluent-cart/v2/products/{postId}/update-variant-option`
1230
-
1231
- Sync variant options for a product (used when managing product attribute variations).
1232
-
1233
- **Permission:** `products/edit`
1234
-
1235
- #### Parameters
1236
-
1237
- | Parameter | Type | Location | Required | Description |
1238
- |-----------|------|----------|----------|-------------|
1239
- | `postId` | integer | path | Yes | The product post ID |
1240
- | `variation_type` | string | body | Yes | The variation type |
1241
- | `product_id` | integer | body | Yes | The product ID |
1242
- | `options` | array | body | Yes | Array of option objects with `id` and `variants` |
1243
-
1244
- #### Response
1245
-
1246
- ```json
1247
- {
1248
- "message": "Variant options synced successfully"
1249
- }
1250
- ```
1251
-
1252
- #### Example
1253
-
1254
- ```bash
1255
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/123/update-variant-option" \
1256
- -u "username:app_password" \
1257
- -H "Content-Type: application/json" \
1258
- -d '{
1259
- "variation_type": "simple_variations",
1260
- "product_id": 123,
1261
- "options": []
1262
- }'
1263
- ```
1264
-
1265
- ---
1266
-
1267
- ### Update Product Detail
1268
-
1269
- `POST /fluent-cart/v2/products/detail/{detailId}`
1270
-
1271
- Update a product detail record (e.g., change variation type).
1272
-
1273
- **Permission:** `products/edit`
1274
-
1275
- #### Parameters
1276
-
1277
- | Parameter | Type | Location | Required | Description |
1278
- |-----------|------|----------|----------|-------------|
1279
- | `detailId` | integer | path | Yes | The product detail ID |
1280
- | `variation_type` | string | body | No | New variation type (e.g., `simple`, `simple_variations`) |
1281
- | `variation_ids` | array | body | No | Array of variation IDs |
1282
- | `action` | string | body | No | Action to perform (default: `change_variation_type`) |
1283
-
1284
- #### Response
1285
-
1286
- ```json
1287
- {
1288
- "message": "Product detail updated successfully"
1289
- }
1290
- ```
1291
-
1292
- #### Example
1293
-
1294
- ```bash
1295
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/detail/456" \
1296
- -u "username:app_password" \
1297
- -H "Content-Type: application/json" \
1298
- -d '{
1299
- "variation_type": "simple_variations",
1300
- "action": "change_variation_type"
1301
- }'
1302
- ```
1303
-
1304
- ---
1305
-
1306
- ### Add Product Terms
1307
-
1308
- `POST /fluent-cart/v2/products/add-product-terms`
1309
-
1310
- Create new taxonomy terms for products (categories, brands, etc.).
1311
-
1312
- **Permission:** `products/edit`
1313
-
1314
- #### Parameters
1315
-
1316
- | Parameter | Type | Location | Required | Description |
1317
- |-----------|------|----------|----------|-------------|
1318
- | `term.name` | string | body | Yes | Term name(s), comma-separated for multiple |
1319
- | `term.taxonomy` | string | body | Yes | Taxonomy name (e.g., `product-categories`, `product-brands`) |
1320
- | `term.parent` | integer | body | No | Parent term ID for hierarchical terms |
1321
-
1322
- #### Response
1323
-
1324
- ```json
1325
- {
1326
- "term_ids": [10, 11],
1327
- "names": ["Category A", "Category B"]
1328
- }
1329
- ```
1330
-
1331
- #### Example
1332
-
1333
- ```bash
1334
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/add-product-terms" \
1335
- -u "username:app_password" \
1336
- -H "Content-Type: application/json" \
1337
- -d '{
1338
- "term": {
1339
- "name": "New Category,Another Category",
1340
- "taxonomy": "product-categories",
1341
- "parent": 0
1342
- }
1343
- }'
1344
- ```
1345
-
1346
- ---
1347
-
1348
- ### Sync Taxonomy Terms
1349
-
1350
- `POST /fluent-cart/v2/products/sync-taxonomy-term/{postId}`
1351
-
1352
- Sync (replace) taxonomy terms for a product.
1353
-
1354
- **Permission:** `products/edit`
1355
-
1356
- #### Parameters
1357
-
1358
- | Parameter | Type | Location | Required | Description |
1359
- |-----------|------|----------|----------|-------------|
1360
- | `postId` | integer | path | Yes | The product post ID |
1361
- | `taxonomy` | string | body | Yes | Taxonomy name (e.g., `product-categories`) |
1362
- | `terms` | array | body | No | Array of term IDs to sync |
1363
-
1364
- #### Response
1365
-
1366
- ```json
1367
- {
1368
- "message": "Taxonomy terms synced successfully"
1369
- }
1370
- ```
1371
-
1372
- #### Example
1373
-
1374
- ```bash
1375
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/sync-taxonomy-term/123" \
1376
- -u "username:app_password" \
1377
- -H "Content-Type: application/json" \
1378
- -d '{
1379
- "taxonomy": "product-categories",
1380
- "terms": [1, 5, 10]
1381
- }'
1382
- ```
1383
-
1384
- ---
1385
-
1386
- ### Delete Taxonomy Term
1387
-
1388
- `POST /fluent-cart/v2/products/delete-taxonomy-term/{postId}`
1389
-
1390
- Remove a specific taxonomy term from a product.
1391
-
1392
- **Permission:** `products/edit`
1393
-
1394
- #### Parameters
1395
-
1396
- | Parameter | Type | Location | Required | Description |
1397
- |-----------|------|----------|----------|-------------|
1398
- | `postId` | integer | path | Yes | The product post ID |
1399
- | `taxonomy` | string | body | Yes | Taxonomy name (e.g., `product-categories`) |
1400
- | `term` | integer | body | Yes | Term ID to remove |
1401
-
1402
- #### Response
1403
-
1404
- ```json
1405
- {
1406
- "message": "Taxonomy term removed successfully"
1407
- }
1408
- ```
1409
-
1410
- #### Example
1411
-
1412
- ```bash
1413
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/delete-taxonomy-term/123" \
1414
- -u "username:app_password" \
1415
- -H "Content-Type: application/json" \
1416
- -d '{
1417
- "taxonomy": "product-categories",
1418
- "term": 5
1419
- }'
1420
- ```
1421
-
1422
- ---
1423
-
1424
- ### Get Pricing Widgets
1425
-
1426
- `GET /fluent-cart/v2/products/{productId}/pricing-widgets`
1427
-
1428
- Retrieve sales overview widgets for a product (all-time, last 30 days, this month).
1429
-
1430
- **Permission:** `products/view`
1431
-
1432
- #### Parameters
1433
-
1434
- | Parameter | Type | Location | Required | Description |
1435
- |-----------|------|----------|----------|-------------|
1436
- | `productId` | integer | path | Yes | The product ID |
1437
-
1438
- #### Response
1439
-
1440
- ```json
1441
- {
1442
- "widgets": [
1443
- {
1444
- "title": "Quick Sales Overview",
1445
- "body": "<ul class=\"fct-lists\"><li><span>All time (5)</span><span>$50.00</span></li>...</ul>"
1446
- }
1447
- ]
1448
- }
1449
- ```
1450
-
1451
- #### Example
1452
-
1453
- ```bash
1454
- curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/123/pricing-widgets" \
1455
- -u "username:app_password"
1456
- ```
1457
-
1458
- ---
1459
-
1460
- ## Bundle Products
1461
-
1462
- ### Get Bundle Info
1463
-
1464
- `GET /fluent-cart/v2/products/get-bundle-info/{productId}`
1465
-
1466
- Retrieve bundle configuration information for a product, including child variant mappings.
1467
-
1468
- **Permission:** `products/view`
1469
-
1470
- #### Parameters
1471
-
1472
- | Parameter | Type | Location | Required | Description |
1473
- |-----------|------|----------|----------|-------------|
1474
- | `productId` | integer | path | Yes | The product ID |
1475
-
1476
- #### Response
1477
-
1478
- ```json
1479
- [
1480
- {
1481
- "id": 789,
1482
- "variation_title": "Bundle Plan",
1483
- "other_info": {
1484
- "bundle_child_ids": [101, 102, 103]
1485
- }
1486
- }
1487
- ]
1488
- ```
1489
-
1490
- #### Example
1491
-
1492
- ```bash
1493
- curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/get-bundle-info/123" \
1494
- -u "username:app_password"
1495
- ```
1496
-
1497
- ---
1498
-
1499
- ### Save Bundle Info
1500
-
1501
- `POST /fluent-cart/v2/products/save-bundle-info/{variationId}`
1502
-
1503
- Save bundle child variant IDs for a variation. Bundle products cannot be added as children of other bundles.
1504
-
1505
- **Permission:** `products/edit`
1506
-
1507
- #### Parameters
1508
-
1509
- | Parameter | Type | Location | Required | Description |
1510
- |-----------|------|----------|----------|-------------|
1511
- | `variationId` | integer | path | Yes | The variation ID to configure as a bundle |
1512
- | `bundle_child_ids` | array | body | Yes | Array of child variation IDs |
1513
-
1514
- #### Response
1515
-
1516
- ```json
1517
- [true]
1518
- ```
1519
-
1520
- #### Example
1521
-
1522
- ```bash
1523
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/save-bundle-info/789" \
1524
- -u "username:app_password" \
1525
- -H "Content-Type: application/json" \
1526
- -d '{
1527
- "bundle_child_ids": [101, 102, 103]
1528
- }'
1529
- ```
1530
-
1531
- ---
1532
-
1533
- ## Upgrade Paths
1534
-
1535
- ### Get Upgrade Settings
1536
-
1537
- `GET /fluent-cart/v2/products/{id}/upgrade-paths`
1538
-
1539
- Retrieve all upgrade path configurations for a product.
1540
-
1541
- **Permission:** `products/view`
1542
-
1543
- #### Parameters
1544
-
1545
- | Parameter | Type | Location | Required | Description |
1546
- |-----------|------|----------|----------|-------------|
1547
- | `id` | integer | path | Yes | The product ID |
1548
-
1549
- #### Response
1550
-
1551
- ```json
1552
- {
1553
- "data": [ ... ]
1554
- }
1555
- ```
1556
-
1557
- #### Example
1558
-
1559
- ```bash
1560
- curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/123/upgrade-paths" \
1561
- -u "username:app_password"
1562
- ```
1563
-
1564
- ---
1565
-
1566
- ### Save Upgrade Path
1567
-
1568
- `POST /fluent-cart/v2/products/{id}/upgrade-path`
1569
-
1570
- Create a new upgrade path for a product.
1571
-
1572
- **Permission:** `products/edit`
1573
-
1574
- **Request Class:** `UpgradePathSettingRequest`
1575
-
1576
- #### Parameters
1577
-
1578
- | Parameter | Type | Location | Required | Description |
1579
- |-----------|------|----------|----------|-------------|
1580
- | `id` | integer | path | Yes | The product ID |
1581
- | `from_variant` | integer | body | Yes | Source variation ID (must exist in `fct_product_variations`) |
1582
- | `to_variants` | array | body | Yes | Array of target variation IDs (each must exist in `fct_product_variations`) |
1583
- | `discount_amount` | number | body | No | Discount amount for the upgrade |
1584
- | `title` | string | body | No | Upgrade path title |
1585
- | `description` | string | body | No | Upgrade path description |
1586
- | `slug` | string | body | No | Upgrade path slug |
1587
-
1588
- #### Response
1589
-
1590
- ```json
1591
- {
1592
- "message": "Settings saved successfully"
1593
- }
1594
- ```
1595
-
1596
- #### Example
1597
-
1598
- ```bash
1599
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/123/upgrade-path" \
1600
- -u "username:app_password" \
1601
- -H "Content-Type: application/json" \
1602
- -d '{
1603
- "from_variant": 456,
1604
- "to_variants": [457, 458],
1605
- "discount_amount": 500
1606
- }'
1607
- ```
1608
-
1609
- ---
1610
-
1611
- ### Update Upgrade Path
1612
-
1613
- `POST /fluent-cart/v2/products/upgrade-path/{id}/update`
1614
-
1615
- Update an existing upgrade path.
1616
-
1617
- **Permission:** `products/edit`
1618
-
1619
- **Request Class:** `UpgradePathSettingRequest`
1620
-
1621
- #### Parameters
1622
-
1623
- | Parameter | Type | Location | Required | Description |
1624
- |-----------|------|----------|----------|-------------|
1625
- | `id` | integer | path | Yes | The upgrade path ID |
1626
- | `from_variant` | integer | body | Yes | Source variation ID |
1627
- | `to_variants` | array | body | Yes | Array of target variation IDs |
1628
- | `discount_amount` | number | body | No | Discount amount |
1629
- | `title` | string | body | No | Upgrade path title |
1630
- | `description` | string | body | No | Upgrade path description |
1631
- | `slug` | string | body | No | Upgrade path slug |
1632
-
1633
- #### Response
1634
-
1635
- ```json
1636
- {
1637
- "message": "Settings updated successfully"
1638
- }
1639
- ```
1640
-
1641
- #### Example
1642
-
1643
- ```bash
1644
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/upgrade-path/10/update" \
1645
- -u "username:app_password" \
1646
- -H "Content-Type: application/json" \
1647
- -d '{
1648
- "from_variant": 456,
1649
- "to_variants": [458, 459],
1650
- "discount_amount": 1000
1651
- }'
1652
- ```
1653
-
1654
- ---
1655
-
1656
- ### Delete Upgrade Path
1657
-
1658
- `DELETE /fluent-cart/v2/products/upgrade-path/{id}/delete`
1659
-
1660
- Delete an upgrade path.
1661
-
1662
- **Permission:** `products/delete`
1663
-
1664
- #### Parameters
1665
-
1666
- | Parameter | Type | Location | Required | Description |
1667
- |-----------|------|----------|----------|-------------|
1668
- | `id` | integer | path | Yes | The upgrade path ID |
1669
-
1670
- #### Response
1671
-
1672
- ```json
1673
- {
1674
- "message": "Path deleted successfully"
1675
- }
1676
- ```
1677
-
1678
- #### Example
1679
-
1680
- ```bash
1681
- curl -X DELETE "https://example.com/wp-json/fluent-cart/v2/products/upgrade-path/10/delete" \
1682
- -u "username:app_password"
1683
- ```
1684
-
1685
- ---
1686
-
1687
- ### Get Variation Upgrade Paths
1688
-
1689
- `GET /fluent-cart/v2/products/variation/{variantId}/upgrade-paths`
1690
-
1691
- Retrieve available upgrade paths for a specific variation (used in customer-facing upgrade flows).
1692
-
1693
- **Permission:** `products/view`
1694
-
1695
- #### Parameters
1696
-
1697
- | Parameter | Type | Location | Required | Description |
1698
- |-----------|------|----------|----------|-------------|
1699
- | `variantId` | integer | path | Yes | The variation ID |
1700
- | `params.order_hash` | string | query | Yes | The order hash to determine applicable upgrades |
1701
-
1702
- #### Response
1703
-
1704
- ```json
1705
- {
1706
- "upgradePaths": [ ... ]
1707
- }
1708
- ```
1709
-
1710
- #### Example
1711
-
1712
- ```bash
1713
- curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/variation/456/upgrade-paths?params[order_hash]=abc123" \
1714
- -u "username:app_password"
1715
- ```
1716
-
1717
- ---
1718
-
1719
- ## Tax & Shipping Classes
1720
-
1721
- ### Set Product Tax Exemption
1722
-
1723
- `POST /fluent-cart/v2/products/{postId}/tax-exempt`
1724
-
1725
- Set the tax-exempt flag and tax class for an **entire product** — stored on the product detail, not per-variant.
1726
-
1727
- If `tax_class` is omitted, the product's existing tax class (or `standard`) is kept. The **resolved tax class ID** is stored on the product, not the slug.
1728
-
1729
- **Permission:** `products/edit`
1730
-
1731
- #### Parameters
1732
-
1733
- | Parameter | Type | Location | Required | Description |
1734
- |-----------|------|----------|----------|-------------|
1735
- | `postId` | integer | path | Yes | Product post ID |
1736
- | `tax_exempt` | string | body | No | `yes` or `no`. Defaults to `no` |
1737
- | `tax_class` | string | body | No | Slug of an existing tax class. Defaults to the current class, or `standard` |
1738
-
1739
- #### Response
1740
-
1741
- ```json
1742
- { "message": "Product is now tax exempt", "tax_exempt": "yes", "tax_class": 1, "tax_class_slug": "standard" }
1743
- ```
1744
-
1745
- #### Example
1746
-
1747
- ```bash
1748
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/123/tax-exempt" \
1749
- -u "username:app_password" \
1750
- -H "Content-Type: application/json" \
1751
- -d '{"tax_exempt":"yes","tax_class":"standard"}'
1752
- ```
1753
-
1754
- ---
1755
-
1756
- ### Set Variant Tax Exemption
1757
-
1758
- `POST /fluent-cart/v2/products/variants/{variantId}/tax-exempt`
1759
-
1760
- Set the tax-exempt flag and tax class for a **single variant**. If `tax_class` is omitted, the variant's existing class (or `standard` if none is set) is kept. The supplied tax class must already exist.
1761
-
1762
- **Permission:** `products/edit`
1763
-
1764
- #### Parameters
1765
-
1766
- | Parameter | Type | Location | Required | Description |
1767
- |-----------|------|----------|----------|-------------|
1768
- | `variantId` | integer | path | Yes | Product variation ID |
1769
- | `tax_exempt` | string | body | No | `yes` or `no`. Defaults to `no` |
1770
- | `tax_class` | string | body | No | Slug of an existing tax class. Defaults to the current class, or `standard` |
1771
-
1772
- #### Response
1773
-
1774
- ```json
1775
- { "message": "Variation is now tax exempt", "tax_exempt": "yes", "tax_class": "standard", "tax_class_slug": "standard" }
1776
- ```
1777
-
1778
- #### Example
1779
-
1780
- ```bash
1781
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/variants/456/tax-exempt" \
1782
- -u "username:app_password" \
1783
- -H "Content-Type: application/json" \
1784
- -d '{"tax_exempt":"yes"}'
1785
- ```
1786
-
1787
- ---
1788
-
1789
- ### Update Tax Class
1790
-
1791
- `POST /fluent-cart/v2/products/{postId}/tax-class`
1792
-
1793
- Assign a tax class to a product.
1794
-
1795
- **Permission:** `products/edit`
1796
-
1797
- #### Parameters
1798
-
1799
- | Parameter | Type | Location | Required | Description |
1800
- |-----------|------|----------|----------|-------------|
1801
- | `postId` | integer | path | Yes | The product post ID |
1802
- | `tax_class` | integer | body | Yes | Tax class ID |
1803
-
1804
- #### Response
1805
-
1806
- ```json
1807
- {
1808
- "message": "Tax Class updated successfully"
1809
- }
1810
- ```
1811
-
1812
- #### Example
1813
-
1814
- ```bash
1815
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/123/tax-class" \
1816
- -u "username:app_password" \
1817
- -H "Content-Type: application/json" \
1818
- -d '{"tax_class": 5}'
1819
- ```
1820
-
1821
- ---
1822
-
1823
- ### Remove Tax Class
1824
-
1825
- `POST /fluent-cart/v2/products/{postId}/tax-class/remove`
1826
-
1827
- Remove the assigned tax class from a product.
1828
-
1829
- **Permission:** `products/edit`
1830
-
1831
- #### Parameters
1832
-
1833
- | Parameter | Type | Location | Required | Description |
1834
- |-----------|------|----------|----------|-------------|
1835
- | `postId` | integer | path | Yes | The product post ID |
1836
-
1837
- #### Response
1838
-
1839
- ```json
1840
- {
1841
- "message": "Tax Class removed successfully"
1842
- }
1843
- ```
1844
-
1845
- #### Example
1846
-
1847
- ```bash
1848
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/123/tax-class/remove" \
1849
- -u "username:app_password"
1850
- ```
1851
-
1852
- ---
1853
-
1854
- ### Update Shipping Class
1855
-
1856
- `POST /fluent-cart/v2/products/{postId}/shipping-class`
1857
-
1858
- Assign a shipping class to a product.
1859
-
1860
- **Permission:** `products/edit`
1861
-
1862
- #### Parameters
1863
-
1864
- | Parameter | Type | Location | Required | Description |
1865
- |-----------|------|----------|----------|-------------|
1866
- | `postId` | integer | path | Yes | The product post ID |
1867
- | `shipping_class` | integer | body | Yes | Shipping class ID |
1868
-
1869
- #### Response
1870
-
1871
- ```json
1872
- {
1873
- "message": "Shipping Class updated successfully"
1874
- }
1875
- ```
1876
-
1877
- #### Example
1878
-
1879
- ```bash
1880
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/123/shipping-class" \
1881
- -u "username:app_password" \
1882
- -H "Content-Type: application/json" \
1883
- -d '{"shipping_class": 3}'
1884
- ```
1885
-
1886
- ---
1887
-
1888
- ### Remove Shipping Class
1889
-
1890
- `POST /fluent-cart/v2/products/{postId}/shipping-class/remove`
1891
-
1892
- Remove the assigned shipping class from a product.
1893
-
1894
- **Permission:** `products/edit`
1895
-
1896
- #### Parameters
1897
-
1898
- | Parameter | Type | Location | Required | Description |
1899
- |-----------|------|----------|----------|-------------|
1900
- | `postId` | integer | path | Yes | The product post ID |
1901
-
1902
- #### Response
1903
-
1904
- ```json
1905
- {
1906
- "message": "Shipping Class removed successfully"
1907
- }
1908
- ```
1909
-
1910
- #### Example
1911
-
1912
- ```bash
1913
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/123/shipping-class/remove" \
1914
- -u "username:app_password"
1915
- ```
1916
-
1917
- ---
1918
-
1919
- ## Stock Management
1920
-
1921
- ### Update Inventory
1922
-
1923
- `PUT /fluent-cart/v2/products/{postId}/update-inventory/{variantId}`
1924
-
1925
- Update stock levels for a specific variant. Automatically updates stock status and product-level availability.
1926
-
1927
- **Permission:** `products/edit`
1928
-
1929
- #### Parameters
1930
-
1931
- | Parameter | Type | Location | Required | Description |
1932
- |-----------|------|----------|----------|-------------|
1933
- | `postId` | integer | path | Yes | The product post ID |
1934
- | `variantId` | integer | path | Yes | The variant ID to update |
1935
- | `total_stock` | integer | body | Yes | Total stock quantity |
1936
- | `available` | integer | body | Yes | Available stock quantity |
1937
-
1938
- #### Response
1939
-
1940
- ```json
1941
- {
1942
- "message": "Inventory updated successfully"
1943
- }
1944
- ```
1945
-
1946
- #### Example
1947
-
1948
- ```bash
1949
- curl -X PUT "https://example.com/wp-json/fluent-cart/v2/products/123/update-inventory/456" \
1950
- -u "username:app_password" \
1951
- -H "Content-Type: application/json" \
1952
- -d '{
1953
- "total_stock": 100,
1954
- "available": 80
1955
- }'
1956
- ```
1957
-
1958
- ---
1959
-
1960
- ### Update Manage Stock Setting
1961
-
1962
- `PUT /fluent-cart/v2/products/{postId}/update-manage-stock`
1963
-
1964
- Enable or disable stock management for a product and all its variants.
1965
-
1966
- **Permission:** `products/edit`
1967
-
1968
- #### Parameters
1969
-
1970
- | Parameter | Type | Location | Required | Description |
1971
- |-----------|------|----------|----------|-------------|
1972
- | `postId` | integer | path | Yes | The product post ID |
1973
- | `manage_stock` | integer | body | Yes | `1` to enable, `0` to disable stock management |
1974
-
1975
- #### Response
1976
-
1977
- ```json
1978
- {
1979
- "message": "Manage stock updated successfully"
1980
- }
1981
- ```
1982
-
1983
- #### Example
1984
-
1985
- ```bash
1986
- curl -X PUT "https://example.com/wp-json/fluent-cart/v2/products/123/update-manage-stock" \
1987
- -u "username:app_password" \
1988
- -H "Content-Type: application/json" \
1989
- -d '{"manage_stock": 1}'
1990
- ```
1991
-
1992
- ---
1993
-
1994
- ## Downloadables
1995
-
1996
- ### Sync Downloadable Files
1997
-
1998
- `POST /fluent-cart/v2/products/{postId}/sync-downloadable-files`
1999
-
2000
- Attach multiple downloadable files to a product. Automatically enables the `manage_downloadable` flag.
2001
-
2002
- **Permission:** `products/edit`
2003
-
2004
- **Validation Class:** `ProductDownloadableBulkFileRequest`
2005
-
2006
- #### Parameters
2007
-
2008
- | Parameter | Type | Location | Required | Description |
2009
- |-----------|------|----------|----------|-------------|
2010
- | `postId` | integer | path | Yes | The product post ID |
2011
- | `downloadable_files` | array | body | Yes | Array of downloadable file objects |
2012
- | `downloadable_files.*.title` | string | body | Yes | File title (max 160 chars) |
2013
- | `downloadable_files.*.type` | string | body | Yes | File type (max 100 chars) |
2014
- | `downloadable_files.*.driver` | string | body | Yes | Storage driver (max 60 chars, e.g., `local`, `s3`) |
2015
- | `downloadable_files.*.file_name` | string | body | Yes | File name (max 185 chars) |
2016
- | `downloadable_files.*.file_path` | string | body | Yes | File path (max 185 chars) |
2017
- | `downloadable_files.*.file_url` | string | body | Yes | File URL (max 200 chars) |
2018
- | `downloadable_files.*.bucket` | string | body | No | Storage bucket name |
2019
- | `downloadable_files.*.file_size` | string | body | No | File size |
2020
- | `downloadable_files.*.serial` | integer | body | No | Display order serial |
2021
- | `downloadable_files.*.product_variation_id` | array | body | No | Array of variation IDs this file is associated with |
2022
- | `downloadable_files.*.settings.download_limit` | integer | body | No | Maximum number of downloads allowed |
2023
- | `downloadable_files.*.settings.download_expiry` | integer | body | No | Download expiry in days |
2024
-
2025
- #### Response
2026
-
2027
- ```json
2028
- {
2029
- "downloadable_files": [
2030
- {
2031
- "id": 1,
2032
- "post_id": 123,
2033
- "title": "Software v1.0",
2034
- "type": "zip",
2035
- "driver": "local",
2036
- "file_name": "software-v1.zip",
2037
- "download_identifier": "a1b2c3d4-..."
2038
- }
2039
- ]
2040
- }
2041
- ```
2042
-
2043
- #### Example
2044
-
2045
- ```bash
2046
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/123/sync-downloadable-files" \
2047
- -u "username:app_password" \
2048
- -H "Content-Type: application/json" \
2049
- -d '{
2050
- "postId": 123,
2051
- "downloadable_files": [
2052
- {
2053
- "title": "Software v1.0",
2054
- "type": "zip",
2055
- "driver": "local",
2056
- "file_name": "software-v1.zip",
2057
- "file_path": "software-v1.zip",
2058
- "file_url": "software-v1.zip",
2059
- "product_variation_id": [456],
2060
- "settings": {
2061
- "download_limit": 5,
2062
- "download_expiry": 365
2063
- }
2064
- }
2065
- ]
2066
- }'
2067
- ```
2068
-
2069
- ---
2070
-
2071
- ### Update Downloadable File
2072
-
2073
- `PUT /fluent-cart/v2/products/{downloadableId}/update`
2074
-
2075
- Update an existing downloadable file record.
2076
-
2077
- **Permission:** `products/edit`
2078
-
2079
- **Validation Class:** `ProductDownloadableFileRequest`
2080
-
2081
- #### Parameters
2082
-
2083
- | Parameter | Type | Location | Required | Description |
2084
- |-----------|------|----------|----------|-------------|
2085
- | `downloadableId` | integer | path | Yes | The downloadable file ID |
2086
- | `title` | string | body | Yes | File title (max 100 chars) |
2087
- | `type` | string | body | Yes | File type (max 100 chars) |
2088
- | `driver` | string | body | Yes | Storage driver (max 100 chars) |
2089
- | `file_name` | string | body | Yes | File name (max 100 chars) |
2090
- | `product_variation_id` | array | body | No | Array of variation IDs |
2091
- | `serial` | integer | body | No | Display order serial |
2092
- | `settings` | object | body | No | File settings |
2093
- | `settings.download_limit` | integer | body | No | Maximum downloads allowed |
2094
- | `settings.download_expiry` | integer | body | No | Download expiry in days |
2095
-
2096
- #### Response
2097
-
2098
- ```json
2099
- {
2100
- "message": "Product downloadable files updated successfully"
2101
- }
2102
- ```
2103
-
2104
- #### Example
2105
-
2106
- ```bash
2107
- curl -X PUT "https://example.com/wp-json/fluent-cart/v2/products/789/update" \
2108
- -u "username:app_password" \
2109
- -H "Content-Type: application/json" \
2110
- -d '{
2111
- "title": "Software v2.0",
2112
- "type": "zip",
2113
- "driver": "local",
2114
- "file_name": "software-v2.zip",
2115
- "product_variation_id": [456, 457],
2116
- "settings": {
2117
- "download_limit": 10
2118
- }
2119
- }'
2120
- ```
2121
-
2122
- ---
2123
-
2124
- ### Delete Downloadable File
2125
-
2126
- `DELETE /fluent-cart/v2/products/{downloadableId}/delete`
2127
-
2128
- Delete a downloadable file record.
2129
-
2130
- **Permission:** `products/delete`
2131
-
2132
- #### Parameters
2133
-
2134
- | Parameter | Type | Location | Required | Description |
2135
- |-----------|------|----------|----------|-------------|
2136
- | `downloadableId` | integer | path | Yes | The downloadable file ID |
2137
-
2138
- #### Response
2139
-
2140
- ```json
2141
- {
2142
- "message": "File deleted successfully"
2143
- }
2144
- ```
2145
-
2146
- #### Example
2147
-
2148
- ```bash
2149
- curl -X DELETE "https://example.com/wp-json/fluent-cart/v2/products/789/delete" \
2150
- -u "username:app_password"
2151
- ```
2152
-
2153
- ---
2154
-
2155
- ### Get Downloadable URL
2156
-
2157
- `GET /fluent-cart/v2/products/getDownloadableUrl/{downloadableId}`
2158
-
2159
- Generate a temporary download URL for a downloadable file (valid for 7 days).
2160
-
2161
- **Permission:** `products/view`
2162
-
2163
- #### Parameters
2164
-
2165
- | Parameter | Type | Location | Required | Description |
2166
- |-----------|------|----------|----------|-------------|
2167
- | `downloadableId` | integer | path | Yes | The downloadable file ID |
2168
-
2169
- #### Response
2170
-
2171
- ```json
2172
- {
2173
- "url": "https://example.com/fluent-cart/download?token=..."
2174
- }
2175
- ```
2176
-
2177
- #### Example
2178
-
2179
- ```bash
2180
- curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/getDownloadableUrl/789" \
2181
- -u "username:app_password"
2182
- ```
2183
-
2184
- ---
2185
-
2186
- ## Variations
2187
-
2188
- ### List Product Variations
2189
-
2190
- `GET /fluent-cart/v2/products/variants`
2191
-
2192
- Retrieve a list of product variations.
2193
-
2194
- **Permission:** `products/view`
2195
-
2196
- #### Parameters
2197
-
2198
- | Parameter | Type | Location | Required | Description |
2199
- |-----------|------|----------|----------|-------------|
2200
- | `params` | object | query | No | Query parameters for filtering variations |
2201
-
2202
- #### Response
2203
-
2204
- ```json
2205
- {
2206
- "variants": [ ... ]
2207
- }
2208
- ```
2209
-
2210
- #### Example
2211
-
2212
- ```bash
2213
- curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/variants" \
2214
- -u "username:app_password"
2215
- ```
2216
-
2217
- ---
2218
-
2219
- ### Create Variation
2220
-
2221
- `POST /fluent-cart/v2/products/variants`
2222
-
2223
- Create a new product variation.
2224
-
2225
- **Permission:** `products/create`
2226
-
2227
- **Request Class:** `ProductVariationRequest`
2228
-
2229
- #### Parameters
2230
-
2231
- | Parameter | Type | Location | Required | Description |
2232
- |-----------|------|----------|----------|-------------|
2233
- | `variants.post_id` | integer | body | Yes | Parent product ID |
2234
- | `variants.variation_title` | string | body | Yes | Variation title (max 200 chars) |
2235
- | `variants.sku` | string | body | No | SKU (max 30 chars, must be unique) |
2236
- | `variants.item_price` | number | body | No | Price in cents (min: 0) |
2237
- | `variants.compare_price` | number | body | No | Compare-at price in cents (must be >= `item_price`) |
2238
- | `variants.manage_cost` | string | body | No | Enable cost tracking |
2239
- | `variants.item_cost` | number | body | Conditional | Required if `manage_cost` is `true` |
2240
- | `variants.fulfillment_type` | string | body | Yes | `physical` or `digital` |
2241
- | `variants.manage_stock` | integer | body | No | `0` or `1` |
2242
- | `variants.stock_status` | string | body | Conditional | Required if `manage_stock` is `1`. Values: `in-stock`, `out-of-stock` |
2243
- | `variants.total_stock` | integer | body | Yes | Total stock quantity |
2244
- | `variants.available` | integer | body | Yes | Available stock |
2245
- | `variants.committed` | integer | body | Yes | Committed stock |
2246
- | `variants.on_hold` | integer | body | Yes | Stock on hold |
2247
- | `variants.serial_index` | integer | body | No | Display order index |
2248
- | `variants.downloadable` | string | body | No | Downloadable flag |
2249
- | `variants.other_info.payment_type` | string | body | Yes | `onetime` or `subscription` |
2250
- | `variants.other_info.description` | string | body | No | Description (max 255 chars) |
2251
- | `variants.other_info.repeat_interval` | string | body | Conditional | Required for subscriptions (e.g., `monthly`, `yearly`) |
2252
- | `variants.other_info.times` | number | body | No | Number of billing cycles |
2253
- | `variants.other_info.trial_days` | number | body | No | Trial days (max 365) |
2254
- | `variants.other_info.billing_summary` | string | body | No | Billing summary (max 255 chars) |
2255
- | `variants.other_info.manage_setup_fee` | string | body | Conditional | Required for subscriptions: `yes` or `no` |
2256
- | `variants.other_info.signup_fee` | number | body | Conditional | Setup fee in cents. Required if `manage_setup_fee` is `yes` |
2257
- | `variants.other_info.signup_fee_name` | string | body | Conditional | Setup fee label (max 100 chars). Required if `manage_setup_fee` is `yes` |
2258
- | `variants.media` | array | body | No | Media images array with `id`, `url`, `title` |
2259
-
2260
- #### Response
2261
-
2262
- ```json
2263
- {
2264
- "variant": {
2265
- "id": 460,
2266
- "post_id": 123,
2267
- "variation_title": "Pro Plan",
2268
- "item_price": 2999,
2269
- "sku": "PRO-PLN",
2270
- "stock_status": "in-stock"
2271
- },
2272
- "message": "Variation created successfully"
2273
- }
2274
- ```
2275
-
2276
- #### Example
2277
-
2278
- ```bash
2279
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/variants" \
2280
- -u "username:app_password" \
2281
- -H "Content-Type: application/json" \
2282
- -d '{
2283
- "variants": {
2284
- "post_id": 123,
2285
- "variation_title": "Pro Plan",
2286
- "item_price": 2999,
2287
- "sku": "PRO-PLN",
2288
- "fulfillment_type": "digital",
2289
- "total_stock": 1,
2290
- "available": 1,
2291
- "committed": 0,
2292
- "on_hold": 0,
2293
- "other_info": {
2294
- "payment_type": "onetime"
2295
- }
2296
- }
2297
- }'
2298
- ```
2299
-
2300
- ---
2301
-
2302
- ### Update Variation
2303
-
2304
- `POST /fluent-cart/v2/products/variants/{variantId}`
2305
-
2306
- Update an existing product variation.
2307
-
2308
- **Permission:** `products/edit`
2309
-
2310
- **Request Class:** `ProductVariationRequest`
2311
-
2312
- #### Parameters
2313
-
2314
- | Parameter | Type | Location | Required | Description |
2315
- |-----------|------|----------|----------|-------------|
2316
- | `variantId` | integer | path | Yes | The variation ID to update |
2317
-
2318
- All body parameters are the same as Create Variation.
2319
-
2320
- #### Response
2321
-
2322
- ```json
2323
- {
2324
- "variant": { ... },
2325
- "message": "Variation updated successfully"
2326
- }
2327
- ```
2328
-
2329
- #### Example
2330
-
2331
- ```bash
2332
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/variants/460" \
2333
- -u "username:app_password" \
2334
- -H "Content-Type: application/json" \
2335
- -d '{
2336
- "variants": {
2337
- "id": 460,
2338
- "post_id": 123,
2339
- "variation_title": "Pro Plan - Updated",
2340
- "item_price": 3999,
2341
- "fulfillment_type": "digital",
2342
- "total_stock": 1,
2343
- "available": 1,
2344
- "committed": 0,
2345
- "on_hold": 0,
2346
- "other_info": {
2347
- "payment_type": "onetime"
2348
- }
2349
- }
2350
- }'
2351
- ```
2352
-
2353
- ---
2354
-
2355
- ### Delete Variation
2356
-
2357
- `DELETE /fluent-cart/v2/products/variants/{variantId}`
2358
-
2359
- Delete a product variation.
2360
-
2361
- **Permission:** `products/delete`
2362
-
2363
- #### Parameters
2364
-
2365
- | Parameter | Type | Location | Required | Description |
2366
- |-----------|------|----------|----------|-------------|
2367
- | `variantId` | integer | path | Yes | The variation ID to delete |
2368
-
2369
- #### Response
2370
-
2371
- ```json
2372
- {
2373
- "message": "Variation deleted successfully"
2374
- }
2375
- ```
2376
-
2377
- #### Example
2378
-
2379
- ```bash
2380
- curl -X DELETE "https://example.com/wp-json/fluent-cart/v2/products/variants/460" \
2381
- -u "username:app_password"
2382
- ```
2383
-
2384
- ---
2385
-
2386
- ### Set Variation Media
2387
-
2388
- `POST /fluent-cart/v2/products/variants/{variantId}/setMedia`
2389
-
2390
- Set media/images for a variation.
2391
-
2392
- **Permission:** `products/edit`
2393
-
2394
- #### Parameters
2395
-
2396
- | Parameter | Type | Location | Required | Description |
2397
- |-----------|------|----------|----------|-------------|
2398
- | `variantId` | integer | path | Yes | The variation ID |
2399
- | `media` | array | body | Yes | Array of media objects |
2400
- | `media.*.id` | integer | body | Yes | WordPress attachment ID |
2401
- | `media.*.title` | string | body | No | Image title |
2402
- | `media.*.url` | string | body | No | Image URL |
2403
-
2404
- #### Response
2405
-
2406
- ```json
2407
- {
2408
- "message": "Media set successfully"
2409
- }
2410
- ```
2411
-
2412
- #### Example
2413
-
2414
- ```bash
2415
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/variants/460/setMedia" \
2416
- -u "username:app_password" \
2417
- -H "Content-Type: application/json" \
2418
- -d '{
2419
- "media": [
2420
- {
2421
- "id": 101,
2422
- "title": "Product Image",
2423
- "url": "https://example.com/wp-content/uploads/product.jpg"
2424
- }
2425
- ]
2426
- }'
2427
- ```
2428
-
2429
- ---
2430
-
2431
- ### Update Variation Pricing Table
2432
-
2433
- `PUT /fluent-cart/v2/products/variants/{variantId}/pricing-table`
2434
-
2435
- Update the pricing table description for a variation.
2436
-
2437
- **Permission:** `products/edit`
2438
-
2439
- #### Parameters
2440
-
2441
- | Parameter | Type | Location | Required | Description |
2442
- |-----------|------|----------|----------|-------------|
2443
- | `variantId` | integer | path | Yes | The variation ID |
2444
- | `description` | string | body | Yes | Pricing table description text (newlines preserved) |
2445
-
2446
- #### Response
2447
-
2448
- ```json
2449
- {
2450
- "message": "Pricing table updated successfully"
2451
- }
2452
- ```
2453
-
2454
- #### Example
2455
-
2456
- ```bash
2457
- curl -X PUT "https://example.com/wp-json/fluent-cart/v2/products/variants/460/pricing-table" \
2458
- -u "username:app_password" \
2459
- -H "Content-Type: application/json" \
2460
- -d '{
2461
- "description": "Includes:\n- Feature A\n- Feature B\n- Priority Support"
2462
- }'
2463
- ```
2464
-
2465
- ---
2466
-
2467
- ## Variants (VariantController)
2468
-
2469
- ### List All Variants
2470
-
2471
- `GET /fluent-cart/v2/variants`
2472
-
2473
- Retrieve all product variations across all products (separate route group using `VariantController`).
2474
-
2475
- **Permission:** `products/view`
2476
-
2477
- **Policy:** `ProductPolicy`
2478
-
2479
- #### Parameters
2480
-
2481
- | Parameter | Type | Location | Required | Description |
2482
- |-----------|------|----------|----------|-------------|
2483
- | `params` | object | query | No | Query parameters for filtering |
2484
-
2485
- #### Response
2486
-
2487
- ```json
2488
- [
2489
- {
2490
- "id": 456,
2491
- "post_id": 123,
2492
- "variation_title": "Default Plan",
2493
- "item_price": 1000,
2494
- "sku": null,
2495
- "stock_status": "in-stock",
2496
- "payment_type": "onetime",
2497
- "other_info": { ... }
2498
- }
2499
- ]
2500
- ```
2501
-
2502
- #### Example
2503
-
2504
- ```bash
2505
- curl -X GET "https://example.com/wp-json/fluent-cart/v2/variants" \
2506
- -u "username:app_password"
2507
- ```
2508
-
2509
- ---
2510
-
2511
- ## Product Integrations
2512
-
2513
- ### Get Product Integration Feeds
2514
-
2515
- `GET /fluent-cart/v2/products/{productId}/integrations`
2516
-
2517
- Retrieve all integration feeds configured for a product, along with available integrations.
2518
-
2519
- **Permission:** `products/view`
2520
-
2521
- #### Parameters
2522
-
2523
- | Parameter | Type | Location | Required | Description |
2524
- |-----------|------|----------|----------|-------------|
2525
- | `productId` | integer | path | Yes | The product ID |
2526
-
2527
- #### Response
2528
-
2529
- ```json
2530
- {
2531
- "feeds": [
2532
- {
2533
- "id": 10,
2534
- "name": "Add to FluentCRM List",
2535
- "enabled": "yes",
2536
- "provider": "fluentcrm",
2537
- "feed": { ... },
2538
- "scope": "product"
2539
- }
2540
- ],
2541
- "available_integrations": {
2542
- "fluentcrm": {
2543
- "title": "FluentCRM",
2544
- "logo": "...",
2545
- "enabled": true,
2546
- "scopes": ["product", "order"]
2547
- }
2548
- },
2549
- "all_module_config_url": "https://example.com/wp-admin/admin.php?page=fluent-cart#/integrations"
2550
- }
2551
- ```
2552
-
2553
- #### Example
2554
-
2555
- ```bash
2556
- curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/123/integrations" \
2557
- -u "username:app_password"
2558
- ```
2559
-
2560
- ---
2561
-
2562
- ### Get Product Integration Settings
2563
-
2564
- `GET /fluent-cart/v2/products/{product_id}/integrations/{integration_name}/settings`
2565
-
2566
- Retrieve settings for a specific integration type on a product. Returns the integration form configuration, existing settings, and product variations.
2567
-
2568
- **Permission:** `products/view`
2569
-
2570
- #### Parameters
2571
-
2572
- | Parameter | Type | Location | Required | Description |
2573
- |-----------|------|----------|----------|-------------|
2574
- | `product_id` | integer | path | Yes | The product ID |
2575
- | `integration_name` | string | path | Yes | Integration provider name (e.g., `fluentcrm`) |
2576
- | `integration_id` | integer | query | No | Existing integration feed ID to load for editing |
2577
-
2578
- #### Response
2579
-
2580
- ```json
2581
- {
2582
- "settings": {
2583
- "conditional_variation_ids": [],
2584
- ...
2585
- },
2586
- "fields": [ ... ],
2587
- "product_variations": [
2588
- {
2589
- "id": 456,
2590
- "title": "Monthly Plan"
2591
- }
2592
- ],
2593
- "scope": "product"
2594
- }
2595
- ```
2596
-
2597
- #### Example
2598
-
2599
- ```bash
2600
- curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/123/integrations/fluentcrm/settings" \
2601
- -u "username:app_password"
2602
- ```
2603
-
2604
- ---
2605
-
2606
- ### Save Product Integration
2607
-
2608
- `POST /fluent-cart/v2/products/{product_id}/integrations`
2609
-
2610
- Create or update an integration feed for a product.
2611
-
2612
- **Permission:** `products/edit`
2613
-
2614
- #### Parameters
2615
-
2616
- | Parameter | Type | Location | Required | Description |
2617
- |-----------|------|----------|----------|-------------|
2618
- | `product_id` | integer | path | Yes | The product ID |
2619
- | `integration_name` | string | body | Yes | Integration provider name |
2620
- | `integration_id` | integer | body | No | Existing feed ID (for updates) |
2621
- | `integration` | string (JSON) | body | Yes | JSON-encoded integration settings object |
2622
-
2623
- #### Response
2624
-
2625
- ```json
2626
- {
2627
- "message": "Integration has been successfully saved",
2628
- "integration": { ... }
2629
- }
2630
- ```
2631
-
2632
- #### Example
2633
-
2634
- ```bash
2635
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/123/integrations" \
2636
- -u "username:app_password" \
2637
- -H "Content-Type: application/json" \
2638
- -d '{
2639
- "integration_name": "fluentcrm",
2640
- "integration": "{\"list_id\": 1, \"tags\": [5, 10]}"
2641
- }'
2642
- ```
2643
-
2644
- ---
2645
-
2646
- ### Update Product Integration
2647
-
2648
- There is **no `PUT /products/{product_id}/integrations/{integration_id}`** — the published API reference documents only `DELETE` on that path.
2649
-
2650
- Updating goes back through the save endpoint with the feed's `integration_id` in the body:
2651
-
2652
- ```bash
2653
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/123/integrations" \
2654
- -u "username:app_password" \
2655
- -H "Content-Type: application/json" \
2656
- -d '{
2657
- "integration_id": 10,
2658
- "integration_name": "fluentcrm",
2659
- "integration": "{\"list_id\": 2, \"tags\": [5, 15]}",
2660
- "enabled": "yes",
2661
- "name": "Updated FluentCRM Feed"
2662
- }'
2663
- ```
2664
-
2665
- See [Save Product Integration](#save-product-integration) for the full parameter list.
2666
-
2667
- ---
2668
-
2669
- ### Delete Product Integration
2670
-
2671
- `DELETE /fluent-cart/v2/products/{product_id}/integrations/{integration_id}`
2672
-
2673
- Delete a product integration feed.
2674
-
2675
- **Permission:** `products/delete`
2676
-
2677
- #### Parameters
2678
-
2679
- | Parameter | Type | Location | Required | Description |
2680
- |-----------|------|----------|----------|-------------|
2681
- | `product_id` | integer | path | Yes | The product ID |
2682
- | `integration_id` | integer | path | Yes | The integration feed ID |
2683
-
2684
- #### Response
2685
-
2686
- ```json
2687
- {
2688
- "message": "Integration has been deleted successfully"
2689
- }
2690
- ```
2691
-
2692
- #### Example
2693
-
2694
- ```bash
2695
- curl -X DELETE "https://example.com/wp-json/fluent-cart/v2/products/123/integrations/10" \
2696
- -u "username:app_password"
2697
- ```
1
+ # Products API
2
+
3
+ Manage your product catalog including creating products, managing variations, downloadable files, bundles, upgrade paths, tax/shipping classes, stock management, and product integrations.
4
+
5
+ **Base URL:** `https://your-site.com/wp-json/fluent-cart/v2/products`
6
+
7
+ **Policy:** `ProductPolicy`
8
+
9
+ > All monetary values are in **cents** (e.g., `$10.00` = `1000`).
10
+
11
+ ---
12
+
13
+ ## Product CRUD & Listing
14
+
15
+ ### List Products
16
+
17
+ GET `/fluent-cart/v2/products`
18
+
19
+ Retrieve a paginated list of products with filtering, sorting, and search capabilities.
20
+
21
+ - **Permission:** `products/view`
22
+
23
+ #### Parameters
24
+
25
+ | Parameter | Type | Location | Required | Description |
26
+ | --- | --- | --- | --- | --- |
27
+ | `search` | string | query | No | Search by product title, ID, or variation title |
28
+ | `per_page` | integer | query | No | Number of results per page (default: `10`) |
29
+ | `page` | integer | query | No | Page number for pagination |
30
+ | `sort_by` | string | query | No | Column to sort by (default: `ID`) |
31
+ | `sort_type` | string | query | No | Sort direction: `asc` or `desc` (default: `desc`) |
32
+ | `active_view` | string | query | No | Filter tab: `publish`, `draft`, `physical`, `digital`, `subscribable`, `not_subscribable`, `bundle`, `non_bundle` |
33
+ | `filter_type` | string | query | No | `simple` or `advanced` |
34
+ | `with` | array | query | No | Relations to eager load |
35
+ | `search_groups` | array | query | No | Advanced filter groups for complex queries |
36
+
37
+ #### Response
38
+
39
+ ```
40
+ {
41
+ "products": {
42
+ "total": 50,
43
+ "per_page": 10,
44
+ "current_page": 1,
45
+ "last_page": 5,
46
+ "data": [
47
+ {
48
+ "ID": 123,
49
+ "post_title": "Example Product",
50
+ "post_status": "publish",
51
+ "post_date": "2025-01-15 12:00:00",
52
+ "view_url": "https://example.com/product/example-product",
53
+ "edit_url": "https://example.com/wp-admin/admin.php?page=fluent-cart#/products/123"
54
+ }
55
+ ]
56
+ }
57
+ }
58
+ ```
59
+
60
+ #### Example
61
+
62
+ ```
63
+ curl -X GET "https://example.com/wp-json/fluent-cart/v2/products?search=widget&per_page=20&active_view=publish" \
64
+ -u "username:app_password"
65
+ ```
66
+
67
+ ---
68
+
69
+ ### Get Product
70
+
71
+ GET `/fluent-cart/v2/products/{product}`
72
+
73
+ Retrieve a single product by ID.
74
+
75
+ - **Permission:** `products/view`
76
+
77
+ #### Parameters
78
+
79
+ | Parameter | Type | Location | Required | Description |
80
+ | --- | --- | --- | --- | --- |
81
+ | `product` | integer | path | Yes | The product ID |
82
+ | `with` | array | query | No | Relations to eager load (e.g., `["detail", "variants", "product_menu"]`) |
83
+
84
+ #### Response
85
+
86
+ ```
87
+ {
88
+ "product": {
89
+ "ID": 123,
90
+ "post_title": "Example Product",
91
+ "post_status": "publish",
92
+ "post_excerpt": "Short description",
93
+ "post_content": "Full description"
94
+ },
95
+ "product_menu": []
96
+ }
97
+ ```
98
+
99
+ #### Example
100
+
101
+ ```
102
+ curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/123?with[]=detail&with[]=variants" \
103
+ -u "username:app_password"
104
+ ```
105
+
106
+ ---
107
+
108
+ ### Create Product
109
+
110
+ POST `/fluent-cart/v2/products`
111
+
112
+ Create a new product. A default variation is automatically created with the product.
113
+
114
+ - **Permission:** `products/create`
115
+ - **Request Class:** `ProductCreateRequest`
116
+
117
+ #### Parameters
118
+
119
+ | Parameter | Type | Location | Required | Description |
120
+ | --- | --- | --- | --- | --- |
121
+ | `post_title` | string | body | Yes | Product title (max 200 characters) |
122
+ | `post_status` | string | body | No | Post status (e.g., `draft`, `publish`) |
123
+ | `detail.fulfillment_type` | string | body | No | `physical` or `digital` (default: `digital`) |
124
+ | `detail.other_info.is_bundle_product` | string | body | No | `yes` or `no` (default: `no`) |
125
+
126
+ #### Response
127
+
128
+ ```
129
+ {
130
+ "data": {
131
+ "ID": 124,
132
+ "variant": {
133
+ "id": 456,
134
+ "post_id": 124,
135
+ "variation_title": "Example Product",
136
+ "stock_status": "in-stock",
137
+ "payment_type": "onetime",
138
+ "total_stock": 1,
139
+ "available": 1,
140
+ "fulfillment_type": "digital"
141
+ },
142
+ "product_details": { ... }
143
+ },
144
+ "message": "Product has been created successfully"
145
+ }
146
+ ```
147
+
148
+ #### Example
149
+
150
+ ```
151
+ curl -X POST "https://example.com/wp-json/fluent-cart/v2/products" \
152
+ -u "username:app_password" \
153
+ -H "Content-Type: application/json" \
154
+ -d '{
155
+ "post_title": "New Digital Product",
156
+ "post_status": "draft",
157
+ "detail": {
158
+ "fulfillment_type": "digital"
159
+ }
160
+ }'
161
+ ```
162
+
163
+ ---
164
+
165
+ ### Delete Product
166
+
167
+ DELETE `/fluent-cart/v2/products/{product}`
168
+
169
+ Delete a product and all associated data.
170
+
171
+ - **Permission:** `products/delete`
172
+
173
+ #### Parameters
174
+
175
+ | Parameter | Type | Location | Required | Description |
176
+ | --- | --- | --- | --- | --- |
177
+ | `product` | integer | path | Yes | The product ID to delete |
178
+
179
+ #### Response
180
+
181
+ ```
182
+ {
183
+ "message": "Product deleted successfully"
184
+ }
185
+ ```
186
+
187
+ #### Example
188
+
189
+ ```
190
+ curl -X DELETE "https://example.com/wp-json/fluent-cart/v2/products/123" \
191
+ -u "username:app_password"
192
+ ```
193
+
194
+ ---
195
+
196
+ ### Get Product Pricing
197
+
198
+ GET `/fluent-cart/v2/products/{productId}/pricing`
199
+
200
+ Retrieve the full product details including pricing, variants, downloadable files, and taxonomy information.
201
+
202
+ - **Permission:** `products/view`
203
+
204
+ #### Parameters
205
+
206
+ | Parameter | Type | Location | Required | Description |
207
+ | --- | --- | --- | --- | --- |
208
+ | `productId` | integer | path | Yes | The product ID |
209
+ | `with` | array | query | No | Additional relations (e.g., `["product_menu"]`) |
210
+
211
+ #### Response
212
+
213
+ ```
214
+ {
215
+ "product": {
216
+ "ID": 123,
217
+ "post_title": "Example Product",
218
+ "post_status": "publish",
219
+ "post_excerpt": "Short description",
220
+ "featured_image_id": 456,
221
+ "view_url": "https://example.com/product/example",
222
+ "edit_url": "https://example.com/wp-admin/admin.php?page=fluent-cart#/products/123",
223
+ "detail": {
224
+ "id": 1,
225
+ "post_id": 123,
226
+ "fulfillment_type": "digital",
227
+ "variation_type": "simple",
228
+ "manage_stock": 0,
229
+ "manage_downloadable": 0,
230
+ "other_info": { ... }
231
+ },
232
+ "variants": [
233
+ {
234
+ "id": 789,
235
+ "post_id": 123,
236
+ "variation_title": "Default Plan",
237
+ "item_price": 1000,
238
+ "compare_price": 0,
239
+ "stock_status": "in-stock",
240
+ "other_info": { ... },
241
+ "media": []
242
+ }
243
+ ],
244
+ "downloadable_files": []
245
+ },
246
+ "product_menu": "",
247
+ "taxonomies": [
248
+ {
249
+ "name": "product-categories",
250
+ "label": "Product Categories",
251
+ "terms": [],
252
+ "labels": { ... }
253
+ }
254
+ ]
255
+ }
256
+ ```
257
+
258
+ #### Example
259
+
260
+ ```
261
+ curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/123/pricing?with[]=product_menu" \
262
+ -u "username:app_password"
263
+ ```
264
+
265
+ ---
266
+
267
+ ### Update Product Pricing
268
+
269
+ POST `/fluent-cart/v2/products/{postId}/pricing`
270
+
271
+ Update a product's pricing, details, variants, and other metadata.
272
+
273
+ - **Permission:** `products/edit`
274
+ - **Request Class:** `ProductUpdateRequest`
275
+
276
+ #### Parameters
277
+
278
+ | Parameter | Type | Location | Required | Description |
279
+ | --- | --- | --- | --- | --- |
280
+ | `postId` | integer | path | Yes | The product post ID |
281
+ | `post_title` | string | body | Yes | Product title (max 200 characters) |
282
+ | `post_status` | string | body | Yes | Status: `draft`, `publish`, `future` |
283
+ | `post_date` | string | body | Conditional | Required when `post_status` is `future`. Must be a future date (GMT) |
284
+ | `post_excerpt` | string | body | No | Product short description (limited by `excerpt_length` filter, default 55 words) |
285
+ | `post_content` | string | body | No | Product long description (HTML allowed) |
286
+ | `post_name` | string | body | No | Product URL slug |
287
+ | `comment_status` | string | body | No | Comment status (max 100 chars) |
288
+ | `detail.fulfillment_type` | string | body | Yes | `physical` or `digital` |
289
+ | `detail.variation_type` | string | body | Yes | `simple` or `simple_variations` |
290
+ | `detail.manage_stock` | integer | body | No | `0` or `1` |
291
+ | `detail.manage_downloadable` | integer | body | No | `0` or `1` |
292
+ | `detail.default_variation_id` | integer | body | No | Default variation ID |
293
+ | `detail.stock_availability` | string | body | No | Stock availability status |
294
+ | `detail.other_info.group_pricing_by` | string | body | No | `payment_type`, `repeat_interval`, or `none` |
295
+ | `detail.other_info.sold_individually` | string | body | No | `yes` or `no` |
296
+ | `detail.other_info.use_pricing_table` | string | body | No | Enable pricing table display |
297
+ | `detail.other_info.shipping_class` | integer | body | No | Shipping class ID (validated) |
298
+ | `detail.other_info.tax_class` | integer | body | No | Tax class ID (validated) |
299
+ | `detail.other_info.active_editor` | string | body | No | Active editor mode |
300
+ | `variants` | array | body | Conditional | Array of variant objects (required for `simple` type when publishing) |
301
+ | `variants.*.variation_title` | string | body | Yes | Variation title (max 200 chars) |
302
+ | `variants.*.post_id` | integer | body | Yes | Parent product post ID |
303
+ | `variants.*.item_price` | number | body | No | Price in cents (min: 0) |
304
+ | `variants.*.compare_price` | number | body | No | Compare-at price in cents (must be >= `item_price`) |
305
+ | `variants.*.manage_cost` | string | body | No | Enable cost tracking |
306
+ | `variants.*.item_cost` | number | body | Conditional | Required if `manage_cost` is `true` |
307
+ | `variants.*.serial_index` | integer | body | No | Display order index |
308
+ | `variants.*.sku` | string | body | No | SKU (max 30 chars, must be unique) |
309
+ | `variants.*.fulfillment_type` | string | body | No | `physical` or `digital` |
310
+ | `variants.*.other_info.payment_type` | string | body | Yes | `onetime` or `subscription` |
311
+ | `variants.*.other_info.description` | string | body | No | Variant description (max 255 chars) |
312
+ | `variants.*.other_info.repeat_interval` | string | body | Conditional | Required for subscriptions. e.g., `monthly`, `yearly` |
313
+ | `variants.*.other_info.times` | string | body | No | Number of billing cycles |
314
+ | `variants.*.other_info.trial_days` | string | body | No | Trial period in days (max 365) |
315
+ | `variants.*.other_info.billing_summary` | string | body | No | Billing summary text (max 255 chars) |
316
+ | `variants.*.other_info.manage_setup_fee` | string | body | Conditional | Required for subscriptions: `yes` or `no` |
317
+ | `variants.*.other_info.signup_fee` | number | body | Conditional | Setup fee in cents. Required if `manage_setup_fee` is `yes` |
318
+ | `variants.*.other_info.signup_fee_name` | string | body | Conditional | Setup fee label (max 100 chars). Required if `manage_setup_fee` is `yes` |
319
+ | `variants.*.other_info.installment` | string | body | No | Enable installment: `yes` or `no` |
320
+ | `product_terms` | object | body | No | Taxonomy term IDs (e.g., `{"product-categories": [1, 2]}`) |
321
+ | `gallery` | array | body | No | Gallery images array with `id`, `url`, `title` |
322
+ | `metaValue` | mixed | body | No | Additional metadata |
323
+
324
+ #### Response
325
+
326
+ ```
327
+ {
328
+ "data": { ... },
329
+ "message": "Product updated successfully"
330
+ }
331
+ ```
332
+
333
+ #### Example
334
+
335
+ ```
336
+ curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/123/pricing" \
337
+ -u "username:app_password" \
338
+ -H "Content-Type: application/json" \
339
+ -d '{
340
+ "post_title": "Updated Product",
341
+ "post_status": "publish",
342
+ "detail": {
343
+ "fulfillment_type": "digital",
344
+ "variation_type": "simple"
345
+ },
346
+ "variants": [
347
+ {
348
+ "id": 789,
349
+ "post_id": 123,
350
+ "variation_title": "Default Plan",
351
+ "item_price": 1999,
352
+ "other_info": {
353
+ "payment_type": "onetime"
354
+ }
355
+ }
356
+ ]
357
+ }'
358
+ ```
359
+
360
+ ---
361
+
362
+ ## Product Search & Lookup
363
+
364
+ ### Search Products by Name
365
+
366
+ GET `/fluent-cart/v2/products/searchProductByName`
367
+
368
+ Search for published products by name. Returns products formatted for select dropdowns.
369
+
370
+ - **Permission:** `products/view`
371
+
372
+ #### Parameters
373
+
374
+ | Parameter | Type | Location | Required | Description |
375
+ | --- | --- | --- | --- | --- |
376
+ | `name` | string | query | No | Product name to search for |
377
+ | `url_mode` | string | query | No | URL mode flag |
378
+ | `termId` | integer | query | No | Filter by taxonomy term ID (product-categories) |
379
+
380
+ #### Response
381
+
382
+ ```
383
+ {
384
+ "products": [
385
+ {
386
+ "ID": 123,
387
+ "post_title": "Example Product",
388
+ "wpTerms": [...]
389
+ }
390
+ ]
391
+ }
392
+ ```
393
+
394
+ #### Example
395
+
396
+ ```
397
+ curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/searchProductByName?name=widget" \
398
+ -u "username:app_password"
399
+ ```
400
+
401
+ ---
402
+
403
+ ### Search Variants by Name
404
+
405
+ GET `/fluent-cart/v2/products/searchVariantByName`
406
+
407
+ Search for published product variants by name. Returns a hierarchical product > variants structure.
408
+
409
+ - **Permission:** `products/view`
410
+
411
+ #### Parameters
412
+
413
+ | Parameter | Type | Location | Required | Description |
414
+ | --- | --- | --- | --- | --- |
415
+ | `name` | string | query | No | Product/variant name to search |
416
+ | `search` | string | query | No | Alternative search parameter (used if `name` is empty) |
417
+ | `ids` | array | query | No | Array of product IDs to include |
418
+
419
+ #### Response
420
+
421
+ ```
422
+ [
423
+ {
424
+ "value": 123,
425
+ "label": "Example Product",
426
+ "children": [
427
+ {
428
+ "value": 456,
429
+ "label": "Monthly Plan"
430
+ },
431
+ {
432
+ "value": 457,
433
+ "label": "Yearly Plan"
434
+ }
435
+ ]
436
+ }
437
+ ]
438
+ ```
439
+
440
+ #### Example
441
+
442
+ ```
443
+ curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/searchVariantByName?name=pro" \
444
+ -u "username:app_password"
445
+ ```
446
+
447
+ ---
448
+
449
+ ### Search Product Variant Options
450
+
451
+ GET `/fluent-cart/v2/products/search-product-variant-options`
452
+
453
+ Search for product variants suitable for selection (e.g., in order creation). Filters out out-of-stock items.
454
+
455
+ - **Permission:** `products/view`
456
+
457
+ #### Parameters
458
+
459
+ | Parameter | Type | Location | Required | Description |
460
+ | --- | --- | --- | --- | --- |
461
+ | `search` | string | query | No | Search term for product/variant title |
462
+ | `include_ids` | array | query | No | Variation IDs to always include in results |
463
+ | `scopes` | array | query | No | Model scopes to apply |
464
+ | `subscription_status` | string | query | No | `not_subscribable` to exclude subscription variants |
465
+
466
+ #### Response
467
+
468
+ ```
469
+ {
470
+ "products": [
471
+ {
472
+ "value": "product_123",
473
+ "label": "Example Product",
474
+ "children": [
475
+ {
476
+ "value": 456,
477
+ "label": "Monthly Plan"
478
+ }
479
+ ]
480
+ }
481
+ ]
482
+ }
483
+ ```
484
+
485
+ #### Example
486
+
487
+ ```
488
+ curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/search-product-variant-options?search=pro&subscription_status=not_subscribable" \
489
+ -u "username:app_password"
490
+ ```
491
+
492
+ ---
493
+
494
+ ### Find Subscription Variants
495
+
496
+ GET `/fluent-cart/v2/products/findSubscriptionVariants`
497
+
498
+ Search for product variants that have a subscription payment type.
499
+
500
+ - **Permission:** `products/view`
501
+
502
+ #### Parameters
503
+
504
+ | Parameter | Type | Location | Required | Description |
505
+ | --- | --- | --- | --- | --- |
506
+ | `name` | string | query | No | Variant title to search |
507
+
508
+ #### Response
509
+
510
+ ```
511
+ [
512
+ {
513
+ "id": 456,
514
+ "title": "Monthly Subscription"
515
+ },
516
+ {
517
+ "id": 457,
518
+ "title": "Yearly Subscription"
519
+ }
520
+ ]
521
+ ```
522
+
523
+ #### Example
524
+
525
+ ```
526
+ curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/findSubscriptionVariants?name=monthly" \
527
+ -u "username:app_password"
528
+ ```
529
+
530
+ ---
531
+
532
+ ### Fetch Products by IDs
533
+
534
+ GET `/fluent-cart/v2/products/fetchProductsByIds`
535
+
536
+ Retrieve products by an array of IDs. Returns products with their detail relation.
537
+
538
+ - **Permission:** `products/view`
539
+
540
+ #### Parameters
541
+
542
+ | Parameter | Type | Location | Required | Description |
543
+ | --- | --- | --- | --- | --- |
544
+ | `productIds` | array | query | Yes | Array of product IDs to fetch |
545
+
546
+ #### Response
547
+
548
+ ```
549
+ {
550
+ "products": [
551
+ {
552
+ "ID": 123,
553
+ "post_title": "Example Product",
554
+ "detail": { ... }
555
+ }
556
+ ]
557
+ }
558
+ ```
559
+
560
+ #### Example
561
+
562
+ ```
563
+ curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/fetchProductsByIds?productIds[]=123&productIds[]=456" \
564
+ -u "username:app_password"
565
+ ```
566
+
567
+ ---
568
+
569
+ ### Fetch Variations by IDs
570
+
571
+ GET `/fluent-cart/v2/products/fetchVariationsByIds`
572
+
573
+ Retrieve variations by an array of IDs. Returns simplified label/value pairs.
574
+
575
+ - **Permission:** `products/view`
576
+
577
+ #### Parameters
578
+
579
+ | Parameter | Type | Location | Required | Description |
580
+ | --- | --- | --- | --- | --- |
581
+ | `productIds` | array | query | Yes | Array of variation IDs to fetch |
582
+
583
+ #### Response
584
+
585
+ ```
586
+ {
587
+ "products": [
588
+ {
589
+ "value": 456,
590
+ "label": "Monthly Plan"
591
+ },
592
+ {
593
+ "value": 457,
594
+ "label": "Yearly Plan"
595
+ }
596
+ ]
597
+ }
598
+ ```
599
+
600
+ #### Example
601
+
602
+ ```
603
+ curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/fetchVariationsByIds?productIds[]=456&productIds[]=457" \
604
+ -u "username:app_password"
605
+ ```
606
+
607
+ ---
608
+
609
+ ### Suggest SKU
610
+
611
+ GET `/fluent-cart/v2/products/suggest-sku`
612
+
613
+ Generate a unique SKU suggestion based on product and variant titles.
614
+
615
+ - **Permission:** `products/view`
616
+
617
+ #### Parameters
618
+
619
+ | Parameter | Type | Location | Required | Description |
620
+ | --- | --- | --- | --- | --- |
621
+ | `title` | string | query | Yes | Product title to base SKU on |
622
+ | `variant_title` | string | query | No | Variant title to include in SKU |
623
+ | `exclude_id` | integer | query | No | Variation ID to exclude from uniqueness check |
624
+
625
+ #### Response
626
+
627
+ ```
628
+ {
629
+ "sku": "EXA-PRO-MON"
630
+ }
631
+ ```
632
+
633
+ #### Example
634
+
635
+ ```
636
+ curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/suggest-sku?title=Example%20Product&variant_title=Monthly" \
637
+ -u "username:app_password"
638
+ ```
639
+
640
+ ---
641
+
642
+ ### Get Max Excerpt Word Count
643
+
644
+ GET `/fluent-cart/v2/products/get-max-excerpt-word-count`
645
+
646
+ Returns the maximum allowed word count for product excerpts (controlled by the WordPress `excerpt_length` filter).
647
+
648
+ - **Permission:** `products/view`
649
+
650
+ #### Parameters
651
+
652
+ None.
653
+
654
+ #### Response
655
+
656
+ ```
657
+ {
658
+ "count": 55
659
+ }
660
+ ```
661
+
662
+ #### Example
663
+
664
+ ```
665
+ curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/get-max-excerpt-word-count" \
666
+ -u "username:app_password"
667
+ ```
668
+
669
+ ---
670
+
671
+ ### Fetch Taxonomy Terms
672
+
673
+ GET `/fluent-cart/v2/products/fetch-term`
674
+
675
+ Retrieve all registered taxonomies and their terms for product categorization.
676
+
677
+ - **Permission:** `products/view`
678
+
679
+ #### Parameters
680
+
681
+ None.
682
+
683
+ #### Response
684
+
685
+ ```
686
+ {
687
+ "taxonomies": [
688
+ {
689
+ "name": "product-categories",
690
+ "label": "Product Categories",
691
+ "terms": [
692
+ {
693
+ "value": 1,
694
+ "label": "Software",
695
+ "children": []
696
+ }
697
+ ]
698
+ },
699
+ {
700
+ "name": "product-brands",
701
+ "label": "Product Brands",
702
+ "terms": []
703
+ }
704
+ ]
705
+ }
706
+ ```
707
+
708
+ #### Example
709
+
710
+ ```
711
+ curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/fetch-term" \
712
+ -u "username:app_password"
713
+ ```
714
+
715
+ ---
716
+
717
+ ### Fetch Terms by Parent
718
+
719
+ POST `/fluent-cart/v2/products/fetch-term-by-parent`
720
+
721
+ Retrieve taxonomy terms filtered by parent term IDs.
722
+
723
+ - **Permission:** `products/view`
724
+
725
+ #### Parameters
726
+
727
+ | Parameter | Type | Location | Required | Description |
728
+ | --- | --- | --- | --- | --- |
729
+ | `parents` | array | body | Yes | Array of parent term IDs |
730
+ | `listeners` | array | body | Yes | Array of taxonomy names to retrieve terms for |
731
+
732
+ #### Response
733
+
734
+ ```
735
+ {
736
+ "data": {
737
+ "product-categories": [
738
+ {
739
+ "value": 5,
740
+ "label": "Sub Category"
741
+ }
742
+ ]
743
+ }
744
+ }
745
+ ```
746
+
747
+ #### Example
748
+
749
+ ```
750
+ curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/fetch-term-by-parent" \
751
+ -u "username:app_password" \
752
+ -H "Content-Type: application/json" \
753
+ -d '{
754
+ "parents": [1, 2],
755
+ "listeners": ["product-categories"]
756
+ }'
757
+ ```
758
+
759
+ ---
760
+
761
+ ## Bulk Operations
762
+
763
+ ### Bulk Insert Products
764
+
765
+ POST `/fluent-cart/v2/products/bulk-insert`
766
+
767
+ Insert multiple products at once. Maximum 10 products per request.
768
+
769
+ - **Permission:** `products/create`
770
+
771
+ #### Parameters
772
+
773
+ | Parameter | Type | Location | Required | Description |
774
+ | --- | --- | --- | --- | --- |
775
+ | `products` | array | body | Yes | Array of product data objects (max 10) |
776
+
777
+ #### Response
778
+
779
+ ```
780
+ {
781
+ "message": "3 product(s) created successfully",
782
+ "created": [ ... ],
783
+ "errors": []
784
+ }
785
+ ```
786
+
787
+ #### Example
788
+
789
+ ```
790
+ curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/bulk-insert" \
791
+ -u "username:app_password" \
792
+ -H "Content-Type: application/json" \
793
+ -d '{
794
+ "products": [
795
+ {
796
+ "post_title": "Product A",
797
+ "detail": { "fulfillment_type": "digital" }
798
+ },
799
+ {
800
+ "post_title": "Product B",
801
+ "detail": { "fulfillment_type": "physical" }
802
+ }
803
+ ]
804
+ }'
805
+ ```
806
+
807
+ ---
808
+
809
+ ### Bulk Edit Fetch
810
+
811
+ GET `/fluent-cart/v2/products/bulk-edit-data`
812
+
813
+ Fetch products formatted for the bulk editing spreadsheet view.
814
+
815
+ - **Permission:** `products/edit`
816
+
817
+ #### Parameters
818
+
819
+ Standard filter parameters (see [List Products](#list-products)).
820
+
821
+ #### Response
822
+
823
+ ```
824
+ {
825
+ "products": [ ... ],
826
+ "columns": [ ... ]
827
+ }
828
+ ```
829
+
830
+ #### Example
831
+
832
+ ```
833
+ curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/bulk-edit-data" \
834
+ -u "username:app_password"
835
+ ```
836
+
837
+ ---
838
+
839
+ ### Bulk Update Products
840
+
841
+ POST `/fluent-cart/v2/products/bulk-update`
842
+
843
+ Update multiple products at once from the bulk edit view. Maximum 10 products per request.
844
+
845
+ - **Permission:** `products/edit`
846
+
847
+ #### Parameters
848
+
849
+ | Parameter | Type | Location | Required | Description |
850
+ | --- | --- | --- | --- | --- |
851
+ | `products` | array | body | Yes | Array of product data objects to update (max 10) |
852
+
853
+ #### Response
854
+
855
+ ```
856
+ {
857
+ "message": "3 product(s) updated successfully",
858
+ "updated": [ ... ],
859
+ "errors": []
860
+ }
861
+ ```
862
+
863
+ #### Example
864
+
865
+ ```
866
+ curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/bulk-update" \
867
+ -u "username:app_password" \
868
+ -H "Content-Type: application/json" \
869
+ -d '{
870
+ "products": [
871
+ {
872
+ "ID": 123,
873
+ "post_title": "Updated Title A"
874
+ }
875
+ ]
876
+ }'
877
+ ```
878
+
879
+ ---
880
+
881
+ ### Do Bulk Action
882
+
883
+ POST `/fluent-cart/v2/products/do-bulk-action`
884
+
885
+ Perform bulk actions on selected products (e.g., publish, draft, delete).
886
+
887
+ - **Permission:** `products/edit`
888
+
889
+ #### Parameters
890
+
891
+ | Parameter | Type | Location | Required | Description |
892
+ | --- | --- | --- | --- | --- |
893
+ | `action` | string | body | Yes | The bulk action to perform |
894
+ | `product_ids` | array | body | Yes | Array of product IDs to act on |
895
+
896
+ #### Response
897
+
898
+ ```
899
+ {
900
+ "message": "Bulk action completed successfully"
901
+ }
902
+ ```
903
+
904
+ #### Example
905
+
906
+ ```
907
+ curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/do-bulk-action" \
908
+ -u "username:app_password" \
909
+ -H "Content-Type: application/json" \
910
+ -d '{
911
+ "action": "publish",
912
+ "product_ids": [123, 456, 789]
913
+ }'
914
+ ```
915
+
916
+ ---
917
+
918
+ ### Create Dummy Products
919
+
920
+ POST `/fluent-cart/v2/products/create-dummy`
921
+
922
+ Create sample/demo products for testing or onboarding purposes.
923
+
924
+ - **Permission:** `products/create`
925
+
926
+ #### Parameters
927
+
928
+ | Parameter | Type | Location | Required | Description |
929
+ | --- | --- | --- | --- | --- |
930
+ | `category` | string | body | No | Product category for dummy products |
931
+ | `index` | integer | body | No | Index for dummy product generation |
932
+
933
+ #### Response
934
+
935
+ Returns the created dummy product data.
936
+
937
+ #### Example
938
+
939
+ ```
940
+ curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/create-dummy" \
941
+ -u "username:app_password" \
942
+ -H "Content-Type: application/json" \
943
+ -d '{
944
+ "category": "digital",
945
+ "index": 1
946
+ }'
947
+ ```
948
+
949
+ ---
950
+
951
+ ## Product Details & Configuration
952
+
953
+ ### Duplicate Product
954
+
955
+ POST `/fluent-cart/v2/products/{productId}/duplicate`
956
+
957
+ Duplicate a product with options to include or exclude certain settings. The new product is saved as a draft.
958
+
959
+ - **Permission:** `products/create`
960
+
961
+ #### Parameters
962
+
963
+ | Parameter | Type | Location | Required | Description |
964
+ | --- | --- | --- | --- | --- |
965
+ | `productId` | integer | path | Yes | The product ID to duplicate |
966
+ | `import_stock_management` | string | body | No | Include stock management settings (`true`/`false`) |
967
+ | `import_license_settings` | string | body | No | Include license settings (`true`/`false`) |
968
+ | `import_downloadable_files` | string | body | No | Include downloadable files (`true`/`false`) |
969
+
970
+ #### Response
971
+
972
+ ```
973
+ {
974
+ "product_id": 125,
975
+ "message": "Product duplicated successfully. The new product has been saved as a draft."
976
+ }
977
+ ```
978
+
979
+ #### Example
980
+
981
+ ```
982
+ curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/123/duplicate" \
983
+ -u "username:app_password" \
984
+ -H "Content-Type: application/json" \
985
+ -d '{
986
+ "import_stock_management": "true",
987
+ "import_license_settings": "true",
988
+ "import_downloadable_files": "false"
989
+ }'
990
+ ```
991
+
992
+ ---
993
+
994
+ ### Get Related Products
995
+
996
+ GET `/fluent-cart/v2/products/{productId}/related-products`
997
+
998
+ Retrieve products related to a given product based on shared categories or brands.
999
+
1000
+ - **Permission:** `products/view`
1001
+
1002
+ #### Parameters
1003
+
1004
+ | Parameter | Type | Location | Required | Description |
1005
+ | --- | --- | --- | --- | --- |
1006
+ | `productId` | integer | path | Yes | The product ID |
1007
+ | `related_by_categories` | boolean | query | No | Include products from same categories |
1008
+ | `related_by_brands` | boolean | query | No | Include products from same brands |
1009
+ | `order_by` | string | query | No | Sort order (default: `title_asc`) |
1010
+ | `posts_per_page` | integer | query | No | Number of related products to return (default: `6`) |
1011
+
1012
+ #### Response
1013
+
1014
+ ```
1015
+ {
1016
+ "products": [
1017
+ {
1018
+ "ID": 456,
1019
+ "post_title": "Related Product",
1020
+ "post_status": "publish"
1021
+ }
1022
+ ]
1023
+ }
1024
+ ```
1025
+
1026
+ #### Example
1027
+
1028
+ ```
1029
+ curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/123/related-products?related_by_categories=true&posts_per_page=4" \
1030
+ -u "username:app_password"
1031
+ ```
1032
+
1033
+ ---
1034
+
1035
+ ### Update Long Description Editor Mode
1036
+
1037
+ POST `/fluent-cart/v2/products/{postId}/update-long-desc-editor-mode`
1038
+
1039
+ Switch the long description editor between modes (e.g., visual, code).
1040
+
1041
+ - **Permission:** `products/edit`
1042
+
1043
+ #### Parameters
1044
+
1045
+ | Parameter | Type | Location | Required | Description |
1046
+ | --- | --- | --- | --- | --- |
1047
+ | `postId` | integer | path | Yes | The product post ID |
1048
+ | `active_editor` | string | body | Yes | The editor mode to set |
1049
+
1050
+ #### Response
1051
+
1052
+ ```
1053
+ {
1054
+ "message": "Editor mode updated successfully"
1055
+ }
1056
+ ```
1057
+
1058
+ #### Example
1059
+
1060
+ ```
1061
+ curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/123/update-long-desc-editor-mode" \
1062
+ -u "username:app_password" \
1063
+ -H "Content-Type: application/json" \
1064
+ -d '{"active_editor": "visual"}'
1065
+ ```
1066
+
1067
+ ---
1068
+
1069
+ ### Update Variant Option
1070
+
1071
+ POST `/fluent-cart/v2/products/{postId}/update-variant-option`
1072
+
1073
+ Sync variant options for a product (used when managing product attribute variations).
1074
+
1075
+ - **Permission:** `products/edit`
1076
+
1077
+ #### Parameters
1078
+
1079
+ | Parameter | Type | Location | Required | Description |
1080
+ | --- | --- | --- | --- | --- |
1081
+ | `postId` | integer | path | Yes | The product post ID |
1082
+ | `variation_type` | string | body | Yes | The variation type |
1083
+ | `product_id` | integer | body | Yes | The product ID |
1084
+ | `options` | array | body | Yes | Array of option objects with `id` and `variants` |
1085
+
1086
+ #### Response
1087
+
1088
+ ```
1089
+ {
1090
+ "message": "Variant options synced successfully"
1091
+ }
1092
+ ```
1093
+
1094
+ #### Example
1095
+
1096
+ ```
1097
+ curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/123/update-variant-option" \
1098
+ -u "username:app_password" \
1099
+ -H "Content-Type: application/json" \
1100
+ -d '{
1101
+ "variation_type": "simple_variations",
1102
+ "product_id": 123,
1103
+ "options": []
1104
+ }'
1105
+ ```
1106
+
1107
+ ---
1108
+
1109
+ ### Update Product Detail
1110
+
1111
+ POST `/fluent-cart/v2/products/detail/{detailId}`
1112
+
1113
+ Update a product detail record (e.g., change variation type).
1114
+
1115
+ - **Permission:** `products/edit`
1116
+
1117
+ #### Parameters
1118
+
1119
+ | Parameter | Type | Location | Required | Description |
1120
+ | --- | --- | --- | --- | --- |
1121
+ | `detailId` | integer | path | Yes | The product detail ID |
1122
+ | `variation_type` | string | body | No | New variation type (e.g., `simple`, `simple_variations`) |
1123
+ | `variation_ids` | array | body | No | Array of variation IDs |
1124
+ | `action` | string | body | No | Action to perform (default: `change_variation_type`) |
1125
+
1126
+ #### Response
1127
+
1128
+ ```
1129
+ {
1130
+ "message": "Product detail updated successfully"
1131
+ }
1132
+ ```
1133
+
1134
+ #### Example
1135
+
1136
+ ```
1137
+ curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/detail/456" \
1138
+ -u "username:app_password" \
1139
+ -H "Content-Type: application/json" \
1140
+ -d '{
1141
+ "variation_type": "simple_variations",
1142
+ "action": "change_variation_type"
1143
+ }'
1144
+ ```
1145
+
1146
+ ---
1147
+
1148
+ ### Add Product Terms
1149
+
1150
+ POST `/fluent-cart/v2/products/add-product-terms`
1151
+
1152
+ Create new taxonomy terms for products (categories, brands, etc.).
1153
+
1154
+ - **Permission:** `products/edit`
1155
+
1156
+ #### Parameters
1157
+
1158
+ | Parameter | Type | Location | Required | Description |
1159
+ | --- | --- | --- | --- | --- |
1160
+ | `term.name` | string | body | Yes | Term name(s), comma-separated for multiple |
1161
+ | `term.taxonomy` | string | body | Yes | Taxonomy name (e.g., `product-categories`, `product-brands`) |
1162
+ | `term.parent` | integer | body | No | Parent term ID for hierarchical terms |
1163
+
1164
+ #### Response
1165
+
1166
+ ```
1167
+ {
1168
+ "term_ids": [10, 11],
1169
+ "names": ["Category A", "Category B"]
1170
+ }
1171
+ ```
1172
+
1173
+ #### Example
1174
+
1175
+ ```
1176
+ curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/add-product-terms" \
1177
+ -u "username:app_password" \
1178
+ -H "Content-Type: application/json" \
1179
+ -d '{
1180
+ "term": {
1181
+ "name": "New Category,Another Category",
1182
+ "taxonomy": "product-categories",
1183
+ "parent": 0
1184
+ }
1185
+ }'
1186
+ ```
1187
+
1188
+ ---
1189
+
1190
+ ### Sync Taxonomy Terms
1191
+
1192
+ POST `/fluent-cart/v2/products/sync-taxonomy-term/{postId}`
1193
+
1194
+ Sync (replace) taxonomy terms for a product.
1195
+
1196
+ - **Permission:** `products/edit`
1197
+
1198
+ #### Parameters
1199
+
1200
+ | Parameter | Type | Location | Required | Description |
1201
+ | --- | --- | --- | --- | --- |
1202
+ | `postId` | integer | path | Yes | The product post ID |
1203
+ | `taxonomy` | string | body | Yes | Taxonomy name (e.g., `product-categories`) |
1204
+ | `terms` | array | body | No | Array of term IDs to sync |
1205
+
1206
+ #### Response
1207
+
1208
+ ```
1209
+ {
1210
+ "message": "Taxonomy terms synced successfully"
1211
+ }
1212
+ ```
1213
+
1214
+ #### Example
1215
+
1216
+ ```
1217
+ curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/sync-taxonomy-term/123" \
1218
+ -u "username:app_password" \
1219
+ -H "Content-Type: application/json" \
1220
+ -d '{
1221
+ "taxonomy": "product-categories",
1222
+ "terms": [1, 5, 10]
1223
+ }'
1224
+ ```
1225
+
1226
+ ---
1227
+
1228
+ ### Delete Taxonomy Term
1229
+
1230
+ POST `/fluent-cart/v2/products/delete-taxonomy-term/{postId}`
1231
+
1232
+ Remove a specific taxonomy term from a product.
1233
+
1234
+ - **Permission:** `products/edit`
1235
+
1236
+ #### Parameters
1237
+
1238
+ | Parameter | Type | Location | Required | Description |
1239
+ | --- | --- | --- | --- | --- |
1240
+ | `postId` | integer | path | Yes | The product post ID |
1241
+ | `taxonomy` | string | body | Yes | Taxonomy name (e.g., `product-categories`) |
1242
+ | `term` | integer | body | Yes | Term ID to remove |
1243
+
1244
+ #### Response
1245
+
1246
+ ```
1247
+ {
1248
+ "message": "Taxonomy term removed successfully"
1249
+ }
1250
+ ```
1251
+
1252
+ #### Example
1253
+
1254
+ ```
1255
+ curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/delete-taxonomy-term/123" \
1256
+ -u "username:app_password" \
1257
+ -H "Content-Type: application/json" \
1258
+ -d '{
1259
+ "taxonomy": "product-categories",
1260
+ "term": 5
1261
+ }'
1262
+ ```
1263
+
1264
+ ---
1265
+
1266
+ ### Get Pricing Widgets
1267
+
1268
+ GET `/fluent-cart/v2/products/{productId}/pricing-widgets`
1269
+
1270
+ Retrieve sales overview widgets for a product (all-time, last 30 days, this month).
1271
+
1272
+ - **Permission:** `products/view`
1273
+
1274
+ #### Parameters
1275
+
1276
+ | Parameter | Type | Location | Required | Description |
1277
+ | --- | --- | --- | --- | --- |
1278
+ | `productId` | integer | path | Yes | The product ID |
1279
+
1280
+ #### Response
1281
+
1282
+ ```
1283
+ {
1284
+ "widgets": [
1285
+ {
1286
+ "title": "Quick Sales Overview",
1287
+ "body": "<ul class=\"fct-lists\"><li><span>All time (5)</span><span>$50.00</span></li>...</ul>"
1288
+ }
1289
+ ]
1290
+ }
1291
+ ```
1292
+
1293
+ #### Example
1294
+
1295
+ ```
1296
+ curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/123/pricing-widgets" \
1297
+ -u "username:app_password"
1298
+ ```
1299
+
1300
+ ---
1301
+
1302
+ ## Bundle Products
1303
+
1304
+ ### Get Bundle Info
1305
+
1306
+ GET `/fluent-cart/v2/products/get-bundle-info/{productId}`
1307
+
1308
+ Retrieve bundle configuration information for a product, including child variant mappings.
1309
+
1310
+ - **Permission:** `products/view`
1311
+
1312
+ #### Parameters
1313
+
1314
+ | Parameter | Type | Location | Required | Description |
1315
+ | --- | --- | --- | --- | --- |
1316
+ | `productId` | integer | path | Yes | The product ID |
1317
+
1318
+ #### Response
1319
+
1320
+ ```
1321
+ [
1322
+ {
1323
+ "id": 789,
1324
+ "variation_title": "Bundle Plan",
1325
+ "other_info": {
1326
+ "bundle_child_ids": [101, 102, 103]
1327
+ }
1328
+ }
1329
+ ]
1330
+ ```
1331
+
1332
+ #### Example
1333
+
1334
+ ```
1335
+ curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/get-bundle-info/123" \
1336
+ -u "username:app_password"
1337
+ ```
1338
+
1339
+ ---
1340
+
1341
+ ### Save Bundle Info
1342
+
1343
+ POST `/fluent-cart/v2/products/save-bundle-info/{variationId}`
1344
+
1345
+ Save bundle child variant IDs for a variation. Bundle products cannot be added as children of other bundles.
1346
+
1347
+ - **Permission:** `products/edit`
1348
+
1349
+ #### Parameters
1350
+
1351
+ | Parameter | Type | Location | Required | Description |
1352
+ | --- | --- | --- | --- | --- |
1353
+ | `variationId` | integer | path | Yes | The variation ID to configure as a bundle |
1354
+ | `bundle_child_ids` | array | body | Yes | Array of child variation IDs |
1355
+
1356
+ #### Response
1357
+
1358
+ ```
1359
+ [true]
1360
+ ```
1361
+
1362
+ #### Example
1363
+
1364
+ ```
1365
+ curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/save-bundle-info/789" \
1366
+ -u "username:app_password" \
1367
+ -H "Content-Type: application/json" \
1368
+ -d '{
1369
+ "bundle_child_ids": [101, 102, 103]
1370
+ }'
1371
+ ```
1372
+
1373
+ ---
1374
+
1375
+ ## Upgrade Paths
1376
+
1377
+ ### Get Upgrade Settings
1378
+
1379
+ GET `/fluent-cart/v2/products/{id}/upgrade-paths`
1380
+
1381
+ Retrieve all upgrade path configurations for a product.
1382
+
1383
+ - **Permission:** `products/view`
1384
+
1385
+ #### Parameters
1386
+
1387
+ | Parameter | Type | Location | Required | Description |
1388
+ | --- | --- | --- | --- | --- |
1389
+ | `id` | integer | path | Yes | The product ID |
1390
+
1391
+ #### Response
1392
+
1393
+ ```
1394
+ {
1395
+ "data": [ ... ]
1396
+ }
1397
+ ```
1398
+
1399
+ #### Example
1400
+
1401
+ ```
1402
+ curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/123/upgrade-paths" \
1403
+ -u "username:app_password"
1404
+ ```
1405
+
1406
+ ---
1407
+
1408
+ ### Save Upgrade Path
1409
+
1410
+ POST `/fluent-cart/v2/products/{id}/upgrade-path`
1411
+
1412
+ Create a new upgrade path for a product.
1413
+
1414
+ - **Permission:** `products/edit`
1415
+ - **Request Class:** `UpgradePathSettingRequest`
1416
+
1417
+ #### Parameters
1418
+
1419
+ | Parameter | Type | Location | Required | Description |
1420
+ | --- | --- | --- | --- | --- |
1421
+ | `id` | integer | path | Yes | The product ID |
1422
+ | `from_variant` | integer | body | Yes | Source variation ID (must exist in `fct_product_variations`) |
1423
+ | `to_variants` | array | body | Yes | Array of target variation IDs (each must exist in `fct_product_variations`) |
1424
+ | `discount_amount` | number | body | No | Discount amount for the upgrade |
1425
+ | `title` | string | body | No | Upgrade path title |
1426
+ | `description` | string | body | No | Upgrade path description |
1427
+ | `slug` | string | body | No | Upgrade path slug |
1428
+
1429
+ #### Response
1430
+
1431
+ ```
1432
+ {
1433
+ "message": "Settings saved successfully"
1434
+ }
1435
+ ```
1436
+
1437
+ #### Example
1438
+
1439
+ ```
1440
+ curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/123/upgrade-path" \
1441
+ -u "username:app_password" \
1442
+ -H "Content-Type: application/json" \
1443
+ -d '{
1444
+ "from_variant": 456,
1445
+ "to_variants": [457, 458],
1446
+ "discount_amount": 500
1447
+ }'
1448
+ ```
1449
+
1450
+ ---
1451
+
1452
+ ### Update Upgrade Path
1453
+
1454
+ POST `/fluent-cart/v2/products/upgrade-path/{id}/update`
1455
+
1456
+ Update an existing upgrade path.
1457
+
1458
+ - **Permission:** `products/edit`
1459
+ - **Request Class:** `UpgradePathSettingRequest`
1460
+
1461
+ #### Parameters
1462
+
1463
+ | Parameter | Type | Location | Required | Description |
1464
+ | --- | --- | --- | --- | --- |
1465
+ | `id` | integer | path | Yes | The upgrade path ID |
1466
+ | `from_variant` | integer | body | Yes | Source variation ID |
1467
+ | `to_variants` | array | body | Yes | Array of target variation IDs |
1468
+ | `discount_amount` | number | body | No | Discount amount |
1469
+ | `title` | string | body | No | Upgrade path title |
1470
+ | `description` | string | body | No | Upgrade path description |
1471
+ | `slug` | string | body | No | Upgrade path slug |
1472
+
1473
+ #### Response
1474
+
1475
+ ```
1476
+ {
1477
+ "message": "Settings updated successfully"
1478
+ }
1479
+ ```
1480
+
1481
+ #### Example
1482
+
1483
+ ```
1484
+ curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/upgrade-path/10/update" \
1485
+ -u "username:app_password" \
1486
+ -H "Content-Type: application/json" \
1487
+ -d '{
1488
+ "from_variant": 456,
1489
+ "to_variants": [458, 459],
1490
+ "discount_amount": 1000
1491
+ }'
1492
+ ```
1493
+
1494
+ ---
1495
+
1496
+ ### Delete Upgrade Path
1497
+
1498
+ DELETE `/fluent-cart/v2/products/upgrade-path/{id}/delete`
1499
+
1500
+ Delete an upgrade path.
1501
+
1502
+ - **Permission:** `products/delete`
1503
+
1504
+ #### Parameters
1505
+
1506
+ | Parameter | Type | Location | Required | Description |
1507
+ | --- | --- | --- | --- | --- |
1508
+ | `id` | integer | path | Yes | The upgrade path ID |
1509
+
1510
+ #### Response
1511
+
1512
+ ```
1513
+ {
1514
+ "message": "Path deleted successfully"
1515
+ }
1516
+ ```
1517
+
1518
+ #### Example
1519
+
1520
+ ```
1521
+ curl -X DELETE "https://example.com/wp-json/fluent-cart/v2/products/upgrade-path/10/delete" \
1522
+ -u "username:app_password"
1523
+ ```
1524
+
1525
+ ---
1526
+
1527
+ ### Get Variation Upgrade Paths
1528
+
1529
+ GET `/fluent-cart/v2/products/variation/{variantId}/upgrade-paths`
1530
+
1531
+ Retrieve available upgrade paths for a specific variation (used in customer-facing upgrade flows).
1532
+
1533
+ - **Permission:** `products/view`
1534
+
1535
+ #### Parameters
1536
+
1537
+ | Parameter | Type | Location | Required | Description |
1538
+ | --- | --- | --- | --- | --- |
1539
+ | `variantId` | integer | path | Yes | The variation ID |
1540
+ | `params.order_hash` | string | query | Yes | The order hash to determine applicable upgrades |
1541
+
1542
+ #### Response
1543
+
1544
+ ```
1545
+ {
1546
+ "upgradePaths": [ ... ]
1547
+ }
1548
+ ```
1549
+
1550
+ #### Example
1551
+
1552
+ ```
1553
+ curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/variation/456/upgrade-paths?params[order_hash]=abc123" \
1554
+ -u "username:app_password"
1555
+ ```
1556
+
1557
+ ---
1558
+
1559
+ ## Tax & Shipping Classes
1560
+
1561
+ ### Update Tax Class
1562
+
1563
+ POST `/fluent-cart/v2/products/{postId}/tax-class`
1564
+
1565
+ Assign a tax class to a product.
1566
+
1567
+ - **Permission:** `products/edit`
1568
+
1569
+ #### Parameters
1570
+
1571
+ | Parameter | Type | Location | Required | Description |
1572
+ | --- | --- | --- | --- | --- |
1573
+ | `postId` | integer | path | Yes | The product post ID |
1574
+ | `tax_class` | integer | body | Yes | Tax class ID |
1575
+
1576
+ #### Response
1577
+
1578
+ ```
1579
+ {
1580
+ "message": "Tax Class updated successfully"
1581
+ }
1582
+ ```
1583
+
1584
+ #### Example
1585
+
1586
+ ```
1587
+ curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/123/tax-class" \
1588
+ -u "username:app_password" \
1589
+ -H "Content-Type: application/json" \
1590
+ -d '{"tax_class": 5}'
1591
+ ```
1592
+
1593
+ ---
1594
+
1595
+ ### Remove Tax Class
1596
+
1597
+ POST `/fluent-cart/v2/products/{postId}/tax-class/remove`
1598
+
1599
+ Remove the assigned tax class from a product.
1600
+
1601
+ - **Permission:** `products/edit`
1602
+
1603
+ #### Parameters
1604
+
1605
+ | Parameter | Type | Location | Required | Description |
1606
+ | --- | --- | --- | --- | --- |
1607
+ | `postId` | integer | path | Yes | The product post ID |
1608
+
1609
+ #### Response
1610
+
1611
+ ```
1612
+ {
1613
+ "message": "Tax Class removed successfully"
1614
+ }
1615
+ ```
1616
+
1617
+ #### Example
1618
+
1619
+ ```
1620
+ curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/123/tax-class/remove" \
1621
+ -u "username:app_password"
1622
+ ```
1623
+
1624
+ ---
1625
+
1626
+ ### Update Shipping Class
1627
+
1628
+ POST `/fluent-cart/v2/products/{postId}/shipping-class`
1629
+
1630
+ Assign a shipping class to a product.
1631
+
1632
+ - **Permission:** `products/edit`
1633
+
1634
+ #### Parameters
1635
+
1636
+ | Parameter | Type | Location | Required | Description |
1637
+ | --- | --- | --- | --- | --- |
1638
+ | `postId` | integer | path | Yes | The product post ID |
1639
+ | `shipping_class` | integer | body | Yes | Shipping class ID |
1640
+
1641
+ #### Response
1642
+
1643
+ ```
1644
+ {
1645
+ "message": "Shipping Class updated successfully"
1646
+ }
1647
+ ```
1648
+
1649
+ #### Example
1650
+
1651
+ ```
1652
+ curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/123/shipping-class" \
1653
+ -u "username:app_password" \
1654
+ -H "Content-Type: application/json" \
1655
+ -d '{"shipping_class": 3}'
1656
+ ```
1657
+
1658
+ ---
1659
+
1660
+ ### Remove Shipping Class
1661
+
1662
+ POST `/fluent-cart/v2/products/{postId}/shipping-class/remove`
1663
+
1664
+ Remove the assigned shipping class from a product.
1665
+
1666
+ - **Permission:** `products/edit`
1667
+
1668
+ #### Parameters
1669
+
1670
+ | Parameter | Type | Location | Required | Description |
1671
+ | --- | --- | --- | --- | --- |
1672
+ | `postId` | integer | path | Yes | The product post ID |
1673
+
1674
+ #### Response
1675
+
1676
+ ```
1677
+ {
1678
+ "message": "Shipping Class removed successfully"
1679
+ }
1680
+ ```
1681
+
1682
+ #### Example
1683
+
1684
+ ```
1685
+ curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/123/shipping-class/remove" \
1686
+ -u "username:app_password"
1687
+ ```
1688
+
1689
+ ---
1690
+
1691
+ ## Stock Management
1692
+
1693
+ ### Update Inventory
1694
+
1695
+ PUT `/fluent-cart/v2/products/{postId}/update-inventory/{variantId}`
1696
+
1697
+ Update stock levels for a specific variant. Automatically updates stock status and product-level availability.
1698
+
1699
+ - **Permission:** `products/edit`
1700
+
1701
+ #### Parameters
1702
+
1703
+ | Parameter | Type | Location | Required | Description |
1704
+ | --- | --- | --- | --- | --- |
1705
+ | `postId` | integer | path | Yes | The product post ID |
1706
+ | `variantId` | integer | path | Yes | The variant ID to update |
1707
+ | `total_stock` | integer | body | Yes | Total stock quantity |
1708
+ | `available` | integer | body | Yes | Available stock quantity |
1709
+
1710
+ #### Response
1711
+
1712
+ ```
1713
+ {
1714
+ "message": "Inventory updated successfully"
1715
+ }
1716
+ ```
1717
+
1718
+ #### Example
1719
+
1720
+ ```
1721
+ curl -X PUT "https://example.com/wp-json/fluent-cart/v2/products/123/update-inventory/456" \
1722
+ -u "username:app_password" \
1723
+ -H "Content-Type: application/json" \
1724
+ -d '{
1725
+ "total_stock": 100,
1726
+ "available": 80
1727
+ }'
1728
+ ```
1729
+
1730
+ ---
1731
+
1732
+ ### Update Manage Stock Setting
1733
+
1734
+ PUT `/fluent-cart/v2/products/{postId}/update-manage-stock`
1735
+
1736
+ Enable or disable stock management for a product and all its variants.
1737
+
1738
+ - **Permission:** `products/edit`
1739
+
1740
+ #### Parameters
1741
+
1742
+ | Parameter | Type | Location | Required | Description |
1743
+ | --- | --- | --- | --- | --- |
1744
+ | `postId` | integer | path | Yes | The product post ID |
1745
+ | `manage_stock` | integer | body | Yes | `1` to enable, `0` to disable stock management |
1746
+
1747
+ #### Response
1748
+
1749
+ ```
1750
+ {
1751
+ "message": "Manage stock updated successfully"
1752
+ }
1753
+ ```
1754
+
1755
+ #### Example
1756
+
1757
+ ```
1758
+ curl -X PUT "https://example.com/wp-json/fluent-cart/v2/products/123/update-manage-stock" \
1759
+ -u "username:app_password" \
1760
+ -H "Content-Type: application/json" \
1761
+ -d '{"manage_stock": 1}'
1762
+ ```
1763
+
1764
+ ---
1765
+
1766
+ ## Downloadables
1767
+
1768
+ ### Sync Downloadable Files
1769
+
1770
+ POST `/fluent-cart/v2/products/{postId}/sync-downloadable-files`
1771
+
1772
+ Attach multiple downloadable files to a product. Automatically enables the `manage_downloadable` flag.
1773
+
1774
+ - **Permission:** `products/edit`
1775
+ - **Validation Class:** `ProductDownloadableBulkFileRequest`
1776
+
1777
+ #### Parameters
1778
+
1779
+ | Parameter | Type | Location | Required | Description |
1780
+ | --- | --- | --- | --- | --- |
1781
+ | `postId` | integer | path | Yes | The product post ID |
1782
+ | `downloadable_files` | array | body | Yes | Array of downloadable file objects |
1783
+ | `downloadable_files.*.title` | string | body | Yes | File title (max 160 chars) |
1784
+ | `downloadable_files.*.type` | string | body | Yes | File type (max 100 chars) |
1785
+ | `downloadable_files.*.driver` | string | body | Yes | Storage driver (max 60 chars, e.g., `local`, `s3`) |
1786
+ | `downloadable_files.*.file_name` | string | body | Yes | File name (max 185 chars) |
1787
+ | `downloadable_files.*.file_path` | string | body | Yes | File path (max 185 chars) |
1788
+ | `downloadable_files.*.file_url` | string | body | Yes | File URL (max 200 chars) |
1789
+ | `downloadable_files.*.bucket` | string | body | No | Storage bucket name |
1790
+ | `downloadable_files.*.file_size` | string | body | No | File size |
1791
+ | `downloadable_files.*.serial` | integer | body | No | Display order serial |
1792
+ | `downloadable_files.*.product_variation_id` | array | body | No | Array of variation IDs this file is associated with |
1793
+ | `downloadable_files.*.settings.download_limit` | integer | body | No | Maximum number of downloads allowed |
1794
+ | `downloadable_files.*.settings.download_expiry` | integer | body | No | Download expiry in days |
1795
+
1796
+ #### Response
1797
+
1798
+ ```
1799
+ {
1800
+ "downloadable_files": [
1801
+ {
1802
+ "id": 1,
1803
+ "post_id": 123,
1804
+ "title": "Software v1.0",
1805
+ "type": "zip",
1806
+ "driver": "local",
1807
+ "file_name": "software-v1.zip",
1808
+ "download_identifier": "a1b2c3d4-..."
1809
+ }
1810
+ ]
1811
+ }
1812
+ ```
1813
+
1814
+ #### Example
1815
+
1816
+ ```
1817
+ curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/123/sync-downloadable-files" \
1818
+ -u "username:app_password" \
1819
+ -H "Content-Type: application/json" \
1820
+ -d '{
1821
+ "postId": 123,
1822
+ "downloadable_files": [
1823
+ {
1824
+ "title": "Software v1.0",
1825
+ "type": "zip",
1826
+ "driver": "local",
1827
+ "file_name": "software-v1.zip",
1828
+ "file_path": "software-v1.zip",
1829
+ "file_url": "software-v1.zip",
1830
+ "product_variation_id": [456],
1831
+ "settings": {
1832
+ "download_limit": 5,
1833
+ "download_expiry": 365
1834
+ }
1835
+ }
1836
+ ]
1837
+ }'
1838
+ ```
1839
+
1840
+ ---
1841
+
1842
+ ### Update Downloadable File
1843
+
1844
+ PUT `/fluent-cart/v2/products/{downloadableId}/update`
1845
+
1846
+ Update an existing downloadable file record.
1847
+
1848
+ - **Permission:** `products/edit`
1849
+ - **Validation Class:** `ProductDownloadableFileRequest`
1850
+
1851
+ #### Parameters
1852
+
1853
+ | Parameter | Type | Location | Required | Description |
1854
+ | --- | --- | --- | --- | --- |
1855
+ | `downloadableId` | integer | path | Yes | The downloadable file ID |
1856
+ | `title` | string | body | Yes | File title (max 100 chars) |
1857
+ | `type` | string | body | Yes | File type (max 100 chars) |
1858
+ | `driver` | string | body | Yes | Storage driver (max 100 chars) |
1859
+ | `file_name` | string | body | Yes | File name (max 100 chars) |
1860
+ | `product_variation_id` | array | body | No | Array of variation IDs |
1861
+ | `serial` | integer | body | No | Display order serial |
1862
+ | `settings` | object | body | No | File settings |
1863
+ | `settings.download_limit` | integer | body | No | Maximum downloads allowed |
1864
+ | `settings.download_expiry` | integer | body | No | Download expiry in days |
1865
+
1866
+ #### Response
1867
+
1868
+ ```
1869
+ {
1870
+ "message": "Product downloadable files updated successfully"
1871
+ }
1872
+ ```
1873
+
1874
+ #### Example
1875
+
1876
+ ```
1877
+ curl -X PUT "https://example.com/wp-json/fluent-cart/v2/products/789/update" \
1878
+ -u "username:app_password" \
1879
+ -H "Content-Type: application/json" \
1880
+ -d '{
1881
+ "title": "Software v2.0",
1882
+ "type": "zip",
1883
+ "driver": "local",
1884
+ "file_name": "software-v2.zip",
1885
+ "product_variation_id": [456, 457],
1886
+ "settings": {
1887
+ "download_limit": 10
1888
+ }
1889
+ }'
1890
+ ```
1891
+
1892
+ ---
1893
+
1894
+ ### Delete Downloadable File
1895
+
1896
+ DELETE `/fluent-cart/v2/products/{downloadableId}/delete`
1897
+
1898
+ Delete a downloadable file record.
1899
+
1900
+ - **Permission:** `products/delete`
1901
+
1902
+ #### Parameters
1903
+
1904
+ | Parameter | Type | Location | Required | Description |
1905
+ | --- | --- | --- | --- | --- |
1906
+ | `downloadableId` | integer | path | Yes | The downloadable file ID |
1907
+
1908
+ #### Response
1909
+
1910
+ ```
1911
+ {
1912
+ "message": "File deleted successfully"
1913
+ }
1914
+ ```
1915
+
1916
+ #### Example
1917
+
1918
+ ```
1919
+ curl -X DELETE "https://example.com/wp-json/fluent-cart/v2/products/789/delete" \
1920
+ -u "username:app_password"
1921
+ ```
1922
+
1923
+ ---
1924
+
1925
+ ### Get Downloadable URL
1926
+
1927
+ GET `/fluent-cart/v2/products/getDownloadableUrl/{downloadableId}`
1928
+
1929
+ Generate a temporary download URL for a downloadable file (valid for 7 days).
1930
+
1931
+ - **Permission:** `products/view`
1932
+
1933
+ #### Parameters
1934
+
1935
+ | Parameter | Type | Location | Required | Description |
1936
+ | --- | --- | --- | --- | --- |
1937
+ | `downloadableId` | integer | path | Yes | The downloadable file ID |
1938
+
1939
+ #### Response
1940
+
1941
+ ```
1942
+ {
1943
+ "url": "https://example.com/fluent-cart/download?token=..."
1944
+ }
1945
+ ```
1946
+
1947
+ #### Example
1948
+
1949
+ ```
1950
+ curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/getDownloadableUrl/789" \
1951
+ -u "username:app_password"
1952
+ ```
1953
+
1954
+ ---
1955
+
1956
+ ## Variations
1957
+
1958
+ ### List Product Variations
1959
+
1960
+ GET `/fluent-cart/v2/products/variants`
1961
+
1962
+ Retrieve a list of product variations.
1963
+
1964
+ - **Permission:** `products/view`
1965
+
1966
+ #### Parameters
1967
+
1968
+ | Parameter | Type | Location | Required | Description |
1969
+ | --- | --- | --- | --- | --- |
1970
+ | `params` | object | query | No | Query parameters for filtering variations |
1971
+
1972
+ #### Response
1973
+
1974
+ ```
1975
+ {
1976
+ "variants": [ ... ]
1977
+ }
1978
+ ```
1979
+
1980
+ #### Example
1981
+
1982
+ ```
1983
+ curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/variants" \
1984
+ -u "username:app_password"
1985
+ ```
1986
+
1987
+ ---
1988
+
1989
+ ### Create Variation
1990
+
1991
+ POST `/fluent-cart/v2/products/variants`
1992
+
1993
+ Create a new product variation.
1994
+
1995
+ - **Permission:** `products/create`
1996
+ - **Request Class:** `ProductVariationRequest`
1997
+
1998
+ #### Parameters
1999
+
2000
+ | Parameter | Type | Location | Required | Description |
2001
+ | --- | --- | --- | --- | --- |
2002
+ | `variants.post_id` | integer | body | Yes | Parent product ID |
2003
+ | `variants.variation_title` | string | body | Yes | Variation title (max 200 chars) |
2004
+ | `variants.sku` | string | body | No | SKU (max 30 chars, must be unique) |
2005
+ | `variants.item_price` | number | body | No | Price in cents (min: 0) |
2006
+ | `variants.compare_price` | number | body | No | Compare-at price in cents (must be >= `item_price`) |
2007
+ | `variants.manage_cost` | string | body | No | Enable cost tracking |
2008
+ | `variants.item_cost` | number | body | Conditional | Required if `manage_cost` is `true` |
2009
+ | `variants.fulfillment_type` | string | body | Yes | `physical` or `digital` |
2010
+ | `variants.manage_stock` | integer | body | No | `0` or `1` |
2011
+ | `variants.stock_status` | string | body | Conditional | Required if `manage_stock` is `1`. Values: `in-stock`, `out-of-stock` |
2012
+ | `variants.total_stock` | integer | body | Yes | Total stock quantity |
2013
+ | `variants.available` | integer | body | Yes | Available stock |
2014
+ | `variants.committed` | integer | body | Yes | Committed stock |
2015
+ | `variants.on_hold` | integer | body | Yes | Stock on hold |
2016
+ | `variants.serial_index` | integer | body | No | Display order index |
2017
+ | `variants.downloadable` | string | body | No | Downloadable flag |
2018
+ | `variants.other_info.payment_type` | string | body | Yes | `onetime` or `subscription` |
2019
+ | `variants.other_info.description` | string | body | No | Description (max 255 chars) |
2020
+ | `variants.other_info.repeat_interval` | string | body | Conditional | Required for subscriptions (e.g., `monthly`, `yearly`) |
2021
+ | `variants.other_info.times` | number | body | No | Number of billing cycles |
2022
+ | `variants.other_info.trial_days` | number | body | No | Trial days (max 365) |
2023
+ | `variants.other_info.billing_summary` | string | body | No | Billing summary (max 255 chars) |
2024
+ | `variants.other_info.manage_setup_fee` | string | body | Conditional | Required for subscriptions: `yes` or `no` |
2025
+ | `variants.other_info.signup_fee` | number | body | Conditional | Setup fee in cents. Required if `manage_setup_fee` is `yes` |
2026
+ | `variants.other_info.signup_fee_name` | string | body | Conditional | Setup fee label (max 100 chars). Required if `manage_setup_fee` is `yes` |
2027
+ | `variants.media` | array | body | No | Media images array with `id`, `url`, `title` |
2028
+
2029
+ #### Response
2030
+
2031
+ ```
2032
+ {
2033
+ "variant": {
2034
+ "id": 460,
2035
+ "post_id": 123,
2036
+ "variation_title": "Pro Plan",
2037
+ "item_price": 2999,
2038
+ "sku": "PRO-PLN",
2039
+ "stock_status": "in-stock"
2040
+ },
2041
+ "message": "Variation created successfully"
2042
+ }
2043
+ ```
2044
+
2045
+ #### Example
2046
+
2047
+ ```
2048
+ curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/variants" \
2049
+ -u "username:app_password" \
2050
+ -H "Content-Type: application/json" \
2051
+ -d '{
2052
+ "variants": {
2053
+ "post_id": 123,
2054
+ "variation_title": "Pro Plan",
2055
+ "item_price": 2999,
2056
+ "sku": "PRO-PLN",
2057
+ "fulfillment_type": "digital",
2058
+ "total_stock": 1,
2059
+ "available": 1,
2060
+ "committed": 0,
2061
+ "on_hold": 0,
2062
+ "other_info": {
2063
+ "payment_type": "onetime"
2064
+ }
2065
+ }
2066
+ }'
2067
+ ```
2068
+
2069
+ ---
2070
+
2071
+ ### Update Variation
2072
+
2073
+ POST `/fluent-cart/v2/products/variants/{variantId}`
2074
+
2075
+ Update an existing product variation.
2076
+
2077
+ - **Permission:** `products/edit`
2078
+ - **Request Class:** `ProductVariationRequest`
2079
+
2080
+ #### Parameters
2081
+
2082
+ | Parameter | Type | Location | Required | Description |
2083
+ | --- | --- | --- | --- | --- |
2084
+ | `variantId` | integer | path | Yes | The variation ID to update |
2085
+
2086
+ All body parameters are the same as [Create Variation](#create-variation).
2087
+
2088
+ #### Response
2089
+
2090
+ ```
2091
+ {
2092
+ "variant": { ... },
2093
+ "message": "Variation updated successfully"
2094
+ }
2095
+ ```
2096
+
2097
+ #### Example
2098
+
2099
+ ```
2100
+ curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/variants/460" \
2101
+ -u "username:app_password" \
2102
+ -H "Content-Type: application/json" \
2103
+ -d '{
2104
+ "variants": {
2105
+ "id": 460,
2106
+ "post_id": 123,
2107
+ "variation_title": "Pro Plan - Updated",
2108
+ "item_price": 3999,
2109
+ "fulfillment_type": "digital",
2110
+ "total_stock": 1,
2111
+ "available": 1,
2112
+ "committed": 0,
2113
+ "on_hold": 0,
2114
+ "other_info": {
2115
+ "payment_type": "onetime"
2116
+ }
2117
+ }
2118
+ }'
2119
+ ```
2120
+
2121
+ ---
2122
+
2123
+ ### Delete Variation
2124
+
2125
+ DELETE `/fluent-cart/v2/products/variants/{variantId}`
2126
+
2127
+ Delete a product variation.
2128
+
2129
+ - **Permission:** `products/delete`
2130
+
2131
+ #### Parameters
2132
+
2133
+ | Parameter | Type | Location | Required | Description |
2134
+ | --- | --- | --- | --- | --- |
2135
+ | `variantId` | integer | path | Yes | The variation ID to delete |
2136
+
2137
+ #### Response
2138
+
2139
+ ```
2140
+ {
2141
+ "message": "Variation deleted successfully"
2142
+ }
2143
+ ```
2144
+
2145
+ #### Example
2146
+
2147
+ ```
2148
+ curl -X DELETE "https://example.com/wp-json/fluent-cart/v2/products/variants/460" \
2149
+ -u "username:app_password"
2150
+ ```
2151
+
2152
+ ---
2153
+
2154
+ ### Set Variation Media
2155
+
2156
+ POST `/fluent-cart/v2/products/variants/{variantId}/setMedia`
2157
+
2158
+ Set media/images for a variation.
2159
+
2160
+ - **Permission:** `products/edit`
2161
+
2162
+ #### Parameters
2163
+
2164
+ | Parameter | Type | Location | Required | Description |
2165
+ | --- | --- | --- | --- | --- |
2166
+ | `variantId` | integer | path | Yes | The variation ID |
2167
+ | `media` | array | body | Yes | Array of media objects |
2168
+ | `media.*.id` | integer | body | Yes | WordPress attachment ID |
2169
+ | `media.*.title` | string | body | No | Image title |
2170
+ | `media.*.url` | string | body | No | Image URL |
2171
+
2172
+ #### Response
2173
+
2174
+ ```
2175
+ {
2176
+ "message": "Media set successfully"
2177
+ }
2178
+ ```
2179
+
2180
+ #### Example
2181
+
2182
+ ```
2183
+ curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/variants/460/setMedia" \
2184
+ -u "username:app_password" \
2185
+ -H "Content-Type: application/json" \
2186
+ -d '{
2187
+ "media": [
2188
+ {
2189
+ "id": 101,
2190
+ "title": "Product Image",
2191
+ "url": "https://example.com/wp-content/uploads/product.jpg"
2192
+ }
2193
+ ]
2194
+ }'
2195
+ ```
2196
+
2197
+ ---
2198
+
2199
+ ### Update Variation Pricing Table
2200
+
2201
+ PUT `/fluent-cart/v2/products/variants/{variantId}/pricing-table`
2202
+
2203
+ Update the pricing table description for a variation.
2204
+
2205
+ - **Permission:** `products/edit`
2206
+
2207
+ #### Parameters
2208
+
2209
+ | Parameter | Type | Location | Required | Description |
2210
+ | --- | --- | --- | --- | --- |
2211
+ | `variantId` | integer | path | Yes | The variation ID |
2212
+ | `description` | string | body | Yes | Pricing table description text (newlines preserved) |
2213
+
2214
+ #### Response
2215
+
2216
+ ```
2217
+ {
2218
+ "message": "Pricing table updated successfully"
2219
+ }
2220
+ ```
2221
+
2222
+ #### Example
2223
+
2224
+ ```
2225
+ curl -X PUT "https://example.com/wp-json/fluent-cart/v2/products/variants/460/pricing-table" \
2226
+ -u "username:app_password" \
2227
+ -H "Content-Type: application/json" \
2228
+ -d '{
2229
+ "description": "Includes:\n- Feature A\n- Feature B\n- Priority Support"
2230
+ }'
2231
+ ```
2232
+
2233
+ ---
2234
+
2235
+ ## Variants (VariantController)
2236
+
2237
+ ### List All Variants
2238
+
2239
+ GET `/fluent-cart/v2/variants`
2240
+
2241
+ Retrieve all product variations across all products (separate route group using `VariantController`).
2242
+
2243
+ - **Permission:** `products/view`
2244
+ - **Policy:** `ProductPolicy`
2245
+
2246
+ #### Parameters
2247
+
2248
+ | Parameter | Type | Location | Required | Description |
2249
+ | --- | --- | --- | --- | --- |
2250
+ | `params` | object | query | No | Query parameters for filtering |
2251
+
2252
+ #### Response
2253
+
2254
+ Returns an array of all product variation objects.
2255
+
2256
+ ```
2257
+ [
2258
+ {
2259
+ "id": 456,
2260
+ "post_id": 123,
2261
+ "variation_title": "Default Plan",
2262
+ "item_price": 1000,
2263
+ "sku": null,
2264
+ "stock_status": "in-stock",
2265
+ "payment_type": "onetime",
2266
+ "other_info": { ... }
2267
+ }
2268
+ ]
2269
+ ```
2270
+
2271
+ #### Example
2272
+
2273
+ ```
2274
+ curl -X GET "https://example.com/wp-json/fluent-cart/v2/variants" \
2275
+ -u "username:app_password"
2276
+ ```
2277
+
2278
+ ---
2279
+
2280
+ ## Product Integrations
2281
+
2282
+ ### Get Product Integration Feeds
2283
+
2284
+ GET `/fluent-cart/v2/products/{productId}/integrations`
2285
+
2286
+ Retrieve all integration feeds configured for a product, along with available integrations.
2287
+
2288
+ - **Permission:** `products/view`
2289
+
2290
+ #### Parameters
2291
+
2292
+ | Parameter | Type | Location | Required | Description |
2293
+ | --- | --- | --- | --- | --- |
2294
+ | `productId` | integer | path | Yes | The product ID |
2295
+
2296
+ #### Response
2297
+
2298
+ ```
2299
+ {
2300
+ "feeds": [
2301
+ {
2302
+ "id": 10,
2303
+ "name": "Add to FluentCRM List",
2304
+ "enabled": "yes",
2305
+ "provider": "fluentcrm",
2306
+ "feed": { ... },
2307
+ "scope": "product"
2308
+ }
2309
+ ],
2310
+ "available_integrations": {
2311
+ "fluentcrm": {
2312
+ "title": "FluentCRM",
2313
+ "logo": "...",
2314
+ "enabled": true,
2315
+ "scopes": ["product", "order"]
2316
+ }
2317
+ },
2318
+ "all_module_config_url": "https://example.com/wp-admin/admin.php?page=fluent-cart#/integrations"
2319
+ }
2320
+ ```
2321
+
2322
+ #### Example
2323
+
2324
+ ```
2325
+ curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/123/integrations" \
2326
+ -u "username:app_password"
2327
+ ```
2328
+
2329
+ ---
2330
+
2331
+ ### Get Product Integration Settings
2332
+
2333
+ GET `/fluent-cart/v2/products/{product_id}/integrations/{integration_name}/settings`
2334
+
2335
+ Retrieve settings for a specific integration type on a product. Returns the integration form configuration, existing settings, and product variations.
2336
+
2337
+ - **Permission:** `products/view`
2338
+
2339
+ #### Parameters
2340
+
2341
+ | Parameter | Type | Location | Required | Description |
2342
+ | --- | --- | --- | --- | --- |
2343
+ | `product_id` | integer | path | Yes | The product ID |
2344
+ | `integration_name` | string | path | Yes | Integration provider name (e.g., `fluentcrm`) |
2345
+ | `integration_id` | integer | query | No | Existing integration feed ID to load for editing |
2346
+
2347
+ #### Response
2348
+
2349
+ ```
2350
+ {
2351
+ "settings": {
2352
+ "conditional_variation_ids": [],
2353
+ ...
2354
+ },
2355
+ "fields": [ ... ],
2356
+ "product_variations": [
2357
+ {
2358
+ "id": 456,
2359
+ "title": "Monthly Plan"
2360
+ }
2361
+ ],
2362
+ "scope": "product"
2363
+ }
2364
+ ```
2365
+
2366
+ #### Example
2367
+
2368
+ ```
2369
+ curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/123/integrations/fluentcrm/settings" \
2370
+ -u "username:app_password"
2371
+ ```
2372
+
2373
+ ---
2374
+
2375
+ ### Save Product Integration
2376
+
2377
+ POST `/fluent-cart/v2/products/{product_id}/integrations`
2378
+
2379
+ Create or update an integration feed for a product.
2380
+
2381
+ - **Permission:** `products/edit`
2382
+
2383
+ #### Parameters
2384
+
2385
+ | Parameter | Type | Location | Required | Description |
2386
+ | --- | --- | --- | --- | --- |
2387
+ | `product_id` | integer | path | Yes | The product ID |
2388
+ | `integration_name` | string | body | Yes | Integration provider name |
2389
+ | `integration_id` | integer | body | No | Existing feed ID (for updates) |
2390
+ | `integration` | string (JSON) | body | Yes | JSON-encoded integration settings object |
2391
+
2392
+ #### Response
2393
+
2394
+ ```
2395
+ {
2396
+ "message": "Integration has been successfully saved",
2397
+ "integration_id": 10,
2398
+ "integration_name": "fluentcrm",
2399
+ "created": true,
2400
+ "feedData": { ... }
2401
+ }
2402
+ ```
2403
+
2404
+ #### Example
2405
+
2406
+ ```
2407
+ curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/123/integrations" \
2408
+ -u "username:app_password" \
2409
+ -H "Content-Type: application/json" \
2410
+ -d '{
2411
+ "integration_name": "fluentcrm",
2412
+ "integration": "{\"name\":\"Add to List\",\"list_id\":1,\"enabled\":\"yes\"}"
2413
+ }'
2414
+ ```
2415
+
2416
+ ---
2417
+
2418
+ ### Delete Product Integration
2419
+
2420
+ DELETE `/fluent-cart/v2/products/{product_id}/integrations/{integration_id}`
2421
+
2422
+ Delete a product integration feed.
2423
+
2424
+ - **Permission:** `products/delete`
2425
+
2426
+ #### Parameters
2427
+
2428
+ | Parameter | Type | Location | Required | Description |
2429
+ | --- | --- | --- | --- | --- |
2430
+ | `product_id` | integer | path | Yes | The product ID |
2431
+ | `integration_id` | integer | path | Yes | The integration feed ID to delete |
2432
+
2433
+ #### Response
2434
+
2435
+ ```
2436
+ {
2437
+ "message": "Integration deleted successfully"
2438
+ }
2439
+ ```
2440
+
2441
+ #### Example
2442
+
2443
+ ```
2444
+ curl -X DELETE "https://example.com/wp-json/fluent-cart/v2/products/123/integrations/10" \
2445
+ -u "username:app_password"
2446
+ ```
2447
+
2448
+ ---
2449
+
2450
+ ### Change Integration Status
2451
+
2452
+ POST `/fluent-cart/v2/products/{product_id}/integrations/feed/change-status`
2453
+
2454
+ Enable or disable a product integration feed.
2455
+
2456
+ - **Permission:** `products/edit`
2457
+
2458
+ #### Parameters
2459
+
2460
+ | Parameter | Type | Location | Required | Description |
2461
+ | --- | --- | --- | --- | --- |
2462
+ | `product_id` | integer | path | Yes | The product ID |
2463
+ | `notification_id` | integer | body | Yes | The integration feed ID |
2464
+ | `status` | string | body | Yes | `yes` to enable, `no` to disable |
2465
+
2466
+ #### Response
2467
+
2468
+ ```
2469
+ {
2470
+ "message": "Integration status has been updated"
2471
+ }
2472
+ ```
2473
+
2474
+ #### Example
2475
+
2476
+ ```
2477
+ curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/123/integrations/feed/change-status" \
2478
+ -u "username:app_password" \
2479
+ -H "Content-Type: application/json" \
2480
+ -d '{
2481
+ "product_id": 123,
2482
+ "notification_id": 10,
2483
+ "status": "yes"
2484
+ }'
2485
+ ```