回数券使用

Authorizations

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

Request Body^required

object

storeId

required

店舗ID

店舗毎に付与するID。

※店舗情報が存在しない場合エラー

※休止中の店舗IDを指定するとエラー

string

>= 1 characters <= 9 characters

terminalId

required

端末ID

店舗の端末毎に付与するID。半角数字9桁以内。

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

string

/^[1-9][0-9]{0,8}$/

customerId

required

会員ID

会員毎に付与するID。

使用する回数券を購入した会員の会員IDを設定してください。

string

>= 1 characters <= 10 characters

customerCode

会員コード

会員毎に付与する一意のコード。半角英数記号スペース20文字以内。

※会員マスタに存在する会員IDが設定されている場合、会員情報の会員コードと一致しないとエラー。

※省略時、会員IDが設定されている場合、会員マスタの会員コードを設定。

string

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

terminalTranId

required

端末取引ID

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

string

>= 1 characters <= 10 characters

terminalTranDateTime

required

端末取引日時

端末で設定された取引日時。（連携元システムで処理日時を設定してください）

string format: date-time

sumDivision

締め区分

締め処理を実施したかの区分。

0: 未処理
1: 精算処理済み
2: 締め処理済み

※省略時は、店舗情報の締め方式区分に合わせて設定します。

※0:未処理または1:精算処理済みは、店舗の締め方式区分が0:手動締め処理のときのみ設定可能。

※存在しない端末IDを設定した場合、2:締め処理済みを設定してください。

string

Allowed values: 0 1 2

sumDate

締め日

締めをしたら年月日が入る。

※締め区分を2:締め処理済みに設定した場合必須。締め区分を0:未処理に設定した場合設定不可。

string format: date

customerRank

会員ランク

管理画面の[設定]→[会員設定]→[会員ランク]で設定したコードを設定してください。

存在しないコードを設定するとエラーになります。

string

>= 1 characters <= 20 characters

customerGroupId

客層ID

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

※客層情報が存在しない場合エラー

string

>= 1 characters <= 9 characters

customerGroupId2

客層ID2

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

※客層情報が存在しない場合エラー

string

>= 1 characters <= 9 characters

customerGroupId3

客層ID3

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

※客層情報が存在しない場合エラー

string

>= 1 characters <= 9 characters

customerGroupId4

客層ID4

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

※客層情報が存在しない場合エラー

string

>= 1 characters <= 9 characters

customerGroupId5

客層ID5

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

※客層情報が存在しない場合エラー

string

>= 1 characters <= 9 characters

staffId

販売員ID

販売員ID（スタッフID）。

※スタッフ情報が存在しない場合エラー

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

string

>= 1 characters <= 10 characters

memo

メモ

入出金時のメモなどを設定。

string

>= 1 characters <= 1000 characters

receiptMemo

レシートメモ

レシートに印字するメモを設定。

string

>= 1 characters <= 1000 characters

guestNumbers

客数

客数。

integer

<= 9999

guestNumbersMale

客数（男）

客数（男）。

integer

<= 9999

guestNumbersFemale

客数（女）

客数（女）。

integer

<= 9999

guestNumbersUnknown

客数（不明）

客数（不明）。

integer

<= 9999

enterDateTime

入店日時

入店日時。

string format: date-time

tags

取引タグ

レジ端末よりクイックコマンドを押下した値を設定。和名を設定する。

※1取引タグは最大64文字。複数ある場合は、カンマ区切りで設定。

string

>= 1 characters <= 255 characters

transactionUuid

レシート番号

レシートに印字する番号。ユニークな値を設定してください。

※レシート番号が重複するとスマレジ・アプリにて取引データの呼び出しができなくなる可能性があります

※省略時は、1970年から計算した現在秒の末尾9桁＋端末IDゼロ詰め4桁

string

>= 1 characters <= 20 characters

exchangeTicketNo

引換券番号

引換券番号。

string

>= 1 characters <= 20 characters

Any of:

object
object

object

products

required

回数券対象商品情報

回数券を消費して引き換える対象商品情報。

※回数券対象商品と回数券対象オプション商品の少なくとも一方を指定してください。

Array

object

transactionProductSetId

回数券購入取引ID

回数券購入取引毎に付与するID。

string

>= 1 characters <= 12 characters

transactionProductSetItemId

回数券購入取引明細ID

回数券購入取引明細毎に付与するID。

string

>= 1 characters <= 12 characters

quantity

数量

数量。

integer

>= 1 <= 999

discriminationNo

識別番号

明細行を識別できる番号。

string

>= 1 characters <= 20 characters

Example

{
  "storeId": "string",
  "terminalId": "string",
  "customerId": "string",
  "customerCode": "string",
  "terminalTranId": "string",
  "terminalTranDateTime": "2000-01-23T01:23:45+09:00",
  "sumDivision": "0",
  "sumDate": "2000-01-23",
  "customerRank": "string",
  "customerGroupId": "string",
  "customerGroupId2": "string",
  "customerGroupId3": "string",
  "customerGroupId4": "string",
  "customerGroupId5": "string",
  "staffId": "string",
  "memo": "string",
  "receiptMemo": "string",
  "guestNumbers": 1234,
  "guestNumbersMale": 1234,
  "guestNumbersFemale": 1234,
  "guestNumbersUnknown": 1234,
  "enterDateTime": "2000-01-23T01:23:45+09:00",
  "tags": "string",
  "transactionUuid": "string",
  "exchangeTicketNo": "string",
  "products": [
    {
      "transactionProductSetId": "string",
      "transactionProductSetItemId": "string",
      "quantity": 123,
      "discriminationNo": "string"
    }
  ]
}

