👩‍💻

【Shopify.dev和訳】Storefront API/Reference/Customers

2021/10/23に公開

API

Shopify

GraphiQL

tech

この記事について

この記事は、Storefront API/Reference/Customersの記事を和訳したものです。

記事内で使用する画像は、公式ドキュメント内の画像を引用して使用させていただいております。

Shopify アプリのご紹介

Shopify アプリである、「商品ページ発売予告アプリ | リテリア Coming Soon」は、商品ページを買えない状態のまま、発売日時の予告をすることができるアプリです。Shopify で Coming Soon 機能を実現することができます。

Shopify アプリである、「らくらく日本語フォント設定｜リテリア Font Picker」は、ノーコードで日本語フォントを使用できるアプリです。日本語フォントを導入することでブランドを演出することができます。

Customer API

顧客の作成と管理

In this section

Customer - カスタマーは、ショップのカスタマーアカウントを表します。カスタマーアカウントには顧客の連絡先情報が保存され、ログインした顧客がチェックアウトのたびに連絡先情報を入力する手間を省くことができます。
CustomerAccessToken -CustomerAccessToken は、カスタマーオブジェクトを変更するために必要な固有のトークンを表します。
CustomerAccessTokenCreateInput - カスタマーアクセストークンの作成に必要な入力フィールドを指定します。
CustomerActivateInput - カスタマーをアクティブにするために必要な入力フィールドを指定します。
CustomerCreateInput - 新しいカスタマーを作成するために必要なフィールドを指定します。
CustomerResetInput - カスタマーのパスワードをリセットするために必要なフィールドを指定します。
CustomerUpdateInput - カスタマー情報を更新するために必要なフィールドを指定します。
customerAccessTokenCreate - カスタマーアクセストークンを作成します。カスタマーアクセストークンは、Customer オブジェクトを何らかの方法で変更する際に必要です。
customerAccessTokenCreateWithMultipass - 電子メールとパスワードの代わりにマルチパストークンを使用してカスタマーアクセストークンを作成します。customer が存在しない場合は、顧客レコードが作成されます。customer レコードがすでに存在していて、そのレコードが無効になっている場合は、有効になります。
customerAccessTokenDelete - カスタマーアクセストークンを永久的に破棄します。
customerAccessTokenRenew - 顧客のアクセストークンを更新します。アクセストークンの更新は、トークンの有効期限が切れる前に行う必要があります。トークンがすでに期限切れになっている場合は、代わりに customerAccessTokenCreate で新しいトークンを作成する必要があります。
customerActivate - カスタマーをアクティブにします。
customerActivateByUrl - customerCreate から受け取ったアクティベーション URL で顧客をアクティベートします。
customerAddressCreate - 顧客の新しい住所を作成します。
customerAddressDelete - 既存の顧客のアドレスを永久に削除します。
customerAddressUpdate - 既存のお客様のアドレスを更新します。
customerCreate -新規のお客様を作成します。
customerDefaultAddressUpdate - 既存のお客様のデフォルトアドレスを更新します。
customerRecover - パスワードリセットプロセスの最初のステップとして、リセットされたパスワードの電子メールを顧客に送信します。
customerReset - CustomerRecover から受け取ったトークンで顧客のパスワードをリセットします。
customerResetByUrl - CustomerRecover から受け取ったリセットパスワードの URL を使って、お客様のパスワードをリセットします。
customerUpdate - 既存の顧客を更新します。

OBJECTS

Customer(`objects`)

カスタマーは、ショップのカスタマーアカウントを表します。カスタマーアカウントには、顧客の連絡先情報が保存され、ログインしている顧客は、チェックアウトのたびに連絡先情報を入力する手間が省けます。

接続

addresses (MailingAddressConnection!)
顧客のアドレスのリスト。

引数	説明
`after` ( `String` )	指定されたカーソルの後にある要素を返します。
`before` ( `String` )	指定されたカーソルの前にある要素を返します。
`first` ( `Int` )	リストから最初の `n` 個の要素までを返します。
`last` ( `Int` )	リストから最後の `n` 個の要素までを返します。
`reverse` ( `Boolean` )	対象となるリストの順序を逆にします。デフォルト値：`false`

metafields (MetafieldConnection!)
リソースに関連するメタフィールドのページングされたリスト。

