Choose a version:

Customer API

The Customer API provides read-only access to customer data. Use this API to get customer information and build personalized experiences based on the selected customer context. The API offers the customer identifier for linking to customer data and enabling customer-specific features.

Anchor to Use casesUse cases

Customer search: Search for customers by name, email, phone, or custom attributes.
Profile creation: Create new customer profiles with contact information and metadata.
Profile updates: Update customer information including details, addresses, and group assignments.
Loyalty programs: Implement loyalty programs by tracking purchase history and applying discounts.

Support

Targets (3)

Supported targets

Anchor to PropertiesProperties

The shopify global object provides customer information for the active context. Access the following properties on shopify to get the customer identifier for building personalized experiences.

Anchor to id id number required: The unique identifier for the customer. Use for customer lookups, applying customer-specific pricing, enabling personalized features, and integrating with external systems.

Examples

jsx

import {render} from 'preact';

export default async () => {

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

};

const Extension = () => {

return (

<s-page heading='Customer Api'>

<s-scroll-box>

<s-text>Customer ID: {shopify.customer.id}</s-text>

</s-scroll-box>

</s-page>

);

};

Examples

Description
Access the unique identifier of the current customer in a customer detail context. This example shows how to use `shopify.customer.id` to retrieve the customer ID. This can be used for fetching additional customer data, implementing loyalty features, or building personalized customer experiences.
jsx
```
import {render} from 'preact';

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

const Extension = () => {
  return (
    <s-page heading='Customer Api'>
      <s-scroll-box>
        <s-text>Customer ID: {shopify.customer.id}</s-text>
      </s-scroll-box>
    </s-page>
  );
};
```

Anchor to Best practicesBest practices

Use customer ID for lookups: Fetch additional customer information from external systems or Shopify APIs using the customer ID.
Enable personalized features: Use customer context for customer-specific pricing, loyalty programs, or product recommendations.
Validate customer access: Verify the customer ID is valid before performing operations or API calls.

Anchor to LimitationsLimitations

Customer data reflects the current POS session and may not include real-time updates from other channels until the session is refreshed.

Was this page helpful?