ONDC Retail
  1. Sent by Retail Seller App
ONDC Retail
  • Begin your ONDC journey
  • Glossary - Components and Terms use
  • Pre-requisites
    • Get information about a registered ONDC participant
      POST
    • Onboard on ONDC - step post whitelisting
      POST
  • APIs for Retail Buyer App
    • Sent by Retail Buyer App
      • 01a - Get full catalog from sellers (full refresh) - /search
      • 01b - Get incremental update on catalogue from sellers (incremental refresh) - /search_inc
      • 02 - Inquire about availability and pricing of selected items from catalogue - /select
      • 03 - Initiate an order before confirmation (order in cart) - /init
      • 04 - Finalize order with Seller App (confirmation of order) subject to ACK from Seller App - /confirm
      • 05 - Retrieve the latest status of an order from the Seller App - /status
      • 06 - Get tracking details for an order's fulfillment from the Seller App - /track
      • 07 - Request cancellation of an order or a return request (Buyer initiated) - /cancel
      • 07 - Respond to cancellation initiated by Seller App - ACK to /on_cancel
      • 08 - Initiate updates/changes to an existing order(item quantity, fulfillment updates, or return requests) - /update
      • 08 - Send response to order changes initiated by Seller App - ACK to /on_update
      • 09 - Submit ratings from the buyer's perspective to the network - /rating
      • 10 - IGM - Raise order related issues to Seller App (as raised by customer) - /issue
      • 11 - IGM - Get status of issue previously raised - /issue_status
      • 12 - RSF - Send settlement file to Settlement agency (For prepaid orders) - /settle
      • 13a - RSF - Request reconciliation from receiver (for prepaid orders)
      • 13b - RSF - Respond to recon request by receiver (for prepaid orders)
      • 14 - RSF - Request report from settlement agency - /report
    • Received by Retail Buyer App
      • 01a - Receive full catalogue from Seller App
      • 01b - Receive incremental catalogue refresh from Seller App
      • 02 - Receive response to inquiry about availability and pricing of selected items from catalogue
      • 03 - Receive response to order initiation by Buyer App
      • 04 - Receive response to order confirmation by Buyer App
      • 05a - Receive response to order status request by Buyer App
      • 5b - Receive unsolicitated status update by Seller App
      • 06 - Receive tracking details from Seller App
      • 07a - Receive response on cancellation request from Buyer App
      • 07b - Receive unsolicitated cancellation initiated by Seller App
      • 08a - Receive response to order updates/changes initiated by Buyer App
      • 08b - Receive unsolicitated order updates/changes initiated by Seller App
      • 09 - Send response to ratings sent by Buyer App
      • 10a - IGM - Receive response to issue raised by Buyer App
      • 10b - IGM - Receive response to issue status sent by Seller App
      • 12 - RSF - Receive response to settlement request from Settlement Agency
      • 13a - RSF - Receive response to recon request sent earlier
      • 13b - Receive request for reconciliation by receiver
      • 14 - RSF - Receive response to the report requested
  • APIs for Retail Seller App
    • Sent by Retail Seller App
      • 01a - Received full catalog from sellers (full refresh) - /on_search
        POST
      • 01b - Received incremental update on catalogue from sellers (incremental refresh) - /on_search_inc
        POST
      • 02 - Inquire about availability and pricing of selected items from catalogue - /on_select
        POST
      • 03 - Initiate an order before confirmation (order in cart) - /on_init
        POST
      • 04 - Finalize order with Seller App (confirmation of order) subject to ACK from Seller App - /on_confirm
        POST
      • 05 - Retrieve the latest status of an order from the Seller App - /on_status
        POST
      • 06 - Get tracking details for an order's fulfillment from the Seller App - /on_track
        POST
      • 07 - Request cancellation of an order or a return request (Buyer initiated) - /on_cancel
        POST
      • 07 - Respond to cancellation initiated by Seller App - ACK to /on_cancel
        POST
      • 08 - Initiate updates/changes to an existing order(item quantity, fulfillment updates, or return requests) - /update
        POST
      • 08 - Send response to order changes initiated by Seller App - ACK to /on_update
        POST
      • 09 - Submit ratings from the buyer's perspective to the network - /on_rating
        POST
      • 10 - IGM - Raise order related issues to Seller App (as raised by customer) - /on_issue
        POST
      • 11 - IGM - Get status of issue previously raised - /on_issue_status
        POST
      • 12 - RSF - Send settlement file to Settlement agency (For prepaid orders) - /on_settle
        POST
      • 13a - RSF - Request reconciliation from receiver (for prepaid orders)
        POST
      • 13b - RSF - Respond to recon request by receiver (for prepaid orders)
        POST
      • 14 - RSF - Request report from settlement agency - /on_report
        POST
    • Received by Retail Seller App
      • 07b - Receive unsolicitated cancellation initiated by Seller App
      • 14 - RSF - Receive response to the report requested
      • 13b - Receive request for reconciliation by receiver
      • 13a - RSF - Receive response to recon request sent earlier
      • 12 - RSF - Receive response to settlement request from Settlement Agency
      • 10b - IGM - Receive response to issue status sent by Seller App
      • 10a - IGM - Receive response to issue raised by Buyer App
      • 09 - Send response to ratings sent by Buyer App
      • 08b - Receive unsolicitated order updates/changes initiated by Seller App
      • 08a - Receive response to order updates/changes initiated by Buyer App
      • 07a - Receive response on cancellation request from Buyer App
      • 06 - Receive tracking details from Seller App
      • 5b - Receive unsolicitated status update by Seller App
      • 05a - Receive response to order status request by Buyer App
      • 01a - Receive full catalogue from Seller App
      • 01b - Receive incremental catalogue refresh from Seller App
      • 02 - Receive response to inquiry about availability and pricing of selected items from catalogue
      • 03 - Receive response to order initiation by Buyer App
      • 04 - Receive response to order confirmation by Buyer App
  1. Sent by Retail Seller App

