[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 fulfillment 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/fulfillment/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/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/fulfillment/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/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/fulfillment/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/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/fulfillment/updates/release-notes)

Guides

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

---

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

---

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

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

[Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/docs/guides/marketplace-overview)

[Orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/docs/guides/orders-overview)

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

[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/docs/guides/payments-overview)

[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/docs/guides/fulfillment)

[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/docs/guides/search-overview)

[Pricing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/docs/guides/pricing-overview)

[Promotions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/docs/guides/promotions-overview)

[Subscriptions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/docs/guides/subscriptions)

---

Integration Guides

---

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

---

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

---

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

---

Payments

---

Orders

---

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/fulfillment/docs/guides/activity-flow)

---

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

---

VTEX Session

---

VTEX Shield

---

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

---

Weni by VTEX

---

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

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

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

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

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

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

---

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

Guides

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

---

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

---

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

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

[Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/docs/guides/marketplace-overview)

[Orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/docs/guides/orders-overview)

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

[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/docs/guides/payments-overview)

[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/docs/guides/fulfillment)

[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/docs/guides/search-overview)

[Pricing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/docs/guides/pricing-overview)

[Promotions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/docs/guides/promotions-overview)

[Subscriptions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/docs/guides/subscriptions)

---

Integration Guides

---

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

---

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

---

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

---

Payments

---

Orders

---

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/fulfillment/docs/guides/activity-flow)

---

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

---

VTEX Session

---

VTEX Shield

---

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

---

Weni by VTEX

---

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

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

[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/docs/guides/fulfillment)

Fulfillment and Logistics

