ONDC Retail
  1. Sent by Retail Buyer App
ONDC Retail
  • Begin your ONDC journey
  • Glossary - Components and Terms use
  • APIs for Retail Buyer App
    • Sent by Retail Buyer App
      • 01a - Get full catalog from sellers (full refresh) - /search
        POST
      • 01b - Get incremental update on catalogue from sellers (incremental refresh) - /search_inc
        POST
      • 02 - Inquire about availability and pricing of selected items from catalogue - /select
        POST
      • 03 - Initiate an order before confirmation (order in cart) - /init
        POST
      • 04 - Finalize order with Seller App (confirmation of order) subject to ACK from Seller App - /confirm
        POST
      • 05 - Retrieve the latest status of an order from the Seller App - /status
        POST
      • 06 - Get tracking details for an order's fulfillment from the Seller App - /track
        POST
      • 07 - Request cancellation of an order or a return request (Buyer initiated) - /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 - /rating
        POST
      • 10 - IGM - Raise order related issues to Seller App (as raised by customer) - /issue
        POST
      • 11 - IGM - Get status of issue previously raised - /issue_status
        POST
      • 12 - RSF - Send settlement file to Settlement agency (For prepaid orders) - /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 - /report
        POST
    • 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
      • 04 - Receive response to order confirmation by Buyer App
      • 03 - Receive response to order initiation by Buyer App
      • 02 - Receive response to inquiry about availability and pricing of selected items from catalogue
      • 01b - Receive incremental catalogue refresh from Seller App
      • 01a - Receive full catalogue from Seller App
  1. Sent by Retail Buyer App

08 - Initiate updates/changes to an existing order(item quantity, fulfillment updates, or return requests) - /update

Developing
POST
/update
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/update' \
--header 'Content-Type: application/json' \
--data-raw '{
    "context": {
        "domain": "ONDC:RET11",
        "country": "IND",
        "city": "std:0124",
        "core_version": "1.2.5",
        "action": "update",
        "transaction_id": "{{transaction_id}}",
        "message_id": "{{message_id}}",
        "timestamp": "{{timestamp}}",
        "bap_uri": "{{bap_uri}}",
        "bap_id": "{{bap_id}}",
        "ttl": "PT30S"
    },
    "message": {
        "update_target": "item",
        "order": {
            "id": "SS1747978302628",
            "fulfillments": [
                {
                    "type": "Return",
                    "tags": [
                        {
                            "code": "return_request",
                            "list": [
                                {
                                    "code": "id",
                                    "value": "bcef07ab-c158-44f1-b619-9d362428ddb2"
                                },
                                {
                                    "code": "item_id",
                                    "value": "id_ancc5_0_0"
                                },
                                {
                                    "code": "item_quantity",
                                    "value": "2"
                                },
                                {
                                    "code": "reason_id",
                                    "value": "003"
                                },
                                {
                                    "code": "reason_desc",
                                    "value": "some detailed reason for return"
                                },
                                {
                                    "code": "images",
                                    "value": "https://some-images-for-item.com"
                                },
                                {
                                    "code": "ttl_approval",
                                    "value": "PT24H"
                                },
                                {
                                    "code": "ttl_reverseqc",
                                    "value": "P3D"
                                },
                                {
                                    "code": "parent_item_id",
                                    "value": "P3121"
                                }
                            ]
                        },
                        {
                            "code": "return_request",
                            "list": [
                                {
                                    "code": "id",
                                    "value": "5100b016-13b8-4ce2-9f1a-d75d623fa82a"
                                },
                                {
                                    "code": "item_id",
                                    "value": "id_5yzai_2_0"
                                },
                                {
                                    "code": "item_quantity",
                                    "value": "2"
                                },
                                {
                                    "code": "reason_id",
                                    "value": "003"
                                },
                                {
                                    "code": "reason_desc",
                                    "value": "some detailed reason for return"
                                },
                                {
                                    "code": "images",
                                    "value": "https://some-images-for-item.com"
                                },
                                {
                                    "code": "ttl_approval",
                                    "value": "PT24H"
                                },
                                {
                                    "code": "ttl_reverseqc",
                                    "value": "P3D"
                                },
                                {
                                    "code": "parent_item_id",
                                    "value": "P3121"
                                }
                            ]
                        }
                    ]
                }
            ]
        }
    }
}'
Response Response Example
{}

Request

Body Params application/json
object {0}
Examples

Responses

🟢200Success
application/json
Body
object {0}
Previous
07 - Respond to cancellation initiated by Seller App - ACK to /on_cancel
Next
08 - Send response to order changes initiated by Seller App - ACK to /on_update
Built with