fluentcart-developer 3.0.0 → 3.0.2

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 (612) hide show
  1. package/LICENSE.md +26 -26
  2. package/README.md +59 -59
  3. package/dist/cards/fluentcart/templates-native.js +1087 -1087
  4. package/dist/cards/fluentcart/tools.js +2309 -2309
  5. package/dist/server.d.ts.map +1 -1
  6. package/dist/server.js +37 -1
  7. package/dist/server.js.map +1 -1
  8. package/dist/skills/fluentcart-developer/SKILL.md +108 -108
  9. package/dist/skills/fluentcart-developer/examples/README.md +30 -30
  10. package/dist/skills/fluentcart-developer/examples/fluentcart-starter-child-theme/fluent-cart/checkout.php +32 -32
  11. package/dist/skills/fluentcart-developer/examples/fluentcart-starter-child-theme/functions.php +40 -40
  12. package/dist/skills/fluentcart-developer/examples/sample-custom-addon/fluentcart-custom-addon.php +113 -113
  13. package/dist/skills/fluentcart-developer/examples/sample-custom-payment-gateway/fluentcart-custom-gateway-example.php +148 -148
  14. package/dist/skills/fluentcart-developer/examples/sample-fee-surcharge-plugin/fluentcart-fee-surcharge.php +38 -38
  15. package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/README.md +22 -22
  16. package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/sample-plugin-with-licensing-sdk.php +79 -79
  17. package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/updater/FluentLicensing.php +303 -303
  18. package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/updater/LicenseSettings.php +566 -566
  19. package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/updater/PluginUpdater.php +304 -304
  20. package/dist/skills/fluentcart-developer/examples/sample-shipping-carrier/fluentcart-custom-shipping-carrier.php +61 -61
  21. package/dist/skills/fluentcart-developer/references/api/authentication.md +452 -452
  22. package/dist/skills/fluentcart-developer/references/api/coupons.md +786 -786
  23. package/dist/skills/fluentcart-developer/references/api/customers.md +889 -889
  24. package/dist/skills/fluentcart-developer/references/api/files.md +609 -609
  25. package/dist/skills/fluentcart-developer/references/api/index.md +432 -432
  26. package/dist/skills/fluentcart-developer/references/api/licensing.md +633 -633
  27. package/dist/skills/fluentcart-developer/references/api/order-bump.md +384 -384
  28. package/dist/skills/fluentcart-developer/references/api/orders.md +814 -814
  29. package/dist/skills/fluentcart-developer/references/api/products.md +866 -866
  30. package/dist/skills/fluentcart-developer/references/api/roles-permissions.md +536 -536
  31. package/dist/skills/fluentcart-developer/references/api/subscriptions.md +827 -827
  32. package/dist/skills/fluentcart-developer/references/database/index.md +44 -44
  33. package/dist/skills/fluentcart-developer/references/database/models/activity.md +178 -178
  34. package/dist/skills/fluentcart-developer/references/database/models/applied-coupon.md +291 -291
  35. package/dist/skills/fluentcart-developer/references/database/models/attribute-group.md +239 -239
  36. package/dist/skills/fluentcart-developer/references/database/models/attribute-relation.md +181 -181
  37. package/dist/skills/fluentcart-developer/references/database/models/attribute-term.md +219 -219
  38. package/dist/skills/fluentcart-developer/references/database/models/cart.md +645 -645
  39. package/dist/skills/fluentcart-developer/references/database/models/coupon.md +427 -427
  40. package/dist/skills/fluentcart-developer/references/database/models/customer-addresses.md +348 -348
  41. package/dist/skills/fluentcart-developer/references/database/models/customer-meta.md +156 -156
  42. package/dist/skills/fluentcart-developer/references/database/models/customer.md +584 -584
  43. package/dist/skills/fluentcart-developer/references/database/models/dynamic-model.md +163 -163
  44. package/dist/skills/fluentcart-developer/references/database/models/label-relationship.md +155 -155
  45. package/dist/skills/fluentcart-developer/references/database/models/label.md +153 -153
  46. package/dist/skills/fluentcart-developer/references/database/models/license-activation.md +182 -182
  47. package/dist/skills/fluentcart-developer/references/database/models/license-meta.md +163 -163
  48. package/dist/skills/fluentcart-developer/references/database/models/license-site.md +208 -208
  49. package/dist/skills/fluentcart-developer/references/database/models/license.md +640 -640
  50. package/dist/skills/fluentcart-developer/references/database/models/meta.md +233 -233
  51. package/dist/skills/fluentcart-developer/references/database/models/order-address.md +391 -391
  52. package/dist/skills/fluentcart-developer/references/database/models/order-download-permission.md +144 -144
  53. package/dist/skills/fluentcart-developer/references/database/models/order-item.md +383 -383
  54. package/dist/skills/fluentcart-developer/references/database/models/order-meta.md +303 -303
  55. package/dist/skills/fluentcart-developer/references/database/models/order-operation.md +158 -158
  56. package/dist/skills/fluentcart-developer/references/database/models/order-promotion-stat.md +175 -175
  57. package/dist/skills/fluentcart-developer/references/database/models/order-promotion.md +250 -250
  58. package/dist/skills/fluentcart-developer/references/database/models/order-tax-rate.md +172 -172
  59. package/dist/skills/fluentcart-developer/references/database/models/order-transaction.md +440 -440
  60. package/dist/skills/fluentcart-developer/references/database/models/order.md +727 -727
  61. package/dist/skills/fluentcart-developer/references/database/models/product-detail.md +397 -397
  62. package/dist/skills/fluentcart-developer/references/database/models/product-download.md +258 -258
  63. package/dist/skills/fluentcart-developer/references/database/models/product-meta.md +153 -153
  64. package/dist/skills/fluentcart-developer/references/database/models/product-variation.md +556 -556
  65. package/dist/skills/fluentcart-developer/references/database/models/product.md +580 -580
  66. package/dist/skills/fluentcart-developer/references/database/models/relationships.md +427 -427
  67. package/dist/skills/fluentcart-developer/references/database/models/scheduled-action.md +175 -175
  68. package/dist/skills/fluentcart-developer/references/database/models/shipping-class.md +148 -148
  69. package/dist/skills/fluentcart-developer/references/database/models/shipping-method.md +280 -280
  70. package/dist/skills/fluentcart-developer/references/database/models/shipping-zone.md +205 -205
  71. package/dist/skills/fluentcart-developer/references/database/models/subscription-meta.md +173 -173
  72. package/dist/skills/fluentcart-developer/references/database/models/subscription.md +528 -528
  73. package/dist/skills/fluentcart-developer/references/database/models/tax-class.md +195 -195
  74. package/dist/skills/fluentcart-developer/references/database/models/tax-rate.md +225 -225
  75. package/dist/skills/fluentcart-developer/references/database/models/user-meta.md +166 -166
  76. package/dist/skills/fluentcart-developer/references/database/models/user.md +220 -220
  77. package/dist/skills/fluentcart-developer/references/database/models.md +404 -404
  78. package/dist/skills/fluentcart-developer/references/database/query-builder.md +860 -860
  79. package/dist/skills/fluentcart-developer/references/database/readme.md +276 -276
  80. package/dist/skills/fluentcart-developer/references/database/schema.md +1002 -1002
  81. package/dist/skills/fluentcart-developer/references/engineering/adding-custom-pages-to-the-customer-dashboard.md +395 -395
  82. package/dist/skills/fluentcart-developer/references/engineering/index.md +4 -4
  83. package/dist/skills/fluentcart-developer/references/engineering.md +4 -4
  84. package/dist/skills/fluentcart-developer/references/getting-started.md +249 -249
  85. package/dist/skills/fluentcart-developer/references/guides/frontend.md +519 -519
  86. package/dist/skills/fluentcart-developer/references/guides/index.md +107 -107
  87. package/dist/skills/fluentcart-developer/references/guides/integrations.md +600 -600
  88. package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/index.md +237 -237
  89. package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/labels-and-tracking.md +481 -481
  90. package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/live-rates.md +269 -269
  91. package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/reference.md +223 -223
  92. package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/settings.md +370 -370
  93. package/dist/skills/fluentcart-developer/references/guides/shipping-carrier.md +237 -237
  94. package/dist/skills/fluentcart-developer/references/guides/subscriptions.md +217 -217
  95. package/dist/skills/fluentcart-developer/references/hooks/actions/admin-and-templates.md +1079 -1079
  96. package/dist/skills/fluentcart-developer/references/hooks/actions/cart-and-checkout.md +1795 -1795
  97. package/dist/skills/fluentcart-developer/references/hooks/actions/customers-and-users.md +327 -327
  98. package/dist/skills/fluentcart-developer/references/hooks/actions/licenses.md +829 -829
  99. package/dist/skills/fluentcart-developer/references/hooks/actions/modules.md +81 -81
  100. package/dist/skills/fluentcart-developer/references/hooks/actions/orders.md +757 -757
  101. package/dist/skills/fluentcart-developer/references/hooks/actions/payments-and-integrations.md +1163 -1163
  102. package/dist/skills/fluentcart-developer/references/hooks/actions/pro-modules.md +219 -219
  103. package/dist/skills/fluentcart-developer/references/hooks/actions/products-and-coupons.md +1019 -1019
  104. package/dist/skills/fluentcart-developer/references/hooks/actions/subscriptions.md +1290 -1290
  105. package/dist/skills/fluentcart-developer/references/hooks/actions.md +16 -16
  106. package/dist/skills/fluentcart-developer/references/hooks/deprecated.md +60 -60
  107. package/dist/skills/fluentcart-developer/references/hooks/filters/cart-and-checkout.md +2032 -2032
  108. package/dist/skills/fluentcart-developer/references/hooks/filters/customers-and-subscriptions.md +1746 -1746
  109. package/dist/skills/fluentcart-developer/references/hooks/filters/integrations-and-advanced.md +2439 -2439
  110. package/dist/skills/fluentcart-developer/references/hooks/filters/modules.md +464 -464
  111. package/dist/skills/fluentcart-developer/references/hooks/filters/orders-and-payments.md +2658 -2658
  112. package/dist/skills/fluentcart-developer/references/hooks/filters/pro-modules.md +502 -502
  113. package/dist/skills/fluentcart-developer/references/hooks/filters/products-and-pricing.md +1785 -1785
  114. package/dist/skills/fluentcart-developer/references/hooks/filters/settings-and-configuration.md +2966 -2966
  115. package/dist/skills/fluentcart-developer/references/hooks/filters.md +14 -14
  116. package/dist/skills/fluentcart-developer/references/hooks/index.md +35 -35
  117. package/dist/skills/fluentcart-developer/references/index.md +625 -625
  118. package/dist/skills/fluentcart-developer/references/modules/fee-system.md +427 -427
  119. package/dist/skills/fluentcart-developer/references/modules/ghost-product-selling.md +440 -440
  120. package/dist/skills/fluentcart-developer/references/modules/index.md +484 -484
  121. package/dist/skills/fluentcart-developer/references/modules/licensing.md +342 -342
  122. package/dist/skills/fluentcart-developer/references/modules/order-bump.md +433 -433
  123. package/dist/skills/fluentcart-developer/references/modules/payment-methods.md +129 -129
  124. package/dist/skills/fluentcart-developer/references/modules/refunds.md +170 -170
  125. package/dist/skills/fluentcart-developer/references/modules/shipping.md +846 -846
  126. package/dist/skills/fluentcart-developer/references/modules/storage.md +986 -986
  127. package/dist/skills/fluentcart-developer/references/modules/subscription-vendor-ids.md +186 -186
  128. package/dist/skills/fluentcart-developer/references/modules/subscriptions.md +678 -678
  129. package/dist/skills/fluentcart-developer/references/payment-methods-integration/index.md +164 -164
  130. package/dist/skills/fluentcart-developer/references/payment-methods-integration/paddle-example.md +1648 -1648
  131. package/dist/skills/fluentcart-developer/references/payment-methods-integration/payment/setting/fields.md +353 -353
  132. package/dist/skills/fluentcart-developer/references/payment-methods-integration/quick-implementation.md +1079 -1079
  133. package/dist/skills/fluentcart-developer/references/payment-methods-integration.md +164 -164
  134. package/dist/skills/fluentcart-developer/references/restapi/checkout.md +573 -573
  135. package/dist/skills/fluentcart-developer/references/restapi/coupons.md +958 -958
  136. package/dist/skills/fluentcart-developer/references/restapi/customer-profile.md +1423 -1423
  137. package/dist/skills/fluentcart-developer/references/restapi/customers.md +1103 -1103
  138. package/dist/skills/fluentcart-developer/references/restapi/dashboard.md +1083 -1083
  139. package/dist/skills/fluentcart-developer/references/restapi/data-export.md +132 -132
  140. package/dist/skills/fluentcart-developer/references/restapi/email-notifications.md +846 -846
  141. package/dist/skills/fluentcart-developer/references/restapi/files.md +313 -313
  142. package/dist/skills/fluentcart-developer/references/restapi/index.md +127 -127
  143. package/dist/skills/fluentcart-developer/references/restapi/integrations.md +1000 -1000
  144. package/dist/skills/fluentcart-developer/references/restapi/inventory.md +192 -192
  145. package/dist/skills/fluentcart-developer/references/restapi/labels-and-attributes.md +797 -797
  146. package/dist/skills/fluentcart-developer/references/restapi/licensing.md +1733 -1733
  147. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-available-shipping-methods.md +30 -30
  148. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-checkout-summary.md +28 -28
  149. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-country-info.md +29 -29
  150. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-order-info.md +28 -28
  151. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-shipping-methods-list-view.md +30 -30
  152. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/login.md +66 -66
  153. package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/place-order.md +179 -179
  154. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/apply-coupon.md +83 -83
  155. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/cancel-coupon.md +87 -87
  156. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/check-product-eligibility.md +59 -59
  157. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/create-coupon.md +230 -230
  158. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/delete-coupon.md +29 -29
  159. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/get-coupon-settings.md +20 -20
  160. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/get-coupon.md +27 -27
  161. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/list-coupon-codes.md +20 -20
  162. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/list-coupons.md +37 -37
  163. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/re-apply-coupons.md +75 -75
  164. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/store-coupon-settings.md +40 -40
  165. package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/update-coupon.md +133 -133
  166. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/create-address-checkout.md +138 -138
  167. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/create-profile-address.md +119 -119
  168. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/dashboard-overview.md +22 -22
  169. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/delete-profile-address.md +46 -46
  170. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-order-details.md +30 -30
  171. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-portal-sections.md +29 -29
  172. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-profile-details.md +22 -22
  173. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-transaction-billing-address.md +30 -30
  174. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-upgrade-paths.md +31 -31
  175. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/list-downloads.md +29 -29
  176. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/list-orders.md +28 -28
  177. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/make-profile-address-primary.md +55 -55
  178. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/pause-subscription.md +29 -29
  179. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/resume-subscription.md +29 -29
  180. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/save-transaction-billing-address.md +92 -92
  181. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/select-address-for-checkout.md +32 -32
  182. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/update-profile-address.md +115 -115
  183. package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/update-profile-details.md +69 -69
  184. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/attach-user.md +50 -50
  185. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/bulk-actions.md +65 -65
  186. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/create-address.md +135 -135
  187. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/create-customer.md +108 -108
  188. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/delete-address.md +62 -62
  189. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/detach-user.md +28 -28
  190. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/find-customer-order.md +27 -27
  191. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-attachable-users.md +20 -20
  192. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer-addresses.md +28 -28
  193. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer-orders.md +37 -37
  194. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer-stats.md +27 -27
  195. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer.md +32 -32
  196. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/list-customers.md +37 -37
  197. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/recalculate-ltv.md +28 -28
  198. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/set-primary-address.md +72 -72
  199. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/update-additional-info.md +55 -55
  200. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/update-address.md +144 -144
  201. package/dist/skills/fluentcart-developer/references/restapi/operations/customers/update-customer.md +123 -123
  202. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/attach-note-to-order.md +49 -49
  203. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/create-all-pages.md +21 -21
  204. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/create-single-page.md +55 -55
  205. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/delete-activity.md +28 -28
  206. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-country-info.md +29 -29
  207. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-dashboard-stats.md +22 -22
  208. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-filter-options.md +31 -31
  209. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-onboarding-data.md +20 -20
  210. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-onboarding-settings.md +20 -20
  211. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-print-templates.md +20 -20
  212. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-search-options.md +27 -27
  213. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-widgets.md +28 -28
  214. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/initialize-app.md +20 -20
  215. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/list-activities.md +33 -33
  216. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/list-attachments.md +21 -21
  217. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/list-countries.md +20 -20
  218. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/mark-activity-read.md +53 -53
  219. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/run-data-backfills.md +21 -21
  220. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/save-onboarding-settings.md +54 -54
  221. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/save-onboarding-tax-settings.md +73 -73
  222. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/save-print-templates.md +64 -64
  223. package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/upload-attachment.md +42 -42
  224. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-customers-batch.md +129 -129
  225. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-licenses-batch.md +133 -133
  226. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-orders-batch.md +129 -129
  227. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-subscriptions-batch.md +129 -129
  228. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-customers-export-schema.md +21 -21
  229. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-licenses-export-schema.md +26 -26
  230. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-orders-export-schema.md +21 -21
  231. package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-subscriptions-export-schema.md +21 -21
  232. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/enable-notification.md +57 -57
  233. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-digest-settings.md +22 -22
  234. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-notification.md +30 -30
  235. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-reminders.md +22 -22
  236. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-settings.md +22 -22
  237. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-shortcodes.md +22 -22
  238. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/list-notifications.md +20 -20
  239. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/preview-default-template.md +66 -66
  240. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/preview-notification.md +50 -50
  241. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/save-digest-settings.md +101 -101
  242. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/save-reminders.md +162 -162
  243. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/save-settings.md +99 -99
  244. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/send-digest-test.md +47 -47
  245. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/send-manual-reminder.md +51 -51
  246. package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/update-notification.md +93 -93
  247. package/dist/skills/fluentcart-developer/references/restapi/operations/files/delete-file.md +31 -31
  248. package/dist/skills/fluentcart-developer/references/restapi/operations/files/get-bucket-list.md +28 -28
  249. package/dist/skills/fluentcart-developer/references/restapi/operations/files/list-files.md +30 -30
  250. package/dist/skills/fluentcart-developer/references/restapi/operations/files/upload-editor-file.md +32 -32
  251. package/dist/skills/fluentcart-developer/references/restapi/operations/files/upload-file.md +34 -34
  252. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/chained-data-request.md +46 -46
  253. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/change-feed-status.md +51 -51
  254. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/delete-feed.md +27 -27
  255. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-dynamic-options.md +29 -29
  256. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-feed-lists.md +27 -27
  257. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-feed-settings.md +27 -27
  258. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-global-feeds.md +20 -20
  259. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-global-settings.md +26 -26
  260. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/install-addon-plugin.md +49 -49
  261. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/list-addons.md +20 -20
  262. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/save-feed-settings.md +52 -52
  263. package/dist/skills/fluentcart-developer/references/restapi/operations/integration/set-global-settings.md +50 -50
  264. package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/bulk-update-stock.md +94 -94
  265. package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/export-inventory.md +81 -81
  266. package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/get-adjustment-history.md +26 -26
  267. package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/get-inventory-stats.md +21 -21
  268. package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/list-inventory.md +33 -33
  269. package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/update-stock.md +75 -75
  270. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/create-attribute-group.md +31 -31
  271. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/create-label.md +31 -31
  272. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/create-terms.md +90 -90
  273. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/delete-attribute-group.md +28 -28
  274. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/delete-attribute-term.md +29 -29
  275. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/get-attribute-group.md +28 -28
  276. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/get-attribute-library.md +20 -20
  277. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/list-attribute-groups.md +32 -32
  278. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/list-attribute-terms.md +33 -33
  279. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/list-labels.md +20 -20
  280. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/reorder-groups.md +51 -51
  281. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/reorder-terms.md +56 -56
  282. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/update-attribute-group.md +37 -37
  283. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/update-attribute-term.md +39 -39
  284. package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/update-label-selections.md +32 -32
  285. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/activate-plugin-license.md +41 -41
  286. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/activate-site-admin.md +60 -60
  287. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/deactivate-plugin-license.md +18 -18
  288. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/deactivate-site-admin.md +67 -67
  289. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/deactivate-site-customer.md +47 -47
  290. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/delete-license.md +24 -24
  291. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/extend-license-validity.md +47 -47
  292. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-customer-license-details.md +25 -25
  293. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-customer-licenses-admin.md +26 -26
  294. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-license-activations.md +25 -25
  295. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-license-details.md +25 -25
  296. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-license-site.md +30 -30
  297. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-plugin-license-status.md +18 -18
  298. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-product-license-settings.md +24 -24
  299. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/list-customer-licenses.md +25 -25
  300. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/list-license-sites.md +33 -33
  301. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/list-licenses.md +38 -38
  302. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-activate-license.md +54 -54
  303. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-check-license.md +26 -26
  304. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-deactivate-license.md +46 -46
  305. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-download-license-package.md +23 -23
  306. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-get-license-version.md +26 -26
  307. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/regenerate-license-key.md +24 -24
  308. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/save-product-license-settings.md +193 -193
  309. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/update-license-activation-limit.md +53 -53
  310. package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/update-license-status.md +52 -52
  311. package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/create-order-bump.md +47 -47
  312. package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/delete-order-bump.md +25 -25
  313. package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/get-order-bump.md +25 -25
  314. package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/list-order-bumps.md +29 -29
  315. package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/update-order-bump.md +141 -141
  316. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/accept-dispute.md +47 -47
  317. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/bulk-actions.md +72 -72
  318. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/calculate-shipping.md +67 -67
  319. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/calculate-tax.md +98 -98
  320. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/change-customer.md +50 -50
  321. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/charge-now.md +29 -29
  322. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-and-change-customer.md +92 -92
  323. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-custom-order-item.md +68 -68
  324. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-order.md +351 -351
  325. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-renewal-now.md +29 -29
  326. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/delete-order.md +28 -28
  327. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/generate-missing-licenses.md +29 -29
  328. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-order-transactions.md +27 -27
  329. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-order.md +27 -27
  330. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-renewal.md +28 -28
  331. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-shipping-methods.md +28 -28
  332. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-single-transaction.md +28 -28
  333. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/list-order-currencies.md +22 -22
  334. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/list-orders.md +42 -42
  335. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/list-renewals.md +28 -28
  336. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/mark-as-paid.md +61 -61
  337. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/price-order.md +135 -135
  338. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/refund-order.md +72 -72
  339. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/resend-renewal-invoice.md +29 -29
  340. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/skip-renewal.md +48 -48
  341. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/sync-order-statuses.md +28 -28
  342. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/sync-pending-transaction.md +29 -29
  343. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-order-address-id.md +60 -60
  344. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-order-address.md +98 -98
  345. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-order.md +172 -172
  346. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-statuses.md +77 -77
  347. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-subscription-details.md +84 -84
  348. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-transaction-status.md +51 -51
  349. package/dist/skills/fluentcart-developer/references/restapi/operations/orders/void-renewal.md +30 -30
  350. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/create-pdf-template.md +42 -42
  351. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/delete-pdf-template.md +26 -26
  352. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/download-pdf-preview.md +44 -44
  353. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-factory-default-templates.md +19 -19
  354. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-pdf-status.md +21 -21
  355. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-pdf-template.md +26 -26
  356. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-saved-templates.md +21 -21
  357. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-seller-details.md +19 -19
  358. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/list-pdf-templates.md +19 -19
  359. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/save-pdf-template.md +53 -53
  360. package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/save-seller-details.md +97 -97
  361. package/dist/skills/fluentcart-developer/references/restapi/operations/products/add-product-terms.md +64 -64
  362. package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-edit-fetch.md +30 -30
  363. package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-insert-products.md +62 -62
  364. package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-update-products.md +59 -59
  365. package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-update-variants.md +83 -83
  366. package/dist/skills/fluentcart-developer/references/restapi/operations/products/change-integration-status.md +64 -64
  367. package/dist/skills/fluentcart-developer/references/restapi/operations/products/create-dummy-products.md +45 -45
  368. package/dist/skills/fluentcart-developer/references/restapi/operations/products/create-product.md +81 -81
  369. package/dist/skills/fluentcart-developer/references/restapi/operations/products/create-variation.md +181 -181
  370. package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-downloadable-file.md +27 -27
  371. package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-product-integration.md +30 -30
  372. package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-product.md +27 -27
  373. package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-taxonomy-term.md +55 -55
  374. package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-upgrade-path.md +27 -27
  375. package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-variation.md +27 -27
  376. package/dist/skills/fluentcart-developer/references/restapi/operations/products/do-bulk-action.md +56 -56
  377. package/dist/skills/fluentcart-developer/references/restapi/operations/products/duplicate-product.md +56 -56
  378. package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-products-by-ids.md +26 -26
  379. package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-taxonomy-terms.md +20 -20
  380. package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-terms-by-parent.md +60 -60
  381. package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-variations-by-ids.md +26 -26
  382. package/dist/skills/fluentcart-developer/references/restapi/operations/products/find-subscription-variants.md +26 -26
  383. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-bundle-info.md +27 -27
  384. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-downloadable-url.md +27 -27
  385. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-max-excerpt-word-count.md +20 -20
  386. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-pricing-widgets.md +27 -27
  387. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product-integration-feeds.md +29 -29
  388. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product-integration-settings.md +31 -31
  389. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product-pricing.md +28 -28
  390. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product.md +28 -28
  391. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-related-products.md +31 -31
  392. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-upgrade-settings.md +27 -27
  393. package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-variation-upgrade-paths.md +28 -28
  394. package/dist/skills/fluentcart-developer/references/restapi/operations/products/group-bulk-update-variants.md +103 -103
  395. package/dist/skills/fluentcart-developer/references/restapi/operations/products/list-all-variants.md +26 -26
  396. package/dist/skills/fluentcart-developer/references/restapi/operations/products/list-product-variations.md +26 -26
  397. package/dist/skills/fluentcart-developer/references/restapi/operations/products/list-products.md +34 -34
  398. package/dist/skills/fluentcart-developer/references/restapi/operations/products/remove-shipping-class.md +27 -27
  399. package/dist/skills/fluentcart-developer/references/restapi/operations/products/remove-tax-class.md +27 -27
  400. package/dist/skills/fluentcart-developer/references/restapi/operations/products/save-bundle-info.md +56 -56
  401. package/dist/skills/fluentcart-developer/references/restapi/operations/products/save-product-integration.md +62 -62
  402. package/dist/skills/fluentcart-developer/references/restapi/operations/products/save-upgrade-path.md +78 -78
  403. package/dist/skills/fluentcart-developer/references/restapi/operations/products/search-product-variant-options.md +29 -29
  404. package/dist/skills/fluentcart-developer/references/restapi/operations/products/search-products-by-name.md +28 -28
  405. package/dist/skills/fluentcart-developer/references/restapi/operations/products/search-variants-by-name.md +28 -28
  406. package/dist/skills/fluentcart-developer/references/restapi/operations/products/set-variation-media.md +74 -74
  407. package/dist/skills/fluentcart-developer/references/restapi/operations/products/suggest-sku.md +28 -28
  408. package/dist/skills/fluentcart-developer/references/restapi/operations/products/sync-downloadable-files.md +134 -134
  409. package/dist/skills/fluentcart-developer/references/restapi/operations/products/sync-taxonomy-terms.md +61 -61
  410. package/dist/skills/fluentcart-developer/references/restapi/operations/products/toggle-product-tax-exemption.md +56 -56
  411. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-downloadable-file.md +98 -98
  412. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-inventory.md +56 -56
  413. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-long-desc-editor-mode.md +49 -49
  414. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-manage-stock.md +53 -53
  415. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-product-detail.md +58 -58
  416. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-product-pricing.md +225 -225
  417. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-shipping-class.md +49 -49
  418. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-tax-class.md +49 -49
  419. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-upgrade-path.md +78 -78
  420. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variant-option.md +79 -79
  421. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variant-tax-exemption.md +56 -56
  422. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variation-pricing-table.md +49 -49
  423. package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variation.md +105 -105
  424. package/dist/skills/fluentcart-developer/references/restapi/operations/public-shop/get-product-views.md +34 -34
  425. package/dist/skills/fluentcart-developer/references/restapi/operations/public-shop/list-products.md +42 -42
  426. package/dist/skills/fluentcart-developer/references/restapi/operations/public-shop/search-products.md +30 -30
  427. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/channel-rules.md +24 -24
  428. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/country-heat-map.md +22 -22
  429. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/coupon-overview.md +37 -37
  430. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/coupons.md +36 -36
  431. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-insights.md +31 -31
  432. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-overview.md +36 -36
  433. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-repeat.md +35 -35
  434. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-segment-customers.md +36 -36
  435. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-segments.md +30 -30
  436. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-value.md +34 -34
  437. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/dashboard-stats.md +30 -30
  438. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/failed-orders.md +34 -34
  439. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-new-vs-returning-customer.md +34 -34
  440. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-report-by-day-and-hour.md +34 -34
  441. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-report-meta.md +29 -29
  442. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-top-sold-products.md +34 -34
  443. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/future-renewals.md +31 -31
  444. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/generate-retention-snapshots.md +24 -24
  445. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-overview.md +30 -30
  446. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-recent-activities.md +26 -26
  447. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-recent-orders.md +20 -20
  448. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-revenue.md +37 -37
  449. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/installments-at-risk.md +35 -35
  450. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/installments-variations.md +33 -33
  451. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/installments.md +33 -33
  452. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/item-count-distribution.md +34 -34
  453. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/license-chart.md +30 -30
  454. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/license-pie-chart.md +22 -22
  455. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/license-summary.md +22 -22
  456. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/locations.md +43 -43
  457. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-chart.md +37 -37
  458. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-completion-time.md +34 -34
  459. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-mix.md +34 -34
  460. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-value-distribution.md +34 -34
  461. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/payment-methods-disputes.md +38 -38
  462. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/payment-methods-methods.md +36 -36
  463. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/payment-methods.md +37 -37
  464. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-comparison-launch.md +33 -33
  465. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-comparison.md +40 -40
  466. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-detail.md +37 -37
  467. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-sales.md +37 -37
  468. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/refunds-overview.md +37 -37
  469. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/retention-snapshots-step.md +45 -45
  470. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/sales-growth-chart.md +35 -35
  471. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/save-channel-rules.md +73 -73
  472. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/source-channels.md +37 -37
  473. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/sources.md +49 -49
  474. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-cohorts.md +33 -33
  475. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-health.md +30 -30
  476. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-rebuys.md +37 -37
  477. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-retention.md +34 -34
  478. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-variations.md +22 -22
  479. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscriptions-overview.md +37 -37
  480. package/dist/skills/fluentcart-developer/references/restapi/operations/reports/weeks-between-refund.md +34 -34
  481. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/assign-role.md +48 -48
  482. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/delete-role-assignment.md +47 -47
  483. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/get-role.md +25 -25
  484. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/list-managers.md +18 -18
  485. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/list-roles.md +18 -18
  486. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/search-users.md +25 -25
  487. package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/update-role.md +43 -43
  488. package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/create-saved-view.md +106 -106
  489. package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/delete-saved-view.md +26 -26
  490. package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/list-saved-views.md +25 -25
  491. package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/update-saved-view.md +83 -83
  492. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/activate-payment-addon.md +44 -44
  493. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/activate-plugin-addon.md +44 -44
  494. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/change-storage-driver-status.md +56 -56
  495. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/check-paypal-webhook.md +26 -26
  496. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/create-storage-bucket.md +63 -63
  497. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/disconnect-payment-method.md +55 -55
  498. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/exchange-paypal-seller-auth-token.md +62 -62
  499. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-active-storage-drivers.md +20 -20
  500. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-checkout-fields.md +22 -22
  501. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-email-shortcodes.md +20 -20
  502. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-mcp-config-snippets.md +26 -26
  503. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-mcp-status.md +20 -20
  504. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-module-settings.md +20 -20
  505. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-payment-method-connection-info.md +26 -26
  506. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-payment-method-settings.md +26 -26
  507. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-permissions.md +22 -22
  508. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-plugin-addons.md +20 -20
  509. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-storage-driver-settings.md +27 -27
  510. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-store-settings.md +26 -26
  511. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/install-mcp-adapter.md +21 -21
  512. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/install-payment-addon.md +60 -60
  513. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/install-plugin-addon.md +64 -64
  514. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/list-all-payment-methods.md +20 -20
  515. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/list-all-storage-drivers.md +20 -20
  516. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/list-storage-buckets.md +67 -67
  517. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/reorder-payment-methods.md +55 -55
  518. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/reset-storage-driver-settings.md +45 -45
  519. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-checkout-fields.md +133 -133
  520. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-confirmation-settings.md +68 -68
  521. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-module-settings.md +68 -68
  522. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-payment-method-design.md +67 -67
  523. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-payment-method-settings.md +58 -58
  524. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-permissions.md +68 -68
  525. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-storage-driver-settings.md +62 -62
  526. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-store-settings.md +239 -239
  527. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/setup-paypal-webhook.md +48 -48
  528. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/toggle-mcp.md +40 -40
  529. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/verify-storage-driver-connection.md +62 -62
  530. package/dist/skills/fluentcart-developer/references/restapi/operations/settings/verify-turnstile-keys.md +55 -55
  531. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/create-shipping-class.md +73 -73
  532. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/create-shipping-method.md +110 -110
  533. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/create-shipping-zone.md +56 -56
  534. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/delete-shipping-class.md +29 -29
  535. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/delete-shipping-method.md +29 -29
  536. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/delete-shipping-zone.md +29 -29
  537. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-class-profile.md +30 -30
  538. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-class.md +29 -29
  539. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-packages.md +22 -22
  540. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-zone.md +27 -27
  541. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-zone-countries.md +22 -22
  542. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-zone-states.md +28 -28
  543. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/list-shipping-classes.md +31 -31
  544. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/list-shipping-zones.md +31 -31
  545. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/save-shipping-packages.md +112 -112
  546. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-shipping-class.md +79 -79
  547. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-shipping-method.md +113 -113
  548. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-shipping-zone.md +62 -62
  549. package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-zone-order.md +52 -52
  550. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/cancel-auto-renew.md +30 -30
  551. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/cancel-subscription.md +52 -52
  552. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/confirm-subscription-switch.md +70 -70
  553. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/fetch-subscription-remote.md +28 -28
  554. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/generate-early-payment-link.md +29 -29
  555. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-customer-subscription.md +27 -27
  556. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-or-create-plan.md +69 -69
  557. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-setup-intent-attempts.md +30 -30
  558. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-subscription.md +28 -28
  559. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/initiate-early-payment.md +31 -31
  560. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/list-customer-subscriptions.md +27 -27
  561. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/list-subscriptions.md +39 -39
  562. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/pause-subscription.md +28 -28
  563. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/reactivate-subscription.md +28 -28
  564. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/resume-subscription.md +28 -28
  565. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/switch-payment-method.md +70 -70
  566. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/update-payment-method.md +69 -69
  567. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/update-vendor-ids.md +56 -56
  568. package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/verify-vendor-ids.md +56 -56
  569. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/create-tax-class.md +51 -51
  570. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/create-tax-rate.md +117 -117
  571. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-product-override.md +27 -27
  572. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-shipping-tax-override.md +27 -27
  573. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-tax-class.md +28 -28
  574. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-tax-rate.md +27 -27
  575. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-country-tax-id.md +27 -27
  576. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-country-tax-rates.md +28 -28
  577. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-eu-vat-product-overrides.md +20 -20
  578. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-oss-country-rates.md +20 -20
  579. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-preconfigured-tax-rates.md +20 -20
  580. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-product-overrides.md +27 -27
  581. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-tax-settings.md +20 -20
  582. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/list-all-tax-rates.md +20 -20
  583. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/list-tax-classes.md +20 -20
  584. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/list-tax-records.md +37 -37
  585. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/mark-taxes-as-filed.md +58 -58
  586. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/reset-eu-vat-rates.md +21 -21
  587. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-configured-countries.md +57 -57
  588. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-country-tax-id.md +50 -50
  589. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-eu-vat-cross-border-settings.md +127 -127
  590. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-oss-country-rates.md +100 -100
  591. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-product-override.md +110 -110
  592. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-shipping-tax-override.md +52 -52
  593. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-tax-settings.md +166 -166
  594. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/update-country-status.md +54 -54
  595. package/dist/skills/fluentcart-developer/references/restapi/operations/tax/update-tax-rate.md +116 -116
  596. package/dist/skills/fluentcart-developer/references/restapi/order-bumps.md +433 -433
  597. package/dist/skills/fluentcart-developer/references/restapi/orders.md +1212 -1212
  598. package/dist/skills/fluentcart-developer/references/restapi/pdf-templates.md +212 -212
  599. package/dist/skills/fluentcart-developer/references/restapi/products.md +2485 -2485
  600. package/dist/skills/fluentcart-developer/references/restapi/public-shop.md +191 -191
  601. package/dist/skills/fluentcart-developer/references/restapi/reports.md +3773 -3773
  602. package/dist/skills/fluentcart-developer/references/restapi/roles.md +403 -403
  603. package/dist/skills/fluentcart-developer/references/restapi/saved-views.md +136 -136
  604. package/dist/skills/fluentcart-developer/references/restapi/settings.md +1423 -1423
  605. package/dist/skills/fluentcart-developer/references/restapi/shipping.md +905 -905
  606. package/dist/skills/fluentcart-developer/references/restapi/subscriptions.md +1169 -1169
  607. package/dist/skills/fluentcart-developer/references/restapi/tax.md +1551 -1551
  608. package/dist/skills/fluentcart-developer/references/restapi.md +127 -127
  609. package/dist/skills/fluentcart-developer/scripts/cli.js +1 -1
  610. package/dist/version.d.ts +1 -1
  611. package/dist/version.js +1 -1
  612. package/package.json +66 -65
