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

ShopServe API連携EXE ドキュメント

ShopServeと販売管理システムを連携するためのEXEについて、用途、 起動方法、引数、終了コード、エラー確認方法をまとめています。

ドキュメントのみ掲載EXE本体はS3配布最終更新: 2026-08-20

Overview

概要

このサイトの対象者

販売管理システム側の開発担当者・保守担当者向けです。 EXEの起動方法や引数仕様を含むため、エンドユーザー向けの案内ではありません。

サイトの役割

各EXEの使い方を確認するためのドキュメント置き場です。 実行ファイル、設定ファイル、ログ、認証情報は掲載しません。

配布の考え方

成果物の受け渡しは従来通りS3を使用します。 このサイトではS3配布場所と取得対象の説明のみを扱います。

Distribution

配布物の取得

S3配布場所

配布物は、事前に案内されたS3配布場所から取得してください。 取得には許可済みのIAMユーザーまたはIAMロールが必要です。

s3://共有済みの配布先/

実際のS3パスは、運用中の配布先に合わせて差し替えてください。

主な配布物

  • GetWebData.exe
  • PutPoint.exe
  • PutShipping.exe
  • GetPaymentStatus.exe
  • common.config
  • Newtonsoft.Json.dll
  • doc/

Common

共通事項

配置

各EXE、common.config、Newtonsoft.Json.dll は同じフォルダに配置してください。

ログ

ログは各EXE共通で、Logフォルダに日付別で出力されます。 1日に行われた処理は同じログファイルへ追記されます。

終了コード

正常終了時は ExitCode=0、異常終了時は ExitCode=9 です。 標準出力やログにエラー詳細が出力されるEXEがあります。

Executables

EXE別仕様

GetWebData.exe

注文情報取得

#

ShopServeから注文情報を取得し、販売管理システム側のDBへ取り込みます。起動パラメータはありません。

GetWebData.exe

補足

  • 外部プログラム、またはタスクスケジューラなどから起動して使用します。
  • 取得対象や取得位置の管理はEXE側で行います。
  • 注文、購入者、お届け先、商品、決済、ポイントなどの情報を取り込みます。
  • 取り込み結果はログ、およびDBの注文関連テーブルを確認してください。

主なエラー例

  • common.config が存在しない
  • DB接続エラー
  • API認証情報の取得失敗
  • API通信エラー
  • JSON解析エラー
  • DB登録エラー

PutPoint.exe

会員ポイント増減

#

ShopServe会員のポイントを加算、または減算します。会員ID、増減ポイント数、備考を起動パラメータで指定します。

PutPoint.exe uid=会員ID addpoint=ポイント数 note=備考

実行例

PutPoint.exe uid=testuser addpoint=200 note="連携にて加算"
PutPoint.exe uid=testuser addpoint=-200 note="連携にて減算"

補足

  • 備考 note は値なしでも送信できます。空白を含む場合は " で囲ってください。
  • バッチ処理などで連続実行する場合は、0.5秒程度のスリープ処理を入れてください。

主なエラー例

  • uid 未指定
  • addpoint 未指定
  • addpoint が数値ではない
  • addpoint=0
  • 会員が買い物中
  • ポイント合計が範囲外
  • API通信エラー

PutShipping.exe

注文届け先発送情報更新

#

ShopServe注文のお届け先発送情報を更新します。注文管理番号、お届け先番号、発送ステータス、配送業者、お問い合わせ番号などを指定します。

PutShipping.exe serial_code=注文管理番号 delivery_no=お届け先番号 [PUTパラメータ...]

実行例

PutShipping.exe serial_code=989819 delivery_no=1 shipping_status=Online delivery_company_label=YamatoTransport contact_number=1234-5678-9012 shipping_scheduled_date=2019-04-15
PutShipping.exe serial_code=989819 delivery_no=1 shipping_status=Sent delivery_company_label=YamatoTransport contact_number=1234-5678-9012
PutShipping.exe serial_code=989819 delivery_no=1 delivery_date=2019-04-18 delivery_hour_zone="午前中" delivery_date_note="不在時は宅配BOXへ"

補足

  • serial_code と delivery_no は必須です。
  • PUTパラメータは1つ以上指定してください。指定したPUTパラメータのみ更新されます。
  • 値なしのPUTパラメータは送信されません。
  • 発送ステータスは Waiting、Online、Sent を指定できます。
  • 配送業者は JapanPost、YamatoTransport、SagawaExpress、SeinoTransportation、FukuyamaTransporting、Ecohai、OtherCompany、Reset を指定できます。
  • 配送業者に Reset 以外を指定する場合、contact_number は必須です。

主なエラー例

  • serial_code 未指定
  • delivery_no 未指定
  • PUTパラメータ未指定
  • 注文管理番号、またはお届け先番号が不正
  • 対象の注文、または届け先が見つからない
  • 発送ステータスが不正
  • 配送業者名が不正
  • お問い合わせ番号が不正
  • 発送予定日、お届け希望日の形式が不正
  • 対象受注の状態により発送情報を更新できない
  • API通信エラー

GetPaymentStatus.exe

決済状況取得

#

ShopServe注文の決済状況を取得します。注文管理番号を serial_codes にカンマ区切りで指定します。

GetPaymentStatus.exe serial_codes=注文管理番号[,注文管理番号...]

実行例

GetPaymentStatus.exe serial_codes=98a01b
GetPaymentStatus.exe serial_codes=98a01b,98a01a,98zzzz

補足

  • 一度に指定できる注文管理番号は最大100件です。
  • 取得対象は payment 配下の status です。
  • 取得結果は標準出力へタブ区切り、ヘッダなしで出力します。
  • 出力形式は 注文管理番号<TAB>OK/NG<TAB>決済ステータス<TAB>メッセージ です。
  • 全件取得できた場合は ExitCode=0、1件でも取得できない注文がある場合、または内部エラー時は ExitCode=9 です。
  • 複数件の決済状況を取得する場合は、可能な範囲で serial_codes にまとめて指定してください。

主なエラー例

  • serial_codes 未指定
  • serial_codes の指定件数が100件を超過
  • 指定した注文管理番号が見つからない
  • common.config が存在しない
  • DB接続エラー
  • API認証情報の取得失敗
  • API通信エラー
  • JSON解析エラー

History

更新履歴

2026-08-20
初版作成

配布用 doc フォルダの内容をもとに、ShopServe API連携EXEの ドキュメントサイトを作成しました。