diff --git a/PostmanCollections/VTEX - Marketplace APIs.json b/PostmanCollections/VTEX - Marketplace APIs.json index af1e197b0..96871e485 100644 --- a/PostmanCollections/VTEX - Marketplace APIs.json +++ b/PostmanCollections/VTEX - Marketplace APIs.json @@ -1,10 +1,10 @@ { "_": { - "postman_id": "02c948bf-5a51-457e-a32d-52936b41d997" + "postman_id": "0781959e-729a-40f3-ae0c-531f04e1e32e" }, "item": [ { - "id": "438941bb-d755-49ec-86f8-a7b5c4b167c3", + "id": "240b5e97-04ba-41b8-b56a-ebf8e3ad4b95", "name": "Sellers", "description": { "content": "", @@ -12,7 +12,7 @@ }, "item": [ { - "id": "5c889e4e-7525-4081-af53-9c330b3675fc", + "id": "d164523b-c15c-486b-b499-ad77a4f89273", "name": "Configure seller account", "request": { "name": "Configure seller account", @@ -94,7 +94,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "3f9738e2-7477-404e-bba9-330187b6d2f1", + "id": "24001b20-429f-4c06-a591-0ab7f7379cbc", "name": "OK", "originalRequest": { "url": { @@ -163,7 +163,7 @@ { "listen": "test", "script": { - "id": "53f938fa-fd37-439d-8753-ac69aa654f39", + "id": "671a0b35-b33b-451f-ba7c-d58ac0dfba8e", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/seller-register/pvt/sellers - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -176,7 +176,7 @@ } }, { - "id": "1c85447e-f53e-4a8b-93bf-c765b0bfc9f8", + "id": "c8c7d01b-6b57-41e4-8a3d-fd247d6c8a17", "name": "List sellers", "request": { "name": "List sellers", @@ -345,7 +345,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "cee10ae3-6ddb-4285-8c0d-c4c377ef9957", + "id": "c416cc17-4a53-45d9-a909-89529642ac65", "name": "OK", "originalRequest": { "url": { @@ -501,7 +501,7 @@ { "listen": "test", "script": { - "id": "373cda91-3684-4dfb-838b-ee41ee71b6cd", + "id": "032ceeb0-2c7d-47e8-80ac-dfd20c65be00", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/seller-register/pvt/sellers - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -514,7 +514,7 @@ } }, { - "id": "ba7b1996-df0e-42ab-a2ed-43687337d3db", + "id": "9c3335b3-869c-4a14-a365-4b123aa1dea5", "name": "Update seller by seller ID", "request": { "name": "Update seller by seller ID", @@ -607,7 +607,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "22dfef0a-a212-488a-a372-9faa546cd207", + "id": "4f53cab0-af47-4bab-9517-0065bc2f76f4", "name": "OK", "originalRequest": { "url": { @@ -677,7 +677,7 @@ { "listen": "test", "script": { - "id": "2dc0a6f0-03b0-404a-ace2-9f6dd2cf8435", + "id": "490ad965-e6e4-4135-aeff-a728dbc44e8f", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PATCH]::/seller-register/pvt/sellers/:sellerId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -690,7 +690,7 @@ } }, { - "id": "0dd7d9b3-1d26-4bec-8318-0c56f88eed9a", + "id": "cff97185-c2c6-4489-a5fd-34dd1125f4cc", "name": "Get seller data by ID", "request": { "name": "Get seller data by ID", @@ -780,7 +780,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "95d8c32a-160e-44a1-bc14-9df4f3a2633e", + "id": "102d70c4-3c0b-430d-9a60-27936aaa2536", "name": "OK", "originalRequest": { "url": { @@ -847,7 +847,7 @@ { "listen": "test", "script": { - "id": "cfb3ca45-9a29-4d60-9316-c5f8d99b91f8", + "id": "0d621daa-82d6-4735-aa6c-c4f331da3b43", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/seller-register/pvt/sellers/:sellerId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -863,7 +863,7 @@ "event": [] }, { - "id": "1bf887b3-78ec-4d48-8f57-68b022a3fc00", + "id": "bd58a0f1-b6db-4f84-b078-f51c291f94c5", "name": "Seller Invite", "description": { "content": "", @@ -871,7 +871,7 @@ }, "item": [ { - "id": "13a6217f-5e46-4526-835b-d0568f082c85", + "id": "23000af9-0ba7-4356-90c2-cd75d13b37eb", "name": "Invite seller lead", "request": { "name": "Invite seller lead", @@ -957,7 +957,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "90e99a4c-0b4f-43a9-b524-814947a04dfb", + "id": "51ebcade-4e4e-4a19-8ec7-1123397c152c", "name": "OK", "originalRequest": { "url": { @@ -1036,7 +1036,7 @@ { "listen": "test", "script": { - "id": "5ee819af-78ba-4dc0-883a-663427db4d7e", + "id": "344965cb-66cd-40b1-9042-74d7c5096e88", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/seller-register/pvt/seller-leads - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1052,7 +1052,7 @@ } }, { - "id": "2d4fb257-a581-4346-95f7-0a42eea64b45", + "id": "be2e7fb5-1bbe-4bbc-9c31-9fbe24c89224", "name": "List seller leads", "request": { "name": "List seller leads", @@ -1122,7 +1122,7 @@ "type": "text/plain" }, "key": "orderBy", - "value": "id labore" + "value": "Ut nulla" } ], "variable": [ @@ -1176,7 +1176,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "9274cea3-5f6c-4f5b-999d-0c0a6b248980", + "id": "51bcd888-ed76-4ddb-8397-6a7c7504238f", "name": "OK", "originalRequest": { "url": { @@ -1241,7 +1241,7 @@ "type": "text/plain" }, "key": "orderBy", - "value": "id labore" + "value": "Ut nulla" } ], "variable": [] @@ -1287,7 +1287,7 @@ { "listen": "test", "script": { - "id": "db1088f1-a0ca-45f6-9579-e1790ad62480", + "id": "0bcf93a9-0846-4625-bf33-35ed4f56f161", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/seller-register/pvt/seller-leads - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -1300,7 +1300,7 @@ } }, { - "id": "601a70de-a273-4bd7-8ea9-b84f924539dd", + "id": "1b85ff9b-5706-488d-8f09-11b7d83c2510", "name": "Accept seller lead", "request": { "name": "Accept seller lead", @@ -1388,7 +1388,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "dbb01907-e060-47e2-bbb7-d6e57ecf3f2a", + "id": "b8b3eba3-bca4-4194-b408-3a11db6f5ab4", "name": "OK", "originalRequest": { "url": { @@ -1449,7 +1449,7 @@ { "listen": "test", "script": { - "id": "c34e8156-0f39-46f3-bc19-bb7dfd9457ec", + "id": "56458d7f-7b58-4e56-ba63-f3db627dfc87", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/seller-register/pvt/seller-leads/:sellerLeadId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -1462,7 +1462,7 @@ } }, { - "id": "a8fdde14-eceb-4f4a-85fd-fe4d213a21ba", + "id": "19e4399d-fd1b-4ec1-b93e-bb624e5ccadc", "name": "Get seller lead's data by ID", "request": { "name": "Get seller lead's data by ID", @@ -1546,7 +1546,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "ea773c55-cef3-4b78-9ad0-503ed8b08bbe", + "id": "2d9a0a49-80fd-4387-9a7b-b51729d75b65", "name": "OK", "originalRequest": { "url": { @@ -1603,7 +1603,7 @@ { "listen": "test", "script": { - "id": "9f720ad6-a783-4b34-b497-63f9295cd828", + "id": "c6355479-8592-4881-ab2a-13b8402b4d13", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/seller-register/pvt/seller-leads/:sellerLeadId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -1616,7 +1616,7 @@ } }, { - "id": "5f2150bc-4beb-4507-9f70-1f8d3bee7f93", + "id": "ced032ee-dddd-486d-a158-077a41e6b5dd", "name": "Delete seller lead", "request": { "name": "Delete seller lead", @@ -1643,7 +1643,7 @@ "type": "text/plain" }, "type": "any", - "value": "id labore", + "value": "Ut nulla", "key": "sellerLeadId" }, { @@ -1696,7 +1696,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "235e96a7-4a21-4fef-ad54-31b26c56d46f", + "id": "8ef2a022-378b-43ed-9e6f-48f3325ac75c", "name": "OK", "originalRequest": { "url": { @@ -1753,7 +1753,7 @@ { "listen": "test", "script": { - "id": "0bbd7872-be9b-4ad4-b5d7-30ca38d93b2b", + "id": "716e9dab-6930-4345-b316-20b609cfe91d", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[DELETE]::/seller-register/pvt/seller-leads/:sellerLeadId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -1766,7 +1766,7 @@ } }, { - "id": "d6ed7ae6-b943-43a2-8978-ccb9c0660c69", + "id": "58269509-8b92-4d66-bbc0-d8b980b5713b", "name": "Create seller from lead", "request": { "name": "Create seller from lead", @@ -1861,7 +1861,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "d0a75c5f-c37d-42f7-8de8-8c02d50f47ec", + "id": "049f693d-9fe1-4a2f-abff-d876123ba260", "name": "OK", "originalRequest": { "url": { @@ -1929,7 +1929,7 @@ { "listen": "test", "script": { - "id": "3faa44e4-eba2-4430-8640-c17e5e7213ae", + "id": "d2c9b1e7-2b74-41df-b3a8-7fb1f41d690b", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/seller-register/pvt/seller-leads/:sellerLeadId/seller - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -1942,7 +1942,7 @@ } }, { - "id": "b69fb4e6-fab4-4727-bb20-05ad33f21bf6", + "id": "eeb1c43d-122f-42bd-9577-329c20c58b4c", "name": "Resend seller lead invite", "request": { "name": "Resend seller lead invite", @@ -2040,7 +2040,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "9798f7fb-8b6e-410d-b321-537c2bf096e3", + "id": "a3df4444-a22d-4274-9ecd-aba0cfb36307", "name": "OK", "originalRequest": { "url": { @@ -2111,7 +2111,7 @@ { "listen": "test", "script": { - "id": "3ff745f2-709f-4e8a-a68b-9f778da7b749", + "id": "7c5633cc-1ccd-4d07-b91c-1247771a98bf", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/seller-register/pvt/seller-leads/:sellerLeadId/status - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -2127,7 +2127,7 @@ "event": [] }, { - "id": "804a6053-f810-4cbe-aa77-01862846df2a", + "id": "0cdeaaeb-a9fd-47ce-b43e-23074d789eae", "name": "Seller Commissions", "description": { "content": "", @@ -2135,7 +2135,7 @@ }, "item": [ { - "id": "bc320fee-bd09-435f-9763-6fbd694cdb7c", + "id": "b5ccbd06-70fc-40ce-b315-9950139f55d2", "name": "List seller commissions by seller ID", "request": { "name": "List seller commissions by seller ID", @@ -2220,7 +2220,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "94f40af8-69dd-4092-8abb-d336580c2b46", + "id": "06609c83-8e35-4e5f-9e61-891e34b4cd99", "name": "OK", "originalRequest": { "url": { @@ -2288,7 +2288,7 @@ { "listen": "test", "script": { - "id": "c4aa1d55-d187-4b2c-994c-8c966cd9d2e2", + "id": "796c1ec6-1e90-4f00-bd31-d1e910ed2c71", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/seller-register/pvt/sellers/:sellerId/commissions - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2304,7 +2304,7 @@ } }, { - "id": "cc0b7e61-0464-411f-8f23-fcd25b0cec51", + "id": "7414b9fd-2f96-4cdc-9ca3-3730998b01dd", "name": "Upsert seller commissions in bulk", "request": { "name": "Upsert seller commissions in bulk", @@ -2398,7 +2398,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "81b82ca1-9520-405d-b5df-7eea1ad14330", + "id": "e2f2f2d1-1176-49eb-8263-a341adeeef78", "name": "No Content", "originalRequest": { "url": { @@ -2469,7 +2469,7 @@ { "listen": "test", "script": { - "id": "c6e71f8d-dead-41a2-8bc5-cd7ab647cc06", + "id": "74397182-e3b0-4dad-9b81-9f50657e050c", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/seller-register/pvt/sellers/:sellerId/commissions - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2483,7 +2483,7 @@ } }, { - "id": "b55a9edf-7d91-4180-bc50-0fd90da755a4", + "id": "3678c4a4-0946-4f5c-a58f-17c7ccab2da7", "name": "Remove seller commissions by category ID", "request": { "name": "Remove seller commissions by category ID", @@ -2575,7 +2575,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "2a0271a5-8654-46bb-a676-08a9dfb5626e", + "id": "5ed3053a-d7d5-470b-8ab6-219701d09b6e", "name": "No Content", "originalRequest": { "url": { @@ -2634,7 +2634,7 @@ { "listen": "test", "script": { - "id": "cdbf6ce6-3caa-49af-918e-46ff6f257467", + "id": "b1540bc0-da03-4afd-8552-7e40796d6b1e", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[DELETE]::/seller-register/pvt/sellers/:sellerId/commissions/:categoryId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2648,7 +2648,7 @@ } }, { - "id": "9744097a-f794-41f0-8456-37003ad5573f", + "id": "dd34f176-1bc9-43f1-af67-cc8982a2d737", "name": "Get seller commissions by category ID", "request": { "name": "Get seller commissions by category ID", @@ -2744,7 +2744,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "9b310ba3-b021-4f10-b1a1-6c07ef5edd9a", + "id": "5f6a84e0-a816-484d-a808-7643dba9d393", "name": "OK", "originalRequest": { "url": { @@ -2813,7 +2813,7 @@ { "listen": "test", "script": { - "id": "42c12338-0a64-4aa3-8a71-a847fbac3969", + "id": "6a51afdc-7457-4a90-be3f-371e669c6d1a", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/seller-register/pvt/sellers/:sellerId/commissions/:categoryId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2832,7 +2832,7 @@ "event": [] }, { - "id": "a264c30c-0973-438f-afa9-4c10ac418445", + "id": "bf4816bd-a1f5-43c7-9cd5-2d3a6879a118", "name": "Affiliates", "description": { "content": "", @@ -2840,7 +2840,7 @@ }, "item": [ { - "id": "62b92da6-03c2-4ef9-9f0b-29882401848d", + "id": "edaa7fc2-e055-44f1-ad40-7c7fc16c6e8f", "name": "List affiliates", "request": { "name": "List affiliates", @@ -2913,7 +2913,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "b88b98b9-7e5f-4c1d-8096-987c013ae54d", + "id": "9cd5bd54-06c0-42b6-acae-8228e16e5db7", "name": "OK", "originalRequest": { "url": { @@ -2971,7 +2971,7 @@ "value": "application/json" } ], - "body": "[\n {\n \"id\": \"LNG\",\n \"followUpEmail\": \"your@email.com\",\n \"useSellerPaymentMethod\": false,\n \"name\": \"Lengow\",\n \"salesChannel\": \"1\",\n \"searchURIEndpoint\": null,\n \"searchURIEndpointVersion\": \"1.x.x\",\n \"searchURIEndpointAvailableVersions\": [\n \"1.x.x\"\n ],\n \"minimumValueAccumulated\": 5000\n },\n {\n \"id\": \"CNT\",\n \"followUpEmail\": \"email@email.com\",\n \"useSellerPaymentMethod\": false,\n \"name\": \"Centauro - lojadobreno\",\n \"salesChannel\": \"2\",\n \"searchURIEndpoint\": \"http://centaurointegration.vtexinternal.com.br/api/centaurointegration/indexedstockkeepingunit?an=lojadobreno\",\n \"searchURIEndpointVersion\": \"1.x.x\",\n \"searchURIEndpointAvailableVersions\": [\n \"1.x.x\"\n ],\n \"minimumValueAccumulated\": 1000\n },\n {\n \"id\": \"MLC\",\n \"followUpEmail\": null,\n \"useSellerPaymentMethod\": false,\n \"name\": \"Mercado Livre - lojadobreno - gold_special\",\n \"salesChannel\": \"2\",\n \"searchURIEndpoint\": \"http://meliintegration.vtexinternal.com/api/meliintegration/commercialcondition?an=lojadobreno<=gold_special\",\n \"searchURIEndpointVersion\": \"1.x.x\",\n \"searchURIEndpointAvailableVersions\": [\n \"1.x.x\"\n ],\n \"minimumValueAccumulated\": 2000\n }\n]", + "body": "[\n {\n \"id\": \"LNG\",\n \"followUpEmail\": \"your@email.com\",\n \"useSellerPaymentMethod\": false,\n \"name\": \"Lengow\",\n \"salesChannel\": \"1\",\n \"searchURIEndpoint\": null,\n \"searchURIEndpointVersion\": \"1.x.x\",\n \"searchURIEndpointAvailableVersions\": [\n \"1.x.x\"\n ],\n \"minimumValueAccumulated\": 5000\n },\n {\n \"id\": \"CNT\",\n \"followUpEmail\": \"email@email.com\",\n \"useSellerPaymentMethod\": false,\n \"name\": \"Centauro - lojadobreno\",\n \"salesChannel\": \"2\",\n \"searchURIEndpoint\": \"http://centaurointegration.vtexinternal.com.br/api/centaurointegration/indexedstockkeepingunit?an=lojadobreno\",\n \"searchURIEndpointVersion\": \"1.x.x\",\n \"searchURIEndpointAvailableVersions\": [\n \"1.x.x\"\n ],\n \"minimumValueAccumulated\": 1000\n },\n {\n \"id\": \"MLC\",\n \"followUpEmail\": \"null\",\n \"useSellerPaymentMethod\": false,\n \"name\": \"Mercado Livre - lojadobreno - gold_special\",\n \"salesChannel\": \"2\",\n \"searchURIEndpoint\": \"http://meliintegration.vtexinternal.com/api/meliintegration/commercialcondition?an=lojadobreno<=gold_special\",\n \"searchURIEndpointVersion\": \"1.x.x\",\n \"searchURIEndpointAvailableVersions\": [\n \"1.x.x\"\n ],\n \"minimumValueAccumulated\": 2000\n }\n]", "cookie": [] } ], @@ -2979,13 +2979,13 @@ { "listen": "test", "script": { - "id": "1b4358b1-c526-48bb-80e5-9c6e35d922e1", + "id": "13c8e496-25d8-4a11-9691-d34554ae5f6f", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/fulfillment/pvt/affiliates - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[GET]::/fulfillment/pvt/affiliates - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[GET]::/fulfillment/pvt/affiliates - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"type\":\"array\",\"items\":{\"description\":\"[Affiliate](https://help.vtex.com/en/tutorial/configuring-affiliates--tutorials_187) information.\",\"type\":\"object\",\"properties\":{\"id\":{\"description\":\"Three-letter identifier defined during the affiliate configuration creation. Vowels are not allowed.\",\"type\":\"string\"},\"followUpEmail\":{\"description\":\"Email address in which the user will receive notifications about the integration.\",\"type\":\"string\"},\"useSellerPaymentMethod\":{\"description\":\"Indicates if the store uses the payment split, seller payment method, (`true`) or not (`false`). Recommended for use only in VTEX-with-VTEX integrations because of compatibility of payment methods.\",\"type\":\"boolean\"},\"name\":{\"description\":\"Affiliate name.\",\"type\":\"string\"},\"salesChannel\":{\"description\":\"Number of the sales channel that will define the catalog assortment, prices, and the shipping strategy of items sent to the marketplace.\",\"type\":\"string\"},\"searchURIEndpoint\":{\"description\":\"URL of the application that will receive products, price, and inventory notifications, among others. The Search Endpoint should be filled with the value: `http://productnotification.vtexcommerce.com.br/api/notification/{NameOfMarketplace}/{SellerID}`. For [external marketplaces](https://help.vtex.com/en/tutorial/marketplace-strategies-at-vtex--tutorials_402#integrating-with-an-external-marketplace), fill in the value: `https://{endpointDoAfiliado}/api/notification/`. Learn more in our article [How to confugure the affiliate endpoint](https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update#how-to-configure-the-affiliate-endpoint).\",\"type\":[\"string\",\"null\"]},\"searchURIEndpointVersion\":{\"description\":\"Search URI endpoint version. The default option is the only one available.\",\"type\":\"string\",\"default\":\"1.x.x.\"},\"searchURIEndpointAvailableVersions\":{\"description\":\"Search URI endpoint available versions.\",\"type\":\"array\",\"items\":{\"description\":\"Search URI endpoint available version. The default option is the only one available.\",\"type\":\"string\",\"default\":\"1.x.x.\"}},\"minimumValueAccumulated\":{\"description\":\"Minimum value accumulated in the cart to checkout the order.\",\"type\":[\"integer\",\"null\"]}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/fulfillment/pvt/affiliates - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"description\":\"Array containing all configured affiliates in the store.\",\"type\":\"array\",\"items\":{\"description\":\"[Affiliate](https://help.vtex.com/en/tutorial/configuring-affiliates--tutorials_187) information.\",\"type\":\"object\",\"properties\":{\"id\":{\"description\":\"Three-letter identifier defined during the affiliate configuration creation. Vowels are not allowed.\",\"type\":\"string\"},\"followUpEmail\":{\"description\":\"Email address in which the user will receive notifications about the integration.\",\"type\":\"string\"},\"useSellerPaymentMethod\":{\"description\":\"Indicates if the store uses the payment split, seller payment method, (`true`) or not (`false`). Recommended for use only in VTEX-with-VTEX integrations because of compatibility of payment methods.\",\"type\":\"boolean\"},\"name\":{\"description\":\"Affiliate name.\",\"type\":\"string\"},\"salesChannel\":{\"description\":\"Number of the sales channel that will define the catalog assortment, prices, and the shipping strategy of items sent to the marketplace.\",\"type\":\"string\"},\"searchURIEndpoint\":{\"description\":\"URL of the application that will receive products, price, and inventory notifications, among others. The Search Endpoint should be filled with the value: `http://productnotification.vtexcommerce.com.br/api/notification/{NameOfMarketplace}/{SellerID}`. For [external marketplaces](https://help.vtex.com/en/tutorial/marketplace-strategies-at-vtex--tutorials_402#integrating-with-an-external-marketplace), fill in the value: `https://{endpointDoAfiliado}/api/notification/`. Learn more in our article [How to confugure the affiliate endpoint](https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update#how-to-configure-the-affiliate-endpoint).\",\"type\":[\"string\",\"null\"]},\"searchURIEndpointVersion\":{\"description\":\"Search URI endpoint version. The default option is the only one available.\",\"type\":\"string\",\"default\":\"1.x.x.\"},\"searchURIEndpointAvailableVersions\":{\"description\":\"Search URI endpoint available versions.\",\"type\":\"array\",\"items\":{\"description\":\"Search URI endpoint available version. The default option is the only one available.\",\"type\":\"string\",\"default\":\"1.x.x.\"}},\"minimumValueAccumulated\":{\"description\":\"Minimum value accumulated in the cart to checkout the order.\",\"type\":[\"integer\",\"null\"]}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/fulfillment/pvt/affiliates - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -2995,7 +2995,7 @@ } }, { - "id": "3d23f811-053b-46c7-bb4d-01b531770aaa", + "id": "e6638d46-4c0b-4bc5-bad4-91f041f3bb83", "name": "Get affiliate by ID", "request": { "name": "Get affiliate by ID", @@ -3079,7 +3079,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "a0d4e134-073d-46f0-88f2-d2b1f89a980c", + "id": "14e96977-8d10-41a1-963b-b344bf5de09c", "name": "OK", "originalRequest": { "url": { @@ -3146,13 +3146,13 @@ { "listen": "test", "script": { - "id": "ef843f83-89e3-4cfb-974f-f5d0e8a2c7e6", + "id": "23c97c58-e95c-4f2d-84a6-1e99c7a9b1cd", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/fulfillment/pvt/affiliates/:affiliateId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", "// Validate if response header has matching content-type\npm.test(\"[GET]::/fulfillment/pvt/affiliates/:affiliateId - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n", "// Validate if response has JSON Body \npm.test(\"[GET]::/fulfillment/pvt/affiliates/:affiliateId - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n", - "// Response Validation\nconst schema = {\"type\":\"object\",\"properties\":{\"id\":{\"description\":\"Three-letter identifier defined during the affiliate configuration creation. Vowels are not allowed.\",\"type\":\"string\"},\"followUpEmail\":{\"description\":\"Email address in which the user will receive notifications about the integration.\",\"type\":\"string\"},\"useSellerPaymentMethod\":{\"description\":\"Indicates if the store uses the payment split, seller payment method, (`true`) or not (`false`). Recommended for use only in VTEX-with-VTEX integrations because of compatibility of payment methods.\",\"type\":\"boolean\"},\"name\":{\"description\":\"Affiliate name.\",\"type\":\"string\"},\"salesChannel\":{\"description\":\"Number of the sales channel that will define the catalog assortment, prices, and the shipping strategy of items sent to the marketplace.\",\"type\":\"string\"},\"searchURIEndpoint\":{\"description\":\"URL of the application that will receive products, price, and inventory notifications, among others. The Search Endpoint should be filled with the value: `http://productnotification.vtexcommerce.com.br/api/notification/{NameOfMarketplace}/{SellerID}`. For [external marketplaces](https://help.vtex.com/en/tutorial/marketplace-strategies-at-vtex--tutorials_402#integrating-with-an-external-marketplace), fill in the value: `https://{endpointDoAfiliado}/api/notification/`. Learn more in our article [How to confugure the affiliate endpoint](https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update#how-to-configure-the-affiliate-endpoint).\",\"type\":[\"string\",\"null\"]},\"searchURIEndpointVersion\":{\"description\":\"Search URI endpoint version. The default option is the only one available.\",\"type\":\"string\",\"default\":\"1.x.x.\"},\"searchURIEndpointAvailableVersions\":{\"description\":\"Search URI endpoint available versions.\",\"type\":\"array\",\"items\":{\"description\":\"Search URI endpoint available version. The default option is the only one available.\",\"type\":\"string\",\"default\":\"1.x.x.\"}},\"minimumValueAccumulated\":{\"description\":\"Minimum value accumulated in the cart to checkout the order.\",\"type\":[\"integer\",\"null\"]}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/fulfillment/pvt/affiliates/:affiliateId - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" + "// Response Validation\nconst schema = {\"description\":\"Object containing detailed information about a specific affiliate.\",\"type\":\"object\",\"properties\":{\"id\":{\"description\":\"Three-letter identifier defined during the affiliate configuration creation. Vowels are not allowed.\",\"type\":\"string\"},\"followUpEmail\":{\"description\":\"Email address in which the user will receive notifications about the integration.\",\"type\":\"string\"},\"useSellerPaymentMethod\":{\"description\":\"Indicates if the store uses the payment split, seller payment method, (`true`) or not (`false`). Recommended for use only in VTEX-with-VTEX integrations because of compatibility of payment methods.\",\"type\":\"boolean\"},\"name\":{\"description\":\"Affiliate name.\",\"type\":\"string\"},\"salesChannel\":{\"description\":\"Number of the sales channel that will define the catalog assortment, prices, and the shipping strategy of items sent to the marketplace.\",\"type\":\"string\"},\"searchURIEndpoint\":{\"description\":\"URL of the application that will receive products, price, and inventory notifications, among others. The Search Endpoint should be filled with the value: `http://productnotification.vtexcommerce.com.br/api/notification/{NameOfMarketplace}/{SellerID}`. For [external marketplaces](https://help.vtex.com/en/tutorial/marketplace-strategies-at-vtex--tutorials_402#integrating-with-an-external-marketplace), fill in the value: `https://{endpointDoAfiliado}/api/notification/`. Learn more in our article [How to confugure the affiliate endpoint](https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update#how-to-configure-the-affiliate-endpoint).\",\"type\":[\"string\",\"null\"]},\"searchURIEndpointVersion\":{\"description\":\"Search URI endpoint version. The default option is the only one available.\",\"type\":\"string\",\"default\":\"1.x.x.\"},\"searchURIEndpointAvailableVersions\":{\"description\":\"Search URI endpoint available versions.\",\"type\":\"array\",\"items\":{\"description\":\"Search URI endpoint available version. The default option is the only one available.\",\"type\":\"string\",\"default\":\"1.x.x.\"}},\"minimumValueAccumulated\":{\"description\":\"Minimum value accumulated in the cart to checkout the order.\",\"type\":[\"integer\",\"null\"]}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/fulfillment/pvt/affiliates/:affiliateId - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n" ] } } @@ -3162,7 +3162,7 @@ } }, { - "id": "b0230f83-6d0f-411e-b737-8e35fb283791", + "id": "5a715b62-1b93-411d-9683-cb4feea03721", "name": "Update affiliate by ID", "request": { "name": "Update affiliate by ID", @@ -3255,7 +3255,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "b333d82f-e495-4567-93b4-5a1ef9b9d40e", + "id": "1bfa69dc-a879-46e6-876b-4ff541336d4f", "name": "No Content", "originalRequest": { "url": { @@ -3325,7 +3325,7 @@ { "listen": "test", "script": { - "id": "2cf79671-28f9-4386-b775-1b20c759bd85", + "id": "9389ec49-85fd-4f1f-8465-1ed6f2b77f06", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/fulfillment/pvt/affiliates/:affiliateId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -3339,7 +3339,7 @@ } }, { - "id": "665b4757-935c-4ec6-bd0d-ac2d47f20906", + "id": "497437eb-9fa3-45ea-9ab8-44dbde79c771", "name": "Delete affiliate by ID", "request": { "name": "Delete affiliate by ID", @@ -3419,7 +3419,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "882b5edd-0ab9-4e84-8d5a-9300b60b5c43", + "id": "f3795342-8de2-4f8c-9472-01f9c3444d7e", "name": "No Content", "originalRequest": { "url": { @@ -3476,7 +3476,7 @@ { "listen": "test", "script": { - "id": "b52eb032-34de-4843-8f2b-f418020fa388", + "id": "142ddcbe-8ff2-4263-b12a-1d91bab55d64", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[DELETE]::/fulfillment/pvt/affiliates/:affiliateId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -3493,7 +3493,7 @@ "event": [] }, { - "id": "6715493c-af1b-417a-9fe4-3eb406064810", + "id": "e274ea87-75a9-4fe5-a77d-aa7a1f504064", "name": "Notification", "description": { "content": "", @@ -3501,7 +3501,7 @@ }, "item": [ { - "id": "18b5f648-0f8c-4845-9df3-afe57e9bf187", + "id": "1ea27230-1ee4-4be0-b113-6a5003a37ab5", "name": "Notify marketplace of price update", "request": { "name": "Notify marketplace of price update", @@ -3592,7 +3592,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "6ece1704-0d77-42bc-971e-cd89bb9da3e6", + "id": "9ebf610d-a19b-4645-b2bb-c74abc7d68ba", "name": "Accepted", "originalRequest": { "url": { @@ -3650,7 +3650,7 @@ { "listen": "test", "script": { - "id": "9d7531ea-fa89-44fa-a8a9-4ef15f9896d4", + "id": "2035ebf5-ab53-4f1b-9718-1681e222e174", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/notificator/:sellerId/changenotification/:skuId/price - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -3663,7 +3663,7 @@ } }, { - "id": "edcdfbd4-9fa5-4426-90f2-6638760349d9", + "id": "a7c467e8-e947-44e3-ae9c-0b1197f02b97", "name": "Notify marketplace of inventory update", "request": { "name": "Notify marketplace of inventory update", @@ -3754,7 +3754,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "2d9cfd4d-3a59-4952-afa5-b909987ebd86", + "id": "6e551482-2639-41f6-bc58-7c43ae02ad1e", "name": "Accepted", "originalRequest": { "url": { @@ -3812,7 +3812,7 @@ { "listen": "test", "script": { - "id": "8309a933-1a15-4489-8ed4-a1888de9d55b", + "id": "966ecc09-489e-499d-9cd4-6a70a1435cce", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/notificator/:sellerId/changenotification/:skuId/inventory - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -3828,7 +3828,7 @@ "event": [] }, { - "id": "939d16b6-8da3-4c25-9cdb-efd3becde34f", + "id": "e49509c1-d09e-44cf-ab3d-869043489066", "name": "Matched Offers", "description": { "content": "", @@ -3836,7 +3836,7 @@ }, "item": [ { - "id": "31a54261-609c-442a-8122-c7577f42ed60", + "id": "417b0a85-ef68-4e17-846e-77884d4240f9", "name": "Get matched offers list", "request": { "name": "Get matched offers list", @@ -3946,7 +3946,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "4602344c-0bc1-4ae0-a483-ea4b97602512", + "id": "e694bf82-5c2d-49f1-9035-70a7173ec7b5", "name": "OK", "originalRequest": { "url": { @@ -4049,7 +4049,7 @@ { "listen": "test", "script": { - "id": "40e14a1a-1ada-4889-85d3-c7ca881e3d52", + "id": "b3e1c732-81a5-4870-a492-fa971e5c7a53", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/offer-manager/pvt/offers - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -4065,7 +4065,7 @@ } }, { - "id": "00ab4c94-5c98-41e7-9f96-916ea0f88e6a", + "id": "2efc1d39-b913-41d6-a286-f5d4953d5661", "name": "Get matched offers' data by SKU ID", "request": { "name": "Get matched offers' data by SKU ID", @@ -4161,7 +4161,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "8db946c1-c828-4ecb-a3e6-018fc36a7065", + "id": "828df2e0-b1e7-4da6-b1d5-a98722352fa9", "name": "OK", "originalRequest": { "url": { @@ -4230,7 +4230,7 @@ { "listen": "test", "script": { - "id": "d8ed3b2a-e1b9-432f-b3f3-6bf80267bdaf", + "id": "446bd179-77d0-4c43-90a4-480925087934", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/offer-manager/pvt/product/:productId/sku/:skuId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -4246,7 +4246,7 @@ } }, { - "id": "6ae5b595-3262-4fc8-ab76-1dbd7b1ed308", + "id": "3dfd5a79-d811-495a-b6de-1573f263c552", "name": "Get matched offers' data by product ID", "request": { "name": "Get matched offers' data by product ID", @@ -4330,7 +4330,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "d52018fb-6f80-43cd-813b-0b7a43b2f081", + "id": "eedf3687-81ee-4de3-b004-1722cad9e3f3", "name": "OK", "originalRequest": { "url": { @@ -4397,7 +4397,7 @@ { "listen": "test", "script": { - "id": "1fe008b9-164b-41ac-a1a8-3781cabb5a29", + "id": "2c81985f-3618-43c9-af97-1ab150c6f938", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/offer-manager/pvt/product/:productId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -4416,7 +4416,7 @@ "event": [] }, { - "id": "0c9de856-a5bc-4f6b-b95a-292a1c26b3c4", + "id": "ffab6f60-761f-442c-a3b8-bab6a7ea1e54", "name": "Sales Channel Mapping", "description": { "content": "", @@ -4424,7 +4424,7 @@ }, "item": [ { - "id": "b7974175-29eb-4b9d-b12d-17be6ef2ddc6", + "id": "729ea7ed-6a11-4f5f-9cfb-41f5a7f9740f", "name": "Upsert sales channel mapping", "request": { "name": "Upsert sales channel mapping", @@ -4533,7 +4533,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "9a640f65-db5a-407a-b7c1-7f5043ee249e", + "id": "8aa82281-b2fa-4228-b850-296291ea2c92", "name": "OK", "originalRequest": { "url": { @@ -4625,7 +4625,7 @@ { "listen": "test", "script": { - "id": "3f10bfd4-33dc-4cac-8a17-24d016f66018", + "id": "18637fa6-7a35-4153-8983-5aaafa091851", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/seller-register/pvt/sellers/:sellerId/sales-channel/mapping - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -4641,7 +4641,7 @@ } }, { - "id": "bb5d6f4f-d0bc-4f33-bc32-2489c48f3576", + "id": "f8e3d57a-b9a7-46b8-b303-ad1cafdb0101", "name": "Get sales channel mapping data", "request": { "name": "Get sales channel mapping data", @@ -4737,7 +4737,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "2710ba55-ff19-466a-83db-f55239793008", + "id": "fcd99e5a-c099-4afd-9634-d7c18e498f3e", "name": "OK", "originalRequest": { "url": { @@ -4816,7 +4816,7 @@ { "listen": "test", "script": { - "id": "ba88374b-1be0-47da-a00f-46c870278f64", + "id": "6a6dec67-6636-4d1e-85cb-4df0f63f0411", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/seller-register/pvt/sellers/:sellerId/sales-channel/mapping - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -4874,11 +4874,11 @@ } ], "info": { - "_postman_id": "02c948bf-5a51-457e-a32d-52936b41d997", + "_postman_id": "0781959e-729a-40f3-ae0c-531f04e1e32e", "name": "Marketplace API", "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\r\n\r\n### Affiliates\r\n\r\nEvery marketplace must correspond to a unique affiliate code for the seller.\r\n\r\n`GET`[List affiliates](https://developers.vtex.com/docs/api-reference/marketplace-apis#get-/fulfillment/pvt/affiliates)\r\n\r\n`GET`[Get affiliate by ID](https://developers.vtex.com/docs/api-reference/marketplace-apis#get-/fulfillment/pvt/affiliates/-affiliateId-) \r\n\r\n`PUT`[Update affiliate by ID](https://developers.vtex.com/docs/api-reference/marketplace-apis#put-/fulfillment/pvt/affiliates/-affiliateId-)\r\n\r\n`DELETE`[Delete affiliate by ID](https://developers.vtex.com/docs/api-reference/marketplace-apis#delete-/fulfillment/pvt/affiliates/-affiliateId-)", + "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" } } diff --git a/VTEX - Marketplace APIs.json b/VTEX - Marketplace APIs.json index b2c6d307a..56d008ff8 100644 --- a/VTEX - Marketplace APIs.json +++ b/VTEX - Marketplace APIs.json @@ -2,7 +2,7 @@ "openapi": "3.0.0", "info": { "title": "Marketplace API", - "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\r\n\r\n### Affiliates\r\n\r\nEvery marketplace must correspond to a unique affiliate code for the seller.\r\n\r\n`GET`[List affiliates](https://developers.vtex.com/docs/api-reference/marketplace-apis#get-/fulfillment/pvt/affiliates)\r\n\r\n`GET`[Get affiliate by ID](https://developers.vtex.com/docs/api-reference/marketplace-apis#get-/fulfillment/pvt/affiliates/-affiliateId-) \r\n\r\n`PUT`[Update affiliate by ID](https://developers.vtex.com/docs/api-reference/marketplace-apis#put-/fulfillment/pvt/affiliates/-affiliateId-)\r\n\r\n`DELETE`[Delete affiliate by ID](https://developers.vtex.com/docs/api-reference/marketplace-apis#delete-/fulfillment/pvt/affiliates/-affiliateId-)", + "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.", "version": "1.0" }, "servers": [