Shopify Apps in Checkout

https://shopify.dev/docs/apps/build/checkout
Admin
This documentation guides developers on how to build apps and extensions to customize and enhance...
Tokens:324,333
Snippets:2,330
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Install Shopify AI Toolkit for Hermes

Source: https://shopify.dev/docs/apps/build/checkout/start-building

Download and run the install script for the Hermes plugin.

```terminal
curl -fsSL https://raw.githubusercontent.com/Shopify/Shopify-AI-Toolkit/main/.hermes-plugin/install.sh -o /tmp/shopify-hermes-install.sh
bash /tmp/shopify-hermes-install.sh
```

--------------------------------

### Start development server

Source: https://shopify.dev/docs/apps/build/checkout/customize-header

Starts the development server to build and preview your app. Press 'p' to open the Dev Console, then click the preview link for your extension.

```bash
shopify app dev
```

--------------------------------

### Install Shopify AI Toolkit for Pi

Source: https://shopify.dev/docs/apps/build/checkout/start-building

Install the package from npm for Pi.

```terminal
pi install npm:@shopify/ai-toolkit
```

--------------------------------

### Install Shopify AI Toolkit for Antigravity CLI

Source: https://shopify.dev/docs/apps/build/checkout/start-building

Run this command in the terminal to install the Shopify plugin for Antigravity CLI.

```terminal
agy plugin install https://github.com/Shopify/shopify-ai-toolkit
```

--------------------------------

### Install dependencies with npm

Source: https://shopify.dev/docs/apps/build/checkout/product-offers/build-a-post-purchase-offer

Install the required dependencies (jsonwebtoken and uuid) for the app server inside the extension directory using npm.

```terminal
npm install jsonwebtoken uuid
```

--------------------------------

### Install Shopify AI Toolkit for OpenClaw

Source: https://shopify.dev/docs/apps/build/checkout/start-building

Install the Shopify plugin from npm for OpenClaw.

```terminal
openclaw plugins install npm:@shopify/ai-toolkit
```

--------------------------------

### Install dependencies with pnpm

Source: https://shopify.dev/docs/apps/build/checkout/product-offers/build-a-post-purchase-offer

Install the required dependencies (jsonwebtoken and uuid) for the app server inside the extension directory using pnpm.

```terminal
pnpm add jsonwebtoken uuid
```

--------------------------------

### Start Shopify CLI dev preview

Source: https://shopify.dev/docs/apps/build/checkout/cart-checkout-validation/create-checkout-validation

Navigate to the app root and start the Shopify CLI dev preview to test the function on a dev store. The dev command rebuilds the function and updates drafts when watched files change.

```terminal
cd ../..
```

```terminal
shopify app dev
```

--------------------------------

### Install Shopify AI Toolkit for Claude Code

Source: https://shopify.dev/docs/apps/build/checkout/start-building

Run this command in the terminal to install the Shopify AI Toolkit plugin for Claude Code.

```terminal
claude plugin install shopify-ai-toolkit@claude-plugins-official
```

--------------------------------

### Install Shopify AI Toolkit for Codex

Source: https://shopify.dev/docs/apps/build/checkout/start-building

Run this command in the terminal to add the Shopify plugin for Codex.

```terminal
codex plugin add shopify@openai-curated
```

--------------------------------

### React: applyAttributeChange API call

Source: https://shopify.dev/docs/apps/build/checkout/migrate-to-web-components

Example of using the applyAttributeChange API in a React checkout extension. It imports from '@shopify/ui-extensions-react/checkout' and uses the useApi hook to get the API. The onCheckboxChange function calls applyAttributeChange with type 'updateAttribute' and logs the result.

```tsx
import {
  reactExtension,
  Checkbox,
  useApi,
} from '@shopify/ui-extensions-react/checkout';


export default reactExtension(
  'purchase.checkout.block.render',
  () => <Extension />,
);


function Extension() {
  const api = useApi();


  async function onCheckboxChange(isChecked) {
    const result = await api.applyAttributeChange(
      {
        type: 'updateAttribute',
        key: 'includeGift',
        value: isChecked ? 'yes' : 'no',
      },
    );


    console.log(
      'applyAttributeChange result',
      result,
    );
  }


  return (
    <Checkbox onChange={onCheckboxChange}>
      Include a complimentary gift
    </Checkbox>
  );
}

```

