店舗グループのインポート – Shopらんサポートサイト

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

呼び出し先URL

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

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

リクエスト

パラメータ名	意味	必須	制約・説明
`func`	動作モード	〇	必ず `importCsv` を指定します。
`key`	WebAPIキー	〇	アカウント管理APIが利用可能な WebAPIキーを指定します。
`csv`	CSVファイル	〇	店舗グループ情報の CSV ファイルを指定します。
`force`	エラーを無視してインポートを実施するか		`1` または `0` を指定します。 `1` : エラーとなったデータを無視し、追加・変更が可能なデータのみインポートを実施します。 `0` : エラーとなったデータが存在する場合、追加・変更が可能なデータも含めてインポートを実施しません。 `force=1` の場合、エラーとなったデータは、レスポンスの `info` にエラー内容が出力されると同時に、`error-lines` に行番号が出力されます。`force` のデフォルトは `0` です。
`revive`	削除済みのグループを復活するかどうか		指定されたグループコードの店舗グループが現在は存在しない場合に、削除済みグループを復活させるかどうか指定します。 `1` : 削除されたグループに同一のグループコードのグループがあれば復活します。複数存在する場合には最後に更新されたグループを復活します。 `0` : 新しく店舗グループを追加します。 `revive` のデフォルトは `0` です。

注意事項

グループのインポートは差分ではなく全件対象 です。CSV ファイルには 全グループの情報 を登録してください。
CSV ファイルに存在しないグループは削除されます。

レスポンス

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 group AREA00001.
    * 2: Adding a new group AREA00007.
      :
  ]]></info>
</response>

説明

//response/result の値が 1 なので、呼び出しは成功しています。
//response/info には、更新・追加された店舗グループのグループコードが返されます。
例では、AREA00001 は既存の店舗グループを更新、AREA00007 は新規追加を示します。

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

<response>
  <result>4</result>
  <errors><![CDATA[
    * 1: Modifying an existing group AREA00001.
    * 2: Adding a new group AREA00007. * sortOrder is invalid (AREA00007)
      :
  ]]></errors>
</response>

説明

//response/result の値が 4 なので、呼び出しは失敗しています。
//response/errors には、エラー内容が返されます。
例では、グループコード AREA00007 の店舗グループは、ソート順位の指定が正しくない ためエラーになったことを示しています。

CSVファイルの仕様

店舗グループ情報の CSV ファイル仕様は以下の通りです。

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

列名	必須	桁数	内容
`id`	〇	120	グループコードを指定します。WebAPI で登録するグループにはすべてグループコードが必要です。グループコードの指定がない店舗グループは、WebAPI からの呼び出しで更新できません。
`name`	△	240	グループ名を指定します。
`phoneticName`	△	240	グループ名ふりがなを指定します。
`sortOrder`	△	3	ソート順位
`parentGroup`		120	グループが階層構造を持つ場合に、このグループの上位グループコードを指定します。
`colors0～`		120	環境の分割機能を使用しているとき、店舗グループが所属する区分を指定できます。
`areaManager0～`		120	エリアなどを表すグループの場合、エリアマネージャーとなる本部ユーザーのログインIDを指定できます。このエリアに対して複数の本部ユーザーがエリアマネージャーとして担当している場合は、複数回指定できます。

文字コード

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