fluentcart-developer 2.3.3 → 3.0.0

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 (655) hide show
  1. package/dist/cards/fluentcart/tools.d.ts.map +1 -1
  2. package/dist/cards/fluentcart/tools.js +2368 -2323
  3. package/dist/cards/fluentcart/tools.js.map +1 -1
  4. package/dist/paths.d.ts +1 -1
  5. package/dist/paths.d.ts.map +1 -1
  6. package/dist/paths.js +1 -1
  7. package/dist/paths.js.map +1 -1
  8. package/dist/reference-reader.d.ts +32 -1
  9. package/dist/reference-reader.d.ts.map +1 -1
  10. package/dist/reference-reader.js +111 -22
  11. package/dist/reference-reader.js.map +1 -1
  12. package/dist/server.d.ts.map +1 -1
  13. package/dist/server.js +8 -1
  14. package/dist/server.js.map +1 -1
  15. package/dist/skills/fluentcart-developer/SKILL.md +66 -538
  16. package/dist/skills/fluentcart-developer/references/api/authentication.md +452 -0
  17. package/dist/skills/fluentcart-developer/references/api/coupons.md +786 -0
  18. package/dist/skills/fluentcart-developer/references/api/customers.md +889 -0
  19. package/dist/skills/fluentcart-developer/references/api/files.md +609 -0
  20. package/dist/skills/fluentcart-developer/references/api/index.md +432 -0
  21. package/dist/skills/fluentcart-developer/references/api/licensing.md +633 -0
  22. package/dist/skills/fluentcart-developer/references/api/order-bump.md +384 -0
  23. package/dist/skills/fluentcart-developer/references/api/orders.md +814 -0
  24. package/dist/skills/fluentcart-developer/references/api/products.md +866 -0
  25. package/dist/skills/fluentcart-developer/references/api/roles-permissions.md +536 -0
  26. package/dist/skills/fluentcart-developer/references/api/subscriptions.md +827 -0
  27. package/dist/skills/fluentcart-developer/references/database/index.md +44 -0
  28. package/dist/skills/fluentcart-developer/references/database/models/activity.md +178 -0
  29. package/dist/skills/fluentcart-developer/references/database/models/applied-coupon.md +291 -0
  30. package/dist/skills/fluentcart-developer/references/database/models/attribute-group.md +239 -0
  31. package/dist/skills/fluentcart-developer/references/database/models/attribute-relation.md +181 -0
  32. package/dist/skills/fluentcart-developer/references/database/models/attribute-term.md +219 -0
  33. package/dist/skills/fluentcart-developer/references/database/models/cart.md +645 -0
  34. package/dist/skills/fluentcart-developer/references/database/models/coupon.md +427 -0
  35. package/dist/skills/fluentcart-developer/references/database/models/customer-addresses.md +348 -0
  36. package/dist/skills/fluentcart-developer/references/database/models/customer-meta.md +156 -0
  37. package/dist/skills/fluentcart-developer/references/database/models/customer.md +584 -0
  38. package/dist/skills/fluentcart-developer/references/database/models/dynamic-model.md +163 -0
  39. package/dist/skills/fluentcart-developer/references/database/models/label-relationship.md +155 -0
  40. package/dist/skills/fluentcart-developer/references/database/models/label.md +153 -0
  41. package/dist/skills/fluentcart-developer/references/database/models/license-activation.md +182 -0
  42. package/dist/skills/fluentcart-developer/references/database/models/license-meta.md +163 -0
  43. package/dist/skills/fluentcart-developer/references/database/models/license-site.md +208 -0
  44. package/dist/skills/fluentcart-developer/references/database/models/license.md +640 -0
  45. package/dist/skills/fluentcart-developer/references/database/models/meta.md +233 -0
  46. package/dist/skills/fluentcart-developer/references/database/models/order-address.md +391 -0
  47. package/dist/skills/fluentcart-developer/references/database/models/order-download-permission.md +144 -0
  48. package/dist/skills/fluentcart-developer/references/database/models/order-item.md +383 -0
  49. package/dist/skills/fluentcart-developer/references/database/models/order-meta.md +303 -0
  50. package/dist/skills/fluentcart-developer/references/database/models/order-operation.md +158 -0
  51. package/dist/skills/fluentcart-developer/references/database/models/order-promotion-stat.md +175 -0
  52. package/dist/skills/fluentcart-developer/references/database/models/order-promotion.md +250 -0
  53. package/dist/skills/fluentcart-developer/references/database/models/order-tax-rate.md +172 -0
  54. package/dist/skills/fluentcart-developer/references/database/models/order-transaction.md +440 -0
  55. package/dist/skills/fluentcart-developer/references/database/models/order.md +727 -0
  56. package/dist/skills/fluentcart-developer/references/database/models/product-detail.md +397 -0
  57. package/dist/skills/fluentcart-developer/references/database/models/product-download.md +258 -0
  58. package/dist/skills/fluentcart-developer/references/database/models/product-meta.md +153 -0
  59. package/dist/skills/fluentcart-developer/references/database/models/product-variation.md +556 -0
  60. package/dist/skills/fluentcart-developer/references/database/models/product.md +580 -0
  61. package/dist/skills/fluentcart-developer/references/database/models/relationships.md +427 -0
  62. package/dist/skills/fluentcart-developer/references/database/models/scheduled-action.md +175 -0
  63. package/dist/skills/fluentcart-developer/references/database/models/shipping-class.md +148 -0
  64. package/dist/skills/fluentcart-developer/references/database/models/shipping-method.md +280 -0
  65. package/dist/skills/fluentcart-developer/references/database/models/shipping-zone.md +205 -0
  66. package/dist/skills/fluentcart-developer/references/database/models/subscription-meta.md +173 -0
  67. package/dist/skills/fluentcart-developer/references/database/models/subscription.md +528 -0
  68. package/dist/skills/fluentcart-developer/references/database/models/tax-class.md +195 -0
  69. package/dist/skills/fluentcart-developer/references/database/models/tax-rate.md +225 -0
  70. package/dist/skills/fluentcart-developer/references/database/models/user-meta.md +166 -0
  71. package/dist/skills/fluentcart-developer/references/database/models/user.md +220 -0
  72. package/dist/skills/fluentcart-developer/references/database/models.md +404 -0
  73. package/dist/skills/fluentcart-developer/references/database/query-builder.md +860 -0
  74. package/dist/skills/fluentcart-developer/references/database/readme.md +276 -0
  75. package/dist/skills/fluentcart-developer/references/database/schema.md +1002 -0
  76. package/dist/skills/fluentcart-developer/references/engineering/adding-custom-pages-to-the-customer-dashboard.md +395 -0
  77. package/dist/skills/fluentcart-developer/references/engineering/index.md +4 -0
  78. package/dist/skills/fluentcart-developer/references/engineering.md +4 -0
  79. package/dist/skills/fluentcart-developer/references/getting-started.md +249 -0
  80. package/dist/skills/fluentcart-developer/references/guides/frontend.md +519 -0
  81. package/dist/skills/fluentcart-developer/references/guides/index.md +107 -0
  82. package/dist/skills/fluentcart-developer/references/guides/integrations.md +600 -0
  83. package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/index.md +237 -0
  84. package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/labels-and-tracking.md +481 -0
  85. package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/live-rates.md +269 -0
  86. package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/reference.md +223 -0
  87. package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/settings.md +370 -0
  88. package/dist/skills/fluentcart-developer/references/guides/shipping-carrier.md +237 -0
  89. package/dist/skills/fluentcart-developer/references/{subscription-customization.md → guides/subscriptions.md} +57 -37
  90. package/dist/skills/fluentcart-developer/references/hooks/actions/admin-and-templates.md +1079 -0
  91. package/dist/skills/fluentcart-developer/references/hooks/actions/cart-and-checkout.md +1795 -0
  92. package/dist/skills/fluentcart-developer/references/hooks/actions/customers-and-users.md +327 -0
  93. package/dist/skills/fluentcart-developer/references/hooks/actions/licenses.md +829 -0
  94. package/dist/skills/fluentcart-developer/references/hooks/actions/modules.md +81 -0
  95. package/dist/skills/fluentcart-developer/references/hooks/actions/orders.md +757 -0
  96. package/dist/skills/fluentcart-developer/references/hooks/actions/payments-and-integrations.md +1163 -0
  97. package/dist/skills/fluentcart-developer/references/hooks/actions/pro-modules.md +219 -0
  98. package/dist/skills/fluentcart-developer/references/hooks/actions/products-and-coupons.md +1019 -0
  99. package/dist/skills/fluentcart-developer/references/hooks/actions/subscriptions.md +1290 -0
  100. package/dist/skills/fluentcart-developer/references/hooks/actions.md +16 -0
  101. package/dist/skills/fluentcart-developer/references/hooks/deprecated.md +60 -0
  102. package/dist/skills/fluentcart-developer/references/hooks/filters/cart-and-checkout.md +2032 -0
  103. package/dist/skills/fluentcart-developer/references/hooks/filters/customers-and-subscriptions.md +1746 -0
  104. package/dist/skills/fluentcart-developer/references/hooks/filters/integrations-and-advanced.md +2439 -0
  105. package/dist/skills/fluentcart-developer/references/hooks/filters/modules.md +464 -0
  106. package/dist/skills/fluentcart-developer/references/hooks/filters/orders-and-payments.md +2658 -0
  107. package/dist/skills/fluentcart-developer/references/hooks/filters/pro-modules.md +502 -0
  108. package/dist/skills/fluentcart-developer/references/hooks/filters/products-and-pricing.md +1785 -0
  109. package/dist/skills/fluentcart-developer/references/hooks/filters/settings-and-configuration.md +2966 -0
  110. package/dist/skills/fluentcart-developer/references/hooks/filters.md +14 -0
  111. package/dist/skills/fluentcart-developer/references/hooks/index.md +35 -0
  112. package/dist/skills/fluentcart-developer/references/index.md +625 -0
  113. package/dist/skills/fluentcart-developer/references/{fee-system-guide.md → modules/fee-system.md} +38 -60
  114. package/dist/skills/fluentcart-developer/references/{ghost-product-selling.md → modules/ghost-product-selling.md} +71 -89
  115. package/dist/skills/fluentcart-developer/references/modules/index.md +484 -0
  116. package/dist/skills/fluentcart-developer/references/modules/licensing.md +342 -0
  117. package/dist/skills/fluentcart-developer/references/modules/order-bump.md +433 -0
  118. package/dist/skills/fluentcart-developer/references/modules/payment-methods.md +129 -0
  119. package/dist/skills/fluentcart-developer/references/modules/refunds.md +170 -0
  120. package/dist/skills/fluentcart-developer/references/modules/shipping.md +846 -0
  121. package/dist/skills/fluentcart-developer/references/modules/storage.md +986 -0
  122. package/dist/skills/fluentcart-developer/references/modules/subscription-vendor-ids.md +186 -0
  123. package/dist/skills/fluentcart-developer/references/modules/subscriptions.md +678 -0
  124. package/dist/skills/fluentcart-developer/references/payment-methods-integration/index.md +164 -0
  125. package/dist/skills/fluentcart-developer/references/payment-methods-integration/paddle-example.md +1648 -0
  126. package/dist/skills/fluentcart-developer/references/payment-methods-integration/payment/setting/fields.md +353 -0
  127. package/dist/skills/fluentcart-developer/references/payment-methods-integration/quick-implementation.md +1079 -0
  128. package/dist/skills/fluentcart-developer/references/payment-methods-integration.md +164 -0
  129. package/dist/skills/fluentcart-developer/references/restapi/checkout.md +573 -0
  130. package/dist/skills/fluentcart-developer/references/restapi/coupons.md +958 -0
  131. package/dist/skills/fluentcart-developer/references/restapi/customer-profile.md +1423 -0
  132. package/dist/skills/fluentcart-developer/references/{rest-api-customers.md → restapi/customers.md} +406 -424
  133. package/dist/skills/fluentcart-developer/references/restapi/dashboard.md +1083 -0
  134. package/dist/skills/fluentcart-developer/references/restapi/data-export.md +132 -0
  135. package/dist/skills/fluentcart-developer/references/restapi/email-notifications.md +846 -0
  136. package/dist/skills/fluentcart-developer/references/restapi/files.md +313 -0
  137. package/dist/skills/fluentcart-developer/references/restapi/index.md +127 -0
  138. package/dist/skills/fluentcart-developer/references/restapi/integrations.md +1000 -0
  139. package/dist/skills/fluentcart-developer/references/restapi/inventory.md +192 -0
  140. package/dist/skills/fluentcart-developer/references/restapi/labels-and-attributes.md +797 -0
  141. package/dist/skills/fluentcart-developer/references/restapi/licensing.md +1733 -0
  142. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-available-shipping-methods.md +30 -0
  143. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-checkout-summary.md +28 -0
  144. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-country-info.md +29 -0
  145. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-order-info.md +28 -0
  146. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-shipping-methods-list-view.md +30 -0
  147. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/login.md +66 -0
  148. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/place-order.md +179 -0
  149. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/apply-coupon.md +83 -0
  150. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/cancel-coupon.md +87 -0
  151. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/check-product-eligibility.md +59 -0
  152. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/create-coupon.md +230 -0
  153. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/delete-coupon.md +29 -0
  154. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/get-coupon-settings.md +20 -0
  155. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/get-coupon.md +27 -0
  156. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/list-coupon-codes.md +20 -0
  157. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/list-coupons.md +37 -0
  158. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/re-apply-coupons.md +75 -0
  159. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/store-coupon-settings.md +40 -0
  160. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/update-coupon.md +133 -0
  161. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/create-address-checkout.md +138 -0
  162. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/create-profile-address.md +119 -0
  163. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/dashboard-overview.md +22 -0
  164. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/delete-profile-address.md +46 -0
  165. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-order-details.md +30 -0
  166. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-portal-sections.md +29 -0
  167. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-profile-details.md +22 -0
  168. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-transaction-billing-address.md +30 -0
  169. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-upgrade-paths.md +31 -0
  170. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/list-downloads.md +29 -0
  171. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/list-orders.md +28 -0
  172. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/make-profile-address-primary.md +55 -0
  173. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/pause-subscription.md +29 -0
  174. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/resume-subscription.md +29 -0
  175. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/save-transaction-billing-address.md +92 -0
  176. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/select-address-for-checkout.md +32 -0
  177. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/update-profile-address.md +115 -0
  178. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/update-profile-details.md +69 -0
  179. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/attach-user.md +50 -0
  180. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/bulk-actions.md +65 -0
  181. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/create-address.md +135 -0
  182. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/create-customer.md +108 -0
  183. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/delete-address.md +62 -0
  184. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/detach-user.md +28 -0
  185. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/find-customer-order.md +27 -0
  186. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-attachable-users.md +20 -0
  187. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer-addresses.md +28 -0
  188. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer-orders.md +37 -0
  189. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer-stats.md +27 -0
  190. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer.md +32 -0
  191. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/list-customers.md +37 -0
  192. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/recalculate-ltv.md +28 -0
  193. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/set-primary-address.md +72 -0
  194. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/update-additional-info.md +55 -0
  195. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/update-address.md +144 -0
  196. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/update-customer.md +123 -0
  197. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/attach-note-to-order.md +49 -0
  198. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/create-all-pages.md +21 -0
  199. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/create-single-page.md +55 -0
  200. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/delete-activity.md +28 -0
  201. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-country-info.md +29 -0
  202. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-dashboard-stats.md +22 -0
  203. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-filter-options.md +31 -0
  204. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-onboarding-data.md +20 -0
  205. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-onboarding-settings.md +20 -0
  206. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-print-templates.md +20 -0
  207. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-search-options.md +27 -0
  208. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-widgets.md +28 -0
  209. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/initialize-app.md +20 -0
  210. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/list-activities.md +33 -0
  211. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/list-attachments.md +21 -0
  212. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/list-countries.md +20 -0
  213. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/mark-activity-read.md +53 -0
  214. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/run-data-backfills.md +21 -0
  215. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/save-onboarding-settings.md +54 -0
  216. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/save-onboarding-tax-settings.md +73 -0
  217. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/save-print-templates.md +64 -0
  218. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/upload-attachment.md +42 -0
  219. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-customers-batch.md +129 -0
  220. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-licenses-batch.md +133 -0
  221. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-orders-batch.md +129 -0
  222. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-subscriptions-batch.md +129 -0
  223. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-customers-export-schema.md +21 -0
  224. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-licenses-export-schema.md +26 -0
  225. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-orders-export-schema.md +21 -0
  226. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-subscriptions-export-schema.md +21 -0
  227. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/enable-notification.md +57 -0
  228. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-digest-settings.md +22 -0
  229. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-notification.md +30 -0
  230. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-reminders.md +22 -0
  231. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-settings.md +22 -0
  232. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-shortcodes.md +22 -0
  233. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/list-notifications.md +20 -0
  234. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/preview-default-template.md +66 -0
  235. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/preview-notification.md +50 -0
  236. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/save-digest-settings.md +101 -0
  237. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/save-reminders.md +162 -0
  238. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/save-settings.md +99 -0
  239. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/send-digest-test.md +47 -0
  240. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/send-manual-reminder.md +51 -0
  241. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/update-notification.md +93 -0
  242. package/dist/skills/fluentcart-developer/references/restapi/operations/files/delete-file.md +31 -0
  243. package/dist/skills/fluentcart-developer/references/restapi/operations/files/get-bucket-list.md +28 -0
  244. package/dist/skills/fluentcart-developer/references/restapi/operations/files/list-files.md +30 -0
  245. package/dist/skills/fluentcart-developer/references/restapi/operations/files/upload-editor-file.md +32 -0
  246. package/dist/skills/fluentcart-developer/references/restapi/operations/files/upload-file.md +34 -0
  247. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/chained-data-request.md +46 -0
  248. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/change-feed-status.md +51 -0
  249. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/delete-feed.md +27 -0
  250. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-dynamic-options.md +29 -0
  251. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-feed-lists.md +27 -0
  252. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-feed-settings.md +27 -0
  253. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-global-feeds.md +20 -0
  254. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-global-settings.md +26 -0
  255. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/install-addon-plugin.md +49 -0
  256. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/list-addons.md +20 -0
  257. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/save-feed-settings.md +52 -0
  258. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/set-global-settings.md +50 -0
  259. package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/bulk-update-stock.md +94 -0
  260. package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/export-inventory.md +81 -0
  261. package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/get-adjustment-history.md +26 -0
  262. package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/get-inventory-stats.md +21 -0
  263. package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/list-inventory.md +33 -0
  264. package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/update-stock.md +75 -0
  265. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/create-attribute-group.md +31 -0
  266. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/create-label.md +31 -0
  267. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/create-terms.md +90 -0
  268. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/delete-attribute-group.md +28 -0
  269. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/delete-attribute-term.md +29 -0
  270. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/get-attribute-group.md +28 -0
  271. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/get-attribute-library.md +20 -0
  272. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/list-attribute-groups.md +32 -0
  273. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/list-attribute-terms.md +33 -0
  274. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/list-labels.md +20 -0
  275. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/reorder-groups.md +51 -0
  276. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/reorder-terms.md +56 -0
  277. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/update-attribute-group.md +37 -0
  278. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/update-attribute-term.md +39 -0
  279. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/update-label-selections.md +32 -0
  280. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/activate-plugin-license.md +41 -0
  281. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/activate-site-admin.md +60 -0
  282. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/deactivate-plugin-license.md +18 -0
  283. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/deactivate-site-admin.md +67 -0
  284. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/deactivate-site-customer.md +47 -0
  285. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/delete-license.md +24 -0
  286. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/extend-license-validity.md +47 -0
  287. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-customer-license-details.md +25 -0
  288. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-customer-licenses-admin.md +26 -0
  289. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-license-activations.md +25 -0
  290. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-license-details.md +25 -0
  291. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-license-site.md +30 -0
  292. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-plugin-license-status.md +18 -0
  293. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-product-license-settings.md +24 -0
  294. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/list-customer-licenses.md +25 -0
  295. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/list-license-sites.md +33 -0
  296. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/list-licenses.md +38 -0
  297. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-activate-license.md +54 -0
  298. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-check-license.md +26 -0
  299. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-deactivate-license.md +46 -0
  300. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-download-license-package.md +23 -0
  301. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-get-license-version.md +26 -0
  302. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/regenerate-license-key.md +24 -0
  303. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/save-product-license-settings.md +193 -0
  304. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/update-license-activation-limit.md +53 -0
  305. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/update-license-status.md +52 -0
  306. package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/create-order-bump.md +47 -0
  307. package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/delete-order-bump.md +25 -0
  308. package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/get-order-bump.md +25 -0
  309. package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/list-order-bumps.md +29 -0
  310. package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/update-order-bump.md +141 -0
  311. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/accept-dispute.md +47 -0
  312. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/bulk-actions.md +72 -0
  313. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/calculate-shipping.md +67 -0
  314. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/calculate-tax.md +98 -0
  315. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/change-customer.md +50 -0
  316. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/charge-now.md +29 -0
  317. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-and-change-customer.md +92 -0
  318. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-custom-order-item.md +68 -0
  319. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-order.md +351 -0
  320. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-renewal-now.md +29 -0
  321. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/delete-order.md +28 -0
  322. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/generate-missing-licenses.md +29 -0
  323. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-order-transactions.md +27 -0
  324. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-order.md +27 -0
  325. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-renewal.md +28 -0
  326. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-shipping-methods.md +28 -0
  327. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-single-transaction.md +28 -0
  328. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/list-order-currencies.md +22 -0
  329. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/list-orders.md +42 -0
  330. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/list-renewals.md +28 -0
  331. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/mark-as-paid.md +61 -0
  332. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/price-order.md +135 -0
  333. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/refund-order.md +72 -0
  334. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/resend-renewal-invoice.md +29 -0
  335. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/skip-renewal.md +48 -0
  336. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/sync-order-statuses.md +28 -0
  337. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/sync-pending-transaction.md +29 -0
  338. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-order-address-id.md +60 -0
  339. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-order-address.md +98 -0
  340. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-order.md +172 -0
  341. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-statuses.md +77 -0
  342. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-subscription-details.md +84 -0
  343. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-transaction-status.md +51 -0
  344. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/void-renewal.md +30 -0
  345. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/create-pdf-template.md +42 -0
  346. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/delete-pdf-template.md +26 -0
  347. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/download-pdf-preview.md +44 -0
  348. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-factory-default-templates.md +19 -0
  349. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-pdf-status.md +21 -0
  350. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-pdf-template.md +26 -0
  351. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-saved-templates.md +21 -0
  352. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-seller-details.md +19 -0
  353. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/list-pdf-templates.md +19 -0
  354. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/save-pdf-template.md +53 -0
  355. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/save-seller-details.md +97 -0
  356. package/dist/skills/fluentcart-developer/references/restapi/operations/products/add-product-terms.md +64 -0
  357. package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-edit-fetch.md +30 -0
  358. package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-insert-products.md +62 -0
  359. package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-update-products.md +59 -0
  360. package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-update-variants.md +83 -0
  361. package/dist/skills/fluentcart-developer/references/restapi/operations/products/change-integration-status.md +64 -0
  362. package/dist/skills/fluentcart-developer/references/restapi/operations/products/create-dummy-products.md +45 -0
  363. package/dist/skills/fluentcart-developer/references/restapi/operations/products/create-product.md +81 -0
  364. package/dist/skills/fluentcart-developer/references/restapi/operations/products/create-variation.md +181 -0
  365. package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-downloadable-file.md +27 -0
  366. package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-product-integration.md +30 -0
  367. package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-product.md +27 -0
  368. package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-taxonomy-term.md +55 -0
  369. package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-upgrade-path.md +27 -0
  370. package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-variation.md +27 -0
  371. package/dist/skills/fluentcart-developer/references/restapi/operations/products/do-bulk-action.md +56 -0
  372. package/dist/skills/fluentcart-developer/references/restapi/operations/products/duplicate-product.md +56 -0
  373. package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-products-by-ids.md +26 -0
  374. package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-taxonomy-terms.md +20 -0
  375. package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-terms-by-parent.md +60 -0
  376. package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-variations-by-ids.md +26 -0
  377. package/dist/skills/fluentcart-developer/references/restapi/operations/products/find-subscription-variants.md +26 -0
  378. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-bundle-info.md +27 -0
  379. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-downloadable-url.md +27 -0
  380. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-max-excerpt-word-count.md +20 -0
  381. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-pricing-widgets.md +27 -0
  382. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product-integration-feeds.md +29 -0
  383. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product-integration-settings.md +31 -0
  384. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product-pricing.md +28 -0
  385. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product.md +28 -0
  386. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-related-products.md +31 -0
  387. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-upgrade-settings.md +27 -0
  388. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-variation-upgrade-paths.md +28 -0
  389. package/dist/skills/fluentcart-developer/references/restapi/operations/products/group-bulk-update-variants.md +103 -0
  390. package/dist/skills/fluentcart-developer/references/restapi/operations/products/list-all-variants.md +26 -0
  391. package/dist/skills/fluentcart-developer/references/restapi/operations/products/list-product-variations.md +26 -0
  392. package/dist/skills/fluentcart-developer/references/restapi/operations/products/list-products.md +34 -0
  393. package/dist/skills/fluentcart-developer/references/restapi/operations/products/remove-shipping-class.md +27 -0
  394. package/dist/skills/fluentcart-developer/references/restapi/operations/products/remove-tax-class.md +27 -0
  395. package/dist/skills/fluentcart-developer/references/restapi/operations/products/save-bundle-info.md +56 -0
  396. package/dist/skills/fluentcart-developer/references/restapi/operations/products/save-product-integration.md +62 -0
  397. package/dist/skills/fluentcart-developer/references/restapi/operations/products/save-upgrade-path.md +78 -0
  398. package/dist/skills/fluentcart-developer/references/restapi/operations/products/search-product-variant-options.md +29 -0
  399. package/dist/skills/fluentcart-developer/references/restapi/operations/products/search-products-by-name.md +28 -0
  400. package/dist/skills/fluentcart-developer/references/restapi/operations/products/search-variants-by-name.md +28 -0
  401. package/dist/skills/fluentcart-developer/references/restapi/operations/products/set-variation-media.md +74 -0
  402. package/dist/skills/fluentcart-developer/references/restapi/operations/products/suggest-sku.md +28 -0
  403. package/dist/skills/fluentcart-developer/references/restapi/operations/products/sync-downloadable-files.md +134 -0
  404. package/dist/skills/fluentcart-developer/references/restapi/operations/products/sync-taxonomy-terms.md +61 -0
  405. package/dist/skills/fluentcart-developer/references/restapi/operations/products/toggle-product-tax-exemption.md +56 -0
  406. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-downloadable-file.md +98 -0
  407. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-inventory.md +56 -0
  408. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-long-desc-editor-mode.md +49 -0
  409. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-manage-stock.md +53 -0
  410. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-product-detail.md +58 -0
  411. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-product-pricing.md +225 -0
  412. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-shipping-class.md +49 -0
  413. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-tax-class.md +49 -0
  414. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-upgrade-path.md +78 -0
  415. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variant-option.md +79 -0
  416. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variant-tax-exemption.md +56 -0
  417. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variation-pricing-table.md +49 -0
  418. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variation.md +105 -0
  419. package/dist/skills/fluentcart-developer/references/restapi/operations/public-shop/get-product-views.md +34 -0
  420. package/dist/skills/fluentcart-developer/references/restapi/operations/public-shop/list-products.md +42 -0
  421. package/dist/skills/fluentcart-developer/references/restapi/operations/public-shop/search-products.md +30 -0
  422. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/channel-rules.md +24 -0
  423. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/country-heat-map.md +22 -0
  424. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/coupon-overview.md +37 -0
  425. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/coupons.md +36 -0
  426. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-insights.md +31 -0
  427. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-overview.md +36 -0
  428. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-repeat.md +35 -0
  429. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-segment-customers.md +36 -0
  430. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-segments.md +30 -0
  431. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-value.md +34 -0
  432. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/dashboard-stats.md +30 -0
  433. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/failed-orders.md +34 -0
  434. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-new-vs-returning-customer.md +34 -0
  435. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-report-by-day-and-hour.md +34 -0
  436. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-report-meta.md +29 -0
  437. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-top-sold-products.md +34 -0
  438. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/future-renewals.md +31 -0
  439. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/generate-retention-snapshots.md +24 -0
  440. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-overview.md +30 -0
  441. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-recent-activities.md +26 -0
  442. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-recent-orders.md +20 -0
  443. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-revenue.md +37 -0
  444. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/installments-at-risk.md +35 -0
  445. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/installments-variations.md +33 -0
  446. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/installments.md +33 -0
  447. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/item-count-distribution.md +34 -0
  448. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/license-chart.md +30 -0
  449. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/license-pie-chart.md +22 -0
  450. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/license-summary.md +22 -0
  451. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/locations.md +43 -0
  452. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-chart.md +37 -0
  453. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-completion-time.md +34 -0
  454. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-mix.md +34 -0
  455. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-value-distribution.md +34 -0
  456. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/payment-methods-disputes.md +38 -0
  457. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/payment-methods-methods.md +36 -0
  458. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/payment-methods.md +37 -0
  459. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-comparison-launch.md +33 -0
  460. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-comparison.md +40 -0
  461. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-detail.md +37 -0
  462. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-sales.md +37 -0
  463. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/refunds-overview.md +37 -0
  464. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/retention-snapshots-step.md +45 -0
  465. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/sales-growth-chart.md +35 -0
  466. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/save-channel-rules.md +73 -0
  467. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/source-channels.md +37 -0
  468. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/sources.md +49 -0
  469. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-cohorts.md +33 -0
  470. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-health.md +30 -0
  471. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-rebuys.md +37 -0
  472. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-retention.md +34 -0
  473. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-variations.md +22 -0
  474. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscriptions-overview.md +37 -0
  475. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/weeks-between-refund.md +34 -0
  476. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/assign-role.md +48 -0
  477. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/delete-role-assignment.md +47 -0
  478. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/get-role.md +25 -0
  479. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/list-managers.md +18 -0
  480. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/list-roles.md +18 -0
  481. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/search-users.md +25 -0
  482. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/update-role.md +43 -0
  483. package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/create-saved-view.md +106 -0
  484. package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/delete-saved-view.md +26 -0
  485. package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/list-saved-views.md +25 -0
  486. package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/update-saved-view.md +83 -0
  487. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/activate-payment-addon.md +44 -0
  488. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/activate-plugin-addon.md +44 -0
  489. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/change-storage-driver-status.md +56 -0
  490. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/check-paypal-webhook.md +26 -0
  491. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/create-storage-bucket.md +63 -0
  492. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/disconnect-payment-method.md +55 -0
  493. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/exchange-paypal-seller-auth-token.md +62 -0
  494. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-active-storage-drivers.md +20 -0
  495. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-checkout-fields.md +22 -0
  496. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-email-shortcodes.md +20 -0
  497. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-mcp-config-snippets.md +26 -0
  498. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-mcp-status.md +20 -0
  499. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-module-settings.md +20 -0
  500. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-payment-method-connection-info.md +26 -0
  501. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-payment-method-settings.md +26 -0
  502. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-permissions.md +22 -0
  503. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-plugin-addons.md +20 -0
  504. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-storage-driver-settings.md +27 -0
  505. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-store-settings.md +26 -0
  506. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/install-mcp-adapter.md +21 -0
  507. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/install-payment-addon.md +60 -0
  508. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/install-plugin-addon.md +64 -0
  509. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/list-all-payment-methods.md +20 -0
  510. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/list-all-storage-drivers.md +20 -0
  511. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/list-storage-buckets.md +67 -0
  512. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/reorder-payment-methods.md +55 -0
  513. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/reset-storage-driver-settings.md +45 -0
  514. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-checkout-fields.md +133 -0
  515. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-confirmation-settings.md +68 -0
  516. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-module-settings.md +68 -0
  517. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-payment-method-design.md +67 -0
  518. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-payment-method-settings.md +58 -0
  519. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-permissions.md +68 -0
  520. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-storage-driver-settings.md +62 -0
  521. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-store-settings.md +239 -0
  522. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/setup-paypal-webhook.md +48 -0
  523. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/toggle-mcp.md +40 -0
  524. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/verify-storage-driver-connection.md +62 -0
  525. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/verify-turnstile-keys.md +55 -0
  526. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/create-shipping-class.md +73 -0
  527. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/create-shipping-method.md +110 -0
  528. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/create-shipping-zone.md +56 -0
  529. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/delete-shipping-class.md +29 -0
  530. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/delete-shipping-method.md +29 -0
  531. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/delete-shipping-zone.md +29 -0
  532. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-class-profile.md +30 -0
  533. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-class.md +29 -0
  534. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-packages.md +22 -0
  535. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-zone.md +27 -0
  536. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-zone-countries.md +22 -0
  537. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-zone-states.md +28 -0
  538. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/list-shipping-classes.md +31 -0
  539. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/list-shipping-zones.md +31 -0
  540. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/save-shipping-packages.md +112 -0
  541. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-shipping-class.md +79 -0
  542. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-shipping-method.md +113 -0
  543. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-shipping-zone.md +62 -0
  544. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-zone-order.md +52 -0
  545. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/cancel-auto-renew.md +30 -0
  546. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/cancel-subscription.md +52 -0
  547. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/confirm-subscription-switch.md +70 -0
  548. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/fetch-subscription-remote.md +28 -0
  549. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/generate-early-payment-link.md +29 -0
  550. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-customer-subscription.md +27 -0
  551. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-or-create-plan.md +69 -0
  552. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-setup-intent-attempts.md +30 -0
  553. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-subscription.md +28 -0
  554. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/initiate-early-payment.md +31 -0
  555. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/list-customer-subscriptions.md +27 -0
  556. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/list-subscriptions.md +39 -0
  557. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/pause-subscription.md +28 -0
  558. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/reactivate-subscription.md +28 -0
  559. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/resume-subscription.md +28 -0
  560. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/switch-payment-method.md +70 -0
  561. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/update-payment-method.md +69 -0
  562. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/update-vendor-ids.md +56 -0
  563. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/verify-vendor-ids.md +56 -0
  564. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/create-tax-class.md +51 -0
  565. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/create-tax-rate.md +117 -0
  566. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-product-override.md +27 -0
  567. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-shipping-tax-override.md +27 -0
  568. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-tax-class.md +28 -0
  569. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-tax-rate.md +27 -0
  570. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-country-tax-id.md +27 -0
  571. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-country-tax-rates.md +28 -0
  572. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-eu-vat-product-overrides.md +20 -0
  573. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-oss-country-rates.md +20 -0
  574. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-preconfigured-tax-rates.md +20 -0
  575. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-product-overrides.md +27 -0
  576. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-tax-settings.md +20 -0
  577. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/list-all-tax-rates.md +20 -0
  578. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/list-tax-classes.md +20 -0
  579. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/list-tax-records.md +37 -0
  580. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/mark-taxes-as-filed.md +58 -0
  581. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/reset-eu-vat-rates.md +21 -0
  582. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-configured-countries.md +57 -0
  583. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-country-tax-id.md +50 -0
  584. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-eu-vat-cross-border-settings.md +127 -0
  585. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-oss-country-rates.md +100 -0
  586. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-product-override.md +110 -0
  587. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-shipping-tax-override.md +52 -0
  588. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-tax-settings.md +166 -0
  589. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/update-country-status.md +54 -0
  590. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/update-tax-rate.md +116 -0
  591. package/dist/skills/fluentcart-developer/references/restapi/order-bumps.md +433 -0
  592. package/dist/skills/fluentcart-developer/references/{rest-api-orders.md → restapi/orders.md} +146 -396
  593. package/dist/skills/fluentcart-developer/references/restapi/pdf-templates.md +212 -0
  594. package/dist/skills/fluentcart-developer/references/{rest-api-products.md → restapi/products.md} +354 -566
  595. package/dist/skills/fluentcart-developer/references/restapi/public-shop.md +191 -0
  596. package/dist/skills/fluentcart-developer/references/restapi/reports.md +3773 -0
  597. package/dist/skills/fluentcart-developer/references/restapi/roles.md +403 -0
  598. package/dist/skills/fluentcart-developer/references/restapi/saved-views.md +136 -0
  599. package/dist/skills/fluentcart-developer/references/restapi/settings.md +1423 -0
  600. package/dist/skills/fluentcart-developer/references/{rest-api-shipping.md → restapi/shipping.md} +243 -138
  601. package/dist/skills/fluentcart-developer/references/restapi/subscriptions.md +1169 -0
  602. package/dist/skills/fluentcart-developer/references/restapi/tax.md +1551 -0
  603. package/dist/skills/fluentcart-developer/references/restapi.md +127 -0
  604. package/dist/version.d.ts +1 -1
  605. package/dist/version.js +1 -1
  606. package/package.json +1 -1
  607. package/dist/skills/fluentcart-developer/.claude-plugin/plugin.json +0 -12
  608. package/dist/skills/fluentcart-developer/.mcp.json +0 -11
  609. package/dist/skills/fluentcart-developer/references/action-hooks-admin-templates.md +0 -787
  610. package/dist/skills/fluentcart-developer/references/action-hooks-cart-checkout.md +0 -1355
  611. package/dist/skills/fluentcart-developer/references/action-hooks-customers-users.md +0 -266
  612. package/dist/skills/fluentcart-developer/references/action-hooks-licenses.md +0 -855
  613. package/dist/skills/fluentcart-developer/references/action-hooks-orders.md +0 -631
  614. package/dist/skills/fluentcart-developer/references/action-hooks-payments-integrations.md +0 -963
  615. package/dist/skills/fluentcart-developer/references/action-hooks-products-coupons.md +0 -585
  616. package/dist/skills/fluentcart-developer/references/action-hooks-subscriptions.md +0 -661
  617. package/dist/skills/fluentcart-developer/references/customer-dashboard-endpoints.md +0 -169
  618. package/dist/skills/fluentcart-developer/references/database-models-query-builder.md +0 -194
  619. package/dist/skills/fluentcart-developer/references/database-models-reference.md +0 -604
  620. package/dist/skills/fluentcart-developer/references/database-schema-reference.md +0 -947
  621. package/dist/skills/fluentcart-developer/references/engineering-notes.md +0 -154
  622. package/dist/skills/fluentcart-developer/references/filter-hooks-cart-checkout.md +0 -1202
  623. package/dist/skills/fluentcart-developer/references/filter-hooks-customers-subscriptions.md +0 -902
  624. package/dist/skills/fluentcart-developer/references/filter-hooks-integrations-advanced.md +0 -1598
  625. package/dist/skills/fluentcart-developer/references/filter-hooks-orders-payments.md +0 -1319
  626. package/dist/skills/fluentcart-developer/references/filter-hooks-products-pricing.md +0 -628
  627. package/dist/skills/fluentcart-developer/references/filter-hooks-settings-configuration.md +0 -1177
  628. package/dist/skills/fluentcart-developer/references/fluentcart-developer-guide.md +0 -154
  629. package/dist/skills/fluentcart-developer/references/hooks-complete-index.md +0 -834
  630. package/dist/skills/fluentcart-developer/references/models-complete-index.md +0 -912
  631. package/dist/skills/fluentcart-developer/references/modules-and-extensions-reference.md +0 -224
  632. package/dist/skills/fluentcart-developer/references/order-bump-module.md +0 -163
  633. package/dist/skills/fluentcart-developer/references/paddle-gateway-case-study.md +0 -1931
  634. package/dist/skills/fluentcart-developer/references/payment-gateway-integration.md +0 -761
  635. package/dist/skills/fluentcart-developer/references/rest-api-checkout.md +0 -288
  636. package/dist/skills/fluentcart-developer/references/rest-api-coupons.md +0 -801
  637. package/dist/skills/fluentcart-developer/references/rest-api-customer-profile.md +0 -190
  638. package/dist/skills/fluentcart-developer/references/rest-api-dashboard-utilities.md +0 -219
  639. package/dist/skills/fluentcart-developer/references/rest-api-email-notifications.md +0 -619
  640. package/dist/skills/fluentcart-developer/references/rest-api-files.md +0 -290
  641. package/dist/skills/fluentcart-developer/references/rest-api-integrations.md +0 -324
  642. package/dist/skills/fluentcart-developer/references/rest-api-labels-attributes.md +0 -321
  643. package/dist/skills/fluentcart-developer/references/rest-api-licensing.md +0 -174
  644. package/dist/skills/fluentcart-developer/references/rest-api-order-bumps.md +0 -200
  645. package/dist/skills/fluentcart-developer/references/rest-api-overview.md +0 -131
  646. package/dist/skills/fluentcart-developer/references/rest-api-public-shop.md +0 -172
  647. package/dist/skills/fluentcart-developer/references/rest-api-reference.md +0 -552
  648. package/dist/skills/fluentcart-developer/references/rest-api-reports.md +0 -377
  649. package/dist/skills/fluentcart-developer/references/rest-api-roles-permissions.md +0 -147
  650. package/dist/skills/fluentcart-developer/references/rest-api-settings.md +0 -528
  651. package/dist/skills/fluentcart-developer/references/rest-api-subscriptions.md +0 -938
  652. package/dist/skills/fluentcart-developer/references/rest-api-tax.md +0 -356
  653. package/dist/skills/fluentcart-developer/references/shipping-module-guide.md +0 -126
  654. package/dist/skills/fluentcart-developer/references/software-licensing-sdk.md +0 -228
  655. package/dist/skills/fluentcart-developer/references/storage-drivers-module.md +0 -140
