Skip to main content
PUT
Update Product

Authorizations

Authorization
string
header
required

You can retrieve your API key from your dashboard under Account > Developers.

Path Parameters

shopId
integer
required

The shop ID.

productId
integer
required

The product ID.

Body

application/json
type
enum<string>
required
Available options:
variant,
addon
Example:

"addon"

name
string
required

Must not be greater than 255 characters.

Example:

"asyzwszwtxpeqqi"

currency
string
required

Must not be greater than 3 characters.

Example:

"on"

visibility
enum<string>
required
Available options:
public,
unlisted,
private,
on_hold
Example:

"on_hold"

product_addons
string[]
required
Example:
product_upsells
string[]
required
Example:
path
string

Must match the regex /^[a-z0-9-]+$/.

Example:

"8"

category_id
string
Example:

null

description
string

Must not be greater than 65535 characters.

Example:

"Accusamus nihil repellat vero omnis voluptates id amet et."

meta_title
string

Must not be greater than 255 characters.

Example:

"qikymwkiinfowtz"

meta_description
string

Must not be greater than 65535 characters.

Example:

"mixkolowyuffszf"

meta_image_id
string
Example:

null

meta_twitter_card
enum<string>
Available options:
summary,
summary_large_image
Example:

"summary_large_image"

instructions
string

Must not be greater than 65535 characters.

Example:

"csnwwxvxezhebdr"

out_of_stock_message
string

Must not be greater than 65535 characters.

Example:

"xkpiypmuihrdife"

thank_you_message
string

Must not be greater than 65535 characters.

Example:

"kzagqzitsslufxb"

tax_inclusive
boolean
Example:

false

deliverables_type
enum<string>
Available options:
serials,
service,
files,
dynamic,
physical
Example:

"serials"

requires_fulfillment
boolean
Example:

false

custom_fields_after_payment
boolean
Example:

true

group_id
string
Example:

null

image_ids
string[]
Example:

null

discord_required
boolean
Example:

false

required_discord_guild_id
string

This field is required when required_discord_role_id is present. Must not be greater than 255 characters.

Example:

"dnacixfxgsmpbol"

required_discord_role_id
string

This field is required when required_discord_guild_id is present. Must not be greater than 255 characters.

Example:

"pwypthgxnkysmpo"

hide_stock_count
boolean
Example:

true

cashback_percentage
number

Must be at least 0. Must not be greater than 100.

Example:

20

payment_method_fee_overrides
number[]

Must be at least -50. Must not be greater than 50.

Example:
reseller_enabled
boolean
Example:

true

reseller_disable_volume_discount
boolean
Example:

true

status_color
string

Must not be greater than 24 characters.

Example:

"wnubzpcclwldce"

status_text
string

Must not be greater than 255 characters.

Example:

"qpnviyqjogqswwh"

show_views_count
boolean
Example:

false

show_sales_count
boolean
Example:

false

show_sales_notifications
boolean
Example:

false

sales_count_hours
number
Example:

6.5279

feedback_coupon_config
object
Example:

null

deliverables_label
string

Must not be greater than 255 characters.

Example:

"qikymwkiinfowtz"

metadata
string

Must not be greater than 65535 characters.

Example:

"mixkolowyuffszf"

is_mandatory
boolean
Example:

false

custom_fields
string[]
Example:
product_tabs
string[]

Must not have more than 10 items.

Example:

"asyzws"

product_badges
string[]

Must not have more than 10 items.

Example:

"zwtxpe"

variants
string[]

This field is required when type is variant. Must have at least 1 items.

Example:

"asyzwszwtxpeqqikymwkiinfowtzmixkolowyuffszfrcsnwwxvxe"

Response

200 - undefined