Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
83 commits
Select commit Hold shift + click to select a range
3ae4e22
Update Filter by Store image
mariana-caetano Sep 19, 2025
ce8903d
Update PLP and search filters
mariana-caetano Sep 19, 2025
5171859
Apply suggestions from code review
mariana-caetano Sep 19, 2025
845dce2
Adding badges section
mariana-caetano Sep 25, 2025
21db5d9
Fix typos
mariana-caetano Sep 25, 2025
6c98e5c
Apply suggestion from @github-actions[bot]
mariana-caetano Sep 25, 2025
651e527
Add 'Managing filters and badges'
mariana-caetano Sep 26, 2025
dcff431
Add callout
mariana-caetano Sep 26, 2025
916f9ed
Fix callout
mariana-caetano Sep 26, 2025
ddc7f1c
Fix titles and images
mariana-caetano Sep 29, 2025
f9c4817
Review Delivery Option and availability
mariana-caetano Sep 29, 2025
6b5414a
Apply suggestion from @github-actions[bot]
mariana-caetano Sep 29, 2025
97e085e
Apply suggestion from @github-actions[bot]
mariana-caetano Sep 29, 2025
5d19933
Fix typos
mariana-caetano Sep 29, 2025
b2b8141
Apply suggestion from @github-actions[bot]
mariana-caetano Sep 29, 2025
dffad5c
Apply suggestion from @github-actions[bot]
mariana-caetano Sep 29, 2025
0611485
Apply suggestion from @github-actions[bot]
mariana-caetano Sep 29, 2025
29a9795
Fix typos
mariana-caetano Sep 29, 2025
40be9d4
Edit managing filter and badge labels
mariana-caetano Sep 29, 2025
96149c3
Apply suggestion from @github-actions[bot]
mariana-caetano Sep 29, 2025
976b982
Apply suggestion from @github-actions[bot]
mariana-caetano Sep 29, 2025
9c5b82a
Apply suggestion from @github-actions[bot]
mariana-caetano Sep 29, 2025
fdc0006
Apply suggestion from @github-actions[bot]
mariana-caetano Sep 29, 2025
92d4d6d
Apply suggestion from @github-actions[bot]
mariana-caetano Sep 29, 2025
2e7f8e0
Apply suggestion from @github-actions[bot]
mariana-caetano Sep 29, 2025
1680326
Apply suggestion from @github-actions[bot]
mariana-caetano Sep 29, 2025
46e3daa
Fix typos
mariana-caetano Sep 30, 2025
58f7385
Apply suggestion from @lariciamota
mariana-caetano Oct 6, 2025
461452f
Apply suggestion from @lariciamota
mariana-caetano Oct 6, 2025
8617afc
Apply suggestion from @lariciamota
mariana-caetano Oct 6, 2025
30ece5a
Apply suggestion from @lariciamota
mariana-caetano Oct 6, 2025
e425a2a
Apply suggestion from @lariciamota
mariana-caetano Oct 6, 2025
6b9599c
Apply suggestion from @lariciamota
mariana-caetano Oct 6, 2025
d9cfff2
Fix Headless CMS name and add link to the Delivery Options guide
mariana-caetano Oct 6, 2025
7e2c09d
Merge branch 'main' into EDU-16074
mariana-caetano Oct 6, 2025
61dfbcb
Review Delivery Options
mariana-caetano Oct 6, 2025
8b0935b
Fix title
mariana-caetano Oct 6, 2025
0100ca1
Fix typos
mariana-caetano Oct 6, 2025
2ecc689
Apply suggestion from @github-actions[bot]
mariana-caetano Oct 6, 2025
4031a85
Apply suggestion from @github-actions[bot]
mariana-caetano Oct 6, 2025
6b06f04
Apply suggestion from @github-actions[bot]
mariana-caetano Oct 6, 2025
41909e6
Apply suggestion from @github-actions[bot]
mariana-caetano Oct 6, 2025
a83b5ba
Apply suggestion from @github-actions[bot]
mariana-caetano Oct 6, 2025
9bf1297
Apply suggestion from @github-actions[bot]
mariana-caetano Oct 6, 2025
2261a95
Apply suggestion from @github-actions[bot]
mariana-caetano Oct 6, 2025
0d858b5
Apply suggestion from @github-actions[bot]
mariana-caetano Oct 6, 2025
591b6d0
Fix DO image
mariana-caetano Oct 6, 2025
eab590e
Apply suggestion from @lariciamota
mariana-caetano Oct 6, 2025
579fc88
Apply suggestion from @hellofanny
mariana-caetano Oct 6, 2025
c876bea
Apply suggestion from @hellofanny
mariana-caetano Oct 6, 2025
20d7f28
Add SLA filter
mariana-caetano Oct 6, 2025
0936e58
Add how to enable availability filter
mariana-caetano Oct 6, 2025
8a3596b
Fix availability gif
mariana-caetano Oct 6, 2025
77c4d2a
Apply suggestion from @github-actions[bot]
mariana-caetano Oct 6, 2025
b515705
Apply suggestion from @github-actions[bot]
mariana-caetano Oct 6, 2025
38599bc
Apply suggestion from @github-actions[bot]
mariana-caetano Oct 6, 2025
f31a221
Apply suggestion from @github-actions[bot]
mariana-caetano Oct 6, 2025
dff48f0
Apply suggestion from @github-actions[bot]
mariana-caetano Oct 6, 2025
516df8e
Apply suggestion from @github-actions[bot]
mariana-caetano Oct 6, 2025
1a85527
Apply suggestion from @github-actions[bot]
mariana-caetano Oct 6, 2025
a19b2ac
Apply suggestion from @github-actions[bot]
mariana-caetano Oct 6, 2025
9182b64
Fix typo
mariana-caetano Oct 7, 2025
575fb3c
Fix typos and review SLA section
mariana-caetano Oct 7, 2025
51c728e
Apply suggestion from @hellofanny
mariana-caetano Oct 7, 2025
6a291dd
Merge branch 'EDU-16074' of https://github.com/vtexdocs/dev-portal-co…
mariana-caetano Oct 7, 2025
b7c4067
Commenting SLA part
mariana-caetano Oct 8, 2025
fa5c7fb
Mention experimental hooks
mariana-caetano Oct 8, 2025
a2ca314
Quick fixes
mariana-caetano Oct 8, 2025
e9fe738
Apply suggestion from @github-actions[bot]
mariana-caetano Oct 8, 2025
48d89af
Apply suggestion from @github-actions[bot]
mariana-caetano Oct 8, 2025
d6c6571
Update docs/faststore/components/features/delivery-promise/overview.mdx
mariana-caetano Oct 13, 2025
32b1fcb
Apply suggestion from @github-actions[bot]
mariana-caetano Oct 13, 2025
b5c1fc2
Apply suggestion from @github-actions[bot]
mariana-caetano Oct 13, 2025
7d924ae
Apply suggestion from @github-actions[bot]
mariana-caetano Oct 13, 2025
fb2b30c
Apply suggestion from @barbara-celi
mariana-caetano Oct 15, 2025
232ea89
Apply suggestion from @barbara-celi
mariana-caetano Oct 15, 2025
39e638b
Apply suggestion from @barbara-celi
mariana-caetano Oct 15, 2025
4a43f6d
Apply suggestion from @barbara-celi
mariana-caetano Oct 15, 2025
a9a88d1
Apply suggestion from @barbara-celi
mariana-caetano Oct 15, 2025
4663db5
Apply suggestion from @barbara-celi
mariana-caetano Oct 15, 2025
4d3e798
Apply suggestion from @karenkrieger
mariana-caetano Oct 15, 2025
2c187ee
Fix links in Delivery Promise implementation guide
mariana-caetano Oct 15, 2025
1f6ee9e
Update Delivery Promise overview documentation
mariana-caetano Oct 15, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 [Grammar reviewer] reported by reviewdog 🐶
Rephrased for better flow and conciseness. 'Installed' functions as an adjective modifying 'Edition app version.'

