仮販売登録

Authorizations

AppAccessToken
pos.transactions:write
UserAccessToken
pos.transactions:write

Request Body

object

transactionHeadDivision

required

取引区分

取引を識別する区分。
（1:通常、2:入金、3:出金、4:預かり金、 5:預かり金返金、6:ポイント加算、7:ポイント減算、8:ポイント失効、10:取置き、13:マイル加算、14:マイル減算、15:バリューカード入金、16:領収証）
※ 仮販売登録APIは、1:通常のみ対応しています。

string

Allowed values: 1

status

required

ステータス

仮販売のステータス。（0:通常、1:完了、2:取消）
※ 仮販売登録APIは、0:通常のみ対応しています。

string

Allowed values: 0

barcode

バーコード

ユニーク値 バーコード
※省略時はシステムで一意のバーコードを設定

string

<= 20 characters

sequentialNumber

連番

連番
※省略時はシステムで日毎の連番を設定

string format: int

>= 1 <= 99999999999

preRegistrationName

仮販売名

仮販売の名称を設定。20文字以内。
※設定した場合、スマレジアプリ取引機能において、仮販売一覧に表示されます。設定しない場合は連番が表示されます。

string

<= 20 characters

subtotal

required

小計

取引明細の値引き後小計の合計。
※明細合計と異なる場合エラー

string format: int

>= -999999999 <= 999999999

subtotalDiscountPrice

小計値引き

小計の値引き金額を設定。

string format: int

>= -999999999 <= 999999999

subtotalDiscountRate

小計割引率

小計の割引を設定（単位％）デフォルトは未設定。
設定された場合、小計値引は必須。
※小計値引率から小計値引は計算しないため小計値引に値引額を設定してください。

string format: int

>= -999 <= 999

subtotalDiscountDivision

小計値引き/割引区分

小計値引き/割引時に指定された区分を設定。
管理画面->設定->販売設定->値引区分/割引区分のページで確認できるID。

string format: int

>= 1 <= 999999999

pointDiscount

ポイント値引き

使用ポイント * ポイント還元率。

string format: int

>= -999999999 <= 999999999

total

required

合計

小計 - 小計値引き - ポイント値引き + 端数値引額 + 外税額 - 免税額を設定
※ 端数値引き機能は現在ご利用いただけません

string format: int

>= -999999999 <= 999999999

taxInclude

内税額

内税商品計 / 110 * 10。
※税率が10%の場合
※小数点以下は税の丸め方式で指定の通り

string format: int

>= -999999999 <= 999999999

taxExclude

外税額

外税商品計 * 10 / 100。
※税率が10%の場合
※小数点以下は税の丸め方式で指定の通り

string format: int

>= -999999999 <= 999999999

roundingDivision

端数値引区分

販売時の合計金額の端数を丸めるか否かを設定する。
00:なし
11:一の位を四捨五入 12:一の位を切捨 13:一の位を切上
21:十の位を四捨五入 22:十の位を切捨 23:十の位を切上
31:百の位を四捨五入 32:百の位を切捨 33:百の位を切上
41:千の位を四捨五入 42:千の位を切捨 43:千の位を切上
99:手入力

string

Allowed values: 00 11 12 13 21 22 23 31 32 33 41 42 43 99

roundingPrice

端数値引額

string format: int

>= -999999999 <= 999999999

newPoint

付与ポイント

取引で付与されるポイント。合計 * ポイント付与率
会員IDが設定されている場合、会員ポイント情報を更新。
※省略時は0を設定

string format: int

0 >= -999999999 <= 999999999

spendPoint

使用ポイント

取引で使用したポイント。
会員IDが設定されている場合、会員ポイント情報を更新。
※省略時は0を設定

string format: int

>= -999999999 <= 999999999

point

現在ポイント

取引前のポイント。

string format: int

>= -999999999 <= 999999999

totalPoint

合計ポイント

取引後のポイント現在ポイント + 付与ポイント - 使用ポイント。

string format: int

>= -999999999 <= 999999999

storeId

required

店舗ID

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

string format: int

>= 1 <= 999999999

terminalId

required

端末ID

店舗の端末毎に付与するID。
※存在しない端末IDも設定可能。

string format: int

>= 1 <= 999999999

customerId

会員ID

会員毎に付与するID。
※存在しない会員IDの場合、そのまま会員IDは登録されますが、会員ポイント情報等は更新しません。

string format: int

>= 1 <= 9999999999

customerCode

会員コード

会員毎に付与する一意のコード。
※設定された場合、会員IDは必須。
※会員マスタに存在する会員IDが設定されている場合、会員情報の会員コードと一致しないとエラー。
※省略時、会員IDが設定されている場合、会員マスタの会員コードを設定。（スマレジ管理画面ver.4.12.0リリース以降）

string

<= 20 characters //^[ -~]+$//

terminalTranId

required

端末取引ID

