fluentcart-developer 3.0.0 → 3.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (609) hide show
  1. package/LICENSE.md +26 -26
  2. package/README.md +59 -59
  3. package/dist/cards/fluentcart/templates-native.js +1087 -1087
  4. package/dist/cards/fluentcart/tools.js +2309 -2309
  5. package/dist/skills/fluentcart-developer/SKILL.md +108 -108
  6. package/dist/skills/fluentcart-developer/examples/README.md +30 -30
  7. package/dist/skills/fluentcart-developer/examples/fluentcart-starter-child-theme/fluent-cart/checkout.php +32 -32
  8. package/dist/skills/fluentcart-developer/examples/fluentcart-starter-child-theme/functions.php +40 -40
  9. package/dist/skills/fluentcart-developer/examples/sample-custom-addon/fluentcart-custom-addon.php +113 -113
  10. package/dist/skills/fluentcart-developer/examples/sample-custom-payment-gateway/fluentcart-custom-gateway-example.php +148 -148
  11. package/dist/skills/fluentcart-developer/examples/sample-fee-surcharge-plugin/fluentcart-fee-surcharge.php +38 -38
  12. package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/README.md +22 -22
  13. package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/sample-plugin-with-licensing-sdk.php +79 -79
  14. package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/updater/FluentLicensing.php +303 -303
  15. package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/updater/LicenseSettings.php +566 -566
  16. package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/updater/PluginUpdater.php +304 -304
  17. package/dist/skills/fluentcart-developer/examples/sample-shipping-carrier/fluentcart-custom-shipping-carrier.php +61 -61
  18. package/dist/skills/fluentcart-developer/references/api/authentication.md +452 -452
  19. package/dist/skills/fluentcart-developer/references/api/coupons.md +786 -786
  20. package/dist/skills/fluentcart-developer/references/api/customers.md +889 -889
  21. package/dist/skills/fluentcart-developer/references/api/files.md +609 -609
  22. package/dist/skills/fluentcart-developer/references/api/index.md +432 -432
  23. package/dist/skills/fluentcart-developer/references/api/licensing.md +633 -633
  24. package/dist/skills/fluentcart-developer/references/api/order-bump.md +384 -384
  25. package/dist/skills/fluentcart-developer/references/api/orders.md +814 -814
  26. package/dist/skills/fluentcart-developer/references/api/products.md +866 -866
  27. package/dist/skills/fluentcart-developer/references/api/roles-permissions.md +536 -536
  28. package/dist/skills/fluentcart-developer/references/api/subscriptions.md +827 -827
  29. package/dist/skills/fluentcart-developer/references/database/index.md +44 -44
  30. package/dist/skills/fluentcart-developer/references/database/models/activity.md +178 -178
  31. package/dist/skills/fluentcart-developer/references/database/models/applied-coupon.md +291 -291
  32. package/dist/skills/fluentcart-developer/references/database/models/attribute-group.md +239 -239
  33. package/dist/skills/fluentcart-developer/references/database/models/attribute-relation.md +181 -181
  34. package/dist/skills/fluentcart-developer/references/database/models/attribute-term.md +219 -219
  35. package/dist/skills/fluentcart-developer/references/database/models/cart.md +645 -645
  36. package/dist/skills/fluentcart-developer/references/database/models/coupon.md +427 -427
  37. package/dist/skills/fluentcart-developer/references/database/models/customer-addresses.md +348 -348
  38. package/dist/skills/fluentcart-developer/references/database/models/customer-meta.md +156 -156
  39. package/dist/skills/fluentcart-developer/references/database/models/customer.md +584 -584
  40. package/dist/skills/fluentcart-developer/references/database/models/dynamic-model.md +163 -163
  41. package/dist/skills/fluentcart-developer/references/database/models/label-relationship.md +155 -155
  42. package/dist/skills/fluentcart-developer/references/database/models/label.md +153 -153
  43. package/dist/skills/fluentcart-developer/references/database/models/license-activation.md +182 -182
  44. package/dist/skills/fluentcart-developer/references/database/models/license-meta.md +163 -163
  45. package/dist/skills/fluentcart-developer/references/database/models/license-site.md +208 -208
  46. package/dist/skills/fluentcart-developer/references/database/models/license.md +640 -640
  47. package/dist/skills/fluentcart-developer/references/database/models/meta.md +233 -233
  48. package/dist/skills/fluentcart-developer/references/database/models/order-address.md +391 -391
  49. package/dist/skills/fluentcart-developer/references/database/models/order-download-permission.md +144 -144
  50. package/dist/skills/fluentcart-developer/references/database/models/order-item.md +383 -383
  51. package/dist/skills/fluentcart-developer/references/database/models/order-meta.md +303 -303
  52. package/dist/skills/fluentcart-developer/references/database/models/order-operation.md +158 -158
  53. package/dist/skills/fluentcart-developer/references/database/models/order-promotion-stat.md +175 -175
  54. package/dist/skills/fluentcart-developer/references/database/models/order-promotion.md +250 -250
  55. package/dist/skills/fluentcart-developer/references/database/models/order-tax-rate.md +172 -172
  56. package/dist/skills/fluentcart-developer/references/database/models/order-transaction.md +440 -440
  57. package/dist/skills/fluentcart-developer/references/database/models/order.md +727 -727
  58. package/dist/skills/fluentcart-developer/references/database/models/product-detail.md +397 -397
  59. package/dist/skills/fluentcart-developer/references/database/models/product-download.md +258 -258
  60. package/dist/skills/fluentcart-developer/references/database/models/product-meta.md +153 -153
  61. package/dist/skills/fluentcart-developer/references/database/models/product-variation.md +556 -556
  62. package/dist/skills/fluentcart-developer/references/database/models/product.md +580 -580
  63. package/dist/skills/fluentcart-developer/references/database/models/relationships.md +427 -427
  64. package/dist/skills/fluentcart-developer/references/database/models/scheduled-action.md +175 -175
  65. package/dist/skills/fluentcart-developer/references/database/models/shipping-class.md +148 -148
  66. package/dist/skills/fluentcart-developer/references/database/models/shipping-method.md +280 -280
  67. package/dist/skills/fluentcart-developer/references/database/models/shipping-zone.md +205 -205
  68. package/dist/skills/fluentcart-developer/references/database/models/subscription-meta.md +173 -173
  69. package/dist/skills/fluentcart-developer/references/database/models/subscription.md +528 -528
  70. package/dist/skills/fluentcart-developer/references/database/models/tax-class.md +195 -195
  71. package/dist/skills/fluentcart-developer/references/database/models/tax-rate.md +225 -225
  72. package/dist/skills/fluentcart-developer/references/database/models/user-meta.md +166 -166
  73. package/dist/skills/fluentcart-developer/references/database/models/user.md +220 -220
  74. package/dist/skills/fluentcart-developer/references/database/models.md +404 -404
  75. package/dist/skills/fluentcart-developer/references/database/query-builder.md +860 -860
  76. package/dist/skills/fluentcart-developer/references/database/readme.md +276 -276
  77. package/dist/skills/fluentcart-developer/references/database/schema.md +1002 -1002
  78. package/dist/skills/fluentcart-developer/references/engineering/adding-custom-pages-to-the-customer-dashboard.md +395 -395
  79. package/dist/skills/fluentcart-developer/references/engineering/index.md +4 -4
  80. package/dist/skills/fluentcart-developer/references/engineering.md +4 -4
  81. package/dist/skills/fluentcart-developer/references/getting-started.md +249 -249
  82. package/dist/skills/fluentcart-developer/references/guides/frontend.md +519 -519
  83. package/dist/skills/fluentcart-developer/references/guides/index.md +107 -107
  84. package/dist/skills/fluentcart-developer/references/guides/integrations.md +600 -600
  85. package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/index.md +237 -237
  86. package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/labels-and-tracking.md +481 -481
  87. package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/live-rates.md +269 -269
  88. package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/reference.md +223 -223
  89. package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/settings.md +370 -370
  90. package/dist/skills/fluentcart-developer/references/guides/shipping-carrier.md +237 -237
  91. package/dist/skills/fluentcart-developer/references/guides/subscriptions.md +217 -217
  92. package/dist/skills/fluentcart-developer/references/hooks/actions/admin-and-templates.md +1079 -1079
  93. package/dist/skills/fluentcart-developer/references/hooks/actions/cart-and-checkout.md +1795 -1795
  94. package/dist/skills/fluentcart-developer/references/hooks/actions/customers-and-users.md +327 -327
  95. package/dist/skills/fluentcart-developer/references/hooks/actions/licenses.md +829 -829
  96. package/dist/skills/fluentcart-developer/references/hooks/actions/modules.md +81 -81
  97. package/dist/skills/fluentcart-developer/references/hooks/actions/orders.md +757 -757
  98. package/dist/skills/fluentcart-developer/references/hooks/actions/payments-and-integrations.md +1163 -1163
  99. package/dist/skills/fluentcart-developer/references/hooks/actions/pro-modules.md +219 -219
  100. package/dist/skills/fluentcart-developer/references/hooks/actions/products-and-coupons.md +1019 -1019
  101. package/dist/skills/fluentcart-developer/references/hooks/actions/subscriptions.md +1290 -1290
  102. package/dist/skills/fluentcart-developer/references/hooks/actions.md +16 -16
  103. package/dist/skills/fluentcart-developer/references/hooks/deprecated.md +60 -60
  104. package/dist/skills/fluentcart-developer/references/hooks/filters/cart-and-checkout.md +2032 -2032
  105. package/dist/skills/fluentcart-developer/references/hooks/filters/customers-and-subscriptions.md +1746 -1746
  106. package/dist/skills/fluentcart-developer/references/hooks/filters/integrations-and-advanced.md +2439 -2439
  107. package/dist/skills/fluentcart-developer/references/hooks/filters/modules.md +464 -464
  108. package/dist/skills/fluentcart-developer/references/hooks/filters/orders-and-payments.md +2658 -2658
  109. package/dist/skills/fluentcart-developer/references/hooks/filters/pro-modules.md +502 -502
  110. package/dist/skills/fluentcart-developer/references/hooks/filters/products-and-pricing.md +1785 -1785
  111. package/dist/skills/fluentcart-developer/references/hooks/filters/settings-and-configuration.md +2966 -2966
  112. package/dist/skills/fluentcart-developer/references/hooks/filters.md +14 -14
  113. package/dist/skills/fluentcart-developer/references/hooks/index.md +35 -35
  114. package/dist/skills/fluentcart-developer/references/index.md +625 -625
  115. package/dist/skills/fluentcart-developer/references/modules/fee-system.md +427 -427
  116. package/dist/skills/fluentcart-developer/references/modules/ghost-product-selling.md +440 -440
  117. package/dist/skills/fluentcart-developer/references/modules/index.md +484 -484
  118. package/dist/skills/fluentcart-developer/references/modules/licensing.md +342 -342
  119. package/dist/skills/fluentcart-developer/references/modules/order-bump.md +433 -433
  120. package/dist/skills/fluentcart-developer/references/modules/payment-methods.md +129 -129
  121. package/dist/skills/fluentcart-developer/references/modules/refunds.md +170 -170
  122. package/dist/skills/fluentcart-developer/references/modules/shipping.md +846 -846
  123. package/dist/skills/fluentcart-developer/references/modules/storage.md +986 -986
  124. package/dist/skills/fluentcart-developer/references/modules/subscription-vendor-ids.md +186 -186
  125. package/dist/skills/fluentcart-developer/references/modules/subscriptions.md +678 -678
  126. package/dist/skills/fluentcart-developer/references/payment-methods-integration/index.md +164 -164
  127. package/dist/skills/fluentcart-developer/references/payment-methods-integration/paddle-example.md +1648 -1648
  128. package/dist/skills/fluentcart-developer/references/payment-methods-integration/payment/setting/fields.md +353 -353
  129. package/dist/skills/fluentcart-developer/references/payment-methods-integration/quick-implementation.md +1079 -1079
  130. package/dist/skills/fluentcart-developer/references/payment-methods-integration.md +164 -164
  131. package/dist/skills/fluentcart-developer/references/restapi/checkout.md +573 -573
  132. package/dist/skills/fluentcart-developer/references/restapi/coupons.md +958 -958
  133. package/dist/skills/fluentcart-developer/references/restapi/customer-profile.md +1423 -1423
  134. package/dist/skills/fluentcart-developer/references/restapi/customers.md +1103 -1103
  135. package/dist/skills/fluentcart-developer/references/restapi/dashboard.md +1083 -1083
  136. package/dist/skills/fluentcart-developer/references/restapi/data-export.md +132 -132
  137. package/dist/skills/fluentcart-developer/references/restapi/email-notifications.md +846 -846
  138. package/dist/skills/fluentcart-developer/references/restapi/files.md +313 -313
  139. package/dist/skills/fluentcart-developer/references/restapi/index.md +127 -127
  140. package/dist/skills/fluentcart-developer/references/restapi/integrations.md +1000 -1000
  141. package/dist/skills/fluentcart-developer/references/restapi/inventory.md +192 -192
  142. package/dist/skills/fluentcart-developer/references/restapi/labels-and-attributes.md +797 -797
  143. package/dist/skills/fluentcart-developer/references/restapi/licensing.md +1733 -1733
  144. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-available-shipping-methods.md +30 -30
  145. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-checkout-summary.md +28 -28
  146. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-country-info.md +29 -29
  147. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-order-info.md +28 -28
  148. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-shipping-methods-list-view.md +30 -30
  149. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/login.md +66 -66
  150. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/place-order.md +179 -179
  151. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/apply-coupon.md +83 -83
  152. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/cancel-coupon.md +87 -87
  153. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/check-product-eligibility.md +59 -59
  154. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/create-coupon.md +230 -230
  155. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/delete-coupon.md +29 -29
  156. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/get-coupon-settings.md +20 -20
  157. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/get-coupon.md +27 -27
  158. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/list-coupon-codes.md +20 -20
  159. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/list-coupons.md +37 -37
  160. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/re-apply-coupons.md +75 -75
  161. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/store-coupon-settings.md +40 -40
  162. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/update-coupon.md +133 -133
  163. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/create-address-checkout.md +138 -138
  164. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/create-profile-address.md +119 -119
  165. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/dashboard-overview.md +22 -22
  166. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/delete-profile-address.md +46 -46
  167. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-order-details.md +30 -30
  168. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-portal-sections.md +29 -29
  169. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-profile-details.md +22 -22
  170. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-transaction-billing-address.md +30 -30
  171. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-upgrade-paths.md +31 -31
  172. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/list-downloads.md +29 -29
  173. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/list-orders.md +28 -28
  174. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/make-profile-address-primary.md +55 -55
  175. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/pause-subscription.md +29 -29
  176. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/resume-subscription.md +29 -29
  177. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/save-transaction-billing-address.md +92 -92
  178. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/select-address-for-checkout.md +32 -32
  179. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/update-profile-address.md +115 -115
  180. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/update-profile-details.md +69 -69
  181. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/attach-user.md +50 -50
  182. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/bulk-actions.md +65 -65
  183. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/create-address.md +135 -135
  184. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/create-customer.md +108 -108
  185. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/delete-address.md +62 -62
  186. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/detach-user.md +28 -28
  187. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/find-customer-order.md +27 -27
  188. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-attachable-users.md +20 -20
  189. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer-addresses.md +28 -28
  190. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer-orders.md +37 -37
  191. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer-stats.md +27 -27
  192. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer.md +32 -32
  193. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/list-customers.md +37 -37
  194. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/recalculate-ltv.md +28 -28
  195. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/set-primary-address.md +72 -72
  196. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/update-additional-info.md +55 -55
  197. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/update-address.md +144 -144
  198. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/update-customer.md +123 -123
  199. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/attach-note-to-order.md +49 -49
  200. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/create-all-pages.md +21 -21
  201. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/create-single-page.md +55 -55
  202. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/delete-activity.md +28 -28
  203. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-country-info.md +29 -29
  204. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-dashboard-stats.md +22 -22
  205. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-filter-options.md +31 -31
  206. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-onboarding-data.md +20 -20
  207. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-onboarding-settings.md +20 -20
  208. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-print-templates.md +20 -20
  209. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-search-options.md +27 -27
  210. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-widgets.md +28 -28
  211. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/initialize-app.md +20 -20
  212. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/list-activities.md +33 -33
  213. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/list-attachments.md +21 -21
  214. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/list-countries.md +20 -20
  215. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/mark-activity-read.md +53 -53
  216. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/run-data-backfills.md +21 -21
  217. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/save-onboarding-settings.md +54 -54
  218. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/save-onboarding-tax-settings.md +73 -73
  219. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/save-print-templates.md +64 -64
  220. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/upload-attachment.md +42 -42
  221. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-customers-batch.md +129 -129
  222. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-licenses-batch.md +133 -133
  223. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-orders-batch.md +129 -129
  224. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-subscriptions-batch.md +129 -129
  225. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-customers-export-schema.md +21 -21
  226. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-licenses-export-schema.md +26 -26
  227. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-orders-export-schema.md +21 -21
  228. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-subscriptions-export-schema.md +21 -21
  229. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/enable-notification.md +57 -57
  230. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-digest-settings.md +22 -22
  231. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-notification.md +30 -30
  232. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-reminders.md +22 -22
  233. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-settings.md +22 -22
  234. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-shortcodes.md +22 -22
  235. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/list-notifications.md +20 -20
  236. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/preview-default-template.md +66 -66
  237. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/preview-notification.md +50 -50
  238. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/save-digest-settings.md +101 -101
  239. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/save-reminders.md +162 -162
  240. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/save-settings.md +99 -99
  241. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/send-digest-test.md +47 -47
  242. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/send-manual-reminder.md +51 -51
  243. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/update-notification.md +93 -93
  244. package/dist/skills/fluentcart-developer/references/restapi/operations/files/delete-file.md +31 -31
  245. package/dist/skills/fluentcart-developer/references/restapi/operations/files/get-bucket-list.md +28 -28
  246. package/dist/skills/fluentcart-developer/references/restapi/operations/files/list-files.md +30 -30
  247. package/dist/skills/fluentcart-developer/references/restapi/operations/files/upload-editor-file.md +32 -32
  248. package/dist/skills/fluentcart-developer/references/restapi/operations/files/upload-file.md +34 -34
  249. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/chained-data-request.md +46 -46
  250. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/change-feed-status.md +51 -51
  251. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/delete-feed.md +27 -27
  252. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-dynamic-options.md +29 -29
  253. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-feed-lists.md +27 -27
  254. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-feed-settings.md +27 -27
  255. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-global-feeds.md +20 -20
  256. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-global-settings.md +26 -26
  257. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/install-addon-plugin.md +49 -49
  258. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/list-addons.md +20 -20
  259. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/save-feed-settings.md +52 -52
  260. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/set-global-settings.md +50 -50
  261. package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/bulk-update-stock.md +94 -94
  262. package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/export-inventory.md +81 -81
  263. package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/get-adjustment-history.md +26 -26
  264. package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/get-inventory-stats.md +21 -21
  265. package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/list-inventory.md +33 -33
  266. package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/update-stock.md +75 -75
  267. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/create-attribute-group.md +31 -31
  268. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/create-label.md +31 -31
  269. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/create-terms.md +90 -90
  270. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/delete-attribute-group.md +28 -28
  271. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/delete-attribute-term.md +29 -29
  272. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/get-attribute-group.md +28 -28
  273. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/get-attribute-library.md +20 -20
  274. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/list-attribute-groups.md +32 -32
  275. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/list-attribute-terms.md +33 -33
  276. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/list-labels.md +20 -20
  277. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/reorder-groups.md +51 -51
  278. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/reorder-terms.md +56 -56
  279. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/update-attribute-group.md +37 -37
  280. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/update-attribute-term.md +39 -39
  281. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/update-label-selections.md +32 -32
  282. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/activate-plugin-license.md +41 -41
  283. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/activate-site-admin.md +60 -60
  284. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/deactivate-plugin-license.md +18 -18
  285. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/deactivate-site-admin.md +67 -67
  286. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/deactivate-site-customer.md +47 -47
  287. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/delete-license.md +24 -24
  288. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/extend-license-validity.md +47 -47
  289. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-customer-license-details.md +25 -25
  290. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-customer-licenses-admin.md +26 -26
  291. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-license-activations.md +25 -25
  292. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-license-details.md +25 -25
  293. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-license-site.md +30 -30
  294. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-plugin-license-status.md +18 -18
  295. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-product-license-settings.md +24 -24
  296. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/list-customer-licenses.md +25 -25
  297. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/list-license-sites.md +33 -33
  298. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/list-licenses.md +38 -38
  299. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-activate-license.md +54 -54
  300. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-check-license.md +26 -26
  301. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-deactivate-license.md +46 -46
  302. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-download-license-package.md +23 -23
  303. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-get-license-version.md +26 -26
  304. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/regenerate-license-key.md +24 -24
  305. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/save-product-license-settings.md +193 -193
  306. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/update-license-activation-limit.md +53 -53
  307. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/update-license-status.md +52 -52
  308. package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/create-order-bump.md +47 -47
  309. package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/delete-order-bump.md +25 -25
  310. package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/get-order-bump.md +25 -25
  311. package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/list-order-bumps.md +29 -29
  312. package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/update-order-bump.md +141 -141
  313. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/accept-dispute.md +47 -47
  314. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/bulk-actions.md +72 -72
  315. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/calculate-shipping.md +67 -67
  316. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/calculate-tax.md +98 -98
  317. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/change-customer.md +50 -50
  318. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/charge-now.md +29 -29
  319. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-and-change-customer.md +92 -92
  320. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-custom-order-item.md +68 -68
  321. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-order.md +351 -351
  322. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-renewal-now.md +29 -29
  323. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/delete-order.md +28 -28
  324. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/generate-missing-licenses.md +29 -29
  325. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-order-transactions.md +27 -27
  326. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-order.md +27 -27
  327. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-renewal.md +28 -28
  328. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-shipping-methods.md +28 -28
  329. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-single-transaction.md +28 -28
  330. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/list-order-currencies.md +22 -22
  331. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/list-orders.md +42 -42
  332. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/list-renewals.md +28 -28
  333. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/mark-as-paid.md +61 -61
  334. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/price-order.md +135 -135
  335. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/refund-order.md +72 -72
  336. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/resend-renewal-invoice.md +29 -29
  337. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/skip-renewal.md +48 -48
  338. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/sync-order-statuses.md +28 -28
  339. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/sync-pending-transaction.md +29 -29
  340. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-order-address-id.md +60 -60
  341. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-order-address.md +98 -98
  342. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-order.md +172 -172
  343. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-statuses.md +77 -77
  344. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-subscription-details.md +84 -84
  345. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-transaction-status.md +51 -51
  346. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/void-renewal.md +30 -30
  347. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/create-pdf-template.md +42 -42
  348. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/delete-pdf-template.md +26 -26
  349. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/download-pdf-preview.md +44 -44
  350. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-factory-default-templates.md +19 -19
  351. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-pdf-status.md +21 -21
  352. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-pdf-template.md +26 -26
  353. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-saved-templates.md +21 -21
  354. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-seller-details.md +19 -19
  355. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/list-pdf-templates.md +19 -19
  356. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/save-pdf-template.md +53 -53
  357. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/save-seller-details.md +97 -97
  358. package/dist/skills/fluentcart-developer/references/restapi/operations/products/add-product-terms.md +64 -64
  359. package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-edit-fetch.md +30 -30
  360. package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-insert-products.md +62 -62
  361. package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-update-products.md +59 -59
  362. package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-update-variants.md +83 -83
  363. package/dist/skills/fluentcart-developer/references/restapi/operations/products/change-integration-status.md +64 -64
  364. package/dist/skills/fluentcart-developer/references/restapi/operations/products/create-dummy-products.md +45 -45
  365. package/dist/skills/fluentcart-developer/references/restapi/operations/products/create-product.md +81 -81
  366. package/dist/skills/fluentcart-developer/references/restapi/operations/products/create-variation.md +181 -181
  367. package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-downloadable-file.md +27 -27
  368. package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-product-integration.md +30 -30
  369. package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-product.md +27 -27
  370. package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-taxonomy-term.md +55 -55
  371. package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-upgrade-path.md +27 -27
  372. package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-variation.md +27 -27
  373. package/dist/skills/fluentcart-developer/references/restapi/operations/products/do-bulk-action.md +56 -56
  374. package/dist/skills/fluentcart-developer/references/restapi/operations/products/duplicate-product.md +56 -56
  375. package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-products-by-ids.md +26 -26
  376. package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-taxonomy-terms.md +20 -20
  377. package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-terms-by-parent.md +60 -60
  378. package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-variations-by-ids.md +26 -26
  379. package/dist/skills/fluentcart-developer/references/restapi/operations/products/find-subscription-variants.md +26 -26
  380. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-bundle-info.md +27 -27
  381. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-downloadable-url.md +27 -27
  382. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-max-excerpt-word-count.md +20 -20
  383. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-pricing-widgets.md +27 -27
  384. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product-integration-feeds.md +29 -29
  385. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product-integration-settings.md +31 -31
  386. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product-pricing.md +28 -28
  387. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product.md +28 -28
  388. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-related-products.md +31 -31
  389. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-upgrade-settings.md +27 -27
  390. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-variation-upgrade-paths.md +28 -28
  391. package/dist/skills/fluentcart-developer/references/restapi/operations/products/group-bulk-update-variants.md +103 -103
  392. package/dist/skills/fluentcart-developer/references/restapi/operations/products/list-all-variants.md +26 -26
  393. package/dist/skills/fluentcart-developer/references/restapi/operations/products/list-product-variations.md +26 -26
  394. package/dist/skills/fluentcart-developer/references/restapi/operations/products/list-products.md +34 -34
  395. package/dist/skills/fluentcart-developer/references/restapi/operations/products/remove-shipping-class.md +27 -27
  396. package/dist/skills/fluentcart-developer/references/restapi/operations/products/remove-tax-class.md +27 -27
  397. package/dist/skills/fluentcart-developer/references/restapi/operations/products/save-bundle-info.md +56 -56
  398. package/dist/skills/fluentcart-developer/references/restapi/operations/products/save-product-integration.md +62 -62
  399. package/dist/skills/fluentcart-developer/references/restapi/operations/products/save-upgrade-path.md +78 -78
  400. package/dist/skills/fluentcart-developer/references/restapi/operations/products/search-product-variant-options.md +29 -29
  401. package/dist/skills/fluentcart-developer/references/restapi/operations/products/search-products-by-name.md +28 -28
  402. package/dist/skills/fluentcart-developer/references/restapi/operations/products/search-variants-by-name.md +28 -28
  403. package/dist/skills/fluentcart-developer/references/restapi/operations/products/set-variation-media.md +74 -74
  404. package/dist/skills/fluentcart-developer/references/restapi/operations/products/suggest-sku.md +28 -28
  405. package/dist/skills/fluentcart-developer/references/restapi/operations/products/sync-downloadable-files.md +134 -134
  406. package/dist/skills/fluentcart-developer/references/restapi/operations/products/sync-taxonomy-terms.md +61 -61
  407. package/dist/skills/fluentcart-developer/references/restapi/operations/products/toggle-product-tax-exemption.md +56 -56
  408. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-downloadable-file.md +98 -98
  409. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-inventory.md +56 -56
  410. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-long-desc-editor-mode.md +49 -49
  411. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-manage-stock.md +53 -53
  412. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-product-detail.md +58 -58
  413. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-product-pricing.md +225 -225
  414. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-shipping-class.md +49 -49
  415. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-tax-class.md +49 -49
  416. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-upgrade-path.md +78 -78
  417. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variant-option.md +79 -79
  418. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variant-tax-exemption.md +56 -56
  419. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variation-pricing-table.md +49 -49
  420. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variation.md +105 -105
  421. package/dist/skills/fluentcart-developer/references/restapi/operations/public-shop/get-product-views.md +34 -34
  422. package/dist/skills/fluentcart-developer/references/restapi/operations/public-shop/list-products.md +42 -42
  423. package/dist/skills/fluentcart-developer/references/restapi/operations/public-shop/search-products.md +30 -30
  424. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/channel-rules.md +24 -24
  425. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/country-heat-map.md +22 -22
  426. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/coupon-overview.md +37 -37
  427. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/coupons.md +36 -36
  428. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-insights.md +31 -31
  429. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-overview.md +36 -36
  430. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-repeat.md +35 -35
  431. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-segment-customers.md +36 -36
  432. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-segments.md +30 -30
  433. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-value.md +34 -34
  434. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/dashboard-stats.md +30 -30
  435. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/failed-orders.md +34 -34
  436. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-new-vs-returning-customer.md +34 -34
  437. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-report-by-day-and-hour.md +34 -34
  438. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-report-meta.md +29 -29
  439. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-top-sold-products.md +34 -34
  440. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/future-renewals.md +31 -31
  441. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/generate-retention-snapshots.md +24 -24
  442. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-overview.md +30 -30
  443. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-recent-activities.md +26 -26
  444. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-recent-orders.md +20 -20
  445. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-revenue.md +37 -37
  446. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/installments-at-risk.md +35 -35
  447. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/installments-variations.md +33 -33
  448. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/installments.md +33 -33
  449. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/item-count-distribution.md +34 -34
  450. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/license-chart.md +30 -30
  451. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/license-pie-chart.md +22 -22
  452. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/license-summary.md +22 -22
  453. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/locations.md +43 -43
  454. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-chart.md +37 -37
  455. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-completion-time.md +34 -34
  456. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-mix.md +34 -34
  457. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-value-distribution.md +34 -34
  458. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/payment-methods-disputes.md +38 -38
  459. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/payment-methods-methods.md +36 -36
  460. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/payment-methods.md +37 -37
  461. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-comparison-launch.md +33 -33
  462. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-comparison.md +40 -40
  463. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-detail.md +37 -37
  464. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-sales.md +37 -37
  465. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/refunds-overview.md +37 -37
  466. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/retention-snapshots-step.md +45 -45
  467. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/sales-growth-chart.md +35 -35
  468. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/save-channel-rules.md +73 -73
  469. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/source-channels.md +37 -37
  470. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/sources.md +49 -49
  471. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-cohorts.md +33 -33
  472. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-health.md +30 -30
  473. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-rebuys.md +37 -37
  474. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-retention.md +34 -34
  475. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-variations.md +22 -22
  476. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscriptions-overview.md +37 -37
  477. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/weeks-between-refund.md +34 -34
  478. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/assign-role.md +48 -48
  479. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/delete-role-assignment.md +47 -47
  480. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/get-role.md +25 -25
  481. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/list-managers.md +18 -18
  482. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/list-roles.md +18 -18
  483. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/search-users.md +25 -25
  484. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/update-role.md +43 -43
  485. package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/create-saved-view.md +106 -106
  486. package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/delete-saved-view.md +26 -26
  487. package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/list-saved-views.md +25 -25
  488. package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/update-saved-view.md +83 -83
  489. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/activate-payment-addon.md +44 -44
  490. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/activate-plugin-addon.md +44 -44
  491. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/change-storage-driver-status.md +56 -56
  492. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/check-paypal-webhook.md +26 -26
  493. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/create-storage-bucket.md +63 -63
  494. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/disconnect-payment-method.md +55 -55
  495. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/exchange-paypal-seller-auth-token.md +62 -62
  496. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-active-storage-drivers.md +20 -20
  497. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-checkout-fields.md +22 -22
  498. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-email-shortcodes.md +20 -20
  499. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-mcp-config-snippets.md +26 -26
  500. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-mcp-status.md +20 -20
  501. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-module-settings.md +20 -20
  502. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-payment-method-connection-info.md +26 -26
  503. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-payment-method-settings.md +26 -26
  504. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-permissions.md +22 -22
  505. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-plugin-addons.md +20 -20
  506. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-storage-driver-settings.md +27 -27
  507. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-store-settings.md +26 -26
  508. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/install-mcp-adapter.md +21 -21
  509. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/install-payment-addon.md +60 -60
  510. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/install-plugin-addon.md +64 -64
  511. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/list-all-payment-methods.md +20 -20
  512. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/list-all-storage-drivers.md +20 -20
  513. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/list-storage-buckets.md +67 -67
  514. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/reorder-payment-methods.md +55 -55
  515. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/reset-storage-driver-settings.md +45 -45
  516. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-checkout-fields.md +133 -133
  517. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-confirmation-settings.md +68 -68
  518. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-module-settings.md +68 -68
  519. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-payment-method-design.md +67 -67
  520. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-payment-method-settings.md +58 -58
  521. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-permissions.md +68 -68
  522. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-storage-driver-settings.md +62 -62
  523. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-store-settings.md +239 -239
  524. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/setup-paypal-webhook.md +48 -48
  525. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/toggle-mcp.md +40 -40
  526. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/verify-storage-driver-connection.md +62 -62
  527. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/verify-turnstile-keys.md +55 -55
  528. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/create-shipping-class.md +73 -73
  529. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/create-shipping-method.md +110 -110
  530. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/create-shipping-zone.md +56 -56
  531. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/delete-shipping-class.md +29 -29
  532. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/delete-shipping-method.md +29 -29
  533. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/delete-shipping-zone.md +29 -29
  534. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-class-profile.md +30 -30
  535. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-class.md +29 -29
  536. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-packages.md +22 -22
  537. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-zone.md +27 -27
  538. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-zone-countries.md +22 -22
  539. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-zone-states.md +28 -28
  540. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/list-shipping-classes.md +31 -31
  541. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/list-shipping-zones.md +31 -31
  542. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/save-shipping-packages.md +112 -112
  543. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-shipping-class.md +79 -79
  544. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-shipping-method.md +113 -113
  545. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-shipping-zone.md +62 -62
  546. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-zone-order.md +52 -52
  547. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/cancel-auto-renew.md +30 -30
  548. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/cancel-subscription.md +52 -52
  549. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/confirm-subscription-switch.md +70 -70
  550. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/fetch-subscription-remote.md +28 -28
  551. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/generate-early-payment-link.md +29 -29
  552. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-customer-subscription.md +27 -27
  553. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-or-create-plan.md +69 -69
  554. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-setup-intent-attempts.md +30 -30
  555. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-subscription.md +28 -28
  556. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/initiate-early-payment.md +31 -31
  557. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/list-customer-subscriptions.md +27 -27
  558. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/list-subscriptions.md +39 -39
  559. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/pause-subscription.md +28 -28
  560. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/reactivate-subscription.md +28 -28
  561. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/resume-subscription.md +28 -28
  562. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/switch-payment-method.md +70 -70
  563. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/update-payment-method.md +69 -69
  564. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/update-vendor-ids.md +56 -56
  565. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/verify-vendor-ids.md +56 -56
  566. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/create-tax-class.md +51 -51
  567. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/create-tax-rate.md +117 -117
  568. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-product-override.md +27 -27
  569. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-shipping-tax-override.md +27 -27
  570. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-tax-class.md +28 -28
  571. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-tax-rate.md +27 -27
  572. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-country-tax-id.md +27 -27
  573. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-country-tax-rates.md +28 -28
  574. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-eu-vat-product-overrides.md +20 -20
  575. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-oss-country-rates.md +20 -20
  576. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-preconfigured-tax-rates.md +20 -20
  577. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-product-overrides.md +27 -27
  578. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-tax-settings.md +20 -20
  579. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/list-all-tax-rates.md +20 -20
  580. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/list-tax-classes.md +20 -20
  581. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/list-tax-records.md +37 -37
  582. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/mark-taxes-as-filed.md +58 -58
  583. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/reset-eu-vat-rates.md +21 -21
  584. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-configured-countries.md +57 -57
  585. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-country-tax-id.md +50 -50
  586. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-eu-vat-cross-border-settings.md +127 -127
  587. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-oss-country-rates.md +100 -100
  588. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-product-override.md +110 -110
  589. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-shipping-tax-override.md +52 -52
  590. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-tax-settings.md +166 -166
  591. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/update-country-status.md +54 -54
  592. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/update-tax-rate.md +116 -116
  593. package/dist/skills/fluentcart-developer/references/restapi/order-bumps.md +433 -433
  594. package/dist/skills/fluentcart-developer/references/restapi/orders.md +1212 -1212
  595. package/dist/skills/fluentcart-developer/references/restapi/pdf-templates.md +212 -212
  596. package/dist/skills/fluentcart-developer/references/restapi/products.md +2485 -2485
  597. package/dist/skills/fluentcart-developer/references/restapi/public-shop.md +191 -191
  598. package/dist/skills/fluentcart-developer/references/restapi/reports.md +3773 -3773
  599. package/dist/skills/fluentcart-developer/references/restapi/roles.md +403 -403
  600. package/dist/skills/fluentcart-developer/references/restapi/saved-views.md +136 -136
  601. package/dist/skills/fluentcart-developer/references/restapi/settings.md +1423 -1423
  602. package/dist/skills/fluentcart-developer/references/restapi/shipping.md +905 -905
  603. package/dist/skills/fluentcart-developer/references/restapi/subscriptions.md +1169 -1169
  604. package/dist/skills/fluentcart-developer/references/restapi/tax.md +1551 -1551
  605. package/dist/skills/fluentcart-developer/references/restapi.md +127 -127
  606. package/dist/skills/fluentcart-developer/scripts/cli.js +1 -1
  607. package/dist/version.d.ts +1 -1
  608. package/dist/version.js +1 -1
  609. package/package.json +66 -65
@@ -1,1212 +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
- ## 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
- ```
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
+ ```