目次

１．基本情報

顧客データに対してメタデータの追加更新を行う。

項目名 内容
アクション名 upsertCustomerMetafields
リクエストメソッド POST

２．リクエストに必要な内容

項目名 内容 必須 フォーマット 入力例 備考
metafields メタフィールド情報 はい 配列
L type 登録するタイプ はい jsonまたはsingle_line_text_field json
single_line_text_field json指定でvalueがjsonフォーマットでない場合、エラーになる。
L key 登録するkey はい 1文字以上の任意の文字列。 customer-1 登録ずみのkeyを指定すると更新になる。
L value 登録する値 はい 1文字以上の任意の文字列。
type=json:
{ \\"json-1\\": \\"ddd\\" }
type=single_line_text_field:
custom-value { \"json-1\": \"ddd\" }
custom-value

３．レスポンス内容

顧客メタデータの登録更新結果が返却される。

■正常時レスポンス

プロパティ 型 説明
success boolean 更新結果
※ エラーの場合はステータスコードが200以外となるため必ずTrueが返却されます

■異常時レスポンス

ステータスコード 型 エラーメッセージ
400 string リクエストパラメーターのtype, valueの組み合わせが正しくない場合などは、下記のようなShopifyから返却されたエラーメッセージが返却されます
例)
Value is invalid JSON: unexpected token at 'a'.
404 string ストアが存在しません
404 string 顧客が存在しません
500 string 内部エラーが発生しています