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

   • 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 is a way to prove who you are when making API requests. It’s part of the OAuth 2.0 standard and is included in the request headers to show that you’re allowed to access certain data or services.

How It Works#

1. Get the Token – using the Shops Integrations Plugin

2. Use the Token – Every time you make an API request, you include the token in the header

Why It’s Useful#

1. No need for usernames and passwords in every request

2. The server doesn’t have to remember who you are (it just checks the token)

What do I need to access it?#

You should have Admin access, for Shops Integrations Plugin in Partner Portal to generate the bearer API token. You can see this information step-by-step below.

Steps for Authentication & API Access#

1. Generate an API Token

   • Step 1: Go to Partner Portal > Shop Integrations.

   • Step 2: Go to Settings > API > Token Management section, input a name based on your use case.

   • Step 3: Generate a Bearer token. You can create up to 11 tokens, and they have no expiry.

2. Secure Your Tokens

   • Ensure tokens are securely stored and not shared with support teams

Here’s how to generate your token

Important things to remember about API tokens#

1. When you create a token, they never expire! Please secure and keep track of your API tokens, and never share them with other people, even our support team

2. Each API token should be assigned a specific name corresponding to its intended use case i.e: Catalog Management, Order Management, Promotion Management

3. Up to 11 tokens can be created at one time

4. Tokens are valid for all stores under your chain

5. Since tokens are managed via the Shops Integrations Plugin, it’s advisable to limit the access to that plugin to the people in your organisation who absolutely need it.

6. In order to 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