Create a new reseller account
Creates a Sub-Reseller Account using the details provided.
Create a new reseller account › Request Body
usernameUsername for the Sub-Reseller account. Username should be an email address.
passwordPassword for the Sub-Reseller account. Note Password related information
nameName of the Sub-Reseller
companyCompany Name of the Sub-Reseller
languagePreferenceLanguage Code as per ISO
addressLine1Address line 1 of the Sub-Reseller's address
cityCity
stateState
countryCountry Code as per ISO 3166-1 alpha-2
zipcodeZIP code
phoneCountryCodePhone number Country Code
phonePhone number
accountingCurrencySymbolAccounting Currency Symbol of Sub-Reseller
sellingCurrencySymbolSelling Currency Symbol of Sub-Reseller
addressLine2Address line 2 of the Sub-Reseller's address
addressLine3Address line 3 of the Sub-Reseller's address
altPhoneCountryCodeAlternate phone country code
altPhoneAlternate phone number
faxCountryCodeFax number country code
faxFax number
mobileCountryCodeMobile number Country Code
mobileMobile number
salesContactIdSales User Id of Parent Sub-Reseller
addDefaultCustomerAdd Default Customer.
vatIdVAT ID for EU VAT
indianServiceTaxIdIndian Service Tax Id.
indianGstIdIndian Gst Id.
salesTaxExemptionIdSales Tax Exemption Id.
russiaVatIdRussia Vat Id.
australiaGstIdAustralia Gst Id.
newzealandGstIdNewzealand Gst Id.
singaporeGstIdSingapore Gst Id.
smsConsentIncase of a US based sub-reseller, consent is required to receive SMSes for low fund or loss alerts
autoActivatePass true if the reseller account should be activated immediately
isWebproIs Webpro.
productSignupListProduct Signup List.
consentConsent.
acceptPolicyAccept Terms and Conditions and Privacy Policy to create an account
marketingEmailConsentIn case of EEA (European Economic Area) countries capture consent to receive marketing emails
referrerCodeCreate a new reseller account › Responses
OK
resellerIdNewly created reseller identifier
activationStatusSub-Reseller signup option (activation status)
eaqIdEntity action queue identifier
minReceiptRequiredMinimum total receipts required for activation
statusOverall status of the request
Get default customer identifier for the reseller
Returns the default customer identifier for the authenticated reseller.
Get default customer identifier for the reseller › Responses
OK
defaultCustomerIdDefault customer identifier
statusOperation status
messageStatus message
Get reseller profile details
Returns Reseller-specific details such as Branding, Personal Details, etc.
query Parameters
resellerIdReseller Id of the Sub-Reseller whose details need to be fetched. In case the Reseller Id is not provided, details of the Reseller making the API call will be returned.
Get reseller profile details › Responses
OK
Reseller profile details
statusOperation status
messageStatus message
Search and list resellers
Returns sub-resellers matching the search criteria, with pagination.
query Parameters
noOfRecordsNumber of records to be fetched. This should be a value between 10 to 500.
pageNoPage number for which details are to be fetched
usernameUsername of Sub-Reseller. Username should be an email address.
nameName of Sub-Reseller
companyCompany Name of Sub-Reseller
cityCity
stateState
countrySearch and list resellers › Responses
OK
totalItemsTotal matching resellers in the database
itemsOnPageNumber of resellers returned on this page
Reseller search results
statusOperation status
messageStatus message
Sign up reseller for additional products
Signs up the reseller for additional products.
Sign up reseller for additional products › Request Body
productKeysProduct keys to sign up for. Sent as a JSON array in the request body.
Sign up reseller for additional products › Responses
OK
actionStatusAction status
actionStatusDescAction status description
actionTypeDescAction type description
entityIdEntity identifier
eaqIdAction queue identifier
actionTypeAction type
descriptionOperation description
statusOperation status
messageStatus message
Suspend or unsuspend a reseller account
Suspends or unsuspends a reseller account.
path Parameters
resellerIdSuspend or unsuspend a reseller account › Request Body
suspendedWhen true, suspends the reseller; when false, unsuspends.
reasonReason for the action.
Suspend or unsuspend a reseller account › Responses
OK
successWhether the operation succeeded.
statusStatus text.
messageResult message.
Update reseller profile details
Modifies the Account details of the specified Sub-Reseller.
Update reseller profile details › Request Body
resellerIdReseller Id of the Sub-Reseller for whom the details need to be modified
usernameUsername of the Sub-Reseller. Username should be an email address.
languagePreferenceLanguage Code as per ISO
addressLine1Address line 1 of the Sub-Reseller's address
cityCity
stateState
zipcodeZIP code
phoneCountryCodePhone number Country Code
phonePhone number
addressLine2Address line 2 of the Sub-Reseller's address
addressLine3Address line 3 of the Sub-Reseller's address
altPhoneCountryCodeAlternate phone country code
altPhoneAlternate phone number
faxCountryCodeFax number country code
faxFax number
mobileCountryCodeMobile number Country Code
mobileMobile number
brandNameBrand name used for branding
websiteUrlBranded website URL
vatIdVAT ID for EU VAT
indianServiceTaxIdIndian Service Tax Id.
indianGstIdGST ID for India GST
russiaVatIdVAT ID for Russia VAT
australiaGstIdGST ID for Australia GST
newzealandGstIdGST ID for New Zealand GST
singaporeGstIdGST ID for Singapore GST
smsConsentSms Consent.
Update reseller profile details › Responses
OK
actionStatusAction status
actionStatusDescAction status description
actionTypeDescAction type description
entityIdEntity identifier
eaqIdAction queue identifier
actionTypeAction type
descriptionOperation description
statusOperation status
messageStatus message