GuidesRecipesAPI Reference
API Reference

Update variant

An endpoint for partially updating a product variant with the provided ID

Path Params
string
required

ID of the product to update

string
required

ID of the variant to update

Body Params

The request body

string

The Convictional variant ID. Read only.

Metafields
object
attributes
object
string

The barcode of the variant.

string

The type of barcode. Options are upc, gtin-13, gtin-14, or ean-8. The value "gtin" is also valid but is deprecated and will be converted to "gtin-13".

compareAtPrice
object

Comparison price within the seller's system

dimensions
object

The dimensions of the variant.

number

A legacy Convictional ID for this variant. Read only.

images
array of objects

An array of images corresponding to this variant.

images
integer

The amount of stock available.

string

The value for option 1.

string

The value for option 2.

string

The value for option 3.

number

The standard retail price for this SKU.

boolean
string

The seller's unique SKU for this variant.

string

The title of the variant.

number

The weight of the variant.

string

The units of weight. Options are g, kg, lb, oz, or t.

Responses

Language
Credentials
Header
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json