POST
api/ONDC/SearchByItem
Request Information
Body Parameters
searchbyitemsName | Description | Type | Additional information |
---|---|---|---|
context | Context |
None. |
|
message | searchbyitemsMessage |
None. |
Request Formats
application/json, text/json
{ "context": { "domain": "sample string 1", "country": "sample string 2", "city": "sample string 3", "action": "sample string 4", "core_version": "sample string 5", "bap_id": "sample string 6", "bap_uri": "sample string 7", "transaction_id": "sample string 8", "message_id": "sample string 9", "timestamp": "2025-06-18T11:56:49.4816601+00:00", "ttl": "sample string 11" }, "message": { "intent": { "item": { "descriptor": { "name": "sample string 1" } }, "fulfillment": { "end": { "location": { "gps": "sample string 1" } } } } } }
text/html
{"context":{"domain":"sample string 1","country":"sample string 2","city":"sample string 3","action":"sample string 4","core_version":"sample string 5","bap_id":"sample string 6","bap_uri":"sample string 7","transaction_id":"sample string 8","message_id":"sample string 9","timestamp":"2025-06-18T11:56:49.4816601+00:00","ttl":"sample string 11"},"message":{"intent":{"item":{"descriptor":{"name":"sample string 1"}},"fulfillment":{"end":{"location":{"gps":"sample string 1"}}}}}}
application/xml, text/xml
<searchbyitems xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FDCMSAdminAPI.ViewModel"> <context> <action>sample string 4</action> <bap_id>sample string 6</bap_id> <bap_uri>sample string 7</bap_uri> <city>sample string 3</city> <core_version>sample string 5</core_version> <country>sample string 2</country> <domain>sample string 1</domain> <message_id>sample string 9</message_id> <timestamp>2025-06-18T11:56:49.4816601+00:00</timestamp> <transaction_id>sample string 8</transaction_id> <ttl>sample string 11</ttl> </context> <message> <intent> <fulfillment> <end> <location> <gps>sample string 1</gps> </location> </end> </fulfillment> <item> <descriptor> <name>sample string 1</name> </descriptor> </item> </intent> </message> </searchbyitems>
application/x-www-form-urlencoded
Sample not available.
Response Information
Description:
Return type: ONDCResponceModule
Response Formats
application/json, text/json
{ "context": { "domain": "sample string 1", "country": "sample string 2", "city": "sample string 3", "action": "sample string 4", "core_version": "sample string 5", "bap_id": "sample string 6", "bap_uri": "sample string 7", "transaction_id": "sample string 8", "message_id": "sample string 9", "timestamp": "2025-06-18T11:56:49.4972893+00:00", "ttl": "sample string 11" }, "message": { "ack": { "status": "sample string 1" } }, "error": { "type": "sample string 1", "code": "sample string 2", "message": "sample string 3" } }
text/html
{"context":{"domain":"sample string 1","country":"sample string 2","city":"sample string 3","action":"sample string 4","core_version":"sample string 5","bap_id":"sample string 6","bap_uri":"sample string 7","transaction_id":"sample string 8","message_id":"sample string 9","timestamp":"2025-06-18T11:56:49.4972893+00:00","ttl":"sample string 11"},"message":{"ack":{"status":"sample string 1"}},"error":{"type":"sample string 1","code":"sample string 2","message":"sample string 3"}}
application/xml, text/xml
<ONDCResponceModule xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FDCMSAdminAPI.ViewModel"> <context> <action>sample string 4</action> <bap_id>sample string 6</bap_id> <bap_uri>sample string 7</bap_uri> <city>sample string 3</city> <core_version>sample string 5</core_version> <country>sample string 2</country> <domain>sample string 1</domain> <message_id>sample string 9</message_id> <timestamp>2025-06-18T11:56:49.4972893+00:00</timestamp> <transaction_id>sample string 8</transaction_id> <ttl>sample string 11</ttl> </context> <error> <code>sample string 2</code> <message>sample string 3</message> <type>sample string 1</type> </error> <message> <ack> <status>sample string 1</status> </ack> </message> </ONDCResponceModule>