Delivery Integration

4 API calls in this section.

Get Delivery Integration Settings

Restaurant Menu / Delivery Integration

GET/restaurant/delivery-integration

Read how the restaurant connects to its delivery service.

Headers

Parameter	Type	Description
Authorization	string	Example: Bearer {{access_token}}

Staging

Request

curl

1curl --globoff --request GET "https://staging-api.ondi.io/functions/v1/restaurant/delivery-integration" \2  --header "Authorization: Bearer ${ONDI_ACCESS_TOKEN}"

Response examples

No saved response example. Use Try it to inspect a staging response.

Upsert Delivery Integration Settings

Restaurant Menu / Delivery Integration

PUT/restaurant/delivery-integration

Save delivery integration mode, connection settings, retry behavior and default service.

Headers

Parameter	Type	Description
Authorization	string	Example: Bearer {{access_token}}

Body parameters

Parameter	Type	Description
mode	string	—
status	string	—
external_base_url	string	—
external_api_key	string	—
webhook_secret	null	—
timeout_ms	number	—
retries	number	—
default_delivery_service_id	string	—

Staging

Request

curl

1curl --globoff --request PUT "https://staging-api.ondi.io/functions/v1/restaurant/delivery-integration" \2  --header "Authorization: Bearer ${ONDI_ACCESS_TOKEN}" \3  --header "Content-Type: application/json" \4  --data-raw '{5  "mode": "external",6  "status": "draft",7  "external_base_url": "https://external-tenant-edge-url",8  "external_api_key": "od_xxx",9  "webhook_secret": null,10  "timeout_ms": 15000,11  "retries": 3,12  "default_delivery_service_id": "{{delivery_service_id}}"13}'

Replace {{placeholders}} with your own values before sending.

Response examples

No saved response example. Use Try it to inspect a staging response.

Test & Activate External Delivery Integration

Restaurant Menu / Delivery Integration

POST/restaurant/delivery-integration/test

Check the supplied external delivery connection and activate a successful integration.

Headers

Parameter	Type	Description
Authorization	string	Example: Bearer {{access_token}}

Body parameters

Parameter	Type	Description
mode	string	—
external_base_url	string	—
external_api_key	string	—
default_delivery_service_id	string	—
timeout_ms	number	—
retries	number	—

Staging

Request

curl

1curl --globoff --request POST "https://staging-api.ondi.io/functions/v1/restaurant/delivery-integration/test" \2  --header "Authorization: Bearer ${ONDI_ACCESS_TOKEN}" \3  --header "Content-Type: application/json" \4  --data-raw '{5  "mode": "external",6  "external_base_url": "https://external-tenant-edge-url",7  "external_api_key": "od_xxx",8  "default_delivery_service_id": "{{delivery_service_id}}",9  "timeout_ms": 15000,10  "retries": 311}'

Replace {{placeholders}} with your own values before sending.

Response examples

No saved response example. Use Try it to inspect a staging response.

List External Delivery Services (via Restaurant)

Restaurant Menu / Delivery Integration

GET/restaurant/delivery-integration/services

Browse delivery services exposed through the restaurant’s external integration.

Query parameters

Parameter	Type	Description
delivery_type_code	string	Example: ondemand
active	string	Example: true

Headers

Parameter	Type	Description
Authorization	string	Example: Bearer {{access_token}}

Staging

Request

curl

1curl --globoff --request GET "https://staging-api.ondi.io/functions/v1/restaurant/delivery-integration/services?delivery_type_code=ondemand&active=true" \2  --header "Authorization: Bearer ${ONDI_ACCESS_TOKEN}"

Response examples

No saved response example. Use Try it to inspect a staging response.