取引取得APIの振る舞いの変更

カテゴリ: POS

いつもお世話になっております。


プラットフォームAPI・POSの取引取得APIについて質問です。

従来こちらのAPIの returnAmount は、「その取引に値が存在すればその値を、存在しなければ '0' を返す」挙動になっていたかと思います。

こちらのフィールドは、ドキュメント上では nullability の指定がなく、従って null もしくは undefined で扱われることもあり得ると想定していますが、現実のデータによる観測・及び現時点でのサンドボックス環境での振る舞いにおいては、上記の挙動であるように観察しております。

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


本日 15:40 ころより、このフィールドの挙動が、「その取引に値が存在すればその値を、存在しなければ null を返す」ように変更されているように見受けられました。


こちらはプラットフォームAPIの想定する挙動として、意図したものなのでしょうか?

答え

  • @kogai

    確認しましたが、仕様の変更はありませんでした。


    returnAmount が存在しないとき(返品数量合計 0)にセットされる値について

    例えば通常取引(transactionHeadDivision: 1)の場合は 0 、

    ポイント加算(transactionHeadDivision: 6)の場合は null となっております。

    このように取引区分等により入る値が異なっていますが、仕様通りの挙動となります。