Skip to content
@ONDC-Official

ONDC

Open Network for Digital Commerce

ONDC - Open Network for Digital Commerce

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.

Overview

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.

Table of Contents

  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 and Sandboxes
  9. Taxonomies
  10. Product Requirement Documents (PRDs)
  11. Gateway and Registry Endpoints
  12. Network Observability for Production
  13. Catalog and Store Rejection

Getting Started

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.

Quick Start Guide

ONDC Integration Guide is a roadmap designed to illuminate key resources and navigate through the integration journey.

The Protocol

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.

Subscription Process

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.

Signing and Verification

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!

Enabled Domains

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 (RET)

    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.

    • B2C

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.

    • B2B

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
  • 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.
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
  • Financial Services (FIS)

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

    • PRD

    • 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
    • Commonly asked questions (Not found the question you were looking for? Leave a comment in the document & we will revert)

    • Gift Card

  • Travel & Tourism/ Mobility (TRV)

    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.

    • PRD

    • Mobility Specifications Developer Guide

      • For On-demand Ride hailing, select version : release-TRV10-2.0.1
      • For Unreserved Ticket Booking (metro and intracity bus), select version : release-TRV11-2.0.0
      • For Intercity bus ticket booking, select version : draft-TRV12-intercity
      • 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
    • Commonly asked questions (Not found the question you were looking for? Leave a comment in the document & we will revert)

  • Services (SRV)

    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.

    • PRD

    • 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
    • Sandbox

    • Commonly asked questions (Not found the question you were looking for? Leave a comment in the document & we will revert)

  • Media, Entertainment, Content (MEC)

  • Ancilliary Services

    • 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 Test Case Scenarios (IGM) IGM Log Verification NA IGM FAQs
RSF Developer Guide v2.0.0 select version: draft-rsf-2.0.0 Test Case Scenarios (RSF) NA RSF Mock Server RSF FAQs
Rating v1.2.0 NA NA NA NA
Score v1.2.0 NA NA NA NA

Reference Applications

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

Staging Environment

Pre-Production Environment

Utilities and Sandboxes

  • 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

  • Taxonomies for different domains are available here.

Product Requirement Documents

  • PRDs for different use cases are available here.

Gateway and Registry Endpoints

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

Network Observability for Production

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

Network Observability

Catalog and Store Rejection

Refer to the following document for the Catalog and Store Rejection Report - Framework.

Catalog Rejection

Swagger Document

Pinned Loading

  1. protocol-network-extension protocol-network-extension Public

    ONDC Protocol (network extension layer) is the network enablement layer for ONDC. Together with the Beckn Protocol as the ONDC Protocol (base layer), it comprises the ONDC protocol

    26 23

  2. protocol-base protocol-base Public

    ONDC Protocol (base layer) is the Beckn Protocol Specification

    5 3

  3. developer-docs developer-docs Public

    Developer documentation

    38 47

  4. reference-implementations reference-implementations Public

    ONDC reference apps

    JavaScript 27 70

  5. verification-logs verification-logs Public

    ONDC Pre-production issue & discussion board

    HTML 22 309

  6. 3rd-Party-Apps 3rd-Party-Apps Public

    5 1

Repositories

Showing 10 of 87 repositories