[System] You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development.

[User] Provide a guide on guides change order in VTEX.

[Assistant]
Documentation

[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)

[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/api-reference)

[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/storefront-development)

[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/troubleshooting)

[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/updates/release-notes)

Guides

[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/vtex-platform-overview)

---

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/api-usage)

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/getting-started)

---

Integration Guides

---

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/catalog-integration)

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/checkout-api-overview)

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/master-data)

---

Payments

---

Orders

[Feed v3](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/orders-feed)

[Order modifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/order-modifications)

[Change seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/change-seller)

[Cancel order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/order-canceling-improvements)

[Actions in orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/actions-orders)

Subscriptions

---

Logistics

---

B2B Suite

---

VTEX Sales App

---

UI Customization

---

Message Center

---

Pricing

---

Promotions

---

Infrastructure

---

Search

---

Storefront Permissions

---

[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/activity-flow)

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/vtex-ads)

---

VTEX Session

---

VTEX Shield

---

[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/data-protection-plus)

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/updates/release-notes)

Guides

[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/vtex-platform-overview)

---

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/api-usage)

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/getting-started)

---

Integration Guides

---

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/catalog-integration)

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/checkout-api-overview)

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/master-data)

---

Payments

---

Orders

[Feed v3](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/orders-feed)

[Order modifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/order-modifications)

[Change seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/change-seller)

[Cancel order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/order-canceling-improvements)

[Actions in orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/actions-orders)

Subscriptions

---

Logistics

---

B2B Suite

---

VTEX Sales App

---

UI Customization

---

Message Center

---

Pricing

---

Promotions

---

Infrastructure

---

Search

---

Storefront Permissions

---

[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/activity-flow)

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/vtex-ads)

---

VTEX Session

---

VTEX Shield

---

[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/data-protection-plus)

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides)

Orders

[Order modifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/order-modifications)

Order modifications

Order modification is a feature that allows your store to modify the items or prices of an order. With this feature, the store can handle potential changes in orders due to customer mistakes, product unavailability, and the inclusion of discounts, among other reasons. Learn more about how it works and its restrictions in the article [Changing items from a completed order](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/changing-items-from-a-complete-order--tutorials%5F190).

> We recommend that you use the [Create order modifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23patch-/api/order-system/orders/-changeOrderId-/changes) endpoint to modify an order.

> The [Order modifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23patch-/api/order-system/orders/-changeOrderId-/changes) feature is not applicable to the Catalog API - Seller Portal.

> Learn more about [Order replacement](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/order-replacement--2IK9mwQjBKseQmE8K8saO8) and how to enable your customers to request order changes.

## Implementation

The [Register modifications on order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23post-/api/oms/pvt/orders/-orderId-/changes) endpoint in the Orders API allows you to create a discount, change an item, or increase the price of an order.

> When removing or adding items to an order, the inventory of the affected SKUs is not updated automatically. You should update it [using the Logistics API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23put-/logistics/pvt/inventory/skus/-skuId-/warehouses/-warehouseId-).

Modifications made this way can be confirmed using the `changesAttachment` field in the response of the [Get order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23get-/api/oms/pvt/orders/-orderId-) endpoint. Alternatively, you may search for the order in the **Orders > Orders management > All orders** section of your Admin panel and see the item modification history in the order details.

> Increasing the price of an order is only available for credit card purchases. The connector must also be able to handle purchases without the CVV, as well as duplicate sequences.

### Errors in Change v1

See below which API errors can be returned when attempting to [modify an order via Change v1 API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23post-/api/oms/pvt/orders/-orderId-/changes) and how to avoid or work around them.

#### Request errors

These errors happen when there are one or more errors in the information sent in the request.

| Error                                                         | Description                                                                                |
| ------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
| The modification value needs to be greater or equal than zero | discountValue or incrementValue is less than 0.                                                                                |
| Invalid modification for order                                | All of these conditions are true:  \- incrementValue is equal to discountValue.  \- itemsAdded is empty.  \- itemsRemoved is empty. |
| Invalid id for item                                           | The request body contains either an itemsAdded or itemsRemoved object that has an empty id.                                         |
| Field reason not set                                          | Empty reason field.                                                                                |

#### Restriction errors

These are errors returned when the request is correct but the order cannot be modified due to [order change restrictions](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/changing-items-from-a-complete-order--tutorials%5F190%23restrictions).

