Skip to main content

Buyer Identity
API

Requires level 2 access to protected customer data.

The API for interacting with the buyer identity.

The base API object provided to purchase extension targets.

Information about the buyer that is interacting with the checkout.

Requires access to protected customer data.

Was this section helpful?

Returns the current Customer. The value is undefined if the buyer isn't a known customer for this shop or if they haven't logged in yet.

| undefined
Was this section helpful?

Returns the email address of the buyer that is interacting with the cart. The value is undefined if the app does not have access to customer data.

string | undefined
Was this section helpful?

Returns the phone number of the buyer that is interacting with the cart. The value is undefined if the app does not have access to customer data.

string | undefined
Was this section helpful?

Anchor to usePurchasingCompany
usePurchasingCompany()

Provides information about the company and its location that the business customer is purchasing on behalf of during a B2B checkout. It includes details that can be utilized to identify both the company and its corresponding location to which the business customer belongs.

The value is undefined if a business customer isn't logged in. This function throws an error if the app doesn't have access to customer data.

| undefined
Was this section helpful?