Adding new endpoint to Index

VTEX - Orders API.json

@@ -2,7 +2,7 @@
     "openapi": "3.0.0",
     "info": {
         "title": "Orders API",
-        "description": "Each purchase a customer makes in your store generates an [order](https:\/\/help.vtex.com\/en\/tutorial\/order-flow-and-status--tutorials_196) on VTEX. With the Orders API, you can view orders statuses and manage multiple aspects involved in order fulfillment, such as financial transactions, invoicing, shipping, and subscriptions. You can also [change orders](https:\/\/help.vtex.com\/en\/tutorial\/changing-items-from-a-complete-order--tutorials_190) and make configurations to allow or forbid marketplaces and sellers to change or cancel orders.\r\n\r\n### Order integration\n\r\nTo automate actions related to order processing, you can [integrate orders](https:\/\/developers.vtex.com\/docs\/guides\/erp-integration-guide) with systems like ERP (Enterprise Resource Planning) and WMS (Warehouse Management System) using [Feed and Hook](https:\/\/developers.vtex.com\/docs\/guides\/orders-feed).\r\n\r\n## Orders API Index\r\n\r\n### Orders\r\n\r\n- `GET` [Get order](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#get-\/api\/oms\/pvt\/orders\/-orderId-)\r\n- `GET` [List orders](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#get-\/api\/oms\/pvt\/orders)\r\n- `POST` [Start handling order](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#post-\/api\/oms\/pvt\/orders\/-orderId-\/start-handling)\r\n- `POST` [Cancel order](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#post-\/api\/oms\/pvt\/orders\/-orderId-\/cancel)\r\n- `POST` [Register change on order](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#post-\/api\/oms\/pvt\/orders\/-orderId-\/changes)\r\n\r\n### Invoice\r\n\r\n- `POST` [Order invoice notification](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#post-\/api\/oms\/pvt\/orders\/-orderId-\/invoice)\r\n- `PATCH` [Update order's partial invoice (send tracking number)](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#patch-\/api\/oms\/pvt\/orders\/-orderId-\/invoice\/-invoiceNumber-)\r\n\r\n### Tracking\r\n\r\n- `PUT` [Update order tracking status](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#put-\/api\/oms\/pvt\/orders\/-orderId-\/invoice\/-invoiceNumber-\/tracking)\r\n\r\n### Conversation\r\n\r\n- `GET` [Retrieve order conversation](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#get-\/api\/oms\/pvt\/orders\/-orderId-\/conversation-message)\r\n\r\n### Payment\r\n\r\n- `GET` [Retrieve payment transaction](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#get-\/api\/oms\/pvt\/orders\/-orderId-\/payment-transaction)\r\n- `POST` [Send payment notification](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#post-\/api\/oms\/pvt\/orders\/-orderId-\/payments\/-paymentId-\/payment-notification)\r\n\r\n### Feed v2 (deprecated)\r\n\r\n- `GET` [Get feed order status](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#get-\/api\/oms\/pvt\/feed\/orders\/status)\r\n\r\n### Feed v3\r\n\r\n- `GET` [Get feed configuration](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#get-\/api\/orders\/feed\/config)\r\n- `POST` [Create or update feed configuration](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#post-\/api\/orders\/feed\/config)\r\n- `DELETE` [Delete feed configuration](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#delete-\/api\/orders\/feed\/config)\r\n- `GET` [Retrieve feed items](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#get-\/api\/orders\/feed)\r\n- `POST` [Commit feed items](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#post-\/api\/orders\/feed)\r\n- `POST` [Test JSONata expression](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#post-\/api\/orders\/expressions\/jsonata)\r\n\r\n### Order hook\r\n\r\n- `GET` [Get hook configuration](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#get-\/api\/orders\/hook\/config)\r\n- `POST` [Create or update hook configuration](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#post-\/api\/orders\/hook\/config)\r\n- `DELETE` [Delete hook configuration](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#delete-\/api\/orders\/hook\/config)\r\n\r\n### User orders\r\n\r\n- `GET` [Retrieve user's orders](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#get-\/api\/oms\/user\/orders)\r\n- `GET` [Retrieve user order details](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#get-\/api\/oms\/user\/orders\/-orderId-)\r\n\r\n### Change seller\r\n\r\n- `GET` [Get window to change seller](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#get-\/api\/checkout\/pvt\/configuration\/window-to-change-seller)\r\n- `POST` [Update window to change seller](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#post-\/api\/checkout\/pvt\/configuration\/window-to-change-seller) \r\n\r\n## Common parameters\r\n\r\n| **Parameter name** | **Description** | **Type** |\r\n| :---: | :--- | :--- |\r\n| `{{accountName}}` | Name of the VTEX account. Used as part of the URL. | Server variable. |\r\n| `{{environment}}` | Environment to use. Used as part of the URL. The default value is `vtexcommercestable`. | Server variable. |\r\n| `X-VTEX-API-AppKey` | Unique identifier of the [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys). | Authentication header. Must be used together with `X-VTEX-API-AppToken`. Not necessary when using `VtexIdclientAutCookie`. |\r\n| `X-VTEX-API-AppToken` | Secret token of the [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys). | Authentication header. Must be used together with X-VTEX-API-AppKey. Not necessary when using `VtexIdclientAutCookie`. |\r\n| `VtexIdclientAutCookie` | [User token](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens), valid for 24 hours. | Authentication header. Not necessary when using `X-VTEX-API-AppKey` and `X-VTEX-API-AppToken`. |",
+        "description": "Each purchase a customer makes in your store generates an [order](https:\/\/help.vtex.com\/en\/tutorial\/order-flow-and-status--tutorials_196) on VTEX. With the Orders API, you can view orders statuses and manage multiple aspects involved in order fulfillment, such as financial transactions, invoicing, shipping, and subscriptions. You can also [change orders](https:\/\/help.vtex.com\/en\/tutorial\/changing-items-from-a-complete-order--tutorials_190) and make configurations to allow or forbid marketplaces and sellers to change or cancel orders.\r\n\r\n### Order integration\n\r\nTo automate actions related to order processing, you can [integrate orders](https:\/\/developers.vtex.com\/docs\/guides\/erp-integration-guide) with systems like ERP (Enterprise Resource Planning) and WMS (Warehouse Management System) using [Feed and Hook](https:\/\/developers.vtex.com\/docs\/guides\/orders-feed).\r\n\r\n## Orders API Index\r\n\r\n### Orders\r\n\r\n- `GET` [Get order](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#get-\/api\/oms\/pvt\/orders\/-orderId-)\r\n- `GET` [Get orders by order group ID](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#get-\/api\/oms\/pvt\/orders\/order-group\/-orderGroup-)\r\n- `GET` [List orders](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#get-\/api\/oms\/pvt\/orders)\r\n- `POST` [Start handling order](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#post-\/api\/oms\/pvt\/orders\/-orderId-\/start-handling)\r\n- `POST` [Cancel order](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#post-\/api\/oms\/pvt\/orders\/-orderId-\/cancel)\r\n- `POST` [Register change on order](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#post-\/api\/oms\/pvt\/orders\/-orderId-\/changes)\r\n\r\n### Invoice\r\n\r\n- `POST` [Order invoice notification](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#post-\/api\/oms\/pvt\/orders\/-orderId-\/invoice)\r\n- `PATCH` [Update order's partial invoice (send tracking number)](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#patch-\/api\/oms\/pvt\/orders\/-orderId-\/invoice\/-invoiceNumber-)\r\n\r\n### Tracking\r\n\r\n- `PUT` [Update order tracking status](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#put-\/api\/oms\/pvt\/orders\/-orderId-\/invoice\/-invoiceNumber-\/tracking)\r\n\r\n### Conversation\r\n\r\n- `GET` [Retrieve order conversation](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#get-\/api\/oms\/pvt\/orders\/-orderId-\/conversation-message)\r\n\r\n### Payment\r\n\r\n- `GET` [Retrieve payment transaction](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#get-\/api\/oms\/pvt\/orders\/-orderId-\/payment-transaction)\r\n- `POST` [Send payment notification](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#post-\/api\/oms\/pvt\/orders\/-orderId-\/payments\/-paymentId-\/payment-notification)\r\n\r\n### Feed v2 (deprecated)\r\n\r\n- `GET` [Get feed order status](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#get-\/api\/oms\/pvt\/feed\/orders\/status)\r\n\r\n### Feed v3\r\n\r\n- `GET` [Get feed configuration](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#get-\/api\/orders\/feed\/config)\r\n- `POST` [Create or update feed configuration](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#post-\/api\/orders\/feed\/config)\r\n- `DELETE` [Delete feed configuration](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#delete-\/api\/orders\/feed\/config)\r\n- `GET` [Retrieve feed items](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#get-\/api\/orders\/feed)\r\n- `POST` [Commit feed items](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#post-\/api\/orders\/feed)\r\n- `POST` [Test JSONata expression](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#post-\/api\/orders\/expressions\/jsonata)\r\n\r\n### Order hook\r\n\r\n- `GET` [Get hook configuration](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#get-\/api\/orders\/hook\/config)\r\n- `POST` [Create or update hook configuration](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#post-\/api\/orders\/hook\/config)\r\n- `DELETE` [Delete hook configuration](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#delete-\/api\/orders\/hook\/config)\r\n\r\n### User orders\r\n\r\n- `GET` [Retrieve user's orders](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#get-\/api\/oms\/user\/orders)\r\n- `GET` [Retrieve user order details](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#get-\/api\/oms\/user\/orders\/-orderId-)\r\n\r\n### Change seller\r\n\r\n- `GET` [Get window to change seller](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#get-\/api\/checkout\/pvt\/configuration\/window-to-change-seller)\r\n- `POST` [Update window to change seller](https:\/\/developers.vtex.com\/docs\/api-reference\/orders-api#post-\/api\/checkout\/pvt\/configuration\/window-to-change-seller) \r\n\r\n## Common parameters\r\n\r\n| **Parameter name** | **Description** | **Type** |\r\n| :---: | :--- | :--- |\r\n| `{{accountName}}` | Name of the VTEX account. Used as part of the URL. | Server variable. |\r\n| `{{environment}}` | Environment to use. Used as part of the URL. The default value is `vtexcommercestable`. | Server variable. |\r\n| `X-VTEX-API-AppKey` | Unique identifier of the [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys). | Authentication header. Must be used together with `X-VTEX-API-AppToken`. Not necessary when using `VtexIdclientAutCookie`. |\r\n| `X-VTEX-API-AppToken` | Secret token of the [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys). | Authentication header. Must be used together with X-VTEX-API-AppKey. Not necessary when using `VtexIdclientAutCookie`. |\r\n| `VtexIdclientAutCookie` | [User token](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens), valid for 24 hours. | Authentication header. Not necessary when using `X-VTEX-API-AppKey` and `X-VTEX-API-AppToken`. |",
         "contact": {},
         "version": "1.0"
     },