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

バンドル販売登録

POST
/bundles

バンドル販売情報を登録します。

対象プラン

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

Authorizations

Section titled “Authorizations ”

Request Body

Section titled “Request Body ”
object
productBundleGroupName
required
商品バンドルグループ名

商品バンドルグループの名称。

string
<= 85 characters
type
required
種類

種類：バンドル販売の種類。
1：バンドル売り+販売金額指定
2：バンドル売り+値引金額指定
3：バンドル売り+割引率指定
4：セット売り+販売金額指定

string
Allowed values: 1 2 3 4
taxDivision
税区分

税区分 (0:税込、1:税抜、2:非課税)

string
Allowed values: 0 1 2
reduceTaxId
軽減税率ID

軽減税率ID
標準:null（または未設定）
軽減:10000001 (特定商品の軽減税率適用）
選択[標準]:10000002（状態による適用[適用しない]）
選択[軽減]:10000003（状態による適用[適用する]）
選択[選択]:10000004（状態による適用[都度選択する]）
上記以外の場合、カスタム軽減税率で登録されている軽減税率ID

※10000001〜10000004における軽減税率は日本国における軽減税率(8%)です。
※存在しない軽減税率IDを指定した場合エラー。

string format: int
quantity
数量

バンドル販売の条件となる数量。

string format: int
>= 1 <= 999
value
required
値

種類=1,4の時は販売金額、種類=2の時は値引金額、種類=3の時は割引率。
※割引率の場合は [ 0 .. 100 ] (単位:%)を設定。

string format: int
>= -99999999 <= 999999999
reduceTaxValue
軽減税率適用時の値

種類=1,4の時は販売金額、種類=2の時は値引金額、種類=3の時は割引率。
※割引率の場合は [ 0 .. 100 ] (単位:%)を設定。

string format: int
>= -99999999 <= 999999999
priority
優先順位

バンドル販売適用の優先順位。

string format: int
<= 999
termFrom
required
適用開始日

適用開始日 [YYYY-MM-DD]

string format: date
termTo
required
適用終了日

適用終了日 [YYYY-MM-DD]

string format: date
pointNotApplicable
ポイント対象区分

ポイント対象区分 (0:ポイント対象、1:ポイント対象外)
※省略時は 0:ポイント対象 を設定

string
Allowed values: 0 1
taxFreeDivision
免税区分

免税区分 (0:対象外、1:一般品、2:消耗品)
※省略時は 0:対象外 を設定

string
Allowed values: 0 1 2
calcDiscount
値引割引計算対象区分

値引割引計算対象区分 (0:対象外、1:対象)
※省略時は 1:対象 を設定

string
Allowed values: 0 1
products
required
対象商品

対象商品:バンドル販売の対象商品
※1件以上の登録必須。
※部門ID、商品ID、商品グループコードのいずれか必須。（複数指定不可。複数設定された場合はエラー）
※種類=4の場合、商品IDのみ設定可能。（部門ID、商品グループコードが設定された場合エラー）

Array<object>
object
categoryId
部門ID

部門ID

string format: int
productId
商品ID

商品ID
※ ユーザーアクセストークンを利用する場合、ユーザーの所属する店舗で販売している商品IDを指定してください。

string format: int
productGroupCode
商品グループコード

商品グループコード

string
<= 255 characters
Example
{
  "productBundleGroupName": "string",
  "type": "1",
  "taxDivision": "0",
  "reduceTaxId": "10000001",
  "quantity": "123",
  "value": "123456789",
  "reduceTaxValue": "123456789",
  "priority": "123",
  "termFrom": "2000-01-23",
  "termTo": "2000-01-23",
  "pointNotApplicable": "0",
  "taxFreeDivision": "0",
  "calcDiscount": "0",
  "products": [
    {
      "categoryId": "1",
      "productId": "1",
      "productGroupCode": "string"
    }
  ]
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

更新成功

object
productBundleGroupId

商品バンドルグループID：商品バンドルグループ毎に付与するID。

string
productBundleGroupName

商品バンドルグループ名：商品バンドルグループの名称。

string
type

種類：バンドル販売の種類。
1：バンドル売り+販売金額指定
2：バンドル売り+値引金額指定
3：バンドル売り+割引率指定
4：セット売り+販売金額指定

string
taxDivision

税区分：税区分 (0:税込、1:税抜、2:非課税)

string
reduceTaxId

軽減税率ID（税設定）：軽減税率設定画面で設定した軽減税率ID、または、下記の軽減税率ID。標準税率の場合はnull。
軽減:10000001 (特定商品の軽減税率適用）
選択[標準]:10000002（状態による適用[適用しない]）
選択[軽減]:10000003（状態による適用[適用する]）
選択[選択]:10000004（状態による適用[都度選択する]）

string
quantity

数量：バンドル販売の条件となる数量。

string
value

値：種類=1,4の時は販売金額、種類=2の時は値引金額、種類=3の時は割引率。

string
reduceTaxValue

軽減税率適用時の値：種類=1,4の時は販売金額、種類=2の時は値引金額、種類=3の時は割引率

string
priority

優先順位：バンドル販売適用の優先順位。

string
termFrom

適用開始日：適用開始日。 [YYYY-MM-DD]

string
termTo

適用終了日：適用終了日。[YYYY-MM-DD]

string
pointNotApplicable

ポイント対象区分：ポイント対象区分 (0:ポイント対象、1:ポイント対象外)

string
taxFreeDivision

免税区分：免税区分 (0:対象外、1:一般品、2:消耗品)

string
calcDiscount

値引割引計算対象区分：値引割引計算対象区分 (0:対象外、1:対象)

string
insDateTime

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

string
updDateTime

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

string
products

対象商品:バンドル販売の対象商品

Array<object>
object
productBundleId

商品バンドル明細ID:商品バンドル明細毎に付与するID。サーバー側で付与する。

string
productBundleGroupId

商品バンドルグループID：商品バンドルグループ毎に付与するID。サーバー側で付与する。

string
categoryId

部門ID：バンドル販売の対象となる部門ID。セット販売の場合、商品IDに紐つく部門ID。

string
productId

商品ID：バンドル販売／セット販売の対象となる商品ID。

string
productGroupCode

商品グループコード：バンドル販売の対象となる商品グループコード。セット販売の場合、商品IDに紐つく商品グループコード。

string
Example
{
  "productBundleGroupId": "string",
  "productBundleGroupName": "string",
  "type": "string",
  "taxDivision": "string",
  "reduceTaxId": "10000001",
  "quantity": "string",
  "value": "string",
  "reduceTaxValue": "string",
  "priority": "string",
  "termFrom": "string",
  "termTo": "string",
  "pointNotApplicable": "string",
  "taxFreeDivision": "string",
  "calcDiscount": "string",
  "insDateTime": "string",
  "updDateTime": "string",
  "products": [
    {
      "productBundleId": "string",
      "productBundleGroupId": "string",
      "categoryId": "string",
      "productId": "string",
      "productGroupCode": "string"
    }
  ]
}

400

Section titled “400 ”
  • 適用終了日が適用開始日より前の場合
  • 税区分が非課税の場合に軽減税率IDが設定された場合
  • 税区分が非課税の場合に軽減税率適用時の値が設定された場合
  • 指定された軽減税率IDが存在しない場合
  • 軽減税率IDが選択(10000002-10000004) かつ 税区分が税込 以外の場合に、軽減税率適用時の値が設定された場合
  • 対象商品が設定されていない場合
  • 対象商品に部門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": "[適用期間] 適用終了日が適用開始日以降になるように設定してください。",
  "status": 400
}