vtex.local – Promotions-

Tools (33)

Extracted live via the executor SDK.

• bundles.calculatediscountsandtaxesBundles

  Calculate discounts and taxes

• campaignAudiences.getcampaignaudiences

  Retrieves a list of all campaign audiences and their respective configurations.

• campaignAudiences.getcampaignconfiguration

  Retrieves a specific campaign audience configuration by its ID. This API uses the campaign ID, not the campaign name.

• campaignAudiences.setcampaignconfiguration

  Creates a new campaign audience.

• coupons.archivebycouponcode

  Archives a specifc coupon by its coupon code.

• coupons.getall

  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 Promotions and is organized by focusing on the developer's journey.

  Retrieves all coupons from an account.

• coupons.getarchivedbycouponcode

  Retrieves a specific archived coupon by its coupon code.

• coupons.getbycouponcode

  Retrieves a specific coupon by its coupon code.

• coupons.getusage

  Retrieves information about the coupon usage.

• coupons.massiveGeneration

  Generates a massive amount of coupons

• coupons.postApiRnbPvtCoupon

  Creates a single new coupon.

• coupons.postApiRnbPvtMultipleCoupons

  Creates multiple coupons with different coupon codes. This endpoint has a throttling of 60 requests per minute.

• coupons.unarchivebycouponcode

  Unarchives a specifc coupon by its coupon code.

• coupons.update

  Updates information of a specific coupon.

• notifications.usagenotification

  Usage notification

• pricesLegacyV1.deletebyskuId

  Delete all prices from an SKU.

  If your account is using Pricing v2, you should avoid using these routes. Please refer directly to the Pricing v2 API

  If you are still using Pricing v1, please check if your store is able to migrate to take advantage of many more features

• pricesLegacyV1.getallpaged

  Get all paged prices.

  If your account is using Pricing v2, you should avoid using these routes. Please refer directly to the Pricing v2 API

  If you are still using Pricing v1, please check if your store is able to migrate to take advantage of many more features

• pricesLegacyV1.pricebycontext

  Get price by context.

  If your account is using Pricing v2, you should avoid using these routes. Please refer directly to the Pricing v2 API

  If you are still using Pricing v1, please check if your store is able to migrate to take advantage of many more features

• pricesLegacyV1.pricebyskuId

  Price by SKU ID

  If your account is using Pricing v2, you should avoid using these routes. Please refer directly to the Pricing v2 API

• pricesLegacyV1.pricebyskuIdandtradePolicy

  Retrieve price by SKU ID and Trade Policy.

  If your account is using Pricing v2, you should avoid using these routes. Please refer directly to the Pricing v2 API

  If you are still using Pricing v1, please check if your store is able to migrate to take advantage of many more features

• pricesLegacyV1.saveprice

  Save price.

  If your account is using Pricing v2, you should avoid using these routes. Please refer directly to the Pricing v2 API

  If you are still using Pricing v1, please check if your store is able to migrate to take advantage of many more features

• promotionsAndTaxes.archivePromotion

  Archives a Promotion or Tax by its ID.

• promotionsAndTaxes.createOrUpdateCalculatorConfiguration

  Creates or updates a specific Promotion by its Promotion ID or a specific Tax by its Tax ID.

• promotionsAndTaxes.getAllBenefits

  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.

• promotionsAndTaxes.getAllTaxes

  Retrieves all taxes from an account.

• promotionsAndTaxes.getArchivedPromotions

  Lists all archived promotions.

• promotionsAndTaxes.getArchivedTaxes

  Lists all archived taxes.

• promotionsAndTaxes.getCalculatorConfigurationById

  Retrieves a specific promotion by its Promotion ID or a specific tax by its Tax ID.

• promotionsAndTaxes.postApiRnbPvtImportCalculatorConfiguration

  Creates a Multiple SKU Promotion. This scenario allows to create a single promotion for multiples SKUs with the Percentage Effect.

  ⚠️

  The limit of SKUs on a Multiple Effects promotion is 400.

• promotionsAndTaxes.putApiRnbPvtImportCalculatorConfigurationPromotionId

  Updates information from a Multiple SKU Promotion. This scenario allows to create a single promotion for multiples SKUs with the Percentage Effect.

  ⚠️

  The limit of SKUs on a Multiple Effects promotion is 400.

• promotionsAndTaxes.unarchivePromotion

  Unarchives a Promotion or Tax by its ID.

• openapi.previewSpec

  Preview an OpenAPI document before adding it as a source

• openapi.addSource

  Add an OpenAPI source and register its operations as tools