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,2485 +1,2485 @@
|
|
|
1
|
-
# Products API
|
|
2
|
-
|
|
3
|
-
Manage your product catalog including creating products, managing variations, downloadable files, bundles, upgrade paths, tax/shipping classes, stock management, and product integrations.
|
|
4
|
-
|
|
5
|
-
**Base URL:** `https://your-site.com/wp-json/fluent-cart/v2/products`
|
|
6
|
-
|
|
7
|
-
**Policy:** `ProductPolicy`
|
|
8
|
-
|
|
9
|
-
> All monetary values are in **cents** (e.g., `$10.00` = `1000`).
|
|
10
|
-
|
|
11
|
-
---
|
|
12
|
-
|
|
13
|
-
## Product CRUD & Listing
|
|
14
|
-
|
|
15
|
-
### List Products
|
|
16
|
-
|
|
17
|
-
GET `/fluent-cart/v2/products`
|
|
18
|
-
|
|
19
|
-
Retrieve a paginated list of products with filtering, sorting, and search capabilities.
|
|
20
|
-
|
|
21
|
-
- **Permission:** `products/view`
|
|
22
|
-
|
|
23
|
-
#### Parameters
|
|
24
|
-
|
|
25
|
-
| Parameter | Type | Location | Required | Description |
|
|
26
|
-
| --- | --- | --- | --- | --- |
|
|
27
|
-
| `search` | string | query | No | Search by product title, ID, or variation title |
|
|
28
|
-
| `per_page` | integer | query | No | Number of results per page (default: `10`) |
|
|
29
|
-
| `page` | integer | query | No | Page number for pagination |
|
|
30
|
-
| `sort_by` | string | query | No | Column to sort by (default: `ID`) |
|
|
31
|
-
| `sort_type` | string | query | No | Sort direction: `asc` or `desc` (default: `desc`) |
|
|
32
|
-
| `active_view` | string | query | No | Filter tab: `publish`, `draft`, `physical`, `digital`, `subscribable`, `not_subscribable`, `bundle`, `non_bundle` |
|
|
33
|
-
| `filter_type` | string | query | No | `simple` or `advanced` |
|
|
34
|
-
| `with` | array | query | No | Relations to eager load |
|
|
35
|
-
| `search_groups` | array | query | No | Advanced filter groups for complex queries |
|
|
36
|
-
|
|
37
|
-
#### Response
|
|
38
|
-
|
|
39
|
-
```
|
|
40
|
-
{
|
|
41
|
-
"products": {
|
|
42
|
-
"total": 50,
|
|
43
|
-
"per_page": 10,
|
|
44
|
-
"current_page": 1,
|
|
45
|
-
"last_page": 5,
|
|
46
|
-
"data": [
|
|
47
|
-
{
|
|
48
|
-
"ID": 123,
|
|
49
|
-
"post_title": "Example Product",
|
|
50
|
-
"post_status": "publish",
|
|
51
|
-
"post_date": "2025-01-15 12:00:00",
|
|
52
|
-
"view_url": "https://example.com/product/example-product",
|
|
53
|
-
"edit_url": "https://example.com/wp-admin/admin.php?page=fluent-cart#/products/123"
|
|
54
|
-
}
|
|
55
|
-
]
|
|
56
|
-
}
|
|
57
|
-
}
|
|
58
|
-
```
|
|
59
|
-
|
|
60
|
-
#### Example
|
|
61
|
-
|
|
62
|
-
```
|
|
63
|
-
curl -X GET "https://example.com/wp-json/fluent-cart/v2/products?search=widget&per_page=20&active_view=publish" \
|
|
64
|
-
-u "username:app_password"
|
|
65
|
-
```
|
|
66
|
-
|
|
67
|
-
---
|
|
68
|
-
|
|
69
|
-
### Get Product
|
|
70
|
-
|
|
71
|
-
GET `/fluent-cart/v2/products/{product}`
|
|
72
|
-
|
|
73
|
-
Retrieve a single product by ID.
|
|
74
|
-
|
|
75
|
-
- **Permission:** `products/view`
|
|
76
|
-
|
|
77
|
-
#### Parameters
|
|
78
|
-
|
|
79
|
-
| Parameter | Type | Location | Required | Description |
|
|
80
|
-
| --- | --- | --- | --- | --- |
|
|
81
|
-
| `product` | integer | path | Yes | The product ID |
|
|
82
|
-
| `with` | array | query | No | Relations to eager load (e.g., `["detail", "variants", "product_menu"]`) |
|
|
83
|
-
|
|
84
|
-
#### Response
|
|
85
|
-
|
|
86
|
-
```
|
|
87
|
-
{
|
|
88
|
-
"product": {
|
|
89
|
-
"ID": 123,
|
|
90
|
-
"post_title": "Example Product",
|
|
91
|
-
"post_status": "publish",
|
|
92
|
-
"post_excerpt": "Short description",
|
|
93
|
-
"post_content": "Full description"
|
|
94
|
-
},
|
|
95
|
-
"product_menu": []
|
|
96
|
-
}
|
|
97
|
-
```
|
|
98
|
-
|
|
99
|
-
#### Example
|
|
100
|
-
|
|
101
|
-
```
|
|
102
|
-
curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/123?with[]=detail&with[]=variants" \
|
|
103
|
-
-u "username:app_password"
|
|
104
|
-
```
|
|
105
|
-
|
|
106
|
-
---
|
|
107
|
-
|
|
108
|
-
### Create Product
|
|
109
|
-
|
|
110
|
-
POST `/fluent-cart/v2/products`
|
|
111
|
-
|
|
112
|
-
Create a new product. A default variation is automatically created with the product.
|
|
113
|
-
|
|
114
|
-
- **Permission:** `products/create`
|
|
115
|
-
- **Request Class:** `ProductCreateRequest`
|
|
116
|
-
|
|
117
|
-
#### Parameters
|
|
118
|
-
|
|
119
|
-
| Parameter | Type | Location | Required | Description |
|
|
120
|
-
| --- | --- | --- | --- | --- |
|
|
121
|
-
| `post_title` | string | body | Yes | Product title (max 200 characters) |
|
|
122
|
-
| `post_status` | string | body | No | Post status (e.g., `draft`, `publish`) |
|
|
123
|
-
| `detail.fulfillment_type` | string | body | No | `physical` or `digital` (default: `digital`) |
|
|
124
|
-
| `detail.other_info.is_bundle_product` | string | body | No | `yes` or `no` (default: `no`) |
|
|
125
|
-
|
|
126
|
-
#### Response
|
|
127
|
-
|
|
128
|
-
```
|
|
129
|
-
{
|
|
130
|
-
"data": {
|
|
131
|
-
"ID": 124,
|
|
132
|
-
"variant": {
|
|
133
|
-
"id": 456,
|
|
134
|
-
"post_id": 124,
|
|
135
|
-
"variation_title": "Example Product",
|
|
136
|
-
"stock_status": "in-stock",
|
|
137
|
-
"payment_type": "onetime",
|
|
138
|
-
"total_stock": 1,
|
|
139
|
-
"available": 1,
|
|
140
|
-
"fulfillment_type": "digital"
|
|
141
|
-
},
|
|
142
|
-
"product_details": { ... }
|
|
143
|
-
},
|
|
144
|
-
"message": "Product has been created successfully"
|
|
145
|
-
}
|
|
146
|
-
```
|
|
147
|
-
|
|
148
|
-
#### Example
|
|
149
|
-
|
|
150
|
-
```
|
|
151
|
-
curl -X POST "https://example.com/wp-json/fluent-cart/v2/products" \
|
|
152
|
-
-u "username:app_password" \
|
|
153
|
-
-H "Content-Type: application/json" \
|
|
154
|
-
-d '{
|
|
155
|
-
"post_title": "New Digital Product",
|
|
156
|
-
"post_status": "draft",
|
|
157
|
-
"detail": {
|
|
158
|
-
"fulfillment_type": "digital"
|
|
159
|
-
}
|
|
160
|
-
}'
|
|
161
|
-
```
|
|
162
|
-
|
|
163
|
-
---
|
|
164
|
-
|
|
165
|
-
### Delete Product
|
|
166
|
-
|
|
167
|
-
DELETE `/fluent-cart/v2/products/{product}`
|
|
168
|
-
|
|
169
|
-
Delete a product and all associated data.
|
|
170
|
-
|
|
171
|
-
- **Permission:** `products/delete`
|
|
172
|
-
|
|
173
|
-
#### Parameters
|
|
174
|
-
|
|
175
|
-
| Parameter | Type | Location | Required | Description |
|
|
176
|
-
| --- | --- | --- | --- | --- |
|
|
177
|
-
| `product` | integer | path | Yes | The product ID to delete |
|
|
178
|
-
|
|
179
|
-
#### Response
|
|
180
|
-
|
|
181
|
-
```
|
|
182
|
-
{
|
|
183
|
-
"message": "Product deleted successfully"
|
|
184
|
-
}
|
|
185
|
-
```
|
|
186
|
-
|
|
187
|
-
#### Example
|
|
188
|
-
|
|
189
|
-
```
|
|
190
|
-
curl -X DELETE "https://example.com/wp-json/fluent-cart/v2/products/123" \
|
|
191
|
-
-u "username:app_password"
|
|
192
|
-
```
|
|
193
|
-
|
|
194
|
-
---
|
|
195
|
-
|
|
196
|
-
### Get Product Pricing
|
|
197
|
-
|
|
198
|
-
GET `/fluent-cart/v2/products/{productId}/pricing`
|
|
199
|
-
|
|
200
|
-
Retrieve the full product details including pricing, variants, downloadable files, and taxonomy information.
|
|
201
|
-
|
|
202
|
-
- **Permission:** `products/view`
|
|
203
|
-
|
|
204
|
-
#### Parameters
|
|
205
|
-
|
|
206
|
-
| Parameter | Type | Location | Required | Description |
|
|
207
|
-
| --- | --- | --- | --- | --- |
|
|
208
|
-
| `productId` | integer | path | Yes | The product ID |
|
|
209
|
-
| `with` | array | query | No | Additional relations (e.g., `["product_menu"]`) |
|
|
210
|
-
|
|
211
|
-
#### Response
|
|
212
|
-
|
|
213
|
-
```
|
|
214
|
-
{
|
|
215
|
-
"product": {
|
|
216
|
-
"ID": 123,
|
|
217
|
-
"post_title": "Example Product",
|
|
218
|
-
"post_status": "publish",
|
|
219
|
-
"post_excerpt": "Short description",
|
|
220
|
-
"featured_image_id": 456,
|
|
221
|
-
"view_url": "https://example.com/product/example",
|
|
222
|
-
"edit_url": "https://example.com/wp-admin/admin.php?page=fluent-cart#/products/123",
|
|
223
|
-
"detail": {
|
|
224
|
-
"id": 1,
|
|
225
|
-
"post_id": 123,
|
|
226
|
-
"fulfillment_type": "digital",
|
|
227
|
-
"variation_type": "simple",
|
|
228
|
-
"manage_stock": 0,
|
|
229
|
-
"manage_downloadable": 0,
|
|
230
|
-
"other_info": { ... }
|
|
231
|
-
},
|
|
232
|
-
"variants": [
|
|
233
|
-
{
|
|
234
|
-
"id": 789,
|
|
235
|
-
"post_id": 123,
|
|
236
|
-
"variation_title": "Default Plan",
|
|
237
|
-
"item_price": 1000,
|
|
238
|
-
"compare_price": 0,
|
|
239
|
-
"stock_status": "in-stock",
|
|
240
|
-
"other_info": { ... },
|
|
241
|
-
"media": []
|
|
242
|
-
}
|
|
243
|
-
],
|
|
244
|
-
"downloadable_files": []
|
|
245
|
-
},
|
|
246
|
-
"product_menu": "",
|
|
247
|
-
"taxonomies": [
|
|
248
|
-
{
|
|
249
|
-
"name": "product-categories",
|
|
250
|
-
"label": "Product Categories",
|
|
251
|
-
"terms": [],
|
|
252
|
-
"labels": { ... }
|
|
253
|
-
}
|
|
254
|
-
]
|
|
255
|
-
}
|
|
256
|
-
```
|
|
257
|
-
|
|
258
|
-
#### Example
|
|
259
|
-
|
|
260
|
-
```
|
|
261
|
-
curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/123/pricing?with[]=product_menu" \
|
|
262
|
-
-u "username:app_password"
|
|
263
|
-
```
|
|
264
|
-
|
|
265
|
-
---
|
|
266
|
-
|
|
267
|
-
### Update Product Pricing
|
|
268
|
-
|
|
269
|
-
POST `/fluent-cart/v2/products/{postId}/pricing`
|
|
270
|
-
|
|
271
|
-
Update a product's pricing, details, variants, and other metadata.
|
|
272
|
-
|
|
273
|
-
- **Permission:** `products/edit`
|
|
274
|
-
- **Request Class:** `ProductUpdateRequest`
|
|
275
|
-
|
|
276
|
-
#### Parameters
|
|
277
|
-
|
|
278
|
-
| Parameter | Type | Location | Required | Description |
|
|
279
|
-
| --- | --- | --- | --- | --- |
|
|
280
|
-
| `postId` | integer | path | Yes | The product post ID |
|
|
281
|
-
| `post_title` | string | body | Yes | Product title (max 200 characters) |
|
|
282
|
-
| `post_status` | string | body | Yes | Status: `draft`, `publish`, `future` |
|
|
283
|
-
| `post_date` | string | body | Conditional | Required when `post_status` is `future`. Must be a future date (GMT) |
|
|
284
|
-
| `post_excerpt` | string | body | No | Product short description (limited by `excerpt_length` filter, default 55 words) |
|
|
285
|
-
| `post_content` | string | body | No | Product long description (HTML allowed) |
|
|
286
|
-
| `post_name` | string | body | No | Product URL slug |
|
|
287
|
-
| `comment_status` | string | body | No | Comment status (max 100 chars) |
|
|
288
|
-
| `detail.fulfillment_type` | string | body | Yes | `physical` or `digital` |
|
|
289
|
-
| `detail.variation_type` | string | body | Yes | `simple` or `simple_variations` |
|
|
290
|
-
| `detail.manage_stock` | integer | body | No | `0` or `1` |
|
|
291
|
-
| `detail.manage_downloadable` | integer | body | No | `0` or `1` |
|
|
292
|
-
| `detail.default_variation_id` | integer | body | No | Default variation ID |
|
|
293
|
-
| `detail.stock_availability` | string | body | No | Stock availability status |
|
|
294
|
-
| `detail.other_info.group_pricing_by` | string | body | No | `payment_type`, `repeat_interval`, or `none` |
|
|
295
|
-
| `detail.other_info.sold_individually` | string | body | No | `yes` or `no` |
|
|
296
|
-
| `detail.other_info.use_pricing_table` | string | body | No | Enable pricing table display |
|
|
297
|
-
| `detail.other_info.shipping_class` | integer | body | No | Shipping class ID (validated) |
|
|
298
|
-
| `detail.other_info.tax_class` | integer | body | No | Tax class ID (validated) |
|
|
299
|
-
| `detail.other_info.active_editor` | string | body | No | Active editor mode |
|
|
300
|
-
| `variants` | array | body | Conditional | Array of variant objects (required for `simple` type when publishing) |
|
|
301
|
-
| `variants.*.variation_title` | string | body | Yes | Variation title (max 200 chars) |
|
|
302
|
-
| `variants.*.post_id` | integer | body | Yes | Parent product post ID |
|
|
303
|
-
| `variants.*.item_price` | number | body | No | Price in cents (min: 0) |
|
|
304
|
-
| `variants.*.compare_price` | number | body | No | Compare-at price in cents (must be >= `item_price`) |
|
|
305
|
-
| `variants.*.manage_cost` | string | body | No | Enable cost tracking |
|
|
306
|
-
| `variants.*.item_cost` | number | body | Conditional | Required if `manage_cost` is `true` |
|
|
307
|
-
| `variants.*.serial_index` | integer | body | No | Display order index |
|
|
308
|
-
| `variants.*.sku` | string | body | No | SKU (max 30 chars, must be unique) |
|
|
309
|
-
| `variants.*.fulfillment_type` | string | body | No | `physical` or `digital` |
|
|
310
|
-
| `variants.*.other_info.payment_type` | string | body | Yes | `onetime` or `subscription` |
|
|
311
|
-
| `variants.*.other_info.description` | string | body | No | Variant description (max 255 chars) |
|
|
312
|
-
| `variants.*.other_info.repeat_interval` | string | body | Conditional | Required for subscriptions. e.g., `monthly`, `yearly` |
|
|
313
|
-
| `variants.*.other_info.times` | string | body | No | Number of billing cycles |
|
|
314
|
-
| `variants.*.other_info.trial_days` | string | body | No | Trial period in days (max 365) |
|
|
315
|
-
| `variants.*.other_info.billing_summary` | string | body | No | Billing summary text (max 255 chars) |
|
|
316
|
-
| `variants.*.other_info.manage_setup_fee` | string | body | Conditional | Required for subscriptions: `yes` or `no` |
|
|
317
|
-
| `variants.*.other_info.signup_fee` | number | body | Conditional | Setup fee in cents. Required if `manage_setup_fee` is `yes` |
|
|
318
|
-
| `variants.*.other_info.signup_fee_name` | string | body | Conditional | Setup fee label (max 100 chars). Required if `manage_setup_fee` is `yes` |
|
|
319
|
-
| `variants.*.other_info.installment` | string | body | No | Enable installment: `yes` or `no` |
|
|
320
|
-
| `product_terms` | object | body | No | Taxonomy term IDs (e.g., `{"product-categories": [1, 2]}`) |
|
|
321
|
-
| `gallery` | array | body | No | Gallery images array with `id`, `url`, `title` |
|
|
322
|
-
| `metaValue` | mixed | body | No | Additional metadata |
|
|
323
|
-
|
|
324
|
-
#### Response
|
|
325
|
-
|
|
326
|
-
```
|
|
327
|
-
{
|
|
328
|
-
"data": { ... },
|
|
329
|
-
"message": "Product updated successfully"
|
|
330
|
-
}
|
|
331
|
-
```
|
|
332
|
-
|
|
333
|
-
#### Example
|
|
334
|
-
|
|
335
|
-
```
|
|
336
|
-
curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/123/pricing" \
|
|
337
|
-
-u "username:app_password" \
|
|
338
|
-
-H "Content-Type: application/json" \
|
|
339
|
-
-d '{
|
|
340
|
-
"post_title": "Updated Product",
|
|
341
|
-
"post_status": "publish",
|
|
342
|
-
"detail": {
|
|
343
|
-
"fulfillment_type": "digital",
|
|
344
|
-
"variation_type": "simple"
|
|
345
|
-
},
|
|
346
|
-
"variants": [
|
|
347
|
-
{
|
|
348
|
-
"id": 789,
|
|
349
|
-
"post_id": 123,
|
|
350
|
-
"variation_title": "Default Plan",
|
|
351
|
-
"item_price": 1999,
|
|
352
|
-
"other_info": {
|
|
353
|
-
"payment_type": "onetime"
|
|
354
|
-
}
|
|
355
|
-
}
|
|
356
|
-
]
|
|
357
|
-
}'
|
|
358
|
-
```
|
|
359
|
-
|
|
360
|
-
---
|
|
361
|
-
|
|
362
|
-
## Product Search & Lookup
|
|
363
|
-
|
|
364
|
-
### Search Products by Name
|
|
365
|
-
|
|
366
|
-
GET `/fluent-cart/v2/products/searchProductByName`
|
|
367
|
-
|
|
368
|
-
Search for published products by name. Returns products formatted for select dropdowns.
|
|
369
|
-
|
|
370
|
-
- **Permission:** `products/view`
|
|
371
|
-
|
|
372
|
-
#### Parameters
|
|
373
|
-
|
|
374
|
-
| Parameter | Type | Location | Required | Description |
|
|
375
|
-
| --- | --- | --- | --- | --- |
|
|
376
|
-
| `name` | string | query | No | Product name to search for |
|
|
377
|
-
| `url_mode` | string | query | No | URL mode flag |
|
|
378
|
-
| `termId` | integer | query | No | Filter by taxonomy term ID (product-categories) |
|
|
379
|
-
|
|
380
|
-
#### Response
|
|
381
|
-
|
|
382
|
-
```
|
|
383
|
-
{
|
|
384
|
-
"products": [
|
|
385
|
-
{
|
|
386
|
-
"ID": 123,
|
|
387
|
-
"post_title": "Example Product",
|
|
388
|
-
"wpTerms": [...]
|
|
389
|
-
}
|
|
390
|
-
]
|
|
391
|
-
}
|
|
392
|
-
```
|
|
393
|
-
|
|
394
|
-
#### Example
|
|
395
|
-
|
|
396
|
-
```
|
|
397
|
-
curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/searchProductByName?name=widget" \
|
|
398
|
-
-u "username:app_password"
|
|
399
|
-
```
|
|
400
|
-
|
|
401
|
-
---
|
|
402
|
-
|
|
403
|
-
### Search Variants by Name
|
|
404
|
-
|
|
405
|
-
GET `/fluent-cart/v2/products/searchVariantByName`
|
|
406
|
-
|
|
407
|
-
Search for published product variants by name. Returns a hierarchical product > variants structure.
|
|
408
|
-
|
|
409
|
-
- **Permission:** `products/view`
|
|
410
|
-
|
|
411
|
-
#### Parameters
|
|
412
|
-
|
|
413
|
-
| Parameter | Type | Location | Required | Description |
|
|
414
|
-
| --- | --- | --- | --- | --- |
|
|
415
|
-
| `name` | string | query | No | Product/variant name to search |
|
|
416
|
-
| `search` | string | query | No | Alternative search parameter (used if `name` is empty) |
|
|
417
|
-
| `ids` | array | query | No | Array of product IDs to include |
|
|
418
|
-
|
|
419
|
-
#### Response
|
|
420
|
-
|
|
421
|
-
```
|
|
422
|
-
[
|
|
423
|
-
{
|
|
424
|
-
"value": 123,
|
|
425
|
-
"label": "Example Product",
|
|
426
|
-
"children": [
|
|
427
|
-
{
|
|
428
|
-
"value": 456,
|
|
429
|
-
"label": "Monthly Plan"
|
|
430
|
-
},
|
|
431
|
-
{
|
|
432
|
-
"value": 457,
|
|
433
|
-
"label": "Yearly Plan"
|
|
434
|
-
}
|
|
435
|
-
]
|
|
436
|
-
}
|
|
437
|
-
]
|
|
438
|
-
```
|
|
439
|
-
|
|
440
|
-
#### Example
|
|
441
|
-
|
|
442
|
-
```
|
|
443
|
-
curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/searchVariantByName?name=pro" \
|
|
444
|
-
-u "username:app_password"
|
|
445
|
-
```
|
|
446
|
-
|
|
447
|
-
---
|
|
448
|
-
|
|
449
|
-
### Search Product Variant Options
|
|
450
|
-
|
|
451
|
-
GET `/fluent-cart/v2/products/search-product-variant-options`
|
|
452
|
-
|
|
453
|
-
Search for product variants suitable for selection (e.g., in order creation). Filters out out-of-stock items.
|
|
454
|
-
|
|
455
|
-
- **Permission:** `products/view`
|
|
456
|
-
|
|
457
|
-
#### Parameters
|
|
458
|
-
|
|
459
|
-
| Parameter | Type | Location | Required | Description |
|
|
460
|
-
| --- | --- | --- | --- | --- |
|
|
461
|
-
| `search` | string | query | No | Search term for product/variant title |
|
|
462
|
-
| `include_ids` | array | query | No | Variation IDs to always include in results |
|
|
463
|
-
| `scopes` | array | query | No | Model scopes to apply |
|
|
464
|
-
| `subscription_status` | string | query | No | `not_subscribable` to exclude subscription variants |
|
|
465
|
-
|
|
466
|
-
#### Response
|
|
467
|
-
|
|
468
|
-
```
|
|
469
|
-
{
|
|
470
|
-
"products": [
|
|
471
|
-
{
|
|
472
|
-
"value": "product_123",
|
|
473
|
-
"label": "Example Product",
|
|
474
|
-
"children": [
|
|
475
|
-
{
|
|
476
|
-
"value": 456,
|
|
477
|
-
"label": "Monthly Plan"
|
|
478
|
-
}
|
|
479
|
-
]
|
|
480
|
-
}
|
|
481
|
-
]
|
|
482
|
-
}
|
|
483
|
-
```
|
|
484
|
-
|
|
485
|
-
#### Example
|
|
486
|
-
|
|
487
|
-
```
|
|
488
|
-
curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/search-product-variant-options?search=pro&subscription_status=not_subscribable" \
|
|
489
|
-
-u "username:app_password"
|
|
490
|
-
```
|
|
491
|
-
|
|
492
|
-
---
|
|
493
|
-
|
|
494
|
-
### Find Subscription Variants
|
|
495
|
-
|
|
496
|
-
GET `/fluent-cart/v2/products/findSubscriptionVariants`
|
|
497
|
-
|
|
498
|
-
Search for product variants that have a subscription payment type.
|
|
499
|
-
|
|
500
|
-
- **Permission:** `products/view`
|
|
501
|
-
|
|
502
|
-
#### Parameters
|
|
503
|
-
|
|
504
|
-
| Parameter | Type | Location | Required | Description |
|
|
505
|
-
| --- | --- | --- | --- | --- |
|
|
506
|
-
| `name` | string | query | No | Variant title to search |
|
|
507
|
-
|
|
508
|
-
#### Response
|
|
509
|
-
|
|
510
|
-
```
|
|
511
|
-
[
|
|
512
|
-
{
|
|
513
|
-
"id": 456,
|
|
514
|
-
"title": "Monthly Subscription"
|
|
515
|
-
},
|
|
516
|
-
{
|
|
517
|
-
"id": 457,
|
|
518
|
-
"title": "Yearly Subscription"
|
|
519
|
-
}
|
|
520
|
-
]
|
|
521
|
-
```
|
|
522
|
-
|
|
523
|
-
#### Example
|
|
524
|
-
|
|
525
|
-
```
|
|
526
|
-
curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/findSubscriptionVariants?name=monthly" \
|
|
527
|
-
-u "username:app_password"
|
|
528
|
-
```
|
|
529
|
-
|
|
530
|
-
---
|
|
531
|
-
|
|
532
|
-
### Fetch Products by IDs
|
|
533
|
-
|
|
534
|
-
GET `/fluent-cart/v2/products/fetchProductsByIds`
|
|
535
|
-
|
|
536
|
-
Retrieve products by an array of IDs. Returns products with their detail relation.
|
|
537
|
-
|
|
538
|
-
- **Permission:** `products/view`
|
|
539
|
-
|
|
540
|
-
#### Parameters
|
|
541
|
-
|
|
542
|
-
| Parameter | Type | Location | Required | Description |
|
|
543
|
-
| --- | --- | --- | --- | --- |
|
|
544
|
-
| `productIds` | array | query | Yes | Array of product IDs to fetch |
|
|
545
|
-
|
|
546
|
-
#### Response
|
|
547
|
-
|
|
548
|
-
```
|
|
549
|
-
{
|
|
550
|
-
"products": [
|
|
551
|
-
{
|
|
552
|
-
"ID": 123,
|
|
553
|
-
"post_title": "Example Product",
|
|
554
|
-
"detail": { ... }
|
|
555
|
-
}
|
|
556
|
-
]
|
|
557
|
-
}
|
|
558
|
-
```
|
|
559
|
-
|
|
560
|
-
#### Example
|
|
561
|
-
|
|
562
|
-
```
|
|
563
|
-
curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/fetchProductsByIds?productIds[]=123&productIds[]=456" \
|
|
564
|
-
-u "username:app_password"
|
|
565
|
-
```
|
|
566
|
-
|
|
567
|
-
---
|
|
568
|
-
|
|
569
|
-
### Fetch Variations by IDs
|
|
570
|
-
|
|
571
|
-
GET `/fluent-cart/v2/products/fetchVariationsByIds`
|
|
572
|
-
|
|
573
|
-
Retrieve variations by an array of IDs. Returns simplified label/value pairs.
|
|
574
|
-
|
|
575
|
-
- **Permission:** `products/view`
|
|
576
|
-
|
|
577
|
-
#### Parameters
|
|
578
|
-
|
|
579
|
-
| Parameter | Type | Location | Required | Description |
|
|
580
|
-
| --- | --- | --- | --- | --- |
|
|
581
|
-
| `productIds` | array | query | Yes | Array of variation IDs to fetch |
|
|
582
|
-
|
|
583
|
-
#### Response
|
|
584
|
-
|
|
585
|
-
```
|
|
586
|
-
{
|
|
587
|
-
"products": [
|
|
588
|
-
{
|
|
589
|
-
"value": 456,
|
|
590
|
-
"label": "Monthly Plan"
|
|
591
|
-
},
|
|
592
|
-
{
|
|
593
|
-
"value": 457,
|
|
594
|
-
"label": "Yearly Plan"
|
|
595
|
-
}
|
|
596
|
-
]
|
|
597
|
-
}
|
|
598
|
-
```
|
|
599
|
-
|
|
600
|
-
#### Example
|
|
601
|
-
|
|
602
|
-
```
|
|
603
|
-
curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/fetchVariationsByIds?productIds[]=456&productIds[]=457" \
|
|
604
|
-
-u "username:app_password"
|
|
605
|
-
```
|
|
606
|
-
|
|
607
|
-
---
|
|
608
|
-
|
|
609
|
-
### Suggest SKU
|
|
610
|
-
|
|
611
|
-
GET `/fluent-cart/v2/products/suggest-sku`
|
|
612
|
-
|
|
613
|
-
Generate a unique SKU suggestion based on product and variant titles.
|
|
614
|
-
|
|
615
|
-
- **Permission:** `products/view`
|
|
616
|
-
|
|
617
|
-
#### Parameters
|
|
618
|
-
|
|
619
|
-
| Parameter | Type | Location | Required | Description |
|
|
620
|
-
| --- | --- | --- | --- | --- |
|
|
621
|
-
| `title` | string | query | Yes | Product title to base SKU on |
|
|
622
|
-
| `variant_title` | string | query | No | Variant title to include in SKU |
|
|
623
|
-
| `exclude_id` | integer | query | No | Variation ID to exclude from uniqueness check |
|
|
624
|
-
|
|
625
|
-
#### Response
|
|
626
|
-
|
|
627
|
-
```
|
|
628
|
-
{
|
|
629
|
-
"sku": "EXA-PRO-MON"
|
|
630
|
-
}
|
|
631
|
-
```
|
|
632
|
-
|
|
633
|
-
#### Example
|
|
634
|
-
|
|
635
|
-
```
|
|
636
|
-
curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/suggest-sku?title=Example%20Product&variant_title=Monthly" \
|
|
637
|
-
-u "username:app_password"
|
|
638
|
-
```
|
|
639
|
-
|
|
640
|
-
---
|
|
641
|
-
|
|
642
|
-
### Get Max Excerpt Word Count
|
|
643
|
-
|
|
644
|
-
GET `/fluent-cart/v2/products/get-max-excerpt-word-count`
|
|
645
|
-
|
|
646
|
-
Returns the maximum allowed word count for product excerpts (controlled by the WordPress `excerpt_length` filter).
|
|
647
|
-
|
|
648
|
-
- **Permission:** `products/view`
|
|
649
|
-
|
|
650
|
-
#### Parameters
|
|
651
|
-
|
|
652
|
-
None.
|
|
653
|
-
|
|
654
|
-
#### Response
|
|
655
|
-
|
|
656
|
-
```
|
|
657
|
-
{
|
|
658
|
-
"count": 55
|
|
659
|
-
}
|
|
660
|
-
```
|
|
661
|
-
|
|
662
|
-
#### Example
|
|
663
|
-
|
|
664
|
-
```
|
|
665
|
-
curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/get-max-excerpt-word-count" \
|
|
666
|
-
-u "username:app_password"
|
|
667
|
-
```
|
|
668
|
-
|
|
669
|
-
---
|
|
670
|
-
|
|
671
|
-
### Fetch Taxonomy Terms
|
|
672
|
-
|
|
673
|
-
GET `/fluent-cart/v2/products/fetch-term`
|
|
674
|
-
|
|
675
|
-
Retrieve all registered taxonomies and their terms for product categorization.
|
|
676
|
-
|
|
677
|
-
- **Permission:** `products/view`
|
|
678
|
-
|
|
679
|
-
#### Parameters
|
|
680
|
-
|
|
681
|
-
None.
|
|
682
|
-
|
|
683
|
-
#### Response
|
|
684
|
-
|
|
685
|
-
```
|
|
686
|
-
{
|
|
687
|
-
"taxonomies": [
|
|
688
|
-
{
|
|
689
|
-
"name": "product-categories",
|
|
690
|
-
"label": "Product Categories",
|
|
691
|
-
"terms": [
|
|
692
|
-
{
|
|
693
|
-
"value": 1,
|
|
694
|
-
"label": "Software",
|
|
695
|
-
"children": []
|
|
696
|
-
}
|
|
697
|
-
]
|
|
698
|
-
},
|
|
699
|
-
{
|
|
700
|
-
"name": "product-brands",
|
|
701
|
-
"label": "Product Brands",
|
|
702
|
-
"terms": []
|
|
703
|
-
}
|
|
704
|
-
]
|
|
705
|
-
}
|
|
706
|
-
```
|
|
707
|
-
|
|
708
|
-
#### Example
|
|
709
|
-
|
|
710
|
-
```
|
|
711
|
-
curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/fetch-term" \
|
|
712
|
-
-u "username:app_password"
|
|
713
|
-
```
|
|
714
|
-
|
|
715
|
-
---
|
|
716
|
-
|
|
717
|
-
### Fetch Terms by Parent
|
|
718
|
-
|
|
719
|
-
POST `/fluent-cart/v2/products/fetch-term-by-parent`
|
|
720
|
-
|
|
721
|
-
Retrieve taxonomy terms filtered by parent term IDs.
|
|
722
|
-
|
|
723
|
-
- **Permission:** `products/view`
|
|
724
|
-
|
|
725
|
-
#### Parameters
|
|
726
|
-
|
|
727
|
-
| Parameter | Type | Location | Required | Description |
|
|
728
|
-
| --- | --- | --- | --- | --- |
|
|
729
|
-
| `parents` | array | body | Yes | Array of parent term IDs |
|
|
730
|
-
| `listeners` | array | body | Yes | Array of taxonomy names to retrieve terms for |
|
|
731
|
-
|
|
732
|
-
#### Response
|
|
733
|
-
|
|
734
|
-
```
|
|
735
|
-
{
|
|
736
|
-
"data": {
|
|
737
|
-
"product-categories": [
|
|
738
|
-
{
|
|
739
|
-
"value": 5,
|
|
740
|
-
"label": "Sub Category"
|
|
741
|
-
}
|
|
742
|
-
]
|
|
743
|
-
}
|
|
744
|
-
}
|
|
745
|
-
```
|
|
746
|
-
|
|
747
|
-
#### Example
|
|
748
|
-
|
|
749
|
-
```
|
|
750
|
-
curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/fetch-term-by-parent" \
|
|
751
|
-
-u "username:app_password" \
|
|
752
|
-
-H "Content-Type: application/json" \
|
|
753
|
-
-d '{
|
|
754
|
-
"parents": [1, 2],
|
|
755
|
-
"listeners": ["product-categories"]
|
|
756
|
-
}'
|
|
757
|
-
```
|
|
758
|
-
|
|
759
|
-
---
|
|
760
|
-
|
|
761
|
-
## Bulk Operations
|
|
762
|
-
|
|
763
|
-
### Bulk Insert Products
|
|
764
|
-
|
|
765
|
-
POST `/fluent-cart/v2/products/bulk-insert`
|
|
766
|
-
|
|
767
|
-
Insert multiple products at once. Maximum 10 products per request.
|
|
768
|
-
|
|
769
|
-
- **Permission:** `products/create`
|
|
770
|
-
|
|
771
|
-
#### Parameters
|
|
772
|
-
|
|
773
|
-
| Parameter | Type | Location | Required | Description |
|
|
774
|
-
| --- | --- | --- | --- | --- |
|
|
775
|
-
| `products` | array | body | Yes | Array of product data objects (max 10) |
|
|
776
|
-
|
|
777
|
-
#### Response
|
|
778
|
-
|
|
779
|
-
```
|
|
780
|
-
{
|
|
781
|
-
"message": "3 product(s) created successfully",
|
|
782
|
-
"created": [ ... ],
|
|
783
|
-
"errors": []
|
|
784
|
-
}
|
|
785
|
-
```
|
|
786
|
-
|
|
787
|
-
#### Example
|
|
788
|
-
|
|
789
|
-
```
|
|
790
|
-
curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/bulk-insert" \
|
|
791
|
-
-u "username:app_password" \
|
|
792
|
-
-H "Content-Type: application/json" \
|
|
793
|
-
-d '{
|
|
794
|
-
"products": [
|
|
795
|
-
{
|
|
796
|
-
"post_title": "Product A",
|
|
797
|
-
"detail": { "fulfillment_type": "digital" }
|
|
798
|
-
},
|
|
799
|
-
{
|
|
800
|
-
"post_title": "Product B",
|
|
801
|
-
"detail": { "fulfillment_type": "physical" }
|
|
802
|
-
}
|
|
803
|
-
]
|
|
804
|
-
}'
|
|
805
|
-
```
|
|
806
|
-
|
|
807
|
-
---
|
|
808
|
-
|
|
809
|
-
### Bulk Edit Fetch
|
|
810
|
-
|
|
811
|
-
GET `/fluent-cart/v2/products/bulk-edit-data`
|
|
812
|
-
|
|
813
|
-
Fetch products formatted for the bulk editing spreadsheet view.
|
|
814
|
-
|
|
815
|
-
- **Permission:** `products/edit`
|
|
816
|
-
|
|
817
|
-
#### Parameters
|
|
818
|
-
|
|
819
|
-
Standard filter parameters (see [List Products](#list-products)).
|
|
820
|
-
|
|
821
|
-
#### Response
|
|
822
|
-
|
|
823
|
-
```
|
|
824
|
-
{
|
|
825
|
-
"products": [ ... ],
|
|
826
|
-
"columns": [ ... ]
|
|
827
|
-
}
|
|
828
|
-
```
|
|
829
|
-
|
|
830
|
-
#### Example
|
|
831
|
-
|
|
832
|
-
```
|
|
833
|
-
curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/bulk-edit-data" \
|
|
834
|
-
-u "username:app_password"
|
|
835
|
-
```
|
|
836
|
-
|
|
837
|
-
---
|
|
838
|
-
|
|
839
|
-
### Bulk Update Products
|
|
840
|
-
|
|
841
|
-
POST `/fluent-cart/v2/products/bulk-update`
|
|
842
|
-
|
|
843
|
-
Update multiple products at once from the bulk edit view. Maximum 10 products per request.
|
|
844
|
-
|
|
845
|
-
- **Permission:** `products/edit`
|
|
846
|
-
|
|
847
|
-
#### Parameters
|
|
848
|
-
|
|
849
|
-
| Parameter | Type | Location | Required | Description |
|
|
850
|
-
| --- | --- | --- | --- | --- |
|
|
851
|
-
| `products` | array | body | Yes | Array of product data objects to update (max 10) |
|
|
852
|
-
|
|
853
|
-
#### Response
|
|
854
|
-
|
|
855
|
-
```
|
|
856
|
-
{
|
|
857
|
-
"message": "3 product(s) updated successfully",
|
|
858
|
-
"updated": [ ... ],
|
|
859
|
-
"errors": []
|
|
860
|
-
}
|
|
861
|
-
```
|
|
862
|
-
|
|
863
|
-
#### Example
|
|
864
|
-
|
|
865
|
-
```
|
|
866
|
-
curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/bulk-update" \
|
|
867
|
-
-u "username:app_password" \
|
|
868
|
-
-H "Content-Type: application/json" \
|
|
869
|
-
-d '{
|
|
870
|
-
"products": [
|
|
871
|
-
{
|
|
872
|
-
"ID": 123,
|
|
873
|
-
"post_title": "Updated Title A"
|
|
874
|
-
}
|
|
875
|
-
]
|
|
876
|
-
}'
|
|
877
|
-
```
|
|
878
|
-
|
|
879
|
-
---
|
|
880
|
-
|
|
881
|
-
### Do Bulk Action
|
|
882
|
-
|
|
883
|
-
POST `/fluent-cart/v2/products/do-bulk-action`
|
|
884
|
-
|
|
885
|
-
Perform bulk actions on selected products (e.g., publish, draft, delete).
|
|
886
|
-
|
|
887
|
-
- **Permission:** `products/edit`
|
|
888
|
-
|
|
889
|
-
#### Parameters
|
|
890
|
-
|
|
891
|
-
| Parameter | Type | Location | Required | Description |
|
|
892
|
-
| --- | --- | --- | --- | --- |
|
|
893
|
-
| `action` | string | body | Yes | The bulk action to perform |
|
|
894
|
-
| `product_ids` | array | body | Yes | Array of product IDs to act on |
|
|
895
|
-
|
|
896
|
-
#### Response
|
|
897
|
-
|
|
898
|
-
```
|
|
899
|
-
{
|
|
900
|
-
"message": "Bulk action completed successfully"
|
|
901
|
-
}
|
|
902
|
-
```
|
|
903
|
-
|
|
904
|
-
#### Example
|
|
905
|
-
|
|
906
|
-
```
|
|
907
|
-
curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/do-bulk-action" \
|
|
908
|
-
-u "username:app_password" \
|
|
909
|
-
-H "Content-Type: application/json" \
|
|
910
|
-
-d '{
|
|
911
|
-
"action": "publish",
|
|
912
|
-
"product_ids": [123, 456, 789]
|
|
913
|
-
}'
|
|
914
|
-
```
|
|
915
|
-
|
|
916
|
-
---
|
|
917
|
-
|
|
918
|
-
### Create Dummy Products
|
|
919
|
-
|
|
920
|
-
POST `/fluent-cart/v2/products/create-dummy`
|
|
921
|
-
|
|
922
|
-
Create sample/demo products for testing or onboarding purposes.
|
|
923
|
-
|
|
924
|
-
- **Permission:** `products/create`
|
|
925
|
-
|
|
926
|
-
#### Parameters
|
|
927
|
-
|
|
928
|
-
| Parameter | Type | Location | Required | Description |
|
|
929
|
-
| --- | --- | --- | --- | --- |
|
|
930
|
-
| `category` | string | body | No | Product category for dummy products |
|
|
931
|
-
| `index` | integer | body | No | Index for dummy product generation |
|
|
932
|
-
|
|
933
|
-
#### Response
|
|
934
|
-
|
|
935
|
-
Returns the created dummy product data.
|
|
936
|
-
|
|
937
|
-
#### Example
|
|
938
|
-
|
|
939
|
-
```
|
|
940
|
-
curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/create-dummy" \
|
|
941
|
-
-u "username:app_password" \
|
|
942
|
-
-H "Content-Type: application/json" \
|
|
943
|
-
-d '{
|
|
944
|
-
"category": "digital",
|
|
945
|
-
"index": 1
|
|
946
|
-
}'
|
|
947
|
-
```
|
|
948
|
-
|
|
949
|
-
---
|
|
950
|
-
|
|
951
|
-
## Product Details & Configuration
|
|
952
|
-
|
|
953
|
-
### Duplicate Product
|
|
954
|
-
|
|
955
|
-
POST `/fluent-cart/v2/products/{productId}/duplicate`
|
|
956
|
-
|
|
957
|
-
Duplicate a product with options to include or exclude certain settings. The new product is saved as a draft.
|
|
958
|
-
|
|
959
|
-
- **Permission:** `products/create`
|
|
960
|
-
|
|
961
|
-
#### Parameters
|
|
962
|
-
|
|
963
|
-
| Parameter | Type | Location | Required | Description |
|
|
964
|
-
| --- | --- | --- | --- | --- |
|
|
965
|
-
| `productId` | integer | path | Yes | The product ID to duplicate |
|
|
966
|
-
| `import_stock_management` | string | body | No | Include stock management settings (`true`/`false`) |
|
|
967
|
-
| `import_license_settings` | string | body | No | Include license settings (`true`/`false`) |
|
|
968
|
-
| `import_downloadable_files` | string | body | No | Include downloadable files (`true`/`false`) |
|
|
969
|
-
|
|
970
|
-
#### Response
|
|
971
|
-
|
|
972
|
-
```
|
|
973
|
-
{
|
|
974
|
-
"product_id": 125,
|
|
975
|
-
"message": "Product duplicated successfully. The new product has been saved as a draft."
|
|
976
|
-
}
|
|
977
|
-
```
|
|
978
|
-
|
|
979
|
-
#### Example
|
|
980
|
-
|
|
981
|
-
```
|
|
982
|
-
curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/123/duplicate" \
|
|
983
|
-
-u "username:app_password" \
|
|
984
|
-
-H "Content-Type: application/json" \
|
|
985
|
-
-d '{
|
|
986
|
-
"import_stock_management": "true",
|
|
987
|
-
"import_license_settings": "true",
|
|
988
|
-
"import_downloadable_files": "false"
|
|
989
|
-
}'
|
|
990
|
-
```
|
|
991
|
-
|
|
992
|
-
---
|
|
993
|
-
|
|
994
|
-
### Get Related Products
|
|
995
|
-
|
|
996
|
-
GET `/fluent-cart/v2/products/{productId}/related-products`
|
|
997
|
-
|
|
998
|
-
Retrieve products related to a given product based on shared categories or brands.
|
|
999
|
-
|
|
1000
|
-
- **Permission:** `products/view`
|
|
1001
|
-
|
|
1002
|
-
#### Parameters
|
|
1003
|
-
|
|
1004
|
-
| Parameter | Type | Location | Required | Description |
|
|
1005
|
-
| --- | --- | --- | --- | --- |
|
|
1006
|
-
| `productId` | integer | path | Yes | The product ID |
|
|
1007
|
-
| `related_by_categories` | boolean | query | No | Include products from same categories |
|
|
1008
|
-
| `related_by_brands` | boolean | query | No | Include products from same brands |
|
|
1009
|
-
| `order_by` | string | query | No | Sort order (default: `title_asc`) |
|
|
1010
|
-
| `posts_per_page` | integer | query | No | Number of related products to return (default: `6`) |
|
|
1011
|
-
|
|
1012
|
-
#### Response
|
|
1013
|
-
|
|
1014
|
-
```
|
|
1015
|
-
{
|
|
1016
|
-
"products": [
|
|
1017
|
-
{
|
|
1018
|
-
"ID": 456,
|
|
1019
|
-
"post_title": "Related Product",
|
|
1020
|
-
"post_status": "publish"
|
|
1021
|
-
}
|
|
1022
|
-
]
|
|
1023
|
-
}
|
|
1024
|
-
```
|
|
1025
|
-
|
|
1026
|
-
#### Example
|
|
1027
|
-
|
|
1028
|
-
```
|
|
1029
|
-
curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/123/related-products?related_by_categories=true&posts_per_page=4" \
|
|
1030
|
-
-u "username:app_password"
|
|
1031
|
-
```
|
|
1032
|
-
|
|
1033
|
-
---
|
|
1034
|
-
|
|
1035
|
-
### Update Long Description Editor Mode
|
|
1036
|
-
|
|
1037
|
-
POST `/fluent-cart/v2/products/{postId}/update-long-desc-editor-mode`
|
|
1038
|
-
|
|
1039
|
-
Switch the long description editor between modes (e.g., visual, code).
|
|
1040
|
-
|
|
1041
|
-
- **Permission:** `products/edit`
|
|
1042
|
-
|
|
1043
|
-
#### Parameters
|
|
1044
|
-
|
|
1045
|
-
| Parameter | Type | Location | Required | Description |
|
|
1046
|
-
| --- | --- | --- | --- | --- |
|
|
1047
|
-
| `postId` | integer | path | Yes | The product post ID |
|
|
1048
|
-
| `active_editor` | string | body | Yes | The editor mode to set |
|
|
1049
|
-
|
|
1050
|
-
#### Response
|
|
1051
|
-
|
|
1052
|
-
```
|
|
1053
|
-
{
|
|
1054
|
-
"message": "Editor mode updated successfully"
|
|
1055
|
-
}
|
|
1056
|
-
```
|
|
1057
|
-
|
|
1058
|
-
#### Example
|
|
1059
|
-
|
|
1060
|
-
```
|
|
1061
|
-
curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/123/update-long-desc-editor-mode" \
|
|
1062
|
-
-u "username:app_password" \
|
|
1063
|
-
-H "Content-Type: application/json" \
|
|
1064
|
-
-d '{"active_editor": "visual"}'
|
|
1065
|
-
```
|
|
1066
|
-
|
|
1067
|
-
---
|
|
1068
|
-
|
|
1069
|
-
### Update Variant Option
|
|
1070
|
-
|
|
1071
|
-
POST `/fluent-cart/v2/products/{postId}/update-variant-option`
|
|
1072
|
-
|
|
1073
|
-
Sync variant options for a product (used when managing product attribute variations).
|
|
1074
|
-
|
|
1075
|
-
- **Permission:** `products/edit`
|
|
1076
|
-
|
|
1077
|
-
#### Parameters
|
|
1078
|
-
|
|
1079
|
-
| Parameter | Type | Location | Required | Description |
|
|
1080
|
-
| --- | --- | --- | --- | --- |
|
|
1081
|
-
| `postId` | integer | path | Yes | The product post ID |
|
|
1082
|
-
| `variation_type` | string | body | Yes | The variation type |
|
|
1083
|
-
| `product_id` | integer | body | Yes | The product ID |
|
|
1084
|
-
| `options` | array | body | Yes | Array of option objects with `id` and `variants` |
|
|
1085
|
-
|
|
1086
|
-
#### Response
|
|
1087
|
-
|
|
1088
|
-
```
|
|
1089
|
-
{
|
|
1090
|
-
"message": "Variant options synced successfully"
|
|
1091
|
-
}
|
|
1092
|
-
```
|
|
1093
|
-
|
|
1094
|
-
#### Example
|
|
1095
|
-
|
|
1096
|
-
```
|
|
1097
|
-
curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/123/update-variant-option" \
|
|
1098
|
-
-u "username:app_password" \
|
|
1099
|
-
-H "Content-Type: application/json" \
|
|
1100
|
-
-d '{
|
|
1101
|
-
"variation_type": "simple_variations",
|
|
1102
|
-
"product_id": 123,
|
|
1103
|
-
"options": []
|
|
1104
|
-
}'
|
|
1105
|
-
```
|
|
1106
|
-
|
|
1107
|
-
---
|
|
1108
|
-
|
|
1109
|
-
### Update Product Detail
|
|
1110
|
-
|
|
1111
|
-
POST `/fluent-cart/v2/products/detail/{detailId}`
|
|
1112
|
-
|
|
1113
|
-
Update a product detail record (e.g., change variation type).
|
|
1114
|
-
|
|
1115
|
-
- **Permission:** `products/edit`
|
|
1116
|
-
|
|
1117
|
-
#### Parameters
|
|
1118
|
-
|
|
1119
|
-
| Parameter | Type | Location | Required | Description |
|
|
1120
|
-
| --- | --- | --- | --- | --- |
|
|
1121
|
-
| `detailId` | integer | path | Yes | The product detail ID |
|
|
1122
|
-
| `variation_type` | string | body | No | New variation type (e.g., `simple`, `simple_variations`) |
|
|
1123
|
-
| `variation_ids` | array | body | No | Array of variation IDs |
|
|
1124
|
-
| `action` | string | body | No | Action to perform (default: `change_variation_type`) |
|
|
1125
|
-
|
|
1126
|
-
#### Response
|
|
1127
|
-
|
|
1128
|
-
```
|
|
1129
|
-
{
|
|
1130
|
-
"message": "Product detail updated successfully"
|
|
1131
|
-
}
|
|
1132
|
-
```
|
|
1133
|
-
|
|
1134
|
-
#### Example
|
|
1135
|
-
|
|
1136
|
-
```
|
|
1137
|
-
curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/detail/456" \
|
|
1138
|
-
-u "username:app_password" \
|
|
1139
|
-
-H "Content-Type: application/json" \
|
|
1140
|
-
-d '{
|
|
1141
|
-
"variation_type": "simple_variations",
|
|
1142
|
-
"action": "change_variation_type"
|
|
1143
|
-
}'
|
|
1144
|
-
```
|
|
1145
|
-
|
|
1146
|
-
---
|
|
1147
|
-
|
|
1148
|
-
### Add Product Terms
|
|
1149
|
-
|
|
1150
|
-
POST `/fluent-cart/v2/products/add-product-terms`
|
|
1151
|
-
|
|
1152
|
-
Create new taxonomy terms for products (categories, brands, etc.).
|
|
1153
|
-
|
|
1154
|
-
- **Permission:** `products/edit`
|
|
1155
|
-
|
|
1156
|
-
#### Parameters
|
|
1157
|
-
|
|
1158
|
-
| Parameter | Type | Location | Required | Description |
|
|
1159
|
-
| --- | --- | --- | --- | --- |
|
|
1160
|
-
| `term.name` | string | body | Yes | Term name(s), comma-separated for multiple |
|
|
1161
|
-
| `term.taxonomy` | string | body | Yes | Taxonomy name (e.g., `product-categories`, `product-brands`) |
|
|
1162
|
-
| `term.parent` | integer | body | No | Parent term ID for hierarchical terms |
|
|
1163
|
-
|
|
1164
|
-
#### Response
|
|
1165
|
-
|
|
1166
|
-
```
|
|
1167
|
-
{
|
|
1168
|
-
"term_ids": [10, 11],
|
|
1169
|
-
"names": ["Category A", "Category B"]
|
|
1170
|
-
}
|
|
1171
|
-
```
|
|
1172
|
-
|
|
1173
|
-
#### Example
|
|
1174
|
-
|
|
1175
|
-
```
|
|
1176
|
-
curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/add-product-terms" \
|
|
1177
|
-
-u "username:app_password" \
|
|
1178
|
-
-H "Content-Type: application/json" \
|
|
1179
|
-
-d '{
|
|
1180
|
-
"term": {
|
|
1181
|
-
"name": "New Category,Another Category",
|
|
1182
|
-
"taxonomy": "product-categories",
|
|
1183
|
-
"parent": 0
|
|
1184
|
-
}
|
|
1185
|
-
}'
|
|
1186
|
-
```
|
|
1187
|
-
|
|
1188
|
-
---
|
|
1189
|
-
|
|
1190
|
-
### Sync Taxonomy Terms
|
|
1191
|
-
|
|
1192
|
-
POST `/fluent-cart/v2/products/sync-taxonomy-term/{postId}`
|
|
1193
|
-
|
|
1194
|
-
Sync (replace) taxonomy terms for a product.
|
|
1195
|
-
|
|
1196
|
-
- **Permission:** `products/edit`
|
|
1197
|
-
|
|
1198
|
-
#### Parameters
|
|
1199
|
-
|
|
1200
|
-
| Parameter | Type | Location | Required | Description |
|
|
1201
|
-
| --- | --- | --- | --- | --- |
|
|
1202
|
-
| `postId` | integer | path | Yes | The product post ID |
|
|
1203
|
-
| `taxonomy` | string | body | Yes | Taxonomy name (e.g., `product-categories`) |
|
|
1204
|
-
| `terms` | array | body | No | Array of term IDs to sync |
|
|
1205
|
-
|
|
1206
|
-
#### Response
|
|
1207
|
-
|
|
1208
|
-
```
|
|
1209
|
-
{
|
|
1210
|
-
"message": "Taxonomy terms synced successfully"
|
|
1211
|
-
}
|
|
1212
|
-
```
|
|
1213
|
-
|
|
1214
|
-
#### Example
|
|
1215
|
-
|
|
1216
|
-
```
|
|
1217
|
-
curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/sync-taxonomy-term/123" \
|
|
1218
|
-
-u "username:app_password" \
|
|
1219
|
-
-H "Content-Type: application/json" \
|
|
1220
|
-
-d '{
|
|
1221
|
-
"taxonomy": "product-categories",
|
|
1222
|
-
"terms": [1, 5, 10]
|
|
1223
|
-
}'
|
|
1224
|
-
```
|
|
1225
|
-
|
|
1226
|
-
---
|
|
1227
|
-
|
|
1228
|
-
### Delete Taxonomy Term
|
|
1229
|
-
|
|
1230
|
-
POST `/fluent-cart/v2/products/delete-taxonomy-term/{postId}`
|
|
1231
|
-
|
|
1232
|
-
Remove a specific taxonomy term from a product.
|
|
1233
|
-
|
|
1234
|
-
- **Permission:** `products/edit`
|
|
1235
|
-
|
|
1236
|
-
#### Parameters
|
|
1237
|
-
|
|
1238
|
-
| Parameter | Type | Location | Required | Description |
|
|
1239
|
-
| --- | --- | --- | --- | --- |
|
|
1240
|
-
| `postId` | integer | path | Yes | The product post ID |
|
|
1241
|
-
| `taxonomy` | string | body | Yes | Taxonomy name (e.g., `product-categories`) |
|
|
1242
|
-
| `term` | integer | body | Yes | Term ID to remove |
|
|
1243
|
-
|
|
1244
|
-
#### Response
|
|
1245
|
-
|
|
1246
|
-
```
|
|
1247
|
-
{
|
|
1248
|
-
"message": "Taxonomy term removed successfully"
|
|
1249
|
-
}
|
|
1250
|
-
```
|
|
1251
|
-
|
|
1252
|
-
#### Example
|
|
1253
|
-
|
|
1254
|
-
```
|
|
1255
|
-
curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/delete-taxonomy-term/123" \
|
|
1256
|
-
-u "username:app_password" \
|
|
1257
|
-
-H "Content-Type: application/json" \
|
|
1258
|
-
-d '{
|
|
1259
|
-
"taxonomy": "product-categories",
|
|
1260
|
-
"term": 5
|
|
1261
|
-
}'
|
|
1262
|
-
```
|
|
1263
|
-
|
|
1264
|
-
---
|
|
1265
|
-
|
|
1266
|
-
### Get Pricing Widgets
|
|
1267
|
-
|
|
1268
|
-
GET `/fluent-cart/v2/products/{productId}/pricing-widgets`
|
|
1269
|
-
|
|
1270
|
-
Retrieve sales overview widgets for a product (all-time, last 30 days, this month).
|
|
1271
|
-
|
|
1272
|
-
- **Permission:** `products/view`
|
|
1273
|
-
|
|
1274
|
-
#### Parameters
|
|
1275
|
-
|
|
1276
|
-
| Parameter | Type | Location | Required | Description |
|
|
1277
|
-
| --- | --- | --- | --- | --- |
|
|
1278
|
-
| `productId` | integer | path | Yes | The product ID |
|
|
1279
|
-
|
|
1280
|
-
#### Response
|
|
1281
|
-
|
|
1282
|
-
```
|
|
1283
|
-
{
|
|
1284
|
-
"widgets": [
|
|
1285
|
-
{
|
|
1286
|
-
"title": "Quick Sales Overview",
|
|
1287
|
-
"body": "<ul class=\"fct-lists\"><li><span>All time (5)</span><span>$50.00</span></li>...</ul>"
|
|
1288
|
-
}
|
|
1289
|
-
]
|
|
1290
|
-
}
|
|
1291
|
-
```
|
|
1292
|
-
|
|
1293
|
-
#### Example
|
|
1294
|
-
|
|
1295
|
-
```
|
|
1296
|
-
curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/123/pricing-widgets" \
|
|
1297
|
-
-u "username:app_password"
|
|
1298
|
-
```
|
|
1299
|
-
|
|
1300
|
-
---
|
|
1301
|
-
|
|
1302
|
-
## Bundle Products
|
|
1303
|
-
|
|
1304
|
-
### Get Bundle Info
|
|
1305
|
-
|
|
1306
|
-
GET `/fluent-cart/v2/products/get-bundle-info/{productId}`
|
|
1307
|
-
|
|
1308
|
-
Retrieve bundle configuration information for a product, including child variant mappings.
|
|
1309
|
-
|
|
1310
|
-
- **Permission:** `products/view`
|
|
1311
|
-
|
|
1312
|
-
#### Parameters
|
|
1313
|
-
|
|
1314
|
-
| Parameter | Type | Location | Required | Description |
|
|
1315
|
-
| --- | --- | --- | --- | --- |
|
|
1316
|
-
| `productId` | integer | path | Yes | The product ID |
|
|
1317
|
-
|
|
1318
|
-
#### Response
|
|
1319
|
-
|
|
1320
|
-
```
|
|
1321
|
-
[
|
|
1322
|
-
{
|
|
1323
|
-
"id": 789,
|
|
1324
|
-
"variation_title": "Bundle Plan",
|
|
1325
|
-
"other_info": {
|
|
1326
|
-
"bundle_child_ids": [101, 102, 103]
|
|
1327
|
-
}
|
|
1328
|
-
}
|
|
1329
|
-
]
|
|
1330
|
-
```
|
|
1331
|
-
|
|
1332
|
-
#### Example
|
|
1333
|
-
|
|
1334
|
-
```
|
|
1335
|
-
curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/get-bundle-info/123" \
|
|
1336
|
-
-u "username:app_password"
|
|
1337
|
-
```
|
|
1338
|
-
|
|
1339
|
-
---
|
|
1340
|
-
|
|
1341
|
-
### Save Bundle Info
|
|
1342
|
-
|
|
1343
|
-
POST `/fluent-cart/v2/products/save-bundle-info/{variationId}`
|
|
1344
|
-
|
|
1345
|
-
Save bundle child variant IDs for a variation. Bundle products cannot be added as children of other bundles.
|
|
1346
|
-
|
|
1347
|
-
- **Permission:** `products/edit`
|
|
1348
|
-
|
|
1349
|
-
#### Parameters
|
|
1350
|
-
|
|
1351
|
-
| Parameter | Type | Location | Required | Description |
|
|
1352
|
-
| --- | --- | --- | --- | --- |
|
|
1353
|
-
| `variationId` | integer | path | Yes | The variation ID to configure as a bundle |
|
|
1354
|
-
| `bundle_child_ids` | array | body | Yes | Array of child variation IDs |
|
|
1355
|
-
|
|
1356
|
-
#### Response
|
|
1357
|
-
|
|
1358
|
-
```
|
|
1359
|
-
[true]
|
|
1360
|
-
```
|
|
1361
|
-
|
|
1362
|
-
#### Example
|
|
1363
|
-
|
|
1364
|
-
```
|
|
1365
|
-
curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/save-bundle-info/789" \
|
|
1366
|
-
-u "username:app_password" \
|
|
1367
|
-
-H "Content-Type: application/json" \
|
|
1368
|
-
-d '{
|
|
1369
|
-
"bundle_child_ids": [101, 102, 103]
|
|
1370
|
-
}'
|
|
1371
|
-
```
|
|
1372
|
-
|
|
1373
|
-
---
|
|
1374
|
-
|
|
1375
|
-
## Upgrade Paths
|
|
1376
|
-
|
|
1377
|
-
### Get Upgrade Settings
|
|
1378
|
-
|
|
1379
|
-
GET `/fluent-cart/v2/products/{id}/upgrade-paths`
|
|
1380
|
-
|
|
1381
|
-
Retrieve all upgrade path configurations for a product.
|
|
1382
|
-
|
|
1383
|
-
- **Permission:** `products/view`
|
|
1384
|
-
|
|
1385
|
-
#### Parameters
|
|
1386
|
-
|
|
1387
|
-
| Parameter | Type | Location | Required | Description |
|
|
1388
|
-
| --- | --- | --- | --- | --- |
|
|
1389
|
-
| `id` | integer | path | Yes | The product ID |
|
|
1390
|
-
|
|
1391
|
-
#### Response
|
|
1392
|
-
|
|
1393
|
-
```
|
|
1394
|
-
{
|
|
1395
|
-
"data": [ ... ]
|
|
1396
|
-
}
|
|
1397
|
-
```
|
|
1398
|
-
|
|
1399
|
-
#### Example
|
|
1400
|
-
|
|
1401
|
-
```
|
|
1402
|
-
curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/123/upgrade-paths" \
|
|
1403
|
-
-u "username:app_password"
|
|
1404
|
-
```
|
|
1405
|
-
|
|
1406
|
-
---
|
|
1407
|
-
|
|
1408
|
-
### Save Upgrade Path
|
|
1409
|
-
|
|
1410
|
-
POST `/fluent-cart/v2/products/{id}/upgrade-path`
|
|
1411
|
-
|
|
1412
|
-
Create a new upgrade path for a product.
|
|
1413
|
-
|
|
1414
|
-
- **Permission:** `products/edit`
|
|
1415
|
-
- **Request Class:** `UpgradePathSettingRequest`
|
|
1416
|
-
|
|
1417
|
-
#### Parameters
|
|
1418
|
-
|
|
1419
|
-
| Parameter | Type | Location | Required | Description |
|
|
1420
|
-
| --- | --- | --- | --- | --- |
|
|
1421
|
-
| `id` | integer | path | Yes | The product ID |
|
|
1422
|
-
| `from_variant` | integer | body | Yes | Source variation ID (must exist in `fct_product_variations`) |
|
|
1423
|
-
| `to_variants` | array | body | Yes | Array of target variation IDs (each must exist in `fct_product_variations`) |
|
|
1424
|
-
| `discount_amount` | number | body | No | Discount amount for the upgrade |
|
|
1425
|
-
| `title` | string | body | No | Upgrade path title |
|
|
1426
|
-
| `description` | string | body | No | Upgrade path description |
|
|
1427
|
-
| `slug` | string | body | No | Upgrade path slug |
|
|
1428
|
-
|
|
1429
|
-
#### Response
|
|
1430
|
-
|
|
1431
|
-
```
|
|
1432
|
-
{
|
|
1433
|
-
"message": "Settings saved successfully"
|
|
1434
|
-
}
|
|
1435
|
-
```
|
|
1436
|
-
|
|
1437
|
-
#### Example
|
|
1438
|
-
|
|
1439
|
-
```
|
|
1440
|
-
curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/123/upgrade-path" \
|
|
1441
|
-
-u "username:app_password" \
|
|
1442
|
-
-H "Content-Type: application/json" \
|
|
1443
|
-
-d '{
|
|
1444
|
-
"from_variant": 456,
|
|
1445
|
-
"to_variants": [457, 458],
|
|
1446
|
-
"discount_amount": 500
|
|
1447
|
-
}'
|
|
1448
|
-
```
|
|
1449
|
-
|
|
1450
|
-
---
|
|
1451
|
-
|
|
1452
|
-
### Update Upgrade Path
|
|
1453
|
-
|
|
1454
|
-
POST `/fluent-cart/v2/products/upgrade-path/{id}/update`
|
|
1455
|
-
|
|
1456
|
-
Update an existing upgrade path.
|
|
1457
|
-
|
|
1458
|
-
- **Permission:** `products/edit`
|
|
1459
|
-
- **Request Class:** `UpgradePathSettingRequest`
|
|
1460
|
-
|
|
1461
|
-
#### Parameters
|
|
1462
|
-
|
|
1463
|
-
| Parameter | Type | Location | Required | Description |
|
|
1464
|
-
| --- | --- | --- | --- | --- |
|
|
1465
|
-
| `id` | integer | path | Yes | The upgrade path ID |
|
|
1466
|
-
| `from_variant` | integer | body | Yes | Source variation ID |
|
|
1467
|
-
| `to_variants` | array | body | Yes | Array of target variation IDs |
|
|
1468
|
-
| `discount_amount` | number | body | No | Discount amount |
|
|
1469
|
-
| `title` | string | body | No | Upgrade path title |
|
|
1470
|
-
| `description` | string | body | No | Upgrade path description |
|
|
1471
|
-
| `slug` | string | body | No | Upgrade path slug |
|
|
1472
|
-
|
|
1473
|
-
#### Response
|
|
1474
|
-
|
|
1475
|
-
```
|
|
1476
|
-
{
|
|
1477
|
-
"message": "Settings updated successfully"
|
|
1478
|
-
}
|
|
1479
|
-
```
|
|
1480
|
-
|
|
1481
|
-
#### Example
|
|
1482
|
-
|
|
1483
|
-
```
|
|
1484
|
-
curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/upgrade-path/10/update" \
|
|
1485
|
-
-u "username:app_password" \
|
|
1486
|
-
-H "Content-Type: application/json" \
|
|
1487
|
-
-d '{
|
|
1488
|
-
"from_variant": 456,
|
|
1489
|
-
"to_variants": [458, 459],
|
|
1490
|
-
"discount_amount": 1000
|
|
1491
|
-
}'
|
|
1492
|
-
```
|
|
1493
|
-
|
|
1494
|
-
---
|
|
1495
|
-
|
|
1496
|
-
### Delete Upgrade Path
|
|
1497
|
-
|
|
1498
|
-
DELETE `/fluent-cart/v2/products/upgrade-path/{id}/delete`
|
|
1499
|
-
|
|
1500
|
-
Delete an upgrade path.
|
|
1501
|
-
|
|
1502
|
-
- **Permission:** `products/delete`
|
|
1503
|
-
|
|
1504
|
-
#### Parameters
|
|
1505
|
-
|
|
1506
|
-
| Parameter | Type | Location | Required | Description |
|
|
1507
|
-
| --- | --- | --- | --- | --- |
|
|
1508
|
-
| `id` | integer | path | Yes | The upgrade path ID |
|
|
1509
|
-
|
|
1510
|
-
#### Response
|
|
1511
|
-
|
|
1512
|
-
```
|
|
1513
|
-
{
|
|
1514
|
-
"message": "Path deleted successfully"
|
|
1515
|
-
}
|
|
1516
|
-
```
|
|
1517
|
-
|
|
1518
|
-
#### Example
|
|
1519
|
-
|
|
1520
|
-
```
|
|
1521
|
-
curl -X DELETE "https://example.com/wp-json/fluent-cart/v2/products/upgrade-path/10/delete" \
|
|
1522
|
-
-u "username:app_password"
|
|
1523
|
-
```
|
|
1524
|
-
|
|
1525
|
-
---
|
|
1526
|
-
|
|
1527
|
-
### Get Variation Upgrade Paths
|
|
1528
|
-
|
|
1529
|
-
GET `/fluent-cart/v2/products/variation/{variantId}/upgrade-paths`
|
|
1530
|
-
|
|
1531
|
-
Retrieve available upgrade paths for a specific variation (used in customer-facing upgrade flows).
|
|
1532
|
-
|
|
1533
|
-
- **Permission:** `products/view`
|
|
1534
|
-
|
|
1535
|
-
#### Parameters
|
|
1536
|
-
|
|
1537
|
-
| Parameter | Type | Location | Required | Description |
|
|
1538
|
-
| --- | --- | --- | --- | --- |
|
|
1539
|
-
| `variantId` | integer | path | Yes | The variation ID |
|
|
1540
|
-
| `params.order_hash` | string | query | Yes | The order hash to determine applicable upgrades |
|
|
1541
|
-
|
|
1542
|
-
#### Response
|
|
1543
|
-
|
|
1544
|
-
```
|
|
1545
|
-
{
|
|
1546
|
-
"upgradePaths": [ ... ]
|
|
1547
|
-
}
|
|
1548
|
-
```
|
|
1549
|
-
|
|
1550
|
-
#### Example
|
|
1551
|
-
|
|
1552
|
-
```
|
|
1553
|
-
curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/variation/456/upgrade-paths?params[order_hash]=abc123" \
|
|
1554
|
-
-u "username:app_password"
|
|
1555
|
-
```
|
|
1556
|
-
|
|
1557
|
-
---
|
|
1558
|
-
|
|
1559
|
-
## Tax & Shipping Classes
|
|
1560
|
-
|
|
1561
|
-
### Update Tax Class
|
|
1562
|
-
|
|
1563
|
-
POST `/fluent-cart/v2/products/{postId}/tax-class`
|
|
1564
|
-
|
|
1565
|
-
Assign a tax class to a product.
|
|
1566
|
-
|
|
1567
|
-
- **Permission:** `products/edit`
|
|
1568
|
-
|
|
1569
|
-
#### Parameters
|
|
1570
|
-
|
|
1571
|
-
| Parameter | Type | Location | Required | Description |
|
|
1572
|
-
| --- | --- | --- | --- | --- |
|
|
1573
|
-
| `postId` | integer | path | Yes | The product post ID |
|
|
1574
|
-
| `tax_class` | integer | body | Yes | Tax class ID |
|
|
1575
|
-
|
|
1576
|
-
#### Response
|
|
1577
|
-
|
|
1578
|
-
```
|
|
1579
|
-
{
|
|
1580
|
-
"message": "Tax Class updated successfully"
|
|
1581
|
-
}
|
|
1582
|
-
```
|
|
1583
|
-
|
|
1584
|
-
#### Example
|
|
1585
|
-
|
|
1586
|
-
```
|
|
1587
|
-
curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/123/tax-class" \
|
|
1588
|
-
-u "username:app_password" \
|
|
1589
|
-
-H "Content-Type: application/json" \
|
|
1590
|
-
-d '{"tax_class": 5}'
|
|
1591
|
-
```
|
|
1592
|
-
|
|
1593
|
-
---
|
|
1594
|
-
|
|
1595
|
-
### Remove Tax Class
|
|
1596
|
-
|
|
1597
|
-
POST `/fluent-cart/v2/products/{postId}/tax-class/remove`
|
|
1598
|
-
|
|
1599
|
-
Remove the assigned tax class from a product.
|
|
1600
|
-
|
|
1601
|
-
- **Permission:** `products/edit`
|
|
1602
|
-
|
|
1603
|
-
#### Parameters
|
|
1604
|
-
|
|
1605
|
-
| Parameter | Type | Location | Required | Description |
|
|
1606
|
-
| --- | --- | --- | --- | --- |
|
|
1607
|
-
| `postId` | integer | path | Yes | The product post ID |
|
|
1608
|
-
|
|
1609
|
-
#### Response
|
|
1610
|
-
|
|
1611
|
-
```
|
|
1612
|
-
{
|
|
1613
|
-
"message": "Tax Class removed successfully"
|
|
1614
|
-
}
|
|
1615
|
-
```
|
|
1616
|
-
|
|
1617
|
-
#### Example
|
|
1618
|
-
|
|
1619
|
-
```
|
|
1620
|
-
curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/123/tax-class/remove" \
|
|
1621
|
-
-u "username:app_password"
|
|
1622
|
-
```
|
|
1623
|
-
|
|
1624
|
-
---
|
|
1625
|
-
|
|
1626
|
-
### Update Shipping Class
|
|
1627
|
-
|
|
1628
|
-
POST `/fluent-cart/v2/products/{postId}/shipping-class`
|
|
1629
|
-
|
|
1630
|
-
Assign a shipping class to a product.
|
|
1631
|
-
|
|
1632
|
-
- **Permission:** `products/edit`
|
|
1633
|
-
|
|
1634
|
-
#### Parameters
|
|
1635
|
-
|
|
1636
|
-
| Parameter | Type | Location | Required | Description |
|
|
1637
|
-
| --- | --- | --- | --- | --- |
|
|
1638
|
-
| `postId` | integer | path | Yes | The product post ID |
|
|
1639
|
-
| `shipping_class` | integer | body | Yes | Shipping class ID |
|
|
1640
|
-
|
|
1641
|
-
#### Response
|
|
1642
|
-
|
|
1643
|
-
```
|
|
1644
|
-
{
|
|
1645
|
-
"message": "Shipping Class updated successfully"
|
|
1646
|
-
}
|
|
1647
|
-
```
|
|
1648
|
-
|
|
1649
|
-
#### Example
|
|
1650
|
-
|
|
1651
|
-
```
|
|
1652
|
-
curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/123/shipping-class" \
|
|
1653
|
-
-u "username:app_password" \
|
|
1654
|
-
-H "Content-Type: application/json" \
|
|
1655
|
-
-d '{"shipping_class": 3}'
|
|
1656
|
-
```
|
|
1657
|
-
|
|
1658
|
-
---
|
|
1659
|
-
|
|
1660
|
-
### Remove Shipping Class
|
|
1661
|
-
|
|
1662
|
-
POST `/fluent-cart/v2/products/{postId}/shipping-class/remove`
|
|
1663
|
-
|
|
1664
|
-
Remove the assigned shipping class from a product.
|
|
1665
|
-
|
|
1666
|
-
- **Permission:** `products/edit`
|
|
1667
|
-
|
|
1668
|
-
#### Parameters
|
|
1669
|
-
|
|
1670
|
-
| Parameter | Type | Location | Required | Description |
|
|
1671
|
-
| --- | --- | --- | --- | --- |
|
|
1672
|
-
| `postId` | integer | path | Yes | The product post ID |
|
|
1673
|
-
|
|
1674
|
-
#### Response
|
|
1675
|
-
|
|
1676
|
-
```
|
|
1677
|
-
{
|
|
1678
|
-
"message": "Shipping Class removed successfully"
|
|
1679
|
-
}
|
|
1680
|
-
```
|
|
1681
|
-
|
|
1682
|
-
#### Example
|
|
1683
|
-
|
|
1684
|
-
```
|
|
1685
|
-
curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/123/shipping-class/remove" \
|
|
1686
|
-
-u "username:app_password"
|
|
1687
|
-
```
|
|
1688
|
-
|
|
1689
|
-
---
|
|
1690
|
-
|
|
1691
|
-
## Stock Management
|
|
1692
|
-
|
|
1693
|
-
### Update Inventory
|
|
1694
|
-
|
|
1695
|
-
PUT `/fluent-cart/v2/products/{postId}/update-inventory/{variantId}`
|
|
1696
|
-
|
|
1697
|
-
Update stock levels for a specific variant. Automatically updates stock status and product-level availability.
|
|
1698
|
-
|
|
1699
|
-
- **Permission:** `products/edit`
|
|
1700
|
-
|
|
1701
|
-
#### Parameters
|
|
1702
|
-
|
|
1703
|
-
| Parameter | Type | Location | Required | Description |
|
|
1704
|
-
| --- | --- | --- | --- | --- |
|
|
1705
|
-
| `postId` | integer | path | Yes | The product post ID |
|
|
1706
|
-
| `variantId` | integer | path | Yes | The variant ID to update |
|
|
1707
|
-
| `total_stock` | integer | body | Yes | Total stock quantity |
|
|
1708
|
-
| `available` | integer | body | Yes | Available stock quantity |
|
|
1709
|
-
|
|
1710
|
-
#### Response
|
|
1711
|
-
|
|
1712
|
-
```
|
|
1713
|
-
{
|
|
1714
|
-
"message": "Inventory updated successfully"
|
|
1715
|
-
}
|
|
1716
|
-
```
|
|
1717
|
-
|
|
1718
|
-
#### Example
|
|
1719
|
-
|
|
1720
|
-
```
|
|
1721
|
-
curl -X PUT "https://example.com/wp-json/fluent-cart/v2/products/123/update-inventory/456" \
|
|
1722
|
-
-u "username:app_password" \
|
|
1723
|
-
-H "Content-Type: application/json" \
|
|
1724
|
-
-d '{
|
|
1725
|
-
"total_stock": 100,
|
|
1726
|
-
"available": 80
|
|
1727
|
-
}'
|
|
1728
|
-
```
|
|
1729
|
-
|
|
1730
|
-
---
|
|
1731
|
-
|
|
1732
|
-
### Update Manage Stock Setting
|
|
1733
|
-
|
|
1734
|
-
PUT `/fluent-cart/v2/products/{postId}/update-manage-stock`
|
|
1735
|
-
|
|
1736
|
-
Enable or disable stock management for a product and all its variants.
|
|
1737
|
-
|
|
1738
|
-
- **Permission:** `products/edit`
|
|
1739
|
-
|
|
1740
|
-
#### Parameters
|
|
1741
|
-
|
|
1742
|
-
| Parameter | Type | Location | Required | Description |
|
|
1743
|
-
| --- | --- | --- | --- | --- |
|
|
1744
|
-
| `postId` | integer | path | Yes | The product post ID |
|
|
1745
|
-
| `manage_stock` | integer | body | Yes | `1` to enable, `0` to disable stock management |
|
|
1746
|
-
|
|
1747
|
-
#### Response
|
|
1748
|
-
|
|
1749
|
-
```
|
|
1750
|
-
{
|
|
1751
|
-
"message": "Manage stock updated successfully"
|
|
1752
|
-
}
|
|
1753
|
-
```
|
|
1754
|
-
|
|
1755
|
-
#### Example
|
|
1756
|
-
|
|
1757
|
-
```
|
|
1758
|
-
curl -X PUT "https://example.com/wp-json/fluent-cart/v2/products/123/update-manage-stock" \
|
|
1759
|
-
-u "username:app_password" \
|
|
1760
|
-
-H "Content-Type: application/json" \
|
|
1761
|
-
-d '{"manage_stock": 1}'
|
|
1762
|
-
```
|
|
1763
|
-
|
|
1764
|
-
---
|
|
1765
|
-
|
|
1766
|
-
## Downloadables
|
|
1767
|
-
|
|
1768
|
-
### Sync Downloadable Files
|
|
1769
|
-
|
|
1770
|
-
POST `/fluent-cart/v2/products/{postId}/sync-downloadable-files`
|
|
1771
|
-
|
|
1772
|
-
Attach multiple downloadable files to a product. Automatically enables the `manage_downloadable` flag.
|
|
1773
|
-
|
|
1774
|
-
- **Permission:** `products/edit`
|
|
1775
|
-
- **Validation Class:** `ProductDownloadableBulkFileRequest`
|
|
1776
|
-
|
|
1777
|
-
#### Parameters
|
|
1778
|
-
|
|
1779
|
-
| Parameter | Type | Location | Required | Description |
|
|
1780
|
-
| --- | --- | --- | --- | --- |
|
|
1781
|
-
| `postId` | integer | path | Yes | The product post ID |
|
|
1782
|
-
| `downloadable_files` | array | body | Yes | Array of downloadable file objects |
|
|
1783
|
-
| `downloadable_files.*.title` | string | body | Yes | File title (max 160 chars) |
|
|
1784
|
-
| `downloadable_files.*.type` | string | body | Yes | File type (max 100 chars) |
|
|
1785
|
-
| `downloadable_files.*.driver` | string | body | Yes | Storage driver (max 60 chars, e.g., `local`, `s3`) |
|
|
1786
|
-
| `downloadable_files.*.file_name` | string | body | Yes | File name (max 185 chars) |
|
|
1787
|
-
| `downloadable_files.*.file_path` | string | body | Yes | File path (max 185 chars) |
|
|
1788
|
-
| `downloadable_files.*.file_url` | string | body | Yes | File URL (max 200 chars) |
|
|
1789
|
-
| `downloadable_files.*.bucket` | string | body | No | Storage bucket name |
|
|
1790
|
-
| `downloadable_files.*.file_size` | string | body | No | File size |
|
|
1791
|
-
| `downloadable_files.*.serial` | integer | body | No | Display order serial |
|
|
1792
|
-
| `downloadable_files.*.product_variation_id` | array | body | No | Array of variation IDs this file is associated with |
|
|
1793
|
-
| `downloadable_files.*.settings.download_limit` | integer | body | No | Maximum number of downloads allowed |
|
|
1794
|
-
| `downloadable_files.*.settings.download_expiry` | integer | body | No | Download expiry in days |
|
|
1795
|
-
|
|
1796
|
-
#### Response
|
|
1797
|
-
|
|
1798
|
-
```
|
|
1799
|
-
{
|
|
1800
|
-
"downloadable_files": [
|
|
1801
|
-
{
|
|
1802
|
-
"id": 1,
|
|
1803
|
-
"post_id": 123,
|
|
1804
|
-
"title": "Software v1.0",
|
|
1805
|
-
"type": "zip",
|
|
1806
|
-
"driver": "local",
|
|
1807
|
-
"file_name": "software-v1.zip",
|
|
1808
|
-
"download_identifier": "a1b2c3d4-..."
|
|
1809
|
-
}
|
|
1810
|
-
]
|
|
1811
|
-
}
|
|
1812
|
-
```
|
|
1813
|
-
|
|
1814
|
-
#### Example
|
|
1815
|
-
|
|
1816
|
-
```
|
|
1817
|
-
curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/123/sync-downloadable-files" \
|
|
1818
|
-
-u "username:app_password" \
|
|
1819
|
-
-H "Content-Type: application/json" \
|
|
1820
|
-
-d '{
|
|
1821
|
-
"postId": 123,
|
|
1822
|
-
"downloadable_files": [
|
|
1823
|
-
{
|
|
1824
|
-
"title": "Software v1.0",
|
|
1825
|
-
"type": "zip",
|
|
1826
|
-
"driver": "local",
|
|
1827
|
-
"file_name": "software-v1.zip",
|
|
1828
|
-
"file_path": "software-v1.zip",
|
|
1829
|
-
"file_url": "software-v1.zip",
|
|
1830
|
-
"product_variation_id": [456],
|
|
1831
|
-
"settings": {
|
|
1832
|
-
"download_limit": 5,
|
|
1833
|
-
"download_expiry": 365
|
|
1834
|
-
}
|
|
1835
|
-
}
|
|
1836
|
-
]
|
|
1837
|
-
}'
|
|
1838
|
-
```
|
|
1839
|
-
|
|
1840
|
-
---
|
|
1841
|
-
|
|
1842
|
-
### Update Downloadable File
|
|
1843
|
-
|
|
1844
|
-
PUT `/fluent-cart/v2/products/{downloadableId}/update`
|
|
1845
|
-
|
|
1846
|
-
Update an existing downloadable file record.
|
|
1847
|
-
|
|
1848
|
-
- **Permission:** `products/edit`
|
|
1849
|
-
- **Validation Class:** `ProductDownloadableFileRequest`
|
|
1850
|
-
|
|
1851
|
-
#### Parameters
|
|
1852
|
-
|
|
1853
|
-
| Parameter | Type | Location | Required | Description |
|
|
1854
|
-
| --- | --- | --- | --- | --- |
|
|
1855
|
-
| `downloadableId` | integer | path | Yes | The downloadable file ID |
|
|
1856
|
-
| `title` | string | body | Yes | File title (max 100 chars) |
|
|
1857
|
-
| `type` | string | body | Yes | File type (max 100 chars) |
|
|
1858
|
-
| `driver` | string | body | Yes | Storage driver (max 100 chars) |
|
|
1859
|
-
| `file_name` | string | body | Yes | File name (max 100 chars) |
|
|
1860
|
-
| `product_variation_id` | array | body | No | Array of variation IDs |
|
|
1861
|
-
| `serial` | integer | body | No | Display order serial |
|
|
1862
|
-
| `settings` | object | body | No | File settings |
|
|
1863
|
-
| `settings.download_limit` | integer | body | No | Maximum downloads allowed |
|
|
1864
|
-
| `settings.download_expiry` | integer | body | No | Download expiry in days |
|
|
1865
|
-
|
|
1866
|
-
#### Response
|
|
1867
|
-
|
|
1868
|
-
```
|
|
1869
|
-
{
|
|
1870
|
-
"message": "Product downloadable files updated successfully"
|
|
1871
|
-
}
|
|
1872
|
-
```
|
|
1873
|
-
|
|
1874
|
-
#### Example
|
|
1875
|
-
|
|
1876
|
-
```
|
|
1877
|
-
curl -X PUT "https://example.com/wp-json/fluent-cart/v2/products/789/update" \
|
|
1878
|
-
-u "username:app_password" \
|
|
1879
|
-
-H "Content-Type: application/json" \
|
|
1880
|
-
-d '{
|
|
1881
|
-
"title": "Software v2.0",
|
|
1882
|
-
"type": "zip",
|
|
1883
|
-
"driver": "local",
|
|
1884
|
-
"file_name": "software-v2.zip",
|
|
1885
|
-
"product_variation_id": [456, 457],
|
|
1886
|
-
"settings": {
|
|
1887
|
-
"download_limit": 10
|
|
1888
|
-
}
|
|
1889
|
-
}'
|
|
1890
|
-
```
|
|
1891
|
-
|
|
1892
|
-
---
|
|
1893
|
-
|
|
1894
|
-
### Delete Downloadable File
|
|
1895
|
-
|
|
1896
|
-
DELETE `/fluent-cart/v2/products/{downloadableId}/delete`
|
|
1897
|
-
|
|
1898
|
-
Delete a downloadable file record.
|
|
1899
|
-
|
|
1900
|
-
- **Permission:** `products/delete`
|
|
1901
|
-
|
|
1902
|
-
#### Parameters
|
|
1903
|
-
|
|
1904
|
-
| Parameter | Type | Location | Required | Description |
|
|
1905
|
-
| --- | --- | --- | --- | --- |
|
|
1906
|
-
| `downloadableId` | integer | path | Yes | The downloadable file ID |
|
|
1907
|
-
|
|
1908
|
-
#### Response
|
|
1909
|
-
|
|
1910
|
-
```
|
|
1911
|
-
{
|
|
1912
|
-
"message": "File deleted successfully"
|
|
1913
|
-
}
|
|
1914
|
-
```
|
|
1915
|
-
|
|
1916
|
-
#### Example
|
|
1917
|
-
|
|
1918
|
-
```
|
|
1919
|
-
curl -X DELETE "https://example.com/wp-json/fluent-cart/v2/products/789/delete" \
|
|
1920
|
-
-u "username:app_password"
|
|
1921
|
-
```
|
|
1922
|
-
|
|
1923
|
-
---
|
|
1924
|
-
|
|
1925
|
-
### Get Downloadable URL
|
|
1926
|
-
|
|
1927
|
-
GET `/fluent-cart/v2/products/getDownloadableUrl/{downloadableId}`
|
|
1928
|
-
|
|
1929
|
-
Generate a temporary download URL for a downloadable file (valid for 7 days).
|
|
1930
|
-
|
|
1931
|
-
- **Permission:** `products/view`
|
|
1932
|
-
|
|
1933
|
-
#### Parameters
|
|
1934
|
-
|
|
1935
|
-
| Parameter | Type | Location | Required | Description |
|
|
1936
|
-
| --- | --- | --- | --- | --- |
|
|
1937
|
-
| `downloadableId` | integer | path | Yes | The downloadable file ID |
|
|
1938
|
-
|
|
1939
|
-
#### Response
|
|
1940
|
-
|
|
1941
|
-
```
|
|
1942
|
-
{
|
|
1943
|
-
"url": "https://example.com/fluent-cart/download?token=..."
|
|
1944
|
-
}
|
|
1945
|
-
```
|
|
1946
|
-
|
|
1947
|
-
#### Example
|
|
1948
|
-
|
|
1949
|
-
```
|
|
1950
|
-
curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/getDownloadableUrl/789" \
|
|
1951
|
-
-u "username:app_password"
|
|
1952
|
-
```
|
|
1953
|
-
|
|
1954
|
-
---
|
|
1955
|
-
|
|
1956
|
-
## Variations
|
|
1957
|
-
|
|
1958
|
-
### List Product Variations
|
|
1959
|
-
|
|
1960
|
-
GET `/fluent-cart/v2/products/variants`
|
|
1961
|
-
|
|
1962
|
-
Retrieve a list of product variations.
|
|
1963
|
-
|
|
1964
|
-
- **Permission:** `products/view`
|
|
1965
|
-
|
|
1966
|
-
#### Parameters
|
|
1967
|
-
|
|
1968
|
-
| Parameter | Type | Location | Required | Description |
|
|
1969
|
-
| --- | --- | --- | --- | --- |
|
|
1970
|
-
| `params` | object | query | No | Query parameters for filtering variations |
|
|
1971
|
-
|
|
1972
|
-
#### Response
|
|
1973
|
-
|
|
1974
|
-
```
|
|
1975
|
-
{
|
|
1976
|
-
"variants": [ ... ]
|
|
1977
|
-
}
|
|
1978
|
-
```
|
|
1979
|
-
|
|
1980
|
-
#### Example
|
|
1981
|
-
|
|
1982
|
-
```
|
|
1983
|
-
curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/variants" \
|
|
1984
|
-
-u "username:app_password"
|
|
1985
|
-
```
|
|
1986
|
-
|
|
1987
|
-
---
|
|
1988
|
-
|
|
1989
|
-
### Create Variation
|
|
1990
|
-
|
|
1991
|
-
POST `/fluent-cart/v2/products/variants`
|
|
1992
|
-
|
|
1993
|
-
Create a new product variation.
|
|
1994
|
-
|
|
1995
|
-
- **Permission:** `products/create`
|
|
1996
|
-
- **Request Class:** `ProductVariationRequest`
|
|
1997
|
-
|
|
1998
|
-
#### Parameters
|
|
1999
|
-
|
|
2000
|
-
| Parameter | Type | Location | Required | Description |
|
|
2001
|
-
| --- | --- | --- | --- | --- |
|
|
2002
|
-
| `variants.post_id` | integer | body | Yes | Parent product ID |
|
|
2003
|
-
| `variants.variation_title` | string | body | Yes | Variation title (max 200 chars) |
|
|
2004
|
-
| `variants.sku` | string | body | No | SKU (max 30 chars, must be unique) |
|
|
2005
|
-
| `variants.item_price` | number | body | No | Price in cents (min: 0) |
|
|
2006
|
-
| `variants.compare_price` | number | body | No | Compare-at price in cents (must be >= `item_price`) |
|
|
2007
|
-
| `variants.manage_cost` | string | body | No | Enable cost tracking |
|
|
2008
|
-
| `variants.item_cost` | number | body | Conditional | Required if `manage_cost` is `true` |
|
|
2009
|
-
| `variants.fulfillment_type` | string | body | Yes | `physical` or `digital` |
|
|
2010
|
-
| `variants.manage_stock` | integer | body | No | `0` or `1` |
|
|
2011
|
-
| `variants.stock_status` | string | body | Conditional | Required if `manage_stock` is `1`. Values: `in-stock`, `out-of-stock` |
|
|
2012
|
-
| `variants.total_stock` | integer | body | Yes | Total stock quantity |
|
|
2013
|
-
| `variants.available` | integer | body | Yes | Available stock |
|
|
2014
|
-
| `variants.committed` | integer | body | Yes | Committed stock |
|
|
2015
|
-
| `variants.on_hold` | integer | body | Yes | Stock on hold |
|
|
2016
|
-
| `variants.serial_index` | integer | body | No | Display order index |
|
|
2017
|
-
| `variants.downloadable` | string | body | No | Downloadable flag |
|
|
2018
|
-
| `variants.other_info.payment_type` | string | body | Yes | `onetime` or `subscription` |
|
|
2019
|
-
| `variants.other_info.description` | string | body | No | Description (max 255 chars) |
|
|
2020
|
-
| `variants.other_info.repeat_interval` | string | body | Conditional | Required for subscriptions (e.g., `monthly`, `yearly`) |
|
|
2021
|
-
| `variants.other_info.times` | number | body | No | Number of billing cycles |
|
|
2022
|
-
| `variants.other_info.trial_days` | number | body | No | Trial days (max 365) |
|
|
2023
|
-
| `variants.other_info.billing_summary` | string | body | No | Billing summary (max 255 chars) |
|
|
2024
|
-
| `variants.other_info.manage_setup_fee` | string | body | Conditional | Required for subscriptions: `yes` or `no` |
|
|
2025
|
-
| `variants.other_info.signup_fee` | number | body | Conditional | Setup fee in cents. Required if `manage_setup_fee` is `yes` |
|
|
2026
|
-
| `variants.other_info.signup_fee_name` | string | body | Conditional | Setup fee label (max 100 chars). Required if `manage_setup_fee` is `yes` |
|
|
2027
|
-
| `variants.media` | array | body | No | Media images array with `id`, `url`, `title` |
|
|
2028
|
-
|
|
2029
|
-
#### Response
|
|
2030
|
-
|
|
2031
|
-
```
|
|
2032
|
-
{
|
|
2033
|
-
"variant": {
|
|
2034
|
-
"id": 460,
|
|
2035
|
-
"post_id": 123,
|
|
2036
|
-
"variation_title": "Pro Plan",
|
|
2037
|
-
"item_price": 2999,
|
|
2038
|
-
"sku": "PRO-PLN",
|
|
2039
|
-
"stock_status": "in-stock"
|
|
2040
|
-
},
|
|
2041
|
-
"message": "Variation created successfully"
|
|
2042
|
-
}
|
|
2043
|
-
```
|
|
2044
|
-
|
|
2045
|
-
#### Example
|
|
2046
|
-
|
|
2047
|
-
```
|
|
2048
|
-
curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/variants" \
|
|
2049
|
-
-u "username:app_password" \
|
|
2050
|
-
-H "Content-Type: application/json" \
|
|
2051
|
-
-d '{
|
|
2052
|
-
"variants": {
|
|
2053
|
-
"post_id": 123,
|
|
2054
|
-
"variation_title": "Pro Plan",
|
|
2055
|
-
"item_price": 2999,
|
|
2056
|
-
"sku": "PRO-PLN",
|
|
2057
|
-
"fulfillment_type": "digital",
|
|
2058
|
-
"total_stock": 1,
|
|
2059
|
-
"available": 1,
|
|
2060
|
-
"committed": 0,
|
|
2061
|
-
"on_hold": 0,
|
|
2062
|
-
"other_info": {
|
|
2063
|
-
"payment_type": "onetime"
|
|
2064
|
-
}
|
|
2065
|
-
}
|
|
2066
|
-
}'
|
|
2067
|
-
```
|
|
2068
|
-
|
|
2069
|
-
---
|
|
2070
|
-
|
|
2071
|
-
### Update Variation
|
|
2072
|
-
|
|
2073
|
-
POST `/fluent-cart/v2/products/variants/{variantId}`
|
|
2074
|
-
|
|
2075
|
-
Update an existing product variation.
|
|
2076
|
-
|
|
2077
|
-
- **Permission:** `products/edit`
|
|
2078
|
-
- **Request Class:** `ProductVariationRequest`
|
|
2079
|
-
|
|
2080
|
-
#### Parameters
|
|
2081
|
-
|
|
2082
|
-
| Parameter | Type | Location | Required | Description |
|
|
2083
|
-
| --- | --- | --- | --- | --- |
|
|
2084
|
-
| `variantId` | integer | path | Yes | The variation ID to update |
|
|
2085
|
-
|
|
2086
|
-
All body parameters are the same as [Create Variation](#create-variation).
|
|
2087
|
-
|
|
2088
|
-
#### Response
|
|
2089
|
-
|
|
2090
|
-
```
|
|
2091
|
-
{
|
|
2092
|
-
"variant": { ... },
|
|
2093
|
-
"message": "Variation updated successfully"
|
|
2094
|
-
}
|
|
2095
|
-
```
|
|
2096
|
-
|
|
2097
|
-
#### Example
|
|
2098
|
-
|
|
2099
|
-
```
|
|
2100
|
-
curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/variants/460" \
|
|
2101
|
-
-u "username:app_password" \
|
|
2102
|
-
-H "Content-Type: application/json" \
|
|
2103
|
-
-d '{
|
|
2104
|
-
"variants": {
|
|
2105
|
-
"id": 460,
|
|
2106
|
-
"post_id": 123,
|
|
2107
|
-
"variation_title": "Pro Plan - Updated",
|
|
2108
|
-
"item_price": 3999,
|
|
2109
|
-
"fulfillment_type": "digital",
|
|
2110
|
-
"total_stock": 1,
|
|
2111
|
-
"available": 1,
|
|
2112
|
-
"committed": 0,
|
|
2113
|
-
"on_hold": 0,
|
|
2114
|
-
"other_info": {
|
|
2115
|
-
"payment_type": "onetime"
|
|
2116
|
-
}
|
|
2117
|
-
}
|
|
2118
|
-
}'
|
|
2119
|
-
```
|
|
2120
|
-
|
|
2121
|
-
---
|
|
2122
|
-
|
|
2123
|
-
### Delete Variation
|
|
2124
|
-
|
|
2125
|
-
DELETE `/fluent-cart/v2/products/variants/{variantId}`
|
|
2126
|
-
|
|
2127
|
-
Delete a product variation.
|
|
2128
|
-
|
|
2129
|
-
- **Permission:** `products/delete`
|
|
2130
|
-
|
|
2131
|
-
#### Parameters
|
|
2132
|
-
|
|
2133
|
-
| Parameter | Type | Location | Required | Description |
|
|
2134
|
-
| --- | --- | --- | --- | --- |
|
|
2135
|
-
| `variantId` | integer | path | Yes | The variation ID to delete |
|
|
2136
|
-
|
|
2137
|
-
#### Response
|
|
2138
|
-
|
|
2139
|
-
```
|
|
2140
|
-
{
|
|
2141
|
-
"message": "Variation deleted successfully"
|
|
2142
|
-
}
|
|
2143
|
-
```
|
|
2144
|
-
|
|
2145
|
-
#### Example
|
|
2146
|
-
|
|
2147
|
-
```
|
|
2148
|
-
curl -X DELETE "https://example.com/wp-json/fluent-cart/v2/products/variants/460" \
|
|
2149
|
-
-u "username:app_password"
|
|
2150
|
-
```
|
|
2151
|
-
|
|
2152
|
-
---
|
|
2153
|
-
|
|
2154
|
-
### Set Variation Media
|
|
2155
|
-
|
|
2156
|
-
POST `/fluent-cart/v2/products/variants/{variantId}/setMedia`
|
|
2157
|
-
|
|
2158
|
-
Set media/images for a variation.
|
|
2159
|
-
|
|
2160
|
-
- **Permission:** `products/edit`
|
|
2161
|
-
|
|
2162
|
-
#### Parameters
|
|
2163
|
-
|
|
2164
|
-
| Parameter | Type | Location | Required | Description |
|
|
2165
|
-
| --- | --- | --- | --- | --- |
|
|
2166
|
-
| `variantId` | integer | path | Yes | The variation ID |
|
|
2167
|
-
| `media` | array | body | Yes | Array of media objects |
|
|
2168
|
-
| `media.*.id` | integer | body | Yes | WordPress attachment ID |
|
|
2169
|
-
| `media.*.title` | string | body | No | Image title |
|
|
2170
|
-
| `media.*.url` | string | body | No | Image URL |
|
|
2171
|
-
|
|
2172
|
-
#### Response
|
|
2173
|
-
|
|
2174
|
-
```
|
|
2175
|
-
{
|
|
2176
|
-
"message": "Media set successfully"
|
|
2177
|
-
}
|
|
2178
|
-
```
|
|
2179
|
-
|
|
2180
|
-
#### Example
|
|
2181
|
-
|
|
2182
|
-
```
|
|
2183
|
-
curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/variants/460/setMedia" \
|
|
2184
|
-
-u "username:app_password" \
|
|
2185
|
-
-H "Content-Type: application/json" \
|
|
2186
|
-
-d '{
|
|
2187
|
-
"media": [
|
|
2188
|
-
{
|
|
2189
|
-
"id": 101,
|
|
2190
|
-
"title": "Product Image",
|
|
2191
|
-
"url": "https://example.com/wp-content/uploads/product.jpg"
|
|
2192
|
-
}
|
|
2193
|
-
]
|
|
2194
|
-
}'
|
|
2195
|
-
```
|
|
2196
|
-
|
|
2197
|
-
---
|
|
2198
|
-
|
|
2199
|
-
### Update Variation Pricing Table
|
|
2200
|
-
|
|
2201
|
-
PUT `/fluent-cart/v2/products/variants/{variantId}/pricing-table`
|
|
2202
|
-
|
|
2203
|
-
Update the pricing table description for a variation.
|
|
2204
|
-
|
|
2205
|
-
- **Permission:** `products/edit`
|
|
2206
|
-
|
|
2207
|
-
#### Parameters
|
|
2208
|
-
|
|
2209
|
-
| Parameter | Type | Location | Required | Description |
|
|
2210
|
-
| --- | --- | --- | --- | --- |
|
|
2211
|
-
| `variantId` | integer | path | Yes | The variation ID |
|
|
2212
|
-
| `description` | string | body | Yes | Pricing table description text (newlines preserved) |
|
|
2213
|
-
|
|
2214
|
-
#### Response
|
|
2215
|
-
|
|
2216
|
-
```
|
|
2217
|
-
{
|
|
2218
|
-
"message": "Pricing table updated successfully"
|
|
2219
|
-
}
|
|
2220
|
-
```
|
|
2221
|
-
|
|
2222
|
-
#### Example
|
|
2223
|
-
|
|
2224
|
-
```
|
|
2225
|
-
curl -X PUT "https://example.com/wp-json/fluent-cart/v2/products/variants/460/pricing-table" \
|
|
2226
|
-
-u "username:app_password" \
|
|
2227
|
-
-H "Content-Type: application/json" \
|
|
2228
|
-
-d '{
|
|
2229
|
-
"description": "Includes:\n- Feature A\n- Feature B\n- Priority Support"
|
|
2230
|
-
}'
|
|
2231
|
-
```
|
|
2232
|
-
|
|
2233
|
-
---
|
|
2234
|
-
|
|
2235
|
-
## Variants (VariantController)
|
|
2236
|
-
|
|
2237
|
-
### List All Variants
|
|
2238
|
-
|
|
2239
|
-
GET `/fluent-cart/v2/variants`
|
|
2240
|
-
|
|
2241
|
-
Retrieve all product variations across all products (separate route group using `VariantController`).
|
|
2242
|
-
|
|
2243
|
-
- **Permission:** `products/view`
|
|
2244
|
-
- **Policy:** `ProductPolicy`
|
|
2245
|
-
|
|
2246
|
-
#### Parameters
|
|
2247
|
-
|
|
2248
|
-
| Parameter | Type | Location | Required | Description |
|
|
2249
|
-
| --- | --- | --- | --- | --- |
|
|
2250
|
-
| `params` | object | query | No | Query parameters for filtering |
|
|
2251
|
-
|
|
2252
|
-
#### Response
|
|
2253
|
-
|
|
2254
|
-
Returns an array of all product variation objects.
|
|
2255
|
-
|
|
2256
|
-
```
|
|
2257
|
-
[
|
|
2258
|
-
{
|
|
2259
|
-
"id": 456,
|
|
2260
|
-
"post_id": 123,
|
|
2261
|
-
"variation_title": "Default Plan",
|
|
2262
|
-
"item_price": 1000,
|
|
2263
|
-
"sku": null,
|
|
2264
|
-
"stock_status": "in-stock",
|
|
2265
|
-
"payment_type": "onetime",
|
|
2266
|
-
"other_info": { ... }
|
|
2267
|
-
}
|
|
2268
|
-
]
|
|
2269
|
-
```
|
|
2270
|
-
|
|
2271
|
-
#### Example
|
|
2272
|
-
|
|
2273
|
-
```
|
|
2274
|
-
curl -X GET "https://example.com/wp-json/fluent-cart/v2/variants" \
|
|
2275
|
-
-u "username:app_password"
|
|
2276
|
-
```
|
|
2277
|
-
|
|
2278
|
-
---
|
|
2279
|
-
|
|
2280
|
-
## Product Integrations
|
|
2281
|
-
|
|
2282
|
-
### Get Product Integration Feeds
|
|
2283
|
-
|
|
2284
|
-
GET `/fluent-cart/v2/products/{productId}/integrations`
|
|
2285
|
-
|
|
2286
|
-
Retrieve all integration feeds configured for a product, along with available integrations.
|
|
2287
|
-
|
|
2288
|
-
- **Permission:** `products/view`
|
|
2289
|
-
|
|
2290
|
-
#### Parameters
|
|
2291
|
-
|
|
2292
|
-
| Parameter | Type | Location | Required | Description |
|
|
2293
|
-
| --- | --- | --- | --- | --- |
|
|
2294
|
-
| `productId` | integer | path | Yes | The product ID |
|
|
2295
|
-
|
|
2296
|
-
#### Response
|
|
2297
|
-
|
|
2298
|
-
```
|
|
2299
|
-
{
|
|
2300
|
-
"feeds": [
|
|
2301
|
-
{
|
|
2302
|
-
"id": 10,
|
|
2303
|
-
"name": "Add to FluentCRM List",
|
|
2304
|
-
"enabled": "yes",
|
|
2305
|
-
"provider": "fluentcrm",
|
|
2306
|
-
"feed": { ... },
|
|
2307
|
-
"scope": "product"
|
|
2308
|
-
}
|
|
2309
|
-
],
|
|
2310
|
-
"available_integrations": {
|
|
2311
|
-
"fluentcrm": {
|
|
2312
|
-
"title": "FluentCRM",
|
|
2313
|
-
"logo": "...",
|
|
2314
|
-
"enabled": true,
|
|
2315
|
-
"scopes": ["product", "order"]
|
|
2316
|
-
}
|
|
2317
|
-
},
|
|
2318
|
-
"all_module_config_url": "https://example.com/wp-admin/admin.php?page=fluent-cart#/integrations"
|
|
2319
|
-
}
|
|
2320
|
-
```
|
|
2321
|
-
|
|
2322
|
-
#### Example
|
|
2323
|
-
|
|
2324
|
-
```
|
|
2325
|
-
curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/123/integrations" \
|
|
2326
|
-
-u "username:app_password"
|
|
2327
|
-
```
|
|
2328
|
-
|
|
2329
|
-
---
|
|
2330
|
-
|
|
2331
|
-
### Get Product Integration Settings
|
|
2332
|
-
|
|
2333
|
-
GET `/fluent-cart/v2/products/{product_id}/integrations/{integration_name}/settings`
|
|
2334
|
-
|
|
2335
|
-
Retrieve settings for a specific integration type on a product. Returns the integration form configuration, existing settings, and product variations.
|
|
2336
|
-
|
|
2337
|
-
- **Permission:** `products/view`
|
|
2338
|
-
|
|
2339
|
-
#### Parameters
|
|
2340
|
-
|
|
2341
|
-
| Parameter | Type | Location | Required | Description |
|
|
2342
|
-
| --- | --- | --- | --- | --- |
|
|
2343
|
-
| `product_id` | integer | path | Yes | The product ID |
|
|
2344
|
-
| `integration_name` | string | path | Yes | Integration provider name (e.g., `fluentcrm`) |
|
|
2345
|
-
| `integration_id` | integer | query | No | Existing integration feed ID to load for editing |
|
|
2346
|
-
|
|
2347
|
-
#### Response
|
|
2348
|
-
|
|
2349
|
-
```
|
|
2350
|
-
{
|
|
2351
|
-
"settings": {
|
|
2352
|
-
"conditional_variation_ids": [],
|
|
2353
|
-
...
|
|
2354
|
-
},
|
|
2355
|
-
"fields": [ ... ],
|
|
2356
|
-
"product_variations": [
|
|
2357
|
-
{
|
|
2358
|
-
"id": 456,
|
|
2359
|
-
"title": "Monthly Plan"
|
|
2360
|
-
}
|
|
2361
|
-
],
|
|
2362
|
-
"scope": "product"
|
|
2363
|
-
}
|
|
2364
|
-
```
|
|
2365
|
-
|
|
2366
|
-
#### Example
|
|
2367
|
-
|
|
2368
|
-
```
|
|
2369
|
-
curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/123/integrations/fluentcrm/settings" \
|
|
2370
|
-
-u "username:app_password"
|
|
2371
|
-
```
|
|
2372
|
-
|
|
2373
|
-
---
|
|
2374
|
-
|
|
2375
|
-
### Save Product Integration
|
|
2376
|
-
|
|
2377
|
-
POST `/fluent-cart/v2/products/{product_id}/integrations`
|
|
2378
|
-
|
|
2379
|
-
Create or update an integration feed for a product.
|
|
2380
|
-
|
|
2381
|
-
- **Permission:** `products/edit`
|
|
2382
|
-
|
|
2383
|
-
#### Parameters
|
|
2384
|
-
|
|
2385
|
-
| Parameter | Type | Location | Required | Description |
|
|
2386
|
-
| --- | --- | --- | --- | --- |
|
|
2387
|
-
| `product_id` | integer | path | Yes | The product ID |
|
|
2388
|
-
| `integration_name` | string | body | Yes | Integration provider name |
|
|
2389
|
-
| `integration_id` | integer | body | No | Existing feed ID (for updates) |
|
|
2390
|
-
| `integration` | string (JSON) | body | Yes | JSON-encoded integration settings object |
|
|
2391
|
-
|
|
2392
|
-
#### Response
|
|
2393
|
-
|
|
2394
|
-
```
|
|
2395
|
-
{
|
|
2396
|
-
"message": "Integration has been successfully saved",
|
|
2397
|
-
"integration_id": 10,
|
|
2398
|
-
"integration_name": "fluentcrm",
|
|
2399
|
-
"created": true,
|
|
2400
|
-
"feedData": { ... }
|
|
2401
|
-
}
|
|
2402
|
-
```
|
|
2403
|
-
|
|
2404
|
-
#### Example
|
|
2405
|
-
|
|
2406
|
-
```
|
|
2407
|
-
curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/123/integrations" \
|
|
2408
|
-
-u "username:app_password" \
|
|
2409
|
-
-H "Content-Type: application/json" \
|
|
2410
|
-
-d '{
|
|
2411
|
-
"integration_name": "fluentcrm",
|
|
2412
|
-
"integration": "{\"name\":\"Add to List\",\"list_id\":1,\"enabled\":\"yes\"}"
|
|
2413
|
-
}'
|
|
2414
|
-
```
|
|
2415
|
-
|
|
2416
|
-
---
|
|
2417
|
-
|
|
2418
|
-
### Delete Product Integration
|
|
2419
|
-
|
|
2420
|
-
DELETE `/fluent-cart/v2/products/{product_id}/integrations/{integration_id}`
|
|
2421
|
-
|
|
2422
|
-
Delete a product integration feed.
|
|
2423
|
-
|
|
2424
|
-
- **Permission:** `products/delete`
|
|
2425
|
-
|
|
2426
|
-
#### Parameters
|
|
2427
|
-
|
|
2428
|
-
| Parameter | Type | Location | Required | Description |
|
|
2429
|
-
| --- | --- | --- | --- | --- |
|
|
2430
|
-
| `product_id` | integer | path | Yes | The product ID |
|
|
2431
|
-
| `integration_id` | integer | path | Yes | The integration feed ID to delete |
|
|
2432
|
-
|
|
2433
|
-
#### Response
|
|
2434
|
-
|
|
2435
|
-
```
|
|
2436
|
-
{
|
|
2437
|
-
"message": "Integration deleted successfully"
|
|
2438
|
-
}
|
|
2439
|
-
```
|
|
2440
|
-
|
|
2441
|
-
#### Example
|
|
2442
|
-
|
|
2443
|
-
```
|
|
2444
|
-
curl -X DELETE "https://example.com/wp-json/fluent-cart/v2/products/123/integrations/10" \
|
|
2445
|
-
-u "username:app_password"
|
|
2446
|
-
```
|
|
2447
|
-
|
|
2448
|
-
---
|
|
2449
|
-
|
|
2450
|
-
### Change Integration Status
|
|
2451
|
-
|
|
2452
|
-
POST `/fluent-cart/v2/products/{product_id}/integrations/feed/change-status`
|
|
2453
|
-
|
|
2454
|
-
Enable or disable a product integration feed.
|
|
2455
|
-
|
|
2456
|
-
- **Permission:** `products/edit`
|
|
2457
|
-
|
|
2458
|
-
#### Parameters
|
|
2459
|
-
|
|
2460
|
-
| Parameter | Type | Location | Required | Description |
|
|
2461
|
-
| --- | --- | --- | --- | --- |
|
|
2462
|
-
| `product_id` | integer | path | Yes | The product ID |
|
|
2463
|
-
| `notification_id` | integer | body | Yes | The integration feed ID |
|
|
2464
|
-
| `status` | string | body | Yes | `yes` to enable, `no` to disable |
|
|
2465
|
-
|
|
2466
|
-
#### Response
|
|
2467
|
-
|
|
2468
|
-
```
|
|
2469
|
-
{
|
|
2470
|
-
"message": "Integration status has been updated"
|
|
2471
|
-
}
|
|
2472
|
-
```
|
|
2473
|
-
|
|
2474
|
-
#### Example
|
|
2475
|
-
|
|
2476
|
-
```
|
|
2477
|
-
curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/123/integrations/feed/change-status" \
|
|
2478
|
-
-u "username:app_password" \
|
|
2479
|
-
-H "Content-Type: application/json" \
|
|
2480
|
-
-d '{
|
|
2481
|
-
"product_id": 123,
|
|
2482
|
-
"notification_id": 10,
|
|
2483
|
-
"status": "yes"
|
|
2484
|
-
}'
|
|
2485
|
-
```
|
|
1
|
+
# Products API
|
|
2
|
+
|
|
3
|
+
Manage your product catalog including creating products, managing variations, downloadable files, bundles, upgrade paths, tax/shipping classes, stock management, and product integrations.
|
|
4
|
+
|
|
5
|
+
**Base URL:** `https://your-site.com/wp-json/fluent-cart/v2/products`
|
|
6
|
+
|
|
7
|
+
**Policy:** `ProductPolicy`
|
|
8
|
+
|
|
9
|
+
> All monetary values are in **cents** (e.g., `$10.00` = `1000`).
|
|
10
|
+
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
## Product CRUD & Listing
|
|
14
|
+
|
|
15
|
+
### List Products
|
|
16
|
+
|
|
17
|
+
GET `/fluent-cart/v2/products`
|
|
18
|
+
|
|
19
|
+
Retrieve a paginated list of products with filtering, sorting, and search capabilities.
|
|
20
|
+
|
|
21
|
+
- **Permission:** `products/view`
|
|
22
|
+
|
|
23
|
+
#### Parameters
|
|
24
|
+
|
|
25
|
+
| Parameter | Type | Location | Required | Description |
|
|
26
|
+
| --- | --- | --- | --- | --- |
|
|
27
|
+
| `search` | string | query | No | Search by product title, ID, or variation title |
|
|
28
|
+
| `per_page` | integer | query | No | Number of results per page (default: `10`) |
|
|
29
|
+
| `page` | integer | query | No | Page number for pagination |
|
|
30
|
+
| `sort_by` | string | query | No | Column to sort by (default: `ID`) |
|
|
31
|
+
| `sort_type` | string | query | No | Sort direction: `asc` or `desc` (default: `desc`) |
|
|
32
|
+
| `active_view` | string | query | No | Filter tab: `publish`, `draft`, `physical`, `digital`, `subscribable`, `not_subscribable`, `bundle`, `non_bundle` |
|
|
33
|
+
| `filter_type` | string | query | No | `simple` or `advanced` |
|
|
34
|
+
| `with` | array | query | No | Relations to eager load |
|
|
35
|
+
| `search_groups` | array | query | No | Advanced filter groups for complex queries |
|
|
36
|
+
|
|
37
|
+
#### Response
|
|
38
|
+
|
|
39
|
+
```
|
|
40
|
+
{
|
|
41
|
+
"products": {
|
|
42
|
+
"total": 50,
|
|
43
|
+
"per_page": 10,
|
|
44
|
+
"current_page": 1,
|
|
45
|
+
"last_page": 5,
|
|
46
|
+
"data": [
|
|
47
|
+
{
|
|
48
|
+
"ID": 123,
|
|
49
|
+
"post_title": "Example Product",
|
|
50
|
+
"post_status": "publish",
|
|
51
|
+
"post_date": "2025-01-15 12:00:00",
|
|
52
|
+
"view_url": "https://example.com/product/example-product",
|
|
53
|
+
"edit_url": "https://example.com/wp-admin/admin.php?page=fluent-cart#/products/123"
|
|
54
|
+
}
|
|
55
|
+
]
|
|
56
|
+
}
|
|
57
|
+
}
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
#### Example
|
|
61
|
+
|
|
62
|
+
```
|
|
63
|
+
curl -X GET "https://example.com/wp-json/fluent-cart/v2/products?search=widget&per_page=20&active_view=publish" \
|
|
64
|
+
-u "username:app_password"
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
---
|
|
68
|
+
|
|
69
|
+
### Get Product
|
|
70
|
+
|
|
71
|
+
GET `/fluent-cart/v2/products/{product}`
|
|
72
|
+
|
|
73
|
+
Retrieve a single product by ID.
|
|
74
|
+
|
|
75
|
+
- **Permission:** `products/view`
|
|
76
|
+
|
|
77
|
+
#### Parameters
|
|
78
|
+
|
|
79
|
+
| Parameter | Type | Location | Required | Description |
|
|
80
|
+
| --- | --- | --- | --- | --- |
|
|
81
|
+
| `product` | integer | path | Yes | The product ID |
|
|
82
|
+
| `with` | array | query | No | Relations to eager load (e.g., `["detail", "variants", "product_menu"]`) |
|
|
83
|
+
|
|
84
|
+
#### Response
|
|
85
|
+
|
|
86
|
+
```
|
|
87
|
+
{
|
|
88
|
+
"product": {
|
|
89
|
+
"ID": 123,
|
|
90
|
+
"post_title": "Example Product",
|
|
91
|
+
"post_status": "publish",
|
|
92
|
+
"post_excerpt": "Short description",
|
|
93
|
+
"post_content": "Full description"
|
|
94
|
+
},
|
|
95
|
+
"product_menu": []
|
|
96
|
+
}
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
#### Example
|
|
100
|
+
|
|
101
|
+
```
|
|
102
|
+
curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/123?with[]=detail&with[]=variants" \
|
|
103
|
+
-u "username:app_password"
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
---
|
|
107
|
+
|
|
108
|
+
### Create Product
|
|
109
|
+
|
|
110
|
+
POST `/fluent-cart/v2/products`
|
|
111
|
+
|
|
112
|
+
Create a new product. A default variation is automatically created with the product.
|
|
113
|
+
|
|
114
|
+
- **Permission:** `products/create`
|
|
115
|
+
- **Request Class:** `ProductCreateRequest`
|
|
116
|
+
|
|
117
|
+
#### Parameters
|
|
118
|
+
|
|
119
|
+
| Parameter | Type | Location | Required | Description |
|
|
120
|
+
| --- | --- | --- | --- | --- |
|
|
121
|
+
| `post_title` | string | body | Yes | Product title (max 200 characters) |
|
|
122
|
+
| `post_status` | string | body | No | Post status (e.g., `draft`, `publish`) |
|
|
123
|
+
| `detail.fulfillment_type` | string | body | No | `physical` or `digital` (default: `digital`) |
|
|
124
|
+
| `detail.other_info.is_bundle_product` | string | body | No | `yes` or `no` (default: `no`) |
|
|
125
|
+
|
|
126
|
+
#### Response
|
|
127
|
+
|
|
128
|
+
```
|
|
129
|
+
{
|
|
130
|
+
"data": {
|
|
131
|
+
"ID": 124,
|
|
132
|
+
"variant": {
|
|
133
|
+
"id": 456,
|
|
134
|
+
"post_id": 124,
|
|
135
|
+
"variation_title": "Example Product",
|
|
136
|
+
"stock_status": "in-stock",
|
|
137
|
+
"payment_type": "onetime",
|
|
138
|
+
"total_stock": 1,
|
|
139
|
+
"available": 1,
|
|
140
|
+
"fulfillment_type": "digital"
|
|
141
|
+
},
|
|
142
|
+
"product_details": { ... }
|
|
143
|
+
},
|
|
144
|
+
"message": "Product has been created successfully"
|
|
145
|
+
}
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
#### Example
|
|
149
|
+
|
|
150
|
+
```
|
|
151
|
+
curl -X POST "https://example.com/wp-json/fluent-cart/v2/products" \
|
|
152
|
+
-u "username:app_password" \
|
|
153
|
+
-H "Content-Type: application/json" \
|
|
154
|
+
-d '{
|
|
155
|
+
"post_title": "New Digital Product",
|
|
156
|
+
"post_status": "draft",
|
|
157
|
+
"detail": {
|
|
158
|
+
"fulfillment_type": "digital"
|
|
159
|
+
}
|
|
160
|
+
}'
|
|
161
|
+
```
|
|
162
|
+
|
|
163
|
+
---
|
|
164
|
+
|
|
165
|
+
### Delete Product
|
|
166
|
+
|
|
167
|
+
DELETE `/fluent-cart/v2/products/{product}`
|
|
168
|
+
|
|
169
|
+
Delete a product and all associated data.
|
|
170
|
+
|
|
171
|
+
- **Permission:** `products/delete`
|
|
172
|
+
|
|
173
|
+
#### Parameters
|
|
174
|
+
|
|
175
|
+
| Parameter | Type | Location | Required | Description |
|
|
176
|
+
| --- | --- | --- | --- | --- |
|
|
177
|
+
| `product` | integer | path | Yes | The product ID to delete |
|
|
178
|
+
|
|
179
|
+
#### Response
|
|
180
|
+
|
|
181
|
+
```
|
|
182
|
+
{
|
|
183
|
+
"message": "Product deleted successfully"
|
|
184
|
+
}
|
|
185
|
+
```
|
|
186
|
+
|
|
187
|
+
#### Example
|
|
188
|
+
|
|
189
|
+
```
|
|
190
|
+
curl -X DELETE "https://example.com/wp-json/fluent-cart/v2/products/123" \
|
|
191
|
+
-u "username:app_password"
|
|
192
|
+
```
|
|
193
|
+
|
|
194
|
+
---
|
|
195
|
+
|
|
196
|
+
### Get Product Pricing
|
|
197
|
+
|
|
198
|
+
GET `/fluent-cart/v2/products/{productId}/pricing`
|
|
199
|
+
|
|
200
|
+
Retrieve the full product details including pricing, variants, downloadable files, and taxonomy information.
|
|
201
|
+
|
|
202
|
+
- **Permission:** `products/view`
|
|
203
|
+
|
|
204
|
+
#### Parameters
|
|
205
|
+
|
|
206
|
+
| Parameter | Type | Location | Required | Description |
|
|
207
|
+
| --- | --- | --- | --- | --- |
|
|
208
|
+
| `productId` | integer | path | Yes | The product ID |
|
|
209
|
+
| `with` | array | query | No | Additional relations (e.g., `["product_menu"]`) |
|
|
210
|
+
|
|
211
|
+
#### Response
|
|
212
|
+
|
|
213
|
+
```
|
|
214
|
+
{
|
|
215
|
+
"product": {
|
|
216
|
+
"ID": 123,
|
|
217
|
+
"post_title": "Example Product",
|
|
218
|
+
"post_status": "publish",
|
|
219
|
+
"post_excerpt": "Short description",
|
|
220
|
+
"featured_image_id": 456,
|
|
221
|
+
"view_url": "https://example.com/product/example",
|
|
222
|
+
"edit_url": "https://example.com/wp-admin/admin.php?page=fluent-cart#/products/123",
|
|
223
|
+
"detail": {
|
|
224
|
+
"id": 1,
|
|
225
|
+
"post_id": 123,
|
|
226
|
+
"fulfillment_type": "digital",
|
|
227
|
+
"variation_type": "simple",
|
|
228
|
+
"manage_stock": 0,
|
|
229
|
+
"manage_downloadable": 0,
|
|
230
|
+
"other_info": { ... }
|
|
231
|
+
},
|
|
232
|
+
"variants": [
|
|
233
|
+
{
|
|
234
|
+
"id": 789,
|
|
235
|
+
"post_id": 123,
|
|
236
|
+
"variation_title": "Default Plan",
|
|
237
|
+
"item_price": 1000,
|
|
238
|
+
"compare_price": 0,
|
|
239
|
+
"stock_status": "in-stock",
|
|
240
|
+
"other_info": { ... },
|
|
241
|
+
"media": []
|
|
242
|
+
}
|
|
243
|
+
],
|
|
244
|
+
"downloadable_files": []
|
|
245
|
+
},
|
|
246
|
+
"product_menu": "",
|
|
247
|
+
"taxonomies": [
|
|
248
|
+
{
|
|
249
|
+
"name": "product-categories",
|
|
250
|
+
"label": "Product Categories",
|
|
251
|
+
"terms": [],
|
|
252
|
+
"labels": { ... }
|
|
253
|
+
}
|
|
254
|
+
]
|
|
255
|
+
}
|
|
256
|
+
```
|
|
257
|
+
|
|
258
|
+
#### Example
|
|
259
|
+
|
|
260
|
+
```
|
|
261
|
+
curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/123/pricing?with[]=product_menu" \
|
|
262
|
+
-u "username:app_password"
|
|
263
|
+
```
|
|
264
|
+
|
|
265
|
+
---
|
|
266
|
+
|
|
267
|
+
### Update Product Pricing
|
|
268
|
+
|
|
269
|
+
POST `/fluent-cart/v2/products/{postId}/pricing`
|
|
270
|
+
|
|
271
|
+
Update a product's pricing, details, variants, and other metadata.
|
|
272
|
+
|
|
273
|
+
- **Permission:** `products/edit`
|
|
274
|
+
- **Request Class:** `ProductUpdateRequest`
|
|
275
|
+
|
|
276
|
+
#### Parameters
|
|
277
|
+
|
|
278
|
+
| Parameter | Type | Location | Required | Description |
|
|
279
|
+
| --- | --- | --- | --- | --- |
|
|
280
|
+
| `postId` | integer | path | Yes | The product post ID |
|
|
281
|
+
| `post_title` | string | body | Yes | Product title (max 200 characters) |
|
|
282
|
+
| `post_status` | string | body | Yes | Status: `draft`, `publish`, `future` |
|
|
283
|
+
| `post_date` | string | body | Conditional | Required when `post_status` is `future`. Must be a future date (GMT) |
|
|
284
|
+
| `post_excerpt` | string | body | No | Product short description (limited by `excerpt_length` filter, default 55 words) |
|
|
285
|
+
| `post_content` | string | body | No | Product long description (HTML allowed) |
|
|
286
|
+
| `post_name` | string | body | No | Product URL slug |
|
|
287
|
+
| `comment_status` | string | body | No | Comment status (max 100 chars) |
|
|
288
|
+
| `detail.fulfillment_type` | string | body | Yes | `physical` or `digital` |
|
|
289
|
+
| `detail.variation_type` | string | body | Yes | `simple` or `simple_variations` |
|
|
290
|
+
| `detail.manage_stock` | integer | body | No | `0` or `1` |
|
|
291
|
+
| `detail.manage_downloadable` | integer | body | No | `0` or `1` |
|
|
292
|
+
| `detail.default_variation_id` | integer | body | No | Default variation ID |
|
|
293
|
+
| `detail.stock_availability` | string | body | No | Stock availability status |
|
|
294
|
+
| `detail.other_info.group_pricing_by` | string | body | No | `payment_type`, `repeat_interval`, or `none` |
|
|
295
|
+
| `detail.other_info.sold_individually` | string | body | No | `yes` or `no` |
|
|
296
|
+
| `detail.other_info.use_pricing_table` | string | body | No | Enable pricing table display |
|
|
297
|
+
| `detail.other_info.shipping_class` | integer | body | No | Shipping class ID (validated) |
|
|
298
|
+
| `detail.other_info.tax_class` | integer | body | No | Tax class ID (validated) |
|
|
299
|
+
| `detail.other_info.active_editor` | string | body | No | Active editor mode |
|
|
300
|
+
| `variants` | array | body | Conditional | Array of variant objects (required for `simple` type when publishing) |
|
|
301
|
+
| `variants.*.variation_title` | string | body | Yes | Variation title (max 200 chars) |
|
|
302
|
+
| `variants.*.post_id` | integer | body | Yes | Parent product post ID |
|
|
303
|
+
| `variants.*.item_price` | number | body | No | Price in cents (min: 0) |
|
|
304
|
+
| `variants.*.compare_price` | number | body | No | Compare-at price in cents (must be >= `item_price`) |
|
|
305
|
+
| `variants.*.manage_cost` | string | body | No | Enable cost tracking |
|
|
306
|
+
| `variants.*.item_cost` | number | body | Conditional | Required if `manage_cost` is `true` |
|
|
307
|
+
| `variants.*.serial_index` | integer | body | No | Display order index |
|
|
308
|
+
| `variants.*.sku` | string | body | No | SKU (max 30 chars, must be unique) |
|
|
309
|
+
| `variants.*.fulfillment_type` | string | body | No | `physical` or `digital` |
|
|
310
|
+
| `variants.*.other_info.payment_type` | string | body | Yes | `onetime` or `subscription` |
|
|
311
|
+
| `variants.*.other_info.description` | string | body | No | Variant description (max 255 chars) |
|
|
312
|
+
| `variants.*.other_info.repeat_interval` | string | body | Conditional | Required for subscriptions. e.g., `monthly`, `yearly` |
|
|
313
|
+
| `variants.*.other_info.times` | string | body | No | Number of billing cycles |
|
|
314
|
+
| `variants.*.other_info.trial_days` | string | body | No | Trial period in days (max 365) |
|
|
315
|
+
| `variants.*.other_info.billing_summary` | string | body | No | Billing summary text (max 255 chars) |
|
|
316
|
+
| `variants.*.other_info.manage_setup_fee` | string | body | Conditional | Required for subscriptions: `yes` or `no` |
|
|
317
|
+
| `variants.*.other_info.signup_fee` | number | body | Conditional | Setup fee in cents. Required if `manage_setup_fee` is `yes` |
|
|
318
|
+
| `variants.*.other_info.signup_fee_name` | string | body | Conditional | Setup fee label (max 100 chars). Required if `manage_setup_fee` is `yes` |
|
|
319
|
+
| `variants.*.other_info.installment` | string | body | No | Enable installment: `yes` or `no` |
|
|
320
|
+
| `product_terms` | object | body | No | Taxonomy term IDs (e.g., `{"product-categories": [1, 2]}`) |
|
|
321
|
+
| `gallery` | array | body | No | Gallery images array with `id`, `url`, `title` |
|
|
322
|
+
| `metaValue` | mixed | body | No | Additional metadata |
|
|
323
|
+
|
|
324
|
+
#### Response
|
|
325
|
+
|
|
326
|
+
```
|
|
327
|
+
{
|
|
328
|
+
"data": { ... },
|
|
329
|
+
"message": "Product updated successfully"
|
|
330
|
+
}
|
|
331
|
+
```
|
|
332
|
+
|
|
333
|
+
#### Example
|
|
334
|
+
|
|
335
|
+
```
|
|
336
|
+
curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/123/pricing" \
|
|
337
|
+
-u "username:app_password" \
|
|
338
|
+
-H "Content-Type: application/json" \
|
|
339
|
+
-d '{
|
|
340
|
+
"post_title": "Updated Product",
|
|
341
|
+
"post_status": "publish",
|
|
342
|
+
"detail": {
|
|
343
|
+
"fulfillment_type": "digital",
|
|
344
|
+
"variation_type": "simple"
|
|
345
|
+
},
|
|
346
|
+
"variants": [
|
|
347
|
+
{
|
|
348
|
+
"id": 789,
|
|
349
|
+
"post_id": 123,
|
|
350
|
+
"variation_title": "Default Plan",
|
|
351
|
+
"item_price": 1999,
|
|
352
|
+
"other_info": {
|
|
353
|
+
"payment_type": "onetime"
|
|
354
|
+
}
|
|
355
|
+
}
|
|
356
|
+
]
|
|
357
|
+
}'
|
|
358
|
+
```
|
|
359
|
+
|
|
360
|
+
---
|
|
361
|
+
|
|
362
|
+
## Product Search & Lookup
|
|
363
|
+
|
|
364
|
+
### Search Products by Name
|
|
365
|
+
|
|
366
|
+
GET `/fluent-cart/v2/products/searchProductByName`
|
|
367
|
+
|
|
368
|
+
Search for published products by name. Returns products formatted for select dropdowns.
|
|
369
|
+
|
|
370
|
+
- **Permission:** `products/view`
|
|
371
|
+
|
|
372
|
+
#### Parameters
|
|
373
|
+
|
|
374
|
+
| Parameter | Type | Location | Required | Description |
|
|
375
|
+
| --- | --- | --- | --- | --- |
|
|
376
|
+
| `name` | string | query | No | Product name to search for |
|
|
377
|
+
| `url_mode` | string | query | No | URL mode flag |
|
|
378
|
+
| `termId` | integer | query | No | Filter by taxonomy term ID (product-categories) |
|
|
379
|
+
|
|
380
|
+
#### Response
|
|
381
|
+
|
|
382
|
+
```
|
|
383
|
+
{
|
|
384
|
+
"products": [
|
|
385
|
+
{
|
|
386
|
+
"ID": 123,
|
|
387
|
+
"post_title": "Example Product",
|
|
388
|
+
"wpTerms": [...]
|
|
389
|
+
}
|
|
390
|
+
]
|
|
391
|
+
}
|
|
392
|
+
```
|
|
393
|
+
|
|
394
|
+
#### Example
|
|
395
|
+
|
|
396
|
+
```
|
|
397
|
+
curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/searchProductByName?name=widget" \
|
|
398
|
+
-u "username:app_password"
|
|
399
|
+
```
|
|
400
|
+
|
|
401
|
+
---
|
|
402
|
+
|
|
403
|
+
### Search Variants by Name
|
|
404
|
+
|
|
405
|
+
GET `/fluent-cart/v2/products/searchVariantByName`
|
|
406
|
+
|
|
407
|
+
Search for published product variants by name. Returns a hierarchical product > variants structure.
|
|
408
|
+
|
|
409
|
+
- **Permission:** `products/view`
|
|
410
|
+
|
|
411
|
+
#### Parameters
|
|
412
|
+
|
|
413
|
+
| Parameter | Type | Location | Required | Description |
|
|
414
|
+
| --- | --- | --- | --- | --- |
|
|
415
|
+
| `name` | string | query | No | Product/variant name to search |
|
|
416
|
+
| `search` | string | query | No | Alternative search parameter (used if `name` is empty) |
|
|
417
|
+
| `ids` | array | query | No | Array of product IDs to include |
|
|
418
|
+
|
|
419
|
+
#### Response
|
|
420
|
+
|
|
421
|
+
```
|
|
422
|
+
[
|
|
423
|
+
{
|
|
424
|
+
"value": 123,
|
|
425
|
+
"label": "Example Product",
|
|
426
|
+
"children": [
|
|
427
|
+
{
|
|
428
|
+
"value": 456,
|
|
429
|
+
"label": "Monthly Plan"
|
|
430
|
+
},
|
|
431
|
+
{
|
|
432
|
+
"value": 457,
|
|
433
|
+
"label": "Yearly Plan"
|
|
434
|
+
}
|
|
435
|
+
]
|
|
436
|
+
}
|
|
437
|
+
]
|
|
438
|
+
```
|
|
439
|
+
|
|
440
|
+
#### Example
|
|
441
|
+
|
|
442
|
+
```
|
|
443
|
+
curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/searchVariantByName?name=pro" \
|
|
444
|
+
-u "username:app_password"
|
|
445
|
+
```
|
|
446
|
+
|
|
447
|
+
---
|
|
448
|
+
|
|
449
|
+
### Search Product Variant Options
|
|
450
|
+
|
|
451
|
+
GET `/fluent-cart/v2/products/search-product-variant-options`
|
|
452
|
+
|
|
453
|
+
Search for product variants suitable for selection (e.g., in order creation). Filters out out-of-stock items.
|
|
454
|
+
|
|
455
|
+
- **Permission:** `products/view`
|
|
456
|
+
|
|
457
|
+
#### Parameters
|
|
458
|
+
|
|
459
|
+
| Parameter | Type | Location | Required | Description |
|
|
460
|
+
| --- | --- | --- | --- | --- |
|
|
461
|
+
| `search` | string | query | No | Search term for product/variant title |
|
|
462
|
+
| `include_ids` | array | query | No | Variation IDs to always include in results |
|
|
463
|
+
| `scopes` | array | query | No | Model scopes to apply |
|
|
464
|
+
| `subscription_status` | string | query | No | `not_subscribable` to exclude subscription variants |
|
|
465
|
+
|
|
466
|
+
#### Response
|
|
467
|
+
|
|
468
|
+
```
|
|
469
|
+
{
|
|
470
|
+
"products": [
|
|
471
|
+
{
|
|
472
|
+
"value": "product_123",
|
|
473
|
+
"label": "Example Product",
|
|
474
|
+
"children": [
|
|
475
|
+
{
|
|
476
|
+
"value": 456,
|
|
477
|
+
"label": "Monthly Plan"
|
|
478
|
+
}
|
|
479
|
+
]
|
|
480
|
+
}
|
|
481
|
+
]
|
|
482
|
+
}
|
|
483
|
+
```
|
|
484
|
+
|
|
485
|
+
#### Example
|
|
486
|
+
|
|
487
|
+
```
|
|
488
|
+
curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/search-product-variant-options?search=pro&subscription_status=not_subscribable" \
|
|
489
|
+
-u "username:app_password"
|
|
490
|
+
```
|
|
491
|
+
|
|
492
|
+
---
|
|
493
|
+
|
|
494
|
+
### Find Subscription Variants
|
|
495
|
+
|
|
496
|
+
GET `/fluent-cart/v2/products/findSubscriptionVariants`
|
|
497
|
+
|
|
498
|
+
Search for product variants that have a subscription payment type.
|
|
499
|
+
|
|
500
|
+
- **Permission:** `products/view`
|
|
501
|
+
|
|
502
|
+
#### Parameters
|
|
503
|
+
|
|
504
|
+
| Parameter | Type | Location | Required | Description |
|
|
505
|
+
| --- | --- | --- | --- | --- |
|
|
506
|
+
| `name` | string | query | No | Variant title to search |
|
|
507
|
+
|
|
508
|
+
#### Response
|
|
509
|
+
|
|
510
|
+
```
|
|
511
|
+
[
|
|
512
|
+
{
|
|
513
|
+
"id": 456,
|
|
514
|
+
"title": "Monthly Subscription"
|
|
515
|
+
},
|
|
516
|
+
{
|
|
517
|
+
"id": 457,
|
|
518
|
+
"title": "Yearly Subscription"
|
|
519
|
+
}
|
|
520
|
+
]
|
|
521
|
+
```
|
|
522
|
+
|
|
523
|
+
#### Example
|
|
524
|
+
|
|
525
|
+
```
|
|
526
|
+
curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/findSubscriptionVariants?name=monthly" \
|
|
527
|
+
-u "username:app_password"
|
|
528
|
+
```
|
|
529
|
+
|
|
530
|
+
---
|
|
531
|
+
|
|
532
|
+
### Fetch Products by IDs
|
|
533
|
+
|
|
534
|
+
GET `/fluent-cart/v2/products/fetchProductsByIds`
|
|
535
|
+
|
|
536
|
+
Retrieve products by an array of IDs. Returns products with their detail relation.
|
|
537
|
+
|
|
538
|
+
- **Permission:** `products/view`
|
|
539
|
+
|
|
540
|
+
#### Parameters
|
|
541
|
+
|
|
542
|
+
| Parameter | Type | Location | Required | Description |
|
|
543
|
+
| --- | --- | --- | --- | --- |
|
|
544
|
+
| `productIds` | array | query | Yes | Array of product IDs to fetch |
|
|
545
|
+
|
|
546
|
+
#### Response
|
|
547
|
+
|
|
548
|
+
```
|
|
549
|
+
{
|
|
550
|
+
"products": [
|
|
551
|
+
{
|
|
552
|
+
"ID": 123,
|
|
553
|
+
"post_title": "Example Product",
|
|
554
|
+
"detail": { ... }
|
|
555
|
+
}
|
|
556
|
+
]
|
|
557
|
+
}
|
|
558
|
+
```
|
|
559
|
+
|
|
560
|
+
#### Example
|
|
561
|
+
|
|
562
|
+
```
|
|
563
|
+
curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/fetchProductsByIds?productIds[]=123&productIds[]=456" \
|
|
564
|
+
-u "username:app_password"
|
|
565
|
+
```
|
|
566
|
+
|
|
567
|
+
---
|
|
568
|
+
|
|
569
|
+
### Fetch Variations by IDs
|
|
570
|
+
|
|
571
|
+
GET `/fluent-cart/v2/products/fetchVariationsByIds`
|
|
572
|
+
|
|
573
|
+
Retrieve variations by an array of IDs. Returns simplified label/value pairs.
|
|
574
|
+
|
|
575
|
+
- **Permission:** `products/view`
|
|
576
|
+
|
|
577
|
+
#### Parameters
|
|
578
|
+
|
|
579
|
+
| Parameter | Type | Location | Required | Description |
|
|
580
|
+
| --- | --- | --- | --- | --- |
|
|
581
|
+
| `productIds` | array | query | Yes | Array of variation IDs to fetch |
|
|
582
|
+
|
|
583
|
+
#### Response
|
|
584
|
+
|
|
585
|
+
```
|
|
586
|
+
{
|
|
587
|
+
"products": [
|
|
588
|
+
{
|
|
589
|
+
"value": 456,
|
|
590
|
+
"label": "Monthly Plan"
|
|
591
|
+
},
|
|
592
|
+
{
|
|
593
|
+
"value": 457,
|
|
594
|
+
"label": "Yearly Plan"
|
|
595
|
+
}
|
|
596
|
+
]
|
|
597
|
+
}
|
|
598
|
+
```
|
|
599
|
+
|
|
600
|
+
#### Example
|
|
601
|
+
|
|
602
|
+
```
|
|
603
|
+
curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/fetchVariationsByIds?productIds[]=456&productIds[]=457" \
|
|
604
|
+
-u "username:app_password"
|
|
605
|
+
```
|
|
606
|
+
|
|
607
|
+
---
|
|
608
|
+
|
|
609
|
+
### Suggest SKU
|
|
610
|
+
|
|
611
|
+
GET `/fluent-cart/v2/products/suggest-sku`
|
|
612
|
+
|
|
613
|
+
Generate a unique SKU suggestion based on product and variant titles.
|
|
614
|
+
|
|
615
|
+
- **Permission:** `products/view`
|
|
616
|
+
|
|
617
|
+
#### Parameters
|
|
618
|
+
|
|
619
|
+
| Parameter | Type | Location | Required | Description |
|
|
620
|
+
| --- | --- | --- | --- | --- |
|
|
621
|
+
| `title` | string | query | Yes | Product title to base SKU on |
|
|
622
|
+
| `variant_title` | string | query | No | Variant title to include in SKU |
|
|
623
|
+
| `exclude_id` | integer | query | No | Variation ID to exclude from uniqueness check |
|
|
624
|
+
|
|
625
|
+
#### Response
|
|
626
|
+
|
|
627
|
+
```
|
|
628
|
+
{
|
|
629
|
+
"sku": "EXA-PRO-MON"
|
|
630
|
+
}
|
|
631
|
+
```
|
|
632
|
+
|
|
633
|
+
#### Example
|
|
634
|
+
|
|
635
|
+
```
|
|
636
|
+
curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/suggest-sku?title=Example%20Product&variant_title=Monthly" \
|
|
637
|
+
-u "username:app_password"
|
|
638
|
+
```
|
|
639
|
+
|
|
640
|
+
---
|
|
641
|
+
|
|
642
|
+
### Get Max Excerpt Word Count
|
|
643
|
+
|
|
644
|
+
GET `/fluent-cart/v2/products/get-max-excerpt-word-count`
|
|
645
|
+
|
|
646
|
+
Returns the maximum allowed word count for product excerpts (controlled by the WordPress `excerpt_length` filter).
|
|
647
|
+
|
|
648
|
+
- **Permission:** `products/view`
|
|
649
|
+
|
|
650
|
+
#### Parameters
|
|
651
|
+
|
|
652
|
+
None.
|
|
653
|
+
|
|
654
|
+
#### Response
|
|
655
|
+
|
|
656
|
+
```
|
|
657
|
+
{
|
|
658
|
+
"count": 55
|
|
659
|
+
}
|
|
660
|
+
```
|
|
661
|
+
|
|
662
|
+
#### Example
|
|
663
|
+
|
|
664
|
+
```
|
|
665
|
+
curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/get-max-excerpt-word-count" \
|
|
666
|
+
-u "username:app_password"
|
|
667
|
+
```
|
|
668
|
+
|
|
669
|
+
---
|
|
670
|
+
|
|
671
|
+
### Fetch Taxonomy Terms
|
|
672
|
+
|
|
673
|
+
GET `/fluent-cart/v2/products/fetch-term`
|
|
674
|
+
|
|
675
|
+
Retrieve all registered taxonomies and their terms for product categorization.
|
|
676
|
+
|
|
677
|
+
- **Permission:** `products/view`
|
|
678
|
+
|
|
679
|
+
#### Parameters
|
|
680
|
+
|
|
681
|
+
None.
|
|
682
|
+
|
|
683
|
+
#### Response
|
|
684
|
+
|
|
685
|
+
```
|
|
686
|
+
{
|
|
687
|
+
"taxonomies": [
|
|
688
|
+
{
|
|
689
|
+
"name": "product-categories",
|
|
690
|
+
"label": "Product Categories",
|
|
691
|
+
"terms": [
|
|
692
|
+
{
|
|
693
|
+
"value": 1,
|
|
694
|
+
"label": "Software",
|
|
695
|
+
"children": []
|
|
696
|
+
}
|
|
697
|
+
]
|
|
698
|
+
},
|
|
699
|
+
{
|
|
700
|
+
"name": "product-brands",
|
|
701
|
+
"label": "Product Brands",
|
|
702
|
+
"terms": []
|
|
703
|
+
}
|
|
704
|
+
]
|
|
705
|
+
}
|
|
706
|
+
```
|
|
707
|
+
|
|
708
|
+
#### Example
|
|
709
|
+
|
|
710
|
+
```
|
|
711
|
+
curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/fetch-term" \
|
|
712
|
+
-u "username:app_password"
|
|
713
|
+
```
|
|
714
|
+
|
|
715
|
+
---
|
|
716
|
+
|
|
717
|
+
### Fetch Terms by Parent
|
|
718
|
+
|
|
719
|
+
POST `/fluent-cart/v2/products/fetch-term-by-parent`
|
|
720
|
+
|
|
721
|
+
Retrieve taxonomy terms filtered by parent term IDs.
|
|
722
|
+
|
|
723
|
+
- **Permission:** `products/view`
|
|
724
|
+
|
|
725
|
+
#### Parameters
|
|
726
|
+
|
|
727
|
+
| Parameter | Type | Location | Required | Description |
|
|
728
|
+
| --- | --- | --- | --- | --- |
|
|
729
|
+
| `parents` | array | body | Yes | Array of parent term IDs |
|
|
730
|
+
| `listeners` | array | body | Yes | Array of taxonomy names to retrieve terms for |
|
|
731
|
+
|
|
732
|
+
#### Response
|
|
733
|
+
|
|
734
|
+
```
|
|
735
|
+
{
|
|
736
|
+
"data": {
|
|
737
|
+
"product-categories": [
|
|
738
|
+
{
|
|
739
|
+
"value": 5,
|
|
740
|
+
"label": "Sub Category"
|
|
741
|
+
}
|
|
742
|
+
]
|
|
743
|
+
}
|
|
744
|
+
}
|
|
745
|
+
```
|
|
746
|
+
|
|
747
|
+
#### Example
|
|
748
|
+
|
|
749
|
+
```
|
|
750
|
+
curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/fetch-term-by-parent" \
|
|
751
|
+
-u "username:app_password" \
|
|
752
|
+
-H "Content-Type: application/json" \
|
|
753
|
+
-d '{
|
|
754
|
+
"parents": [1, 2],
|
|
755
|
+
"listeners": ["product-categories"]
|
|
756
|
+
}'
|
|
757
|
+
```
|
|
758
|
+
|
|
759
|
+
---
|
|
760
|
+
|
|
761
|
+
## Bulk Operations
|
|
762
|
+
|
|
763
|
+
### Bulk Insert Products
|
|
764
|
+
|
|
765
|
+
POST `/fluent-cart/v2/products/bulk-insert`
|
|
766
|
+
|
|
767
|
+
Insert multiple products at once. Maximum 10 products per request.
|
|
768
|
+
|
|
769
|
+
- **Permission:** `products/create`
|
|
770
|
+
|
|
771
|
+
#### Parameters
|
|
772
|
+
|
|
773
|
+
| Parameter | Type | Location | Required | Description |
|
|
774
|
+
| --- | --- | --- | --- | --- |
|
|
775
|
+
| `products` | array | body | Yes | Array of product data objects (max 10) |
|
|
776
|
+
|
|
777
|
+
#### Response
|
|
778
|
+
|
|
779
|
+
```
|
|
780
|
+
{
|
|
781
|
+
"message": "3 product(s) created successfully",
|
|
782
|
+
"created": [ ... ],
|
|
783
|
+
"errors": []
|
|
784
|
+
}
|
|
785
|
+
```
|
|
786
|
+
|
|
787
|
+
#### Example
|
|
788
|
+
|
|
789
|
+
```
|
|
790
|
+
curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/bulk-insert" \
|
|
791
|
+
-u "username:app_password" \
|
|
792
|
+
-H "Content-Type: application/json" \
|
|
793
|
+
-d '{
|
|
794
|
+
"products": [
|
|
795
|
+
{
|
|
796
|
+
"post_title": "Product A",
|
|
797
|
+
"detail": { "fulfillment_type": "digital" }
|
|
798
|
+
},
|
|
799
|
+
{
|
|
800
|
+
"post_title": "Product B",
|
|
801
|
+
"detail": { "fulfillment_type": "physical" }
|
|
802
|
+
}
|
|
803
|
+
]
|
|
804
|
+
}'
|
|
805
|
+
```
|
|
806
|
+
|
|
807
|
+
---
|
|
808
|
+
|
|
809
|
+
### Bulk Edit Fetch
|
|
810
|
+
|
|
811
|
+
GET `/fluent-cart/v2/products/bulk-edit-data`
|
|
812
|
+
|
|
813
|
+
Fetch products formatted for the bulk editing spreadsheet view.
|
|
814
|
+
|
|
815
|
+
- **Permission:** `products/edit`
|
|
816
|
+
|
|
817
|
+
#### Parameters
|
|
818
|
+
|
|
819
|
+
Standard filter parameters (see [List Products](#list-products)).
|
|
820
|
+
|
|
821
|
+
#### Response
|
|
822
|
+
|
|
823
|
+
```
|
|
824
|
+
{
|
|
825
|
+
"products": [ ... ],
|
|
826
|
+
"columns": [ ... ]
|
|
827
|
+
}
|
|
828
|
+
```
|
|
829
|
+
|
|
830
|
+
#### Example
|
|
831
|
+
|
|
832
|
+
```
|
|
833
|
+
curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/bulk-edit-data" \
|
|
834
|
+
-u "username:app_password"
|
|
835
|
+
```
|
|
836
|
+
|
|
837
|
+
---
|
|
838
|
+
|
|
839
|
+
### Bulk Update Products
|
|
840
|
+
|
|
841
|
+
POST `/fluent-cart/v2/products/bulk-update`
|
|
842
|
+
|
|
843
|
+
Update multiple products at once from the bulk edit view. Maximum 10 products per request.
|
|
844
|
+
|
|
845
|
+
- **Permission:** `products/edit`
|
|
846
|
+
|
|
847
|
+
#### Parameters
|
|
848
|
+
|
|
849
|
+
| Parameter | Type | Location | Required | Description |
|
|
850
|
+
| --- | --- | --- | --- | --- |
|
|
851
|
+
| `products` | array | body | Yes | Array of product data objects to update (max 10) |
|
|
852
|
+
|
|
853
|
+
#### Response
|
|
854
|
+
|
|
855
|
+
```
|
|
856
|
+
{
|
|
857
|
+
"message": "3 product(s) updated successfully",
|
|
858
|
+
"updated": [ ... ],
|
|
859
|
+
"errors": []
|
|
860
|
+
}
|
|
861
|
+
```
|
|
862
|
+
|
|
863
|
+
#### Example
|
|
864
|
+
|
|
865
|
+
```
|
|
866
|
+
curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/bulk-update" \
|
|
867
|
+
-u "username:app_password" \
|
|
868
|
+
-H "Content-Type: application/json" \
|
|
869
|
+
-d '{
|
|
870
|
+
"products": [
|
|
871
|
+
{
|
|
872
|
+
"ID": 123,
|
|
873
|
+
"post_title": "Updated Title A"
|
|
874
|
+
}
|
|
875
|
+
]
|
|
876
|
+
}'
|
|
877
|
+
```
|
|
878
|
+
|
|
879
|
+
---
|
|
880
|
+
|
|
881
|
+
### Do Bulk Action
|
|
882
|
+
|
|
883
|
+
POST `/fluent-cart/v2/products/do-bulk-action`
|
|
884
|
+
|
|
885
|
+
Perform bulk actions on selected products (e.g., publish, draft, delete).
|
|
886
|
+
|
|
887
|
+
- **Permission:** `products/edit`
|
|
888
|
+
|
|
889
|
+
#### Parameters
|
|
890
|
+
|
|
891
|
+
| Parameter | Type | Location | Required | Description |
|
|
892
|
+
| --- | --- | --- | --- | --- |
|
|
893
|
+
| `action` | string | body | Yes | The bulk action to perform |
|
|
894
|
+
| `product_ids` | array | body | Yes | Array of product IDs to act on |
|
|
895
|
+
|
|
896
|
+
#### Response
|
|
897
|
+
|
|
898
|
+
```
|
|
899
|
+
{
|
|
900
|
+
"message": "Bulk action completed successfully"
|
|
901
|
+
}
|
|
902
|
+
```
|
|
903
|
+
|
|
904
|
+
#### Example
|
|
905
|
+
|
|
906
|
+
```
|
|
907
|
+
curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/do-bulk-action" \
|
|
908
|
+
-u "username:app_password" \
|
|
909
|
+
-H "Content-Type: application/json" \
|
|
910
|
+
-d '{
|
|
911
|
+
"action": "publish",
|
|
912
|
+
"product_ids": [123, 456, 789]
|
|
913
|
+
}'
|
|
914
|
+
```
|
|
915
|
+
|
|
916
|
+
---
|
|
917
|
+
|
|
918
|
+
### Create Dummy Products
|
|
919
|
+
|
|
920
|
+
POST `/fluent-cart/v2/products/create-dummy`
|
|
921
|
+
|
|
922
|
+
Create sample/demo products for testing or onboarding purposes.
|
|
923
|
+
|
|
924
|
+
- **Permission:** `products/create`
|
|
925
|
+
|
|
926
|
+
#### Parameters
|
|
927
|
+
|
|
928
|
+
| Parameter | Type | Location | Required | Description |
|
|
929
|
+
| --- | --- | --- | --- | --- |
|
|
930
|
+
| `category` | string | body | No | Product category for dummy products |
|
|
931
|
+
| `index` | integer | body | No | Index for dummy product generation |
|
|
932
|
+
|
|
933
|
+
#### Response
|
|
934
|
+
|
|
935
|
+
Returns the created dummy product data.
|
|
936
|
+
|
|
937
|
+
#### Example
|
|
938
|
+
|
|
939
|
+
```
|
|
940
|
+
curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/create-dummy" \
|
|
941
|
+
-u "username:app_password" \
|
|
942
|
+
-H "Content-Type: application/json" \
|
|
943
|
+
-d '{
|
|
944
|
+
"category": "digital",
|
|
945
|
+
"index": 1
|
|
946
|
+
}'
|
|
947
|
+
```
|
|
948
|
+
|
|
949
|
+
---
|
|
950
|
+
|
|
951
|
+
## Product Details & Configuration
|
|
952
|
+
|
|
953
|
+
### Duplicate Product
|
|
954
|
+
|
|
955
|
+
POST `/fluent-cart/v2/products/{productId}/duplicate`
|
|
956
|
+
|
|
957
|
+
Duplicate a product with options to include or exclude certain settings. The new product is saved as a draft.
|
|
958
|
+
|
|
959
|
+
- **Permission:** `products/create`
|
|
960
|
+
|
|
961
|
+
#### Parameters
|
|
962
|
+
|
|
963
|
+
| Parameter | Type | Location | Required | Description |
|
|
964
|
+
| --- | --- | --- | --- | --- |
|
|
965
|
+
| `productId` | integer | path | Yes | The product ID to duplicate |
|
|
966
|
+
| `import_stock_management` | string | body | No | Include stock management settings (`true`/`false`) |
|
|
967
|
+
| `import_license_settings` | string | body | No | Include license settings (`true`/`false`) |
|
|
968
|
+
| `import_downloadable_files` | string | body | No | Include downloadable files (`true`/`false`) |
|
|
969
|
+
|
|
970
|
+
#### Response
|
|
971
|
+
|
|
972
|
+
```
|
|
973
|
+
{
|
|
974
|
+
"product_id": 125,
|
|
975
|
+
"message": "Product duplicated successfully. The new product has been saved as a draft."
|
|
976
|
+
}
|
|
977
|
+
```
|
|
978
|
+
|
|
979
|
+
#### Example
|
|
980
|
+
|
|
981
|
+
```
|
|
982
|
+
curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/123/duplicate" \
|
|
983
|
+
-u "username:app_password" \
|
|
984
|
+
-H "Content-Type: application/json" \
|
|
985
|
+
-d '{
|
|
986
|
+
"import_stock_management": "true",
|
|
987
|
+
"import_license_settings": "true",
|
|
988
|
+
"import_downloadable_files": "false"
|
|
989
|
+
}'
|
|
990
|
+
```
|
|
991
|
+
|
|
992
|
+
---
|
|
993
|
+
|
|
994
|
+
### Get Related Products
|
|
995
|
+
|
|
996
|
+
GET `/fluent-cart/v2/products/{productId}/related-products`
|
|
997
|
+
|
|
998
|
+
Retrieve products related to a given product based on shared categories or brands.
|
|
999
|
+
|
|
1000
|
+
- **Permission:** `products/view`
|
|
1001
|
+
|
|
1002
|
+
#### Parameters
|
|
1003
|
+
|
|
1004
|
+
| Parameter | Type | Location | Required | Description |
|
|
1005
|
+
| --- | --- | --- | --- | --- |
|
|
1006
|
+
| `productId` | integer | path | Yes | The product ID |
|
|
1007
|
+
| `related_by_categories` | boolean | query | No | Include products from same categories |
|
|
1008
|
+
| `related_by_brands` | boolean | query | No | Include products from same brands |
|
|
1009
|
+
| `order_by` | string | query | No | Sort order (default: `title_asc`) |
|
|
1010
|
+
| `posts_per_page` | integer | query | No | Number of related products to return (default: `6`) |
|
|
1011
|
+
|
|
1012
|
+
#### Response
|
|
1013
|
+
|
|
1014
|
+
```
|
|
1015
|
+
{
|
|
1016
|
+
"products": [
|
|
1017
|
+
{
|
|
1018
|
+
"ID": 456,
|
|
1019
|
+
"post_title": "Related Product",
|
|
1020
|
+
"post_status": "publish"
|
|
1021
|
+
}
|
|
1022
|
+
]
|
|
1023
|
+
}
|
|
1024
|
+
```
|
|
1025
|
+
|
|
1026
|
+
#### Example
|
|
1027
|
+
|
|
1028
|
+
```
|
|
1029
|
+
curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/123/related-products?related_by_categories=true&posts_per_page=4" \
|
|
1030
|
+
-u "username:app_password"
|
|
1031
|
+
```
|
|
1032
|
+
|
|
1033
|
+
---
|
|
1034
|
+
|
|
1035
|
+
### Update Long Description Editor Mode
|
|
1036
|
+
|
|
1037
|
+
POST `/fluent-cart/v2/products/{postId}/update-long-desc-editor-mode`
|
|
1038
|
+
|
|
1039
|
+
Switch the long description editor between modes (e.g., visual, code).
|
|
1040
|
+
|
|
1041
|
+
- **Permission:** `products/edit`
|
|
1042
|
+
|
|
1043
|
+
#### Parameters
|
|
1044
|
+
|
|
1045
|
+
| Parameter | Type | Location | Required | Description |
|
|
1046
|
+
| --- | --- | --- | --- | --- |
|
|
1047
|
+
| `postId` | integer | path | Yes | The product post ID |
|
|
1048
|
+
| `active_editor` | string | body | Yes | The editor mode to set |
|
|
1049
|
+
|
|
1050
|
+
#### Response
|
|
1051
|
+
|
|
1052
|
+
```
|
|
1053
|
+
{
|
|
1054
|
+
"message": "Editor mode updated successfully"
|
|
1055
|
+
}
|
|
1056
|
+
```
|
|
1057
|
+
|
|
1058
|
+
#### Example
|
|
1059
|
+
|
|
1060
|
+
```
|
|
1061
|
+
curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/123/update-long-desc-editor-mode" \
|
|
1062
|
+
-u "username:app_password" \
|
|
1063
|
+
-H "Content-Type: application/json" \
|
|
1064
|
+
-d '{"active_editor": "visual"}'
|
|
1065
|
+
```
|
|
1066
|
+
|
|
1067
|
+
---
|
|
1068
|
+
|
|
1069
|
+
### Update Variant Option
|
|
1070
|
+
|
|
1071
|
+
POST `/fluent-cart/v2/products/{postId}/update-variant-option`
|
|
1072
|
+
|
|
1073
|
+
Sync variant options for a product (used when managing product attribute variations).
|
|
1074
|
+
|
|
1075
|
+
- **Permission:** `products/edit`
|
|
1076
|
+
|
|
1077
|
+
#### Parameters
|
|
1078
|
+
|
|
1079
|
+
| Parameter | Type | Location | Required | Description |
|
|
1080
|
+
| --- | --- | --- | --- | --- |
|
|
1081
|
+
| `postId` | integer | path | Yes | The product post ID |
|
|
1082
|
+
| `variation_type` | string | body | Yes | The variation type |
|
|
1083
|
+
| `product_id` | integer | body | Yes | The product ID |
|
|
1084
|
+
| `options` | array | body | Yes | Array of option objects with `id` and `variants` |
|
|
1085
|
+
|
|
1086
|
+
#### Response
|
|
1087
|
+
|
|
1088
|
+
```
|
|
1089
|
+
{
|
|
1090
|
+
"message": "Variant options synced successfully"
|
|
1091
|
+
}
|
|
1092
|
+
```
|
|
1093
|
+
|
|
1094
|
+
#### Example
|
|
1095
|
+
|
|
1096
|
+
```
|
|
1097
|
+
curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/123/update-variant-option" \
|
|
1098
|
+
-u "username:app_password" \
|
|
1099
|
+
-H "Content-Type: application/json" \
|
|
1100
|
+
-d '{
|
|
1101
|
+
"variation_type": "simple_variations",
|
|
1102
|
+
"product_id": 123,
|
|
1103
|
+
"options": []
|
|
1104
|
+
}'
|
|
1105
|
+
```
|
|
1106
|
+
|
|
1107
|
+
---
|
|
1108
|
+
|
|
1109
|
+
### Update Product Detail
|
|
1110
|
+
|
|
1111
|
+
POST `/fluent-cart/v2/products/detail/{detailId}`
|
|
1112
|
+
|
|
1113
|
+
Update a product detail record (e.g., change variation type).
|
|
1114
|
+
|
|
1115
|
+
- **Permission:** `products/edit`
|
|
1116
|
+
|
|
1117
|
+
#### Parameters
|
|
1118
|
+
|
|
1119
|
+
| Parameter | Type | Location | Required | Description |
|
|
1120
|
+
| --- | --- | --- | --- | --- |
|
|
1121
|
+
| `detailId` | integer | path | Yes | The product detail ID |
|
|
1122
|
+
| `variation_type` | string | body | No | New variation type (e.g., `simple`, `simple_variations`) |
|
|
1123
|
+
| `variation_ids` | array | body | No | Array of variation IDs |
|
|
1124
|
+
| `action` | string | body | No | Action to perform (default: `change_variation_type`) |
|
|
1125
|
+
|
|
1126
|
+
#### Response
|
|
1127
|
+
|
|
1128
|
+
```
|
|
1129
|
+
{
|
|
1130
|
+
"message": "Product detail updated successfully"
|
|
1131
|
+
}
|
|
1132
|
+
```
|
|
1133
|
+
|
|
1134
|
+
#### Example
|
|
1135
|
+
|
|
1136
|
+
```
|
|
1137
|
+
curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/detail/456" \
|
|
1138
|
+
-u "username:app_password" \
|
|
1139
|
+
-H "Content-Type: application/json" \
|
|
1140
|
+
-d '{
|
|
1141
|
+
"variation_type": "simple_variations",
|
|
1142
|
+
"action": "change_variation_type"
|
|
1143
|
+
}'
|
|
1144
|
+
```
|
|
1145
|
+
|
|
1146
|
+
---
|
|
1147
|
+
|
|
1148
|
+
### Add Product Terms
|
|
1149
|
+
|
|
1150
|
+
POST `/fluent-cart/v2/products/add-product-terms`
|
|
1151
|
+
|
|
1152
|
+
Create new taxonomy terms for products (categories, brands, etc.).
|
|
1153
|
+
|
|
1154
|
+
- **Permission:** `products/edit`
|
|
1155
|
+
|
|
1156
|
+
#### Parameters
|
|
1157
|
+
|
|
1158
|
+
| Parameter | Type | Location | Required | Description |
|
|
1159
|
+
| --- | --- | --- | --- | --- |
|
|
1160
|
+
| `term.name` | string | body | Yes | Term name(s), comma-separated for multiple |
|
|
1161
|
+
| `term.taxonomy` | string | body | Yes | Taxonomy name (e.g., `product-categories`, `product-brands`) |
|
|
1162
|
+
| `term.parent` | integer | body | No | Parent term ID for hierarchical terms |
|
|
1163
|
+
|
|
1164
|
+
#### Response
|
|
1165
|
+
|
|
1166
|
+
```
|
|
1167
|
+
{
|
|
1168
|
+
"term_ids": [10, 11],
|
|
1169
|
+
"names": ["Category A", "Category B"]
|
|
1170
|
+
}
|
|
1171
|
+
```
|
|
1172
|
+
|
|
1173
|
+
#### Example
|
|
1174
|
+
|
|
1175
|
+
```
|
|
1176
|
+
curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/add-product-terms" \
|
|
1177
|
+
-u "username:app_password" \
|
|
1178
|
+
-H "Content-Type: application/json" \
|
|
1179
|
+
-d '{
|
|
1180
|
+
"term": {
|
|
1181
|
+
"name": "New Category,Another Category",
|
|
1182
|
+
"taxonomy": "product-categories",
|
|
1183
|
+
"parent": 0
|
|
1184
|
+
}
|
|
1185
|
+
}'
|
|
1186
|
+
```
|
|
1187
|
+
|
|
1188
|
+
---
|
|
1189
|
+
|
|
1190
|
+
### Sync Taxonomy Terms
|
|
1191
|
+
|
|
1192
|
+
POST `/fluent-cart/v2/products/sync-taxonomy-term/{postId}`
|
|
1193
|
+
|
|
1194
|
+
Sync (replace) taxonomy terms for a product.
|
|
1195
|
+
|
|
1196
|
+
- **Permission:** `products/edit`
|
|
1197
|
+
|
|
1198
|
+
#### Parameters
|
|
1199
|
+
|
|
1200
|
+
| Parameter | Type | Location | Required | Description |
|
|
1201
|
+
| --- | --- | --- | --- | --- |
|
|
1202
|
+
| `postId` | integer | path | Yes | The product post ID |
|
|
1203
|
+
| `taxonomy` | string | body | Yes | Taxonomy name (e.g., `product-categories`) |
|
|
1204
|
+
| `terms` | array | body | No | Array of term IDs to sync |
|
|
1205
|
+
|
|
1206
|
+
#### Response
|
|
1207
|
+
|
|
1208
|
+
```
|
|
1209
|
+
{
|
|
1210
|
+
"message": "Taxonomy terms synced successfully"
|
|
1211
|
+
}
|
|
1212
|
+
```
|
|
1213
|
+
|
|
1214
|
+
#### Example
|
|
1215
|
+
|
|
1216
|
+
```
|
|
1217
|
+
curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/sync-taxonomy-term/123" \
|
|
1218
|
+
-u "username:app_password" \
|
|
1219
|
+
-H "Content-Type: application/json" \
|
|
1220
|
+
-d '{
|
|
1221
|
+
"taxonomy": "product-categories",
|
|
1222
|
+
"terms": [1, 5, 10]
|
|
1223
|
+
}'
|
|
1224
|
+
```
|
|
1225
|
+
|
|
1226
|
+
---
|
|
1227
|
+
|
|
1228
|
+
### Delete Taxonomy Term
|
|
1229
|
+
|
|
1230
|
+
POST `/fluent-cart/v2/products/delete-taxonomy-term/{postId}`
|
|
1231
|
+
|
|
1232
|
+
Remove a specific taxonomy term from a product.
|
|
1233
|
+
|
|
1234
|
+
- **Permission:** `products/edit`
|
|
1235
|
+
|
|
1236
|
+
#### Parameters
|
|
1237
|
+
|
|
1238
|
+
| Parameter | Type | Location | Required | Description |
|
|
1239
|
+
| --- | --- | --- | --- | --- |
|
|
1240
|
+
| `postId` | integer | path | Yes | The product post ID |
|
|
1241
|
+
| `taxonomy` | string | body | Yes | Taxonomy name (e.g., `product-categories`) |
|
|
1242
|
+
| `term` | integer | body | Yes | Term ID to remove |
|
|
1243
|
+
|
|
1244
|
+
#### Response
|
|
1245
|
+
|
|
1246
|
+
```
|
|
1247
|
+
{
|
|
1248
|
+
"message": "Taxonomy term removed successfully"
|
|
1249
|
+
}
|
|
1250
|
+
```
|
|
1251
|
+
|
|
1252
|
+
#### Example
|
|
1253
|
+
|
|
1254
|
+
```
|
|
1255
|
+
curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/delete-taxonomy-term/123" \
|
|
1256
|
+
-u "username:app_password" \
|
|
1257
|
+
-H "Content-Type: application/json" \
|
|
1258
|
+
-d '{
|
|
1259
|
+
"taxonomy": "product-categories",
|
|
1260
|
+
"term": 5
|
|
1261
|
+
}'
|
|
1262
|
+
```
|
|
1263
|
+
|
|
1264
|
+
---
|
|
1265
|
+
|
|
1266
|
+
### Get Pricing Widgets
|
|
1267
|
+
|
|
1268
|
+
GET `/fluent-cart/v2/products/{productId}/pricing-widgets`
|
|
1269
|
+
|
|
1270
|
+
Retrieve sales overview widgets for a product (all-time, last 30 days, this month).
|
|
1271
|
+
|
|
1272
|
+
- **Permission:** `products/view`
|
|
1273
|
+
|
|
1274
|
+
#### Parameters
|
|
1275
|
+
|
|
1276
|
+
| Parameter | Type | Location | Required | Description |
|
|
1277
|
+
| --- | --- | --- | --- | --- |
|
|
1278
|
+
| `productId` | integer | path | Yes | The product ID |
|
|
1279
|
+
|
|
1280
|
+
#### Response
|
|
1281
|
+
|
|
1282
|
+
```
|
|
1283
|
+
{
|
|
1284
|
+
"widgets": [
|
|
1285
|
+
{
|
|
1286
|
+
"title": "Quick Sales Overview",
|
|
1287
|
+
"body": "<ul class=\"fct-lists\"><li><span>All time (5)</span><span>$50.00</span></li>...</ul>"
|
|
1288
|
+
}
|
|
1289
|
+
]
|
|
1290
|
+
}
|
|
1291
|
+
```
|
|
1292
|
+
|
|
1293
|
+
#### Example
|
|
1294
|
+
|
|
1295
|
+
```
|
|
1296
|
+
curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/123/pricing-widgets" \
|
|
1297
|
+
-u "username:app_password"
|
|
1298
|
+
```
|
|
1299
|
+
|
|
1300
|
+
---
|
|
1301
|
+
|
|
1302
|
+
## Bundle Products
|
|
1303
|
+
|
|
1304
|
+
### Get Bundle Info
|
|
1305
|
+
|
|
1306
|
+
GET `/fluent-cart/v2/products/get-bundle-info/{productId}`
|
|
1307
|
+
|
|
1308
|
+
Retrieve bundle configuration information for a product, including child variant mappings.
|
|
1309
|
+
|
|
1310
|
+
- **Permission:** `products/view`
|
|
1311
|
+
|
|
1312
|
+
#### Parameters
|
|
1313
|
+
|
|
1314
|
+
| Parameter | Type | Location | Required | Description |
|
|
1315
|
+
| --- | --- | --- | --- | --- |
|
|
1316
|
+
| `productId` | integer | path | Yes | The product ID |
|
|
1317
|
+
|
|
1318
|
+
#### Response
|
|
1319
|
+
|
|
1320
|
+
```
|
|
1321
|
+
[
|
|
1322
|
+
{
|
|
1323
|
+
"id": 789,
|
|
1324
|
+
"variation_title": "Bundle Plan",
|
|
1325
|
+
"other_info": {
|
|
1326
|
+
"bundle_child_ids": [101, 102, 103]
|
|
1327
|
+
}
|
|
1328
|
+
}
|
|
1329
|
+
]
|
|
1330
|
+
```
|
|
1331
|
+
|
|
1332
|
+
#### Example
|
|
1333
|
+
|
|
1334
|
+
```
|
|
1335
|
+
curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/get-bundle-info/123" \
|
|
1336
|
+
-u "username:app_password"
|
|
1337
|
+
```
|
|
1338
|
+
|
|
1339
|
+
---
|
|
1340
|
+
|
|
1341
|
+
### Save Bundle Info
|
|
1342
|
+
|
|
1343
|
+
POST `/fluent-cart/v2/products/save-bundle-info/{variationId}`
|
|
1344
|
+
|
|
1345
|
+
Save bundle child variant IDs for a variation. Bundle products cannot be added as children of other bundles.
|
|
1346
|
+
|
|
1347
|
+
- **Permission:** `products/edit`
|
|
1348
|
+
|
|
1349
|
+
#### Parameters
|
|
1350
|
+
|
|
1351
|
+
| Parameter | Type | Location | Required | Description |
|
|
1352
|
+
| --- | --- | --- | --- | --- |
|
|
1353
|
+
| `variationId` | integer | path | Yes | The variation ID to configure as a bundle |
|
|
1354
|
+
| `bundle_child_ids` | array | body | Yes | Array of child variation IDs |
|
|
1355
|
+
|
|
1356
|
+
#### Response
|
|
1357
|
+
|
|
1358
|
+
```
|
|
1359
|
+
[true]
|
|
1360
|
+
```
|
|
1361
|
+
|
|
1362
|
+
#### Example
|
|
1363
|
+
|
|
1364
|
+
```
|
|
1365
|
+
curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/save-bundle-info/789" \
|
|
1366
|
+
-u "username:app_password" \
|
|
1367
|
+
-H "Content-Type: application/json" \
|
|
1368
|
+
-d '{
|
|
1369
|
+
"bundle_child_ids": [101, 102, 103]
|
|
1370
|
+
}'
|
|
1371
|
+
```
|
|
1372
|
+
|
|
1373
|
+
---
|
|
1374
|
+
|
|
1375
|
+
## Upgrade Paths
|
|
1376
|
+
|
|
1377
|
+
### Get Upgrade Settings
|
|
1378
|
+
|
|
1379
|
+
GET `/fluent-cart/v2/products/{id}/upgrade-paths`
|
|
1380
|
+
|
|
1381
|
+
Retrieve all upgrade path configurations for a product.
|
|
1382
|
+
|
|
1383
|
+
- **Permission:** `products/view`
|
|
1384
|
+
|
|
1385
|
+
#### Parameters
|
|
1386
|
+
|
|
1387
|
+
| Parameter | Type | Location | Required | Description |
|
|
1388
|
+
| --- | --- | --- | --- | --- |
|
|
1389
|
+
| `id` | integer | path | Yes | The product ID |
|
|
1390
|
+
|
|
1391
|
+
#### Response
|
|
1392
|
+
|
|
1393
|
+
```
|
|
1394
|
+
{
|
|
1395
|
+
"data": [ ... ]
|
|
1396
|
+
}
|
|
1397
|
+
```
|
|
1398
|
+
|
|
1399
|
+
#### Example
|
|
1400
|
+
|
|
1401
|
+
```
|
|
1402
|
+
curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/123/upgrade-paths" \
|
|
1403
|
+
-u "username:app_password"
|
|
1404
|
+
```
|
|
1405
|
+
|
|
1406
|
+
---
|
|
1407
|
+
|
|
1408
|
+
### Save Upgrade Path
|
|
1409
|
+
|
|
1410
|
+
POST `/fluent-cart/v2/products/{id}/upgrade-path`
|
|
1411
|
+
|
|
1412
|
+
Create a new upgrade path for a product.
|
|
1413
|
+
|
|
1414
|
+
- **Permission:** `products/edit`
|
|
1415
|
+
- **Request Class:** `UpgradePathSettingRequest`
|
|
1416
|
+
|
|
1417
|
+
#### Parameters
|
|
1418
|
+
|
|
1419
|
+
| Parameter | Type | Location | Required | Description |
|
|
1420
|
+
| --- | --- | --- | --- | --- |
|
|
1421
|
+
| `id` | integer | path | Yes | The product ID |
|
|
1422
|
+
| `from_variant` | integer | body | Yes | Source variation ID (must exist in `fct_product_variations`) |
|
|
1423
|
+
| `to_variants` | array | body | Yes | Array of target variation IDs (each must exist in `fct_product_variations`) |
|
|
1424
|
+
| `discount_amount` | number | body | No | Discount amount for the upgrade |
|
|
1425
|
+
| `title` | string | body | No | Upgrade path title |
|
|
1426
|
+
| `description` | string | body | No | Upgrade path description |
|
|
1427
|
+
| `slug` | string | body | No | Upgrade path slug |
|
|
1428
|
+
|
|
1429
|
+
#### Response
|
|
1430
|
+
|
|
1431
|
+
```
|
|
1432
|
+
{
|
|
1433
|
+
"message": "Settings saved successfully"
|
|
1434
|
+
}
|
|
1435
|
+
```
|
|
1436
|
+
|
|
1437
|
+
#### Example
|
|
1438
|
+
|
|
1439
|
+
```
|
|
1440
|
+
curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/123/upgrade-path" \
|
|
1441
|
+
-u "username:app_password" \
|
|
1442
|
+
-H "Content-Type: application/json" \
|
|
1443
|
+
-d '{
|
|
1444
|
+
"from_variant": 456,
|
|
1445
|
+
"to_variants": [457, 458],
|
|
1446
|
+
"discount_amount": 500
|
|
1447
|
+
}'
|
|
1448
|
+
```
|
|
1449
|
+
|
|
1450
|
+
---
|
|
1451
|
+
|
|
1452
|
+
### Update Upgrade Path
|
|
1453
|
+
|
|
1454
|
+
POST `/fluent-cart/v2/products/upgrade-path/{id}/update`
|
|
1455
|
+
|
|
1456
|
+
Update an existing upgrade path.
|
|
1457
|
+
|
|
1458
|
+
- **Permission:** `products/edit`
|
|
1459
|
+
- **Request Class:** `UpgradePathSettingRequest`
|
|
1460
|
+
|
|
1461
|
+
#### Parameters
|
|
1462
|
+
|
|
1463
|
+
| Parameter | Type | Location | Required | Description |
|
|
1464
|
+
| --- | --- | --- | --- | --- |
|
|
1465
|
+
| `id` | integer | path | Yes | The upgrade path ID |
|
|
1466
|
+
| `from_variant` | integer | body | Yes | Source variation ID |
|
|
1467
|
+
| `to_variants` | array | body | Yes | Array of target variation IDs |
|
|
1468
|
+
| `discount_amount` | number | body | No | Discount amount |
|
|
1469
|
+
| `title` | string | body | No | Upgrade path title |
|
|
1470
|
+
| `description` | string | body | No | Upgrade path description |
|
|
1471
|
+
| `slug` | string | body | No | Upgrade path slug |
|
|
1472
|
+
|
|
1473
|
+
#### Response
|
|
1474
|
+
|
|
1475
|
+
```
|
|
1476
|
+
{
|
|
1477
|
+
"message": "Settings updated successfully"
|
|
1478
|
+
}
|
|
1479
|
+
```
|
|
1480
|
+
|
|
1481
|
+
#### Example
|
|
1482
|
+
|
|
1483
|
+
```
|
|
1484
|
+
curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/upgrade-path/10/update" \
|
|
1485
|
+
-u "username:app_password" \
|
|
1486
|
+
-H "Content-Type: application/json" \
|
|
1487
|
+
-d '{
|
|
1488
|
+
"from_variant": 456,
|
|
1489
|
+
"to_variants": [458, 459],
|
|
1490
|
+
"discount_amount": 1000
|
|
1491
|
+
}'
|
|
1492
|
+
```
|
|
1493
|
+
|
|
1494
|
+
---
|
|
1495
|
+
|
|
1496
|
+
### Delete Upgrade Path
|
|
1497
|
+
|
|
1498
|
+
DELETE `/fluent-cart/v2/products/upgrade-path/{id}/delete`
|
|
1499
|
+
|
|
1500
|
+
Delete an upgrade path.
|
|
1501
|
+
|
|
1502
|
+
- **Permission:** `products/delete`
|
|
1503
|
+
|
|
1504
|
+
#### Parameters
|
|
1505
|
+
|
|
1506
|
+
| Parameter | Type | Location | Required | Description |
|
|
1507
|
+
| --- | --- | --- | --- | --- |
|
|
1508
|
+
| `id` | integer | path | Yes | The upgrade path ID |
|
|
1509
|
+
|
|
1510
|
+
#### Response
|
|
1511
|
+
|
|
1512
|
+
```
|
|
1513
|
+
{
|
|
1514
|
+
"message": "Path deleted successfully"
|
|
1515
|
+
}
|
|
1516
|
+
```
|
|
1517
|
+
|
|
1518
|
+
#### Example
|
|
1519
|
+
|
|
1520
|
+
```
|
|
1521
|
+
curl -X DELETE "https://example.com/wp-json/fluent-cart/v2/products/upgrade-path/10/delete" \
|
|
1522
|
+
-u "username:app_password"
|
|
1523
|
+
```
|
|
1524
|
+
|
|
1525
|
+
---
|
|
1526
|
+
|
|
1527
|
+
### Get Variation Upgrade Paths
|
|
1528
|
+
|
|
1529
|
+
GET `/fluent-cart/v2/products/variation/{variantId}/upgrade-paths`
|
|
1530
|
+
|
|
1531
|
+
Retrieve available upgrade paths for a specific variation (used in customer-facing upgrade flows).
|
|
1532
|
+
|
|
1533
|
+
- **Permission:** `products/view`
|
|
1534
|
+
|
|
1535
|
+
#### Parameters
|
|
1536
|
+
|
|
1537
|
+
| Parameter | Type | Location | Required | Description |
|
|
1538
|
+
| --- | --- | --- | --- | --- |
|
|
1539
|
+
| `variantId` | integer | path | Yes | The variation ID |
|
|
1540
|
+
| `params.order_hash` | string | query | Yes | The order hash to determine applicable upgrades |
|
|
1541
|
+
|
|
1542
|
+
#### Response
|
|
1543
|
+
|
|
1544
|
+
```
|
|
1545
|
+
{
|
|
1546
|
+
"upgradePaths": [ ... ]
|
|
1547
|
+
}
|
|
1548
|
+
```
|
|
1549
|
+
|
|
1550
|
+
#### Example
|
|
1551
|
+
|
|
1552
|
+
```
|
|
1553
|
+
curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/variation/456/upgrade-paths?params[order_hash]=abc123" \
|
|
1554
|
+
-u "username:app_password"
|
|
1555
|
+
```
|
|
1556
|
+
|
|
1557
|
+
---
|
|
1558
|
+
|
|
1559
|
+
## Tax & Shipping Classes
|
|
1560
|
+
|
|
1561
|
+
### Update Tax Class
|
|
1562
|
+
|
|
1563
|
+
POST `/fluent-cart/v2/products/{postId}/tax-class`
|
|
1564
|
+
|
|
1565
|
+
Assign a tax class to a product.
|
|
1566
|
+
|
|
1567
|
+
- **Permission:** `products/edit`
|
|
1568
|
+
|
|
1569
|
+
#### Parameters
|
|
1570
|
+
|
|
1571
|
+
| Parameter | Type | Location | Required | Description |
|
|
1572
|
+
| --- | --- | --- | --- | --- |
|
|
1573
|
+
| `postId` | integer | path | Yes | The product post ID |
|
|
1574
|
+
| `tax_class` | integer | body | Yes | Tax class ID |
|
|
1575
|
+
|
|
1576
|
+
#### Response
|
|
1577
|
+
|
|
1578
|
+
```
|
|
1579
|
+
{
|
|
1580
|
+
"message": "Tax Class updated successfully"
|
|
1581
|
+
}
|
|
1582
|
+
```
|
|
1583
|
+
|
|
1584
|
+
#### Example
|
|
1585
|
+
|
|
1586
|
+
```
|
|
1587
|
+
curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/123/tax-class" \
|
|
1588
|
+
-u "username:app_password" \
|
|
1589
|
+
-H "Content-Type: application/json" \
|
|
1590
|
+
-d '{"tax_class": 5}'
|
|
1591
|
+
```
|
|
1592
|
+
|
|
1593
|
+
---
|
|
1594
|
+
|
|
1595
|
+
### Remove Tax Class
|
|
1596
|
+
|
|
1597
|
+
POST `/fluent-cart/v2/products/{postId}/tax-class/remove`
|
|
1598
|
+
|
|
1599
|
+
Remove the assigned tax class from a product.
|
|
1600
|
+
|
|
1601
|
+
- **Permission:** `products/edit`
|
|
1602
|
+
|
|
1603
|
+
#### Parameters
|
|
1604
|
+
|
|
1605
|
+
| Parameter | Type | Location | Required | Description |
|
|
1606
|
+
| --- | --- | --- | --- | --- |
|
|
1607
|
+
| `postId` | integer | path | Yes | The product post ID |
|
|
1608
|
+
|
|
1609
|
+
#### Response
|
|
1610
|
+
|
|
1611
|
+
```
|
|
1612
|
+
{
|
|
1613
|
+
"message": "Tax Class removed successfully"
|
|
1614
|
+
}
|
|
1615
|
+
```
|
|
1616
|
+
|
|
1617
|
+
#### Example
|
|
1618
|
+
|
|
1619
|
+
```
|
|
1620
|
+
curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/123/tax-class/remove" \
|
|
1621
|
+
-u "username:app_password"
|
|
1622
|
+
```
|
|
1623
|
+
|
|
1624
|
+
---
|
|
1625
|
+
|
|
1626
|
+
### Update Shipping Class
|
|
1627
|
+
|
|
1628
|
+
POST `/fluent-cart/v2/products/{postId}/shipping-class`
|
|
1629
|
+
|
|
1630
|
+
Assign a shipping class to a product.
|
|
1631
|
+
|
|
1632
|
+
- **Permission:** `products/edit`
|
|
1633
|
+
|
|
1634
|
+
#### Parameters
|
|
1635
|
+
|
|
1636
|
+
| Parameter | Type | Location | Required | Description |
|
|
1637
|
+
| --- | --- | --- | --- | --- |
|
|
1638
|
+
| `postId` | integer | path | Yes | The product post ID |
|
|
1639
|
+
| `shipping_class` | integer | body | Yes | Shipping class ID |
|
|
1640
|
+
|
|
1641
|
+
#### Response
|
|
1642
|
+
|
|
1643
|
+
```
|
|
1644
|
+
{
|
|
1645
|
+
"message": "Shipping Class updated successfully"
|
|
1646
|
+
}
|
|
1647
|
+
```
|
|
1648
|
+
|
|
1649
|
+
#### Example
|
|
1650
|
+
|
|
1651
|
+
```
|
|
1652
|
+
curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/123/shipping-class" \
|
|
1653
|
+
-u "username:app_password" \
|
|
1654
|
+
-H "Content-Type: application/json" \
|
|
1655
|
+
-d '{"shipping_class": 3}'
|
|
1656
|
+
```
|
|
1657
|
+
|
|
1658
|
+
---
|
|
1659
|
+
|
|
1660
|
+
### Remove Shipping Class
|
|
1661
|
+
|
|
1662
|
+
POST `/fluent-cart/v2/products/{postId}/shipping-class/remove`
|
|
1663
|
+
|
|
1664
|
+
Remove the assigned shipping class from a product.
|
|
1665
|
+
|
|
1666
|
+
- **Permission:** `products/edit`
|
|
1667
|
+
|
|
1668
|
+
#### Parameters
|
|
1669
|
+
|
|
1670
|
+
| Parameter | Type | Location | Required | Description |
|
|
1671
|
+
| --- | --- | --- | --- | --- |
|
|
1672
|
+
| `postId` | integer | path | Yes | The product post ID |
|
|
1673
|
+
|
|
1674
|
+
#### Response
|
|
1675
|
+
|
|
1676
|
+
```
|
|
1677
|
+
{
|
|
1678
|
+
"message": "Shipping Class removed successfully"
|
|
1679
|
+
}
|
|
1680
|
+
```
|
|
1681
|
+
|
|
1682
|
+
#### Example
|
|
1683
|
+
|
|
1684
|
+
```
|
|
1685
|
+
curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/123/shipping-class/remove" \
|
|
1686
|
+
-u "username:app_password"
|
|
1687
|
+
```
|
|
1688
|
+
|
|
1689
|
+
---
|
|
1690
|
+
|
|
1691
|
+
## Stock Management
|
|
1692
|
+
|
|
1693
|
+
### Update Inventory
|
|
1694
|
+
|
|
1695
|
+
PUT `/fluent-cart/v2/products/{postId}/update-inventory/{variantId}`
|
|
1696
|
+
|
|
1697
|
+
Update stock levels for a specific variant. Automatically updates stock status and product-level availability.
|
|
1698
|
+
|
|
1699
|
+
- **Permission:** `products/edit`
|
|
1700
|
+
|
|
1701
|
+
#### Parameters
|
|
1702
|
+
|
|
1703
|
+
| Parameter | Type | Location | Required | Description |
|
|
1704
|
+
| --- | --- | --- | --- | --- |
|
|
1705
|
+
| `postId` | integer | path | Yes | The product post ID |
|
|
1706
|
+
| `variantId` | integer | path | Yes | The variant ID to update |
|
|
1707
|
+
| `total_stock` | integer | body | Yes | Total stock quantity |
|
|
1708
|
+
| `available` | integer | body | Yes | Available stock quantity |
|
|
1709
|
+
|
|
1710
|
+
#### Response
|
|
1711
|
+
|
|
1712
|
+
```
|
|
1713
|
+
{
|
|
1714
|
+
"message": "Inventory updated successfully"
|
|
1715
|
+
}
|
|
1716
|
+
```
|
|
1717
|
+
|
|
1718
|
+
#### Example
|
|
1719
|
+
|
|
1720
|
+
```
|
|
1721
|
+
curl -X PUT "https://example.com/wp-json/fluent-cart/v2/products/123/update-inventory/456" \
|
|
1722
|
+
-u "username:app_password" \
|
|
1723
|
+
-H "Content-Type: application/json" \
|
|
1724
|
+
-d '{
|
|
1725
|
+
"total_stock": 100,
|
|
1726
|
+
"available": 80
|
|
1727
|
+
}'
|
|
1728
|
+
```
|
|
1729
|
+
|
|
1730
|
+
---
|
|
1731
|
+
|
|
1732
|
+
### Update Manage Stock Setting
|
|
1733
|
+
|
|
1734
|
+
PUT `/fluent-cart/v2/products/{postId}/update-manage-stock`
|
|
1735
|
+
|
|
1736
|
+
Enable or disable stock management for a product and all its variants.
|
|
1737
|
+
|
|
1738
|
+
- **Permission:** `products/edit`
|
|
1739
|
+
|
|
1740
|
+
#### Parameters
|
|
1741
|
+
|
|
1742
|
+
| Parameter | Type | Location | Required | Description |
|
|
1743
|
+
| --- | --- | --- | --- | --- |
|
|
1744
|
+
| `postId` | integer | path | Yes | The product post ID |
|
|
1745
|
+
| `manage_stock` | integer | body | Yes | `1` to enable, `0` to disable stock management |
|
|
1746
|
+
|
|
1747
|
+
#### Response
|
|
1748
|
+
|
|
1749
|
+
```
|
|
1750
|
+
{
|
|
1751
|
+
"message": "Manage stock updated successfully"
|
|
1752
|
+
}
|
|
1753
|
+
```
|
|
1754
|
+
|
|
1755
|
+
#### Example
|
|
1756
|
+
|
|
1757
|
+
```
|
|
1758
|
+
curl -X PUT "https://example.com/wp-json/fluent-cart/v2/products/123/update-manage-stock" \
|
|
1759
|
+
-u "username:app_password" \
|
|
1760
|
+
-H "Content-Type: application/json" \
|
|
1761
|
+
-d '{"manage_stock": 1}'
|
|
1762
|
+
```
|
|
1763
|
+
|
|
1764
|
+
---
|
|
1765
|
+
|
|
1766
|
+
## Downloadables
|
|
1767
|
+
|
|
1768
|
+
### Sync Downloadable Files
|
|
1769
|
+
|
|
1770
|
+
POST `/fluent-cart/v2/products/{postId}/sync-downloadable-files`
|
|
1771
|
+
|
|
1772
|
+
Attach multiple downloadable files to a product. Automatically enables the `manage_downloadable` flag.
|
|
1773
|
+
|
|
1774
|
+
- **Permission:** `products/edit`
|
|
1775
|
+
- **Validation Class:** `ProductDownloadableBulkFileRequest`
|
|
1776
|
+
|
|
1777
|
+
#### Parameters
|
|
1778
|
+
|
|
1779
|
+
| Parameter | Type | Location | Required | Description |
|
|
1780
|
+
| --- | --- | --- | --- | --- |
|
|
1781
|
+
| `postId` | integer | path | Yes | The product post ID |
|
|
1782
|
+
| `downloadable_files` | array | body | Yes | Array of downloadable file objects |
|
|
1783
|
+
| `downloadable_files.*.title` | string | body | Yes | File title (max 160 chars) |
|
|
1784
|
+
| `downloadable_files.*.type` | string | body | Yes | File type (max 100 chars) |
|
|
1785
|
+
| `downloadable_files.*.driver` | string | body | Yes | Storage driver (max 60 chars, e.g., `local`, `s3`) |
|
|
1786
|
+
| `downloadable_files.*.file_name` | string | body | Yes | File name (max 185 chars) |
|
|
1787
|
+
| `downloadable_files.*.file_path` | string | body | Yes | File path (max 185 chars) |
|
|
1788
|
+
| `downloadable_files.*.file_url` | string | body | Yes | File URL (max 200 chars) |
|
|
1789
|
+
| `downloadable_files.*.bucket` | string | body | No | Storage bucket name |
|
|
1790
|
+
| `downloadable_files.*.file_size` | string | body | No | File size |
|
|
1791
|
+
| `downloadable_files.*.serial` | integer | body | No | Display order serial |
|
|
1792
|
+
| `downloadable_files.*.product_variation_id` | array | body | No | Array of variation IDs this file is associated with |
|
|
1793
|
+
| `downloadable_files.*.settings.download_limit` | integer | body | No | Maximum number of downloads allowed |
|
|
1794
|
+
| `downloadable_files.*.settings.download_expiry` | integer | body | No | Download expiry in days |
|
|
1795
|
+
|
|
1796
|
+
#### Response
|
|
1797
|
+
|
|
1798
|
+
```
|
|
1799
|
+
{
|
|
1800
|
+
"downloadable_files": [
|
|
1801
|
+
{
|
|
1802
|
+
"id": 1,
|
|
1803
|
+
"post_id": 123,
|
|
1804
|
+
"title": "Software v1.0",
|
|
1805
|
+
"type": "zip",
|
|
1806
|
+
"driver": "local",
|
|
1807
|
+
"file_name": "software-v1.zip",
|
|
1808
|
+
"download_identifier": "a1b2c3d4-..."
|
|
1809
|
+
}
|
|
1810
|
+
]
|
|
1811
|
+
}
|
|
1812
|
+
```
|
|
1813
|
+
|
|
1814
|
+
#### Example
|
|
1815
|
+
|
|
1816
|
+
```
|
|
1817
|
+
curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/123/sync-downloadable-files" \
|
|
1818
|
+
-u "username:app_password" \
|
|
1819
|
+
-H "Content-Type: application/json" \
|
|
1820
|
+
-d '{
|
|
1821
|
+
"postId": 123,
|
|
1822
|
+
"downloadable_files": [
|
|
1823
|
+
{
|
|
1824
|
+
"title": "Software v1.0",
|
|
1825
|
+
"type": "zip",
|
|
1826
|
+
"driver": "local",
|
|
1827
|
+
"file_name": "software-v1.zip",
|
|
1828
|
+
"file_path": "software-v1.zip",
|
|
1829
|
+
"file_url": "software-v1.zip",
|
|
1830
|
+
"product_variation_id": [456],
|
|
1831
|
+
"settings": {
|
|
1832
|
+
"download_limit": 5,
|
|
1833
|
+
"download_expiry": 365
|
|
1834
|
+
}
|
|
1835
|
+
}
|
|
1836
|
+
]
|
|
1837
|
+
}'
|
|
1838
|
+
```
|
|
1839
|
+
|
|
1840
|
+
---
|
|
1841
|
+
|
|
1842
|
+
### Update Downloadable File
|
|
1843
|
+
|
|
1844
|
+
PUT `/fluent-cart/v2/products/{downloadableId}/update`
|
|
1845
|
+
|
|
1846
|
+
Update an existing downloadable file record.
|
|
1847
|
+
|
|
1848
|
+
- **Permission:** `products/edit`
|
|
1849
|
+
- **Validation Class:** `ProductDownloadableFileRequest`
|
|
1850
|
+
|
|
1851
|
+
#### Parameters
|
|
1852
|
+
|
|
1853
|
+
| Parameter | Type | Location | Required | Description |
|
|
1854
|
+
| --- | --- | --- | --- | --- |
|
|
1855
|
+
| `downloadableId` | integer | path | Yes | The downloadable file ID |
|
|
1856
|
+
| `title` | string | body | Yes | File title (max 100 chars) |
|
|
1857
|
+
| `type` | string | body | Yes | File type (max 100 chars) |
|
|
1858
|
+
| `driver` | string | body | Yes | Storage driver (max 100 chars) |
|
|
1859
|
+
| `file_name` | string | body | Yes | File name (max 100 chars) |
|
|
1860
|
+
| `product_variation_id` | array | body | No | Array of variation IDs |
|
|
1861
|
+
| `serial` | integer | body | No | Display order serial |
|
|
1862
|
+
| `settings` | object | body | No | File settings |
|
|
1863
|
+
| `settings.download_limit` | integer | body | No | Maximum downloads allowed |
|
|
1864
|
+
| `settings.download_expiry` | integer | body | No | Download expiry in days |
|
|
1865
|
+
|
|
1866
|
+
#### Response
|
|
1867
|
+
|
|
1868
|
+
```
|
|
1869
|
+
{
|
|
1870
|
+
"message": "Product downloadable files updated successfully"
|
|
1871
|
+
}
|
|
1872
|
+
```
|
|
1873
|
+
|
|
1874
|
+
#### Example
|
|
1875
|
+
|
|
1876
|
+
```
|
|
1877
|
+
curl -X PUT "https://example.com/wp-json/fluent-cart/v2/products/789/update" \
|
|
1878
|
+
-u "username:app_password" \
|
|
1879
|
+
-H "Content-Type: application/json" \
|
|
1880
|
+
-d '{
|
|
1881
|
+
"title": "Software v2.0",
|
|
1882
|
+
"type": "zip",
|
|
1883
|
+
"driver": "local",
|
|
1884
|
+
"file_name": "software-v2.zip",
|
|
1885
|
+
"product_variation_id": [456, 457],
|
|
1886
|
+
"settings": {
|
|
1887
|
+
"download_limit": 10
|
|
1888
|
+
}
|
|
1889
|
+
}'
|
|
1890
|
+
```
|
|
1891
|
+
|
|
1892
|
+
---
|
|
1893
|
+
|
|
1894
|
+
### Delete Downloadable File
|
|
1895
|
+
|
|
1896
|
+
DELETE `/fluent-cart/v2/products/{downloadableId}/delete`
|
|
1897
|
+
|
|
1898
|
+
Delete a downloadable file record.
|
|
1899
|
+
|
|
1900
|
+
- **Permission:** `products/delete`
|
|
1901
|
+
|
|
1902
|
+
#### Parameters
|
|
1903
|
+
|
|
1904
|
+
| Parameter | Type | Location | Required | Description |
|
|
1905
|
+
| --- | --- | --- | --- | --- |
|
|
1906
|
+
| `downloadableId` | integer | path | Yes | The downloadable file ID |
|
|
1907
|
+
|
|
1908
|
+
#### Response
|
|
1909
|
+
|
|
1910
|
+
```
|
|
1911
|
+
{
|
|
1912
|
+
"message": "File deleted successfully"
|
|
1913
|
+
}
|
|
1914
|
+
```
|
|
1915
|
+
|
|
1916
|
+
#### Example
|
|
1917
|
+
|
|
1918
|
+
```
|
|
1919
|
+
curl -X DELETE "https://example.com/wp-json/fluent-cart/v2/products/789/delete" \
|
|
1920
|
+
-u "username:app_password"
|
|
1921
|
+
```
|
|
1922
|
+
|
|
1923
|
+
---
|
|
1924
|
+
|
|
1925
|
+
### Get Downloadable URL
|
|
1926
|
+
|
|
1927
|
+
GET `/fluent-cart/v2/products/getDownloadableUrl/{downloadableId}`
|
|
1928
|
+
|
|
1929
|
+
Generate a temporary download URL for a downloadable file (valid for 7 days).
|
|
1930
|
+
|
|
1931
|
+
- **Permission:** `products/view`
|
|
1932
|
+
|
|
1933
|
+
#### Parameters
|
|
1934
|
+
|
|
1935
|
+
| Parameter | Type | Location | Required | Description |
|
|
1936
|
+
| --- | --- | --- | --- | --- |
|
|
1937
|
+
| `downloadableId` | integer | path | Yes | The downloadable file ID |
|
|
1938
|
+
|
|
1939
|
+
#### Response
|
|
1940
|
+
|
|
1941
|
+
```
|
|
1942
|
+
{
|
|
1943
|
+
"url": "https://example.com/fluent-cart/download?token=..."
|
|
1944
|
+
}
|
|
1945
|
+
```
|
|
1946
|
+
|
|
1947
|
+
#### Example
|
|
1948
|
+
|
|
1949
|
+
```
|
|
1950
|
+
curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/getDownloadableUrl/789" \
|
|
1951
|
+
-u "username:app_password"
|
|
1952
|
+
```
|
|
1953
|
+
|
|
1954
|
+
---
|
|
1955
|
+
|
|
1956
|
+
## Variations
|
|
1957
|
+
|
|
1958
|
+
### List Product Variations
|
|
1959
|
+
|
|
1960
|
+
GET `/fluent-cart/v2/products/variants`
|
|
1961
|
+
|
|
1962
|
+
Retrieve a list of product variations.
|
|
1963
|
+
|
|
1964
|
+
- **Permission:** `products/view`
|
|
1965
|
+
|
|
1966
|
+
#### Parameters
|
|
1967
|
+
|
|
1968
|
+
| Parameter | Type | Location | Required | Description |
|
|
1969
|
+
| --- | --- | --- | --- | --- |
|
|
1970
|
+
| `params` | object | query | No | Query parameters for filtering variations |
|
|
1971
|
+
|
|
1972
|
+
#### Response
|
|
1973
|
+
|
|
1974
|
+
```
|
|
1975
|
+
{
|
|
1976
|
+
"variants": [ ... ]
|
|
1977
|
+
}
|
|
1978
|
+
```
|
|
1979
|
+
|
|
1980
|
+
#### Example
|
|
1981
|
+
|
|
1982
|
+
```
|
|
1983
|
+
curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/variants" \
|
|
1984
|
+
-u "username:app_password"
|
|
1985
|
+
```
|
|
1986
|
+
|
|
1987
|
+
---
|
|
1988
|
+
|
|
1989
|
+
### Create Variation
|
|
1990
|
+
|
|
1991
|
+
POST `/fluent-cart/v2/products/variants`
|
|
1992
|
+
|
|
1993
|
+
Create a new product variation.
|
|
1994
|
+
|
|
1995
|
+
- **Permission:** `products/create`
|
|
1996
|
+
- **Request Class:** `ProductVariationRequest`
|
|
1997
|
+
|
|
1998
|
+
#### Parameters
|
|
1999
|
+
|
|
2000
|
+
| Parameter | Type | Location | Required | Description |
|
|
2001
|
+
| --- | --- | --- | --- | --- |
|
|
2002
|
+
| `variants.post_id` | integer | body | Yes | Parent product ID |
|
|
2003
|
+
| `variants.variation_title` | string | body | Yes | Variation title (max 200 chars) |
|
|
2004
|
+
| `variants.sku` | string | body | No | SKU (max 30 chars, must be unique) |
|
|
2005
|
+
| `variants.item_price` | number | body | No | Price in cents (min: 0) |
|
|
2006
|
+
| `variants.compare_price` | number | body | No | Compare-at price in cents (must be >= `item_price`) |
|
|
2007
|
+
| `variants.manage_cost` | string | body | No | Enable cost tracking |
|
|
2008
|
+
| `variants.item_cost` | number | body | Conditional | Required if `manage_cost` is `true` |
|
|
2009
|
+
| `variants.fulfillment_type` | string | body | Yes | `physical` or `digital` |
|
|
2010
|
+
| `variants.manage_stock` | integer | body | No | `0` or `1` |
|
|
2011
|
+
| `variants.stock_status` | string | body | Conditional | Required if `manage_stock` is `1`. Values: `in-stock`, `out-of-stock` |
|
|
2012
|
+
| `variants.total_stock` | integer | body | Yes | Total stock quantity |
|
|
2013
|
+
| `variants.available` | integer | body | Yes | Available stock |
|
|
2014
|
+
| `variants.committed` | integer | body | Yes | Committed stock |
|
|
2015
|
+
| `variants.on_hold` | integer | body | Yes | Stock on hold |
|
|
2016
|
+
| `variants.serial_index` | integer | body | No | Display order index |
|
|
2017
|
+
| `variants.downloadable` | string | body | No | Downloadable flag |
|
|
2018
|
+
| `variants.other_info.payment_type` | string | body | Yes | `onetime` or `subscription` |
|
|
2019
|
+
| `variants.other_info.description` | string | body | No | Description (max 255 chars) |
|
|
2020
|
+
| `variants.other_info.repeat_interval` | string | body | Conditional | Required for subscriptions (e.g., `monthly`, `yearly`) |
|
|
2021
|
+
| `variants.other_info.times` | number | body | No | Number of billing cycles |
|
|
2022
|
+
| `variants.other_info.trial_days` | number | body | No | Trial days (max 365) |
|
|
2023
|
+
| `variants.other_info.billing_summary` | string | body | No | Billing summary (max 255 chars) |
|
|
2024
|
+
| `variants.other_info.manage_setup_fee` | string | body | Conditional | Required for subscriptions: `yes` or `no` |
|
|
2025
|
+
| `variants.other_info.signup_fee` | number | body | Conditional | Setup fee in cents. Required if `manage_setup_fee` is `yes` |
|
|
2026
|
+
| `variants.other_info.signup_fee_name` | string | body | Conditional | Setup fee label (max 100 chars). Required if `manage_setup_fee` is `yes` |
|
|
2027
|
+
| `variants.media` | array | body | No | Media images array with `id`, `url`, `title` |
|
|
2028
|
+
|
|
2029
|
+
#### Response
|
|
2030
|
+
|
|
2031
|
+
```
|
|
2032
|
+
{
|
|
2033
|
+
"variant": {
|
|
2034
|
+
"id": 460,
|
|
2035
|
+
"post_id": 123,
|
|
2036
|
+
"variation_title": "Pro Plan",
|
|
2037
|
+
"item_price": 2999,
|
|
2038
|
+
"sku": "PRO-PLN",
|
|
2039
|
+
"stock_status": "in-stock"
|
|
2040
|
+
},
|
|
2041
|
+
"message": "Variation created successfully"
|
|
2042
|
+
}
|
|
2043
|
+
```
|
|
2044
|
+
|
|
2045
|
+
#### Example
|
|
2046
|
+
|
|
2047
|
+
```
|
|
2048
|
+
curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/variants" \
|
|
2049
|
+
-u "username:app_password" \
|
|
2050
|
+
-H "Content-Type: application/json" \
|
|
2051
|
+
-d '{
|
|
2052
|
+
"variants": {
|
|
2053
|
+
"post_id": 123,
|
|
2054
|
+
"variation_title": "Pro Plan",
|
|
2055
|
+
"item_price": 2999,
|
|
2056
|
+
"sku": "PRO-PLN",
|
|
2057
|
+
"fulfillment_type": "digital",
|
|
2058
|
+
"total_stock": 1,
|
|
2059
|
+
"available": 1,
|
|
2060
|
+
"committed": 0,
|
|
2061
|
+
"on_hold": 0,
|
|
2062
|
+
"other_info": {
|
|
2063
|
+
"payment_type": "onetime"
|
|
2064
|
+
}
|
|
2065
|
+
}
|
|
2066
|
+
}'
|
|
2067
|
+
```
|
|
2068
|
+
|
|
2069
|
+
---
|
|
2070
|
+
|
|
2071
|
+
### Update Variation
|
|
2072
|
+
|
|
2073
|
+
POST `/fluent-cart/v2/products/variants/{variantId}`
|
|
2074
|
+
|
|
2075
|
+
Update an existing product variation.
|
|
2076
|
+
|
|
2077
|
+
- **Permission:** `products/edit`
|
|
2078
|
+
- **Request Class:** `ProductVariationRequest`
|
|
2079
|
+
|
|
2080
|
+
#### Parameters
|
|
2081
|
+
|
|
2082
|
+
| Parameter | Type | Location | Required | Description |
|
|
2083
|
+
| --- | --- | --- | --- | --- |
|
|
2084
|
+
| `variantId` | integer | path | Yes | The variation ID to update |
|
|
2085
|
+
|
|
2086
|
+
All body parameters are the same as [Create Variation](#create-variation).
|
|
2087
|
+
|
|
2088
|
+
#### Response
|
|
2089
|
+
|
|
2090
|
+
```
|
|
2091
|
+
{
|
|
2092
|
+
"variant": { ... },
|
|
2093
|
+
"message": "Variation updated successfully"
|
|
2094
|
+
}
|
|
2095
|
+
```
|
|
2096
|
+
|
|
2097
|
+
#### Example
|
|
2098
|
+
|
|
2099
|
+
```
|
|
2100
|
+
curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/variants/460" \
|
|
2101
|
+
-u "username:app_password" \
|
|
2102
|
+
-H "Content-Type: application/json" \
|
|
2103
|
+
-d '{
|
|
2104
|
+
"variants": {
|
|
2105
|
+
"id": 460,
|
|
2106
|
+
"post_id": 123,
|
|
2107
|
+
"variation_title": "Pro Plan - Updated",
|
|
2108
|
+
"item_price": 3999,
|
|
2109
|
+
"fulfillment_type": "digital",
|
|
2110
|
+
"total_stock": 1,
|
|
2111
|
+
"available": 1,
|
|
2112
|
+
"committed": 0,
|
|
2113
|
+
"on_hold": 0,
|
|
2114
|
+
"other_info": {
|
|
2115
|
+
"payment_type": "onetime"
|
|
2116
|
+
}
|
|
2117
|
+
}
|
|
2118
|
+
}'
|
|
2119
|
+
```
|
|
2120
|
+
|
|
2121
|
+
---
|
|
2122
|
+
|
|
2123
|
+
### Delete Variation
|
|
2124
|
+
|
|
2125
|
+
DELETE `/fluent-cart/v2/products/variants/{variantId}`
|
|
2126
|
+
|
|
2127
|
+
Delete a product variation.
|
|
2128
|
+
|
|
2129
|
+
- **Permission:** `products/delete`
|
|
2130
|
+
|
|
2131
|
+
#### Parameters
|
|
2132
|
+
|
|
2133
|
+
| Parameter | Type | Location | Required | Description |
|
|
2134
|
+
| --- | --- | --- | --- | --- |
|
|
2135
|
+
| `variantId` | integer | path | Yes | The variation ID to delete |
|
|
2136
|
+
|
|
2137
|
+
#### Response
|
|
2138
|
+
|
|
2139
|
+
```
|
|
2140
|
+
{
|
|
2141
|
+
"message": "Variation deleted successfully"
|
|
2142
|
+
}
|
|
2143
|
+
```
|
|
2144
|
+
|
|
2145
|
+
#### Example
|
|
2146
|
+
|
|
2147
|
+
```
|
|
2148
|
+
curl -X DELETE "https://example.com/wp-json/fluent-cart/v2/products/variants/460" \
|
|
2149
|
+
-u "username:app_password"
|
|
2150
|
+
```
|
|
2151
|
+
|
|
2152
|
+
---
|
|
2153
|
+
|
|
2154
|
+
### Set Variation Media
|
|
2155
|
+
|
|
2156
|
+
POST `/fluent-cart/v2/products/variants/{variantId}/setMedia`
|
|
2157
|
+
|
|
2158
|
+
Set media/images for a variation.
|
|
2159
|
+
|
|
2160
|
+
- **Permission:** `products/edit`
|
|
2161
|
+
|
|
2162
|
+
#### Parameters
|
|
2163
|
+
|
|
2164
|
+
| Parameter | Type | Location | Required | Description |
|
|
2165
|
+
| --- | --- | --- | --- | --- |
|
|
2166
|
+
| `variantId` | integer | path | Yes | The variation ID |
|
|
2167
|
+
| `media` | array | body | Yes | Array of media objects |
|
|
2168
|
+
| `media.*.id` | integer | body | Yes | WordPress attachment ID |
|
|
2169
|
+
| `media.*.title` | string | body | No | Image title |
|
|
2170
|
+
| `media.*.url` | string | body | No | Image URL |
|
|
2171
|
+
|
|
2172
|
+
#### Response
|
|
2173
|
+
|
|
2174
|
+
```
|
|
2175
|
+
{
|
|
2176
|
+
"message": "Media set successfully"
|
|
2177
|
+
}
|
|
2178
|
+
```
|
|
2179
|
+
|
|
2180
|
+
#### Example
|
|
2181
|
+
|
|
2182
|
+
```
|
|
2183
|
+
curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/variants/460/setMedia" \
|
|
2184
|
+
-u "username:app_password" \
|
|
2185
|
+
-H "Content-Type: application/json" \
|
|
2186
|
+
-d '{
|
|
2187
|
+
"media": [
|
|
2188
|
+
{
|
|
2189
|
+
"id": 101,
|
|
2190
|
+
"title": "Product Image",
|
|
2191
|
+
"url": "https://example.com/wp-content/uploads/product.jpg"
|
|
2192
|
+
}
|
|
2193
|
+
]
|
|
2194
|
+
}'
|
|
2195
|
+
```
|
|
2196
|
+
|
|
2197
|
+
---
|
|
2198
|
+
|
|
2199
|
+
### Update Variation Pricing Table
|
|
2200
|
+
|
|
2201
|
+
PUT `/fluent-cart/v2/products/variants/{variantId}/pricing-table`
|
|
2202
|
+
|
|
2203
|
+
Update the pricing table description for a variation.
|
|
2204
|
+
|
|
2205
|
+
- **Permission:** `products/edit`
|
|
2206
|
+
|
|
2207
|
+
#### Parameters
|
|
2208
|
+
|
|
2209
|
+
| Parameter | Type | Location | Required | Description |
|
|
2210
|
+
| --- | --- | --- | --- | --- |
|
|
2211
|
+
| `variantId` | integer | path | Yes | The variation ID |
|
|
2212
|
+
| `description` | string | body | Yes | Pricing table description text (newlines preserved) |
|
|
2213
|
+
|
|
2214
|
+
#### Response
|
|
2215
|
+
|
|
2216
|
+
```
|
|
2217
|
+
{
|
|
2218
|
+
"message": "Pricing table updated successfully"
|
|
2219
|
+
}
|
|
2220
|
+
```
|
|
2221
|
+
|
|
2222
|
+
#### Example
|
|
2223
|
+
|
|
2224
|
+
```
|
|
2225
|
+
curl -X PUT "https://example.com/wp-json/fluent-cart/v2/products/variants/460/pricing-table" \
|
|
2226
|
+
-u "username:app_password" \
|
|
2227
|
+
-H "Content-Type: application/json" \
|
|
2228
|
+
-d '{
|
|
2229
|
+
"description": "Includes:\n- Feature A\n- Feature B\n- Priority Support"
|
|
2230
|
+
}'
|
|
2231
|
+
```
|
|
2232
|
+
|
|
2233
|
+
---
|
|
2234
|
+
|
|
2235
|
+
## Variants (VariantController)
|
|
2236
|
+
|
|
2237
|
+
### List All Variants
|
|
2238
|
+
|
|
2239
|
+
GET `/fluent-cart/v2/variants`
|
|
2240
|
+
|
|
2241
|
+
Retrieve all product variations across all products (separate route group using `VariantController`).
|
|
2242
|
+
|
|
2243
|
+
- **Permission:** `products/view`
|
|
2244
|
+
- **Policy:** `ProductPolicy`
|
|
2245
|
+
|
|
2246
|
+
#### Parameters
|
|
2247
|
+
|
|
2248
|
+
| Parameter | Type | Location | Required | Description |
|
|
2249
|
+
| --- | --- | --- | --- | --- |
|
|
2250
|
+
| `params` | object | query | No | Query parameters for filtering |
|
|
2251
|
+
|
|
2252
|
+
#### Response
|
|
2253
|
+
|
|
2254
|
+
Returns an array of all product variation objects.
|
|
2255
|
+
|
|
2256
|
+
```
|
|
2257
|
+
[
|
|
2258
|
+
{
|
|
2259
|
+
"id": 456,
|
|
2260
|
+
"post_id": 123,
|
|
2261
|
+
"variation_title": "Default Plan",
|
|
2262
|
+
"item_price": 1000,
|
|
2263
|
+
"sku": null,
|
|
2264
|
+
"stock_status": "in-stock",
|
|
2265
|
+
"payment_type": "onetime",
|
|
2266
|
+
"other_info": { ... }
|
|
2267
|
+
}
|
|
2268
|
+
]
|
|
2269
|
+
```
|
|
2270
|
+
|
|
2271
|
+
#### Example
|
|
2272
|
+
|
|
2273
|
+
```
|
|
2274
|
+
curl -X GET "https://example.com/wp-json/fluent-cart/v2/variants" \
|
|
2275
|
+
-u "username:app_password"
|
|
2276
|
+
```
|
|
2277
|
+
|
|
2278
|
+
---
|
|
2279
|
+
|
|
2280
|
+
## Product Integrations
|
|
2281
|
+
|
|
2282
|
+
### Get Product Integration Feeds
|
|
2283
|
+
|
|
2284
|
+
GET `/fluent-cart/v2/products/{productId}/integrations`
|
|
2285
|
+
|
|
2286
|
+
Retrieve all integration feeds configured for a product, along with available integrations.
|
|
2287
|
+
|
|
2288
|
+
- **Permission:** `products/view`
|
|
2289
|
+
|
|
2290
|
+
#### Parameters
|
|
2291
|
+
|
|
2292
|
+
| Parameter | Type | Location | Required | Description |
|
|
2293
|
+
| --- | --- | --- | --- | --- |
|
|
2294
|
+
| `productId` | integer | path | Yes | The product ID |
|
|
2295
|
+
|
|
2296
|
+
#### Response
|
|
2297
|
+
|
|
2298
|
+
```
|
|
2299
|
+
{
|
|
2300
|
+
"feeds": [
|
|
2301
|
+
{
|
|
2302
|
+
"id": 10,
|
|
2303
|
+
"name": "Add to FluentCRM List",
|
|
2304
|
+
"enabled": "yes",
|
|
2305
|
+
"provider": "fluentcrm",
|
|
2306
|
+
"feed": { ... },
|
|
2307
|
+
"scope": "product"
|
|
2308
|
+
}
|
|
2309
|
+
],
|
|
2310
|
+
"available_integrations": {
|
|
2311
|
+
"fluentcrm": {
|
|
2312
|
+
"title": "FluentCRM",
|
|
2313
|
+
"logo": "...",
|
|
2314
|
+
"enabled": true,
|
|
2315
|
+
"scopes": ["product", "order"]
|
|
2316
|
+
}
|
|
2317
|
+
},
|
|
2318
|
+
"all_module_config_url": "https://example.com/wp-admin/admin.php?page=fluent-cart#/integrations"
|
|
2319
|
+
}
|
|
2320
|
+
```
|
|
2321
|
+
|
|
2322
|
+
#### Example
|
|
2323
|
+
|
|
2324
|
+
```
|
|
2325
|
+
curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/123/integrations" \
|
|
2326
|
+
-u "username:app_password"
|
|
2327
|
+
```
|
|
2328
|
+
|
|
2329
|
+
---
|
|
2330
|
+
|
|
2331
|
+
### Get Product Integration Settings
|
|
2332
|
+
|
|
2333
|
+
GET `/fluent-cart/v2/products/{product_id}/integrations/{integration_name}/settings`
|
|
2334
|
+
|
|
2335
|
+
Retrieve settings for a specific integration type on a product. Returns the integration form configuration, existing settings, and product variations.
|
|
2336
|
+
|
|
2337
|
+
- **Permission:** `products/view`
|
|
2338
|
+
|
|
2339
|
+
#### Parameters
|
|
2340
|
+
|
|
2341
|
+
| Parameter | Type | Location | Required | Description |
|
|
2342
|
+
| --- | --- | --- | --- | --- |
|
|
2343
|
+
| `product_id` | integer | path | Yes | The product ID |
|
|
2344
|
+
| `integration_name` | string | path | Yes | Integration provider name (e.g., `fluentcrm`) |
|
|
2345
|
+
| `integration_id` | integer | query | No | Existing integration feed ID to load for editing |
|
|
2346
|
+
|
|
2347
|
+
#### Response
|
|
2348
|
+
|
|
2349
|
+
```
|
|
2350
|
+
{
|
|
2351
|
+
"settings": {
|
|
2352
|
+
"conditional_variation_ids": [],
|
|
2353
|
+
...
|
|
2354
|
+
},
|
|
2355
|
+
"fields": [ ... ],
|
|
2356
|
+
"product_variations": [
|
|
2357
|
+
{
|
|
2358
|
+
"id": 456,
|
|
2359
|
+
"title": "Monthly Plan"
|
|
2360
|
+
}
|
|
2361
|
+
],
|
|
2362
|
+
"scope": "product"
|
|
2363
|
+
}
|
|
2364
|
+
```
|
|
2365
|
+
|
|
2366
|
+
#### Example
|
|
2367
|
+
|
|
2368
|
+
```
|
|
2369
|
+
curl -X GET "https://example.com/wp-json/fluent-cart/v2/products/123/integrations/fluentcrm/settings" \
|
|
2370
|
+
-u "username:app_password"
|
|
2371
|
+
```
|
|
2372
|
+
|
|
2373
|
+
---
|
|
2374
|
+
|
|
2375
|
+
### Save Product Integration
|
|
2376
|
+
|
|
2377
|
+
POST `/fluent-cart/v2/products/{product_id}/integrations`
|
|
2378
|
+
|
|
2379
|
+
Create or update an integration feed for a product.
|
|
2380
|
+
|
|
2381
|
+
- **Permission:** `products/edit`
|
|
2382
|
+
|
|
2383
|
+
#### Parameters
|
|
2384
|
+
|
|
2385
|
+
| Parameter | Type | Location | Required | Description |
|
|
2386
|
+
| --- | --- | --- | --- | --- |
|
|
2387
|
+
| `product_id` | integer | path | Yes | The product ID |
|
|
2388
|
+
| `integration_name` | string | body | Yes | Integration provider name |
|
|
2389
|
+
| `integration_id` | integer | body | No | Existing feed ID (for updates) |
|
|
2390
|
+
| `integration` | string (JSON) | body | Yes | JSON-encoded integration settings object |
|
|
2391
|
+
|
|
2392
|
+
#### Response
|
|
2393
|
+
|
|
2394
|
+
```
|
|
2395
|
+
{
|
|
2396
|
+
"message": "Integration has been successfully saved",
|
|
2397
|
+
"integration_id": 10,
|
|
2398
|
+
"integration_name": "fluentcrm",
|
|
2399
|
+
"created": true,
|
|
2400
|
+
"feedData": { ... }
|
|
2401
|
+
}
|
|
2402
|
+
```
|
|
2403
|
+
|
|
2404
|
+
#### Example
|
|
2405
|
+
|
|
2406
|
+
```
|
|
2407
|
+
curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/123/integrations" \
|
|
2408
|
+
-u "username:app_password" \
|
|
2409
|
+
-H "Content-Type: application/json" \
|
|
2410
|
+
-d '{
|
|
2411
|
+
"integration_name": "fluentcrm",
|
|
2412
|
+
"integration": "{\"name\":\"Add to List\",\"list_id\":1,\"enabled\":\"yes\"}"
|
|
2413
|
+
}'
|
|
2414
|
+
```
|
|
2415
|
+
|
|
2416
|
+
---
|
|
2417
|
+
|
|
2418
|
+
### Delete Product Integration
|
|
2419
|
+
|
|
2420
|
+
DELETE `/fluent-cart/v2/products/{product_id}/integrations/{integration_id}`
|
|
2421
|
+
|
|
2422
|
+
Delete a product integration feed.
|
|
2423
|
+
|
|
2424
|
+
- **Permission:** `products/delete`
|
|
2425
|
+
|
|
2426
|
+
#### Parameters
|
|
2427
|
+
|
|
2428
|
+
| Parameter | Type | Location | Required | Description |
|
|
2429
|
+
| --- | --- | --- | --- | --- |
|
|
2430
|
+
| `product_id` | integer | path | Yes | The product ID |
|
|
2431
|
+
| `integration_id` | integer | path | Yes | The integration feed ID to delete |
|
|
2432
|
+
|
|
2433
|
+
#### Response
|
|
2434
|
+
|
|
2435
|
+
```
|
|
2436
|
+
{
|
|
2437
|
+
"message": "Integration deleted successfully"
|
|
2438
|
+
}
|
|
2439
|
+
```
|
|
2440
|
+
|
|
2441
|
+
#### Example
|
|
2442
|
+
|
|
2443
|
+
```
|
|
2444
|
+
curl -X DELETE "https://example.com/wp-json/fluent-cart/v2/products/123/integrations/10" \
|
|
2445
|
+
-u "username:app_password"
|
|
2446
|
+
```
|
|
2447
|
+
|
|
2448
|
+
---
|
|
2449
|
+
|
|
2450
|
+
### Change Integration Status
|
|
2451
|
+
|
|
2452
|
+
POST `/fluent-cart/v2/products/{product_id}/integrations/feed/change-status`
|
|
2453
|
+
|
|
2454
|
+
Enable or disable a product integration feed.
|
|
2455
|
+
|
|
2456
|
+
- **Permission:** `products/edit`
|
|
2457
|
+
|
|
2458
|
+
#### Parameters
|
|
2459
|
+
|
|
2460
|
+
| Parameter | Type | Location | Required | Description |
|
|
2461
|
+
| --- | --- | --- | --- | --- |
|
|
2462
|
+
| `product_id` | integer | path | Yes | The product ID |
|
|
2463
|
+
| `notification_id` | integer | body | Yes | The integration feed ID |
|
|
2464
|
+
| `status` | string | body | Yes | `yes` to enable, `no` to disable |
|
|
2465
|
+
|
|
2466
|
+
#### Response
|
|
2467
|
+
|
|
2468
|
+
```
|
|
2469
|
+
{
|
|
2470
|
+
"message": "Integration status has been updated"
|
|
2471
|
+
}
|
|
2472
|
+
```
|
|
2473
|
+
|
|
2474
|
+
#### Example
|
|
2475
|
+
|
|
2476
|
+
```
|
|
2477
|
+
curl -X POST "https://example.com/wp-json/fluent-cart/v2/products/123/integrations/feed/change-status" \
|
|
2478
|
+
-u "username:app_password" \
|
|
2479
|
+
-H "Content-Type: application/json" \
|
|
2480
|
+
-d '{
|
|
2481
|
+
"product_id": 123,
|
|
2482
|
+
"notification_id": 10,
|
|
2483
|
+
"status": "yes"
|
|
2484
|
+
}'
|
|
2485
|
+
```
|