店舗登録
POST /stores
店舗情報を登録します。
対象プラン
- スタンダード
- プレミアム
- プレミアムプラス
- フードビジネス
- リテールビジネス
Authorizations
Section titled “Authorizations ”Request Body
Section titled “Request Body ”object
ユニーク値
レシートに印字する店舗名。(64文字以内)
在庫レシートに印字する店舗名。(64文字以内)
(1:通常店舗、2:倉庫)
※登録後、変更できません。
店舗郵便番号 (ハイフンあり)
店舗住所
店舗電話番号 (ハイフン付)
店舗FAX番号
店舗メールアドレス
店舗ホームページ
仮販売登録時に送信するメールアドレス
※カンマ区切りで複数指定可
IPod,iPadで販売価格を変更できなくするには、0:変更不可を設定してください。(0:変更不可、1:変更可能)
(0:内税販売、1:外税販売)
(0:手動締め処理、1:自動締め処理)
日付変更時間。締め処理時に使用 [HHMM]
締め方式区分が1:自動締め処理の場合必須
締め処理を行う時に参照する時間。締め処理時に使用
(0:端末時間、1:サーバー時間)
締め方式区分が1:自動締め処理の場合必須
(0:ポイントをつける、1:ポイントをつけない)
(0:対象外、1:一般品、2:消耗品)
簡易バンドル販売画面の最大商品登録数を設定する。
※デフォルト:9 とする。最大999
端末で値引きができる率。下記の率を超える金額になると値引き出来なくなる。(単位:%)
未設定の場合、上限なし
送料・手数料を表示するフラグ。
スマレジAPIで送料手数料を設定している場合、日報/月報/日別集計に表示するかしないかを設定する。
(0:表示しない、1:表示する)
端末精算時に現金管理入力画面を表示するか否か
(0:入力しない、1:入力する)
端末精算時に現金管理入力画面を表示するか否か
(0:入力しない、1:入力する)
未会計伝票が残った状態での精算を許可するか許可しないかを判定(ウェイター利用者のみ)
0:チェックしない、1:チェックする
締め処理画面の銀行預入金を自動で設定するか否か
0:自動入力しない、1:自動入力する
※金額が未設定の場合、(現金売上+現金化不足)
※設定済みの場合、実現金残高 - 銀行預入金自動入力金額
銀行預入金が自動の場合、繰越準備金の金額を設定する。
取消設定区分 (1:自動、2:消込のみ、3:選択)
1: 「自動で切り替える」 ※締まっている場合、消込レコード作成、締まっていない場合取消を行う。
2: 「消込レコード作成」のみ表示
3: 「取消」「消込レコード作成」の両方表示。※デフォルト
販売時の合計金額の端数を丸めるか否かを設定する
00:なし
11:一の位を四捨五入,12:一の位を切捨,13:一の位を切上
21:十の位を四捨五入,22:十の位を切捨,23:十の位を切上
31:百の位を四捨五入,32:百の位を切捨,33:百の位を切上
41:千の位を四捨五入,42:千の位を切捨,43:千の位を切上
99:手入力
0:四捨五入、1:切り捨て、2:切り上げ、3:銀行丸め
クレジットカード手入力時のカードブランド選択
0:選択なし、1:選択あり
引換の有効日数。nullの場合は有効期限なし。
標準税率のボタンラベル。未指定の場合は「イートイン」。
※この項目は商品の税設定が「販売時に選択」を選ばれているときのみ、有効になります。
軽減税率のボタンラベル。未指定の場合は「テイクアウト」。
※この項目は商品の税設定が「販売時に選択」を選ばれているときのみ、有効になります。
表示順序
(非推奨)顔認証決済利用区分 (0:利用しない、1:利用する)
※ 顔認証決済をスマレジ上で利用可能に個別設定された契約でのみ設定可能です。
登録事業者番号:適格請求書発行事業者としての登録番号。
object
ポイント機能を使用するか判断 (0:使用しない、1:使用する)
1ポイントの還元率を、円で設定 (設定範囲:0円~100円) (例:1ポイント1円の場合、1円) ポイント機能を使用しない場合はnull. ※ポイント使用区分が1の場合、必須。
ポイント付与の設定 n円をnポイントの「n円」の部分 (設定範囲:1円~99999円) (例:10円ごとに2ポイントの場合、10円) ポイント機能を使用しない場合はnull. ※ポイント使用区分が1の場合、必須。
ポイント付与の設定 n円をnポイントの「nポイント」の部分 (設定範囲:0.00ポイント~99999.99ポイント) (例:10円ごとに0.2ポイントの場合、0.2ポイント) ポイント機能を使用しない場合はnull. ※ポイント使用区分が1の場合、必須。
(1:税額を含める + 利用ポイント分を含める、 2:税額を含めない + 利用ポイント分を含める、 3:税額を含める + 利用ポイント分を含めない、 4:税額を含めない + 利用ポイント分を含めない) ポイント機能を使用しない場合は1 ※ポイント使用区分が1の場合、必須。
利用単位 (設定範囲:1ポイント~99999ポイント) 500ポイント単位で利用可能の場合、500 ポイント機能を使用しない場合はnull.(利用単位なし) ※ポイント使用区分が1の場合、必須。
1:外税を含む合計からポイント利用分を差し引く 2:外税を含まない合計からポイント利用分を差し引く ポイント機能を使用しない場合は1
ポイント利用時にどこまで利用可能かを識別する区分 0: 保有ポイントまで利用可能 1: 値引き対象額以下で最小のポイントまで利用可能 2: 値引き対象額以上で最小のポイントまで利用可能 ポイント機能を使用しない場合は0
例)100ポイント単位利用可。300ポイント保有する会員が150円の会計を行った場合 0: 300ポイントまで利用可能 1: 100ポイントまで利用可能 2: 200ポイントまで利用可能
ポイント失効期限の単位を設定 (0:なし、1:日、2:月、3:年) ポイント機能を使用しない場合は0 ポイント失効期限を指定する場合、0(なし)を指定するとエラー
ポイント失効までの期限を設定 ポイント機能を使用しない場合はnull.
マイレージ機能を利用するか否か (0: 利用しない, 1: 利用する, 2: ポイントの代わりに貯める) ポイント機能を使用しない場合は0
マイレージ付与上限。数字8桁以内。 (設定範囲:0~99999999)
object
レシートのヘッダ部分に印字する内容を設定してください。 横幅24文字(半角48文字)で改行して登録してください。 縦幅は100列程度まで。
レシートのフッタ部分に印字する内容を設定してください。 横幅24文字(半角48文字)で改行して登録してください。 縦幅は100列程度まで。
税務署名が登録されてい場合のみ、レシートのコメント部分に印字されます。 横幅24文字(半角48文字)で改行して登録してください。 縦幅は100列程度まで。
規定の位置に収入印紙を貼り付ける代わりに「印紙税申告納付につき○○税務署承認済」印を押印する場合入力してください。 例) 渋谷税務署の場合「渋谷」、新宿税務署の場合「新宿」と入力してください。
割引レシート控えレシートのヘッダ部分に印字する内容を設定してください。
割引レシート控えレシートのヘッダ部分に印字する内容を設定してください。
Example
{ "storeCode": "string", "storeName": "string", "storeAbbr": "string", "printReceiptStoreName": "string", "printStockReceiptStoreName": "string", "division": "1", "postCode": "string", "address": "string", "phoneNumber": "string", "faxNumber": "string", "mailAddress": "test@example.com", "homepage": "string", "tempTranMailAddress": "test@example.com", "priceChangeFlag": "0", "sellDivision": "0", "sumProcDivision": "0", "sumDateChangeTime": "string", "sumRefColumn": "0", "pointNotApplicable": "0", "taxFreeDivision": "0", "maxBundleProductCount": "123", "maxDiscountRate": "100", "carriageDisplayFlag": "0", "terminalAdjustmentCashFlag": "0", "terminalCheckCashFlag": "0", "waiterAdjustmentDivision": "0", "savingAutoDivision": "0", "savingAutoPrice": "123456789", "cancelSettingDivision": "1", "roundingDivision": "00", "discountRoundingDivision": "0", "cardCompanySelectDivision": "0", "giftReceiptValidDays": "123", "taxLabelNormal": "string", "taxLabelReduce": "string", "displaySequence": "123456789", "facePaymentUseDivision": "0", "invoiceRegistrationNo": "string", "pointCondition": { "pointUseDivision": "0", "spendRate": "100", "pointGivingUnitPrice": "12345", "pointGivingUnit": "99999.99", "pointGivingDivision": "1", "pointUseUnit": "12345", "pointSpendDivision": "1", "pointSpendLimitDivision": "0", "expireDivision": "0", "expireLimit": "123", "mileageDivision": "0", "mileageLimit": "12345678" }, "receiptPrintInfo": { "header": "string", "footer": "string", "receiptTaxOfficeStampComment": "string", "taxOfficeName": "string", "discountReceiptHeader": "string", "discountReceiptFooter": "string" }}
Responses
Section titled “ Responses ”更新成功
object
店舗ID:
店舗コード:
店舗名:
店舗名略称:
レシート印刷用店舗名:レシートに印字する店舗名。(64文字以内)
在庫レシート印字店舗名:在庫レシートに印字する店舗名。(64文字以内)
店舗区分:(1:通常店舗、2:倉庫)
※登録後、変更できません。
郵便番号:店舗郵便番号 (ハイフンあり)
住所:店舗住所
電話番号:店舗電話番号 (ハイフン付)
FAX番号:店舗FAX番号
メールアドレス:店舗メールアドレス
ホームページ:店舗ホームページ
仮販売登録時送信先アドレス:仮販売登録時に送信するメールアドレス
※カンマ区切りで複数指定可
端末価格変更許可フラグ:iPod,iPadで販売価格を変更できなくするには、0:変更不可を設定してください。(0:変更不可、1:変更可能)
販売区分:(0:内税販売、1:外税販売)
締め方式区分:(0:手動締め処理、1:自動締め処理)
締め日付変更時間:日付変更時間。締め処理時に使用 [HHMM]
締め方式区分が1:自動締め処理の場合必須
締め参照時間項目:締め処理を行う時に参照する時間。締め処理時に使用
(0:端末時間、1:サーバー時間)
締め方式区分が1:自動締め処理の場合必須
ポイント対象区分:(0:ポイントをつける、1:ポイントをつけない)
免税区分:(0:対象外、1:一般品、2:消耗品)
簡易バンドル商品登録最大件数:簡易バンドル販売画面の最大商品登録数を設定する。
※デフォルト:9 とする。最大999
最大値引率:端末で値引きができる率。下記の率を超える金額になると値引き出来なくなる。(単位:%)
未設定の場合、上限なし
送料・手数料表示フラグ:送料・手数料を表示するフラグ。
スマレジAPIで送料手数料を設定している場合、日報/月報/日別集計に表示するかしないかを設定する。
(0:表示しない、1:表示する)
端末精算時の現金管理フラグ:端末精算時に現金管理入力画面を表示するか否か
(0:入力しない、1:入力する)
端末検査時の現金管理フラグ:端末精算時に現金管理入力画面を表示するか否か
(0:入力しない、1:入力する)
ウェイター精算可能チェック区分:未会計伝票が残った状態での精算を許可するか許可しないかを判定(ウェイター利用者のみ)
0:チェックしない、1:チェックする
銀行預入金自動入力区分:締め処理画面の銀行預入金を自動で設定するか否か
0:自動入力しない、1:自動入力する
※金額が未設定の場合、(現金売上+現金化不足)
※設定済みの場合、実現金残高 - 銀行預入金自動入力金額
銀行預入金自動入力金額:銀行預入金が自動の場合、繰越準備金の金額を設定する。
取消設定区分:取消設定区分 (1:自動、2:消込のみ、3:選択)
1: 「自動で切り替える」 ※締まっている場合、消込レコード作成、締まっていない場合取消を行う。
2: 「消込レコード作成」のみ表示
3: 「取消」「消込レコード作成」の両方表示。※デフォルト
端数値引区分:販売時の合計金額の端数を丸めるか否かを設定する
00:なし
11:一の位を四捨五入,12:一の位を切捨,13:一の位を切上
21:十の位を四捨五入,22:十の位を切捨,23:十の位を切上
31:百の位を四捨五入,32:百の位を切捨,33:百の位を切上
41:千の位を四捨五入,42:千の位を切捨,43:千の位を切上
99:手入力
割引丸め区分:0:四捨五入、1:切り捨て、2:切り上げ、3:銀行丸め
カード会社選択区分:クレジットカード手入力時のカードブランド選択
0:選択なし、1:選択あり
ギフトレシート引換有効日数:引換の有効日数。nullの場合は有効期限なし。
標準税率のボタンラベル:標準税率のボタンラベル。未指定の場合は「イートイン」。
※この項目は商品の税設定が「販売時に選択」を選ばれているときのみ、有効になります。
軽減税率のボタンラベル:軽減税率のボタンラベル。未指定の場合は「テイクアウト」。
※この項目は商品の税設定が「販売時に選択」を選ばれているときのみ、有効になります。
表示番号:表示順序
(非推奨)顔認証決済利用区分:顔認証決済利用区分 (0:利用しない、1:利用する)
※ 顔認証決済をスマレジ上で利用可能に個別設定された契約でのみ設定可能です。
登録事業者番号:適格請求書発行事業者としての登録番号。
作成日時:登録時の日時。[YYYY-MM-DDThh:mm:ssTZD]
更新日時:登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]
ポイント条件:
object
店舗ID:
ポイント機能を使用するか判断 (0:使用しない、1:使用する)
1ポイントの還元率を、円で設定 (設定範囲:0円~100円) (例:1ポイント1円の場合、1円) ポイント機能を使用しない場合はnull. ※ポイント使用区分が1の場合、必須。
ポイント付与の設定 n円をnポイントの「n円」の部分 (設定範囲:1円~99999円) (例:10円ごとに2ポイントの場合、10円) ポイント機能を使用しない場合はnull. ※ポイント使用区分が1の場合、必須。
ポイント付与の設定 n円をnポイントの「nポイント」の部分 (設定範囲:0.00ポイント~99999.99ポイント) (例:10円ごとに0.2ポイントの場合、0.2ポイント) ポイント機能を使用しない場合はnull. ※ポイント使用区分が1の場合、必須。
(1:税額を含める + 利用ポイント分を含める、 2:税額を含めない + 利用ポイント分を含める、 3:税額を含める + 利用ポイント分を含めない、 4:税額を含めない + 利用ポイント分を含めない) ポイント機能を使用しない場合は1 ※ポイント使用区分が1の場合、必須。
利用単位 (設定範囲:1ポイント~99999ポイント) 500ポイント単位で利用可能の場合、500 ポイント機能を使用しない場合はnull.(利用単位なし) ※ポイント使用区分が1の場合、必須。
1:外税を含む合計からポイント利用分を差し引く 2:外税を含まない合計からポイント利用分を差し引く ポイント機能を使用しない場合は1
ポイント利用時にどこまで利用可能かを識別する区分 0: 保有ポイントまで利用可能 1: 値引き対象額以下で最小のポイントまで利用可能 2: 値引き対象額以上で最小のポイントまで利用可能 ポイント機能を使用しない場合は0
例)100ポイント単位利用可。300ポイント保有する会員が150円の会計を行った場合 0: 300ポイントまで利用可能 1: 100ポイントまで利用可能 2: 200ポイントまで利用可能
ポイント失効期限の単位を設定 (0:なし、1:日、2:月、3:年) ポイント機能を使用しない場合は0 ポイント失効期限を指定する場合、0(なし)を指定するとエラー
ポイント失効までの期限を設定 ポイント機能を使用しない場合はnull.
マイレージ機能を利用するか否か (0: 利用しない, 1: 利用する, 2: ポイントの代わりに貯める) ポイント機能を使用しない場合は0
マイレージ付与上限。数字8桁以内。 (設定範囲:0~99999999)
レシート印刷情報:
object
店舗ID:
レシートのヘッダ部分に印字する内容を設定してください。 横幅24文字(半角48文字)で改行して登録してください。 縦幅は100列程度まで。
レシートのフッタ部分に印字する内容を設定してください。 横幅24文字(半角48文字)で改行して登録してください。 縦幅は100列程度まで。
税務署名が登録されてい場合のみ、レシートのコメント部分に印字されます。 横幅24文字(半角48文字)で改行して登録してください。 縦幅は100列程度まで。
AirPrint用ロゴ:URLを設定 (http://~/xxx.png)
広告画像:URLを設定 (http://~/xxx.png)
ギフトレシート用画像:URLを設定 (http://~/xxx.png)
ギフトレシート用注釈:ギフトレシートに印刷する注釈
規定の位置に収入印紙を貼り付ける代わりに「印紙税申告納付につき○○税務署承認済」印を押印する場合入力してください。 例) 渋谷税務署の場合「渋谷」、新宿税務署の場合「新宿」と入力してください。
割引レシート控えレシートのヘッダ部分に印字する内容を設定してください。
割引レシート控えレシートのヘッダ部分に印字する内容を設定してください。
Example
{ "storeId": "string", "storeCode": "string", "storeName": "string", "storeAbbr": "string", "printReceiptStoreName": "string", "printStockReceiptStoreName": "string", "division": "1", "postCode": "string", "address": "string", "phoneNumber": "string", "faxNumber": "string", "mailAddress": "string", "homepage": "string", "tempTranMailAddress": "string", "priceChangeFlag": "string", "sellDivision": "0", "sumProcDivision": "0", "sumDateChangeTime": "string", "sumRefColumn": "0", "pointNotApplicable": "0", "taxFreeDivision": "0", "maxBundleProductCount": "string", "maxDiscountRate": "string", "carriageDisplayFlag": "0", "terminalAdjustmentCashFlag": "0", "terminalCheckCashFlag": "0", "waiterAdjustmentDivision": "0", "savingAutoDivision": "0", "savingAutoPrice": "string", "cancelSettingDivision": "1", "roundingDivision": "00", "discountRoundingDivision": "0", "cardCompanySelectDivision": "0", "giftReceiptValidDays": "string", "taxLabelNormal": "string", "taxLabelReduce": "string", "displaySequence": "string", "facePaymentUseDivision": "string", "invoiceRegistrationNo": "string", "insDateTime": "string", "updDateTime": "string", "pointCondition": { "storeId": "string", "pointUseDivision": "0", "spendRate": "string", "pointGivingUnitPrice": 1, "pointGivingUnit": "1.23", "pointGivingDivision": "1", "pointUseUnit": 1, "pointSpendDivision": "1", "pointSpendLimitDivision": "0", "expireDivision": "0", "expireLimit": 1, "mileageDivision": "0", "mileageLimit": 1 }, "receiptPrintInfo": { "storeId": "string", "header": "string", "footer": "string", "receiptTaxOfficeStampComment": "string", "airPrintLogo": "string", "advertisementImage": "string", "giftReceiptImage": "string", "giftReceiptNote": "string", "taxOfficeName": "string", "discountReceiptHeader": "string", "discountReceiptFooter": "string" }}
- 入力チェックエラーの場合
- 店舗コードが重複している場合
- 締め方式区分が[1:自動締め処理]の場合の必須項目が未入力の場合
- ポイント利用条件のポイント使用区分が[1:使用する]の場合の必須項目が未入力の場合
- 店舗の登録上限数を超えてしまう場合
object
Examples
{ "type": "about:blank", "title": "Bad Request", "detail": "[storeCode] storeId:171 既に登録されている店舗コードです", "status": 400}
{ "type": "about:blank", "title": "Bad Request", "detail": "[sumDateChangeTime] 締め方式区分が 1:自動締め処理 の場合、締め日付変更時間は必須です", "status": 400}
{ "type": "about:blank", "title": "Bad Request", "detail": "[pointCondition.spendRate] ポイント利用条件のポイント使用区分が 1:使用する の場合、ポイント還元率は必須です", "status": 400}
{ "type": "about:blank", "title": "Bad Request", "detail": "登録件数の上限をオーバーしたため、登録できません。", "status": 400}
- 顔認証決済をスマレジ上で利用可能に個別設定された契約でのみ設定可能な項目が、そうでない契約において設定された場合
object
Examples
{ "type": "about:blank", "title": null, "detail": "ご利用の契約では顔認証決済加盟店IDは登録できません。", "status": 403}