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.
- package/LICENSE.md +26 -26
- package/README.md +59 -59
- package/dist/cards/fluentcart/templates-native.js +1087 -1087
- package/dist/cards/fluentcart/tools.js +2309 -2309
- package/dist/server.d.ts.map +1 -1
- package/dist/server.js +37 -1
- package/dist/server.js.map +1 -1
- package/dist/skills/fluentcart-developer/SKILL.md +108 -108
- package/dist/skills/fluentcart-developer/examples/README.md +30 -30
- package/dist/skills/fluentcart-developer/examples/fluentcart-starter-child-theme/fluent-cart/checkout.php +32 -32
- package/dist/skills/fluentcart-developer/examples/fluentcart-starter-child-theme/functions.php +40 -40
- package/dist/skills/fluentcart-developer/examples/sample-custom-addon/fluentcart-custom-addon.php +113 -113
- package/dist/skills/fluentcart-developer/examples/sample-custom-payment-gateway/fluentcart-custom-gateway-example.php +148 -148
- package/dist/skills/fluentcart-developer/examples/sample-fee-surcharge-plugin/fluentcart-fee-surcharge.php +38 -38
- package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/README.md +22 -22
- package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/sample-plugin-with-licensing-sdk.php +79 -79
- package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/updater/FluentLicensing.php +303 -303
- package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/updater/LicenseSettings.php +566 -566
- package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/updater/PluginUpdater.php +304 -304
- package/dist/skills/fluentcart-developer/examples/sample-shipping-carrier/fluentcart-custom-shipping-carrier.php +61 -61
- package/dist/skills/fluentcart-developer/references/api/authentication.md +452 -452
- package/dist/skills/fluentcart-developer/references/api/coupons.md +786 -786
- package/dist/skills/fluentcart-developer/references/api/customers.md +889 -889
- package/dist/skills/fluentcart-developer/references/api/files.md +609 -609
- package/dist/skills/fluentcart-developer/references/api/index.md +432 -432
- package/dist/skills/fluentcart-developer/references/api/licensing.md +633 -633
- package/dist/skills/fluentcart-developer/references/api/order-bump.md +384 -384
- package/dist/skills/fluentcart-developer/references/api/orders.md +814 -814
- package/dist/skills/fluentcart-developer/references/api/products.md +866 -866
- package/dist/skills/fluentcart-developer/references/api/roles-permissions.md +536 -536
- package/dist/skills/fluentcart-developer/references/api/subscriptions.md +827 -827
- package/dist/skills/fluentcart-developer/references/database/index.md +44 -44
- package/dist/skills/fluentcart-developer/references/database/models/activity.md +178 -178
- package/dist/skills/fluentcart-developer/references/database/models/applied-coupon.md +291 -291
- package/dist/skills/fluentcart-developer/references/database/models/attribute-group.md +239 -239
- package/dist/skills/fluentcart-developer/references/database/models/attribute-relation.md +181 -181
- package/dist/skills/fluentcart-developer/references/database/models/attribute-term.md +219 -219
- package/dist/skills/fluentcart-developer/references/database/models/cart.md +645 -645
- package/dist/skills/fluentcart-developer/references/database/models/coupon.md +427 -427
- package/dist/skills/fluentcart-developer/references/database/models/customer-addresses.md +348 -348
- package/dist/skills/fluentcart-developer/references/database/models/customer-meta.md +156 -156
- package/dist/skills/fluentcart-developer/references/database/models/customer.md +584 -584
- package/dist/skills/fluentcart-developer/references/database/models/dynamic-model.md +163 -163
- package/dist/skills/fluentcart-developer/references/database/models/label-relationship.md +155 -155
- package/dist/skills/fluentcart-developer/references/database/models/label.md +153 -153
- package/dist/skills/fluentcart-developer/references/database/models/license-activation.md +182 -182
- package/dist/skills/fluentcart-developer/references/database/models/license-meta.md +163 -163
- package/dist/skills/fluentcart-developer/references/database/models/license-site.md +208 -208
- package/dist/skills/fluentcart-developer/references/database/models/license.md +640 -640
- package/dist/skills/fluentcart-developer/references/database/models/meta.md +233 -233
- package/dist/skills/fluentcart-developer/references/database/models/order-address.md +391 -391
- package/dist/skills/fluentcart-developer/references/database/models/order-download-permission.md +144 -144
- package/dist/skills/fluentcart-developer/references/database/models/order-item.md +383 -383
- package/dist/skills/fluentcart-developer/references/database/models/order-meta.md +303 -303
- package/dist/skills/fluentcart-developer/references/database/models/order-operation.md +158 -158
- package/dist/skills/fluentcart-developer/references/database/models/order-promotion-stat.md +175 -175
- package/dist/skills/fluentcart-developer/references/database/models/order-promotion.md +250 -250
- package/dist/skills/fluentcart-developer/references/database/models/order-tax-rate.md +172 -172
- package/dist/skills/fluentcart-developer/references/database/models/order-transaction.md +440 -440
- package/dist/skills/fluentcart-developer/references/database/models/order.md +727 -727
- package/dist/skills/fluentcart-developer/references/database/models/product-detail.md +397 -397
- package/dist/skills/fluentcart-developer/references/database/models/product-download.md +258 -258
- package/dist/skills/fluentcart-developer/references/database/models/product-meta.md +153 -153
- package/dist/skills/fluentcart-developer/references/database/models/product-variation.md +556 -556
- package/dist/skills/fluentcart-developer/references/database/models/product.md +580 -580
- package/dist/skills/fluentcart-developer/references/database/models/relationships.md +427 -427
- package/dist/skills/fluentcart-developer/references/database/models/scheduled-action.md +175 -175
- package/dist/skills/fluentcart-developer/references/database/models/shipping-class.md +148 -148
- package/dist/skills/fluentcart-developer/references/database/models/shipping-method.md +280 -280
- package/dist/skills/fluentcart-developer/references/database/models/shipping-zone.md +205 -205
- package/dist/skills/fluentcart-developer/references/database/models/subscription-meta.md +173 -173
- package/dist/skills/fluentcart-developer/references/database/models/subscription.md +528 -528
- package/dist/skills/fluentcart-developer/references/database/models/tax-class.md +195 -195
- package/dist/skills/fluentcart-developer/references/database/models/tax-rate.md +225 -225
- package/dist/skills/fluentcart-developer/references/database/models/user-meta.md +166 -166
- package/dist/skills/fluentcart-developer/references/database/models/user.md +220 -220
- package/dist/skills/fluentcart-developer/references/database/models.md +404 -404
- package/dist/skills/fluentcart-developer/references/database/query-builder.md +860 -860
- package/dist/skills/fluentcart-developer/references/database/readme.md +276 -276
- package/dist/skills/fluentcart-developer/references/database/schema.md +1002 -1002
- package/dist/skills/fluentcart-developer/references/engineering/adding-custom-pages-to-the-customer-dashboard.md +395 -395
- package/dist/skills/fluentcart-developer/references/engineering/index.md +4 -4
- package/dist/skills/fluentcart-developer/references/engineering.md +4 -4
- package/dist/skills/fluentcart-developer/references/getting-started.md +249 -249
- package/dist/skills/fluentcart-developer/references/guides/frontend.md +519 -519
- package/dist/skills/fluentcart-developer/references/guides/index.md +107 -107
- package/dist/skills/fluentcart-developer/references/guides/integrations.md +600 -600
- package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/index.md +237 -237
- package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/labels-and-tracking.md +481 -481
- package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/live-rates.md +269 -269
- package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/reference.md +223 -223
- package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/settings.md +370 -370
- package/dist/skills/fluentcart-developer/references/guides/shipping-carrier.md +237 -237
- package/dist/skills/fluentcart-developer/references/guides/subscriptions.md +217 -217
- package/dist/skills/fluentcart-developer/references/hooks/actions/admin-and-templates.md +1079 -1079
- package/dist/skills/fluentcart-developer/references/hooks/actions/cart-and-checkout.md +1795 -1795
- package/dist/skills/fluentcart-developer/references/hooks/actions/customers-and-users.md +327 -327
- package/dist/skills/fluentcart-developer/references/hooks/actions/licenses.md +829 -829
- package/dist/skills/fluentcart-developer/references/hooks/actions/modules.md +81 -81
- package/dist/skills/fluentcart-developer/references/hooks/actions/orders.md +757 -757
- package/dist/skills/fluentcart-developer/references/hooks/actions/payments-and-integrations.md +1163 -1163
- package/dist/skills/fluentcart-developer/references/hooks/actions/pro-modules.md +219 -219
- package/dist/skills/fluentcart-developer/references/hooks/actions/products-and-coupons.md +1019 -1019
- package/dist/skills/fluentcart-developer/references/hooks/actions/subscriptions.md +1290 -1290
- package/dist/skills/fluentcart-developer/references/hooks/actions.md +16 -16
- package/dist/skills/fluentcart-developer/references/hooks/deprecated.md +60 -60
- package/dist/skills/fluentcart-developer/references/hooks/filters/cart-and-checkout.md +2032 -2032
- package/dist/skills/fluentcart-developer/references/hooks/filters/customers-and-subscriptions.md +1746 -1746
- package/dist/skills/fluentcart-developer/references/hooks/filters/integrations-and-advanced.md +2439 -2439
- package/dist/skills/fluentcart-developer/references/hooks/filters/modules.md +464 -464
- package/dist/skills/fluentcart-developer/references/hooks/filters/orders-and-payments.md +2658 -2658
- package/dist/skills/fluentcart-developer/references/hooks/filters/pro-modules.md +502 -502
- package/dist/skills/fluentcart-developer/references/hooks/filters/products-and-pricing.md +1785 -1785
- package/dist/skills/fluentcart-developer/references/hooks/filters/settings-and-configuration.md +2966 -2966
- package/dist/skills/fluentcart-developer/references/hooks/filters.md +14 -14
- package/dist/skills/fluentcart-developer/references/hooks/index.md +35 -35
- package/dist/skills/fluentcart-developer/references/index.md +625 -625
- package/dist/skills/fluentcart-developer/references/modules/fee-system.md +427 -427
- package/dist/skills/fluentcart-developer/references/modules/ghost-product-selling.md +440 -440
- package/dist/skills/fluentcart-developer/references/modules/index.md +484 -484
- package/dist/skills/fluentcart-developer/references/modules/licensing.md +342 -342
- package/dist/skills/fluentcart-developer/references/modules/order-bump.md +433 -433
- package/dist/skills/fluentcart-developer/references/modules/payment-methods.md +129 -129
- package/dist/skills/fluentcart-developer/references/modules/refunds.md +170 -170
- package/dist/skills/fluentcart-developer/references/modules/shipping.md +846 -846
- package/dist/skills/fluentcart-developer/references/modules/storage.md +986 -986
- package/dist/skills/fluentcart-developer/references/modules/subscription-vendor-ids.md +186 -186
- package/dist/skills/fluentcart-developer/references/modules/subscriptions.md +678 -678
- package/dist/skills/fluentcart-developer/references/payment-methods-integration/index.md +164 -164
- package/dist/skills/fluentcart-developer/references/payment-methods-integration/paddle-example.md +1648 -1648
- package/dist/skills/fluentcart-developer/references/payment-methods-integration/payment/setting/fields.md +353 -353
- package/dist/skills/fluentcart-developer/references/payment-methods-integration/quick-implementation.md +1079 -1079
- package/dist/skills/fluentcart-developer/references/payment-methods-integration.md +164 -164
- package/dist/skills/fluentcart-developer/references/restapi/checkout.md +573 -573
- package/dist/skills/fluentcart-developer/references/restapi/coupons.md +958 -958
- package/dist/skills/fluentcart-developer/references/restapi/customer-profile.md +1423 -1423
- package/dist/skills/fluentcart-developer/references/restapi/customers.md +1103 -1103
- package/dist/skills/fluentcart-developer/references/restapi/dashboard.md +1083 -1083
- package/dist/skills/fluentcart-developer/references/restapi/data-export.md +132 -132
- package/dist/skills/fluentcart-developer/references/restapi/email-notifications.md +846 -846
- package/dist/skills/fluentcart-developer/references/restapi/files.md +313 -313
- package/dist/skills/fluentcart-developer/references/restapi/index.md +127 -127
- package/dist/skills/fluentcart-developer/references/restapi/integrations.md +1000 -1000
- package/dist/skills/fluentcart-developer/references/restapi/inventory.md +192 -192
- package/dist/skills/fluentcart-developer/references/restapi/labels-and-attributes.md +797 -797
- package/dist/skills/fluentcart-developer/references/restapi/licensing.md +1733 -1733
- package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-available-shipping-methods.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-checkout-summary.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-country-info.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-order-info.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-shipping-methods-list-view.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/login.md +66 -66
- package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/place-order.md +179 -179
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/apply-coupon.md +83 -83
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/cancel-coupon.md +87 -87
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/check-product-eligibility.md +59 -59
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/create-coupon.md +230 -230
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/delete-coupon.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/get-coupon-settings.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/get-coupon.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/list-coupon-codes.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/list-coupons.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/re-apply-coupons.md +75 -75
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/store-coupon-settings.md +40 -40
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/update-coupon.md +133 -133
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/create-address-checkout.md +138 -138
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/create-profile-address.md +119 -119
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/dashboard-overview.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/delete-profile-address.md +46 -46
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-order-details.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-portal-sections.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-profile-details.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-transaction-billing-address.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-upgrade-paths.md +31 -31
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/list-downloads.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/list-orders.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/make-profile-address-primary.md +55 -55
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/pause-subscription.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/resume-subscription.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/save-transaction-billing-address.md +92 -92
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/select-address-for-checkout.md +32 -32
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/update-profile-address.md +115 -115
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/update-profile-details.md +69 -69
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/attach-user.md +50 -50
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/bulk-actions.md +65 -65
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/create-address.md +135 -135
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/create-customer.md +108 -108
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/delete-address.md +62 -62
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/detach-user.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/find-customer-order.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-attachable-users.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer-addresses.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer-orders.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer-stats.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer.md +32 -32
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/list-customers.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/recalculate-ltv.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/set-primary-address.md +72 -72
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/update-additional-info.md +55 -55
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/update-address.md +144 -144
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/update-customer.md +123 -123
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/attach-note-to-order.md +49 -49
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/create-all-pages.md +21 -21
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/create-single-page.md +55 -55
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/delete-activity.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-country-info.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-dashboard-stats.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-filter-options.md +31 -31
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-onboarding-data.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-onboarding-settings.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-print-templates.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-search-options.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-widgets.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/initialize-app.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/list-activities.md +33 -33
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/list-attachments.md +21 -21
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/list-countries.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/mark-activity-read.md +53 -53
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/run-data-backfills.md +21 -21
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/save-onboarding-settings.md +54 -54
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/save-onboarding-tax-settings.md +73 -73
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/save-print-templates.md +64 -64
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/upload-attachment.md +42 -42
- package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-customers-batch.md +129 -129
- package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-licenses-batch.md +133 -133
- package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-orders-batch.md +129 -129
- package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-subscriptions-batch.md +129 -129
- package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-customers-export-schema.md +21 -21
- package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-licenses-export-schema.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-orders-export-schema.md +21 -21
- package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-subscriptions-export-schema.md +21 -21
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/enable-notification.md +57 -57
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-digest-settings.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-notification.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-reminders.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-settings.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-shortcodes.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/list-notifications.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/preview-default-template.md +66 -66
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/preview-notification.md +50 -50
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/save-digest-settings.md +101 -101
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/save-reminders.md +162 -162
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/save-settings.md +99 -99
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/send-digest-test.md +47 -47
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/send-manual-reminder.md +51 -51
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/update-notification.md +93 -93
- package/dist/skills/fluentcart-developer/references/restapi/operations/files/delete-file.md +31 -31
- package/dist/skills/fluentcart-developer/references/restapi/operations/files/get-bucket-list.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/files/list-files.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/files/upload-editor-file.md +32 -32
- package/dist/skills/fluentcart-developer/references/restapi/operations/files/upload-file.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/chained-data-request.md +46 -46
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/change-feed-status.md +51 -51
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/delete-feed.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-dynamic-options.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-feed-lists.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-feed-settings.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-global-feeds.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-global-settings.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/install-addon-plugin.md +49 -49
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/list-addons.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/save-feed-settings.md +52 -52
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/set-global-settings.md +50 -50
- package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/bulk-update-stock.md +94 -94
- package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/export-inventory.md +81 -81
- package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/get-adjustment-history.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/get-inventory-stats.md +21 -21
- package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/list-inventory.md +33 -33
- package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/update-stock.md +75 -75
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/create-attribute-group.md +31 -31
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/create-label.md +31 -31
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/create-terms.md +90 -90
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/delete-attribute-group.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/delete-attribute-term.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/get-attribute-group.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/get-attribute-library.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/list-attribute-groups.md +32 -32
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/list-attribute-terms.md +33 -33
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/list-labels.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/reorder-groups.md +51 -51
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/reorder-terms.md +56 -56
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/update-attribute-group.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/update-attribute-term.md +39 -39
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/update-label-selections.md +32 -32
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/activate-plugin-license.md +41 -41
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/activate-site-admin.md +60 -60
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/deactivate-plugin-license.md +18 -18
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/deactivate-site-admin.md +67 -67
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/deactivate-site-customer.md +47 -47
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/delete-license.md +24 -24
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/extend-license-validity.md +47 -47
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-customer-license-details.md +25 -25
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-customer-licenses-admin.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-license-activations.md +25 -25
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-license-details.md +25 -25
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-license-site.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-plugin-license-status.md +18 -18
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-product-license-settings.md +24 -24
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/list-customer-licenses.md +25 -25
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/list-license-sites.md +33 -33
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/list-licenses.md +38 -38
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-activate-license.md +54 -54
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-check-license.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-deactivate-license.md +46 -46
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-download-license-package.md +23 -23
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-get-license-version.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/regenerate-license-key.md +24 -24
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/save-product-license-settings.md +193 -193
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/update-license-activation-limit.md +53 -53
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/update-license-status.md +52 -52
- package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/create-order-bump.md +47 -47
- package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/delete-order-bump.md +25 -25
- package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/get-order-bump.md +25 -25
- package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/list-order-bumps.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/update-order-bump.md +141 -141
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/accept-dispute.md +47 -47
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/bulk-actions.md +72 -72
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/calculate-shipping.md +67 -67
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/calculate-tax.md +98 -98
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/change-customer.md +50 -50
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/charge-now.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-and-change-customer.md +92 -92
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-custom-order-item.md +68 -68
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-order.md +351 -351
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-renewal-now.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/delete-order.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/generate-missing-licenses.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-order-transactions.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-order.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-renewal.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-shipping-methods.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-single-transaction.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/list-order-currencies.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/list-orders.md +42 -42
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/list-renewals.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/mark-as-paid.md +61 -61
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/price-order.md +135 -135
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/refund-order.md +72 -72
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/resend-renewal-invoice.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/skip-renewal.md +48 -48
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/sync-order-statuses.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/sync-pending-transaction.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-order-address-id.md +60 -60
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-order-address.md +98 -98
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-order.md +172 -172
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-statuses.md +77 -77
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-subscription-details.md +84 -84
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-transaction-status.md +51 -51
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/void-renewal.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/create-pdf-template.md +42 -42
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/delete-pdf-template.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/download-pdf-preview.md +44 -44
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-factory-default-templates.md +19 -19
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-pdf-status.md +21 -21
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-pdf-template.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-saved-templates.md +21 -21
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-seller-details.md +19 -19
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/list-pdf-templates.md +19 -19
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/save-pdf-template.md +53 -53
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/save-seller-details.md +97 -97
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/add-product-terms.md +64 -64
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-edit-fetch.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-insert-products.md +62 -62
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-update-products.md +59 -59
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-update-variants.md +83 -83
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/change-integration-status.md +64 -64
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/create-dummy-products.md +45 -45
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/create-product.md +81 -81
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/create-variation.md +181 -181
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-downloadable-file.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-product-integration.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-product.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-taxonomy-term.md +55 -55
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-upgrade-path.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-variation.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/do-bulk-action.md +56 -56
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/duplicate-product.md +56 -56
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-products-by-ids.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-taxonomy-terms.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-terms-by-parent.md +60 -60
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-variations-by-ids.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/find-subscription-variants.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-bundle-info.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-downloadable-url.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-max-excerpt-word-count.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-pricing-widgets.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product-integration-feeds.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product-integration-settings.md +31 -31
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product-pricing.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-related-products.md +31 -31
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-upgrade-settings.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-variation-upgrade-paths.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/group-bulk-update-variants.md +103 -103
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/list-all-variants.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/list-product-variations.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/list-products.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/remove-shipping-class.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/remove-tax-class.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/save-bundle-info.md +56 -56
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/save-product-integration.md +62 -62
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/save-upgrade-path.md +78 -78
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/search-product-variant-options.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/search-products-by-name.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/search-variants-by-name.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/set-variation-media.md +74 -74
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/suggest-sku.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/sync-downloadable-files.md +134 -134
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/sync-taxonomy-terms.md +61 -61
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/toggle-product-tax-exemption.md +56 -56
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-downloadable-file.md +98 -98
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-inventory.md +56 -56
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-long-desc-editor-mode.md +49 -49
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-manage-stock.md +53 -53
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-product-detail.md +58 -58
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-product-pricing.md +225 -225
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-shipping-class.md +49 -49
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-tax-class.md +49 -49
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-upgrade-path.md +78 -78
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variant-option.md +79 -79
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variant-tax-exemption.md +56 -56
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variation-pricing-table.md +49 -49
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variation.md +105 -105
- package/dist/skills/fluentcart-developer/references/restapi/operations/public-shop/get-product-views.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/public-shop/list-products.md +42 -42
- package/dist/skills/fluentcart-developer/references/restapi/operations/public-shop/search-products.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/channel-rules.md +24 -24
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/country-heat-map.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/coupon-overview.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/coupons.md +36 -36
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-insights.md +31 -31
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-overview.md +36 -36
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-repeat.md +35 -35
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-segment-customers.md +36 -36
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-segments.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-value.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/dashboard-stats.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/failed-orders.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-new-vs-returning-customer.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-report-by-day-and-hour.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-report-meta.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-top-sold-products.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/future-renewals.md +31 -31
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/generate-retention-snapshots.md +24 -24
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-overview.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-recent-activities.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-recent-orders.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-revenue.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/installments-at-risk.md +35 -35
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/installments-variations.md +33 -33
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/installments.md +33 -33
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/item-count-distribution.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/license-chart.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/license-pie-chart.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/license-summary.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/locations.md +43 -43
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-chart.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-completion-time.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-mix.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-value-distribution.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/payment-methods-disputes.md +38 -38
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/payment-methods-methods.md +36 -36
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/payment-methods.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-comparison-launch.md +33 -33
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-comparison.md +40 -40
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-detail.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-sales.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/refunds-overview.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/retention-snapshots-step.md +45 -45
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/sales-growth-chart.md +35 -35
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/save-channel-rules.md +73 -73
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/source-channels.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/sources.md +49 -49
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-cohorts.md +33 -33
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-health.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-rebuys.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-retention.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-variations.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscriptions-overview.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/weeks-between-refund.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/assign-role.md +48 -48
- package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/delete-role-assignment.md +47 -47
- package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/get-role.md +25 -25
- package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/list-managers.md +18 -18
- package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/list-roles.md +18 -18
- package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/search-users.md +25 -25
- package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/update-role.md +43 -43
- package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/create-saved-view.md +106 -106
- package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/delete-saved-view.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/list-saved-views.md +25 -25
- package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/update-saved-view.md +83 -83
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/activate-payment-addon.md +44 -44
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/activate-plugin-addon.md +44 -44
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/change-storage-driver-status.md +56 -56
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/check-paypal-webhook.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/create-storage-bucket.md +63 -63
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/disconnect-payment-method.md +55 -55
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/exchange-paypal-seller-auth-token.md +62 -62
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-active-storage-drivers.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-checkout-fields.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-email-shortcodes.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-mcp-config-snippets.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-mcp-status.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-module-settings.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-payment-method-connection-info.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-payment-method-settings.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-permissions.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-plugin-addons.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-storage-driver-settings.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-store-settings.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/install-mcp-adapter.md +21 -21
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/install-payment-addon.md +60 -60
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/install-plugin-addon.md +64 -64
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/list-all-payment-methods.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/list-all-storage-drivers.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/list-storage-buckets.md +67 -67
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/reorder-payment-methods.md +55 -55
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/reset-storage-driver-settings.md +45 -45
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-checkout-fields.md +133 -133
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-confirmation-settings.md +68 -68
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-module-settings.md +68 -68
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-payment-method-design.md +67 -67
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-payment-method-settings.md +58 -58
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-permissions.md +68 -68
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-storage-driver-settings.md +62 -62
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-store-settings.md +239 -239
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/setup-paypal-webhook.md +48 -48
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/toggle-mcp.md +40 -40
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/verify-storage-driver-connection.md +62 -62
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/verify-turnstile-keys.md +55 -55
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/create-shipping-class.md +73 -73
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/create-shipping-method.md +110 -110
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/create-shipping-zone.md +56 -56
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/delete-shipping-class.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/delete-shipping-method.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/delete-shipping-zone.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-class-profile.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-class.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-packages.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-zone.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-zone-countries.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-zone-states.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/list-shipping-classes.md +31 -31
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/list-shipping-zones.md +31 -31
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/save-shipping-packages.md +112 -112
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-shipping-class.md +79 -79
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-shipping-method.md +113 -113
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-shipping-zone.md +62 -62
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-zone-order.md +52 -52
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/cancel-auto-renew.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/cancel-subscription.md +52 -52
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/confirm-subscription-switch.md +70 -70
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/fetch-subscription-remote.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/generate-early-payment-link.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-customer-subscription.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-or-create-plan.md +69 -69
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-setup-intent-attempts.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-subscription.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/initiate-early-payment.md +31 -31
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/list-customer-subscriptions.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/list-subscriptions.md +39 -39
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/pause-subscription.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/reactivate-subscription.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/resume-subscription.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/switch-payment-method.md +70 -70
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/update-payment-method.md +69 -69
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/update-vendor-ids.md +56 -56
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/verify-vendor-ids.md +56 -56
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/create-tax-class.md +51 -51
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/create-tax-rate.md +117 -117
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-product-override.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-shipping-tax-override.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-tax-class.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-tax-rate.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-country-tax-id.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-country-tax-rates.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-eu-vat-product-overrides.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-oss-country-rates.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-preconfigured-tax-rates.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-product-overrides.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-tax-settings.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/list-all-tax-rates.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/list-tax-classes.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/list-tax-records.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/mark-taxes-as-filed.md +58 -58
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/reset-eu-vat-rates.md +21 -21
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-configured-countries.md +57 -57
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-country-tax-id.md +50 -50
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-eu-vat-cross-border-settings.md +127 -127
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-oss-country-rates.md +100 -100
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-product-override.md +110 -110
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-shipping-tax-override.md +52 -52
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-tax-settings.md +166 -166
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/update-country-status.md +54 -54
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/update-tax-rate.md +116 -116
- package/dist/skills/fluentcart-developer/references/restapi/order-bumps.md +433 -433
- package/dist/skills/fluentcart-developer/references/restapi/orders.md +1212 -1212
- package/dist/skills/fluentcart-developer/references/restapi/pdf-templates.md +212 -212
- package/dist/skills/fluentcart-developer/references/restapi/products.md +2485 -2485
- package/dist/skills/fluentcart-developer/references/restapi/public-shop.md +191 -191
- package/dist/skills/fluentcart-developer/references/restapi/reports.md +3773 -3773
- package/dist/skills/fluentcart-developer/references/restapi/roles.md +403 -403
- package/dist/skills/fluentcart-developer/references/restapi/saved-views.md +136 -136
- package/dist/skills/fluentcart-developer/references/restapi/settings.md +1423 -1423
- package/dist/skills/fluentcart-developer/references/restapi/shipping.md +905 -905
- package/dist/skills/fluentcart-developer/references/restapi/subscriptions.md +1169 -1169
- package/dist/skills/fluentcart-developer/references/restapi/tax.md +1551 -1551
- package/dist/skills/fluentcart-developer/references/restapi.md +127 -127
- package/dist/skills/fluentcart-developer/scripts/cli.js +1 -1
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +66 -65
|
@@ -1,427 +1,427 @@
|
|
|
1
|
-
# Fee System (Surcharges & Additional Charges)
|
|
2
|
-
|
|
3
|
-
FluentCart provides a built-in fee system that allows developers to attach additional charges to a cart during checkout. This is useful for processing fees, handling fees, small-order surcharges, payment gateway surcharges, environmental levies, and more.
|
|
4
|
-
|
|
5
|
-
## Overview
|
|
6
|
-
|
|
7
|
-
Fees are stored as order items with `payment_type = 'fee'` and a cached `fee_total` column on the order for fast aggregation. The system provides two ways to register fees:
|
|
8
|
-
|
|
9
|
-
- **Dynamic fees** via the `fluent_cart/cart/fees` filter — recalculated on every checkout update
|
|
10
|
-
- **Persistent fees** via `$cart->addFee()` — stored directly on the cart and persisted to the database
|
|
11
|
-
|
|
12
|
-
Fees automatically integrate with:
|
|
13
|
-
|
|
14
|
-
- Checkout summary display
|
|
15
|
-
- Order totals calculation
|
|
16
|
-
- Email templates and PDF receipts
|
|
17
|
-
- Admin order view and customer portal
|
|
18
|
-
- Refund distribution (proportional)
|
|
19
|
-
- REST API responses
|
|
20
|
-
|
|
21
|
-
## Fee Data Structure
|
|
22
|
-
|
|
23
|
-
Every fee follows this structure:
|
|
24
|
-
|
|
25
|
-
```
|
|
26
|
-
[
|
|
27
|
-
'key' => 'processing_fee', // Unique slug (required)
|
|
28
|
-
'label' => 'Processing Fee', // Customer-facing name (required)
|
|
29
|
-
'amount' => 450, // Amount in cents, must be positive (required)
|
|
30
|
-
'taxable' => false, // Whether tax should be calculated (default: false)
|
|
31
|
-
'source' => 'my-addon', // Addon identifier (default: 'custom')
|
|
32
|
-
'meta' => ['rule_id' => 42], // Optional extra data stored in order item
|
|
33
|
-
]
|
|
34
|
-
```
|
|
35
|
-
|
|
36
|
-
**Rules:**
|
|
37
|
-
|
|
38
|
-
- `amount` must be a positive integer (in cents). Negative values are rejected.
|
|
39
|
-
- `key` is sanitized with `sanitize_key()`. Combined with `source`, it forms a composite dedup key (`source:key`).
|
|
40
|
-
- Duplicate `source:key` entries are deduplicated — the last one wins.
|
|
41
|
-
|
|
42
|
-
---
|
|
43
|
-
|
|
44
|
-
## Method 1: Dynamic Fees via Filter
|
|
45
|
-
|
|
46
|
-
Use the `fluent_cart/cart/fees` filter to add fees that are recalculated on every checkout update (quantity change, coupon applied, payment method changed, etc.).
|
|
47
|
-
|
|
48
|
-
### Hook: `fluent_cart/cart/fees`
|
|
49
|
-
|
|
50
|
-
**Parameters:**
|
|
51
|
-
|
|
52
|
-
- `$fees` (array): Current fees array (may contain fees from other addons or stored fees)
|
|
53
|
-
- `$context` (array): Cart context for condition evaluation
|
|
54
|
-
|
|
55
|
-
**Returns:** Modified fees array
|
|
56
|
-
|
|
57
|
-
**Context array contents:**
|
|
58
|
-
|
|
59
|
-
| Key | Type | Description |
|
|
60
|
-
| --- | --- | --- |
|
|
61
|
-
| `cart` | `Cart` | The Cart model instance |
|
|
62
|
-
| `cart_items` | `array` | Current cart item data |
|
|
63
|
-
| `cart_subtotal` | `int` | Cart subtotal in cents (before discounts) |
|
|
64
|
-
| `shipping_total` | `int` | Shipping total in cents |
|
|
65
|
-
| `customer_id` | `int` | Customer ID |
|
|
66
|
-
| `payment_method` | `string` | Selected payment method key |
|
|
67
|
-
| `checkout_data` | `array` | Full checkout data |
|
|
68
|
-
|
|
69
|
-
### Example: Small Order Surcharge
|
|
70
|
-
|
|
71
|
-
Add a $5 fee when the cart subtotal is under $25:
|
|
72
|
-
|
|
73
|
-
```
|
|
74
|
-
add_filter('fluent_cart/cart/fees', function (array $fees, array $context) {
|
|
75
|
-
$subtotal = $context['cart_subtotal'];
|
|
76
|
-
|
|
77
|
-
if ($subtotal > 0 && $subtotal < 2500) {
|
|
78
|
-
$fees[] = [
|
|
79
|
-
'key' => 'small_order_fee',
|
|
80
|
-
'label' => __('Small Order Fee', 'my-addon'),
|
|
81
|
-
'amount' => 500,
|
|
82
|
-
'taxable' => false,
|
|
83
|
-
'source' => 'my-addon',
|
|
84
|
-
'meta' => ['reason' => 'subtotal_below_threshold'],
|
|
85
|
-
];
|
|
86
|
-
}
|
|
87
|
-
|
|
88
|
-
return $fees;
|
|
89
|
-
}, 10, 2);
|
|
90
|
-
```
|
|
91
|
-
|
|
92
|
-
### Example: Payment Method Processing Fee
|
|
93
|
-
|
|
94
|
-
Add a 2.9% processing fee for Stripe payments:
|
|
95
|
-
|
|
96
|
-
```
|
|
97
|
-
add_filter('fluent_cart/cart/fees', function (array $fees, array $context) {
|
|
98
|
-
if ($context['payment_method'] !== 'stripe') {
|
|
99
|
-
return $fees;
|
|
100
|
-
}
|
|
101
|
-
|
|
102
|
-
$subtotal = $context['cart_subtotal'];
|
|
103
|
-
if ($subtotal <= 0) {
|
|
104
|
-
return $fees;
|
|
105
|
-
}
|
|
106
|
-
|
|
107
|
-
$feeAmount = (int) round($subtotal * 0.029);
|
|
108
|
-
|
|
109
|
-
$fees[] = [
|
|
110
|
-
'key' => 'stripe_processing',
|
|
111
|
-
'label' => __('Processing Fee (2.9%)', 'my-addon'),
|
|
112
|
-
'amount' => $feeAmount,
|
|
113
|
-
'taxable' => true,
|
|
114
|
-
'source' => 'my-addon',
|
|
115
|
-
'meta' => ['rate' => '2.9%'],
|
|
116
|
-
];
|
|
117
|
-
|
|
118
|
-
return $fees;
|
|
119
|
-
}, 10, 2);
|
|
120
|
-
```
|
|
121
|
-
|
|
122
|
-
### Example: Location-Based Fee
|
|
123
|
-
|
|
124
|
-
Add a handling fee for orders shipping to remote areas:
|
|
125
|
-
|
|
126
|
-
```
|
|
127
|
-
add_filter('fluent_cart/cart/fees', function (array $fees, array $context) {
|
|
128
|
-
$checkoutData = $context['checkout_data'];
|
|
129
|
-
$country = $checkoutData['form_data']['shipping_country'] ?? '';
|
|
130
|
-
$state = $checkoutData['form_data']['shipping_state'] ?? '';
|
|
131
|
-
|
|
132
|
-
$remoteAreas = ['AK', 'HI', 'PR']; // Alaska, Hawaii, Puerto Rico
|
|
133
|
-
|
|
134
|
-
if ($country === 'US' && in_array($state, $remoteAreas, true)) {
|
|
135
|
-
$fees[] = [
|
|
136
|
-
'key' => 'remote_handling',
|
|
137
|
-
'label' => __('Remote Area Handling Fee', 'my-addon'),
|
|
138
|
-
'amount' => 1500,
|
|
139
|
-
'taxable' => false,
|
|
140
|
-
'source' => 'my-addon',
|
|
141
|
-
];
|
|
142
|
-
}
|
|
143
|
-
|
|
144
|
-
return $fees;
|
|
145
|
-
}, 10, 2);
|
|
146
|
-
```
|
|
147
|
-
|
|
148
|
-
---
|
|
149
|
-
|
|
150
|
-
## Method 2: Persistent Fees via Cart Methods
|
|
151
|
-
|
|
152
|
-
Use these methods to programmatically add or remove fees that are stored on the cart. Persistent fees survive page reloads and are included alongside dynamic fees.
|
|
153
|
-
|
|
154
|
-
### `$cart->addFee(array $fee): bool`
|
|
155
|
-
|
|
156
|
-
Adds a fee to the cart and saves immediately. If a fee with the same `source:key` already exists, it will be updated.
|
|
157
|
-
|
|
158
|
-
```
|
|
159
|
-
$cart = \FluentCart\App\Models\Cart::find($cartId);
|
|
160
|
-
|
|
161
|
-
$cart->addFee([
|
|
162
|
-
'key' => 'handling_fee',
|
|
163
|
-
'label' => 'Handling Fee',
|
|
164
|
-
'amount' => 200,
|
|
165
|
-
'source' => 'my-addon',
|
|
166
|
-
'taxable' => false,
|
|
167
|
-
'meta' => ['applied_by' => 'admin'],
|
|
168
|
-
]);
|
|
169
|
-
```
|
|
170
|
-
|
|
171
|
-
### `$cart->removeFee(string $key, ?string $source = null): bool`
|
|
172
|
-
|
|
173
|
-
Removes a fee by key. Optionally filter by source to avoid removing another addon's fee with the same key.
|
|
174
|
-
|
|
175
|
-
```
|
|
176
|
-
// Remove a specific fee by key and source
|
|
177
|
-
$cart->removeFee('handling_fee', 'my-addon');
|
|
178
|
-
|
|
179
|
-
// Remove all fees with this key (regardless of source)
|
|
180
|
-
$cart->removeFee('handling_fee');
|
|
181
|
-
```
|
|
182
|
-
|
|
183
|
-
### `$cart->removeFeesBySource(string $source): void`
|
|
184
|
-
|
|
185
|
-
Removes all fees from a specific source. Useful for clearing all your addon's fees before recalculating.
|
|
186
|
-
|
|
187
|
-
```
|
|
188
|
-
// Clear all fees from your addon
|
|
189
|
-
$cart->removeFeesBySource('my-addon');
|
|
190
|
-
```
|
|
191
|
-
|
|
192
|
-
### `$cart->getFees(): array`
|
|
193
|
-
|
|
194
|
-
Returns all validated fees (stored + dynamic from filter).
|
|
195
|
-
|
|
196
|
-
### `$cart->getFeeTotal(): int`
|
|
197
|
-
|
|
198
|
-
Returns the total of all fees in cents.
|
|
199
|
-
|
|
200
|
-
```
|
|
201
|
-
$fees = $cart->getFees();
|
|
202
|
-
$total = $cart->getFeeTotal(); // e.g., 700 (= $7.00)
|
|
203
|
-
```
|
|
204
|
-
|
|
205
|
-
---
|
|
206
|
-
|
|
207
|
-
## How Fees Flow Through the System
|
|
208
|
-
|
|
209
|
-
```
|
|
210
|
-
1. REGISTRATION
|
|
211
|
-
Addon registers fees via filter or $cart->addFee()
|
|
212
|
-
|
|
213
|
-
2. CHECKOUT SUMMARY
|
|
214
|
-
WebCheckoutHandler recalculates on every cart change
|
|
215
|
-
CartSummaryRender::renderFees() displays fee lines
|
|
216
|
-
Fee total included in estimated total
|
|
217
|
-
|
|
218
|
-
3. ORDER CREATION
|
|
219
|
-
CheckoutProcessor reads fees from cart
|
|
220
|
-
Each fee becomes an OrderItem (payment_type = 'fee')
|
|
221
|
-
fee_total cached on the Order record
|
|
222
|
-
total_amount formula includes fee_total
|
|
223
|
-
|
|
224
|
-
4. POST-ORDER
|
|
225
|
-
Admin view: fee rows in payment table
|
|
226
|
-
Customer portal: fee rows in totals
|
|
227
|
-
Emails: fee rows in items table
|
|
228
|
-
PDF receipts: fee rows in summary
|
|
229
|
-
Refunds: fees participate in proportional distribution
|
|
230
|
-
```
|
|
231
|
-
|
|
232
|
-
### Total Amount Formula
|
|
233
|
-
|
|
234
|
-
```
|
|
235
|
-
total_amount = subtotal
|
|
236
|
-
- coupon_discount_total
|
|
237
|
-
- manual_discount_total
|
|
238
|
-
+ fee_total
|
|
239
|
-
+ shipping_total
|
|
240
|
-
+ tax_total (if exclusive)
|
|
241
|
-
+ shipping_tax (if exclusive)
|
|
242
|
-
```
|
|
243
|
-
|
|
244
|
-
---
|
|
245
|
-
|
|
246
|
-
## Fee Display Order
|
|
247
|
-
|
|
248
|
-
Fees appear in the checkout summary and all post-order displays in this order:
|
|
249
|
-
|
|
250
|
-
```
|
|
251
|
-
1. Subtotal
|
|
252
|
-
2. Shipping
|
|
253
|
-
3. Fees ← your fees appear here
|
|
254
|
-
4. Coupons / Discounts
|
|
255
|
-
5. Tax
|
|
256
|
-
6. Total
|
|
257
|
-
```
|
|
258
|
-
|
|
259
|
-
This ordering is intentional — fees are additions (like shipping), shown before subtractions (discounts).
|
|
260
|
-
|
|
261
|
-
---
|
|
262
|
-
|
|
263
|
-
## Reading Fees from Orders
|
|
264
|
-
|
|
265
|
-
After an order is placed, fees are stored as order items. Use these methods to access them:
|
|
266
|
-
|
|
267
|
-
### `$order->feeItems()`
|
|
268
|
-
|
|
269
|
-
Returns a HasMany relationship query for fee order items.
|
|
270
|
-
|
|
271
|
-
```
|
|
272
|
-
$order = \FluentCart\App\Models\Order::find($orderId);
|
|
273
|
-
|
|
274
|
-
$feeItems = $order->feeItems()->get();
|
|
275
|
-
|
|
276
|
-
foreach ($feeItems as $item) {
|
|
277
|
-
echo $item->title; // "Processing Fee"
|
|
278
|
-
echo $item->subtotal; // 450 (cents)
|
|
279
|
-
echo $item->tax_amount; // 36 (cents, if taxable)
|
|
280
|
-
}
|
|
281
|
-
```
|
|
282
|
-
|
|
283
|
-
### `$order->getAppliedFees()`
|
|
284
|
-
|
|
285
|
-
Returns a simplified array of applied fees.
|
|
286
|
-
|
|
287
|
-
```
|
|
288
|
-
$fees = $order->getAppliedFees();
|
|
289
|
-
// [
|
|
290
|
-
// [
|
|
291
|
-
// 'key' => 'processing_fee',
|
|
292
|
-
// 'label' => 'Processing Fee',
|
|
293
|
-
// 'amount' => 450,
|
|
294
|
-
// 'source' => 'my-addon',
|
|
295
|
-
// 'item_id' => 42,
|
|
296
|
-
// ],
|
|
297
|
-
// ]
|
|
298
|
-
```
|
|
299
|
-
|
|
300
|
-
### `$order->getProductItems()`
|
|
301
|
-
|
|
302
|
-
Returns order items excluding fees and signup fees. Use this whenever displaying product line items to avoid showing fee rows in the product list.
|
|
303
|
-
|
|
304
|
-
```
|
|
305
|
-
// Correct: excludes fee and signup_fee items
|
|
306
|
-
$products = $order->getProductItems();
|
|
307
|
-
|
|
308
|
-
// Also available on the order: the cached total
|
|
309
|
-
$feeTotal = $order->fee_total; // e.g., 650
|
|
310
|
-
```
|
|
311
|
-
|
|
312
|
-
---
|
|
313
|
-
|
|
314
|
-
## Fee Item Structure in Order Items
|
|
315
|
-
|
|
316
|
-
When a fee becomes an order item, it has this structure in `fct_order_items`:
|
|
317
|
-
|
|
318
|
-
| Column | Value | Notes |
|
|
319
|
-
| --- | --- | --- |
|
|
320
|
-
| `post_id` | `0` | No product |
|
|
321
|
-
| `object_id` | `0` | No variation |
|
|
322
|
-
| `title` | `"Processing Fee"` | The fee label |
|
|
323
|
-
| `quantity` | `1` | Always 1 |
|
|
324
|
-
| `unit_price` | `450` | Amount in cents |
|
|
325
|
-
| `subtotal` | `450` | Same as unit_price |
|
|
326
|
-
| `line_total` | `450` | Same as subtotal |
|
|
327
|
-
| `payment_type` | `'fee'` | Identifies as a fee |
|
|
328
|
-
| `other_info` | JSON | Contains `fee_key`, `source`, `taxable`, `meta` |
|
|
329
|
-
|
|
330
|
-
---
|
|
331
|
-
|
|
332
|
-
## Actions
|
|
333
|
-
|
|
334
|
-
### `fluent_cart/cart/fees_calculated`
|
|
335
|
-
|
|
336
|
-
Fired after fees are collected and stored on the cart during checkout summary recalculation.
|
|
337
|
-
|
|
338
|
-
```
|
|
339
|
-
add_action('fluent_cart/cart/fees_calculated', function (array $fees, $cart) {
|
|
340
|
-
// Log or track fee activity
|
|
341
|
-
if (!empty($fees)) {
|
|
342
|
-
error_log('Fees applied: ' . count($fees) . ' for cart #' . $cart->id);
|
|
343
|
-
}
|
|
344
|
-
}, 10, 2);
|
|
345
|
-
```
|
|
346
|
-
|
|
347
|
-
### `fluent_cart/order/fee_items_created`
|
|
348
|
-
|
|
349
|
-
Fired after fee order items are created during order placement.
|
|
350
|
-
|
|
351
|
-
```
|
|
352
|
-
add_action('fluent_cart/order/fee_items_created', function (array $feeOrderItems, $order) {
|
|
353
|
-
// Post-creation processing
|
|
354
|
-
}, 10, 2);
|
|
355
|
-
```
|
|
356
|
-
|
|
357
|
-
---
|
|
358
|
-
|
|
359
|
-
## Important Behavior Notes
|
|
360
|
-
|
|
361
|
-
1. **Fees are recalculated on every checkout update.** Dynamic fees (via filter) run whenever the checkout summary refreshes — item changes, coupon application, payment method change, address change, etc.
|
|
362
|
-
2. **Fees are not applied to subscription renewals.** The filter is skipped when `checkout_data.renew_data.is_renewal` is `yes`.
|
|
363
|
-
3. **Fees are not applied to locked carts.** Custom/manual checkout carts that are locked return only stored fees without running the filter.
|
|
364
|
-
4. **Deduplication uses `source:key`.** Two addons can both register a fee with `key = 'processing_fee'` as long as they use different `source` values.
|
|
365
|
-
5. **Fees are read-only after order creation.** Once an order is placed, fee items cannot be edited from the admin panel.
|
|
366
|
-
6. **Fees participate in proportional refunds.** When an order is refunded, fee items are included in the proportional distribution automatically.
|
|
367
|
-
7. **Per-request caching.** `getFees()` caches results within a single request. Call `$cart->clearFeeCache()` if you modify fees and need to re-read within the same request.
|
|
368
|
-
8. **Recursion guard.** If your filter callback calls `$cart->getFees()`, it returns only stored fees (not the filter result) to prevent infinite loops.
|
|
369
|
-
|
|
370
|
-
---
|
|
371
|
-
|
|
372
|
-
## Complete Example: Tiered Handling Fee Addon
|
|
373
|
-
|
|
374
|
-
A full working example that applies tiered handling fees based on cart subtotal:
|
|
375
|
-
|
|
376
|
-
```
|
|
377
|
-
<?php
|
|
378
|
-
/**
|
|
379
|
-
* Plugin Name: FluentCart Handling Fee
|
|
380
|
-
* Description: Adds tiered handling fees based on cart subtotal.
|
|
381
|
-
*/
|
|
382
|
-
|
|
383
|
-
add_filter('fluent_cart/cart/fees', function (array $fees, array $context) {
|
|
384
|
-
$subtotal = $context['cart_subtotal'];
|
|
385
|
-
|
|
386
|
-
if ($subtotal <= 0) {
|
|
387
|
-
return $fees;
|
|
388
|
-
}
|
|
389
|
-
|
|
390
|
-
// Tiered handling fee
|
|
391
|
-
$feeAmount = match (true) {
|
|
392
|
-
$subtotal < 2000 => 500, // Under $20: $5.00 fee
|
|
393
|
-
$subtotal < 5000 => 300, // $20-$49.99: $3.00 fee
|
|
394
|
-
$subtotal < 10000 => 100, // $50-$99.99: $1.00 fee
|
|
395
|
-
default => 0, // $100+: no fee
|
|
396
|
-
};
|
|
397
|
-
|
|
398
|
-
if ($feeAmount > 0) {
|
|
399
|
-
$fees[] = [
|
|
400
|
-
'key' => 'handling_fee',
|
|
401
|
-
'label' => __('Handling Fee', 'my-handling-fee'),
|
|
402
|
-
'amount' => $feeAmount,
|
|
403
|
-
'taxable' => false,
|
|
404
|
-
'source' => 'handling-fee-addon',
|
|
405
|
-
'meta' => [
|
|
406
|
-
'tier' => $subtotal < 2000 ? 'small' : ($subtotal < 5000 ? 'medium' : 'large'),
|
|
407
|
-
'subtotal' => $subtotal,
|
|
408
|
-
],
|
|
409
|
-
];
|
|
410
|
-
}
|
|
411
|
-
|
|
412
|
-
return $fees;
|
|
413
|
-
}, 10, 2);
|
|
414
|
-
```
|
|
415
|
-
|
|
416
|
-
---
|
|
417
|
-
|
|
418
|
-
## Related Documentation
|
|
419
|
-
|
|
420
|
-
- [Developer Hooks](/hooks/) - Complete hooks and filters reference
|
|
421
|
-
- [Orders API](/restapi/operations/orders/) - Order management API
|
|
422
|
-
- [Database Models](/database/models/) - Data model documentation
|
|
423
|
-
- [Ghost Product Selling](/modules/ghost-product-selling.md) - Custom product selling guide
|
|
424
|
-
|
|
425
|
-
---
|
|
426
|
-
|
|
427
|
-
**Next Steps:** Explore [Custom Payment Gateway Integration](/payment-methods-integration/) or return to [Getting Started](/getting-started.md)
|
|
1
|
+
# Fee System (Surcharges & Additional Charges)
|
|
2
|
+
|
|
3
|
+
FluentCart provides a built-in fee system that allows developers to attach additional charges to a cart during checkout. This is useful for processing fees, handling fees, small-order surcharges, payment gateway surcharges, environmental levies, and more.
|
|
4
|
+
|
|
5
|
+
## Overview
|
|
6
|
+
|
|
7
|
+
Fees are stored as order items with `payment_type = 'fee'` and a cached `fee_total` column on the order for fast aggregation. The system provides two ways to register fees:
|
|
8
|
+
|
|
9
|
+
- **Dynamic fees** via the `fluent_cart/cart/fees` filter — recalculated on every checkout update
|
|
10
|
+
- **Persistent fees** via `$cart->addFee()` — stored directly on the cart and persisted to the database
|
|
11
|
+
|
|
12
|
+
Fees automatically integrate with:
|
|
13
|
+
|
|
14
|
+
- Checkout summary display
|
|
15
|
+
- Order totals calculation
|
|
16
|
+
- Email templates and PDF receipts
|
|
17
|
+
- Admin order view and customer portal
|
|
18
|
+
- Refund distribution (proportional)
|
|
19
|
+
- REST API responses
|
|
20
|
+
|
|
21
|
+
## Fee Data Structure
|
|
22
|
+
|
|
23
|
+
Every fee follows this structure:
|
|
24
|
+
|
|
25
|
+
```
|
|
26
|
+
[
|
|
27
|
+
'key' => 'processing_fee', // Unique slug (required)
|
|
28
|
+
'label' => 'Processing Fee', // Customer-facing name (required)
|
|
29
|
+
'amount' => 450, // Amount in cents, must be positive (required)
|
|
30
|
+
'taxable' => false, // Whether tax should be calculated (default: false)
|
|
31
|
+
'source' => 'my-addon', // Addon identifier (default: 'custom')
|
|
32
|
+
'meta' => ['rule_id' => 42], // Optional extra data stored in order item
|
|
33
|
+
]
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
**Rules:**
|
|
37
|
+
|
|
38
|
+
- `amount` must be a positive integer (in cents). Negative values are rejected.
|
|
39
|
+
- `key` is sanitized with `sanitize_key()`. Combined with `source`, it forms a composite dedup key (`source:key`).
|
|
40
|
+
- Duplicate `source:key` entries are deduplicated — the last one wins.
|
|
41
|
+
|
|
42
|
+
---
|
|
43
|
+
|
|
44
|
+
## Method 1: Dynamic Fees via Filter
|
|
45
|
+
|
|
46
|
+
Use the `fluent_cart/cart/fees` filter to add fees that are recalculated on every checkout update (quantity change, coupon applied, payment method changed, etc.).
|
|
47
|
+
|
|
48
|
+
### Hook: `fluent_cart/cart/fees`
|
|
49
|
+
|
|
50
|
+
**Parameters:**
|
|
51
|
+
|
|
52
|
+
- `$fees` (array): Current fees array (may contain fees from other addons or stored fees)
|
|
53
|
+
- `$context` (array): Cart context for condition evaluation
|
|
54
|
+
|
|
55
|
+
**Returns:** Modified fees array
|
|
56
|
+
|
|
57
|
+
**Context array contents:**
|
|
58
|
+
|
|
59
|
+
| Key | Type | Description |
|
|
60
|
+
| --- | --- | --- |
|
|
61
|
+
| `cart` | `Cart` | The Cart model instance |
|
|
62
|
+
| `cart_items` | `array` | Current cart item data |
|
|
63
|
+
| `cart_subtotal` | `int` | Cart subtotal in cents (before discounts) |
|
|
64
|
+
| `shipping_total` | `int` | Shipping total in cents |
|
|
65
|
+
| `customer_id` | `int` | Customer ID |
|
|
66
|
+
| `payment_method` | `string` | Selected payment method key |
|
|
67
|
+
| `checkout_data` | `array` | Full checkout data |
|
|
68
|
+
|
|
69
|
+
### Example: Small Order Surcharge
|
|
70
|
+
|
|
71
|
+
Add a $5 fee when the cart subtotal is under $25:
|
|
72
|
+
|
|
73
|
+
```
|
|
74
|
+
add_filter('fluent_cart/cart/fees', function (array $fees, array $context) {
|
|
75
|
+
$subtotal = $context['cart_subtotal'];
|
|
76
|
+
|
|
77
|
+
if ($subtotal > 0 && $subtotal < 2500) {
|
|
78
|
+
$fees[] = [
|
|
79
|
+
'key' => 'small_order_fee',
|
|
80
|
+
'label' => __('Small Order Fee', 'my-addon'),
|
|
81
|
+
'amount' => 500,
|
|
82
|
+
'taxable' => false,
|
|
83
|
+
'source' => 'my-addon',
|
|
84
|
+
'meta' => ['reason' => 'subtotal_below_threshold'],
|
|
85
|
+
];
|
|
86
|
+
}
|
|
87
|
+
|
|
88
|
+
return $fees;
|
|
89
|
+
}, 10, 2);
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
### Example: Payment Method Processing Fee
|
|
93
|
+
|
|
94
|
+
Add a 2.9% processing fee for Stripe payments:
|
|
95
|
+
|
|
96
|
+
```
|
|
97
|
+
add_filter('fluent_cart/cart/fees', function (array $fees, array $context) {
|
|
98
|
+
if ($context['payment_method'] !== 'stripe') {
|
|
99
|
+
return $fees;
|
|
100
|
+
}
|
|
101
|
+
|
|
102
|
+
$subtotal = $context['cart_subtotal'];
|
|
103
|
+
if ($subtotal <= 0) {
|
|
104
|
+
return $fees;
|
|
105
|
+
}
|
|
106
|
+
|
|
107
|
+
$feeAmount = (int) round($subtotal * 0.029);
|
|
108
|
+
|
|
109
|
+
$fees[] = [
|
|
110
|
+
'key' => 'stripe_processing',
|
|
111
|
+
'label' => __('Processing Fee (2.9%)', 'my-addon'),
|
|
112
|
+
'amount' => $feeAmount,
|
|
113
|
+
'taxable' => true,
|
|
114
|
+
'source' => 'my-addon',
|
|
115
|
+
'meta' => ['rate' => '2.9%'],
|
|
116
|
+
];
|
|
117
|
+
|
|
118
|
+
return $fees;
|
|
119
|
+
}, 10, 2);
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
### Example: Location-Based Fee
|
|
123
|
+
|
|
124
|
+
Add a handling fee for orders shipping to remote areas:
|
|
125
|
+
|
|
126
|
+
```
|
|
127
|
+
add_filter('fluent_cart/cart/fees', function (array $fees, array $context) {
|
|
128
|
+
$checkoutData = $context['checkout_data'];
|
|
129
|
+
$country = $checkoutData['form_data']['shipping_country'] ?? '';
|
|
130
|
+
$state = $checkoutData['form_data']['shipping_state'] ?? '';
|
|
131
|
+
|
|
132
|
+
$remoteAreas = ['AK', 'HI', 'PR']; // Alaska, Hawaii, Puerto Rico
|
|
133
|
+
|
|
134
|
+
if ($country === 'US' && in_array($state, $remoteAreas, true)) {
|
|
135
|
+
$fees[] = [
|
|
136
|
+
'key' => 'remote_handling',
|
|
137
|
+
'label' => __('Remote Area Handling Fee', 'my-addon'),
|
|
138
|
+
'amount' => 1500,
|
|
139
|
+
'taxable' => false,
|
|
140
|
+
'source' => 'my-addon',
|
|
141
|
+
];
|
|
142
|
+
}
|
|
143
|
+
|
|
144
|
+
return $fees;
|
|
145
|
+
}, 10, 2);
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
---
|
|
149
|
+
|
|
150
|
+
## Method 2: Persistent Fees via Cart Methods
|
|
151
|
+
|
|
152
|
+
Use these methods to programmatically add or remove fees that are stored on the cart. Persistent fees survive page reloads and are included alongside dynamic fees.
|
|
153
|
+
|
|
154
|
+
### `$cart->addFee(array $fee): bool`
|
|
155
|
+
|
|
156
|
+
Adds a fee to the cart and saves immediately. If a fee with the same `source:key` already exists, it will be updated.
|
|
157
|
+
|
|
158
|
+
```
|
|
159
|
+
$cart = \FluentCart\App\Models\Cart::find($cartId);
|
|
160
|
+
|
|
161
|
+
$cart->addFee([
|
|
162
|
+
'key' => 'handling_fee',
|
|
163
|
+
'label' => 'Handling Fee',
|
|
164
|
+
'amount' => 200,
|
|
165
|
+
'source' => 'my-addon',
|
|
166
|
+
'taxable' => false,
|
|
167
|
+
'meta' => ['applied_by' => 'admin'],
|
|
168
|
+
]);
|
|
169
|
+
```
|
|
170
|
+
|
|
171
|
+
### `$cart->removeFee(string $key, ?string $source = null): bool`
|
|
172
|
+
|
|
173
|
+
Removes a fee by key. Optionally filter by source to avoid removing another addon's fee with the same key.
|
|
174
|
+
|
|
175
|
+
```
|
|
176
|
+
// Remove a specific fee by key and source
|
|
177
|
+
$cart->removeFee('handling_fee', 'my-addon');
|
|
178
|
+
|
|
179
|
+
// Remove all fees with this key (regardless of source)
|
|
180
|
+
$cart->removeFee('handling_fee');
|
|
181
|
+
```
|
|
182
|
+
|
|
183
|
+
### `$cart->removeFeesBySource(string $source): void`
|
|
184
|
+
|
|
185
|
+
Removes all fees from a specific source. Useful for clearing all your addon's fees before recalculating.
|
|
186
|
+
|
|
187
|
+
```
|
|
188
|
+
// Clear all fees from your addon
|
|
189
|
+
$cart->removeFeesBySource('my-addon');
|
|
190
|
+
```
|
|
191
|
+
|
|
192
|
+
### `$cart->getFees(): array`
|
|
193
|
+
|
|
194
|
+
Returns all validated fees (stored + dynamic from filter).
|
|
195
|
+
|
|
196
|
+
### `$cart->getFeeTotal(): int`
|
|
197
|
+
|
|
198
|
+
Returns the total of all fees in cents.
|
|
199
|
+
|
|
200
|
+
```
|
|
201
|
+
$fees = $cart->getFees();
|
|
202
|
+
$total = $cart->getFeeTotal(); // e.g., 700 (= $7.00)
|
|
203
|
+
```
|
|
204
|
+
|
|
205
|
+
---
|
|
206
|
+
|
|
207
|
+
## How Fees Flow Through the System
|
|
208
|
+
|
|
209
|
+
```
|
|
210
|
+
1. REGISTRATION
|
|
211
|
+
Addon registers fees via filter or $cart->addFee()
|
|
212
|
+
|
|
213
|
+
2. CHECKOUT SUMMARY
|
|
214
|
+
WebCheckoutHandler recalculates on every cart change
|
|
215
|
+
CartSummaryRender::renderFees() displays fee lines
|
|
216
|
+
Fee total included in estimated total
|
|
217
|
+
|
|
218
|
+
3. ORDER CREATION
|
|
219
|
+
CheckoutProcessor reads fees from cart
|
|
220
|
+
Each fee becomes an OrderItem (payment_type = 'fee')
|
|
221
|
+
fee_total cached on the Order record
|
|
222
|
+
total_amount formula includes fee_total
|
|
223
|
+
|
|
224
|
+
4. POST-ORDER
|
|
225
|
+
Admin view: fee rows in payment table
|
|
226
|
+
Customer portal: fee rows in totals
|
|
227
|
+
Emails: fee rows in items table
|
|
228
|
+
PDF receipts: fee rows in summary
|
|
229
|
+
Refunds: fees participate in proportional distribution
|
|
230
|
+
```
|
|
231
|
+
|
|
232
|
+
### Total Amount Formula
|
|
233
|
+
|
|
234
|
+
```
|
|
235
|
+
total_amount = subtotal
|
|
236
|
+
- coupon_discount_total
|
|
237
|
+
- manual_discount_total
|
|
238
|
+
+ fee_total
|
|
239
|
+
+ shipping_total
|
|
240
|
+
+ tax_total (if exclusive)
|
|
241
|
+
+ shipping_tax (if exclusive)
|
|
242
|
+
```
|
|
243
|
+
|
|
244
|
+
---
|
|
245
|
+
|
|
246
|
+
## Fee Display Order
|
|
247
|
+
|
|
248
|
+
Fees appear in the checkout summary and all post-order displays in this order:
|
|
249
|
+
|
|
250
|
+
```
|
|
251
|
+
1. Subtotal
|
|
252
|
+
2. Shipping
|
|
253
|
+
3. Fees ← your fees appear here
|
|
254
|
+
4. Coupons / Discounts
|
|
255
|
+
5. Tax
|
|
256
|
+
6. Total
|
|
257
|
+
```
|
|
258
|
+
|
|
259
|
+
This ordering is intentional — fees are additions (like shipping), shown before subtractions (discounts).
|
|
260
|
+
|
|
261
|
+
---
|
|
262
|
+
|
|
263
|
+
## Reading Fees from Orders
|
|
264
|
+
|
|
265
|
+
After an order is placed, fees are stored as order items. Use these methods to access them:
|
|
266
|
+
|
|
267
|
+
### `$order->feeItems()`
|
|
268
|
+
|
|
269
|
+
Returns a HasMany relationship query for fee order items.
|
|
270
|
+
|
|
271
|
+
```
|
|
272
|
+
$order = \FluentCart\App\Models\Order::find($orderId);
|
|
273
|
+
|
|
274
|
+
$feeItems = $order->feeItems()->get();
|
|
275
|
+
|
|
276
|
+
foreach ($feeItems as $item) {
|
|
277
|
+
echo $item->title; // "Processing Fee"
|
|
278
|
+
echo $item->subtotal; // 450 (cents)
|
|
279
|
+
echo $item->tax_amount; // 36 (cents, if taxable)
|
|
280
|
+
}
|
|
281
|
+
```
|
|
282
|
+
|
|
283
|
+
### `$order->getAppliedFees()`
|
|
284
|
+
|
|
285
|
+
Returns a simplified array of applied fees.
|
|
286
|
+
|
|
287
|
+
```
|
|
288
|
+
$fees = $order->getAppliedFees();
|
|
289
|
+
// [
|
|
290
|
+
// [
|
|
291
|
+
// 'key' => 'processing_fee',
|
|
292
|
+
// 'label' => 'Processing Fee',
|
|
293
|
+
// 'amount' => 450,
|
|
294
|
+
// 'source' => 'my-addon',
|
|
295
|
+
// 'item_id' => 42,
|
|
296
|
+
// ],
|
|
297
|
+
// ]
|
|
298
|
+
```
|
|
299
|
+
|
|
300
|
+
### `$order->getProductItems()`
|
|
301
|
+
|
|
302
|
+
Returns order items excluding fees and signup fees. Use this whenever displaying product line items to avoid showing fee rows in the product list.
|
|
303
|
+
|
|
304
|
+
```
|
|
305
|
+
// Correct: excludes fee and signup_fee items
|
|
306
|
+
$products = $order->getProductItems();
|
|
307
|
+
|
|
308
|
+
// Also available on the order: the cached total
|
|
309
|
+
$feeTotal = $order->fee_total; // e.g., 650
|
|
310
|
+
```
|
|
311
|
+
|
|
312
|
+
---
|
|
313
|
+
|
|
314
|
+
## Fee Item Structure in Order Items
|
|
315
|
+
|
|
316
|
+
When a fee becomes an order item, it has this structure in `fct_order_items`:
|
|
317
|
+
|
|
318
|
+
| Column | Value | Notes |
|
|
319
|
+
| --- | --- | --- |
|
|
320
|
+
| `post_id` | `0` | No product |
|
|
321
|
+
| `object_id` | `0` | No variation |
|
|
322
|
+
| `title` | `"Processing Fee"` | The fee label |
|
|
323
|
+
| `quantity` | `1` | Always 1 |
|
|
324
|
+
| `unit_price` | `450` | Amount in cents |
|
|
325
|
+
| `subtotal` | `450` | Same as unit_price |
|
|
326
|
+
| `line_total` | `450` | Same as subtotal |
|
|
327
|
+
| `payment_type` | `'fee'` | Identifies as a fee |
|
|
328
|
+
| `other_info` | JSON | Contains `fee_key`, `source`, `taxable`, `meta` |
|
|
329
|
+
|
|
330
|
+
---
|
|
331
|
+
|
|
332
|
+
## Actions
|
|
333
|
+
|
|
334
|
+
### `fluent_cart/cart/fees_calculated`
|
|
335
|
+
|
|
336
|
+
Fired after fees are collected and stored on the cart during checkout summary recalculation.
|
|
337
|
+
|
|
338
|
+
```
|
|
339
|
+
add_action('fluent_cart/cart/fees_calculated', function (array $fees, $cart) {
|
|
340
|
+
// Log or track fee activity
|
|
341
|
+
if (!empty($fees)) {
|
|
342
|
+
error_log('Fees applied: ' . count($fees) . ' for cart #' . $cart->id);
|
|
343
|
+
}
|
|
344
|
+
}, 10, 2);
|
|
345
|
+
```
|
|
346
|
+
|
|
347
|
+
### `fluent_cart/order/fee_items_created`
|
|
348
|
+
|
|
349
|
+
Fired after fee order items are created during order placement.
|
|
350
|
+
|
|
351
|
+
```
|
|
352
|
+
add_action('fluent_cart/order/fee_items_created', function (array $feeOrderItems, $order) {
|
|
353
|
+
// Post-creation processing
|
|
354
|
+
}, 10, 2);
|
|
355
|
+
```
|
|
356
|
+
|
|
357
|
+
---
|
|
358
|
+
|
|
359
|
+
## Important Behavior Notes
|
|
360
|
+
|
|
361
|
+
1. **Fees are recalculated on every checkout update.** Dynamic fees (via filter) run whenever the checkout summary refreshes — item changes, coupon application, payment method change, address change, etc.
|
|
362
|
+
2. **Fees are not applied to subscription renewals.** The filter is skipped when `checkout_data.renew_data.is_renewal` is `yes`.
|
|
363
|
+
3. **Fees are not applied to locked carts.** Custom/manual checkout carts that are locked return only stored fees without running the filter.
|
|
364
|
+
4. **Deduplication uses `source:key`.** Two addons can both register a fee with `key = 'processing_fee'` as long as they use different `source` values.
|
|
365
|
+
5. **Fees are read-only after order creation.** Once an order is placed, fee items cannot be edited from the admin panel.
|
|
366
|
+
6. **Fees participate in proportional refunds.** When an order is refunded, fee items are included in the proportional distribution automatically.
|
|
367
|
+
7. **Per-request caching.** `getFees()` caches results within a single request. Call `$cart->clearFeeCache()` if you modify fees and need to re-read within the same request.
|
|
368
|
+
8. **Recursion guard.** If your filter callback calls `$cart->getFees()`, it returns only stored fees (not the filter result) to prevent infinite loops.
|
|
369
|
+
|
|
370
|
+
---
|
|
371
|
+
|
|
372
|
+
## Complete Example: Tiered Handling Fee Addon
|
|
373
|
+
|
|
374
|
+
A full working example that applies tiered handling fees based on cart subtotal:
|
|
375
|
+
|
|
376
|
+
```
|
|
377
|
+
<?php
|
|
378
|
+
/**
|
|
379
|
+
* Plugin Name: FluentCart Handling Fee
|
|
380
|
+
* Description: Adds tiered handling fees based on cart subtotal.
|
|
381
|
+
*/
|
|
382
|
+
|
|
383
|
+
add_filter('fluent_cart/cart/fees', function (array $fees, array $context) {
|
|
384
|
+
$subtotal = $context['cart_subtotal'];
|
|
385
|
+
|
|
386
|
+
if ($subtotal <= 0) {
|
|
387
|
+
return $fees;
|
|
388
|
+
}
|
|
389
|
+
|
|
390
|
+
// Tiered handling fee
|
|
391
|
+
$feeAmount = match (true) {
|
|
392
|
+
$subtotal < 2000 => 500, // Under $20: $5.00 fee
|
|
393
|
+
$subtotal < 5000 => 300, // $20-$49.99: $3.00 fee
|
|
394
|
+
$subtotal < 10000 => 100, // $50-$99.99: $1.00 fee
|
|
395
|
+
default => 0, // $100+: no fee
|
|
396
|
+
};
|
|
397
|
+
|
|
398
|
+
if ($feeAmount > 0) {
|
|
399
|
+
$fees[] = [
|
|
400
|
+
'key' => 'handling_fee',
|
|
401
|
+
'label' => __('Handling Fee', 'my-handling-fee'),
|
|
402
|
+
'amount' => $feeAmount,
|
|
403
|
+
'taxable' => false,
|
|
404
|
+
'source' => 'handling-fee-addon',
|
|
405
|
+
'meta' => [
|
|
406
|
+
'tier' => $subtotal < 2000 ? 'small' : ($subtotal < 5000 ? 'medium' : 'large'),
|
|
407
|
+
'subtotal' => $subtotal,
|
|
408
|
+
],
|
|
409
|
+
];
|
|
410
|
+
}
|
|
411
|
+
|
|
412
|
+
return $fees;
|
|
413
|
+
}, 10, 2);
|
|
414
|
+
```
|
|
415
|
+
|
|
416
|
+
---
|
|
417
|
+
|
|
418
|
+
## Related Documentation
|
|
419
|
+
|
|
420
|
+
- [Developer Hooks](/hooks/) - Complete hooks and filters reference
|
|
421
|
+
- [Orders API](/restapi/operations/orders/) - Order management API
|
|
422
|
+
- [Database Models](/database/models/) - Data model documentation
|
|
423
|
+
- [Ghost Product Selling](/modules/ghost-product-selling.md) - Custom product selling guide
|
|
424
|
+
|
|
425
|
+
---
|
|
426
|
+
|
|
427
|
+
**Next Steps:** Explore [Custom Payment Gateway Integration](/payment-methods-integration/) or return to [Getting Started](/getting-started.md)
|