canonical: https://jentic.com/apis/shop.app/shop

# Shop App Shop

Search for millions of products from the world's greatest brands. The API exposes 2 endpoints.

## For AI agents

Programmatically search for products, return more details about a list of products.. Covers 2 operations.

## Scope

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

## Capabilities

- Search for products
- Return more details about a list of products.
- Integrate Shop into automated workflows
- Query and filter Shop records by parameters
- Monitor Shop operational status and events

## Use cases

### E-Commerce Operations

Use the Shop to perform e commerce operations programmatically. The API provides 2 endpoints covering core functionality including search for products, return more details about a list of products..

Example prompt: Call GET `/openai/search` to search for products

### Data Retrieval and Monitoring

Query Shop resources on a schedule to track changes, generate alerts, or feed downstream dashboards. Agents poll relevant endpoints, compare against previous state, and trigger actions when thresholds are crossed.

Example prompt: Poll the primary Shop endpoint, compare response to last known state, and alert if changed

### AI Agent Integration via Jentic

AI agents discover and call Shop 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 none tokens manually.

Example prompt: Search Jentic for 'search for products', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/openai/search` | Search for products |
| GET | `/openai/details` | Return more details about a list of products. |

## Key resources

- **Openai** — Operations for openai

## AI readiness

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.

- **Score:** 61 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 73 / 100
  - Developer Experience & Jentic Compatibility: 60 / 100
  - AI-Readiness & Agent Experience: 40 / 100
  - Agent Usability: 94 / 100
  - Security: 100 / 100
  - AI Discoverability: 50 / 100
- **View full report:** https://jentic.com/apis/shop.app/shop/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the Shop API by hand means formatting search and details requests against server.shop.app and parsing the product results yourself. Through Jentic you install once, import Shop from the API Directory, and your agent calls it, with no key to manage since these endpoints are open.
- **Permission scoping:** The Shop endpoints in this spec are two read-only lookups, so you limit the agent to the operations it needs, such as product search or product details, and it can call nothing beyond the read operations you choose.
- **Credential handling:** Shop exposes these endpoints without a credential, so there is no secret to store, and any configuration your Jentic One instance holds is injected at execution time rather than placed in the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'search for products' or 'get product details', and Jentic returns the matching Shop 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 Shop use?

The Shop uses no authentication. 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 search for products with the Shop?

Yes. Use the GET `/openai/search` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Shop?

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 search for products through Jentic?

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

### How many endpoints does the Shop have?

The Shop exposes 2 endpoints covering openai operations.

### Can I limit what my agent is allowed to do with the Shop API?

Yes. Because you run Jentic One yourself, your own rules decide which Shop operations the agent may call. The Shop API exposes only two read-only lookups, product search via GET `/openai/search` and product details via GET `/openai/details`, so you can grant the agent just the one it needs and it can call nothing beyond the read operations you allow. Since these endpoints need no credential, there is no secret to hand the agent, and any configuration your instance holds is injected only at execution time.