200

登録成功

object

transactionHeadId

取引ID

取引ID。

string

>= 1 characters <= 12 characters

transactionDateTime

取引日時

取引日時。サーバーに送信された日時。販売日時は端末取引日時を参照。

string format: date-time

transactionHeadDivision

取引区分

取引を識別する区分。

9: 回数券

※回数券使用では常に9:回数券を返します。

string

Allowed values: 9

cancelDivision

取消区分

取引の取消を識別する区分。

0: 通常

※回数券使用では常に0:通常を返します。

string

Allowed values: 0

unitNonDiscountsubtotal

単品値引き前小計

取引明細の、値引き前計の合計。

※回数券使用では常に0を返します。

integer

Allowed values: 0

unitDiscountsubtotal

単品値引き小計

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

※回数券使用では常に0を返します。

integer

Allowed values: 0

unitStaffDiscountsubtotal

単品社員販売値引き計

単品社員販売値引き計。

※回数券使用では常に0を返します。

integer

Allowed values: 0

unitBargainDiscountsubtotal

単品セール販売値引き計

単品セール販売値引き計。

※回数券使用では常に0を返します。

integer

Allowed values: 0

subtotal

小計

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

※回数券使用では常に0を返します。

integer

Allowed values: 0

subtotalForDiscount

値引対象小計

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

※回数券使用では常に0を返します。

integer

Allowed values: 0

subtotalDiscountPrice

小計値引き

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

※回数券使用では常に0を返します。

integer

Allowed values: 0

subtotalDiscountRate

小計割引率

小計の割引。

※回数券使用では常に0.00を返します。

string

Allowed values: 0.00

subtotalDiscountDivision

小計値引き/割引区分

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

※回数券使用では常にnullを返します。

string

nullable

pointDiscount

ポイント値引き

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

※回数券使用では常に0を返します。

integer

Allowed values: 0

couponDiscount

クーポン値引き

クーポン値引き：その取引で使用された各クーポンの値引き・割引額の合計値。

※回数券使用では常に0を返します。

integer

Allowed values: 0

total

合計

合計。

※回数券使用では常に0を返します。

integer

Allowed values: 0

taxInclude

内税額

内税額。

※回数券使用では常に0を返します。

integer

Allowed values: 0

taxExclude

外税額

外税額。

※回数券使用では常に0を返します。

integer

Allowed values: 0

roundingDivision

端数値引区分

販売時の合計金額の端数を丸めるか否かを設定する。

00: なし

※回数券使用では常に00:なしを返します。

string

Allowed values: 00

roundingPrice

端数値引額

端数値引額。

※回数券使用では常に0を返します。

integer

Allowed values: 0

cashTotal

内現金支払金額

合計金額の内訳（現金払い）。

※回数券使用では常に0を返します。

integer

Allowed values: 0

creditTotal

内クレジット支払金額

合計金額の内訳（クレジット払い）。

※回数券使用では常に0を返します。

integer

Allowed values: 0

deposit

預かり金

会計時に預かった金額。

※回数券使用では常に0を返します。

integer

Allowed values: 0

depositCash

預かり金現金

会計時に預かった現金金額。

※回数券使用では常に0を返します。

integer

Allowed values: 0

depositCredit

預かり金クレジット

会計時に預かったクレジット金額。

※回数券使用では常に0を返します。

integer

Allowed values: 0

change

釣銭

釣銭。

※回数券使用では常に0を返します。

integer

Allowed values: 0

tipCash

現金チップ

現金チップ。

※回数券使用では常にnullを返します。

integer

nullable

tipCredit

クレジットチップ

クレジットチップ。

※回数券使用では常にnullを返します。

integer

nullable

amount

数量合計

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

integer

>= 1 <= 999999

returnAmount

返品数量合計

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

※回数券使用では常に0を返します。

integer

Allowed values: 0

costTotal

原価合計

明細の原価計の合計。（-99999999.99999 〜 99999999.99999）

string

/^(?!-0\.0{5}$)-?(?:0|[1-9][0-9]{0,7})\.[0-9]{5}$/

salesHeadDivision

売上ヘッダ区分

売上明細に売上対象外商品を含むか否かの区分。

0: 売上対象のみ
1: 売上対象外含む

string

Allowed values: 0 1

inTaxSalesTotal

内税対象額

売上対象商品の内税販売合計金額。

※回数券使用では常に0を返します。

integer

Allowed values: 0

outTaxSalesTotal

外税対象額

売上対象商品の外税販売の税抜き商品合計金額。

※回数券使用では常に0を返します。

integer

Allowed values: 0

nonTaxSalesTotal

