atouch API Overview
With atouch API, you can read and write product, order, and customer data from the existing atouch (Shop / Admin) platform through standard OpenAPI 3.1 + OAuth 2.1.
It is currently in closed beta. Alongside read access to products, orders, and customers, write access for inventory, shipping, and catalog management is now available (all idempotent; changes are recorded in the operation log). See the tables below for details.
Available APIs (ReadOnly)
| Area | Contents | Required scope |
|---|---|---|
| Items / Categories | Item list & detail, categories, delivery companies, own shop | read_items / read_users |
| Orders | Order header, line items, shipments (buyer PII excluded) | read_orders |
| Order buyer PII | Purchaser / recipient name, address, phone | read_orders_pii |
| Customers | LINE identity, tags, orders | read_customers |
| Customer PII | Name / address / phone / email / gender | read_customers_pii |
Available APIs (Write)
| Area | Contents | Required scope |
|---|---|---|
| Inventory reservations | Reserve (hold) → confirm / release. Availability is checked atomically — no overselling. Reservations auto-expire via TTL (default 15 min) | write_reservations |
| Shipping status | Shipping status transitions (prepared → partial_shipped → shipped → re_shipped / returned), tracking number registration / correction | write_shipping |
| Stock updates | Set item stock to an absolute value (0–99999) or adjust by a delta. Set items and per-variant stock (variant_id) will be opened incrementally | write_items |
| Items | Create items (all kinds: normal / gift / ticket / free ticket / pre-sale ticket / set) and edit existing items (partial update, recorded in the merchant change log) | write_items |
| Categories | Create (up to 2 levels; sort auto-assigned to the end) and edit (name / status / sort) | write_items |
| Item images | Register or replace images by URL (JPEG/PNG, validated by actual bytes). Create → image → publish completes via API alone | write_items |
All write endpoints require the Idempotency-Key header (resending the same key safely replays the result). Changes are recorded in the merchant's modification log.
Basics
- Base URL (dev):
https://api.dev.developers.atouch.jp - Protocol: HTTPS only
- Format:
application/json; charset=utf-8 - Datetime: ISO 8601 + JST (e.g.
2026-06-01T12:00:00+09:00) - Money:
{ "amount": 3200, "currency": "JPY" } - Envelope: single
{ "data": {...} }/ collection{ "data": [...], "pagination": {...} }/ error{ "error": { code, message } }
Handling of personal data (PII)
Buyer PII (name, address, phone, email, etc.) is returned only to tokens that hold the corresponding PII scope. Without it, those fields are omitted from the response entirely. Card numbers and payment-gateway tokens are never returned under any scope.
Continue to Getting Started to obtain a token and make your first call.