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

店舗取得

GET
/stores/{store_id}
curl --request GET \
  --url 'https://api.smaregi.dev/TARGET-CONTRACT-ID/pos/stores/example?with_point_condition=all&with_receipt_print_info=all' \
  --header 'Authorization: Bearer <token>'

店舗情報を取得します。

対象プラン

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

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
store_id
required
string

店舗ID

Query Parameters

Section titled “Query Parameters”
fields
array

検索パラメータ（カンマ区切りで指定可）
Response項目を指定可能
※一部項目(withで指定する項目、2階層目以降の項目)については指定不可

with_point_condition
string
default: none
Allowed values: all none

ポイント情報を付加するか(付加する場合はall, しない場合はnone)

with_receipt_print_info
string
default: none
Allowed values: all none

レシート印刷情報を付加するか(付加する場合はall, しない場合はnone)

Responses

Section titled “Responses”

200

Section titled “200”

取得成功

Media typeapplication/json
object
storeId

店舗ID：店舗毎に付与するID。

string
storeCode

店舗コード：店舗コード。半角英数記号20文字以内。

string
storeName

店舗名：店舗名。(85文字以内)

string
storeAbbr

店舗名略称：店舗名略称。85文字以内。

string
printReceiptStoreName

レシート印刷用店舗名：レシートに印字する店舗名。(64文字以内)

string
printStockReceiptStoreName

在庫レシート印字店舗名：在庫レシートに印字する店舗名。(64文字以内)

string
division

店舗区分：店舗区分。（1：通常店舗、2：倉庫）

string
postCode

郵便番号：店舗郵便番号。半角英数記号10文字以内。

string
address

住所：店舗住所。85文字以内。

string
phoneNumber

電話番号：店舗電話番号。半角英数20文字以内。

string
faxNumber

FAX番号：店舗FAX番号。半角英数20文字以内。

string
mailAddress

メールアドレス：店舗メールアドレス。半角英数記号255文字以内。メールアドレス形式。

string
homepage

ホームページ：店舗ホームページ。255文字以内。

string
tempTranMailAddress

仮販売登録時送信先アドレス：仮販売登録時に送信するメールアドレス。1000文字以内。

string
priceChangeFlag

端末価格変更許可フラグ：iPod、iPadで販売価格を変更可能か否かの区分。 （0：変更不可、1：変更可能)

string
sellDivision

販売区分：店舗での販売時の消費税の扱いを指定する区分。 （0：内税販売、1：外税販売）

string
sumProcDivision

締め方式区分：締め方法を指定する区分。 （0：手動締め処理、1：自動締め処理）

string
sumDateChangeTime

締め日付変更時間：日付変更時間。締め処理時に使用 (HHMM形式) 締め方式区分が1：自動締め処理の場合必須。

string
sumRefColumn

締め参照時間項目：締め処理を行う時に参照する時間。締め処理時に使用。 （0：端末時間、1：サーバー時間）

string
pointNotApplicable

ポイント対象区分：ポイント対象区分。（0:ポイント対象、1:ポイント対象外）

string
taxFreeDivision

免税区分：免税区分。（0：対象外、1：一般品、2：消耗品）

string
canSelectCustomerFromOtherStores

他店舗に所属する会員の選択許可。

スマレジアプリで他店舗に所属する会員を選択可能な場合true、選択不可な場合falseが設定される。選択不可の場合、他店舗に所属する会員をスマレジアプリで呼び出すとエラーになる。

boolean
maxBundleProductCount

バンドル登録最大件数：簡易バンドル商品登録最大件数。(設定範囲: 0-999)

string
maxDiscountRate

最大値引率

string
carriageDisplayFlag

送料表示フラグ：(0：表示しない、1：表示する)

string
terminalAdjustmentCashFlag

端末精算時の現金管理フラグ：(0：入力しない、1：入力する)

string
terminalCheckCashFlag

端末点検時の現金管理フラグ：(0：入力しない、1：入力する)

string
waiterAdjustmentDivision

ウェイター精算可能チェック区分：(0：チェックしない、1：チェックする)

string
savingAutoDivision

銀行預入金自動入力区分：(0:自動入力しない、1:自動入力する)

string
savingAutoPrice

銀行預入金自動入力金額

string
cancelSettingDivision

