Skip to content

chore: remove manual Index section from Delivery Promise Suggestions API overview #1684

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

Open
PedroAntunesCosta wants to merge 4 commits into
base: master
Choose a base branch
from
Open

chore: remove manual Index section from Delivery Promise Suggestions API overview #1684

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fef7ecf
chore: remove manual Index section from Delivery Promise Suggestions …
PedroAntunesCosta May 18, 2026
390fbb6
chore: update postman files
May 18, 2026
cc06214
Merge branch 'master' into chore/remove-index-delivery-promise-sugges…
karenkrieger Jun 23, 2026
41e1030
chore: update postman files
Jun 23, 2026
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
54 changes: 27 additions & 27 deletions PostmanCollections/VTEX - Delivery Promise Suggestions API.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
{
"_": {
"postman_id": "b2dd1eb8-30c4-48bf-b632-fdc0ba1b2b04"
"postman_id": "ad56b4c2-3d72-4a08-8d01-401eef773057"
},
"item": [
{
"id": "f4acc0fc-35db-4062-bb79-5383e94f21c9",
"id": "f6a9b51f-9e5d-490a-861f-7115ef82ba5f",
"name": "Logistics shipping",
"description": {
"content": "",
"type": "text/plain"
},
"item": [
{
"id": "02ee6e4d-b85f-4e34-889a-e3f072fd00c2",
"id": "c25eedae-bdab-4dda-a229-1af2f12f78ce",
"name": "Search delivery zones",
"request": {
"name": "Search delivery zones",
Expand Down Expand Up @@ -99,7 +99,7 @@
"_": {
"postman_previewlanguage": "json"
},
"id": "e0c345eb-fb43-40d6-ad9c-58f7e283d985",
"id": "7088ea9f-6ac8-4389-b4ce-09b2fa1b2907",
"name": "OK",
"originalRequest": {
"url": {
Expand Down Expand Up @@ -180,7 +180,7 @@
{
"listen": "test",
"script": {
"id": "84c5cba0-b3cb-45fb-90a7-4356a006f842",
"id": "ce671807-3a7b-48c3-9050-8e1b4d360438",
"type": "text/javascript",
"exec": [
"// Validate status 2xx \npm.test(\"[POST]::/api/logistics-shipping/delivery-zones/_search/v2 - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n",
Expand All @@ -196,7 +196,7 @@
}
},
{
"id": "8bc43e99-931c-4aa7-a76a-999103da08ac",
"id": "116814fb-439b-4084-86d6-7ed618d51ee5",
"name": "Search pickup points",
"request": {
"name": "Search pickup points",
Expand Down Expand Up @@ -292,7 +292,7 @@
"_": {
"postman_previewlanguage": "json"
},
"id": "8c7b0d07-3189-41ea-9d31-12cb7c97ff99",
"id": "6b735304-28a6-4ed6-a720-f2921ba5f8d9",
"name": "OK",
"originalRequest": {
"url": {
Expand Down Expand Up @@ -382,7 +382,7 @@
{
"listen": "test",
"script": {
"id": "5fb199aa-33ae-4ed3-b73e-e68570830a9f",
"id": "2cbdc1f8-0b2f-47df-9ee8-a8fa9c87092e",
"type": "text/javascript",
"exec": [
"// Validate status 2xx \npm.test(\"[POST]::/api/logistics-shipping/pickuppoints/_search - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n",
Expand All @@ -401,15 +401,15 @@
"event": []
},
{
"id": "74b96611-0efb-4851-9416-8592250acf3a",
"id": "955ef5a5-4d3b-448b-a750-5e6b96661aa5",
"name": "Delivery suggestions",
"description": {
"content": "",
"type": "text/plain"
},
"item": [
{
"id": "77e76ed5-7ef7-4dca-b833-a3021a745991",
"id": "bd7a9fbb-8681-4dd1-904b-adf321b636a5",
"name": "Search delivery suggestions",
"request": {
"name": "Search delivery suggestions",
Expand Down Expand Up @@ -494,7 +494,7 @@
"_": {
"postman_previewlanguage": "json"
},
"id": "43e80d63-df97-4b76-9261-4fb795f870bf",
"id": "fa7c003c-e68f-4dbf-a0e2-1d36eb4f84e3",
"name": "OK",
"originalRequest": {
"url": {
Expand Down Expand Up @@ -572,7 +572,7 @@
"_": {
"postman_previewlanguage": "json"
},
"id": "38900783-d640-4577-b6f0-ab97de411f34",
"id": "2f40950d-a961-4533-9216-9000b1da03f3",
"name": "The products array cannot be empty.",
"originalRequest": {
"url": {
Expand Down Expand Up @@ -650,7 +650,7 @@
"_": {
"postman_previewlanguage": "json"
},
"id": "55c24ad6-3c17-40b8-b05f-729bbd4a9b5e",
"id": "25c651c8-277e-4f83-be76-43419cb4883a",
"name": "The maximum number of products allowed is 20.",
"originalRequest": {
"url": {
Expand Down Expand Up @@ -728,7 +728,7 @@
"_": {
"postman_previewlanguage": "json"
},
"id": "8f1c5bc4-4912-4934-a7f0-94702c5fbae5",
"id": "c1370f35-fca2-4e79-8396-d65583187c90",
"name": "The product list cannot be empty.",
"originalRequest": {
"url": {
Expand Down Expand Up @@ -806,7 +806,7 @@
"_": {
"postman_previewlanguage": "json"
},
"id": "57e73d7e-86b0-4a37-8e75-2a445b1e51eb",
"id": "080f04ac-fe44-40a9-89f7-3b91ea6dbbb2",
"name": "Unauthorized",
"originalRequest": {
"url": {
Expand Down Expand Up @@ -884,7 +884,7 @@
"_": {
"postman_previewlanguage": "json"
},
"id": "0f48f219-c442-40f7-936c-c5c40a082660",
"id": "e45e4944-dc52-4b67-bc89-88bce7a48ce8",
"name": "Forbidden",
"originalRequest": {
"url": {
Expand Down Expand Up @@ -962,7 +962,7 @@
"_": {
"postman_previewlanguage": "json"
},
"id": "17f0571f-f117-4f24-8991-fdf06a2236a4",
"id": "b3d30f4f-74a1-408a-b552-c95f62965878",
"name": "Too Many Requests",
"originalRequest": {
"url": {
Expand Down Expand Up @@ -1040,7 +1040,7 @@
"_": {
"postman_previewlanguage": "json"
},
"id": "f73e6474-dc82-4672-8330-62df625ff9cb",
"id": "090da20f-53e8-41f3-adc0-e745d5bdb6d7",
"name": "Internal Server Error",
"originalRequest": {
"url": {
Expand Down Expand Up @@ -1119,7 +1119,7 @@
{
"listen": "test",
"script": {
"id": "7cc5ec32-2dbf-4437-a1bb-95afca939d32",
"id": "4bb0ee61-b9d1-4fe7-acdc-106b3243516b",
"type": "text/javascript",
"exec": [
"// Validate status 2xx \npm.test(\"[POST]::/api/delivery-promise-suggestions/_search - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n",
Expand All @@ -1135,7 +1135,7 @@
}
},
{
"id": "da497efd-3e35-4be4-88b9-0478dab625f0",
"id": "008c6a65-2066-4264-907d-005d2967fd98",
"name": "Get delivery suggestions",
"request": {
"name": "Get delivery suggestions",
Expand Down Expand Up @@ -1243,7 +1243,7 @@
"_": {
"postman_previewlanguage": "json"
},
"id": "011c0285-52b6-48ea-b654-ce65420834b2",
"id": "5a110f5c-6ce7-4937-9d0e-f363676cc113",
"name": "OK",
"originalRequest": {
"url": {
Expand Down Expand Up @@ -1344,7 +1344,7 @@
"_": {
"postman_previewlanguage": "json"
},
"id": "9d217f2a-0990-4257-b74c-782efd6ca405",
"id": "79ed222c-23c0-416a-a20c-5a82d24b13f7",
"name": "Unauthorized",
"originalRequest": {
"url": {
Expand Down Expand Up @@ -1445,7 +1445,7 @@
"_": {
"postman_previewlanguage": "json"
},
"id": "b0451452-f100-4e9d-ab6d-10f0deaaeb1b",
"id": "92df458a-69d2-4a93-8488-da5c67b25a3d",
"name": "Too Many Requests",
"originalRequest": {
"url": {
Expand Down Expand Up @@ -1546,7 +1546,7 @@
"_": {
"postman_previewlanguage": "json"
},
"id": "7247654f-ab13-40fd-b155-c307014c3e3d",
"id": "25bdbe1c-8b9b-45a2-a00a-637353842671",
"name": "Internal Server Error",
"originalRequest": {
"url": {
Expand Down Expand Up @@ -1648,7 +1648,7 @@
{
"listen": "test",
"script": {
"id": "d0310126-c7a8-4470-9cc3-9e13bb8c412a",
"id": "b3dc3d68-e016-4dd2-a9b8-5a1ccc843f08",
"type": "text/javascript",
"exec": [
"// Validate status 2xx \npm.test(\"[GET]::/api/delivery-promise-suggestions - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n",
Expand Down Expand Up @@ -1686,11 +1686,11 @@
}
],
"info": {
"_postman_id": "b2dd1eb8-30c4-48bf-b632-fdc0ba1b2b04",
"_postman_id": "ad56b4c2-3d72-4a08-8d01-401eef773057",
"name": "Delivery Promise Suggestions API",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
"description": {
"content": "The Delivery Promise Suggestions API provides real-time suggestions for delivery and pickup options based on product availability, user location, and fulfillment context for stores that use [Delivery Promise](https://help.vtex.com/docs/tutorials/delivery-promise-beta) and [Delivery Options](https://help.vtex.com/en/docs/tutorials/delivery-options-beta). It helps optimize the customer shopping experience by suggesting the best fulfillment options for each product. \r\n\r\n>ℹ️ This API is in beta, which means that we are working to improve it. If you have any questions, please contact our [Support Center](https://support.vtex.com/hc/en-us/requests).\r\n\r\n## Index\r\n\r\n### Logistics Shipping\r\n\r\n- `POST` [Search delivery zones](https://developers.vtex.com/docs/api-reference/delivery-promise-suggestionss-api#post-/api/logistics-shipping/delivery-zones/_search/v2)\r\n- `POST` [Search pickup points](https://developers.vtex.com/docs/api-reference/delivery-promise-suggestionss-api#post-/api/logistics-shipping/pickuppoints/_search)\r\n\r\n### Delivery Promise Suggestions\r\n\r\n- `POST` [Search delivery suggestions](https://developers.vtex.com/docs/api-reference/delivery-promise-suggestionss-api#post-/api/delivery-promise-suggestions/_search)\r\n- `GET` [Get delivery suggestions](https://developers.vtex.com/docs/api-reference/delivery-promise-suggestionss-api#get-/api/delivery-promise-suggestions)",
"content": "The Delivery Promise Suggestions API provides real-time suggestions for delivery and pickup options based on product availability, user location, and fulfillment context for stores that use [Delivery Promise](https://help.vtex.com/docs/tutorials/delivery-promise-beta) and [Delivery Options](https://help.vtex.com/en/docs/tutorials/delivery-options-beta). It helps optimize the customer shopping experience by suggesting the best fulfillment options for each product. \r\n\r\n>ℹ️ This API is in beta, which means that we are working to improve it. If you have any questions, please contact our [Support Center](https://support.vtex.com/hc/en-us/requests).",
"type": "text/plain"
}
}
Expand Down
2 changes: 1 addition & 1 deletion VTEX - Delivery Promise Suggestions API.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"openapi": "3.0.0",
"info": {
"title": "Delivery Promise Suggestions API",
"description": "The Delivery Promise Suggestions API provides real-time suggestions for delivery and pickup options based on product availability, user location, and fulfillment context for stores that use [Delivery Promise](https://help.vtex.com/docs/tutorials/delivery-promise-beta) and [Delivery Options](https://help.vtex.com/en/docs/tutorials/delivery-options-beta). It helps optimize the customer shopping experience by suggesting the best fulfillment options for each product. \r\n\r\n>ℹ️ This API is in beta, which means that we are working to improve it. If you have any questions, please contact our [Support Center](https://support.vtex.com/hc/en-us/requests).\r\n\r\n## Index\r\n\r\n### Logistics Shipping\r\n\r\n- `POST` [Search delivery zones](https://developers.vtex.com/docs/api-reference/delivery-promise-suggestionss-api#post-/api/logistics-shipping/delivery-zones/_search/v2)\r\n- `POST` [Search pickup points](https://developers.vtex.com/docs/api-reference/delivery-promise-suggestionss-api#post-/api/logistics-shipping/pickuppoints/_search)\r\n\r\n### Delivery Promise Suggestions\r\n\r\n- `POST` [Search delivery suggestions](https://developers.vtex.com/docs/api-reference/delivery-promise-suggestionss-api#post-/api/delivery-promise-suggestions/_search)\r\n- `GET` [Get delivery suggestions](https://developers.vtex.com/docs/api-reference/delivery-promise-suggestionss-api#get-/api/delivery-promise-suggestions)",
"description": "The Delivery Promise Suggestions API provides real-time suggestions for delivery and pickup options based on product availability, user location, and fulfillment context for stores that use [Delivery Promise](https://help.vtex.com/docs/tutorials/delivery-promise-beta) and [Delivery Options](https://help.vtex.com/en/docs/tutorials/delivery-options-beta). It helps optimize the customer shopping experience by suggesting the best fulfillment options for each product. \r\n\r\n>ℹ️ This API is in beta, which means that we are working to improve it. If you have any questions, please contact our [Support Center](https://support.vtex.com/hc/en-us/requests).",
"contact": {},
"version": "1.0"
},
Expand Down