「取引セクションのAPI」とは何か
いつもお世話になっております。
スマレジ Developers の 2023/06/07 付の「お知らせ」に、以下のような告知が掲載されていました。
【仕様書修正】取引セクションのAPIについて合計(total)の式について「クーポン値引き」「端数値引額」に関する記述が漏れている箇所があったため修正しました。
ここで「取引セクションのAPI」と言及されているのは、APIドキュメントにおけるどの操作、または操作の結果与えられるレスポンスについてのものでしょうか?
当該告知の「仕様書を見る」にリンクされているプラットフォームAPI・POSのドキュメント https://www1.smaregi.dev/apidoc には、「取引セクション」という名前の操作やデータ構造は見当たらないように思います。
また、店舗運営者が用いる iOS POS アプリや、Web のPOS管理画面でも、同様にこの単語を見た覚えがありません。
(こちらについては見落としている可能性もあるかとは思いますが)
本告知が、APIドキュメント上のどの項目についての話題なのか、下記の形式で正確なパーマリンクを提供頂けないでしょうか?
https://www1.smaregi.dev/apidoc/#operation/getTransaction
よろしくお願いいたします。
答え
@kogai
いつもお世話になっております。
お問い合わせありがとうございます。
まず、混乱を招く表現をしまい、誠に申し訳ありません。
該当箇所が多かったため、API仕様書のサイドバーの「取引」のAPIのことを指して「取引セクション」と表現しておりました。
正確には下記が対象です。
・取引一覧取得 - レスポンス
・取引登録 - リクエスト
・取引取消 - レスポンス
・取引打消取消 - レスポンス
・取引会員更新 - レスポンス
・取置き一覧取得 - レスポンス
・取置き取得 - レスポンス
・取置き打消取消 - レスポンス
詳細に記載することでかえって趣旨が伝わりづらかったりするかと思い、今回は短めに記載いたしましたが、
ご指摘通り、情報の性質上、詳細に書いた方が良いと思いますので、今後は改めて参りたいと思います。
パーマリンクのことにつきましても、ご意見ありがとうございます。こちらにつきましても検討をさせていただきます。