端末で設定された取引ID。(連携元システムで任意の連番を設定してください）

string

<= 10 characters

terminalTranDateTime

required

端末取引日時

端末で設定された取引日時。[YYYY-MM-DDThh:mm:ssTZD]（連携元システムで処理日時を設定してください）

string format: date-time

customerGroupId

客層ID

客層ID。客層セクションIDが1の客層IDを設定。
※客層情報が存在しない場合エラー

string format: int

>= 1 <= 999999999

customerGroupId2

客層ID2

客層ID2。客層セクションIDが2の客層IDを設定。
※客層情報が存在しない場合エラー

string format: int

>= 1 <= 999999999

customerGroupId3

客層ID3

客層ID3。客層セクションIDが3の客層IDを設定。
※客層情報が存在しない場合エラー

string format: int

>= 1 <= 999999999

customerGroupId4

客層ID4

客層ID4。客層セクションIDが4の客層IDを設定。
※客層情報が存在しない場合エラー

string format: int

>= 1 <= 999999999

customerGroupId5

客層ID5

客層ID5。客層セクションIDが5の客層IDを設定。
※客層情報が存在しない場合エラー

string format: int

>= 1 <= 999999999

staffId

販売員ID

販売員ID（スタッフID）
※スタッフ情報が存在しない場合エラー
※ ユーザーアクセストークンを利用する場合、ユーザーの所属する店舗の販売員IDを指定してください。

string format: int

>= 1 <= 999999999

memo

メモ

入出金時のメモなどを設定。 1000文字以内。

string

<= 1000 characters

receiptMemo

レシートメモ

レシートに印字するメモを設定。100文字以内。

string

<= 100 characters

guestNumbers

客数

客数。

string format: int

<= 9999

guestNumbersMale

客数（男）

客数（男）。

string format: int

<= 9999

guestNumbersFemale

客数（女）

客数（女）。

string format: int

<= 9999

guestNumbersUnknown

客数（不明）

客数（不明）。

string format: int

<= 9999

enterDateTime

入店日時

入店日時。[YYYY-MM-DDThh:mm:ssTZD]

string format: date-time

taxFreeSalesDivision

免税販売区分

免税販売区分 (0:通常販売、1:免税販売(自動計算)、2:免税販売(強制免税適用)、3:免税販売(一般品のみ強制免税適用)、4:免税販売(消耗品のみ強制免税適用)、5:免税販売(自動計算・合算))
※未設定の場合、0:通常販売

string

0

Allowed values: 0 1 2 3 4 5

netTaxFreeGeneralTaxInclude

内税商品の一般品免税額

内税商品の一般品免税額。

string format: int

>= -999999999 <= 999999999

netTaxFreeGeneralTaxExclude

外税商品の一般品免税額

外税商品の一般品免税額。

string format: int

>= -999999999 <= 999999999

netTaxFreeConsumableTaxInclude

内税商品の消耗品免税額

内税商品の消耗品免税額。

string format: int

>= -999999999 <= 999999999

netTaxFreeConsumableTaxExclude

外税商品の消耗品免税額

外税商品の消耗品免税額。

string format: int

>= -999999999 <= 999999999

tags

取引タグ

レジ端末よりクイックコマンドを押下した値を設定。和名を設定する。
※1取引タグは最大64文字。複数ある場合は、カンマ区切りで設定。

string

<= 255 characters

mileageDivision

マイレージ利用区分

マイレージ機能を利用するか否か。 (0: 利用しない 1: 利用する 2: ポイントの代わりに貯める)
※未設定の場合は店舗マスタから設定。初期値:0。

string

0

Allowed values: 0 1 2

mileageLabel

マイレージラベル

マイレージの名称。未設定の場合は「マイル」

string

<= 32 characters

sellDivision

販売区分

取引が外税販売、内税販売かを識別する区分。（0:内税販売、1:外税販売）
※省略時は0:内税販売を設定

string

Allowed values: 0 1

taxRate

税率

税率（単位％）
※省略時は、スマレジに設定されている消費税を設定（端末取引日時より算出）

string format: decimal

<= 99999.999

taxRounding

税の丸め方式

税の丸めを判定。 0:四捨五入、1:切り捨て、2:切り上げ
※省略時はスマレジに設定されている税の丸め方式を設定

string

Allowed values: 0 1 2

discountRoundingDivision

割引丸め区分

割引の端数を丸める方法を指定する区分。 0:四捨五入、1:切り捨て、2:切り上げ
※省略時は店舗マスタに設定されている税の丸め方式を設定

string

Allowed values: 0 1 2

details

required

取引明細

Array<object>

object

transactionDetailId

required

取引明細ID

ユニーク値 取引毎の明細に付与するID。
設定する場合は1〜999まで。
取引明細を指定する場合必須。

string format: int

>= 1 <= 999

parentTransactionDetailId

親取引明細ID

紐付く親の取引明細がある場合、その取引明細IDを設定。
※商品区分が、0（通常販売）, 4（バンドル(親)）の場合は設定できず、2（オプション商品）の場合はオプション元の取引明細IDを、7（バンドル子）, 8（バンドル値引）の時は、バンドル(親)の取引明細IDを設定しなければならない。

string format: int

>= 1 <= 999

transactionDetailDivision

required

取引明細区分

取引明細を識別する区分。
（1:通常、2:返品、3:部門売り）
取引明細を指定する場合必須。

string

Allowed values: 1 2 3

productId

商品ID

商品毎に付与するID
※ 存在しない商品IDが設定されている場合、nullを登録。
※ 商品IDで指定された商品の持つ商品区分が 1:回数券の明細は登録できません。
※ ユーザーアクセストークンを利用する場合、ユーザーの所属する店舗で販売している商品IDを指定してください。

string format: int

>= 1 <= 999999999999999

productCode

商品コード

商品コード。（半角英数記号 20桁以内）
省略時、商品IDが設定されている場合、マスタから設定。以外はnull

string

<= 20 characters /^[ -~]+$/

productName

商品名

省略時、商品IDが設定されている場合、マスタから設定。以外はnull

string

<= 85 characters

printReceiptProductName

レシート印字商品名

省略時、商品IDが設定されている場合、マスタから設定。以外はnull

string

<= 85 characters

taxDivision

税区分

(0:税込、1:税抜、2:非課税)
※設定時そのまま設定
※省略時、商品IDが設定されている場合、マスタから設定。以外は0:税込

string

Allowed values: 0 1 2

price

商品単価

※設定時そのまま設定
※省略時、商品IDが設定されている場合、マスタから設定。以外は0円

string format: int

>= -999999999 <= 999999999

salesPrice

required

販売単価

販売時の単価を設定。
取引明細を指定する場合必須。

string format: int

>= -999999999 <= 999999999

unitDiscountPrice

単品値引

販売単価の値引き金額を設定。

string format: int

>= -999999999 <= 999999999

unitDiscountRate

単品割引率

単品の割引率を設定。（単位:％）
※このフィールドはラベルであり、販売単価の値引き金額の算出には利用されません。
※設定された場合、単品値引は必須

string format: int

>= -999 <= 999

unitDiscountDivision

単品値引き/割引区分

単品値引き/割引時に指定された割引区分を設定。

string format: int

>= 1 <= 999999999

quantity

required

数量

購入数
取引明細を指定する場合必須。

string format: int

>= 1 <= 999999

categoryId

部門ID

商品に紐付く部門毎に付与するID。数字9桁以内。
※部門情報が存在しない場合、エラー
※商品IDが設定されている場合、商品情報の部門IDと一致しないとエラー
※省略時、商品IDが設定されている場合、商品マスタの部門IDを設定

string format: int

>= 1 <= 999999999

categoryName

部門名

商品に紐付く部門名。(85文字以内)
※設定時、そのまま設定。
※省略時、部門IDが設定されている場合、マスタから設定。以外はnull

string

<= 85 characters

salesDivision

売上区分

売上計上するか否かの区分。（0:売上対象、1:売上対象外）
省略時、商品IDが設定されている場合、商品マスタから設定。以外は0:売上対象を設定

string

Allowed values: 0 1

productDivision

商品区分

商品区分 (0:通常、1:回数券、2:オプション商品、3:部門販売、4:バンドル (親)、5:セット売(親)、6:簡易セット(親)、7:バンドル商品(子)、8:バンドル値引(子)、A:プラン(子)、B:コース(子)) ※0, 2, 4, 7, 8のみ許可。商品区分を0, 4にする場合、親取引明細IDは設定不可。また、商品区分を2（オプション商品）にする場合は親取引明細IDにオプション元の取引明細IDの、7, 8にする場合はバンドル(親)の取引明細IDの設定が必要
※A,Bはウェイターでのみ利用する区分。

string

Allowed values: 0 2 4 7 8

calcDiscount

値引割引計算対象

小計値引／割引(クーポン、ポイント値引き含む)の対象かどうかを設定。（0:対象外、1:対象）
※省略時、商品IDが設定されている場合、商品マスタから設定。その他の場合は1:対象を設定。
※スマレジ・アプリver.4.27.0以降で取引登録すると、取引明細区分が2:返品の取引明細は仮販売登録時の値引割引計算対象設定値に関わらず、0:対象外として再計算します。

string

Allowed values: 0 1

taxFreeDivision

免税区分

免税区分の設定。(0:対象外、1:一般品、2:消耗品)
省略時、商品区分が0:通常、2:オプション商品、7:バンドル商品(子)、8:バンドル値引(子)で商品IDが設定されている場合、商品マスタから設定。商品区分が4:バンドル (親)で商品バンドルグループIDが設定されている場合、商品バンドルグループマスタから設定。以外は0:対象外を設定

string

Allowed values: 0 1 2

taxFreeCommodityPrice

免税対象額

免税後の税抜金額を設定。（税抜価格x数量）
※免税販売時に未設定だと、日報の表示がずれる事があるので注意してください。

string format: int

>= -999999999 <= 999999999

taxFree

免税額

免税額を設定。（免税対象額 x 税率）
※免税販売時に未設定だと、日報の表示がずれる事があるので注意してください。

string format: int

>= -999999999 <= 999999999

productBundleGroupId

商品バンドルグループID

商品バンドル販売の明細の場合、商品バンドルグループのIDを設定。
商品バンドルグループに存在するIDを指定しなければならない。
この項目を設定する明細の商品区分は「4:バンドル(親)」でなければならない

string format: int

>= 1 <= 999999999

reduceTaxId

軽減税率ID（税設定）

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

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

string format: int

>= 1 <= 999999999

memo

メモ

返品販売時などのメモなどを設定。 1000文字以内。

string

<= 1000 characters

Example

{
  "transactionHeadDivision": "1",
  "status": "0",
  "barcode": "string",
  "sequentialNumber": "12345678901",
  "preRegistrationName": "string",
  "subtotal": "123456789",
  "subtotalDiscountPrice": "123456789",
  "subtotalDiscountRate": "123",
  "subtotalDiscountDivision": "123456789",
  "pointDiscount": "123456789",
  "total": "123456789",
  "taxInclude": "123456789",
  "taxExclude": "123456789",
  "roundingDivision": "00",
  "roundingPrice": "123456789",
  "newPoint": "123456789",
  "spendPoint": "123456789",
  "point": "123456789",
  "totalPoint": "123456789",
  "storeId": "123456789",
  "terminalId": "123456789",
  "customerId": "1234567890",
  "customerCode": "string",
  "terminalTranId": "string",
  "terminalTranDateTime": "2000-01-23T01:23:45+09:00",
  "customerGroupId": "123456789",
  "customerGroupId2": "123456789",
  "customerGroupId3": "123456789",
  "customerGroupId4": "123456789",
  "customerGroupId5": "123456789",
  "staffId": "123456789",
  "memo": "string",
  "receiptMemo": "string",
  "guestNumbers": "1234",
  "guestNumbersMale": "1234",
  "guestNumbersFemale": "1234",
  "guestNumbersUnknown": "1234",
  "enterDateTime": "2000-01-23T01:23:45+09:00",
  "taxFreeSalesDivision": "0",
  "netTaxFreeGeneralTaxInclude": "123456789",
  "netTaxFreeGeneralTaxExclude": "123456789",
  "netTaxFreeConsumableTaxInclude": "123456789",
  "netTaxFreeConsumableTaxExclude": "123456789",
  "tags": "string",
  "mileageDivision": "0",
  "mileageLabel": "string",
  "sellDivision": "0",
  "taxRate": "99999.999",
  "taxRounding": "0",
  "discountRoundingDivision": "0",
  "details": [
    {
      "transactionDetailId": "123",
      "parentTransactionDetailId": "123",
      "transactionDetailDivision": "1",
      "productId": "123456789012345",
      "productCode": "string",
      "productName": "string",
      "printReceiptProductName": "string",
      "taxDivision": "0",
      "price": "123456789",
      "salesPrice": "123456789",
      "unitDiscountPrice": "123456789",
      "unitDiscountRate": "123",
      "unitDiscountDivision": "123456789",
      "quantity": "123456",
      "categoryId": "123456789",
      "categoryName": "string",
      "salesDivision": "0",
      "productDivision": "0",
      "calcDiscount": "0",
      "taxFreeDivision": "0",
      "taxFreeCommodityPrice": "123456789",
      "taxFree": "123456789",
      "productBundleGroupId": "123456789",
      "reduceTaxId": "10000001",
      "memo": "string"
    }
  ]
}

200

更新成功

object

transactionHeadId

仮販売取引ID

string

transactionDateTime

取引日時。サーバーに送信された日時。販売日時は端末取引日時を参照。[YYYY-MM-DDThh:mm:ssTZD]

string

transactionHeadDivision

取引を識別する区分。
（1:通常、2:入金、3:出金、4:預かり金、 5:預かり金返金、6:ポイント加算、7:ポイント減算、8:ポイント失効、10:取置き、13:マイル加算、14:マイル減算、15:バリューカード入金、16:領収証）

string

cancelDivision

取引の取消を識別する区分。 (0:通常、1取消）

string

status

仮販売のステータス。（0:通常、1:完了、2:取消）

string

barcode

バーコード

string

sequentialNumber

連番

string

preRegistrationName

仮販売の名称を設定。20文字以内。

string

unitNonDiscountsubtotal

取引明細の、値引き前計の合計。明細より自動算出。
※管理画面の取引履歴CSVで対応する項目: 単価値引き前小計

string

unitDiscountsubtotal

単品値引き小計：取引明細の単品値引き計の合計と商品バンドル値引按分の合計を合算した値。

※ 取引明細区分が2:返品の取引明細のとき、単品値引き計及び商品バンドル値引按分は符号反転して計算されます。
（例: ある取引明細の取引明細区分が2、単品値引き計が50円、商品バンドル値引按分が12円の場合、単品値引き計は-50円、商品バンドル値引按分は-12円として計算されます。）
※ 以下の商品区分を持つ取引明細については、単品値引き計及び商品バンドル値引按分が0として計算されます。
4:バンドル (親)
5:セット売り(親)
6:簡易セット(親)
8:バンドル値引(子)
※ ウェイターから生成された仮販売取引では、本項目が0になります。

string

subtotal

取引明細の値引き後小計の合計。

string

subtotalForDiscount

取引明細の割引値引対象区分が対象の小計金額

string

subtotalDiscountPrice

小計の値引き金額を設定。

string

subtotalDiscountRate

小計の割引を設定（単位％）デフォルトは未設定。
設定された場合、小計値引は必須。
※小計値引率から小計値引は計算しないため小計値引に値引額を設定してください。

string

subtotalDiscountDivision

小計値引き/割引時に指定された区分を設定。
管理画面->設定->販売設定->値引区分/割引区分のページで確認できるID。

string

pointDiscount

使用ポイント * ポイント還元率。

string

total

小計 - 小計値引き - ポイント値引き + 端数値引額 + 外税額 - 免税額を設定
※ 端数値引き機能は現在ご利用いただけません。

string

taxInclude

内税商品計 / 110 * 10。
※税率が10%の場合
※小数点以下は税の丸め方式で指定の通り

string

taxExclude

外税商品計 * 10 / 100。
※税率が10%の場合
※小数点以下は税の丸め方式で指定の通り

string

roundingDivision

販売時の合計金額の端数を丸めるか否かを設定する。
00:なし
11:一の位を四捨五入 12:一の位を切捨 13:一の位を切上
21:十の位を四捨五入 22:十の位を切捨 23:十の位を切上
31:百の位を四捨五入 32:百の位を切捨 33:百の位を切上
41:千の位を四捨五入 42:千の位を切捨 43:千の位を切上
99:手入力

string

roundingPrice

端数値引額

string

amount

取引明細の返品以外の数量の合計（取引明細区分が2返品以外の数量）

string

returnAmount

取引明細の返品の数量の合計（取引明細区分が2返品の数量）

string

costTotal

明細の原価計の合計

string

newPoint

取引で付与されるポイント。合計 * ポイント付与率

string

spendPoint

取引で使用したポイント。

string

point

取引前のポイント。

string

totalPoint

取引後のポイント現在ポイント + 付与ポイント - 使用ポイント。

string

storeId

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

string

terminalId

店舗の端末毎に付与するID。
※存在しない端末IDも設定可能。(存在しない場合精算できないので、締め済みに設定する必要あり)

string

customerId

会員毎に付与するID。
※設定されている場合、会員販売とみなし会員ポイント情報を更新します。
※存在しない会員IDの場合、そのまま会員IDは登録されますが、会員ポイント情報等は更新しません。

string

terminalTranId

端末で設定された取引ID。

string

terminalTranDateTime

端末で設定された取引日時。[YYYY-MM-DDThh:mm:ssTZD]

string

customerGroupId

客層ID。客層セクションIDが1の客層IDを設定。

string

customerGroupId2

客層ID2。客層セクションIDが2の客層IDを設定。

string

customerGroupId3

客層ID3。客層セクションIDが3の客層IDを設定。

string

customerGroupId4

客層ID4。客層セクションIDが4の客層IDを設定。

string

customerGroupId5

客層ID5。客層セクションIDが5の客層IDを設定。

string

staffId

販売員ID（スタッフID）

string

staffName

AppAccessToken(pos.staffs:read)
販売員名（スタッフ名）

string

memo

入出金時のメモなどを設定。 1000文字以内。

string

receiptMemo

レシートに印字するメモを設定。100文字以内。

string

guestNumbers

客数。
※省略時、1を設定。

string

guestNumbersMale

客数（男）。

string

guestNumbersFemale

客数（女）。

string

guestNumbersUnknown

客数（不明）。

string

enterDateTime

入店日時。[YYYY-MM-DDThh:mm:ssTZD]

string

taxFreeSalesDivision

免税販売区分 (0:通常販売、1:免税販売(自動計算)、2:免税販売(強制免税適用)、3:免税販売(一般品のみ強制免税適用)、4:免税販売(消耗品のみ強制免税適用)、5:免税販売(自動計算・合算))
※未設定の場合、0:通常販売

string

netTaxFreeGeneralTaxInclude

内税商品の一般品免税額。

string

netTaxFreeGeneralTaxExclude

外税商品の一般品免税額。

string

netTaxFreeConsumableTaxInclude

内税商品の消耗品免税額。

string

netTaxFreeConsumableTaxExclude

外税商品の消耗品免税額。

string

tags

レジ端末よりクイックコマンドを押下した値を設定。和名を設定する。
※複数ある場合は、カンマ区切りで設定

string

mileageDivision

マイレージ機能を利用するか否か。 (0: 利用しない 1: 利用する 2: ポイントの代わりに貯める)
※未設定の場合は店舗マスタから設定。初期値:0。

string

mileageLabel

マイレージの名称。未設定の場合は「マイル」

string

returnSales

0:通常、1:返品販売

string

sellDivision

取引が外税販売、内税販売かを識別する区分。（0:内税販売、1:外税販売）
※省略時は0:内税販売を設定

string

taxRate

税率（単位％）
※省略時は、スマレジに設定されている消費税を設定（端末取引日時より算出）

string

taxRounding

税の丸めを判定。 0:四捨五入、1:切り捨て、2:切り上げ
※省略時はスマレジに設定されている税の丸め方式を設定

string

discountRoundingDivision

割引の端数を丸める方法を指定する区分。 0:四捨五入、1:切り捨て、2:切り上げ
※省略時はスマレジに設定されている税の丸め方式を設定

string

details

取引明細

Array<object>

object

transactionHeadId

仮販売取引ID

string

transactionDetailId

ユニーク値 取引毎の明細に付与するID。
設定する場合は1〜999まで。
取引明細を指定する場合必須。

string

parentTransactionDetailId

紐付く親の取引明細がある場合、その取引明細IDを設定。
※商品区分が、0（通常販売）, 4（バンドル(親)）の場合は設定できず、7（バンドル子）, 8（バンドル値引）の時は、バンドル(親)の取引明細IDを設定しなければならない。

string

transactionDetailDivision

取引明細を識別する区分。
（1:通常、2:返品、3:部門売り）

string

productId

商品ID

string

productCode

商品コード

string

productName

商品名

string

printReceiptProductName

レシート印字商品名

string

color

カラー

string

size

サイズ

string

groupCode

グループコード

string

taxDivision

税区分。(0:税込、1:税抜、2:非課税)
※設定時そのまま設定
※省略時、商品IDが設定されている場合、マスタから設定。以外は0:税込

string

price

※設定時そのまま設定
※省略時、商品IDが設定されている場合、マスタから設定。以外は0円

string

salesPrice

販売時の単価を設定。

string

unitDiscountPrice

販売単価の値引き金額を設定。
単品割引率が設定された場合、その割合から値引き金額を設定。（切捨て）。

string

unitDiscountRate

単品の割引率を設定。（単位:％）
※設定された場合、単品値引は必須

string

unitDiscountDivision

単品値引き/割引時に指定された割引区分を設定。

string

cost

商品原価。整数部分8桁、少数部5桁。

string

quantity

購入数
取引明細を指定する場合必須。

string

unitNonDiscountSum

販売価格×数量

string

unitDiscountSum

単品値引き×数量
※管理画面の取引履歴CSVで対応する項目: 単価値引き計

string

unitDiscountedSum

値引き前計 - 単品値引き計

string

costSum

原価×数量

string

categoryId

商品に紐付く部門毎に付与するID。数字9桁以内。
※部門情報が存在しない場合、エラー
※商品IDが設定されている場合、商品情報の部門IDと一致しないとエラー
※省略時、商品IDが設定されている場合、商品マスタの部門IDを設定

string

categoryName

商品に紐付く部門名。(85文字以内)
※設定時、そのまま設定。
※省略時、部門IDが設定されている場合、マスタから設定。以外はnull

string

salesDivision

売上計上するか否かの区分。（0:売上対象、1:売上対象外）
省略時、商品IDが設定されている場合、商品マスタから設定。以外は0:売上対象を設定

string

productDivision

商品区分 (0:通常、1:回数券、2:オプション商品、3:部門販売、4:バンドル (親)、5:セット売(親)、6:簡易セット(親)、7:バンドル商品(子)、8:バンドル値引(子)、A:プラン(子)、B:コース(子)) ※0, 4, 7, 8のみ許可。商品区分を0, 4にする場合、親取引明細IDは設定不可。また、商品区分を7, 8にする場合、親取引明細IDにバンドル(親)の取引明細ID の設定が必要 ※A,Bはウェイターでのみ利用する区分。

string

pointNotApplicable

ポイント対象にするか否かの設定（0:ポイント対象、1:ポイント対象外）
自動で設定します。商品IDが設定されている場合、商品マスタから設定。以外は0:ポイント対象を設定

string

calcDiscount

小計値引／割引(クーポン、ポイント値引き含む)の対象かどうかを設定。（0:対象外、1:対象）
※省略時、商品IDが設定されている場合、商品マスタから設定。その他の場合は1:対象を設定。
※スマレジ・アプリver.4.27.0以降で取引登録すると、取引明細区分が2:返品の取引明細は仮販売登録時の値引割引計算対象設定値に関わらず、0:対象外として再計算します。

string

taxFreeDivision

免税区分の設定。(0:対象外、1:一般品、2:消耗品)
省略時、商品区分が0:通常、2:オプション商品、7:バンドル商品(子)、8:バンドル値引(子)で商品IDが設定されている場合、商品マスタから設定。商品区分が4:バンドル (親)で商品バンドルグループIDが設定されている場合、商品バンドルグループマスタから設定。以外は0:対象外を設定

string

taxFreeCommodityPrice

免税後の税抜金額を設定。（税抜価格x数量）
※免税販売時に未設定だと、日報の表示がずれる事があるので注意してください。

string

taxFree

免税額を設定。（免税対象額 x 税率）
※免税販売時に未設定だと、日報の表示がずれる事があるので注意してください。

string

productBundleGroupId

商品バンドル販売の明細の場合、商品バンドルグループのIDを設定。
商品バンドルグループに存在するIDを指定しなければならない。
この項目を設定する明細の商品区分は「4:バンドル(親)」でなければならない

string

productStaffDiscountRate

社員販売時のみ設定商品の社販販売割引率

string

staffRank

社員販売時のみ設定社員ランクのコードを設定

string

staffRankName

社員販売時のみ設定社員ランクの名称を設定

string

staffDiscountRate

社員販売時のみ設定社員販売の割引率

string

staffDiscountDivision

社員販売時のみ設定１ビット目: 商品マスタの社員販売最大値引率を考慮（する or しない）２ビット目: セール価格と社員販売割引を掛け合わせて適用（する or しない）３ビット目: セール価格と社員販売価格を比較して安い方を適用（する or しない）４ビット目: セール価格と社員販売価格を比較して高い方を適用（する or しない）８ビット目: セール価格と社員販売価格の比較に商品マスタの社販OFF率を利用（する or しない）

string

applyStaffDiscountRate

セール販売時のみ設定適用した社員販売の割引率

string

applyStaffDiscountPrice

セール販売時のみ設定適用した社員販売の値引き額

string

bargainId

セール販売時のみ設定。適用したセールのID ※セール商品ID(bargainProductId)の値が設定されます。

string

bargainName

セール販売時のみ設定適用したセールの名称

string

bargainDivision

セール販売時のみ設定（1:割引、2:値引、3:価格指定）

string

bargainValue

セール販売時のみ設定割引、値引、価格指定の値

string

applyBargainValue

セール販売時のみ設定適用したセール販売の割引、値引き、価格指定の値

string

applyBargainDiscountPrice

セール販売時のみ設定適用したセール販売の値引き額

string

taxRate

適用した税率
軽減税率IDがある場合、軽減税率マスタの税率を設定。以外は、取引ヘッダの税率を設定

string

standardTaxRate

標準税率
取引ヘッダの税率を設定

string

modifiedTaxRate

修正した税率（設定不可）

string

reduceTaxId

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

string

reduceTaxName

軽減税率IDがある場合、軽減税率マスタの軽減税率名を設定。

string

reduceTaxRate

軽減税率IDがある場合、軽減税率マスタの軽減税率を設定。

string

reduceTaxPrice

商品IDがある場合、商品マスタの軽減税率用商品単価を設定。

string

reduceTaxMemberPrice

商品IDがある場合、商品マスタの軽減税率用会員商品単価を設定。

string

memo

返品販売時などのメモなどを設定。 1000文字以内。

string

productAttributes

取引時の商品属性情報

Array<object>

object

transactionHeadId

取引ID

string

transactionDetailId

取引明細ID

string

code

コード：数字9桁以内。

string

name

名称：30文字以内

string

Example

{
  "transactionHeadId": "string",
  "transactionDateTime": "string",
  "transactionHeadDivision": "string",
  "cancelDivision": "string",
  "status": "string",
  "barcode": "string",
  "sequentialNumber": "string",
  "preRegistrationName": "string",
  "unitNonDiscountsubtotal": "string",
  "unitDiscountsubtotal": "string",
  "subtotal": "string",
  "subtotalForDiscount": "string",
  "subtotalDiscountPrice": "string",
  "subtotalDiscountRate": "string",
  "subtotalDiscountDivision": "string",
  "pointDiscount": "string",
  "total": "string",
  "taxInclude": "string",
  "taxExclude": "string",
  "roundingDivision": "string",
  "roundingPrice": "string",
  "amount": "string",
  "returnAmount": "string",
  "costTotal": "string",
  "newPoint": "string",
  "spendPoint": "string",
  "point": "string",
  "totalPoint": "string",
  "storeId": "string",
  "terminalId": "string",
  "customerId": "string",
  "terminalTranId": "string",
  "terminalTranDateTime": "string",
  "customerGroupId": "string",
  "customerGroupId2": "string",
  "customerGroupId3": "string",
  "customerGroupId4": "string",
  "customerGroupId5": "string",
  "staffId": "string",
  "staffName": "string",
  "memo": "string",
  "receiptMemo": "string",
  "guestNumbers": "string",
  "guestNumbersMale": "string",
  "guestNumbersFemale": "string",
  "guestNumbersUnknown": "string",
  "enterDateTime": "string",
  "taxFreeSalesDivision": "string",
  "netTaxFreeGeneralTaxInclude": "string",
  "netTaxFreeGeneralTaxExclude": "string",
  "netTaxFreeConsumableTaxInclude": "string",
  "netTaxFreeConsumableTaxExclude": "string",
  "tags": "string",
  "mileageDivision": "string",
  "mileageLabel": "string",
  "returnSales": "string",
  "sellDivision": "string",
  "taxRate": "string",
  "taxRounding": "string",
  "discountRoundingDivision": "string",
  "details": [
    {
      "transactionHeadId": "string",
      "transactionDetailId": "string",
      "parentTransactionDetailId": "string",
      "transactionDetailDivision": "string",
      "productId": "string",
      "productCode": "string",
      "productName": "string",
      "printReceiptProductName": "string",
      "color": "string",
      "size": "string",
      "groupCode": "string",
      "taxDivision": "string",
      "price": "string",
      "salesPrice": "string",
      "unitDiscountPrice": "string",
      "unitDiscountRate": "string",
      "unitDiscountDivision": "string",
      "cost": "string",
      "quantity": "string",
      "unitNonDiscountSum": "string",
      "unitDiscountSum": "string",
      "unitDiscountedSum": "string",
      "costSum": "string",
      "categoryId": "string",
      "categoryName": "string",
      "salesDivision": "string",
      "productDivision": "string",
      "pointNotApplicable": "string",
      "calcDiscount": "string",
      "taxFreeDivision": "string",
      "taxFreeCommodityPrice": "string",
      "taxFree": "string",
      "productBundleGroupId": "string",
      "productStaffDiscountRate": "string",
      "staffRank": "string",
      "staffRankName": "string",
      "staffDiscountRate": "string",
      "staffDiscountDivision": "string",
      "applyStaffDiscountRate": "string",
      "applyStaffDiscountPrice": "string",
      "bargainId": "string",
      "bargainName": "string",
      "bargainDivision": "string",
      "bargainValue": "string",
      "applyBargainValue": "string",
      "applyBargainDiscountPrice": "string",
      "taxRate": "string",
      "standardTaxRate": "string",
      "modifiedTaxRate": "string",
      "reduceTaxId": "10000001",
      "reduceTaxName": "string",
      "reduceTaxRate": "string",
      "reduceTaxPrice": "string",
      "reduceTaxMemberPrice": "string",
      "memo": "string",
      "productAttributes": [
        {
          "transactionHeadId": "string",
          "transactionDetailId": "string",
          "code": "string",
          "name": "string"
        }
      ]
    }
  ]
}

400

小計割引率が設定されており、小計値引きが未指定の場合
存在しない店舗IDを指定した場合
店舗が倉庫の店舗IDを指定した場合
店舗が休止中の店舗IDを指定した場合
会員コードを設定し、会員IDが未設定の場合
現在の会員マスタの会員コードと、リクエストの会員コードが異なる場合
客層IDが指定した客層セクションに存在しない場合
存在しない販売員IDを指定した場合
客数と客数（男）、客数（女）、客数（不明）の合計が一致しない場合
1取引タグが64文字を超える場合
取引明細が存在しない場合
取引明細IDが明細間で重複した場合
同じ取引の明細に存在しない親取引明細IDを指定した場合
商品IDで指定された商品の持つ商品区分が回数券である場合
商品区分が 0:通常／4:バンドル販売（親）であり、親取引明細IDを指定した場合
商品区分が 2:オプション商品／7:バンドル商品(子)／8:バンドル値引(子)で親取引明細IDが未指定の場合
商品区分が 2:オプション商品であるが、商品IDで指定された商品の持つ商品区分が 2:オプション商品でない場合
商品区分が 2:オプション商品の明細で、販売数が親取引明細における販売数の整数倍でない場合
商品区分が 2:オプション商品である取引明細とその親取引明細に対して、存在する商品IDがともに設定されており、かつ前者の商品が後者の商品に対して付与可能なオプショングループに所属していない場合
商品区分が 4:バンドル販売（親）の明細以外で商品バンドルグループを指定した場合
商品区分が 0:通常販売／4:バンドル(親) の場合に親取引明細IDを指定した場合
商品区分が 4:バンドル(親) の場合で、同じ取引の明細に 7:バンドル子／8:バンドル値引かつ親取引明細IDが親自身であるものが存在しない場合
商品区分が 7:バンドル子／8:バンドル値引で、親取引IDにバンドル(親)の取引明細IDが設定されていない場合
商品バンドルグループIDを設定し、商品区分が 4:バンドル(親) でない場合
単品割引率を設定し、単品値引が未設定の場合
現在の商品マスタの部門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
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "存在しない店舗IDです。",
  "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": "会員コードを指定した場合、会員IDは必須です。",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "会員コードは、会員マスタで会員に設定された会員コードと同じである必要があります。(会員コード-{会員コード}:会員マスタ-会員コード-{会員コード})",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "客層セクションIDが1（2,3,4,5）のセクションに存在しない客層IDです。",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "存在しない販売担当者IDです。",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "客数と客数（男）、客数（女）、客数（不明）の合計が一致しません。",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "1つの取引タグは64文字以下である必要があります",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "仮販売の場合、取引明細は必須です。",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "同一の取引明細IDが複数明細に対して設定されています。(取引明細ID-{取引明細ID})",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "同じ取引の明細に存在しない親取引明細IDです。(親取引明細ID-{親取引明細ID})",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "商品IDで指定された商品の持つ商品区分が 1:回数券 の明細は登録できません。(商品ID-{取引明細の商品ID})",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "商品区分が 0:通常／4:バンドル販売（親）のときは、親取引明細IDは指定できません。(商品区分-{商品区分}, 親取引明細ID-{親取引明細ID})",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "商品区分が 4:バンドル(親) のときは、商品区分が 7:バンドル子／8:バンドル値引 である子明細が必要です。(親取引明細ID-{親取引明細ID})",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "商品区分が2:オプション商品／7:バンドル商品(子)／8:バンドル値引(子)のときは、親取引明細IDは必須です。(商品区分-{商品区分}, 親取引明細ID-{親取引明細ID})",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "商品区分 2:オプション商品 は、商品IDで指定された商品の持つ商品区分が 2:オプション商品 の明細のみ可能です。ID-{商品ID})",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "オプション商品である明細の購入数は、親明細の購入数の整数倍である必要があります。(取引明細ID-{取引明細ID}})",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "商品区分が 2:オプション商品 の取引明細の商品IDで指定された商品は、親取引明細の商品IDで指定された商品に対して付与可能なオプショングループに所属している必要があります。(商品ID-{商品ID}:親取引明細商品ID-{親取引明細商品ID})"
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "商品バンドルグループの指定は、商品区分が 4:バンドル販売（親）の明細のみ可能です。",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "商品区分が 0:通常／4:バンドル販売（親）のときは、親取引明細IDは指定できません。",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "商品区分が 7:バンドル商品(子)／8:バンドル値引(子)のときは、親取引明細IDは商品区分が 4:バンドル(親) の明細のみ指定可能です。",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "商品バンドルグループIDの指定は、商品区分が 4:バンドル販売（親）の明細のみ可能です",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "単品割引率を設定した場合、単品値引は必須です。",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "取引明細で商品に設定する部門は、商品マスタで商品に設定された部門と同じである必要があります。(取引明細-部門ID-{部門ID}, 商品マスタ-部門ID-{部門ID})",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "存在しない商品コードが指定されています。(商品コード-{商品コード}})",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "存在しない部門IDが指定されています。(部門ID-{部門ID}})",
  "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": "同一バーコードの仮販売取引データが存在する為、仮販売取引データを作成できません。",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "同一キーの仮販売取引データが存在する為、仮販売取引データを作成できません。",
  "status": 400
}

仮販売登録

対象プラン

Authorizations

Request Body

Example

Responses

200

Example

400

Examples