| Error                                                                                | Description                                                                                |
| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| It is only allowed to register an order modification when the order is in handling: status = handling, waiting for fulfillment or ready for invoicing | The fulfillment order is not in a status that allows changes (handling, waiting for fulfillment and ready-for-invoice).                                                                                |
| It is not allowed to make modifications to chain orders                                                                                | The order has a chain origin.                                                                                |
| It is only allowed to register a modification in the order when the payment is approved - status = payment-approved                                   | The marketplace order is not in the status payment-approved.                                                                                |
| The value of the modification exceeds the order's price                                                                                | discountValue is greater than the total order price.                                                                                |
| Impossible cancel order {0} - Payment not found                                                                                | Order is complete, but transaction id is empty or null.                                                                                |
| Workflow not found for order {0}                                                                                | Order has an empty or null workflowInstanceId.                                                                                |
| Max allowed modifications for order exceeded: {0}                                                                                | More than 50 registered modification requests for a single order.                                                                                |
| 404 Not Found                                                                                | At least one of these conditions is true:  \- The removed item does not exist in the order.  \- The added item does not exist in the catalog.                                                                                |
| Invalid quantity to remove from item {0}                                                                                | An item's quantity would be reduced to less than 0 after the modification.                                                                                |
| It's not allowed to make modifications in orders without a credit card payment, promissory card, cash, or credit control                              | All of these conditions are true:  \- An attempt to increase order price was made.  \- The payment method does not support value changes.  \- The payment method is not credit card payment, promissory card, cash, or credit control. Consult your payment gateway to see which methods allow for order value changes. |
| Modification cannot be done. Possible reason: settlement directly done by API                                                                         | All of these conditions are true:  \- An attempt to reduce order price.  \- The payment method does not support value modifications. Consult your payment gateway to see which methods allow for order value modifications.                                                                                |
| The value of the modification exceeds the order's price                                                                                | discountValue is greater than the amount allowed for the order transaction.                                                                                |
| 500 Internal Server Error                                                                                | There is an issue with the payment gateway.                                                                                |

### Errors in Change v2

See below which API errors can be returned when attempting to [modify an order via Change v2 API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23post-/api/oms/pvt/orders/-orderId-/changes) and how to avoid or work around them.

#### Errors with exception codes

