From 03b8d45a55747740111ea621c19f002151473c51 Mon Sep 17 00:00:00 2001
From: Pedro Antunes <47991446+PedroAntunesCosta@users.noreply.github.com>
Date: Mon, 18 May 2026 20:13:02 -0300
Subject: [PATCH 1/2] chore: remove manual Index section from Pricing API
overview
---
VTEX - Pricing API.json | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/VTEX - Pricing API.json b/VTEX - Pricing API.json
index a7d5ca2dd..8a09cfb9d 100644
--- a/VTEX - Pricing API.json
+++ b/VTEX - Pricing API.json
@@ -2,7 +2,7 @@
"openapi": "3.0.0",
"info": {
"title": "Pricing API",
- "description": "Check the new [Pricing onboarding guide](https:\/\/developers.vtex.com\/docs\/guides\/pricing-overview). This guide improves the onboarding experience for developers at VTEX by assembling all Pricing documentation on our Developer Portal and organizing it around the developer journey.\r\n\r\nPricing is the VTEX module responsible for the SKU price list. It stores each SKU\u2019s base price, optional fixed prices by trade policy, and rules that dynamically generate final prices according to the purchase context and trade policy.\r\n\r\nFor details on how to use this module and its business logic, see the [Pricing onboarding guide](https:\/\/developers.vtex.com\/docs\/guides\/pricing-overview).\r\n\r\n## Rate limits per route\r\n\r\nThe following table summarizes the rate limits per HTTP method and the available burst credits for each route:\r\n\r\n| Operation | Rate | Burst credits |\r\n| - | - | - |\r\n| `GET` | Rate limit under review. Usage may be restricted in cases of excessive use. | Under review |\r\n| `POST` and `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\n\r\nWhen an account exceeds the per-second rate for a route, the excess is deducted from that route\u2019s burst credits.\r\n**Example:** If an account sends **34 requests per second** to a `POST` or `PUT` price route (whose per-second rate is **33**), **1** burst credit is consumed.\r\n\r\nIf burst credits reach **0**, the service blocks new requests and returns **HTTP 429**.\r\n\r\nBurst credits **refill over time** while the route is idle, at the **same rate** as the route\u2019s per-second limit. \r\n**Example:** For `POST` or `PUT` routes (whose per-second rate is **33**), each idle second refills **33** burst credits for that limiter.\r\n\r\n### Response headers for rate limits\r\n\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 available for the route.\r\n- `Ratelimit-Remaining`: remaining burst credits for the route.\r\n- `Ratelimit-Reset`: time, in seconds, until burst credits fully refill (up to `Ratelimit-Limit`).\r\n- `Retry-After`: time, in seconds, until the route accepts a new request. If present, the current request was rate-limited and not processed.\r\n\r\n### Integrating with Pricing v2 considering rate limits\r\nWhen developing an integration, consider the **request, route, and account** limits specified in the [Rate limits per route](#rate-limit-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## 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- `PATCH` [Create or update base price or fixed prices](https:\/\/developers.vtex.com\/docs\/api-reference\/pricing-api#patch-\/pricing\/prices\/-itemId-\/fixed)\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 prices for all price tables](https:\/\/developers.vtex.com\/docs\/api-reference\/pricing-api\/#get-\/pricing\/prices\/-itemId-\/computed)\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### 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### 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\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}` | Environment to be called. |\r\n| `X-VTEX-API-AppKey` | Header used for authentication (application key). |\r\n| `X-VTEX-API-AppToken` | Header used for authentication (application token). |",
+ "description": "Check the new [Pricing onboarding guide](https:\/\/developers.vtex.com\/docs\/guides\/pricing-overview). This guide improves the onboarding experience for developers at VTEX by assembling all Pricing documentation on our Developer Portal and organizing it around the developer journey.\r\n\r\nPricing is the VTEX module responsible for the SKU price list. It stores each SKU’s base price, optional fixed prices by trade policy, and rules that dynamically generate final prices according to the purchase context and trade policy.\r\n\r\nFor details on how to use this module and its business logic, see the [Pricing onboarding guide](https:\/\/developers.vtex.com\/docs\/guides\/pricing-overview).\r\n\r\n## Rate limits per route\r\n\r\nThe following table summarizes the rate limits per HTTP method and the available burst credits for each route:\r\n\r\n| Operation | Rate | Burst credits |\r\n| - | - | - |\r\n| `GET` | Rate limit under review. Usage may be restricted in cases of excessive use. | Under review |\r\n| `POST` and `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\n\r\nWhen an account exceeds the per-second rate for a route, the excess is deducted from that route’s burst credits.\r\n**Example:** If an account sends **34 requests per second** to a `POST` or `PUT` price route (whose per-second rate is **33**), **1** burst credit is consumed.\r\n\r\nIf burst credits reach **0**, the service blocks new requests and returns **HTTP 429**.\r\n\r\nBurst credits **refill over time** while the route is idle, at the **same rate** as the route’s per-second limit. \r\n**Example:** For `POST` or `PUT` routes (whose per-second rate is **33**), each idle second refills **33** burst credits for that limiter.\r\n\r\n### Response headers for rate limits\r\n\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 available for the route.\r\n- `Ratelimit-Remaining`: remaining burst credits for the route.\r\n- `Ratelimit-Reset`: time, in seconds, until burst credits fully refill (up to `Ratelimit-Limit`).\r\n- `Retry-After`: time, in seconds, until the route accepts a new request. If present, the current request was rate-limited and not processed.\r\n\r\n### Integrating with Pricing v2 considering rate limits\r\nWhen developing an integration, consider the **request, route, and account** limits specified in the [Rate limits per route](#rate-limit-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## Common parameters in the documentation\r\n\r\n| Parameter name | Description |\r\n| - | - |\r\n| `{accountName}` | Store account name. |\r\n| `{environment}` | Environment to be called. |\r\n| `X-VTEX-API-AppKey` | Header used for authentication (application key). |\r\n| `X-VTEX-API-AppToken` | Header used for authentication (application token). |",
"contact": {},
"version": "1.0"
},
From d3cecd1d553e171fb7e09271b3292177dd3e5287 Mon Sep 17 00:00:00 2001
From: PedroAntunesCosta <>
Date: Mon, 18 May 2026 23:14:11 +0000
Subject: [PATCH 2/2] chore: update postman files
---
PostmanCollections/VTEX - Pricing API.json | 110 ++++++++++-----------
1 file changed, 55 insertions(+), 55 deletions(-)
diff --git a/PostmanCollections/VTEX - Pricing API.json b/PostmanCollections/VTEX - Pricing API.json
index a033690c1..017a94b9f 100644
--- a/PostmanCollections/VTEX - Pricing API.json
+++ b/PostmanCollections/VTEX - Pricing API.json
@@ -1,10 +1,10 @@
{
"_": {
- "postman_id": "5547e61d-db33-4309-bc24-84f69ef55ada"
+ "postman_id": "a749ed07-6263-4e4e-b51f-035d47cad958"
},
"item": [
{
- "id": "7273f6a7-84a0-4936-b3ec-e9d083b42176",
+ "id": "64a2d9eb-7100-42e7-a9c2-40de1cf0995b",
"name": "Price Tables",
"description": {
"content": "",
@@ -12,7 +12,7 @@
},
"item": [
{
- "id": "b662f04a-2057-4ef1-8220-8f02bfec6fe0",
+ "id": "54939cb5-a158-4ee8-9fc8-2ca657188545",
"name": "Get rules for a price table",
"request": {
"name": "Get rules for a price table",
@@ -86,7 +86,7 @@
"_": {
"postman_previewlanguage": "json"
},
- "id": "0ad8ce5f-71a2-468b-aa5e-e133c363aa3c",
+ "id": "d6c8e7d0-b210-4c3e-9bec-337a9cdaa845",
"name": "OK",
"originalRequest": {
"url": {
@@ -157,7 +157,7 @@
"_": {
"postman_previewlanguage": "text"
},
- "id": "7f617388-61b3-44a7-b4e0-d15026d465ad",
+ "id": "292bfc74-7a2d-4966-9dcb-71b6f975a312",
"name": "Unauthorized",
"originalRequest": {
"url": {
@@ -218,7 +218,7 @@
"_": {
"postman_previewlanguage": "text"
},
- "id": "c3ffa307-8a98-4edd-9ea3-0922faa982ab",
+ "id": "c4576f1c-1f48-4127-977a-e2bf90b6480c",
"name": "Forbidden",
"originalRequest": {
"url": {
@@ -279,7 +279,7 @@
"_": {
"postman_previewlanguage": "text"
},
- "id": "8b4e033e-8d03-47ac-b0c9-a93afaf2555a",
+ "id": "791b3877-f641-4b3a-b700-a36074b1fd5c",
"name": "Too many requests",
"originalRequest": {
"url": {
@@ -343,7 +343,7 @@
}
},
{
- "id": "654d35ef-2aab-4397-8457-6f6b1226b960",
+ "id": "2599605a-7e2e-43d1-b308-a215f2a5b1d6",
"name": "Update rules for a price table",
"request": {
"name": "Update rules for a price table",
@@ -370,7 +370,7 @@
"type": "text/plain"
},
"type": "any",
- "value": "dolore commodo ex",
+ "value": "do",
"key": "priceTableId"
}
]
@@ -416,7 +416,7 @@
"_": {
"postman_previewlanguage": "text"
},
- "id": "16487481-aa11-4c6c-aa86-ae14d95c1fb4",
+ "id": "7d16d1b7-a866-4e77-a54d-5f126d870a5f",
"name": "Created",
"originalRequest": {
"url": {
@@ -486,7 +486,7 @@
{
"listen": "test",
"script": {
- "id": "e3921131-286a-4934-9633-10ff929b07b5",
+ "id": "7f0c0a5e-a06d-4fed-8d2d-be68de9324d3",
"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"
@@ -499,7 +499,7 @@
}
},
{
- "id": "cf78ea76-3083-484a-9654-b1ae3ab6c7f1",
+ "id": "ecd82892-52c5-4932-b70d-6e0305d8ea5d",
"name": "Create price table",
"request": {
"name": "Create price table",
@@ -525,7 +525,7 @@
"type": "text/plain"
},
"type": "any",
- "value": "dolore commodo ex",
+ "value": "do",
"key": "priceTableId"
}
]
@@ -558,7 +558,7 @@
"_": {
"postman_previewlanguage": "text"
},
- "id": "480bb363-e9b0-4f70-aee0-446a6e1219e9",
+ "id": "70036af3-654f-4dfa-821f-c24e69616eca",
"name": "OK",
"originalRequest": {
"url": {
@@ -614,7 +614,7 @@
{
"listen": "test",
"script": {
- "id": "fa17bb03-8e6e-415b-948b-d0290bfd4a24",
+ "id": "622ece95-83b0-43b4-b8d1-9fb7e16f204d",
"type": "text/javascript",
"exec": [
"// Validate status 2xx \npm.test(\"[PUT]::/pricing/tables/:priceTableId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n"
@@ -627,7 +627,7 @@
}
},
{
- "id": "a23f3f92-c6b6-4394-83c7-8c5b7458e784",
+ "id": "4b7287c8-940e-4643-953c-83fcfce5202b",
"name": "Get all price tables and their rules",
"request": {
"name": "Get all price tables and their rules",
@@ -690,7 +690,7 @@
"_": {
"postman_previewlanguage": "json"
},
- "id": "6be4611f-4ca6-49c9-b1ad-6003105dafb8",
+ "id": "caee4c56-7aa9-4a79-aa95-ee61b1c674f8",
"name": "OK",
"originalRequest": {
"url": {
@@ -763,7 +763,7 @@
}
},
{
- "id": "de2ed30c-3b8c-4456-95ea-28ccc2832a72",
+ "id": "daa042d1-bc7b-4484-a6f8-12430cdcfdf6",
"name": "List price tables",
"request": {
"name": "List price tables",
@@ -825,7 +825,7 @@
"_": {
"postman_previewlanguage": "json"
},
- "id": "c6be18c9-bcc7-4596-ae47-aa7f40413045",
+ "id": "57cec167-e4cf-4a0e-9580-242a9563a0f4",
"name": "OK",
"originalRequest": {
"url": {
@@ -900,7 +900,7 @@
"event": []
},
{
- "id": "71e22e34-bb34-4921-a15c-24fb32c1f4a8",
+ "id": "cefef2f3-86fe-4ff9-a9b2-5ae70f789210",
"name": "Prices and Fixed Prices",
"description": {
"content": "",
@@ -908,7 +908,7 @@
},
"item": [
{
- "id": "7c0b776a-54c4-486d-88de-85d4adabb1e3",
+ "id": "958f5f75-256f-4eab-aba5-6100af6c98ad",
"name": "Get price by SKU ID",
"request": {
"name": "Get price by SKU ID",
@@ -971,7 +971,7 @@
"_": {
"postman_previewlanguage": "json"
},
- "id": "24f8de98-37de-4c9d-8fde-7480f6529b1e",
+ "id": "dd97f6fb-a67b-4798-96a2-9b3acdeadc6f",
"name": "OK",
"originalRequest": {
"url": {
@@ -1037,7 +1037,7 @@
{
"listen": "test",
"script": {
- "id": "e8e9000c-d68e-4313-8667-54c6c81894c1",
+ "id": "144d680b-e702-4f72-9061-8dfd2170df91",
"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",
@@ -1053,7 +1053,7 @@
}
},
{
- "id": "535efbbc-00d7-46bb-b1bb-66d7ccb4353d",
+ "id": "933a8a6c-1b57-4c1b-a483-4cb3850dc9b1",
"name": "Delete price all base and fixed prices of an SKU",
"request": {
"name": "Delete price all base and fixed prices of an SKU",
@@ -1112,7 +1112,7 @@
"_": {
"postman_previewlanguage": "text"
},
- "id": "f07f8e09-fe16-4115-9797-f6c470839f41",
+ "id": "8d486999-c6f7-40e4-8cb3-73fad8aae2f7",
"name": "OK",
"originalRequest": {
"url": {
@@ -1168,7 +1168,7 @@
{
"listen": "test",
"script": {
- "id": "53d1643a-83a9-4a7b-8b9e-b233537dcf88",
+ "id": "c1e7fea3-ab6a-4e5b-bccd-27c93f17c625",
"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"
@@ -1181,7 +1181,7 @@
}
},
{
- "id": "f70bf3d1-d744-48cb-b226-c1a8244fec6f",
+ "id": "d8db4fa0-3a5e-428c-8062-52ddfaade9cb",
"name": "Create or update base price or fixed price",
"request": {
"name": "Create or update base price or fixed price",
@@ -1253,7 +1253,7 @@
"_": {
"postman_previewlanguage": "text"
},
- "id": "193e0e1f-a952-416f-93fe-57caa3a7043f",
+ "id": "ec076210-2c67-4337-adad-0f99e43ebde0",
"name": "OK",
"originalRequest": {
"url": {
@@ -1322,7 +1322,7 @@
{
"listen": "test",
"script": {
- "id": "0eea3c11-d2ef-4b1d-9ca1-3e3113beb693",
+ "id": "20f416d4-2fe5-489b-bb3c-f756ca8fbc64",
"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"
@@ -1335,7 +1335,7 @@
}
},
{
- "id": "96c5d1f6-3bff-41ff-b4b5-ca74159b24bd",
+ "id": "dc453a68-627a-4e58-b145-e54d9da96fdf",
"name": "Get fixed prices",
"request": {
"name": "Get fixed prices",
@@ -1399,7 +1399,7 @@
"_": {
"postman_previewlanguage": "json"
},
- "id": "da8a76c0-c1b6-4377-9d48-70f165cfc8b7",
+ "id": "3c63d352-5fc7-43b1-be1a-dcb303d7e8ea",
"name": "OK",
"originalRequest": {
"url": {
@@ -1466,7 +1466,7 @@
{
"listen": "test",
"script": {
- "id": "45ffbfc8-122a-4528-af7d-1f5349e953a8",
+ "id": "167b58e6-bbf4-482b-bce8-b8c283788885",
"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",
@@ -1482,7 +1482,7 @@
}
},
{
- "id": "d9c0e01e-94ae-45a3-8f17-5a878c4923a9",
+ "id": "b2e79576-b65f-4c65-937e-cb4b32585ee2",
"name": "Create or update base price or fixed price",
"request": {
"name": "Create or update base price or fixed price",
@@ -1555,7 +1555,7 @@
"_": {
"postman_previewlanguage": "text"
},
- "id": "ba718c72-d204-48ab-bd4e-71a6a82cd69a",
+ "id": "e3330a4e-79ee-4b2b-850d-d3430ef14d76",
"name": "OK",
"originalRequest": {
"url": {
@@ -1625,7 +1625,7 @@
{
"listen": "test",
"script": {
- "id": "51e74031-80ff-42ae-8db1-38a535f181b1",
+ "id": "9be06f23-cb98-4d21-b21f-64ad43694e84",
"type": "text/javascript",
"exec": [
"// Validate status 2xx \npm.test(\"[PATCH]::/pricing/prices/:itemId/fixed - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n"
@@ -1638,7 +1638,7 @@
}
},
{
- "id": "12c46d49-9436-4620-90b7-333d296d4631",
+ "id": "24bbcb62-de3e-40f6-9c4d-984aea57cac7",
"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",
@@ -1722,7 +1722,7 @@
"_": {
"postman_previewlanguage": "text"
},
- "id": "31d6e7a1-5d09-42aa-96db-94c8110cee6e",
+ "id": "de3458fb-2453-4714-93c4-c72873b192e7",
"name": "OK",
"originalRequest": {
"url": {
@@ -1793,7 +1793,7 @@
{
"listen": "test",
"script": {
- "id": "75614d14-c404-4f9f-970c-4333becb410d",
+ "id": "e276ad59-1cd9-4cfa-9436-8346db44147b",
"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"
@@ -1806,7 +1806,7 @@
}
},
{
- "id": "e99783fa-064f-4633-8084-bc7c309b08e1",
+ "id": "dbfcd7d5-8f50-4e25-9592-fecd29e0181e",
"name": "Get fixed prices on a price table or trade policy",
"request": {
"name": "Get fixed prices on a price table or trade policy",
@@ -1881,7 +1881,7 @@
"_": {
"postman_previewlanguage": "json"
},
- "id": "499e336c-eadd-4ed1-8a61-774f9e9250bb",
+ "id": "e9ed5d02-009f-4e8f-b31c-a77fc49ba03a",
"name": "OK",
"originalRequest": {
"url": {
@@ -1949,7 +1949,7 @@
{
"listen": "test",
"script": {
- "id": "6bcd9e94-e6ae-4b37-9123-08ea236b0bcb",
+ "id": "76d1755f-93cf-4b96-a13c-ba24d15324c5",
"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",
@@ -1965,7 +1965,7 @@
}
},
{
- "id": "c31ce370-f098-4804-8291-0d98ee0935a5",
+ "id": "c0241a8d-3cb8-4f5e-92cf-db527009e98e",
"name": "Delete fixed prices on a price table or trade policy",
"request": {
"name": "Delete fixed prices on a price table or trade policy",
@@ -2036,7 +2036,7 @@
"_": {
"postman_previewlanguage": "text"
},
- "id": "539fd412-b26c-4a0f-bee1-b57870b45986",
+ "id": "3fc7430a-2299-41f0-8277-c6a61575ec8c",
"name": "OK",
"originalRequest": {
"url": {
@@ -2094,7 +2094,7 @@
{
"listen": "test",
"script": {
- "id": "5335475d-e0ab-45d6-8e37-9e4364a4c150",
+ "id": "7d4fb958-556a-4a5a-973e-c5142e564704",
"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"
@@ -2107,7 +2107,7 @@
}
},
{
- "id": "6a7a3c84-97b6-4c2e-9fe0-0045a1c3eb03",
+ "id": "8a730ac2-0c80-4143-93dd-7f13458a9a37",
"name": "Get computed prices for all price tables",
"request": {
"name": "Get computed prices for all price tables",
@@ -2209,7 +2209,7 @@
"_": {
"postman_previewlanguage": "json"
},
- "id": "e9c76dd4-2979-4ff8-bc56-ad3d90eed0ba",
+ "id": "ee23aeda-6109-4d99-b556-41b3509fd271",
"name": "OK",
"originalRequest": {
"url": {
@@ -2311,7 +2311,7 @@
}
},
{
- "id": "e4d8867c-8ad1-40e9-809e-07c2878225fe",
+ "id": "786f659c-7319-49dc-b511-bb7a7ebc89fe",
"name": "Get computed price by price table or trade policy",
"request": {
"name": "Get computed price by price table or trade policy",
@@ -2424,7 +2424,7 @@
"_": {
"postman_previewlanguage": "json"
},
- "id": "23444b6d-89ba-4ba8-bf58-becb54c35291",
+ "id": "008a2f0a-df18-45c6-9e67-fe404ba61c71",
"name": "OK",
"originalRequest": {
"url": {
@@ -2530,7 +2530,7 @@
"event": []
},
{
- "id": "536c3147-d1d7-4c5d-87fe-9d500fb7c493",
+ "id": "0303f3af-0ea9-455f-b71f-4c2b7496f83f",
"name": "Pricing Configuration",
"description": {
"content": "",
@@ -2538,7 +2538,7 @@
},
"item": [
{
- "id": "2c17b112-8b0f-4a20-9af9-f28c527ccb4d",
+ "id": "f03463a3-0707-4b93-aaa4-e8c8adbdf51d",
"name": "Get pricing configuration",
"request": {
"name": "Get pricing configuration",
@@ -2600,7 +2600,7 @@
"_": {
"postman_previewlanguage": "json"
},
- "id": "381ce252-b065-48e3-a985-0d8926d0b2a4",
+ "id": "a892cc2b-6e0e-408b-8e37-9819b674f0e7",
"name": "OK",
"originalRequest": {
"url": {
@@ -2771,7 +2771,7 @@
}
},
{
- "id": "b91a0627-be47-49a0-89e1-0ba6abfe0cd9",
+ "id": "79beb591-2d93-43f6-b493-d0d6dec86dc7",
"name": "Get pricing v2 status",
"request": {
"name": "Get pricing v2 status",
@@ -2833,7 +2833,7 @@
"_": {
"postman_previewlanguage": "json"
},
- "id": "d81a3daf-a295-4682-a5ec-31162f182487",
+ "id": "a2a01526-268c-48b5-bd88-9b5cecd7bb86",
"name": "OK",
"originalRequest": {
"url": {
@@ -3041,11 +3041,11 @@
}
],
"info": {
- "_postman_id": "5547e61d-db33-4309-bc24-84f69ef55ada",
+ "_postman_id": "a749ed07-6263-4e4e-b51f-035d47cad958",
"name": "Pricing API",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
"description": {
- "content": "Check the new [Pricing onboarding guide](https://developers.vtex.com/docs/guides/pricing-overview). This guide improves the onboarding experience for developers at VTEX by assembling all Pricing documentation on our Developer Portal and organizing it around the developer journey.\r\n\r\nPricing is the VTEX module responsible for the SKU price list. It stores each SKU’s base price, optional fixed prices by trade policy, and rules that dynamically generate final prices according to the purchase context and trade policy.\r\n\r\nFor details on how to use this module and its business logic, see the [Pricing onboarding guide](https://developers.vtex.com/docs/guides/pricing-overview).\r\n\r\n## Rate limits per route\r\n\r\nThe following table summarizes the rate limits per HTTP method and the available burst credits for each route:\r\n\r\n| Operation | Rate | Burst credits |\r\n| - | - | - |\r\n| `GET` | Rate limit under review. Usage may be restricted in cases of excessive use. | Under review |\r\n| `POST` and `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\n\r\nWhen an account exceeds the per-second rate for a route, the excess is deducted from that route’s burst credits.\r\n**Example:** If an account sends **34 requests per second** to a `POST` or `PUT` price route (whose per-second rate is **33**), **1** burst credit is consumed.\r\n\r\nIf burst credits reach **0**, the service blocks new requests and returns **HTTP 429**.\r\n\r\nBurst credits **refill over time** while the route is idle, at the **same rate** as the route’s per-second limit. \r\n**Example:** For `POST` or `PUT` routes (whose per-second rate is **33**), each idle second refills **33** burst credits for that limiter.\r\n\r\n### Response headers for rate limits\r\n\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 available for the route.\r\n- `Ratelimit-Remaining`: remaining burst credits for the route.\r\n- `Ratelimit-Reset`: time, in seconds, until burst credits fully refill (up to `Ratelimit-Limit`).\r\n- `Retry-After`: time, in seconds, until the route accepts a new request. If present, the current request was rate-limited and not processed.\r\n\r\n### Integrating with Pricing v2 considering rate limits\r\nWhen developing an integration, consider the **request, route, and account** limits specified in the [Rate limits per route](#rate-limit-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## 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- `PATCH` [Create or update base price or fixed prices](https://developers.vtex.com/docs/api-reference/pricing-api#patch-/pricing/prices/-itemId-/fixed)\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 prices for all price tables](https://developers.vtex.com/docs/api-reference/pricing-api/#get-/pricing/prices/-itemId-/computed)\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### 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### 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\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}` | Environment to be called. |\r\n| `X-VTEX-API-AppKey` | Header used for authentication (application key). |\r\n| `X-VTEX-API-AppToken` | Header used for authentication (application token). |",
+ "content": "Check the new [Pricing onboarding guide](https://developers.vtex.com/docs/guides/pricing-overview). This guide improves the onboarding experience for developers at VTEX by assembling all Pricing documentation on our Developer Portal and organizing it around the developer journey.\r\n\r\nPricing is the VTEX module responsible for the SKU price list. It stores each SKU’s base price, optional fixed prices by trade policy, and rules that dynamically generate final prices according to the purchase context and trade policy.\r\n\r\nFor details on how to use this module and its business logic, see the [Pricing onboarding guide](https://developers.vtex.com/docs/guides/pricing-overview).\r\n\r\n## Rate limits per route\r\n\r\nThe following table summarizes the rate limits per HTTP method and the available burst credits for each route:\r\n\r\n| Operation | Rate | Burst credits |\r\n| - | - | - |\r\n| `GET` | Rate limit under review. Usage may be restricted in cases of excessive use. | Under review |\r\n| `POST` and `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\n\r\nWhen an account exceeds the per-second rate for a route, the excess is deducted from that route’s burst credits.\r\n**Example:** If an account sends **34 requests per second** to a `POST` or `PUT` price route (whose per-second rate is **33**), **1** burst credit is consumed.\r\n\r\nIf burst credits reach **0**, the service blocks new requests and returns **HTTP 429**.\r\n\r\nBurst credits **refill over time** while the route is idle, at the **same rate** as the route’s per-second limit. \r\n**Example:** For `POST` or `PUT` routes (whose per-second rate is **33**), each idle second refills **33** burst credits for that limiter.\r\n\r\n### Response headers for rate limits\r\n\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 available for the route.\r\n- `Ratelimit-Remaining`: remaining burst credits for the route.\r\n- `Ratelimit-Reset`: time, in seconds, until burst credits fully refill (up to `Ratelimit-Limit`).\r\n- `Retry-After`: time, in seconds, until the route accepts a new request. If present, the current request was rate-limited and not processed.\r\n\r\n### Integrating with Pricing v2 considering rate limits\r\nWhen developing an integration, consider the **request, route, and account** limits specified in the [Rate limits per route](#rate-limit-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## Common parameters in the documentation\r\n\r\n| Parameter name | Description |\r\n| - | - |\r\n| `{accountName}` | Store account name. |\r\n| `{environment}` | Environment to be called. |\r\n| `X-VTEX-API-AppKey` | Header used for authentication (application key). |\r\n| `X-VTEX-API-AppToken` | Header used for authentication (application token). |",
"type": "text/plain"
}
}