---
title: ProductSearch API
description: The ProductSearch API gives extensions access to the native product search and fetching functionality of Shopify POS. The interface provides numerous functions to search for products by query, or to fetch the details of one or more products or product variants.
api_version: 2024-10
api_name: pos-ui-extensions
source_url:
  html: https://shopify.dev/docs/api/pos-ui-extensions/2024-10/apis/productsearch-api
  md: https://shopify.dev/docs/api/pos-ui-extensions/2024-10/apis/productsearch-api.md
---

# Product​Search APIAPIs

The ProductSearch API gives extensions access to the native product search and fetching functionality of Shopify POS. The interface provides numerous functions to search for products by query, or to fetch the details of one or more products or product variants.

## ProductSearchApi

* fetchPaginatedProductVariantsWithProductId

  (productId: number, paginationParams: PaginationParams) => Promise\<PaginatedResult\<ProductVariant>>

  required

  Fetches a page of product variants associated with a product.

* fetchProductsWithIds

  (productIds: number\[]) => Promise\<MultipleResourceResult\<Product>>

  required

  Fetches multiple products' details.

* fetchProductVariantsWithIds

  (productVariantIds: number\[]) => Promise\<MultipleResourceResult\<ProductVariant>>

  required

  Fetches multiple product variants' details.

* fetchProductVariantsWithProductId

  (productId: number) => Promise\<ProductVariant\[]>

  required

  Fetches all product variants associated with a product.

* fetchProductVariantWithId

  (productVariantId: number) => Promise\<ProductVariant>

  required

  Fetches a single product variant's details.

* fetchProductWithId

  (productId: number) => Promise\<Product>

  required

  Fetches a single product's details.

* searchProducts

  (searchParams: ProductSearchParams) => Promise\<PaginatedResult\<Product>>

  required

  Search for products on the POS device.

### PaginationParams

Base interface for pagination.

* afterCursor

  Specifies the page cursor. Items after this cursor will be returned.

  ```ts
  string
  ```

* first

  Specifies the number of results to be returned in this page. The maximum number of items that will be returned is 50.

  ```ts
  number
  ```

```ts
export interface PaginationParams {
  /**
   * Specifies the number of results to be returned in this page. The maximum number of items that will be returned is 50.
   */
  first?: number;
  /**
   * Specifies the page cursor. Items after this cursor will be returned.
   */
  afterCursor?: string;
}
```

### PaginatedResult

Contains a page of fetched results.

* hasNextPage

  Whether or not there is another page of results that can be fetched.

  ```ts
  boolean
  ```

* items

  The items returned from the fetch.

  ```ts
  T[]
  ```

* lastCursor

  The cursor of the last item. This can be used to fetch more results. The format of this cursor may look different depending on if POS is fetching results from the remote API, or its local database. However, that should not affect its usage with the search functions.

  ```ts
  string
  ```

```ts
export interface PaginatedResult<T> {
  /**
   * The items returned from the fetch.
   */
  items: T[];

  /**
   * The cursor of the last item. This can be used to fetch more results.
   * The format of this cursor may look different depending on if POS is fetching results from the remote API, or its local database. However, that should not affect its usage with the search functions.
   */
  lastCursor?: string;

  /**
   * Whether or not there is another page of results that can be fetched.
   */
  hasNextPage: boolean;
}
```

### ProductVariant

* barcode

  ```ts
  string
  ```

* compareAtPrice

  ```ts
  string
  ```

* createdAt

  ```ts
  string
  ```

* displayName

  ```ts
  string
  ```

* hasInStockVariants

  ```ts
  boolean
  ```

* id

  ```ts
  number
  ```

* image

  ```ts
  string
  ```

* inventoryAtAllLocations

  ```ts
  number
  ```

* inventoryAtLocation

  ```ts
  number
  ```

* inventoryIsTracked

  ```ts
  boolean
  ```

* inventoryPolicy

  ```ts
  ProductVariantInventoryPolicy
  ```

* options

  ```ts
  ProductVariantOption[]
  ```

* position

  ```ts
  number
  ```

* price

  ```ts
  string
  ```

* product

  ```ts
  Product
  ```

* productId

  ```ts
  number
  ```

* sku

  ```ts
  string
  ```

* taxable

  ```ts
  boolean
  ```

* title

  ```ts
  string
  ```

* updatedAt

  ```ts
  string
  ```