@@ -1,34 +1,12 @@
1
1
  # Shipping API
2
2
 
3
- Configure shipping zones, manage shipping methods within zones, and organize products with shipping classes in FluentCart.
3
+ Configure shipping zones, manage shipping methods within zones, and organize products with shipping classes.
4
4
 
5
- **Base URL:** `https://your-site.com/wp-json/fluent-cart/v2`
6
- **Policy:** `StoreSensitivePolicy`
7
- **Permission:** `store/sensitive`
5
+ **Base URL:** `https://your-site.com/wp-json/fluent-cart/v2/shipping`
8
6
 
9
- > All monetary values (shipping costs, amounts) are in **cents** (e.g., `$10.00` = `1000`).
7
+ **Policy:** `StoreSensitivePolicy`
10
8
 
11
- ---
12
-
13
- ## Endpoints Overview
14
-
15
- | Group | Method | Endpoint | Request Class | Description |
16
- |-------|--------|----------|---------------|-------------|
17
- | **Shipping Zones** | GET | `/shipping/zones` | — | List Shipping Zones (paginated) |
18
- | | POST | `/shipping/zones` | `ShippingZoneRequest` | Create Shipping Zone |
19
- | | GET | `/shipping/zones/{id}` | — | Get Single Shipping Zone Details |
20
- | | PUT | `/shipping/zones/{id}` | `ShippingZoneRequest` | Update Shipping Zone |
21
- | | DELETE | `/shipping/zones/{id}` | — | Delete Shipping Zone (cascading) |
22
- | | POST | `/shipping/zones/update-order` | — | Reorder Shipping Zones |
23
- | | GET | `/shipping/zone/states` | — | Get State Options & Locale Config |
24
- | **Shipping Methods** | POST | `/shipping/methods` | `ShippingMethodRequest` | Create Shipping Method |
25
- | | PUT | `/shipping/methods` | `ShippingMethodRequest` | Update Shipping Method |
26
- | | DELETE | `/shipping/methods/{method_id}` | — | Delete Shipping Method |
27
- | **Shipping Classes** | GET | `/shipping/classes` | — | List Shipping Classes (paginated) |
28
- | | POST | `/shipping/classes` | `ShippingClassRequest` | Create Shipping Class |
29
- | | GET | `/shipping/classes/{id}` | — | Get Single Shipping Class |
30
- | | PUT | `/shipping/classes/{id}` | `ShippingClassRequest` | Update Shipping Class |
31
- | | DELETE | `/shipping/classes/{id}` | — | Delete Shipping Class |
9
+ > Shipping amounts on this page are **decimal base-currency major units**, not cents (`5.00` means $5.00). Method `amount` and class `cost` are both `DECIMAL(10,2)`. When a method's `settings.configure_rate` is `per_price`, `amount` is a percentage instead.
32
10
 