非課税対象額

売上対象商品の非課税商品の合計金額。

※回数券使用では常に0を返します。

integer

Allowed values: 0

nonSalesTargetTotal

売上対象外合計

売上対象外商品の合計。

※回数券使用では常に0を返します。

integer

Allowed values: 0

nonSalesTargetInTaxTotal

売上対象外内税合計

売上対象外商品の内税合計。

※回数券使用では常に0を返します。

integer

Allowed values: 0

nonSalesTargetOutTaxTotal

売上対象外外税合計

売上対象外商品の外税合計。

※回数券使用では常に0を返します。

integer

Allowed values: 0

nonSalesTargetTaxFreeTotal

売上対象外免税額合計

売上対象外商品の免税額合計。

※回数券使用では常に0を返します。

integer

Allowed values: 0

nonSalesTargetCostTotal

売上対象外原価合計

売上対象外商品の原価合計。（-99999999.99999 〜 99999999.99999）

string

/^(?!-0\.0{5}$)-?(?:0|[1-9][0-9]{0,7})\.[0-9]{5}$/

nonSalesTargetAmount

売上対象外数量合計

取引明細の返品以外かつ売上対象外の数量の合計。（取引明細区分が2:返品以外の数量）

integer

<= 999999

nonSalesTargetReturnAmount

売上対象外返品数量合計

取引明細の返品かつ売上対象外の数量の合計。（取引明細区分が2:返品の数量）

※回数券使用では常に0を返します。

integer

Allowed values: 0

newPoint

付与ポイント

取引で付与されるポイント。

※回数券使用では常に0を返します。

integer

Allowed values: 0

spendPoint

使用ポイント

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

※回数券使用では常に0を返します。

integer

Allowed values: 0

point

現在ポイント

取引前のポイント。

integer

>= -999999999 <= 999999999

totalPoint

合計ポイント

取引後のポイント。

integer

>= -999999999 <= 999999999

currentMile

現在マイル

現在マイル。取引前のマイル。

integer

>= -999999999 <= 999999999

earnMile

獲得マイル

獲得マイル。取引で付与されるマイル。

※回数券使用では常に0を返します。

integer

Allowed values: 0

totalMile

合計マイル

合計マイル。取引後のマイル。

integer

>= -999999999 <= 999999999

adjustmentMile

調整マイル

調整マイル。取引で手動で付与されるマイル。

※回数券使用では常に0を返します。

integer

Allowed values: 0

adjustmentMileDivision

調整マイル区分

調整マイル区分。

※回数券使用では常にnullを返します。

string

nullable

adjustmentMileValue

調整マイル区分値

調整マイル区分値。

※回数券使用では常にnullを返します。

integer

nullable

storeId

店舗ID

店舗毎に付与するID。

string

>= 1 characters <= 9 characters

terminalId

端末ID

店舗の端末毎に付与するID。

string

/^[1-9][0-9]{0,8}$/

customerId

会員ID

会員毎に付与するID。

string

>= 1 characters <= 10 characters

terminalTranId

端末取引ID

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

string

>= 1 characters <= 10 characters

terminalTranDateTime

端末取引日時

端末で設定された取引日時。

string format: date-time

sumDivision

締め区分

締め処理を実施したかの区分。

0: 未処理
1: 精算処理済み
2: 締め処理済み

string

Allowed values: 0 1 2

adjustmentDateTime

精算日時

精算をしたら日時が入る。

string format: date-time

nullable

sumDate

締め日

締めをしたら年月日が入る。

string format: date

nullable

customerRank

会員ランク

会員ランク。

string

nullable >= 1 characters <= 20 characters

customerGroupId

客層ID

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

string

nullable >= 1 characters <= 9 characters

customerGroupId2

客層ID2

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

string

nullable >= 1 characters <= 9 characters

customerGroupId3

客層ID3

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

string

nullable >= 1 characters <= 9 characters

customerGroupId4

客層ID4

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

string

nullable >= 1 characters <= 9 characters

customerGroupId5

客層ID5

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

string

nullable >= 1 characters <= 9 characters

staffId

販売員ID

販売員ID（スタッフID）

string

nullable >= 1 characters <= 10 characters

staffName

販売員名

スタッフIDがある場合、スタッフマスタのスタッフ名（販売員名）を設定。

string

nullable >= 1 characters <= 50 characters

creditDivision

クレジット区分

クレジット区分：クレジット会社を識別する区分。

※回数券使用では常にnullを返します。

string

nullable

paymentCount

支払回数

クレジットの支払回数。

※回数券使用では常にnullを返します。

string

nullable

slipNumber

伝票番号

クレジットの伝票番号。

※回数券使用では常にnullを返します。

string

nullable

cancelSlipNumber

取消伝票番号

クレジットの取消伝票番号。

※回数券使用では常にnullを返します。

string

nullable

authNumber

承認番号

クレジットの承認番号。

※回数券使用では常にnullを返します。

string

nullable

authDate

センター処理日

クレジットのセンター処理日。

※回数券使用では常にnullを返します。

string

nullable

cardCompany

取扱カード会社

クレジットカード会社。

