Using the Store Information API

API Store Store Information OAuth

This is a guide for fetching and updating a store's basic information (store name, store type, contact details, and address) via a REST API. You can implement a store information editing screen from token-authenticated clients such as staff apps.

Authentication

This uses the same authentication as fetching the store list. Attach Authorization: Bearer access-token (a user-scope token) to the request, and you must be a member of the target business account. No additional scope is required. If the target store does not belong to that business account, a 404 is returned.

Fetching a single store

Use this to populate the initial state of the editing screen.

GET /api/v1/me/organizations/{organizationId}/stores/{storeId}

Example response (MeStore format, the same shape as each element in the store list):

{
  "id": "store-id",
  "name": "Shibuya Store",
  "storeType": "Restaurant",
  "primaryCategory": "...",
  "status": "Active",
  "address": {
    "country": "JP",
    "prefecture": "Tokyo",
    "city": "Shibuya-ku",
    "line1": "...",
    "line2": "...",
    "postalCode": "150-0001",
    "latitude": 35.6,
    "longitude": 139.7
  },
  "phone": "03-xxxx-xxxx",
  "websiteUrl": "https://...",
  "updatedAt": "2026-06-20T00:00:00Z"
}

Updating store information

PUT /api/v1/me/organizations/{organizationId}/stores/{storeId}

The editable fields are: store name (name), store type (storeType), primary category (primaryCategory), status (status), phone number (phone), website (websiteUrl), and address (postalCode / prefecture / city / line1 / line2 within address).

Partial updates are supported. Fields you do not specify (that are null) are left unchanged, and sending an empty string clears that field.

Example request:

{
  "name": "Shibuya Main Store",
  "phone": "03-1234-5678",
  "websiteUrl": "https://example.com",
  "address": {
    "postalCode": "150-0002",
    "prefecture": "Tokyo",
    "city": "Shibuya-ku",
    "line1": "Shibuya 1-2-3",
    "line2": "Building 4F"
  }
}

The updated store information (the same MeStore format as when fetching) is returned. Your screen can re-render from this response.

Notes

  • Even if you update the address, the server does not re-geocode (re-fetch latitude / longitude). country / latitude / longitude are preserved.
  • Business hours, regular closing days, and working-hours limits are out of scope for this API. Use the Business Hours API instead.
  • All fields not included in the request body (external IDs, POS integration information, etc.) are preserved.

Related pages

Published: 2026-06-20 Updated: 2026-07-05
このトピックについて
開発者API
機能の詳細を見る
Tags
API (22) OAuth (15) Android (10) iOS (9) Webhook (6) Troubleshooting (5) api (5) App registration (4) POS Integration (4) Reference (4)
Related articles