取引明細取得について

カテゴリ: API共通

初心者のため見当違いのことを聞いていたら申し訳ありません。

POSの取引情報をAPIで取得したいのですが、仕様書には取引明細情報を付加するかについて、以下の様な記述がありました。

--------------------------------

 大量に取引及び取引明細データを取得する際のご注意

with_detailsに none 以外を指定して、下記のケースのような大量の取引データの取得処理を実行すると、弊社サーバが高負荷になり、処理に影響が出る場合がございます。

  ・大量の取引・取引明細の取得

  ・日次バッチなど、毎日定まった期間の取引を取得する処理

上記のようなケースについては、

  ・取引についてはwith_details=noneで本APIを複数回コールして取得(最大で1コールで1000件取得)

  ・取引明細については取引明細一覧CSV作成APIで必要期間分コールして取得 (取引明細データを最大1ヶ月分取得)

上記の2つのAPIを組み合わせてご利用いただきますようお願いいたします。

--------------------------------

具体的にどれぐらいのデータ量から取引明細一覧CSV作成APIを使用するのを検討したらいいのでしょうか。

また、取引明細取得API(/transactions/{id}/details)はどのような場合に使用するのでしょうか。

よろしくお願いします。

答え

  • @tabata

    具体的にどれぐらいのデータ量から取引明細一覧CSV作成APIを使用するのを検討したらいいのでしょうか。
    

    取引件数3000程を目安にしていただければと存じます。


    また、取引明細取得API(/transactions/{id}/details)はどのような場合に使用するのでしょうか。
    よろしくお願いします。
    

    取引明細取得APIのリクエストでは取引IDの指定が必要なため、特定の取引明細を取得したい場合にご利用いただくことが多いかと存じます。