{ "opencollection": "1.0.0", "info": { "name": "VTex Anti-fraud Provider Account Feed V3 API", "version": "1.0" }, "items": [ { "info": { "name": "Feed V3", "type": "folder" }, "items": [ { "info": { "name": "VTex Get feed configuration", "type": "http" }, "http": { "method": "GET", "url": "https://{providerApiEndpoint}/api/orders/feed/config", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ] }, "docs": "The Orders Feed v3 is the best way to create order integrations. Below you can find details on the configuration API specification, and to know more see our [Feed v3 guide](https://developers.vtex.com/vtex-rest-api/docs/orders-feed) and our [order integration guide](https://developers.vtex.com/vtex-rest-api/docs/erp-integration-set-up-order-integration).\n\r\n> 📘 Onboarding guide \r\n>\r\n> Check the new [Orders onboarding guide](https://developers.vtex.com/vtex-rest-api/docs/orders-overview). We crea" }, { "info": { "name": "VTex Create or update feed configuration", "type": "http" }, "http": { "method": "POST", "url": "https://{providerApiEndpoint}/api/orders/feed/config", "headers": [ { "name": "Accept", "value": "" }, { "name": "Content-Type", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "The Orders Feed v3 is the best way to create order integrations. Below you can find details on the configuration API specification, and to know more see our [Feed v3 guide](https://developers.vtex.com/vtex-rest-api/docs/orders-feed) and our [order integration guide](https://developers.vtex.com/vtex-rest-api/docs/erp-integration-set-up-order-integration)\n\r\n\rThere are two types of filtering that can be used. The `FromWorkflow` type filters orders by status, whereas the `FromOrders` type uses JSONa" }, { "info": { "name": "VTex Delete feed configuration", "type": "http" }, "http": { "method": "DELETE", "url": "https://{providerApiEndpoint}/api/orders/feed/config", "headers": [ { "name": "Accept", "value": "" }, { "name": "Content-Type", "value": "" } ] }, "docs": "Deletes the configuration set up in [Feed v3](https://developers.vtex.com/docs/guides/orders-feed)." }, { "info": { "name": "VTex Retrieve feed items", "type": "http" }, "http": { "method": "GET", "url": "https://{providerApiEndpoint}/api/orders/feed", "headers": [ { "name": "Accept", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "maxlot", "value": "", "type": "query", "description": "Lot quantity to retrieve. Maximum accepted value is 10." } ] }, "docs": "Retrieve items from [feed](https://developers.vtex.com/docs/guides/orders-feed) queue. \n\r\nThe event will be removed if the message `send retry` is equal to, or greater than the maximum retention period.\r\n\r\n> This API will return `404 Not Found` if there is no [Feed Configuration](https://developers.vtex.com/docs/guides/orders-feed) available for the given X-VTEX-API-AppKey." }, { "info": { "name": "VTex Commit feed items", "type": "http" }, "http": { "method": "POST", "url": "https://{providerApiEndpoint}/api/orders/feed", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Commit items in the [feed](https://developers.vtex.com/docs/guides/orders-feed) queue." }, { "info": { "name": "VTex Test JSONata expression", "type": "http" }, "http": { "method": "POST", "url": "https://{providerApiEndpoint}/api/orders/expressions/jsonata", "headers": [ { "name": "Accept", "value": "" }, { "name": "Content-Type", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint allows you to test a JSON document with a JSONata expression, returning `true` if the document meets the criteria posed in the expression, or `false` if it does not.\n\r\n\rSince JSONata expressions can be used to filter order updates in the [Orders API feed and hook](https://developers.vtex.com/docs/guides/orders-feed), this endpoint can be used to test an expression's results before configuring the [feed or hook](https://developers.vtex.com/docs/guides/orders-feed).\n\r\n\rLearn more abo" } ] } ], "bundled": true }