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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params

Product data to update

string

Description

boolean

Is Inventory

boolean

Is Product Sharing

string
enum
required

Type of the product item

Allowed:
uri

Meta Thumbnail

string
required

Product Name

string | null

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.

string | null

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

string | null

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.

string | null

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.

string

Partnership sales letter for affiliate/reseller promotion

string

Product Public Name

string

Rich Description

string

Product Slug

integer

Taxonomy ID

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json