fluentcart-developer 3.0.0 → 3.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE.md +26 -26
- package/README.md +59 -59
- package/dist/cards/fluentcart/templates-native.js +1087 -1087
- package/dist/cards/fluentcart/tools.js +2309 -2309
- package/dist/skills/fluentcart-developer/SKILL.md +108 -108
- package/dist/skills/fluentcart-developer/examples/README.md +30 -30
- package/dist/skills/fluentcart-developer/examples/fluentcart-starter-child-theme/fluent-cart/checkout.php +32 -32
- package/dist/skills/fluentcart-developer/examples/fluentcart-starter-child-theme/functions.php +40 -40
- package/dist/skills/fluentcart-developer/examples/sample-custom-addon/fluentcart-custom-addon.php +113 -113
- package/dist/skills/fluentcart-developer/examples/sample-custom-payment-gateway/fluentcart-custom-gateway-example.php +148 -148
- package/dist/skills/fluentcart-developer/examples/sample-fee-surcharge-plugin/fluentcart-fee-surcharge.php +38 -38
- package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/README.md +22 -22
- package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/sample-plugin-with-licensing-sdk.php +79 -79
- package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/updater/FluentLicensing.php +303 -303
- package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/updater/LicenseSettings.php +566 -566
- package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/updater/PluginUpdater.php +304 -304
- package/dist/skills/fluentcart-developer/examples/sample-shipping-carrier/fluentcart-custom-shipping-carrier.php +61 -61
- package/dist/skills/fluentcart-developer/references/api/authentication.md +452 -452
- package/dist/skills/fluentcart-developer/references/api/coupons.md +786 -786
- package/dist/skills/fluentcart-developer/references/api/customers.md +889 -889
- package/dist/skills/fluentcart-developer/references/api/files.md +609 -609
- package/dist/skills/fluentcart-developer/references/api/index.md +432 -432
- package/dist/skills/fluentcart-developer/references/api/licensing.md +633 -633
- package/dist/skills/fluentcart-developer/references/api/order-bump.md +384 -384
- package/dist/skills/fluentcart-developer/references/api/orders.md +814 -814
- package/dist/skills/fluentcart-developer/references/api/products.md +866 -866
- package/dist/skills/fluentcart-developer/references/api/roles-permissions.md +536 -536
- package/dist/skills/fluentcart-developer/references/api/subscriptions.md +827 -827
- package/dist/skills/fluentcart-developer/references/database/index.md +44 -44
- package/dist/skills/fluentcart-developer/references/database/models/activity.md +178 -178
- package/dist/skills/fluentcart-developer/references/database/models/applied-coupon.md +291 -291
- package/dist/skills/fluentcart-developer/references/database/models/attribute-group.md +239 -239
- package/dist/skills/fluentcart-developer/references/database/models/attribute-relation.md +181 -181
- package/dist/skills/fluentcart-developer/references/database/models/attribute-term.md +219 -219
- package/dist/skills/fluentcart-developer/references/database/models/cart.md +645 -645
- package/dist/skills/fluentcart-developer/references/database/models/coupon.md +427 -427
- package/dist/skills/fluentcart-developer/references/database/models/customer-addresses.md +348 -348
- package/dist/skills/fluentcart-developer/references/database/models/customer-meta.md +156 -156
- package/dist/skills/fluentcart-developer/references/database/models/customer.md +584 -584
- package/dist/skills/fluentcart-developer/references/database/models/dynamic-model.md +163 -163
- package/dist/skills/fluentcart-developer/references/database/models/label-relationship.md +155 -155
- package/dist/skills/fluentcart-developer/references/database/models/label.md +153 -153
- package/dist/skills/fluentcart-developer/references/database/models/license-activation.md +182 -182
- package/dist/skills/fluentcart-developer/references/database/models/license-meta.md +163 -163
- package/dist/skills/fluentcart-developer/references/database/models/license-site.md +208 -208
- package/dist/skills/fluentcart-developer/references/database/models/license.md +640 -640
- package/dist/skills/fluentcart-developer/references/database/models/meta.md +233 -233
- package/dist/skills/fluentcart-developer/references/database/models/order-address.md +391 -391
- package/dist/skills/fluentcart-developer/references/database/models/order-download-permission.md +144 -144
- package/dist/skills/fluentcart-developer/references/database/models/order-item.md +383 -383
- package/dist/skills/fluentcart-developer/references/database/models/order-meta.md +303 -303
- package/dist/skills/fluentcart-developer/references/database/models/order-operation.md +158 -158
- package/dist/skills/fluentcart-developer/references/database/models/order-promotion-stat.md +175 -175
- package/dist/skills/fluentcart-developer/references/database/models/order-promotion.md +250 -250
- package/dist/skills/fluentcart-developer/references/database/models/order-tax-rate.md +172 -172
- package/dist/skills/fluentcart-developer/references/database/models/order-transaction.md +440 -440
- package/dist/skills/fluentcart-developer/references/database/models/order.md +727 -727
- package/dist/skills/fluentcart-developer/references/database/models/product-detail.md +397 -397
- package/dist/skills/fluentcart-developer/references/database/models/product-download.md +258 -258
- package/dist/skills/fluentcart-developer/references/database/models/product-meta.md +153 -153
- package/dist/skills/fluentcart-developer/references/database/models/product-variation.md +556 -556
- package/dist/skills/fluentcart-developer/references/database/models/product.md +580 -580
- package/dist/skills/fluentcart-developer/references/database/models/relationships.md +427 -427
- package/dist/skills/fluentcart-developer/references/database/models/scheduled-action.md +175 -175
- package/dist/skills/fluentcart-developer/references/database/models/shipping-class.md +148 -148
- package/dist/skills/fluentcart-developer/references/database/models/shipping-method.md +280 -280
- package/dist/skills/fluentcart-developer/references/database/models/shipping-zone.md +205 -205
- package/dist/skills/fluentcart-developer/references/database/models/subscription-meta.md +173 -173
- package/dist/skills/fluentcart-developer/references/database/models/subscription.md +528 -528
- package/dist/skills/fluentcart-developer/references/database/models/tax-class.md +195 -195
- package/dist/skills/fluentcart-developer/references/database/models/tax-rate.md +225 -225
- package/dist/skills/fluentcart-developer/references/database/models/user-meta.md +166 -166
- package/dist/skills/fluentcart-developer/references/database/models/user.md +220 -220
- package/dist/skills/fluentcart-developer/references/database/models.md +404 -404
- package/dist/skills/fluentcart-developer/references/database/query-builder.md +860 -860
- package/dist/skills/fluentcart-developer/references/database/readme.md +276 -276
- package/dist/skills/fluentcart-developer/references/database/schema.md +1002 -1002
- package/dist/skills/fluentcart-developer/references/engineering/adding-custom-pages-to-the-customer-dashboard.md +395 -395
- package/dist/skills/fluentcart-developer/references/engineering/index.md +4 -4
- package/dist/skills/fluentcart-developer/references/engineering.md +4 -4
- package/dist/skills/fluentcart-developer/references/getting-started.md +249 -249
- package/dist/skills/fluentcart-developer/references/guides/frontend.md +519 -519
- package/dist/skills/fluentcart-developer/references/guides/index.md +107 -107
- package/dist/skills/fluentcart-developer/references/guides/integrations.md +600 -600
- package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/index.md +237 -237
- package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/labels-and-tracking.md +481 -481
- package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/live-rates.md +269 -269
- package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/reference.md +223 -223
- package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/settings.md +370 -370
- package/dist/skills/fluentcart-developer/references/guides/shipping-carrier.md +237 -237
- package/dist/skills/fluentcart-developer/references/guides/subscriptions.md +217 -217
- package/dist/skills/fluentcart-developer/references/hooks/actions/admin-and-templates.md +1079 -1079
- package/dist/skills/fluentcart-developer/references/hooks/actions/cart-and-checkout.md +1795 -1795
- package/dist/skills/fluentcart-developer/references/hooks/actions/customers-and-users.md +327 -327
- package/dist/skills/fluentcart-developer/references/hooks/actions/licenses.md +829 -829
- package/dist/skills/fluentcart-developer/references/hooks/actions/modules.md +81 -81
- package/dist/skills/fluentcart-developer/references/hooks/actions/orders.md +757 -757
- package/dist/skills/fluentcart-developer/references/hooks/actions/payments-and-integrations.md +1163 -1163
- package/dist/skills/fluentcart-developer/references/hooks/actions/pro-modules.md +219 -219
- package/dist/skills/fluentcart-developer/references/hooks/actions/products-and-coupons.md +1019 -1019
- package/dist/skills/fluentcart-developer/references/hooks/actions/subscriptions.md +1290 -1290
- package/dist/skills/fluentcart-developer/references/hooks/actions.md +16 -16
- package/dist/skills/fluentcart-developer/references/hooks/deprecated.md +60 -60
- package/dist/skills/fluentcart-developer/references/hooks/filters/cart-and-checkout.md +2032 -2032
- package/dist/skills/fluentcart-developer/references/hooks/filters/customers-and-subscriptions.md +1746 -1746
- package/dist/skills/fluentcart-developer/references/hooks/filters/integrations-and-advanced.md +2439 -2439
- package/dist/skills/fluentcart-developer/references/hooks/filters/modules.md +464 -464
- package/dist/skills/fluentcart-developer/references/hooks/filters/orders-and-payments.md +2658 -2658
- package/dist/skills/fluentcart-developer/references/hooks/filters/pro-modules.md +502 -502
- package/dist/skills/fluentcart-developer/references/hooks/filters/products-and-pricing.md +1785 -1785
- package/dist/skills/fluentcart-developer/references/hooks/filters/settings-and-configuration.md +2966 -2966
- package/dist/skills/fluentcart-developer/references/hooks/filters.md +14 -14
- package/dist/skills/fluentcart-developer/references/hooks/index.md +35 -35
- package/dist/skills/fluentcart-developer/references/index.md +625 -625
- package/dist/skills/fluentcart-developer/references/modules/fee-system.md +427 -427
- package/dist/skills/fluentcart-developer/references/modules/ghost-product-selling.md +440 -440
- package/dist/skills/fluentcart-developer/references/modules/index.md +484 -484
- package/dist/skills/fluentcart-developer/references/modules/licensing.md +342 -342
- package/dist/skills/fluentcart-developer/references/modules/order-bump.md +433 -433
- package/dist/skills/fluentcart-developer/references/modules/payment-methods.md +129 -129
- package/dist/skills/fluentcart-developer/references/modules/refunds.md +170 -170
- package/dist/skills/fluentcart-developer/references/modules/shipping.md +846 -846
- package/dist/skills/fluentcart-developer/references/modules/storage.md +986 -986
- package/dist/skills/fluentcart-developer/references/modules/subscription-vendor-ids.md +186 -186
- package/dist/skills/fluentcart-developer/references/modules/subscriptions.md +678 -678
- package/dist/skills/fluentcart-developer/references/payment-methods-integration/index.md +164 -164
- package/dist/skills/fluentcart-developer/references/payment-methods-integration/paddle-example.md +1648 -1648
- package/dist/skills/fluentcart-developer/references/payment-methods-integration/payment/setting/fields.md +353 -353
- package/dist/skills/fluentcart-developer/references/payment-methods-integration/quick-implementation.md +1079 -1079
- package/dist/skills/fluentcart-developer/references/payment-methods-integration.md +164 -164
- package/dist/skills/fluentcart-developer/references/restapi/checkout.md +573 -573
- package/dist/skills/fluentcart-developer/references/restapi/coupons.md +958 -958
- package/dist/skills/fluentcart-developer/references/restapi/customer-profile.md +1423 -1423
- package/dist/skills/fluentcart-developer/references/restapi/customers.md +1103 -1103
- package/dist/skills/fluentcart-developer/references/restapi/dashboard.md +1083 -1083
- package/dist/skills/fluentcart-developer/references/restapi/data-export.md +132 -132
- package/dist/skills/fluentcart-developer/references/restapi/email-notifications.md +846 -846
- package/dist/skills/fluentcart-developer/references/restapi/files.md +313 -313
- package/dist/skills/fluentcart-developer/references/restapi/index.md +127 -127
- package/dist/skills/fluentcart-developer/references/restapi/integrations.md +1000 -1000
- package/dist/skills/fluentcart-developer/references/restapi/inventory.md +192 -192
- package/dist/skills/fluentcart-developer/references/restapi/labels-and-attributes.md +797 -797
- package/dist/skills/fluentcart-developer/references/restapi/licensing.md +1733 -1733
- package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-available-shipping-methods.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-checkout-summary.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-country-info.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-order-info.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-shipping-methods-list-view.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/login.md +66 -66
- package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/place-order.md +179 -179
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/apply-coupon.md +83 -83
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/cancel-coupon.md +87 -87
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/check-product-eligibility.md +59 -59
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/create-coupon.md +230 -230
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/delete-coupon.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/get-coupon-settings.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/get-coupon.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/list-coupon-codes.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/list-coupons.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/re-apply-coupons.md +75 -75
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/store-coupon-settings.md +40 -40
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/update-coupon.md +133 -133
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/create-address-checkout.md +138 -138
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/create-profile-address.md +119 -119
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/dashboard-overview.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/delete-profile-address.md +46 -46
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-order-details.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-portal-sections.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-profile-details.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-transaction-billing-address.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-upgrade-paths.md +31 -31
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/list-downloads.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/list-orders.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/make-profile-address-primary.md +55 -55
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/pause-subscription.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/resume-subscription.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/save-transaction-billing-address.md +92 -92
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/select-address-for-checkout.md +32 -32
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/update-profile-address.md +115 -115
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/update-profile-details.md +69 -69
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/attach-user.md +50 -50
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/bulk-actions.md +65 -65
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/create-address.md +135 -135
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/create-customer.md +108 -108
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/delete-address.md +62 -62
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/detach-user.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/find-customer-order.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-attachable-users.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer-addresses.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer-orders.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer-stats.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer.md +32 -32
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/list-customers.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/recalculate-ltv.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/set-primary-address.md +72 -72
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/update-additional-info.md +55 -55
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/update-address.md +144 -144
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/update-customer.md +123 -123
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/attach-note-to-order.md +49 -49
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/create-all-pages.md +21 -21
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/create-single-page.md +55 -55
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/delete-activity.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-country-info.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-dashboard-stats.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-filter-options.md +31 -31
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-onboarding-data.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-onboarding-settings.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-print-templates.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-search-options.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-widgets.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/initialize-app.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/list-activities.md +33 -33
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/list-attachments.md +21 -21
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/list-countries.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/mark-activity-read.md +53 -53
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/run-data-backfills.md +21 -21
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/save-onboarding-settings.md +54 -54
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/save-onboarding-tax-settings.md +73 -73
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/save-print-templates.md +64 -64
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/upload-attachment.md +42 -42
- package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-customers-batch.md +129 -129
- package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-licenses-batch.md +133 -133
- package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-orders-batch.md +129 -129
- package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-subscriptions-batch.md +129 -129
- package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-customers-export-schema.md +21 -21
- package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-licenses-export-schema.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-orders-export-schema.md +21 -21
- package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-subscriptions-export-schema.md +21 -21
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/enable-notification.md +57 -57
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-digest-settings.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-notification.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-reminders.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-settings.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-shortcodes.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/list-notifications.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/preview-default-template.md +66 -66
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/preview-notification.md +50 -50
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/save-digest-settings.md +101 -101
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/save-reminders.md +162 -162
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/save-settings.md +99 -99
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/send-digest-test.md +47 -47
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/send-manual-reminder.md +51 -51
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/update-notification.md +93 -93
- package/dist/skills/fluentcart-developer/references/restapi/operations/files/delete-file.md +31 -31
- package/dist/skills/fluentcart-developer/references/restapi/operations/files/get-bucket-list.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/files/list-files.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/files/upload-editor-file.md +32 -32
- package/dist/skills/fluentcart-developer/references/restapi/operations/files/upload-file.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/chained-data-request.md +46 -46
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/change-feed-status.md +51 -51
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/delete-feed.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-dynamic-options.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-feed-lists.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-feed-settings.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-global-feeds.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-global-settings.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/install-addon-plugin.md +49 -49
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/list-addons.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/save-feed-settings.md +52 -52
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/set-global-settings.md +50 -50
- package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/bulk-update-stock.md +94 -94
- package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/export-inventory.md +81 -81
- package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/get-adjustment-history.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/get-inventory-stats.md +21 -21
- package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/list-inventory.md +33 -33
- package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/update-stock.md +75 -75
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/create-attribute-group.md +31 -31
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/create-label.md +31 -31
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/create-terms.md +90 -90
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/delete-attribute-group.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/delete-attribute-term.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/get-attribute-group.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/get-attribute-library.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/list-attribute-groups.md +32 -32
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/list-attribute-terms.md +33 -33
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/list-labels.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/reorder-groups.md +51 -51
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/reorder-terms.md +56 -56
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/update-attribute-group.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/update-attribute-term.md +39 -39
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/update-label-selections.md +32 -32
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/activate-plugin-license.md +41 -41
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/activate-site-admin.md +60 -60
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/deactivate-plugin-license.md +18 -18
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/deactivate-site-admin.md +67 -67
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/deactivate-site-customer.md +47 -47
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/delete-license.md +24 -24
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/extend-license-validity.md +47 -47
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-customer-license-details.md +25 -25
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-customer-licenses-admin.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-license-activations.md +25 -25
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-license-details.md +25 -25
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-license-site.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-plugin-license-status.md +18 -18
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-product-license-settings.md +24 -24
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/list-customer-licenses.md +25 -25
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/list-license-sites.md +33 -33
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/list-licenses.md +38 -38
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-activate-license.md +54 -54
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-check-license.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-deactivate-license.md +46 -46
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-download-license-package.md +23 -23
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-get-license-version.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/regenerate-license-key.md +24 -24
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/save-product-license-settings.md +193 -193
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/update-license-activation-limit.md +53 -53
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/update-license-status.md +52 -52
- package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/create-order-bump.md +47 -47
- package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/delete-order-bump.md +25 -25
- package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/get-order-bump.md +25 -25
- package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/list-order-bumps.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/update-order-bump.md +141 -141
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/accept-dispute.md +47 -47
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/bulk-actions.md +72 -72
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/calculate-shipping.md +67 -67
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/calculate-tax.md +98 -98
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/change-customer.md +50 -50
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/charge-now.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-and-change-customer.md +92 -92
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-custom-order-item.md +68 -68
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-order.md +351 -351
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-renewal-now.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/delete-order.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/generate-missing-licenses.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-order-transactions.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-order.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-renewal.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-shipping-methods.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-single-transaction.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/list-order-currencies.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/list-orders.md +42 -42
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/list-renewals.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/mark-as-paid.md +61 -61
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/price-order.md +135 -135
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/refund-order.md +72 -72
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/resend-renewal-invoice.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/skip-renewal.md +48 -48
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/sync-order-statuses.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/sync-pending-transaction.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-order-address-id.md +60 -60
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-order-address.md +98 -98
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-order.md +172 -172
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-statuses.md +77 -77
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-subscription-details.md +84 -84
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-transaction-status.md +51 -51
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/void-renewal.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/create-pdf-template.md +42 -42
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/delete-pdf-template.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/download-pdf-preview.md +44 -44
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-factory-default-templates.md +19 -19
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-pdf-status.md +21 -21
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-pdf-template.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-saved-templates.md +21 -21
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-seller-details.md +19 -19
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/list-pdf-templates.md +19 -19
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/save-pdf-template.md +53 -53
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/save-seller-details.md +97 -97
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/add-product-terms.md +64 -64
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-edit-fetch.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-insert-products.md +62 -62
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-update-products.md +59 -59
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-update-variants.md +83 -83
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/change-integration-status.md +64 -64
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/create-dummy-products.md +45 -45
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/create-product.md +81 -81
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/create-variation.md +181 -181
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-downloadable-file.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-product-integration.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-product.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-taxonomy-term.md +55 -55
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-upgrade-path.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-variation.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/do-bulk-action.md +56 -56
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/duplicate-product.md +56 -56
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-products-by-ids.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-taxonomy-terms.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-terms-by-parent.md +60 -60
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-variations-by-ids.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/find-subscription-variants.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-bundle-info.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-downloadable-url.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-max-excerpt-word-count.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-pricing-widgets.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product-integration-feeds.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product-integration-settings.md +31 -31
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product-pricing.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-related-products.md +31 -31
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-upgrade-settings.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-variation-upgrade-paths.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/group-bulk-update-variants.md +103 -103
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/list-all-variants.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/list-product-variations.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/list-products.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/remove-shipping-class.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/remove-tax-class.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/save-bundle-info.md +56 -56
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/save-product-integration.md +62 -62
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/save-upgrade-path.md +78 -78
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/search-product-variant-options.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/search-products-by-name.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/search-variants-by-name.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/set-variation-media.md +74 -74
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/suggest-sku.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/sync-downloadable-files.md +134 -134
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/sync-taxonomy-terms.md +61 -61
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/toggle-product-tax-exemption.md +56 -56
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-downloadable-file.md +98 -98
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-inventory.md +56 -56
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-long-desc-editor-mode.md +49 -49
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-manage-stock.md +53 -53
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-product-detail.md +58 -58
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-product-pricing.md +225 -225
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-shipping-class.md +49 -49
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-tax-class.md +49 -49
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-upgrade-path.md +78 -78
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variant-option.md +79 -79
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variant-tax-exemption.md +56 -56
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variation-pricing-table.md +49 -49
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variation.md +105 -105
- package/dist/skills/fluentcart-developer/references/restapi/operations/public-shop/get-product-views.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/public-shop/list-products.md +42 -42
- package/dist/skills/fluentcart-developer/references/restapi/operations/public-shop/search-products.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/channel-rules.md +24 -24
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/country-heat-map.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/coupon-overview.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/coupons.md +36 -36
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-insights.md +31 -31
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-overview.md +36 -36
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-repeat.md +35 -35
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-segment-customers.md +36 -36
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-segments.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-value.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/dashboard-stats.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/failed-orders.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-new-vs-returning-customer.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-report-by-day-and-hour.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-report-meta.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-top-sold-products.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/future-renewals.md +31 -31
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/generate-retention-snapshots.md +24 -24
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-overview.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-recent-activities.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-recent-orders.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-revenue.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/installments-at-risk.md +35 -35
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/installments-variations.md +33 -33
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/installments.md +33 -33
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/item-count-distribution.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/license-chart.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/license-pie-chart.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/license-summary.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/locations.md +43 -43
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-chart.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-completion-time.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-mix.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-value-distribution.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/payment-methods-disputes.md +38 -38
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/payment-methods-methods.md +36 -36
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/payment-methods.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-comparison-launch.md +33 -33
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-comparison.md +40 -40
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-detail.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-sales.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/refunds-overview.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/retention-snapshots-step.md +45 -45
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/sales-growth-chart.md +35 -35
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/save-channel-rules.md +73 -73
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/source-channels.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/sources.md +49 -49
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-cohorts.md +33 -33
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-health.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-rebuys.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-retention.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-variations.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscriptions-overview.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/weeks-between-refund.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/assign-role.md +48 -48
- package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/delete-role-assignment.md +47 -47
- package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/get-role.md +25 -25
- package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/list-managers.md +18 -18
- package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/list-roles.md +18 -18
- package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/search-users.md +25 -25
- package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/update-role.md +43 -43
- package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/create-saved-view.md +106 -106
- package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/delete-saved-view.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/list-saved-views.md +25 -25
- package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/update-saved-view.md +83 -83
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/activate-payment-addon.md +44 -44
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/activate-plugin-addon.md +44 -44
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/change-storage-driver-status.md +56 -56
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/check-paypal-webhook.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/create-storage-bucket.md +63 -63
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/disconnect-payment-method.md +55 -55
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/exchange-paypal-seller-auth-token.md +62 -62
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-active-storage-drivers.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-checkout-fields.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-email-shortcodes.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-mcp-config-snippets.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-mcp-status.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-module-settings.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-payment-method-connection-info.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-payment-method-settings.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-permissions.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-plugin-addons.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-storage-driver-settings.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-store-settings.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/install-mcp-adapter.md +21 -21
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/install-payment-addon.md +60 -60
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/install-plugin-addon.md +64 -64
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/list-all-payment-methods.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/list-all-storage-drivers.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/list-storage-buckets.md +67 -67
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/reorder-payment-methods.md +55 -55
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/reset-storage-driver-settings.md +45 -45
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-checkout-fields.md +133 -133
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-confirmation-settings.md +68 -68
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-module-settings.md +68 -68
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-payment-method-design.md +67 -67
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-payment-method-settings.md +58 -58
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-permissions.md +68 -68
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-storage-driver-settings.md +62 -62
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-store-settings.md +239 -239
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/setup-paypal-webhook.md +48 -48
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/toggle-mcp.md +40 -40
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/verify-storage-driver-connection.md +62 -62
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/verify-turnstile-keys.md +55 -55
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/create-shipping-class.md +73 -73
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/create-shipping-method.md +110 -110
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/create-shipping-zone.md +56 -56
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/delete-shipping-class.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/delete-shipping-method.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/delete-shipping-zone.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-class-profile.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-class.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-packages.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-zone.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-zone-countries.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-zone-states.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/list-shipping-classes.md +31 -31
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/list-shipping-zones.md +31 -31
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/save-shipping-packages.md +112 -112
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-shipping-class.md +79 -79
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-shipping-method.md +113 -113
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-shipping-zone.md +62 -62
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-zone-order.md +52 -52
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/cancel-auto-renew.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/cancel-subscription.md +52 -52
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/confirm-subscription-switch.md +70 -70
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/fetch-subscription-remote.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/generate-early-payment-link.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-customer-subscription.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-or-create-plan.md +69 -69
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-setup-intent-attempts.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-subscription.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/initiate-early-payment.md +31 -31
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/list-customer-subscriptions.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/list-subscriptions.md +39 -39
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/pause-subscription.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/reactivate-subscription.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/resume-subscription.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/switch-payment-method.md +70 -70
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/update-payment-method.md +69 -69
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/update-vendor-ids.md +56 -56
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/verify-vendor-ids.md +56 -56
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/create-tax-class.md +51 -51
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/create-tax-rate.md +117 -117
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-product-override.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-shipping-tax-override.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-tax-class.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-tax-rate.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-country-tax-id.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-country-tax-rates.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-eu-vat-product-overrides.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-oss-country-rates.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-preconfigured-tax-rates.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-product-overrides.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-tax-settings.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/list-all-tax-rates.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/list-tax-classes.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/list-tax-records.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/mark-taxes-as-filed.md +58 -58
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/reset-eu-vat-rates.md +21 -21
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-configured-countries.md +57 -57
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-country-tax-id.md +50 -50
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-eu-vat-cross-border-settings.md +127 -127
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-oss-country-rates.md +100 -100
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-product-override.md +110 -110
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-shipping-tax-override.md +52 -52
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-tax-settings.md +166 -166
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/update-country-status.md +54 -54
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/update-tax-rate.md +116 -116
- package/dist/skills/fluentcart-developer/references/restapi/order-bumps.md +433 -433
- package/dist/skills/fluentcart-developer/references/restapi/orders.md +1212 -1212
- package/dist/skills/fluentcart-developer/references/restapi/pdf-templates.md +212 -212
- package/dist/skills/fluentcart-developer/references/restapi/products.md +2485 -2485
- package/dist/skills/fluentcart-developer/references/restapi/public-shop.md +191 -191
- package/dist/skills/fluentcart-developer/references/restapi/reports.md +3773 -3773
- package/dist/skills/fluentcart-developer/references/restapi/roles.md +403 -403
- package/dist/skills/fluentcart-developer/references/restapi/saved-views.md +136 -136
- package/dist/skills/fluentcart-developer/references/restapi/settings.md +1423 -1423
- package/dist/skills/fluentcart-developer/references/restapi/shipping.md +905 -905
- package/dist/skills/fluentcart-developer/references/restapi/subscriptions.md +1169 -1169
- package/dist/skills/fluentcart-developer/references/restapi/tax.md +1551 -1551
- package/dist/skills/fluentcart-developer/references/restapi.md +127 -127
- package/dist/skills/fluentcart-developer/scripts/cli.js +1 -1
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +66 -65
|
@@ -1,370 +1,370 @@
|
|
|
1
|
-
# Carrier Settings
|
|
2
|
-
|
|
3
|
-
FluentCart draws your carrier's settings page from `fields()`, including the **Save settings** and **Discard** buttons, so you write no Vue. The page is at **Settings → Shipping → Carriers → your carrier**.
|
|
4
|
-
|
|
5
|
-
This page comes from these fields:
|
|
6
|
-
|
|
7
|
-
| On the page | Field |
|
|
8
|
-
| --- | --- |
|
|
9
|
-
| Connection, Labels and Sender cards | `section` |
|
|
10
|
-
| "Connected" tag | `badge` on the section |
|
|
11
|
-
| "Printed on every label" | `aside` on the section |
|
|
12
|
-
| Enable, rates and labels switches | `toggle` |
|
|
13
|
-
| Client ID and Phone, Client Secret and Email in two columns | `'width' => 'half'` |
|
|
14
|
-
| Saved secret note | `password` |
|
|
15
|
-
| Connected strip with its Disconnect button | `status` with an action |
|
|
16
|
-
| Units row with its Change link | `readonly` with a `link` |
|
|
17
|
-
| "required" beside Phone | `label_note` |
|
|
18
|
-
| Warning under the empty Phone field | `empty_hint` |
|
|
19
|
-
|
|
20
|
-
## Carrier details
|
|
21
|
-
|
|
22
|
-
`meta()` describes the carrier.
|
|
23
|
-
|
|
24
|
-
| Key | Required | Purpose |
|
|
25
|
-
| --- | --- | --- |
|
|
26
|
-
| `slug` | Yes | Must match the key you registered it under. |
|
|
27
|
-
| `name` | Yes | Shown in the carrier list, the shipment form and on shipments. |
|
|
28
|
-
| `description` | No | Shown in the carrier list. |
|
|
29
|
-
| `supports` | No | Any of `rates`, `labels`, `tracking`. |
|
|
30
|
-
| `webhook_hint` | No | Instructions shown under the webhook URL. |
|
|
31
|
-
|
|
32
|
-
A carrier without `slug` and `name` is left out of the settings pages.
|
|
33
|
-
|
|
34
|
-
## Saving
|
|
35
|
-
|
|
36
|
-
A save runs in this order:
|
|
37
|
-
|
|
38
|
-
1. Keeps only the keys you declared. An undeclared key in the request is dropped.
|
|
39
|
-
2. Drops an empty secret, which means the admin did not retype it, so the stored value stays.
|
|
40
|
-
3. Sanitizes the values and converts toggles to `yes` or `no`.
|
|
41
|
-
4. Calls `validateSettings()`. Return the array, changed if you need to, or a `WP_Error` to reject the save with your message.
|
|
42
|
-
5. Merges the result into the stored settings.
|
|
43
|
-
|
|
44
|
-
### Storing your own data
|
|
45
|
-
|
|
46
|
-
Your carrier can store values the merchant never edits, such as tokens, a webhook secret or the time of the last event. Add them in `validateSettings()`, or call `$this->settings->save()` at any time:
|
|
47
|
-
|
|
48
|
-
```
|
|
49
|
-
$this->settings->save(['last_event_at' => gmdate('Y-m-d H:i:s')]);
|
|
50
|
-
```
|
|
51
|
-
|
|
52
|
-
`save()` merges into the stored settings, so other keys stay as they are. Keys you did not declare in `fields()` are never sent to the browser. Add them to `getDefaults()` as well.
|
|
53
|
-
|
|
54
|
-
Read a value with `$this->settings->get('key')`. Give every key a value in `getDefaults()`.
|
|
55
|
-
|
|
56
|
-
`isEnabled()` decides whether checkout offers your carrier. The default checks that `is_active` is `yes`. Override it to require credentials as well. `ProvidesLiveRates` also requires an `enable_rates` setting of `yes`.
|
|
57
|
-
|
|
58
|
-
## Input fields
|
|
59
|
-
|
|
60
|
-
Every field has a `key`, `type` and `label`. Keys share one store, so each must be unique. `hint` adds help text.
|
|
61
|
-
|
|
62
|
-
| Type | Stores | Notes |
|
|
63
|
-
| --- | --- | --- |
|
|
64
|
-
| `text` | String | `placeholder` is optional. |
|
|
65
|
-
| `password` | String | Returned to the browser as an empty string. The form shows that a value is saved and its last four characters. |
|
|
66
|
-
| `toggle` | `yes` or `no` | |
|
|
67
|
-
| `select` | Option value | `'options' => [['value' => 'a', 'label' => 'A'], ...]`. Add `groups` for a searchable list with headings: `'groups' => [['label' => 'Your accounts', 'options' => [...]]]`. |
|
|
68
|
-
| `mode` | Option value | Radio cards. Each option can hold its own `fields`. |
|
|
69
|
-
|
|
70
|
-
Input fields also accept:
|
|
71
|
-
|
|
72
|
-
- `label_note`: a small note beside the label.
|
|
73
|
-
- `'width' => 'half'`: two fields share a row.
|
|
74
|
-
- `empty_hint`: a message shown while the field is empty, such as `['tone' => 'warn', 'text' => 'Labels need a phone.']`.
|
|
75
|
-
|
|
76
|
-
Add `'is_secret' => true` to mask any other field type in the same way as a password.
|
|
77
|
-
|
|
78
|
-
A `mode` field shows an option's fields only while it is selected. Nesting is limited to one level.
|
|
79
|
-
|
|
80
|
-
```
|
|
81
|
-
[
|
|
82
|
-
'key' => 'sandbox_mode',
|
|
83
|
-
'type' => 'mode',
|
|
84
|
-
'label' => __('Connection Mode', 'acme-parcel-for-fluent-cart'),
|
|
85
|
-
'options' => [
|
|
86
|
-
[
|
|
87
|
-
'value' => 'no',
|
|
88
|
-
'label' => __('Live', 'acme-parcel-for-fluent-cart'),
|
|
89
|
-
'hint' => __('Labels are real and billed.', 'acme-parcel-for-fluent-cart'),
|
|
90
|
-
'fields' => [
|
|
91
|
-
['key' => 'live_key', 'type' => 'password', 'label' => __('Live Key', 'acme-parcel-for-fluent-cart')],
|
|
92
|
-
],
|
|
93
|
-
],
|
|
94
|
-
[
|
|
95
|
-
'value' => 'yes',
|
|
96
|
-
'label' => __('Test', 'acme-parcel-for-fluent-cart'),
|
|
97
|
-
'fields' => [
|
|
98
|
-
['key' => 'test_key', 'type' => 'password', 'label' => __('Test Key', 'acme-parcel-for-fluent-cart')],
|
|
99
|
-
],
|
|
100
|
-
],
|
|
101
|
-
],
|
|
102
|
-
],
|
|
103
|
-
```
|
|
104
|
-
|
|
105
|
-
## Display fields
|
|
106
|
-
|
|
107
|
-
These show information and store nothing. Each one still needs a unique `key`.
|
|
108
|
-
|
|
109
|
-
| Type | Keys | Purpose |
|
|
110
|
-
| --- | --- | --- |
|
|
111
|
-
| `section` | `label`, `hint`, `aside`, `badge`, `active_if` | Starts a new card. `aside` is short text in the card header. `badge` is a tag such as `['text' => 'Connected', 'tone' => 'ok', 'dot' => true]`, with a `tone` of `ok`, `warn`, `err` or `mute`. `active_if` dims the card until a field has a value: `['key' => 'is_active', 'value' => 'yes']`. |
|
|
112
|
-
| `webhook_url` | | Places the webhook URL here. Without it, the URL appears at the end of the form. |
|
|
113
|
-
| `status` | `title`, `text`, `tone`, `items`, `actions`, `note` | A strip with facts and buttons. `tone` of `err` shows it as an error. |
|
|
114
|
-
| `readonly` | `label`, `value`, `hint`, `link` | A value managed elsewhere. |
|
|
115
|
-
| `notice` | `text`, `tone`, `link` | An inline message. `tone` is `mute`, `warn` or `err`. |
|
|
116
|
-
| `webhook_setup` | `label`, `steps`, `open`, `mask_param` | Manual setup steps with a masked URL. `mask_param` names the query argument to hide. `**word**` in a step is shown in bold. |
|
|
117
|
-
|
|
118
|
-
A `link` is `['label' => 'Change', 'route' => '/settings/store-settings']`, using a route in the FluentCart admin.
|
|
119
|
-
|
|
120
|
-
Any field can use `show_if` to appear only while another field has a value. A hidden field keeps its stored value.
|
|
121
|
-
|
|
122
|
-
```
|
|
123
|
-
['key' => 'label_format', 'type' => 'text', 'label' => 'Label format', 'show_if' => ['key' => 'enable_labels', 'value' => 'yes']],
|
|
124
|
-
```
|
|
125
|
-
|
|
126
|
-
## Status actions
|
|
127
|
-
|
|
128
|
-
A button in a `status` field runs at once, without Save. Use it for actions such as testing a connection.
|
|
129
|
-
|
|
130
|
-
```
|
|
131
|
-
[
|
|
132
|
-
'key' => 'connection',
|
|
133
|
-
'type' => 'status',
|
|
134
|
-
'title' => __('Connection', 'acme-parcel-for-fluent-cart'),
|
|
135
|
-
'text' => __('Check that your API key works.', 'acme-parcel-for-fluent-cart'),
|
|
136
|
-
'actions' => [
|
|
137
|
-
['action' => 'test_connection', 'label' => __('Test connection', 'acme-parcel-for-fluent-cart'), 'variant' => 'primary'],
|
|
138
|
-
],
|
|
139
|
-
],
|
|
140
|
-
```
|
|
141
|
-
|
|
142
|
-
An action can also set `variant` to `danger`, and `confirm` to `['title' => '', 'text' => '', 'button' => '']` to ask first.
|
|
143
|
-
|
|
144
|
-
The button calls `runAction()`:
|
|
145
|
-
|
|
146
|
-
```
|
|
147
|
-
public function runAction(string $action, array $data)
|
|
148
|
-
{
|
|
149
|
-
if ($action !== 'test_connection') {
|
|
150
|
-
return parent::runAction($action, $data);
|
|
151
|
-
}
|
|
152
|
-
|
|
153
|
-
$response = $this->request('GET', '/account');
|
|
154
|
-
|
|
155
|
-
return is_wp_error($response)
|
|
156
|
-
? ['ok' => false, 'message' => $response->get_error_message()]
|
|
157
|
-
: ['ok' => true, 'message' => __('Connected.', 'acme-parcel-for-fluent-cart')];
|
|
158
|
-
}
|
|
159
|
-
```
|
|
160
|
-
|
|
161
|
-
Return `message` and `ok`, or a `WP_Error`. The page then reloads the carrier, so `fields()` can reflect what the action stored. The route needs the `store/sensitive` permission.
|
|
162
|
-
|
|
163
|
-
## Connecting with OAuth
|
|
164
|
-
|
|
165
|
-
A carrier that uses an API key needs only a `password` field. A carrier that uses OAuth needs the merchant to log in on the carrier's site and return.
|
|
166
|
-
|
|
167
|
-
Buttons on the settings page run in the background, and a `link` opens FluentCart admin routes. So start the login from a full-page link and handle both ends with a FluentCart route, the same way the Stripe and PayPal connections work. `?fluent-cart={name}` on your site fires `fluent_cart_action_{name}`.
|
|
168
|
-
|
|
169
|
-
### 1. Add the route and the link
|
|
170
|
-
|
|
171
|
-
```
|
|
172
|
-
add_action('fluent_cart_action_acme_connect', function ($data) {
|
|
173
|
-
\FluentCart\App\Modules\Shipping\Carriers\Core\CarrierManager::carrier('acme')->handleConnect($data);
|
|
174
|
-
});
|
|
175
|
-
|
|
176
|
-
add_filter('plugin_action_links_' . plugin_basename(__FILE__), function ($links) {
|
|
177
|
-
if (current_user_can('manage_options') && class_exists('\\AcmeParcel\\AcmeCarrier')) {
|
|
178
|
-
$links[] = '<a href="' . esc_url(\AcmeParcel\AcmeCarrier::connectUrl()) . '">' . esc_html__('Connect', 'acme-parcel-for-fluent-cart') . '</a>';
|
|
179
|
-
}
|
|
180
|
-
|
|
181
|
-
return $links;
|
|
182
|
-
});
|
|
183
|
-
```
|
|
184
|
-
|
|
185
|
-
This puts **Connect** on the WordPress Plugins screen. Tell the merchant where to find it with a `status` field on your settings page.
|
|
186
|
-
|
|
187
|
-
### 2. Send the merchant out and handle the return
|
|
188
|
-
|
|
189
|
-
```
|
|
190
|
-
const AUTHORIZE_URL = 'https://auth.acme-parcel.example/oauth/login';
|
|
191
|
-
const TOKEN_URL = 'https://auth.acme-parcel.example/oauth/token';
|
|
192
|
-
|
|
193
|
-
public static function connectUrl(): string
|
|
194
|
-
{
|
|
195
|
-
return add_query_arg([
|
|
196
|
-
'fluent-cart' => 'acme_connect',
|
|
197
|
-
'intent' => 'connect',
|
|
198
|
-
'_wpnonce' => wp_create_nonce('acme_connect'),
|
|
199
|
-
], home_url('/'));
|
|
200
|
-
}
|
|
201
|
-
|
|
202
|
-
public function handleConnect(array $data): void
|
|
203
|
-
{
|
|
204
|
-
if (!current_user_can('manage_options')) {
|
|
205
|
-
wp_die(esc_html__('You do not have permission to do this.', 'acme-parcel-for-fluent-cart'), '', ['response' => 403]);
|
|
206
|
-
}
|
|
207
|
-
|
|
208
|
-
$intent = sanitize_key((string) Arr::get($data, 'intent', ''));
|
|
209
|
-
$stateKey = 'acme_oauth_state_' . get_current_user_id();
|
|
210
|
-
$redirectTo = add_query_arg(['fluent-cart' => 'acme_connect', 'intent' => 'callback'], home_url('/'));
|
|
211
|
-
|
|
212
|
-
if ($intent === 'connect') {
|
|
213
|
-
check_admin_referer('acme_connect');
|
|
214
|
-
|
|
215
|
-
$state = wp_generate_password(32, false);
|
|
216
|
-
set_transient($stateKey, $state, 10 * MINUTE_IN_SECONDS);
|
|
217
|
-
|
|
218
|
-
wp_redirect(add_query_arg([
|
|
219
|
-
'response_type' => 'code',
|
|
220
|
-
'client_id' => rawurlencode((string) $this->settings->get('client_id')),
|
|
221
|
-
'redirect_uri' => rawurlencode($redirectTo),
|
|
222
|
-
'state' => $state,
|
|
223
|
-
], self::AUTHORIZE_URL));
|
|
224
|
-
exit;
|
|
225
|
-
}
|
|
226
|
-
|
|
227
|
-
$state = (string) Arr::get($data, 'state', '');
|
|
228
|
-
$expected = (string) get_transient($stateKey);
|
|
229
|
-
delete_transient($stateKey);
|
|
230
|
-
|
|
231
|
-
if ($intent !== 'callback' || $expected === '' || !hash_equals($expected, $state)) {
|
|
232
|
-
wp_die(esc_html__('This connection request has expired. Please try again.', 'acme-parcel-for-fluent-cart'), '', ['response' => 400]);
|
|
233
|
-
}
|
|
234
|
-
|
|
235
|
-
$tokens = $this->requestTokens([
|
|
236
|
-
'grant_type' => 'authorization_code',
|
|
237
|
-
'code' => sanitize_text_field((string) Arr::get($data, 'code', '')),
|
|
238
|
-
'redirect_uri' => $redirectTo,
|
|
239
|
-
]);
|
|
240
|
-
|
|
241
|
-
if (is_wp_error($tokens)) {
|
|
242
|
-
wp_die(esc_html($tokens->get_error_message()), '', ['response' => 502]);
|
|
243
|
-
}
|
|
244
|
-
|
|
245
|
-
$this->storeTokens($tokens);
|
|
246
|
-
|
|
247
|
-
wp_safe_redirect(admin_url('admin.php?page=fluent-cart#/settings/shipping/carriers/' . self::SLUG));
|
|
248
|
-
exit;
|
|
249
|
-
}
|
|
250
|
-
```
|
|
251
|
-
|
|
252
|
-
Register `https://your-site.com/?fluent-cart=acme_connect&intent=callback` as the redirect URL in your OAuth app. This route is public, so keep all three checks: the `manage_options` permission, the nonce when the login starts, and the single-use `state` when it returns.
|
|
253
|
-
|
|
254
|
-
### 3. Store and refresh the tokens
|
|
255
|
-
|
|
256
|
-
```
|
|
257
|
-
/**
|
|
258
|
-
* @return string|\WP_Error
|
|
259
|
-
*/
|
|
260
|
-
protected function accessToken()
|
|
261
|
-
{
|
|
262
|
-
if ((int) $this->settings->get('token_expires_at') > time() + MINUTE_IN_SECONDS) {
|
|
263
|
-
return Helper::decryptKey((string) $this->settings->get('access_token'));
|
|
264
|
-
}
|
|
265
|
-
|
|
266
|
-
$tokens = $this->requestTokens([
|
|
267
|
-
'grant_type' => 'refresh_token',
|
|
268
|
-
'refresh_token' => Helper::decryptKey((string) $this->settings->get('refresh_token')),
|
|
269
|
-
]);
|
|
270
|
-
|
|
271
|
-
if (is_wp_error($tokens)) {
|
|
272
|
-
return $tokens;
|
|
273
|
-
}
|
|
274
|
-
|
|
275
|
-
$this->storeTokens($tokens);
|
|
276
|
-
|
|
277
|
-
return (string) $tokens['access_token'];
|
|
278
|
-
}
|
|
279
|
-
|
|
280
|
-
protected function storeTokens(array $tokens): void
|
|
281
|
-
{
|
|
282
|
-
$refreshToken = (string) Arr::get($tokens, 'refresh_token', '');
|
|
283
|
-
|
|
284
|
-
$this->settings->save([
|
|
285
|
-
'access_token' => Helper::encryptKey((string) $tokens['access_token']),
|
|
286
|
-
'refresh_token' => $refreshToken !== '' ? Helper::encryptKey($refreshToken) : $this->settings->get('refresh_token'),
|
|
287
|
-
'token_expires_at' => time() + (int) Arr::get($tokens, 'expires_in', 0),
|
|
288
|
-
]);
|
|
289
|
-
}
|
|
290
|
-
|
|
291
|
-
/**
|
|
292
|
-
* @return array|\WP_Error
|
|
293
|
-
*/
|
|
294
|
-
protected function requestTokens(array $body)
|
|
295
|
-
{
|
|
296
|
-
$response = wp_remote_post(self::TOKEN_URL, [
|
|
297
|
-
'timeout' => 15,
|
|
298
|
-
'headers' => ['Authorization' => 'Basic ' . base64_encode($this->settings->get('client_id') . ':' . $this->settings->get('client_secret'))],
|
|
299
|
-
'body' => $body,
|
|
300
|
-
]);
|
|
301
|
-
|
|
302
|
-
if (is_wp_error($response)) {
|
|
303
|
-
return new \WP_Error('acme_unreachable', $response->get_error_message(), ['http_code' => 0]);
|
|
304
|
-
}
|
|
305
|
-
|
|
306
|
-
$code = (int) wp_remote_retrieve_response_code($response);
|
|
307
|
-
$data = json_decode(wp_remote_retrieve_body($response), true);
|
|
308
|
-
|
|
309
|
-
if ($code !== 200 || empty($data['access_token'])) {
|
|
310
|
-
return new \WP_Error('acme_token_failed', __('Acme Parcel refused the connection.', 'acme-parcel-for-fluent-cart'), ['http_code' => 401]);
|
|
311
|
-
}
|
|
312
|
-
|
|
313
|
-
return $data;
|
|
314
|
-
}
|
|
315
|
-
```
|
|
316
|
-
|
|
317
|
-
Call `accessToken()` in your API request and send the result as the bearer token. Return its `WP_Error` if it fails. `Helper::encryptKey()` keeps the tokens encrypted in the database. A failed refresh shows no rates at checkout and backs off for 60 seconds, and the stored tokens stay. Show this to the merchant with a setup notice.
|
|
318
|
-
|
|
319
|
-
If your provider issues a new refresh token each time, two checkouts can refresh at once and one can lose. Guard the refresh with a short lock in that case.
|
|
320
|
-
|
|
321
|
-
### 4. Disconnect
|
|
322
|
-
|
|
323
|
-
A `status` button works here, because nothing leaves the page:
|
|
324
|
-
|
|
325
|
-
```
|
|
326
|
-
public function runAction(string $action, array $data)
|
|
327
|
-
{
|
|
328
|
-
if ($action !== 'disconnect') {
|
|
329
|
-
return parent::runAction($action, $data);
|
|
330
|
-
}
|
|
331
|
-
|
|
332
|
-
$this->settings->save(['access_token' => '', 'refresh_token' => '', 'token_expires_at' => 0]);
|
|
333
|
-
|
|
334
|
-
return ['ok' => true, 'message' => __('Disconnected.', 'acme-parcel-for-fluent-cart')];
|
|
335
|
-
}
|
|
336
|
-
```
|
|
337
|
-
|
|
338
|
-
Make `isEnabled()` require the refresh token, so checkout offers the carrier only while it is connected:
|
|
339
|
-
|
|
340
|
-
```
|
|
341
|
-
public function isEnabled(): bool
|
|
342
|
-
{
|
|
343
|
-
return $this->settings->get('is_active') === 'yes' && (string) $this->settings->get('refresh_token') !== '';
|
|
344
|
-
}
|
|
345
|
-
```
|
|
346
|
-
|
|
347
|
-
## Setup notices
|
|
348
|
-
|
|
349
|
-
`getSetupNotices()` lists problems the merchant must fix. They appear on the carrier pages, and the carrier list marks the carrier as needing attention.
|
|
350
|
-
|
|
351
|
-
```
|
|
352
|
-
public function getSetupNotices(): array
|
|
353
|
-
{
|
|
354
|
-
$notices = [];
|
|
355
|
-
|
|
356
|
-
if ($this->settings->get('is_active') === 'yes' && !$this->settings->get('api_key')) {
|
|
357
|
-
$notices[] = [
|
|
358
|
-
'type' => 'error',
|
|
359
|
-
'message' => __('Add your API key to start showing rates.', 'acme-parcel-for-fluent-cart'),
|
|
360
|
-
'action' => null,
|
|
361
|
-
];
|
|
362
|
-
}
|
|
363
|
-
|
|
364
|
-
return $notices;
|
|
365
|
-
}
|
|
366
|
-
```
|
|
367
|
-
|
|
368
|
-
`type` is `error`, `warning` or `info`. `action` is `null` or `['label' => '', 'route' => '']`. This method runs each time the carrier list loads, so read stored settings only and do not call your API.
|
|
369
|
-
|
|
370
|
-
The `ProvidesSetupNotices` trait adds two helpers. `originSetupNotice($carrierName)` returns a notice when the store address is incomplete, or `null`. `setupNotice($type, $message)` builds a plain notice. It needs `buildOrigin()`, which `ProvidesLiveRates` provides.
|
|
1
|
+
# Carrier Settings
|
|
2
|
+
|
|
3
|
+
FluentCart draws your carrier's settings page from `fields()`, including the **Save settings** and **Discard** buttons, so you write no Vue. The page is at **Settings → Shipping → Carriers → your carrier**.
|
|
4
|
+
|
|
5
|
+
This page comes from these fields:
|
|
6
|
+
|
|
7
|
+
| On the page | Field |
|
|
8
|
+
| --- | --- |
|
|
9
|
+
| Connection, Labels and Sender cards | `section` |
|
|
10
|
+
| "Connected" tag | `badge` on the section |
|
|
11
|
+
| "Printed on every label" | `aside` on the section |
|
|
12
|
+
| Enable, rates and labels switches | `toggle` |
|
|
13
|
+
| Client ID and Phone, Client Secret and Email in two columns | `'width' => 'half'` |
|
|
14
|
+
| Saved secret note | `password` |
|
|
15
|
+
| Connected strip with its Disconnect button | `status` with an action |
|
|
16
|
+
| Units row with its Change link | `readonly` with a `link` |
|
|
17
|
+
| "required" beside Phone | `label_note` |
|
|
18
|
+
| Warning under the empty Phone field | `empty_hint` |
|
|
19
|
+
|
|
20
|
+
## Carrier details
|
|
21
|
+
|
|
22
|
+
`meta()` describes the carrier.
|
|
23
|
+
|
|
24
|
+
| Key | Required | Purpose |
|
|
25
|
+
| --- | --- | --- |
|
|
26
|
+
| `slug` | Yes | Must match the key you registered it under. |
|
|
27
|
+
| `name` | Yes | Shown in the carrier list, the shipment form and on shipments. |
|
|
28
|
+
| `description` | No | Shown in the carrier list. |
|
|
29
|
+
| `supports` | No | Any of `rates`, `labels`, `tracking`. |
|
|
30
|
+
| `webhook_hint` | No | Instructions shown under the webhook URL. |
|
|
31
|
+
|
|
32
|
+
A carrier without `slug` and `name` is left out of the settings pages.
|
|
33
|
+
|
|
34
|
+
## Saving
|
|
35
|
+
|
|
36
|
+
A save runs in this order:
|
|
37
|
+
|
|
38
|
+
1. Keeps only the keys you declared. An undeclared key in the request is dropped.
|
|
39
|
+
2. Drops an empty secret, which means the admin did not retype it, so the stored value stays.
|
|
40
|
+
3. Sanitizes the values and converts toggles to `yes` or `no`.
|
|
41
|
+
4. Calls `validateSettings()`. Return the array, changed if you need to, or a `WP_Error` to reject the save with your message.
|
|
42
|
+
5. Merges the result into the stored settings.
|
|
43
|
+
|
|
44
|
+
### Storing your own data
|
|
45
|
+
|
|
46
|
+
Your carrier can store values the merchant never edits, such as tokens, a webhook secret or the time of the last event. Add them in `validateSettings()`, or call `$this->settings->save()` at any time:
|
|
47
|
+
|
|
48
|
+
```
|
|
49
|
+
$this->settings->save(['last_event_at' => gmdate('Y-m-d H:i:s')]);
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
`save()` merges into the stored settings, so other keys stay as they are. Keys you did not declare in `fields()` are never sent to the browser. Add them to `getDefaults()` as well.
|
|
53
|
+
|
|
54
|
+
Read a value with `$this->settings->get('key')`. Give every key a value in `getDefaults()`.
|
|
55
|
+
|
|
56
|
+
`isEnabled()` decides whether checkout offers your carrier. The default checks that `is_active` is `yes`. Override it to require credentials as well. `ProvidesLiveRates` also requires an `enable_rates` setting of `yes`.
|
|
57
|
+
|
|
58
|
+
## Input fields
|
|
59
|
+
|
|
60
|
+
Every field has a `key`, `type` and `label`. Keys share one store, so each must be unique. `hint` adds help text.
|
|
61
|
+
|
|
62
|
+
| Type | Stores | Notes |
|
|
63
|
+
| --- | --- | --- |
|
|
64
|
+
| `text` | String | `placeholder` is optional. |
|
|
65
|
+
| `password` | String | Returned to the browser as an empty string. The form shows that a value is saved and its last four characters. |
|
|
66
|
+
| `toggle` | `yes` or `no` | |
|
|
67
|
+
| `select` | Option value | `'options' => [['value' => 'a', 'label' => 'A'], ...]`. Add `groups` for a searchable list with headings: `'groups' => [['label' => 'Your accounts', 'options' => [...]]]`. |
|
|
68
|
+
| `mode` | Option value | Radio cards. Each option can hold its own `fields`. |
|
|
69
|
+
|
|
70
|
+
Input fields also accept:
|
|
71
|
+
|
|
72
|
+
- `label_note`: a small note beside the label.
|
|
73
|
+
- `'width' => 'half'`: two fields share a row.
|
|
74
|
+
- `empty_hint`: a message shown while the field is empty, such as `['tone' => 'warn', 'text' => 'Labels need a phone.']`.
|
|
75
|
+
|
|
76
|
+
Add `'is_secret' => true` to mask any other field type in the same way as a password.
|
|
77
|
+
|
|
78
|
+
A `mode` field shows an option's fields only while it is selected. Nesting is limited to one level.
|
|
79
|
+
|
|
80
|
+
```
|
|
81
|
+
[
|
|
82
|
+
'key' => 'sandbox_mode',
|
|
83
|
+
'type' => 'mode',
|
|
84
|
+
'label' => __('Connection Mode', 'acme-parcel-for-fluent-cart'),
|
|
85
|
+
'options' => [
|
|
86
|
+
[
|
|
87
|
+
'value' => 'no',
|
|
88
|
+
'label' => __('Live', 'acme-parcel-for-fluent-cart'),
|
|
89
|
+
'hint' => __('Labels are real and billed.', 'acme-parcel-for-fluent-cart'),
|
|
90
|
+
'fields' => [
|
|
91
|
+
['key' => 'live_key', 'type' => 'password', 'label' => __('Live Key', 'acme-parcel-for-fluent-cart')],
|
|
92
|
+
],
|
|
93
|
+
],
|
|
94
|
+
[
|
|
95
|
+
'value' => 'yes',
|
|
96
|
+
'label' => __('Test', 'acme-parcel-for-fluent-cart'),
|
|
97
|
+
'fields' => [
|
|
98
|
+
['key' => 'test_key', 'type' => 'password', 'label' => __('Test Key', 'acme-parcel-for-fluent-cart')],
|
|
99
|
+
],
|
|
100
|
+
],
|
|
101
|
+
],
|
|
102
|
+
],
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
## Display fields
|
|
106
|
+
|
|
107
|
+
These show information and store nothing. Each one still needs a unique `key`.
|
|
108
|
+
|
|
109
|
+
| Type | Keys | Purpose |
|
|
110
|
+
| --- | --- | --- |
|
|
111
|
+
| `section` | `label`, `hint`, `aside`, `badge`, `active_if` | Starts a new card. `aside` is short text in the card header. `badge` is a tag such as `['text' => 'Connected', 'tone' => 'ok', 'dot' => true]`, with a `tone` of `ok`, `warn`, `err` or `mute`. `active_if` dims the card until a field has a value: `['key' => 'is_active', 'value' => 'yes']`. |
|
|
112
|
+
| `webhook_url` | | Places the webhook URL here. Without it, the URL appears at the end of the form. |
|
|
113
|
+
| `status` | `title`, `text`, `tone`, `items`, `actions`, `note` | A strip with facts and buttons. `tone` of `err` shows it as an error. |
|
|
114
|
+
| `readonly` | `label`, `value`, `hint`, `link` | A value managed elsewhere. |
|
|
115
|
+
| `notice` | `text`, `tone`, `link` | An inline message. `tone` is `mute`, `warn` or `err`. |
|
|
116
|
+
| `webhook_setup` | `label`, `steps`, `open`, `mask_param` | Manual setup steps with a masked URL. `mask_param` names the query argument to hide. `**word**` in a step is shown in bold. |
|
|
117
|
+
|
|
118
|
+
A `link` is `['label' => 'Change', 'route' => '/settings/store-settings']`, using a route in the FluentCart admin.
|
|
119
|
+
|
|
120
|
+
Any field can use `show_if` to appear only while another field has a value. A hidden field keeps its stored value.
|
|
121
|
+
|
|
122
|
+
```
|
|
123
|
+
['key' => 'label_format', 'type' => 'text', 'label' => 'Label format', 'show_if' => ['key' => 'enable_labels', 'value' => 'yes']],
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
## Status actions
|
|
127
|
+
|
|
128
|
+
A button in a `status` field runs at once, without Save. Use it for actions such as testing a connection.
|
|
129
|
+
|
|
130
|
+
```
|
|
131
|
+
[
|
|
132
|
+
'key' => 'connection',
|
|
133
|
+
'type' => 'status',
|
|
134
|
+
'title' => __('Connection', 'acme-parcel-for-fluent-cart'),
|
|
135
|
+
'text' => __('Check that your API key works.', 'acme-parcel-for-fluent-cart'),
|
|
136
|
+
'actions' => [
|
|
137
|
+
['action' => 'test_connection', 'label' => __('Test connection', 'acme-parcel-for-fluent-cart'), 'variant' => 'primary'],
|
|
138
|
+
],
|
|
139
|
+
],
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
An action can also set `variant` to `danger`, and `confirm` to `['title' => '', 'text' => '', 'button' => '']` to ask first.
|
|
143
|
+
|
|
144
|
+
The button calls `runAction()`:
|
|
145
|
+
|
|
146
|
+
```
|
|
147
|
+
public function runAction(string $action, array $data)
|
|
148
|
+
{
|
|
149
|
+
if ($action !== 'test_connection') {
|
|
150
|
+
return parent::runAction($action, $data);
|
|
151
|
+
}
|
|
152
|
+
|
|
153
|
+
$response = $this->request('GET', '/account');
|
|
154
|
+
|
|
155
|
+
return is_wp_error($response)
|
|
156
|
+
? ['ok' => false, 'message' => $response->get_error_message()]
|
|
157
|
+
: ['ok' => true, 'message' => __('Connected.', 'acme-parcel-for-fluent-cart')];
|
|
158
|
+
}
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
Return `message` and `ok`, or a `WP_Error`. The page then reloads the carrier, so `fields()` can reflect what the action stored. The route needs the `store/sensitive` permission.
|
|
162
|
+
|
|
163
|
+
## Connecting with OAuth
|
|
164
|
+
|
|
165
|
+
A carrier that uses an API key needs only a `password` field. A carrier that uses OAuth needs the merchant to log in on the carrier's site and return.
|
|
166
|
+
|
|
167
|
+
Buttons on the settings page run in the background, and a `link` opens FluentCart admin routes. So start the login from a full-page link and handle both ends with a FluentCart route, the same way the Stripe and PayPal connections work. `?fluent-cart={name}` on your site fires `fluent_cart_action_{name}`.
|
|
168
|
+
|
|
169
|
+
### 1. Add the route and the link
|
|
170
|
+
|
|
171
|
+
```
|
|
172
|
+
add_action('fluent_cart_action_acme_connect', function ($data) {
|
|
173
|
+
\FluentCart\App\Modules\Shipping\Carriers\Core\CarrierManager::carrier('acme')->handleConnect($data);
|
|
174
|
+
});
|
|
175
|
+
|
|
176
|
+
add_filter('plugin_action_links_' . plugin_basename(__FILE__), function ($links) {
|
|
177
|
+
if (current_user_can('manage_options') && class_exists('\\AcmeParcel\\AcmeCarrier')) {
|
|
178
|
+
$links[] = '<a href="' . esc_url(\AcmeParcel\AcmeCarrier::connectUrl()) . '">' . esc_html__('Connect', 'acme-parcel-for-fluent-cart') . '</a>';
|
|
179
|
+
}
|
|
180
|
+
|
|
181
|
+
return $links;
|
|
182
|
+
});
|
|
183
|
+
```
|
|
184
|
+
|
|
185
|
+
This puts **Connect** on the WordPress Plugins screen. Tell the merchant where to find it with a `status` field on your settings page.
|
|
186
|
+
|
|
187
|
+
### 2. Send the merchant out and handle the return
|
|
188
|
+
|
|
189
|
+
```
|
|
190
|
+
const AUTHORIZE_URL = 'https://auth.acme-parcel.example/oauth/login';
|
|
191
|
+
const TOKEN_URL = 'https://auth.acme-parcel.example/oauth/token';
|
|
192
|
+
|
|
193
|
+
public static function connectUrl(): string
|
|
194
|
+
{
|
|
195
|
+
return add_query_arg([
|
|
196
|
+
'fluent-cart' => 'acme_connect',
|
|
197
|
+
'intent' => 'connect',
|
|
198
|
+
'_wpnonce' => wp_create_nonce('acme_connect'),
|
|
199
|
+
], home_url('/'));
|
|
200
|
+
}
|
|
201
|
+
|
|
202
|
+
public function handleConnect(array $data): void
|
|
203
|
+
{
|
|
204
|
+
if (!current_user_can('manage_options')) {
|
|
205
|
+
wp_die(esc_html__('You do not have permission to do this.', 'acme-parcel-for-fluent-cart'), '', ['response' => 403]);
|
|
206
|
+
}
|
|
207
|
+
|
|
208
|
+
$intent = sanitize_key((string) Arr::get($data, 'intent', ''));
|
|
209
|
+
$stateKey = 'acme_oauth_state_' . get_current_user_id();
|
|
210
|
+
$redirectTo = add_query_arg(['fluent-cart' => 'acme_connect', 'intent' => 'callback'], home_url('/'));
|
|
211
|
+
|
|
212
|
+
if ($intent === 'connect') {
|
|
213
|
+
check_admin_referer('acme_connect');
|
|
214
|
+
|
|
215
|
+
$state = wp_generate_password(32, false);
|
|
216
|
+
set_transient($stateKey, $state, 10 * MINUTE_IN_SECONDS);
|
|
217
|
+
|
|
218
|
+
wp_redirect(add_query_arg([
|
|
219
|
+
'response_type' => 'code',
|
|
220
|
+
'client_id' => rawurlencode((string) $this->settings->get('client_id')),
|
|
221
|
+
'redirect_uri' => rawurlencode($redirectTo),
|
|
222
|
+
'state' => $state,
|
|
223
|
+
], self::AUTHORIZE_URL));
|
|
224
|
+
exit;
|
|
225
|
+
}
|
|
226
|
+
|
|
227
|
+
$state = (string) Arr::get($data, 'state', '');
|
|
228
|
+
$expected = (string) get_transient($stateKey);
|
|
229
|
+
delete_transient($stateKey);
|
|
230
|
+
|
|
231
|
+
if ($intent !== 'callback' || $expected === '' || !hash_equals($expected, $state)) {
|
|
232
|
+
wp_die(esc_html__('This connection request has expired. Please try again.', 'acme-parcel-for-fluent-cart'), '', ['response' => 400]);
|
|
233
|
+
}
|
|
234
|
+
|
|
235
|
+
$tokens = $this->requestTokens([
|
|
236
|
+
'grant_type' => 'authorization_code',
|
|
237
|
+
'code' => sanitize_text_field((string) Arr::get($data, 'code', '')),
|
|
238
|
+
'redirect_uri' => $redirectTo,
|
|
239
|
+
]);
|
|
240
|
+
|
|
241
|
+
if (is_wp_error($tokens)) {
|
|
242
|
+
wp_die(esc_html($tokens->get_error_message()), '', ['response' => 502]);
|
|
243
|
+
}
|
|
244
|
+
|
|
245
|
+
$this->storeTokens($tokens);
|
|
246
|
+
|
|
247
|
+
wp_safe_redirect(admin_url('admin.php?page=fluent-cart#/settings/shipping/carriers/' . self::SLUG));
|
|
248
|
+
exit;
|
|
249
|
+
}
|
|
250
|
+
```
|
|
251
|
+
|
|
252
|
+
Register `https://your-site.com/?fluent-cart=acme_connect&intent=callback` as the redirect URL in your OAuth app. This route is public, so keep all three checks: the `manage_options` permission, the nonce when the login starts, and the single-use `state` when it returns.
|
|
253
|
+
|
|
254
|
+
### 3. Store and refresh the tokens
|
|
255
|
+
|
|
256
|
+
```
|
|
257
|
+
/**
|
|
258
|
+
* @return string|\WP_Error
|
|
259
|
+
*/
|
|
260
|
+
protected function accessToken()
|
|
261
|
+
{
|
|
262
|
+
if ((int) $this->settings->get('token_expires_at') > time() + MINUTE_IN_SECONDS) {
|
|
263
|
+
return Helper::decryptKey((string) $this->settings->get('access_token'));
|
|
264
|
+
}
|
|
265
|
+
|
|
266
|
+
$tokens = $this->requestTokens([
|
|
267
|
+
'grant_type' => 'refresh_token',
|
|
268
|
+
'refresh_token' => Helper::decryptKey((string) $this->settings->get('refresh_token')),
|
|
269
|
+
]);
|
|
270
|
+
|
|
271
|
+
if (is_wp_error($tokens)) {
|
|
272
|
+
return $tokens;
|
|
273
|
+
}
|
|
274
|
+
|
|
275
|
+
$this->storeTokens($tokens);
|
|
276
|
+
|
|
277
|
+
return (string) $tokens['access_token'];
|
|
278
|
+
}
|
|
279
|
+
|
|
280
|
+
protected function storeTokens(array $tokens): void
|
|
281
|
+
{
|
|
282
|
+
$refreshToken = (string) Arr::get($tokens, 'refresh_token', '');
|
|
283
|
+
|
|
284
|
+
$this->settings->save([
|
|
285
|
+
'access_token' => Helper::encryptKey((string) $tokens['access_token']),
|
|
286
|
+
'refresh_token' => $refreshToken !== '' ? Helper::encryptKey($refreshToken) : $this->settings->get('refresh_token'),
|
|
287
|
+
'token_expires_at' => time() + (int) Arr::get($tokens, 'expires_in', 0),
|
|
288
|
+
]);
|
|
289
|
+
}
|
|
290
|
+
|
|
291
|
+
/**
|
|
292
|
+
* @return array|\WP_Error
|
|
293
|
+
*/
|
|
294
|
+
protected function requestTokens(array $body)
|
|
295
|
+
{
|
|
296
|
+
$response = wp_remote_post(self::TOKEN_URL, [
|
|
297
|
+
'timeout' => 15,
|
|
298
|
+
'headers' => ['Authorization' => 'Basic ' . base64_encode($this->settings->get('client_id') . ':' . $this->settings->get('client_secret'))],
|
|
299
|
+
'body' => $body,
|
|
300
|
+
]);
|
|
301
|
+
|
|
302
|
+
if (is_wp_error($response)) {
|
|
303
|
+
return new \WP_Error('acme_unreachable', $response->get_error_message(), ['http_code' => 0]);
|
|
304
|
+
}
|
|
305
|
+
|
|
306
|
+
$code = (int) wp_remote_retrieve_response_code($response);
|
|
307
|
+
$data = json_decode(wp_remote_retrieve_body($response), true);
|
|
308
|
+
|
|
309
|
+
if ($code !== 200 || empty($data['access_token'])) {
|
|
310
|
+
return new \WP_Error('acme_token_failed', __('Acme Parcel refused the connection.', 'acme-parcel-for-fluent-cart'), ['http_code' => 401]);
|
|
311
|
+
}
|
|
312
|
+
|
|
313
|
+
return $data;
|
|
314
|
+
}
|
|
315
|
+
```
|
|
316
|
+
|
|
317
|
+
Call `accessToken()` in your API request and send the result as the bearer token. Return its `WP_Error` if it fails. `Helper::encryptKey()` keeps the tokens encrypted in the database. A failed refresh shows no rates at checkout and backs off for 60 seconds, and the stored tokens stay. Show this to the merchant with a setup notice.
|
|
318
|
+
|
|
319
|
+
If your provider issues a new refresh token each time, two checkouts can refresh at once and one can lose. Guard the refresh with a short lock in that case.
|
|
320
|
+
|
|
321
|
+
### 4. Disconnect
|
|
322
|
+
|
|
323
|
+
A `status` button works here, because nothing leaves the page:
|
|
324
|
+
|
|
325
|
+
```
|
|
326
|
+
public function runAction(string $action, array $data)
|
|
327
|
+
{
|
|
328
|
+
if ($action !== 'disconnect') {
|
|
329
|
+
return parent::runAction($action, $data);
|
|
330
|
+
}
|
|
331
|
+
|
|
332
|
+
$this->settings->save(['access_token' => '', 'refresh_token' => '', 'token_expires_at' => 0]);
|
|
333
|
+
|
|
334
|
+
return ['ok' => true, 'message' => __('Disconnected.', 'acme-parcel-for-fluent-cart')];
|
|
335
|
+
}
|
|
336
|
+
```
|
|
337
|
+
|
|
338
|
+
Make `isEnabled()` require the refresh token, so checkout offers the carrier only while it is connected:
|
|
339
|
+
|
|
340
|
+
```
|
|
341
|
+
public function isEnabled(): bool
|
|
342
|
+
{
|
|
343
|
+
return $this->settings->get('is_active') === 'yes' && (string) $this->settings->get('refresh_token') !== '';
|
|
344
|
+
}
|
|
345
|
+
```
|
|
346
|
+
|
|
347
|
+
## Setup notices
|
|
348
|
+
|
|
349
|
+
`getSetupNotices()` lists problems the merchant must fix. They appear on the carrier pages, and the carrier list marks the carrier as needing attention.
|
|
350
|
+
|
|
351
|
+
```
|
|
352
|
+
public function getSetupNotices(): array
|
|
353
|
+
{
|
|
354
|
+
$notices = [];
|
|
355
|
+
|
|
356
|
+
if ($this->settings->get('is_active') === 'yes' && !$this->settings->get('api_key')) {
|
|
357
|
+
$notices[] = [
|
|
358
|
+
'type' => 'error',
|
|
359
|
+
'message' => __('Add your API key to start showing rates.', 'acme-parcel-for-fluent-cart'),
|
|
360
|
+
'action' => null,
|
|
361
|
+
];
|
|
362
|
+
}
|
|
363
|
+
|
|
364
|
+
return $notices;
|
|
365
|
+
}
|
|
366
|
+
```
|
|
367
|
+
|
|
368
|
+
`type` is `error`, `warning` or `info`. `action` is `null` or `['label' => '', 'route' => '']`. This method runs each time the carrier list loads, so read stored settings only and do not call your API.
|
|
369
|
+
|
|
370
|
+
The `ProvidesSetupNotices` trait adds two helpers. `originSetupNotice($carrierName)` returns a notice when the store address is incomplete, or `null`. `setupNotice($type, $message)` builds a plain notice. It needs `buildOrigin()`, which `ProvidesLiveRates` provides.
|