diff --git a/PostmanCollections/VTEX - Pricing API.json b/PostmanCollections/VTEX - Pricing API.json
index 70ddb5ad4..b51c74f69 100644
--- a/PostmanCollections/VTEX - Pricing API.json
+++ b/PostmanCollections/VTEX - Pricing API.json
@@ -1,10 +1,10 @@
{
"_": {
- "postman_id": "10491e02-d085-4516-964c-46e29d185129"
+ "postman_id": "4e87d932-2197-467a-98c1-42d8392f6986"
},
"item": [
{
- "id": "54d73c91-9619-4d49-bb53-85783575d354",
+ "id": "33744315-8a6c-4d5b-93e1-e29a8c7775e4",
"name": "Price Tables",
"description": {
"content": "",
@@ -12,12 +12,12 @@
},
"item": [
{
- "id": "18c5b0f5-b5c3-4567-9fa3-aeff18353a54",
+ "id": "06957774-c13e-4a3c-8a93-e8c33bb46591",
"name": "Get rules for a price table",
"request": {
"name": "Get rules for a price table",
"description": {
- "content": "This method will retrieve the rules from a specific Price Table.\r\n\r\n## Response body example\r\n\r\n```json\r\n{\r\n \"tradePolicyId\": \"b2c\",\r\n \"rules\": [{\r\n \"id\": 0,\r\n \"context\": {\r\n \"categories\": {},\r\n \"brands\": {\r\n \"2000009\": \"Whiskas\"\r\n },\r\n \"stockStatuses\": null,\r\n \"internalCategories\": null,\r\n \"markupRange\": null,\r\n \"dateRange\": null\r\n },\r\n \"percentualModifier\": 15\r\n }]\r\n}\r\n```",
+ "content": "This method will retrieve the rules from a specific Price Table.\r\n\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-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| Pricing | Price List | **Read prices** |\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 machine 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": {
@@ -71,7 +71,7 @@
"_": {
"postman_previewlanguage": "json"
},
- "id": "54c5376c-e056-431a-92ef-fbbdc128a46a",
+ "id": "2739ca4a-3921-489a-a675-e77a93db08f1",
"name": "OK",
"originalRequest": {
"url": {
@@ -162,7 +162,7 @@
"_": {
"postman_previewlanguage": "text"
},
- "id": "21f2e9dc-c18c-4797-9444-c70667e6d5b6",
+ "id": "9886a96c-0ded-4234-a58a-223cd8a135da",
"name": "Unauthorized",
"originalRequest": {
"url": {
@@ -249,7 +249,7 @@
"_": {
"postman_previewlanguage": "text"
},
- "id": "e4727777-22be-4b91-a74a-883d1a6c9e58",
+ "id": "0ed5c9cc-1140-4da1-be4c-1d529d1349a0",
"name": "Forbidden",
"originalRequest": {
"url": {
@@ -336,7 +336,7 @@
"_": {
"postman_previewlanguage": "text"
},
- "id": "186db9f3-ce0a-4465-a101-fb1421dbf806",
+ "id": "b1cd0bd3-3339-496e-a52d-14fd5216de0d",
"name": "Too many requests",
"originalRequest": {
"url": {
@@ -426,12 +426,12 @@
}
},
{
- "id": "de50122d-17cd-48b7-b2bb-b0461f4f2ae6",
+ "id": "cd011c5d-8fed-4376-85df-0cc74bffd3dc",
"name": "Update rules for a price table",
"request": {
"name": "Update rules for a price table",
"description": {
- "content": "This method will update the rules from a specific Price Table. It will delete all the rules from the requested Price Table and create new rules based on the content of the request.\r\n\r\n## Request body example\r\n\r\n```json\r\n{\r\n \"rules\": [\r\n {\r\n \"id\": 1,\r\n \"context\": {\r\n \"categories\": {\r\n \"Category ID\": \"1\",\r\n \"Category Name\": \"Alimentação\"\r\n },\r\n \"brands\": {\r\n \"Brand ID\": \"2000002\",\r\n \"Brand Name\": \"Whiskas\"\r\n },\r\n \"markupRange\": {\r\n \"from\": 0,\r\n \"to\": 200\r\n },\r\n \"dateRange\": {\r\n \"from\": \"2022-01-23T19:00:00.000Z\",\r\n \"to\": \"2023-10-26T00:00:00.000Z\"\r\n }\r\n },\r\n \"percentualModifier\": 0\r\n }\r\n ]\r\n}\r\n```",
+ "content": "This method will update the rules from a specific Price Table. It will delete all the rules from the requested Price Table and create new rules based on the content of the request.\r\n\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-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| Pricing | Price List | **Modify prices** |\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 machine 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": {
@@ -453,7 +453,7 @@
"type": "text/plain"
},
"type": "any",
- "value": "ad",
+ "value": "ipsum qui officia in",
"key": "priceTableId"
},
{
@@ -489,7 +489,7 @@
"_": {
"postman_previewlanguage": "text"
},
- "id": "19791c93-935b-4e3d-a885-f6a1b3c1bdf4",
+ "id": "c509d20d-636b-4d4a-98bb-9216cefe3ebd",
"name": "Created",
"originalRequest": {
"url": {
@@ -511,7 +511,7 @@
"type": "text/plain"
},
"type": "any",
- "value": "ad",
+ "value": "ipsum qui officia in",
"key": "priceTableId"
},
{
@@ -556,7 +556,7 @@
"method": "PUT",
"body": {
"mode": "raw",
- "raw": "{\n \"rules\": [\n {\n \"id\": 0,\n \"context\": {\n \"categories\": {\n \"laborum_249\": \"209\",\n \"ina\": \"209\"\n },\n \"brands\": {\n \"dolor_d90\": \"421\"\n },\n \"markupRange\": null,\n \"dateRange\": {\n \"from\": \"2019-10-23T19:00:00.000Z\",\n \"to\": \"2019-10-26T00:00:00.000Z\"\n },\n \"stockStatuses\": null,\n \"internalCategories\": null\n },\n \"percentualModifier\": 0\n },\n {\n \"id\": 0,\n \"context\": {\n \"categories\": {\n \"utb1\": \"209\"\n },\n \"brands\": {\n \"in_0d1\": \"421\",\n \"laboris_b73\": \"421\",\n \"sitcf_\": \"421\",\n \"magna_e4\": \"421\"\n },\n \"markupRange\": null,\n \"dateRange\": {\n \"from\": \"2019-10-23T19:00:00.000Z\",\n \"to\": \"2019-10-26T00:00:00.000Z\"\n },\n \"stockStatuses\": null,\n \"internalCategories\": null\n },\n \"percentualModifier\": 0\n }\n ]\n}",
+ "raw": "{\n \"rules\": [\n {\n \"id\": 0,\n \"context\": {\n \"categories\": {\n \"magna_a7a\": \"209\",\n \"Duisab9\": \"209\"\n },\n \"brands\": {\n \"deserunt_ef\": \"421\"\n },\n \"markupRange\": null,\n \"dateRange\": {\n \"from\": \"2019-10-23T19:00:00.000Z\",\n \"to\": \"2019-10-26T00:00:00.000Z\"\n },\n \"stockStatuses\": null,\n \"internalCategories\": null\n },\n \"percentualModifier\": 0\n },\n {\n \"id\": 0,\n \"context\": {\n \"categories\": {\n \"officia900\": \"209\"\n },\n \"brands\": {\n \"do_d7\": \"421\"\n },\n \"markupRange\": null,\n \"dateRange\": {\n \"from\": \"2019-10-23T19:00:00.000Z\",\n \"to\": \"2019-10-26T00:00:00.000Z\"\n },\n \"stockStatuses\": null,\n \"internalCategories\": null\n },\n \"percentualModifier\": 0\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
@@ -580,7 +580,7 @@
{
"listen": "test",
"script": {
- "id": "a5e465aa-e9d9-47f7-879c-6bae170cb5e7",
+ "id": "f8c3e8a8-d921-4fb4-90a5-ddd6df709c84",
"type": "text/javascript",
"exec": [
"// Validate status 2xx \npm.test(\"[PUT]::/pricing/pipeline/catalog/:priceTableId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n"
@@ -593,12 +593,12 @@
}
},
{
- "id": "a7929205-0cb6-4385-be98-164db3404005",
+ "id": "60475ebe-cc2b-4490-955a-b360d8b5cda7",
"name": "Get all price tables and their rules",
"request": {
"name": "Get all price tables and their rules",
"description": {
- "content": "This method will retrieve all price tables and their rules.\r\n\r\n## Response body example\r\n\r\n```json\r\n[\r\n {\r\n \"tradePolicyId\": \"2\",\r\n \"rules\": [\r\n {\r\n \"id\": 0,\r\n \"context\": {\r\n \"categories\": {},\r\n \"brands\": {},\r\n \"stockStatuses\": null,\r\n \"internalCategories\": null,\r\n \"markupRange\": null,\r\n \"dateRange\": null\r\n },\r\n \"percentualModifier\": 20\r\n }\r\n ]\r\n },\r\n {\r\n \"tradePolicyId\": \"b2c\",\r\n \"rules\": [\r\n {\r\n \"id\": 0,\r\n \"context\": {\r\n \"categories\": {},\r\n \"brands\": {\r\n \"2000009\": \"Whiskas\"\r\n },\r\n \"stockStatuses\": null,\r\n \"internalCategories\": null,\r\n \"markupRange\": null,\r\n \"dateRange\": null\r\n },\r\n \"percentualModifier\": 15\r\n }\r\n ]\r\n }\r\n]\r\n```",
+ "content": "This method will retrieve all price tables and their rules.\r\n\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-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| Pricing | Price List | **Read prices** |\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 machine 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": {
@@ -641,7 +641,7 @@
"_": {
"postman_previewlanguage": "json"
},
- "id": "87e99173-fa20-43fa-a36a-6f18c7566e6d",
+ "id": "69730131-f552-4099-a999-54b1e709fd44",
"name": "OK",
"originalRequest": {
"url": {
@@ -724,12 +724,12 @@
}
},
{
- "id": "10c4b243-0cc2-44eb-bd45-028e36ad56ac",
+ "id": "778621a1-93bc-4b46-9a42-d66da52147ca",
"name": "List price tables",
"request": {
"name": "List price tables",
"description": {
- "content": "This method will list all price tables.\r\n\r\n## Response body example\r\n\r\n```json\r\n[\r\n \"1\",\r\n \"2\",\r\n \"3\",\r\n \"b2c\",\r\n \"b2b\",\r\n \"gold\"\r\n]\r\n```",
+ "content": "This method will list all price tables.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-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| Pricing | Price List | **Read prices** |\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 machine 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": {
@@ -771,7 +771,7 @@
"_": {
"postman_previewlanguage": "json"
},
- "id": "bd461529-64f8-458d-8c01-1c103cb88a7e",
+ "id": "6223213e-46a9-4321-8466-f62fb91db2fd",
"name": "OK",
"originalRequest": {
"url": {
@@ -856,7 +856,7 @@
"event": []
},
{
- "id": "db6fafc7-00a6-43ad-8e27-eb4c44fcbfd5",
+ "id": "a41c96bc-652e-428f-a16d-923593f9e517",
"name": "Prices and Fixed Prices",
"description": {
"content": "",
@@ -864,12 +864,12 @@
},
"item": [
{
- "id": "bc4dfd9c-9de2-4060-9b8d-f353696f3fad",
+ "id": "658fbf7b-baaa-4958-92c1-85218c867dae",
"name": "Get Price",
"request": {
"name": "Get Price",
"description": {
- "content": "Retrieves price data given a specific SKU ID. Within the `fixedPrices` object, there might be a list of prices for specific Trade Policies and Minimium Quantities of the SKU. Fixed Prices may also be scheduled.\r\n\r\n ## Response body example\r\n\r\n```json\r\n{\r\n \"itemId\": \"1\",\r\n \"listPrice\": 50,\r\n \"costPrice\": 90,\r\n \"markup\": 30,\r\n \"basePrice\": 117,\r\n \"fixedPrices\": [\r\n {\r\n \"tradePolicyId\": \"1\",\r\n \"value\": 50.5,\r\n \"listPrice\": 50.5,\r\n \"minQuantity\": 2,\r\n \"dateRange\": {\r\n \"from\": \"2021-12-31T01:00:00Z\",\r\n \"to\": \"2022-12-31T01:00:00Z\"\r\n }\r\n },\r\n {\r\n \"tradePolicyId\": \"2\",\r\n \"value\": 30,\r\n \"listPrice\": 50,\r\n \"minQuantity\": 2\r\n }\r\n ]\r\n}\r\n```",
+ "content": "Retrieves price data given a specific SKU ID. Within the `fixedPrices` object, there might be a list of prices for specific Trade Policies and Minimium Quantities of the SKU. Fixed Prices may also be scheduled.\r\n\r\n\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-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| Pricing | Price List | **Read prices** |\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 machine 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": {
@@ -917,7 +917,7 @@
"_": {
"postman_previewlanguage": "json"
},
- "id": "068ca631-0bd5-4127-bc2f-3c2216a6164f",
+ "id": "6fb8f568-3beb-4ede-9649-d63f3e81af42",
"name": "OK",
"originalRequest": {
"url": {
@@ -1003,7 +1003,7 @@
{
"listen": "test",
"script": {
- "id": "918562ea-95ff-4012-94a2-444b99b90362",
+ "id": "c5929a41-b71a-4cce-8251-aadfd1ccf11d",
"type": "text/javascript",
"exec": [
"// Validate status 2xx \npm.test(\"[GET]::/pricing/prices/:itemId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n",
@@ -1019,12 +1019,12 @@
}
},
{
- "id": "1f036057-c648-4810-a39e-e0c98804432f",
+ "id": "36b357bc-309b-40e9-ac28-390c880a567b",
"name": "Delete Price",
"request": {
"name": "Delete Price",
"description": {
- "content": "Deletes the Base Price and all available Fixed Prices for an SKU in all trade policies.",
+ "content": "Deletes the Base Price and all available Fixed Prices for an SKU in all trade policies.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-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| Pricing | Price List | **Delete all prices from account** |\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 machine 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": {
@@ -1066,7 +1066,7 @@
"_": {
"postman_previewlanguage": "text"
},
- "id": "5954ab71-79e0-46b0-9676-fe99830de7ef",
+ "id": "bd8c169c-4de7-4947-a05a-fa7bf3cd9050",
"name": "OK",
"originalRequest": {
"url": {
@@ -1148,7 +1148,7 @@
{
"listen": "test",
"script": {
- "id": "22d30533-f6ae-4d0b-b19f-18e8f73f2f13",
+ "id": "2a6c623d-95eb-4476-bbc7-84a61c1bcef1",
"type": "text/javascript",
"exec": [
"// Validate status 2xx \npm.test(\"[DELETE]::/pricing/prices/:itemId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n"
@@ -1161,12 +1161,12 @@
}
},
{
- "id": "8069707c-58e1-4977-b9d7-f6de8aaea3c6",
+ "id": "0380853e-6334-4303-90d4-0afc6f9cb83e",
"name": "Create or Update Base Price or Fixed Prices",
"request": {
"name": "Create or Update Base Price or Fixed Prices",
"description": {
- "content": "Creates or updates an SKU Base Price or Fixed Prices. The **base price** is the basic selling price of a product, it comprises the cost price and the markup wanted in the sale of the product. The **fixed price** is an optional price of the SKU for a specific trade policy with a specific minimum quantity to be activated.\r\n\r\n
You may optionally set a list price. Additionally, you may set either a cost price or a markup value. By defining either one of them, the other will be calculated to conform to the formula costPrice * (1 + markup) = basePrice
.
Request body example
\r\n\r\n```json\r\n{\r\n \"markup\": 30,\r\n \"basePrice\": 100,\r\n \"listPrice\": 35,\r\n \"fixedPrices\": [\r\n {\r\n \"tradePolicyId\": \"1\",\r\n \"value\": 31,\r\n \"listPrice\": 32,\r\n \"minQuantity\": 1,\r\n \"dateRange\": {\r\n \"from\": \"2022-05-21T22:00:00Z\",\r\n \"to\": \"2023-05-28T22:00:00Z\"\r\n }\r\n },\r\n {\r\n \"tradePolicyId\": \"1\",\r\n \"value\": 31.5,\r\n \"listPrice\": 33,\r\n \"minQuantity\": 2\r\n }\r\n ]\r\n}\r\n```",
+ "content": "Creates or updates an SKU Base Price or Fixed Prices. The **base price** is the basic selling price of a product, it comprises the cost price and the markup wanted in the sale of the product. The **fixed price** is an optional price of the SKU for a specific trade policy with a specific minimum quantity to be activated.\r\n\r\nYou may optionally set a list price. Additionally, you may set either a cost price or a markup value. By defining either one of them, the other will be calculated to conform to the formula`costPrice * (1 + markup) = basePrice`.\r\n\r\n\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-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| Pricing | Price List | **Modify prices** |\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 machine 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": {
@@ -1223,7 +1223,7 @@
"_": {
"postman_previewlanguage": "text"
},
- "id": "8ab543c6-918f-4c62-834e-37c821d4e23f",
+ "id": "f66141d8-7a1a-4234-8f6d-e33918d75799",
"name": "OK",
"originalRequest": {
"url": {
@@ -1313,7 +1313,7 @@
{
"listen": "test",
"script": {
- "id": "ae0a407c-ae94-44ef-988a-ffa77ba350ef",
+ "id": "58185aa3-e566-416e-96ce-fbb3707367f8",
"type": "text/javascript",
"exec": [
"// Validate status 2xx \npm.test(\"[PUT]::/pricing/prices/:itemId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n"
@@ -1326,12 +1326,12 @@
}
},
{
- "id": "d3c06624-3db5-4248-b5be-1d7787aa6c79",
+ "id": "3d0995ac-f0b7-4cfe-a583-978a263f283b",
"name": "Get Fixed Prices",
"request": {
"name": "Get Fixed Prices",
"description": {
- "content": "The **fixed price** is an optional price of the SKU for a specific trade policy with a specific minimum quantity to be activated. This method retrieves an array of Fixed Prices for an SKU in a Trade Policy with Minimum Quantities.\r\n\r\n The default value for a Minimum Quantity is `1`. This means a Fixed Price will be valid for a SKU in a Trade Policy for orders containing the specified number of Minimum Quantity or above, unless a higher Minimum Quantity is specified.\r\n\r\n Fixed prices may, optionally, be scheduled. If so, these objects will contain the `dateRange` object with `from` and `to` properties, indicating the start and end time of the scheduled fixed price in the RFC3339 timestamp format (`YYYY-MM-DDT23:59:60Z`).\r\n\r\n Note that the 'Z', at the end, represents the UTC time (GMT+00:00). If it was in GMT-03:00, for example, it would be (`YYYY-MM-DDT23:59:60-03:00`).\r\n\r\n ## Response body example\r\n\r\n```json\r\n[\r\n {\r\n \"tradePolicyId\": \"6\",\r\n \"value\": 20.9,\r\n \"listPrice\": 22.9,\r\n \"minQuantity\": 1,\r\n \"dateRange\": {\r\n \"from\": \"2021-12-30T22:00:00-03:00\",\r\n \"to\": \"2021-12-30T22:00:00-03:00\"\r\n }\r\n },\r\n {\r\n \"tradePolicyId\": \"1\",\r\n \"value\": 18.9,\r\n \"listPrice\": null,\r\n \"minQuantity\": 1,\r\n \"dateRange\": {\r\n \"from\": \"2021-12-30T22:00:00-03:00\",\r\n \"to\": \"2021-12-30T22:00:00-03:00\"\r\n }\r\n }\r\n]\r\n```",
+ "content": "The **fixed price** is an optional price of the SKU for a specific trade policy with a specific minimum quantity to be activated. This method retrieves an array of Fixed Prices for an SKU in a Trade Policy with Minimum Quantities.\r\n\r\nThe default value for a Minimum Quantity is `1`. This means a Fixed Price will be valid for a SKU in a Trade Policy for orders containing the specified number of Minimum Quantity or above, unless a higher Minimum Quantity is specified.\r\n\r\nFixed prices may, optionally, be scheduled. If so, these objects will contain the `dateRange` object with `from` and `to` properties, indicating the start and end time of the scheduled fixed price in the RFC3339 timestamp format (`YYYY-MM-DDT23:59:60Z`).\r\n\r\n Note that the 'Z', at the end, represents the UTC time (GMT+00:00). If it was in GMT-03:00, for example, it would be (`YYYY-MM-DDT23:59:60-03:00`).\r\n\r\n\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-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| Pricing | Price List | **Read prices** |\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 machine 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": {
@@ -1380,7 +1380,7 @@
"_": {
"postman_previewlanguage": "json"
},
- "id": "2dd9d44f-9262-41fc-954b-27679c7a3f32",
+ "id": "633edde6-3df1-431e-8beb-65d7e30a6b50",
"name": "OK",
"originalRequest": {
"url": {
@@ -1467,7 +1467,7 @@
{
"listen": "test",
"script": {
- "id": "96119428-5178-4c0d-b961-4588d413388b",
+ "id": "b41130ab-6946-4824-b9b3-335df77cbabd",
"type": "text/javascript",
"exec": [
"// Validate status 2xx \npm.test(\"[GET]::/pricing/prices/:itemId/fixed - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n",
@@ -1483,12 +1483,12 @@
}
},
{
- "id": "4f5d52bf-fe94-4597-b7b1-f32bd98f5db4",
+ "id": "05ba67a2-3f48-4d1a-b46c-eec9a41020e9",
"name": "Create or Update Fixed Prices on a price table or trade policy",
"request": {
"name": "Create or Update Fixed Prices on a price table or trade policy",
"description": {
- "content": "Creates or updates the fixed prices of an SKU for a specific price table or trade policy. You can add one or multiple fixed prices per SKU.\r\n\r\n ## Request body example\r\n\r\n```json\r\n[\r\n {\r\n \"value\": 50.5,\r\n \"listPrice\": 50.5,\r\n \"minQuantity\": 2,\r\n \"dateRange\": {\r\n \"from\": \"2021-12-30T22:00:00-03:00\",\r\n \"to\": \"2021-12-30T22:00:00-04:00\"\r\n }\r\n }\r\n]\r\n```",
+ "content": "Creates or updates the fixed prices of an SKU for a specific price table or trade policy. You can add one or multiple fixed prices per SKU.\r\n\r\n\\r\\n\\r\\n## Permissions\\r\\n\\r\\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-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| Pricing | Price List | **Modify prices** |\\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 machine 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.",
"type": "text/plain"
},
"url": {
@@ -1557,7 +1557,7 @@
"_": {
"postman_previewlanguage": "text"
},
- "id": "d5504159-6805-4865-a1fa-4ed7d5d0819f",
+ "id": "8b306944-ba5d-4d8d-b9db-6060ca346874",
"name": "OK",
"originalRequest": {
"url": {
@@ -1659,7 +1659,7 @@
{
"listen": "test",
"script": {
- "id": "3b1f0749-fba1-4c8b-ae6d-28710adcc220",
+ "id": "f22fc6f8-87c5-4732-937e-a8d0071bd706",
"type": "text/javascript",
"exec": [
"// Validate status 2xx \npm.test(\"[POST]::/pricing/prices/:itemId/fixed/:priceTableId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n"
@@ -1672,12 +1672,12 @@
}
},
{
- "id": "4214aa0a-6080-4429-93ba-4a3d4452d3e4",
+ "id": "0758c949-3d85-4b4e-bff5-bcd26f65355a",
"name": "Get Fixed Prices on a price table or trade policy",
"request": {
"name": "Get Fixed Prices on a price table or trade policy",
"description": {
- "content": "Retrieves all Fixed Prices on a price table or trade policy. \r\n\r\n## Response body example\r\n\r\n```json\r\n[\r\n {\r\n \"tradePolicyId\": \"6\",\r\n \"value\": 20.9,\r\n \"listPrice\": 22.9,\r\n \"minQuantity\": 1,\r\n \"dateRange\": {\r\n \"from\": \"2021-12-30T22:00:00-03:00\",\r\n \"to\": \"2021-12-30T22:00:00-04:00\"\r\n }\r\n },\r\n {\r\n \"tradePolicyId\": \"1\",\r\n \"value\": 18.9,\r\n \"listPrice\": null,\r\n \"minQuantity\": 1\r\n }\r\n]\r\n```",
+ "content": "Retrieves all Fixed Prices on a price table or trade policy. \r\n\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-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| Pricing | Price List | **Read prices** |\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 machine 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": {
@@ -1737,7 +1737,7 @@
"_": {
"postman_previewlanguage": "json"
},
- "id": "98b89b1d-87c0-4ba1-939d-f31334c58a4b",
+ "id": "00ba4734-e3c1-469b-8d4d-24242a6a042c",
"name": "OK",
"originalRequest": {
"url": {
@@ -1835,7 +1835,7 @@
{
"listen": "test",
"script": {
- "id": "3c9719b1-e897-4f78-9a76-5a423026a8fa",
+ "id": "61e93b4f-8916-47d0-b242-e2f545d22d92",
"type": "text/javascript",
"exec": [
"// Validate status 2xx \npm.test(\"[GET]::/pricing/prices/:itemId/fixed/:priceTableId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n",
@@ -1851,12 +1851,12 @@
}
},
{
- "id": "fcf49179-5168-435e-ab24-eacb5990998b",
+ "id": "cc043407-a5b1-4d8c-8b00-ca7c4e63d4ae",
"name": "Delete Fixed Prices on a price table or trade policy",
"request": {
"name": "Delete Fixed Prices on a price table or trade policy",
"description": {
- "content": "Deletes all Fixed Prices of an SKU in a specific Price Table or Trade Policy.",
+ "content": "Deletes all Fixed Prices of an SKU in a specific Price Table or Trade Policy.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-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| Pricing | Price List | **Delete all prices from account** |\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 machine 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": {
@@ -1910,7 +1910,7 @@
"_": {
"postman_previewlanguage": "text"
},
- "id": "5d5db8a1-2130-451b-b96e-2c2367f56e0a",
+ "id": "203c2beb-52dd-4be7-904e-b2d516af0723",
"name": "OK",
"originalRequest": {
"url": {
@@ -2004,7 +2004,7 @@
{
"listen": "test",
"script": {
- "id": "d03fa8f0-ce0b-447c-ac28-7989746467b2",
+ "id": "0ed3e071-3b82-42ea-a265-d8564788dc85",
"type": "text/javascript",
"exec": [
"// Validate status 2xx \npm.test(\"[DELETE]::/pricing/prices/:itemId/fixed/:priceTableId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n"
@@ -2017,12 +2017,12 @@
}
},
{
- "id": "3c2a0888-9599-474d-bcb0-8d859b61bc51",
+ "id": "6c6b7804-247b-4352-876a-bd023e083f04",
"name": "Get Computed Price by price table or trade policy",
"request": {
"name": "Get Computed Price by price table or trade policy",
"description": {
- "content": "Gets the Computed Price, which is the price after all the steps in the Pricing pipeline, for an SKU in a specific price table or trade policy. \r\n\r\n## Response body example\r\n\r\n```json\r\n{\r\n \"tradePolicyId\": \"1\",\r\n \"listPrice\": 30,\r\n \"costPrice\": 76.92,\r\n \"sellingPrice\": 18.9,\r\n \"priceValidUntil\": \"2018-12-20T18:12:14Z\"\r\n}\r\n```",
+ "content": "Gets the Computed Price, which is the price after all the steps in the Pricing pipeline, for an SKU in a specific price table or trade policy. \r\n\r\n\\\\r\\\\n\\\\r\\\\n## Permissions\\\\r\\\\n\\\\r\\\\nAny user or [application key](https:\\/\\/developers.vtex.com\\/docs\\/guides\\/api-authentication-using-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| Pricing | Price List | **Read prices** |\\\\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 machine 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.",
"type": "text/plain"
},
"url": {
@@ -2115,7 +2115,7 @@
"_": {
"postman_previewlanguage": "json"
},
- "id": "bd03a30d-8233-43ed-88e3-11039dfe2eaa",
+ "id": "cb2077b6-9cac-46a8-9b13-1378fcf888ea",
"name": "OK",
"originalRequest": {
"url": {
@@ -2236,7 +2236,7 @@
"event": []
},
{
- "id": "fc1cd1e1-f3cc-4233-a384-30e2ea44d729",
+ "id": "59a9bfa8-7019-4739-b4ec-6b78683c7f43",
"name": "Pricing Configuration",
"description": {
"content": "",
@@ -2244,12 +2244,12 @@
},
"item": [
{
- "id": "30f6f638-616c-4f3a-9d82-93c2ddb1c72b",
+ "id": "2fe76c92-9045-49e2-98a8-f1db1af7a81c",
"name": "Get Pricing Configuration",
"request": {
"name": "Get Pricing Configuration",
"description": {
- "content": "Retrieves Pricing Configuration.\r\n## Response body example\r\n\r\n```json\r\n{\r\n \"hasMigrated\": true,\r\n \"migrationStatus\": \"Completed\",\r\n \"defaultMarkup\": 100,\r\n \"priceVariation\": {\r\n \"upperLimit\": null,\r\n \"lowerLimit\": null\r\n },\r\n \"minimumMarkups\": {\r\n \"1\": 100,\r\n \"2\": 90\r\n },\r\n \"tradePolicyConfigs\": [],\r\n \"sellersToOverride\": [],\r\n \"hasPriceInheritance\": false,\r\n \"priceInheritance\": \"never\",\r\n \"hasOptionalBasePrice\": false,\r\n \"blockAccount\": false,\r\n \"blockedRoutes\": null,\r\n \"priceTableSelectionStrategy\": \"first\",\r\n \"priceTableLimit\": null\r\n}\r\n```",
+ "content": "Retrieves Pricing Configuration.\r\n\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-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| Pricing | Price List | **Read prices** |\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 machine 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": {
@@ -2291,7 +2291,7 @@
"_": {
"postman_previewlanguage": "json"
},
- "id": "5d5a527e-53c1-4725-a826-1b0f8af94d0e",
+ "id": "81945626-1d1a-4ad5-8645-09db90679f4b",
"name": "OK",
"originalRequest": {
"url": {
@@ -2472,12 +2472,12 @@
}
},
{
- "id": "39aa0fc5-97bd-49d7-9136-76a8b9544832",
+ "id": "0f19864b-5821-48b9-9084-c3a7d465fdd4",
"name": "Get Pricing v2 Status",
"request": {
"name": "Get Pricing v2 Status",
"description": {
- "content": "Retrieves Pricing v2 Status. \r\n## Response body example\r\n\r\n```json\r\n{\r\n \"isActive\": true,\r\n \"hasMigrated\": true\r\n}\r\n```",
+ "content": "Retrieves Pricing v2 Status. \r\n## Response body example\r\n\r\n```json\r\n{\r\n \"isActive\": true,\r\n \"hasMigrated\": true\r\n}\r\n```\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-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| Pricing | Price List | **Read prices** |\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 machine 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": {
@@ -2519,7 +2519,7 @@
"_": {
"postman_previewlanguage": "json"
},
- "id": "dcab3b6c-5b2d-495f-b8bb-54be593e6537",
+ "id": "1244b5a3-c617-4fcd-acdb-03f1d348a71c",
"name": "OK",
"originalRequest": {
"url": {
@@ -2741,11 +2741,11 @@
}
],
"info": {
- "_postman_id": "10491e02-d085-4516-964c-46e29d185129",
+ "_postman_id": "4e87d932-2197-467a-98c1-42d8392f6986",
"name": "Pricing API",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
"description": {
- "content": "\r\n> Check the new [Pricing onboarding guide](https://developers.vtex.com/vtex-rest-api/docs/pricing-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Pricing and is organized by focusing on the developer's journey.\r\n\r\nPricing is the VTEX module responsible for the SKU's price list. At this module we have the base price of each SKU, some optional fixed prices by trade policy, and some rules that can be applied to generate dynamically different final prices according to the purchase context and the trade policy. The variables used in this collection are:\n\n`{{accountName}}` = You VTEX account name.\n\n`{{tradePolicyId}}` = Current Trade Policy ID.\n\n`{{itemId}}` = SKU ID.\n\n`{{X-VTEX-API-AppKey}}` and `{{X-VTEX-API-AppToken}}` = Credentials used in Authentication.\n\nYou can get more information about how to use this module and its business logic at our [Pricing onboarding guide](https://developers.vtex.com/vtex-rest-api/docs/pricing-overview).\n\n## Rate Limits per route\nThe rate limits per route revolve around the following values:\n\n\n| Operation | Rate | Burst credits |\n|-----------|----------------------------------|----------------|\n| GET | No rate limits | No rate limits |\n| POST/PUT |- 2000 per minute
- 33 per second | 500 |\n| DELETE | - 1000 per minute
-16 per second | 300 |\n\n### What are Burst Credits?\nIn case the account exceeds the limit frequency for a Rate Limiter (for instance, when one account makes 41 requests/second in any price insert/update route), we decrease from the Burst Credit count the exceeding (in this example, 1 Credit).\n\nIn the event of the Burst Credits reaching 0 (zero), the request is blocked with a Status 429 response.\n\nThe credits fill up over time when the route is not being used, in the same rate as the route's Rate Limiter. In our example, for each second not sending a PUT or POST request, we increase 40 Burst Credits to this Rate Limiter\n\n### Response Headers for rate limits\nIn the response headers of any request to the Pricing API, there are some headers indicating the current status of the Rate Limiting. This information may be useful to evaluate the ideal frequency to send requests to a route, and when to send a new request in the event of reaching a Rate Limit.\n\n- `Ratelimit-Limit`: Total Burst Credits offered to a route\n- `Ratelimit-Remaining`: How many Burst Credits are still available to use\n- `Ratelimit-Reset`: How long (in seconds) it will take for Burst Credits to fill up completely (it will fill up to the *Ratelimit-Limit*)\n- `Retry-After`: Indicates how many seconds you will need to wait until the Rate Limiter accepts a new request to this route again. If this header response exists, this means your current request has been rate limited and has not been processed.\n\n\n### How to integrate with Pricing v2 considering our Rate Limits\nIntegrate considering the limits of requests/route/account specified in the [Rate Limits per route](#rate-limits-per-route) section, avoiding to surpass this frequency.\n\nIf you happen to be Rate Limited, please await the time in seconds specified in `Retry-After` before making another request to the service, and reduce the rate of requests per second that your integration is making.",
+ "content": "\r\n> Check the new [Pricing onboarding guide](https://developers.vtex.com/vtex-rest-api/docs/pricing-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Pricing and is organized by focusing on the developer's journey.\r\n\r\nPricing is the VTEX module responsible for the SKU's price list. At this module we have the base price of each SKU, some optional fixed prices by trade policy, and some rules that can be applied to generate dynamically different final prices according to the purchase context and the trade policy. The variables used in this collection are:\r\n\r\n`{{accountName}}` = You VTEX account name.\r\n\r\n`{{tradePolicyId}}` = Current Trade Policy ID.\r\n\r\n`{{itemId}}` = SKU ID.\r\n\r\n`{{X-VTEX-API-AppKey}}` and `{{X-VTEX-API-AppToken}}` = Credentials used in Authentication.\r\n\r\nYou can get more information about how to use this module and its business logic at our [Pricing onboarding guide](https://developers.vtex.com/vtex-rest-api/docs/pricing-overview).\r\n\r\n## Rate Limits per route\r\nThe rate limits per route revolve around the following values:\r\n\r\n\r\n| Operation | Rate | Burst credits |\r\n|-----------|----------------------------------|----------------|\r\n| GET | No rate limits | No rate limits |\r\n| POST/PUT |- 2000 per minute
- 33 per second | 500 |\r\n| DELETE | - 1000 per minute
-16 per second | 300 |\r\n\r\n### What are Burst Credits?\r\nIn case the account exceeds the limit frequency for a Rate Limiter (for instance, when one account makes 41 requests/second in any price insert/update route), we decrease from the Burst Credit count the exceeding (in this example, 1 Credit).\r\n\r\nIn the event of the Burst Credits reaching 0 (zero), the request is blocked with a Status 429 response.\r\n\r\nThe credits fill up over time when the route is not being used, in the same rate as the route's Rate Limiter. In our example, for each second not sending a PUT or POST request, we increase 40 Burst Credits to this Rate Limiter\r\n\r\n### Response Headers for rate limits\r\nIn the response headers of any request to the Pricing API, there are some headers indicating the current status of the Rate Limiting. This information may be useful to evaluate the ideal frequency to send requests to a route, and when to send a new request in the event of reaching a Rate Limit.\r\n\r\n- `Ratelimit-Limit`: Total Burst Credits offered to a route\r\n- `Ratelimit-Remaining`: How many Burst Credits are still available to use\r\n- `Ratelimit-Reset`: How long (in seconds) it will take for Burst Credits to fill up completely (it will fill up to the *Ratelimit-Limit*)\r\n- `Retry-After`: Indicates how many seconds you will need to wait until the Rate Limiter accepts a new request to this route again. If this header response exists, this means your current request has been rate limited and has not been processed.\r\n\r\n\r\n### How to integrate with Pricing v2 considering our Rate Limits\r\nIntegrate considering the limits of requests/route/account specified in the [Rate Limits per route](#rate-limits-per-route) section, avoiding to surpass this frequency.\r\n\r\nIf you happen to be Rate Limited, please await the time in seconds specified in `Retry-After` before making another request to the service, and reduce the rate of requests per second that your integration is making.\r\n\r\n\r\n\r\n## Index\r\n\r\n### Prices and Fixed Prices\r\n- `GET` [Get Price](https://developers.vtex.com/docs/api-reference/pricing-api/#get-/pricing/prices/-itemId-)\r\n- `DELETE` [Delete Price](https://developers.vtex.com/docs/api-reference/pricing-api/#delete-/pricing/prices/-itemId-)\r\n- `PUT` [Create or Update Base Price or Fixed Prices](https://developers.vtex.com/docs/api-reference/pricing-api/#put-/pricing/prices/-itemId-)\r\n- `GET` [Get Fixed Prices](https://developers.vtex.com/docs/api-reference/pricing-api/#get-/pricing/prices/-itemId-/fixed)\r\n- `POST` [Create or Update Fixed Prices on a price table or trade policy](https://developers.vtex.com/docs/api-reference/pricing-api/#post-/pricing/prices/-itemId-/fixed/-priceTableId-)\r\n- `GET` [Get Fixed Prices on a price table policy](https://developers.vtex.com/docs/api-reference/pricing-api/#get-/pricing/prices/-itemId-/fixed/-priceTableId-)\r\n- `DELETE` [Delete Fixed Prices on a price table or trade policy](https://developers.vtex.com/docs/api-reference/pricing-api/#delete-/pricing/prices/-itemId-/fixed/-priceTableId-)\r\n- `GET` [GET Computed Price by price table or trade policy](https://developers.vtex.com/docs/api-reference/pricing-api/#get-/pricing/prices/-itemId-/computed/-priceTableId-)\r\n\r\n\r\n### Pricing Configuration\r\n- `GET` [Get Pricing Configuration](https://developers.vtex.com/docs/api-reference/pricing-api/#get-/pricing/config)\r\n- `GET` [Get Pricing v2 Status](https://developers.vtex.com/docs/api-reference/pricing-api/#get-/pricing/migration)\r\n\r\n\r\n### Price Tables\r\n- `GET` [Get rules for a price table](https://developers.vtex.com/docs/api-reference/pricing-api/#get-/pricing/pipeline/catalog/-priceTableId-)\r\n- `PUT` [Update rules for a price table](https://developers.vtex.com/docs/api-reference/pricing-api/#put-/pricing/pipeline/catalog/-priceTableId-)\r\n- `GET` [Get all price tables and their rules](https://developers.vtex.com/docs/api-reference/pricing-api/#get-/pricing/pipeline/catalog)\r\n- `GET` [List price tables](https://developers.vtex.com/docs/api-reference/pricing-api/#get-/pricing/tables)\r\n## Common parameters in the documentation\r\n\r\n| Parameter name | Description |\r\n|---------------------------|-----------------------------------------------------------------------------------------|\r\n| `{{accountName}}` | Store account name. |\r\n| `{{environment}}` | The environment that will be called. |\r\n| `{{X-VTEX-API-AppKey}}` | Located in the headers of the requests, user authentication key. |\r\n| `{{X-VTEX-API-AppToken}}` | Located in the headers of the requests, authentication password. |\r\n",
"type": "text/plain"
}
}
diff --git a/VTEX - Pricing API.json b/VTEX - Pricing API.json
index 85fb76727..540fc72ae 100644
--- a/VTEX - Pricing API.json
+++ b/VTEX - Pricing API.json
@@ -2,7 +2,7 @@
"openapi": "3.0.0",
"info": {
"title": "Pricing API",
- "description": "\r\n> Check the new [Pricing onboarding guide](https://developers.vtex.com/vtex-rest-api/docs/pricing-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Pricing and is organized by focusing on the developer's journey.\r\n\r\nPricing is the VTEX module responsible for the SKU's price list. At this module we have the base price of each SKU, some optional fixed prices by trade policy, and some rules that can be applied to generate dynamically different final prices according to the purchase context and the trade policy. The variables used in this collection are:\n\n`{{accountName}}` = You VTEX account name.\n\n`{{tradePolicyId}}` = Current Trade Policy ID.\n\n`{{itemId}}` = SKU ID.\n\n`{{X-VTEX-API-AppKey}}` and `{{X-VTEX-API-AppToken}}` = Credentials used in Authentication.\n\nYou can get more information about how to use this module and its business logic at our [Pricing onboarding guide](https://developers.vtex.com/vtex-rest-api/docs/pricing-overview).\n\n## Rate Limits per route\nThe rate limits per route revolve around the following values:\n\n\n| Operation | Rate | Burst credits |\n|-----------|----------------------------------|----------------|\n| GET | No rate limits | No rate limits |\n| POST/PUT |- 2000 per minute
- 33 per second | 500 |\n| DELETE | - 1000 per minute
-16 per second | 300 |\n\n### What are Burst Credits?\nIn case the account exceeds the limit frequency for a Rate Limiter (for instance, when one account makes 41 requests/second in any price insert/update route), we decrease from the Burst Credit count the exceeding (in this example, 1 Credit).\n\nIn the event of the Burst Credits reaching 0 (zero), the request is blocked with a Status 429 response.\n\nThe credits fill up over time when the route is not being used, in the same rate as the route's Rate Limiter. In our example, for each second not sending a PUT or POST request, we increase 40 Burst Credits to this Rate Limiter\n\n### Response Headers for rate limits\nIn the response headers of any request to the Pricing API, there are some headers indicating the current status of the Rate Limiting. This information may be useful to evaluate the ideal frequency to send requests to a route, and when to send a new request in the event of reaching a Rate Limit.\n\n- `Ratelimit-Limit`: Total Burst Credits offered to a route\n- `Ratelimit-Remaining`: How many Burst Credits are still available to use\n- `Ratelimit-Reset`: How long (in seconds) it will take for Burst Credits to fill up completely (it will fill up to the *Ratelimit-Limit*)\n- `Retry-After`: Indicates how many seconds you will need to wait until the Rate Limiter accepts a new request to this route again. If this header response exists, this means your current request has been rate limited and has not been processed.\n\n\n### How to integrate with Pricing v2 considering our Rate Limits\nIntegrate considering the limits of requests/route/account specified in the [Rate Limits per route](#rate-limits-per-route) section, avoiding to surpass this frequency.\n\nIf you happen to be Rate Limited, please await the time in seconds specified in `Retry-After` before making another request to the service, and reduce the rate of requests per second that your integration is making.",
+ "description": "\r\n> Check the new [Pricing onboarding guide](https://developers.vtex.com/vtex-rest-api/docs/pricing-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Pricing and is organized by focusing on the developer's journey.\r\n\r\nPricing is the VTEX module responsible for the SKU's price list. At this module we have the base price of each SKU, optional fixed prices by trade policy, and rules that can be applied to dynamically generate different final prices according to the purchase context and the trade policy. \r\n\r\nFind more information on how to use this module and its business logic at our [Pricing onboarding guide](https://developers.vtex.com/vtex-rest-api/docs/pricing-overview).\r\n\r\n## Rate limits per route\r\nThe rate limits per route revolve around the following values:\r\n\r\n\r\n| Operation | Rate | Burst credits |\r\n| - | - | - |\r\n| `GET` | No rate limits | No rate limits |\r\n| `POST`/ `PUT` | 2000 per minute
33 per second | 500 |\r\n| `DELETE` | 1000 per minute
16 per second | 300 |\r\n\r\n### Burst credits\r\nIn case the account exceeds the limit frequency for a Rate Limiter (for instance, when one account makes 41 requests/second in any price insert/update route), we decrease from the Burst Credit count the exceeding (in this example, 1 Credit).\r\n\r\nIn the event of the Burst Credits reaching 0 (zero), the request is blocked with a Status 429 response.\r\n\r\nThe credits fill up over time when the route is not being used, in the same rate as the route's Rate Limiter. In our example, for each second not sending a PUT or POST request, we increase 40 Burst Credits to this Rate Limiter.\r\n\r\n### Response Headers for rate limits\r\nIn the response of any request to the Pricing API, there are headers indicating the current status of the Rate Limiting. This information may be useful to evaluate the ideal frequency to send requests to a route, and when to send a new request in the event of reaching a Rate Limit.\r\n\r\n- `Ratelimit-Limit`: Total Burst Credits offered to a route\r\n- `Ratelimit-Remaining`: How many Burst Credits are still available to use\r\n- `Ratelimit-Reset`: How long (in seconds) it will take for Burst Credits to fill up completely (it will fill up to the *Ratelimit-Limit*)\r\n- `Retry-After`: Indicates how many seconds you will need to wait until the Rate Limiter accepts a new request to this route again. If this header response exists, this means your current request has been rate limited and has not been processed.\r\n\r\n\r\n### Integrating with Pricing v2 considering rate limits\r\nWhen developing an integration, consider the requests/route/account limits specified in the [Rate Limits per route](#rate-limits-per-route) section, and avoid surpassing this frequency.\r\n\r\nIf you happen to be rate limited, please await the time in seconds specified in `Retry-After` before making another request to the service, and reduce the rate of requests per second that your integration is making.\r\n\r\n\r\n\r\n## Index\r\n\r\n### Prices and Fixed Prices\r\n- `GET` [Get Price](https://developers.vtex.com/docs/api-reference/pricing-api/#get-/pricing/prices/-itemId-)\r\n- `DELETE` [Delete Price](https://developers.vtex.com/docs/api-reference/pricing-api/#delete-/pricing/prices/-itemId-)\r\n- `PUT` [Create or Update Base Price or Fixed Prices](https://developers.vtex.com/docs/api-reference/pricing-api/#put-/pricing/prices/-itemId-)\r\n- `GET` [Get Fixed Prices](https://developers.vtex.com/docs/api-reference/pricing-api/#get-/pricing/prices/-itemId-/fixed)\r\n- `POST` [Create or Update Fixed Prices on a price table or trade policy](https://developers.vtex.com/docs/api-reference/pricing-api/#post-/pricing/prices/-itemId-/fixed/-priceTableId-)\r\n- `GET` [Get Fixed Prices on a price table policy](https://developers.vtex.com/docs/api-reference/pricing-api/#get-/pricing/prices/-itemId-/fixed/-priceTableId-)\r\n- `DELETE` [Delete Fixed Prices on a price table or trade policy](https://developers.vtex.com/docs/api-reference/pricing-api/#delete-/pricing/prices/-itemId-/fixed/-priceTableId-)\r\n- `GET` [GET Computed Price by price table or trade policy](https://developers.vtex.com/docs/api-reference/pricing-api/#get-/pricing/prices/-itemId-/computed/-priceTableId-)\r\n\r\n\r\n### Pricing Configuration\r\n- `GET` [Get Pricing Configuration](https://developers.vtex.com/docs/api-reference/pricing-api/#get-/pricing/config)\r\n- `GET` [Get Pricing v2 Status](https://developers.vtex.com/docs/api-reference/pricing-api/#get-/pricing/migration)\r\n\r\n\r\n### Price Tables\r\n- `GET` [Get rules for a price table](https://developers.vtex.com/docs/api-reference/pricing-api/#get-/pricing/pipeline/catalog/-priceTableId-)\r\n- `PUT` [Update rules for a price table](https://developers.vtex.com/docs/api-reference/pricing-api/#put-/pricing/pipeline/catalog/-priceTableId-)\r\n- `GET` [Get all price tables and their rules](https://developers.vtex.com/docs/api-reference/pricing-api/#get-/pricing/pipeline/catalog)\r\n- `GET` [List price tables](https://developers.vtex.com/docs/api-reference/pricing-api/#get-/pricing/tables)\r\n## Common parameters in the documentation\r\n\r\n| Parameter name | Description |\r\n| - | - |\r\n| `{{accountName}}` | Store account name. |\r\n| `{{environment}}` | The environment that will be called. |\r\n| `{{X-VTEX-API-AppKey}}` | Located in the headers of the requests, user authentication key. |\r\n| `{{X-VTEX-API-AppToken}}` | Located in the headers of the requests, authentication password. |\r\n | `{{tradePolicyId}}` | Current Trade Policy ID.\r\n | `{{itemId}}` | SKU ID.\r\n |",
"contact": {},
"version": "1.0"
},
@@ -25,7 +25,7 @@
"Prices and Fixed Prices"
],
"summary": "Get Price",
- "description": "Retrieves price data given a specific SKU ID. Within the `fixedPrices` object, there might be a list of prices for specific Trade Policies and Minimium Quantities of the SKU. Fixed Prices may also be scheduled.\r\n\r\n ## Response body example\r\n\r\n```json\r\n{\r\n \"itemId\": \"1\",\r\n \"listPrice\": 50,\r\n \"costPrice\": 90,\r\n \"markup\": 30,\r\n \"basePrice\": 117,\r\n \"fixedPrices\": [\r\n {\r\n \"tradePolicyId\": \"1\",\r\n \"value\": 50.5,\r\n \"listPrice\": 50.5,\r\n \"minQuantity\": 2,\r\n \"dateRange\": {\r\n \"from\": \"2021-12-31T01:00:00Z\",\r\n \"to\": \"2022-12-31T01:00:00Z\"\r\n }\r\n },\r\n {\r\n \"tradePolicyId\": \"2\",\r\n \"value\": 30,\r\n \"listPrice\": 50,\r\n \"minQuantity\": 2\r\n }\r\n ]\r\n}\r\n```",
+ "description": "Retrieves price data given a specific SKU ID. Within the `fixedPrices` object, there might be a list of prices for specific Trade Policies and Minimium Quantities of the SKU. Fixed Prices may also be scheduled.\r\n\r\n\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-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| Pricing | Price List | **Read prices** |\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 machine 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": "GetPrice",
"parameters": [
{
@@ -106,7 +106,7 @@
"Prices and Fixed Prices"
],
"summary": "Delete Price",
- "description": "Deletes the Base Price and all available Fixed Prices for an SKU in all trade policies.",
+ "description": "Deletes the Base Price and all available Fixed Prices for an SKU in all trade policies.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-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| Pricing | Price List | **Delete all prices from account** |\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 machine 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": "DeletePrice",
"parameters": [
{
@@ -155,7 +155,7 @@
"Prices and Fixed Prices"
],
"summary": "Create or Update Base Price or Fixed Prices",
- "description": "Creates or updates an SKU Base Price or Fixed Prices. The **base price** is the basic selling price of a product, it comprises the cost price and the markup wanted in the sale of the product. The **fixed price** is an optional price of the SKU for a specific trade policy with a specific minimum quantity to be activated.\r\n\r\n You may optionally set a list price. Additionally, you may set either a cost price or a markup value. By defining either one of them, the other will be calculated to conform to the formula costPrice * (1 + markup) = basePrice
.
Request body example
\r\n\r\n```json\r\n{\r\n \"markup\": 30,\r\n \"basePrice\": 100,\r\n \"listPrice\": 35,\r\n \"fixedPrices\": [\r\n {\r\n \"tradePolicyId\": \"1\",\r\n \"value\": 31,\r\n \"listPrice\": 32,\r\n \"minQuantity\": 1,\r\n \"dateRange\": {\r\n \"from\": \"2022-05-21T22:00:00Z\",\r\n \"to\": \"2023-05-28T22:00:00Z\"\r\n }\r\n },\r\n {\r\n \"tradePolicyId\": \"1\",\r\n \"value\": 31.5,\r\n \"listPrice\": 33,\r\n \"minQuantity\": 2\r\n }\r\n ]\r\n}\r\n```",
+ "description": "Creates or updates an SKU Base Price or Fixed Prices. The **base price** is the basic selling price of a product, it comprises the cost price and the markup wanted in the sale of the product. The **fixed price** is an optional price of the SKU for a specific trade policy with a specific minimum quantity to be activated.\r\n\r\nYou may optionally set a list price. Additionally, you may set either a cost price or a markup value. By defining either one of them, the other will be calculated to conform to the formula`costPrice * (1 + markup) = basePrice`.\r\n\r\n\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-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| Pricing | Price List | **Modify prices** |\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 machine 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": "CreateUpdatePriceOrFixedPrice",
"parameters": [
{
@@ -296,7 +296,7 @@
"Prices and Fixed Prices"
],
"summary": "Get Fixed Prices",
- "description": "The **fixed price** is an optional price of the SKU for a specific trade policy with a specific minimum quantity to be activated. This method retrieves an array of Fixed Prices for an SKU in a Trade Policy with Minimum Quantities.\r\n\r\n The default value for a Minimum Quantity is `1`. This means a Fixed Price will be valid for a SKU in a Trade Policy for orders containing the specified number of Minimum Quantity or above, unless a higher Minimum Quantity is specified.\r\n\r\n Fixed prices may, optionally, be scheduled. If so, these objects will contain the `dateRange` object with `from` and `to` properties, indicating the start and end time of the scheduled fixed price in the RFC3339 timestamp format (`YYYY-MM-DDT23:59:60Z`).\r\n\r\n Note that the 'Z', at the end, represents the UTC time (GMT+00:00). If it was in GMT-03:00, for example, it would be (`YYYY-MM-DDT23:59:60-03:00`).\r\n\r\n ## Response body example\r\n\r\n```json\r\n[\r\n {\r\n \"tradePolicyId\": \"6\",\r\n \"value\": 20.9,\r\n \"listPrice\": 22.9,\r\n \"minQuantity\": 1,\r\n \"dateRange\": {\r\n \"from\": \"2021-12-30T22:00:00-03:00\",\r\n \"to\": \"2021-12-30T22:00:00-03:00\"\r\n }\r\n },\r\n {\r\n \"tradePolicyId\": \"1\",\r\n \"value\": 18.9,\r\n \"listPrice\": null,\r\n \"minQuantity\": 1,\r\n \"dateRange\": {\r\n \"from\": \"2021-12-30T22:00:00-03:00\",\r\n \"to\": \"2021-12-30T22:00:00-03:00\"\r\n }\r\n }\r\n]\r\n```",
+ "description": "The **fixed price** is an optional price of the SKU for a specific trade policy with a specific minimum quantity to be activated. This method retrieves an array of Fixed Prices for an SKU in a Trade Policy with Minimum Quantities.\r\n\r\nThe default value for a Minimum Quantity is `1`. This means a Fixed Price will be valid for a SKU in a Trade Policy for orders containing the specified number of Minimum Quantity or above, unless a higher Minimum Quantity is specified.\r\n\r\nFixed prices may, optionally, be scheduled. If so, these objects will contain the `dateRange` object with `from` and `to` properties, indicating the start and end time of the scheduled fixed price in the RFC3339 timestamp format (`YYYY-MM-DDT23:59:60Z`).\r\n\r\n Note that the 'Z', at the end, represents the UTC time (GMT+00:00). If it was in GMT-03:00, for example, it would be (`YYYY-MM-DDT23:59:60-03:00`).\r\n\r\n\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-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| Pricing | Price List | **Read prices** |\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 machine 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": "GetFixedPrices",
"parameters": [
{
@@ -379,7 +379,7 @@
"Prices and Fixed Prices"
],
"summary": "Create or Update Fixed Prices on a price table or trade policy",
- "description": "Creates or updates the fixed prices of an SKU for a specific price table or trade policy. You can add one or multiple fixed prices per SKU.\r\n\r\n ## Request body example\r\n\r\n```json\r\n[\r\n {\r\n \"value\": 50.5,\r\n \"listPrice\": 50.5,\r\n \"minQuantity\": 2,\r\n \"dateRange\": {\r\n \"from\": \"2021-12-30T22:00:00-03:00\",\r\n \"to\": \"2021-12-30T22:00:00-04:00\"\r\n }\r\n }\r\n]\r\n```",
+ "description": "Creates or updates the fixed prices of an SKU for a specific price table or trade policy. You can add one or multiple fixed prices per SKU.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-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| Pricing | Price List | **Modify prices** |\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 machine 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": "createorupdatefixedpricesonpricetableortradepolicy",
"parameters": [
{
@@ -493,7 +493,7 @@
"Prices and Fixed Prices"
],
"summary": "Get Fixed Prices on a price table or trade policy",
- "description": "Retrieves all Fixed Prices on a price table or trade policy. \r\n\r\n## Response body example\r\n\r\n```json\r\n[\r\n {\r\n \"tradePolicyId\": \"6\",\r\n \"value\": 20.9,\r\n \"listPrice\": 22.9,\r\n \"minQuantity\": 1,\r\n \"dateRange\": {\r\n \"from\": \"2021-12-30T22:00:00-03:00\",\r\n \"to\": \"2021-12-30T22:00:00-04:00\"\r\n }\r\n },\r\n {\r\n \"tradePolicyId\": \"1\",\r\n \"value\": 18.9,\r\n \"listPrice\": null,\r\n \"minQuantity\": 1\r\n }\r\n]\r\n```",
+ "description": "Retrieves all Fixed Prices on a price table or trade policy. \r\n\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-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| Pricing | Price List | **Read prices** |\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 machine 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": "GetFixedPricesonapricetable",
"parameters": [
{
@@ -581,7 +581,7 @@
"Prices and Fixed Prices"
],
"summary": "Delete Fixed Prices on a price table or trade policy",
- "description": "Deletes all Fixed Prices of an SKU in a specific Price Table or Trade Policy.",
+ "description": "Deletes all Fixed Prices of an SKU in a specific Price Table or Trade Policy.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-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| Pricing | Price List | **Delete all prices from account** |\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 machine 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": "Deletefixedpricesonapricetableortradepolicy",
"parameters": [
{
@@ -643,7 +643,7 @@
"Prices and Fixed Prices"
],
"summary": "Get Computed Price by price table or trade policy",
- "description": "Gets the Computed Price, which is the price after all the steps in the Pricing pipeline, for an SKU in a specific price table or trade policy. \r\n\r\n## Response body example\r\n\r\n```json\r\n{\r\n \"tradePolicyId\": \"1\",\r\n \"listPrice\": 30,\r\n \"costPrice\": 76.92,\r\n \"sellingPrice\": 18.9,\r\n \"priceValidUntil\": \"2018-12-20T18:12:14Z\"\r\n}\r\n```",
+ "description": "Gets the Computed Price, which is the price after all the steps in the Pricing pipeline, for an SKU in a specific price table or trade policy. \r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-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| Pricing | Price List | **Read prices** |\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 machine 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": "GetComputedPricebypricetable",
"parameters": [
{
@@ -764,8 +764,8 @@
"tags": [
"Pricing Configuration"
],
- "summary": "Get Pricing Configuration",
- "description": "Retrieves Pricing Configuration.\r\n## Response body example\r\n\r\n```json\r\n{\r\n \"hasMigrated\": true,\r\n \"migrationStatus\": \"Completed\",\r\n \"defaultMarkup\": 100,\r\n \"priceVariation\": {\r\n \"upperLimit\": null,\r\n \"lowerLimit\": null\r\n },\r\n \"minimumMarkups\": {\r\n \"1\": 100,\r\n \"2\": 90\r\n },\r\n \"tradePolicyConfigs\": [],\r\n \"sellersToOverride\": [],\r\n \"hasPriceInheritance\": false,\r\n \"priceInheritance\": \"never\",\r\n \"hasOptionalBasePrice\": false,\r\n \"blockAccount\": false,\r\n \"blockedRoutes\": null,\r\n \"priceTableSelectionStrategy\": \"first\",\r\n \"priceTableLimit\": null\r\n}\r\n```",
+ "summary": "Get Pricing configuration",
+ "description": "Retrieves Pricing configuration.\r\n\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-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| Pricing | Price List | **Read prices** |\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 machine 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": "GetPricingConfig",
"parameters": [
{
@@ -955,8 +955,8 @@
"tags": [
"Pricing Configuration"
],
- "summary": "Get Pricing v2 Status",
- "description": "Retrieves Pricing v2 Status. \r\n## Response body example\r\n\r\n```json\r\n{\r\n \"isActive\": true,\r\n \"hasMigrated\": true\r\n}\r\n```",
+ "summary": "Get Pricing v2 status",
+ "description": "Retrieves Pricing v2 status.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-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| Pricing | Price List | **Read prices** |\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 machine 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": "GetPricingv2Status",
"parameters": [
{
@@ -1141,7 +1141,7 @@
"Price Tables"
],
"summary": "Get rules for a price table",
- "description": "This method will retrieve the rules from a specific Price Table.\r\n\r\n## Response body example\r\n\r\n```json\r\n{\r\n \"tradePolicyId\": \"b2c\",\r\n \"rules\": [{\r\n \"id\": 0,\r\n \"context\": {\r\n \"categories\": {},\r\n \"brands\": {\r\n \"2000009\": \"Whiskas\"\r\n },\r\n \"stockStatuses\": null,\r\n \"internalCategories\": null,\r\n \"markupRange\": null,\r\n \"dateRange\": null\r\n },\r\n \"percentualModifier\": 15\r\n }]\r\n}\r\n```",
+ "description": "Retrieves the rules of a specific price table.\r\n\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-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| Pricing | Price List | **Read prices** |\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 machine 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": "Getrulesforapricetable",
"parameters": [
{
@@ -1329,7 +1329,7 @@
"Price Tables"
],
"summary": "Update rules for a price table",
- "description": "This method will update the rules from a specific Price Table. It will delete all the rules from the requested Price Table and create new rules based on the content of the request.\r\n\r\n## Request body example\r\n\r\n```json\r\n{\r\n \"rules\": [\r\n {\r\n \"id\": 1,\r\n \"context\": {\r\n \"categories\": {\r\n \"Category ID\": \"1\",\r\n \"Category Name\": \"Alimenta\u00E7\u00E3o\"\r\n },\r\n \"brands\": {\r\n \"Brand ID\": \"2000002\",\r\n \"Brand Name\": \"Whiskas\"\r\n },\r\n \"markupRange\": {\r\n \"from\": 0,\r\n \"to\": 200\r\n },\r\n \"dateRange\": {\r\n \"from\": \"2022-01-23T19:00:00.000Z\",\r\n \"to\": \"2023-10-26T00:00:00.000Z\"\r\n }\r\n },\r\n \"percentualModifier\": 0\r\n }\r\n ]\r\n}\r\n```",
+ "description": "Updates the rules of a specific price table, by deleting all the rules from the requested price table and creating new rules based on the content of the request.\r\n\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-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| Pricing | Price List | **Modify prices** |\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 machine 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.",
"parameters": [
{
"name": "Content-Type",
@@ -1537,7 +1537,7 @@
"Price Tables"
],
"summary": "Get all price tables and their rules",
- "description": "This method will retrieve all price tables and their rules.\r\n\r\n## Response body example\r\n\r\n```json\r\n[\r\n {\r\n \"tradePolicyId\": \"2\",\r\n \"rules\": [\r\n {\r\n \"id\": 0,\r\n \"context\": {\r\n \"categories\": {},\r\n \"brands\": {},\r\n \"stockStatuses\": null,\r\n \"internalCategories\": null,\r\n \"markupRange\": null,\r\n \"dateRange\": null\r\n },\r\n \"percentualModifier\": 20\r\n }\r\n ]\r\n },\r\n {\r\n \"tradePolicyId\": \"b2c\",\r\n \"rules\": [\r\n {\r\n \"id\": 0,\r\n \"context\": {\r\n \"categories\": {},\r\n \"brands\": {\r\n \"2000009\": \"Whiskas\"\r\n },\r\n \"stockStatuses\": null,\r\n \"internalCategories\": null,\r\n \"markupRange\": null,\r\n \"dateRange\": null\r\n },\r\n \"percentualModifier\": 15\r\n }\r\n ]\r\n }\r\n]\r\n```",
+ "description": "Retrieves a list of all price tables and their rules.\r\n\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-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| Pricing | Price List | **Read prices** |\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 machine 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": "getallpricetablesandrules",
"parameters": [
{
@@ -1729,7 +1729,7 @@
"Price Tables"
],
"summary": "List price tables",
- "description": "This method will list all price tables.\r\n\r\n## Response body example\r\n\r\n```json\r\n[\r\n \"1\",\r\n \"2\",\r\n \"3\",\r\n \"b2c\",\r\n \"b2b\",\r\n \"gold\"\r\n]\r\n```",
+ "description": "Retrieves a list of all price tables.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-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| Pricing | Price List | **Read prices** |\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 machine 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": "Listpricetables",
"parameters": [
{