- Begin your ONDC journey
- Glossary - Components and Terms use
- APIs for Registry
- 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
- 01b - Received incremental update on catalogue from sellers (incremental refresh) - /on_search_inc
- 02 - Inquire about availability and pricing of selected items from catalogue - /on_select
- 03 - Initiate an order before confirmation (order in cart) - /on_init
- 04 - Finalize order with Seller App (confirmation of order) subject to ACK from Seller App - /on_confirm
- 05 - Retrieve the latest status of an order from the Seller App - /on_status
- 06 - Get tracking details for an order's fulfillment from the Seller App - /on_track
- 07 - Request cancellation of an order or a return request (Buyer initiated) - /on_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 - /on_rating
- 10 - IGM - Raise order related issues to Seller App (as raised by customer) - /on_issue
- 11 - IGM - Get status of issue previously raised - /on_issue_status
- 12 - RSF - Send settlement file to Settlement agency (For prepaid orders) - /on_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 - /on_report
- 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
subscribe to ONDC registry
Developing
POST
subscribe
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'subscribe'Response Response Example
{
"error": "string"
}Request
None
Responses
🟠400Bad Request
application/json
Body
error
stringÂ
required