reseller

is added when reseller has a customer specific business

Add Forward Only Account

Description

Adds a forward only account.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required Order ID of the Domain Registration, Email Hosting, Legacy Web Hosting, Website Builder, Enterprise Email or Digital Certificate Order
email String Required Email address of user
forwards String Required Comma-separated email addresses

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/mail/user/add-forward-only-account.json?auth-userid=0&api-key=key&order-id=0&[email protected]&[email protected],[email protected]

Response

Returns the details of a forward only account addition.

Add User

Description

Adds a user.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required Order ID of the Domain Registration, Email Hosting, Legacy Web Hosting, Website Builder, Enterprise Email or Digital Certificate Order
email String Required Email address of user
passwd String Required Password of user
notification-email String Required Notification email address of user
first-name String Required First name of user
last-name String Required Last name of user
country-code String Required Country Code as per ISO 3166-1 alpha-2
language-code String Required Language Code as per ISO

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/mail/user/add.json?auth-userid=0&api-key=key&order-id=0&[email protected]&passwd=user-password&[email protected]&first-name=firstname&last-name=lastname&country-code=US&language-code=en

Response

Returns the details of user addition.

Get Reseller Pricing Based On Pricing Bands (Mock Response)

Description

Gets mock response of the Reseller's Band Pricing. Eventually this response will be a part of this response.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter

HTTP Method

GET

Example Test URL Request

https://test.httpapi.com/api/mock/products/reseller-price.json?auth-userid=0&api-key=key

Response

Returns a map with the prices of Web Services plans.


