From fa4c0f8f513952a9c94cf1ed870f21b641485c3e Mon Sep 17 00:00:00 2001 From: Pedro Antunes <47991446+PedroAntunesCosta@users.noreply.github.com> Date: Mon, 18 May 2026 20:13:31 -0300 Subject: [PATCH 1/2] chore: remove manual Index section from Promotions & Taxes API v2 overview --- VTEX - Promotions & Taxes API - v2.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/VTEX - Promotions & Taxes API - v2.json b/VTEX - Promotions & Taxes API - v2.json index 77b2e99406..7f80f1278e 100644 --- a/VTEX - Promotions & Taxes API - v2.json +++ b/VTEX - Promotions & Taxes API - v2.json @@ -2,7 +2,7 @@ "openapi": "3.0.0", "info": { "title": "Promotions & Taxes API v2", - "description": "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 coupons from your VTEX store.\r\n\r\n ## Index\r\n\r\n ### Coupons \r\n- `GET` [Get coupons](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api-v2#get-/api/rnb/v2/pvt/coupon)\r\n- `GET` [Get archived coupons](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api-v2#get-/api/rnb/v2/pvt/coupon/group/archived)\r\n- `GET` [Get coupon batch information](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api-v2#get-/api/rnb/v2/pvt/coupon/group/-groupingKey-)\r\n- `PUT` [Edit coupon batch configuration](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api-v2#put-/api/rnb/v2/pvt/coupon/group/-groupingKey-)\r\n- `GET` [Get coupon batch codes](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api-v2#get-/api/rnb/v2/pvt/coupon/group/-groupingKey-/codes)\r\n- `PUT` [Archive a coupon batch](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api-v2#put-/api/rnb/v2/pvt/coupon/group/-groupingKey-/archive)\r\n- `POST` [Create coupon batches](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api-v2#post-/api/rnb/v2/pvt/coupon/group)\r\n- `PUT` [Unarchive a coupon batch](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api-v2#put-/api/rnb/v2/pvt/coupon/group/-groupingKey-/unarchive)\r\n- `GET` [Get usage count for a single coupon](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api-v2#get-/api/rnb/v2/pvt/coupon/usage-count/-couponCode-)\r\n- `GET` [Get usage count for a coupon batch](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api-v2#get-/api/rnb/v2/pvt/coupon/usage-count/group/-groupingKey-)\r\n\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", + "description": "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 coupons from your VTEX store.\n\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" }, From a96ad06e961685f2099d1802cc4d760a6c4ac045 Mon Sep 17 00:00:00 2001 From: PedroAntunesCosta <> Date: Mon, 18 May 2026 23:14:37 +0000 Subject: [PATCH 2/2] chore: update postman files --- .../VTEX - Promotions & Taxes API - v2.json | 987 +++++------------- 1 file changed, 254 insertions(+), 733 deletions(-) diff --git a/PostmanCollections/VTEX - Promotions & Taxes API - v2.json b/PostmanCollections/VTEX - Promotions & Taxes API - v2.json index ea34fddf6e..030765aa80 100644 --- a/PostmanCollections/VTEX - Promotions & Taxes API - v2.json +++ b/PostmanCollections/VTEX - Promotions & Taxes API - v2.json @@ -1,10 +1,10 @@ { "_": { - "postman_id": "4f5f3e57-a5e6-4af0-9042-642e539d37de" + "postman_id": "5c9a1a02-6c7a-417f-921d-524d23d73994" }, "item": [ { - "id": "cad21542-c20b-46be-a22d-07a3f3da3dff", + "id": "df79bc4e-8345-4889-b6ce-5a8806a6fb59", "name": "Coupons", "description": { "content": "", @@ -12,7 +12,7 @@ }, "item": [ { - "id": "18f12a56-bd4e-4bce-84d0-7d3feb2f0261", + "id": "1730cdcb-e7ca-4477-be61-154ca45ce432", "name": "Get coupons", "request": { "name": "Get coupons", @@ -32,26 +32,7 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ { @@ -71,16 +52,21 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "GET" + "method": "GET", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, - "id": "fd877093-9855-4fcb-8b90-084d52067b63", + "id": "2fbdb70d-6474-41c9-a099-829db54b2570", "name": "OK", "originalRequest": { "url": { @@ -95,36 +81,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -146,6 +105,14 @@ { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "GET", @@ -167,7 +134,7 @@ { "listen": "test", "script": { - "id": "61fc4ea2-5d7d-4ac2-a556-840b16cf7e57", + "id": "02ae946c-d959-4877-9e71-b68cea1b11e1", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/rnb/v2/pvt/coupon - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -183,7 +150,7 @@ } }, { - "id": "60623796-73b6-40de-b9a5-bbbf57604eff", + "id": "d64c0818-f4a6-419e-9947-a6470380e096", "name": "Get archived coupons", "request": { "name": "Get archived coupons", @@ -205,26 +172,7 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ { @@ -244,16 +192,21 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "GET" + "method": "GET", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, - "id": "b45f1ce9-959d-4f4a-9e8c-9ac150043053", + "id": "500897b8-b561-41d2-9344-bf986adf3346", "name": "OK", "originalRequest": { "url": { @@ -270,36 +223,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -321,6 +247,14 @@ { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "GET", @@ -342,7 +276,7 @@ { "listen": "test", "script": { - "id": "f3351d89-ffe0-4252-8090-364a13f959a7", + "id": "7e82947e-5d59-4b7a-9a33-ba7c70848eda", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/rnb/v2/pvt/coupon/group/archived - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -358,7 +292,7 @@ } }, { - "id": "bdbbac0a-ddf7-4a36-9caf-ce9f73b7b2b5", + "id": "3d2c2579-2c9f-4afc-b1bb-8d6b55b30af0", "name": "Get coupon batch information", "request": { "name": "Get coupon batch information", @@ -390,24 +324,6 @@ "type": "any", "value": "promo", "key": "groupingKey" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" } ] }, @@ -429,16 +345,21 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "GET" + "method": "GET", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, - "id": "ed2d5aff-2b2e-45e9-aabd-2130c26d2471", + "id": "12686905-e4bb-48f3-a6b2-5e75c9f50e71", "name": "OK", "originalRequest": { "url": { @@ -455,46 +376,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) Coupon grouping key, which is the prefix for the coupon batch's generated codes.", - "type": "text/plain" - }, - "type": "any", - "value": "promo", - "key": "groupingKey" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -516,6 +400,14 @@ { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "GET", @@ -537,7 +429,7 @@ { "listen": "test", "script": { - "id": "0414cc56-70f9-4fef-8bd8-ff77287ff543", + "id": "41c21863-9082-450a-a989-2f3aaf13c368", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/rnb/v2/pvt/coupon/group/:groupingKey - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -553,7 +445,7 @@ } }, { - "id": "dbda052b-aa25-478f-abee-123a50c6c0d5", + "id": "3e38e457-f59c-416e-9d98-314980259847", "name": "Edit coupon batch configuration", "request": { "name": "Edit coupon batch configuration", @@ -585,24 +477,6 @@ "type": "any", "value": "promo", "key": "groupingKey" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" } ] }, @@ -624,6 +498,14 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], "method": "PUT", @@ -632,6 +514,7 @@ "raw": "{\n \"utmSource\": \"source\",\n \"isArchived\": false,\n \"maxItemsPerClient\": 0,\n \"expirationIntervalPerUse\": \"00:00:00\",\n \"maxUsage\": 4\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -642,7 +525,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "30c44b51-4a11-4dac-a166-dc0e54ab3063", + "id": "b697b89a-ef38-4ac2-bab9-a3f7aaff6867", "name": "OK", "originalRequest": { "url": { @@ -659,46 +542,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) Coupon grouping key, which is the prefix for the coupon batch's generated codes.", - "type": "text/plain" - }, - "type": "any", - "value": "promo", - "key": "groupingKey" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -717,9 +563,21 @@ "key": "Accept", "value": "application/json" }, + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "PUT", @@ -728,6 +586,7 @@ "raw": "{\n \"utmSource\": \"source\",\n \"isArchived\": false,\n \"maxItemsPerClient\": 0,\n \"expirationIntervalPerUse\": \"00:00:00\",\n \"maxUsage\": 4\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -748,7 +607,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "8dff880c-8df0-474e-8193-68220742b608", + "id": "1c3ce7d6-cb21-439b-8740-850a727e981e", "name": "Bad Request", "originalRequest": { "url": { @@ -765,46 +624,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) Coupon grouping key, which is the prefix for the coupon batch's generated codes.", - "type": "text/plain" - }, - "type": "any", - "value": "promo", - "key": "groupingKey" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -823,9 +645,21 @@ "key": "Accept", "value": "application/json" }, + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "text/plain" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "PUT", @@ -834,6 +668,7 @@ "raw": "{\n \"utmSource\": \"source\",\n \"isArchived\": false,\n \"maxItemsPerClient\": 0,\n \"expirationIntervalPerUse\": \"00:00:00\",\n \"maxUsage\": 4\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -855,7 +690,7 @@ { "listen": "test", "script": { - "id": "b50d972a-f7e7-44e2-a2ea-810d6e43d49c", + "id": "0f46c569-e7f3-4042-84a7-c7c9b7851311", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/api/rnb/v2/pvt/coupon/group/:groupingKey - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -871,7 +706,7 @@ } }, { - "id": "d7596566-abfc-42d8-a9a9-d4f106e1a907", + "id": "78161f67-0d71-42ff-8ee7-5fb13d316c22", "name": "Get coupon batch codes", "request": { "name": "Get coupon batch codes", @@ -904,24 +739,6 @@ "type": "any", "value": "promo", "key": "groupingKey" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" } ] }, @@ -943,16 +760,21 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "GET" + "method": "GET", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, - "id": "b6a19c87-ee2e-4d58-b988-83d490ce165b", + "id": "7283213b-57d1-4be0-91b3-e0ec0f96ee44", "name": "OK", "originalRequest": { "url": { @@ -970,46 +792,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) Coupon grouping key, which is the prefix for the coupon batch's generated codes.", - "type": "text/plain" - }, - "type": "any", - "value": "promo", - "key": "groupingKey" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -1031,6 +816,14 @@ { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "GET", @@ -1051,7 +844,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "0916ba99-4f09-4051-afb1-e87c71005177", + "id": "a0466ff1-0509-461b-8461-95bd0acf1429", "name": "Not Found", "originalRequest": { "url": { @@ -1069,46 +862,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) Coupon grouping key, which is the prefix for the coupon batch's generated codes.", - "type": "text/plain" - }, - "type": "any", - "value": "promo", - "key": "groupingKey" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -1130,6 +886,14 @@ { "key": "Accept", "value": "text/plain" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "GET", @@ -1151,7 +915,7 @@ { "listen": "test", "script": { - "id": "fee8ab4e-5cf0-4b3b-9194-f2625c26350f", + "id": "65298cd3-8f97-4b5e-857a-d668f57fd1c6", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/rnb/v2/pvt/coupon/group/:groupingKey/codes - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1167,7 +931,7 @@ } }, { - "id": "566a66ee-aa19-4ee1-9c44-e593a201ad9d", + "id": "3859fd79-6315-4200-9ec7-e23e07d66fb5", "name": "Archive a coupon batch", "request": { "name": "Archive a coupon batch", @@ -1200,24 +964,6 @@ "type": "any", "value": "promo", "key": "groupingKey" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" } ] }, @@ -1239,16 +985,21 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "PUT" + "method": "PUT", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, - "id": "523cbae3-0b9f-4ae6-a825-5b3e22d57b38", + "id": "e5c8d8c5-17ab-4fe8-9761-d3faacdd3aa5", "name": "OK", "originalRequest": { "url": { @@ -1266,46 +1017,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) Coupon grouping key, which is the prefix for the coupon batch's generated codes.", - "type": "text/plain" - }, - "type": "any", - "value": "promo", - "key": "groupingKey" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -1327,6 +1041,14 @@ { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "PUT", @@ -1347,7 +1069,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "0385c5c5-9d2d-4701-84be-abb18ea885e3", + "id": "87e8212f-4354-483c-9515-23347dc24ac7", "name": "Not Found", "originalRequest": { "url": { @@ -1365,46 +1087,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) Coupon grouping key, which is the prefix for the coupon batch's generated codes.", - "type": "text/plain" - }, - "type": "any", - "value": "promo", - "key": "groupingKey" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -1426,6 +1111,14 @@ { "key": "Accept", "value": "text/plain" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "PUT", @@ -1447,7 +1140,7 @@ { "listen": "test", "script": { - "id": "54f766d7-92be-40b8-a0f4-de8ad2e9ab80", + "id": "50374f4c-b564-47ef-82d3-28648e5bb92e", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/api/rnb/v2/pvt/coupon/group/:groupingKey/archive - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1463,7 +1156,7 @@ } }, { - "id": "15a13bca-1ef7-4551-973c-2372d882ddbd", + "id": "dc66ce3c-4f91-4def-bdaa-687f4d77726d", "name": "Create coupon batches", "request": { "name": "Create coupon batches", @@ -1484,26 +1177,7 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ { @@ -1523,6 +1197,14 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], "method": "POST", @@ -1531,6 +1213,7 @@ "raw": "[\n {\n \"couponConfiguration\": {\n \"utmSource\": \"fb\",\n \"utmCampaign\": \"blackfriday\",\n \"couponCode\": \"bf22\",\n \"expirationIntervalPerUse\": \"00:00:00\",\n \"maxItemsPerClient\": 5,\n \"maxUsage\": 5\n },\n \"quantity\": \"5\"\n }\n]", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -1541,7 +1224,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "141540b1-d55b-449d-b26e-f37967555a79", + "id": "db81ffa2-f4dd-4723-89be-3d818faa865f", "name": "OK", "originalRequest": { "url": { @@ -1557,36 +1240,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -1605,9 +1261,21 @@ "key": "Accept", "value": "application/json" }, + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "POST", @@ -1616,6 +1284,7 @@ "raw": "[\n {\n \"couponConfiguration\": {\n \"utmSource\": \"fb\",\n \"utmCampaign\": \"blackfriday\",\n \"couponCode\": \"bf22\",\n \"expirationIntervalPerUse\": \"00:00:00\",\n \"maxItemsPerClient\": 5,\n \"maxUsage\": 5\n },\n \"quantity\": \"5\"\n }\n]", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -1636,7 +1305,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "825fe95b-e361-4903-99e2-5d47175a0dea", + "id": "1b73ce13-319f-43d1-923c-9e329e8f952b", "name": "Bad Request", "originalRequest": { "url": { @@ -1652,36 +1321,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -1700,9 +1342,21 @@ "key": "Accept", "value": "application/json" }, + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "text/plain" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "POST", @@ -1711,6 +1365,7 @@ "raw": "[\n {\n \"couponConfiguration\": {\n \"utmSource\": \"fb\",\n \"utmCampaign\": \"blackfriday\",\n \"couponCode\": \"bf22\",\n \"expirationIntervalPerUse\": \"00:00:00\",\n \"maxItemsPerClient\": 5,\n \"maxUsage\": 5\n },\n \"quantity\": \"5\"\n }\n]", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -1732,7 +1387,7 @@ { "listen": "test", "script": { - "id": "1b253497-966c-4e8a-8176-c994d8b32d33", + "id": "7a223055-531e-44c7-87ac-254aef915249", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/rnb/v2/pvt/coupon/group - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1748,7 +1403,7 @@ } }, { - "id": "f957365c-1085-408f-98ef-1680226d2697", + "id": "88c5ce0b-fe86-45a8-b204-86f185f7d630", "name": "Unarchive a coupon batch", "request": { "name": "Unarchive a coupon batch", @@ -1781,24 +1436,6 @@ "type": "any", "value": "promo", "key": "groupingKey" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" } ] }, @@ -1820,16 +1457,21 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "PUT" + "method": "PUT", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, - "id": "f7405aef-c7cb-4382-9262-448654a1bef1", + "id": "e50ea5b3-b73b-40cf-be4f-ad5e68af43b9", "name": "OK", "originalRequest": { "url": { @@ -1847,46 +1489,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) Coupon grouping key, which is the prefix for the coupon batch's generated codes.", - "type": "text/plain" - }, - "type": "any", - "value": "promo", - "key": "groupingKey" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -1908,6 +1513,14 @@ { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "PUT", @@ -1929,7 +1542,7 @@ { "listen": "test", "script": { - "id": "30b5c4f4-41c2-448a-b1e1-cda97180a4c9", + "id": "7a239f2b-6305-41d9-960e-3467ae29d226", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/api/rnb/v2/pvt/coupon/group/:groupingKey/unarchive - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1945,7 +1558,7 @@ } }, { - "id": "21cf7303-5b51-48fa-820c-573aaa5521ef", + "id": "e34b9300-b308-4d72-abac-94e0f933c160", "name": "Get usage count for a single coupon", "request": { "name": "Get usage count for a single coupon", @@ -1977,24 +1590,6 @@ "type": "any", "value": "blackfriday10", "key": "couponCode" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" } ] }, @@ -2016,16 +1611,21 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "GET" + "method": "GET", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, - "id": "5a411edd-c557-43ac-beef-e45bb935cfaf", + "id": "f3340b4a-1f43-40fe-a01e-473aa8491c83", "name": "OK", "originalRequest": { "url": { @@ -2042,46 +1642,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) Single coupon code.", - "type": "text/plain" - }, - "type": "any", - "value": "blackfriday10", - "key": "couponCode" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -2103,6 +1666,14 @@ { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "GET", @@ -2124,7 +1695,7 @@ { "listen": "test", "script": { - "id": "ae1d5a2c-a394-4d73-be5d-2403cd9a1ca1", + "id": "786d258d-9e42-4f17-80e5-510e5239879c", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/rnb/v2/pvt/coupon/usage-count/:couponCode - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2140,7 +1711,7 @@ } }, { - "id": "6f206ad8-4c5c-43d8-b073-cc39d6196ebf", + "id": "48d4661b-3dbd-4bdd-8c08-478db842c2e2", "name": "Get usage count for a coupon batch", "request": { "name": "Get usage count for a coupon batch", @@ -2173,24 +1744,6 @@ "type": "any", "value": "rewardsprogram", "key": "groupingKey" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" } ] }, @@ -2212,16 +1765,21 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "GET" + "method": "GET", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, - "id": "e5ee3d5c-567b-4e83-90f3-8405565fcdcc", + "id": "93fb13cd-abbf-4458-b70f-f6713c2c89bb", "name": "OK", "originalRequest": { "url": { @@ -2239,46 +1797,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) Coupon grouping key, which is the prefix for the coupon batch's generated codes.", - "type": "text/plain" - }, - "type": "any", - "value": "rewardsprogram", - "key": "groupingKey" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -2300,6 +1821,14 @@ { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "GET", @@ -2321,7 +1850,7 @@ { "listen": "test", "script": { - "id": "21905538-0d64-4e6f-a165-c6000830a467", + "id": "15a2741d-aaa1-4efe-86d9-97218ea2869f", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/rnb/v2/pvt/coupon/usage-count/group/:groupingKey - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2363,35 +1892,27 @@ "event": [], "variable": [ { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, "type": "any", "value": "apiexamples", "key": "accountName" }, { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, "type": "any", "value": "vtexcommercestable", "key": "environment" }, { - "type": "string", + "type": "any", "value": "https://{{accountName}}.{{environment}}.com.br", "key": "baseUrl" } ], "info": { - "_postman_id": "4f5f3e57-a5e6-4af0-9042-642e539d37de", + "_postman_id": "5c9a1a02-6c7a-417f-921d-524d23d73994", "name": "Promotions & Taxes API v2", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { - "content": "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 coupons from your VTEX store.\r\n\r\n ## Index\r\n\r\n ### Coupons \r\n- `GET` [Get coupons](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api-v2#get-/api/rnb/v2/pvt/coupon)\r\n- `GET` [Get archived coupons](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api-v2#get-/api/rnb/v2/pvt/coupon/group/archived)\r\n- `GET` [Get coupon batch information](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api-v2#get-/api/rnb/v2/pvt/coupon/group/-groupingKey-)\r\n- `PUT` [Edit coupon batch configuration](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api-v2#put-/api/rnb/v2/pvt/coupon/group/-groupingKey-)\r\n- `GET` [Get coupon batch codes](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api-v2#get-/api/rnb/v2/pvt/coupon/group/-groupingKey-/codes)\r\n- `PUT` [Archive a coupon batch](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api-v2#put-/api/rnb/v2/pvt/coupon/group/-groupingKey-/archive)\r\n- `POST` [Create coupon batches](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api-v2#post-/api/rnb/v2/pvt/coupon/group)\r\n- `PUT` [Unarchive a coupon batch](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api-v2#put-/api/rnb/v2/pvt/coupon/group/-groupingKey-/unarchive)\r\n- `GET` [Get usage count for a single coupon](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api-v2#get-/api/rnb/v2/pvt/coupon/usage-count/-couponCode-)\r\n- `GET` [Get usage count for a coupon batch](https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api-v2#get-/api/rnb/v2/pvt/coupon/usage-count/group/-groupingKey-)\r\n\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", + "content": "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 coupons from your VTEX store.\n\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" } }