v1
latestOpenAPI 3.1.02026-07-26620219.6 KBRetrieve product variants
get/core/v3/stores/{store_id}/products/{yotpo_product_id}/variants
Path parameters
store_idstring required
The store ID (app_key).
yotpo_product_idinteger required
The Yotpo ID for the product. This ID is created automatically upon creation of the product. You can find it by using the Retrieve endpoint.
Query parameters
page_infostring
Encoded page info.
limitinteger
Defines how many results will be returned per page. Can be any number between 1 and 100.
external_idsstring
Return only entities specified by a comma-separated (without spaces) list of external IDs. The argument must be <a href="https://www.urlencoder.io/learn" target="_blank">URL encoded</a>. Max 100 IDs. Can't come with page_info or limit.
access_tokenstring required
Your Yotpo access token. Click here to learn how to generate one.
Response
200
Example response
{
"variants": [
{
"yotpo_id": 300021,
"external_id": "var0001",
"name": "blue minimal surfboard",
"description": "A great surfboard!",
"url": "http://www.waverider.com/products/minimalsurfboard?variant=vr125f633d6h",
"is_valid_url": true,
"image_url": "http://www.waverider.com/products/minimalsurfboard/images/blue2.jpg",
"price": 750,
"compare_at_price": 800,
"currency": "USD",
"inventory_quantity": 4,
"sku": "xxxxx",
"gtins": [
{
"declared_type": "UPC",
"value": "742833102466"
}
],
"options": [
{
"name": "color",
"value": "blue"
}
],
"created_at": "2020-09-08T08:43:27Z",
"updated_at": "2020-10-08T08:43:27Z"
}
],
"pagination": {
"next_page_info": "eyJjdXJzb3IiOjE4ODgwNzE2NSwiZmlsdGVyIjpbeyJuYW1lIjoic3RvcmVJZCIsImRhdGVfdHlwZSI6IlNUUklORyIsInZhbHVlIjoiQWd4eGhiRENyTFZZQUg4cDZEN1Z5MGNPRjZmcENacm45UUlrU2hKNyJ9XX0="
}
}