引数	説明
`after` ( `String` )	指定されたカーソルの後にある要素を返します。
`before` ( `String` )	指定されたカーソルの前にある要素を返します。
`first` ( `Int` )	リストから最初の `n` 個の要素までを返します。
`last` ( `Int` )	リストから最後の `n` 個の要素までを返します。
`namespace` ( `String` )	メタフィールドのセットのためのコンテナ（最大 20 文字）
`reverse` (`Boolean`)	対象となるリストの順序を逆にします。デフォルト値：`false`
`orders` (`OrderConnection!`)	顧客に関連する注文。

引数	説明
`after` ( `String` )	指定されたカーソルの後にある要素を返します。
`before` ( `String` )	指定されたカーソルの前にある要素を返します。
`first` ( `Int` )	リストから最初の `n` 個の要素までを返します。
`last` ( `Int` )	リストから最後の `n` 個の要素までを返します。
`query` ( `String` )	サポートされるフィルタパラメータ。 `processed_at`フィルターの使用方法については、詳細な検索構文を参照してください。
reverse ( Boolean )	対象となるリストの順序を逆にします。デフォルト値：`false`
`sortKey` ( `OrderSortKeys` )	対象となるリストの順序を逆にします。デフォルト値：`false`

フィールド

acceptsMarketing (Boolean!)
顧客が電子メールでマーケティング資料を送信することに同意したかどうかを示す。
createdAt (DateTime!)
顧客が作成された日付と時間。
defaultAddress (MailingAddress)
顧客のデフォルトアドレス。
displayName (String!)
顧客の名前、E メール、または電話番号。
email (String)
顧客の電子メールアドレス。
firstName (String)
顧客のファーストネーム。
id (ID!)
お客さまの一意の識別子。
lastIncompleteCheckout (Checkout)
お客様の直近に更新された、不完全なチェックアウト。
lastName (String)
顧客のラストネーム。
metafield (Metafield)
名前空間とキーで見つかったメタフィールドを返します。

引数	説明
`key` ( `String!` ) `required`	メタフィールドの識別子（最大 30 文字）。
`namespace` ( `String!` ) `required`	メタフィールドのセットのためのコンテナ（最大 20 文字）。

phone (String)
お客様の電話番号です。
tags ([String!]!)
カスタマーに追加されたタグのコンマ区切りリスト。

!

必要なアクセス
unauthenticated_read_customer_tagsのアクセス・スコープ。
updatedAt (DateTime!)
顧客情報が更新された日付と時間。

Customer を返す型

QueryRoot.customer

Customer に対するミューテーション

customerActivate
カスタマーをアクティブにします。
customerActivateByUrl
customerCreate から受け取ったアクティベーション URL で顧客をアクティベートします。
customerAddressCreate
顧客の新しい住所を作成します。
customerAddressDelete
既存の顧客のアドレスを永久に削除します。
customerAddressUpdate
既存の顧客の住所を更新します。
customerCreate
新規顧客を作成します。
customerDefaultAddressUpdate
既存のカスタマーのデフォルトアドレスを更新します。
customerRecover
パスワード再設定プロセスの最初のステップとして、パスワード再設定の電子メールを顧客に送信します。
customerReset
CustomerRecover から受け取ったトークンで顧客のパスワードをリセットします。
customerResetByUrl
CustomerRecover から受け取ったリセットパスワード URL で顧客のパスワードをリセットします。
customerUpdate
既存の顧客を更新します。

インプリメンツ

HasMetafields

CustomerAccessToken(`objects`)

CustomerAccessToken は、customer オブジェクトに変更を加えるために必要な固有のトークンを表します。

フィールド

accessToken (String!)
顧客のアクセストークン。
expiresAt (DateTime!)
顧客のアクセストークンが期限切れになる日付と時刻。

CustomerAccessToken の mutation

customerAccessTokenCreate
カスタマーアクセストークンを作成します。カスタマーアクセストークンは、カスタマーオブジェクトを何らかの方法で変更する際に必要です。
customerAccessTokenCreateWithMultipass
電子メールとパスワードの代わりにマルチパス・トークンを使用してカスタマー・アクセストークンを作成します。customer が存在しない場合は、customer レコードが作成されます。customer レコードがすでに存在していて、そのレコードが無効になっている場合は、有効になります。
customerAccessTokenDelete
カスタマーアクセストークンを永久的に破棄します。
customerAccessTokenRenew
顧客のアクセストークンを更新します。

アクセストークンの更新は、トークンの有効期限が切れる前に行う必要があります。トークンがすでに期限切れになっている場合は、代わりに customerAccessTokenCreate で新しいトークンを作成する必要があります。

MUTATION

customerAccessTokenCreate(`mutation`)

カスタマーアクセストークンを作成します。カスタマーアクセストークンは、カスタマーオブジェクトを何らかの方法で変更する際に必要です。

