User Guide on Transaction Analysis

Created by Surya Boddu, Modified on Tue, 2 Apr, 2024 at 2:27 PM by Surya Boddu

Overview

The Transaction Analysis User Guide provides detailed instructions for troubleshooting orders placed on the ONDC module. This guide focuses on utilizing Transaction Analysis to obtain a comprehensive overview of the entire order process, from the initial buyer app request to the item's delivery. By exploring the features and options available on the ONDC Events tab, such as Account ID or Name, Transaction ID, Message ID, Filter, Search type, Event Type, Subscriber ID, Subscriber Uri, BAP Action, BPP Action, Event Status, and Created On, you can effectively troubleshoot and address any issues that may arise.

Step-by-Step Troubleshooting Instructions using Transaction Analysis

Step 1: Login to Bitsila



  • Once logged in, you will be directed to the dashboard.


  • On the dashboard, navigate to the ONDC module and click on the ONDC Events/Transaction Analysis tab.



transaction analysis

Step 2: Go to the ONDC Module


  • Within the ONDC module, locate and click on the ONDC Events/Transaction Analysis tab. This tab provides a list of all the transactions associated with your account.



  • Search Transaction Details:


On the ONDC Events tab, you can search for transaction details using various parameters:


  • Account ID or Name

  • Transaction ID

  • Message ID

  • Filter

  • Search type

  • Event Type

  • Subscriber ID

  • Subscriber Uri

  • BAP Action

  • BPP Action

  • Event Status

  • Created On

1. Account ID or Name:

Enter the Account ID or Name to search for transactional information associated with the entire account.

2. Transaction ID:

  • Input the Transaction ID to retrieve transactional data for a specific item. The most recent transactions will appear at the top..




  • To know about particular Event Status click on the Transaction ID




  • Open the pop-up screen below, displaying the event status. Click on the kebab menu to view comprehensive details regarding the success or failure of the action.






Accessing Event Details:

  • Download JSON: Click on the "Download JSON" option to download the JSON file specific to the event. This file can be reviewed by the developer for further analysis.

  • View Summary: Click on the "Summary" option to obtain a more detailed overview of the event status.

Event Sections:

When you click on events within the domain, two sections will be displayed: Retail and Logistics. The Logistics section provides information related to the delivery process, while the Retail section pertains to the seller's activities.

Retail:

In the retail domain, the buyer event shows four responses: Search, Select, Init, Confirm, and Status. Additionally, in the seller response tab, it displays ACK if the process is successful and NACK if the process has failed.


  • Search:

When a buyer performs a search for a specific item, the summary provides information about the item that was searched. It also indicates whether the seller is capable of processing the request. If the seller is unable to process the request, the summary will provide details about why it cannot be processed.




  • Select:

By clicking on the summary for a particular transaction, the buyer can view the item that has been selected and added to the cart. The summary also indicates whether the seller is capable of processing the selected item. If the seller cannot process the item, the summary provides information about the reason for the inability to process.


  • Init:

The initialization stage occurs when a product is added to the cart and the order is placed. It is the first step in the order process. The summary for the init event provides details about this stage.


  • Confirm:

After the order is placed, the next step is to verify and confirm whether the seller can fulfill the order. The summary for the confirm event indicates whether the seller can process the order. If the seller is unable to process the order, the summary provides information about the reason for the inability.


These events help track the progress of the order and provide insights into the actions taken by the buyer and the corresponding responses from the seller.

Logistic:

In the logistical domain, the buyer event status encompasses three cases: Search, Init, and Confirm.


  • Search:

When a seller performs a search for a logistic, the search status is displayed. This indicates that the seller is actively looking for available logistics options.


  • Init:

When a seller initiates a logistic request, the init status is displayed. This indicates that the seller has made a specific logistic request and is awaiting further processing.


  • Confirm:

