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

レジ端末更新

PATCH
/terminals/{terminal_id}

レジ端末を更新します。

対象プラン

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

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
terminal_id
required
string

端末ID

Request Body

Section titled “Request Body ”
object
storeId
店舗ID

店舗毎に付与するID
※店舗情報が存在しない場合エラー
※休止中の店舗IDを指定するとエラー

string format: int
>= 1 <= 999999999
terminalName
端末名

端末名

string format: string
<= 85 characters
uuid
端末識別番号

ユニーク値 端末を一意に識別する番号

string format: string
<= 40 characters //^[ -~]+$//
useStopDivision
利用停止区分

利用停止区分（0:利用する、1:利用しない）

string
Allowed values: 0 1
transactionEditableFlag
取引編集可能フラグ

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

string
Allowed values: 0 1
selfCheckoutAvailableFlag
セルフレジ使用可能フラグ

対象プラン プレミアムプラス／フードビジネス／リテールビジネス
セルフレジ使用可能フラグ（0:使用できない、1:使用できる）

string
Allowed values: 0 1
smartIdEngineAvailableFlag
Smart ID Engine利用フラグ

対象プラン リテールビジネス
Smart ID Engine利用フラグ（0:利用しない、1:利用する）

string
Allowed values: 0 1
creditTerminalId
CAT/CCT端末ID

レジ端末に紐付けるCAT/CCT端末のID
※CAT/CCT端末連動が有効な契約でのみ設定可能です
※CAT/CCT端末情報が存在しない場合エラー
※他のレジ端末で既に登録されているCAT/CCT端末IDを指定するとエラー

string format: int
>= 1 <= 999999999
cashDrawerId
キャッシュドロアID

レジ端末を登録するキャッシュドロアのID
※利用可能なキャッシュドロア情報が存在しない場合エラー
※同一店舗に所属しないキャッシュドロアIDを指定するとエラー

string format: int
>= 1 <= 999999999
parentTerminalId
親端末ID

親端末として登録するレジ端末の端末ID
※端末情報が存在しない場合エラー
※同一店舗に所属しない端末IDを指定するとエラー
※親端末が設定されている端末IDを指定するとエラー

string format: int
>= 1 <= 999999999
Example
{
  "storeId": "123456789",
  "terminalName": "string",
  "uuid": "string",
  "useStopDivision": "0",
  "transactionEditableFlag": "0",
  "selfCheckoutAvailableFlag": "0",
  "smartIdEngineAvailableFlag": "0",
  "creditTerminalId": "123456789",
  "cashDrawerId": "123456789",
  "parentTerminalId": "123456789"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

取得成功

Array<object>
object
terminalId

端末ID

string
storeId

店舗ID

string
terminalName

端末名

string
uuid

端末識別番号

string
useStopDivision

利用停止区分（0:利用する、1:利用しない）

string
Allowed values: 0 1
transactionEditableFlag

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

string
Allowed values: 0 1
selfCheckoutAvailableFlag

対象プラン プレミアムプラス／フードビジネス／リテールビジネス
セルフレジ使用可能フラグ（0:使用できない、1:使用できる）

string
Allowed values: 0 1
smartIdEngineAvailableFlag

対象プラン リテールビジネス
Smart ID Engine利用フラグ（0:利用しない、1:利用する）

string
Allowed values: 0 1
creditTerminalId

CAT/CCT端末ID

string
cashDrawerId

キャッシュドロアID

string
parentTerminalId

親端末ID

string
insDateTime

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

string
updDateTime

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

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

400

Section titled “400 ”
  • 存在しない店舗IDを指定した場合
  • 店舗が休止中の店舗IDを指定した場合
  • 設定されているキャッシュドロアと異なる店舗IDを指定した場合
  • 設定されている親端末と異なる店舗IDを指定した場合
  • 親端末の店舗IDを変更しようとした場合
  • 販売用端末の登録上限数を超えてしまう場合
  • 端末識別番号が重複した場合
  • セルフレジ端末の登録上限数を超えてしまう場合
  • Smart ID Engineの利用可能台数上限を超えてしまう場合
  • 存在しないCAT/CCT端末IDを指定した場合
  • 他のレジ端末で既に登録されているCAT/CCT端末IDを指定した場合
  • 存在しないキャッシュドロアIDを指定した場合
  • 異なる店舗に所属するキャッシュドロアIDを指定した場合
  • 利用不可のキャッシュドロアIDを指定した場合
  • 親端末に親端末IDを指定した場合
  • 存在しない親端末IDを指定した場合
  • 更新対象のレジ端末IDを親端末IDに指定した場合
  • 異なる店舗に所属するレジ端末を親端末IDに指定した場合
  • 親端末が設定されているレジ端末を親端末IDに指定した場合
object
type
required
string
title
required
string
detail
string
status
integer
Examples
{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "存在しない店舗IDです。",
  "status": 400
}

403

Section titled “403 ”
  • CAT/CCT端末連動が有効な契約でのみ設定可能な項目が、そうでない契約において設定された場合
object
type
required
string
title
required
string
detail
string
status
integer
Examples
{
  "type": "about:blank",
  "title": "Forbidden",
  "detail": "ご利用の契約ではCAT/CCT端末IDは登録できません。",
  "status": 403
}

404

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