```ts
export interface ProductVariant {
  id: number;
  createdAt: string;
  updatedAt: string;
  title: string;
  price: string;
  compareAtPrice?: string;
  taxable: boolean;
  sku?: string;
  barcode?: string;
  displayName: string;
  image?: string;
  inventoryIsTracked: boolean;
  inventoryAtLocation?: number;
  inventoryAtAllLocations?: number;
  inventoryPolicy: ProductVariantInventoryPolicy;
  hasInStockVariants?: boolean;
  options?: ProductVariantOption[];
  product?: Product;
  productId: number;
  position: number;
}
```

### ProductVariantInventoryPolicy

```ts
'DENY' | 'CONTINUE'
```

### ProductVariantOption

* name

  ```ts
  string
  ```

* value

  ```ts
  string
  ```

```ts
export interface ProductVariantOption {
  name: string;
  value: string;
}
```

### Product

* createdAt

  ```ts
  string
  ```

* description

  ```ts
  string
  ```

* descriptionHtml

  ```ts
  string
  ```

* featuredImage

  ```ts
  string
  ```

* hasInStockVariants

  ```ts
  boolean
  ```

* hasOnlyDefaultVariant

  ```ts
  boolean
  ```

* id

  ```ts
  number
  ```

* isGiftCard

  ```ts
  boolean
  ```

* maxVariantPrice

  ```ts
  string
  ```

* minVariantPrice

  ```ts
  string
  ```

* numVariants

  ```ts
  number
  ```

* onlineStoreUrl

  ```ts
  string
  ```

* options

  ```ts
  ProductOption[]
  ```

* productCategory

  ```ts
  string
  ```

* productType

  ```ts
  string
  ```

* tags

  ```ts
  string[]
  ```

* title

  ```ts
  string
  ```

* totalAvailableInventory

  ```ts
  number
  ```

* totalInventory

  ```ts
  number
  ```

* tracksInventory

  ```ts
  boolean
  ```

* updatedAt

  ```ts
  string
  ```

* variants

  ```ts
  ProductVariant[]
  ```

* vendor

  ```ts
  string
  ```

```ts
export interface Product {
  id: number;
  createdAt: string;
  updatedAt: string;
  title: string;
  description: string;
  descriptionHtml: string;
  featuredImage?: string;
  isGiftCard: boolean;
  tracksInventory: boolean;
  vendor: string;
  minVariantPrice: string;
  maxVariantPrice: string;
  productType: string;
  productCategory: string;
  tags: string[];
  numVariants: number;
  totalAvailableInventory?: number;
  totalInventory: number;
  variants: ProductVariant[];
  options: ProductOption[];
  hasOnlyDefaultVariant: boolean;
  hasInStockVariants?: boolean;
  onlineStoreUrl?: string;
}
```

### ProductOption

* id

  ```ts
  number
  ```

* name

  ```ts
  string
  ```

* optionValues

  ```ts
  string[]
  ```

* productId

  ```ts
  number
  ```

```ts
export interface ProductOption {
  id: number;
  name: string;
  optionValues: string[];
  productId: number;
}
```

### MultipleResourceResult

The result of a fetch function where the input is multiple IDs. This object contains the resources that were found, as well as an array of IDs specifying which IDs, if any, did not correspond to a resource.

* fetchedResources

  The resources that were fetched using the IDs provided.

  ```ts
  T[]
  ```

* idsForResourcesNotFound

  The IDs for which a resource was not found.

  ```ts
  number[]
  ```

```ts
export interface MultipleResourceResult<T> {
  /**
   * The resources that were fetched using the IDs provided.
   */
  fetchedResources: T[];
  /**
   * The IDs for which a resource was not found.
   */
  idsForResourcesNotFound: number[];
}
```

### ProductSearchParams

Interface for product search

* afterCursor

  Specifies the page cursor. Items after this cursor will be returned.

  ```ts
  string
  ```

* first

  Specifies the number of results to be returned in this page. The maximum number of items that will be returned is 50.

  ```ts
  number
  ```

* queryString

  The search term to be used to search for POS products.

  ```ts
  string
  ```