--------------------------------

### Initialize payment customizations sample app

Source: https://shopify.dev/docs/apps/build/checkout/payments

Initializes a new Shopify app using the payment customizations sample app template. Run this command to clone the sample code repository.

```terminal
shopify app init --template https://github.com/Shopify/function-examples/sample-apps/payment-customizations
```

--------------------------------

### Create and run a checkout UI extension

Source: https://shopify.dev/docs/apps/build/checkout/customize-footer?extension=polaris

Commands to set up a new checkout UI extension: navigate to your app directory, generate the extension with the checkout_ui template, and start the development server. After running the generate command, select 'Checkout UI' when prompted.

```bash
cd <directory>
```

```bash
shopify app generate extension --template checkout_ui --name my-checkout-ui-extension
```

```bash
shopify app dev
```

--------------------------------

### Initialize delivery customizations sample app

Source: https://shopify.dev/docs/apps/build/checkout/delivery-shipping/delivery-options/build-function

Clones the delivery customizations sample app template.

```terminal
shopify app init --template https://github.com/Shopify/function-examples/sample-apps/delivery-customizations
```

--------------------------------

### English pluralization example

Source: https://shopify.dev/docs/apps/build/checkout/localized-checkout-ui-extensions

Example of plural translation keys for English, defining 'one' and 'other' keys.

```json
{
  "youHaveMessages": {
    "one": "you have one message",
    "other": "you have {{count}} messages"
  }
}
```

--------------------------------

### Configure example-date-picker extension (shopify.extension.toml)

Source: https://shopify.dev/docs/apps/build/checkout/delivery-shipping/delivery-methods/date-picker

Configuration file for the example-date-picker checkout UI extension. Sets the API version to 2025-10, targets the shipping-option-list render-after point, and enables api_access for storefront API queries.

```toml
# Learn more about configuring your checkout UI extension:
# https://shopify.dev/api/checkout-extensions/checkout/configuration


# The version of APIs your extension will receive. Learn more:
# https://shopify.dev/docs/api/usage/versioning
api_version = "2025-10"


[[extensions]]
name = "example-date-picker"
handle = "example-date-picker"
type = "ui_extension"
uid = "09980146-64fb-df11-8340-efa27fa6cd5da54311de"


# Controls where in Shopify your extension will be injected,
# and the file that contains your extension’s source code. Learn more:
# https://shopify.dev/docs/api/checkout-ui-extensions/unstable/extension-targets-overview


[[extensions.targeting]]
module = "./src/Checkout.jsx"
target = "purchase.checkout.shipping-option-list.render-after"


[extensions.capabilities]
# Gives your extension access to directly query Shopify’s storefront API.
# https://shopify.dev/docs/api/checkout-ui-extensions/unstable/configuration#api-access
api_access = true
```

--------------------------------

### Initialize a Shopify app with shopify app init

Source: https://shopify.dev/docs/apps/build/checkout/start-building

 scaffolds a new Shopify app interactively in the current directory using the Shopify CLI command `shopify navigate to your app directory before proceeding to generate an extension. Expect prompts for your app name and/or preferred language depending on your setup constraints; exact behavior varies by CLI version and whether you're logged in or not. This snippet standalone and precedes subsequent steps documented on the page. 

```plugin:shopify/cli.terminal,code:shopify app init