| Error code          | Error message                                                                                | Description                                                                                |
| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| CHK0022             | Invalid id for item.                                                                                | The item id is not valid or does not exist.                                                                                |
| CHK0023             | Invalid quantity for item.                                                                                | The item quantity is not allowed (e.g., less than 1).                                                                                |
| CHK0034             | The value of the change exceed the order's price.                                                                                | The modification value is greater than the total order price.                                                                                |
| CHK0095             | Changes in chain orders are not allowed.                                                                                | Chain orders do not support modifications.                                                                                |
| CHK0096             | Change cannot be done. Possible reason: settlement directly done by API.                                                                                | The change operation is not allowed, possibly due to a direct settlement.                                                                                |
| CHK0098             | The change value needs to be greater or equal than zero.                                                                                | The value for the change operation must not be negative.                                                                                |
| CHK0124             | Invalid change for order.                                                                                | The requested modification is not valid for the current order state or data. **Allowed order states for order modification:** handling, waiting-for-fulfillment, and ready-for-invoicing.                                                                                |
| CHK0196             | Cannot cancel order {0} - Payment not found.                                                                                | The order cannot be canceled because no payment was found.                                                                                |
| CHK0199             | OrderGroup {0} not found.                                                                                | The order group does not exist.                                                                                |
| CHK0201             | Order {0} not found.                                                                                | The order does not exist. Please verify the order ID in your operation.                                                                                |
| CHK0229             | Workflow not found for order {0}.                                                                                | No workflow was found for the order.                                                                                |
| CHK0289             | Change order request {0} not found.                                                                                | The modification order request does not exist.                                                                                |
| CHK00342            | Change order cannot increase the value for this payment method.                                                                                | Increasing the order value is not allowed for the selected payment method.                                                                                |
| SalesOrderSystem008 | Cannot Change Cancelled Order.                                                                                | Changes cannot be made to orders that have already been canceled.                                                                                |
| SalesOrderSystem010 | It's not possible to remove the item of ID {0} from the original order. Validate your {1} operation items IDs.                                                           | The specified item id cannot be removed from the original order. Please verify the item id in your operation.                                                                                |
| SalesOrderSystem011 | It's not possible to remove more than {0} quantities of the item of ID {1} from the original order. Validate your items quantities at Remove or Replace From operations. | The quantity being removed exceeds the quantity available in the order. Please verify the item quantity in your operation.                                                                                |
| SalesOrderSystem012 | The logistics information couldn't be determined for the item due to the presence of multiple options.                                                                   | The order contains multiple logistics options, so the system cannot infer which one to use. Please verify the logisticsInfo field in your operation.                                                                                |
| SalesOrderSystem013 | The logistics information provided was not found on the order.                                                                                | The logistics details given do not match any information in the order. Please verify the logisticsInfo field in your operation.                                                                                |
| SalesOrderSystem014 | Change In Progress.                                                                                | A change operation is currently in progress for this order. You can try making a new operation once the change in progress is finalized.                                                                                |
| SalesOrderSystem015 | A Change V1 has already been applied to this order. Orders can only contain one Change Order version at a time.                                                          | Only one type of order change (v1 or v2) can be applied. A v1 change already exists.                                                                                |
| SalesOrderSystem016 | Cannot Retry Change.                                                                                | The change operation cannot be retried since the workflow status is done or canceled.                                                                                |
| SalesOrderSystem017 | Change process was automatically canceled after failed retries.                                                                                | The modification was canceled by the system after several failed retry attempts. You should use the [Create order modifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23patch-/api/order-system/orders/-changeOrderId-/changes?endpoint=patch-/api/order-system/orders/-changeOrderId-/changes) endpoint. |
| SalesOrderSystem018 | Unable to communicate with Participants Client.                                                                                | The system could not reach the Participants Client service.                                                                                |
| SalesOrderSystem019 | Cannot Update Change Order Settings.                                                                                | Settings are being updated by another request. You can try again later.                                                                                |
| SalesOrderSystem026 | Unable to match an item to the information provided. Try providing the item's uniqueId for identification.                                                               | The item could not be identified with the given data. Try using the item's uniqueId.                                                                                |
| SalesOrderSystem027 | Change Settings Not Found.                                                                                | Change order settings could not be found for this configuration.                                                                                |
| SalesOrderSystem029 | Cannot Add New Products At Change Order When Order Has Multiple Address.                                                                                | When the order has multiple delivery addresses, you can only modify the existing items, not add new ones.                                                                                |
| SalesOrderSystem035 | The {0} is not a valid Agreement Type.                                                                                | The agreement type is not recognized or supported. **Allowed:** Acknowledgment or Confirmation.                                                                                |
| SalesOrderSystem045 | Invalid address.                                                                                | The address is invalid. Please verify the addressId field in your operation.                                                                                |
| SalesOrderSystem046 | The order change is not allowed after the item invoice has been issued.                                                                                | Order modification is not allowed after the invoice has been issued.                                                                                |
| SalesOrderSystem047 | The address change is not allowed.                                                                                | The address modification is not allowed.                                                                                |
| SalesOrderSystem048 | The address change is not allowed when there are packages associated.                                                                                | The address modification is not allowed when there are packages associated.                                                                                |
| SalesOrderSystem051 | Change order not allowed with tax hub and multiple delivery docks.                                                                                | Order modification is not allowed with tax hub and multiple delivery docks.                                                                                |
| SalesOrderSystem055 | Item modification is not allowed when the measurement unit differs from the original.                                                                                | Item modification is not allowed when the measurement unit differs from the original. To change the measurement unit, try using the replace array and modifying its to and from objects.                                                                                |

Contributors

2

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F170467615%3Fv%3D4%26w=64%26q=75)](https://github.com/mariananantua)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F77292838%3Fv%3D4%26w=64%26q=75)](https://github.com/julia-rabello)

Was this helpful?

Yes

No

[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/erp-integration-guide/order-modifications.md)

[Feed v3« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order//docs/guides/orders-feed)[Change sellerNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order//docs/guides/change-seller)

Contributors

2

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F170467615%3Fv%3D4%26w=64%26q=75)](https://github.com/mariananantua)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F77292838%3Fv%3D4%26w=64%26q=75)](https://github.com/julia-rabello)

ON THIS PAGE

[Implementation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/order-modifications%23implementation)

[Errors in Change v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/order-modifications%23errors-in-change-v1)[Errors in Change v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/order-modifications%23errors-in-change-v2)

Was this helpful?

 Send feedback

[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/erp-integration-guide/order-modifications.md)

Copy page

On this page

ON THIS PAGE

[Implementation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/order-modifications%23implementation)

[Errors in Change v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/order-modifications%23errors-in-change-v1)[Errors in Change v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order/docs/guides/order-modifications%23errors-in-change-v2)

On this page

[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)


[System] You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development.

[User] Provide a guide on guides faststore feature search in VTEX.

[Assistant]
Documentation

[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)

[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/api-reference)

[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/storefront-development)

[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/troubleshooting)

[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/updates/release-notes)

Storefront Development

[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/getting-started-with-storefront-solutions)

---

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore)

