レジ端末印刷

POST

/stores/{store_id}/terminals/{terminal_id}/prints

• サンドボックス
• 本番

指定した端末に画像URLを含むプッシュ通知を送信し、スマレジ・アプリに接続されているプリンターから画像を印刷します。

※本機能はスマレジ・アプリ ver.4.41.0以降 で利用可能です。

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

プッシュ通知が届かなかった場合はスマレジ・アプリから手動で未印刷のデータを取得することができます。

※印刷画像はAPI実行時点から30日間保存されます。この保存期間を超過した場合、未印刷であってもスマレジ・アプリからデータを取得することはできなくなります。

対象プラン

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

Authorizations

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

Parameters

Path Parameters

store_id

required

string

店舗ID

terminal_id

required

string

端末ID

Request Body

object

printImageUrl

required

印刷画像URL

プリンターで印刷したい画像のURL

弊社システムから本項目に指定されたURLにアクセスして取得しますので、アクセス可能なURLを指定してください。

画像サイズは最大63KB、横幅は最大576px、縦幅は最大1024px、対応フォーマットはJPEG,PNGです。

• 横幅の狭いプリンターでは縮小されて印刷されます。

  プリンター機種	レシート幅58mm	レシート幅80mm
  SM-S210i	360px
  SM-L200	380px
  mPOP	380px
  MP-B20	380px
  SPP-R200II	380px
  P25	380px
  mC-Print2	380px
  mC-Print3	380px	570px
  TM-m10	420px
  TM-m30	420px	576px
  PRP-250	420px	576px
  RP-F10	420px	576px
  上記以外		576px

• SM-S210iでは横幅380px、縦幅600pxが最大サイズとなり、これより大きいサイズの画像を指定すると正しく印字されません。

string format: uri

<= 2048 characters /^https?:\/\/.*/

printerType

プリンター種別

プリンター種別

• 1: プリンター
• 2: 仮販売プリンター
• 3: 引換券控えプリンター

string

default: 1

Allowed values: 1 2 3

Example

{
  "printImageUrl": "https://example.com",
  "printerType": "1"
}

Responses

200

登録成功

object

printId

印刷ID

string

printInstructionDateTime

印刷指示日時

string format: date-time

storeId

店舗ID

string

terminalId

端末ID

string

Example

{
  "printId": "string",
  "printInstructionDateTime": "2000-01-23T01:23:45+09:00",
  "storeId": "string",
  "terminalId": "string"
}

400

• 指定された端末の利用停止区分が「利用しない」の場合
• 指定された端末のスマレジ・アプリバージョンが4.41.0未満の場合
• 指定された端末にデバイストークンが設定されていない場合
• 指定された印刷画像URLのフォーマットが正しくない場合
• 指定された印刷画像URLから画像情報が取得できない場合
• 指定された印刷画像URLの画像がJPEG、PNG以外の場合
• 指定された印刷画像URLの画像が最大容量を超えていた場合
• 指定された印刷画像URLの画像が最大横幅を超えていた場合
• 指定された印刷画像URLの画像が最大縦幅を超えていた場合

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
}

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

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "指定された印刷画像URLのフォーマットが不正です。",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "指定された印刷画像URLから画像情報が取得できません。",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "印刷画像URLに指定できる画像はJPEG、PNGのみです。",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "印刷画像URLに指定できる画像の容量は63KBまでです。",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "印刷画像URLに指定できる画像の横幅は576pxまでです。",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "印刷画像URLに指定できる画像の縦幅は1152pxまでです。",
  "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
}