Documentation
Feedback
Guides

Release Notes
Release Notes
Deprecated
Search API: Teasers field deprecation
July, 6

From September 2023, the Teasers field in Search API requests will be deprecated. While some VTEX stores may use this entity to create integrations, we recommend using the new PromotionTeasers field as it provides more straightforward information. We encourage all users to update their integrations accordingly to ensure a seamless transition.

What has changed?

We have already added the PromotionTeasers field to Search API endpoints. Currently, both fields coexist, and it is possible to view previously recorded information. From September 2023, VTEX will deprecate the Teasers field for all accounts and maintain PromotionTeasers only.

Before - "Teasers" example


_27
"Teasers": [
_27
{
_27
"<Name>k__BackingField": "AdditionalInfo",
_27
"<GeneralValues>k__BackingField": {
_27
"Team": "Flamengo",
_27
"Name": "Pedro",
_27
"Number": "9"
_27
},
_27
"<Conditions>k__BackingField": {
_27
"<MinimumQuantity>k__BackingField": 0,
_27
"<Parameters>k__BackingField": [
_27
{
_27
"<Name>k__BackingField": "PaymentMethodId",
_27
"<Value>k__BackingField": "4"
_27
}
_27
]
_27
},
_27
"<Effects>k__BackingField": {
_27
"<Parameters>k__BackingField": [
_27
{
_27
"<Name>k__BackingField": "PercentualDiscount",
_27
"<Value>k__BackingField": "1"
_27
}
_27
]
_27
}
_27
}
_27
]

After - "PromotionTeasers" example


_27
"PromotionTeasers": [
_27
{
_27
"Name": "AdditionalInfo",
_27
"GeneralValues": {
_27
"Team": "Flamengo",
_27
"Name": "Pedro",
_27
"Number": "9"
_27
},
_27
"Conditions": {
_27
"MinimumQuantity": 0,
_27
"Parameters": [
_27
{
_27
"Name": "PaymentMethodId",
_27
"Value": "4"
_27
}
_27
]
_27
},
_27
"Effects": {
_27
"Parameters": [
_27
{
_27
"Name": "PercentualDiscount",
_27
"Value": "1"
_27
}
_27
]
_27
}
_27
}
_27
]

What needs to be done?

If you have integrations that depend on the Teasers field, you must adapt your implementation to use PromotionTeasers instead as soon as possible. You can find more information about the new field in Search API reference.

Was this helpful?
Yes
No
On this page