canonical: https://jentic.com/apis/shoprocket.co/shoprocket

# Shoprocket API

The Shoprocket API. This is the private API and is under rapid development. Endpoints may change be added to and removed. Also some endpoits are symbolic in nature such as session and voucher which at this moment in time reside in the cart end point. By the they are promoted to the public API they will most likely be under the session voucher methods and not the cart. This is one example of the th. The API exposes 53 endpoints.

## For AI agents

Programmatically create_account_with_paramaters, create_account_no_paramaters. Covers 53 operations.

## Scope

Does not handle payments, communications, or crm - use for identity and authentication only.

## Capabilities

- create_account_with_paramaters
- create_account_no_paramaters
- create_delete_with_paramaters
- create_delete_no_paramaters
- create_list_with_paramaters
- create_list_no_paramaters
- create_livestate_with_paramaters

## Use cases

### Identity and Authentication Operations

Use the Shoprocket API to perform identity auth operations programmatically. The API provides 53 endpoints covering core functionality including create_account_with_paramaters, create_account_no_paramaters, create_delete_with_paramaters.

Example prompt: Call GET `/account/create/{email}{password}{companyname}{partnerkey}` to create_account_with_paramaters

### Automated Account Management

Automate account operations by combining multiple Shoprocket API endpoints. Agents can create_account_no_paramaters and then create_delete_with_paramaters in a single workflow.

Example prompt: Call POST `/account/create`/ to create_account_no_paramaters, then verify the result

### AI Agent Integration via Jentic

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

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

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/account/create/{email}{password}{companyname}{partnerkey}` | create_account_with_paramaters |
| POST | `/account/create/` | create_account_no_paramaters |
| GET | `/account/delete/{companyid}{authkey}{partnerkey}` | create_delete_with_paramaters |
| POST | `/account/delete/` | create_delete_no_paramaters |
| GET | `/account/list/{companyid}{authkey}{partnerkey}` | create_list_with_paramaters |
| POST | `/account/list/` | create_list_no_paramaters |
| GET | `/account/livestate/{companyid}{authkey}{partnerkey}` | create_livestate_with_paramaters |
| POST | `/account/logintoken/` | create_logintoken_with_paramaters |

## Key resources

- **Account** — Operations related to Account
- **App** — Operations related to App
- **Cart** — Operations related to Cart
- **Comms** — Operations related to Comms
- **Orders** — Operations related to Orders

## 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:** 58 / 100
- **Maturity:** Foundational
- **Dimensions:**
  - Foundational Compliance: 52 / 100
  - Developer Experience & Jentic Compatibility: 60 / 100
  - AI-Readiness & Agent Experience: 41 / 100
  - Agent Usability: 93 / 100
  - Security: 100 / 100
  - AI Discoverability: 51 / 100
- **View full report:** https://jentic.com/apis/shoprocket.co/shoprocket/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 Shoprocket API by hand means threading the company id, auth key, and partner key through each account path against dev.shoprocket.co and parsing the responses yourself. Through Jentic you install once, import the Shoprocket API from the API Directory, and your agent calls it with the account keys configured in one place.
- **Permission scoping:** Shoprocket carries its keys and ids in the request rather than as owned path resources, so you limit the agent to the operations it needs, such as creating an account or listing accounts, and destructive ones like account deletion stay out unless you add them.
- **Credential handling:** Any Shoprocket keys your agent needs are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'create an account with parameters' or 'get account live state', and Jentic returns the matching Shoprocket operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Auth0** — Alternative identity auth API
- **Okta** — Alternative identity auth API

## FAQ

### What authentication does the Shoprocket API use?

The Shoprocket API 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 create_account_with_paramaters with the Shoprocket API?

Yes. Use the GET `/account/create/{email}{password}{companyname}{partnerkey}` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Shoprocket 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_account_with_paramaters through Jentic?

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

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

The Shoprocket API exposes 53 endpoints covering account, app, cart operations.

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

Yes. Because you run Jentic One yourself, your own rules decide which Shoprocket operations and keys the agent can use, and it can only call the endpoints you import. Since Shoprocket passes the company id, auth key, and partner key inside each request rather than as owned resources, you scope the agent to just the operations it needs, such as creating an account with GET `/account/create` or listing accounts with GET `/account/list.` Destructive calls like account deletion via POST `/account/delete` stay out of reach unless you explicitly add them.