{ "opencollection": "1.0.0", "info": { "name": "VTex Anti-fraud Provider Account Search API", "version": "1.0" }, "items": [ { "info": { "name": "Search", "type": "folder" }, "items": [ { "info": { "name": "VTex Search for Products", "type": "http" }, "http": { "method": "GET", "url": "https://{providerApiEndpoint}/api/catalog_system/pub/products/search/:search", "headers": [ { "name": "Accept", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "search", "value": "", "type": "path", "description": "Term used to search products" } ] }, "docs": "Retrieves general information about the products related to the term searched. \r\nThis is the main search used by the store. The user can type anything to be searched. \r\n\r\nFor example, if they search for a \"decanter\", this is the URL: `https://{{accountName}}.{{environment}}.com.br/api/catalog_system/pub/products/search/decanter`. \r\n\r\nNote that maybe the response can be HTTP 200 or 206, 206 means that it's a partial content response.\r\n\r\nIf it is a 206 take a look at the Headers, will be an entry" }, { "info": { "name": "VTex Search for Products with Filter, Order and Pagination", "type": "http" }, "http": { "method": "GET", "url": "https://{providerApiEndpoint}/api/catalog_system/pub/products/search", "headers": [ { "name": "Accept", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "_from", "value": "", "type": "query", "description": "Starting page of the pagination range. This number must be below or equal to 2500 for the query to work. Note that the difference between the initial and final pages cannot exceed 50 pages. Therefore, each page will display a maximum of 50 items." }, { "name": "_to", "value": "", "type": "query", "description": "Final page of the pagination range. Note that the difference between the initial and final pages cannot exceed 50 pages. Therefore, each page will display a maximum of 50 items." }, { "name": "ft", "value": "", "type": "query", "description": "Filter by full text. The form is`ft={searchWord}`." }, { "name": "fq", "value": "", "type": "query", "description": "General filter. It can be by category (`fq=C:/{a}/{b}`), by specification (`fq=specificationFilter_{a}:{b}`), by price range (`fq=P:[{a} TO {b}]`), by collection (`fq=productClusterIds:{{productClusterId}}`), by product ID (`fq=productId:{{productId}}`), by SKU ID (`fq=skuId:{{skuId}}`), by Reference ID (`fq=alternateIds_RefId:{{referenceId}}`), by EAN13 (`fq=alternateIds_Ean:{{ean13}}`), by availability at a specific sales channel (`fq=isAvailablePerSalesChannel_{{sc}}:{{bool}}`), by available at a specific seller (`fq=sellerId:{{sellerId}}`)." }, { "name": "O", "value": "", "type": "query", "description": "Sorting method. It can be by Price (`O=OrderByPriceDESC` or `O=OrderByPriceASC`), by Top Selling Products (`O=OrderByTopSaleDESC`), by Best Reviews (`O=OrderByReviewRateDESC`), by Name (`O=OrderByNameASC` or `O=OrderByNameDESC`), by Release Date (`O=OrderByReleaseDateDESC`), by Best Discounts (`O=OrderByBestDiscountDESC`), by Score (`O=OrderByScoreDESC`)." } ] }, "docs": "Retrieves general information about the store's products. This information can be filtered and ordered by a number of options. It also can be paginated, filtered and ordered. \r\n\r\n## Filters \r\n\r\n- **Filter by full text** - `ft={searchWord}` \r\nE.g.: `ft=television`\r\n\r\n- **Filter by category** - `fq=C:/{a}/{b}` \r\n`{a}` and `{b}` are Category IDs \r\nE.g.: `fq=C:/1000041/1000049/`\r\n\r\n- **Filter by brand** - `fq=B:/{a}/{b}` \r\n`{a}` and `{b}` are Brand IDs\r\nE.g.: `fq=B:/189385/189387/`\r\n\r\n- **Filt" }, { "info": { "name": "VTex Search Product by Product URL", "type": "http" }, "http": { "method": "GET", "url": "https://{providerApiEndpoint}/api/catalog_system/pub/products/search/:product-text-link/p", "headers": [ { "name": "Accept", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "product-text-link", "value": "", "type": "path", "description": "Product URL" } ] }, "docs": "Retrieves general information about the product of the URL you searched for." }, { "info": { "name": "VTex Search documents", "type": "http" }, "http": { "method": "GET", "url": "https://{providerApiEndpoint}/api/dataentities/:dataEntityName/search", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" }, { "name": "REST-Range", "value": "" } ], "params": [ { "name": "dataEntityName", "value": "", "type": "path", "description": "Name of the data entity." }, { "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": "Retrieves documents' information, while choosing which fields will be returned and filtering documents by specific fields.\r\n\r\n> The response header `REST-Content-Range` indicates the total amount of results for that specific search. For example, it may return `resources 0-100/136108`, which indicates it has returned results from 0 to 100 of a total 136108.\r\n\r\nBelow you can see some query examples and learn more about each query parameter.\n\r\n\r> Avoid sending too many requests with wildcards (`*`)" } ] } ], "bundled": true }