In the case of logistics, there can be multiple initiators for a delivery. However, only the first initiator will have the delivery confirmed. This means that once the delivery is confirmed by the first initiator, it is considered as confirmed for that particular logistic request.


The comprehensive summary window of the Retail domain is displayed below. This window provides a detailed overview of the Retail domain, including information about the order, its status, and other relevant details.

Retail Domain consists of the following details:


  • Buyer App

  • Summary

  • Seller Response

  • Customer Details

  • Buyer Requests

  • Seller Errors


Buyer App:

In this section, the retail domain obtains information about the buyer app from which the order was searched for or selected. This information allows the retail domain to track the origin of the order and understand which buyer app was involved in the transaction. By knowing the specific buyer app, the retail domain can better manage and analyze the order data associated with that particular app.


Summary:

In this section, the seller app learns the order summary, including the details of the buyer app request that was issued. Additionally, the seller app obtains information about the customer's location, including the area and the radius within which the customer is located. This information helps the seller app to effectively process and fulfill the order based on the customer's location.


Seller Response:

In this section, the retailer receives information about the order, including its quantity and price. This allows the retailer to have a clear understanding of the specific order details and enables them to process and fulfill the order accurately.





Customer Details:

In this section, the seller receives information about the customer's GPS and position details, including their area and pin code. This information helps the seller to determine the customer's location for order processing and delivery purposes.


Buyer Requests:

In this section, the order's description and quantity are disclosed.


Seller Errors:

  • If there is a seller error, it is the responsibility of the seller team, specifically the Bitsila Team, to resolve any seller ONDC error codes or seller ONDC error messages. These error codes and messages provide specific information about the nature of the error encountered during the transaction process.


  • The seller team, represented by the Bitsila Team in this case, should analyze the error codes or messages to identify the root cause of the issue. They need to troubleshoot and resolve the problem to ensure a smooth transaction flow and provide a satisfactory experience for the buyer.


  • Additionally, the comprehensive summary window of the Logistic domain provides a detailed overview of the logistics-related aspects of the order. It presents a consolidated view of relevant information such as order status, delivery details, tracking updates, and any associated events or actions related to the order's transportation and delivery process. This summary window helps the logistic team efficiently manage and monitor the order's progress, ensuring successful delivery to the buyer

Logistic domain consists of following details:


  • Buyer Details

  • Seller Details

  • Buyer Request

  • Seller Errors

  • Seller Response




Buyer Details:

In this logistics domain, the system receives information about the buyer app actions (such as search, select, init, confirm) as well as the buyer's location.


Seller Details:

This section provides information about the available logistics partners for delivery and also presents the corresponding delivery charges.


Buyer Request:

Here the logistical domain possesses the knowledge about the order's specifics.When referring to the "logistical domain" it means that the logistics-related systems or components involved in the order processing and fulfillment process have access to the details of the order. This includes information such as the product, quantity, shipping address, delivery preferences, and any other relevant details specified by the buyer.


Seller Errors:

If there is a seller error encountered during the order process, it is the responsibility of the seller team, specifically the Bitsila Team, to address and resolve any seller ONDC error codes or seller ONDC error messages. These error codes and messages are specific to the ONDC platform and indicate issues or problems related to the seller's actions or system. The Bitsila Team should analyze the error codes or error messages, identify the root cause of the problem, and take appropriate measures to rectify the issue. By resolving these errors, the seller team ensures a smooth and error-free ordering experience for the buyers on the ONDC platform.


Seller Response:

When the buyer app receives API responses related to an unsuccessful order due to the seller, a pop-up screen will appear with the message "we don't service you." This indicates that the seller is unable to fulfill the order or provide service to the buyer. This response helps communicate the reason for the unsuccessful transaction and informs the buyer about the unavailability of service from that particular seller.




