openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 197 kB
JSON
{"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-06-15T13:48:48.871Z","description":"","endDate":"2025-06-15T13:48:48.871Z","hasMaxPricePerItem":false,"idCalculatorConfiguration":"05558233-b415-4f2e-9822-ebdb3918623b","idsSalesChannel":[],"isActive":false,"isArchived":true,"isTax":false,"lastModifiedUtc":"2025-06-15T13:48:48.871Z","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-06-15T13:48:48.871Z","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-06-15T13:48:48.871Z","description":"My description","endDate":"2025-06-15T13:48:48.871Z","hasMaxPricePerItem":false,"idCalculatorConfiguration":"90f4affc-fea0-424c-a7a7-c69aec7bbdc8","idsSalesChannel":["1"],"isActive":false,"isArchived":true,"isTax":true,"lastModifiedUtc":"2025-06-15T13:48:48.871Z","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-06-15T13:48:48.871Z","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-06-15T13:48:48.871Z","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-06-15T13:48:48.871Z","description":"","hasMaxPricePerItem":false,"idCalculatorConfiguration":"7c946926-7815-4446-9428-83bd577a9135","idsSalesChannel":[],"isActive":true,"isArchived":false,"isTax":false,"lastModifiedUtc":"2025-06-15T13:48:48.871Z","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-06-15T13:48:48.871Z","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-06-15T13:48:48.871Z","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-06-15T13:48:48.871Z","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-06-15T13:48:48.871Z","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-06-15T13:48:48.871Z","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-06-15T13:48:48.871Z","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-06-15T13:48:48.871Z","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"},