diff --git a/PostmanCollections/VTEX - Promotions & Taxes API.json b/PostmanCollections/VTEX - Promotions & Taxes API.json index 8bc3b176d..55eaaa798 100644 --- a/PostmanCollections/VTEX - Promotions & Taxes API.json +++ b/PostmanCollections/VTEX - Promotions & Taxes API.json @@ -1,10 +1,10 @@ { "_": { - "postman_id": "22e4b26b-1bcc-4b19-abe4-dc0a559c53ea" + "postman_id": "5f6ec77e-e33b-4395-9ce5-499f750c7d4d" }, "item": [ { - "id": "ca187621-444e-4cf0-b4bc-cb4115f32f59", + "id": "124105dc-da2c-4007-ade7-3bde46ca143f", "name": "Promotions and Taxes", "description": { "content": "", @@ -12,7 +12,7 @@ }, "item": [ { - "id": "5ff91af2-2f00-4ddb-ba80-6d63524529ee", + "id": "3a51a440-5dca-4af6-9675-da8c66dd5c0b", "name": "Get All Promotions", "request": { "name": "Get All Promotions", @@ -35,7 +35,7 @@ "variable": [ { "description": { - "content": "Name of the VTEX account. Used as part of the URL", + "content": "Name of the VTEX account. Used as part of the URL.", "type": "text/plain" }, "type": "any", @@ -66,7 +66,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "77d3f1d4-33cb-4c7d-8b74-cd89e0d857ed", + "id": "74b6bb24-5b09-4b04-b489-3c7b885ab00d", "name": "OK", "originalRequest": { "url": { @@ -84,7 +84,7 @@ "variable": [ { "description": { - "content": "Name of the VTEX account. Used as part of the URL", + "content": "Name of the VTEX account. Used as part of the URL.", "type": "text/plain" }, "type": "any", @@ -145,7 +145,7 @@ "value": "application/json" } ], - "body": "{\n \"limitConfigurationMaxPrice\": {\n \"activesCount\": 0,\n \"limit\": 10\n },\n \"limitConfiguration\": {\n \"activesCount\": 4,\n \"limit\": 100\n },\n \"items\": [\n {\n \"idCalculatorConfiguration\": \"d8a1cd2e-b667-4054-b3ae-b79124c7218e\",\n \"lastModifiedUtc\": \"2021-09-17T18:13:16.2896414Z\",\n \"name\": \"Promotion Social Seller\",\n \"description\": \"Promotion for Social Seller\",\n \"type\": \"regular\",\n \"utmSource\": \"georgeSource\",\n \"utmCampain\": \"georgeTest\",\n \"utmiCampaign\": \"\",\n \"status\": \"active\",\n \"isActive\": true,\n \"isArchived\": false,\n \"hasMaxPricePerItem\": false,\n \"isTax\": false,\n \"Campaigns\": [],\n \"conditionsIds\": [\n \"372e1868-2c0e-4437-be45-1ef8c9cab735\"\n ],\n \"activateGiftsMultiplier\": false,\n \"scope\": {\n \"allCatalog\": true,\n \"skus\": 0,\n \"skusAreInclusive\": true,\n \"products\": 0,\n \"productsAreInclusive\": false,\n \"collections\": 0,\n \"collectionsAreInclusive\": false,\n \"categories\": 0,\n \"categoriesAreInclusive\": false,\n \"brands\": 0,\n \"brandsAreInclusive\": false,\n \"sellers\": 0,\n \"sellersAreInclusive\": false\n },\n \"maxUsage\": 0,\n \"idsSalesChannel\": [],\n \"areSalesChannelIdsExclusive\": false\n },\n {\n \"idCalculatorConfiguration\": \"7c946926-7815-4446-9428-83bd577a9135\",\n \"lastModifiedUtc\": \"2021-11-12T16:58:30.2553053Z\",\n \"name\": \"Progressive Discount\",\n \"beginDate\": \"2009-12-31T02:00:00Z\",\n \"isActive\": true,\n \"description\": \"\",\n \"type\": \"progressive\",\n \"utmSource\": \"\",\n \"utmCampain\": \"\",\n \"utmiCampaign\": \"\",\n \"status\": \"active\",\n \"percentualTax\": 0,\n \"isArchived\": false,\n \"hasMaxPricePerItem\": false,\n \"isTax\": false,\n \"Campaigns\": [],\n \"activateGiftsMultiplier\": false,\n \"scope\": {\n \"allCatalog\": true,\n \"skus\": 0,\n \"skusAreInclusive\": true,\n \"products\": 0,\n \"productsAreInclusive\": true,\n \"collections\": 0,\n \"collectionsAreInclusive\": true,\n \"categories\": 0,\n \"categoriesAreInclusive\": true,\n \"brands\": 0,\n \"brandsAreInclusive\": true,\n \"sellers\": 0,\n \"sellersAreInclusive\": true\n },\n \"maxUsage\": 0,\n \"idsSalesChannel\": [],\n \"areSalesChannelIdsExclusive\": false\n }\n ],\n \"disabledItems\": [],\n \"archivedItems\": []\n}", + "body": "{\n \"limitConfigurationMaxPrice\": {\n \"activesCount\": 0,\n \"limit\": 10\n },\n \"limitConfiguration\": {\n \"activesCount\": 4,\n \"limit\": 100\n },\n \"items\": [\n {\n \"idCalculatorConfiguration\": \"d8a1cd2e-b667-4054-b3ae-b79124c7218e\",\n \"lastModifiedUtc\": \"2021-09-17T18:13:16.2896414Z\",\n \"name\": \"Promotion Social Seller\",\n \"description\": \"Promotion for Social Seller\",\n \"type\": \"regular\",\n \"utmSource\": \"georgeSource\",\n \"utmCampain\": \"georgeTest\",\n \"utmiCampaign\": \"\",\n \"status\": \"active\",\n \"isActive\": true,\n \"isArchived\": false,\n \"hasMaxPricePerItem\": false,\n \"isTax\": false,\n \"Campaigns\": [],\n \"conditionsIds\": [\n \"372e1868-2c0e-4437-be45-1ef8c9cab735\"\n ],\n \"activateGiftsMultiplier\": false,\n \"scope\": {\n \"allCatalog\": true,\n \"skus\": 0,\n \"skusAreInclusive\": true,\n \"products\": 0,\n \"productsAreInclusive\": false,\n \"collections\": 0,\n \"collectionsAreInclusive\": false,\n \"categories\": 0,\n \"categoriesAreInclusive\": false,\n \"brands\": 0,\n \"brandsAreInclusive\": false,\n \"sellers\": 0,\n \"sellersAreInclusive\": false\n },\n \"maxUsage\": 0,\n \"idsSalesChannel\": [],\n \"areSalesChannelIdsExclusive\": false\n },\n {\n \"idCalculatorConfiguration\": \"7c946926-7815-4446-9428-83bd577a9135\",\n \"lastModifiedUtc\": \"2021-11-12T16:58:30.2553053Z\",\n \"name\": \"Progressive Discount\",\n \"beginDate\": \"2021-04-15T03:00:00Z\",\n \"endDate\": \"2021-04-16T02:30:00Z\",\n \"isActive\": false,\n \"description\": \"\",\n \"type\": \"progressive\",\n \"utmSource\": \"\",\n \"utmCampain\": \"\",\n \"utmiCampaign\": \"\",\n \"nominalDiscountType\": \"item\",\n \"status\": \"inactive\",\n \"percentualTax\": 0,\n \"isArchived\": false,\n \"hasMaxPricePerItem\": false,\n \"isTax\": false,\n \"Campaigns\": [],\n \"activateGiftsMultiplier\": false,\n \"scope\": {\n \"allCatalog\": true,\n \"skus\": 0,\n \"skusAreInclusive\": true,\n \"products\": 0,\n \"productsAreInclusive\": true,\n \"collections\": 0,\n \"collectionsAreInclusive\": true,\n \"categories\": 0,\n \"categoriesAreInclusive\": true,\n \"brands\": 0,\n \"brandsAreInclusive\": true,\n \"sellers\": 0,\n \"sellersAreInclusive\": true\n },\n \"maxUsage\": 0,\n \"idsSalesChannel\": [],\n \"areSalesChannelIdsExclusive\": false\n }\n ],\n \"disabledItems\": [],\n \"archivedItems\": []\n}", "cookie": [] } ], @@ -153,13 +153,13 @@ { "listen": "test", "script": { - "id": "4c1a7b44-a84b-433f-b099-cad0d43fa078", + "id": "12ecf283-cfd9-4f8a-aa2e-bff6f03d6d6b", "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", "// Validate if response header has matching content-type\npm.test(\"[GET]::/api/rnb/pvt/benefits/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(\"[GET]::/api/rnb/pvt/benefits/calculatorconfiguration - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"type\":\"object\",\"properties\":{\"limitConfigurationMaxPrice\":{\"type\":\"object\",\"description\":\"Limit configuration max price.\",\"properties\":{\"activesCount\":{\"type\":\"integer\",\"description\":\"Actives count.\"},\"limit\":{\"type\":\"integer\",\"description\":\"Limit.\"}}},\"limitConfiguration\":{\"type\":\"object\",\"description\":\"Limit configuration.\",\"properties\":{\"activesCount\":{\"type\":\"integer\",\"description\":\"Actives count.\"},\"limit\":{\"type\":\"integer\",\"description\":\"Limit.\"}}},\"items\":{\"type\":\"array\",\"description\":\"Array with promotions.\",\"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\":\"Array with campaign audiences that activate this promotion.\",\"type\":\"array\",\"items\":{\"type\":\"string\",\"description\":\"Campaign Audience.\",\"example\":\"Campaign Audience example\"}},\"activateGiftsMultiplier\":{\"description\":\"If set as `true`, it activates gifts Multiplier.\",\"type\":\"boolean\",\"example\":false},\"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\",\"example\":false},\"skus\":{\"description\":\"Quantity of SKUs which activate or deactivate the promotion.\",\"type\":\"number\",\"example\":1},\"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\",\"example\":true},\"products\":{\"description\":\"Quantity of products which activate or deactivate the promotion.\",\"type\":\"number\",\"example\":1},\"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\",\"example\":true},\"collections\":{\"description\":\"Quantity of collections which activate or deactivate the promotion.\",\"type\":\"number\",\"example\":1},\"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\",\"example\":true},\"categories\":{\"description\":\"Quantity of categories which activate or deactivate the promotion.\",\"type\":\"number\",\"example\":1},\"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.\",\"example\":true},\"brands\":{\"description\":\"Quantity of brands which activate or deactivate the promotion.\",\"type\":\"number\",\"example\":1},\"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\",\"example\":true},\"sellers\":{\"description\":\"Quantity of sellers which activate or deactivate the promotion.\",\"type\":\"number\",\"example\":0},\"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\",\"example\":false}}},\"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.\"}}}},\"disabledItems\":{\"type\":\"array\",\"description\":\"Disabled items.\"},\"archivedItems\":{\"type\":\"array\",\"description\":\"Archived items.\",\"items\":{\"type\":\"string\",\"description\":\"Archived item.\"}},\"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.\",\"example\":\"item\"}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/rnb/pvt/benefits/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\":{\"limitConfigurationMaxPrice\":{\"type\":\"object\",\"description\":\"Limit configuration max price.\",\"properties\":{\"activesCount\":{\"type\":\"integer\",\"description\":\"Actives count.\"},\"limit\":{\"type\":\"integer\",\"description\":\"Limit.\"}}},\"limitConfiguration\":{\"type\":\"object\",\"description\":\"Limit configuration.\",\"properties\":{\"activesCount\":{\"type\":\"integer\",\"description\":\"Actives count.\"},\"limit\":{\"type\":\"integer\",\"description\":\"Limit.\"}}},\"items\":{\"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\":{\"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.\"}}}},\"disabledItems\":{\"type\":\"array\",\"description\":\"Disabled items.\",\"items\":{\"type\":\"string\",\"description\":\"Disabled item.\"}},\"archivedItems\":{\"type\":\"array\",\"description\":\"Archived items.\",\"items\":{\"type\":\"string\",\"description\":\"Archived item.\"}},\"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.\"}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/rnb/pvt/benefits/calculatorconfiguration - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -169,7 +169,7 @@ } }, { - "id": "0a25681b-ad35-48ff-8648-c8e7f7dbce70", + "id": "392b2014-5b29-4d28-a818-c08dea450c44", "name": "Search promotion by name", "request": { "name": "Search promotion by name", @@ -203,7 +203,7 @@ "variable": [ { "description": { - "content": "Name of the VTEX account. Used as part of the URL", + "content": "Name of the VTEX account. Used as part of the URL.", "type": "text/plain" }, "type": "any", @@ -234,7 +234,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "157efef3-9dc3-44fa-8c19-5ce0ffaac295", + "id": "79a9e78f-3841-4e2e-a3e2-428e126d2cf2", "name": "OK", "originalRequest": { "url": { @@ -258,7 +258,7 @@ "variable": [ { "description": { - "content": "Name of the VTEX account. Used as part of the URL", + "content": "Name of the VTEX account. Used as part of the URL.", "type": "text/plain" }, "type": "any", @@ -319,7 +319,7 @@ "value": "application/json" } ], - "body": "[\n {\n \"idCalculatorConfiguration\": \"5ee78a73-a77e-4f84-b54e-d0c75a4b101a\",\n \"name\": \"Black shirt\",\n \"beginDateUtc\": \"2021-11-09T03:00:00Z\",\n \"endDateUtc\": \"2021-11-26T02:30:00Z\",\n \"lastModified\": \"2021-11-16T22:09:55.071735Z\",\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 \"nominalShippingDiscountValue\": 0,\n \"absoluteShippingDiscountValue\": 0,\n \"nominalDiscountValue\": 1,\n \"nominalDiscountType\": \"cart\",\n \"maximumUnitPriceDiscount\": 0,\n \"percentualDiscountValue\": 0,\n \"rebatePercentualDiscountValue\": 0,\n \"percentualShippingDiscountValue\": 0,\n \"percentualTax\": 0,\n \"shippingPercentualTax\": 0,\n \"percentualDiscountValueList1\": 0,\n \"percentualDiscountValueList2\": 0,\n \"skusGift\": {\n \"quantitySelectable\": 1,\n \"gifts\": []\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\": true,\n \"idsSalesChannel\": [],\n \"areSalesChannelIdsExclusive\": false,\n \"marketingTags\": [],\n \"marketingTagsAreNotInclusive\": false,\n \"paymentsMethods\": [],\n \"stores\": [],\n \"campaigns\": [],\n \"storesAreInclusive\": true,\n \"categories\": [],\n \"categoriesAreInclusive\": true,\n \"brands\": [],\n \"brandsAreInclusive\": true,\n \"products\": [\n {\n \"id\": \"1\",\n \"name\": \"Pricing QA Test Product 1 (Produto 1)\"\n },\n {\n \"id\": \"3\",\n \"name\": \"Pricing QA Test Product 3 (Produto 3)\"\n }\n ],\n \"productsAreInclusive\": true,\n \"skus\": [],\n \"skusAreInclusive\": true,\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\": true,\n \"restrictionsBins\": [],\n \"cardIssuers\": [],\n \"totalValuePurchase\": 0,\n \"slasIds\": [],\n \"isSlaSelected\": false,\n \"isFirstBuy\": false,\n \"firstBuyIsProfileOptimistic\": true,\n \"compareListPriceAndPrice\": false,\n \"isDifferentListPriceAndPrice\": false,\n \"zipCodeRanges\": [],\n \"itemMaxPrice\": 0,\n \"itemMinPrice\": 0,\n \"installment\": 0,\n \"isMinMaxInstallments\": false,\n \"minInstallment\": 0,\n \"maxInstallment\": 0,\n \"merchants\": [],\n \"clusterExpressions\": [],\n \"clusterOperator\": \"all\",\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 }\n]", + "body": "[\n {\n \"idCalculatorConfiguration\": \"5ee78a73-a77e-4f84-b54e-d0c75a4b101a\",\n \"name\": \"Black shirt\",\n \"beginDateUtc\": \"2021-11-09T03:00:00Z\",\n \"endDateUtc\": \"2021-11-26T02:30:00Z\",\n \"lastModified\": \"2021-11-16T22:09:55.071735Z\",\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 \"nominalShippingDiscountValue\": 0,\n \"absoluteShippingDiscountValue\": 0,\n \"nominalDiscountValue\": 1,\n \"nominalDiscountType\": \"cart\",\n \"maximumUnitPriceDiscount\": 0,\n \"percentualDiscountValue\": 0,\n \"rebatePercentualDiscountValue\": 0,\n \"percentualShippingDiscountValue\": 0,\n \"percentualTax\": 0,\n \"shippingPercentualTax\": 0,\n \"percentualDiscountValueList1\": 0,\n \"percentualDiscountValueList2\": 0,\n \"skusGift\": {\n \"quantitySelectable\": 1,\n \"gifts\": 1\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\": true,\n \"idsSalesChannel\": [],\n \"areSalesChannelIdsExclusive\": false,\n \"marketingTags\": [],\n \"marketingTagsAreNotInclusive\": false,\n \"paymentsMethods\": [],\n \"stores\": [],\n \"campaigns\": [],\n \"storesAreInclusive\": true,\n \"categories\": [],\n \"categoriesAreInclusive\": true,\n \"brands\": [],\n \"brandsAreInclusive\": true,\n \"products\": [\n {\n \"id\": \"1\",\n \"name\": \"Pricing QA Test Product 1 (Produto 1)\"\n },\n {\n \"id\": \"3\",\n \"name\": \"Pricing QA Test Product 3 (Produto 3)\"\n }\n ],\n \"productsAreInclusive\": true,\n \"skus\": [],\n \"skusAreInclusive\": true,\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\": true,\n \"restrictionsBins\": [],\n \"cardIssuers\": [],\n \"totalValuePurchase\": 0,\n \"slasIds\": [],\n \"isSlaSelected\": false,\n \"isFirstBuy\": false,\n \"firstBuyIsProfileOptimistic\": true,\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 \"clusterOperator\": \"all\",\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 }\n]", "cookie": [] } ], @@ -327,13 +327,13 @@ { "listen": "test", "script": { - "id": "793d5f24-3d26-469a-b206-4c1da22b4c81", + "id": "4fa3d7b0-9a06-4932-8410-4ee6f33d6dbb", "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.\",\"example\":{\"idCalculatorConfiguration\":\"5ee78a73-a77e-4f84-b54e-d0c75a4b101a\",\"name\":\"Black shirt\",\"beginDateUtc\":\"2021-11-09T03:00:00Z\",\"endDateUtc\":\"2021-11-26T02:30:00Z\",\"lastModified\":\"2021-11-16T22:09:55.071735Z\",\"daysAgoOfPurchases\":0,\"isActive\":true,\"isArchived\":false,\"isFeatured\":false,\"disableDeal\":false,\"activeDaysOfWeek\":[],\"offset\":-3,\"activateGiftsMultiplier\":false,\"newOffset\":-3,\"maxPricesPerItems\":[],\"cumulative\":false,\"nominalShippingDiscountValue\":0,\"absoluteShippingDiscountValue\":0,\"nominalDiscountValue\":1,\"nominalDiscountType\":\"cart\",\"maximumUnitPriceDiscount\":0,\"percentualDiscountValue\":0,\"rebatePercentualDiscountValue\":0,\"percentualShippingDiscountValue\":0,\"percentualTax\":0,\"shippingPercentualTax\":0,\"percentualDiscountValueList1\":0,\"percentualDiscountValueList2\":0,\"skusGift\":{\"quantitySelectable\":1,\"gifts\":[]},\"nominalRewardValue\":0,\"percentualRewardValue\":0,\"orderStatusRewardValue\":\"invoiced\",\"maxNumberOfAffectedItems\":0,\"maxNumberOfAffectedItemsGroupKey\":\"perCart\",\"applyToAllShippings\":false,\"nominalTax\":0,\"origin\":\"Marketplace\",\"idSellerIsInclusive\":true,\"idsSalesChannel\":[],\"areSalesChannelIdsExclusive\":false,\"marketingTags\":[],\"marketingTagsAreNotInclusive\":false,\"paymentsMethods\":[],\"stores\":[],\"campaigns\":[],\"storesAreInclusive\":true,\"categories\":[],\"categoriesAreInclusive\":true,\"brands\":[],\"brandsAreInclusive\":true,\"products\":[{\"id\":\"1\",\"name\":\"Pricing QA Test Product 1 (Produto 1)\"},{\"id\":\"3\",\"name\":\"Pricing QA Test Product 3 (Produto 3)\"}],\"productsAreInclusive\":true,\"skus\":[],\"skusAreInclusive\":true,\"collections1BuyTogether\":[],\"collections2BuyTogether\":[],\"minimumQuantityBuyTogether\":0,\"quantityToAffectBuyTogether\":0,\"enableBuyTogetherPerSku\":false,\"listSku1BuyTogether\":[],\"listSku2BuyTogether\":[],\"coupon\":[],\"totalValueFloor\":0,\"totalValueCeling\":0,\"totalValueIncludeAllItems\":false,\"totalValueMode\":\"IncludeMatchedItems\",\"collections\":[],\"collectionsIsInclusive\":true,\"restrictionsBins\":[],\"cardIssuers\":[],\"totalValuePurchase\":0,\"slasIds\":[],\"isSlaSelected\":false,\"isFirstBuy\":false,\"firstBuyIsProfileOptimistic\":true,\"compareListPriceAndPrice\":false,\"isDifferentListPriceAndPrice\":false,\"zipCodeRanges\":[],\"itemMaxPrice\":0,\"itemMinPrice\":0,\"installment\":0,\"isMinMaxInstallments\":false,\"minInstallment\":0,\"maxInstallment\":0,\"merchants\":[],\"clusterExpressions\":[],\"clusterOperator\":\"all\",\"paymentsRules\":[],\"giftListTypes\":[],\"productsSpecifications\":[],\"affiliates\":[],\"maxUsage\":0,\"maxUsagePerClient\":0,\"shouldDistributeDiscountAmongMatchedItems\":false,\"multipleUsePerClient\":false,\"accumulateWithManualPrice\":false,\"type\":\"regular\",\"useNewProgressiveAlgorithm\":false,\"percentualDiscountValueList\":[]},\"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},\"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},\"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.\",\"example\":\"item\"},\"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},\"campaigns\":{\"type\":\"array\",\"description\":\"Campaign Audiences that activate this promotion.\"},\"conditionsIds\":{\"type\":\"array\",\"description\":\"Array with conditions IDs.\",\"items\":{\"type\":\"string\",\"description\":\"Condition ID.\"}},\"storesAreInclusive\":{\"type\":\"boolean\",\"deprecated\":true},\"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\":\"string\",\"description\":\"Collection ID.\"}},\"collections2BuyTogether\":{\"type\":\"array\",\"deprecated\":true},\"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\":\"SKU first list for the promotion **Buy Together**.\"},\"listSku2BuyTogether\":{\"type\":\"array\",\"description\":\"SKU second list for the promotion **Buy Together**.\"},\"coupon\":{\"type\":\"array\",\"deprecated\":true},\"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},\"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},\"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\",\"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},\"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},\"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.\",\"example\":\"email contains user@mail.com\"}},\"clusterOperator\":{\"type\":\"string\",\"deprecated\":true},\"paymentsRules\":{\"type\":\"array\",\"deprecated\":true},\"giftListTypes\":{\"type\":\"array\",\"description\":\"Gifts List Type.\",\"items\":{\"type\":\"string\",\"description\":\"Gift List Type.\"}},\"productsSpecifications\":{\"type\":\"array\",\"deprecated\":true},\"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\",\"deprecated\":true,\"description\":\"Indicates whether a deal is disable.\"},\"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.\"}},\"conditionsIds\":{\"type\":\"array\",\"description\":\"Array with conditions IDs.\",\"items\":{\"type\":\"string\",\"description\":\"Condition ID.\"}},\"storesAreInclusive\":{\"type\":\"boolean\",\"deprecated\":true,\"description\":\"Stores are inclusive.\"},\"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\":\"string\",\"description\":\"Collection ID.\"}},\"collections2BuyTogether\":{\"type\":\"array\",\"deprecated\":true,\"description\":\"List of item for **Buy Together**.\",\"items\":{\"type\":\"string\",\"description\":\"Item for **Buy Together**.\"}},\"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\":\"SKU first list for the promotion **Buy Together**.\",\"items\":{\"type\":\"string\",\"description\":\"Product SKU.\"}},\"listSku2BuyTogether\":{\"type\":\"array\",\"description\":\"SKU second list for the promotion **Buy Together**.\",\"items\":{\"type\":\"string\",\"description\":\"Product SKU.\"}},\"coupon\":{\"type\":\"array\",\"deprecated\":true,\"description\":\"List of coupons.\",\"items\":{\"type\":\"string\",\"description\":\"Coupon.\"}},\"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 include 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\",\"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 specification.\",\"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" ] } } @@ -343,7 +343,7 @@ } }, { - "id": "6c7e4589-a1eb-4bfb-bf06-d099a2e6b290", + "id": "27d4a339-449e-4910-a59f-e09e77166942", "name": "Get All Taxes", "request": { "name": "Get All Taxes", @@ -366,7 +366,7 @@ "variable": [ { "description": { - "content": "Name of the VTEX account. Used as part of the URL", + "content": "Name of the VTEX account. Used as part of the URL.", "type": "text/plain" }, "type": "any", @@ -397,7 +397,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "e2d64fb2-45a8-40f4-a75e-37e0482190f9", + "id": "a5d3963f-47b6-4bfb-8238-9e1e2f47d0dd", "name": "OK", "originalRequest": { "url": { @@ -415,7 +415,7 @@ "variable": [ { "description": { - "content": "Name of the VTEX account. Used as part of the URL", + "content": "Name of the VTEX account. Used as part of the URL.", "type": "text/plain" }, "type": "any", @@ -484,13 +484,13 @@ { "listen": "test", "script": { - "id": "258692bb-c3c4-4e33-8442-f445422d9497", + "id": "61ad23e5-b6dd-4a9f-b821-23740eb5cd63", "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", "// Validate if response header has matching content-type\npm.test(\"[GET]::/api/rnb/pvt/taxes/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(\"[GET]::/api/rnb/pvt/taxes/calculatorconfiguration - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"type\":\"object\",\"properties\":{\"limitConfiguration\":{\"type\":\"object\",\"description\":\"Limit configuration.\",\"properties\":{\"activesCount\":{\"type\":\"integer\",\"description\":\"Actives count.\"},\"limit\":{\"type\":\"integer\",\"description\":\"Limit.\"}}},\"items\":{\"type\":\"array\",\"description\":\"Array with taxes.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information about a tax.\",\"properties\":{\"idCalculatorConfiguration\":{\"type\":\"string\",\"description\":\"Tax ID.\"},\"lastModifiedUtc\":{\"type\":\"string\",\"description\":\"Date and time when the tax was last modified (UTC).\"},\"name\":{\"type\":\"string\",\"description\":\"Tax name.\"},\"beginDate\":{\"type\":\"string\",\"description\":\"Tax start date (UTC).\"},\"endDate\":{\"type\":\"string\",\"description\":\"Tax end date (UTC).\"},\"isActive\":{\"type\":\"boolean\",\"description\":\"If set as `true` the tax is activated. If set as `false` the tax is deactivated.\"},\"description\":{\"type\":\"string\",\"description\":\"Tax internal description.\"},\"type\":{\"description\":\"Defines the type of tax.\",\"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 tax.\"},\"percentualTax\":{\"type\":\"number\",\"description\":\"Percentual tax applied.\"},\"isArchived\":{\"type\":\"boolean\",\"description\":\"If set as `true` the tax is archived. If set as `false` the tax 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\":\"Array with campaign audiences that activate this tax.\",\"type\":\"array\",\"items\":{\"type\":\"string\",\"description\":\"Campaign Audience.\",\"example\":\"Campaign Audience example\"}},\"activateGiftsMultiplier\":{\"description\":\"If set as `true`, it activates gifts Multiplier.\",\"type\":\"boolean\",\"example\":false},\"scope\":{\"description\":\"Scope of the tax.\",\"type\":\"object\",\"properties\":{\"allCatalog\":{\"description\":\"Determines if the tax applies to all products in the Catalog (`true`) or not (`false`).\",\"type\":\"boolean\",\"example\":false},\"skus\":{\"description\":\"Quantity of SKUs which activate or deactivate the tax.\",\"type\":\"number\",\"example\":1},\"skusAreInclusive\":{\"description\":\"If set to `true`, this tax will be applied to any SKU present on the `skus` field. If set to `false`, SKUs present on that field will make this tax not to be applied.\",\"type\":\"boolean\",\"example\":true},\"products\":{\"description\":\"Quantity of products which activate or deactivate the tax.\",\"type\":\"number\",\"example\":1},\"productsAreInclusive\":{\"description\":\"If set to `true`, this tax will be applied to any product present on the `products` field. If set to `false`, products present on that field will make this tax not to be applied.\",\"type\":\"boolean\",\"example\":true},\"collections\":{\"description\":\"Quantity of collections which activate or deactivate the tax.\",\"type\":\"number\",\"example\":1},\"collectionsAreInclusive\":{\"description\":\"If set to `true`, this tax will be applied to any collection present on the `collections` field. If set to `false`, collections present on that field will make this tax not to be applied.\",\"type\":\"boolean\",\"example\":true},\"categories\":{\"description\":\"Quantity of categories which activate or deactivate the tax.\",\"type\":\"number\",\"example\":1},\"categoriesAreInclusive\":{\"type\":\"boolean\",\"description\":\"If set to `true`, this tax will be applied to any category present on the `categories` field. If set to `false`, categories present on that field will make this tax not to be applied.\",\"example\":true},\"brands\":{\"description\":\"Quantity of brands which activate or deactivate the tax.\",\"type\":\"number\",\"example\":1},\"brandsAreInclusive\":{\"description\":\"If set to `true`, this tax will be applied to any brand present on the `brands` field. If set to `false`, brands present on that field will make this tax not to be applied.\",\"type\":\"boolean\",\"example\":true},\"sellers\":{\"description\":\"Quantity of sellers which activate or deactivate the tax.\",\"type\":\"number\",\"example\":0},\"sellersAreInclusive\":{\"description\":\"If set to `true`, this tax will be applied to any seller present on the `sellers` field. If set to `false`, sellers present on that field will make this tax not to be applied.\",\"type\":\"boolean\",\"example\":false}}},\"maxUsage\":{\"type\":\"number\",\"description\":\"Defines how many times the tax can be used.\"},\"idsSalesChannel\":{\"type\":\"array\",\"description\":\"List of Trade Policies that activate this tax.\",\"items\":{\"type\":\"string\",\"description\":\"Trade Policy ID.\"}},\"areSalesChannelIdsExclusive\":{\"type\":\"boolean\",\"description\":\"If set to `false`, this tax will be applied to any trade policies present on the `idsSalesChannel` field. If set to `true`, trade policies present on that field will make this tax not to be applied.\"}}}},\"disabledItems\":{\"type\":\"array\",\"description\":\"Disabled items.\",\"items\":{\"type\":\"string\",\"description\":\"Disabled item.\"}},\"archivedItems\":{\"type\":\"array\",\"description\":\"Archived items.\",\"items\":{\"type\":\"string\",\"description\":\"Archived item.\"}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/rnb/pvt/taxes/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\":{\"limitConfiguration\":{\"type\":\"object\",\"description\":\"Limit configuration.\",\"properties\":{\"activesCount\":{\"type\":\"integer\",\"description\":\"Actives count.\"},\"limit\":{\"type\":\"integer\",\"description\":\"Limit.\"}}},\"items\":{\"type\":\"array\",\"description\":\"Array with taxes.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information about a tax.\",\"properties\":{\"idCalculatorConfiguration\":{\"type\":\"string\",\"description\":\"Tax ID.\"},\"lastModifiedUtc\":{\"type\":\"string\",\"description\":\"Date and time when the tax was last modified (UTC).\"},\"name\":{\"type\":\"string\",\"description\":\"Tax name.\"},\"beginDate\":{\"type\":\"string\",\"description\":\"Tax start date (UTC).\"},\"endDate\":{\"type\":\"string\",\"description\":\"Tax end date (UTC).\"},\"isActive\":{\"type\":\"boolean\",\"description\":\"If set as `true` the tax is activated. If set as `false` the tax is deactivated.\"},\"description\":{\"type\":\"string\",\"description\":\"Tax internal description.\"},\"type\":{\"description\":\"Defines the type of tax.\",\"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 tax.\"},\"percentualTax\":{\"type\":\"number\",\"description\":\"Percentual tax applied.\"},\"isArchived\":{\"type\":\"boolean\",\"description\":\"If set as `true` the tax is archived. If set as `false` the tax 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\":{\"type\":\"array\",\"description\":\"Campaign Audiences that activate this promotion.\",\"items\":{\"type\":\"string\",\"description\":\"Campaign.\"}},\"activateGiftsMultiplier\":{\"description\":\"If set as `true`, it activates gifts Multiplier.\",\"type\":\"boolean\"},\"scope\":{\"description\":\"Scope of the tax.\",\"type\":\"object\",\"properties\":{\"allCatalog\":{\"description\":\"Determines if the tax applies to all products in the Catalog (`true`) or not (`false`).\",\"type\":\"boolean\"},\"skus\":{\"description\":\"Quantity of SKUs which activate or deactivate the tax.\",\"type\":\"number\"},\"skusAreInclusive\":{\"description\":\"If set to `true`, this tax will be applied to any SKU present on the `skus` field. If set to `false`, SKUs present on that field will make this tax not to be applied.\",\"type\":\"boolean\"},\"products\":{\"description\":\"Quantity of products which activate or deactivate the tax.\",\"type\":\"number\"},\"productsAreInclusive\":{\"description\":\"If set to `true`, this tax will be applied to any product present on the `products` field. If set to `false`, products present on that field will make this tax not to be applied.\",\"type\":\"boolean\"},\"collections\":{\"description\":\"Quantity of collections which activate or deactivate the tax.\",\"type\":\"number\"},\"collectionsAreInclusive\":{\"description\":\"If set to `true`, this tax will be applied to any collection present on the `collections` field. If set to `false`, collections present on that field will make this tax not to be applied.\",\"type\":\"boolean\"},\"categories\":{\"description\":\"Quantity of categories which activate or deactivate the tax.\",\"type\":\"number\"},\"categoriesAreInclusive\":{\"type\":\"boolean\",\"description\":\"If set to `true`, this tax will be applied to any category present on the `categories` field. If set to `false`, categories present on that field will make this tax not to be applied.\"},\"brands\":{\"description\":\"Quantity of brands which activate or deactivate the tax.\",\"type\":\"number\"},\"brandsAreInclusive\":{\"description\":\"If set to `true`, this tax will be applied to any brand present on the `brands` field. If set to `false`, brands present on that field will make this tax not to be applied.\",\"type\":\"boolean\"},\"sellers\":{\"description\":\"Quantity of sellers which activate or deactivate the tax.\",\"type\":\"number\"},\"sellersAreInclusive\":{\"description\":\"If set to `true`, this tax will be applied to any seller present on the `sellers` field. If set to `false`, sellers present on that field will make this tax not to be applied.\",\"type\":\"boolean\"}}},\"maxUsage\":{\"type\":\"number\",\"description\":\"Defines how many times the tax can be used.\"},\"idsSalesChannel\":{\"type\":\"array\",\"description\":\"List of Trade Policies that activate this tax.\",\"items\":{\"type\":\"string\",\"description\":\"Trade Policy ID.\"}},\"areSalesChannelIdsExclusive\":{\"type\":\"boolean\",\"description\":\"If set to `false`, this tax will be applied to any trade policies present on the `idsSalesChannel` field. If set to `true`, trade policies present on that field will make this tax not to be applied.\"}}}},\"disabledItems\":{\"type\":\"array\",\"description\":\"Disabled items.\",\"items\":{\"type\":\"string\",\"description\":\"Disabled item.\"}},\"archivedItems\":{\"type\":\"array\",\"description\":\"Archived items.\",\"items\":{\"type\":\"string\",\"description\":\"Archived item.\"}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/rnb/pvt/taxes/calculatorconfiguration - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -500,7 +500,7 @@ } }, { - "id": "9a8b8b24-0d32-49c2-a92a-d01e4e26da91", + "id": "68cc5405-23d5-472f-bb4a-cd7b744ace4c", "name": "Get Promotion or Tax by ID", "request": { "name": "Get Promotion or Tax by ID", @@ -533,7 +533,7 @@ }, { "description": { - "content": "Name of the VTEX account. Used as part of the URL", + "content": "Name of the VTEX account. Used as part of the URL.", "type": "text/plain" }, "type": "any", @@ -564,7 +564,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "0a6954d9-c703-4798-9cd4-d8fea0da373c", + "id": "de111880-b0a6-4384-8099-3c43f5b803bc", "name": "OK", "originalRequest": { "url": { @@ -592,7 +592,7 @@ }, { "description": { - "content": "Name of the VTEX account. Used as part of the URL", + "content": "Name of the VTEX account. Used as part of the URL.", "type": "text/plain" }, "type": "any", @@ -653,7 +653,7 @@ "value": "application/json" } ], - "body": "{\n \"idCalculatorConfiguration\": \"d8a1cd2e-b667-4054-b3ae-b79124c7218e\",\n \"name\": \"Social Seller Promotion\",\n \"beginDateUtc\": \"2020-05-01T18:47:15.89Z\",\n \"lastModified\": \"2021-02-23T20:58:38.7963862Z\",\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\": 0,\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 {\n \"id\": \"202\",\n \"name\": \"Dinheiro (202)\"\n },\n {\n \"id\": \"2\",\n \"name\": \"Visa (2)\"\n }\n ],\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 \"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}", + "body": "{\n \"idCalculatorConfiguration\": \"d8a1cd2e-b667-4054-b3ae-b79124c7218e\",\n \"name\": \"Social Seller Promotion\",\n \"beginDateUtc\": \"2020-05-01T18:47:15.89Z\",\n \"lastModified\": \"2021-02-23T20:58:38.7963862Z\",\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\": 0,\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 {\n \"id\": \"202\",\n \"name\": \"Dinheiro (202)\"\n },\n {\n \"id\": \"2\",\n \"name\": \"Visa (2)\"\n }\n ],\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 {\n \"id\": \"2\",\n \"name\": \"gustaBT\"\n },\n {\n \"id\": \"5\",\n \"name\": \"exampleSKU\"\n }\n ],\n \"listSku2BuyTogether\": [\n {\n \"id\": \"3\",\n \"name\": \"anotherSKU\"\n },\n {\n \"id\": \"6\",\n \"name\": \"exampleProduct\"\n }\n ],\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}", "cookie": [] } ], @@ -661,13 +661,13 @@ { "listen": "test", "script": { - "id": "2f80234a-e25c-414b-b0f4-fc9abb415c9c", + "id": "716faafa-e489-465a-ac7b-d0f35af0ac65", "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},\"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},\"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.\",\"example\":\"item\"},\"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},\"campaigns\":{\"type\":\"array\",\"description\":\"Campaign Audiences that activate this promotion.\"},\"conditionsIds\":{\"type\":\"array\",\"description\":\"Array with conditions IDs.\",\"items\":{\"type\":\"string\",\"description\":\"Condition ID.\"}},\"storesAreInclusive\":{\"type\":\"boolean\",\"deprecated\":true},\"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\":\"string\",\"description\":\"Collection ID.\"}},\"collections2BuyTogether\":{\"type\":\"array\",\"deprecated\":true},\"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\":\"SKU first list for the promotion **Buy Together**.\"},\"listSku2BuyTogether\":{\"type\":\"array\",\"description\":\"SKU second list for the promotion **Buy Together**.\"},\"coupon\":{\"type\":\"array\",\"deprecated\":true},\"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},\"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},\"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\",\"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},\"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},\"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.\",\"example\":\"email contains user@mail.com\"}},\"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},\"giftListTypes\":{\"type\":\"array\",\"description\":\"Gifts List Type.\",\"items\":{\"type\":\"string\",\"description\":\"Gift List Type.\"}},\"productsSpecifications\":{\"type\":\"array\",\"deprecated\":true},\"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\",\"deprecated\":true,\"description\":\"Disable deal.\"},\"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.\"}},\"conditionsIds\":{\"type\":\"array\",\"description\":\"Array with conditions IDs.\",\"items\":{\"type\":\"string\",\"description\":\"Condition ID.\"}},\"storesAreInclusive\":{\"type\":\"boolean\",\"deprecated\":true,\"description\":\"Stores are inclusive.\"},\"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\":\"string\",\"description\":\"Collection ID.\"}},\"collections2BuyTogether\":{\"type\":\"array\",\"deprecated\":true,\"description\":\"List of item for **Buy Together**.\",\"items\":{\"type\":\"string\",\"description\":\"Item for **Buy Together**.\"}},\"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.\"}},\"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 include 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\",\"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" ] } } @@ -677,7 +677,7 @@ } }, { - "id": "0d53d3f1-1a8e-4977-b6e9-1b3d09d050e2", + "id": "5bf3438a-5919-4f59-9e4a-817f0e57d1a3", "name": "Create or Update Promotion or Tax", "request": { "name": "Create or Update Promotion or Tax", @@ -699,7 +699,7 @@ "variable": [ { "description": { - "content": "Name of the VTEX account. Used as part of the URL", + "content": "Name of the VTEX account. Used as part of the URL.", "type": "text/plain" }, "type": "any", @@ -730,7 +730,7 @@ "method": "POST", "body": { "mode": "raw", - "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 \"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}", + "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": { "language": "json" @@ -743,7 +743,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "f746742d-ef75-4b75-a923-385a804f66c0", + "id": "a8553a6c-9773-4c7c-a1ea-0f05dc770c6d", "name": "OK", "originalRequest": { "url": { @@ -760,7 +760,7 @@ "variable": [ { "description": { - "content": "Name of the VTEX account. Used as part of the URL", + "content": "Name of the VTEX account. Used as part of the URL.", "type": "text/plain" }, "type": "any", @@ -813,7 +813,7 @@ "method": "POST", "body": { "mode": "raw", - "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 \"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}", + "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": { "language": "json" @@ -829,7 +829,7 @@ "value": "application/json" } ], - "body": "{\n \"idCalculatorConfiguration\": \"d8a1cd2e-b667-4054-b3ae-b79124c7218e\",\n \"name\": \"Promoção Social Seller\",\n \"beginDateUtc\": \"2020-05-01T18:47:15.89Z\",\n \"lastModified\": \"2021-02-23T20:58:38.7963862Z\",\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\": 0,\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 {\n \"id\": \"202\",\n \"name\": \"Dinheiro (202)\"\n },\n {\n \"id\": \"2\",\n \"name\": \"Visa (2)\"\n }\n ],\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 \"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}", + "body": "{\n \"idCalculatorConfiguration\": \"d8a1cd2e-b667-4054-b3ae-b79124c7218e\",\n \"name\": \"Promoção Social Seller\",\n \"beginDateUtc\": \"2020-05-01T18:47:15.89Z\",\n \"lastModified\": \"2021-02-23T20:58:38.7963862Z\",\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\": 0,\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 {\n \"id\": \"202\",\n \"name\": \"Dinheiro (202)\"\n },\n {\n \"id\": \"2\",\n \"name\": \"Visa (2)\"\n }\n ],\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}", "cookie": [] } ], @@ -837,13 +837,13 @@ { "listen": "test", "script": { - "id": "23683911-98b0-48e5-b1eb-cbcf20d9248e", + "id": "9c577a81-4925-41ff-b146-95cac5450d56", "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},\"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},\"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},\"campaigns\":{\"type\":\"array\",\"description\":\"Campaign Audiences that activate this promotion.\"},\"conditionsIds\":{\"type\":\"array\",\"description\":\"Array with conditions IDs.\",\"items\":{\"type\":\"string\",\"description\":\"Condition ID.\"}},\"storesAreInclusive\":{\"type\":\"boolean\",\"deprecated\":true},\"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\":\"string\",\"description\":\"Collection ID.\"}},\"collections2BuyTogether\":{\"type\":\"array\",\"deprecated\":true},\"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\":\"SKU first list for the promotion **Buy Together**.\"},\"listSku2BuyTogether\":{\"type\":\"array\",\"description\":\"SKU second list for the promotion **Buy Together**.\"},\"coupon\":{\"type\":\"array\",\"deprecated\":true},\"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},\"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},\"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\":{}},\"itemMaxPrice\":{\"type\":\"number\",\"description\":\"Maximum price of the item.\"},\"itemMinPrice\":{\"type\":\"number\",\"description\":\"Minimum price of the item.\"},\"installment\":{\"type\":\"integer\",\"deprecated\":true},\"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},\"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.\",\"example\":\"email contains user@mail.com\"}},\"paymentsRules\":{\"type\":\"array\",\"deprecated\":true},\"giftListTypes\":{\"type\":\"array\",\"description\":\"Gifts List Type.\",\"items\":{\"type\":\"string\",\"description\":\"Gift List Type.\"}},\"productsSpecifications\":{\"type\":\"array\",\"deprecated\":true},\"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\",\"deprecated\":true,\"description\":\"Disable deal.\"},\"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.\"}},\"conditionsIds\":{\"type\":\"array\",\"description\":\"Array with conditions IDs.\",\"items\":{\"type\":\"string\",\"description\":\"Condition ID.\"}},\"storesAreInclusive\":{\"type\":\"boolean\",\"deprecated\":true,\"description\":\"Stores are inclusive.\"},\"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\":\"string\",\"description\":\"Collection ID.\"}},\"collections2BuyTogether\":{\"type\":\"array\",\"deprecated\":true,\"description\":\"List of item for **Buy Together**.\",\"items\":{\"type\":\"string\",\"description\":\"Item for **Buy Together**.\"}},\"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.\"}},\"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 include 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\",\"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" ] } } @@ -853,7 +853,7 @@ } }, { - "id": "93fa5982-722a-456b-adf2-51bfeed81196", + "id": "756171d7-6491-44f4-8828-444080a57712", "name": "Create Multiple SKU Promotion", "request": { "name": "Create Multiple SKU Promotion", @@ -876,7 +876,7 @@ "variable": [ { "description": { - "content": "Name of the VTEX account. Used as part of the URL", + "content": "Name of the VTEX account. Used as part of the URL.", "type": "text/plain" }, "type": "any", @@ -973,7 +973,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "fc6212de-6773-4b05-b135-dbc001abfe23", + "id": "1f36216e-37fc-4a95-b076-eb8118146e42", "name": "OK", "originalRequest": { "url": { @@ -991,7 +991,7 @@ "variable": [ { "description": { - "content": "Name of the VTEX account. Used as part of the URL", + "content": "Name of the VTEX account. Used as part of the URL.", "type": "text/plain" }, "type": "any", @@ -1121,7 +1121,7 @@ { "listen": "test", "script": { - "id": "971c7099-4f7b-4d69-9ed6-2958fc63d584", + "id": "d23c7377-7906-46c0-94b3-5375f751c8e8", "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" @@ -1134,7 +1134,7 @@ } }, { - "id": "64d76627-99b4-4847-80fa-afaf6fd9cf78", + "id": "95e805b5-147e-4af8-beb3-76a801d9265a", "name": "Update Multiple SKU Promotion", "request": { "name": "Update Multiple SKU Promotion", @@ -1168,7 +1168,7 @@ }, { "description": { - "content": "Name of the VTEX account. Used as part of the URL", + "content": "Name of the VTEX account. Used as part of the URL.", "type": "text/plain" }, "type": "any", @@ -1265,7 +1265,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "cb877fee-bac8-4fdf-b64c-6acad6967dd7", + "id": "4033c135-8358-4155-8b85-0959ba34425b", "name": "Accepted", "originalRequest": { "url": { @@ -1294,7 +1294,7 @@ }, { "description": { - "content": "Name of the VTEX account. Used as part of the URL", + "content": "Name of the VTEX account. Used as part of the URL.", "type": "text/plain" }, "type": "any", @@ -1424,7 +1424,7 @@ { "listen": "test", "script": { - "id": "05a229bb-77c3-43b5-b199-69a6414e4ae4", + "id": "13ee8bc8-4278-4113-98bd-f3612c17321a", "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" @@ -1437,7 +1437,7 @@ } }, { - "id": "c43e116f-771f-4ba7-a5c1-1b7691751391", + "id": "83c95f94-a95d-4772-bf18-fabafb985cf3", "name": "Archive Promotion or Tax", "request": { "name": "Archive Promotion or Tax", @@ -1471,7 +1471,7 @@ }, { "description": { - "content": "Name of the VTEX account. Used as part of the URL", + "content": "Name of the VTEX account. Used as part of the URL.", "type": "text/plain" }, "type": "any", @@ -1496,7 +1496,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "2fb64eab-3307-4b34-8b76-7c1e09222484", + "id": "4c5ee6d0-0fe9-4d15-937c-f339a248c537", "name": "No Content", "originalRequest": { "url": { @@ -1525,7 +1525,7 @@ }, { "description": { - "content": "Name of the VTEX account. Used as part of the URL", + "content": "Name of the VTEX account. Used as part of the URL.", "type": "text/plain" }, "type": "any", @@ -1590,7 +1590,7 @@ { "listen": "test", "script": { - "id": "ed86c749-44ec-45d1-a203-1b10eb2a5cf5", + "id": "1408af3a-af07-413f-acc1-27defa1f6433", "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", @@ -1604,7 +1604,7 @@ } }, { - "id": "61cc0526-ad85-4015-97ca-d288c288188d", + "id": "7a754560-2f78-4885-a371-6b0de6147076", "name": "Unarchive Promotion or Tax", "request": { "name": "Unarchive Promotion or Tax", @@ -1638,7 +1638,7 @@ }, { "description": { - "content": "Name of the VTEX account. Used as part of the URL", + "content": "Name of the VTEX account. Used as part of the URL.", "type": "text/plain" }, "type": "any", @@ -1663,7 +1663,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "da170b2f-2d53-4fae-9497-5334f736c61d", + "id": "139e9ae2-a5fa-431a-ab49-c6943c1d6721", "name": "No Content", "originalRequest": { "url": { @@ -1692,7 +1692,7 @@ }, { "description": { - "content": "Name of the VTEX account. Used as part of the URL", + "content": "Name of the VTEX account. Used as part of the URL.", "type": "text/plain" }, "type": "any", @@ -1757,7 +1757,7 @@ { "listen": "test", "script": { - "id": "02ee26d7-ae58-48e5-bbd1-829c88e20ad8", + "id": "fbfd80fb-27ac-409e-8855-96ee3d03afc6", "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", @@ -1771,7 +1771,7 @@ } }, { - "id": "fe0d2a32-9f6c-4f02-bd05-cfb3e1eef905", + "id": "347e61f2-dbe5-4ea8-ac39-ef73a364e0fa", "name": "List Archived Promotions", "request": { "name": "List Archived Promotions", @@ -1795,7 +1795,7 @@ "variable": [ { "description": { - "content": "Name of the VTEX account. Used as part of the URL", + "content": "Name of the VTEX account. Used as part of the URL.", "type": "text/plain" }, "type": "any", @@ -1826,7 +1826,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "01c0871e-d59e-45cb-880c-f512fece0771", + "id": "f6d601cb-78a2-4180-8401-1f01bda19ec9", "name": "OK", "originalRequest": { "url": { @@ -1845,7 +1845,7 @@ "variable": [ { "description": { - "content": "Name of the VTEX account. Used as part of the URL", + "content": "Name of the VTEX account. Used as part of the URL.", "type": "text/plain" }, "type": "any", @@ -1914,13 +1914,13 @@ { "listen": "test", "script": { - "id": "e5d31ce6-076f-4c39-aa52-0fb7e31ff4a3", + "id": "8888bdfb-9091-437d-a859-d23fadb97b22", "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", "// Validate if response header has matching content-type\npm.test(\"[GET]::/api/rnb/pvt/archive/benefits/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(\"[GET]::/api/rnb/pvt/archive/benefits/calculatorConfiguration - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"type\":\"object\",\"description\":\"Response object.\",\"properties\":{\"items\":{\"type\":\"array\",\"description\":\"Array with promotions.\",\"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\":\"Array with campaign audiences that activate this promotion.\",\"type\":\"array\",\"items\":{\"type\":\"string\",\"description\":\"Campaign Audience.\",\"example\":\"Campaign Audience example\"}},\"activateGiftsMultiplier\":{\"description\":\"If set as `true`, it activates gifts Multiplier.\",\"type\":\"boolean\",\"example\":false},\"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\",\"example\":false},\"skus\":{\"description\":\"Quantity of SKUs which activate or deactivate the promotion.\",\"type\":\"number\",\"example\":1},\"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\",\"example\":true},\"products\":{\"description\":\"Quantity of products which activate or deactivate the promotion.\",\"type\":\"number\",\"example\":1},\"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\",\"example\":true},\"collections\":{\"description\":\"Quantity of collections which activate or deactivate the promotion.\",\"type\":\"number\",\"example\":1},\"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\",\"example\":true},\"categories\":{\"description\":\"Quantity of categories which activate or deactivate the promotion.\",\"type\":\"number\",\"example\":1},\"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.\",\"example\":true},\"brands\":{\"description\":\"Quantity of brands which activate or deactivate the promotion.\",\"type\":\"number\",\"example\":1},\"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\",\"example\":true},\"sellers\":{\"description\":\"Quantity of sellers which activate or deactivate the promotion.\",\"type\":\"number\",\"example\":0},\"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\",\"example\":false}}},\"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.\"}}}},\"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.\",\"example\":\"item\"}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/rnb/pvt/archive/benefits/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\",\"description\":\"Response object.\",\"properties\":{\"items\":{\"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\":{\"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.\"}}}},\"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.\"}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/rnb/pvt/archive/benefits/calculatorConfiguration - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -1930,7 +1930,7 @@ } }, { - "id": "63a4d616-bf7b-495a-815f-67a25dad836f", + "id": "d869a92f-683b-4a76-b6af-d7ac26153125", "name": "List Archived Taxes", "request": { "name": "List Archived Taxes", @@ -1954,7 +1954,7 @@ "variable": [ { "description": { - "content": "Name of the VTEX account. Used as part of the URL", + "content": "Name of the VTEX account. Used as part of the URL.", "type": "text/plain" }, "type": "any", @@ -1985,7 +1985,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "87d6c601-43de-4594-958c-6758344adba0", + "id": "53470fe4-84e7-4ada-8312-9901e5cd6f3e", "name": "OK", "originalRequest": { "url": { @@ -2004,7 +2004,7 @@ "variable": [ { "description": { - "content": "Name of the VTEX account. Used as part of the URL", + "content": "Name of the VTEX account. Used as part of the URL.", "type": "text/plain" }, "type": "any", @@ -2073,13 +2073,13 @@ { "listen": "test", "script": { - "id": "eea392c5-e7ee-48e4-ab58-71d3c634fe32", + "id": "ae48afb1-c008-4c71-9582-f2dc46ec4742", "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", "// Validate if response header has matching content-type\npm.test(\"[GET]::/api/rnb/pvt/archive/taxes/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(\"[GET]::/api/rnb/pvt/archive/taxes/calculatorConfiguration - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"type\":\"object\",\"description\":\"Response object.\",\"properties\":{\"items\":{\"type\":\"array\",\"description\":\"Array with taxes.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information about a tax.\",\"properties\":{\"idCalculatorConfiguration\":{\"type\":\"string\",\"description\":\"Tax ID.\"},\"lastModifiedUtc\":{\"type\":\"string\",\"description\":\"Date and time when the tax was last modified (UTC).\"},\"name\":{\"type\":\"string\",\"description\":\"Tax name.\"},\"beginDate\":{\"type\":\"string\",\"description\":\"Tax start date (UTC).\"},\"endDate\":{\"type\":\"string\",\"description\":\"Tax end date (UTC).\"},\"isActive\":{\"type\":\"boolean\",\"description\":\"If set as `true` the tax is activated. If set as `false` the tax is deactivated.\"},\"description\":{\"type\":\"string\",\"description\":\"Tax internal description.\"},\"type\":{\"description\":\"Defines the type of tax.\",\"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 tax.\"},\"percentualTax\":{\"type\":\"number\",\"description\":\"Percentual tax applied.\"},\"isArchived\":{\"type\":\"boolean\",\"description\":\"If set as `true` the tax is archived. If set as `false` the tax 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\":\"Array with campaign audiences that activate this tax.\",\"type\":\"array\",\"items\":{\"type\":\"string\",\"description\":\"Campaign Audience.\",\"example\":\"Campaign Audience example\"}},\"activateGiftsMultiplier\":{\"description\":\"If set as `true`, it activates gifts Multiplier.\",\"type\":\"boolean\",\"example\":false},\"scope\":{\"description\":\"Scope of the tax.\",\"type\":\"object\",\"properties\":{\"allCatalog\":{\"description\":\"Determines if the tax applies to all products in the Catalog (`true`) or not (`false`).\",\"type\":\"boolean\",\"example\":false},\"skus\":{\"description\":\"Quantity of SKUs which activate or deactivate the tax.\",\"type\":\"number\",\"example\":1},\"skusAreInclusive\":{\"description\":\"If set to `true`, this tax will be applied to any SKU present on the `skus` field. If set to `false`, SKUs present on that field will make this tax not to be applied.\",\"type\":\"boolean\",\"example\":true},\"products\":{\"description\":\"Quantity of products which activate or deactivate the tax.\",\"type\":\"number\",\"example\":1},\"productsAreInclusive\":{\"description\":\"If set to `true`, this tax will be applied to any product present on the `products` field. If set to `false`, products present on that field will make this tax not to be applied.\",\"type\":\"boolean\",\"example\":true},\"collections\":{\"description\":\"Quantity of collections which activate or deactivate the tax.\",\"type\":\"number\",\"example\":1},\"collectionsAreInclusive\":{\"description\":\"If set to `true`, this tax will be applied to any collection present on the `collections` field. If set to `false`, collections present on that field will make this tax not to be applied.\",\"type\":\"boolean\",\"example\":true},\"categories\":{\"description\":\"Quantity of categories which activate or deactivate the tax.\",\"type\":\"number\",\"example\":1},\"categoriesAreInclusive\":{\"type\":\"boolean\",\"description\":\"If set to `true`, this tax will be applied to any category present on the `categories` field. If set to `false`, categories present on that field will make this tax not to be applied.\",\"example\":true},\"brands\":{\"description\":\"Quantity of brands which activate or deactivate the tax.\",\"type\":\"number\",\"example\":1},\"brandsAreInclusive\":{\"description\":\"If set to `true`, this tax will be applied to any brand present on the `brands` field. If set to `false`, brands present on that field will make this tax not to be applied.\",\"type\":\"boolean\",\"example\":true},\"sellers\":{\"description\":\"Quantity of sellers which activate or deactivate the tax.\",\"type\":\"number\",\"example\":0},\"sellersAreInclusive\":{\"description\":\"If set to `true`, this tax will be applied to any seller present on the `sellers` field. If set to `false`, sellers present on that field will make this tax not to be applied.\",\"type\":\"boolean\",\"example\":false}}},\"maxUsage\":{\"type\":\"number\",\"description\":\"Defines how many times the tax can be used.\"},\"idsSalesChannel\":{\"type\":\"array\",\"description\":\"List of Trade Policies that activate this tax.\",\"items\":{\"type\":\"string\",\"description\":\"Trade Policy ID.\"}},\"areSalesChannelIdsExclusive\":{\"type\":\"boolean\",\"description\":\"If set to `false`, this tax will be applied to any trade policies present on the `idsSalesChannel` field. If set to `true`, trade policies present on that field will make this tax not to be applied.\"}}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/rnb/pvt/archive/taxes/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\",\"description\":\"Response object.\",\"properties\":{\"items\":{\"type\":\"array\",\"description\":\"Array with taxes.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information about a tax.\",\"properties\":{\"idCalculatorConfiguration\":{\"type\":\"string\",\"description\":\"Tax ID.\"},\"lastModifiedUtc\":{\"type\":\"string\",\"description\":\"Date and time when the tax was last modified (UTC).\"},\"name\":{\"type\":\"string\",\"description\":\"Tax name.\"},\"beginDate\":{\"type\":\"string\",\"description\":\"Tax start date (UTC).\"},\"endDate\":{\"type\":\"string\",\"description\":\"Tax end date (UTC).\"},\"isActive\":{\"type\":\"boolean\",\"description\":\"If set as `true` the tax is activated. If set as `false` the tax is deactivated.\"},\"description\":{\"type\":\"string\",\"description\":\"Tax internal description.\"},\"type\":{\"description\":\"Defines the type of tax.\",\"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 tax.\"},\"percentualTax\":{\"type\":\"number\",\"description\":\"Percentual tax applied.\"},\"isArchived\":{\"type\":\"boolean\",\"description\":\"If set as `true` the tax is archived. If set as `false` the tax 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\":{\"type\":\"array\",\"description\":\"Campaign Audiences that activate this promotion.\",\"items\":{\"type\":\"string\",\"description\":\"Campaign.\"}},\"activateGiftsMultiplier\":{\"description\":\"If set as `true`, it activates gifts Multiplier.\",\"type\":\"boolean\"},\"scope\":{\"description\":\"Scope of the tax.\",\"type\":\"object\",\"properties\":{\"allCatalog\":{\"description\":\"Determines if the tax applies to all products in the Catalog (`true`) or not (`false`).\",\"type\":\"boolean\"},\"skus\":{\"description\":\"Quantity of SKUs which activate or deactivate the tax.\",\"type\":\"number\"},\"skusAreInclusive\":{\"description\":\"If set to `true`, this tax will be applied to any SKU present on the `skus` field. If set to `false`, SKUs present on that field will make this tax not to be applied.\",\"type\":\"boolean\"},\"products\":{\"description\":\"Quantity of products which activate or deactivate the tax.\",\"type\":\"number\"},\"productsAreInclusive\":{\"description\":\"If set to `true`, this tax will be applied to any product present on the `products` field. If set to `false`, products present on that field will make this tax not to be applied.\",\"type\":\"boolean\"},\"collections\":{\"description\":\"Quantity of collections which activate or deactivate the tax.\",\"type\":\"number\"},\"collectionsAreInclusive\":{\"description\":\"If set to `true`, this tax will be applied to any collection present on the `collections` field. If set to `false`, collections present on that field will make this tax not to be applied.\",\"type\":\"boolean\"},\"categories\":{\"description\":\"Quantity of categories which activate or deactivate the tax.\",\"type\":\"number\"},\"categoriesAreInclusive\":{\"type\":\"boolean\",\"description\":\"If set to `true`, this tax will be applied to any category present on the `categories` field. If set to `false`, categories present on that field will make this tax not to be applied.\"},\"brands\":{\"description\":\"Quantity of brands which activate or deactivate the tax.\",\"type\":\"number\"},\"brandsAreInclusive\":{\"description\":\"If set to `true`, this tax will be applied to any brand present on the `brands` field. If set to `false`, brands present on that field will make this tax not to be applied.\",\"type\":\"boolean\"},\"sellers\":{\"description\":\"Quantity of sellers which activate or deactivate the tax.\",\"type\":\"number\"},\"sellersAreInclusive\":{\"description\":\"If set to `true`, this tax will be applied to any seller present on the `sellers` field. If set to `false`, sellers present on that field will make this tax not to be applied.\",\"type\":\"boolean\"}}},\"maxUsage\":{\"type\":\"number\",\"description\":\"Defines how many times the tax can be used.\"},\"idsSalesChannel\":{\"type\":\"array\",\"description\":\"List of Trade Policies that activate this tax.\",\"items\":{\"type\":\"string\",\"description\":\"Trade Policy ID.\"}},\"areSalesChannelIdsExclusive\":{\"type\":\"boolean\",\"description\":\"If set to `false`, this tax will be applied to any trade policies present on the `idsSalesChannel` field. If set to `true`, trade policies present on that field will make this tax not to be applied.\"}}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/rnb/pvt/archive/taxes/calculatorConfiguration - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -2092,7 +2092,7 @@ "event": [] }, { - "id": "7adc0d3d-5c8d-417e-bba4-f2a231fbbf44", + "id": "10a58aa2-b492-4e22-bf95-7226a58151ab", "name": "Coupons", "description": { "content": "", @@ -2100,7 +2100,7 @@ }, "item": [ { - "id": "3a91c706-c1b7-4edb-9b2c-147adcc9c3e3", + "id": "62ed975a-5714-4894-8844-9b48a4ff380f", "name": "Create multiple coupons", "request": { "name": "Create multiple coupons", @@ -2122,7 +2122,7 @@ "variable": [ { "description": { - "content": "Name of the VTEX account. Used as part of the URL", + "content": "Name of the VTEX account. Used as part of the URL.", "type": "text/plain" }, "type": "any", @@ -2166,7 +2166,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "b9098e49-b329-4d13-a7ad-c3023cca87c4", + "id": "4bc32f1c-20de-43c2-b99a-037ce25bd6c1", "name": "OK", "originalRequest": { "url": { @@ -2183,7 +2183,7 @@ "variable": [ { "description": { - "content": "Name of the VTEX account. Used as part of the URL", + "content": "Name of the VTEX account. Used as part of the URL.", "type": "text/plain" }, "type": "any", @@ -2260,13 +2260,13 @@ { "listen": "test", "script": { - "id": "dabb2e0f-d777-45c4-8e83-f7331ea3d926", + "id": "23524df6-f637-49f7-a543-ad887b98562b", "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", "// Validate if response header has matching content-type\npm.test(\"[POST]::/api/rnb/pvt/multiple-coupons - 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/multiple-coupons - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"type\":\"array\",\"description\":\"Array with the coupon codes that were created.\",\"items\":{\"type\":\"string\",\"description\":\"Coupon code.\",\"example\":\"promobf\"}}\n\n// Validate if response matches JSON schema \npm.test(\"[POST]::/api/rnb/pvt/multiple-coupons - 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 with the coupon codes that were created.\",\"items\":{\"type\":\"string\",\"description\":\"Coupon code.\"}}\n\n// Validate if response matches JSON schema \npm.test(\"[POST]::/api/rnb/pvt/multiple-coupons - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -2276,7 +2276,7 @@ } }, { - "id": "f6d0f6c7-c9f2-4311-9aab-c3408a8ffccd", + "id": "08afd712-44d8-43e0-afaa-e2d646cd013e", "name": "Create or update coupon", "request": { "name": "Create or update coupon", @@ -2298,7 +2298,7 @@ "variable": [ { "description": { - "content": "Name of the VTEX account. Used as part of the URL", + "content": "Name of the VTEX account. Used as part of the URL.", "type": "text/plain" }, "type": "any", @@ -2342,7 +2342,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "a90426c1-fd05-4be6-ad11-2433f5c86f17", + "id": "6f2b98b8-5a07-4b76-8ec5-d8fc653febea", "name": "OK", "originalRequest": { "url": { @@ -2359,7 +2359,7 @@ "variable": [ { "description": { - "content": "Name of the VTEX account. Used as part of the URL", + "content": "Name of the VTEX account. Used as part of the URL.", "type": "text/plain" }, "type": "any", @@ -2435,7 +2435,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "37f5f202-0641-498f-a428-974a24631f48", + "id": "4f7d18ec-478d-437d-9f79-a995e79b6ccb", "name": "Created", "originalRequest": { "url": { @@ -2452,7 +2452,7 @@ "variable": [ { "description": { - "content": "Name of the VTEX account. Used as part of the URL", + "content": "Name of the VTEX account. Used as part of the URL.", "type": "text/plain" }, "type": "any", @@ -2529,7 +2529,7 @@ { "listen": "test", "script": { - "id": "ad769b09-21e4-477c-a1dd-c54aab8ee80d", + "id": "897a6077-efb9-4671-96bb-2dce253fbaae", "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", @@ -2545,7 +2545,7 @@ } }, { - "id": "32669337-275b-44fc-9b5e-fd3147d111bb", + "id": "38016443-6d30-4f4a-b3e9-35c626035198", "name": "Get all coupons", "request": { "name": "Get all coupons", @@ -2567,7 +2567,7 @@ "variable": [ { "description": { - "content": "Name of the VTEX account. Used as part of the URL", + "content": "Name of the VTEX account. Used as part of the URL.", "type": "text/plain" }, "type": "any", @@ -2598,7 +2598,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "1be74a68-776b-436c-ac5c-1f69fb45d365", + "id": "c842a71b-0015-40f7-9bf6-5aa59f52ea71", "name": "OK", "originalRequest": { "url": { @@ -2615,7 +2615,7 @@ "variable": [ { "description": { - "content": "Name of the VTEX account. Used as part of the URL", + "content": "Name of the VTEX account. Used as part of the URL.", "type": "text/plain" }, "type": "any", @@ -2684,13 +2684,13 @@ { "listen": "test", "script": { - "id": "25c9a267-4733-42b7-bc3b-b19a275f3e16", + "id": "42abe59d-c8cd-465a-a69e-eb0ea71691e7", "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", "// Validate if response header has matching content-type\npm.test(\"[GET]::/api/rnb/pvt/coupon - 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/coupon - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"type\":\"array\",\"items\":{\"type\":\"object\",\"description\":\"Object with information about the coupon.\",\"properties\":{\"lastModifiedUtc\":{\"type\":\"string\",\"description\":\"Date and time of the last update of the coupon in UTC format.\"},\"utmSource\":{\"type\":\"string\",\"description\":\"UTM source code.\"},\"utmCampaign\":{\"type\":\"string\",\"description\":\"UTM campaign code.\"},\"couponCode\":{\"type\":\"string\",\"description\":\"Coupon code.\"},\"isArchived\":{\"type\":\"boolean\",\"description\":\"Defines if the coupon is archived (`true`) or not (`false`).\"},\"maxItemsPerClient\":{\"type\":\"integer\",\"description\":\"Maximum items per client that the coupon can be applied.\"},\"expirationIntervalPerUse\":{\"type\":\"string\",\"description\":\"Coupon expiration interval per use.\"},\"maxUsage\":{\"type\":\"integer\",\"description\":\"Amount of times the coupon can be used.\"},\"groupingKey\":{\"type\":\"string\",\"description\":\"If the coupon was created as a [multiple coupon](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api/#post-/api/rnb/pvt/multiple-coupons) or using [Coupon Massive Generation](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api/#post-/api/rnb/pvt/coupons), this field returns the original `couponCode` informed.\"}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/rnb/pvt/coupon - 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 coupons.\",\"items\":{\"type\":\"object\",\"description\":\"Object with information about the coupon.\",\"properties\":{\"lastModifiedUtc\":{\"type\":\"string\",\"description\":\"Date and time of the last update of the coupon in UTC format.\"},\"utmSource\":{\"type\":\"string\",\"description\":\"UTM source code.\"},\"utmCampaign\":{\"type\":\"string\",\"description\":\"UTM campaign code.\"},\"couponCode\":{\"type\":\"string\",\"description\":\"Coupon code.\"},\"isArchived\":{\"type\":\"boolean\",\"description\":\"Defines if the coupon is archived (`true`) or not (`false`).\"},\"maxItemsPerClient\":{\"type\":\"integer\",\"description\":\"Maximum items per client that the coupon can be applied.\"},\"expirationIntervalPerUse\":{\"type\":\"string\",\"description\":\"Coupon expiration interval per use.\"},\"maxUsage\":{\"type\":\"integer\",\"description\":\"Amount of times the coupon can be used.\"},\"groupingKey\":{\"type\":\"string\",\"description\":\"If the coupon was created as a [multiple coupon](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api/#post-/api/rnb/pvt/multiple-coupons) or using [Coupon Massive Generation](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api/#post-/api/rnb/pvt/coupons), this field returns the original `couponCode` informed.\"}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/rnb/pvt/coupon - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -2700,7 +2700,7 @@ } }, { - "id": "3693c29d-b48d-463d-974b-31eceea33fba", + "id": "c7f66bfd-4c28-4cb4-a528-7e0a806f7f48", "name": "Get coupon by coupon code", "request": { "name": "Get coupon by coupon code", @@ -2733,7 +2733,7 @@ }, { "description": { - "content": "Name of the VTEX account. Used as part of the URL", + "content": "Name of the VTEX account. Used as part of the URL.", "type": "text/plain" }, "type": "any", @@ -2764,7 +2764,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "64b06698-b070-4c48-9ece-98d8d8621584", + "id": "548623e1-2ea0-410f-af25-5ca6521c419c", "name": "OK", "originalRequest": { "url": { @@ -2792,7 +2792,7 @@ }, { "description": { - "content": "Name of the VTEX account. Used as part of the URL", + "content": "Name of the VTEX account. Used as part of the URL.", "type": "text/plain" }, "type": "any", @@ -2861,7 +2861,7 @@ { "listen": "test", "script": { - "id": "ca223e2a-1f1a-4656-8253-003dddbaa729", + "id": "de96cc69-47c1-4bf8-9d77-80748a36a9f3", "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", @@ -2877,7 +2877,7 @@ } }, { - "id": "2c1f06a3-f371-4233-ab26-c19d899b0586", + "id": "3d42b91e-1e76-4cc8-a350-47c86875c40a", "name": "Get archived coupon by coupon code", "request": { "name": "Get archived coupon by coupon code", @@ -2911,7 +2911,7 @@ }, { "description": { - "content": "Name of the VTEX account. Used as part of the URL", + "content": "Name of the VTEX account. Used as part of the URL.", "type": "text/plain" }, "type": "any", @@ -2942,7 +2942,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "32fea9bd-422e-4d82-b21d-05e509f5e225", + "id": "64a98514-62d1-4159-9fdc-00953ce664d6", "name": "OK", "originalRequest": { "url": { @@ -2971,7 +2971,7 @@ }, { "description": { - "content": "Name of the VTEX account. Used as part of the URL", + "content": "Name of the VTEX account. Used as part of the URL.", "type": "text/plain" }, "type": "any", @@ -3040,7 +3040,7 @@ { "listen": "test", "script": { - "id": "7eca2238-ebad-4f4a-9835-8507bb13409d", + "id": "db6e682b-9d4b-46c0-a805-19c1af8a3ec1", "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", @@ -3056,12 +3056,12 @@ } }, { - "id": "853ab062-2815-49b0-8761-89f84742cd55", + "id": "bd38996a-fc03-48cf-8060-9d67fbdfd751", "name": "Archive coupon by coupon code", "request": { "name": "Archive coupon by coupon code", "description": { - "content": "Archives a specifc coupon by its coupon code.", + "content": "Archives a specific coupon by its coupon code.", "type": "text/plain" }, "url": { @@ -3090,7 +3090,7 @@ }, { "description": { - "content": "Name of the VTEX account. Used as part of the URL", + "content": "Name of the VTEX account. Used as part of the URL.", "type": "text/plain" }, "type": "any", @@ -3121,7 +3121,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "283e1013-8b82-42dc-93fd-c528d63aea95", + "id": "4fb0df32-4c8e-4291-839f-4606c1872553", "name": "OK", "originalRequest": { "url": { @@ -3150,7 +3150,7 @@ }, { "description": { - "content": "Name of the VTEX account. Used as part of the URL", + "content": "Name of the VTEX account. Used as part of the URL.", "type": "text/plain" }, "type": "any", @@ -3219,7 +3219,7 @@ { "listen": "test", "script": { - "id": "1b6476d7-4ba2-4f3c-baba-4f47b5d5d5a8", + "id": "1b166e41-f9a7-430d-a0c5-402b4d34db9b", "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", @@ -3235,7 +3235,7 @@ } }, { - "id": "e9e0279e-da6c-46cc-a78d-4ed83a14bda4", + "id": "902e417b-07f6-406e-bbc3-3474c0c74f0c", "name": "Coupon Massive Generation", "request": { "name": "Coupon Massive Generation", @@ -3267,7 +3267,7 @@ "variable": [ { "description": { - "content": "Name of the VTEX account. Used as part of the URL", + "content": "Name of the VTEX account. Used as part of the URL.", "type": "text/plain" }, "type": "any", @@ -3311,7 +3311,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "b7fbdc7e-50ae-4c67-842a-bdae3f201f23", + "id": "30583a99-a5f2-4a7a-abc5-a4b8f3b739d1", "name": "OK", "originalRequest": { "url": { @@ -3333,7 +3333,7 @@ "variable": [ { "description": { - "content": "Name of the VTEX account. Used as part of the URL", + "content": "Name of the VTEX account. Used as part of the URL.", "type": "text/plain" }, "type": "any", @@ -3410,7 +3410,7 @@ { "listen": "test", "script": { - "id": "5d17c899-7654-44fc-b349-138b508e0725", + "id": "5a687c0d-e34b-4ef2-aaa8-ba4eedd735ad", "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", @@ -3426,7 +3426,7 @@ } }, { - "id": "70116037-af51-47e2-bf66-457920fe2f68", + "id": "3a84b0cb-b9b7-4ccc-a0b0-dd7a07735416", "name": "Get coupon usage", "request": { "name": "Get coupon usage", @@ -3460,7 +3460,7 @@ }, { "description": { - "content": "Name of the VTEX account. Used as part of the URL", + "content": "Name of the VTEX account. Used as part of the URL.", "type": "text/plain" }, "type": "any", @@ -3491,7 +3491,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "8591c564-1f7c-47cc-92c7-599f3718ea64", + "id": "fc76a2dd-a4e3-4576-be40-4d9b34ac1c0f", "name": "OK", "originalRequest": { "url": { @@ -3520,7 +3520,7 @@ }, { "description": { - "content": "Name of the VTEX account. Used as part of the URL", + "content": "Name of the VTEX account. Used as part of the URL.", "type": "text/plain" }, "type": "any", @@ -3589,7 +3589,7 @@ { "listen": "test", "script": { - "id": "48d24a3a-36dc-49bc-96b0-1745ba833aa6", + "id": "a9a8c3de-4307-42ce-b9d7-81334a906fed", "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", @@ -3605,7 +3605,7 @@ } }, { - "id": "33be7a2b-4ef3-4c1c-92dc-c477891b72a1", + "id": "f6b00eae-866c-4dbd-a70a-f3a26bebc431", "name": "Unarchive coupon by coupon code", "request": { "name": "Unarchive coupon by coupon code", @@ -3639,7 +3639,7 @@ }, { "description": { - "content": "Name of the VTEX account. Used as part of the URL", + "content": "Name of the VTEX account. Used as part of the URL.", "type": "text/plain" }, "type": "any", @@ -3670,7 +3670,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "a1724ca9-54cd-423a-a4c5-338d34dce966", + "id": "b6d1447a-bed4-4f56-9365-03e56e9071a1", "name": "OK", "originalRequest": { "url": { @@ -3699,7 +3699,7 @@ }, { "description": { - "content": "Name of the VTEX account. Used as part of the URL", + "content": "Name of the VTEX account. Used as part of the URL.", "type": "text/plain" }, "type": "any", @@ -3768,7 +3768,7 @@ { "listen": "test", "script": { - "id": "6c5d4333-7a6d-475e-a201-34292f58f189", + "id": "7f9604f7-b3cf-40f6-9119-92984f007fbc", "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", @@ -3787,7 +3787,7 @@ "event": [] }, { - "id": "224aaddd-d507-4736-a41f-877e38a19c48", + "id": "94b8090a-7962-4062-b98c-46ae9386a983", "name": "Campaign Audiences", "description": { "content": "", @@ -3795,7 +3795,7 @@ }, "item": [ { - "id": "3e0e41cf-7012-4bc2-8b10-1830d67122de", + "id": "60261f6e-8270-415e-bf38-47c8805c7bea", "name": "Get campaign audience configuration", "request": { "name": "Get campaign audience configuration", @@ -3828,7 +3828,7 @@ }, { "description": { - "content": "Name of the VTEX account. Used as part of the URL", + "content": "Name of the VTEX account. Used as part of the URL.", "type": "text/plain" }, "type": "any", @@ -3859,7 +3859,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "1099fde8-a2d8-457a-8daf-db1faaa7221d", + "id": "7cbf160e-2fc6-43c7-b8d0-cd6164a52366", "name": "OK", "originalRequest": { "url": { @@ -3887,7 +3887,7 @@ }, { "description": { - "content": "Name of the VTEX account. Used as part of the URL", + "content": "Name of the VTEX account. Used as part of the URL.", "type": "text/plain" }, "type": "any", @@ -3948,7 +3948,7 @@ "value": "application/json" } ], - "body": "{\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\": false,\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 \"areSalesChannelIdsExclusive\": false,\n \"marketingTags\": [\n \"MKT1\"\n ],\n \"marketingTagsAreNotInclusive\": false,\n \"paymentsMethods\": [],\n \"stores\": [],\n \"campaigns\": [],\n \"storesAreInclusive\": false,\n \"categories\": [],\n \"categoriesAreInclusive\": true,\n \"brands\": [],\n \"brandsAreInclusive\": true,\n \"products\": [],\n \"productsAreInclusive\": false,\n \"skus\": [],\n \"skusAreInclusive\": true,\n \"collections1BuyTogether\": [],\n \"collections2BuyTogether\": [],\n \"minimumQuantityBuyTogether\": 1,\n \"quantityToAffectBuyTogether\": 0,\n \"enableBuyTogetherPerSku\": false,\n \"listSku1BuyTogether\": [],\n \"listSku2BuyTogether\": [],\n \"listBrand1BuyTogether\": [],\n \"listCategory1BuyTogether\": [],\n \"coupon\": [],\n \"totalValueFloor\": 0,\n \"totalValueCeling\": 0,\n \"totalValueIncludeAllItems\": false,\n \"totalValueMode\": \"IncludeMatchedItems\",\n \"collections\": [],\n \"collectionsIsInclusive\": true,\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 \"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 \"clusterOperator\": \"all\",\n \"paymentsRules\": [],\n \"giftListTypes\": [],\n \"productsSpecifications\": [],\n \"affiliates\": [],\n \"maxUsage\": 0,\n \"maxUsagePerClient\": 0,\n \"shouldDistributeDiscountAmongMatchedItems\": false,\n \"multipleUsePerClient\": false,\n \"useNewProgressiveAlgorithm\": false,\n \"percentualDiscountValueList\": []\n }\n ]\n}", + "body": "{\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\": false,\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 \"areSalesChannelIdsExclusive\": false,\n \"marketingTags\": [\n \"MKT1\"\n ],\n \"marketingTagsAreNotInclusive\": false,\n \"paymentsMethods\": [],\n \"stores\": [],\n \"campaigns\": [],\n \"storesAreInclusive\": false,\n \"categories\": [],\n \"categoriesAreInclusive\": true,\n \"brands\": [],\n \"brandsAreInclusive\": true,\n \"products\": [],\n \"productsAreInclusive\": false,\n \"skus\": [],\n \"skusAreInclusive\": true,\n \"collections1BuyTogether\": [],\n \"collections2BuyTogether\": [],\n \"minimumQuantityBuyTogether\": 1,\n \"quantityToAffectBuyTogether\": 0,\n \"enableBuyTogetherPerSku\": false,\n \"listSku1BuyTogether\": [],\n \"listSku2BuyTogether\": [],\n \"listBrand1BuyTogether\": [],\n \"listCategory1BuyTogether\": [\n {\n \"id\": \"1\",\n \"name\": \"Vinhos Tintos (1)\"\n }\n ],\n \"coupon\": [],\n \"totalValueFloor\": 0,\n \"totalValueCeling\": 0,\n \"totalValueIncludeAllItems\": false,\n \"totalValueMode\": \"IncludeMatchedItems\",\n \"collections\": [],\n \"collectionsIsInclusive\": true,\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 \"clusterOperator\": \"all\",\n \"paymentsRules\": [],\n \"giftListTypes\": [],\n \"productsSpecifications\": [],\n \"affiliates\": [],\n \"maxUsage\": 0,\n \"maxUsagePerClient\": 0,\n \"shouldDistributeDiscountAmongMatchedItems\": false,\n \"multipleUsePerClient\": false,\n \"useNewProgressiveAlgorithm\": false,\n \"percentualDiscountValueList\": []\n }\n ]\n}", "cookie": [] } ], @@ -3956,13 +3956,13 @@ { "listen": "test", "script": { - "id": "93e9369e-648b-4258-a57a-3dcb4e51f1af", + "id": "fb5668e3-5811-4edf-9b68-0ae4f89e203b", "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},\"campaigns\":{\"type\":\"array\",\"description\":\"Campaign Audiences that activate this promotion.\"},\"storesAreInclusive\":{\"type\":\"boolean\",\"deprecated\":true},\"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\":\"string\",\"description\":\"Collection ID.\"}},\"collections2BuyTogether\":{\"type\":\"array\",\"deprecated\":true},\"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\":\"SKU first list for the promotion **Buy Together**.\"},\"listSku2BuyTogether\":{\"type\":\"array\",\"description\":\"SKU second list for the promotion **Buy Together**.\"},\"listBrand1BuyTogether\":{\"type\":\"array\",\"description\":\"Brand first list for the promotion **Buy Together.\"},\"listCategory1BuyTogether\":{\"type\":\"array\",\"description\":\"Category first list for the promotion **Buy Together**.\"},\"coupon\":{\"type\":\"array\",\"deprecated\":true},\"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},\"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},\"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 campaign audience.\",\"items\":{\"type\":\"object\",\"description\":\"Zip code that applies the campaign audience.\",\"properties\":{\"inclusive\":{\"type\":\"boolean\",\"description\":\"Defines if the zip code applies the campaign audience.\"}}}},\"itemMaxPrice\":{\"type\":\"number\",\"description\":\"Maximum price of the item.\"},\"itemMinPrice\":{\"type\":\"number\",\"description\":\"Minimum price of the item.\"},\"installment\":{\"type\":\"integer\",\"deprecated\":true},\"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},\"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.\",\"example\":\"email contains user@mail.com\"}},\"paymentsRules\":{\"type\":\"array\",\"deprecated\":true},\"giftListTypes\":{\"type\":\"array\",\"description\":\"Gifts List Type.\",\"items\":{\"type\":\"string\",\"description\":\"Gift List Type.\"}},\"productsSpecifications\":{\"type\":\"array\",\"deprecated\":true},\"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\",\"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\":\"Stores are inclusive.\"},\"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\":\"string\",\"description\":\"Collection ID.\"}},\"collections2BuyTogether\":{\"type\":\"array\",\"deprecated\":true,\"description\":\"List of item for **Buy Together**.\",\"items\":{\"type\":\"string\",\"description\":\"Item for **Buy Together**.\"}},\"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\":\"Brand first list for the promotion **Buy Together.\",\"items\":{\"type\":\"string\",\"description\":\"Brand.\"}},\"listCategory1BuyTogether\":{\"type\":\"array\",\"description\":\"Category first list for the promotion **Buy Together**.\",\"items\":{\"type\":\"object\",\"description\":\"Category.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Category ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Category name.\"}}}},\"coupon\":{\"type\":\"array\",\"deprecated\":true,\"description\":\"List of coupons.\",\"items\":{\"type\":\"string\",\"description\":\"Coupon.\"}},\"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 include 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\",\"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" ] } } @@ -3972,7 +3972,7 @@ } }, { - "id": "e4e37446-fbf5-48ff-b86a-46b35a067955", + "id": "c1cb7b1a-9008-4d2f-b609-ba981084040d", "name": "Get all campaign audiences", "request": { "name": "Get all campaign audiences", @@ -3994,7 +3994,7 @@ "variable": [ { "description": { - "content": "Name of the VTEX account. Used as part of the URL", + "content": "Name of the VTEX account. Used as part of the URL.", "type": "text/plain" }, "type": "any", @@ -4025,7 +4025,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "2d5fcd20-59ee-4e9c-9280-68cf45669410", + "id": "90a72854-f632-42d9-b46c-9dbe293264ef", "name": "OK", "originalRequest": { "url": { @@ -4042,7 +4042,7 @@ "variable": [ { "description": { - "content": "Name of the VTEX account. Used as part of the URL", + "content": "Name of the VTEX account. Used as part of the URL.", "type": "text/plain" }, "type": "any", @@ -4103,7 +4103,7 @@ "value": "application/json" } ], - "body": "[\n {\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\": false,\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 \"areSalesChannelIdsExclusive\": false,\n \"marketingTags\": [\n \"MKT1\"\n ],\n \"marketingTagsAreNotInclusive\": false,\n \"paymentsMethods\": [],\n \"stores\": [],\n \"campaigns\": [],\n \"storesAreInclusive\": false,\n \"categories\": [],\n \"categoriesAreInclusive\": true,\n \"brands\": [],\n \"brandsAreInclusive\": true,\n \"products\": [],\n \"productsAreInclusive\": false,\n \"skus\": [],\n \"skusAreInclusive\": true,\n \"collections1BuyTogether\": [],\n \"collections2BuyTogether\": [],\n \"minimumQuantityBuyTogether\": 1,\n \"quantityToAffectBuyTogether\": 0,\n \"enableBuyTogetherPerSku\": false,\n \"listSku1BuyTogether\": [],\n \"listSku2BuyTogether\": [],\n \"listBrand1BuyTogether\": [],\n \"listCategory1BuyTogether\": [],\n \"coupon\": [],\n \"totalValueFloor\": 0,\n \"totalValueCeling\": 0,\n \"totalValueIncludeAllItems\": false,\n \"totalValueMode\": \"IncludeMatchedItems\",\n \"collections\": [],\n \"collectionsIsInclusive\": true,\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 \"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 \"clusterOperator\": \"all\",\n \"paymentsRules\": [],\n \"giftListTypes\": [],\n \"productsSpecifications\": [],\n \"affiliates\": [],\n \"maxUsage\": 0,\n \"maxUsagePerClient\": 0,\n \"shouldDistributeDiscountAmongMatchedItems\": false,\n \"multipleUsePerClient\": false,\n \"useNewProgressiveAlgorithm\": false,\n \"percentualDiscountValueList\": []\n }\n ]\n }\n]", + "body": "[\n {\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\": false,\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 \"areSalesChannelIdsExclusive\": false,\n \"marketingTags\": [\n \"MKT1\"\n ],\n \"marketingTagsAreNotInclusive\": false,\n \"paymentsMethods\": [],\n \"stores\": [],\n \"campaigns\": [],\n \"storesAreInclusive\": false,\n \"categories\": [],\n \"categoriesAreInclusive\": true,\n \"brands\": [],\n \"brandsAreInclusive\": true,\n \"products\": [],\n \"productsAreInclusive\": false,\n \"skus\": [],\n \"skusAreInclusive\": true,\n \"collections1BuyTogether\": [],\n \"collections2BuyTogether\": [],\n \"minimumQuantityBuyTogether\": 1,\n \"quantityToAffectBuyTogether\": 0,\n \"enableBuyTogetherPerSku\": false,\n \"listSku1BuyTogether\": [],\n \"listSku2BuyTogether\": [],\n \"listBrand1BuyTogether\": [],\n \"listCategory1BuyTogether\": [\n {\n \"id\": \"1\",\n \"name\": \"Vinhos Tintos (1)\"\n }\n ],\n \"coupon\": [],\n \"totalValueFloor\": 0,\n \"totalValueCeling\": 0,\n \"totalValueIncludeAllItems\": false,\n \"totalValueMode\": \"IncludeMatchedItems\",\n \"collections\": [],\n \"collectionsIsInclusive\": true,\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 \"clusterOperator\": \"all\",\n \"paymentsRules\": [],\n \"giftListTypes\": [],\n \"productsSpecifications\": [],\n \"affiliates\": [],\n \"maxUsage\": 0,\n \"maxUsagePerClient\": 0,\n \"shouldDistributeDiscountAmongMatchedItems\": false,\n \"multipleUsePerClient\": false,\n \"useNewProgressiveAlgorithm\": false,\n \"percentualDiscountValueList\": []\n }\n ]\n }\n]", "cookie": [] } ], @@ -4111,13 +4111,13 @@ { "listen": "test", "script": { - "id": "8e644b75-5878-4b2f-a689-04e62759e99f", + "id": "1a203d6b-b20e-4e88-98e5-8fa35c4e5759", "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},\"campaigns\":{\"type\":\"array\",\"description\":\"Campaign Audiences that activate this promotion.\"},\"storesAreInclusive\":{\"type\":\"boolean\",\"deprecated\":true},\"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\":\"string\",\"description\":\"Collection ID.\"}},\"collections2BuyTogether\":{\"type\":\"array\",\"deprecated\":true},\"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\":\"SKU first list for the promotion **Buy Together**.\"},\"listSku2BuyTogether\":{\"type\":\"array\",\"description\":\"SKU second list for the promotion **Buy Together**.\"},\"listBrand1BuyTogether\":{\"type\":\"array\",\"description\":\"Brand first list for the promotion **Buy Together.\"},\"listCategory1BuyTogether\":{\"type\":\"array\",\"description\":\"Category first list for the promotion **Buy Together**.\"},\"coupon\":{\"type\":\"array\",\"deprecated\":true},\"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},\"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},\"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 campaign audience.\",\"items\":{\"type\":\"object\",\"description\":\"Zip code that applies the campaign audience.\",\"properties\":{\"inclusive\":{\"type\":\"boolean\",\"description\":\"Defines if the zip code applies the campaign audience.\"}}}},\"itemMaxPrice\":{\"type\":\"number\",\"description\":\"Maximum price of the item.\"},\"itemMinPrice\":{\"type\":\"number\",\"description\":\"Minimum price of the item.\"},\"installment\":{\"type\":\"integer\",\"deprecated\":true},\"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},\"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.\",\"example\":\"email contains user@mail.com\"}},\"clusterOperator\":{\"type\":\"string\",\"deprecated\":true},\"paymentsRules\":{\"type\":\"array\",\"deprecated\":true},\"giftListTypes\":{\"type\":\"array\",\"description\":\"Gifts List Type.\",\"items\":{\"type\":\"string\",\"description\":\"Gift List Type.\"}},\"productsSpecifications\":{\"type\":\"array\",\"deprecated\":true},\"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\",\"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\":\"Stores are inclusive.\"},\"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\":\"string\",\"description\":\"Collection ID.\"}},\"collections2BuyTogether\":{\"type\":\"array\",\"deprecated\":true,\"description\":\"List of item for **Buy Together**.\",\"items\":{\"type\":\"string\",\"description\":\"Item for **Buy Together**.\"}},\"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\":\"Brand first list for the promotion **Buy Together.\",\"items\":{\"type\":\"string\",\"description\":\"Brand.\"}},\"listCategory1BuyTogether\":{\"type\":\"array\",\"description\":\"Category first list for the promotion **Buy Together**.\",\"items\":{\"type\":\"object\",\"description\":\"Category.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Category ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Category name.\"}}}},\"coupon\":{\"type\":\"array\",\"deprecated\":true,\"description\":\"List of coupons.\",\"items\":{\"type\":\"string\",\"description\":\"Coupon.\"}},\"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 include 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\",\"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" ] } } @@ -4127,7 +4127,7 @@ } }, { - "id": "a00f32a9-9c33-4bfa-a0ac-54f9584caeac", + "id": "73e20c85-3090-4629-a80d-d16bc88ab2a1", "name": "Create campaign audience", "request": { "name": "Create campaign audience", @@ -4149,7 +4149,7 @@ "variable": [ { "description": { - "content": "Name of the VTEX account. Used as part of the URL", + "content": "Name of the VTEX account. Used as part of the URL.", "type": "text/plain" }, "type": "any", @@ -4180,7 +4180,7 @@ "method": "POST", "body": { "mode": "raw", - "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 \"storesAreInclusive\": true,\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 \"1\",\n \"1\"\n ],\n \"minimumQuantityBuyTogether\": 1,\n \"quantityToAffectBuyTogether\": 0,\n \"enableBuyTogetherPerSku\": false,\n \"listCategory1BuyTogether\": [\n {\n \"id\": \"1\",\n \"name\": \"Vinhos Tintos (1)\"\n },\n {\n \"id\": \"1\",\n \"name\": \"Vinhos Tintos (1)\"\n }\n ],\n \"totalValueFloor\": 40,\n \"totalValueCeling\": 0,\n \"totalValueIncludeAllItems\": true,\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 \"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 \"inclusive\": false\n },\n {\n \"inclusive\": false\n }\n ],\n \"itemMaxPrice\": 0,\n \"itemMinPrice\": 0,\n \"installment\": 46631424,\n \"isMinMaxInstallments\": false,\n \"minInstallment\": 0,\n \"maxInstallment\": 0,\n \"clusterExpressions\": [\n \"email contains user@mail.com\",\n \"email contains user@mail.com\"\n ],\n \"clusterOperator\": \"Duis\",\n \"giftListTypes\": [\n \"Wishlist\",\n \"Wishlist\"\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 \"storesAreInclusive\": true,\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 \"1\",\n \"1\"\n ],\n \"minimumQuantityBuyTogether\": 1,\n \"quantityToAffectBuyTogether\": 0,\n \"enableBuyTogetherPerSku\": false,\n \"listCategory1BuyTogether\": [\n {\n \"id\": \"1\",\n \"name\": \"Vinhos Tintos (1)\"\n },\n {\n \"id\": \"1\",\n \"name\": \"Vinhos Tintos (1)\"\n }\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 \"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 \"inclusive\": false\n },\n {\n \"inclusive\": false\n }\n ],\n \"itemMaxPrice\": 0,\n \"itemMinPrice\": 0,\n \"installment\": 4612791,\n \"isMinMaxInstallments\": false,\n \"minInstallment\": 0,\n \"maxInstallment\": 0,\n \"clusterExpressions\": [\n \"email contains user@mail.com\",\n \"email contains user@mail.com\"\n ],\n \"clusterOperator\": \"dolore do reprehenderit\",\n \"giftListTypes\": [\n \"Wishlist\",\n \"Wishlist\"\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}", + "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\": true,\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 \"1\",\n \"1\"\n ],\n \"collections2BuyTogether\": [\n \"item\",\n \"item\"\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 \"brand\",\n \"brand\"\n ],\n \"listCategory1BuyTogether\": [\n {\n \"id\": \"1\",\n \"name\": \"Vinhos Tintos (1)\"\n },\n {\n \"id\": \"1\",\n \"name\": \"Vinhos Tintos (1)\"\n }\n ],\n \"coupon\": [\n \"coupon\",\n \"coupon\"\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 \"1\",\n \"1\"\n ],\n \"collections2BuyTogether\": [\n \"item\",\n \"item\"\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 \"brand\",\n \"brand\"\n ],\n \"listCategory1BuyTogether\": [\n {\n \"id\": \"1\",\n \"name\": \"Vinhos Tintos (1)\"\n },\n {\n \"id\": \"1\",\n \"name\": \"Vinhos Tintos (1)\"\n }\n ],\n \"coupon\": [\n \"coupon\",\n \"coupon\"\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": { "language": "json" @@ -4193,7 +4193,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "544564bb-a04a-470e-8d29-1fefbad16923", + "id": "019f5e78-3393-46ab-b814-952cdf147735", "name": "OK", "originalRequest": { "url": { @@ -4210,7 +4210,7 @@ "variable": [ { "description": { - "content": "Name of the VTEX account. Used as part of the URL", + "content": "Name of the VTEX account. Used as part of the URL.", "type": "text/plain" }, "type": "any", @@ -4263,7 +4263,7 @@ "method": "POST", "body": { "mode": "raw", - "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 \"storesAreInclusive\": true,\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 \"1\",\n \"1\"\n ],\n \"minimumQuantityBuyTogether\": 1,\n \"quantityToAffectBuyTogether\": 0,\n \"enableBuyTogetherPerSku\": false,\n \"listCategory1BuyTogether\": [\n {\n \"id\": \"1\",\n \"name\": \"Vinhos Tintos (1)\"\n },\n {\n \"id\": \"1\",\n \"name\": \"Vinhos Tintos (1)\"\n }\n ],\n \"totalValueFloor\": 40,\n \"totalValueCeling\": 0,\n \"totalValueIncludeAllItems\": true,\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 \"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 \"inclusive\": false\n },\n {\n \"inclusive\": false\n }\n ],\n \"itemMaxPrice\": 0,\n \"itemMinPrice\": 0,\n \"installment\": -93910864,\n \"isMinMaxInstallments\": false,\n \"minInstallment\": 0,\n \"maxInstallment\": 0,\n \"clusterExpressions\": [\n \"email contains user@mail.com\",\n \"email contains user@mail.com\"\n ],\n \"clusterOperator\": \"nisi\",\n \"giftListTypes\": [\n \"Wishlist\",\n \"Wishlist\"\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 \"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 \"1\",\n \"1\"\n ],\n \"minimumQuantityBuyTogether\": 1,\n \"quantityToAffectBuyTogether\": 0,\n \"enableBuyTogetherPerSku\": false,\n \"listCategory1BuyTogether\": [\n {\n \"id\": \"1\",\n \"name\": \"Vinhos Tintos (1)\"\n },\n {\n \"id\": \"1\",\n \"name\": \"Vinhos Tintos (1)\"\n }\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 \"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 \"inclusive\": false\n },\n {\n \"inclusive\": false\n }\n ],\n \"itemMaxPrice\": 0,\n \"itemMinPrice\": 0,\n \"installment\": -45613656,\n \"isMinMaxInstallments\": false,\n \"minInstallment\": 0,\n \"maxInstallment\": 0,\n \"clusterExpressions\": [\n \"email contains user@mail.com\",\n \"email contains user@mail.com\"\n ],\n \"clusterOperator\": \"irure incididunt ullamco amet\",\n \"giftListTypes\": [\n \"Wishlist\",\n \"Wishlist\"\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}", + "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\": true,\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 \"1\",\n \"1\"\n ],\n \"collections2BuyTogether\": [\n \"item\",\n \"item\"\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 \"brand\",\n \"brand\"\n ],\n \"listCategory1BuyTogether\": [\n {\n \"id\": \"1\",\n \"name\": \"Vinhos Tintos (1)\"\n },\n {\n \"id\": \"1\",\n \"name\": \"Vinhos Tintos (1)\"\n }\n ],\n \"coupon\": [\n \"coupon\",\n \"coupon\"\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 \"1\",\n \"1\"\n ],\n \"collections2BuyTogether\": [\n \"item\",\n \"item\"\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 \"brand\",\n \"brand\"\n ],\n \"listCategory1BuyTogether\": [\n {\n \"id\": \"1\",\n \"name\": \"Vinhos Tintos (1)\"\n },\n {\n \"id\": \"1\",\n \"name\": \"Vinhos Tintos (1)\"\n }\n ],\n \"coupon\": [\n \"coupon\",\n \"coupon\"\n ],\n \"totalValueFloor\": 40,\n \"totalValueCeling\": 0,\n \"totalValueIncludeAllItems\": true,\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": { "language": "json" @@ -4279,7 +4279,7 @@ "value": "application/json" } ], - "body": "{\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\": false,\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 \"areSalesChannelIdsExclusive\": false,\n \"marketingTags\": [\n \"MKT1\"\n ],\n \"marketingTagsAreNotInclusive\": false,\n \"paymentsMethods\": [],\n \"stores\": [],\n \"campaigns\": [],\n \"storesAreInclusive\": false,\n \"categories\": [],\n \"categoriesAreInclusive\": true,\n \"brands\": [],\n \"brandsAreInclusive\": true,\n \"products\": [],\n \"productsAreInclusive\": false,\n \"skus\": [],\n \"skusAreInclusive\": true,\n \"collections1BuyTogether\": [],\n \"collections2BuyTogether\": [],\n \"minimumQuantityBuyTogether\": 1,\n \"quantityToAffectBuyTogether\": 0,\n \"enableBuyTogetherPerSku\": false,\n \"listSku1BuyTogether\": [],\n \"listSku2BuyTogether\": [],\n \"listBrand1BuyTogether\": [],\n \"listCategory1BuyTogether\": [],\n \"coupon\": [],\n \"totalValueFloor\": 0,\n \"totalValueCeling\": 0,\n \"totalValueIncludeAllItems\": false,\n \"totalValueMode\": \"IncludeMatchedItems\",\n \"collections\": [],\n \"collectionsIsInclusive\": true,\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 \"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 \"useNewProgressiveAlgorithm\": false,\n \"percentualDiscountValueList\": []\n }\n ]\n}", + "body": "{\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\": false,\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 \"areSalesChannelIdsExclusive\": false,\n \"marketingTags\": [\n \"MKT1\"\n ],\n \"marketingTagsAreNotInclusive\": false,\n \"paymentsMethods\": [],\n \"stores\": [],\n \"campaigns\": [],\n \"storesAreInclusive\": false,\n \"categories\": [],\n \"categoriesAreInclusive\": true,\n \"brands\": [],\n \"brandsAreInclusive\": true,\n \"products\": [],\n \"productsAreInclusive\": false,\n \"skus\": [],\n \"skusAreInclusive\": true,\n \"collections1BuyTogether\": [],\n \"collections2BuyTogether\": [],\n \"minimumQuantityBuyTogether\": 1,\n \"quantityToAffectBuyTogether\": 0,\n \"enableBuyTogetherPerSku\": false,\n \"listSku1BuyTogether\": [],\n \"listSku2BuyTogether\": [],\n \"listBrand1BuyTogether\": [],\n \"listCategory1BuyTogether\": [\n {\n \"id\": \"1\",\n \"name\": \"Vinhos Tintos (1)\"\n }\n ],\n \"coupon\": [],\n \"totalValueFloor\": 0,\n \"totalValueCeling\": 0,\n \"totalValueIncludeAllItems\": false,\n \"totalValueMode\": \"IncludeMatchedItems\",\n \"collections\": [],\n \"collectionsIsInclusive\": true,\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 \"useNewProgressiveAlgorithm\": false,\n \"percentualDiscountValueList\": []\n }\n ]\n}", "cookie": [] } ], @@ -4287,13 +4287,13 @@ { "listen": "test", "script": { - "id": "a3120bec-ddc1-41a6-84ad-c2ffb0763900", + "id": "65a401c9-c22b-46c9-8f22-350b813b909e", "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},\"campaigns\":{\"type\":\"array\",\"description\":\"Campaign Audiences that activate this promotion.\"},\"storesAreInclusive\":{\"type\":\"boolean\",\"deprecated\":true},\"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\":\"string\",\"description\":\"Collection ID.\"}},\"collections2BuyTogether\":{\"type\":\"array\",\"deprecated\":true},\"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\":\"SKU first list for the promotion **Buy Together**.\"},\"listSku2BuyTogether\":{\"type\":\"array\",\"description\":\"SKU second list for the promotion **Buy Together**.\"},\"listBrand1BuyTogether\":{\"type\":\"array\",\"description\":\"Brand first list for the promotion **Buy Together.\"},\"listCategory1BuyTogether\":{\"type\":\"array\",\"description\":\"Category first list for the promotion **Buy Together**.\"},\"coupon\":{\"type\":\"array\",\"deprecated\":true},\"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},\"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},\"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 campaign audience.\",\"items\":{\"type\":\"object\",\"description\":\"Zip code that applies the campaign audience.\",\"properties\":{\"inclusive\":{\"type\":\"boolean\",\"description\":\"Defines if the zip code applies the campaign audience.\"}}}},\"itemMaxPrice\":{\"type\":\"number\",\"description\":\"Maximum price of the item.\"},\"itemMinPrice\":{\"type\":\"number\",\"description\":\"Minimum price of the item.\"},\"installment\":{\"type\":\"integer\",\"deprecated\":true},\"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},\"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.\",\"example\":\"email contains user@mail.com\"}},\"clusterOperator\":{\"type\":\"string\",\"deprecated\":true},\"paymentsRules\":{\"type\":\"array\",\"deprecated\":true},\"giftListTypes\":{\"type\":\"array\",\"description\":\"Gifts List Type.\",\"items\":{\"type\":\"string\",\"description\":\"Gift List Type.\"}},\"productsSpecifications\":{\"type\":\"array\",\"deprecated\":true},\"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\",\"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\":\"Stores are inclusive.\"},\"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\":\"string\",\"description\":\"Collection ID.\"}},\"collections2BuyTogether\":{\"type\":\"array\",\"deprecated\":true,\"description\":\"List of item for **Buy Together**.\",\"items\":{\"type\":\"string\",\"description\":\"Item for **Buy Together**.\"}},\"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\":\"Brand first list for the promotion **Buy Together.\",\"items\":{\"type\":\"string\",\"description\":\"Brand.\"}},\"listCategory1BuyTogether\":{\"type\":\"array\",\"description\":\"Category first list for the promotion **Buy Together**.\",\"items\":{\"type\":\"object\",\"description\":\"Category.\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Category ID.\"},\"name\":{\"type\":\"string\",\"description\":\"Category name.\"}}}},\"coupon\":{\"type\":\"array\",\"deprecated\":true,\"description\":\"List of coupons.\",\"items\":{\"type\":\"string\",\"description\":\"Coupon.\"}},\"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 include 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\",\"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" ] } } @@ -4306,7 +4306,7 @@ "event": [] }, { - "id": "4999455a-55eb-4d9d-a083-3e1b458e0565", + "id": "dc3deb84-862b-4c52-8bf4-ec4ec1eb8176", "name": "Notifications", "description": { "content": "", @@ -4314,7 +4314,7 @@ }, "item": [ { - "id": "181fc044-3cdf-4746-ba1f-cded2beef086", + "id": "3be2c094-ed04-4a2c-85a1-1304b1080893", "name": "Usage notification", "request": { "name": "Usage notification", @@ -4349,7 +4349,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"orderId\": \"vbbbbbb-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}", + "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": { "language": "json" @@ -4362,7 +4362,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "dfbe5d99-e539-419f-90cc-3c0f0314294a", + "id": "683f5cac-f6c0-40d9-b4a2-7108719c7a83", "name": "OK", "originalRequest": { "url": { @@ -4414,7 +4414,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"orderId\": \"vbbbbbb-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}", + "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": { "language": "json" @@ -4443,7 +4443,7 @@ "event": [] }, { - "id": "f7f64f96-2c8f-430d-bf12-f642459afab0", + "id": "e8d6af61-7e18-40a0-8fdb-06579220faf3", "name": "Bundles", "description": { "content": "", @@ -4451,7 +4451,7 @@ }, "item": [ { - "id": "e4a15e13-a1af-45e1-872f-5924f3ba2390", + "id": "7a9bf778-c80c-4a53-b45e-d1354f980264", "name": "Calculate discounts and taxes (Bundles)", "request": { "name": "Calculate discounts and taxes (Bundles)", @@ -4497,7 +4497,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "464835a6-1c18-460d-ae03-3c8bbd58165d", + "id": "94d8a82b-6750-42f4-98b6-ecb0550ffca1", "name": "OK", "originalRequest": { "url": { @@ -4576,7 +4576,7 @@ "event": [] }, { - "id": "69107e83-6559-4151-87e5-d99469c09eb5", + "id": "f9a34292-94a5-4e4e-bce3-8e72d5ca33a7", "name": "Prices (Legacy - v1)", "description": { "content": "", @@ -4584,7 +4584,7 @@ }, "item": [ { - "id": "7c107c78-2a78-410a-80ec-a9eab5cd8454", + "id": "bdfde06c-b7b9-44a9-9a8c-090376530b07", "name": "Get Price by SKU ID", "request": { "name": "Get Price by SKU ID", @@ -4626,7 +4626,7 @@ "type": "text/plain" }, "type": "any", - "value": "nulla", + "value": "quis aliqu", "key": "skuId" } ] @@ -4638,7 +4638,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "d802b479-d930-4cbe-941e-f4e8e28c6243", + "id": "99dec79c-ebef-4bec-968b-b1ecb98b8f8b", "name": "OK", "originalRequest": { "url": { @@ -4670,7 +4670,7 @@ "type": "text/plain" }, "type": "any", - "value": "nulla", + "value": "quis aliqu", "key": "skuId" } ] @@ -4724,7 +4724,7 @@ } }, { - "id": "51480fc6-8ad4-4217-8d23-34a5833bbb8b", + "id": "606a3070-cefa-4577-9a5d-7d741672faa1", "name": "Delete Price by SKU Id", "request": { "name": "Delete Price by SKU Id", @@ -4766,7 +4766,7 @@ "type": "text/plain" }, "type": "any", - "value": "nulla", + "value": "quis aliqu", "key": "skuId" } ] @@ -4778,7 +4778,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "98c06407-196e-4f78-a191-e5b51606aadc", + "id": "1b5e151b-d491-461a-8af6-eee3b24c9621", "name": "OK", "originalRequest": { "url": { @@ -4810,7 +4810,7 @@ "type": "text/plain" }, "type": "any", - "value": "nulla", + "value": "quis aliqu", "key": "skuId" } ] @@ -4864,7 +4864,7 @@ } }, { - "id": "664af34c-cf65-4187-930a-37c55054834d", + "id": "07bbe2aa-4cd3-4c27-b249-cb9f224545bc", "name": "Get all paged prices", "request": { "name": "Get all paged prices", @@ -4908,7 +4908,7 @@ "type": "text/plain" }, "type": "any", - "value": "nulla", + "value": "quis aliqu", "key": "page" }, { @@ -4918,7 +4918,7 @@ "type": "text/plain" }, "type": "any", - "value": "nulla", + "value": "quis aliqu", "key": "pageSize" } ] @@ -4930,7 +4930,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "6efb509a-1c67-4a9d-b9de-bfb1f5f61d4f", + "id": "5dad01ee-3b3e-4878-af1b-800278b4fc49", "name": "OK", "originalRequest": { "url": { @@ -4964,7 +4964,7 @@ "type": "text/plain" }, "type": "any", - "value": "nulla", + "value": "quis aliqu", "key": "page" }, { @@ -4974,7 +4974,7 @@ "type": "text/plain" }, "type": "any", - "value": "nulla", + "value": "quis aliqu", "key": "pageSize" } ] @@ -5028,7 +5028,7 @@ } }, { - "id": "7f041fc7-1ddf-49ee-8434-e837090700b5", + "id": "5d5aca37-109c-410b-a4a6-6fc4d126b413", "name": "Get Price by context", "request": { "name": "Get Price by context", @@ -5073,7 +5073,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"id\": 6324,\n \"itemId\": 2390148,\n \"salesChannel\": 1,\n \"sellerId\": \"1\",\n \"validFrom\": \"1900-01-01T00:00:00\",\n \"validTo\": \"4000-01-01T00:00:00\"\n}", + "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": { "language": "json" @@ -5086,7 +5086,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "932c294b-7dcb-48ae-817c-fc2a4ed0ab4a", + "id": "c7af9f38-91f0-4c81-8ad5-b33847c74332", "name": "OK", "originalRequest": { "url": { @@ -5143,7 +5143,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"id\": 6324,\n \"itemId\": 2390148,\n \"salesChannel\": 1,\n \"sellerId\": \"1\",\n \"validFrom\": \"1900-01-01T00:00:00\",\n \"validTo\": \"4000-01-01T00:00:00\"\n}", + "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": { "language": "json" @@ -5169,7 +5169,7 @@ } }, { - "id": "7b50fcbe-1886-4342-8bf3-7b386a77d608", + "id": "c1f15512-db29-41bf-85e3-6fd60f68d2f5", "name": "Get Price by SKU ID and Trade Policy", "request": { "name": "Get Price by SKU ID and Trade Policy", @@ -5212,7 +5212,7 @@ "type": "text/plain" }, "type": "any", - "value": "nulla", + "value": "quis aliqu", "key": "skuId" }, { @@ -5222,7 +5222,7 @@ "type": "text/plain" }, "type": "any", - "value": "nulla", + "value": "quis aliqu", "key": "tradePolicy" } ] @@ -5234,7 +5234,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "c860988b-b688-4e1e-93e0-1a77359e92e7", + "id": "ef5b48f0-e830-47f7-a431-0ebe3d393440", "name": "OK", "originalRequest": { "url": { @@ -5267,7 +5267,7 @@ "type": "text/plain" }, "type": "any", - "value": "nulla", + "value": "quis aliqu", "key": "skuId" }, { @@ -5277,7 +5277,7 @@ "type": "text/plain" }, "type": "any", - "value": "nulla", + "value": "quis aliqu", "key": "tradePolicy" } ] @@ -5331,7 +5331,7 @@ } }, { - "id": "51a1bc61-32c4-4ebc-bb8b-5f9a3e286220", + "id": "b3855906-c995-4608-8736-2e4a4137bac2", "name": "Save Price", "request": { "name": "Save Price", @@ -5388,7 +5388,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "b892bbb2-818e-48b3-9dcd-17786b4defc6", + "id": "91519a7f-da13-4dcc-afd9-a34d2884a767", "name": "OK", "originalRequest": { "url": { @@ -5497,7 +5497,7 @@ "variable": [ { "description": { - "content": "Name of the VTEX account. Used as part of the URL", + "content": "Name of the VTEX account. Used as part of the URL.", "type": "text/plain" }, "type": "any", @@ -5529,11 +5529,11 @@ } ], "info": { - "_postman_id": "22e4b26b-1bcc-4b19-abe4-dc0a559c53ea", + "_postman_id": "5f6ec77e-e33b-4395-9ce5-499f750c7d4d", "name": "Promotions & Taxes API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { - "content": "\r\n> Check the new [Promotions onboarding guide](https://developers.vtex.com/vtex-rest-api/docs/promotions-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Promotions and is organized by focusing on the developer's journey.\r\n\r\n The Promotions & Taxes API allows you to manage and retrieve all promotions, coupons and tax rules from your VTEX store.\r\n\r\n ## Index\r\n\r\n ### Coupons \r\n- `POST` [Create multiple coupons](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#post-/api/rnb/pvt/multiple-coupons) \r\n- `POST` [Create coupon](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#post-/api/rnb/pvt/coupon) \r\n- `GET` [Get all coupons](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#get-/api/rnb/pvt/coupon) \r\n- `GET` [Get coupon by coupon code](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#get-/api/rnb/pvt/coupon/-couponCode-) \r\n- `GET` [Get archived coupon by coupon code](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#get-/api/rnb/pvt/archive/coupon/-couponCode-) \r\n- `POST` [Archive coupon by coupon code](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#post-/api/rnb/pvt/archive/coupon/-couponCode-) \r\n- `POST` [Coupon Massive Generation](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#post-/api/rnb/pvt/coupons) \r\n- `GET` [Get coupon usage](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#get-/api/rnb/pvt/coupon/usage/-couponCode-) \r\n- `POST` [Unarchive coupon by coupon code](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#post-/api/rnb/pvt/unarchive/coupon/-couponCode-) \r\n\r\n### Promotions and Taxes \r\n- `GET` [Get All Promotions](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#get-/api/rnb/pvt/benefits/calculatorconfiguration) \r\n- `GET` [Search promotions by name](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#get-/api/rnb/pvt/benefits/calculatorconfiguration/search) \r\n- `GET` [Get All Taxes](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#get-/api/rnb/pvt/taxes/calculatorconfiguration) \r\n- `GET` [Get Promotion or Tax By ID](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#get-/api/rnb/pvt/calculatorconfiguration/-idCalculatorConfiguration-) \r\n- `POST` [Create or Update Promotion or Tax](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#post-/api/rnb/pvt/calculatorconfiguration) \r\n- `POST` [Create Multiple SKU Promotion](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#post-/api/rnb/pvt/import/calculatorConfiguration) \r\n- `PUT` [Update Multiple SKU Promotion](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#put-/api/rnb/pvt/import/calculatorConfiguration/-promotionId-) \r\n- `POST` [Archive Promotion or Tax](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#post-/api/rnb/pvt/archive/calculatorConfiguration/-idCalculatorConfiguration-) \r\n- `POST` [Unarchive Promotion or Tax](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#post-/api/rnb/pvt/unarchive/calculatorConfiguration/-idCalculatorConfiguration-) \r\n- `GET` [List archived Promotions](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#get-/api/rnb/pvt/archive/benefits/calculatorConfiguration) \r\n- `GET` [List archived Taxes](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#get-/api/rnb/pvt/archive/taxes/calculatorConfiguration) \r\n\r\n\r\n### Campaign Audiences \r\n- `GET` [Get campaign audience configuration](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#get-/api/rnb/pvt/campaignConfiguration/-campaignId-) \r\n- `POST` [Create campaign audience](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#post-/api/rnb/pvt/campaignConfiguration)", + "content": "\r\n> Check the new [Promotions onboarding guide](https://developers.vtex.com/vtex-rest-api/docs/promotions-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Promotions and is organized by focusing on the developer's journey.\r\n\r\n The Promotions & Taxes API allows you to manage and retrieve all promotions, coupons and tax rules from your VTEX store.\r\n\r\n ## Index\r\n\r\n ### Coupons \r\n- `POST` [Create multiple coupons](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#post-/api/rnb/pvt/multiple-coupons) \r\n- `POST` [Create coupon](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#post-/api/rnb/pvt/coupon) \r\n- `GET` [Get all coupons](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#get-/api/rnb/pvt/coupon) \r\n- `GET` [Get coupon by coupon code](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#get-/api/rnb/pvt/coupon/-couponCode-) \r\n- `GET` [Get archived coupon by coupon code](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#get-/api/rnb/pvt/archive/coupon/-couponCode-) \r\n- `POST` [Archive coupon by coupon code](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#post-/api/rnb/pvt/archive/coupon/-couponCode-) \r\n- `POST` [Coupon Massive Generation](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#post-/api/rnb/pvt/coupons) \r\n- `GET` [Get coupon usage](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#get-/api/rnb/pvt/coupon/usage/-couponCode-) \r\n- `POST` [Unarchive coupon by coupon code](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#post-/api/rnb/pvt/unarchive/coupon/-couponCode-) \r\n\r\n### Promotions and Taxes \r\n- `GET` [Get All Promotions](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#get-/api/rnb/pvt/benefits/calculatorconfiguration) \r\n- `GET` [Search promotions by name](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#get-/api/rnb/pvt/benefits/calculatorconfiguration/search) \r\n- `GET` [Get All Taxes](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#get-/api/rnb/pvt/taxes/calculatorconfiguration) \r\n- `GET` [Get Promotion or Tax By ID](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#get-/api/rnb/pvt/calculatorconfiguration/-idCalculatorConfiguration-) \r\n- `POST` [Create or Update Promotion or Tax](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#post-/api/rnb/pvt/calculatorconfiguration) \r\n- `POST` [Create Multiple SKU Promotion](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#post-/api/rnb/pvt/import/calculatorConfiguration) \r\n- `PUT` [Update Multiple SKU Promotion](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#put-/api/rnb/pvt/import/calculatorConfiguration/-promotionId-) \r\n- `POST` [Archive Promotion or Tax](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#post-/api/rnb/pvt/archive/calculatorConfiguration/-idCalculatorConfiguration-) \r\n- `POST` [Unarchive Promotion or Tax](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#post-/api/rnb/pvt/unarchive/calculatorConfiguration/-idCalculatorConfiguration-) \r\n- `GET` [List archived Promotions](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#get-/api/rnb/pvt/archive/benefits/calculatorConfiguration) \r\n- `GET` [List archived Taxes](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#get-/api/rnb/pvt/archive/taxes/calculatorConfiguration) \r\n\r\n\r\n### Campaign Audiences \r\n- `GET` [Get campaign audience configuration](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#get-/api/rnb/pvt/campaignConfiguration/-campaignId-) \r\n- `POST` [Create campaign audience](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#post-/api/rnb/pvt/campaignConfiguration)\r\n## Common parameters in the documentation\r\n\r\n| Parameter name | Description |\r\n|---------------------------|-----------------------------------------------------------------------------------------|\r\n| `{{accountName}}` | Store account name. |\r\n| `{{environment}}` | The environment that will be called. |\r\n| `{{X-VTEX-API-AppKey}}` | Located in the headers of the requests, user authentication key. |\r\n| `{{X-VTEX-API-AppToken}}` | Located in the headers of the requests, authentication password. |\r\n", "type": "text/plain" } } diff --git a/VTEX - Promotions & Taxes API.json b/VTEX - Promotions & Taxes API.json index 245f43f18..ba6f90fc7 100644 --- a/VTEX - Promotions & Taxes API.json +++ b/VTEX - Promotions & Taxes API.json @@ -2,7 +2,7 @@ "openapi": "3.0.0", "info": { "title": "Promotions & Taxes API", - "description": "\r\n> Check the new [Promotions onboarding guide](https://developers.vtex.com/vtex-rest-api/docs/promotions-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Promotions and is organized by focusing on the developer's journey.\r\n\r\n The Promotions & Taxes API allows you to manage and retrieve all promotions, coupons and tax rules from your VTEX store.\r\n\r\n ## Index\r\n\r\n ### Coupons \r\n- `POST` [Create multiple coupons](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#post-/api/rnb/pvt/multiple-coupons) \r\n- `POST` [Create coupon](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#post-/api/rnb/pvt/coupon) \r\n- `GET` [Get all coupons](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#get-/api/rnb/pvt/coupon) \r\n- `GET` [Get coupon by coupon code](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#get-/api/rnb/pvt/coupon/-couponCode-) \r\n- `GET` [Get archived coupon by coupon code](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#get-/api/rnb/pvt/archive/coupon/-couponCode-) \r\n- `POST` [Archive coupon by coupon code](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#post-/api/rnb/pvt/archive/coupon/-couponCode-) \r\n- `POST` [Coupon Massive Generation](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#post-/api/rnb/pvt/coupons) \r\n- `GET` [Get coupon usage](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#get-/api/rnb/pvt/coupon/usage/-couponCode-) \r\n- `POST` [Unarchive coupon by coupon code](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#post-/api/rnb/pvt/unarchive/coupon/-couponCode-) \r\n\r\n### Promotions and Taxes \r\n- `GET` [Get All Promotions](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#get-/api/rnb/pvt/benefits/calculatorconfiguration) \r\n- `GET` [Search promotions by name](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#get-/api/rnb/pvt/benefits/calculatorconfiguration/search) \r\n- `GET` [Get All Taxes](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#get-/api/rnb/pvt/taxes/calculatorconfiguration) \r\n- `GET` [Get Promotion or Tax By ID](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#get-/api/rnb/pvt/calculatorconfiguration/-idCalculatorConfiguration-) \r\n- `POST` [Create or Update Promotion or Tax](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#post-/api/rnb/pvt/calculatorconfiguration) \r\n- `POST` [Create Multiple SKU Promotion](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#post-/api/rnb/pvt/import/calculatorConfiguration) \r\n- `PUT` [Update Multiple SKU Promotion](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#put-/api/rnb/pvt/import/calculatorConfiguration/-promotionId-) \r\n- `POST` [Archive Promotion or Tax](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#post-/api/rnb/pvt/archive/calculatorConfiguration/-idCalculatorConfiguration-) \r\n- `POST` [Unarchive Promotion or Tax](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#post-/api/rnb/pvt/unarchive/calculatorConfiguration/-idCalculatorConfiguration-) \r\n- `GET` [List archived Promotions](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#get-/api/rnb/pvt/archive/benefits/calculatorConfiguration) \r\n- `GET` [List archived Taxes](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#get-/api/rnb/pvt/archive/taxes/calculatorConfiguration) \r\n\r\n\r\n### Campaign Audiences \r\n- `GET` [Get campaign audience configuration](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#get-/api/rnb/pvt/campaignConfiguration/-campaignId-) \r\n- `POST` [Create campaign audience](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#post-/api/rnb/pvt/campaignConfiguration)", + "description": "\r\n> Check the new [Promotions onboarding guide](https://developers.vtex.com/vtex-rest-api/docs/promotions-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Promotions and is organized by focusing on the developer's journey.\r\n\r\n The Promotions & Taxes API allows you to manage and retrieve all promotions, coupons and tax rules from your VTEX store.\r\n\r\n ## Index\r\n\r\n ### Coupons \r\n- `POST` [Create multiple coupons](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#post-/api/rnb/pvt/multiple-coupons) \r\n- `POST` [Create coupon](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#post-/api/rnb/pvt/coupon) \r\n- `GET` [Get all coupons](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#get-/api/rnb/pvt/coupon) \r\n- `GET` [Get coupon by coupon code](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#get-/api/rnb/pvt/coupon/-couponCode-) \r\n- `GET` [Get archived coupon by coupon code](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#get-/api/rnb/pvt/archive/coupon/-couponCode-) \r\n- `POST` [Archive coupon by coupon code](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#post-/api/rnb/pvt/archive/coupon/-couponCode-) \r\n- `POST` [Coupon Massive Generation](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#post-/api/rnb/pvt/coupons) \r\n- `GET` [Get coupon usage](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#get-/api/rnb/pvt/coupon/usage/-couponCode-) \r\n- `POST` [Unarchive coupon by coupon code](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#post-/api/rnb/pvt/unarchive/coupon/-couponCode-) \r\n\r\n### Promotions and Taxes \r\n- `GET` [Get All Promotions](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#get-/api/rnb/pvt/benefits/calculatorconfiguration) \r\n- `GET` [Search promotions by name](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#get-/api/rnb/pvt/benefits/calculatorconfiguration/search) \r\n- `GET` [Get All Taxes](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#get-/api/rnb/pvt/taxes/calculatorconfiguration) \r\n- `GET` [Get Promotion or Tax By ID](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#get-/api/rnb/pvt/calculatorconfiguration/-idCalculatorConfiguration-) \r\n- `POST` [Create or Update Promotion or Tax](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#post-/api/rnb/pvt/calculatorconfiguration) \r\n- `POST` [Create Multiple SKU Promotion](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#post-/api/rnb/pvt/import/calculatorConfiguration) \r\n- `PUT` [Update Multiple SKU Promotion](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#put-/api/rnb/pvt/import/calculatorConfiguration/-promotionId-) \r\n- `POST` [Archive Promotion or Tax](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#post-/api/rnb/pvt/archive/calculatorConfiguration/-idCalculatorConfiguration-) \r\n- `POST` [Unarchive Promotion or Tax](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#post-/api/rnb/pvt/unarchive/calculatorConfiguration/-idCalculatorConfiguration-) \r\n- `GET` [List archived Promotions](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#get-/api/rnb/pvt/archive/benefits/calculatorConfiguration) \r\n- `GET` [List archived Taxes](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#get-/api/rnb/pvt/archive/taxes/calculatorConfiguration) \r\n\r\n\r\n### Campaign Audiences \r\n- `GET` [Get campaign audience configuration](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#get-/api/rnb/pvt/campaignConfiguration/-campaignId-) \r\n- `POST` [Create campaign audience](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#post-/api/rnb/pvt/campaignConfiguration)\r\n## Common parameters in the documentation\r\n\r\n| Parameter name | Description |\r\n|---------------------------|-----------------------------------------------------------------------------------------|\r\n| `{{accountName}}` | Store account name. |\r\n| `{{environment}}` | The environment that will be called. |\r\n| `{{X-VTEX-API-AppKey}}` | Located in the headers of the requests, user authentication key. |\r\n| `{{X-VTEX-API-AppToken}}` | Located in the headers of the requests, authentication password. |\r\n", "contact": {}, "version": "1.0" }, @@ -11,10 +11,10 @@ "url": "https://{accountName}.{environment}.com.br", "variables": { "accountName": { - "description": "Name of the VTEX account. Used as part of the URL", + "description": "Name of the VTEX account. Used as part of the URL.", "default": "apiexamples" }, - "environment": { + "environment": { "description": "Environment to use. Used as part of the URL.", "enum": [ "vtexcommercestable" @@ -30,6 +30,7 @@ "tags": [ "Coupons" ], + "operationId": "CreateMultipleCoupons", "summary": "Create multiple coupons", "description": "Creates multiple coupons with different coupon codes. This endpoint has a throttling of 60 requests per minute.", "parameters": [ @@ -61,7 +62,10 @@ "application/json": { "schema": { "type": "array", + "description": "List of coupons.", "items": { + "type": "object", + "description": "Object containing information about the coupons.", "required": [ "quantity", "couponConfiguration" @@ -75,13 +79,6 @@ "couponConfiguration": { "type": "object", "description": "Object that contains all coupon configuration.", - "example": { - "utmSource": "coupon3", - "utmCampaign": "", - "couponCode": "test", - "maxItemsPerClient": 10, - "expirationIntervalPerUse": "00:00:00" - }, "required": [ "utmSource", "utmCampaign", @@ -98,7 +95,7 @@ "utmCampaign": { "type": "string", "description": "utmCampaign code.", - "example": "" + "example": "xfbf1" }, "couponCode": { "type": "string", @@ -160,8 +157,7 @@ "description": "Array with the coupon codes that were created.", "items": { "type": "string", - "description": "Coupon code.", - "example": "promobf" + "description": "Coupon code." } } } @@ -175,6 +171,7 @@ "tags": [ "Coupons" ], + "operationId": "CreateOrUpdateCoupon", "summary": "Create or update coupon", "description": "Creates a new single coupon or updates an existing coupon.\r\n\r\nTo update an existing coupon, first make a [Get coupon by coupon code](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api#get-/api/rnb/pvt/coupon/-couponCode-) request, copy the response body and apply the desired changes. Then, use the complete edited body as a request body in this update call.\r\n\r\n>⚠️ When updating a coupon, don't change the original `couponCode`, or a new coupon will be created instead of the existing coupon being updated.", "parameters": [ @@ -375,7 +372,7 @@ { "name": "Content-Type", "in": "header", - "description": "", + "description": "Indicate the media type of the resource.", "required": true, "style": "simple", "schema": { @@ -422,6 +419,7 @@ ], "schema": { "type": "array", + "description": "List of coupons.", "items": { "type": "object", "description": "Object with information about the coupon.", @@ -683,7 +681,7 @@ "Coupons" ], "summary": "Archive coupon by coupon code", - "description": "Archives a specifc coupon by its coupon code.", + "description": "Archives a specific coupon by its coupon code.", "operationId": "Archivebycouponcode", "parameters": [ { @@ -781,7 +779,6 @@ } ], "requestBody": { - "description": "", "content": { "application/json": { "schema": { @@ -1115,15 +1112,17 @@ "idCalculatorConfiguration": "7c946926-7815-4446-9428-83bd577a9135", "lastModifiedUtc": "2021-11-12T16:58:30.2553053Z", "name": "Progressive Discount", - "beginDate": "2009-12-31T02:00:00Z", - "isActive": true, - "description": "", + "beginDate": "2021-04-15T03:00:00Z", + "endDate": "2021-04-16T02:30:00Z", + "isActive": false, + "description": "The progressive discount.", "type": "progressive", "utmSource": "", "utmCampain": "", "utmiCampaign": "", - "status": "active", - "percentualTax": 0.0, + "nominalDiscountType": "item", + "status": "inactive", + "percentualTax": 0, "isArchived": false, "hasMaxPricePerItem": false, "isTax": false, @@ -1188,7 +1187,11 @@ }, "disabledItems": { "type": "array", - "description": "Disabled items." + "description": "Disabled items.", + "items": { + "type": "string", + "description": "Disabled item." + } }, "archivedItems": { "type": "array", @@ -1200,8 +1203,7 @@ }, "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.", - "example": "item" + "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." } } } @@ -1292,7 +1294,7 @@ "percentualDiscountValueList2": 0.0, "skusGift": { "quantitySelectable": 1, - "gifts": [] + "gifts": 1 }, "nominalRewardValue": 0.0, "percentualRewardValue": 0.0, @@ -1344,16 +1346,22 @@ "collectionsIsInclusive": true, "restrictionsBins": [], "cardIssuers": [], - "totalValuePurchase": 0.0, + "totalValuePurchase": 0, "slasIds": [], "isSlaSelected": false, "isFirstBuy": false, "firstBuyIsProfileOptimistic": true, "compareListPriceAndPrice": false, "isDifferentListPriceAndPrice": false, - "zipCodeRanges": [], - "itemMaxPrice": 0.0, - "itemMinPrice": 0.0, + "zipCodeRanges": [ + { + "zipCodeFrom": "20000-000", + "zipCodeTo": "20000-100", + "inclusive": true + } + ], + "itemMaxPrice": 0, + "itemMinPrice": 0, "installment": 0, "isMinMaxInstallments": false, "minInstallment": 0, @@ -1381,119 +1389,6 @@ "items": { "type": "object", "description": "Object with information about a promotion.", - "example": { - "idCalculatorConfiguration": "5ee78a73-a77e-4f84-b54e-d0c75a4b101a", - "name": "Black shirt", - "beginDateUtc": "2021-11-09T03:00:00Z", - "endDateUtc": "2021-11-26T02:30:00Z", - "lastModified": "2021-11-16T22:09:55.071735Z", - "daysAgoOfPurchases": 0, - "isActive": true, - "isArchived": false, - "isFeatured": false, - "disableDeal": false, - "activeDaysOfWeek": [], - "offset": -3, - "activateGiftsMultiplier": false, - "newOffset": -3.0, - "maxPricesPerItems": [], - "cumulative": false, - "nominalShippingDiscountValue": 0.0, - "absoluteShippingDiscountValue": 0.0, - "nominalDiscountValue": 1.0, - "nominalDiscountType": "cart", - "maximumUnitPriceDiscount": 0.0, - "percentualDiscountValue": 0.0, - "rebatePercentualDiscountValue": 0.0, - "percentualShippingDiscountValue": 0.0, - "percentualTax": 0.0, - "shippingPercentualTax": 0.0, - "percentualDiscountValueList1": 0.0, - "percentualDiscountValueList2": 0.0, - "skusGift": { - "quantitySelectable": 1, - "gifts": [] - }, - "nominalRewardValue": 0.0, - "percentualRewardValue": 0.0, - "orderStatusRewardValue": "invoiced", - "maxNumberOfAffectedItems": 0, - "maxNumberOfAffectedItemsGroupKey": "perCart", - "applyToAllShippings": false, - "nominalTax": 0.0, - "origin": "Marketplace", - "idSellerIsInclusive": true, - "idsSalesChannel": [], - "areSalesChannelIdsExclusive": false, - "marketingTags": [], - "marketingTagsAreNotInclusive": false, - "paymentsMethods": [], - "stores": [], - "campaigns": [], - "storesAreInclusive": true, - "categories": [], - "categoriesAreInclusive": true, - "brands": [], - "brandsAreInclusive": true, - "products": [ - { - "id": "1", - "name": "Pricing QA Test Product 1 (Produto 1)" - }, - { - "id": "3", - "name": "Pricing QA Test Product 3 (Produto 3)" - } - ], - "productsAreInclusive": true, - "skus": [], - "skusAreInclusive": true, - "collections1BuyTogether": [], - "collections2BuyTogether": [], - "minimumQuantityBuyTogether": 0, - "quantityToAffectBuyTogether": 0, - "enableBuyTogetherPerSku": false, - "listSku1BuyTogether": [], - "listSku2BuyTogether": [], - "coupon": [], - "totalValueFloor": 0.0, - "totalValueCeling": 0.0, - "totalValueIncludeAllItems": false, - "totalValueMode": "IncludeMatchedItems", - "collections": [], - "collectionsIsInclusive": true, - "restrictionsBins": [], - "cardIssuers": [], - "totalValuePurchase": 0.0, - "slasIds": [], - "isSlaSelected": false, - "isFirstBuy": false, - "firstBuyIsProfileOptimistic": true, - "compareListPriceAndPrice": false, - "isDifferentListPriceAndPrice": false, - "zipCodeRanges": [], - "itemMaxPrice": 0.0, - "itemMinPrice": 0.0, - "installment": 0, - "isMinMaxInstallments": false, - "minInstallment": 0, - "maxInstallment": 0, - "merchants": [], - "clusterExpressions": [], - "clusterOperator": "all", - "paymentsRules": [], - "giftListTypes": [], - "productsSpecifications": [], - "affiliates": [], - "maxUsage": 0, - "maxUsagePerClient": 0, - "shouldDistributeDiscountAmongMatchedItems": false, - "multipleUsePerClient": false, - "accumulateWithManualPrice": false, - "type": "regular", - "useNewProgressiveAlgorithm": false, - "percentualDiscountValueList": [] - }, "properties": { "idCalculatorConfiguration": { "type": "string", @@ -1537,7 +1432,8 @@ }, "disableDeal": { "type": "boolean", - "deprecated": true + "deprecated": true, + "description": "Indicates whether a deal is disabled (`true`) or not (`false`)." }, "activeDaysOfWeek": { "type": "array", @@ -1561,7 +1457,12 @@ }, "maxPricesPerItems": { "type": "array", - "deprecated": true + "deprecated": true, + "description": "List of prices per items.", + "items": { + "type": "string", + "description": "Price." + } }, "cumulative": { "type": "boolean", @@ -1589,8 +1490,7 @@ }, "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.", - "example": "item" + "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", @@ -1722,11 +1622,20 @@ }, "stores": { "type": "array", - "deprecated": true + "deprecated": true, + "description": "List of stores.", + "items": { + "type": "string", + "description": "Store." + } }, "campaigns": { "type": "array", - "description": "Campaign Audiences that activate this promotion." + "description": "Campaign Audiences that activate this promotion.", + "items": { + "type": "string", + "description": "Campaign audience." + } }, "conditionsIds": { "type": "array", @@ -1738,7 +1647,8 @@ }, "storesAreInclusive": { "type": "boolean", - "deprecated": true + "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", @@ -1840,13 +1750,38 @@ "type": "array", "description": "Collections that will generate the promotion, type **Buy Together**, **More for less**, **Progressive Discount**, **Buy One Get One**.", "items": { - "type": "string", - "description": "Collection ID." + "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 + "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", @@ -1862,15 +1797,48 @@ }, "listSku1BuyTogether": { "type": "array", - "description": "SKU first list for the promotion **Buy Together**." + "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": "SKU second list for the promotion **Buy Together**." + "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 + "deprecated": true, + "description": "List of coupons.", + "items": { + "type": "string", + "description": "Coupon code." + } }, "totalValueFloor": { "type": "number", @@ -1882,7 +1850,8 @@ }, "totalValueIncludeAllItems": { "type": "boolean", - "deprecated": true + "deprecated": true, + "description": "Total value including all items." }, "totalValueMode": { "type": "string", @@ -1920,7 +1889,12 @@ }, "cardIssuers": { "type": "array", - "deprecated": true + "deprecated": true, + "description": "List of card issuers.", + "items": { + "type": "string", + "description": "Card issuer." + } }, "totalValuePurchase": { "type": "number", @@ -1959,6 +1933,7 @@ "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", @@ -1985,7 +1960,8 @@ }, "installment": { "type": "integer", - "deprecated": true + "deprecated": true, + "description": "Installment." }, "isMinMaxInstallments": { "type": "boolean", @@ -2001,24 +1977,34 @@ }, "merchants": { "type": "array", - "deprecated": true + "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.", - "example": "email contains user@mail.com" + "description": "Cluster expression." } }, "clusterOperator": { "type": "string", - "deprecated": true + "deprecated": true, + "description": "Cluster operator." }, "paymentsRules": { "type": "array", - "deprecated": true + "deprecated": true, + "description": "List of payment rules.", + "items": { + "type": "string", + "description": "Payment rule." + } }, "giftListTypes": { "type": "array", @@ -2030,7 +2016,12 @@ }, "productsSpecifications": { "type": "array", - "deprecated": true + "deprecated": true, + "description": "List of product specifications.", + "items": { + "type": "string", + "description": "Product specification." + } }, "affiliates": { "type": "array", @@ -2351,25 +2342,49 @@ "minimumQuantityBuyTogether": 0, "quantityToAffectBuyTogether": 0, "enableBuyTogetherPerSku": false, - "listSku1BuyTogether": [], - "listSku2BuyTogether": [], + "listSku1BuyTogether": [ + { + "id": "2", + "name": "gustaBT" + }, + { + "id": "5", + "name": "exampleSKU" + } + ], + "listSku2BuyTogether": [ + { + "id": "3", + "name": "anotherSKU" + }, + { + "id": "6", + "name": "exampleProduct" + } + ], "coupon": [], - "totalValueFloor": 0.0, - "totalValueCeling": 0.0, + "totalValueFloor": 0, + "totalValueCeling": 0, "totalValueIncludeAllItems": false, "totalValueMode": "IncludeMatchedItems", "collections": [], "collectionsIsInclusive": false, "restrictionsBins": [], "cardIssuers": [], - "totalValuePurchase": 0.0, + "totalValuePurchase": 0, "slasIds": [], "isSlaSelected": false, "isFirstBuy": false, "firstBuyIsProfileOptimistic": false, "compareListPriceAndPrice": false, "isDifferentListPriceAndPrice": false, - "zipCodeRanges": [], + "zipCodeRanges": [ + { + "zipCodeFrom": "20000-000", + "zipCodeTo": "20000-100", + "inclusive": true + } + ], "itemMaxPrice": 0.0, "itemMinPrice": 0.0, "installment": 0, @@ -2436,7 +2451,8 @@ }, "disableDeal": { "type": "boolean", - "deprecated": true + "deprecated": true, + "description": "Indicates whether a deal is disabled (`true`) or not (`false`)." }, "activeDaysOfWeek": { "type": "array", @@ -2460,7 +2476,12 @@ }, "maxPricesPerItems": { "type": "array", - "deprecated": true + "deprecated": true, + "description": "List of max price per items.", + "items": { + "type": "string", + "description": "Max price." + } }, "cumulative": { "type": "boolean", @@ -2484,8 +2505,7 @@ }, "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.", - "example": "item" + "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", @@ -2617,11 +2637,20 @@ }, "stores": { "type": "array", - "deprecated": true + "deprecated": true, + "description": "List of stores.", + "items": { + "type": "string", + "description": "Store." + } }, "campaigns": { "type": "array", - "description": "Campaign Audiences that activate this promotion." + "description": "Campaign Audiences that activate this promotion.", + "items": { + "type": "string", + "description": "Campaign audience." + } }, "conditionsIds": { "type": "array", @@ -2633,7 +2662,8 @@ }, "storesAreInclusive": { "type": "boolean", - "deprecated": true + "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", @@ -2735,13 +2765,38 @@ "type": "array", "description": "Collections that will generate the promotion, type **Buy Together**, **More for less**, **Progressive Discount**, **Buy One Get One**.", "items": { - "type": "string", - "description": "Collection ID." + "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 + "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", @@ -2757,15 +2812,48 @@ }, "listSku1BuyTogether": { "type": "array", - "description": "SKU first list for the promotion **Buy Together**." + "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": "SKU second list for the promotion **Buy Together**." + "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 + "deprecated": true, + "description": "List of coupons.", + "items": { + "type": "string", + "description": "Coupon code." + } }, "totalValueFloor": { "type": "number", @@ -2777,7 +2865,8 @@ }, "totalValueIncludeAllItems": { "type": "boolean", - "deprecated": true + "deprecated": true, + "description": "Total value including all items." }, "totalValueMode": { "type": "string", @@ -2815,7 +2904,12 @@ }, "cardIssuers": { "type": "array", - "deprecated": true + "deprecated": true, + "description": "List of card issuers.", + "items": { + "type": "string", + "description": "Card issuer." + } }, "totalValuePurchase": { "type": "number", @@ -2854,6 +2948,7 @@ "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", @@ -2880,7 +2975,8 @@ }, "installment": { "type": "integer", - "deprecated": true + "deprecated": true, + "description": "Installment." }, "isMinMaxInstallments": { "type": "boolean", @@ -2896,15 +2992,19 @@ }, "merchants": { "type": "array", - "deprecated": true + "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.", - "example": "email contains user@mail.com" + "description": "Cluster expression." } }, "multipleSkusCause": { @@ -2917,7 +3017,12 @@ }, "paymentsRules": { "type": "array", - "deprecated": true + "deprecated": true, + "description": "List of payment rules.", + "items": { + "type": "string", + "description": "Payment rule." + } }, "giftListTypes": { "type": "array", @@ -2929,7 +3034,12 @@ }, "productsSpecifications": { "type": "array", - "deprecated": true + "deprecated": true, + "description": "List of product specifications.", + "items": { + "type": "string", + "description": "Product specification." + } }, "affiliates": { "type": "array", @@ -3027,7 +3137,6 @@ } ], "requestBody": { - "description": "", "content": { "application/json": { "example": { @@ -3116,9 +3225,15 @@ "firstBuyIsProfileOptimistic": false, "compareListPriceAndPrice": false, "isDifferentListPriceAndPrice": false, - "zipCodeRanges": [], - "itemMaxPrice": 0.0, - "itemMinPrice": 0.0, + "zipCodeRanges": [ + { + "zipCodeFrom": "20000-000", + "zipCodeTo": "20000-100", + "inclusive": true + } + ], + "itemMaxPrice": 0, + "itemMinPrice": 0, "installment": 0, "isMinMaxInstallments": false, "minInstallment": 0, @@ -3193,7 +3308,9 @@ }, "disableDeal": { "type": "boolean", - "deprecated": true + "deprecated": true, + "description": "Indicates whether a deal is disabled (`true`) or not (`false`).", + "example": false }, "activeDaysOfWeek": { "type": "array", @@ -3217,11 +3334,17 @@ "newOffset": { "type": "number", "description": "New time offset from UTC in seconds.", - "example": -3.0 + "example": -3 }, "maxPricesPerItems": { "type": "array", - "deprecated": true + "deprecated": true, + "description": "List of max price per items.", + "items": { + "type": "string", + "description": "Max price.", + "example": "100" + } }, "cumulative": { "type": "boolean", @@ -3236,17 +3359,17 @@ "nominalShippingDiscountValue": { "type": "number", "description": "Exact discount to be applied for the shipping value.", - "example": 0.0 + "example": 0 }, "absoluteShippingDiscountValue": { "type": "number", "description": "Maximum shipping value.", - "example": 0.0 + "example": 0 }, "nominalDiscountValue": { "type": "number", "description": "Exact discount to be applied for the total purchase value.", - "example": 10.0 + "example": 10 }, "nominalDiscountType": { "type": "string", @@ -3256,42 +3379,42 @@ "maximumUnitPriceDiscount": { "type": "number", "description": "The maximum price for each item of the purchase will be the price set up.", - "example": 0.0 + "example": 0 }, "percentualDiscountValue": { "type": "number", "description": "Percentage discount to be applied for total purchase value.", - "example": 10.0 + "example": 10 }, "rebatePercentualDiscountValue": { "type": "number", "description": "Percentual Shipping Discount Value.", - "example": 0.0 + "example": 0 }, "percentualShippingDiscountValue": { "type": "number", "description": "Percentage discount to be applied for shipping value.", - "example": 0.0 + "example": 0 }, "percentualTax": { "type": "number", "description": "Percentual Tax over purchase total value.", - "example": 0.0 + "example": 0 }, "shippingPercentualTax": { "type": "number", "description": "Shipping Percentual Tax over purchase total value.", - "example": 0.0 + "example": 0 }, "percentualDiscountValueList1": { "type": "number", "description": "Valid discounts for the SKUs in `listSku1BuyTogether`, discount list used for Buy Together Promotions.", - "example": 0.0 + "example": 0 }, "percentualDiscountValueList2": { "type": "number", "description": "Equivalent to `percentualDiscountValueList1`.", - "example": 0.0 + "example": 0 }, "skusGift": { "type": "object", @@ -3305,21 +3428,23 @@ "gifts": { "type": "array", "description": "Array with SKU Gifts IDs.", - "example": [ - "SKU" - ] + "items": { + "type": "string", + "description": "SKU gift ID.", + "example": "123" + } } } }, "nominalRewardValue": { "type": "number", "description": "Nominal value for rewards program.", - "example": 0.0 + "example": 0 }, "percentualRewardValue": { "type": "number", "description": "Percentage value for rewards program.", - "example": 0.0 + "example": 0 }, "orderStatusRewardValue": { "type": "string", @@ -3344,7 +3469,7 @@ "nominalTax": { "type": "number", "description": "Nominal Tax.", - "example": 0.0 + "example": 0 }, "origin": { "type": "string", @@ -3411,14 +3536,22 @@ }, "stores": { "type": "array", - "deprecated": true + "deprecated": true, + "description": "List of stores.", + "items": { + "type": "string", + "description": "Store.", + "example": "store" + } }, "campaigns": { "type": "array", - "description": "Campaign Audiences that activate this Promotion or Tax.", - "example": [ - "Campaign Audience test" - ] + "description": "Campaign Audiences that activate this promotion.", + "items": { + "type": "string", + "description": "Campaign audience.", + "example": "campaign" + } }, "conditionsIds": { "type": "array", @@ -3431,7 +3564,9 @@ }, "storesAreInclusive": { "type": "boolean", - "deprecated": true + "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.", + "example": false }, "categories": { "type": "array", @@ -3545,16 +3680,44 @@ }, "collections1BuyTogether": { "type": "array", - "description": "Collections that will generate the Promotion, type **Buy Together**, **More for less**, **Progressive Discount**, **Buy One Get One**.", + "description": "Collections that will generate the promotion, type **Buy Together**, **More for less**, **Progressive Discount** or **Buy One Get One**.", "items": { - "type": "string", - "description": "Collection ID.", - "example": "1" + "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.", + "example": "157" + }, + "name": { + "type": "string", + "description": "Name of the collection to be added to the first list of the **Buy Together** promotion.", + "example": "Inverno (157)" + } + } } }, "collections2BuyTogether": { "type": "array", - "deprecated": true + "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.", + "example": "157" + }, + "name": { + "type": "string", + "description": "Name of the collection to be added to the first list of the **Buy Together** promotion.", + "example": "Inverno (157)" + } + } + } }, "minimumQuantityBuyTogether": { "type": "integer", @@ -3574,29 +3737,19 @@ "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.", - "example": [ - { - "id": "2", - "name": "gustaBT" - } - ], "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.", - "example": { - "id": "2", - "name": "gustaBT" - }, "properties": { "id": { "type": "string", "description": "ID of the SKU to be added to the first list of the **Buy Together** promotion.", - "example": "2" + "example": "1" }, "name": { "type": "string", "description": "Name of the SKU to be added to the first list of the **Buy Together** promotion.", - "example": "gustaBT" + "example": "White Shirt" } } } @@ -3604,50 +3757,48 @@ "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.", - "example": [ - { - "id": "2", - "name": "gustaBT" - } - ], "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.", - "example": { - "id": "2", - "name": "gustaBT" - }, "properties": { "id": { "type": "string", "description": "ID of the SKU to be added to the second list of the **Buy Together** promotion.", - "example": "2" + "example": "1" }, "name": { "type": "string", "description": "Name of the SKU to be added to the second list of the **Buy Together** promotion.", - "example": "gustaBT" + "example": "White Shirt" } } } }, "coupon": { "type": "array", - "deprecated": true + "deprecated": true, + "description": "List of coupons.", + "items": { + "type": "string", + "description": "Coupon.", + "example": "12345" + } }, "totalValueFloor": { "type": "number", "description": "Minimum chart value to activate the Promotion or Tax.", - "example": 0.0 + "example": 0 }, "totalValueCeling": { "type": "number", "description": "Maximum chart value to activate the Promotion or Tax.", - "example": 0.0 + "example": 0 }, "totalValueIncludeAllItems": { "type": "boolean", - "deprecated": true + "deprecated": true, + "description": "Total vale including all items.", + "example": false }, "totalValueMode": { "type": "string", @@ -3690,12 +3841,18 @@ }, "cardIssuers": { "type": "array", - "deprecated": true + "deprecated": true, + "description": "List of card issuers.", + "items": { + "type": "string", + "description": "Card issuer.", + "example": "issuer" + } }, "totalValuePurchase": { "type": "number", "description": "Total value a client must have in past orders to activate the Promotion or Tax.", - "example": 0.0 + "example": 0 }, "slasIds": { "type": "array", @@ -3736,12 +3893,22 @@ "description": "Range of the zip code that applies the promotion.", "items": { "type": "object", - "description": "Zip code that applies the promotion.", + "description": "Object with information of the Zip Code.", "properties": { + "zipCodeFrom": { + "type": "string", + "description": "Initial Zip Code.", + "example": "20000-000" + }, + "zipCodeTo": { + "type": "string", + "description": "Final Zip Code.", + "example": "20000-100" + }, "inclusive": { "type": "boolean", - "description": "Defines if the zip code applies the promotion.", - "example": false + "description": "Defines if the zip code range is included in the promotion.", + "example": true } } } @@ -3749,16 +3916,18 @@ "itemMaxPrice": { "type": "number", "description": "Maximum price of the item.", - "example": 0.0 + "example": 0 }, "itemMinPrice": { "type": "number", "description": "Minimum price of the item.", - "example": 0.0 + "example": 0 }, "installment": { "type": "integer", - "deprecated": true + "deprecated": true, + "description": "Installment.", + "example": 1 }, "isMinMaxInstallments": { "type": "boolean", @@ -3777,7 +3946,13 @@ }, "merchants": { "type": "array", - "deprecated": true + "deprecated": true, + "description": "List of merchants.", + "items": { + "type": "string", + "description": "Merchant.", + "example": "merchant" + } }, "clusterExpressions": { "type": "array", @@ -3790,7 +3965,13 @@ }, "paymentsRules": { "type": "array", - "deprecated": true + "deprecated": true, + "description": "List of payment rules.", + "items": { + "type": "string", + "description": "Payment rule.", + "example": "rules" + } }, "giftListTypes": { "type": "array", @@ -3803,7 +3984,13 @@ }, "productsSpecifications": { "type": "array", - "deprecated": true + "deprecated": true, + "description": "List of product specifications.", + "items": { + "type": "string", + "description": "Product specification.", + "example": "spec" + } }, "affiliates": { "type": "array", @@ -3866,7 +4053,7 @@ "items": { "type": "number", "description": "Percentual discount value.", - "example": 10.0 + "example": 10 } } } @@ -3958,24 +4145,30 @@ "listSku1BuyTogether": [], "listSku2BuyTogether": [], "coupon": [], - "totalValueFloor": 0.0, - "totalValueCeling": 0.0, + "totalValueFloor": 0, + "totalValueCeling": 0, "totalValueIncludeAllItems": false, "totalValueMode": "IncludeMatchedItems", "collections": [], "collectionsIsInclusive": false, "restrictionsBins": [], "cardIssuers": [], - "totalValuePurchase": 0.0, + "totalValuePurchase": 0, "slasIds": [], "isSlaSelected": false, "isFirstBuy": false, "firstBuyIsProfileOptimistic": false, "compareListPriceAndPrice": false, "isDifferentListPriceAndPrice": false, - "zipCodeRanges": [], - "itemMaxPrice": 0.0, - "itemMinPrice": 0.0, + "zipCodeRanges": [ + { + "zipCodeFrom": "20000-000", + "zipCodeTo": "20000-100", + "inclusive": true + } + ], + "itemMaxPrice": 0, + "itemMinPrice": 0, "installment": 0, "isMinMaxInstallments": false, "minInstallment": 0, @@ -4040,7 +4233,8 @@ }, "disableDeal": { "type": "boolean", - "deprecated": true + "deprecated": true, + "description": "Indicates whether a deal is disabled (`true`) or not (`false`)." }, "activeDaysOfWeek": { "type": "array", @@ -4064,7 +4258,12 @@ }, "maxPricesPerItems": { "type": "array", - "deprecated": true + "deprecated": true, + "description": "List of max price per items.", + "items": { + "type": "string", + "description": "Max price." + } }, "cumulative": { "type": "boolean", @@ -4216,11 +4415,20 @@ }, "stores": { "type": "array", - "deprecated": true + "deprecated": true, + "description": "List of stores.", + "items": { + "type": "string", + "description": "Store." + } }, "campaigns": { "type": "array", - "description": "Campaign Audiences that activate this promotion." + "description": "Campaign Audiences that activate this promotion.", + "items": { + "type": "string", + "description": "Campaign audience." + } }, "conditionsIds": { "type": "array", @@ -4232,7 +4440,8 @@ }, "storesAreInclusive": { "type": "boolean", - "deprecated": true + "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", @@ -4334,13 +4543,38 @@ "type": "array", "description": "Collections that will generate the promotion, type **Buy Together**, **More for less**, **Progressive Discount**, **Buy One Get One**.", "items": { - "type": "string", - "description": "Collection ID." + "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 + "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", @@ -4356,15 +4590,48 @@ }, "listSku1BuyTogether": { "type": "array", - "description": "SKU first list for the promotion **Buy Together**." + "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": "SKU second list for the promotion **Buy Together**." + "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 + "deprecated": true, + "description": "List of coupons.", + "items": { + "type": "string", + "description": "Coupon code." + } }, "totalValueFloor": { "type": "number", @@ -4376,7 +4643,8 @@ }, "totalValueIncludeAllItems": { "type": "boolean", - "deprecated": true + "deprecated": true, + "description": "Total value including all items." }, "totalValueMode": { "type": "string", @@ -4414,7 +4682,12 @@ }, "cardIssuers": { "type": "array", - "deprecated": true + "deprecated": true, + "description": "List of card issuers.", + "items": { + "type": "string", + "description": "Card issuer." + } }, "totalValuePurchase": { "type": "number", @@ -4451,7 +4724,24 @@ "zipCodeRanges": { "type": "array", "description": "Range of the zip code that applies the promotion.", - "items": {} + "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", @@ -4463,7 +4753,8 @@ }, "installment": { "type": "integer", - "deprecated": true + "deprecated": true, + "description": "Installment." }, "isMinMaxInstallments": { "type": "boolean", @@ -4479,20 +4770,29 @@ }, "merchants": { "type": "array", - "deprecated": true + "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.", - "example": "email contains user@mail.com" + "description": "Cluster expression." } }, "paymentsRules": { "type": "array", - "deprecated": true + "deprecated": true, + "description": "List of payment rules.", + "items": { + "type": "string", + "description": "Payment rule." + } }, "giftListTypes": { "type": "array", @@ -4504,7 +4804,12 @@ }, "productsSpecifications": { "type": "array", - "deprecated": true + "deprecated": true, + "description": "List of product specifications.", + "items": { + "type": "string", + "description": "Product specification." + } }, "affiliates": { "type": "array", @@ -4621,6 +4926,7 @@ "tags": [ "Promotions and Taxes" ], + "operationId": "CreateMultipleSkuPromotion", "summary": "Create Multiple SKU Promotion", "description": "Creates a Multiple SKU Promotion. This scenario allows to create a single promotion for multiples SKUs with the Percentage Effect. \r\n> ⚠️ \r\n>\r\n> The limit of SKUs on a Multiple Effects promotion is 400.", "parameters": [ @@ -4748,6 +5054,7 @@ "tags": [ "Promotions and Taxes" ], + "operationId": "UpdateMultipleSkuPromotion", "summary": "Update Multiple SKU Promotion", "description": "Updates information from a Multiple SKU Promotion. This scenario allows to create a single promotion for multiples SKUs with the Percentage Effect. \r\n> ⚠️ \r\n>\r\n> The limit of SKUs on a Multiple Effects promotion is 400.", "parameters": [ @@ -5026,7 +5333,7 @@ "beginDate": "2021-04-15T03:00:00Z", "endDate": "2021-04-16T02:30:00Z", "isActive": false, - "description": "", + "description": "Progressive discount promotion.", "type": "progressive", "utmSource": "", "utmCampain": "", @@ -5069,8 +5376,7 @@ }, "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.", - "example": "item" + "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." } } } @@ -5212,7 +5518,7 @@ { "name": "an", "in": "query", - "description": "", + "description": "VTEX account name.", "required": true, "style": "form", "explode": true, @@ -5224,7 +5530,7 @@ { "name": "skuId", "in": "path", - "description": "", + "description": "SKU ID.", "required": true, "style": "simple", "schema": { @@ -5282,7 +5588,7 @@ { "name": "an", "in": "query", - "description": "", + "description": "VTEX account name.", "required": true, "style": "form", "explode": true, @@ -5294,7 +5600,7 @@ { "name": "skuId", "in": "path", - "description": "", + "description": "SKU ID.", "required": true, "style": "simple", "schema": { @@ -5354,7 +5660,7 @@ { "name": "an", "in": "query", - "description": "", + "description": "VTEX account name.", "required": true, "style": "form", "explode": true, @@ -5366,7 +5672,7 @@ { "name": "page", "in": "path", - "description": "", + "description": "Page number for pagination.", "required": true, "style": "simple", "schema": { @@ -5376,7 +5682,7 @@ { "name": "pageSize", "in": "path", - "description": "", + "description": "Size of each page for pagination.", "required": true, "style": "simple", "schema": { @@ -5436,7 +5742,7 @@ { "name": "an", "in": "query", - "description": "", + "description": "VTEX account name.", "required": true, "style": "form", "explode": true, @@ -5447,19 +5753,61 @@ } ], "requestBody": { - "description": "", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PricebycontextRequest" + "required": [ + "id", + "itemId", + "salesChannel", + "sellerId", + "validFrom", + "validTo" + ], + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32", + "description": "Price ID.", + "example": 6324 + }, + "itemId": { + "type": "integer", + "format": "int32", + "description": "Item ID.", + "example": 2390148 + }, + "salesChannel": { + "type": "integer", + "format": "int32", + "description": "Sales channel.", + "example": 1 + }, + "sellerId": { + "type": "string", + "description": "Seller ID.", + "example": "1" + }, + "validFrom": { + "type": "string", + "description": "Valid from.", + "example": "2000-01-01T00:00:00" + }, + "validTo": { + "type": "string", + "description": "Valid to.", + "example": "2000-02-01T00:00:00" + } + } }, "example": { "id": 6324, "itemId": 2390148, "salesChannel": 1, "sellerId": "1", - "validFrom": "1900-01-01T00:00:00", - "validTo": "4000-01-01T00:00:00" + "validFrom": "2000-01-01T00:00:00", + "validTo": "2000-02-01T00:00:00" } } }, @@ -5506,7 +5854,7 @@ { "name": "an", "in": "query", - "description": "", + "description": "Account name.", "required": true, "style": "form", "explode": true, @@ -5529,7 +5877,7 @@ { "name": "skuId", "in": "path", - "description": "", + "description": "SKU ID.", "required": true, "style": "simple", "schema": { @@ -5539,7 +5887,7 @@ { "name": "tradePolicy", "in": "path", - "description": "", + "description": "Trade policy name.", "required": true, "style": "simple", "schema": { @@ -5599,7 +5947,7 @@ { "name": "an", "in": "query", - "description": "", + "description": "VTEX account name.", "required": true, "style": "form", "explode": true, @@ -5610,15 +5958,66 @@ } ], "requestBody": { - "description": "", "content": { "application/json": { "schema": { "type": "array", + "description": "List of prices.", "items": { - "$ref": "#/components/schemas/SavepriceRequest" - }, - "description": "" + "description": "Object containing information about the prices.", + "required": [ + "itemId", + "salesChannel", + "sellerId", + "price", + "listPrice", + "validFrom", + "validTo" + ], + "type": "object", + "properties": { + "itemId": { + "type": "integer", + "format": "int32", + "example": 2390148, + "description": "Item ID." + }, + "salesChannel": { + "type": "integer", + "format": "int32", + "example": 1, + "description": "Sales channel." + }, + "sellerId": { + "type": "integer", + "format": "int32", + "example": 1, + "description": "Seller ID." + }, + "price": { + "type": "integer", + "format": "int32", + "example": 1, + "description": "Price." + }, + "listPrice": { + "type": "integer", + "format": "int32", + "example": 1, + "description": "List price." + }, + "validFrom": { + "type": "string", + "example": "2016-01-01T02:00:00Z", + "description": "Valid from." + }, + "validTo": { + "type": "string", + "example": "2016-01-01T02:00:00Z", + "description": "Valid to." + } + } + } }, "example": [ { @@ -5686,60 +6085,211 @@ } ], "requestBody": { - "description": "", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Calculatediscountsandtaxes_Bundles_Request" - }, - "example": { - "isShoppingCart": true, - "origin": "Marketplace", - "salesChannel": "1", - "profileId": "aa", - "items": [ - { - "index": 0, - "id": "160", - "quantity": 3, - "isGift": false, - "measurementUnit": "un", - "unitMultiplier": 1, - "priceTags": [], - "params": [ - { - "name": "Seller@CatalogSystem", - "value": "1" - }, - { - "name": "product@CatalogSystem", - "value": "94" - } - ], - "priceSheet": [], - "logisticsInfos": [], - "sellerId": "1", - "productSpecifications": [] - } + "required": [ + "isShoppingCart", + "origin", + "salesChannel", + "profileId", + "items", + "params" ], - "params": [ - { - "name": "product@CatalogSystem", - "value": "2662" + "type": "object", + "properties": { + "isShoppingCart": { + "type": "boolean", + "description": "Indicates whether the item is a shopping cart.", + "example": false }, - { - "name": "couponCode@Marketing", - "value": "coupon" - } - ] - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK" + "origin": { + "type": "string", + "description": "Origin.", + "example": "origin" + }, + "salesChannel": { + "type": "string", + "description": "Sales channel.", + "example": "channel" + }, + "profileId": { + "type": "string", + "description": "Profile ID.", + "example": "1" + }, + "items": { + "type": "array", + "description": "List of items.", + "items": { + "description": "Object containing information about the items.", + "required": [ + "index", + "id", + "quantity", + "isGift", + "measurementUnit", + "unitMultiplier", + "priceTags", + "params", + "priceSheet", + "logisticsInfos", + "sellerId", + "productSpecifications" + ], + "type": "object", + "properties": { + "index": { + "type": "integer", + "format": "int32", + "description": "Index.", + "example": 1 + }, + "id": { + "type": "string", + "description": "Item ID.", + "example": "1" + }, + "quantity": { + "type": "integer", + "format": "int32", + "description": "The quantity of the item.", + "example": 1 + }, + "isGift": { + "type": "boolean", + "description": "Indicates whether the item is a gift.", + "example": true + }, + "measurementUnit": { + "type": "string", + "description": "Measurement unit.", + "example": "un" + }, + "unitMultiplier": { + "type": "integer", + "format": "int32", + "description": "Unit multiplier.", + "example": 1 + }, + "priceTags": { + "type": "array", + "description": "List of price tags.", + "items": { + "type": "string", + "description": "Price tag.", + "example": "tag" + } + }, + "params": { + "type": "array", + "description": "List of parameters.", + "items": { + "description": "Object containing information about the parameters.", + "required": [ + "name", + "value" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "Seller@CatalogSystem", + "description": "Name of the item." + }, + "value": { + "type": "string", + "example": "1", + "description": "Value." + } + } + } + }, + "priceSheet": { + "type": "array", + "description": "List of price sheet.", + "items": { + "type": "string", + "description": "Price sheet.", + "example": "pricesheet" + } + }, + "logisticsInfos": { + "type": "array", + "description": "List of logistics information.", + "items": { + "type": "string", + "description": "Logistic information.", + "example": "logistic" + } + }, + "sellerId": { + "type": "string", + "description": "Seller ID.", + "example": "1" + }, + "productSpecifications": { + "type": "array", + "description": "List of product specifications.", + "items": { + "type": "string", + "description": "Product specification.", + "example": "spefification" + } + } + } + } + } + } + }, + "example": { + "isShoppingCart": true, + "origin": "Marketplace", + "salesChannel": "1", + "profileId": "aa", + "items": [ + { + "index": 0, + "id": "160", + "quantity": 3, + "isGift": false, + "measurementUnit": "un", + "unitMultiplier": 1, + "priceTags": [], + "params": [ + { + "name": "Seller@CatalogSystem", + "value": "1" + }, + { + "name": "product@CatalogSystem", + "value": "94" + } + ], + "priceSheet": [], + "logisticsInfos": [], + "sellerId": "1", + "productSpecifications": [] + } + ], + "params": [ + { + "name": "product@CatalogSystem", + "value": "2662" + }, + { + "name": "couponCode@Marketing", + "value": "coupon" + } + ] + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "OK" } }, "deprecated": false, @@ -5849,17 +6399,22 @@ "listSku1BuyTogether": [], "listSku2BuyTogether": [], "listBrand1BuyTogether": [], - "listCategory1BuyTogether": [], + "listCategory1BuyTogether": [ + { + "id": "1", + "name": "Vinhos Tintos (1)" + } + ], "coupon": [], - "totalValueFloor": 0.0, - "totalValueCeling": 0.0, + "totalValueFloor": 0, + "totalValueCeling": 0, "totalValueIncludeAllItems": false, "totalValueMode": "IncludeMatchedItems", "collections": [], "collectionsIsInclusive": true, "restrictionsBins": [], "cardIssuers": [], - "totalValuePurchase": 0.0, + "totalValuePurchase": 0, "slasIds": [], "isSlaSelected": false, "isFirstBuy": false, @@ -5868,11 +6423,13 @@ "isDifferentListPriceAndPrice": false, "zipCodeRanges": [ { + "zipCodeFrom": "20000-000", + "zipCodeTo": "20000-100", "inclusive": true } ], - "itemMaxPrice": 0.0, - "itemMinPrice": 0.0, + "itemMaxPrice": 0, + "itemMinPrice": 0, "installment": 0, "isMinMaxInstallments": false, "minInstallment": 0, @@ -6013,15 +6570,25 @@ }, "stores": { "type": "array", - "deprecated": true + "deprecated": true, + "description": "List of stores.", + "items": { + "type": "string", + "description": "Store." + } }, "campaigns": { "type": "array", - "description": "Campaign Audiences that activate this promotion." + "description": "Campaign Audiences that activate this promotion.", + "items": { + "type": "string", + "description": "Campaign audience." + } }, "storesAreInclusive": { "type": "boolean", - "deprecated": true + "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", @@ -6115,13 +6682,38 @@ "type": "array", "description": "Collections that will generate the promotion, type **Buy Together**, **More for less**, **Progressive Discount**, **Buy One Get One**.", "items": { - "type": "string", - "description": "Collection ID." + "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 + "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", @@ -6137,23 +6729,84 @@ }, "listSku1BuyTogether": { "type": "array", - "description": "SKU first list for the promotion **Buy Together**." + "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": "SKU second list for the promotion **Buy Together**." + "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": "Brand first list for the promotion **Buy Together." + "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": "Category first list for the promotion **Buy Together**." + "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 + "deprecated": true, + "description": "List of coupons.", + "items": { + "type": "string", + "description": "Coupon code." + } }, "totalValueFloor": { "type": "number", @@ -6165,7 +6818,8 @@ }, "totalValueIncludeAllItems": { "type": "boolean", - "deprecated": true + "deprecated": true, + "description": "Total value including all items." }, "totalValueMode": { "type": "string", @@ -6203,7 +6857,12 @@ }, "cardIssuers": { "type": "array", - "deprecated": true + "deprecated": true, + "description": "List of card issuers.", + "items": { + "type": "string", + "description": "Card issuer." + } }, "totalValuePurchase": { "type": "number", @@ -6239,14 +6898,22 @@ }, "zipCodeRanges": { "type": "array", - "description": "Range of the zip code that applies the campaign audience.", + "description": "Range of zip codes that applies the promotion.", "items": { "type": "object", - "description": "Zip code that applies the campaign audience.", + "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 applies the campaign audience." + "description": "Defines if the zip code range is included in the promotion." } } } @@ -6261,7 +6928,8 @@ }, "installment": { "type": "integer", - "deprecated": true + "deprecated": true, + "description": "Installment." }, "isMinMaxInstallments": { "type": "boolean", @@ -6277,20 +6945,29 @@ }, "merchants": { "type": "array", - "deprecated": true + "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.", - "example": "email contains user@mail.com" + "description": "Cluster expression." } }, "paymentsRules": { "type": "array", - "deprecated": true + "deprecated": true, + "description": "List of payment rules.", + "items": { + "type": "string", + "description": "Payment rule." + } }, "giftListTypes": { "type": "array", @@ -6302,7 +6979,12 @@ }, "productsSpecifications": { "type": "array", - "deprecated": true + "deprecated": true, + "description": "List of product specifications.", + "items": { + "type": "string", + "description": "Product specification." + } }, "affiliates": { "type": "array", @@ -6445,17 +7127,22 @@ "listSku1BuyTogether": [], "listSku2BuyTogether": [], "listBrand1BuyTogether": [], - "listCategory1BuyTogether": [], + "listCategory1BuyTogether": [ + { + "id": "1", + "name": "Vinhos Tintos (1)" + } + ], "coupon": [], - "totalValueFloor": 0.0, - "totalValueCeling": 0.0, + "totalValueFloor": 0, + "totalValueCeling": 0, "totalValueIncludeAllItems": false, "totalValueMode": "IncludeMatchedItems", "collections": [], "collectionsIsInclusive": true, "restrictionsBins": [], "cardIssuers": [], - "totalValuePurchase": 0.0, + "totalValuePurchase": 0, "slasIds": [], "isSlaSelected": false, "isFirstBuy": false, @@ -6464,11 +7151,13 @@ "isDifferentListPriceAndPrice": false, "zipCodeRanges": [ { + "zipCodeFrom": "20000-000", + "zipCodeTo": "20000-100", "inclusive": true } ], - "itemMaxPrice": 0.0, - "itemMinPrice": 0.0, + "itemMaxPrice": 0, + "itemMinPrice": 0, "installment": 0, "isMinMaxInstallments": false, "minInstallment": 0, @@ -6614,15 +7303,25 @@ }, "stores": { "type": "array", - "deprecated": true + "deprecated": true, + "description": "List of stores.", + "items": { + "type": "string", + "description": "Store." + } }, "campaigns": { "type": "array", - "description": "Campaign Audiences that activate this promotion." + "description": "Campaign Audiences that activate this promotion.", + "items": { + "type": "string", + "description": "Campaign audience." + } }, "storesAreInclusive": { "type": "boolean", - "deprecated": true + "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", @@ -6716,13 +7415,38 @@ "type": "array", "description": "Collections that will generate the promotion, type **Buy Together**, **More for less**, **Progressive Discount**, **Buy One Get One**.", "items": { - "type": "string", - "description": "Collection ID." + "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 + "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", @@ -6738,23 +7462,84 @@ }, "listSku1BuyTogether": { "type": "array", - "description": "SKU first list for the promotion **Buy Together**." + "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": "SKU second list for the promotion **Buy Together**." + "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": "Brand first list for the promotion **Buy Together." + "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": "Category first list for the promotion **Buy Together**." + "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 + "deprecated": true, + "description": "List of coupons.", + "items": { + "type": "string", + "description": "Coupon code." + } }, "totalValueFloor": { "type": "number", @@ -6766,7 +7551,8 @@ }, "totalValueIncludeAllItems": { "type": "boolean", - "deprecated": true + "deprecated": true, + "description": "Total value including all items." }, "totalValueMode": { "type": "string", @@ -6804,7 +7590,12 @@ }, "cardIssuers": { "type": "array", - "deprecated": true + "deprecated": true, + "description": "List of card issuers.", + "items": { + "type": "string", + "description": "Card issuer." + } }, "totalValuePurchase": { "type": "number", @@ -6840,14 +7631,22 @@ }, "zipCodeRanges": { "type": "array", - "description": "Range of the zip code that applies the campaign audience.", + "description": "Range of zip codes that applies the promotion.", "items": { "type": "object", - "description": "Zip code that applies the campaign audience.", + "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 applies the campaign audience." + "description": "Defines if the zip code range is included in the promotion." } } } @@ -6862,7 +7661,8 @@ }, "installment": { "type": "integer", - "deprecated": true + "deprecated": true, + "description": "Installment." }, "isMinMaxInstallments": { "type": "boolean", @@ -6878,24 +7678,34 @@ }, "merchants": { "type": "array", - "deprecated": true + "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.", - "example": "email contains user@mail.com" + "description": "Cluster expression." } }, "clusterOperator": { "type": "string", - "deprecated": true + "deprecated": true, + "description": "Cluster operator." }, "paymentsRules": { "type": "array", - "deprecated": true + "deprecated": true, + "description": "List of payment rules.", + "items": { + "type": "string", + "description": "Payment rule." + } }, "giftListTypes": { "type": "array", @@ -6907,7 +7717,12 @@ }, "productsSpecifications": { "type": "array", - "deprecated": true + "deprecated": true, + "description": "List of product specifications.", + "items": { + "type": "string", + "description": "Product specification." + } }, "affiliates": { "type": "array", @@ -6998,7 +7813,6 @@ } ], "requestBody": { - "description": "", "content": { "application/json": { "schema": { @@ -7142,16 +7956,28 @@ }, "stores": { "type": "array", - "deprecated": true + "deprecated": true, + "description": "List of stores.", + "items": { + "type": "string", + "description": "Store.", + "example": "store" + } }, "campaigns": { "type": "array", "description": "Campaign Audiences that activate this promotion.", - "example": [] + "items": { + "type": "string", + "description": "Campaign.", + "example": "campaign" + } }, "storesAreInclusive": { "type": "boolean", - "deprecated": true + "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.", + "example": false }, "categories": { "type": "array", @@ -7257,14 +8083,42 @@ "type": "array", "description": "Collections that will generate the promotion, type **Buy Together**, **More for less**, **Progressive Discount**, **Buy One Get One**.", "items": { - "type": "string", - "description": "Collection ID.", - "example": "1" + "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.", + "example": "157" + }, + "name": { + "type": "string", + "description": "Name of the collection to be added to the first list of the **Buy Together** promotion.", + "example": "Inverno (157)" + } + } } }, "collections2BuyTogether": { "type": "array", - "deprecated": true + "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.", + "example": "157" + }, + "name": { + "type": "string", + "description": "Name of the collection to be added to the first list of the **Buy Together** promotion.", + "example": "Inverno (157)" + } + } + } }, "minimumQuantityBuyTogether": { "type": "integer", @@ -7283,55 +8137,109 @@ }, "listSku1BuyTogether": { "type": "array", - "description": "SKU first list for the promotion **Buy Together**.", - "example": [] + "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.", + "example": "1" + }, + "name": { + "type": "string", + "description": "Name of the SKU to be added to the first list of the **Buy Together** promotion.", + "example": "Vinho" + } + } + } }, "listSku2BuyTogether": { "type": "array", - "description": "SKU second list for the promotion **Buy Together**.", - "example": [] + "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.", + "example": "1" + }, + "name": { + "type": "string", + "description": "Name of the SKU to be added to the second list of the **Buy Together** promotion.", + "example": "Vinho" + } + } + } }, "listBrand1BuyTogether": { "type": "array", - "description": "Brand first list for the promotion **Buy Together.", - "example": [] + "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.", + "example": "1" + }, + "name": { + "type": "string", + "description": "Name of the brand to be added to the first list of the **Buy Together** promotion.", + "example": "Malbec" + } + } + } }, "listCategory1BuyTogether": { "type": "array", - "description": "Category first list for the promotion **Buy Together**.", + "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": "Category ID.", + "description": "ID of the category to be added to the first list of the **Buy Together** promotion.", "example": "1" }, "name": { "type": "string", - "description": "Category name.", - "example": "Vinhos Tintos (1)" + "description": "Name of the category to be added to the first list of the **Buy Together** promotion.", + "example": "Vinhos Tintos" } } } }, "coupon": { "type": "array", - "deprecated": true + "deprecated": true, + "description": "List of coupons.", + "items": { + "type": "string", + "description": "Coupon.", + "example": "coupon code." + } }, "totalValueFloor": { "type": "number", "description": "Minimum chart value to active the campaign audience.", - "example": 40.0 + "example": 40 }, "totalValueCeling": { "type": "number", "description": "Maximum chart value to active the campaign audience.", - "example": 0.0 + "example": 0 }, "totalValueIncludeAllItems": { "type": "boolean", - "deprecated": true + "deprecated": true, + "description": "Total value including all items.", + "example": false }, "totalValueMode": { "type": "string", @@ -7374,12 +8282,18 @@ }, "cardIssuers": { "type": "array", - "deprecated": true + "deprecated": true, + "description": "List of card issuers.", + "items": { + "type": "string", + "description": "Card issuer.", + "example": "issuer" + } }, "totalValuePurchase": { "type": "number", "description": "Total value a client must have in past orders to active the campaign audience.", - "example": 0.0 + "example": 0 }, "slasIds": { "type": "array", @@ -7417,15 +8331,25 @@ }, "zipCodeRanges": { "type": "array", - "description": "Range of the zip code that applies the campaign audience.", + "description": "Range of the zip code that applies the promotion.", "items": { "type": "object", - "description": "Zip code that applies the campaign audience.", + "description": "Object with information of the Zip Code", "properties": { + "zipCodeFrom": { + "type": "string", + "description": "Initial Zip Code.", + "example": "20000-000" + }, + "zipCodeTo": { + "type": "string", + "description": "Final Zip Code.", + "example": "20000-100" + }, "inclusive": { "type": "boolean", - "description": "Defines if the zip code applies the campaign audience.", - "example": false + "description": "Defines if the zip code range is included in the promotion.", + "example": true } } } @@ -7433,16 +8357,18 @@ "itemMaxPrice": { "type": "number", "description": "Maximum price of the item.", - "example": 0.0 + "example": 0 }, "itemMinPrice": { "type": "number", "description": "Minimum price of the item.", - "example": 0.0 + "example": 0 }, "installment": { "type": "integer", - "deprecated": true + "deprecated": true, + "description": "Installment.", + "example": 1 }, "isMinMaxInstallments": { "type": "boolean", @@ -7461,7 +8387,13 @@ }, "merchants": { "type": "array", - "deprecated": true + "deprecated": true, + "description": "List of merchants.", + "items": { + "type": "string", + "description": "Merchant.", + "example": "merchant" + } }, "clusterExpressions": { "type": "array", @@ -7474,11 +8406,19 @@ }, "clusterOperator": { "type": "string", - "deprecated": true + "deprecated": true, + "description": "Cluster operator.", + "example": "operator" }, "paymentsRules": { "type": "array", - "deprecated": true + "deprecated": true, + "description": "List of payment rules.", + "items": { + "type": "string", + "description": "Payment rule.", + "example": "rule1" + } }, "giftListTypes": { "type": "array", @@ -7491,7 +8431,13 @@ }, "productsSpecifications": { "type": "array", - "deprecated": true + "deprecated": true, + "description": "List of product specifications.", + "items": { + "type": "string", + "description": "Product specification.", + "example": "spec" + } }, "affiliates": { "type": "array", @@ -7544,7 +8490,7 @@ "items": { "type": "number", "description": "Percentual discount value.", - "example": 0.0 + "example": 0 } } } @@ -7607,17 +8553,22 @@ "listSku1BuyTogether": [], "listSku2BuyTogether": [], "listBrand1BuyTogether": [], - "listCategory1BuyTogether": [], + "listCategory1BuyTogether": [ + { + "id": "1", + "name": "Vinhos Tintos (1)" + } + ], "coupon": [], - "totalValueFloor": 0.0, - "totalValueCeling": 0.0, + "totalValueFloor": 0, + "totalValueCeling": 0, "totalValueIncludeAllItems": false, "totalValueMode": "IncludeMatchedItems", "collections": [], "collectionsIsInclusive": true, "restrictionsBins": [], "cardIssuers": [], - "totalValuePurchase": 0.0, + "totalValuePurchase": 0, "slasIds": [], "isSlaSelected": false, "isFirstBuy": false, @@ -7626,11 +8577,13 @@ "isDifferentListPriceAndPrice": false, "zipCodeRanges": [ { + "zipCodeFrom": "20000-000", + "zipCodeTo": "20000-100", "inclusive": true } ], - "itemMaxPrice": 0.0, - "itemMinPrice": 0.0, + "itemMaxPrice": 0, + "itemMinPrice": 0, "installment": 0, "isMinMaxInstallments": false, "minInstallment": 0, @@ -7770,15 +8723,25 @@ }, "stores": { "type": "array", - "deprecated": true + "deprecated": true, + "description": "List of stores.", + "items": { + "type": "string", + "description": "Store." + } }, "campaigns": { "type": "array", - "description": "Campaign Audiences that activate this promotion." + "description": "Campaign Audiences that activate this promotion.", + "items": { + "type": "string", + "description": "Campaign." + } }, "storesAreInclusive": { "type": "boolean", - "deprecated": true + "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", @@ -7872,13 +8835,38 @@ "type": "array", "description": "Collections that will generate the promotion, type **Buy Together**, **More for less**, **Progressive Discount**, **Buy One Get One**.", "items": { - "type": "string", - "description": "Collection ID." + "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 + "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", @@ -7894,23 +8882,84 @@ }, "listSku1BuyTogether": { "type": "array", - "description": "SKU first list for the promotion **Buy Together**." + "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": "SKU second list for the promotion **Buy Together**." + "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": "Brand first list for the promotion **Buy Together." + "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": "Category first list for the promotion **Buy Together**." + "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 + "deprecated": true, + "description": "List of coupons.", + "items": { + "type": "string", + "description": "Coupon code." + } }, "totalValueFloor": { "type": "number", @@ -7922,7 +8971,8 @@ }, "totalValueIncludeAllItems": { "type": "boolean", - "deprecated": true + "deprecated": true, + "description": "Total value including all items." }, "totalValueMode": { "type": "string", @@ -7960,7 +9010,12 @@ }, "cardIssuers": { "type": "array", - "deprecated": true + "deprecated": true, + "description": "List of card issuers.", + "items": { + "type": "string", + "description": "Card issuer." + } }, "totalValuePurchase": { "type": "number", @@ -7996,14 +9051,22 @@ }, "zipCodeRanges": { "type": "array", - "description": "Range of the zip code that applies the campaign audience.", + "description": "Range of the zip code that applies the promotion.", "items": { "type": "object", - "description": "Zip code that applies the campaign audience.", + "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 applies the campaign audience." + "description": "Defines if the zip code range is included in the promotion." } } } @@ -8018,7 +9081,8 @@ }, "installment": { "type": "integer", - "deprecated": true + "deprecated": true, + "description": "Installment." }, "isMinMaxInstallments": { "type": "boolean", @@ -8034,24 +9098,34 @@ }, "merchants": { "type": "array", - "deprecated": true + "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.", - "example": "email contains user@mail.com" + "description": "Cluster expression." } }, "clusterOperator": { "type": "string", - "deprecated": true + "deprecated": true, + "description": "Cluster operator." }, "paymentsRules": { "type": "array", - "deprecated": true + "deprecated": true, + "description": "List of payment rules.", + "items": { + "type": "string", + "description": "Payment rule." + } }, "giftListTypes": { "type": "array", @@ -8063,7 +9137,12 @@ }, "productsSpecifications": { "type": "array", - "deprecated": true + "deprecated": true, + "description": "List of product specifications.", + "items": { + "type": "string", + "description": "Product specification." + } }, "affiliates": { "type": "array", @@ -8155,14 +9234,64 @@ } ], "requestBody": { - "description": "", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UsagenotificationRequest" + "required": [ + "orderId", + "profileId", + "accountId", + "calculatorIds", + "used", + "coupon", + "itemsCount" + ], + "type": "object", + "properties": { + "orderId": { + "type": "string", + "description": "Order ID.", + "example": "1" + }, + "profileId": { + "type": "string", + "description": "Profile ID.", + "example": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" + }, + "accountId": { + "type": "string", + "description": "Account ID.", + "example": "ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj" + }, + "calculatorIds": { + "type": "array", + "description": "List of calculator IDs.", + "items": { + "type": "string", + "description": "Calculator ID.", + "example": "discount_basetestqa_1" + } + }, + "used": { + "type": "boolean", + "description": "Indicates whether the item has been used or not.", + "example": false + }, + "coupon": { + "type": "string", + "description": "Indicates whether a coupon is applicable to the item.", + "example": "cupom" + }, + "itemsCount": { + "type": "integer", + "format": "int32", + "description": "Items count.", + "example": 1 + } + } }, "example": { - "orderId": "vbbbbbb-1", + "orderId": "1", "profileId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "accountId": "ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj", "calculatorIds": [ @@ -8198,8 +9327,6 @@ "components": { "schemas": { "GetPromotions": { - "type": "array", - "description": "Array with promotions.", "items": { "type": "object", "description": "Object with information about a promotion.", @@ -8268,19 +9395,17 @@ "description": "Defines if it is a tax.", "type": "boolean" }, - "Campaigns": { - "description": "Array with campaign audiences that activate this promotion.", + "campaigns": { + "description": "Campaign Audiences that activate this promotion.", "type": "array", "items": { "type": "string", - "description": "Campaign Audience.", - "example": "Campaign Audience example" + "description": "Campaign Audience." } }, "activateGiftsMultiplier": { "description": "If set as `true`, it activates gifts Multiplier.", - "type": "boolean", - "example": false + "type": "boolean" }, "scope": { "description": "Scope of the promotion.", @@ -8288,68 +9413,55 @@ "properties": { "allCatalog": { "description": "Determines if the promotion applies to all products in the Catalog (`true`) or not (`false`).", - "type": "boolean", - "example": false + "type": "boolean" }, "skus": { "description": "Quantity of SKUs which activate or deactivate the promotion.", - "type": "number", - "example": 1 + "type": "number" }, "skusAreInclusive": { "description": "If set to `true`, this promotion will be applied to any SKU present on the `skus` field. If set to `false`, SKUs present on that field will make this promotion not to be applied.", - "type": "boolean", - "example": true + "type": "boolean" }, "products": { "description": "Quantity of products which activate or deactivate the promotion.", - "type": "number", - "example": 1 + "type": "number" }, "productsAreInclusive": { "description": "If set to `true`, this promotion will be applied to any product present on the `products` field. If set to `false`, products present on that field will make this promotion not to be applied.", - "type": "boolean", - "example": true + "type": "boolean" }, "collections": { "description": "Quantity of collections which activate or deactivate the promotion.", - "type": "number", - "example": 1 + "type": "number" }, "collectionsAreInclusive": { "description": "If set to `true`, this promotion will be applied to any collection present on the `collections` field. If set to `false`, collections present on that field will make this promotion not to be applied.", - "type": "boolean", - "example": true + "type": "boolean" }, "categories": { "description": "Quantity of categories which activate or deactivate the promotion.", - "type": "number", - "example": 1 + "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.", - "example": true + "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", - "example": 1 + "type": "number" }, "brandsAreInclusive": { "description": "If set to `true`, this promotion will be applied to any brand present on the `brands` field. If set to `false`, brands present on that field will make this promotion not to be applied.", - "type": "boolean", - "example": true + "type": "boolean" }, "sellers": { "description": "Quantity of sellers which activate or deactivate the promotion.", - "type": "number", - "example": 0 + "type": "number" }, "sellersAreInclusive": { "description": "If set to `true`, this promotion will be applied to any seller present on the `sellers` field. If set to `false`, sellers present on that field will make this promotion not to be applied.", - "type": "boolean", - "example": false + "type": "boolean" } } }, @@ -8443,19 +9555,17 @@ "description": "Defines if it is a tax.", "type": "boolean" }, - "Campaigns": { - "description": "Array with campaign audiences that activate this tax.", + "campaigns": { "type": "array", + "description": "Campaign Audiences that activate this promotion.", "items": { "type": "string", - "description": "Campaign Audience.", - "example": "Campaign Audience example" + "description": "Campaign." } }, "activateGiftsMultiplier": { "description": "If set as `true`, it activates gifts Multiplier.", - "type": "boolean", - "example": false + "type": "boolean" }, "scope": { "description": "Scope of the tax.", @@ -8463,68 +9573,55 @@ "properties": { "allCatalog": { "description": "Determines if the tax applies to all products in the Catalog (`true`) or not (`false`).", - "type": "boolean", - "example": false + "type": "boolean" }, "skus": { "description": "Quantity of SKUs which activate or deactivate the tax.", - "type": "number", - "example": 1 + "type": "number" }, "skusAreInclusive": { "description": "If set to `true`, this tax will be applied to any SKU present on the `skus` field. If set to `false`, SKUs present on that field will make this tax not to be applied.", - "type": "boolean", - "example": true + "type": "boolean" }, "products": { "description": "Quantity of products which activate or deactivate the tax.", - "type": "number", - "example": 1 + "type": "number" }, "productsAreInclusive": { "description": "If set to `true`, this tax will be applied to any product present on the `products` field. If set to `false`, products present on that field will make this tax not to be applied.", - "type": "boolean", - "example": true + "type": "boolean" }, "collections": { "description": "Quantity of collections which activate or deactivate the tax.", - "type": "number", - "example": 1 + "type": "number" }, "collectionsAreInclusive": { "description": "If set to `true`, this tax will be applied to any collection present on the `collections` field. If set to `false`, collections present on that field will make this tax not to be applied.", - "type": "boolean", - "example": true + "type": "boolean" }, "categories": { "description": "Quantity of categories which activate or deactivate the tax.", - "type": "number", - "example": 1 + "type": "number" }, "categoriesAreInclusive": { "type": "boolean", - "description": "If set to `true`, this tax will be applied to any category present on the `categories` field. If set to `false`, categories present on that field will make this tax not to be applied.", - "example": true + "description": "If set to `true`, this tax will be applied to any category present on the `categories` field. If set to `false`, categories present on that field will make this tax not to be applied." }, "brands": { "description": "Quantity of brands which activate or deactivate the tax.", - "type": "number", - "example": 1 + "type": "number" }, "brandsAreInclusive": { "description": "If set to `true`, this tax will be applied to any brand present on the `brands` field. If set to `false`, brands present on that field will make this tax not to be applied.", - "type": "boolean", - "example": true + "type": "boolean" }, "sellers": { "description": "Quantity of sellers which activate or deactivate the tax.", - "type": "number", - "example": 0 + "type": "number" }, "sellersAreInclusive": { "description": "If set to `true`, this tax will be applied to any seller present on the `sellers` field. If set to `false`, sellers present on that field will make this tax not to be applied.", - "type": "boolean", - "example": false + "type": "boolean" } } }, @@ -8546,374 +9643,26 @@ } } } - }, - "PricebycontextRequest": { - "required": [ - "id", - "itemId", - "salesChannel", - "sellerId", - "validFrom", - "validTo" - ], - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int32" - }, - "itemId": { - "type": "integer", - "format": "int32" - }, - "salesChannel": { - "type": "integer", - "format": "int32" - }, - "sellerId": { - "type": "string" - }, - "validFrom": { - "type": "string" - }, - "validTo": { - "type": "string" - } - }, - "example": { - "id": 6324, - "itemId": 2390148, - "salesChannel": 1, - "sellerId": "1", - "validFrom": "1900-01-01T00:00:00", - "validTo": "4000-01-01T00:00:00" - } - }, - "SavepriceRequest": { - "required": [ - "itemId", - "salesChannel", - "sellerId", - "price", - "listPrice", - "validFrom", - "validTo" - ], - "type": "object", - "properties": { - "itemId": { - "type": "integer", - "format": "int32" - }, - "salesChannel": { - "type": "integer", - "format": "int32" - }, - "sellerId": { - "type": "integer", - "format": "int32" - }, - "price": { - "type": "integer", - "format": "int32" - }, - "listPrice": { - "type": "integer", - "format": "int32" - }, - "validFrom": { - "type": "string" - }, - "validTo": { - "type": "string" - } - }, - "example": { - "itemId": 2390148, - "salesChannel": 1, - "sellerId": 1, - "price": 1, - "listPrice": 1, - "validFrom": "2016-01-01T02:00:00Z", - "validTo": "2017-01-01T02:00:00Z" - } - }, - "Calculatediscountsandtaxes_Bundles_Request": { - "required": [ - "isShoppingCart", - "origin", - "salesChannel", - "profileId", - "items", - "params" - ], - "type": "object", - "properties": { - "isShoppingCart": { - "type": "boolean" - }, - "origin": { - "type": "string" - }, - "salesChannel": { - "type": "string" - }, - "profileId": { - "type": "string" - }, - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Item" - }, - "description": "" - }, - "params": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Param" - }, - "description": "" - } - }, - "example": { - "isShoppingCart": true, - "origin": "Marketplace", - "salesChannel": "1", - "profileId": "aa", - "items": [ - { - "index": 0, - "id": "160", - "quantity": 3, - "isGift": false, - "measurementUnit": "un", - "unitMultiplier": 1, - "priceTags": [], - "params": [ - { - "name": "Seller@CatalogSystem", - "value": "1" - }, - { - "name": "product@CatalogSystem", - "value": "94" - } - ], - "priceSheet": [], - "logisticsInfos": [], - "sellerId": "1", - "productSpecifications": [] - } - ], - "params": [ - { - "name": "product@CatalogSystem", - "value": "2662" - }, - { - "name": "couponCode@Marketing", - "value": "coupon" - } - ] - } - }, - "Item": { - "required": [ - "index", - "id", - "quantity", - "isGift", - "measurementUnit", - "unitMultiplier", - "priceTags", - "params", - "priceSheet", - "logisticsInfos", - "sellerId", - "productSpecifications" - ], - "type": "object", - "properties": { - "index": { - "type": "integer", - "format": "int32" - }, - "id": { - "type": "string" - }, - "quantity": { - "type": "integer", - "format": "int32" - }, - "isGift": { - "type": "boolean" - }, - "measurementUnit": { - "type": "string" - }, - "unitMultiplier": { - "type": "integer", - "format": "int32" - }, - "priceTags": { - "type": "array", - "items": { - "type": "string" - }, - "description": "" - }, - "params": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Param" - }, - "description": "" - }, - "priceSheet": { - "type": "array", - "items": { - "type": "string" - }, - "description": "" - }, - "logisticsInfos": { - "type": "array", - "items": { - "type": "string" - }, - "description": "" - }, - "sellerId": { - "type": "string" - }, - "productSpecifications": { - "type": "array", - "items": { - "type": "string" - }, - "description": "" - } - }, - "example": { - "index": 0, - "id": "160", - "quantity": 3, - "isGift": false, - "measurementUnit": "un", - "unitMultiplier": 1, - "priceTags": [], - "params": [ - { - "name": "Seller@CatalogSystem", - "value": "1" - }, - { - "name": "product@CatalogSystem", - "value": "94" - } - ], - "priceSheet": [], - "logisticsInfos": [], - "sellerId": "1", - "productSpecifications": [] - } - }, - "Param": { - "required": [ - "name", - "value" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "value": { - "type": "string" - } - }, - "example": { - "name": "Seller@CatalogSystem", - "value": "1" - } - }, - "ZipCodeRange": { - "required": [ - "inclusive" - ], - "type": "object", - "properties": { - "inclusive": { - "type": "boolean" - } - }, - "example": { - "inclusive": true - } - }, - "UsagenotificationRequest": { - "required": [ - "orderId", - "profileId", - "accountId", - "calculatorIds", - "used", - "coupon", - "itemsCount" - ], - "type": "object", - "properties": { - "orderId": { - "type": "string" - }, - "profileId": { - "type": "string" - }, - "accountId": { - "type": "string" - }, - "calculatorIds": { - "type": "array", - "items": { - "type": "string" - }, - "description": "" - }, - "used": { - "type": "boolean" - }, - "coupon": { - "type": "string" - }, - "itemsCount": { - "type": "integer", - "format": "int32" - } - }, - "example": { - "orderId": "vbbbbbb-1", - "profileId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", - "accountId": "ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj", - "calculatorIds": [ - "discount_basetestqa_1" - ], - "used": true, - "coupon": "cupom", - "itemsCount": 4 - } } }, "securitySchemes": { "appKey": { "type": "apiKey", "in": "header", - "name": "X-VTEX-API-AppKey" + "name": "X-VTEX-API-AppKey", + "description": "Unique identifier of the [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys)." }, "appToken": { "type": "apiKey", "in": "header", - "name": "X-VTEX-API-AppToken" + "name": "X-VTEX-API-AppToken", + "description": "Secret token of the [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys)." + }, + "VtexIdclientAutCookie": { + "type": "apiKey", + "in": "header", + "name": "VtexIdclientAutCookie", + "description": "[User token](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens), valid for 24 hours." } } }, @@ -8941,6 +9690,9 @@ { "appKey": [], "appToken": [] + }, + { + "VtexIdclientAutCookie": [] } ] } \ No newline at end of file