Admin rest apiを利用して customer metafieldを更新したい

日本語 ディスカッション 技術的なQ＆A

Topic summary

Admin REST APIを使用してcustomer metafieldを更新しようとしているが、200レスポンスは返るものの実際には更新されない問題が発生。

試した方法:

  • エンドポイント: /admin/api/2023-01/customers/{customer.id}.json
  • APIスコープ: write_customers、read_customers
  • PUTメソッドでmetafieldsを含むペイロードを送信

判明した仕様と解決策:

  1. 空のmetafieldは更新可能 - 初期状態（値が入っていない）のmetafieldはAPIで更新できる

  2. 既存値があると更新不可 - すでに値が入っているmetafieldは更新できない仕様の可能性

  3. 代替手段 - customer.noteやcustomer.tagsを使用する方法もある

  4. 最終的な解決方法 - 各ユーザーに紐づいた固有のmetafield IDを指定する必要がある。メタフィールド定義IDではなく、「ユーザー × メタフィールド」ごとに生成される個別のIDをペイロードに含めることで更新が可能になる。このIDはLiquidなどで表示させて確認できる。

Summarized with AI on November 15. AI used: claude-sonnet-4-5-20250929.
4

最近解決したので、返信させていただきます。

メタフィールドを作成すると、ユーザー x メタフィールド ごとに固有のIDが生成されるので、それを一緒に送ると更新されました。

注意点は、メタフィールドの定義IDではなく、各ユーザーに紐づいたメタフィールドIDになります。

このIDを画面上で確認するのは難しいので、liquid などでユーザーのメタフィールドを表示させれて合わせてIDを出すとわかるかと思います。

{
          id: ${number}
          key: metafieldKey_02,
          value: newValue,
          value_type: 'single_line_text_field',
          namespace: metafieldNamespace_02,
        },
1 Like