[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)

[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/getting-started-overview)

[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/webops-dashboard)

[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/headless-cms-overview)

[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/developer-tools-overview)

[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/styling-overview)

[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/components-index)

[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/storefront-features-overview)

[Adding third-party scripts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/storefront-features-handling-third-party-scripts)

[Building navigation menus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/storefront-features-building-navigation-menus)

[Displaying content for authenticated users](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users)

[Implementing regionalization features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/storefront-features-implementing-regionalization-features)

[Implementing search features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/storefront-features-implementing-search-features)

[Managing product images in specific contexts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/storefront-features-managing-product-images-in-specific-contexts)

[Implementing Delivery Promise](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/delivery-promise-implementation)

[Implementing Live Shopping for FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore)

[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/faststore-api-overview)

[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/sdk-overview)

[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/developing-and-overriding-components-overview)

[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/api-extensions-overview)

[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)

[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/managing-performance-overview)

[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/seo-overview)

[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/go-live-overview)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/troubleshooting-overview)

---

[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/store-framework)

---

(Legacy) CMS Portal

---

[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/storefront-best-practices)

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/updates/release-notes)

Storefront Development

[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/getting-started-with-storefront-solutions)

---

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore)

[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)

[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/getting-started-overview)

[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/webops-dashboard)

[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/headless-cms-overview)

[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/developer-tools-overview)

[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/styling-overview)

[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/components-index)

[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/storefront-features-overview)

[Adding third-party scripts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/storefront-features-handling-third-party-scripts)

[Building navigation menus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/storefront-features-building-navigation-menus)

[Displaying content for authenticated users](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users)

[Implementing regionalization features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/storefront-features-implementing-regionalization-features)

[Implementing search features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/storefront-features-implementing-search-features)

[Managing product images in specific contexts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/storefront-features-managing-product-images-in-specific-contexts)

[Implementing Delivery Promise](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/delivery-promise-implementation)

[Implementing Live Shopping for FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore)

[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/faststore-api-overview)

[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/sdk-overview)

[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/developing-and-overriding-components-overview)

[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/api-extensions-overview)

[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)

[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/managing-performance-overview)

[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/seo-overview)

[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/go-live-overview)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/troubleshooting-overview)

---

[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/store-framework)

---

(Legacy) CMS Portal

---

[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/storefront-best-practices)

---

[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/storefront-development)

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore)

[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/storefront-features-overview)

Implementing search features

This feature enables customers to find their search easier.

The Search feature is based on the Autocomplete functionality to enhance user search experiences. Autocomplete dynamically displays relevant search suggestions based on current and past search queries. The feature includes four different lists, which can be presented collectively or individually based on user interaction preferences. The existing sections within Autocomplete are as follows:

* **Last Searches:** Displays a list of the user's most recent search queries.
* __Search Suggestions: Offers real-time suggestions based on the user's current input._
* **Product suggestion:** Provides relevant product recommendations based on the search query.
* **Most searched terms:** Highlights popular and frequently searched terms.

Refer to the [Autocomplete in VTEX Intelligent Search](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/vtex-intelligent-search--19wrbB7nEQcmwzDPl1l4Cb/4gXFsEWjF7QF7UtI2GAvhL) for more information.

---

## Usage

To integrate the `<SearchInput />` component, refer to the provided example in the [FastStore Core](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/tree/main/packages/core/src/components/search/SearchInput).

> You can add this component to your store where you need it, with the Navbar being a recommended location.

---

## Components

