Skip to content

Commit

Permalink
Add delivery promise parameters to the intelligent-search-api general…
Browse files Browse the repository at this point in the history
… filters
  • Loading branch information
hiagolcm committed Oct 9, 2024
1 parent e5719ea commit e39601e
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion VTEX - Intelligent Search API.json
Original file line number Diff line number Diff line change
Expand Up @@ -1179,7 +1179,7 @@
"in": "path",
"name": "facets",
"required": true,
"description": "## Format\r\n\r\nThe `facets` parameter follows the format: `/${facetKey1}/${facetValue1}/${facetKey2}/${facetValue2}/.../${facetKeyN}/${facetValueN}`.\r\n\r\nThe order in which the terms appear is not relevant to the search.\r\n\r\nYou can also repeat the same `facetKey` several times for different values. For example: `category-1/shoes/color/blue/color/red/color/yellow`.\r\n\r\n## General filters\r\n\r\nThe `facets` parameter also allows the following general filters:\r\n\r\n| `facetKey` | Description | Example |\r\n| - | - | - |\r\n| `price` | Filter the search by a price range, following the format `${minPrice}:${maxPrice}`. | `/color/blue/price/100:500?query=shirt` |\r\n| `category-${n}` | Filter the search by category, where `n` represents the category tree level (1 = department, 2 = category, 3 = subcategory, and so on). | `category-1/clothing/category-2/shirts` |\r\n| `productClusterIds` | Filter the search by collection, following the format `productClusterIds/{collectionId}`. | `productClusterIds/262` |\r\n| `trade-policy` | Filter the search by trade policy (also known as sales channel), following the format `trade-policy/{tradePolicyId}`. | `trade-policy/2`|\n",
"description": "## Format\r\n\r\nThe `facets` parameter follows the format: `/${facetKey1}/${facetValue1}/${facetKey2}/${facetValue2}/.../${facetKeyN}/${facetValueN}`.\r\n\r\nThe order in which the terms appear is not relevant to the search.\r\n\r\nYou can also repeat the same `facetKey` several times for different values. For example: `category-1/shoes/color/blue/color/red/color/yellow`.\r\n\r\n## General filters\r\n\r\nThe `facets` parameter also allows the following general filters:\r\n\r\n| `facetKey` | Description | Example |\r\n| - | - | - |\r\n| `price` | Filter the search by a price range, following the format `${minPrice}:${maxPrice}`. | `/color/blue/price/100:500?query=shirt` |\r\n| `category-${n}` | Filter the search by category, where `n` represents the category tree level (1 = department, 2 = category, 3 = subcategory, and so on). | `category-1/clothing/category-2/shirts` |\r\n| `productClusterIds` | Filter the search by collection, following the format `productClusterIds/{collectionId}`. | `productClusterIds/262` |\r\n| `trade-policy` | Filter the search by trade policy (also known as sales channel), following the format `trade-policy/{tradePolicyId}`. | `trade-policy/2`| |\r\n| `zip-code` | Filter the search by the zip code. It also adds delivery promise filters to the API return. The `coordinates` filter is also required. | `zip-code/22250040` |\r\n| `coordinates` | Filter the search by geographic coordinates, following the format `coordinates/{longitude},{latitude}`. It also adds delivery promise filters to the API return. The `zip-code`filter is also required | `coordinates/-43.18218231201172,-22.94549560546875`| |\r\n| `pickupPoint` | The API result will contain a filter with the option to filter the search by pickup point. | `pickupPoint/myPickupPoint`|\n",
"example": "category-1/clothing/category-2/shirt/category-3/man",
"schema": {
"nullable": true,
Expand Down

0 comments on commit e39601e

Please sign in to comment.