※回数券使用では常にnullを返します。

string

nullable

denomination

金種

支払金種。

※回数券使用では常にnullを返します。

string

nullable

memo

メモ

入出金時のメモなどを設定。

string

nullable >= 1 characters <= 1000 characters

receiptMemo

レシートメモ

レシートに印字するメモを設定。

string

nullable >= 1 characters <= 1000 characters

carriage

送料

EC連携用送料。

※回数券使用では常にnullを返します。

integer

nullable

commission

手数料

EC連携用手数料。

※回数券使用では常にnullを返します。

integer

nullable

guestNumbers

客数

客数。

integer

<= 9999

guestNumbersMale

客数（男）

客数（男）。

integer

nullable <= 9999

guestNumbersFemale

客数（女）

客数（女）。

integer

nullable <= 9999

guestNumbersUnknown

客数（不明）

客数（不明）。

integer

nullable <= 9999

enterDateTime

入店日時

入店日時。

string format: date-time

taxFreeSalesDivision

免税販売区分

免税販売区分。

0:通常販売

※回数券使用では常に0:通常販売を返します。

string

Allowed values: 0

netTaxFreeGeneralTaxInclude

内税商品の一般品免税額

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

※回数券使用では常に0を返します。

integer

Allowed values: 0

netTaxFreeGeneralTaxExclude

外税商品の一般品免税額

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

※回数券使用では常に0を返します。

integer

Allowed values: 0

netTaxFreeConsumableTaxInclude

内税商品の消耗品免税額

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

※回数券使用では常に0を返します。

integer

Allowed values: 0

netTaxFreeConsumableTaxExclude

外税商品の消耗品免税額

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

※回数券使用では常に0を返します。

integer

Allowed values: 0

tags

取引タグ

レジ端末よりクイックコマンドを押下した値を設定。和名を設定する。

※複数ある場合は、カンマ区切りで設定

string

nullable >= 1 characters <= 255 characters

pointGivingDivision

ポイント付与区分

ポイント付与区分。

1: 税額を含める + 利用ポイント分を含める
2: 税額を含めない + 利用ポイント分を含める
3: 税額を含める + 利用ポイント分を含めない
4: 税額を含めない + 利用ポイント分を含めない

※店舗マスタから設定。

string

Allowed values: 1 2 3 4

pointGivingUnitPrice

ポイント付与単位(金額)

ポイント付与の設定 n円をnポイントの「n円」の部分。

※店舗マスタから設定。

integer

>= 1 <= 99999

pointGivingUnit

ポイント付与単位(ポイント)

ポイント付与の設定 n円をnポイントの「nポイント」の部分。（0.00 〜 99999.99）

※店舗マスタから設定。

string

/^(?:0|[1-9][0-9]{0,4})\.[0-9]{2}$/

pointSpendDivision

ポイント利用区分

ポイント利用時の税を含む／含まないを判定。

1: ポイント利用を現金として扱う (税を含む値引き)
2: ポイント利用を値引として扱う (税を含まない値引き)

※店舗マスタから設定。

string

Allowed values: 1 2

mileageDivision

マイレージ利用区分

マイレージ機能を利用するか否か。

0: 利用しない
1: 利用する
2: ポイントの代わりに貯める

※店舗マスタから設定。

string

Allowed values: 0 1 2

mileageLabel

マイレージ名称

マイレージの名称。

※回数券使用では常にデフォルトの「マイル」を返します。

string

Allowed values: マイル

customerPinCode

PINコード

PINコードなど会員を識別する任意の文字列。

※会員マスタから設定。

string

nullable >= 1 characters <= 32 characters

returnSales

返品取引区分

返品販売区分。

0: 通常

※回数券使用では常に0:通常を返します。

string

Allowed values: 0

disposeDivision

打消区分

打消区分。

0: 通常

※回数券使用では常に0:通常を返します。

string

Allowed values: 0

disposeServerTransactionHeadId

打消元取引ID

打消元取引ID。

※回数券使用では常に0を返します。

string

Allowed values: 0

cancelDateTime

取消日時

取消／打消しの場合自動設定。

※回数券使用では常にnullを返します。

string

nullable

sellDivision

販売区分

取引が外税販売、内税販売かを識別する区分。

0: 内税販売

※回数券使用では常に0:内税販売を返します。

string

Allowed values: 0 1

taxRate

税率

税率。（単位％）（0.000 〜 100.000）

※スマレジに設定されている消費税を設定（端末取引日時より算出）

string

/^(?:100\.000|(?:[0-9]|[1-9][0-9])\.[0-9]{3})$/

taxRounding

税の丸め方式

税の丸めを判定。

0: 四捨五入
1: 切り捨て
2: 切り上げ

※スマレジに設定されている税の丸め方式を設定。

string

Allowed values: 0 1 2

discountRoundingDivision

割引丸め区分

割引の端数を丸める方法を指定する区分。

0: 四捨五入
1: 切り捨て
2: 切り上げ

※スマレジに設定されている税の丸め方式を設定。

string

Allowed values: 0 1 2

transactionUuid

レシート番号

レシートに印字する番号。