* History
Clear History
   1. [Headphone](#)
   2. [Audio & Video](#)
   3. [mh-7000](#)
Search History
Responsible for showing the latest terms searched by a user.
[See more ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/molecules-search-history)
* Top Search
   1. [1Notebooks](#)
   2. [2Laser Printer](#)
   3. [3Bluetooth Keyboard](#)
Search Top
Displays the most searched terms by customers.
[See more ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/molecules-search-top)
* 1. [appl**e airpods**](#)
   2. [appl**e tv**](#)
Search Auto Complete
List of auto completing suggestions based on the searched term.
[See more ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/molecules-search-auto-complete)
* Suggested Products
   1. [![combo](https://read.calvincode.net/reader?url=https://storeframework.vtexassets.com/arquivos/ids/190924/anthony-choren-e7dG26YCrZU-unsplash.jpg?v=637867501835430000)Apple Magic MouseOriginal price:$999Price:$950.04](#)
   2. [![combo](https://read.calvincode.net/reader?url=https://storeframework.vtexassets.com/arquivos/ids/190924/anthony-choren-e7dG26YCrZU-unsplash.jpg?v=637867501835430000)Apple Magic MouseOriginal price:$999Price:$950.04](#)
Search Products
List of `SearchProductItem` to show details of the suggested products.
[See more ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/molecules-search-products)
* History
Clear History
   1. [Headphone](#)
   2. [Audio & Video](#)
   3. [mh-7000](#)
Top Search
   1. [1Notebooks](#)
   2. [2Laser Printer](#)
   3. [3Bluetooth Keyboard](#)
Search Dropdown
Combine `SearchHistory`, `SearchTop` `SearchAutoComplete` and `SearchProducts` to show all options in `SearchInput`.
[See more ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/molecules-search-dropdown)
* Search Input Field
An `InputField` with a search button.
[See more ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/molecules-search-input-field)
* Search Input
The `SearchInput` is responsible for receiving, searching and displaying suggestions.
[See more ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/organisms-search-input)

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F67270558%3Fv%3D4%26w=64%26q=75)](https://github.com/mariana-caetano)

Was this helpful?

Yes

No

[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/storefront-features/implementing-search-features.mdx)

[Implementing regionalization features« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/storefront-features-implementing-regionalization-features)[Managing product images in specific contextsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/storefront-features-managing-product-images-in-specific-contexts)

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F67270558%3Fv%3D4%26w=64%26q=75)](https://github.com/mariana-caetano)

ON THIS PAGE

[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/storefront-features-implementing-search-features%23usage)

[Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/storefront-features-implementing-search-features%23components)

Was this helpful?

 Send feedback

[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/storefront-features/implementing-search-features.mdx)

Copy page

On this page

ON THIS PAGE

[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/storefront-features-implementing-search-features%23usage)

[Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-search/docs/guides/faststore/storefront-features-implementing-search-features%23components)

On this page

[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)


[System] You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development.

[User] Provide a guide on guides services 3 using the analytics client in VTEX.

[Assistant]
Documentation

[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)

[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/api-reference)

[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/storefront-development)

[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/troubleshooting)

[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/updates/release-notes)

App Development

[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/vtex-io-documentation-what-is-vtex-io)

---

[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/vtex-io-documentation-what-is-a-vtex-app)

---

[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/governance-and-shared-security-in-vtex-io-apps)

---

[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/code-samples)

---

[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/vtex-io-getting-started)

---

Project structure

---

[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)

---

[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/vtex-io-documentation-workspace)

---

Managing apps

---

Development guides

---

[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/app-development-guides)

[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/vtex-io-documentation-service)

[Developing services on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/developing-services-on-vtex-io)

[1\. Getting started with the boilerplate](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-1-getting-started-with-the-boilerplate)

[2\. Handling and receiving events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-2-handling-and-receiving-events)

[3\. Using the Analytics client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-3-using-the-analytics-client)

[4\. Using events as triggers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-4-using-events-as-triggers)

[5\. Using the Master Data client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-5-using-the-master-data-client)

[6\. Using GraphQL to retrieve data from Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-6-graphql-retrieving-data-from-master-data)

[7\. Using GraphiQL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-7-using-graphiql)

[Services - Conclusion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-conclusion)

[Calling commerce APIs on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/calling-commerce-apis-on-vtex-io)

[Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/vtex-io-documentation-clients)

Handling events

[Path patterns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/service-path-patterns)

[Configuring dynamic routes in VTEX IO services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/configuring-dynamic-routes-in-vtex-io-services)

[Developing service configuration apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/vtex-io-documentation-developing-service-configuration-apps)

[Node builder 7.x migration guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/node-builder-7x-migration-guide)

---

[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/graphql-in-vtex-io)

---

[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/vtex-io-documentation-policies)

---

[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/ab-tests)

---

[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)

---

[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/vtex-app-store)

---

[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/managing-edition-apps)

---

[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/vtex-io-documentation-frequently-asked-questions)

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/updates/release-notes)

App Development

[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/vtex-io-documentation-what-is-vtex-io)

---

[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/vtex-io-documentation-what-is-a-vtex-app)

---

[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/governance-and-shared-security-in-vtex-io-apps)

---

[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/code-samples)

---

[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/vtex-io-getting-started)

---

Project structure

---

[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)

---

[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/vtex-io-documentation-workspace)

---

Managing apps

---

Development guides

---

[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/app-development-guides)

[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/vtex-io-documentation-service)

[Developing services on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/developing-services-on-vtex-io)

[1\. Getting started with the boilerplate](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-1-getting-started-with-the-boilerplate)

[2\. Handling and receiving events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-2-handling-and-receiving-events)

[3\. Using the Analytics client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-3-using-the-analytics-client)

[4\. Using events as triggers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-4-using-events-as-triggers)

[5\. Using the Master Data client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-5-using-the-master-data-client)

[6\. Using GraphQL to retrieve data from Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-6-graphql-retrieving-data-from-master-data)

[7\. Using GraphiQL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-7-using-graphiql)

[Services - Conclusion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-conclusion)

[Calling commerce APIs on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/calling-commerce-apis-on-vtex-io)

[Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/vtex-io-documentation-clients)

Handling events

[Path patterns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/service-path-patterns)

[Configuring dynamic routes in VTEX IO services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/configuring-dynamic-routes-in-vtex-io-services)

[Developing service configuration apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/vtex-io-documentation-developing-service-configuration-apps)

[Node builder 7.x migration guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/node-builder-7x-migration-guide)

---

[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/graphql-in-vtex-io)

---

[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/vtex-io-documentation-policies)

---

[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/ab-tests)

---

[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)

---

[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/vtex-app-store)

---

[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/managing-edition-apps)

---

[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/vtex-io-documentation-frequently-asked-questions)

---

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/app-development)

[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/app-development-guides)

[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/vtex-io-documentation-service)

[Developing services on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/developing-services-on-vtex-io)

[3\. Using the Analytics client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-3-using-the-analytics-client)

3\. Using the Analytics client

Now that we have successfully set up event listening, our next objective is to gain insights into the live number of views for each product page in our store whenever an event is triggered.

To achieve this, we will implement a [custom client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-how-to-create-and-use-clients) with analytics capabilities. This client will be responsible for retrieving information about a product's number of views from mocked data.

In VTEX IO, a [client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients) is responsible for establishing connections with external APIs and other VTEX services. The Analytics client, which will be developed in this step, will execute a REST request, fetching valuable information about product views.

## Developing a custom client

Navigate to the `service-course-template/node/clients/analytics.ts` file. This is where the Analytics client will be implemented. Observe that the `Analytics` client extends the `AppClient` class from the `@vtex/api` package, ensuring secure communication configurations within your app.

### Defining a constructor

The client includes a constructor, a special method invoked when an object is instantiated from a class. Its primary purpose is to initialize the object's properties and perform any necessary setup, ensuring that the Analytics client can interact effectively with other parts of the app and the `vtex.mocked-analytics` app.

> The [vtex.mocked-analytics](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/mocked-analytics) app provides mocked live products data via the `/_v/live-products` endpoint.

### Implementing the client's method

Proceed to implement the `getLiveUsers` method, responsible for making an HTTP GET request to the `_v/live-products` endpoint. This method returns a promise for fetching an array, with each element of type `LiveUsersProduct` \- an object containing `slug` (product ID) and `liveUsers` (quantity of users viewing the product).

### Exporting the custom client

Expose the custom client by extending the default `Clients` implementation. Open the `node/clients/index.ts` file, import the analytics client, and update the `Clients` class as highlighted.

## Using the custom client

### Defining the handler function

With our new analytics client, let's update its handler function to display the output of the analytics client's `getLiveUsers` method. Go to the `node/handlers/analytics.ts` file and replace the content of `ctx.body` with the method developed in the previous steps (`ctx.analytics.getLiveUsers()`).

### Defining the service route

Go to the `node/service.json` file, and define a public route named `analytics` with the path `/_v/app/analytics/realTime`.

### Relating a route to a handler

Update the `node/index.ts` file to relate a route to a handler. Note that the `routes` section associates the `analytics` route with the `analytics` handler function. The `GET` method is associated with the `analytics` handler.

Therefore, when a GET request is made to the `analytics` route previously defined, it triggers the `analytics` handler function, which, in turn, executes the `getLiveUsers()` method of the Analytics client, providing real-time insights into product views.

## Linking the app

To test the Analytics client, link your app using `vtex link`. Then, use [Postman](https://read.calvincode.net/reader?url=https://www.postman.com/) or `curl` to send a `GET` request to the designated route, replacing `{workspace}` with your workspace name and `{accountName}` with your VTEX account name.

The request should return status `200 OK` and data in the same format as the example in the right.

service-course-template/node/clients/analytics.ts

`1

import { AppClient, InstanceOptions, IOContext } from '@vtex/api'

2

3

export default class Analytics extends AppClient {

4

 constructor(context: IOContext, options?: InstanceOptions) {

5

 super('vtex.mocked-analytics@0.x', context, options)

6

 }

7

8

 public getLiveUsers(): Promise<LiveUsersProduct[]> {

9

 return this.http.get('_v/live-products')

10

 }

11

}

12

13

interface LiveUsersProduct {

14

 slug: string

15

 liveUsers: number

16

}

`

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F60782333%3Fv%3D4%26w=64%26q=75)](https://github.com/carolinamenezes)

Was this helpful?

Yes

No

[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/services/services-3-using-the-analytics-client.mdx)

[2\. Handling and receiving events« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client//docs/guides/services-2-handling-and-receiving-events)[4\. Using events as triggersNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client//docs/guides/services-4-using-events-as-triggers)

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F60782333%3Fv%3D4%26w=64%26q=75)](https://github.com/carolinamenezes)

ON THIS PAGE

[Developing a custom client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-3-using-the-analytics-client%23developing-a-custom-client)

[Defining a constructor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-3-using-the-analytics-client%23defining-a-constructor)[Implementing the client's method](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-3-using-the-analytics-client%23implementing-the-clients-method)[Exporting the custom client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-3-using-the-analytics-client%23exporting-the-custom-client)

[Using the custom client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-3-using-the-analytics-client%23using-the-custom-client)

[Defining the handler function](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-3-using-the-analytics-client%23defining-the-handler-function)[Defining the service route](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-3-using-the-analytics-client%23defining-the-service-route)[Relating a route to a handler](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-3-using-the-analytics-client%23relating-a-route-to-a-handler)

[Linking the app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-3-using-the-analytics-client%23linking-the-app)

Was this helpful?

 Send feedback

[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/services/services-3-using-the-analytics-client.mdx)

Copy page

On this page

ON THIS PAGE

[Developing a custom client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-3-using-the-analytics-client%23developing-a-custom-client)

[Defining a constructor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-3-using-the-analytics-client%23defining-a-constructor)[Implementing the client's method](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-3-using-the-analytics-client%23implementing-the-clients-method)[Exporting the custom client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-3-using-the-analytics-client%23exporting-the-custom-client)

[Using the custom client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-3-using-the-analytics-client%23using-the-custom-client)

[Defining the handler function](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-3-using-the-analytics-client%23defining-the-handler-function)[Defining the service route](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-3-using-the-analytics-client%23defining-the-service-route)[Relating a route to a handler](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-3-using-the-analytics-client%23relating-a-route-to-a-handler)

[Linking the app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/services-3-using-the-analytics-client/docs/guides/services-3-using-the-analytics-client%23linking-the-app)

On this page

[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)


[System] You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development.

[User] How do I use the VTEX store components autocompleteresults app? Provide documentation and configuration details.

[Assistant]
Documentation

[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)

[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/api-reference)

[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/storefront-development)

[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/troubleshooting)

[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/updates/release-notes)

VTEX IO Apps

[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/guides/basic-components)

---

[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/guides/store-components)

[Autocomplete Result List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/autocompleteresults)

[Availability Subscriber](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/availabilitysubscriber)

[Back To Top Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/backtotopbutton)

[Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/image)

[Info Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/infocard)

[Logo](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/logo)

[Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/notification)

[Product Brand](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/productbrand)

[Product Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/productdescription)

[Product Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/productimages)

[Product Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/productname)

[Product SKU Attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/productskuattributes)

[Search Bar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/searchbar)

[Share](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/share)

[Shipping Simulator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/shippingsimulator)

[SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/skuselector)

---

[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/guides/advanced-components)

---

[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/guides/b2b-components)

---

[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.b2b-suite)

---

[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/guides/functional-apps)

---

[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/guides/layout-apps)

---

[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/guides/pixel-apps)

---

[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.my-account)

---

[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/guides/vtex-io-deprecated-apps)

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/updates/release-notes)

VTEX IO Apps

[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/guides/basic-components)

---

[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/guides/store-components)

[Autocomplete Result List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/autocompleteresults)

[Availability Subscriber](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/availabilitysubscriber)

[Back To Top Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/backtotopbutton)

[Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/image)

[Info Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/infocard)

[Logo](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/logo)

[Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/notification)

[Product Brand](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/productbrand)

[Product Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/productdescription)

[Product Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/productimages)

[Product Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/productname)

[Product SKU Attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/productskuattributes)

[Search Bar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/searchbar)

[Share](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/share)

[Shipping Simulator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/shippingsimulator)

[SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/skuselector)

---

[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/guides/advanced-components)

---

[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/guides/b2b-components)

---

[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.b2b-suite)

---

[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/guides/functional-apps)

---

[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/guides/layout-apps)

---

[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/guides/pixel-apps)

---

[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.my-account)

---

[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/guides/vtex-io-deprecated-apps)

---

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/vtex-io-apps)

[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/guides/store-components)

Autocomplete Result List

[vtex.store-components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components)

Version: 3.178.5

Latest version: 3.178.5

The `autocomplete-result-list` component displays the autocomplete functionality in the search bar. This component serves mainly to ease the creation of custom autocomplete components for search engines.

![{"base64":"  ","img":{"width":1870,"height":767,"type":"gif","mime":"image/gif","wUnits":"px","hUnits":"px","length":2137387,"url":"https://user-images.githubusercontent.com/67270558/147763822-a47487e7-35d1-4d42-a30e-2b505209b5f2.gif"}}](https://read.calvincode.net/reader?url=https://user-images.githubusercontent.com/67270558/147763822-a47487e7-35d1-4d42-a30e-2b505209b5f2.gif)

## Configuration

1. Import the `vtex.store-components` app to your theme's dependencies in the `manifest.json` file as in the following example:

`1

 "dependencies": {

2

 "vtex.store-components": "3.x"

3

 }

`

1. Add the `autocomplete-result-list` block into the `search-bar` component. For example:

`1

 "search-bar": {

2

 "blocks": [

3

+ "autocomplete-result-list"

4

 ]

5

 }

`

1. Then, declare the `autocomplete-result-list` block using the props stated in the [Props](#props) table.

### Props

> Info
>
> The `autocomplete-result-list` block is commonly used with [Downshift](https://read.calvincode.net/reader?url=https://github.com/downshift-js/downshift). Hence, some of its props are directly related to it.

| Prop name                    | Type             | Description                                                                                | Default value |
| ---------------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------- |
| attemptPageTypeSearch        | Boolean          | Uses the input term to try to navigate to the proper page type (e.g. a department, a brand, a category) if true.                                                                                | \-            |
| classes                      | CustomCSSClasses | Overrides default CSS handles. To better understand how this prop works, check [this document](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/css-handles%23usecustomclasses). Note that this is only helpful if you're using this block as a React component. | undefined     |
| closeMenu (Downshift)        | Function         | Closes the menu.                                                                                | \-            |
| customSearchPageUrl          | String           | Template for a custom URL. It accepts a substring ${term} as placeholder to interpolate the searched term (e.g., /search?query=${term}).                                                                                | \-            |
| data                         | Object           | Graphql data response.                                                                                | {}            |
| highlightedIndex (Downshift) | Number           | The index that should be highlighted.                                                                                | \-            |
| getItemProps (Downshift)     | Function         | Returns the props for every menu item element being rendered.                                                                                | \-            |
| getMenuProps (Downshift)     | Function         | Returns the props for the ul or root element of your menu.                                                                                | \-            |
| inputValue                   | String           | Search query.                                                                                | \-            |
| onClearInput                 | Function         | Clears the input.                                                                                | \-            |
| isOpen                       | Boolean          | Identifies if the autocomplete should be opened.                                                                                | \-            |

## Customization

To apply CSS customizations in this and other blocks, follow the [Using CSS handles for store customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-using-css-handles-for-store-customization) guide.

| CSS Handles           |
| --------------------- |
| resultsItem           |
| resultsItemImage      |
| resultsItemName       |
| resultsList           |
| searchTerm            |
| spinnerContainer      |
| spinnerInnerContainer |

[Store Components« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/guides/store-components)[Availability SubscriberNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/availabilitysubscriber)

See also

[Vtex.store ComponentsVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components)[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)

ON THIS PAGE

[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/autocompleteresults%23configuration)

[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/autocompleteresults%23props)

[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/autocompleteresults/docs/apps/vtex.store-components/autocompleteresults%23customization)

Was this helpful?

[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)