Skip to main content
PATCH
Error

Path Parameters

product_id
string
required

Product ID

app_slug
string
required

App slug

team_slug
string
required

Team slug

Body

application/json

Product data

brand_id
string

Brand or series of a brand connected to product

custom
object

Custom fields - null value removes the field, non-null merges with existing

description
string

Deprecated: read-only in write payloads. Derived from html_description.

exclude_from_feeds
boolean

Whenever a product should exist in feeds or not

html_description
string

HTML description of the description fields. All of the fields which is not related to showing content, e.g or

html_short_description
string

HTML Shortdescription of the description fields. All of the fields which is not related to showing content, e.g or

market_status
object[]
meta_description
string

Meta description for SEO

meta_title
string

Meta title for SEO

package_dimensions
object

The package dimensions

product_dimensions
object

The products dimensions

product_name
string

Name of the product

product_type
enum<string>

Product type. Default 'simple'

Available options:
flexible,
simple
short_description
string

Deprecated: read-only in write payloads. Derived from html_short_description.

slug
string

Slug for the product

status
enum<string>

Status of the product

Available options:
active,
draft,
inactive,
archived
tax_group_slug
string

If provided will the product using the selected tax group. Otherwise will we use the default tax group for the app

Response

Product updated successfully

data
object
details
string[]

Additional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes

success
boolean