The Product entity allows you to keep your catalog in-sync with Yotpo. Product information is used by Yotpo to power various capabilities such as tagging photos to products, populating review-request emails with product information, and showing recommendations in the widgets.

📘

Products endpoints are available for Reviews, SMS Marketing, and Visual UGC.

Good to know

Products may be implicitly created when product information is provided along with the order in the "register_purchase" endpoint.

Product endpoints

👍

Coming soon!

If your product has options such as size or color, you'll soon be able to add a variant for each combination of options.

Product properties

Listed below are all of the available properties for products. 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.
Max. length: 255 characters

name

string

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

yotpo_id

long

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

description

text

The description of the product.

status

string

The status of the product.
Valid values: active, draft, archived, inactive

url

string

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

is_valid_url_format

boolean

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

image_url

string

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

price

double

The price of the product.

compare_at_price

double

The original price of the product before any adjustments or sales

currency

string

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

inventory_quantity

integer

The number of items available in stock.

is_discontinued

boolean

Whether the product has been discontinued. Such products will be automatically added to. a blocklist. See more information about our blocklist functionality in the custom properties section below.

group_name

string

Products with the same group name will share reviews. If left empty, the product will be removed from its existing group. You can add up to 1,000 products to a group. Learn more about grouping products

Max. length: 100 characters
Valid values: Alphanumeric characters a-z, 0-9, "_" and "-"

brand

string

The brand of the product. Important for any type of integration between Reviews and Google, and/or retail syndication. See product identifiers below.

Max. length: 255 characters

sku

string

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

mpn

string

The Manufacturer Part Number of the product. Important for any type of integration between Reviews and Google, and/or retail syndication. See product identifiers below.

Max. length: 255 characters

gtins

array of objects

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

Important for any type of integration between Reviews and Google, and/or retail syndication. See product identifiers below.

handle

string

The merchant's unique handle for the product.

custom_properties

object

A key-value set of additional properties.

See more about information about custome properties in the table below

created_at

datetime

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

updated_at

datetime

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

Product custom properties

Property Name

Type

Description

is_blocklisted

boolean

Products that are added to the blocklist 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

review_form_tag

string

The name of the custom review form that will be used for this product. If left blank, the default review form will be used.

Product identifiers

  • Product identifiers (GTINs, MPN, Brand, and SKU) are required and play a crucial role if you're using retail syndication and/or Google Shopping ads and want to take advantage of Yotpo’s unique partnership with Google, as a certified reviews provider, and other retailers like Walmart.
  • Product identifiers (GTINs, MPN, Brand, and SKU) play a crucial role if you're using Google Shopping ads and want to take advantage of Yotpo’s unique partnership with Google, as a certified reviews provider.
  • To maximize your chances of success when integrating with Google features and using retail syndication, we recommend filling as many identifiers as possible.