開発者向けサポート

店舗設定関連

初期設定の取得・変更や、お店を作る配下の一部項目を取得することができます。

リソース一覧

リソースURI 説明
店舗設定一覧
店舗設定

リソース属性

このリソースが持つ属性を以下に示します。本リソースについてのAPIを実行すると、以下の属性を取得、変更することができます。

カラム名必須Byte概要
CLIENT_CONFIG_NAME100半角文字列設定名です。「Appsコード:」から始まる文字列を指定してください。
CLIENT_CONFIG_USE_KBN1半角数値利用区分です。null:公開しない、1:公開する、2:公開する(参照のみ)
CLIENT_CONFIG_VALUE2147483647全角文字列設定値です。
DISP_ORDER8半角数値表示順です。システム標準の項目との競合を避けるため、20000以上の値を指定することを強くお勧めします。
DISP_NAME200全角文字列日本語の画面表示項目名です。
DISP_COMMENT2000全角文字列コメントです。画面の入力欄付近に表示される説明を記述します。
FORM_TYPE1半角数値入力形式です。1:1行テキスト、2:プルダウン、3:チェックボックス、4:ラジオボタン、5:テキストエリア
FORM_OPTION4000全角文字列項目の選択肢です。プルダウン・チェックボックス・ラジオボタンを利用する場合に、選択肢をカンマ区切りで設定します。
FORM_SIZE5半角数値テキスト項目横幅です。1行テキスト・パスワードを利用する場合に設定します。
FORM_TEXTAREA_COLS5半角数値テキストエリア横幅です。テキストエリアを利用する場合に設定します。
FORM_TEXTAREA_ROWS5半角数値テキストエリア縦幅です。テキストエリアを利用する場合に設定します。
FORM_UPPER1半角数値大文字変換する場合に指定します。null:変換しない、1:大文字変換する
FORM_IME_MODE1半角数値IME入力モードです。1:半角、2:全角、3:数値、4:日付、5:電話番号、6:メールアドレス、7:コード(英数、アンダーのみ)
CHECK_PROPERTY1半角数値属性です。入力値のチェック時に利用します。1:半角、2:全角、3:数値、4:日付、5:電話番号、6:メールアドレス、7:コード(英数、アンダーのみ)
CHECK_NEED1半角数値必須フラグです。null:必須でない 1:必須
CHECK_BYTE_SIZE8半角数値桁数です。入力可能最大桁数を指定します。全角文字は2文字に換算します。
CHECK_INT_SIZE8半角数値整数部分桁数です。入力可能最大桁数を指定します。
CHECK_DEC_SIZE8半角数値小数部分桁数です。入力可能最大桁数を指定します。

なお、お店を作るメニュー配下にて指定可能な設定の 詳細はこちらを参照してください。