fluentcart-developer 3.0.0 → 3.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE.md +26 -26
- package/README.md +59 -59
- package/dist/cards/fluentcart/templates-native.js +1087 -1087
- package/dist/cards/fluentcart/tools.js +2309 -2309
- package/dist/server.d.ts.map +1 -1
- package/dist/server.js +37 -1
- package/dist/server.js.map +1 -1
- package/dist/skills/fluentcart-developer/SKILL.md +108 -108
- package/dist/skills/fluentcart-developer/examples/README.md +30 -30
- package/dist/skills/fluentcart-developer/examples/fluentcart-starter-child-theme/fluent-cart/checkout.php +32 -32
- package/dist/skills/fluentcart-developer/examples/fluentcart-starter-child-theme/functions.php +40 -40
- package/dist/skills/fluentcart-developer/examples/sample-custom-addon/fluentcart-custom-addon.php +113 -113
- package/dist/skills/fluentcart-developer/examples/sample-custom-payment-gateway/fluentcart-custom-gateway-example.php +148 -148
- package/dist/skills/fluentcart-developer/examples/sample-fee-surcharge-plugin/fluentcart-fee-surcharge.php +38 -38
- package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/README.md +22 -22
- package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/sample-plugin-with-licensing-sdk.php +79 -79
- package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/updater/FluentLicensing.php +303 -303
- package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/updater/LicenseSettings.php +566 -566
- package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/updater/PluginUpdater.php +304 -304
- package/dist/skills/fluentcart-developer/examples/sample-shipping-carrier/fluentcart-custom-shipping-carrier.php +61 -61
- package/dist/skills/fluentcart-developer/references/api/authentication.md +452 -452
- package/dist/skills/fluentcart-developer/references/api/coupons.md +786 -786
- package/dist/skills/fluentcart-developer/references/api/customers.md +889 -889
- package/dist/skills/fluentcart-developer/references/api/files.md +609 -609
- package/dist/skills/fluentcart-developer/references/api/index.md +432 -432
- package/dist/skills/fluentcart-developer/references/api/licensing.md +633 -633
- package/dist/skills/fluentcart-developer/references/api/order-bump.md +384 -384
- package/dist/skills/fluentcart-developer/references/api/orders.md +814 -814
- package/dist/skills/fluentcart-developer/references/api/products.md +866 -866
- package/dist/skills/fluentcart-developer/references/api/roles-permissions.md +536 -536
- package/dist/skills/fluentcart-developer/references/api/subscriptions.md +827 -827
- package/dist/skills/fluentcart-developer/references/database/index.md +44 -44
- package/dist/skills/fluentcart-developer/references/database/models/activity.md +178 -178
- package/dist/skills/fluentcart-developer/references/database/models/applied-coupon.md +291 -291
- package/dist/skills/fluentcart-developer/references/database/models/attribute-group.md +239 -239
- package/dist/skills/fluentcart-developer/references/database/models/attribute-relation.md +181 -181
- package/dist/skills/fluentcart-developer/references/database/models/attribute-term.md +219 -219
- package/dist/skills/fluentcart-developer/references/database/models/cart.md +645 -645
- package/dist/skills/fluentcart-developer/references/database/models/coupon.md +427 -427
- package/dist/skills/fluentcart-developer/references/database/models/customer-addresses.md +348 -348
- package/dist/skills/fluentcart-developer/references/database/models/customer-meta.md +156 -156
- package/dist/skills/fluentcart-developer/references/database/models/customer.md +584 -584
- package/dist/skills/fluentcart-developer/references/database/models/dynamic-model.md +163 -163
- package/dist/skills/fluentcart-developer/references/database/models/label-relationship.md +155 -155
- package/dist/skills/fluentcart-developer/references/database/models/label.md +153 -153
- package/dist/skills/fluentcart-developer/references/database/models/license-activation.md +182 -182
- package/dist/skills/fluentcart-developer/references/database/models/license-meta.md +163 -163
- package/dist/skills/fluentcart-developer/references/database/models/license-site.md +208 -208
- package/dist/skills/fluentcart-developer/references/database/models/license.md +640 -640
- package/dist/skills/fluentcart-developer/references/database/models/meta.md +233 -233
- package/dist/skills/fluentcart-developer/references/database/models/order-address.md +391 -391
- package/dist/skills/fluentcart-developer/references/database/models/order-download-permission.md +144 -144
- package/dist/skills/fluentcart-developer/references/database/models/order-item.md +383 -383
- package/dist/skills/fluentcart-developer/references/database/models/order-meta.md +303 -303
- package/dist/skills/fluentcart-developer/references/database/models/order-operation.md +158 -158
- package/dist/skills/fluentcart-developer/references/database/models/order-promotion-stat.md +175 -175
- package/dist/skills/fluentcart-developer/references/database/models/order-promotion.md +250 -250
- package/dist/skills/fluentcart-developer/references/database/models/order-tax-rate.md +172 -172
- package/dist/skills/fluentcart-developer/references/database/models/order-transaction.md +440 -440
- package/dist/skills/fluentcart-developer/references/database/models/order.md +727 -727
- package/dist/skills/fluentcart-developer/references/database/models/product-detail.md +397 -397
- package/dist/skills/fluentcart-developer/references/database/models/product-download.md +258 -258
- package/dist/skills/fluentcart-developer/references/database/models/product-meta.md +153 -153
- package/dist/skills/fluentcart-developer/references/database/models/product-variation.md +556 -556
- package/dist/skills/fluentcart-developer/references/database/models/product.md +580 -580
- package/dist/skills/fluentcart-developer/references/database/models/relationships.md +427 -427
- package/dist/skills/fluentcart-developer/references/database/models/scheduled-action.md +175 -175
- package/dist/skills/fluentcart-developer/references/database/models/shipping-class.md +148 -148
- package/dist/skills/fluentcart-developer/references/database/models/shipping-method.md +280 -280
- package/dist/skills/fluentcart-developer/references/database/models/shipping-zone.md +205 -205
- package/dist/skills/fluentcart-developer/references/database/models/subscription-meta.md +173 -173
- package/dist/skills/fluentcart-developer/references/database/models/subscription.md +528 -528
- package/dist/skills/fluentcart-developer/references/database/models/tax-class.md +195 -195
- package/dist/skills/fluentcart-developer/references/database/models/tax-rate.md +225 -225
- package/dist/skills/fluentcart-developer/references/database/models/user-meta.md +166 -166
- package/dist/skills/fluentcart-developer/references/database/models/user.md +220 -220
- package/dist/skills/fluentcart-developer/references/database/models.md +404 -404
- package/dist/skills/fluentcart-developer/references/database/query-builder.md +860 -860
- package/dist/skills/fluentcart-developer/references/database/readme.md +276 -276
- package/dist/skills/fluentcart-developer/references/database/schema.md +1002 -1002
- package/dist/skills/fluentcart-developer/references/engineering/adding-custom-pages-to-the-customer-dashboard.md +395 -395
- package/dist/skills/fluentcart-developer/references/engineering/index.md +4 -4
- package/dist/skills/fluentcart-developer/references/engineering.md +4 -4
- package/dist/skills/fluentcart-developer/references/getting-started.md +249 -249
- package/dist/skills/fluentcart-developer/references/guides/frontend.md +519 -519
- package/dist/skills/fluentcart-developer/references/guides/index.md +107 -107
- package/dist/skills/fluentcart-developer/references/guides/integrations.md +600 -600
- package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/index.md +237 -237
- package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/labels-and-tracking.md +481 -481
- package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/live-rates.md +269 -269
- package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/reference.md +223 -223
- package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/settings.md +370 -370
- package/dist/skills/fluentcart-developer/references/guides/shipping-carrier.md +237 -237
- package/dist/skills/fluentcart-developer/references/guides/subscriptions.md +217 -217
- package/dist/skills/fluentcart-developer/references/hooks/actions/admin-and-templates.md +1079 -1079
- package/dist/skills/fluentcart-developer/references/hooks/actions/cart-and-checkout.md +1795 -1795
- package/dist/skills/fluentcart-developer/references/hooks/actions/customers-and-users.md +327 -327
- package/dist/skills/fluentcart-developer/references/hooks/actions/licenses.md +829 -829
- package/dist/skills/fluentcart-developer/references/hooks/actions/modules.md +81 -81
- package/dist/skills/fluentcart-developer/references/hooks/actions/orders.md +757 -757
- package/dist/skills/fluentcart-developer/references/hooks/actions/payments-and-integrations.md +1163 -1163
- package/dist/skills/fluentcart-developer/references/hooks/actions/pro-modules.md +219 -219
- package/dist/skills/fluentcart-developer/references/hooks/actions/products-and-coupons.md +1019 -1019
- package/dist/skills/fluentcart-developer/references/hooks/actions/subscriptions.md +1290 -1290
- package/dist/skills/fluentcart-developer/references/hooks/actions.md +16 -16
- package/dist/skills/fluentcart-developer/references/hooks/deprecated.md +60 -60
- package/dist/skills/fluentcart-developer/references/hooks/filters/cart-and-checkout.md +2032 -2032
- package/dist/skills/fluentcart-developer/references/hooks/filters/customers-and-subscriptions.md +1746 -1746
- package/dist/skills/fluentcart-developer/references/hooks/filters/integrations-and-advanced.md +2439 -2439
- package/dist/skills/fluentcart-developer/references/hooks/filters/modules.md +464 -464
- package/dist/skills/fluentcart-developer/references/hooks/filters/orders-and-payments.md +2658 -2658
- package/dist/skills/fluentcart-developer/references/hooks/filters/pro-modules.md +502 -502
- package/dist/skills/fluentcart-developer/references/hooks/filters/products-and-pricing.md +1785 -1785
- package/dist/skills/fluentcart-developer/references/hooks/filters/settings-and-configuration.md +2966 -2966
- package/dist/skills/fluentcart-developer/references/hooks/filters.md +14 -14
- package/dist/skills/fluentcart-developer/references/hooks/index.md +35 -35
- package/dist/skills/fluentcart-developer/references/index.md +625 -625
- package/dist/skills/fluentcart-developer/references/modules/fee-system.md +427 -427
- package/dist/skills/fluentcart-developer/references/modules/ghost-product-selling.md +440 -440
- package/dist/skills/fluentcart-developer/references/modules/index.md +484 -484
- package/dist/skills/fluentcart-developer/references/modules/licensing.md +342 -342
- package/dist/skills/fluentcart-developer/references/modules/order-bump.md +433 -433
- package/dist/skills/fluentcart-developer/references/modules/payment-methods.md +129 -129
- package/dist/skills/fluentcart-developer/references/modules/refunds.md +170 -170
- package/dist/skills/fluentcart-developer/references/modules/shipping.md +846 -846
- package/dist/skills/fluentcart-developer/references/modules/storage.md +986 -986
- package/dist/skills/fluentcart-developer/references/modules/subscription-vendor-ids.md +186 -186
- package/dist/skills/fluentcart-developer/references/modules/subscriptions.md +678 -678
- package/dist/skills/fluentcart-developer/references/payment-methods-integration/index.md +164 -164
- package/dist/skills/fluentcart-developer/references/payment-methods-integration/paddle-example.md +1648 -1648
- package/dist/skills/fluentcart-developer/references/payment-methods-integration/payment/setting/fields.md +353 -353
- package/dist/skills/fluentcart-developer/references/payment-methods-integration/quick-implementation.md +1079 -1079
- package/dist/skills/fluentcart-developer/references/payment-methods-integration.md +164 -164
- package/dist/skills/fluentcart-developer/references/restapi/checkout.md +573 -573
- package/dist/skills/fluentcart-developer/references/restapi/coupons.md +958 -958
- package/dist/skills/fluentcart-developer/references/restapi/customer-profile.md +1423 -1423
- package/dist/skills/fluentcart-developer/references/restapi/customers.md +1103 -1103
- package/dist/skills/fluentcart-developer/references/restapi/dashboard.md +1083 -1083
- package/dist/skills/fluentcart-developer/references/restapi/data-export.md +132 -132
- package/dist/skills/fluentcart-developer/references/restapi/email-notifications.md +846 -846
- package/dist/skills/fluentcart-developer/references/restapi/files.md +313 -313
- package/dist/skills/fluentcart-developer/references/restapi/index.md +127 -127
- package/dist/skills/fluentcart-developer/references/restapi/integrations.md +1000 -1000
- package/dist/skills/fluentcart-developer/references/restapi/inventory.md +192 -192
- package/dist/skills/fluentcart-developer/references/restapi/labels-and-attributes.md +797 -797
- package/dist/skills/fluentcart-developer/references/restapi/licensing.md +1733 -1733
- package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-available-shipping-methods.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-checkout-summary.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-country-info.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-order-info.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-shipping-methods-list-view.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/login.md +66 -66
- package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/place-order.md +179 -179
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/apply-coupon.md +83 -83
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/cancel-coupon.md +87 -87
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/check-product-eligibility.md +59 -59
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/create-coupon.md +230 -230
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/delete-coupon.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/get-coupon-settings.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/get-coupon.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/list-coupon-codes.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/list-coupons.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/re-apply-coupons.md +75 -75
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/store-coupon-settings.md +40 -40
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/update-coupon.md +133 -133
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/create-address-checkout.md +138 -138
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/create-profile-address.md +119 -119
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/dashboard-overview.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/delete-profile-address.md +46 -46
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-order-details.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-portal-sections.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-profile-details.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-transaction-billing-address.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-upgrade-paths.md +31 -31
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/list-downloads.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/list-orders.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/make-profile-address-primary.md +55 -55
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/pause-subscription.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/resume-subscription.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/save-transaction-billing-address.md +92 -92
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/select-address-for-checkout.md +32 -32
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/update-profile-address.md +115 -115
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/update-profile-details.md +69 -69
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/attach-user.md +50 -50
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/bulk-actions.md +65 -65
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/create-address.md +135 -135
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/create-customer.md +108 -108
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/delete-address.md +62 -62
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/detach-user.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/find-customer-order.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-attachable-users.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer-addresses.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer-orders.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer-stats.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer.md +32 -32
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/list-customers.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/recalculate-ltv.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/set-primary-address.md +72 -72
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/update-additional-info.md +55 -55
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/update-address.md +144 -144
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/update-customer.md +123 -123
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/attach-note-to-order.md +49 -49
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/create-all-pages.md +21 -21
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/create-single-page.md +55 -55
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/delete-activity.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-country-info.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-dashboard-stats.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-filter-options.md +31 -31
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-onboarding-data.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-onboarding-settings.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-print-templates.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-search-options.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-widgets.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/initialize-app.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/list-activities.md +33 -33
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/list-attachments.md +21 -21
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/list-countries.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/mark-activity-read.md +53 -53
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/run-data-backfills.md +21 -21
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/save-onboarding-settings.md +54 -54
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/save-onboarding-tax-settings.md +73 -73
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/save-print-templates.md +64 -64
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/upload-attachment.md +42 -42
- package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-customers-batch.md +129 -129
- package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-licenses-batch.md +133 -133
- package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-orders-batch.md +129 -129
- package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-subscriptions-batch.md +129 -129
- package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-customers-export-schema.md +21 -21
- package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-licenses-export-schema.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-orders-export-schema.md +21 -21
- package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-subscriptions-export-schema.md +21 -21
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/enable-notification.md +57 -57
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-digest-settings.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-notification.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-reminders.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-settings.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-shortcodes.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/list-notifications.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/preview-default-template.md +66 -66
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/preview-notification.md +50 -50
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/save-digest-settings.md +101 -101
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/save-reminders.md +162 -162
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/save-settings.md +99 -99
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/send-digest-test.md +47 -47
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/send-manual-reminder.md +51 -51
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/update-notification.md +93 -93
- package/dist/skills/fluentcart-developer/references/restapi/operations/files/delete-file.md +31 -31
- package/dist/skills/fluentcart-developer/references/restapi/operations/files/get-bucket-list.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/files/list-files.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/files/upload-editor-file.md +32 -32
- package/dist/skills/fluentcart-developer/references/restapi/operations/files/upload-file.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/chained-data-request.md +46 -46
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/change-feed-status.md +51 -51
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/delete-feed.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-dynamic-options.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-feed-lists.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-feed-settings.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-global-feeds.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-global-settings.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/install-addon-plugin.md +49 -49
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/list-addons.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/save-feed-settings.md +52 -52
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/set-global-settings.md +50 -50
- package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/bulk-update-stock.md +94 -94
- package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/export-inventory.md +81 -81
- package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/get-adjustment-history.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/get-inventory-stats.md +21 -21
- package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/list-inventory.md +33 -33
- package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/update-stock.md +75 -75
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/create-attribute-group.md +31 -31
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/create-label.md +31 -31
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/create-terms.md +90 -90
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/delete-attribute-group.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/delete-attribute-term.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/get-attribute-group.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/get-attribute-library.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/list-attribute-groups.md +32 -32
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/list-attribute-terms.md +33 -33
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/list-labels.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/reorder-groups.md +51 -51
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/reorder-terms.md +56 -56
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/update-attribute-group.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/update-attribute-term.md +39 -39
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/update-label-selections.md +32 -32
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/activate-plugin-license.md +41 -41
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/activate-site-admin.md +60 -60
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/deactivate-plugin-license.md +18 -18
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/deactivate-site-admin.md +67 -67
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/deactivate-site-customer.md +47 -47
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/delete-license.md +24 -24
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/extend-license-validity.md +47 -47
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-customer-license-details.md +25 -25
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-customer-licenses-admin.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-license-activations.md +25 -25
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-license-details.md +25 -25
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-license-site.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-plugin-license-status.md +18 -18
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-product-license-settings.md +24 -24
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/list-customer-licenses.md +25 -25
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/list-license-sites.md +33 -33
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/list-licenses.md +38 -38
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-activate-license.md +54 -54
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-check-license.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-deactivate-license.md +46 -46
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-download-license-package.md +23 -23
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-get-license-version.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/regenerate-license-key.md +24 -24
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/save-product-license-settings.md +193 -193
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/update-license-activation-limit.md +53 -53
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/update-license-status.md +52 -52
- package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/create-order-bump.md +47 -47
- package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/delete-order-bump.md +25 -25
- package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/get-order-bump.md +25 -25
- package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/list-order-bumps.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/update-order-bump.md +141 -141
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/accept-dispute.md +47 -47
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/bulk-actions.md +72 -72
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/calculate-shipping.md +67 -67
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/calculate-tax.md +98 -98
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/change-customer.md +50 -50
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/charge-now.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-and-change-customer.md +92 -92
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-custom-order-item.md +68 -68
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-order.md +351 -351
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-renewal-now.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/delete-order.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/generate-missing-licenses.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-order-transactions.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-order.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-renewal.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-shipping-methods.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-single-transaction.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/list-order-currencies.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/list-orders.md +42 -42
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/list-renewals.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/mark-as-paid.md +61 -61
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/price-order.md +135 -135
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/refund-order.md +72 -72
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/resend-renewal-invoice.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/skip-renewal.md +48 -48
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/sync-order-statuses.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/sync-pending-transaction.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-order-address-id.md +60 -60
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-order-address.md +98 -98
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-order.md +172 -172
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-statuses.md +77 -77
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-subscription-details.md +84 -84
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-transaction-status.md +51 -51
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/void-renewal.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/create-pdf-template.md +42 -42
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/delete-pdf-template.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/download-pdf-preview.md +44 -44
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-factory-default-templates.md +19 -19
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-pdf-status.md +21 -21
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-pdf-template.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-saved-templates.md +21 -21
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-seller-details.md +19 -19
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/list-pdf-templates.md +19 -19
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/save-pdf-template.md +53 -53
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/save-seller-details.md +97 -97
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/add-product-terms.md +64 -64
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-edit-fetch.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-insert-products.md +62 -62
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-update-products.md +59 -59
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-update-variants.md +83 -83
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/change-integration-status.md +64 -64
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/create-dummy-products.md +45 -45
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/create-product.md +81 -81
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/create-variation.md +181 -181
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-downloadable-file.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-product-integration.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-product.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-taxonomy-term.md +55 -55
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-upgrade-path.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-variation.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/do-bulk-action.md +56 -56
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/duplicate-product.md +56 -56
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-products-by-ids.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-taxonomy-terms.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-terms-by-parent.md +60 -60
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-variations-by-ids.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/find-subscription-variants.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-bundle-info.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-downloadable-url.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-max-excerpt-word-count.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-pricing-widgets.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product-integration-feeds.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product-integration-settings.md +31 -31
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product-pricing.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-related-products.md +31 -31
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-upgrade-settings.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-variation-upgrade-paths.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/group-bulk-update-variants.md +103 -103
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/list-all-variants.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/list-product-variations.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/list-products.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/remove-shipping-class.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/remove-tax-class.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/save-bundle-info.md +56 -56
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/save-product-integration.md +62 -62
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/save-upgrade-path.md +78 -78
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/search-product-variant-options.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/search-products-by-name.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/search-variants-by-name.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/set-variation-media.md +74 -74
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/suggest-sku.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/sync-downloadable-files.md +134 -134
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/sync-taxonomy-terms.md +61 -61
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/toggle-product-tax-exemption.md +56 -56
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-downloadable-file.md +98 -98
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-inventory.md +56 -56
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-long-desc-editor-mode.md +49 -49
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-manage-stock.md +53 -53
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-product-detail.md +58 -58
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-product-pricing.md +225 -225
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-shipping-class.md +49 -49
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-tax-class.md +49 -49
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-upgrade-path.md +78 -78
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variant-option.md +79 -79
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variant-tax-exemption.md +56 -56
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variation-pricing-table.md +49 -49
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variation.md +105 -105
- package/dist/skills/fluentcart-developer/references/restapi/operations/public-shop/get-product-views.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/public-shop/list-products.md +42 -42
- package/dist/skills/fluentcart-developer/references/restapi/operations/public-shop/search-products.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/channel-rules.md +24 -24
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/country-heat-map.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/coupon-overview.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/coupons.md +36 -36
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-insights.md +31 -31
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-overview.md +36 -36
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-repeat.md +35 -35
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-segment-customers.md +36 -36
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-segments.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-value.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/dashboard-stats.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/failed-orders.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-new-vs-returning-customer.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-report-by-day-and-hour.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-report-meta.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-top-sold-products.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/future-renewals.md +31 -31
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/generate-retention-snapshots.md +24 -24
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-overview.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-recent-activities.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-recent-orders.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-revenue.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/installments-at-risk.md +35 -35
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/installments-variations.md +33 -33
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/installments.md +33 -33
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/item-count-distribution.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/license-chart.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/license-pie-chart.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/license-summary.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/locations.md +43 -43
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-chart.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-completion-time.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-mix.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-value-distribution.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/payment-methods-disputes.md +38 -38
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/payment-methods-methods.md +36 -36
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/payment-methods.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-comparison-launch.md +33 -33
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-comparison.md +40 -40
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-detail.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-sales.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/refunds-overview.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/retention-snapshots-step.md +45 -45
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/sales-growth-chart.md +35 -35
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/save-channel-rules.md +73 -73
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/source-channels.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/sources.md +49 -49
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-cohorts.md +33 -33
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-health.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-rebuys.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-retention.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-variations.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscriptions-overview.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/weeks-between-refund.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/assign-role.md +48 -48
- package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/delete-role-assignment.md +47 -47
- package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/get-role.md +25 -25
- package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/list-managers.md +18 -18
- package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/list-roles.md +18 -18
- package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/search-users.md +25 -25
- package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/update-role.md +43 -43
- package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/create-saved-view.md +106 -106
- package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/delete-saved-view.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/list-saved-views.md +25 -25
- package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/update-saved-view.md +83 -83
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/activate-payment-addon.md +44 -44
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/activate-plugin-addon.md +44 -44
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/change-storage-driver-status.md +56 -56
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/check-paypal-webhook.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/create-storage-bucket.md +63 -63
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/disconnect-payment-method.md +55 -55
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/exchange-paypal-seller-auth-token.md +62 -62
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-active-storage-drivers.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-checkout-fields.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-email-shortcodes.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-mcp-config-snippets.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-mcp-status.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-module-settings.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-payment-method-connection-info.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-payment-method-settings.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-permissions.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-plugin-addons.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-storage-driver-settings.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-store-settings.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/install-mcp-adapter.md +21 -21
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/install-payment-addon.md +60 -60
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/install-plugin-addon.md +64 -64
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/list-all-payment-methods.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/list-all-storage-drivers.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/list-storage-buckets.md +67 -67
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/reorder-payment-methods.md +55 -55
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/reset-storage-driver-settings.md +45 -45
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-checkout-fields.md +133 -133
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-confirmation-settings.md +68 -68
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-module-settings.md +68 -68
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-payment-method-design.md +67 -67
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-payment-method-settings.md +58 -58
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-permissions.md +68 -68
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-storage-driver-settings.md +62 -62
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-store-settings.md +239 -239
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/setup-paypal-webhook.md +48 -48
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/toggle-mcp.md +40 -40
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/verify-storage-driver-connection.md +62 -62
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/verify-turnstile-keys.md +55 -55
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/create-shipping-class.md +73 -73
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/create-shipping-method.md +110 -110
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/create-shipping-zone.md +56 -56
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/delete-shipping-class.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/delete-shipping-method.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/delete-shipping-zone.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-class-profile.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-class.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-packages.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-zone.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-zone-countries.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-zone-states.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/list-shipping-classes.md +31 -31
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/list-shipping-zones.md +31 -31
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/save-shipping-packages.md +112 -112
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-shipping-class.md +79 -79
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-shipping-method.md +113 -113
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-shipping-zone.md +62 -62
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-zone-order.md +52 -52
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/cancel-auto-renew.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/cancel-subscription.md +52 -52
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/confirm-subscription-switch.md +70 -70
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/fetch-subscription-remote.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/generate-early-payment-link.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-customer-subscription.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-or-create-plan.md +69 -69
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-setup-intent-attempts.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-subscription.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/initiate-early-payment.md +31 -31
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/list-customer-subscriptions.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/list-subscriptions.md +39 -39
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/pause-subscription.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/reactivate-subscription.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/resume-subscription.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/switch-payment-method.md +70 -70
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/update-payment-method.md +69 -69
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/update-vendor-ids.md +56 -56
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/verify-vendor-ids.md +56 -56
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/create-tax-class.md +51 -51
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/create-tax-rate.md +117 -117
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-product-override.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-shipping-tax-override.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-tax-class.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-tax-rate.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-country-tax-id.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-country-tax-rates.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-eu-vat-product-overrides.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-oss-country-rates.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-preconfigured-tax-rates.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-product-overrides.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-tax-settings.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/list-all-tax-rates.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/list-tax-classes.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/list-tax-records.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/mark-taxes-as-filed.md +58 -58
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/reset-eu-vat-rates.md +21 -21
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-configured-countries.md +57 -57
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-country-tax-id.md +50 -50
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-eu-vat-cross-border-settings.md +127 -127
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-oss-country-rates.md +100 -100
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-product-override.md +110 -110
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-shipping-tax-override.md +52 -52
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-tax-settings.md +166 -166
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/update-country-status.md +54 -54
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/update-tax-rate.md +116 -116
- package/dist/skills/fluentcart-developer/references/restapi/order-bumps.md +433 -433
- package/dist/skills/fluentcart-developer/references/restapi/orders.md +1212 -1212
- package/dist/skills/fluentcart-developer/references/restapi/pdf-templates.md +212 -212
- package/dist/skills/fluentcart-developer/references/restapi/products.md +2485 -2485
- package/dist/skills/fluentcart-developer/references/restapi/public-shop.md +191 -191
- package/dist/skills/fluentcart-developer/references/restapi/reports.md +3773 -3773
- package/dist/skills/fluentcart-developer/references/restapi/roles.md +403 -403
- package/dist/skills/fluentcart-developer/references/restapi/saved-views.md +136 -136
- package/dist/skills/fluentcart-developer/references/restapi/settings.md +1423 -1423
- package/dist/skills/fluentcart-developer/references/restapi/shipping.md +905 -905
- package/dist/skills/fluentcart-developer/references/restapi/subscriptions.md +1169 -1169
- package/dist/skills/fluentcart-developer/references/restapi/tax.md +1551 -1551
- package/dist/skills/fluentcart-developer/references/restapi.md +127 -127
- package/dist/skills/fluentcart-developer/scripts/cli.js +1 -1
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +66 -65
|
@@ -1,1423 +1,1423 @@
|
|
|
1
|
-
# Settings API
|
|
2
|
-
|
|
3
|
-
Configure your store settings, payment gateways, modules, file storage, checkout fields, and permissions.
|
|
4
|
-
|
|
5
|
-
**Base URL:** `https://your-site.com/wp-json/fluent-cart/v2/settings`
|
|
6
|
-
|
|
7
|
-
**Policy:** `StoreSettingsPolicy` (most endpoints require `is_super_admin`)
|
|
8
|
-
|
|
9
|
-
---
|
|
10
|
-
|
|
11
|
-
## Payment Methods
|
|
12
|
-
|
|
13
|
-
### Get Payment Method Settings
|
|
14
|
-
|
|
15
|
-
GET `/fluent-cart/v2/settings/payment-methods`
|
|
16
|
-
|
|
17
|
-
Retrieve the configuration and settings for a specific payment method gateway (e.g., Stripe, PayPal).
|
|
18
|
-
|
|
19
|
-
- **Permission:** `is_super_admin`
|
|
20
|
-
|
|
21
|
-
#### Parameters
|
|
22
|
-
|
|
23
|
-
| Parameter | Type | Location | Required | Description |
|
|
24
|
-
| --- | --- | --- | --- | --- |
|
|
25
|
-
| `method` | string | query | Yes | The payment method key to retrieve settings for (e.g., `stripe`, `paypal`, `cod`). |
|
|
26
|
-
|
|
27
|
-
#### Response
|
|
28
|
-
|
|
29
|
-
```
|
|
30
|
-
{
|
|
31
|
-
"settings": {
|
|
32
|
-
"is_active": "yes",
|
|
33
|
-
"payment_mode": "live",
|
|
34
|
-
"checkout_label": "Pay with Stripe",
|
|
35
|
-
"checkout_logo": "https://example.com/stripe-logo.png",
|
|
36
|
-
"checkout_instructions": "",
|
|
37
|
-
"thank_you_page_instructions": ""
|
|
38
|
-
},
|
|
39
|
-
"fields": { ... }
|
|
40
|
-
}
|
|
41
|
-
```
|
|
42
|
-
|
|
43
|
-
#### Example
|
|
44
|
-
|
|
45
|
-
```
|
|
46
|
-
curl -X GET "https://example.com/wp-json/fluent-cart/v2/settings/payment-methods?method=stripe" \
|
|
47
|
-
-u "username:app_password"
|
|
48
|
-
```
|
|
49
|
-
|
|
50
|
-
---
|
|
51
|
-
|
|
52
|
-
### Save Payment Method Settings
|
|
53
|
-
|
|
54
|
-
POST `/fluent-cart/v2/settings/payment-methods`
|
|
55
|
-
|
|
56
|
-
Create or update the configuration for a specific payment method gateway.
|
|
57
|
-
|
|
58
|
-
- **Permission:** `is_super_admin`
|
|
59
|
-
|
|
60
|
-
#### Parameters
|
|
61
|
-
|
|
62
|
-
| Parameter | Type | Location | Required | Description |
|
|
63
|
-
| --- | --- | --- | --- | --- |
|
|
64
|
-
| `method` | string | body | Yes | The payment method key (e.g., `stripe`, `paypal`, `cod`). |
|
|
65
|
-
| `settings` | object | body | Yes | Key-value object of gateway-specific settings to save. Fields vary by payment method. |
|
|
66
|
-
|
|
67
|
-
#### Response
|
|
68
|
-
|
|
69
|
-
```
|
|
70
|
-
{
|
|
71
|
-
"settings": {
|
|
72
|
-
"is_active": "yes",
|
|
73
|
-
"payment_mode": "live",
|
|
74
|
-
...
|
|
75
|
-
},
|
|
76
|
-
"message": "Settings saved successfully"
|
|
77
|
-
}
|
|
78
|
-
```
|
|
79
|
-
|
|
80
|
-
#### Example
|
|
81
|
-
|
|
82
|
-
```
|
|
83
|
-
curl -X POST "https://example.com/wp-json/fluent-cart/v2/settings/payment-methods" \
|
|
84
|
-
-u "username:app_password" \
|
|
85
|
-
-H "Content-Type: application/json" \
|
|
86
|
-
-d '{
|
|
87
|
-
"method": "cod",
|
|
88
|
-
"settings": {
|
|
89
|
-
"is_active": "yes",
|
|
90
|
-
"checkout_label": "Cash on Delivery"
|
|
91
|
-
}
|
|
92
|
-
}'
|
|
93
|
-
```
|
|
94
|
-
|
|
95
|
-
---
|
|
96
|
-
|
|
97
|
-
### List All Payment Methods
|
|
98
|
-
|
|
99
|
-
GET `/fluent-cart/v2/settings/payment-methods/all`
|
|
100
|
-
|
|
101
|
-
Retrieve all registered payment method gateways categorized by availability status.
|
|
102
|
-
|
|
103
|
-
- **Permission:** `is_super_admin`
|
|
104
|
-
|
|
105
|
-
#### Parameters
|
|
106
|
-
|
|
107
|
-
None.
|
|
108
|
-
|
|
109
|
-
#### Response
|
|
110
|
-
|
|
111
|
-
```
|
|
112
|
-
{
|
|
113
|
-
"gateways": [
|
|
114
|
-
{
|
|
115
|
-
"method_key": "stripe",
|
|
116
|
-
"title": "Stripe",
|
|
117
|
-
"is_active": "yes",
|
|
118
|
-
"description": "Accept payments via Stripe",
|
|
119
|
-
"logo": "https://...",
|
|
120
|
-
"upcoming": false
|
|
121
|
-
},
|
|
122
|
-
{
|
|
123
|
-
"method_key": "paypal",
|
|
124
|
-
"title": "PayPal",
|
|
125
|
-
"is_active": "no",
|
|
126
|
-
"requires_pro": true
|
|
127
|
-
}
|
|
128
|
-
]
|
|
129
|
-
}
|
|
130
|
-
```
|
|
131
|
-
|
|
132
|
-
Gateways are sorted in order: available gateways first, then those requiring Pro, then upcoming.
|
|
133
|
-
|
|
134
|
-
#### Example
|
|
135
|
-
|
|
136
|
-
```
|
|
137
|
-
curl -X GET "https://example.com/wp-json/fluent-cart/v2/settings/payment-methods/all" \
|
|
138
|
-
-u "username:app_password"
|
|
139
|
-
```
|
|
140
|
-
|
|
141
|
-
---
|
|
142
|
-
|
|
143
|
-
### Reorder Payment Methods
|
|
144
|
-
|
|
145
|
-
POST `/fluent-cart/v2/settings/payment-methods/reorder`
|
|
146
|
-
|
|
147
|
-
Set the display order of payment methods on the checkout page.
|
|
148
|
-
|
|
149
|
-
- **Permission:** `is_super_admin`
|
|
150
|
-
|
|
151
|
-
#### Parameters
|
|
152
|
-
|
|
153
|
-
| Parameter | Type | Location | Required | Description |
|
|
154
|
-
| --- | --- | --- | --- | --- |
|
|
155
|
-
| `order` | array | body | Yes | Ordered array of payment method keys (e.g., `["stripe", "paypal", "cod"]`). |
|
|
156
|
-
|
|
157
|
-
#### Response
|
|
158
|
-
|
|
159
|
-
```
|
|
160
|
-
{
|
|
161
|
-
"message": "Payment methods order saved successfully",
|
|
162
|
-
"order": ["stripe", "paypal", "cod"]
|
|
163
|
-
}
|
|
164
|
-
```
|
|
165
|
-
|
|
166
|
-
#### Example
|
|
167
|
-
|
|
168
|
-
```
|
|
169
|
-
curl -X POST "https://example.com/wp-json/fluent-cart/v2/settings/payment-methods/reorder" \
|
|
170
|
-
-u "username:app_password" \
|
|
171
|
-
-H "Content-Type: application/json" \
|
|
172
|
-
-d '{
|
|
173
|
-
"order": ["stripe", "paypal", "cod"]
|
|
174
|
-
}'
|
|
175
|
-
```
|
|
176
|
-
|
|
177
|
-
---
|
|
178
|
-
|
|
179
|
-
### Get Payment Method Connection Info
|
|
180
|
-
|
|
181
|
-
GET `/fluent-cart/v2/settings/payment-methods/connect/info`
|
|
182
|
-
|
|
183
|
-
Retrieve connection information (OAuth URLs, account status) for a connectable payment gateway.
|
|
184
|
-
|
|
185
|
-
- **Permission:** `is_super_admin`
|
|
186
|
-
|
|
187
|
-
#### Parameters
|
|
188
|
-
|
|
189
|
-
| Parameter | Type | Location | Required | Description |
|
|
190
|
-
| --- | --- | --- | --- | --- |
|
|
191
|
-
| `method` | string | query | Yes | The payment method key (e.g., `stripe`, `paypal`). |
|
|
192
|
-
|
|
193
|
-
#### Response
|
|
194
|
-
|
|
195
|
-
The response structure varies by gateway. For Stripe, it may include OAuth redirect URLs and connected account information. For PayPal, it includes test/live redirect URLs and account details.
|
|
196
|
-
|
|
197
|
-
```
|
|
198
|
-
{
|
|
199
|
-
"connect_config": {
|
|
200
|
-
"test_redirect": "https://example.com/wp-admin/?fluent-cart=...",
|
|
201
|
-
"live_redirect": "https://example.com/wp-admin/?fluent-cart=...",
|
|
202
|
-
"disconnect_note": "Disconnecting will prevent..."
|
|
203
|
-
},
|
|
204
|
-
"test_account": { ... },
|
|
205
|
-
"live_account": { ... },
|
|
206
|
-
"settings": { ... }
|
|
207
|
-
}
|
|
208
|
-
```
|
|
209
|
-
|
|
210
|
-
#### Example
|
|
211
|
-
|
|
212
|
-
```
|
|
213
|
-
curl -X GET "https://example.com/wp-json/fluent-cart/v2/settings/payment-methods/connect/info?method=paypal" \
|
|
214
|
-
-u "username:app_password"
|
|
215
|
-
```
|
|
216
|
-
|
|
217
|
-
---
|
|
218
|
-
|
|
219
|
-
### Disconnect Payment Method
|
|
220
|
-
|
|
221
|
-
POST `/fluent-cart/v2/settings/payment-methods/disconnect`
|
|
222
|
-
|
|
223
|
-
Disconnect a payment gateway account (e.g., revoke Stripe or PayPal connection).
|
|
224
|
-
|
|
225
|
-
- **Permission:** `is_super_admin`
|
|
226
|
-
|
|
227
|
-
#### Parameters
|
|
228
|
-
|
|
229
|
-
| Parameter | Type | Location | Required | Description |
|
|
230
|
-
| --- | --- | --- | --- | --- |
|
|
231
|
-
| `method` | string | body | Yes | The payment method key to disconnect (e.g., `stripe`, `paypal`). |
|
|
232
|
-
| `mode` | string | body | Yes | The environment mode to disconnect: `test` or `live`. |
|
|
233
|
-
|
|
234
|
-
#### Response
|
|
235
|
-
|
|
236
|
-
```
|
|
237
|
-
{
|
|
238
|
-
"message": "PayPal settings has been disconnected",
|
|
239
|
-
"settings": { ... }
|
|
240
|
-
}
|
|
241
|
-
```
|
|
242
|
-
|
|
243
|
-
#### Example
|
|
244
|
-
|
|
245
|
-
```
|
|
246
|
-
curl -X POST "https://example.com/wp-json/fluent-cart/v2/settings/payment-methods/disconnect" \
|
|
247
|
-
-u "username:app_password" \
|
|
248
|
-
-H "Content-Type: application/json" \
|
|
249
|
-
-d '{
|
|
250
|
-
"method": "paypal",
|
|
251
|
-
"mode": "test"
|
|
252
|
-
}'
|
|
253
|
-
```
|
|
254
|
-
|
|
255
|
-
---
|
|
256
|
-
|
|
257
|
-
### Save Payment Method Design
|
|
258
|
-
|
|
259
|
-
POST `/fluent-cart/v2/settings/payment-methods/design`
|
|
260
|
-
|
|
261
|
-
Customize the checkout appearance for a specific payment method, including its label, logo, and instructions.
|
|
262
|
-
|
|
263
|
-
- **Permission:** `is_super_admin`
|
|
264
|
-
|
|
265
|
-
#### Parameters
|
|
266
|
-
|
|
267
|
-
| Parameter | Type | Location | Required | Description |
|
|
268
|
-
| --- | --- | --- | --- | --- |
|
|
269
|
-
| `method` | string | body | Yes | The payment method key (e.g., `stripe`, `paypal`, `cod`). |
|
|
270
|
-
| `checkout_label` | string | body | No | Custom label displayed on the checkout form for this method. |
|
|
271
|
-
| `checkout_logo` | string | body | No | URL to a custom logo image for the checkout form. |
|
|
272
|
-
| `checkout_instructions` | string | body | No | HTML instructions shown on the checkout page when this method is selected. |
|
|
273
|
-
| `thank_you_page_instructions` | string | body | No | HTML instructions shown on the thank-you/receipt page. |
|
|
274
|
-
|
|
275
|
-
#### Response
|
|
276
|
-
|
|
277
|
-
```
|
|
278
|
-
{
|
|
279
|
-
"message": "Checkout design settings saved",
|
|
280
|
-
"settings": { ... }
|
|
281
|
-
}
|
|
282
|
-
```
|
|
283
|
-
|
|
284
|
-
#### Example
|
|
285
|
-
|
|
286
|
-
```
|
|
287
|
-
curl -X POST "https://example.com/wp-json/fluent-cart/v2/settings/payment-methods/design" \
|
|
288
|
-
-u "username:app_password" \
|
|
289
|
-
-H "Content-Type: application/json" \
|
|
290
|
-
-d '{
|
|
291
|
-
"method": "stripe",
|
|
292
|
-
"checkout_label": "Credit / Debit Card",
|
|
293
|
-
"checkout_logo": "https://example.com/card-icon.png",
|
|
294
|
-
"checkout_instructions": "<p>You will be charged securely via Stripe.</p>"
|
|
295
|
-
}'
|
|
296
|
-
```
|
|
297
|
-
|
|
298
|
-
---
|
|
299
|
-
|
|
300
|
-
### Install Payment Addon
|
|
301
|
-
|
|
302
|
-
POST `/fluent-cart/v2/settings/payment-methods/install-addon`
|
|
303
|
-
|
|
304
|
-
Install a payment gateway addon plugin from a remote source (WordPress.org or GitHub).
|
|
305
|
-
|
|
306
|
-
- **Permission:** `is_super_admin`
|
|
307
|
-
|
|
308
|
-
#### Parameters
|
|
309
|
-
|
|
310
|
-
| Parameter | Type | Location | Required | Description |
|
|
311
|
-
| --- | --- | --- | --- | --- |
|
|
312
|
-
| `plugin_slug` | string | body | Yes | The slug of the plugin to install (e.g., `fluent-cart-pro`). |
|
|
313
|
-
| `source_type` | string | body | Yes | Source type: `wordpress` (WordPress.org) or `github`. |
|
|
314
|
-
| `source_link` | string | body | Conditional | The URL to the plugin source. Required when `source_type` is `github`. |
|
|
315
|
-
|
|
316
|
-
#### Response
|
|
317
|
-
|
|
318
|
-
```
|
|
319
|
-
{
|
|
320
|
-
"message": "Payment addon installed successfully!",
|
|
321
|
-
"plugin_file": "fluent-cart-pro/fluent-cart-pro.php"
|
|
322
|
-
}
|
|
323
|
-
```
|
|
324
|
-
|
|
325
|
-
#### Example
|
|
326
|
-
|
|
327
|
-
```
|
|
328
|
-
curl -X POST "https://example.com/wp-json/fluent-cart/v2/settings/payment-methods/install-addon" \
|
|
329
|
-
-u "username:app_password" \
|
|
330
|
-
-H "Content-Type: application/json" \
|
|
331
|
-
-d '{
|
|
332
|
-
"plugin_slug": "fluent-cart-pro",
|
|
333
|
-
"source_type": "wordpress"
|
|
334
|
-
}'
|
|
335
|
-
```
|
|
336
|
-
|
|
337
|
-
---
|
|
338
|
-
|
|
339
|
-
### Activate Payment Addon
|
|
340
|
-
|
|
341
|
-
POST `/fluent-cart/v2/settings/payment-methods/activate-addon`
|
|
342
|
-
|
|
343
|
-
Activate an already-installed payment gateway addon plugin.
|
|
344
|
-
|
|
345
|
-
- **Permission:** `is_super_admin`
|
|
346
|
-
|
|
347
|
-
#### Parameters
|
|
348
|
-
|
|
349
|
-
| Parameter | Type | Location | Required | Description |
|
|
350
|
-
| --- | --- | --- | --- | --- |
|
|
351
|
-
| `plugin_file` | string | body | Yes | The plugin file path (e.g., `fluent-cart-pro/fluent-cart-pro.php`). |
|
|
352
|
-
|
|
353
|
-
#### Response
|
|
354
|
-
|
|
355
|
-
```
|
|
356
|
-
{
|
|
357
|
-
"message": "Payment addon activated successfully!"
|
|
358
|
-
}
|
|
359
|
-
```
|
|
360
|
-
|
|
361
|
-
For FluentCart Pro specifically:
|
|
362
|
-
|
|
363
|
-
```
|
|
364
|
-
{
|
|
365
|
-
"message": "FluentCart Pro activated successfully! All premium features are now available."
|
|
366
|
-
}
|
|
367
|
-
```
|
|
368
|
-
|
|
369
|
-
#### Example
|
|
370
|
-
|
|
371
|
-
```
|
|
372
|
-
curl -X POST "https://example.com/wp-json/fluent-cart/v2/settings/payment-methods/activate-addon" \
|
|
373
|
-
-u "username:app_password" \
|
|
374
|
-
-H "Content-Type: application/json" \
|
|
375
|
-
-d '{
|
|
376
|
-
"plugin_file": "fluent-cart-pro/fluent-cart-pro.php"
|
|
377
|
-
}'
|
|
378
|
-
```
|
|
379
|
-
|
|
380
|
-
---
|
|
381
|
-
|
|
382
|
-
## PayPal Configuration
|
|
383
|
-
|
|
384
|
-
These endpoints are used during the PayPal gateway onboarding and webhook setup process.
|
|
385
|
-
|
|
386
|
-
**Policy:** `AdminPolicy` (requires `super_admin`)
|
|
387
|
-
|
|
388
|
-
### Exchange PayPal Seller Auth Token
|
|
389
|
-
|
|
390
|
-
POST `/fluent-cart/v2/settings/payment-methods/paypal/seller-auth-token`
|
|
391
|
-
|
|
392
|
-
Exchange the PayPal authorization code for a seller access token during the PayPal Connect onboarding flow. This retrieves merchant credentials and saves them to the gateway settings.
|
|
393
|
-
|
|
394
|
-
- **Permission:** `super_admin`
|
|
395
|
-
|
|
396
|
-
#### Parameters
|
|
397
|
-
|
|
398
|
-
| Parameter | Type | Location | Required | Description |
|
|
399
|
-
| --- | --- | --- | --- | --- |
|
|
400
|
-
| `authCode` | string | body | Yes | The authorization code received from PayPal OAuth redirect. |
|
|
401
|
-
| `sharedId` | string | body | Yes | The PayPal partner shared/client ID used during authentication. |
|
|
402
|
-
| `mode` | string | body | Yes | Environment mode: `test` or `live`. |
|
|
403
|
-
|
|
404
|
-
#### Response
|
|
405
|
-
|
|
406
|
-
On success, credentials are saved to the PayPal gateway settings and webhooks are automatically registered. No explicit JSON response body is returned.
|
|
407
|
-
|
|
408
|
-
#### Example
|
|
409
|
-
|
|
410
|
-
```
|
|
411
|
-
curl -X POST "https://example.com/wp-json/fluent-cart/v2/settings/payment-methods/paypal/seller-auth-token" \
|
|
412
|
-
-u "username:app_password" \
|
|
413
|
-
-H "Content-Type: application/json" \
|
|
414
|
-
-d '{
|
|
415
|
-
"authCode": "C21AAF...",
|
|
416
|
-
"sharedId": "AaBbCc...",
|
|
417
|
-
"mode": "live"
|
|
418
|
-
}'
|
|
419
|
-
```
|
|
420
|
-
|
|
421
|
-
---
|
|
422
|
-
|
|
423
|
-
### Setup PayPal Webhook
|
|
424
|
-
|
|
425
|
-
POST `/fluent-cart/v2/settings/payment-methods/paypal/webhook/setup`
|
|
426
|
-
|
|
427
|
-
Register a webhook endpoint with PayPal to receive payment event notifications.
|
|
428
|
-
|
|
429
|
-
- **Permission:** `super_admin`
|
|
430
|
-
|
|
431
|
-
#### Parameters
|
|
432
|
-
|
|
433
|
-
| Parameter | Type | Location | Required | Description |
|
|
434
|
-
| --- | --- | --- | --- | --- |
|
|
435
|
-
| `mode` | string | body | Yes | Environment mode: `test` or `live`. |
|
|
436
|
-
|
|
437
|
-
#### Response
|
|
438
|
-
|
|
439
|
-
```
|
|
440
|
-
{
|
|
441
|
-
"message": "Webhook setup successfully! Please reload the page."
|
|
442
|
-
}
|
|
443
|
-
```
|
|
444
|
-
|
|
445
|
-
#### Example
|
|
446
|
-
|
|
447
|
-
```
|
|
448
|
-
curl -X POST "https://example.com/wp-json/fluent-cart/v2/settings/payment-methods/paypal/webhook/setup" \
|
|
449
|
-
-u "username:app_password" \
|
|
450
|
-
-H "Content-Type: application/json" \
|
|
451
|
-
-d '{
|
|
452
|
-
"mode": "live"
|
|
453
|
-
}'
|
|
454
|
-
```
|
|
455
|
-
|
|
456
|
-
---
|
|
457
|
-
|
|
458
|
-
### Check PayPal Webhook
|
|
459
|
-
|
|
460
|
-
GET `/fluent-cart/v2/settings/payment-methods/paypal/webhook/check`
|
|
461
|
-
|
|
462
|
-
Verify the current PayPal webhook registration status and set up the webhook if it is missing.
|
|
463
|
-
|
|
464
|
-
- **Permission:** `super_admin`
|
|
465
|
-
|
|
466
|
-
#### Parameters
|
|
467
|
-
|
|
468
|
-
| Parameter | Type | Location | Required | Description |
|
|
469
|
-
| --- | --- | --- | --- | --- |
|
|
470
|
-
| `mode` | string | query | Yes | Environment mode: `test` or `live`. |
|
|
471
|
-
|
|
472
|
-
#### Response
|
|
473
|
-
|
|
474
|
-
Returns the webhook status and configuration details from PayPal.
|
|
475
|
-
|
|
476
|
-
#### Example
|
|
477
|
-
|
|
478
|
-
```
|
|
479
|
-
curl -X GET "https://example.com/wp-json/fluent-cart/v2/settings/payment-methods/paypal/webhook/check?mode=live" \
|
|
480
|
-
-u "username:app_password"
|
|
481
|
-
```
|
|
482
|
-
|
|
483
|
-
---
|
|
484
|
-
|
|
485
|
-
## Permissions
|
|
486
|
-
|
|
487
|
-
### Get Permissions
|
|
488
|
-
|
|
489
|
-
GET `/fluent-cart/v2/settings/permissions`
|
|
490
|
-
|
|
491
|
-
Retrieve the current role-to-capability permission mappings for FluentCart.
|
|
492
|
-
|
|
493
|
-
- **Permission:** `is_super_admin`
|
|
494
|
-
|
|
495
|
-
#### Parameters
|
|
496
|
-
|
|
497
|
-
None.
|
|
498
|
-
|
|
499
|
-
#### Response
|
|
500
|
-
|
|
501
|
-
```
|
|
502
|
-
{
|
|
503
|
-
"roles": {
|
|
504
|
-
"administrator": {
|
|
505
|
-
"name": "Administrator",
|
|
506
|
-
"capabilities": {
|
|
507
|
-
"orders/view": true,
|
|
508
|
-
"orders/manage": true,
|
|
509
|
-
"customers/view": true,
|
|
510
|
-
"products/manage": true,
|
|
511
|
-
...
|
|
512
|
-
}
|
|
513
|
-
},
|
|
514
|
-
"shop_manager": {
|
|
515
|
-
"name": "Shop Manager",
|
|
516
|
-
"capabilities": { ... }
|
|
517
|
-
}
|
|
518
|
-
}
|
|
519
|
-
}
|
|
520
|
-
```
|
|
521
|
-
|
|
522
|
-
#### Example
|
|
523
|
-
|
|
524
|
-
```
|
|
525
|
-
curl -X GET "https://example.com/wp-json/fluent-cart/v2/settings/permissions" \
|
|
526
|
-
-u "username:app_password"
|
|
527
|
-
```
|
|
528
|
-
|
|
529
|
-
---
|
|
530
|
-
|
|
531
|
-
### Save Permissions
|
|
532
|
-
|
|
533
|
-
POST `/fluent-cart/v2/settings/permissions`
|
|
534
|
-
|
|
535
|
-
Update the role-to-capability permission mappings for FluentCart.
|
|
536
|
-
|
|
537
|
-
- **Permission:** `is_super_admin`
|
|
538
|
-
|
|
539
|
-
#### Parameters
|
|
540
|
-
|
|
541
|
-
| Parameter | Type | Location | Required | Description |
|
|
542
|
-
| --- | --- | --- | --- | --- |
|
|
543
|
-
| `capability` | object | body | Yes | An object mapping WordPress role slugs to their FluentCart capability assignments. |
|
|
544
|
-
|
|
545
|
-
#### Response
|
|
546
|
-
|
|
547
|
-
```
|
|
548
|
-
{
|
|
549
|
-
"message": "Permissions saved successfully"
|
|
550
|
-
}
|
|
551
|
-
```
|
|
552
|
-
|
|
553
|
-
#### Example
|
|
554
|
-
|
|
555
|
-
```
|
|
556
|
-
curl -X POST "https://example.com/wp-json/fluent-cart/v2/settings/permissions" \
|
|
557
|
-
-u "username:app_password" \
|
|
558
|
-
-H "Content-Type: application/json" \
|
|
559
|
-
-d '{
|
|
560
|
-
"capability": {
|
|
561
|
-
"shop_manager": {
|
|
562
|
-
"orders/view": true,
|
|
563
|
-
"orders/manage": true,
|
|
564
|
-
"customers/view": true,
|
|
565
|
-
"products/manage": false
|
|
566
|
-
}
|
|
567
|
-
}
|
|
568
|
-
}'
|
|
569
|
-
```
|
|
570
|
-
|
|
571
|
-
---
|
|
572
|
-
|
|
573
|
-
## Store Settings
|
|
574
|
-
|
|
575
|
-
### Get Store Settings
|
|
576
|
-
|
|
577
|
-
GET `/fluent-cart/v2/settings/store`
|
|
578
|
-
|
|
579
|
-
Retrieve all store configuration settings along with the field schema for a given settings tab.
|
|
580
|
-
|
|
581
|
-
- **Permission:** `store/settings`
|
|
582
|
-
|
|
583
|
-
#### Parameters
|
|
584
|
-
|
|
585
|
-
| Parameter | Type | Location | Required | Description |
|
|
586
|
-
| --- | --- | --- | --- | --- |
|
|
587
|
-
| `settings_name` | string | query | No | The settings tab to return fields for (e.g., `store_setup`, `checkout`, `pages`). |
|
|
588
|
-
|
|
589
|
-
#### Response
|
|
590
|
-
|
|
591
|
-
```
|
|
592
|
-
{
|
|
593
|
-
"settings": {
|
|
594
|
-
"store_name": "My Store",
|
|
595
|
-
"currency": "USD",
|
|
596
|
-
"currency_position": "before",
|
|
597
|
-
"decimal_separator": "dot",
|
|
598
|
-
"checkout_button_text": "Checkout",
|
|
599
|
-
"view_cart_button_text": "View Cart",
|
|
600
|
-
"cart_button_text": "Add To Cart",
|
|
601
|
-
"popup_button_text": "View Product",
|
|
602
|
-
"out_of_stock_button_text": "Not Available",
|
|
603
|
-
"checkout_method_style": "logo",
|
|
604
|
-
"enable_modal_checkout": "no",
|
|
605
|
-
"require_logged_in": "no",
|
|
606
|
-
"show_cart_icon_in_nav": "no",
|
|
607
|
-
"show_cart_icon_in_body": "yes",
|
|
608
|
-
"additional_address_field": "yes",
|
|
609
|
-
"hide_coupon_field": "no",
|
|
610
|
-
"user_account_creation_mode": "all",
|
|
611
|
-
"checkout_page_id": "",
|
|
612
|
-
"cart_page_id": "",
|
|
613
|
-
"receipt_page_id": "",
|
|
614
|
-
"shop_page_id": "",
|
|
615
|
-
"customer_profile_page_id": "",
|
|
616
|
-
"store_address1": "",
|
|
617
|
-
"store_address2": "",
|
|
618
|
-
"store_city": "",
|
|
619
|
-
"store_country": "",
|
|
620
|
-
"store_postcode": "",
|
|
621
|
-
"store_state": "",
|
|
622
|
-
"order_mode": "test",
|
|
623
|
-
"variation_view": "both",
|
|
624
|
-
"variation_columns": "masonry",
|
|
625
|
-
"min_receipt_number": "1",
|
|
626
|
-
"inv_prefix": "INV-",
|
|
627
|
-
"show_email_footer": "yes",
|
|
628
|
-
...
|
|
629
|
-
},
|
|
630
|
-
"fields": {
|
|
631
|
-
"store_setup": { ... }
|
|
632
|
-
}
|
|
633
|
-
}
|
|
634
|
-
```
|
|
635
|
-
|
|
636
|
-
#### Example
|
|
637
|
-
|
|
638
|
-
```
|
|
639
|
-
curl -X GET "https://example.com/wp-json/fluent-cart/v2/settings/store?settings_name=store_setup" \
|
|
640
|
-
-u "username:app_password"
|
|
641
|
-
```
|
|
642
|
-
|
|
643
|
-
---
|
|
644
|
-
|
|
645
|
-
### Save Store Settings
|
|
646
|
-
|
|
647
|
-
POST `/fluent-cart/v2/settings/store`
|
|
648
|
-
|
|
649
|
-
Update store configuration settings. Submitted values are merged with existing settings.
|
|
650
|
-
|
|
651
|
-
- **Permission:** `store/settings`
|
|
652
|
-
- **Request Class:** `FluentMetaRequest` (validates and sanitizes input)
|
|
653
|
-
|
|
654
|
-
#### Parameters
|
|
655
|
-
|
|
656
|
-
| Parameter | Type | Location | Required | Description |
|
|
657
|
-
| --- | --- | --- | --- | --- |
|
|
658
|
-
| `settings_name` | string | body | Conditional | Settings tab identifier. Required for `store_setup` tab validation (enforces `store_name` and `store_country`). |
|
|
659
|
-
| `store_name` | string | body | Conditional | Store name. Required when `settings_name` is `store_setup`. Max 200 characters. |
|
|
660
|
-
| `store_logo` | object | body | No | Store logo with `id` (integer), `url` (string), and `title` (string). |
|
|
661
|
-
| `currency` | string | body | No | Store currency code (e.g., `USD`, `EUR`, `GBP`). |
|
|
662
|
-
| `currency_position` | string | body | No | Currency symbol position: `before` or `after`. |
|
|
663
|
-
| `decimal_separator` | string | body | No | Decimal separator style: `dot` or `comma`. |
|
|
664
|
-
| `checkout_button_text` | string | body | No | Custom text for the checkout button. |
|
|
665
|
-
| `view_cart_button_text` | string | body | No | Custom text for the view cart button. |
|
|
666
|
-
| `cart_button_text` | string | body | No | Custom text for the add-to-cart button. |
|
|
667
|
-
| `popup_button_text` | string | body | No | Custom text for the product popup button. |
|
|
668
|
-
| `out_of_stock_button_text` | string | body | No | Custom text for the out-of-stock button. |
|
|
669
|
-
| `checkout_method_style` | string | body | No | Payment method display on checkout: `logo` or other styles. |
|
|
670
|
-
| `enable_modal_checkout` | string | body | No | Enable modal/popup checkout: `yes` or `no`. |
|
|
671
|
-
| `show_cart_icon_in_nav` | string | body | No | Show cart icon in navigation: `yes` or `no`. |
|
|
672
|
-
| `show_cart_icon_in_body` | string | body | No | Show floating cart icon: `yes` or `no`. |
|
|
673
|
-
| `additional_address_field` | string | body | No | Show additional address field: `yes` or `no`. |
|
|
674
|
-
| `hide_coupon_field` | string | body | No | Hide coupon input on checkout: `yes` or `no`. |
|
|
675
|
-
| `user_account_creation_mode` | string | body | No | Account creation mode: `all`, `optional`, or `disabled`. |
|
|
676
|
-
| `force_ssl` | string | body | No | Force SSL on checkout: `yes` or `no`. |
|
|
677
|
-
| `checkout_page_id` | integer | body | No | WordPress page ID for the checkout page. |
|
|
678
|
-
| `cart_page_id` | integer | body | No | WordPress page ID for the cart page. |
|
|
679
|
-
| `receipt_page_id` | integer | body | No | WordPress page ID for the order receipt page. |
|
|
680
|
-
| `shop_page_id` | integer | body | No | WordPress page ID for the shop page. |
|
|
681
|
-
| `customer_profile_page_id` | integer | body | No | WordPress page ID for the customer profile page. |
|
|
682
|
-
| `customer_profile_page_slug` | string | body | No | Custom slug for the customer profile page. |
|
|
683
|
-
| `registration_page_id` | integer | body | No | WordPress page ID for the registration page. |
|
|
684
|
-
| `login_page_id` | integer | body | No | WordPress page ID for the login page. |
|
|
685
|
-
| `store_address1` | string | body | No | Store address line 1. |
|
|
686
|
-
| `store_address2` | string | body | No | Store address line 2. |
|
|
687
|
-
| `store_city` | string | body | No | Store city. |
|
|
688
|
-
| `store_country` | string | body | Conditional | Store country code. Required when `settings_name` is `store_setup`. Max 200 characters. |
|
|
689
|
-
| `store_postcode` | string | body | No | Store postal/zip code. |
|
|
690
|
-
| `store_state` | string | body | No | Store state/province code. |
|
|
691
|
-
| `order_mode` | string | body | No | Order/payment mode: `test` or `live`. |
|
|
692
|
-
| `variation_view` | string | body | No | Product variation display: `both`, `grid`, or `list`. |
|
|
693
|
-
| `variation_columns` | string | body | No | Variation layout style: `masonry` or other layouts. |
|
|
694
|
-
| `enable_early_payment_for_installment` | string | body | No | Allow early installment payments: `yes` or `no`. |
|
|
695
|
-
| `product_slug` | string | body | No | Custom product URL slug. |
|
|
696
|
-
| `min_receipt_number` | string | body | No | Minimum receipt/invoice number. |
|
|
697
|
-
| `inv_prefix` | string | body | No | Invoice number prefix (e.g., `INV-`). |
|
|
698
|
-
| `frontend_theme` | object | body | No | Theme color overrides. Object of key-value pairs where values are hex colors. |
|
|
699
|
-
|
|
700
|
-
#### Response
|
|
701
|
-
|
|
702
|
-
```
|
|
703
|
-
{
|
|
704
|
-
"data": {
|
|
705
|
-
"store_name": "My Store",
|
|
706
|
-
"currency": "USD",
|
|
707
|
-
...
|
|
708
|
-
}
|
|
709
|
-
}
|
|
710
|
-
```
|
|
711
|
-
|
|
712
|
-
#### Example
|
|
713
|
-
|
|
714
|
-
```
|
|
715
|
-
curl -X POST "https://example.com/wp-json/fluent-cart/v2/settings/store" \
|
|
716
|
-
-u "username:app_password" \
|
|
717
|
-
-H "Content-Type: application/json" \
|
|
718
|
-
-d '{
|
|
719
|
-
"settings_name": "store_setup",
|
|
720
|
-
"store_name": "My Awesome Store",
|
|
721
|
-
"store_country": "US",
|
|
722
|
-
"currency": "USD",
|
|
723
|
-
"order_mode": "live"
|
|
724
|
-
}'
|
|
725
|
-
```
|
|
726
|
-
|
|
727
|
-
---
|
|
728
|
-
|
|
729
|
-
## Modules
|
|
730
|
-
|
|
731
|
-
### Get Plugin Addons
|
|
732
|
-
|
|
733
|
-
GET `/fluent-cart/v2/settings/modules/plugin-addons`
|
|
734
|
-
|
|
735
|
-
List all registered plugin addons (e.g., Elementor Blocks) with their installation and activation status.
|
|
736
|
-
|
|
737
|
-
- **Permission:** `is_super_admin`
|
|
738
|
-
|
|
739
|
-
#### Parameters
|
|
740
|
-
|
|
741
|
-
None.
|
|
742
|
-
|
|
743
|
-
#### Response
|
|
744
|
-
|
|
745
|
-
```
|
|
746
|
-
{
|
|
747
|
-
"addons": {
|
|
748
|
-
"elementor-block": {
|
|
749
|
-
"title": "Elementor Blocks",
|
|
750
|
-
"description": "Enable to get Elementor Blocks for FluentCart. Minimum Requirement: Elementor V3.34",
|
|
751
|
-
"logo": "https://...",
|
|
752
|
-
"dark_logo": "https://...",
|
|
753
|
-
"plugin_slug": "fluent-cart-elementor-blocks",
|
|
754
|
-
"plugin_file": "fluent-cart-elementor-blocks/fluent-cart-elementor-blocks.php",
|
|
755
|
-
"source_type": "cdn",
|
|
756
|
-
"source_link": "https://addons-cdn.fluentcart.com/fluent-cart-elementor-blocks.zip",
|
|
757
|
-
"upcoming": false,
|
|
758
|
-
"repo_link": "https://fluentcart.com/fluentcart-addons",
|
|
759
|
-
"is_installed": false,
|
|
760
|
-
"is_active": false
|
|
761
|
-
}
|
|
762
|
-
}
|
|
763
|
-
}
|
|
764
|
-
```
|
|
765
|
-
|
|
766
|
-
#### Example
|
|
767
|
-
|
|
768
|
-
```
|
|
769
|
-
curl -X GET "https://example.com/wp-json/fluent-cart/v2/settings/modules/plugin-addons" \
|
|
770
|
-
-u "username:app_password"
|
|
771
|
-
```
|
|
772
|
-
|
|
773
|
-
---
|
|
774
|
-
|
|
775
|
-
### Install Plugin Addon
|
|
776
|
-
|
|
777
|
-
POST `/fluent-cart/v2/settings/modules/plugin-addons/install`
|
|
778
|
-
|
|
779
|
-
Install a registered plugin addon from its configured source (WordPress.org, GitHub, or CDN).
|
|
780
|
-
|
|
781
|
-
- **Permission:** `is_super_admin`
|
|
782
|
-
|
|
783
|
-
#### Parameters
|
|
784
|
-
|
|
785
|
-
| Parameter | Type | Location | Required | Description |
|
|
786
|
-
| --- | --- | --- | --- | --- |
|
|
787
|
-
| `plugin_slug` | string | body | Yes | The slug of the addon to install. Must match a registered addon slug. |
|
|
788
|
-
| `source_type` | string | body | No | Source type: `wordpress`, `github`, or `cdn`. Defaults to the addon's registered source. |
|
|
789
|
-
| `source_link` | string | body | No | URL to the addon source. Defaults to the addon's registered source link. |
|
|
790
|
-
| `asset_path` | string | body | No | GitHub release asset path (defaults to `zipball_url`). |
|
|
791
|
-
|
|
792
|
-
#### Response
|
|
793
|
-
|
|
794
|
-
```
|
|
795
|
-
{
|
|
796
|
-
"message": "Addon installed successfully",
|
|
797
|
-
"plugin_file": "fluent-cart-elementor-blocks/fluent-cart-elementor-blocks.php"
|
|
798
|
-
}
|
|
799
|
-
```
|
|
800
|
-
|
|
801
|
-
#### Example
|
|
802
|
-
|
|
803
|
-
```
|
|
804
|
-
curl -X POST "https://example.com/wp-json/fluent-cart/v2/settings/modules/plugin-addons/install" \
|
|
805
|
-
-u "username:app_password" \
|
|
806
|
-
-H "Content-Type: application/json" \
|
|
807
|
-
-d '{
|
|
808
|
-
"plugin_slug": "fluent-cart-elementor-blocks"
|
|
809
|
-
}'
|
|
810
|
-
```
|
|
811
|
-
|
|
812
|
-
---
|
|
813
|
-
|
|
814
|
-
### Activate Plugin Addon
|
|
815
|
-
|
|
816
|
-
POST `/fluent-cart/v2/settings/modules/plugin-addons/activate`
|
|
817
|
-
|
|
818
|
-
Activate an already-installed plugin addon.
|
|
819
|
-
|
|
820
|
-
- **Permission:** `is_super_admin`
|
|
821
|
-
|
|
822
|
-
#### Parameters
|
|
823
|
-
|
|
824
|
-
| Parameter | Type | Location | Required | Description |
|
|
825
|
-
| --- | --- | --- | --- | --- |
|
|
826
|
-
| `plugin_file` | string | body | Yes | The plugin file path to activate (e.g., `fluent-cart-elementor-blocks/fluent-cart-elementor-blocks.php`). |
|
|
827
|
-
|
|
828
|
-
#### Response
|
|
829
|
-
|
|
830
|
-
```
|
|
831
|
-
{
|
|
832
|
-
"message": "Addon activated successfully."
|
|
833
|
-
}
|
|
834
|
-
```
|
|
835
|
-
|
|
836
|
-
#### Example
|
|
837
|
-
|
|
838
|
-
```
|
|
839
|
-
curl -X POST "https://example.com/wp-json/fluent-cart/v2/settings/modules/plugin-addons/activate" \
|
|
840
|
-
-u "username:app_password" \
|
|
841
|
-
-H "Content-Type: application/json" \
|
|
842
|
-
-d '{
|
|
843
|
-
"plugin_file": "fluent-cart-elementor-blocks/fluent-cart-elementor-blocks.php"
|
|
844
|
-
}'
|
|
845
|
-
```
|
|
846
|
-
|
|
847
|
-
---
|
|
848
|
-
|
|
849
|
-
### Get Module Settings
|
|
850
|
-
|
|
851
|
-
GET `/fluent-cart/v2/settings/modules`
|
|
852
|
-
|
|
853
|
-
Retrieve all module (feature toggle) settings and their field definitions.
|
|
854
|
-
|
|
855
|
-
- **Permission:** `is_super_admin`
|
|
856
|
-
|
|
857
|
-
#### Parameters
|
|
858
|
-
|
|
859
|
-
None.
|
|
860
|
-
|
|
861
|
-
#### Response
|
|
862
|
-
|
|
863
|
-
```
|
|
864
|
-
{
|
|
865
|
-
"fields": {
|
|
866
|
-
"modules_settings": {
|
|
867
|
-
"title": "Features & addon",
|
|
868
|
-
"type": "section",
|
|
869
|
-
"class": "no-padding",
|
|
870
|
-
"disable_nesting": true,
|
|
871
|
-
"columns": {
|
|
872
|
-
"default": 1,
|
|
873
|
-
"md": 1
|
|
874
|
-
},
|
|
875
|
-
"schema": {
|
|
876
|
-
"turnstile": { "title": "Turnstile", "description": "...", "type": "...", "component": "..." },
|
|
877
|
-
"reviews": { "title": "Reviews", "hidden": false },
|
|
878
|
-
"stock_management": { "title": "Stock Management", "description": "...", "type": "...", "component": "...",
|
|
879
|
-
"settings": { "enable_advanced_inventory": { "label": "...", "default": "no" } } },
|
|
880
|
-
"license": { "title": "Licensing", "description": "...", "type": "...", "component": "..." },
|
|
881
|
-
"order_bump": { "title": "Order Bump", "description": "...", "type": "...", "component": "..." },
|
|
882
|
-
"dynamic_pricing": { "title": "Dynamic Pricing", "description": "...", "type": "...", "component": "..." },
|
|
883
|
-
"mcp": { "title": "MCP", "description": "...", "type": "...", "component": "..." }
|
|
884
|
-
}
|
|
885
|
-
}
|
|
886
|
-
},
|
|
887
|
-
"settings": {
|
|
888
|
-
"turnstile": {
|
|
889
|
-
"active": "no",
|
|
890
|
-
"site_key": "",
|
|
891
|
-
"secret_key": ""
|
|
892
|
-
},
|
|
893
|
-
"reviews": {
|
|
894
|
-
"active": "yes",
|
|
895
|
-
"review_permission_mode": "verified_buyers",
|
|
896
|
-
"auto_approve_reviews": "no",
|
|
897
|
-
"show_verified_badge": "yes",
|
|
898
|
-
"enable_star_rating": "yes",
|
|
899
|
-
"star_rating_required": "yes",
|
|
900
|
-
"reviews_per_page": 10
|
|
901
|
-
},
|
|
902
|
-
"stock_management": {
|
|
903
|
-
"active": "yes",
|
|
904
|
-
"enable_advanced_inventory": "no"
|
|
905
|
-
}
|
|
906
|
-
}
|
|
907
|
-
}
|
|
908
|
-
```
|
|
909
|
-
|
|
910
|
-
`fields.modules_settings.schema` describes **every** module the admin can toggle, while `settings` carries only the modules that have stored values. A module absent from `settings` has never been configured on that store, so read defaults from the schema rather than assuming the key is present.
|
|
911
|
-
|
|
912
|
-
Module keys are dynamically registered via the `fluent_cart/module_setting/fields` filter.
|
|
913
|
-
|
|
914
|
-
#### Example
|
|
915
|
-
|
|
916
|
-
```
|
|
917
|
-
curl -X GET "https://example.com/wp-json/fluent-cart/v2/settings/modules" \
|
|
918
|
-
-u "username:app_password"
|
|
919
|
-
```
|
|
920
|
-
|
|
921
|
-
---
|
|
922
|
-
|
|
923
|
-
### Save Module Settings
|
|
924
|
-
|
|
925
|
-
POST `/fluent-cart/v2/settings/modules`
|
|
926
|
-
|
|
927
|
-
Enable or disable modules (features) and update their configuration. Fires `fluent_cart/module/activated/{key}` or `fluent_cart/module/deactivated/{key}` hooks when a module's active status changes.
|
|
928
|
-
|
|
929
|
-
- **Permission:** `is_super_admin`
|
|
930
|
-
|
|
931
|
-
#### Parameters
|
|
932
|
-
|
|
933
|
-
The request body should include module key-value pairs matching the registered module keys. Each module object typically contains:
|
|
934
|
-
|
|
935
|
-
| Parameter | Type | Location | Required | Description |
|
|
936
|
-
| --- | --- | --- | --- | --- |
|
|
937
|
-
| `{module_key}` | object | body | Yes | Module configuration object. Keys vary per module. |
|
|
938
|
-
| `{module_key}.active` | string | body | Yes | Whether the module is enabled: `yes` or `no`. |
|
|
939
|
-
|
|
940
|
-
Only keys returned by `ModuleSettings::validKeys()` (derived from registered module fields) are accepted. Unrecognized keys are ignored.
|
|
941
|
-
|
|
942
|
-
#### Response
|
|
943
|
-
|
|
944
|
-
```
|
|
945
|
-
{
|
|
946
|
-
"message": "Settings saved successfully"
|
|
947
|
-
}
|
|
948
|
-
```
|
|
949
|
-
|
|
950
|
-
#### Example
|
|
951
|
-
|
|
952
|
-
```
|
|
953
|
-
curl -X POST "https://example.com/wp-json/fluent-cart/v2/settings/modules" \
|
|
954
|
-
-u "username:app_password" \
|
|
955
|
-
-H "Content-Type: application/json" \
|
|
956
|
-
-d '{
|
|
957
|
-
"shipping": {
|
|
958
|
-
"active": "yes"
|
|
959
|
-
},
|
|
960
|
-
"tax": {
|
|
961
|
-
"active": "no"
|
|
962
|
-
},
|
|
963
|
-
"coupons": {
|
|
964
|
-
"active": "yes"
|
|
965
|
-
}
|
|
966
|
-
}'
|
|
967
|
-
```
|
|
968
|
-
|
|
969
|
-
---
|
|
970
|
-
|
|
971
|
-
## Confirmation Pages
|
|
972
|
-
|
|
973
|
-
### Save Confirmation Settings
|
|
974
|
-
|
|
975
|
-
POST `/fluent-cart/v2/settings/confirmation`
|
|
976
|
-
|
|
977
|
-
Update the order confirmation/receipt page settings, including the confirmation type, message content, and the receipt page assignment.
|
|
978
|
-
|
|
979
|
-
- **Permission:** `is_super_admin`
|
|
980
|
-
|
|
981
|
-
#### Parameters
|
|
982
|
-
|
|
983
|
-
| Parameter | Type | Location | Required | Description |
|
|
984
|
-
| --- | --- | --- | --- | --- |
|
|
985
|
-
| `settings` | object | body | Yes | Confirmation settings object. |
|
|
986
|
-
| `settings.confirmation_type` | string | body | No | Confirmation behavior: `same_page` (show confirmation on same page) or `custom_page` (redirect to a custom page). |
|
|
987
|
-
| `settings.message_to_show` | string | body | No | HTML content to display as the order confirmation message. Sanitized with `wp_kses_post`. |
|
|
988
|
-
| `settings.confirmation_page_id` | integer | body | No | WordPress page ID for a custom confirmation/receipt page. Also updates the store's `receipt_page_id`. |
|
|
989
|
-
|
|
990
|
-
#### Response
|
|
991
|
-
|
|
992
|
-
```
|
|
993
|
-
{
|
|
994
|
-
"confirmation_type": "same_page",
|
|
995
|
-
"message_to_show": "<p>Thank you for your order!</p>"
|
|
996
|
-
}
|
|
997
|
-
```
|
|
998
|
-
|
|
999
|
-
#### Example
|
|
1000
|
-
|
|
1001
|
-
```
|
|
1002
|
-
curl -X POST "https://example.com/wp-json/fluent-cart/v2/settings/confirmation" \
|
|
1003
|
-
-u "username:app_password" \
|
|
1004
|
-
-H "Content-Type: application/json" \
|
|
1005
|
-
-d '{
|
|
1006
|
-
"settings": {
|
|
1007
|
-
"confirmation_type": "custom_page",
|
|
1008
|
-
"confirmation_page_id": 42,
|
|
1009
|
-
"message_to_show": "<h2>Order Confirmed!</h2><p>Thank you for your purchase.</p>"
|
|
1010
|
-
}
|
|
1011
|
-
}'
|
|
1012
|
-
```
|
|
1013
|
-
|
|
1014
|
-
---
|
|
1015
|
-
|
|
1016
|
-
### Get Email Shortcodes
|
|
1017
|
-
|
|
1018
|
-
GET `/fluent-cart/v2/settings/confirmation/shortcode`
|
|
1019
|
-
|
|
1020
|
-
Retrieve available shortcodes/merge tags that can be used in email notification templates and confirmation messages.
|
|
1021
|
-
|
|
1022
|
-
- **Permission:** `is_super_admin`
|
|
1023
|
-
|
|
1024
|
-
#### Parameters
|
|
1025
|
-
|
|
1026
|
-
None.
|
|
1027
|
-
|
|
1028
|
-
#### Response
|
|
1029
|
-
|
|
1030
|
-
```
|
|
1031
|
-
{
|
|
1032
|
-
"data": {
|
|
1033
|
-
"order": {
|
|
1034
|
-
"title": "Order",
|
|
1035
|
-
"shortcodes": {
|
|
1036
|
-
"{{order.id}}": "Order ID",
|
|
1037
|
-
"{{order.total}}": "Order Total",
|
|
1038
|
-
"{{order.status}}": "Order Status",
|
|
1039
|
-
...
|
|
1040
|
-
}
|
|
1041
|
-
},
|
|
1042
|
-
"customer": {
|
|
1043
|
-
"title": "Customer",
|
|
1044
|
-
"shortcodes": {
|
|
1045
|
-
"{{customer.first_name}}": "First Name",
|
|
1046
|
-
"{{customer.email}}": "Email",
|
|
1047
|
-
...
|
|
1048
|
-
}
|
|
1049
|
-
},
|
|
1050
|
-
"store": {
|
|
1051
|
-
"title": "Store",
|
|
1052
|
-
"shortcodes": {
|
|
1053
|
-
"{{store.name}}": "Store Name",
|
|
1054
|
-
...
|
|
1055
|
-
}
|
|
1056
|
-
}
|
|
1057
|
-
}
|
|
1058
|
-
}
|
|
1059
|
-
```
|
|
1060
|
-
|
|
1061
|
-
#### Example
|
|
1062
|
-
|
|
1063
|
-
```
|
|
1064
|
-
curl -X GET "https://example.com/wp-json/fluent-cart/v2/settings/confirmation/shortcode" \
|
|
1065
|
-
-u "username:app_password"
|
|
1066
|
-
```
|
|
1067
|
-
|
|
1068
|
-
---
|
|
1069
|
-
|
|
1070
|
-
## Storage Drivers
|
|
1071
|
-
|
|
1072
|
-
Manage file storage drivers for digital product delivery (e.g., local filesystem, Amazon S3, Bunny CDN).
|
|
1073
|
-
|
|
1074
|
-
### List All Storage Drivers
|
|
1075
|
-
|
|
1076
|
-
GET `/fluent-cart/v2/settings/storage-drivers`
|
|
1077
|
-
|
|
1078
|
-
Retrieve all registered file storage drivers and their current status.
|
|
1079
|
-
|
|
1080
|
-
- **Permission:** `is_super_admin`
|
|
1081
|
-
|
|
1082
|
-
#### Parameters
|
|
1083
|
-
|
|
1084
|
-
None.
|
|
1085
|
-
|
|
1086
|
-
#### Response
|
|
1087
|
-
|
|
1088
|
-
```
|
|
1089
|
-
{
|
|
1090
|
-
"drivers": {
|
|
1091
|
-
"local": {
|
|
1092
|
-
"title": "Local",
|
|
1093
|
-
"route": "local",
|
|
1094
|
-
"description": "Local allows to upload file in local file storage",
|
|
1095
|
-
"logo": "https://example.com/wp-content/plugins/fluent-cart/assets/images/storage-drivers/local.svg",
|
|
1096
|
-
"dark_logo": null,
|
|
1097
|
-
"status": true,
|
|
1098
|
-
"brand_color": "#136196",
|
|
1099
|
-
"has_bucket": false,
|
|
1100
|
-
"instance": { "slug": "local", "title": "Local", "brandColor": "#136196" }
|
|
1101
|
-
},
|
|
1102
|
-
"s3": {
|
|
1103
|
-
"title": "Amazon S3",
|
|
1104
|
-
"route": "s3",
|
|
1105
|
-
"status": false,
|
|
1106
|
-
"has_bucket": true,
|
|
1107
|
-
"need_reconfigure": false,
|
|
1108
|
-
"buckets": []
|
|
1109
|
-
},
|
|
1110
|
-
"r2": {
|
|
1111
|
-
"title": "Cloudflare R2",
|
|
1112
|
-
"route": "r2",
|
|
1113
|
-
"status": false,
|
|
1114
|
-
"has_bucket": true,
|
|
1115
|
-
"need_reconfigure": false,
|
|
1116
|
-
"buckets": []
|
|
1117
|
-
}
|
|
1118
|
-
}
|
|
1119
|
-
}
|
|
1120
|
-
```
|
|
1121
|
-
|
|
1122
|
-
#### Example
|
|
1123
|
-
|
|
1124
|
-
```
|
|
1125
|
-
curl -X GET "https://example.com/wp-json/fluent-cart/v2/settings/storage-drivers" \
|
|
1126
|
-
-u "username:app_password"
|
|
1127
|
-
```
|
|
1128
|
-
|
|
1129
|
-
---
|
|
1130
|
-
|
|
1131
|
-
### Save Storage Driver Settings
|
|
1132
|
-
|
|
1133
|
-
POST `/fluent-cart/v2/settings/storage-drivers`
|
|
1134
|
-
|
|
1135
|
-
Create or update settings for a specific file storage driver.
|
|
1136
|
-
|
|
1137
|
-
- **Permission:** `is_super_admin`
|
|
1138
|
-
|
|
1139
|
-
#### Parameters
|
|
1140
|
-
|
|
1141
|
-
| Parameter | Type | Location | Required | Description |
|
|
1142
|
-
| --- | --- | --- | --- | --- |
|
|
1143
|
-
| `driver` | string | body | Yes | The storage driver key (e.g., `local`, `s3`, `bunny`). |
|
|
1144
|
-
| `settings` | object | body | Yes | Driver-specific configuration settings. Fields vary by driver. |
|
|
1145
|
-
|
|
1146
|
-
#### Response
|
|
1147
|
-
|
|
1148
|
-
```
|
|
1149
|
-
{
|
|
1150
|
-
"message": "Settings saved successfully",
|
|
1151
|
-
"data": { ... }
|
|
1152
|
-
}
|
|
1153
|
-
```
|
|
1154
|
-
|
|
1155
|
-
#### Example
|
|
1156
|
-
|
|
1157
|
-
```
|
|
1158
|
-
curl -X POST "https://example.com/wp-json/fluent-cart/v2/settings/storage-drivers" \
|
|
1159
|
-
-u "username:app_password" \
|
|
1160
|
-
-H "Content-Type: application/json" \
|
|
1161
|
-
-d '{
|
|
1162
|
-
"driver": "s3",
|
|
1163
|
-
"settings": {
|
|
1164
|
-
"access_key": "AKIA...",
|
|
1165
|
-
"secret_key": "wJalr...",
|
|
1166
|
-
"bucket": "my-store-files",
|
|
1167
|
-
"region": "us-east-1"
|
|
1168
|
-
}
|
|
1169
|
-
}'
|
|
1170
|
-
```
|
|
1171
|
-
|
|
1172
|
-
---
|
|
1173
|
-
|
|
1174
|
-
### Get Active Storage Drivers
|
|
1175
|
-
|
|
1176
|
-
GET `/fluent-cart/v2/settings/storage-drivers/active-drivers`
|
|
1177
|
-
|
|
1178
|
-
Retrieve only the currently active/enabled file storage drivers.
|
|
1179
|
-
|
|
1180
|
-
- **Permission:** `is_super_admin`
|
|
1181
|
-
|
|
1182
|
-
#### Parameters
|
|
1183
|
-
|
|
1184
|
-
None.
|
|
1185
|
-
|
|
1186
|
-
#### Response
|
|
1187
|
-
|
|
1188
|
-
```
|
|
1189
|
-
{
|
|
1190
|
-
"drivers": [
|
|
1191
|
-
{
|
|
1192
|
-
"key": "local",
|
|
1193
|
-
"title": "Local Storage",
|
|
1194
|
-
"is_active": true,
|
|
1195
|
-
...
|
|
1196
|
-
}
|
|
1197
|
-
]
|
|
1198
|
-
}
|
|
1199
|
-
```
|
|
1200
|
-
|
|
1201
|
-
#### Example
|
|
1202
|
-
|
|
1203
|
-
```
|
|
1204
|
-
curl -X GET "https://example.com/wp-json/fluent-cart/v2/settings/storage-drivers/active-drivers" \
|
|
1205
|
-
-u "username:app_password"
|
|
1206
|
-
```
|
|
1207
|
-
|
|
1208
|
-
---
|
|
1209
|
-
|
|
1210
|
-
### Get Storage Driver Settings
|
|
1211
|
-
|
|
1212
|
-
GET `/fluent-cart/v2/settings/storage-drivers/{driver}`
|
|
1213
|
-
|
|
1214
|
-
Retrieve the configuration settings and field schema for a specific storage driver.
|
|
1215
|
-
|
|
1216
|
-
- **Permission:** `is_super_admin`
|
|
1217
|
-
|
|
1218
|
-
#### Parameters
|
|
1219
|
-
|
|
1220
|
-
| Parameter | Type | Location | Required | Description |
|
|
1221
|
-
| --- | --- | --- | --- | --- |
|
|
1222
|
-
| `driver` | string | path | Yes | The storage driver key (e.g., `local`, `s3`, `bunny`). |
|
|
1223
|
-
|
|
1224
|
-
#### Response
|
|
1225
|
-
|
|
1226
|
-
```
|
|
1227
|
-
{
|
|
1228
|
-
"settings": {
|
|
1229
|
-
"access_key": "AKIA...",
|
|
1230
|
-
"secret_key": "****",
|
|
1231
|
-
"bucket": "my-store-files",
|
|
1232
|
-
"region": "us-east-1"
|
|
1233
|
-
},
|
|
1234
|
-
"fields": { ... }
|
|
1235
|
-
}
|
|
1236
|
-
```
|
|
1237
|
-
|
|
1238
|
-
#### Example
|
|
1239
|
-
|
|
1240
|
-
```
|
|
1241
|
-
curl -X GET "https://example.com/wp-json/fluent-cart/v2/settings/storage-drivers/s3" \
|
|
1242
|
-
-u "username:app_password"
|
|
1243
|
-
```
|
|
1244
|
-
|
|
1245
|
-
---
|
|
1246
|
-
|
|
1247
|
-
### Verify Storage Driver Connection
|
|
1248
|
-
|
|
1249
|
-
POST `/fluent-cart/v2/settings/storage-drivers/verify-info`
|
|
1250
|
-
|
|
1251
|
-
Test the connection to a storage driver using the provided credentials without saving them.
|
|
1252
|
-
|
|
1253
|
-
- **Permission:** `is_super_admin`
|
|
1254
|
-
|
|
1255
|
-
#### Parameters
|
|
1256
|
-
|
|
1257
|
-
| Parameter | Type | Location | Required | Description |
|
|
1258
|
-
| --- | --- | --- | --- | --- |
|
|
1259
|
-
| `driver` | string | body | Yes | The storage driver key (e.g., `s3`, `bunny`). |
|
|
1260
|
-
| `settings` | object | body | Yes | Driver-specific credentials and configuration to verify. Fields vary by driver. |
|
|
1261
|
-
|
|
1262
|
-
#### Response
|
|
1263
|
-
|
|
1264
|
-
```
|
|
1265
|
-
{
|
|
1266
|
-
"message": "Connection verified successfully"
|
|
1267
|
-
}
|
|
1268
|
-
```
|
|
1269
|
-
|
|
1270
|
-
#### Example
|
|
1271
|
-
|
|
1272
|
-
```
|
|
1273
|
-
curl -X POST "https://example.com/wp-json/fluent-cart/v2/settings/storage-drivers/verify-info" \
|
|
1274
|
-
-u "username:app_password" \
|
|
1275
|
-
-H "Content-Type: application/json" \
|
|
1276
|
-
-d '{
|
|
1277
|
-
"driver": "s3",
|
|
1278
|
-
"settings": {
|
|
1279
|
-
"access_key": "AKIA...",
|
|
1280
|
-
"secret_key": "wJalr...",
|
|
1281
|
-
"bucket": "my-store-files",
|
|
1282
|
-
"region": "us-east-1"
|
|
1283
|
-
}
|
|
1284
|
-
}'
|
|
1285
|
-
```
|
|
1286
|
-
|
|
1287
|
-
---
|
|
1288
|
-
|
|
1289
|
-
## Checkout Fields
|
|
1290
|
-
|
|
1291
|
-
Manage which fields are displayed on the checkout form and their required/optional status.
|
|
1292
|
-
|
|
1293
|
-
**Base URL:** `https://your-site.com/wp-json/fluent-cart/v2/checkout-fields`
|
|
1294
|
-
|
|
1295
|
-
**Policy:** `StoreSensitivePolicy` (requires `store/sensitive` capability)
|
|
1296
|
-
|
|
1297
|
-
### Get Checkout Fields
|
|
1298
|
-
|
|
1299
|
-
GET `/fluent-cart/v2/checkout-fields/get-fields`
|
|
1300
|
-
|
|
1301
|
-
Retrieve the checkout field configuration including the schema definition and current settings.
|
|
1302
|
-
|
|
1303
|
-
- **Permission:** `store/sensitive`
|
|
1304
|
-
|
|
1305
|
-
#### Parameters
|
|
1306
|
-
|
|
1307
|
-
None.
|
|
1308
|
-
|
|
1309
|
-
#### Response
|
|
1310
|
-
|
|
1311
|
-
```
|
|
1312
|
-
{
|
|
1313
|
-
"fields": {
|
|
1314
|
-
"basic_info": {
|
|
1315
|
-
"full_name": {
|
|
1316
|
-
"label": "Full Name",
|
|
1317
|
-
"type": "text",
|
|
1318
|
-
"configurable": true
|
|
1319
|
-
},
|
|
1320
|
-
"first_name": {
|
|
1321
|
-
"label": "First Name",
|
|
1322
|
-
"type": "text",
|
|
1323
|
-
"configurable": true
|
|
1324
|
-
},
|
|
1325
|
-
"last_name": {
|
|
1326
|
-
"label": "Last Name",
|
|
1327
|
-
"type": "text",
|
|
1328
|
-
"configurable": true
|
|
1329
|
-
},
|
|
1330
|
-
"email": {
|
|
1331
|
-
"label": "Email",
|
|
1332
|
-
"type": "email",
|
|
1333
|
-
"configurable": false
|
|
1334
|
-
}
|
|
1335
|
-
},
|
|
1336
|
-
"billing_address": { ... },
|
|
1337
|
-
"shipping_address": { ... }
|
|
1338
|
-
},
|
|
1339
|
-
"settings": {
|
|
1340
|
-
"basic_info": {
|
|
1341
|
-
"full_name": {
|
|
1342
|
-
"enabled": "yes",
|
|
1343
|
-
"required": "yes"
|
|
1344
|
-
},
|
|
1345
|
-
"first_name": {
|
|
1346
|
-
"enabled": "no",
|
|
1347
|
-
"required": "no"
|
|
1348
|
-
},
|
|
1349
|
-
"last_name": {
|
|
1350
|
-
"enabled": "no",
|
|
1351
|
-
"required": "no"
|
|
1352
|
-
}
|
|
1353
|
-
},
|
|
1354
|
-
"billing_address": { ... },
|
|
1355
|
-
"shipping_address": { ... }
|
|
1356
|
-
}
|
|
1357
|
-
}
|
|
1358
|
-
```
|
|
1359
|
-
|
|
1360
|
-
#### Example
|
|
1361
|
-
|
|
1362
|
-
```
|
|
1363
|
-
curl -X GET "https://example.com/wp-json/fluent-cart/v2/checkout-fields/get-fields" \
|
|
1364
|
-
-u "username:app_password"
|
|
1365
|
-
```
|
|
1366
|
-
|
|
1367
|
-
---
|
|
1368
|
-
|
|
1369
|
-
### Save Checkout Fields
|
|
1370
|
-
|
|
1371
|
-
POST `/fluent-cart/v2/checkout-fields/save-fields`
|
|
1372
|
-
|
|
1373
|
-
Update the checkout field visibility and required settings. The endpoint enforces name field logic automatically:
|
|
1374
|
-
|
|
1375
|
-
- If `first_name` or `last_name` is enabled, `full_name` is automatically disabled.
|
|
1376
|
-
- If neither `first_name` nor `last_name` is enabled, `full_name` is automatically enabled and marked as required.
|
|
1377
|
-
- If `first_name` is enabled, it is forced to be required. Same for `last_name`.
|
|
1378
|
-
- **Permission:** `store/sensitive`
|
|
1379
|
-
|
|
1380
|
-
#### Parameters
|
|
1381
|
-
|
|
1382
|
-
| Parameter | Type | Location | Required | Description |
|
|
1383
|
-
| --- | --- | --- | --- | --- |
|
|
1384
|
-
| `settings` | object | body | Yes | Checkout field settings object. Only keys matching existing settings are accepted. |
|
|
1385
|
-
| `settings.basic_info` | object | body | No | Basic information field settings. |
|
|
1386
|
-
| `settings.basic_info.{field}.enabled` | string | body | No | Whether the field is shown: `yes` or `no`. |
|
|
1387
|
-
| `settings.basic_info.{field}.required` | string | body | No | Whether the field is required: `yes` or `no`. |
|
|
1388
|
-
| `settings.billing_address` | object | body | No | Billing address field settings (same structure as `basic_info`). |
|
|
1389
|
-
| `settings.shipping_address` | object | body | No | Shipping address field settings (same structure as `basic_info`). |
|
|
1390
|
-
|
|
1391
|
-
#### Response
|
|
1392
|
-
|
|
1393
|
-
```
|
|
1394
|
-
{
|
|
1395
|
-
"message": "Checkout fields has been updated successfully."
|
|
1396
|
-
}
|
|
1397
|
-
```
|
|
1398
|
-
|
|
1399
|
-
#### Example
|
|
1400
|
-
|
|
1401
|
-
```
|
|
1402
|
-
curl -X POST "https://example.com/wp-json/fluent-cart/v2/checkout-fields/save-fields" \
|
|
1403
|
-
-u "username:app_password" \
|
|
1404
|
-
-H "Content-Type: application/json" \
|
|
1405
|
-
-d '{
|
|
1406
|
-
"settings": {
|
|
1407
|
-
"basic_info": {
|
|
1408
|
-
"full_name": {
|
|
1409
|
-
"enabled": "no",
|
|
1410
|
-
"required": "no"
|
|
1411
|
-
},
|
|
1412
|
-
"first_name": {
|
|
1413
|
-
"enabled": "yes",
|
|
1414
|
-
"required": "yes"
|
|
1415
|
-
},
|
|
1416
|
-
"last_name": {
|
|
1417
|
-
"enabled": "yes",
|
|
1418
|
-
"required": "no"
|
|
1419
|
-
}
|
|
1420
|
-
}
|
|
1421
|
-
}
|
|
1422
|
-
}'
|
|
1423
|
-
```
|
|
1
|
+
# Settings API
|
|
2
|
+
|
|
3
|
+
Configure your store settings, payment gateways, modules, file storage, checkout fields, and permissions.
|
|
4
|
+
|
|
5
|
+
**Base URL:** `https://your-site.com/wp-json/fluent-cart/v2/settings`
|
|
6
|
+
|
|
7
|
+
**Policy:** `StoreSettingsPolicy` (most endpoints require `is_super_admin`)
|
|
8
|
+
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
## Payment Methods
|
|
12
|
+
|
|
13
|
+
### Get Payment Method Settings
|
|
14
|
+
|
|
15
|
+
GET `/fluent-cart/v2/settings/payment-methods`
|
|
16
|
+
|
|
17
|
+
Retrieve the configuration and settings for a specific payment method gateway (e.g., Stripe, PayPal).
|
|
18
|
+
|
|
19
|
+
- **Permission:** `is_super_admin`
|
|
20
|
+
|
|
21
|
+
#### Parameters
|
|
22
|
+
|
|
23
|
+
| Parameter | Type | Location | Required | Description |
|
|
24
|
+
| --- | --- | --- | --- | --- |
|
|
25
|
+
| `method` | string | query | Yes | The payment method key to retrieve settings for (e.g., `stripe`, `paypal`, `cod`). |
|
|
26
|
+
|
|
27
|
+
#### Response
|
|
28
|
+
|
|
29
|
+
```
|
|
30
|
+
{
|
|
31
|
+
"settings": {
|
|
32
|
+
"is_active": "yes",
|
|
33
|
+
"payment_mode": "live",
|
|
34
|
+
"checkout_label": "Pay with Stripe",
|
|
35
|
+
"checkout_logo": "https://example.com/stripe-logo.png",
|
|
36
|
+
"checkout_instructions": "",
|
|
37
|
+
"thank_you_page_instructions": ""
|
|
38
|
+
},
|
|
39
|
+
"fields": { ... }
|
|
40
|
+
}
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
#### Example
|
|
44
|
+
|
|
45
|
+
```
|
|
46
|
+
curl -X GET "https://example.com/wp-json/fluent-cart/v2/settings/payment-methods?method=stripe" \
|
|
47
|
+
-u "username:app_password"
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
---
|
|
51
|
+
|
|
52
|
+
### Save Payment Method Settings
|
|
53
|
+
|
|
54
|
+
POST `/fluent-cart/v2/settings/payment-methods`
|
|
55
|
+
|
|
56
|
+
Create or update the configuration for a specific payment method gateway.
|
|
57
|
+
|
|
58
|
+
- **Permission:** `is_super_admin`
|
|
59
|
+
|
|
60
|
+
#### Parameters
|
|
61
|
+
|
|
62
|
+
| Parameter | Type | Location | Required | Description |
|
|
63
|
+
| --- | --- | --- | --- | --- |
|
|
64
|
+
| `method` | string | body | Yes | The payment method key (e.g., `stripe`, `paypal`, `cod`). |
|
|
65
|
+
| `settings` | object | body | Yes | Key-value object of gateway-specific settings to save. Fields vary by payment method. |
|
|
66
|
+
|
|
67
|
+
#### Response
|
|
68
|
+
|
|
69
|
+
```
|
|
70
|
+
{
|
|
71
|
+
"settings": {
|
|
72
|
+
"is_active": "yes",
|
|
73
|
+
"payment_mode": "live",
|
|
74
|
+
...
|
|
75
|
+
},
|
|
76
|
+
"message": "Settings saved successfully"
|
|
77
|
+
}
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
#### Example
|
|
81
|
+
|
|
82
|
+
```
|
|
83
|
+
curl -X POST "https://example.com/wp-json/fluent-cart/v2/settings/payment-methods" \
|
|
84
|
+
-u "username:app_password" \
|
|
85
|
+
-H "Content-Type: application/json" \
|
|
86
|
+
-d '{
|
|
87
|
+
"method": "cod",
|
|
88
|
+
"settings": {
|
|
89
|
+
"is_active": "yes",
|
|
90
|
+
"checkout_label": "Cash on Delivery"
|
|
91
|
+
}
|
|
92
|
+
}'
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
---
|
|
96
|
+
|
|
97
|
+
### List All Payment Methods
|
|
98
|
+
|
|
99
|
+
GET `/fluent-cart/v2/settings/payment-methods/all`
|
|
100
|
+
|
|
101
|
+
Retrieve all registered payment method gateways categorized by availability status.
|
|
102
|
+
|
|
103
|
+
- **Permission:** `is_super_admin`
|
|
104
|
+
|
|
105
|
+
#### Parameters
|
|
106
|
+
|
|
107
|
+
None.
|
|
108
|
+
|
|
109
|
+
#### Response
|
|
110
|
+
|
|
111
|
+
```
|
|
112
|
+
{
|
|
113
|
+
"gateways": [
|
|
114
|
+
{
|
|
115
|
+
"method_key": "stripe",
|
|
116
|
+
"title": "Stripe",
|
|
117
|
+
"is_active": "yes",
|
|
118
|
+
"description": "Accept payments via Stripe",
|
|
119
|
+
"logo": "https://...",
|
|
120
|
+
"upcoming": false
|
|
121
|
+
},
|
|
122
|
+
{
|
|
123
|
+
"method_key": "paypal",
|
|
124
|
+
"title": "PayPal",
|
|
125
|
+
"is_active": "no",
|
|
126
|
+
"requires_pro": true
|
|
127
|
+
}
|
|
128
|
+
]
|
|
129
|
+
}
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
Gateways are sorted in order: available gateways first, then those requiring Pro, then upcoming.
|
|
133
|
+
|
|
134
|
+
#### Example
|
|
135
|
+
|
|
136
|
+
```
|
|
137
|
+
curl -X GET "https://example.com/wp-json/fluent-cart/v2/settings/payment-methods/all" \
|
|
138
|
+
-u "username:app_password"
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
---
|
|
142
|
+
|
|
143
|
+
### Reorder Payment Methods
|
|
144
|
+
|
|
145
|
+
POST `/fluent-cart/v2/settings/payment-methods/reorder`
|
|
146
|
+
|
|
147
|
+
Set the display order of payment methods on the checkout page.
|
|
148
|
+
|
|
149
|
+
- **Permission:** `is_super_admin`
|
|
150
|
+
|
|
151
|
+
#### Parameters
|
|
152
|
+
|
|
153
|
+
| Parameter | Type | Location | Required | Description |
|
|
154
|
+
| --- | --- | --- | --- | --- |
|
|
155
|
+
| `order` | array | body | Yes | Ordered array of payment method keys (e.g., `["stripe", "paypal", "cod"]`). |
|
|
156
|
+
|
|
157
|
+
#### Response
|
|
158
|
+
|
|
159
|
+
```
|
|
160
|
+
{
|
|
161
|
+
"message": "Payment methods order saved successfully",
|
|
162
|
+
"order": ["stripe", "paypal", "cod"]
|
|
163
|
+
}
|
|
164
|
+
```
|
|
165
|
+
|
|
166
|
+
#### Example
|
|
167
|
+
|
|
168
|
+
```
|
|
169
|
+
curl -X POST "https://example.com/wp-json/fluent-cart/v2/settings/payment-methods/reorder" \
|
|
170
|
+
-u "username:app_password" \
|
|
171
|
+
-H "Content-Type: application/json" \
|
|
172
|
+
-d '{
|
|
173
|
+
"order": ["stripe", "paypal", "cod"]
|
|
174
|
+
}'
|
|
175
|
+
```
|
|
176
|
+
|
|
177
|
+
---
|
|
178
|
+
|
|
179
|
+
### Get Payment Method Connection Info
|
|
180
|
+
|
|
181
|
+
GET `/fluent-cart/v2/settings/payment-methods/connect/info`
|
|
182
|
+
|
|
183
|
+
Retrieve connection information (OAuth URLs, account status) for a connectable payment gateway.
|
|
184
|
+
|
|
185
|
+
- **Permission:** `is_super_admin`
|
|
186
|
+
|
|
187
|
+
#### Parameters
|
|
188
|
+
|
|
189
|
+
| Parameter | Type | Location | Required | Description |
|
|
190
|
+
| --- | --- | --- | --- | --- |
|
|
191
|
+
| `method` | string | query | Yes | The payment method key (e.g., `stripe`, `paypal`). |
|
|
192
|
+
|
|
193
|
+
#### Response
|
|
194
|
+
|
|
195
|
+
The response structure varies by gateway. For Stripe, it may include OAuth redirect URLs and connected account information. For PayPal, it includes test/live redirect URLs and account details.
|
|
196
|
+
|
|
197
|
+
```
|
|
198
|
+
{
|
|
199
|
+
"connect_config": {
|
|
200
|
+
"test_redirect": "https://example.com/wp-admin/?fluent-cart=...",
|
|
201
|
+
"live_redirect": "https://example.com/wp-admin/?fluent-cart=...",
|
|
202
|
+
"disconnect_note": "Disconnecting will prevent..."
|
|
203
|
+
},
|
|
204
|
+
"test_account": { ... },
|
|
205
|
+
"live_account": { ... },
|
|
206
|
+
"settings": { ... }
|
|
207
|
+
}
|
|
208
|
+
```
|
|
209
|
+
|
|
210
|
+
#### Example
|
|
211
|
+
|
|
212
|
+
```
|
|
213
|
+
curl -X GET "https://example.com/wp-json/fluent-cart/v2/settings/payment-methods/connect/info?method=paypal" \
|
|
214
|
+
-u "username:app_password"
|
|
215
|
+
```
|
|
216
|
+
|
|
217
|
+
---
|
|
218
|
+
|
|
219
|
+
### Disconnect Payment Method
|
|
220
|
+
|
|
221
|
+
POST `/fluent-cart/v2/settings/payment-methods/disconnect`
|
|
222
|
+
|
|
223
|
+
Disconnect a payment gateway account (e.g., revoke Stripe or PayPal connection).
|
|
224
|
+
|
|
225
|
+
- **Permission:** `is_super_admin`
|
|
226
|
+
|
|
227
|
+
#### Parameters
|
|
228
|
+
|
|
229
|
+
| Parameter | Type | Location | Required | Description |
|
|
230
|
+
| --- | --- | --- | --- | --- |
|
|
231
|
+
| `method` | string | body | Yes | The payment method key to disconnect (e.g., `stripe`, `paypal`). |
|
|
232
|
+
| `mode` | string | body | Yes | The environment mode to disconnect: `test` or `live`. |
|
|
233
|
+
|
|
234
|
+
#### Response
|
|
235
|
+
|
|
236
|
+
```
|
|
237
|
+
{
|
|
238
|
+
"message": "PayPal settings has been disconnected",
|
|
239
|
+
"settings": { ... }
|
|
240
|
+
}
|
|
241
|
+
```
|
|
242
|
+
|
|
243
|
+
#### Example
|
|
244
|
+
|
|
245
|
+
```
|
|
246
|
+
curl -X POST "https://example.com/wp-json/fluent-cart/v2/settings/payment-methods/disconnect" \
|
|
247
|
+
-u "username:app_password" \
|
|
248
|
+
-H "Content-Type: application/json" \
|
|
249
|
+
-d '{
|
|
250
|
+
"method": "paypal",
|
|
251
|
+
"mode": "test"
|
|
252
|
+
}'
|
|
253
|
+
```
|
|
254
|
+
|
|
255
|
+
---
|
|
256
|
+
|
|
257
|
+
### Save Payment Method Design
|
|
258
|
+
|
|
259
|
+
POST `/fluent-cart/v2/settings/payment-methods/design`
|
|
260
|
+
|
|
261
|
+
Customize the checkout appearance for a specific payment method, including its label, logo, and instructions.
|
|
262
|
+
|
|
263
|
+
- **Permission:** `is_super_admin`
|
|
264
|
+
|
|
265
|
+
#### Parameters
|
|
266
|
+
|
|
267
|
+
| Parameter | Type | Location | Required | Description |
|
|
268
|
+
| --- | --- | --- | --- | --- |
|
|
269
|
+
| `method` | string | body | Yes | The payment method key (e.g., `stripe`, `paypal`, `cod`). |
|
|
270
|
+
| `checkout_label` | string | body | No | Custom label displayed on the checkout form for this method. |
|
|
271
|
+
| `checkout_logo` | string | body | No | URL to a custom logo image for the checkout form. |
|
|
272
|
+
| `checkout_instructions` | string | body | No | HTML instructions shown on the checkout page when this method is selected. |
|
|
273
|
+
| `thank_you_page_instructions` | string | body | No | HTML instructions shown on the thank-you/receipt page. |
|
|
274
|
+
|
|
275
|
+
#### Response
|
|
276
|
+
|
|
277
|
+
```
|
|
278
|
+
{
|
|
279
|
+
"message": "Checkout design settings saved",
|
|
280
|
+
"settings": { ... }
|
|
281
|
+
}
|
|
282
|
+
```
|
|
283
|
+
|
|
284
|
+
#### Example
|
|
285
|
+
|
|
286
|
+
```
|
|
287
|
+
curl -X POST "https://example.com/wp-json/fluent-cart/v2/settings/payment-methods/design" \
|
|
288
|
+
-u "username:app_password" \
|
|
289
|
+
-H "Content-Type: application/json" \
|
|
290
|
+
-d '{
|
|
291
|
+
"method": "stripe",
|
|
292
|
+
"checkout_label": "Credit / Debit Card",
|
|
293
|
+
"checkout_logo": "https://example.com/card-icon.png",
|
|
294
|
+
"checkout_instructions": "<p>You will be charged securely via Stripe.</p>"
|
|
295
|
+
}'
|
|
296
|
+
```
|
|
297
|
+
|
|
298
|
+
---
|
|
299
|
+
|
|
300
|
+
### Install Payment Addon
|
|
301
|
+
|
|
302
|
+
POST `/fluent-cart/v2/settings/payment-methods/install-addon`
|
|
303
|
+
|
|
304
|
+
Install a payment gateway addon plugin from a remote source (WordPress.org or GitHub).
|
|
305
|
+
|
|
306
|
+
- **Permission:** `is_super_admin`
|
|
307
|
+
|
|
308
|
+
#### Parameters
|
|
309
|
+
|
|
310
|
+
| Parameter | Type | Location | Required | Description |
|
|
311
|
+
| --- | --- | --- | --- | --- |
|
|
312
|
+
| `plugin_slug` | string | body | Yes | The slug of the plugin to install (e.g., `fluent-cart-pro`). |
|
|
313
|
+
| `source_type` | string | body | Yes | Source type: `wordpress` (WordPress.org) or `github`. |
|
|
314
|
+
| `source_link` | string | body | Conditional | The URL to the plugin source. Required when `source_type` is `github`. |
|
|
315
|
+
|
|
316
|
+
#### Response
|
|
317
|
+
|
|
318
|
+
```
|
|
319
|
+
{
|
|
320
|
+
"message": "Payment addon installed successfully!",
|
|
321
|
+
"plugin_file": "fluent-cart-pro/fluent-cart-pro.php"
|
|
322
|
+
}
|
|
323
|
+
```
|
|
324
|
+
|
|
325
|
+
#### Example
|
|
326
|
+
|
|
327
|
+
```
|
|
328
|
+
curl -X POST "https://example.com/wp-json/fluent-cart/v2/settings/payment-methods/install-addon" \
|
|
329
|
+
-u "username:app_password" \
|
|
330
|
+
-H "Content-Type: application/json" \
|
|
331
|
+
-d '{
|
|
332
|
+
"plugin_slug": "fluent-cart-pro",
|
|
333
|
+
"source_type": "wordpress"
|
|
334
|
+
}'
|
|
335
|
+
```
|
|
336
|
+
|
|
337
|
+
---
|
|
338
|
+
|
|
339
|
+
### Activate Payment Addon
|
|
340
|
+
|
|
341
|
+
POST `/fluent-cart/v2/settings/payment-methods/activate-addon`
|
|
342
|
+
|
|
343
|
+
Activate an already-installed payment gateway addon plugin.
|
|
344
|
+
|
|
345
|
+
- **Permission:** `is_super_admin`
|
|
346
|
+
|
|
347
|
+
#### Parameters
|
|
348
|
+
|
|
349
|
+
| Parameter | Type | Location | Required | Description |
|
|
350
|
+
| --- | --- | --- | --- | --- |
|
|
351
|
+
| `plugin_file` | string | body | Yes | The plugin file path (e.g., `fluent-cart-pro/fluent-cart-pro.php`). |
|
|
352
|
+
|
|
353
|
+
#### Response
|
|
354
|
+
|
|
355
|
+
```
|
|
356
|
+
{
|
|
357
|
+
"message": "Payment addon activated successfully!"
|
|
358
|
+
}
|
|
359
|
+
```
|
|
360
|
+
|
|
361
|
+
For FluentCart Pro specifically:
|
|
362
|
+
|
|
363
|
+
```
|
|
364
|
+
{
|
|
365
|
+
"message": "FluentCart Pro activated successfully! All premium features are now available."
|
|
366
|
+
}
|
|
367
|
+
```
|
|
368
|
+
|
|
369
|
+
#### Example
|
|
370
|
+
|
|
371
|
+
```
|
|
372
|
+
curl -X POST "https://example.com/wp-json/fluent-cart/v2/settings/payment-methods/activate-addon" \
|
|
373
|
+
-u "username:app_password" \
|
|
374
|
+
-H "Content-Type: application/json" \
|
|
375
|
+
-d '{
|
|
376
|
+
"plugin_file": "fluent-cart-pro/fluent-cart-pro.php"
|
|
377
|
+
}'
|
|
378
|
+
```
|
|
379
|
+
|
|
380
|
+
---
|
|
381
|
+
|
|
382
|
+
## PayPal Configuration
|
|
383
|
+
|
|
384
|
+
These endpoints are used during the PayPal gateway onboarding and webhook setup process.
|
|
385
|
+
|
|
386
|
+
**Policy:** `AdminPolicy` (requires `super_admin`)
|
|
387
|
+
|
|
388
|
+
### Exchange PayPal Seller Auth Token
|
|
389
|
+
|
|
390
|
+
POST `/fluent-cart/v2/settings/payment-methods/paypal/seller-auth-token`
|
|
391
|
+
|
|
392
|
+
Exchange the PayPal authorization code for a seller access token during the PayPal Connect onboarding flow. This retrieves merchant credentials and saves them to the gateway settings.
|
|
393
|
+
|
|
394
|
+
- **Permission:** `super_admin`
|
|
395
|
+
|
|
396
|
+
#### Parameters
|
|
397
|
+
|
|
398
|
+
| Parameter | Type | Location | Required | Description |
|
|
399
|
+
| --- | --- | --- | --- | --- |
|
|
400
|
+
| `authCode` | string | body | Yes | The authorization code received from PayPal OAuth redirect. |
|
|
401
|
+
| `sharedId` | string | body | Yes | The PayPal partner shared/client ID used during authentication. |
|
|
402
|
+
| `mode` | string | body | Yes | Environment mode: `test` or `live`. |
|
|
403
|
+
|
|
404
|
+
#### Response
|
|
405
|
+
|
|
406
|
+
On success, credentials are saved to the PayPal gateway settings and webhooks are automatically registered. No explicit JSON response body is returned.
|
|
407
|
+
|
|
408
|
+
#### Example
|
|
409
|
+
|
|
410
|
+
```
|
|
411
|
+
curl -X POST "https://example.com/wp-json/fluent-cart/v2/settings/payment-methods/paypal/seller-auth-token" \
|
|
412
|
+
-u "username:app_password" \
|
|
413
|
+
-H "Content-Type: application/json" \
|
|
414
|
+
-d '{
|
|
415
|
+
"authCode": "C21AAF...",
|
|
416
|
+
"sharedId": "AaBbCc...",
|
|
417
|
+
"mode": "live"
|
|
418
|
+
}'
|
|
419
|
+
```
|
|
420
|
+
|
|
421
|
+
---
|
|
422
|
+
|
|
423
|
+
### Setup PayPal Webhook
|
|
424
|
+
|
|
425
|
+
POST `/fluent-cart/v2/settings/payment-methods/paypal/webhook/setup`
|
|
426
|
+
|
|
427
|
+
Register a webhook endpoint with PayPal to receive payment event notifications.
|
|
428
|
+
|
|
429
|
+
- **Permission:** `super_admin`
|
|
430
|
+
|
|
431
|
+
#### Parameters
|
|
432
|
+
|
|
433
|
+
| Parameter | Type | Location | Required | Description |
|
|
434
|
+
| --- | --- | --- | --- | --- |
|
|
435
|
+
| `mode` | string | body | Yes | Environment mode: `test` or `live`. |
|
|
436
|
+
|
|
437
|
+
#### Response
|
|
438
|
+
|
|
439
|
+
```
|
|
440
|
+
{
|
|
441
|
+
"message": "Webhook setup successfully! Please reload the page."
|
|
442
|
+
}
|
|
443
|
+
```
|
|
444
|
+
|
|
445
|
+
#### Example
|
|
446
|
+
|
|
447
|
+
```
|
|
448
|
+
curl -X POST "https://example.com/wp-json/fluent-cart/v2/settings/payment-methods/paypal/webhook/setup" \
|
|
449
|
+
-u "username:app_password" \
|
|
450
|
+
-H "Content-Type: application/json" \
|
|
451
|
+
-d '{
|
|
452
|
+
"mode": "live"
|
|
453
|
+
}'
|
|
454
|
+
```
|
|
455
|
+
|
|
456
|
+
---
|
|
457
|
+
|
|
458
|
+
### Check PayPal Webhook
|
|
459
|
+
|
|
460
|
+
GET `/fluent-cart/v2/settings/payment-methods/paypal/webhook/check`
|
|
461
|
+
|
|
462
|
+
Verify the current PayPal webhook registration status and set up the webhook if it is missing.
|
|
463
|
+
|
|
464
|
+
- **Permission:** `super_admin`
|
|
465
|
+
|
|
466
|
+
#### Parameters
|
|
467
|
+
|
|
468
|
+
| Parameter | Type | Location | Required | Description |
|
|
469
|
+
| --- | --- | --- | --- | --- |
|
|
470
|
+
| `mode` | string | query | Yes | Environment mode: `test` or `live`. |
|
|
471
|
+
|
|
472
|
+
#### Response
|
|
473
|
+
|
|
474
|
+
Returns the webhook status and configuration details from PayPal.
|
|
475
|
+
|
|
476
|
+
#### Example
|
|
477
|
+
|
|
478
|
+
```
|
|
479
|
+
curl -X GET "https://example.com/wp-json/fluent-cart/v2/settings/payment-methods/paypal/webhook/check?mode=live" \
|
|
480
|
+
-u "username:app_password"
|
|
481
|
+
```
|
|
482
|
+
|
|
483
|
+
---
|
|
484
|
+
|
|
485
|
+
## Permissions
|
|
486
|
+
|
|
487
|
+
### Get Permissions
|
|
488
|
+
|
|
489
|
+
GET `/fluent-cart/v2/settings/permissions`
|
|
490
|
+
|
|
491
|
+
Retrieve the current role-to-capability permission mappings for FluentCart.
|
|
492
|
+
|
|
493
|
+
- **Permission:** `is_super_admin`
|
|
494
|
+
|
|
495
|
+
#### Parameters
|
|
496
|
+
|
|
497
|
+
None.
|
|
498
|
+
|
|
499
|
+
#### Response
|
|
500
|
+
|
|
501
|
+
```
|
|
502
|
+
{
|
|
503
|
+
"roles": {
|
|
504
|
+
"administrator": {
|
|
505
|
+
"name": "Administrator",
|
|
506
|
+
"capabilities": {
|
|
507
|
+
"orders/view": true,
|
|
508
|
+
"orders/manage": true,
|
|
509
|
+
"customers/view": true,
|
|
510
|
+
"products/manage": true,
|
|
511
|
+
...
|
|
512
|
+
}
|
|
513
|
+
},
|
|
514
|
+
"shop_manager": {
|
|
515
|
+
"name": "Shop Manager",
|
|
516
|
+
"capabilities": { ... }
|
|
517
|
+
}
|
|
518
|
+
}
|
|
519
|
+
}
|
|
520
|
+
```
|
|
521
|
+
|
|
522
|
+
#### Example
|
|
523
|
+
|
|
524
|
+
```
|
|
525
|
+
curl -X GET "https://example.com/wp-json/fluent-cart/v2/settings/permissions" \
|
|
526
|
+
-u "username:app_password"
|
|
527
|
+
```
|
|
528
|
+
|
|
529
|
+
---
|
|
530
|
+
|
|
531
|
+
### Save Permissions
|
|
532
|
+
|
|
533
|
+
POST `/fluent-cart/v2/settings/permissions`
|
|
534
|
+
|
|
535
|
+
Update the role-to-capability permission mappings for FluentCart.
|
|
536
|
+
|
|
537
|
+
- **Permission:** `is_super_admin`
|
|
538
|
+
|
|
539
|
+
#### Parameters
|
|
540
|
+
|
|
541
|
+
| Parameter | Type | Location | Required | Description |
|
|
542
|
+
| --- | --- | --- | --- | --- |
|
|
543
|
+
| `capability` | object | body | Yes | An object mapping WordPress role slugs to their FluentCart capability assignments. |
|
|
544
|
+
|
|
545
|
+
#### Response
|
|
546
|
+
|
|
547
|
+
```
|
|
548
|
+
{
|
|
549
|
+
"message": "Permissions saved successfully"
|
|
550
|
+
}
|
|
551
|
+
```
|
|
552
|
+
|
|
553
|
+
#### Example
|
|
554
|
+
|
|
555
|
+
```
|
|
556
|
+
curl -X POST "https://example.com/wp-json/fluent-cart/v2/settings/permissions" \
|
|
557
|
+
-u "username:app_password" \
|
|
558
|
+
-H "Content-Type: application/json" \
|
|
559
|
+
-d '{
|
|
560
|
+
"capability": {
|
|
561
|
+
"shop_manager": {
|
|
562
|
+
"orders/view": true,
|
|
563
|
+
"orders/manage": true,
|
|
564
|
+
"customers/view": true,
|
|
565
|
+
"products/manage": false
|
|
566
|
+
}
|
|
567
|
+
}
|
|
568
|
+
}'
|
|
569
|
+
```
|
|
570
|
+
|
|
571
|
+
---
|
|
572
|
+
|
|
573
|
+
## Store Settings
|
|
574
|
+
|
|
575
|
+
### Get Store Settings
|
|
576
|
+
|
|
577
|
+
GET `/fluent-cart/v2/settings/store`
|
|
578
|
+
|
|
579
|
+
Retrieve all store configuration settings along with the field schema for a given settings tab.
|
|
580
|
+
|
|
581
|
+
- **Permission:** `store/settings`
|
|
582
|
+
|
|
583
|
+
#### Parameters
|
|
584
|
+
|
|
585
|
+
| Parameter | Type | Location | Required | Description |
|
|
586
|
+
| --- | --- | --- | --- | --- |
|
|
587
|
+
| `settings_name` | string | query | No | The settings tab to return fields for (e.g., `store_setup`, `checkout`, `pages`). |
|
|
588
|
+
|
|
589
|
+
#### Response
|
|
590
|
+
|
|
591
|
+
```
|
|
592
|
+
{
|
|
593
|
+
"settings": {
|
|
594
|
+
"store_name": "My Store",
|
|
595
|
+
"currency": "USD",
|
|
596
|
+
"currency_position": "before",
|
|
597
|
+
"decimal_separator": "dot",
|
|
598
|
+
"checkout_button_text": "Checkout",
|
|
599
|
+
"view_cart_button_text": "View Cart",
|
|
600
|
+
"cart_button_text": "Add To Cart",
|
|
601
|
+
"popup_button_text": "View Product",
|
|
602
|
+
"out_of_stock_button_text": "Not Available",
|
|
603
|
+
"checkout_method_style": "logo",
|
|
604
|
+
"enable_modal_checkout": "no",
|
|
605
|
+
"require_logged_in": "no",
|
|
606
|
+
"show_cart_icon_in_nav": "no",
|
|
607
|
+
"show_cart_icon_in_body": "yes",
|
|
608
|
+
"additional_address_field": "yes",
|
|
609
|
+
"hide_coupon_field": "no",
|
|
610
|
+
"user_account_creation_mode": "all",
|
|
611
|
+
"checkout_page_id": "",
|
|
612
|
+
"cart_page_id": "",
|
|
613
|
+
"receipt_page_id": "",
|
|
614
|
+
"shop_page_id": "",
|
|
615
|
+
"customer_profile_page_id": "",
|
|
616
|
+
"store_address1": "",
|
|
617
|
+
"store_address2": "",
|
|
618
|
+
"store_city": "",
|
|
619
|
+
"store_country": "",
|
|
620
|
+
"store_postcode": "",
|
|
621
|
+
"store_state": "",
|
|
622
|
+
"order_mode": "test",
|
|
623
|
+
"variation_view": "both",
|
|
624
|
+
"variation_columns": "masonry",
|
|
625
|
+
"min_receipt_number": "1",
|
|
626
|
+
"inv_prefix": "INV-",
|
|
627
|
+
"show_email_footer": "yes",
|
|
628
|
+
...
|
|
629
|
+
},
|
|
630
|
+
"fields": {
|
|
631
|
+
"store_setup": { ... }
|
|
632
|
+
}
|
|
633
|
+
}
|
|
634
|
+
```
|
|
635
|
+
|
|
636
|
+
#### Example
|
|
637
|
+
|
|
638
|
+
```
|
|
639
|
+
curl -X GET "https://example.com/wp-json/fluent-cart/v2/settings/store?settings_name=store_setup" \
|
|
640
|
+
-u "username:app_password"
|
|
641
|
+
```
|
|
642
|
+
|
|
643
|
+
---
|
|
644
|
+
|
|
645
|
+
### Save Store Settings
|
|
646
|
+
|
|
647
|
+
POST `/fluent-cart/v2/settings/store`
|
|
648
|
+
|
|
649
|
+
Update store configuration settings. Submitted values are merged with existing settings.
|
|
650
|
+
|
|
651
|
+
- **Permission:** `store/settings`
|
|
652
|
+
- **Request Class:** `FluentMetaRequest` (validates and sanitizes input)
|
|
653
|
+
|
|
654
|
+
#### Parameters
|
|
655
|
+
|
|
656
|
+
| Parameter | Type | Location | Required | Description |
|
|
657
|
+
| --- | --- | --- | --- | --- |
|
|
658
|
+
| `settings_name` | string | body | Conditional | Settings tab identifier. Required for `store_setup` tab validation (enforces `store_name` and `store_country`). |
|
|
659
|
+
| `store_name` | string | body | Conditional | Store name. Required when `settings_name` is `store_setup`. Max 200 characters. |
|
|
660
|
+
| `store_logo` | object | body | No | Store logo with `id` (integer), `url` (string), and `title` (string). |
|
|
661
|
+
| `currency` | string | body | No | Store currency code (e.g., `USD`, `EUR`, `GBP`). |
|
|
662
|
+
| `currency_position` | string | body | No | Currency symbol position: `before` or `after`. |
|
|
663
|
+
| `decimal_separator` | string | body | No | Decimal separator style: `dot` or `comma`. |
|
|
664
|
+
| `checkout_button_text` | string | body | No | Custom text for the checkout button. |
|
|
665
|
+
| `view_cart_button_text` | string | body | No | Custom text for the view cart button. |
|
|
666
|
+
| `cart_button_text` | string | body | No | Custom text for the add-to-cart button. |
|
|
667
|
+
| `popup_button_text` | string | body | No | Custom text for the product popup button. |
|
|
668
|
+
| `out_of_stock_button_text` | string | body | No | Custom text for the out-of-stock button. |
|
|
669
|
+
| `checkout_method_style` | string | body | No | Payment method display on checkout: `logo` or other styles. |
|
|
670
|
+
| `enable_modal_checkout` | string | body | No | Enable modal/popup checkout: `yes` or `no`. |
|
|
671
|
+
| `show_cart_icon_in_nav` | string | body | No | Show cart icon in navigation: `yes` or `no`. |
|
|
672
|
+
| `show_cart_icon_in_body` | string | body | No | Show floating cart icon: `yes` or `no`. |
|
|
673
|
+
| `additional_address_field` | string | body | No | Show additional address field: `yes` or `no`. |
|
|
674
|
+
| `hide_coupon_field` | string | body | No | Hide coupon input on checkout: `yes` or `no`. |
|
|
675
|
+
| `user_account_creation_mode` | string | body | No | Account creation mode: `all`, `optional`, or `disabled`. |
|
|
676
|
+
| `force_ssl` | string | body | No | Force SSL on checkout: `yes` or `no`. |
|
|
677
|
+
| `checkout_page_id` | integer | body | No | WordPress page ID for the checkout page. |
|
|
678
|
+
| `cart_page_id` | integer | body | No | WordPress page ID for the cart page. |
|
|
679
|
+
| `receipt_page_id` | integer | body | No | WordPress page ID for the order receipt page. |
|
|
680
|
+
| `shop_page_id` | integer | body | No | WordPress page ID for the shop page. |
|
|
681
|
+
| `customer_profile_page_id` | integer | body | No | WordPress page ID for the customer profile page. |
|
|
682
|
+
| `customer_profile_page_slug` | string | body | No | Custom slug for the customer profile page. |
|
|
683
|
+
| `registration_page_id` | integer | body | No | WordPress page ID for the registration page. |
|
|
684
|
+
| `login_page_id` | integer | body | No | WordPress page ID for the login page. |
|
|
685
|
+
| `store_address1` | string | body | No | Store address line 1. |
|
|
686
|
+
| `store_address2` | string | body | No | Store address line 2. |
|
|
687
|
+
| `store_city` | string | body | No | Store city. |
|
|
688
|
+
| `store_country` | string | body | Conditional | Store country code. Required when `settings_name` is `store_setup`. Max 200 characters. |
|
|
689
|
+
| `store_postcode` | string | body | No | Store postal/zip code. |
|
|
690
|
+
| `store_state` | string | body | No | Store state/province code. |
|
|
691
|
+
| `order_mode` | string | body | No | Order/payment mode: `test` or `live`. |
|
|
692
|
+
| `variation_view` | string | body | No | Product variation display: `both`, `grid`, or `list`. |
|
|
693
|
+
| `variation_columns` | string | body | No | Variation layout style: `masonry` or other layouts. |
|
|
694
|
+
| `enable_early_payment_for_installment` | string | body | No | Allow early installment payments: `yes` or `no`. |
|
|
695
|
+
| `product_slug` | string | body | No | Custom product URL slug. |
|
|
696
|
+
| `min_receipt_number` | string | body | No | Minimum receipt/invoice number. |
|
|
697
|
+
| `inv_prefix` | string | body | No | Invoice number prefix (e.g., `INV-`). |
|
|
698
|
+
| `frontend_theme` | object | body | No | Theme color overrides. Object of key-value pairs where values are hex colors. |
|
|
699
|
+
|
|
700
|
+
#### Response
|
|
701
|
+
|
|
702
|
+
```
|
|
703
|
+
{
|
|
704
|
+
"data": {
|
|
705
|
+
"store_name": "My Store",
|
|
706
|
+
"currency": "USD",
|
|
707
|
+
...
|
|
708
|
+
}
|
|
709
|
+
}
|
|
710
|
+
```
|
|
711
|
+
|
|
712
|
+
#### Example
|
|
713
|
+
|
|
714
|
+
```
|
|
715
|
+
curl -X POST "https://example.com/wp-json/fluent-cart/v2/settings/store" \
|
|
716
|
+
-u "username:app_password" \
|
|
717
|
+
-H "Content-Type: application/json" \
|
|
718
|
+
-d '{
|
|
719
|
+
"settings_name": "store_setup",
|
|
720
|
+
"store_name": "My Awesome Store",
|
|
721
|
+
"store_country": "US",
|
|
722
|
+
"currency": "USD",
|
|
723
|
+
"order_mode": "live"
|
|
724
|
+
}'
|
|
725
|
+
```
|
|
726
|
+
|
|
727
|
+
---
|
|
728
|
+
|
|
729
|
+
## Modules
|
|
730
|
+
|
|
731
|
+
### Get Plugin Addons
|
|
732
|
+
|
|
733
|
+
GET `/fluent-cart/v2/settings/modules/plugin-addons`
|
|
734
|
+
|
|
735
|
+
List all registered plugin addons (e.g., Elementor Blocks) with their installation and activation status.
|
|
736
|
+
|
|
737
|
+
- **Permission:** `is_super_admin`
|
|
738
|
+
|
|
739
|
+
#### Parameters
|
|
740
|
+
|
|
741
|
+
None.
|
|
742
|
+
|
|
743
|
+
#### Response
|
|
744
|
+
|
|
745
|
+
```
|
|
746
|
+
{
|
|
747
|
+
"addons": {
|
|
748
|
+
"elementor-block": {
|
|
749
|
+
"title": "Elementor Blocks",
|
|
750
|
+
"description": "Enable to get Elementor Blocks for FluentCart. Minimum Requirement: Elementor V3.34",
|
|
751
|
+
"logo": "https://...",
|
|
752
|
+
"dark_logo": "https://...",
|
|
753
|
+
"plugin_slug": "fluent-cart-elementor-blocks",
|
|
754
|
+
"plugin_file": "fluent-cart-elementor-blocks/fluent-cart-elementor-blocks.php",
|
|
755
|
+
"source_type": "cdn",
|
|
756
|
+
"source_link": "https://addons-cdn.fluentcart.com/fluent-cart-elementor-blocks.zip",
|
|
757
|
+
"upcoming": false,
|
|
758
|
+
"repo_link": "https://fluentcart.com/fluentcart-addons",
|
|
759
|
+
"is_installed": false,
|
|
760
|
+
"is_active": false
|
|
761
|
+
}
|
|
762
|
+
}
|
|
763
|
+
}
|
|
764
|
+
```
|
|
765
|
+
|
|
766
|
+
#### Example
|
|
767
|
+
|
|
768
|
+
```
|
|
769
|
+
curl -X GET "https://example.com/wp-json/fluent-cart/v2/settings/modules/plugin-addons" \
|
|
770
|
+
-u "username:app_password"
|
|
771
|
+
```
|
|
772
|
+
|
|
773
|
+
---
|
|
774
|
+
|
|
775
|
+
### Install Plugin Addon
|
|
776
|
+
|
|
777
|
+
POST `/fluent-cart/v2/settings/modules/plugin-addons/install`
|
|
778
|
+
|
|
779
|
+
Install a registered plugin addon from its configured source (WordPress.org, GitHub, or CDN).
|
|
780
|
+
|
|
781
|
+
- **Permission:** `is_super_admin`
|
|
782
|
+
|
|
783
|
+
#### Parameters
|
|
784
|
+
|
|
785
|
+
| Parameter | Type | Location | Required | Description |
|
|
786
|
+
| --- | --- | --- | --- | --- |
|
|
787
|
+
| `plugin_slug` | string | body | Yes | The slug of the addon to install. Must match a registered addon slug. |
|
|
788
|
+
| `source_type` | string | body | No | Source type: `wordpress`, `github`, or `cdn`. Defaults to the addon's registered source. |
|
|
789
|
+
| `source_link` | string | body | No | URL to the addon source. Defaults to the addon's registered source link. |
|
|
790
|
+
| `asset_path` | string | body | No | GitHub release asset path (defaults to `zipball_url`). |
|
|
791
|
+
|
|
792
|
+
#### Response
|
|
793
|
+
|
|
794
|
+
```
|
|
795
|
+
{
|
|
796
|
+
"message": "Addon installed successfully",
|
|
797
|
+
"plugin_file": "fluent-cart-elementor-blocks/fluent-cart-elementor-blocks.php"
|
|
798
|
+
}
|
|
799
|
+
```
|
|
800
|
+
|
|
801
|
+
#### Example
|
|
802
|
+
|
|
803
|
+
```
|
|
804
|
+
curl -X POST "https://example.com/wp-json/fluent-cart/v2/settings/modules/plugin-addons/install" \
|
|
805
|
+
-u "username:app_password" \
|
|
806
|
+
-H "Content-Type: application/json" \
|
|
807
|
+
-d '{
|
|
808
|
+
"plugin_slug": "fluent-cart-elementor-blocks"
|
|
809
|
+
}'
|
|
810
|
+
```
|
|
811
|
+
|
|
812
|
+
---
|
|
813
|
+
|
|
814
|
+
### Activate Plugin Addon
|
|
815
|
+
|
|
816
|
+
POST `/fluent-cart/v2/settings/modules/plugin-addons/activate`
|
|
817
|
+
|
|
818
|
+
Activate an already-installed plugin addon.
|
|
819
|
+
|
|
820
|
+
- **Permission:** `is_super_admin`
|
|
821
|
+
|
|
822
|
+
#### Parameters
|
|
823
|
+
|
|
824
|
+
| Parameter | Type | Location | Required | Description |
|
|
825
|
+
| --- | --- | --- | --- | --- |
|
|
826
|
+
| `plugin_file` | string | body | Yes | The plugin file path to activate (e.g., `fluent-cart-elementor-blocks/fluent-cart-elementor-blocks.php`). |
|
|
827
|
+
|
|
828
|
+
#### Response
|
|
829
|
+
|
|
830
|
+
```
|
|
831
|
+
{
|
|
832
|
+
"message": "Addon activated successfully."
|
|
833
|
+
}
|
|
834
|
+
```
|
|
835
|
+
|
|
836
|
+
#### Example
|
|
837
|
+
|
|
838
|
+
```
|
|
839
|
+
curl -X POST "https://example.com/wp-json/fluent-cart/v2/settings/modules/plugin-addons/activate" \
|
|
840
|
+
-u "username:app_password" \
|
|
841
|
+
-H "Content-Type: application/json" \
|
|
842
|
+
-d '{
|
|
843
|
+
"plugin_file": "fluent-cart-elementor-blocks/fluent-cart-elementor-blocks.php"
|
|
844
|
+
}'
|
|
845
|
+
```
|
|
846
|
+
|
|
847
|
+
---
|
|
848
|
+
|
|
849
|
+
### Get Module Settings
|
|
850
|
+
|
|
851
|
+
GET `/fluent-cart/v2/settings/modules`
|
|
852
|
+
|
|
853
|
+
Retrieve all module (feature toggle) settings and their field definitions.
|
|
854
|
+
|
|
855
|
+
- **Permission:** `is_super_admin`
|
|
856
|
+
|
|
857
|
+
#### Parameters
|
|
858
|
+
|
|
859
|
+
None.
|
|
860
|
+
|
|
861
|
+
#### Response
|
|
862
|
+
|
|
863
|
+
```
|
|
864
|
+
{
|
|
865
|
+
"fields": {
|
|
866
|
+
"modules_settings": {
|
|
867
|
+
"title": "Features & addon",
|
|
868
|
+
"type": "section",
|
|
869
|
+
"class": "no-padding",
|
|
870
|
+
"disable_nesting": true,
|
|
871
|
+
"columns": {
|
|
872
|
+
"default": 1,
|
|
873
|
+
"md": 1
|
|
874
|
+
},
|
|
875
|
+
"schema": {
|
|
876
|
+
"turnstile": { "title": "Turnstile", "description": "...", "type": "...", "component": "..." },
|
|
877
|
+
"reviews": { "title": "Reviews", "hidden": false },
|
|
878
|
+
"stock_management": { "title": "Stock Management", "description": "...", "type": "...", "component": "...",
|
|
879
|
+
"settings": { "enable_advanced_inventory": { "label": "...", "default": "no" } } },
|
|
880
|
+
"license": { "title": "Licensing", "description": "...", "type": "...", "component": "..." },
|
|
881
|
+
"order_bump": { "title": "Order Bump", "description": "...", "type": "...", "component": "..." },
|
|
882
|
+
"dynamic_pricing": { "title": "Dynamic Pricing", "description": "...", "type": "...", "component": "..." },
|
|
883
|
+
"mcp": { "title": "MCP", "description": "...", "type": "...", "component": "..." }
|
|
884
|
+
}
|
|
885
|
+
}
|
|
886
|
+
},
|
|
887
|
+
"settings": {
|
|
888
|
+
"turnstile": {
|
|
889
|
+
"active": "no",
|
|
890
|
+
"site_key": "",
|
|
891
|
+
"secret_key": ""
|
|
892
|
+
},
|
|
893
|
+
"reviews": {
|
|
894
|
+
"active": "yes",
|
|
895
|
+
"review_permission_mode": "verified_buyers",
|
|
896
|
+
"auto_approve_reviews": "no",
|
|
897
|
+
"show_verified_badge": "yes",
|
|
898
|
+
"enable_star_rating": "yes",
|
|
899
|
+
"star_rating_required": "yes",
|
|
900
|
+
"reviews_per_page": 10
|
|
901
|
+
},
|
|
902
|
+
"stock_management": {
|
|
903
|
+
"active": "yes",
|
|
904
|
+
"enable_advanced_inventory": "no"
|
|
905
|
+
}
|
|
906
|
+
}
|
|
907
|
+
}
|
|
908
|
+
```
|
|
909
|
+
|
|
910
|
+
`fields.modules_settings.schema` describes **every** module the admin can toggle, while `settings` carries only the modules that have stored values. A module absent from `settings` has never been configured on that store, so read defaults from the schema rather than assuming the key is present.
|
|
911
|
+
|
|
912
|
+
Module keys are dynamically registered via the `fluent_cart/module_setting/fields` filter.
|
|
913
|
+
|
|
914
|
+
#### Example
|
|
915
|
+
|
|
916
|
+
```
|
|
917
|
+
curl -X GET "https://example.com/wp-json/fluent-cart/v2/settings/modules" \
|
|
918
|
+
-u "username:app_password"
|
|
919
|
+
```
|
|
920
|
+
|
|
921
|
+
---
|
|
922
|
+
|
|
923
|
+
### Save Module Settings
|
|
924
|
+
|
|
925
|
+
POST `/fluent-cart/v2/settings/modules`
|
|
926
|
+
|
|
927
|
+
Enable or disable modules (features) and update their configuration. Fires `fluent_cart/module/activated/{key}` or `fluent_cart/module/deactivated/{key}` hooks when a module's active status changes.
|
|
928
|
+
|
|
929
|
+
- **Permission:** `is_super_admin`
|
|
930
|
+
|
|
931
|
+
#### Parameters
|
|
932
|
+
|
|
933
|
+
The request body should include module key-value pairs matching the registered module keys. Each module object typically contains:
|
|
934
|
+
|
|
935
|
+
| Parameter | Type | Location | Required | Description |
|
|
936
|
+
| --- | --- | --- | --- | --- |
|
|
937
|
+
| `{module_key}` | object | body | Yes | Module configuration object. Keys vary per module. |
|
|
938
|
+
| `{module_key}.active` | string | body | Yes | Whether the module is enabled: `yes` or `no`. |
|
|
939
|
+
|
|
940
|
+
Only keys returned by `ModuleSettings::validKeys()` (derived from registered module fields) are accepted. Unrecognized keys are ignored.
|
|
941
|
+
|
|
942
|
+
#### Response
|
|
943
|
+
|
|
944
|
+
```
|
|
945
|
+
{
|
|
946
|
+
"message": "Settings saved successfully"
|
|
947
|
+
}
|
|
948
|
+
```
|
|
949
|
+
|
|
950
|
+
#### Example
|
|
951
|
+
|
|
952
|
+
```
|
|
953
|
+
curl -X POST "https://example.com/wp-json/fluent-cart/v2/settings/modules" \
|
|
954
|
+
-u "username:app_password" \
|
|
955
|
+
-H "Content-Type: application/json" \
|
|
956
|
+
-d '{
|
|
957
|
+
"shipping": {
|
|
958
|
+
"active": "yes"
|
|
959
|
+
},
|
|
960
|
+
"tax": {
|
|
961
|
+
"active": "no"
|
|
962
|
+
},
|
|
963
|
+
"coupons": {
|
|
964
|
+
"active": "yes"
|
|
965
|
+
}
|
|
966
|
+
}'
|
|
967
|
+
```
|
|
968
|
+
|
|
969
|
+
---
|
|
970
|
+
|
|
971
|
+
## Confirmation Pages
|
|
972
|
+
|
|
973
|
+
### Save Confirmation Settings
|
|
974
|
+
|
|
975
|
+
POST `/fluent-cart/v2/settings/confirmation`
|
|
976
|
+
|
|
977
|
+
Update the order confirmation/receipt page settings, including the confirmation type, message content, and the receipt page assignment.
|
|
978
|
+
|
|
979
|
+
- **Permission:** `is_super_admin`
|
|
980
|
+
|
|
981
|
+
#### Parameters
|
|
982
|
+
|
|
983
|
+
| Parameter | Type | Location | Required | Description |
|
|
984
|
+
| --- | --- | --- | --- | --- |
|
|
985
|
+
| `settings` | object | body | Yes | Confirmation settings object. |
|
|
986
|
+
| `settings.confirmation_type` | string | body | No | Confirmation behavior: `same_page` (show confirmation on same page) or `custom_page` (redirect to a custom page). |
|
|
987
|
+
| `settings.message_to_show` | string | body | No | HTML content to display as the order confirmation message. Sanitized with `wp_kses_post`. |
|
|
988
|
+
| `settings.confirmation_page_id` | integer | body | No | WordPress page ID for a custom confirmation/receipt page. Also updates the store's `receipt_page_id`. |
|
|
989
|
+
|
|
990
|
+
#### Response
|
|
991
|
+
|
|
992
|
+
```
|
|
993
|
+
{
|
|
994
|
+
"confirmation_type": "same_page",
|
|
995
|
+
"message_to_show": "<p>Thank you for your order!</p>"
|
|
996
|
+
}
|
|
997
|
+
```
|
|
998
|
+
|
|
999
|
+
#### Example
|
|
1000
|
+
|
|
1001
|
+
```
|
|
1002
|
+
curl -X POST "https://example.com/wp-json/fluent-cart/v2/settings/confirmation" \
|
|
1003
|
+
-u "username:app_password" \
|
|
1004
|
+
-H "Content-Type: application/json" \
|
|
1005
|
+
-d '{
|
|
1006
|
+
"settings": {
|
|
1007
|
+
"confirmation_type": "custom_page",
|
|
1008
|
+
"confirmation_page_id": 42,
|
|
1009
|
+
"message_to_show": "<h2>Order Confirmed!</h2><p>Thank you for your purchase.</p>"
|
|
1010
|
+
}
|
|
1011
|
+
}'
|
|
1012
|
+
```
|
|
1013
|
+
|
|
1014
|
+
---
|
|
1015
|
+
|
|
1016
|
+
### Get Email Shortcodes
|
|
1017
|
+
|
|
1018
|
+
GET `/fluent-cart/v2/settings/confirmation/shortcode`
|
|
1019
|
+
|
|
1020
|
+
Retrieve available shortcodes/merge tags that can be used in email notification templates and confirmation messages.
|
|
1021
|
+
|
|
1022
|
+
- **Permission:** `is_super_admin`
|
|
1023
|
+
|
|
1024
|
+
#### Parameters
|
|
1025
|
+
|
|
1026
|
+
None.
|
|
1027
|
+
|
|
1028
|
+
#### Response
|
|
1029
|
+
|
|
1030
|
+
```
|
|
1031
|
+
{
|
|
1032
|
+
"data": {
|
|
1033
|
+
"order": {
|
|
1034
|
+
"title": "Order",
|
|
1035
|
+
"shortcodes": {
|
|
1036
|
+
"{{order.id}}": "Order ID",
|
|
1037
|
+
"{{order.total}}": "Order Total",
|
|
1038
|
+
"{{order.status}}": "Order Status",
|
|
1039
|
+
...
|
|
1040
|
+
}
|
|
1041
|
+
},
|
|
1042
|
+
"customer": {
|
|
1043
|
+
"title": "Customer",
|
|
1044
|
+
"shortcodes": {
|
|
1045
|
+
"{{customer.first_name}}": "First Name",
|
|
1046
|
+
"{{customer.email}}": "Email",
|
|
1047
|
+
...
|
|
1048
|
+
}
|
|
1049
|
+
},
|
|
1050
|
+
"store": {
|
|
1051
|
+
"title": "Store",
|
|
1052
|
+
"shortcodes": {
|
|
1053
|
+
"{{store.name}}": "Store Name",
|
|
1054
|
+
...
|
|
1055
|
+
}
|
|
1056
|
+
}
|
|
1057
|
+
}
|
|
1058
|
+
}
|
|
1059
|
+
```
|
|
1060
|
+
|
|
1061
|
+
#### Example
|
|
1062
|
+
|
|
1063
|
+
```
|
|
1064
|
+
curl -X GET "https://example.com/wp-json/fluent-cart/v2/settings/confirmation/shortcode" \
|
|
1065
|
+
-u "username:app_password"
|
|
1066
|
+
```
|
|
1067
|
+
|
|
1068
|
+
---
|
|
1069
|
+
|
|
1070
|
+
## Storage Drivers
|
|
1071
|
+
|
|
1072
|
+
Manage file storage drivers for digital product delivery (e.g., local filesystem, Amazon S3, Bunny CDN).
|
|
1073
|
+
|
|
1074
|
+
### List All Storage Drivers
|
|
1075
|
+
|
|
1076
|
+
GET `/fluent-cart/v2/settings/storage-drivers`
|
|
1077
|
+
|
|
1078
|
+
Retrieve all registered file storage drivers and their current status.
|
|
1079
|
+
|
|
1080
|
+
- **Permission:** `is_super_admin`
|
|
1081
|
+
|
|
1082
|
+
#### Parameters
|
|
1083
|
+
|
|
1084
|
+
None.
|
|
1085
|
+
|
|
1086
|
+
#### Response
|
|
1087
|
+
|
|
1088
|
+
```
|
|
1089
|
+
{
|
|
1090
|
+
"drivers": {
|
|
1091
|
+
"local": {
|
|
1092
|
+
"title": "Local",
|
|
1093
|
+
"route": "local",
|
|
1094
|
+
"description": "Local allows to upload file in local file storage",
|
|
1095
|
+
"logo": "https://example.com/wp-content/plugins/fluent-cart/assets/images/storage-drivers/local.svg",
|
|
1096
|
+
"dark_logo": null,
|
|
1097
|
+
"status": true,
|
|
1098
|
+
"brand_color": "#136196",
|
|
1099
|
+
"has_bucket": false,
|
|
1100
|
+
"instance": { "slug": "local", "title": "Local", "brandColor": "#136196" }
|
|
1101
|
+
},
|
|
1102
|
+
"s3": {
|
|
1103
|
+
"title": "Amazon S3",
|
|
1104
|
+
"route": "s3",
|
|
1105
|
+
"status": false,
|
|
1106
|
+
"has_bucket": true,
|
|
1107
|
+
"need_reconfigure": false,
|
|
1108
|
+
"buckets": []
|
|
1109
|
+
},
|
|
1110
|
+
"r2": {
|
|
1111
|
+
"title": "Cloudflare R2",
|
|
1112
|
+
"route": "r2",
|
|
1113
|
+
"status": false,
|
|
1114
|
+
"has_bucket": true,
|
|
1115
|
+
"need_reconfigure": false,
|
|
1116
|
+
"buckets": []
|
|
1117
|
+
}
|
|
1118
|
+
}
|
|
1119
|
+
}
|
|
1120
|
+
```
|
|
1121
|
+
|
|
1122
|
+
#### Example
|
|
1123
|
+
|
|
1124
|
+
```
|
|
1125
|
+
curl -X GET "https://example.com/wp-json/fluent-cart/v2/settings/storage-drivers" \
|
|
1126
|
+
-u "username:app_password"
|
|
1127
|
+
```
|
|
1128
|
+
|
|
1129
|
+
---
|
|
1130
|
+
|
|
1131
|
+
### Save Storage Driver Settings
|
|
1132
|
+
|
|
1133
|
+
POST `/fluent-cart/v2/settings/storage-drivers`
|
|
1134
|
+
|
|
1135
|
+
Create or update settings for a specific file storage driver.
|
|
1136
|
+
|
|
1137
|
+
- **Permission:** `is_super_admin`
|
|
1138
|
+
|
|
1139
|
+
#### Parameters
|
|
1140
|
+
|
|
1141
|
+
| Parameter | Type | Location | Required | Description |
|
|
1142
|
+
| --- | --- | --- | --- | --- |
|
|
1143
|
+
| `driver` | string | body | Yes | The storage driver key (e.g., `local`, `s3`, `bunny`). |
|
|
1144
|
+
| `settings` | object | body | Yes | Driver-specific configuration settings. Fields vary by driver. |
|
|
1145
|
+
|
|
1146
|
+
#### Response
|
|
1147
|
+
|
|
1148
|
+
```
|
|
1149
|
+
{
|
|
1150
|
+
"message": "Settings saved successfully",
|
|
1151
|
+
"data": { ... }
|
|
1152
|
+
}
|
|
1153
|
+
```
|
|
1154
|
+
|
|
1155
|
+
#### Example
|
|
1156
|
+
|
|
1157
|
+
```
|
|
1158
|
+
curl -X POST "https://example.com/wp-json/fluent-cart/v2/settings/storage-drivers" \
|
|
1159
|
+
-u "username:app_password" \
|
|
1160
|
+
-H "Content-Type: application/json" \
|
|
1161
|
+
-d '{
|
|
1162
|
+
"driver": "s3",
|
|
1163
|
+
"settings": {
|
|
1164
|
+
"access_key": "AKIA...",
|
|
1165
|
+
"secret_key": "wJalr...",
|
|
1166
|
+
"bucket": "my-store-files",
|
|
1167
|
+
"region": "us-east-1"
|
|
1168
|
+
}
|
|
1169
|
+
}'
|
|
1170
|
+
```
|
|
1171
|
+
|
|
1172
|
+
---
|
|
1173
|
+
|
|
1174
|
+
### Get Active Storage Drivers
|
|
1175
|
+
|
|
1176
|
+
GET `/fluent-cart/v2/settings/storage-drivers/active-drivers`
|
|
1177
|
+
|
|
1178
|
+
Retrieve only the currently active/enabled file storage drivers.
|
|
1179
|
+
|
|
1180
|
+
- **Permission:** `is_super_admin`
|
|
1181
|
+
|
|
1182
|
+
#### Parameters
|
|
1183
|
+
|
|
1184
|
+
None.
|
|
1185
|
+
|
|
1186
|
+
#### Response
|
|
1187
|
+
|
|
1188
|
+
```
|
|
1189
|
+
{
|
|
1190
|
+
"drivers": [
|
|
1191
|
+
{
|
|
1192
|
+
"key": "local",
|
|
1193
|
+
"title": "Local Storage",
|
|
1194
|
+
"is_active": true,
|
|
1195
|
+
...
|
|
1196
|
+
}
|
|
1197
|
+
]
|
|
1198
|
+
}
|
|
1199
|
+
```
|
|
1200
|
+
|
|
1201
|
+
#### Example
|
|
1202
|
+
|
|
1203
|
+
```
|
|
1204
|
+
curl -X GET "https://example.com/wp-json/fluent-cart/v2/settings/storage-drivers/active-drivers" \
|
|
1205
|
+
-u "username:app_password"
|
|
1206
|
+
```
|
|
1207
|
+
|
|
1208
|
+
---
|
|
1209
|
+
|
|
1210
|
+
### Get Storage Driver Settings
|
|
1211
|
+
|
|
1212
|
+
GET `/fluent-cart/v2/settings/storage-drivers/{driver}`
|
|
1213
|
+
|
|
1214
|
+
Retrieve the configuration settings and field schema for a specific storage driver.
|
|
1215
|
+
|
|
1216
|
+
- **Permission:** `is_super_admin`
|
|
1217
|
+
|
|
1218
|
+
#### Parameters
|
|
1219
|
+
|
|
1220
|
+
| Parameter | Type | Location | Required | Description |
|
|
1221
|
+
| --- | --- | --- | --- | --- |
|
|
1222
|
+
| `driver` | string | path | Yes | The storage driver key (e.g., `local`, `s3`, `bunny`). |
|
|
1223
|
+
|
|
1224
|
+
#### Response
|
|
1225
|
+
|
|
1226
|
+
```
|
|
1227
|
+
{
|
|
1228
|
+
"settings": {
|
|
1229
|
+
"access_key": "AKIA...",
|
|
1230
|
+
"secret_key": "****",
|
|
1231
|
+
"bucket": "my-store-files",
|
|
1232
|
+
"region": "us-east-1"
|
|
1233
|
+
},
|
|
1234
|
+
"fields": { ... }
|
|
1235
|
+
}
|
|
1236
|
+
```
|
|
1237
|
+
|
|
1238
|
+
#### Example
|
|
1239
|
+
|
|
1240
|
+
```
|
|
1241
|
+
curl -X GET "https://example.com/wp-json/fluent-cart/v2/settings/storage-drivers/s3" \
|
|
1242
|
+
-u "username:app_password"
|
|
1243
|
+
```
|
|
1244
|
+
|
|
1245
|
+
---
|
|
1246
|
+
|
|
1247
|
+
### Verify Storage Driver Connection
|
|
1248
|
+
|
|
1249
|
+
POST `/fluent-cart/v2/settings/storage-drivers/verify-info`
|
|
1250
|
+
|
|
1251
|
+
Test the connection to a storage driver using the provided credentials without saving them.
|
|
1252
|
+
|
|
1253
|
+
- **Permission:** `is_super_admin`
|
|
1254
|
+
|
|
1255
|
+
#### Parameters
|
|
1256
|
+
|
|
1257
|
+
| Parameter | Type | Location | Required | Description |
|
|
1258
|
+
| --- | --- | --- | --- | --- |
|
|
1259
|
+
| `driver` | string | body | Yes | The storage driver key (e.g., `s3`, `bunny`). |
|
|
1260
|
+
| `settings` | object | body | Yes | Driver-specific credentials and configuration to verify. Fields vary by driver. |
|
|
1261
|
+
|
|
1262
|
+
#### Response
|
|
1263
|
+
|
|
1264
|
+
```
|
|
1265
|
+
{
|
|
1266
|
+
"message": "Connection verified successfully"
|
|
1267
|
+
}
|
|
1268
|
+
```
|
|
1269
|
+
|
|
1270
|
+
#### Example
|
|
1271
|
+
|
|
1272
|
+
```
|
|
1273
|
+
curl -X POST "https://example.com/wp-json/fluent-cart/v2/settings/storage-drivers/verify-info" \
|
|
1274
|
+
-u "username:app_password" \
|
|
1275
|
+
-H "Content-Type: application/json" \
|
|
1276
|
+
-d '{
|
|
1277
|
+
"driver": "s3",
|
|
1278
|
+
"settings": {
|
|
1279
|
+
"access_key": "AKIA...",
|
|
1280
|
+
"secret_key": "wJalr...",
|
|
1281
|
+
"bucket": "my-store-files",
|
|
1282
|
+
"region": "us-east-1"
|
|
1283
|
+
}
|
|
1284
|
+
}'
|
|
1285
|
+
```
|
|
1286
|
+
|
|
1287
|
+
---
|
|
1288
|
+
|
|
1289
|
+
## Checkout Fields
|
|
1290
|
+
|
|
1291
|
+
Manage which fields are displayed on the checkout form and their required/optional status.
|
|
1292
|
+
|
|
1293
|
+
**Base URL:** `https://your-site.com/wp-json/fluent-cart/v2/checkout-fields`
|
|
1294
|
+
|
|
1295
|
+
**Policy:** `StoreSensitivePolicy` (requires `store/sensitive` capability)
|
|
1296
|
+
|
|
1297
|
+
### Get Checkout Fields
|
|
1298
|
+
|
|
1299
|
+
GET `/fluent-cart/v2/checkout-fields/get-fields`
|
|
1300
|
+
|
|
1301
|
+
Retrieve the checkout field configuration including the schema definition and current settings.
|
|
1302
|
+
|
|
1303
|
+
- **Permission:** `store/sensitive`
|
|
1304
|
+
|
|
1305
|
+
#### Parameters
|
|
1306
|
+
|
|
1307
|
+
None.
|
|
1308
|
+
|
|
1309
|
+
#### Response
|
|
1310
|
+
|
|
1311
|
+
```
|
|
1312
|
+
{
|
|
1313
|
+
"fields": {
|
|
1314
|
+
"basic_info": {
|
|
1315
|
+
"full_name": {
|
|
1316
|
+
"label": "Full Name",
|
|
1317
|
+
"type": "text",
|
|
1318
|
+
"configurable": true
|
|
1319
|
+
},
|
|
1320
|
+
"first_name": {
|
|
1321
|
+
"label": "First Name",
|
|
1322
|
+
"type": "text",
|
|
1323
|
+
"configurable": true
|
|
1324
|
+
},
|
|
1325
|
+
"last_name": {
|
|
1326
|
+
"label": "Last Name",
|
|
1327
|
+
"type": "text",
|
|
1328
|
+
"configurable": true
|
|
1329
|
+
},
|
|
1330
|
+
"email": {
|
|
1331
|
+
"label": "Email",
|
|
1332
|
+
"type": "email",
|
|
1333
|
+
"configurable": false
|
|
1334
|
+
}
|
|
1335
|
+
},
|
|
1336
|
+
"billing_address": { ... },
|
|
1337
|
+
"shipping_address": { ... }
|
|
1338
|
+
},
|
|
1339
|
+
"settings": {
|
|
1340
|
+
"basic_info": {
|
|
1341
|
+
"full_name": {
|
|
1342
|
+
"enabled": "yes",
|
|
1343
|
+
"required": "yes"
|
|
1344
|
+
},
|
|
1345
|
+
"first_name": {
|
|
1346
|
+
"enabled": "no",
|
|
1347
|
+
"required": "no"
|
|
1348
|
+
},
|
|
1349
|
+
"last_name": {
|
|
1350
|
+
"enabled": "no",
|
|
1351
|
+
"required": "no"
|
|
1352
|
+
}
|
|
1353
|
+
},
|
|
1354
|
+
"billing_address": { ... },
|
|
1355
|
+
"shipping_address": { ... }
|
|
1356
|
+
}
|
|
1357
|
+
}
|
|
1358
|
+
```
|
|
1359
|
+
|
|
1360
|
+
#### Example
|
|
1361
|
+
|
|
1362
|
+
```
|
|
1363
|
+
curl -X GET "https://example.com/wp-json/fluent-cart/v2/checkout-fields/get-fields" \
|
|
1364
|
+
-u "username:app_password"
|
|
1365
|
+
```
|
|
1366
|
+
|
|
1367
|
+
---
|
|
1368
|
+
|
|
1369
|
+
### Save Checkout Fields
|
|
1370
|
+
|
|
1371
|
+
POST `/fluent-cart/v2/checkout-fields/save-fields`
|
|
1372
|
+
|
|
1373
|
+
Update the checkout field visibility and required settings. The endpoint enforces name field logic automatically:
|
|
1374
|
+
|
|
1375
|
+
- If `first_name` or `last_name` is enabled, `full_name` is automatically disabled.
|
|
1376
|
+
- If neither `first_name` nor `last_name` is enabled, `full_name` is automatically enabled and marked as required.
|
|
1377
|
+
- If `first_name` is enabled, it is forced to be required. Same for `last_name`.
|
|
1378
|
+
- **Permission:** `store/sensitive`
|
|
1379
|
+
|
|
1380
|
+
#### Parameters
|
|
1381
|
+
|
|
1382
|
+
| Parameter | Type | Location | Required | Description |
|
|
1383
|
+
| --- | --- | --- | --- | --- |
|
|
1384
|
+
| `settings` | object | body | Yes | Checkout field settings object. Only keys matching existing settings are accepted. |
|
|
1385
|
+
| `settings.basic_info` | object | body | No | Basic information field settings. |
|
|
1386
|
+
| `settings.basic_info.{field}.enabled` | string | body | No | Whether the field is shown: `yes` or `no`. |
|
|
1387
|
+
| `settings.basic_info.{field}.required` | string | body | No | Whether the field is required: `yes` or `no`. |
|
|
1388
|
+
| `settings.billing_address` | object | body | No | Billing address field settings (same structure as `basic_info`). |
|
|
1389
|
+
| `settings.shipping_address` | object | body | No | Shipping address field settings (same structure as `basic_info`). |
|
|
1390
|
+
|
|
1391
|
+
#### Response
|
|
1392
|
+
|
|
1393
|
+
```
|
|
1394
|
+
{
|
|
1395
|
+
"message": "Checkout fields has been updated successfully."
|
|
1396
|
+
}
|
|
1397
|
+
```
|
|
1398
|
+
|
|
1399
|
+
#### Example
|
|
1400
|
+
|
|
1401
|
+
```
|
|
1402
|
+
curl -X POST "https://example.com/wp-json/fluent-cart/v2/checkout-fields/save-fields" \
|
|
1403
|
+
-u "username:app_password" \
|
|
1404
|
+
-H "Content-Type: application/json" \
|
|
1405
|
+
-d '{
|
|
1406
|
+
"settings": {
|
|
1407
|
+
"basic_info": {
|
|
1408
|
+
"full_name": {
|
|
1409
|
+
"enabled": "no",
|
|
1410
|
+
"required": "no"
|
|
1411
|
+
},
|
|
1412
|
+
"first_name": {
|
|
1413
|
+
"enabled": "yes",
|
|
1414
|
+
"required": "yes"
|
|
1415
|
+
},
|
|
1416
|
+
"last_name": {
|
|
1417
|
+
"enabled": "yes",
|
|
1418
|
+
"required": "no"
|
|
1419
|
+
}
|
|
1420
|
+
}
|
|
1421
|
+
}
|
|
1422
|
+
}'
|
|
1423
|
+
```
|