{"product-key":{"plan-category":{"band-id":{"pricing":{"action":price},"description":{"plan-category-parameter-key":plan-category-parameter-value}}}}

Example:


{"hosting":{"email_plan":{"0":{"pricing":{"renew":0.0,"add":0.0},"description":{"no_of_mail_accounts":-1,"default":true}},"1":{"description":{"no_of_mail_accounts":1,"default":false}}},"websitebuilder_plan":{"0":{"pricing":{"renew":0.0,"ssl":0.0,"add":0.0},"description":{"no_of_mail_accounts":-1,"default":true,"bandwidth":-1,"noofpages":50,"webspace":-1}},"1":{"description":{"no_of_mail_accounts":0,"default":false,"bandwidth":0,"noofpages":0,"webspace":0}}},"windows_hosting_plan":{"0":{"pricing":{"renew":0.0,"ssl":0.0,"add":0.0},"description":{"no_of_mail_accounts":-1,"default":true,"bandwidth":-1,"webspace":-1}},"1":{"description":{"no_of_mail_accounts":0,"default":false,"bandwidth":0,"webspace":0}}},"linux_hosting_plan":{"0":{"pricing":{"renew":0.0,"ssl":0.0,"add":0.0},"description":{"no_of_mail_accounts":-1,"default":true,"bandwidth":-1,"webspace":-1}},"1":{"description":{"no_of_mail_accounts":1,"default":false,"bandwidth":1,"webspace":1}}}}}

* -1 denotes Unlimited.

* "pricing" key will come only when pricing is set for that particular band.

* "default":true denotes the default band.

Getting Customer Details By Id

Description

Gets the Customer details for the specified Customer Id.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
customer-id Integer Required Customer Id of the Customer

HTTP Method

GET

Example Test URL Request

https://test.httpapi.com/api/customers/details-by-id.json?auth-userid=0&api-key=key&customer-id=0

Response

Returns a hash map containing the below details:

  • Customer Id (customerid)

  • Customer Username (username)

  • Reseller Id of the Parent Reseller (resellerid)

  • Name (name)

  • Company (company)

  • Email Address (useremail)

  • Telephone Number Country Code (telnocc)

  • Telephone Number (telno)

  • First line of address of the Customer (address1)

  • Second line of address of the Customer (address2)

  • Third line of address of the Customer (address3)

  • City (city)

  • State (state)

  • Country Code (country)

  • ZIP Code (zip)

  • Personal Identification Number (pin)

  • Creation Date (creationdt)

  • Current Status (customerstatus)

  • Sales Contact Id (salescontactid)

  • Language Preference for the Control Panel and Emails (langpref)

  • Total Receipts (totalreceipts)

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.

Search Archived Transactions Of Customers

Description

Gets a detailed list of the Customer's Archived Transactions, matching the search criteria.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
no-of-records Integer Required Number of Transactions to be fetched
page-no Integer Required Page number for which details are to be fetched
customer-id Array of Integers Optional Customer Id of the Customers whose archived Transaction are to be fetched
username Array of Strings Optional Username of the Customers whose archived Transactions are to be fetched
transaction-type Array of Strings Optional Type of the Transactions. Possible values can be credit, debit, invoice, receipt.
transaction-key String Optional Transaction key. Possible value can be manually or systemgenerated.
transaction-id Array of Integers Optional Transaction Ids
transaction-description String Optional Transaction description
amt-range-start Integer Optional Lowest amount in the range of Transactions you intend to list
amt-range-end Integer Optional Highest amount in the range of Transactions you intend to list
transaction-date-start String Optional UNIX TimeStamp for listing of Archived Transactions whose Creation Date is greater than transaction-date-start
transaction-date-end String Optional UNIX TimeStamp for listing of Archived Transactions whose Creation Date is less than transaction-date-end
order-by Array of Strings Optional One or more parameters by which you want to sort the Transactions.

Example: If page-no is 1, no-of-records is 30 and order-by is customerid; it will fetch the first 30 Transactions which suit the search criteria sorted by customerid. If page-no is 2, no-of-records is 30 and order-by is customerid; it will fetch the second batch of 30 Transactions sorted by customerid

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/billing/customer-archived-transactions/search.json?auth-userid=0&api-key=key&no-of-records=1&page-no=1

Response

Returns a hash map of the Customer's Archived Transactions containing the below details:

  • Transaction Id (customer_transaction.transid)

  • Transaction Date (customer_transaction.transactiondate)

  • Order Id associated with the Transaction (customer_transaction.orderid)

  • Product Key (customer_transaction.key)

  • Transaction Type (customer_transaction.type)

  • Transaction Description (customer_transaction.description)

  • Whether Transaction is Greedy (greedy)

  • Customer Id Associated with the Transaction (customer_transaction.customerid)

  • Selling Currency Symbol of the Parent Reseller (customer_transaction.sellingcurrencysymbol)

  • Transaction Amount in the Selling Currency (customer_transaction.sellingamount)

  • Unutilised Transaction Amount in the Selling Currency (customer_transaction.unutilisedsellingamount)

  • Accounting Currency Symbol of the Parent Reseller (customer_transaction.accountingcurrencysymbol)

  • Transaction Amount in the Accounting Currency (customer_transaction.accountingamount)

  • Unutilised Transaction Amount in the Accounting Currency (customer_transaction.unutilisedaccountingamount)

  • Foreign Exchange Difference (forexdiff)

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.

Search Transactions of a Customer

Description

Gets a detailed list of Customer's Transactions, matching the search criteria.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
no-of-records Integer Required Number of Transactions to be fetched
page-no Integer Required Page number for which details are to be fetched
customer-id Array of Integers Optional Customer Id of the Customers(s) whose Transactions are to be fetched
username Array of Strings Optional Username of the Customer(s) whose Transactions are to be fetched
transaction-type Array of Strings Optional Type of the Transactions. Possible values can be credit, debit, invoice, receipt.
transaction-key String Optional Transaction key. Possible value can be manually or systemgenerated.
transaction-id Array of Integers Optional Transaction Ids
transaction-description String Optional Transaction description
balance-type String Optional

Payment status for the Transaction. Possible values can be:

  • onlybalanced: Will fetch all transactions that have been balanced or paid for

  • onlyunbalanced: Will fetch all transactions that are yet to be balanced or paid

If this parameter is not included in the API call, all Transactions (balanced as well as unbalanced) will be fetched.
amt-range-start Integer Optional Lowest amount in the range of Transactions you intend to list
amt-range-end Integer Optional Highest amount in the range of Transactions you intend to list
transaction-date-start String Optional UNIX TimeStamp for listing of Transactions whose Creation Date is greater than transaction-date-start
transaction-date-end String Optional UNIX TimeStamp for listing of Transactions whose Creation Date is less than transaction-date-end
order-by Array of Strings Optional One or more parameters by which you want to sort the Transactions.

Example: If page-no is 1, no-of-records is 30 and order-by is customer-id; it will fetch the first 30 Transactions which match the search criteria sorted by customer-id. If page-no is 2, no-of-records is 30 and order-by is customer-id; it will fetch the second batch of 30 Transactions sorted by customer-id.

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/billing/customer-transactions/search.json?auth-userid=0&api-key=key&no-of-records=1&page-no=1

Response

Returns a hash map of the Customer's Transactions containing the below details:

  • Transaction Id (customer_transaction.transid)

  • Transaction Date (customer_transaction.transactiondate)

  • Order Id associated with the Transaction (customer_transaction.orderid)

  • Product Key (customer_transaction.key)

  • Transaction Type (customer_transaction.type)

  • Transaction Description (customer_transaction.description)

  • Whether Transaction is Greedy (greedy)

  • Customer Id Associated with the Transaction (customer_transaction.customerid)

  • Selling Currency Symbol of the Parent Reseller (customer_transaction.sellingcurrencysymbol)

  • Transaction Amount in the Selling Currency (customer_transaction.sellingamount)

  • Unutilised Transaction Amount in the Selling Currency (customer_transaction.unutilisedsellingamount)

  • Accounting Currency Symbol of the Parent Reseller (customer_transaction.accountingcurrencysymbol)

  • Transaction Amount in the Accounting Currency (customer_transaction.accountingamount)

  • Unutilised Transaction Amount in the Accounting Currency (customer_transaction.unutilisedaccountingamount)

  • Foreign Exchange Difference (forexdiff)

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.

Subscribe to reseller