The Retail Log Validation Utility is a tool designed to validate transaction logs on the ONDC network. It allows for easy testing and validation of transaction payloads using the provided API. This utility helps ensure the accuracy and integrity of transaction data on the ONDC network.
You can use the Log Validation Service to validate all ONDC transaction-related API payloads. The service is hosted at https://log-validation.ondc.org. You can use the following curl or Postman requests to validate the API logs. The service will generate a report for the provided JSON payloads.
curl --location --request POST 'https://log-validation.ondc.org/api/validate' \
--header 'Content-Type: application/json' \
--data '{
"domain": "",
"version": "1.2.0",
"bap_id": "BUYER_APP_SUBSCRIBER_ID",
"bpp_id": "SELLER_APP_SUBSCRIBER_ID",
"payload": {
"search_full_catalog_refresh": {},
"on_search_full_catalog_refresh": {},
"search_inc_refresh": {},
"on_search_inc_refresh": {},
"select": {},
"on_select": {},
"init": {},
"on_init": {},
"confirm": {},
"on_confirm": {},
"update(initiated)": {},
"on_update(interim)":{},
"on_status_picked": {},
"on_status_out_for_delivery": {},
"on_status_delivered": {}
},
"flow":""
}'The table below outlines the payload structure for various transaction flows in the Retail Log Validation Utility. Each flow corresponds to specific actions within the ONDC network, and the payload structure provides a clear representation of the data expected for each action. This comprehensive reference assists developers in constructing accurate and valid JSON payloads for their transactions.
| Flow 1 | Flow 2 | Flow 3 | Flow 4 | Flow 5 | Flow 6 |
|---|---|---|---|---|---|
| search | search | search | search | search | search |
| on_search | on_search | on_search | on_search | on_search | on_search |
| search_inc | select | select_out_of_stock | select | select | select |
| on_search_inc | on_select | on_select_out_of_stock | on_select | on_select | on_select |
| init | select | init | init | init | |
| on_init | on_select | on_init | on_init | on_init | |
| confirm | init | confirm | confirm | confirm | |
| on_confirm | on_init | on_confirm | on_confirm | on_confirm | |
| on_status_pending | confirm | cancel | on_status_pending | on_update_part_cancel | |
| on_status_packed | on_confirm | on_cancel | on_status_packed | update_settlement_part_cancel | |
| on_status_picked | on_status_pending | on_status_picked | on_status_pending | ||
| on_status_out_for_delivery | on_status_packed | on_status_out_for_delivery | on_status_packed | ||
| on_status_delivered | on_status_picked | on_cancel | on_status_picked | ||
| on_status_out_for_delivery | on_status_rto_delivered/disposed | on_status_out_for_delivery | |||
| on_status_delivered | on_status_delivered | ||||
| update_reverse_qc | |||||
| on_update_interim_reverse_qc | |||||
| on_update_approval | |||||
| on_update_picked | |||||
| update_settlement_reverse_qc | |||||
| on_update_delivered | |||||
| update_liquidated | |||||
| on_update_interim_liquidated | |||||
| on_update_liquidated | |||||
| update_settlement_liquidated |
curl --location --request POST 'https://log-validation.ondc.org/api/validate' \
--header 'Content-Type: application/json' \
--data-raw '{
"domain": "ONDC:RET10",
"version": "1.2.0",
"bap_id": "BUYER_APP_SUBSCRIBER_ID",
"bpp_id": "SELLER_APP_SUBSCRIBER_ID",
"payload": {
"search_full_catalog_refresh": {
"context": {
"action": "search",
"bap_id": "buyer-app.ondc.or",
"bap_uri": "https://buyer-app.ondc.org",
...
},
"message": {...}
},
"on_search_full_catalog_refresh": {
"context": {
"action": "on_search",
"bap_id": "buyer-app.ondc.or",
"bap_uri": "https://buyer-app.ondc.org",
"bpp_id": "seller-app.ondc.org",
"bpp_uri": "https://seller-app.ondc.org",
...
},
"message": {...}
},
"on_search_inc_refresh": {
"context": {
"action": "on_search",
"bap_id": "buyer-app.ondc.or",
"bap_uri": "https://buyer-app.ondc.org",
"bpp_id": "seller-app.ondc.org",
"bpp_uri": "https://seller-app.ondc.org",
...
},
"message": {...}
},
"select": {
"context": {
"action": "select",
"bap_id": "buyer-app.ondc.or",
"bap_uri": "https://buyer-app.ondc.org",
"bpp_id": "seller-app.ondc.org",
"bpp_uri": "https://seller-app.ondc.org",
...
},
"message": {...}
},
"on_select": {
"context": {
"action": "on_select",
"bap_id": "buyer-app.ondc.or",
"bap_uri": "https://buyer-app.ondc.org",
"bpp_id": "seller-app.ondc.org",
"bpp_uri": "https://seller-app.ondc.org",
...
},
"message": {...}
},
"init": {
"context": {
"action": "init",
"bap_id": "buyer-app.ondc.or",
"bap_uri": "https://buyer-app.ondc.org",
"bpp_id": "seller-app.ondc.org",
"bpp_uri": "https://seller-app.ondc.org",
...
},
"message": {...}
},
"on_init": {
"context": {
"action": "on_init",
"bap_id": "buyer-app.ondc.or",
"bap_uri": "https://buyer-app.ondc.org",
"bpp_id": "seller-app.ondc.org",
"bpp_uri": "https://seller-app.ondc.org",
...
},
"message": {...}
},
"confirm": {
"context": {
"action": "confirm",
"bap_id": "buyer-app.ondc.or",
"bap_uri": "https://buyer-app.ondc.org",
"bpp_id": "seller-app.ondc.org",
"bpp_uri": "https://seller-app.ondc.org",
...
},
"message": {...}
},
"on_confirm": {
"context": {
"action": "on_confirm",
"bap_id": "buyer-app.ondc.or",
"bap_uri": "https://buyer-app.ondc.org",
"bpp_id": "seller-app.ondc.org",
"bpp_uri": "https://seller-app.ondc.org",
...
},
"message": {...}
},
"on_status_pending": {
"context": {
"action": "on_status",
"bap_id": "buyer-app.ondc.or",
"bap_uri": "https://buyer-app.ondc.org",
"bpp_id": "seller-app.ondc.org",
"bpp_uri": "https://seller-app.ondc.org",
...
},
"message": {...}
},
"on_status_picked": {
"context": {
"action": "on_status",
"bap_id": "buyer-app.ondc.or",
"bap_uri": "https://buyer-app.ondc.org",
"bpp_id": "seller-app.ondc.org",
"bpp_uri": "https://seller-app.ondc.org",
...
},
"message": {...}
},
"on_status_delivered": {
"context": {
"action": "on_status",
"bap_id": "buyer-app.ondc.or",
"bap_uri": "https://buyer-app.ondc.org",
"bpp_id": "seller-app.ondc.org",
"bpp_uri": "https://seller-app.ondc.org",
...
},
"message": {...}
}
}
}'
If your log are successfully approved, you will receive a similar response as described below:
{
"success": true,
"response": {
"message": "Logs were verified successfully",
"report": {},
"bap_id": "BUYER_APP_ID", // example: buyer-app-preprod-v2.ondc.org
"bpp_id": "SELLER_APP_ID", // example: seller-app-preprod-v2.ondc.org
"domain": "DOMAIN", // example: ONDC:RET10
"reportTimestamp": "2024-02-08T08:10:10.805Z"
},
"signature": "Ishpxpy8p3SPE1CXnMTkxKDt9S/X7v8OigL4DqVWphcr0jXTQOPotX/Y710WKZoCvWgCDOJahf7sXvJzgmRHAg==",
"signTimestamp": "2024-02-08T08:10:10.805Z"
}The signature can be provided to validate that your request was approved by the log validation utility and will be serving as the first level of log verification that has to be completed on the NP side.
In order to perform a validation request with combination of signature and signTimestamp, you can do the following request:
curl --location 'https://log-validation.ondc.org/api/validate/token' \
--header 'Content-Type: application/json' \
--header 'Cookie: connect.sid=s%3AjQe2v39s-ZeiHTOm-dkGI1NK5rqN0Lj4.PLxLV6QlhCtGTHP2ZKe0a5OpHl2ng0oQ%2BAqWmd56POU' \
--data-raw '{
"search_full_catalog_refresh": {
"context": {
"action": "search",
"bap_id": "buyer-app.ondc.or",
"bap_uri": "https://buyer-app.ondc.org",
...
},
"message": {...}
},
"on_search_full_catalog_refresh": {
"context": {
"action": "on_search",
"bap_id": "buyer-app.ondc.or",
"bap_uri": "https://buyer-app.ondc.org",
"bpp_id": "seller-app.ondc.org",
"bpp_uri": "https://seller-app.ondc.org",
...
},
"message": {...}
},
"on_search_inc_refresh": {
"context": {
"action": "on_search",
"bap_id": "buyer-app.ondc.or",
"bap_uri": "https://buyer-app.ondc.org",
"bpp_id": "seller-app.ondc.org",
"bpp_uri": "https://seller-app.ondc.org",
...
},
"message": {...}
},
"select": {
"context": {
"action": "select",
"bap_id": "buyer-app.ondc.or",
"bap_uri": "https://buyer-app.ondc.org",
"bpp_id": "seller-app.ondc.org",
"bpp_uri": "https://seller-app.ondc.org",
...
},
"message": {...}
},
"on_select": {
"context": {
"action": "on_select",
"bap_id": "buyer-app.ondc.or",
"bap_uri": "https://buyer-app.ondc.org",
"bpp_id": "seller-app.ondc.org",
"bpp_uri": "https://seller-app.ondc.org",
...
},
"message": {...}
},
"init": {
"context": {
"action": "init",
"bap_id": "buyer-app.ondc.or",
"bap_uri": "https://buyer-app.ondc.org",
"bpp_id": "seller-app.ondc.org",
"bpp_uri": "https://seller-app.ondc.org",
...
},
"message": {...}
},
"on_init": {
"context": {
"action": "on_init",
"bap_id": "buyer-app.ondc.or",
"bap_uri": "https://buyer-app.ondc.org",
"bpp_id": "seller-app.ondc.org",
"bpp_uri": "https://seller-app.ondc.org",
...
},
"message": {...}
},
"confirm": {
"context": {
"action": "confirm",
"bap_id": "buyer-app.ondc.or",
"bap_uri": "https://buyer-app.ondc.org",
"bpp_id": "seller-app.ondc.org",
"bpp_uri": "https://seller-app.ondc.org",
...
},
"message": {...}
},
"on_confirm": {
"context": {
"action": "on_confirm",
"bap_id": "buyer-app.ondc.or",
"bap_uri": "https://buyer-app.ondc.org",
"bpp_id": "seller-app.ondc.org",
"bpp_uri": "https://seller-app.ondc.org",
...
},
"message": {...}
},
"on_status_pending": {
"context": {
"action": "on_status",
"bap_id": "buyer-app.ondc.or",
"bap_uri": "https://buyer-app.ondc.org",
"bpp_id": "seller-app.ondc.org",
"bpp_uri": "https://seller-app.ondc.org",
...
},
"message": {...}
},
"on_status_picked": {
"context": {
"action": "on_status",
"bap_id": "buyer-app.ondc.or",
"bap_uri": "https://buyer-app.ondc.org",
"bpp_id": "seller-app.ondc.org",
"bpp_uri": "https://seller-app.ondc.org",
...
},
"message": {...}
},
"on_status_delivered": {
"context": {
"action": "on_status",
"bap_id": "buyer-app.ondc.or",
"bap_uri": "https://buyer-app.ondc.org",
"bpp_id": "seller-app.ondc.org",
"bpp_uri": "https://seller-app.ondc.org",
...
},
"message": {...}
}
}
}'You will receive verification: true if the signature was verified to be generated from the same set of logs.
- The output of the utility service provides the report in a JSON format along with a success flag (true/false). Refer to the above sample payloads.
- The service can be used to validate the entire transaction on the network or a particular schema of any payload.
- Endpoint for the validation of the entire transaction: https://log-validation.ondc.org/api/validate
- Endpoint for the validation of schema: https://log-validation.ondc.org/api/validate-schema
- Community contributions are welcome to enhance this utility for future releases. To contribute, please raise a PR or create an issue. Contribution through either way works!
If you want to use this utility locally, follow these steps:
-
Clone the repository from GitHub:
git clone https://github.com/ONDC-Official/log-validation-utility.git
-
Install the required dependencies:
npm install
-
Run the server in a local environment:
npm run dev
After starting the local server, you can use the API for log validation by making POST requests to the following endpoint:
http://localhost:3006/api/validate
You can use the following curl command to make a POST request to the local validation endpoint:
curl --location 'http://localhost:3008/api/validate' \
--header 'Content-Type: application/json' \
--data '{
"domain": "ONDC:RET18",
"version": "1.2.0",
"bap_id": "BUYER_APP_SUBSCRIBER_ID",
"bpp_id": "SELLER_APP_SUBSCRIBER_ID",
"payload": {
"search_full_catalog_refresh": {},
"on_search_full_catalog_refresh":{},
"search_inc_refresh": {},
"on_search_inc_refresh": {}
},
"flow": "1"
}'curl --location 'http://localhost:3008/api/validate' \
--header 'Content-Type: application/json' \
--data '{
"domain": "ONDC:RET18",
"version": "1.2.0",
"bap_id": "BUYER_APP_SUBSCRIBER_ID",
"bpp_id": "SELLER_APP_SUBSCRIBER_ID",
"payload": {
"search_full_catalog_refresh": {},
"on_search_full_catalog_refresh":{},
"select": {},
"on_select": {},
"init": {},
"on_init": {},
"confirm": {},
"on_confirm": {},
"on_status_pending": {},
"on_status_packed": {},
"on_status_picked": {},
"on_status_out_for_delivery": {},
"on_status_delivered": {}
},
"flow": "2"
}'curl --location 'http://localhost:3008/api/validate' \
--header 'Content-Type: application/json' \
--data '{
"domain": "ONDC:RET18",
"version": "1.2.0",
"bap_id": "BUYER_APP_SUBSCRIBER_ID",
"bpp_id": "SELLER_APP_SUBSCRIBER_ID",
"payload": {
"search_full_catalog_refresh": {},
"on_search_full_catalog_refresh":{},
"select_out_of_stock": {},
"on_select_out_of_stock": {},
"select": {},
"on_select": {},
"init": {},
"on_init": {},
"confirm": {},
"on_confirm": {},
"on_status_pending": {},
"on_status_packed": {},
"on_status_picked": {},
"on_status_out_for_delivery": {},
"on_status_delivered": {}
},
"flow": "3"
}'curl --location 'http://localhost:3008/api/validate' \
--header 'Content-Type: application/json' \
--data '{
"domain": "ONDC:RET18",
"version": "1.2.0",
"bap_id": "BUYER_APP_SUBSCRIBER_ID",
"bpp_id": "SELLER_APP_SUBSCRIBER_ID",
"payload": {
"search_full_catalog_refresh": {},
"on_search_full_catalog_refresh":{},
"select": {},
"on_select": {},
"init": {},
"on_init": {},
"confirm": {},
"on_confirm": {},
"cancel": {},
"on_cancel": {}
},
"flow": "4"
}'curl --location 'http://localhost:3008/api/validate' \
--header 'Content-Type: application/json' \
--data '{
"domain": "ONDC:RET18",
"version": "1.2.0",
"bap_id": "BUYER_APP_SUBSCRIBER_ID",
"bpp_id": "SELLER_APP_SUBSCRIBER_ID",
"payload": {
"search_full_catalog_refresh": {},
"on_search_full_catalog_refresh":{},
"select": {},
"on_select": {},
"init": {},
"on_init": {},
"confirm": {},
"on_confirm": {},
"on_status_pending": {},
"on_status_packed": {},
"on_status_picked": {},
"on_status_out_for_delivery": {},
"on_cancel": {},
"on_status_rto_delivered/disposed":{}
},
"flow": "5"
}'curl --location 'http://localhost:3008/api/validate' \
--header 'Content-Type: application/json' \
--data '{
"domain": "",
"version": "1.2.0",
"bap_id": "BUYER_APP_SUBSCRIBER_ID",
"bpp_id": "SELLER_APP_SUBSCRIBER_ID",
"payload": {
"search_full_catalog_refresh": {},
"on_search_full_catalog_refresh":{},
"select": {},
"on_select": {},
"init": {},
"on_init": {},
"confirm": {},
"on_confirm": {},
"on_update_part_cancel": {},
"update_settlement_part_cancel": {},
"on_status_pending": {},
"on_status_packed": {},
"on_status_picked": {},
"on_status_out_for_delivery": {},
"on_status_delivered": {},
"update_reverse_qc":{},
"on_update_interim_reverse_qc":{},
"on_update_approval":{},
"on_update_picked": {},
"update_settlement_reverse_qc": {},
"on_update_delivered": {},
"update_liquidated":{},
"on_update_interim_liquidated":{},
"on_update_liquidated": {},
"update_settlement_liquidated": {}
},
"flow": "6"
}'curl --location 'https://localhost:3006/api/validate/igm' \
--header 'Content-Type: application/json' \
--data '{
"domain": "",
"version": "1.2.0",
"bap_id": "BUYER_APP_SUBSCRIBER_ID",
"bpp_id": "SELLER_APP_SUBSCRIBER_ID",
"payload": {
"ret_issue": {},
"ret_issue_close":{},
"ret_on_issue": {},
"ret_issue_status": {},
"ret_on_issue_status": {},
"ret_on_issue_status_unsolicited": {},
"lsp_issue": {},
"lsp_issue_close":{},
"lsp_on_issue": {},
"lsp_issue_status": {},
"lsp_on_issue_status": {}
}
}'curl --location 'https://log-validation.ondc.org/api/validate/fis/fis12' \
--header 'Content-Type: application/json' \
--data '{
"domain": "ONDC:FIS12",
"version": "2.0.0",
"flow": "PERSONAL",
"bap_id": "BUYER_APP_SUBSCRIBER_ID",
"bpp_id": "SELLER_APP_SUBSCRIBER_ID",
"payload": {
"search": {},
"on_search":{},
"select_1": {},
"on_select_1": {},
"select_2": {},
"on_select_2": {},
"select_3": {},
"on_select_3":{},
"init_1": {},
"on_init_1": {},
"init_2": {},
"on_init_2": {},
"init_3": {},
"on_init_3": {},
"confirm": {},
"on_confirm": {},
"status": {},
"on_status": {},
"update": {},
"on_update": {}
}
}'curl --location 'https://localhost:3006/api/validate/trv' \
--header 'Content-Type: application/json' \
--data '{
"domain": "ONDC:TRV10",
"version": "2.0.0",
"flow": "RIDER_CANCEL",
"bap_id": "BUYER_APP_SUBSCRIBER_ID",
"bpp_id": "SELLER_APP_SUBSCRIBER_ID",
"payload": {
"search": {},
"on_search":{},
"select": {},
"on_select": {},
"init": {},
"on_init": {},
"confirm": {},
"on_confirm": {},
"status": {},
"on_status": {},
"soft_cancel": {},
"soft_on_cancel": {},
"cancel": {},
"on_cancel": {}
}
}'Using Postman, you can import the above curl command into Postman and replace the empty objects in the payload with your actual data. This allows for easy testing and validation of transaction logs on your local environment.
With these instructions, you can start using the Retail Logs Validation Utility for local log validation.
Feel free to reach out if you have any questions or need further assistance.