If the order is unsuccessful due to logistics-related issues, the buyer app will receive an API response that triggers a pop-up screen displaying the message "Delivery partners not available." This response indicates that the delivery partners or logistics services necessary to fulfill the order are currently unavailable. The message informs the buyer about the reason for the unsuccessful transaction and implies that the order cannot be processed or delivered at that moment.



3. Message ID:


4. Filter:

By applying the account filter to the data in the ONDC module's Transaction Analysis, you can narrow down the information to be specific to a particular account. This is particularly useful when dealing with a large number of records associated with the account.


For example, if the account has 1000 records, it can be challenging to search for specific transactions manually due to the numerous events generated for each action. By utilizing the account filter, you can focus on the transactions and events related to that specific account.


In addition to the account filter, there are other filters available to refine your search:

Request Actions, Response Actions, City, Buyer App, Status, Event type, Date, Account Name, From Time, To Time, Need Attention.



Request Actions:

In the Request Actions tab, you can choose from the following request actions to retrieve specific events:


Search: Select this action to find events related to product searches. Multiple events may be generated if many users search for the same product. Use this action to locate the desired search event.


Select: Choose this action to view events related to product selection. Multiple events may be created if multiple users select the same product. Use this action to find the specific select event.


Init: Init stands for initialization. This action represents the initial step when an order is placed. To locate a specific initialized event, select the init action.


Confirm: Use the confirm request action to determine whether a particular order has been confirmed or not.


Status: Select the status request action to retrieve information about the status of a specific order.


Track: Choose the track request action to access details regarding the tracking of order information.


Cancel: Select the cancel request action to gather information about a specific order cancellation.


Update: Choose the update request action to learn about any updates made to a particular order.


By selecting the appropriate request action from the drop-down menu, you can retrieve the relevant events and obtain detailed information about specific actions performed within the order process.


Response Actions:

In the ONDC module's Transaction Analysis, you have the option to select specific request actions from a drop-down menu. These request actions correspond to different stages or events within the order process. By choosing the appropriate request action, you can narrow down your search and retrieve transaction data specific to that action. Here are the available request actions and their descriptions:

  1. On Search: This request action allows you to view events related to item searches. It helps you track and analyze the search process initiated by buyers.

  2. On Select: By choosing "On select" as the request action, you can access events that pertain to item selection. This action provides information about the products or items buyers have chosen or added to their cart.

  3. On Init: Selecting "On init" as the request action allows you to focus on events related to order initialization. This action represents the initial stage of the order process when the buyer places the order.

  4. On Confirm: By choosing "On confirm" as the request action, you can view events associated with order confirmation. This action provides details about the verification or confirmation of the buyer's order.

  5. On Status: Selecting "On status" as the request action allows you to access events that provide information about the status of the order. This action helps you track the progress or current status of the order.

  6. On Track: By choosing "On track" as the request action, you can view events related to tracking order information. This action provides updates on the delivery and tracking of the order.

  7. On Cancel: Selecting "On cancel" as the request action allows you to focus on events related to order cancellation. This action provides information about canceled orders and the reasons behind the cancellation.

  8. On Update: By choosing "On update" as the request action, you can access events that represent updates or changes made to the order. This action provides details about any modifications or updates made to the order after its initial placement.

By selecting the appropriate request action from the drop-down menu, you can narrow down your search and retrieve transaction data specific to a particular stage or event in the order process. This helps you analyze and troubleshoot issues related to that specific action.


City:

Within the Transaction Analysis section of the ONDC module, you have the capability to search for a specific city by providing a pin code. This functionality enables you to retrieve transaction data associated with a particular city based on its corresponding pin code.


Buyer app:

In the Transaction Analysis section of the ONDC module, you have the flexibility to choose a specific buyer app from the available drop-down menu. This feature enables you to access transaction information that is specifically associated with the selected buyer app.


Status:

