店舗アカウントのインポート – Shopらんサポートサイト

店舗アカウントの登録・更新を行えます。
アカウントデータをCSVファイルで作成し、WebAPIでアップロードします。

呼び出し先URL

{your-domain} の部分は、ご利用の環境に合わせて変更してください。

https://{your-domain}/h2/STRStoreAccountManipurator.do

リクエスト

パラメータ名	意味	必須	制約
func	動作モード	〇	必ず `importCsv` を指定します。
key	WebAPIキー	〇	アカウント管理APIが利用可能なWebAPIキーを指定します。
csv	CSVファイル	〇	店舗情報のCSVファイルを指定します。 ℹ 補足：CSVファイルは「店舗の管理＞一括操作＞エクスポート」からダウンロードできます。
importMode	一括操作のインポートモード		次の値を指定できます。 `add`：現在存在しない店舗を追加する `modify`：既存の店舗情報を更新する `disable`：CSVに存在しない既存の店舗を無効にするパラメータを省略した場合は、すべてのモードが指定されたものとして扱われます。CSVに存在する店舗は追加・更新され、CSVに存在しない既存店舗は無効になります。 ℹ 補足：複数のモードを指定する場合は、同じパラメータ名を複数回指定し、値を変えて指定してください。
passwordExpirationFlag	次回ログイン時のパスワード更新		`1` または `0` を指定します。 `1`：パスワードを更新した店舗の次回ログイン時に、パスワード更新を強制します。 `0`：パスワード更新を強制しません。
force	エラーを無視してインポートを実施するかどうか		`1` または `0` を指定します。 `1`：エラーがあるデータを無視し、追加・変更可能なデータのみインポートします。 `0`：エラーがあるデータが存在する場合、追加・変更可能なデータも含めてインポートしません。レスポンスの `info` にエラー内容が出力されると同時に、`error-lines` にエラーのあった行番号が出力されます。パラメータを省略した場合は、`0` が指定されたものとして扱われます。

HTMLによるリクエストサンプル

インポートモードに追加と更新を指定する場合の例です。

<form method="POST"
    enctype="multipart/form-data">
    　：
    <input type="hidden" name="importMode" value="add" />
    <input type="hidden" name="importMode" value="modify" />
    　：
</form>

レスポンス

APIの呼び出し結果は、次のスキーマのXML文書として返されます。

<?xml version="1.0"?>
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <xsd:element name="response">
    <xsd:sequence>
      <xsd:element name="result" type="xsd:int" minOccurs="1" maxOccurs="1" />
      <xsd:element name="errors" type="xsd:string" minOccurs="0" maxOccurs="1"/>
      <xsd:element name="info" type="xsd:string" minOccurs="0" maxOccurs="1"/>
      <xsd:element name="error-lines" type="xsd:string" minOccurs="0" maxOccurs="1" />
    </xsd:sequence>
  </xsd:element>
</xsd:schema>

要素	意味	備考
`//response/result`	リザルトコード	次の値を返します。 `1`：成功 `4`：入力パラメータの内容にエラーがある `8`：その他のシステムエラーが発生
`//response/errors`	エラーメッセージ	エラーが発生した場合、詳細なエラーメッセージが文字列で返されます。
`//response/info`	更新ログ	店舗アカウントを更新したログが文字列で出力されます。
`//response/error-lines`	エラーを無視した行番号	パラメータ `force` に `1` を指定したとき、エラーがあった行の行番号をカンマ区切りで返します。

アカウントの更新に成功した場合のレスポンスXML例

<response>
  <result>1</result>
  <info><![CDATA[
    * 1: Modifying an existing account STR00001.
    * 2: Adding a new account STR00007.
      :
  ]]></info>
</response>

上の例では、//response/result の値が 1 のため、呼び出しは成功しています。
//response/info には、更新または追加された店舗の店舗コードが返されます。

STR00001 は、既存アカウントを更新したことを示します。
STR00007 は、新規アカウントを追加したことを示します。

アカウントの更新に失敗した場合のレスポンスXML例

<response>
  <result>4</result>
  <errors><![CDATA[
    * 1: Modifying an existing account STR00001. * mail is invalid. (str00001)
    * 2: Adding a new account STR00007. * Specified group is not found. (str00007)
    * 3: Adding a new account STR00008. * sortOrder is invalid. (str00008)
      :
  ]]></errors>
</response>

上の例では、//response/result の値が 4 のため、呼び出しは失敗しています。
//response/errors には、次のようなエラーメッセージが返されます。

STR00001：メールの指定が正しくない
STR00007：指定した店舗グループが存在しない
STR00008：ソート順位の指定が正しくない

CSVファイルの仕様

店舗情報のCSVファイル仕様は次のとおりです。

〇：必須
△：追加時は必須

列名	必須	桁数	内容
id	〇	120	店舗コードを指定します。
password	△	120	平文のパスワードを指定できます。既存アカウントの更新時に空欄にした場合は、既存のパスワードを変更しません。
md5Password		120	GNU版 `crypt(3)` で生成される、 $1$ から始まるMD5ハッシュのパスワードを指定できます。`password` 列とどちらか一方を指定します。
name	△	240	店舗名を指定します。
phoneticName	△	240	店舗名ふりがなを指定します。
mail		240	メールアドレスを指定します。
mobileMail0～		240	モバイルメールアドレスを指定します。 `0,1,2...` と、最大10件まで指定できます。
postalCode1		3	郵便番号の前半を指定します。
postalCode2		4	郵便番号の後半を指定します。
address1		240	住所1を指定します。
address2		240	住所2を指定します。
telephoneNumber		120	電話番号を指定します。
facimileTelephoneNumber		120	FAX番号を指定します。
sortOrder	△	3	ソート順位を指定します。
enable		5	有効かどうかのフラグです。`TRUE` または `FALSE` を指定できます。
openDate		10	有効期間の開始日を指定します。
closeDate		10	有効期間の終了日を指定します。
group0～		480	所属する店舗グループのグループコードを指定します。グループコードを設定していない店舗グループは変更されません。例）インポート前にグループコードを設定していない店舗グループに所属していた場合：新たに指定した店舗グループと、グループコードを設定していない店舗グループに所属します。例）インポート前にグループコードを設定している店舗グループに所属していた場合：新たに指定した店舗グループにのみ所属します。
fcCompany		480	FC法人機能を使用しているとき、所属するFC法人の法人コードを指定できます。
storeAdvisor		480	店舗アドバイザー機能を使用しているとき、店舗アドバイザーとなる本部ユーザーのログインIDを指定できます。 ℹ 補足：複数の本部ユーザーを指定する場合は、複数のログインIDをスペース区切りで指定します。

文字コード

本サービスでアップロードするCSVファイルの文字コードについては、CSVファイルの仕様 を参照してください。