From an end to end workflow perspective, here is the how the IHD API can be utilized.
Definitions
OLOP: Online Ordering Solution Partner
Customer: End user ordering food or other deliverable items through an online ordering solution.
IHD: InhouseDelivery solution
DSP: Delivery Service Provider (e.g. Uber, Skipcart, Lyft etc)
Step 1: Authentication
IHD API uses authentication tokens for authorizing API usage. Using the Request Token end point, you create an authentication token using the API credentials you have been given and send it in the request header on all API calls. API tokens expire every 24 hours and must be renewed.
'Authorization: Bearer <API Token>'
Step 2: Requesting a quote
In order to get a delivery quote prior to the customer finalizing their order, you can utilize the Request Quote end point and select from a range of DSP quotes in real-time. Once you select the DSP you would like to go with, you are ready to create a delivery with the selected DSP.
Step 3: Create a delivery order
Once your customer has finalized their order, Create Delivery endpoint is used to submit all essential delivery details including pickup, dropoff, order items etc.
Step 4: Webhooks
Once a delivery order is created, IHD sends webhook delivery status notifications during the full life cycle of a delivery order (from creation to completion / failure). Ensure you have specified a webhook url using the webhook creation end point. Check out our documentation on webhooks here.