レジ端末一覧取得

GET

/terminals

curl --request GET \
  --url https://api.smaregi.dev/TARGET-CONTRACT-ID/pos/terminals \
  --header 'Authorization: Bearer <token>'

• サンドボックス
• 本番

レジ端末の一覧を取得します。

対象プラン

• スタンダード
• プレミアム
• プレミアムプラス
• フードビジネス
• リテールビジネス

Authorizations

• AppAccessToken
  pos.stores:read
• UserAccessToken
  pos.stores:read

Parameters

Query Parameters

fields

array

検索パラメータ（カンマ区切りで指定可）
Response項目を指定可能
※一部項目(withで指定する項目、2階層目以降の項目)については指定不可

sort

string

並び順（カンマ区切りで指定可）

指定可能なパラメータ

• storeId：店舗ID
• terminalId：端末ID
• updDateTime：更新日時

limit

integer

上限数

page

integer

ページ

terminal_id

string

端末ID

store_id

string

店舗ID

cash_drawer_id

string

キャッシュドロアID

uuid

string

端末識別番号

self_checkout_available_flag

string

セルフレジ使用可能フラグ。(0:使用できない、1:使用できる)

use_stop_division

string

利用区分。(0:利用可、1:利用停止)

smart_id_engine_available_flag

string

Smart ID Engine利用フラグ（0:利用しない、1:利用する）

Responses

200

取得成功

Media typeapplication/json

Array<object>

object

storeId

店舗ID

string

terminalId

端末ID

string

terminalName

端末名

string

cashDrawerId

キャッシュドロアID

string

uuid

端末識別番号

string

selfCheckoutAvailableFlag

セルフレジ使用可能フラグ。(0:使用できない、1:使用できる)

string

useStopDivision

利用区分。(0:利用可、1:利用停止)

string

transactionEditableFlag

取引編集可能フラグ（0:利用しない、1:利用する）

string

smartIdEngineAvailableFlag

Smart ID Engine利用フラグ（0:利用しない、1:利用する）

string

creditTerminalId

CAT/CCT端末ID

string

parentTerminalId

親端末ID

string

appVersion

アプリバージョン

string

insDateTime

登録時の日時。[YYYY-MM-DDThh:mm:ssTZD]

string

updDateTime

登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]

string

Example

[
  {
    "storeId": "string",
    "terminalId": "string",
    "terminalName": "string",
    "cashDrawerId": "string",
    "uuid": "string",
    "selfCheckoutAvailableFlag": "string",
    "useStopDivision": "string",
    "transactionEditableFlag": "string",
    "smartIdEngineAvailableFlag": "string",
    "creditTerminalId": "string",
    "parentTerminalId": "string",
    "appVersion": "string",
    "insDateTime": "string",
    "updDateTime": "string"
  }
]