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

クーポン登録

POST
/coupons

クーポンを登録します。

対象プラン

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

Authorizations

Section titled “Authorizations ”

Request Body

Section titled “Request Body ”
object
couponName
required
クーポン名

クーポン名

string
<= 85 characters
couponDivision
クーポン区分

クーポン区分：クーポン区分（0：通常、1：giftee）
※ 1:giftee は、プレミアムプラスプラン以上でのみ指定可能です。

string
0
Allowed values: 0 1
serialNumber
required
シリアル番号

シリアル番号：端末側でのクーポンの入力に用いられます。
※ クーポン区分が 1:giftee の場合は、gifteeクーポンに付与されているコードの上7桁を指定します。

string
<= 20 characters
summary
概要

概要

string
<= 255 characters
awardType
required
特典タイプ

特典タイプ：そのクーポンのタイプ。（1：値引、2：割引、3：商品付与、P1：0ポイント、P2：ポイント指定（上書き）、P3：ポイント追加（加算）、P4：ポイントN倍、M1：0マイル、M2：マイル指定（上書き）、M3：マイル追加（加算）、M4：マイルN倍）

string
Allowed values: 1 2 3 P1 P2 P3 P4 M1 M2 M3 M4
awardValue
required
特典値

特典値： 特典タイプに応じた値を設定。

特典タイプ 設定値
1：値引 値引き額[円]
2：割引 割引率[%]
3：商品付与 0固定
P1：0ポイント 0固定
P2：ポイント指定（上書き） ポイント数
P3：ポイント追加（加算） 差分ポイント数
P4：ポイントN倍 ポイントへ乗算する値
M1：0マイル 0固定
M2：マイル指定（上書き） マイル数
M3：マイル追加（加算） 差分マイル数
M4：マイルN倍 マイルへ乗算する値
string format: int
applyConditionDivision
required
適用条件区分

適用条件区分：クーポンの使用条件のうち、対象商品が含まれている必要があるか指定します。（0：全適用、1：対象商品が含まれる場合のみ適用）

string
Allowed values: 0 1
minTargetPrice
最低対象金額

最低対象金額

string format: int
<= 9999999999
maxTargetPrice
最高対象金額

最高対象金額

string format: int
<= 9999999999
startDate
利用可能開始日

利用可能開始日：クーポンの有効期限（開始日）。[YYYY-MM-DD]

string format: date
endDate
利用可能期限

利用可能終了日：クーポンの有効期限（終了日）。[YYYY-MM-DD]

string format: date
combineDivision
併用区分

併用区分：クーポン利用時に他クーポンとの併用が可能か否かを指定します。（1：併用不可、2：一部のクーポン(3:併用可能)と併用可能、3：併用可能）

