Sync your product variants to Yotpo. Add variants to your products in order to represent one version of a product with several options, for example, size, or color. Each product will have a variant for every possible combination of its options.

🚧

These endpoints are currently in beta and may not work as expected.

📘

Product variants endpoints are available for Reviews and Visual UGC.

Good to know

  • Some e-commerce platform use a different name for product variants. You might know them as simple products, configurable products, variable products, grouped products, or product options. Learn more about Magento product types
  • You can add up to 20 options for each variant.

Product variant endpoints

Product variant properties

Listed below are all of the available properties for product variants. To see which properties are required per endpoint, refer to the endpoint pages below.

Field

Type

Description

external_id

string

The merchant's unique ID for the product variant.
Max length: 255 characters

yotpo_id

long

The ID generated by Yotpo for the product variant. This field is read-only.

name

string

The name of the product variant.
Max length: 255 characters

description

text

The description of the product variant.

url

string

The URL of the product variant on your store website.
Max length: 2048 characters

is_valid_url_format

boolean

An indication that the URL provided for the product variant is valid for PLA sync. This field is read-only.

image_url

string

The URL of the product variant image.
Max length: 2048 characters

price

double

The price of the product variant.

compare_at_price

double

The original price of the product variant before any adjustments or sales

currency

string

The currency of the product variant. Must be valid ISO code of 3 characters. See currency codes

inventory_quantity

integer

The quantity of product variants available for sale.

is_discontinued

boolean

Whether the product variant has been discontinued. Product variants that are discontinued will be excluded from product recommendations and other customer-facing widgets. Also, automatic email requests will not be sent out for them. Learn more about adding products to your blocklist

sku

string

Stock-Keeping Unit. Cannot contain spaces or the "/" symbol.
Max length: 255 characters

gtins

array of objects

Global trade item numbers, often called barcodes. See GTIN object description

options

array of objects

An array of objects relating to variant options.
Each option is specified using two fields.

  • The name specifies the variant name, for example, color, size, or materials.
  • The value fields holds the variant value, for example, for the color variant, the value could be blue.

"options": [
{
"name": "string",
"value": "string"
}

custom_properties

object

A key-value set of additional properties.

created_at

datetime

The time the variant was first synced to Yotpo. This field is read-only.

updated_at

datetime

The time the variant was last updated in Yotpo. This field is read-only.