canonical: https://jentic.com/apis/yotpo.com

# Yotpo APIs

Yotpo is a commerce marketing platform whose APIs cover user-generated content and storefront data. The Yotpo UGC API handles reviews, Q&A, coupons, visual content, and email analytics, while the Yotpo App Developer API handles orders, products, customers, and fulfillments. Together they let programs read shopper reviews and ratings and connect them to the underlying order and product records.

## For AI agents

An agent can read and create product reviews, fetch product ratings, search review content, and vote on reviews through the UGC API, then pull the related orders, products, customers, and fulfillments and update fulfillment status through the App Developer API.

## Scope

Use for: Reading and creating product reviews, ratings, Q&A, and coupons, and reading orders, products, customers, and fulfillments for a Yotpo commerce account

Not supported:
- payment processing
- email sending
- crm records
- real-time streaming
- on-prem deployment

## APIs

| API | Category | Endpoints | Description |
| --- | --- | --- | --- |
| Yotpo UGC API | analytics | 34 | Programmatically yotpo authentication, create review. |
| Yotpo App Developer API | e-commerce | 15 | Programmatically generate access token, retrieve orders. |

## Which API to use

| Need | API | Why |
| --- | --- | --- |
| Read, create, search, or vote on product reviews and ratings | yotpo-ugc-api | The UGC API owns reviews, Q&A, product bottom-line ratings, and voting. |
| Read orders, products, customers, and update fulfillments | yotpo-app-developer-api | The App Developer API exposes storefront records like orders, products, and fulfillments. |
| Look up product review content | yotpo-ugc-api | Product reviews and ratings live in the UGC API, not the storefront API. |
| Look up product records and variants | yotpo-app-developer-api | Product listings, variants, and promoted products come from the App Developer API. |

## Cross-API use cases

### Attach reviews to their orders

Pull a customer's orders from the App Developer API, then fetch the reviews and ratings for the products in those orders from the UGC API to see what buyers said about what they bought.

Example prompt: Call GET /orders to retrieve a customer's orders, then for each product call GET /products/{product_id}/reviews to gather its reviews

### Rating check before fulfillment update

Read a product's rating from the UGC API and its record from the App Developer API before updating a fulfillment, so low-rated items can be flagged in the same workflow.

Example prompt: Call GET /products/{product_id}/bottomline for the rating and GET /products/{product_id} for the record, then PATCH /orders/fulfillments/{id} to update fulfillment

### Review coverage report by product

List products and variants from the App Developer API and cross-reference each against its reviews in the UGC API to report which products lack reviews.

Example prompt: Call GET /products to list products, then GET /products/{product_id}/reviews for each to find products with no reviews

## Why Jentic

- **Setup:** Wiring Yotpo by hand means running the UGC API's OAuth token exchange, minting an App Developer API key for the X-Yotpo-Token header, and handling retries on each call yourself. With Jentic One installed you add either Yotpo API from the Jentic directory to your workspace and your agent calls it.
- **Permission scoping:** Yotpo puts review, product, and fulfillment ids in the URL path, so your own rules can pin an agent to specific records and specific operations. Reads like fetching a product's reviews can be allowed while writes such as creating a review or updating a fulfillment stay out unless you add them.
- **Credential handling:** Each Yotpo credential, the UGC bearer token and the App Developer API key, is stored encrypted by your own Jentic One instance and injected at execution time, so raw secrets never enter the agent's prompt, logs, or context.
- **Discovery method:** An agent searches the Jentic directory by intent, such as getting a product's reviews or listing orders, and Jentic returns the matching Yotpo operation and its input schema so the agent calls the right endpoint across both APIs without browsing the reference docs.

## Related vendors

- **Shopify** — Storefront and order platform that Yotpo reviews and ratings are often attached to.
- **Stripe** — Handles the payment side of commerce that Yotpo's order APIs do not cover.
- **Trustpilot** — Alternative reviews and ratings provider for user-generated content.
- **Klaviyo** — Marketing and email platform that complements Yotpo's UGC and coupon data.

## FAQ

### What can an agent do across Yotpo's APIs?

An agent can read and create product reviews, fetch ratings, search review content, and vote on reviews through the UGC API, and read orders, products, customers, variants, and fulfillments and update fulfillment status through the App Developer API. The shared link between them is the product, so review data can be joined to order and product records.

### Do the two Yotpo APIs share one credential?

No. The Yotpo UGC API authenticates with a bearer token obtained from its OAuth token exchange, and the Yotpo App Developer API authenticates with an API key in the X-Yotpo-Token header. An agent that spans both needs both credentials configured.

### Which Yotpo API should I use for reviews versus orders?

Use the UGC API for reviews, ratings, Q&A, coupons, and email analytics. Use the App Developer API for orders, products, customers, variants, and fulfillments. Product identifiers appear in both, which lets you connect a review to the product and order it belongs to.

### Can I combine both Yotpo APIs in one workflow?

Yes. A common pattern is to pull orders and products from the App Developer API and then fetch the matching reviews and ratings from the UGC API, or to check a product rating before updating a fulfillment. Product ids returned by one API are used to query the other.

### What is out of scope for Yotpo's APIs?

These APIs do not process payments, send email, or store crm records. They focus on user-generated content and storefront data such as reviews, ratings, orders, products, and fulfillments for a Yotpo commerce account.

### How does an agent find the right Yotpo operation?

The agent searches Jentic by intent, such as getting a product's reviews or listing orders, and Jentic returns the matching Yotpo operation with its input schema. This avoids reading the reference docs to locate an endpoint by hand.