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

クイックコマンド登録

POST
/quick_command_settings
curl --request POST \
  --url https://api.smaregi.dev/TARGET-CONTRACT-ID/pos/quick_command_settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "storeScope": "1", "name": "string", "stores": [ { "storeId": 1 } ], "totalCommands": [ { "buttonName": "string", "command": "1", "discountAmount": 1234567890, "discountDivisionId": 1234567890, "color": "#0084CF", "isDisplay": false, "displaySequence": 1 } ], "unitCommands": [ { "buttonName": "string", "command": "1", "discountAmount": 1234567890, "discountDivisionId": 1234567890, "color": "#0084CF", "isDisplay": false, "displaySequence": 1 } ] }'

クイックコマンド設定を登録します。

クイックコマンド設定IDは自動採番されます。

本APIでは 99: 複数コマンド実行 は指定できません。複数コマンド実行を含むクイックコマンド設定を作成する場合は、先に本APIで対象となる通常のクイックコマンドを登録し、更新APIで登録済みのクイックコマンドIDを指定してください。

対象プラン

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

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
storeScope
required
対象店舗範囲
  • 1: 全店
  • 2: 店舗指定

1: 全店 のクイックコマンド設定は1件のみ登録できます。

既に 1: 全店 のクイックコマンド設定が登録されている場合は指定できません。

string
default: 1
Allowed values: 1 2
name
required
名称
string
>= 1 characters <= 85 characters
stores
対象店舗一覧

StoreScopeが 2: 店舗指定 の場合に設定できます。

storeScopeが 1: 全店 の場合は指定できません。指定した場合はエラーになります。

storeScopeが 2: 店舗指定 の場合でも、省略、または空配列の指定が可能です。

通常店舗のみ指定できます。倉庫、受注店舗、削除済み店舗は指定できません。

既に他のクイックコマンド設定に紐づいている店舗は指定できません。

Array<object>
object
storeId
required
店舗ID

通常店舗のみ指定できます。

倉庫、受注店舗、削除済み店舗、既に他のクイックコマンド設定に紐づいている店舗IDは指定できません。

integer format: int32
>= 1
totalCommands
合計コマンド一覧

省略、または空配列の指定が可能です。

最大99件まで指定できます。

commandに応じた項目のみ設定してください。該当しない項目を設定した場合はエラーになります。

登録APIでは 99: 複数コマンド実行 は指定できません。複数コマンド実行を設定する場合は、先に本APIで対象となる通常のクイックコマンドを登録し、更新APIで登録済みのクイックコマンドIDを指定してください。

Array<object>
<= 99 items
One of:
値引
object
buttonName
required
ボタン名
string
>= 1 characters <= 100 characters
command
required
コマンド
  • 1: 値引
  • 2: 割引
  • 6: 価格リセット
  • 9: 取引タグ

登録APIでは 99: 複数コマンド実行 は指定できません。複数コマンド実行を設定する場合は、先に本APIで対象となる通常のクイックコマンドを登録し、更新APIで登録済みのクイックコマンドIDを指定してください。

string
Allowed values: 1
discountAmount
required
値引金額

1〜9999999999

integer format: int64
>= 1 <= 9999999999
discountDivisionId
値引区分ID

管理画面の[設定]→[販売設定]→[値引区分]で確認できる「ID」。未指定または null の場合は未選択として登録します。

integer format: int32
nullable >= 1
color
表示カラーコード（16進数）

#から始まる1〜6桁の16進数を指定してください。

string
<= 7 characters /^#[0-9A-Fa-f]{1,6}$/
isDisplay
表示有無

省略時は false として登録します。false の場合、レジ端末に表示されません。

boolean
displaySequence
表示順

IsDisplayが true の場合は必須です。isDisplayが true のクイックコマンド間で重複する値は指定できません。

integer format: int32
>= 1 <= 8
unitCommands
単品コマンド一覧

省略、または空配列の指定が可能です。

最大99件まで指定できます。

commandに応じた項目のみ設定してください。該当しない項目を設定した場合はエラーになります。

登録APIでは 99: 複数コマンド実行 は指定できません。複数コマンド実行を設定する場合は、先に本APIで対象となる通常のクイックコマンドを登録し、更新APIで登録済みのクイックコマンドIDを指定してください。

Array<object>
<= 99 items
One of:
値引
object
buttonName
required
ボタン名
string
>= 1 characters <= 100 characters
command
required
コマンド
  • 1: 値引
  • 2: 割引
  • 5: 0円販売
  • 6: 価格リセット
  • 7: 数量乗算
  • 10: ポイント対象外区分変更

登録APIでは 99: 複数コマンド実行 は指定できません。複数コマンド実行を設定する場合は、先に本APIで対象となる通常のクイックコマンドを登録し、更新APIで登録済みのクイックコマンドIDを指定してください。

string
Allowed values: 1
discountAmount
required
値引金額

1〜9999999999

integer format: int64
>= 1 <= 9999999999
discountDivisionId
値引区分ID

管理画面の[設定]→[販売設定]→[値引区分]で確認できる「ID」。未指定または null の場合は未選択として登録します。

integer format: int32
nullable >= 1
color
表示カラーコード（16進数）

#から始まる1〜6桁の16進数を指定してください。

string
<= 7 characters /^#[0-9A-Fa-f]{1,6}$/
isDisplay
表示有無

省略時は false として登録します。false の場合、レジ端末に表示されません。

boolean
displaySequence
表示順

IsDisplayが true の場合は必須です。isDisplayが true のクイックコマンド間で重複する値は指定できません。

integer format: int32
>= 1 <= 8
Example
{
  "storeScope": "1",
  "name": "string",
  "stores": [
    {
      "storeId": 1
    }
  ],
  "totalCommands": [
    {
      "buttonName": "string",
      "command": "1",
      "discountAmount": 1234567890,
      "discountDivisionId": 1234567890,
      "color": "#0084CF",
      "isDisplay": false,
      "displaySequence": 1
    }
  ],
  "unitCommands": [
    {
      "buttonName": "string",
      "command": "1",
      "discountAmount": 1234567890,
      "discountDivisionId": 1234567890,
      "color": "#0084CF",
      "isDisplay": false,
      "displaySequence": 1
    }
  ]
}

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: 取引タグ
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: ポイント対象外区分変更
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"
}

400

Section titled “400”
  • リクエスト内容が不正な場合
  • totalCommands、unitCommands内で指定できないcommandを指定した場合
  • totalCommands、unitCommandsに100件以上指定した場合
  • totalCommands、unitCommands内でisDisplayにtrueを指定し、displaySequenceを指定していない場合
  • totalCommands、unitCommands内で表示対象のdisplaySequenceが重複している場合
  • totalCommands、unitCommands内で 99: 複数コマンド実行 を指定した場合
  • commandに応じた必須項目が未指定の場合
  • commandに応じた項目以外を指定した場合
  • 既に全店のクイックコマンド設定が登録されている状態でstoreScopeに 1: 全店 を指定した場合
  • storeScopeに 1: 全店 を指定し、storesを指定した場合
  • storesに通常店舗以外、または削除済み店舗の店舗IDを指定した場合
  • storesに既に他のクイックコマンド設定に紐づいている店舗IDを指定した場合
Media typeapplication/json
object
type
required
string
title
required
string
detail
string
status
integer
Examples
{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "[totalCommands.command] は[1,2,6,9]の中から指定して下さい。",
  "status": 400
}