Within the ONDC module's Transaction Analysis, you have the option to select a status from the provided drop-down menu. This selection allows you to filter and access specific transaction data based on different status categories. Here are some status options available and their meanings:


  • Request Received

    • This status indicates that the initial request for the transaction has been received by the system. It signifies the starting point of the transaction process.

  • Request Acknowledgment

    • The Request Acknowledgment status confirms that the system has acknowledged the transaction request. It serves as a confirmation of receipt from the system's end.

  • Call Back Received

    • When the system receives a callback in response to a transaction, the Call Back Received status is assigned. This typically involves a response or action initiated by the buyer app or another party involved in the transaction.

  • Call Back Sent

    • The Call Back Sent status indicates that the system has sent a callback in response to a transaction. This is usually a response or action initiated by the seller app or another relevant entity.

By selecting a specific status from the drop-down menu, such as "request received," "request acknowledgment," "call back received," or "call back sent," you can access transaction data that corresponds to the chosen status. This helps you analyze and understand the progress and specific events related to the transaction process at different stages.

Event type:

Within the ONDC module's Transaction Analysis, you have the flexibility to choose from different event types to gain insights into specific aspects of the transaction process. The available event types include Retail BPP, Logistics BPP, and All. Here's a breakdown of what each option entails:


  • Retail BPP:

Selecting Retail BPP as the event type allows you to focus on buyer app-related activities and responses. This includes analyzing buyer app replies, examining interactions between the buyer app and the seller, and understanding the sequence of events related to the buyer's actions. By choosing Retail BPP, you can obtain a detailed overview of the buyer app's involvement throughout the transaction process.


  • Logistics BPP:

Opting for Logistics BPP as the event type enables you to concentrate on delivery-related response issues. This includes evaluating logistics-related activities, tracking the progress of the delivery process, and understanding any challenges or errors encountered during the delivery phase. By selecting Logistics BPP, you can gain valuable insights into the logistics domain and identify any issues or bottlenecks affecting the successful delivery of orders.




  • All:

Choosing the All option allows you to view and analyze both Retail BPP and Logistics BPP responses simultaneously. This comprehensive approach provides a holistic understanding of the entire transaction process, encompassing buyer app interactions, seller responses, and logistics-related activities. By selecting All, you can explore all aspects of the transaction and gain a comprehensive overview of the order's journey from initiation to delivery.


Date:

If you need to obtain information about an order's transaction, you have the option to search based on the date when the order was placed. By selecting the specific date, you can access relevant details and insights related to transactions that occurred on that particular day.


Account Name:

To retrieve information about an order's transaction, you have the option to search based on the specific account name associated with the transaction. By providing the account name, you can access comprehensive details related to the order within that account.


From Time:

If you want to retrieve specific information about an order's transaction, you have the option to search based on the time the order was placed. By entering the time details, you can narrow down the search results and obtain the desired transaction details. This feature allows you to pinpoint and review orders within a specific timeframe.


Need Attention:

  • The Require Attention field is used when there are issues or problems with the events displayed in the ONDC module that require special attention. By selecting "Yes" under the Require Attention tab, you indicate that certain events need to be closely monitored or addressed.

  • When events require attention, it means that there might be errors, failures, or anomalies that need to be investigated or resolved. These events may impact the overall order processing or transaction flow.

  • By flagging events that require attention, you ensure that they receive proper focus and follow-up actions from the relevant team members or stakeholders. It helps in identifying and resolving issues promptly, ensuring smooth order processing and customer satisfaction.

5. Search type:

The Search Type feature allows you to specify the type of actions you are performing within the search functionality. It helps identify whether you are conducting an item search or searching for nearby stores.


  • Item Search: Selecting the item search option indicates that you are searching for specific products or items within the ONDC module. This can be helpful when troubleshooting issues related to a particular item or analyzing search patterns.


  • Store Nearby: Choosing the store nearby option signifies that you are searching for stores or sellers located in close proximity to a specific location. This feature is beneficial when you need to find nearby sellers or analyze the availability of products in a particular area.


