---
updatedAt: 2026-10-29T11:54:48.000Z
agentTools:
  projectIndex: https://docs.yotpo.com/llms.txt
---

# Retrieve product variant by ID

Retrieves a product variant by store ID, product ID, and product variant ID.

> 👍 How to use this endpoint
>
> * Required parameters are listed below. For the full list of properties, see [About product variants](https://docs.yotpo.com/reference/product-variants).
> * For example responses, click the relevant status code on the right.

> 📘 App partners
>
> Partner apps call this endpoint at `GET https://developers.yotpo.com/core/v3/stores/{store_id}/products/{yotpo_product_id}/variants/{yotpo_variant_id}`, with the access token the merchant's install gave you in the `X-Yotpo-Token` header. See [Authenticating with OAuth 2.0](https://docs.yotpo.com/docs/authenticating).

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Yotpo API V3",
    "description": "Yotpo API V3 endpoints on api.yotpo.com. Webhook events are defined separately, in webhooks.json.",
    "version": "3.0"
  },
  "servers": [
    {
      "url": "https://api.yotpo.com"
    }
  ],
  "components": {
    "securitySchemes": {
      "X-Yotpo-Token": {
        "type": "apiKey",
        "in": "header",
        "name": "X-Yotpo-Token",
        "description": "Your Yotpo account access token. See [Authentication](https://core-api.yotpo.com/reference/yotpo-authentication) to learn how to generate your access token."
      }
    },
    "responses": {
      "Unauthorized": {
        "description": "Unauthorized. The access token in `X-Yotpo-Token` is invalid or expired, and the body is plain text. Generate a new token with [Generate access token](ref:yotpo-authentication). If the request also has an `Authorization: Bearer` header, the API checks that header instead of `X-Yotpo-Token` and returns `Bad token; invalid JSON` as JSON. Remove the `Authorization` header and send the token in `X-Yotpo-Token` only.",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "example": "unauthorized"
            }
          },
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "message": {
                  "type": "string",
                  "description": "Error message.",
                  "example": "Bad token; invalid JSON"
                }
              }
            },
            "examples": {
              "Authorization header sent": {
                "value": "{\n  \"message\": \"Bad token; invalid JSON\"\n}"
              }
            }
          }
        }
      },
      "Forbidden": {
        "description": "Forbidden. The request has no `X-Yotpo-Token` header.",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "message": {
                  "type": "string",
                  "description": "Error message.",
                  "example": "Forbidden"
                }
              }
            },
            "examples": {
              "Missing token": {
                "value": "{\n  \"message\": \"Forbidden\"\n}"
              }
            }
          }
        }
      }
    }
  },
  "security": [
    {
      "X-Yotpo-Token": []
    }
  ],
  "paths": {
    "/core/v3/stores/{store_id}/products/{yotpo_product_id}/variants/{yotpo_variant_id}": {
      "get": {
        "summary": "Retrieve product variant by ID",
        "description": "Retrieves a product variant by store ID, product ID, and product variant ID.",
        "operationId": "retrieve-product-variant-by-id",
        "parameters": [
          {
            "name": "store_id",
            "in": "path",
            "description": "The store ID (app_key).",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "yotpo_product_id",
            "in": "path",
            "description": "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.",
            "schema": {
              "type": "integer",
              "format": "int64"
            },
            "required": true
          },
          {
            "name": "yotpo_variant_id",
            "in": "path",
            "description": "The Yotpo ID for the product variant. This ID is created automatically upon creation of the variant. You can find it by using the Retrieve endpoint.",
            "schema": {
              "type": "integer",
              "format": "int64"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"variant\": {\n    \"yotpo_id\": 300021,\n    \"external_id\": \"var0001\",\n    \"name\": \"blue minimal surfboard\",\n    \"description\": \"A great surfboard!\",\n    \"url\": \"http://www.waverider.com/products/minimalsurfboard?variant=vr125f633d6h\",\n    \"is_valid_url_format\": true,\n    \"image_url\": \"http://www.waverider.com/products/minimalsurfboard/images/blue2.jpg\",\n    \"price\": 750,\n    \"compare_at_price\": 800,\n    \"currency\": \"USD\",\n    \"inventory_quantity\": 4,\n    \"is_discontinued\": false,\n    \"sku\": \"xxxxx\",\n    \"gtins\": [\n      {\n        \"declared_type\": \"UPC\",\n        \"value\": \"742833102466\"\n      },\n      {\n        \"declared_type\": \"EAN\",\n        \"value\": \"5057913274083\"\n      }\n    ],\n    \"options\": [\n      {\n        \"name\": \"color\",\n        \"value\": \"blue\"\n      },\n      {\n        \"name\": \"material\",\n        \"value\": \"epoxy\"\n      }\n    ],\n    \"created_at\": \"2020-09-08T08:43:27Z\",\n    \"updated_at\": \"2020-10-08T08:43:27Z\",\n    \"yotpo_product_id\": 1153559455\n  }\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "variant": {
                      "type": "object",
                      "properties": {
                        "yotpo_id": {
                          "type": "integer",
                          "example": 300021,
                          "default": 0,
                          "description": "The Yotpo ID of the variant. Use it as `yotpo_variant_id` in variant paths."
                        },
                        "external_id": {
                          "type": "string",
                          "example": "var0001",
                          "description": "The variant ID in your store."
                        },
                        "name": {
                          "type": "string",
                          "example": "blue minimal surfboard",
                          "description": "The variant name. Omitted when not set."
                        },
                        "description": {
                          "type": "string",
                          "example": "A great surfboard!",
                          "description": "The variant description. Omitted when not set."
                        },
                        "url": {
                          "type": "string",
                          "example": "http://www.waverider.com/products/minimalsurfboard?variant=vr125f633d6h",
                          "description": "The variant page URL in your store. Omitted when not set."
                        },
                        "is_valid_url_format": {
                          "type": "boolean",
                          "example": true,
                          "default": true,
                          "description": "Whether `url` is a well-formed URL."
                        },
                        "image_url": {
                          "type": "string",
                          "example": "http://www.waverider.com/products/minimalsurfboard/images/blue2.jpg",
                          "description": "The variant image URL. Omitted when not set."
                        },
                        "price": {
                          "type": "number",
                          "example": 750,
                          "description": "The variant price, in `currency`. Omitted when not set."
                        },
                        "compare_at_price": {
                          "type": "number",
                          "example": 800,
                          "description": "The original price before a sale or adjustment. Omitted when not set."
                        },
                        "currency": {
                          "type": "string",
                          "example": "USD",
                          "description": "The three-letter ISO currency code of `price`, for example `USD`. Omitted when not set."
                        },
                        "inventory_quantity": {
                          "type": "integer",
                          "example": 4,
                          "default": 0,
                          "description": "The number of items in stock. Omitted when not set."
                        },
                        "is_discontinued": {
                          "type": "boolean",
                          "example": false,
                          "default": true,
                          "description": "Whether the variant is discontinued. Discontinued variants get no automatic review requests and don't appear in customer-facing widgets."
                        },
                        "sku": {
                          "type": "string",
                          "example": "xxxxx",
                          "description": "The variant SKU. Omitted when not set."
                        },
                        "gtins": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "declared_type": {
                                "type": "string",
                                "example": "UPC",
                                "description": "The barcode standard: `EAN`, `UPC` or `ISBN`."
                              },
                              "value": {
                                "type": "string",
                                "example": "742833102466",
                                "description": "The barcode value."
                              }
                            }
                          },
                          "description": "The variant barcodes (GTINs). Empty when none are set."
                        },
                        "options": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "name": {
                                "type": "string",
                                "example": "color",
                                "description": "The option name, for example `color`."
                              },
                              "value": {
                                "type": "string",
                                "example": "blue",
                                "description": "The option value, for example `blue`."
                              }
                            }
                          },
                          "description": "The variant options, for example color and size. Omitted when none are set."
                        },
                        "created_at": {
                          "type": "string",
                          "example": "2020-09-08T08:43:27Z",
                          "description": "When the variant was created in Yotpo (UTC, ISO 8601 without a time zone suffix)."
                        },
                        "updated_at": {
                          "type": "string",
                          "example": "2020-10-08T08:43:27Z",
                          "description": "When the variant was last updated in Yotpo (UTC, ISO 8601 without a time zone suffix)."
                        },
                        "yotpo_product_id": {
                          "type": "integer",
                          "description": "The Yotpo ID of the parent product.",
                          "example": 1153559455
                        }
                      },
                      "description": "The variant."
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"errors\": [\n    {\n      \"message\": \"The request contains illegal argument/s\"\n    }\n  ]\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "errors": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "message": {
                            "type": "string",
                            "example": "The request contains illegal argument/s",
                            "description": "What's wrong with the request, usually naming the missing or invalid field. Meant for logs; the wording can change, so don't parse it."
                          }
                        }
                      },
                      "description": "The validation errors. Usually one item."
                    }
                  }
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "description": "404",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"errors\": [\n    {\n      \"message\": \"variant not found\"\n    }\n  ]\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "errors": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "message": {
                            "type": "string",
                            "example": "variant not found",
                            "description": "Says which object wasn't found. Meant for logs; the wording can change, so don't parse it."
                          }
                        }
                      },
                      "description": "The errors. Usually one item."
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false,
        "x-readme": {
          "samples-languages": [
            "http"
          ]
        }
      }
    }
  },
  "x-readme": {
    "headers": [
      {
        "value": "application/json",
        "key": "Content-Type"
      }
    ],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```

# Sibling pages

* [About products](https://docs.yotpo.com/reference/products.md)
* [Create product](https://docs.yotpo.com/reference/create-product.md)
* [Update product](https://docs.yotpo.com/reference/update-product.md)
* [Retrieve products](https://docs.yotpo.com/reference/retrieve-products.md)
* [Retrieve product by ID](https://docs.yotpo.com/reference/retrieve-product-by-id.md)
* [About product variants](https://docs.yotpo.com/reference/product-variants.md)
* [Create product variant](https://docs.yotpo.com/reference/create-product-variant.md)
* [Update product variant](https://docs.yotpo.com/reference/update-product-variant.md)
* [Retrieve product variants](https://docs.yotpo.com/reference/retrieve-product-variants.md)
* [About collections](https://docs.yotpo.com/reference/collections.md)
* [Create collection](https://docs.yotpo.com/reference/create-collection.md)
* [Update collection](https://docs.yotpo.com/reference/update-collection.md)
* [Retrieve collections](https://docs.yotpo.com/reference/retrieve-collections.md)
* [Add product to collection](https://docs.yotpo.com/reference/add-product-to-collection.md)
* [Retrieve products in collection](https://docs.yotpo.com/reference/retrieve-products-in-collection.md)
* [Remove product from collection](https://docs.yotpo.com/reference/remove-product-from-collection.md)
* [Retrieve list of collections for product](https://docs.yotpo.com/reference/retrieve-list-of-collections-for-product.md)