Skip to main content
Update product variant

Authorizations

X-API-Key
string
header
required

Path Parameters

id
string
required

Body

application/json
sku
string
Required string length: 1 - 255
custom_fields
object[]

Response

200 - application/json
id
string<uuid>
required
read-only
bigcommerce_id
integer
required
read-only
sku
string
required
Required string length: 1 - 255
is_purchasable
boolean
required
read-only
base_price
string<decimal>
required
read-only

The regular price, before any sale.

Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
list_price
string<decimal>
required
read-only

The price currently charged, which reflects any sale in progress.

Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
cost_price
string<decimal>
required
read-only

What this variant costs the store.

Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
inventory_level
integer | null
required
read-only

null when inventory is not tracked at the variant level.

custom_fields
object[]
required
product
object
required
options
object[]
required
read-only