reseller

is added when reseller has a customer specific business

Get Details

Description

Gets the details of an existing Business Email Order.

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 Order for which the details are to be fetched

HTTP Method

GET

Example Test URL Request

US Server


https://test.httpapi.com/api/eelite/us/details.json?auth-userid=0&api-key=key&order-id=0

Response

Returns a hash map containing details of the Business Email Order as below:

  • Order Id (entityid)

  • Order Description (description)

  • Domain Name (domainname)

  • Current Order Status under the System (currentstatus) - value will be InActive, Active, Suspended, Pending Delete Restorable, Deleted or Archived

  • Product Category (productcategory)

  • Product Key (productkey)

  • Order Creation Date (creationtime)

  • Expiry Date (endtime)

  • Whether Order belongs to a Customer directly under the Reseller (isImmediateReseller)

  • Reseller Chain by Reseller Id (parentkey)

  • Customer Id Associated with the Order (customerid)

  • Number of Email Accounts (emailaccounts)

  • Whether Order Suspended due to Expiry (isOrderSuspendedUponExpiry)

  • Whether Order Suspended by Parent Reseller (orderSuspendedByParent)

  • Whether Order Deletion is Allowed (allowdeletion)

Delete

Description

Deletes an existing Business Email Order.

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 Order which is to be deleted

HTTP Method

POST

Example Test URL Request

US Server


https://test.httpapi.com/api/eelite/us/delete.json?auth-userid=0&api-key=key&order-id=0

Response

Returns a hash map containing the below details:

  • Domain Name (description)

  • Order Id of the Business Email Order (entityid)

  • Action Id of the Order Unsuspension Action (eaqid)

  • Action Type (actiontype)

  • Description of the Order Deletion Action (actiontypedesc)

  • Order Deletion Action Status (actionstatus)

  • Description of the Order Deletion Action Status (actionstatusdesc)

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

Delete Email Accounts

Description

Deletes Email Accounts from an existing Business Email Order.

Parameters

Name Data Type Required / Optional
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required Order ID of the Order for which Email Accounts need to be deleted
no-of-accounts Integer Required The number of Email Accounts to be deleted

HTTP Method

POST

Example Test URL Request

US Server


https://test.httpapi.com/api/eelite/us/delete-email-account.json?auth-userid=0&api-key=key&order-id=0&no-of-accounts=2

Response

Returns a hash map containing the below details:

  • Domain Name (description)

  • Order Id of the Business Email Order (entityid)

  • Action Type (actiontype)

  • Description of the Email Accounts Deletion Action (actiontypedesc)

  • Action Id of the Email Accounts Deletion Action (eaqid)

  • Email Accounts Deletion Action Status (actionstatus)

  • Description of the Email Accounts Deletion Action Status (actionstatusdesc)

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

Add Email Accounts

Description

Adds Email Accounts to an existing Business Email Order.

Parameters

Name Data Type Required / Optional
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required Order ID of the Order for which Email Accounts need to be added
no-of-accounts Integer Required The number of Email Accounts to be added
invoice-option String Required This parameter will decide how the Customer Invoices will be handled. Values can be: NoInvoice, PayInvoice, KeepInvoice, OnlyAdd

HTTP Method

POST

Example Test URL Request

US Server


https://test.httpapi.com/api/eelite/us/add-email-account.json?auth-userid=0&api-key=key&order-id=0&no-of-accounts=10&invoice-option=NoInvoice

Response

Returns a hash map containing the below details:

  • Domain Name (description)

  • Order Id of the Business Email Order (entityid)

  • Action Type (actiontype)

  • Description of the Email Accounts Addition Action (actiontypedesc)

  • Action Id of the Email Accounts Addition Action (eaqid)

  • Email Accounts Addition Action Status (actionstatus)

  • Description of the Email Accounts Addition Action Status (actionstatusdesc)

  • Invoice Id of the Domain Renewal Invoice (invoiceid)

  • Selling Currency of the Reseller (sellingcurrencysymbol)

  • Selling Curreny Amount (sellingamount)

  • Unutilised Transaction Amount in the Selling Currency (unutilisedsellingamount)

  • Customer Id associated with the Domain Name Order (customerid)

