v50

latestOpenAPI 3.0.0raw.githubusercontent.com2025-09-22312710.8 KB

Promotions and taxes

Get all promotions

Retrieves all promotions from an account.

📘 Onboarding guide

Check the new Promotions onboarding guide. We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about the Promotions and is organized by focusing on the developer's journey.

Permissions

Any user or API key must have at least one of the appropriate License Manager resources to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint:

Product	Category	Resource
Rates and Benefits	Manage benefits and rates	GerenciarPromocoesETarifas

There are no applicable predefined roles for this resource list. You must create a custom role and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see Authentication overview.

❗ To prevent integrations from having excessive permissions, consider the best practices for managing API keys when assigning License Manager roles to integrations.

get/api/rnb/pvt/benefits/calculatorconfiguration

Headers

Content-Typestring required

Type of the content being sent.

Acceptstring required

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Response

disabledItemsstring[]

Disabled items.

archivedItemsstring[]

Archived items.

nominalDiscountTypestring

Controls the behavior of the NominalDiscount effect. This field only accepts two string values:

-item: applies the intended nominal discount on every item present on the cart.

-cart: keeps the behavior as it currently is: the whole order/cart receives a nominal discount that is distributed among the items.