canonical: https://jentic.com/apis/swaggerhub.semantictouch/bentoweb-order-api

# Semantictouch BentoWeb Order API

BentoWeb Order API using for manage order. Please ask our team for client_id and client_secret. The API exposes 59 endpoints secured with oauth2 authentication.

## For AI agents

Programmatically order list, full order info with order items. Covers 59 operations with oauth2 authentication.

## Scope

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

## Capabilities

- Order list
- Full order info with order items
- Get sub order data
- Query and filter BentoWeb Order API records by parameters
- Monitor BentoWeb Order API operational status and events

## Use cases

### E-Commerce Operations

Use the BentoWeb Order API to perform e commerce operations programmatically. The API provides 59 endpoints covering core functionality including order list, full order info with order items, get sub order data.

Example prompt: Call GET `/order/list/{store_id}` to order list

### Automated Order Management

Automate order operations by combining multiple BentoWeb Order API endpoints. Agents can full order info with order items and then get sub order data in a single workflow.

Example prompt: Call GET `/order/order-full/{order_id}` to full order info with order items, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call BentoWeb Order 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 oauth2 tokens manually.

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

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/order/list/{store_id}` | Order list |
| GET | `/order/order-full/{order_id}` | Full order info with order items |
| GET | `/order/sub-order/{order_id}` | Get sub order data |
| GET | `/order/order-full-by-invoice-code/{invoiceCode}` | Full order info with order items |
| GET | `/order/print-invoice/{order_id}` | Get invoice HTML for printing |
| GET | `/order/print-receipt/{order_id}` | Get receipt HTML for printing |
| GET | `/order/print-tax-invoice/{order_id}` | Get tax invoice HTML for printing |
| POST | `/order/print-reason-credit-note/{order_id}` | Get credit note HTML for printing |

## Key resources

- **Order** — Manage order (get, print, update status)
- **Cart** — Create cart for checkout

## Why Jentic

- **Setup:** Wiring BentoWeb Order API by hand means implementing its OAuth2 password flow against login.bentoweb.com, refreshing tokens for the order.bentoweb.com host, and handling requests and retries yourself. Through Jentic you install once, import BentoWeb Order API from the API Directory, store the client credentials once, and your agent calls it.
- **Permission scoping:** BentoWeb Order API puts the order id in the URL path (`/order/order-full/{order_id}`), so a rule can pin your agent to one order: it can read that order and nothing else. You choose the operations it may call, so writes like posting a credit-note reason are not included unless you add them.
- **Credential handling:** Your BentoWeb Order API 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 'list orders for a store' or 'print an invoice for an order', and Jentic returns the matching BentoWeb Order 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 BentoWeb Order API use?

The BentoWeb Order API uses OAuth 2.0 for authorization. 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 order list with the BentoWeb Order API?

Yes. Use the GET `/order/list/{store_id}` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the BentoWeb Order 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 order list through Jentic?

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

### How many endpoints does the BentoWeb Order API have?

The BentoWeb Order API exposes 59 endpoints covering order, cart operations.

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

Yes. Because Jentic One is self-hosted, you set the rules that decide which BentoWeb Order API operations and credentials your agent may use. Since the API puts the order id in the URL path, such as GET `/order/order-full/{order_id}`, you can pin the agent to a single order so it reads that order and nothing else. You also choose the operations it may call, so write actions like POST `/order/print-reason-credit-note/{order_id}` stay off limits unless you explicitly add them.