※省略時は、1970年から計算した現在秒の末尾9桁＋端末IDゼロ詰め4桁

string

>= 1 characters <= 20 characters

exchangeTicketNo

引換券番号

引換券番号。

string

nullable >= 1 characters <= 20 characters

giftReceiptValidDays

ギフトレシート有効日数

有効日数が経過しても、ギフトレシートの引換ができなくなるわけではありません。

※回数券使用では常にnullを返します。

integer

nullable

discountCalculateDivision

割引額計算対象

小計に対する値引または割引の上にさらに割引を行う際の、割引額の算出方法を指定する区分。

0: 小計（明細から算出された、値引・割引前の小計を一律対象に割引率を乗算したものを割引額とします。）

※回数券使用では常に0:小計を返します。

string

Allowed values: 0

barcode

バーコード

仮販売のバーコード。

※回数券使用では常にnullを返します。

string

nullable

updDateTime

更新日時

登録時・更新時の日時。

string format: date-time

details

取引明細

取引明細

Array<object>

object

transactionHeadId

取引ID

取引ID。

string

>= 1 characters <= 12 characters

transactionDetailId

取引明細ID

取引明細ID。

string

>= 1 characters <= 3 characters

parentTransactionDetailId

親取引明細ID

親取引明細ID。

※回数券使用では常にnullを返します。

string

nullable

transactionDetailDivision

取引明細区分

取引明細を識別する区分。

1: 通常

※回数券使用では常に1:通常を返します。

string

Allowed values: 1

productId

商品ID

商品ID。

string

>= 1 characters <= 15 characters

productCode

商品コード

商品コード。

※商品マスタから設定。

string

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

productName

商品名

商品名。

※商品マスタから設定。

string

>= 1 characters <= 85 characters

printReceiptProductName

レシート印字商品名

レシート印字商品名。

※商品マスタから設定。

string

nullable >= 1 characters <= 64 characters

color

カラー

カラー。

※商品マスタから設定。

string

nullable >= 1 characters <= 85 characters

size

サイズ

サイズ。

※商品マスタから設定。

string

nullable >= 1 characters <= 85 characters

groupCode

グループコード

グループコード。

※商品マスタから設定。

string

nullable >= 1 characters <= 85 characters

supplierProductNo

品番

品番。

※商品マスタから設定。

string

nullable >= 1 characters <= 85 characters

taxDivision

税区分

税区分。

0: 税込
1: 税抜
2: 非課税

※商品マスタから設定。

string

Allowed values: 0 1 2

price

商品単価

商品単価。

※商品マスタから設定。

integer

>= -999999999 <= 999999999

salesPrice

販売単価

販売単価。

※回数券使用では常に0を返します。

integer

Allowed values: 0

unitDiscountPrice

単品値引

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

※回数券使用では常に0を返します。

integer

Allowed values: 0

unitDiscountRate

単品割引

単品の割引率を設定。（単位:％）

※回数券使用では常にnullを返します。

string

nullable

unitDiscountDivision

単品値引き/割引区分

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

※回数券使用では常にnullを返します。

string

nullable

cost

原価

商品原価。（-99999999.99999 〜 99999999.99999）

※商品マスタから設定。

string

nullable /^(?!-0\.0{5}$)-?(?:0|[1-9][0-9]{0,7})\.[0-9]{5}$/

quantity

数量

購入数。

integer

>= 1 <= 999

unitNonDiscountSum

値引き前計

販売価格×数量。

※回数券使用では常に0を返します。

integer

Allowed values: 0

unitDiscountSum

単品値引き計

単品値引き×数量。

※回数券使用では常に0を返します。

integer

Allowed values: 0

unitDiscountedSum

値引き後計

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

※回数券使用では常に0を返します。

integer

Allowed values: 0

costSum

原価計

原価計。（-99999999.99999 〜 99999999.99999）

string

/^(?!-0\.0{5}$)-?(?:0|[1-9][0-9]{0,7})\.[0-9]{5}$/

categoryId

部門ID

商品に紐付く部門毎に付与するID。

※商品マスタから設定。

string

>= 1 characters <= 9 characters

categoryName

部門名

商品に紐付く部門名。

※部門マスタから設定。

string

>= 1 characters <= 85 characters

discriminationNo

識別番号

明細行を識別できる番号。

string

nullable >= 1 characters <= 20 characters

salesDivision

売上区分

売上計上するか否かの区分。

0: 売上対象
1: 売上対象外

※商品マスタから設定。

string

Allowed values: 0 1

productDivision

商品区分

商品区分。

0: 通常
1: 回数券
2: オプション商品
3: 部門販売
4: バンドル売り(親)
5: セット売り(親)
6: 簡易バンドル販売(親)
7: バンドル商品(子)
8: バンドル値引(子)
A: プラン(子)
B: コース(子)

※ A:プラン(子), B:コース(子)はウェイターから登録された取引でのみ設定される。

※商品マスタから設定。

string

Allowed values: 0 1 2 3 4 5 6 7 8 A B

inventoryReservationDivision

在庫引当区分

在庫引当商品か否かの区分。

0: 通常商品
1: 在庫引当商品

※商品マスタから設定。

