{ "opencollection": "1.0.0", "info": { "name": "VTex Anti-fraud Provider Account Scroll API", "version": "1.0" }, "items": [ { "info": { "name": "Scroll", "type": "folder" }, "items": [ { "info": { "name": "VTex Scroll documents", "type": "http" }, "http": { "method": "GET", "url": "https://{providerApiEndpoint}/api/dataentities/:dataEntityName/scroll", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "dataEntityName", "value": "", "type": "path", "description": "Name of the data entity." }, { "name": "_token", "value": "", "type": "query", "description": "Value of the header `X-VTEX-MD-TOKEN` returned in your first request. Send its value in this query string in the subsequent requests. The token has a timeout of 10 minutes, which refreshes after each new request." }, { "name": "_size", "value": "", "type": "query", "description": "Inform the number of documents per request. Maximum value of `1000`." }, { "name": "_fields", "value": "", "type": "query", "description": "Fields that should be returned by document. Separate fields' names with commas. For example `_fields=email,firstName,document`. You can also use `_fields=_all` to fetch all fields." }, { "name": "_where", "value": "", "type": "query", "description": "Defines a clause the document must comply with." }, { "name": "_schema", "value": "", "type": "query", "description": "Name of the [schema](https://developers.vtex.com/docs/guides/master-data-schema-lifecycle) that the document complies with. This field is required when using `_where` or `_fields` query parameters." }, { "name": "_sort", "value": "", "type": "query", "description": "Sets sorting mode in two parts. The first part is the name of the field you want to sort by. In the second part, use `ASC` for ascending or `DESC` for descending." } ] }, "docs": "If you need to query the entire VTEX Master Data database, or your collection is over 10.000 documents, use this endpoint.\r\n\r\nIn the first request, the `X-VTEX-MD-TOKEN` token will be returned in the header. This token must be passed to the next request in the query string `_token` parameter. The token has a timeout of 10 minutes, which refreshes after each request.\r\n\r\nAfter the token is obtained, it is no longer necessary to send the filter or document size per page parameters. You only need to" } ] } ], "bundled": true }