canonical: https://jentic.com/apis/cloud.nekom.com/cloud-nekom-com

# Cloud Nekom NEKOM Orders API

The NEKOM Orders API reads and manages orders inside the NEKOM order-management system. An integration can list and search orders by status, customer, invoice, or free text, create direct and historical orders, add and update order positions, attach and email documents, update delivery estimates and tour assignments, and export orders to logistics or back to the shop. It also covers credit notes, goodwill orders, returns, and per-order text and status history.

## For AI agents

Lets an AI agent query, create, and update orders in the NEKOM order-management system, including positions, documents, logistics export, and status history.

## Scope

Does not handle payment capture, product pricing, or warehouse stock levels: use it for order management in NEKOM only.

## Capabilities

- List and search orders by status, customer, invoice, or free text
- Create direct, standard, and historical orders
- Add, update, and cancel order positions
- Attach, retrieve, and email order documents
- Update delivery estimates, tours, and order status
- Export orders to logistics and push status back to the shop

## Use cases

### Order status automation

Operations teams need orders to move through statuses without manual clicks. The NEKOM Orders API lets a system read orders by status and update each one, then push the new status back to the shop so the storefront stays in sync.

Example prompt: Find orders in a pending status, advance each to shipped, and send the status back to the shop

### Customer service order lookup

Support agents answering order questions need a fast lookup across customer, invoice, and free text. The API's search and filter operations return matching orders with their positions and documents so an assistant can resolve a query in one pass.

Example prompt: Search orders for a customer, read the line items, and email the matching invoice document

### Logistics and fulfillment export

Fulfillment depends on orders reaching the logistics provider accurately. The API exports an order to logistics, records tour assignments, and updates delivery estimates, keeping the warehouse and the customer aligned.

Example prompt: Export a confirmed order to logistics and set its delivery estimate and tour assignment

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/api/v1/orders` | Get orders by status code |
| POST | `/api/v1/orders` | Create a new order |
| GET | `/api/v1/orders/search` | Search orders by text |
| POST | `/api/v1/orders/addposition` | Add an order position |
| GET | `/api/v1/orders/document` | Get a document for an order |
| PUT | `/api/v1/orders/status` | Update order status |

## Key resources

- **Orders** — Create, read, search, and update orders and their status
- **Order positions** — Add, update, cancel, and annotate order line items
- **Documents** — Attach, retrieve, and email order documents
- **Credits and returns** — Credit notes, goodwill orders, and order line credit notes
- **Logistics export** — Export orders to logistics and push status to the shop

## 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:** 49 / 100
- **Maturity:** Foundational
- **Dimensions:**
  - Foundational Compliance: 44 / 100
  - Developer Experience & Jentic Compatibility: 71 / 100
  - AI-Readiness & Agent Experience: 28 / 100
  - Agent Usability: 94 / 100
  - Security: 50 / 100
  - AI Discoverability: 73 / 100
- **View full report:** https://jentic.com/apis/cloud.nekom.com/cloud-nekom-com/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:** Hand-wiring NEKOM means managing its two header credentials and 48 order operations yourself. With Jentic One you install once, import the operations from the API Directory, and keep the client credentials in one place.
- **Permission scoping:** Order resources are addressed by path parameters such as order UUID, so you can scope an agent to specific operations, for example letting it search and read orders while withholding create, cancel, and export.
- **Credential handling:** The clientuuid and Authorization token are stored encrypted by your own Jentic One instance and injected when a call runs, so neither value enters the agent's prompt, logs, or context.
- **Discovery method:** Agents locate the right order operation through Jentic's intent search, matching a request like finding a customer's recent orders to the matching NEKOM endpoint.

## Related APIs

- **Shopify** — Full commerce platform whose Admin API also manages orders
- **Ecwid** — Lightweight store platform with order management
- **Orderful** — EDI network for trading-partner order documents

## FAQ

### How does the NEKOM Orders API authenticate requests?

NEKOM expects two header credentials declared as API keys in its spec: a `clientuuid` that identifies your client and a token in the `Authorization` header for the interface user. Jentic One injects both at execution time.

### Can I limit what my agent can do with the NEKOM Orders API?

Yes. You import only the operations an agent needs, so a reporting agent can be given read operations like order search while create, update, and export operations stay out of its reach.

### Can the API create orders or only read them?

Both. Alongside the read and search operations it can create direct, standard, and historical orders and add or update their positions.

### Does the API handle logistics and shipping?

It exports orders to a logistics provider and records tour assignments and delivery estimates, but the carrier movements themselves happen in the logistics system.

### What formats does the NEKOM Orders API return?

Order data is returned as JSON, and documents such as invoices can be retrieved or emailed through the document operations.