Note

invoiceid, sellingcurrencysymbol, sellingamount, unutilisedsellingamount and customerid will not be returned if invoice-option is set to NoInvoice.

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

Renew

Description

Renews an existing Business Email Order.

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 Order which is to be renewed
months Integer Required The number of months for which the Order is to be renewed
no-of-accounts Integer Optional Additional Email Accounts to be purchased for the Business Email Order, if required
auto-renew Boolean Required

Enables / Disables the Auto Renewal setting for the Order

invoice-option String Required This parameter will decide how the Customer Invoices will be handled. Values can be: NoInvoice, PayInvoice, KeepInvoice, OnlyAdd

HTTP Method

POST

Example Test URL Request

US Server


https://test.httpapi.com/api/eelite/us/renew.json?auth-userid=0&api-key=key&order-id=0&months=0&invoice-option=NoInvoice

Response

Returns a hash map containing the below details:

  • Domain Name (description)

  • Order Id of the Business Email Order (entityid)

  • Action Type (actiontype)

  • Description of the Business Email Order Renewal Action (actiontypedesc)

  • Action Id of the Business Email Order Renewal Action (eaqid)

  • Business Email Order Renewal Action Status (actionstatus)

  • Description of the Business Email Order Renewal Action Status (actionstatusdesc)

  • Invoice Id of the Business Email Order Renewal Invoice (invoiceid)

  • Selling Currency of the Reseller (sellingcurrencysymbol)

  • Selling Curreny Amount (sellingamount)

  • Unutilised Transaction Amount in the Selling Currency (unutilisedsellingamount)

  • Customer Id associated with the Business Email Order (customerid)

Note

invoiceid, sellingcurrencysymbol, sellingamount, unutilisedsellingamount and customerid will not be returned if invoice-option is set to NoInvoice.

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

Add

Description

Places an Business Email Order for the specified domain name.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
domain-name String Required The domain name for which the Order is placed
customer-id Integer Required The Customer ID of the Customer under whom the Order should be added
months Integer Required The number of months for which the Order is placed
no-of-accounts Integer Required The number of email accounts required
auto-renew Boolean Required

Enables / Disables the Auto Renewal setting for the Order.

invoice-option String Required This parameter will decide how the Customer Invoices will be handled. Values can be: NoInvoice, PayInvoice, KeepInvoice, OnlyAdd

HTTP Method

POST

Example Test URL Request

US Server


https://test.httpapi.com/api/eelite/us/add.json?auth-userid=0&api-key=key&domain-name=name&customer-id=0&months=0&no-of-accounts=15&invoice-option=NoInvoice

Response

Returns a hash map containing the below details:

  • Domain Name (description)

  • Order Id of the Business Email Order (entityid)

  • Action Type (actiontype)

  • Description of the Business Email Order Add Action (actiontypedesc)

  • Action Id of the Business Email Order Add Action (eaqid)

  • Business Email Order Add Action Status (actionstatus)

  • Description of the Business Email Order Add Action Status (actionstatusdesc)

  • Invoice Id of the Business Email Order Add Invoice (invoiceid)

  • Selling Currency of the Reseller (sellingcurrencysymbol)

  • Selling Price for Customers (sellingamount)

  • Unutilised Transaction Amount in the Selling Currency (unutilisedsellingamount)

  • Customer Id associated with the Business Email Order (customerid)

Note

invoiceid, sellingcurrencysymbol, sellingamount, unutilisedsellingamount and customerid will not be returned if invoice-option is set to NoInvoice.

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

Business Email Setup Guide

As a Reseller, you need to take the following steps in order to start selling the Business Email Product to your Customers and Sub-Resellers:

  • Ensure that you are Selling the Business Email
    Product. See details

  • Set your Selling Price for Business Email. See details

  • Select which Plans to display on your SuperSite. See details

  • If Tax is applicable to the Business Email Product in your Country, you may use our Tax Engine to collect it from your Customers and
    Sub-Resellers. See details