Working with entity identifiers

Orders, products and product variants already have their own IDs in the merchant's eCommerce platform. In Yotpo, each of them has two IDs:

• external_id: the merchant's own ID for the order, product or variant, as it appears in their platform. It can't be changed once the entity exists in Yotpo.
• yotpo_id: the ID Yotpo assigns to the same order, product or variant.

Endpoints that work on a single entity, such as Retrieve product by ID, take the yotpo_id in the path. To get it from an external_id, call the list endpoint with the external_ids filter. The response includes each entity's yotpo_id.

Example: from a platform product ID to Yotpo data

1. Call Retrieve Products with external_ids=YOUR_PRODUCT_ID (up to 100 IDs, comma-separated and URL-encoded).
2. Read yotpo_id from the product in the response.
3. Use it in the path of Retrieve product by ID or Retrieve product variants.

Orders work the same way: Retrieve Orders with external_ids, then Retrieve order by ID with the yotpo_id.