diff --git a/PostmanCollections/VTEX - Pricing Hub.json b/PostmanCollections/VTEX - Pricing Hub.json index 4b5dc459d..15751dd34 100644 --- a/PostmanCollections/VTEX - Pricing Hub.json +++ b/PostmanCollections/VTEX - Pricing Hub.json @@ -1,10 +1,10 @@ { "_": { - "postman_id": "cf465623-4c95-4784-ac0b-2cc2d7108a80" + "postman_id": "c2785efa-9c98-446d-8501-bfc17b2118d5" }, "item": [ { - "id": "b8418096-57ed-4843-b427-4b3e0eb061bd", + "id": "93e3bdd6-1cb0-40e4-a237-c10daf8a10be", "name": "Pricing Hub Prices", "description": { "content": "", @@ -12,7 +12,7 @@ }, "item": [ { - "id": "faac41d1-23a3-4756-b544-fffdf4bb7f71", + "id": "dcf17ef7-f61e-44a6-842a-f1b62bc2fecd", "name": "Retrieve prices", "request": { "name": "Retrieve prices", @@ -40,17 +40,7 @@ "value": "apiexamples" } ], - "variable": [ - { - "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": [ { @@ -70,6 +60,14 @@ }, "key": "Content-Type", "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], "method": "POST", @@ -78,6 +76,7 @@ "raw": "{\n \"items\": [\n {\n \"index\": 0,\n \"skuId\": \"13\",\n \"quantity\": 1,\n \"brandId\": \"2000000\",\n \"sellerId\": \"1\",\n \"priceTableIds\": [],\n \"categoriesIds\": [\n \"1\"\n ]\n }\n ],\n \"UtmSource\": \"facebook\",\n \"UtmMedium\": \"social\",\n \"UtmCampaign\": \"summer\",\n \"UtmInternalCampaign\": \"sale\",\n \"salesChannel\": \"1\",\n \"email\": \"customer@email.com\"\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -88,7 +87,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "baa2097b-07c0-40ea-b1e0-4c8dbe574e18", + "id": "423a2cd1-255d-434c-984d-58ecfacb12d0", "name": "OK", "originalRequest": { "url": { @@ -102,31 +101,18 @@ ], "query": [ { - "key": "an", - "value": "apiexamples" - } - ], - "variable": [ - { + "disabled": false, "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", + "content": "(Required) Name of the VTEX account. Used as part of the URL.", "type": "text/plain" }, - "type": "any", - "value": "{{environment}}", - "key": "environment" + "key": "an", + "value": "apiexamples" } - ] + ], + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -145,9 +131,21 @@ "key": "Content-Type", "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", @@ -156,6 +154,7 @@ "raw": "{\n \"items\": [\n {\n \"index\": 0,\n \"skuId\": \"13\",\n \"quantity\": 1,\n \"brandId\": \"2000000\",\n \"sellerId\": \"1\",\n \"priceTableIds\": [],\n \"categoriesIds\": [\n \"1\"\n ]\n }\n ],\n \"UtmSource\": \"facebook\",\n \"UtmMedium\": \"social\",\n \"UtmCampaign\": \"summer\",\n \"UtmInternalCampaign\": \"sale\",\n \"salesChannel\": \"1\",\n \"email\": \"customer@email.com\"\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -177,7 +176,7 @@ { "listen": "test", "script": { - "id": "bbba0192-3de8-4f61-b947-7560bd28c85b", + "id": "312992e2-0d5b-4602-b03b-9dc7030f5892", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/pricing-hub/prices - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -193,7 +192,7 @@ } }, { - "id": "415e7aaa-86a9-41da-ae78-8d2f4d9352ac", + "id": "bdc092f0-17c2-4dcf-99c7-00178e8377af", "name": "Configure external price source", "request": { "name": "Configure external price source", @@ -222,17 +221,7 @@ "value": "apiexamples" } ], - "variable": [ - { - "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": [ { @@ -252,6 +241,10 @@ }, "key": "Content-Type", "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" } ], "method": "PUT", @@ -260,6 +253,7 @@ "raw": "{\n \"active\": true,\n \"appName\": \"apiexamples_app_name\"\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -270,7 +264,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "acaae19f-ea77-45c7-a1de-a9eebaeb3633", + "id": "6657dc18-c716-48b6-8533-f2236174b15b", "name": "OK", "originalRequest": { "url": { @@ -285,31 +279,18 @@ ], "query": [ { - "key": "an", - "value": "apiexamples" - } - ], - "variable": [ - { + "disabled": true, "description": { - "content": "Environment to use. Used as part of the URL. (This can only be one of vtexcommercestable)", + "content": "Name of the VTEX account.", "type": "text/plain" }, - "type": "any", - "value": "{{environment}}", - "key": "environment" + "key": "an", + "value": "apiexamples" } - ] + ], + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -327,6 +308,18 @@ }, "key": "Content-Type", "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "PUT", @@ -335,6 +328,7 @@ "raw": "{\n \"active\": true,\n \"appName\": \"apiexamples_app_name\"\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -342,13 +336,7 @@ }, "status": "OK", "code": 200, - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "body": "", + "header": [], "cookie": [] } ], @@ -356,7 +344,7 @@ { "listen": "test", "script": { - "id": "754515a3-5717-4dd2-ae4a-446412b2386e", + "id": "f5c9d197-5a1e-4ae9-9cff-604ccf6092a4", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/api/pricing-hub/prices/config - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -395,26 +383,22 @@ "event": [], "variable": [ { - "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://prchub.{{environment}}.com.br", "key": "baseUrl" } ], "info": { - "_postman_id": "cf465623-4c95-4784-ac0b-2cc2d7108a80", + "_postman_id": "c2785efa-9c98-446d-8501-bfc17b2118d5", "name": "Pricing Hub (DEPRECATED)", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { - "content": "> This feature is in closed beta, available only for selected customers. If you have any questions, contact our [Support](https://support.vtex.com/hc/en-us/requests). \r\n\r\n In the B2B scenario, it is common for stores to have personalized prices per customer and complex pricing systems that require external integrations. Pricing Hub is a system developed for the B2B context that works as an intermediary between VTEX and external pricing systems.\r\n\r\n In VTEX, B2B stores have the option to use our internal pricing system or an external one. If the store chooses to operate with an external pricing system, Pricing Hub will query an external price calculation API. The external API should then respond with the price for all items in the shopping cart according to its predefined tax rules.\r\n\r\n![Pricing hub protocal diagram](https://user-images.githubusercontent.com/77292838/211634260-e4f7a516-91df-416e-ab43-d9c79d56bc91.png)\r\n\r\n## Implementation\r\n\r\nTo connect with external pricing systems using Pricing Hub, it is necessary to build a VTEX IO middleware app. We offer two reference implementation templates to simplify this process:\r\n\r\n- [C# template](https://github.com/vtex-apps/external-prices-app)\r\n- [Node template](https://github.com/vtex-apps/external-prices-node)\r\n\r\nRead the documentation on each repository to learn more about the required steps to use and customize the app.\r\n\r\n> The app used by Pricing Hub to connect must be a `major 0`. \r\n\r\n### Index\r\n- [POST - Retrieve prices](https://developers.vtex.com/docs/api-reference/pricing-hub#post-/api/pricing-hub/prices?endpoint=post-/api/pricing-hub/prices)\r\n- [PUT - Configure External Price Source](https://developers.vtex.com/docs/api-reference/pricing-hub#put-/api/pricing-hub/prices/config)\n\n## Common parameters in the documentation\r\n\r\n| Parameter name | Description |\r\n| - | - |\r\n| `{{accountName}}` | Store account name. |\r\n| `{{environment}}` | The environment that will be called. |\r\n| `{{X-VTEX-API-AppKey}}` | Located in the headers of the requests, user authentication key. |\r\n| `{{X-VTEX-API-AppToken}}` | Located in the headers of the requests, authentication password. |", + "content": ">⚠️ This API has been deprecated. If you need to associate prices with customers, we recommend using the [Audience API](https://developers.vtex.com/docs/api-reference/audience-api).\\n\\n. \r\n\r\n In the B2B scenario, it is common for stores to have personalized prices per customer and complex pricing systems that require external integrations. Pricing Hub is a system developed for the B2B context that works as an intermediary between VTEX and external pricing systems.\r\n\r\n In VTEX, B2B stores have the option to use our internal pricing system or an external one. If the store chooses to operate with an external pricing system, Pricing Hub will query an external price calculation API. The external API should then respond with the price for all items in the shopping cart according to its predefined tax rules.\r\n\r\n![Pricing hub protocal diagram](https://user-images.githubusercontent.com/77292838/211634260-e4f7a516-91df-416e-ab43-d9c79d56bc91.png)\r\n\r\n## Implementation\r\n\r\nTo connect with external pricing systems using Pricing Hub, it is necessary to build a VTEX IO middleware app. We offer two reference implementation templates to simplify this process:\r\n\r\n- [C# template](https://github.com/vtex-apps/external-prices-app)\r\n- [Node template](https://github.com/vtex-apps/external-prices-node)\r\n\r\nRead the documentation on each repository to learn more about the required steps to use and customize the app.\r\n\r\n> The app used by Pricing Hub to connect must be a `major 0`. \r\n\r\n## Common parameters in the documentation\r\n\r\n| Parameter name | Description |\r\n| - | - |\r\n| `{{accountName}}` | Store account name. |\r\n| `{{environment}}` | The environment that will be called. |\r\n| `{{X-VTEX-API-AppKey}}` | Located in the headers of the requests, user authentication key. |\r\n| `{{X-VTEX-API-AppToken}}` | Located in the headers of the requests, authentication password. |", "type": "text/plain" } } diff --git a/VTEX - Pricing Hub.json b/VTEX - Pricing Hub.json index af10e02cc..258b745d4 100644 --- a/VTEX - Pricing Hub.json +++ b/VTEX - Pricing Hub.json @@ -2,7 +2,7 @@ "openapi": "3.0.0", "info": { "title": "Pricing Hub (DEPRECATED)", - "description": ">⚠️ This API has been deprecated. If you need to associate prices with customers, we recommend using the [Audience API](https:\/\/developers.vtex.com\/docs\/api-reference\/audience-api).\\n\\n. \r\n\r\n In the B2B scenario, it is common for stores to have personalized prices per customer and complex pricing systems that require external integrations. Pricing Hub is a system developed for the B2B context that works as an intermediary between VTEX and external pricing systems.\r\n\r\n In VTEX, B2B stores have the option to use our internal pricing system or an external one. If the store chooses to operate with an external pricing system, Pricing Hub will query an external price calculation API. The external API should then respond with the price for all items in the shopping cart according to its predefined tax rules.\r\n\r\n![Pricing hub protocal diagram](https:\/\/user-images.githubusercontent.com\/77292838\/211634260-e4f7a516-91df-416e-ab43-d9c79d56bc91.png)\r\n\r\n## Implementation\r\n\r\nTo connect with external pricing systems using Pricing Hub, it is necessary to build a VTEX IO middleware app. We offer two reference implementation templates to simplify this process:\r\n\r\n- [C# template](https:\/\/github.com\/vtex-apps\/external-prices-app)\r\n- [Node template](https:\/\/github.com\/vtex-apps\/external-prices-node)\r\n\r\nRead the documentation on each repository to learn more about the required steps to use and customize the app.\r\n\r\n> The app used by Pricing Hub to connect must be a `major 0`. \r\n\r\n### Index\r\n- [POST - Retrieve prices](https:\/\/developers.vtex.com\/docs\/api-reference\/pricing-hub#post-\/api\/pricing-hub\/prices?endpoint=post-\/api\/pricing-hub\/prices)\r\n- [PUT - Configure External Price Source](https:\/\/developers.vtex.com\/docs\/api-reference\/pricing-hub#put-\/api\/pricing-hub\/prices\/config)\r\n\r\n## Common parameters in the documentation\r\n\r\n| Parameter name | Description |\r\n| - | - |\r\n| `{{accountName}}` | Store account name. |\r\n| `{{environment}}` | The environment that will be called. |\r\n| `{{X-VTEX-API-AppKey}}` | Located in the headers of the requests, user authentication key. |\r\n| `{{X-VTEX-API-AppToken}}` | Located in the headers of the requests, authentication password. |", + "description": ">⚠️ This API has been deprecated. If you need to associate prices with customers, we recommend using the [Audience API](https:\/\/developers.vtex.com\/docs\/api-reference\/audience-api).\\n\\n. \r\n\r\n In the B2B scenario, it is common for stores to have personalized prices per customer and complex pricing systems that require external integrations. Pricing Hub is a system developed for the B2B context that works as an intermediary between VTEX and external pricing systems.\r\n\r\n In VTEX, B2B stores have the option to use our internal pricing system or an external one. If the store chooses to operate with an external pricing system, Pricing Hub will query an external price calculation API. The external API should then respond with the price for all items in the shopping cart according to its predefined tax rules.\r\n\r\n![Pricing hub protocal diagram](https:\/\/user-images.githubusercontent.com\/77292838\/211634260-e4f7a516-91df-416e-ab43-d9c79d56bc91.png)\r\n\r\n## Implementation\r\n\r\nTo connect with external pricing systems using Pricing Hub, it is necessary to build a VTEX IO middleware app. We offer two reference implementation templates to simplify this process:\r\n\r\n- [C# template](https:\/\/github.com\/vtex-apps\/external-prices-app)\r\n- [Node template](https:\/\/github.com\/vtex-apps\/external-prices-node)\r\n\r\nRead the documentation on each repository to learn more about the required steps to use and customize the app.\r\n\r\n> The app used by Pricing Hub to connect must be a `major 0`. \r\n\r\n## Common parameters in the documentation\r\n\r\n| Parameter name | Description |\r\n| - | - |\r\n| `{{accountName}}` | Store account name. |\r\n| `{{environment}}` | The environment that will be called. |\r\n| `{{X-VTEX-API-AppKey}}` | Located in the headers of the requests, user authentication key. |\r\n| `{{X-VTEX-API-AppToken}}` | Located in the headers of the requests, authentication password. |", "contact": {}, "version": "1.0" },