Skip to main content
PATCH
Patch 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>
Available options:
variant,
addon
Example:

"addon"

name
string

Must not be greater than 255 characters.

Example:

"tjqotbhpzwonwlzospqcs"

path
string | null

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

Example:

"o"

category_id
string | null
Example:

null

description
string | null

Must not be greater than 65535 characters.

Example:

"Quaerat ut fuga non quibusdam itaque ut quia at."

meta_title
string | null

Must not be greater than 255 characters.

Example:

"zospqcsnssrciatkmatld"

meta_description
string | null

Must not be greater than 65535 characters.

Example:

"znkaapjptdhyldmarwuvl"

meta_image_id
string | null

Must match an existing stored value.

Example:

null

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

"summary_large_image"

instructions
string | null

Must not be greater than 65535 characters.

Example:

"vyfcejzolbxnqyvzmcgyf"

out_of_stock_message
string | null

Must not be greater than 65535 characters.

Example:

"pncfystnonjizoohlpabv"

thank_you_message
string | null

Must not be greater than 65535 characters.

Example:

"wbfbzkwsewlxtdfjxskyk"

currency
string

Must not be greater than 3 characters.

Example:

"aa"

tax_inclusive
boolean | null
Example:

true

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

"dynamic"

requires_fulfillment
boolean | null
Example:

false

custom_fields_after_payment
boolean | null
Example:

true

group_id
string | null

Must match an existing stored value.

Example:

null

image_ids
string[]

Must match an existing stored value.

Example:

null

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

"on_hold"

password_mode
enum<string> | null

Password lock: view hides the product page behind the password, purchase keeps the page public and requires the password to buy. Null removes the lock; leave it out to keep the current one.

Available options:
view,
purchase
Example:

"purchase"

password
string | null

The password buyers enter to unlock the product. Required with password_mode unless the product already has one. Must be at least 3 characters. Must not be greater than 100 characters.

Example:

"early-access"

discord_required
boolean | null
Example:

true

required_discord_guild_id
string | null

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

Example:

"pbpdxvoinjyyjgewzrvld"

required_discord_role_id
string | null

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

Example:

"mtktykspxnwtkwmotupun"

hide_stock_count
boolean | null
Example:

true

volume_discounts_combined
boolean | null

Count every variant of this product in the cart together toward each variant's volume discount tiers. Tiers stay per variant.

Example:

false

cashback_percentage
number | null

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

Example:

22

payment_method_fee_overrides
(number | null)[]

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

Example:
status_color
string | null

Must not be greater than 24 characters.

Example:

"ewaeqmxearmqdr"

status_text
string | null

Must not be greater than 255 characters.

Example:

"ugeraqymfegawtjymzjry"

show_views_count
boolean | null
Example:

false

show_sales_count
boolean | null
Example:

false

show_sales_notifications
boolean | null
Example:

false

sales_count_hours
number | null
Example:

666245.61078

feedback_coupon_config
object | null
Example:

null

deliverables_label
string | null

Must not be greater than 255 characters.

Example:

"zwonwlzospqcsnssrciat"

metadata
string | null

Must not be greater than 65535 characters.

Example:

"kmatldznkaapjptdhyldm"

is_mandatory
boolean | null
Example:

true

custom_fields
(object | null)[]
Example:

null

product_tabs
(object | null)[]

Must not have more than 10 items.

Example:

null

product_badges
(object | null)[]

Must not have more than 10 items.

Example:

null

product_addons
integer[]

IDs of the addon products (type addon) offered with this product, in display order. The product_addons objects returned by Get Product are also accepted (their addon_product_id is used). Variant products only. Must match an existing stored value.

Example:
product_upsells
integer[]

IDs of the products offered as upsells, in display order. The product_upsells objects returned by Get Product are also accepted (their upsell_product_id is used). Variant products only. Must match an existing stored value.

Example:
variants
string

Not accepted. Use the variant endpoints to change variants.

Example:

null

Response

200