string
default: 3
Allowed values: 1 2 3
Example
{
  "couponName": "string",
  "couponDivision": "0",
  "serialNumber": "string",
  "summary": "string",
  "awardType": "1",
  "awardValue": "1",
  "applyConditionDivision": "0",
  "minTargetPrice": "1234567890",
  "maxTargetPrice": "1234567890",
  "startDate": "2000-01-23",
  "endDate": "2000-01-23",
  "combineDivision": "1"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

更新成功

object
couponId

クーポンID

string
couponName

クーポン名

string
couponDivision

クーポン区分：クーポン区分（0：通常、1：giftee）

string
serialNumber

シリアル番号：端末側でのクーポンの入力に用いられます。

string
summary

概要

string
awardType

特典タイプ：そのクーポンのタイプ。（1：値引、2：割引、3：商品付与、P1：0ポイント、P2：ポイント指定（上書き）、P3：ポイント追加（加算）、P4：ポイントN倍、M1：0マイル、M2：マイル指定（上書き）、M3：マイル追加（加算）、M4：マイルN倍）

string
awardValue

特典値： 特典タイプに応じた値を設定。

特典タイプ 設定値
1：値引 値引き額[円]
2：割引 割引率[%]
3：商品付与 0固定
P1：0ポイント 0固定
P2：ポイント指定（上書き） ポイント数
P3：ポイント追加（加算） 差分ポイント数
P4：ポイントN倍 ポイントへ乗算する値
M1：0マイル 0固定
M2：マイル指定（上書き） マイル数
M3：マイル追加（加算） 差分マイル数
M4：マイルN倍 マイルへ乗算する値
string
applyConditionDivision

適用条件区分：クーポンの使用条件のうち、対象商品が含まれている必要があるか指定します。（0：全適用、1：対象商品が含まれる場合のみ適用）

string
minTargetPrice

最低対象金額

string
maxTargetPrice

最高対象金額

string
startDate

利用可能開始日：クーポンの有効期限（開始日）。[YYYY-MM-DD]

string
endDate

利用可能終了日：クーポンの有効期限（終了日）。[YYYY-MM-DD]

string
combineDivision

併用区分：クーポン利用時に他クーポンとの併用が可能か否かを指定します。（1：併用不可、2：一部のクーポン(3:併用可能)と併用可能、3：併用可能）

string
insDateTime

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

string
updDateTime

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

string
Example
{
  "couponId": "string",
  "couponName": "string",
  "couponDivision": "string",
  "serialNumber": "string",
  "summary": "string",
  "awardType": "string",
  "awardValue": "string",
  "applyConditionDivision": "string",
  "minTargetPrice": "string",
  "maxTargetPrice": "string",
  "startDate": "string",
  "endDate": "string",
  "combineDivision": "string",
  "insDateTime": "string",
  "updDateTime": "string"
}

400

Section titled “400 ”
  • クーポン区分が 1:giftee で、シリアル番号が7文字でない場合
  • 最低対象金額が最高対象金額を上回っている場合
  • 利用可能終了日が利用可能開始日より前の日が指定されている場合
  • 特典タイプが 1.値引 指定で、特典値が -9999999999 を下回っている場合
  • 特典タイプが 1.値引 指定で、特典値が 9999999999 を上回っている場合
  • 特典タイプが 2.割引 指定で、特典値が 0 を下回っている場合
  • 特典タイプが 2.割引 指定で、特典値が 100 を上回っている場合
  • 特典タイプが 3.商品付与 指定で、特典値が 0 以外の値を指定している場合
  • 特典タイプが P1:0ポイント 指定で、特典値が 0 以外の値を指定している場合
  • 特典タイプが P2:ポイント指定（上書き） 指定で、特典値が 0 を下回っている場合
  • 特典タイプが P2:ポイント指定（上書き） 指定で、特典値が 999999999 を上回っている場合
  • 特典タイプが P3:ポイント追加（加算） 指定で、特典値が 0 を下回っている場合
  • 特典タイプが P3:ポイント追加（加算） 指定で、特典値が 999999999 を上回っている場合
  • 特典タイプが P4:ポイントN倍 指定で、特典値が 1 を下回っている場合
  • 特典タイプが P4:ポイントN倍 指定で、特典値が 999999999 を上回っている場合
  • 特典タイプが M1:0マイル 指定で、特典値が 0 以外の値を指定している場合
  • 特典タイプが M2:マイル指定（上書き） 指定で、特典値が 0 を下回っている場合
  • 特典タイプが M2:マイル指定（上書き） 指定で、特典値が 999999999 を上回っている場合
  • 特典タイプが M3:マイル追加（加算） 指定で、特典値が 0 を下回っている場合
  • 特典タイプが M3:マイル追加（加算） 指定で、特典値が 999999999 を上回っている場合
  • 特典タイプが M4:マイルN倍 指定で、特典値が 1 を下回っている場合
  • 特典タイプが M4:マイルN倍 指定で、特典値が 999999999 を上回っている場合
  • シリアル番号が重複する場合
object
type
required
string
title
required
string
detail
string
status
integer
Examples
{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "[serialNumber] クーポン区分が 1:giftee の場合、7文字で入力してください。",
  "status": 400
}

403

Section titled “403 ”
  • プレミアムプラスプラン未満で、クーポン区分に 1:giftee を指定した場合
object
type
required
string
title
required
string
detail
string
status
integer
Examples
{
  "type": "about:blank",
  "title": "Forbidden",
  "detail": "[couponDivision] ご利用の契約では 1:giftee は指定できません。",
  "status": 403
}