In your terminal, log in to your account by running `vtex login {accountName}` and run `vtex edition get` to see the Edition app version installed. *Remember to replace the values between curly braces with your account name*.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 [Grammar reviewer] reported by reviewdog 🐶
Added 'the' for grammatical correctness when referring to a specific app.

If you're using a different major version and want to migrate, please [open a ticket with VTEX Support](https://help.vtex.com/en/support) and request the installation of Edition app `vtex.edition-store@5.x`.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 [Grammar reviewer] reported by reviewdog 🐶
'Store's' is the correct possessive form, indicating that the postal code belongs to the store.

`RegionPopover` is a section that manages user location inputs. It's used when location data is missing or the store default postal code is applied. `RegionPopover` is available in [`@faststore/core`](https://developers.vtex.com/docs/guides/faststore/project-structure-overview#packagejson) and uses the [`Popover`](https://developers.vtex.com/docs/guides/faststore/molecules-popover) component as its UI base.

Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This solution continuously updates product availability throughout the buying jo

In this guide, you'll learn how to configure Delivery Promise in your FastStore project.

To understand how Delivery Promise works, see the guide [Delivery Promise (beta)](https://developers.vtex.com/docs/guides/faststore/delivery-promise-overview).
>ℹ To understand how Delivery Promise operates, see the [Understanding Delivery Promise operation](https://developers.vtex.com/docs/guides/faststore/delivery-promise-overview) guide. For more information about Delivery Promise components, see the [Working with Delivery Promise components](https://developers.vtex.com/docs/guides/faststore/delivery-promise-components) guide.

## Default settings

Expand All @@ -26,8 +26,8 @@ deliveryPromise: {
},
```

* `enabled`: When set to **true**, Delivery Promise is activated, allowing the store to provide delivery estimates based on user location.
* `mandatory`: When set to **false**, providing a postal code is optional for the user. Users can browse and add items to the cart without entering their postal code, though the accuracy of delivery information may be limited.
* `enabled`: When set to **true**, Delivery Promise activates, allowing the store to provide delivery estimates based on the user's location.
* `mandatory`: When set to **true**, users must provide a postal code. By default, this is **false**, allowing users to browse and add items to the cart without entering their postal code. However, without a postal code, the accuracy of delivery information may be limited.

## Before you begin

Expand All @@ -39,7 +39,7 @@ Check if you have version `0.5.0` or later of the [`search-session`](https://dev

1. In your terminal, run the `vtex list` command.
2. In the returned results, search for the app.
3. If you dont have this app installed, run the command `vtex install vtex.search-session`.
3. If you don't have this app installed, run the command `vtex install vtex.search-session`.

### Enable the VTEX Intelligent Search app

Expand All @@ -50,9 +50,9 @@ In your terminal, log in to your account by running `vtex login {accountName}` a
<details>
<summary>Accounts with `vtex.edition-store@5.x`</summary>

If your account is using the `vtex.edition-store@5.x` major, the VTEX Intelligent Search app is already included, and you need to integrate it via the VTEX Admin.
If your account is using the `vtex.edition-store@5.x` major version, the VTEX Intelligent Search app is already included, and you need to integrate it via VTEX Admin.

To integrate VTEX Intelligent Search, go to **Store Settings > Intelligent Search > Integrations** in the VTEX Admin, and click `START INTEGRATION`.
To integrate VTEX Intelligent Search, access **Store Settings > Intelligent Search > Integrations** in the VTEX Admin, and click `START INTEGRATION`.

</details>

Expand Down Expand Up @@ -339,4 +339,54 @@ To set a default postal code for your store, follow the steps below:
geoCoordinates: null,
person: null,
},
```
```
## Managing Delivery Promise filters and labels

Delivery Promise [filters](https://developers.vtex.com/docs/guides/faststore/delivery-promise-overview#filter-options) help shoppers narrow products by delivery/pickup availability for their location, while [badges](https://developers.vtex.com/docs/guides/faststore/delivery-promise-components) visually indicate shipping/pickup availability for the shopper's location when Delivery Promise data exists.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 [Grammar reviewer] reported by reviewdog 🐶
'Based on' is clearer and more precise than 'by' when describing the criteria for narrowing products.

Suggested change
Delivery Promise [filters](https://developers.vtex.com/docs/guides/faststore/delivery-promise-overview#filter-options) help shoppers narrow products by delivery/pickup availability for their location, while [badges](https://developers.vtex.com/docs/guides/faststore/delivery-promise-components) visually indicate shipping/pickup availability for the shopper's location when Delivery Promise data exists.
Delivery Promise [filters](https://developers.vtex.com/docs/guides/faststore/delivery-promise-overview#filter-options) help shoppers narrow products based on delivery/pickup availability for their location, while [badges](https://developers.vtex.com/docs/guides/faststore/delivery-promise-components) visually indicate shipping/pickup availability for the shopper's location when Delivery Promise data exists.


By default, filters and badges are active once Delivery Promise is enabled and implemented in the store. However, you can deactivate them (Global Filter by Pickup Point, [Delivery Option](https://newhelp.vtex.com/docs/tutorials/delivery-options-beta), and [Badges](https://developers.vtex.com/docs/guides/faststore/delivery-promise-overview#badges) and edit their labels in the Headless CMS. To do this, follow these steps.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[link-check] reported by reviewdog 🐶
🚨 Found a broken link in a Markdown Link (Error undefined):
https://newhelp.vtex.com/docs/tutorials/delivery-options-beta

👉 Please review this link before merging your Pull Request.


>ℹ️ For more details on filters and badges, see the [Working with Delivery Promise components](https://developers.vtex.com/docs/guides/faststore/delivery-promise-components) guide.

1. Access the VTEX Admin and go to **Storefront > Headless CMS**.
2. Click the **Global Sections** Content Type.
3. Click the **Settings** tab.
4. Go to the **Delivery Promise** section and change the labels and settings to suit your scenario.

![dp-managing-filter-and-badges-labels](https://vtexhelp.vtexassets.com/assets/docs/src/dp-managing-filter-labels___8ced78ce723693085b3d8baa857ff5a6.gif)

## Enabling the Availability (In-stock) filter

By default, the [Availability](https://developers.vtex.com/docs/guides/faststore/delivery-promise-overview#plp-or-search-page-filters) filter is disabled in the Headless CMS. To enable this feature, follow these steps:

### Setting up `hideUnavailableItems`

1. Open your FastStore project in the code editor of your choice.
2. Open the `discovery.config.js` file.
3. In the `hideUnavailableItems` property, change the value to `false`.

```discovery.config.js mark=6
...
api: {
storeId: "newstore",
workspace: "master",
environment: "vtexcommercestable",
hideUnavailableItems: false,
incrementAddress: false,
},
...
```

4. Create a new branch and open a pull request to deploy the change made in the `discovery.config.js` file to production.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 [Grammar reviewer] reported by reviewdog 🐶
Rephrased for conciseness and clarity. The original phrasing is slightly awkward.

Suggested change
4. Create a new branch and open a pull request to deploy the change made in the `discovery.config.js` file to production.
4. Create a new branch and open a pull request to deploy the change in the `discovery.config.js` file to production.


### Enabling the filter in the Headless CMS

After changing the `hideUnavailableItems` value to `false`, you can enable this filter in the Headless CMS.

1. Access VTEX Admin and go to **Storefront > Headless CMS**.
2. Click the **Global Sections** Content Type.
3. Click the **Settings** tab.
4. Go to the **Delivery Promise** section and check the field **Should display In Stock filter?**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 [Grammar reviewer] reported by reviewdog 🐶
'In-Stock' should be hyphenated when used as a compound adjective modifying 'filter.'

Suggested change
4. Go to the **Delivery Promise** section and check the field **Should display In Stock filter?**
4. Go to the **Delivery Promise** section and check the field **Should display In-Stock filter?**


![dp-availability-in-stock-filter](https://vtexhelp.vtexassets.com/assets/docs/src/dp-availability-filter___2fd389aefe66a4014d8bf9828ade58b1.png)

Loading
Loading