コンテンツにスキップ
スマレジ・プラットフォームAPI リファレンス

クイックコマンド取得

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

クイックコマンド設定を取得します。

対象プラン

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

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
quick_command_setting_id
required
integer format: int32
>= 1

クイックコマンド設定ID

Query Parameters

Section titled “Query Parameters”
fields
array

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

Responses

Section titled “Responses”

200

Section titled “200”

取得成功

Media typeapplication/json
object
quickCommandSettingId

クイックコマンド設定ID

integer format: int32
>= 1
storeScope

対象店舗範囲

  • 1: 全店
  • 2: 店舗指定
string
Allowed values: 1 2
name

名称

string
stores

対象店舗一覧。

storeScopeが 2: 店舗指定 の場合は、対象店舗の一覧を返します。

storeScopeが 1: 全店 の場合は、全店舗が対象のため空配列を返します。

Array<object>
object
storeId

店舗ID

integer format: int32
>= 1
totalCommands

合計コマンド一覧。

commandに応じた項目のみ返却されます。該当しない項目は返却されません。

Array<object>
One of:
値引
object
quickCommandId
required

クイックコマンドID

integer format: int32
>= 1
buttonName
required

ボタン名

string
>= 1 characters
command
required

コマンド。

  • 1: 値引
  • 2: 割引
  • 6: 価格リセット
  • 9: 取引タグ
  • 99: 複数コマンド実行
string
Allowed values: 1
discountAmount

値引金額

integer format: int64
>= 1 <= 9999999999
discountDivisionId

管理画面の[設定]→[販売設定]→[値引区分]で確認できる「ID」。未選択の場合は null。

integer format: int32
nullable >= 1
color
required

表示カラーコード（16進数）。#から始まる1〜6桁の16進数。

string
nullable <= 7 characters /^#[0-9A-Fa-f]{1,6}$/
isDisplay
required

表示有無

boolean
displaySequence
required

表示順

integer format: int32
nullable >= 1 <= 8
unitCommands

単品コマンド一覧。

commandに応じた項目のみ返却されます。該当しない項目は返却されません。

Array<object>
One of:
値引
object
quickCommandId
required

クイックコマンドID

integer format: int32
>= 1
buttonName
required

ボタン名

string
>= 1 characters
command
required

コマンド。

  • 1: 値引
  • 2: 割引
  • 5: 0円販売
  • 6: 価格リセット
  • 7: 数量乗算
  • 10: ポイント対象外区分変更
  • 99: 複数コマンド実行
string
Allowed values: 1
discountAmount

値引金額

integer format: int64
>= 1 <= 9999999999
discountDivisionId

管理画面の[設定]→[販売設定]→[値引区分]で確認できる「ID」。未選択の場合は null。

integer format: int32
nullable >= 1
color
required

表示カラーコード（16進数）。#から始まる1〜6桁の16進数。

string
nullable <= 7 characters /^#[0-9A-Fa-f]{1,6}$/
isDisplay
required

表示有無

boolean
displaySequence
required

表示順

integer format: int32
nullable >= 1 <= 8
insDateTime

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

string format: date-time
updDateTime

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

string format: date-time
Example
{
  "quickCommandSettingId": 1,
  "storeScope": "1",
  "name": "string",
  "stores": [
    {
      "storeId": 1
    }
  ],
  "totalCommands": [
    {
      "quickCommandId": 1,
      "buttonName": "string",
      "command": "1",
      "discountAmount": 1234567890,
      "discountDivisionId": 1234567890,
      "color": "#0084CF",
      "isDisplay": false,
      "displaySequence": 1
    }
  ],
  "unitCommands": [
    {
      "quickCommandId": 1,
      "buttonName": "string",
      "command": "1",
      "discountAmount": 1234567890,
      "discountDivisionId": 1234567890,
      "color": "#0084CF",
      "isDisplay": false,
      "displaySequence": 1
    }
  ],
  "insDateTime": "2000-01-23T01:23:45+09:00",
  "updDateTime": "2000-01-23T01:23:45+09:00"
}

404

Section titled “404”
  • 指定されたIDが存在しない場合
Media typeapplication/json
object
type
required
string
title
required
string
detail
string
status
integer
Examples
Exampleリソースが存在しない場合
{
  "type": "about:blank",
  "title": "NotFound",
  "detail": "指定されたIDのリソースが見つかりません",
  "status": 404
}