string

Allowed values: 0 1

pointNotApplicable

ポイント対象

ポイント対象にするか否かの設定。

0: ポイント対象
1: ポイント対象外

※商品マスタから設定。

string

Allowed values: 0 1

calcDiscount

値引割引計算対象

小計値引／割引(クーポン、ポイント値引き含む)の対象かどうかを設定。

0: 対象外
1: 対象

※商品マスタから設定。

string

Allowed values: 0 1

taxFreeDivision

免税区分

免税区分の設定。

0: 対象外
1: 一般品
2: 消耗品

※商品マスタから設定。

string

Allowed values: 0 1 2

taxFreeCommodityPrice

免税対象額

免税後の税抜金額を設定。

※回数券使用では常に0を返します。

integer

Allowed values: 0

taxFree

免税額

免税額を設定。

※回数券使用では常に0を返します。

integer

Allowed values: 0

productBundleGroupId

商品バンドルグループID

商品バンドルグループのID。

※回数券使用では常にnullを返します。

string

nullable

discountPriceProportional

小計値引き按分

端数処理は銀行丸め。誤差は最終行で調整。

※回数券使用では常に0を返します。

integer

Allowed values: 0

discountPointProportional

ポイント値引き按分

ポイント値引き按分。

※回数券使用では常に0を返します。

integer

Allowed values: 0

discountCouponProportional

クーポン値引き按分

クーポン値引き按分。

※回数券使用では常に0を返します。

integer

Allowed values: 0

taxIncludeProportional

内税按分

内税按分。

※回数券使用では常に0を返します。

integer

Allowed values: 0

taxExcludeProportional

外税按分

外税按分。

※回数券使用では常に0を返します。

integer

Allowed values: 0

productBundleProportional

商品バンドル値引按分

商品バンドル値引按分。

※回数券使用では常に0を返します。

integer

Allowed values: 0

staffDiscountProportional

社員値引き按分

社員値引き按分。

※回数券使用では常に0を返します。

integer

Allowed values: 0

bargainDiscountProportional

セール値引き按分

セール値引き按分。

※回数券使用では常に0を返します。

integer

Allowed values: 0

roundingPriceProportional

端数値引額按分

端数値引額按分。

※回数券使用では常に0を返します。

integer

Allowed values: 0

productStaffDiscountRate

商品毎の社員割引率

商品の社販販売割引率。

※回数券使用では常にnullを返します。

integer

nullable

staffRank

社員ランクコード

社員ランクのコードを設定。

※回数券使用では常にnullを返します。

string

nullable

staffRankName

社員ランク名

社員ランクの名称を設定。

※回数券使用では常にnullを返します。

string

nullable

staffDiscountRate

社員販売割引率

社員販売の割引率。

※回数券使用では常にnullを返します。

string

nullable

staffDiscountDivision

社員販売割引区分

社員販売割引区分。

※回数券使用では常にnullを返します。

string

nullable

applyStaffDiscountRate

適用社員販売割引率

適用した社員販売の割引率。

※回数券使用では常にnullを返します。

string

nullable

applyStaffDiscountPrice

適用社員値引き額

適用した社員販売の値引き額。

※回数券使用では常にnullを返します。

integer

nullable

bargainId

セールID

適用したセールのID。

※回数券使用では常にnullを返します。

string

nullable

bargainName

セール名称

適用したセールの名称。

※回数券使用では常にnullを返します。

string

nullable

bargainDivision

セール区分

セール区分。

※回数券使用では常にnullを返します。

string

nullable

bargainValue

セール値

割引、値引、価格指定の値。

※回数券使用では常にnullを返します。

integer

nullable

applyBargainValue

適用セール値

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

※回数券使用では常にnullを返します。

integer

nullable

applyBargainDiscountPrice

適用セール値引き額

適用したセール販売の値引き額。

※回数券使用では常にnullを返します。

integer

nullable

taxRate

適用税率

適用した税率。（0.000 〜 100.000）

※商品マスタから設定。

string

/^(?:100\.000|(?:[0-9]|[1-9][0-9])\.[0-9]{3})$/

standardTaxRate

標準税率

標準税率。（0.000 〜 100.000）

取引ヘッダの税率を設定

string

/^(?:100\.000|(?:[0-9]|[1-9][0-9])\.[0-9]{3})$/

modifiedTaxRate

修正税率

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

※回数券使用では常にnullを返します。

string

nullable

reduceTaxId

軽減税率ID

軽減税率ID（税設定）。

※回数券使用では常にnullを返します。

string

nullable

reduceTaxName

軽減税率名

軽減税率名。

※回数券使用では常にnullを返します。

string

nullable

reduceTaxRate

軽減税率

軽減税率。

※回数券使用では常にnullを返します。

string

nullable

reduceTaxPrice

軽減税率用商品単価

軽減税率用商品単価。

※商品マスタから設定。

integer

>= -999999999 <= 999999999

reduceTaxMemberPrice

軽減税率用会員商品単価

軽減税率用会員商品単価。

※商品マスタから設定。

integer

>= -999999999 <= 999999999

memo

メモ

返品販売時などのメモなどを設定。

