レジ端末通知

POST

/stores/{store_id}/terminals/{terminal_id}/notifications

• サンドボックス
• 本番

指定した端末にプッシュ通知を送信し、スマレジ・アプリ上にメッセージを通知します。

※メッセージ本文の受信は、スマレジ・アプリ ver.2.4.0以降 で利用可能です。(ver.2.4.0未満 の場合、メッセージ件名のみ通知）

プッシュ通知の送信成功・失敗に関わらず、通知データが正常に登録されていれば成功レスポンスを返却します。

プッシュ通知が届かなかった場合でもスマレジ・アプリ側で未受信のメッセージを定期的に自動取得します。

対象プラン

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

Authorizations

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

Parameters

Path Parameters

store_id

required

string

店舗ID

terminal_id

required

string

端末ID

Request Body

object

level

通知レベル

通知レベル

• 0: 通常
• 8: 警告
• 9: エラー

string

default: 0

Allowed values: 0 8 9

title

required

メッセージ件名

メッセージ件名

string

>= 1 characters <= 32 characters

content

required

メッセージ

メッセージ本文

string

>= 1 characters <= 1000 characters

color

メッセージの色

メッセージの色（カラーコード）

未設定の場合、通知レベルに対応した色が設定されます。

• 通知レベルが 0:通常 の場合 、#007ec4（青）
• 通知レベルが 8:警告 の場合、#ff9900（黄）
• 通知レベルが 9:エラー の場合、#ff0000（赤）

string

/^#([0-9a-fA-F]{6})$/

Example

{
  "level": "0",
  "title": "string",
  "content": "string",
  "color": "string"
}

Responses

200

登録成功

object

notificationId

通知ID

string

storeId

店舗ID

string

terminalId

端末ID

string

Example

{
  "notificationId": "string",
  "storeId": "string",
  "terminalId": "string"
}

400

• 指定された端末の利用停止区分が「利用しない」の場合
• 指定された端末にデバイストークンが設定されていない場合

object

type

required

string

title

required

string

detail

string

status

integer

Examples

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "指定された端末は利用停止中です。",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "指定された端末にはデバイストークンが設定されていません。スマレジ・アプリから店舗同期を行ってください。",
  "status": 400
}

404

• 指定された店舗に所属する端末IDが存在しない場合

object

type

required

string

title

required

string

detail

string

status

integer

Examples

{
  "type": "about:blank",
  "title": "NotFound",
  "detail": "指定されたIDのリソースが見つかりません",
  "status": 404
}