販売管理システム開発・保守担当者向け

ShopServe API連携EXE 目録

ShopServe APIと販売管理システムを連携するためのEXEについて、配布物の取得場所、共通事項、各EXEの詳細ドキュメントをまとめています。

README

この資料について

対象者

この資料は、販売管理システム側の開発担当者・保守担当者向けです。各EXEは販売管理プログラムから呼び出して使用する連携部品です。エンドユーザーが直接操作するものではありません。

配布用フォルダ直下には、ShopServe APIと販売管理システムを連携するためのEXEを格納しています。各EXEの詳細な起動方法や引数仕様は、下のEXE別解説を参照してください。

Distribution

配布物の取得

配布場所

配布物は以下の場所に配置しています。 AWSにログインしてから開いてください。

配布場所を開くhttps://ap-northeast-1.console.aws.amazon.com/s3/buckets/wkv-public-share?region=ap-northeast-1&prefix=shopservetool/

配布用フォルダ直下の主なファイル

GetWebData.exe
PutPoint.exe
GetPoint.exe
PutShipping.exe
GetPaymentStatus.exe
GetUnimportedOrders.exe
ReqPayment.exe
common.config
Newtonsoft.Json.dll

SHA-256

配布ファイルの確認用ハッシュ値

以下は配布用フォルダ直下のファイルのSHA-256ハッシュ値です。ダウンロード後のファイル確認に使用してください。

ファイル名	SHA-256
GetWebData.exe	9E0BA103C4192D4AE98B9F3DACBA8F5F10A46DFEBA7CCCAAF340E8E19805AE74
PutPoint.exe	88DAAD58DCB8BE37589D2F3D2CFDE0B81A350100EDFC795B3B5B1CA8CC01008D
GetPoint.exe	104EC5F5E2D5F98803D98CAEF141709A898E914B75BB459690407888A40B832D
PutShipping.exe	9D2BA3F1ECF0F4D0EF8D41679773BD900A5333235F6B1778406A17EB329B58F9
GetPaymentStatus.exe	23B426613C96A3A08AD28D862D1D7DDB01B16203C8987144407C1949B837DDDD
GetUnimportedOrders.exe	ED430FC36118608D631BE0805EA871D2BBF702E1BD5CAE6B1208D6572B16A246
ReqPayment.exe	988EAE495C36D9879574ACDDED491796B8CCEC8B993B293C21C0235931F5C7D6
common.config	24E287965D8C63F062129AEAB9725FCD147EBB95C9BF666FE26FABC48B7A811A
Newtonsoft.Json.dll	E1E27AF7B07EEEDF5CE71A9255F0422816A6FC5849A483C6714E1B472044FA9D

詳細を開く

Guide

呼び出し実装例

VB.NET呼び出し例

販売管理システムから各EXEを呼び出す場合のVB.NET実装例です。

実装例を開く

Common

共通事項

配置

各EXE、common.config、Newtonsoft.Json.dll は同じフォルダに配置してください。 common.config は各EXEが共通で使用する設定ファイルです。

ログ

ログは各EXE共通で、EXE配置フォルダ配下の Log フォルダに日付別で出力されます。同じ日に実行された各ShopServe API連携EXEのログは、同じ日付ファイルに追記されます。

終了コード

正常終了時は ExitCode=0、異常終了時は ExitCode=9 です。

異常終了時のログ自動送信

各EXEは、内部エラーにより ExitCode=9 で終了する場合、今回の実行範囲のログを調査用として自動送信します。正常終了時、およびShopServe APIから正常に回答された業務上のNGでは送信しません。自動送信の成否にかかわらず、標準出力および終了コードの内容は変わりません。通信状況によっては、異常終了時に最大30秒程度の待ち時間が発生する場合があります。自動送信に失敗した場合も、従来の日付別ログはそのまま残ります。送信されるのは今回の実行範囲のログだけで、既存の日付別ログが送信・変更・削除されることはありません。

標準出力と終了コードについて

各EXEは ExitCode=0 を正常終了、ExitCode=9 を異常終了とします。ただし、標準出力の用途はEXEにより異なります。

PutPoint.exe / PutShipping.exe

正常終了時は標準出力を出力しません。 ExitCode<>0 の場合、ShopServe APIから返されたエラー理由、または内部エラーメッセージを標準出力に出力します。

GetWebData.exe

標準出力は出力しません。実行結果やエラー内容はログ、およびDBの注文関連テーブルを確認してください。

GetPaymentStatus.exe / ReqPayment.exe / GetPoint.exe

API呼び出しに成功し、明細結果を作成できた場合は、標準出力に明細結果を出力します。明細内に NG が含まれていても、処理全体が正常に完了していれば ExitCode=0 です。 ExitCode<>0 の場合は、標準出力に SYSTEM 行として内部エラー理由を出力します。

GetUnimportedOrders.exe

API呼び出しおよび必要なDB照合に成功した場合は、標準出力に注文情報をタブ区切りで出力します。該当する注文がない場合、標準出力は空です。 ExitCode<>0 の場合は、標準出力に内部エラー理由を1行で出力します。

History

更新履歴

プログラムの追加・変更、およびドキュメントサイトの更新を記載します。

2026-09-30

GetUnimportedOrders.exe を追加

ShopServeから指定会員の注文を検索し、DBに存在しない未取り込み注文を取得する機能に対応しました。

配布ファイルの確認用ハッシュ値を更新

GetUnimportedOrders.exe を含む配布用フォルダ直下のファイルについて、SHA-256ハッシュ値を更新しました。

2026-09-09

全EXEを変更

内部エラーにより ExitCode=9 で終了する場合、今回の実行範囲のログを調査用として自動送信する機能を追加しました。標準出力および終了コードの仕様は従来どおりです。

配布ファイルの確認用ハッシュ値を追加

配布用フォルダ直下のファイルについて、SHA-256ハッシュ値を掲載しました。

2026-09-02

PutPoint.exe を変更

異常終了時に標準出力へ出力するエラー理由の扱いを見直しました。

PutShipping.exe を変更

異常終了時に標準出力へ出力するエラー理由の扱いを見直しました。

2026-09-01

GetPoint.exe を追加

ShopServe会員ポイントの取得に対応しました。

呼び出し実装例を追加

販売管理システムから各EXEを呼び出す場合のVB.NET実装例を追加しました。

2026-08-31

ReqPayment.exe を追加

ShopServe注文の決済依頼に対応しました。

2026-08-21

ドキュメントサイトを初版公開

販売管理システム側の開発・保守担当者向けに、連携EXEのドキュメントサイトを公開しました。

GetPaymentStatus.exe を追加

ShopServe注文の決済状況取得に対応しました。

2026-07-31

PutShipping.exe を追加

ShopServe注文のお届け先発送情報更新に対応しました。

2026-05-28

PutPoint.exe を追加

ShopServe会員ポイントの加算・減算に対応しました。

2026-03-31

GetWebData.exe を追加

ShopServe注文情報の取得とDB取り込みに対応しました。

Handling

ドキュメントの扱い

docフォルダ内のドキュメント類は、販売管理システム側の開発担当者・保守担当者向けです。 EXEの起動方法や引数仕様を含むため、エンドユーザーには配布しないでください。