From fcdeb9fd9274ba5535ed57fef601a971e3134f36 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Isabella=20Veloso=20S=C3=A1?= Date: Tue, 25 Jul 2023 18:13:24 -0300 Subject: [PATCH 1/4] Update VTEX - Orders API.json Improved description. --- VTEX - Orders API.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/VTEX - Orders API.json b/VTEX - Orders API.json index 0152cc5e0..6b1a13250 100644 --- a/VTEX - Orders API.json +++ b/VTEX - Orders API.json @@ -3243,7 +3243,7 @@ "put": { "tags": ["Tracking"], "summary": "Update order tracking status", - "description": "This endpoint sends a tracking event to an order that already has a tracking number registered to its invoice.\n\r\n\rThis request is not meant to send tracking number and URL to the invoice. If you wish to send tracking number and URL to an order, use the [Update order's partial invoice API request](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/oms/pvt/orders/-orderId-/invoice/-invoiceNumber-). You can also learn more about [Partial invoice](https://help.vtex.com/en/tracks/partial-invoices--2xkTisx4SXOWXQel8Jg8sa/q9GPspTb9cHlMeAZfdEUe) scenarios. \n\r\n\r> The `Notify invoice` resource is needed to use this API request. This is included in `OMS - Full access` and `IntegrationProfile - Fulfillment Oms`, among other default roles available in the Admin. Learn more about the [License manager roles and resources](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc).", + "description": "This endpoint sends a tracking event to an order that already has a tracking number registered to its invoice.\n\r\n\rThis request is not meant to send tracking number and URL to the invoice. If you wish to send tracking number and URL to an order, use the [Update order's partial invoice API request](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/oms/pvt/orders/-orderId-/invoice/-invoiceNumber-). For more information, see [Partial invoice](https://help.vtex.com/en/tracks/partial-invoices--2xkTisx4SXOWXQel8Jg8sa/q9GPspTb9cHlMeAZfdEUe) scenarios.\n\r\n\rThis endpoint applies to orders with any shipping type, whether delivery or [pickup](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).\n\r\n\r> The `Notify invoice` resource is needed to use this API request. This is included in `OMS - Full access` and `IntegrationProfile - Fulfillment Oms`, among other default roles available in the Admin. Learn more about the [License manager roles and resources](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc).", "operationId": "UpdateTrackingStatus", "parameters": [ { From bd1132bbe31e93c421917501010290bd6950ef7c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Isabella=20Veloso=20S=C3=A1?= Date: Tue, 25 Jul 2023 18:14:51 -0300 Subject: [PATCH 2/4] Update VTEX - Orders API.json Added description. --- VTEX - Orders API.json | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/VTEX - Orders API.json b/VTEX - Orders API.json index 6b1a13250..fb7ff2109 100644 --- a/VTEX - Orders API.json +++ b/VTEX - Orders API.json @@ -11259,7 +11259,9 @@ "type": "object", "properties": { "isDelivered": { - "type": "boolean" + "type": "boolean", + "description": "When set as `true`, it means the order got to its final shipping address, whether by delivery or pickup shipping type. When set as `false`, the order is still in transit to its shipping address.", + "example": false }, "deliveredDate": { "type": "string", From 4ad96ce80865fef6cf3f48a4171cfa87b602ef3f Mon Sep 17 00:00:00 2001 From: Isabella-Veloso <> Date: Tue, 25 Jul 2023 21:18:11 +0000 Subject: [PATCH 3/4] Update generated files by portman --- PostmanCollections/VTEX - Orders API.json | 240 +++++++++++----------- 1 file changed, 120 insertions(+), 120 deletions(-) diff --git a/PostmanCollections/VTEX - Orders API.json b/PostmanCollections/VTEX - Orders API.json index 7ba84c626..724b774a3 100644 --- a/PostmanCollections/VTEX - Orders API.json +++ b/PostmanCollections/VTEX - Orders API.json @@ -1,10 +1,10 @@ { "_": { - "postman_id": "534d52d0-5b37-4d8e-86b2-f46977007daf" + "postman_id": "c458c881-915a-445a-83c2-ba055319483d" }, "item": [ { - "id": "b21b9711-06e0-48ea-b061-14b1e21ebbb6", + "id": "ae0e4b59-7022-4ab4-a9f6-47694fd3a046", "name": "Orders", "description": { "content": "", @@ -12,7 +12,7 @@ }, "item": [ { - "id": "2187757b-4459-4763-b0c0-b33b8f97efe4", + "id": "fd00614b-e664-425a-affc-58dd78a14f17", "name": "Get order", "request": { "name": "Get order", @@ -76,7 +76,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "cd105f27-edcf-47a3-9eba-b0a2ac489e84", + "id": "02b8f54b-9d06-4ce0-9436-37395ae320f9", "name": "OK", "originalRequest": { "url": { @@ -173,7 +173,7 @@ { "listen": "test", "script": { - "id": "ae04a0cf-cd6d-4754-b5ca-da6813ce085e", + "id": "897db8e8-1c93-4a87-b500-3adba2f653c9", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/oms/pvt/orders/:orderId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -189,7 +189,7 @@ } }, { - "id": "68a8dd52-3b7c-4b61-a16a-e55ac2b9878e", + "id": "b5879884-4aef-4e66-a531-ca3f817d8ee4", "name": "List orders", "request": { "name": "List orders", @@ -459,7 +459,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "90938627-b413-4ce6-9a68-473bab2fe849", + "id": "45521967-5fd7-4115-9586-f5ccc04cb287", "name": "OK", "originalRequest": { "url": { @@ -750,7 +750,7 @@ { "listen": "test", "script": { - "id": "b99ba605-d3c5-41f1-967c-dd5d1e1fc581", + "id": "4c4e0bdf-f64b-4029-beab-29f03c12d341", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/oms/pvt/orders - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -778,7 +778,7 @@ } }, { - "id": "aa840b4e-30da-4e8e-b318-128bf4791fd4", + "id": "639f0179-fbab-4454-a6f5-b608b07658ee", "name": "Start handling order", "request": { "name": "Start handling order", @@ -843,7 +843,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "4c70ced5-7b46-466e-b55a-243871777fa6", + "id": "206bef6e-064b-4ea9-b7e3-518189712d50", "name": "[No content](https://httpstatuses.com/204)", "originalRequest": { "url": { @@ -936,7 +936,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "f018ad2c-a154-4f2d-8527-6b30987c6f0c", + "id": "4976cdf2-ff5a-4fd8-8f51-ca2dcf44bd1d", "name": "[Unauthorized](https://httpstatuses.com/401)", "originalRequest": { "url": { @@ -1033,7 +1033,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "9684b75d-5a7e-4e66-8608-921b863aa240", + "id": "746769d0-30bf-490c-9e45-3b6633b38fde", "name": "[Forbidden](https://httpstatuses.com/403)", "originalRequest": { "url": { @@ -1126,7 +1126,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "961abc04-0eef-421d-9fca-9f2f5492f463", + "id": "8e53e6f4-3ff6-4e48-99a9-c461f044768c", "name": "[Not found](https://httpstatuses.com/404)", "originalRequest": { "url": { @@ -1219,7 +1219,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "ca371420-7ff9-4f7c-a3e6-180f5582c0ac", + "id": "ff026a89-21af-476c-af2f-889028bcce5f", "name": "[Conflict](https://httpstatuses.com/409)", "originalRequest": { "url": { @@ -1316,7 +1316,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "452d5b4b-b835-4779-b741-d1ed5d561ef5", + "id": "fcef8c3c-4d77-4f06-bc82-314d3418c9da", "name": "[Too many requests](https://httpstatuses.com/429)", "originalRequest": { "url": { @@ -1410,7 +1410,7 @@ { "listen": "test", "script": { - "id": "fde51e45-2404-4f6a-901d-4c39e7cb92c6", + "id": "3d0cad39-f05f-4320-96f5-7db31956c49b", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/oms/pvt/orders/:orderId/start-handling - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1424,7 +1424,7 @@ } }, { - "id": "2d28bceb-b6f0-45a3-93fa-07b35d9eea51", + "id": "6435a20e-89fb-4e8e-a171-533bda663304", "name": "Cancel order", "request": { "name": "Cancel order", @@ -1502,7 +1502,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "d99efcdd-c43c-443d-9305-3dab53664ea6", + "id": "43828f59-270d-460e-950e-2264a52dfff4", "name": "OK", "originalRequest": { "url": { @@ -1607,7 +1607,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "184d27c0-9bef-45a7-8dd6-80d775848524", + "id": "c4f8f53f-2aea-4085-a9f9-d1b9b3d9f9d2", "name": "The credentials are not enabled to access the service.", "originalRequest": { "url": { @@ -1708,7 +1708,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "eab6d7ca-4919-4706-b6ce-67fe6c202249", + "id": "231ae309-9d45-4f64-ae8f-1e801493e5a8", "name": "Value not found.", "originalRequest": { "url": { @@ -1809,7 +1809,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "1c724f32-40b4-4f14-9df9-42a353d48282", + "id": "d9fe2397-6909-41a6-aecd-32042bed4907", "name": "Too many requests.", "originalRequest": { "url": { @@ -1911,7 +1911,7 @@ { "listen": "test", "script": { - "id": "8f5467e6-7aa7-4879-9537-25dfee474bfc", + "id": "e5ba54ea-68c5-4bbe-b213-06ffa6a51eaf", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/oms/pvt/orders/:orderId/cancel - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -1927,7 +1927,7 @@ } }, { - "id": "dd01ef7a-b9f5-4b7d-9f74-979233a80b9d", + "id": "d00ae4d2-6b0e-43f1-ba9e-08814b578674", "name": "Register change on order", "request": { "name": "Register change on order", @@ -2005,7 +2005,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "b1d84e66-e483-44a3-894a-6697bd7d0fa9", + "id": "37e1fd30-16b6-4236-ba4f-13c1c24fdba8", "name": "OK", "originalRequest": { "url": { @@ -2111,7 +2111,7 @@ { "listen": "test", "script": { - "id": "704169cc-29e7-48a2-b65b-ba3585046bcf", + "id": "4421ade0-ff3a-4cb1-8efd-af172585f12d", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/oms/pvt/orders/:orderId/changes - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2127,7 +2127,7 @@ } }, { - "id": "df84ccd6-7687-4da0-8353-d3fd5c53d4c4", + "id": "da7baabc-030a-4b55-84fb-215058e9386d", "name": "Add log in orders", "request": { "name": "Add log in orders", @@ -2201,7 +2201,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "de0910f6-8580-4227-a5ca-3c95f27882f4", + "id": "c77d9c60-0b4a-45b2-b04f-3ad21a75e8ca", "name": "OK", "originalRequest": { "url": { @@ -2303,7 +2303,7 @@ { "listen": "test", "script": { - "id": "394d2be2-b1b8-40e9-8908-f02a239171cc", + "id": "fd03d38c-3050-47a9-97ff-336493755efb", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/oms/pvt/orders/:orderId/interactions - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -2319,7 +2319,7 @@ "event": [] }, { - "id": "e447cf9e-4bc2-4d0a-906f-fc23e2d6eea6", + "id": "d79622a5-e156-4642-bfd3-a16acaf5e8f8", "name": "Invoice", "description": { "content": "", @@ -2327,7 +2327,7 @@ }, "item": [ { - "id": "c2cefa40-1491-48ee-9d1c-90a887709a13", + "id": "eec16035-502c-4c17-9047-8ffdd707e632", "name": "Order invoice notification", "request": { "name": "Order invoice notification", @@ -2405,7 +2405,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "7fcf6916-ad42-4a0f-a700-c01b6ee3b68c", + "id": "27182432-9f5b-40d5-abc2-7beadf1032f2", "name": "OK", "originalRequest": { "url": { @@ -2511,7 +2511,7 @@ { "listen": "test", "script": { - "id": "8046e8a3-ec41-436c-9096-75f36ebd7bbd", + "id": "e104e440-90e6-4e3e-9295-20eb247d4232", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/oms/pvt/orders/:orderId/invoice - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2527,7 +2527,7 @@ } }, { - "id": "fe388628-bc62-4a39-891a-39f97dba1357", + "id": "04f32a91-506c-4858-89ab-a6733233861a", "name": "Update order's partial invoice (send tracking number)", "request": { "name": "Update order's partial invoice (send tracking number)", @@ -2616,7 +2616,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "d54f88ac-8883-48e9-8030-ecbccedae2a6", + "id": "35ecc484-de6f-4e16-9400-dc1942b7701a", "name": "OK", "originalRequest": { "url": { @@ -2733,7 +2733,7 @@ { "listen": "test", "script": { - "id": "1a95c9a6-1b04-4a9b-890a-e4a58359f1ec", + "id": "178bf7a2-6870-41f9-86d6-e2309ec1095b", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PATCH]::/api/oms/pvt/orders/:orderId/invoice/:invoiceNumber - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -2752,7 +2752,7 @@ "event": [] }, { - "id": "c26d2886-7967-40c7-8263-ca23de181bb1", + "id": "c175f535-318c-4215-936e-8a77a3dc3fb0", "name": "Tracking", "description": { "content": "", @@ -2760,12 +2760,12 @@ }, "item": [ { - "id": "cb11fd8c-42ef-4b90-9382-975c31b272d8", + "id": "88fb79fb-3eae-4a23-8056-4c83a1613b4c", "name": "Update order tracking status", "request": { "name": "Update order tracking status", "description": { - "content": "This endpoint sends a tracking event to an order that already has a tracking number registered to its invoice.\n\r\n\rThis request is not meant to send tracking number and URL to the invoice. If you wish to send tracking number and URL to an order, use the [Update order's partial invoice API request](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/oms/pvt/orders/-orderId-/invoice/-invoiceNumber-). You can also learn more about [Partial invoice](https://help.vtex.com/en/tracks/partial-invoices--2xkTisx4SXOWXQel8Jg8sa/q9GPspTb9cHlMeAZfdEUe) scenarios. \n\r\n\r> The `Notify invoice` resource is needed to use this API request. This is included in `OMS - Full access` and `IntegrationProfile - Fulfillment Oms`, among other default roles available in the Admin. Learn more about the [License manager roles and resources](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc).", + "content": "This endpoint sends a tracking event to an order that already has a tracking number registered to its invoice.\n\r\n\rThis request is not meant to send tracking number and URL to the invoice. If you wish to send tracking number and URL to an order, use the [Update order's partial invoice API request](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/oms/pvt/orders/-orderId-/invoice/-invoiceNumber-). For more information, see [Partial invoice](https://help.vtex.com/en/tracks/partial-invoices--2xkTisx4SXOWXQel8Jg8sa/q9GPspTb9cHlMeAZfdEUe) scenarios.\n\r\n\rThis endpoint applies to orders with any shipping type, whether delivery or [pickup](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).\n\r\n\r> The `Notify invoice` resource is needed to use this API request. This is included in `OMS - Full access` and `IntegrationProfile - Fulfillment Oms`, among other default roles available in the Admin. Learn more about the [License manager roles and resources](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc).", "type": "text/plain" }, "url": { @@ -2850,7 +2850,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "a5f81a9a-f023-4460-84b0-7b2c36a01a2d", + "id": "1be7b188-9e28-48f8-8124-8af9833a38a6", "name": "OK", "originalRequest": { "url": { @@ -3067,7 +3067,7 @@ { "listen": "test", "script": { - "id": "955fad99-46e4-43bf-9f13-a7b31dc534a7", + "id": "c4165416-d475-42de-9d57-033ef5850d61", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[PUT]::/api/oms/pvt/orders/:orderId/invoice/:invoiceNumber/tracking - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -3097,7 +3097,7 @@ "event": [] }, { - "id": "0e568db0-4fed-4c2b-89d0-f5812a130aff", + "id": "7333b2e3-6184-4f6b-b326-48e034aca51a", "name": "Conversation", "description": { "content": "", @@ -3105,7 +3105,7 @@ }, "item": [ { - "id": "14b95463-3518-400d-9f74-57fb2fca8628", + "id": "b00667f3-e7c0-497f-bd24-fe171b23d3cc", "name": "Retrieve order conversation", "request": { "name": "Retrieve order conversation", @@ -3170,7 +3170,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "59a9721e-3133-49ac-a2b7-0a74b51c89d2", + "id": "839362a9-320d-4e9a-a6ae-42dded8f2812", "name": "OK", "originalRequest": { "url": { @@ -3376,7 +3376,7 @@ { "listen": "test", "script": { - "id": "4c19c88b-cb62-4956-9692-926fdefe0135", + "id": "6ab5b66c-6b3a-43b2-b426-263b0aa2a57b", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/oms/pvt/orders/:orderId/conversation-message - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -3407,7 +3407,7 @@ "event": [] }, { - "id": "b8d73d02-d66f-4ef7-b335-c3efa276829e", + "id": "90140805-eeb9-439d-9776-94747457cc1b", "name": "Payment", "description": { "content": "", @@ -3415,7 +3415,7 @@ }, "item": [ { - "id": "25245acc-8712-485d-b019-9ef0fc3c6fc0", + "id": "f00fa0d5-91db-4658-9fca-5eb78b38a6b2", "name": "Retrieve payment transaction", "request": { "name": "Retrieve payment transaction", @@ -3480,7 +3480,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "25586107-71b8-4adf-97f2-78dbc13e9f96", + "id": "e6eef823-8073-40ac-b440-3d9272c43995", "name": "OK", "originalRequest": { "url": { @@ -3578,7 +3578,7 @@ { "listen": "test", "script": { - "id": "c69b01a5-499d-4dcc-af50-62228ac5cb9d", + "id": "7c9b9694-4241-4936-8aec-9b00e489b85c", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/oms/pvt/orders/:orderId/payment-transaction - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -3594,7 +3594,7 @@ } }, { - "id": "13d6a2b5-ca50-4ff5-9d37-1846dacf5cc1", + "id": "50e07223-fbc7-4f10-ace9-12ea82883b31", "name": "Send payment notification", "request": { "name": "Send payment notification", @@ -3665,7 +3665,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "ed15b8e9-216b-4ac1-8eab-e0c3353eefc3", + "id": "ed894f46-084a-4eea-806f-1f3a9befd32d", "name": "OK", "originalRequest": { "url": { @@ -3770,7 +3770,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "517d30a3-6cfc-457c-a348-c4a853fa0e34", + "id": "f6b88284-bd2f-416d-aa0b-9dbe82d1d18f", "name": "Bad request.", "originalRequest": { "url": { @@ -3875,7 +3875,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "d4d33ce9-93cc-4194-81cf-f5f8b6b28239", + "id": "6c915eba-a049-4599-ab76-132e04a2ba0f", "name": "The credentials are not enabled to access the service.", "originalRequest": { "url": { @@ -3980,7 +3980,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "00e3fb8d-193c-4803-aaba-4990f96fc6d7", + "id": "f0289821-e706-4dd0-8f9c-05b485bb2745", "name": "Value not found.", "originalRequest": { "url": { @@ -4085,7 +4085,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "ce71da57-520d-4485-9edf-b87557f5fc96", + "id": "dd804629-5665-48fd-b0b7-ec27173babd3", "name": "Too many requests.", "originalRequest": { "url": { @@ -4191,7 +4191,7 @@ { "listen": "test", "script": { - "id": "bedca6a9-235f-4b1f-bec3-b2002bbd573d", + "id": "478e5d61-1117-42f9-88a2-339c93531563", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/oms/pvt/orders/:orderId/payments/:paymentId/payment-notification - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -4207,7 +4207,7 @@ "event": [] }, { - "id": "01960aad-85a0-4af6-b739-a79b21779fc4", + "id": "25d85335-0ef2-4f8a-8b53-06aa234403d9", "name": "Feed v3", "description": { "content": "", @@ -4215,7 +4215,7 @@ }, "item": [ { - "id": "6d977ac3-43be-4732-b7b2-0e74b8d97a8d", + "id": "4b34d66a-5a48-4881-bb38-67317da51d77", "name": "Get feed configuration", "request": { "name": "Get feed configuration", @@ -4268,7 +4268,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "11e5acf4-65d7-4634-9832-e8719edd1289", + "id": "48172cb6-338a-4043-bc83-6e979b5c0be5", "name": "OK", "originalRequest": { "url": { @@ -4354,7 +4354,7 @@ { "listen": "test", "script": { - "id": "622390d3-5917-4040-aba3-df9d3fb8cc71", + "id": "858e8d0a-f499-404f-9674-7b4ba550b7b2", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/orders/feed/config - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -4370,7 +4370,7 @@ } }, { - "id": "eb287ac9-0ddb-482a-b6e4-e758bd39d741", + "id": "0e7afc71-f90a-4a82-9b49-6b10335339d6", "name": "Create or update feed configuration", "request": { "name": "Create or update feed configuration", @@ -4432,7 +4432,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "49467b95-2b88-4d52-88e5-c0f093363654", + "id": "b3d13f9e-493d-44ee-a7de-90c981abc924", "name": "Success", "originalRequest": { "url": { @@ -4521,7 +4521,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "03834c16-7b61-4eb6-9d8d-b5f6e9d7e661", + "id": "fc8acab4-cf8e-41c3-b2f2-63dfb915e326", "name": "The credentials are not enabled to access the service", "originalRequest": { "url": { @@ -4610,7 +4610,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "92a68c43-0da4-4e06-9431-564c07a2f30e", + "id": "018556eb-c0c6-4ca8-99db-481285a4eb8d", "name": "Value not found", "originalRequest": { "url": { @@ -4699,7 +4699,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "ef88aa45-b8a6-4334-a348-8b25d89d8f1f", + "id": "d2dd658b-09d7-4a6d-8e3f-fe85f882ae76", "name": "Too many requests", "originalRequest": { "url": { @@ -4789,7 +4789,7 @@ { "listen": "test", "script": { - "id": "c7ce0a67-c974-426a-ba47-e391333a5be0", + "id": "69139add-839d-441c-8cbe-1f5500860c7a", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/orders/feed/config - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -4802,7 +4802,7 @@ } }, { - "id": "4ed23a1c-8538-4a2c-95a1-58c50d027340", + "id": "a870d7b3-7d8d-4a40-a23a-f343ab06ec23", "name": "Delete feed configuration", "request": { "name": "Delete feed configuration", @@ -4849,7 +4849,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "cd97a2d3-8115-4a2b-a505-9ad0518bbd4e", + "id": "0d8a76a8-3c70-458e-b1eb-5374b2a52b2a", "name": "OK", "originalRequest": { "url": { @@ -4930,7 +4930,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "8aa8ea54-01e8-4847-8b61-5bf7c23faeee", + "id": "65bfa152-924d-4415-911a-589888d0abd8", "name": "Bad request - Unable to check address / Only https scheme is accepted", "originalRequest": { "url": { @@ -5011,7 +5011,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "eb5f6057-1fe5-4e8a-9000-52f2ef40df8b", + "id": "1fe15762-fdcf-42c9-8c34-af6a2575bbc1", "name": "The credentials are not enabled to access the service", "originalRequest": { "url": { @@ -5092,7 +5092,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "d9018684-9653-465e-ae0a-3ba670e61061", + "id": "e805a952-29c6-4c95-87b4-ba6534c79b60", "name": "Value not found", "originalRequest": { "url": { @@ -5173,7 +5173,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "c1178cae-64c4-47ef-861b-786d094519e9", + "id": "87d2278f-7659-4487-8bf3-52eac62356e4", "name": "Too many requests", "originalRequest": { "url": { @@ -5255,7 +5255,7 @@ { "listen": "test", "script": { - "id": "d49ae9d8-79b4-4e02-96bf-863e431eb442", + "id": "c254d1e8-9ea9-4199-8cbb-fbb16d3f6295", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[DELETE]::/api/orders/feed/config - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -5268,7 +5268,7 @@ } }, { - "id": "7be15a75-be02-42a6-9c99-ec48f5fcd398", + "id": "1f2a07cb-a1cd-4b7f-aacf-b3a545c86cbf", "name": "Retrieve feed items", "request": { "name": "Retrieve feed items", @@ -5330,7 +5330,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "2f7d0b87-759b-4073-bae6-4c1dab99345a", + "id": "aeafa700-99dd-4c96-8d15-07a0ee3bf47c", "name": "OK", "originalRequest": { "url": { @@ -5420,7 +5420,7 @@ { "listen": "test", "script": { - "id": "dc4275dc-4d58-46e4-bc56-082bebafcce4", + "id": "0039c732-e8c9-4592-b3c8-6df34ad25286", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/orders/feed - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -5436,7 +5436,7 @@ } }, { - "id": "3e0bb300-7b7b-4c6d-9128-00b1ba97fe4b", + "id": "59a2a2fb-dcde-4081-87f0-132ea4e56640", "name": "Commit feed items", "request": { "name": "Commit feed items", @@ -5501,7 +5501,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "210b145d-c81e-467e-b3b5-490f61b2aae5", + "id": "22c57b96-9102-4a1a-9809-e8407e8f90ca", "name": "OK", "originalRequest": { "url": { @@ -5594,7 +5594,7 @@ { "listen": "test", "script": { - "id": "67990006-87bf-4c4e-96b2-2d5e1b56ccbd", + "id": "ab395bcc-0d17-48a3-89a3-11612a934802", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/orders/feed - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -5608,7 +5608,7 @@ } }, { - "id": "9245c834-4975-41c0-bae6-a3fca8d37500", + "id": "25e1bb13-c1bf-4502-9ffd-cb2cd3e5f718", "name": "Test JSONata expression", "request": { "name": "Test JSONata expression", @@ -5674,7 +5674,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "114369d9-fb61-4ee6-8309-260b265a683f", + "id": "a00aa6aa-5ad9-4971-be96-2b6ab2b42968", "name": "OK", "originalRequest": { "url": { @@ -5768,7 +5768,7 @@ { "listen": "test", "script": { - "id": "73c77363-c6a6-415f-9b3a-a7019932f5a9", + "id": "762b8632-a40b-4d06-9bd3-62f70d7685fb", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/orders/expressions/jsonata - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -5785,7 +5785,7 @@ "event": [] }, { - "id": "9918f511-408c-468c-a322-b1613cec3217", + "id": "61eb650d-72c1-4f4b-ab12-8cf2c021d47c", "name": "Order hook", "description": { "content": "", @@ -5793,7 +5793,7 @@ }, "item": [ { - "id": "e769c11d-23d4-42f4-8a55-361320a47e32", + "id": "d49393e1-9bc0-4930-a08a-ab40384e247c", "name": "Get hook configuration", "request": { "name": "Get hook configuration", @@ -5868,7 +5868,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "c188e8bb-10d2-4dfd-a638-5a5bf8246be1", + "id": "6f27c1b0-fddf-4314-ae0e-a1f60c4100de", "name": "OK", "originalRequest": { "url": { @@ -5963,7 +5963,7 @@ { "listen": "test", "script": { - "id": "ca8bc443-beca-407b-a6f7-a63652810dda", + "id": "cde9b1b0-84fd-407a-b82f-b5d1da5be101", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/orders/hook/config - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -5976,7 +5976,7 @@ } }, { - "id": "bf41f6ec-2951-4805-a74f-f37b82acc57e", + "id": "ae77b6bf-1aef-4fb5-bf75-76f92ed17c80", "name": "Create or update hook configuration", "request": { "name": "Create or update hook configuration", @@ -6042,7 +6042,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "53ae97ca-dcd6-4f4d-bda4-3623d5c2b1b4", + "id": "8f2972a9-7900-447b-bcb3-b8e9c8691d90", "name": "OK", "originalRequest": { "url": { @@ -6136,7 +6136,7 @@ { "listen": "test", "script": { - "id": "1e1d534d-701d-4f4d-9ca5-01a004e1db33", + "id": "a0e85ed2-b09d-4a11-916a-0882ba1ff41a", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/orders/hook/config - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -6152,7 +6152,7 @@ } }, { - "id": "f0ab42b4-6a55-4177-be33-5ab1a94804b5", + "id": "156ac1dc-91ad-4085-a417-26259d4cd687", "name": "Delete hook configuration", "request": { "name": "Delete hook configuration", @@ -6199,7 +6199,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "d8120edc-a2a4-427e-8dea-6a5cc002b3c9", + "id": "57fb1409-3991-4174-9023-7b81d25529c8", "name": "Success", "originalRequest": { "url": { @@ -6280,7 +6280,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "89eff84b-1c42-447c-88e5-5ef0b3fa6462", + "id": "4fd331c4-ba5c-4f7c-ba80-d972b4bc86e7", "name": "The credentials are not enabled to access the service", "originalRequest": { "url": { @@ -6361,7 +6361,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "fbd2002e-04ff-4f51-953d-0142874f2efa", + "id": "37ec1354-8267-44cd-a7cd-bb91cf38cedf", "name": "Value not found", "originalRequest": { "url": { @@ -6442,7 +6442,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "4a889c26-5c10-4708-a723-14a321b678ea", + "id": "52a71cf5-47ba-4dff-a2a7-0895aa72115b", "name": "Too many requests", "originalRequest": { "url": { @@ -6524,7 +6524,7 @@ { "listen": "test", "script": { - "id": "dd893a89-ce5d-40c3-9dea-c288e5c3cd8d", + "id": "099b63d0-fd53-41d5-a43d-5b373e27e344", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[DELETE]::/api/orders/hook/config - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -6540,7 +6540,7 @@ "event": [] }, { - "id": "1f6c8438-e297-4bb5-83d9-e5d84e15c38c", + "id": "3b62f77a-c3a6-4195-8b69-bc461f3c5a3a", "name": "Export order report", "description": { "content": "", @@ -6548,7 +6548,7 @@ }, "item": [ { - "id": "aebb834c-08ed-4037-8826-d7707262f892", + "id": "11c6eaa8-85ae-43a5-b063-a49943d8c25c", "name": "Export order report with status 'Completed'", "request": { "name": "Export order report with status 'Completed'", @@ -6603,7 +6603,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "e82c8758-cfc2-4bde-9928-8a42d08da261", + "id": "74943c22-578c-45f7-9622-285b03fa3adb", "name": "OK", "originalRequest": { "url": { @@ -6799,7 +6799,7 @@ { "listen": "test", "script": { - "id": "f91fa948-d1e0-4619-b857-a4e5af5c29cc", + "id": "f1d2043a-5b0d-4fa7-a7f5-d25d7e2ab356", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/oms/pvt/admin/reports/completed - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -6827,7 +6827,7 @@ } }, { - "id": "5f970485-f12f-4584-a68d-560b83a0672f", + "id": "458d39ef-dc9c-4dd8-9bea-305fe19b4d26", "name": "Export order report with status 'In Progress'", "request": { "name": "Export order report with status 'In Progress'", @@ -6882,7 +6882,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "9e6cbdc1-f8b6-4efd-a4c2-1e21813a56dd", + "id": "75af3912-0810-47ce-b999-638765200ad7", "name": "OK", "originalRequest": { "url": { @@ -7069,7 +7069,7 @@ { "listen": "test", "script": { - "id": "df977adb-9dd8-435f-9b58-a018e8001068", + "id": "69628e57-f90e-467e-9f5a-b8e7858e9efd", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/oms/pvt/admin/reports/inprogress - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -7099,7 +7099,7 @@ "event": [] }, { - "id": "56cf251c-d486-4d2e-8668-deaf78a51ffe", + "id": "73d3e07e-dfb3-4020-a994-3ba2d144eefc", "name": "User orders", "description": { "content": "", @@ -7107,7 +7107,7 @@ }, "item": [ { - "id": "e144394f-4b91-4d31-a078-9dbd56e283c5", + "id": "31b3a537-692c-4f4d-998f-71b94c409500", "name": "Retrieve user's orders", "request": { "name": "Retrieve user's orders", @@ -7188,7 +7188,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "ddefa179-dbdd-48f5-a851-040716f75614", + "id": "7e3e6e21-08ba-4fc1-9ee4-caca80dca3d4", "name": "OK", "originalRequest": { "url": { @@ -7287,7 +7287,7 @@ { "listen": "test", "script": { - "id": "05c04d1c-3134-4bc5-bbeb-3ca7f9ad8b68", + "id": "c54c2919-e2cf-4104-a8e2-7d40d14e3e01", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/oms/user/orders - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -7303,7 +7303,7 @@ } }, { - "id": "c2262a99-cd20-40e8-ad6b-8ae384607411", + "id": "2a2863de-37eb-44cb-b9d6-17ad0fffa7d0", "name": "Retrieve user order details", "request": { "name": "Retrieve user order details", @@ -7377,7 +7377,7 @@ "_": { "postman_previewlanguage": "json" }, - "id": "3322f76d-0873-435f-8cec-8333ce7ef6a4", + "id": "76e3fe20-f0ba-4759-a745-93dae9a2ee79", "name": "OK", "originalRequest": { "url": { @@ -7479,7 +7479,7 @@ { "listen": "test", "script": { - "id": "c76c7971-625e-45eb-b985-0aba2fdff922", + "id": "4b7b4be4-275f-4755-b95b-37322b94b7df", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/oms/user/orders/:orderId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -7498,7 +7498,7 @@ "event": [] }, { - "id": "6014d6e0-8b11-4815-8c5e-672fc1b25ec2", + "id": "3ed494f0-384b-4c8d-9d50-e645d4b5b469", "name": "Change seller", "description": { "content": "", @@ -7506,7 +7506,7 @@ }, "item": [ { - "id": "7639dd81-d0df-4d68-93d0-44bc367b1b3d", + "id": "ed3c28c6-8775-4427-9e03-955139a7a68e", "name": "Get window to change seller", "request": { "name": "Get window to change seller", @@ -7560,7 +7560,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "72b9cc6d-8276-4fb3-8493-8ba89d3cb973", + "id": "1889b833-51de-4dff-89f5-f6679af78750", "name": "OK", "originalRequest": { "url": { @@ -7647,7 +7647,7 @@ { "listen": "test", "script": { - "id": "3d3ba48f-5373-47b5-a952-7ce3f2d76505", + "id": "536be1ef-88cd-4e24-ab23-6b91e9ca0ffc", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/checkout/pvt/configuration/window-to-change-seller - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n", @@ -7661,7 +7661,7 @@ } }, { - "id": "a9921621-0b92-47aa-b408-a8cf079cc25e", + "id": "0d4f1add-469b-472a-bfa6-e2c43b36b560", "name": "Update window to change seller", "request": { "name": "Update window to change seller", @@ -7724,7 +7724,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "506bdebd-d6f9-4098-8045-22bdeaddce33", + "id": "98e23543-360c-4110-8561-73c9e8dfc7ee", "name": "Created", "originalRequest": { "url": { @@ -7815,7 +7815,7 @@ { "listen": "test", "script": { - "id": "d1e3923d-c4f7-460d-be3b-416c48f3996c", + "id": "9ad65502-a4cd-46c8-8f2b-92a98f835de4", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[POST]::/api/checkout/pvt/configuration/window-to-change-seller - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -7831,7 +7831,7 @@ "event": [] }, { - "id": "1973df87-1358-4ce4-8742-1bb6aca88ae6", + "id": "bde13533-36d9-49eb-a988-e5b194904e87", "name": "Feed v2 (deprecated)", "description": { "content": "", @@ -7839,7 +7839,7 @@ }, "item": [ { - "id": "e94817ce-389c-407a-80ee-be38f5b81f81", + "id": "f1fe9fe6-8a88-4808-a676-0feb50cc48d2", "name": "Get feed order status", "request": { "name": "Get feed order status", @@ -7898,7 +7898,7 @@ "_": { "postman_previewlanguage": "text" }, - "id": "b15815b4-e655-4d47-a431-be640207edbc", + "id": "f8f8e39d-b22a-4a83-904f-53fe8548d06b", "name": "OK", "originalRequest": { "url": { @@ -7987,7 +7987,7 @@ { "listen": "test", "script": { - "id": "caecf017-c6bf-4ce4-8869-c27bafe3b333", + "id": "99c60f8c-f4cb-463c-8d9d-d301a968857a", "type": "text/javascript", "exec": [ "// Validate status 2xx \npm.test(\"[GET]::/api/oms/pvt/feed/orders/status - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n" @@ -8050,7 +8050,7 @@ } ], "info": { - "_postman_id": "534d52d0-5b37-4d8e-86b2-f46977007daf", + "_postman_id": "c458c881-915a-445a-83c2-ba055319483d", "name": "Orders API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { From 018e482f6f6a950a46193f1bff152898f923b21f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Isabella=20Veloso=20S=C3=A1?= <77300325+Isabella-Veloso@users.noreply.github.com> Date: Wed, 26 Jul 2023 11:14:29 -0300 Subject: [PATCH 4/4] Update VTEX - Orders API.json MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Júlia Rabello <77292838+julia-rabello@users.noreply.github.com> --- VTEX - Orders API.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/VTEX - Orders API.json b/VTEX - Orders API.json index fb7ff2109..08dee78e6 100644 --- a/VTEX - Orders API.json +++ b/VTEX - Orders API.json @@ -3243,7 +3243,7 @@ "put": { "tags": ["Tracking"], "summary": "Update order tracking status", - "description": "This endpoint sends a tracking event to an order that already has a tracking number registered to its invoice.\n\r\n\rThis request is not meant to send tracking number and URL to the invoice. If you wish to send tracking number and URL to an order, use the [Update order's partial invoice API request](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/oms/pvt/orders/-orderId-/invoice/-invoiceNumber-). For more information, see [Partial invoice](https://help.vtex.com/en/tracks/partial-invoices--2xkTisx4SXOWXQel8Jg8sa/q9GPspTb9cHlMeAZfdEUe) scenarios.\n\r\n\rThis endpoint applies to orders with any shipping type, whether delivery or [pickup](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).\n\r\n\r> The `Notify invoice` resource is needed to use this API request. This is included in `OMS - Full access` and `IntegrationProfile - Fulfillment Oms`, among other default roles available in the Admin. Learn more about the [License manager roles and resources](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc).", + "description": "This endpoint sends a tracking event to an order that already has a tracking number registered to its invoice.\r\n\r\nThis request is not meant to send a tracking number and URL to the invoice. If you wish to send a tracking number and URL to an order, use the [Update order's partial invoice](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/oms/pvt/orders/-orderId-/invoice/-invoiceNumber-) endpoint. For more information, see [Partial invoice](https://help.vtex.com/en/tracks/partial-invoices--2xkTisx4SXOWXQel8Jg8sa/q9GPspTb9cHlMeAZfdEUe) scenarios.\r\n\r\nThis endpoint applies to orders with any shipping type, whether delivery or [pickup](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).\r\n\r\n> The `Notify invoice` License Manager resource is needed to use this API request. This is included in `OMS - Full access` and `IntegrationProfile - Fulfillment Oms`, among other default roles available in the Admin. Learn more about [License Manager Roles](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc).", "operationId": "UpdateTrackingStatus", "parameters": [ {