Choose a version:

Customer details

The customer details screen appears when merchants look up a customer during checkout or need to access customer history and profile information. This screen serves as the hub for customer management within POS, displaying customer data, purchase history, and contact details.

Anchor to Use casesUse cases

Loyalty programs: Display loyalty status, points balance, and tier information.
Customer discounts: Apply personalized discounts based on membership level or purchase history.
Profile management: Launch workflows for updating customer preferences and communication settings.
Customer service: Process loyalty redemptions, account adjustments, and service requests.

Anchor to Customer details targetsCustomer details targets

Use these targets for customer service capabilities, loyalty program integration, or tools for customer engagement and support during transactions.

Anchor to Customer details block ,[object Object]Customer details block target

pos.customer-details.block.render

Renders a custom information section within the customer details screen. Use this target for displaying supplementary customer data like loyalty status, points balance, or personalized information alongside standard customer details.

Extensions at this target appear as persistent blocks within the customer details interface and support interactive elements that can launch modal workflows using shopify.action.presentModal() for more complex customer operations.

Examples

jsx

import {render} from 'preact';

export default async () => {

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

};

const Extension = () => {

return (

<s-pos-block>

<s-button

slot="secondary-actions"

onClick={() => shopify.action.presentModal()}

Open action

</s-button>

<s-text>This is a block extension</s-text>

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

</s-pos-block>

);

};

Examples

Description

Add a custom information section to the customer details screen for displaying supplementary customer data. This example shows how to create a block that shows loyalty status, points balance, or personalized information alongside standard customer details.

jsx

import {render} from 'preact';

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

const Extension = () => {
  return (
    <s-pos-block>
      <s-button
        slot="secondary-actions"
        onClick={() => shopify.action.presentModal()}
      >
        Open action
      </s-button>
      <s-text>This is a block extension</s-text>
      <s-text>Customer ID for this customer: {shopify.customer.id}</s-text>
    </s-pos-block>
  );
};

Anchor to Customer details action (menu item) ,[object Object]Customer details action (menu item) target

pos.customer-details.action.menu-item.render

Renders a single interactive button component as a menu item in the customer details action menu. Use this target for customer-specific operations like applying customer discounts, processing loyalty redemptions, or launching profile update workflows.

Extensions at this target can access the customer identifier through the Customer API to perform customer-specific operations. Menu items typically invoke shopify.action.presentModal() to launch the companion modal for complete customer workflows.

Examples

jsx

import {render} from 'preact';

export default async () => {

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

};

const Extension = () => {

return (

<s-button

onClick={() => shopify.action.presentModal()}

);

};

Examples

Description
Add an interactive menu item to the customer details action menu for customer-specific operations. This example shows how to create a menu item that accesses customer data and launches modal workflows for tasks like applying loyalty rewards, updating profiles, or managing customer preferences.
jsx
```
import {render} from 'preact';

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

const Extension = () => {
  return (
    <s-button
      onClick={() => shopify.action.presentModal()}
    />
  );
};
```

Anchor to Customer details action (modal) ,[object Object]Customer details action (modal) target

pos.customer-details.action.render

Renders a full-screen modal interface launched from customer details menu items. Use this target for complex customer workflows that require forms, multi-step processes, or detailed information displays beyond what a simple button can provide.

Extensions at this target have access to customer data through the Customer API and support workflows with multiple screens, navigation, and interactive components.

Support

Components (34)

APIs (13)

Examples

jsx

import {render} from 'preact';

export default async () => {

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

};

const Extension = () => {

return (

<s-page heading='Customer Details'>

<s-scroll-box>

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

</s-scroll-box>

</s-page>

);

};

Examples

Description

Build a full-screen modal workflow launched from a customer details action menu item. This example demonstrates creating customer-specific experiences with multi-step processes, forms, and customer data access for operations like loyalty management or profile updates.

jsx

import {render} from 'preact';

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

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

Anchor to Best practicesBest practices

Update info in real time: Update customer information immediately when changes occur to reflect current state.
Show clear confirmations: Display messages specifying which customer was affected, like "Loyalty points updated for Jane Doe."
Ensure service continuity: Integrate customer changes with the overall transaction and relationship.
Handle data responsibly: Communicate limitations clearly. Display only necessary information and explain data collection or processing.
Write action-oriented labels: Use specific labels like "Update loyalty tier" instead of generic terms like "Customer App."
Show status and metrics: Display tier, points, VIP status, and action eligibility to support decisions.

Anchor to LimitationsLimitations

You can only render one button component for each POS UI extension using the action (menu item) target.
Customer data is read-only through the Customer API, which provides only the customer ID. To access additional customer information or modify customer data, use external API calls or integrate with the Customer API through your app backend.

Was this page helpful?

Customer details

Anchor to Use casesUse cases

Anchor to Customer details targetsCustomer details targets

Anchor to Customer details block ,[object Object]Customer details block target

Supported components

Available APIs

Supported components

Available APIs

jsx

Anchor to Customer details action (menu item) ,[object Object]Customer details action (menu item) target

Supported components

Available APIs

Supported components

Available APIs

jsx

Anchor to Customer details action (modal) ,[object Object]Customer details action (modal) target

Supported components

Available APIs

Supported components

Available APIs

jsx

Anchor to Best practicesBest practices

Anchor to LimitationsLimitations