インタラクティブな例

これは、ミューテーションクエリの例です。このクエリを編集するには、以下の埋め込みインタラクティブツールを使用します。

ヒント：フィールドを自動補完するには、Ctrl + Spaceを使用してください。

mutation customerAccessTokenCreate($input: CustomerAccessTokenCreateInput!) {
  customerAccessTokenCreate(input: $input) {
    customerAccessToken {
      accessToken
      expiresAt
    }
    customerUserErrors {
      code
      field
      message
    }
  }
}

Variable

"input": {
    "email": "user@example.com",
    "password": "HiZqFuDvDdQ7"
  }
}

引数

引数	説明
`input` ( `CustomerAccessTokenCreateInput!` ) `required`	カスタマーアクセストークンの作成に使用されるフィールドです。

CustomerAccessTokenCreateInput フィールド

email (String!) Required
顧客に関連付けられた電子メール。
password (String!) Required
顧客が使用するログインパスワード。

フィールドを返す

customerAccessToken (CustomerAccessToken)
新しく作成されたカスタマーアクセストークンオブジェクト。
customerUserErrors ([CustomerUserError!]!)
変異を実行した際に発生したエラーのリスト。

非推奨のリターンフィールド

userErrors ([UserError!]!) deprecated
変異を実行した際に発生したエラーのリストです。

CustomerAccessTokenCreateWithMultipass(`mutation`)

電子メールとパスワードの代わりにマルチパス・トークンを使用して顧客アクセストークンを作成します。customer が存在しない場合は、customer レコードが作成されます。カスタマーレコードがすでに存在していて、そのレコードが無効になっている場合は有効になります。

インタラクティブな例

これは、mutation クエリの例です。このクエリを編集するには、下に埋め込まれたインタラクティブツールを使用します。

ヒント：フィールドを自動補完するには、Ctrl + Spaceを使用してください。

mutation customerAccessTokenCreateWithMultipass($multipassToken: String!) {
  customerAccessTokenCreateWithMultipass(multipassToken: $multipassToken) {
    customerAccessToken {
      accessToken
      expiresAt
    }
    customerUserErrors {
      code
      field
      message
    }
  }
}

Variables

{
  "multipassToken": "ae0f1d2e179c9571122a0595a6ac8125"
}

引数

引数	説明
`multipassToken` ( `String!` ) `required`	認証される有効なマルチパス・トークン。

フィールドを返す

customerAccessToken (CustomerAccessToken)
カスタマーに関連付けられたアクセストークンオブジェクト。
customerUserErrors ([CustomerUserError!]!)
変異を実行した際に発生したエラーのリスト。

customerAccessTokenDelete(`mutation`)

カスタマーアクセストークンを永久的に破棄します。

インタラクティブな例

これは、mutation クエリの例です。このクエリを編集するには、下に埋め込まれたインタラクティブツールを使用します。

ヒント：フィールドを自動補完するには、Ctrl + Spaceを使用してください。

