Search partners
Last updated: 06-Apr-2017
Search partners using their company name or contact email. If a generic string is provided, the system searches for matches in company names and contact emails for all your partners.
Parameters | Type/Description |
---|---|
sessionID | Required (string) |
Session identifier, output by the Login method. An exception will be thrown if the values are incorrect. | |
searchString | Required (string) |
Can be either the company name or contact email of the partner. The system searches generic strings in both the names of the companies as well as the contact email addresses. |
Parameters | Type/Description |
---|---|
Partner | Array of objects |
<?php
require ('PATH_TO_AUTH'); // Authentication example: https://knowledgecenter.avangate.com/Integration/Channel_Manager_API/JSON-RPC/02Authentication
$searchString = "YOUR_SEARCH_STRING";
$jsonRpcRequest = array (
'jsonrpc' => '2.0',
'id' => $i++,
'method' => 'searchPartners',
'params' => array($sessionID, $searchString)
);
$response = callRPC((Object)$jsonRpcRequest, $host);
Error | Description |
---|---|
INVALID_SEARCH |
Invalid value. Please use a string to search. |