v2

OpenAPI 3.0.3Proprietary2026-07-263483431.1 MB
Business Products

Update a business product

Requires the product:update scope. Updates the details of a product. Variant creation, updates, and deletion must use the dedicated variant endpoints. Product update may change is_multiple only through guarded single-active-variant transitions: true to false clears product option names and active variant option values; false to true requires option1_name and option1_value. Product update may also change option names through option1_name, option2_name, and option3_name; setting an option name to null removes that slot only when active variants have at most one unique value for that option, then moves any higher option names and variant values left to keep option slots contiguous.

patch/v3/products/{id}

Request body

descriptionstring

Description

is_inventoryboolean

Is Inventory

is_product_sharingboolean

Is Product Sharing

item_type'physical' | 'digital' | 'course' | 'license' | 'subscription' required

Type of the product item

meta_thumbnailstring uri

Meta Thumbnail

namestring required

Product Name

option1_namestring nullable

Product option 1 name. Set to null to remove this option. Removal is allowed only when active variants have at most one unique option1_value, then higher option names and variant values move left. Required with option1_value when setting is_multiple from false to true.

option1_valuestring nullable

Initial option 1 value applied to the only active variant when setting is_multiple from false to true.

option2_namestring nullable

Product option 2 name. Set to null to remove this option. Removal is allowed only when active variants have at most one unique option2_value, then option3_name and option3_value move into option2.

option3_namestring nullable

Product option 3 name. Set to null to remove this option. Removal clears option3_value on all variants only when active variants have at most one unique option3_value.

partnership_sales_letterstring

Partnership sales letter for affiliate/reseller promotion

public_namestring

Product Public Name

rich_descriptionstring

Rich Description

slugstring

Product Slug

taxonomy_idinteger

Taxonomy ID

Response

Product updated successfully

variants_countinteger

Variants Count

displaystring

Product name for display

option1_namestring

Option 1 Name

is_inventoryboolean

Is Inventory

uuidstring

Product UUID

rich_descriptionstring

Rich Description

affiliate_pro_commission_ratestring

Affiliate Pro Commission Rate (%)

item_type'physical' | 'digital' | 'course' | 'license' | 'subscription'

Type of the product item

is_affiliate_pro_enabledboolean

Is Affiliate Pro Enabled

item_type_namestring

Item Type Name

descriptionstring

Description

namestring

Product Name

idinteger

Product ID

option2_namestring

Option 2 Name

is_product_sharingboolean

Is Product Sharing

is_affiliate_auto_acceptboolean

Is Affiliate Auto Accept

meta_thumbnailstring uri

Meta Thumbnail

is_affiliate_enabledboolean

Is Affiliate Enabled

imagesstring[]
is_multipleboolean

Is Multiple

option3_namestring

Option 3 Name

last_updated_atstring date-time
partnership_sales_letterstring

Partnership sales letter for affiliate/reseller promotion

slugstring

Product Slug

affiliate_commission_ratestring

Affiliate Commission Rate (%)

public_namestring

Product Public Name

created_atstring date-time