* sortType

  Specifies the order in which products should be sorted. When a \`queryString\` is provided, sortType will not have any effect, as the results will be returned in order by relevance to the \`queryString\`.

  ```ts
  ProductSortType
  ```

```ts
export interface ProductSearchParams extends PaginationParams {
  /**
   * The search term to be used to search for POS products.
   */
  queryString?: string;
  /**
   * Specifies the order in which products should be sorted. When a `queryString` is provided, sortType will not have any effect, as the results will be returned in order by relevance to the `queryString`.
   */
  sortType?: ProductSortType;
}
```

### ProductSortType

```ts
'RECENTLY_ADDED' | 'RECENTLY_ADDED_ASCENDING' | 'ALPHABETICAL_A_TO_Z' | 'ALPHABETICAL_Z_TO_A'
```

## Examples

Examples of using the Cart API

Search for products with a search bar

Fetch a specific product with a product ID

Fetch multiple products by specifying product IDs

Fetch a specific product variant with a variant ID

Fetch multiple product variants by specifying variant IDs

Fetch a page of product variants with a specific product ID

### Examples

* #### Search for products with a search bar

  ##### React

  ```tsx
  import React, { useState } from 'react'

  import { Screen, List, Navigator, reactExtension, SearchBar, useApi, ListRow } from '@shopify/ui-extensions-react/point-of-sale';

  const Modal = () => {
    const api = useApi<'pos.home.modal.render'>();
    const [data, setData] = useState<ListRow[]>([]);

    const search = async (queryString?: string) => {
      const results = await api.productSearch.searchProducts({queryString})
      const data = results.items.map((product): ListRow => {
        return {
          id: String(product.id),
          leftSide: {
            label: product.title,
            image: {
              source: product.featuredImage
            }
          }
        }
      })

      setData(data)
    }

    return (
      <Navigator>
        <Screen name="HelloWorld" title="Hello World!">
          <List
            listHeaderComponent={<SearchBar 
              placeholder='Search products'
              onTextChange={search}
              onSearch={search}
            />}
          imageDisplayStrategy='always'
          data={data}
          />
        </Screen>
      </Navigator>
    )
  }

  export default reactExtension('pos.home.modal.render', () => <Modal />);
  ```

  ##### TS

  ```ts
  import {
    SearchBar,
    Screen,
    Navigator,
    extension,
    ListRow,
    List,
  } from '@shopify/ui-extensions/point-of-sale';

  export default extension('pos.home.modal.render', (root, api) => {
    const list = root.createComponent(List, {
      imageDisplayStrategy: 'always',
      data: [],
    });

    const search = async (queryString?: string) => {
      const results = await api.productSearch.searchProducts({queryString});
      const data = results.items.map((product): ListRow => {
        return {
          id: String(product.id),
          leftSide: {
            label: product.title,
            image: {
              source: product.featuredImage,
            },
          },
        };
      });

      list.updateProps({data});
    };

    const searchBar = root.createFragment();

    searchBar.append(
      root.createComponent(SearchBar, {
        placeholder: 'Search products',
        onTextChange: search,
        onSearch: search,
      }),
    );

    list.updateProps({listHeaderComponent: searchBar});

    const screen = root.createComponent(Screen, {
      title: 'Home',
      name: 'Home',
    });

    screen.append(list);

    const navigator = root.createComponent(Navigator);
    navigator.append(screen);

    root.append(navigator);
  });
  ```

* #### Fetch a specific product with a product ID

  ##### React

  ```tsx
  import React, { useEffect, useState } from 'react'

  import { Screen, List, Navigator, reactExtension, SearchBar, useApi, ListRow } from '@shopify/ui-extensions-react/point-of-sale';

  const Modal = () => {
    const api = useApi<'pos.home.modal.render'>();
    const [data, setData] = useState<ListRow[]>([]);

    useEffect(() => {
      const fetchProduct = async () => {
        const resultProduct = await api.productSearch.fetchProductWithId(1)
    
        if (resultProduct) { 
          const listItem = {
            id: String(resultProduct.id),
            leftSide: {
              label: resultProduct.title,
              image: {
                source: resultProduct.featuredImage
              }
            }
          }
          setData([listItem])
        }
      }

      fetchProduct();
    }, []);

    return (
      <Navigator>
        <Screen name="HelloWorld" title="Hello World!">
          <List
            imageDisplayStrategy='always'
            data={data}
          />
        </Screen>
      </Navigator>
    )
  }

  export default reactExtension('pos.home.modal.render', () => <Modal />);
  ```

  ##### TS

  ```ts
  import {
    SearchBar,
    Screen,
    Navigator,
    extension,
    ListRow,
    List,
  } from '@shopify/ui-extensions/point-of-sale';

  export default extension('pos.home.modal.render', (root, api) => {
    const list = root.createComponent(List, {
      imageDisplayStrategy: 'always',
      data: [],
    });

    const fetchProduct = async () => {
      const resultProduct = await api.productSearch.fetchProductWithId(1);
      if (resultProduct) {
        const listItem = {
          id: String(resultProduct.id),
          leftSide: {
            label: resultProduct.title,
            image: {
              source: resultProduct.featuredImage,
            },
          },
        };

        list.updateProps({data: [listItem]});
      }
    };

    const screen = root.createComponent(Screen, {
      title: 'Home',
      name: 'Home',
    });

    screen.append(list);

    const navigator = root.createComponent(Navigator);
    navigator.append(screen);

    root.append(navigator);

    fetchProduct();
  });
  ```

* #### Fetch multiple products by specifying product IDs

  ##### React

  ```tsx
  import React, { useEffect, useState } from 'react'

  import { Screen, List, Navigator, reactExtension, SearchBar, useApi, ListRow } from '@shopify/ui-extensions-react/point-of-sale';

  const Modal = () => {
    const api = useApi<'pos.home.modal.render'>();
    const [data, setData] = useState<ListRow[]>([]);

    useEffect(() => {
      const fetchProducts = async () => {
        const results = await api.productSearch.fetchProductsWithIds([1, 2, 3]);
        const data = results.fetchedResources.map((product): ListRow => {
          return {
            id: String(product.id),
            leftSide: {
              label: product.title,
              image: {
                source: product.featuredImage
              }
            }
          }
        })

        console.log('IDs not found: ', results.idsForResourcesNotFound);
    
        setData(data)
      }

      fetchProducts();
    }, []);

    return (
      <Navigator>
        <Screen name="HelloWorld" title="Hello World!">
          <List
            imageDisplayStrategy='always'
            data={data}
          />
        </Screen>
      </Navigator>
    )
  }

  export default reactExtension('pos.home.modal.render', () => <Modal />);
  ```

  ##### TS

  ```ts
  import {
    SearchBar,
    Screen,
    Navigator,
    extension,
    ListRow,
    List,
  } from '@shopify/ui-extensions/point-of-sale';

  export default extension('pos.home.modal.render', (root, api) => {
    const list = root.createComponent(List, {
      imageDisplayStrategy: 'always',
      data: [],
    });

    const fetchProducts = async () => {
      const results = await api.productSearch.fetchProductsWithIds([1, 2, 3, 4]);
      const data = results.fetchedResources.map((product): ListRow => {
        return {
          id: String(product.id),
          leftSide: {
            label: product.title,
            image: {
              source: product.featuredImage,
            },
          },
        };
      });

      console.log('IDs not found: ', results.idsForResourcesNotFound);

      list.updateProps({data});
    };

    const screen = root.createComponent(Screen, {
      title: 'Home',
      name: 'Home',
    });

    screen.append(list);

    const navigator = root.createComponent(Navigator);
    navigator.append(screen);

    root.append(navigator);

    fetchProducts();
  });
  ```

* #### Fetch a specific product variant with a variant ID

  ##### React

  ```tsx
  import React, { useEffect, useState } from 'react'

  import { Screen, List, Navigator, reactExtension, SearchBar, useApi, ListRow } from '@shopify/ui-extensions-react/point-of-sale';

  const Modal = () => {
    const api = useApi<'pos.home.modal.render'>();
    const [data, setData] = useState<ListRow[]>([]);

    useEffect(() => {
      const fetchProductVariant = async () => {
        const resultProductVariant = await api.productSearch.fetchProductVariantWithId(1);
    
        if (resultProductVariant) { 
          const listItem = {
            id: String(resultProductVariant.id),
            leftSide: {
              label: resultProductVariant.title,
              image: {
                source: resultProductVariant.image
              }
            }
          }
          setData([listItem])
        }
      }

      fetchProductVariant();
    }, []);

    return (
      <Navigator>
        <Screen name="HelloWorld" title="Hello World!">
          <List
            imageDisplayStrategy='always'
            data={data}
          />
        </Screen>
      </Navigator>
    )
  }

  export default reactExtension('pos.home.modal.render', () => <Modal />);
  ```

  ##### TS

  ```ts
  import {
    SearchBar,
    Screen,
    Navigator,
    extension,
    ListRow,
    List,
  } from '@shopify/ui-extensions/point-of-sale';

  export default extension('pos.home.modal.render', (root, api) => {
    const list = root.createComponent(List, {
      imageDisplayStrategy: 'always',
      data: [],
    });

    const fetchProductVariant = async () => {
      const resultProductVariant =
        await api.productSearch.fetchProductVariantWithId(1);
      if (resultProductVariant) {
        const listItem = {
          id: String(resultProductVariant.id),
          leftSide: {
            label: resultProductVariant.title,
            image: {
              source: resultProductVariant.image,
            },
          },
        };

        list.updateProps({data: [listItem]});
      }
    };

    const screen = root.createComponent(Screen, {
      title: 'Home',
      name: 'Home',
    });

    screen.append(list);

    const navigator = root.createComponent(Navigator);
    navigator.append(screen);

    root.append(navigator);

    fetchProductVariant();
  });
  ```

* #### Fetch multiple product variants by specifying variant IDs

  ##### React

  ```tsx
  import React, { useEffect, useState } from 'react'

  import { Screen, List, Navigator, reactExtension, SearchBar, useApi, ListRow } from '@shopify/ui-extensions-react/point-of-sale';

  const Modal = () => {
    const api = useApi<'pos.home.modal.render'>();
    const [data, setData] = useState<ListRow[]>([]);

    useEffect(() => {
      const fetchProductVariants = async () => {
        const results = await api.productSearch.fetchProductVariantsWithIds([1, 2, 3]);
        const data = results.fetchedResources.map((variant): ListRow => {
          return {
            id: String(variant.id),
            leftSide: {
              label: variant.title,
              image: {
                source: variant.image
              }
            }
          }
        })

        console.log('IDs not found: ', results.idsForResourcesNotFound);
    
        setData(data)
      }

      fetchProductVariants();
    }, []);

    return (
      <Navigator>
        <Screen name="HelloWorld" title="Hello World!">
          <List
            imageDisplayStrategy='always'
            data={data}
          />
        </Screen>
      </Navigator>
    )
  }

  export default reactExtension('pos.home.modal.render', () => <Modal />);
  ```

  ##### TS

  ```ts
  import {
    SearchBar,
    Screen,
    Navigator,
    extension,
    ListRow,
    List,
  } from '@shopify/ui-extensions/point-of-sale';

  export default extension('pos.home.modal.render', (root, api) => {
    const list = root.createComponent(List, {
      imageDisplayStrategy: 'always',
      data: [],
    });

    const fetchProductVariants = async () => {
      const results = await api.productSearch.fetchProductVariantsWithIds([
        1, 2, 3, 4,
      ]);
      const data = results.fetchedResources.map((variant): ListRow => {
        return {
          id: String(variant.id),
          leftSide: {
            label: variant.title,
            image: {
              source: variant.image,
            },
          },
        };
      });

      console.log('IDs not found: ', results.idsForResourcesNotFound);

      list.updateProps({data});
    };

    const screen = root.createComponent(Screen, {
      title: 'Home',
      name: 'Home',
    });

    screen.append(list);

    const navigator = root.createComponent(Navigator);
    navigator.append(screen);

    root.append(navigator);

    fetchProductVariants();
  });
  ```

* #### Fetch a page of product variants with a specific product ID

  ##### React

  ```tsx
  import React, { useEffect, useState } from 'react'

  import { Screen, List, Navigator, reactExtension, SearchBar, useApi, ListRow } from '@shopify/ui-extensions-react/point-of-sale';

  const Modal = () => {
    const api = useApi<'pos.home.modal.render'>();
    const [data, setData] = useState<ListRow[]>([]);

    useEffect(() => {
      const fetchProductVariants = async () => {
        const results = await api.productSearch.fetchPaginatedProductVariantsWithProductId(1, {first: 10});
        const data = results.items.map((variant): ListRow => {
          return {
            id: String(variant.id),
            leftSide: {
              label: variant.title,
              image: {
                source: variant.image
              }
            }
          }
        })
    
        console.log('Cursor for next page: ', results.lastCursor);
        setData(data)
      }

      fetchProductVariants();
    }, []);

    return (
      <Navigator>
        <Screen name="HelloWorld" title="Hello World!">
          <List
            imageDisplayStrategy='always'
            data={data}
          />
        </Screen>
      </Navigator>
    )
  }

  export default reactExtension('pos.home.modal.render', () => <Modal />);
  ```

  ##### TS

  ```ts
  import {
    SearchBar,
    Screen,
    Navigator,
    extension,
    ListRow,
    List,
  } from '@shopify/ui-extensions/point-of-sale';

  export default extension('pos.home.modal.render', (root, api) => {
    const list = root.createComponent(List, {
      imageDisplayStrategy: 'always',
      data: [],
    });

    const fetchProductVariants = async () => {
      const results =
        await api.productSearch.fetchPaginatedProductVariantsWithProductId(1, {
          first: 10,
        });
      const data = results.items.map((variant): ListRow => {
        return {
          id: String(variant.id),
          leftSide: {
            label: variant.title,
            image: {
              source: variant.image,
            },
          },
        };
      });

      console.log('Cursor for next page: ', results.lastCursor);

      list.updateProps({data});
    };

    const screen = root.createComponent(Screen, {
      title: 'Home',
      name: 'Home',
    });

    screen.append(list);

    const navigator = root.createComponent(Navigator);
    navigator.append(screen);

    root.append(navigator);

    fetchProductVariants();
  });
  ```