canonical: https://jentic.com/apis/swaggerhub.develop-beyable/beyable-product-shelving-api

# Develop Beyable BEYABLE Product Shelving API

This API provides collection of products built from BEYABLE Shelving Rules. The API exposes 1 endpoints secured with apiKey authentication.

## For AI agents

Programmatically products for the requested shelving rule. Covers 1 operations with apiKey authentication.

## Scope

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

## Capabilities

- Products for the requested Shelving Rule
- Manage e commerce data programmatically
- Integrate BEYABLE Product Shelving API into automated workflows
- Query and filter BEYABLE Product Shelving API records by parameters
- Monitor BEYABLE Product Shelving API operational status and events

## Use cases

### E-Commerce Operations

Use the BEYABLE Product Shelving API to perform e commerce operations programmatically. The API provides 1 endpoints covering core functionality including products for the requested shelving rule.

Example prompt: Call GET /{account}/{rule}/{dimension}/{pointofinterest} to products for the requested shelving rule

### Data Retrieval and Monitoring

Query BEYABLE Product Shelving API 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 BEYABLE Product Shelving API endpoint, compare response to last known state, and alert if changed

### AI Agent Integration via Jentic

AI agents discover and call BEYABLE Product Shelving 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 'products for the requested shelving rule', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/{account}/{rule}/{dimension}/{pointofinterest}` | Products for the requested Shelving Rule |

## Key resources

- **default** — Operations related to default

## Why Jentic

- **Setup:** Wiring the BEYABLE Product Shelving API by hand means setting up its subscription-key API key (in a header or query), pointing at the apibeyableprod.azure-api.net host, and handling retries yourself. Through Jentic you install once, import the BEYABLE Product Shelving API from the API Directory, store the subscription key once, and your agent calls it.
- **Permission scoping:** The BEYABLE Product Shelving API puts the account, rule, dimension, and point of interest in the URL path (/{account}/{rule}/{dimension}/{pointofinterest}), so a rule can pin your agent to one account's shelving. Its single operation is a read, and the agent only runs it if you include it.
- **Credential handling:** Your BEYABLE subscription key 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 'get products for a shelving rule', and Jentic returns the matching BEYABLE Product Shelving 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 BEYABLE Product Shelving API use?

The BEYABLE Product Shelving API uses an API key passed in the `Subscription-Key` 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 products for the requested shelving rule with the BEYABLE Product Shelving API?

Yes. Use the GET /{account}/{rule}/{dimension}/{pointofinterest} endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the BEYABLE Product Shelving 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 products for the requested shelving rule through Jentic?

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

### How many endpoints does the BEYABLE Product Shelving API have?

The BEYABLE Product Shelving API exposes 1 endpoints covering default operations.

### Can I limit what my agent is allowed to do with the BEYABLE Product Shelving API?

Yes. Jentic One is self-hosted by you, so your own rules decide which operations and credentials your agent may use. The BEYABLE Product Shelving API exposes a single read operation, GET /{account}/{rule}/{dimension}/{pointofinterest}, and the agent can only call it if you include it in what you have granted. Because the account, rule, dimension, and point of interest live in the URL path, you can pin the agent to one account's shelving and nothing more.