Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add delivery promise parameters to the intelligent-search-api general filters #1342

Merged
merged 3 commits into from
Oct 10, 2024
Merged

Add delivery promise parameters to the intelligent-search-api general filters #1342

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e39601e
Add delivery promise parameters to the intelligent-search-api general…
hiagolcm Oct 9, 2024
c287912
Update generated files by portman
Oct 9, 2024
752d141
review zip-code, coordinates, pickupPoint facets
julia-rabello Oct 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 29 additions & 29 deletions PostmanCollections/VTEX - Intelligent Search API.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
{
"_": {
"postman_id": "bb7e8047-f3a9-4c4b-b5df-e72446d8a7a4"
"postman_id": "279e22eb-f3da-46ac-a1c6-e3629efd0bba"
},
"item": [
{
"id": "28d85e1a-c9ce-4bab-b889-009e4133b4f3",
"id": "207e6461-647b-49b8-9a63-3266810f0518",
"name": "Autocomplete",
"description": {
"content": "",
"type": "text/plain"
},
"item": [
{
"id": "0d9661ab-b5cd-418a-a44b-c898276cae03",
"id": "459f2051-c2b2-43d9-96e2-f199bf83637e",
"name": "Get list of the 10 most searched terms",
"request": {
"name": "Get list of the 10 most searched terms",
Expand Down Expand Up @@ -54,7 +54,7 @@
"_": {
"postman_previewlanguage": "json"
},
"id": "3f284190-7e29-4787-80a3-6bad80771657",
"id": "9fda8b2b-3163-4bab-915c-746865b706a2",
"name": "OK",
"originalRequest": {
"url": {
Expand Down Expand Up @@ -102,7 +102,7 @@
{
"listen": "test",
"script": {
"id": "38333201-9e19-4baf-98c8-6a9c71ef78f3",
"id": "cd51c12b-5cf1-44dc-9716-7c0fb185e719",
"type": "text/javascript",
"exec": [
"// Validate status 2xx \npm.test(\"[GET]::/top_searches - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n",
Expand All @@ -118,7 +118,7 @@
}
},
{
"id": "f8af764a-7877-445d-ae8b-f0cf5e03e31b",
"id": "2def3df6-4e5a-4a50-b6a7-47768f8af09f",
"name": "Get list of suggested terms and attributes similar to the search term",
"request": {
"name": "Get list of suggested terms and attributes similar to the search term",
Expand Down Expand Up @@ -169,7 +169,7 @@
"_": {
"postman_previewlanguage": "json"
},
"id": "a77dcc8e-c558-432c-9dbf-76ac7a118230",
"id": "d9e43cb1-edda-4ae4-b11d-e81d36b55669",
"name": "OK",
"originalRequest": {
"url": {
Expand Down Expand Up @@ -226,7 +226,7 @@
{
"listen": "test",
"script": {
"id": "a736c943-2dee-4934-9a2f-473764ec952e",
"id": "f38f57ae-8e80-4ade-9d7f-708fd40611be",
"type": "text/javascript",
"exec": [
"// Validate status 2xx \npm.test(\"[GET]::/autocomplete_suggestions - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n",
Expand All @@ -242,7 +242,7 @@
}
},
{
"id": "c201e5b6-91c3-45bf-8ea8-c3a99ffaf599",
"id": "4cad5403-a39d-46d0-9a90-64aed1df2da9",
"name": "Get list of suggested terms similar to the search term",
"request": {
"name": "Get list of suggested terms similar to the search term",
Expand Down Expand Up @@ -293,7 +293,7 @@
"_": {
"postman_previewlanguage": "json"
},
"id": "d5f43ffc-63c4-4334-a6c1-cb2dfa561bed",
"id": "d2ddb535-c5d8-4e4e-9896-3cd449c3ddcc",
"name": "OK",
"originalRequest": {
"url": {
Expand Down Expand Up @@ -350,7 +350,7 @@
{
"listen": "test",
"script": {
"id": "6720f47a-6ec8-4b3c-b0da-d3d0c9ae8dd8",
"id": "5ad3cb68-1d66-4679-a138-ea2e6986fd46",
"type": "text/javascript",
"exec": [
"// Validate status 2xx \npm.test(\"[GET]::/search_suggestions - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n",
Expand All @@ -369,15 +369,15 @@
"event": []
},
{
"id": "88ee52ef-54d5-4981-81cd-a94fd23ba545",
"id": "c14237f6-501f-430a-97bb-c4dbb868acf7",
"name": "Product List Page",
"description": {
"content": "",
"type": "text/plain"
},
"item": [
{
"id": "289aaa3a-6e37-4a3e-8fd6-8f6c57508e96",
"id": "07006283-b37b-4506-8288-5423549925ad",
"name": "Get attempt of correction of a misspelled term",
"request": {
"name": "Get attempt of correction of a misspelled term",
Expand Down Expand Up @@ -428,7 +428,7 @@
"_": {
"postman_previewlanguage": "json"
},
"id": "7a3eee52-ffb1-4777-9844-2f3a13803a5b",
"id": "50cb1b06-1978-4c66-a02f-6be0f85a68ee",
"name": "OK",
"originalRequest": {
"url": {
Expand Down Expand Up @@ -485,7 +485,7 @@
{
"listen": "test",
"script": {
"id": "069c913d-783b-4b94-8adf-3ae928746ee3",
"id": "0f93a21e-1194-49f2-8368-15f3dbe84a57",
"type": "text/javascript",
"exec": [
"// Validate status 2xx \npm.test(\"[GET]::/correction_search - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n",
Expand All @@ -501,7 +501,7 @@
}
},
{
"id": "6e944797-1b44-484a-b2ce-5f82806e9a0f",
"id": "64bc5960-de9a-415b-83d4-38ba974cf063",
"name": "Get list of banners registered for query",
"request": {
"name": "Get list of banners registered for query",
Expand Down Expand Up @@ -541,7 +541,7 @@
{
"disabled": false,
"description": {
"content": "(Required) ## 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",
"content": "(Required) ## 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",
"type": "text/plain"
},
"type": "any",
Expand All @@ -564,7 +564,7 @@
"_": {
"postman_previewlanguage": "json"
},
"id": "0a8044b8-6f32-4ef9-998f-f2f605b58002",
"id": "3e3622a1-f85e-4238-bb49-49c639fd2cc3",
"name": "OK",
"originalRequest": {
"url": {
Expand Down Expand Up @@ -622,7 +622,7 @@
{
"listen": "test",
"script": {
"id": "2683bbcd-009d-412f-b47f-cf2aa16bb56a",
"id": "bb64eef5-2a74-4746-a0f7-dec3ee313f65",
"type": "text/javascript",
"exec": [
"// Validate status 2xx \npm.test(\"[GET]::/banners/:facets - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n",
Expand All @@ -638,7 +638,7 @@
}
},
{
"id": "7dc6453a-6738-4278-8890-f75c45ab06e7",
"id": "dd320a94-14ae-4608-859b-d0207aecab47",
"name": "Get list of products for a query",
"request": {
"name": "Get list of products for a query",
Expand Down Expand Up @@ -732,7 +732,7 @@
{
"disabled": false,
"description": {
"content": "(Required) ## 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",
"content": "(Required) ## 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",
"type": "text/plain"
},
"type": "any",
Expand All @@ -755,7 +755,7 @@
"_": {
"postman_previewlanguage": "json"
},
"id": "c1dd2afb-07b3-46a0-9be1-fd33ea299bf7",
"id": "b9d0a889-0893-4f94-9f32-2e80bb13d52b",
"name": "List of products for the given query.",
"originalRequest": {
"url": {
Expand Down Expand Up @@ -866,7 +866,7 @@
"_": {
"postman_previewlanguage": "json"
},
"id": "b824aa79-2eb4-4018-8805-bc9318283db8",
"id": "f0e96b05-f439-4a1c-bb78-e9edfc339579",
"name": "Bad Request.",
"originalRequest": {
"url": {
Expand Down Expand Up @@ -978,7 +978,7 @@
{
"listen": "test",
"script": {
"id": "966cda46-8207-4b01-a226-07d1eb307c36",
"id": "ec9d7d15-f7b5-464d-921d-2750f7e12e74",
"type": "text/javascript",
"exec": [
"// Validate status 2xx \npm.test(\"[GET]::/product_search/:facets - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n",
Expand All @@ -994,7 +994,7 @@
}
},
{
"id": "298f28e5-2445-4dc0-9d50-dab42ef9a1f5",
"id": "211a8067-2bfb-4acc-a7da-3a767fd578f4",
"name": "Get list of the possible facets for a given query",
"request": {
"name": "Get list of the possible facets for a given query",
Expand Down Expand Up @@ -1043,7 +1043,7 @@
{
"disabled": false,
"description": {
"content": "(Required) ## 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",
"content": "(Required) ## 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",
"type": "text/plain"
},
"type": "any",
Expand All @@ -1066,7 +1066,7 @@
"_": {
"postman_previewlanguage": "json"
},
"id": "0bcaf44d-d1ca-4252-a382-8f9cc53b7494",
"id": "fdaf1019-4ac0-4429-984e-ba66beda6fa1",
"name": "List of facets for the given query.",
"originalRequest": {
"url": {
Expand Down Expand Up @@ -1133,7 +1133,7 @@
{
"listen": "test",
"script": {
"id": "91437758-8d9e-4181-9d6e-5b6ed4fc3adb",
"id": "a838290f-01a3-41cb-92d0-4371a4351848",
"type": "text/javascript",
"exec": [
"// Validate status 2xx \npm.test(\"[GET]::/facets/:facets - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n",
Expand Down Expand Up @@ -1171,7 +1171,7 @@
}
],
"info": {
"_postman_id": "bb7e8047-f3a9-4c4b-b5df-e72446d8a7a4",
"_postman_id": "279e22eb-f3da-46ac-a1c6-e3629efd0bba",
"name": "Intelligent Search API",
"version": {
"raw": "0.1.12",
Expand Down
Loading
Loading