VROMO is setting a new standard for integrating last-mile delivery management software into your technology mix. In addition to our best-in-class software for streamlining restaurant deliveries and improving customer engagement, our API-first approach means we consume our own public API in developing the VROMO interface. This gives your team access to the same API endpoints that we use internally and the ability to utilize the vast majority of VROMO's functionality to build custom add ons, create deep integrations to other products or extend your own platform to add VROMO functionality such as:

• Create and view jobs
• Set the dispatch policy for the job created to trigger automatic job dispatch
• Assign, reassign, recall jobs manually
• Lookup and edit job details
• Assign tracking link marketing campaigns
• Keep track of your restaurant 'sites'

If you cannot find the relevant endpoint in the details below, please email our team at hello@vromo.io and we will happily assist.

If you are integrating an ordering platform or Point of Sales (POS) and want a simple create and dispatch or if you are integrating with an existing delivery partner start with the Core steps for integrating with an ordering app or delivery partner section after the glossary below.

https://api.vromo.io/v2/graph

VROMO requests are authenticated by including an access_token parameter in the url.

HTTP Request

GET https://api.vromo.io/v2/graph?access_token=API_TOKEN

Note: You will need to replace API_TOKEN with your API key. You will find the API token for a particular group by logging into VROMO with the administrator role, clicking on your avatar in the top right corner of the screen, then selecting 'integrations'. If you want to create and manage jobs in sub-teams in a company structure, it is best practice to set up your team structure first and use separate API keys in your integration.

JOB: An individual delivery. Jobs comprise of one or more tasks.

TASK: Tasks are the individual units of progress in a job, and can be applied in flexible ways depending on your purpose. For a typical restaurant delivery, you might create 4 tasks - Arrive at the restaurant, leave the restaurant, arrive at the customer and leave the customer. Note that in addition to the tasks, every job also has a global 'Start job' and 'Complete job' status that is presented to the driver.

SITE: An individual location from which deliveries will be collected. If you apply a site to a job you will be able to use site to filter the job list and reports in the VROMO interface. You can also use the site record to store default preferences for campaign and policy for a particular restaurant.

BLUEPRINT: A blueprint is used to simplify the job creation process. Jobs can be created on a blueprint and a site(typically with a blueprint attached). The blueprint transforms the most basic data needed to create a job (i.e. pickup location, customer address, customer latitude and longitude, customer contact details) into a more complete job according to how the blueprint is set up.

POLICY: A policy is a collection of rules that determine which drivers are offered unassigned jobs. When you create a job with a policy (optional), the job will automatically be offered to all drivers that adhere to the set of rules in that policy until a driver accepts the job, or the job is cancelled.

CAMPAIGN: A jobs campaign field determines the customer engagement settings for the job. These include the wording of the SMS, and the look and feel of the driver tracking page including any video and promotional content to be included.

JOB ATTRIBUTE: Since there is no universal set of fields that delivery teams like to add to a job, VROMO enables you to add any arbitrary number of additional fields using key:value pairs that we call 'job attributes'.

If you are starting in the same place as most ordering app and website integrations your first step will be using the VROMO API to create and view Jobs. If you are trying to assign the driver from your own system you'll also want to dispatch them at this point.

Creating a Job

To create an order ingestion integration it is first necessary to decide if orders should be created on Sites or Blueprints (a.k.a Job Templates). Sites are optimal for frequent orders for brick and mortar stores such as restaurants. Blueprints are often preferred for infrequent orders (e.g. a once off order for a restaurant) or orders where the pickup location is not a brick and mortar location.

To create a Job on a Site we recommend creating a Site with the `external` field populated. This allows integrations to create Jobs on Sites based on a third party's id for the store/restaurant. Following this, use the Site's external id to create a Job.

An alternative strategy is to always attempt to create the Job on a Site using the Site's External id and if the request returns a 404 error, create the Site, then try recreate the Job again.

Providing the `external` field for Sites and Jobs ensures idempotency therefore if either are created with an external id that already exists the existing item will be returned and not recreated.

To create a Job on a Blueprint you must have a known Blueprint (a.k.a Job Template) id stored.

Subscribing to updates

Webhooks receive notifications and status updates as jobs are updated and completed in the system. You can use the webhook endpoints to manage your webhooks. A successful integration should require only a single registered webhook to handle all job updates. The easiest way to implement them is to then treat every update for a particular job ID as a trigger to use the jobs endpoint to fetch the current status of all the fields of interest as the webhook itself contains just the updated information, not the entire state of the job.

Cancellation

If you need to cancel a previously created job (e.g. your customer has cancelled an order) you can use the update job endpoint to post a cancellation.

Dispatching the jobs to drivers

If you are integrating with a third-party delivery team using VROMO or are an ordering app linking to self-delivery teams then you probably won't send the jobs to individual drivers since you aren't responsible for those drivers. You might have an agreement to include a particular dispatch Policy on the job when you create it or to use a Site ID in order to assist the delivery team to automate the dispatch at their end however.

If you are intending to dispatch the jobs from within your system however, you have two options you can either allow your users to manually select a driver and then dispatch the job to them, or you can create the job with dispatch Policy, which will then start offering the job to rules. To dispatch to a specific driver, you just need to issue a Dispatch event for the job to be dispatched with the Vehicle ID of the driver to receive the job and with the type 'dispatched'. You'll see in the dispatches section the full details of issuing 'dispatched' Dispatches along with recalling jobs and manually marking them complete.

The Jobs endpoint gives you control over editing and querying Jobs.

Dispatch Jobs to drivers. Update the dispatch status of a Job, setting it to underway, started, or completed. Change assigned driver by reassigning, or recall the Job back into the unassigned queue.

Fetch, create, delete, and edit Sites, which can be considered as store/pickup locations.