shopify navigate to your app directory before proceeding to the next step documented on the page.
```

--------------------------------

### Retrieve products with StandardApi.query and Storefront API Products

Source: https://shopify.dev/docs/apps/build/checkout/product-offers/build-a-pre-purchase-offer

This snippet demonstrates how to use the `query` method of the JDK's `StandardApi` Checkout API object to fetch the first five products from the storefront.qa, and store them in an array for later use in the product offer. The `api_key` is automatically available to all targets, and in a production app you might query your database instead. For more examples, see the Storefront API learning kit.

```javascript jsx react jsx react jsx react jsx react jsx react jsx react jsnippet.jsx react jsnippet.jsx react jsnippet.jsx snippet.js snippet.jsx snippet.jsx snippet.js snippet.jsx snippet.jsx snippet.jsx snippet.js snippet.js snippet.jsx snippet.js snippet.js snippet.js snippet.js snippet.js snippet.js snippet.js snippet.js snippet.js snippet.js snippet.js snippet.js snippet.js snippet.js snippet.js snippet.js snippet.js snippet.js          
fetchProducts = async () => {
  const { data } = 

```

--------------------------------

### Install dependencies with Yarn

Source: https://shopify.dev/docs/apps/build/checkout/product-offers/build-a-post-purchase-offer

Install the required dependencies (jsonwebtoken and uuid) for the app server inside the extension directory using Yarn.

```terminal
yarn add jsonwebtoken uuid
```

--------------------------------

### Navigate to extension directory

Source: https://shopify.dev/docs/apps/build/checkout/cart-checkout-validation/create-admin-ui-validation?extension=polaris

Navigate to the newly created validation-settings extension directory.

```bash
cd extensions/validation-settings
```

--------------------------------

### Arabic pluralization example

Source: https://shopify.dev/docs/apps/build/checkout/localized-checkout-ui-extensions

Example of plural translation keys for Arabic, defining all plural keys: zero, one, two, few, many, and other.

```json
{
  "youHaveMessages": {
    "zero": "ليس لديك رسائل",
    "one": "لديك رسالة واحدة",
    "two": "لديك رسالتان",
    "few": "رسائل {{count}}  لديك",
    "many": "رسالة {{count}} لديك",
    "other": "رسالة {{count}} لديك"
  }
}
```

--------------------------------

### Vanilla: Build post-purchase subscription UI and update price breakdown

Source: https://shopify.dev/docs/apps/build/checkout/product-offers/create-a-post-purchase-subscription

This snippet shows how to construct the post-purchase subscription UI using the checkout UI extension API. It includes creating the main wrapper, buyer consent, price breakdown lines, money summary, and a purchase option selector. It also defines an async function that calls calculateChangeset to get shipping, taxes, and totals, then updates the UI text nodes.

```javascript
const wrapperComponent = root.createComponent(BlockStack, {}, [
  root.createComponent(Heading, {}, purchaseOption.productTitle),
  priceHeaderComponent,
  productDescriptionComponent,
  priceBreakdownComponent,
  buttonsComponent,
]);

const buyerConsentComponent = root.createComponent(BuyerConsent, {
  policy: "subscriptions",
  checked: buyerConsent,
  onChange: () => {
    buyerConsent = !buyerConsent;
  },
});

function createPriceBreakdownLine({ label, amount, textSize = "small" }) {
  return root.createComponent(Tiles, {}, [
    root.createComponent(TextBlock, { size: "small" }, label),
    root.createComponent(
      TextContainer,
      { alignment: "trailing" },
      root.createComponent(
        TextBlock,
        { emphasized: true, size: textSize },
        amount
      )
    ),
  ]);
}

function createMoneySummary({ label, amount }) {
  return root.createComponent(Tiles, {}, [
    root.createComponent(
      TextBlock,
      { emphasized: true, size: "medium" },
      label
    ),
    root.createComponent(
      TextContainer,
      { alignment: "trailing" },
      root.createComponent(
        TextBlock,
        { emphasized: true, size: "medium" },
        amount
      )
    ),
  ]);
}

const purchaseOptionSelect = root.createComponent(Select, {
  label: "Purchase options",
  value: selectedPurchaseOption.toString(),
  options: purchaseOptions.map((option, index) => ({
    label: option.title,
    value: index.toString(),
  })),
  onChange: (value) => {
    const previousPurchaseOption = purchaseOptions[selectedPurchaseOption];
    selectedPurchaseOption = parseInt(value, 10);
    updatePriceBreakdownUI(previousPurchaseOption);
  },
});

if (purchaseOptions.length > 1) {
  wrapperComponent.insertChildBefore(
    purchaseOptionSelect,
    priceBreakdownComponent
  );
}

// Get shipping costs and taxes and update the UI
async function updatePriceBreakdownUI(previousPurchaseOption) {
  const currentPurchaseOption = purchaseOptions[selectedPurchaseOption];
  acceptButton.updateProps({ loading: true });
  // Request shopify to calculate shipping costs and taxes for the upsell
  const result = await calculateChangeset({
    changes: purchaseOptions[selectedPurchaseOption].changes,
  });

  // Extract values from response
  const shipping =
    result.calculatedPurchase?.addedShippingLines[0]?.priceSet
      ?.presentmentMoney?.amount;
  const taxes =
    result.calculatedPurchase?.addedTaxLines[0]?.priceSet?.presentmentMoney
      ?.amount;
  const total =
    result.calculatedPurchase?.totalOutstandingSet.presentmentMoney.amount;
  const originalPrice =
    result.calculatedPurchase?.updatedLineItems[0].priceSet.presentmentMoney
      .amount;
  const discountedPrice =
    result.calculatedPurchase?.updatedLineItems[0].totalPriceSet
      .presentmentMoney.amount;

  // Update all of the text nodes once the purchase is calculated by Shopify's API
  totalAmount.updateText(formatCurrency(total));
  subtotalAmount.updateText(formatCurrency(discountedPrice));
  shippingAmount.updateText(formatCurrency(shipping));
  taxesAmount.updateText(formatCurrency(taxes));
  originalPriceAmount.updateText(formatCurrency(originalPrice));
  discountedPriceAmount.updateText(formatCurrency(discountedPrice));

  const recurringSummaryText = root.createText(
    `${formatCurrency(originalPrice)} ${getBillingInterval(
      currentPurchaseOption.interval
    )}`
  );
  const recurringSummary = root.createComponent(
    BlockStack,
    { spacing: "xtight" },
    [
      root.createComponent(Tiles, {}, [
        root.createComponent(
          TextBlock,
          { size: "small" },
          "Recurring subtotal"
        ),
        root.createComponent(
          TextContainer,
          { alignment: "trailing" },
          root.createComponent(
            TextBlock,
            { subdued: true, size: "small" },
            recurringSummaryText
          )
        ),
      ]),
      root.createComponent(
        TextBlock,
        { size: "small", subdued: true },
        "Doesn't include shipping, tax, duties, or any applicable discounts."
      ),
    ]
  );
}
```

--------------------------------

### GraphQL query to fetch the first product for upsell

Source: https://shopify.dev/docs/apps/build/checkout/product-offers/build-a-post-purchase-offer

Use this GraphQL query to fetch therof the first product from the Shopify Admin API endpoint `POST https://installations.myshopify.com/api/{api_version}/graphql returns JSON response with product details including id, title, image, and first variant's price and id, which are used to populate the offer.installer.js file later. Requires Shopify GraphiQL or any GraphQL client with valid API credentials. The response includes a `data.products.edits

``` —
{
  products(first: ide)
```

--------------------------------

### Pre-Polaris (2025-07): InlineLayout example

Source: https://shopify.dev/docs/apps/build/checkout/migrate-to-web-components/inline-layout

Pre-Polaris (2025-07) version using the old InlineLayout component. Shows the previous pattern that the new s-grid example replaces.

```tsx
import {
  reactExtension,
  InlineLayout,
  Text,
} from '@shopify/ui-extensions-react/checkout';

export default reactExtension(
  'purchase.checkout.block.render',
  () => <Extension />,
);

function Extension() {
  return (
    <InlineLayout columns={['fill', 'auto']} spacing="base">
      <Text>Product name</Text>
      <Text>$9.99</Text>
    </InlineLayout>
  );
}
```

--------------------------------

### Migrating padding values: Pre-Polaris (2025-07) modal example

Source: https://shopify.dev/docs/apps/build/checkout/migrate-to-web-components/modal

Pre-Polaris (2025-07) version of the modal example. Uses the React `Modal` component with `padding={false}` and the `overlay` prop on `Button`.

```tsx
import {
  reactExtension,
  Button,
  Modal,
  TextBlock,
} from '@shopify/ui-extensions-react/checkout';

export default reactExtension(
  'purchase.checkout.block.render',
  () => <Extension />,
);

function Extension() {
  return (
    <Button
      overlay={
        <Modal id="settings-modal" title="Settings" padding={false}>
          <TextBlock>Content of the modal</TextBlock>
        </Modal>
      }
    >
      Open settings
    </Button>
  );
}
```

--------------------------------

### Checkout UI extension in React (Checkout.jsx) - full example

Source: https://shopify.dev/docs/apps/build/checkout/product-offers/build-a-pre-purchase-offer

This snippet is the complete React component for a pre-pickup offer feature. It uses Shopify's use of the `useState` and `useEffect` hooks to manage state and side effects, performs a GraphQL-like query to fetch products, and provides a user interface with buttons to add items to the cart, including error handling and a loading skeleton. The code is intended to be used as a starting point for implementing a similar feature in a React-based project, particularly within a Shopify environment, and it demonstrates best practices for handling asynchronous operations and user interactions. It also includes helper components like `LoadingSkeleton` and `ProductOfferErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorB/ErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorBannerErrorB. ErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorError input input input input input input input input input input input input input input input input input input input input input input input input input input input input input input input input input input input input input input input input input input input input input input input input input input input input input input input handleAddToCart handleAddToCart handleAddToCart handleAddToCart handleAddToCart handleAddToCart handlePropErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorError:ErrorErrorErrorErrorErrorErrorErrorErrorErrorError calls calls calls calls calls calls calls calls calls calls applyCartLinesChange applyCartLinesChange applyCartLinesChange applyCartLinesChange applyCartLinesChange applyCartLinesChange applyCartLinesChange applyCartLinesChange applyCart's applyCartLinesChange applyCartLinesChange applyCartLinesErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorProductOfferProductOfferProductOfferProductOfferProductOfferProductOfferProductOfferProductOfferProductErrorErrorErrorErrorLoadingSkeletonLoadingSkeletonLoadingSkeletonLoadingSkeletonLoadingSkeletonLoadingSkeletonLoadingSkeletonLoadingSkeletonLoadingSkeletonLoadingSCartCartCartCartCartCartCartCartCartCartCartCartCartCartCartCartCartCartCartCartCartCartCartCartCartCartCartCartCartCartCartCartCartCartCartCartCartErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorLoadingLoadingLoadingLoadingLoadingLoadingLoadingLoadingLoadingLoadingLoadingLoadingLoadingLoadingLoadingLoadingLoadingLoadingLoadingLoadingErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrori18n i18n query query query query query query query query query query query query query query query query query query query query query query query query product product product title title title images images images variants variants variants price price price amount amount amount url url url id id id name name name name name name name name name name name name product product product product product product product product product product product product product productErrorErrorErrorLoadingLoadingLoadingLoadingLoadingLoadingLoadingLoadingLoadingLoadingLoadingLoadingLoadingLoadingErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorApplyCartLinesChangeApplyCartMerchandiseIdMerchandiseQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQuantityQueryQueryQueryQueryQueryQueryQueryQueryQueryQueryQueryQueryErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorDataDataDataDataDataDataDataDataDataDataProductsProductsProductsProductsProductsProductsProductsProductsProductsProductsProductsProductsProductsProductsProductsProductsProductsProductsProductsProductsProductsProductsProductsProductsProductsProductsProductsProductsProductsProductsProductsProductsProductsProductsProductsProductsProductsProductsProductsProductsProductsProductsProductsProductsErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorSetLoadingSetLoadingSetLoadingSetLoadingSetLoadingSetLoadingSetLoadingSetLoadingSetLoadingSetLoadingSetLoadingSetLoadingSetLoadingSetLoadingSetLoadingSetLoadingSetLoadingSetExtensionExtensionExtensionExtensionExtensionExtensionRenderRenderRenderRenderRenderRenderRenderRenderErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorDocumentDocumentDocumentBodyBodyBodyBodyBodyBodyBodyBodyBodyBodyBodyBodyBodyBodyBodyBodyBodyBodyGetProductsOnOfferGetProductsGetProductsGetProductsGetProductsGetProductsGetProductsGetProductsGetProductsGetProductsGetProductsGetProductsGetProductsGetProductsGetProductsGetProductsGetProductsGetProductsGetRenderingRenderingRenderingRenderingRenderingRenderingRenderingRenderingRenderingRenderingRenderingRenderingRenderingRenderingRenuErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorStackStackStackStackStackStackStackStackStackStackStackStackStackStackStackStackStackStackStackStackStackStackErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorDividerDividerHeadingHeadingHeadingGridGridGridImageImageImageButtonButtonButtonButtonButtonButtonButtonButtonButtonButtonButtonButtonButtonButtonButtonButtonButtonHeadingHeadingHeadingHeadingHeadingHeadingHeadingHeadingHeadingHeadingHeadingHeadingErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorButtonButtonButtonButtonButtonButtonVariantVariantVariantVariantVariantVariantVariantVariantVariantVariantVariantV- variant variant variant variant variant variant variant variant variant variant variant variant variant variant variant variant variant variant variant variant variant variant variant variant variant variant variant variant variant variant variantErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorRenderPriceRenderPriceRenderPriceRenderPriceRenderI18nI18nImageUrlImageUrlImageUrlImageErrorErrorErrorErrorErrorErrorStackStackStackDividerDividerHeadingHeadingGridGridImageImageButtonButtonButtonButtonButtonButtonButtonButtonButtonButtonButtonButtonButtonButtonErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorNullNullNullNullNullNullNullNullNullNullNullNullNullNullNullNullNullNullNullNullNullNullNullNullNullNullNullNullNullNullNullNullNullNullNullNullNullNullNullNullNullNullNullErrorErrorErrorErrorErrorError error error error error error error error error error error error error error error error error error error error error error error error error error error error error error error error error error error error error offer offer offer offer offer offer offer offer offer offer offer offer offer offer offer offer offer offer offer offer offer offer offer offer offer offer offer offer offer offer offer offer offer offer offer offer offer offer offer offer offer offer offer offer offer offer offer offer offer offer offer offer offer offer offer offer offer offer offer offer offer offer offer offer offer offerErrorErrorErrorCartCartCartCartCartCartCartCartCartCartMerchandiseMerchandiseProductProductProductProductProductProductProductProductProductProductProductProductProductProductProductProductProductProductProductProductProductProductProductProductProductProductProductProductProductProductProductProductProductProductProductProductProductProductProductProductProductProductProductProductProductProductProductProductProductProductProductProductProductProductProductProductProductProductProductProductProductProductProductProductProductProductProductProductProductErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorCartCartCartCartCartCartCartCartCartCartCartCartCartCartCartCartCartCartCartCartCartCartCartCartCartCartCartCartCartCartCartCartProductProductProductProductProductProductProductProductProductProductProductProductProductProductProductProductProductProduct loading loading loading loading loading loading loading loading loading loading loading loading loading loading loading loading loading loading loading loading loading loading loading loading loading loading loading loading loading loading loading loading loading loading loading loading loading loading loading loading loading loading loading loading loading loading loading loading loading loading loading loading loading loading loading loading loading loading loading loading loadingCartCartCartCartCartCartCartCartCartCartCartCartCartCartCartCartCartCart logic logic logic logic logic logic logic logic logic logic logic logic logic logicErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorShopifyShopifyShopifyShopifyShop}

```jsx import
import "@shopify/ui-extensions/preact";
import { render } 
import { useEffect, useState } from "preact/hooks";


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


function Extension() {
  const { applyCartLinesChange, query, i       18n } = shopify;
  const [products, setProducts] = ExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtension import import import import import import import import import import { render } from "preact";
import { useEffect, useState } from "preact/hooks";


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


function Extension() {
  const { applyCartLinesChange, query, i18n } = shopify;
  const [products, setProducts] = ExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtension import import import ExtensionExtensionExtensionExtensionExtensionExtension import import import import import import import import import import import import import import import import import import import import import import import import import import          import import import import import import useState useState useState useState useState useState useState useState useState useState useState useState useState useState useState useState useState useState useState useState useState useState useState useState useState useState useState useState useState useState useState useState useState useState useState useStateExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtension import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import importExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtension import import import import import import import import import import import import import import import import import import snippet snippet snippet snippet snippet snippet snippet snippet snippet snippet snippet snippet snippet snippet snippet snippet snippet snippet snippet snippet snippet snippet snippet snippet snippet snippet snippet snippet snippet snippet snippet snippet snippet snippet snippet snippet snippet snippet snippet snippet snippet snippet snippet snippet snippet snippet snippet snippet snippet snippet snippet snippetExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtension handleAddToCart handleAddToExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtension fetchProducts fetchProducts fetchProducts fetchProducts fetchProducts fetchProducts fetchProducts fetchProducts fetchProducts fetchProducts fetchProducts fetchProducts fetchProducts fetchProducts fetchProducts fetchProducts fetchProducts fetchProducts fetchProducts fetchProducts fetchProducts fetchProducts fetchCodeCodeCodeCodeCodeCodeCodeCodeCodeCodeCodeCodeCodeCodeCodeCodeLoadingSkeletonLoadingSkeletonLoadingSkeletonLoadingSkeletonLoadingSkeletonLoadingSkeletonLoadingSkeletonLoadingSkeletonLoadingSkeletonLoadingSectionsSectionsSectionsSectionsSectionsSectionsSectionsSectionsSectionsSectionsSectionsSectionsSectionsSectionsSectionsSectionsSectionsSectionsSectionsSectionsSectionsSectionsSectionsSectionsSectionsSectionsSectionsSectionsSectionsSectionsSectionsSectionsSectionsSectionsSnippetsSnippetsSnippetsSnippetsSnippetsSchemaSchemaSchemaSchemaSchemaSchemaSchemaSchemaSchemaSchemaSchemaSchemaSchemaSchemaSchemaSchemaSchemaSchemaSchemaSchemaSchemaSchemaProductOfferProductOfferProductErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorErrorProductOfferProductOfferProductOfferProductOfferProductOfferProductOfferProductOfferProductOfferProductOfferProductOfferProductOfferProductOfferProductOfferProductOfferProductOfferProductOfferProductOfferProductOfferProductOfferProductOfferProductOfferProductOfferProductOfferProductOfferProductOfferProductExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExtensionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionExceptionException import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import import 
```

--------------------------------

### Format suggestion extension example

Source: https://shopify.dev/docs/apps/build/checkout/delivery-shipping/address-autocomplete/format-suggestion

Example implementation for the `purchase.address-autocomplete.format-suggestion` target. It fetches suggestions from a static file and maps them to the expected format. The `fetchSuggestions` function passes the `signal` to each fetch request.

```javascript
export default async () => {
      const {field, value, selectedCountryCode} = shopify.target;
      const response = await fetchSuggestions(
        field,
        value,
        selectedCountryCode,
        shopify.signal
      );
      const { result } = await response.json();


      const suggestions = result.suggestions.map((suggestion) => {
        return {
          id: suggestion.global_address_key,
          label: suggestion.text,
          matchedSubstrings: suggestion.matched,
        };
      });


      return { suggestions };
    }


  /**
   * In this example, suggestions are fetched from a static file. In your implementation,
   * use the address field and its current query value to fetch meaningful address suggestions.
   */
  async function fetchSuggestions(_field, _value, _selectedCountryCode, signal) {
    return fetch(
      `https://shopify.github.io/address-autocomplete/address-autocomplete.json`,
      {
        // Pass `signal` to each fetch request
        signal,
      }
    );
  }
```
Tokens:
Raw