canonical: https://jentic.com/apis/storeplum.in/storeplum

# Storeplum In Storeplum API

Storeplum API for managing products, webhooks, and e-commerce operations. The API exposes 2 endpoints secured with apiKey authentication.

## For AI agents

Programmatically create or update product, register webhooks. Covers 2 operations with apiKey authentication.

## Scope

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

## Capabilities

- Create or update product
- Register webhooks
- Integrate Storeplum API into automated workflows
- Query and filter Storeplum API records by parameters
- Monitor Storeplum API operational status and events

## Use cases

### E-Commerce Operations

Use the Storeplum API to perform e commerce operations programmatically. The API provides 2 endpoints covering core functionality including create or update product, register webhooks.

Example prompt: Call POST `/integration/action/product/save` to create or update product

### Data Retrieval and Monitoring

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

### AI Agent Integration via Jentic

AI agents discover and call Storeplum 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 'create or update product', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/integration/action/product/save` | Create or update product |
| POST | `/integration/subscribe` | Register webhooks |

## Key resources

- **integration** — Operations related to integration

## 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:** 67 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 100 / 100
  - Developer Experience & Jentic Compatibility: 56 / 100
  - AI-Readiness & Agent Experience: 52 / 100
  - Agent Usability: 94 / 100
  - Security: 50 / 100
  - AI Discoverability: 100 / 100
- **View full report:** https://jentic.com/apis/storeplum.in/storeplum/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 Storeplum API by hand means sending its key in the X-SP-INTEGRATION header on every call to api.storeplum.in and shaping the product and subscribe payloads yourself. Through Jentic you install once, import the Storeplum API from the API Directory, store the API key once, and your agent calls it.
- **Permission scoping:** Storeplum takes the product and subscriber details in the request body rather than a resource id in the URL path, so scope by operation: limit the agent to the operations it needs, such as saving a product or adding a subscriber. Only the operations you add are available to the agent.
- **Credential handling:** Your Storeplum API 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 'create or update a product' or 'add a newsletter subscriber', and Jentic returns the matching Storeplum 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 Storeplum API use?

The Storeplum API uses an API key passed in the `X-SP-INTEGRATION` 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 create or update product with the Storeplum API?

Yes. Use the POST `/integration/action/product/save` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Storeplum 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 create or update product through Jentic?

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

### How many endpoints does the Storeplum API have?

The Storeplum API exposes 2 endpoints covering integration operations.

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

Yes. Because you run Jentic One yourself, only the Storeplum operations you add become available to the agent, and your own rules decide which ones it may call. Since Storeplum takes product and subscriber details in the request body rather than a resource id in the URL, you scope by operation: grant just saving a product through POST `/integration/action/product/save`, or just adding a subscriber through POST `/integration/subscribe`, and leave the rest out. The stored API key is injected only when the agent runs an operation you have allowed.
