# harukibox Agent API API

**Canonical:** https://apis.io/apis/harukibox-com/harukibox-agent-api-api/  
**Provider:** Harukibox — https://apis.io/providers/harukibox-com/  
**Base URL:** https://harukibox.com/api/agent  
**Documentation:** https://harukibox.com/docs

harukibox Agent API API is one of 2 APIs that [Harukibox](https://apis.io/providers/harukibox-com/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

Agent / MCP / CLI 用的 harukibox API。所有端點以 Bearer token 認證，token 透過 @harukibox/cli 跑 `harukibox login`（OAuth PKCE 或 device flow）取得。每個 token 屬於某個 user 並繼承其 organization 權限；token 只能存取 token 擁有者的 organization 內資料。

## Operations (42)

| Method | Path | Summary |
|---|---|---|
| GET | `/me` | Current user + organization + token info |
| GET | `/products` | List products |
| POST | `/products` | Create a product |
| PATCH | `/products/{id}` | Patch an existing product and/or its items |
| GET | `/products/{id}` | Get product by id, with its items |
| GET | `/registrations` | List registrations (orders) |
| POST | `/registrations` | Create one or many registrations (orders) |
| PATCH | `/registrations` | Update status / payment / notes on existing registrations |
| POST | `/products/{id}/items` | Add items (品項) to a product |
| GET | `/buyers/{id}` | Get one buyer with recent order history |
| GET | `/buyers` | List buyers |
| GET | `/stats` | Sales and payment statistics |
| GET | `/buyers/{id}/character-stats` | Which characters a buyer collects |
| GET | `/buyer-aliases` | Read buyer alias grouping |
| POST | `/buyer-aliases` | Group names as the same buyer |
| GET | `/shipping-calculations` | Past freight allocations |
| POST | `/shipping-calculations` | Split freight across packages |
| POST | `/images` | Upload an image, get a public URL back |
| GET | `/confirm-links` | List confirmation links with status |
| POST | `/confirm-links` | Generate a confirmation link for one order |
| PATCH | `/confirm-links` | Activate / expire / reactivate a confirmation link |
| GET | `/buyer-payments` | Prepaid balances (all buyers) or one buyer's transactions |
| POST | `/buyer-payments` | Record a prepaid balance movement |
| GET | `/buyer-memos` | Notes that follow a buyer across orders |
| POST | `/buyer-memos` | Attach a note to a buyer |
| GET | `/ip-roles` | Series (IP) and their character lists |
| POST | `/ip-roles` | Create a series with its characters |
| PATCH | `/ip-roles` | Update a series / append characters |
| GET | `/shipment-batches` | Shipping batches (one product, many orders shipped together) |
| POST | `/shipment-batches` | Group orders into one shipping batch |
| GET | `/store-links` | Shop links given to buyers |
| POST | `/store-links` | Publish a shop link to buyers |
| GET | `/locations` | Warehouse hierarchy and item placement |
| PATCH | `/locations` | Put items into a box or location |
| GET | `/products/links` | Seller's private reference links on products |
| POST | `/products/links` | Attach reference links to one or many products |
| GET | `/shippings` | List shipments |
| PATCH | `/shippings` | Move orders to the next shipping stage in bulk |
| POST | `/shippings` | Create courier shipment records |
| GET | `/tokens` | List my Personal Access Tokens |
| DELETE | `/tokens/{id}` | Revoke one of my Personal Access Tokens |
| GET | `/search` | Global search (products / buyers / registrations) |

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/harukibox-com/openapi/_original/harukibox-com-agent-openapi.json
- **JSONSchema** — https://artifacts.apis.io/harukibox-com/json-schema/harukibox-com-registration-create-schema.json
- **JSONSchema** — https://artifacts.apis.io/harukibox-com/json-schema/harukibox-com-me-schema.json
- **JSONSchema** — https://artifacts.apis.io/harukibox-com/json-schema/harukibox-com-product-schema.json
- **JSONSchema** — https://artifacts.apis.io/harukibox-com/json-schema/harukibox-com-registrations-list-schema.json
- **JSONSchema** — https://artifacts.apis.io/harukibox-com/json-schema/harukibox-com-products-list-schema.json
- **JSONSchema** — https://artifacts.apis.io/harukibox-com/json-schema/harukibox-com-buyers-list-schema.json

## Other Harukibox APIs (1)

- [Harukibox Agent API](https://apis.io/apis/harukibox-com/harukibox-agent-api/)

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/harukibox-com/harukibox-agent-api-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/harukibox-com/.
