fluentcart-developer 2.3.4 → 3.0.1

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