01b - Received incremental update on catalogue from sellers (incremental refresh) - /on_search_inc

Developing
POST
/on_search
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/on_search' \
--header 'Content-Type: application/json' \
--data-raw '{
    "context": {
        "domain": "ONDC:RET11",
        "country": "IND",
        "city": "std:0124",
        "core_version": "1.2.5",
        "action": "on_search",
        "transaction_id": "{{transaction_id}}",
        "message_id": "{{message_id}}",
        "timestamp": "{{timestamp}}",
          "bpp_uri": "{{bap_uri}}",
    "bpp_id": "{{bap_id}}",
        "ttl": "PT30S"
    },
    "message": {
      "catalog": {
        "bpp/descriptor": {
          "name": "ONDC Pramaan Seller Services",
          "symbol": "https://ondc.org/assets/theme/images/ondc_registered_logo.svg?v=399788fda7",
          "short_desc": "ONDC Pramaan Seller",
          "long_desc": "ONDC Pramaan Seller - One Stop Shop",
          "images": [
            "https://ondc.org/assets/theme/images/ondc_registered_logo.svg?v=399788fda7"
          ],
          "tags": [
            {
              "code": "bpp_terms",
              "list": [
                {
                  "code": "np_type",
                  "value": "MSN"
                },
                {
                  "code": "accept_bap_terms",
                  "value": "Y"
                },
                {
                  "code": "tax_number",
                  "value": "00CBADE2145H1Z5"
                },
                {
                  "code": "max_liability",
                  "value": "2"
                },
                {
                  "code": "max_liability_cap",
                  "value": "10000.00"
                },
                {
                  "code": "mandatory_arbitration",
                  "value": "false"
                },
                {
                  "code": "court_jurisdiction",
                  "value": "New Delhi"
                },
                {
                  "code": "delay_interest",
                  "value": "7.50"
                },
                {
                  "code": "provider_tax_number",
                  "value": "ABCDE1234F"
                }
              ]
            }
          ]
        },
        "bpp/providers": [
          {
            "id": "pramaan_provider_1",
            "time": {
              "label": "enable",
              "timestamp": "2024-10-11T00:00:00.000Z"
            },
            "rating": "2",
            "fulfillments": [
              {
                "id": "F0",
                "type": "Delivery",
                "contact": {
                  "phone": "9876543210",
                  "email": "ss_seller_1@ss.com"
                }
              },
              {
                "id": "F1",
                "type": "Self-Pickup",
                "contact": {
                  "phone": "9876543210",
                  "email": "ss_seller_1@ss.com"
                }
              },
              {
                "id": "F2",
                "type": "Buyer-Delivery",
                "contact": {
                  "phone": "9876543210",
                  "email": "ss_seller_1@ss.com"
                }
              }
            ],
            "descriptor": {
              "name": "Pramaan Store 1",
              "symbol": "https://ondc.org/assets/theme/images/ondc_registered_logo.svg?v=399788fda7",
              "short_desc": "Pramaan Store 1",
              "long_desc": "Pramaan Store 1",
              "images": [
                "https://ondc.org/assets/theme/images/ondc_registered_logo.svg?v=399788fda7"
              ]
            },
            "ttl": "P1D",
            "categories": [
              {
                "id": "CM11",
                "parent_category_id": "",
                "descriptor": {
                  "name": "Pizza",
                  "short_desc": "Veg and Non-Veg Pizza",
                  "long_desc": "Veg and Non-Veg Pizza",
                  "images": [
                    "https://ondc.org/assets/theme/images/ondc_registered_logo.svg?v=399788fda7"
                  ]
                },
                "tags": [
                  {
                    "code": "type",
                    "list": [
                      {
                        "code": "type",
                        "value": "custom_menu"
                      }
                    ]
                  },
                  {
                    "code": "display",
                    "list": [
                      {
                        "code": "rank",
                        "value": "1"
                      }
                    ]
                  },
                  {
                    "code": "timing",
                    "list": [
                      {
                        "code": "day_from",
                        "value": "1"
                      },
                      {
                        "code":
Response Response Example
{}

Request

Body Params application/json

Examples

Responses

🟢200Success
application/json
Body

Modified at 2025-06-09 12:57:03
Previous
01a - Received full catalog from sellers (full refresh) - /on_search
Next
02 - Inquire about availability and pricing of selected items from catalogue - /on_select
Built with