取消設定区分：(1:自動、2：返品取消のみ、3:両方)

string
roundingDivision

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

string
discountCalculateDivision

割引額計算対象：小計に対する値引・割引を複数適用する場合に、割引率から割引額を算出するときの対象金額を指定する区分。

  • 0: 小計（販売価格）。明細から算出した値引・割引前の小計を、毎回の割引率計算の対象にします。
  • 1: 他の値引割引に追従した小計（販売価格）。先に適用した小計値引・割引を反映した後の小計を、次の割引率計算の対象にします。

計算例：小計10,000円に「10%割引」「1,000円値引」「10%割引」の順で適用する場合

0 小計（販売価格）

  • 10%割引：-1,000円
  • 1,000円値引：-1,000円
  • 10%割引：-1,000円
  • 合計：7,000円

1 他の値引割引に追従した小計（販売価格）

  • 10%割引：-1,000円
  • 1,000円値引：-1,000円
  • 10%割引：-800円
  • 合計：7,200円
string
Allowed values: 0 1
discountRoundingDivision

割引丸め区分：割引の端数を丸める方法を指定する区分。 0:四捨五入、1:切り捨て、2:切り上げ

string
cardCompanySelectDivision

カード会社選択区分(0:選択なし、1:選択あり)

string
giftReceiptValidDays

ギフトレシート引換有効日数

string
taxLabelNormal

標準税率のボタンラベル

string
taxLabelReduce

軽減税率のボタンラベル

string
pauseFlag

休止フラグ：数字１桁。休止フラグ。（0：通常、1：休止）

string
displaySequence

表示順：数字9桁以内。

string
facePaymentUseDivision

顔認証決済利用区分：顔認証決済利用区分 (0:利用しない、1：利用する)
※ 顔認証決済をスマレジ上で利用可能に個別設定された契約でのみ参照可能です。

string
invoiceRegistrationNo

登録事業者番号：適格請求書発行事業者としての登録番号。

string
insDateTime

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

string
updDateTime

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

string
pointCondition

ポイント条件

object
storeId

店舗ID。

string
pointUseDivision

ポイント使用区分：ポイント機能を使用するか判断。(0：使用しない、1：使用する）

string
0
Allowed values: 0 1
spendRate

ポイント還元率：1ポイントの還元率を、円で設定
（設定範囲：0円～100円)
（例：1ポイント1円の場合、1円）

string
pointGivingUnitPrice

ポイント付与単位(金額)：ポイント付与の設定 n円をnポイントの「n円」の部分
（設定範囲：1円～99999円)
（例：10円ごとに0.2ポイントの場合、10）

string
pointGivingUnit

ポイント付与単位(ポイント)：ポイント付与の設定 n円をnポイントの「nポイント」の部分
（設定範囲：0.00ポイント～99999.99ポイント)
（例：10円ごとに0.2ポイントの場合、0.2）

string
pointGivingDivision

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

string
default: 1
Allowed values: 1 2 3 4
pointUseUnit

ポイント利用単位：利用単位 （設定範囲：1ポイント～99999ポイント)
500ポイント単位で利用可能の場合、500

string
pointSpendDivision

ポイント利用時の税を含む／含まない、対価の値引き／対価の値引きでないを判定。

  • 1: 「小計 + 外税 の金額から差し引く」かつ「対価への充当」
  • 2: 「小計から差し引く」かつ「対価の値引き」
  • 3: 「小計 + 外税 の金額から差し引く」かつ「対価の値引き」
string
default: 2
Allowed values: 1 2 3
pointSpendLimitDivision

ポイント利用上限区分： ポイント利用時にどこまで利用可能かを識別する区分
0: 保有ポイントまで利用可能
1: 値引き対象額以下で最小のポイントまで利用可能
2: 値引き対象額以上で最小のポイントまで利用可能

例）100ポイント単位利用可。300ポイント保有する会員が150円の会計を行った場合
0: 300ポイントまで利用可能
1: 100ポイントまで利用可能
2: 200ポイントまで利用可能

string
0
Allowed values: 0 1 2
expireDivision

ポイント失効期限区分：ポイント失効期限の単位を設定。
(0：なし、1：日、2：月、3：年)

string
0
Allowed values: 0 1 2 3
expireLimit

ポイント失効期限：ポイント失効までの期限を設定
（設定範囲：1～999)

