canonical: https://jentic.com/apis/shopware.com/shopware-rest-api

# Shopware REST API

Shopware e-commerce platform REST API for managing products, orders, customers, and more. The API exposes 32 endpoints secured with basic, digest authentication.

## For AI agents

Programmatically create address, list addresses. Covers 32 operations with basic, digest authentication.

## Scope

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

## Capabilities

- Create address
- List addresses
- Get address
- Update address
- Delete address

## Use cases

### E-Commerce Operations

Use the Shopware REST API to perform e commerce operations programmatically. The API provides 32 endpoints covering core functionality including create address, list addresses, get address.

Example prompt: Call POST /addresses to create address

### Automated Products Management

Automate products operations by combining multiple Shopware REST API endpoints. Agents can list addresses and then get address in a single workflow.

Example prompt: Call GET /addresses to list addresses, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Shopware REST 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 basic, digest tokens manually.

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

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/addresses` | Create address |
| GET | `/addresses` | List addresses |
| GET | `/addresses/{id}` | Get address |
| PUT | `/addresses/{id}` | Update address |
| DELETE | `/addresses/{id}` | Delete address |
| POST | `/articles` | Create product |
| GET | `/articles` | List products |
| GET | `/articles/{id}` | Get product |

## Key resources

- **Products** — Product management
- **Orders** — Order management
- **Customers** — Customer management
- **Categories** — Category management
- **Media** — Media and file management

## Why Jentic

- **Setup:** Wiring the Shopware REST API by hand means setting up its basic or digest authentication against your own /api base and parsing the address and article responses yourself. Through Jentic you install once, import the Shopware REST API from the API Directory, store the credentials once, and your agent calls it.
- **Permission scoping:** Shopware puts the resource id in the URL path (`/addresses/{id}`, `/articles/{id}`), so a rule can pin your agent to one address or article: it can read and update that record and nothing else. You choose the operations it may call, so destructive ones like address or article deletion are not included unless you add them.
- **Credential handling:** Your Shopware basic or digest credentials 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 address' or 'fetch an article by id', and Jentic returns the matching Shopware 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 Shopware REST API use?

The Shopware REST API uses basic, digest 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 address with the Shopware REST API?

Yes. Use the POST /addresses endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Shopware REST 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 address through Jentic?

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

### How many endpoints does the Shopware REST API have?

The Shopware REST API exposes 32 endpoints covering products, orders, customers operations.

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

Yes. Because you run Jentic One yourself, your own rules decide which Shopware operations and credentials the agent may use. Since Shopware puts the resource id in the URL path, such as `/addresses/{id}` and `/articles/{id}`, you can pin the agent to a single address or article so it only reads and updates that record and nothing else. You choose which operations are exposed, so destructive calls like address or article deletion stay out of reach unless you explicitly add them.