From 26f1e2c001ed744686a3f6f02715301fec013a3d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Isabella=20Veloso=20S=C3=A1?= Date: Wed, 2 Oct 2024 13:02:14 -0300 Subject: [PATCH 1/3] Update VTEX - Subscriptions API v3.json --- VTEX - Subscriptions API v3.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/VTEX - Subscriptions API v3.json b/VTEX - Subscriptions API v3.json index 1b59e21aa..302412836 100644 --- a/VTEX - Subscriptions API v3.json +++ b/VTEX - Subscriptions API v3.json @@ -1,7 +1,7 @@ { "openapi": "3.0.0", "info": { - "title": "Subscriptions API (v3)", + "title": "Subscriptions API (v3) MAKE IT WORK", "description": "[Subscriptions](https://help.vtex.com/en/tutorial/how-subscriptions-work--frequentlyAskedQuestions_4453) is the VTEX solution for customers to make recurrent purchases at your store on a regular schedule. When customers subscribe, they define what products they want to acquire regularly and at what frequency they want these automatic orders to be created. For more information, see [Subscriptions onboarding guide](https://developers.vtex.com/docs/guides/subscriptions).\r\n\r\n## Index\r\n\r\n### Cycles\r\n\r\n- `GET` [Get cycle details](https:\/\/developers.vtex.com\/docs\/api-reference\/subscriptions-api-v3#get-\/api\/rns\/pub\/cycles\/-cycleId-)\r\n- `GET` [List cycles](https:\/\/developers.vtex.com\/docs\/api-reference\/subscriptions-api-v3#get-\/api\/rns\/pub\/cycles)\r\n- `POST` [Retry cycle](https:\/\/developers.vtex.com\/docs\/api-reference\/subscriptions-api-v3#post-\/api\/rns\/pub\/cycles\/-cycleId-\/retry)\r\n\r\n### Plans\r\n\r\n- `GET` [List plans](https:\/\/developers.vtex.com\/docs\/api-reference\/subscriptions-api-v3#get-\/api\/rns\/pvt\/plans)\r\n- `GET` [Get plan details](https:\/\/developers.vtex.com\/docs\/api-reference\/subscriptions-api-v3#get-\/api\/rns\/pvt\/plans\/-id-)\r\n\r\n### Reports\r\n\r\n- `GET` [List report templates](https:\/\/developers.vtex.com\/docs\/api-reference\/subscriptions-api-v3#get-\/api\/rns\/pvt\/reports)\r\n- `GET` [Get report document details](https:\/\/developers.vtex.com\/docs\/api-reference\/subscriptions-api-v3#get-\/api\/rns\/pvt\/reports\/-reportName-\/documents\/-documentId-)\r\n- `POST` [Generate report](https:\/\/developers.vtex.com\/docs\/api-reference\/subscriptions-api-v3#post-\/api\/rns\/pvt\/reports\/-reportName-\/documents)\r\n\r\n### Subscriptions\r\n\r\n- `GET` [Get subscription details by ID](https:\/\/developers.vtex.com\/docs\/api-reference\/subscriptions-api-v3#get-\/api\/rns\/pub\/subscriptions\/-id-)\r\n- `PATCH` [Update subscription by ID](https:\/\/developers.vtex.com\/docs\/api-reference\/subscriptions-api-v3#patch-\/api\/rns\/pub\/subscriptions\/-id-)\r\n- `GET` [List subscriptions](https:\/\/developers.vtex.com\/docs\/api-reference\/subscriptions-api-v3#get-\/api\/rns\/pub\/subscriptions)\r\n- `POST` [Create subscription](https:\/\/developers.vtex.com\/docs\/api-reference\/subscriptions-api-v3#post-\/api\/rns\/pub\/subscriptions)\r\n- `DELETE` [Remove item from subscription](https:\/\/developers.vtex.com\/docs\/api-reference\/subscriptions-api-v3#delete-\/api\/rns\/pub\/subscriptions\/-id-\/items\/-itemId-)\r\n- `PATCH` [Edit item on subscription](https:\/\/developers.vtex.com\/docs\/api-reference\/subscriptions-api-v3#patch-\/api\/rns\/pub\/subscriptions\/-id-\/items\/-itemId-)\r\n- `POST` [Add item to subscription](https:\/\/developers.vtex.com\/docs\/api-reference\/subscriptions-api-v3#post-\/api\/rns\/pub\/subscriptions\/-id-\/items)\r\n- `POST` [Calculate the current prices for a subscription](https:\/\/developers.vtex.com\/docs\/api-reference\/subscriptions-api-v3#post-\/api\/rns\/pub\/subscriptions\/-id-\/simulate)\r\n- `POST` [Calculate the current prices for the provided subscription template](https:\/\/developers.vtex.com\/docs\/api-reference\/subscriptions-api-v3#post-\/api\/rns\/pub\/subscriptions\/simulate)\r\n- `GET` [Get conversation messages](https:\/\/developers.vtex.com\/docs\/api-reference\/subscriptions-api-v3#get-\/api\/rns\/pub\/subscriptions\/-subscriptionId-\/conversation-message)\r\n\r\n### Settings\r\n\r\n- `GET` [Get subscription settings](https:\/\/developers.vtex.com\/docs\/api-reference\/subscriptions-api-v3#get-\/api\/rns\/settings)\r\n- `POST` [Edit subscriptions settings](https:\/\/developers.vtex.com\/docs\/api-reference\/subscriptions-api-v3#post-\/api\/rns\/settings) \r\n\r\n## Common parameters\r\n\r\n| **Parameter name** | **Description** | **Type** |\r\n| :---: | :--- | :--- |\r\n| `{{accountName}}` | Name of the VTEX account. Used as part of the URL. | Server variable. |\r\n| `{{environment}}` | Environment to use. Used as part of the URL. The default value is `vtexcommercestable`. | Server variable. |\r\n| `X-VTEX-API-AppKey` | Unique identifier of the [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys). | Authentication header. Must be used together with `X-VTEX-API-AppToken`. Not necessary when using `VtexIdclientAutCookie`. |\r\n| `X-VTEX-API-AppToken` | Secret token of the [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys). | Authentication header. Must be used together with X-VTEX-API-AppKey. Not necessary when using `VtexIdclientAutCookie`. |\r\n| `VtexIdclientAutCookie` | [User token](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens), valid for 24 hours. | Authentication header. Not necessary when using `X-VTEX-API-AppKey` and `X-VTEX-API-AppToken`. |", "contact": {}, "version": "1.0" From 31f47ea99eb77c8fc6711d6b4c9471767e79290e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Isabella=20Veloso=20S=C3=A1?= Date: Wed, 2 Oct 2024 13:03:38 -0300 Subject: [PATCH 2/3] Update VTEX - Orders API PII version.json --- VTEX - Orders API PII version.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/VTEX - Orders API PII version.json b/VTEX - Orders API PII version.json index d4ff1357a..8a0514694 100644 --- a/VTEX - Orders API PII version.json +++ b/VTEX - Orders API PII version.json @@ -1,7 +1,7 @@ { "openapi": "3.0.0", "info": { - "title": "Orders API - PII data architecture", + "title": "Orders API - PII data architecture MAKE IT WORK 2", "description": "VTEX stores using the [PII data architecture](https://developers.vtex.com/docs/guides/pii-data-architecture-specifications) from [Data Protection Plus](https://developers.vtex.com/docs/guides/data-protection-plus) must use this adapted version of the Orders API. Learn more about the modified behavior at [Changes in VTEX features behavior to handle PII data](https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data).\r\n\r\n>⚠️ The **Orders API - PII data architecture** is only compatible with stores using the PII data architecture from [Data Protection Plus](https://developers.vtex.com/docs/guides/data-protection-plus), which is in closed beta phase, only available in selected regions.\r\n>\r\n> This feature is part of [VTEX Shield](https://help.vtex.com/en/tutorial/vtex-shield--2CVk6H9eY2CBtHjtDI7BFh). If you are already a VTEX customer and want to adopt VTEX Shield for your business, please contact [Commercial Support](https://help.vtex.com/en/tracks/support-at-vtex--4AXsGdGHqExp9ZkiNq9eMy/3KQWGgkPOwbFTPfBxL7YwZ). Additional fees may apply. If you are not yet a customer but are interested in this solution, please complete our [contact form](https://vtex.com/us-en/contact/).\r\n\r\n## Index\r\n\r\n### Orders\r\n\r\n- `GET` [Get order](https://developers.vtex.com/docs/api-reference/orders-api-pii-version#get-/api/orders/pvt/document/-orderId-)\r\n- `POST` [List orders](https://developers.vtex.com/docs/api-reference/orders-api-pii-version#post-/api/orders/extendsearch/orders)\r\n- `POST` [Start handling order](https://developers.vtex.com/docs/api-reference/orders-api-pii-version#post-/api/orders/pvt/document/-orderId-/actions/start-handling)\r\n- `POST` [Cancel order](https://developers.vtex.com/docs/api-reference/orders-api-pii-version#post-/api/orders/pvt/document/-orderId-/cancel)\r\n\r\n### Invoice\r\n\r\n- `POST` [Order invoice notification](https://developers.vtex.com/docs/api-reference/orders-api-pii-version#post-/api/orders/pvt/document/-orderId-/invoices)\r\n\r\n### Payment\r\n\r\n- `POST` [Send payment notification](https://developers.vtex.com/docs/api-reference/orders-api-pii-version#post-/api/orders/pvt/document/-orderId-/payment/-paymentId-/notify-payment)", "contact": {}, "version": "1.0" From b41aa84df9623bc091ecbb3afd9068552d5572c7 Mon Sep 17 00:00:00 2001 From: Isabella-Veloso <> Date: Wed, 2 Oct 2024 16:03:45 +0000 Subject: [PATCH 3/3] Update generated files by portman --- .../VTEX - Subscriptions API v3.json | 166 +++++++++--------- 1 file changed, 83 insertions(+), 83 deletions(-) diff --git a/PostmanCollections/VTEX - Subscriptions API v3.json b/PostmanCollections/VTEX - Subscriptions API v3.json index 9c95f5424..8113f3214 100644 --- a/PostmanCollections/VTEX - Subscriptions API v3.json +++ b/PostmanCollections/VTEX - Subscriptions API v3.json @@ -1,10 +1,10 @@ { "_": { - "postman_id": "dd433e63-2708-4e4a-bf39-7e4403d5b125" + "postman_id": "7758011a-a6d2-47e3-8609-f3b8be2c84f9" }, "item": [ { - "id": "618f46d6-9c00-4efd-a1d4-e34b84f4a529", + "id": "0df4b408-5b3d-49ec-87f7-983eeb652f0f", "name": "Cycles", "description": { "content": "", @@ -12,7 +12,7 @@ }, "item": [ { - "id": "0c9a831a-1894-4b82-a91a-607a1c6d0e07", + "id": "0afe3b2d-a4cd-4f95-bf00-17d2092dd88c", "name": "Get cycle details", "request": { "name": "Get cycle details", @@ -77,7 +77,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "eb4323ef-14c1-4a9f-9f10-16c496920801", + "id": "2d63a442-bfff-45ee-a9aa-3b1c5e87a138", "name": "OK", "originalRequest": { "url": { @@ -145,7 +145,7 @@ { "listen": "test", "script": { - "id": "eddb5772-e44f-4cea-ba60-a212d18520c6", + "id": "d26f95aa-75c8-4d09-8a9d-cce0200de32a", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/rns/pub/cycles/:cycleId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -161,7 +161,7 @@ } }, { - "id": "32bcdb35-fbe3-489c-9565-b8ce95e9dd92", + "id": "40e6faa7-f0c7-42fb-b47b-d548e53edc99", "name": "List cycles", "request": { "name": "List cycles", @@ -187,7 +187,7 @@ "type": "text/plain" }, "key": "beginDate", - "value": "anim commodo" + "value": "dolor sit ad Duis" }, { "disabled": true, @@ -196,7 +196,7 @@ "type": "text/plain" }, "key": "endDate", - "value": "anim commodo" + "value": "dolor sit ad Duis" }, { "disabled": true, @@ -205,7 +205,7 @@ "type": "text/plain" }, "key": "subscriptionId", - "value": "anim commodo" + "value": "dolor sit ad Duis" }, { "disabled": true, @@ -214,7 +214,7 @@ "type": "text/plain" }, "key": "customerEmail", - "value": "anim commodo" + "value": "dolor sit ad Duis" }, { "disabled": true, @@ -223,7 +223,7 @@ "type": "text/plain" }, "key": "status", - "value": "anim commodo" + "value": "dolor sit ad Duis" }, { "disabled": true, @@ -278,7 +278,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "d683626d-ac41-4622-a5c2-a3ba4a10af74", + "id": "f91337cc-8407-4143-b980-fc57eb0fcd42", "name": "OK", "originalRequest": { "url": { @@ -299,7 +299,7 @@ "type": "text/plain" }, "key": "beginDate", - "value": "anim commodo" + "value": "dolor sit ad Duis" }, { "disabled": true, @@ -308,7 +308,7 @@ "type": "text/plain" }, "key": "endDate", - "value": "anim commodo" + "value": "dolor sit ad Duis" }, { "disabled": true, @@ -317,7 +317,7 @@ "type": "text/plain" }, "key": "subscriptionId", - "value": "anim commodo" + "value": "dolor sit ad Duis" }, { "disabled": true, @@ -326,7 +326,7 @@ "type": "text/plain" }, "key": "customerEmail", - "value": "anim commodo" + "value": "dolor sit ad Duis" }, { "disabled": true, @@ -335,7 +335,7 @@ "type": "text/plain" }, "key": "status", - "value": "anim commodo" + "value": "dolor sit ad Duis" }, { "disabled": true, @@ -409,7 +409,7 @@ { "listen": "test", "script": { - "id": "c19e12ab-038d-4e88-9e91-54fd16702d31", + "id": "c590519c-661a-4cb8-9106-8351e92746e7", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/rns/pub/cycles - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -425,7 +425,7 @@ } }, { - "id": "99772ea7-f613-48fc-bacb-f3d0dd14a731", + "id": "6a6c41e5-4458-422b-94df-017149d6bf49", "name": "Retry cycle", "request": { "name": "Retry cycle", @@ -454,7 +454,7 @@ "type": "text/plain" }, "type": "any", - "value": "anim commodo", + "value": "dolor sit ad Duis", "key": "cycleId" } ] @@ -487,7 +487,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "f1303d57-9fe6-48fc-9cb5-af092b6b68ad", + "id": "0bed1f72-6329-4752-a5fe-274f7cf61f28", "name": "OK", "originalRequest": { "url": { @@ -546,7 +546,7 @@ { "listen": "test", "script": { - "id": "05eb967b-9423-4d63-a363-2ec90dbdf8e8", + "id": "8472e642-2008-49c5-a21a-dfa6714d9600", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/rns/pub/cycles/:cycleId/retry - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -562,7 +562,7 @@ "event": [] }, { - "id": "b53e3707-bdf1-42fc-aa9f-c91e490f427e", + "id": "bff63eb4-f841-4a1e-9c28-c7ad5f3a3853", "name": "Plans", "description": { "content": "", @@ -570,7 +570,7 @@ }, "item": [ { - "id": "e3bf8331-e232-4cc7-a57a-c79f9dfab85c", + "id": "2656b51b-779e-4902-b523-940e94da807a", "name": "List plans", "request": { "name": "List plans", @@ -596,7 +596,7 @@ "type": "text/plain" }, "key": "periodicity", - "value": "anim commodo" + "value": "dolor sit ad Duis" }, { "disabled": true, @@ -605,7 +605,7 @@ "type": "text/plain" }, "key": "interval", - "value": "anim commodo" + "value": "dolor sit ad Duis" }, { "disabled": true, @@ -660,7 +660,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "ef117756-2b65-4268-bc0b-71862f48b3be", + "id": "e9e13aa1-a162-4864-8a81-ce24f077c18d", "name": "OK", "originalRequest": { "url": { @@ -681,7 +681,7 @@ "type": "text/plain" }, "key": "periodicity", - "value": "anim commodo" + "value": "dolor sit ad Duis" }, { "disabled": true, @@ -690,7 +690,7 @@ "type": "text/plain" }, "key": "interval", - "value": "anim commodo" + "value": "dolor sit ad Duis" }, { "disabled": true, @@ -764,7 +764,7 @@ { "listen": "test", "script": { - "id": "b0c5e1a7-0d0a-4f29-8c55-31813a32af9e", + "id": "3e1e6777-396c-47ed-87ef-3d2a7ee72292", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/rns/pvt/plans - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -780,7 +780,7 @@ } }, { - "id": "ab8dd6ae-fa87-49b2-bf8a-7afd43e60063", + "id": "bad1cbc8-5f96-4891-aeaf-3665cb6df445", "name": "Get plan details", "request": { "name": "Get plan details", @@ -845,7 +845,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "f15a62f2-3092-40a9-8470-cd9af622f531", + "id": "0c37c977-1916-4dcf-b9b5-7cf50773d169", "name": "OK", "originalRequest": { "url": { @@ -913,7 +913,7 @@ { "listen": "test", "script": { - "id": "98f6de2b-f5f8-471e-a155-3708c700df63", + "id": "c240e0b2-d57b-4605-99bd-a2b1af956ce2", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/rns/pvt/plans/:id - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -932,7 +932,7 @@ "event": [] }, { - "id": "aa1cd92a-f0a3-4293-be48-3a04227f8c20", + "id": "ad0ad16d-7b30-4d40-8ad5-3b33b54f46fe", "name": "Reports", "description": { "content": "", @@ -940,7 +940,7 @@ }, "item": [ { - "id": "2a3e3cd0-bad9-4c61-bc4f-dfbeb8a6c7d4", + "id": "ebe5fafb-fe10-453b-a3a8-3c64780e6e68", "name": "List report templates", "request": { "name": "List report templates", @@ -993,7 +993,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "fef69e8d-90c0-4daa-8159-5cca0f17dd77", + "id": "ccec9d80-479b-49b2-93b0-3aa4fafeabb0", "name": "OK", "originalRequest": { "url": { @@ -1060,7 +1060,7 @@ { "listen": "test", "script": { - "id": "38b54e00-3981-41ff-959e-67987f9739d7", + "id": "288bbe16-2072-47a8-8593-c63d6fc925be", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/rns/pvt/reports - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1076,7 +1076,7 @@ } }, { - "id": "8abde333-84e0-4627-a485-15fc0ea98e58", + "id": "2137aa6b-1776-43d7-b556-145b753a0813", "name": "Get report document details", "request": { "name": "Get report document details", @@ -1153,7 +1153,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "a7d1925c-867f-4f15-92cb-c8445f3ed161", + "id": "733f1e6b-c301-4d78-8dd9-626a8d5005db", "name": "OK", "originalRequest": { "url": { @@ -1223,7 +1223,7 @@ { "listen": "test", "script": { - "id": "1c5cd5c8-c0cf-43c4-b477-0f8cb6d3c691", + "id": "8b6dc2bd-9441-4fb0-a195-07b70c6c7f38", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/rns/pvt/reports/:reportName/documents/:documentId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1239,7 +1239,7 @@ } }, { - "id": "cf63551b-95fc-44bb-b267-424d95feab99", + "id": "955ed155-a6fe-4e87-b481-d35078591e49", "name": "Generate report", "request": { "name": "Generate report", @@ -1342,7 +1342,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "e3f9f9ba-2978-4c46-a1ed-435eb396ce40", + "id": "629d5cc6-1646-4f4f-8118-451a5657342a", "name": "OK", "originalRequest": { "url": { @@ -1448,7 +1448,7 @@ { "listen": "test", "script": { - "id": "649807fc-92ac-4f29-a03c-81ceb7dfe73e", + "id": "15ae35b8-219b-4d19-8ca1-ac7075c2bc11", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/rns/pvt/reports/:reportName/documents - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1467,7 +1467,7 @@ "event": [] }, { - "id": "d3fe8330-a135-4e51-a134-30534da827ea", + "id": "d27c2068-ea18-4f8a-a188-459e4462e17f", "name": "Subscriptions", "description": { "content": "", @@ -1475,7 +1475,7 @@ }, "item": [ { - "id": "16d187e9-e844-4fe7-8b47-ac0faf960bed", + "id": "909ac66a-b0bf-4d5c-92bd-d4f0093692e8", "name": "Get subscription details by ID", "request": { "name": "Get subscription details by ID", @@ -1540,7 +1540,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "54e85cbf-3099-41f7-b3f7-679b6ea939d5", + "id": "d8db080a-fb9e-4fa2-83bc-741d20a0b3bb", "name": "OK", "originalRequest": { "url": { @@ -1608,7 +1608,7 @@ { "listen": "test", "script": { - "id": "5aaa6e0e-b9aa-4675-9bfb-fef9740f11c3", + "id": "8b06340a-35bd-4378-9490-aa4ef7a7fb94", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/rns/pub/subscriptions/:id - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1624,7 +1624,7 @@ } }, { - "id": "fcf5ed0b-3d28-4588-aa83-992fd77019bb", + "id": "2ff80b0d-c634-404e-b3c7-8c0ba6557164", "name": "Update subscription by ID", "request": { "name": "Update subscription by ID", @@ -1702,7 +1702,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "71632db9-f04a-4502-9f08-6e557bdc8623", + "id": "b112a81e-e7d8-47a5-b52e-ade2b4ba32db", "name": "OK", "originalRequest": { "url": { @@ -1783,7 +1783,7 @@ { "listen": "test", "script": { - "id": "320ccc8a-fb2e-4349-b45e-0f3d112c1cd5", + "id": "9280f97f-c258-4804-9ae8-fefeb5663dc2", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PATCH]::/api/rns/pub/subscriptions/:id - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1799,7 +1799,7 @@ } }, { - "id": "e8ef5668-a88b-436e-9c1a-5070e3224ca7", + "id": "2f29151c-c525-4d5c-ba6f-740f5b098cdc", "name": "List subscriptions", "request": { "name": "List subscriptions", @@ -1934,7 +1934,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "6b4f83da-3ae4-4309-b439-1404077ce7b6", + "id": "71f9ec30-a8e4-43a1-81b8-909f8bffa7da", "name": "OK", "originalRequest": { "url": { @@ -2083,7 +2083,7 @@ { "listen": "test", "script": { - "id": "476b502e-4ad8-4b05-b944-1b49d9ad6b73", + "id": "e76af4a2-7c14-4421-96c4-cd1bd3cc2238", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/rns/pub/subscriptions - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2099,7 +2099,7 @@ } }, { - "id": "e25e035c-6c11-4c40-8e49-09626019f437", + "id": "f296dbcd-391d-4959-9560-7aa756720060", "name": "Create subscription", "request": { "name": "Create subscription", @@ -2165,7 +2165,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "1efd83cc-f254-4521-b460-48ff064ff334", + "id": "1d9f06b1-6182-4857-be07-c5fc8427c24b", "name": "Created", "originalRequest": { "url": { @@ -2245,7 +2245,7 @@ { "listen": "test", "script": { - "id": "30417a05-d23a-4d93-a2ae-2e2449289777", + "id": "ff7848f3-fe95-4fec-b586-4c77f6b557a1", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/rns/pub/subscriptions - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2261,7 +2261,7 @@ } }, { - "id": "5af97bbf-dc6d-4e8e-aa19-e4c8e5486e3a", + "id": "9c1d4272-9911-4bd8-a521-3a3ff27aa648", "name": "Remove item from subscription", "request": { "name": "Remove item from subscription", @@ -2334,7 +2334,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "2b5c0ba8-0bfd-4a9e-bcb9-ac43574b1af5", + "id": "4f844735-bcf1-423c-933b-da75f0ea5814", "name": "No Content", "originalRequest": { "url": { @@ -2394,7 +2394,7 @@ { "listen": "test", "script": { - "id": "7709c1f8-07e6-47f6-9a25-2e7beec2584f", + "id": "1da3cdd6-b182-4d37-a56d-7168e7327bfe", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[DELETE]::/api/rns/pub/subscriptions/:id/items/:itemId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2408,7 +2408,7 @@ } }, { - "id": "603c9a76-ec25-4a19-ac45-c3b45a533599", + "id": "cae93b61-53bd-47be-a3e5-42e4b31fc369", "name": "Edit item from subscription", "request": { "name": "Edit item from subscription", @@ -2498,7 +2498,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "10989851-b35b-465d-a186-1102c68628ae", + "id": "8aa5cace-bfb4-45f1-88e3-48419d4acb4d", "name": "OK", "originalRequest": { "url": { @@ -2581,7 +2581,7 @@ { "listen": "test", "script": { - "id": "eb75082d-2c32-49d7-994f-d35cc13acb51", + "id": "207b85dd-5616-4c0f-8713-946063d3f396", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PATCH]::/api/rns/pub/subscriptions/:id/items/:itemId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2597,7 +2597,7 @@ } }, { - "id": "53d11a63-1474-483e-9f8f-a59fdfeb3b98", + "id": "bdbfe28a-20c2-4c79-9505-b0c725cbb4f5", "name": "Add item to subscription", "request": { "name": "Add item to subscription", @@ -2676,7 +2676,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "3f6cbffd-89c8-4df1-8641-f6c3facf2e1b", + "id": "c6f91b8c-71e1-47bc-ba21-2475c13162cb", "name": "OK", "originalRequest": { "url": { @@ -2758,7 +2758,7 @@ { "listen": "test", "script": { - "id": "f3f38fa1-3d8a-47b4-9883-26a7e994b45f", + "id": "d4a0c3b5-5fd3-4422-a3a6-eb0b95bc9ba0", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/rns/pub/subscriptions/:id/items - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2774,7 +2774,7 @@ } }, { - "id": "4162e7d6-f759-43d2-8d67-35b8d18557d5", + "id": "cfbc125c-e0bb-42da-8920-17dbba2b0c1d", "name": "Calculate the current prices for a subscription", "request": { "name": "Calculate the current prices for a subscription", @@ -2840,7 +2840,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "00dbae49-e93d-4ff3-8d8a-5bb565229057", + "id": "d901701f-6984-49a3-8217-31765da4a45d", "name": "OK", "originalRequest": { "url": { @@ -2909,7 +2909,7 @@ { "listen": "test", "script": { - "id": "72fcb2ae-2e3c-4c83-9c97-9f7b73acdcee", + "id": "a8ee6a8c-8dc4-4ea5-8208-b5c4aeca4aac", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/rns/pub/subscriptions/:id/simulate - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2925,7 +2925,7 @@ } }, { - "id": "2ebabd93-9c05-4895-9b84-99291496efb8", + "id": "54e94abf-d4d2-4ccc-92d5-8adbe7b8a22e", "name": "Calculate the current prices for the provided subscription template", "request": { "name": "Calculate the current prices for the provided subscription template", @@ -2992,7 +2992,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "b5b37add-9b6f-4c21-b13e-3b00b34d48bf", + "id": "53bf5857-fc7a-44e9-a373-5f8cf7ba061b", "name": "OK", "originalRequest": { "url": { @@ -3073,7 +3073,7 @@ { "listen": "test", "script": { - "id": "0cc3b368-8871-495e-8238-6b37b5951215", + "id": "60b97616-68de-4fd2-bc08-547848046e33", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/rns/pub/subscriptions/simulate - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -3089,7 +3089,7 @@ } }, { - "id": "79494190-2bd1-47df-8256-80e8bde2ce28", + "id": "46539f24-5108-4d63-8b69-563fa0ce4d75", "name": "Get conversation messages", "request": { "name": "Get conversation messages", @@ -3155,7 +3155,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "01e9142c-711c-4c56-9250-3fb12716c99e", + "id": "67467222-cab9-4b92-b592-8b2be0428037", "name": "OK", "originalRequest": { "url": { @@ -3224,7 +3224,7 @@ { "listen": "test", "script": { - "id": "07dd059f-8880-4c4f-a1a4-4017bd36ac2c", + "id": "58dc22d8-a91c-49d1-adbc-728b24c100ae", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/rns/pub/subscriptions/:subscriptionId/conversation-message - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -3243,7 +3243,7 @@ "event": [] }, { - "id": "e774e4dc-f012-4642-b939-1e850ab98d8a", + "id": "a9e4a8d2-75e2-4013-a753-bf800b3c54f7", "name": "Settings", "description": { "content": "", @@ -3251,7 +3251,7 @@ }, "item": [ { - "id": "4c281483-ff38-4406-ba22-e68c413a710b", + "id": "60628e5c-f52c-4d10-af67-a1429a83a74d", "name": "Get subscriptions settings", "request": { "name": "Get subscriptions settings", @@ -3303,7 +3303,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "6ace617b-1980-469c-8772-aab3dd451e7c", + "id": "fc3f6a9c-4001-46d2-8cc7-7b92dd2d9d2d", "name": "OK", "originalRequest": { "url": { @@ -3369,7 +3369,7 @@ { "listen": "test", "script": { - "id": "5f55cd2c-4ad7-43a2-b825-c62d4d3f7df9", + "id": "24a66566-05bf-4319-b5f6-858778259be4", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/rns/settings - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -3385,7 +3385,7 @@ } }, { - "id": "61f7e0cc-e466-4186-b6e5-0b581554d1eb", + "id": "dafa448f-e678-4855-9ae8-79ef3595720a", "name": "Edit subscriptions settings", "request": { "name": "Edit subscriptions settings", @@ -3450,7 +3450,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "8ce9eed4-7b3a-440a-a042-726a234695c3", + "id": "ef700a6c-4cf8-46c8-acd2-e939a5cd563c", "name": "OK", "originalRequest": { "url": { @@ -3529,7 +3529,7 @@ { "listen": "test", "script": { - "id": "ef3c8524-eaae-4d8c-b7c0-d0df9ba57461", + "id": "b4dac23c-cc04-4934-9ac2-1e3ea6ba71e5", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/rns/settings - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -3587,8 +3587,8 @@ } ], "info": { - "_postman_id": "dd433e63-2708-4e4a-bf39-7e4403d5b125", - "name": "Subscriptions API (v3)", + "_postman_id": "7758011a-a6d2-47e3-8609-f3b8be2c84f9", + "name": "Subscriptions API (v3) MAKE IT WORK", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "[Subscriptions](https://help.vtex.com/en/tutorial/how-subscriptions-work--frequentlyAskedQuestions_4453) is the VTEX solution for customers to make recurrent purchases at your store on a regular schedule. When customers subscribe, they define what products they want to acquire regularly and at what frequency they want these automatic orders to be created. For more information, see [Subscriptions onboarding guide](https://developers.vtex.com/docs/guides/subscriptions).\r\n\r\n## Index\r\n\r\n### Cycles\r\n\r\n- `GET` [Get cycle details](https://developers.vtex.com/docs/api-reference/subscriptions-api-v3#get-/api/rns/pub/cycles/-cycleId-)\r\n- `GET` [List cycles](https://developers.vtex.com/docs/api-reference/subscriptions-api-v3#get-/api/rns/pub/cycles)\r\n- `POST` [Retry cycle](https://developers.vtex.com/docs/api-reference/subscriptions-api-v3#post-/api/rns/pub/cycles/-cycleId-/retry)\r\n\r\n### Plans\r\n\r\n- `GET` [List plans](https://developers.vtex.com/docs/api-reference/subscriptions-api-v3#get-/api/rns/pvt/plans)\r\n- `GET` [Get plan details](https://developers.vtex.com/docs/api-reference/subscriptions-api-v3#get-/api/rns/pvt/plans/-id-)\r\n\r\n### Reports\r\n\r\n- `GET` [List report templates](https://developers.vtex.com/docs/api-reference/subscriptions-api-v3#get-/api/rns/pvt/reports)\r\n- `GET` [Get report document details](https://developers.vtex.com/docs/api-reference/subscriptions-api-v3#get-/api/rns/pvt/reports/-reportName-/documents/-documentId-)\r\n- `POST` [Generate report](https://developers.vtex.com/docs/api-reference/subscriptions-api-v3#post-/api/rns/pvt/reports/-reportName-/documents)\r\n\r\n### Subscriptions\r\n\r\n- `GET` [Get subscription details by ID](https://developers.vtex.com/docs/api-reference/subscriptions-api-v3#get-/api/rns/pub/subscriptions/-id-)\r\n- `PATCH` [Update subscription by ID](https://developers.vtex.com/docs/api-reference/subscriptions-api-v3#patch-/api/rns/pub/subscriptions/-id-)\r\n- `GET` [List subscriptions](https://developers.vtex.com/docs/api-reference/subscriptions-api-v3#get-/api/rns/pub/subscriptions)\r\n- `POST` [Create subscription](https://developers.vtex.com/docs/api-reference/subscriptions-api-v3#post-/api/rns/pub/subscriptions)\r\n- `DELETE` [Remove item from subscription](https://developers.vtex.com/docs/api-reference/subscriptions-api-v3#delete-/api/rns/pub/subscriptions/-id-/items/-itemId-)\r\n- `PATCH` [Edit item on subscription](https://developers.vtex.com/docs/api-reference/subscriptions-api-v3#patch-/api/rns/pub/subscriptions/-id-/items/-itemId-)\r\n- `POST` [Add item to subscription](https://developers.vtex.com/docs/api-reference/subscriptions-api-v3#post-/api/rns/pub/subscriptions/-id-/items)\r\n- `POST` [Calculate the current prices for a subscription](https://developers.vtex.com/docs/api-reference/subscriptions-api-v3#post-/api/rns/pub/subscriptions/-id-/simulate)\r\n- `POST` [Calculate the current prices for the provided subscription template](https://developers.vtex.com/docs/api-reference/subscriptions-api-v3#post-/api/rns/pub/subscriptions/simulate)\r\n- `GET` [Get conversation messages](https://developers.vtex.com/docs/api-reference/subscriptions-api-v3#get-/api/rns/pub/subscriptions/-subscriptionId-/conversation-message)\r\n\r\n### Settings\r\n\r\n- `GET` [Get subscription settings](https://developers.vtex.com/docs/api-reference/subscriptions-api-v3#get-/api/rns/settings)\r\n- `POST` [Edit subscriptions settings](https://developers.vtex.com/docs/api-reference/subscriptions-api-v3#post-/api/rns/settings) \r\n\r\n## Common parameters\r\n\r\n| **Parameter name** | **Description** | **Type** |\r\n| :---: | :--- | :--- |\r\n| `{{accountName}}` | Name of the VTEX account. Used as part of the URL. | Server variable. |\r\n| `{{environment}}` | Environment to use. Used as part of the URL. The default value is `vtexcommercestable`. | Server variable. |\r\n| `X-VTEX-API-AppKey` | Unique identifier of the [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys). | Authentication header. Must be used together with `X-VTEX-API-AppToken`. Not necessary when using `VtexIdclientAutCookie`. |\r\n| `X-VTEX-API-AppToken` | Secret token of the [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys). | Authentication header. Must be used together with X-VTEX-API-AppKey. Not necessary when using `VtexIdclientAutCookie`. |\r\n| `VtexIdclientAutCookie` | [User token](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens), valid for 24 hours. | Authentication header. Not necessary when using `X-VTEX-API-AppKey` and `X-VTEX-API-AppToken`. |",