{"openapi":"3.0.0","servers":[{"url":"https://vtex.local"},{"url":"https://{accountName}.{environment}.com.br","variables":{"accountName":{"default":"{accountName}","description":"Name of the VTEX account. Used as part of the URL"},"environment":{"default":"{environment}","description":"Environment to use. Used as part of the URL."}}}],"info":{"contact":{},"description":"\r\n> 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 Promotions and is organized by focusing on the developer's journey.\r\n\r\n The Promotions & Taxes API allows you to manage and retrieve all promotions, coupons and tax rules from your VTEX store.\r\n\r\n ## Index\r\n\r\n ### Coupons \r\n`POST` [Create multiple coupons](https://developers.vtex.com/vtex-rest-api/reference/post_api-rnb-pvt-multiple-coupons) \r\n`POST` [Create coupon](https://developers.vtex.com/vtex-rest-api/reference/post_api-rnb-pvt-coupon) \r\n`GET` [Get coupon by coupon code](https://developers.vtex.com/vtex-rest-api/reference/getbycouponcode) \r\n`GET` [Get archived coupon by coupon code](https://developers.vtex.com/vtex-rest-api/reference/getarchivedbycouponcode) \r\n`POST` [Archive coupon by coupon code](https://developers.vtex.com/vtex-rest-api/reference/archivebycouponcode) \r\n`POST` [Update coupon](https://developers.vtex.com/vtex-rest-api/reference/update) \r\n`GET` [Get all coupons](https://developers.vtex.com/vtex-rest-api/reference/getall) \r\n`POST` [Coupon Massive Generation](https://developers.vtex.com/vtex-rest-api/reference/massivegeneration) \r\n`GET` [Get coupon usage](https://developers.vtex.com/vtex-rest-api/reference/getusage) \r\n`POST` [Unarchive coupon by coupon code](https://developers.vtex.com/vtex-rest-api/reference/unarchivebycouponcode) \r\n\r\n### Promotions and Taxes \r\n`GET` [Get All Promotions](https://developers.vtex.com/vtex-rest-api/reference/getallbenefits) \r\n`GET` [Get All Taxes](https://developers.vtex.com/vtex-rest-api/reference/getalltaxes) \r\n`GET` [Get Promotion or Tax By ID](https://developers.vtex.com/vtex-rest-api/reference/getcalculatorconfigurationbyid) \r\n`POST` [Create or Update Promotion or Tax](https://developers.vtex.com/vtex-rest-api/reference/createorupdatecalculatorconfiguration) \r\n`POST` [Create Multiple SKU Promotion](https://developers.vtex.com/vtex-rest-api/reference/post_api-rnb-pvt-import-calculatorconfiguration) \r\n`PUT` [Update Multiple SKU Promotion](https://developers.vtex.com/vtex-rest-api/reference/put_api-rnb-pvt-import-calculatorconfiguration-promotionid) \r\n`POST` [Archive Promotion or Tax](https://developers.vtex.com/vtex-rest-api/reference/archivepromotion-1) \r\n`POST` [Unarchive Promotion or Tax](https://developers.vtex.com/vtex-rest-api/reference/unarchivepromotion-1) \r\n`GET` [List archived Promotions](https://developers.vtex.com/vtex-rest-api/reference/getarchivedpromotions) \r\n`GET` [List archived Taxes](https://developers.vtex.com/vtex-rest-api/reference/getarchivedtaxes) \r\n\r\n\r\n### Campaign Audiences \r\n`GET` [Get campaign audience configuration](https://developers.vtex.com/vtex-rest-api/reference/getcampaignconfiguration) \r\n`POST` [Create campaign audience](https://developers.vtex.com/vtex-rest-api/reference/setcampaignconfiguration)","title":"Promotions & Taxes API","version":"1.0","x-origin":[{"format":"openapi","url":"https://raw.githubusercontent.com/vtex/openapi-schemas/master/VTEX - Promotions & Taxes API.json","version":"3.0"}],"x-providerName":"vtex.local","x-serviceName":"Promotions-"},"security":[{"appKey":[],"appToken":[]}],"tags":[{"name":"Promotions and Taxes"},{"name":"Coupons"},{"name":"Campaign Audiences"},{"name":"Notifications"},{"name":"Bundles"},{"name":"Prices (Legacy - v1)"}],"paths":{"/api/rnb/pub/notifications":{"post":{"deprecated":false,"description":"Usage notification","operationId":"Usagenotification","parameters":[{"description":"Type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"example":{"accountId":"ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj","calculatorIds":["discount_basetestqa_1"],"coupon":"cupom","itemsCount":4,"orderId":"vbbbbbb-1","profileId":"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee","used":true},"schema":{"$ref":"#/components/schemas/UsagenotificationRequest"}}},"description":"","required":true},"responses":{"200":{"description":"OK"}},"servers":[{"url":"http://example.com/.{environment}.com.br/api/rnb","variables":{"environment":{"default":"exampleParameterValue"}}}],"summary":"Usage notification","tags":["Notifications"]}},"/api/rnb/pvt/archive/benefits/calculatorConfiguration":{"get":{"deprecated":false,"description":"Lists all archived promotions.","operationId":"GetArchivedPromotions","parameters":[{"description":"Type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"example":{"items":[{"Campaigns":[],"activateGiftsMultiplier":false,"areSalesChannelIdsExclusive":false,"beginDate":"2025-08-15T13:51:41.625Z","description":"","endDate":"2025-08-15T13:51:41.625Z","hasMaxPricePerItem":false,"idCalculatorConfiguration":"05558233-b415-4f2e-9822-ebdb3918623b","idsSalesChannel":[],"isActive":false,"isArchived":true,"isTax":false,"lastModifiedUtc":"2025-08-15T13:51:41.625Z","maxUsage":0,"name":"Promoção Progressiva","percentualTax":0,"scope":{"allCatalog":true,"brands":0,"brandsAreInclusive":true,"categories":0,"categoriesAreInclusive":true,"collections":0,"collectionsAreInclusive":true,"products":0,"productsAreInclusive":true,"sellers":0,"sellersAreInclusive":true,"skus":0,"skusAreInclusive":true},"status":"inactive","type":"progressive","utmCampain":"","utmSource":"","utmiCampaign":""}]},"schema":{"description":"Response object.","properties":{"items":{"$ref":"#/components/schemas/GetPromotions"}},"title":"","type":"object"}}},"description":"OK"}},"summary":"List Archived Promotions","tags":["Promotions and Taxes"]}},"/api/rnb/pvt/archive/calculatorConfiguration/{idCalculatorConfiguration}":{"post":{"description":"Archives a Promotion or Tax by its ID.","operationId":"ArchivePromotion","parameters":[{"description":"Type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"Promotion ID or tax ID.","in":"path","name":"idCalculatorConfiguration","required":true,"schema":{"example":"d8a1cd2e-b667-4054-b3ae-b79124c7218e","type":"string"},"style":"simple"}],"responses":{"204":{"description":"No Content"}},"summary":"Archive Promotion or Tax","tags":["Promotions and Taxes"]}},"/api/rnb/pvt/archive/coupon/{couponCode}":{"get":{"description":"Retrieves a specific archived coupon by its coupon code.","operationId":"Getarchivedbycouponcode","parameters":[{"description":"Describes the type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"Coupon Code","in":"path","name":"couponCode","required":true,"schema":{"example":"promo10","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"example":{"couponCode":"test","expirationIntervalPerUse":"00:00:00","isArchived":true,"lastModifiedUtc":"2025-08-15T13:51:41.625Z","maxItemsPerClient":10,"utmSource":"coupon3"},"schema":{"properties":{"couponCode":{"description":"Coupon code.","type":"string"},"expirationIntervalPerUse":{"description":"Coupon expiration interval per use.","type":"string"},"isArchived":{"description":"Defines if the coupon is archived (`true`) or not (`false`).","type":"boolean"},"lastModifiedUtc":{"description":"Date and time of the last update of the coupon in UTC format.","type":"string"},"maxItemsPerClient":{"description":"Maximum items per client that the coupon can be applied.","type":"integer"},"utmCampaign":{"description":"UTM campaign code.","type":"string"},"utmSource":{"description":"UTM source code.","type":"string"}},"title":"","type":"object"}}},"description":"OK"}},"summary":"Get archived coupon by coupon code","tags":["Coupons"]},"post":{"description":"Archives a specifc coupon by its coupon code.","operationId":"Archivebycouponcode","parameters":[{"description":"Describes the type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"Coupon Code","in":"path","name":"couponCode","required":true,"schema":{"example":"test","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"example":"promo10","schema":{"description":"Coupon code of the archived coupon.","title":"couponCode","type":"string"}}},"description":"OK"}},"summary":"Archive coupon by coupon code","tags":["Coupons"]}},"/api/rnb/pvt/archive/taxes/calculatorConfiguration":{"get":{"deprecated":false,"description":"Lists all archived taxes.","operationId":"GetArchivedTaxes","parameters":[{"description":"Type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"example":{"items":[{"Campaigns":[],"activateGiftsMultiplier":false,"areSalesChannelIdsExclusive":false,"beginDate":"2025-08-15T13:51:41.625Z","description":"My description","endDate":"2025-08-15T13:51:41.625Z","hasMaxPricePerItem":false,"idCalculatorConfiguration":"90f4affc-fea0-424c-a7a7-c69aec7bbdc8","idsSalesChannel":["1"],"isActive":false,"isArchived":true,"isTax":true,"lastModifiedUtc":"2025-08-15T13:51:41.625Z","maxUsage":0,"name":"Test Tax","percentualTax":10,"scope":{"allCatalog":false,"brands":1,"brandsAreInclusive":true,"categories":1,"categoriesAreInclusive":true,"collections":1,"collectionsAreInclusive":true,"products":1,"productsAreInclusive":true,"sellers":0,"sellersAreInclusive":false,"skus":1,"skusAreInclusive":true},"status":"inactive","type":"tax","utmCampain":"","utmSource":"","utmiCampaign":""}]},"schema":{"description":"Response object.","properties":{"items":{"$ref":"#/components/schemas/GetTaxes"}},"title":"","type":"object"}}},"description":"OK"}},"summary":"List Archived Taxes","tags":["Promotions and Taxes"]}},"/api/rnb/pvt/benefits/calculatorconfiguration":{"get":{"deprecated":false,"description":"Retrieves all promotions from an account. \r\n\r\n> 📘 Onboarding guide \r\n>\r\n> 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.\r\n\r\n","operationId":"GetAllBenefits","parameters":[{"description":"Type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"example":{"archivedItems":[],"disabledItems":[],"items":[{"Campaigns":[],"activateGiftsMultiplier":false,"areSalesChannelIdsExclusive":false,"beginDate":"2025-08-15T13:51:41.626Z","conditionsIds":["372e1868-2c0e-4437-be45-1ef8c9cab735"],"description":"Promotion for Social Seller","hasMaxPricePerItem":false,"idCalculatorConfiguration":"d8a1cd2e-b667-4054-b3ae-b79124c7218e","idsSalesChannel":[],"isActive":true,"isArchived":false,"isTax":false,"lastModifiedUtc":"2025-08-15T13:51:41.626Z","maxUsage":0,"name":"Promoção Social Seller","percentualTax":0,"scope":{"allCatalog":true,"brands":0,"brandsAreInclusive":false,"categories":0,"categoriesAreInclusive":false,"collections":0,"collectionsAreInclusive":false,"products":0,"productsAreInclusive":false,"sellers":0,"sellersAreInclusive":false,"skus":0,"skusAreInclusive":true},"status":"active","type":"regular","utmCampain":"georgeTest","utmSource":"georgeSource","utmiCampaign":""},{"Campaigns":[],"activateGiftsMultiplier":false,"areSalesChannelIdsExclusive":false,"beginDate":"2025-08-15T13:51:41.626Z","description":"","hasMaxPricePerItem":false,"idCalculatorConfiguration":"7c946926-7815-4446-9428-83bd577a9135","idsSalesChannel":[],"isActive":true,"isArchived":false,"isTax":false,"lastModifiedUtc":"2025-08-15T13:51:41.626Z","maxUsage":0,"name":"Progressive Discount","percentualTax":0,"scope":{"allCatalog":true,"brands":0,"brandsAreInclusive":true,"categories":0,"categoriesAreInclusive":true,"collections":0,"collectionsAreInclusive":true,"products":0,"productsAreInclusive":true,"sellers":0,"sellersAreInclusive":true,"skus":0,"skusAreInclusive":true},"status":"active","type":"progressive","utmCampain":"","utmSource":"","utmiCampaign":""}],"limitConfiguration":{"activesCount":4,"limit":100},"limitConfigurationMaxPrice":{"activesCount":0,"limit":10}},"schema":{"properties":{"archivedItems":{"description":"Archived items.","items":{"description":"Archived item.","type":"string"},"type":"array"},"disabledItems":{"description":"Disabled items.","items":{},"type":"array"},"items":{"$ref":"#/components/schemas/GetPromotions"},"limitConfiguration":{"description":"Limit configuration.","properties":{"activesCount":{"description":"Actives count.","type":"integer"},"limit":{"description":"Limit.","type":"integer"}},"type":"object"},"limitConfigurationMaxPrice":{"description":"Limit configuration max price.","properties":{"activesCount":{"description":"Actives count.","type":"integer"},"limit":{"description":"Limit.","type":"integer"}},"type":"object"}},"title":"","type":"object"}}},"description":"OK"}},"summary":"Get All Promotions","tags":["Promotions and Taxes"]}},"/api/rnb/pvt/calculatorconfiguration":{"post":{"deprecated":false,"description":"Creates or updates a specific Promotion by its Promotion ID or a specific Tax by its Tax ID.","operationId":"CreateOrUpdateCalculatorConfiguration","parameters":[{"description":"Type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"example":{"absoluteShippingDiscountValue":0,"accumulateWithManualPrice":false,"activateGiftsMultiplier":false,"activeDaysOfWeek":[],"affiliates":[],"applyToAllShippings":false,"areSalesChannelIdsExclusive":false,"beginDateUtc":"2025-08-15T13:51:41.626Z","brands":[],"brandsAreInclusive":false,"campaigns":[],"cardIssuers":[],"categories":[],"categoriesAreInclusive":false,"clusterExpressions":[],"collections":[],"collections1BuyTogether":[],"collections2BuyTogether":[],"collectionsIsInclusive":false,"compareListPriceAndPrice":false,"conditionsIds":["372e1868-2c0e-4437-be45-1ef8c9cab735"],"coupon":[],"cumulative":false,"daysAgoOfPurchases":0,"description":"Promotion for Social Seller","disableDeal":false,"discountType":"percentual","enableBuyTogetherPerSku":false,"firstBuyIsProfileOptimistic":false,"giftListTypes":[],"idCalculatorConfiguration":"d8a1cd2e-b667-4054-b3ae-b79124c7218e","idSellerIsInclusive":false,"idsSalesChannel":[],"installment":0,"isActive":true,"isArchived":false,"isDifferentListPriceAndPrice":false,"isFeatured":false,"isFirstBuy":false,"isMinMaxInstallments":false,"isSlaSelected":false,"itemMaxPrice":0,"itemMinPrice":0,"lastModified":"2025-08-15T13:51:41.626Z","listSku1BuyTogether":[],"listSku2BuyTogether":[],"marketingTags":[],"marketingTagsAreNotInclusive":false,"maxInstallment":0,"maxNumberOfAffectedItems":0,"maxNumberOfAffectedItemsGroupKey":"perCart","maxPricesPerItems":[],"maxUsage":0,"maxUsagePerClient":0,"maximumUnitPriceDiscount":0,"merchants":[],"minInstallment":0,"minimumQuantityBuyTogether":0,"multipleUsePerClient":false,"name":"Promoção Social Seller","newOffset":-3,"nominalDiscountValue":0,"nominalRewardValue":0,"nominalShippingDiscountValue":0,"nominalTax":0,"offset":-3,"orderStatusRewardValue":"invoiced","origin":"marketplace","paymentsMethods":[],"paymentsRules":[],"percentualDiscountValue":10,"percentualDiscountValueList":[],"percentualDiscountValueList1":0,"percentualDiscountValueList2":0,"percentualRewardValue":0,"percentualShippingDiscountValue":0,"percentualTax":0,"products":[],"productsAreInclusive":false,"productsSpecifications":[],"quantityToAffectBuyTogether":0,"rebatePercentualDiscountValue":0,"restrictionsBins":[],"shippingPercentualTax":0,"shouldDistributeDiscountAmongMatchedItems":false,"skus":[],"skusAreInclusive":true,"skusGift":{"quantitySelectable":0},"slasIds":[],"stores":[],"storesAreInclusive":false,"totalValueCeling":0,"totalValueFloor":0,"totalValueIncludeAllItems":false,"totalValueMode":"IncludeMatchedItems","totalValuePurchase":0,"type":"regular","useNewProgressiveAlgorithm":false,"utmCampaign":"georgeTest","utmSource":"georgeSource","zipCodeRanges":[]},"schema":{"properties":{"absoluteShippingDiscountValue":{"description":"Maximum shipping value.","example":0,"type":"number"},"accumulateWithManualPrice":{"description":"Allows the promotion to apply to products whose prices have been manually added by a call-center operator.","example":false,"type":"boolean"},"activateGiftsMultiplier":{"description":"If set as `true`, it activates gifts Multiplier.","example":false,"type":"boolean"},"activeDaysOfWeek":{"description":"Defines which days of the week the Promotion or Tax will applied.","items":{"description":"Day of the week that the Promotion or Tax will be valid.","example":"Monday","type":"string"},"type":"array"},"affiliates":{"description":"Marketplace order identifier. The discount will apply to selected affiliates.","items":{"description":"Object with information of the affiliate.","properties":{"id":{"description":"Affiliate ID.","example":"1","type":"string"},"name":{"description":"Affiliate Name.","example":"Amazon","type":"string"}},"type":"object"},"type":"array"},"applyToAllShippings":{"description":"Promotion or Tax will be applied to all kind of shipping.","example":false,"type":"boolean"},"areSalesChannelIdsExclusive":{"description":"If set to `false`, this Promotion or Tax 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 or Tax not to be applied.","example":false,"type":"boolean"},"beginDateUtc":{"description":"Promotion or Tax Begin Date (UTC).","example":"2025-08-15T13:51:41.626Z","type":"string"},"brands":{"description":"Object composed by the brands that will activate or deactivate the Promotion or Tax.","items":{"description":"Object with information of the brand.","properties":{"id":{"description":"Brand ID.","example":"1","type":"string"},"name":{"description":"Brand Name.","example":"Brand (1)","type":"string"}},"type":"object"},"type":"array"},"brandsAreInclusive":{"description":"If set to `true`, this Promotion or Tax will be applied to any brand present on the `brands` field. If set to `false`, brands present on that field will make this Promotion or Tax not to be applied.","example":true,"type":"boolean"},"campaigns":{"description":"Campaign Audiences that activate this Promotion or Tax.","example":["Campaign Audience test"],"items":{},"type":"array"},"cardIssuers":{"deprecated":true,"items":{},"type":"array"},"categories":{"description":"Object composed by the categories that will activate or deactivate the Promotion or Tax.","items":{"description":"Object with information of the category.","properties":{"id":{"description":"Category ID.","example":"1","type":"string"},"name":{"description":"Category Name.","example":"Vinhos Tintos (1)","type":"string"}},"type":"object"},"type":"array"},"categoriesAreInclusive":{"description":"If set to `true`, this Promotion or Tax will be applied to any category present on the `categories` field. If set to `false`, categories present on that field will make this Promotion or Tax not to be applied.","example":true,"type":"boolean"},"clusterExpressions":{"description":"An expression to use with clusters.","items":{"description":"Cluster expression.","example":"birthday=true","type":"string"},"type":"array"},"collections":{"description":"Object composed by the collections that will activate or deactivate the Promotion or Tax.","items":{"description":"Object with information of the collection.","properties":{"id":{"description":"Collection ID.","example":"1","type":"string"},"name":{"description":"Collection Name.","example":"Collection (1)","type":"string"}},"type":"object"},"type":"array"},"collections1BuyTogether":{"description":"Collections that will generate the Promotion, type **Buy Together**, **More for less**, **Progressive Discount**, **Buy One Get One**.","items":{"description":"Collection ID.","example":"1","type":"string"},"type":"array"},"collections2BuyTogether":{"deprecated":true,"items":{},"type":"array"},"collectionsIsInclusive":{"description":"If set to `true`, this Promotion or Tax will be applied to any collection present on the `collections` field. If set to `false`, collections present on that field will make this Promotion or Tax not to be applied.","example":false,"type":"boolean"},"compareListPriceAndPrice":{"description":"If the **List Price** and **Price** are the same.","example":false,"type":"boolean"},"conditionsIds":{"description":"Array with conditions IDs.","items":{"description":"Condition ID.","example":"1","type":"string"},"type":"array"},"coupon":{"deprecated":true,"items":{},"type":"array"},"cumulative":{"description":"Defines if a Promotion or Tax can accumulate with another one. (`true`) or not (`false`).","example":false,"type":"boolean"},"daysAgoOfPurchases":{"description":"Number of days that are considered to add the purchase history.","example":0,"type":"integer"},"description":{"description":"Internal description of the Promotion or Tax.","example":"Description of the promotion.","type":"string"},"disableDeal":{"deprecated":true,"type":"boolean"},"discountType":{"description":"The type of discount that will apply to the promotion.","example":"percentual","type":"string"},"enableBuyTogetherPerSku":{"description":"Enable **Buy Together** per SKU.","example":false,"type":"boolean"},"endDateUtc":{"description":"Promotion or Tax End Date (UTC).","example":"2025-08-15T13:51:41.626Z","type":"string"},"firstBuyIsProfileOptimistic":{"description":"Applies the discount even if the user is not logged.","example":false,"type":"boolean"},"giftListTypes":{"description":"Gifts List Type.","items":{"description":"Gift List Type.","example":"Gift SKU","type":"string"},"type":"array"},"idCalculatorConfiguration":{"description":"Promotion ID or Tax ID.","example":"ba087fa9-8587-44b3-8ef1-ade8d053e9e9","type":"string"},"idSeller":{"description":"Seller Name.","example":"1","type":"string"},"idSellerIsInclusive":{"description":"If set to `true`, this Promotion or Tax will be applied to any seller present on the `idSeller` field. If set to `false`, sellers present on that field will make this Promotion or Tax not to be applied.","example":false,"type":"boolean"},"idsSalesChannel":{"description":"List of Trade Policies that activate this Promotion or Tax.","items":{"description":"Trade Policy ID.","example":"Principal","type":"string"},"type":"array"},"installment":{"deprecated":true,"type":"integer"},"isActive":{"description":"If set as `true` the Promotion or Tax is activated. If set as `false` the Promotion or Tax is deactivated.","example":true,"type":"boolean"},"isArchived":{"description":"If set as `true` the Promotion or Tax is archived. If set as `false` the Promotion or Tax is not archived.","example":false,"type":"boolean"},"isDifferentListPriceAndPrice":{"description":"Applies the Promotion or Tax only if the list price and price is different.","example":false,"type":"boolean"},"isFeatured":{"description":"Insert a flag with the promotion name used in the product's window display and page.","example":true,"type":"boolean"},"isFirstBuy":{"description":"Applies the discount only if it's a first buy.","example":false,"type":"boolean"},"isMinMaxInstallments":{"description":"Set if the Promotion or Tax will be applied considering a minimum and maximum values for installments.","example":false,"type":"boolean"},"isSlaSelected":{"description":"Applies selected discount only when one of the defined shipping method is selected by the customer.","example":false,"type":"boolean"},"itemMaxPrice":{"description":"Maximum price of the item.","example":0,"type":"number"},"itemMinPrice":{"description":"Minimum price of the item.","example":0,"type":"number"},"lastModified":{"description":"Date when the Promotion or Tax was last modified.","example":"2025-08-15T13:51:41.626Z","type":"string"},"listSku1BuyTogether":{"description":"SKU first list for the promotion **Buy Together**.","example":["SKU"],"items":{},"type":"array"},"listSku2BuyTogether":{"description":"SKU second list for the promotion **Buy Together**.","example":["SKU"],"items":{},"type":"array"},"marketingTags":{"description":"Promotion or Tax Marketing tags.","items":{"description":"Promotion or Tax Marketing tag.","example":"MKT1","type":"string"},"type":"array"},"marketingTagsAreNotInclusive":{"description":"If set to `false`, this Promotion or Tax will be applied to any marketing tag present on the `marketingTags` field. If set to `true`, marketing tags present on that field will make this Promotion or Tax not to be applied.","example":false,"type":"boolean"},"maxInstallment":{"description":"Maximum value for installment.","example":0,"type":"integer"},"maxNumberOfAffectedItems":{"description":"The maximum number of affected items for a promotion.","example":0,"type":"integer"},"maxNumberOfAffectedItemsGroupKey":{"description":"The maximum number of affected items by group key for a promotion.","example":"perCart","type":"string"},"maxPricesPerItems":{"deprecated":true,"items":{},"type":"array"},"maxUsage":{"description":"Defines how many times the Promotion or Tax can be used.","example":0,"type":"integer"},"maxUsagePerClient":{"description":"Defines if the promotion can be used multiple times per client.","example":0,"type":"integer"},"maximumUnitPriceDiscount":{"description":"The maximum price for each item of the purchase will be the price set up.","example":0,"type":"number"},"merchants":{"deprecated":true,"items":{},"type":"array"},"minInstallment":{"description":"Minimum value for installment.","example":0,"type":"integer"},"minimumQuantityBuyTogether":{"description":"Minimum quantity for **Buy Together** promotion.","example":0,"type":"integer"},"multipleUsePerClient":{"description":"Defines if the promotion can be used multiple times per client.","example":false,"type":"boolean"},"name":{"description":"Promotion name or Tax name.","example":"Promoção Social Seller","type":"string"},"newOffset":{"description":"New time offset from UTC in seconds.","example":-3,"type":"number"},"nominalDiscountValue":{"description":"Exact discount to be applied for the total purchase value.","example":0,"type":"number"},"nominalRewardValue":{"description":"Nominal value for rewards program.","example":0,"type":"number"},"nominalShippingDiscountValue":{"description":"Exact discount to be applied for the shipping value.","example":0,"type":"number"},"nominalTax":{"description":"Nominal Tax.","example":0,"type":"number"},"offset":{"description":"Time offset from UTC in seconds.","example":-3,"type":"integer"},"orderStatusRewardValue":{"description":"Order status reward value.","example":"invoiced","type":"string"},"origin":{"description":"Origin of the Promotion or Tax, `marketplace` or `Fulfillment`.  Read [Difference between orders with marketplace and fulfillment sources](https://help.vtex.com/en/tutorial/what-are-orders-with-marketplace-source-and-orders-with-fulfillment-source--6eVYrmUAwMOeKICU2KuG06) for more information.","example":"marketplace","type":"string"},"paymentsMethods":{"description":"Array composed by all the Payments Methods that activate this Promotion or Tax.","items":{"description":"Object with information of the Payment Method.","properties":{"id":{"description":"Payment Method ID.","example":"2","type":"string"},"name":{"description":"Payment Method Name.","example":"Visa (2)","type":"string"}},"type":"object"},"type":"array"},"paymentsRules":{"deprecated":true,"items":{},"type":"array"},"percentualDiscountValue":{"description":"Percentage discount to be applied for total purchase value.","example":10,"type":"number"},"percentualDiscountValueList":{"description":"Percentual discount value list.","items":{"description":"Percentual discount value.","example":10,"type":"number"},"type":"array"},"percentualDiscountValueList1":{"description":"Valid discounts for the SKUs in `listSku1BuyTogether`, discount list used for Buy Together Promotions.","example":0,"type":"number"},"percentualDiscountValueList2":{"description":"Equivalent to `percentualDiscountValueList1`.","example":0,"type":"number"},"percentualRewardValue":{"description":"Percentage value for rewards program.","example":0,"type":"number"},"percentualShippingDiscountValue":{"description":"Percentage discount to be applied for shipping value.","example":0,"type":"number"},"percentualTax":{"description":"Percentual Tax over purchase total value.","example":0,"type":"number"},"products":{"description":"Object composed by the products that will activate or deactivate the Promotion or Tax.","items":{"description":"Object with information of the product.","properties":{"id":{"description":"Product ID.","example":"1","type":"string"},"name":{"description":"Product Name.","example":"Vinho (1)","type":"string"}},"type":"object"},"type":"array"},"productsAreInclusive":{"description":"If set to `true`, this Promotion or Tax will be applied to any product present on the `products` field. If set to `false`, products present on that field will make this Promotion or Tax not to be applied.","example":true,"type":"boolean"},"productsSpecifications":{"deprecated":true,"items":{},"type":"array"},"quantityToAffectBuyTogether":{"description":"Quantity to affect **Buy Together** promotion.","example":0,"type":"integer"},"rebatePercentualDiscountValue":{"description":"Percentual Shipping Discount Value.","example":0,"type":"number"},"restrictionsBins":{"description":"The discount will be granted if the card's BIN is given.","items":{"description":"Card's BIN.","example":"1234","type":"string"},"type":"array"},"shippingPercentualTax":{"description":"Shipping Percentual Tax over purchase total value.","example":0,"type":"number"},"shouldDistributeDiscountAmongMatchedItems":{"description":"Should distribute discount among matched items.","example":false,"type":"boolean"},"skus":{"description":"Object composed by the SKUs that will activate or deactivate the Promotion or Tax.","items":{"description":"Object with information of the SKU.","properties":{"id":{"description":"SKU ID.","example":"1","type":"string"},"name":{"description":"SKU Name.","example":"Vinho tinto (1)","type":"string"}},"type":"object"},"type":"array"},"skusAreInclusive":{"description":"If set to `true`, this Promotion or Tax will be applied to any SKU present on the `skus` field. If set to `false`, SKUs present on that field will make this Promotion or Tax not to be applied.","example":true,"type":"boolean"},"skusGift":{"description":"SKU Gift Object. Total discount on the product value set as a gift.","properties":{"gifts":{"description":"Array with SKU Gifts IDs.","example":["SKU"],"items":{},"type":"array"},"quantitySelectable":{"description":"Quantity of SKU Gifts.","example":0,"type":"integer"}},"type":"object"},"slasIds":{"description":"The discount will be granted if the shipping method is the same as the one given.","items":{"description":"Shipping method.","example":"Express","type":"string"},"type":"array"},"stores":{"deprecated":true,"items":{},"type":"array"},"storesAreInclusive":{"deprecated":true,"type":"boolean"},"totalValueCeling":{"description":"Maximum chart value to activate the Promotion or Tax.","example":0,"type":"number"},"totalValueFloor":{"description":"Minimum chart value to activate the Promotion or Tax.","example":0,"type":"number"},"totalValueIncludeAllItems":{"deprecated":true,"type":"boolean"},"totalValueMode":{"description":"Defines if products that already are receiving a promotion will be considered on the chart total value. There are three options available: `IncludeMatchedItems`, `ExcludeMatchedItems`, `AllItems`.","example":"IncludeMatchedItems","type":"string"},"totalValuePurchase":{"description":"Total value a client must have in past orders to activate the Promotion or Tax.","example":0,"type":"number"},"type":{"description":"Defines what is the type of the promotion or indicates if it is a tax. Possible values: `regular` ([Regular Promotion](https://help.vtex.com/tutorial/regular-promotion--tutorials_327)), `combo` ([Buy Together](https://help.vtex.com/en/tutorial/buy-together--tutorials_323)), `forThePriceOf` ([More for Less](https://help.vtex.com/en/tutorial/creating-a-more-for-less-promotion--tutorials_325)), `progressive` ([Progressive Discount](https://help.vtex.com/en/tutorial/progressive-discount--tutorials_324)), `buyAndWin` ([Buy One Get One](https://help.vtex.com/en/tutorial/buy-one-get-one--tutorials_322)), `maxPricePerItem` (Deprecated), `campaign` ([Campaign Promotion](https://help.vtex.com/en/tutorial/campaign-promotion--1ChYXhK2AQGuS6wAqS8Ume)), `tax` (Tax), `multipleEffects` (Multiple Effects).","example":"regular","type":"string"},"useNewProgressiveAlgorithm":{"description":"Use new progressive algorithm.","example":false,"type":"boolean"},"utmCampaign":{"description":"Coupon utmCampaign code.","example":"testSource","type":"string"},"utmSource":{"description":"Coupon utmSource code.","example":"testSource","type":"string"},"zipCodeRanges":{"description":"Range of the zip code that applies the promotion.","items":{"description":"Zip code that applies the promotion.","properties":{"inclusive":{"description":"Defines if the zip code applies the promotion.","example":false,"type":"boolean"}},"type":"object"},"type":"array"}},"type":"object"}}},"description":"","required":true},"responses":{"200":{"content":{"application/json":{"example":{"absoluteShippingDiscountValue":0,"accumulateWithManualPrice":false,"activateGiftsMultiplier":false,"activeDaysOfWeek":[],"affiliates":[],"applyToAllShippings":false,"areSalesChannelIdsExclusive":false,"beginDateUtc":"2025-08-15T13:51:41.626Z","brands":[],"brandsAreInclusive":false,"campaigns":[],"cardIssuers":[],"categories":[],"categoriesAreInclusive":false,"clusterExpressions":[],"collections":[],"collections1BuyTogether":[],"collections2BuyTogether":[],"collectionsIsInclusive":false,"compareListPriceAndPrice":false,"conditionsIds":["372e1868-2c0e-4437-be45-1ef8c9cab735"],"coupon":[],"cumulative":false,"daysAgoOfPurchases":0,"disableDeal":false,"discountType":"percentual","enableBuyTogetherPerSku":false,"firstBuyIsProfileOptimistic":false,"giftListTypes":[],"idCalculatorConfiguration":"d8a1cd2e-b667-4054-b3ae-b79124c7218e","idSellerIsInclusive":false,"idsSalesChannel":[],"installment":0,"isActive":true,"isArchived":false,"isDifferentListPriceAndPrice":false,"isFeatured":false,"isFirstBuy":false,"isMinMaxInstallments":false,"isSlaSelected":false,"itemMaxPrice":0,"itemMinPrice":0,"lastModified":"2025-08-15T13:51:41.626Z","listSku1BuyTogether":[],"listSku2BuyTogether":[],"marketingTags":[],"marketingTagsAreNotInclusive":false,"maxInstallment":0,"maxNumberOfAffectedItems":0,"maxNumberOfAffectedItemsGroupKey":"perCart","maxPricesPerItems":[],"maxUsage":0,"maxUsagePerClient":0,"maximumUnitPriceDiscount":0,"merchants":[],"minInstallment":0,"minimumQuantityBuyTogether":0,"multipleUsePerClient":false,"name":"Promoção Social Seller","newOffset":-3,"nominalDiscountValue":0,"nominalRewardValue":0,"nominalShippingDiscountValue":0,"nominalTax":0,"offset":-3,"orderStatusRewardValue":"invoiced","origin":"marketplace","paymentsMethods":[{"id":"202","name":"Dinheiro (202)"},{"id":"2","name":"Visa (2)"}],"paymentsRules":[],"percentualDiscountValue":10,"percentualDiscountValueList":[],"percentualDiscountValueList1":0,"percentualDiscountValueList2":0,"percentualRewardValue":0,"percentualShippingDiscountValue":0,"percentualTax":0,"products":[],"productsAreInclusive":false,"productsSpecifications":[],"quantityToAffectBuyTogether":0,"rebatePercentualDiscountValue":0,"restrictionsBins":[],"shippingPercentualTax":0,"shouldDistributeDiscountAmongMatchedItems":false,"skus":[],"skusAreInclusive":true,"skusGift":{"quantitySelectable":0},"slasIds":[],"stores":[],"storesAreInclusive":false,"totalValueCeling":0,"totalValueFloor":0,"totalValueIncludeAllItems":false,"totalValueMode":"IncludeMatchedItems","totalValuePurchase":0,"type":"regular","useNewProgressiveAlgorithm":false,"utmCampaign":"georgeTest","utmSource":"georgeSource","zipCodeRanges":[]},"schema":{"properties":{"absoluteShippingDiscountValue":{"description":"Maximum shipping value.","type":"number"},"accumulateWithManualPrice":{"description":"Allows the promotion to apply to products whose prices have been manually added by a call-center operator.","type":"boolean"},"activateGiftsMultiplier":{"description":"If set as `true`, it activates gifts Multiplier.","type":"boolean"},"activeDaysOfWeek":{"description":"Defines which days of the week the promotion will applied.","items":{"description":"Day of the week that the promotion will be valid.","type":"string"},"type":"array"},"affiliates":{"description":"Marketplace order identifier. The discount will apply to selected affiliates.","items":{"description":"Object with information of the affiliate.","properties":{"id":{"description":"Affiliate ID.","type":"string"},"name":{"description":"Affiliate Name.","type":"string"}},"type":"object"},"type":"array"},"applyToAllShippings":{"description":"Promotion will be applied to all kind of shipping.","type":"boolean"},"areSalesChannelIdsExclusive":{"description":"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.","type":"boolean"},"beginDateUtc":{"description":"Promotion Begin Date (UTC).","type":"string"},"brands":{"description":"Object composed by the brands that will activate or deactivate the promotion.","items":{"description":"Object with information of the brand.","properties":{"id":{"description":"Brand ID.","type":"string"},"name":{"description":"Brand Name.","type":"string"}},"type":"object"},"type":"array"},"brandsAreInclusive":{"description":"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.","type":"boolean"},"campaigns":{"description":"Campaign Audiences that activate this promotion.","items":{},"type":"array"},"cardIssuers":{"deprecated":true,"items":{},"type":"array"},"categories":{"description":"Object composed by the categories that will activate or deactivate the promotion.","items":{"description":"Object with information of the category.","properties":{"id":{"description":"Category ID.","type":"string"},"name":{"description":"Category Name.","type":"string"}},"type":"object"},"type":"array"},"categoriesAreInclusive":{"description":"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.","type":"boolean"},"clusterExpressions":{"description":"An expression to use with clusters.","items":{"description":"Cluster expression.","type":"string"},"type":"array"},"collections":{"description":"Object composed by the collections that will activate or deactivate the promotion.","items":{"description":"Object with information of the collection.","properties":{"id":{"description":"Collection ID.","type":"string"},"name":{"description":"Collection Name.","type":"string"}},"type":"object"},"type":"array"},"collections1BuyTogether":{"description":"Collections that will generate the promotion, type **Buy Together**, **More for less**, **Progressive Discount**, **Buy One Get One**.","items":{"description":"Collection ID.","type":"string"},"type":"array"},"collections2BuyTogether":{"deprecated":true,"items":{},"type":"array"},"collectionsIsInclusive":{"description":"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.","type":"boolean"},"compareListPriceAndPrice":{"description":"If the **List Price** and **Price** are the same.","type":"boolean"},"conditionsIds":{"description":"Array with conditions IDs.","items":{"description":"Condition ID.","type":"string"},"type":"array"},"coupon":{"deprecated":true,"items":{},"type":"array"},"cumulative":{"description":"Defines if a promotion can accumulate with another one. (`true`) or not (`false`).","type":"boolean"},"daysAgoOfPurchases":{"description":"Number of days that are considered to add the purchase history.","type":"integer"},"description":{"description":"Promotion internal description.","type":"string"},"disableDeal":{"deprecated":true,"type":"boolean"},"discountType":{"description":"The type of discount that will apply to the promotion.","type":"string"},"enableBuyTogetherPerSku":{"description":"Enable **Buy Together** per SKU.","type":"boolean"},"endDateUtc":{"description":"Promotion End Date (UTC).","type":"string"},"firstBuyIsProfileOptimistic":{"description":"Applies the discount even if the user is not logged.","type":"boolean"},"giftListTypes":{"description":"Gifts List Type.","items":{"description":"Gift List Type.","type":"string"},"type":"array"},"idCalculatorConfiguration":{"description":"Promotion ID.","type":"string"},"idSeller":{"description":"Seller Name.","type":"string"},"idSellerIsInclusive":{"description":"If set to `true`, this promotion will be applied to any seller present on the `idSeller` field. If set to `false`, sellers present on that field will make this promotion not to be applied.","type":"boolean"},"idsSalesChannel":{"description":"List of Trade Policies that activate this promotion.","items":{"description":"Trade Policy ID.","type":"string"},"type":"array"},"installment":{"deprecated":true,"type":"integer"},"isActive":{"description":"If set as `true` the Promotion is activated. If set as `false` the Promotion is deactivated.","type":"boolean"},"isArchived":{"description":"If set as `true` the Promotion is archived. If set as `false` the Promotion is not archived.","type":"boolean"},"isDifferentListPriceAndPrice":{"description":"Applies the promotion only if the list price and price is different.","type":"boolean"},"isFeatured":{"description":"Insert a flag with the promotion name used in the product's window display and page.","type":"boolean"},"isFirstBuy":{"description":"Applies the discount only if it's a first buy.","type":"boolean"},"isMinMaxInstallments":{"description":"Set if the promotion will be applied considering a minimum and maximum values for installments.","type":"boolean"},"isSlaSelected":{"description":"Applies selected discount only when one of the defined shipping method is selected by the customer.","type":"boolean"},"itemMaxPrice":{"description":"Maximum price of the item.","type":"number"},"itemMinPrice":{"description":"Minimum price of the item.","type":"number"},"lastModified":{"description":"When the Promotion was last modified.","type":"string"},"listSku1BuyTogether":{"description":"SKU first list for the promotion **Buy Together**.","items":{},"type":"array"},"listSku2BuyTogether":{"description":"SKU second list for the promotion **Buy Together**.","items":{},"type":"array"},"marketingTags":{"description":"Promotion Marketing tags.","items":{"description":"Promotion Marketing tag.","type":"string"},"type":"array"},"marketingTagsAreNotInclusive":{"description":"If set to `false`, this promotion will be applied to any marketing tag present on the `marketingTags` field. If set to `true`, marketing tags present on that field will make this promotion not to be applied.","type":"boolean"},"maxInstallment":{"description":"Maximum value for installment.","type":"integer"},"maxNumberOfAffectedItems":{"description":"The maximum number of affected items for a promotion.","type":"integer"},"maxNumberOfAffectedItemsGroupKey":{"description":"The maximum number of affected items by group key for a promotion.","type":"string"},"maxPricesPerItems":{"deprecated":true,"items":{},"type":"array"},"maxUsage":{"description":"Defines how many times the promotion can be used.","type":"integer"},"maxUsagePerClient":{"description":"Defines if the promotion can be used multiple times per client.","type":"integer"},"maximumUnitPriceDiscount":{"description":"The maximum price for each item of the purchase will be the price set up.","type":"number"},"merchants":{"deprecated":true,"items":{},"type":"array"},"minInstallment":{"description":"Minimum value for installment.","type":"integer"},"minimumQuantityBuyTogether":{"description":"Minimum quantity for **Buy Together** promotion.","type":"integer"},"multipleUsePerClient":{"description":"Defines if the promotion can be used multiple times per client.","type":"boolean"},"name":{"description":"Promotion Name.","type":"string"},"newOffset":{"description":"New time offset from UTC in seconds.","type":"number"},"nominalDiscountValue":{"description":"Exact discount to be applied for the total purchase value.","type":"number"},"nominalRewardValue":{"description":"Nominal value for rewards program.","type":"number"},"nominalShippingDiscountValue":{"description":"Exact discount to be applied for the shipping value.","type":"number"},"nominalTax":{"description":"Nominal Tax.","type":"number"},"offset":{"description":"Time offset from UTC in seconds.","type":"integer"},"orderStatusRewardValue":{"description":"Order status reward value.","type":"string"},"origin":{"description":"Origin of the promotion, `marketplace` or `Fulfillment`.  Read [Difference between orders with marketplace and fulfillment sources](https://help.vtex.com/en/tutorial/what-are-orders-with-marketplace-source-and-orders-with-fulfillment-source--6eVYrmUAwMOeKICU2KuG06) for more information.","type":"string"},"paymentsMethods":{"description":"Array composed by all the Payments Methods.","items":{"description":"Object with information of the Payment Method.","properties":{"id":{"description":"Payment Method ID.","type":"string"},"name":{"description":"Payment Method Name.","type":"string"}},"type":"object"},"type":"array"},"paymentsRules":{"deprecated":true,"items":{},"type":"array"},"percentualDiscountValue":{"description":"Percentage discount to be applied for total purchase value.","type":"number"},"percentualDiscountValueList":{"description":"Percentual discount value list.","items":{"description":"Percentual discount value.","type":"number"},"type":"array"},"percentualDiscountValueList1":{"description":"Valid discounts for the SKUs in `listSku1BuyTogether`, discount list used for Buy Together Promotions.","type":"number"},"percentualDiscountValueList2":{"description":"Equivalent to `percentualDiscountValueList1`.","type":"number"},"percentualRewardValue":{"description":"Percentage value for rewards program.","type":"number"},"percentualShippingDiscountValue":{"description":"Percentage discount to be applied for shipping value.","type":"number"},"percentualTax":{"description":"Percentual Tax over purchase total value.","type":"number"},"products":{"description":"Object composed by the products that will activate or deactivate the promotion.","items":{"description":"Object with information of the product.","properties":{"id":{"description":"Product ID.","type":"string"},"name":{"description":"Product Name.","type":"string"}},"type":"object"},"type":"array"},"productsAreInclusive":{"description":"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.","type":"boolean"},"productsSpecifications":{"deprecated":true,"items":{},"type":"array"},"quantityToAffectBuyTogether":{"description":"Quantity to affect **Buy Together** promotion.","type":"integer"},"rebatePercentualDiscountValue":{"description":"Percentual Shipping Discount Value.","type":"number"},"restrictionsBins":{"description":"The discount will be granted if the card's BIN is given.","items":{"description":"Card's BIN.","type":"string"},"type":"array"},"shippingPercentualTax":{"description":"Shipping Percentual Tax over purchase total value.","type":"number"},"shouldDistributeDiscountAmongMatchedItems":{"description":"Should distribute discount among matched items.","type":"boolean"},"skus":{"description":"Object composed by the SKUs that will activate or deactivate the promotion.","items":{"description":"Object with information of the SKU.","properties":{"id":{"description":"SKU ID.","type":"string"},"name":{"description":"SKU Name.","type":"string"}},"type":"object"},"type":"array"},"skusAreInclusive":{"description":"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.","type":"boolean"},"skusGift":{"description":"SKU Gift Object. Total discount on the product value set as a gift.","properties":{"gifts":{"description":"Array with SKU Gifts IDs.","type":"integer"},"quantitySelectable":{"description":"Quantity of SKU Gifts.","type":"integer"}},"type":"object"},"slasIds":{"description":"The discount will be granted if the shipping method is the same as the one given.","items":{"description":"Shipping method.","type":"string"},"type":"array"},"stores":{"deprecated":true,"items":{},"type":"array"},"storesAreInclusive":{"deprecated":true,"type":"boolean"},"totalValueCeling":{"description":"Maximum chart value to activate the promotion.","type":"number"},"totalValueFloor":{"description":"Minimum chart value to activate the promotion.","type":"number"},"totalValueIncludeAllItems":{"deprecated":true,"type":"boolean"},"totalValueMode":{"description":"Defines if products that already are receiving a promotion will be considered on the chart total value. There are three options available: `IncludeMatchedItems`, `ExcludeMatchedItems`, `AllItems`.","type":"string"},"totalValuePurchase":{"description":"Total value a client must have in past orders to active the promotion.","type":"number"},"type":{"description":"Defines what is the type of the promotion or indicates if it is a tax. Possible values: `regular` ([Regular Promotion](https://help.vtex.com/tutorial/regular-promotion--tutorials_327)), `combo` ([Buy Together](https://help.vtex.com/en/tutorial/buy-together--tutorials_323)), `forThePriceOf` ([More for Less](https://help.vtex.com/en/tutorial/creating-a-more-for-less-promotion--tutorials_325)), `progressive` ([Progressive Discount](https://help.vtex.com/en/tutorial/progressive-discount--tutorials_324)), `buyAndWin` ([Buy One Get One](https://help.vtex.com/en/tutorial/buy-one-get-one--tutorials_322)), `maxPricePerItem` (Deprecated), `campaign` ([Campaign Promotion](https://help.vtex.com/en/tutorial/campaign-promotion--1ChYXhK2AQGuS6wAqS8Ume)), `tax` (Tax), `multipleEffects` (Multiple Effects).","type":"string"},"useNewProgressiveAlgorithm":{"description":"Use new progressive algorithm.","type":"boolean"},"utmCampaign":{"description":"Coupon utmCampaign code.","type":"string"},"utmSource":{"description":"Coupon utmSource code.","type":"string"},"zipCodeRanges":{"description":"Range of the zip code that applies the promotion.","items":{},"type":"array"}},"type":"object"}}},"description":"OK"}},"summary":"Create or Update Promotion or Tax","tags":["Promotions and Taxes"]}},"/api/rnb/pvt/calculatorconfiguration/{idCalculatorConfiguration}":{"get":{"deprecated":false,"description":"Retrieves a specific promotion by its Promotion ID or a specific tax by its Tax ID.","operationId":"GetCalculatorConfigurationById","parameters":[{"description":"Type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"Promotion ID or tax ID.","in":"path","name":"idCalculatorConfiguration","required":true,"schema":{"example":"d8a1cd2e-b667-4054-b3ae-b79124c7218e","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"Promotion":{"example":{"absoluteShippingDiscountValue":0,"accumulateWithManualPrice":false,"activateGiftsMultiplier":false,"activeDaysOfWeek":[],"affiliates":[],"applyToAllShippings":false,"areSalesChannelIdsExclusive":false,"beginDateUtc":"2025-08-15T13:51:41.626Z","brands":[],"brandsAreInclusive":false,"campaigns":[],"cardIssuers":[],"categories":[],"categoriesAreInclusive":false,"clusterExpressions":[],"collections":[],"collections1BuyTogether":[],"collections2BuyTogether":[],"collectionsIsInclusive":false,"compareListPriceAndPrice":false,"conditionsIds":["372e1868-2c0e-4437-be45-1ef8c9cab735"],"coupon":[],"cumulative":false,"daysAgoOfPurchases":0,"disableDeal":false,"discountType":"percentual","enableBuyTogetherPerSku":false,"firstBuyIsProfileOptimistic":false,"giftListTypes":[],"idCalculatorConfiguration":"d8a1cd2e-b667-4054-b3ae-b79124c7218e","idSellerIsInclusive":false,"idsSalesChannel":[],"installment":0,"isActive":true,"isArchived":false,"isDifferentListPriceAndPrice":false,"isFeatured":false,"isFirstBuy":false,"isMinMaxInstallments":false,"isSlaSelected":false,"itemMaxPrice":0,"itemMinPrice":0,"lastModified":"2025-08-15T13:51:41.626Z","listSku1BuyTogether":[],"listSku2BuyTogether":[],"marketingTags":[],"marketingTagsAreNotInclusive":false,"maxInstallment":0,"maxNumberOfAffectedItems":0,"maxNumberOfAffectedItemsGroupKey":"perCart","maxPricesPerItems":[],"maxUsage":0,"maxUsagePerClient":0,"maximumUnitPriceDiscount":0,"merchants":[],"minInstallment":0,"minimumQuantityBuyTogether":0,"multipleUsePerClient":false,"name":"Promoção Social Seller","newOffset":-3,"nominalDiscountValue":0,"nominalRewardValue":0,"nominalShippingDiscountValue":0,"nominalTax":0,"offset":-3,"orderStatusRewardValue":"invoiced","origin":"marketplace","paymentsMethods":[{"id":"202","name":"Dinheiro (202)"},{"id":"2","name":"Visa (2)"}],"paymentsRules":[],"percentualDiscountValue":10,"percentualDiscountValueList":[],"percentualDiscountValueList1":0,"percentualDiscountValueList2":0,"percentualRewardValue":0,"percentualShippingDiscountValue":0,"percentualTax":0,"products":[],"productsAreInclusive":false,"productsSpecifications":[],"quantityToAffectBuyTogether":0,"rebatePercentualDiscountValue":0,"restrictionsBins":[],"shippingPercentualTax":0,"shouldDistributeDiscountAmongMatchedItems":false,"skus":[],"skusAreInclusive":true,"skusGift":{"quantitySelectable":0},"slasIds":[],"stores":[],"storesAreInclusive":false,"totalValueCeling":0,"totalValueFloor":0,"totalValueIncludeAllItems":false,"totalValueMode":"IncludeMatchedItems","totalValuePurchase":0,"type":"regular","useNewProgressiveAlgorithm":false,"utmCampaign":"georgeTest","utmSource":"georgeSource","zipCodeRanges":[]},"schema":{"properties":{"absoluteShippingDiscountValue":{"description":"Maximum value for the shipping.","type":"number"},"accumulateWithManualPrice":{"description":"Allows the promotion to apply to products whose prices have been manually added by a call center operator.","type":"boolean"},"activateGiftsMultiplier":{"description":"If set as `true`, it activates gifts Multiplier.","type":"boolean"},"activeDaysOfWeek":{"description":"Defines which days of the week the promotion will applied.","items":{"description":"Day of the week that the promotion will be valid.","type":"string"},"type":"array"},"affiliates":{"description":"Marketplace order identifier. The discount will apply to selected affiliates.","items":{"description":"Object with information of the affiliate.","properties":{"id":{"description":"Affiliate ID.","type":"string"},"name":{"description":"Affiliate Name.","type":"string"}},"type":"object"},"type":"array"},"applyToAllShippings":{"description":"Promotion will be applied to all kind of shipping.","type":"boolean"},"areSalesChannelIdsExclusive":{"description":"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.","type":"boolean"},"beginDateUtc":{"description":"Promotion Begin Date (UTC).","type":"string"},"brands":{"description":"Object composed by the brands that will activate or deactivate the promotion.","items":{"description":"Object with information of the brand.","properties":{"id":{"description":"Brand ID.","type":"string"},"name":{"description":"Brand Name.","type":"string"}},"type":"object"},"type":"array"},"brandsAreInclusive":{"description":"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.","type":"boolean"},"campaigns":{"description":"Campaign Audiences that activate this promotion.","items":{},"type":"array"},"cardIssuers":{"deprecated":true,"items":{},"type":"array"},"categories":{"description":"Object composed by the categories that will activate or deactivate the promotion.","items":{"description":"Object with information of the category.","properties":{"id":{"description":"Category ID.","type":"string"},"name":{"description":"Category Name.","type":"string"}},"type":"object"},"type":"array"},"categoriesAreInclusive":{"description":"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.","type":"boolean"},"clusterExpressions":{"description":"An expression to use with clusters.","items":{"description":"Cluster expression.","type":"string"},"type":"array"},"collections":{"description":"Array composed by the collections that will be activated or deactivated the promotion.","items":{"description":"Object with information of the collection.","properties":{"id":{"description":"Collection ID.","type":"string"},"name":{"description":"Collection Name.","type":"string"}},"type":"object"},"type":"array"},"collections1BuyTogether":{"description":"Collections that will generate the promotion, type **Buy Together**, **More for less**, **Progressive Discount**, **Buy One Get One**.","items":{"description":"Collection ID.","type":"string"},"type":"array"},"collections2BuyTogether":{"deprecated":true,"items":{},"type":"array"},"collectionsIsInclusive":{"description":"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.","type":"boolean"},"compareListPriceAndPrice":{"description":"If the **List Price** and **Price** are the same.","type":"boolean"},"conditionsIds":{"description":"Array with conditions IDs.","items":{"description":"Condition ID.","type":"string"},"type":"array"},"coupon":{"deprecated":true,"items":{},"type":"array"},"cumulative":{"description":"Defines if a promotion can accumulate with another one. (`true`) or not (`false`).","type":"boolean"},"daysAgoOfPurchases":{"description":"Number of days that are considered to add the purchase history.","type":"integer"},"description":{"description":"Promotion internal description.","type":"string"},"disableDeal":{"deprecated":true,"type":"boolean"},"discountType":{"description":"The type of discount that will apply to the promotion.","type":"string"},"enableBuyTogetherPerSku":{"description":"Enable **Buy Together** per SKU.","type":"boolean"},"endDateUtc":{"description":"Promotion End Date (UTC).","type":"string"},"firstBuyIsProfileOptimistic":{"description":"Applies the discount even if the user is not logged.","type":"boolean"},"giftListTypes":{"description":"Gifts List Type.","items":{"description":"Gift List Type.","type":"string"},"type":"array"},"idCalculatorConfiguration":{"description":"Promotion ID.","type":"string"},"idSeller":{"description":"Seller Name.","type":"string"},"idSellerIsInclusive":{"description":"If set to `true`, this promotion will be applied to any seller present on the idSeller field. If set to `false`, sellers present on that field will make this promotion not to be applied.","type":"boolean"},"idsSalesChannel":{"description":"List of Trade Policies that activate this promotion.","items":{"description":"Trade Policy ID.","type":"string"},"type":"array"},"installment":{"deprecated":true,"type":"integer"},"isActive":{"description":"If set as `true` the Promotion is activated. If set as `false` the Promotion is deactivated.","type":"boolean"},"isArchived":{"description":"If set as `true` the Promotion is archived. If set as `false` the Promotion is not archived.","type":"boolean"},"isDifferentListPriceAndPrice":{"description":"Applies the promotion only if the list price and price is different.","type":"boolean"},"isFeatured":{"description":"Insert a flag with the promotion name used in the product's window display and page.","type":"boolean"},"isFirstBuy":{"description":"Applies the discount only if it's a first buy.","type":"boolean"},"isMinMaxInstallments":{"description":"Set if the promotion will be applied considering a minimum and maximum values for installments.","type":"boolean"},"isSlaSelected":{"description":"Applies selected discount only when one of the defined shipping method is selected by the customer.","type":"boolean"},"itemMaxPrice":{"description":"Maximum price of the item.","type":"number"},"itemMinPrice":{"description":"Minimum price of the item.","type":"number"},"lastModified":{"description":"When the Promotion was last modified.","type":"string"},"listSku1BuyTogether":{"description":"SKU first list for the promotion **Buy Together**.","items":{},"type":"array"},"listSku2BuyTogether":{"description":"SKU second list for the promotion **Buy Together**.","items":{},"type":"array"},"marketingTags":{"description":"Promotion Marketing tags.","items":{"description":"Promotion Marketing tag.","type":"string"},"type":"array"},"marketingTagsAreNotInclusive":{"description":"If set to `false`, this promotion will be applied to any marketing tag present on the `marketingTags` field. If set to `true`, marketing tags present on that field will make this promotion not to be applied.","type":"boolean"},"maxInstallment":{"description":"Maximum value for installment.","type":"integer"},"maxNumberOfAffectedItems":{"description":"The maximum number of affected items for a promotion.","type":"integer"},"maxNumberOfAffectedItemsGroupKey":{"description":"The maximum number of affected items by group key for a promotion.","type":"string"},"maxPricesPerItems":{"deprecated":true,"items":{},"type":"array"},"maxUsage":{"description":"Defines how many times the promotion can be used.","type":"integer"},"maxUsagePerClient":{"description":"Defines if the promotion can be used multiple times per client.","type":"integer"},"maximumUnitPriceDiscount":{"description":"The maximum price for each item of the purchase will be the price set up.","type":"number"},"merchants":{"deprecated":true,"items":{},"type":"array"},"minInstallment":{"description":"Minimum value for installment.","type":"integer"},"minimumQuantityBuyTogether":{"description":"Minimum quantity for **Buy Together** promotion.","type":"integer"},"multipleSkusCause":{"additionalProperties":{"description":"SKU ID.","type":"string"},"description":"Object composed by a list of SKUs on a Multiple Effects promotion. Structure: `\"{SkuId}\": {PercentageDiscount}`. There is a limit of 400 SKUs for this type of promotion.","type":"object"},"multipleUsePerClient":{"description":"Defines if the promotion can be used multiple times per client.","type":"boolean"},"name":{"description":"Promotion Name.","type":"string"},"newOffset":{"description":"New time offset from UTC in seconds.","type":"number"},"nominalDiscountValue":{"description":"Exact discount to be applied for the total purchase value.","type":"number"},"nominalRewardValue":{"description":"Nominal value for rewards program.","type":"number"},"nominalShippingDiscountValue":{"description":"Exact discount to be applied for the shipping value.","type":"number"},"nominalTax":{"description":"Nominal Tax.","type":"number"},"offset":{"description":"Time offset from UTC in seconds.","type":"integer"},"orderStatusRewardValue":{"description":"Order status reward value.","type":"string"},"origin":{"description":"Origin of the promotion, `marketplace` or `Fulfillment`. Read [Difference between orders with marketplace and fulfillment sources](https://help.vtex.com/en/tutorial/what-are-orders-with-marketplace-source-and-orders-with-fulfillment-source--6eVYrmUAwMOeKICU2KuG06) for more information.","type":"string"},"paymentsMethods":{"description":"Array composed by all the Payments Methods.","items":{"description":"Object with information of the Payment Method.","properties":{"id":{"description":"Payment Method ID.","type":"string"},"name":{"description":"Payment Method Name.","type":"string"}},"type":"object"},"type":"array"},"paymentsRules":{"deprecated":true,"items":{},"type":"array"},"percentualDiscountValue":{"description":"Percentage discount to be applied for total purchase value.","type":"number"},"percentualDiscountValueList":{"description":"Percentual discount value list.","items":{"description":"Percentual discount value.","type":"number"},"type":"array"},"percentualDiscountValueList1":{"description":"Valid discounts for the SKUs in `listSku1BuyTogether`, discount list used for Buy Together Promotions.","type":"number"},"percentualDiscountValueList2":{"description":"Equivalent to `percentualDiscountValueList1`.","type":"number"},"percentualRewardValue":{"description":"Percentage value for rewards program.","type":"number"},"percentualShippingDiscountValue":{"description":"Percentage discount to be applied for shipping value.","type":"number"},"percentualTax":{"description":"Percentual Tax over purchase total value.","type":"number"},"products":{"description":"Object composed by the products that will activate or deactivate the promotion.","items":{"description":"Object with information of the product.","properties":{"id":{"description":"Product ID.","type":"string"},"name":{"description":"Product Name.","type":"string"}},"type":"object"},"type":"array"},"productsAreInclusive":{"description":"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.","type":"boolean"},"productsSpecifications":{"deprecated":true,"items":{},"type":"array"},"quantityToAffectBuyTogether":{"description":"Quantity to affect **Buy Together** promotion.","type":"integer"},"rebatePercentualDiscountValue":{"description":"Percentual Shipping Discount Value.","type":"number"},"restrictionsBins":{"description":"The discount will be granted if the card's BIN is given.","items":{"description":"Card's BIN.","type":"string"},"type":"array"},"shippingPercentualTax":{"description":"Shipping Percentual Tax over purchase total value.","type":"number"},"shouldDistributeDiscountAmongMatchedItems":{"description":"Should distribute discount among matched items.","type":"boolean"},"skus":{"description":"Object composed by the SKUs that will activate or deactivate the promotion.","items":{"description":"Object with information of the SKU.","properties":{"id":{"description":"SKU ID.","type":"string"},"name":{"description":"SKU Name.","type":"string"}},"type":"object"},"type":"array"},"skusAreInclusive":{"description":"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.","type":"boolean"},"skusGift":{"description":"SKU Gift Object. Total discount on the product value set as a gift.","properties":{"gifts":{"description":"Array with SKU Gifts IDs.","type":"integer"},"quantitySelectable":{"description":"Quantity of SKU Gifts.","type":"integer"}},"type":"object"},"slasIds":{"description":"The discount will be granted if the shipping method is the same as the one given.","items":{"description":"Shipping method.","type":"string"},"type":"array"},"stores":{"deprecated":true,"items":{},"type":"array"},"storesAreInclusive":{"deprecated":true,"type":"boolean"},"totalValueCeling":{"description":"Maximum chart value to activate the promotion.","type":"number"},"totalValueFloor":{"description":"Minimum chart value to activate the promotion.","type":"number"},"totalValueIncludeAllItems":{"deprecated":true,"type":"boolean"},"totalValueMode":{"description":"If products that already are receiving a promotion, will be considered on the chart total value. There are three options available: `IncludeMatchedItems`, `ExcludeMatchedItems`, `AllItems`.","type":"string"},"totalValuePurchase":{"description":"Total value a client must have in past orders to active the promotion.","type":"number"},"type":{"description":"Defines what is the type of the promotion or indicates if it is a tax. Possible values: `regular` ([Regular Promotion](https://help.vtex.com/tutorial/regular-promotion--tutorials_327)), `combo` ([Buy Together](https://help.vtex.com/en/tutorial/buy-together--tutorials_323)), `forThePriceOf` ([More for Less](https://help.vtex.com/en/tutorial/creating-a-more-for-less-promotion--tutorials_325)), `progressive` ([Progressive Discount](https://help.vtex.com/en/tutorial/progressive-discount--tutorials_324)), `buyAndWin` ([Buy One Get One](https://help.vtex.com/en/tutorial/buy-one-get-one--tutorials_322)), `maxPricePerItem` (Deprecated), `campaign` ([Campaign Promotion](https://help.vtex.com/en/tutorial/campaign-promotion--1ChYXhK2AQGuS6wAqS8Ume)), `tax` (Tax), `multipleEffects` (Multiple Effects).","type":"string"},"useNewProgressiveAlgorithm":{"description":"Use new progressive algorithm.","type":"boolean"},"utmCampaign":{"description":"Coupon utmCampaign code.","type":"string"},"utmSource":{"description":"Coupon utmSource code.","type":"string"},"zipCodeRanges":{"description":"Range of the zip code that applies the promotion.","items":{"properties":{"inclusive":{"description":"Defines if the zip code range is included in the promotion.","type":"boolean"},"zipCodeFrom":{"description":"Initial Zip Code.","type":"string"},"zipCodeTo":{"description":"Final Zip Code.","type":"string"}},"title":"","type":"object"},"type":"array"}},"type":"object"}},"Tax":{"example":{"absoluteShippingDiscountValue":0,"activateGiftsMultiplier":false,"activeDaysOfWeek":[],"affiliates":[],"applyToAllShippings":false,"areSalesChannelIdsExclusive":false,"beginDateUtc":"2025-08-15T13:51:41.627Z","brands":[{"id":"2000000","name":"VALDIE&CO (2000000)"}],"brandsAreInclusive":true,"campaigns":[],"cardIssuers":[],"categories":[{"id":"2","name":"Computers (2)"}],"categoriesAreInclusive":true,"clusterExpressions":[],"collections":[{"id":"137","name":"Best Sellers (137)"}],"collections1BuyTogether":[],"collections2BuyTogether":[],"collectionsIsInclusive":true,"compareListPriceAndPrice":false,"coupon":[],"cumulative":false,"daysAgoOfPurchases":0,"description":"Tax applied by the government","disableDeal":false,"enableBuyTogetherPerSku":false,"endDateUtc":"2025-08-15T13:51:41.627Z","firstBuyIsProfileOptimistic":false,"giftListTypes":[],"idCalculatorConfiguration":"90f4affc-fea0-424c-a7a7-c69aec7bbdc8","idSellerIsInclusive":false,"idsSalesChannel":[],"installment":0,"isActive":true,"isArchived":false,"isDifferentListPriceAndPrice":false,"isFeatured":false,"isFirstBuy":false,"isMinMaxInstallments":false,"isSlaSelected":false,"itemMaxPrice":0,"itemMinPrice":0,"lastModified":"2025-08-15T13:51:41.627Z","listSku1BuyTogether":[],"listSku2BuyTogether":[],"marketingTags":["hello-world"],"marketingTagsAreNotInclusive":false,"maxInstallment":0,"maxNumberOfAffectedItems":0,"maxNumberOfAffectedItemsGroupKey":"perCart","maxPricesPerItems":[],"maxUsage":0,"maxUsagePerClient":0,"maximumUnitPriceDiscount":0,"merchants":[],"minInstallment":0,"minimumQuantityBuyTogether":0,"multipleUsePerClient":false,"name":"Government Tax","newOffset":0,"nominalDiscountValue":0,"nominalRewardValue":0,"nominalShippingDiscountValue":0,"nominalTax":0,"offset":0,"orderStatusRewardValue":"invoiced","origin":"Fulfillment","paymentsMethods":[{"id":"45","name":"Venda Direta Credito (45)"}],"paymentsRules":[],"percentualDiscountValue":0,"percentualDiscountValueList":[],"percentualDiscountValueList1":0,"percentualDiscountValueList2":0,"percentualRewardValue":0,"percentualShippingDiscountValue":0,"percentualTax":10,"products":[{"id":"1","name":"Seaweed Strengthening Masks - Pre Order! (Produto 1)"}],"productsAreInclusive":true,"productsSpecifications":[],"quantityToAffectBuyTogether":0,"rebatePercentualDiscountValue":0,"restrictionsBins":[],"shippingPercentualTax":0,"shouldDistributeDiscountAmongMatchedItems":false,"skus":[{"id":"1","name":"50 ml (SKU 1)"}],"skusAreInclusive":true,"skusGift":{"quantitySelectable":0},"slasIds":[],"stores":[],"storesAreInclusive":false,"totalValueCeling":0,"totalValueFloor":0,"totalValueIncludeAllItems":false,"totalValueMode":"IncludeMatchedItems","totalValuePurchase":123,"type":"tax","useNewProgressiveAlgorithm":false,"zipCodeRanges":[]},"schema":{"properties":{"absoluteShippingDiscountValue":{"description":"Maximum value for the shipping.","type":"number"},"activateGiftsMultiplier":{"description":"If set as `true`, it activates gifts Multiplier.","type":"boolean"},"activeDaysOfWeek":{"description":"Defines days of the week in which the Tax will applied.","items":{"description":"Day of the week that the Tax will be valid.","type":"string"},"type":"array"},"affiliates":{"description":"Marketplace order identifier. The discount will apply to selected affiliates.","items":{"description":"Object with information of the affiliate.","properties":{"id":{"description":"Affiliate ID.","type":"string"},"name":{"description":"Affiliate Name.","type":"string"}},"type":"object"},"type":"array"},"applyToAllShippings":{"description":"Tax will be applied to all kind of shipping.","type":"boolean"},"areSalesChannelIdsExclusive":{"description":"If set to `false`, this Tax 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 Tax not to be applied.","type":"boolean"},"beginDateUtc":{"description":"Tax Begin Date (UTC).","type":"string"},"brands":{"description":"Object composed by the brands that will activate or deactivate the Tax.","items":{"description":"Object with information of the brand.","properties":{"id":{"description":"Brand ID.","type":"string"},"name":{"description":"Brand Name.","type":"string"}},"type":"object"},"type":"array"},"brandsAreInclusive":{"description":"If set to `true`, this Tax will be applied to any brand present on the `brands` field. If set to `false`, brands present on that field will make this Tax not to be applied.","type":"boolean"},"campaigns":{"description":"Campaign Audiences that activate this Tax.","items":{"description":"Campaign Audience.","example":"Campaign Audience example","type":"string"},"type":"array"},"cardIssuers":{"deprecated":true,"items":{},"type":"array"},"categories":{"description":"Object composed by the categories that will activate or deactivate the Tax.","items":{"description":"Object with information of the category.","properties":{"id":{"description":"Category ID.","type":"string"},"name":{"description":"Category Name.","type":"string"}},"type":"object"},"type":"array"},"categoriesAreInclusive":{"description":"If set to `true`, this Tax will be applied to any category present on the `categories` field. If set to `false`, categories present on that field will make this Tax not to be applied.","type":"boolean"},"clusterExpressions":{"description":"An expression to use with clusters.","items":{"description":"Cluster expression.","type":"string"},"type":"array"},"collections":{"description":"Array composed by the collections that will be activated or deactivated the Tax.","items":{"description":"Object with information of the collection.","properties":{"id":{"description":"Collection ID.","type":"string"},"name":{"description":"Collection Name.","type":"string"}},"type":"object"},"type":"array"},"collections1BuyTogether":{"description":"Collections that will generate the Tax, type **Buy Together**, **More for less**, **Progressive Discount**, **Buy One Get One**.","items":{"description":"Collection ID.","type":"string"},"type":"array"},"collections2BuyTogether":{"deprecated":true,"items":{},"type":"array"},"collectionsIsInclusive":{"description":"If set to `true`, this Tax will be applied to any collection present on the `collections` field. If set to `false`, collections present on that field will make this Tax not be applied.","type":"boolean"},"compareListPriceAndPrice":{"description":"If the **List Price** and **Price** are the same.","type":"boolean"},"coupon":{"deprecated":true,"items":{},"type":"array"},"cumulative":{"description":"Defines if a Tax can accumulate with another one. (`true`) or not (`false`).","type":"boolean"},"daysAgoOfPurchases":{"description":"Number of days that are considered to add the purchase history.","type":"integer"},"description":{"description":"Tax internal description.","type":"string"},"disableDeal":{"deprecated":true,"type":"boolean"},"enableBuyTogetherPerSku":{"description":"Enable **Buy Together** per SKU.","type":"boolean"},"endDateUtc":{"description":"Tax End Date (UTC).","type":"string"},"firstBuyIsProfileOptimistic":{"description":"Applies the Tax even if the user is not logged.","type":"boolean"},"giftListTypes":{"description":"Gifts List Type.","items":{"description":"Gift List Type.","type":"string"},"type":"array"},"idCalculatorConfiguration":{"description":"Tax ID.","type":"string"},"idSeller":{"description":"Seller Name.","type":"string"},"idSellerIsInclusive":{"description":"If set to `true`, this Tax will be applied to any seller present on the idSeller field. If set to `false`, sellers present on that field will make this Tax not to be applied.","type":"boolean"},"idsSalesChannel":{"description":"List of Trade Policies that activate this Tax.","items":{"description":"Trade Policy ID.","type":"string"},"type":"array"},"installment":{"deprecated":true,"type":"integer"},"isActive":{"description":"If set as `true` the Tax is activated. If set as `false` the Tax is deactivated.","type":"boolean"},"isArchived":{"description":"If set as `true` the Tax is archived. If set as `false` the Tax is not archived.","type":"boolean"},"isDifferentListPriceAndPrice":{"description":"Applies the Tax only if the list price and price is different.","type":"boolean"},"isFeatured":{"description":"Insert a flag with the Tax name used in the product's window display and page.","type":"boolean"},"isFirstBuy":{"description":"Applies the Tax only if it's a first buy.","type":"boolean"},"isMinMaxInstallments":{"description":"Set if the Tax will be applied considering a minimum and maximum values for installments.","type":"boolean"},"isSlaSelected":{"description":"Applies the Tax only when one of the defined shipping method is selected by the customer.","type":"boolean"},"itemMaxPrice":{"description":"Maximum price of the item.","type":"number"},"itemMinPrice":{"description":"Minimum price of the item.","type":"number"},"lastModified":{"description":"When the Tax was last modified.","type":"string"},"listSku1BuyTogether":{"description":"SKU first list for the promotion **Buy Together**.","items":{"description":"SKU ID.","example":1,"type":"integer"},"type":"array"},"listSku2BuyTogether":{"description":"SKU second list for the promotion **Buy Together**.","items":{"description":"SKU ID.","example":1,"type":"integer"},"type":"array"},"marketingTags":{"description":"Tax Marketing tags.","items":{"description":"Promotion Marketing tag.","type":"string"},"type":"array"},"marketingTagsAreNotInclusive":{"description":"If set to `false`, this Tax will be applied to any marketing tag present on the `marketingTags` field. If set to `true`, marketing tags present on that field will make this Tax not to be applied.","type":"boolean"},"maxInstallment":{"description":"Maximum value for installment.","type":"integer"},"maxNumberOfAffectedItems":{"description":"The maximum number of affected items for a promotion.","type":"integer"},"maxNumberOfAffectedItemsGroupKey":{"description":"The maximum number of affected items by group key for a promotion.","type":"string"},"maxPricesPerItems":{"deprecated":true,"items":{},"type":"array"},"maxUsage":{"description":"Defines how many times the Tax can be applied.","type":"integer"},"maxUsagePerClient":{"description":"Defines the maximum amount of times the Tax can be applied per client.","type":"integer"},"maximumUnitPriceDiscount":{"description":"The maximum price for each item of the purchase will be the price set up.","type":"number"},"merchants":{"deprecated":true,"items":{},"type":"array"},"minInstallment":{"description":"Minimum value for installment.","type":"integer"},"minimumQuantityBuyTogether":{"description":"Minimum quantity for **Buy Together** promotion.","type":"integer"},"multipleUsePerClient":{"description":"Defines if the Tax can be applied multiple times per client.","type":"boolean"},"name":{"description":"Tax Name.","type":"string"},"newOffset":{"description":"New time offset from UTC in seconds.","type":"number"},"nominalDiscountValue":{"description":"Exact discount to be applied for the total purchase value.","type":"number"},"nominalRewardValue":{"description":"Nominal value for rewards program.","type":"number"},"nominalShippingDiscountValue":{"description":"Exact discount to be applied for the shipping value.","type":"number"},"nominalTax":{"description":"Nominal Tax.","type":"number"},"offset":{"description":"Time offset from UTC in seconds.","type":"integer"},"orderStatusRewardValue":{"description":"Order status reward value.","type":"string"},"origin":{"description":"Origin of the Tax, `marketplace` or `Fulfillment`.  Read [Difference between orders with marketplace and fulfillment sources](https://help.vtex.com/en/tutorial/what-are-orders-with-marketplace-source-and-orders-with-fulfillment-source--6eVYrmUAwMOeKICU2KuG06) for more information.","type":"string"},"paymentsMethods":{"description":"Array composed by all the Payments Methods.","items":{"description":"Object with information of the Payment Method.","properties":{"id":{"description":"Payment Method ID.","type":"string"},"name":{"description":"Payment Method Name.","type":"string"}},"type":"object"},"type":"array"},"paymentsRules":{"deprecated":true,"items":{},"type":"array"},"percentualDiscountValue":{"description":"Percentage discount to be applied for total purchase value.","type":"number"},"percentualDiscountValueList":{"description":"Percentual discount value list.","items":{"description":"Percentual discount value.","type":"number"},"type":"array"},"percentualDiscountValueList1":{"description":"Valid discounts for the SKUs in `listSku1BuyTogether`, discount list used for Buy Together Promotions.","type":"number"},"percentualDiscountValueList2":{"description":"Equivalent to `percentualDiscountValueList1`.","type":"number"},"percentualRewardValue":{"description":"Percentage value for rewards program.","type":"number"},"percentualShippingDiscountValue":{"description":"Percentage discount to be applied for shipping value.","type":"number"},"percentualTax":{"description":"Percentual Tax over purchase total value.","type":"number"},"products":{"description":"Array composed by the products that will activate or deactivate the Tax.","items":{"description":"Object with information of the product.","properties":{"id":{"description":"Product ID.","type":"string"},"name":{"description":"Product Name.","type":"string"}},"type":"object"},"type":"array"},"productsAreInclusive":{"description":"If set to `true`, this Tax will be applied to any product present on the `products` field. If set to `false`, products present on that field will make this Tax not to be applied.","type":"boolean"},"productsSpecifications":{"deprecated":true,"items":{},"type":"array"},"quantityToAffectBuyTogether":{"description":"Quantity to affect **Buy Together** promotion.","type":"integer"},"rebatePercentualDiscountValue":{"description":"Percentual Shipping Discount Value.","type":"number"},"restrictionsBins":{"description":"The Tax will be applied if the card's BIN is given.","items":{"description":"Card's BIN.","type":"string"},"type":"array"},"shippingPercentualTax":{"description":"Shipping Percentual Tax over purchase total value.","type":"number"},"shouldDistributeDiscountAmongMatchedItems":{"description":"Should distribute the Tax among matched items.","type":"boolean"},"skus":{"description":"Array composed by the SKUs that will activate or deactivate the Tax.","items":{"description":"Object with information of the SKU.","properties":{"id":{"description":"SKU ID.","type":"string"},"name":{"description":"SKU Name.","type":"string"}},"type":"object"},"type":"array"},"skusAreInclusive":{"description":"If set to `true`, this Tax will be applied to any SKU present on the `skus` field. If set to `false`, SKUs present on that field will make this Tax not to be applied.","type":"boolean"},"skusGift":{"description":"SKU Gift Object. Total discount on the product value set as a gift.","properties":{"gifts":{"description":"Array with SKU Gifts IDs.","type":"integer"},"quantitySelectable":{"description":"Quantity of SKU Gifts.","type":"integer"}},"type":"object"},"slasIds":{"description":"The Tax will be applied if the shipping method is the same as the one given.","items":{"description":"Shipping method.","type":"string"},"type":"array"},"stores":{"deprecated":true,"items":{},"type":"array"},"storesAreInclusive":{"deprecated":true,"type":"boolean"},"totalValueCeling":{"description":"Maximum chart value to activate the Tax.","type":"number"},"totalValueFloor":{"description":"Minimum chart value to activate the Tax.","type":"number"},"totalValueIncludeAllItems":{"deprecated":true,"type":"boolean"},"totalValueMode":{"description":"If products that are already receiving a Tax will be considered on the cart's total value. There are three options available: `IncludeMatchedItems`, `ExcludeMatchedItems`, `AllItems`.","type":"string"},"totalValuePurchase":{"description":"Total value a client must have in past orders to activate the Tax.","type":"number"},"type":{"description":"Defines what is the type of the promotion or indicates if it is a tax. Possible values: `regular` ([Regular Promotion](https://help.vtex.com/tutorial/regular-promotion--tutorials_327)), `combo` ([Buy Together](https://help.vtex.com/en/tutorial/buy-together--tutorials_323)), `forThePriceOf` ([More for Less](https://help.vtex.com/en/tutorial/creating-a-more-for-less-promotion--tutorials_325)), `progressive` ([Progressive Discount](https://help.vtex.com/en/tutorial/progressive-discount--tutorials_324)), `buyAndWin` ([Buy One Get One](https://help.vtex.com/en/tutorial/buy-one-get-one--tutorials_322)), `maxPricePerItem` (Deprecated), `campaign` ([Campaign Promotion](https://help.vtex.com/en/tutorial/campaign-promotion--1ChYXhK2AQGuS6wAqS8Ume)), `tax` (Tax), `multipleEffects` (Multiple Effects).","type":"string"},"useNewProgressiveAlgorithm":{"description":"Use new progressive algorithm.","type":"boolean"},"zipCodeRanges":{"description":"Range of the zip code that activate the Tax.","items":{"properties":{"inclusive":{"description":"Defines if the zip code range is included in the Tax.","type":"boolean"},"zipCodeFrom":{"description":"Initial Zip Code.","type":"string"},"zipCodeTo":{"description":"Final Zip Code.","type":"string"}},"title":"","type":"object"},"type":"array"}},"title":"","type":"object"}}},"description":"OK"}},"summary":"Get Promotion or Tax by ID","tags":["Promotions and Taxes"]}},"/api/rnb/pvt/campaignConfiguration":{"get":{"description":"Retrieves a list of all campaign audiences and their respective configurations.","operationId":"Getcampaignaudiences","parameters":[{"description":"Describes the type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"example":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"example":[{"beginDateUtc":"2025-08-15T13:51:41.627Z","endDateUtc":"2025-08-15T13:51:41.627Z","id":"dd270d06-1ed1-47fc-b04e-a2431121b5a4","isActive":true,"isAndOperator":false,"isArchived":false,"lastModified":{"dateUtc":"2025-08-15T13:51:41.627Z","user":"email@email.com"},"name":"Interna","targetConfigurations":[{"affiliates":[],"areSalesChannelIdsExclusive":false,"brands":[],"brandsAreInclusive":true,"campaigns":[],"cardIssuers":[],"categories":[],"categoriesAreInclusive":true,"clusterExpressions":[],"clusterOperator":"all","collections":[],"collections1BuyTogether":[],"collections2BuyTogether":[],"collectionsIsInclusive":true,"compareListPriceAndPrice":false,"coupon":[],"daysAgoOfPurchases":0,"enableBuyTogetherPerSku":false,"featured":false,"firstBuyIsProfileOptimistic":false,"giftListTypes":[],"id":"77ae1e4c-a216-4b15-a4a3-ae64ec298988","idSellerIsInclusive":false,"idsSalesChannel":[],"installment":0,"isDifferentListPriceAndPrice":false,"isFirstBuy":false,"isMinMaxInstallments":false,"isSlaSelected":false,"itemMaxPrice":0,"itemMinPrice":0,"listBrand1BuyTogether":[],"listCategory1BuyTogether":[],"listSku1BuyTogether":[],"listSku2BuyTogether":[],"marketingTags":["MKT1"],"marketingTagsAreNotInclusive":false,"maxInstallment":0,"maxUsage":0,"maxUsagePerClient":0,"merchants":[],"minInstallment":0,"minimumQuantityBuyTogether":1,"multipleUsePerClient":false,"name":"Social Sellers","origin":"Marketplace","paymentsMethods":[],"paymentsRules":[],"percentualDiscountValueList":[],"products":[],"productsAreInclusive":false,"productsSpecifications":[],"quantityToAffectBuyTogether":0,"restrictionsBins":[],"shouldDistributeDiscountAmongMatchedItems":false,"skus":[],"skusAreInclusive":true,"slasIds":[],"stores":[],"storesAreInclusive":false,"totalValueCeling":0,"totalValueFloor":0,"totalValueIncludeAllItems":false,"totalValueMode":"IncludeMatchedItems","totalValuePurchase":0,"useNewProgressiveAlgorithm":false,"zipCodeRanges":[{"inclusive":true}]}]}],"schema":{"description":"Array of campaign audiences.","items":{"description":"Object containing information about the campaign audience.","properties":{"beginDateUtc":{"description":"Start date of the campaign audience in UTC format.","type":"string"},"endDateUtc":{"description":"End date of the campaign audience in UTC format.","type":"string"},"id":{"description":"Campaign audience ID.","type":"string"},"isActive":{"description":"Defines if the campaign audience is active (`true`) or not (`false`).","type":"boolean"},"isAndOperator":{"description":"When `true`, determines that all the `targetConfigurations` need to be valid for the campaign audience to be active. When `false`, determines that if at least one of the `targetConfigurations` is valid, the campaign audience will be active.","type":"boolean"},"isArchived":{"description":"Defines if the campaign audience is archived (`true`) or not (`false`).","type":"boolean"},"lastModified":{"description":"Object with information about the most recent update of the campaign audience.","properties":{"dateUtc":{"description":"Date of the most recent update in UTC format.","type":"string"},"user":{"description":"Email of the user who updated the campaign audience for the latest time.","type":"string"}},"type":"object"},"name":{"description":"Campaign audience name.","type":"string"},"targetConfigurations":{"description":"Array that contains all target audience that the campaign audience will be valid.","items":{"description":"Object with information about the target audience.","properties":{"affiliates":{"description":"Marketplace order identifier. The discount will apply to selected affiliates.","items":{"description":"Object with information of the affiliate.","properties":{"id":{"description":"Affiliate ID.","type":"string"},"name":{"description":"Affiliate Name.","type":"string"}},"type":"object"},"type":"array"},"areSalesChannelIdsExclusive":{"description":"Defines if the trade policy IDs are exclusive.","type":"boolean"},"brands":{"description":"Object composed by the brands that will activate or deactivate the campaign audience.","items":{"description":"Object with information of the brand.","properties":{"id":{"description":"Brand ID.","type":"string"},"name":{"description":"Brand Name.","type":"string"}},"type":"object"},"type":"array"},"brandsAreInclusive":{"description":"If set to `true`, this campaign audience will be applied to any brand present on the `brands` field. If set to `false`, brands present on that field will make this campaign audience not to be applied.","type":"boolean"},"campaigns":{"description":"Campaign Audiences that activate this promotion.","items":{},"type":"array"},"cardIssuers":{"deprecated":true,"items":{},"type":"array"},"categories":{"description":"Object composed by the categories that will activate or deactivate the campaign audience.","items":{"description":"Object with information of the category.","properties":{"id":{"description":"Category ID.","type":"string"},"name":{"description":"Category Name.","type":"string"}},"type":"object"},"type":"array"},"categoriesAreInclusive":{"description":"If set to `true`, this campaign audience will be applied to any category present on the `categories` field. If set to `false`, categories present on that field will make this campaign audience not to be applied.","type":"boolean"},"clusterExpressions":{"description":"An expression to use with clusters.","items":{"description":"Cluster expression.","type":"string"},"type":"array"},"clusterOperator":{"deprecated":true,"type":"string"},"collections":{"description":"Object composed by the collections that will activate or deactivate the campaign audience.","items":{"description":"Object with information of the collection.","properties":{"id":{"description":"Collection ID.","type":"string"},"name":{"description":"Collection Name.","type":"string"}},"type":"object"},"type":"array"},"collections1BuyTogether":{"description":"Collections that will generate the promotion, type **Buy Together**, **More for less**, **Progressive Discount**, **Buy One Get One**.","items":{"description":"Collection ID.","type":"string"},"type":"array"},"collections2BuyTogether":{"deprecated":true,"items":{},"type":"array"},"collectionsIsInclusive":{"description":"If set to `true`, this campaign audience will be applied to any collection present on the `collections` field. If set to `false`, collections present on that field will make this campaign audience not to be applied.","type":"boolean"},"compareListPriceAndPrice":{"description":"If the **List Price** and **Price** are the same.","type":"boolean"},"coupon":{"deprecated":true,"items":{},"type":"array"},"daysAgoOfPurchases":{"description":"Number of days that are considered to add the purchase history.","type":"integer"},"enableBuyTogetherPerSku":{"description":"Enable **Buy Together** per SKU.","type":"boolean"},"featured":{"description":"Defines if the target audience is featured (`true`) or not (`false`).","type":"boolean"},"firstBuyIsProfileOptimistic":{"description":"Applies the discount even if the user is not logged.","type":"boolean"},"giftListTypes":{"description":"Gifts List Type.","items":{"description":"Gift List Type.","type":"string"},"type":"array"},"id":{"description":"Target audience ID.","type":"string"},"idSellerIsInclusive":{"description":"Defines if at least one of the sellers must be valid to active the campaign audience.","type":"boolean"},"idsSalesChannel":{"description":"Array with all the trade policies that activate the campaign audience.","items":{"description":"Trade policy ID.","type":"string"},"type":"array"},"installment":{"deprecated":true,"type":"integer"},"isDifferentListPriceAndPrice":{"description":"Applies the campaign audience only if the list price and price is different.","type":"boolean"},"isFirstBuy":{"description":"Applies the discount only if it's a first buy.","type":"boolean"},"isMinMaxInstallments":{"description":"Set if the campaign audience will be applied considering a minimum and maximum values for installments.","type":"boolean"},"isSlaSelected":{"description":"Applies selected discount only when one of the defined shipping method is selected by the customer.","type":"boolean"},"itemMaxPrice":{"description":"Maximum price of the item.","type":"number"},"itemMinPrice":{"description":"Minimum price of the item.","type":"number"},"listBrand1BuyTogether":{"description":"Brand first list for the promotion **Buy Together.","items":{},"type":"array"},"listCategory1BuyTogether":{"description":"Category first list for the promotion **Buy Together**.","items":{},"type":"array"},"listSku1BuyTogether":{"description":"SKU first list for the promotion **Buy Together**.","items":{},"type":"array"},"listSku2BuyTogether":{"description":"SKU second list for the promotion **Buy Together**.","items":{},"type":"array"},"marketingTags":{"description":"Array with all the campaign audience's marketing tags.","items":{"description":"Campaign audience marketing tags.","type":"string"},"type":"array"},"marketingTagsAreNotInclusive":{"description":"Defines if marketing tags are not inclusive.","type":"boolean"},"maxInstallment":{"description":"Maximum value for installment.","type":"integer"},"maxUsage":{"description":"Defines how many times the campaign audience can be used.","type":"integer"},"maxUsagePerClient":{"description":"Defines if the campaign audience can be used multiple times per client.","type":"integer"},"merchants":{"deprecated":true,"items":{},"type":"array"},"minInstallment":{"description":"Minimum value for installment.","type":"integer"},"minimumQuantityBuyTogether":{"description":"Minimum quantity for **Buy Together** promotion.","type":"integer"},"multipleUsePerClient":{"description":"Defines if the campaign audience can be used multiple times per client.","type":"boolean"},"name":{"description":"Target audience name.","type":"string"},"origin":{"description":"Shows the campaign audience origin, `Marketplace` or `Fulfillment`.  Read [Difference between orders with marketplace and fulfillment sources](https://help.vtex.com/en/tutorial/what-are-orders-with-marketplace-source-and-orders-with-fulfillment-source--6eVYrmUAwMOeKICU2KuG06) for more information.","type":"string"},"paymentsMethods":{"description":"Array composed by all the Payments Methods.","items":{"description":"Object with information of the Payment Method.","properties":{"id":{"description":"Payment Method ID.","type":"string"},"name":{"description":"Payment Method Name.","type":"string"}},"type":"object"},"type":"array"},"paymentsRules":{"deprecated":true,"items":{},"type":"array"},"percentualDiscountValueList":{"description":"Percentual discount value list.","items":{"description":"Percentual discount value.","type":"number"},"type":"array"},"products":{"description":"Object composed by the products that will activate or deactivate the campaign audience.","items":{"description":"Object with information of the product.","properties":{"id":{"description":"Product ID.","type":"string"},"name":{"description":"Product Name.","type":"string"}},"type":"object"},"type":"array"},"productsAreInclusive":{"description":"If set to `true`, this campaign audience will be applied to any product present on the `products` field. If set to `false`, products present on that field will make this campaign audience not to be applied.","type":"boolean"},"productsSpecifications":{"deprecated":true,"items":{},"type":"array"},"quantityToAffectBuyTogether":{"description":"Quantity to affect **Buy Together** promotion.","type":"integer"},"restrictionsBins":{"description":"The discount will be granted if the card's BIN is given.","items":{"description":"Card's BIN.","type":"string"},"type":"array"},"shouldDistributeDiscountAmongMatchedItems":{"description":"Should distribute discount among matched items.","type":"boolean"},"skus":{"description":"Object composed by the SKUs that will activate or deactivate the campaign audience.","items":{"description":"Object with information of the SKU.","properties":{"id":{"description":"SKU ID.","type":"string"},"name":{"description":"SKU Name.","type":"string"}},"type":"object"},"type":"array"},"skusAreInclusive":{"description":"If set to `true`, this campaign audience will be applied to any SKU present on the `skus` field. If set to `false`, SKUs present on that field will make this campaign audience not to be applied.","type":"boolean"},"slasIds":{"description":"The discount will be granted if the shipping method is the same as the one given.","items":{"description":"Shipping method.","type":"string"},"type":"array"},"stores":{"deprecated":true,"items":{},"type":"array"},"storesAreInclusive":{"deprecated":true,"type":"boolean"},"totalValueCeling":{"description":"Maximum chart value to active the campaign audience.","type":"number"},"totalValueFloor":{"description":"Minimum chart value to active the campaign audience.","type":"number"},"totalValueIncludeAllItems":{"deprecated":true,"type":"boolean"},"totalValueMode":{"description":"Total chart value to active the campaign audience.","type":"string"},"totalValuePurchase":{"description":"Total value a client must have in past orders to active the campaign audience.","type":"number"},"useNewProgressiveAlgorithm":{"description":"Use new progressive algorithm.","type":"boolean"},"zipCodeRanges":{"description":"Range of the zip code that applies the campaign audience.","items":{"description":"Zip code that applies the campaign audience.","properties":{"inclusive":{"description":"Defines if the zip code applies the campaign audience.","type":"boolean"}},"type":"object"},"type":"array"}},"type":"object"},"type":"array"}},"title":"","type":"object"},"type":"array"}}},"description":"OK"}},"summary":"Get all campaign audiences","tags":["Campaign Audiences"]},"post":{"description":"Creates a new campaign audience.","operationId":"Setcampaignconfiguration","parameters":[{"description":"Describes the type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"beginDateUtc":{"description":"Start date of the campaign audience in UTC format.","example":"2025-08-15T13:51:41.627Z","type":"string"},"endDateUtc":{"description":"End date of the campaign audience in UTC format.","example":"2025-08-15T13:51:41.627Z","type":"string"},"id":{"description":"Campaign audience ID.","example":"dd270d06-1ed1-47fc-b04e-a2431121b5a4","type":"string"},"isActive":{"description":"Defines if the campaign audience is active (`true`) or not (`false`).","example":true,"type":"boolean"},"isAndOperator":{"description":"When `true`, determines that all the `targetConfigurations` need to be valid for the campaign audience to be active. When `false`, determines that if at least one of the `targetConfigurations` is valid, the campaign audience will be active.","example":true,"type":"boolean"},"isArchived":{"description":"Defines if the campaign audience is archived (`true`) or not (`false`).","example":false,"type":"boolean"},"lastModified":{"description":"Object with information about the last update of the campaign audience.","properties":{"dateUtc":{"description":"Date of the last update in UTC format.","example":"2025-08-15T13:51:41.627Z","type":"string"},"user":{"description":"Email of the user who made the last update.","example":"email@email.com","type":"string"}},"type":"object"},"name":{"description":"Campaign audience name.","example":"Interna","type":"string"},"targetConfigurations":{"description":"Array that contains all target audience that the campaign audience will be valid.","items":{"description":"Object with information about the target audience.","properties":{"affiliates":{"description":"Marketplace order identifier. The discount will apply to selected affiliates.","items":{"description":"Object with information of the affiliate.","properties":{"id":{"description":"Affiliate ID.","example":"1","type":"string"},"name":{"description":"Affiliate Name.","example":"Amazon","type":"string"}},"type":"object"},"type":"array"},"areSalesChannelIdsExclusive":{"description":"Shows if the trade policy IDs are exclusive.","example":false,"type":"boolean"},"brands":{"description":"Object composed by the brands that will activate or deactivate the campaign audience.","items":{"description":"Object with information of the brand.","properties":{"id":{"description":"Brand ID.","example":"1","type":"string"},"name":{"description":"Brand Name.","example":"Brand (1)","type":"string"}},"type":"object"},"type":"array"},"brandsAreInclusive":{"description":"If set to `true`, this campaign audience will be applied to any brand present on the `brands` field. If set to `false`, brands present on that field will make this campaign audience not to be applied.","example":true,"type":"boolean"},"campaigns":{"description":"Campaign Audiences that activate this promotion.","example":[],"items":{},"type":"array"},"cardIssuers":{"deprecated":true,"items":{},"type":"array"},"categories":{"description":"Object composed by the categories that will activate or deactivate the campaign audience.","items":{"description":"Object with information of the category.","properties":{"id":{"description":"Category ID.","example":"1","type":"string"},"name":{"description":"Category Name.","example":"Vinhos Tintos (1)","type":"string"}},"type":"object"},"type":"array"},"categoriesAreInclusive":{"description":"If set to `true`, this campaign audience will be applied to any category present on the `categories` field. If set to `false`, categories present on that field will make this campaign audience not to be applied.","example":true,"type":"boolean"},"clusterExpressions":{"description":"An expression to use with clusters.","items":{"description":"Cluster expression.","example":"birthday=true","type":"string"},"type":"array"},"clusterOperator":{"deprecated":true,"type":"string"},"collections":{"description":"Object composed by the collections that will activate or deactivate the campaign audience.","items":{"description":"Object with information of the collection.","properties":{"id":{"description":"Collection ID.","example":"1","type":"string"},"name":{"description":"Collection Name.","example":"Collection (1)","type":"string"}},"type":"object"},"type":"array"},"collections1BuyTogether":{"description":"Collections that will generate the promotion, type **Buy Together**, **More for less**, **Progressive Discount**, **Buy One Get One**.","items":{"description":"Collection ID.","example":"1","type":"string"},"type":"array"},"collections2BuyTogether":{"deprecated":true,"items":{},"type":"array"},"collectionsIsInclusive":{"description":"If set to `true`, this campaign audience will be applied to any collection present on the `collections` field. If set to `false`, collections present on that field will make this campaign audience not to be applied.","example":true,"type":"boolean"},"compareListPriceAndPrice":{"description":"If the **List Price** and **Price** are the same.","example":false,"type":"boolean"},"coupon":{"deprecated":true,"items":{},"type":"array"},"daysAgoOfPurchases":{"description":"Number of days that are considered to add the purchase history.","example":0,"type":"integer"},"enableBuyTogetherPerSku":{"description":"Enable **Buy Together** per SKU.","example":false,"type":"boolean"},"featured":{"description":"Defines if the target audience is featured (`true`) or not (`false`).","example":false,"type":"boolean"},"firstBuyIsProfileOptimistic":{"description":"Applies the discount even if the user is not logged.","example":false,"type":"boolean"},"giftListTypes":{"description":"Gifts List Type.","items":{"description":"Gift List Type.","example":"Wishlist","type":"string"},"type":"array"},"id":{"description":"Target audience ID.","example":"77ae1e4c-a216-4b15-a4a3-ae64ec298988","type":"string"},"idSellerIsInclusive":{"description":"Shows if at least one of the sellers must be valid to active the campaign audience.","example":false,"type":"boolean"},"idsSalesChannel":{"description":"Shows the trade policies that active the campaign audience.","items":{"description":"Trade policy ID.","example":"Principal","type":"string"},"type":"array"},"installment":{"deprecated":true,"type":"integer"},"isDifferentListPriceAndPrice":{"description":"Applies the campaign audience only if the list price and price is different.","example":false,"type":"boolean"},"isFirstBuy":{"description":"Applies the discount only if it's a first buy.","example":false,"type":"boolean"},"isMinMaxInstallments":{"description":"Set if the campaign audience will be applied considering a minimum and maximum values for installments.","example":false,"type":"boolean"},"isSlaSelected":{"description":"Applies selected discount only when one of the defined shipping method is selected by the customer.","example":false,"type":"boolean"},"itemMaxPrice":{"description":"Maximum price of the item.","example":0,"type":"number"},"itemMinPrice":{"description":"Minimum price of the item.","example":0,"type":"number"},"listBrand1BuyTogether":{"description":"Brand first list for the promotion **Buy Together.","example":[],"items":{},"type":"array"},"listCategory1BuyTogether":{"description":"Category first list for the promotion **Buy Together**.","items":{"properties":{"id":{"description":"Category ID.","example":"1","type":"string"},"name":{"description":"Category name.","example":"Vinhos Tintos (1)","type":"string"}},"title":"","type":"object"},"type":"array"},"listSku1BuyTogether":{"description":"SKU first list for the promotion **Buy Together**.","example":[],"items":{},"type":"array"},"listSku2BuyTogether":{"description":"SKU second list for the promotion **Buy Together**.","example":[],"items":{},"type":"array"},"marketingTags":{"description":"Array with all campaign audience's marketing tags.","items":{"description":"Campaign audience marketing tags.","example":"MKT1","type":"string"},"type":"array"},"marketingTagsAreNotInclusive":{"description":"Shows if marketing tags are not inclusive.","example":false,"type":"boolean"},"maxInstallment":{"description":"Maximum value for installment.","example":0,"type":"integer"},"maxUsage":{"description":"Defines how many times the campaign audience can be used.","example":0,"type":"integer"},"maxUsagePerClient":{"description":"Defines if the campaign audience can be used multiple times per client.","example":0,"type":"integer"},"merchants":{"deprecated":true,"items":{},"type":"array"},"minInstallment":{"description":"Minimum value for installment.","example":0,"type":"integer"},"minimumQuantityBuyTogether":{"description":"Minimum quantity for **Buy Together** promotion.","example":1,"type":"integer"},"multipleUsePerClient":{"description":"Defines if the campaign audience can be used multiple times per client.","example":false,"type":"boolean"},"name":{"description":"Target audience name.","example":"Social Sellers","type":"string"},"origin":{"description":"Shows the campaign audience origin, `Marketplace` or `Fulfillment`.  Read [Difference between orders with marketplace and fulfillment sources](https://help.vtex.com/en/tutorial/what-are-orders-with-marketplace-source-and-orders-with-fulfillment-source--6eVYrmUAwMOeKICU2KuG06) for more information.","example":"Marketplace","type":"string"},"paymentsMethods":{"description":"Array composed by all the Payments Methods.","items":{"description":"Object with information of the Payment Method.","properties":{"id":{"description":"Payment Method ID.","example":"2","type":"string"},"name":{"description":"Payment Method Name.","example":"Visa (2)","type":"string"}},"type":"object"},"type":"array"},"paymentsRules":{"deprecated":true,"items":{},"type":"array"},"percentualDiscountValueList":{"description":"Percentual discount value list.","items":{"description":"Percentual discount value.","example":0,"type":"number"},"type":"array"},"products":{"description":"Object composed by the products that will activate or deactivate the campaign audience.","items":{"description":"Object with information of the product.","properties":{"id":{"description":"Product ID.","example":"1","type":"string"},"name":{"description":"Product Name.","example":"Vinho (1)","type":"string"}},"type":"object"},"type":"array"},"productsAreInclusive":{"description":"If set to `true`, this campaign audience will be applied to any product present on the `products` field. If set to `false`, products present on that field will make this campaign audience not to be applied.","example":true,"type":"boolean"},"productsSpecifications":{"deprecated":true,"items":{},"type":"array"},"quantityToAffectBuyTogether":{"description":"Quantity to affect **Buy Together** promotion.","example":0,"type":"integer"},"restrictionsBins":{"description":"The discount will be granted if the card's BIN is given.","items":{"description":"Card's BIN.","example":"1234","type":"string"},"type":"array"},"shouldDistributeDiscountAmongMatchedItems":{"description":"Should distribute discount among matched items.","example":false,"type":"boolean"},"skus":{"description":"Object composed by the SKUs that will activate or deactivate the campaign audience.","items":{"description":"Object with information of the SKU.","properties":{"id":{"description":"SKU ID.","example":"1","type":"string"},"name":{"description":"SKU Name.","example":"Vinho tinto (1)","type":"string"}},"type":"object"},"type":"array"},"skusAreInclusive":{"description":"If set to `true`, this campaign audience will be applied to any SKU present on the `skus` field. If set to `false`, SKUs present on that field will make this campaign audience not to be applied.","example":true,"type":"boolean"},"slasIds":{"description":"The discount will be granted if the shipping method is the same as the one given.","items":{"description":"Shipping method.","example":"Express","type":"string"},"type":"array"},"stores":{"deprecated":true,"items":{},"type":"array"},"storesAreInclusive":{"deprecated":true,"type":"boolean"},"totalValueCeling":{"description":"Maximum chart value to active the campaign audience.","example":0,"type":"number"},"totalValueFloor":{"description":"Minimum chart value to active the campaign audience.","example":40,"type":"number"},"totalValueIncludeAllItems":{"deprecated":true,"type":"boolean"},"totalValueMode":{"description":"Total chart value to active the campaign audience.","example":"IncludeMatchedItems","type":"string"},"totalValuePurchase":{"description":"Total value a client must have in past orders to active the campaign audience.","example":0,"type":"number"},"useNewProgressiveAlgorithm":{"description":"Use new progressive algorithm.","example":false,"type":"boolean"},"zipCodeRanges":{"description":"Range of the zip code that applies the campaign audience.","items":{"description":"Zip code that applies the campaign audience.","properties":{"inclusive":{"description":"Defines if the zip code applies the campaign audience.","example":false,"type":"boolean"}},"type":"object"},"type":"array"}},"type":"object"},"type":"array"}},"title":"","type":"object"}}},"description":"","required":true},"responses":{"200":{"content":{"application/json":{"example":{"beginDateUtc":"2025-08-15T13:51:41.627Z","endDateUtc":"2025-08-15T13:51:41.627Z","id":"dd270d06-1ed1-47fc-b04e-a2431121b5a4","isActive":true,"isAndOperator":false,"isArchived":false,"lastModified":{"dateUtc":"2025-08-15T13:51:41.627Z","user":"email@email.com"},"name":"Interna","targetConfigurations":[{"affiliates":[],"areSalesChannelIdsExclusive":false,"brands":[],"brandsAreInclusive":true,"campaigns":[],"cardIssuers":[],"categories":[],"categoriesAreInclusive":true,"clusterExpressions":[],"collections":[],"collections1BuyTogether":[],"collections2BuyTogether":[],"collectionsIsInclusive":true,"compareListPriceAndPrice":false,"coupon":[],"daysAgoOfPurchases":0,"enableBuyTogetherPerSku":false,"featured":false,"firstBuyIsProfileOptimistic":false,"giftListTypes":[],"id":"77ae1e4c-a216-4b15-a4a3-ae64ec298988","idSellerIsInclusive":false,"idsSalesChannel":[],"installment":0,"isDifferentListPriceAndPrice":false,"isFirstBuy":false,"isMinMaxInstallments":false,"isSlaSelected":false,"itemMaxPrice":0,"itemMinPrice":0,"listBrand1BuyTogether":[],"listCategory1BuyTogether":[],"listSku1BuyTogether":[],"listSku2BuyTogether":[],"marketingTags":["MKT1"],"marketingTagsAreNotInclusive":false,"maxInstallment":0,"maxUsage":0,"maxUsagePerClient":0,"merchants":[],"minInstallment":0,"minimumQuantityBuyTogether":1,"multipleUsePerClient":false,"name":"Social Sellers","origin":"Marketplace","paymentsMethods":[],"paymentsRules":[],"percentualDiscountValueList":[],"products":[],"productsAreInclusive":false,"productsSpecifications":[],"quantityToAffectBuyTogether":0,"restrictionsBins":[],"shouldDistributeDiscountAmongMatchedItems":false,"skus":[],"skusAreInclusive":true,"slasIds":[],"stores":[],"storesAreInclusive":false,"totalValueCeling":0,"totalValueFloor":0,"totalValueIncludeAllItems":false,"totalValueMode":"IncludeMatchedItems","totalValuePurchase":0,"useNewProgressiveAlgorithm":false,"zipCodeRanges":[{"inclusive":true}]}]},"schema":{"properties":{"beginDateUtc":{"description":"Start date of the campaign audience in UTC format.","type":"string"},"endDateUtc":{"description":"End date of the campaign audience in UTC format.","type":"string"},"id":{"description":"Campaign audience ID.","type":"string"},"isActive":{"description":"Defines if the campaign audience is active (`true`) or not (`false`).","type":"boolean"},"isAndOperator":{"description":"When `true`, determines that all the `targetConfigurations` need to be valid for the campaign audience to be active. When `false`, determines that if at least one of the `targetConfigurations` is valid, the campaign audience will be active.","type":"boolean"},"isArchived":{"description":"Defines if the campaign audience is archived (`true`) or not (`false`).","type":"boolean"},"lastModified":{"description":"Object with information about the most recent update of the campaign audience.","properties":{"dateUtc":{"description":"Date of the most recent update in UTC format.","type":"string"},"user":{"description":"Email of the user who updated the campaign audience for the latest time.","type":"string"}},"type":"object"},"name":{"description":"Campaign audience name.","type":"string"},"targetConfigurations":{"description":"Array that contains all target audience that the campaign audience will be valid.","items":{"description":"Object with information about the target audience.","properties":{"affiliates":{"description":"Marketplace order identifier. The discount will apply to selected affiliates.","items":{"description":"Object with information of the affiliate.","properties":{"id":{"description":"Affiliate ID.","type":"string"},"name":{"description":"Affiliate Name.","type":"string"}},"type":"object"},"type":"array"},"areSalesChannelIdsExclusive":{"description":"Defines if the trade policy IDs are exclusive.","type":"boolean"},"brands":{"description":"Object composed by the brands that will activate or deactivate the campaign audience.","items":{"description":"Object with information of the brand.","properties":{"id":{"description":"Brand ID.","type":"string"},"name":{"description":"Brand Name.","type":"string"}},"type":"object"},"type":"array"},"brandsAreInclusive":{"description":"If set to `true`, this campaign audience will be applied to any brand present on the `brands` field. If set to `false`, brands present on that field will make this campaign audience not to be applied.","type":"boolean"},"campaigns":{"description":"Campaign Audiences that activate this promotion.","items":{},"type":"array"},"cardIssuers":{"deprecated":true,"items":{},"type":"array"},"categories":{"description":"Object composed by the categories that will activate or deactivate the campaign audience.","items":{"description":"Object with information of the category.","properties":{"id":{"description":"Category ID.","type":"string"},"name":{"description":"Category Name.","type":"string"}},"type":"object"},"type":"array"},"categoriesAreInclusive":{"description":"If set to `true`, this campaign audience will be applied to any category present on the `categories` field. If set to `false`, categories present on that field will make this campaign audience not to be applied.","type":"boolean"},"clusterExpressions":{"description":"An expression to use with clusters.","items":{"description":"Cluster expression.","type":"string"},"type":"array"},"clusterOperator":{"deprecated":true,"type":"string"},"collections":{"description":"Object composed by the collections that will activate or deactivate the campaign audience.","items":{"description":"Object with information of the collection.","properties":{"id":{"description":"Collection ID.","type":"string"},"name":{"description":"Collection Name.","type":"string"}},"type":"object"},"type":"array"},"collections1BuyTogether":{"description":"Collections that will generate the promotion, type **Buy Together**, **More for less**, **Progressive Discount**, **Buy One Get One**.","items":{"description":"Collection ID.","type":"string"},"type":"array"},"collections2BuyTogether":{"deprecated":true,"items":{},"type":"array"},"collectionsIsInclusive":{"description":"If set to `true`, this campaign audience will be applied to any collection present on the `collections` field. If set to `false`, collections present on that field will make this campaign audience not to be applied.","type":"boolean"},"compareListPriceAndPrice":{"description":"If the **List Price** and **Price** are the same.","type":"boolean"},"coupon":{"deprecated":true,"items":{},"type":"array"},"daysAgoOfPurchases":{"description":"Number of days that are considered to add the purchase history.","type":"integer"},"enableBuyTogetherPerSku":{"description":"Enable **Buy Together** per SKU.","type":"boolean"},"featured":{"description":"Defines if the target audience is feature (`true`) or not (`false`).","type":"boolean"},"firstBuyIsProfileOptimistic":{"description":"Applies the discount even if the user is not logged.","type":"boolean"},"giftListTypes":{"description":"Gifts List Type.","items":{"description":"Gift List Type.","type":"string"},"type":"array"},"id":{"description":"Target audience ID.","type":"string"},"idSellerIsInclusive":{"description":"Defines if at least one of the sellers must be valid to active the campaign audience.","type":"boolean"},"idsSalesChannel":{"description":"Array with all the trade policies that activate the campaign audience.","items":{"description":"Trade policy ID.","type":"string"},"type":"array"},"installment":{"deprecated":true,"type":"integer"},"isDifferentListPriceAndPrice":{"description":"Applies the campaign audience only if the list price and price is different.","type":"boolean"},"isFirstBuy":{"description":"Applies the discount only if it's a first buy.","type":"boolean"},"isMinMaxInstallments":{"description":"Set if the campaign audience will be applied considering a minimum and maximum values for installments.","type":"boolean"},"isSlaSelected":{"description":"Applies selected discount only when one of the defined shipping method is selected by the customer.","type":"boolean"},"itemMaxPrice":{"description":"Maximum price of the item.","type":"number"},"itemMinPrice":{"description":"Minimum price of the item.","type":"number"},"listBrand1BuyTogether":{"description":"Brand first list for the promotion **Buy Together.","items":{},"type":"array"},"listCategory1BuyTogether":{"description":"Category first list for the promotion **Buy Together**.","items":{},"type":"array"},"listSku1BuyTogether":{"description":"SKU first list for the promotion **Buy Together**.","items":{},"type":"array"},"listSku2BuyTogether":{"description":"SKU second list for the promotion **Buy Together**.","items":{},"type":"array"},"marketingTags":{"description":"Array with all the campaign audience's marketing tags.","items":{"description":"Campaign audience marketing tags.","type":"string"},"type":"array"},"marketingTagsAreNotInclusive":{"description":"Defines if marketing tags are not inclusive.","type":"boolean"},"maxInstallment":{"description":"Maximum value for installment.","type":"integer"},"maxUsage":{"description":"Defines how many times the campaign audience can be used.","type":"integer"},"maxUsagePerClient":{"description":"Defines if the campaign audience can be used multiple times per client.","type":"integer"},"merchants":{"deprecated":true,"items":{},"type":"array"},"minInstallment":{"description":"Minimum value for installment.","type":"integer"},"minimumQuantityBuyTogether":{"description":"Minimum quantity for **Buy Together** promotion.","type":"integer"},"multipleUsePerClient":{"description":"Defines if the campaign audience can be used multiple times per client.","type":"boolean"},"name":{"description":"Target audience name.","type":"string"},"origin":{"description":"Shows the campaign audience origin, `Marketplace` or `Fulfillment`.  Read [Difference between orders with marketplace and fulfillment sources](https://help.vtex.com/en/tutorial/what-are-orders-with-marketplace-source-and-orders-with-fulfillment-source--6eVYrmUAwMOeKICU2KuG06) for more information.","type":"string"},"paymentsMethods":{"description":"Array composed by all the Payments Methods.","items":{"description":"Object with information of the Payment Method.","properties":{"id":{"description":"Payment Method ID.","type":"string"},"name":{"description":"Payment Method Name.","type":"string"}},"type":"object"},"type":"array"},"paymentsRules":{"deprecated":true,"items":{},"type":"array"},"percentualDiscountValueList":{"description":"Percentual discount value list.","items":{"description":"Percentual discount value.","type":"number"},"type":"array"},"products":{"description":"Object composed by the products that will activate or deactivate the campaign audience.","items":{"description":"Object with information of the product.","properties":{"id":{"description":"Product ID.","type":"string"},"name":{"description":"Product Name.","type":"string"}},"type":"object"},"type":"array"},"productsAreInclusive":{"description":"If set to `true`, this campaign audience will be applied to any product present on the `products` field. If set to `false`, products present on that field will make this campaign audience not to be applied.","type":"boolean"},"productsSpecifications":{"deprecated":true,"items":{},"type":"array"},"quantityToAffectBuyTogether":{"description":"Quantity to affect **Buy Together** promotion.","type":"integer"},"restrictionsBins":{"description":"The discount will be granted if the card's BIN is given.","items":{"description":"Card's BIN.","type":"string"},"type":"array"},"shouldDistributeDiscountAmongMatchedItems":{"description":"Should distribute discount among matched items.","type":"boolean"},"skus":{"description":"Object composed by the SKUs that will activate or deactivate the campaign audience.","items":{"description":"Object with information of the SKU.","properties":{"id":{"description":"SKU ID.","type":"string"},"name":{"description":"SKU Name.","type":"string"}},"type":"object"},"type":"array"},"skusAreInclusive":{"description":"If set to `true`, this campaign audience will be applied to any SKU present on the `skus` field. If set to `false`, SKUs present on that field will make this campaign audience not to be applied.","type":"boolean"},"slasIds":{"description":"The discount will be granted if the shipping method is the same as the one given.","items":{"description":"Shipping method.","type":"string"},"type":"array"},"stores":{"deprecated":true,"items":{},"type":"array"},"storesAreInclusive":{"deprecated":true,"type":"boolean"},"totalValueCeling":{"description":"Maximum chart value to active the campaign audience.","type":"number"},"totalValueFloor":{"description":"Minimum chart value to active the campaign audience.","type":"number"},"totalValueIncludeAllItems":{"deprecated":true,"type":"boolean"},"totalValueMode":{"description":"Total chart value to active the campaign audience.","type":"string"},"totalValuePurchase":{"description":"Total value a client must have in past orders to active the campaign audience.","type":"number"},"useNewProgressiveAlgorithm":{"description":"Use new progressive algorithm.","type":"boolean"},"zipCodeRanges":{"description":"Range of the zip code that applies the campaign audience.","items":{"description":"Zip code that applies the campaign audience.","properties":{"inclusive":{"description":"Defines if the zip code applies the campaign audience.","type":"boolean"}},"type":"object"},"type":"array"}},"type":"object"},"type":"array"}},"title":"","type":"object"}}},"description":"OK"}},"summary":"Create campaign audience","tags":["Campaign Audiences"]}},"/api/rnb/pvt/campaignConfiguration/{campaignId}":{"get":{"description":"Retrieves a specific campaign audience configuration by its ID. This API uses the campaign ID, not the campaign name.","operationId":"Getcampaignconfiguration","parameters":[{"description":"Describes the type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"Campaign audience unique identifier.","in":"path","name":"campaignId","required":true,"schema":{"example":"dd270d06-1ed1-47fc-b04e-a2431121b5a4","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"example":{"beginDateUtc":"2025-08-15T13:51:41.628Z","endDateUtc":"2025-08-15T13:51:41.628Z","id":"dd270d06-1ed1-47fc-b04e-a2431121b5a4","isActive":true,"isAndOperator":false,"isArchived":false,"lastModified":{"dateUtc":"2025-08-15T13:51:41.628Z","user":"email@email.com"},"name":"Interna","targetConfigurations":[{"affiliates":[],"areSalesChannelIdsExclusive":false,"brands":[],"brandsAreInclusive":true,"campaigns":[],"cardIssuers":[],"categories":[],"categoriesAreInclusive":true,"clusterExpressions":[],"clusterOperator":"all","collections":[],"collections1BuyTogether":[],"collections2BuyTogether":[],"collectionsIsInclusive":true,"compareListPriceAndPrice":false,"coupon":[],"daysAgoOfPurchases":0,"enableBuyTogetherPerSku":false,"featured":false,"firstBuyIsProfileOptimistic":false,"giftListTypes":[],"id":"77ae1e4c-a216-4b15-a4a3-ae64ec298988","idSellerIsInclusive":false,"idsSalesChannel":[],"installment":0,"isDifferentListPriceAndPrice":false,"isFirstBuy":false,"isMinMaxInstallments":false,"isSlaSelected":false,"itemMaxPrice":0,"itemMinPrice":0,"listBrand1BuyTogether":[],"listCategory1BuyTogether":[],"listSku1BuyTogether":[],"listSku2BuyTogether":[],"marketingTags":["MKT1"],"marketingTagsAreNotInclusive":false,"maxInstallment":0,"maxUsage":0,"maxUsagePerClient":0,"merchants":[],"minInstallment":0,"minimumQuantityBuyTogether":1,"multipleUsePerClient":false,"name":"Social Sellers","origin":"Marketplace","paymentsMethods":[],"paymentsRules":[],"percentualDiscountValueList":[],"products":[],"productsAreInclusive":false,"productsSpecifications":[],"quantityToAffectBuyTogether":0,"restrictionsBins":[],"shouldDistributeDiscountAmongMatchedItems":false,"skus":[],"skusAreInclusive":true,"slasIds":[],"stores":[],"storesAreInclusive":false,"totalValueCeling":0,"totalValueFloor":0,"totalValueIncludeAllItems":false,"totalValueMode":"IncludeMatchedItems","totalValuePurchase":0,"useNewProgressiveAlgorithm":false,"zipCodeRanges":[{"inclusive":true}]}]},"schema":{"properties":{"beginDateUtc":{"description":"Start date of the campaign audience in UTC format.","type":"string"},"endDateUtc":{"description":"End date of the campaign audience in UTC format.","type":"string"},"id":{"description":"Campaign audience ID.","type":"string"},"isActive":{"description":"Defines if the campaign audience is active (`true`) or not (`false`).","type":"boolean"},"isAndOperator":{"description":"When `true`, determines that all the `targetConfigurations` need to be valid for the campaign audience to be active. When `false`, determines that if at least one of the `targetConfigurations` is valid, the campaign audience will be active.","type":"boolean"},"isArchived":{"description":"Defines if the campaign audience is archived (`true`) or not (`false`).","type":"boolean"},"lastModified":{"description":"Object with information about the most recent update of the campaign audience.","properties":{"dateUtc":{"description":"Date of the most recent update in UTC format.","type":"string"},"user":{"description":"Email of the user who updated the campaign audience for the latest time.","type":"string"}},"type":"object"},"name":{"description":"Campaign audience name.","type":"string"},"targetConfigurations":{"description":"Array that contains all target audience that the campaign audience will be valid.","items":{"description":"Object with information about the target audience.","properties":{"affiliates":{"description":"Marketplace order identifier. The discount will apply to selected affiliates.","items":{"description":"Object with information of the affiliate.","properties":{"id":{"description":"Affiliate ID.","type":"string"},"name":{"description":"Affiliate Name.","type":"string"}},"type":"object"},"type":"array"},"areSalesChannelIdsExclusive":{"description":"Defines if the trade policy IDs are exclusive.","type":"boolean"},"brands":{"description":"Object composed by the brands that will activate or deactivate the campaign audience.","items":{"description":"Object with information of the brand.","properties":{"id":{"description":"Brand ID.","type":"string"},"name":{"description":"Brand Name.","type":"string"}},"type":"object"},"type":"array"},"brandsAreInclusive":{"description":"If set to `true`, this campaign audience will be applied to any brand present on the `brands` field. If set to `false`, brands present on that field will make this campaign audience not to be applied.","type":"boolean"},"campaigns":{"description":"Campaign Audiences that activate this promotion.","items":{},"type":"array"},"cardIssuers":{"deprecated":true,"items":{},"type":"array"},"categories":{"description":"Object composed by the categories that will activate or deactivate the campaign audience.","items":{"description":"Object with information of the category.","properties":{"id":{"description":"Category ID.","type":"string"},"name":{"description":"Category Name.","type":"string"}},"type":"object"},"type":"array"},"categoriesAreInclusive":{"description":"If set to `true`, this campaign audience will be applied to any category present on the `categories` field. If set to `false`, categories present on that field will make this campaign audience not to be applied.","type":"boolean"},"clusterExpressions":{"description":"An expression to use with clusters.","items":{"description":"Cluster expression.","type":"string"},"type":"array"},"collections":{"description":"Object composed by the collections that will activate or deactivate the campaign audience.","items":{"description":"Object with information of the collection.","properties":{"id":{"description":"Collection ID.","type":"string"},"name":{"description":"Collection Name.","type":"string"}},"type":"object"},"type":"array"},"collections1BuyTogether":{"description":"Collections that will generate the promotion, type **Buy Together**, **More for less**, **Progressive Discount**, **Buy One Get One**.","items":{"description":"Collection ID.","type":"string"},"type":"array"},"collections2BuyTogether":{"deprecated":true,"items":{},"type":"array"},"collectionsIsInclusive":{"description":"If set to `true`, this campaign audience will be applied to any collection present on the `collections` field. If set to `false`, collections present on that field will make this campaign audience not to be applied.","type":"boolean"},"compareListPriceAndPrice":{"description":"If the **List Price** and **Price** are the same.","type":"boolean"},"coupon":{"deprecated":true,"items":{},"type":"array"},"daysAgoOfPurchases":{"description":"Number of days that are considered to add the purchase history.","type":"integer"},"enableBuyTogetherPerSku":{"description":"Enable **Buy Together** per SKU.","type":"boolean"},"featured":{"description":"Defines if the target audience is featured (`true`) or not (`false`).","type":"boolean"},"firstBuyIsProfileOptimistic":{"description":"Applies the discount even if the user is not logged.","type":"boolean"},"giftListTypes":{"description":"Gifts List Type.","items":{"description":"Gift List Type.","type":"string"},"type":"array"},"id":{"description":"Target audience ID.","type":"string"},"idSellerIsInclusive":{"description":"Defines if at least one of the sellers must be valid to active the campaign audience.","type":"boolean"},"idsSalesChannel":{"description":"Array with all the trade policies that activate the campaign audience.","items":{"description":"Trade policy ID.","type":"string"},"type":"array"},"installment":{"deprecated":true,"type":"integer"},"isDifferentListPriceAndPrice":{"description":"Applies the campaign audience only if the list price and price is different.","type":"boolean"},"isFirstBuy":{"description":"Applies the discount only if it's a first buy.","type":"boolean"},"isMinMaxInstallments":{"description":"Set if the campaign audience will be applied considering a minimum and maximum values for installments.","type":"boolean"},"isSlaSelected":{"description":"Applies selected discount only when one of the defined shipping method is selected by the customer.","type":"boolean"},"itemMaxPrice":{"description":"Maximum price of the item.","type":"number"},"itemMinPrice":{"description":"Minimum price of the item.","type":"number"},"listBrand1BuyTogether":{"description":"Brand first list for the promotion **Buy Together.","items":{},"type":"array"},"listCategory1BuyTogether":{"description":"Category first list for the promotion **Buy Together**.","items":{},"type":"array"},"listSku1BuyTogether":{"description":"SKU first list for the promotion **Buy Together**.","items":{},"type":"array"},"listSku2BuyTogether":{"description":"SKU second list for the promotion **Buy Together**.","items":{},"type":"array"},"marketingTags":{"description":"Array with all the campaign audience's marketing tags.","items":{"description":"Campaign audience marketing tags.","type":"string"},"type":"array"},"marketingTagsAreNotInclusive":{"description":"Defines if marketing tags are not inclusive.","type":"boolean"},"maxInstallment":{"description":"Maximum value for installment.","type":"integer"},"maxUsage":{"description":"Defines how many times the campaign audience can be used.","type":"integer"},"maxUsagePerClient":{"description":"Defines if the campaign audience can be used multiple times per client.","type":"integer"},"merchants":{"deprecated":true,"items":{},"type":"array"},"minInstallment":{"description":"Minimum value for installment.","type":"integer"},"minimumQuantityBuyTogether":{"description":"Minimum quantity for **Buy Together** promotion.","type":"integer"},"multipleUsePerClient":{"description":"Defines if the campaign audience can be used multiple times per client.","type":"boolean"},"name":{"description":"Target audience name.","type":"string"},"origin":{"description":"Shows the campaign audience origin, `Marketplace` or `Fulfillment`.  Read [Difference between orders with marketplace and fulfillment sources](https://help.vtex.com/en/tutorial/what-are-orders-with-marketplace-source-and-orders-with-fulfillment-source--6eVYrmUAwMOeKICU2KuG06) for more information.","type":"string"},"paymentsMethods":{"description":"Array composed by all the Payments Methods.","items":{"description":"Object with information of the Payment Method.","properties":{"id":{"description":"Payment Method ID.","type":"string"},"name":{"description":"Payment Method Name.","type":"string"}},"type":"object"},"type":"array"},"paymentsRules":{"deprecated":true,"items":{},"type":"array"},"percentualDiscountValueList":{"description":"Percentual discount value list.","items":{"description":"Percentual discount value.","type":"number"},"type":"array"},"products":{"description":"Object composed by the products that will activate or deactivate the campaign audience.","items":{"description":"Object with information of the product.","properties":{"id":{"description":"Product ID.","type":"string"},"name":{"description":"Product Name.","type":"string"}},"type":"object"},"type":"array"},"productsAreInclusive":{"description":"If set to `true`, this campaign audience will be applied to any product present on the `products` field. If set to `false`, products present on that field will make this campaign audience not to be applied.","type":"boolean"},"productsSpecifications":{"deprecated":true,"items":{},"type":"array"},"quantityToAffectBuyTogether":{"description":"Quantity to affect **Buy Together** promotion.","type":"integer"},"restrictionsBins":{"description":"The discount will be granted if the card's BIN is given.","items":{"description":"Card's BIN.","type":"string"},"type":"array"},"shouldDistributeDiscountAmongMatchedItems":{"description":"Should distribute discount among matched items.","type":"boolean"},"skus":{"description":"Object composed by the SKUs that will activate or deactivate the campaign audience.","items":{"description":"Object with information of the SKU.","properties":{"id":{"description":"SKU ID.","type":"string"},"name":{"description":"SKU Name.","type":"string"}},"type":"object"},"type":"array"},"skusAreInclusive":{"description":"If set to `true`, this campaign audience will be applied to any SKU present on the `skus` field. If set to `false`, SKUs present on that field will make this campaign audience not to be applied.","type":"boolean"},"slasIds":{"description":"The discount will be granted if the shipping method is the same as the one given.","items":{"description":"Shipping method.","type":"string"},"type":"array"},"stores":{"deprecated":true,"items":{},"type":"array"},"storesAreInclusive":{"deprecated":true,"type":"boolean"},"totalValueCeling":{"description":"Maximum chart value to active the campaign audience.","type":"number"},"totalValueFloor":{"description":"Minimum chart value to active the campaign audience.","type":"number"},"totalValueIncludeAllItems":{"deprecated":true,"type":"boolean"},"totalValueMode":{"description":"Total chart value to active the campaign audience.","type":"string"},"totalValuePurchase":{"description":"Total value a client must have in past orders to active the campaign audience.","type":"number"},"useNewProgressiveAlgorithm":{"description":"Use new progressive algorithm.","type":"boolean"},"zipCodeRanges":{"description":"Range of the zip code that applies the campaign audience.","items":{"description":"Zip code that applies the campaign audience.","properties":{"inclusive":{"description":"Defines if the zip code applies the campaign audience.","type":"boolean"}},"type":"object"},"type":"array"}},"type":"object"},"type":"array"}},"title":"","type":"object"}}},"description":"OK"}},"summary":"Get campaign audience configuration","tags":["Campaign Audiences"]}},"/api/rnb/pvt/coupon":{"get":{"description":"\r\n> 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 Promotions and is organized by focusing on the developer's journey.\r\n\r\n Retrieves all coupons from an account.","operationId":"Getall","parameters":[{"description":"","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"example":[{"couponCode":"test","expirationIntervalPerUse":"00:00:00","isArchived":false,"lastModifiedUtc":"2025-08-15T13:51:41.628Z","maxItemsPerClient":10,"utmCampaign":"coupon3","utmSource":"coupon3"},{"couponCode":"test-lucian2","expirationIntervalPerUse":"00:00:00","isArchived":false,"lastModifiedUtc":"2025-08-15T13:51:41.628Z","maxItemsPerClient":10,"utmSource":"cupom3"}],"schema":{"items":{"description":"Object with information about the coupon.","properties":{"couponCode":{"description":"Coupon code.","type":"string"},"expirationIntervalPerUse":{"description":"Coupon expiration interval per use.","type":"string"},"isArchived":{"description":"Defines if the coupon is archived (`true`) or not (`false`).","type":"boolean"},"lastModifiedUtc":{"description":"Date and time of the last update of the coupon in UTC format.","type":"string"},"maxItemsPerClient":{"description":"Maximum items per client that the coupon can be applied.","type":"integer"},"utmCampaign":{"description":"UTM campaign code.","type":"string"},"utmSource":{"description":"UTM source code.","type":"string"}},"title":"","type":"object"},"title":"","type":"array"}}},"description":"OK"}},"summary":"Get all coupons","tags":["Coupons"]},"post":{"description":"Updates information of a specific coupon.","operationId":"Update","parameters":[{"description":"Type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"couponCode":{"description":"Coupon code.","example":"test","type":"string"},"expirationIntervalPerUse":{"description":"Coupon expiration interval per use.","example":"00:00:00","type":"string"},"isArchived":{"description":"Defines if the coupon is archived (`true`) or not (`false`).","example":false,"type":"boolean"},"maxItemsPerClient":{"description":"Maximum items per client that the coupon can be applied.","example":10,"type":"integer"},"utmCampaign":{"description":"UTM campaign code.","example":"coupon3","type":"string"},"utmSource":{"description":"UTM source code.","example":"coupon3","type":"string"}},"required":["utmSource","utmCampaign","couponCode","isArchived","maxItemsPerClient","expirationIntervalPerUse"],"title":"","type":"object"}}},"description":"","required":true},"responses":{"200":{"content":{"application/json":{"example":{"couponCode":"test","expirationIntervalPerUse":"00:00:00","isArchived":false,"lastModifiedUtc":"2025-08-15T13:51:41.628Z","maxItemsPerClient":10,"utmCampaign":"coupon3","utmSource":"coupon3"},"schema":{"properties":{"couponCode":{"description":"Coupon code.","type":"string"},"expirationIntervalPerUse":{"description":"Coupon expiration interval per use.","type":"string"},"isArchived":{"description":"Defines if the coupon is archived (`true`) or not (`false`).","type":"boolean"},"lastModifiedUtc":{"description":"Date and time of the last update of the coupon in UTC format.","type":"string"},"maxItemsPerClient":{"description":"Maximum items per client that the coupon can be applied.","type":"integer"},"utmCampaign":{"description":"UTM campaign code.","type":"string"},"utmSource":{"description":"UTM source code.","type":"string"}},"title":"","type":"object"}}},"description":"OK"}},"summary":"Update coupon","tags":["Coupons"]}},"/api/rnb/pvt/coupon/":{"post":{"description":"Creates a single new coupon.","parameters":[{"description":"Type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"couponCode":{"description":"Coupon code.","example":"summersale10","type":"string"},"expirationIntervalPerUse":{"description":"Coupon expiration interval per use.","example":"00:00:00","type":"string"},"maxItemsPerClient":{"description":"Maximum items per client that the coupon can be applied.","example":10,"type":"integer"},"utmCampaign":{"description":"UTM campaign code.","example":"summer","type":"string"},"utmSource":{"description":"UTM source code.","example":"email","type":"string"}},"required":["utmSource","couponCode","maxItemsPerClient","expirationIntervalPerUse"],"title":"","type":"object"}}}},"responses":{"201":{"content":{"application/json":{"example":{"couponCode":"summersale10","expirationIntervalPerUse":"00:00:00","isArchived":false,"lastModifiedUtc":"2025-08-15T13:51:41.628Z","maxItemsPerClient":10,"utmCampaign":"summer","utmSource":"email"},"schema":{"properties":{"couponCode":{"description":"Coupon code.","type":"string"},"expirationIntervalPerUse":{"description":"Coupon expiration interval per use.","type":"string"},"isArchived":{"description":"Defines if the coupon is archived (`true`) or not (`false`).","type":"boolean"},"lastModifiedUtc":{"description":"Date and time of the last update of the coupon in UTC format.","type":"string"},"maxItemsPerClient":{"description":"Maximum items per client that the coupon can be applied.","type":"integer"},"utmCampaign":{"description":"UTM campaign code.","type":"string"},"utmSource":{"description":"UTM source code.","type":"string"}},"title":"","type":"object"}}},"description":"Created"}},"summary":"Create coupon","tags":["Coupons"]}},"/api/rnb/pvt/coupon/usage/{couponCode}":{"get":{"description":"Retrieves information about the coupon usage.","operationId":"Getusage","parameters":[{"description":"Describes the type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"Coupon Code","in":"path","name":"couponCode","required":true,"schema":{"example":"test","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"example":{"couponCode":"test","hostName":"account","profileUsages":{"23fa76cd-14e1-43ee-93af-0c04c9f6cfd7":{"orderUsage":[{"orderId":"11636716780563-01","usageDateUtc":"2025-08-15T13:51:41.628Z"}]}}},"schema":{"properties":{"couponCode":{"description":"Coupon code.","type":"string"},"hostName":{"description":"Name of the store.","type":"string"},"profileUsages":{"description":"Object with information where and when the coupon was used.","properties":{"profileId":{"description":"Profile ID.","properties":{"orderUsage":{"description":"Array with all the orders that the coupon was used.","items":{"description":"Object with information about the order that the coupon was used.","properties":{"orderId":{"description":"Order ID.","type":"string"},"usageDateUtc":{"description":"Date and time when the coupon was used in the order in UTC format.","type":"string"}},"type":"object"},"type":"array"}},"type":"object"}},"type":"object"}},"title":"","type":"object"}}},"description":"OK"}},"summary":"Get coupon usage","tags":["Coupons"]}},"/api/rnb/pvt/coupon/{couponCode}":{"get":{"description":"Retrieves a specific coupon by its coupon code.","operationId":"Getbycouponcode","parameters":[{"description":"Describes the type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"Coupon Code","in":"path","name":"couponCode","required":true,"schema":{"example":"promo10","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"example":{"couponCode":"test","expirationIntervalPerUse":"00:00:00","isArchived":false,"lastModifiedUtc":"2025-08-15T13:51:41.628Z","maxItemsPerClient":10,"utmSource":"coupon3"},"schema":{"properties":{"couponCode":{"description":"Coupon code.","type":"string"},"expirationIntervalPerUse":{"description":"Coupon expiration interval per use.","type":"string"},"isArchived":{"description":"Defines if the coupon is archived (`true`) or not (`false`).","type":"boolean"},"lastModifiedUtc":{"description":"Date and time of the last update of the coupon in UTC format.","type":"string"},"maxItemsPerClient":{"description":"Maximum items per client that the coupon can be applied.","type":"integer"},"utmCampaign":{"description":"UTM campaign code.","type":"string"},"utmSource":{"description":"UTM source code.","type":"string"}},"title":"","type":"object"}}},"description":"OK"}},"summary":"Get coupon by coupon code","tags":["Coupons"]}},"/api/rnb/pvt/coupons":{"post":{"description":"Generates a massive amount of coupons","operationId":"MassiveGeneration","parameters":[{"description":"Type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"Quantity of coupons to generate","explode":true,"in":"query","name":"quantity","required":true,"schema":{"example":10,"type":"integer"},"style":"form"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"couponCode":{"description":"Coupon code.","example":"ctest","type":"string"},"expirationIntervalPerUse":{"description":"Coupon expiration interval per use.","example":"00:00:00","type":"string"},"maxItemsPerClient":{"description":"Defines if the coupon is archived (`true`) or not (`false`).","example":1,"type":"integer"},"utmCampaign":{"description":"UTM campaign code.","example":"cupom3","type":"string"},"utmSource":{"description":"UTM source code.","example":"cupom3","type":"string"}},"required":["utmSource","utmCampaign","couponCode","maxItemsPerClient","expirationIntervalPerUse"],"title":"","type":"object"}}},"description":"","required":true},"responses":{"200":{"content":{"application/json":{"example":["ctest-7DLKU492HR4MANV","ctest-QUM3U4HUGJ54301","ctest-0KYBWQUKR3WXV4C","ctest-971CX1N55WZSEBY","ctest-9FCQ0UX80F6K4A7","ctest-HWZEJ7D0D9MP3O7","ctest-7PI34QVEERM8A70","ctest-RT47PC2A116O9QO","ctest-F4T3IQBAGQWRVW7","ctest-8C3MS3U594EPQB8"],"schema":{"description":"Array with the generated coupon codes.","items":{"description":"Coupon code.","title":"couponCode","type":"string"},"title":"","type":"array"}}},"description":"OK"}},"summary":"Coupon Massive Generation","tags":["Coupons"]}},"/api/rnb/pvt/import/calculatorConfiguration":{"post":{"description":"Creates a Multiple SKU Promotion. This scenario allows to create a single promotion for multiples SKUs with the Percentage Effect. \r\n> ⚠️ \r\n>\r\n> The limit of SKUs on a Multiple Effects promotion is 400.","parameters":[{"description":"Type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"example":"text/csv","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"Promotion Name.","in":"header","name":"X-VTEX-calculator-name","required":true,"schema":{"example":"Test","type":"string"},"style":"simple"},{"description":"Defines if the Promotion is cumulative with other promotions.","in":"header","name":"X-VTEX-cumulative","required":false,"schema":{"example":false,"type":"boolean"},"style":"simple"},{"description":"This header allows implementing the Promotion in multiples client clusters. You can set the value as `all` - the Promotion will be valid to all the clusters - or `any` - the Promotion will be valid to any of the clusters.","in":"header","name":"X-VTEX-cluster-operator","required":false,"schema":{"example":"any","type":"string"},"style":"simple"},{"description":"Cluster that will be included in the Promotion. To add multiple clusters, create a header for each one of them.","in":"header","name":"X-VTEX-cluster-expression","required":false,"schema":{"example":"cluster_name=true","type":"string"},"style":"simple"},{"description":"Promotion start date.","in":"header","name":"X-VTEX-start-date","required":true,"schema":{"example":"2025-08-15T13:51:41.628Z","type":"string"},"style":"simple"},{"description":"Promotion end date.","in":"header","name":"X-VTEX-end-date","required":true,"schema":{"example":"2025-08-15T13:51:41.628Z","type":"string"},"style":"simple"},{"description":"Condition that will accumulate the Promotion with manual prices or not.","in":"header","name":"X-VTEX-accumulate-with-manual-prices","required":true,"schema":{"example":false,"type":"boolean"},"style":"simple"}],"requestBody":{"content":{"text/csv":{"schema":{"description":"The file must contain the SKU ID and the percentage of the discount. The first line must have the headers `sku` and `effect`. The next lines must be the SKU ID and the percentage, without any spaces. For decimal values, use `.` as in `10.5`. This should be sent as a raw text on the request body.","example":"sku,effect\r\n1,10.5","format":"binary","type":"string"}}}},"responses":{"200":{"description":"OK"}},"summary":"Create Multiple SKU Promotion","tags":["Promotions and Taxes"]}},"/api/rnb/pvt/import/calculatorConfiguration/{promotionId}":{"put":{"description":"Updates information from a Multiple SKU Promotion. This scenario allows to create a single promotion for multiples SKUs with the Percentage Effect.  \r\n> ⚠️ \r\n>\r\n> The limit of SKUs on a Multiple Effects promotion is 400.","parameters":[{"description":"Type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"example":"text/csv","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"Promotion Name.","in":"header","name":"X-VTEX-calculator-name","required":true,"schema":{"example":"Test","type":"string"},"style":"simple"},{"description":"Defines if the Promotion is cumulative with other promotions.","in":"header","name":"X-VTEX-cumulative","required":false,"schema":{"example":false,"type":"boolean"},"style":"simple"},{"description":"This header allows implementing the Promotion in multiples client clusters. You can set the value as `all` - the Promotion will be valid to all the clusters - or `any` - the Promotion will be valid to any of the clusters.","in":"header","name":"X-VTEX-cluster-operator","required":false,"schema":{"example":"any","type":"string"},"style":"simple"},{"description":"Cluster that will be included in the Promotion. To add multiple clusters, create a header for each one of them.","in":"header","name":"X-VTEX-cluster-expression","required":false,"schema":{"example":"cluster_name=true","type":"string"},"style":"simple"},{"description":"Promotion start date.","in":"header","name":"X-VTEX-start-date","required":true,"schema":{"example":"2025-08-15T13:51:41.628Z","type":"string"},"style":"simple"},{"description":"Promotion end date.","in":"header","name":"X-VTEX-end-date","required":true,"schema":{"example":"2025-08-15T13:51:41.628Z","type":"string"},"style":"simple"},{"description":"Condition that will accumulate the Promotion with manual prices or not.","in":"header","name":"X-VTEX-accumulate-with-manual-prices","required":true,"schema":{"example":false,"type":"boolean"},"style":"simple"},{"description":"Promotion unique identifier.","in":"path","name":"promotionId","required":true,"schema":{"example":"dc6b6f59-ec2b-4a13-8490-0d1e0c53ddf9","type":"string"}}],"requestBody":{"content":{"text/csv":{"schema":{"description":"The file must contain the SKU ID and the percentage of the discount. The first line must have the headers `sku` and `effect`. The next lines must be the SKU ID and the percentage, without any spaces. For decimal values, use `.` as in `10.5`. This should be sent as a raw text on the request body.","example":"sku,effect\r\n1,10.5","format":"binary","type":"string"}}}},"responses":{"202":{"description":"Accepted"}},"summary":"Update Multiple SKU Promotion","tags":["Promotions and Taxes"]}},"/api/rnb/pvt/multiple-coupons":{"post":{"description":"Creates multiple coupons with different coupon codes. This endpoint has a throttling of 60 requests per minute.","parameters":[{"description":"Type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"example":[{"couponConfiguration":{"couponCode":"promobf4","expirationIntervalPerUse":"00:00:00","isArchived":false,"maxItemsPerClient":10,"utmCampaign":"bf","utmSource":"fb"},"quantity":1}],"schema":{"items":{"properties":{"couponConfiguration":{"description":"Object that contains all coupon configuration.","example":{"couponCode":"test","expirationIntervalPerUse":"00:00:00","maxItemsPerClient":10,"utmCampaign":"","utmSource":"coupon3"},"properties":{"couponCode":{"description":"Coupon code.","example":"test","title":"couponCode","type":"string"},"expirationIntervalPerUse":{"description":"Coupon expiration interval per use.","example":"00:00:00","title":"expirationIntervalPerUse","type":"string"},"isArchived":{"description":"Defines if the coupon is archived (`true`) or not (`false`).","example":false,"title":"isArchived","type":"boolean"},"maxItemsPerClient":{"description":"Maximum items per client that the coupon can be applied.","example":10,"title":"maxItemsPerClient","type":"integer"},"utmCampaign":{"description":"utmCampaign code.","example":"","title":"utmCampaign","type":"string"},"utmSource":{"description":"utmSource code.","example":"coupon3","title":"utmSource","type":"string"}},"required":["utmSource","utmCampaign","couponCode","maxItemsPerClient","expirationIntervalPerUse"],"title":"couponConfiguration","type":"object"},"quantity":{"description":"Quantity of coupons created. The value must be a minimum of `1` and at maximum `1000`. If the amount is `1`, the coupon code will be the value of the `couponCode` parameter. If the value is greater than `1`, the coupon code will receive a random suffix.","example":1,"title":"quantity","type":"integer"}},"required":["quantity","couponConfiguration"]},"title":"","type":"array"}}}},"responses":{"200":{"content":{"application/json":{"example":["promobf"],"schema":{"description":"Array with the coupon codes that were created.","items":{"description":"Coupon code.","example":"promobf","title":"items","type":"string"},"type":"array"}}},"description":"OK"}},"summary":"Create multiple coupons","tags":["Coupons"]}},"/api/rnb/pvt/taxes/calculatorconfiguration":{"get":{"deprecated":false,"description":"Retrieves all taxes from an account.","operationId":"GetAllTaxes","parameters":[{"description":"Type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"example":{"archivedItems":[],"disabledItems":[],"items":[{"Campaigns":[],"activateGiftsMultiplier":false,"areSalesChannelIdsExclusive":false,"beginDate":"2025-08-15T13:51:41.628Z","description":"Tax applied by the government","endDate":"2025-08-15T13:51:41.628Z","hasMaxPricePerItem":false,"idCalculatorConfiguration":"90f4affc-fea0-424c-a7a7-c69aec7bbdc8","idsSalesChannel":["1"],"isActive":true,"isArchived":false,"isTax":true,"lastModifiedUtc":"2025-08-15T13:51:41.628Z","maxUsage":0,"name":"Government Tax","percentualTax":10,"scope":{"allCatalog":false,"brands":1,"brandsAreInclusive":true,"categories":1,"categoriesAreInclusive":true,"collections":1,"collectionsAreInclusive":true,"products":1,"productsAreInclusive":true,"sellers":0,"sellersAreInclusive":false,"skus":1,"skusAreInclusive":true},"status":"active","type":"tax","utmCampain":"","utmSource":"","utmiCampaign":""}],"limitConfiguration":{"activesCount":1,"limit":100}},"schema":{"properties":{"archivedItems":{"description":"Archived items.","items":{"description":"Archived item.","type":"string"},"type":"array"},"disabledItems":{"description":"Disabled items.","items":{"description":"Disabled item.","type":"string"},"type":"array"},"items":{"$ref":"#/components/schemas/GetTaxes"},"limitConfiguration":{"description":"Limit configuration.","properties":{"activesCount":{"description":"Actives count.","type":"integer"},"limit":{"description":"Limit.","type":"integer"}},"type":"object"}},"title":"","type":"object"}}},"description":"OK"}},"summary":"Get All Taxes","tags":["Promotions and Taxes"]}},"/api/rnb/pvt/unarchive/calculatorConfiguration/{idCalculatorConfiguration}":{"post":{"description":"Unarchives a Promotion or Tax by its ID.","operationId":"UnarchivePromotion","parameters":[{"description":"Type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"Promotion ID or tax ID.","in":"path","name":"idCalculatorConfiguration","required":true,"schema":{"example":"d8a1cd2e-b667-4054-b3ae-b79124c7218e","type":"string"},"style":"simple"}],"responses":{"204":{"description":"No Content"}},"summary":"Unarchive Promotion or Tax","tags":["Promotions and Taxes"]}},"/api/rnb/pvt/unarchive/coupon/{couponCode}":{"post":{"description":"Unarchives a specifc coupon by its coupon code.","operationId":"Unarchivebycouponcode","parameters":[{"description":"Describes the type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"Coupon Code","in":"path","name":"couponCode","required":true,"schema":{"example":"test","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"example":"test","schema":{"description":"Coupon code.","title":"couponCode","type":"string"}}},"description":"OK"}},"summary":"Unarchive coupon by coupon code","tags":["Coupons"]}},"/price-sheet":{"post":{"deprecated":false,"description":"Save price. \n> If your account is using Pricing v2, you should avoid using these routes. Please refer directly to the [Pricing v2 API](https://documenter.getpostman.com/view/101975/vtex-pricing-api/6YsWxKT) \n\n> If you are still using Pricing v1, please [check if your store is able to migrate to take advantage of many more features](https://help.vtex.com/en/faq/how-to-migrate-a-store-to-pricing-v2)","operationId":"Saveprice","parameters":[{"description":"Type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"","explode":true,"in":"query","name":"an","required":true,"schema":{"example":"{{accountName}}","type":"string"},"style":"form"}],"requestBody":{"content":{"application/json":{"example":[{"itemId":2390148,"listPrice":1,"price":1,"salesChannel":1,"sellerId":1,"validFrom":"2025-08-15T13:51:41.628Z","validTo":"2025-08-15T13:51:41.628Z"}],"schema":{"description":"","items":{"$ref":"#/components/schemas/SavepriceRequest"},"type":"array"}}},"description":"","required":true},"responses":{"200":{"description":"OK"}},"servers":[{"url":"https://rnb.{environment}.com.br/api/pricing/pvt","variables":{"environment":{"default":"vtexcommercestable"}}}],"summary":"Save Price","tags":["Prices (Legacy - v1)"]}},"/price-sheet/all/{page}/{pageSize}":{"get":{"deprecated":false,"description":"Get all paged prices. \n> If your account is using Pricing v2, you should avoid using these routes. Please refer directly to the [Pricing v2 API](https://documenter.getpostman.com/view/101975/vtex-pricing-api/6YsWxKT) \n\n> If you are still using Pricing v1, please [check if your store is able to migrate to take advantage of many more features](https://help.vtex.com/en/faq/how-to-migrate-a-store-to-pricing-v2)","operationId":"Getallpaged","parameters":[{"description":"Describes the type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"","explode":true,"in":"query","name":"an","required":true,"schema":{"example":"{{accountName}}","type":"string"},"style":"form"},{"description":"","in":"path","name":"page","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"","in":"path","name":"pageSize","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"description":"OK"}},"servers":[{"url":"https://rnb.{environment}.com.br/api/pricing/pvt","variables":{"environment":{"default":"vtexcommercestable"}}}],"summary":"Get all paged prices","tags":["Prices (Legacy - v1)"]}},"/price-sheet/context":{"post":{"deprecated":false,"description":"Get price by context. \n> If your account is using Pricing v2, you should avoid using these routes. Please refer directly to the [Pricing v2 API](https://documenter.getpostman.com/view/101975/vtex-pricing-api/6YsWxKT) \n\n> If you are still using Pricing v1, please [check if your store is able to migrate to take advantage of many more features](https://help.vtex.com/en/faq/how-to-migrate-a-store-to-pricing-v2)","operationId":"Pricebycontext","parameters":[{"description":"Type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"","explode":true,"in":"query","name":"an","required":true,"schema":{"example":"{{accountName}}","type":"string"},"style":"form"}],"requestBody":{"content":{"application/json":{"example":{"id":6324,"itemId":2390148,"salesChannel":1,"sellerId":"1","validFrom":"2025-08-15T13:51:41.628Z","validTo":"2025-08-15T13:51:41.628Z"},"schema":{"$ref":"#/components/schemas/PricebycontextRequest"}}},"description":"","required":true},"responses":{"200":{"description":"OK"}},"servers":[{"url":"https://rnb.{environment}.com.br/api/pricing/pvt","variables":{"environment":{"default":"vtexcommercestable"}}}],"summary":"Get Price by context","tags":["Prices (Legacy - v1)"]}},"/price-sheet/{skuId}":{"delete":{"deprecated":false,"description":"Delete all prices from an SKU. \n> If your account is using Pricing v2, you should avoid using these routes. Please refer directly to the [Pricing v2 API](https://documenter.getpostman.com/view/101975/vtex-pricing-api/6YsWxKT) \n\n> If you are still using Pricing v1, please [check if your store is able to migrate to take advantage of many more features](https://help.vtex.com/en/faq/how-to-migrate-a-store-to-pricing-v2)","operationId":"DeletebyskuId","parameters":[{"description":"Describes the type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"","explode":true,"in":"query","name":"an","required":true,"schema":{"example":"{{accountName}}","type":"string"},"style":"form"},{"description":"","in":"path","name":"skuId","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"description":"OK"}},"servers":[{"url":"https://rnb.{environment}.com.br/api/pricing/pvt","variables":{"environment":{"default":"exampleParameterValue"}}}],"summary":"Delete Price by SKU Id","tags":["Prices (Legacy - v1)"]},"get":{"deprecated":false,"description":"Price by SKU ID              \n> If your account is using Pricing v2, you should avoid using these routes. Please refer directly to the [Pricing v2 API](https://developers.vtex.com/docs/api-reference/pricing-api)","operationId":"PricebyskuId","parameters":[{"description":"Describes the type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"","explode":true,"in":"query","name":"an","required":true,"schema":{"example":"{{accountName}}","type":"string"},"style":"form"},{"description":"","in":"path","name":"skuId","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"description":"OK"}},"servers":[{"url":"https://rnb.{environment}.com.br/api/pricing/pvt","variables":{"environment":{"default":"vtexcommercestable"}}}],"summary":"Get Price by SKU ID","tags":["Prices (Legacy - v1)"]}},"/price-sheet/{skuId}/{tradePolicy}":{"get":{"deprecated":false,"description":"Retrieve price by SKU ID and Trade Policy. \n> If your account is using Pricing v2, you should avoid using these routes. Please refer directly to the [Pricing v2 API](https://documenter.getpostman.com/view/101975/vtex-pricing-api/6YsWxKT) \n\n> If you are still using Pricing v1, please [check if your store is able to migrate to take advantage of many more features](https://help.vtex.com/en/faq/how-to-migrate-a-store-to-pricing-v2)","operationId":"PricebyskuIdandtradePolicy","parameters":[{"description":"HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"","explode":true,"in":"query","name":"an","required":true,"schema":{"example":"{{accountName}}","type":"string"},"style":"form"},{"description":"Describes the type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"","in":"path","name":"skuId","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"","in":"path","name":"tradePolicy","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"description":"OK"}},"servers":[{"url":"https://rnb.{environment}.com.br/api/pricing/pvt","variables":{"environment":{"default":"vtexcommercestable"}}}],"summary":"Get Price by SKU ID and Trade Policy","tags":["Prices (Legacy - v1)"]}},"/pub/bundles":{"post":{"deprecated":false,"description":"Calculate discounts and taxes","operationId":"Calculatediscountsandtaxes(Bundles)","parameters":[{"description":"Type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"example":{"isShoppingCart":true,"items":[{"id":"160","index":0,"isGift":false,"logisticsInfos":[],"measurementUnit":"un","params":[{"name":"Seller@CatalogSystem","value":"1"},{"name":"product@CatalogSystem","value":"94"}],"priceSheet":[],"priceTags":[],"productSpecifications":[],"quantity":3,"sellerId":"1","unitMultiplier":1}],"origin":"Marketplace","params":[{"name":"product@CatalogSystem","value":"2662"},{"name":"couponCode@Marketing","value":"coupon"}],"profileId":"aa","salesChannel":"1"},"schema":{"$ref":"#/components/schemas/Calculatediscountsandtaxes_Bundles_Request"}}},"description":"","required":true},"responses":{"200":{"description":"OK"}},"servers":[{"url":"http://example.com/.{environment}.com.br/api/rnb","variables":{"environment":{"default":"vtexcommercestable"}}}],"summary":"Calculate discounts and taxes (Bundles)","tags":["Bundles"]}}},"components":{"schemas":{"Calculatediscountsandtaxes_Bundles_Request":{"example":{"isShoppingCart":true,"items":[{"id":"160","index":0,"isGift":false,"logisticsInfos":[],"measurementUnit":"un","params":[{"name":"Seller@CatalogSystem","value":"1"},{"name":"product@CatalogSystem","value":"94"}],"priceSheet":[],"priceTags":[],"productSpecifications":[],"quantity":3,"sellerId":"1","unitMultiplier":1}],"origin":"Marketplace","params":[{"name":"product@CatalogSystem","value":"2662"},{"name":"couponCode@Marketing","value":"coupon"}],"profileId":"aa","salesChannel":"1"},"properties":{"isShoppingCart":{"type":"boolean"},"items":{"description":"","items":{"$ref":"#/components/schemas/Item"},"type":"array"},"origin":{"type":"string"},"params":{"description":"","items":{"$ref":"#/components/schemas/Param"},"type":"array"},"profileId":{"type":"string"},"salesChannel":{"type":"string"}},"required":["isShoppingCart","origin","salesChannel","profileId","items","params"],"title":"Calculatediscountsandtaxes(Bundles)Request","type":"object"},"GetPromotions":{"description":"Array with promotions.","items":{"description":"Object with information about a promotion.","properties":{"Campaigns":{"description":"Array with campaign audiences that activate this promotion.","items":{"description":"Campaign Audience.","example":"Campaign Audience example","type":"string"},"type":"array"},"activateGiftsMultiplier":{"description":"If set as `true`, it activates gifts Multiplier.","example":false,"type":"boolean"},"areSalesChannelIdsExclusive":{"description":"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.","type":"boolean"},"beginDate":{"description":"Promotion Begin Date (UTC).","type":"string"},"description":{"description":"Promotion internal description.","type":"string"},"endDate":{"description":"Promotion End Date (UTC).","type":"string"},"hasMaxPricePerItem":{"description":"Defines if there is a maximum price per item.","type":"boolean"},"idCalculatorConfiguration":{"description":"Promotion ID.","type":"string"},"idsSalesChannel":{"description":"List of Trade Policies that activate this promotion.","items":{"description":"Trade Policy ID.","type":"string"},"type":"array"},"isActive":{"description":"If set as `true` the promotion is activated. If set as `false` the promotion is deactivated.","type":"boolean"},"isArchived":{"description":"If set as `true` the Promotion is archived. If set as `false` the Promotion is not archived.","type":"boolean"},"isTax":{"description":"Defines if it is a tax.","type":"boolean"},"lastModifiedUtc":{"description":"Date and time when the promotion was last modified (UTC).","type":"string"},"maxUsage":{"description":"Defines how many times the promotion can be used.","type":"number"},"name":{"description":"Promotion Name.","type":"string"},"percentualTax":{"description":"Percentual tax applied.","type":"number"},"scope":{"description":"Scope of the promotion.","properties":{"allCatalog":{"description":"Determines if the promotion applies to all products in the Catalog (`true`) or not (`false`).","example":false,"type":"boolean"},"brands":{"description":"Quantity of brands which activate or deactivate the promotion.","example":1,"type":"number"},"brandsAreInclusive":{"description":"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.","example":true,"type":"boolean"},"categories":{"description":"Quantity of categories which activate or deactivate the promotion.","example":1,"type":"number"},"categoriesAreInclusive":{"description":"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.","example":true,"type":"boolean"},"collections":{"description":"Quantity of collections which activate or deactivate the promotion.","example":1,"type":"number"},"collectionsAreInclusive":{"description":"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.","example":true,"type":"boolean"},"products":{"description":"Quantity of products which activate or deactivate the promotion.","example":1,"type":"number"},"productsAreInclusive":{"description":"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.","example":true,"type":"boolean"},"sellers":{"description":"Quantity of sellers which activate or deactivate the promotion.","example":0,"type":"number"},"sellersAreInclusive":{"description":"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.","example":false,"type":"boolean"},"skus":{"description":"Quantity of SKUs which activate or deactivate the promotion.","example":1,"type":"number"},"skusAreInclusive":{"description":"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.","example":true,"type":"boolean"}},"type":"object"},"status":{"description":"Status of the promotion.","type":"string"},"type":{"description":"Defines the type of promotion.","title":"type","type":"string"},"utmCampain":{"description":"utmCampaign code.","type":"string"},"utmSource":{"description":"utmSource code.","type":"string"},"utmiCampaign":{"description":"utmiCampaign code.","type":"string"}},"type":"object"},"title":"items","type":"array"},"GetTaxes":{"description":"Array with taxes.","items":{"description":"Object with information about a tax.","properties":{"Campaigns":{"description":"Array with campaign audiences that activate this tax.","items":{"description":"Campaign Audience.","example":"Campaign Audience example","type":"string"},"type":"array"},"activateGiftsMultiplier":{"description":"If set as `true`, it activates gifts Multiplier.","example":false,"type":"boolean"},"areSalesChannelIdsExclusive":{"description":"If set to `false`, this tax 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 tax not to be applied.","type":"boolean"},"beginDate":{"description":"Tax start date (UTC).","type":"string"},"description":{"description":"Tax internal description.","type":"string"},"endDate":{"description":"Tax end date (UTC).","type":"string"},"hasMaxPricePerItem":{"description":"Defines if there is a maximum price per item.","type":"boolean"},"idCalculatorConfiguration":{"description":"Tax ID.","type":"string"},"idsSalesChannel":{"description":"List of Trade Policies that activate this tax.","items":{"description":"Trade Policy ID.","type":"string"},"type":"array"},"isActive":{"description":"If set as `true` the tax is activated. If set as `false` the tax is deactivated.","type":"boolean"},"isArchived":{"description":"If set as `true` the tax is archived. If set as `false` the tax is not archived.","type":"boolean"},"isTax":{"description":"Defines if it is a tax.","type":"boolean"},"lastModifiedUtc":{"description":"Date and time when the tax was last modified (UTC).","type":"string"},"maxUsage":{"description":"Defines how many times the tax can be used.","type":"number"},"name":{"description":"Tax name.","type":"string"},"percentualTax":{"description":"Percentual tax applied.","type":"number"},"scope":{"description":"Scope of the tax.","properties":{"allCatalog":{"description":"Determines if the tax applies to all products in the Catalog (`true`) or not (`false`).","example":false,"type":"boolean"},"brands":{"description":"Quantity of brands which activate or deactivate the tax.","example":1,"type":"number"},"brandsAreInclusive":{"description":"If set to `true`, this tax will be applied to any brand present on the `brands` field. If set to `false`, brands present on that field will make this tax not to be applied.","example":true,"type":"boolean"},"categories":{"description":"Quantity of categories which activate or deactivate the tax.","example":1,"type":"number"},"categoriesAreInclusive":{"description":"If set to `true`, this tax will be applied to any category present on the `categories` field. If set to `false`, categories present on that field will make this tax not to be applied.","example":true,"type":"boolean"},"collections":{"description":"Quantity of collections which activate or deactivate the tax.","example":1,"type":"number"},"collectionsAreInclusive":{"description":"If set to `true`, this tax will be applied to any collection present on the `collections` field. If set to `false`, collections present on that field will make this tax not to be applied.","example":true,"type":"boolean"},"products":{"description":"Quantity of products which activate or deactivate the tax.","example":1,"type":"number"},"productsAreInclusive":{"description":"If set to `true`, this tax will be applied to any product present on the `products` field. If set to `false`, products present on that field will make this tax not to be applied.","example":true,"type":"boolean"},"sellers":{"description":"Quantity of sellers which activate or deactivate the tax.","example":0,"type":"number"},"sellersAreInclusive":{"description":"If set to `true`, this tax will be applied to any seller present on the `sellers` field. If set to `false`, sellers present on that field will make this tax not to be applied.","example":false,"type":"boolean"},"skus":{"description":"Quantity of SKUs which activate or deactivate the tax.","example":1,"type":"number"},"skusAreInclusive":{"description":"If set to `true`, this tax will be applied to any SKU present on the `skus` field. If set to `false`, SKUs present on that field will make this tax not to be applied.","example":true,"type":"boolean"}},"type":"object"},"status":{"description":"Status of the tax.","type":"string"},"type":{"description":"Defines the type of tax.","title":"type","type":"string"},"utmCampain":{"description":"utmCampaign code.","type":"string"},"utmSource":{"description":"utmSource code.","type":"string"},"utmiCampaign":{"description":"utmiCampaign code.","type":"string"}},"type":"object"},"title":"items","type":"array"},"Item":{"example":{"id":"160","index":0,"isGift":false,"logisticsInfos":[],"measurementUnit":"un","params":[{"name":"Seller@CatalogSystem","value":"1"},{"name":"product@CatalogSystem","value":"94"}],"priceSheet":[],"priceTags":[],"productSpecifications":[],"quantity":3,"sellerId":"1","unitMultiplier":1},"properties":{"id":{"type":"string"},"index":{"format":"int32","type":"integer"},"isGift":{"type":"boolean"},"logisticsInfos":{"description":"","items":{"type":"string"},"type":"array"},"measurementUnit":{"type":"string"},"params":{"description":"","items":{"$ref":"#/components/schemas/Param"},"type":"array"},"priceSheet":{"description":"","items":{"type":"string"},"type":"array"},"priceTags":{"description":"","items":{"type":"string"},"type":"array"},"productSpecifications":{"description":"","items":{"type":"string"},"type":"array"},"quantity":{"format":"int32","type":"integer"},"sellerId":{"type":"string"},"unitMultiplier":{"format":"int32","type":"integer"}},"required":["index","id","quantity","isGift","measurementUnit","unitMultiplier","priceTags","params","priceSheet","logisticsInfos","sellerId","productSpecifications"],"title":"Item","type":"object"},"Param":{"example":{"name":"Seller@CatalogSystem","value":"1"},"properties":{"name":{"type":"string"},"value":{"type":"string"}},"required":["name","value"],"title":"Param","type":"object"},"PricebycontextRequest":{"example":{"id":6324,"itemId":2390148,"salesChannel":1,"sellerId":"1","validFrom":"2025-08-15T13:51:41.629Z","validTo":"2025-08-15T13:51:41.629Z"},"properties":{"id":{"format":"int32","type":"integer"},"itemId":{"format":"int32","type":"integer"},"salesChannel":{"format":"int32","type":"integer"},"sellerId":{"type":"string"},"validFrom":{"type":"string"},"validTo":{"type":"string"}},"required":["id","itemId","salesChannel","sellerId","validFrom","validTo"],"title":"PricebycontextRequest","type":"object"},"SavepriceRequest":{"example":{"itemId":2390148,"listPrice":1,"price":1,"salesChannel":1,"sellerId":1,"validFrom":"2025-08-15T13:51:41.629Z","validTo":"2025-08-15T13:51:41.629Z"},"properties":{"itemId":{"format":"int32","type":"integer"},"listPrice":{"format":"int32","type":"integer"},"price":{"format":"int32","type":"integer"},"salesChannel":{"format":"int32","type":"integer"},"sellerId":{"format":"int32","type":"integer"},"validFrom":{"type":"string"},"validTo":{"type":"string"}},"required":["itemId","salesChannel","sellerId","price","listPrice","validFrom","validTo"],"title":"SavepriceRequest","type":"object"},"UsagenotificationRequest":{"example":{"accountId":"ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj","calculatorIds":["discount_basetestqa_1"],"coupon":"cupom","itemsCount":4,"orderId":"vbbbbbb-1","profileId":"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee","used":true},"properties":{"accountId":{"type":"string"},"calculatorIds":{"description":"","items":{"type":"string"},"type":"array"},"coupon":{"type":"string"},"itemsCount":{"format":"int32","type":"integer"},"orderId":{"type":"string"},"profileId":{"type":"string"},"used":{"type":"boolean"}},"required":["orderId","profileId","accountId","calculatorIds","used","coupon","itemsCount"],"title":"UsagenotificationRequest","type":"object"},"ZipCodeRange":{"example":{"inclusive":true},"properties":{"inclusive":{"type":"boolean"}},"required":["inclusive"],"title":"ZipCodeRange","type":"object"}},"securitySchemes":{"appKey":{"in":"header","name":"X-VTEX-API-AppKey","type":"apiKey"},"appToken":{"in":"header","name":"X-VTEX-API-AppToken","type":"apiKey"}}}}