※回数券使用では常に空文字を返します。

string

Example

{
  "transactionHeadId": "string",
  "transactionDateTime": "2000-01-23T01:23:45+09:00",
  "transactionHeadDivision": "9",
  "cancelDivision": "0",
  "unitNonDiscountsubtotal": 0,
  "unitDiscountsubtotal": 0,
  "unitStaffDiscountsubtotal": 0,
  "unitBargainDiscountsubtotal": 0,
  "subtotal": 0,
  "subtotalForDiscount": 0,
  "subtotalDiscountPrice": 0,
  "subtotalDiscountRate": "0.00",
  "subtotalDiscountDivision": null,
  "pointDiscount": 0,
  "couponDiscount": 0,
  "total": 0,
  "taxInclude": 0,
  "taxExclude": 0,
  "roundingDivision": "00",
  "roundingPrice": 0,
  "cashTotal": 0,
  "creditTotal": 0,
  "deposit": 0,
  "depositCash": 0,
  "depositCredit": 0,
  "change": 0,
  "tipCash": null,
  "tipCredit": null,
  "amount": 123456,
  "returnAmount": 0,
  "costTotal": "string",
  "salesHeadDivision": "0",
  "inTaxSalesTotal": 0,
  "outTaxSalesTotal": 0,
  "nonTaxSalesTotal": 0,
  "nonSalesTargetTotal": 0,
  "nonSalesTargetInTaxTotal": 0,
  "nonSalesTargetOutTaxTotal": 0,
  "nonSalesTargetTaxFreeTotal": 0,
  "nonSalesTargetCostTotal": "string",
  "nonSalesTargetAmount": 123456,
  "nonSalesTargetReturnAmount": 0,
  "newPoint": 0,
  "spendPoint": 0,
  "point": 123456789,
  "totalPoint": 123456789,
  "currentMile": 123456789,
  "earnMile": 0,
  "totalMile": 123456789,
  "adjustmentMile": 0,
  "adjustmentMileDivision": null,
  "adjustmentMileValue": null,
  "storeId": "string",
  "terminalId": "string",
  "customerId": "string",
  "terminalTranId": "string",
  "terminalTranDateTime": "2000-01-23T01:23:45+09:00",
  "sumDivision": "0",
  "adjustmentDateTime": "2000-01-23T01:23:45+09:00",
  "sumDate": "2000-01-23",
  "customerRank": "string",
  "customerGroupId": "string",
  "customerGroupId2": "string",
  "customerGroupId3": "string",
  "customerGroupId4": "string",
  "customerGroupId5": "string",
  "staffId": "string",
  "staffName": "string",
  "creditDivision": null,
  "paymentCount": null,
  "slipNumber": null,
  "cancelSlipNumber": null,
  "authNumber": null,
  "authDate": null,
  "cardCompany": null,
  "denomination": null,
  "memo": "string",
  "receiptMemo": "string",
  "carriage": null,
  "commission": null,
  "guestNumbers": 1234,
  "guestNumbersMale": 1234,
  "guestNumbersFemale": 1234,
  "guestNumbersUnknown": 1234,
  "enterDateTime": "2000-01-23T01:23:45+09:00",
  "taxFreeSalesDivision": "0",
  "netTaxFreeGeneralTaxInclude": 0,
  "netTaxFreeGeneralTaxExclude": 0,
  "netTaxFreeConsumableTaxInclude": 0,
  "netTaxFreeConsumableTaxExclude": 0,
  "tags": "string",
  "pointGivingDivision": "1",
  "pointGivingUnitPrice": 12345,
  "pointGivingUnit": "string",
  "pointSpendDivision": "1",
  "mileageDivision": "0",
  "mileageLabel": "マイル",
  "customerPinCode": "string",
  "returnSales": "0",
  "disposeDivision": "0",
  "disposeServerTransactionHeadId": "0",
  "cancelDateTime": null,
  "sellDivision": "0",
  "taxRate": "string",
  "taxRounding": "0",
  "discountRoundingDivision": "0",
  "transactionUuid": "string",
  "exchangeTicketNo": "string",
  "giftReceiptValidDays": null,
  "discountCalculateDivision": "0",
  "barcode": null,
  "updDateTime": "2000-01-23T01:23:45+09:00",
  "details": [
    {
      "transactionHeadId": "string",
      "transactionDetailId": "string",
      "parentTransactionDetailId": null,
      "transactionDetailDivision": "1",
      "productId": "string",
      "productCode": "string",
      "productName": "string",
      "printReceiptProductName": "string",
      "color": "string",
      "size": "string",
      "groupCode": "string",
      "supplierProductNo": "string",
      "taxDivision": "0",
      "price": 123456789,
      "salesPrice": 0,
      "unitDiscountPrice": 0,
      "unitDiscountRate": null,
      "unitDiscountDivision": null,
      "cost": "string",
      "quantity": 123,
      "unitNonDiscountSum": 0,
      "unitDiscountSum": 0,
      "unitDiscountedSum": 0,
      "costSum": "string",
      "categoryId": "string",
      "categoryName": "string",
      "discriminationNo": "string",
      "salesDivision": "0",
      "productDivision": "0",
      "inventoryReservationDivision": "0",
      "pointNotApplicable": "0",
      "calcDiscount": "0",
      "taxFreeDivision": "0",
      "taxFreeCommodityPrice": 0,
      "taxFree": 0,
      "productBundleGroupId": null,
      "discountPriceProportional": 0,
      "discountPointProportional": 0,
      "discountCouponProportional": 0,
      "taxIncludeProportional": 0,
      "taxExcludeProportional": 0,
      "productBundleProportional": 0,
      "staffDiscountProportional": 0,
      "bargainDiscountProportional": 0,
      "roundingPriceProportional": 0,
      "productStaffDiscountRate": null,
      "staffRank": null,
      "staffRankName": null,
      "staffDiscountRate": null,
      "staffDiscountDivision": null,
      "applyStaffDiscountRate": null,
      "applyStaffDiscountPrice": null,
      "bargainId": null,
      "bargainName": null,
      "bargainDivision": null,
      "bargainValue": null,
      "applyBargainValue": null,
      "applyBargainDiscountPrice": null,
      "taxRate": "string",
      "standardTaxRate": "string",
      "modifiedTaxRate": null,
      "reduceTaxId": null,
      "reduceTaxName": null,
      "reduceTaxRate": null,
      "reduceTaxPrice": 123456789,
      "reduceTaxMemberPrice": 123456789,
      "memo": "string"
    }
  ]
}

