Choose a version:

Buyer Identity API

Requires level 2 access to protected customer data.

The Buyer Identity API provides access to the buyer's identity information during checkout, including customer details and B2B purchasing company data. Use this API to identify returning customers, personalize the checkout experience, and detect B2B sessions.

The Buyer Identity API is read-only. There are no methods to update the buyer's identity from a checkout extension.

The customer property is undefined when the buyer isn't a known customer or hasn't logged in.

Anchor to Use casesUse cases

Display buyer details: Greet returning buyers by name and show their contact information during checkout.
Identify B2B sessions: Determine if the buyer is purchasing on behalf of a company and display company-specific details.
Personalize the checkout: Use the buyer's email, phone, or customer ID to tailor the checkout experience.

Support

Targets (31)

Supported targets

Anchor to PropertiesProperties

The shopify global object provides buyer identity data for the current checkout. Access the following properties on shopify to read customer details and B2B purchasing company information. Available to purchase extension targets.

Anchor to buyerIdentity buyerIdentity: Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.

Requires access to protected customer data.

BuyerIdentity

Information about the buyer who is completing the checkout. {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). The `customer` and `purchasingCompany` properties require level 1 access. The `email` and `phone` properties require level 2 access.

customer
The buyer's customer account, including their ID and whether they've accepted marketing. The value is `undefined` if the buyer isn't a known customer for this shop or if they haven't logged in yet. {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
SubscribableSignalLike<Customer | undefined>
```
email
The email address the buyer provided during checkout. The value is `undefined` if the app doesn't have access to customer data. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
SubscribableSignalLike<string | undefined>
```
phone
The phone number the buyer provided during checkout. The value is `undefined` if no phone number was provided or the app doesn't have access to customer data. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
SubscribableSignalLike<string | undefined>
```
purchasingCompany
The company and company location that a B2B (business-to-business) customer is purchasing on behalf of. Use this to identify the business context of the order. The value is `undefined` if the buyer isn't a B2B customer. {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
SubscribableSignalLike<PurchasingCompany | undefined>
```

SubscribableSignalLike

Represents a reactive signal interface that provides both immediate value access and subscription-based updates. Enables real-time synchronization with changing data through the observer pattern. This interface extends `ReadonlySignalLike` with deprecated fields that are still supported for backwards compatibility.

current
The current value of the signal. Equivalent to `.value`, accessing this property subscribes to changes when used in a reactive context.
```
T
```
destroy
Cleans up the subscription and releases any resources held by this signal. After calling `destroy()`, the signal stops receiving updates from the main thread.
```
() => Promise<void>
```
subscribe
Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value.
```
(fn: (value: T) => void) => () => void
```
value
The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup.
```
T
```

Customer

Information about a customer who has previously purchased from this shop. {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).

acceptsEmailMarketing
Whether the customer has opted in to email marketing. {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
boolean
```
acceptsMarketing
Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers. {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.
```
boolean
```
acceptsSmsMarketing
Whether the customer has opted in to SMS marketing. {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
boolean
```
email
The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
string
```
firstName
The customer's first name. The value is `undefined` if the app doesn't have the required access level. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
string
```
fullName
The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
string
```
id
An identifier for the customer in the format `gid://shopify/Customer/<id>`. This value is unique per shop. {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
string
```
image
The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer. {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
ImageDetails
```
lastName
The customer's last name. The value is `undefined` if the app doesn't have the required access level. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
string
```
ordersCount
The number of orders the customer has previously placed with this shop. {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
number
```
phone
The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level. {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
string
```
storeCreditAccounts
The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit. {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
StoreCreditAccount[]
```

ImageDetails

altText
The alternative text for the image, used for accessibility. The value is `undefined` if the merchant hasn't provided alt text.
```
string
```
url
The fully-qualified URL of the image. Use this to render the product or variant image in your extension.
```
string
```

PurchasingCompany

The company and location that the [B2B](/docs/apps/build/b2b) customer is purchasing on behalf of. This is present only when the buyer is logged in as a business customer.

company
The company the B2B customer belongs to. {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
Company
```
location
The specific company location associated with this B2B purchase. {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
CompanyLocation
```

Company

externalId
A merchant-defined external identifier for the company. The value is `undefined` if the merchant hasn't set one. {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
string
```
id
A globally-unique identifier for the company in the format `gid://shopify/Company/<id>`. {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
string
```
name
The company's display name. {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
string
```

CompanyLocation

externalId
A merchant-defined external identifier for the company location. The value is `undefined` if the merchant hasn't set one. {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
string
```
id
A globally-unique identifier for the company location in the format `gid://shopify/CompanyLocation/<id>`. {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
string
```
name
The display name of the company location. {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
```
string
```

Examples

jsx

import '@shopify/ui-extensions/preact';

import {render} from 'preact';

export default function extension() {

render(<Extension />, document.body);

}

function Extension() {

const customer = shopify.buyerIdentity?.customer.value;

if (!customer) {

return null;

}

const name =

customer.fullName ?? 'Customer';

return (

<s-banner heading="Welcome back">

{name}, you have {customer.ordersCount}{' '}

previous{' '}

{customer.ordersCount === 1

? 'order'

: 'orders'}{' '}

with us.

</s-banner>

);

}

Examples

Description

Greet returning buyers with a personalized welcome banner. This example reads `shopify.buyerIdentity.customer` and displays the buyer's name and order count, with a fallback when `fullName` is unavailable.

jsx

import '@shopify/ui-extensions/preact';
import {render} from 'preact';

export default function extension() {
  render(<Extension />, document.body);
}

function Extension() {
  const customer = shopify.buyerIdentity?.customer.value;

  if (!customer) {
    return null;
  }

  const name =
    customer.fullName ?? 'Customer';

  return (
    <s-banner heading="Welcome back">
      {name}, you have {customer.ordersCount}{' '}
      previous{' '}
      {customer.ordersCount === 1
        ? 'order'
        : 'orders'}{' '}
      with us.
    </s-banner>
  );
}

Description

Identify B2B buyers and show the purchasing company's name and location. This example checks whether `shopify.buyerIdentity.purchasingCompany` is defined and renders the details in a banner.

jsx

import '@shopify/ui-extensions/preact';
import {render} from 'preact';

export default function extension() {
  render(<Extension />, document.body);
}

function Extension() {
  const purchasingCompany = shopify.buyerIdentity?.purchasingCompany.value;

  if (!purchasingCompany) {
    return null;
  }

  return (
    <s-banner heading="B2B order">
      Purchasing on behalf of{' '}
      {purchasingCompany.company.name},{' '}
      location:{' '}
      {purchasingCompany.location.name}
    </s-banner>
  );
}

Anchor to Best practicesBest practices

For multi-shop apps, key records on shop and customer.id together: customer.id is unique per shop. If your app is installed on multiple shops and keys records only on customer.id, then it can't reliably correlate a buyer across shops.
Check marketing consent before using contact details: The Customer object includes acceptsEmailMarketing and acceptsSmsMarketing flags. Respect these preferences when using the buyer's email or phone for marketing purposes.

Was this page helpful?