---
title: "Get all promotions"
method: GET
path: "/api/rnb/pvt/benefits/calculatorconfiguration"
tags: ["Promotions and taxes"]
---

# Get all promotions

`GET /api/rnb/pvt/benefits/calculatorconfiguration`

Retrieves all promotions from an account. 

> 📘 Onboarding guide 
>
> Check the new [Promotions onboarding guide](https://developers.vtex.com/vtex-rest-api/docs/promotions-overview). 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](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) 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](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-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](https://developers.vtex.com/docs/guides/authentication).

>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.

## Headers

- `Content-Type` string, required
- `Accept` string, required

## Response `200`

OK

- object
  - `limitConfigurationMaxPrice` object — Limit configuration max price.
    - `activesCount` integer — Actives count.
    - `limit` integer — Limit.
  - `limitConfiguration` object — Limit configuration.
    - `activesCount` integer — Actives count.
    - `limit` integer — Limit.
  - `items` object[] — Array with information about a promotion.
    - `idCalculatorConfiguration` string — Promotion ID.
    - `lastModifiedUtc` string — Date and time when the promotion was last modified (UTC).
    - `name` string — Promotion Name.
    - `beginDate` string — Promotion Begin Date (UTC).
    - `endDate` string — Promotion End Date (UTC).
    - `isActive` boolean — If set as `true` the promotion is activated. If set as `false` the promotion is deactivated.
    - `description` string — Promotion internal description.
    - `type` string — Defines the type of promotion.
    - `utmSource` string — utmSource code.
    - `utmCampain` string — utmCampaign code.
    - `utmiCampaign` string — utmiCampaign code.
    - `status` string — Status of the promotion.
    - `percentualTax` number — Percentual tax applied.
    - `isArchived` boolean — If set as `true` the Promotion is archived. If set as `false` the Promotion is not archived.
    - `hasMaxPricePerItem` boolean — Defines if there is a maximum price per item.
    - `isTax` boolean — Defines if it is a tax.
    - `campaigns` string[] — Campaign Audiences that activate this promotion.
    - `activateGiftsMultiplier` boolean — If set as `true`, it activates gifts Multiplier.
    - `scope` object — Scope of the promotion.
      - `allCatalog` boolean — Determines if the promotion applies to all products in the Catalog (`true`) or not (`false`).
      - `skus` number — Quantity of SKUs which activate or deactivate the promotion.
      - `skusAreInclusive` boolean — If set to `true`, this promotion will be applied to any SKU present on the `skus` field. If set to `false`, SKUs present on that field will make this promotion not to be applied.
      - `products` number — Quantity of products which activate or deactivate the promotion.
      - `productsAreInclusive` boolean — If set to `true`, this promotion will be applied to any product present on the `products` field. If set to `false`, products present on that field will make this promotion not to be applied.
      - `collections` number — Quantity of collections which activate or deactivate the promotion.
      - `collectionsAreInclusive` boolean — If set to `true`, this promotion will be applied to any collection present on the `collections` field. If set to `false`, collections present on that field will make this promotion not to be applied.
      - `categories` number — Quantity of categories which activate or deactivate the promotion.
      - `categoriesAreInclusive` boolean — If set to `true`, this promotion will be applied to any category present on the `categories` field. If set to `false`, categories present on that field will make this promotion not to be applied.
      - `brands` number — Quantity of brands which activate or deactivate the promotion.
      - `brandsAreInclusive` boolean — If set to `true`, this promotion will be applied to any brand present on the `brands` field. If set to `false`, brands present on that field will make this promotion not to be applied.
      - `sellers` number — Quantity of sellers which activate or deactivate the promotion.
      - `sellersAreInclusive` boolean — If set to `true`, this promotion will be applied to any seller present on the `sellers` field. If set to `false`, sellers present on that field will make this promotion not to be applied.
    - `maxUsage` number — Defines how many times the promotion can be used.
    - `idsSalesChannel` string[] — List of Trade Policies that activate this promotion.
    - `areSalesChannelIdsExclusive` boolean — If set to `false`, this promotion will be applied to any trade policies present on the `idsSalesChannel` field. If set to `true`, trade policies present on that field will make this promotion not to be applied.
  - `disabledItems` string[] — Disabled items.
  - `archivedItems` string[] — Archived items.
  - `nominalDiscountType` string — 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.

---

[API](https://skmtc.net/vtex/apis/promotions-taxes-api.md) · [All operations](https://skmtc.net/vtex/apis/promotions-taxes-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vtex/promotions-taxes-api/revisions/6ad1b4bbb46f/schema)