Management API

Base Resource URL:

     https://[server-name]/api/v01/resellers

Description:

Provides access to resellers registered in the system

Available sub-resources:

Resource URL Description
https://[server-name]/api/v01/resellers/[reseller-code]    Reseller code of a reseller, on which action is required.

In cases when an external identifier (Reference Number) is desired to be used in place of Reseller Code, the star (*) must be used, followed by the external identifier assigned to the reseller.

For example,

/resellers/1.xml - reseller identification is done using Reseller Code, in this case 1

/resellers/*004.xml - reseller identification is done using Reference Number, in this case 004

Supported Actions:

find  
Method:  GET       Implicit:  Yes       Returns:  Reseller[]      
Consumes:  query  Produces:  json, xml 
 
Returns list of available resellers based on specified search conditions

Parameters:
# Name Type Required Default Description
01 offset Integer No 0 Index of the first record returned to the customer from the search result of a web search.
02 limit Integer No 20 Maximum number of records to load per single search web call made by the customer.
03 createDateFrom DateRange No Query parameter to search resellers by their provider creation date. All resellers created within the date range defined will be included.

Represents a date range with lower and upper limits. Range can include only lower or only upper limit.
04 createDateTo DateRange No Query parameter to search resellers by their provider creation date. All resellers created within the date range defined will be included.

Represents a date range with lower and upper limits. Range can include only lower or only upper limit.
05 merchantName Integer No Query parameter to search resellers by full or partial merchant's name (soundex on full name is supported as well).
06 resellerName String(255) No Query parameter to search resellers by full or partial name (soundex on full name is supported as well).
07 code Integer No Query parameter to search resellers by code.
08 id Integer No Query parameter to search resellers by id.
09 active Boolean No Query parameter to search resellers by activity status.

Response Codes: view