ONDC is an ambitious initiative to democratize digital commerce by creating a decentralized network of buyer apps and seller apps through an interoperable protocol specification.
This comprehensive guide is designed to walk you through the process of integrating your digital commerce platform with the Open Network for Digital Commerce (ONDC). By following these steps, you'll enable seamless interoperability with the decentralized network, allowing your platform to leverage the benefits of ONDC.
- Getting Started
- Quick Start Guide
- The Protocol
- Subscription Process
- Signing and Verification
- Enabled Domains
- Reference Applications
- Utilities
- Taxonomies
- Product Requirement Documents (PRDs)
- Gateway and Registry Endpoints
- Network Observability for Production
- Catalog and Store Rejection
- Technical support
The ONDC Web Portal serves as a self-service platform that streamlines interaction between ONDC and its network participants across their entire lifecycle. "Network player" encompasses network participants, ecosystem partners, and other entities engaged with ONDC. The portal provides access to a range of services for network players, such as self-service onboarding, self-monitored compliance, and self-monitored operations. Creating an account on ONDC Web Portal is mandatory for starting your integration with ONDC.
ONDC Integration Guide is a roadmap designed to illuminate key resources and navigate through the integration journey.
Beckn is an open protocol that allows local businesses across any industry to be discovered and engaged by any beckn-enabled application. Beckn protocol is a collection of open specifications consisting of protocol APIs, message formats, network design and reference architectures to allow any two entities to execute commercial transactions without being on the same platform.
ONDC has provided the network extension layer over the Beckn Protocol (base layer). Over the base layer, the network extension layer comprises model specifications customised to the ONDC context that have been adopted in order to facilitate transactions over the network. For a detailed understanding of the ONDC network architecture, please refer to our Tech Briefing Presentation and Video.
To enroll in the ONDC network, Network Participants (NP) must be added to the registry. The steps for an NP to onboard onto the ONDC Registry (Staging, Pre Production, Production) are outlined as follows:
-
Staging Registry
- Obtain whitelisting for the subscriber ID.
- Initiate the subscription process by calling the /subscribe API. The complete process is documented here
-
Pre-Production Registry
After presenting a demo and receiving approval from the relevant team, follow the outlined process to be added to the Pre-Prod registry.
-
Production Registry Upon successfully completing functional testing and satisfying the final checklist in Pre-Production, an NP can transition to the the Production environment.
When communicating over HTTP using Beckn APIs, the subscribers need to authenticate themselves to perform transactions with other subscribers. Due to the commercial nature of the transactions, every request/callback pair is considered to be a "contract" between two parties. Therefore, it is imperative that all requests and callbacks are digitally signed by the sender and subsequently verified by the receiver.
The complete process is documented here.
Tip
Stuck somewhere? Refer these frequently asked questions and answers!
Network Participants are requested to refer to the list here for ONDC defined domains and respective codes, across all environments (Staging, Pre-production and Production). The list will be updated as in when required.
Below are links to the comprehensive developer guide and model implementations for the enabled domains.
-
This domain encompasses subcategories such as grocery (RET10), food and beverages (RET11), fashion (RET12), electronics (RET14), home & decor (RET15), beauty and personal care (RET13), etc. It facilitates seamless transactions in both B2C and B2B modes, offering a comprehensive shopping experience for consumers and businesses alike.
Domain | API Contract/ Developer Guide | Test Scenarios | Log Utility | Mock Server/ Sandbox/ Reference Application | FAQs |
---|---|---|---|---|---|
B2C Retail | - API Contract v1.2.0 - Retail Developer Guide - select version: draft-1.x - Taxonomy |
B2C Test Scenarios | - Log Validation Utility - Manual Logs Checklist |
Reference BA/ SA - Staging - Pre-Prod |
B2C Retail FAQs |
B2C Exports | - Retail Developer Guide - select version: b2c_exports_2.0 - Taxonomy |
NA | B2C Exports Log Verification | Sandbox | NA |
It is important to implement Catalog & Store Rejection Framework for the Retail B2C domain. The documentation is here.
Domain | API Contract/ Developer Guide | Test Scenarios | Log Utility | Mock Server/ Reference Application | FAQs |
---|---|---|---|---|---|
B2B Retail | - API Contract v2.0.2 - Retail Developer Guide - select version: release-2.0.2 - Taxonomy |
B2B Test Case Scenarios | B2B Log Verification | Sandbox | NA |
- This domain streamlines the acquisition of on-network logistics services, providing logistics buyers with a variety of choices for flexible solutions that suit their specific needs.
Domain | API Contract/ Developer Guide | Test Scenarios | Log Utility | Mock Server/ Sandbox/ Reference Application | FAQs |
---|---|---|---|---|---|
B2C Logistics | B2C Logistics v1.2 | Test Case Scenarios - B2C Logistics | B2C Logistics Log Verification | Reference LSP - Staging - Pre-Prod |
B2C Logistics FAQs |
B2B Logistics | - B2B Logistics v2.0 - Logistics Developer Guide - select version: draft-2.x |
NA | B2B Logistics Log Verification | Sandbox | NA |
- This domain facilitates easy access to a spectrum of financial solutions, covering loans, insurance, investments.
Domain | API Contract/ Developer Guide | Test Scenarios | Log Utility | Mock Server/ Sandbox/ Reference Application | FAQs |
---|---|---|---|---|---|
Financial Services | - PRD - Financial Services Developer Guide Select version: - For Personal Loan: release-FIS12-2.0.0 - For Invoice-based Loan: draft-FIS12-invoice-2.1.0 - For Health Insurance: draft-health - For Motor Insurance: draft-motor - For Marine Insurance: draft-marine - For Investments: draft-FIS14-enhancements |
Refer to LogSubmission-UI in the developer guide | FIS Log Verification | Refer to Sandbox-UI in the developer guide | Financial Services FAQs |
Gift Cards | API Specifications | NA | NA | NA | NA |
- This domain enables easy access to a range of travel-related services, covering On-demand Ride hailing with various transport modes, ticket booking without designated seat, airlines, hotels, intercity bus, entry ticket pass, etc.
Domain | API Contract/ Developer Guide | Test Scenarios | Log Utility | Mock Server/ Sandbox/ Reference Application | FAQs |
---|---|---|---|---|---|
Travel & Tourism/ Mobility | - PRD - Mobility Specifications Developer Guide Select version: - For On-demand Ride hailing: release-TRV10-2.0.1 - For Unreserved Ticket Booking (metro/intracity bus): release-TRV11-2.0.0 - For Intercity Bus Ticket Booking: draft-TRV12-intercity - For Airlines Booking: draft-TRV12-airline - For Hotel Booking: draft-TRV13-hotel - For Unreserved Entry Pass (heritage sites, museums, concerts, etc.): draft-TRV14-2.0.0 |
Refer to LogSubmission-UI in the developer guide | Mobility Log Verification | Refer to Sandbox-UI in the developer guide | Mobility FAQs |
- This domain empowers individuals to effortlessly access a diverse array of services, covering skilled services like home painting, chefs and consulations, auction of agricultural outputs, leasing farming machinery and tools, soil testing, assaying services, lab testing, subscriptions, etc.
Domain | API Contract/ Developer Guide | Test Scenarios | Log Utility | Mock Server/ Sandbox/ Reference Application | FAQs |
---|---|---|---|---|---|
Services | - PRD - v2.0.0 - Services Developer Guide Select version: - For Skilled Services: release-services - For Auction of Agricultural Outputs: draft-agri_bids_and_auction - For Equipment Hiring (leasing farming machinery and tools): draft-agri_equipment - For Soil Testing and Assaying Service: draft-agri_services - For Healthcare Services (Lab Test Booking): draft-healthcare |
NA | Services Log Verification | Sandbox | Services FAQs |
Domain | API Contract/ Developer Guide | Test Scenarios | Log Utility | Mock Server/ Sandbox/ Reference Application | FAQs |
---|---|---|---|---|---|
Media, Entertainment, Content (MEC) | - PRD - v2.0.0 - Media, Entertainment, Content Developer Guide |
NA | NA | NA | NA |
-
- Issue & Grievance Management (IGM) within the ONDC Network serves as a critical mechanism for resolving disputes and concerns among Network Participants (NPs).
- Reconcillation and Settlement Framework (RSF) plays a pivotal role in maintaining a comprehensive trail of settlements between Network Participants.
- Rating
- Score
Domain | API Contract/ Developer Guide | Test Scenarios | Log Utility/ Sandbox | Mock Server/ Reference Application | FAQs |
---|---|---|---|---|---|
IGM | Developer Guide v2.0.0 select version: draft-igm-2.0.0 |
NA | NA | NA | IGM FAQs |
RSF | Developer Guide v2.0.0 select version: draft-rsf-2.0.0 |
Test case scenarios - RSF 2.0 | Refer to this document for testing | NA | RSF FAQs |
Rating | v1.2.0 | NA | NA | NA | NA |
Score | v1.2.0 | NA | NA | NA | NA |
Overview
The Buyer and Seller Reference Applications are available in staging and pre-production environments. These applications enable network participants (NPs) to test their APIs, services, and integrations independently, ensuring compliance with ONDC protocol specifications.
Key Features
- Sandbox environment for testing both positive and negative scenarios.
- Direct submission of logs to ONDC for verification.
- Supports scalability, security, and compliance testing.
The network participants need to complete the end-to-end testing with ONDC reference applications.
Domain | Service Type | Buyer App | Onboarding Process/Point of Contact | Seller App | Onboarding Process/Point of Contact |
---|---|---|---|---|---|
Financial Services | Personal Loan | https://credit.staging.cliniq360.com/ | Email "[email protected]" to get the login credentials | ondc.fis12.seller.cornex.in | Fill onboarding form or Email "[email protected]" for onboarding. |
Invoice based loan | https://cornex.in | Fill onboarding form or Email "[email protected]" for onboarding. | ondc.fis12.seller.cornex.in | Fill onboarding form or Email "[email protected]" for onboarding. | |
Marine Insurance | https://cornex.in | Fill onboarding form or Email "[email protected]" for onboarding. | https://ondc-ref-app.sequelstring.com/staging/mock/seller | - | |
Motor Insurance | https://cornex.in | Fill onboarding form or Email "[email protected]" for onboarding. | https://ondc-ref-app.sequelstring.com/staging/mock/seller | - | |
Health Insurance | https://credit.staging.cliniq360.com/ | Email "[email protected]" to get the login credentials | https://ondc-ref-app.sequelstring.com/staging/mock/seller | - |
Domain | Service Type | Buyer App | Onboarding Process/Point of Contact | Seller App | Onboarding Process/Point of Contact |
---|---|---|---|---|---|
Mobility | Ride Hailing | https://ondc-ref-app.sequelstring.com/staging/gui/buyer | Process for NP to access the environment: Please send the following info on email, please write to Mrityunjay and keep amit and nirdosh in cc:
|
https://ondc-ref-app.sequelstring.com/staging/mock/seller | For Support, please refer to the details below: Mrityunjay Kumar
|
Metro | https://ondc-ref-app.sequelstring.com/staging/gui/buyer | Process for NP to access the environment: Please send the following info on email, please write to Mrityunjay and keep amit and nirdosh in cc:
|
https://ondc-ref-app.sequelstring.com/staging/mock/seller | For Support, please refer to the details below: Mrityunjay Kumar
|
Domain | Service Type | Buyer App | Onboarding Process/Point of Contact | Seller App | Onboarding Process/Point of Contact |
---|---|---|---|---|---|
B2B | Retail | https://play.google.com/store/apps/details?id=com.placeorder.app.referance.preprod&pcampaignid=web_share | Email "[email protected]" OR "[email protected]" to get the login details. Support Contact from Acelr Tech Labs Pvt. Ltd. (Rapidor)
|
ondc.sellerstagingref.rapidor.co | Email "[email protected]" OR "[email protected]" to get the login details. |
Domain | Service Type | Buyer App | Onboarding Process/Point of Contact | Seller App | Onboarding Process/Point of Contact |
---|---|---|---|---|---|
B2C | Logistics | - | https://ref-logistics-staging.thewitslab.com/ | Email "[email protected]" to get the login credentials. | - |
Retail | https://ref-app-buyer-staging-v2.ondc.org/login | Email "[email protected]" to get the required support. | https://ref-app-seller-staging-v2.ondc.org/sign-up | Email "[email protected]" to get the required support. |
Domain | Service Type | Buyer App | Onboarding Process/Point of Contact | Seller App | Onboarding Process/Point of Contact |
---|---|---|---|---|---|
Financial Services | Personal Loan | https://credit.staging.cliniq360.com/ | Email "[email protected]" to get the login credentials | ondc.fis12.seller.cornex.in | Fill onboarding form or Email "[email protected]" for onboarding. |
Invoice based loan | https://cornex.in | Fill onboarding form or Email "[email protected]" for onboarding. | ondc.fis12.seller.cornex.in | Fill onboarding form or Email "[email protected]" for onboarding. | |
Marine Insurance | https://cornex.in | Fill onboarding form or Email "[email protected]" for onboarding. | https://ondc-ref-app.sequelstring.com/staging/mock/seller | - | |
Motor Insurance | https://cornex.in | Fill onboarding form or Email "[email protected]" for onboarding. | https://ondc-ref-app.sequelstring.com/staging/mock/seller | - | |
Health Insurance | https://credit.staging.cliniq360.com/ | Email "[email protected]" to get the login credentials | https://ondc-ref-app.sequelstring.com/staging/mock/seller |
Staging Environment
- ONDC Reference Seller App
- Github Repo link
- ONDC Reference Buyer App
- Github Repo link
- ONDC Reference Mobile Buyer App
- Github Repo link
- ONDC Reference Logistics Seller (LSP) App
- Github Repo link
Pre-Production Environment
- ONDC Reference Seller App
- Github Repo link
- ONDC Reference Buyer App
- Github Repo link
- ONDC Reference Mobile Buyer App
- Github Repo link
- ONDC Reference Logistics Seller (LSP) App
- Github Repo link
- Signing and Verification : This tool is designed to support and aid ONDC Network Participants in constructing their own crypto libraries essential for engaging with the ONDC Network. It encompasses tasks such as key generation, signing, verification, encryption, and decryption.
- Subscription process : This tool aids ONDC Network Participants during the subscription process for the registry (Staging, Pre Prod, Prod). It includes the implementation of the /on_subscribe API in both NodeJS and Python.
- vlookup : This tool is developed to perform a registry lookup and retrieve details related to Network Participants (NP).
- Taxonomies for different domains are available here.
- PRDs for different use cases are available here.
Environment | Endpoint For | URL |
---|---|---|
Staging | Gateway | https://staging.gateway.proteantech.in/search |
Registry | https://staging.registry.ondc.org/lookup |
|
https://staging.registry.ondc.org/vlookup |
||
Pre-Production | Gateway | https://preprod.gateway.ondc.org/search |
Registry | https://preprod.registry.ondc.org/ondc/lookup |
|
https://preprod.registry.ondc.org/ondc/vlookup |
||
Production | Gateway | https://prod.gateway.ondc.org/search |
Registry | https://prod.registry.ondc.org/lookup |
|
https://prod.registry.ondc.org/vlookup |
Refer to the following document for the Network Observability API Schema Requirements for the Production Environment.
Refer to the following document for the Catalog and Store Rejection Report - Framework.
-
Chatbot Assistance
Get instant support for your queries on ONDC Network and Integration journey through our AI-powered chatbot.- Launch Chatbot ONDC Buddy: Link
-
Email Support
For further technical assistance, dedicated technical support team is reachable at the email ID: [email protected]