Yotpo App Developer API
Browse all Yotpo APIs67
AI ReadinessAI-Aware (B+)67/100
Official vendor OpenAPI document · agent-readyE CommerceStorefrontapiKey15 EndpointsREST
For Agents
Programmatically generate access token, retrieve orders. Covers 15 operations with apiKey authentication.
Use for: I need to generate access token, I want to orders, Search for fulfillments, Find all fulfillment
Not supported: Does not handle payments, communications, or crm - use for e-commerce only.
Yotpo platform API for orders, products, reviews, customers. The API exposes 15 endpoints secured with apiKey authentication.
Install Jentic One Beta
Connect the Yotpo App Developer API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Yotpo App Developer API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fyotpo.com%2Fyotpo-app-developer-api" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fyotpo.com%2Fyotpo-app-developer-api" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with Yotpo App Developer API.
Generate access token
Retrieve orders
Update fulfillment
List products
Get product
Use Cases
Patterns agents use Yotpo App Developer API for, with concrete tasks.
★ 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.
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.
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.
Search Jentic for 'generate access token', load the operation schema, and execute with Jentic-managed credentials
Key Endpoints
15 endpoints — yotpo platform api for orders, products, reviews, customers.
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
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
Jentic AI Readiness Score
This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.
Y
Yotpo App Developer API
- AI-Aware (B+)67/100
85
Foundational Compliance63
Developer Experience & Jentic Compatibility53
AI-Readiness & Agent Experience94
Agent Usability50
Security100
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
85
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: ASignals: 4
98%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
100%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
42%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
63
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: B-Signals: 4
0%
Example Density
How richly the API is illustrated with examples.
100%
Example Validity
Percentage of examples that conform to their schemas.
50%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
100%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
53
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: C-Signals: 4
60%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
100%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
52%
Summary Coverage
Coverage of summaries across operations/tags/info.
94
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: A+Signals: 1
94%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
50
Security
Trust, risk posture, and security compliance.
Grade: C-Signals: 1
50%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
100
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: A+Signals: 1
100%
Descriptive Richness
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>Why Jentic?
What agents get from Jentic-routed access to this vendor.
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 isolation
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.
Intent-based discovery
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
Alternatives and complements available in the Jentic catalogue.
Alternative
Stripe
Alternative e commerce API
Choose Stripe when you need a different approach to e commerce operations
FAQs
Specific to using Yotpo App Developer API through Jentic.
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.
GET STARTED