Schemas
UpdateResellerSuspensionRequest
suspendedWhen true, suspends the reseller; when false, unsuspends.
reasonReason for the action.
CreateResellerRequest
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
referrerCodeSignUpResellerProductsRequest
productKeysProduct keys to sign up for. Sent as a JSON array in the request body.
UpdateResellerProfileRequest
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.
ResellerSearchResultDto
resellerIdreseller Id
usernameusername
namename
companycompany
citycity
statestate
countrycountry
resellerStatusreseller Status
totalReceiptstotal Receipts
GsuiteTransferTokenEntryDto
tokenKeyTransfer token key
tokenValueTransfer token value
ResellerProfileDto
companycompany
namename
brandNamebrand Name
resellerIdreseller Id
parentIdparent Id
resellerStatusreseller Status
creationDatecreation Date
totalReceiptstotal Receipts
addressLine1address Line1
addressLine2address Line2
citycity
statestate
stateIdstate Id
otherStateother State
zipcodezipcode
countrycountry
phoneCountryCodephone Country Code
phonephone
emailusernameusername
passwordpassword
pinpin
languagePreferencelanguage Preference
sfLangPrefstorefront language preference
sellingCurrencySymbolselling Currency Symbol
accountingCurrencySymbolaccounting Currency Symbol
salesContactIdsales Contact Id
salesRepresentativesales Representative
billingFromNamebilling From Name
billingPhoneCountryCodebilling Phone Country Code
billingPhonebilling Phone
billingEmailAddressbilling Email Address
billingSignaturebilling Signature
salesFromNamesales From Name
salesPhoneCountryCodesales Phone Country Code
salesPhonesales Phone
salesEmailAddresssales Email Address
salesSignaturesales Signature
technicalSupportPhoneCountryCodetechnical Support Phone Country Code
technicalSupportPhonetechnical Support Phone
technicalSupportEmailAddresstechnical Support Email Address
technicalSupportUrltechnical Support Url
abuseFromNameabuse From Name
abuseEmailAddressabuse Email Address
abuseSignatureabuse Signature
parentSellingCurrencySymbolparent Selling Currency Symbol
fundThresholdfund Threshold
minReceiptRequiredmin Receipt Required
minimumBillingAmountminimum Billing Amount
minimumAddFundAmountminimum Add Fund Amount
directPaymentDetailsCustomerdirect Payment Details Customer
directPaymentDetailsResellerdirect Payment Details Reseller
showDirectPaymentCustomershow Direct Payment Customer
showDirectPaymentResellershow Direct Payment Reseller
conversionRateconversion Rate
useSystemConversionRateuse System Conversion Rate
sendRiskReportMailsend Risk Report Mail
isResellerRestrictedis Reseller Restricted
futureProductSignupfuture Product Signup
parentBrandingUrlparent Branding Url
partialSupersite2Urlpartial Supersite2 Url
partialPartnerSiteUrlpartial Partner Site Url
partialStorefrontUrlpartial Storefront Url
fullyStorefrontUrlfully Storefront Url
suffixUrlsuffix Url
brandingUrlbranding Url
supersite2Urlsupersite2 Url
supersiteUrlsupersite Url
partnerSiteUrlpartner Site Url
australiaGstEnabledaustralia Gst Enabled
australiaGstIdaustralia Gst Id
singaporeGstEnabledsingapore Gst Enabled
singaporeGstIdsingapore Gst Id
newZealandGstEnablednew Zealand Gst Enabled
newZealandGstIdnew Zealand Gst Id
indianGstEnabledindian Gst Enabled
indianServiceTaxEnabledindian Service Tax Enabled
indianServiceTaxIdindian Service Tax Id
russiaVatEnabledrussia Vat Enabled
russiaVatIdrussia Vat Id
brTaxPayerIdbr Tax Payer Id
chargeVatcharge Vat
usSalesTaxIdus Sales Tax Id
isWebProis Web Pro
isOldReselleris Old Reseller
isChildInfoAllowedis Child Info Allowed
isDominicanTaxConfiguredByParentis Dominican Tax Configured By Parent
supportAutoRenewsupport Auto Renew
supportsAutoRenewsupports Auto Renew
switchPanelEnabledswitch Panel Enabled
twoFactorAuthEnabledtwo Factor Auth Enabled
twoFactorGoogleAuthEnabledtwo Factor Google Auth Enabled
twoFactorSmsAuthEnabledtwo Factor Sms Auth Enabled
Google Workspace transfer token entries
CreateResellerResponse
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
GetDefaultCustomerIdResponse
defaultCustomerIdDefault customer identifier
statusOperation status
messageStatus message
GetResellerProfileResponse
Reseller profile details
statusOperation status
messageStatus message
SearchResellersResponse
totalItemsTotal matching resellers in the database
itemsOnPageNumber of resellers returned on this page
Reseller search results
statusOperation status
messageStatus message
SignUpResellerProductsResponse
actionStatusAction status
actionStatusDescAction status description
actionTypeDescAction type description
entityIdEntity identifier
eaqIdAction queue identifier
actionTypeAction type
descriptionOperation description
statusOperation status
messageStatus message
UpdateResellerProfileResponse
actionStatusAction status
actionStatusDescAction status description
actionTypeDescAction type description
entityIdEntity identifier
eaqIdAction queue identifier
actionTypeAction type
descriptionOperation description
statusOperation status
messageStatus message

