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,1462 +1,1212 @@
1
- # Orders API
2
-
3
- Manage customer orders including creation, updates, payments, refunds, shipping, and status management.
4
-
5
- **Base URL:** `https://your-site.com/wp-json/fluent-cart/v2/orders`
6
-
7
- **Policy:** `OrderPolicy`
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
- | GET | `/orders` | List Orders |
18
- | GET | `/orders/{order_id}` | Get Order Details |
19
- | POST | `/orders` | Create Order |
20
- | POST | `/orders/{order_id}` | Update Order |
21
- | DELETE | `/orders/{order_id}` | Delete Order |
22
- | POST | `/orders/{order}/mark-as-paid` | Mark Order as Paid |
23
- | POST | `/orders/{order_id}/refund` | Refund Order |
24
- | POST | `/orders/{order}/transactions/{transaction_id}/accept-dispute/` | Accept Dispute |
25
- | PUT | `/orders/{order}/address/{id}` | Update Order Address |
26
- | POST | `/orders/{order_id}/update-address-id` | Update Order Address ID |
27
- | POST | `/orders/{order_id}/change-customer` | Change Customer |
28
- | POST | `/orders/{order_id}/create-and-change-customer` | Create and Change Customer |
29
- | GET | `/orders/{order}/transactions` | Get Order Transactions |
30
- | GET | `/orders/{id}/transactions/{transaction_id}` | Get Single Transaction |
31
- | PUT | `/orders/{order}/transactions/{transaction}/status` | Update Transaction Status |
32
- | POST | `/orders/{order}/transactions/{transaction}/sync` | Sync Pending Transaction |
33
- | POST | `/orders/{order}/create-custom` | Create Custom Order Item |
34
- | PUT | `/orders/{order}/statuses` | Update Statuses |
35
- | PUT | `/orders/{order}/sync-statuses` | Sync Order Statuses |
36
- | GET | `/orders/shipping_methods` | Get Shipping Methods |
37
- | POST | `/orders/calculate-shipping` | Calculate Shipping |
38
- | POST | `/orders/calculate-tax` | Calculate Order Tax |
39
- | POST | `/orders/price` | Price Order |
40
- | GET | `/orders/currencies` | List Order Currencies |
41
- | POST | `/orders/{order}/generate-missing-licenses` | Generate Missing Licenses |
42
- | POST | `/orders/do-bulk-action` | Bulk Actions |
43
-
44
- ---
45
-
46
- ## List Orders
47
-
48
- `GET /fluent-cart/v2/orders`
49
-
50
- Retrieve a paginated list of orders with optional filtering, sorting, and search.
51
-
52
- **Permission:** `orders/view`
53
-
54
- ### Parameters
55
-
56
- | Parameter | Type | Location | Required | Description |
57
- |-----------|------|----------|----------|-------------|
58
- | `page` | integer | query | No | Page number for pagination |
59
- | `per_page` | integer | query | No | Number of records per page (default: 10, max: 200) |
60
- | `search` | string | query | No | Search term. Searches invoice number, customer name/email, and order item titles. Also supports operator syntax (e.g., `status = completed`, `id > 5`, `id :: 1-10`) |
61
- | `sort_by` | string | query | No | Column to sort by (default: `id`). Must be a fillable column on the Order model |
62
- | `sort_type` | string | query | No | Sort direction: `asc` or `desc` (default: `desc`) |
63
- | `active_view` | string | query | No | Tab filter. One of: `on-hold`, `paid`, `completed`, `processing`, `renewal`, `subscription`, `onetime`, `refunded`, `partially_refunded`, `upgraded_to`, `upgraded_from` |
64
- | `filter_type` | string | query | No | Filter mode: `simple` (default) or `advanced` |
65
- | `advanced_filters` | string (JSON) | query | No | JSON-encoded array of advanced filter groups (requires Pro). Supports filtering by order properties, customer properties, transaction properties, license properties, and UTM properties |
66
- | `with` | array/string | query | No | Eager-load relations. Supports relation names and `{relation}Count` for counts |
67
- | `select` | array/string | query | No | Comma-separated list of columns to select |
68
- | `scopes` | array | query | No | Model scopes to apply |
69
- | `include_ids` | array/string | query | No | Comma-separated IDs that must always be included in results |
70
- | `limit` | integer | query | No | Limit number of records (used with non-paginated queries) |
71
- | `offset` | integer | query | No | Offset for records |
72
- | `user_tz` | string | query | No | User timezone for date filtering (e.g., `America/New_York`) |
73
- | `payment_statuses` | array | query | No | Filter by payment statuses |
74
- | `order_statuses` | array | query | No | Filter by order statuses |
75
- | `shipping_statuses` | array | query | No | Filter by shipping statuses |
76
-
77
- ### Searchable Fields (Operator Syntax)
78
-
79
- The `search` parameter supports operator syntax like `field = value`, `field > value`, or `field :: range`:
80
-
81
- | Field | Column | Type | Examples |
82
- |-------|--------|------|----------|
83
- | `id` | `id` | numeric | `id = 1`, `id > 5`, `id :: 1-10` |
84
- | `status` | `status` | string | `status = completed` |
85
- | `invoice` | `status` | string | Invoice number search |
86
- | `payment` | `payment_status` | string | `payment = paid`, `payment = partially_refunded` |
87
- | `payment_by` | `payment_method` | string | `payment_by = stripe`, `payment_by = paypal` |
88
- | `customer` | (custom) | custom | `customer = john` (searches name and email) |
89
- | `license` | (custom) | custom | `license = ff-78d47b3fed89bda25cdc5b60d0298d60` (Pro only) |
90
-
91
- ### Response
92
-
93
- ```json
94
- {
95
- "orders": {
96
- "current_page": 1,
97
- "data": [
98
- {
99
- "id": 1,
100
- "uuid": "abc123-def456",
101
- "invoice_no": "INV-001",
102
- "status": "completed",
103
- "payment_status": "paid",
104
- "payment_method": "stripe",
105
- "type": "payment",
106
- "fulfillment_type": "digital",
107
- "currency": "USD",
108
- "subtotal": 5000,
109
- "total_amount": 5000,
110
- "total_paid": 5000,
111
- "total_refund": 0,
112
- "shipping_total": 0,
113
- "tax_total": 0,
114
- "manual_discount_total": 0,
115
- "coupon_discount_total": 0,
116
- "customer_id": 1,
117
- "customer": { ... },
118
- "created_at": "2025-01-15 10:30:00",
119
- "updated_at": "2025-01-15 10:35:00"
120
- }
121
- ],
122
- "per_page": 10,
123
- "total": 100,
124
- "last_page": 10
125
- }
126
- }
127
- ```
128
-
129
- ### Example
130
-
131
- ```bash
132
- curl -X GET "https://example.com/wp-json/fluent-cart/v2/orders?page=1&per_page=10&sort_by=id&sort_type=desc" \
133
- -u "username:app_password"
134
- ```
135
-
136
- ---
137
-
138
- ## Calculate Shipping
139
-
140
- `POST /fluent-cart/v2/orders/calculate-shipping`
141
-
142
- Calculate shipping charges for order items with a specific shipping method.
143
-
144
- **Permission:** `orders/create` or `orders/manage`
145
-
146
- ### Parameters
147
-
148
- | Parameter | Type | Location | Required | Description |
149
- |-----------|------|----------|----------|-------------|
150
- | `order_items` | array | body | Yes | Array of order items, each with `id` (variation ID) and `quantity` |
151
- | `shipping_id` | integer | body | Yes | ID of the shipping method to calculate charges for |
152
-
153
- ### Response
154
-
155
- ```json
156
- {
157
- "message": "Shipping updated",
158
- "shipping_charge": 500,
159
- "order_items": {
160
- "1": {
161
- "id": 1,
162
- "quantity": 2,
163
- "shipping_charge": 500,
164
- "unit_price": 2500,
165
- "other_info": {},
166
- "discount_total": 0,
167
- "fulfillment_type": "physical"
168
- }
169
- }
170
- }
171
- ```
172
-
173
- ### Example
174
-
175
- ```bash
176
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/orders/calculate-shipping" \
177
- -u "username:app_password" \
178
- -H "Content-Type: application/json" \
179
- -d '{
180
- "order_items": [{"id": 1, "quantity": 2}],
181
- "shipping_id": 5
182
- }'
183
- ```
184
-
185
- ---
186
-
187
- ## Create Order
188
-
189
- `POST /fluent-cart/v2/orders`
190
-
191
- Create a new order manually from the admin panel.
192
-
193
- **Permission:** `orders/create`
194
-
195
- **Request Class:** `OrderRequest`
196
-
197
- ### Parameters
198
-
199
- | Parameter | Type | Location | Required | Description |
200
- |-----------|------|----------|----------|-------------|
201
- | `customer_id` | integer | body | Yes | ID of the customer placing the order |
202
- | `order_items` | array | body | Yes | Array of order items (see Order Items below) |
203
- | `status` | string | body | No | Order status (max 50 chars) |
204
- | `invoice_no` | string | body | No | Invoice number (max 100 chars) |
205
- | `fulfillment_type` | string | body | No | Fulfillment type (max 50 chars) |
206
- | `type` | string | body | No | Order type (max 50 chars) |
207
- | `payment_method` | string | body | No | Payment method key (max 50 chars) |
208
- | `payment_method_title` | string | body | No | Payment method display title (max 50 chars) |
209
- | `payment_status` | string | body | No | Payment status (max 50 chars) |
210
- | `currency` | string | body | No | Currency code, e.g., `USD` (max 10 chars) |
211
- | `subtotal` | numeric | body | No | Order subtotal in cents |
212
- | `discount_tax` | numeric | body | No | Discount tax amount in cents |
213
- | `manual_discount_total` | numeric | body | No | Manual discount total in cents |
214
- | `coupon_discount_total` | numeric | body | No | Coupon discount total in cents |
215
- | `shipping_tax` | numeric | body | No | Shipping tax in cents |
216
- | `shipping_total` | numeric | body | No | Shipping total in cents |
217
- | `tax_total` | numeric | body | No | Tax total in cents |
218
- | `total_amount` | numeric | body | No | Total order amount in cents |
219
- | `rate` | numeric | body | No | Exchange rate |
220
- | `note` | string | body | No | Order note (max 5000 chars) |
221
- | `uuid` | string | body | No | Order UUID (max 100 chars) |
222
- | `ip_address` | string | body | No | Customer IP address (max 100 chars) |
223
- | `completed_at` | string | body | No | Completion timestamp (max 100 chars) |
224
- | `refunded_at` | string | body | No | Refund timestamp (max 100 chars) |
225
- | `user_tz` | string | body | No | User timezone (max 50 chars) |
226
- | `discount` | object | body | No | Manual discount details |
227
- | `shipping` | array | body | No | Shipping method details |
228
- | `applied_coupon` | array | body | No | Applied coupon details |
229
- | `trigger` | string | body | No | Trigger source |
230
-
231
- ### Order Items Object
232
-
233
- | Field | Type | Required | Description |
234
- |-------|------|----------|-------------|
235
- | `id` | integer | No | Order item ID (for updates) |
236
- | `order_id` | integer | No | Parent order ID |
237
- | `post_id` | integer | No | WordPress post ID of the product |
238
- | `variation_id` | integer | No | Product variation ID |
239
- | `object_id` | integer | No | Object reference ID |
240
- | `fulfillment_type` | string | No | `digital` or `physical` |
241
- | `payment_type` | string | No | Payment type (max 100 chars), e.g., `subscription` |
242
- | `quantity` | integer | No | Item quantity (min: 1) |
243
- | `post_title` | string | No | Product title (max 255 chars) |
244
- | `title` | string | No | Item title (max 255 chars) |
245
- | `price` | numeric | No | Item price in cents |
246
- | `unit_price` | numeric | No | Unit price in cents |
247
- | `shipping_charge` | numeric | No | Shipping charge in cents |
248
- | `item_cost` | numeric | No | Item cost in cents |
249
- | `item_total` | numeric | No | Item total in cents |
250
- | `tax_amount` | numeric | No | Tax amount in cents |
251
- | `discount_total` | numeric | No | Discount total in cents |
252
- | `total` | numeric | No | Total in cents |
253
- | `line_total` | numeric | No | Line total in cents |
254
- | `cart_index` | integer | No | Cart position index |
255
- | `rate` | numeric | No | Exchange rate |
256
- | `line_meta` | array | No | Line item metadata |
257
- | `other_info` | array | No | Additional item information |
258
-
259
- ### Discount Object
260
-
261
- | Field | Type | Required | Description |
262
- |-------|------|----------|-------------|
263
- | `type` | string | No | Discount type (max 100 chars) |
264
- | `value` | numeric | No | Discount value |
265
- | `label` | string | No | Discount label (max 100 chars) |
266
- | `reason` | string | No | Discount reason (max 100 chars) |
267
- | `action` | string | No | Discount action (max 100 chars) |
268
-
269
- ### Shipping Object (array)
270
-
271
- | Field | Type | Required | Description |
272
- |-------|------|----------|-------------|
273
- | `type` | string | No | Shipping type (max 100 chars) |
274
- | `rate_name` | string | No | Shipping rate name (max 100 chars) |
275
- | `custom_price` | numeric | No | Custom shipping price in cents |
276
-
277
- ### Applied Coupon Object (array)
278
-
279
- | Field | Type | Required | Description |
280
- |-------|------|----------|-------------|
281
- | `id` | integer | No | Applied coupon record ID |
282
- | `order_id` | integer | No | Order ID |
283
- | `coupon_id` | integer | Yes | Coupon ID (min: 1) |
284
- | `code` | string | Yes | Coupon code (max 100 chars) |
285
- | `amount` | numeric | No | Coupon amount |
286
- | `discounted_amount` | numeric | Yes | Discounted amount in cents |
287
- | `discount` | numeric | No | Discount value |
288
- | `stackable` | integer | Yes | Whether coupon is stackable (0 or 1) |
289
- | `priority` | integer | No | Coupon priority |
290
- | `max_uses` | integer | No | Maximum uses |
291
- | `use_count` | integer | No | Current use count |
292
- | `max_per_customer` | integer | No | Max uses per customer (min: 1) |
293
- | `min_purchase_amount` | numeric | No | Minimum purchase amount in cents |
294
- | `max_discount_amount` | numeric | No | Maximum discount amount in cents |
295
- | `notes` | string | No | Coupon notes (max 100 chars) |
296
-
297
- ### Response
298
-
299
- ```json
300
- {
301
- "message": "Order created successfully!",
302
- "order_id": 42,
303
- "uuid": "abc123-def456-ghi789"
304
- }
305
- ```
306
-
307
- ### Example
308
-
309
- ```bash
310
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/orders" \
311
- -u "username:app_password" \
312
- -H "Content-Type: application/json" \
313
- -d '{
314
- "customer_id": 1,
315
- "order_items": [
316
- {
317
- "post_id": 10,
318
- "variation_id": 5,
319
- "object_id": 5,
320
- "quantity": 1,
321
- "unit_price": 2500,
322
- "price": 2500,
323
- "item_total": 2500,
324
- "total": 2500,
325
- "line_total": 2500,
326
- "title": "Pro License"
327
- }
328
- ],
329
- "subtotal": 2500,
330
- "total_amount": 2500,
331
- "payment_method": "offline_payment"
332
- }'
333
- ```
334
-
335
- ---
336
-
337
- ## Bulk Actions
338
-
339
- `POST /fluent-cart/v2/orders/do-bulk-action`
340
-
341
- Perform bulk actions on multiple orders at once.
342
-
343
- **Permission:** `orders/manage`
344
-
345
- ### Parameters
346
-
347
- | Parameter | Type | Location | Required | Description |
348
- |-----------|------|----------|----------|-------------|
349
- | `action` | string | body | Yes | Bulk action to perform. One of: `delete_orders`, `change_shipping_status`, `change_order_status`, `capture_payments`, `change_payment_status` |
350
- | `order_ids` | array | body | Yes | Array of order IDs to act upon |
351
- | `new_status` | string | body | Conditional | New status value. Required for `change_shipping_status`, `change_order_status`, and `change_payment_status` actions |
352
- | `manage_stock` | string | body | No | Whether to manage stock on status change (`true`/`false`) |
353
-
354
- ### Supported Actions
355
-
356
- | Action | Description | Valid `new_status` Values |
357
- |--------|-------------|--------------------------|
358
- | `delete_orders` | Delete selected orders and related data | N/A |
359
- | `change_shipping_status` | Update shipping status | Valid shipping statuses (e.g., `shipped`, `delivered`) |
360
- | `change_order_status` | Update order status | `completed`, `processing`, `on-hold`, `canceled` |
361
- | `capture_payments` | Capture authorized payments | N/A |
362
- | `change_payment_status` | Update payment status | Valid transaction statuses |
363
-
364
- ### Response
365
-
366
- ```json
367
- {
368
- "message": "Order Status has been changed for the selected orders"
369
- }
370
- ```
371
-
372
- ### Example
373
-
374
- ```bash
375
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/orders/do-bulk-action" \
376
- -u "username:app_password" \
377
- -H "Content-Type: application/json" \
378
- -d '{
379
- "action": "change_order_status",
380
- "order_ids": [1, 2, 3],
381
- "new_status": "processing"
382
- }'
383
- ```
384
-
385
- ---
386
-
387
- ## Mark Order as Paid
388
-
389
- `POST /fluent-cart/v2/orders/{order}/mark-as-paid`
390
-
391
- Mark a pending order as paid, creating or updating the transaction record.
392
-
393
- **Permission:** `orders/manage`
394
-
395
- ### Parameters
396
-
397
- | Parameter | Type | Location | Required | Description |
398
- |-----------|------|----------|----------|-------------|
399
- | `order` | integer | path | Yes | Order ID |
400
- | `payment_method` | string | body | No | Payment method used (e.g., `offline_payment`, `stripe`) |
401
- | `vendor_charge_id` | string | body | No | External payment reference/charge ID |
402
- | `transaction_type` | string | body | No | Transaction type identifier |
403
- | `mark_paid_note` | string | body | No | Note to attach to the order |
404
-
405
- ### Response
406
-
407
- ```json
408
- {
409
- "message": "Order has been marked as paid"
410
- }
411
- ```
412
-
413
- ### Error Responses
414
-
415
- | Status | Message |
416
- |--------|---------|
417
- | 423 | Order has already been paid |
418
- | 423 | Unable to mark paid for canceled order |
419
-
420
- ### Example
421
-
422
- ```bash
423
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/orders/42/mark-as-paid" \
424
- -u "username:app_password" \
425
- -H "Content-Type: application/json" \
426
- -d '{
427
- "payment_method": "offline_payment",
428
- "vendor_charge_id": "CHK-12345",
429
- "mark_paid_note": "Payment received via bank transfer"
430
- }'
431
- ```
432
-
433
- ---
434
-
435
- ## Generate Missing Licenses
436
-
437
- `POST /fluent-cart/v2/orders/{order}/generate-missing-licenses`
438
-
439
- Generate any missing license keys for an order's items (requires Pro with licensing module).
440
-
441
- **Permission:** `orders/manage`
442
-
443
- ### Parameters
444
-
445
- | Parameter | Type | Location | Required | Description |
446
- |-----------|------|----------|----------|-------------|
447
- | `order` | integer | path | Yes | Order ID |
448
-
449
- ### Error Responses
450
-
451
- | Status | Message |
452
- |--------|---------|
453
- | 404 | Order not found |
454
- | 400 | No missing licenses found! |
455
-
456
- ### Example
457
-
458
- ```bash
459
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/orders/42/generate-missing-licenses" \
460
- -u "username:app_password"
461
- ```
462
-
463
- ---
464
-
465
- ## Get Order Details
466
-
467
- `GET /fluent-cart/v2/orders/{order_id}`
468
-
469
- Retrieve detailed information about a specific order, including items, transactions, addresses, subscriptions, and activities.
470
-
471
- **Permission:** `orders/view`
472
-
473
- ### Parameters
474
-
475
- | Parameter | Type | Location | Required | Description |
476
- |-----------|------|----------|----------|-------------|
477
- | `order_id` | integer | path | Yes | Order ID |
478
-
479
- ### Response
480
-
481
- ```json
482
- {
483
- "order": {
484
- "id": 42,
485
- "uuid": "abc123-def456",
486
- "invoice_no": "INV-042",
487
- "status": "completed",
488
- "payment_status": "paid",
489
- "payment_method": "stripe",
490
- "type": "payment",
491
- "fulfillment_type": "digital",
492
- "currency": "USD",
493
- "subtotal": 5000,
494
- "total_amount": 5000,
495
- "total_paid": 5000,
496
- "total_refund": 0,
497
- "shipping_total": 0,
498
- "tax_total": 0,
499
- "manual_discount_total": 0,
500
- "coupon_discount_total": 0,
501
- "customer_id": 1,
502
- "customer": { ... },
503
- "order_items": [ ... ],
504
- "transactions": [ ... ],
505
- "billing_address": { ... },
506
- "shipping_address": { ... },
507
- "subscriptions": [ ... ],
508
- "activities": [ ... ],
509
- "labels": [ ... ],
510
- "applied_coupons": [ ... ],
511
- "children": [ ... ],
512
- "parent_order": null,
513
- "order_operation": { ... },
514
- "receipt_url": "https://example.com/receipt/?order_hash=abc123",
515
- "custom_checkout_url": "https://example.com/checkout/?payment_hash=...",
516
- "has_missing_licenses": false,
517
- "created_at": "2025-01-15 10:30:00",
518
- "updated_at": "2025-01-15 10:35:00"
519
- },
520
- "discount_meta": { ... },
521
- "shipping_meta": { ... },
522
- "order_settings": {},
523
- "selected_labels": [1, 2],
524
- "tax_id": null
525
- }
526
- ```
527
-
528
- ### Example
529
-
530
- ```bash
531
- curl -X GET "https://example.com/wp-json/fluent-cart/v2/orders/42" \
532
- -u "username:app_password"
533
- ```
534
-
535
- ---
536
-
537
- ## Update Order
538
-
539
- `POST /fluent-cart/v2/orders/{order_id}`
540
-
541
- Update an existing order's details, items, discounts, shipping, and coupons. Subscription orders cannot be edited.
542
-
543
- **Permission:** `orders/manage`
544
-
545
- **Request Class:** `OrderRequest`
546
-
547
- ### Parameters
548
-
549
- | Parameter | Type | Location | Required | Description |
550
- |-----------|------|----------|----------|-------------|
551
- | `order_id` | integer | path | Yes | Order ID |
552
- | `customer_id` | integer | body | Yes | Customer ID |
553
- | `order_items` | array | body | Yes | Updated array of order items (same structure as Create Order) |
554
- | `status` | string | body | No | Order status (cannot be set to `completed`) |
555
- | `payment_status` | string | body | No | Payment status |
556
- | `subtotal` | numeric | body | No | Updated subtotal in cents |
557
- | `total_amount` | numeric | body | No | Updated total amount in cents |
558
- | `total_paid` | numeric | body | No | Total amount already paid in cents |
559
- | `shipping_total` | numeric | body | No | Updated shipping total in cents |
560
- | `tax_total` | numeric | body | No | Updated tax total in cents |
561
- | `manual_discount_total` | numeric | body | No | Manual discount in cents |
562
- | `coupon_discount_total` | numeric | body | No | Coupon discount in cents |
563
- | `discount` | object | body | No | Discount details (see Create Order) |
564
- | `shipping` | array | body | No | Shipping details (see Create Order) |
565
- | `applied_coupon` | array | body | No | Applied coupon details (see Create Order) |
566
- | `deletedItems` | array | body | No | Array of order item IDs to remove |
567
- | `couponCalculation` | array | body | No | Coupon calculation details |
568
-
569
- All other fields from `OrderRequest` are also accepted (see Create Order).
570
-
571
- ### Error Responses
572
-
573
- | Status | Message |
574
- |--------|---------|
575
- | 400 | Subscription Order cannot be edited |
576
- | 400 | Completed status can not be updated |
577
-
578
- ### Response
579
-
580
- ```json
581
- {
582
- "message": "Order updated successfully",
583
- "order": { ... }
584
- }
585
- ```
586
-
587
- ### Example
588
-
589
- ```bash
590
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/orders/42" \
591
- -u "username:app_password" \
592
- -H "Content-Type: application/json" \
593
- -d '{
594
- "customer_id": 1,
595
- "order_items": [
596
- {
597
- "id": 10,
598
- "order_id": 42,
599
- "quantity": 2,
600
- "unit_price": 2500,
601
- "line_total": 5000
602
- }
603
- ],
604
- "subtotal": 5000,
605
- "total_amount": 5000
606
- }'
607
- ```
608
-
609
- ---
610
-
611
- ## Update Order Address ID
612
-
613
- `POST /fluent-cart/v2/orders/{order_id}/update-address-id`
614
-
615
- Assign an existing customer address to an order's billing or shipping address.
616
-
617
- **Permission:** `orders/manage`
618
-
619
- ### Parameters
620
-
621
- | Parameter | Type | Location | Required | Description |
622
- |-----------|------|----------|----------|-------------|
623
- | `order_id` | integer | path | Yes | Order ID |
624
- | `address_id` | integer | body | Yes | Customer address ID to assign |
625
- | `address_type` | string | body | No | Address type: `billing` (default) or `shipping` |
626
-
627
- ### Response
628
-
629
- ```json
630
- {
631
- "message": "Address updated successfully"
632
- }
633
- ```
634
-
635
- ### Error Responses
636
-
637
- | Status | Message |
638
- |--------|---------|
639
- | 404 | Order not found |
640
-
641
- ### Example
642
-
643
- ```bash
644
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/orders/42/update-address-id" \
645
- -u "username:app_password" \
646
- -H "Content-Type: application/json" \
647
- -d '{
648
- "address_id": 5,
649
- "address_type": "billing"
650
- }'
651
- ```
652
-
653
- ---
654
-
655
- ## Refund Order
656
-
657
- `POST /fluent-cart/v2/orders/{order_id}/refund`
658
-
659
- Process a full or partial refund for an order. Supports both gateway refunds and manual refunds, with optional subscription cancellation.
660
-
661
- **Permission:** `orders/can_refund`
662
-
663
- ### Parameters
664
-
665
- | Parameter | Type | Location | Required | Description |
666
- |-----------|------|----------|----------|-------------|
667
- | `order_id` | integer | path | Yes | Order ID |
668
- | `refund_info` | object | body | Yes | Refund details object |
669
- | `refund_info.transaction_id` | integer | body | Yes | ID of the transaction to refund |
670
- | `refund_info.amount` | numeric | body | Yes | Refund amount in decimal format (e.g., `10.00` not cents). Will be converted to cents internally |
671
- | `refund_info.cancelSubscription` | string | body | No | Set to `"true"` to cancel associated subscription |
672
-
673
- ### Response
674
-
675
- ```json
676
- {
677
- "fluent_cart_refund": {
678
- "status": "success",
679
- "message": "Refund processed on FluentCart."
680
- },
681
- "gateway_refund": {
682
- "status": "success",
683
- "message": "Refund processed on Stripe"
684
- },
685
- "subscription_cancel": {
686
- "status": "success",
687
- "message": "Subscription cancelled successfully"
688
- }
689
- }
690
- ```
691
-
692
- ### Error Responses
693
-
694
- | Status | Message |
695
- |--------|---------|
696
- | 400 | Order can not be refunded |
697
- | 422 | Transaction ID is required |
698
- | 422 | Refund amount is required |
699
-
700
- ### Example
701
-
702
- ```bash
703
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/orders/42/refund" \
704
- -u "username:app_password" \
705
- -H "Content-Type: application/json" \
706
- -d '{
707
- "refund_info": {
708
- "transaction_id": 15,
709
- "amount": 25.00,
710
- "cancelSubscription": "true"
711
- }
712
- }'
713
- ```
714
-
715
- ---
716
-
717
- ## Change Customer
718
-
719
- `POST /fluent-cart/v2/orders/{order_id}/change-customer`
720
-
721
- Reassign an order to a different existing customer. Updates all connected orders (parent/child/renewals), subscriptions, and customer statistics.
722
-
723
- **Permission:** `orders/manage`
724
-
725
- ### Parameters
726
-
727
- | Parameter | Type | Location | Required | Description |
728
- |-----------|------|----------|----------|-------------|
729
- | `order_id` | integer | path | Yes | Order ID |
730
- | `customer_id` | integer | body | Yes | New customer ID to assign |
731
-
732
- ### Response
733
-
734
- ```json
735
- {
736
- "message": "Customer changed successfully"
737
- }
738
- ```
739
-
740
- ### Error Responses
741
-
742
- | Status | Message |
743
- |--------|---------|
744
- | 423 | Customer id is required |
745
-
746
- ### Example
747
-
748
- ```bash
749
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/orders/42/change-customer" \
750
- -u "username:app_password" \
751
- -H "Content-Type: application/json" \
752
- -d '{
753
- "customer_id": 15
754
- }'
755
- ```
756
-
757
- ---
758
-
759
- ## Create and Change Customer
760
-
761
- `POST /fluent-cart/v2/orders/{order_id}/create-and-change-customer`
762
-
763
- Create a new customer and immediately assign them to the order. Combines customer creation with order reassignment.
764
-
765
- **Permission:** `orders/manage`
766
-
767
- **Request Class:** `CustomerRequest`
768
-
769
- ### Parameters
770
-
771
- | Parameter | Type | Location | Required | Description |
772
- |-----------|------|----------|----------|-------------|
773
- | `order_id` | integer | path | Yes | Order ID |
774
- | `first_name` | string | body | Conditional | Customer first name (max 255 chars). Required if full name mode is disabled |
775
- | `last_name` | string | body | No | Customer last name (max 255 chars) |
776
- | `full_name` | string | body | Conditional | Customer full name (max 255 chars). Required if full name mode is enabled |
777
- | `email` | string | body | Yes | Customer email address (max 255 chars, must be unique) |
778
- | `city` | string | body | No | Customer city |
779
- | `user_id` | integer | body | No | WordPress user ID to link |
780
- | `status` | string | body | No | Customer status |
781
- | `country` | string | body | No | Customer country |
782
- | `state` | string | body | No | Customer state |
783
- | `postcode` | string | body | No | Customer postal code |
784
- | `notes` | string | body | No | Customer notes |
785
-
786
- ### Response
787
-
788
- ```json
789
- {
790
- "message": "Customer changed successfully"
791
- }
792
- ```
793
-
794
- ### Error Responses
795
-
796
- | Status | Message |
797
- |--------|---------|
798
- | 422 | Email is required |
799
- | 422 | Email already exists |
800
- | 422 | First Name is required |
801
- | 400 | Failed to attach customer |
802
-
803
- ### Example
804
-
805
- ```bash
806
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/orders/42/create-and-change-customer" \
807
- -u "username:app_password" \
808
- -H "Content-Type: application/json" \
809
- -d '{
810
- "first_name": "Jane",
811
- "last_name": "Doe",
812
- "email": "jane@example.com"
813
- }'
814
- ```
815
-
816
- ---
817
-
818
- ## Delete Order
819
-
820
- `DELETE /fluent-cart/v2/orders/{order_id}`
821
-
822
- Permanently delete an order and all associated data (transactions, items, meta, addresses, coupons, cart data, download permissions, labels). For subscription orders, also deletes all child renewal orders and subscriptions.
823
-
824
- **Permission:** `orders/delete`
825
-
826
- ### Parameters
827
-
828
- | Parameter | Type | Location | Required | Description |
829
- |-----------|------|----------|----------|-------------|
830
- | `order_id` | integer | path | Yes | Order ID to delete |
831
-
832
- ### Response
833
-
834
- ```json
835
- {
836
- "message": "Order 42 deleted successfully",
837
- "data": {
838
- "order_id": 42,
839
- "invoice_no": "INV-042",
840
- "status": "success"
841
- },
842
- "errors": []
843
- }
844
- ```
845
-
846
- ### Error Responses
847
-
848
- | Status | Message |
849
- |--------|---------|
850
- | 404 | Order not found |
851
- | 400 | (Various reasons why order cannot be deleted) |
852
-
853
- ### Example
854
-
855
- ```bash
856
- curl -X DELETE "https://example.com/wp-json/fluent-cart/v2/orders/42" \
857
- -u "username:app_password"
858
- ```
859
-
860
- ---
861
-
862
- ## Update Statuses
863
-
864
- `PUT /fluent-cart/v2/orders/{order}/statuses`
865
-
866
- Update the order status or shipping status for an order.
867
-
868
- **Permission:** `orders/manage_statuses`
869
-
870
- ### Parameters
871
-
872
- | Parameter | Type | Location | Required | Description |
873
- |-----------|------|----------|----------|-------------|
874
- | `order` | integer | path | Yes | Order ID |
875
- | `action` | string | body | Yes | Status change type: `change_order_status` or `change_shipping_status` |
876
- | `statuses` | object | body | Yes | Status values object |
877
- | `statuses.order_status` | string | body | Conditional | New order status. Required when action is `change_order_status`. One of: `completed`, `processing`, `on-hold`, `canceled` |
878
- | `statuses.shipping_status` | string | body | Conditional | New shipping status. Required when action is `change_shipping_status` |
879
- | `manage_stock` | string/boolean | body | No | Whether to adjust stock levels on status change |
880
-
881
- ### Response
882
-
883
- ```json
884
- {
885
- "message": "Status has been updated",
886
- "data": { ... }
887
- }
888
- ```
889
-
890
- ### Error Responses
891
-
892
- | Status | Message |
893
- |--------|---------|
894
- | 400 | Order already has the same status |
895
- | 400 | You cannot change the order status once it has been canceled |
896
-
897
- ### Example
898
-
899
- ```bash
900
- curl -X PUT "https://example.com/wp-json/fluent-cart/v2/orders/42/statuses" \
901
- -u "username:app_password" \
902
- -H "Content-Type: application/json" \
903
- -d '{
904
- "action": "change_order_status",
905
- "statuses": {
906
- "order_status": "processing"
907
- },
908
- "manage_stock": true
909
- }'
910
- ```
911
-
912
- ---
913
-
914
- ## Get Order Transactions
915
-
916
- `GET /fluent-cart/v2/orders/{order}/transactions`
917
-
918
- Retrieve all transactions for an order. This endpoint returns the full order details (same as Get Order Details), which includes the transactions relation.
919
-
920
- **Permission:** `orders/view`
921
-
922
- ### Parameters
923
-
924
- | Parameter | Type | Location | Required | Description |
925
- |-----------|------|----------|----------|-------------|
926
- | `order` | integer | path | Yes | Order ID |
927
-
928
- ### Response
929
-
930
- Same response structure as Get Order Details, with the `order.transactions` array populated.
931
-
932
- ### Example
933
-
934
- ```bash
935
- curl -X GET "https://example.com/wp-json/fluent-cart/v2/orders/42/transactions" \
936
- -u "username:app_password"
937
- ```
938
-
939
- ---
940
-
941
- ## Accept Dispute
942
-
943
- `POST /fluent-cart/v2/orders/{order}/transactions/{transaction_id}/accept-dispute/`
944
-
945
- Accept a payment dispute (chargeback) for a specific transaction.
946
-
947
- **Permission:** `orders/manage`
948
-
949
- ### Parameters
950
-
951
- | Parameter | Type | Location | Required | Description |
952
- |-----------|------|----------|----------|-------------|
953
- | `order` | integer | path | Yes | Order ID |
954
- | `transaction_id` | integer | path | Yes | Transaction ID with the dispute |
955
- | `dispute_note` | string | body | No | Note about the dispute acceptance |
956
-
957
- ### Response
958
-
959
- ```json
960
- {
961
- "message": "Dispute accepted!"
962
- }
963
- ```
964
-
965
- ### Example
966
-
967
- ```bash
968
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/orders/42/transactions/15/accept-dispute/" \
969
- -u "username:app_password" \
970
- -H "Content-Type: application/json" \
971
- -d '{
972
- "dispute_note": "Customer provided valid reason for dispute"
973
- }'
974
- ```
975
-
976
- ---
977
-
978
- ## Get Single Transaction
979
-
980
- `GET /fluent-cart/v2/orders/{id}/transactions/{transaction_id}`
981
-
982
- Retrieve details of a specific transaction within an order. This endpoint returns the full order details (same as Get Order Details).
983
-
984
- **Permission:** `orders/view`
985
-
986
- ### Parameters
987
-
988
- | Parameter | Type | Location | Required | Description |
989
- |-----------|------|----------|----------|-------------|
990
- | `id` | integer | path | Yes | Order ID |
991
- | `transaction_id` | integer | path | Yes | Transaction ID |
992
-
993
- ### Response
994
-
995
- Same response structure as Get Order Details.
996
-
997
- ### Example
998
-
999
- ```bash
1000
- curl -X GET "https://example.com/wp-json/fluent-cart/v2/orders/42/transactions/15" \
1001
- -u "username:app_password"
1002
- ```
1003
-
1004
- ---
1005
-
1006
- ## Sync Pending Transaction
1007
-
1008
- `POST /fluent-cart/v2/orders/{order}/transactions/{transaction}/sync`
1009
-
1010
- Re-fetch a pending transaction's current status **directly from its payment gateway** and update the local record to match. Use this to reconcile a transaction stuck in `pending` after a webhook was missed or delayed.
1011
-
1012
- **Permission:** `orders/manage`
1013
-
1014
- ### Parameters
1015
-
1016
- | Parameter | Type | Location | Required | Description |
1017
- |-----------|------|----------|----------|-------------|
1018
- | `order` | integer | path | Yes | Order ID |
1019
- | `transaction` | integer | path | Yes | Transaction ID |
1020
-
1021
- ### Response
1022
-
1023
- ```json
1024
- {
1025
- "message": "Transaction has been synced from the payment gateway successfully!",
1026
- "transaction": {
1027
- "id": 78,
1028
- "order_id": 42,
1029
- "vendor_charge_id": "ch_3PxKE2JY8q",
1030
- "payment_method": "stripe",
1031
- "payment_mode": "live",
1032
- "payment_method_type": "card",
1033
- "currency": "USD",
1034
- "transaction_type": "payment",
1035
- "card_last_4": "4242",
1036
- "card_brand": "visa",
1037
- "status": "paid",
1038
- "total": 10692,
1039
- "uuid": "txn_f7e8d9c0",
1040
- "created_at": "2026-08-18 10:00:00"
1041
- }
1042
- }
1043
- ```
1044
-
1045
- ### Example
1046
-
1047
- ```bash
1048
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/orders/42/transactions/78/sync" \
1049
- -u "username:app_password"
1050
- ```
1051
-
1052
- ---
1053
-
1054
- ## Update Order Address
1055
-
1056
- `PUT /fluent-cart/v2/orders/{order}/address/{id}`
1057
-
1058
- Update an existing order address (billing or shipping) with new address data.
1059
-
1060
- **Permission:** `orders/manage`
1061
-
1062
- ### Parameters
1063
-
1064
- | Parameter | Type | Location | Required | Description |
1065
- |-----------|------|----------|----------|-------------|
1066
- | `order` | integer | path | Yes | Order ID |
1067
- | `id` | integer | path | Yes | Order address ID |
1068
- | `order_id` | integer | body | Yes | Order ID (must match the path parameter) |
1069
- | `name` | string | body | No | Full name |
1070
- | `first_name` | string | body | No | First name |
1071
- | `last_name` | string | body | No | Last name |
1072
- | `full_name` | string | body | No | Full name |
1073
- | `address_1` | string | body | No | Address line 1 |
1074
- | `address_2` | string | body | No | Address line 2 |
1075
- | `city` | string | body | No | City |
1076
- | `state` | string | body | No | State/province |
1077
- | `postcode` | string | body | No | Postal/ZIP code |
1078
- | `country` | string | body | No | Country code |
1079
-
1080
- ### Response
1081
-
1082
- ```json
1083
- {
1084
- "message": "Address updated successfully"
1085
- }
1086
- ```
1087
-
1088
- ### Error Responses
1089
-
1090
- | Status | Message |
1091
- |--------|---------|
1092
- | 404 | The address information does not match |
1093
-
1094
- ### Example
1095
-
1096
- ```bash
1097
- curl -X PUT "https://example.com/wp-json/fluent-cart/v2/orders/42/address/5" \
1098
- -u "username:app_password" \
1099
- -H "Content-Type: application/json" \
1100
- -d '{
1101
- "order_id": 42,
1102
- "first_name": "John",
1103
- "last_name": "Doe",
1104
- "address_1": "123 Main St",
1105
- "city": "New York",
1106
- "state": "NY",
1107
- "postcode": "10001",
1108
- "country": "US"
1109
- }'
1110
- ```
1111
-
1112
- ---
1113
-
1114
- ## Update Transaction Status
1115
-
1116
- `PUT /fluent-cart/v2/orders/{order}/transactions/{transaction}/status`
1117
-
1118
- Update the payment status of a specific transaction and sync the order's payment status accordingly.
1119
-
1120
- **Permission:** `orders/manage`
1121
-
1122
- ### Parameters
1123
-
1124
- | Parameter | Type | Location | Required | Description |
1125
- |-----------|------|----------|----------|-------------|
1126
- | `order` | integer | path | Yes | Order ID |
1127
- | `transaction` | integer | path | Yes | Transaction ID |
1128
- | `status` | string | body | Yes | New transaction status (e.g., `succeeded`, `pending`, `refunded`, `failed`) |
1129
-
1130
- ### Response
1131
-
1132
- ```json
1133
- {
1134
- "transaction": {
1135
- "id": 15,
1136
- "order_id": 42,
1137
- "status": "succeeded",
1138
- "total": 5000,
1139
- "payment_method": "stripe"
1140
- },
1141
- "message": "Payment status has been successfully updated"
1142
- }
1143
- ```
1144
-
1145
- ### Error Responses
1146
-
1147
- | Status | Message |
1148
- |--------|---------|
1149
- | 400 | Transaction already has the same status |
1150
- | 400 | The selected transaction does not match with the provided order |
1151
-
1152
- ### Example
1153
-
1154
- ```bash
1155
- curl -X PUT "https://example.com/wp-json/fluent-cart/v2/orders/42/transactions/15/status" \
1156
- -u "username:app_password" \
1157
- -H "Content-Type: application/json" \
1158
- -d '{
1159
- "status": "succeeded"
1160
- }'
1161
- ```
1162
-
1163
- ---
1164
-
1165
- ## Create Custom Order Item
1166
-
1167
- `POST /fluent-cart/v2/orders/{order}/create-custom`
1168
-
1169
- Add a custom product/item to an existing order.
1170
-
1171
- **Permission:** `orders/create`
1172
-
1173
- ### Parameters
1174
-
1175
- | Parameter | Type | Location | Required | Description |
1176
- |-----------|------|----------|----------|-------------|
1177
- | `order` | integer | path | Yes | Order ID |
1178
- | `product` | object | body | Yes | Product data to add as a custom item |
1179
-
1180
- ### Response
1181
-
1182
- Returns the result of processing the custom item addition.
1183
-
1184
- ### Error Responses
1185
-
1186
- | Status | Message |
1187
- |--------|---------|
1188
- | 423 | (Error message from processing) |
1189
-
1190
- ### Example
1191
-
1192
- ```bash
1193
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/orders/42/create-custom" \
1194
- -u "username:app_password" \
1195
- -H "Content-Type: application/json" \
1196
- -d '{
1197
- "product": {
1198
- "title": "Custom Service",
1199
- "price": 1500,
1200
- "quantity": 1
1201
- }
1202
- }'
1203
- ```
1204
-
1205
- ---
1206
-
1207
- ## Get Shipping Methods
1208
-
1209
- `GET /fluent-cart/v2/orders/shipping_methods`
1210
-
1211
- Retrieve available shipping methods, optionally filtered by country and state. Returns methods applicable to the specified location and all other enabled methods separately.
1212
-
1213
- **Permission:** `orders/manage`
1214
-
1215
- ### Parameters
1216
-
1217
- | Parameter | Type | Location | Required | Description |
1218
- |-----------|------|----------|----------|-------------|
1219
- | `country_code` | string | query | No | Country code to filter applicable shipping methods (e.g., `US`, `GB`) |
1220
- | `state` | string | query | No | State/province code for more specific filtering |
1221
- | `order_items` | array | query | No | Array of order items (each with `id` and `quantity`) to calculate shipping charges |
1222
-
1223
- ### Response
1224
-
1225
- ```json
1226
- {
1227
- "shipping_methods": [
1228
- {
1229
- "id": 1,
1230
- "title": "Standard Shipping",
1231
- "is_enabled": "1",
1232
- "shipping_charge": 500
1233
- }
1234
- ],
1235
- "other_shipping_methods": [
1236
- {
1237
- "id": 2,
1238
- "title": "International Shipping",
1239
- "is_enabled": "1",
1240
- "shipping_charge": 1500
1241
- }
1242
- ]
1243
- }
1244
- ```
1245
-
1246
- When `country_code` is empty, `shipping_methods` will be an empty array and all enabled methods appear in `other_shipping_methods`.
1247
-
1248
- ### Example
1249
-
1250
- ```bash
1251
- curl -X GET "https://example.com/wp-json/fluent-cart/v2/orders/shipping_methods?country_code=US&state=CA" \
1252
- -u "username:app_password"
1253
- ```
1254
-
1255
- ---
1256
-
1257
- ## Sync Order Statuses
1258
-
1259
- `PUT /fluent-cart/v2/orders/{order}/sync-statuses`
1260
-
1261
- Synchronize the order's status and payment status based on the latest transaction data. Useful for resolving status mismatches.
1262
-
1263
- **Permission:** `orders/manage`
1264
-
1265
- ### Parameters
1266
-
1267
- | Parameter | Type | Location | Required | Description |
1268
- |-----------|------|----------|----------|-------------|
1269
- | `order` | integer | path | Yes | Order ID |
1270
-
1271
- ### Response
1272
-
1273
- ```json
1274
- {
1275
- "message": "Order statuses synced successfully",
1276
- "order": { ... },
1277
- "payment_status": "paid",
1278
- "status": "processing"
1279
- }
1280
- ```
1281
-
1282
- ### Error Responses
1283
-
1284
- | Status | Message |
1285
- |--------|---------|
1286
- | 404 | No transaction found for this order |
1287
-
1288
- ### Example
1289
-
1290
- ```bash
1291
- curl -X PUT "https://example.com/wp-json/fluent-cart/v2/orders/42/sync-statuses" \
1292
- -u "username:app_password"
1293
- ```
1294
-
1295
- ---
1296
-
1297
- ## Calculate Order Tax
1298
-
1299
- `POST /fluent-cart/v2/orders/calculate-tax`
1300
-
1301
- Calculate tax for an admin-created order from a destination address and a list of line items. This is a pure calculation helper — **no database writes occur and no order is created or modified**.
1302
-
1303
- Up to 100 items are processed per request; any beyond that are silently dropped. If tax calculation is not available for the given address, all totals are returned as zero.
1304
-
1305
- **Permission:** `orders/create` or `orders/manage`
1306
-
1307
- ### Parameters
1308
-
1309
- | Parameter | Type | Location | Required | Description |
1310
- |-----------|------|----------|----------|-------------|
1311
- | `country` | string | body | No | Destination country code (e.g. `US`) |
1312
- | `state` | string | body | No | Destination state/province code |
1313
- | `city` | string | body | No | Destination city |
1314
- | `postcode` | string | body | No | Destination postal/zip code |
1315
- | `items` | array | body | No | Line items. Capped at 100 per request |
1316
-
1317
- Each entry in `items`:
1318
-
1319
- | Field | Type | Description |
1320
- |-------|------|-------------|
1321
- | `post_id` | integer | Product post ID |
1322
- | `object_id` | integer | Variation / object ID |
1323
- | `subtotal` | integer | Line subtotal in cents |
1324
- | `discount_total` | integer | Discount applied to the line, in cents |
1325
- | `shipping_charge` | integer | Shipping attributed to the line, in cents |
1326
- | `quantity` | integer | Line quantity (minimum 1) |
1327
-
1328
- ### Response
1329
-
1330
- ```json
1331
- {
1332
- "tax_total": 792,
1333
- "shipping_tax": 0,
1334
- "tax_behavior": 0,
1335
- "tax_country": "US",
1336
- "tax_lines": [
1337
- { "label": "CA State Tax", "rate_percent": 8, "tax_amount": 792, "inclusive": false }
1338
- ]
1339
- }
1340
- ```
1341
-
1342
- ### Example
1343
-
1344
- ```bash
1345
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/orders/calculate-tax" \
1346
- -u "username:app_password" \
1347
- -H "Content-Type: application/json" \
1348
- -d '{
1349
- "country": "US", "state": "CA", "city": "Springfield", "postcode": "62704",
1350
- "items": [{ "post_id": 123, "object_id": 456, "subtotal": 9900, "discount_total": 0, "shipping_charge": 0, "quantity": 1 }]
1351
- }'
1352
- ```
1353
-
1354
- ---
1355
-
1356
- ## Price Order
1357
-
1358
- `POST /fluent-cart/v2/orders/price`
1359
-
1360
- Price an admin order **before creating it**. Nothing is saved.
1361
-
1362
- Catalog lines are priced from the product in the requested `currency` at the store's exchange rate. Coupons and the manual discount are validated and applied the same way [Create Order](#create-order) applies them.
1363
-
1364
- To save exactly what was previewed, send the returned `quote_revision` and `total_amount` to Create Order with the same `currency`, lines, coupons, discount and shipping. If the rate or a price changed in between, Create Order fails with **`fx_prices_updated`** — price the order again and resend.
1365
-
1366
- Amounts are in cents of the order's currency, before tax.
1367
-
1368
- **Permission:** `orders/create`
1369
-
1370
- ### Parameters
1371
-
1372
- | Parameter | Type | Location | Required | Description |
1373
- |-----------|------|----------|----------|-------------|
1374
- | `customer_id` | integer | body | No | Existing customer ID |
1375
- | `currency` | string | body | No | Order currency code; defaults to the store currency |
1376
- | `order_items` | array | body | **Yes** | Lines to price |
1377
- | `applied_coupon` | array | body | No | Coupon codes to validate and apply |
1378
- | `discount` | object | body | No | Manual discount (same shape as Create Order) |
1379
- | `shipping_total` | integer | body | No | Shipping total in cents |
1380
-
1381
- Each entry in `order_items`:
1382
-
1383
- | Field | Type | Description |
1384
- |-------|------|-------------|
1385
- | `post_id` | integer | Product post ID |
1386
- | `variation_id` | integer | Variation ID |
1387
- | `object_id` | integer | Object (variation) ID |
1388
- | `quantity` | integer | Line quantity |
1389
- | `unit_price` | integer | Unit price in cents override |
1390
- | `has_custom_price` | boolean | Whether `unit_price` overrides the catalog price |
1391
- | `shipping_charge` | integer | Shipping attributed to the line, in cents |
1392
- | `other_info` | object | Arbitrary line metadata |
1393
-
1394
- ### Response
1395
-
1396
- ```json
1397
- {
1398
- "currency": "EUR",
1399
- "quote_revision": "afe0d9020e760936a57bea648532cb53",
1400
- "order_items": [
1401
- {
1402
- "object_id": 5, "post_id": 10, "quantity": 1,
1403
- "unit_price": 2300, "price": 2300, "subtotal": 2300, "line_total": 2300,
1404
- "discount_total": 230, "coupon_discount": 230, "manual_discount": 0,
1405
- "shipping_charge": 0,
1406
- "other_info": {
1407
- "payment_type": "onetime",
1408
- "fx_base": { "unit_price": 2500, "signup_fee": 0 },
1409
- "fx": { "currency": "EUR", "rate": "0.920000000000", "rules": "none|none|0" }
1410
- }
1411
- }
1412
- ],
1413
- "applied_coupons": { "SAVE10": { "id": 3, "code": "SAVE10", "discount": 230 } },
1414
- "shipping_total": 0,
1415
- "subtotal": 2300,
1416
- "coupon_discount_total": 230,
1417
- "manual_discount_total": 0,
1418
- "total_amount": 2070
1419
- }
1420
- ```
1421
-
1422
- ### Example
1423
-
1424
- ```bash
1425
- curl -X POST "https://example.com/wp-json/fluent-cart/v2/orders/price" \
1426
- -u "username:app_password" \
1427
- -H "Content-Type: application/json" \
1428
- -d '{"currency":"EUR","order_items":[{"post_id":10,"object_id":5,"quantity":1}],"applied_coupon":["SAVE10"]}'
1429
- ```
1430
-
1431
- ---
1432
-
1433
- ## List Order Currencies
1434
-
1435
- `GET /fluent-cart/v2/orders/currencies`
1436
-
1437
- List the currencies an admin order can be created in, with today's rate for each. The store currency comes first.
1438
-
1439
- The list is **empty when Multi-Currency is off** or no other currency has a rate — then orders can only be created in the store currency.
1440
-
1441
- **Permission:** `orders/create`
1442
-
1443
- ### Response
1444
-
1445
- ```json
1446
- {
1447
- "currencies": [
1448
- { "code": "USD", "sign": "$", "rate": "1.000000000000", "is_base": true },
1449
- {
1450
- "code": "EUR", "sign": "€", "rate": "0.920000000000", "is_base": false,
1451
- "rounding": "none", "charm": "none", "adjustment": "0", "decimals": 2
1452
- }
1453
- ]
1454
- }
1455
- ```
1456
-
1457
- ### Example
1458
-
1459
- ```bash
1460
- curl -X GET "https://example.com/wp-json/fluent-cart/v2/orders/currencies" \
1461
- -u "username:app_password"
1462
- ```
1
+ # Orders API
2
+
3
+ Manage customer orders including creation, updates, payments, refunds, shipping, and status management.
4
+
5
+ **Base URL:** `https://your-site.com/wp-json/fluent-cart/v2/orders`
6
+
7
+ **Policy:** `OrderPolicy`
8
+
9
+ > All monetary values are in **cents** (e.g., `$10.00` = `1000`).
10
+
11
+ ---
12
+
13
+ ## List Orders
14
+
15
+ GET `/fluent-cart/v2/orders`
16
+
17
+ Retrieve a paginated list of orders with optional filtering, sorting, and search.
18
+
19
+ - **Permission:** `orders/view`
20
+
21
+ ### Parameters
22
+
23
+ | Parameter | Type | Location | Required | Description |
24
+ | --- | --- | --- | --- | --- |
25
+ | `page` | integer | query | No | Page number for pagination |
26
+ | `per_page` | integer | query | No | Number of records per page (default: 10, max: 200) |
27
+ | `search` | string | query | No | Search term. Searches invoice number, customer name/email, and order item titles. Also supports operator syntax (e.g., `status = completed`, `id > 5`, `id :: 1-10`) |
28
+ | `sort_by` | string | query | No | Column to sort by (default: `id`). Must be a fillable column on the Order model |
29
+ | `sort_type` | string | query | No | Sort direction: `asc` or `desc` (default: `desc`) |
30
+ | `active_view` | string | query | No | Tab filter. One of: `on-hold`, `paid`, `completed`, `processing`, `renewal`, `subscription`, `onetime`, `refunded`, `partially_refunded`, `upgraded_to`, `upgraded_from` |
31
+ | `filter_type` | string | query | No | Filter mode: `simple` (default) or `advanced` |
32
+ | `advanced_filters` | string (JSON) | query | No | JSON-encoded array of advanced filter groups (requires Pro). Supports filtering by order properties, customer properties, transaction properties, license properties, and UTM properties |
33
+ | `with` | array/string | query | No | Eager-load relations. Supports relation names and `{relation}Count` for counts |
34
+ | `select` | array/string | query | No | Comma-separated list of columns to select |
35
+ | `scopes` | array | query | No | Model scopes to apply |
36
+ | `include_ids` | array/string | query | No | Comma-separated IDs that must always be included in results |
37
+ | `limit` | integer | query | No | Limit number of records (used with non-paginated queries) |
38
+ | `offset` | integer | query | No | Offset for records |
39
+ | `user_tz` | string | query | No | User timezone for date filtering (e.g., `America/New_York`) |
40
+ | `payment_statuses` | array | query | No | Filter by payment statuses |
41
+ | `order_statuses` | array | query | No | Filter by order statuses |
42
+ | `shipping_statuses` | array | query | No | Filter by shipping statuses |
43
+
44
+ ### Searchable Fields (Operator Syntax)
45
+
46
+ The `search` parameter supports operator syntax like `field = value`, `field > value`, or `field :: range`:
47
+
48
+ | Field | Column | Type | Examples |
49
+ | --- | --- | --- | --- |
50
+ | `id` | `id` | numeric | `id = 1`, `id > 5`, `id :: 1-10` |
51
+ | `status` | `status` | string | `status = completed` |
52
+ | `invoice` | `status` | string | Invoice number search |
53
+ | `payment` | `payment_status` | string | `payment = paid`, `payment = partially_refunded` |
54
+ | `payment_by` | `payment_method` | string | `payment_by = stripe`, `payment_by = paypal` |
55
+ | `customer` | (custom) | custom | `customer = john` (searches name and email) |
56
+ | `license` | (custom) | custom | `license = ff-78d47b3fed89bda25cdc5b60d0298d60` (Pro only) |
57
+
58
+ ### Response
59
+
60
+ ```
61
+ {
62
+ "orders": {
63
+ "current_page": 1,
64
+ "data": [
65
+ {
66
+ "id": 1,
67
+ "uuid": "abc123-def456",
68
+ "invoice_no": "INV-001",
69
+ "status": "completed",
70
+ "payment_status": "paid",
71
+ "payment_method": "stripe",
72
+ "type": "payment",
73
+ "fulfillment_type": "digital",
74
+ "currency": "USD",
75
+ "subtotal": 5000,
76
+ "total_amount": 5000,
77
+ "total_paid": 5000,
78
+ "total_refund": 0,
79
+ "shipping_total": 0,
80
+ "tax_total": 0,
81
+ "manual_discount_total": 0,
82
+ "coupon_discount_total": 0,
83
+ "customer_id": 1,
84
+ "customer": { ... },
85
+ "created_at": "2025-01-15 10:30:00",
86
+ "updated_at": "2025-01-15 10:35:00"
87
+ }
88
+ ],
89
+ "per_page": 10,
90
+ "total": 100,
91
+ "last_page": 10
92
+ }
93
+ }
94
+ ```
95
+
96
+ ### Example
97
+
98
+ ```
99
+ curl -X GET "https://example.com/wp-json/fluent-cart/v2/orders?page=1&per_page=10&sort_by=id&sort_type=desc" \
100
+ -u "username:app_password"
101
+ ```
102
+
103
+ ---
104
+
105
+ ## Calculate Shipping
106
+
107
+ POST `/fluent-cart/v2/orders/calculate-shipping`
108
+
109
+ Calculate shipping charges for order items with a specific shipping method.
110
+
111
+ - **Permission:** `orders/create` or `orders/manage`
112
+
113
+ ### Parameters
114
+
115
+ | Parameter | Type | Location | Required | Description |
116
+ | --- | --- | --- | --- | --- |
117
+ | `order_items` | array | body | Yes | Array of order items, each with `id` (variation ID) and `quantity` |
118
+ | `shipping_id` | integer | body | Yes | ID of the shipping method to calculate charges for |
119
+
120
+ ### Response
121
+
122
+ ```
123
+ {
124
+ "message": "Shipping updated",
125
+ "shipping_charge": 500,
126
+ "order_items": {
127
+ "1": {
128
+ "id": 1,
129
+ "quantity": 2,
130
+ "shipping_charge": 500,
131
+ "unit_price": 2500,
132
+ "other_info": {},
133
+ "discount_total": 0,
134
+ "fulfillment_type": "physical"
135
+ }
136
+ }
137
+ }
138
+ ```
139
+
140
+ ### Example
141
+
142
+ ```
143
+ curl -X POST "https://example.com/wp-json/fluent-cart/v2/orders/calculate-shipping" \
144
+ -u "username:app_password" \
145
+ -H "Content-Type: application/json" \
146
+ -d '{
147
+ "order_items": [{"id": 1, "quantity": 2}],
148
+ "shipping_id": 5
149
+ }'
150
+ ```
151
+
152
+ ---
153
+
154
+ ## Create Order
155
+
156
+ POST `/fluent-cart/v2/orders`
157
+
158
+ Create a new order manually from the admin panel.
159
+
160
+ - **Permission:** `orders/create`
161
+ - **Request Class:** `OrderRequest`
162
+
163
+ ### Parameters
164
+
165
+ | Parameter | Type | Location | Required | Description |
166
+ | --- | --- | --- | --- | --- |
167
+ | `customer_id` | integer | body | Yes | ID of the customer placing the order |
168
+ | `order_items` | array | body | Yes | Array of order items (see Order Items below) |
169
+ | `status` | string | body | No | Order status (max 50 chars) |
170
+ | `invoice_no` | string | body | No | Invoice number (max 100 chars) |
171
+ | `fulfillment_type` | string | body | No | Fulfillment type (max 50 chars) |
172
+ | `type` | string | body | No | Order type (max 50 chars) |
173
+ | `payment_method` | string | body | No | Payment method key (max 50 chars) |
174
+ | `payment_method_title` | string | body | No | Payment method display title (max 50 chars) |
175
+ | `payment_status` | string | body | No | Payment status (max 50 chars) |
176
+ | `currency` | string | body | No | Currency code, e.g., `USD` (max 10 chars) |
177
+ | `subtotal` | numeric | body | No | Order subtotal in cents |
178
+ | `discount_tax` | numeric | body | No | Discount tax amount in cents |
179
+ | `manual_discount_total` | numeric | body | No | Manual discount total in cents |
180
+ | `coupon_discount_total` | numeric | body | No | Coupon discount total in cents |
181
+ | `shipping_tax` | numeric | body | No | Shipping tax in cents |
182
+ | `shipping_total` | numeric | body | No | Shipping total in cents |
183
+ | `tax_total` | numeric | body | No | Tax total in cents |
184
+ | `total_amount` | numeric | body | No | Total order amount in cents |
185
+ | `rate` | numeric | body | No | Exchange rate |
186
+ | `note` | string | body | No | Order note (max 5000 chars) |
187
+ | `uuid` | string | body | No | Order UUID (max 100 chars) |
188
+ | `ip_address` | string | body | No | Customer IP address (max 100 chars) |
189
+ | `completed_at` | string | body | No | Completion timestamp (max 100 chars) |
190
+ | `refunded_at` | string | body | No | Refund timestamp (max 100 chars) |
191
+ | `user_tz` | string | body | No | User timezone (max 50 chars) |
192
+ | `discount` | object | body | No | Manual discount details |
193
+ | `shipping` | array | body | No | Shipping method details |
194
+ | `applied_coupon` | array | body | No | Applied coupon details |
195
+ | `trigger` | string | body | No | Trigger source |
196
+
197
+ #### Order Items Object
198
+
199
+ | Field | Type | Required | Description |
200
+ | --- | --- | --- | --- |
201
+ | `id` | integer | No | Order item ID (for updates) |
202
+ | `order_id` | integer | No | Parent order ID |
203
+ | `post_id` | integer | No | WordPress post ID of the product |
204
+ | `variation_id` | integer | No | Product variation ID |
205
+ | `object_id` | integer | No | Object reference ID |
206
+ | `fulfillment_type` | string | No | `digital` or `physical` |
207
+ | `payment_type` | string | No | Payment type (max 100 chars), e.g., `subscription` |
208
+ | `quantity` | integer | No | Item quantity (min: 1) |
209
+ | `post_title` | string | No | Product title (max 255 chars) |
210
+ | `title` | string | No | Item title (max 255 chars) |
211
+ | `price` | numeric | No | Item price in cents |
212
+ | `unit_price` | numeric | No | Unit price in cents |
213
+ | `shipping_charge` | numeric | No | Shipping charge in cents |
214
+ | `item_cost` | numeric | No | Item cost in cents |
215
+ | `item_total` | numeric | No | Item total in cents |
216
+ | `tax_amount` | numeric | No | Tax amount in cents |
217
+ | `discount_total` | numeric | No | Discount total in cents |
218
+ | `total` | numeric | No | Total in cents |
219
+ | `line_total` | numeric | No | Line total in cents |
220
+ | `cart_index` | integer | No | Cart position index |
221
+ | `rate` | numeric | No | Exchange rate |
222
+ | `line_meta` | array | No | Line item metadata |
223
+ | `other_info` | array | No | Additional item information |
224
+
225
+ #### Discount Object
226
+
227
+ | Field | Type | Required | Description |
228
+ | --- | --- | --- | --- |
229
+ | `type` | string | No | Discount type (max 100 chars) |
230
+ | `value` | numeric | No | Discount value |
231
+ | `label` | string | No | Discount label (max 100 chars) |
232
+ | `reason` | string | No | Discount reason (max 100 chars) |
233
+ | `action` | string | No | Discount action (max 100 chars) |
234
+
235
+ #### Shipping Object (array)
236
+
237
+ | Field | Type | Required | Description |
238
+ | --- | --- | --- | --- |
239
+ | `type` | string | No | Shipping type (max 100 chars) |
240
+ | `rate_name` | string | No | Shipping rate name (max 100 chars) |
241
+ | `custom_price` | numeric | No | Custom shipping price in cents |
242
+
243
+ #### Applied Coupon Object (array)
244
+
245
+ | Field | Type | Required | Description |
246
+ | --- | --- | --- | --- |
247
+ | `id` | integer | No | Applied coupon record ID |
248
+ | `order_id` | integer | No | Order ID |
249
+ | `coupon_id` | integer | Yes | Coupon ID (min: 1) |
250
+ | `code` | string | Yes | Coupon code (max 100 chars) |
251
+ | `amount` | numeric | No | Coupon amount |
252
+ | `discounted_amount` | numeric | Yes | Discounted amount in cents |
253
+ | `discount` | numeric | No | Discount value |
254
+ | `stackable` | integer | Yes | Whether coupon is stackable (0 or 1) |
255
+ | `priority` | integer | No | Coupon priority |
256
+ | `max_uses` | integer | No | Maximum uses |
257
+ | `use_count` | integer | No | Current use count |
258
+ | `max_per_customer` | integer | No | Max uses per customer (min: 1) |
259
+ | `min_purchase_amount` | numeric | No | Minimum purchase amount in cents |
260
+ | `max_discount_amount` | numeric | No | Maximum discount amount in cents |
261
+ | `notes` | string | No | Coupon notes (max 100 chars) |
262
+
263
+ ### Response
264
+
265
+ ```
266
+ {
267
+ "message": "Order created successfully!",
268
+ "order_id": 42,
269
+ "uuid": "abc123-def456-ghi789"
270
+ }
271
+ ```
272
+
273
+ ### Example
274
+
275
+ ```
276
+ curl -X POST "https://example.com/wp-json/fluent-cart/v2/orders" \
277
+ -u "username:app_password" \
278
+ -H "Content-Type: application/json" \
279
+ -d '{
280
+ "customer_id": 1,
281
+ "order_items": [
282
+ {
283
+ "post_id": 10,
284
+ "variation_id": 5,
285
+ "object_id": 5,
286
+ "quantity": 1,
287
+ "unit_price": 2500,
288
+ "price": 2500,
289
+ "item_total": 2500,
290
+ "total": 2500,
291
+ "line_total": 2500,
292
+ "title": "Pro License"
293
+ }
294
+ ],
295
+ "subtotal": 2500,
296
+ "total_amount": 2500,
297
+ "payment_method": "offline_payment"
298
+ }'
299
+ ```
300
+
301
+ ---
302
+
303
+ ## Bulk Actions
304
+
305
+ POST `/fluent-cart/v2/orders/do-bulk-action`
306
+
307
+ Perform bulk actions on multiple orders at once.
308
+
309
+ - **Permission:** `orders/manage`
310
+
311
+ ### Parameters
312
+
313
+ | Parameter | Type | Location | Required | Description |
314
+ | --- | --- | --- | --- | --- |
315
+ | `action` | string | body | Yes | Bulk action to perform. One of: `delete_orders`, `change_shipping_status`, `change_order_status`, `capture_payments`, `change_payment_status` |
316
+ | `order_ids` | array | body | Yes | Array of order IDs to act upon |
317
+ | `new_status` | string | body | Conditional | New status value. Required for `change_shipping_status`, `change_order_status`, and `change_payment_status` actions |
318
+ | `manage_stock` | string | body | No | Whether to manage stock on status change (`true`/`false`) |
319
+
320
+ ### Supported Actions
321
+
322
+ | Action | Description | Valid `new_status` Values |
323
+ | --- | --- | --- |
324
+ | `delete_orders` | Delete selected orders and related data | N/A |
325
+ | `change_shipping_status` | Update shipping status | Valid shipping statuses (e.g., `shipped`, `delivered`) |
326
+ | `change_order_status` | Update order status | `completed`, `processing`, `on-hold`, `canceled` |
327
+ | `capture_payments` | Capture authorized payments | N/A |
328
+ | `change_payment_status` | Update payment status | Valid transaction statuses |
329
+
330
+ ### Response
331
+
332
+ ```
333
+ {
334
+ "message": "Order Status has been changed for the selected orders"
335
+ }
336
+ ```
337
+
338
+ ### Example
339
+
340
+ ```
341
+ curl -X POST "https://example.com/wp-json/fluent-cart/v2/orders/do-bulk-action" \
342
+ -u "username:app_password" \
343
+ -H "Content-Type: application/json" \
344
+ -d '{
345
+ "action": "change_order_status",
346
+ "order_ids": [1, 2, 3],
347
+ "new_status": "processing"
348
+ }'
349
+ ```
350
+
351
+ ---
352
+
353
+ ## Mark Order as Paid
354
+
355
+ POST `/fluent-cart/v2/orders/{order}/mark-as-paid`
356
+
357
+ Mark a pending order as paid, creating or updating the transaction record.
358
+
359
+ - **Permission:** `orders/manage`
360
+
361
+ ### Parameters
362
+
363
+ | Parameter | Type | Location | Required | Description |
364
+ | --- | --- | --- | --- | --- |
365
+ | `order` | integer | path | Yes | Order ID |
366
+ | `payment_method` | string | body | No | Payment method used (e.g., `offline_payment`, `stripe`) |
367
+ | `vendor_charge_id` | string | body | No | External payment reference/charge ID |
368
+ | `transaction_type` | string | body | No | Transaction type identifier |
369
+ | `mark_paid_note` | string | body | No | Note to attach to the order |
370
+
371
+ ### Response
372
+
373
+ ```
374
+ {
375
+ "message": "Order has been marked as paid"
376
+ }
377
+ ```
378
+
379
+ ### Error Responses
380
+
381
+ | Status | Message |
382
+ | --- | --- |
383
+ | 423 | Order has already been paid |
384
+ | 423 | Unable to mark paid for canceled order |
385
+
386
+ ### Example
387
+
388
+ ```
389
+ curl -X POST "https://example.com/wp-json/fluent-cart/v2/orders/42/mark-as-paid" \
390
+ -u "username:app_password" \
391
+ -H "Content-Type: application/json" \
392
+ -d '{
393
+ "payment_method": "offline_payment",
394
+ "vendor_charge_id": "CHK-12345",
395
+ "mark_paid_note": "Payment received via bank transfer"
396
+ }'
397
+ ```
398
+
399
+ ---
400
+
401
+ ## Generate Missing Licenses
402
+
403
+ POST `/fluent-cart/v2/orders/{order}/generate-missing-licenses`
404
+
405
+ Generate any missing license keys for an order's items (requires Pro with licensing module).
406
+
407
+ - **Permission:** `orders/manage`
408
+
409
+ ### Parameters
410
+
411
+ | Parameter | Type | Location | Required | Description |
412
+ | --- | --- | --- | --- | --- |
413
+ | `order` | integer | path | Yes | Order ID |
414
+
415
+ ### Error Responses
416
+
417
+ | Status | Message |
418
+ | --- | --- |
419
+ | 404 | Order not found |
420
+ | 400 | No missing licenses found! |
421
+
422
+ ### Example
423
+
424
+ ```
425
+ curl -X POST "https://example.com/wp-json/fluent-cart/v2/orders/42/generate-missing-licenses" \
426
+ -u "username:app_password"
427
+ ```
428
+
429
+ ---
430
+
431
+ ## Get Order Details
432
+
433
+ GET `/fluent-cart/v2/orders/{order_id}`
434
+
435
+ Retrieve detailed information about a specific order, including items, transactions, addresses, subscriptions, and activities.
436
+
437
+ - **Permission:** `orders/view`
438
+
439
+ ### Parameters
440
+
441
+ | Parameter | Type | Location | Required | Description |
442
+ | --- | --- | --- | --- | --- |
443
+ | `order_id` | integer | path | Yes | Order ID |
444
+
445
+ ### Response
446
+
447
+ ```
448
+ {
449
+ "order": {
450
+ "id": 42,
451
+ "uuid": "abc123-def456",
452
+ "invoice_no": "INV-042",
453
+ "status": "completed",
454
+ "payment_status": "paid",
455
+ "payment_method": "stripe",
456
+ "type": "payment",
457
+ "fulfillment_type": "digital",
458
+ "currency": "USD",
459
+ "subtotal": 5000,
460
+ "total_amount": 5000,
461
+ "total_paid": 5000,
462
+ "total_refund": 0,
463
+ "shipping_total": 0,
464
+ "tax_total": 0,
465
+ "manual_discount_total": 0,
466
+ "coupon_discount_total": 0,
467
+ "customer_id": 1,
468
+ "customer": { ... },
469
+ "order_items": [ ... ],
470
+ "transactions": [ ... ],
471
+ "billing_address": { ... },
472
+ "shipping_address": { ... },
473
+ "subscriptions": [ ... ],
474
+ "activities": [ ... ],
475
+ "labels": [ ... ],
476
+ "applied_coupons": [ ... ],
477
+ "children": [ ... ],
478
+ "parent_order": null,
479
+ "order_operation": { ... },
480
+ "receipt_url": "https://example.com/receipt/?order_hash=abc123",
481
+ "custom_checkout_url": "https://example.com/checkout/?payment_hash=...",
482
+ "has_missing_licenses": false,
483
+ "created_at": "2025-01-15 10:30:00",
484
+ "updated_at": "2025-01-15 10:35:00"
485
+ },
486
+ "discount_meta": { ... },
487
+ "shipping_meta": { ... },
488
+ "order_settings": {},
489
+ "selected_labels": [1, 2],
490
+ "tax_id": null
491
+ }
492
+ ```
493
+
494
+ ### Example
495
+
496
+ ```
497
+ curl -X GET "https://example.com/wp-json/fluent-cart/v2/orders/42" \
498
+ -u "username:app_password"
499
+ ```
500
+
501
+ ---
502
+
503
+ ## Update Order
504
+
505
+ POST `/fluent-cart/v2/orders/{order_id}`
506
+
507
+ Update an existing order's details, items, discounts, shipping, and coupons. Subscription orders cannot be edited.
508
+
509
+ - **Permission:** `orders/manage`
510
+ - **Request Class:** `OrderRequest`
511
+
512
+ ### Parameters
513
+
514
+ | Parameter | Type | Location | Required | Description |
515
+ | --- | --- | --- | --- | --- |
516
+ | `order_id` | integer | path | Yes | Order ID |
517
+ | `customer_id` | integer | body | Yes | Customer ID |
518
+ | `order_items` | array | body | Yes | Updated array of order items (same structure as Create Order) |
519
+ | `status` | string | body | No | Order status (cannot be set to `completed`) |
520
+ | `payment_status` | string | body | No | Payment status |
521
+ | `subtotal` | numeric | body | No | Updated subtotal in cents |
522
+ | `total_amount` | numeric | body | No | Updated total amount in cents |
523
+ | `total_paid` | numeric | body | No | Total amount already paid in cents |
524
+ | `shipping_total` | numeric | body | No | Updated shipping total in cents |
525
+ | `tax_total` | numeric | body | No | Updated tax total in cents |
526
+ | `manual_discount_total` | numeric | body | No | Manual discount in cents |
527
+ | `coupon_discount_total` | numeric | body | No | Coupon discount in cents |
528
+ | `discount` | object | body | No | Discount details (see Create Order) |
529
+ | `shipping` | array | body | No | Shipping details (see Create Order) |
530
+ | `applied_coupon` | array | body | No | Applied coupon details (see Create Order) |
531
+ | `deletedItems` | array | body | No | Array of order item IDs to remove |
532
+ | `couponCalculation` | array | body | No | Coupon calculation details |
533
+
534
+ All other fields from `OrderRequest` are also accepted (see Create Order).
535
+
536
+ ### Error Responses
537
+
538
+ | Status | Message |
539
+ | --- | --- |
540
+ | 400 | Subscription Order cannot be edited |
541
+ | 400 | Completed status can not be updated |
542
+
543
+ ### Response
544
+
545
+ ```
546
+ {
547
+ "message": "Order updated successfully",
548
+ "order": { ... }
549
+ }
550
+ ```
551
+
552
+ ### Example
553
+
554
+ ```
555
+ curl -X POST "https://example.com/wp-json/fluent-cart/v2/orders/42" \
556
+ -u "username:app_password" \
557
+ -H "Content-Type: application/json" \
558
+ -d '{
559
+ "customer_id": 1,
560
+ "order_items": [
561
+ {
562
+ "id": 10,
563
+ "order_id": 42,
564
+ "quantity": 2,
565
+ "unit_price": 2500,
566
+ "line_total": 5000
567
+ }
568
+ ],
569
+ "subtotal": 5000,
570
+ "total_amount": 5000
571
+ }'
572
+ ```
573
+
574
+ ---
575
+
576
+ ## Update Order Address ID
577
+
578
+ POST `/fluent-cart/v2/orders/{order_id}/update-address-id`
579
+
580
+ Assign an existing customer address to an order's billing or shipping address.
581
+
582
+ - **Permission:** `orders/manage`
583
+
584
+ ### Parameters
585
+
586
+ | Parameter | Type | Location | Required | Description |
587
+ | --- | --- | --- | --- | --- |
588
+ | `order_id` | integer | path | Yes | Order ID |
589
+ | `address_id` | integer | body | Yes | Customer address ID to assign |
590
+ | `address_type` | string | body | No | Address type: `billing` (default) or `shipping` |
591
+
592
+ ### Response
593
+
594
+ ```
595
+ {
596
+ "message": "Address updated successfully"
597
+ }
598
+ ```
599
+
600
+ ### Error Responses
601
+
602
+ | Status | Message |
603
+ | --- | --- |
604
+ | 404 | Order not found |
605
+
606
+ ### Example
607
+
608
+ ```
609
+ curl -X POST "https://example.com/wp-json/fluent-cart/v2/orders/42/update-address-id" \
610
+ -u "username:app_password" \
611
+ -H "Content-Type: application/json" \
612
+ -d '{
613
+ "address_id": 5,
614
+ "address_type": "billing"
615
+ }'
616
+ ```
617
+
618
+ ---
619
+
620
+ ## Refund Order
621
+
622
+ POST `/fluent-cart/v2/orders/{order_id}/refund`
623
+
624
+ Process a full or partial refund for an order. Supports both gateway refunds and manual refunds, with optional subscription cancellation.
625
+
626
+ - **Permission:** `orders/can_refund`
627
+
628
+ ### Parameters
629
+
630
+ | Parameter | Type | Location | Required | Description |
631
+ | --- | --- | --- | --- | --- |
632
+ | `order_id` | integer | path | Yes | Order ID |
633
+ | `refund_info` | object | body | Yes | Refund details object |
634
+ | `refund_info.transaction_id` | integer | body | Yes | ID of the transaction to refund |
635
+ | `refund_info.amount` | numeric | body | Yes | Refund amount in **decimal** format (e.g., `10.00` not cents). Will be converted to cents internally |
636
+ | `refund_info.cancelSubscription` | string | body | No | Set to `"true"` to cancel associated subscription |
637
+
638
+ ### Response
639
+
640
+ ```
641
+ {
642
+ "fluent_cart_refund": {
643
+ "status": "success",
644
+ "message": "Refund processed on FluentCart."
645
+ },
646
+ "gateway_refund": {
647
+ "status": "success",
648
+ "message": "Refund processed on Stripe"
649
+ },
650
+ "subscription_cancel": {
651
+ "status": "success",
652
+ "message": "Subscription cancelled successfully"
653
+ }
654
+ }
655
+ ```
656
+
657
+ ### Error Responses
658
+
659
+ | Status | Message |
660
+ | --- | --- |
661
+ | 400 | Order can not be refunded |
662
+ | 422 | Transaction ID is required |
663
+ | 422 | Refund amount is required |
664
+
665
+ ### Example
666
+
667
+ ```
668
+ curl -X POST "https://example.com/wp-json/fluent-cart/v2/orders/42/refund" \
669
+ -u "username:app_password" \
670
+ -H "Content-Type: application/json" \
671
+ -d '{
672
+ "refund_info": {
673
+ "transaction_id": 15,
674
+ "amount": 25.00,
675
+ "cancelSubscription": "true"
676
+ }
677
+ }'
678
+ ```
679
+
680
+ ---
681
+
682
+ ## Change Customer
683
+
684
+ POST `/fluent-cart/v2/orders/{order_id}/change-customer`
685
+
686
+ Reassign an order to a different existing customer. Updates all connected orders (parent/child/renewals), subscriptions, and customer statistics.
687
+
688
+ - **Permission:** `orders/manage`
689
+
690
+ ### Parameters
691
+
692
+ | Parameter | Type | Location | Required | Description |
693
+ | --- | --- | --- | --- | --- |
694
+ | `order_id` | integer | path | Yes | Order ID |
695
+ | `customer_id` | integer | body | Yes | New customer ID to assign |
696
+
697
+ ### Response
698
+
699
+ ```
700
+ {
701
+ "message": "Customer changed successfully"
702
+ }
703
+ ```
704
+
705
+ ### Error Responses
706
+
707
+ | Status | Message |
708
+ | --- | --- |
709
+ | 423 | Customer id is required |
710
+
711
+ ### Example
712
+
713
+ ```
714
+ curl -X POST "https://example.com/wp-json/fluent-cart/v2/orders/42/change-customer" \
715
+ -u "username:app_password" \
716
+ -H "Content-Type: application/json" \
717
+ -d '{
718
+ "customer_id": 15
719
+ }'
720
+ ```
721
+
722
+ ---
723
+
724
+ ## Create and Change Customer
725
+
726
+ POST `/fluent-cart/v2/orders/{order_id}/create-and-change-customer`
727
+
728
+ Create a new customer and immediately assign them to the order. Combines customer creation with order reassignment.
729
+
730
+ - **Permission:** `orders/manage`
731
+ - **Request Class:** `CustomerRequest`
732
+
733
+ ### Parameters
734
+
735
+ | Parameter | Type | Location | Required | Description |
736
+ | --- | --- | --- | --- | --- |
737
+ | `order_id` | integer | path | Yes | Order ID |
738
+ | `first_name` | string | body | Conditional | Customer first name (max 255 chars). Required if full name mode is disabled |
739
+ | `last_name` | string | body | No | Customer last name (max 255 chars) |
740
+ | `full_name` | string | body | Conditional | Customer full name (max 255 chars). Required if full name mode is enabled |
741
+ | `email` | string | body | Yes | Customer email address (max 255 chars, must be unique) |
742
+ | `city` | string | body | No | Customer city |
743
+ | `user_id` | integer | body | No | WordPress user ID to link |
744
+ | `status` | string | body | No | Customer status |
745
+ | `country` | string | body | No | Customer country |
746
+ | `state` | string | body | No | Customer state |
747
+ | `postcode` | string | body | No | Customer postal code |
748
+ | `notes` | string | body | No | Customer notes |
749
+
750
+ ### Response
751
+
752
+ ```
753
+ {
754
+ "message": "Customer changed successfully"
755
+ }
756
+ ```
757
+
758
+ ### Error Responses
759
+
760
+ | Status | Message |
761
+ | --- | --- |
762
+ | 422 | Email is required |
763
+ | 422 | Email already exists |
764
+ | 422 | First Name is required |
765
+ | 400 | Failed to attach customer |
766
+
767
+ ### Example
768
+
769
+ ```
770
+ curl -X POST "https://example.com/wp-json/fluent-cart/v2/orders/42/create-and-change-customer" \
771
+ -u "username:app_password" \
772
+ -H "Content-Type: application/json" \
773
+ -d '{
774
+ "first_name": "Jane",
775
+ "last_name": "Doe",
776
+ "email": "[email protected]"
777
+ }'
778
+ ```
779
+
780
+ ---
781
+
782
+ ## Delete Order
783
+
784
+ DELETE `/fluent-cart/v2/orders/{order_id}`
785
+
786
+ Permanently delete an order and all associated data (transactions, items, meta, addresses, coupons, cart data, download permissions, labels). For subscription orders, also deletes all child renewal orders and subscriptions.
787
+
788
+ - **Permission:** `orders/delete`
789
+
790
+ ### Parameters
791
+
792
+ | Parameter | Type | Location | Required | Description |
793
+ | --- | --- | --- | --- | --- |
794
+ | `order_id` | integer | path | Yes | Order ID to delete |
795
+
796
+ ### Response
797
+
798
+ ```
799
+ {
800
+ "message": "Order 42 deleted successfully",
801
+ "data": {
802
+ "order_id": 42,
803
+ "invoice_no": "INV-042",
804
+ "status": "success"
805
+ },
806
+ "errors": []
807
+ }
808
+ ```
809
+
810
+ ### Error Responses
811
+
812
+ | Status | Message |
813
+ | --- | --- |
814
+ | 404 | Order not found |
815
+ | 400 | (Various reasons why order cannot be deleted) |
816
+
817
+ ### Example
818
+
819
+ ```
820
+ curl -X DELETE "https://example.com/wp-json/fluent-cart/v2/orders/42" \
821
+ -u "username:app_password"
822
+ ```
823
+
824
+ ---
825
+
826
+ ## Update Statuses
827
+
828
+ PUT `/fluent-cart/v2/orders/{order}/statuses`
829
+
830
+ Update the order status or shipping status for an order.
831
+
832
+ - **Permission:** `orders/manage_statuses`
833
+
834
+ ### Parameters
835
+
836
+ | Parameter | Type | Location | Required | Description |
837
+ | --- | --- | --- | --- | --- |
838
+ | `order` | integer | path | Yes | Order ID |
839
+ | `action` | string | body | Yes | Status change type: `change_order_status` or `change_shipping_status` |
840
+ | `statuses` | object | body | Yes | Status values object |
841
+ | `statuses.order_status` | string | body | Conditional | New order status. Required when `action` is `change_order_status`. One of: `completed`, `processing`, `on-hold`, `canceled` |
842
+ | `statuses.shipping_status` | string | body | Conditional | New shipping status. Required when `action` is `change_shipping_status` |
843
+ | `manage_stock` | string/boolean | body | No | Whether to adjust stock levels on status change |
844
+
845
+ ### Response
846
+
847
+ ```
848
+ {
849
+ "message": "Status has been updated",
850
+ "data": { ... }
851
+ }
852
+ ```
853
+
854
+ ### Error Responses
855
+
856
+ | Status | Message |
857
+ | --- | --- |
858
+ | 400 | Order already has the same status |
859
+ | 400 | You cannot change the order status once it has been canceled |
860
+
861
+ ### Example
862
+
863
+ ```
864
+ curl -X PUT "https://example.com/wp-json/fluent-cart/v2/orders/42/statuses" \
865
+ -u "username:app_password" \
866
+ -H "Content-Type: application/json" \
867
+ -d '{
868
+ "action": "change_order_status",
869
+ "statuses": {
870
+ "order_status": "processing"
871
+ },
872
+ "manage_stock": true
873
+ }'
874
+ ```
875
+
876
+ ---
877
+
878
+ ## Get Order Transactions
879
+
880
+ GET `/fluent-cart/v2/orders/{order}/transactions`
881
+
882
+ Retrieve all transactions for an order. This endpoint returns the full order details (same as Get Order Details), which includes the `transactions` relation.
883
+
884
+ - **Permission:** `orders/view`
885
+
886
+ ### Parameters
887
+
888
+ | Parameter | Type | Location | Required | Description |
889
+ | --- | --- | --- | --- | --- |
890
+ | `order` | integer | path | Yes | Order ID |
891
+
892
+ ### Response
893
+
894
+ Same response structure as [Get Order Details](#get-order-details), with the `order.transactions` array populated.
895
+
896
+ ### Example
897
+
898
+ ```
899
+ curl -X GET "https://example.com/wp-json/fluent-cart/v2/orders/42/transactions" \
900
+ -u "username:app_password"
901
+ ```
902
+
903
+ ---
904
+
905
+ ## Accept Dispute
906
+
907
+ POST `/fluent-cart/v2/orders/{order}/transactions/{transaction_id}/accept-dispute/`
908
+
909
+ Accept a payment dispute (chargeback) for a specific transaction.
910
+
911
+ - **Permission:** `orders/manage`
912
+
913
+ ### Parameters
914
+
915
+ | Parameter | Type | Location | Required | Description |
916
+ | --- | --- | --- | --- | --- |
917
+ | `order` | integer | path | Yes | Order ID |
918
+ | `transaction_id` | integer | path | Yes | Transaction ID with the dispute |
919
+ | `dispute_note` | string | body | No | Note about the dispute acceptance |
920
+
921
+ ### Response
922
+
923
+ ```
924
+ {
925
+ "message": "Dispute accepted!"
926
+ }
927
+ ```
928
+
929
+ ### Example
930
+
931
+ ```
932
+ curl -X POST "https://example.com/wp-json/fluent-cart/v2/orders/42/transactions/15/accept-dispute/" \
933
+ -u "username:app_password" \
934
+ -H "Content-Type: application/json" \
935
+ -d '{
936
+ "dispute_note": "Customer provided valid reason for dispute"
937
+ }'
938
+ ```
939
+
940
+ ---
941
+
942
+ ## Get Single Transaction
943
+
944
+ GET `/fluent-cart/v2/orders/{id}/transactions/{transaction_id}`
945
+
946
+ Retrieve details of a specific transaction within an order. This endpoint returns the full order details (same as Get Order Details).
947
+
948
+ - **Permission:** `orders/view`
949
+
950
+ ### Parameters
951
+
952
+ | Parameter | Type | Location | Required | Description |
953
+ | --- | --- | --- | --- | --- |
954
+ | `id` | integer | path | Yes | Order ID |
955
+ | `transaction_id` | integer | path | Yes | Transaction ID |
956
+
957
+ ### Response
958
+
959
+ Same response structure as [Get Order Details](#get-order-details).
960
+
961
+ ### Example
962
+
963
+ ```
964
+ curl -X GET "https://example.com/wp-json/fluent-cart/v2/orders/42/transactions/15" \
965
+ -u "username:app_password"
966
+ ```
967
+
968
+ ---
969
+
970
+ ## Update Order Address
971
+
972
+ PUT `/fluent-cart/v2/orders/{order}/address/{id}`
973
+
974
+ Update an existing order address (billing or shipping) with new address data.
975
+
976
+ - **Permission:** `orders/manage`
977
+
978
+ ### Parameters
979
+
980
+ | Parameter | Type | Location | Required | Description |
981
+ | --- | --- | --- | --- | --- |
982
+ | `order` | integer | path | Yes | Order ID |
983
+ | `id` | integer | path | Yes | Order address ID |
984
+ | `order_id` | integer | body | Yes | Order ID (must match the path parameter) |
985
+ | `name` | string | body | No | Full name |
986
+ | `first_name` | string | body | No | First name |
987
+ | `last_name` | string | body | No | Last name |
988
+ | `full_name` | string | body | No | Full name |
989
+ | `address_1` | string | body | No | Address line 1 |
990
+ | `address_2` | string | body | No | Address line 2 |
991
+ | `city` | string | body | No | City |
992
+ | `state` | string | body | No | State/province |
993
+ | `postcode` | string | body | No | Postal/ZIP code |
994
+ | `country` | string | body | No | Country code |
995
+
996
+ ### Response
997
+
998
+ ```
999
+ {
1000
+ "message": "Address updated successfully"
1001
+ }
1002
+ ```
1003
+
1004
+ ### Error Responses
1005
+
1006
+ | Status | Message |
1007
+ | --- | --- |
1008
+ | 404 | The address information does not match |
1009
+
1010
+ ### Example
1011
+
1012
+ ```
1013
+ curl -X PUT "https://example.com/wp-json/fluent-cart/v2/orders/42/address/5" \
1014
+ -u "username:app_password" \
1015
+ -H "Content-Type: application/json" \
1016
+ -d '{
1017
+ "order_id": 42,
1018
+ "first_name": "John",
1019
+ "last_name": "Doe",
1020
+ "address_1": "123 Main St",
1021
+ "city": "New York",
1022
+ "state": "NY",
1023
+ "postcode": "10001",
1024
+ "country": "US"
1025
+ }'
1026
+ ```
1027
+
1028
+ ---
1029
+
1030
+ ## Update Transaction Status
1031
+
1032
+ PUT `/fluent-cart/v2/orders/{order}/transactions/{transaction}/status`
1033
+
1034
+ Update the payment status of a specific transaction and sync the order's payment status accordingly.
1035
+
1036
+ - **Permission:** `orders/manage`
1037
+
1038
+ ### Parameters
1039
+
1040
+ | Parameter | Type | Location | Required | Description |
1041
+ | --- | --- | --- | --- | --- |
1042
+ | `order` | integer | path | Yes | Order ID |
1043
+ | `transaction` | integer | path | Yes | Transaction ID |
1044
+ | `status` | string | body | Yes | New transaction status (e.g., `succeeded`, `pending`, `refunded`, `failed`) |
1045
+
1046
+ ### Response
1047
+
1048
+ ```
1049
+ {
1050
+ "transaction": {
1051
+ "id": 15,
1052
+ "order_id": 42,
1053
+ "status": "succeeded",
1054
+ "total": 5000,
1055
+ "payment_method": "stripe",
1056
+ ...
1057
+ },
1058
+ "message": "Payment status has been successfully updated"
1059
+ }
1060
+ ```
1061
+
1062
+ ### Error Responses
1063
+
1064
+ | Status | Message |
1065
+ | --- | --- |
1066
+ | 400 | Transaction already has the same status |
1067
+ | 400 | The selected transaction does not match with the provided order |
1068
+
1069
+ ### Example
1070
+
1071
+ ```
1072
+ curl -X PUT "https://example.com/wp-json/fluent-cart/v2/orders/42/transactions/15/status" \
1073
+ -u "username:app_password" \
1074
+ -H "Content-Type: application/json" \
1075
+ -d '{
1076
+ "status": "succeeded"
1077
+ }'
1078
+ ```
1079
+
1080
+ ---
1081
+
1082
+ ## Create Custom Order Item
1083
+
1084
+ POST `/fluent-cart/v2/orders/{order}/create-custom`
1085
+
1086
+ Add a custom product/item to an existing order.
1087
+
1088
+ - **Permission:** `orders/create`
1089
+
1090
+ ### Parameters
1091
+
1092
+ | Parameter | Type | Location | Required | Description |
1093
+ | --- | --- | --- | --- | --- |
1094
+ | `order` | integer | path | Yes | Order ID |
1095
+ | `product` | object | body | Yes | Product data to add as a custom item |
1096
+
1097
+ ### Response
1098
+
1099
+ Returns the result of processing the custom item addition.
1100
+
1101
+ ### Error Responses
1102
+
1103
+ | Status | Message |
1104
+ | --- | --- |
1105
+ | 423 | (Error message from processing) |
1106
+
1107
+ ### Example
1108
+
1109
+ ```
1110
+ curl -X POST "https://example.com/wp-json/fluent-cart/v2/orders/42/create-custom" \
1111
+ -u "username:app_password" \
1112
+ -H "Content-Type: application/json" \
1113
+ -d '{
1114
+ "product": {
1115
+ "title": "Custom Service",
1116
+ "price": 1500,
1117
+ "quantity": 1
1118
+ }
1119
+ }'
1120
+ ```
1121
+
1122
+ ---
1123
+
1124
+ ## Get Shipping Methods
1125
+
1126
+ GET `/fluent-cart/v2/orders/shipping_methods`
1127
+
1128
+ Retrieve available shipping methods, optionally filtered by country and state. Returns methods applicable to the specified location and all other enabled methods separately.
1129
+
1130
+ - **Permission:** `orders/manage`
1131
+
1132
+ ### Parameters
1133
+
1134
+ | Parameter | Type | Location | Required | Description |
1135
+ | --- | --- | --- | --- | --- |
1136
+ | `country_code` | string | query | No | Country code to filter applicable shipping methods (e.g., `US`, `GB`) |
1137
+ | `state` | string | query | No | State/province code for more specific filtering |
1138
+ | `order_items` | array | query | No | Array of order items (each with `id` and `quantity`) to calculate shipping charges |
1139
+
1140
+ ### Response
1141
+
1142
+ ```
1143
+ {
1144
+ "shipping_methods": [
1145
+ {
1146
+ "id": 1,
1147
+ "title": "Standard Shipping",
1148
+ "is_enabled": "1",
1149
+ "shipping_charge": 500,
1150
+ ...
1151
+ }
1152
+ ],
1153
+ "other_shipping_methods": [
1154
+ {
1155
+ "id": 2,
1156
+ "title": "International Shipping",
1157
+ "is_enabled": "1",
1158
+ "shipping_charge": 1500,
1159
+ ...
1160
+ }
1161
+ ]
1162
+ }
1163
+ ```
1164
+
1165
+ When `country_code` is empty, `shipping_methods` will be an empty array and all enabled methods appear in `other_shipping_methods`.
1166
+
1167
+ ### Example
1168
+
1169
+ ```
1170
+ curl -X GET "https://example.com/wp-json/fluent-cart/v2/orders/shipping_methods?country_code=US&state=CA" \
1171
+ -u "username:app_password"
1172
+ ```
1173
+
1174
+ ---
1175
+
1176
+ ## Sync Order Statuses
1177
+
1178
+ PUT `/fluent-cart/v2/orders/{order}/sync-statuses`
1179
+
1180
+ Synchronize the order's status and payment status based on the latest transaction data. Useful for resolving status mismatches.
1181
+
1182
+ - **Permission:** `orders/manage`
1183
+
1184
+ ### Parameters
1185
+
1186
+ | Parameter | Type | Location | Required | Description |
1187
+ | --- | --- | --- | --- | --- |
1188
+ | `order` | integer | path | Yes | Order ID |
1189
+
1190
+ ### Response
1191
+
1192
+ ```
1193
+ {
1194
+ "message": "Order statuses synced successfully",
1195
+ "order": { ... },
1196
+ "payment_status": "paid",
1197
+ "status": "processing"
1198
+ }
1199
+ ```
1200
+
1201
+ ### Error Responses
1202
+
1203
+ | Status | Message |
1204
+ | --- | --- |
1205
+ | 404 | No transaction found for this order |
1206
+
1207
+ ### Example
1208
+
1209
+ ```
1210
+ curl -X PUT "https://example.com/wp-json/fluent-cart/v2/orders/42/sync-statuses" \
1211
+ -u "username:app_password"
1212
+ ```