diff --git a/PostmanCollections/VTEX - GiftCard Hub API.json b/PostmanCollections/VTEX - GiftCard Hub API.json index fe81ad21a..5bb83a70e 100644 --- a/PostmanCollections/VTEX - GiftCard Hub API.json +++ b/PostmanCollections/VTEX - GiftCard Hub API.json @@ -1,10 +1,10 @@ { "_": { - "postman_id": "aadf69b5-1e08-47f3-8c60-bed58978c3b4" + "postman_id": "10dd5d03-5ad0-4ad1-968f-b08fca84ed2f" }, "item": [ { - "id": "d79e8161-ef78-4125-ac7e-8cf2c28742b2", + "id": "95880d19-d4d3-4613-9b92-33cbb3cade41", "name": "Provider", "description": { "content": "", @@ -12,7 +12,7 @@ }, "item": [ { - "id": "f6148fe0-e0fe-4406-b340-d8f0b476ebc7", + "id": "1f1718bb-b510-46bd-8800-a16454be8ef4", "name": "List all gift card providers", "request": { "name": "List all gift card providers", @@ -29,26 +29,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": [ { @@ -77,16 +58,21 @@ }, "key": "REST-Range", "value": "resources=0-49" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "GET" + "method": "GET", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, - "id": "a9344d89-3e5b-4575-8527-4217a1cdde0d", + "id": "a46e3521-ac67-4924-8e06-b58ff9337328", "name": "OK", "originalRequest": { "url": { @@ -98,36 +84,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": { @@ -158,6 +117,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", @@ -179,7 +146,7 @@ { "listen": "test", "script": { - "id": "a75a9f89-3980-424f-a2cd-5d413d6d8060", + "id": "30decb19-3e3c-47ac-abdb-e0c8e1b7e92d", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/giftcardproviders - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -195,7 +162,7 @@ } }, { - "id": "1d1f0fbd-b2b8-4e98-820e-0c894878ecb0", + "id": "714acbc8-6e71-4684-ba24-362822fa28b6", "name": "Get a gift card provider by ID", "request": { "name": "Get a gift card provider by ID", @@ -223,24 +190,6 @@ "type": "any", "value": "GiftCardExample", "key": "giftCardProviderId" - }, - { - "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" } ] }, @@ -262,16 +211,21 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "GET" + "method": "GET", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, - "id": "d9c4bed1-9f2c-4fb9-bcd8-32e682191770", + "id": "b47f5d62-1700-4e16-a663-4ff4c610513d", "name": "OK", "originalRequest": { "url": { @@ -284,46 +238,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) Gift card provider identification.", - "type": "text/plain" - }, - "type": "any", - "value": "GiftCardExample", - "key": "giftCardProviderId" - }, - { - "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": { @@ -345,6 +262,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", @@ -365,7 +290,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "a52c97af-d18e-4187-922a-164f49e11e78", + "id": "6c64d764-3d99-4b2b-ab84-8bcfa4d0f183", "name": "Object reference not set to an instance of an object (The gift card provider described does not exist).", "originalRequest": { "url": { @@ -378,46 +303,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) Gift card provider identification.", - "type": "text/plain" - }, - "type": "any", - "value": "GiftCardExample", - "key": "giftCardProviderId" - }, - { - "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": { @@ -435,6 +323,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", @@ -442,13 +338,7 @@ }, "status": "Internal Server Error", "code": 500, - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "body": "", + "header": [], "cookie": [] } ], @@ -456,7 +346,7 @@ { "listen": "test", "script": { - "id": "85171686-69cc-42cc-b168-dd465a3e1289", + "id": "3e397674-2184-4a6d-8bf7-02ed596290ef", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/giftcardproviders/:giftCardProviderId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -472,12 +362,12 @@ } }, { - "id": "ef56b539-726d-47ec-9df8-26b148ba4eda", + "id": "99cf22f2-82e5-4754-988c-92ea15d8e628", "name": "Create or update a gift card provider by ID", "request": { "name": "Create or update a gift card provider by ID", "description": { - "content": "Create or update a gift card provider from a store.\r\n\r\n> ⚠️ The `appkey` and `apptoken` fields are not mandatory for the native VTEX gift card, only for external gift card providers.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/authentication-overview#application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| GiftCard | GiftCard | **Edit Gift Card providers** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", + "content": "Create or update a gift card provider from a store.\r\n\r\n> ⚠️ The `appkey` and `apptoken` fields are not mandatory for the native VTEX gift card, only for [external gift card providers](https://developers.vtex.com/updates/release-notes/2024-05-27-changes-in-authentication-requirements-for-external-gift-card-providers).\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/authentication-overview#application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| GiftCard | GiftCard | **Edit Gift Card providers** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "type": "text/plain" }, "url": { @@ -500,24 +390,6 @@ "type": "any", "value": "customProvider", "key": "giftCardProviderId" - }, - { - "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" } ] }, @@ -539,6 +411,14 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/vnd.vtex.giftcardproviders.v1+json" + }, + { + "key": "Accept", + "value": "application/json" } ], "method": "PUT", @@ -547,6 +427,7 @@ "raw": "{\n \"serviceUrl\": \"https://api.vtex.com.br/example\",\n \"oauthProvider\": \"vtex\",\n \"preAuthEnabled\": true,\n \"cancelEnabled\": true,\n \"appKey\": \"key\",\n \"appToken\": \"token\",\n \"id\": \"customProvider\"\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -557,7 +438,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "c2e54276-bd43-4b5e-bb1a-1f4b0fe8a695", + "id": "c99d725b-0197-46c0-8e4d-1ca3f3f835d0", "name": "OK", "originalRequest": { "url": { @@ -570,46 +451,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) Gift card provider identification.", - "type": "text/plain" - }, - "type": "any", - "value": "customProvider", - "key": "giftCardProviderId" - }, - { - "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": { @@ -628,9 +472,21 @@ "key": "Accept", "value": "application/json" }, + { + "key": "Content-Type", + "value": "application/vnd.vtex.giftcardproviders.v1+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", @@ -639,6 +495,7 @@ "raw": "{\n \"serviceUrl\": \"https://api.vtex.com.br/example\",\n \"oauthProvider\": \"vtex\",\n \"preAuthEnabled\": true,\n \"cancelEnabled\": true,\n \"appKey\": \"key\",\n \"appToken\": \"token\",\n \"id\": \"customProvider\"\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -660,7 +517,7 @@ { "listen": "test", "script": { - "id": "1f918a34-09d4-4916-b552-98a2dd7d8dbf", + "id": "2384a3be-9de3-4770-9a37-83d4e3143c57", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/api/giftcardproviders/:giftCardProviderId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -676,7 +533,7 @@ } }, { - "id": "1eca6046-6640-45c6-8caf-1ae52db7f49a", + "id": "18a2884b-562d-4722-bde4-605a6be57e29", "name": "Delete a gift card provider by ID", "request": { "name": "Delete a gift card provider by ID", @@ -704,24 +561,6 @@ "type": "any", "value": "GiftCardExample", "key": "giftCardProviderId" - }, - { - "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" } ] }, @@ -745,14 +584,15 @@ "value": "application/json" } ], - "method": "DELETE" + "method": "DELETE", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "text" }, - "id": "db941794-f372-461c-8cbe-b423c599f82d", + "id": "a482a54a-77d8-4c3e-9186-3ec6e21259cc", "name": "OK. This endpoint does not return any data in the response body.", "originalRequest": { "url": { @@ -765,46 +605,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) Gift card provider identification.", - "type": "text/plain" - }, - "type": "any", - "value": "GiftCardExample", - "key": "giftCardProviderId" - }, - { - "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": { @@ -822,6 +625,14 @@ }, "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "DELETE", @@ -829,20 +640,14 @@ }, "status": "OK", "code": 200, - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "body": "", + "header": [], "cookie": [] }, { "_": { "postman_previewlanguage": "text" }, - "id": "12336e3e-008c-4c80-9a15-48fcdae83c7d", + "id": "954185d0-78d1-4e60-ba62-e444fea84aba", "name": "Not Found", "originalRequest": { "url": { @@ -855,46 +660,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) Gift card provider identification.", - "type": "text/plain" - }, - "type": "any", - "value": "GiftCardExample", - "key": "giftCardProviderId" - }, - { - "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": { @@ -912,6 +680,14 @@ }, "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "DELETE", @@ -919,13 +695,7 @@ }, "status": "Not Found", "code": 404, - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "body": "", + "header": [], "cookie": [] } ], @@ -933,7 +703,7 @@ { "listen": "test", "script": { - "id": "8c752a1a-90c7-4159-9816-d891ac7a5451", + "id": "2bba365d-21bf-45fb-b4a5-2fd21b238dc1", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[DELETE]::/api/giftcardproviders/:giftCardProviderId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -949,7 +719,7 @@ "event": [] }, { - "id": "77272a2d-919e-4169-8d24-a19d99473055", + "id": "874bac74-17ae-47b9-916a-15e6a8004b34", "name": "Transaction", "description": { "content": "", @@ -957,7 +727,7 @@ }, "item": [ { - "id": "86559a78-ea5b-48c5-99a1-27e8842255b7", + "id": "37190845-529e-4dd3-aeff-e7a9b8559cac", "name": "Create a gift card at a gift card provider", "request": { "name": "Create a gift card at a gift card provider", @@ -986,24 +756,6 @@ "type": "any", "value": "GiftCardExample", "key": "giftCardProviderId" - }, - { - "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" } ] }, @@ -1025,6 +777,14 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/vnd.vtex.giftcardproviders.v1+json" + }, + { + "key": "Accept", + "value": "application/json" } ], "method": "POST", @@ -1033,6 +793,7 @@ "raw": "{\n \"relationName\": \"loyalty-program\",\n \"emissionDate\": \"2020-09-01T13:15:30Z\",\n \"expiringDate\": \"2020-09-10T13:15:30Z\",\n \"caption\": \"Loyalty Program\",\n \"restrictedToOwner\": false,\n \"multipleRedemptions\": false,\n \"multipleCredits\": false,\n \"profileId\": \"92de2449-0e02-4ca9-a4aa-a09cc9d8f7ff\",\n \"currencyCode\": \"USD\"\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -1043,7 +804,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "551fc933-19e1-4983-b3d9-2f057a6441d1", + "id": "5208a3bc-197c-4d6e-9b13-2b47fc10c621", "name": "OK", "originalRequest": { "url": { @@ -1057,46 +818,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) Gift card provider identification.", - "type": "text/plain" - }, - "type": "any", - "value": "GiftCardExample", - "key": "giftCardProviderId" - }, - { - "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": { @@ -1115,9 +839,21 @@ "key": "Accept", "value": "application/json" }, + { + "key": "Content-Type", + "value": "application/vnd.vtex.giftcardproviders.v1+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", @@ -1126,6 +862,7 @@ "raw": "{\n \"relationName\": \"loyalty-program\",\n \"emissionDate\": \"2020-09-01T13:15:30Z\",\n \"expiringDate\": \"2020-09-10T13:15:30Z\",\n \"caption\": \"Loyalty Program\",\n \"restrictedToOwner\": false,\n \"multipleRedemptions\": false,\n \"multipleCredits\": false,\n \"profileId\": \"92de2449-0e02-4ca9-a4aa-a09cc9d8f7ff\",\n \"currencyCode\": \"USD\"\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -1147,13 +884,13 @@ { "listen": "test", "script": { - "id": "58ed3aaf-ae9a-4f27-afa3-e85e2746019b", + "id": "9cd68818-c933-478d-b9b8-5ff30ecbf0ef", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/giftcardproviders/:giftCardProviderId/giftcards - 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/giftcardproviders/:giftCardProviderId/giftcards - 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/giftcardproviders/:giftCardProviderId/giftcards - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Gift card identification.\"},\"emissionDate\":{\"type\":\"string\",\"description\":\"Gift card emission date.\"},\"expiringDate\":{\"type\":\"string\",\"description\":\"Gift card expiration date.\"},\"caption\":{\"type\":\"string\",\"description\":\"Field to be filled in if a loyalty program must be created for the gift card.\"},\"provider\":{\"type\":\"string\",\"description\":\"Provider name.\"},\"discount\":{\"type\":\"boolean\",\"description\":\"Deprecated field.\",\"deprecated\":true},\"currencyCode\":{\"type\":\"string\",\"description\":\"Currency code in ISO 4217.\"},\"transaction\":{\"type\":\"object\",\"description\":\"Transaction information.\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"Gift card resource URL. The number described in the URL refers to the gift card identification.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[POST]::/api/giftcardproviders/:giftCardProviderId/giftcards - 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\":{\"id\":{\"type\":\"string\",\"description\":\"Gift card identification.\"},\"emissionDate\":{\"type\":\"string\",\"description\":\"Gift card emission date.\"},\"expiringDate\":{\"type\":\"string\",\"description\":\"Gift card expiration date.\"},\"caption\":{\"type\":\"string\",\"description\":\"Field to be filled in if a loyalty program must be created for the gift card.\"},\"provider\":{\"type\":\"string\",\"description\":\"Provider name.\"},\"discount\":{\"type\":\"boolean\",\"description\":\"Deprecated field.\"},\"currencyCode\":{\"type\":\"string\",\"description\":\"Currency code in ISO 4217.\"},\"transaction\":{\"type\":\"object\",\"description\":\"Transaction information.\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"Gift card resource URL. The number described in the URL refers to the gift card identification.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[POST]::/api/giftcardproviders/:giftCardProviderId/giftcards - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -1163,7 +900,7 @@ } }, { - "id": "9eedbb2e-0f8b-4883-9a7e-02a26c9ef871", + "id": "61856b01-da3f-4109-9a94-43357b143acf", "name": "Get a gift card from a gift card provider", "request": { "name": "Get a gift card from a gift card provider", @@ -1193,24 +930,6 @@ "type": "any", "value": "GiftCardExample", "key": "giftCardProviderId" - }, - { - "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" } ] }, @@ -1241,6 +960,14 @@ }, "key": "REST-Range", "value": "resources=0-49" + }, + { + "key": "Content-Type", + "value": "application/vnd.vtex.giftcardproviders.v1+json" + }, + { + "key": "Accept", + "value": "application/json" } ], "method": "POST", @@ -1249,6 +976,7 @@ "raw": "{\n \"client\": {\n \"id\": \"3b1abc17-988e-4a14-8b7f-31fc6a5b955c\",\n \"email\": \"email@domain.com\",\n \"document\": \"42151783120\"\n },\n \"cart\": {\n \"grandTotal\": 0,\n \"relationName\": \"loyalty-program\",\n \"redemptionCode\": \"***********ASDQ\",\n \"discounts\": 20,\n \"shipping\": 2,\n \"taxes\": 0,\n \"items\": [\n {\n \"productId\": \"2000000\",\n \"id\": \"2000002\",\n \"refId\": \"MEV41\",\n \"name\": \"Shoes\",\n \"price\": 200,\n \"quantity\": 1\n },\n {\n \"productId\": \"2000000\",\n \"id\": \"2000002\",\n \"refId\": \"MEV41\",\n \"name\": \"Shoes\",\n \"price\": 200,\n \"quantity\": 1\n }\n ],\n \"itemsTotal\": 200\n }\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -1259,7 +987,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "6c3c7c2a-3d14-4571-9cee-c0d8554721e3", + "id": "933e0ad7-07e0-4062-b36b-aedf62f3f100", "name": "OK", "originalRequest": { "url": { @@ -1274,46 +1002,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) Gift card provider identification.", - "type": "text/plain" - }, - "type": "any", - "value": "GiftCardExample", - "key": "giftCardProviderId" - }, - { - "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": { @@ -1341,9 +1032,21 @@ "key": "REST-Range", "value": "resources=0-49" }, + { + "key": "Content-Type", + "value": "application/vnd.vtex.giftcardproviders.v1+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", @@ -1352,6 +1055,7 @@ "raw": "{\n \"client\": {\n \"id\": \"3b1abc17-988e-4a14-8b7f-31fc6a5b955c\",\n \"email\": \"email@domain.com\",\n \"document\": \"42151783120\"\n },\n \"cart\": {\n \"grandTotal\": 0,\n \"relationName\": \"loyalty-program\",\n \"redemptionCode\": \"***********ASDQ\",\n \"discounts\": 20,\n \"shipping\": 2,\n \"taxes\": 0,\n \"items\": [\n {\n \"productId\": \"2000000\",\n \"id\": \"2000002\",\n \"refId\": \"MEV41\",\n \"name\": \"Shoes\",\n \"price\": 200,\n \"quantity\": 1\n },\n {\n \"productId\": \"2000000\",\n \"id\": \"2000002\",\n \"refId\": \"MEV41\",\n \"name\": \"Shoes\",\n \"price\": 200,\n \"quantity\": 1\n }\n ],\n \"itemsTotal\": 200\n }\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -1373,7 +1077,7 @@ { "listen": "test", "script": { - "id": "ae2b7654-134e-48a4-8151-0efdd7bae92f", + "id": "f42805f1-125d-44f8-bf37-7dddd3ff43ec", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/giftcardproviders/:giftCardProviderId/giftcards/_search - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1389,7 +1093,7 @@ } }, { - "id": "7258c77a-efcf-403d-b6b7-0e9a6da923db", + "id": "c16514f2-cf74-4c9e-a53c-8df7e01ae61f", "name": "Get a gift card from a gift card provider by ID", "request": { "name": "Get a gift card from a gift card provider by ID", @@ -1429,24 +1133,6 @@ "type": "any", "value": "5", "key": "giftCardId" - }, - { - "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" } ] }, @@ -1468,16 +1154,21 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "GET" + "method": "GET", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, - "id": "9de689c8-36b5-417d-888e-06ddbc7506ba", + "id": "60dc42be-e3a8-4911-b199-b9fecb783e41", "name": "OK", "originalRequest": { "url": { @@ -1492,56 +1183,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) Gift card provider identification.", - "type": "text/plain" - }, - "type": "any", - "value": "GiftCardExample", - "key": "giftCardProviderId" - }, - { - "disabled": false, - "description": { - "content": "(Required) Gift card identification.", - "type": "text/plain" - }, - "type": "any", - "value": "5", - "key": "giftCardId" - }, - { - "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": { @@ -1563,6 +1207,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", @@ -1584,13 +1236,13 @@ { "listen": "test", "script": { - "id": "cf597c18-cdba-42f5-b738-561c8210f04e", + "id": "ac193664-4268-4c05-b2cb-c2ac0309ff26", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/giftcardproviders/:giftCardProviderId/giftcards/:giftCardId - 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/giftcardproviders/:giftCardProviderId/giftcards/:giftCardId - 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/giftcardproviders/:giftCardProviderId/giftcards/:giftCardId - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Gift card identification.\"},\"redemptionToken\":{\"type\":\"string\",\"description\":\"Gift card redemption token.\"},\"redemptionCode\":{\"type\":\"string\",\"description\":\"Gift card identification code used at checkout. Minimum of 6 characters.\"},\"balance\":{\"type\":\"number\",\"description\":\"Gift card current balance. For newly created gift cards, the balance will be 0.0.\"},\"emissionDate\":{\"type\":\"string\",\"description\":\"Gift card emission date.\"},\"expiringDate\":{\"type\":\"string\",\"description\":\"Gift card expiration date.\"},\"currencyCode\":{\"type\":\"string\",\"description\":\"Currency code in ISO 4217.\"},\"discount\":{\"type\":\"boolean\",\"description\":\"Deprecated field.\",\"deprecated\":true},\"transactions\":{\"type\":\"object\",\"description\":\"Transactions information.\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"This is one of the fields inside the `_self`. It is exactly the route that identifies this provider on the Hub's API, but it is not the same thing as the `serviceURL`.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/giftcardproviders/:giftCardProviderId/giftcards/:giftCardId - 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\":{\"id\":{\"type\":\"string\",\"description\":\"Gift card identification.\"},\"redemptionToken\":{\"type\":\"string\",\"description\":\"Gift card redemption token.\"},\"redemptionCode\":{\"type\":\"string\",\"description\":\"Gift card identification code used at checkout. Minimum of 6 characters.\"},\"balance\":{\"type\":\"number\",\"description\":\"Gift card current balance. For newly created gift cards, the balance will be 0.0.\"},\"emissionDate\":{\"type\":\"string\",\"description\":\"Gift card emission date.\"},\"expiringDate\":{\"type\":\"string\",\"description\":\"Gift card expiration date.\"},\"currencyCode\":{\"type\":\"string\",\"description\":\"Currency code in ISO 4217.\"},\"discount\":{\"type\":\"boolean\",\"description\":\"Deprecated field.\"},\"transactions\":{\"type\":\"object\",\"description\":\"Transactions information.\",\"properties\":{\"href\":{\"type\":\"string\",\"description\":\"This is one of the fields inside the `_self`. It is exactly the route that identifies this provider on the Hub's API, but it is not the same thing as the `serviceURL`.\"}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/api/giftcardproviders/:giftCardProviderId/giftcards/:giftCardId - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -1600,7 +1252,7 @@ } }, { - "id": "3468d7f2-2d5e-4616-bfa7-8b8e7109e778", + "id": "5459acdb-8758-4dfc-8fe0-959968167358", "name": "List all gift card transactions", "request": { "name": "List all gift card transactions", @@ -1641,24 +1293,6 @@ "type": "any", "value": "7d1dfc17-989e-4t21-8b7f-5103c6a5b925c_70", "key": "giftCardId" - }, - { - "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" } ] }, @@ -1680,16 +1314,21 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "GET" + "method": "GET", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, - "id": "39eaca62-8e0b-4050-8816-a5c57cc74a8f", + "id": "a5df3379-0b93-44da-b56e-6ad9eb60713c", "name": "OK", "originalRequest": { "url": { @@ -1705,56 +1344,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) Gift card provider identification.", - "type": "text/plain" - }, - "type": "any", - "value": "GiftCardExample", - "key": "giftCardProviderId" - }, - { - "disabled": false, - "description": { - "content": "(Required) Gift card identification.", - "type": "text/plain" - }, - "type": "any", - "value": "7d1dfc17-989e-4t21-8b7f-5103c6a5b925c_70", - "key": "giftCardId" - }, - { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, - "type": "any", - "value": "{{accountName}}", - "key": "accountName" - }, - { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, - "type": "any", - "value": "{{environment}}", - "key": "environment" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -1776,6 +1368,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", @@ -1797,7 +1397,7 @@ { "listen": "test", "script": { - "id": "473ea84c-7012-4753-9e99-f4a771ee3d4b", + "id": "3e344fd4-0720-418a-9138-9780f8172f54", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/giftcardproviders/:giftCardProviderId/giftcards/:giftCardId/transactions - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1813,7 +1413,7 @@ } }, { - "id": "de490f37-bc54-4b93-9ded-9b68318fb39c", + "id": "4b66adc0-8047-42a5-91e3-a85343e791b9", "name": "Create a gift card transaction", "request": { "name": "Create a gift card transaction", @@ -1854,24 +1454,6 @@ "type": "any", "value": "6", "key": "giftCardId" - }, - { - "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" } ] }, @@ -1893,6 +1475,14 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/vnd.vtex.giftcardproviders.v1+json" + }, + { + "key": "Accept", + "value": "application/json" } ], "method": "POST", @@ -1901,6 +1491,7 @@ "raw": "{\n \"operation\": \"Debit\",\n \"value\": 3,\n \"description\": \"GiftCardHub\",\n \"redemptionToken\": \"b2dac6f2-f365-48cd-82a9-0b376a55557a\",\n \"redemptionCode\": \"***********ASDQ\",\n \"requestId\": \"B56CBE231DEE4E1A859183C1030CE926\",\n \"orderInfo\": {\n \"orderId\": \"v5006128str\",\n \"sequence\": 5006128,\n \"cart\": {\n \"items\": [\n {\n \"id\": \"2001023\",\n \"productId\": \"2000492\",\n \"refId\": \"35994\",\n \"name\": \"Vaporizador Des. ColC4nia Branco\",\n \"value\": 14.99,\n \"price\": 14.99,\n \"quantity\": 1,\n \"shippingDiscount\": 0,\n \"discount\": -7.5,\n \"priceTags\": {\n \"name\": \"discount@price-discount_store_183#4911bf6f-22a2-4af1-a365-cce895c3df2c\",\n \"value\": 0\n }\n },\n {\n \"id\": \"2001023\",\n \"productId\": \"2000492\",\n \"refId\": \"35994\",\n \"name\": \"Vaporizador Des. ColC4nia Branco\",\n \"value\": 14.99,\n \"price\": 14.99,\n \"quantity\": 1,\n \"shippingDiscount\": 0,\n \"discount\": -7.5,\n \"priceTags\": {\n \"name\": \"discount@price-discount_store_183#4911bf6f-22a2-4af1-a365-cce895c3df2c\",\n \"value\": 0\n }\n }\n ],\n \"grandTotal\": 0,\n \"discounts\": -7.5,\n \"shipping\": 7.27,\n \"taxes\": 0,\n \"itemsTotal\": 14.99\n },\n \"clientProfile\": {\n \"email\": \"michael.scott96@mail.com\",\n \"firstName\": \"Michael\",\n \"lastName\": \"Scott\",\n \"document\": \"02906792063\",\n \"phone\": \"+551111111111\",\n \"birthDate\": \"0001-01-01T00:00:00\",\n \"isCorporate\": false\n },\n \"shipping\": {\n \"receiverName\": \"Michael Scott\",\n \"postalCode\": \"22250040\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BRA\",\n \"street\": \"Praia de Botafogo\",\n \"number\": \"111\",\n \"neighborhood\": \"Botafogo\",\n \"complement\": \"House\",\n \"reference\": \"Subway\"\n }\n }\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -1911,7 +1502,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "4252a500-a879-491d-9ff3-c78b85aa9a34", + "id": "436eccd0-ba6e-4571-9dcf-dc0c6c303471", "name": "OK", "originalRequest": { "url": { @@ -1927,56 +1518,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) Gift card provider identification.", - "type": "text/plain" - }, - "type": "any", - "value": "GiftCardExample", - "key": "giftCardProviderId" - }, - { - "disabled": false, - "description": { - "content": "(Required) Gift card identification.", - "type": "text/plain" - }, - "type": "any", - "value": "6", - "key": "giftCardId" - }, - { - "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" - } - ] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, + "variable": [] + }, + "header": [ { "disabled": false, "description": { @@ -1995,9 +1539,21 @@ "key": "Accept", "value": "application/json" }, + { + "key": "Content-Type", + "value": "application/vnd.vtex.giftcardproviders.v1+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", @@ -2006,6 +1562,7 @@ "raw": "{\n \"operation\": \"Debit\",\n \"value\": 3,\n \"description\": \"GiftCardHub\",\n \"redemptionToken\": \"b2dac6f2-f365-48cd-82a9-0b376a55557a\",\n \"redemptionCode\": \"***********ASDQ\",\n \"requestId\": \"B56CBE231DEE4E1A859183C1030CE926\",\n \"orderInfo\": {\n \"orderId\": \"v5006128str\",\n \"sequence\": 5006128,\n \"cart\": {\n \"items\": [\n {\n \"id\": \"2001023\",\n \"productId\": \"2000492\",\n \"refId\": \"35994\",\n \"name\": \"Vaporizador Des. ColC4nia Branco\",\n \"value\": 14.99,\n \"price\": 14.99,\n \"quantity\": 1,\n \"shippingDiscount\": 0,\n \"discount\": -7.5,\n \"priceTags\": {\n \"name\": \"discount@price-discount_store_183#4911bf6f-22a2-4af1-a365-cce895c3df2c\",\n \"value\": 0\n }\n },\n {\n \"id\": \"2001023\",\n \"productId\": \"2000492\",\n \"refId\": \"35994\",\n \"name\": \"Vaporizador Des. ColC4nia Branco\",\n \"value\": 14.99,\n \"price\": 14.99,\n \"quantity\": 1,\n \"shippingDiscount\": 0,\n \"discount\": -7.5,\n \"priceTags\": {\n \"name\": \"discount@price-discount_store_183#4911bf6f-22a2-4af1-a365-cce895c3df2c\",\n \"value\": 0\n }\n }\n ],\n \"grandTotal\": 0,\n \"discounts\": -7.5,\n \"shipping\": 7.27,\n \"taxes\": 0,\n \"itemsTotal\": 14.99\n },\n \"clientProfile\": {\n \"email\": \"michael.scott96@mail.com\",\n \"firstName\": \"Michael\",\n \"lastName\": \"Scott\",\n \"document\": \"02906792063\",\n \"phone\": \"+551111111111\",\n \"birthDate\": \"0001-01-01T00:00:00\",\n \"isCorporate\": false\n },\n \"shipping\": {\n \"receiverName\": \"Michael Scott\",\n \"postalCode\": \"22250040\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BRA\",\n \"street\": \"Praia de Botafogo\",\n \"number\": \"111\",\n \"neighborhood\": \"Botafogo\",\n \"complement\": \"House\",\n \"reference\": \"Subway\"\n }\n }\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -2027,7 +1584,7 @@ { "listen": "test", "script": { - "id": "56534b3b-fba0-48c9-8c6d-321a1f35bf31", + "id": "6ce3dcd2-6a72-4718-a29c-3d0c60193362", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/giftcardproviders/:giftCardProviderId/giftcards/:giftCardId/transactions - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2043,7 +1600,7 @@ } }, { - "id": "8a1e733b-ecc2-47c2-9239-13f9c3915e2a", + "id": "d1c1ab06-22ba-47f0-bd85-ca4801e3dd89", "name": "Get a gift card transaction by ID", "request": { "name": "Get a gift card transaction by ID", @@ -2095,24 +1652,6 @@ "type": "any", "value": "jac68316306453f4b8tr3fdb892dfba1", "key": "transactionId" - }, - { - "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" } ] }, @@ -2134,16 +1673,21 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "GET" + "method": "GET", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, - "id": "801e0f70-0978-46c5-a9c2-47d5c490fee4", + "id": "2f06f877-9aec-4cc6-be49-4c24db9f0f7e", "name": "OK", "originalRequest": { "url": { @@ -2160,66 +1704,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) Gift card provider identification.", - "type": "text/plain" - }, - "type": "any", - "value": "GiftCardExample", - "key": "giftCardProviderId" - }, - { - "disabled": false, - "description": { - "content": "(Required) Gift card identification.", - "type": "text/plain" - }, - "type": "any", - "value": "7d1dfc17-989e-4t21-8b7f-5103c6a5b925c_70", - "key": "giftCardId" - }, - { - "disabled": false, - "description": { - "content": "(Required) Transaction identification.", - "type": "text/plain" - }, - "type": "any", - "value": "jac68316306453f4b8tr3fdb892dfba1", - "key": "transactionId" - }, - { - "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": { @@ -2241,6 +1728,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", @@ -2262,7 +1757,7 @@ { "listen": "test", "script": { - "id": "7e5eb126-f2ea-44b5-ac02-787d0da93cdd", + "id": "22b9db82-e3e3-4f87-bbbe-cbf2cce619b3", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/giftcardproviders/:giftCardProviderId/giftcards/:giftCardId/transactions/:transactionId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2278,7 +1773,7 @@ } }, { - "id": "2408af6c-a4c4-4ce3-a9ba-84b11c2248b3", + "id": "2fd58d63-4c88-4c05-805f-dadf1c65bee6", "name": "Get a gift card transaction authorization", "request": { "name": "Get a gift card transaction authorization", @@ -2331,24 +1826,6 @@ "type": "any", "value": "jac68316306453f4b8tr3fdb892dfba1", "key": "tId" - }, - { - "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" } ] }, @@ -2370,16 +1847,21 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "GET" + "method": "GET", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, - "id": "397d4c4a-ddd5-4736-967b-469961c74f74", + "id": "5522ab23-45cc-447a-a1e5-321bb2fa733c", "name": "OK", "originalRequest": { "url": { @@ -2397,66 +1879,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) Gift card provider identification.", - "type": "text/plain" - }, - "type": "any", - "value": "GiftCardExample", - "key": "giftCardProviderId" - }, - { - "disabled": false, - "description": { - "content": "(Required) Gift card identification.", - "type": "text/plain" - }, - "type": "any", - "value": "7d1dfc17-989e-4t21-8b7f-5103c6a5b925c_70", - "key": "giftCardId" - }, - { - "disabled": false, - "description": { - "content": "(Required) Transaction ID generated by the provider. It is different from the `transactionId` generated by VTEX.", - "type": "text/plain" - }, - "type": "any", - "value": "jac68316306453f4b8tr3fdb892dfba1", - "key": "tId" - }, - { - "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": { @@ -2478,6 +1903,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", @@ -2499,7 +1932,7 @@ { "listen": "test", "script": { - "id": "8ea454ac-1576-498e-9352-5e8a33f7c045", + "id": "474fc26e-bb1e-4a33-a85d-7e3d4e9db057", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/giftcardproviders/:giftCardProviderId/giftcards/:giftCardId/transactions/:tId/authorization - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2515,7 +1948,7 @@ } }, { - "id": "6b46be57-3c65-4f44-89cd-175a2c1173b2", + "id": "b4f0a41d-df65-49cc-a08b-5ec4bee52dff", "name": "List all gift card transactions settlements", "request": { "name": "List all gift card transactions settlements", @@ -2568,24 +2001,6 @@ "type": "any", "value": "jac68316306453f4b8tr3fdb892dfba1", "key": "tId" - }, - { - "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" } ] }, @@ -2607,16 +2022,21 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "GET" + "method": "GET", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, - "id": "dad3f1b8-daa9-4e34-92f1-2dd8af955293", + "id": "0f7f51e9-fb26-41b8-864d-bef2fb28beaf", "name": "OK", "originalRequest": { "url": { @@ -2634,66 +2054,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) Gift card provider identification.", - "type": "text/plain" - }, - "type": "any", - "value": "GiftCardExample", - "key": "giftCardProviderId" - }, - { - "disabled": false, - "description": { - "content": "(Required) Gift card identification.", - "type": "text/plain" - }, - "type": "any", - "value": "7d1dfc17-989e-4t21-8b7f-5103c6a5b925c_70", - "key": "giftCardId" - }, - { - "disabled": false, - "description": { - "content": "(Required) Transaction ID generated by the provider. It is different from the `transactionId` generated by VTEX.", - "type": "text/plain" - }, - "type": "any", - "value": "jac68316306453f4b8tr3fdb892dfba1", - "key": "tId" - }, - { - "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": { @@ -2715,6 +2078,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", @@ -2736,7 +2107,7 @@ { "listen": "test", "script": { - "id": "667fd2d4-67f2-44eb-a043-222200739081", + "id": "687b2502-9e91-4af8-8e71-1c92f60e47b3", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/giftcardproviders/:giftCardProviderId/giftcards/:giftCardId/transactions/:tId/settlements - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2752,7 +2123,7 @@ } }, { - "id": "f891fea2-06a5-4e6c-a3fa-8bf207ae05c6", + "id": "2f23c9df-2c9b-4161-968a-e580b10b7037", "name": "Settle a gift card transaction", "request": { "name": "Settle a gift card transaction", @@ -2805,24 +2176,6 @@ "type": "any", "value": "b47690", "key": "tId" - }, - { - "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" } ] }, @@ -2844,6 +2197,14 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], "method": "POST", @@ -2852,6 +2213,7 @@ "raw": "{\n \"value\": 1.8,\n \"requestId\": \"12093812masoidj120398\"\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -2862,7 +2224,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "66643c24-e928-4ad2-af68-cb738c0942eb", + "id": "826577f1-dfc0-4409-b8f3-8d211464c9e3", "name": "OK", "originalRequest": { "url": { @@ -2880,66 +2242,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) Gift card provider identification.", - "type": "text/plain" - }, - "type": "any", - "value": "GiftCardExample", - "key": "giftCardProviderId" - }, - { - "disabled": false, - "description": { - "content": "(Required) Gift card identification.", - "type": "text/plain" - }, - "type": "any", - "value": "6", - "key": "giftCardId" - }, - { - "disabled": false, - "description": { - "content": "(Required) Transaction ID generated by the provider. It is different from the `transactionId` generated by VTEX.", - "type": "text/plain" - }, - "type": "any", - "value": "b47690", - "key": "tId" - }, - { - "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": { @@ -2958,9 +2263,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", @@ -2969,6 +2286,7 @@ "raw": "{\n \"value\": 1.8,\n \"requestId\": \"12093812masoidj120398\"\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -2990,7 +2308,7 @@ { "listen": "test", "script": { - "id": "28b942df-aa4a-426c-b303-32bb428ee907", + "id": "afbb6148-e320-4c3d-8513-f2860d451280", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/giftcardproviders/:giftCardProviderId/giftcards/:giftCardId/transactions/:tId/settlements - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -3006,7 +2324,7 @@ } }, { - "id": "2bec23a4-e3ca-41bb-a727-4c09d378a10e", + "id": "c4cfdb7d-92c4-4fe1-a840-4f3e71674974", "name": "List all gift card transactions cancellations", "request": { "name": "List all gift card transactions cancellations", @@ -3059,24 +2377,6 @@ "type": "any", "value": "jac68316306453f4b8tr3fdb892dfba1", "key": "tId" - }, - { - "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" } ] }, @@ -3098,16 +2398,21 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], - "method": "GET" + "method": "GET", + "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, - "id": "03f6b103-af26-4ebe-8a03-36d1f2f5a311", + "id": "1acda063-c33a-4f91-a2b6-9b8917a5e7bb", "name": "OK", "originalRequest": { "url": { @@ -3125,66 +2430,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) Gift card provider identification.", - "type": "text/plain" - }, - "type": "any", - "value": "GiftCardExample", - "key": "giftCardProviderId" - }, - { - "disabled": false, - "description": { - "content": "(Required) Gift card identification.", - "type": "text/plain" - }, - "type": "any", - "value": "7d1dfc17-989e-4t21-8b7f-5103c6a5b925c_70", - "key": "giftCardId" - }, - { - "disabled": false, - "description": { - "content": "(Required) Transaction ID generated by the provider. It is different from the `transactionId` generated by VTEX.", - "type": "text/plain" - }, - "type": "any", - "value": "jac68316306453f4b8tr3fdb892dfba1", - "key": "tId" - }, - { - "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": { @@ -3206,6 +2454,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", @@ -3227,7 +2483,7 @@ { "listen": "test", "script": { - "id": "50654f1d-e783-43fb-abbd-60fe966a171f", + "id": "6d84494b-2bf1-4244-9932-05b76869a386", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/giftcardproviders/:giftCardProviderId/giftcards/:giftCardId/transactions/:tId/cancellations - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -3243,7 +2499,7 @@ } }, { - "id": "955a211b-5abc-456a-b60c-95e9e9ea3812", + "id": "f043b71c-69ad-41ef-89b4-69300d93c46a", "name": "Cancel a gift card transaction", "request": { "name": "Cancel a gift card transaction", @@ -3296,24 +2552,6 @@ "type": "any", "value": "b47690", "key": "tId" - }, - { - "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" } ] }, @@ -3335,6 +2573,14 @@ }, "key": "Accept", "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/vnd.vtex.giftcardproviders.v1+json" + }, + { + "key": "Accept", + "value": "application/json" } ], "method": "POST", @@ -3343,6 +2589,7 @@ "raw": "{\n \"value\": 4.1,\n \"requestId\": \"12093812masoidj120398\"\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -3353,7 +2600,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "01092ec4-8555-40d9-b374-e81742c7e474", + "id": "ffbabb4d-98ad-481a-9974-4212cee3e936", "name": "OK", "originalRequest": { "url": { @@ -3371,66 +2618,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) Gift card provider identification.", - "type": "text/plain" - }, - "type": "any", - "value": "GiftCardExample", - "key": "giftCardProviderId" - }, - { - "disabled": false, - "description": { - "content": "(Required) Gift card identification.", - "type": "text/plain" - }, - "type": "any", - "value": "6", - "key": "giftCardId" - }, - { - "disabled": false, - "description": { - "content": "(Required) Transaction ID generated by the provider. It is different from the `transactionId` generated by VTEX.", - "type": "text/plain" - }, - "type": "any", - "value": "b47690", - "key": "tId" - }, - { - "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": { @@ -3449,9 +2639,21 @@ "key": "Accept", "value": "application/json" }, + { + "key": "Content-Type", + "value": "application/vnd.vtex.giftcardproviders.v1+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", @@ -3460,6 +2662,7 @@ "raw": "{\n \"value\": 4.1,\n \"requestId\": \"12093812masoidj120398\"\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -3481,7 +2684,7 @@ { "listen": "test", "script": { - "id": "15a29e2c-4a0c-4ae1-b02d-9b6188a07a61", + "id": "1a405e39-5023-4c0a-b831-12428fab6066", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/giftcardproviders/:giftCardProviderId/giftcards/:giftCardId/transactions/:tId/cancellations - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -3523,31 +2726,23 @@ "event": [], "variable": [ { - "description": { - "content": "Name of the VTEX account. Used as part of the URL.", - "type": "text/plain" - }, "type": "any", "value": "apiexamples", "key": "accountName" }, { - "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", - "type": "text/plain" - }, "type": "any", "value": "vtexcommercestable", "key": "environment" }, { - "type": "string", + "type": "any", "value": "https://{{accountName}}.{{environment}}.com.br", "key": "baseUrl" } ], "info": { - "_postman_id": "aadf69b5-1e08-47f3-8c60-bed58978c3b4", + "_postman_id": "10dd5d03-5ad0-4ad1-968f-b08fca84ed2f", "name": "Giftcard Hub API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { diff --git a/VTEX - GiftCard Hub API.json b/VTEX - GiftCard Hub API.json index eb7a0482a..47c5bbf1e 100644 --- a/VTEX - GiftCard Hub API.json +++ b/VTEX - GiftCard Hub API.json @@ -257,7 +257,7 @@ "Provider" ], "summary": "Create or update a gift card provider by ID", - "description": "Create or update a gift card provider from a store.\r\n\r\n> ⚠️ The `appkey` and `apptoken` fields are not mandatory for the native VTEX gift card, only for external gift card providers.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https:\/\/developers.vtex.com\/docs\/guides\/authentication-overview#application-keys) must have at least one of the appropriate [License Manager resources](https:\/\/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| GiftCard | GiftCard | **Edit Gift Card providers** |\r\n\r\nThere are no applicable [predefined roles](https:\/\/help.vtex.com\/en\/tutorial\/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https:\/\/help.vtex.com\/en\/tutorial\/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>\u2757 To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https:\/\/help.vtex.com\/en\/tutorial\/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", + "description": "Create or update a gift card provider from a store.\r\n\r\n> ⚠️ The `X-PROVIDER-API-AppKey` and `X-PROVIDER-API-AppToken` headers are not mandatory for the native VTEX gift card, only for [external gift card providers](https://developers.vtex.com/updates/release-notes/2024-05-27-changes-in-authentication-requirements-for-external-gift-card-providers).\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https:\/\/developers.vtex.com\/docs\/guides\/authentication-overview#application-keys) must have at least one of the appropriate [License Manager resources](https:\/\/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| GiftCard | GiftCard | **Edit Gift Card providers** |\r\n\r\nThere are no applicable [predefined roles](https:\/\/help.vtex.com\/en\/tutorial\/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https:\/\/help.vtex.com\/en\/tutorial\/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>\u2757 To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https:\/\/help.vtex.com\/en\/tutorial\/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "operationId": "Create/UpdateGiftCardProviderbyID", "parameters": [ {