Update one product variant

patch

https://api.scalev.com/v3/variants/{id}

Requires the product:update scope. Updates a single variant. Product update does not accept bulk variant changes.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

length ≥ 1

^(?:[1-9][0-9]*|variant_[A-Za-z0-9_-]+|[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12})$

Positive numeric variant ID, variant_... unique reference, or canonical UUID, resolved within the authenticated business.

Body Params

Single product variant data to update

cogs

number

Cost of Goods Sold

currency

string

enum

The currency code for the item price.

Allowed:

description

string

Variant Description

images

array of uris

List of image URLs

images

image_configs

object

Per-image variant configuration

interval

string

enum

Unit of the recurring billing period

Allowed:

interval_count

integer

Interval count for recurring variants

is_checked

boolean

Mark variant as sellable

is_discussion_active

boolean

Variant discussion capability flag

is_email_notification_active

boolean

Variant email notification capability flag

is_file_enabled

boolean

Variant file delivery capability flag

is_license_enabled

boolean

Variant license capability flag

is_lms_enabled

boolean

Variant LMS capability flag

item_type

string

enum

Type of the product item

Allowed:

metadata

object

Additional metadata

option1_value

string

Option 1 value for this variant. May be set only when the product has option1_name configured.

option2_value

string

Option 2 value for this variant. May be set only when the product has option2_name configured.

option3_value

string

Option 3 value for this variant. May be set only when the product has option3_name configured.

price

number

Price

pricing_type

string

enum

Type of the product pricing

Allowed:

reseller_price

number

Reseller Price

rich_description

string

Variant Rich Description

self_file_urls

array of uris

List of self file URLs

self_file_urls

sku

string

SKU

validity_period

integer

Validity period for one-time variants

validity_period_unit

string

enum

Unit of the one-time validity period

Allowed:

weight

integer

Weight in grams

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Product variant

400Bad Request

401Unauthorized

403Forbidden

404Not Found