From 0e820f02f2faee63b5a0f690b50af9309f5cc7a4 Mon Sep 17 00:00:00 2001 From: Geise Costa Date: Fri, 6 Sep 2024 09:17:03 -0300 Subject: [PATCH 1/6] Error fixed in description --- VTEX - Promotions & Taxes API.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/VTEX - Promotions & Taxes API.json b/VTEX - Promotions & Taxes API.json index 5f5b85331..e158a78d4 100644 --- a/VTEX - Promotions & Taxes API.json +++ b/VTEX - Promotions & Taxes API.json @@ -767,7 +767,7 @@ { "name": "quantity", "in": "query", - "description": "Quantity of coupons to generate", + "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.", "required": true, "style": "form", "explode": true, @@ -807,7 +807,7 @@ }, "maxItemsPerClient": { "type": "integer", - "description": "Defines if the coupon is archived (`true`) or not (`false`).", + "description": "Maximum items per client that the coupon can be applied.", "example": 1 }, "expirationIntervalPerUse": { From 1404f4008d8ebc79b08ce161ae09af3568cc7df0 Mon Sep 17 00:00:00 2001 From: geisecosta <> Date: Fri, 6 Sep 2024 12:19:20 +0000 Subject: [PATCH 2/6] Update generated files by portman --- .../VTEX - Promotions & Taxes API.json | 2303 +++++------------ 1 file changed, 710 insertions(+), 1593 deletions(-) diff --git a/PostmanCollections/VTEX - Promotions & Taxes API.json b/PostmanCollections/VTEX - Promotions & Taxes API.json index b58f56626..c280933ce 100644 --- a/PostmanCollections/VTEX - Promotions & Taxes API.json +++ b/PostmanCollections/VTEX - Promotions & Taxes API.json @@ -1,10 +1,10 @@ { "_": { - "postman_id": "0773edd2-3716-4595-9075-7a1efb8e0bd1" + "postman_id": "1986f854-2a78-401b-989a-49d587240f5f" }, "item": [ { - "id": "54a90999-407c-46ce-a84b-f50657f5d2e8", + "id": "cd8a3ddb-c4de-4e30-976c-2ec591de5bd7", "name": "Promotions and taxes", "description": { "content": "", @@ -12,7 +12,7 @@ }, "item": [ { - "id": "b1c9b2fa-0295-414d-b3fb-24480f75d7f6", + "id": "0efdfb4a-50ca-4038-9e16-9bafb7971906", "name": "Get all promotions", "request": { "name": "Get all promotions", @@ -32,26 +32,7 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ { @@ -71,16 +52,21 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "GET" + "method": "GET", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, - "id": "4329e244-f47c-44f0-a51e-c2c4afff5d15", + "id": "c371c7af-045f-4147-ac3b-0e549e2dcff2", "name": "OK", "originalRequest": { "url": { @@ -95,36 +81,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -146,6 +105,14 @@ { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "GET", @@ -167,7 +134,7 @@ { "listen": "test", "script": { - "id": "e55f13ff-bf2a-4189-8587-8080b84f380f", + "id": "cd3e9ecb-6e98-43af-aca9-ca8eeb747f5b", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/rnb/pvt/benefits/calculatorconfiguration - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -183,7 +150,7 @@ } }, { - "id": "277bff73-4c77-4b16-9bd9-9e7bf6eb8507", + "id": "f976c00b-84e2-4971-96e5-07e60382e3dc", "name": "Search promotion by name", "request": { "name": "Search promotion by name", @@ -214,26 +181,7 @@ "value": "shirt" } ], - "variable": [ - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ { @@ -253,16 +201,21 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "GET" + "method": "GET", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, - "id": "df05e675-06f1-437c-83cc-868690b95092", + "id": "f438b939-0209-44f3-9988-2e58a12413ad", "name": "OK", "originalRequest": { "url": { @@ -279,40 +232,18 @@ ], "query": [ { - "key": "byName", - "value": "shirt" - } - ], - "variable": [ - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { + "disabled": false, "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", + "content": "(Required) Search term used to find a promotion by name.", "type": "text/plain" }, - "type": "any", - "value": "{{environment}}", - "key": "environment" + "key": "byName", + "value": "shirt" } - ] + ], + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -334,6 +265,14 @@ { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "GET", @@ -355,13 +294,13 @@ { "listen": "test", "script": { - "id": "b098845f-eb51-4813-881a-9e793e927061", + "id": "71daf1fb-e481-446c-85d8-7a500c7aeb97", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/rnb/pvt/benefits/calculatorconfiguration/search - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[GET]::/api/rnb/pvt/benefits/calculatorconfiguration/search - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[GET]::/api/rnb/pvt/benefits/calculatorconfiguration/search - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"type\":\"array\",\"description\":\"List of promotions whose name matches the search.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information about a promotion.\",\"properties\":{\"idCalculatorConfiguration\":{\"type\":\"string\",\"description\":\"Promotion ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Promotion Name.\"},\"description\":{\"type\":\"string\",\"description\":\"Promotion internal description.\"},\"beginDateUtc\":{\"type\":\"string\",\"description\":\"Promotion Begin Date (UTC).\"},\"endDateUtc\":{\"type\":\"string\",\"description\":\"Promotion End Date (UTC).\"},\"lastModified\":{\"type\":\"string\",\"description\":\"When the Promotion was last modified.\"},\"daysAgoOfPurchases\":{\"type\":\"integer\",\"description\":\"Number of days that are considered to add the purchase history.\"},\"isActive\":{\"type\":\"boolean\",\"description\":\"If set as `true` the Promotion is activated. If set as `false` the Promotion is deactivated.\"},\"isArchived\":{\"type\":\"boolean\",\"description\":\"If set as `true` the Promotion is archived. If set as `false` the Promotion is not archived.\"},\"isFeatured\":{\"type\":\"boolean\",\"description\":\"Insert a flag with the promotion name used in the product's window display and page.\"},\"disableDeal\":{\"type\":\"boolean\",\"deprecated\":true,\"description\":\"Indicates whether a deal is disabled (`true`) or not (`false`).\"},\"activeDaysOfWeek\":{\"type\":\"array\",\"description\":\"Defines which days of the week the promotion will applied.\",\"items\":{\"type\":\"string\",\"description\":\"Day of the week that the promotion will be valid.\"}},\"offset\":{\"type\":\"integer\",\"description\":\"Time offset from UTC in seconds.\"},\"activateGiftsMultiplier\":{\"type\":\"boolean\",\"description\":\"If set as `true`, it activates gifts Multiplier.\"},\"newOffset\":{\"type\":\"number\",\"description\":\"New time offset from UTC in seconds.\"},\"maxPricesPerItems\":{\"type\":\"array\",\"deprecated\":true,\"description\":\"List of prices per items.\",\"items\":{\"type\":\"string\",\"description\":\"Price.\"}},\"cumulative\":{\"type\":\"boolean\",\"description\":\"Defines if a promotion can accumulate with another one. (`true`) or not (`false`).\"},\"effectType\":{\"type\":\"string\",\"description\":\"The type of effect that will apply to the promotion.\"},\"discountType\":{\"type\":\"string\",\"description\":\"The type of discount that will apply to the promotion.\"},\"nominalShippingDiscountValue\":{\"type\":\"number\",\"description\":\"Exact discount to be applied for the shipping value.\"},\"absoluteShippingDiscountValue\":{\"type\":\"number\",\"description\":\"Maximum value for the shipping.\"},\"nominalDiscountValue\":{\"type\":\"number\",\"description\":\"Exact discount to be applied for the total purchase value.\"},\"nominalDiscountType\":{\"type\":\"string\",\"description\":\"Controls the behavior of the `NominalDiscount` effect. This field only accepts two string values:\\r\\n-`item`: applies the intended nominal discount on every item present on the cart. \\r\\n-`cart`: keeps the behavior as it currently is: the whole order/cart receives a nominal discount that is distributed among the items.\"},\"maximumUnitPriceDiscount\":{\"type\":\"number\",\"description\":\"The maximum price for each item of the purchase will be the price set up.\"},\"percentualDiscountValue\":{\"type\":\"number\",\"description\":\"Percentage discount to be applied for total purchase value.\"},\"rebatePercentualDiscountValue\":{\"type\":\"number\",\"description\":\"Percentual Shipping Discount Value.\"},\"percentualShippingDiscountValue\":{\"type\":\"number\",\"description\":\"Percentage discount to be applied for shipping value.\"},\"percentualTax\":{\"type\":\"number\",\"description\":\"Percentual tax over purchase total value.\"},\"shippingPercentualTax\":{\"type\":\"number\",\"description\":\"Shipping Percentual tax over purchase total value.\"},\"percentualDiscountValueList1\":{\"type\":\"number\",\"description\":\"Valid discounts for the SKUs in `listSku1BuyTogether`, discount list used for Buy Together Promotions.\"},\"percentualDiscountValueList2\":{\"type\":\"number\",\"description\":\"Equivalent to `percentualDiscountValueList1`.\"},\"skusGift\":{\"type\":\"object\",\"description\":\"SKU Gift Object. Total discount on the product value set as a gift.\",\"properties\":{\"quantitySelectable\":{\"type\":\"integer\",\"description\":\"Quantity of SKU Gifts.\"},\"gifts\":{\"type\":\"integer\",\"description\":\"Array with SKU Gifts IDs.\"}}},\"nominalRewardValue\":{\"type\":\"number\",\"description\":\"Nominal value for rewards program.\"},\"percentualRewardValue\":{\"type\":\"number\",\"description\":\"Percentage value for rewards program.\"},\"orderStatusRewardValue\":{\"type\":\"string\",\"description\":\"Order status reward value.\"},\"maxNumberOfAffectedItems\":{\"type\":\"integer\",\"description\":\"The maximum number of affected items for a promotion.\"},\"maxNumberOfAffectedItemsGroupKey\":{\"type\":\"string\",\"description\":\"The maximum number of affected items by group key for a promotion.\"},\"applyToAllShippings\":{\"type\":\"boolean\",\"description\":\"Promotion will be applied to all kind of shipping.\"},\"nominalTax\":{\"type\":\"number\",\"description\":\"Nominal tax.\"},\"origin\":{\"type\":\"string\",\"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.\"},\"idSeller\":{\"type\":\"string\",\"description\":\"Seller Name.\"},\"idSellerIsInclusive\":{\"type\":\"boolean\",\"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.\"},\"idsSalesChannel\":{\"type\":\"array\",\"description\":\"List of Trade Policies that activate this promotion.\",\"items\":{\"type\":\"string\",\"description\":\"Trade policy ID.\"}},\"areSalesChannelIdsExclusive\":{\"type\":\"boolean\",\"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.\"},\"marketingTags\":{\"type\":\"array\",\"description\":\"Promotion Marketing tags.\",\"items\":{\"type\":\"string\",\"description\":\"Promotion Marketing tag.\"}},\"marketingTagsAreNotInclusive\":{\"type\":\"boolean\",\"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.\"},\"paymentsMethods\":{\"type\":\"array\",\"description\":\"Array composed by all the Payments Methods.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the Payment Method.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Payment Method ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Payment Method Name.\"}}}},\"stores\":{\"type\":\"array\",\"deprecated\":true,\"description\":\"List of stores.\",\"items\":{\"type\":\"string\",\"description\":\"Store.\"}},\"campaigns\":{\"type\":\"array\",\"description\":\"Campaign Audiences that activate this promotion.\",\"items\":{\"type\":\"string\",\"description\":\"Campaign audience.\"}},\"conditionsIds\":{\"type\":\"array\",\"description\":\"Array with conditions IDs.\",\"items\":{\"type\":\"string\",\"description\":\"Condition ID.\"}},\"storesAreInclusive\":{\"type\":\"boolean\",\"deprecated\":true,\"description\":\"If set to `true`, this promotion will be applied to any store present on the `stores` field. If set to `false`, stores present on that field will make this promotion not to be applied.\"},\"categories\":{\"type\":\"array\",\"description\":\"Object composed by the categories that will activate or deactivate the promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the category.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Category ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Category Name.\"}}}},\"categoriesAreInclusive\":{\"type\":\"boolean\",\"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.\"},\"brands\":{\"type\":\"array\",\"description\":\"Object composed by the brands that will activate or deactivate the promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the brand.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Brand ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Brand Name.\"}}}},\"brandsAreInclusive\":{\"type\":\"boolean\",\"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.\"},\"products\":{\"type\":\"array\",\"description\":\"Object composed by the products that will activate or deactivate the promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the product.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Product Name.\"}}}},\"productsAreInclusive\":{\"type\":\"boolean\",\"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.\"},\"skus\":{\"type\":\"array\",\"description\":\"Object composed by the SKUs that will activate or deactivate the promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the SKU.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SKU ID.\"},\"name\":{\"type\":\"string\",\"description\":\"SKU Name.\"}}}},\"skusAreInclusive\":{\"type\":\"boolean\",\"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.\"},\"utmSource\":{\"type\":\"string\",\"description\":\"Coupon utmSource code.\"},\"utmCampaign\":{\"type\":\"string\",\"description\":\"Coupon utmCampaign code.\"},\"collections1BuyTogether\":{\"type\":\"array\",\"description\":\"Collections that will generate the promotion, type **Buy Together**, **More for less**, **Progressive Discount**, **Buy One Get One**.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the collection to be added to the first list of the **Buy Together** promotion.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the collection to be added to the first list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the collection to be added to the first list of the **Buy Together** promotion.\"}}}},\"collections2BuyTogether\":{\"type\":\"array\",\"deprecated\":true,\"description\":\"Collections that will generate the promotion, type **Buy Together**, **More for less**, **Progressive Discount** or **Buy One Get One**.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the collection to be added to the first list of the **Buy Together** promotion.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the collection to be added to the first list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the collection to be added to the first list of the **Buy Together** promotion.\"}}}},\"minimumQuantityBuyTogether\":{\"type\":\"integer\",\"description\":\"Minimum quantity for **Buy Together** promotion.\"},\"quantityToAffectBuyTogether\":{\"type\":\"integer\",\"description\":\"Quantity to affect **Buy Together** promotion.\"},\"enableBuyTogetherPerSku\":{\"type\":\"boolean\",\"description\":\"Enable **Buy Together** per SKU.\"},\"listSku1BuyTogether\":{\"type\":\"array\",\"description\":\"Array of objects, each containing ID and Name of an SKU to be added in the first list of the **Buy Together** promotion. Learn more about this type of promotion in the [Creating a Buy Together promotion](https://help.vtex.com/en/tutorial/buy-together--tutorials_323) documentation.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the SKU to be added to the first list of the **Buy Together** promotion. Learn more about this type of promotion in the [Creating a Buy Together promotion](https://help.vtex.com/en/tutorial/buy-together--tutorials_323) documentation.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the SKU to be added to the first list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the SKU to be added to the first list of the **Buy Together** promotion.\"}}}},\"listSku2BuyTogether\":{\"type\":\"array\",\"description\":\"Array of objects, each containing ID and Name of an SKU to be added to the second list of the **Buy Together** promotion. Learn more about this type of promotion in the [Creating a Buy Together promotion](https://help.vtex.com/en/tutorial/buy-together--tutorials_323) documentation.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the SKU to be added to the second list of the **Buy Together** promotion. Learn more about this type of promotion in the [Creating a Buy Together promotion](https://help.vtex.com/en/tutorial/buy-together--tutorials_323) documentation.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the SKU to be added to the second list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the SKU to be added to the second list of the **Buy Together** promotion.\"}}}},\"coupon\":{\"type\":\"array\",\"deprecated\":true,\"description\":\"List of coupons.\",\"items\":{\"type\":\"string\",\"description\":\"Coupon code.\"}},\"totalValueFloor\":{\"type\":\"number\",\"description\":\"Minimum chart value to activate the promotion.\"},\"totalValueCeling\":{\"type\":\"number\",\"description\":\"Maximum chart value to activate the promotion.\"},\"totalValueIncludeAllItems\":{\"type\":\"boolean\",\"deprecated\":true,\"description\":\"Total value including all items.\"},\"totalValueMode\":{\"type\":\"string\",\"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`.\"},\"collections\":{\"type\":\"array\",\"description\":\"Array composed by the collections that will be activated or deactivated the promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the collection.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Collection ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Collection Name.\"}}}},\"collectionsIsInclusive\":{\"type\":\"boolean\",\"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.\"},\"restrictionsBins\":{\"type\":\"array\",\"description\":\"The discount will be granted if the card's BIN is given.\",\"items\":{\"type\":\"string\",\"description\":\"Card's BIN.\"}},\"cardIssuers\":{\"type\":\"array\",\"deprecated\":true,\"description\":\"List of card issuers.\",\"items\":{\"type\":\"string\",\"description\":\"Card issuer.\"}},\"totalValuePurchase\":{\"type\":\"number\",\"description\":\"Total value a client must have in past orders to active the promotion.\"},\"slasIds\":{\"type\":\"array\",\"description\":\"The discount will be granted if the shipping method is the same as the one given.\",\"items\":{\"type\":\"string\",\"description\":\"Shipping method.\"}},\"isSlaSelected\":{\"type\":\"boolean\",\"description\":\"Applies selected discount only when one of the defined shipping method is selected by the customer.\"},\"isFirstBuy\":{\"type\":\"boolean\",\"description\":\"Applies the discount only if it's a first buy.\"},\"firstBuyIsProfileOptimistic\":{\"type\":\"boolean\",\"description\":\"Applies the discount even if the user is not logged.\"},\"compareListPriceAndPrice\":{\"type\":\"boolean\",\"description\":\"If the **List Price** and **Price** are the same.\"},\"isDifferentListPriceAndPrice\":{\"type\":\"boolean\",\"description\":\"Applies the promotion only if the list price and price is different.\"},\"zipCodeRanges\":{\"type\":\"array\",\"description\":\"Range of the zip code that applies the promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the Zip Code\",\"properties\":{\"zipCodeFrom\":{\"type\":\"string\",\"description\":\"Initial Zip Code.\"},\"zipCodeTo\":{\"type\":\"string\",\"description\":\"Final Zip Code.\"},\"inclusive\":{\"type\":\"boolean\",\"description\":\"Defines if the zip code range is included in the promotion.\"}}}},\"itemMaxPrice\":{\"type\":\"number\",\"description\":\"Maximum price of the item.\"},\"itemMinPrice\":{\"type\":\"number\",\"description\":\"Minimum price of the item.\"},\"installment\":{\"type\":\"integer\",\"deprecated\":true,\"description\":\"Installment.\"},\"isMinMaxInstallments\":{\"type\":\"boolean\",\"description\":\"Set if the promotion will be applied considering a minimum and maximum values for installments.\"},\"minInstallment\":{\"type\":\"integer\",\"description\":\"Minimum value for installment.\"},\"maxInstallment\":{\"type\":\"integer\",\"description\":\"Maximum value for installment.\"},\"merchants\":{\"type\":\"array\",\"deprecated\":true,\"description\":\"List of merchants.\",\"items\":{\"type\":\"string\",\"description\":\"Merchant.\"}},\"clusterExpressions\":{\"type\":\"array\",\"description\":\"Criteria to select a customer cluster. Each item in this array should follow the format of an equality function (`{propertyname}={value}`) or the format of a contains function (`{propertyname} contains {value}`). In both options, `{propertyname}` must be replaced with the name of the field in the data entity, and `{value}` must be replaced with the value determined in Master Data. Find more information about these criteria in [Filling in the Customer cluster field](https://help.vtex.com/tutorial/creating-promotion-for-a-customer-cluster--tutorials_342#filling-in-the-customer-cluster-field).\",\"items\":{\"type\":\"string\",\"description\":\"Cluster expression.\"}},\"clusterOperator\":{\"type\":\"string\",\"deprecated\":true,\"description\":\"Cluster operator.\"},\"paymentsRules\":{\"type\":\"array\",\"deprecated\":true,\"description\":\"List of payment rules.\",\"items\":{\"type\":\"string\",\"description\":\"Payment rule.\"}},\"giftListTypes\":{\"type\":\"array\",\"description\":\"Gifts List Type.\",\"items\":{\"type\":\"string\",\"description\":\"Gift List Type.\"}},\"productsSpecifications\":{\"type\":\"array\",\"deprecated\":true,\"description\":\"List of product specifications.\",\"items\":{\"type\":\"string\",\"description\":\"Product specification.\"}},\"affiliates\":{\"type\":\"array\",\"description\":\"Marketplace order identifier. The discount will apply to selected affiliates.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the affiliate.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Affiliate ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Affiliate Name.\"}}}},\"maxUsage\":{\"type\":\"integer\",\"description\":\"Defines how many times the promotion can be used.\"},\"maxUsagePerClient\":{\"type\":\"integer\",\"description\":\"Defines if the promotion can be used multiple times per client.\"},\"shouldDistributeDiscountAmongMatchedItems\":{\"type\":\"boolean\",\"description\":\"Should distribute discount among matched items.\"},\"multipleUsePerClient\":{\"type\":\"boolean\",\"description\":\"Defines if the promotion can be used multiple times per client.\"},\"accumulateWithManualPrice\":{\"type\":\"boolean\",\"description\":\"Allows the promotion to apply to products whose prices have been manually added by a call center operator.\"},\"type\":{\"type\":\"string\",\"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).\"},\"useNewProgressiveAlgorithm\":{\"type\":\"boolean\",\"description\":\"Use new progressive algorithm.\"},\"percentualDiscountValueList\":{\"type\":\"array\",\"description\":\"Percentual discount value list.\",\"items\":{\"type\":\"number\",\"description\":\"Percentual discount value.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/rnb/pvt/benefits/calculatorconfiguration/search - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"type\":\"array\",\"description\":\"List of promotions whose name matches the search.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information about a promotion.\",\"properties\":{\"idCalculatorConfiguration\":{\"type\":\"string\",\"description\":\"Promotion ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Promotion Name.\"},\"description\":{\"type\":\"string\",\"description\":\"Promotion internal description.\"},\"beginDateUtc\":{\"type\":\"string\",\"description\":\"Promotion Begin Date (UTC).\"},\"endDateUtc\":{\"type\":\"string\",\"description\":\"Promotion End Date (UTC).\"},\"lastModified\":{\"type\":\"string\",\"description\":\"When the Promotion was last modified.\"},\"daysAgoOfPurchases\":{\"type\":\"integer\",\"description\":\"Number of days that are considered to add the purchase history.\"},\"isActive\":{\"type\":\"boolean\",\"description\":\"If set as `true` the Promotion is activated. If set as `false` the Promotion is deactivated.\"},\"isArchived\":{\"type\":\"boolean\",\"description\":\"If set as `true` the Promotion is archived. If set as `false` the Promotion is not archived.\"},\"isFeatured\":{\"type\":\"boolean\",\"description\":\"Insert a flag with the promotion name used in the product's window display and page.\"},\"disableDeal\":{\"type\":\"boolean\",\"description\":\"Indicates whether a deal is disabled (`true`) or not (`false`).\"},\"activeDaysOfWeek\":{\"type\":\"array\",\"description\":\"Defines which days of the week the promotion will applied.\",\"items\":{\"type\":\"string\",\"description\":\"Day of the week that the promotion will be valid.\"}},\"offset\":{\"type\":\"integer\",\"description\":\"Time offset from UTC in seconds.\"},\"activateGiftsMultiplier\":{\"type\":\"boolean\",\"description\":\"If set as `true`, it activates gifts Multiplier.\"},\"newOffset\":{\"type\":\"number\",\"description\":\"New time offset from UTC in seconds.\"},\"maxPricesPerItems\":{\"type\":\"array\",\"description\":\"List of prices per items.\",\"items\":{\"type\":\"string\",\"description\":\"Price.\"}},\"cumulative\":{\"type\":\"boolean\",\"description\":\"Defines if a promotion can accumulate with another one. (`true`) or not (`false`).\"},\"effectType\":{\"type\":\"string\",\"description\":\"The type of effect that will apply to the promotion.\"},\"discountType\":{\"type\":\"string\",\"description\":\"The type of discount that will apply to the promotion.\"},\"nominalShippingDiscountValue\":{\"type\":\"number\",\"description\":\"Exact discount to be applied for the shipping value.\"},\"absoluteShippingDiscountValue\":{\"type\":\"number\",\"description\":\"Maximum value for the shipping.\"},\"nominalDiscountValue\":{\"type\":\"number\",\"description\":\"Exact discount to be applied for the total purchase value.\"},\"nominalDiscountType\":{\"type\":\"string\",\"description\":\"Controls the behavior of the `NominalDiscount` effect. This field only accepts two string values:\\r\\n-`item`: applies the intended nominal discount on every item present on the cart. \\r\\n-`cart`: keeps the behavior as it currently is: the whole order/cart receives a nominal discount that is distributed among the items.\"},\"maximumUnitPriceDiscount\":{\"type\":\"number\",\"description\":\"The maximum price for each item of the purchase will be the price set up.\"},\"percentualDiscountValue\":{\"type\":\"number\",\"description\":\"Percentage discount to be applied for total purchase value.\"},\"rebatePercentualDiscountValue\":{\"type\":\"number\",\"description\":\"Percentual Shipping Discount Value.\"},\"percentualShippingDiscountValue\":{\"type\":\"number\",\"description\":\"Percentage discount to be applied for shipping value.\"},\"percentualTax\":{\"type\":\"number\",\"description\":\"Percentual tax over purchase total value.\"},\"shippingPercentualTax\":{\"type\":\"number\",\"description\":\"Shipping Percentual tax over purchase total value.\"},\"percentualDiscountValueList1\":{\"type\":\"number\",\"description\":\"Valid discounts for the SKUs in `listSku1BuyTogether`, discount list used for Buy Together Promotions.\"},\"percentualDiscountValueList2\":{\"type\":\"number\",\"description\":\"Equivalent to `percentualDiscountValueList1`.\"},\"skusGift\":{\"type\":\"object\",\"description\":\"SKU Gift Object. Total discount on the product value set as a gift.\",\"properties\":{\"quantitySelectable\":{\"type\":\"integer\",\"description\":\"Quantity of SKU Gifts.\"},\"gifts\":{\"type\":\"integer\",\"description\":\"Array with SKU Gifts IDs.\"}}},\"nominalRewardValue\":{\"type\":\"number\",\"description\":\"Nominal value for rewards program.\"},\"percentualRewardValue\":{\"type\":\"number\",\"description\":\"Percentage value for rewards program.\"},\"orderStatusRewardValue\":{\"type\":\"string\",\"description\":\"Order status reward value.\"},\"maxNumberOfAffectedItems\":{\"type\":\"integer\",\"description\":\"The maximum number of affected items for a promotion.\"},\"maxNumberOfAffectedItemsGroupKey\":{\"type\":\"string\",\"description\":\"The maximum number of affected items by group key for a promotion.\"},\"applyToAllShippings\":{\"type\":\"boolean\",\"description\":\"Promotion will be applied to all kind of shipping.\"},\"nominalTax\":{\"type\":\"number\",\"description\":\"Nominal tax.\"},\"origin\":{\"type\":\"string\",\"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.\"},\"idSeller\":{\"type\":\"string\",\"description\":\"Seller Name.\"},\"idSellerIsInclusive\":{\"type\":\"boolean\",\"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.\"},\"idsSalesChannel\":{\"type\":\"array\",\"description\":\"List of Trade Policies that activate this promotion.\",\"items\":{\"type\":\"string\",\"description\":\"Trade policy ID.\"}},\"areSalesChannelIdsExclusive\":{\"type\":\"boolean\",\"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.\"},\"marketingTags\":{\"type\":\"array\",\"description\":\"Promotion Marketing tags.\",\"items\":{\"type\":\"string\",\"description\":\"Promotion Marketing tag.\"}},\"marketingTagsAreNotInclusive\":{\"type\":\"boolean\",\"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.\"},\"paymentsMethods\":{\"type\":\"array\",\"description\":\"Array composed by all the Payments Methods.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the Payment Method.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Payment Method ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Payment Method Name.\"}}}},\"stores\":{\"type\":\"array\",\"description\":\"List of stores.\",\"items\":{\"type\":\"string\",\"description\":\"Store.\"}},\"campaigns\":{\"type\":\"array\",\"description\":\"Campaign Audiences that activate this promotion.\",\"items\":{\"type\":\"string\",\"description\":\"Campaign audience.\"}},\"conditionsIds\":{\"type\":\"array\",\"description\":\"Array with conditions IDs.\",\"items\":{\"type\":\"string\",\"description\":\"Condition ID.\"}},\"storesAreInclusive\":{\"type\":\"boolean\",\"description\":\"If set to `true`, this promotion will be applied to any store present on the `stores` field. If set to `false`, stores present on that field will make this promotion not to be applied.\"},\"categories\":{\"type\":\"array\",\"description\":\"Object composed by the categories that will activate or deactivate the promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the category.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Category ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Category Name.\"}}}},\"categoriesAreInclusive\":{\"type\":\"boolean\",\"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.\"},\"brands\":{\"type\":\"array\",\"description\":\"Object composed by the brands that will activate or deactivate the promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the brand.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Brand ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Brand Name.\"}}}},\"brandsAreInclusive\":{\"type\":\"boolean\",\"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.\"},\"products\":{\"type\":\"array\",\"description\":\"Object composed by the products that will activate or deactivate the promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the product.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Product Name.\"}}}},\"productsAreInclusive\":{\"type\":\"boolean\",\"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.\"},\"skus\":{\"type\":\"array\",\"description\":\"Object composed by the SKUs that will activate or deactivate the promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the SKU.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SKU ID.\"},\"name\":{\"type\":\"string\",\"description\":\"SKU Name.\"}}}},\"skusAreInclusive\":{\"type\":\"boolean\",\"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.\"},\"utmSource\":{\"type\":\"string\",\"description\":\"Coupon utmSource code.\"},\"utmCampaign\":{\"type\":\"string\",\"description\":\"Coupon utmCampaign code.\"},\"collections1BuyTogether\":{\"type\":\"array\",\"description\":\"Collections that will generate the promotion, type **Buy Together**, **More for less**, **Progressive Discount**, **Buy One Get One**.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the collection to be added to the first list of the **Buy Together** promotion.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the collection to be added to the first list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the collection to be added to the first list of the **Buy Together** promotion.\"}}}},\"collections2BuyTogether\":{\"type\":\"array\",\"description\":\"Collections that will generate the promotion, type **Buy Together**, **More for less**, **Progressive Discount** or **Buy One Get One**.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the collection to be added to the first list of the **Buy Together** promotion.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the collection to be added to the first list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the collection to be added to the first list of the **Buy Together** promotion.\"}}}},\"minimumQuantityBuyTogether\":{\"type\":\"integer\",\"description\":\"Minimum quantity for **Buy Together** promotion.\"},\"quantityToAffectBuyTogether\":{\"type\":\"integer\",\"description\":\"Quantity to affect **Buy Together** promotion.\"},\"enableBuyTogetherPerSku\":{\"type\":\"boolean\",\"description\":\"Enable **Buy Together** per SKU.\"},\"listSku1BuyTogether\":{\"type\":\"array\",\"description\":\"Array of objects, each containing ID and Name of an SKU to be added in the first list of the **Buy Together** promotion. Learn more about this type of promotion in the [Creating a Buy Together promotion](https://help.vtex.com/en/tutorial/buy-together--tutorials_323) documentation.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the SKU to be added to the first list of the **Buy Together** promotion. Learn more about this type of promotion in the [Creating a Buy Together promotion](https://help.vtex.com/en/tutorial/buy-together--tutorials_323) documentation.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the SKU to be added to the first list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the SKU to be added to the first list of the **Buy Together** promotion.\"}}}},\"listSku2BuyTogether\":{\"type\":\"array\",\"description\":\"Array of objects, each containing ID and Name of an SKU to be added to the second list of the **Buy Together** promotion. Learn more about this type of promotion in the [Creating a Buy Together promotion](https://help.vtex.com/en/tutorial/buy-together--tutorials_323) documentation.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the SKU to be added to the second list of the **Buy Together** promotion. Learn more about this type of promotion in the [Creating a Buy Together promotion](https://help.vtex.com/en/tutorial/buy-together--tutorials_323) documentation.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the SKU to be added to the second list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the SKU to be added to the second list of the **Buy Together** promotion.\"}}}},\"coupon\":{\"type\":\"array\",\"description\":\"List of coupons.\",\"items\":{\"type\":\"string\",\"description\":\"Coupon code.\"}},\"totalValueFloor\":{\"type\":\"number\",\"description\":\"Minimum chart value to activate the promotion.\"},\"totalValueCeling\":{\"type\":\"number\",\"description\":\"Maximum chart value to activate the promotion.\"},\"totalValueIncludeAllItems\":{\"type\":\"boolean\",\"description\":\"Total value including all items.\"},\"totalValueMode\":{\"type\":\"string\",\"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`.\"},\"collections\":{\"type\":\"array\",\"description\":\"Array composed by the collections that will be activated or deactivated the promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the collection.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Collection ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Collection Name.\"}}}},\"collectionsIsInclusive\":{\"type\":\"boolean\",\"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.\"},\"restrictionsBins\":{\"type\":\"array\",\"description\":\"The discount will be granted if the card's BIN is given.\",\"items\":{\"type\":\"string\",\"description\":\"Card's BIN.\"}},\"cardIssuers\":{\"type\":\"array\",\"description\":\"List of card issuers.\",\"items\":{\"type\":\"string\",\"description\":\"Card issuer.\"}},\"totalValuePurchase\":{\"type\":\"number\",\"description\":\"Total value a client must have in past orders to active the promotion.\"},\"slasIds\":{\"type\":\"array\",\"description\":\"The discount will be granted if the shipping method is the same as the one given.\",\"items\":{\"type\":\"string\",\"description\":\"Shipping method.\"}},\"isSlaSelected\":{\"type\":\"boolean\",\"description\":\"Applies selected discount only when one of the defined shipping method is selected by the customer.\"},\"isFirstBuy\":{\"type\":\"boolean\",\"description\":\"Applies the discount only if it's a first buy.\"},\"firstBuyIsProfileOptimistic\":{\"type\":\"boolean\",\"description\":\"Applies the discount even if the user is not logged.\"},\"compareListPriceAndPrice\":{\"type\":\"boolean\",\"description\":\"If the **List Price** and **Price** are the same.\"},\"isDifferentListPriceAndPrice\":{\"type\":\"boolean\",\"description\":\"Applies the promotion only if the list price and price is different.\"},\"zipCodeRanges\":{\"type\":\"array\",\"description\":\"Range of the zip code that applies the promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the Zip Code\",\"properties\":{\"zipCodeFrom\":{\"type\":\"string\",\"description\":\"Initial Zip Code.\"},\"zipCodeTo\":{\"type\":\"string\",\"description\":\"Final Zip Code.\"},\"inclusive\":{\"type\":\"boolean\",\"description\":\"Defines if the zip code range is included in the promotion.\"}}}},\"itemMaxPrice\":{\"type\":\"number\",\"description\":\"Maximum price of the item.\"},\"itemMinPrice\":{\"type\":\"number\",\"description\":\"Minimum price of the item.\"},\"installment\":{\"type\":\"integer\",\"description\":\"Installment.\"},\"isMinMaxInstallments\":{\"type\":\"boolean\",\"description\":\"Set if the promotion will be applied considering a minimum and maximum values for installments.\"},\"minInstallment\":{\"type\":\"integer\",\"description\":\"Minimum value for installment.\"},\"maxInstallment\":{\"type\":\"integer\",\"description\":\"Maximum value for installment.\"},\"merchants\":{\"type\":\"array\",\"description\":\"List of merchants.\",\"items\":{\"type\":\"string\",\"description\":\"Merchant.\"}},\"clusterExpressions\":{\"type\":\"array\",\"description\":\"Criteria to select a customer cluster. Each item in this array should follow the format of an equality function (`{propertyname}={value}`) or the format of a contains function (`{propertyname} contains {value}`). In both options, `{propertyname}` must be replaced with the name of the field in the data entity, and `{value}` must be replaced with the value determined in Master Data. Find more information about these criteria in [Filling in the Customer cluster field](https://help.vtex.com/tutorial/creating-promotion-for-a-customer-cluster--tutorials_342#filling-in-the-customer-cluster-field).\",\"items\":{\"type\":\"string\",\"description\":\"Cluster expression.\"}},\"clusterOperator\":{\"type\":\"string\",\"description\":\"Cluster operator.\"},\"paymentsRules\":{\"type\":\"array\",\"description\":\"List of payment rules.\",\"items\":{\"type\":\"string\",\"description\":\"Payment rule.\"}},\"giftListTypes\":{\"type\":\"array\",\"description\":\"Gifts List Type.\",\"items\":{\"type\":\"string\",\"description\":\"Gift List Type.\"}},\"productsSpecifications\":{\"type\":\"array\",\"description\":\"List of product specifications.\",\"items\":{\"type\":\"string\",\"description\":\"Product specification.\"}},\"affiliates\":{\"type\":\"array\",\"description\":\"Marketplace order identifier. The discount will apply to selected affiliates.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the affiliate.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Affiliate ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Affiliate Name.\"}}}},\"maxUsage\":{\"type\":\"integer\",\"description\":\"Defines how many times the promotion can be used.\"},\"maxUsagePerClient\":{\"type\":\"integer\",\"description\":\"Defines if the promotion can be used multiple times per client.\"},\"shouldDistributeDiscountAmongMatchedItems\":{\"type\":\"boolean\",\"description\":\"Should distribute discount among matched items.\"},\"multipleUsePerClient\":{\"type\":\"boolean\",\"description\":\"Defines if the promotion can be used multiple times per client.\"},\"accumulateWithManualPrice\":{\"type\":\"boolean\",\"description\":\"Allows the promotion to apply to products whose prices have been manually added by a call center operator.\"},\"type\":{\"type\":\"string\",\"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).\"},\"useNewProgressiveAlgorithm\":{\"type\":\"boolean\",\"description\":\"Use new progressive algorithm.\"},\"percentualDiscountValueList\":{\"type\":\"array\",\"description\":\"Percentual discount value list.\",\"items\":{\"type\":\"number\",\"description\":\"Percentual discount value.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/rnb/pvt/benefits/calculatorconfiguration/search - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -371,7 +310,7 @@ } }, { - "id": "564293a3-f439-4ce7-a96b-0c3dea6e3c75", + "id": "4afbadb6-f1e8-4f9b-a739-93ba74f316c8", "name": "Get all taxes", "request": { "name": "Get all taxes", @@ -391,26 +330,7 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ { @@ -430,16 +350,21 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "GET" + "method": "GET", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, - "id": "46f6877b-c082-480f-b0fd-56e09bbb3228", + "id": "70017b8a-6e50-4890-baf2-f436e8511271", "name": "OK", "originalRequest": { "url": { @@ -454,36 +379,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -505,6 +403,14 @@ { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "GET", @@ -526,7 +432,7 @@ { "listen": "test", "script": { - "id": "744a8f90-be41-4533-ae67-b2fbe64548a6", + "id": "f708846d-a0fa-453a-92d3-7bb82f8fd94d", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/rnb/pvt/taxes/calculatorconfiguration - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -542,7 +448,7 @@ } }, { - "id": "fbff4e72-7708-4f57-8548-b555d6c2141c", + "id": "a059f7e9-dd7a-4e27-a489-7c175c2c95f1", "name": "Get promotion or tax by ID", "request": { "name": "Get promotion or tax by ID", @@ -572,24 +478,6 @@ "type": "any", "value": "d8a1cd2e-b667-4054-b3ae-b79124c7218e", "key": "idCalculatorConfiguration" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" } ] }, @@ -611,16 +499,21 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "GET" + "method": "GET", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, - "id": "b7b75221-6daa-4952-b6ad-55ae3ea2845d", + "id": "be3a1553-d7e7-4344-8757-45d5a6b4c362", "name": "OK", "originalRequest": { "url": { @@ -635,46 +528,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) Promotion ID or tax ID.", - "type": "text/plain" - }, - "type": "any", - "value": "d8a1cd2e-b667-4054-b3ae-b79124c7218e", - "key": "idCalculatorConfiguration" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -696,6 +552,14 @@ { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "GET", @@ -717,13 +581,13 @@ { "listen": "test", "script": { - "id": "fd1d95f4-d1da-4f3d-83d1-d923322d25a5", + "id": "2c8a613b-f5fa-481c-9317-c1c83fdc6c9b", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/rnb/pvt/calculatorconfiguration/:idCalculatorConfiguration - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[GET]::/api/rnb/pvt/calculatorconfiguration/:idCalculatorConfiguration - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[GET]::/api/rnb/pvt/calculatorconfiguration/:idCalculatorConfiguration - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"type\":\"object\",\"properties\":{\"idCalculatorConfiguration\":{\"type\":\"string\",\"description\":\"Promotion ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Promotion Name.\"},\"description\":{\"type\":\"string\",\"description\":\"Promotion internal description.\"},\"beginDateUtc\":{\"type\":\"string\",\"description\":\"Promotion Begin Date (UTC).\"},\"endDateUtc\":{\"type\":\"string\",\"description\":\"Promotion End Date (UTC).\"},\"lastModified\":{\"type\":\"string\",\"description\":\"When the Promotion was last modified.\"},\"daysAgoOfPurchases\":{\"type\":\"integer\",\"description\":\"Number of days that are considered to add the purchase history.\"},\"isActive\":{\"type\":\"boolean\",\"description\":\"If set as `true` the Promotion is activated. If set as `false` the Promotion is deactivated.\"},\"isArchived\":{\"type\":\"boolean\",\"description\":\"If set as `true` the Promotion is archived. If set as `false` the Promotion is not archived.\"},\"isFeatured\":{\"type\":\"boolean\",\"description\":\"Insert a flag with the promotion name used in the product's window display and page.\"},\"disableDeal\":{\"type\":\"boolean\",\"deprecated\":true,\"description\":\"Indicates whether a deal is disabled (`true`) or not (`false`).\"},\"activeDaysOfWeek\":{\"type\":\"array\",\"description\":\"Defines which days of the week the promotion will applied.\",\"items\":{\"type\":\"string\",\"description\":\"Day of the week that the promotion will be valid.\"}},\"offset\":{\"type\":\"integer\",\"description\":\"Time offset from UTC in seconds.\"},\"activateGiftsMultiplier\":{\"type\":\"boolean\",\"description\":\"If set as `true`, it activates gifts Multiplier.\"},\"newOffset\":{\"type\":\"number\",\"description\":\"New time offset from UTC in seconds.\"},\"maxPricesPerItems\":{\"type\":\"array\",\"deprecated\":true,\"description\":\"List of max price per items.\",\"items\":{\"type\":\"string\",\"description\":\"Max price.\"}},\"cumulative\":{\"type\":\"boolean\",\"description\":\"Defines if a promotion can accumulate with another one. (`true`) or not (`false`).\"},\"discountType\":{\"type\":\"string\",\"description\":\"The type of discount that will apply to the promotion.\"},\"nominalShippingDiscountValue\":{\"type\":\"number\",\"description\":\"Exact discount to be applied for the shipping value.\"},\"absoluteShippingDiscountValue\":{\"type\":\"number\",\"description\":\"Maximum value for the shipping.\"},\"nominalDiscountValue\":{\"type\":\"number\",\"description\":\"Exact discount to be applied for the total purchase value.\"},\"nominalDiscountType\":{\"type\":\"string\",\"description\":\"Controls the behavior of the `NominalDiscount` effect. This field only accepts two string values:\\n\\n -`item`: applies the intended nominal discount on every item present on the cart. \\n\\n -`cart`: keeps the behavior as it currently is: the whole order/cart receives a nominal discount that is distributed among the items.\"},\"maximumUnitPriceDiscount\":{\"type\":\"number\",\"description\":\"The maximum price for each item of the purchase will be the price set up.\"},\"percentualDiscountValue\":{\"type\":\"number\",\"description\":\"Percentage discount to be applied for total purchase value.\"},\"rebatePercentualDiscountValue\":{\"type\":\"number\",\"description\":\"Percentual Shipping Discount Value.\"},\"percentualShippingDiscountValue\":{\"type\":\"number\",\"description\":\"Percentage discount to be applied for shipping value.\"},\"percentualTax\":{\"type\":\"number\",\"description\":\"Percentual tax over purchase total value.\"},\"shippingPercentualTax\":{\"type\":\"number\",\"description\":\"Shipping Percentual tax over purchase total value.\"},\"percentualDiscountValueList1\":{\"type\":\"number\",\"description\":\"Valid discounts for the SKUs in `listSku1BuyTogether`, discount list used for Buy Together Promotions.\"},\"percentualDiscountValueList2\":{\"type\":\"number\",\"description\":\"Equivalent to `percentualDiscountValueList1`.\"},\"skusGift\":{\"type\":\"object\",\"description\":\"SKU Gift Object. Total discount on the product value set as a gift.\",\"properties\":{\"quantitySelectable\":{\"type\":\"integer\",\"description\":\"Quantity of SKU Gifts.\"},\"gifts\":{\"type\":\"integer\",\"description\":\"Array with SKU Gifts IDs.\"}}},\"nominalRewardValue\":{\"type\":\"number\",\"description\":\"Nominal value for rewards program.\"},\"percentualRewardValue\":{\"type\":\"number\",\"description\":\"Percentage value for rewards program.\"},\"orderStatusRewardValue\":{\"type\":\"string\",\"description\":\"Order status reward value.\"},\"maxNumberOfAffectedItems\":{\"type\":\"integer\",\"description\":\"The maximum number of affected items for a promotion.\"},\"maxNumberOfAffectedItemsGroupKey\":{\"type\":\"string\",\"description\":\"The maximum number of affected items by group key for a promotion.\"},\"applyToAllShippings\":{\"type\":\"boolean\",\"description\":\"Promotion will be applied to all kind of shipping.\"},\"nominalTax\":{\"type\":\"number\",\"description\":\"Nominal tax.\"},\"origin\":{\"type\":\"string\",\"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.\"},\"idSeller\":{\"type\":\"string\",\"description\":\"Seller Name.\"},\"idSellerIsInclusive\":{\"type\":\"boolean\",\"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.\"},\"idsSalesChannel\":{\"type\":\"array\",\"description\":\"List of Trade Policies that activate this promotion.\",\"items\":{\"type\":\"string\",\"description\":\"Trade policy ID.\"}},\"areSalesChannelIdsExclusive\":{\"type\":\"boolean\",\"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.\"},\"marketingTags\":{\"type\":\"array\",\"description\":\"Promotion Marketing tags.\",\"items\":{\"type\":\"string\",\"description\":\"Promotion Marketing tag.\"}},\"marketingTagsAreNotInclusive\":{\"type\":\"boolean\",\"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.\"},\"paymentsMethods\":{\"type\":\"array\",\"description\":\"Array composed by all the Payments Methods.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the Payment Method.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Payment Method ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Payment Method Name.\"}}}},\"stores\":{\"type\":\"array\",\"deprecated\":true,\"description\":\"List of stores.\",\"items\":{\"type\":\"string\",\"description\":\"Store.\"}},\"campaigns\":{\"type\":\"array\",\"description\":\"Campaign Audiences that activate this promotion.\",\"items\":{\"type\":\"string\",\"description\":\"Campaign audience.\"}},\"conditionsIds\":{\"type\":\"array\",\"description\":\"Array with conditions IDs.\",\"items\":{\"type\":\"string\",\"description\":\"Condition ID.\"}},\"storesAreInclusive\":{\"type\":\"boolean\",\"deprecated\":true,\"description\":\"If set to `true`, this promotion will be applied to any store present on the `stores` field. If set to `false`, stores present on that field will make this promotion not to be applied.\"},\"categories\":{\"type\":\"array\",\"description\":\"Object composed by the categories that will activate or deactivate the promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the category.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Category ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Category Name.\"}}}},\"categoriesAreInclusive\":{\"type\":\"boolean\",\"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.\"},\"brands\":{\"type\":\"array\",\"description\":\"Object composed by the brands that will activate or deactivate the promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the brand.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Brand ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Brand Name.\"}}}},\"brandsAreInclusive\":{\"type\":\"boolean\",\"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.\"},\"products\":{\"type\":\"array\",\"description\":\"Object composed by the products that will activate or deactivate the promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the product.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Product Name.\"}}}},\"productsAreInclusive\":{\"type\":\"boolean\",\"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.\"},\"skus\":{\"type\":\"array\",\"description\":\"Object composed by the SKUs that will activate or deactivate the promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the SKU.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SKU ID.\"},\"name\":{\"type\":\"string\",\"description\":\"SKU Name.\"}}}},\"skusAreInclusive\":{\"type\":\"boolean\",\"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.\"},\"utmSource\":{\"type\":\"string\",\"description\":\"Coupon utmSource code.\"},\"utmCampaign\":{\"type\":\"string\",\"description\":\"Coupon utmCampaign code.\"},\"collections1BuyTogether\":{\"type\":\"array\",\"description\":\"Collections that will generate the promotion, type **Buy Together**, **More for less**, **Progressive Discount**, **Buy One Get One**.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the collection to be added to the first list of the **Buy Together** promotion.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the collection to be added to the first list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the collection to be added to the first list of the **Buy Together** promotion.\"}}}},\"collections2BuyTogether\":{\"type\":\"array\",\"deprecated\":true,\"description\":\"Collections that will generate the promotion, type **Buy Together**, **More for less**, **Progressive Discount** or **Buy One Get One**.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the collection to be added to the first list of the **Buy Together** promotion.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the collection to be added to the first list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the collection to be added to the first list of the **Buy Together** promotion.\"}}}},\"minimumQuantityBuyTogether\":{\"type\":\"integer\",\"description\":\"Minimum quantity for **Buy Together** promotion.\"},\"quantityToAffectBuyTogether\":{\"type\":\"integer\",\"description\":\"Quantity to affect **Buy Together** promotion.\"},\"enableBuyTogetherPerSku\":{\"type\":\"boolean\",\"description\":\"Enable **Buy Together** per SKU.\"},\"listSku1BuyTogether\":{\"type\":\"array\",\"description\":\"Array of objects, each containing ID and Name of an SKU to be added in the first list of the **Buy Together** promotion. Learn more about this type of promotion in the [Creating a Buy Together promotion](https://help.vtex.com/en/tutorial/buy-together--tutorials_323) documentation.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the SKU to be added to the first list of the **Buy Together** promotion. Learn more about this type of promotion in the [Creating a Buy Together promotion](https://help.vtex.com/en/tutorial/buy-together--tutorials_323) documentation.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the SKU to be added to the first list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the SKU to be added to the first list of the **Buy Together** promotion.\"}}}},\"listSku2BuyTogether\":{\"type\":\"array\",\"description\":\"Array of objects, each containing ID and Name of an SKU to be added to the second list of the **Buy Together** promotion. Learn more about this type of promotion in the [Creating a Buy Together promotion](https://help.vtex.com/en/tutorial/buy-together--tutorials_323) documentation.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the SKU to be added to the second list of the **Buy Together** promotion. Learn more about this type of promotion in the [Creating a Buy Together promotion](https://help.vtex.com/en/tutorial/buy-together--tutorials_323) documentation.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the SKU to be added to the second list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the SKU to be added to the second list of the **Buy Together** promotion.\"}}}},\"coupon\":{\"type\":\"array\",\"deprecated\":true,\"description\":\"List of coupons.\",\"items\":{\"type\":\"string\",\"description\":\"Coupon code.\"}},\"totalValueFloor\":{\"type\":\"number\",\"description\":\"Minimum chart value to activate the promotion.\"},\"totalValueCeling\":{\"type\":\"number\",\"description\":\"Maximum chart value to activate the promotion.\"},\"totalValueIncludeAllItems\":{\"type\":\"boolean\",\"deprecated\":true,\"description\":\"Total value including all items.\"},\"totalValueMode\":{\"type\":\"string\",\"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`.\"},\"collections\":{\"type\":\"array\",\"description\":\"Array composed by the collections that will be activated or deactivated the promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the collection.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Collection ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Collection Name.\"}}}},\"collectionsIsInclusive\":{\"type\":\"boolean\",\"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.\"},\"restrictionsBins\":{\"type\":\"array\",\"description\":\"The discount will be granted if the card's BIN is given.\",\"items\":{\"type\":\"string\",\"description\":\"Card's BIN.\"}},\"cardIssuers\":{\"type\":\"array\",\"deprecated\":true,\"description\":\"List of card issuers.\",\"items\":{\"type\":\"string\",\"description\":\"Card issuer.\"}},\"totalValuePurchase\":{\"type\":\"number\",\"description\":\"Total value a client must have in past orders to active the promotion.\"},\"slasIds\":{\"type\":\"array\",\"description\":\"The discount will be granted if the shipping method is the same as the one given.\",\"items\":{\"type\":\"string\",\"description\":\"Shipping method.\"}},\"isSlaSelected\":{\"type\":\"boolean\",\"description\":\"Applies selected discount only when one of the defined shipping method is selected by the customer.\"},\"isFirstBuy\":{\"type\":\"boolean\",\"description\":\"Applies the discount only if it's a first buy.\"},\"firstBuyIsProfileOptimistic\":{\"type\":\"boolean\",\"description\":\"Applies the discount even if the user is not logged.\"},\"compareListPriceAndPrice\":{\"type\":\"boolean\",\"description\":\"If the **List Price** and **Price** are the same.\"},\"isDifferentListPriceAndPrice\":{\"type\":\"boolean\",\"description\":\"Applies the promotion only if the list price and price is different.\"},\"zipCodeRanges\":{\"type\":\"array\",\"description\":\"Range of the zip code that applies the promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the Zip Code.\",\"properties\":{\"zipCodeFrom\":{\"type\":\"string\",\"description\":\"Initial Zip Code.\"},\"zipCodeTo\":{\"type\":\"string\",\"description\":\"Final Zip Code.\"},\"inclusive\":{\"type\":\"boolean\",\"description\":\"Defines if the zip code range is included in the promotion.\"}}}},\"itemMaxPrice\":{\"type\":\"number\",\"description\":\"Maximum price of the item.\"},\"itemMinPrice\":{\"type\":\"number\",\"description\":\"Minimum price of the item.\"},\"installment\":{\"type\":\"integer\",\"deprecated\":true,\"description\":\"Installment.\"},\"isMinMaxInstallments\":{\"type\":\"boolean\",\"description\":\"Set if the promotion will be applied considering a minimum and maximum values for installments.\"},\"minInstallment\":{\"type\":\"integer\",\"description\":\"Minimum value for installment.\"},\"maxInstallment\":{\"type\":\"integer\",\"description\":\"Maximum value for installment.\"},\"merchants\":{\"type\":\"array\",\"deprecated\":true,\"description\":\"List of merchants.\",\"items\":{\"type\":\"string\",\"description\":\"Merchant.\"}},\"clusterExpressions\":{\"type\":\"array\",\"description\":\"Criteria to select a customer cluster. Each item in this array should follow the format of an equality function (`{propertyname}={value}`) or the format of a contains function (`{propertyname} contains {value}`). In both options, `{propertyname}` must be replaced with the name of the field in the data entity, and `{value}` must be replaced with the value determined in Master Data. Find more information about these criteria in [Filling in the Customer cluster field](https://help.vtex.com/tutorial/creating-promotion-for-a-customer-cluster--tutorials_342#filling-in-the-customer-cluster-field).\",\"items\":{\"type\":\"string\",\"description\":\"Cluster expression.\"}},\"multipleSkusCause\":{\"type\":\"object\",\"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.\",\"additionalProperties\":{\"type\":\"string\",\"description\":\"SKU ID.\"}},\"paymentsRules\":{\"type\":\"array\",\"deprecated\":true,\"description\":\"List of payment rules.\",\"items\":{\"type\":\"string\",\"description\":\"Payment rule.\"}},\"giftListTypes\":{\"type\":\"array\",\"description\":\"Gifts List Type.\",\"items\":{\"type\":\"string\",\"description\":\"Gift List Type.\"}},\"productsSpecifications\":{\"type\":\"array\",\"deprecated\":true,\"description\":\"List of product specifications.\",\"items\":{\"type\":\"string\",\"description\":\"Product specification.\"}},\"affiliates\":{\"type\":\"array\",\"description\":\"Marketplace order identifier. The discount will apply to selected affiliates.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the affiliate.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Affiliate ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Affiliate Name.\"}}}},\"maxUsage\":{\"type\":\"integer\",\"description\":\"Defines how many times the promotion can be used.\"},\"maxUsagePerClient\":{\"type\":\"integer\",\"description\":\"Defines if the promotion can be used multiple times per client.\"},\"shouldDistributeDiscountAmongMatchedItems\":{\"type\":\"boolean\",\"description\":\"Should distribute discount among matched items.\"},\"multipleUsePerClient\":{\"type\":\"boolean\",\"description\":\"Defines if the promotion can be used multiple times per client.\"},\"accumulateWithManualPrice\":{\"type\":\"boolean\",\"description\":\"Allows the promotion to apply to products whose prices have been manually added by a call center operator.\"},\"type\":{\"type\":\"string\",\"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).\"},\"useNewProgressiveAlgorithm\":{\"type\":\"boolean\",\"description\":\"Use new progressive algorithm.\"},\"percentualDiscountValueList\":{\"type\":\"array\",\"description\":\"Percentual discount value list.\",\"items\":{\"type\":\"number\",\"description\":\"Percentual discount value.\"}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/rnb/pvt/calculatorconfiguration/:idCalculatorConfiguration - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"type\":\"object\",\"properties\":{\"idCalculatorConfiguration\":{\"type\":\"string\",\"description\":\"Promotion ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Promotion Name.\"},\"description\":{\"type\":\"string\",\"description\":\"Promotion internal description.\"},\"beginDateUtc\":{\"type\":\"string\",\"description\":\"Promotion Begin Date (UTC).\"},\"endDateUtc\":{\"type\":\"string\",\"description\":\"Promotion End Date (UTC).\"},\"lastModified\":{\"type\":\"string\",\"description\":\"When the Promotion was last modified.\"},\"daysAgoOfPurchases\":{\"type\":\"integer\",\"description\":\"Number of days that are considered to add the purchase history.\"},\"isActive\":{\"type\":\"boolean\",\"description\":\"If set as `true` the Promotion is activated. If set as `false` the Promotion is deactivated.\"},\"isArchived\":{\"type\":\"boolean\",\"description\":\"If set as `true` the Promotion is archived. If set as `false` the Promotion is not archived.\"},\"isFeatured\":{\"type\":\"boolean\",\"description\":\"Insert a flag with the promotion name used in the product's window display and page.\"},\"disableDeal\":{\"type\":\"boolean\",\"description\":\"Indicates whether a deal is disabled (`true`) or not (`false`).\"},\"activeDaysOfWeek\":{\"type\":\"array\",\"description\":\"Defines which days of the week the promotion will applied.\",\"items\":{\"type\":\"string\",\"description\":\"Day of the week that the promotion will be valid.\"}},\"offset\":{\"type\":\"integer\",\"description\":\"Time offset from UTC in seconds.\"},\"activateGiftsMultiplier\":{\"type\":\"boolean\",\"description\":\"If set as `true`, it activates gifts Multiplier.\"},\"newOffset\":{\"type\":\"number\",\"description\":\"New time offset from UTC in seconds.\"},\"maxPricesPerItems\":{\"type\":\"array\",\"description\":\"List of max price per items.\",\"items\":{\"type\":\"string\",\"description\":\"Max price.\"}},\"cumulative\":{\"type\":\"boolean\",\"description\":\"Defines if a promotion can accumulate with another one. (`true`) or not (`false`).\"},\"discountType\":{\"type\":\"string\",\"description\":\"The type of discount that will apply to the promotion.\"},\"nominalShippingDiscountValue\":{\"type\":\"number\",\"description\":\"Exact discount to be applied for the shipping value.\"},\"absoluteShippingDiscountValue\":{\"type\":\"number\",\"description\":\"Maximum value for the shipping.\"},\"nominalDiscountValue\":{\"type\":\"number\",\"description\":\"Exact discount to be applied for the total purchase value.\"},\"nominalDiscountType\":{\"type\":\"string\",\"description\":\"Controls the behavior of the `NominalDiscount` effect. This field only accepts two string values:\\n\\n -`item`: applies the intended nominal discount on every item present on the cart. \\n\\n -`cart`: keeps the behavior as it currently is: the whole order/cart receives a nominal discount that is distributed among the items.\"},\"maximumUnitPriceDiscount\":{\"type\":\"number\",\"description\":\"The maximum price for each item of the purchase will be the price set up.\"},\"percentualDiscountValue\":{\"type\":\"number\",\"description\":\"Percentage discount to be applied for total purchase value.\"},\"rebatePercentualDiscountValue\":{\"type\":\"number\",\"description\":\"Percentual Shipping Discount Value.\"},\"percentualShippingDiscountValue\":{\"type\":\"number\",\"description\":\"Percentage discount to be applied for shipping value.\"},\"percentualTax\":{\"type\":\"number\",\"description\":\"Percentual tax over purchase total value.\"},\"shippingPercentualTax\":{\"type\":\"number\",\"description\":\"Shipping Percentual tax over purchase total value.\"},\"percentualDiscountValueList1\":{\"type\":\"number\",\"description\":\"Valid discounts for the SKUs in `listSku1BuyTogether`, discount list used for Buy Together Promotions.\"},\"percentualDiscountValueList2\":{\"type\":\"number\",\"description\":\"Equivalent to `percentualDiscountValueList1`.\"},\"skusGift\":{\"type\":\"object\",\"description\":\"SKU Gift Object. Total discount on the product value set as a gift.\",\"properties\":{\"quantitySelectable\":{\"type\":\"integer\",\"description\":\"Quantity of SKU Gifts.\"},\"gifts\":{\"type\":\"integer\",\"description\":\"Array with SKU Gifts IDs.\"}}},\"nominalRewardValue\":{\"type\":\"number\",\"description\":\"Nominal value for rewards program.\"},\"percentualRewardValue\":{\"type\":\"number\",\"description\":\"Percentage value for rewards program.\"},\"orderStatusRewardValue\":{\"type\":\"string\",\"description\":\"Order status reward value.\"},\"maxNumberOfAffectedItems\":{\"type\":\"integer\",\"description\":\"The maximum number of affected items for a promotion.\"},\"maxNumberOfAffectedItemsGroupKey\":{\"type\":\"string\",\"description\":\"The maximum number of affected items by group key for a promotion.\"},\"applyToAllShippings\":{\"type\":\"boolean\",\"description\":\"Promotion will be applied to all kind of shipping.\"},\"nominalTax\":{\"type\":\"number\",\"description\":\"Nominal tax.\"},\"origin\":{\"type\":\"string\",\"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.\"},\"idSeller\":{\"type\":\"string\",\"description\":\"Seller Name.\"},\"idSellerIsInclusive\":{\"type\":\"boolean\",\"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.\"},\"idsSalesChannel\":{\"type\":\"array\",\"description\":\"List of Trade Policies that activate this promotion.\",\"items\":{\"type\":\"string\",\"description\":\"Trade policy ID.\"}},\"areSalesChannelIdsExclusive\":{\"type\":\"boolean\",\"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.\"},\"marketingTags\":{\"type\":\"array\",\"description\":\"Promotion Marketing tags.\",\"items\":{\"type\":\"string\",\"description\":\"Promotion Marketing tag.\"}},\"marketingTagsAreNotInclusive\":{\"type\":\"boolean\",\"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.\"},\"paymentsMethods\":{\"type\":\"array\",\"description\":\"Array composed by all the Payments Methods.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the Payment Method.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Payment Method ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Payment Method Name.\"}}}},\"stores\":{\"type\":\"array\",\"description\":\"List of stores.\",\"items\":{\"type\":\"string\",\"description\":\"Store.\"}},\"campaigns\":{\"type\":\"array\",\"description\":\"Campaign Audiences that activate this promotion.\",\"items\":{\"type\":\"string\",\"description\":\"Campaign audience.\"}},\"conditionsIds\":{\"type\":\"array\",\"description\":\"Array with conditions IDs.\",\"items\":{\"type\":\"string\",\"description\":\"Condition ID.\"}},\"storesAreInclusive\":{\"type\":\"boolean\",\"description\":\"If set to `true`, this promotion will be applied to any store present on the `stores` field. If set to `false`, stores present on that field will make this promotion not to be applied.\"},\"categories\":{\"type\":\"array\",\"description\":\"Object composed by the categories that will activate or deactivate the promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the category.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Category ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Category Name.\"}}}},\"categoriesAreInclusive\":{\"type\":\"boolean\",\"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.\"},\"brands\":{\"type\":\"array\",\"description\":\"Object composed by the brands that will activate or deactivate the promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the brand.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Brand ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Brand Name.\"}}}},\"brandsAreInclusive\":{\"type\":\"boolean\",\"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.\"},\"products\":{\"type\":\"array\",\"description\":\"Object composed by the products that will activate or deactivate the promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the product.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Product Name.\"}}}},\"productsAreInclusive\":{\"type\":\"boolean\",\"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.\"},\"skus\":{\"type\":\"array\",\"description\":\"Object composed by the SKUs that will activate or deactivate the promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the SKU.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SKU ID.\"},\"name\":{\"type\":\"string\",\"description\":\"SKU Name.\"}}}},\"skusAreInclusive\":{\"type\":\"boolean\",\"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.\"},\"utmSource\":{\"type\":\"string\",\"description\":\"Coupon utmSource code.\"},\"utmCampaign\":{\"type\":\"string\",\"description\":\"Coupon utmCampaign code.\"},\"collections1BuyTogether\":{\"type\":\"array\",\"description\":\"Collections that will generate the promotion, type **Buy Together**, **More for less**, **Progressive Discount**, **Buy One Get One**.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the collection to be added to the first list of the **Buy Together** promotion.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the collection to be added to the first list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the collection to be added to the first list of the **Buy Together** promotion.\"}}}},\"collections2BuyTogether\":{\"type\":\"array\",\"description\":\"Collections that will generate the promotion, type **Buy Together**, **More for less**, **Progressive Discount** or **Buy One Get One**.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the collection to be added to the first list of the **Buy Together** promotion.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the collection to be added to the first list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the collection to be added to the first list of the **Buy Together** promotion.\"}}}},\"minimumQuantityBuyTogether\":{\"type\":\"integer\",\"description\":\"Minimum quantity for **Buy Together** promotion.\"},\"quantityToAffectBuyTogether\":{\"type\":\"integer\",\"description\":\"Quantity to affect **Buy Together** promotion.\"},\"enableBuyTogetherPerSku\":{\"type\":\"boolean\",\"description\":\"Enable **Buy Together** per SKU.\"},\"listSku1BuyTogether\":{\"type\":\"array\",\"description\":\"Array of objects, each containing ID and Name of an SKU to be added in the first list of the **Buy Together** promotion. Learn more about this type of promotion in the [Creating a Buy Together promotion](https://help.vtex.com/en/tutorial/buy-together--tutorials_323) documentation.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the SKU to be added to the first list of the **Buy Together** promotion. Learn more about this type of promotion in the [Creating a Buy Together promotion](https://help.vtex.com/en/tutorial/buy-together--tutorials_323) documentation.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the SKU to be added to the first list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the SKU to be added to the first list of the **Buy Together** promotion.\"}}}},\"listSku2BuyTogether\":{\"type\":\"array\",\"description\":\"Array of objects, each containing ID and Name of an SKU to be added to the second list of the **Buy Together** promotion. Learn more about this type of promotion in the [Creating a Buy Together promotion](https://help.vtex.com/en/tutorial/buy-together--tutorials_323) documentation.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the SKU to be added to the second list of the **Buy Together** promotion. Learn more about this type of promotion in the [Creating a Buy Together promotion](https://help.vtex.com/en/tutorial/buy-together--tutorials_323) documentation.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the SKU to be added to the second list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the SKU to be added to the second list of the **Buy Together** promotion.\"}}}},\"coupon\":{\"type\":\"array\",\"description\":\"List of coupons.\",\"items\":{\"type\":\"string\",\"description\":\"Coupon code.\"}},\"totalValueFloor\":{\"type\":\"number\",\"description\":\"Minimum chart value to activate the promotion.\"},\"totalValueCeling\":{\"type\":\"number\",\"description\":\"Maximum chart value to activate the promotion.\"},\"totalValueIncludeAllItems\":{\"type\":\"boolean\",\"description\":\"Total value including all items.\"},\"totalValueMode\":{\"type\":\"string\",\"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`.\"},\"collections\":{\"type\":\"array\",\"description\":\"Array composed by the collections that will be activated or deactivated the promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the collection.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Collection ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Collection Name.\"}}}},\"collectionsIsInclusive\":{\"type\":\"boolean\",\"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.\"},\"restrictionsBins\":{\"type\":\"array\",\"description\":\"The discount will be granted if the card's BIN is given.\",\"items\":{\"type\":\"string\",\"description\":\"Card's BIN.\"}},\"cardIssuers\":{\"type\":\"array\",\"description\":\"List of card issuers.\",\"items\":{\"type\":\"string\",\"description\":\"Card issuer.\"}},\"totalValuePurchase\":{\"type\":\"number\",\"description\":\"Total value a client must have in past orders to active the promotion.\"},\"slasIds\":{\"type\":\"array\",\"description\":\"The discount will be granted if the shipping method is the same as the one given.\",\"items\":{\"type\":\"string\",\"description\":\"Shipping method.\"}},\"isSlaSelected\":{\"type\":\"boolean\",\"description\":\"Applies selected discount only when one of the defined shipping method is selected by the customer.\"},\"isFirstBuy\":{\"type\":\"boolean\",\"description\":\"Applies the discount only if it's a first buy.\"},\"firstBuyIsProfileOptimistic\":{\"type\":\"boolean\",\"description\":\"Applies the discount even if the user is not logged.\"},\"compareListPriceAndPrice\":{\"type\":\"boolean\",\"description\":\"If the **List Price** and **Price** are the same.\"},\"isDifferentListPriceAndPrice\":{\"type\":\"boolean\",\"description\":\"Applies the promotion only if the list price and price is different.\"},\"zipCodeRanges\":{\"type\":\"array\",\"description\":\"Range of the zip code that applies the promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the Zip Code.\",\"properties\":{\"zipCodeFrom\":{\"type\":\"string\",\"description\":\"Initial Zip Code.\"},\"zipCodeTo\":{\"type\":\"string\",\"description\":\"Final Zip Code.\"},\"inclusive\":{\"type\":\"boolean\",\"description\":\"Defines if the zip code range is included in the promotion.\"}}}},\"itemMaxPrice\":{\"type\":\"number\",\"description\":\"Maximum price of the item.\"},\"itemMinPrice\":{\"type\":\"number\",\"description\":\"Minimum price of the item.\"},\"installment\":{\"type\":\"integer\",\"description\":\"Installment.\"},\"isMinMaxInstallments\":{\"type\":\"boolean\",\"description\":\"Set if the promotion will be applied considering a minimum and maximum values for installments.\"},\"minInstallment\":{\"type\":\"integer\",\"description\":\"Minimum value for installment.\"},\"maxInstallment\":{\"type\":\"integer\",\"description\":\"Maximum value for installment.\"},\"merchants\":{\"type\":\"array\",\"description\":\"List of merchants.\",\"items\":{\"type\":\"string\",\"description\":\"Merchant.\"}},\"clusterExpressions\":{\"type\":\"array\",\"description\":\"Criteria to select a customer cluster. Each item in this array should follow the format of an equality function (`{propertyname}={value}`) or the format of a contains function (`{propertyname} contains {value}`). In both options, `{propertyname}` must be replaced with the name of the field in the data entity, and `{value}` must be replaced with the value determined in Master Data. Find more information about these criteria in [Filling in the Customer cluster field](https://help.vtex.com/tutorial/creating-promotion-for-a-customer-cluster--tutorials_342#filling-in-the-customer-cluster-field).\",\"items\":{\"type\":\"string\",\"description\":\"Cluster expression.\"}},\"multipleSkusCause\":{\"type\":\"object\",\"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.\",\"additionalProperties\":{\"type\":\"string\",\"description\":\"SKU ID.\"}},\"paymentsRules\":{\"type\":\"array\",\"description\":\"List of payment rules.\",\"items\":{\"type\":\"string\",\"description\":\"Payment rule.\"}},\"giftListTypes\":{\"type\":\"array\",\"description\":\"Gifts List Type.\",\"items\":{\"type\":\"string\",\"description\":\"Gift List Type.\"}},\"productsSpecifications\":{\"type\":\"array\",\"description\":\"List of product specifications.\",\"items\":{\"type\":\"string\",\"description\":\"Product specification.\"}},\"affiliates\":{\"type\":\"array\",\"description\":\"Marketplace order identifier. The discount will apply to selected affiliates.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the affiliate.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Affiliate ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Affiliate Name.\"}}}},\"maxUsage\":{\"type\":\"integer\",\"description\":\"Defines how many times the promotion can be used.\"},\"maxUsagePerClient\":{\"type\":\"integer\",\"description\":\"Defines if the promotion can be used multiple times per client.\"},\"shouldDistributeDiscountAmongMatchedItems\":{\"type\":\"boolean\",\"description\":\"Should distribute discount among matched items.\"},\"multipleUsePerClient\":{\"type\":\"boolean\",\"description\":\"Defines if the promotion can be used multiple times per client.\"},\"accumulateWithManualPrice\":{\"type\":\"boolean\",\"description\":\"Allows the promotion to apply to products whose prices have been manually added by a call center operator.\"},\"type\":{\"type\":\"string\",\"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).\"},\"useNewProgressiveAlgorithm\":{\"type\":\"boolean\",\"description\":\"Use new progressive algorithm.\"},\"percentualDiscountValueList\":{\"type\":\"array\",\"description\":\"Percentual discount value list.\",\"items\":{\"type\":\"number\",\"description\":\"Percentual discount value.\"}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/rnb/pvt/calculatorconfiguration/:idCalculatorConfiguration - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -733,7 +597,7 @@ } }, { - "id": "0b294a51-5982-4676-8c94-daea55ce3ff2", + "id": "c9c12279-0373-4ed8-adf6-d0dcc9ce3482", "name": "Create or update promotion or tax", "request": { "name": "Create or update promotion or tax", @@ -752,26 +616,7 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ { @@ -791,6 +636,14 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], "method": "POST", @@ -799,6 +652,7 @@ "raw": "{\n \"idCalculatorConfiguration\": \"d8a1cd2e-b667-4054-b3ae-b79124c7218e\",\n \"name\": \"Promotion Social Seller\",\n \"description\": \"Promotion for Social Seller\",\n \"beginDateUtc\": \"2020-05-01T18:47:15.89Z\",\n \"lastModified\": \"2021-09-17T18:13:16.2896414Z\",\n \"daysAgoOfPurchases\": 0,\n \"isActive\": true,\n \"isArchived\": false,\n \"isFeatured\": false,\n \"disableDeal\": false,\n \"activeDaysOfWeek\": [],\n \"offset\": -3,\n \"activateGiftsMultiplier\": false,\n \"newOffset\": -3,\n \"maxPricesPerItems\": [],\n \"cumulative\": false,\n \"discountType\": \"percentual\",\n \"nominalShippingDiscountValue\": 0,\n \"absoluteShippingDiscountValue\": 0,\n \"nominalDiscountValue\": 10,\n \"nominalDiscountType\": \"item\",\n \"maximumUnitPriceDiscount\": 0,\n \"percentualDiscountValue\": 10,\n \"rebatePercentualDiscountValue\": 0,\n \"percentualShippingDiscountValue\": 0,\n \"percentualTax\": 0,\n \"shippingPercentualTax\": 0,\n \"percentualDiscountValueList1\": 0,\n \"percentualDiscountValueList2\": 0,\n \"skusGift\": {\n \"quantitySelectable\": 0\n },\n \"nominalRewardValue\": 0,\n \"percentualRewardValue\": 0,\n \"orderStatusRewardValue\": \"invoiced\",\n \"maxNumberOfAffectedItems\": 0,\n \"maxNumberOfAffectedItemsGroupKey\": \"perCart\",\n \"applyToAllShippings\": false,\n \"nominalTax\": 0,\n \"origin\": \"marketplace\",\n \"idSellerIsInclusive\": false,\n \"idsSalesChannel\": [],\n \"areSalesChannelIdsExclusive\": false,\n \"marketingTags\": [],\n \"marketingTagsAreNotInclusive\": false,\n \"paymentsMethods\": [],\n \"stores\": [],\n \"campaigns\": [],\n \"conditionsIds\": [\n \"372e1868-2c0e-4437-be45-1ef8c9cab735\"\n ],\n \"storesAreInclusive\": false,\n \"categories\": [],\n \"categoriesAreInclusive\": false,\n \"brands\": [],\n \"brandsAreInclusive\": false,\n \"products\": [],\n \"productsAreInclusive\": false,\n \"skus\": [],\n \"skusAreInclusive\": true,\n \"utmSource\": \"georgeSource\",\n \"utmCampaign\": \"georgeTest\",\n \"collections1BuyTogether\": [],\n \"collections2BuyTogether\": [],\n \"minimumQuantityBuyTogether\": 0,\n \"quantityToAffectBuyTogether\": 0,\n \"enableBuyTogetherPerSku\": false,\n \"listSku1BuyTogether\": [],\n \"listSku2BuyTogether\": [],\n \"coupon\": [],\n \"totalValueFloor\": 0,\n \"totalValueCeling\": 0,\n \"totalValueIncludeAllItems\": false,\n \"totalValueMode\": \"IncludeMatchedItems\",\n \"collections\": [],\n \"collectionsIsInclusive\": false,\n \"restrictionsBins\": [],\n \"cardIssuers\": [],\n \"totalValuePurchase\": 0,\n \"slasIds\": [],\n \"isSlaSelected\": false,\n \"isFirstBuy\": false,\n \"firstBuyIsProfileOptimistic\": false,\n \"compareListPriceAndPrice\": false,\n \"isDifferentListPriceAndPrice\": false,\n \"zipCodeRanges\": [\n {\n \"zipCodeFrom\": \"20000-000\",\n \"zipCodeTo\": \"20000-100\",\n \"inclusive\": true\n }\n ],\n \"itemMaxPrice\": 0,\n \"itemMinPrice\": 0,\n \"installment\": 0,\n \"isMinMaxInstallments\": false,\n \"minInstallment\": 0,\n \"maxInstallment\": 0,\n \"merchants\": [],\n \"clusterExpressions\": [],\n \"paymentsRules\": [],\n \"giftListTypes\": [],\n \"productsSpecifications\": [],\n \"affiliates\": [],\n \"maxUsage\": 0,\n \"maxUsagePerClient\": 0,\n \"shouldDistributeDiscountAmongMatchedItems\": false,\n \"multipleUsePerClient\": false,\n \"accumulateWithManualPrice\": false,\n \"type\": \"regular\",\n \"useNewProgressiveAlgorithm\": false,\n \"percentualDiscountValueList\": []\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -809,7 +663,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "02131f0e-c076-48d0-a66c-c59234d61b80", + "id": "f353d2f9-6fd7-4d50-aa59-64fc2957b111", "name": "OK", "originalRequest": { "url": { @@ -823,36 +677,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -871,9 +698,21 @@ "key": "Accept", "value": "application/json" }, + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "POST", @@ -882,6 +721,7 @@ "raw": "{\n \"idCalculatorConfiguration\": \"d8a1cd2e-b667-4054-b3ae-b79124c7218e\",\n \"name\": \"Promotion Social Seller\",\n \"description\": \"Promotion for Social Seller\",\n \"beginDateUtc\": \"2020-05-01T18:47:15.89Z\",\n \"lastModified\": \"2021-09-17T18:13:16.2896414Z\",\n \"daysAgoOfPurchases\": 0,\n \"isActive\": true,\n \"isArchived\": false,\n \"isFeatured\": false,\n \"disableDeal\": false,\n \"activeDaysOfWeek\": [],\n \"offset\": -3,\n \"activateGiftsMultiplier\": false,\n \"newOffset\": -3,\n \"maxPricesPerItems\": [],\n \"cumulative\": false,\n \"discountType\": \"percentual\",\n \"nominalShippingDiscountValue\": 0,\n \"absoluteShippingDiscountValue\": 0,\n \"nominalDiscountValue\": 10,\n \"nominalDiscountType\": \"item\",\n \"maximumUnitPriceDiscount\": 0,\n \"percentualDiscountValue\": 10,\n \"rebatePercentualDiscountValue\": 0,\n \"percentualShippingDiscountValue\": 0,\n \"percentualTax\": 0,\n \"shippingPercentualTax\": 0,\n \"percentualDiscountValueList1\": 0,\n \"percentualDiscountValueList2\": 0,\n \"skusGift\": {\n \"quantitySelectable\": 0\n },\n \"nominalRewardValue\": 0,\n \"percentualRewardValue\": 0,\n \"orderStatusRewardValue\": \"invoiced\",\n \"maxNumberOfAffectedItems\": 0,\n \"maxNumberOfAffectedItemsGroupKey\": \"perCart\",\n \"applyToAllShippings\": false,\n \"nominalTax\": 0,\n \"origin\": \"marketplace\",\n \"idSellerIsInclusive\": false,\n \"idsSalesChannel\": [],\n \"areSalesChannelIdsExclusive\": false,\n \"marketingTags\": [],\n \"marketingTagsAreNotInclusive\": false,\n \"paymentsMethods\": [],\n \"stores\": [],\n \"campaigns\": [],\n \"conditionsIds\": [\n \"372e1868-2c0e-4437-be45-1ef8c9cab735\"\n ],\n \"storesAreInclusive\": false,\n \"categories\": [],\n \"categoriesAreInclusive\": false,\n \"brands\": [],\n \"brandsAreInclusive\": false,\n \"products\": [],\n \"productsAreInclusive\": false,\n \"skus\": [],\n \"skusAreInclusive\": true,\n \"utmSource\": \"georgeSource\",\n \"utmCampaign\": \"georgeTest\",\n \"collections1BuyTogether\": [],\n \"collections2BuyTogether\": [],\n \"minimumQuantityBuyTogether\": 0,\n \"quantityToAffectBuyTogether\": 0,\n \"enableBuyTogetherPerSku\": false,\n \"listSku1BuyTogether\": [],\n \"listSku2BuyTogether\": [],\n \"coupon\": [],\n \"totalValueFloor\": 0,\n \"totalValueCeling\": 0,\n \"totalValueIncludeAllItems\": false,\n \"totalValueMode\": \"IncludeMatchedItems\",\n \"collections\": [],\n \"collectionsIsInclusive\": false,\n \"restrictionsBins\": [],\n \"cardIssuers\": [],\n \"totalValuePurchase\": 0,\n \"slasIds\": [],\n \"isSlaSelected\": false,\n \"isFirstBuy\": false,\n \"firstBuyIsProfileOptimistic\": false,\n \"compareListPriceAndPrice\": false,\n \"isDifferentListPriceAndPrice\": false,\n \"zipCodeRanges\": [\n {\n \"zipCodeFrom\": \"20000-000\",\n \"zipCodeTo\": \"20000-100\",\n \"inclusive\": true\n }\n ],\n \"itemMaxPrice\": 0,\n \"itemMinPrice\": 0,\n \"installment\": 0,\n \"isMinMaxInstallments\": false,\n \"minInstallment\": 0,\n \"maxInstallment\": 0,\n \"merchants\": [],\n \"clusterExpressions\": [],\n \"paymentsRules\": [],\n \"giftListTypes\": [],\n \"productsSpecifications\": [],\n \"affiliates\": [],\n \"maxUsage\": 0,\n \"maxUsagePerClient\": 0,\n \"shouldDistributeDiscountAmongMatchedItems\": false,\n \"multipleUsePerClient\": false,\n \"accumulateWithManualPrice\": false,\n \"type\": \"regular\",\n \"useNewProgressiveAlgorithm\": false,\n \"percentualDiscountValueList\": []\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -902,7 +742,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "25f58705-c25b-4502-a8b8-01ee2b34232a", + "id": "5c0f2100-cb33-4c1d-8b49-4f72a01be655", "name": "Bad request.", "originalRequest": { "url": { @@ -916,36 +756,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -964,9 +777,21 @@ "key": "Accept", "value": "application/json" }, + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "POST", @@ -975,6 +800,7 @@ "raw": "{\n \"idCalculatorConfiguration\": \"d8a1cd2e-b667-4054-b3ae-b79124c7218e\",\n \"name\": \"Promotion Social Seller\",\n \"description\": \"Promotion for Social Seller\",\n \"beginDateUtc\": \"2020-05-01T18:47:15.89Z\",\n \"lastModified\": \"2021-09-17T18:13:16.2896414Z\",\n \"daysAgoOfPurchases\": 0,\n \"isActive\": true,\n \"isArchived\": false,\n \"isFeatured\": false,\n \"disableDeal\": false,\n \"activeDaysOfWeek\": [],\n \"offset\": -3,\n \"activateGiftsMultiplier\": false,\n \"newOffset\": -3,\n \"maxPricesPerItems\": [],\n \"cumulative\": false,\n \"discountType\": \"percentual\",\n \"nominalShippingDiscountValue\": 0,\n \"absoluteShippingDiscountValue\": 0,\n \"nominalDiscountValue\": 10,\n \"nominalDiscountType\": \"item\",\n \"maximumUnitPriceDiscount\": 0,\n \"percentualDiscountValue\": 10,\n \"rebatePercentualDiscountValue\": 0,\n \"percentualShippingDiscountValue\": 0,\n \"percentualTax\": 0,\n \"shippingPercentualTax\": 0,\n \"percentualDiscountValueList1\": 0,\n \"percentualDiscountValueList2\": 0,\n \"skusGift\": {\n \"quantitySelectable\": 0\n },\n \"nominalRewardValue\": 0,\n \"percentualRewardValue\": 0,\n \"orderStatusRewardValue\": \"invoiced\",\n \"maxNumberOfAffectedItems\": 0,\n \"maxNumberOfAffectedItemsGroupKey\": \"perCart\",\n \"applyToAllShippings\": false,\n \"nominalTax\": 0,\n \"origin\": \"marketplace\",\n \"idSellerIsInclusive\": false,\n \"idsSalesChannel\": [],\n \"areSalesChannelIdsExclusive\": false,\n \"marketingTags\": [],\n \"marketingTagsAreNotInclusive\": false,\n \"paymentsMethods\": [],\n \"stores\": [],\n \"campaigns\": [],\n \"conditionsIds\": [\n \"372e1868-2c0e-4437-be45-1ef8c9cab735\"\n ],\n \"storesAreInclusive\": false,\n \"categories\": [],\n \"categoriesAreInclusive\": false,\n \"brands\": [],\n \"brandsAreInclusive\": false,\n \"products\": [],\n \"productsAreInclusive\": false,\n \"skus\": [],\n \"skusAreInclusive\": true,\n \"utmSource\": \"georgeSource\",\n \"utmCampaign\": \"georgeTest\",\n \"collections1BuyTogether\": [],\n \"collections2BuyTogether\": [],\n \"minimumQuantityBuyTogether\": 0,\n \"quantityToAffectBuyTogether\": 0,\n \"enableBuyTogetherPerSku\": false,\n \"listSku1BuyTogether\": [],\n \"listSku2BuyTogether\": [],\n \"coupon\": [],\n \"totalValueFloor\": 0,\n \"totalValueCeling\": 0,\n \"totalValueIncludeAllItems\": false,\n \"totalValueMode\": \"IncludeMatchedItems\",\n \"collections\": [],\n \"collectionsIsInclusive\": false,\n \"restrictionsBins\": [],\n \"cardIssuers\": [],\n \"totalValuePurchase\": 0,\n \"slasIds\": [],\n \"isSlaSelected\": false,\n \"isFirstBuy\": false,\n \"firstBuyIsProfileOptimistic\": false,\n \"compareListPriceAndPrice\": false,\n \"isDifferentListPriceAndPrice\": false,\n \"zipCodeRanges\": [\n {\n \"zipCodeFrom\": \"20000-000\",\n \"zipCodeTo\": \"20000-100\",\n \"inclusive\": true\n }\n ],\n \"itemMaxPrice\": 0,\n \"itemMinPrice\": 0,\n \"installment\": 0,\n \"isMinMaxInstallments\": false,\n \"minInstallment\": 0,\n \"maxInstallment\": 0,\n \"merchants\": [],\n \"clusterExpressions\": [],\n \"paymentsRules\": [],\n \"giftListTypes\": [],\n \"productsSpecifications\": [],\n \"affiliates\": [],\n \"maxUsage\": 0,\n \"maxUsagePerClient\": 0,\n \"shouldDistributeDiscountAmongMatchedItems\": false,\n \"multipleUsePerClient\": false,\n \"accumulateWithManualPrice\": false,\n \"type\": \"regular\",\n \"useNewProgressiveAlgorithm\": false,\n \"percentualDiscountValueList\": []\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -996,13 +822,13 @@ { "listen": "test", "script": { - "id": "c1e0c74b-d0d2-4555-82e6-0d79bc655d6c", + "id": "c019449a-4a00-4101-803f-66a9dc1918ff", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/rnb/pvt/calculatorconfiguration - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[POST]::/api/rnb/pvt/calculatorconfiguration - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[POST]::/api/rnb/pvt/calculatorconfiguration - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"type\":\"object\",\"properties\":{\"idCalculatorConfiguration\":{\"type\":\"string\",\"description\":\"Promotion ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Promotion Name.\"},\"description\":{\"type\":\"string\",\"description\":\"Promotion internal description.\"},\"beginDateUtc\":{\"type\":\"string\",\"description\":\"Promotion Begin Date (UTC).\"},\"endDateUtc\":{\"type\":\"string\",\"description\":\"Promotion End Date (UTC).\"},\"lastModified\":{\"type\":\"string\",\"description\":\"When the Promotion was last modified.\"},\"daysAgoOfPurchases\":{\"type\":\"integer\",\"description\":\"Number of days that are considered to add the purchase history.\"},\"isActive\":{\"type\":\"boolean\",\"description\":\"If set as `true` the Promotion is activated. If set as `false` the Promotion is deactivated.\"},\"isArchived\":{\"type\":\"boolean\",\"description\":\"If set as `true` the Promotion is archived. If set as `false` the Promotion is not archived.\"},\"isFeatured\":{\"type\":\"boolean\",\"description\":\"Insert a flag with the promotion name used in the product's window display and page.\"},\"disableDeal\":{\"type\":\"boolean\",\"deprecated\":true,\"description\":\"Indicates whether a deal is disabled (`true`) or not (`false`).\"},\"activeDaysOfWeek\":{\"type\":\"array\",\"description\":\"Defines which days of the week the promotion will applied.\",\"items\":{\"type\":\"string\",\"description\":\"Day of the week that the promotion will be valid.\"}},\"offset\":{\"type\":\"integer\",\"description\":\"Time offset from UTC in seconds.\"},\"activateGiftsMultiplier\":{\"type\":\"boolean\",\"description\":\"If set as `true`, it activates gifts Multiplier.\"},\"newOffset\":{\"type\":\"number\",\"description\":\"New time offset from UTC in seconds.\"},\"maxPricesPerItems\":{\"type\":\"array\",\"deprecated\":true,\"description\":\"List of max price per items.\",\"items\":{\"type\":\"string\",\"description\":\"Max price.\"}},\"cumulative\":{\"type\":\"boolean\",\"description\":\"Defines if a promotion can accumulate with another one. (`true`) or not (`false`).\"},\"discountType\":{\"type\":\"string\",\"description\":\"The type of discount that will apply to the promotion.\"},\"nominalShippingDiscountValue\":{\"type\":\"number\",\"description\":\"Exact discount to be applied for the shipping value.\"},\"absoluteShippingDiscountValue\":{\"type\":\"number\",\"description\":\"Maximum shipping value.\"},\"nominalDiscountValue\":{\"type\":\"number\",\"description\":\"Exact discount to be applied for the total purchase value.\"},\"maximumUnitPriceDiscount\":{\"type\":\"number\",\"description\":\"The maximum price for each item of the purchase will be the price set up.\"},\"percentualDiscountValue\":{\"type\":\"number\",\"description\":\"Percentage discount to be applied for total purchase value.\"},\"rebatePercentualDiscountValue\":{\"type\":\"number\",\"description\":\"Percentual Shipping Discount Value.\"},\"percentualShippingDiscountValue\":{\"type\":\"number\",\"description\":\"Percentage discount to be applied for shipping value.\"},\"percentualTax\":{\"type\":\"number\",\"description\":\"Percentual tax over purchase total value.\"},\"shippingPercentualTax\":{\"type\":\"number\",\"description\":\"Shipping Percentual tax over purchase total value.\"},\"percentualDiscountValueList1\":{\"type\":\"number\",\"description\":\"Valid discounts for the SKUs in `listSku1BuyTogether`, discount list used for Buy Together Promotions.\"},\"percentualDiscountValueList2\":{\"type\":\"number\",\"description\":\"Equivalent to `percentualDiscountValueList1`.\"},\"skusGift\":{\"type\":\"object\",\"description\":\"SKU Gift Object. Total discount on the product value set as a gift.\",\"properties\":{\"quantitySelectable\":{\"type\":\"integer\",\"description\":\"Quantity of SKU Gifts.\"},\"gifts\":{\"type\":\"integer\",\"description\":\"Array with SKU Gifts IDs.\"}}},\"nominalRewardValue\":{\"type\":\"number\",\"description\":\"Nominal value for rewards program.\"},\"percentualRewardValue\":{\"type\":\"number\",\"description\":\"Percentage value for rewards program.\"},\"orderStatusRewardValue\":{\"type\":\"string\",\"description\":\"Order status reward value.\"},\"maxNumberOfAffectedItems\":{\"type\":\"integer\",\"description\":\"The maximum number of affected items for a promotion.\"},\"maxNumberOfAffectedItemsGroupKey\":{\"type\":\"string\",\"description\":\"The maximum number of affected items by group key for a promotion.\"},\"applyToAllShippings\":{\"type\":\"boolean\",\"description\":\"Promotion will be applied to all kind of shipping.\"},\"nominalTax\":{\"type\":\"number\",\"description\":\"Nominal tax.\"},\"origin\":{\"type\":\"string\",\"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.\"},\"idSeller\":{\"type\":\"string\",\"description\":\"Seller Name.\"},\"idSellerIsInclusive\":{\"type\":\"boolean\",\"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.\"},\"idsSalesChannel\":{\"type\":\"array\",\"description\":\"List of Trade Policies that activate this promotion.\",\"items\":{\"type\":\"string\",\"description\":\"Trade policy ID.\"}},\"areSalesChannelIdsExclusive\":{\"type\":\"boolean\",\"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.\"},\"marketingTags\":{\"type\":\"array\",\"description\":\"Promotion Marketing tags.\",\"items\":{\"type\":\"string\",\"description\":\"Promotion Marketing tag.\"}},\"marketingTagsAreNotInclusive\":{\"type\":\"boolean\",\"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.\"},\"paymentsMethods\":{\"type\":\"array\",\"description\":\"Array composed by all the Payments Methods.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the Payment Method.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Payment Method ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Payment Method Name.\"}}}},\"stores\":{\"type\":\"array\",\"deprecated\":true,\"description\":\"List of stores.\",\"items\":{\"type\":\"string\",\"description\":\"Store.\"}},\"campaigns\":{\"type\":\"array\",\"description\":\"Campaign Audiences that activate this promotion.\",\"items\":{\"type\":\"string\",\"description\":\"Campaign audience.\"}},\"conditionsIds\":{\"type\":\"array\",\"description\":\"Array with conditions IDs.\",\"items\":{\"type\":\"string\",\"description\":\"Condition ID.\"}},\"storesAreInclusive\":{\"type\":\"boolean\",\"deprecated\":true,\"description\":\"If set to `true`, this promotion will be applied to any store present on the `stores` field. If set to `false`, stores present on that field will make this promotion not to be applied.\"},\"categories\":{\"type\":\"array\",\"description\":\"Object composed by the categories that will activate or deactivate the promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the category.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Category ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Category Name.\"}}}},\"categoriesAreInclusive\":{\"type\":\"boolean\",\"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.\"},\"brands\":{\"type\":\"array\",\"description\":\"Object composed by the brands that will activate or deactivate the promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the brand.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Brand ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Brand Name.\"}}}},\"brandsAreInclusive\":{\"type\":\"boolean\",\"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.\"},\"products\":{\"type\":\"array\",\"description\":\"Object composed by the products that will activate or deactivate the promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the product.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Product Name.\"}}}},\"productsAreInclusive\":{\"type\":\"boolean\",\"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.\"},\"skus\":{\"type\":\"array\",\"description\":\"Object composed by the SKUs that will activate or deactivate the promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the SKU.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SKU ID.\"},\"name\":{\"type\":\"string\",\"description\":\"SKU Name.\"}}}},\"skusAreInclusive\":{\"type\":\"boolean\",\"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.\"},\"utmSource\":{\"type\":\"string\",\"description\":\"Coupon utmSource code.\"},\"utmCampaign\":{\"type\":\"string\",\"description\":\"Coupon utmCampaign code.\"},\"collections1BuyTogether\":{\"type\":\"array\",\"description\":\"Collections that will generate the promotion, type **Buy Together**, **More for less**, **Progressive Discount**, **Buy One Get One**.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the collection to be added to the first list of the **Buy Together** promotion.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the collection to be added to the first list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the collection to be added to the first list of the **Buy Together** promotion.\"}}}},\"collections2BuyTogether\":{\"type\":\"array\",\"deprecated\":true,\"description\":\"Collections that will generate the promotion, type **Buy Together**, **More for less**, **Progressive Discount**, **Buy One Get One**.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the collection to be added to the first list of the **Buy Together** promotion.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the collection to be added to the first list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the collection to be added to the first list of the **Buy Together** promotion.\"}}}},\"minimumQuantityBuyTogether\":{\"type\":\"integer\",\"description\":\"Minimum quantity for **Buy Together** promotion.\"},\"quantityToAffectBuyTogether\":{\"type\":\"integer\",\"description\":\"Quantity to affect **Buy Together** promotion.\"},\"enableBuyTogetherPerSku\":{\"type\":\"boolean\",\"description\":\"Enable **Buy Together** per SKU.\"},\"listSku1BuyTogether\":{\"type\":\"array\",\"description\":\"Array of objects, each containing ID and Name of an SKU to be added in the first list of the **Buy Together** promotion. Learn more about this type of promotion in the [Creating a Buy Together promotion](https://help.vtex.com/en/tutorial/buy-together--tutorials_323) documentation.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the SKU to be added to the first list of the **Buy Together** promotion. Learn more about this type of promotion in the [Creating a Buy Together promotion](https://help.vtex.com/en/tutorial/buy-together--tutorials_323) documentation.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the SKU to be added to the first list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the SKU to be added to the first list of the **Buy Together** promotion.\"}}}},\"listSku2BuyTogether\":{\"type\":\"array\",\"description\":\"Array of objects, each containing ID and Name of an SKU to be added to the second list of the **Buy Together** promotion. Learn more about this type of promotion in the [Creating a Buy Together promotion](https://help.vtex.com/en/tutorial/buy-together--tutorials_323) documentation.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the SKU to be added to the second list of the **Buy Together** promotion. Learn more about this type of promotion in the [Creating a Buy Together promotion](https://help.vtex.com/en/tutorial/buy-together--tutorials_323) documentation.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the SKU to be added to the second list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the SKU to be added to the second list of the **Buy Together** promotion.\"}}}},\"coupon\":{\"type\":\"array\",\"deprecated\":true,\"description\":\"List of coupons.\",\"items\":{\"type\":\"string\",\"description\":\"Coupon code.\"}},\"totalValueFloor\":{\"type\":\"number\",\"description\":\"Minimum chart value to activate the promotion.\"},\"totalValueCeling\":{\"type\":\"number\",\"description\":\"Maximum chart value to activate the promotion.\"},\"totalValueIncludeAllItems\":{\"type\":\"boolean\",\"deprecated\":true,\"description\":\"Total value including all items.\"},\"totalValueMode\":{\"type\":\"string\",\"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`.\"},\"collections\":{\"type\":\"array\",\"description\":\"Object composed by the collections that will activate or deactivate the promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the collection.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Collection ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Collection Name.\"}}}},\"collectionsIsInclusive\":{\"type\":\"boolean\",\"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.\"},\"restrictionsBins\":{\"type\":\"array\",\"description\":\"The discount will be granted if the card's BIN is given.\",\"items\":{\"type\":\"string\",\"description\":\"Card's BIN.\"}},\"cardIssuers\":{\"type\":\"array\",\"deprecated\":true,\"description\":\"List of card issuers.\",\"items\":{\"type\":\"string\",\"description\":\"Card issuer.\"}},\"totalValuePurchase\":{\"type\":\"number\",\"description\":\"Total value a client must have in past orders to active the promotion.\"},\"slasIds\":{\"type\":\"array\",\"description\":\"The discount will be granted if the shipping method is the same as the one given.\",\"items\":{\"type\":\"string\",\"description\":\"Shipping method.\"}},\"isSlaSelected\":{\"type\":\"boolean\",\"description\":\"Applies selected discount only when one of the defined shipping method is selected by the customer.\"},\"isFirstBuy\":{\"type\":\"boolean\",\"description\":\"Applies the discount only if it's a first buy.\"},\"firstBuyIsProfileOptimistic\":{\"type\":\"boolean\",\"description\":\"Applies the discount even if the user is not logged.\"},\"compareListPriceAndPrice\":{\"type\":\"boolean\",\"description\":\"If the **List Price** and **Price** are the same.\"},\"isDifferentListPriceAndPrice\":{\"type\":\"boolean\",\"description\":\"Applies the promotion only if the list price and price is different.\"},\"zipCodeRanges\":{\"type\":\"array\",\"description\":\"Range of the zip code that applies the promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the Zip Code.\",\"properties\":{\"zipCodeFrom\":{\"type\":\"string\",\"description\":\"Initial Zip Code.\"},\"zipCodeTo\":{\"type\":\"string\",\"description\":\"Final Zip Code.\"},\"inclusive\":{\"type\":\"boolean\",\"description\":\"Defines if the zip code range is included in the promotion.\"}}}},\"itemMaxPrice\":{\"type\":\"number\",\"description\":\"Maximum price of the item.\"},\"itemMinPrice\":{\"type\":\"number\",\"description\":\"Minimum price of the item.\"},\"installment\":{\"type\":\"integer\",\"deprecated\":true,\"description\":\"Installment.\"},\"isMinMaxInstallments\":{\"type\":\"boolean\",\"description\":\"Set if the promotion will be applied considering a minimum and maximum values for installments.\"},\"minInstallment\":{\"type\":\"integer\",\"description\":\"Minimum value for installment.\"},\"maxInstallment\":{\"type\":\"integer\",\"description\":\"Maximum value for installment.\"},\"merchants\":{\"type\":\"array\",\"deprecated\":true,\"description\":\"List of merchants.\",\"items\":{\"type\":\"string\",\"description\":\"Merchant.\"}},\"clusterExpressions\":{\"type\":\"array\",\"description\":\"Criteria to select a customer cluster. Each item in this array should follow the format of an equality function (`{propertyname}={value}`) or the format of a contains function (`{propertyname} contains {value}`). In both options, `{propertyname}` must be replaced with the name of the field in the data entity, and `{value}` must be replaced with the value determined in Master Data. Find more information about these criteria in [Filling in the Customer cluster field](https://help.vtex.com/tutorial/creating-promotion-for-a-customer-cluster--tutorials_342#filling-in-the-customer-cluster-field).\",\"items\":{\"type\":\"string\",\"description\":\"Cluster expression.\"}},\"paymentsRules\":{\"type\":\"array\",\"deprecated\":true,\"description\":\"List of payment rules.\",\"items\":{\"type\":\"string\",\"description\":\"Payment rule.\"}},\"giftListTypes\":{\"type\":\"array\",\"description\":\"Gifts List Type.\",\"items\":{\"type\":\"string\",\"description\":\"Gift List Type.\"}},\"productsSpecifications\":{\"type\":\"array\",\"deprecated\":true,\"description\":\"List of product specifications.\",\"items\":{\"type\":\"string\",\"description\":\"Product specification.\"}},\"affiliates\":{\"type\":\"array\",\"description\":\"Marketplace order identifier. The discount will apply to selected affiliates.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the affiliate.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Affiliate ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Affiliate Name.\"}}}},\"maxUsage\":{\"type\":\"integer\",\"description\":\"Defines how many times the promotion can be used.\"},\"maxUsagePerClient\":{\"type\":\"integer\",\"description\":\"Defines if the promotion can be used multiple times per client.\"},\"shouldDistributeDiscountAmongMatchedItems\":{\"type\":\"boolean\",\"description\":\"Should distribute discount among matched items.\"},\"multipleUsePerClient\":{\"type\":\"boolean\",\"description\":\"Defines if the promotion can be used multiple times per client.\"},\"accumulateWithManualPrice\":{\"type\":\"boolean\",\"description\":\"Allows the promotion to apply to products whose prices have been manually added by a call-center operator.\"},\"type\":{\"type\":\"string\",\"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).\"},\"useNewProgressiveAlgorithm\":{\"type\":\"boolean\",\"description\":\"Use new progressive algorithm.\"},\"percentualDiscountValueList\":{\"type\":\"array\",\"description\":\"Percentual discount value list.\",\"items\":{\"type\":\"number\",\"description\":\"Percentual discount value.\"}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[POST]::/api/rnb/pvt/calculatorconfiguration - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"type\":\"object\",\"properties\":{\"idCalculatorConfiguration\":{\"type\":\"string\",\"description\":\"Promotion ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Promotion Name.\"},\"description\":{\"type\":\"string\",\"description\":\"Promotion internal description.\"},\"beginDateUtc\":{\"type\":\"string\",\"description\":\"Promotion Begin Date (UTC).\"},\"endDateUtc\":{\"type\":\"string\",\"description\":\"Promotion End Date (UTC).\"},\"lastModified\":{\"type\":\"string\",\"description\":\"When the Promotion was last modified.\"},\"daysAgoOfPurchases\":{\"type\":\"integer\",\"description\":\"Number of days that are considered to add the purchase history.\"},\"isActive\":{\"type\":\"boolean\",\"description\":\"If set as `true` the Promotion is activated. If set as `false` the Promotion is deactivated.\"},\"isArchived\":{\"type\":\"boolean\",\"description\":\"If set as `true` the Promotion is archived. If set as `false` the Promotion is not archived.\"},\"isFeatured\":{\"type\":\"boolean\",\"description\":\"Insert a flag with the promotion name used in the product's window display and page.\"},\"disableDeal\":{\"type\":\"boolean\",\"description\":\"Indicates whether a deal is disabled (`true`) or not (`false`).\"},\"activeDaysOfWeek\":{\"type\":\"array\",\"description\":\"Defines which days of the week the promotion will applied.\",\"items\":{\"type\":\"string\",\"description\":\"Day of the week that the promotion will be valid.\"}},\"offset\":{\"type\":\"integer\",\"description\":\"Time offset from UTC in seconds.\"},\"activateGiftsMultiplier\":{\"type\":\"boolean\",\"description\":\"If set as `true`, it activates gifts Multiplier.\"},\"newOffset\":{\"type\":\"number\",\"description\":\"New time offset from UTC in seconds.\"},\"maxPricesPerItems\":{\"type\":\"array\",\"description\":\"List of max price per items.\",\"items\":{\"type\":\"string\",\"description\":\"Max price.\"}},\"cumulative\":{\"type\":\"boolean\",\"description\":\"Defines if a promotion can accumulate with another one. (`true`) or not (`false`).\"},\"discountType\":{\"type\":\"string\",\"description\":\"The type of discount that will apply to the promotion.\"},\"nominalShippingDiscountValue\":{\"type\":\"number\",\"description\":\"Exact discount to be applied for the shipping value.\"},\"absoluteShippingDiscountValue\":{\"type\":\"number\",\"description\":\"Maximum shipping value.\"},\"nominalDiscountValue\":{\"type\":\"number\",\"description\":\"Exact discount to be applied for the total purchase value.\"},\"maximumUnitPriceDiscount\":{\"type\":\"number\",\"description\":\"The maximum price for each item of the purchase will be the price set up.\"},\"percentualDiscountValue\":{\"type\":\"number\",\"description\":\"Percentage discount to be applied for total purchase value.\"},\"rebatePercentualDiscountValue\":{\"type\":\"number\",\"description\":\"Percentual Shipping Discount Value.\"},\"percentualShippingDiscountValue\":{\"type\":\"number\",\"description\":\"Percentage discount to be applied for shipping value.\"},\"percentualTax\":{\"type\":\"number\",\"description\":\"Percentual tax over purchase total value.\"},\"shippingPercentualTax\":{\"type\":\"number\",\"description\":\"Shipping Percentual tax over purchase total value.\"},\"percentualDiscountValueList1\":{\"type\":\"number\",\"description\":\"Valid discounts for the SKUs in `listSku1BuyTogether`, discount list used for Buy Together Promotions.\"},\"percentualDiscountValueList2\":{\"type\":\"number\",\"description\":\"Equivalent to `percentualDiscountValueList1`.\"},\"skusGift\":{\"type\":\"object\",\"description\":\"SKU Gift Object. Total discount on the product value set as a gift.\",\"properties\":{\"quantitySelectable\":{\"type\":\"integer\",\"description\":\"Quantity of SKU Gifts.\"},\"gifts\":{\"type\":\"integer\",\"description\":\"Array with SKU Gifts IDs.\"}}},\"nominalRewardValue\":{\"type\":\"number\",\"description\":\"Nominal value for rewards program.\"},\"percentualRewardValue\":{\"type\":\"number\",\"description\":\"Percentage value for rewards program.\"},\"orderStatusRewardValue\":{\"type\":\"string\",\"description\":\"Order status reward value.\"},\"maxNumberOfAffectedItems\":{\"type\":\"integer\",\"description\":\"The maximum number of affected items for a promotion.\"},\"maxNumberOfAffectedItemsGroupKey\":{\"type\":\"string\",\"description\":\"The maximum number of affected items by group key for a promotion.\"},\"applyToAllShippings\":{\"type\":\"boolean\",\"description\":\"Promotion will be applied to all kind of shipping.\"},\"nominalTax\":{\"type\":\"number\",\"description\":\"Nominal tax.\"},\"origin\":{\"type\":\"string\",\"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.\"},\"idSeller\":{\"type\":\"string\",\"description\":\"Seller Name.\"},\"idSellerIsInclusive\":{\"type\":\"boolean\",\"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.\"},\"idsSalesChannel\":{\"type\":\"array\",\"description\":\"List of Trade Policies that activate this promotion.\",\"items\":{\"type\":\"string\",\"description\":\"Trade policy ID.\"}},\"areSalesChannelIdsExclusive\":{\"type\":\"boolean\",\"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.\"},\"marketingTags\":{\"type\":\"array\",\"description\":\"Promotion Marketing tags.\",\"items\":{\"type\":\"string\",\"description\":\"Promotion Marketing tag.\"}},\"marketingTagsAreNotInclusive\":{\"type\":\"boolean\",\"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.\"},\"paymentsMethods\":{\"type\":\"array\",\"description\":\"Array composed by all the Payments Methods.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the Payment Method.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Payment Method ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Payment Method Name.\"}}}},\"stores\":{\"type\":\"array\",\"description\":\"List of stores.\",\"items\":{\"type\":\"string\",\"description\":\"Store.\"}},\"campaigns\":{\"type\":\"array\",\"description\":\"Campaign Audiences that activate this promotion.\",\"items\":{\"type\":\"string\",\"description\":\"Campaign audience.\"}},\"conditionsIds\":{\"type\":\"array\",\"description\":\"Array with conditions IDs.\",\"items\":{\"type\":\"string\",\"description\":\"Condition ID.\"}},\"storesAreInclusive\":{\"type\":\"boolean\",\"description\":\"If set to `true`, this promotion will be applied to any store present on the `stores` field. If set to `false`, stores present on that field will make this promotion not to be applied.\"},\"categories\":{\"type\":\"array\",\"description\":\"Object composed by the categories that will activate or deactivate the promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the category.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Category ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Category Name.\"}}}},\"categoriesAreInclusive\":{\"type\":\"boolean\",\"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.\"},\"brands\":{\"type\":\"array\",\"description\":\"Object composed by the brands that will activate or deactivate the promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the brand.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Brand ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Brand Name.\"}}}},\"brandsAreInclusive\":{\"type\":\"boolean\",\"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.\"},\"products\":{\"type\":\"array\",\"description\":\"Object composed by the products that will activate or deactivate the promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the product.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Product Name.\"}}}},\"productsAreInclusive\":{\"type\":\"boolean\",\"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.\"},\"skus\":{\"type\":\"array\",\"description\":\"Object composed by the SKUs that will activate or deactivate the promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the SKU.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SKU ID.\"},\"name\":{\"type\":\"string\",\"description\":\"SKU Name.\"}}}},\"skusAreInclusive\":{\"type\":\"boolean\",\"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.\"},\"utmSource\":{\"type\":\"string\",\"description\":\"Coupon utmSource code.\"},\"utmCampaign\":{\"type\":\"string\",\"description\":\"Coupon utmCampaign code.\"},\"collections1BuyTogether\":{\"type\":\"array\",\"description\":\"Collections that will generate the promotion, type **Buy Together**, **More for less**, **Progressive Discount**, **Buy One Get One**.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the collection to be added to the first list of the **Buy Together** promotion.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the collection to be added to the first list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the collection to be added to the first list of the **Buy Together** promotion.\"}}}},\"collections2BuyTogether\":{\"type\":\"array\",\"description\":\"Collections that will generate the promotion, type **Buy Together**, **More for less**, **Progressive Discount**, **Buy One Get One**.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the collection to be added to the first list of the **Buy Together** promotion.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the collection to be added to the first list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the collection to be added to the first list of the **Buy Together** promotion.\"}}}},\"minimumQuantityBuyTogether\":{\"type\":\"integer\",\"description\":\"Minimum quantity for **Buy Together** promotion.\"},\"quantityToAffectBuyTogether\":{\"type\":\"integer\",\"description\":\"Quantity to affect **Buy Together** promotion.\"},\"enableBuyTogetherPerSku\":{\"type\":\"boolean\",\"description\":\"Enable **Buy Together** per SKU.\"},\"listSku1BuyTogether\":{\"type\":\"array\",\"description\":\"Array of objects, each containing ID and Name of an SKU to be added in the first list of the **Buy Together** promotion. Learn more about this type of promotion in the [Creating a Buy Together promotion](https://help.vtex.com/en/tutorial/buy-together--tutorials_323) documentation.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the SKU to be added to the first list of the **Buy Together** promotion. Learn more about this type of promotion in the [Creating a Buy Together promotion](https://help.vtex.com/en/tutorial/buy-together--tutorials_323) documentation.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the SKU to be added to the first list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the SKU to be added to the first list of the **Buy Together** promotion.\"}}}},\"listSku2BuyTogether\":{\"type\":\"array\",\"description\":\"Array of objects, each containing ID and Name of an SKU to be added to the second list of the **Buy Together** promotion. Learn more about this type of promotion in the [Creating a Buy Together promotion](https://help.vtex.com/en/tutorial/buy-together--tutorials_323) documentation.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the SKU to be added to the second list of the **Buy Together** promotion. Learn more about this type of promotion in the [Creating a Buy Together promotion](https://help.vtex.com/en/tutorial/buy-together--tutorials_323) documentation.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the SKU to be added to the second list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the SKU to be added to the second list of the **Buy Together** promotion.\"}}}},\"coupon\":{\"type\":\"array\",\"description\":\"List of coupons.\",\"items\":{\"type\":\"string\",\"description\":\"Coupon code.\"}},\"totalValueFloor\":{\"type\":\"number\",\"description\":\"Minimum chart value to activate the promotion.\"},\"totalValueCeling\":{\"type\":\"number\",\"description\":\"Maximum chart value to activate the promotion.\"},\"totalValueIncludeAllItems\":{\"type\":\"boolean\",\"description\":\"Total value including all items.\"},\"totalValueMode\":{\"type\":\"string\",\"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`.\"},\"collections\":{\"type\":\"array\",\"description\":\"Object composed by the collections that will activate or deactivate the promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the collection.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Collection ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Collection Name.\"}}}},\"collectionsIsInclusive\":{\"type\":\"boolean\",\"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.\"},\"restrictionsBins\":{\"type\":\"array\",\"description\":\"The discount will be granted if the card's BIN is given.\",\"items\":{\"type\":\"string\",\"description\":\"Card's BIN.\"}},\"cardIssuers\":{\"type\":\"array\",\"description\":\"List of card issuers.\",\"items\":{\"type\":\"string\",\"description\":\"Card issuer.\"}},\"totalValuePurchase\":{\"type\":\"number\",\"description\":\"Total value a client must have in past orders to active the promotion.\"},\"slasIds\":{\"type\":\"array\",\"description\":\"The discount will be granted if the shipping method is the same as the one given.\",\"items\":{\"type\":\"string\",\"description\":\"Shipping method.\"}},\"isSlaSelected\":{\"type\":\"boolean\",\"description\":\"Applies selected discount only when one of the defined shipping method is selected by the customer.\"},\"isFirstBuy\":{\"type\":\"boolean\",\"description\":\"Applies the discount only if it's a first buy.\"},\"firstBuyIsProfileOptimistic\":{\"type\":\"boolean\",\"description\":\"Applies the discount even if the user is not logged.\"},\"compareListPriceAndPrice\":{\"type\":\"boolean\",\"description\":\"If the **List Price** and **Price** are the same.\"},\"isDifferentListPriceAndPrice\":{\"type\":\"boolean\",\"description\":\"Applies the promotion only if the list price and price is different.\"},\"zipCodeRanges\":{\"type\":\"array\",\"description\":\"Range of the zip code that applies the promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the Zip Code.\",\"properties\":{\"zipCodeFrom\":{\"type\":\"string\",\"description\":\"Initial Zip Code.\"},\"zipCodeTo\":{\"type\":\"string\",\"description\":\"Final Zip Code.\"},\"inclusive\":{\"type\":\"boolean\",\"description\":\"Defines if the zip code range is included in the promotion.\"}}}},\"itemMaxPrice\":{\"type\":\"number\",\"description\":\"Maximum price of the item.\"},\"itemMinPrice\":{\"type\":\"number\",\"description\":\"Minimum price of the item.\"},\"installment\":{\"type\":\"integer\",\"description\":\"Installment.\"},\"isMinMaxInstallments\":{\"type\":\"boolean\",\"description\":\"Set if the promotion will be applied considering a minimum and maximum values for installments.\"},\"minInstallment\":{\"type\":\"integer\",\"description\":\"Minimum value for installment.\"},\"maxInstallment\":{\"type\":\"integer\",\"description\":\"Maximum value for installment.\"},\"merchants\":{\"type\":\"array\",\"description\":\"List of merchants.\",\"items\":{\"type\":\"string\",\"description\":\"Merchant.\"}},\"clusterExpressions\":{\"type\":\"array\",\"description\":\"Criteria to select a customer cluster. Each item in this array should follow the format of an equality function (`{propertyname}={value}`) or the format of a contains function (`{propertyname} contains {value}`). In both options, `{propertyname}` must be replaced with the name of the field in the data entity, and `{value}` must be replaced with the value determined in Master Data. Find more information about these criteria in [Filling in the Customer cluster field](https://help.vtex.com/tutorial/creating-promotion-for-a-customer-cluster--tutorials_342#filling-in-the-customer-cluster-field).\",\"items\":{\"type\":\"string\",\"description\":\"Cluster expression.\"}},\"paymentsRules\":{\"type\":\"array\",\"description\":\"List of payment rules.\",\"items\":{\"type\":\"string\",\"description\":\"Payment rule.\"}},\"giftListTypes\":{\"type\":\"array\",\"description\":\"Gifts List Type.\",\"items\":{\"type\":\"string\",\"description\":\"Gift List Type.\"}},\"productsSpecifications\":{\"type\":\"array\",\"description\":\"List of product specifications.\",\"items\":{\"type\":\"string\",\"description\":\"Product specification.\"}},\"affiliates\":{\"type\":\"array\",\"description\":\"Marketplace order identifier. The discount will apply to selected affiliates.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the affiliate.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Affiliate ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Affiliate Name.\"}}}},\"maxUsage\":{\"type\":\"integer\",\"description\":\"Defines how many times the promotion can be used.\"},\"maxUsagePerClient\":{\"type\":\"integer\",\"description\":\"Defines if the promotion can be used multiple times per client.\"},\"shouldDistributeDiscountAmongMatchedItems\":{\"type\":\"boolean\",\"description\":\"Should distribute discount among matched items.\"},\"multipleUsePerClient\":{\"type\":\"boolean\",\"description\":\"Defines if the promotion can be used multiple times per client.\"},\"accumulateWithManualPrice\":{\"type\":\"boolean\",\"description\":\"Allows the promotion to apply to products whose prices have been manually added by a call-center operator.\"},\"type\":{\"type\":\"string\",\"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).\"},\"useNewProgressiveAlgorithm\":{\"type\":\"boolean\",\"description\":\"Use new progressive algorithm.\"},\"percentualDiscountValueList\":{\"type\":\"array\",\"description\":\"Percentual discount value list.\",\"items\":{\"type\":\"number\",\"description\":\"Percentual discount value.\"}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[POST]::/api/rnb/pvt/calculatorconfiguration - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -1012,7 +838,7 @@ } }, { - "id": "733c7979-9fcb-4ad1-8fe2-61b909483b8a", + "id": "4be5e1a1-5ecc-4780-ab41-5aa83bc8d127", "name": "Create multiple SKU promotion", "request": { "name": "Create multiple SKU promotion", @@ -1032,26 +858,7 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ { @@ -1134,6 +941,10 @@ }, "key": "X-VTEX-accumulate-with-manual-prices", "value": "false" + }, + { + "key": "Content-Type", + "value": "text/csv" } ], "method": "POST", @@ -1146,7 +957,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "adb2a129-4ad5-4e0b-90cd-8502b7cad60d", + "id": "dc9b952d-b76e-46cd-8214-06036f935be1", "name": "OK", "originalRequest": { "url": { @@ -1161,36 +972,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -1271,6 +1055,18 @@ }, "key": "X-VTEX-accumulate-with-manual-prices", "value": "false" + }, + { + "key": "Content-Type", + "value": "text/csv" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "POST", @@ -1280,13 +1076,7 @@ }, "status": "OK", "code": 200, - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "body": "", + "header": [], "cookie": [] } ], @@ -1294,7 +1084,7 @@ { "listen": "test", "script": { - "id": "f17ea64b-b5b0-4925-84d8-eb6f83ba7375", + "id": "65a928d6-f471-49fb-af5a-37dc62bcd6ed", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/rnb/pvt/import/calculatorConfiguration - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -1307,7 +1097,7 @@ } }, { - "id": "3a6e7e9a-c74c-4995-adfc-2b1225a81502", + "id": "7039f46b-b41b-45ea-8a76-15e22212e29c", "name": "Update multiple SKU promotion", "request": { "name": "Update multiple SKU promotion", @@ -1338,24 +1128,6 @@ "type": "any", "value": "dc6b6f59-ec2b-4a13-8490-0d1e0c53ddf9", "key": "promotionId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" } ] }, @@ -1440,6 +1212,10 @@ }, "key": "X-VTEX-accumulate-with-manual-prices", "value": "false" + }, + { + "key": "Content-Type", + "value": "text/csv" } ], "method": "PUT", @@ -1452,7 +1228,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "defa1b00-0d31-4013-9601-fad954aa1c4b", + "id": "69430352-d547-46a8-9247-76b538eebd70", "name": "Accepted", "originalRequest": { "url": { @@ -1468,46 +1244,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) Promotion unique identifier.", - "type": "text/plain" - }, - "type": "any", - "value": "dc6b6f59-ec2b-4a13-8490-0d1e0c53ddf9", - "key": "promotionId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -1588,6 +1327,18 @@ }, "key": "X-VTEX-accumulate-with-manual-prices", "value": "false" + }, + { + "key": "Content-Type", + "value": "text/csv" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "PUT", @@ -1597,13 +1348,7 @@ }, "status": "Accepted", "code": 202, - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "body": "", + "header": [], "cookie": [] } ], @@ -1611,7 +1356,7 @@ { "listen": "test", "script": { - "id": "31031667-10a5-49c1-8e99-91b881924df6", + "id": "1844e5d9-d10e-4138-9dfd-457c8a35bd55", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/api/rnb/pvt/import/calculatorConfiguration/:promotionId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -1624,7 +1369,7 @@ } }, { - "id": "c8715cd3-9ef3-42e2-9c22-95dc82c01ca4", + "id": "3c543ebe-ae19-4de2-a666-2c52ee9da313", "name": "Archive promotion or tax", "request": { "name": "Archive promotion or tax", @@ -1655,24 +1400,6 @@ "type": "any", "value": "d8a1cd2e-b667-4054-b3ae-b79124c7218e", "key": "idCalculatorConfiguration" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" } ] }, @@ -1696,14 +1423,15 @@ "value": "application/json" } ], - "method": "POST" + "method": "POST", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "text" }, - "id": "f74b6483-7f1d-497d-ad65-56718c0d18e0", + "id": "cd9caf50-fb90-463d-83ea-d6d8e6f15ca2", "name": "No Content", "originalRequest": { "url": { @@ -1719,46 +1447,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) Promotion ID or tax ID.", - "type": "text/plain" - }, - "type": "any", - "value": "d8a1cd2e-b667-4054-b3ae-b79124c7218e", - "key": "idCalculatorConfiguration" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -1776,6 +1467,14 @@ }, "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "POST", @@ -1783,13 +1482,7 @@ }, "status": "No Content", "code": 204, - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "body": "", + "header": [], "cookie": [] } ], @@ -1797,7 +1490,7 @@ { "listen": "test", "script": { - "id": "54b63ba9-27b2-42eb-ac56-6755f37e64c4", + "id": "0e285066-022c-4bf7-817b-33fc2e24ad92", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/rnb/pvt/archive/calculatorConfiguration/:idCalculatorConfiguration - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1811,7 +1504,7 @@ } }, { - "id": "72780d3d-a780-4c21-b7d2-9990e6ef87b8", + "id": "e0dc5aac-85a8-4810-becb-8dc9ff078bc9", "name": "Unarchive promotion or tax", "request": { "name": "Unarchive promotion or tax", @@ -1842,24 +1535,6 @@ "type": "any", "value": "d8a1cd2e-b667-4054-b3ae-b79124c7218e", "key": "idCalculatorConfiguration" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" } ] }, @@ -1883,14 +1558,15 @@ "value": "application/json" } ], - "method": "POST" + "method": "POST", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "text" }, - "id": "277ab910-8ddc-4dde-aef3-32e8d52f4793", + "id": "2968522f-ad98-4330-9f00-6da81ea44811", "name": "No Content", "originalRequest": { "url": { @@ -1906,63 +1582,34 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) Promotion ID or tax ID.", - "type": "text/plain" - }, - "type": "any", - "value": "d8a1cd2e-b667-4054-b3ae-b79124c7218e", - "key": "idCalculatorConfiguration" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ { + "disabled": false, "description": { - "content": "Added as a part of security scheme: apikey", + "content": "(Required) Type of the content being sent.", "type": "text/plain" }, - "key": "X-VTEX-API-AppKey", - "value": "" + "key": "Content-Type", + "value": "application/json" }, { "disabled": false, "description": { - "content": "(Required) Type of the content being sent.", + "content": "(Required) HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "type": "text/plain" }, - "key": "Content-Type", + "key": "Accept", "value": "application/json" }, { - "disabled": false, "description": { - "content": "(Required) HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", + "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, - "key": "Accept", - "value": "application/json" + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "POST", @@ -1970,13 +1617,7 @@ }, "status": "No Content", "code": 204, - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "body": "", + "header": [], "cookie": [] } ], @@ -1984,7 +1625,7 @@ { "listen": "test", "script": { - "id": "5d04628f-51cc-410b-8c38-4b4c1e97853d", + "id": "74a4ae07-2711-4111-9d28-c6797a18425e", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/rnb/pvt/unarchive/calculatorConfiguration/:idCalculatorConfiguration - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1998,7 +1639,7 @@ } }, { - "id": "54cf714b-49b6-4e33-8e35-10dd7ce76782", + "id": "3879a255-3714-4418-ade6-6b5fe781ecfb", "name": "List archived promotions", "request": { "name": "List archived promotions", @@ -2019,26 +1660,7 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ { @@ -2058,16 +1680,21 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "GET" + "method": "GET", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, - "id": "3823408b-fcff-4d6b-9cfc-0bb7ca72a579", + "id": "ac4525f7-1db3-4459-9f98-378fcdb31a99", "name": "OK", "originalRequest": { "url": { @@ -2083,36 +1710,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -2134,6 +1734,14 @@ { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "GET", @@ -2155,7 +1763,7 @@ { "listen": "test", "script": { - "id": "90b2ea9b-e89a-4c46-95ed-4c09cf71d894", + "id": "3d02ffbb-a986-420e-9cf8-f32c12ef6c8c", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/rnb/pvt/archive/benefits/calculatorConfiguration - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2171,7 +1779,7 @@ } }, { - "id": "ce62d4bf-11bb-4641-9a13-9cf9be3be69c", + "id": "7bf74f0f-94bb-495b-b335-a8bd45290d79", "name": "List archived taxes", "request": { "name": "List archived taxes", @@ -2192,26 +1800,7 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ { @@ -2231,16 +1820,21 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "GET" + "method": "GET", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, - "id": "f55f6e38-714f-49eb-b0e1-a44d1b5e7759", + "id": "539cf3c0-7022-475a-bab1-57ca345ef9e1", "name": "OK", "originalRequest": { "url": { @@ -2256,36 +1850,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -2307,6 +1874,14 @@ { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "GET", @@ -2328,7 +1903,7 @@ { "listen": "test", "script": { - "id": "95c5c306-9f12-4f5c-b686-541ec12fee06", + "id": "567a4bfa-696d-42d6-9eb0-8e410a689e8d", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/rnb/pvt/archive/taxes/calculatorConfiguration - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2347,7 +1922,7 @@ "event": [] }, { - "id": "4baae343-6901-495b-89ab-af4226948793", + "id": "e7940abe-12c1-4f5d-a708-ff1d7121695b", "name": "Coupons", "description": { "content": "", @@ -2355,7 +1930,7 @@ }, "item": [ { - "id": "778c7de2-c794-44b0-a749-6f91e74233b0", + "id": "aedfa43e-0089-4b78-98c0-a02b785bb1e7", "name": "Create multiple coupons", "request": { "name": "Create multiple coupons", @@ -2374,26 +1949,7 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ { @@ -2413,6 +1969,14 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], "method": "POST", @@ -2421,6 +1985,7 @@ "raw": "[\n {\n \"quantity\": 1,\n \"couponConfiguration\": {\n \"utmSource\": \"fb\",\n \"utmCampaign\": \"bf\",\n \"couponCode\": \"promobf4\",\n \"isArchived\": false,\n \"maxItemsPerClient\": 10,\n \"expirationIntervalPerUse\": \"00:00:00\",\n \"maxUsage\": 1\n }\n }\n]", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -2431,7 +1996,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "593fc966-067f-4470-8bae-60ac0e487321", + "id": "1c2adb9b-24c6-44c8-98ca-a91235f28a4b", "name": "OK", "originalRequest": { "url": { @@ -2445,36 +2010,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -2493,9 +2031,21 @@ "key": "Accept", "value": "application/json" }, + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "POST", @@ -2504,6 +2054,7 @@ "raw": "[\n {\n \"quantity\": 1,\n \"couponConfiguration\": {\n \"utmSource\": \"fb\",\n \"utmCampaign\": \"bf\",\n \"couponCode\": \"promobf4\",\n \"isArchived\": false,\n \"maxItemsPerClient\": 10,\n \"expirationIntervalPerUse\": \"00:00:00\",\n \"maxUsage\": 1\n }\n }\n]", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -2525,7 +2076,7 @@ { "listen": "test", "script": { - "id": "c5c5fbed-8fe8-4b41-9eb6-bc2375b5156e", + "id": "8b5f8ca5-a952-4c51-a1bb-f1510c8ae81b", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/rnb/pvt/multiple-coupons - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2541,7 +2092,7 @@ } }, { - "id": "56e7174d-b9a1-43bc-a12f-eea00209639d", + "id": "3c75f05e-503a-40a1-9b6c-e593a8209f94", "name": "Create or update coupon", "request": { "name": "Create or update coupon", @@ -2560,26 +2111,7 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ { @@ -2599,6 +2131,14 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], "method": "POST", @@ -2607,6 +2147,7 @@ "raw": "{\n \"utmSource\": \"email\",\n \"couponCode\": \"summersale10\",\n \"maxItemsPerClient\": 10,\n \"expirationIntervalPerUse\": \"00:00:00\",\n \"utmCampaign\": \"summer\",\n \"isArchived\": false,\n \"maxUsage\": 1\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -2617,7 +2158,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "99510ef4-1e0c-4e85-9dd7-d429da8c04ce", + "id": "523cd8c7-8920-43c9-abbe-a6a41d0101e3", "name": "OK", "originalRequest": { "url": { @@ -2631,36 +2172,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -2679,9 +2193,21 @@ "key": "Accept", "value": "application/json" }, + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "POST", @@ -2690,6 +2216,7 @@ "raw": "{\n \"utmSource\": \"email\",\n \"couponCode\": \"summersale10\",\n \"maxItemsPerClient\": 10,\n \"expirationIntervalPerUse\": \"00:00:00\",\n \"utmCampaign\": \"summer\",\n \"isArchived\": false,\n \"maxUsage\": 1\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -2710,7 +2237,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "a56567aa-9b23-4cf7-9378-6ce17b827451", + "id": "b4432cba-0de9-4ce6-aa5f-db299c44ed2d", "name": "Created", "originalRequest": { "url": { @@ -2724,36 +2251,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -2772,9 +2272,21 @@ "key": "Accept", "value": "application/json" }, + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "POST", @@ -2783,6 +2295,7 @@ "raw": "{\n \"utmSource\": \"email\",\n \"couponCode\": \"summersale10\",\n \"maxItemsPerClient\": 10,\n \"expirationIntervalPerUse\": \"00:00:00\",\n \"utmCampaign\": \"summer\",\n \"isArchived\": false,\n \"maxUsage\": 1\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -2804,7 +2317,7 @@ { "listen": "test", "script": { - "id": "e6072768-429d-4b53-a15e-e09d2cbf627d", + "id": "06dcfb89-36de-403c-9cc6-a833bacc9de0", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/rnb/pvt/coupon - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2820,7 +2333,7 @@ } }, { - "id": "f39b7fe9-b951-4e34-b85f-1d2edfaca893", + "id": "2b538344-447b-4194-8ad9-75ae8805cc96", "name": "Get all coupons", "request": { "name": "Get all coupons", @@ -2839,26 +2352,7 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ { @@ -2878,16 +2372,21 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "GET" + "method": "GET", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, - "id": "5204be73-59a1-4388-9ea6-96cbbe874660", + "id": "f14f0aa2-9d79-4a50-a90f-631eb819462d", "name": "OK", "originalRequest": { "url": { @@ -2901,36 +2400,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -2952,6 +2424,14 @@ { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "GET", @@ -2973,7 +2453,7 @@ { "listen": "test", "script": { - "id": "9dfdf208-0783-496e-85a4-a6151083f752", + "id": "1439a107-5433-4a71-9608-3922a129ace6", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/rnb/pvt/coupon - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2989,7 +2469,7 @@ } }, { - "id": "63543cb4-6cbc-4024-92f9-40ca85ad102b", + "id": "7c57f8e8-9477-47cc-b7ca-8565c908f085", "name": "Get coupon by coupon code", "request": { "name": "Get coupon by coupon code", @@ -3019,24 +2499,6 @@ "type": "any", "value": "promo10", "key": "couponCode" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" } ] }, @@ -3058,16 +2520,21 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "GET" + "method": "GET", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, - "id": "9e3f12ad-17bd-481f-b273-d7b0f8cb205b", + "id": "9a610c00-10b5-462a-b816-2ffb0b527fc7", "name": "OK", "originalRequest": { "url": { @@ -3082,46 +2549,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) Coupon Code", - "type": "text/plain" - }, - "type": "any", - "value": "promo10", - "key": "couponCode" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -3143,6 +2573,14 @@ { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "GET", @@ -3164,7 +2602,7 @@ { "listen": "test", "script": { - "id": "2392d539-4251-4c48-b832-92dd8b52bca0", + "id": "d30b8a73-c7f2-4d1c-8288-a5aa10183bdb", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/rnb/pvt/coupon/:couponCode - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -3180,7 +2618,7 @@ } }, { - "id": "6b1fd9b3-e55d-4c05-9266-cbebaba539a5", + "id": "3ceeb247-13df-45c4-bc2f-d81ce75fb63c", "name": "Get archived coupon by coupon code", "request": { "name": "Get archived coupon by coupon code", @@ -3211,24 +2649,6 @@ "type": "any", "value": "promo10", "key": "couponCode" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" } ] }, @@ -3250,16 +2670,21 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "GET" + "method": "GET", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, - "id": "6d8b436d-c81d-43d3-9af8-c560b8c9c3d3", + "id": "1938d665-3a68-4cc5-b28c-4f43964d8656", "name": "OK", "originalRequest": { "url": { @@ -3275,46 +2700,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) Coupon Code", - "type": "text/plain" - }, - "type": "any", - "value": "promo10", - "key": "couponCode" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -3336,6 +2724,14 @@ { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "GET", @@ -3357,7 +2753,7 @@ { "listen": "test", "script": { - "id": "4cf485f4-a61b-4f3a-bff4-238daa0d2e19", + "id": "14c490e4-7607-45b3-a931-018fa1a7f51c", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/rnb/pvt/archive/coupon/:couponCode - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -3373,7 +2769,7 @@ } }, { - "id": "f4d1db3a-c18b-40f6-8027-3ae044584a5a", + "id": "65882f9a-2b7a-47aa-8bab-5cdddd5e85b2", "name": "Archive coupon by coupon code", "request": { "name": "Archive coupon by coupon code", @@ -3404,24 +2800,6 @@ "type": "any", "value": "test", "key": "couponCode" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" } ] }, @@ -3443,16 +2821,21 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "POST" + "method": "POST", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, - "id": "d69645dc-2fb1-4caf-bb78-c2d94cc24a34", + "id": "93afc2d5-f808-4a82-b0e8-dd84dceb7a89", "name": "OK", "originalRequest": { "url": { @@ -3468,46 +2851,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) Coupon Code", - "type": "text/plain" - }, - "type": "any", - "value": "test", - "key": "couponCode" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -3529,6 +2875,14 @@ { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "POST", @@ -3542,7 +2896,7 @@ "value": "application/json" } ], - "body": "\"promo10\"", + "body": "promo10", "cookie": [] } ], @@ -3550,7 +2904,7 @@ { "listen": "test", "script": { - "id": "7a571b30-2cd0-4aff-b430-c29c16b00109", + "id": "f328aa91-c886-4252-b29c-627459d51404", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/rnb/pvt/archive/coupon/:couponCode - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -3566,7 +2920,7 @@ } }, { - "id": "60297cd8-27e6-4fac-9802-c5f0ee05dc57", + "id": "9927b3e3-f6f2-4ab3-a14e-7880c7891f1d", "name": "Generate coupons in bulk", "request": { "name": "Generate coupons in bulk", @@ -3588,33 +2942,14 @@ { "disabled": false, "description": { - "content": "(Required) Quantity of coupons to generate", + "content": "(Required) 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.", "type": "text/plain" }, "key": "quantity", "value": "10" } ], - "variable": [ - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ { @@ -3634,6 +2969,14 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], "method": "POST", @@ -3642,6 +2985,7 @@ "raw": "{\n \"utmSource\": \"cupom3\",\n \"utmCampaign\": \"cupom3\",\n \"couponCode\": \"ctest\",\n \"maxItemsPerClient\": 1,\n \"expirationIntervalPerUse\": \"00:00:00\"\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -3652,7 +2996,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "244a3f6d-775e-4ad0-b381-105bbc1316f6", + "id": "5c39c860-f6da-4c85-aa80-312d310fe6ec", "name": "OK", "originalRequest": { "url": { @@ -3667,40 +3011,18 @@ ], "query": [ { - "key": "quantity", - "value": "10" - } - ], - "variable": [ - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { + "disabled": false, "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", + "content": "(Required) 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.", "type": "text/plain" }, - "type": "any", - "value": "{{environment}}", - "key": "environment" + "key": "quantity", + "value": "10" } - ] + ], + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -3719,9 +3041,21 @@ "key": "Accept", "value": "application/json" }, + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "POST", @@ -3730,6 +3064,7 @@ "raw": "{\n \"utmSource\": \"cupom3\",\n \"utmCampaign\": \"cupom3\",\n \"couponCode\": \"ctest\",\n \"maxItemsPerClient\": 1,\n \"expirationIntervalPerUse\": \"00:00:00\"\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -3751,7 +3086,7 @@ { "listen": "test", "script": { - "id": "48ee2c9b-0801-4e2f-9f3c-21682deeee68", + "id": "f462a570-c329-44c7-a547-01a3cc84edba", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/rnb/pvt/coupons - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -3767,7 +3102,7 @@ } }, { - "id": "6fd41d49-e627-4254-8774-0a9e785894c2", + "id": "e4703b09-3498-4e15-b63a-2376dcd21d29", "name": "Get coupon usage", "request": { "name": "Get coupon usage", @@ -3787,35 +3122,17 @@ "host": [ "{{baseUrl}}" ], - "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) Coupon Code", - "type": "text/plain" - }, - "type": "any", - "value": "test", - "key": "couponCode" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, + "query": [], + "variable": [ { + "disabled": false, "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", + "content": "(Required) Coupon Code", "type": "text/plain" }, "type": "any", - "value": "{{environment}}", - "key": "environment" + "value": "test", + "key": "couponCode" } ] }, @@ -3837,16 +3154,21 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "GET" + "method": "GET", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, - "id": "9b9cf116-2207-4c93-9555-e28098269d21", + "id": "9bc152b2-35d2-44b3-850f-18b138074885", "name": "OK", "originalRequest": { "url": { @@ -3862,46 +3184,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) Coupon Code", - "type": "text/plain" - }, - "type": "any", - "value": "test", - "key": "couponCode" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -3923,6 +3208,14 @@ { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "GET", @@ -3944,7 +3237,7 @@ { "listen": "test", "script": { - "id": "022a031f-c5dd-4416-b326-d4e6beee17f7", + "id": "f34ec2a6-2e55-4114-a26a-950c5144e01c", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/rnb/pvt/coupon/usage/:couponCode - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -3960,7 +3253,7 @@ } }, { - "id": "d2c79608-db74-45ff-b5c8-dc53d0c82d14", + "id": "31462937-99cf-4b58-826e-95a1fa2776c9", "name": "Unarchive coupon by coupon code", "request": { "name": "Unarchive coupon by coupon code", @@ -3991,24 +3284,6 @@ "type": "any", "value": "test", "key": "couponCode" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" } ] }, @@ -4030,16 +3305,21 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "POST" + "method": "POST", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, - "id": "eff814a5-b9fa-42b0-bf47-e93ac9d4455a", + "id": "8828be52-5918-4331-8b12-9994a5725f28", "name": "OK", "originalRequest": { "url": { @@ -4055,46 +3335,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) Coupon Code", - "type": "text/plain" - }, - "type": "any", - "value": "test", - "key": "couponCode" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -4116,6 +3359,14 @@ { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "POST", @@ -4129,7 +3380,7 @@ "value": "application/json" } ], - "body": "\"test\"", + "body": "test", "cookie": [] } ], @@ -4137,7 +3388,7 @@ { "listen": "test", "script": { - "id": "d8e084db-2355-42d8-b5c4-3230a61c87c9", + "id": "9c2aa3b5-7dfd-4a03-b8f4-5b377dafd78d", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/rnb/pvt/unarchive/coupon/:couponCode - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -4156,7 +3407,7 @@ "event": [] }, { - "id": "c084b4a4-43bd-4545-bc96-510b56b37f2e", + "id": "b22099ee-8f6c-46c9-b1ea-fbe327090763", "name": "Campaign Audiences", "description": { "content": "", @@ -4164,7 +3415,7 @@ }, "item": [ { - "id": "b9e636e4-6e6e-4dcb-80e9-f7c1228c488e", + "id": "497d4495-883d-4b3a-bd82-17f9f918d23d", "name": "Get campaign audience configuration", "request": { "name": "Get campaign audience configuration", @@ -4194,24 +3445,6 @@ "type": "any", "value": "dd270d06-1ed1-47fc-b04e-a2431121b5a4", "key": "campaignId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" } ] }, @@ -4233,16 +3466,21 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "GET" + "method": "GET", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, - "id": "5abee8be-156f-4237-944c-642038e0e9a5", + "id": "60d35db1-15ed-4c41-8041-31b8f15a4e25", "name": "OK", "originalRequest": { "url": { @@ -4257,46 +3495,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) Campaign audience unique identifier.", - "type": "text/plain" - }, - "type": "any", - "value": "dd270d06-1ed1-47fc-b04e-a2431121b5a4", - "key": "campaignId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -4318,6 +3519,14 @@ { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "GET", @@ -4339,13 +3548,13 @@ { "listen": "test", "script": { - "id": "94fc3d6c-6d2f-46b9-8166-1ecd5aa3feb2", + "id": "804a7554-e525-49df-8f38-f8c1c78d95ac", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/rnb/pvt/campaignConfiguration/:campaignId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[GET]::/api/rnb/pvt/campaignConfiguration/:campaignId - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[GET]::/api/rnb/pvt/campaignConfiguration/:campaignId - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"type\":\"object\",\"properties\":{\"beginDateUtc\":{\"type\":\"string\",\"description\":\"Start date of the campaign audience in UTC format.\"},\"endDateUtc\":{\"type\":\"string\",\"description\":\"End date of the campaign audience in UTC format.\"},\"id\":{\"type\":\"string\",\"description\":\"Campaign audience ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Campaign audience name.\"},\"isActive\":{\"type\":\"boolean\",\"description\":\"Defines if the campaign audience is active (`true`) or not (`false`).\"},\"isAndOperator\":{\"type\":\"boolean\",\"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.\"},\"isArchived\":{\"type\":\"boolean\",\"description\":\"Defines if the campaign audience is archived (`true`) or not (`false`).\"},\"lastModified\":{\"type\":\"object\",\"description\":\"Object with information about the most recent update of the campaign audience.\",\"properties\":{\"dateUtc\":{\"type\":\"string\",\"description\":\"Date of the most recent update in UTC format.\"},\"user\":{\"type\":\"string\",\"description\":\"Email of the user who updated the campaign audience for the latest time.\"}}},\"targetConfigurations\":{\"type\":\"array\",\"description\":\"Array that contains all target audience that the campaign audience will be valid.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information about the target audience.\",\"properties\":{\"featured\":{\"type\":\"boolean\",\"description\":\"Defines if the target audience is featured (`true`) or not (`false`).\"},\"id\":{\"type\":\"string\",\"description\":\"Target audience ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Target audience name.\"},\"daysAgoOfPurchases\":{\"type\":\"integer\",\"description\":\"Number of days that are considered to add the purchase history.\"},\"origin\":{\"type\":\"string\",\"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.\"},\"idSellerIsInclusive\":{\"type\":\"boolean\",\"description\":\"Defines if at least one of the sellers must be valid to active the campaign audience.\"},\"idsSalesChannel\":{\"type\":\"array\",\"description\":\"Array with all the trade policies that activate the campaign audience.\",\"items\":{\"type\":\"string\",\"description\":\"Trade policy ID.\"}},\"areSalesChannelIdsExclusive\":{\"type\":\"boolean\",\"description\":\"Defines if the trade policy IDs are exclusive.\"},\"marketingTags\":{\"type\":\"array\",\"description\":\"Array with all the campaign audience's marketing tags.\",\"items\":{\"type\":\"string\",\"description\":\"Campaign audience marketing tags.\"}},\"marketingTagsAreNotInclusive\":{\"type\":\"boolean\",\"description\":\"Defines if marketing tags are not inclusive.\"},\"paymentsMethods\":{\"type\":\"array\",\"description\":\"Array composed by all the Payments Methods.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the Payment Method.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Payment Method ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Payment Method Name.\"}}}},\"stores\":{\"type\":\"array\",\"deprecated\":true,\"description\":\"List of stores.\",\"items\":{\"type\":\"string\",\"description\":\"Store.\"}},\"campaigns\":{\"type\":\"array\",\"description\":\"Campaign Audiences that activate this promotion.\",\"items\":{\"type\":\"string\",\"description\":\"Campaign audience.\"}},\"storesAreInclusive\":{\"type\":\"boolean\",\"deprecated\":true,\"description\":\"If set to `true`, this promotion will be applied to any store present on the `stores` field. If set to `false`, stores present on that field will make this promotion not to be applied.\"},\"categories\":{\"type\":\"array\",\"description\":\"Object composed by the categories that will activate or deactivate the campaign audience.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the category.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Category ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Category Name.\"}}}},\"categoriesAreInclusive\":{\"type\":\"boolean\",\"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.\"},\"brands\":{\"type\":\"array\",\"description\":\"Object composed by the brands that will activate or deactivate the campaign audience.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the brand.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Brand ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Brand Name.\"}}}},\"brandsAreInclusive\":{\"type\":\"boolean\",\"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.\"},\"products\":{\"type\":\"array\",\"description\":\"Object composed by the products that will activate or deactivate the campaign audience.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the product.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Product Name.\"}}}},\"productsAreInclusive\":{\"type\":\"boolean\",\"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.\"},\"skus\":{\"type\":\"array\",\"description\":\"Object composed by the SKUs that will activate or deactivate the campaign audience.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the SKU.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SKU ID.\"},\"name\":{\"type\":\"string\",\"description\":\"SKU Name.\"}}}},\"skusAreInclusive\":{\"type\":\"boolean\",\"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.\"},\"collections1BuyTogether\":{\"type\":\"array\",\"description\":\"Collections that will generate the promotion, type **Buy Together**, **More for less**, **Progressive Discount**, **Buy One Get One**.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the collection to be added to the first list of the **Buy Together** promotion.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the collection to be added to the first list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the collection to be added to the first list of the **Buy Together** promotion.\"}}}},\"collections2BuyTogether\":{\"type\":\"array\",\"deprecated\":true,\"description\":\"Collections that will generate the promotion, type **Buy Together**, **More for less**, **Progressive Discount**, **Buy One Get One**.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the collection to be added to the first list of the **Buy Together** promotion.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the collection to be added to the first list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the collection to be added to the first list of the **Buy Together** promotion.\"}}}},\"minimumQuantityBuyTogether\":{\"type\":\"integer\",\"description\":\"Minimum quantity for **Buy Together** promotion.\"},\"quantityToAffectBuyTogether\":{\"type\":\"integer\",\"description\":\"Quantity to affect **Buy Together** promotion.\"},\"enableBuyTogetherPerSku\":{\"type\":\"boolean\",\"description\":\"Enable **Buy Together** per SKU.\"},\"listSku1BuyTogether\":{\"type\":\"array\",\"description\":\"Array of objects, each containing ID and Name of an SKU to be added in the first list of the **Buy Together** promotion. Learn more about this type of promotion in the [Creating a Buy Together promotion](https://help.vtex.com/en/tutorial/buy-together--tutorials_323) documentation.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the SKU to be added to the first list of the **Buy Together** promotion. Learn more about this type of promotion in the [Creating a Buy Together promotion](https://help.vtex.com/en/tutorial/buy-together--tutorials_323) documentation.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the SKU to be added to the first list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the SKU to be added to the first list of the **Buy Together** promotion.\"}}}},\"listSku2BuyTogether\":{\"type\":\"array\",\"description\":\"Array of objects, each containing ID and Name of an SKU to be added to the second list of the **Buy Together** promotion. Learn more about this type of promotion in the [Creating a Buy Together promotion](https://help.vtex.com/en/tutorial/buy-together--tutorials_323) documentation.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the SKU to be added to the second list of the **Buy Together** promotion. Learn more about this type of promotion in the [Creating a Buy Together promotion](https://help.vtex.com/en/tutorial/buy-together--tutorials_323) documentation.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the SKU to be added to the second list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the SKU to be added to the second list of the **Buy Together** promotion.\"}}}},\"listBrand1BuyTogether\":{\"type\":\"array\",\"description\":\"Array of objects, each containing ID and Name of a brand to be added in the first list of the **Buy Together** promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the brand to be added to the first list of the **Buy Together** promotion.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the brand to be added to the first list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the brand to be added to the first list of the **Buy Together** promotion.\"}}}},\"listCategory1BuyTogether\":{\"type\":\"array\",\"description\":\"Array of objects, each containing ID and Name of a category to be added in the first list of the **Buy Together** promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the category to be added to the first list of the **Buy Together** promotion.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the category to be added to the first list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the category to be added to the first list of the **Buy Together** promotion.\"}}}},\"coupon\":{\"type\":\"array\",\"deprecated\":true,\"description\":\"List of coupons.\",\"items\":{\"type\":\"string\",\"description\":\"Coupon code.\"}},\"totalValueFloor\":{\"type\":\"number\",\"description\":\"Minimum chart value to active the campaign audience.\"},\"totalValueCeling\":{\"type\":\"number\",\"description\":\"Maximum chart value to active the campaign audience.\"},\"totalValueIncludeAllItems\":{\"type\":\"boolean\",\"deprecated\":true,\"description\":\"Total value including all items.\"},\"totalValueMode\":{\"type\":\"string\",\"description\":\"Total chart value to active the campaign audience.\"},\"collections\":{\"type\":\"array\",\"description\":\"Object composed by the collections that will activate or deactivate the campaign audience.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the collection.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Collection ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Collection Name.\"}}}},\"collectionsIsInclusive\":{\"type\":\"boolean\",\"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.\"},\"restrictionsBins\":{\"type\":\"array\",\"description\":\"The discount will be granted if the card's BIN is given.\",\"items\":{\"type\":\"string\",\"description\":\"Card's BIN.\"}},\"cardIssuers\":{\"type\":\"array\",\"deprecated\":true,\"description\":\"List of card issuers.\",\"items\":{\"type\":\"string\",\"description\":\"Card issuer.\"}},\"totalValuePurchase\":{\"type\":\"number\",\"description\":\"Total value a client must have in past orders to active the campaign audience.\"},\"slasIds\":{\"type\":\"array\",\"description\":\"The discount will be granted if the shipping method is the same as the one given.\",\"items\":{\"type\":\"string\",\"description\":\"Shipping method.\"}},\"isSlaSelected\":{\"type\":\"boolean\",\"description\":\"Applies selected discount only when one of the defined shipping method is selected by the customer.\"},\"isFirstBuy\":{\"type\":\"boolean\",\"description\":\"Applies the discount only if it's a first buy.\"},\"firstBuyIsProfileOptimistic\":{\"type\":\"boolean\",\"description\":\"Applies the discount even if the user is not logged.\"},\"compareListPriceAndPrice\":{\"type\":\"boolean\",\"description\":\"If the **List Price** and **Price** are the same.\"},\"isDifferentListPriceAndPrice\":{\"type\":\"boolean\",\"description\":\"Applies the campaign audience only if the list price and price is different.\"},\"zipCodeRanges\":{\"type\":\"array\",\"description\":\"Range of zip codes that applies the promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the Zip Code.\",\"properties\":{\"zipCodeFrom\":{\"type\":\"string\",\"description\":\"Initial Zip Code.\"},\"zipCodeTo\":{\"type\":\"string\",\"description\":\"Final Zip Code.\"},\"inclusive\":{\"type\":\"boolean\",\"description\":\"Defines if the zip code range is included in the promotion.\"}}}},\"itemMaxPrice\":{\"type\":\"number\",\"description\":\"Maximum price of the item.\"},\"itemMinPrice\":{\"type\":\"number\",\"description\":\"Minimum price of the item.\"},\"installment\":{\"type\":\"integer\",\"deprecated\":true,\"description\":\"Installment.\"},\"isMinMaxInstallments\":{\"type\":\"boolean\",\"description\":\"Set if the campaign audience will be applied considering a minimum and maximum values for installments.\"},\"minInstallment\":{\"type\":\"integer\",\"description\":\"Minimum value for installment.\"},\"maxInstallment\":{\"type\":\"integer\",\"description\":\"Maximum value for installment.\"},\"merchants\":{\"type\":\"array\",\"deprecated\":true,\"description\":\"List of merchants.\",\"items\":{\"type\":\"string\",\"description\":\"Merchant.\"}},\"clusterExpressions\":{\"type\":\"array\",\"description\":\"Criteria to select a customer cluster. Each item in this array should follow the format of an equality function (`{propertyname}={value}`) or the format of a contains function (`{propertyname} contains {value}`). In both options, `{propertyname}` must be replaced with the name of the field in the data entity, and `{value}` must be replaced with the value determined in Master Data. Find more information about these criteria in [Filling in the Customer cluster field](https://help.vtex.com/tutorial/creating-promotion-for-a-customer-cluster--tutorials_342#filling-in-the-customer-cluster-field).\",\"items\":{\"type\":\"string\",\"description\":\"Cluster expression.\"}},\"paymentsRules\":{\"type\":\"array\",\"deprecated\":true,\"description\":\"List of payment rules.\",\"items\":{\"type\":\"string\",\"description\":\"Payment rule.\"}},\"giftListTypes\":{\"type\":\"array\",\"description\":\"Gifts List Type.\",\"items\":{\"type\":\"string\",\"description\":\"Gift List Type.\"}},\"productsSpecifications\":{\"type\":\"array\",\"deprecated\":true,\"description\":\"List of product specifications.\",\"items\":{\"type\":\"string\",\"description\":\"Product specification.\"}},\"affiliates\":{\"type\":\"array\",\"description\":\"Marketplace order identifier. The discount will apply to selected affiliates.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the affiliate.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Affiliate ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Affiliate Name.\"}}}},\"maxUsage\":{\"type\":\"integer\",\"description\":\"Defines how many times the campaign audience can be used.\"},\"maxUsagePerClient\":{\"type\":\"integer\",\"description\":\"Defines if the campaign audience can be used multiple times per client.\"},\"shouldDistributeDiscountAmongMatchedItems\":{\"type\":\"boolean\",\"description\":\"Should distribute discount among matched items.\"},\"multipleUsePerClient\":{\"type\":\"boolean\",\"description\":\"Defines if the campaign audience can be used multiple times per client.\"},\"useNewProgressiveAlgorithm\":{\"type\":\"boolean\",\"description\":\"Use new progressive algorithm.\"},\"percentualDiscountValueList\":{\"type\":\"array\",\"description\":\"Percentual discount value list.\",\"items\":{\"type\":\"number\",\"description\":\"Percentual discount value.\"}}}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/rnb/pvt/campaignConfiguration/:campaignId - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"type\":\"object\",\"properties\":{\"beginDateUtc\":{\"type\":\"string\",\"description\":\"Start date of the campaign audience in UTC format.\"},\"endDateUtc\":{\"type\":\"string\",\"description\":\"End date of the campaign audience in UTC format.\"},\"id\":{\"type\":\"string\",\"description\":\"Campaign audience ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Campaign audience name.\"},\"isActive\":{\"type\":\"boolean\",\"description\":\"Defines if the campaign audience is active (`true`) or not (`false`).\"},\"isAndOperator\":{\"type\":\"boolean\",\"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.\"},\"isArchived\":{\"type\":\"boolean\",\"description\":\"Defines if the campaign audience is archived (`true`) or not (`false`).\"},\"lastModified\":{\"type\":\"object\",\"description\":\"Object with information about the most recent update of the campaign audience.\",\"properties\":{\"dateUtc\":{\"type\":\"string\",\"description\":\"Date of the most recent update in UTC format.\"},\"user\":{\"type\":\"string\",\"description\":\"Email of the user who updated the campaign audience for the latest time.\"}}},\"targetConfigurations\":{\"type\":\"array\",\"description\":\"Array that contains all target audience that the campaign audience will be valid.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information about the target audience.\",\"properties\":{\"featured\":{\"type\":\"boolean\",\"description\":\"Defines if the target audience is featured (`true`) or not (`false`).\"},\"id\":{\"type\":\"string\",\"description\":\"Target audience ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Target audience name.\"},\"daysAgoOfPurchases\":{\"type\":\"integer\",\"description\":\"Number of days that are considered to add the purchase history.\"},\"origin\":{\"type\":\"string\",\"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.\"},\"idSellerIsInclusive\":{\"type\":\"boolean\",\"description\":\"Defines if at least one of the sellers must be valid to active the campaign audience.\"},\"idsSalesChannel\":{\"type\":\"array\",\"description\":\"Array with all the trade policies that activate the campaign audience.\",\"items\":{\"type\":\"string\",\"description\":\"Trade policy ID.\"}},\"areSalesChannelIdsExclusive\":{\"type\":\"boolean\",\"description\":\"Defines if the trade policy IDs are exclusive.\"},\"marketingTags\":{\"type\":\"array\",\"description\":\"Array with all the campaign audience's marketing tags.\",\"items\":{\"type\":\"string\",\"description\":\"Campaign audience marketing tags.\"}},\"marketingTagsAreNotInclusive\":{\"type\":\"boolean\",\"description\":\"Defines if marketing tags are not inclusive.\"},\"paymentsMethods\":{\"type\":\"array\",\"description\":\"Array composed by all the Payments Methods.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the Payment Method.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Payment Method ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Payment Method Name.\"}}}},\"stores\":{\"type\":\"array\",\"description\":\"List of stores.\",\"items\":{\"type\":\"string\",\"description\":\"Store.\"}},\"campaigns\":{\"type\":\"array\",\"description\":\"Campaign Audiences that activate this promotion.\",\"items\":{\"type\":\"string\",\"description\":\"Campaign audience.\"}},\"storesAreInclusive\":{\"type\":\"boolean\",\"description\":\"If set to `true`, this promotion will be applied to any store present on the `stores` field. If set to `false`, stores present on that field will make this promotion not to be applied.\"},\"categories\":{\"type\":\"array\",\"description\":\"Object composed by the categories that will activate or deactivate the campaign audience.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the category.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Category ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Category Name.\"}}}},\"categoriesAreInclusive\":{\"type\":\"boolean\",\"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.\"},\"brands\":{\"type\":\"array\",\"description\":\"Object composed by the brands that will activate or deactivate the campaign audience.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the brand.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Brand ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Brand Name.\"}}}},\"brandsAreInclusive\":{\"type\":\"boolean\",\"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.\"},\"products\":{\"type\":\"array\",\"description\":\"Object composed by the products that will activate or deactivate the campaign audience.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the product.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Product Name.\"}}}},\"productsAreInclusive\":{\"type\":\"boolean\",\"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.\"},\"skus\":{\"type\":\"array\",\"description\":\"Object composed by the SKUs that will activate or deactivate the campaign audience.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the SKU.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SKU ID.\"},\"name\":{\"type\":\"string\",\"description\":\"SKU Name.\"}}}},\"skusAreInclusive\":{\"type\":\"boolean\",\"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.\"},\"collections1BuyTogether\":{\"type\":\"array\",\"description\":\"Collections that will generate the promotion, type **Buy Together**, **More for less**, **Progressive Discount**, **Buy One Get One**.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the collection to be added to the first list of the **Buy Together** promotion.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the collection to be added to the first list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the collection to be added to the first list of the **Buy Together** promotion.\"}}}},\"collections2BuyTogether\":{\"type\":\"array\",\"description\":\"Collections that will generate the promotion, type **Buy Together**, **More for less**, **Progressive Discount**, **Buy One Get One**.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the collection to be added to the first list of the **Buy Together** promotion.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the collection to be added to the first list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the collection to be added to the first list of the **Buy Together** promotion.\"}}}},\"minimumQuantityBuyTogether\":{\"type\":\"integer\",\"description\":\"Minimum quantity for **Buy Together** promotion.\"},\"quantityToAffectBuyTogether\":{\"type\":\"integer\",\"description\":\"Quantity to affect **Buy Together** promotion.\"},\"enableBuyTogetherPerSku\":{\"type\":\"boolean\",\"description\":\"Enable **Buy Together** per SKU.\"},\"listSku1BuyTogether\":{\"type\":\"array\",\"description\":\"Array of objects, each containing ID and Name of an SKU to be added in the first list of the **Buy Together** promotion. Learn more about this type of promotion in the [Creating a Buy Together promotion](https://help.vtex.com/en/tutorial/buy-together--tutorials_323) documentation.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the SKU to be added to the first list of the **Buy Together** promotion. Learn more about this type of promotion in the [Creating a Buy Together promotion](https://help.vtex.com/en/tutorial/buy-together--tutorials_323) documentation.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the SKU to be added to the first list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the SKU to be added to the first list of the **Buy Together** promotion.\"}}}},\"listSku2BuyTogether\":{\"type\":\"array\",\"description\":\"Array of objects, each containing ID and Name of an SKU to be added to the second list of the **Buy Together** promotion. Learn more about this type of promotion in the [Creating a Buy Together promotion](https://help.vtex.com/en/tutorial/buy-together--tutorials_323) documentation.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the SKU to be added to the second list of the **Buy Together** promotion. Learn more about this type of promotion in the [Creating a Buy Together promotion](https://help.vtex.com/en/tutorial/buy-together--tutorials_323) documentation.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the SKU to be added to the second list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the SKU to be added to the second list of the **Buy Together** promotion.\"}}}},\"listBrand1BuyTogether\":{\"type\":\"array\",\"description\":\"Array of objects, each containing ID and Name of a brand to be added in the first list of the **Buy Together** promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the brand to be added to the first list of the **Buy Together** promotion.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the brand to be added to the first list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the brand to be added to the first list of the **Buy Together** promotion.\"}}}},\"listCategory1BuyTogether\":{\"type\":\"array\",\"description\":\"Array of objects, each containing ID and Name of a category to be added in the first list of the **Buy Together** promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the category to be added to the first list of the **Buy Together** promotion.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the category to be added to the first list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the category to be added to the first list of the **Buy Together** promotion.\"}}}},\"coupon\":{\"type\":\"array\",\"description\":\"List of coupons.\",\"items\":{\"type\":\"string\",\"description\":\"Coupon code.\"}},\"totalValueFloor\":{\"type\":\"number\",\"description\":\"Minimum chart value to active the campaign audience.\"},\"totalValueCeling\":{\"type\":\"number\",\"description\":\"Maximum chart value to active the campaign audience.\"},\"totalValueIncludeAllItems\":{\"type\":\"boolean\",\"description\":\"Total value including all items.\"},\"totalValueMode\":{\"type\":\"string\",\"description\":\"Total chart value to active the campaign audience.\"},\"collections\":{\"type\":\"array\",\"description\":\"Object composed by the collections that will activate or deactivate the campaign audience.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the collection.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Collection ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Collection Name.\"}}}},\"collectionsIsInclusive\":{\"type\":\"boolean\",\"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.\"},\"restrictionsBins\":{\"type\":\"array\",\"description\":\"The discount will be granted if the card's BIN is given.\",\"items\":{\"type\":\"string\",\"description\":\"Card's BIN.\"}},\"cardIssuers\":{\"type\":\"array\",\"description\":\"List of card issuers.\",\"items\":{\"type\":\"string\",\"description\":\"Card issuer.\"}},\"totalValuePurchase\":{\"type\":\"number\",\"description\":\"Total value a client must have in past orders to active the campaign audience.\"},\"slasIds\":{\"type\":\"array\",\"description\":\"The discount will be granted if the shipping method is the same as the one given.\",\"items\":{\"type\":\"string\",\"description\":\"Shipping method.\"}},\"isSlaSelected\":{\"type\":\"boolean\",\"description\":\"Applies selected discount only when one of the defined shipping method is selected by the customer.\"},\"isFirstBuy\":{\"type\":\"boolean\",\"description\":\"Applies the discount only if it's a first buy.\"},\"firstBuyIsProfileOptimistic\":{\"type\":\"boolean\",\"description\":\"Applies the discount even if the user is not logged.\"},\"compareListPriceAndPrice\":{\"type\":\"boolean\",\"description\":\"If the **List Price** and **Price** are the same.\"},\"isDifferentListPriceAndPrice\":{\"type\":\"boolean\",\"description\":\"Applies the campaign audience only if the list price and price is different.\"},\"zipCodeRanges\":{\"type\":\"array\",\"description\":\"Range of zip codes that applies the promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the Zip Code.\",\"properties\":{\"zipCodeFrom\":{\"type\":\"string\",\"description\":\"Initial Zip Code.\"},\"zipCodeTo\":{\"type\":\"string\",\"description\":\"Final Zip Code.\"},\"inclusive\":{\"type\":\"boolean\",\"description\":\"Defines if the zip code range is included in the promotion.\"}}}},\"itemMaxPrice\":{\"type\":\"number\",\"description\":\"Maximum price of the item.\"},\"itemMinPrice\":{\"type\":\"number\",\"description\":\"Minimum price of the item.\"},\"installment\":{\"type\":\"integer\",\"description\":\"Installment.\"},\"isMinMaxInstallments\":{\"type\":\"boolean\",\"description\":\"Set if the campaign audience will be applied considering a minimum and maximum values for installments.\"},\"minInstallment\":{\"type\":\"integer\",\"description\":\"Minimum value for installment.\"},\"maxInstallment\":{\"type\":\"integer\",\"description\":\"Maximum value for installment.\"},\"merchants\":{\"type\":\"array\",\"description\":\"List of merchants.\",\"items\":{\"type\":\"string\",\"description\":\"Merchant.\"}},\"clusterExpressions\":{\"type\":\"array\",\"description\":\"Criteria to select a customer cluster. Each item in this array should follow the format of an equality function (`{propertyname}={value}`) or the format of a contains function (`{propertyname} contains {value}`). In both options, `{propertyname}` must be replaced with the name of the field in the data entity, and `{value}` must be replaced with the value determined in Master Data. Find more information about these criteria in [Filling in the Customer cluster field](https://help.vtex.com/tutorial/creating-promotion-for-a-customer-cluster--tutorials_342#filling-in-the-customer-cluster-field).\",\"items\":{\"type\":\"string\",\"description\":\"Cluster expression.\"}},\"paymentsRules\":{\"type\":\"array\",\"description\":\"List of payment rules.\",\"items\":{\"type\":\"string\",\"description\":\"Payment rule.\"}},\"giftListTypes\":{\"type\":\"array\",\"description\":\"Gifts List Type.\",\"items\":{\"type\":\"string\",\"description\":\"Gift List Type.\"}},\"productsSpecifications\":{\"type\":\"array\",\"description\":\"List of product specifications.\",\"items\":{\"type\":\"string\",\"description\":\"Product specification.\"}},\"affiliates\":{\"type\":\"array\",\"description\":\"Marketplace order identifier. The discount will apply to selected affiliates.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the affiliate.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Affiliate ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Affiliate Name.\"}}}},\"maxUsage\":{\"type\":\"integer\",\"description\":\"Defines how many times the campaign audience can be used.\"},\"maxUsagePerClient\":{\"type\":\"integer\",\"description\":\"Defines if the campaign audience can be used multiple times per client.\"},\"shouldDistributeDiscountAmongMatchedItems\":{\"type\":\"boolean\",\"description\":\"Should distribute discount among matched items.\"},\"multipleUsePerClient\":{\"type\":\"boolean\",\"description\":\"Defines if the campaign audience can be used multiple times per client.\"},\"useNewProgressiveAlgorithm\":{\"type\":\"boolean\",\"description\":\"Use new progressive algorithm.\"},\"percentualDiscountValueList\":{\"type\":\"array\",\"description\":\"Percentual discount value list.\",\"items\":{\"type\":\"number\",\"description\":\"Percentual discount value.\"}}}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/rnb/pvt/campaignConfiguration/:campaignId - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -4355,7 +3564,7 @@ } }, { - "id": "f7fc54b6-6939-4697-8520-48e6ad05d609", + "id": "20511dce-244a-4d96-8c10-a85a70a4b3d5", "name": "Get all campaign audiences", "request": { "name": "Get all campaign audiences", @@ -4374,26 +3583,7 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ { @@ -4413,16 +3603,21 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "GET" + "method": "GET", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, - "id": "9fda84b6-74fa-4d4d-a462-32e33ec23e40", + "id": "af7dde00-8d41-41d0-9b46-98c0ae2534ce", "name": "OK", "originalRequest": { "url": { @@ -4436,36 +3631,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -4487,6 +3655,14 @@ { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "GET", @@ -4508,13 +3684,13 @@ { "listen": "test", "script": { - "id": "0d4e1114-a9cb-4776-a82c-3a8d3bc185ab", + "id": "eb438d58-490f-4b0f-b833-d71560bc8316", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/rnb/pvt/campaignConfiguration - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[GET]::/api/rnb/pvt/campaignConfiguration - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[GET]::/api/rnb/pvt/campaignConfiguration - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"type\":\"array\",\"description\":\"Array of campaign audiences.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing information about the campaign audience.\",\"properties\":{\"beginDateUtc\":{\"type\":\"string\",\"description\":\"Start date of the campaign audience in UTC format.\"},\"endDateUtc\":{\"type\":\"string\",\"description\":\"End date of the campaign audience in UTC format.\"},\"id\":{\"type\":\"string\",\"description\":\"Campaign audience ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Campaign audience name.\"},\"isActive\":{\"type\":\"boolean\",\"description\":\"Defines if the campaign audience is active (`true`) or not (`false`).\"},\"isAndOperator\":{\"type\":\"boolean\",\"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.\"},\"isArchived\":{\"type\":\"boolean\",\"description\":\"Defines if the campaign audience is archived (`true`) or not (`false`).\"},\"lastModified\":{\"type\":\"object\",\"description\":\"Object with information about the most recent update of the campaign audience.\",\"properties\":{\"dateUtc\":{\"type\":\"string\",\"description\":\"Date of the most recent update in UTC format.\"},\"user\":{\"type\":\"string\",\"description\":\"Email of the user who updated the campaign audience for the latest time.\"}}},\"targetConfigurations\":{\"type\":\"array\",\"description\":\"Array that contains all target audience that the campaign audience will be valid.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information about the target audience.\",\"properties\":{\"featured\":{\"type\":\"boolean\",\"description\":\"Defines if the target audience is featured (`true`) or not (`false`).\"},\"id\":{\"type\":\"string\",\"description\":\"Target audience ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Target audience name.\"},\"daysAgoOfPurchases\":{\"type\":\"integer\",\"description\":\"Number of days that are considered to add the purchase history.\"},\"origin\":{\"type\":\"string\",\"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.\"},\"idSellerIsInclusive\":{\"type\":\"boolean\",\"description\":\"Defines if at least one of the sellers must be valid to active the campaign audience.\"},\"idsSalesChannel\":{\"type\":\"array\",\"description\":\"Array with all the trade policies that activate the campaign audience.\",\"items\":{\"type\":\"string\",\"description\":\"Trade policy ID.\"}},\"areSalesChannelIdsExclusive\":{\"type\":\"boolean\",\"description\":\"Defines if the trade policy IDs are exclusive.\"},\"marketingTags\":{\"type\":\"array\",\"description\":\"Array with all the campaign audience's marketing tags.\",\"items\":{\"type\":\"string\",\"description\":\"Campaign audience marketing tags.\"}},\"marketingTagsAreNotInclusive\":{\"type\":\"boolean\",\"description\":\"Defines if marketing tags are not inclusive.\"},\"paymentsMethods\":{\"type\":\"array\",\"description\":\"Array composed by all the Payments Methods.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the Payment Method.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Payment Method ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Payment Method Name.\"}}}},\"stores\":{\"type\":\"array\",\"deprecated\":true,\"description\":\"List of stores.\",\"items\":{\"type\":\"string\",\"description\":\"Store.\"}},\"campaigns\":{\"type\":\"array\",\"description\":\"Campaign Audiences that activate this promotion.\",\"items\":{\"type\":\"string\",\"description\":\"Campaign audience.\"}},\"storesAreInclusive\":{\"type\":\"boolean\",\"deprecated\":true,\"description\":\"If set to `true`, this promotion will be applied to any store present on the `stores` field. If set to `false`, stores present on that field will make this promotion not to be applied.\"},\"categories\":{\"type\":\"array\",\"description\":\"Object composed by the categories that will activate or deactivate the campaign audience.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the category.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Category ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Category Name.\"}}}},\"categoriesAreInclusive\":{\"type\":\"boolean\",\"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.\"},\"brands\":{\"type\":\"array\",\"description\":\"Object composed by the brands that will activate or deactivate the campaign audience.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the brand.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Brand ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Brand Name.\"}}}},\"brandsAreInclusive\":{\"type\":\"boolean\",\"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.\"},\"products\":{\"type\":\"array\",\"description\":\"Object composed by the products that will activate or deactivate the campaign audience.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the product.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Product Name.\"}}}},\"productsAreInclusive\":{\"type\":\"boolean\",\"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.\"},\"skus\":{\"type\":\"array\",\"description\":\"Object composed by the SKUs that will activate or deactivate the campaign audience.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the SKU.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SKU ID.\"},\"name\":{\"type\":\"string\",\"description\":\"SKU Name.\"}}}},\"skusAreInclusive\":{\"type\":\"boolean\",\"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.\"},\"collections1BuyTogether\":{\"type\":\"array\",\"description\":\"Collections that will generate the promotion, type **Buy Together**, **More for less**, **Progressive Discount**, **Buy One Get One**.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the collection to be added to the first list of the **Buy Together** promotion.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the collection to be added to the first list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the collection to be added to the first list of the **Buy Together** promotion.\"}}}},\"collections2BuyTogether\":{\"type\":\"array\",\"deprecated\":true,\"description\":\"Collections that will generate the promotion, type **Buy Together**, **More for less**, **Progressive Discount**, **Buy One Get One**.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the collection to be added to the first list of the **Buy Together** promotion.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the collection to be added to the first list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the collection to be added to the first list of the **Buy Together** promotion.\"}}}},\"minimumQuantityBuyTogether\":{\"type\":\"integer\",\"description\":\"Minimum quantity for **Buy Together** promotion.\"},\"quantityToAffectBuyTogether\":{\"type\":\"integer\",\"description\":\"Quantity to affect **Buy Together** promotion.\"},\"enableBuyTogetherPerSku\":{\"type\":\"boolean\",\"description\":\"Enable **Buy Together** per SKU.\"},\"listSku1BuyTogether\":{\"type\":\"array\",\"description\":\"Array of objects, each containing ID and Name of an SKU to be added in the first list of the **Buy Together** promotion. Learn more about this type of promotion in the [Creating a Buy Together promotion](https://help.vtex.com/en/tutorial/buy-together--tutorials_323) documentation.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the SKU to be added to the first list of the **Buy Together** promotion. Learn more about this type of promotion in the [Creating a Buy Together promotion](https://help.vtex.com/en/tutorial/buy-together--tutorials_323) documentation.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the SKU to be added to the first list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the SKU to be added to the first list of the **Buy Together** promotion.\"}}}},\"listSku2BuyTogether\":{\"type\":\"array\",\"description\":\"Array of objects, each containing ID and Name of an SKU to be added to the second list of the **Buy Together** promotion. Learn more about this type of promotion in the [Creating a Buy Together promotion](https://help.vtex.com/en/tutorial/buy-together--tutorials_323) documentation.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the SKU to be added to the second list of the **Buy Together** promotion. Learn more about this type of promotion in the [Creating a Buy Together promotion](https://help.vtex.com/en/tutorial/buy-together--tutorials_323) documentation.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the SKU to be added to the second list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the SKU to be added to the second list of the **Buy Together** promotion.\"}}}},\"listBrand1BuyTogether\":{\"type\":\"array\",\"description\":\"Array of objects, each containing ID and Name of a brand to be added in the first list of the **Buy Together** promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the brand to be added to the first list of the **Buy Together** promotion.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the brand to be added to the first list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the brand to be added to the first list of the **Buy Together** promotion.\"}}}},\"listCategory1BuyTogether\":{\"type\":\"array\",\"description\":\"Array of objects, each containing ID and Name of a category to be added in the first list of the **Buy Together** promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the category to be added to the first list of the **Buy Together** promotion.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the category to be added to the first list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the category to be added to the first list of the **Buy Together** promotion.\"}}}},\"coupon\":{\"type\":\"array\",\"deprecated\":true,\"description\":\"List of coupons.\",\"items\":{\"type\":\"string\",\"description\":\"Coupon code.\"}},\"totalValueFloor\":{\"type\":\"number\",\"description\":\"Minimum chart value to active the campaign audience.\"},\"totalValueCeling\":{\"type\":\"number\",\"description\":\"Maximum chart value to active the campaign audience.\"},\"totalValueIncludeAllItems\":{\"type\":\"boolean\",\"deprecated\":true,\"description\":\"Total value including all items.\"},\"totalValueMode\":{\"type\":\"string\",\"description\":\"Total chart value to active the campaign audience.\"},\"collections\":{\"type\":\"array\",\"description\":\"Object composed by the collections that will activate or deactivate the campaign audience.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the collection.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Collection ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Collection Name.\"}}}},\"collectionsIsInclusive\":{\"type\":\"boolean\",\"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.\"},\"restrictionsBins\":{\"type\":\"array\",\"description\":\"The discount will be granted if the card's BIN is given.\",\"items\":{\"type\":\"string\",\"description\":\"Card's BIN.\"}},\"cardIssuers\":{\"type\":\"array\",\"deprecated\":true,\"description\":\"List of card issuers.\",\"items\":{\"type\":\"string\",\"description\":\"Card issuer.\"}},\"totalValuePurchase\":{\"type\":\"number\",\"description\":\"Total value a client must have in past orders to active the campaign audience.\"},\"slasIds\":{\"type\":\"array\",\"description\":\"The discount will be granted if the shipping method is the same as the one given.\",\"items\":{\"type\":\"string\",\"description\":\"Shipping method.\"}},\"isSlaSelected\":{\"type\":\"boolean\",\"description\":\"Applies selected discount only when one of the defined shipping method is selected by the customer.\"},\"isFirstBuy\":{\"type\":\"boolean\",\"description\":\"Applies the discount only if it's a first buy.\"},\"firstBuyIsProfileOptimistic\":{\"type\":\"boolean\",\"description\":\"Applies the discount even if the user is not logged.\"},\"compareListPriceAndPrice\":{\"type\":\"boolean\",\"description\":\"If the **List Price** and **Price** are the same.\"},\"isDifferentListPriceAndPrice\":{\"type\":\"boolean\",\"description\":\"Applies the campaign audience only if the list price and price is different.\"},\"zipCodeRanges\":{\"type\":\"array\",\"description\":\"Range of zip codes that applies the promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the Zip Code\",\"properties\":{\"zipCodeFrom\":{\"type\":\"string\",\"description\":\"Initial Zip Code.\"},\"zipCodeTo\":{\"type\":\"string\",\"description\":\"Final Zip Code.\"},\"inclusive\":{\"type\":\"boolean\",\"description\":\"Defines if the zip code range is included in the promotion.\"}}}},\"itemMaxPrice\":{\"type\":\"number\",\"description\":\"Maximum price of the item.\"},\"itemMinPrice\":{\"type\":\"number\",\"description\":\"Minimum price of the item.\"},\"installment\":{\"type\":\"integer\",\"deprecated\":true,\"description\":\"Installment.\"},\"isMinMaxInstallments\":{\"type\":\"boolean\",\"description\":\"Set if the campaign audience will be applied considering a minimum and maximum values for installments.\"},\"minInstallment\":{\"type\":\"integer\",\"description\":\"Minimum value for installment.\"},\"maxInstallment\":{\"type\":\"integer\",\"description\":\"Maximum value for installment.\"},\"merchants\":{\"type\":\"array\",\"deprecated\":true,\"description\":\"List of merchants.\",\"items\":{\"type\":\"string\",\"description\":\"Merchant.\"}},\"clusterExpressions\":{\"type\":\"array\",\"description\":\"Criteria to select a customer cluster. Each item in this array should follow the format of an equality function (`{propertyname}={value}`) or the format of a contains function (`{propertyname} contains {value}`). In both options, `{propertyname}` must be replaced with the name of the field in the data entity, and `{value}` must be replaced with the value determined in Master Data. Find more information about these criteria in [Filling in the Customer cluster field](https://help.vtex.com/tutorial/creating-promotion-for-a-customer-cluster--tutorials_342#filling-in-the-customer-cluster-field).\",\"items\":{\"type\":\"string\",\"description\":\"Cluster expression.\"}},\"clusterOperator\":{\"type\":\"string\",\"deprecated\":true,\"description\":\"Cluster operator.\"},\"paymentsRules\":{\"type\":\"array\",\"deprecated\":true,\"description\":\"List of payment rules.\",\"items\":{\"type\":\"string\",\"description\":\"Payment rule.\"}},\"giftListTypes\":{\"type\":\"array\",\"description\":\"Gifts List Type.\",\"items\":{\"type\":\"string\",\"description\":\"Gift List Type.\"}},\"productsSpecifications\":{\"type\":\"array\",\"deprecated\":true,\"description\":\"List of product specifications.\",\"items\":{\"type\":\"string\",\"description\":\"Product specification.\"}},\"affiliates\":{\"type\":\"array\",\"description\":\"Marketplace order identifier. The discount will apply to selected affiliates.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the affiliate.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Affiliate ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Affiliate Name.\"}}}},\"maxUsage\":{\"type\":\"integer\",\"description\":\"Defines how many times the campaign audience can be used.\"},\"maxUsagePerClient\":{\"type\":\"integer\",\"description\":\"Defines if the campaign audience can be used multiple times per client.\"},\"shouldDistributeDiscountAmongMatchedItems\":{\"type\":\"boolean\",\"description\":\"Should distribute discount among matched items.\"},\"multipleUsePerClient\":{\"type\":\"boolean\",\"description\":\"Defines if the campaign audience can be used multiple times per client.\"},\"useNewProgressiveAlgorithm\":{\"type\":\"boolean\",\"description\":\"Use new progressive algorithm.\"},\"percentualDiscountValueList\":{\"type\":\"array\",\"description\":\"Percentual discount value list.\",\"items\":{\"type\":\"number\",\"description\":\"Percentual discount value.\"}}}}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/rnb/pvt/campaignConfiguration - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"type\":\"array\",\"description\":\"Array of campaign audiences.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing information about the campaign audience.\",\"properties\":{\"beginDateUtc\":{\"type\":\"string\",\"description\":\"Start date of the campaign audience in UTC format.\"},\"endDateUtc\":{\"type\":\"string\",\"description\":\"End date of the campaign audience in UTC format.\"},\"id\":{\"type\":\"string\",\"description\":\"Campaign audience ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Campaign audience name.\"},\"isActive\":{\"type\":\"boolean\",\"description\":\"Defines if the campaign audience is active (`true`) or not (`false`).\"},\"isAndOperator\":{\"type\":\"boolean\",\"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.\"},\"isArchived\":{\"type\":\"boolean\",\"description\":\"Defines if the campaign audience is archived (`true`) or not (`false`).\"},\"lastModified\":{\"type\":\"object\",\"description\":\"Object with information about the most recent update of the campaign audience.\",\"properties\":{\"dateUtc\":{\"type\":\"string\",\"description\":\"Date of the most recent update in UTC format.\"},\"user\":{\"type\":\"string\",\"description\":\"Email of the user who updated the campaign audience for the latest time.\"}}},\"targetConfigurations\":{\"type\":\"array\",\"description\":\"Array that contains all target audience that the campaign audience will be valid.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information about the target audience.\",\"properties\":{\"featured\":{\"type\":\"boolean\",\"description\":\"Defines if the target audience is featured (`true`) or not (`false`).\"},\"id\":{\"type\":\"string\",\"description\":\"Target audience ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Target audience name.\"},\"daysAgoOfPurchases\":{\"type\":\"integer\",\"description\":\"Number of days that are considered to add the purchase history.\"},\"origin\":{\"type\":\"string\",\"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.\"},\"idSellerIsInclusive\":{\"type\":\"boolean\",\"description\":\"Defines if at least one of the sellers must be valid to active the campaign audience.\"},\"idsSalesChannel\":{\"type\":\"array\",\"description\":\"Array with all the trade policies that activate the campaign audience.\",\"items\":{\"type\":\"string\",\"description\":\"Trade policy ID.\"}},\"areSalesChannelIdsExclusive\":{\"type\":\"boolean\",\"description\":\"Defines if the trade policy IDs are exclusive.\"},\"marketingTags\":{\"type\":\"array\",\"description\":\"Array with all the campaign audience's marketing tags.\",\"items\":{\"type\":\"string\",\"description\":\"Campaign audience marketing tags.\"}},\"marketingTagsAreNotInclusive\":{\"type\":\"boolean\",\"description\":\"Defines if marketing tags are not inclusive.\"},\"paymentsMethods\":{\"type\":\"array\",\"description\":\"Array composed by all the Payments Methods.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the Payment Method.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Payment Method ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Payment Method Name.\"}}}},\"stores\":{\"type\":\"array\",\"description\":\"List of stores.\",\"items\":{\"type\":\"string\",\"description\":\"Store.\"}},\"campaigns\":{\"type\":\"array\",\"description\":\"Campaign Audiences that activate this promotion.\",\"items\":{\"type\":\"string\",\"description\":\"Campaign audience.\"}},\"storesAreInclusive\":{\"type\":\"boolean\",\"description\":\"If set to `true`, this promotion will be applied to any store present on the `stores` field. If set to `false`, stores present on that field will make this promotion not to be applied.\"},\"categories\":{\"type\":\"array\",\"description\":\"Object composed by the categories that will activate or deactivate the campaign audience.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the category.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Category ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Category Name.\"}}}},\"categoriesAreInclusive\":{\"type\":\"boolean\",\"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.\"},\"brands\":{\"type\":\"array\",\"description\":\"Object composed by the brands that will activate or deactivate the campaign audience.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the brand.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Brand ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Brand Name.\"}}}},\"brandsAreInclusive\":{\"type\":\"boolean\",\"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.\"},\"products\":{\"type\":\"array\",\"description\":\"Object composed by the products that will activate or deactivate the campaign audience.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the product.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Product Name.\"}}}},\"productsAreInclusive\":{\"type\":\"boolean\",\"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.\"},\"skus\":{\"type\":\"array\",\"description\":\"Object composed by the SKUs that will activate or deactivate the campaign audience.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the SKU.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SKU ID.\"},\"name\":{\"type\":\"string\",\"description\":\"SKU Name.\"}}}},\"skusAreInclusive\":{\"type\":\"boolean\",\"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.\"},\"collections1BuyTogether\":{\"type\":\"array\",\"description\":\"Collections that will generate the promotion, type **Buy Together**, **More for less**, **Progressive Discount**, **Buy One Get One**.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the collection to be added to the first list of the **Buy Together** promotion.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the collection to be added to the first list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the collection to be added to the first list of the **Buy Together** promotion.\"}}}},\"collections2BuyTogether\":{\"type\":\"array\",\"description\":\"Collections that will generate the promotion, type **Buy Together**, **More for less**, **Progressive Discount**, **Buy One Get One**.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the collection to be added to the first list of the **Buy Together** promotion.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the collection to be added to the first list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the collection to be added to the first list of the **Buy Together** promotion.\"}}}},\"minimumQuantityBuyTogether\":{\"type\":\"integer\",\"description\":\"Minimum quantity for **Buy Together** promotion.\"},\"quantityToAffectBuyTogether\":{\"type\":\"integer\",\"description\":\"Quantity to affect **Buy Together** promotion.\"},\"enableBuyTogetherPerSku\":{\"type\":\"boolean\",\"description\":\"Enable **Buy Together** per SKU.\"},\"listSku1BuyTogether\":{\"type\":\"array\",\"description\":\"Array of objects, each containing ID and Name of an SKU to be added in the first list of the **Buy Together** promotion. Learn more about this type of promotion in the [Creating a Buy Together promotion](https://help.vtex.com/en/tutorial/buy-together--tutorials_323) documentation.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the SKU to be added to the first list of the **Buy Together** promotion. Learn more about this type of promotion in the [Creating a Buy Together promotion](https://help.vtex.com/en/tutorial/buy-together--tutorials_323) documentation.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the SKU to be added to the first list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the SKU to be added to the first list of the **Buy Together** promotion.\"}}}},\"listSku2BuyTogether\":{\"type\":\"array\",\"description\":\"Array of objects, each containing ID and Name of an SKU to be added to the second list of the **Buy Together** promotion. Learn more about this type of promotion in the [Creating a Buy Together promotion](https://help.vtex.com/en/tutorial/buy-together--tutorials_323) documentation.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the SKU to be added to the second list of the **Buy Together** promotion. Learn more about this type of promotion in the [Creating a Buy Together promotion](https://help.vtex.com/en/tutorial/buy-together--tutorials_323) documentation.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the SKU to be added to the second list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the SKU to be added to the second list of the **Buy Together** promotion.\"}}}},\"listBrand1BuyTogether\":{\"type\":\"array\",\"description\":\"Array of objects, each containing ID and Name of a brand to be added in the first list of the **Buy Together** promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the brand to be added to the first list of the **Buy Together** promotion.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the brand to be added to the first list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the brand to be added to the first list of the **Buy Together** promotion.\"}}}},\"listCategory1BuyTogether\":{\"type\":\"array\",\"description\":\"Array of objects, each containing ID and Name of a category to be added in the first list of the **Buy Together** promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the category to be added to the first list of the **Buy Together** promotion.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the category to be added to the first list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the category to be added to the first list of the **Buy Together** promotion.\"}}}},\"coupon\":{\"type\":\"array\",\"description\":\"List of coupons.\",\"items\":{\"type\":\"string\",\"description\":\"Coupon code.\"}},\"totalValueFloor\":{\"type\":\"number\",\"description\":\"Minimum chart value to active the campaign audience.\"},\"totalValueCeling\":{\"type\":\"number\",\"description\":\"Maximum chart value to active the campaign audience.\"},\"totalValueIncludeAllItems\":{\"type\":\"boolean\",\"description\":\"Total value including all items.\"},\"totalValueMode\":{\"type\":\"string\",\"description\":\"Total chart value to active the campaign audience.\"},\"collections\":{\"type\":\"array\",\"description\":\"Object composed by the collections that will activate or deactivate the campaign audience.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the collection.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Collection ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Collection Name.\"}}}},\"collectionsIsInclusive\":{\"type\":\"boolean\",\"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.\"},\"restrictionsBins\":{\"type\":\"array\",\"description\":\"The discount will be granted if the card's BIN is given.\",\"items\":{\"type\":\"string\",\"description\":\"Card's BIN.\"}},\"cardIssuers\":{\"type\":\"array\",\"description\":\"List of card issuers.\",\"items\":{\"type\":\"string\",\"description\":\"Card issuer.\"}},\"totalValuePurchase\":{\"type\":\"number\",\"description\":\"Total value a client must have in past orders to active the campaign audience.\"},\"slasIds\":{\"type\":\"array\",\"description\":\"The discount will be granted if the shipping method is the same as the one given.\",\"items\":{\"type\":\"string\",\"description\":\"Shipping method.\"}},\"isSlaSelected\":{\"type\":\"boolean\",\"description\":\"Applies selected discount only when one of the defined shipping method is selected by the customer.\"},\"isFirstBuy\":{\"type\":\"boolean\",\"description\":\"Applies the discount only if it's a first buy.\"},\"firstBuyIsProfileOptimistic\":{\"type\":\"boolean\",\"description\":\"Applies the discount even if the user is not logged.\"},\"compareListPriceAndPrice\":{\"type\":\"boolean\",\"description\":\"If the **List Price** and **Price** are the same.\"},\"isDifferentListPriceAndPrice\":{\"type\":\"boolean\",\"description\":\"Applies the campaign audience only if the list price and price is different.\"},\"zipCodeRanges\":{\"type\":\"array\",\"description\":\"Range of zip codes that applies the promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the Zip Code\",\"properties\":{\"zipCodeFrom\":{\"type\":\"string\",\"description\":\"Initial Zip Code.\"},\"zipCodeTo\":{\"type\":\"string\",\"description\":\"Final Zip Code.\"},\"inclusive\":{\"type\":\"boolean\",\"description\":\"Defines if the zip code range is included in the promotion.\"}}}},\"itemMaxPrice\":{\"type\":\"number\",\"description\":\"Maximum price of the item.\"},\"itemMinPrice\":{\"type\":\"number\",\"description\":\"Minimum price of the item.\"},\"installment\":{\"type\":\"integer\",\"description\":\"Installment.\"},\"isMinMaxInstallments\":{\"type\":\"boolean\",\"description\":\"Set if the campaign audience will be applied considering a minimum and maximum values for installments.\"},\"minInstallment\":{\"type\":\"integer\",\"description\":\"Minimum value for installment.\"},\"maxInstallment\":{\"type\":\"integer\",\"description\":\"Maximum value for installment.\"},\"merchants\":{\"type\":\"array\",\"description\":\"List of merchants.\",\"items\":{\"type\":\"string\",\"description\":\"Merchant.\"}},\"clusterExpressions\":{\"type\":\"array\",\"description\":\"Criteria to select a customer cluster. Each item in this array should follow the format of an equality function (`{propertyname}={value}`) or the format of a contains function (`{propertyname} contains {value}`). In both options, `{propertyname}` must be replaced with the name of the field in the data entity, and `{value}` must be replaced with the value determined in Master Data. Find more information about these criteria in [Filling in the Customer cluster field](https://help.vtex.com/tutorial/creating-promotion-for-a-customer-cluster--tutorials_342#filling-in-the-customer-cluster-field).\",\"items\":{\"type\":\"string\",\"description\":\"Cluster expression.\"}},\"clusterOperator\":{\"type\":\"string\",\"description\":\"Cluster operator.\"},\"paymentsRules\":{\"type\":\"array\",\"description\":\"List of payment rules.\",\"items\":{\"type\":\"string\",\"description\":\"Payment rule.\"}},\"giftListTypes\":{\"type\":\"array\",\"description\":\"Gifts List Type.\",\"items\":{\"type\":\"string\",\"description\":\"Gift List Type.\"}},\"productsSpecifications\":{\"type\":\"array\",\"description\":\"List of product specifications.\",\"items\":{\"type\":\"string\",\"description\":\"Product specification.\"}},\"affiliates\":{\"type\":\"array\",\"description\":\"Marketplace order identifier. The discount will apply to selected affiliates.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the affiliate.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Affiliate ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Affiliate Name.\"}}}},\"maxUsage\":{\"type\":\"integer\",\"description\":\"Defines how many times the campaign audience can be used.\"},\"maxUsagePerClient\":{\"type\":\"integer\",\"description\":\"Defines if the campaign audience can be used multiple times per client.\"},\"shouldDistributeDiscountAmongMatchedItems\":{\"type\":\"boolean\",\"description\":\"Should distribute discount among matched items.\"},\"multipleUsePerClient\":{\"type\":\"boolean\",\"description\":\"Defines if the campaign audience can be used multiple times per client.\"},\"useNewProgressiveAlgorithm\":{\"type\":\"boolean\",\"description\":\"Use new progressive algorithm.\"},\"percentualDiscountValueList\":{\"type\":\"array\",\"description\":\"Percentual discount value list.\",\"items\":{\"type\":\"number\",\"description\":\"Percentual discount value.\"}}}}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/rnb/pvt/campaignConfiguration - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -4524,7 +3700,7 @@ } }, { - "id": "0e92dac7-f89b-42fd-bfb5-a212129df897", + "id": "87258013-b534-4c4a-a4cb-026b422e5d26", "name": "Create campaign audience", "request": { "name": "Create campaign audience", @@ -4543,26 +3719,7 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ { @@ -4582,6 +3739,14 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], "method": "POST", @@ -4590,6 +3755,7 @@ "raw": "{\n \"beginDateUtc\": \"2020-05-01T21:30:00Z\",\n \"endDateUtc\": \"2020-05-02T01:30:00Z\",\n \"id\": \"dd270d06-1ed1-47fc-b04e-a2431121b5a4\",\n \"name\": \"Interna\",\n \"isActive\": true,\n \"isAndOperator\": true,\n \"isArchived\": false,\n \"lastModified\": {\n \"dateUtc\": \"2020-05-01T21:22:01.807398Z\",\n \"user\": \"email@email.com\"\n },\n \"targetConfigurations\": [\n {\n \"featured\": false,\n \"id\": \"77ae1e4c-a216-4b15-a4a3-ae64ec298988\",\n \"name\": \"Social Sellers\",\n \"daysAgoOfPurchases\": 0,\n \"origin\": \"Marketplace\",\n \"idSellerIsInclusive\": false,\n \"idsSalesChannel\": [\n \"Principal\",\n \"Principal\"\n ],\n \"areSalesChannelIdsExclusive\": false,\n \"marketingTags\": [\n \"MKT1\",\n \"MKT1\"\n ],\n \"marketingTagsAreNotInclusive\": false,\n \"paymentsMethods\": [\n {\n \"id\": \"2\",\n \"name\": \"Visa (2)\"\n },\n {\n \"id\": \"2\",\n \"name\": \"Visa (2)\"\n }\n ],\n \"stores\": [\n \"store\",\n \"store\"\n ],\n \"campaigns\": [\n \"campaign\",\n \"campaign\"\n ],\n \"storesAreInclusive\": false,\n \"categories\": [\n {\n \"id\": \"1\",\n \"name\": \"Vinhos Tintos (1)\"\n },\n {\n \"id\": \"1\",\n \"name\": \"Vinhos Tintos (1)\"\n }\n ],\n \"categoriesAreInclusive\": true,\n \"brands\": [\n {\n \"id\": \"1\",\n \"name\": \"Brand (1)\"\n },\n {\n \"id\": \"1\",\n \"name\": \"Brand (1)\"\n }\n ],\n \"brandsAreInclusive\": true,\n \"products\": [\n {\n \"id\": \"1\",\n \"name\": \"Vinho (1)\"\n },\n {\n \"id\": \"1\",\n \"name\": \"Vinho (1)\"\n }\n ],\n \"productsAreInclusive\": true,\n \"skus\": [\n {\n \"id\": \"1\",\n \"name\": \"Vinho tinto (1)\"\n },\n {\n \"id\": \"1\",\n \"name\": \"Vinho tinto (1)\"\n }\n ],\n \"skusAreInclusive\": true,\n \"collections1BuyTogether\": [\n {\n \"id\": \"157\",\n \"name\": \"Inverno (157)\"\n },\n {\n \"id\": \"157\",\n \"name\": \"Inverno (157)\"\n }\n ],\n \"collections2BuyTogether\": [\n {\n \"id\": \"157\",\n \"name\": \"Inverno (157)\"\n },\n {\n \"id\": \"157\",\n \"name\": \"Inverno (157)\"\n }\n ],\n \"minimumQuantityBuyTogether\": 1,\n \"quantityToAffectBuyTogether\": 0,\n \"enableBuyTogetherPerSku\": false,\n \"listSku1BuyTogether\": [\n {\n \"id\": \"1\",\n \"name\": \"Vinho\"\n },\n {\n \"id\": \"1\",\n \"name\": \"Vinho\"\n }\n ],\n \"listSku2BuyTogether\": [\n {\n \"id\": \"1\",\n \"name\": \"Vinho\"\n },\n {\n \"id\": \"1\",\n \"name\": \"Vinho\"\n }\n ],\n \"listBrand1BuyTogether\": [\n {\n \"id\": \"1\",\n \"name\": \"Malbec\"\n },\n {\n \"id\": \"1\",\n \"name\": \"Malbec\"\n }\n ],\n \"listCategory1BuyTogether\": [\n {\n \"id\": \"1\",\n \"name\": \"Vinhos Tintos\"\n },\n {\n \"id\": \"1\",\n \"name\": \"Vinhos Tintos\"\n }\n ],\n \"coupon\": [\n \"coupon code.\",\n \"coupon code.\"\n ],\n \"totalValueFloor\": 40,\n \"totalValueCeling\": 0,\n \"totalValueIncludeAllItems\": false,\n \"totalValueMode\": \"IncludeMatchedItems\",\n \"collections\": [\n {\n \"id\": \"1\",\n \"name\": \"Collection (1)\"\n },\n {\n \"id\": \"1\",\n \"name\": \"Collection (1)\"\n }\n ],\n \"collectionsIsInclusive\": true,\n \"restrictionsBins\": [\n \"1234\",\n \"1234\"\n ],\n \"cardIssuers\": [\n \"issuer\",\n \"issuer\"\n ],\n \"totalValuePurchase\": 0,\n \"slasIds\": [\n \"Express\",\n \"Express\"\n ],\n \"isSlaSelected\": false,\n \"isFirstBuy\": false,\n \"firstBuyIsProfileOptimistic\": false,\n \"compareListPriceAndPrice\": false,\n \"isDifferentListPriceAndPrice\": false,\n \"zipCodeRanges\": [\n {\n \"zipCodeFrom\": \"20000-000\",\n \"zipCodeTo\": \"20000-100\",\n \"inclusive\": true\n },\n {\n \"zipCodeFrom\": \"20000-000\",\n \"zipCodeTo\": \"20000-100\",\n \"inclusive\": true\n }\n ],\n \"itemMaxPrice\": 0,\n \"itemMinPrice\": 0,\n \"installment\": 1,\n \"isMinMaxInstallments\": false,\n \"minInstallment\": 0,\n \"maxInstallment\": 0,\n \"merchants\": [\n \"merchant\",\n \"merchant\"\n ],\n \"clusterExpressions\": [\n \"email contains user@mail.com\",\n \"email contains user@mail.com\"\n ],\n \"clusterOperator\": \"operator\",\n \"paymentsRules\": [\n \"rule1\",\n \"rule1\"\n ],\n \"giftListTypes\": [\n \"Wishlist\",\n \"Wishlist\"\n ],\n \"productsSpecifications\": [\n \"spec\",\n \"spec\"\n ],\n \"affiliates\": [\n {\n \"id\": \"1\",\n \"name\": \"Amazon\"\n },\n {\n \"id\": \"1\",\n \"name\": \"Amazon\"\n }\n ],\n \"maxUsage\": 0,\n \"maxUsagePerClient\": 0,\n \"shouldDistributeDiscountAmongMatchedItems\": false,\n \"multipleUsePerClient\": false,\n \"useNewProgressiveAlgorithm\": false,\n \"percentualDiscountValueList\": [\n 0,\n 0\n ]\n },\n {\n \"featured\": false,\n \"id\": \"77ae1e4c-a216-4b15-a4a3-ae64ec298988\",\n \"name\": \"Social Sellers\",\n \"daysAgoOfPurchases\": 0,\n \"origin\": \"Marketplace\",\n \"idSellerIsInclusive\": false,\n \"idsSalesChannel\": [\n \"Principal\",\n \"Principal\"\n ],\n \"areSalesChannelIdsExclusive\": false,\n \"marketingTags\": [\n \"MKT1\",\n \"MKT1\"\n ],\n \"marketingTagsAreNotInclusive\": false,\n \"paymentsMethods\": [\n {\n \"id\": \"2\",\n \"name\": \"Visa (2)\"\n },\n {\n \"id\": \"2\",\n \"name\": \"Visa (2)\"\n }\n ],\n \"stores\": [\n \"store\",\n \"store\"\n ],\n \"campaigns\": [\n \"campaign\",\n \"campaign\"\n ],\n \"storesAreInclusive\": false,\n \"categories\": [\n {\n \"id\": \"1\",\n \"name\": \"Vinhos Tintos (1)\"\n },\n {\n \"id\": \"1\",\n \"name\": \"Vinhos Tintos (1)\"\n }\n ],\n \"categoriesAreInclusive\": true,\n \"brands\": [\n {\n \"id\": \"1\",\n \"name\": \"Brand (1)\"\n },\n {\n \"id\": \"1\",\n \"name\": \"Brand (1)\"\n }\n ],\n \"brandsAreInclusive\": true,\n \"products\": [\n {\n \"id\": \"1\",\n \"name\": \"Vinho (1)\"\n },\n {\n \"id\": \"1\",\n \"name\": \"Vinho (1)\"\n }\n ],\n \"productsAreInclusive\": true,\n \"skus\": [\n {\n \"id\": \"1\",\n \"name\": \"Vinho tinto (1)\"\n },\n {\n \"id\": \"1\",\n \"name\": \"Vinho tinto (1)\"\n }\n ],\n \"skusAreInclusive\": true,\n \"collections1BuyTogether\": [\n {\n \"id\": \"157\",\n \"name\": \"Inverno (157)\"\n },\n {\n \"id\": \"157\",\n \"name\": \"Inverno (157)\"\n }\n ],\n \"collections2BuyTogether\": [\n {\n \"id\": \"157\",\n \"name\": \"Inverno (157)\"\n },\n {\n \"id\": \"157\",\n \"name\": \"Inverno (157)\"\n }\n ],\n \"minimumQuantityBuyTogether\": 1,\n \"quantityToAffectBuyTogether\": 0,\n \"enableBuyTogetherPerSku\": false,\n \"listSku1BuyTogether\": [\n {\n \"id\": \"1\",\n \"name\": \"Vinho\"\n },\n {\n \"id\": \"1\",\n \"name\": \"Vinho\"\n }\n ],\n \"listSku2BuyTogether\": [\n {\n \"id\": \"1\",\n \"name\": \"Vinho\"\n },\n {\n \"id\": \"1\",\n \"name\": \"Vinho\"\n }\n ],\n \"listBrand1BuyTogether\": [\n {\n \"id\": \"1\",\n \"name\": \"Malbec\"\n },\n {\n \"id\": \"1\",\n \"name\": \"Malbec\"\n }\n ],\n \"listCategory1BuyTogether\": [\n {\n \"id\": \"1\",\n \"name\": \"Vinhos Tintos\"\n },\n {\n \"id\": \"1\",\n \"name\": \"Vinhos Tintos\"\n }\n ],\n \"coupon\": [\n \"coupon code.\",\n \"coupon code.\"\n ],\n \"totalValueFloor\": 40,\n \"totalValueCeling\": 0,\n \"totalValueIncludeAllItems\": false,\n \"totalValueMode\": \"IncludeMatchedItems\",\n \"collections\": [\n {\n \"id\": \"1\",\n \"name\": \"Collection (1)\"\n },\n {\n \"id\": \"1\",\n \"name\": \"Collection (1)\"\n }\n ],\n \"collectionsIsInclusive\": true,\n \"restrictionsBins\": [\n \"1234\",\n \"1234\"\n ],\n \"cardIssuers\": [\n \"issuer\",\n \"issuer\"\n ],\n \"totalValuePurchase\": 0,\n \"slasIds\": [\n \"Express\",\n \"Express\"\n ],\n \"isSlaSelected\": false,\n \"isFirstBuy\": false,\n \"firstBuyIsProfileOptimistic\": false,\n \"compareListPriceAndPrice\": false,\n \"isDifferentListPriceAndPrice\": false,\n \"zipCodeRanges\": [\n {\n \"zipCodeFrom\": \"20000-000\",\n \"zipCodeTo\": \"20000-100\",\n \"inclusive\": true\n },\n {\n \"zipCodeFrom\": \"20000-000\",\n \"zipCodeTo\": \"20000-100\",\n \"inclusive\": true\n }\n ],\n \"itemMaxPrice\": 0,\n \"itemMinPrice\": 0,\n \"installment\": 1,\n \"isMinMaxInstallments\": false,\n \"minInstallment\": 0,\n \"maxInstallment\": 0,\n \"merchants\": [\n \"merchant\",\n \"merchant\"\n ],\n \"clusterExpressions\": [\n \"email contains user@mail.com\",\n \"email contains user@mail.com\"\n ],\n \"clusterOperator\": \"operator\",\n \"paymentsRules\": [\n \"rule1\",\n \"rule1\"\n ],\n \"giftListTypes\": [\n \"Wishlist\",\n \"Wishlist\"\n ],\n \"productsSpecifications\": [\n \"spec\",\n \"spec\"\n ],\n \"affiliates\": [\n {\n \"id\": \"1\",\n \"name\": \"Amazon\"\n },\n {\n \"id\": \"1\",\n \"name\": \"Amazon\"\n }\n ],\n \"maxUsage\": 0,\n \"maxUsagePerClient\": 0,\n \"shouldDistributeDiscountAmongMatchedItems\": false,\n \"multipleUsePerClient\": false,\n \"useNewProgressiveAlgorithm\": false,\n \"percentualDiscountValueList\": [\n 0,\n 0\n ]\n }\n ]\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -4600,7 +3766,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "73cdf8b6-6883-4aa3-aee1-d518e291b954", + "id": "b6ef1fef-2104-4fb0-a722-bd21b150d2e1", "name": "OK", "originalRequest": { "url": { @@ -4614,36 +3780,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -4662,9 +3801,21 @@ "key": "Accept", "value": "application/json" }, + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "POST", @@ -4673,6 +3824,7 @@ "raw": "{\n \"beginDateUtc\": \"2020-05-01T21:30:00Z\",\n \"endDateUtc\": \"2020-05-02T01:30:00Z\",\n \"id\": \"dd270d06-1ed1-47fc-b04e-a2431121b5a4\",\n \"name\": \"Interna\",\n \"isActive\": true,\n \"isAndOperator\": true,\n \"isArchived\": false,\n \"lastModified\": {\n \"dateUtc\": \"2020-05-01T21:22:01.807398Z\",\n \"user\": \"email@email.com\"\n },\n \"targetConfigurations\": [\n {\n \"featured\": false,\n \"id\": \"77ae1e4c-a216-4b15-a4a3-ae64ec298988\",\n \"name\": \"Social Sellers\",\n \"daysAgoOfPurchases\": 0,\n \"origin\": \"Marketplace\",\n \"idSellerIsInclusive\": false,\n \"idsSalesChannel\": [\n \"Principal\",\n \"Principal\"\n ],\n \"areSalesChannelIdsExclusive\": false,\n \"marketingTags\": [\n \"MKT1\",\n \"MKT1\"\n ],\n \"marketingTagsAreNotInclusive\": false,\n \"paymentsMethods\": [\n {\n \"id\": \"2\",\n \"name\": \"Visa (2)\"\n },\n {\n \"id\": \"2\",\n \"name\": \"Visa (2)\"\n }\n ],\n \"stores\": [\n \"store\",\n \"store\"\n ],\n \"campaigns\": [\n \"campaign\",\n \"campaign\"\n ],\n \"storesAreInclusive\": false,\n \"categories\": [\n {\n \"id\": \"1\",\n \"name\": \"Vinhos Tintos (1)\"\n },\n {\n \"id\": \"1\",\n \"name\": \"Vinhos Tintos (1)\"\n }\n ],\n \"categoriesAreInclusive\": true,\n \"brands\": [\n {\n \"id\": \"1\",\n \"name\": \"Brand (1)\"\n },\n {\n \"id\": \"1\",\n \"name\": \"Brand (1)\"\n }\n ],\n \"brandsAreInclusive\": true,\n \"products\": [\n {\n \"id\": \"1\",\n \"name\": \"Vinho (1)\"\n },\n {\n \"id\": \"1\",\n \"name\": \"Vinho (1)\"\n }\n ],\n \"productsAreInclusive\": true,\n \"skus\": [\n {\n \"id\": \"1\",\n \"name\": \"Vinho tinto (1)\"\n },\n {\n \"id\": \"1\",\n \"name\": \"Vinho tinto (1)\"\n }\n ],\n \"skusAreInclusive\": true,\n \"collections1BuyTogether\": [\n {\n \"id\": \"157\",\n \"name\": \"Inverno (157)\"\n },\n {\n \"id\": \"157\",\n \"name\": \"Inverno (157)\"\n }\n ],\n \"collections2BuyTogether\": [\n {\n \"id\": \"157\",\n \"name\": \"Inverno (157)\"\n },\n {\n \"id\": \"157\",\n \"name\": \"Inverno (157)\"\n }\n ],\n \"minimumQuantityBuyTogether\": 1,\n \"quantityToAffectBuyTogether\": 0,\n \"enableBuyTogetherPerSku\": false,\n \"listSku1BuyTogether\": [\n {\n \"id\": \"1\",\n \"name\": \"Vinho\"\n },\n {\n \"id\": \"1\",\n \"name\": \"Vinho\"\n }\n ],\n \"listSku2BuyTogether\": [\n {\n \"id\": \"1\",\n \"name\": \"Vinho\"\n },\n {\n \"id\": \"1\",\n \"name\": \"Vinho\"\n }\n ],\n \"listBrand1BuyTogether\": [\n {\n \"id\": \"1\",\n \"name\": \"Malbec\"\n },\n {\n \"id\": \"1\",\n \"name\": \"Malbec\"\n }\n ],\n \"listCategory1BuyTogether\": [\n {\n \"id\": \"1\",\n \"name\": \"Vinhos Tintos\"\n },\n {\n \"id\": \"1\",\n \"name\": \"Vinhos Tintos\"\n }\n ],\n \"coupon\": [\n \"coupon code.\",\n \"coupon code.\"\n ],\n \"totalValueFloor\": 40,\n \"totalValueCeling\": 0,\n \"totalValueIncludeAllItems\": false,\n \"totalValueMode\": \"IncludeMatchedItems\",\n \"collections\": [\n {\n \"id\": \"1\",\n \"name\": \"Collection (1)\"\n },\n {\n \"id\": \"1\",\n \"name\": \"Collection (1)\"\n }\n ],\n \"collectionsIsInclusive\": true,\n \"restrictionsBins\": [\n \"1234\",\n \"1234\"\n ],\n \"cardIssuers\": [\n \"issuer\",\n \"issuer\"\n ],\n \"totalValuePurchase\": 0,\n \"slasIds\": [\n \"Express\",\n \"Express\"\n ],\n \"isSlaSelected\": false,\n \"isFirstBuy\": false,\n \"firstBuyIsProfileOptimistic\": false,\n \"compareListPriceAndPrice\": false,\n \"isDifferentListPriceAndPrice\": false,\n \"zipCodeRanges\": [\n {\n \"zipCodeFrom\": \"20000-000\",\n \"zipCodeTo\": \"20000-100\",\n \"inclusive\": true\n },\n {\n \"zipCodeFrom\": \"20000-000\",\n \"zipCodeTo\": \"20000-100\",\n \"inclusive\": true\n }\n ],\n \"itemMaxPrice\": 0,\n \"itemMinPrice\": 0,\n \"installment\": 1,\n \"isMinMaxInstallments\": false,\n \"minInstallment\": 0,\n \"maxInstallment\": 0,\n \"merchants\": [\n \"merchant\",\n \"merchant\"\n ],\n \"clusterExpressions\": [\n \"email contains user@mail.com\",\n \"email contains user@mail.com\"\n ],\n \"clusterOperator\": \"operator\",\n \"paymentsRules\": [\n \"rule1\",\n \"rule1\"\n ],\n \"giftListTypes\": [\n \"Wishlist\",\n \"Wishlist\"\n ],\n \"productsSpecifications\": [\n \"spec\",\n \"spec\"\n ],\n \"affiliates\": [\n {\n \"id\": \"1\",\n \"name\": \"Amazon\"\n },\n {\n \"id\": \"1\",\n \"name\": \"Amazon\"\n }\n ],\n \"maxUsage\": 0,\n \"maxUsagePerClient\": 0,\n \"shouldDistributeDiscountAmongMatchedItems\": false,\n \"multipleUsePerClient\": false,\n \"useNewProgressiveAlgorithm\": false,\n \"percentualDiscountValueList\": [\n 0,\n 0\n ]\n },\n {\n \"featured\": false,\n \"id\": \"77ae1e4c-a216-4b15-a4a3-ae64ec298988\",\n \"name\": \"Social Sellers\",\n \"daysAgoOfPurchases\": 0,\n \"origin\": \"Marketplace\",\n \"idSellerIsInclusive\": false,\n \"idsSalesChannel\": [\n \"Principal\",\n \"Principal\"\n ],\n \"areSalesChannelIdsExclusive\": false,\n \"marketingTags\": [\n \"MKT1\",\n \"MKT1\"\n ],\n \"marketingTagsAreNotInclusive\": false,\n \"paymentsMethods\": [\n {\n \"id\": \"2\",\n \"name\": \"Visa (2)\"\n },\n {\n \"id\": \"2\",\n \"name\": \"Visa (2)\"\n }\n ],\n \"stores\": [\n \"store\",\n \"store\"\n ],\n \"campaigns\": [\n \"campaign\",\n \"campaign\"\n ],\n \"storesAreInclusive\": false,\n \"categories\": [\n {\n \"id\": \"1\",\n \"name\": \"Vinhos Tintos (1)\"\n },\n {\n \"id\": \"1\",\n \"name\": \"Vinhos Tintos (1)\"\n }\n ],\n \"categoriesAreInclusive\": true,\n \"brands\": [\n {\n \"id\": \"1\",\n \"name\": \"Brand (1)\"\n },\n {\n \"id\": \"1\",\n \"name\": \"Brand (1)\"\n }\n ],\n \"brandsAreInclusive\": true,\n \"products\": [\n {\n \"id\": \"1\",\n \"name\": \"Vinho (1)\"\n },\n {\n \"id\": \"1\",\n \"name\": \"Vinho (1)\"\n }\n ],\n \"productsAreInclusive\": true,\n \"skus\": [\n {\n \"id\": \"1\",\n \"name\": \"Vinho tinto (1)\"\n },\n {\n \"id\": \"1\",\n \"name\": \"Vinho tinto (1)\"\n }\n ],\n \"skusAreInclusive\": true,\n \"collections1BuyTogether\": [\n {\n \"id\": \"157\",\n \"name\": \"Inverno (157)\"\n },\n {\n \"id\": \"157\",\n \"name\": \"Inverno (157)\"\n }\n ],\n \"collections2BuyTogether\": [\n {\n \"id\": \"157\",\n \"name\": \"Inverno (157)\"\n },\n {\n \"id\": \"157\",\n \"name\": \"Inverno (157)\"\n }\n ],\n \"minimumQuantityBuyTogether\": 1,\n \"quantityToAffectBuyTogether\": 0,\n \"enableBuyTogetherPerSku\": false,\n \"listSku1BuyTogether\": [\n {\n \"id\": \"1\",\n \"name\": \"Vinho\"\n },\n {\n \"id\": \"1\",\n \"name\": \"Vinho\"\n }\n ],\n \"listSku2BuyTogether\": [\n {\n \"id\": \"1\",\n \"name\": \"Vinho\"\n },\n {\n \"id\": \"1\",\n \"name\": \"Vinho\"\n }\n ],\n \"listBrand1BuyTogether\": [\n {\n \"id\": \"1\",\n \"name\": \"Malbec\"\n },\n {\n \"id\": \"1\",\n \"name\": \"Malbec\"\n }\n ],\n \"listCategory1BuyTogether\": [\n {\n \"id\": \"1\",\n \"name\": \"Vinhos Tintos\"\n },\n {\n \"id\": \"1\",\n \"name\": \"Vinhos Tintos\"\n }\n ],\n \"coupon\": [\n \"coupon code.\",\n \"coupon code.\"\n ],\n \"totalValueFloor\": 40,\n \"totalValueCeling\": 0,\n \"totalValueIncludeAllItems\": false,\n \"totalValueMode\": \"IncludeMatchedItems\",\n \"collections\": [\n {\n \"id\": \"1\",\n \"name\": \"Collection (1)\"\n },\n {\n \"id\": \"1\",\n \"name\": \"Collection (1)\"\n }\n ],\n \"collectionsIsInclusive\": true,\n \"restrictionsBins\": [\n \"1234\",\n \"1234\"\n ],\n \"cardIssuers\": [\n \"issuer\",\n \"issuer\"\n ],\n \"totalValuePurchase\": 0,\n \"slasIds\": [\n \"Express\",\n \"Express\"\n ],\n \"isSlaSelected\": false,\n \"isFirstBuy\": false,\n \"firstBuyIsProfileOptimistic\": false,\n \"compareListPriceAndPrice\": false,\n \"isDifferentListPriceAndPrice\": false,\n \"zipCodeRanges\": [\n {\n \"zipCodeFrom\": \"20000-000\",\n \"zipCodeTo\": \"20000-100\",\n \"inclusive\": true\n },\n {\n \"zipCodeFrom\": \"20000-000\",\n \"zipCodeTo\": \"20000-100\",\n \"inclusive\": true\n }\n ],\n \"itemMaxPrice\": 0,\n \"itemMinPrice\": 0,\n \"installment\": 1,\n \"isMinMaxInstallments\": false,\n \"minInstallment\": 0,\n \"maxInstallment\": 0,\n \"merchants\": [\n \"merchant\",\n \"merchant\"\n ],\n \"clusterExpressions\": [\n \"email contains user@mail.com\",\n \"email contains user@mail.com\"\n ],\n \"clusterOperator\": \"operator\",\n \"paymentsRules\": [\n \"rule1\",\n \"rule1\"\n ],\n \"giftListTypes\": [\n \"Wishlist\",\n \"Wishlist\"\n ],\n \"productsSpecifications\": [\n \"spec\",\n \"spec\"\n ],\n \"affiliates\": [\n {\n \"id\": \"1\",\n \"name\": \"Amazon\"\n },\n {\n \"id\": \"1\",\n \"name\": \"Amazon\"\n }\n ],\n \"maxUsage\": 0,\n \"maxUsagePerClient\": 0,\n \"shouldDistributeDiscountAmongMatchedItems\": false,\n \"multipleUsePerClient\": false,\n \"useNewProgressiveAlgorithm\": false,\n \"percentualDiscountValueList\": [\n 0,\n 0\n ]\n }\n ]\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -4694,13 +3846,13 @@ { "listen": "test", "script": { - "id": "deda7bcc-d431-4066-9fb6-8fb22d11f8ee", + "id": "bf4ad296-9a3e-4371-af66-69e1dbd20316", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/rnb/pvt/campaignConfiguration - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[POST]::/api/rnb/pvt/campaignConfiguration - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[POST]::/api/rnb/pvt/campaignConfiguration - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"type\":\"object\",\"properties\":{\"beginDateUtc\":{\"type\":\"string\",\"description\":\"Start date of the campaign audience in UTC format.\"},\"endDateUtc\":{\"type\":\"string\",\"description\":\"End date of the campaign audience in UTC format.\"},\"id\":{\"type\":\"string\",\"description\":\"Campaign audience ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Campaign audience name.\"},\"isActive\":{\"type\":\"boolean\",\"description\":\"Defines if the campaign audience is active (`true`) or not (`false`).\"},\"isAndOperator\":{\"type\":\"boolean\",\"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.\"},\"isArchived\":{\"type\":\"boolean\",\"description\":\"Defines if the campaign audience is archived (`true`) or not (`false`).\"},\"lastModified\":{\"type\":\"object\",\"description\":\"Object with information about the most recent update of the campaign audience.\",\"properties\":{\"dateUtc\":{\"type\":\"string\",\"description\":\"Date of the most recent update in UTC format.\"},\"user\":{\"type\":\"string\",\"description\":\"Email of the user who updated the campaign audience for the latest time.\"}}},\"targetConfigurations\":{\"type\":\"array\",\"description\":\"Array that contains all target audience that the campaign audience will be valid.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information about the target audience.\",\"properties\":{\"featured\":{\"type\":\"boolean\",\"description\":\"Defines if the target audience is feature (`true`) or not (`false`).\"},\"id\":{\"type\":\"string\",\"description\":\"Target audience ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Target audience name.\"},\"daysAgoOfPurchases\":{\"type\":\"integer\",\"description\":\"Number of days that are considered to add the purchase history.\"},\"origin\":{\"type\":\"string\",\"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.\"},\"idSellerIsInclusive\":{\"type\":\"boolean\",\"description\":\"Defines if at least one of the sellers must be valid to active the campaign audience.\"},\"idsSalesChannel\":{\"type\":\"array\",\"description\":\"Array with all the trade policies that activate the campaign audience.\",\"items\":{\"type\":\"string\",\"description\":\"Trade policy ID.\"}},\"areSalesChannelIdsExclusive\":{\"type\":\"boolean\",\"description\":\"Defines if the trade policy IDs are exclusive.\"},\"marketingTags\":{\"type\":\"array\",\"description\":\"Array with all the campaign audience's marketing tags.\",\"items\":{\"type\":\"string\",\"description\":\"Campaign audience marketing tags.\"}},\"marketingTagsAreNotInclusive\":{\"type\":\"boolean\",\"description\":\"Defines if marketing tags are not inclusive.\"},\"paymentsMethods\":{\"type\":\"array\",\"description\":\"Array composed by all the Payments Methods.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the Payment Method.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Payment Method ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Payment Method Name.\"}}}},\"stores\":{\"type\":\"array\",\"deprecated\":true,\"description\":\"List of stores.\",\"items\":{\"type\":\"string\",\"description\":\"Store.\"}},\"campaigns\":{\"type\":\"array\",\"description\":\"Campaign Audiences that activate this promotion.\",\"items\":{\"type\":\"string\",\"description\":\"Campaign.\"}},\"storesAreInclusive\":{\"type\":\"boolean\",\"deprecated\":true,\"description\":\"If set to `true`, this promotion will be applied to any store present on the `stores` field. If set to `false`, stores present on that field will make this promotion not to be applied.\"},\"categories\":{\"type\":\"array\",\"description\":\"Object composed by the categories that will activate or deactivate the campaign audience.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the category.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Category ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Category Name.\"}}}},\"categoriesAreInclusive\":{\"type\":\"boolean\",\"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.\"},\"brands\":{\"type\":\"array\",\"description\":\"Object composed by the brands that will activate or deactivate the campaign audience.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the brand.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Brand ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Brand Name.\"}}}},\"brandsAreInclusive\":{\"type\":\"boolean\",\"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.\"},\"products\":{\"type\":\"array\",\"description\":\"Object composed by the products that will activate or deactivate the campaign audience.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the product.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Product Name.\"}}}},\"productsAreInclusive\":{\"type\":\"boolean\",\"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.\"},\"skus\":{\"type\":\"array\",\"description\":\"Object composed by the SKUs that will activate or deactivate the campaign audience.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the SKU.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SKU ID.\"},\"name\":{\"type\":\"string\",\"description\":\"SKU Name.\"}}}},\"skusAreInclusive\":{\"type\":\"boolean\",\"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.\"},\"collections1BuyTogether\":{\"type\":\"array\",\"description\":\"Collections that will generate the promotion, type **Buy Together**, **More for less**, **Progressive Discount**, **Buy One Get One**.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the collection to be added to the first list of the **Buy Together** promotion.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the collection to be added to the first list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the collection to be added to the first list of the **Buy Together** promotion.\"}}}},\"collections2BuyTogether\":{\"type\":\"array\",\"deprecated\":true,\"description\":\"Collections that will generate the promotion, type **Buy Together**, **More for less**, **Progressive Discount**, **Buy One Get One**.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the collection to be added to the first list of the **Buy Together** promotion.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the collection to be added to the first list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the collection to be added to the first list of the **Buy Together** promotion.\"}}}},\"minimumQuantityBuyTogether\":{\"type\":\"integer\",\"description\":\"Minimum quantity for **Buy Together** promotion.\"},\"quantityToAffectBuyTogether\":{\"type\":\"integer\",\"description\":\"Quantity to affect **Buy Together** promotion.\"},\"enableBuyTogetherPerSku\":{\"type\":\"boolean\",\"description\":\"Enable **Buy Together** per SKU.\"},\"listSku1BuyTogether\":{\"type\":\"array\",\"description\":\"Array of objects, each containing ID and Name of an SKU to be added in the first list of the **Buy Together** promotion. Learn more about this type of promotion in the [Creating a Buy Together promotion](https://help.vtex.com/en/tutorial/buy-together--tutorials_323) documentation.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the SKU to be added to the first list of the **Buy Together** promotion. Learn more about this type of promotion in the [Creating a Buy Together promotion](https://help.vtex.com/en/tutorial/buy-together--tutorials_323) documentation.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the SKU to be added to the first list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the SKU to be added to the first list of the **Buy Together** promotion.\"}}}},\"listSku2BuyTogether\":{\"type\":\"array\",\"description\":\"Array of objects, each containing ID and Name of an SKU to be added to the second list of the **Buy Together** promotion. Learn more about this type of promotion in the [Creating a Buy Together promotion](https://help.vtex.com/en/tutorial/buy-together--tutorials_323) documentation.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the SKU to be added to the second list of the **Buy Together** promotion. Learn more about this type of promotion in the [Creating a Buy Together promotion](https://help.vtex.com/en/tutorial/buy-together--tutorials_323) documentation.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the SKU to be added to the second list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the SKU to be added to the second list of the **Buy Together** promotion.\"}}}},\"listBrand1BuyTogether\":{\"type\":\"array\",\"description\":\"Array of objects, each containing ID and Name of a brand to be added in the first list of the **Buy Together** promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the brand to be added to the first list of the **Buy Together** promotion.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the brand to be added to the first list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the brand to be added to the first list of the **Buy Together** promotion.\"}}}},\"listCategory1BuyTogether\":{\"type\":\"array\",\"description\":\"Array of objects, each containing ID and Name of a category to be added in the first list of the **Buy Together** promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the category to be added to the first list of the **Buy Together** promotion.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the category to be added to the first list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the category to be added to the first list of the **Buy Together** promotion.\"}}}},\"coupon\":{\"type\":\"array\",\"deprecated\":true,\"description\":\"List of coupons.\",\"items\":{\"type\":\"string\",\"description\":\"Coupon code.\"}},\"totalValueFloor\":{\"type\":\"number\",\"description\":\"Minimum chart value to active the campaign audience.\"},\"totalValueCeling\":{\"type\":\"number\",\"description\":\"Maximum chart value to active the campaign audience.\"},\"totalValueIncludeAllItems\":{\"type\":\"boolean\",\"deprecated\":true,\"description\":\"Total value including all items.\"},\"totalValueMode\":{\"type\":\"string\",\"description\":\"Total chart value to active the campaign audience.\"},\"collections\":{\"type\":\"array\",\"description\":\"Object composed by the collections that will activate or deactivate the campaign audience.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the collection.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Collection ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Collection Name.\"}}}},\"collectionsIsInclusive\":{\"type\":\"boolean\",\"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.\"},\"restrictionsBins\":{\"type\":\"array\",\"description\":\"The discount will be granted if the card's BIN is given.\",\"items\":{\"type\":\"string\",\"description\":\"Card's BIN.\"}},\"cardIssuers\":{\"type\":\"array\",\"deprecated\":true,\"description\":\"List of card issuers.\",\"items\":{\"type\":\"string\",\"description\":\"Card issuer.\"}},\"totalValuePurchase\":{\"type\":\"number\",\"description\":\"Total value a client must have in past orders to active the campaign audience.\"},\"slasIds\":{\"type\":\"array\",\"description\":\"The discount will be granted if the shipping method is the same as the one given.\",\"items\":{\"type\":\"string\",\"description\":\"Shipping method.\"}},\"isSlaSelected\":{\"type\":\"boolean\",\"description\":\"Applies selected discount only when one of the defined shipping method is selected by the customer.\"},\"isFirstBuy\":{\"type\":\"boolean\",\"description\":\"Applies the discount only if it's a first buy.\"},\"firstBuyIsProfileOptimistic\":{\"type\":\"boolean\",\"description\":\"Applies the discount even if the user is not logged.\"},\"compareListPriceAndPrice\":{\"type\":\"boolean\",\"description\":\"If the **List Price** and **Price** are the same.\"},\"isDifferentListPriceAndPrice\":{\"type\":\"boolean\",\"description\":\"Applies the campaign audience only if the list price and price is different.\"},\"zipCodeRanges\":{\"type\":\"array\",\"description\":\"Range of the zip code that applies the promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the Zip Code\",\"properties\":{\"zipCodeFrom\":{\"type\":\"string\",\"description\":\"Initial Zip Code.\"},\"zipCodeTo\":{\"type\":\"string\",\"description\":\"Final Zip Code.\"},\"inclusive\":{\"type\":\"boolean\",\"description\":\"Defines if the zip code range is included in the promotion.\"}}}},\"itemMaxPrice\":{\"type\":\"number\",\"description\":\"Maximum price of the item.\"},\"itemMinPrice\":{\"type\":\"number\",\"description\":\"Minimum price of the item.\"},\"installment\":{\"type\":\"integer\",\"deprecated\":true,\"description\":\"Installment.\"},\"isMinMaxInstallments\":{\"type\":\"boolean\",\"description\":\"Set if the campaign audience will be applied considering a minimum and maximum values for installments.\"},\"minInstallment\":{\"type\":\"integer\",\"description\":\"Minimum value for installment.\"},\"maxInstallment\":{\"type\":\"integer\",\"description\":\"Maximum value for installment.\"},\"merchants\":{\"type\":\"array\",\"deprecated\":true,\"description\":\"List of merchants.\",\"items\":{\"type\":\"string\",\"description\":\"Merchant.\"}},\"clusterExpressions\":{\"type\":\"array\",\"description\":\"Criteria to select a customer cluster. Each item in this array should follow the format of an equality function (`{propertyname}={value}`) or the format of a contains function (`{propertyname} contains {value}`). In both options, `{propertyname}` must be replaced with the name of the field in the data entity, and `{value}` must be replaced with the value determined in Master Data. Find more information about these criteria in [Filling in the Customer cluster field](https://help.vtex.com/tutorial/creating-promotion-for-a-customer-cluster--tutorials_342#filling-in-the-customer-cluster-field).\",\"items\":{\"type\":\"string\",\"description\":\"Cluster expression.\"}},\"clusterOperator\":{\"type\":\"string\",\"deprecated\":true,\"description\":\"Cluster operator.\"},\"paymentsRules\":{\"type\":\"array\",\"deprecated\":true,\"description\":\"List of payment rules.\",\"items\":{\"type\":\"string\",\"description\":\"Payment rule.\"}},\"giftListTypes\":{\"type\":\"array\",\"description\":\"Gifts List Type.\",\"items\":{\"type\":\"string\",\"description\":\"Gift List Type.\"}},\"productsSpecifications\":{\"type\":\"array\",\"deprecated\":true,\"description\":\"List of product specifications.\",\"items\":{\"type\":\"string\",\"description\":\"Product specification.\"}},\"affiliates\":{\"type\":\"array\",\"description\":\"Marketplace order identifier. The discount will apply to selected affiliates.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the affiliate.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Affiliate ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Affiliate Name.\"}}}},\"maxUsage\":{\"type\":\"integer\",\"description\":\"Defines how many times the campaign audience can be used.\"},\"maxUsagePerClient\":{\"type\":\"integer\",\"description\":\"Defines if the campaign audience can be used multiple times per client.\"},\"shouldDistributeDiscountAmongMatchedItems\":{\"type\":\"boolean\",\"description\":\"Should distribute discount among matched items.\"},\"multipleUsePerClient\":{\"type\":\"boolean\",\"description\":\"Defines if the campaign audience can be used multiple times per client.\"},\"useNewProgressiveAlgorithm\":{\"type\":\"boolean\",\"description\":\"Use new progressive algorithm.\"},\"percentualDiscountValueList\":{\"type\":\"array\",\"description\":\"Percentual discount value list.\",\"items\":{\"type\":\"number\",\"description\":\"Percentual discount value.\"}}}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[POST]::/api/rnb/pvt/campaignConfiguration - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"type\":\"object\",\"properties\":{\"beginDateUtc\":{\"type\":\"string\",\"description\":\"Start date of the campaign audience in UTC format.\"},\"endDateUtc\":{\"type\":\"string\",\"description\":\"End date of the campaign audience in UTC format.\"},\"id\":{\"type\":\"string\",\"description\":\"Campaign audience ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Campaign audience name.\"},\"isActive\":{\"type\":\"boolean\",\"description\":\"Defines if the campaign audience is active (`true`) or not (`false`).\"},\"isAndOperator\":{\"type\":\"boolean\",\"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.\"},\"isArchived\":{\"type\":\"boolean\",\"description\":\"Defines if the campaign audience is archived (`true`) or not (`false`).\"},\"lastModified\":{\"type\":\"object\",\"description\":\"Object with information about the most recent update of the campaign audience.\",\"properties\":{\"dateUtc\":{\"type\":\"string\",\"description\":\"Date of the most recent update in UTC format.\"},\"user\":{\"type\":\"string\",\"description\":\"Email of the user who updated the campaign audience for the latest time.\"}}},\"targetConfigurations\":{\"type\":\"array\",\"description\":\"Array that contains all target audience that the campaign audience will be valid.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information about the target audience.\",\"properties\":{\"featured\":{\"type\":\"boolean\",\"description\":\"Defines if the target audience is feature (`true`) or not (`false`).\"},\"id\":{\"type\":\"string\",\"description\":\"Target audience ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Target audience name.\"},\"daysAgoOfPurchases\":{\"type\":\"integer\",\"description\":\"Number of days that are considered to add the purchase history.\"},\"origin\":{\"type\":\"string\",\"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.\"},\"idSellerIsInclusive\":{\"type\":\"boolean\",\"description\":\"Defines if at least one of the sellers must be valid to active the campaign audience.\"},\"idsSalesChannel\":{\"type\":\"array\",\"description\":\"Array with all the trade policies that activate the campaign audience.\",\"items\":{\"type\":\"string\",\"description\":\"Trade policy ID.\"}},\"areSalesChannelIdsExclusive\":{\"type\":\"boolean\",\"description\":\"Defines if the trade policy IDs are exclusive.\"},\"marketingTags\":{\"type\":\"array\",\"description\":\"Array with all the campaign audience's marketing tags.\",\"items\":{\"type\":\"string\",\"description\":\"Campaign audience marketing tags.\"}},\"marketingTagsAreNotInclusive\":{\"type\":\"boolean\",\"description\":\"Defines if marketing tags are not inclusive.\"},\"paymentsMethods\":{\"type\":\"array\",\"description\":\"Array composed by all the Payments Methods.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the Payment Method.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Payment Method ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Payment Method Name.\"}}}},\"stores\":{\"type\":\"array\",\"description\":\"List of stores.\",\"items\":{\"type\":\"string\",\"description\":\"Store.\"}},\"campaigns\":{\"type\":\"array\",\"description\":\"Campaign Audiences that activate this promotion.\",\"items\":{\"type\":\"string\",\"description\":\"Campaign.\"}},\"storesAreInclusive\":{\"type\":\"boolean\",\"description\":\"If set to `true`, this promotion will be applied to any store present on the `stores` field. If set to `false`, stores present on that field will make this promotion not to be applied.\"},\"categories\":{\"type\":\"array\",\"description\":\"Object composed by the categories that will activate or deactivate the campaign audience.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the category.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Category ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Category Name.\"}}}},\"categoriesAreInclusive\":{\"type\":\"boolean\",\"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.\"},\"brands\":{\"type\":\"array\",\"description\":\"Object composed by the brands that will activate or deactivate the campaign audience.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the brand.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Brand ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Brand Name.\"}}}},\"brandsAreInclusive\":{\"type\":\"boolean\",\"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.\"},\"products\":{\"type\":\"array\",\"description\":\"Object composed by the products that will activate or deactivate the campaign audience.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the product.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Product ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Product Name.\"}}}},\"productsAreInclusive\":{\"type\":\"boolean\",\"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.\"},\"skus\":{\"type\":\"array\",\"description\":\"Object composed by the SKUs that will activate or deactivate the campaign audience.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the SKU.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"SKU ID.\"},\"name\":{\"type\":\"string\",\"description\":\"SKU Name.\"}}}},\"skusAreInclusive\":{\"type\":\"boolean\",\"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.\"},\"collections1BuyTogether\":{\"type\":\"array\",\"description\":\"Collections that will generate the promotion, type **Buy Together**, **More for less**, **Progressive Discount**, **Buy One Get One**.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the collection to be added to the first list of the **Buy Together** promotion.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the collection to be added to the first list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the collection to be added to the first list of the **Buy Together** promotion.\"}}}},\"collections2BuyTogether\":{\"type\":\"array\",\"description\":\"Collections that will generate the promotion, type **Buy Together**, **More for less**, **Progressive Discount**, **Buy One Get One**.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the collection to be added to the first list of the **Buy Together** promotion.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the collection to be added to the first list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the collection to be added to the first list of the **Buy Together** promotion.\"}}}},\"minimumQuantityBuyTogether\":{\"type\":\"integer\",\"description\":\"Minimum quantity for **Buy Together** promotion.\"},\"quantityToAffectBuyTogether\":{\"type\":\"integer\",\"description\":\"Quantity to affect **Buy Together** promotion.\"},\"enableBuyTogetherPerSku\":{\"type\":\"boolean\",\"description\":\"Enable **Buy Together** per SKU.\"},\"listSku1BuyTogether\":{\"type\":\"array\",\"description\":\"Array of objects, each containing ID and Name of an SKU to be added in the first list of the **Buy Together** promotion. Learn more about this type of promotion in the [Creating a Buy Together promotion](https://help.vtex.com/en/tutorial/buy-together--tutorials_323) documentation.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the SKU to be added to the first list of the **Buy Together** promotion. Learn more about this type of promotion in the [Creating a Buy Together promotion](https://help.vtex.com/en/tutorial/buy-together--tutorials_323) documentation.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the SKU to be added to the first list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the SKU to be added to the first list of the **Buy Together** promotion.\"}}}},\"listSku2BuyTogether\":{\"type\":\"array\",\"description\":\"Array of objects, each containing ID and Name of an SKU to be added to the second list of the **Buy Together** promotion. Learn more about this type of promotion in the [Creating a Buy Together promotion](https://help.vtex.com/en/tutorial/buy-together--tutorials_323) documentation.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the SKU to be added to the second list of the **Buy Together** promotion. Learn more about this type of promotion in the [Creating a Buy Together promotion](https://help.vtex.com/en/tutorial/buy-together--tutorials_323) documentation.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the SKU to be added to the second list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the SKU to be added to the second list of the **Buy Together** promotion.\"}}}},\"listBrand1BuyTogether\":{\"type\":\"array\",\"description\":\"Array of objects, each containing ID and Name of a brand to be added in the first list of the **Buy Together** promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the brand to be added to the first list of the **Buy Together** promotion.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the brand to be added to the first list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the brand to be added to the first list of the **Buy Together** promotion.\"}}}},\"listCategory1BuyTogether\":{\"type\":\"array\",\"description\":\"Array of objects, each containing ID and Name of a category to be added in the first list of the **Buy Together** promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing the ID and Name of the category to be added to the first list of the **Buy Together** promotion.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"ID of the category to be added to the first list of the **Buy Together** promotion.\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the category to be added to the first list of the **Buy Together** promotion.\"}}}},\"coupon\":{\"type\":\"array\",\"description\":\"List of coupons.\",\"items\":{\"type\":\"string\",\"description\":\"Coupon code.\"}},\"totalValueFloor\":{\"type\":\"number\",\"description\":\"Minimum chart value to active the campaign audience.\"},\"totalValueCeling\":{\"type\":\"number\",\"description\":\"Maximum chart value to active the campaign audience.\"},\"totalValueIncludeAllItems\":{\"type\":\"boolean\",\"description\":\"Total value including all items.\"},\"totalValueMode\":{\"type\":\"string\",\"description\":\"Total chart value to active the campaign audience.\"},\"collections\":{\"type\":\"array\",\"description\":\"Object composed by the collections that will activate or deactivate the campaign audience.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the collection.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Collection ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Collection Name.\"}}}},\"collectionsIsInclusive\":{\"type\":\"boolean\",\"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.\"},\"restrictionsBins\":{\"type\":\"array\",\"description\":\"The discount will be granted if the card's BIN is given.\",\"items\":{\"type\":\"string\",\"description\":\"Card's BIN.\"}},\"cardIssuers\":{\"type\":\"array\",\"description\":\"List of card issuers.\",\"items\":{\"type\":\"string\",\"description\":\"Card issuer.\"}},\"totalValuePurchase\":{\"type\":\"number\",\"description\":\"Total value a client must have in past orders to active the campaign audience.\"},\"slasIds\":{\"type\":\"array\",\"description\":\"The discount will be granted if the shipping method is the same as the one given.\",\"items\":{\"type\":\"string\",\"description\":\"Shipping method.\"}},\"isSlaSelected\":{\"type\":\"boolean\",\"description\":\"Applies selected discount only when one of the defined shipping method is selected by the customer.\"},\"isFirstBuy\":{\"type\":\"boolean\",\"description\":\"Applies the discount only if it's a first buy.\"},\"firstBuyIsProfileOptimistic\":{\"type\":\"boolean\",\"description\":\"Applies the discount even if the user is not logged.\"},\"compareListPriceAndPrice\":{\"type\":\"boolean\",\"description\":\"If the **List Price** and **Price** are the same.\"},\"isDifferentListPriceAndPrice\":{\"type\":\"boolean\",\"description\":\"Applies the campaign audience only if the list price and price is different.\"},\"zipCodeRanges\":{\"type\":\"array\",\"description\":\"Range of the zip code that applies the promotion.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the Zip Code\",\"properties\":{\"zipCodeFrom\":{\"type\":\"string\",\"description\":\"Initial Zip Code.\"},\"zipCodeTo\":{\"type\":\"string\",\"description\":\"Final Zip Code.\"},\"inclusive\":{\"type\":\"boolean\",\"description\":\"Defines if the zip code range is included in the promotion.\"}}}},\"itemMaxPrice\":{\"type\":\"number\",\"description\":\"Maximum price of the item.\"},\"itemMinPrice\":{\"type\":\"number\",\"description\":\"Minimum price of the item.\"},\"installment\":{\"type\":\"integer\",\"description\":\"Installment.\"},\"isMinMaxInstallments\":{\"type\":\"boolean\",\"description\":\"Set if the campaign audience will be applied considering a minimum and maximum values for installments.\"},\"minInstallment\":{\"type\":\"integer\",\"description\":\"Minimum value for installment.\"},\"maxInstallment\":{\"type\":\"integer\",\"description\":\"Maximum value for installment.\"},\"merchants\":{\"type\":\"array\",\"description\":\"List of merchants.\",\"items\":{\"type\":\"string\",\"description\":\"Merchant.\"}},\"clusterExpressions\":{\"type\":\"array\",\"description\":\"Criteria to select a customer cluster. Each item in this array should follow the format of an equality function (`{propertyname}={value}`) or the format of a contains function (`{propertyname} contains {value}`). In both options, `{propertyname}` must be replaced with the name of the field in the data entity, and `{value}` must be replaced with the value determined in Master Data. Find more information about these criteria in [Filling in the Customer cluster field](https://help.vtex.com/tutorial/creating-promotion-for-a-customer-cluster--tutorials_342#filling-in-the-customer-cluster-field).\",\"items\":{\"type\":\"string\",\"description\":\"Cluster expression.\"}},\"clusterOperator\":{\"type\":\"string\",\"description\":\"Cluster operator.\"},\"paymentsRules\":{\"type\":\"array\",\"description\":\"List of payment rules.\",\"items\":{\"type\":\"string\",\"description\":\"Payment rule.\"}},\"giftListTypes\":{\"type\":\"array\",\"description\":\"Gifts List Type.\",\"items\":{\"type\":\"string\",\"description\":\"Gift List Type.\"}},\"productsSpecifications\":{\"type\":\"array\",\"description\":\"List of product specifications.\",\"items\":{\"type\":\"string\",\"description\":\"Product specification.\"}},\"affiliates\":{\"type\":\"array\",\"description\":\"Marketplace order identifier. The discount will apply to selected affiliates.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information of the affiliate.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Affiliate ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Affiliate Name.\"}}}},\"maxUsage\":{\"type\":\"integer\",\"description\":\"Defines how many times the campaign audience can be used.\"},\"maxUsagePerClient\":{\"type\":\"integer\",\"description\":\"Defines if the campaign audience can be used multiple times per client.\"},\"shouldDistributeDiscountAmongMatchedItems\":{\"type\":\"boolean\",\"description\":\"Should distribute discount among matched items.\"},\"multipleUsePerClient\":{\"type\":\"boolean\",\"description\":\"Defines if the campaign audience can be used multiple times per client.\"},\"useNewProgressiveAlgorithm\":{\"type\":\"boolean\",\"description\":\"Use new progressive algorithm.\"},\"percentualDiscountValueList\":{\"type\":\"array\",\"description\":\"Percentual discount value list.\",\"items\":{\"type\":\"number\",\"description\":\"Percentual discount value.\"}}}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[POST]::/api/rnb/pvt/campaignConfiguration - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -4713,7 +3865,7 @@ "event": [] }, { - "id": "77a4bf6b-da0e-4e9f-a1b8-10dbf1dfd97a", + "id": "a4d805ae-d12e-42db-9069-552f54cf6240", "name": "Notifications", "description": { "content": "", @@ -4721,7 +3873,7 @@ }, "item": [ { - "id": "33569acd-4345-4d99-b9d5-856d9a911ab6", + "id": "acb4924e-f9f7-4c90-b790-29b2bcc50408", "name": "Usage notification", "request": { "name": "Usage notification", @@ -4765,6 +3917,10 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" } ], "method": "POST", @@ -4773,6 +3929,7 @@ "raw": "{\n \"orderId\": \"1\",\n \"profileId\": \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\",\n \"accountId\": \"ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj\",\n \"calculatorIds\": [\n \"discount_basetestqa_1\"\n ],\n \"used\": true,\n \"coupon\": \"cupom\",\n \"itemsCount\": 4\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -4783,7 +3940,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "f041f641-411d-4990-99dd-7d08da7a1784", + "id": "53078bf2-a660-46ea-8c9e-a6cbc4582718", "name": "OK", "originalRequest": { "url": { @@ -4806,30 +3963,34 @@ }, "header": [ { + "disabled": false, "description": { - "content": "Added as a part of security scheme: apikey", + "content": "(Required) Type of the content being sent.", "type": "text/plain" }, - "key": "X-VTEX-API-AppKey", - "value": "" + "key": "Content-Type", + "value": "application/json" }, { "disabled": false, "description": { - "content": "(Required) Type of the content being sent.", + "content": "(Required) HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "type": "text/plain" }, + "key": "Accept", + "value": "application/json" + }, + { "key": "Content-Type", "value": "application/json" }, { - "disabled": false, "description": { - "content": "(Required) HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", + "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, - "key": "Accept", - "value": "application/json" + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "POST", @@ -4838,6 +3999,7 @@ "raw": "{\n \"orderId\": \"1\",\n \"profileId\": \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\",\n \"accountId\": \"ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj\",\n \"calculatorIds\": [\n \"discount_basetestqa_1\"\n ],\n \"used\": true,\n \"coupon\": \"cupom\",\n \"itemsCount\": 4\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -4845,13 +4007,7 @@ }, "status": "OK", "code": 200, - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "body": "", + "header": [], "cookie": [] } ], @@ -4864,7 +4020,7 @@ "event": [] }, { - "id": "647a7b81-0a88-4713-b0bd-457ab1f17147", + "id": "720a601e-b0cb-46ec-ae81-35b0711569be", "name": "Bundles", "description": { "content": "", @@ -4872,7 +4028,7 @@ }, "item": [ { - "id": "8cf4afc5-eec9-442f-a1c3-0953ce54e9cc", + "id": "5c1be2d5-1a34-4682-a84b-06174000f00b", "name": "Calculate discounts and taxes (bundles)", "request": { "name": "Calculate discounts and taxes (bundles)", @@ -4914,6 +4070,10 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" } ], "method": "POST", @@ -4922,6 +4082,7 @@ "raw": "{\n \"isShoppingCart\": true,\n \"origin\": \"Marketplace\",\n \"salesChannel\": \"1\",\n \"profileId\": \"aa\",\n \"items\": [\n {\n \"index\": 0,\n \"id\": \"160\",\n \"quantity\": 3,\n \"isGift\": false,\n \"measurementUnit\": \"un\",\n \"unitMultiplier\": 1,\n \"priceTags\": [],\n \"params\": [\n {\n \"name\": \"Seller@CatalogSystem\",\n \"value\": \"1\"\n },\n {\n \"name\": \"product@CatalogSystem\",\n \"value\": \"94\"\n }\n ],\n \"priceSheet\": [],\n \"logisticsInfos\": [],\n \"sellerId\": \"1\",\n \"productSpecifications\": []\n }\n ],\n \"params\": [\n {\n \"name\": \"product@CatalogSystem\",\n \"value\": \"2662\"\n },\n {\n \"name\": \"couponCode@Marketing\",\n \"value\": \"coupon\"\n }\n ]\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -4932,7 +4093,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "47ca0e76-bdfe-47af-bdfb-4b74eef72f21", + "id": "a04a9302-b9d1-4246-a4a5-bec8557817c3", "name": "OK", "originalRequest": { "url": { @@ -4952,14 +4113,6 @@ "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -4977,6 +4130,18 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "POST", @@ -4985,6 +4150,7 @@ "raw": "{\n \"isShoppingCart\": true,\n \"origin\": \"Marketplace\",\n \"salesChannel\": \"1\",\n \"profileId\": \"aa\",\n \"items\": [\n {\n \"index\": 0,\n \"id\": \"160\",\n \"quantity\": 3,\n \"isGift\": false,\n \"measurementUnit\": \"un\",\n \"unitMultiplier\": 1,\n \"priceTags\": [],\n \"params\": [\n {\n \"name\": \"Seller@CatalogSystem\",\n \"value\": \"1\"\n },\n {\n \"name\": \"product@CatalogSystem\",\n \"value\": \"94\"\n }\n ],\n \"priceSheet\": [],\n \"logisticsInfos\": [],\n \"sellerId\": \"1\",\n \"productSpecifications\": []\n }\n ],\n \"params\": [\n {\n \"name\": \"product@CatalogSystem\",\n \"value\": \"2662\"\n },\n {\n \"name\": \"couponCode@Marketing\",\n \"value\": \"coupon\"\n }\n ]\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -4992,13 +4158,7 @@ }, "status": "OK", "code": 200, - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "body": "", + "header": [], "cookie": [] } ], @@ -5011,7 +4171,7 @@ "event": [] }, { - "id": "bdbf52e4-131d-4a15-9231-571d4267af3f", + "id": "8e32a75e-a1fc-46a3-a817-645649c4b4a5", "name": "Prices (Legacy - v1)", "description": { "content": "", @@ -5019,7 +4179,7 @@ }, "item": [ { - "id": "8d48c850-906e-47f7-944b-16218e9bdff4", + "id": "e6353c36-9dc9-4d32-bdb0-ebf51fa93cc5", "name": "Get price by SKU ID", "request": { "name": "Get price by SKU ID", @@ -5061,7 +4221,7 @@ "type": "text/plain" }, "type": "any", - "value": "nostrud", + "value": "culpa", "key": "skuId" } ] @@ -5084,16 +4244,21 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "GET" + "method": "GET", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, - "id": "02d22465-31a9-4506-8676-140f0c4d93f9", + "id": "9fa2b747-a681-4f04-b432-4e017f74d5fa", "name": "OK", "originalRequest": { "url": { @@ -5112,33 +4277,19 @@ "br" ], "query": [ - { - "key": "an", - "value": "{{accountName}}" - } - ], - "variable": [ { "disabled": false, "description": { - "content": "(Required) SKU ID.", + "content": "(Required) VTEX account name.", "type": "text/plain" }, - "type": "any", - "value": "nostrud", - "key": "skuId" + "key": "an", + "value": "{{accountName}}" } - ] + ], + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -5160,6 +4311,14 @@ { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "GET", @@ -5183,7 +4342,7 @@ } }, { - "id": "24667fab-3358-406f-ad10-f7b75b8e1c60", + "id": "ac44fe0f-aef9-4549-8717-33ec387ab5f0", "name": "Delete price by SKU ID", "request": { "name": "Delete price by SKU ID", @@ -5225,7 +4384,7 @@ "type": "text/plain" }, "type": "any", - "value": "nostrud", + "value": "culpa", "key": "skuId" } ] @@ -5250,14 +4409,15 @@ "value": "application/json" } ], - "method": "DELETE" + "method": "DELETE", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "text" }, - "id": "3f456121-6d9a-4af0-b4d0-d5e5f77277e3", + "id": "7301a451-7773-4b66-b235-4489308db84c", "name": "OK", "originalRequest": { "url": { @@ -5276,33 +4436,19 @@ "br" ], "query": [ - { - "key": "an", - "value": "{{accountName}}" - } - ], - "variable": [ { "disabled": false, "description": { - "content": "(Required) SKU ID.", + "content": "(Required) VTEX account name.", "type": "text/plain" }, - "type": "any", - "value": "nostrud", - "key": "skuId" + "key": "an", + "value": "{{accountName}}" } - ] + ], + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -5320,6 +4466,14 @@ }, "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "DELETE", @@ -5327,13 +4481,7 @@ }, "status": "OK", "code": 200, - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "body": "", + "header": [], "cookie": [] } ], @@ -5343,7 +4491,7 @@ } }, { - "id": "0448fdb3-5d9c-4be5-a70a-73048609eb68", + "id": "a2faaf46-558d-4f73-81b0-61e873e278f0", "name": "Get all paged prices", "request": { "name": "Get all paged prices", @@ -5387,7 +4535,7 @@ "type": "text/plain" }, "type": "any", - "value": "nostrud", + "value": "culpa", "key": "page" }, { @@ -5397,7 +4545,7 @@ "type": "text/plain" }, "type": "any", - "value": "nostrud", + "value": "culpa", "key": "pageSize" } ] @@ -5422,14 +4570,15 @@ "value": "application/json" } ], - "method": "GET" + "method": "GET", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "text" }, - "id": "38967076-0a43-41f9-9bd3-eea0c1d6528f", + "id": "4d710127-d35d-465b-8dd4-663e864718ba", "name": "OK", "originalRequest": { "url": { @@ -5450,43 +4599,19 @@ "br" ], "query": [ - { - "key": "an", - "value": "{{accountName}}" - } - ], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) Page number for pagination.", - "type": "text/plain" - }, - "type": "any", - "value": "nostrud", - "key": "page" - }, { "disabled": false, "description": { - "content": "(Required) Size of each page for pagination.", + "content": "(Required) VTEX account name.", "type": "text/plain" }, - "type": "any", - "value": "nostrud", - "key": "pageSize" + "key": "an", + "value": "{{accountName}}" } - ] + ], + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -5504,6 +4629,14 @@ }, "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "GET", @@ -5511,13 +4644,7 @@ }, "status": "OK", "code": 200, - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "body": "", + "header": [], "cookie": [] } ], @@ -5527,7 +4654,7 @@ } }, { - "id": "bbd3f3cc-1673-43dc-8609-6565b611bba9", + "id": "1b5dee07-4b13-46c4-819f-4ce450d70e51", "name": "Get price by context", "request": { "name": "Get price by context", @@ -5581,6 +4708,10 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" } ], "method": "POST", @@ -5589,6 +4720,7 @@ "raw": "{\n \"id\": 6324,\n \"itemId\": 2390148,\n \"salesChannel\": 1,\n \"sellerId\": \"1\",\n \"validFrom\": \"2000-01-01T00:00:00\",\n \"validTo\": \"2000-02-01T00:00:00\"\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -5599,7 +4731,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "11f9869a-7f4e-4e3b-acc2-c6741249fda2", + "id": "43754dce-c551-4296-ac76-370eaa0f3593", "name": "OK", "originalRequest": { "url": { @@ -5619,6 +4751,11 @@ ], "query": [ { + "disabled": false, + "description": { + "content": "(Required) VTEX account name.", + "type": "text/plain" + }, "key": "an", "value": "{{accountName}}" } @@ -5626,14 +4763,6 @@ "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -5651,6 +4780,18 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "POST", @@ -5659,6 +4800,7 @@ "raw": "{\n \"id\": 6324,\n \"itemId\": 2390148,\n \"salesChannel\": 1,\n \"sellerId\": \"1\",\n \"validFrom\": \"2000-01-01T00:00:00\",\n \"validTo\": \"2000-02-01T00:00:00\"\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -5666,13 +4808,7 @@ }, "status": "OK", "code": 200, - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "body": "", + "header": [], "cookie": [] } ], @@ -5682,7 +4818,7 @@ } }, { - "id": "43aba485-1229-412d-a662-15db6ee2da46", + "id": "d17765bf-4768-42c5-88f0-673ca6176d35", "name": "Get price by SKU ID and trade policy", "request": { "name": "Get price by SKU ID and trade policy", @@ -5725,7 +4861,7 @@ "type": "text/plain" }, "type": "any", - "value": "nostrud", + "value": "culpa", "key": "skuId" }, { @@ -5735,7 +4871,7 @@ "type": "text/plain" }, "type": "any", - "value": "nostrud", + "value": "culpa", "key": "tradePolicy" } ] @@ -5758,16 +4894,21 @@ }, "key": "Content-Type", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "GET" + "method": "GET", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, - "id": "fb6a5a0b-0bf3-4d57-bff0-bf2330f5ffa0", + "id": "29c54e0f-1cb2-443b-a013-d1afafee4703", "name": "OK", "originalRequest": { "url": { @@ -5787,43 +4928,19 @@ "br" ], "query": [ - { - "key": "an", - "value": "{{accountName}}" - } - ], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) SKU ID.", - "type": "text/plain" - }, - "type": "any", - "value": "nostrud", - "key": "skuId" - }, { "disabled": false, "description": { - "content": "(Required) Trade policy name.", + "content": "(Required) Account name.", "type": "text/plain" }, - "type": "any", - "value": "nostrud", - "key": "tradePolicy" + "key": "an", + "value": "{{accountName}}" } - ] + ], + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -5845,6 +4962,14 @@ { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "GET", @@ -5868,7 +4993,7 @@ } }, { - "id": "f085d87b-7922-41cf-874c-169d0ab84ba4", + "id": "ac809d9f-b375-4a70-9ea1-b7cedb41a838", "name": "Save price", "request": { "name": "Save price", @@ -5921,6 +5046,10 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" } ], "method": "POST", @@ -5929,6 +5058,7 @@ "raw": "[\n {\n \"itemId\": 2390148,\n \"salesChannel\": 1,\n \"sellerId\": 1,\n \"price\": 1,\n \"listPrice\": 1,\n \"validFrom\": \"2016-01-01T02:00:00Z\",\n \"validTo\": \"2017-01-01T02:00:00Z\"\n }\n]", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -5939,7 +5069,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "2664a15e-6225-4a41-a4ea-ed9ae12b8619", + "id": "9a2a565c-a278-4d8f-a1db-c20a4c69c733", "name": "OK", "originalRequest": { "url": { @@ -5958,6 +5088,11 @@ ], "query": [ { + "disabled": false, + "description": { + "content": "(Required) VTEX account name.", + "type": "text/plain" + }, "key": "an", "value": "{{accountName}}" } @@ -5965,14 +5100,6 @@ "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -5990,6 +5117,18 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "POST", @@ -5998,6 +5137,7 @@ "raw": "[\n {\n \"itemId\": 2390148,\n \"salesChannel\": 1,\n \"sellerId\": 1,\n \"price\": 1,\n \"listPrice\": 1,\n \"validFrom\": \"2016-01-01T02:00:00Z\",\n \"validTo\": \"2017-01-01T02:00:00Z\"\n }\n]", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -6005,13 +5145,7 @@ }, "status": "OK", "code": 200, - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "body": "", + "header": [], "cookie": [] } ], @@ -6047,40 +5181,23 @@ "event": [], "variable": [ { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, "type": "any", "value": "apiexamples", "key": "accountName" }, { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, "type": "any", "value": "vtexcommercestable", "key": "environment" }, { - "type": "string", + "type": "any", "value": "https://{{accountName}}.{{environment}}.com.br", "key": "baseUrl" - }, - { - "description": { - "content": "", - "type": "text/plain" - }, - "type": "any", - "value": "vtexcommercestable", - "key": "environment" } ], "info": { - "_postman_id": "0773edd2-3716-4595-9075-7a1efb8e0bd1", + "_postman_id": "1986f854-2a78-401b-989a-49d587240f5f", "name": "Promotions & Taxes API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { From c16f331ac679b36c18ce49b109f3cf911045f2e0 Mon Sep 17 00:00:00 2001 From: Geise Costa <136460310+geisecosta@users.noreply.github.com> Date: Fri, 6 Sep 2024 13:08:39 -0300 Subject: [PATCH 3/6] Update VTEX - Promotions & Taxes API.json MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Júlia Rabello <77292838+julia-rabello@users.noreply.github.com> --- VTEX - Promotions & Taxes API.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/VTEX - Promotions & Taxes API.json b/VTEX - Promotions & Taxes API.json index e158a78d4..3bdc7b5ac 100644 --- a/VTEX - Promotions & Taxes API.json +++ b/VTEX - Promotions & Taxes API.json @@ -767,7 +767,7 @@ { "name": "quantity", "in": "query", - "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.", + "description": "Number of coupons to create, which can be from `1` to `1000`. For a single coupon (`1`), the code will be the `couponCode` value. For multiple coupons (more than `1`), codes will be the `couponCode` value with a random suffix.", "required": true, "style": "form", "explode": true, From cf52409a0725aaa818b8b19c995821a9992ee259 Mon Sep 17 00:00:00 2001 From: Geise Costa <136460310+geisecosta@users.noreply.github.com> Date: Fri, 6 Sep 2024 13:08:46 -0300 Subject: [PATCH 4/6] Update VTEX - Promotions & Taxes API.json MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Júlia Rabello <77292838+julia-rabello@users.noreply.github.com> --- VTEX - Promotions & Taxes API.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/VTEX - Promotions & Taxes API.json b/VTEX - Promotions & Taxes API.json index 3bdc7b5ac..0bb4ad853 100644 --- a/VTEX - Promotions & Taxes API.json +++ b/VTEX - Promotions & Taxes API.json @@ -807,7 +807,7 @@ }, "maxItemsPerClient": { "type": "integer", - "description": "Maximum items per client that the coupon can be applied.", + "description": "Maximum number of items a coupon can be applied to per client.", "example": 1 }, "expirationIntervalPerUse": { From 349b122aecd69c99251e4f91cb76f517e76bdba6 Mon Sep 17 00:00:00 2001 From: Geise Costa Date: Fri, 20 Sep 2024 18:41:39 -0300 Subject: [PATCH 5/6] Fixed spectral --- VTEX - Promotions & Taxes API.json | 302 +++++++++++++++-------------- 1 file changed, 153 insertions(+), 149 deletions(-) diff --git a/VTEX - Promotions & Taxes API.json b/VTEX - Promotions & Taxes API.json index 0bb4ad853..f0c12b368 100644 --- a/VTEX - Promotions & Taxes API.json +++ b/VTEX - Promotions & Taxes API.json @@ -6191,7 +6191,7 @@ "tags": [ "Bundles" ], - "summary": "Calculate discounts and taxes (bundles)", + "summary": "Calculate discounts and taxes bundles", "description": "Calculate discounts and taxes\r\n\r\n## Permissions\r\n\r\nThis endpoint is usually used internally for backend services and does not require user [permissions]((https:\/\/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3)).", "operationId": "Calculatediscountsandtaxes(Bundles)", "parameters": [ @@ -9461,160 +9461,164 @@ "components": { "schemas": { "GetPromotions": { + "type": "array", + "description": "Array with information about a promotion.", + "items": { "type": "object", "description": "Object with information about a promotion.", - "properties": { - "idCalculatorConfiguration": { - "type": "string", - "description": "Promotion ID." - }, - "lastModifiedUtc": { - "type": "string", - "description": "Date and time when the promotion was last modified (UTC)." - }, - "name": { - "type": "string", - "description": "Promotion Name." - }, - "beginDate": { - "type": "string", - "description": "Promotion Begin Date (UTC)." - }, - "endDate": { - "type": "string", - "description": "Promotion End Date (UTC)." - }, - "isActive": { - "type": "boolean", - "description": "If set as `true` the promotion is activated. If set as `false` the promotion is deactivated." - }, - "description": { - "type": "string", - "description": "Promotion internal description." - }, - "type": { - "description": "Defines the type of promotion.", - "type": "string" - }, - "utmSource": { - "type": "string", - "description": "utmSource code." - }, - "utmCampain": { - "type": "string", - "description": "utmCampaign code." - }, - "utmiCampaign": { - "type": "string", - "description": "utmiCampaign code." - }, - "status": { - "type": "string", - "description": "Status of the promotion." - }, - "percentualTax": { - "type": "number", - "description": "Percentual tax applied." - }, - "isArchived": { - "type": "boolean", - "description": "If set as `true` the Promotion is archived. If set as `false` the Promotion is not archived." - }, - "hasMaxPricePerItem": { - "description": "Defines if there is a maximum price per item.", - "type": "boolean" - }, - "isTax": { - "description": "Defines if it is a tax.", - "type": "boolean" - }, - "campaigns": { - "description": "Campaign Audiences that activate this promotion.", - "type": "array", - "items": { + "properties": { + "idCalculatorConfiguration": { "type": "string", - "description": "Campaign Audience." - } - }, - "activateGiftsMultiplier": { - "description": "If set as `true`, it activates gifts Multiplier.", - "type": "boolean" - }, - "scope": { - "description": "Scope of the promotion.", - "type": "object", - "properties": { - "allCatalog": { - "description": "Determines if the promotion applies to all products in the Catalog (`true`) or not (`false`).", - "type": "boolean" - }, - "skus": { - "description": "Quantity of SKUs which activate or deactivate the promotion.", - "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.", - "type": "boolean" - }, - "products": { - "description": "Quantity of products which activate or deactivate the promotion.", - "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.", - "type": "boolean" - }, - "collections": { - "description": "Quantity of collections which activate or deactivate the promotion.", - "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.", - "type": "boolean" - }, - "categories": { - "description": "Quantity of categories which activate or deactivate the promotion.", - "type": "number" - }, - "categoriesAreInclusive": { - "type": "boolean", - "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." - }, - "brands": { - "description": "Quantity of brands which activate or deactivate the promotion.", - "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.", - "type": "boolean" - }, - "sellers": { - "description": "Quantity of sellers which activate or deactivate the promotion.", - "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.", - "type": "boolean" - } - } - }, - "maxUsage": { - "type": "number", - "description": "Defines how many times the promotion can be used." - }, - "idsSalesChannel": { - "type": "array", - "description": "List of Trade Policies that activate this promotion.", - "items": { + "description": "Promotion ID." + }, + "lastModifiedUtc": { "type": "string", - "description": "Trade policy ID." + "description": "Date and time when the promotion was last modified (UTC)." + }, + "name": { + "type": "string", + "description": "Promotion Name." + }, + "beginDate": { + "type": "string", + "description": "Promotion Begin Date (UTC)." + }, + "endDate": { + "type": "string", + "description": "Promotion End Date (UTC)." + }, + "isActive": { + "type": "boolean", + "description": "If set as `true` the promotion is activated. If set as `false` the promotion is deactivated." + }, + "description": { + "type": "string", + "description": "Promotion internal description." + }, + "type": { + "description": "Defines the type of promotion.", + "type": "string" + }, + "utmSource": { + "type": "string", + "description": "utmSource code." + }, + "utmCampain": { + "type": "string", + "description": "utmCampaign code." + }, + "utmiCampaign": { + "type": "string", + "description": "utmiCampaign code." + }, + "status": { + "type": "string", + "description": "Status of the promotion." + }, + "percentualTax": { + "type": "number", + "description": "Percentual tax applied." + }, + "isArchived": { + "type": "boolean", + "description": "If set as `true` the Promotion is archived. If set as `false` the Promotion is not archived." + }, + "hasMaxPricePerItem": { + "description": "Defines if there is a maximum price per item.", + "type": "boolean" + }, + "isTax": { + "description": "Defines if it is a tax.", + "type": "boolean" + }, + "campaigns": { + "description": "Campaign Audiences that activate this promotion.", + "type": "array", + "items": { + "type": "string", + "description": "Campaign Audience." + } + }, + "activateGiftsMultiplier": { + "description": "If set as `true`, it activates gifts Multiplier.", + "type": "boolean" + }, + "scope": { + "description": "Scope of the promotion.", + "type": "object", + "properties": { + "allCatalog": { + "description": "Determines if the promotion applies to all products in the Catalog (`true`) or not (`false`).", + "type": "boolean" + }, + "skus": { + "description": "Quantity of SKUs which activate or deactivate the promotion.", + "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.", + "type": "boolean" + }, + "products": { + "description": "Quantity of products which activate or deactivate the promotion.", + "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.", + "type": "boolean" + }, + "collections": { + "description": "Quantity of collections which activate or deactivate the promotion.", + "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.", + "type": "boolean" + }, + "categories": { + "description": "Quantity of categories which activate or deactivate the promotion.", + "type": "number" + }, + "categoriesAreInclusive": { + "type": "boolean", + "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." + }, + "brands": { + "description": "Quantity of brands which activate or deactivate the promotion.", + "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.", + "type": "boolean" + }, + "sellers": { + "description": "Quantity of sellers which activate or deactivate the promotion.", + "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.", + "type": "boolean" + } + } + }, + "maxUsage": { + "type": "number", + "description": "Defines how many times the promotion can be used." + }, + "idsSalesChannel": { + "type": "array", + "description": "List of Trade Policies that activate this promotion.", + "items": { + "type": "string", + "description": "Trade policy ID." + } + }, + "areSalesChannelIdsExclusive": { + "type": "boolean", + "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." } - }, - "areSalesChannelIdsExclusive": { - "type": "boolean", - "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." } - } + } }, "GetTaxes": { "type": "array", From 764174a40fdb73c3724be48f122c9e6e06c6ca76 Mon Sep 17 00:00:00 2001 From: julia-rabello <77292838+julia-rabello@users.noreply.github.com> Date: Wed, 25 Sep 2024 14:57:01 -0300 Subject: [PATCH 6/6] format document --- VTEX - Promotions & Taxes API.json | 300 ++++++++++++++--------------- 1 file changed, 150 insertions(+), 150 deletions(-) diff --git a/VTEX - Promotions & Taxes API.json b/VTEX - Promotions & Taxes API.json index f0c12b368..3627ce93b 100644 --- a/VTEX - Promotions & Taxes API.json +++ b/VTEX - Promotions & Taxes API.json @@ -5556,9 +5556,9 @@ } ], "schema": { - "type" : "array", + "type": "array", "description": "List of prices.", - "items":{ + "items": { "description": "Object containing information about prices.", "type": "object", "properties": { @@ -9466,158 +9466,158 @@ "items": { "type": "object", "description": "Object with information about a promotion.", - "properties": { - "idCalculatorConfiguration": { - "type": "string", - "description": "Promotion ID." - }, - "lastModifiedUtc": { - "type": "string", - "description": "Date and time when the promotion was last modified (UTC)." - }, - "name": { - "type": "string", - "description": "Promotion Name." - }, - "beginDate": { - "type": "string", - "description": "Promotion Begin Date (UTC)." - }, - "endDate": { - "type": "string", - "description": "Promotion End Date (UTC)." - }, - "isActive": { - "type": "boolean", - "description": "If set as `true` the promotion is activated. If set as `false` the promotion is deactivated." - }, - "description": { - "type": "string", - "description": "Promotion internal description." - }, - "type": { - "description": "Defines the type of promotion.", - "type": "string" - }, - "utmSource": { - "type": "string", - "description": "utmSource code." - }, - "utmCampain": { - "type": "string", - "description": "utmCampaign code." - }, - "utmiCampaign": { - "type": "string", - "description": "utmiCampaign code." - }, - "status": { + "properties": { + "idCalculatorConfiguration": { + "type": "string", + "description": "Promotion ID." + }, + "lastModifiedUtc": { + "type": "string", + "description": "Date and time when the promotion was last modified (UTC)." + }, + "name": { + "type": "string", + "description": "Promotion Name." + }, + "beginDate": { + "type": "string", + "description": "Promotion Begin Date (UTC)." + }, + "endDate": { + "type": "string", + "description": "Promotion End Date (UTC)." + }, + "isActive": { + "type": "boolean", + "description": "If set as `true` the promotion is activated. If set as `false` the promotion is deactivated." + }, + "description": { + "type": "string", + "description": "Promotion internal description." + }, + "type": { + "description": "Defines the type of promotion.", + "type": "string" + }, + "utmSource": { + "type": "string", + "description": "utmSource code." + }, + "utmCampain": { + "type": "string", + "description": "utmCampaign code." + }, + "utmiCampaign": { + "type": "string", + "description": "utmiCampaign code." + }, + "status": { + "type": "string", + "description": "Status of the promotion." + }, + "percentualTax": { + "type": "number", + "description": "Percentual tax applied." + }, + "isArchived": { + "type": "boolean", + "description": "If set as `true` the Promotion is archived. If set as `false` the Promotion is not archived." + }, + "hasMaxPricePerItem": { + "description": "Defines if there is a maximum price per item.", + "type": "boolean" + }, + "isTax": { + "description": "Defines if it is a tax.", + "type": "boolean" + }, + "campaigns": { + "description": "Campaign Audiences that activate this promotion.", + "type": "array", + "items": { "type": "string", - "description": "Status of the promotion." - }, - "percentualTax": { - "type": "number", - "description": "Percentual tax applied." - }, - "isArchived": { - "type": "boolean", - "description": "If set as `true` the Promotion is archived. If set as `false` the Promotion is not archived." - }, - "hasMaxPricePerItem": { - "description": "Defines if there is a maximum price per item.", - "type": "boolean" - }, - "isTax": { - "description": "Defines if it is a tax.", - "type": "boolean" - }, - "campaigns": { - "description": "Campaign Audiences that activate this promotion.", - "type": "array", - "items": { - "type": "string", - "description": "Campaign Audience." - } - }, - "activateGiftsMultiplier": { - "description": "If set as `true`, it activates gifts Multiplier.", - "type": "boolean" - }, - "scope": { - "description": "Scope of the promotion.", - "type": "object", - "properties": { - "allCatalog": { - "description": "Determines if the promotion applies to all products in the Catalog (`true`) or not (`false`).", - "type": "boolean" - }, - "skus": { - "description": "Quantity of SKUs which activate or deactivate the promotion.", - "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.", - "type": "boolean" - }, - "products": { - "description": "Quantity of products which activate or deactivate the promotion.", - "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.", - "type": "boolean" - }, - "collections": { - "description": "Quantity of collections which activate or deactivate the promotion.", - "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.", - "type": "boolean" - }, - "categories": { - "description": "Quantity of categories which activate or deactivate the promotion.", - "type": "number" - }, - "categoriesAreInclusive": { - "type": "boolean", - "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." - }, - "brands": { - "description": "Quantity of brands which activate or deactivate the promotion.", - "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.", - "type": "boolean" - }, - "sellers": { - "description": "Quantity of sellers which activate or deactivate the promotion.", - "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.", - "type": "boolean" - } - } - }, - "maxUsage": { - "type": "number", - "description": "Defines how many times the promotion can be used." - }, - "idsSalesChannel": { - "type": "array", - "description": "List of Trade Policies that activate this promotion.", - "items": { - "type": "string", - "description": "Trade policy ID." + "description": "Campaign Audience." + } + }, + "activateGiftsMultiplier": { + "description": "If set as `true`, it activates gifts Multiplier.", + "type": "boolean" + }, + "scope": { + "description": "Scope of the promotion.", + "type": "object", + "properties": { + "allCatalog": { + "description": "Determines if the promotion applies to all products in the Catalog (`true`) or not (`false`).", + "type": "boolean" + }, + "skus": { + "description": "Quantity of SKUs which activate or deactivate the promotion.", + "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.", + "type": "boolean" + }, + "products": { + "description": "Quantity of products which activate or deactivate the promotion.", + "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.", + "type": "boolean" + }, + "collections": { + "description": "Quantity of collections which activate or deactivate the promotion.", + "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.", + "type": "boolean" + }, + "categories": { + "description": "Quantity of categories which activate or deactivate the promotion.", + "type": "number" + }, + "categoriesAreInclusive": { + "type": "boolean", + "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." + }, + "brands": { + "description": "Quantity of brands which activate or deactivate the promotion.", + "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.", + "type": "boolean" + }, + "sellers": { + "description": "Quantity of sellers which activate or deactivate the promotion.", + "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.", + "type": "boolean" } - }, - "areSalesChannelIdsExclusive": { - "type": "boolean", - "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." } + }, + "maxUsage": { + "type": "number", + "description": "Defines how many times the promotion can be used." + }, + "idsSalesChannel": { + "type": "array", + "description": "List of Trade Policies that activate this promotion.", + "items": { + "type": "string", + "description": "Trade policy ID." + } + }, + "areSalesChannelIdsExclusive": { + "type": "boolean", + "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." } + } } }, "GetTaxes": {