33
11
  ---
34
12
 
@@ -36,20 +14,20 @@ Configure shipping zones, manage shipping methods within zones, and organize pro
36
14
 
37
15
  Shipping zones define geographic regions (countries) to which specific shipping methods apply. Each zone contains a country code (or `all` for worldwide) and can hold multiple shipping methods.
38
16
 
39
- **Prefix:** `/fluent-cart/v2/shipping/zones` | **Policy:** `StoreSensitivePolicy` (`store/sensitive`)
40
-
41
17
  ### List Shipping Zones
42
18
 
43
- `GET /fluent-cart/v2/shipping/zones`
19
+ GET `/fluent-cart/v2/shipping/zones`
44
20
 
45
21
  Retrieve a paginated list of shipping zones with filtering and sorting capabilities.
46
22
 
23
+ - **Permission:** `store/sensitive`
24
+
47
25
  #### Parameters
48
26
 
49
27
  | Parameter | Type | Location | Required | Description |
50
- |-----------|------|----------|----------|-------------|
28
+ | --- | --- | --- | --- | --- |
51
29
  | `search` | string | query | No | Search zones by name |
52
- | `per_page` | integer | query | No | Number of results per page (default: 10, max: 200) |
30
+ | `per_page` | integer | query | No | Number of results per page (default: `10`, max: `200`) |
53
31
  | `page` | integer | query | No | Page number for pagination |
