API changelog

October 2026

• Spec 2026-10-24

  Numbers published as numbers

  636 numeric fields were published as integer|string; they are now plain numbers. The API never returns a number as a string. Requests still accept numeric strings.

• Added 2026-10-24

  Edit the signed-in user's profile

  PATCH /api/v1/me changes the display name, language and time zone, and POST /api/v1/me/avatar replaces the profile image, under user.profile.write. If any field is rejected, the profile is left unchanged.

• Spec 2026-10-24

  Both shapes of /sales/kpis and /sales/trend published

  With storeId these endpoints return the store shape (revenue, transactionCount, …); without it, the business-account shape (totalRevenue, …). The spec showed only the latter; both are now published as oneOf.

• Spec 2026-10-24

  Documented responses, 401 and 403 in the spec

  Every operation that takes a token now lists 401, and 403 naming its scope. Success codes such as 204 are published as they are returned. No endpoint behaves differently.

• Action required 2026-10-23

  Webhooks are signed with the webhook's secret

  Deliveries were signed with the client ID, not the webhook secret the docs describe. They are now signed with the secret; if you verify with the client ID, switch to the secret. receipt.created is now sent once per new sale, and X-RR-Delivery stays the same across retries.

• Spec 2026-10-23

  Token-only operations marked in the spec

  Operations that need a token but no particular scope (/me, devices, webhook management, …) now carry a security entry with no scopes. An operation without one needs no token. /api/sns/crm/* and the creative API, which use the site's sign-in cookie, left the spec.

• Added 2026-10-23

  Create and manage posts (お知らせ)

  /api/v1/organizations/{organizationId}/posts lists (drafts and scheduled included), reads, creates, updates, publishes, archives and deletes posts, under the new store.posts.read / store.posts.write scopes.

• Added 2026-10-23

  Google reviews and insights

  /api/v1/google-business lists unanswered reviews, replies, drafts an AI reply and reads a store's insights, under sns.content.read / sns.content.write. Store details and weekly hours changed through the API now also update the linked Google listing.

• Added 2026-10-20

  Token verify returns the business account

  POST /api/v1/auth/verify now returns organizationId: the business account the token is bound to, or null for a user token. The field is additive, so existing clients are unaffected.

• Action required 2026-10-20

  Store role levels enforced on transactions, reservations and customers

  Being placed at a store used to open all of its API. Store roles now apply: staff view reservations and the day's transactions; shift leads also see earlier transactions, book, run slots and look customers up; store managers also change customers. "The day" is Japan's. Business-account roles are unchanged.

• Added 2026-10-13

  Coupons and store-email settings for users

  Users' coupons can now be claimed, used and un-used through the API under user.coupons.write; refusals carry the reason as 409 (already_used, …). Store-email settings are readable and writable at /api/v1/user/store-mail.

• Action required 2026-10-10

  Receipt writes need user.receipts.write

  The 18 write operations in the user receipt APIs (receipts, categories, labels, scan, statements, QR claim) ran on user.receipts.read. They now require the new user.receipts.write; user.receipts.read is still accepted on them for two weeks.

• Spec 2026-10-07

  Parameter descriptions and the real error body in the spec

  32 parameter descriptions that were written but dropped are now published. 4xx bodies reference ApiError ({ error }), the shape actually returned; 400 also lists ProblemDetails from model validation.

• Action required 2026-10-07

  Business-account roles reach all stores only in their own area

  Any business-account role used to open every area of the store API. Each area now names the roles that reach every store, matching the web screens; outside its area, a role holder keeps only the stores they are placed at.

• Action required 2026-10-07

  Business-account endpoints return only the caller's stores

  Someone placed at one store could list other stores' customers, orders, sales and staff. Transactions, orders, inventory, staff and customers are now limited to the caller's stores; products show only the caller's prices and no cost. Business-account roles and integration tokens see what they did. Purchase-history take is capped at 200.

September 2026

• Changed 2026-09-24

  Receipt claim links last at most 7 days

  ttlMinutes on POST /api/v1/transactions/{id}/claim-token had no ceiling; anything over 10080 minutes (7 days) is now refused with 400. Absent, zero or negative still mean 1440 minutes. claimUrl's path is the token itself, so keep it out of logs.

• Changed 2026-09-24

  /api/v1/me says why it refuses

  /api/v1/me returned empty 403s. They now carry no_user_context for a token without a user, and not_a_member for a user who is not an active member. Status codes are unchanged.

• Action required 2026-09-09

  Reading a store's sales needs a role that runs the store

  Any token with sales.read could read a store's revenue, churn scores and advice with ?storeId= if its user was merely placed there. A role that runs the store is now required; business-account tokens still pass. Every operation's required scope is now declared in the spec.