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.

1. Getting Started
2. Quick Start Guide
3. The Protocol
4. Subscription Process
5. Signing and Verification
6. Enabled Domains
7. Reference Applications
8. Utilities
9. Taxonomies
10. Gateway and Registry Endpoints
11. Network Observability for Production

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 necessary 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:

1. Staging Registry

   • Obtain whitelisting for the subscriber ID.
   • Initiate the subscription process by calling the /subscribe API. The complete process is documented here

2. 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.

3. 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. Some frequently asked questions and answers are compiled here.

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.

• Retail - This domain encompasses subcategories such as grocery, food and beverages, fashion, electronics, home & decor, beauty, and personal care, etc. It facilitates seamless transactions in both B2C and B2B modes, offering a comprehensive shopping experience for consumers and businesses alike.

  • B2C

    • v1.2
    • Test Case Scenarios - B2C

  • B2B

    • v2.0.2
    • Test Case Scenarios - B2B

  • Retail Developer Guide

    • For B2B, select version : release-2.0.2
    • For B2C, select version : draft-1.x
    • For B2C Exports, select version : b2c_exports_2.0

• Logistics - 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.

  • B2C Logistics v1.2
  • B2B Logistics v2.0
  • Logistics Developer Guide
    • For B2B Logistics, select version : draft-2.x
  • Test Case Scenarios - B2C Logistics

• Financial Services - This domain facilitates easy access to a spectrum of financial solutions, covering loans, insurance, investments.

  • Financial Services Developer Guide

    • For Personal Loan , select Version : release-FIS12-2.0.0
    • For Invoice based Loan , select Version : draft-FIS12-invoice-2.1.0
    • For Health Insurance , select version : draft-health
    • For Motor Insurance , select version : draft-motor
    • For Marine Insurance , select version : draft-marine
    • For Investments , select version : draft-FIS14-enhancements

  • Gift Card

• Travel & Tourism - 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.

  • Mobility Specifications Developer Guide

    • For On-demand Ride hailing, select version : release-TRV10-2.0.0
    • For Unreserved Ticket Booking (metro and intracity bus), select version : release-TRV11-2.0.0
    • For Airlines Booking, select version : draft-TRV12-airline
    • For Hotel Booking, select version : draft-TRV13-hotel
    • For Unreserved Entry Pass (heritage sights, museums, concerts, etc), select version : draft-TRV14-2.0.0

• Services - 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.

  • v2.0.0

  • Services Developer Guide

    • For Skilled Services, select version : release-services
    • For Auction of Agricultural Outputs, select version : draft-agri_bids_and_auction
    • For Equipment hiring (leasing farming machinery and tools), select version : draft-agri_equipment
    • For Soil Testing and Assaying Service, select version : draft-agri_services
    • For Healthcare Services (Lab Test Booking), select version : draft-healthcare
    • For Subcription based services, select version : draft-subscriptions

• Ancillary Services

  • Issue & Grievance Management (IGM) within the ONDC Network serves as a critical mechanism for resolving disputes and concerns among Network Participants (NPs).
    • v1.0.0
  • Reconcillation and Settlement Framework (RSF) plays a pivotal role in maintaining a comprehensive trail of settlements between Network Participants.
    • v1.0.0
  • Rating
    • v1.2.0
  • Score
    • v1.2.0
  • Test Case Scenarios (IGM & RSF)

The network participants need to complete the end-to-end testing with ONDC reference applications.

Staging Environment

• ONDC Reference Seller App
  • Github Repo link
• ONDC Reference 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 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 cryptocurrency libraries essential for engaging with the ONDC Network. It encompasses tasks such as key generation, signing, verification, encryption, and decryption.
  • Java
  • NodeJS
  • Python
  • GoLang
• Subcription 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.
• Retail/IGM Log Verification : This tool is designed for ONDC Network Participants to verify their transaction logs related to the Retail and IGM use cases on their end, ensuring accuracy before submission to the ONDC team for technical clearance.
• B2B/Logistics Log Verification : This tool is designed for ONDC Network Participants to verify their transaction logs related to the B2B and Logistics use cases on their end, ensuring accuracy before submission to the ONDC team for technical clearance.
• vlookup : This tool is developed to perform a registry lookup and retrieve details related to Network Participants (NP).
• RSF Mock Server : The RSF Mock Server is a tool specifically designed to test network integration for Reconcillation and Settlement Framework (RSF) , based on ONDC model implementation.

• Taxonomies for different domains can be found here.

Refer to the following document for the Network Observability API Schema Requirements for the Production Environment Network Observability