Customer - storefront - OBJECT

Version: 2024-10

Description:

A customer represents a customer account with the shop. Customer accounts store contact information for the customer, saving logged-in customers the trouble of having to provide it at every checkout.

Access Scopes

`unauthenticated_read_customers` access scope.

Fields

• acceptsMarketing: Boolean! - Indicates whether the customer has consented to be sent marketing material via email.
• createdAt: DateTime! - The date and time when the customer was created.
• defaultAddress: MailingAddress - The customer’s default address.
• displayName: String! - The customer’s name, email or phone number.
• email: String - The customer’s email address.
• firstName: String - The customer’s first name.
• id: ID! - A unique ID for the customer.
• lastName: String - The customer’s last name.
• metafield: Metafield - A [custom field](https://shopify.dev/docs/apps/build/custom-data), including its `namespace` and `key`, that's associated with a Shopify resource for the purposes of adding and storing additional information.
• metafields: Metafield! - A list of [custom fields](/docs/apps/build/custom-data) that a merchant associates with a Shopify resource.
• numberOfOrders: UnsignedInt64! - The number of orders that the customer has made at the store in their lifetime.
• phone: String - The customer’s phone number.
• tags: String! - A comma separated list of tags that have been added to the customer. Additional access scope required: unauthenticated_read_customer_tags.
• updatedAt: DateTime! - The date and time when the customer information was updated.

Connections

• addresses: MailingAddressConnection!
• orders: OrderConnection!

Related queries

• customer The customer associated with the given access token. Tokens are obtained by using the [`customerAccessTokenCreate` mutation](https://shopify.dev/docs/api/storefront/latest/mutations/customerAccessTokenCreate).

Related mutations

• customerActivateByUrl Activates a customer with the activation url received from `customerCreate`.
• customerActivate Activates a customer.
• customerCreate Creates a new customer.
• customerDefaultAddressUpdate Updates the default address of an existing customer.
• customerResetByUrl "Resets a customer’s password with the reset password URL received from a reset password email. You can send a reset password email with the [`customerRecover`](https://shopify.dev/api/storefront/latest/mutations/customerRecover) mutation."
• customerReset "Resets a customer’s password with the token received from a reset password email. You can send a reset password email with the [`customerRecover`](https://shopify.dev/api/storefront/latest/mutations/customerRecover) mutation."
• customerUpdate Updates an existing customer.

Related Unions

• MetafieldParentResource A resource that the metafield belongs to.

Examples

• Get a customer by access token

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Storefront-Access-Token: {storefront_access_token}' \\\n-d '{\n\"query\": \"query { customer(customerAccessToken: \\\"bobs_token\\\") { id firstName lastName acceptsMarketing email phone } }\"\n}'\n"
          Node example: "const client = new shopify.clients.Storefront({\n  domain: 'your-development-store.myshopify.com',\n  storefrontAccessToken,\n});\nconst data = await client.query({\n  data: `query {\n    customer(customerAccessToken: \"bobs_token\") {\n      id\n      firstName\n      lastName\n      acceptsMarketing\n      email\n      phone\n    }\n  }`,\n});\n"
          Ruby example: null
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new ShopifyClientsStorefront(\"your-development-store.myshopify.com\", $storefrontAccessToken);\n$query = <<<QUERY\n  query {\n    customer(customerAccessToken: \"bobs_token\") {\n      id\n      firstName\n      lastName\n      acceptsMarketing\n      email\n      phone\n    }\n  }\nQUERY;\n\n$response = $client->query([\"query\" => $query]);\n"
          Remix example: "const { storefront } = await unauthenticated.storefront(\n  'your-development-store.myshopify.com'\n);\n\nconst response = await storefront.graphql(\n  `#graphql\n  query {\n    customer(customerAccessToken: \"bobs_token\") {\n      id\n      firstName\n      lastName\n      acceptsMarketing\n      email\n      phone\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
          Graphql query: "query {\n  customer(customerAccessToken: \"bobs_token\") {\n    id\n    firstName\n    lastName\n    acceptsMarketing\n    email\n    phone\n  }\n}"
        

  input: null

  response: {
    "data": {
      "customer": {
        "id": "gid://shopify/Customer/410535040",
        "firstName": "John",
        "lastName": "Smith",
        "acceptsMarketing": false,
        "email": "johnsmith@example.com",
        "phone": "+16134504533"
      }
    }
  }