Urban Piper Integration User Guide: Seamless Sync with ONDC through PaiPai

Created by Surya Boddu, Modified on Thu, 13 Jun, 2024 at 5:47 PM by Surya Boddu

1.0 Overview

PaiPai has streamlined the connection between businesses of all sizes and Urban Piper, a significant player in e-commerce. This collaboration enables Urban Piper users to seamlessly link up with the Open Network for Digital Commerce (ONDC) through PaiPai, simplifying their entry into selling on ONDC. This partnership acts as a smooth conduit, empowering Urban Piper businesses to effortlessly expand their online presence.

Within their Urban Piper accounts, users have the flexibility to tweak various elements such as products, product groups, categories, and outlets. Thanks to this integration, any adjustments made within the Urban Piper account swiftly sync with the PaiPai system. Consequently, this synchronization ensures that relevant ONDC listings promptly reflect these modifications.


1.1 Conditions

For you to proceed with the integration, certain conditions must be met.

  1. You must have your Urban Piper account already created. If you still need to, please complete your account creation.

  2. You must have your PaiPai account already created. If you still need to, please complete your account creation.

Once you have created both of these accounts, you can proceed with integrations.

1.2 How does this work?

PaiPai has upgraded its capabilities by allowing Upstream APIs to link up with various e-commerce platforms. The connection between PaiPai and Urban Piper is made possible through webhooks, ensuring smooth data transfer. This setup guarantees that any modifications users make to their catalog, inventory, items, or locations on their Urban Piper Account will seamlessly reflect in the PaiPai system.

Moreover, this integration extends to orders and deliveries. So, when a customer makes an order using the PaiPai system, it will automatically show up in their Urban Piper account too.



1.3 Requirements

To enable this seamless integration and proper synchronization between both platforms, the following are required.

Webhook Configuration

The webhook configuration facilitates the data transfer between both Urban Piper and PaiPai accounts in real time. These webhooks handle the updates regarding the catalog, location, order, delivery, etc. 

PaiPai team provides a set of webhooks that need to be configured in the client’s Urban Piper account and here is an example of how those webhooks look.

To Configure these webhooks, the user must open their Urban Piper account.

On the left-side panel, click on Settings.

Under the Settings Menu, click on Webhooks.

Click on Add Webhook.

Enter the Webhook URL and select the event from the dropdown and click on create.

The webhook will be configured and appear under the webhooks page.

Configure the remaining webhooks in the same way.

Location ID

You need the location ID of the Urban Piper outlet to synchronise it with your PaiPai outlet. If there was no outlet already created in the Urban piper account, go through the following process and obtain the location ID.

Go to the locations module on the left-side panel.

Click on Add Location on the top-right corner.

Select Single.

Fill in the details and click on Next.

If you have catalogs for existing locations, you can choose to copy the catalogs from them or you can skip this step and add the catalog later.

Select the PaiPai Platform from the dropdown and finish the process.

Once the location is created, you can see it in the list in the locations module.

In the list, you can find the Location ID Column. You can choose the location ID of the outlet that you are configuring with your PaiPai outlet for later use.

2.0 Integration Process

2.1 Upstream Provider Settings

The first step in the Integration process is to ensure that the upstream provider for the account is set to Shopify on the PaiPai System

  • Navigate to the Accounts Module on the Left-side Panel

  • Click on Accounts Option

You will be able to see a list of all the Accounts in the PaiPai system.

  • Click on the Account that you are performing the Integration for.

You can find the Account by scrolling down the list or you can use the search bar.

  • Click on the Edit Button in the Overview Panel

  • In the Upstream Provider Panel select the Upstream Provider as Urban Piper

Click on Update to save the changes.

2.2 Get the Location and Make the Client Finish the Webhook Configuration

For this step, you need to share an email with the Client with a clear step-by-step guide on how they could Configure the webhooks and find the location ID.

You can find the template along with the guide below. Do not change anything other than the client’s name and send the email.

Email template:

Subject: Request for Webhook Configuration and Location ID for PaiPai Integration

Dear [Client’s Name],

I hope this email finds you well. To complete the integration process between your Urban Piper account and PaiPai Account, we require you to finish the configuration of webhooks for your urban piper account and also the Location ID of the outlet that you want to integrate with PaiPai. Here is a step-by-step guide to assist you in finishing the process.

Webhooks

To Configure these webhooks, the user must open their Urban Piper account.

On the left-side panel, click on Settings.

Under the Settings Menu, click on Webhooks.

Click on Add Webhook.

Enter the Webhook URL and select the event from the dropdown and click on create.

The webhook will be configured and appear under the webhooks page.

Configure the remaining webhooks in the same way.

Here is the webhook URLs that you need to configure.

[Insert the URL Table here]

Location ID

 If there was no outlet already created in the Urban piper account, go through the following process and obtain the location ID.

Go to the locations module on the left-side panel.

Click on Add Location on the top-right corner.

Select Single.

Fill in the details and click on Next.

If you have catalogs for existing locations, you can choose to copy the catalogs from them or you can skip this step and add the catalog later.

Select the PaiPai Platform from the dropdown and finish the process.

Once the location is created, you can see it in the list in the locations module.

In the list, you can find the Location ID Column. You can choose the location ID of the outlet that you are configuring with your PaiPai outlet




By following these steps you should have configured the webhooks and obtained the Location ID. Please, do not hesitate to contact our team in case you have any queries about the process.

We hope you can send us these details to [email] as soon as possible so that we can complete the configuration process.

Best Regards,

[Your Name]

[Your Postiion]

[Contact info]

Once you receive all these details from the customer you can proceed with the next step.

2.5 Enter the External Outlet ID (Location ID) on the Account Side

  • Once the upstream provider settings are configured on the system side, switch to the client’s account.

  • In the Business Module click on Outlets.

  • Click on the Outlet that you are integrating.

  • Go to the settings tab and Click on Edit.

  • Scroll down to find the Upstream Outlet Mapping and Enter the External Outlet ID(Location ID you obtained from the Client)

  • Click on Update to save the changes.



2.6 Catalog Push

After the configuration is complete, you need to push the catalog long from the Urban Piper account.

  • Go to the Locations Module.

  • Select the outlet that you are integrating.

  • Click on Publish

  • Select PaiPai and Click on Publish.


2.7 Verification of catalog push

  • Go to the account side of the client’s PaiPai account and go to Upstream Module.

  • You can see the Update Menu event registered in the list.

2.8 Configure C Taxonomy and G Taxonomy

Now you need to go back to the System side.

  • Go to Accounts Module 

  • Click on the Accounts Option

  • Click on the Account that you are integrating

  • In the Account Details screen click on the C Taxonomy Tab and Map the C Taxonomy

  • After configuring the C Taxonomy Click on the G Taxonomy


Click on the Actions dropdown on the top-right.

Select Sync Product Catalog to Master

Then go to ONDC add the new account under ONDC and follow the ONDC flow

2.9 Configuring for ONDC

  • Go to ONDC Module on the Left-side Panel

  • Click on Accounts

You will see the list of all the Accounts

  • Click on Add to ONDC Button on the top-right Corner

You will see a pop-up screen with entry fields

  • Enter the Details

  • Click on Add Button

The Account will be added to the ONDC and you can see it in the list of Accounts

  • Click on the Account to see the general info of the Account

  • Click on the Outlets tab

  • Map the Outlet


  • Now Click on the Items tab


  • Click on the Actions Dropdown and select Map all

The account is added to ONDC, and all the products and outlets are synced.


Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article