54
32
  | `sort_by` | string | query | No | Column to sort by (default: `order`) |
55
33
  | `sort_type` | string | query | No | Sort direction: `asc` or `desc` (default: `asc`) |
@@ -57,7 +35,7 @@ Retrieve a paginated list of shipping zones with filtering and sorting capabilit
57
35
 
58
36
  #### Response
59
37
 
60
- ```json
38
+ ```
61
39
  {
62
40
  "shipping_zones": {
63
41
  "total": 3,
@@ -90,7 +68,7 @@ Retrieve a paginated list of shipping zones with filtering and sorting capabilit
90
68
 
91
69
  #### Example
92
70
 
93
- ```bash
71
+ ```
94
72
  curl -X GET "https://example.com/wp-json/fluent-cart/v2/shipping/zones?per_page=20&search=domestic" \
95
73
  -u "username:app_password"
96
74
  ```
@@ -99,23 +77,27 @@ curl -X GET "https://example.com/wp-json/fluent-cart/v2/shipping/zones?per_page=
99
77
 
100
78
  ### Create Shipping Zone
101
79
 
102
- `POST /fluent-cart/v2/shipping/zones`
80
+ POST `/fluent-cart/v2/shipping/zones`
103
81
 
104
82
  Create a new shipping zone.
105
83
 
106
- **Request Class:** `ShippingZoneRequest`
84
+ - **Permission:** `store/sensitive`
85
+ - **Request Class:** `ShippingZoneRequest`
107
86
 
108
87
  #### Parameters
109
88
 
110
89
  | Parameter | Type | Location | Required | Description |
111
- |-----------|------|----------|----------|-------------|
90
+ | --- | --- | --- | --- | --- |
112
91
  | `name` | string | body | Yes | Zone name (max 192 characters) |
113
- | `region` | string | body | No | ISO 3166-1 alpha-2 country code (e.g. `US`, `GB`) or `all` for worldwide. Only one `all` zone is allowed. |
92
+ | `region` | string | body | No | ISO 3166-1 alpha-2 country code (e.g., `US`, `GB`), `all` for worldwide, or `selection` for several countries. Only one `all` zone is allowed **per shipping class** — one for `shipping_class_id` and one for class-less zones. |
93
+ | `shipping_class_id` | integer | body | No | Scopes the zone to one shipping class. Omit or send `null` for class-less items. |
94
+ | `meta.countries` | array | body | No | Country codes, used when `region` is `selection` |
95
+ | `meta.selection_type` | string | body | No | `included` or `excluded` — whether `meta.countries` is an allow or deny list |
114
96
  | `order` | integer | body | No | Sort order for display priority |
115
97
 
116
98
  #### Response
117
99
 
118
- ```json
100
+ ```
119
101
  {
120
102
  "shipping_zone": {
121
103
  "id": 3,
@@ -132,7 +114,7 @@ Create a new shipping zone.
132
114
 
133
115
  #### Example
134
116
 
135
- ```bash
117
+ ```
136
118
  curl -X POST "https://example.com/wp-json/fluent-cart/v2/shipping/zones" \
137
119
  -u "username:app_password" \
138
120
  -H "Content-Type: application/json" \
@@ -147,19 +129,21 @@ curl -X POST "https://example.com/wp-json/fluent-cart/v2/shipping/zones" \
147
129
 
148
130
  ### Get Shipping Zone
149
131
 
150
- `GET /fluent-cart/v2/shipping/zones/{id}`
132
+ GET `/fluent-cart/v2/shipping/zones/{id}`
151
133
 
152
134
  Retrieve a single shipping zone by ID, including its associated shipping methods.
153
135
 
136
+ - **Permission:** `store/sensitive`
137
+
154
138
  #### Parameters
155
139
 
156
140
  | Parameter | Type | Location | Required | Description |
157
- |-----------|------|----------|----------|-------------|
141
+ | --- | --- | --- | --- | --- |
158
142
  | `id` | integer | path | Yes | The shipping zone ID |
159
143
 
160
144
  #### Response
161
145
 
162
- ```json
146
+ ```
163
147
  {
164
148
  "shipping_zone": {
165
149
  "id": 1,
@@ -192,7 +176,7 @@ Retrieve a single shipping zone by ID, including its associated shipping methods
192
176
 
193
177
  #### Example
194
178
 
195
- ```bash
179
+ ```
196
180
  curl -X GET "https://example.com/wp-json/fluent-cart/v2/shipping/zones/1" \
197
181
  -u "username:app_password"
198
182
  ```
@@ -201,26 +185,29 @@ curl -X GET "https://example.com/wp-json/fluent-cart/v2/shipping/zones/1" \
201
185
 
202
186
  ### Update Shipping Zone
203
187
 
204
- `PUT /fluent-cart/v2/shipping/zones/{id}`
188
+ PUT `/fluent-cart/v2/shipping/zones/{id}`
205
189
 
206
- Update an existing shipping zone.
190
+ Update an existing shipping zone. If the `region` changes, all associated shipping method `states` are reset to empty.
207
191
 
208
- **Request Class:** `ShippingZoneRequest`
192
+ - **Permission:** `store/sensitive`
193
+ - **Request Class:** `ShippingZoneRequest`
209
194
 
210
195
  #### Parameters
211
196
 
212
197
  | Parameter | Type | Location | Required | Description |
213
- |-----------|------|----------|----------|-------------|
198
+ | --- | --- | --- | --- | --- |
214
199
  | `id` | integer | path | Yes | The shipping zone ID |
215
200
  | `name` | string | body | Yes | Zone name (max 192 characters) |
216
201
  | `region` | string | body | No | ISO 3166-1 alpha-2 country code or `all`. Only one `all` zone is allowed. |
217
202
  | `order` | integer | body | No | Sort order for display priority |
218
203
 
219
- > **Region Change Side Effect:** When the `region` value changes, all shipping methods in the zone have their `states` arrays reset to `[]`. This is because states/provinces are country-specific.
204
+ Region Change Side Effect
205
+
206
+ When the `region` value changes, all shipping methods in the zone have their `states` arrays reset to `[]`. This is because states/provinces are country-specific.
220
207
 
221
208
  #### Response
222
209
 
223
- ```json
210
+ ```
224
211
  {
225
212
  "shipping_zone": {
226
213
  "id": 1,
@@ -237,7 +224,7 @@ Update an existing shipping zone.
237
224
 
238
225
  #### Example
239
226
 
240
- ```bash
227
+ ```
241
228
  curl -X PUT "https://example.com/wp-json/fluent-cart/v2/shipping/zones/1" \
242
229
  -u "username:app_password" \
243
230
  -H "Content-Type: application/json" \
@@ -252,21 +239,25 @@ curl -X PUT "https://example.com/wp-json/fluent-cart/v2/shipping/zones/1" \
252
239
 
253
240
  ### Delete Shipping Zone
254
241
 
255
- `DELETE /fluent-cart/v2/shipping/zones/{id}`
242
+ DELETE `/fluent-cart/v2/shipping/zones/{id}`
256
243
 
257
244
  Delete a shipping zone and all its associated shipping methods.
258
245
 
259
- > **Cascading Delete:** Deleting a zone will also permanently delete all shipping methods associated with that zone.
246
+ - **Permission:** `store/sensitive`
260
247
 
261
248
  #### Parameters
262
249
 
263
250
  | Parameter | Type | Location | Required | Description |
264
- |-----------|------|----------|----------|-------------|
251
+ | --- | --- | --- | --- | --- |
265
252
  | `id` | integer | path | Yes | The shipping zone ID |
266
253
 
254
+ Cascading Delete
255
+
256
+ Deleting a zone will also permanently delete all shipping methods associated with that zone.
257
+
267
258
  #### Response
268
259
 
269
- ```json
260
+ ```
270
261
  {
271
262
  "message": "Shipping zone has been deleted successfully"
272
263
  }
@@ -274,7 +265,7 @@ Delete a shipping zone and all its associated shipping methods.
274
265
 
275
266
  #### Example
276
267
 
277
- ```bash
268
+ ```
278
269
  curl -X DELETE "https://example.com/wp-json/fluent-cart/v2/shipping/zones/1" \
279
270
  -u "username:app_password"
280
271
  ```
@@ -283,19 +274,21 @@ curl -X DELETE "https://example.com/wp-json/fluent-cart/v2/shipping/zones/1" \
283
274
 
284
275
  ### Update Zone Order
285
276
 
286
- `POST /fluent-cart/v2/shipping/zones/update-order`
277
+ POST `/fluent-cart/v2/shipping/zones/update-order`
287
278
 
288
279
  Reorder shipping zones by providing an array of zone IDs in the desired order. Each zone's `order` field is updated to match its index position.
289
280
 
281
+ - **Permission:** `store/sensitive`
282
+
290
283
  #### Parameters
291
284
 
292
285
  | Parameter | Type | Location | Required | Description |
293
- |-----------|------|----------|----------|-------------|
286
+ | --- | --- | --- | --- | --- |
294
287
  | `zones` | array | body | Yes | Array of zone IDs in the desired display order |
295
288
 
296
289
  #### Response
297
290
 
298
- ```json
291
+ ```
299
292
  {
300
293
  "message": "Shipping zones order has been updated"
301
294
  }
@@ -303,7 +296,7 @@ Reorder shipping zones by providing an array of zone IDs in the desired order. E
303
296
 
304
297
  #### Error Response
305
298
 
306
- ```json
299
+ ```
307
300
  {
308
301
  "message": "Invalid data provided"
309
302
  }
@@ -311,7 +304,7 @@ Reorder shipping zones by providing an array of zone IDs in the desired order. E
311
304
 
312
305
  #### Example
313
306
 
314
- ```bash
307
+ ```
315
308
  curl -X POST "https://example.com/wp-json/fluent-cart/v2/shipping/zones/update-order" \
316
309
  -u "username:app_password" \
317
310
  -H "Content-Type: application/json" \
@@ -319,35 +312,38 @@ curl -X POST "https://example.com/wp-json/fluent-cart/v2/shipping/zones/update-o
319
312
  "zones": [3, 1, 2]
320
313
  }'
321
314
  ```
322
- *(In this example, zone `3` gets `order: 0`, zone `1` gets `order: 1`, and zone `2` gets `order: 2`.)*
315
+
316
+ In this example, zone `3` gets `order: 0`, zone `1` gets `order: 1`, and zone `2` gets `order: 2`.
323
317
 
324
318
  ---
325
319
 
326
320
  ### Get Zone States
327
321
 
328
- `GET /fluent-cart/v2/shipping/zone/states`
322
+ GET `/fluent-cart/v2/shipping/zone/states`
329
323
 
330
324
  Retrieve state/province options and address locale configuration for a given country. Useful for populating state selectors when configuring shipping methods within a zone.
331
325
 
326
+ - **Permission:** `store/sensitive`
327
+
332
328
  #### Parameters
333
329
 
334
330
  | Parameter | Type | Location | Required | Description |
335
- |-----------|------|----------|----------|-------------|
331
+ | --- | --- | --- | --- | --- |
336
332
  | `country_code` | string | query | No | ISO 3166-1 alpha-2 country code (e.g., `US`, `CA`, `GB`) |
337
333
 
338
- #### Response (with country code)
334
+ #### Response
339
335
 
340
- ```json
336
+ ```
341
337
  {
342
338
  "data": {
343
339
  "country_code": "US",
344
- "states": {
345
- "AL": "Alabama",
346
- "AK": "Alaska",
347
- "AZ": "Arizona",
348
- "CA": "California",
349
- "NY": "New York"
350
- },
340
+ "states": [
341
+ { "value": "AL", "name": "Alabama" },
342
+ { "value": "AK", "name": "Alaska" },
343
+ { "value": "AZ", "name": "Arizona" },
344
+ { "value": "CA", "name": "California" },
345
+ { "value": "NY", "name": "New York" }
346
+ ],
351
347
  "address_locale": {
352
348
  "state": {
353
349
  "label": "State",
@@ -362,9 +358,11 @@ Retrieve state/province options and address locale configuration for a given cou
362
358
  }
363
359
  ```
364
360
 
365
- #### Response (empty / no states)
361
+ `address_locale` only carries the fields that differ for the requested country, so its keys vary from one country to the next.
362
+
363
+ When no country code is provided or the country has no states:
366
364
 
367
- ```json
365
+ ```
368
366
  {
369
367
  "data": {
370
368
  "country_code": "",
@@ -376,7 +374,7 @@ Retrieve state/province options and address locale configuration for a given cou
376
374
 
377
375
  #### Example
378
376
 
379
- ```bash
377
+ ```
380
378
  curl -X GET "https://example.com/wp-json/fluent-cart/v2/shipping/zone/states?country_code=US" \
381
379
  -u "username:app_password"
382
380
  ```
@@ -387,34 +385,34 @@ curl -X GET "https://example.com/wp-json/fluent-cart/v2/shipping/zone/states?cou
387
385
 
388
386
  Shipping methods define how items are shipped within a zone. Each method belongs to a zone and can be scoped to specific states/provinces within that zone's country.
389
387
 
390
- **Prefix:** `/fluent-cart/v2/shipping/methods` | **Policy:** `StoreSensitivePolicy` (`store/sensitive`)
391
-
392
388
  ### Create Shipping Method
393
389
 
394
- `POST /fluent-cart/v2/shipping/methods`
390
+ POST `/fluent-cart/v2/shipping/methods`
395
391
 
396
392
  Create a new shipping method within a shipping zone.
397
393
 
398
- **Request Class:** `ShippingMethodRequest`
394
+ - **Permission:** `store/sensitive`
395
+ - **Request Class:** `ShippingMethodRequest`
399
396
 
400
397
  #### Parameters
401
398
 
402
399
  | Parameter | Type | Location | Required | Description |
403
- |-----------|------|----------|----------|-------------|
400
+ | --- | --- | --- | --- | --- |
404
401
  | `zone_id` | integer | body | Yes | ID of the parent shipping zone |
405
402
  | `title` | string | body | Yes | Method display title (max 192 characters) |
406
403
  | `type` | string | body | Yes | Shipping method type (max 192 characters), e.g., `flat_rate`, `free_shipping`, `local_pickup` |
407
- | `amount` | string | body | No | Shipping cost in cents (e.g., `500` for `$5.00`) |
404
+ | `amount` | number | body | No | Base rate in major units (e.g., `5.00` for $5.00); a percentage when `configure_rate` is `per_price` |
408
405
  | `is_enabled` | integer | body | No | Enable/disable the method: `1` (enabled) or `0` (disabled). Default: `1` |
409
- | `states` | array | body | No | Array of state/province codes to restrict this method to (e.g. `["CA", "NY"]`). Empty array means all states. |
410
- | `settings` | object | body | No | Additional settings object |
411
- | `settings.configure_rate` | string | body | No | Rate configuration type (e.g., `per_order`) |
412
- | `settings.class_aggregation` | string | body | No | How shipping classes are aggregated (e.g., `per_class`) |
406
+ | `states` | array | body | No | Array of state/province codes to restrict this method to (e.g., `["CA", "NY"]`). Empty array means all states. |
407
+ | `settings` | object | body | No | Additional settings for the method |
408
+ | `settings.configure_rate` | string | body | No | `per_order` (default), `per_price`, `per_weight`, or per item |
409
+ | `settings.class_aggregation` | string | body | No | `sum_all` (default) or `highest_class` |
410
+ | `settings.weight_tiers` | array | body | No | Used when `configure_rate` is `per_weight`; each tier is `{min, max, cost}`, `max` of `0` meaning no upper bound |
413
411
  | `meta` | object | body | No | Additional metadata key-value pairs (string values only) |
414
412
 
415
413
  #### Response
416
414
 
417
- ```json
415
+ ```
418
416
  {
419
417
  "message": "Shipping method has been created successfully"
420
418
  }
@@ -422,7 +420,7 @@ Create a new shipping method within a shipping zone.
422
420
 
423
421
  #### Example
424
422
 
425
- ```bash
423
+ ```
426
424
  curl -X POST "https://example.com/wp-json/fluent-cart/v2/shipping/methods" \
427
425
  -u "username:app_password" \
428
426
  -H "Content-Type: application/json" \
@@ -435,7 +433,7 @@ curl -X POST "https://example.com/wp-json/fluent-cart/v2/shipping/methods" \
435
433
  "states": ["CA", "NY"],
436
434
  "settings": {
437
435
  "configure_rate": "per_order",
438
- "class_aggregation": "per_class"
436
+ "class_aggregation": "sum_all"
439
437
  }
440
438
  }'
441
439
  ```
@@ -444,31 +442,33 @@ curl -X POST "https://example.com/wp-json/fluent-cart/v2/shipping/methods" \
444
442
 
445
443
  ### Update Shipping Method
446
444
 
447
- `PUT /fluent-cart/v2/shipping/methods`
445
+ PUT `/fluent-cart/v2/shipping/methods`
448
446
 
449
447
  Update an existing shipping method. The method ID is passed in the request body.
450
448
 
451
- **Request Class:** `ShippingMethodRequest`
449
+ - **Permission:** `store/sensitive`
450
+ - **Request Class:** `ShippingMethodRequest`
452
451
 
453
452
  #### Parameters
454
453
 
455
454
  | Parameter | Type | Location | Required | Description |
456
- |-----------|------|----------|----------|-------------|
455
+ | --- | --- | --- | --- | --- |
457
456
  | `method_id` | integer | body | Yes | ID of the shipping method to update |
458
457
  | `zone_id` | integer | body | Yes | ID of the parent shipping zone |
459
458
  | `title` | string | body | Yes | Method display title (max 192 characters) |
460
459
  | `type` | string | body | Yes | Shipping method type (max 192 characters), e.g., `flat_rate`, `free_shipping`, `local_pickup` |
461
- | `amount` | string | body | No | Shipping cost in cents (e.g., `500` for `$5.00`) |
460
+ | `amount` | number | body | No | Base rate in major units (e.g., `5.00` for $5.00); a percentage when `configure_rate` is `per_price` |
462
461
  | `is_enabled` | integer | body | No | Enable/disable the method: `1` (enabled) or `0` (disabled) |
463
462
  | `states` | array | body | No | Array of state/province codes to restrict this method to. Empty array means all states. |
464
463
  | `settings` | object | body | No | Additional settings for the method |
465
- | `settings.configure_rate` | string | body | No | Rate configuration type |
466
- | `settings.class_aggregation` | string | body | No | How shipping classes are aggregated |
464
+ | `settings.configure_rate` | string | body | No | `per_order` (default), `per_price`, `per_weight`, or per item |
465
+ | `settings.class_aggregation` | string | body | No | `sum_all` (default) or `highest_class` |
466
+ | `settings.weight_tiers` | array | body | No | Used when `configure_rate` is `per_weight`; each tier is `{min, max, cost}`, `max` of `0` meaning no upper bound |
467
467
  | `meta` | object | body | No | Additional metadata key-value pairs (string values only) |
468
468
 
469
469
  #### Response
470
470
 
471
- ```json
471
+ ```
472
472
  {
473
473
  "message": "Shipping method has been updated successfully"
474
474
  }
@@ -476,7 +476,7 @@ Update an existing shipping method. The method ID is passed in the request body.
476
476
 
477
477
  #### Example
478
478
 
479
- ```bash
479
+ ```
480
480
  curl -X PUT "https://example.com/wp-json/fluent-cart/v2/shipping/methods" \
481
481
  -u "username:app_password" \
482
482
  -H "Content-Type: application/json" \
@@ -495,19 +495,21 @@ curl -X PUT "https://example.com/wp-json/fluent-cart/v2/shipping/methods" \
495
495
 
496
496
  ### Delete Shipping Method
497
497
 
498
- `DELETE /fluent-cart/v2/shipping/methods/{method_id}`
498
+ DELETE `/fluent-cart/v2/shipping/methods/{method_id}`
499
499
 
500
500
  Delete a shipping method by ID.
501
501
 
502
+ - **Permission:** `store/sensitive`
503
+
502
504
  #### Parameters
503
505
 
504
506
  | Parameter | Type | Location | Required | Description |
505
- |-----------|------|----------|----------|-------------|
507
+ | --- | --- | --- | --- | --- |
506
508
  | `method_id` | integer | path | Yes | The shipping method ID |
507
509
 
508
510
  #### Response
509
511
 
510
- ```json
512
+ ```
511
513
  {
512
514
  "message": "Shipping method has been deleted successfully"
513
515
  }
@@ -515,7 +517,7 @@ Delete a shipping method by ID.
515
517
 
516
518
  #### Example
517
519
 
518
- ```bash
520
+ ```
519
521
  curl -X DELETE "https://example.com/wp-json/fluent-cart/v2/shipping/methods/10" \
520
522
  -u "username:app_password"
521
523
  ```
@@ -526,20 +528,20 @@ curl -X DELETE "https://example.com/wp-json/fluent-cart/v2/shipping/methods/10"
526
528
 
527
529
  Shipping classes allow you to group products with similar shipping requirements. Each class defines a cost (fixed or percentage) that can be applied per order or per item.
528
530
 
529
- **Prefix:** `/fluent-cart/v2/shipping/classes` | **Policy:** `StoreSensitivePolicy` (`store/sensitive`)
530
-
531
531
  ### List Shipping Classes
532
532
 
533
- `GET /fluent-cart/v2/shipping/classes`
533
+ GET `/fluent-cart/v2/shipping/classes`
534
534
 
535
535
  Retrieve a paginated list of shipping classes with filtering and sorting capabilities.
536
536
 
537
+ - **Permission:** `store/sensitive`
538
+
537
539
  #### Parameters
538
540
 
539
541
  | Parameter | Type | Location | Required | Description |
540
- |-----------|------|----------|----------|-------------|
542
+ | --- | --- | --- | --- | --- |
541
543
  | `search` | string | query | No | Search classes by name |
542
- | `per_page` | integer | query | No | Number of results per page (default: 10, max: 200) |
544
+ | `per_page` | integer | query | No | Number of results per page (default: `10`, max: `200`) |
543
545
  | `page` | integer | query | No | Page number for pagination |
544
546
  | `sort_by` | string | query | No | Column to sort by (default: `id`) |
545
547
  | `sort_type` | string | query | No | Sort direction: `asc` or `desc` (default: `desc`) |
@@ -547,7 +549,7 @@ Retrieve a paginated list of shipping classes with filtering and sorting capabil
547
549
 
548
550
  #### Response
549
551
 
550
- ```json
552
+ ```
551
553
  {
552
554
  "shipping_classes": {
553
555
  "total": 3,
@@ -580,7 +582,7 @@ Retrieve a paginated list of shipping classes with filtering and sorting capabil
580
582
 
581
583
  #### Example
582
584
 
583
- ```bash
585
+ ```
584
586
  curl -X GET "https://example.com/wp-json/fluent-cart/v2/shipping/classes?search=heavy&per_page=20" \
585
587
  -u "username:app_password"
586
588
  ```
@@ -589,24 +591,26 @@ curl -X GET "https://example.com/wp-json/fluent-cart/v2/shipping/classes?search=
589
591
 
590
592
  ### Create Shipping Class
591
593
 
592
- `POST /fluent-cart/v2/shipping/classes`
594
+ POST `/fluent-cart/v2/shipping/classes`
593
595
 
594
596
  Create a new shipping class.
595
597
 
596
- **Request Class:** `ShippingClassRequest`
598
+ - **Permission:** `store/sensitive`
599
+ - **Request Class:** `ShippingClassRequest`
597
600
 
598
601
  #### Parameters
599
602
 
600
603
  | Parameter | Type | Location | Required | Description |
601
- |-----------|------|----------|----------|-------------|
604
+ | --- | --- | --- | --- | --- |
602
605
  | `name` | string | body | Yes | Class name (max 192 characters) |
603
- | `cost` | numeric | body | Yes | Cost value (minimum: 0). Flat amount for fixed type, percentage value for percentage type |
606
+ | `description` | string | body | No | Class description (max 500 characters) |
607
+ | `cost` | numeric | body | Yes | Cost value (minimum: `0`). For `fixed` type, a flat surcharge in major units, not cents. For `percentage` type, a percentage value. |
604
608
  | `type` | string | body | Yes | Cost type: `fixed` or `percentage` |
605
609
  | `per_item` | integer | body | No | Apply cost per item (`1`) or per order (`0`). Default: `0` |
606
610
 
607
611
  #### Response
608
612
 
609
- ```json
613
+ ```
610
614
  {
611
615
  "shipping_class": {
612
616
  "id": 3,
@@ -623,7 +627,7 @@ Create a new shipping class.
623
627
 
624
628
  #### Example
625
629
 
626
- ```bash
630
+ ```
627
631
  curl -X POST "https://example.com/wp-json/fluent-cart/v2/shipping/classes" \
628
632
  -u "username:app_password" \
629
633
  -H "Content-Type: application/json" \
@@ -639,19 +643,21 @@ curl -X POST "https://example.com/wp-json/fluent-cart/v2/shipping/classes" \
639
643
 
640
644
  ### Get Shipping Class
641
645
 
642
- `GET /fluent-cart/v2/shipping/classes/{id}`
646
+ GET `/fluent-cart/v2/shipping/classes/{id}`
643
647
 
644
648
  Retrieve a single shipping class by ID.
645
649
 
650
+ - **Permission:** `store/sensitive`
651
+
646
652
  #### Parameters
647
653
 
648
654
  | Parameter | Type | Location | Required | Description |
649
- |-----------|------|----------|----------|-------------|
655
+ | --- | --- | --- | --- | --- |
650
656
  | `id` | integer | path | Yes | The shipping class ID |
651
657
 
652
658
  #### Response
653
659
 
654
- ```json
660
+ ```
655
661
  {
656
662
  "shipping_class": {
657
663
  "id": 1,
@@ -667,7 +673,7 @@ Retrieve a single shipping class by ID.
667
673
 
668
674
  #### Example
669
675
 
670
- ```bash
676
+ ```
671
677
  curl -X GET "https://example.com/wp-json/fluent-cart/v2/shipping/classes/1" \
672
678
  -u "username:app_password"
673
679
  ```
@@ -676,25 +682,26 @@ curl -X GET "https://example.com/wp-json/fluent-cart/v2/shipping/classes/1" \
676
682
 
677
683
  ### Update Shipping Class
678
684
 
679
- `PUT /fluent-cart/v2/shipping/classes/{id}`
685
+ PUT `/fluent-cart/v2/shipping/classes/{id}`
680
686
 
681
687
  Update an existing shipping class.
682
688
 
683
- **Request Class:** `ShippingClassRequest`
689
+ - **Permission:** `store/sensitive`
690
+ - **Request Class:** `ShippingClassRequest`
684
691
 
685
692
  #### Parameters
686
693
 
687
694
  | Parameter | Type | Location | Required | Description |
688
- |-----------|------|----------|----------|-------------|
695
+ | --- | --- | --- | --- | --- |
689
696
  | `id` | integer | path | Yes | The shipping class ID |
690
697
  | `name` | string | body | Yes | Class name (max 192 characters) |
691
- | `cost` | numeric | body | Yes | Cost value (minimum: 0) |
698
+ | `cost` | numeric | body | Yes | Cost value (minimum: `0`) |
692
699
  | `type` | string | body | Yes | Cost type: `fixed` or `percentage` |
693
700
  | `per_item` | integer | body | No | Apply cost per item (`1`) or per order (`0`). Default: `0` |
694
701
 
695
702
  #### Response
696
703
 
697
- ```json
704
+ ```
698
705
  {
699
706
  "shipping_class": {
700
707
  "id": 1,
@@ -711,7 +718,7 @@ Update an existing shipping class.
711
718
 
712
719
  #### Example
713
720
 
714
- ```bash
721
+ ```
715
722
  curl -X PUT "https://example.com/wp-json/fluent-cart/v2/shipping/classes/1" \
716
723
  -u "username:app_password" \
717
724
  -H "Content-Type: application/json" \
@@ -727,19 +734,21 @@ curl -X PUT "https://example.com/wp-json/fluent-cart/v2/shipping/classes/1" \
727
734
 
728
735
  ### Delete Shipping Class
729
736
 
730
- `DELETE /fluent-cart/v2/shipping/classes/{id}`
737
+ DELETE `/fluent-cart/v2/shipping/classes/{id}`
731
738
 
732
739
  Delete a shipping class by ID.
733
740
 
741
+ - **Permission:** `store/sensitive`
742
+
734
743
  #### Parameters
735
744
 
736
745
  | Parameter | Type | Location | Required | Description |
737
- |-----------|------|----------|----------|-------------|
746
+ | --- | --- | --- | --- | --- |
738
747
  | `id` | integer | path | Yes | The shipping class ID |
739
748
 
740
749
  #### Response
741
750
 
742
- ```json
751
+ ```
743
752
  {
744
753
  "message": "Shipping class has been deleted successfully"
745
754
  }
@@ -747,41 +756,136 @@ Delete a shipping class by ID.
747
756
 
748
757
  #### Example
749
758
 
750
- ```bash
759
+ ```
751
760
  curl -X DELETE "https://example.com/wp-json/fluent-cart/v2/shipping/classes/1" \
752
761
  -u "username:app_password"
753
762
  ```
754
763
 
755
764
  ---
756
765
 
766
+ ### Get Shipping Class Profile
767
+
768
+ Return one shipping class with its zones and each zone's methods eager-loaded.
769
+
770
+ ```
771
+ GET /wp-json/fluent-cart/v2/shipping/classes/{id}/profile
772
+ ```
773
+
774
+ - **Permission:** `store/sensitive`
775
+ - Unknown `id` returns a 404 (`findOrFail`).
776
+
777
+ #### Response
778
+
779
+ ```
780
+ {
781
+ "shipping_class": {
782
+ "id": 2,
783
+ "name": "Bulky",
784
+ "description": "Oversized items",
785
+ "cost": "7.50",
786
+ "type": "fixed",
787
+ "per_item": 0,
788
+ "zones": [
789
+ { "id": 5, "name": "Europe", "region": "selection", "methods": [] }
790
+ ]
791
+ }
792
+ }
793
+ ```
794
+
795
+ ---
796
+
797
+ ### Get Countries by Continent
798
+
799
+ Countries grouped by continent, for building zone pickers.
800
+
801
+ ```
802
+ GET /wp-json/fluent-cart/v2/shipping/zone/countries
803
+ ```
804
+
805
+ - **Permission:** `store/sensitive`
806
+ - Continents with no known countries are omitted.
807
+
808
+ #### Response
809
+
810
+ ```
811
+ {
812
+ "data": {
813
+ "EU": {
814
+ "name": "Europe",
815
+ "countries": [
816
+ { "code": "DE", "name": "Germany" },
817
+ { "code": "FR", "name": "France" }
818
+ ]
819
+ }
820
+ }
821
+ }
822
+ ```
823
+
824
+ ---
825
+
826
+ ## Shipping Packages
827
+
828
+ Packages are stored as the `shipping_packages` store option, not in a database table.
829
+
830
+ ### Get Shipping Packages
831
+
832
+ ```
833
+ GET /wp-json/fluent-cart/v2/shipping/packages
834
+ ```
835
+
836
+ - **Permission:** `store/sensitive`
837
+ - Returns `{ "packages": [] }` when none are configured.
838
+
839
+ ### Save Shipping Packages
840
+
841
+ ```
842
+ POST /wp-json/fluent-cart/v2/shipping/packages
843
+ ```
844
+
845
+ - **Permission:** `store/sensitive`
846
+ - Replaces the whole list. A non-array `packages` value is stored as an empty list.
847
+ - At most **50** packages are kept; the rest are dropped.
848
+ - `type` must be one of `box`, `envelope`, `soft_package`.
849
+ - Dimension units: `cm`, `mm`, `in`, `m`. Weight units: `kg`, `g`, `lbs`, `oz`.
850
+
851
+ #### Parameters
852
+
853
+ | Parameter | Type | Location | Required | Description |
854
+ | --- | --- | --- | --- | --- |
855
+ | `packages` | array | body | Yes | The full package list; capped at 50 entries |
856
+
857
+ ---
858
+
757
859
  ## Data Models
758
860
 
759
861
  ### Shipping Zone Object
760
862
 
761
863
  | Field | Type | Description |
762
- |-------|------|-------------|
864
+ | --- | --- | --- |
763
865
  | `id` | integer | Unique zone identifier |
764
866
  | `name` | string | Zone display name |
765
- | `region` | string | ISO 3166-1 alpha-2 country code or `all` for worldwide |
867
+ | `region` | string | ISO 3166-1 alpha-2 country code, `all` for worldwide, or `selection` for several countries |
868
+ | `shipping_class_id` | integer | Scopes the zone to one shipping class; `null` means it applies to class-less items |
869
+ | `meta` | object | For `selection` zones: `countries` and `selection_type` (`included` / `excluded`) |
766
870
  | `order` | integer | Sort order for display priority |
767
871
  | `formatted_region` | string | Human-readable region name (computed) |
768
- | `methods` | array | Associated shipping methods (included when fetching single zone) |
872
+ | `methods` | array | Associated shipping methods (included when using `show` endpoint) |
769
873
  | `created_at` | string | Creation timestamp (UTC) |
770
874
  | `updated_at` | string | Last update timestamp (UTC) |
771
875
 
772
876
  ### Shipping Method Object
773
877
 
774
878
  | Field | Type | Description |
775
- |-------|------|-------------|
879
+ | --- | --- | --- |
776
880
  | `id` | integer | Unique method identifier |
777
881
  | `zone_id` | integer | Parent shipping zone ID |
778
882
  | `title` | string | Method display title |
779
883
  | `type` | string | Method type (e.g., `flat_rate`, `free_shipping`, `local_pickup`) |
780
- | `amount` | integer | Shipping cost in cents |
884
+ | `amount` | string | Base rate as a decimal in major units (`"5.00"`); a percentage when `settings.configure_rate` is `per_price` |
781
885
  | `is_enabled` | boolean | Whether the method is active |
782
- | `states` | array | State/province codes this method applies to (empty array = all states) |
783
- | `settings` | object | Additional configuration settings (`configure_rate`, `class_aggregation`) |
784
- | `meta` | object | Additional metadata key-value pairs |
886
+ | `states` | array | State/province codes this method applies to (empty = all states) |
887
+ | `settings` | object | Additional configuration settings |
888
+ | `meta` | object | Additional metadata |
785
889
  | `order` | integer | Sort order within the zone |
786
890
  | `formatted_states` | array | Human-readable state names (computed) |
787
891
  | `created_at` | string | Creation timestamp (UTC) |
@@ -790,11 +894,12 @@ curl -X DELETE "https://example.com/wp-json/fluent-cart/v2/shipping/classes/1" \
790
894
  ### Shipping Class Object
791
895
 
792
896
  | Field | Type | Description |
793
- |-------|------|-------------|
897
+ | --- | --- | --- |
794
898
  | `id` | integer | Unique class identifier |
795
899
  | `name` | string | Class display name |
796
- | `cost` | float | Cost value (flat amount or percentage, depending on type) |
900
+ | `description` | string | Class description (max 500 characters) |
901
+ | `cost` | float | Surcharge in major units, not cents (or a percentage when `type` is `percentage`) |
797
902
  | `type` | string | Cost type: `fixed` or `percentage` |
798
903
  | `per_item` | integer | `1` = cost applied per item, `0` = cost applied per order |
799
904
  | `created_at` | string | Creation timestamp (UTC) |
800
- | `updated_at` | string | Last update timestamp (UTC) |
905
+ | `updated_at` | string | Last update timestamp (UTC) |