string
mileageDivision

マイレージ利用区分： マイレージ機能を利用するか否か(0: 利用しない, 1: 利用する, 2: ポイントの代わりに貯める)

string
0
Allowed values: 0 1 2
receiptPrintInfo

レシート印刷情報

object
storeId

店舗ID。

string
header

レシートヘッダ：レシートのヘッダ部分に印字する内容を設定してください。
横幅24文字(半角48文字)で改行して登録してください。
縦幅は100列程度まで。1000文字以内。

string
footer

レシートフッタ：レシートのフッタ部分に印字する内容を設定してください。
横幅24文字(半角48文字)で改行して登録してください。
縦幅は100列程度まで。1000文字以内。

string
receiptTaxOfficeStampComment

レシート税務署印コメント：税務署名が登録されてい場合のみ、
レシートのコメント部分に印字されます。
横幅24文字(半角48文字)で改行して登録してください。
縦幅は100列程度まで。1000文字以内。

string
taxOfficeName

税務署名：10文字以内。
規定の位置に収入印紙を貼り付ける代わりに
「印紙税申告納付につき○○税務署承認済」印を押印する場合、
税務署名を入力してください。
例） 渋谷税務署の場合「渋谷」、新宿税務署の場合「新宿」と入力してください。

string
airPrintLogo

AirPrint用ロゴ

string
advertisementImage

広告画像

string
giftReceiptImage

ギフトレシート用画像

string
giftReceiptNote

ギフトレシート用注釈

string
discountReceiptHeader

割引レシート控えヘッダ：割引レシート控えレシートのヘッダ部分に印字する内容を
設定してください。1000文字以内。

string
discountReceiptFooter

割引レシート控えフッダ：割引レシート控えレシートのヘッダ部分に印字する内容を
設定してください。1000文字以内。

string
Example
{
  "storeId": "string",
  "storeCode": "string",
  "storeName": "string",
  "storeAbbr": "string",
  "printReceiptStoreName": "string",
  "printStockReceiptStoreName": "string",
  "division": "string",
  "postCode": "string",
  "address": "string",
  "phoneNumber": "string",
  "faxNumber": "string",
  "mailAddress": "string",
  "homepage": "string",
  "tempTranMailAddress": "string",
  "priceChangeFlag": "string",
  "sellDivision": "string",
  "sumProcDivision": "string",
  "sumDateChangeTime": "string",
  "sumRefColumn": "string",
  "pointNotApplicable": "string",
  "taxFreeDivision": "string",
  "canSelectCustomerFromOtherStores": true,
  "maxBundleProductCount": "string",
  "maxDiscountRate": "string",
  "carriageDisplayFlag": "string",
  "terminalAdjustmentCashFlag": "string",
  "terminalCheckCashFlag": "string",
  "waiterAdjustmentDivision": "string",
  "savingAutoDivision": "string",
  "savingAutoPrice": "string",
  "cancelSettingDivision": "string",
  "roundingDivision": "string",
  "discountCalculateDivision": "0",
  "discountRoundingDivision": "string",
  "cardCompanySelectDivision": "string",
  "giftReceiptValidDays": "string",
  "taxLabelNormal": "string",
  "taxLabelReduce": "string",
  "pauseFlag": "string",
  "displaySequence": "string",
  "facePaymentUseDivision": "string",
  "invoiceRegistrationNo": "string",
  "insDateTime": "string",
  "updDateTime": "string",
  "pointCondition": {
    "storeId": "string",
    "pointUseDivision": "0",
    "spendRate": "string",
    "pointGivingUnitPrice": "string",
    "pointGivingUnit": "string",
    "pointGivingDivision": "1",
    "pointUseUnit": "string",
    "pointSpendDivision": "1",
    "pointSpendLimitDivision": "0",
    "expireDivision": "0",
    "expireLimit": "string",
    "mileageDivision": "0"
  },
  "receiptPrintInfo": {
    "storeId": "string",
    "header": "string",
    "footer": "string",
    "receiptTaxOfficeStampComment": "string",
    "taxOfficeName": "string",
    "airPrintLogo": "string",
    "advertisementImage": "string",
    "giftReceiptImage": "string",
    "giftReceiptNote": "string",
    "discountReceiptHeader": "string",
    "discountReceiptFooter": "string"
  }
}