Passive Delivery Service Integration Module

Introduction

Connect your on-demand delivery company or your delivery software platform to OpenQloud (asking OpenQloud to consume your APIs and listen to your webhooks). Applies whether you run the fleet/logistics or you provide the platform used by multiple fleets.

Passive integration

Passive Integration Only

This guide is ONLY for passive integrations, understood as integrations in which OpenQloud will consume your API services and listen your webhooks. If you don't have your own API and webhook notifications and you are not planning to develop them, please go to delivery service active integration docs.

Integration level

In OpenQloud we have different integration module types. For a delivery service integration module, we have different module features in order to help the restaurant to understand the benefits of contracting the module. All features are optional and defined by the limits of the company developing the integration and the company providing API or services webhook.

Integration requirements

For a full integration, we would need all these API services and webhooks:

API SERVICES

POST Delivery

Service/s to create a new delivery delegated to your delivery company

GET Delivery

Service/s to get the delivery information of a previously created delivery

GET Delivery Status

Service/s to get the delivery status of a previously created delivery

POST/PATCH Delivery Status

Service/s to change the status of a previously created delivery

GET Availability

Service/s to get your delivery service availability (zones, areas, postal codes, schedules, shifts, calendar exceptions, ...). We support zones definitions by geojsons.

WEBHOOK NOTIFICATIONS

The webhook notifications are POST/PUT requests thrown by your system to a specific endpoint we provide.

Delivery status changed

Notification you send for a delivery status change

Delivery driver position changed

Notification you send for a driver's position change

Availability changed

Notification you send for a delivery availability change from your side

Webhook Endpoint

We will provide an endpoint to receive your notifications. Example: https://integrations.openqloud.com/{your-delivery-code}/webhooks/{any-other-data}

OTHER REQUIREMENTS

API and webhooks docs - Document or whatever you normally use to document your API for third-party developers
Restaurant test account - An account to test and ideally access to the restaurant's dashboard
Sandbox and production credentials - API keys or equivalent for production environment, and ideally, for sandbox/test environments

Data model

As this integration is passive, we adapt our data to your data model (to consume API services and understand the webhooks). In order to show you examples of these entities, we invite you to check the delivery service active integration docs.

Integration request

If you already have your API and webhooks docs and you want OpenQloud to develop the integration module, please send us an email to integrations@openqloud.com

We'll provide a document explaining which features have been integrated and which ones were not integrated and the reasons, and of course, we'll attend any validation session if it's considered in your workflow.