店舗一覧取得

GET

/stores

curl --request GET \
  --url 'https://api.smaregi.dev/TARGET-CONTRACT-ID/waiter/stores?selforder=none&direct_checkout=none&status=all&limit=10&sort=id&page=1' \
  --header 'Authorization: Bearer <token>'

• サンドボックス
• 本番

店舗一覧を取得します

Authorizations

• AppAccessToken
  waiter.stores:read

Parameters

Query Parameters

selforder

deprecated

string

default: none

Allowed values: none enabled disabled

[フィルタ]セルフオーダー利用

• none: 条件なし
• enabled: 有効なもの
• disabled: 無効なもの

※ セルフオーダー機能は廃止されているため、本パラメータの指定は避けてください。

Example

none

direct_checkout

string

default: none

Allowed values: none enabled disabled

[フィルタ]ダイレクトチェックアウト利用

• none: 条件なし
• enabled: 有効なもの
• disabled: 無効なもの

Example

none

status

string

default: all

Allowed values: active suspend all

[フィルタ]店舗ステータス

• all: 全て
• active: 稼働中(休止でない)
• suspend: 休止中

Example

all

limit

integer

default: 10 >= 1 <= 30

取得件数

Example

10

sort

string

default: id

ソート

• id: 店舗ID

Example

id

page

integer

default: 1 >= 1

ページ番号

Example

1

Responses

200

OK

Media typeapplication/json

Array<object>

Store

店舗情報

• ストアの基本情報

object

id

required

店舗ID

string

name

店舗名

string

startOfDay

切替時刻[hh:mm:ss]

string

tablesCount

テーブル数

integer

0

suspend

休止日時[YYYY-MM-DDThh:mm:ssTZD]

string

nullable

created

店舗作成日時[YYYY-MM-DDThh:mm:ssTZD]

string

posStoreId

スマレジ・POSの店舗ID

※ウェイター管理画面ver.2.32.0未満から利用されているスタンダードプランの契約では、店舗のスマレジ・POS連携が有効化されていない場合にnullが格納されます。
　管理画面から有効化された契約、ver.2.32.0以降に作成された契約、スタンダードプラン以外の契約では店舗のスマレジ・POS連携は常に有効化されており、無効化することは出来ません。

string

nullable

Examples

Exampleレスポンス例

[
  {
    "id": "1",
    "name": "テスト店舗",
    "startOfDay": "10:00:00",
    "tablesCount": 35,
    "suspend": "2019-03-03T09:34:45+09:00",
    "created": "2018-11-10T17:24:12+09:00",
    "posStoreId": "5"
  },
  {
    "id": "2",
    "name": "テストカフェ",
    "startOfDay": "11:30:00",
    "tablesCount": 5,
    "suspend": null,
    "created": "2018-12-11T12:56:43+09:00",
    "posStoreId": "7"
  }
]

Headers

Link

string

<前のURI>; rel="prev", <次のURI>; rel="next"