How to Integrate#

This section covers the basics of how to integrate. Click these links below to access each section of the integration process as required, or simply scroll down the page:

• Integration prerequisites

• What do you need to develop to complete the integration?

• Token management & access

• Accessing Production Endpoints

Integration prerequisites#

To be eligible for this integration, you must have the following:

• API Development Capability – The ability to develop an API in-house or access third-party support for API development

• Technical Readiness – You must have the technical capacity and infrastructure to receive order updates to your webhook

If you satisfy both of these requirements, you are ready & able to start the integration journey.
To integrate with our Partner API, you also must be one of our partners and ensure that you have:

• Access to Partner Portal: A back office tool by which you can monitor orders, store operations, export orders, manage assortment across multiple stores.

  • Click here for more information on what’s Partner Portal

• Access to the Integrations Plugin: Allows you to configure webhook and generate webhook.

  • Click here for more information on how to access the Shops Integrations Plugin

• Possess an Active Store: You should have store setup in our platform and corresponding integration type configurations to be enabled in our catalog (check with your Account Manager)

What do you need to develop to complete the integration?#

At the high level, there are two things you need to do:

1. Set Up a Webhook to receive Order Events

   • Develop a webhook to receive live order updates throughout the order lifecycle i.e READY_FOR_PICKUP & CANCELLED

   • Webhook can be configured in your Partner Portal and can be secured using your custom secret key, it can be any string or basic auth token

     Securing your webhook is mandatory!

     Please check FAQs.

2. Integrate with Partner API Endpoints:

• In order to use GET endpoints you will need your chainID. You can request it from your Account Manager or find it directly in your Shops Integrations plugin in the URL. For example:

• Use the GET endpoint to retrieve order information from the past 60 days whenever required

Token Management & Access#

What is a token & how do I use it?#

A Bearer API token verifies who you are when calling an Partner API. It follows the OAuth 2.0 standard and is included in request headers to confirm that you have permission to access the requested resources.

How It Works#

• Generate – You can generate client ID & secret directly from Partner Portal or contact your Account Manager to get this information.

• Receive - By sending the API request with generated Client ID and Secret, you will receive an OAuth 2.0 bearer token that is valid for 2 hours.

• Use the Token – Every time you make an API request, you must include the OAuth 2.0 bearer token in the header

Why OAuth 2.0#

• Improved security Static tokens pose long-term security risks if exposed. OAuth 2.0 tokens expire automatically, greatly reducing risk.

• Higher reliability Expired or invalid tokens are refreshed automatically, preventing unexpected integration downtime.

• Future compatibility New features and enhancements will only be supported on Partner API (/v2) with OAuth 2.0 authentication.

Steps for Authentication & API Access#

Generate an API Token

• Step 1: Generate client_id and client_secret from Secret Management section of Partner Portal or check with Account Manager

  

• Step 2: To generate an access token, send a POST request to the token endpoint. Ensure the request uses application/x-www-form-urlencoded and includes the parameters grant_type, client_id, and client_secret. Check API Specification here

https://pedidosya.partner.deliveryhero.io/v2/oauth/token

• Step 3: Now you can proceed with your Partner API request by Including your access_token in the Authorization header. Prefix your access_token with the string Bearer  For example:

Authorization: Bearer <access_token>

Important things to remember about API tokens#

• Secure your client_id and client_secret, this is what you will need each time to request a token

• You can create up to 10 client_id in your chain

• When you create a token, they expire in 2 hours.

• Generated token is valid for all stores under your chain

• In order to gain access Partner Portal or Shops Integrations, please reach out to your account manager

Production Endpoints: Partner API/Orders#

• You can find an exhaustive list of endpoints available here.

• You can access platform-level production environments by region here