fluentcart-developer 3.0.0 → 3.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE.md +26 -26
- package/README.md +59 -59
- package/dist/cards/fluentcart/templates-native.js +1087 -1087
- package/dist/cards/fluentcart/tools.js +2309 -2309
- package/dist/server.d.ts.map +1 -1
- package/dist/server.js +37 -1
- package/dist/server.js.map +1 -1
- package/dist/skills/fluentcart-developer/SKILL.md +108 -108
- package/dist/skills/fluentcart-developer/examples/README.md +30 -30
- package/dist/skills/fluentcart-developer/examples/fluentcart-starter-child-theme/fluent-cart/checkout.php +32 -32
- package/dist/skills/fluentcart-developer/examples/fluentcart-starter-child-theme/functions.php +40 -40
- package/dist/skills/fluentcart-developer/examples/sample-custom-addon/fluentcart-custom-addon.php +113 -113
- package/dist/skills/fluentcart-developer/examples/sample-custom-payment-gateway/fluentcart-custom-gateway-example.php +148 -148
- package/dist/skills/fluentcart-developer/examples/sample-fee-surcharge-plugin/fluentcart-fee-surcharge.php +38 -38
- package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/README.md +22 -22
- package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/sample-plugin-with-licensing-sdk.php +79 -79
- package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/updater/FluentLicensing.php +303 -303
- package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/updater/LicenseSettings.php +566 -566
- package/dist/skills/fluentcart-developer/examples/sample-plugin-with-licensing-sdk/updater/PluginUpdater.php +304 -304
- package/dist/skills/fluentcart-developer/examples/sample-shipping-carrier/fluentcart-custom-shipping-carrier.php +61 -61
- package/dist/skills/fluentcart-developer/references/api/authentication.md +452 -452
- package/dist/skills/fluentcart-developer/references/api/coupons.md +786 -786
- package/dist/skills/fluentcart-developer/references/api/customers.md +889 -889
- package/dist/skills/fluentcart-developer/references/api/files.md +609 -609
- package/dist/skills/fluentcart-developer/references/api/index.md +432 -432
- package/dist/skills/fluentcart-developer/references/api/licensing.md +633 -633
- package/dist/skills/fluentcart-developer/references/api/order-bump.md +384 -384
- package/dist/skills/fluentcart-developer/references/api/orders.md +814 -814
- package/dist/skills/fluentcart-developer/references/api/products.md +866 -866
- package/dist/skills/fluentcart-developer/references/api/roles-permissions.md +536 -536
- package/dist/skills/fluentcart-developer/references/api/subscriptions.md +827 -827
- package/dist/skills/fluentcart-developer/references/database/index.md +44 -44
- package/dist/skills/fluentcart-developer/references/database/models/activity.md +178 -178
- package/dist/skills/fluentcart-developer/references/database/models/applied-coupon.md +291 -291
- package/dist/skills/fluentcart-developer/references/database/models/attribute-group.md +239 -239
- package/dist/skills/fluentcart-developer/references/database/models/attribute-relation.md +181 -181
- package/dist/skills/fluentcart-developer/references/database/models/attribute-term.md +219 -219
- package/dist/skills/fluentcart-developer/references/database/models/cart.md +645 -645
- package/dist/skills/fluentcart-developer/references/database/models/coupon.md +427 -427
- package/dist/skills/fluentcart-developer/references/database/models/customer-addresses.md +348 -348
- package/dist/skills/fluentcart-developer/references/database/models/customer-meta.md +156 -156
- package/dist/skills/fluentcart-developer/references/database/models/customer.md +584 -584
- package/dist/skills/fluentcart-developer/references/database/models/dynamic-model.md +163 -163
- package/dist/skills/fluentcart-developer/references/database/models/label-relationship.md +155 -155
- package/dist/skills/fluentcart-developer/references/database/models/label.md +153 -153
- package/dist/skills/fluentcart-developer/references/database/models/license-activation.md +182 -182
- package/dist/skills/fluentcart-developer/references/database/models/license-meta.md +163 -163
- package/dist/skills/fluentcart-developer/references/database/models/license-site.md +208 -208
- package/dist/skills/fluentcart-developer/references/database/models/license.md +640 -640
- package/dist/skills/fluentcart-developer/references/database/models/meta.md +233 -233
- package/dist/skills/fluentcart-developer/references/database/models/order-address.md +391 -391
- package/dist/skills/fluentcart-developer/references/database/models/order-download-permission.md +144 -144
- package/dist/skills/fluentcart-developer/references/database/models/order-item.md +383 -383
- package/dist/skills/fluentcart-developer/references/database/models/order-meta.md +303 -303
- package/dist/skills/fluentcart-developer/references/database/models/order-operation.md +158 -158
- package/dist/skills/fluentcart-developer/references/database/models/order-promotion-stat.md +175 -175
- package/dist/skills/fluentcart-developer/references/database/models/order-promotion.md +250 -250
- package/dist/skills/fluentcart-developer/references/database/models/order-tax-rate.md +172 -172
- package/dist/skills/fluentcart-developer/references/database/models/order-transaction.md +440 -440
- package/dist/skills/fluentcart-developer/references/database/models/order.md +727 -727
- package/dist/skills/fluentcart-developer/references/database/models/product-detail.md +397 -397
- package/dist/skills/fluentcart-developer/references/database/models/product-download.md +258 -258
- package/dist/skills/fluentcart-developer/references/database/models/product-meta.md +153 -153
- package/dist/skills/fluentcart-developer/references/database/models/product-variation.md +556 -556
- package/dist/skills/fluentcart-developer/references/database/models/product.md +580 -580
- package/dist/skills/fluentcart-developer/references/database/models/relationships.md +427 -427
- package/dist/skills/fluentcart-developer/references/database/models/scheduled-action.md +175 -175
- package/dist/skills/fluentcart-developer/references/database/models/shipping-class.md +148 -148
- package/dist/skills/fluentcart-developer/references/database/models/shipping-method.md +280 -280
- package/dist/skills/fluentcart-developer/references/database/models/shipping-zone.md +205 -205
- package/dist/skills/fluentcart-developer/references/database/models/subscription-meta.md +173 -173
- package/dist/skills/fluentcart-developer/references/database/models/subscription.md +528 -528
- package/dist/skills/fluentcart-developer/references/database/models/tax-class.md +195 -195
- package/dist/skills/fluentcart-developer/references/database/models/tax-rate.md +225 -225
- package/dist/skills/fluentcart-developer/references/database/models/user-meta.md +166 -166
- package/dist/skills/fluentcart-developer/references/database/models/user.md +220 -220
- package/dist/skills/fluentcart-developer/references/database/models.md +404 -404
- package/dist/skills/fluentcart-developer/references/database/query-builder.md +860 -860
- package/dist/skills/fluentcart-developer/references/database/readme.md +276 -276
- package/dist/skills/fluentcart-developer/references/database/schema.md +1002 -1002
- package/dist/skills/fluentcart-developer/references/engineering/adding-custom-pages-to-the-customer-dashboard.md +395 -395
- package/dist/skills/fluentcart-developer/references/engineering/index.md +4 -4
- package/dist/skills/fluentcart-developer/references/engineering.md +4 -4
- package/dist/skills/fluentcart-developer/references/getting-started.md +249 -249
- package/dist/skills/fluentcart-developer/references/guides/frontend.md +519 -519
- package/dist/skills/fluentcart-developer/references/guides/index.md +107 -107
- package/dist/skills/fluentcart-developer/references/guides/integrations.md +600 -600
- package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/index.md +237 -237
- package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/labels-and-tracking.md +481 -481
- package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/live-rates.md +269 -269
- package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/reference.md +223 -223
- package/dist/skills/fluentcart-developer/references/guides/shipping-carrier/settings.md +370 -370
- package/dist/skills/fluentcart-developer/references/guides/shipping-carrier.md +237 -237
- package/dist/skills/fluentcart-developer/references/guides/subscriptions.md +217 -217
- package/dist/skills/fluentcart-developer/references/hooks/actions/admin-and-templates.md +1079 -1079
- package/dist/skills/fluentcart-developer/references/hooks/actions/cart-and-checkout.md +1795 -1795
- package/dist/skills/fluentcart-developer/references/hooks/actions/customers-and-users.md +327 -327
- package/dist/skills/fluentcart-developer/references/hooks/actions/licenses.md +829 -829
- package/dist/skills/fluentcart-developer/references/hooks/actions/modules.md +81 -81
- package/dist/skills/fluentcart-developer/references/hooks/actions/orders.md +757 -757
- package/dist/skills/fluentcart-developer/references/hooks/actions/payments-and-integrations.md +1163 -1163
- package/dist/skills/fluentcart-developer/references/hooks/actions/pro-modules.md +219 -219
- package/dist/skills/fluentcart-developer/references/hooks/actions/products-and-coupons.md +1019 -1019
- package/dist/skills/fluentcart-developer/references/hooks/actions/subscriptions.md +1290 -1290
- package/dist/skills/fluentcart-developer/references/hooks/actions.md +16 -16
- package/dist/skills/fluentcart-developer/references/hooks/deprecated.md +60 -60
- package/dist/skills/fluentcart-developer/references/hooks/filters/cart-and-checkout.md +2032 -2032
- package/dist/skills/fluentcart-developer/references/hooks/filters/customers-and-subscriptions.md +1746 -1746
- package/dist/skills/fluentcart-developer/references/hooks/filters/integrations-and-advanced.md +2439 -2439
- package/dist/skills/fluentcart-developer/references/hooks/filters/modules.md +464 -464
- package/dist/skills/fluentcart-developer/references/hooks/filters/orders-and-payments.md +2658 -2658
- package/dist/skills/fluentcart-developer/references/hooks/filters/pro-modules.md +502 -502
- package/dist/skills/fluentcart-developer/references/hooks/filters/products-and-pricing.md +1785 -1785
- package/dist/skills/fluentcart-developer/references/hooks/filters/settings-and-configuration.md +2966 -2966
- package/dist/skills/fluentcart-developer/references/hooks/filters.md +14 -14
- package/dist/skills/fluentcart-developer/references/hooks/index.md +35 -35
- package/dist/skills/fluentcart-developer/references/index.md +625 -625
- package/dist/skills/fluentcart-developer/references/modules/fee-system.md +427 -427
- package/dist/skills/fluentcart-developer/references/modules/ghost-product-selling.md +440 -440
- package/dist/skills/fluentcart-developer/references/modules/index.md +484 -484
- package/dist/skills/fluentcart-developer/references/modules/licensing.md +342 -342
- package/dist/skills/fluentcart-developer/references/modules/order-bump.md +433 -433
- package/dist/skills/fluentcart-developer/references/modules/payment-methods.md +129 -129
- package/dist/skills/fluentcart-developer/references/modules/refunds.md +170 -170
- package/dist/skills/fluentcart-developer/references/modules/shipping.md +846 -846
- package/dist/skills/fluentcart-developer/references/modules/storage.md +986 -986
- package/dist/skills/fluentcart-developer/references/modules/subscription-vendor-ids.md +186 -186
- package/dist/skills/fluentcart-developer/references/modules/subscriptions.md +678 -678
- package/dist/skills/fluentcart-developer/references/payment-methods-integration/index.md +164 -164
- package/dist/skills/fluentcart-developer/references/payment-methods-integration/paddle-example.md +1648 -1648
- package/dist/skills/fluentcart-developer/references/payment-methods-integration/payment/setting/fields.md +353 -353
- package/dist/skills/fluentcart-developer/references/payment-methods-integration/quick-implementation.md +1079 -1079
- package/dist/skills/fluentcart-developer/references/payment-methods-integration.md +164 -164
- package/dist/skills/fluentcart-developer/references/restapi/checkout.md +573 -573
- package/dist/skills/fluentcart-developer/references/restapi/coupons.md +958 -958
- package/dist/skills/fluentcart-developer/references/restapi/customer-profile.md +1423 -1423
- package/dist/skills/fluentcart-developer/references/restapi/customers.md +1103 -1103
- package/dist/skills/fluentcart-developer/references/restapi/dashboard.md +1083 -1083
- package/dist/skills/fluentcart-developer/references/restapi/data-export.md +132 -132
- package/dist/skills/fluentcart-developer/references/restapi/email-notifications.md +846 -846
- package/dist/skills/fluentcart-developer/references/restapi/files.md +313 -313
- package/dist/skills/fluentcart-developer/references/restapi/index.md +127 -127
- package/dist/skills/fluentcart-developer/references/restapi/integrations.md +1000 -1000
- package/dist/skills/fluentcart-developer/references/restapi/inventory.md +192 -192
- package/dist/skills/fluentcart-developer/references/restapi/labels-and-attributes.md +797 -797
- package/dist/skills/fluentcart-developer/references/restapi/licensing.md +1733 -1733
- package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-available-shipping-methods.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-checkout-summary.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-country-info.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-order-info.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/get-shipping-methods-list-view.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/login.md +66 -66
- package/dist/skills/fluentcart-developer/references/restapi/operations/checkout/place-order.md +179 -179
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/apply-coupon.md +83 -83
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/cancel-coupon.md +87 -87
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/check-product-eligibility.md +59 -59
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/create-coupon.md +230 -230
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/delete-coupon.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/get-coupon-settings.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/get-coupon.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/list-coupon-codes.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/list-coupons.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/re-apply-coupons.md +75 -75
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/store-coupon-settings.md +40 -40
- package/dist/skills/fluentcart-developer/references/restapi/operations/coupons/update-coupon.md +133 -133
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/create-address-checkout.md +138 -138
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/create-profile-address.md +119 -119
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/dashboard-overview.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/delete-profile-address.md +46 -46
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-order-details.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-portal-sections.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-profile-details.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-transaction-billing-address.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/get-upgrade-paths.md +31 -31
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/list-downloads.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/list-orders.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/make-profile-address-primary.md +55 -55
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/pause-subscription.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/resume-subscription.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/save-transaction-billing-address.md +92 -92
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/select-address-for-checkout.md +32 -32
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/update-profile-address.md +115 -115
- package/dist/skills/fluentcart-developer/references/restapi/operations/customer-profile/update-profile-details.md +69 -69
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/attach-user.md +50 -50
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/bulk-actions.md +65 -65
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/create-address.md +135 -135
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/create-customer.md +108 -108
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/delete-address.md +62 -62
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/detach-user.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/find-customer-order.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-attachable-users.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer-addresses.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer-orders.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer-stats.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/get-customer.md +32 -32
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/list-customers.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/recalculate-ltv.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/set-primary-address.md +72 -72
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/update-additional-info.md +55 -55
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/update-address.md +144 -144
- package/dist/skills/fluentcart-developer/references/restapi/operations/customers/update-customer.md +123 -123
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/attach-note-to-order.md +49 -49
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/create-all-pages.md +21 -21
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/create-single-page.md +55 -55
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/delete-activity.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-country-info.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-dashboard-stats.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-filter-options.md +31 -31
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-onboarding-data.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-onboarding-settings.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-print-templates.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-search-options.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/get-widgets.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/initialize-app.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/list-activities.md +33 -33
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/list-attachments.md +21 -21
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/list-countries.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/mark-activity-read.md +53 -53
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/run-data-backfills.md +21 -21
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/save-onboarding-settings.md +54 -54
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/save-onboarding-tax-settings.md +73 -73
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/save-print-templates.md +64 -64
- package/dist/skills/fluentcart-developer/references/restapi/operations/dashboard/upload-attachment.md +42 -42
- package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-customers-batch.md +129 -129
- package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-licenses-batch.md +133 -133
- package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-orders-batch.md +129 -129
- package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/export-subscriptions-batch.md +129 -129
- package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-customers-export-schema.md +21 -21
- package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-licenses-export-schema.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-orders-export-schema.md +21 -21
- package/dist/skills/fluentcart-developer/references/restapi/operations/data-export/get-subscriptions-export-schema.md +21 -21
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/enable-notification.md +57 -57
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-digest-settings.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-notification.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-reminders.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-settings.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/get-shortcodes.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/list-notifications.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/preview-default-template.md +66 -66
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/preview-notification.md +50 -50
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/save-digest-settings.md +101 -101
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/save-reminders.md +162 -162
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/save-settings.md +99 -99
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/send-digest-test.md +47 -47
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/send-manual-reminder.md +51 -51
- package/dist/skills/fluentcart-developer/references/restapi/operations/email-notification/update-notification.md +93 -93
- package/dist/skills/fluentcart-developer/references/restapi/operations/files/delete-file.md +31 -31
- package/dist/skills/fluentcart-developer/references/restapi/operations/files/get-bucket-list.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/files/list-files.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/files/upload-editor-file.md +32 -32
- package/dist/skills/fluentcart-developer/references/restapi/operations/files/upload-file.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/chained-data-request.md +46 -46
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/change-feed-status.md +51 -51
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/delete-feed.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-dynamic-options.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-feed-lists.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-feed-settings.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-global-feeds.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/get-global-settings.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/install-addon-plugin.md +49 -49
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/list-addons.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/save-feed-settings.md +52 -52
- package/dist/skills/fluentcart-developer/references/restapi/operations/integration/set-global-settings.md +50 -50
- package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/bulk-update-stock.md +94 -94
- package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/export-inventory.md +81 -81
- package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/get-adjustment-history.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/get-inventory-stats.md +21 -21
- package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/list-inventory.md +33 -33
- package/dist/skills/fluentcart-developer/references/restapi/operations/inventory/update-stock.md +75 -75
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/create-attribute-group.md +31 -31
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/create-label.md +31 -31
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/create-terms.md +90 -90
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/delete-attribute-group.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/delete-attribute-term.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/get-attribute-group.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/get-attribute-library.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/list-attribute-groups.md +32 -32
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/list-attribute-terms.md +33 -33
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/list-labels.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/reorder-groups.md +51 -51
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/reorder-terms.md +56 -56
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/update-attribute-group.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/update-attribute-term.md +39 -39
- package/dist/skills/fluentcart-developer/references/restapi/operations/labels-attributes/update-label-selections.md +32 -32
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/activate-plugin-license.md +41 -41
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/activate-site-admin.md +60 -60
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/deactivate-plugin-license.md +18 -18
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/deactivate-site-admin.md +67 -67
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/deactivate-site-customer.md +47 -47
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/delete-license.md +24 -24
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/extend-license-validity.md +47 -47
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-customer-license-details.md +25 -25
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-customer-licenses-admin.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-license-activations.md +25 -25
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-license-details.md +25 -25
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-license-site.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-plugin-license-status.md +18 -18
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/get-product-license-settings.md +24 -24
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/list-customer-licenses.md +25 -25
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/list-license-sites.md +33 -33
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/list-licenses.md +38 -38
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-activate-license.md +54 -54
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-check-license.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-deactivate-license.md +46 -46
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-download-license-package.md +23 -23
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/public-get-license-version.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/regenerate-license-key.md +24 -24
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/save-product-license-settings.md +193 -193
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/update-license-activation-limit.md +53 -53
- package/dist/skills/fluentcart-developer/references/restapi/operations/licensing/update-license-status.md +52 -52
- package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/create-order-bump.md +47 -47
- package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/delete-order-bump.md +25 -25
- package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/get-order-bump.md +25 -25
- package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/list-order-bumps.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/order-bumps/update-order-bump.md +141 -141
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/accept-dispute.md +47 -47
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/bulk-actions.md +72 -72
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/calculate-shipping.md +67 -67
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/calculate-tax.md +98 -98
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/change-customer.md +50 -50
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/charge-now.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-and-change-customer.md +92 -92
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-custom-order-item.md +68 -68
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-order.md +351 -351
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/create-renewal-now.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/delete-order.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/generate-missing-licenses.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-order-transactions.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-order.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-renewal.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-shipping-methods.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/get-single-transaction.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/list-order-currencies.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/list-orders.md +42 -42
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/list-renewals.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/mark-as-paid.md +61 -61
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/price-order.md +135 -135
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/refund-order.md +72 -72
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/resend-renewal-invoice.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/skip-renewal.md +48 -48
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/sync-order-statuses.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/sync-pending-transaction.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-order-address-id.md +60 -60
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-order-address.md +98 -98
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-order.md +172 -172
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-statuses.md +77 -77
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-subscription-details.md +84 -84
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/update-transaction-status.md +51 -51
- package/dist/skills/fluentcart-developer/references/restapi/operations/orders/void-renewal.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/create-pdf-template.md +42 -42
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/delete-pdf-template.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/download-pdf-preview.md +44 -44
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-factory-default-templates.md +19 -19
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-pdf-status.md +21 -21
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-pdf-template.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-saved-templates.md +21 -21
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/get-seller-details.md +19 -19
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/list-pdf-templates.md +19 -19
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/save-pdf-template.md +53 -53
- package/dist/skills/fluentcart-developer/references/restapi/operations/pdf-templates/save-seller-details.md +97 -97
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/add-product-terms.md +64 -64
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-edit-fetch.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-insert-products.md +62 -62
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-update-products.md +59 -59
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/bulk-update-variants.md +83 -83
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/change-integration-status.md +64 -64
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/create-dummy-products.md +45 -45
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/create-product.md +81 -81
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/create-variation.md +181 -181
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-downloadable-file.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-product-integration.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-product.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-taxonomy-term.md +55 -55
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-upgrade-path.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/delete-variation.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/do-bulk-action.md +56 -56
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/duplicate-product.md +56 -56
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-products-by-ids.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-taxonomy-terms.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-terms-by-parent.md +60 -60
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/fetch-variations-by-ids.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/find-subscription-variants.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-bundle-info.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-downloadable-url.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-max-excerpt-word-count.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-pricing-widgets.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product-integration-feeds.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product-integration-settings.md +31 -31
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product-pricing.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-product.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-related-products.md +31 -31
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-upgrade-settings.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/get-variation-upgrade-paths.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/group-bulk-update-variants.md +103 -103
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/list-all-variants.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/list-product-variations.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/list-products.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/remove-shipping-class.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/remove-tax-class.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/save-bundle-info.md +56 -56
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/save-product-integration.md +62 -62
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/save-upgrade-path.md +78 -78
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/search-product-variant-options.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/search-products-by-name.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/search-variants-by-name.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/set-variation-media.md +74 -74
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/suggest-sku.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/sync-downloadable-files.md +134 -134
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/sync-taxonomy-terms.md +61 -61
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/toggle-product-tax-exemption.md +56 -56
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-downloadable-file.md +98 -98
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-inventory.md +56 -56
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-long-desc-editor-mode.md +49 -49
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-manage-stock.md +53 -53
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-product-detail.md +58 -58
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-product-pricing.md +225 -225
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-shipping-class.md +49 -49
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-tax-class.md +49 -49
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-upgrade-path.md +78 -78
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variant-option.md +79 -79
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variant-tax-exemption.md +56 -56
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variation-pricing-table.md +49 -49
- package/dist/skills/fluentcart-developer/references/restapi/operations/products/update-variation.md +105 -105
- package/dist/skills/fluentcart-developer/references/restapi/operations/public-shop/get-product-views.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/public-shop/list-products.md +42 -42
- package/dist/skills/fluentcart-developer/references/restapi/operations/public-shop/search-products.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/channel-rules.md +24 -24
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/country-heat-map.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/coupon-overview.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/coupons.md +36 -36
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-insights.md +31 -31
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-overview.md +36 -36
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-repeat.md +35 -35
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-segment-customers.md +36 -36
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-segments.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/customer-value.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/dashboard-stats.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/failed-orders.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-new-vs-returning-customer.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-report-by-day-and-hour.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-report-meta.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/fetch-top-sold-products.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/future-renewals.md +31 -31
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/generate-retention-snapshots.md +24 -24
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-overview.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-recent-activities.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-recent-orders.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/get-revenue.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/installments-at-risk.md +35 -35
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/installments-variations.md +33 -33
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/installments.md +33 -33
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/item-count-distribution.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/license-chart.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/license-pie-chart.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/license-summary.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/locations.md +43 -43
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-chart.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-completion-time.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-mix.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/order-value-distribution.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/payment-methods-disputes.md +38 -38
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/payment-methods-methods.md +36 -36
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/payment-methods.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-comparison-launch.md +33 -33
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-comparison.md +40 -40
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-detail.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/product-sales.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/refunds-overview.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/retention-snapshots-step.md +45 -45
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/sales-growth-chart.md +35 -35
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/save-channel-rules.md +73 -73
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/source-channels.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/sources.md +49 -49
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-cohorts.md +33 -33
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-health.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-rebuys.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-retention.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscription-variations.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/subscriptions-overview.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/reports/weeks-between-refund.md +34 -34
- package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/assign-role.md +48 -48
- package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/delete-role-assignment.md +47 -47
- package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/get-role.md +25 -25
- package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/list-managers.md +18 -18
- package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/list-roles.md +18 -18
- package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/search-users.md +25 -25
- package/dist/skills/fluentcart-developer/references/restapi/operations/roles-permissions/update-role.md +43 -43
- package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/create-saved-view.md +106 -106
- package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/delete-saved-view.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/list-saved-views.md +25 -25
- package/dist/skills/fluentcart-developer/references/restapi/operations/saved-views/update-saved-view.md +83 -83
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/activate-payment-addon.md +44 -44
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/activate-plugin-addon.md +44 -44
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/change-storage-driver-status.md +56 -56
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/check-paypal-webhook.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/create-storage-bucket.md +63 -63
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/disconnect-payment-method.md +55 -55
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/exchange-paypal-seller-auth-token.md +62 -62
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-active-storage-drivers.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-checkout-fields.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-email-shortcodes.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-mcp-config-snippets.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-mcp-status.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-module-settings.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-payment-method-connection-info.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-payment-method-settings.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-permissions.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-plugin-addons.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-storage-driver-settings.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/get-store-settings.md +26 -26
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/install-mcp-adapter.md +21 -21
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/install-payment-addon.md +60 -60
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/install-plugin-addon.md +64 -64
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/list-all-payment-methods.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/list-all-storage-drivers.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/list-storage-buckets.md +67 -67
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/reorder-payment-methods.md +55 -55
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/reset-storage-driver-settings.md +45 -45
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-checkout-fields.md +133 -133
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-confirmation-settings.md +68 -68
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-module-settings.md +68 -68
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-payment-method-design.md +67 -67
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-payment-method-settings.md +58 -58
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-permissions.md +68 -68
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-storage-driver-settings.md +62 -62
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/save-store-settings.md +239 -239
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/setup-paypal-webhook.md +48 -48
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/toggle-mcp.md +40 -40
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/verify-storage-driver-connection.md +62 -62
- package/dist/skills/fluentcart-developer/references/restapi/operations/settings/verify-turnstile-keys.md +55 -55
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/create-shipping-class.md +73 -73
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/create-shipping-method.md +110 -110
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/create-shipping-zone.md +56 -56
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/delete-shipping-class.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/delete-shipping-method.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/delete-shipping-zone.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-class-profile.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-class.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-packages.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-shipping-zone.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-zone-countries.md +22 -22
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/get-zone-states.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/list-shipping-classes.md +31 -31
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/list-shipping-zones.md +31 -31
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/save-shipping-packages.md +112 -112
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-shipping-class.md +79 -79
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-shipping-method.md +113 -113
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-shipping-zone.md +62 -62
- package/dist/skills/fluentcart-developer/references/restapi/operations/shipping/update-zone-order.md +52 -52
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/cancel-auto-renew.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/cancel-subscription.md +52 -52
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/confirm-subscription-switch.md +70 -70
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/fetch-subscription-remote.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/generate-early-payment-link.md +29 -29
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-customer-subscription.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-or-create-plan.md +69 -69
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-setup-intent-attempts.md +30 -30
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/get-subscription.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/initiate-early-payment.md +31 -31
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/list-customer-subscriptions.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/list-subscriptions.md +39 -39
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/pause-subscription.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/reactivate-subscription.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/resume-subscription.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/switch-payment-method.md +70 -70
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/update-payment-method.md +69 -69
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/update-vendor-ids.md +56 -56
- package/dist/skills/fluentcart-developer/references/restapi/operations/subscriptions/verify-vendor-ids.md +56 -56
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/create-tax-class.md +51 -51
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/create-tax-rate.md +117 -117
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-product-override.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-shipping-tax-override.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-tax-class.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/delete-tax-rate.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-country-tax-id.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-country-tax-rates.md +28 -28
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-eu-vat-product-overrides.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-oss-country-rates.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-preconfigured-tax-rates.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-product-overrides.md +27 -27
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/get-tax-settings.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/list-all-tax-rates.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/list-tax-classes.md +20 -20
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/list-tax-records.md +37 -37
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/mark-taxes-as-filed.md +58 -58
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/reset-eu-vat-rates.md +21 -21
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-configured-countries.md +57 -57
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-country-tax-id.md +50 -50
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-eu-vat-cross-border-settings.md +127 -127
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-oss-country-rates.md +100 -100
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-product-override.md +110 -110
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-shipping-tax-override.md +52 -52
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/save-tax-settings.md +166 -166
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/update-country-status.md +54 -54
- package/dist/skills/fluentcart-developer/references/restapi/operations/tax/update-tax-rate.md +116 -116
- package/dist/skills/fluentcart-developer/references/restapi/order-bumps.md +433 -433
- package/dist/skills/fluentcart-developer/references/restapi/orders.md +1212 -1212
- package/dist/skills/fluentcart-developer/references/restapi/pdf-templates.md +212 -212
- package/dist/skills/fluentcart-developer/references/restapi/products.md +2485 -2485
- package/dist/skills/fluentcart-developer/references/restapi/public-shop.md +191 -191
- package/dist/skills/fluentcart-developer/references/restapi/reports.md +3773 -3773
- package/dist/skills/fluentcart-developer/references/restapi/roles.md +403 -403
- package/dist/skills/fluentcart-developer/references/restapi/saved-views.md +136 -136
- package/dist/skills/fluentcart-developer/references/restapi/settings.md +1423 -1423
- package/dist/skills/fluentcart-developer/references/restapi/shipping.md +905 -905
- package/dist/skills/fluentcart-developer/references/restapi/subscriptions.md +1169 -1169
- package/dist/skills/fluentcart-developer/references/restapi/tax.md +1551 -1551
- package/dist/skills/fluentcart-developer/references/restapi.md +127 -127
- package/dist/skills/fluentcart-developer/scripts/cli.js +1 -1
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +66 -65
|
@@ -1,556 +1,556 @@
|
|
|
1
|
-
# Product Variation Model
|
|
2
|
-
|
|
3
|
-
| DB Table Name | {wp_db_prefix}_fct_product_variations |
|
|
4
|
-
| --- | --- |
|
|
5
|
-
| Schema | [Check Schema](/database/schema.md#fct-product-variations-table) |
|
|
6
|
-
| Source File | fluent-cart/app/Models/ProductVariation.php |
|
|
7
|
-
| Name Space | FluentCart\App\Models |
|
|
8
|
-
| Class | FluentCart\App\Models\ProductVariation |
|
|
9
|
-
|
|
10
|
-
## Traits
|
|
11
|
-
|
|
12
|
-
| Trait | Description |
|
|
13
|
-
| --- | --- |
|
|
14
|
-
| `CanSearch` | Adds search scope capabilities |
|
|
15
|
-
| `CanUpdateBatch` | Adds batch update capabilities |
|
|
16
|
-
|
|
17
|
-
## Attributes
|
|
18
|
-
|
|
19
|
-
| Attribute | Data Type | Comment |
|
|
20
|
-
| --- | --- | --- |
|
|
21
|
-
| id | Integer | Primary Key |
|
|
22
|
-
| post_id | Integer | Reference to WordPress post (product) |
|
|
23
|
-
| media_id | Integer | Reference to media |
|
|
24
|
-
| serial_index | Integer | Serial index for ordering |
|
|
25
|
-
| sold_individually | Integer | Whether sold individually (0 or 1) |
|
|
26
|
-
| variation_title | String | Variation title |
|
|
27
|
-
| variation_identifier | String | Variation identifier |
|
|
28
|
-
| sku | String | Stock keeping unit |
|
|
29
|
-
| manage_stock | String | Whether to manage stock |
|
|
30
|
-
| payment_type | String | Payment type (`onetime`, `subscription`) |
|
|
31
|
-
| stock_status | String | Stock status |
|
|
32
|
-
| backorders | Integer | Backorder quantity |
|
|
33
|
-
| total_stock | Integer | Total stock quantity |
|
|
34
|
-
| available | Integer | Available quantity |
|
|
35
|
-
| committed | Integer | Committed quantity |
|
|
36
|
-
| on_hold | Integer | On hold quantity |
|
|
37
|
-
| fulfillment_type | String | Fulfillment type (`physical`, `digital`) |
|
|
38
|
-
| item_status | String | Item status (`active`, `inactive`) |
|
|
39
|
-
| manage_cost | String | Whether to manage cost |
|
|
40
|
-
| item_price | Decimal | Item price (stored in cents, cast to double) |
|
|
41
|
-
| item_cost | Decimal | Item cost (stored in cents, cast to double) |
|
|
42
|
-
| compare_price | Decimal | Compare price (stored in cents, cast to double) |
|
|
43
|
-
| other_info | Array | Additional variation information (JSON, cast to array) |
|
|
44
|
-
| downloadable | String | Whether downloadable |
|
|
45
|
-
| shipping_class | String | Shipping class ID |
|
|
46
|
-
| created_at | Date Time | Creation timestamp |
|
|
47
|
-
| updated_at | Date Time | Last update timestamp |
|
|
48
|
-
|
|
49
|
-
## Casts
|
|
50
|
-
|
|
51
|
-
The following attributes are automatically cast when accessed:
|
|
52
|
-
|
|
53
|
-
| Attribute | Cast Type |
|
|
54
|
-
| --- | --- |
|
|
55
|
-
| post_id | integer |
|
|
56
|
-
| media_id | integer |
|
|
57
|
-
| item_cost | double |
|
|
58
|
-
| item_price | double |
|
|
59
|
-
| compare_price | double |
|
|
60
|
-
| backorders | integer |
|
|
61
|
-
| total_stock | integer |
|
|
62
|
-
| available | integer |
|
|
63
|
-
| committed | integer |
|
|
64
|
-
| on_hold | integer |
|
|
65
|
-
| sold_individually | integer |
|
|
66
|
-
| serial_index | integer |
|
|
67
|
-
| other_info | array |
|
|
68
|
-
|
|
69
|
-
## Appends
|
|
70
|
-
|
|
71
|
-
The following computed attributes are appended to every model instance:
|
|
72
|
-
|
|
73
|
-
| Appended Attribute | Description |
|
|
74
|
-
| --- | --- |
|
|
75
|
-
| `thumbnail` | Always appended via `$appends`. Returns the first thumbnail URL from the `media` relation, or `null`. |
|
|
76
|
-
| `formatted_total` | Appended at runtime inside `booted()` on every `retrieved` event. Returns `Helper::toDecimal($this->item_price)`. |
|
|
77
|
-
|
|
78
|
-
## Custom `other_info` Accessor
|
|
79
|
-
|
|
80
|
-
The `getOtherInfoAttribute` accessor decodes the JSON value and, when `payment_type` is `subscription`, injects sensible defaults for subscription fields that may not yet be stored:
|
|
81
|
-
|
|
82
|
-
| Injected Key | Default Value |
|
|
83
|
-
| --- | --- |
|
|
84
|
-
| `payment_type` | `'subscription'` |
|
|
85
|
-
| `installment` | `'yes'` only if value is `'yes'` AND Pro is active; otherwise `'no'` |
|
|
86
|
-
| `repeat_interval` | `'yearly'` |
|
|
87
|
-
| `times` | `0` |
|
|
88
|
-
| `trial_days` | `0` |
|
|
89
|
-
| `manage_setup_fee` | `'no'` |
|
|
90
|
-
|
|
91
|
-
This means reading `$variation->other_info` on a subscription variation always returns these keys even if they were not explicitly saved.
|
|
92
|
-
|
|
93
|
-
## Cascade Deletes
|
|
94
|
-
|
|
95
|
-
When a `ProductVariation` is deleted, the `boot()` method fires the following cleanup:
|
|
96
|
-
|
|
97
|
-
1. **Media** -- calls `\FluentCart\Api\Meta::deleteVariationMedia($model->id)` to remove associated media metadata.
|
|
98
|
-
2. **Attribute Map** -- calls `$model->attrMap()->delete()` to remove all related `AttributeRelation` records.
|
|
99
|
-
|
|
100
|
-
## Usage
|
|
101
|
-
|
|
102
|
-
Please check [Model Basic](/database/models.md) for Common methods.
|
|
103
|
-
|
|
104
|
-
### Accessing Attributes
|
|
105
|
-
|
|
106
|
-
```
|
|
107
|
-
$productVariation = FluentCart\App\Models\ProductVariation::find(1);
|
|
108
|
-
|
|
109
|
-
$productVariation->id; // returns id
|
|
110
|
-
$productVariation->post_id; // returns post ID
|
|
111
|
-
$productVariation->item_price; // returns item price (cast to double)
|
|
112
|
-
$productVariation->stock_status; // returns stock status
|
|
113
|
-
$productVariation->sku; // returns SKU
|
|
114
|
-
$productVariation->thumbnail; // returns thumbnail URL or null (appended attribute)
|
|
115
|
-
$productVariation->formatted_total; // returns formatted price string (appended on retrieval)
|
|
116
|
-
```
|
|
117
|
-
|
|
118
|
-
## Scopes
|
|
119
|
-
|
|
120
|
-
This model has the following scopes that you can use
|
|
121
|
-
|
|
122
|
-
### getWithShippingClass()
|
|
123
|
-
|
|
124
|
-
Get variations with their shipping class information. This scope executes the query, then looks up `ShippingMethod` records whose IDs match the `other_info.shipping_class` value on each variation, and attaches the matching method as a `shipping_method` dynamic attribute.
|
|
125
|
-
|
|
126
|
-
- Parameters none
|
|
127
|
-
|
|
128
|
-
Returns the query result (executes `$query->get()` internally)
|
|
129
|
-
|
|
130
|
-
#### Usage:
|
|
131
|
-
|
|
132
|
-
```
|
|
133
|
-
// Get variations with shipping class data
|
|
134
|
-
$variations = FluentCart\App\Models\ProductVariation::getWithShippingClass();
|
|
135
|
-
|
|
136
|
-
foreach ($variations as $variation) {
|
|
137
|
-
if (isset($variation->shipping_method)) {
|
|
138
|
-
echo $variation->shipping_method->title;
|
|
139
|
-
}
|
|
140
|
-
}
|
|
141
|
-
```
|
|
142
|
-
|
|
143
|
-
## Relations
|
|
144
|
-
|
|
145
|
-
### attrMap / attrRelations
|
|
146
|
-
|
|
147
|
-
Both are `hasMany` to `AttributeRelation` on `object_id` — the variation's attribute term links. `attrMap` is also what the model's `deleting` hook clears: deleting a variation removes its attribute relations and its variation media.
|
|
148
|
-
|
|
149
|
-
```
|
|
150
|
-
$terms = $variation->attrRelations;
|
|
151
|
-
```
|
|
152
|
-
|
|
153
|
-
This model has the following relationships that you can use
|
|
154
|
-
|
|
155
|
-
### product
|
|
156
|
-
|
|
157
|
-
Access the associated product (WordPress post). BelongsTo via `post_id` -> `Product.ID`.
|
|
158
|
-
|
|
159
|
-
- return `FluentCart\App\Models\Product` Model
|
|
160
|
-
|
|
161
|
-
#### Example:
|
|
162
|
-
|
|
163
|
-
```
|
|
164
|
-
// Accessing Product
|
|
165
|
-
$product = $productVariation->product;
|
|
166
|
-
|
|
167
|
-
// For Filtering by product relationship
|
|
168
|
-
$productVariations = FluentCart\App\Models\ProductVariation::whereHas('product', function($query) {
|
|
169
|
-
$query->where('post_status', 'publish');
|
|
170
|
-
})->get();
|
|
171
|
-
```
|
|
172
|
-
|
|
173
|
-
### shippingClass
|
|
174
|
-
|
|
175
|
-
Access the associated shipping class. BelongsTo via `shipping_class` -> `ShippingClass.id`.
|
|
176
|
-
|
|
177
|
-
- return `FluentCart\App\Models\ShippingClass` Model
|
|
178
|
-
|
|
179
|
-
#### Example:
|
|
180
|
-
|
|
181
|
-
```
|
|
182
|
-
// Accessing Shipping Class
|
|
183
|
-
$shippingClass = $productVariation->shippingClass;
|
|
184
|
-
```
|
|
185
|
-
|
|
186
|
-
### product_detail
|
|
187
|
-
|
|
188
|
-
Access the associated product detail. BelongsTo via `post_id` -> `ProductDetail.post_id`.
|
|
189
|
-
|
|
190
|
-
- return `FluentCart\App\Models\ProductDetail` Model
|
|
191
|
-
|
|
192
|
-
#### Example:
|
|
193
|
-
|
|
194
|
-
```
|
|
195
|
-
// Accessing Product Detail
|
|
196
|
-
$productDetail = $productVariation->product_detail;
|
|
197
|
-
```
|
|
198
|
-
|
|
199
|
-
### media
|
|
200
|
-
|
|
201
|
-
Access the associated product thumbnail media. HasOne to `ProductMeta` via `object_id` -> `id`, filtered to `meta_key = 'product_thumbnail'`. Only selects `id`, `object_id`, `meta_value`.
|
|
202
|
-
|
|
203
|
-
- return `FluentCart\App\Models\ProductMeta` Model (single record)
|
|
204
|
-
|
|
205
|
-
#### Example:
|
|
206
|
-
|
|
207
|
-
```
|
|
208
|
-
// Accessing Media
|
|
209
|
-
$media = $productVariation->media;
|
|
210
|
-
|
|
211
|
-
// The thumbnail appended attribute reads from this relation:
|
|
212
|
-
$url = $productVariation->thumbnail; // shortcut
|
|
213
|
-
```
|
|
214
|
-
|
|
215
|
-
### product_downloads
|
|
216
|
-
|
|
217
|
-
Access all product downloads associated with this variation's product. HasMany to `ProductDownload` via `post_id` -> `post_id`, filtered to rows where `product_variation_id` contains this variation's ID, or is `NULL`, or is `'[]'`.
|
|
218
|
-
|
|
219
|
-
- return `FluentCart\App\Models\ProductDownload` Model Collection
|
|
220
|
-
|
|
221
|
-
#### Example:
|
|
222
|
-
|
|
223
|
-
```
|
|
224
|
-
// Accessing Product Downloads
|
|
225
|
-
$downloads = $productVariation->product_downloads;
|
|
226
|
-
```
|
|
227
|
-
|
|
228
|
-
### order_items
|
|
229
|
-
|
|
230
|
-
Access all order items for this variation. HasMany to `OrderItem` via `object_id` -> `id`.
|
|
231
|
-
|
|
232
|
-
- return `FluentCart\App\Models\OrderItem` Model Collection
|
|
233
|
-
|
|
234
|
-
#### Example:
|
|
235
|
-
|
|
236
|
-
```
|
|
237
|
-
// Accessing Order Items
|
|
238
|
-
$orderItems = $productVariation->order_items;
|
|
239
|
-
```
|
|
240
|
-
|
|
241
|
-
### downloadable_files
|
|
242
|
-
|
|
243
|
-
Access all downloadable files directly linked to this variation. HasMany to `ProductDownload` via `product_variation_id` -> `id`.
|
|
244
|
-
|
|
245
|
-
- return `FluentCart\App\Models\ProductDownload` Model Collection
|
|
246
|
-
|
|
247
|
-
#### Example:
|
|
248
|
-
|
|
249
|
-
```
|
|
250
|
-
// Accessing Downloadable Files
|
|
251
|
-
$downloadableFiles = $productVariation->downloadable_files;
|
|
252
|
-
```
|
|
253
|
-
|
|
254
|
-
### upgrade_paths
|
|
255
|
-
|
|
256
|
-
Access all upgrade path meta entries for this variation. HasMany to `Meta` via `object_id` -> `id`, filtered by `object_type = PlanUpgradeService::$metaType` and `meta_key = PlanUpgradeService::$metaKey`.
|
|
257
|
-
|
|
258
|
-
- return `FluentCart\App\Models\Meta` Model Collection
|
|
259
|
-
|
|
260
|
-
#### Example:
|
|
261
|
-
|
|
262
|
-
```
|
|
263
|
-
// Accessing Upgrade Paths
|
|
264
|
-
$upgradePaths = $productVariation->upgrade_paths;
|
|
265
|
-
```
|
|
266
|
-
|
|
267
|
-
### attrMap
|
|
268
|
-
|
|
269
|
-
Access all attribute relation mappings for this variation. HasMany to `AttributeRelation` via `object_id` -> `id`.
|
|
270
|
-
|
|
271
|
-
**Note:** These records are cascade-deleted when the variation is deleted.
|
|
272
|
-
|
|
273
|
-
- return `FluentCart\App\Models\AttributeRelation` Model Collection
|
|
274
|
-
|
|
275
|
-
#### Example:
|
|
276
|
-
|
|
277
|
-
```
|
|
278
|
-
// Accessing Attribute Relations
|
|
279
|
-
$attrMap = $productVariation->attrMap;
|
|
280
|
-
```
|
|
281
|
-
|
|
282
|
-
### bundleChildren
|
|
283
|
-
|
|
284
|
-
Access the child variations of a bundle product. Uses a custom `BundleChildrenRelation` that reads child IDs from the `other_info` JSON column (key `bundle_child_ids`) and loads the corresponding `ProductVariation` records. Supports eager loading.
|
|
285
|
-
|
|
286
|
-
- return `FluentCart\App\Models\ProductVariation` Model Collection (via `BundleChildrenRelation`)
|
|
287
|
-
|
|
288
|
-
#### Example:
|
|
289
|
-
|
|
290
|
-
```
|
|
291
|
-
// Accessing Bundle Children
|
|
292
|
-
$children = $productVariation->bundleChildren;
|
|
293
|
-
|
|
294
|
-
// Eager loading bundle children
|
|
295
|
-
$variations = FluentCart\App\Models\ProductVariation::with('bundleChildren')->where('post_id', $postId)->get();
|
|
296
|
-
|
|
297
|
-
foreach ($variations as $variation) {
|
|
298
|
-
foreach ($variation->bundleChildren as $child) {
|
|
299
|
-
echo $child->variation_title;
|
|
300
|
-
}
|
|
301
|
-
}
|
|
302
|
-
```
|
|
303
|
-
|
|
304
|
-
## Methods
|
|
305
|
-
|
|
306
|
-
### isStock($bundleChildren = null)
|
|
307
|
-
|
|
308
|
-
Whether the variation is in stock. For a bundle, pass the already-loaded children so the check does not re-query them per variation.
|
|
309
|
-
|
|
310
|
-
- Parameters `$bundleChildren` - array|null (optional) - pre-loaded bundle children
|
|
311
|
-
|
|
312
|
-
Returns `bool`
|
|
313
|
-
|
|
314
|
-
### loadBundleChildren($variations) (static)
|
|
315
|
-
|
|
316
|
-
Resolve the bundle children for a set of variations in one pass, so `isStock()` can then be called per variation without an N+1.
|
|
317
|
-
|
|
318
|
-
- Parameters `$variations` - the variations to resolve children for
|
|
319
|
-
|
|
320
|
-
### getVariationLabel()
|
|
321
|
-
|
|
322
|
-
The variation's label, built from its attribute terms.
|
|
323
|
-
|
|
324
|
-
- Returns `string`
|
|
325
|
-
|
|
326
|
-
### getDisplayTitle()
|
|
327
|
-
|
|
328
|
-
The title shown to customers for this variation.
|
|
329
|
-
|
|
330
|
-
- Returns `string`
|
|
331
|
-
|
|
332
|
-
Along with Global Model methods, this model has few helper methods.
|
|
333
|
-
|
|
334
|
-
### getFormattedTotalAttribute()
|
|
335
|
-
|
|
336
|
-
Get formatted total price (accessor). Automatically appended on every `retrieved` event via the `booted()` method.
|
|
337
|
-
|
|
338
|
-
- Parameters none
|
|
339
|
-
|
|
340
|
-
Returns `string` -- the decimal-formatted item price
|
|
341
|
-
|
|
342
|
-
#### Usage
|
|
343
|
-
|
|
344
|
-
```
|
|
345
|
-
$formattedTotal = $productVariation->formatted_total; // Returns formatted price string
|
|
346
|
-
```
|
|
347
|
-
|
|
348
|
-
### getThumbnailAttribute()
|
|
349
|
-
|
|
350
|
-
Get thumbnail URL (accessor). Reads from the `media` relation. Returns the `url` key of the first element in `media->meta_value`, or `null` if no media is set.
|
|
351
|
-
|
|
352
|
-
- Parameters none
|
|
353
|
-
|
|
354
|
-
Returns `string|null`
|
|
355
|
-
|
|
356
|
-
#### Usage
|
|
357
|
-
|
|
358
|
-
```
|
|
359
|
-
$thumbnail = $productVariation->thumbnail; // Returns thumbnail URL or null
|
|
360
|
-
```
|
|
361
|
-
|
|
362
|
-
### canPurchase($quantity = 1)
|
|
363
|
-
|
|
364
|
-
Check if the variation can be purchased. Validates:
|
|
365
|
-
|
|
366
|
-
1. `item_status` must be `active` and parent product must be `publish` or `private`.
|
|
367
|
-
2. Subscription variations cannot have `$quantity > 1`.
|
|
368
|
-
3. A related `product_detail` must exist.
|
|
369
|
-
4. If stock management module is active and both `productDetail->manage_stock` and `$this->manage_stock` are truthy, `$quantity` must not exceed `$this->available`.
|
|
370
|
-
5. Bundle products require Pro to be active.
|
|
371
|
-
6. Applies the `fluent_cart/variation/can_purchase_bundle` filter for additional bundle checks.
|
|
372
|
-
|
|
373
|
-
- Parameters `$quantity` - integer (default: 1)
|
|
374
|
-
|
|
375
|
-
Returns `true` on success, or `\WP_Error` with an error code on failure
|
|
376
|
-
|
|
377
|
-
**Error codes:** `unpublished`, `invalid_subscription_quantity`, `insufficient_stock`, `invalid_bundle_product`
|
|
378
|
-
|
|
379
|
-
#### Usage
|
|
380
|
-
|
|
381
|
-
```
|
|
382
|
-
$canPurchase = $productVariation->canPurchase(2);
|
|
383
|
-
if (is_wp_error($canPurchase)) {
|
|
384
|
-
echo "Error: " . $canPurchase->get_error_message();
|
|
385
|
-
} else {
|
|
386
|
-
echo "Available for purchase";
|
|
387
|
-
}
|
|
388
|
-
```
|
|
389
|
-
|
|
390
|
-
### getSubscriptionTermsText($withComparePrice = false)
|
|
391
|
-
|
|
392
|
-
Get human-readable subscription terms text. Returns an empty string for non-subscription variations. Reads `trial_days`, `repeat_interval`, `times`, `signup_fee`, `signup_fee_name` from `other_info` and delegates to `Helper::getSubscriptionTermText()`.
|
|
393
|
-
|
|
394
|
-
- Parameters `$withComparePrice` - boolean (default: false). When `true` and `compare_price > item_price`, the compare price is included in the formatted output.
|
|
395
|
-
|
|
396
|
-
Returns `string`
|
|
397
|
-
|
|
398
|
-
#### Usage
|
|
399
|
-
|
|
400
|
-
```
|
|
401
|
-
$termsText = $productVariation->getSubscriptionTermsText(true);
|
|
402
|
-
echo "Subscription Terms: " . $termsText;
|
|
403
|
-
```
|
|
404
|
-
|
|
405
|
-
### getPurchaseUrl()
|
|
406
|
-
|
|
407
|
-
Get the instant checkout purchase URL for this variation.
|
|
408
|
-
|
|
409
|
-
- Parameters none
|
|
410
|
-
|
|
411
|
-
Returns `string` -- URL in the format `site_url('?fluent-cart=instant_checkout&item_id={id}&quantity=1')`
|
|
412
|
-
|
|
413
|
-
#### Usage
|
|
414
|
-
|
|
415
|
-
```
|
|
416
|
-
$purchaseUrl = $productVariation->getPurchaseUrl();
|
|
417
|
-
echo "Purchase URL: " . $purchaseUrl;
|
|
418
|
-
```
|
|
419
|
-
|
|
420
|
-
### soldIndividually()
|
|
421
|
-
|
|
422
|
-
Check whether this variation's parent product is sold individually. Delegates to `$this->product->soldIndividually()`.
|
|
423
|
-
|
|
424
|
-
- Parameters none
|
|
425
|
-
|
|
426
|
-
Returns `bool` -- `false` if no product is loaded
|
|
427
|
-
|
|
428
|
-
#### Usage
|
|
429
|
-
|
|
430
|
-
```
|
|
431
|
-
if ($productVariation->soldIndividually()) {
|
|
432
|
-
echo "This product can only be purchased one at a time.";
|
|
433
|
-
}
|
|
434
|
-
```
|
|
435
|
-
|
|
436
|
-
### isStock()
|
|
437
|
-
|
|
438
|
-
Check whether this variation is currently in stock. The logic handles both regular and bundle products:
|
|
439
|
-
|
|
440
|
-
1. Returns `false` if `item_status` is not `active`.
|
|
441
|
-
2. If `manage_stock` is disabled: For bundle products, delegates to `isBundleChildrenInStock()`.
|
|
442
|
-
3. For regular products, returns `true` when `stock_status` equals `Helper::IN_STOCK`.
|
|
443
|
-
4. If `manage_stock` is enabled, checks `available > 0` AND `stock_status === Helper::IN_STOCK`.
|
|
444
|
-
5. For bundle products with stock management enabled, the parent must be in stock AND all children must pass `isBundleChildrenInStock()`.
|
|
445
|
-
|
|
446
|
-
- Parameters none
|
|
447
|
-
|
|
448
|
-
Returns `bool`
|
|
449
|
-
|
|
450
|
-
#### Usage
|
|
451
|
-
|
|
452
|
-
```
|
|
453
|
-
$variation = FluentCart\App\Models\ProductVariation::find(1);
|
|
454
|
-
if ($variation->isStock()) {
|
|
455
|
-
echo "In stock";
|
|
456
|
-
} else {
|
|
457
|
-
echo "Out of stock";
|
|
458
|
-
}
|
|
459
|
-
```
|
|
460
|
-
|
|
461
|
-
### isBundleChildrenInStock() (protected)
|
|
462
|
-
|
|
463
|
-
Check if all bundle children are in stock. Reads `bundle_child_ids` from `other_info`, loads those variations, and verifies each child is `active` and (if `manage_stock` is enabled) has `available > 0` with `stock_status === Helper::IN_STOCK`. Returns `true` if there are no bundle children.
|
|
464
|
-
|
|
465
|
-
- Visibility: `protected`
|
|
466
|
-
- Parameters none
|
|
467
|
-
|
|
468
|
-
Returns `bool`
|
|
469
|
-
|
|
470
|
-
## Hooks / Filters
|
|
471
|
-
|
|
472
|
-
| Hook | Type | Location | Description |
|
|
473
|
-
| --- | --- | --- | --- |
|
|
474
|
-
| `fluent_cart/variation/can_purchase_bundle` | Filter | `canPurchase()` | Allows external code to block or allow bundle purchases. Receives `null` and an array with `variation` and `quantity`. Return `\WP_Error` to block, `false` for out-of-stock, or `null`/`true` to allow. |
|
|
475
|
-
|
|
476
|
-
## Usage Examples
|
|
477
|
-
|
|
478
|
-
### Get Product Variations
|
|
479
|
-
|
|
480
|
-
```
|
|
481
|
-
$productVariation = FluentCart\App\Models\ProductVariation::find(1);
|
|
482
|
-
echo "Price: " . $productVariation->formatted_total;
|
|
483
|
-
echo "Stock: " . $productVariation->available;
|
|
484
|
-
echo "Status: " . $productVariation->item_status;
|
|
485
|
-
echo "SKU: " . $productVariation->sku;
|
|
486
|
-
```
|
|
487
|
-
|
|
488
|
-
### Get Variations with Shipping Class
|
|
489
|
-
|
|
490
|
-
```
|
|
491
|
-
$variations = FluentCart\App\Models\ProductVariation::getWithShippingClass();
|
|
492
|
-
foreach ($variations as $variation) {
|
|
493
|
-
echo "Variation: " . $variation->variation_title;
|
|
494
|
-
if (isset($variation->shipping_method)) {
|
|
495
|
-
echo "Shipping Method: " . $variation->shipping_method->title;
|
|
496
|
-
}
|
|
497
|
-
}
|
|
498
|
-
```
|
|
499
|
-
|
|
500
|
-
### Check Purchase Availability
|
|
501
|
-
|
|
502
|
-
```
|
|
503
|
-
$variation = FluentCart\App\Models\ProductVariation::find(1);
|
|
504
|
-
$canPurchase = $variation->canPurchase(1);
|
|
505
|
-
|
|
506
|
-
if (is_wp_error($canPurchase)) {
|
|
507
|
-
echo "Cannot purchase: " . $canPurchase->get_error_message();
|
|
508
|
-
} else {
|
|
509
|
-
echo "Available for purchase";
|
|
510
|
-
}
|
|
511
|
-
```
|
|
512
|
-
|
|
513
|
-
### Check Stock Status (Including Bundles)
|
|
514
|
-
|
|
515
|
-
```
|
|
516
|
-
$variation = FluentCart\App\Models\ProductVariation::find(1);
|
|
517
|
-
if ($variation->isStock()) {
|
|
518
|
-
echo "Variation is in stock";
|
|
519
|
-
} else {
|
|
520
|
-
echo "Variation is out of stock";
|
|
521
|
-
}
|
|
522
|
-
```
|
|
523
|
-
|
|
524
|
-
### Get Subscription Terms
|
|
525
|
-
|
|
526
|
-
```
|
|
527
|
-
$variation = FluentCart\App\Models\ProductVariation::find(1);
|
|
528
|
-
if ($variation->payment_type === 'subscription') {
|
|
529
|
-
$terms = $variation->getSubscriptionTermsText(true);
|
|
530
|
-
echo "Subscription: " . $terms;
|
|
531
|
-
}
|
|
532
|
-
```
|
|
533
|
-
|
|
534
|
-
### Get Downloadable Files
|
|
535
|
-
|
|
536
|
-
```
|
|
537
|
-
$variation = FluentCart\App\Models\ProductVariation::find(1);
|
|
538
|
-
$downloads = $variation->downloadable_files;
|
|
539
|
-
|
|
540
|
-
foreach ($downloads as $download) {
|
|
541
|
-
echo "Download: " . $download->title;
|
|
542
|
-
}
|
|
543
|
-
```
|
|
544
|
-
|
|
545
|
-
### Work with Bundle Children
|
|
546
|
-
|
|
547
|
-
```
|
|
548
|
-
$variation = FluentCart\App\Models\ProductVariation::find(1);
|
|
549
|
-
$children = $variation->bundleChildren;
|
|
550
|
-
|
|
551
|
-
foreach ($children as $child) {
|
|
552
|
-
echo "Child: " . $child->variation_title . " - Price: " . $child->formatted_total;
|
|
553
|
-
}
|
|
554
|
-
```
|
|
555
|
-
|
|
556
|
-
---
|
|
1
|
+
# Product Variation Model
|
|
2
|
+
|
|
3
|
+
| DB Table Name | {wp_db_prefix}_fct_product_variations |
|
|
4
|
+
| --- | --- |
|
|
5
|
+
| Schema | [Check Schema](/database/schema.md#fct-product-variations-table) |
|
|
6
|
+
| Source File | fluent-cart/app/Models/ProductVariation.php |
|
|
7
|
+
| Name Space | FluentCart\App\Models |
|
|
8
|
+
| Class | FluentCart\App\Models\ProductVariation |
|
|
9
|
+
|
|
10
|
+
## Traits
|
|
11
|
+
|
|
12
|
+
| Trait | Description |
|
|
13
|
+
| --- | --- |
|
|
14
|
+
| `CanSearch` | Adds search scope capabilities |
|
|
15
|
+
| `CanUpdateBatch` | Adds batch update capabilities |
|
|
16
|
+
|
|
17
|
+
## Attributes
|
|
18
|
+
|
|
19
|
+
| Attribute | Data Type | Comment |
|
|
20
|
+
| --- | --- | --- |
|
|
21
|
+
| id | Integer | Primary Key |
|
|
22
|
+
| post_id | Integer | Reference to WordPress post (product) |
|
|
23
|
+
| media_id | Integer | Reference to media |
|
|
24
|
+
| serial_index | Integer | Serial index for ordering |
|
|
25
|
+
| sold_individually | Integer | Whether sold individually (0 or 1) |
|
|
26
|
+
| variation_title | String | Variation title |
|
|
27
|
+
| variation_identifier | String | Variation identifier |
|
|
28
|
+
| sku | String | Stock keeping unit |
|
|
29
|
+
| manage_stock | String | Whether to manage stock |
|
|
30
|
+
| payment_type | String | Payment type (`onetime`, `subscription`) |
|
|
31
|
+
| stock_status | String | Stock status |
|
|
32
|
+
| backorders | Integer | Backorder quantity |
|
|
33
|
+
| total_stock | Integer | Total stock quantity |
|
|
34
|
+
| available | Integer | Available quantity |
|
|
35
|
+
| committed | Integer | Committed quantity |
|
|
36
|
+
| on_hold | Integer | On hold quantity |
|
|
37
|
+
| fulfillment_type | String | Fulfillment type (`physical`, `digital`) |
|
|
38
|
+
| item_status | String | Item status (`active`, `inactive`) |
|
|
39
|
+
| manage_cost | String | Whether to manage cost |
|
|
40
|
+
| item_price | Decimal | Item price (stored in cents, cast to double) |
|
|
41
|
+
| item_cost | Decimal | Item cost (stored in cents, cast to double) |
|
|
42
|
+
| compare_price | Decimal | Compare price (stored in cents, cast to double) |
|
|
43
|
+
| other_info | Array | Additional variation information (JSON, cast to array) |
|
|
44
|
+
| downloadable | String | Whether downloadable |
|
|
45
|
+
| shipping_class | String | Shipping class ID |
|
|
46
|
+
| created_at | Date Time | Creation timestamp |
|
|
47
|
+
| updated_at | Date Time | Last update timestamp |
|
|
48
|
+
|
|
49
|
+
## Casts
|
|
50
|
+
|
|
51
|
+
The following attributes are automatically cast when accessed:
|
|
52
|
+
|
|
53
|
+
| Attribute | Cast Type |
|
|
54
|
+
| --- | --- |
|
|
55
|
+
| post_id | integer |
|
|
56
|
+
| media_id | integer |
|
|
57
|
+
| item_cost | double |
|
|
58
|
+
| item_price | double |
|
|
59
|
+
| compare_price | double |
|
|
60
|
+
| backorders | integer |
|
|
61
|
+
| total_stock | integer |
|
|
62
|
+
| available | integer |
|
|
63
|
+
| committed | integer |
|
|
64
|
+
| on_hold | integer |
|
|
65
|
+
| sold_individually | integer |
|
|
66
|
+
| serial_index | integer |
|
|
67
|
+
| other_info | array |
|
|
68
|
+
|
|
69
|
+
## Appends
|
|
70
|
+
|
|
71
|
+
The following computed attributes are appended to every model instance:
|
|
72
|
+
|
|
73
|
+
| Appended Attribute | Description |
|
|
74
|
+
| --- | --- |
|
|
75
|
+
| `thumbnail` | Always appended via `$appends`. Returns the first thumbnail URL from the `media` relation, or `null`. |
|
|
76
|
+
| `formatted_total` | Appended at runtime inside `booted()` on every `retrieved` event. Returns `Helper::toDecimal($this->item_price)`. |
|
|
77
|
+
|
|
78
|
+
## Custom `other_info` Accessor
|
|
79
|
+
|
|
80
|
+
The `getOtherInfoAttribute` accessor decodes the JSON value and, when `payment_type` is `subscription`, injects sensible defaults for subscription fields that may not yet be stored:
|
|
81
|
+
|
|
82
|
+
| Injected Key | Default Value |
|
|
83
|
+
| --- | --- |
|
|
84
|
+
| `payment_type` | `'subscription'` |
|
|
85
|
+
| `installment` | `'yes'` only if value is `'yes'` AND Pro is active; otherwise `'no'` |
|
|
86
|
+
| `repeat_interval` | `'yearly'` |
|
|
87
|
+
| `times` | `0` |
|
|
88
|
+
| `trial_days` | `0` |
|
|
89
|
+
| `manage_setup_fee` | `'no'` |
|
|
90
|
+
|
|
91
|
+
This means reading `$variation->other_info` on a subscription variation always returns these keys even if they were not explicitly saved.
|
|
92
|
+
|
|
93
|
+
## Cascade Deletes
|
|
94
|
+
|
|
95
|
+
When a `ProductVariation` is deleted, the `boot()` method fires the following cleanup:
|
|
96
|
+
|
|
97
|
+
1. **Media** -- calls `\FluentCart\Api\Meta::deleteVariationMedia($model->id)` to remove associated media metadata.
|
|
98
|
+
2. **Attribute Map** -- calls `$model->attrMap()->delete()` to remove all related `AttributeRelation` records.
|
|
99
|
+
|
|
100
|
+
## Usage
|
|
101
|
+
|
|
102
|
+
Please check [Model Basic](/database/models.md) for Common methods.
|
|
103
|
+
|
|
104
|
+
### Accessing Attributes
|
|
105
|
+
|
|
106
|
+
```
|
|
107
|
+
$productVariation = FluentCart\App\Models\ProductVariation::find(1);
|
|
108
|
+
|
|
109
|
+
$productVariation->id; // returns id
|
|
110
|
+
$productVariation->post_id; // returns post ID
|
|
111
|
+
$productVariation->item_price; // returns item price (cast to double)
|
|
112
|
+
$productVariation->stock_status; // returns stock status
|
|
113
|
+
$productVariation->sku; // returns SKU
|
|
114
|
+
$productVariation->thumbnail; // returns thumbnail URL or null (appended attribute)
|
|
115
|
+
$productVariation->formatted_total; // returns formatted price string (appended on retrieval)
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
## Scopes
|
|
119
|
+
|
|
120
|
+
This model has the following scopes that you can use
|
|
121
|
+
|
|
122
|
+
### getWithShippingClass()
|
|
123
|
+
|
|
124
|
+
Get variations with their shipping class information. This scope executes the query, then looks up `ShippingMethod` records whose IDs match the `other_info.shipping_class` value on each variation, and attaches the matching method as a `shipping_method` dynamic attribute.
|
|
125
|
+
|
|
126
|
+
- Parameters none
|
|
127
|
+
|
|
128
|
+
Returns the query result (executes `$query->get()` internally)
|
|
129
|
+
|
|
130
|
+
#### Usage:
|
|
131
|
+
|
|
132
|
+
```
|
|
133
|
+
// Get variations with shipping class data
|
|
134
|
+
$variations = FluentCart\App\Models\ProductVariation::getWithShippingClass();
|
|
135
|
+
|
|
136
|
+
foreach ($variations as $variation) {
|
|
137
|
+
if (isset($variation->shipping_method)) {
|
|
138
|
+
echo $variation->shipping_method->title;
|
|
139
|
+
}
|
|
140
|
+
}
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
## Relations
|
|
144
|
+
|
|
145
|
+
### attrMap / attrRelations
|
|
146
|
+
|
|
147
|
+
Both are `hasMany` to `AttributeRelation` on `object_id` — the variation's attribute term links. `attrMap` is also what the model's `deleting` hook clears: deleting a variation removes its attribute relations and its variation media.
|
|
148
|
+
|
|
149
|
+
```
|
|
150
|
+
$terms = $variation->attrRelations;
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
This model has the following relationships that you can use
|
|
154
|
+
|
|
155
|
+
### product
|
|
156
|
+
|
|
157
|
+
Access the associated product (WordPress post). BelongsTo via `post_id` -> `Product.ID`.
|
|
158
|
+
|
|
159
|
+
- return `FluentCart\App\Models\Product` Model
|
|
160
|
+
|
|
161
|
+
#### Example:
|
|
162
|
+
|
|
163
|
+
```
|
|
164
|
+
// Accessing Product
|
|
165
|
+
$product = $productVariation->product;
|
|
166
|
+
|
|
167
|
+
// For Filtering by product relationship
|
|
168
|
+
$productVariations = FluentCart\App\Models\ProductVariation::whereHas('product', function($query) {
|
|
169
|
+
$query->where('post_status', 'publish');
|
|
170
|
+
})->get();
|
|
171
|
+
```
|
|
172
|
+
|
|
173
|
+
### shippingClass
|
|
174
|
+
|
|
175
|
+
Access the associated shipping class. BelongsTo via `shipping_class` -> `ShippingClass.id`.
|
|
176
|
+
|
|
177
|
+
- return `FluentCart\App\Models\ShippingClass` Model
|
|
178
|
+
|
|
179
|
+
#### Example:
|
|
180
|
+
|
|
181
|
+
```
|
|
182
|
+
// Accessing Shipping Class
|
|
183
|
+
$shippingClass = $productVariation->shippingClass;
|
|
184
|
+
```
|
|
185
|
+
|
|
186
|
+
### product_detail
|
|
187
|
+
|
|
188
|
+
Access the associated product detail. BelongsTo via `post_id` -> `ProductDetail.post_id`.
|
|
189
|
+
|
|
190
|
+
- return `FluentCart\App\Models\ProductDetail` Model
|
|
191
|
+
|
|
192
|
+
#### Example:
|
|
193
|
+
|
|
194
|
+
```
|
|
195
|
+
// Accessing Product Detail
|
|
196
|
+
$productDetail = $productVariation->product_detail;
|
|
197
|
+
```
|
|
198
|
+
|
|
199
|
+
### media
|
|
200
|
+
|
|
201
|
+
Access the associated product thumbnail media. HasOne to `ProductMeta` via `object_id` -> `id`, filtered to `meta_key = 'product_thumbnail'`. Only selects `id`, `object_id`, `meta_value`.
|
|
202
|
+
|
|
203
|
+
- return `FluentCart\App\Models\ProductMeta` Model (single record)
|
|
204
|
+
|
|
205
|
+
#### Example:
|
|
206
|
+
|
|
207
|
+
```
|
|
208
|
+
// Accessing Media
|
|
209
|
+
$media = $productVariation->media;
|
|
210
|
+
|
|
211
|
+
// The thumbnail appended attribute reads from this relation:
|
|
212
|
+
$url = $productVariation->thumbnail; // shortcut
|
|
213
|
+
```
|
|
214
|
+
|
|
215
|
+
### product_downloads
|
|
216
|
+
|
|
217
|
+
Access all product downloads associated with this variation's product. HasMany to `ProductDownload` via `post_id` -> `post_id`, filtered to rows where `product_variation_id` contains this variation's ID, or is `NULL`, or is `'[]'`.
|
|
218
|
+
|
|
219
|
+
- return `FluentCart\App\Models\ProductDownload` Model Collection
|
|
220
|
+
|
|
221
|
+
#### Example:
|
|
222
|
+
|
|
223
|
+
```
|
|
224
|
+
// Accessing Product Downloads
|
|
225
|
+
$downloads = $productVariation->product_downloads;
|
|
226
|
+
```
|
|
227
|
+
|
|
228
|
+
### order_items
|
|
229
|
+
|
|
230
|
+
Access all order items for this variation. HasMany to `OrderItem` via `object_id` -> `id`.
|
|
231
|
+
|
|
232
|
+
- return `FluentCart\App\Models\OrderItem` Model Collection
|
|
233
|
+
|
|
234
|
+
#### Example:
|
|
235
|
+
|
|
236
|
+
```
|
|
237
|
+
// Accessing Order Items
|
|
238
|
+
$orderItems = $productVariation->order_items;
|
|
239
|
+
```
|
|
240
|
+
|
|
241
|
+
### downloadable_files
|
|
242
|
+
|
|
243
|
+
Access all downloadable files directly linked to this variation. HasMany to `ProductDownload` via `product_variation_id` -> `id`.
|
|
244
|
+
|
|
245
|
+
- return `FluentCart\App\Models\ProductDownload` Model Collection
|
|
246
|
+
|
|
247
|
+
#### Example:
|
|
248
|
+
|
|
249
|
+
```
|
|
250
|
+
// Accessing Downloadable Files
|
|
251
|
+
$downloadableFiles = $productVariation->downloadable_files;
|
|
252
|
+
```
|
|
253
|
+
|
|
254
|
+
### upgrade_paths
|
|
255
|
+
|
|
256
|
+
Access all upgrade path meta entries for this variation. HasMany to `Meta` via `object_id` -> `id`, filtered by `object_type = PlanUpgradeService::$metaType` and `meta_key = PlanUpgradeService::$metaKey`.
|
|
257
|
+
|
|
258
|
+
- return `FluentCart\App\Models\Meta` Model Collection
|
|
259
|
+
|
|
260
|
+
#### Example:
|
|
261
|
+
|
|
262
|
+
```
|
|
263
|
+
// Accessing Upgrade Paths
|
|
264
|
+
$upgradePaths = $productVariation->upgrade_paths;
|
|
265
|
+
```
|
|
266
|
+
|
|
267
|
+
### attrMap
|
|
268
|
+
|
|
269
|
+
Access all attribute relation mappings for this variation. HasMany to `AttributeRelation` via `object_id` -> `id`.
|
|
270
|
+
|
|
271
|
+
**Note:** These records are cascade-deleted when the variation is deleted.
|
|
272
|
+
|
|
273
|
+
- return `FluentCart\App\Models\AttributeRelation` Model Collection
|
|
274
|
+
|
|
275
|
+
#### Example:
|
|
276
|
+
|
|
277
|
+
```
|
|
278
|
+
// Accessing Attribute Relations
|
|
279
|
+
$attrMap = $productVariation->attrMap;
|
|
280
|
+
```
|
|
281
|
+
|
|
282
|
+
### bundleChildren
|
|
283
|
+
|
|
284
|
+
Access the child variations of a bundle product. Uses a custom `BundleChildrenRelation` that reads child IDs from the `other_info` JSON column (key `bundle_child_ids`) and loads the corresponding `ProductVariation` records. Supports eager loading.
|
|
285
|
+
|
|
286
|
+
- return `FluentCart\App\Models\ProductVariation` Model Collection (via `BundleChildrenRelation`)
|
|
287
|
+
|
|
288
|
+
#### Example:
|
|
289
|
+
|
|
290
|
+
```
|
|
291
|
+
// Accessing Bundle Children
|
|
292
|
+
$children = $productVariation->bundleChildren;
|
|
293
|
+
|
|
294
|
+
// Eager loading bundle children
|
|
295
|
+
$variations = FluentCart\App\Models\ProductVariation::with('bundleChildren')->where('post_id', $postId)->get();
|
|
296
|
+
|
|
297
|
+
foreach ($variations as $variation) {
|
|
298
|
+
foreach ($variation->bundleChildren as $child) {
|
|
299
|
+
echo $child->variation_title;
|
|
300
|
+
}
|
|
301
|
+
}
|
|
302
|
+
```
|
|
303
|
+
|
|
304
|
+
## Methods
|
|
305
|
+
|
|
306
|
+
### isStock($bundleChildren = null)
|
|
307
|
+
|
|
308
|
+
Whether the variation is in stock. For a bundle, pass the already-loaded children so the check does not re-query them per variation.
|
|
309
|
+
|
|
310
|
+
- Parameters `$bundleChildren` - array|null (optional) - pre-loaded bundle children
|
|
311
|
+
|
|
312
|
+
Returns `bool`
|
|
313
|
+
|
|
314
|
+
### loadBundleChildren($variations) (static)
|
|
315
|
+
|
|
316
|
+
Resolve the bundle children for a set of variations in one pass, so `isStock()` can then be called per variation without an N+1.
|
|
317
|
+
|
|
318
|
+
- Parameters `$variations` - the variations to resolve children for
|
|
319
|
+
|
|
320
|
+
### getVariationLabel()
|
|
321
|
+
|
|
322
|
+
The variation's label, built from its attribute terms.
|
|
323
|
+
|
|
324
|
+
- Returns `string`
|
|
325
|
+
|
|
326
|
+
### getDisplayTitle()
|
|
327
|
+
|
|
328
|
+
The title shown to customers for this variation.
|
|
329
|
+
|
|
330
|
+
- Returns `string`
|
|
331
|
+
|
|
332
|
+
Along with Global Model methods, this model has few helper methods.
|
|
333
|
+
|
|
334
|
+
### getFormattedTotalAttribute()
|
|
335
|
+
|
|
336
|
+
Get formatted total price (accessor). Automatically appended on every `retrieved` event via the `booted()` method.
|
|
337
|
+
|
|
338
|
+
- Parameters none
|
|
339
|
+
|
|
340
|
+
Returns `string` -- the decimal-formatted item price
|
|
341
|
+
|
|
342
|
+
#### Usage
|
|
343
|
+
|
|
344
|
+
```
|
|
345
|
+
$formattedTotal = $productVariation->formatted_total; // Returns formatted price string
|
|
346
|
+
```
|
|
347
|
+
|
|
348
|
+
### getThumbnailAttribute()
|
|
349
|
+
|
|
350
|
+
Get thumbnail URL (accessor). Reads from the `media` relation. Returns the `url` key of the first element in `media->meta_value`, or `null` if no media is set.
|
|
351
|
+
|
|
352
|
+
- Parameters none
|
|
353
|
+
|
|
354
|
+
Returns `string|null`
|
|
355
|
+
|
|
356
|
+
#### Usage
|
|
357
|
+
|
|
358
|
+
```
|
|
359
|
+
$thumbnail = $productVariation->thumbnail; // Returns thumbnail URL or null
|
|
360
|
+
```
|
|
361
|
+
|
|
362
|
+
### canPurchase($quantity = 1)
|
|
363
|
+
|
|
364
|
+
Check if the variation can be purchased. Validates:
|
|
365
|
+
|
|
366
|
+
1. `item_status` must be `active` and parent product must be `publish` or `private`.
|
|
367
|
+
2. Subscription variations cannot have `$quantity > 1`.
|
|
368
|
+
3. A related `product_detail` must exist.
|
|
369
|
+
4. If stock management module is active and both `productDetail->manage_stock` and `$this->manage_stock` are truthy, `$quantity` must not exceed `$this->available`.
|
|
370
|
+
5. Bundle products require Pro to be active.
|
|
371
|
+
6. Applies the `fluent_cart/variation/can_purchase_bundle` filter for additional bundle checks.
|
|
372
|
+
|
|
373
|
+
- Parameters `$quantity` - integer (default: 1)
|
|
374
|
+
|
|
375
|
+
Returns `true` on success, or `\WP_Error` with an error code on failure
|
|
376
|
+
|
|
377
|
+
**Error codes:** `unpublished`, `invalid_subscription_quantity`, `insufficient_stock`, `invalid_bundle_product`
|
|
378
|
+
|
|
379
|
+
#### Usage
|
|
380
|
+
|
|
381
|
+
```
|
|
382
|
+
$canPurchase = $productVariation->canPurchase(2);
|
|
383
|
+
if (is_wp_error($canPurchase)) {
|
|
384
|
+
echo "Error: " . $canPurchase->get_error_message();
|
|
385
|
+
} else {
|
|
386
|
+
echo "Available for purchase";
|
|
387
|
+
}
|
|
388
|
+
```
|
|
389
|
+
|
|
390
|
+
### getSubscriptionTermsText($withComparePrice = false)
|
|
391
|
+
|
|
392
|
+
Get human-readable subscription terms text. Returns an empty string for non-subscription variations. Reads `trial_days`, `repeat_interval`, `times`, `signup_fee`, `signup_fee_name` from `other_info` and delegates to `Helper::getSubscriptionTermText()`.
|
|
393
|
+
|
|
394
|
+
- Parameters `$withComparePrice` - boolean (default: false). When `true` and `compare_price > item_price`, the compare price is included in the formatted output.
|
|
395
|
+
|
|
396
|
+
Returns `string`
|
|
397
|
+
|
|
398
|
+
#### Usage
|
|
399
|
+
|
|
400
|
+
```
|
|
401
|
+
$termsText = $productVariation->getSubscriptionTermsText(true);
|
|
402
|
+
echo "Subscription Terms: " . $termsText;
|
|
403
|
+
```
|
|
404
|
+
|
|
405
|
+
### getPurchaseUrl()
|
|
406
|
+
|
|
407
|
+
Get the instant checkout purchase URL for this variation.
|
|
408
|
+
|
|
409
|
+
- Parameters none
|
|
410
|
+
|
|
411
|
+
Returns `string` -- URL in the format `site_url('?fluent-cart=instant_checkout&item_id={id}&quantity=1')`
|
|
412
|
+
|
|
413
|
+
#### Usage
|
|
414
|
+
|
|
415
|
+
```
|
|
416
|
+
$purchaseUrl = $productVariation->getPurchaseUrl();
|
|
417
|
+
echo "Purchase URL: " . $purchaseUrl;
|
|
418
|
+
```
|
|
419
|
+
|
|
420
|
+
### soldIndividually()
|
|
421
|
+
|
|
422
|
+
Check whether this variation's parent product is sold individually. Delegates to `$this->product->soldIndividually()`.
|
|
423
|
+
|
|
424
|
+
- Parameters none
|
|
425
|
+
|
|
426
|
+
Returns `bool` -- `false` if no product is loaded
|
|
427
|
+
|
|
428
|
+
#### Usage
|
|
429
|
+
|
|
430
|
+
```
|
|
431
|
+
if ($productVariation->soldIndividually()) {
|
|
432
|
+
echo "This product can only be purchased one at a time.";
|
|
433
|
+
}
|
|
434
|
+
```
|
|
435
|
+
|
|
436
|
+
### isStock()
|
|
437
|
+
|
|
438
|
+
Check whether this variation is currently in stock. The logic handles both regular and bundle products:
|
|
439
|
+
|
|
440
|
+
1. Returns `false` if `item_status` is not `active`.
|
|
441
|
+
2. If `manage_stock` is disabled: For bundle products, delegates to `isBundleChildrenInStock()`.
|
|
442
|
+
3. For regular products, returns `true` when `stock_status` equals `Helper::IN_STOCK`.
|
|
443
|
+
4. If `manage_stock` is enabled, checks `available > 0` AND `stock_status === Helper::IN_STOCK`.
|
|
444
|
+
5. For bundle products with stock management enabled, the parent must be in stock AND all children must pass `isBundleChildrenInStock()`.
|
|
445
|
+
|
|
446
|
+
- Parameters none
|
|
447
|
+
|
|
448
|
+
Returns `bool`
|
|
449
|
+
|
|
450
|
+
#### Usage
|
|
451
|
+
|
|
452
|
+
```
|
|
453
|
+
$variation = FluentCart\App\Models\ProductVariation::find(1);
|
|
454
|
+
if ($variation->isStock()) {
|
|
455
|
+
echo "In stock";
|
|
456
|
+
} else {
|
|
457
|
+
echo "Out of stock";
|
|
458
|
+
}
|
|
459
|
+
```
|
|
460
|
+
|
|
461
|
+
### isBundleChildrenInStock() (protected)
|
|
462
|
+
|
|
463
|
+
Check if all bundle children are in stock. Reads `bundle_child_ids` from `other_info`, loads those variations, and verifies each child is `active` and (if `manage_stock` is enabled) has `available > 0` with `stock_status === Helper::IN_STOCK`. Returns `true` if there are no bundle children.
|
|
464
|
+
|
|
465
|
+
- Visibility: `protected`
|
|
466
|
+
- Parameters none
|
|
467
|
+
|
|
468
|
+
Returns `bool`
|
|
469
|
+
|
|
470
|
+
## Hooks / Filters
|
|
471
|
+
|
|
472
|
+
| Hook | Type | Location | Description |
|
|
473
|
+
| --- | --- | --- | --- |
|
|
474
|
+
| `fluent_cart/variation/can_purchase_bundle` | Filter | `canPurchase()` | Allows external code to block or allow bundle purchases. Receives `null` and an array with `variation` and `quantity`. Return `\WP_Error` to block, `false` for out-of-stock, or `null`/`true` to allow. |
|
|
475
|
+
|
|
476
|
+
## Usage Examples
|
|
477
|
+
|
|
478
|
+
### Get Product Variations
|
|
479
|
+
|
|
480
|
+
```
|
|
481
|
+
$productVariation = FluentCart\App\Models\ProductVariation::find(1);
|
|
482
|
+
echo "Price: " . $productVariation->formatted_total;
|
|
483
|
+
echo "Stock: " . $productVariation->available;
|
|
484
|
+
echo "Status: " . $productVariation->item_status;
|
|
485
|
+
echo "SKU: " . $productVariation->sku;
|
|
486
|
+
```
|
|
487
|
+
|
|
488
|
+
### Get Variations with Shipping Class
|
|
489
|
+
|
|
490
|
+
```
|
|
491
|
+
$variations = FluentCart\App\Models\ProductVariation::getWithShippingClass();
|
|
492
|
+
foreach ($variations as $variation) {
|
|
493
|
+
echo "Variation: " . $variation->variation_title;
|
|
494
|
+
if (isset($variation->shipping_method)) {
|
|
495
|
+
echo "Shipping Method: " . $variation->shipping_method->title;
|
|
496
|
+
}
|
|
497
|
+
}
|
|
498
|
+
```
|
|
499
|
+
|
|
500
|
+
### Check Purchase Availability
|
|
501
|
+
|
|
502
|
+
```
|
|
503
|
+
$variation = FluentCart\App\Models\ProductVariation::find(1);
|
|
504
|
+
$canPurchase = $variation->canPurchase(1);
|
|
505
|
+
|
|
506
|
+
if (is_wp_error($canPurchase)) {
|
|
507
|
+
echo "Cannot purchase: " . $canPurchase->get_error_message();
|
|
508
|
+
} else {
|
|
509
|
+
echo "Available for purchase";
|
|
510
|
+
}
|
|
511
|
+
```
|
|
512
|
+
|
|
513
|
+
### Check Stock Status (Including Bundles)
|
|
514
|
+
|
|
515
|
+
```
|
|
516
|
+
$variation = FluentCart\App\Models\ProductVariation::find(1);
|
|
517
|
+
if ($variation->isStock()) {
|
|
518
|
+
echo "Variation is in stock";
|
|
519
|
+
} else {
|
|
520
|
+
echo "Variation is out of stock";
|
|
521
|
+
}
|
|
522
|
+
```
|
|
523
|
+
|
|
524
|
+
### Get Subscription Terms
|
|
525
|
+
|
|
526
|
+
```
|
|
527
|
+
$variation = FluentCart\App\Models\ProductVariation::find(1);
|
|
528
|
+
if ($variation->payment_type === 'subscription') {
|
|
529
|
+
$terms = $variation->getSubscriptionTermsText(true);
|
|
530
|
+
echo "Subscription: " . $terms;
|
|
531
|
+
}
|
|
532
|
+
```
|
|
533
|
+
|
|
534
|
+
### Get Downloadable Files
|
|
535
|
+
|
|
536
|
+
```
|
|
537
|
+
$variation = FluentCart\App\Models\ProductVariation::find(1);
|
|
538
|
+
$downloads = $variation->downloadable_files;
|
|
539
|
+
|
|
540
|
+
foreach ($downloads as $download) {
|
|
541
|
+
echo "Download: " . $download->title;
|
|
542
|
+
}
|
|
543
|
+
```
|
|
544
|
+
|
|
545
|
+
### Work with Bundle Children
|
|
546
|
+
|
|
547
|
+
```
|
|
548
|
+
$variation = FluentCart\App\Models\ProductVariation::find(1);
|
|
549
|
+
$children = $variation->bundleChildren;
|
|
550
|
+
|
|
551
|
+
foreach ($children as $child) {
|
|
552
|
+
echo "Child: " . $child->variation_title . " - Price: " . $child->formatted_total;
|
|
553
|
+
}
|
|
554
|
+
```
|
|
555
|
+
|
|
556
|
+
---
|