canonical: https://jentic.com/apis/swaggerhub.visanetperu/api-order-management-15

# Visanetperu API Order Management 1.5

API Order Management 1.5. The API exposes 21 endpoints secured with apiKey authentication.

## For AI agents

Programmatically query batch by id, create merchant. Covers 21 operations with apiKey authentication.

## Scope

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

## Capabilities

- Query batch by id
- Create merchant
- Update merchant
- Query and filter API Order Management 1.5 records by parameters
- Monitor API Order Management 1.5 operational status and events

## Use cases

### E-Commerce Operations

Use the API Order Management 1.5 to perform e commerce operations programmatically. The API provides 21 endpoints covering core functionality including query batch by id, create merchant, query merchant by id.

Example prompt: Call GET /api/v1/batch/query/{merchantId}/{batchId} to query batch by id

### Automated order Management

Automate order operations by combining multiple API Order Management 1.5 endpoints. Agents can create merchant and then query merchant by id in a single workflow.

Example prompt: Call POST /api/v1/merchant/{merchantId} to create merchant, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call API Order Management 1.5 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 'query batch by id', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | /api/v1/batch/query/{merchantId}/{batchId} | Query batch by id |
| POST | /api/v1/merchant/{merchantId} | Create merchant |
| GET | /api/v1/merchant/{merchantId} | Query merchant by id |
| PUT | /api/v1/merchant/{merchantId} | Update merchant |
| POST | /api/v1/merchant/{merchantId}/provider | Create Merchant Provider |
| GET | /api/v1/merchant/{merchantId}/provider | Query Merchant Providers for merchant |
| PUT | /api/v1/merchant/{merchantId}/provider | Update Merchant Provider |
| GET | /api/v1/merchant/{merchantId}/provider/{providerId} | Query Merchant Provider by id |

## Key resources

- **order** — Order related apis
- **merchant** — Merchant related apis
- **provider** — Merchant Provider related apis
- **batch** — Operations related to batch
- **template** — Operations related to template

## Why Jentic

- **Setup:** Wiring the API Order Management 1.5 by hand means obtaining an access token from Niubiz api.security, passing it in the Authorization header, and coding its merchant, provider, and batch calls against its vnforapps.com ordermgmt host yourself. Through Jentic you install once, import the API Order Management 1.5 from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** The API Order Management 1.5 puts the merchant id in the URL path (/api/v1/merchant/{merchantId}/...), so a rule can pin your agent to one merchant: it can read that merchant and its providers and batch queries. You choose the operations it may call, so updating a merchant with PUT /api/v1/merchant/{merchantId} is not included unless you add it.
- **Credential handling:** Your Niubiz access token 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 'query a batch by id for a merchant' or 'read a merchant provider', and Jentic returns the matching API Order Management 1.5 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 API Order Management 1.5 use?

The API Order Management 1.5 uses an API key passed in the `Authorization` 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 query batch by id with the API Order Management 1.5?

Yes. Use the GET /api/v1/batch/query/{merchantId}/{batchId} endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the API Order Management 1.5?

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 query batch by id through Jentic?

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

### How many endpoints does the API Order Management 1.5 have?

The API Order Management 1.5 exposes 21 endpoints covering order, merchant, provider operations.

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

Yes. Jentic One runs self-hosted, so your own rules decide which operations and credentials the agent may use. Because the merchant id sits in the URL path (for example /api/v1/merchant/{merchantId}/provider), you can pin the agent to a single merchant and let it only read that merchant, its providers, and its batch queries. You add write operations such as PUT /api/v1/merchant/{merchantId} to update a merchant only if you explicitly allow them, so nothing you have not approved is callable.
