fluentcart-developer 2.3.4 → 3.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cards/fluentcart/tools.d.ts.map +1 -1
- package/dist/cards/fluentcart/tools.js +2368 -2323
- package/dist/cards/fluentcart/tools.js.map +1 -1
- package/dist/paths.d.ts +1 -1
- package/dist/paths.d.ts.map +1 -1
- package/dist/paths.js +1 -1
- package/dist/paths.js.map +1 -1
- package/dist/reference-reader.d.ts +32 -1
- package/dist/reference-reader.d.ts.map +1 -1
- package/dist/reference-reader.js +111 -22
- package/dist/reference-reader.js.map +1 -1
- package/dist/server.d.ts.map +1 -1
- package/dist/server.js +8 -1
- package/dist/server.js.map +1 -1
- package/dist/skills/fluentcart-developer/SKILL.md +66 -538
- package/dist/skills/fluentcart-developer/references/api/authentication.md +452 -0
- package/dist/skills/fluentcart-developer/references/api/coupons.md +786 -0
- package/dist/skills/fluentcart-developer/references/api/customers.md +889 -0
- package/dist/skills/fluentcart-developer/references/api/files.md +609 -0
- package/dist/skills/fluentcart-developer/references/api/index.md +432 -0
- package/dist/skills/fluentcart-developer/references/api/licensing.md +633 -0
- package/dist/skills/fluentcart-developer/references/api/order-bump.md +384 -0
- package/dist/skills/fluentcart-developer/references/api/orders.md +814 -0
- package/dist/skills/fluentcart-developer/references/api/products.md +866 -0
- package/dist/skills/fluentcart-developer/references/api/roles-permissions.md +536 -0
- package/dist/skills/fluentcart-developer/references/api/subscriptions.md +827 -0
- package/dist/skills/fluentcart-developer/references/database/index.md +44 -0
- package/dist/skills/fluentcart-developer/references/database/models/activity.md +178 -0
- package/dist/skills/fluentcart-developer/references/database/models/applied-coupon.md +291 -0
- package/dist/skills/fluentcart-developer/references/database/models/attribute-group.md +239 -0
- package/dist/skills/fluentcart-developer/references/database/models/attribute-relation.md +181 -0
- package/dist/skills/fluentcart-developer/references/database/models/attribute-term.md +219 -0
- package/dist/skills/fluentcart-developer/references/database/models/cart.md +645 -0
- package/dist/skills/fluentcart-developer/references/database/models/coupon.md +427 -0
- package/dist/skills/fluentcart-developer/references/database/models/customer-addresses.md +348 -0
- package/dist/skills/fluentcart-developer/references/database/models/customer-meta.md +156 -0
- package/dist/skills/fluentcart-developer/references/database/models/customer.md +584 -0
- package/dist/skills/fluentcart-developer/references/database/models/dynamic-model.md +163 -0
- package/dist/skills/fluentcart-developer/references/database/models/label-relationship.md +155 -0
- package/dist/skills/fluentcart-developer/references/database/models/label.md +153 -0
- package/dist/skills/fluentcart-developer/references/database/models/license-activation.md +182 -0
- package/dist/skills/fluentcart-developer/references/database/models/license-meta.md +163 -0
- package/dist/skills/fluentcart-developer/references/database/models/license-site.md +208 -0
- package/dist/skills/fluentcart-developer/references/database/models/license.md +640 -0
- package/dist/skills/fluentcart-developer/references/database/models/meta.md +233 -0
- package/dist/skills/fluentcart-developer/references/database/models/order-address.md +391 -0
- package/dist/skills/fluentcart-developer/references/database/models/order-download-permission.md +144 -0
- package/dist/skills/fluentcart-developer/references/database/models/order-item.md +383 -0
- package/dist/skills/fluentcart-developer/references/database/models/order-meta.md +303 -0
- package/dist/skills/fluentcart-developer/references/database/models/order-operation.md +158 -0
- package/dist/skills/fluentcart-developer/references/database/models/order-promotion-stat.md +175 -0
- package/dist/skills/fluentcart-developer/references/database/models/order-promotion.md +250 -0
- package/dist/skills/fluentcart-developer/references/database/models/order-tax-rate.md +172 -0
- package/dist/skills/fluentcart-developer/references/database/models/order-transaction.md +440 -0
- package/dist/skills/fluentcart-developer/references/database/models/order.md +727 -0
- package/dist/skills/fluentcart-developer/references/database/models/product-detail.md +397 -0
- package/dist/skills/fluentcart-developer/references/database/models/product-download.md +258 -0
- package/dist/skills/fluentcart-developer/references/database/models/product-meta.md +153 -0
- package/dist/skills/fluentcart-developer/references/database/models/product-variation.md +556 -0
- package/dist/skills/fluentcart-developer/references/database/models/product.md +580 -0
- package/dist/skills/fluentcart-developer/references/database/models/relationships.md +427 -0
- package/dist/skills/fluentcart-developer/references/database/models/scheduled-action.md +175 -0
- package/dist/skills/fluentcart-developer/references/database/models/shipping-class.md +148 -0
- package/dist/skills/fluentcart-developer/references/database/models/shipping-method.md +280 -0
- package/dist/skills/fluentcart-developer/references/database/models/shipping-zone.md +205 -0
- package/dist/skills/fluentcart-developer/references/database/models/subscription-meta.md +173 -0
- package/dist/skills/fluentcart-developer/references/database/models/subscription.md +528 -0
- package/dist/skills/fluentcart-developer/references/database/models/tax-class.md +195 -0
- package/dist/skills/fluentcart-developer/references/database/models/tax-rate.md +225 -0
- package/dist/skills/fluentcart-developer/references/database/models/user-meta.md +166 -0
- package/dist/skills/fluentcart-developer/references/database/models/user.md +220 -0
- package/dist/skills/fluentcart-developer/references/database/models.md +404 -0
- package/dist/skills/fluentcart-developer/references/database/query-builder.md +860 -0
- package/dist/skills/fluentcart-developer/references/database/readme.md +276 -0
- package/dist/skills/fluentcart-developer/references/database/schema.md +1002 -0
- package/dist/skills/fluentcart-developer/references/engineering/adding-custom-pages-to-the-customer-dashboard.md +395 -0
- package/dist/skills/fluentcart-developer/references/engineering/index.md +4 -0
- package/dist/skills/fluentcart-developer/references/engineering.md +4 -0
- package/dist/skills/fluentcart-developer/references/getting-started.md +249 -0
- package/dist/skills/fluentcart-developer/references/guides/frontend.md +519 -0
- package/dist/skills/fluentcart-developer/references/guides/index.md +107 -0
- package/dist/skills/fluentcart-developer/references/guides/integrations.md +600 -0
- package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/index.md +237 -0
- package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/labels-and-tracking.md +481 -0
- package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/live-rates.md +269 -0
- package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/reference.md +223 -0
- package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/settings.md +370 -0
- package/dist/skills/fluentcart-developer/references/guides/shipping-carrier.md +237 -0
- package/dist/skills/fluentcart-developer/references/{subscription-customization.md → guides/subscriptions.md} +57 -37
- package/dist/skills/fluentcart-developer/references/hooks/actions/admin-and-templates.md +1079 -0
- package/dist/skills/fluentcart-developer/references/hooks/actions/cart-and-checkout.md +1795 -0
- package/dist/skills/fluentcart-developer/references/hooks/actions/customers-and-users.md +327 -0
- package/dist/skills/fluentcart-developer/references/hooks/actions/licenses.md +829 -0
- package/dist/skills/fluentcart-developer/references/hooks/actions/modules.md +81 -0
- package/dist/skills/fluentcart-developer/references/hooks/actions/orders.md +757 -0
- package/dist/skills/fluentcart-developer/references/hooks/actions/payments-and-integrations.md +1163 -0
- package/dist/skills/fluentcart-developer/references/hooks/actions/pro-modules.md +219 -0
- package/dist/skills/fluentcart-developer/references/hooks/actions/products-and-coupons.md +1019 -0
- package/dist/skills/fluentcart-developer/references/hooks/actions/subscriptions.md +1290 -0
- package/dist/skills/fluentcart-developer/references/hooks/actions.md +16 -0
- package/dist/skills/fluentcart-developer/references/hooks/deprecated.md +60 -0
- package/dist/skills/fluentcart-developer/references/hooks/filters/cart-and-checkout.md +2032 -0
- package/dist/skills/fluentcart-developer/references/hooks/filters/customers-and-subscriptions.md +1746 -0
- package/dist/skills/fluentcart-developer/references/hooks/filters/integrations-and-advanced.md +2439 -0
- package/dist/skills/fluentcart-developer/references/hooks/filters/modules.md +464 -0
- package/dist/skills/fluentcart-developer/references/hooks/filters/orders-and-payments.md +2658 -0
- package/dist/skills/fluentcart-developer/references/hooks/filters/pro-modules.md +502 -0
- package/dist/skills/fluentcart-developer/references/hooks/filters/products-and-pricing.md +1785 -0
- package/dist/skills/fluentcart-developer/references/hooks/filters/settings-and-configuration.md +2966 -0
- package/dist/skills/fluentcart-developer/references/hooks/filters.md +14 -0
- package/dist/skills/fluentcart-developer/references/hooks/index.md +35 -0
- package/dist/skills/fluentcart-developer/references/index.md +625 -0
- package/dist/skills/fluentcart-developer/references/{fee-system-guide.md → modules/fee-system.md} +38 -60
- package/dist/skills/fluentcart-developer/references/{ghost-product-selling.md → modules/ghost-product-selling.md} +71 -89
- package/dist/skills/fluentcart-developer/references/modules/index.md +484 -0
- package/dist/skills/fluentcart-developer/references/modules/licensing.md +342 -0
- package/dist/skills/fluentcart-developer/references/modules/order-bump.md +433 -0
- package/dist/skills/fluentcart-developer/references/modules/payment-methods.md +129 -0
- package/dist/skills/fluentcart-developer/references/modules/refunds.md +170 -0
- package/dist/skills/fluentcart-developer/references/modules/shipping.md +846 -0
- package/dist/skills/fluentcart-developer/references/modules/storage.md +986 -0
- package/dist/skills/fluentcart-developer/references/modules/subscription-vendor-ids.md +186 -0
- package/dist/skills/fluentcart-developer/references/modules/subscriptions.md +678 -0
- package/dist/skills/fluentcart-developer/references/payment-methods-integration/index.md +164 -0
- package/dist/skills/fluentcart-developer/references/payment-methods-integration/paddle-example.md +1648 -0
- package/dist/skills/fluentcart-developer/references/payment-methods-integration/payment/setting/fields.md +353 -0
- package/dist/skills/fluentcart-developer/references/payment-methods-integration/quick-implementation.md +1079 -0
- package/dist/skills/fluentcart-developer/references/payment-methods-integration.md +164 -0
- package/dist/skills/fluentcart-developer/references/restapi/checkout.md +573 -0
- package/dist/skills/fluentcart-developer/references/restapi/coupons.md +958 -0
- package/dist/skills/fluentcart-developer/references/restapi/customer-profile.md +1423 -0
- package/dist/skills/fluentcart-developer/references/{rest-api-customers.md → restapi/customers.md} +406 -424
- package/dist/skills/fluentcart-developer/references/restapi/dashboard.md +1083 -0
- package/dist/skills/fluentcart-developer/references/restapi/data-export.md +132 -0
- package/dist/skills/fluentcart-developer/references/restapi/email-notifications.md +846 -0
- package/dist/skills/fluentcart-developer/references/restapi/files.md +313 -0
- package/dist/skills/fluentcart-developer/references/restapi/index.md +127 -0
- package/dist/skills/fluentcart-developer/references/restapi/integrations.md +1000 -0
- package/dist/skills/fluentcart-developer/references/restapi/inventory.md +192 -0
- package/dist/skills/fluentcart-developer/references/restapi/labels-and-attributes.md +797 -0
- package/dist/skills/fluentcart-developer/references/restapi/licensing.md +1733 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-available-shipping-methods.md +30 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-checkout-summary.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-country-info.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-order-info.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-shipping-methods-list-view.md +30 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/login.md +66 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/place-order.md +179 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/apply-coupon.md +83 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/cancel-coupon.md +87 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/check-product-eligibility.md +59 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/create-coupon.md +230 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/delete-coupon.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/get-coupon-settings.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/get-coupon.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/list-coupon-codes.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/list-coupons.md +37 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/re-apply-coupons.md +75 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/store-coupon-settings.md +40 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/update-coupon.md +133 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/create-address-checkout.md +138 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/create-profile-address.md +119 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/dashboard-overview.md +22 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/delete-profile-address.md +46 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-order-details.md +30 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-portal-sections.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-profile-details.md +22 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-transaction-billing-address.md +30 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-upgrade-paths.md +31 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/list-downloads.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/list-orders.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/make-profile-address-primary.md +55 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/pause-subscription.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/resume-subscription.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/save-transaction-billing-address.md +92 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/select-address-for-checkout.md +32 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/update-profile-address.md +115 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/update-profile-details.md +69 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/attach-user.md +50 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/bulk-actions.md +65 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/create-address.md +135 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/create-customer.md +108 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/delete-address.md +62 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/detach-user.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/find-customer-order.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-attachable-users.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer-addresses.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer-orders.md +37 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer-stats.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer.md +32 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/list-customers.md +37 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/recalculate-ltv.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/set-primary-address.md +72 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/update-additional-info.md +55 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/update-address.md +144 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/update-customer.md +123 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/attach-note-to-order.md +49 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/create-all-pages.md +21 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/create-single-page.md +55 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/delete-activity.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-country-info.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-dashboard-stats.md +22 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-filter-options.md +31 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-onboarding-data.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-onboarding-settings.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-print-templates.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-search-options.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-widgets.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/initialize-app.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/list-activities.md +33 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/list-attachments.md +21 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/list-countries.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/mark-activity-read.md +53 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/run-data-backfills.md +21 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/save-onboarding-settings.md +54 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/save-onboarding-tax-settings.md +73 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/save-print-templates.md +64 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/upload-attachment.md +42 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-customers-batch.md +129 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-licenses-batch.md +133 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-orders-batch.md +129 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-subscriptions-batch.md +129 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-customers-export-schema.md +21 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-licenses-export-schema.md +26 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-orders-export-schema.md +21 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-subscriptions-export-schema.md +21 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/enable-notification.md +57 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-digest-settings.md +22 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-notification.md +30 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-reminders.md +22 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-settings.md +22 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-shortcodes.md +22 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/list-notifications.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/preview-default-template.md +66 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/preview-notification.md +50 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/save-digest-settings.md +101 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/save-reminders.md +162 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/save-settings.md +99 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/send-digest-test.md +47 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/send-manual-reminder.md +51 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/update-notification.md +93 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/files/delete-file.md +31 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/files/get-bucket-list.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/files/list-files.md +30 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/files/upload-editor-file.md +32 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/files/upload-file.md +34 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/chained-data-request.md +46 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/change-feed-status.md +51 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/delete-feed.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-dynamic-options.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-feed-lists.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-feed-settings.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-global-feeds.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-global-settings.md +26 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/install-addon-plugin.md +49 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/list-addons.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/save-feed-settings.md +52 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/set-global-settings.md +50 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/bulk-update-stock.md +94 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/export-inventory.md +81 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/get-adjustment-history.md +26 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/get-inventory-stats.md +21 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/list-inventory.md +33 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/update-stock.md +75 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/create-attribute-group.md +31 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/create-label.md +31 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/create-terms.md +90 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/delete-attribute-group.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/delete-attribute-term.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/get-attribute-group.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/get-attribute-library.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/list-attribute-groups.md +32 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/list-attribute-terms.md +33 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/list-labels.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/reorder-groups.md +51 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/reorder-terms.md +56 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/update-attribute-group.md +37 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/update-attribute-term.md +39 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/update-label-selections.md +32 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/activate-plugin-license.md +41 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/activate-site-admin.md +60 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/deactivate-plugin-license.md +18 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/deactivate-site-admin.md +67 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/deactivate-site-customer.md +47 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/delete-license.md +24 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/extend-license-validity.md +47 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-customer-license-details.md +25 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-customer-licenses-admin.md +26 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-license-activations.md +25 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-license-details.md +25 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-license-site.md +30 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-plugin-license-status.md +18 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-product-license-settings.md +24 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/list-customer-licenses.md +25 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/list-license-sites.md +33 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/list-licenses.md +38 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-activate-license.md +54 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-check-license.md +26 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-deactivate-license.md +46 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-download-license-package.md +23 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-get-license-version.md +26 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/regenerate-license-key.md +24 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/save-product-license-settings.md +193 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/update-license-activation-limit.md +53 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/update-license-status.md +52 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/create-order-bump.md +47 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/delete-order-bump.md +25 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/get-order-bump.md +25 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/list-order-bumps.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/update-order-bump.md +141 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/accept-dispute.md +47 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/bulk-actions.md +72 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/calculate-shipping.md +67 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/calculate-tax.md +98 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/change-customer.md +50 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/charge-now.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-and-change-customer.md +92 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-custom-order-item.md +68 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-order.md +351 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-renewal-now.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/delete-order.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/generate-missing-licenses.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-order-transactions.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-order.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-renewal.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-shipping-methods.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-single-transaction.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/list-order-currencies.md +22 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/list-orders.md +42 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/list-renewals.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/mark-as-paid.md +61 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/price-order.md +135 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/refund-order.md +72 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/resend-renewal-invoice.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/skip-renewal.md +48 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/sync-order-statuses.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/sync-pending-transaction.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-order-address-id.md +60 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-order-address.md +98 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-order.md +172 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-statuses.md +77 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-subscription-details.md +84 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-transaction-status.md +51 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/void-renewal.md +30 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/create-pdf-template.md +42 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/delete-pdf-template.md +26 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/download-pdf-preview.md +44 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-factory-default-templates.md +19 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-pdf-status.md +21 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-pdf-template.md +26 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-saved-templates.md +21 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-seller-details.md +19 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/list-pdf-templates.md +19 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/save-pdf-template.md +53 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/save-seller-details.md +97 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/add-product-terms.md +64 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-edit-fetch.md +30 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-insert-products.md +62 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-update-products.md +59 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-update-variants.md +83 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/change-integration-status.md +64 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/create-dummy-products.md +45 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/create-product.md +81 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/create-variation.md +181 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-downloadable-file.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-product-integration.md +30 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-product.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-taxonomy-term.md +55 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-upgrade-path.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-variation.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/do-bulk-action.md +56 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/duplicate-product.md +56 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-products-by-ids.md +26 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-taxonomy-terms.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-terms-by-parent.md +60 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-variations-by-ids.md +26 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/find-subscription-variants.md +26 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-bundle-info.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-downloadable-url.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-max-excerpt-word-count.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-pricing-widgets.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product-integration-feeds.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product-integration-settings.md +31 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product-pricing.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-related-products.md +31 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-upgrade-settings.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-variation-upgrade-paths.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/group-bulk-update-variants.md +103 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/list-all-variants.md +26 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/list-product-variations.md +26 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/list-products.md +34 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/remove-shipping-class.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/remove-tax-class.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/save-bundle-info.md +56 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/save-product-integration.md +62 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/save-upgrade-path.md +78 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/search-product-variant-options.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/search-products-by-name.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/search-variants-by-name.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/set-variation-media.md +74 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/suggest-sku.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/sync-downloadable-files.md +134 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/sync-taxonomy-terms.md +61 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/toggle-product-tax-exemption.md +56 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-downloadable-file.md +98 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-inventory.md +56 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-long-desc-editor-mode.md +49 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-manage-stock.md +53 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-product-detail.md +58 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-product-pricing.md +225 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-shipping-class.md +49 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-tax-class.md +49 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-upgrade-path.md +78 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variant-option.md +79 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variant-tax-exemption.md +56 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variation-pricing-table.md +49 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variation.md +105 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/public-shop/get-product-views.md +34 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/public-shop/list-products.md +42 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/public-shop/search-products.md +30 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/channel-rules.md +24 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/country-heat-map.md +22 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/coupon-overview.md +37 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/coupons.md +36 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-insights.md +31 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-overview.md +36 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-repeat.md +35 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-segment-customers.md +36 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-segments.md +30 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-value.md +34 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/dashboard-stats.md +30 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/failed-orders.md +34 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-new-vs-returning-customer.md +34 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-report-by-day-and-hour.md +34 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-report-meta.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-top-sold-products.md +34 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/future-renewals.md +31 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/generate-retention-snapshots.md +24 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-overview.md +30 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-recent-activities.md +26 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-recent-orders.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-revenue.md +37 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/installments-at-risk.md +35 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/installments-variations.md +33 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/installments.md +33 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/item-count-distribution.md +34 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/license-chart.md +30 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/license-pie-chart.md +22 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/license-summary.md +22 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/locations.md +43 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-chart.md +37 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-completion-time.md +34 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-mix.md +34 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-value-distribution.md +34 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/payment-methods-disputes.md +38 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/payment-methods-methods.md +36 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/payment-methods.md +37 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-comparison-launch.md +33 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-comparison.md +40 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-detail.md +37 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-sales.md +37 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/refunds-overview.md +37 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/retention-snapshots-step.md +45 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/sales-growth-chart.md +35 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/save-channel-rules.md +73 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/source-channels.md +37 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/sources.md +49 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-cohorts.md +33 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-health.md +30 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-rebuys.md +37 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-retention.md +34 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-variations.md +22 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscriptions-overview.md +37 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/weeks-between-refund.md +34 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/assign-role.md +48 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/delete-role-assignment.md +47 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/get-role.md +25 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/list-managers.md +18 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/list-roles.md +18 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/search-users.md +25 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/update-role.md +43 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/create-saved-view.md +106 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/delete-saved-view.md +26 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/list-saved-views.md +25 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/update-saved-view.md +83 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/activate-payment-addon.md +44 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/activate-plugin-addon.md +44 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/change-storage-driver-status.md +56 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/check-paypal-webhook.md +26 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/create-storage-bucket.md +63 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/disconnect-payment-method.md +55 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/exchange-paypal-seller-auth-token.md +62 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-active-storage-drivers.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-checkout-fields.md +22 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-email-shortcodes.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-mcp-config-snippets.md +26 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-mcp-status.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-module-settings.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-payment-method-connection-info.md +26 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-payment-method-settings.md +26 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-permissions.md +22 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-plugin-addons.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-storage-driver-settings.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-store-settings.md +26 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/install-mcp-adapter.md +21 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/install-payment-addon.md +60 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/install-plugin-addon.md +64 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/list-all-payment-methods.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/list-all-storage-drivers.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/list-storage-buckets.md +67 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/reorder-payment-methods.md +55 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/reset-storage-driver-settings.md +45 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-checkout-fields.md +133 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-confirmation-settings.md +68 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-module-settings.md +68 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-payment-method-design.md +67 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-payment-method-settings.md +58 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-permissions.md +68 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-storage-driver-settings.md +62 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-store-settings.md +239 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/setup-paypal-webhook.md +48 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/toggle-mcp.md +40 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/verify-storage-driver-connection.md +62 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/verify-turnstile-keys.md +55 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/create-shipping-class.md +73 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/create-shipping-method.md +110 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/create-shipping-zone.md +56 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/delete-shipping-class.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/delete-shipping-method.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/delete-shipping-zone.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-class-profile.md +30 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-class.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-packages.md +22 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-zone.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-zone-countries.md +22 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-zone-states.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/list-shipping-classes.md +31 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/list-shipping-zones.md +31 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/save-shipping-packages.md +112 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-shipping-class.md +79 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-shipping-method.md +113 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-shipping-zone.md +62 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-zone-order.md +52 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/cancel-auto-renew.md +30 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/cancel-subscription.md +52 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/confirm-subscription-switch.md +70 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/fetch-subscription-remote.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/generate-early-payment-link.md +29 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-customer-subscription.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-or-create-plan.md +69 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-setup-intent-attempts.md +30 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-subscription.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/initiate-early-payment.md +31 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/list-customer-subscriptions.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/list-subscriptions.md +39 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/pause-subscription.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/reactivate-subscription.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/resume-subscription.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/switch-payment-method.md +70 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/update-payment-method.md +69 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/update-vendor-ids.md +56 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/verify-vendor-ids.md +56 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/create-tax-class.md +51 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/create-tax-rate.md +117 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-product-override.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-shipping-tax-override.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-tax-class.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-tax-rate.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-country-tax-id.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-country-tax-rates.md +28 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-eu-vat-product-overrides.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-oss-country-rates.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-preconfigured-tax-rates.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-product-overrides.md +27 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-tax-settings.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/list-all-tax-rates.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/list-tax-classes.md +20 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/list-tax-records.md +37 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/mark-taxes-as-filed.md +58 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/reset-eu-vat-rates.md +21 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-configured-countries.md +57 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-country-tax-id.md +50 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-eu-vat-cross-border-settings.md +127 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-oss-country-rates.md +100 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-product-override.md +110 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-shipping-tax-override.md +52 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-tax-settings.md +166 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/update-country-status.md +54 -0
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/update-tax-rate.md +116 -0
- package/dist/skills/fluentcart-developer/references/restapi/order-bumps.md +433 -0
- package/dist/skills/fluentcart-developer/references/{rest-api-orders.md → restapi/orders.md} +146 -396
- package/dist/skills/fluentcart-developer/references/restapi/pdf-templates.md +212 -0
- package/dist/skills/fluentcart-developer/references/{rest-api-products.md → restapi/products.md} +354 -566
- package/dist/skills/fluentcart-developer/references/restapi/public-shop.md +191 -0
- package/dist/skills/fluentcart-developer/references/restapi/reports.md +3773 -0
- package/dist/skills/fluentcart-developer/references/restapi/roles.md +403 -0
- package/dist/skills/fluentcart-developer/references/restapi/saved-views.md +136 -0
- package/dist/skills/fluentcart-developer/references/restapi/settings.md +1423 -0
- package/dist/skills/fluentcart-developer/references/{rest-api-shipping.md → restapi/shipping.md} +243 -138
- package/dist/skills/fluentcart-developer/references/restapi/subscriptions.md +1169 -0
- package/dist/skills/fluentcart-developer/references/restapi/tax.md +1551 -0
- package/dist/skills/fluentcart-developer/references/restapi.md +127 -0
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +1 -1
- package/dist/skills/fluentcart-developer/.claude-plugin/plugin.json +0 -12
- package/dist/skills/fluentcart-developer/.mcp.json +0 -11
- package/dist/skills/fluentcart-developer/references/action-hooks-admin-templates.md +0 -787
- package/dist/skills/fluentcart-developer/references/action-hooks-cart-checkout.md +0 -1355
- package/dist/skills/fluentcart-developer/references/action-hooks-customers-users.md +0 -266
- package/dist/skills/fluentcart-developer/references/action-hooks-licenses.md +0 -855
- package/dist/skills/fluentcart-developer/references/action-hooks-orders.md +0 -631
- package/dist/skills/fluentcart-developer/references/action-hooks-payments-integrations.md +0 -963
- package/dist/skills/fluentcart-developer/references/action-hooks-products-coupons.md +0 -585
- package/dist/skills/fluentcart-developer/references/action-hooks-subscriptions.md +0 -661
- package/dist/skills/fluentcart-developer/references/customer-dashboard-endpoints.md +0 -169
- package/dist/skills/fluentcart-developer/references/database-models-query-builder.md +0 -194
- package/dist/skills/fluentcart-developer/references/database-models-reference.md +0 -604
- package/dist/skills/fluentcart-developer/references/database-schema-reference.md +0 -947
- package/dist/skills/fluentcart-developer/references/engineering-notes.md +0 -154
- package/dist/skills/fluentcart-developer/references/filter-hooks-cart-checkout.md +0 -1202
- package/dist/skills/fluentcart-developer/references/filter-hooks-customers-subscriptions.md +0 -902
- package/dist/skills/fluentcart-developer/references/filter-hooks-integrations-advanced.md +0 -1598
- package/dist/skills/fluentcart-developer/references/filter-hooks-orders-payments.md +0 -1319
- package/dist/skills/fluentcart-developer/references/filter-hooks-products-pricing.md +0 -628
- package/dist/skills/fluentcart-developer/references/filter-hooks-settings-configuration.md +0 -1177
- package/dist/skills/fluentcart-developer/references/fluentcart-developer-guide.md +0 -154
- package/dist/skills/fluentcart-developer/references/hooks-complete-index.md +0 -834
- package/dist/skills/fluentcart-developer/references/models-complete-index.md +0 -912
- package/dist/skills/fluentcart-developer/references/modules-and-extensions-reference.md +0 -224
- package/dist/skills/fluentcart-developer/references/order-bump-module.md +0 -163
- package/dist/skills/fluentcart-developer/references/paddle-gateway-case-study.md +0 -1931
- package/dist/skills/fluentcart-developer/references/payment-gateway-integration.md +0 -761
- package/dist/skills/fluentcart-developer/references/rest-api-checkout.md +0 -288
- package/dist/skills/fluentcart-developer/references/rest-api-coupons.md +0 -801
- package/dist/skills/fluentcart-developer/references/rest-api-customer-profile.md +0 -190
- package/dist/skills/fluentcart-developer/references/rest-api-dashboard-utilities.md +0 -219
- package/dist/skills/fluentcart-developer/references/rest-api-email-notifications.md +0 -619
- package/dist/skills/fluentcart-developer/references/rest-api-files.md +0 -290
- package/dist/skills/fluentcart-developer/references/rest-api-integrations.md +0 -324
- package/dist/skills/fluentcart-developer/references/rest-api-labels-attributes.md +0 -321
- package/dist/skills/fluentcart-developer/references/rest-api-licensing.md +0 -174
- package/dist/skills/fluentcart-developer/references/rest-api-order-bumps.md +0 -200
- package/dist/skills/fluentcart-developer/references/rest-api-overview.md +0 -131
- package/dist/skills/fluentcart-developer/references/rest-api-public-shop.md +0 -172
- package/dist/skills/fluentcart-developer/references/rest-api-reference.md +0 -552
- package/dist/skills/fluentcart-developer/references/rest-api-reports.md +0 -377
- package/dist/skills/fluentcart-developer/references/rest-api-roles-permissions.md +0 -147
- package/dist/skills/fluentcart-developer/references/rest-api-settings.md +0 -528
- package/dist/skills/fluentcart-developer/references/rest-api-subscriptions.md +0 -938
- package/dist/skills/fluentcart-developer/references/rest-api-tax.md +0 -356
- package/dist/skills/fluentcart-developer/references/shipping-module-guide.md +0 -126
- package/dist/skills/fluentcart-developer/references/software-licensing-sdk.md +0 -228
- package/dist/skills/fluentcart-developer/references/storage-drivers-module.md +0 -140
|
@@ -0,0 +1,395 @@
|
|
|
1
|
+
# /engineering/adding-custom-pages-to-the-customer-dashboard
|
|
2
|
+
|
|
3
|
+
The FluentCart customer portal is a Vue 3 single-page app. Dashboard, purchase history, subscriptions, licenses, downloads, profile — all client-side routes in one bundle, shipped by core.
|
|
4
|
+
|
|
5
|
+
That is a fine architecture right up until an add-on needs a tab in it. A wallet plugin wants a **Wallet** page. A helpdesk wants **Support**. A payment add-on wants **Payment Methods**. None of them can compile Vue components into core's bundle, and none of them should have to.
|
|
6
|
+
|
|
7
|
+
So `addCustomerDashboardEndpoint()` exists, and the interesting part is not the API — it is three lines long — but the routing trick underneath that lets a server-rendered page live inside a client-rendered app without either one knowing about the other.
|
|
8
|
+
|
|
9
|
+
## One call
|
|
10
|
+
|
|
11
|
+
```
|
|
12
|
+
add_action('fluent_cart/init', function () {
|
|
13
|
+
fluent_cart_api()->addCustomerDashboardEndpoint('acme-wallet', [
|
|
14
|
+
'title' => __('Wallet', 'my-plugin'),
|
|
15
|
+
'icon_svg' => '<svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 20 20" fill="none"><path d="M3 6h14v10H3z" fill="currentColor"/></svg>',
|
|
16
|
+
'render_callback' => function () {
|
|
17
|
+
echo do_shortcode('[my_wallet_widget]');
|
|
18
|
+
},
|
|
19
|
+
]);
|
|
20
|
+
});
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
That is the whole integration. You now have:
|
|
24
|
+
|
|
25
|
+
- a **Wallet** item in the portal's left nav, sitting just above *Profile*,
|
|
26
|
+
- a working URL at `/account/acme-wallet` (whatever your customer dashboard page slug is),
|
|
27
|
+
- the portal's header, avatar block, nav, logout button, and responsive behaviour wrapped around your content,
|
|
28
|
+
- correct active-tab highlighting when a customer is on your page,
|
|
29
|
+
- no rewrite rule to register, no permalink flush, no `template_redirect` hook, no Vue, no build step.
|
|
30
|
+
|
|
31
|
+
Two things in that snippet are doing more work than they look like they are.
|
|
32
|
+
|
|
33
|
+
**`fluent_cart/init` is the hook to use.** It fires from `boot/app.php:40`:
|
|
34
|
+
|
|
35
|
+
```
|
|
36
|
+
add_action('plugins_loaded', function () use ($app) {
|
|
37
|
+
do_action('fluentcart_loaded', $app);
|
|
38
|
+
|
|
39
|
+
add_action('init', function () use ($app) {
|
|
40
|
+
DBMigrator::maybeMigrateDBChanges();
|
|
41
|
+
do_action('fluent_cart/init', $app); // ← you are here
|
|
42
|
+
// ...
|
|
43
|
+
});
|
|
44
|
+
});
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
It runs inside WordPress's `init`, after migrations, and it only fires **if FluentCart is loaded at all**. That is the whole point: inside that callback, FluentCart is present, booted, and its globals are defined. You do not need `function_exists()`, you do not need `class_exists()`, and you do not need to guess a priority — if FluentCart isn't active, your callback simply never runs and your plugin does nothing, which is exactly the behaviour you wanted from the guard anyway. The `$app` container instance is passed as the first argument if you need it.
|
|
48
|
+
|
|
49
|
+
Attach your listener at the top level of your plugin file (or anywhere before `init`) and you're done. Registering later than `init` — inside `wp`, `template_redirect`, or `wp_enqueue_scripts` — is too late: by then the portal may already be rendering its menu, and your tab silently isn't there.
|
|
50
|
+
|
|
51
|
+
**`fluent_cart_api()` is the public entry point.** It's a global function defined in `boot/globals.php` returning the `FluentCart\Api\FluentCartGeneralApi` singleton. Prefer it over reaching into the class directly — it is the surface we treat as public API, and it keeps your code free of `FluentCart\…` class references that would fatal on a site where the plugin is missing. The alternative, `\FluentCart\Api\FluentCartGeneralApi::getInstance()`, is the same object; you'll see it in older integrations written before the helper existed.
|
|
52
|
+
|
|
53
|
+
## The second form: hand it a WordPress page
|
|
54
|
+
|
|
55
|
+
`render_callback` is one of two ways to fill the page. The other is `page_id` — you point the endpoint at an ordinary WordPress page and let core render it:
|
|
56
|
+
|
|
57
|
+
```
|
|
58
|
+
add_action('fluent_cart/init', function () {
|
|
59
|
+
fluent_cart_api()->addCustomerDashboardEndpoint('help', [
|
|
60
|
+
'title' => __('Help', 'my-plugin'),
|
|
61
|
+
'page_id' => get_option('my_plugin_help_page_id'),
|
|
62
|
+
]);
|
|
63
|
+
});
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
Core runs a one-post `WP_Query`, renders `the_content()` inside a `.fluent-cart-custom-page-content` wrapper, and calls `wp_reset_postdata()`. The page's own template, header, and sidebar are *not* used — only its content — which is exactly what you want for something that has to sit inside the portal shell. If the ID doesn't resolve, the customer sees "No content found!". `render_callback` wins if you pass both.
|
|
67
|
+
|
|
68
|
+
This is the right form whenever the page is really *content* — a help page, a terms summary, an onboarding note, a page built in the block editor. A site owner can edit it without touching your plugin, and you didn't have to write a renderer.
|
|
69
|
+
|
|
70
|
+
### Make the Account page its parent
|
|
71
|
+
|
|
72
|
+
Here's the part that makes `page_id` genuinely pleasant, and it's easy to miss.
|
|
73
|
+
|
|
74
|
+
Set the endpoint page's **parent** to your Account (customer dashboard) page in the Page Attributes panel, and give it a **slug matching the endpoint slug**. WordPress then builds the page's permalink as `/account/help/` — which is byte-for-byte the URL the portal nav already points at.
|
|
75
|
+
|
|
76
|
+
You don't have to do this. But when you don't, the page has two addresses: its real permalink somewhere else on the site, and the portal URL. When you do, there is exactly one URL, and it is the portal one. Concretely:
|
|
77
|
+
|
|
78
|
+
- The page's **View** link in wp-admin opens it inside the portal, in the shell, with the nav highlighted — not as a bare page on the theme's template.
|
|
79
|
+
- Yoast/breadcrumbs/menus/search all point at the portal URL, because it *is* the permalink.
|
|
80
|
+
- The site owner can find and edit the page in **Pages** like any other page, nested under Account in the list view where they'd expect it.
|
|
81
|
+
|
|
82
|
+
I checked this end-to-end on a live install rather than trusting the reasoning. Creating a page with `post_parent` set to the Account page and slug `fct-doc-test` gives `get_page_link()` → `https://cart.lab/account/fct-doc-test/`, and `URL::getCustomerDashboardUrl('fct-doc-test')` → the same path. Requesting it as a logged-in customer returns 200 and the response contains the page's content inside `.fluent-cart-custom-page-content`, wrapped in the portal shell, with `active_customer_menu` on `.fct-customer-nav-item-fct-doc-test`. The SPA mount point `data-fluent-cart-customer-profile-app` is absent, exactly as the branch in `renderCustomerAppContainer()` predicts.
|
|
83
|
+
|
|
84
|
+
Why does this work at all? Because of the wildcard rewrite rule covered under *How a URL becomes your callback* below: `^account/(.+)?$` is registered with `'top'` priority, so it wins before WordPress's own page-hierarchy rules ever get a look. The request resolves to the *Account* page, the portal boots, and the path segment `help` is matched against the endpoint map. Your child page is never resolved as a page by WordPress — core loads its content deliberately, by ID.
|
|
85
|
+
|
|
86
|
+
A child page without a registered endpoint is unreachable
|
|
87
|
+
|
|
88
|
+
That same rewrite rule is unconditional. Park a page under Account and *don't* register a matching endpoint, and the page becomes a dead end: the request still resolves to the Account page, `maybeCustomEndpointContent()` finds nothing, so core boots the Vue SPA — whose router has no such route. The customer gets the portal shell with nothing in it, and the page's own content never renders.
|
|
89
|
+
|
|
90
|
+
Verified: an orphan child page at `/account/fct-orphan/` returned 200 with the SPA mount point present and its own content nowhere in the response.
|
|
91
|
+
|
|
92
|
+
So the page and the endpoint registration are a pair. If your plugin creates the page on activation, register the endpoint unconditionally on `fluent_cart/init` — not behind a setting that can be switched off while the page stays published.
|
|
93
|
+
|
|
94
|
+
One cosmetic note while you're here: `URL::getCustomerDashboardUrl()` builds the nav link *without* a trailing slash, and WordPress canonicalises to the trailing slash form. So the first click on your tab costs a 301. This is true for every custom endpoint, `page_id` or callback, and is harmless — just don't be puzzled by the redirect in your network tab.
|
|
95
|
+
|
|
96
|
+
## What the call actually does
|
|
97
|
+
|
|
98
|
+
`addCustomerDashboardEndpoint()` (`api/FluentCartGeneralApi.php:25`) validates its arguments and then registers **two filters**. That is it. There is no registry object, no custom post type, no route table.
|
|
99
|
+
|
|
100
|
+
```
|
|
101
|
+
add_filter('fluent_cart/global_customer_menu_items', /* insert nav item */);
|
|
102
|
+
add_filter('fluent_cart/customer_portal/custom_endpoints', /* register slug => callback */);
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
The first filter puts a nav item in the menu. The second one puts your slug in a map the portal consults at render time. The split matters: the menu is rendered on *every* portal page, while the endpoint map is only consulted when the requested path doesn't belong to core.
|
|
106
|
+
|
|
107
|
+
You can call those two filters directly and skip the API entirely — they're documented under [customer & subscription filters](/hooks/filters/customers-and-subscriptions.md). The wrapper exists because getting the nav-item array shape, the URL builder, and the CSS class right by hand is three chances to be subtly wrong, and one of them is load-bearing in a way that isn't obvious. More on that in a moment.
|
|
108
|
+
|
|
109
|
+
## How a URL becomes your callback
|
|
110
|
+
|
|
111
|
+
This is the part worth understanding, because it explains every constraint that follows.
|
|
112
|
+
|
|
113
|
+
Three details in that flow do all the work.
|
|
114
|
+
|
|
115
|
+
**The rewrite rule is a wildcard, registered once.** On `init`, `CustomerProfileHandler::register()` adds a single rule (`CustomerProfileHandler.php:43-55`):
|
|
116
|
+
|
|
117
|
+
```
|
|
118
|
+
add_rewrite_rule(
|
|
119
|
+
'^' . $pageSlug . '/(.+)?$',
|
|
120
|
+
'index.php?page_id=' . $customerProfilePageId,
|
|
121
|
+
'top'
|
|
122
|
+
);
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
Everything under the dashboard slug resolves to the same WordPress page. That is why your endpoint needs no rewrite rule of its own and why you never have to flush permalinks — a new slug is not new routing, it is new *content* on routing that already exists. It also means "does this path exist?" is a question core answers in PHP at render time, not something the rewrite layer knows about.
|
|
126
|
+
|
|
127
|
+
The `'top'` argument is what makes the parent-page trick work: this rule is inserted ahead of WordPress's own rules, including page hierarchy. A real child page sitting at `/account/help/` never gets resolved as a page — the wildcard claims the URL first, and core loads that page's content by ID instead. The same priority is why an unregistered child page is unreachable: there is no fallback path back to normal page resolution.
|
|
128
|
+
|
|
129
|
+
`getCustomerDashboardPageSlug()` derives that prefix from `get_page_link()` minus the home URL, so it is the page's **full path**, not just its post slug. Nest the Account page itself under `/my/` and the rule becomes `^my/account/(.+)?$`. It handles that correctly; just don't assume the prefix is a single segment when you're parsing `$wp->request` yourself.
|
|
130
|
+
|
|
131
|
+
**Only the first path segment is matched.** `maybeCustomEndpointContent()` (`CustomerProfileHandler.php:154`) strips the dashboard page slug, splits what's left on `/`, and `array_shift()`s the first segment. `/account/acme-wallet` and `/account/acme-wallet/transactions/42` both resolve to the endpoint `acme-wallet`. The remaining segments are **discarded** — they are not passed to your callback. If you want sub-routes, read them yourself:
|
|
132
|
+
|
|
133
|
+
```
|
|
134
|
+
'render_callback' => function () {
|
|
135
|
+
global $wp;
|
|
136
|
+
|
|
137
|
+
// Slice off everything up to and including your own slug, rather than
|
|
138
|
+
// assuming a fixed offset — the dashboard prefix can be more than one
|
|
139
|
+
// segment if the Account page is nested.
|
|
140
|
+
$segments = explode('/', trim($wp->request, '/'));
|
|
141
|
+
$position = array_search('acme-wallet', $segments, true);
|
|
142
|
+
$subPath = $position === false ? [] : array_slice($segments, $position + 1);
|
|
143
|
+
|
|
144
|
+
if (!empty($subPath) && $subPath[0] === 'transactions') {
|
|
145
|
+
echo my_plugin_render_transactions();
|
|
146
|
+
return;
|
|
147
|
+
}
|
|
148
|
+
|
|
149
|
+
echo do_shortcode('[my_wallet_widget]');
|
|
150
|
+
}
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
**When your endpoint matches, the SPA does not boot.** Look at the branch in `renderCustomerAppContainer()` (`CustomerProfileHandler.php:130-145`):
|
|
154
|
+
|
|
155
|
+
```
|
|
156
|
+
$customEndpointContent = $this->maybeCustomEndpointContent();
|
|
157
|
+
|
|
158
|
+
if (!$customEndpointContent) {
|
|
159
|
+
(new static())->enqueueStyles();
|
|
160
|
+
}
|
|
161
|
+
|
|
162
|
+
add_action('fluent_cart/customer_app', function () use ($customEndpointContent) {
|
|
163
|
+
if ($customEndpointContent) {
|
|
164
|
+
echo $customEndpointContent; // your output
|
|
165
|
+
} else {
|
|
166
|
+
AssetLoader::loadCustomerDashboardAssets();
|
|
167
|
+
$this->renderCustomerApp(); // <div data-fluent-cart-customer-profile-app>
|
|
168
|
+
}
|
|
169
|
+
});
|
|
170
|
+
```
|
|
171
|
+
|
|
172
|
+
Your page and core's SPA are mutually exclusive. Core's page renders the mount point and enqueues the bundle; your page renders your HTML and doesn't. That is a deliberate trade — you inherit the shell, not the runtime — and it is the source of the asset rules below.
|
|
173
|
+
|
|
174
|
+
## The link is a full page load, on purpose
|
|
175
|
+
|
|
176
|
+
Core's own nav items carry the CSS class `fct_route`. On `DOMContentLoaded`, `Start.js:342` walks every `a.fct_route`, resolves the href against the Vue router, and if the router matches, calls `preventDefault()` and pushes the route client-side.
|
|
177
|
+
|
|
178
|
+
Your nav item is given the class `fct-menu-item-` instead. It is never picked up by that listener, so clicking it is an ordinary browser navigation — full page load, PHP renders, your callback runs.
|
|
179
|
+
|
|
180
|
+
This is not an oversight. If your link were tagged `fct_route`, one of two things would happen: the router wouldn't match the path and the click would fall through to a normal navigation anyway (harmless but accidental), or — worse — a future core route would start matching your slug and swallow the click into a 404 inside the SPA. Opting out of the interceptor is what makes a server-rendered page safe to embed in a client-rendered app.
|
|
181
|
+
|
|
182
|
+
The practical consequence: **navigating to your page costs a full page load, and navigating away from it costs another one.** For a page a customer visits occasionally, that is the correct trade. For something they'd tab in and out of constantly, it isn't — see *When not to use this* at the end.
|
|
183
|
+
|
|
184
|
+
## What the API refuses to do
|
|
185
|
+
|
|
186
|
+
Two guard clauses, both of which `throw`:
|
|
187
|
+
|
|
188
|
+
```
|
|
189
|
+
$reserved = ['dashboard', 'purchase-history', 'subscriptions', 'licenses', 'downloads', 'profile'];
|
|
190
|
+
|
|
191
|
+
if (in_array($slug, $reserved)) {
|
|
192
|
+
throw new \Exception(/* ... */);
|
|
193
|
+
}
|
|
194
|
+
|
|
195
|
+
if (!isset($args['render_callback']) && !isset($args['page_id'])) {
|
|
196
|
+
throw new \Exception(/* ... */);
|
|
197
|
+
}
|
|
198
|
+
```
|
|
199
|
+
|
|
200
|
+
An empty slug throws too. Because `fluent_cart/init` fires on every request, an uncaught exception here is a **fatal on every page load of the site**, not a quiet failure on the portal. If your slug is anything other than a hard-coded literal — a setting, a filter, a slug derived from a post — wrap the call:
|
|
201
|
+
|
|
202
|
+
```
|
|
203
|
+
try {
|
|
204
|
+
fluent_cart_api()->addCustomerDashboardEndpoint($slug, $args);
|
|
205
|
+
} catch (\Exception $e) {
|
|
206
|
+
// log it, skip the tab, keep the site up
|
|
207
|
+
}
|
|
208
|
+
```
|
|
209
|
+
|
|
210
|
+
### The reserved list is shorter than the route list
|
|
211
|
+
|
|
212
|
+
Here is a sharp edge that is easy to walk into. The reserved list has six entries. The SPA's router (`Start.js`) has ten routes, including:
|
|
213
|
+
|
|
214
|
+
| Route | Reserved? |
|
|
215
|
+
| --- | --- |
|
|
216
|
+
| `/purchase-history` | yes |
|
|
217
|
+
| `/subscriptions` | yes |
|
|
218
|
+
| `/downloads`, `/licenses`, `/profile` | yes |
|
|
219
|
+
| `/order/:order_id` | **no** |
|
|
220
|
+
| `/subscription/:subscription_uuid` | **no** |
|
|
221
|
+
|
|
222
|
+
`URL::getCustomerOrderUrl()` builds links to `/{dashboard}/order/{uuid}` — a real, linked-to route in every order confirmation. But `order` is not in the reserved list, so `addCustomerDashboardEndpoint('order', …)` is accepted without complaint, and from then on every order-detail link renders *your* page instead. Same for `subscription` (singular — the plural is reserved, the singular isn't).
|
|
223
|
+
|
|
224
|
+
Don't rely on the guard to protect you. **Namespace your slug.** `acme-wallet` beats `wallet`, and it costs you nothing.
|
|
225
|
+
|
|
226
|
+
## What you own
|
|
227
|
+
|
|
228
|
+
The shell is core's. Everything inside it is yours, including the parts that are easy to forget.
|
|
229
|
+
|
|
230
|
+
### Escaping
|
|
231
|
+
|
|
232
|
+
Your callback's output is echoed with escaping explicitly suppressed:
|
|
233
|
+
|
|
234
|
+
```
|
|
235
|
+
echo $customEndpointContent; // @phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
|
|
236
|
+
```
|
|
237
|
+
|
|
238
|
+
Core cannot escape it — you are returning HTML by design. So every dynamic value inside your callback goes through `esc_html()`, `esc_attr()`, `esc_url()`, or `wp_kses()` before it reaches the buffer. There is no second line of defence behind you.
|
|
239
|
+
|
|
240
|
+
The `page_id` form is exempt: that content goes through `the_content()` and WordPress's normal filters, so it is no more and no less trusted than any other page on the site.
|
|
241
|
+
|
|
242
|
+
### Authorization
|
|
243
|
+
|
|
244
|
+
The portal gates on `is_user_logged_in()` and nothing else. Any logged-in user reaches any registered endpoint. If your page shows data belonging to a customer, resolve *which* customer from the session rather than from anything in the request:
|
|
245
|
+
|
|
246
|
+
```
|
|
247
|
+
'render_callback' => function () {
|
|
248
|
+
$customer = \FluentCart\Api\Resource\CustomerResource::getCurrentCustomer();
|
|
249
|
+
|
|
250
|
+
if (!$customer) {
|
|
251
|
+
echo '<p>' . esc_html__('No customer record found.', 'my-plugin') . '</p>';
|
|
252
|
+
return;
|
|
253
|
+
}
|
|
254
|
+
|
|
255
|
+
// Query by $customer->id — never by an id from $_GET.
|
|
256
|
+
echo my_plugin_render_wallet($customer->id);
|
|
257
|
+
}
|
|
258
|
+
```
|
|
259
|
+
|
|
260
|
+
`getCurrentCustomer()` returns `null` for logged-out users and is memoised per request, so calling it repeatedly inside your renderer is free.
|
|
261
|
+
|
|
262
|
+
### Assets
|
|
263
|
+
|
|
264
|
+
This is the one that surprises people. On a custom-endpoint page:
|
|
265
|
+
|
|
266
|
+
**Loaded:** `customer-profile-global.scss` — the portal shell, the nav, and the full set of `--fct-customer-dashboard-*` CSS custom properties.
|
|
267
|
+
|
|
268
|
+
**Not loaded:** `customer-profile.scss` and `Start.js`. `enqueueStyles()` is skipped and `AssetLoader::loadCustomerDashboardAssets()` is never called, which also means the `fluent_cart/customer_dashboard/enqueue_assets` action does not fire on your page, and `window.fluentcart_customer_profile_vars` does not exist. Anything you were hoping to borrow from core's bundle — Element Plus, the REST config, the translation strings — is absent.
|
|
269
|
+
|
|
270
|
+
Enqueue your own, conditionally:
|
|
271
|
+
|
|
272
|
+
```
|
|
273
|
+
add_action('wp_enqueue_scripts', function () {
|
|
274
|
+
global $wp;
|
|
275
|
+
if (strpos($wp->request ?? '', '/acme-wallet') === false) {
|
|
276
|
+
return;
|
|
277
|
+
}
|
|
278
|
+
|
|
279
|
+
wp_enqueue_style('acme-wallet', plugins_url('assets/wallet.css', __FILE__), [], '1.0.0');
|
|
280
|
+
wp_enqueue_script('acme-wallet', plugins_url('assets/wallet.js', __FILE__), [], '1.0.0', true);
|
|
281
|
+
});
|
|
282
|
+
```
|
|
283
|
+
|
|
284
|
+
To look native without importing core's stylesheet, style against the custom properties the shell already defines:
|
|
285
|
+
|
|
286
|
+
```
|
|
287
|
+
.acme-wallet-card {
|
|
288
|
+
color: var(--fct-customer-dashboard-text-color);
|
|
289
|
+
border: 1px solid var(--fct-customer-dashboard-border-color);
|
|
290
|
+
border-radius: 8px;
|
|
291
|
+
padding: 16px;
|
|
292
|
+
}
|
|
293
|
+
|
|
294
|
+
.acme-wallet-card h3 {
|
|
295
|
+
color: var(--fct-customer-dashboard-title-color);
|
|
296
|
+
}
|
|
297
|
+
```
|
|
298
|
+
|
|
299
|
+
Those variables inherit from the store's theme colors, including the ones a site owner sets through the shortcode's `colors` attribute. Hard-coded hex values will drift the moment someone rebrands; these won't.
|
|
300
|
+
|
|
301
|
+
### Icons
|
|
302
|
+
|
|
303
|
+
`icon_svg` is rendered through `wp_kses()` against a deliberately tight allowlist (`fct_allowed_svg_tags`): `svg`, `path`, and `g`, with only geometry and stroke/fill attributes. No `title`, no `defs`, no `use`, no inline `style`. Give the SVG `width="20" height="20"` and `fill="currentColor"` so it picks up the nav's active and hover states, and strip anything decorative before pasting it in — it will be silently removed otherwise.
|
|
304
|
+
|
|
305
|
+
If your icon doesn't survive the allowlist, `icon_url` takes an image URL instead. Only one of the two is used; `icon_svg` wins if both are set.
|
|
306
|
+
|
|
307
|
+
## Two real integrations
|
|
308
|
+
|
|
309
|
+
**Fluent Support** adds a Support tab that renders its existing portal shortcode (`FluentCart.php:241`):
|
|
310
|
+
|
|
311
|
+
```
|
|
312
|
+
fluent_cart_api()->addCustomerDashboardEndpoint('fluent-support', [
|
|
313
|
+
'title' => __('Support', 'fluent-support'),
|
|
314
|
+
'render_callback' => function () {
|
|
315
|
+
echo do_shortcode('[fluent_support_portal]');
|
|
316
|
+
},
|
|
317
|
+
'priority' => 'high'
|
|
318
|
+
]);
|
|
319
|
+
```
|
|
320
|
+
|
|
321
|
+
Note `'priority' => 'high'`. `addCustomerDashboardEndpoint()` reads exactly four keys — `title`, `icon_svg`, `icon_url`, and `render_callback`/`page_id` — so `priority` is silently ignored. It does nothing, and it has never done anything. Menu order is not configurable through this API.
|
|
322
|
+
|
|
323
|
+
**Credex** does the same for a wallet — hooking WordPress's own `init` and guarding with `class_exists()`:
|
|
324
|
+
|
|
325
|
+
```
|
|
326
|
+
add_action('init', [$this, 'addCredexMenuInFluentCart']);
|
|
327
|
+
|
|
328
|
+
public function addCredexMenuInFluentCart()
|
|
329
|
+
{
|
|
330
|
+
if (!class_exists('\FluentCart\Api\FluentCartGeneralApi')) {
|
|
331
|
+
return;
|
|
332
|
+
}
|
|
333
|
+
|
|
334
|
+
\FluentCart\Api\FluentCartGeneralApi::getInstance()->addCustomerDashboardEndpoint('wallet', [
|
|
335
|
+
'title' => __('Wallet', 'credex'),
|
|
336
|
+
'render_callback' => function () {
|
|
337
|
+
echo do_shortcode('[credex_user_wallet]');
|
|
338
|
+
},
|
|
339
|
+
]);
|
|
340
|
+
}
|
|
341
|
+
```
|
|
342
|
+
|
|
343
|
+
This works, and it is what you'll find in the wild. Written today it would be four lines shorter — `fluent_cart/init` makes the guard redundant, and `fluent_cart_api()` makes the class reference unnecessary:
|
|
344
|
+
|
|
345
|
+
```
|
|
346
|
+
add_action('fluent_cart/init', [$this, 'addCredexMenuInFluentCart']);
|
|
347
|
+
|
|
348
|
+
public function addCredexMenuInFluentCart()
|
|
349
|
+
{
|
|
350
|
+
fluent_cart_api()->addCustomerDashboardEndpoint('credex-wallet', [
|
|
351
|
+
'title' => __('Wallet', 'credex'),
|
|
352
|
+
'render_callback' => function () {
|
|
353
|
+
echo do_shortcode('[credex_user_wallet]');
|
|
354
|
+
},
|
|
355
|
+
]);
|
|
356
|
+
}
|
|
357
|
+
```
|
|
358
|
+
|
|
359
|
+
Both integrations wrap an existing shortcode. That is the shape this API is built for: you already have a rendering path, and you want it to appear inside the portal chrome rather than on a standalone page.
|
|
360
|
+
|
|
361
|
+
## Where your tab lands
|
|
362
|
+
|
|
363
|
+
Each registration inserts its item **immediately before `profile`** in the menu array. Two add-ons registering on the same hook therefore end up in the order their filters ran, both above Profile — so relative order between add-ons is plugin load order, which is alphabetical by directory name and not something you should build on.
|
|
364
|
+
|
|
365
|
+
If placement genuinely matters, hook `fluent_cart/global_customer_menu_items` at a late priority and reorder the array yourself. Bear in mind that `licenses` is unset unless Pro is active with the license module on, and `subscriptions` is unset for customers who have none — so write reordering code that tolerates missing keys.
|
|
366
|
+
|
|
367
|
+
Active-tab highlighting needs nothing from you. When your endpoint matches, `maybeCustomEndpointContent()` filters `fluent_cart/customer_portal/active_tab` to your slug, and the inline script in `customer_app.php` adds `.active_customer_menu` to `.fct-customer-nav-item-`.
|
|
368
|
+
|
|
369
|
+
## Checklist
|
|
370
|
+
|
|
371
|
+
- [ ] Registered inside `add_action('fluent_cart/init', …)` — no `function_exists()` or `class_exists()` guard needed
|
|
372
|
+
- [ ] Called through `fluent_cart_api()`, not the class directly
|
|
373
|
+
- [ ] Namespaced slug — not `wallet`, `order`, `subscription`, or anything else a core route might claim
|
|
374
|
+
- [ ] Wrapped in `try/catch` if the slug isn't a literal
|
|
375
|
+
- [ ] Using `page_id` if the page is editable content, with the Account page as its **parent** and its slug matching the endpoint slug
|
|
376
|
+
- [ ] No child page parked under Account without a matching endpoint registered
|
|
377
|
+
- [ ] Every dynamic value in the callback escaped
|
|
378
|
+
- [ ] Customer resolved from the session, never from the request
|
|
379
|
+
- [ ] Assets enqueued conditionally — nothing from core's bundle is available
|
|
380
|
+
- [ ] Styled against `--fct-customer-dashboard-*`, not hard-coded colors
|
|
381
|
+
- [ ] Icon reduced to `svg`/`path`/`g` with `fill="currentColor"`
|
|
382
|
+
|
|
383
|
+
## When not to use this
|
|
384
|
+
|
|
385
|
+
`addCustomerDashboardEndpoint()` gives you a **whole page** reached by a **full page load**. Two cases where that's the wrong tool:
|
|
386
|
+
|
|
387
|
+
**You want a section inside an existing portal page** — a block on the profile page, extra rows under an order. Use `fluent_cart/customer_portal/profile_sections` and the dynamic per-slug section filter instead. Those render inside the SPA, so they need no navigation at all and cost no page load.
|
|
388
|
+
|
|
389
|
+
**You want a genuinely interactive app** — something with client-side state that a customer moves in and out of. A full page load on every entry and exit will be felt. Consider whether the work belongs on your own page template outside the portal, linked from a portal tab.
|
|
390
|
+
|
|
391
|
+
For everything else — a wallet, a support inbox, saved payment methods, a membership summary, a help page — one PHP call is the entire integration: `render_callback` when you have a renderer, `page_id` when a site owner should own the content. The routing was already there. All this API does is tell it your name.
|
|
392
|
+
|
|
393
|
+
---
|
|
394
|
+
|
|
395
|
+
*Source references: `api/FluentCartGeneralApi.php`, `app/Hooks/Handlers/ShortCodes/CustomerProfileHandler.php`, `app/Modules/Templating/AssetLoader.php`, `resources/public/customer-profile/Start.js`. Filter documentation: [customer & subscription filters](/hooks/filters/customers-and-subscriptions.md).*
|
|
@@ -0,0 +1,249 @@
|
|
|
1
|
+
# FluentCart Developer Guide
|
|
2
|
+
|
|
3
|
+
FluentCart Core Complete Guide
|
|
4
|
+
|
|
5
|
+
Welcome to the complete developer guide for **FluentCart** - the self-hosted e-commerce plugin for WordPress. This comprehensive guide will take you from understanding the basics to building sophisticated integrations and custom functionality.
|
|
6
|
+
|
|
7
|
+
## What is FluentCart?
|
|
8
|
+
|
|
9
|
+
FluentCart is a **Self-Hosted E-commerce Plugin** for WordPress that helps businesses manage their online stores, process payments, handle orders, and manage customers. Unlike cloud-based solutions, FluentCart runs entirely on your WordPress site, ensuring data privacy, unlimited products, and no monthly fees.
|
|
10
|
+
|
|
11
|
+
## Why Extend FluentCart?
|
|
12
|
+
|
|
13
|
+
FluentCart is designed to be highly extensible, allowing developers to customize and extend its functionality far beyond what the plugin offers out-of-the-box. Whether you're a business owner looking to customize your store or a developer hired to create specific integrations, FluentCart provides the tools you need.
|
|
14
|
+
|
|
15
|
+
### 🔧 **Built for Customization**
|
|
16
|
+
|
|
17
|
+
- **Extensive hook system** - over 750 action and filter hooks; see the [Action](/hooks/actions.md) and [Filter](/hooks/filters.md) references
|
|
18
|
+
- **Modular architecture** - Clean separation allows safe modifications and additions
|
|
19
|
+
- **RESTful API** - Complete programmatic access to all e-commerce data and functions
|
|
20
|
+
- **WordPress-native** - Follows WordPress coding standards and best practices
|
|
21
|
+
|
|
22
|
+
### 🏗️ **Flexible Extension Points**
|
|
23
|
+
|
|
24
|
+
- **Custom payment gateways** - Integrate with any payment processor
|
|
25
|
+
- **Third-party integrations** - Connect with external services and platforms
|
|
26
|
+
- **Custom modules** - Add specialized functionality and features
|
|
27
|
+
- **API extensions** - Build custom endpoints for mobile apps or external systems
|
|
28
|
+
|
|
29
|
+
### 💼 **Business Benefits**
|
|
30
|
+
|
|
31
|
+
- **No vendor lock-in** - Your customizations stay with you, not dependent on external services
|
|
32
|
+
- **Unlimited scalability** - Extend functionality as your business needs grow
|
|
33
|
+
- **Cost-effective** - One-time development instead of ongoing SaaS fees
|
|
34
|
+
- **Complete control** - Modify any aspect to match your specific business processes
|
|
35
|
+
|
|
36
|
+
## FluentCart Versions
|
|
37
|
+
|
|
38
|
+
### FluentCart Core (Free)
|
|
39
|
+
|
|
40
|
+
The free version includes powerful core functionalities:
|
|
41
|
+
|
|
42
|
+
- ✅ **Product Management** - Unlimited products and variations
|
|
43
|
+
- ✅ **Order Processing** - Complete order management system
|
|
44
|
+
- ✅ **Customer Management** - Customer accounts and profiles
|
|
45
|
+
- ✅ **Payment Processing** - Multiple payment gateway support
|
|
46
|
+
- ✅ **Shipping Management** - Flexible shipping options
|
|
47
|
+
- ✅ **Coupon System** - Discount and promotional codes
|
|
48
|
+
- ✅ **Subscriptions** - Recurring billing, including store-managed renewals
|
|
49
|
+
- ✅ **Tax** - Tax classes, rates and EU VAT handling
|
|
50
|
+
- ✅ **Reporting** - Sales, product, customer and subscription reports
|
|
51
|
+
- ✅ **Product Reviews** - Review collection and display
|
|
52
|
+
- ✅ **Multi-Currency engine** - Currency settings and rate storage
|
|
53
|
+
- ✅ **MCP** - Model Context Protocol abilities for AI tooling
|
|
54
|
+
- ✅ **Developer API** - Full access to hooks and REST API
|
|
55
|
+
|
|
56
|
+
### FluentCart Pro (Premium)
|
|
57
|
+
|
|
58
|
+
The premium version adds advanced e-commerce features:
|
|
59
|
+
|
|
60
|
+
- 🚀 **Licensing System** - Software license management
|
|
61
|
+
- 🚀 **Order Bumps** - Upselling and promotional offers
|
|
62
|
+
- 🚀 **Roles & Permissions** - Advanced user role management
|
|
63
|
+
- 🚀 **Dynamic Pricing** - Rule-based pricing and discounts
|
|
64
|
+
- 🚀 **Inline Checkout** - On-page checkout
|
|
65
|
+
- 🚀 **Advanced Inventory** - Stock adjustments and inventory history
|
|
66
|
+
- 🚀 **Saved Payment Methods** - Stored cards for repeat purchases
|
|
67
|
+
- 🚀 **Data & Accounting Export** - Order, customer, licence and OSS exports
|
|
68
|
+
- 🚀 **Advanced Filters** - Extended filtering across admin lists
|
|
69
|
+
- 🚀 **Multi-Currency storefront** - Customer-facing currency switching on top of the free engine
|
|
70
|
+
- 🚀 **Paddle, Mollie and Authorize.Net** - Additional payment gateways
|
|
71
|
+
- 🚀 **Advanced Integrations** - Deep third-party integrations
|
|
72
|
+
|
|
73
|
+
Subscriptions, Tax, Reporting, Reviews and MCP are **free** modules. Reviews, MCP and Multi-Currency ship a free engine that Pro extends, rather than being Pro-only.
|
|
74
|
+
|
|
75
|
+
## Core Development Concepts
|
|
76
|
+
|
|
77
|
+
### 📊 **Data Architecture**
|
|
78
|
+
|
|
79
|
+
FluentCart follows WordPress conventions with a clean, normalized database structure:
|
|
80
|
+
|
|
81
|
+
**Core Tables & Relationships:**
|
|
82
|
+
|
|
83
|
+
- **🛒 Orders** (`fct_orders`) - Central hub for all order data Stores order information, status, customer details
|
|
84
|
+
- Links to all order items, transactions, and metadata
|
|
85
|
+
|
|
86
|
+
**👥 Customers** (`fct_customers`) - Customer management
|
|
87
|
+
|
|
88
|
+
- Customer profiles, addresses, order history
|
|
89
|
+
- Integration with WordPress users
|
|
90
|
+
|
|
91
|
+
**📦 Products** (WordPress `posts` table) - Product catalog
|
|
92
|
+
|
|
93
|
+
- Product information stored as WordPress custom post type
|
|
94
|
+
- Additional details in `fct_product_details` and `fct_product_variations`
|
|
95
|
+
|
|
96
|
+
**💳 Transactions** (`fct_order_transactions`) - Payment processing
|
|
97
|
+
|
|
98
|
+
- Payment records, refunds, transaction history
|
|
99
|
+
- Integration with payment gateways
|
|
100
|
+
|
|
101
|
+
**📋 Subscriptions** (`fct_subscriptions`) - Recurring billing
|
|
102
|
+
|
|
103
|
+
- Subscription management and renewals
|
|
104
|
+
- Automated billing workflows
|
|
105
|
+
|
|
106
|
+
### 🔄 **E-commerce Workflow**
|
|
107
|
+
|
|
108
|
+
The three-component e-commerce system:
|
|
109
|
+
|
|
110
|
+
1. **Products** - Catalog management and inventory tracking
|
|
111
|
+
2. **Orders** - Order processing and fulfillment
|
|
112
|
+
3. **Payments** - Payment processing and transaction management
|
|
113
|
+
|
|
114
|
+
### 🔌 **Extension Points**
|
|
115
|
+
|
|
116
|
+
Multiple ways to extend FluentCart:
|
|
117
|
+
|
|
118
|
+
- **WordPress Hooks** - 315+ actions and filters for custom functionality
|
|
119
|
+
- **REST API** - Complete programmatic access to all features
|
|
120
|
+
- **Module System** - Add new payment gateways, shipping methods, and features
|
|
121
|
+
- **Custom Fields** - Extend products, orders, and customers with custom data
|
|
122
|
+
- **Template System** - Customize frontend templates and layouts
|
|
123
|
+
|
|
124
|
+
## Directory Structure
|
|
125
|
+
|
|
126
|
+
Understanding FluentCart's organized codebase:
|
|
127
|
+
|
|
128
|
+
```
|
|
129
|
+
fluent-cart/
|
|
130
|
+
├── app/ # Core application logic
|
|
131
|
+
│ ├── Hooks/ # WordPress action/filter handlers
|
|
132
|
+
│ │ ├── Handlers/ # Hook handlers
|
|
133
|
+
│ │ ├── actions.php # Action hooks
|
|
134
|
+
│ │ └── filters.php # Filter hooks
|
|
135
|
+
│ ├── Http/ # Request handling and routing
|
|
136
|
+
│ │ ├── Controllers/ # API and admin controllers
|
|
137
|
+
│ │ ├── Policies/ # Route permission policies
|
|
138
|
+
│ │ ├── Requests/ # FormRequest validation / sanitisation
|
|
139
|
+
│ │ ├── Rules/ # Custom validation rules
|
|
140
|
+
│ │ └── Routes/ # API route definitions
|
|
141
|
+
│ ├── Models/ # Database models (37 models + Model and DynamicModel bases)
|
|
142
|
+
│ │ ├── Order.php # Order model
|
|
143
|
+
│ │ ├── Customer.php # Customer model
|
|
144
|
+
│ │ ├── Product.php # Product model
|
|
145
|
+
│ │ └── ... # Additional models
|
|
146
|
+
│ ├── Services/ # Business logic and services
|
|
147
|
+
│ │ ├── Payments/ # Payment processing services
|
|
148
|
+
│ │ ├── Renderer/ # Storefront rendering
|
|
149
|
+
│ │ └── Tax/ # Tax calculation services
|
|
150
|
+
│ ├── Helpers/ # Helper.php and other helper utilities
|
|
151
|
+
│ ├── Views/ # PHP template files
|
|
152
|
+
│ ├── Events/ # Event system
|
|
153
|
+
│ ├── Listeners/ # Event listeners
|
|
154
|
+
│ └── Modules/ # Module system
|
|
155
|
+
│
|
|
156
|
+
├── api/ # REST API endpoints and utilities
|
|
157
|
+
│ ├── Orders.php # Order management API
|
|
158
|
+
│ ├── Customers.php # Customer management API
|
|
159
|
+
│ ├── StoreSettings.php # Store settings API
|
|
160
|
+
│ ├── Checkout/ # Checkout API
|
|
161
|
+
│ ├── Resource/ # API resource classes
|
|
162
|
+
│ └── ... # Additional API endpoints
|
|
163
|
+
│
|
|
164
|
+
├── resources/ # Frontend assets and templates
|
|
165
|
+
│ ├── admin/ # Admin interface (Vue.js) + Gutenberg blocks (React)
|
|
166
|
+
│ │ ├── Pages/ # Vue page components
|
|
167
|
+
│ │ ├── Modules/ # Feature modules
|
|
168
|
+
│ │ ├── shared/ # Shared module API and utilities
|
|
169
|
+
│ │ └── BlockEditor/# React Gutenberg blocks
|
|
170
|
+
│ ├── public/ # Public-facing components
|
|
171
|
+
│ │ ├── cart/ # Cart functionality
|
|
172
|
+
│ │ ├── checkout/ # Checkout process
|
|
173
|
+
│ │ └── customer-profile/ # Customer interface
|
|
174
|
+
│ ├── styles/ # SCSS stylesheets
|
|
175
|
+
│ └── images/ # Image resources
|
|
176
|
+
│
|
|
177
|
+
├── boot/ # Plugin initialization
|
|
178
|
+
├── config/ # Configuration files
|
|
179
|
+
├── database/ # Database migrations and schema
|
|
180
|
+
│ ├── Migrations/ # Database migration files (39 files)
|
|
181
|
+
│ ├── Seeder/ # Database seeders
|
|
182
|
+
│ └── DBMigrator.php # Migration handler
|
|
183
|
+
│
|
|
184
|
+
├── dev/ # Development tools and testing
|
|
185
|
+
│ ├── cli/ # CLI commands
|
|
186
|
+
│ ├── wp-browser/ # wp-browser test suite
|
|
187
|
+
│ ├── factories/ # Model factories
|
|
188
|
+
│ └── seeds/ # Seed data
|
|
189
|
+
│
|
|
190
|
+
└── fluent-cart.php # Plugin entry point
|
|
191
|
+
```
|
|
192
|
+
|
|
193
|
+
## Development Environment Setup
|
|
194
|
+
|
|
195
|
+
### Prerequisites
|
|
196
|
+
|
|
197
|
+
- **WordPress 6.7+** - the plugin header requires it; tested up to 7.1
|
|
198
|
+
- **PHP 7.4+** - Recent PHP version with required extensions
|
|
199
|
+
- **MySQL or MariaDB with InnoDB** - FluentCart's tables are InnoDB. The plugin does not check a MySQL version, so no specific minimum is enforced
|
|
200
|
+
- **Basic WordPress Development** - Understanding of hooks, plugins, and themes
|
|
201
|
+
|
|
202
|
+
### Development Tools
|
|
203
|
+
|
|
204
|
+
- **Code Editor** - VS Code, PhpStorm, or your preferred editor
|
|
205
|
+
- **Local Environment** - Laravel Herd, XAMPP, WAMP, or Docker
|
|
206
|
+
- **Version Control** - Git for tracking changes (optional but recommended)
|
|
207
|
+
- **API Testing** - Postman or Insomnia for REST API development
|
|
208
|
+
|
|
209
|
+
### Getting Started Checklist
|
|
210
|
+
|
|
211
|
+
1. **📖 Read the Fundamentals**[ ] Understand the database schema
|
|
212
|
+
2. [ ] Review core models
|
|
213
|
+
3. [ ] Explore global functions
|
|
214
|
+
4. **🔍 Explore the Hooks**[ ] Browse action hooks
|
|
215
|
+
5. [ ] Study filter hooks
|
|
216
|
+
6. [ ] Try event system
|
|
217
|
+
7. **🏗️ Build Your First Extension**[ ] Create a custom payment gateway
|
|
218
|
+
8. [ ] Build a custom shipping method
|
|
219
|
+
9. [ ] Add a custom module
|
|
220
|
+
10. **🌐 API Integration**[ ] Set up REST API access
|
|
221
|
+
11. [ ] Test order management
|
|
222
|
+
12. [ ] Explore webhook integration
|
|
223
|
+
|
|
224
|
+
## Quick Start Guide
|
|
225
|
+
|
|
226
|
+
### 1. Database & Models
|
|
227
|
+
|
|
228
|
+
Start by understanding FluentCart's data structure:
|
|
229
|
+
|
|
230
|
+
- [Database Schema](/database/schema.md) - Complete table structure
|
|
231
|
+
- [Core Models](/database/models.md) - Order, Customer, Product models
|
|
232
|
+
- [Model Relationships](/database/models/relationships.md) - How data connects
|
|
233
|
+
|
|
234
|
+
### 2. Developer Hooks
|
|
235
|
+
|
|
236
|
+
Learn how to extend FluentCart functionality:
|
|
237
|
+
|
|
238
|
+
- [Action Hooks](/hooks/actions.md) - Trigger custom code on events
|
|
239
|
+
- [Filter Hooks](/hooks/filters.md) - Modify data and behavior
|
|
240
|
+
|
|
241
|
+
## Community & Support
|
|
242
|
+
|
|
243
|
+
### 📚 **Learning Resources**
|
|
244
|
+
|
|
245
|
+
- **[Official Documentation](https://docs.fluentcart.com)** - Complete user and developer reference
|
|
246
|
+
|
|
247
|
+
### 💬 **Community**
|
|
248
|
+
|
|
249
|
+
- **[Official Support](https://fluentcart.com/account)** - Technical support
|