取引一覧取得APIの"fields(検索パラメータ)"の使用方法について

株式会社ティーエスアイ

お世話になっております。

取引一覧取得APIで、terminalTranId(端末取引ID)が特定の値の検索を

行いたいと考えています。

QUERY PARAMETERS に"fields(検索パラメータ)"という項目があるので、

これを使用すれば検索可能なように思いますが、URLにどのように

記述すれば良いか分かりません。

"fields(検索パラメータ)" についての認識は正しいでしょうか？

正しければ、URLの具体例をお教え頂けませんでしょうか？

以上、お手数をお掛け致しますが、ご回答の程よろしくお願い致します。

スマレジ 大橋

お問い合わせいただき有難うございます。

申し訳ございませんが、現状、取引一覧取得においてterminalTranId での絞り込み機能はございません。

なお、fields は、検索結果の取引レコードのうち、どのフィールド（仕様書の Responses - RESPONSE SCHEMAに記載のフィールド）をレスポンスに含めるか、を指定していただくパラメータとなっております。

恐れ入りますが、もし特定の端末の特定の terminalTranId の取引を取得されたい場合は、店舗ID store_id検を QUERY PARAMETERS に含め、さらにterminalId`、`terminalTranId をQUERY PARAMETERSのfieldsに含めて検索をしていただき、取得後のプログラム側で絞り込みを行っていただくようお願いいたします。

【リクエスト例】

/pos/transactions?fields=terminalId,terminalTranId,{その他、取得されたいフィールド名（カンマ区切り）}&store_id={端末が所属する店舗のID}

（仕様書のうち、 `QUERY PARAMETERS` の page より下に記載されているパラメータが、検索条件に指定可能なパラメータとなっていますので、 `store_id` をクエリパラメータに指定していただければ可能です。）

https://www1.smaregi.dev/apidoc/#operation/getTransaction

どうぞよろしくお願いいたします。

株式会社ティーエスアイ

スマレジ　大橋様

分かりました。

丁寧にご回答頂き、ありがとうございます。