組織向け
店舗・商品マスタAPI
ビジネスアカウントに属する店舗と、その商品マスタを取得します。外部システムとマスタを突き合わせる際の起点です。
api/v1/me/organizations/{organizationId}/stores
View in API Reference
Endpoints
| Method | Path | Description | Response |
|---|---|---|---|
| GET |
/api/v1/me/organizations/{organizationId}/stores/
|
店舗を一覧取得
ログイン中の利用者が属するビジネスアカウントの店舗を返します。
|
200 |
| GET |
/api/v1/me/organizations/{organizationId}/stores/{storeId}
|
店舗詳細を取得
住所・営業時間・連絡先を含む店舗情報を返します。
|
200 404 |
| GET |
/api/v1/me/organizations/{organizationId}/stores/../../../products
|
商品を一覧取得
商品マスタを取得します(/api/v1/products)。
|
200 |
| GET |
/api/v1/me/organizations/{organizationId}/stores/../../../products/{productId}
|
商品詳細を取得
バリエーションを含む商品情報を返します。
|
200 404 |
Endpoint details
ログイン中の利用者が属するビジネスアカウントの店舗を返します。
Full path:
GET /api/v1/me/organizations/{organizationId}/stores/
Response codes:
200
住所・営業時間・連絡先を含む店舗情報を返します。
Full path:
GET /api/v1/me/organizations/{organizationId}/stores/{storeId}
Response codes:
200
404
商品マスタを取得します(/api/v1/products)。
Full path:
GET /api/v1/me/organizations/{organizationId}/stores/../../../products
Response codes:
200
バリエーションを含む商品情報を返します。
Full path:
GET /api/v1/me/organizations/{organizationId}/stores/../../../products/{productId}
Response codes:
200
404
Example request
Request
GET /api/v1/me/organizations/{organizationId}/stores
Authorization: Bearer {access_token}
Response
{
"count": 2,
"stores": [
{ "storeId": "21cc…", "name": "レストランABC" }
]
}
About authentication
To use this API, the Authorization: Bearer {access_token} header is required. See the authentication guide for how to obtain a token.