From 739ed9cc9b7c3653a3f25a7dbc3c745e0bf75e4d Mon Sep 17 00:00:00 2001 From: Pedro Antunes <47991446+PedroAntunesCosta@users.noreply.github.com> Date: Mon, 18 May 2026 20:11:44 -0300 Subject: [PATCH 1/2] chore: remove manual Index section from Marketplace APIs - Suggestions overview --- VTEX - Marketplace APIs - Suggestions.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/VTEX - Marketplace APIs - Suggestions.json b/VTEX - Marketplace APIs - Suggestions.json index b22e90bbc2..dfdf8242af 100644 --- a/VTEX - Marketplace APIs - Suggestions.json +++ b/VTEX - Marketplace APIs - Suggestions.json @@ -2,7 +2,7 @@ "openapi": "3.0.0", "info": { "title": "Suggestions", - "description": "The **Marketplace API** enables marketplaces and sellers hosted on VTEX to perform their collaborative operations. \r\n\r\n>⚠️ The marketplace must [create an appKey and appToken](https://developers.vtex.com/docs/guides/getting-started-authentication) for each non-VTEX seller that will use this API.\r\n\r\n## Index\r\n\r\n### Notification\r\n\r\nEndpoints used by sellers to notify marketplaces that the price or inventory language has changed for one of their SKUs.\r\n\r\n`POST` [Notify marketplace of price update](https://developers.vtex.com/docs/api-reference/marketplace-apis#post-/notificator/-sellerId-/changenotification/-skuId-/price)\r\n\r\n`POST` [Notify marketplace of inventory update](https://developers.vtex.com/docs/api-reference/marketplace-apis#post-/notificator/-sellerId-/changenotification/-skuId-/inventory)\r\n\r\n\r\n### Suggestions\r\n\r\n#### Get Suggestions\r\n\r\nSearch and filter all suggestions using specific criteria.\r\n\r\n`GET` [Get all SKU Suggestions](https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions#get-/suggestions)\r\n\r\n`GET` [Get SKU Suggestion by ID](https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions#get-/suggestions/-sellerId-/-sellerSkuId-)\r\n\r\n\r\n#### Manage Suggestions\r\n\r\nSend or delete SKU suggestions from the seller to marketplace.\r\n\r\n`PUT` [Send SKU Suggestion](https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions#put-/suggestions/-sellerId-/-sellerSkuId-)\r\n\r\n`DELETE` [Delete SKU Suggestion](https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions#delete-/suggestions/-sellerId-/-sellerSkuId-)\r\n\r\n\r\n#### Get Versions\r\n\r\nSearch and filter all versions of suggestions, using specific criteria.\r\n\r\n`GET` [Get all versions](https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions#get-/suggestions/-sellerId-/-sellerskuid-/versions)\r\n\r\n`GET` [Get version by ID](https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions#get-/suggestions/-sellerId-/-sellerskuid-/versions/-version-)\r\n\r\n\r\n#### Match Received SKUs\r\n\r\nMatch SKU suggestions received in the marketplace.\r\n\r\n`PUT` [Match Received SKUs individually](https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions#put-/suggestions/-sellerId-/-sellerskuid-/versions/-version-/matches/-matchid-)\r\n\r\n`PUT` [Match Multiple Received SKUs](https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions#put-/suggestions/matches/action/-actionName-)\r\n\r\n\r\n#### SKU Approval Settings\r\n\r\nAllows marketplaces to configure rules for automatically and manually approving SKUs received from sellers.\r\n\r\n`GET`[Get autoApprove Status in Account Settings](https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions#get-/suggestions/configuration/autoapproval/toggle) \r\n\r\n`PUT`[Activate autoApprove in Marketplace's Account](https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions#put-/suggestions/configuration/autoapproval/toggle) \r\n\r\n`GET`[Get Account's Approval Settings](https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions#get-/suggestions/configuration)\r\n\r\n`PUT`[Save Account's Approval Settings](https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions#put-/suggestions/configuration)\r\n\r\n`GET`[Get Seller's Approval Settings](https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions#get-/suggestions/configuration/seller/-sellerId-)\r\n\r\n`PUT`[Save Seller's Approval Settings](https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions#put-/suggestions/configuration/seller/-sellerId-)\r\n\r\n`PUT`[Activate autoApprove Setting for a Seller](https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions#put-/suggestions/configuration/autoapproval/toggle/seller/-sellerId-) \r\n\r\n\r\n### Matched Offers\r\n\r\nOffers are seller products and SKUs that were sent to the marketplace, and already have their price and inventory level configured.\r\n\r\n`GET`[Get Matched Offers List](https://developers.vtex.com/docs/api-reference/marketplace-apis#get-/offer-manager/pvt/offers)\r\n\r\n`GET`[Get Matched Offer's Data by SKU ID](https://developers.vtex.com/docs/api-reference/marketplace-apis#get-/offer-manager/pvt/product/-productId-/sku/-skuId-) \r\n\r\n`GET`[Get Matched Offer's Data by Product ID](https://developers.vtex.com/docs/api-reference/marketplace-apis#get-/offer-manager/pvt/product/-productId-)\r\n", + "description": "The **Marketplace API** enables marketplaces and sellers hosted on VTEX to perform their collaborative operations. \r\n\r\n>⚠️ The marketplace must [create an appKey and appToken](https://developers.vtex.com/docs/guides/getting-started-authentication) for each non-VTEX seller that will use this API.", "contact": {}, "version": "1.0" }, From c74a1a62be6d797f0648ad2112317a239a90b373 Mon Sep 17 00:00:00 2001 From: PedroAntunesCosta <> Date: Mon, 18 May 2026 23:12:49 +0000 Subject: [PATCH 2/2] chore: update postman files --- ...VTEX - Marketplace APIs - Suggestions.json | 290 ++++++++++++++---- 1 file changed, 223 insertions(+), 67 deletions(-) diff --git a/PostmanCollections/VTEX - Marketplace APIs - Suggestions.json b/PostmanCollections/VTEX - Marketplace APIs - Suggestions.json index 7d235bf126..5a59857092 100644 --- a/PostmanCollections/VTEX - Marketplace APIs - Suggestions.json +++ b/PostmanCollections/VTEX - Marketplace APIs - Suggestions.json @@ -1,10 +1,10 @@ { "_": { - "postman_id": "42f44cfc-a3e6-4440-a890-971beea67312" + "postman_id": "59e91f9d-ce37-4900-8eec-0a6066f20b59" }, "item": [ { - "id": "70864c2f-dee5-4e3c-85f0-a3d609703ae3", + "id": "c353916a-92d6-4b71-b255-83935c843767", "name": "Get suggestions", "description": { "content": "Search and filter all suggestions using specific criteria.", @@ -12,7 +12,7 @@ }, "item": [ { - "id": "09543eeb-d564-4841-a35a-5cbc29aa1132", + "id": "141030d7-21cf-4313-97d3-3a51aa8aff07", "name": "Get all SKU suggestions", "request": { "name": "Get all SKU suggestions", @@ -142,7 +142,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "c35e64f5-90f7-4bf0-9d70-b917aeee3497", + "id": "c64dd904-a00c-4bfe-8229-ab552cca7a8e", "name": "OK", "originalRequest": { "url": { @@ -246,6 +246,14 @@ }, "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "GET", @@ -261,7 +269,7 @@ { "listen": "test", "script": { - "id": "e0370418-e23f-4c29-aeaa-82472675362e", + "id": "4a01995f-6cc7-4874-b0b0-c2008fe058c2", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/suggestions - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -274,7 +282,7 @@ } }, { - "id": "5b662ff9-88b8-4452-aa23-b3801763ae3d", + "id": "b7275077-de44-4a32-87b8-8869feabbb04", "name": "Get SKU suggestion by ID", "request": { "name": "Get SKU suggestion by ID", @@ -353,7 +361,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "2c94e59d-a1c8-4fe4-b615-bc52f0b9bdb0", + "id": "0537f13c-a11b-4495-874d-cf66eea19704", "name": "OK", "originalRequest": { "url": { @@ -386,6 +394,14 @@ }, "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "GET", @@ -401,7 +417,7 @@ { "listen": "test", "script": { - "id": "46bb77c8-fc74-484b-8a67-fb2f256ee1af", + "id": "e9c8d888-bb56-4649-b811-0064ac465dd9", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/suggestions/:sellerId/:sellerSkuId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -417,7 +433,7 @@ "event": [] }, { - "id": "6ae89f2f-ea19-402e-a06b-085c4962fe1c", + "id": "a81efd3c-a9c2-4ed2-8c85-72b6a85f9783", "name": "Manage suggestions", "description": { "content": "Send or delete SKU suggestions from the seller to marketplace.", @@ -425,7 +441,7 @@ }, "item": [ { - "id": "4a1d28c1-2d4a-4ee5-81ed-73ab80782ffd", + "id": "0bc6fc89-48fb-4e7f-809e-983d2922012e", "name": "Send SKU suggestion", "request": { "name": "Send SKU suggestion", @@ -517,7 +533,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "551b01af-b000-491b-9558-b0a7c6eb1c98", + "id": "fcb47c28-9baa-48e7-a910-d368a3e54d04", "name": "OK", "originalRequest": { "url": { @@ -554,6 +570,14 @@ { "key": "Content-Type", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "PUT", @@ -578,7 +602,7 @@ { "listen": "test", "script": { - "id": "9d5387ae-939a-4951-85e3-611895af8e0d", + "id": "592557a6-42a5-4086-b922-1388a42a2d9f", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/suggestions/:sellerId/:sellerSkuId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -591,7 +615,7 @@ } }, { - "id": "fa672f0b-f065-41d8-888c-dc42f962feb0", + "id": "b4220212-2beb-4faa-8418-03fe02e7b1a7", "name": "Delete SKU suggestion", "request": { "name": "Delete SKU suggestion", @@ -670,7 +694,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "f1ae4397-d50f-43a0-88d4-f6f7d22e5207", + "id": "3b5557a4-4ff6-4d92-bd03-3c247ff3a291", "name": "OK", "originalRequest": { "url": { @@ -703,6 +727,14 @@ }, "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "DELETE", @@ -718,7 +750,7 @@ { "listen": "test", "script": { - "id": "95289fef-157b-4d40-9b63-6f8620c87eea", + "id": "5c105037-3842-404a-8617-d206a6852ec4", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[DELETE]::/suggestions/:sellerId/:sellerSkuId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -734,7 +766,7 @@ "event": [] }, { - "id": "16ab0366-2ff0-406b-9102-2f51b7c77805", + "id": "40cbbd09-7c0d-4bc0-8486-f30e213f90cb", "name": "Get versions", "description": { "content": "Search and filter all versions of suggestions, using specific criteria.", @@ -742,7 +774,7 @@ }, "item": [ { - "id": "a6408ca5-f936-4401-83c2-943e5dfbd811", + "id": "18aea704-8f0a-4354-a294-6a19bf5a17e2", "name": "Get all versions", "request": { "name": "Get all versions", @@ -822,7 +854,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "e9fa0a4e-2365-4a54-8128-6a35b118c12b", + "id": "49a5d41f-0bf5-44e4-81fc-2284cf5ee10a", "name": "OK", "originalRequest": { "url": { @@ -856,6 +888,14 @@ }, "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "GET", @@ -871,7 +911,7 @@ { "listen": "test", "script": { - "id": "c6b2df16-e465-49f6-9f49-42328fa4c619", + "id": "fc876657-9570-4c9e-87f4-417cba287ff2", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/suggestions/:sellerId/:sellerskuid/versions - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -884,7 +924,7 @@ } }, { - "id": "606941b6-b84d-44ea-840d-2b6a37aea1be", + "id": "4c27c64b-fc51-4661-9e03-e4e2a6873a93", "name": "Get version by ID", "request": { "name": "Get version by ID", @@ -975,7 +1015,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "14572bad-8e70-47b9-a96e-d49e044d7226", + "id": "dc3c0b47-b129-4ad1-b38b-9d342bfaee68", "name": "OK", "originalRequest": { "url": { @@ -1010,6 +1050,14 @@ }, "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "GET", @@ -1025,7 +1073,7 @@ { "listen": "test", "script": { - "id": "d5e83ea7-61c0-4714-87d8-c5338213be44", + "id": "2a0ffdbf-be2f-4483-8b14-3d26d98ab706", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/suggestions/:sellerId/:sellerskuid/versions/:version - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -1041,7 +1089,7 @@ "event": [] }, { - "id": "a7dcc9a0-4509-4387-ac1e-242f8cea19dc", + "id": "ca36ad40-0022-462b-8b74-081d26604225", "name": "SKU approval settings", "description": { "content": "", @@ -1049,7 +1097,7 @@ }, "item": [ { - "id": "24063774-7670-4e32-aa87-cab853d4ec90", + "id": "c37019f6-d616-4350-9317-b44cb042499d", "name": "Get autoApprove status in account settings", "request": { "name": "Get autoApprove status in account settings", @@ -1123,7 +1171,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "ef4819a0-4a18-49c8-bfc8-76a72bce9c6b", + "id": "be555225-60f8-420d-9de4-9dbe1bb21f9f", "name": "OK", "originalRequest": { "url": { @@ -1171,6 +1219,14 @@ { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "GET", @@ -1192,7 +1248,7 @@ { "listen": "test", "script": { - "id": "f7d59d02-8600-473e-925c-a13cd015c233", + "id": "54baa56b-9d5f-415a-8b13-76fecc690bab", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/suggestions/configuration/autoapproval/toggle - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1208,7 +1264,7 @@ } }, { - "id": "d7b32858-8942-4ff7-88a8-cc9e77d29e21", + "id": "cf137688-08c1-4841-a94c-9cc281fd14a5", "name": "Activate autoApprove in marketplace's account", "request": { "name": "Activate autoApprove in marketplace's account", @@ -1285,7 +1341,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "d6af0f78-2e8a-4863-a61c-70cb06c96bfe", + "id": "aff09376-15bb-4fd7-a18d-b4bc08221d83", "name": "OK", "originalRequest": { "url": { @@ -1327,6 +1383,14 @@ { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "PUT", @@ -1357,7 +1421,7 @@ { "listen": "test", "script": { - "id": "8537abf0-e072-420d-ab78-4b7cef224822", + "id": "9ba7fc33-3732-422c-b9d6-19e3a20697c7", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/suggestions/configuration/autoapproval/toggle - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1373,7 +1437,7 @@ } }, { - "id": "32027508-a151-4750-9d79-59a3b9bd96aa", + "id": "17003779-11c6-4c72-b56f-187aff23aa78", "name": "Get account's approval settings", "request": { "name": "Get account's approval settings", @@ -1435,7 +1499,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "292c8c0b-39af-45de-9c11-d37f67dd1910", + "id": "6d8d44c4-4b89-4c73-a9ad-6288fe805166", "name": "OK", "originalRequest": { "url": { @@ -1471,6 +1535,14 @@ { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "GET", @@ -1492,7 +1564,7 @@ { "listen": "test", "script": { - "id": "3df55fd2-d74f-46af-8a9d-d2eedbb90cff", + "id": "142e26b3-f77e-4419-a3d9-671fc73fccf1", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/suggestions/configuration - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1508,7 +1580,7 @@ } }, { - "id": "42ea15c9-6f02-4058-9aad-f86d9bd09342", + "id": "2db80c9a-d544-42a6-a106-406172676d6e", "name": "Save account's approval settings", "request": { "name": "Save account's approval settings", @@ -1583,7 +1655,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "efb6f27c-83e1-4e9d-bd9d-69cbf8186dbe", + "id": "0191985e-0582-4233-aec4-c84a2a97cae9", "name": "OK", "originalRequest": { "url": { @@ -1623,6 +1695,14 @@ { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "PUT", @@ -1653,7 +1733,7 @@ { "listen": "test", "script": { - "id": "3c5222c5-c13b-485f-8d58-1d7e22a794ee", + "id": "9ee2196b-034c-49a3-9d6b-2fe0c74df267", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/suggestions/configuration - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1669,7 +1749,7 @@ } }, { - "id": "4c2b1842-524c-4986-ac16-ae72c1ffaa47", + "id": "6fd1c3a5-456b-44f7-909e-e08df67fb2a8", "name": "Get account's matcher settings", "request": { "name": "Get account's matcher settings", @@ -1733,7 +1813,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "7d99c76f-2789-4f7c-8609-0cc620a218a7", + "id": "1f13d87f-01d8-413b-8841-ec19414528b3", "name": "OK", "originalRequest": { "url": { @@ -1771,6 +1851,14 @@ { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "GET", @@ -1792,7 +1880,7 @@ { "listen": "test", "script": { - "id": "78ab25cc-10a6-4931-8b0e-a65abdeb3455", + "id": "9fe4024f-c738-47da-9d63-be8dbbb3be04", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/suggestions/configuration/account/config - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1808,7 +1896,7 @@ } }, { - "id": "6efd3121-bb6a-490f-905c-556a039f05ab", + "id": "ec4dea2b-c035-4d1a-9e1e-e3d6dfaf79ae", "name": "Get seller's approval settings", "request": { "name": "Get seller's approval settings", @@ -1882,7 +1970,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "c41f1298-963d-45dd-ac0a-0244a8cf7109", + "id": "59b2fd54-4506-4727-a232-0a2a83e857f7", "name": "OK", "originalRequest": { "url": { @@ -1920,6 +2008,14 @@ { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "GET", @@ -1941,7 +2037,7 @@ { "listen": "test", "script": { - "id": "436af7e9-0870-4858-a7a1-222b82c6ad3f", + "id": "65223ac2-27b9-4c8a-8965-90436b141016", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/suggestions/configuration/seller/:sellerId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1957,7 +2053,7 @@ } }, { - "id": "3be3dcb9-dd67-4495-90e9-824b52a01850", + "id": "d4c0699d-2361-4aed-8864-df04435c0cd4", "name": "Save seller's approval settings", "request": { "name": "Save seller's approval settings", @@ -2040,7 +2136,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "969af9ac-79f0-4330-a797-dce947ba1dc4", + "id": "4ac00a39-11ca-450f-9703-28317cf4deae", "name": "OK", "originalRequest": { "url": { @@ -2078,6 +2174,14 @@ { "key": "Content-Type", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "PUT", @@ -2102,7 +2206,7 @@ { "listen": "test", "script": { - "id": "ace95717-a322-4bf0-a415-ee4255265f8c", + "id": "fad125e7-cbfd-455e-a631-d835fbccf79b", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/suggestions/configuration/seller/:sellerId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -2115,7 +2219,7 @@ } }, { - "id": "f7a46672-7200-412b-a724-bea152265f13", + "id": "5dac441d-c645-4792-8856-0685a214aab1", "name": "Activate autoApprove setting for a seller", "request": { "name": "Activate autoApprove setting for a seller", @@ -2200,7 +2304,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "a8a69766-8adb-4bcd-befa-f49a44cf29cf", + "id": "f4be8f11-9224-4fc7-81d2-1cc530db1da3", "name": "OK", "originalRequest": { "url": { @@ -2240,6 +2344,14 @@ { "key": "Content-Type", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "PUT", @@ -2264,7 +2376,7 @@ { "listen": "test", "script": { - "id": "dca81c32-ccf4-4806-a347-9cfbf86b6366", + "id": "32e86ffe-7201-4fd3-bf15-ae2ac0ac5d08", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/suggestions/configuration/autoapproval/toggle/seller/:sellerId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -2280,7 +2392,7 @@ "event": [] }, { - "id": "a61894b5-3b91-4c8a-8933-b3d81bf4ddfd", + "id": "71a871cc-95c4-49cb-91d9-5c67ae8ebb98", "name": "Match received SKUs", "description": { "content": "Match SKU suggestions received in the marketplace.", @@ -2288,7 +2400,7 @@ }, "item": [ { - "id": "ed460bf5-1967-4575-a2b4-43678f59724a", + "id": "65ba4f93-83cb-41b6-bc6f-04afa02939b6", "name": "Match received SKUs individually", "request": { "name": "Match received SKUs individually", @@ -2348,7 +2460,7 @@ "type": "text/plain" }, "type": "any", - "value": "et ex cupid", + "value": "eiusmod fugiat labore ", "key": "matchid" }, { @@ -2408,7 +2520,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "dfc73f04-6b14-4d7b-9f9a-86a26038b821", + "id": "9a5c5d5c-cc0e-4241-b2f9-bda53683be86", "name": "OK", "originalRequest": { "url": { @@ -2453,6 +2565,14 @@ { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "PUT", @@ -2483,7 +2603,7 @@ { "listen": "test", "script": { - "id": "92b6c52c-8eab-44e2-9f92-abb7514b90e8", + "id": "ca54a91a-0372-4197-b10e-860326b924c8", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/suggestions/:sellerId/:sellerskuid/versions/:version/matches/:matchid - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2499,7 +2619,7 @@ } }, { - "id": "e90c7b67-9fb8-4f15-92d4-1fb4116b5a9a", + "id": "dec0ab4e-2c84-42d1-ae4f-4991c9e251e6", "name": "Match multiple received SKUs", "request": { "name": "Match multiple received SKUs", @@ -2572,7 +2692,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "[\n [\n {\n \"itemId\": \"1234567\",\n \"versionId\": \"v.2\",\n \"matchId\": \"vtex-matcher\",\n \"matcherId\": \"vtex-matcher\",\n \"categoryId\": 12,\n \"sellerId\": \"seller123\",\n \"brandId\": 1234567,\n \"skuRef\": \"123 sku ref\",\n \"productRef\": \"123 product ref\"\n },\n {\n \"itemId\": \"1234567\",\n \"versionId\": \"v.2\",\n \"matchId\": \"vtex-matcher\",\n \"matcherId\": \"vtex-matcher\",\n \"categoryId\": 12,\n \"sellerId\": \"seller123\",\n \"brandId\": 1234567,\n \"skuRef\": \"123 sku ref\",\n \"productRef\": \"123 product ref\"\n }\n ],\n [\n {\n \"itemId\": \"1234567\",\n \"versionId\": \"v.2\",\n \"matchId\": \"vtex-matcher\",\n \"matcherId\": \"vtex-matcher\",\n \"categoryId\": 12,\n \"sellerId\": \"seller123\",\n \"brandId\": 1234567,\n \"skuRef\": \"123 sku ref\",\n \"productRef\": \"123 product ref\"\n },\n {\n \"itemId\": \"1234567\",\n \"versionId\": \"v.2\",\n \"matchId\": \"vtex-matcher\",\n \"matcherId\": \"vtex-matcher\",\n \"categoryId\": 12,\n \"sellerId\": \"seller123\",\n \"brandId\": 1234567,\n \"skuRef\": \"123 sku ref\",\n \"productRef\": \"123 product ref\"\n }\n ]\n]", + "raw": "[\n {\n \"itemId\": \"1234567\",\n \"versionId\": \"v.2\",\n \"matchId\": \"06272023010821403\",\n \"matcherId\": \"vtex-matcher\",\n \"categoryId\": 12,\n \"brandId\": 1234567,\n \"skuRef\": \"123 sku ref\",\n \"productRef\": null,\n \"sellerId\": \"seller123\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -2586,7 +2706,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "e9a1f61d-192e-452b-8542-4e81c33f7023", + "id": "4f668acc-e88a-4b31-b795-4f3277fbbdb6", "name": "OK", "originalRequest": { "url": { @@ -2628,12 +2748,20 @@ { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "PUT", "body": { "mode": "raw", - "raw": "[\n [\n {\n \"itemId\": \"1234567\",\n \"versionId\": \"v.2\",\n \"matchId\": \"vtex-matcher\",\n \"matcherId\": \"vtex-matcher\",\n \"categoryId\": 12,\n \"sellerId\": \"seller123\",\n \"brandId\": 1234567,\n \"skuRef\": \"123 sku ref\",\n \"productRef\": \"123 product ref\"\n },\n {\n \"itemId\": \"1234567\",\n \"versionId\": \"v.2\",\n \"matchId\": \"vtex-matcher\",\n \"matcherId\": \"vtex-matcher\",\n \"categoryId\": 12,\n \"sellerId\": \"seller123\",\n \"brandId\": 1234567,\n \"skuRef\": \"123 sku ref\",\n \"productRef\": \"123 product ref\"\n }\n ],\n [\n {\n \"itemId\": \"1234567\",\n \"versionId\": \"v.2\",\n \"matchId\": \"vtex-matcher\",\n \"matcherId\": \"vtex-matcher\",\n \"categoryId\": 12,\n \"sellerId\": \"seller123\",\n \"brandId\": 1234567,\n \"skuRef\": \"123 sku ref\",\n \"productRef\": \"123 product ref\"\n },\n {\n \"itemId\": \"1234567\",\n \"versionId\": \"v.2\",\n \"matchId\": \"vtex-matcher\",\n \"matcherId\": \"vtex-matcher\",\n \"categoryId\": 12,\n \"sellerId\": \"seller123\",\n \"brandId\": 1234567,\n \"skuRef\": \"123 sku ref\",\n \"productRef\": \"123 product ref\"\n }\n ]\n]", + "raw": "[\n {\n \"itemId\": \"1234567\",\n \"versionId\": \"v.2\",\n \"matchId\": \"06272023010821403\",\n \"matcherId\": \"vtex-matcher\",\n \"categoryId\": 12,\n \"brandId\": 1234567,\n \"skuRef\": \"123 sku ref\",\n \"productRef\": null,\n \"sellerId\": \"seller123\"\n }\n]", "options": { "raw": { "headerFamily": "json", @@ -2658,7 +2786,7 @@ { "listen": "test", "script": { - "id": "0f3fdba3-c0c3-425c-8ec4-b59ee8d9fc99", + "id": "f767f090-135a-477d-847b-a09e74121a90", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/suggestions/matches/action/:actionName - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2677,20 +2805,20 @@ "event": [] }, { - "id": "ba6d1d1a-d322-41bd-9b05-783a9069537c", + "id": "7c95edd0-cbca-47f2-929d-fee2b4c7b61e", "name": "Multiple product specification mapping", "description": { - "content": "", + "content": "Bulk mapping of seller product specifications to the marketplace catalog.", "type": "text/plain" }, "item": [ { - "id": "651956ff-fb96-48d6-a173-3ed9e795d71b", + "id": "37350ffb-53f9-4c86-a3c1-048897786fd4", "name": "Map seller specifications to marketplace catalog", "request": { "name": "Map seller specifications to marketplace catalog", "description": { - "content": "This endpoint allows the seller to perform a bulk mapping of product specifications to the marketplace catalog.\r\n\r\nSpecifications are additional properties that can be registered on products. To ensure this information is correctly interpreted, the marketplace must map the seller’s specifications to the corresponding fields in its own catalog.\r\n\r\nThis process ensures that products sent by the seller contain data that matches the marketplace's catalog. Sending a new item without prior mapping does not override existing values. Adding new specifications must follow the instructions in the Mapping categories, brands, and specifications for the marketplace guide.\r\nThe mapping must be done based on specifications that already exist in the marketplace's catalog.\r\n\r\n🔹 All differing specifications must be mapped, even if the only difference is the capitalization of the word.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-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| Catalog | Content | **Product and SKU Management** |\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 API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", + "content": "This endpoint allows the seller to perform a bulk mapping of product specifications to the marketplace catalog.\r\n\r\nSpecifications are additional properties that can be registered on products. To ensure this information is correctly interpreted, the marketplace must map the seller\r\n specifications to the corresponding fields in its own catalog.\r\n >⚠️ This process ensures that products sent by the seller contain data that matches the marketplace's catalog. Sending a new item without prior mapping does not override existing values. Adding new specifications must follow the instructions in the Mapping categories, brands, and specifications for the marketplace guide.\r\nThe mapping must be done based on specifications that already exist in the marketplace's catalog.\r\n\r\n All differing specifications must be mapped, even if the only difference is the capitalization of the word.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-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| Catalog | Content | **Product and SKU Management** |\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 API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "type": "text/plain" }, "url": { @@ -2754,7 +2882,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"43\": \"41\",\n \"Tamanho\": \"TAM\",\n \"Cor\": \"Color\",\n \"BROWN\": \"Marrom\",\n \"Brand\": \"Marca\"\n}", + "raw": "{\n \"43\": \"41\",\n \"Size\": \"SIZE\",\n \"Cor\": \"Color\",\n \"BROWN\": \"Brown\",\n \"Brand\": \"brand\"\n}", "options": { "raw": { "headerFamily": "json", @@ -2768,7 +2896,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "0e870000-54bd-408a-a90d-bbca55e8856e", + "id": "2c3a07f0-9f86-43d1-b54a-d9586c1d3e39", "name": "OK", "originalRequest": { "url": { @@ -2806,12 +2934,20 @@ { "key": "Content-Type", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"43\": \"41\",\n \"Tamanho\": \"TAM\",\n \"Cor\": \"Color\",\n \"BROWN\": \"Marrom\",\n \"Brand\": \"Marca\"\n}", + "raw": "{\n \"43\": \"41\",\n \"Size\": \"SIZE\",\n \"Cor\": \"Color\",\n \"BROWN\": \"Brown\",\n \"Brand\": \"brand\"\n}", "options": { "raw": { "headerFamily": "json", @@ -2830,7 +2966,7 @@ { "listen": "test", "script": { - "id": "7995655a-0fa9-41b4-9595-9787491f466f", + "id": "b7bdb878-1a35-475c-b6e9-475b09758824", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/suggestions/configuration/:sellerID/specifications - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -2846,6 +2982,26 @@ "event": [] } ], + "auth": { + "type": "apikey", + "apikey": [ + { + "type": "any", + "value": "X-VTEX-API-AppKey", + "key": "key" + }, + { + "type": "any", + "value": "{{apiKey}}", + "key": "value" + }, + { + "type": "any", + "value": "header", + "key": "in" + } + ] + }, "event": [], "variable": [ { @@ -2860,11 +3016,11 @@ } ], "info": { - "_postman_id": "42f44cfc-a3e6-4440-a890-971beea67312", + "_postman_id": "59e91f9d-ce37-4900-8eec-0a6066f20b59", "name": "Suggestions", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { - "content": "The **Marketplace API** enables marketplaces and sellers hosted on VTEX to perform their collaborative operations. \r\n\r\n>⚠️ The marketplace must [create an appKey and appToken](https://developers.vtex.com/docs/guides/getting-started-authentication) for each non-VTEX seller that will use this API.\r\n\r\n## Index\r\n\r\n### Notification\r\n\r\nEndpoints used by sellers to notify marketplaces that the price or inventory language has changed for one of their SKUs.\r\n\r\n`POST` [Notify marketplace of price update](https://developers.vtex.com/docs/api-reference/marketplace-apis#post-/notificator/-sellerId-/changenotification/-skuId-/price)\r\n\r\n`POST` [Notify marketplace of inventory update](https://developers.vtex.com/docs/api-reference/marketplace-apis#post-/notificator/-sellerId-/changenotification/-skuId-/inventory)\r\n\r\n\r\n### Suggestions\r\n\r\n#### Get Suggestions\r\n\r\nSearch and filter all suggestions using specific criteria.\r\n\r\n`GET` [Get all SKU Suggestions](https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions#get-/suggestions)\r\n\r\n`GET` [Get SKU Suggestion by ID](https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions#get-/suggestions/-sellerId-/-sellerSkuId-)\r\n\r\n\r\n#### Manage Suggestions\r\n\r\nSend or delete SKU suggestions from the seller to marketplace.\r\n\r\n`PUT` [Send SKU Suggestion](https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions#put-/suggestions/-sellerId-/-sellerSkuId-)\r\n\r\n`DELETE` [Delete SKU Suggestion](https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions#delete-/suggestions/-sellerId-/-sellerSkuId-)\r\n\r\n\r\n#### Get Versions\r\n\r\nSearch and filter all versions of suggestions, using specific criteria.\r\n\r\n`GET` [Get all versions](https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions#get-/suggestions/-sellerId-/-sellerskuid-/versions)\r\n\r\n`GET` [Get version by ID](https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions#get-/suggestions/-sellerId-/-sellerskuid-/versions/-version-)\r\n\r\n\r\n#### Match Received SKUs\r\n\r\nMatch SKU suggestions received in the marketplace.\r\n\r\n`PUT` [Match Received SKUs individually](https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions#put-/suggestions/-sellerId-/-sellerskuid-/versions/-version-/matches/-matchid-)\r\n\r\n`PUT` [Match Multiple Received SKUs](https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions#put-/suggestions/matches/action/-actionName-)\r\n\r\n\r\n#### SKU Approval Settings\r\n\r\nAllows marketplaces to configure rules for automatically and manually approving SKUs received from sellers.\r\n\r\n`GET`[Get autoApprove Status in Account Settings](https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions#get-/suggestions/configuration/autoapproval/toggle) \r\n\r\n`PUT`[Activate autoApprove in Marketplace's Account](https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions#put-/suggestions/configuration/autoapproval/toggle) \r\n\r\n`GET`[Get Account's Approval Settings](https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions#get-/suggestions/configuration)\r\n\r\n`PUT`[Save Account's Approval Settings](https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions#put-/suggestions/configuration)\r\n\r\n`GET`[Get Seller's Approval Settings](https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions#get-/suggestions/configuration/seller/-sellerId-)\r\n\r\n`PUT`[Save Seller's Approval Settings](https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions#put-/suggestions/configuration/seller/-sellerId-)\r\n\r\n`PUT`[Activate autoApprove Setting for a Seller](https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions#put-/suggestions/configuration/autoapproval/toggle/seller/-sellerId-) \r\n\r\n\r\n### Matched Offers\r\n\r\nOffers are seller products and SKUs that were sent to the marketplace, and already have their price and inventory level configured.\r\n\r\n`GET`[Get Matched Offers List](https://developers.vtex.com/docs/api-reference/marketplace-apis#get-/offer-manager/pvt/offers)\r\n\r\n`GET`[Get Matched Offer's Data by SKU ID](https://developers.vtex.com/docs/api-reference/marketplace-apis#get-/offer-manager/pvt/product/-productId-/sku/-skuId-) \r\n\r\n`GET`[Get Matched Offer's Data by Product ID](https://developers.vtex.com/docs/api-reference/marketplace-apis#get-/offer-manager/pvt/product/-productId-)\r\n", + "content": "The **Marketplace API** enables marketplaces and sellers hosted on VTEX to perform their collaborative operations. \r\n\r\n>⚠️ The marketplace must [create an appKey and appToken](https://developers.vtex.com/docs/guides/getting-started-authentication) for each non-VTEX seller that will use this API.", "type": "text/plain" } }