canonical: https://jentic.com/apis/yotpo.com/yotpo-app-developer-api

# Yotpo App Developer API

Yotpo platform API for orders, products, reviews, customers. The API exposes 15 endpoints secured with apiKey authentication.

## For AI agents

Programmatically generate access token, retrieve orders. Covers 15 operations with apiKey authentication.

## Scope

Does not handle payments, communications, or crm - use for e-commerce only.

## Capabilities

- Generate access token
- Retrieve orders
- Update fulfillment
- List products
- Get product

## Use cases

### E-Commerce Operations

Use the Yotpo App Developer API to perform e commerce operations programmatically. The API provides 15 endpoints covering core functionality including generate access token, retrieve orders, retrieve fulfillments.

Example prompt: Call POST /access_token to generate access token

### Automated Authentication Management

Automate authentication operations by combining multiple Yotpo App Developer API endpoints. Agents can retrieve orders and then retrieve fulfillments in a single workflow.

Example prompt: Call GET /orders to retrieve orders, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Yotpo App Developer API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually.

Example prompt: Search Jentic for 'generate access token', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | /access_token | Generate access token |
| GET | /orders | Retrieve orders |
| GET | /orders/fulfillments | Retrieve fulfillments |
| PATCH | /orders/fulfillments/{id} | Update fulfillment |
| GET | /products | List products |
| GET | /products/{product_id} | Get product |
| GET | /products/promoted | Get promoted products |
| GET | /products/variants | Get variants |

## Key resources

- **Authentication** — Operations related to Authentication
- **Customers** — Operations related to Customers
- **Orders** — Operations related to Orders
- **Products** — Operations related to Products
- **Reviews** — Operations related to Reviews

## Why Jentic

- **Setup:** Wiring the Yotpo App Developer API by hand means minting an access token, sending the X-Yotpo-Token header on developers.yotpo.com, and handling retries yourself. Through Jentic you install once, import the Yotpo App Developer API from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** The Yotpo App Developer API puts the product and fulfillment ids in the URL path (/products/{product_id}, /orders/fulfillments/{id}), so a rule can pin your agent to one product or fulfillment: it reads or updates that record and nothing else. You choose the operations it may call, so writes like updating a fulfillment are not included unless you add them.
- **Credential handling:** Your Yotpo token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'generate an access token' or 'list orders', and Jentic returns the matching Yotpo App Developer API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Shopify** — Alternative e commerce API
- **Stripe** — Alternative e commerce API

## FAQ

### What authentication does the Yotpo App Developer API use?

The Yotpo App Developer API uses an API key passed in the `X-Yotpo-Token` header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I generate access token with the Yotpo App Developer API?

Yes. Use the POST /access_token endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Yotpo App Developer API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I generate access token through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'generate access token'. Jentic returns the matching Yotpo App Developer API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Yotpo App Developer API have?

The Yotpo App Developer API exposes 15 endpoints covering authentication, customers, orders operations.

### Can I limit what my agent is allowed to do with the Yotpo App Developer API?

Yes. Because you run Jentic One yourself, your own rules decide which Yotpo operations and credentials the agent may use. Since the Yotpo App Developer API carries the product and fulfillment ids in the URL path (/products/{product_id}, /orders/fulfillments/{id}), you can pin the agent to a single product or fulfillment so it reads or updates that record and nothing else. You also choose the operations it may call, so a write such as updating a fulfillment via PATCH /orders/fulfillments/{id} is off limits unless you explicitly allow it.