By selecting the appropriate search type, you can narrow down your search and focus on the specific actions or criteria relevant to your analysis or troubleshooting process.


6. Event Type:

  • The Event Type indicates the classification of the event based on its nature and origin. In the ONDC module, there are two main event types: Retail BPP and Logistics BPP.

  • Retail BPP refers to events related to the buyer app, encompassing actions such as searching for products, selecting items, initiating orders, confirming orders, and checking status. This category focuses on the interactions and activities performed by the buyer app.

  • Logistics BPP pertains to events associated with the delivery app or logistics domain. It includes actions related to logistics operations, such as tracking shipments, managing inventory, coordinating deliveries, and confirming the fulfillment of orders.

  • By understanding the event type, you can differentiate between buyer app-related events and delivery app-related events, enabling you to navigate and analyze the data more effectively.

  • If there are additional tabs or sections available but not visible, you can scroll the window to the left to access them and explore further information or options.




7. Subscriber ID:

The Subscriber ID provides information about the domain to which a particular transaction belongs. It helps identify whether the transaction is associated with the logistics domain or the buyer app domain. By referring to the Subscriber ID, you can determine the specific category or area of the transaction and gain insights into its context and purpose.



8. Subscriber Uri:

The buyer apps' logical or physical resources, which are connected to the internet, can be identified using a Uniform Resource Identifier (URI). A URI is a character sequence that serves as a unique identifier for the buyer app's resources. It allows for the identification and access of specific buyer app resources within the transaction analysis process.



9. BAP Action:



10. BPP Action:



11. Event Status:

The event status provides important information regarding the progress and responses of the transaction between the selling app and the buyer app. It includes various statuses such as "request received," "request acknowledgment," "call back received," "call back sent," and other relevant responses. These statuses indicate the current stage and communication status of the transaction



12. Created On:

This tab provides information regarding the date and time when the order was placed. It gives you an overview of when the transaction took place.


























FAQs

Q. What is Transaction Analysis?

A. Transaction Analysis is a feature within the ONDC module that allows users to obtain detailed information about a transaction, from the initial buyer app request to the delivery of the item. It helps in troubleshooting issues and gaining insights into the transactional process.


Q. How do I access the Transaction Analysis feature?

A. To access Transaction Analysis, log in to Bitsila and navigate to the ONDC module. From there, click on the ONDC Events/Transaction Analysis tab to access the transactional data and search for specific details.


Q. How can Transaction Analysis help in troubleshooting ONDC orders?

A. Transaction Analysis provides a comprehensive overview of the entire transaction process, enabling users to identify and resolve issues related to orders placed on the ONDC platform. It helps in pinpointing errors, understanding the status of each event, and retrieving specific transactional data for troubleshooting purposes.


Q. Can I download transaction data for further analysis?

A. Yes, you can download the JSON file for a particular event by clicking on the "Download JSON" option. This file can be reviewed by developers or used for further analysis and investigation.


Q. What information is available in the Retail and Logistics domains?

A. The Retail domain provides information about buyer app actions, seller responses, customer details, buyer requests, and seller errors. The Logistics domain focuses on buyer details, seller details, buyer requests, seller errors, and seller responses related to delivery.


Q. How can I find specific transactional details for an account?

A. You can search for transactional information using the Account ID or Name parameter. By entering the account details, you can retrieve transactional data associated with that specific account.


Q. Is there a way to filter and sort transaction data?

A. Yes, you can utilize various filters such as Request Actions, Response Actions, City, Buyer App, Status, Event Type, Date, Account Name, From Time, To Time, and Need Attention to refine and sort transaction data based on specific criteria.


Q. How can I troubleshoot specific errors or issues using Transaction Analysis?

A. By analyzing the event details, responses, and error messages within Transaction Analysis, you can identify the root cause of errors or issues encountered during the transaction process. The comprehensive overview and details provided help in troubleshooting and resolving these problems effectively

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article