API バージョン 2026-07 以降、Customer オブジェクトの taxSettings フィールドが公開化。チェックアウトで集めた VAT 番号などの税 ID を、アプリから読み取りクエリできるようになる。
taxSettings フィールドが Admin GraphQL API で公開される。顧客の税 ID はチェックアウトで集めても、Admin GraphQL API の Customer から公開クエリできなかった。
customer { taxSettings { taxId } } で税 ID を取得できる。読み取り専用の変更。
| フィールド | 内容 | 公開 API での扱い |
|---|---|---|
| taxSettings | Customer オブジェクト配下の税設定コンテナ | 公開 2026-07〜 |
| taxSettings.taxId | 税 ID(VAT 番号など)。文字列、または未提供なら null |
取得可 read-only |
| taxSettings.taxIdValidation | 税 ID の検証ステータスを示すサブフィールド | 公開 API に含まれない |
read_customers または read_taxes のアクセススコープを持つアプリで taxId をクエリできる。
検証ステータスを使いたいアプリは、承認済みの保護対象顧客データアクセスを持つ必要がある(公開 API には未収録)。
Customer.taxSettings は、B2B 向けにすでに提供されている CompanyLocation.taxSettings.taxRegistrationId(API バージョン 2025-01〜)と整合する形で追加される。
| 対象 | フィールド | 提供開始 |
|---|---|---|
| B2B 法人ロケーション | CompanyLocation.taxSettings.taxRegistrationId |
API 2025-01〜 |
| 通常顧客 Customer | Customer.taxSettings.taxId |
API 2026-07〜(今回) |
これまで法人ロケーション側でしか取れなかった税登録情報が、通常の Customer 側でも同じ taxSettings 構造で扱えるようになる。
taxId は文字列、または顧客が未提供なら null を返す。クライアント側は必ず null を想定したハンドリングを行うこと。この公開は API バージョン 2026-07 以降が前提。アプリのターゲット API バージョンを上げないと taxSettings は利用できない。
read_customers または read_taxes のいずれかがあれば taxId をクエリできる。
これは read-only な変更。API 経由で税 ID を書き込み・更新する用途ではない。値の発生源はチェックアウト。
taxId は文字列か null。顧客が税 ID を提供していなければ null が返るため、欠損前提で実装する。
検証ステータスを示す taxIdValidation サブフィールドは公開 API に含まれない。アクセスするには承認済みの保護対象顧客データ(protected customer data)アクセスが必須。「番号が検証済みか」を知りたい要件は、この権限取得の有無で実現可否が分かれる。
customer { taxSettings { taxId } } をクエリし、請求・会計システムへ自動で渡す。read_customers か read_taxes が必要。read-only。null(未提供)時の分岐を必ず用意。taxId の値 / null をシグナルにして、対象顧客のフローやコミュニケーションを分岐させる。taxIdValidation が必要だが公開 API に無いため、この判定には保護対象顧客データアクセスが別途必要。番号の有無だけならスコープのみで判定可。CompanyLocation.taxSettings.taxRegistrationId(2025-01〜)で B2B 法人ロケーションの税登録番号だけ扱っていて、通常 Customer の税 ID が取れなかった。Customer.taxSettings.taxId を取り込み、B2B / 通常顧客の両方を同じ taxSettings 構造で処理する。taxSettings で整合する設計なので、フィールドマッピングを揃えやすい。対象 API バージョンの差(2025-01 / 2026-07)に注意。Customer.taxSettings.taxId で読み取り取得できる。read_customers か read_taxes、read-only。