> Help us improve our documentation! Tell us about your experience with this article by filling out [this form](https://read.calvincode.net/reader?url=https://forms.gle/fQoELRA1yfKDqmAb8)!

[Fulfillment](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/fulfillment-logistics-vtex--53udnvI5eBy8DKo8FOjMoP) is the logistic process of storing merchandise and receiving, managing, packing and shipping orders. It starts when a shopper buys a product and ends when the life cycle of the order is complete with the shopper receiving the purchase.

This overview article goes over what you can accomplish with VTEX logistics’ capabilities, like the registration and control of your inventory, shipping rates management, items availability control, tracking deliveries, and more.

## Importing inventory from an ERP or Back office

If your store has an ERP integration or another integration for inventory management and shipping, it will be necessary to integrate with VTEX platform. The links below provide a general view of the integration flow between a back office system and a VTEX store regarding inventory:

* [Back office (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide)
* [Import inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-inventory)

> If you wish to customize the fulfillment capabilities in the storefront, see the [Checkout guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview) overview.

## Understanding fulfillment process

When a shopper selects an item and proceeds to checkout, after entering their location, the VTEX platform:

1. Checks the availability of the item and where it will be picked up from.
2. Selects the place and the time when the [carrier](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/carries-on-vtex--7u9duMD5UQa2QQwukAWMcE) must collect the item.
3. Calculates the shipping conditions, or Service Level Agreement (SLA), that will be offered to the shopper.

The shopper chooses one option from the shipping conditions displayed and completes the order’s payment. That is when the logistic part of packing and shipping takes place.

The following image summarizes the fulfillment process:

![{"base64":"  ","img":{"width":1115,"height":962,"type":"svg","mime":"image/svg+xml","wUnits":"px","hUnits":"px","length":159675,"url":"https://raw.githubusercontent.com/vtexdocs/dev-portal-content/main/images/fulfillment_image_1.svg"}}](https://read.calvincode.net/reader?url=https://raw.githubusercontent.com/vtexdocs/dev-portal-content/main/images/fulfillment_image_1.svg)

In VTEX, there are specific terms to identify the entities involved in order fulfillment, which can be checked in our [Logistics Glossary](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/logistics-glossary--16DSSiXn548rsidi0A8Hby). An important concept is [Shipping strategy](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/shipping-strategy--58vLBDbjYVQzJ6rRc5QNz3), defined as the relationship between the following entities:

* [Shipping policy](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/shipping-policy--tutorials%5F140): Set of rules that define the shipping conditions, including carrier’s working hours, delivery time frames, shipping rates, and more.
* [Loading dock](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/managing-loading-docks--7K3FultD8I2cuuA6iyGEiW): Entity that links your products to a shipping policy.
* [Warehouse](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb): Location where your products are stored.

The following image shows how these entities connect to each other:

![{"base64":"  ","img":{"width":910,"height":482,"type":"svg","mime":"image/svg+xml","wUnits":"px","hUnits":"px","length":192381,"url":"https://raw.githubusercontent.com/vtexdocs/dev-portal-content/main/images/fulfillment_image_2.svg"}}](https://read.calvincode.net/reader?url=https://raw.githubusercontent.com/vtexdocs/dev-portal-content/main/images/fulfillment_image_2.svg)

## Setting up shipping strategy (mandatory)

Configuring your shipping strategy means setting up a shipping policy, a loading dock, and a warehouse. For the system to perform as expected, we suggest you follow the order below:

1. [Shipping policy](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/shipping-policy--tutorials%5F140)
2. [Loading dock](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/managing-loading-docks--7K3FultD8I2cuuA6iyGEiW)
3. [Warehouse](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb)

**In VTEX Admin:** Shipping > Shipping Strategy > Shipping Policies/Loading Docks/Warehouses

### 1\. Shipping policy

A [Shipping policy](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/shipping-policy--tutorials%5F140) defines the shipping conditions offered to the shopper at checkout, including costs and deadlines. This set of rules includes carriers working hours, shipping capacity, and more.

* [POST - Create shipping policy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23post-/api/logistics/pvt/shipping-policies)

### 2\. Loading dock

[Loading docks](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/managing-loading-docks--7K3FultD8I2cuuA6iyGEiW) connect the warehouse to the shipping policy. The loading dock corresponds to a physical location from where products will be shipped. By default, when you create a new loading dock, it is generated as activated.

* [POST - Create/update dock](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23post-/api/logistics/pvt/configuration/docks)
* [POST - Activate dock](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23post-/api/logistics/pvt/configuration/docks/-dockId-/activation)

### 3\. Warehouse

A [Warehouse](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) is the physical location where you store your products. The items sold go from the warehouse to the loading dock for the carriers to deliver them. By default, when you create a new warehouse, it is generated as activated.

* [POST - Create/update warehouse](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23post-/api/logistics/pvt/configuration/warehouses)
* [POST - Activate warehouse](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23post-/api/logistics/pvt/configuration/warehouses/-warehouseId-/activation)

## Managing shipping strategy

Manage your [Shipping strategy](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/shipping-strategy--58vLBDbjYVQzJ6rRc5QNz3) by editing your shipping policies, loading docks, and warehouses.

> **In VTEX Admin:** Shipping > Shipping Strategy > Shipping Policies/Loading Docks/Warehouses

### Shipping policy

You can list shipping policies, deactivate, reactivate, update or delete them.

* [GET - List shipping policies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23get-/api/logistics/pvt/shipping-policies)
* [GET - Retrieve shipping policy by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23get-/api/logistics/pvt/shipping-policies/-id-)
* [PUT - Update shipping policy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23put-/api/logistics/pvt/shipping-policies/-id-)
* [DELETE - Delete shipping policies by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23delete-/api/logistics/pvt/shipping-policies/-id-)

### Loading dock

You can list loading docks, deactivate, reactivate, update or delete them.

* [GET - List all docks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23get-/api/logistics/pvt/configuration/docks)
* [GET - List dock by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23get-/api/logistics/pvt/configuration/docks/-dockId-)
* [POST - Deactivate dock](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23post-/api/logistics/pvt/configuration/docks/-dockId-/deactivation)
* [DELETE - Delete dock](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23delete-/api/logistics/pvt/configuration/docks/-dockId-)
* [POST - Create/update dock](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23post-/api/logistics/pvt/configuration/docks)
* [POST - Activate dock](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23post-/api/logistics/pvt/configuration/docks/-dockId-/activation)

### Warehouse

You can list warehouses, deactivate, reactivate, update or delete them.

* [GET - List all warehouses](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23get-/api/logistics/pvt/configuration/warehouses)
* [GET - List warehouse by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23get-/api/logistics/pvt/configuration/warehouses/-warehouseId-)
* [POST - Deactivate warehouse](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23post-/api/logistics/pvt/configuration/warehouses/-warehouseId-/deactivation)
* [POST - Activate warehouse](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23post-/api/logistics/pvt/configuration/warehouses/-warehouseId-/activation)
* [DELETE - Remove warehouse](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23delete-/api/logistics/pvt/configuration/warehouses/-warehouseId-)
* [POST - Create/update warehouse](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23post-/api/logistics/pvt/configuration/warehouses)

## Managing inventory

Once you have your Shipping strategy set up, you will need to manage the items available for sales, which compose your [inventory](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/inventory-management--tutorials%5F139). In VTEX, inventory is the relationship between your stored products and their availability for sales.

### Inventory

You can update your inventory or retrieve information about it.

* [PUT - Update inventory by SKU and warehouse](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23put-/api/logistics/pvt/inventory/skus/-skuId-/warehouses/-warehouseId-)
* [GET - List inventory by SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23get-/api/logistics/pvt/inventory/skus/-skuId-)
* [GET - List inventory per warehouse](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23get-/api/logistics/pvt/inventory/items/-skuId-/warehouses/-warehouseId-)
* [GET - List inventory per dock](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23get-/api/logistics/pvt/inventory/items/-skuId-/docks/-dockId-)
* [GET - List inventory per dock and warehouse](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23get-/api/logistics/pvt/inventory/items/-skuId-/docks/-dockId-/warehouses/-warehouseId-)
* [GET - List inventory with dispatched reservations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23get-/api/logistics/pvt/inventory/items/-itemId-/warehouses/-warehouseId-/dispatched)

> **In VTEX Admin:** Catalog > Inventory > Inventory Management

## Setting up shipping configurations (Optional)

VTEX offers different solutions for your logistic process according to your business needs. You can configure shipping geolocations, work with the reservation, create scheduled delivery windows, define holidays, register pickup points, and more.

> **In VTEX Admin:** Store Settings > Shipping > Settings/Geolocation Shipping/Holidays

### Geolocation shipping (polygons)

[Geolocation shipping](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/gerenciar-geolocalizacao--tutorials%5F138) is the registration of shipping locations using polygons to delimitate areas, usually for delivering in rural and industrial areas.

* [PUT - Create/update polygon](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23put-/api/logistics/pvt/configuration/geoshape)
* [GET - List paged polygons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23get-/api/logistics/pvt/configuration/geoshape)
* [GET - List polygon by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23get-/api/logistics/pvt/configuration/geoshape/-polygonName-)
* [DELETE - Delete polygon](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23delete-/api/logistics/pvt/configuration/geoshape/-polygonName-)

### Reservations

[Reservation](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials%5F92) is the solution that prevents the same item from being sold more than once. After the shopper completes the purchase, the status of the purchased item changes from `Available` to `Reserved` in the [inventory management](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/inventory-management--tutorials%5F139).

* [POST - Create reservation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23post-/api/logistics/pvt/inventory/reservations)
* [GET - List reservation by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23get-/api/logistics/pvt/inventory/reservations/-reservationId-)
* [GET - List reservation by warehouse and SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23get-/api/logistics/pvt/inventory/reservations/-warehouseId-/-skuId-)
* [POST - Confirm reservation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23post-/api/logistics/pvt/inventory/reservations/-reservationId-/confirm)
* [POST - Acknowledgment reservation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23post-/api/logistics/pvt/inventory/reservations/-reservationId-/acknowledge)
* [POST - Cancel reservation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23post-/api/logistics/pvt/inventory/reservations/-reservationId-/cancel)

### Scheduled delivery

[Scheduled delivery](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) allows you to set delivery time frames for shoppers to choose the day and time to receive the order.

* [POST - Add blocked delivery windows](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23post-/api/logistics/pvt/configuration/carriers/-carrierId-/adddayofweekblocked)
* [GET - Retrieve blocked delivery windows](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23get-/api/logistics/pvt/configuration/carriers/-carrierId-/getdayofweekblocked)
* [POST - Remove blocked delivery windows](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23post-/api/logistics/pvt/configuration/carriers/-carrierId-/removedayofweekblocked)
* [GET - Search capacity reservations in time range](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23get-/api/logistics-capacity/resources/carrier@-capacityType-@-shippingPolicyId-/time-frames)
* [GET - Get capacity reservation usage by window](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23get-/api/logistics-capacity/resources/carrier@-capacityType-@-shippingPolicyId-/time-frames/-windowDay-F-windowStartTime-T-windowEndTime-)

### Holidays

The [Holidays](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/registering-holidays--2ItOthSEAoyAmcwsuiO6Yk) feature allows you to configure days that should not be considered valid for delivery, so that the VTEX platform adds those days when calculating the shipping estimated time.

* [PUT - Create/update holiday](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23put-/api/logistics/pvt/configuration/holidays/-holidayId-)
* [GET - List holiday by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23get-/api/logistics/pvt/configuration/holidays/-holidayId-)
* [GET - List all holidays](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23get-/api/logistics/pvt/configuration/holidays)
* [DELETE - Delete holiday](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23delete-/api/logistics/pvt/configuration/holidays/-holidayId-)

### Pickup points

[Pickup points](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) are physical locations from where shoppers can pick up their orders.

* [PUT - Create/Update Pickup Point](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23put-/api/logistics/pvt/configuration/pickuppoints/-pickupPointId-)
* [GET - List all pickup points](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23get-/api/logistics/pvt/configuration/pickuppoints)
* [GET - List Pickup Point By ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23get-/api/logistics/pvt/configuration/pickuppoints/-pickupPointId-)
* [GET - List paged Pickup Points](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23get-/api/logistics/pvt/configuration/pickuppoints/%5Fsearch)
* [DELETE - Delete Pickup Point](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23delete-/api/logistics/pvt/configuration/pickuppoints/-pickupPointId-)

> **In VTEX Admin:** Shipping > Pickup Points

## Calculating shipping estimate time

When the shopper enters their address at checkout, the VTEX platform analyzes the order fulfillment conditions and displays the available shipping options to the shopper.

### SLA

Service Level Agreement (SLA) refers to the order’s fulfillment conditions presented to the shopper, including shipping type - delivery or pick up -, costs and deadlines.

* POST - [Calculate SLA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23post-/api/logistics/pvt/shipping/calculate)

## Optimizing fulfillment process with carriers

[Carriers](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/carries-on-vtex--7u9duMD5UQa2QQwukAWMcE), or couriers, are the companies responsible for delivering orders, and their operating profiles are configured in your [shipping policies](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/shipping-policy--tutorials%5F140). The service contract details with carriers, like shipping ZIP code ranges and packages weight limits, are configured via [shipping rate template](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/shipping-rate-template--tutorials%5F127).

### Freight values

Create carriers’ freight values and retrieve information about them.

* [POST - Create/update freight values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23post-/api/logistics/pvt/configuration/freights/-carrierId-/values/update)
* [GET - List freight values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23get-/api/logistics/pvt/configuration/freights/-carrierId-/-cep-/values)

### VTEX Shipping Network (independent App)

[VTEX Shipping Network](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api) is an app that connects your store with carriers to deliver orders at better freight costs and with optimized logistic operation. Currently, the solution is available exclusively in Brazil.

With VTEX Shipping Network you coordinate the actions of:

1. Notifying carriers of new package deliveries.
2. Issuing shipping labels.
3. Tracking the shipping process steps until the order is fulfilled.

#### Notification

The endpoint below notifies the carrier of the dispatched package information, including fiscal information, and a contact email.

* [POST - Notify Carrier with App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api%23post-/-app%5Fname-/v-app%5Fversion-/-account-/-workspace-/notify)

#### Tracking

The endpoint below updates tracking events for pending deliveries using a list of tracking codes.

* [POST - Tracking Events with App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api%23post-/-app%5Fname-/v-app%5Fversion-/-account-/-workspace-/tracking)

### VTEX Tracking (independent App)

[VTEX Tracking](https://read.calvincode.net/reader?url=https://vtex.com/br-pt/vtex-tracking/) is an app that enables the merchant to control and manage deliveries in real-time, having visibility of indicators like the driver's location and order delivery status. Shoppers can also keep up with deliveries in real-time. Currently, the solution is available exclusively in Brazil.

> We strongly recommend that a call to a VTEX Tracking GET endpoint is made only once every 6 hours. Retrieving data from the same endpoint more than once during a 6-hour window represents a load to our API that will slow down the overall usage of systems.

* [POST - Asynchronous Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/tracking%23post-/auth)
* [PUT - Remove Packing List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/tracking%23put-/services)
* [POST - Post Delivery Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/tracking%23post-/services)
* [GET - Get Delivery Services List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/tracking%23get-/services)
* [GET - Get Delivery Service by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/tracking%23get-/services/-idDeliveryService-)
* [POST - Post Delivery Service With Route Scheduling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/tracking%23post-/services/routes)
* [GET - Get Delivery Services List by Route](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/tracking%23get-/services/routes)
* [GET - Get Delivery Service by Invoice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/tracking%23get-/services/invoice)

Contributors

1

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

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/Getting-Started/fulfillment.md)

[Payments« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment//docs/guides/payments-overview)[SearchNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment//docs/guides/search-overview)

Contributors

1

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

ON THIS PAGE

[Importing inventory from an ERP or Back office](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/docs/guides/fulfillment%23importing-inventory-from-an-erp-or-back-office)

[Understanding fulfillment process](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/docs/guides/fulfillment%23understanding-fulfillment-process)

[Setting up shipping strategy (mandatory)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/docs/guides/fulfillment%23setting-up-shipping-strategy-mandatory)

[1\. Shipping policy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/docs/guides/fulfillment%231-shipping-policy)[2\. Loading dock](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/docs/guides/fulfillment%232-loading-dock)[3\. Warehouse](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/docs/guides/fulfillment%233-warehouse)

[Managing shipping strategy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/docs/guides/fulfillment%23managing-shipping-strategy)

[Shipping policy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/docs/guides/fulfillment%23shipping-policy)[Loading dock](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/docs/guides/fulfillment%23loading-dock)[Warehouse](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/docs/guides/fulfillment%23warehouse)

[Managing inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/docs/guides/fulfillment%23managing-inventory)

[Inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/docs/guides/fulfillment%23inventory)

[Setting up shipping configurations (Optional)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/docs/guides/fulfillment%23setting-up-shipping-configurations-optional)

[Geolocation shipping (polygons)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/docs/guides/fulfillment%23geolocation-shipping-polygons)[Reservations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/docs/guides/fulfillment%23reservations)[Scheduled delivery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/docs/guides/fulfillment%23scheduled-delivery)[Holidays](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/docs/guides/fulfillment%23holidays)[Pickup points](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/docs/guides/fulfillment%23pickup-points)

[Calculating shipping estimate time](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/docs/guides/fulfillment%23calculating-shipping-estimate-time)

[SLA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/docs/guides/fulfillment%23sla)

[Optimizing fulfillment process with carriers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/docs/guides/fulfillment%23optimizing-fulfillment-process-with-carriers)

[Freight values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/docs/guides/fulfillment%23freight-values)[VTEX Shipping Network (independent App)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/docs/guides/fulfillment%23vtex-shipping-network-independent-app)[VTEX Tracking (independent App)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/docs/guides/fulfillment%23vtex-tracking-independent-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/Getting-Started/fulfillment.md)

Copy page

On this page

ON THIS PAGE

[Importing inventory from an ERP or Back office](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/docs/guides/fulfillment%23importing-inventory-from-an-erp-or-back-office)

[Understanding fulfillment process](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/docs/guides/fulfillment%23understanding-fulfillment-process)

[Setting up shipping strategy (mandatory)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/docs/guides/fulfillment%23setting-up-shipping-strategy-mandatory)

[1\. Shipping policy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/docs/guides/fulfillment%231-shipping-policy)[2\. Loading dock](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/docs/guides/fulfillment%232-loading-dock)[3\. Warehouse](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/docs/guides/fulfillment%233-warehouse)

[Managing shipping strategy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/docs/guides/fulfillment%23managing-shipping-strategy)

[Shipping policy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/docs/guides/fulfillment%23shipping-policy)[Loading dock](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/docs/guides/fulfillment%23loading-dock)[Warehouse](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/docs/guides/fulfillment%23warehouse)

[Managing inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/docs/guides/fulfillment%23managing-inventory)

[Inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/docs/guides/fulfillment%23inventory)

[Setting up shipping configurations (Optional)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/docs/guides/fulfillment%23setting-up-shipping-configurations-optional)

[Geolocation shipping (polygons)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/docs/guides/fulfillment%23geolocation-shipping-polygons)[Reservations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/docs/guides/fulfillment%23reservations)[Scheduled delivery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/docs/guides/fulfillment%23scheduled-delivery)[Holidays](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/docs/guides/fulfillment%23holidays)[Pickup points](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/docs/guides/fulfillment%23pickup-points)

[Calculating shipping estimate time](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/docs/guides/fulfillment%23calculating-shipping-estimate-time)

[SLA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/docs/guides/fulfillment%23sla)

[Optimizing fulfillment process with carriers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/docs/guides/fulfillment%23optimizing-fulfillment-process-with-carriers)

[Freight values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/docs/guides/fulfillment%23freight-values)[VTEX Shipping Network (independent App)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/docs/guides/fulfillment%23vtex-shipping-network-independent-app)[VTEX Tracking (independent App)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/fulfillment/docs/guides/fulfillment%23vtex-tracking-independent-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 icons 0.18.0 ICONPACK 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-icons@0.18.0/ICONPACK/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons@0.18.0/ICONPACK/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-icons@0.18.0/ICONPACK/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-icons@0.18.0/ICONPACK/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-icons@0.18.0/ICONPACK/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-icons@0.18.0/ICONPACK/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-icons@0.18.0/ICONPACK/updates/release-notes)

VTEX IO Apps

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

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

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

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

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

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

---

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

VTEX IO Apps

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

Icon Pack list

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

Version: 0.18.0

Latest version: 0.18.0

Here we describe all our SVG fragment identifiers.

:loudspeaker: **Disclaimer:** The `svg/` folder is just to render the icons in this MD.

### How to use this fragments?

First of all, you should add the `vtex.store-icons` to your dependencies in `manifest.json`.

This an example that show you how to use it.

`1

 import React from 'react'

2

3

 import Icon from 'vtex.store-icons'

4

5

 const IconSearch = ({ ...props }) => {

6

 return <Icon id="hpa-search" {...props} />

7

 }

8

9

 IconSearch.propTypes = {

10

 /** Icon size, aspect ratio 1:1 */

11

 size: PropTypes.number,

12

 /** Icon viewBox. Default 0, 0, 16, 16 */

13

 viewBox: PropTypes.string,

14

 /** Define if will be used a active or muted className */

15

 isActive: PropTypes.bool,

16

 /** Active color class */

17

 activeClassName: PropTypes.string,

18

 /** Muted color class */

19

 mutedClassName: PropTypes.string,

20

 }

21

 export default IconSearch

`

### SVG Prefixes

We use a series of prefixes to help us understand what an specific icon means.

* bnd - Brand;
* hpa - High Priority Actions;
* mpa - Midle Priority Actions;
* sti - Status Indicator;
* inf - Informative;
* nav - Navigation

### SVG Fragments

| Icon                                                                       | ID                         |
| -------------------------------------------------------------------------- | -------------------------- |
| An error occurred while loading the image ./bnd-logo.svg                   | bnd-logo                   |
| An error occurred while loading the image ./mpa-expand.svg                 | mpa-expand                 |
| An error occurred while loading the image ./hpa-arrow-back.svg             | hpa-arrow-back             |
| An error occurred while loading the image ./hpa-arrow-from-bottom.svg      | hpa-arrow-from-bottom      |
| An error occurred while loading the image ./hpa-arrow-to-bottom.svg        | hpa-arrow-to-bottom        |
| An error occurred while loading the image ./hpa-calendar.svg               | hpa-calendar               |
| An error occurred while loading the image ./hpa-cart.svg                   | hpa-cart                   |
| An error occurred while loading the image ./hpa-delete.svg                 | hpa-delete                 |
| An error occurred while loading the image ./hpa-hamburguer-menu.svg        | hpa-hamburguer-menu        |
| An error occurred while loading the image ./hpa-location-marker.svg        | hpa-location-marker        |
| An error occurred while loading the image ./hpa-play.svg                   | hpa-play                   |
| An error occurred while loading the image ./hpa-profile.svg                | hpa-profile                |
| An error occurred while loading the image ./hpa-save.svg                   | hpa-save                   |
| An error occurred while loading the image ./hpa-search.svg                 | hpa-search                 |
| An error occurred while loading the image ./hpa-telemarketing.svg          | hpa-telemarketing          |
| An error occurred while loading the image ./inf-help--filled.svg           | inf-help--filled           |
| An error occurred while loading the image ./inf-help--outline.svg          | inf-help--outline          |
| An error occurred while loading the image ./inf-star.svg                   | inf-star                   |
| An error occurred while loading the image ./inf-tooltip--filled.svg        | inf-tooltip--filled        |
| An error occurred while loading the image ./inf-tooltip--outline.svg       | inf-tooltip--outline       |
| An error occurred while loading the image ./inf-warning--filled.svg        | inf-warning--filled        |
| An error occurred while loading the image ./inf-warning--outline.svg       | inf-warning--outline       |
| An error occurred while loading the image ./mpa-angle--down.svg            | mpa-angle--down            |
| An error occurred while loading the image ./mpa-angle--up.svg              | mpa-angle--up              |
| An error occurred while loading the image ./mpa-arrows.svg                 | mpa-arrows                 |
| An error occurred while loading the image ./mpa-bag.svg                    | mpa-bag                    |
| An error occurred while loading the image ./mpa-bars.svg                   | mpa-bars                   |
| An error occurred while loading the image ./mpa-bookmark--filled.svg       | mpa-bookmark--filled       |
| An error occurred while loading the image ./mpa-bookmark--outline.svg      | mpa-bookmark--outline      |
| An error occurred while loading the image ./mpa-clone--filled.svg          | mpa-clone--filled          |
| An error occurred while loading the image ./mpa-clone--outline.svg         | mpa-clone--outline         |
| An error occurred while loading the image ./mpa-cog.svg                    | mpa-cog                    |
| An error occurred while loading the image ./mpa-columns.svg                | mpa-columns                |
| An error occurred while loading the image ./mpa-credit-card.svg            | mpa-credit-card            |
| An error occurred while loading the image ./mpa-edit--filled.svg           | mpa-edit--filled           |
| An error occurred while loading the image ./mpa-edit--outline.svg          | mpa-edit--outline          |
| An error occurred while loading the image ./mpa-elypsis.svg                | mpa-elypsis                |
| An error occurred while loading the image ./mpa-exchange.svg               | mpa-exchange               |
| An error occurred while loading the image ./mpa-export.svg                 | mpa-export                 |
| An error occurred while loading the image ./mpa-external-link--line.svg    | mpa-external-link--line    |
| An error occurred while loading the image ./mpa-external-link--outline.svg | mpa-external-link--outline |
| An error occurred while loading the image ./mpa-eyesight--filled--off.svg  | mpa-eyesight--filled--off  |
| An error occurred while loading the image ./mpa-eyesight--filled--on.svg   | mpa-eyesight--filled--on   |
| An error occurred while loading the image ./mpa-eyesight--outline--off.svg | mpa-eyesight--outline--off |
| An error occurred while loading the image ./mpa-eyesight--outline--on.svg  | mpa-eyesight--outline--on  |
| An error occurred while loading the image ./mpa-filter--filled.svg         | mpa-filter--filled         |
| An error occurred while loading the image ./mpa-filter--outline.svg        | mpa-filter--outline        |
| An error occurred while loading the image ./mpa-filter-settings.svg        | mpa-filter-settings        |
| An error occurred while loading the image ./mpa-gallery.svg                | mpa-gallery                |
| An error occurred while loading the image ./mpa-globe.svg                  | mpa-globe                  |
| An error occurred while loading the image ./mpa-heart.svg                  | mpa-heart                  |
| An error occurred while loading the image ./mpa-link.svg                   | mpa-link                   |
| An error occurred while loading the image ./mpa-list-items.svg             | mpa-list-items             |
| An error occurred while loading the image ./mpa-location-input.svg         | mpa-location-input         |
| An error occurred while loading the image ./mpa-minus--filled.svg          | mpa-minus--filled          |
| An error occurred while loading the image ./mpa-minus--line.svg            | mpa-minus--line            |
| An error occurred while loading the image ./mpa-minus--outline.svg         | mpa-minus--outline         |
| An error occurred while loading the image ./mpa-plus--filled.svg           | mpa-plus--filled           |
| An error occurred while loading the image ./mpa-plus--line.svg             | mpa-plus--line             |
| An error occurred while loading the image ./mpa-plus--outline.svg          | mpa-plus--outline          |
| An error occurred while loading the image ./mpa-remove.svg                 | mpa-remove                 |
| An error occurred while loading the image ./mpa-settings.svg               | mpa-settings               |
| An error occurred while loading the image ./mpa-single-item.svg            | mpa-single-item            |
| An error occurred while loading the image ./mpa-store.svg                  | mpa-store                  |
| An error occurred while loading the image ./mpa-swap.svg                   | mpa-swap                   |
| An error occurred while loading the image ./nav-arrow--left.svg            | nav-arrow--left            |
| An error occurred while loading the image ./nav-arrow--right.svg           | nav-arrow--right           |
| An error occurred while loading the image ./nav-caret--down.svg            | nav-caret--down            |
| An error occurred while loading the image ./nav-caret--left.svg            | nav-caret--left            |
| An error occurred while loading the image ./nav-caret--right.svg           | nav-caret--right           |
| An error occurred while loading the image ./nav-caret--up.svg              | nav-caret--up              |
| An error occurred while loading the image ./nav-home.svg                   | nav-home                   |
| An error occurred while loading the image ./nav-minus.svg                  | nav-minus                  |
| An error occurred while loading the image ./nav-plus.svg                   | nav-plus                   |
| An error occurred while loading the image ./nav-thin-caret--left.svg       | nav-thin-caret--left       |
| An error occurred while loading the image ./nav-thin-caret--right.svg      | nav-thin-caret--right      |
| An error occurred while loading the image ./sti-check--filled.svg          | sti-check--filled          |
| An error occurred while loading the image ./sti-check--line.svg            | sti-check--line            |
| An error occurred while loading the image ./sti-check--outline.svg         | sti-check--outline         |
| An error occurred while loading the image ./sti-clock.svg                  | sti-clock                  |
| An error occurred while loading the image ./sti-close--filled.svg          | sti-close--filled          |
| An error occurred while loading the image ./sti-close--line.svg            | sti-close--line            |
| An error occurred while loading the image ./sti-close--outline.svg         | sti-close--outline         |
| An error occurred while loading the image ./sti-discount.svg               | sti-discount               |
| An error occurred while loading the image ./sti-equals.svg                 | sti-equals                 |
| An error occurred while loading the image ./sti-loading.svg                | sti-loading                |

See also

[Vtex.store IconsVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons@0.18.0/ICONPACK/docs/apps/vtex.store-icons)[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)

ON THIS PAGE

[How to use this fragments?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons@0.18.0/ICONPACK/docs/apps/vtex.store-icons@0.18.0/ICONPACK%23how-to-use-this-fragments)

[SVG Prefixes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons@0.18.0/ICONPACK/docs/apps/vtex.store-icons@0.18.0/ICONPACK%23svg-prefixes)[SVG Fragments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-icons@0.18.0/ICONPACK/docs/apps/vtex.store-icons@0.18.0/ICONPACK%23svg-fragments)

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=)


[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 consult product search information 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/consult-product-search-information/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-product-search-information/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/consult-product-search-information/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-product-search-information/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/consult-product-search-information/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-product-search-information/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/consult-product-search-information/updates/release-notes)

Guides

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

---

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

---

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

---

Integration Guides

---

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

---

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

---

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

---

Payments

---

Orders

---

Logistics

---

B2B Suite

---

VTEX Sales App

---

UI Customization

---

Message Center

---

Pricing

---

Promotions

---

Infrastructure

---

Search

[How search parameters work](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-product-search-information/docs/guides/how-search-parameters-work)

[Search Control – fulltextSearchBox](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-product-search-information/docs/guides/search-control-fulltextsearchbox)

[Consult store search terms information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-product-search-information/docs/guides/consult-store-search-terms-information)

[Consult product search information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-product-search-information/docs/guides/consult-product-search-information)

[Get banner list for a specific search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-product-search-information/docs/guides/get-banner-list-for-a-specific-search)

[Get a list of the possible facets for a specific search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-product-search-information/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search)

[Segmenting the search result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-product-search-information/docs/guides/vtex-io-documentation-segmenting-the-search-result)

[Access Control List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-product-search-information/docs/guides/access-control-list)

[Delivery promise for headless stores (Beta)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-product-search-information/docs/guides/delivery-promise-for-headless-stores)

---

Storefront Permissions

---

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

---

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

---

VTEX Session

---

VTEX Shield

---

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

---

Weni by VTEX

---

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

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

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

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

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

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

---

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

Guides

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

---

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

---

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

---

Integration Guides

---

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

---

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

---

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

---

Payments

---

Orders

---

Logistics

---

B2B Suite

---

VTEX Sales App

---

UI Customization

---

Message Center

---

Pricing

---

Promotions

---

Infrastructure

---

Search

[How search parameters work](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-product-search-information/docs/guides/how-search-parameters-work)

[Search Control – fulltextSearchBox](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-product-search-information/docs/guides/search-control-fulltextsearchbox)

[Consult store search terms information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-product-search-information/docs/guides/consult-store-search-terms-information)

[Consult product search information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-product-search-information/docs/guides/consult-product-search-information)

[Get banner list for a specific search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-product-search-information/docs/guides/get-banner-list-for-a-specific-search)

[Get a list of the possible facets for a specific search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-product-search-information/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search)

[Segmenting the search result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-product-search-information/docs/guides/vtex-io-documentation-segmenting-the-search-result)

[Access Control List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-product-search-information/docs/guides/access-control-list)

[Delivery promise for headless stores (Beta)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-product-search-information/docs/guides/delivery-promise-for-headless-stores)

---

Storefront Permissions

---

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

---

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

---

VTEX Session

---

VTEX Shield

---

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

---

Weni by VTEX

---

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

Search

[Consult product search information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-product-search-information/docs/guides/consult-product-search-information)

Consult product search information

It is essential to understand the products searched in your store to present personalized marketing information to shoppers. You can use the [Intelligent Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api%23overview), as detailed in the following sections, to gather information about shoppers’ product searches. This way, you can create [synonyms](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-intelligent-search--19wrbB7nEQcmwzDPl1l4Cb/1pxAWPEglBey1UFdvcetZV) or [banners](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-intelligent-search--19wrbB7nEQcmwzDPl1l4Cb/1pxAWPEglBey1UFdvcetZV) that include common searches on your store.

## Get a list of suggested terms for a search term

To get a list of suggested terms for a search term, you must use the [Get list of suggested terms similar to the search term](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/get%5Fsearch-suggestions) endpoint. You can filter the endpoint response by defining the term's `locale` and `query`.

**Response body example:**

`1

{

2

 "searches": [

3

 {

4

 "term": "mountain bike",

5

 "count": 66

6

 },

7

 {

8

 "term": "bike helmet",

9

 "count": 121

10

 },

11

 {

12

 "term": "electric bike",

13

 "count": 78

14

 },

15

 {

16

 "term": "bike rack",

17

 "count": 161

18

 },

19

 {

20

 "term": "road bike",

21

 "count": 28

22

 }

23

 ]

24

}

`

## Get correction of misspelled words of a search

To get the system corrections for a misspelled search term, you must use the [Get attempt of correction of a misspelled term](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/get%5Fcorrection-search) endpoint. You can filter the endpoint response by defining the term's `locale` and `query`.

**Response body example:**

`1

{

2

 "correction": {

3

 "correction": true,

4

 "misspelled": true,

5

 "text": "mountain bike",

6

 "highlighted": "mountain bike"

7

 }

8

}

`

## Get product list for a specific search

To get a product list for a search term, you must use the [Get list of products for a query](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/get%5Fproduct-search-facets) endpoint. You can filter the endpoint response by defining the term's `locale` and `query`.

**Response body example:**

`1

{

2

 "products": [

3

 {

4

 "cacheId": "sp-2000003",

5

 "productId": "2000003",

6

 "description": "With this beautiful design piece you will never miss an appointment anymore. Yay.",

7

 "productName": "Top Wood Clock",

8

 "productReference": "clock120",

9

 "linkText": "wood-clock",

10

 "brand": "Sony",

11

 "brandId": 2000005,

12

 "link": "/wood-clock/p",

13

 "categories": [

14

 "/Home & Decor/"

15

 ],

16

 "categoryId": "40",

17

 "categoriesIds": [

18

 "/40/"

19

 ],

20

 "priceRange": {

21

 "sellingPrice": {

22

 "highPrice": 197.99,

23

 "lowPrice": 197.99

24

 },

25

 "listPrice": {

26

 "highPrice": 197.99,

27

 "lowPrice": 197.99

28

 }

29

 },

30

 "specificationGroups": [

31

 {

32

 "originalName": "allSpecifications",

33

 "name": "allSpecifications",

34

 "specifications": [

35

 {

36

 "originalName": "sellerId",

37

 "name": "sellerId",

38

 "values": [

39

 "1"

40

 ]

41

 }

42

 ]

43

 }

44

 ],

45

 "skuSpecifications": [],

46

 "productClusters": [

47

 {

48

 "id": "1970",

49

 "name": "Summer"

50

 }

51

 ],

52

 "clusterHighlights": [

53

 {

54

 "id": "1970",

55

 "name": "Summer"

56

 }

57

 ],

58

 "properties": [

59

 {

60

 "name": "sellerId",

61

 "originalName": "sellerId",

62

 "values": [

63

 "1"

64

 ]

65

 }

66

 ],

67

 "items": [

68

 {

69

 "sellers": [

70

 {

71

 "sellerId": "1",

72

 "sellerName": "VTEX",

73

 "addToCartLink": "",

74

 "sellerDefault": true,

75

 "commertialOffer": {

76

 "DeliverySlaSamplesPerRegion": {},

77

 "DeliverySlaSamples": [],

78

 "AvailableQuantity": 10000,

79

 "discountHighlights": [],

80

 "Installments": [

81

 {

82

 "Value": 197.99,

83

 "InterestRate": 0,

84

 "TotalValuePlusInterestRate": 197.99,

85

 "NumberOfInstallments": 1,

86

 "Name": "American Express à vista",

87

 "PaymentSystemName": "American Express"

88

 },

89

 {

90

 "Value": 197.99,

91

 "InterestRate": 0,

92

 "TotalValuePlusInterestRate": 197.99,

93

 "NumberOfInstallments": 1,

94

 "Name": "Visa à vista",

95

 "PaymentSystemName": "Visa"

96

 },

97

 {

98

 "Value": 98.99,

99

 "InterestRate": 0,

100

 "TotalValuePlusInterestRate": 197.99,

101

 "NumberOfInstallments": 2,

102

 "Name": "Visa 2 vezes sem juros",

103

 "PaymentSystemName": "Visa"

104

 },

105

 {

106

 "Value": 65.99,

107

 "InterestRate": 0,

108

 "TotalValuePlusInterestRate": 197.99,

109

 "NumberOfInstallments": 3,

110

 "Name": "Visa 3 vezes sem juros",

111

 "PaymentSystemName": "Visa"

112

 },

113

 {

114

 "Value": 49.49,

115

 "InterestRate": 0,

116

 "TotalValuePlusInterestRate": 197.99,

117

 "NumberOfInstallments": 4,

118

 "Name": "Visa 4 vezes sem juros",

119

 "PaymentSystemName": "Visa"

120

 },

121

 {

122

 "Value": 39.59,

123

 "InterestRate": 0,

124

 "TotalValuePlusInterestRate": 197.99,

125

 "NumberOfInstallments": 5,

126

 "Name": "Visa 5 vezes sem juros",

127

 "PaymentSystemName": "Visa"

128

 },

129

 {

130

 "Value": 32.99,

131

 "InterestRate": 0,

132

 "TotalValuePlusInterestRate": 197.99,

133

 "NumberOfInstallments": 6,

134

 "Name": "Visa 6 vezes sem juros",

135

 "PaymentSystemName": "Visa"

136

 },

137

 {

138

 "Value": 197.99,

139

 "InterestRate": 0,

140

 "TotalValuePlusInterestRate": 197.99,

141

 "NumberOfInstallments": 1,

142

 "Name": "Diners à vista",

143

 "PaymentSystemName": "Diners"

144

 },

145

 {

146

 "Value": 100.48,

147

 "InterestRate": 100,

148

 "TotalValuePlusInterestRate": 200.96,

149

 "NumberOfInstallments": 2,

150

 "Name": "Diners 2 vezes com juros",

151

 "PaymentSystemName": "Diners"

152

 },

153

 {

154

 "Value": 197.99,

155

 "InterestRate": 0,

156

 "TotalValuePlusInterestRate": 197.99,

157

 "NumberOfInstallments": 1,

158

 "Name": "Mastercard à vista",

159

 "PaymentSystemName": "Mastercard"

160

 },

161

 {

162

 "Value": 197.99,

163

 "InterestRate": 0,

164

 "TotalValuePlusInterestRate": 197.99,

165

 "NumberOfInstallments": 1,

166

 "Name": "Boleto Bancário à vista",

167

 "PaymentSystemName": "Boleto Bancário"

168

 },

169

 {

170

 "Value": 197.99,

171

 "InterestRate": 0,

172

 "TotalValuePlusInterestRate": 197.99,

173

 "NumberOfInstallments": 1,

174

 "Name": "Vale à vista",

175

 "PaymentSystemName": "Vale"

176

 },

177

 {

178

 "Value": 197.99,

179

 "InterestRate": 0,

180

 "TotalValuePlusInterestRate": 197.99,

181

 "NumberOfInstallments": 1,

182

 "Name": "Promissory à vista",

183

 "PaymentSystemName": "Promissory"

184

 },

185

 {

186

 "Value": 197.99,

187

 "InterestRate": 0,

188

 "TotalValuePlusInterestRate": 197.99,

189

 "NumberOfInstallments": 1,

190

 "Name": "Customer Credit à vista",

191

 "PaymentSystemName": "Customer Credit"

192

 },

193

 {

194

 "Value": 98.99,

195

 "InterestRate": 0,

196

 "TotalValuePlusInterestRate": 197.99,

197

 "NumberOfInstallments": 2,

198

 "Name": "Customer Credit 2 vezes sem juros",

199

 "PaymentSystemName": "Customer Credit"

200

 },

201

 {

202

 "Value": 67.97,

203

 "InterestRate": 100,

204

 "TotalValuePlusInterestRate": 203.91,

205

 "NumberOfInstallments": 3,

206

 "Name": "Customer Credit 3 vezes com juros",

207

 "PaymentSystemName": "Customer Credit"

208

 },

209

 {

210

 "Value": 197.99,

211

 "InterestRate": 0,

212

 "TotalValuePlusInterestRate": 197.99,

213

 "NumberOfInstallments": 1,

214

 "Name": "Free à vista",

215

 "PaymentSystemName": "Free"

216

 }

217

 ],

218

 "Price": 197.99,

219

 "ListPrice": 197.99,

220

 "spotPrice": 197.99,

221

 "taxPercentage": 0,

222

 "PriceWithoutDiscount": 197.99,

223

 "Tax": 0,

224

 "GiftSkuIds": [],

225

 "BuyTogether": [],

226

 "ItemMetadataAttachment": [],

227

 "RewardValue": 0,

228

 "PriceValidUntil": "2023-04-01T13:13:20Z",

229

 "GetInfoErrorMessage": null,

230

 "CacheVersionUsedToCallCheckout": "",

231

 "teasers": [

232

 {

233

 "name": "8% Boleto",

234

 "conditions": {

235

 "minimumQuantity": 0,

236

 "parameters": [

237

 {

238

 "name": "PaymentMethodId",

239

 "value": "6"

240

 }

241

 ]

242

 },

243

 "effects": {

244

 "parameters": [

245

 {

246

 "name": "PercentualDiscount",

247

 "value": "8.0"

248

 }

249

 ]

250

 }

251

 }

252

 ]

253

 }

254

 }

255

 ],

256

 "images": [

257

 {

258

 "imageId": "155484",

259

 "cacheId": "155484",

260

 "imageTag": "",

261

 "imageLabel": "",

262

 "imageText": "",

263

 "imageUrl": "https://storecomponents.vtexassets.com/arquivos/ids/155484/Frame.jpg?v=636793817478300000"

264

 },

265

 {

266

 "imageId": "155485",

267

 "cacheId": "155485",

268

 "imageTag": "",

269

 "imageLabel": "",

270

 "imageText": "",

271

 "imageUrl": "https://storecomponents.vtexassets.com/arquivos/ids/155485/Frame-1.jpg?v=636793817642000000"

272

 },

273

 {

274

 "imageId": "155486",

275

 "cacheId": "155486",

276

 "imageTag": "",

277

 "imageLabel": "",

278

 "imageText": "",

279

 "imageUrl": "https://storecomponents.vtexassets.com/arquivos/ids/155486/Frame-2.jpg?v=636793817785530000"

280

 }

281

 ],

282

 "itemId": "2000534",

283

 "name": "1",

284

 "nameComplete": "Top Wood Clock 1",

285

 "complementName": "",

286

 "referenceId": [

287

 {

288

 "Key": "RefId",

289

 "Value": "16001"

290

 }

291

 ],

292

 "measurementUnit": "un",

293

 "unitMultiplier": 1,

294

 "variations": [],

295

 "ean": "16001",

296

 "modalType": "",

297

 "videos": [],

298

 "attachments": [],

299

 "isKit": false

300

 }

301

 ],

302

 "origin": "intelligent-search"

303

 },

304

 {

305

 "cacheId": "sp-2000214",

306

 "productId": "2000214",

307

 "description": "",

308

 "productName": "kevin1",

309

 "linkText": "kevin1-lkn",

310

 "brand": "Sony",

311

 "brandId": 2000005,

312

 "link": "/kevin1-lkn/p",

313

 "categories": [

314

 "/Home & Decor/"

315

 ],

316

 "categoryId": "40",

317

 "categoriesIds": [

318

 "/40/"

319

 ],

320

 "priceRange": {

321

 "sellingPrice": {

322

 "highPrice": 10,

323

 "lowPrice": 10

324

 },

325

 "listPrice": {

326

 "highPrice": 10,

327

 "lowPrice": 10

328

 }

329

 },

330

 "specificationGroups": [

331

 {

332

 "originalName": "allSpecifications",

333

 "name": "allSpecifications",

334

 "specifications": [

335

 {

336

 "originalName": "sellerId",

337

 "name": "sellerId",

338

 "values": [

339

 "1"

340

 ]

341

 }

342

 ]

343

 }

344

 ],

345

 "skuSpecifications": [],

346

 "productClusters": [],

347

 "clusterHighlights": [],

348

 "properties": [

349

 {

350

 "name": "sellerId",

351

 "originalName": "sellerId",

352

 "values": [

353

 "1"

354

 ]

355

 }

356

 ],

357

 "items": [

358

 {

359

 "sellers": [

360

 {

361

 "sellerId": "1",

362

 "sellerName": "VTEX",

363

 "addToCartLink": "",

364

 "sellerDefault": true,

365

 "commertialOffer": {

366

 "DeliverySlaSamplesPerRegion": {},

367

 "DeliverySlaSamples": [],

368

 "AvailableQuantity": 10000,

369

 "discountHighlights": [],

370

 "Installments": [

371

 {

372

 "Value": 10,

373

 "InterestRate": 0,

374

 "TotalValuePlusInterestRate": 10,

375

 "NumberOfInstallments": 1,

376

 "Name": "American Express à vista",

377

 "PaymentSystemName": "American Express"

378

 },

379

 {

380

 "Value": 10,

381

 "InterestRate": 0,

382

 "TotalValuePlusInterestRate": 10,

383

 "NumberOfInstallments": 1,

384

 "Name": "Visa à vista",

385

 "PaymentSystemName": "Visa"

386

 },

387

 {

388

 "Value": 10,

389

 "InterestRate": 0,

390

 "TotalValuePlusInterestRate": 10,

391

 "NumberOfInstallments": 1,

392

 "Name": "Diners à vista",

393

 "PaymentSystemName": "Diners"

394

 },

395

 {

396

 "Value": 10,

397

 "InterestRate": 0,

398

 "TotalValuePlusInterestRate": 10,

399

 "NumberOfInstallments": 1,

400

 "Name": "Mastercard à vista",

401

 "PaymentSystemName": "Mastercard"

402

 },

403

 {

404

 "Value": 10,

405

 "InterestRate": 0,

406

 "TotalValuePlusInterestRate": 10,

407

 "NumberOfInstallments": 1,

408

 "Name": "Boleto Bancário à vista",

409

 "PaymentSystemName": "Boleto Bancário"

410

 },

411

 {

412

 "Value": 10,

413

 "InterestRate": 0,

414

 "TotalValuePlusInterestRate": 10,

415

 "NumberOfInstallments": 1,

416

 "Name": "Vale à vista",

417

 "PaymentSystemName": "Vale"

418

 },

419

 {

420

 "Value": 10,

421

 "InterestRate": 0,

422

 "TotalValuePlusInterestRate": 10,

423

 "NumberOfInstallments": 1,

424

 "Name": "Promissory à vista",

425

 "PaymentSystemName": "Promissory"

426

 },

427

 {

428

 "Value": 10,

429

 "InterestRate": 0,

430

 "TotalValuePlusInterestRate": 10,

431

 "NumberOfInstallments": 1,

432

 "Name": "Customer Credit à vista",

433

 "PaymentSystemName": "Customer Credit"

434

 },

435

 {

436

 "Value": 5,

437

 "InterestRate": 0,

438

 "TotalValuePlusInterestRate": 10,

439

 "NumberOfInstallments": 2,

440

 "Name": "Customer Credit 2 vezes sem juros",

441

 "PaymentSystemName": "Customer Credit"

442

 },

443

 {

444

 "Value": 3.43,

445

 "InterestRate": 100,

446

 "TotalValuePlusInterestRate": 10.29,

447

 "NumberOfInstallments": 3,

448

 "Name": "Customer Credit 3 vezes com juros",

449

 "PaymentSystemName": "Customer Credit"

450

 },

451

 {

452

 "Value": 10,

453

 "InterestRate": 0,

454

 "TotalValuePlusInterestRate": 10,

455

 "NumberOfInstallments": 1,

456

 "Name": "Free à vista",

457

 "PaymentSystemName": "Free"

458

 }

459

 ],

460

 "Price": 10,

461

 "ListPrice": 10,

462

 "spotPrice": 10,

463

 "taxPercentage": 0,

464

 "PriceWithoutDiscount": 10,

465

 "Tax": 0,

466

 "GiftSkuIds": [],

467

 "BuyTogether": [],

468

 "ItemMetadataAttachment": [],

469

 "RewardValue": 0,

470

 "PriceValidUntil": "2023-04-01T13:13:20Z",

471

 "GetInfoErrorMessage": null,

472

 "CacheVersionUsedToCallCheckout": "",

473

 "teasers": [

474

 {

475

 "name": "8% Boleto",

476

 "conditions": {

477

 "minimumQuantity": 0,

478

 "parameters": [

479

 {

480

 "name": "PaymentMethodId",

481

 "value": "6"

482

 }

483

 ]

484

 },

485

 "effects": {

486

 "parameters": [

487

 {

488

 "name": "PercentualDiscount",

489

 "value": "8.0"

490

 }

491

 ]

492

 }

493

 }

494

 ]

495

 }

496

 }

497

 ],

498

 "images": [

499

 {

500

 "imageId": "155675",

501

 "cacheId": "155675",

502

 "imageTag": "",

503

 "imageLabel": "vtex",

504

 "imageText": "vtex",

505

 "imageUrl": "https://storecomponents.vtexassets.com/arquivos/ids/155675/vtex.jpg?v=637655270451200000"

506

 }

507

 ],

508

 "itemId": "310124211",

509

 "name": "kevin1sku",

510

 "nameComplete": "kevin1sku",

511

 "complementName": "",

512

 "referenceId": [

513

 {

514

 "Key": "RefId",

515

 "Value": "2983678w63478"

516

 }

517

 ],

518

 "measurementUnit": "un",

519

 "unitMultiplier": 1,

520

 "variations": [],

521

 "ean": "2398428937489",

522

 "modalType": "",

523

 "videos": [],

524

 "attachments": [],

525

 "isKit": false

526

 }

527

 ],

528

 "origin": "intelligent-search"

529

 }

530

 ],

531

 "recordsFiltered": 5,

532

 "correction": {

533

 "misspelled": false

534

 },

535

 "fuzzy": "0",

536

 "operator": "and",

537

 "translated": false

538

}

`

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-product-search-information/_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/Search/consult-product-search-information.md)

[Consult store search terms information« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-product-search-information//docs/guides/consult-store-search-terms-information)[Get banner list for a specific searchNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-product-search-information//docs/guides/get-banner-list-for-a-specific-search)

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-product-search-information/_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

[Get a list of suggested terms for a search term](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-product-search-information/docs/guides/consult-product-search-information%23get-a-list-of-suggested-terms-for-a-search-term)

[Get correction of misspelled words of a search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-product-search-information/docs/guides/consult-product-search-information%23get-correction-of-misspelled-words-of-a-search)

[Get product list for a specific search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-product-search-information/docs/guides/consult-product-search-information%23get-product-list-for-a-specific-search)

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/Search/consult-product-search-information.md)

Copy page

On this page

ON THIS PAGE

[Get a list of suggested terms for a search term](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-product-search-information/docs/guides/consult-product-search-information%23get-a-list-of-suggested-terms-for-a-search-term)

[Get correction of misspelled words of a search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-product-search-information/docs/guides/consult-product-search-information%23get-correction-of-misspelled-words-of-a-search)

[Get product list for a specific search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-product-search-information/docs/guides/consult-product-search-information%23get-product-list-for-a-specific-search)

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=)