@@ -1,846 +1,846 @@
1
- # Shipping Module
2
-
3
- The Shipping module handles shipping calculations, zone management, and delivery options in FluentCart. It provides a flexible system for configuring shipping rates based on location, product weight, and other factors.
4
-
5
- ## Architecture Overview
6
-
7
- ### Core Components
8
-
9
- #### 1. **Shipping Zones**
10
-
11
- Geographic areas where specific shipping methods are available.
12
-
13
- #### 2. **Shipping Methods**
14
-
15
- Specific delivery options within each zone (e.g., Standard, Express, Overnight).
16
-
17
- #### 3. **Shipping Classes**
18
-
19
- Product categories that can have different shipping rates.
20
-
21
- #### 4. **Rate Calculations**
22
-
23
- Dynamic pricing based on various factors like weight, distance, and product type.
24
-
25
- ## Database Models
26
-
27
- ### ShippingZone Model
28
-
29
- ```
30
- class ShippingZone extends Model
31
- {
32
- protected $table = 'fct_shipping_zones';
33
-
34
- protected $appends = ['formatted_region'];
35
-
36
- protected $fillable = [
37
- 'name',
38
- 'region',
39
- 'order',
40
- 'shipping_class_id',
41
- 'meta'
42
- ];
43
-
44
- public function methods(): HasMany
45
- {
46
- return $this->hasMany(ShippingMethod::class, 'zone_id', 'id')
47
- ->orderBy('id', 'DESC');
48
- }
49
- }
50
- ```
51
-
52
- ### ShippingMethod Model
53
-
54
- ```
55
- class ShippingMethod extends Model
56
- {
57
- protected $table = 'fct_shipping_methods';
58
-
59
- protected $fillable = [
60
- 'zone_id',
61
- 'title',
62
- 'type',
63
- 'settings',
64
- 'amount',
65
- 'is_enabled',
66
- 'order',
67
- 'states',
68
- 'meta'
69
- ];
70
-
71
- protected $appends = ['formatted_states'];
72
-
73
- protected $casts = [
74
- 'settings' => 'array',
75
- 'states' => 'array',
76
- 'is_enabled' => 'boolean'
77
- ];
78
-
79
- public function zone(): BelongsTo
80
- {
81
- return $this->belongsTo(ShippingZone::class, 'zone_id', 'id');
82
- }
83
- }
84
- ```
85
-
86
- ### ShippingClass Model
87
-
88
- ```
89
- class ShippingClass extends Model
90
- {
91
- protected $table = 'fct_shipping_classes';
92
-
93
- protected $fillable = [
94
- 'name',
95
- 'cost',
96
- 'type',
97
- 'per_item'
98
- ];
99
-
100
- protected $casts = [
101
- 'cost' => 'float'
102
- ];
103
- }
104
- ```
105
-
106
- ## Shipping Zones
107
-
108
- ### Creating Shipping Zones
109
-
110
- ```
111
- use FluentCart\App\Models\ShippingZone;
112
-
113
- // Create a new shipping zone
114
- $zone = ShippingZone::create([
115
- 'name' => 'United States',
116
- 'region' => 'US',
117
- 'order' => 1
118
- ]);
119
-
120
- // Create a zone for multiple countries
121
- $europeZone = ShippingZone::create([
122
- 'name' => 'Europe',
123
- 'region' => 'selection',
124
- 'meta' => [
125
- 'countries' => ['GB', 'DE', 'FR', 'IT', 'ES'],
126
- 'selection_type' => 'included'
127
- ],
128
- 'order' => 2
129
- ]);
130
-
131
- // Create a worldwide zone
132
- $worldwideZone = ShippingZone::create([
133
- 'name' => 'Rest of World',
134
- 'region' => 'all', // Whole World - only one such zone per shipping class
135
- 'order' => 3
136
- ]);
137
- ```
138
-
139
- ### Managing Zone Regions
140
-
141
- ```
142
- // Target a single country
143
- $zone = ShippingZone::find(1);
144
- $zone->region = 'US';
145
- $zone->save();
146
-
147
- // Target several countries: region becomes 'selection' and the list lives in meta
148
- $zone->region = 'selection';
149
- $zone->meta = [
150
- 'countries' => ['US', 'CA', 'MX'],
151
- 'selection_type' => 'included' // or 'excluded'
152
- ];
153
- $zone->save();
154
-
155
- // Get the human-readable region label
156
- $formattedRegion = $zone->formatted_region;
157
- // 'United States', or 'Whole World' when region is 'all'
158
- ```
159
-
160
- ## Shipping Methods
161
-
162
- ### Creating Shipping Methods
163
-
164
- The shipping module provides a flexible framework for creating custom shipping methods. You can define your own shipping method types and configurations.
165
-
166
- #### **Custom Shipping Method**
167
-
168
- ```
169
- $shippingMethod = ShippingMethod::create([
170
- 'zone_id' => 1,
171
- 'title' => 'Standard Shipping',
172
- 'type' => 'flat_rate',
173
- 'amount' => 5.00, // base-currency major units, not cents
174
- 'is_enabled' => true,
175
- 'settings' => [
176
- 'configure_rate' => 'per_order',
177
- 'class_aggregation' => 'sum_all'
178
- ]
179
- ]);
180
- ```
181
-
182
- #### **Free Shipping Method**
183
-
184
- ```
185
- $freeShipping = ShippingMethod::create([
186
- 'zone_id' => 1,
187
- 'title' => 'Free Shipping',
188
- 'type' => 'free_shipping',
189
- 'amount' => 0,
190
- 'is_enabled' => true,
191
- 'settings' => []
192
- ]);
193
- ```
194
-
195
- #### **Weight-Based Shipping**
196
-
197
- ```
198
- $weightBased = ShippingMethod::create([
199
- 'zone_id' => 1,
200
- 'title' => 'Weight Based Shipping',
201
- 'type' => 'flat_rate',
202
- 'amount' => 0,
203
- 'is_enabled' => true,
204
- 'settings' => [
205
- 'configure_rate' => 'per_weight',
206
- 'weight_tiers' => [
207
- ['min' => 0, 'max' => 5, 'cost' => 5.00],
208
- ['min' => 5, 'max' => 0, 'cost' => 12.00] // max 0 = no upper bound
209
- ]
210
- ]
211
- ]);
212
- ```
213
-
214
- ### Custom Shipping Methods
215
-
216
- #### Creating a Custom Shipping Method
217
-
218
- ```
219
- class ExpressShipping extends ShippingMethod
220
- {
221
- public function calculateRate($cart, $address)
222
- {
223
- $baseRate = 1500; // $15 base rate
224
- $weightRate = $cart->getTotalWeight() * 200; // $2 per lb
225
-
226
- return $baseRate + $weightRate;
227
- }
228
-
229
- public function isAvailable($cart, $address)
230
- {
231
- // Only available for orders over $100
232
- return $cart->getTotal() >= 10000;
233
- }
234
- }
235
- ```
236
-
237
- ## Shipping Classes
238
-
239
- ### Creating Shipping Classes
240
-
241
- ```
242
- use FluentCart\App\Models\ShippingClass;
243
-
244
- // Create shipping classes for different product types
245
- $fragileClass = ShippingClass::create([
246
- 'name' => 'Fragile Items',
247
- 'cost' => 1000, // $10 additional cost
248
- 'type' => 'fixed',
249
- 'per_item' => false
250
- ]);
251
-
252
- $heavyClass = ShippingClass::create([
253
- 'name' => 'Heavy Items',
254
- 'cost' => 500, // $5 additional cost
255
- 'type' => 'fixed',
256
- 'per_item' => true // Cost per item
257
- ]);
258
-
259
- $digitalClass = ShippingClass::create([
260
- 'name' => 'Digital Products',
261
- 'cost' => 0, // No shipping cost
262
- 'type' => 'fixed',
263
- 'per_item' => false
264
- ]);
265
- ```
266
-
267
- ### Assigning Shipping Classes to Products
268
-
269
- ```
270
- use FluentCart\App\Models\Product;
271
-
272
- // Assign shipping class to a product
273
- $product = Product::find(1);
274
- $product->shipping_class_id = $fragileClass->id;
275
- $product->save();
276
-
277
- // Or through product meta
278
- $product->updateMeta('shipping_class', $fragileClass->id);
279
- ```
280
-
281
- ## Rate Calculations
282
-
283
- ### Basic Rate Calculation
284
-
285
- ```
286
- class ShippingCalculator
287
- {
288
- public function calculateShipping($cart, $address)
289
- {
290
- $zone = $this->getShippingZone($address);
291
-
292
- if (!$zone) {
293
- return null; // No shipping available
294
- }
295
-
296
- $methods = $zone->methods()->where('is_enabled', true)->get();
297
- $availableMethods = [];
298
-
299
- foreach ($methods as $method) {
300
- if ($this->isMethodAvailable($method, $cart, $address)) {
301
- $rate = $this->calculateMethodRate($method, $cart, $address);
302
- $availableMethods[] = [
303
- 'id' => $method->id,
304
- 'title' => $method->title,
305
- 'cost' => $rate,
306
- 'description' => $method->settings['description'] ?? ''
307
- ];
308
- }
309
- }
310
-
311
- return $availableMethods;
312
- }
313
-
314
- private function calculateMethodRate($method, $cart, $address)
315
- {
316
- switch ($method->type) {
317
- case 'flat_rate':
318
- return $method->amount;
319
-
320
- case 'free_shipping':
321
- $minimumAmount = $method->settings['minimum_amount'] ?? 0;
322
- return $cart->getTotal() >= $minimumAmount ? 0 : null;
323
-
324
- case 'table_rate':
325
- return $this->calculateTableRate($method, $cart);
326
-
327
- default:
328
- return $method->amount;
329
- }
330
- }
331
-
332
- private function calculateTableRate($method, $cart)
333
- {
334
- $rates = $method->settings['rates'] ?? [];
335
- $calculationType = $method->settings['calculation_type'] ?? 'weight';
336
-
337
- $value = match($calculationType) {
338
- 'weight' => $cart->getTotalWeight(),
339
- 'quantity' => $cart->getTotalQuantity(),
340
- 'price' => $cart->getTotal(),
341
- default => $cart->getTotalWeight()
342
- };
343
-
344
- foreach ($rates as $rate) {
345
- $min = $rate['min'];
346
- $max = $rate['max'] == 0 ? PHP_FLOAT_MAX : $rate['max'];
347
-
348
- if ($value >= $min && $value <= $max) {
349
- return $rate['cost'];
350
- }
351
- }
352
-
353
- return 0; // No matching rate found
354
- }
355
- }
356
- ```
357
-
358
- ### Advanced Rate Calculation with Shipping Classes
359
-
360
- ```
361
- class AdvancedShippingCalculator extends ShippingCalculator
362
- {
363
- public function calculateMethodRate($method, $cart, $address)
364
- {
365
- $baseRate = parent::calculateMethodRate($method, $cart, $address);
366
-
367
- if ($baseRate === null) {
368
- return null;
369
- }
370
-
371
- // Add shipping class costs
372
- $shippingClassCost = $this->calculateShippingClassCost($cart);
373
-
374
- return $baseRate + $shippingClassCost;
375
- }
376
-
377
- private function calculateShippingClassCost($cart)
378
- {
379
- $totalCost = 0;
380
- $shippingClasses = [];
381
-
382
- foreach ($cart->getItems() as $item) {
383
- $product = $item->product;
384
- $shippingClass = $product->shippingClass;
385
-
386
- if ($shippingClass) {
387
- if (!isset($shippingClasses[$shippingClass->id])) {
388
- $shippingClasses[$shippingClass->id] = [
389
- 'class' => $shippingClass,
390
- 'quantity' => 0
391
- ];
392
- }
393
- $shippingClasses[$shippingClass->id]['quantity'] += $item->quantity;
394
- }
395
- }
396
-
397
- foreach ($shippingClasses as $classData) {
398
- $class = $classData['class'];
399
- $quantity = $classData['quantity'];
400
-
401
- if ($class->per_item) {
402
- $totalCost += $class->cost * $quantity;
403
- } else {
404
- $totalCost += $class->cost; // Fixed cost per order
405
- }
406
- }
407
-
408
- return $totalCost;
409
- }
410
- }
411
- ```
412
-
413
- ## API Endpoints
414
-
415
- ### Shipping Zones API
416
-
417
- #### List Shipping Zones
418
-
419
- ```
420
- GET /wp-json/fluent-cart/v2/shipping/zones
421
- ```
422
-
423
- **Response:**
424
-
425
- ```
426
- {
427
- "success": true,
428
- "data": {
429
- "zones": [
430
- {
431
- "id": 1,
432
- "name": "United States",
433
- "region": "US",
434
- "order": 1,
435
- "formatted_region": "United States",
436
- "methods": [
437
- {
438
- "id": 1,
439
- "title": "Standard Shipping",
440
- "type": "flat_rate",
441
- "amount": "5.00",
442
- "is_enabled": true
443
- }
444
- ]
445
- }
446
- ]
447
- }
448
- }
449
- ```
450
-
451
- #### Create Shipping Zone
452
-
453
- ```
454
- POST /wp-json/fluent-cart/v2/shipping/zones
455
- ```
456
-
457
- **Request Body:**
458
-
459
- ```
460
- {
461
- "name": "Europe",
462
- "region": "selection",
463
- "order": 2
464
- }
465
- ```
466
-
467
- #### Update Shipping Zone
468
-
469
- ```
470
- PUT /wp-json/fluent-cart/v2/shipping/zones/{id}
471
- ```
472
-
473
- **Request Body:**
474
-
475
- ```
476
- {
477
- "name": "European Union",
478
- "region": "selection",
479
- "order": 2
480
- }
481
- ```
482
-
483
- #### Delete Shipping Zone
484
-
485
- ```
486
- DELETE /wp-json/fluent-cart/v2/shipping/zones/{id}
487
- ```
488
-
489
- ### Shipping Methods API
490
-
491
- #### Create Shipping Method
492
-
493
- ```
494
- POST /wp-json/fluent-cart/v2/shipping/methods
495
- ```
496
-
497
- **Request Body:**
498
-
499
- ```
500
- {
501
- "zone_id": 1,
502
- "title": "Express Shipping",
503
- "type": "flat_rate",
504
- "amount": "15.00",
505
- "is_enabled": true,
506
- "settings": {
507
- "cost": 1500,
508
- "description": "Express delivery within 2-3 business days"
509
- }
510
- }
511
- ```
512
-
513
- #### Update Shipping Method
514
-
515
- ```
516
- PUT /wp-json/fluent-cart/v2/shipping/methods
517
- ```
518
-
519
- **Request Body:**
520
-
521
- ```
522
- {
523
- "method_id": 1,
524
- "title": "Standard Shipping",
525
- "amount": "8.00",
526
- "settings": {
527
- "cost": 800,
528
- "description": "Standard delivery within 5-7 business days"
529
- }
530
- }
531
- ```
532
-
533
- #### Delete Shipping Method
534
-
535
- ```
536
- DELETE /wp-json/fluent-cart/v2/shipping/methods/{method_id}
537
- ```
538
-
539
- ### Shipping Classes API
540
-
541
- #### List Shipping Classes
542
-
543
- ```
544
- GET /wp-json/fluent-cart/v2/shipping/classes
545
- ```
546
-
547
- **Response:**
548
-
549
- ```
550
- {
551
- "success": true,
552
- "data": {
553
- "classes": [
554
- {
555
- "id": 1,
556
- "name": "Fragile Items",
557
- "cost": 1000,
558
- "type": "fixed",
559
- "per_item": false
560
- },
561
- {
562
- "id": 2,
563
- "name": "Heavy Items",
564
- "cost": 500,
565
- "type": "fixed",
566
- "per_item": true
567
- }
568
- ]
569
- }
570
- }
571
- ```
572
-
573
- #### Create Shipping Class
574
-
575
- ```
576
- POST /wp-json/fluent-cart/v2/shipping/classes
577
- ```
578
-
579
- **Request Body:**
580
-
581
- ```
582
- {
583
- "name": "Digital Products",
584
- "cost": 0,
585
- "type": "fixed",
586
- "per_item": false
587
- }
588
- ```
589
-
590
- ## Frontend Integration
591
-
592
- ### Getting Available Shipping Methods
593
-
594
- ```
595
- GET /wp-json/fluent-cart/v2/checkout/get-available-shipping-methods
596
- ```
597
-
598
- **Query Parameters:**
599
-
600
- - `country_code` - Country code (e.g., 'US', 'GB')
601
- - `timezone` - Timezone for automatic country detection
602
-
603
- **Response:**
604
-
605
- ```
606
- {
607
- "status": true,
608
- "available_shipping_methods": [
609
- {
610
- "id": 1,
611
- "title": "Standard Shipping",
612
- "type": "flat_rate",
613
- "amount": "5.00",
614
- "settings": {
615
- "description": "Standard delivery within 5-7 business days"
616
- }
617
- },
618
- {
619
- "id": 2,
620
- "title": "Express Shipping",
621
- "type": "flat_rate",
622
- "amount": "15.00",
623
- "settings": {
624
- "description": "Express delivery within 2-3 business days"
625
- }
626
- }
627
- ]
628
- }
629
- ```
630
-
631
- ### JavaScript Integration
632
-
633
- ```
634
- // Get available shipping methods
635
- async function getShippingMethods(countryCode) {
636
- try {
637
- const response = await fetch(`/wp-json/fluent-cart/v2/checkout/get-available-shipping-methods?country_code=${countryCode}`);
638
- const data = await response.json();
639
-
640
- if (data.status) {
641
- return data.available_shipping_methods;
642
- } else {
643
- console.error('No shipping methods available:', data.message);
644
- return [];
645
- }
646
- } catch (error) {
647
- console.error('Error fetching shipping methods:', error);
648
- return [];
649
- }
650
- }
651
-
652
- // Update shipping options in checkout
653
- function updateShippingOptions(methods) {
654
- const shippingContainer = document.getElementById('shipping-options');
655
-
656
- if (methods.length === 0) {
657
- shippingContainer.innerHTML = '<p>No shipping methods available for this location.</p>';
658
- return;
659
- }
660
-
661
- let html = '<div class="shipping-methods">';
662
-
663
- methods.forEach(method => {
664
- html += `
665
- <div class="shipping-method">
666
- <input type="radio" name="shipping_method" value="${method.id}" id="shipping_${method.id}">
667
- <label for="shipping_${method.id}">
668
- <span class="method-title">${method.title}</span>
669
- <span class="method-cost">$${(method.amount / 100).toFixed(2)}</span>
670
- <span class="method-description">${method.settings.description || ''}</span>
671
- </label>
672
- </div>
673
- `;
674
- });
675
-
676
- html += '</div>';
677
- shippingContainer.innerHTML = html;
678
- }
679
-
680
- // Usage
681
- document.addEventListener('DOMContentLoaded', async function() {
682
- const countrySelect = document.getElementById('country');
683
-
684
- countrySelect.addEventListener('change', async function() {
685
- const countryCode = this.value;
686
- const methods = await getShippingMethods(countryCode);
687
- updateShippingOptions(methods);
688
- });
689
-
690
- // Load initial shipping methods
691
- const initialCountry = countrySelect.value;
692
- const initialMethods = await getShippingMethods(initialCountry);
693
- updateShippingOptions(initialMethods);
694
- });
695
- ```
696
-
697
- ## Custom Shipping Method Development
698
-
699
- ### Creating a Custom Shipping Method
700
-
701
- ```
702
- <?php
703
- namespace FluentCart\App\Modules\Shipping\Methods;
704
-
705
- use FluentCart\App\Models\ShippingMethod;
706
- use FluentCart\App\Models\Cart;
707
-
708
- class CustomShippingMethod
709
- {
710
- protected $method;
711
-
712
- public function __construct(ShippingMethod $method)
713
- {
714
- $this->method = $method;
715
- }
716
-
717
- public function calculateRate(Cart $cart, $address)
718
- {
719
- // Custom calculation logic
720
- $baseRate = $this->method->amount;
721
- $weight = $cart->getTotalWeight();
722
- $distance = $this->calculateDistance($address);
723
-
724
- // Example: Base rate + weight factor + distance factor
725
- $rate = $baseRate + ($weight * 100) + ($distance * 50);
726
-
727
- return $rate;
728
- }
729
-
730
- public function isAvailable(Cart $cart, $address)
731
- {
732
- // Check if method is available for this cart/address
733
- $minimumOrder = $this->method->settings['minimum_order'] ?? 0;
734
-
735
- return $cart->getTotal() >= $minimumOrder;
736
- }
737
-
738
- private function calculateDistance($address)
739
- {
740
- // Implement distance calculation logic
741
- // This could use a mapping service API
742
- return 0; // Placeholder
743
- }
744
- }
745
- ```
746
-
747
- ### Registering Custom Shipping Methods
748
-
749
- ```
750
- // In your module's initialization
751
- add_action('fluentcart_loaded', function($app) {
752
- // Register custom shipping method type
753
- add_filter('fluent_cart/shipping/method_types', function($types) {
754
- $types['custom_method'] = [
755
- 'title' => 'Custom Shipping',
756
- 'class' => CustomShippingMethod::class,
757
- 'settings' => [
758
- 'minimum_order' => [
759
- 'type' => 'number',
760
- 'label' => 'Minimum Order Amount',
761
- 'default' => 0
762
- ],
763
- 'custom_setting' => [
764
- 'type' => 'text',
765
- 'label' => 'Custom Setting',
766
- 'default' => ''
767
- ]
768
- ]
769
- ];
770
-
771
- return $types;
772
- });
773
- });
774
- ```
775
-
776
- ## Hooks and Filters
777
-
778
- ### Shipping Calculation Hooks
779
-
780
- ```
781
- // Modify shipping rates before calculation
782
- add_filter('fluent_cart/shipping/calculate_rate', function($rate, $method, $cart, $address) {
783
- // Apply custom logic to modify rate
784
- if ($cart->hasCoupon('FREE_SHIPPING')) {
785
- return 0; // Free shipping with coupon
786
- }
787
-
788
- return $rate;
789
- }, 10, 4);
790
-
791
- // Add custom shipping methods
792
- add_filter('fluent_cart/shipping/available_methods', function($methods, $cart, $address) {
793
- // Add custom method if conditions are met
794
- if ($cart->getTotal() > 10000) { // Orders over $100
795
- $methods[] = [
796
- 'id' => 'custom_express',
797
- 'title' => 'Custom Express',
798
- 'cost' => 2000,
799
- 'description' => 'Custom express shipping for large orders'
800
- ];
801
- }
802
-
803
- return $methods;
804
- }, 10, 3);
805
-
806
- // Modify shipping zone selection
807
- add_filter('fluent_cart/shipping/zone_for_address', function($zone, $address) {
808
- // Custom zone selection logic
809
- if ($address['country'] === 'US' && $address['state'] === 'CA') {
810
- // Special handling for California
811
- return ShippingZone::where('name', 'California Special')->first();
812
- }
813
-
814
- return $zone;
815
- }, 10, 2);
816
- ```
817
-
818
- ### Shipping Method Hooks
819
-
820
- ```
821
- // Before shipping method is saved
822
- add_action('fluent_cart/shipping/method/before_save', function($method) {
823
- // Validate or modify method before saving
824
- if ($method->type === 'custom_method') {
825
- // Custom validation logic
826
- }
827
- });
828
-
829
- // After shipping method is saved
830
- add_action('fluent_cart/shipping/method/after_save', function($method) {
831
- // Perform actions after method is saved
832
- // e.g., update external shipping service
833
- });
834
-
835
- // Before shipping method is deleted
836
- add_action('fluent_cart/shipping/method/before_delete', function($method) {
837
- // Clean up related data
838
- });
839
- ```
840
-
841
- ---
842
-
843
- **Next Steps:**
844
-
845
- - [Storage Drivers](./storage.md) - File storage integration
846
- - [Modules Overview](./index.md) - Back to modules overview
1
+ # Shipping Module
2
+
3
+ The Shipping module handles shipping calculations, zone management, and delivery options in FluentCart. It provides a flexible system for configuring shipping rates based on location, product weight, and other factors.
4
+
5
+ ## Architecture Overview
6
+
7
+ ### Core Components
8
+
9
+ #### 1. **Shipping Zones**
10
+
11
+ Geographic areas where specific shipping methods are available.
12
+
13
+ #### 2. **Shipping Methods**
14
+
15
+ Specific delivery options within each zone (e.g., Standard, Express, Overnight).
16
+
17
+ #### 3. **Shipping Classes**
18
+
19
+ Product categories that can have different shipping rates.
20
+
21
+ #### 4. **Rate Calculations**
22
+
23
+ Dynamic pricing based on various factors like weight, distance, and product type.
24
+
25
+ ## Database Models
26
+
27
+ ### ShippingZone Model
28
+
29
+ ```
30
+ class ShippingZone extends Model
31
+ {
32
+ protected $table = 'fct_shipping_zones';
33
+
34
+ protected $appends = ['formatted_region'];
35
+
36
+ protected $fillable = [
37
+ 'name',
38
+ 'region',
39
+ 'order',
40
+ 'shipping_class_id',
41
+ 'meta'
42
+ ];
43
+
44
+ public function methods(): HasMany
45
+ {
46
+ return $this->hasMany(ShippingMethod::class, 'zone_id', 'id')
47
+ ->orderBy('id', 'DESC');
48
+ }
49
+ }
50
+ ```
51
+
52
+ ### ShippingMethod Model
53
+
54
+ ```
55
+ class ShippingMethod extends Model
56
+ {
57
+ protected $table = 'fct_shipping_methods';
58
+
59
+ protected $fillable = [
60
+ 'zone_id',
61
+ 'title',
62
+ 'type',
63
+ 'settings',
64
+ 'amount',
65
+ 'is_enabled',
66
+ 'order',
67
+ 'states',
68
+ 'meta'
69
+ ];
70
+
71
+ protected $appends = ['formatted_states'];
72
+
73
+ protected $casts = [
74
+ 'settings' => 'array',
75
+ 'states' => 'array',
76
+ 'is_enabled' => 'boolean'
77
+ ];
78
+
79
+ public function zone(): BelongsTo
80
+ {
81
+ return $this->belongsTo(ShippingZone::class, 'zone_id', 'id');
82
+ }
83
+ }
84
+ ```
85
+
86
+ ### ShippingClass Model
87
+
88
+ ```
89
+ class ShippingClass extends Model
90
+ {
91
+ protected $table = 'fct_shipping_classes';
92
+
93
+ protected $fillable = [
94
+ 'name',
95
+ 'cost',
96
+ 'type',
97
+ 'per_item'
98
+ ];
99
+
100
+ protected $casts = [
101
+ 'cost' => 'float'
102
+ ];
103
+ }
104
+ ```
105
+
106
+ ## Shipping Zones
107
+
108
+ ### Creating Shipping Zones
109
+
110
+ ```
111
+ use FluentCart\App\Models\ShippingZone;
112
+
113
+ // Create a new shipping zone
114
+ $zone = ShippingZone::create([
115
+ 'name' => 'United States',
116
+ 'region' => 'US',
117
+ 'order' => 1
118
+ ]);
119
+
120
+ // Create a zone for multiple countries
121
+ $europeZone = ShippingZone::create([
122
+ 'name' => 'Europe',
123
+ 'region' => 'selection',
124
+ 'meta' => [
125
+ 'countries' => ['GB', 'DE', 'FR', 'IT', 'ES'],
126
+ 'selection_type' => 'included'
127
+ ],
128
+ 'order' => 2
129
+ ]);
130
+
131
+ // Create a worldwide zone
132
+ $worldwideZone = ShippingZone::create([
133
+ 'name' => 'Rest of World',
134
+ 'region' => 'all', // Whole World - only one such zone per shipping class
135
+ 'order' => 3
136
+ ]);
137
+ ```
138
+
139
+ ### Managing Zone Regions
140
+
141
+ ```
142
+ // Target a single country
143
+ $zone = ShippingZone::find(1);
144
+ $zone->region = 'US';
145
+ $zone->save();
146
+
147
+ // Target several countries: region becomes 'selection' and the list lives in meta
148
+ $zone->region = 'selection';
149
+ $zone->meta = [
150
+ 'countries' => ['US', 'CA', 'MX'],
151
+ 'selection_type' => 'included' // or 'excluded'
152
+ ];
153
+ $zone->save();
154
+
155
+ // Get the human-readable region label
156
+ $formattedRegion = $zone->formatted_region;
157
+ // 'United States', or 'Whole World' when region is 'all'
158
+ ```
159
+
160
+ ## Shipping Methods
161
+
162
+ ### Creating Shipping Methods
163
+
164
+ The shipping module provides a flexible framework for creating custom shipping methods. You can define your own shipping method types and configurations.
165
+
166
+ #### **Custom Shipping Method**
167
+
168
+ ```
169
+ $shippingMethod = ShippingMethod::create([
170
+ 'zone_id' => 1,
171
+ 'title' => 'Standard Shipping',
172
+ 'type' => 'flat_rate',
173
+ 'amount' => 5.00, // base-currency major units, not cents
174
+ 'is_enabled' => true,
175
+ 'settings' => [
176
+ 'configure_rate' => 'per_order',
177
+ 'class_aggregation' => 'sum_all'
178
+ ]
179
+ ]);
180
+ ```
181
+
182
+ #### **Free Shipping Method**
183
+
184
+ ```
185
+ $freeShipping = ShippingMethod::create([
186
+ 'zone_id' => 1,
187
+ 'title' => 'Free Shipping',
188
+ 'type' => 'free_shipping',
189
+ 'amount' => 0,
190
+ 'is_enabled' => true,
191
+ 'settings' => []
192
+ ]);
193
+ ```
194
+
195
+ #### **Weight-Based Shipping**
196
+
197
+ ```
198
+ $weightBased = ShippingMethod::create([
199
+ 'zone_id' => 1,
200
+ 'title' => 'Weight Based Shipping',
201
+ 'type' => 'flat_rate',
202
+ 'amount' => 0,
203
+ 'is_enabled' => true,
204
+ 'settings' => [
205
+ 'configure_rate' => 'per_weight',
206
+ 'weight_tiers' => [
207
+ ['min' => 0, 'max' => 5, 'cost' => 5.00],
208
+ ['min' => 5, 'max' => 0, 'cost' => 12.00] // max 0 = no upper bound
209
+ ]
210
+ ]
211
+ ]);
212
+ ```
213
+
214
+ ### Custom Shipping Methods
215
+
216
+ #### Creating a Custom Shipping Method
217
+
218
+ ```
219
+ class ExpressShipping extends ShippingMethod
220
+ {
221
+ public function calculateRate($cart, $address)
222
+ {
223
+ $baseRate = 1500; // $15 base rate
224
+ $weightRate = $cart->getTotalWeight() * 200; // $2 per lb
225
+
226
+ return $baseRate + $weightRate;
227
+ }
228
+
229
+ public function isAvailable($cart, $address)
230
+ {
231
+ // Only available for orders over $100
232
+ return $cart->getTotal() >= 10000;
233
+ }
234
+ }
235
+ ```
236
+
237
+ ## Shipping Classes
238
+
239
+ ### Creating Shipping Classes
240
+
241
+ ```
242
+ use FluentCart\App\Models\ShippingClass;
243
+
244
+ // Create shipping classes for different product types
245
+ $fragileClass = ShippingClass::create([
246
+ 'name' => 'Fragile Items',
247
+ 'cost' => 1000, // $10 additional cost
248
+ 'type' => 'fixed',
249
+ 'per_item' => false
250
+ ]);
251
+
252
+ $heavyClass = ShippingClass::create([
253
+ 'name' => 'Heavy Items',
254
+ 'cost' => 500, // $5 additional cost
255
+ 'type' => 'fixed',
256
+ 'per_item' => true // Cost per item
257
+ ]);
258
+
259
+ $digitalClass = ShippingClass::create([
260
+ 'name' => 'Digital Products',
261
+ 'cost' => 0, // No shipping cost
262
+ 'type' => 'fixed',
263
+ 'per_item' => false
264
+ ]);
265
+ ```
266
+
267
+ ### Assigning Shipping Classes to Products
268
+
269
+ ```
270
+ use FluentCart\App\Models\Product;
271
+
272
+ // Assign shipping class to a product
273
+ $product = Product::find(1);
274
+ $product->shipping_class_id = $fragileClass->id;
275
+ $product->save();
276
+
277
+ // Or through product meta
278
+ $product->updateMeta('shipping_class', $fragileClass->id);
279
+ ```
280
+
281
+ ## Rate Calculations
282
+
283
+ ### Basic Rate Calculation
284
+
285
+ ```
286
+ class ShippingCalculator
287
+ {
288
+ public function calculateShipping($cart, $address)
289
+ {
290
+ $zone = $this->getShippingZone($address);
291
+
292
+ if (!$zone) {
293
+ return null; // No shipping available
294
+ }
295
+
296
+ $methods = $zone->methods()->where('is_enabled', true)->get();
297
+ $availableMethods = [];
298
+
299
+ foreach ($methods as $method) {
300
+ if ($this->isMethodAvailable($method, $cart, $address)) {
301
+ $rate = $this->calculateMethodRate($method, $cart, $address);
302
+ $availableMethods[] = [
303
+ 'id' => $method->id,
304
+ 'title' => $method->title,
305
+ 'cost' => $rate,
306
+ 'description' => $method->settings['description'] ?? ''
307
+ ];
308
+ }
309
+ }
310
+
311
+ return $availableMethods;
312
+ }
313
+
314
+ private function calculateMethodRate($method, $cart, $address)
315
+ {
316
+ switch ($method->type) {
317
+ case 'flat_rate':
318
+ return $method->amount;
319
+
320
+ case 'free_shipping':
321
+ $minimumAmount = $method->settings['minimum_amount'] ?? 0;
322
+ return $cart->getTotal() >= $minimumAmount ? 0 : null;
323
+
324
+ case 'table_rate':
325
+ return $this->calculateTableRate($method, $cart);
326
+
327
+ default:
328
+ return $method->amount;
329
+ }
330
+ }
331
+
332
+ private function calculateTableRate($method, $cart)
333
+ {
334
+ $rates = $method->settings['rates'] ?? [];
335
+ $calculationType = $method->settings['calculation_type'] ?? 'weight';
336
+
337
+ $value = match($calculationType) {
338
+ 'weight' => $cart->getTotalWeight(),
339
+ 'quantity' => $cart->getTotalQuantity(),
340
+ 'price' => $cart->getTotal(),
341
+ default => $cart->getTotalWeight()
342
+ };
343
+
344
+ foreach ($rates as $rate) {
345
+ $min = $rate['min'];
346
+ $max = $rate['max'] == 0 ? PHP_FLOAT_MAX : $rate['max'];
347
+
348
+ if ($value >= $min && $value <= $max) {
349
+ return $rate['cost'];
350
+ }
351
+ }
352
+
353
+ return 0; // No matching rate found
354
+ }
355
+ }
356
+ ```
357
+
358
+ ### Advanced Rate Calculation with Shipping Classes
359
+
360
+ ```
361
+ class AdvancedShippingCalculator extends ShippingCalculator
362
+ {
363
+ public function calculateMethodRate($method, $cart, $address)
364
+ {
365
+ $baseRate = parent::calculateMethodRate($method, $cart, $address);
366
+
367
+ if ($baseRate === null) {
368
+ return null;
369
+ }
370
+
371
+ // Add shipping class costs
372
+ $shippingClassCost = $this->calculateShippingClassCost($cart);
373
+
374
+ return $baseRate + $shippingClassCost;
375
+ }
376
+
377
+ private function calculateShippingClassCost($cart)
378
+ {
379
+ $totalCost = 0;
380
+ $shippingClasses = [];
381
+
382
+ foreach ($cart->getItems() as $item) {
383
+ $product = $item->product;
384
+ $shippingClass = $product->shippingClass;
385
+
386
+ if ($shippingClass) {
387
+ if (!isset($shippingClasses[$shippingClass->id])) {
388
+ $shippingClasses[$shippingClass->id] = [
389
+ 'class' => $shippingClass,
390
+ 'quantity' => 0
391
+ ];
392
+ }
393
+ $shippingClasses[$shippingClass->id]['quantity'] += $item->quantity;
394
+ }
395
+ }
396
+
397
+ foreach ($shippingClasses as $classData) {
398
+ $class = $classData['class'];
399
+ $quantity = $classData['quantity'];
400
+
401
+ if ($class->per_item) {
402
+ $totalCost += $class->cost * $quantity;
403
+ } else {
404
+ $totalCost += $class->cost; // Fixed cost per order
405
+ }
406
+ }
407
+
408
+ return $totalCost;
409
+ }
410
+ }
411
+ ```
412
+
413
+ ## API Endpoints
414
+
415
+ ### Shipping Zones API
416
+
417
+ #### List Shipping Zones
418
+
419
+ ```
420
+ GET /wp-json/fluent-cart/v2/shipping/zones
421
+ ```
422
+
423
+ **Response:**
424
+
425
+ ```
426
+ {
427
+ "success": true,
428
+ "data": {
429
+ "zones": [
430
+ {
431
+ "id": 1,
432
+ "name": "United States",
433
+ "region": "US",
434
+ "order": 1,
435
+ "formatted_region": "United States",
436
+ "methods": [
437
+ {
438
+ "id": 1,
439
+ "title": "Standard Shipping",
440
+ "type": "flat_rate",
441
+ "amount": "5.00",
442
+ "is_enabled": true
443
+ }
444
+ ]
445
+ }
446
+ ]
447
+ }
448
+ }
449
+ ```
450
+
451
+ #### Create Shipping Zone
452
+
453
+ ```
454
+ POST /wp-json/fluent-cart/v2/shipping/zones
455
+ ```
456
+
457
+ **Request Body:**
458
+
459
+ ```
460
+ {
461
+ "name": "Europe",
462
+ "region": "selection",
463
+ "order": 2
464
+ }
465
+ ```
466
+
467
+ #### Update Shipping Zone
468
+
469
+ ```
470
+ PUT /wp-json/fluent-cart/v2/shipping/zones/{id}
471
+ ```
472
+
473
+ **Request Body:**
474
+
475
+ ```
476
+ {
477
+ "name": "European Union",
478
+ "region": "selection",
479
+ "order": 2
480
+ }
481
+ ```
482
+
483
+ #### Delete Shipping Zone
484
+
485
+ ```
486
+ DELETE /wp-json/fluent-cart/v2/shipping/zones/{id}
487
+ ```
488
+
489
+ ### Shipping Methods API
490
+
491
+ #### Create Shipping Method
492
+
493
+ ```
494
+ POST /wp-json/fluent-cart/v2/shipping/methods
495
+ ```
496
+
497
+ **Request Body:**
498
+
499
+ ```
500
+ {
501
+ "zone_id": 1,
502
+ "title": "Express Shipping",
503
+ "type": "flat_rate",
504
+ "amount": "15.00",
505
+ "is_enabled": true,
506
+ "settings": {
507
+ "cost": 1500,
508
+ "description": "Express delivery within 2-3 business days"
509
+ }
510
+ }
511
+ ```
512
+
513
+ #### Update Shipping Method
514
+
515
+ ```
516
+ PUT /wp-json/fluent-cart/v2/shipping/methods
517
+ ```
518
+
519
+ **Request Body:**
520
+
521
+ ```
522
+ {
523
+ "method_id": 1,
524
+ "title": "Standard Shipping",
525
+ "amount": "8.00",
526
+ "settings": {
527
+ "cost": 800,
528
+ "description": "Standard delivery within 5-7 business days"
529
+ }
530
+ }
531
+ ```
532
+
533
+ #### Delete Shipping Method
534
+
535
+ ```
536
+ DELETE /wp-json/fluent-cart/v2/shipping/methods/{method_id}
537
+ ```
538
+
539
+ ### Shipping Classes API
540
+
541
+ #### List Shipping Classes
542
+
543
+ ```
544
+ GET /wp-json/fluent-cart/v2/shipping/classes
545
+ ```
546
+
547
+ **Response:**
548
+
549
+ ```
550
+ {
551
+ "success": true,
552
+ "data": {
553
+ "classes": [
554
+ {
555
+ "id": 1,
556
+ "name": "Fragile Items",
557
+ "cost": 1000,
558
+ "type": "fixed",
559
+ "per_item": false
560
+ },
561
+ {
562
+ "id": 2,
563
+ "name": "Heavy Items",
564
+ "cost": 500,
565
+ "type": "fixed",
566
+ "per_item": true
567
+ }
568
+ ]
569
+ }
570
+ }
571
+ ```
572
+
573
+ #### Create Shipping Class
574
+
575
+ ```
576
+ POST /wp-json/fluent-cart/v2/shipping/classes
577
+ ```
578
+
579
+ **Request Body:**
580
+
581
+ ```
582
+ {
583
+ "name": "Digital Products",
584
+ "cost": 0,
585
+ "type": "fixed",
586
+ "per_item": false
587
+ }
588
+ ```
589
+
590
+ ## Frontend Integration
591
+
592
+ ### Getting Available Shipping Methods
593
+
594
+ ```
595
+ GET /wp-json/fluent-cart/v2/checkout/get-available-shipping-methods
596
+ ```
597
+
598
+ **Query Parameters:**
599
+
600
+ - `country_code` - Country code (e.g., 'US', 'GB')
601
+ - `timezone` - Timezone for automatic country detection
602
+
603
+ **Response:**
604
+
605
+ ```
606
+ {
607
+ "status": true,
608
+ "available_shipping_methods": [
609
+ {
610
+ "id": 1,
611
+ "title": "Standard Shipping",
612
+ "type": "flat_rate",
613
+ "amount": "5.00",
614
+ "settings": {
615
+ "description": "Standard delivery within 5-7 business days"
616
+ }
617
+ },
618
+ {
619
+ "id": 2,
620
+ "title": "Express Shipping",
621
+ "type": "flat_rate",
622
+ "amount": "15.00",
623
+ "settings": {
624
+ "description": "Express delivery within 2-3 business days"
625
+ }
626
+ }
627
+ ]
628
+ }
629
+ ```
630
+
631
+ ### JavaScript Integration
632
+
633
+ ```
634
+ // Get available shipping methods
635
+ async function getShippingMethods(countryCode) {
636
+ try {
637
+ const response = await fetch(`/wp-json/fluent-cart/v2/checkout/get-available-shipping-methods?country_code=${countryCode}`);
638
+ const data = await response.json();
639
+
640
+ if (data.status) {
641
+ return data.available_shipping_methods;
642
+ } else {
643
+ console.error('No shipping methods available:', data.message);
644
+ return [];
645
+ }
646
+ } catch (error) {
647
+ console.error('Error fetching shipping methods:', error);
648
+ return [];
649
+ }
650
+ }
651
+
652
+ // Update shipping options in checkout
653
+ function updateShippingOptions(methods) {
654
+ const shippingContainer = document.getElementById('shipping-options');
655
+
656
+ if (methods.length === 0) {
657
+ shippingContainer.innerHTML = '<p>No shipping methods available for this location.</p>';
658
+ return;
659
+ }
660
+
661
+ let html = '<div class="shipping-methods">';
662
+
663
+ methods.forEach(method => {
664
+ html += `
665
+ <div class="shipping-method">
666
+ <input type="radio" name="shipping_method" value="${method.id}" id="shipping_${method.id}">
667
+ <label for="shipping_${method.id}">
668
+ <span class="method-title">${method.title}</span>
669
+ <span class="method-cost">$${(method.amount / 100).toFixed(2)}</span>
670
+ <span class="method-description">${method.settings.description || ''}</span>
671
+ </label>
672
+ </div>
673
+ `;
674
+ });
675
+
676
+ html += '</div>';
677
+ shippingContainer.innerHTML = html;
678
+ }
679
+
680
+ // Usage
681
+ document.addEventListener('DOMContentLoaded', async function() {
682
+ const countrySelect = document.getElementById('country');
683
+
684
+ countrySelect.addEventListener('change', async function() {
685
+ const countryCode = this.value;
686
+ const methods = await getShippingMethods(countryCode);
687
+ updateShippingOptions(methods);
688
+ });
689
+
690
+ // Load initial shipping methods
691
+ const initialCountry = countrySelect.value;
692
+ const initialMethods = await getShippingMethods(initialCountry);
693
+ updateShippingOptions(initialMethods);
694
+ });
695
+ ```
696
+
697
+ ## Custom Shipping Method Development
698
+
699
+ ### Creating a Custom Shipping Method
700
+
701
+ ```
702
+ <?php
703
+ namespace FluentCart\App\Modules\Shipping\Methods;
704
+
705
+ use FluentCart\App\Models\ShippingMethod;
706
+ use FluentCart\App\Models\Cart;
707
+
708
+ class CustomShippingMethod
709
+ {
710
+ protected $method;
711
+
712
+ public function __construct(ShippingMethod $method)
713
+ {
714
+ $this->method = $method;
715
+ }
716
+
717
+ public function calculateRate(Cart $cart, $address)
718
+ {
719
+ // Custom calculation logic
720
+ $baseRate = $this->method->amount;
721
+ $weight = $cart->getTotalWeight();
722
+ $distance = $this->calculateDistance($address);
723
+
724
+ // Example: Base rate + weight factor + distance factor
725
+ $rate = $baseRate + ($weight * 100) + ($distance * 50);
726
+
727
+ return $rate;
728
+ }
729
+
730
+ public function isAvailable(Cart $cart, $address)
731
+ {
732
+ // Check if method is available for this cart/address
733
+ $minimumOrder = $this->method->settings['minimum_order'] ?? 0;
734
+
735
+ return $cart->getTotal() >= $minimumOrder;
736
+ }
737
+
738
+ private function calculateDistance($address)
739
+ {
740
+ // Implement distance calculation logic
741
+ // This could use a mapping service API
742
+ return 0; // Placeholder
743
+ }
744
+ }
745
+ ```
746
+
747
+ ### Registering Custom Shipping Methods
748
+
749
+ ```
750
+ // In your module's initialization
751
+ add_action('fluentcart_loaded', function($app) {
752
+ // Register custom shipping method type
753
+ add_filter('fluent_cart/shipping/method_types', function($types) {
754
+ $types['custom_method'] = [
755
+ 'title' => 'Custom Shipping',
756
+ 'class' => CustomShippingMethod::class,
757
+ 'settings' => [
758
+ 'minimum_order' => [
759
+ 'type' => 'number',
760
+ 'label' => 'Minimum Order Amount',
761
+ 'default' => 0
762
+ ],
763
+ 'custom_setting' => [
764
+ 'type' => 'text',
765
+ 'label' => 'Custom Setting',
766
+ 'default' => ''
767
+ ]
768
+ ]
769
+ ];
770
+
771
+ return $types;
772
+ });
773
+ });
774
+ ```
775
+
776
+ ## Hooks and Filters
777
+
778
+ ### Shipping Calculation Hooks
779
+
780
+ ```
781
+ // Modify shipping rates before calculation
782
+ add_filter('fluent_cart/shipping/calculate_rate', function($rate, $method, $cart, $address) {
783
+ // Apply custom logic to modify rate
784
+ if ($cart->hasCoupon('FREE_SHIPPING')) {
785
+ return 0; // Free shipping with coupon
786
+ }
787
+
788
+ return $rate;
789
+ }, 10, 4);
790
+
791
+ // Add custom shipping methods
792
+ add_filter('fluent_cart/shipping/available_methods', function($methods, $cart, $address) {
793
+ // Add custom method if conditions are met
794
+ if ($cart->getTotal() > 10000) { // Orders over $100
795
+ $methods[] = [
796
+ 'id' => 'custom_express',
797
+ 'title' => 'Custom Express',
798
+ 'cost' => 2000,
799
+ 'description' => 'Custom express shipping for large orders'
800
+ ];
801
+ }
802
+
803
+ return $methods;
804
+ }, 10, 3);
805
+
806
+ // Modify shipping zone selection
807
+ add_filter('fluent_cart/shipping/zone_for_address', function($zone, $address) {
808
+ // Custom zone selection logic
809
+ if ($address['country'] === 'US' && $address['state'] === 'CA') {
810
+ // Special handling for California
811
+ return ShippingZone::where('name', 'California Special')->first();
812
+ }
813
+
814
+ return $zone;
815
+ }, 10, 2);
816
+ ```
817
+
818
+ ### Shipping Method Hooks
819
+
820
+ ```
821
+ // Before shipping method is saved
822
+ add_action('fluent_cart/shipping/method/before_save', function($method) {
823
+ // Validate or modify method before saving
824
+ if ($method->type === 'custom_method') {
825
+ // Custom validation logic
826
+ }
827
+ });
828
+
829
+ // After shipping method is saved
830
+ add_action('fluent_cart/shipping/method/after_save', function($method) {
831
+ // Perform actions after method is saved
832
+ // e.g., update external shipping service
833
+ });
834
+
835
+ // Before shipping method is deleted
836
+ add_action('fluent_cart/shipping/method/before_delete', function($method) {
837
+ // Clean up related data
838
+ });
839
+ ```
840
+
841
+ ---
842
+
843
+ **Next Steps:**
844
+
845
+ - [Storage Drivers](./storage.md) - File storage integration
846
+ - [Modules Overview](./index.md) - Back to modules overview