mutation customerAccessTokenDelete($customerAccessToken: String!) {
  customerAccessTokenDelete(customerAccessToken: $customerAccessToken) {
    deletedAccessToken
    deletedCustomerAccessTokenId
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "customerAccessToken": "ae0f1d2e179c9571122a0595a6ac8125"
}

引数	説明
`customerAccessToken` ( `String!` ) `required`	顧客の識別に使用されるアクセストークン。

戻り値のフィールド

deletedAccessToken (String)
破壊されたアクセストークン。
deletedCustomerAccessTokenId (String)
破壊されたカスタマーアクセストークンの ID。
userErrors ([UserError!]!)
変異を実行して発生したエラーのリストです。

customerAccessTokenRenew(`mutation`)

顧客のアクセストークンを更新します。

アクセストークンの更新は、トークンの有効期限が切れる前に行う必要があります。アクセストークンがすでに期限切れになっている場合は、代わりにcustomerAccessTokenCreateで新しいトークンを作成する必要があります。

インタラクティブな例

これは、mutation クエリの例です。このクエリを編集するには、下に埋め込まれたインタラクティブツールを使用します。

ヒント：フィールドを自動補完するにはCtrl + Spaceを使います。

mutation customerAccessTokenRenew($customerAccessToken: String!) {
  customerAccessTokenRenew(customerAccessToken: $customerAccessToken) {
    customerAccessToken {
      accessToken
      expiresAt
    }
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "customerAccessToken": "ae0f1d2e179c9571122a0595a6ac8125"
}

引数	説明
`customerAccessToken` ( `String!` ) `required`	顧客の識別に使用されるアクセストークン。

フィールドを返す

customerAccessToken (CustomerAccessToken)
更新されたカスタマーアクセストークンオブジェクト。
userErrors ([UserError!]!)
変異を実行した際に発生したエラーのリスト。

CustomerActivate(`mutation`)

顧客をアクティベートします。

インタラクティブな例

これは、ミューテーション・クエリの例です。このクエリを編集するには、以下の埋め込みインタラクティブツールを使用します。

ヒント：フィールドを自動補完するには、Ctrl + Spaceを使用してください。

mutation customerActivate($id: ID!, $input: CustomerActivateInput!) {
  customerActivate(id: $id, input: $input) {
    customer {
      id
    }
    customerAccessToken {
      accessToken
      expiresAt
    }
    customerUserErrors {
      code
      field
      message
    }
  }
}

Variables

{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
  "input": {
    "activationToken": "ae0f1d2e179c9571122a0595a6ac8125",
    "password": "HiZqFuDvDdQ7"
  }
}

引数

引数	説明
`id` ( `ID!` ) `required`	アクティブにするカスタマーを指定します。
`input` ( `CustomerActivateInput!` ) `required`	カスタマーをアクティブにするために使用されるフィールドを指定します。

CustomerActivateInput フィールド

activationToken (String!) Required
カスタマーをアクティブにするために必要なアクティベーション・トークン。
password (String!) Required
アクティベーション時に設定される新しいパスワード。

戻り値のフィールド

customer (Customer)
カスタマーオブジェクト。
customerAccessToken (CustomerAccessToken)
カスタマー用に新しく作成されたカスタマーアクセストークンオブジェクト。
customerUserErrors ([CustomerUserError!]!)
変異を実行して発生したエラーのリストです。

非推奨のリターンフィールド

userErrors ([UserError!]!) deprecated
変異を実行した際に発生したエラーのリストです。
!

非推奨の警告
代わりに customerUserErrors を使用してください。

customerActivateByUrl(`mutation`)

customerCreateから受け取ったアクティベーション URL で顧客をアクティベートします。

インタラクティブな例

これは、mutation クエリの例です。このクエリを編集するには、下に埋め込まれたインタラクティブツールを使用します。

ヒント: フィールドの自動補完には Ctrl + Space を使用します。

mutation customerActivateByUrl($activationUrl: URL!, $password: String!) {
  customerActivateByUrl(activationUrl: $activationUrl, password: $password) {
    customer {
      id
    }
    customerAccessToken {
      accessToken
      expiresAt
    }
    customerUserErrors {
      code
      field
      message
    }
  }
}

Variables

{
  "activationUrl": "placeholder",
  "password": "HiZqFuDvDdQ7"
}

引数

引数	説明
`activationUrl` ( `URL!` ) `required`	お客様のアクティベーション URL。
`password` ( `String!` ) `required`	アクティベーション時に設定された新しいパスワード。

フィールドを返す

customer (Customer)
アクティブ化されたカスタマー。
customerAccessToken (CustomerAccessToken)
カスタマーの新しいカスタマーアクセストークン。
customerUserErrors ([CustomerUserError!]!)
変異を実行した際に発生したエラーのリスト。

customerAddressCreate(`mutation`)

顧客の新しい住所を作成します。

インタラクティブな例

これは、ミューテーションクエリの例です。このクエリを編集するには、以下の埋め込みインタラクティブツールを使用します。

ヒント：フィールドを自動補完するには、Ctrl + Spaceを使用してください。

mutation customerAddressCreate($customerAccessToken: String!, $address: MailingAddressInput!) {
  customerAddressCreate(customerAccessToken: $customerAccessToken, address: $address) {
    customerAddress {
      id
    }
    customerUserErrors {
      code
      field
      message
    }
  }
}

Variables

{
  "customerAccessToken": "ae0f1d2e179c9571122a0595a6ac8125",
  "address": {}
}

引数	説明
`address` ( `MailingAddressInput!` ) `required`	作成する顧客の郵送先住所。
`customerAccessToken` ( `String!` ) `required`	顧客の識別に使用されるアクセストークン。

MailingAddressInput フィールド

address1 (String)
住所の 1 行目。通常は番地または私書箱番号です。
address2 (String)
住所の 2 行目です。典型的には、アパート、スイート、またはユニットの番号です。
city (String)
市、区、村、または町の名前。
company (String)
顧客の会社や組織の名前。
country (String)
国の名前を指定します。
firstName (String)
顧客のファーストネーム。
lastName (String)
顧客のラストネーム。
phone (String)
顧客のユニークな電話番号。

E.164 規格に基づいてフォーマットされています。例えば、+16135551111 です。

province (String)
県、州、地区などの住所の地域名。
zip (String)
住所の郵便番号を指定します。

フィールドを返す

customerAddress (MailingAddress)
新しいカスタマーアドレスオブジェクト。
customerUserErrors ([CustomerUserError!]!)
変異を実行した際に発生したエラーのリスト。

非推奨のリターンフィールド

userErrors ([UserError!]!) deprecated
変異を実行した際に発生したエラーのリストです。

customerAddressDelete(`mutation`)

既存の顧客のアドレスを永久に削除します。

インタラクティブな例

これは Mutation クエリの例です。このクエリを編集するには、以下の埋め込みインタラクティブツールを使用してください。

ヒント: フィールドの自動補完には Ctrl + Space を使います。

mutation customerAddressDelete($id: ID!, $customerAccessToken: String!) {
  customerAddressDelete(id: $id, customerAccessToken: $customerAccessToken) {
    customerUserErrors {
      code
      field
      message
    }
    deletedCustomerAddressId
  }
}

Variables

{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
  "customerAccessToken": "ae0f1d2e179c9571122a0595a6ac8125"
}

引数

引数	説明
`customerAccessToken` ( `String!` ) `required`	お客様を識別するためのアクセストークンです。
`id` ( `ID!` ) `required`	削除するアドレスを指定します。

戻り値のフィールド

customerUserErrors ([CustomerUserError!]!)
変異を実行して発生したエラーのリストです。
deletedCustomerAddressId (String)
削除されたカスタマーアドレスの ID。

非推奨のリターンフィールド

userErrors ([UserError!]!) deprecated
変異を実行して発生したエラーのリストです。

customerAddressUpdate(`mutation`)

既存の顧客の住所を更新します。

インタラクティブな例

これは、ミューテーションクエリの例です。このクエリを編集するには、以下の埋め込みインタラクティブツールを使用します。

ヒント：フィールドを自動補完するには、Ctrl + Spaceを使います。

mutation customerAddressUpdate(
  $customerAccessToken: String!
  $id: ID!
  $address: MailingAddressInput!
) {
  customerAddressUpdate(customerAccessToken: $customerAccessToken, id: $id, address: $address) {
    customerAddress {
      id
    }
    customerUserErrors {
      code
      field
      message
    }
  }
}

Variables

{
  "customerAccessToken": "ae0f1d2e179c9571122a0595a6ac8125",
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
  "address": {}
}

引数

引数	説明
`address` ( `MailingAddressInput!` ) `required`	顧客の郵送先住所です。
`customerAccessToken` ( `String!` ) `required`	顧客の識別に使用されるアクセストークン。
`id` ( `ID!` ) `required`	更新する顧客の住所を指定します。

MailingAddressInput フィールド

address1 (String)
住所の 1 行目です。通常は番地または私書箱番号です。
address2 (String)
住所の 2 行目です。典型的には、アパート、スイート、またはユニットの番号です。
city (String)
市、区、村、または町の名前。
company (String)
顧客の会社や組織の名前。
country (String)
国の名前を指定します。
firstName (String)
顧客のファーストネーム。
lastName (String)
顧客のラストネーム。
phone (String)
顧客のユニークな電話番号。

E.164 規格に基づいてフォーマットされています。例えば、+16135551111 です。

province (String)
県、州、地区などの住所の地域名。
zip (String)
住所の郵便番号を指定します。

フィールドを返す

customerAddress (MailingAddress)
顧客の更新された郵送先住所。
customerUserErrors ([CustomerUserError!]!)
変異を実行した際に発生したエラーのリスト。

非推奨のリターンフィールド

userErrors ([UserError!]!) deprecated
変異を実行した際に発生したエラーのリストです。
!

非推奨の警告
代わりに customerUserErrors を使用してください。

customerCreate(`mutation`)

新規顧客を作成します。

インタラクティブな例

これは、ミューテーションクエリの例です。このクエリを編集するには、以下の埋め込みインタラクティブツールを使用します。

ヒント: フィールドを自動補完するには Ctrl + Space を使用します。

mutation customerCreate($input: CustomerCreateInput!) {
  customerCreate(input: $input) {
    customer {
      id
    }
    customerUserErrors {
      code
      field
      message
    }
  }
}

Variables

{
  "input": {
    "email": "user@example.com",
    "password": "HiZqFuDvDdQ7"
  }
}

引数

引数	説明
`input` ( `CustomerCreateInput!` ) `required`	新規顧客の作成に使用されるフィールド。

CustomerCreateInput フィールド

acceptsMarketing (Boolean)
顧客が E メールでマーケティング資料を送信することに同意したかどうかを示します。
email (String!) Required
顧客の E メール。
firstName (String)
顧客のファーストネーム。
lastName (String)
お客様の名字です。
password (String!) Required
顧客が使用するログインパスワード。
phone (String)
お客さまの固有の電話番号です。

E.164 規格を使用してフォーマットされています。例えば、+16135551111 です。

フィールドを返す

customer (Customer)
作成されたカスタマー・オブジェクト。
customerUserErrors ([CustomerUserError!]!)
変異を実行した際に発生したエラーのリスト。

非推奨のリターンフィールド

userErrors ([UserError!]!) deprecated
変異を実行した際に発生したエラーのリストです。
!

非推奨の警告
代わりに customerUserErrors を使用してください。

customerDefaultUpdate(`mutation`)

既存の顧客のデフォルトアドレスを更新します。

インタラクティブな例

これは Mutation クエリの例です。このクエリを編集するには、以下の埋め込みインタラクティブツールを使用してください。

ヒント: フィールドを自動補完するには、Ctrl + Spaceを使います。

mutation customerDefaultAddressUpdate($customerAccessToken: String!, $addressId: ID!) {
  customerDefaultAddressUpdate(customerAccessToken: $customerAccessToken, addressId: $addressId) {
    customer {
      id
    }
    customerUserErrors {
      code
      field
      message
    }
  }
}

Variables

{
  "customerAccessToken": "ae0f1d2e179c9571122a0595a6ac8125",
  "addressId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}

引数

引数	説明
`addressId` ( `ID!` ) `required`	顧客の新しいデフォルトとして設定するアドレスの ID。
`customerAccessToken` ( `String!` ) `required`	顧客の識別に使用されるアクセストークン。

戻り値のフィールド

customer (Customer)
更新されたカスタマーオブジェクト。
customerUserErrors ([CustomerUserError!]!)
変異を実行した際に発生したエラーのリスト。

非推奨のリターンフィールド

userErrors ([UserError!]!) deprecated
変異を実行した際に発生したエラーのリストです。
!

非推奨の警告
代わりに customerUserErrors を使用してください。

customerRecover(`mutation`)

リセットされたパスワードのプロセスの最初のステップとして、リセットされたパスワードの電子メールを顧客に送信します。

インタラクティブな例

これは Mutation クエリの例です。このクエリを編集するには、以下の埋め込みインタラクティブツールを使用してください。

ヒント：フィールドの自動補完にはCtrl + Spaceを使います。

mutation customerRecover($email: String!) {
  customerRecover(email: $email) {
    customerUserErrors {
      code
      field
      message
    }
  }
}

Variables

{
  "email": "user@example.com"
}

引数

引数	説明
`email` ( `String!` ) `required`	回収するお客様のメールアドレス。

フィールドを返す

customerUserErrors ([CustomerUserError!]!)
変異を実行した際に発生したエラーのリスト。

非推奨のリターンフィールド

userErrors ([UserError!]!) deprecated
変異を実行した際に発生したエラーのリストです。
!

非推奨の警告
代わりに customerUserErrors を使用してください。

customerReset(`mutation`)

CustomerRecover から受け取ったトークンで顧客のパスワードをリセットします。

インタラクティブな例

これはミューテーション・クエリの例です。このクエリを編集するには、以下の埋め込みインタラクティブツールを使用します。

ヒント: フィールドの自動補完には Ctrl + Space を使用してください。

mutation customerReset($id: ID!, $input: CustomerResetInput!) {
  customerReset(id: $id, input: $input) {
    customer {
      id
    }
    customerAccessToken {
      accessToken
      expiresAt
    }
    customerUserErrors {
      code
      field
      message
    }
  }
}

Variables

{
  "id": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
  "input": {
    "resetToken": "ae0f1d2e179c9571122a0595a6ac8125",
    "password": "HiZqFuDvDdQ7"
  }
}

引数

引数	説明
`id` ( `ID!` ) `required`	リセットする顧客を指定します。
`input` ( `CustomerResetInput!` ) `required`	顧客のパスワードをリセットするために使用されるフィールドを指定します。

CustomerResetInput フィールド

password (String!) Required
パスワードのリセット処理の一部として設定される新しいパスワード。
resetToken (String!) Required
カスタマーのパスワードをリセットするのに必要なリセットトークン。

返却フィールド

customer (Customer)
リセットされたカスタマー・オブジェクト。
customerAccessToken (CustomerAccessToken)
カスタマー用に新たに作成されたカスタマーアクセストークンオブジェクト。
customerUserErrors ([CustomerUserError!]!)
変異を実行して発生したエラーのリストです。

非推奨のリターンフィールド

userErrors ([UserError!]!) deprecated
変異を実行した際に発生したエラーのリストです。
!

非推奨の警告
代わりに customerUserErrors を使用してください。

customerResetByUrl(`mutation`)

CustomerRecover から受け取った reset password url で顧客のパスワードをリセットします。

インタラクティブな例

これは Mutation クエリの例です。このクエリを編集するには、以下の埋め込みインタラクティブツールを使用してください。

ヒント: フィールドを自動補完するには Ctrl + Space を使用します。

mutation customerResetByUrl($resetUrl: URL!, $password: String!) {
  customerResetByUrl(resetUrl: $resetUrl, password: $password) {
    customer {
      id
    }
    customerAccessToken {
      accessToken
      expiresAt
    }
    customerUserErrors {
      code
      field
      message
    }
  }
}

Variables

{
  "resetUrl": "placeholder",
  "password": "HiZqFuDvDdQ7"
}

引数

引数	説明
`password` ( `String!` ) `required`	パスワードリセット処理の一部として設定される新しいパスワード。
`resetUrl` ( `URL!` ) `required`	お客様のリセットパスワードの URL。

フィールドを返す

customer (Customer)
リセットされたカスタマーオブジェクト。
customerAccessToken (CustomerAccessToken)
カスタマーのために新しく作成されたカスタマーアクセストークンオブジェクト。
customerUserErrors ([CustomerUserError!]!)
変異を実行して発生したエラーのリストです。

非推奨のリターンフィールド

userErrors ([UserError!]!) deprecated
変異を実行した際に発生したエラーのリストです。
!

非推奨の警告
代わりに customerUserErrors を使用してください。

customerUpdate(`mutation`)

既存の顧客を更新します。

インタラクティブな例

これは、ミューテーションクエリの例です。このクエリを編集するには、以下の埋め込みインタラクティブツールを使用します。

ヒント: フィールドの自動補完にはCtrl + Spaceを使います。

mutation customerUpdate($customerAccessToken: String!, $customer: CustomerUpdateInput!) {
  customerUpdate(customerAccessToken: $customerAccessToken, customer: $customer) {
    customer {
      id
    }
    customerAccessToken {
      accessToken
      expiresAt
    }
    customerUserErrors {
      code
      field
      message
    }
  }

Variables

{
  "customerAccessToken": "ae0f1d2e179c9571122a0595a6ac8125",
  "customer": {}
}

引数	説明
`customer` ( `CustomerUpdateInput!` ) `required`	カスタマーオブジェクトの入力です。
`customerAccessToken` ( `String!` ) `required`	顧客の識別に使用されるアクセストークン。

CustomerUpdateInput フィールド

acceptsMarketing (Boolean)
顧客が E メールでマーケティング資料を送信することに同意したかどうかを示します。
email (String)
顧客の電子メール。
firstName (String)
顧客のファーストネーム。
lastName (String)
顧客の名字。
password (String)
顧客が使用するログインパスワード。
phone (String)
顧客のユニークな電話番号。
E.164 規格に基づいてフォーマットされています。例えば、+16135551111 などです。電話番号を削除するには、nullを指定します。

フィールドを返す

customer (Customer)
更新された customer オブジェクト。
customerAccessToken (CustomerAccessToken)
新しく作成されたカスタマーアクセストークン。カスタマーのパスワードが更新されると、以前のアクセストークン（この変異を実行するために使用されたものを含む）はすべて無効になり、新しいトークンが生成されます。
customerUserErrors ([CustomerUserError!]!)
変異を実行して発生したエラーのリストです。

非推奨のリターンフィールド

userErrors ([UserError!]!) deprecated
変異を実行した際に発生したエラーのリストです。
!

非推奨の警告
代わりに customerUserErrors を使用してください。

INPUTS

CustomerAccessTokenCreate(`input`)

カスタマーアクセストークンの作成に必要な入力フィールドを指定します。

入力フィールド

email (String!) Required
顧客に関連付けられた電子メール
password (String!) Required
顧客が使用するログインパスワード。

CustomerActivateInput(`input`)

カスタマーをアクティベートするために必要な入力フィールドを指定します。

入力フィールド

activationToken (String!) Required
カスタマーをアクティブにするために必要なアクティベーショントークンです。
password (String!) Required
アクティブ化の際に設定される新しいパスワード

CustomerCreateInput(`input`)

新規顧客の作成に必要なフィールドです。

入力フィールド

acceptsMarketing (Boolean)
顧客が電子メールでマーケティング資料を送信することに同意したかどうかを示します。
email (String!) Required
顧客の電子メール。
firstName (String)
顧客のファーストネーム。
lastName (String)
お客様の名字です。
password (String!) Required
顧客が使用するログインパスワード。
phone (String)
お客さまの固有の電話番号です。
E.164 規格を使用してフォーマットされています。例えば、+16135551111 です。

CustomerResetInput(`input`)

顧客のパスワードをリセットするために必要なフィールドを指定します。

入力フィールド

password (String!) Required
パスワードのリセット処理の一部として設定される新しいパスワード。
resetToken (String!) Required
顧客のパスワードをリセットするために必要なリセットトークン。

CustomerUpdateInput(`input`)

顧客情報の更新に必要なフィールドを指定します。

入力フィールド

acceptsMarketing (Boolean)
顧客が電子メールでマーケティング資料を送信することに同意したかどうかを示します。
email (String)
顧客の電子メール。
firstName (String)
顧客のファーストネーム。
lastName (String)
顧客の名字。
password (String)
顧客が使用するログインパスワード。
phone (String)
顧客のユニークな電話番号。
E.164 規格に基づいてフォーマットされています。例えば、+16135551111 などです。電話番号を削除するには、nullを指定します。

Shopify アプリのご紹介

Discussion

ログインするとコメントできます

この記事について

Shopify アプリのご紹介

Customer API

In this section

OBJECTS

Customer(objects)

接続

フィールド

Customer を返す型

Customer に対するミューテーション

インプリメンツ

CustomerAccessToken(objects)

フィールド

CustomerAccessToken の mutation

MUTATION

customerAccessTokenCreate(mutation)

インタラクティブな例

引数

CustomerAccessTokenCreateInput フィールド

フィールドを返す

非推奨のリターンフィールド

CustomerAccessTokenCreateWithMultipass(mutation)

インタラクティブな例

引数

フィールドを返す

customerAccessTokenDelete(mutation)

インタラクティブな例

戻り値のフィールド

customerAccessTokenRenew(mutation)

インタラクティブな例

フィールドを返す

CustomerActivate(mutation)

インタラクティブな例

引数

CustomerActivateInput フィールド

戻り値のフィールド

非推奨のリターンフィールド

customerActivateByUrl(mutation)

インタラクティブな例

引数

フィールドを返す

customerAddressCreate(mutation)

インタラクティブな例

MailingAddressInput フィールド

フィールドを返す

非推奨のリターンフィールド

customerAddressDelete(mutation)

インタラクティブな例

引数

戻り値のフィールド

非推奨のリターンフィールド

customerAddressUpdate(mutation)

インタラクティブな例

引数

MailingAddressInput フィールド

非推奨のリターンフィールド

customerCreate(mutation)

インタラクティブな例

引数

CustomerCreateInput フィールド

フィールドを返す

非推奨のリターンフィールド

customerDefaultUpdate(mutation)

インタラクティブな例

引数

戻り値のフィールド

非推奨のリターンフィールド

customerRecover(mutation)

インタラクティブな例

引数

フィールドを返す

非推奨のリターンフィールド

customerReset(mutation)

インタラクティブな例

引数

CustomerResetInput フィールド

返却フィールド

非推奨のリターンフィールド

customerResetByUrl(mutation)

インタラクティブな例

Customer(`objects`)

CustomerAccessToken(`objects`)

customerAccessTokenCreate(`mutation`)

CustomerAccessTokenCreateWithMultipass(`mutation`)

customerAccessTokenDelete(`mutation`)

customerAccessTokenRenew(`mutation`)

CustomerActivate(`mutation`)

customerActivateByUrl(`mutation`)

customerAddressCreate(`mutation`)

customerAddressDelete(`mutation`)

customerAddressUpdate(`mutation`)

customerCreate(`mutation`)

customerDefaultUpdate(`mutation`)

customerRecover(`mutation`)

customerReset(`mutation`)

customerResetByUrl(`mutation`)

customerUpdate(`mutation`)

CustomerAccessTokenCreate(`input`)

CustomerActivateInput(`input`)

CustomerCreateInput(`input`)

CustomerResetInput(`input`)

CustomerUpdateInput(`input`)