Menu
Feedback
Start here
Tutorials
Developer portal

Known Issues
Support Rules
Troubleshooting

Frequently Asked Questions
Announcements
News
Announcements
New feed filter allows for notifications related to any order atribute
Photo of the author
PedroAntunesCosta
Published on 5/20/2021
Last update on 5/28/2021

We have improved the orders feed and hook configuration options with a new type of filter which allows stores to get updates regarding any order attribute. For example, it is now possible to receive updates when an order is delivered or an item is changed, among other things.

What has changed?

Before, the feed and the hook tracked changes only in the orders’ status.

With the new configuration, any changes made to orders can be tracked. This is done through JSONata expressions set in the Orders API, which allow for highly customized filtering.

Why did we make this change?

Order filtering by status did not include events that were relevant for some integration. We realized that stores could benefit from receiving updates when orders were delivered or had items changed, for example.

Furthermore, this new configuration allows for a number of custom filter options in addition to the ones mentioned above. Since it uses JSONata expressions, you can combine filtering conditions and select specific subsets of orders that should generate events, for example.

What needs to be done?

Existing feed and hook configurations are not affected by this change. This new configuration is an alternative to the default filtering by status.

You can implement the new configuration by using the Feed v3 configuration or Hook configuration endpoints of the Order API. Learn more about how to configure this new filter in the Feed v3 guide.

If you need to test your JSONata filtering expressions, use our JSONata expressions API endpoint.

Was this helpful?
Yes
No
Suggest Edits (GitHub)
On this page
Still got questions?
Ask the community
Find solutions and share ideas in the VTEX community.
Join our community
Request support from VTEX
For personalized assistance, contact our experts.
Open a support ticket
GithubDeveloper portalCommunityFeedback