From 5d8d68653633658eb1d8171cda0eed5eca4ea394 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ana=20Patr=C3=ADcia=20F=2E=20Barbosa?= Date: Wed, 16 Oct 2024 12:14:11 -0300 Subject: [PATCH 1/2] Send Invoice API Fix broken link and path params of Send invoice API. --- ...- Marketplace Protocol - External Seller Marketplace.json | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/VTEX - Marketplace Protocol - External Seller Marketplace.json b/VTEX - Marketplace Protocol - External Seller Marketplace.json index 91516a87e..5e36c153a 100644 --- a/VTEX - Marketplace Protocol - External Seller Marketplace.json +++ b/VTEX - Marketplace Protocol - External Seller Marketplace.json @@ -38,6 +38,9 @@ }, { "$ref": "#/components/parameters/marketplaceServicesEndpoint" + }, + { + "$ref":"#/components/parameters/invoiceNumber" } ], "requestBody": { @@ -295,7 +298,7 @@ "marketplaceServicesEndpoint": { "name": "marketplaceServicesEndpoint", "in": "path", - "description": "This is an endpoint sent from VTEX to the external seller in the [Order placement request](https://developers.vtex.com/vtex-rest-api/reference/external-seller#order-placement).", + "description": "This is an endpoint sent from VTEX to the external seller in the [Order placement request](https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-seller-fulfillment#post-/pvt/orders).", "required": true, "style": "simple", "schema": { From 2372c7f70ad1db6372249d162bd491d725985dfe Mon Sep 17 00:00:00 2001 From: anabaarbosa <> Date: Wed, 16 Oct 2024 15:20:34 +0000 Subject: [PATCH 2/2] Update generated files by portman --- ...rotocol - External Seller Marketplace.json | 332 ++++++++---------- 1 file changed, 145 insertions(+), 187 deletions(-) diff --git a/PostmanCollections/VTEX - Marketplace Protocol - External Seller Marketplace.json b/PostmanCollections/VTEX - Marketplace Protocol - External Seller Marketplace.json index 4a0994f04..c19341926 100644 --- a/PostmanCollections/VTEX - Marketplace Protocol - External Seller Marketplace.json +++ b/PostmanCollections/VTEX - Marketplace Protocol - External Seller Marketplace.json @@ -1,10 +1,10 @@ { "_": { - "postman_id": "3f81a02b-2bf0-4f75-9003-da51b86902d8" + "postman_id": "fd8bc55f-a5c4-49ce-be70-c412c2e85c7d" }, "item": [ { - "id": "2117a3ba-1127-437e-b92e-89a1484207b9", + "id": "f8071939-ed34-4088-82ff-cb2fd3762504", "name": "External Seller", "description": { "content": "", @@ -12,12 +12,12 @@ }, "item": [ { - "id": "43743a95-7b19-4932-8cb6-d215eb414b44", + "id": "bf16c1b7-c083-44d6-a52b-eb14255c9992", "name": "Send invoice", "request": { "name": "Send invoice", "description": { - "content": "This request is sent by the external seller to the VTEX marketplace to send invoice information.\n\nThis can be necessary in a regular order or in the case of a return. The `type` field is used to indicate which of these is the case.3\r\n\r\n## Permissions\r\n\r\nCheck with your service provider to know what permissions are needed.", + "content": "This request is sent by the external seller to the VTEX marketplace to send invoice information.\n\nThis can be necessary in a regular order or in the case of a return. The `type` field is used to indicate which of these is the case.\r\n\r\n## Permissions\r\n\r\nCheck with your service provider to know what permissions are needed.", "type": "text/plain" }, "url": { @@ -45,12 +45,22 @@ { "disabled": false, "description": { - "content": "This is an endpoint sent from VTEX to the external seller in the [Order placement request](https://developers.vtex.com/vtex-rest-api/reference/external-seller#order-placement).", + "content": "(Required) This is an endpoint sent from VTEX to the external seller in the [Order placement request](https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-seller-fulfillment#post-/pvt/orders).", "type": "text/plain" }, "type": "any", - "value": "{{marketplaceServicesEndpoint}}", + "value": "marketplaceservicesendpoint.myvtex.com", "key": "marketplaceServicesEndpoint" + }, + { + "disabled": false, + "description": { + "content": "(Required) Invoice number.", + "type": "text/plain" + }, + "type": "any", + "value": "NFe-00002", + "key": "invoiceNumber" } ] }, @@ -72,6 +82,14 @@ }, "key": "Content-Type", "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], "method": "POST", @@ -80,6 +98,7 @@ "raw": "{\n \"type\": \"Output\",\n \"invoiceNumber\": \"NFe-00002\",\n \"items\": [\n {\n \"id\": \"6\",\n \"quantity\": 1,\n \"price\": 5500\n },\n {\n \"id\": \"6\",\n \"quantity\": 1,\n \"price\": 5500\n }\n ],\n \"courier\": \"courier-example\",\n \"trackingNumber\": \"12345678abc\",\n \"trackingUrl\": \"https://courier-example.com/tracking\",\n \"issuanceDate\": \"2021-05-21T10:00:00\",\n \"invoiceValue\": 6000\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -90,7 +109,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "2feca0b0-7f79-445c-aabd-fb5c505ce962", + "id": "2ed4c0ee-769a-4b59-a77d-beaa67eca8cd", "name": "OK", "originalRequest": { "url": { @@ -104,38 +123,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "(Required) Identifies the order in the marketplace.", - "type": "text/plain" - }, - "type": "any", - "value": "1138342255777-01", - "key": "marketplaceOrderId" - }, - { - "disabled": false, - "description": { - "content": "This is an endpoint sent from VTEX to the external seller in the [Order placement request](https://developers.vtex.com/vtex-rest-api/reference/external-seller#order-placement).", - "type": "text/plain" - }, - "type": "any", - "value": "{{marketplaceServicesEndpoint}}", - "key": "marketplaceServicesEndpoint" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -154,9 +144,21 @@ "key": "Content-Type", "value": "application/json" }, + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "POST", @@ -165,6 +167,7 @@ "raw": "{\n \"type\": \"Output\",\n \"invoiceNumber\": \"NFe-00002\",\n \"items\": [\n {\n \"id\": \"6\",\n \"quantity\": 1,\n \"price\": 5500\n },\n {\n \"id\": \"6\",\n \"quantity\": 1,\n \"price\": 5500\n }\n ],\n \"courier\": \"courier-example\",\n \"trackingNumber\": \"12345678abc\",\n \"trackingUrl\": \"https://courier-example.com/tracking\",\n \"issuanceDate\": \"2021-05-21T10:00:00\",\n \"invoiceValue\": 6000\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -186,7 +189,7 @@ { "listen": "test", "script": { - "id": "624e41fc-0302-46a8-9ab4-71ead6b5e641", + "id": "729c201e-21c8-45e9-a648-96a98f206593", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/pvt/orders/:marketplaceOrderId/invoice - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -202,7 +205,7 @@ } }, { - "id": "0b8986ad-7aac-4d47-89fd-1fe2ca823559", + "id": "16de9620-e464-4f8b-a53c-6a2ad5a6441c", "name": "Send tracking information", "request": { "name": "Send tracking information", @@ -226,32 +229,32 @@ { "disabled": false, "description": { - "content": "This is an endpoint sent from VTEX to the external seller in the [Order placement request](https://developers.vtex.com/vtex-rest-api/reference/external-seller#order-placement).", + "content": "(Required) Identifies the order in the marketplace.", "type": "text/plain" }, "type": "any", - "value": "{{marketplaceServicesEndpoint}}", - "key": "marketplaceServicesEndpoint" + "value": "1138342255777-01", + "key": "marketplaceOrderId" }, { "disabled": false, "description": { - "content": "(Required) Identifies the order in the marketplace.", + "content": "(Required) Invoice number.", "type": "text/plain" }, "type": "any", - "value": "1138342255777-01", - "key": "marketplaceOrderId" + "value": "NFe-00002", + "key": "invoiceNumber" }, { "disabled": false, "description": { - "content": "(Required) Invoice number.", + "content": "(Required) This is an endpoint sent from VTEX to the external seller in the [Order placement request](https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-seller-fulfillment#post-/pvt/orders).", "type": "text/plain" }, "type": "any", - "value": "NFe-00002", - "key": "invoiceNumber" + "value": "marketplaceservicesendpoint.myvtex.com", + "key": "marketplaceServicesEndpoint" } ] }, @@ -273,6 +276,14 @@ }, "key": "Content-Type", "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], "method": "POST", @@ -281,6 +292,7 @@ "raw": "{\n \"courier\": \"courier-example\",\n \"trackingNumber\": \"12345678abc\",\n \"trackingUrl\": \"https://courier-example.com/tracking\",\n \"dispatchedDate\": \"2021-06-09\"\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -291,7 +303,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "3f46805c-1982-4a04-ac12-650da87b49bc", + "id": "ce4a334b-ae0b-4d11-b44b-85ce1d9e0f9d", "name": "OK", "originalRequest": { "url": { @@ -306,48 +318,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "This is an endpoint sent from VTEX to the external seller in the [Order placement request](https://developers.vtex.com/vtex-rest-api/reference/external-seller#order-placement).", - "type": "text/plain" - }, - "type": "any", - "value": "{{marketplaceServicesEndpoint}}", - "key": "marketplaceServicesEndpoint" - }, - { - "disabled": false, - "description": { - "content": "(Required) Identifies the order in the marketplace.", - "type": "text/plain" - }, - "type": "any", - "value": "1138342255777-01", - "key": "marketplaceOrderId" - }, - { - "disabled": false, - "description": { - "content": "(Required) Invoice number.", - "type": "text/plain" - }, - "type": "any", - "value": "NFe-00002", - "key": "invoiceNumber" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -366,9 +339,21 @@ "key": "Content-Type", "value": "application/json" }, + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "POST", @@ -377,6 +362,7 @@ "raw": "{\n \"courier\": \"courier-example\",\n \"trackingNumber\": \"12345678abc\",\n \"trackingUrl\": \"https://courier-example.com/tracking\",\n \"dispatchedDate\": \"2021-06-09\"\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -398,7 +384,7 @@ { "listen": "test", "script": { - "id": "ad1b5ee0-68b9-4c80-806b-5d1bfe019078", + "id": "dbea5e32-a956-447f-b478-8ccc081fe6ac", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/pvt/orders/:marketplaceOrderId/invoice/:invoiceNumber - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -414,7 +400,7 @@ } }, { - "id": "e9852bb6-3524-4e2d-b6fd-0a21c7978a26", + "id": "80a60a27-aa07-4964-a737-9c6238f0588e", "name": "Update tracking status", "request": { "name": "Update tracking status", @@ -439,32 +425,32 @@ { "disabled": false, "description": { - "content": "This is an endpoint sent from VTEX to the external seller in the [Order placement request](https://developers.vtex.com/vtex-rest-api/reference/external-seller#order-placement).", + "content": "(Required) Identifies the order in the marketplace.", "type": "text/plain" }, "type": "any", - "value": "{{marketplaceServicesEndpoint}}", - "key": "marketplaceServicesEndpoint" + "value": "1138342255777-01", + "key": "marketplaceOrderId" }, { "disabled": false, "description": { - "content": "(Required) Identifies the order in the marketplace.", + "content": "(Required) Invoice number.", "type": "text/plain" }, "type": "any", - "value": "1138342255777-01", - "key": "marketplaceOrderId" + "value": "NFe-00002", + "key": "invoiceNumber" }, { "disabled": false, "description": { - "content": "(Required) Invoice number.", + "content": "(Required) This is an endpoint sent from VTEX to the external seller in the [Order placement request](https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-seller-fulfillment#post-/pvt/orders).", "type": "text/plain" }, "type": "any", - "value": "NFe-00002", - "key": "invoiceNumber" + "value": "marketplaceservicesendpoint.myvtex.com", + "key": "marketplaceServicesEndpoint" } ] }, @@ -486,6 +472,14 @@ }, "key": "Content-Type", "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], "method": "POST", @@ -494,6 +488,7 @@ "raw": "{\n \"isDelivered\": true,\n \"events\": [\n {\n \"city\": \"Rio de Janeiro\",\n \"state\": \"Rio de Janeiro\",\n \"description\": \"Order delivered.\",\n \"date\": \"2021-03-16\"\n },\n {\n \"city\": \"Rio de Janeiro\",\n \"state\": \"Rio de Janeiro\",\n \"description\": \"Order delivered.\",\n \"date\": \"2021-03-16\"\n }\n ]\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -504,7 +499,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "cccc0f31-148b-488b-96e3-8c0b8e705397", + "id": "5a87dfb9-e0b8-49bd-ad03-03be4249724c", "name": "OK", "originalRequest": { "url": { @@ -520,48 +515,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "This is an endpoint sent from VTEX to the external seller in the [Order placement request](https://developers.vtex.com/vtex-rest-api/reference/external-seller#order-placement).", - "type": "text/plain" - }, - "type": "any", - "value": "{{marketplaceServicesEndpoint}}", - "key": "marketplaceServicesEndpoint" - }, - { - "disabled": false, - "description": { - "content": "(Required) Identifies the order in the marketplace.", - "type": "text/plain" - }, - "type": "any", - "value": "1138342255777-01", - "key": "marketplaceOrderId" - }, - { - "disabled": false, - "description": { - "content": "(Required) Invoice number.", - "type": "text/plain" - }, - "type": "any", - "value": "NFe-00002", - "key": "invoiceNumber" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -580,9 +536,21 @@ "key": "Content-Type", "value": "application/json" }, + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "POST", @@ -591,6 +559,7 @@ "raw": "{\n \"isDelivered\": true,\n \"events\": [\n {\n \"city\": \"Rio de Janeiro\",\n \"state\": \"Rio de Janeiro\",\n \"description\": \"Order delivered.\",\n \"date\": \"2021-03-16\"\n },\n {\n \"city\": \"Rio de Janeiro\",\n \"state\": \"Rio de Janeiro\",\n \"description\": \"Order delivered.\",\n \"date\": \"2021-03-16\"\n }\n ]\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -612,7 +581,7 @@ { "listen": "test", "script": { - "id": "73e8d859-fd3e-4b03-be87-a91a384a60c3", + "id": "c74055b1-8ced-4349-ab96-2afcb18b9b96", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/pvt/orders/:marketplaceOrderId/invoice/:invoiceNumber/tracking - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -628,7 +597,7 @@ } }, { - "id": "5c6dd9ff-d83b-4d9d-a882-0a1bf376e73c", + "id": "ccf41879-5598-4655-b7e7-ef4b7a6fa8ce", "name": "Cancel order in marketplace", "request": { "name": "Cancel order in marketplace", @@ -651,22 +620,22 @@ { "disabled": false, "description": { - "content": "This is an endpoint sent from VTEX to the external seller in the [Order placement request](https://developers.vtex.com/vtex-rest-api/reference/external-seller#order-placement).", + "content": "(Required) Identifies the order in the marketplace.", "type": "text/plain" }, "type": "any", - "value": "{{marketplaceServicesEndpoint}}", - "key": "marketplaceServicesEndpoint" + "value": "1138342255777-01", + "key": "marketplaceOrderId" }, { "disabled": false, "description": { - "content": "(Required) Identifies the order in the marketplace.", + "content": "(Required) This is an endpoint sent from VTEX to the external seller in the [Order placement request](https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-seller-fulfillment#post-/pvt/orders).", "type": "text/plain" }, "type": "any", - "value": "1138342255777-01", - "key": "marketplaceOrderId" + "value": "marketplaceservicesendpoint.myvtex.com", + "key": "marketplaceServicesEndpoint" } ] }, @@ -688,6 +657,14 @@ }, "key": "Content-Type", "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], "method": "POST", @@ -696,6 +673,7 @@ "raw": "{\n \"reason\": \"Product is unavailable.\"\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -706,7 +684,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "8a79ae45-ea9c-4a18-8069-39fecbb53218", + "id": "afeb7bd9-d42b-4ee4-bae2-00002c87ab6d", "name": "OK", "originalRequest": { "url": { @@ -720,38 +698,9 @@ "{{baseUrl}}" ], "query": [], - "variable": [ - { - "disabled": false, - "description": { - "content": "This is an endpoint sent from VTEX to the external seller in the [Order placement request](https://developers.vtex.com/vtex-rest-api/reference/external-seller#order-placement).", - "type": "text/plain" - }, - "type": "any", - "value": "{{marketplaceServicesEndpoint}}", - "key": "marketplaceServicesEndpoint" - }, - { - "disabled": false, - "description": { - "content": "(Required) Identifies the order in the marketplace.", - "type": "text/plain" - }, - "type": "any", - "value": "1138342255777-01", - "key": "marketplaceOrderId" - } - ] + "variable": [] }, "header": [ - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "X-VTEX-API-AppKey", - "value": "" - }, { "disabled": false, "description": { @@ -770,9 +719,21 @@ "key": "Content-Type", "value": "application/json" }, + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: apikey", + "type": "text/plain" + }, + "key": "X-VTEX-API-AppKey", + "value": "" } ], "method": "POST", @@ -781,6 +742,7 @@ "raw": "{\n \"reason\": \"Product is unavailable.\"\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } @@ -802,7 +764,7 @@ { "listen": "test", "script": { - "id": "2af88274-0392-46c4-a8e6-b2deaad89df0", + "id": "a3c272c5-ab0e-4161-8bdd-29bec727ee36", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/pvt/orders/:marketplaceOrderId/cancel - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -844,22 +806,18 @@ "event": [], "variable": [ { - "description": { - "content": "This is an endpoint sent from VTEX to the external seller in the [Order placement request](https://developers.vtex.com/vtex-rest-api/reference/external-seller#order-placement).", - "type": "text/plain" - }, "type": "any", "value": "{marketplaceServicesEndpoint}", "key": "marketplaceServicesEndpoint" }, { - "type": "string", + "type": "any", "value": "https://{{marketplaceServicesEndpoint}}", "key": "baseUrl" } ], "info": { - "_postman_id": "3f81a02b-2bf0-4f75-9003-da51b86902d8", + "_postman_id": "fd8bc55f-a5c4-49ce-be70-c412c2e85c7d", "name": "Marketplace Protocol", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": {