400

存在しない店舗IDを指定した場合
店舗が倉庫の店舗IDを指定した場合
店舗が休止中の店舗IDを指定した場合
存在しない端末IDを指定し、締め区分を 2:締め処理済み以外を指定した場合
対象店舗の締め方式区分の設定が「自動締め処理」で、締め区分に 1:清算処理済みを指定した場合
対象店舗の締め方式区分の設定が「自動締め処理」で、締め区分に 0:未処理を指定した場合
締め区分が 2:締め処理済み以外で、締め日を設定した場合
締め区分が 2：締め処理済で、締め日が未指定の場合
現在の会員マスタの会員コードと、リクエストの会員コードが異なる場合
客層IDが指定した客層セクションに存在しない場合
存在しない販売員IDを指定した場合
レシート番号が重複した場合
客数と客数（男）、客数（女）、客数（不明）の合計が一致しない場合
1取引タグが64文字を超える場合
回数券対象商品、回数券対象オプション商品がどちらも未設定の場合
回数券対象商品または回数券対象オプション商品にて、存在しない回数券購入取引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": "存在しない店舗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を指定した場合、締め区分は 2:締め処理済み を指定してください。（店舗ID：{店舗ID} 端末ID：{端末ID})",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "対象店舗の締め方式区分の設定が「自動締め処理」の場合、締め区分に 1:清算処理済み は設定できません。（店舗ID：{店舗ID} 端末ID：{端末ID})",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "対象店舗の締め方式区分の設定が「自動締め処理」の場合、締め区分に 0:未処理 は設定できません。（店舗ID：{店舗ID} 端末ID：{端末ID})",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "締め区分が 2:締め処理済み 以外の場合、締め日は指定できません。",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "締め区分が 2:締め処理済み の場合、締め日は必須です。",
  "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": "客数と客数（男）、客数（女）、客数（不明）の合計が一致しません。",
  "status": 400
}

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

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "存在しない回数券購入取引IDです。(回数券購入取引ID-{回数券購入取引ID})",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "存在しない回数券購入取引明細IDです。（回数券購入取引ID-{回数券購入取引ID} 回数券購入取引明細ID-{回数券購入取引明細ID})",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "回数券対象商品と回数券対象オプション商品がどちらも設定されていません。",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "指定した回数券の期限が切れています。(回数券購入取引ID-{回数券購入取引ID})",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "指定した回数券は使用済みです。(回数券購入取引ID-{回数券購入取引ID})",
  "status": 400
}

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

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "指定した会員IDが回数券を購入した会員と一致しません。（会員ID-{会員ID} 回数券購入取引ID-{回数券購入取引ID})",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "回数券対象商品には回数券対象オプション商品を指定できません。（回数券購入取引ID-{回数券購入取引ID} 回数券購入取引明細ID-{回数券購入取引明細ID})",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "残数を上回る数量が指定されています。（回数券購入取引ID-{回数券購入取引ID} 回数券購入取引明細ID-{回数券購入取引明細ID} 数量-{数量} 残数-{残数})",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "回数券対象オプション商品には回数券対象商品を指定できません。（回数券購入取引ID-{回数券購入取引ID} 回数券購入取引明細ID-{回数券購入取引明細ID})",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "オプション商品全体の残数を上回る数量が指定されています。（回数券購入取引ID-{回数券購入取引ID} オプション商品合計数量-{オプション商品合計数量} オプション商品全体の残数-{オプション商品全体の残数})",
  "status": 400
}

回数券使用

対象プラン

Authorizations

Request Body^required

Example

Responses

200

Example

400

Examples

回数券使用

対象プラン

Authorizations

Request Body required

Example

Responses

200

Example

400

Examples

Request Body^required