fluentcart-developer 3.0.0 → 3.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- 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/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,464 +1,464 @@
|
|
|
1
|
-
# Modules
|
|
2
|
-
|
|
3
|
-
Filters exposed by FluentCart's optional built-in modules: the **MCP server** (`app/Modules/MCP/`), which exposes store data and actions to AI agents through the WordPress Abilities API, and the **Advanced Variation** product type (`app/Services/AdvancedVariationService.php`, `app/Hooks/Handlers/AdvancedVariationHandler.php`), which lets a product combine multiple attribute groups into a large set of purchasable variants.
|
|
4
|
-
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
## Advanced Variation
|
|
8
|
-
|
|
9
|
-
### ` advanced_variation/asset_page_types `
|
|
10
|
-
|
|
11
|
-
`fluent_cart/advanced_variation/asset_page_types` — Filter which frontend page types load the advanced-variation selector assets
|
|
12
|
-
|
|
13
|
-
**When it runs:** Runs once when the handler builds the list of FluentCart page types for which it enqueues the advanced-variation selector's CSS/JS on `wp_enqueue_scripts`. Cart, checkout, receipt, login, registration, and the customer dashboard are excluded by default so those pages don't pay the asset weight; use this filter to add a custom page type context.
|
|
14
|
-
|
|
15
|
-
**Parameters:**
|
|
16
|
-
|
|
17
|
-
- `$pageTypes` (array): Page type slugs the selector assets should load on. Default: `['single_product', 'shop', 'product_taxonomy']`
|
|
18
|
-
|
|
19
|
-
**Returns:** `array` — The page type slugs to enqueue assets for
|
|
20
|
-
|
|
21
|
-
**Source:** `app/Hooks/Handlers/AdvancedVariationHandler.php:161`
|
|
22
|
-
|
|
23
|
-
**Usage:**
|
|
24
|
-
|
|
25
|
-
```
|
|
26
|
-
add_filter('fluent_cart/advanced_variation/asset_page_types', function ($pageTypes) {
|
|
27
|
-
// Also load the selector assets on a custom landing page template
|
|
28
|
-
$pageTypes[] = 'custom_bundle_page';
|
|
29
|
-
return $pageTypes;
|
|
30
|
-
}, 10, 1);
|
|
31
|
-
```
|
|
32
|
-
|
|
33
|
-
### ` advanced_variation/max_combinations `
|
|
34
|
-
|
|
35
|
-
`fluent_cart/advanced_variation/max_combinations` — Filter the maximum projected variant combinations allowed per product
|
|
36
|
-
|
|
37
|
-
**When it runs:** Runs when `AdvancedVariationService` validates a save: once against the *projected* combination count (attribute-group term counts multiplied together) before the real per-variant relations are built, and again against the *real* group set right before the write. Both checks re-apply this filter so a raised limit is honored consistently. Exceeding the limit rejects the save with an error message.
|
|
38
|
-
|
|
39
|
-
**Parameters:**
|
|
40
|
-
|
|
41
|
-
- `$maxCombinations` (int): The combination cap. Default: `self::DEFAULT_MAX_COMBINATIONS`
|
|
42
|
-
|
|
43
|
-
**Returns:** `int` — The maximum number of variant combinations to allow
|
|
44
|
-
|
|
45
|
-
**Source:** `app/Services/AdvancedVariationService.php:162`
|
|
46
|
-
|
|
47
|
-
Also re-applied at `app/Services/AdvancedVariationService.php:463`.
|
|
48
|
-
|
|
49
|
-
**Usage:**
|
|
50
|
-
|
|
51
|
-
```
|
|
52
|
-
add_filter('fluent_cart/advanced_variation/max_combinations', function ($maxCombinations) {
|
|
53
|
-
// This store's catalog needs a larger combination ceiling than the default
|
|
54
|
-
return 5000;
|
|
55
|
-
}, 10, 1);
|
|
56
|
-
```
|
|
57
|
-
|
|
58
|
-
### ` advanced_variation/max_groups_per_save `
|
|
59
|
-
|
|
60
|
-
`fluent_cart/advanced_variation/max_groups_per_save` — Filter the maximum number of attribute groups allowed per save
|
|
61
|
-
|
|
62
|
-
**When it runs:** Runs when `AdvancedVariationService` validates a save, bounding the number of non-empty attribute groups in the submitted payload (e.g. Color, Size, Material). It's re-applied a second time against the *real* group count derived from the persisted variant relations, since a single payload entry can bundle terms from more than one real group.
|
|
63
|
-
|
|
64
|
-
**Parameters:**
|
|
65
|
-
|
|
66
|
-
- `$maxGroups` (int): The attribute-group cap. Default: `self::DEFAULT_MAX_GROUPS_PER_SAVE`
|
|
67
|
-
|
|
68
|
-
**Returns:** `int` — The maximum number of attribute groups to allow per save
|
|
69
|
-
|
|
70
|
-
**Source:** `app/Services/AdvancedVariationService.php:130`
|
|
71
|
-
|
|
72
|
-
Also re-applied at `app/Services/AdvancedVariationService.php:452`.
|
|
73
|
-
|
|
74
|
-
**Usage:**
|
|
75
|
-
|
|
76
|
-
```
|
|
77
|
-
add_filter('fluent_cart/advanced_variation/max_groups_per_save', function ($maxGroups) {
|
|
78
|
-
return 6;
|
|
79
|
-
}, 10, 1);
|
|
80
|
-
```
|
|
81
|
-
|
|
82
|
-
### ` advanced_variation/max_terms_per_save `
|
|
83
|
-
|
|
84
|
-
`fluent_cart/advanced_variation/max_terms_per_save` — Filter the maximum number of unique attribute terms allowed per save
|
|
85
|
-
|
|
86
|
-
**When it runs:** Runs when `AdvancedVariationService` validates a save, bounding the total number of unique attribute terms (e.g. Red, Blue, Small, Large) across all attribute groups in the submitted payload. This bounds the term-validation `whereIn` list and the per-variant relation insert count independently of the combination cap, which only bounds the cartesian product.
|
|
87
|
-
|
|
88
|
-
**Parameters:**
|
|
89
|
-
|
|
90
|
-
- `$maxTerms` (int): The unique-term cap. Default: `self::DEFAULT_MAX_TERMS_PER_SAVE`
|
|
91
|
-
|
|
92
|
-
**Returns:** `int` — The maximum number of unique attribute terms to allow per save
|
|
93
|
-
|
|
94
|
-
**Source:** `app/Services/AdvancedVariationService.php:146`
|
|
95
|
-
|
|
96
|
-
**Usage:**
|
|
97
|
-
|
|
98
|
-
```
|
|
99
|
-
add_filter('fluent_cart/advanced_variation/max_terms_per_save', function ($maxTerms) {
|
|
100
|
-
return 200;
|
|
101
|
-
}, 10, 1);
|
|
102
|
-
```
|
|
103
|
-
|
|
104
|
-
---
|
|
105
|
-
|
|
106
|
-
## MCP
|
|
107
|
-
|
|
108
|
-
### ` mcp_ability_names `
|
|
109
|
-
|
|
110
|
-
`fluent_cart/mcp_ability_names` — Filter the fully-qualified ability names exposed by the MCP server
|
|
111
|
-
|
|
112
|
-
**When it runs:** Runs when `MCPInit` builds the list of abilities to register with the MCP adapter, and again in `toolsCount()` when the admin Settings UI reports how many tools are available. Use it to add abilities registered outside FluentCart's own `AbilitiesRegistrar`, or to remove specific abilities from the exposed set.
|
|
113
|
-
|
|
114
|
-
**Parameters:**
|
|
115
|
-
|
|
116
|
-
- `$abilityNames` (array): Fully-qualified ability names (e.g. `fluent-cart/list-orders`)
|
|
117
|
-
|
|
118
|
-
**Returns:** `array` — The ability names to register/count. Duplicates and empty values are filtered out afterward
|
|
119
|
-
|
|
120
|
-
**Source:** `app/Modules/MCP/MCPInit.php:130`
|
|
121
|
-
|
|
122
|
-
Also re-applied in `toolsCount()` at `app/Modules/MCP/MCPInit.php:247`.
|
|
123
|
-
|
|
124
|
-
**Usage:**
|
|
125
|
-
|
|
126
|
-
```
|
|
127
|
-
add_filter('fluent_cart/mcp_ability_names', function ($abilityNames) {
|
|
128
|
-
// Hide a sensitive built-in ability from every MCP client
|
|
129
|
-
return array_diff($abilityNames, ['fluent-cart/refund-order']);
|
|
130
|
-
}, 10, 1);
|
|
131
|
-
```
|
|
132
|
-
|
|
133
|
-
### ` mcp_advanced_search_entities `
|
|
134
|
-
|
|
135
|
-
`fluent_cart/mcp_advanced_search_entities` — Filter the entities available to the MCP advanced-search tool
|
|
136
|
-
|
|
137
|
-
**When it runs:** Runs when `AdvancedSearch` resolves the entity map that backs the `get-search-schema` MCP tool and the `advanced_filters` parameter on the `query-*` tools. Each entry maps an entity name to the filter class that handles it, the WordPress capability required to query it, and the corresponding `list-*` tool name.
|
|
138
|
-
|
|
139
|
-
**Parameters:**
|
|
140
|
-
|
|
141
|
-
- `$entities` (array): Entity map
|
|
142
|
-
|
|
143
|
-
```
|
|
144
|
-
$entities = [
|
|
145
|
-
'orders' => [
|
|
146
|
-
'filter' => \FluentCart\App\Services\Filter\OrderFilter::class,
|
|
147
|
-
'permission' => 'manage_options',
|
|
148
|
-
'list_tool' => 'list-orders',
|
|
149
|
-
],
|
|
150
|
-
// ...
|
|
151
|
-
];
|
|
152
|
-
```
|
|
153
|
-
|
|
154
|
-
**Returns:** `array` — The entity map, keyed by entity name
|
|
155
|
-
|
|
156
|
-
**Source:** `app/Modules/MCP/Support/AdvancedSearch.php:102`
|
|
157
|
-
|
|
158
|
-
**Usage:**
|
|
159
|
-
|
|
160
|
-
```
|
|
161
|
-
add_filter('fluent_cart/mcp_advanced_search_entities', function ($entities) {
|
|
162
|
-
// Expose a custom entity to the MCP advanced-search tool
|
|
163
|
-
$entities['loyalty_points'] = [
|
|
164
|
-
'filter' => \MyAddon\LoyaltyPointsFilter::class,
|
|
165
|
-
'permission' => 'manage_options',
|
|
166
|
-
'list_tool' => 'list-loyalty-points',
|
|
167
|
-
];
|
|
168
|
-
return $entities;
|
|
169
|
-
}, 10, 1);
|
|
170
|
-
```
|
|
171
|
-
|
|
172
|
-
### ` mcp_allow_live_gateway `
|
|
173
|
-
|
|
174
|
-
`fluent_cart/mcp_allow_live_gateway` — Filter whether MCP tools may perform live (real-money) gateway actions
|
|
175
|
-
|
|
176
|
-
**When it runs:** Runs inside `WriteGuard` whenever an MCP tool call (e.g. `refund-order`, `change-subscription-status:cancel`) would touch a live gateway. By default live mutations are blocked and the tool call returns a `live_gateway_blocked` error, so an agent can't move real money unless a store owner explicitly opts in via the `mcp_allow_live_gateway` option or this filter.
|
|
177
|
-
|
|
178
|
-
**Parameters:**
|
|
179
|
-
|
|
180
|
-
- `$allowed` (bool): Whether live refunds/cancellations are permitted. Reflects the current `mcp_allow_live_gateway` option value
|
|
181
|
-
|
|
182
|
-
**Returns:** `bool` — `true` to permit live gateway writes from MCP tools, `false` to keep blocking them
|
|
183
|
-
|
|
184
|
-
**Source:** `app/Modules/MCP/Support/WriteGuard.php:186`
|
|
185
|
-
|
|
186
|
-
**Usage:**
|
|
187
|
-
|
|
188
|
-
```
|
|
189
|
-
add_filter('fluent_cart/mcp_allow_live_gateway', function ($allowed) {
|
|
190
|
-
// Only ever allow live gateway writes from MCP on staging
|
|
191
|
-
return wp_get_environment_type() !== 'production';
|
|
192
|
-
}, 10, 1);
|
|
193
|
-
```
|
|
194
|
-
|
|
195
|
-
### ` mcp_customer_data `
|
|
196
|
-
|
|
197
|
-
`fluent_cart/mcp_customer_data` — Filter the customer payload returned by MCP customer tools
|
|
198
|
-
|
|
199
|
-
**When it runs:** Runs in `CustomerTools` after the customer record and its requested `include[]` sections have been assembled into the response payload, just before it's wrapped and returned to the MCP client. Use it to append data an add-on tracks about the customer.
|
|
200
|
-
|
|
201
|
-
**Parameters:**
|
|
202
|
-
|
|
203
|
-
- `$data` (array): The customer payload as it will be returned to the MCP client
|
|
204
|
-
- `$context` (array): Resolution context
|
|
205
|
-
|
|
206
|
-
```
|
|
207
|
-
$context = [
|
|
208
|
-
'customer' => $customer, // \FluentCart\App\Models\Customer
|
|
209
|
-
'include' => $include, // string[] — the include[] sections that were requested
|
|
210
|
-
];
|
|
211
|
-
```
|
|
212
|
-
|
|
213
|
-
**Returns:** `array` — The (possibly extended) customer payload
|
|
214
|
-
|
|
215
|
-
**Source:** `app/Modules/MCP/Tools/CustomerTools.php:435`
|
|
216
|
-
|
|
217
|
-
**Usage:**
|
|
218
|
-
|
|
219
|
-
```
|
|
220
|
-
add_filter('fluent_cart/mcp_customer_data', function ($data, $context) {
|
|
221
|
-
$data['loyalty_points'] = my_addon_get_points($context['customer']->id);
|
|
222
|
-
return $data;
|
|
223
|
-
}, 10, 2);
|
|
224
|
-
```
|
|
225
|
-
|
|
226
|
-
### ` mcp_customer_include_sections `
|
|
227
|
-
|
|
228
|
-
`fluent_cart/mcp_customer_include_sections` — Filter the section names offered in the MCP get-customer tool's include[] enum
|
|
229
|
-
|
|
230
|
-
**When it runs:** Runs when `CustomerTools` builds the list of section names a caller may request via the `include` parameter on the `get-customer` MCP tool. Add a section name here to advertise it in the tool's schema; you still need to populate that section via `fluent_cart/mcp_customer_data`.
|
|
231
|
-
|
|
232
|
-
**Parameters:**
|
|
233
|
-
|
|
234
|
-
- `$sections` (array): Section name strings
|
|
235
|
-
|
|
236
|
-
**Returns:** `array` — The section names to offer in the `include[]` enum. Deduplicated and cast to strings afterward
|
|
237
|
-
|
|
238
|
-
**Source:** `app/Modules/MCP/Tools/CustomerTools.php:141`
|
|
239
|
-
|
|
240
|
-
**Usage:**
|
|
241
|
-
|
|
242
|
-
```
|
|
243
|
-
add_filter('fluent_cart/mcp_customer_include_sections', function ($sections) {
|
|
244
|
-
$sections[] = 'loyalty_points';
|
|
245
|
-
return $sections;
|
|
246
|
-
}, 10, 1);
|
|
247
|
-
```
|
|
248
|
-
|
|
249
|
-
### ` mcp_enums `
|
|
250
|
-
|
|
251
|
-
`fluent_cart/mcp_enums` — Filter the enum reference map returned by get-store-context
|
|
252
|
-
|
|
253
|
-
**When it runs:** Runs when `ContextTools` assembles the payload for the `get-store-context` MCP tool, which every well-behaved MCP client is instructed to call once per session. The `enums` section tells the agent the exact valid values (order statuses, payment statuses, etc.) to use so it never invents one.
|
|
254
|
-
|
|
255
|
-
**Parameters:**
|
|
256
|
-
|
|
257
|
-
- `$enums` (array): The default enum map, from `ContextTools::enums()`
|
|
258
|
-
|
|
259
|
-
**Returns:** `array` — The enum map to expose to MCP clients
|
|
260
|
-
|
|
261
|
-
**Source:** `app/Modules/MCP/Tools/ContextTools.php:254`
|
|
262
|
-
|
|
263
|
-
**Usage:**
|
|
264
|
-
|
|
265
|
-
```
|
|
266
|
-
add_filter('fluent_cart/mcp_enums', function ($enums) {
|
|
267
|
-
$enums['loyalty_tier'] = ['bronze', 'silver', 'gold'];
|
|
268
|
-
return $enums;
|
|
269
|
-
}, 10, 1);
|
|
270
|
-
```
|
|
271
|
-
|
|
272
|
-
### ` mcp_expose_error_details `
|
|
273
|
-
|
|
274
|
-
`fluent_cart/mcp_expose_error_details` — Filter whether MCP tool errors include file/line and stack trace details
|
|
275
|
-
|
|
276
|
-
**When it runs:** Runs in `AbilitiesRegistrar`'s exception handler when an MCP tool callback throws. Full error detail is always logged server-side regardless of this filter; this only controls whether the file (reduced to a basename), line, and a short stack trace are also included in the error payload sent back to the MCP client. Off (`false`) by default since a client-visible stack trace can leak the server's filesystem layout.
|
|
277
|
-
|
|
278
|
-
**Parameters:**
|
|
279
|
-
|
|
280
|
-
- `$exposeDetails` (bool): Whether to include file/line/trace in the client-facing error. Default: `false`
|
|
281
|
-
|
|
282
|
-
**Returns:** `bool` — `true` to include the extra detail in the MCP error response
|
|
283
|
-
|
|
284
|
-
**Source:** `app/Modules/MCP/AbilitiesRegistrar.php:323`
|
|
285
|
-
|
|
286
|
-
**Usage:**
|
|
287
|
-
|
|
288
|
-
```
|
|
289
|
-
add_filter('fluent_cart/mcp_expose_error_details', function ($exposeDetails) {
|
|
290
|
-
// Only expose stack traces to MCP clients on a local dev install
|
|
291
|
-
return defined('WP_DEBUG') && WP_DEBUG;
|
|
292
|
-
}, 10, 1);
|
|
293
|
-
```
|
|
294
|
-
|
|
295
|
-
### ` mcp_guidelines `
|
|
296
|
-
|
|
297
|
-
`fluent_cart/mcp_guidelines` — Filter the top-level usage guidelines returned by get-store-context
|
|
298
|
-
|
|
299
|
-
**When it runs:** Runs when `ContextTools` builds the `guidelines` string returned by the `get-store-context` MCP tool — the free-text instructions that steer how an MCP client should call FluentCart's tools (e.g. calling `get-store-context` once per session, requiring a `dry_run` preview before destructive writes).
|
|
300
|
-
|
|
301
|
-
**Parameters:**
|
|
302
|
-
|
|
303
|
-
- `$guidelines` (string): The default guidelines text
|
|
304
|
-
|
|
305
|
-
**Returns:** `string` — The guidelines text to return to MCP clients
|
|
306
|
-
|
|
307
|
-
**Source:** `app/Modules/MCP/Tools/ContextTools.php:426`
|
|
308
|
-
|
|
309
|
-
**Usage:**
|
|
310
|
-
|
|
311
|
-
```
|
|
312
|
-
add_filter('fluent_cart/mcp_guidelines', function ($guidelines) {
|
|
313
|
-
return $guidelines . ' Loyalty point balances are informational only and cannot be redeemed through these tools.';
|
|
314
|
-
}, 10, 1);
|
|
315
|
-
```
|
|
316
|
-
|
|
317
|
-
### ` mcp_is_local_dev `
|
|
318
|
-
|
|
319
|
-
`fluent_cart/mcp_is_local_dev` — Filter whether the current request is treated as local development for MCP settings
|
|
320
|
-
|
|
321
|
-
**When it runs:** Runs at the end of `McpSettingsController`'s local-dev detection, after it has checked the request host against its own heuristics (e.g. `localhost`, `.test`, `.local`). Local-dev status affects which guidance/warnings the MCP Settings UI shows about exposing the endpoint.
|
|
322
|
-
|
|
323
|
-
**Parameters:**
|
|
324
|
-
|
|
325
|
-
- `$isLocal` (bool): The result of the built-in heuristic check
|
|
326
|
-
- `$host` (string): The request host that was checked
|
|
327
|
-
|
|
328
|
-
**Returns:** `bool` — Whether to treat the current install as local development
|
|
329
|
-
|
|
330
|
-
**Source:** `app/Http/Controllers/McpSettingsController.php:273`
|
|
331
|
-
|
|
332
|
-
**Usage:**
|
|
333
|
-
|
|
334
|
-
```
|
|
335
|
-
add_filter('fluent_cart/mcp_is_local_dev', function ($isLocal, $host) {
|
|
336
|
-
// Also treat this team's internal staging domain as local
|
|
337
|
-
return $isLocal || str_ends_with($host, '.staging.example.com');
|
|
338
|
-
}, 10, 2);
|
|
339
|
-
```
|
|
340
|
-
|
|
341
|
-
### ` mcp_order_data `
|
|
342
|
-
|
|
343
|
-
`fluent_cart/mcp_order_data` — Filter the order payload returned by MCP order tools
|
|
344
|
-
|
|
345
|
-
**When it runs:** Runs in `OrderTools` after the order record and its requested `include[]` sections have been assembled into the response payload, before the `fields` projection (if requested) trims it. Note `order_id` is always kept even if `fields` would otherwise drop it.
|
|
346
|
-
|
|
347
|
-
**Parameters:**
|
|
348
|
-
|
|
349
|
-
- `$data` (array): The order payload as it will be returned to the MCP client
|
|
350
|
-
- `$context` (array): Resolution context
|
|
351
|
-
|
|
352
|
-
```
|
|
353
|
-
$context = [
|
|
354
|
-
'order' => $order, // \FluentCart\App\Models\Order
|
|
355
|
-
'include' => $include, // string[] — the include[] sections that were requested
|
|
356
|
-
];
|
|
357
|
-
```
|
|
358
|
-
|
|
359
|
-
**Returns:** `array` — The (possibly extended) order payload
|
|
360
|
-
|
|
361
|
-
**Source:** `app/Modules/MCP/Tools/OrderTools.php:532`
|
|
362
|
-
|
|
363
|
-
**Usage:**
|
|
364
|
-
|
|
365
|
-
```
|
|
366
|
-
add_filter('fluent_cart/mcp_order_data', function ($data, $context) {
|
|
367
|
-
$data['fulfillment_notes'] = my_addon_get_notes($context['order']->id);
|
|
368
|
-
return $data;
|
|
369
|
-
}, 10, 2);
|
|
370
|
-
```
|
|
371
|
-
|
|
372
|
-
### ` mcp_order_include_sections `
|
|
373
|
-
|
|
374
|
-
`fluent_cart/mcp_order_include_sections` — Filter the section names offered in the MCP get-order tool's include[] enum
|
|
375
|
-
|
|
376
|
-
**When it runs:** Runs when `OrderTools` builds the list of section names a caller may request via the `include` parameter on the `get-order` MCP tool. Add a section name here to advertise it in the tool's schema; you still need to populate that section via `fluent_cart/mcp_order_data`.
|
|
377
|
-
|
|
378
|
-
**Parameters:**
|
|
379
|
-
|
|
380
|
-
- `$sections` (array): Section name strings
|
|
381
|
-
|
|
382
|
-
**Returns:** `array` — The section names to offer in the `include[]` enum. Deduplicated and cast to strings afterward
|
|
383
|
-
|
|
384
|
-
**Source:** `app/Modules/MCP/Tools/OrderTools.php:567`
|
|
385
|
-
|
|
386
|
-
**Usage:**
|
|
387
|
-
|
|
388
|
-
```
|
|
389
|
-
add_filter('fluent_cart/mcp_order_include_sections', function ($sections) {
|
|
390
|
-
$sections[] = 'fulfillment_notes';
|
|
391
|
-
return $sections;
|
|
392
|
-
}, 10, 1);
|
|
393
|
-
```
|
|
394
|
-
|
|
395
|
-
### ` mcp_server_namespace `
|
|
396
|
-
|
|
397
|
-
`fluent_cart/mcp_server_namespace` — Filter the REST namespace the FluentCart MCP server is registered under
|
|
398
|
-
|
|
399
|
-
**When it runs:** Runs when `MCPInit` creates the dedicated `fluent-cart` MCP server and again in `getEndpointUrl()`, which the Settings UI and connection-snippet generator use, so both stay in sync. Combined with `fluent_cart/mcp_server_route`, this forms the REST path `/wp-json/{namespace}/{route}`.
|
|
400
|
-
|
|
401
|
-
**Parameters:**
|
|
402
|
-
|
|
403
|
-
- `$namespace` (string): The REST namespace. Default: `'fluent-cart'`
|
|
404
|
-
|
|
405
|
-
**Returns:** `string` — The REST namespace for the MCP server endpoint
|
|
406
|
-
|
|
407
|
-
**Source:** `app/Modules/MCP/MCPInit.php:133`
|
|
408
|
-
|
|
409
|
-
Also re-applied in `getEndpointUrl()` at `app/Modules/MCP/MCPInit.php:265`.
|
|
410
|
-
|
|
411
|
-
**Usage:**
|
|
412
|
-
|
|
413
|
-
```
|
|
414
|
-
add_filter('fluent_cart/mcp_server_namespace', function ($namespace) {
|
|
415
|
-
return 'my-store-mcp';
|
|
416
|
-
}, 10, 1);
|
|
417
|
-
```
|
|
418
|
-
|
|
419
|
-
### ` mcp_server_route `
|
|
420
|
-
|
|
421
|
-
`fluent_cart/mcp_server_route` — Filter the REST route the FluentCart MCP server is registered under
|
|
422
|
-
|
|
423
|
-
**When it runs:** Runs when `MCPInit` creates the dedicated `fluent-cart` MCP server and again in `getEndpointUrl()`, which the Settings UI and connection-snippet generator use, so both stay in sync. Combined with `fluent_cart/mcp_server_namespace`, this forms the REST path `/wp-json/{namespace}/{route}`.
|
|
424
|
-
|
|
425
|
-
**Parameters:**
|
|
426
|
-
|
|
427
|
-
- `$route` (string): The REST route. Default: `'mcp'`
|
|
428
|
-
|
|
429
|
-
**Returns:** `string` — The REST route for the MCP server endpoint
|
|
430
|
-
|
|
431
|
-
**Source:** `app/Modules/MCP/MCPInit.php:134`
|
|
432
|
-
|
|
433
|
-
Also re-applied in `getEndpointUrl()` at `app/Modules/MCP/MCPInit.php:266`.
|
|
434
|
-
|
|
435
|
-
**Usage:**
|
|
436
|
-
|
|
437
|
-
```
|
|
438
|
-
add_filter('fluent_cart/mcp_server_route', function ($route) {
|
|
439
|
-
return 'agent-tools';
|
|
440
|
-
}, 10, 1);
|
|
441
|
-
```
|
|
442
|
-
|
|
443
|
-
### ` mcp_tool_index `
|
|
444
|
-
|
|
445
|
-
`fluent_cart/mcp_tool_index` — Filter the tool index returned by get-store-context
|
|
446
|
-
|
|
447
|
-
**When it runs:** Runs when `ContextTools` builds the `tool_index` section of the `get-store-context` MCP tool payload — a grouped index that helps an MCP client pick the right tool for a task before calling `list-*`/`query-*`/`get-*` tools. Empty groups are already filtered out before this filter runs.
|
|
448
|
-
|
|
449
|
-
**Parameters:**
|
|
450
|
-
|
|
451
|
-
- `$index` (array): The tool index, grouped by category
|
|
452
|
-
|
|
453
|
-
**Returns:** `array` — The tool index to return to MCP clients
|
|
454
|
-
|
|
455
|
-
**Source:** `app/Modules/MCP/Tools/ContextTools.php:408`
|
|
456
|
-
|
|
457
|
-
**Usage:**
|
|
458
|
-
|
|
459
|
-
```
|
|
460
|
-
add_filter('fluent_cart/mcp_tool_index', function ($index) {
|
|
461
|
-
$index['loyalty'] = ['list-loyalty-points', 'get-loyalty-summary'];
|
|
462
|
-
return $index;
|
|
463
|
-
}, 10, 1);
|
|
464
|
-
```
|
|
1
|
+
# Modules
|
|
2
|
+
|
|
3
|
+
Filters exposed by FluentCart's optional built-in modules: the **MCP server** (`app/Modules/MCP/`), which exposes store data and actions to AI agents through the WordPress Abilities API, and the **Advanced Variation** product type (`app/Services/AdvancedVariationService.php`, `app/Hooks/Handlers/AdvancedVariationHandler.php`), which lets a product combine multiple attribute groups into a large set of purchasable variants.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Advanced Variation
|
|
8
|
+
|
|
9
|
+
### ` advanced_variation/asset_page_types `
|
|
10
|
+
|
|
11
|
+
`fluent_cart/advanced_variation/asset_page_types` — Filter which frontend page types load the advanced-variation selector assets
|
|
12
|
+
|
|
13
|
+
**When it runs:** Runs once when the handler builds the list of FluentCart page types for which it enqueues the advanced-variation selector's CSS/JS on `wp_enqueue_scripts`. Cart, checkout, receipt, login, registration, and the customer dashboard are excluded by default so those pages don't pay the asset weight; use this filter to add a custom page type context.
|
|
14
|
+
|
|
15
|
+
**Parameters:**
|
|
16
|
+
|
|
17
|
+
- `$pageTypes` (array): Page type slugs the selector assets should load on. Default: `['single_product', 'shop', 'product_taxonomy']`
|
|
18
|
+
|
|
19
|
+
**Returns:** `array` — The page type slugs to enqueue assets for
|
|
20
|
+
|
|
21
|
+
**Source:** `app/Hooks/Handlers/AdvancedVariationHandler.php:161`
|
|
22
|
+
|
|
23
|
+
**Usage:**
|
|
24
|
+
|
|
25
|
+
```
|
|
26
|
+
add_filter('fluent_cart/advanced_variation/asset_page_types', function ($pageTypes) {
|
|
27
|
+
// Also load the selector assets on a custom landing page template
|
|
28
|
+
$pageTypes[] = 'custom_bundle_page';
|
|
29
|
+
return $pageTypes;
|
|
30
|
+
}, 10, 1);
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
### ` advanced_variation/max_combinations `
|
|
34
|
+
|
|
35
|
+
`fluent_cart/advanced_variation/max_combinations` — Filter the maximum projected variant combinations allowed per product
|
|
36
|
+
|
|
37
|
+
**When it runs:** Runs when `AdvancedVariationService` validates a save: once against the *projected* combination count (attribute-group term counts multiplied together) before the real per-variant relations are built, and again against the *real* group set right before the write. Both checks re-apply this filter so a raised limit is honored consistently. Exceeding the limit rejects the save with an error message.
|
|
38
|
+
|
|
39
|
+
**Parameters:**
|
|
40
|
+
|
|
41
|
+
- `$maxCombinations` (int): The combination cap. Default: `self::DEFAULT_MAX_COMBINATIONS`
|
|
42
|
+
|
|
43
|
+
**Returns:** `int` — The maximum number of variant combinations to allow
|
|
44
|
+
|
|
45
|
+
**Source:** `app/Services/AdvancedVariationService.php:162`
|
|
46
|
+
|
|
47
|
+
Also re-applied at `app/Services/AdvancedVariationService.php:463`.
|
|
48
|
+
|
|
49
|
+
**Usage:**
|
|
50
|
+
|
|
51
|
+
```
|
|
52
|
+
add_filter('fluent_cart/advanced_variation/max_combinations', function ($maxCombinations) {
|
|
53
|
+
// This store's catalog needs a larger combination ceiling than the default
|
|
54
|
+
return 5000;
|
|
55
|
+
}, 10, 1);
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
### ` advanced_variation/max_groups_per_save `
|
|
59
|
+
|
|
60
|
+
`fluent_cart/advanced_variation/max_groups_per_save` — Filter the maximum number of attribute groups allowed per save
|
|
61
|
+
|
|
62
|
+
**When it runs:** Runs when `AdvancedVariationService` validates a save, bounding the number of non-empty attribute groups in the submitted payload (e.g. Color, Size, Material). It's re-applied a second time against the *real* group count derived from the persisted variant relations, since a single payload entry can bundle terms from more than one real group.
|
|
63
|
+
|
|
64
|
+
**Parameters:**
|
|
65
|
+
|
|
66
|
+
- `$maxGroups` (int): The attribute-group cap. Default: `self::DEFAULT_MAX_GROUPS_PER_SAVE`
|
|
67
|
+
|
|
68
|
+
**Returns:** `int` — The maximum number of attribute groups to allow per save
|
|
69
|
+
|
|
70
|
+
**Source:** `app/Services/AdvancedVariationService.php:130`
|
|
71
|
+
|
|
72
|
+
Also re-applied at `app/Services/AdvancedVariationService.php:452`.
|
|
73
|
+
|
|
74
|
+
**Usage:**
|
|
75
|
+
|
|
76
|
+
```
|
|
77
|
+
add_filter('fluent_cart/advanced_variation/max_groups_per_save', function ($maxGroups) {
|
|
78
|
+
return 6;
|
|
79
|
+
}, 10, 1);
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
### ` advanced_variation/max_terms_per_save `
|
|
83
|
+
|
|
84
|
+
`fluent_cart/advanced_variation/max_terms_per_save` — Filter the maximum number of unique attribute terms allowed per save
|
|
85
|
+
|
|
86
|
+
**When it runs:** Runs when `AdvancedVariationService` validates a save, bounding the total number of unique attribute terms (e.g. Red, Blue, Small, Large) across all attribute groups in the submitted payload. This bounds the term-validation `whereIn` list and the per-variant relation insert count independently of the combination cap, which only bounds the cartesian product.
|
|
87
|
+
|
|
88
|
+
**Parameters:**
|
|
89
|
+
|
|
90
|
+
- `$maxTerms` (int): The unique-term cap. Default: `self::DEFAULT_MAX_TERMS_PER_SAVE`
|
|
91
|
+
|
|
92
|
+
**Returns:** `int` — The maximum number of unique attribute terms to allow per save
|
|
93
|
+
|
|
94
|
+
**Source:** `app/Services/AdvancedVariationService.php:146`
|
|
95
|
+
|
|
96
|
+
**Usage:**
|
|
97
|
+
|
|
98
|
+
```
|
|
99
|
+
add_filter('fluent_cart/advanced_variation/max_terms_per_save', function ($maxTerms) {
|
|
100
|
+
return 200;
|
|
101
|
+
}, 10, 1);
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
---
|
|
105
|
+
|
|
106
|
+
## MCP
|
|
107
|
+
|
|
108
|
+
### ` mcp_ability_names `
|
|
109
|
+
|
|
110
|
+
`fluent_cart/mcp_ability_names` — Filter the fully-qualified ability names exposed by the MCP server
|
|
111
|
+
|
|
112
|
+
**When it runs:** Runs when `MCPInit` builds the list of abilities to register with the MCP adapter, and again in `toolsCount()` when the admin Settings UI reports how many tools are available. Use it to add abilities registered outside FluentCart's own `AbilitiesRegistrar`, or to remove specific abilities from the exposed set.
|
|
113
|
+
|
|
114
|
+
**Parameters:**
|
|
115
|
+
|
|
116
|
+
- `$abilityNames` (array): Fully-qualified ability names (e.g. `fluent-cart/list-orders`)
|
|
117
|
+
|
|
118
|
+
**Returns:** `array` — The ability names to register/count. Duplicates and empty values are filtered out afterward
|
|
119
|
+
|
|
120
|
+
**Source:** `app/Modules/MCP/MCPInit.php:130`
|
|
121
|
+
|
|
122
|
+
Also re-applied in `toolsCount()` at `app/Modules/MCP/MCPInit.php:247`.
|
|
123
|
+
|
|
124
|
+
**Usage:**
|
|
125
|
+
|
|
126
|
+
```
|
|
127
|
+
add_filter('fluent_cart/mcp_ability_names', function ($abilityNames) {
|
|
128
|
+
// Hide a sensitive built-in ability from every MCP client
|
|
129
|
+
return array_diff($abilityNames, ['fluent-cart/refund-order']);
|
|
130
|
+
}, 10, 1);
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
### ` mcp_advanced_search_entities `
|
|
134
|
+
|
|
135
|
+
`fluent_cart/mcp_advanced_search_entities` — Filter the entities available to the MCP advanced-search tool
|
|
136
|
+
|
|
137
|
+
**When it runs:** Runs when `AdvancedSearch` resolves the entity map that backs the `get-search-schema` MCP tool and the `advanced_filters` parameter on the `query-*` tools. Each entry maps an entity name to the filter class that handles it, the WordPress capability required to query it, and the corresponding `list-*` tool name.
|
|
138
|
+
|
|
139
|
+
**Parameters:**
|
|
140
|
+
|
|
141
|
+
- `$entities` (array): Entity map
|
|
142
|
+
|
|
143
|
+
```
|
|
144
|
+
$entities = [
|
|
145
|
+
'orders' => [
|
|
146
|
+
'filter' => \FluentCart\App\Services\Filter\OrderFilter::class,
|
|
147
|
+
'permission' => 'manage_options',
|
|
148
|
+
'list_tool' => 'list-orders',
|
|
149
|
+
],
|
|
150
|
+
// ...
|
|
151
|
+
];
|
|
152
|
+
```
|
|
153
|
+
|
|
154
|
+
**Returns:** `array` — The entity map, keyed by entity name
|
|
155
|
+
|
|
156
|
+
**Source:** `app/Modules/MCP/Support/AdvancedSearch.php:102`
|
|
157
|
+
|
|
158
|
+
**Usage:**
|
|
159
|
+
|
|
160
|
+
```
|
|
161
|
+
add_filter('fluent_cart/mcp_advanced_search_entities', function ($entities) {
|
|
162
|
+
// Expose a custom entity to the MCP advanced-search tool
|
|
163
|
+
$entities['loyalty_points'] = [
|
|
164
|
+
'filter' => \MyAddon\LoyaltyPointsFilter::class,
|
|
165
|
+
'permission' => 'manage_options',
|
|
166
|
+
'list_tool' => 'list-loyalty-points',
|
|
167
|
+
];
|
|
168
|
+
return $entities;
|
|
169
|
+
}, 10, 1);
|
|
170
|
+
```
|
|
171
|
+
|
|
172
|
+
### ` mcp_allow_live_gateway `
|
|
173
|
+
|
|
174
|
+
`fluent_cart/mcp_allow_live_gateway` — Filter whether MCP tools may perform live (real-money) gateway actions
|
|
175
|
+
|
|
176
|
+
**When it runs:** Runs inside `WriteGuard` whenever an MCP tool call (e.g. `refund-order`, `change-subscription-status:cancel`) would touch a live gateway. By default live mutations are blocked and the tool call returns a `live_gateway_blocked` error, so an agent can't move real money unless a store owner explicitly opts in via the `mcp_allow_live_gateway` option or this filter.
|
|
177
|
+
|
|
178
|
+
**Parameters:**
|
|
179
|
+
|
|
180
|
+
- `$allowed` (bool): Whether live refunds/cancellations are permitted. Reflects the current `mcp_allow_live_gateway` option value
|
|
181
|
+
|
|
182
|
+
**Returns:** `bool` — `true` to permit live gateway writes from MCP tools, `false` to keep blocking them
|
|
183
|
+
|
|
184
|
+
**Source:** `app/Modules/MCP/Support/WriteGuard.php:186`
|
|
185
|
+
|
|
186
|
+
**Usage:**
|
|
187
|
+
|
|
188
|
+
```
|
|
189
|
+
add_filter('fluent_cart/mcp_allow_live_gateway', function ($allowed) {
|
|
190
|
+
// Only ever allow live gateway writes from MCP on staging
|
|
191
|
+
return wp_get_environment_type() !== 'production';
|
|
192
|
+
}, 10, 1);
|
|
193
|
+
```
|
|
194
|
+
|
|
195
|
+
### ` mcp_customer_data `
|
|
196
|
+
|
|
197
|
+
`fluent_cart/mcp_customer_data` — Filter the customer payload returned by MCP customer tools
|
|
198
|
+
|
|
199
|
+
**When it runs:** Runs in `CustomerTools` after the customer record and its requested `include[]` sections have been assembled into the response payload, just before it's wrapped and returned to the MCP client. Use it to append data an add-on tracks about the customer.
|
|
200
|
+
|
|
201
|
+
**Parameters:**
|
|
202
|
+
|
|
203
|
+
- `$data` (array): The customer payload as it will be returned to the MCP client
|
|
204
|
+
- `$context` (array): Resolution context
|
|
205
|
+
|
|
206
|
+
```
|
|
207
|
+
$context = [
|
|
208
|
+
'customer' => $customer, // \FluentCart\App\Models\Customer
|
|
209
|
+
'include' => $include, // string[] — the include[] sections that were requested
|
|
210
|
+
];
|
|
211
|
+
```
|
|
212
|
+
|
|
213
|
+
**Returns:** `array` — The (possibly extended) customer payload
|
|
214
|
+
|
|
215
|
+
**Source:** `app/Modules/MCP/Tools/CustomerTools.php:435`
|
|
216
|
+
|
|
217
|
+
**Usage:**
|
|
218
|
+
|
|
219
|
+
```
|
|
220
|
+
add_filter('fluent_cart/mcp_customer_data', function ($data, $context) {
|
|
221
|
+
$data['loyalty_points'] = my_addon_get_points($context['customer']->id);
|
|
222
|
+
return $data;
|
|
223
|
+
}, 10, 2);
|
|
224
|
+
```
|
|
225
|
+
|
|
226
|
+
### ` mcp_customer_include_sections `
|
|
227
|
+
|
|
228
|
+
`fluent_cart/mcp_customer_include_sections` — Filter the section names offered in the MCP get-customer tool's include[] enum
|
|
229
|
+
|
|
230
|
+
**When it runs:** Runs when `CustomerTools` builds the list of section names a caller may request via the `include` parameter on the `get-customer` MCP tool. Add a section name here to advertise it in the tool's schema; you still need to populate that section via `fluent_cart/mcp_customer_data`.
|
|
231
|
+
|
|
232
|
+
**Parameters:**
|
|
233
|
+
|
|
234
|
+
- `$sections` (array): Section name strings
|
|
235
|
+
|
|
236
|
+
**Returns:** `array` — The section names to offer in the `include[]` enum. Deduplicated and cast to strings afterward
|
|
237
|
+
|
|
238
|
+
**Source:** `app/Modules/MCP/Tools/CustomerTools.php:141`
|
|
239
|
+
|
|
240
|
+
**Usage:**
|
|
241
|
+
|
|
242
|
+
```
|
|
243
|
+
add_filter('fluent_cart/mcp_customer_include_sections', function ($sections) {
|
|
244
|
+
$sections[] = 'loyalty_points';
|
|
245
|
+
return $sections;
|
|
246
|
+
}, 10, 1);
|
|
247
|
+
```
|
|
248
|
+
|
|
249
|
+
### ` mcp_enums `
|
|
250
|
+
|
|
251
|
+
`fluent_cart/mcp_enums` — Filter the enum reference map returned by get-store-context
|
|
252
|
+
|
|
253
|
+
**When it runs:** Runs when `ContextTools` assembles the payload for the `get-store-context` MCP tool, which every well-behaved MCP client is instructed to call once per session. The `enums` section tells the agent the exact valid values (order statuses, payment statuses, etc.) to use so it never invents one.
|
|
254
|
+
|
|
255
|
+
**Parameters:**
|
|
256
|
+
|
|
257
|
+
- `$enums` (array): The default enum map, from `ContextTools::enums()`
|
|
258
|
+
|
|
259
|
+
**Returns:** `array` — The enum map to expose to MCP clients
|
|
260
|
+
|
|
261
|
+
**Source:** `app/Modules/MCP/Tools/ContextTools.php:254`
|
|
262
|
+
|
|
263
|
+
**Usage:**
|
|
264
|
+
|
|
265
|
+
```
|
|
266
|
+
add_filter('fluent_cart/mcp_enums', function ($enums) {
|
|
267
|
+
$enums['loyalty_tier'] = ['bronze', 'silver', 'gold'];
|
|
268
|
+
return $enums;
|
|
269
|
+
}, 10, 1);
|
|
270
|
+
```
|
|
271
|
+
|
|
272
|
+
### ` mcp_expose_error_details `
|
|
273
|
+
|
|
274
|
+
`fluent_cart/mcp_expose_error_details` — Filter whether MCP tool errors include file/line and stack trace details
|
|
275
|
+
|
|
276
|
+
**When it runs:** Runs in `AbilitiesRegistrar`'s exception handler when an MCP tool callback throws. Full error detail is always logged server-side regardless of this filter; this only controls whether the file (reduced to a basename), line, and a short stack trace are also included in the error payload sent back to the MCP client. Off (`false`) by default since a client-visible stack trace can leak the server's filesystem layout.
|
|
277
|
+
|
|
278
|
+
**Parameters:**
|
|
279
|
+
|
|
280
|
+
- `$exposeDetails` (bool): Whether to include file/line/trace in the client-facing error. Default: `false`
|
|
281
|
+
|
|
282
|
+
**Returns:** `bool` — `true` to include the extra detail in the MCP error response
|
|
283
|
+
|
|
284
|
+
**Source:** `app/Modules/MCP/AbilitiesRegistrar.php:323`
|
|
285
|
+
|
|
286
|
+
**Usage:**
|
|
287
|
+
|
|
288
|
+
```
|
|
289
|
+
add_filter('fluent_cart/mcp_expose_error_details', function ($exposeDetails) {
|
|
290
|
+
// Only expose stack traces to MCP clients on a local dev install
|
|
291
|
+
return defined('WP_DEBUG') && WP_DEBUG;
|
|
292
|
+
}, 10, 1);
|
|
293
|
+
```
|
|
294
|
+
|
|
295
|
+
### ` mcp_guidelines `
|
|
296
|
+
|
|
297
|
+
`fluent_cart/mcp_guidelines` — Filter the top-level usage guidelines returned by get-store-context
|
|
298
|
+
|
|
299
|
+
**When it runs:** Runs when `ContextTools` builds the `guidelines` string returned by the `get-store-context` MCP tool — the free-text instructions that steer how an MCP client should call FluentCart's tools (e.g. calling `get-store-context` once per session, requiring a `dry_run` preview before destructive writes).
|
|
300
|
+
|
|
301
|
+
**Parameters:**
|
|
302
|
+
|
|
303
|
+
- `$guidelines` (string): The default guidelines text
|
|
304
|
+
|
|
305
|
+
**Returns:** `string` — The guidelines text to return to MCP clients
|
|
306
|
+
|
|
307
|
+
**Source:** `app/Modules/MCP/Tools/ContextTools.php:426`
|
|
308
|
+
|
|
309
|
+
**Usage:**
|
|
310
|
+
|
|
311
|
+
```
|
|
312
|
+
add_filter('fluent_cart/mcp_guidelines', function ($guidelines) {
|
|
313
|
+
return $guidelines . ' Loyalty point balances are informational only and cannot be redeemed through these tools.';
|
|
314
|
+
}, 10, 1);
|
|
315
|
+
```
|
|
316
|
+
|
|
317
|
+
### ` mcp_is_local_dev `
|
|
318
|
+
|
|
319
|
+
`fluent_cart/mcp_is_local_dev` — Filter whether the current request is treated as local development for MCP settings
|
|
320
|
+
|
|
321
|
+
**When it runs:** Runs at the end of `McpSettingsController`'s local-dev detection, after it has checked the request host against its own heuristics (e.g. `localhost`, `.test`, `.local`). Local-dev status affects which guidance/warnings the MCP Settings UI shows about exposing the endpoint.
|
|
322
|
+
|
|
323
|
+
**Parameters:**
|
|
324
|
+
|
|
325
|
+
- `$isLocal` (bool): The result of the built-in heuristic check
|
|
326
|
+
- `$host` (string): The request host that was checked
|
|
327
|
+
|
|
328
|
+
**Returns:** `bool` — Whether to treat the current install as local development
|
|
329
|
+
|
|
330
|
+
**Source:** `app/Http/Controllers/McpSettingsController.php:273`
|
|
331
|
+
|
|
332
|
+
**Usage:**
|
|
333
|
+
|
|
334
|
+
```
|
|
335
|
+
add_filter('fluent_cart/mcp_is_local_dev', function ($isLocal, $host) {
|
|
336
|
+
// Also treat this team's internal staging domain as local
|
|
337
|
+
return $isLocal || str_ends_with($host, '.staging.example.com');
|
|
338
|
+
}, 10, 2);
|
|
339
|
+
```
|
|
340
|
+
|
|
341
|
+
### ` mcp_order_data `
|
|
342
|
+
|
|
343
|
+
`fluent_cart/mcp_order_data` — Filter the order payload returned by MCP order tools
|
|
344
|
+
|
|
345
|
+
**When it runs:** Runs in `OrderTools` after the order record and its requested `include[]` sections have been assembled into the response payload, before the `fields` projection (if requested) trims it. Note `order_id` is always kept even if `fields` would otherwise drop it.
|
|
346
|
+
|
|
347
|
+
**Parameters:**
|
|
348
|
+
|
|
349
|
+
- `$data` (array): The order payload as it will be returned to the MCP client
|
|
350
|
+
- `$context` (array): Resolution context
|
|
351
|
+
|
|
352
|
+
```
|
|
353
|
+
$context = [
|
|
354
|
+
'order' => $order, // \FluentCart\App\Models\Order
|
|
355
|
+
'include' => $include, // string[] — the include[] sections that were requested
|
|
356
|
+
];
|
|
357
|
+
```
|
|
358
|
+
|
|
359
|
+
**Returns:** `array` — The (possibly extended) order payload
|
|
360
|
+
|
|
361
|
+
**Source:** `app/Modules/MCP/Tools/OrderTools.php:532`
|
|
362
|
+
|
|
363
|
+
**Usage:**
|
|
364
|
+
|
|
365
|
+
```
|
|
366
|
+
add_filter('fluent_cart/mcp_order_data', function ($data, $context) {
|
|
367
|
+
$data['fulfillment_notes'] = my_addon_get_notes($context['order']->id);
|
|
368
|
+
return $data;
|
|
369
|
+
}, 10, 2);
|
|
370
|
+
```
|
|
371
|
+
|
|
372
|
+
### ` mcp_order_include_sections `
|
|
373
|
+
|
|
374
|
+
`fluent_cart/mcp_order_include_sections` — Filter the section names offered in the MCP get-order tool's include[] enum
|
|
375
|
+
|
|
376
|
+
**When it runs:** Runs when `OrderTools` builds the list of section names a caller may request via the `include` parameter on the `get-order` MCP tool. Add a section name here to advertise it in the tool's schema; you still need to populate that section via `fluent_cart/mcp_order_data`.
|
|
377
|
+
|
|
378
|
+
**Parameters:**
|
|
379
|
+
|
|
380
|
+
- `$sections` (array): Section name strings
|
|
381
|
+
|
|
382
|
+
**Returns:** `array` — The section names to offer in the `include[]` enum. Deduplicated and cast to strings afterward
|
|
383
|
+
|
|
384
|
+
**Source:** `app/Modules/MCP/Tools/OrderTools.php:567`
|
|
385
|
+
|
|
386
|
+
**Usage:**
|
|
387
|
+
|
|
388
|
+
```
|
|
389
|
+
add_filter('fluent_cart/mcp_order_include_sections', function ($sections) {
|
|
390
|
+
$sections[] = 'fulfillment_notes';
|
|
391
|
+
return $sections;
|
|
392
|
+
}, 10, 1);
|
|
393
|
+
```
|
|
394
|
+
|
|
395
|
+
### ` mcp_server_namespace `
|
|
396
|
+
|
|
397
|
+
`fluent_cart/mcp_server_namespace` — Filter the REST namespace the FluentCart MCP server is registered under
|
|
398
|
+
|
|
399
|
+
**When it runs:** Runs when `MCPInit` creates the dedicated `fluent-cart` MCP server and again in `getEndpointUrl()`, which the Settings UI and connection-snippet generator use, so both stay in sync. Combined with `fluent_cart/mcp_server_route`, this forms the REST path `/wp-json/{namespace}/{route}`.
|
|
400
|
+
|
|
401
|
+
**Parameters:**
|
|
402
|
+
|
|
403
|
+
- `$namespace` (string): The REST namespace. Default: `'fluent-cart'`
|
|
404
|
+
|
|
405
|
+
**Returns:** `string` — The REST namespace for the MCP server endpoint
|
|
406
|
+
|
|
407
|
+
**Source:** `app/Modules/MCP/MCPInit.php:133`
|
|
408
|
+
|
|
409
|
+
Also re-applied in `getEndpointUrl()` at `app/Modules/MCP/MCPInit.php:265`.
|
|
410
|
+
|
|
411
|
+
**Usage:**
|
|
412
|
+
|
|
413
|
+
```
|
|
414
|
+
add_filter('fluent_cart/mcp_server_namespace', function ($namespace) {
|
|
415
|
+
return 'my-store-mcp';
|
|
416
|
+
}, 10, 1);
|
|
417
|
+
```
|
|
418
|
+
|
|
419
|
+
### ` mcp_server_route `
|
|
420
|
+
|
|
421
|
+
`fluent_cart/mcp_server_route` — Filter the REST route the FluentCart MCP server is registered under
|
|
422
|
+
|
|
423
|
+
**When it runs:** Runs when `MCPInit` creates the dedicated `fluent-cart` MCP server and again in `getEndpointUrl()`, which the Settings UI and connection-snippet generator use, so both stay in sync. Combined with `fluent_cart/mcp_server_namespace`, this forms the REST path `/wp-json/{namespace}/{route}`.
|
|
424
|
+
|
|
425
|
+
**Parameters:**
|
|
426
|
+
|
|
427
|
+
- `$route` (string): The REST route. Default: `'mcp'`
|
|
428
|
+
|
|
429
|
+
**Returns:** `string` — The REST route for the MCP server endpoint
|
|
430
|
+
|
|
431
|
+
**Source:** `app/Modules/MCP/MCPInit.php:134`
|
|
432
|
+
|
|
433
|
+
Also re-applied in `getEndpointUrl()` at `app/Modules/MCP/MCPInit.php:266`.
|
|
434
|
+
|
|
435
|
+
**Usage:**
|
|
436
|
+
|
|
437
|
+
```
|
|
438
|
+
add_filter('fluent_cart/mcp_server_route', function ($route) {
|
|
439
|
+
return 'agent-tools';
|
|
440
|
+
}, 10, 1);
|
|
441
|
+
```
|
|
442
|
+
|
|
443
|
+
### ` mcp_tool_index `
|
|
444
|
+
|
|
445
|
+
`fluent_cart/mcp_tool_index` — Filter the tool index returned by get-store-context
|
|
446
|
+
|
|
447
|
+
**When it runs:** Runs when `ContextTools` builds the `tool_index` section of the `get-store-context` MCP tool payload — a grouped index that helps an MCP client pick the right tool for a task before calling `list-*`/`query-*`/`get-*` tools. Empty groups are already filtered out before this filter runs.
|
|
448
|
+
|
|
449
|
+
**Parameters:**
|
|
450
|
+
|
|
451
|
+
- `$index` (array): The tool index, grouped by category
|
|
452
|
+
|
|
453
|
+
**Returns:** `array` — The tool index to return to MCP clients
|
|
454
|
+
|
|
455
|
+
**Source:** `app/Modules/MCP/Tools/ContextTools.php:408`
|
|
456
|
+
|
|
457
|
+
**Usage:**
|
|
458
|
+
|
|
459
|
+
```
|
|
460
|
+
add_filter('fluent_cart/mcp_tool_index', function ($index) {
|
|
461
|
+
$index['loyalty'] = ['list-loyalty-points', 'get-loyalty-summary'];
|
|
462
|
+
return $index;
|
|
463
|
+
}, 10, 1);
|
|
464
|
+
```
|