カレンダーに売上データを表示する設定をしているときに、各店舗および本部の売上データをAPIで連携することができます。
売上の予算と実績を管理している販売管理システムなどから、自動的に売上データを更新することが可能です。
呼び出し先URL
{your-domain} の部分をご利用の環境にあわせて変更してください。
https://{your-domain}/h2/STRSalesLedgerManipurator.doリクエスト
| パラメータ | 意味 | 必須 | 制約 |
|---|---|---|---|
func | 動作モード | 〇 | 必ず update を指定します。 |
key | WebAPIキー | 〇 | 売上データ更新APIが利用可能なWebAPIキーを指定します。 |
csvFile | 売上データのCSVファイル | 〇 | 売上データのCSVファイルを指定します。CSVファイルの形式は、Web画面でアップロードするCSVファイルと同一です。CSVファイルのフォーマットは、*1.売上データのCSVファイル仕様 を参照してください。 |
補足事項
ファイルのアップロードが必須なため、フォームのPOST時には必ず multipart/form-data 形式で送信する必要があります。
レスポンス
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="num-data" type="xsd:int" minOccurs="0" maxOccurs="1"/>
</xsd:sequence>
</xsd:element>
</xsd:schema>
| 要素 | 意味 | 備考 |
|---|---|---|
//response/result | リザルトコード | 以下の値をとります。1: 成功4: 入力パラメータの内容にエラーがある8: その他のシステムエラーが発生 |
//response/errors | エラーメッセージ | エラーが発生した場合は、詳細なエラーメッセージが文字列として返されます。 |
//response/num-data | 登録した件数 | CSVファイルで登録された件数が返されます。 |
売上データの更新に成功した場合のレスポンスXMLの例
<response>
<result>1</result>
<num-data>24</num-data>
</response>
上の例では、//response/result の値が 1 なので呼び出しは成功しており、//response/num-data に登録した件数が返されます。