reseller

is added when reseller has a customer specific business

Delete Add-on

Description

Deletes the specified Add-on of the Managed Server Linux 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 specified Add-on is to be deleted
addon-id Integer Required ID of the Add-on to be deleted. Use this method to fetch the Add-on ID.

HTTP Method

POST

Example Test URL Request


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

Response

Returns a hash map containing the below details:

  • Domain Name (description)

  • Order ID of the Managed Server Order (entityid)

  • Action Type (actiontype)

  • Description of the Delete Add-on Action (actiontypedesc)

  • Action ID of the Delete Add-on Action (eaqid)

  • Delete Add-on Action Status (actionstatus)

  • Description of the Delete Add-on Action Status (actionstatusdesc)

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

Add Add-on

Description

Adds the specified Add-on for an existing Managed Server Linux 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 specified Add-on(s) is/are to be added
addon String Required Add-ons can be one of the following:
  • ipaddress
  • whmcs
  • storage_1
  • storage_2
  • storage_3
  • storage_4
  • storage_5
invoice-option String Required This parameter will decide how the Customer's Invoice will be handled. Values can be: NoInvoice, PayInvoice, KeepInvoice or OnlyAdd.

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/managedserver/linux/us/addon/add.json?auth-userid=0&api-key=key&order-id=0&addon=ssl&invoice-option=NoInvoice

Response

Returns a hash map containing the below details:

  • Domain Name (description)

  • Order ID of the Managed Server Order (entityid)

  • Action Type (actiontype)

  • Description of the Add Add-on Action (actiontypedesc)

  • Action ID of the Add Add-on Action (eaqid)

  • Add Add-on Action Status (actionstatus)

  • Description of the Add Add-on Action Status (actionstatusdesc)

  • Invoice ID of the Add Add-on Invoice (invoiceid)

  • Selling Currency of the Reseller (sellingcurrencysymbol)

  • Transaction Amount in the Selling Currency (sellingamount)

  • Unutilised Transaction Amount in the Selling Currency (unutilisedsellingamount)

  • Customer ID associated with the Managed Server 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 Managed Server Linux 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
auto-renew Boolean Required

Enables / Disables the Auto Renewal setting for the Order

Note

Auto-Renewal
invoice-option String Required This parameter will decide how the Customer's Invoice will be handled. Values can be: NoInvoice, PayInvoice, KeepInvoice or OnlyAdd.

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/managedserver/linux/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 Managed Server Order (entityid)

  • Action Type (actiontype)

  • Description of the Managed Server Order Renew Action (actiontypedesc)

  • Action ID of the Managed Server Order Renew Action (eaqid)

  • Managed Server Order Renew Action Status (actionstatus)

  • Description of the Managed Server Order Renew Action Status (actionstatusdesc)

  • Invoice ID of the Managed Server Order Renew Invoice (invoiceid)

  • Selling Currency of the Reseller (sellingcurrencysymbol)

  • Transaction Amount in the Selling Currency (sellingamount)

  • Unutilised Transaction Amount in the Selling Currency (unutilisedsellingamount)

  • Customer ID associated with the Managed Server 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 a Managed Server Linux 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 to be 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 to be placed
plan-id Integer Required The plan under which the Order should be added. To fetch the plan details i.e., plan-id, etc., use this method.
addon Array of Strings Optional Additional Add-ons to be purchased. Values can be:
  • ipaddress
  • whmcs
  • storage_1
  • storage_2
  • storage_3
  • storage_4
  • storage_5
auto-renew Boolean Required

Enables / Disables the Auto Renewal setting for the Order

Note

Auto-Renewal
invoice-option String Required This parameter will decide how the Customer's Invoice will be handled. Values can be: NoInvoice, PayInvoice, KeepInvoice or OnlyAdd.

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/managedserver/linux/us/add.json?auth-userid=0&api-key=key&domain-name=name&customer-id=0&months=0&plan-id=0&invoice-option=NoInvoice

Response

Returns a hash map containing the below details:

  • Domain Name (description)

  • Order ID of the Managed Server Order (entityid)

  • Action Type (actiontype)

  • Description of the Managed Server Order Add Action (actiontypedesc)

  • Action ID of the Managed Server Order Add Action (eaqid)

  • Managed Server Order Add Action Status (actionstatus)

  • Description of the Managed Server Order Add Action Status (actionstatusdesc)

  • Invoice ID of the Managed Server Order Add Invoice (invoiceid)

  • Selling Currency of the Reseller (sellingcurrencysymbol)

  • Transaction Amount in the Selling Currency (sellingamount)

  • Unutilised Transaction Amount in the Selling Currency (unutilisedsellingamount)

  • Customer ID associated with the Managed Server 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.

Get DNS Records

Description

Gets the DNS records of an 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 Business Email Order

HTTP Method

GET

Example Test URL Request

US Server


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

Response

Returns an Array of hash map containing the below details of the DNS records associated with the Business Email Order:

  • Type of DNS Record (type)

  • Name or the Fully Qualified Domain Name associated with the DNS record (host)

  • Data of Type-specific relevance, such as the IP Address for Address Records or Hostname for MX records (value)

  • Class of the DNS Record (class)

Get Customer Pricing

Description

Use this method to get details of the Customer Pricing for the Business Email Plans.

Response

Returns a map with the prices of the Business Email Plans along with the prices of the other products.

The response structure for the Business Email will be:


"productkey":
{
"email_account_ranges":
{
"plan_specifications":
{
"action":
{
"tenure-in-months":price
}
}
}
}

Example:

US Server


"eeliteus":
{
"email_account_ranges":
{
"1-5":
{
"renew":
{
"6":100.0, "3":100.0, "12":100.0, "1":100.0
},
"add":
{
"6":100.0, "3":100.0, "1":100.0, "12":100.0
}
},
"6-25":
{
"renew":
{
"6":100.0, "3":100.0, "12":100.0, "1":100.0
},
"add":
{
"6":100.0, "3":100.0, "1":100.0, "12":100.0
}
}
"26-49":
{
"renew":
{
"6":100.0, "3":100.0, "12":100.0, "1":100.0
},
"add":
{
"6":100.0, "3":100.0, "1":100.0, "12":100.0
}
}
"50-200000":
{
"renew":
{
"6":100.0, "3":100.0, "12":100.0, "1":100.0
},
"add":
{
"6":100.0, "3":100.0, "1":100.0, "12":100.0
}
}
}
}

Search Orders

Description

Gets a list and details of the Business Email Orders 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 Orders to be fetched
page-no Integer Required Page number for which details are to be fetched
order-id Array of Integers Optional Order ID(s) of the Business Email Order(s) whose details need to be fetched
reseller-id Array of Integers Optional Reseller ID(s) of the Resellers whose Orders need to be fetched
customer-id Array of Integers Optional Customer ID(s) of the Customers whose Orders need to be fetched
show-child-orders Boolean Optional Whether Sub-Reseller Orders need to be fetched or not
status Array of Strings Optional Status of the Order: Active, InActive, Deleted, etc.
domain-name String Optional Domain name associated with the Business Email Order
creation-date-start String Optional UNIX TimeStamp for listing of the Business Email Orders whose Creation Date is greater than creation-date-start
creation-date-end String Optional UNIX TimeStamp for listing of the Business Email Orders whose Creation Date is less than creation-date-end
expiry-date-start String Optional UNIX TimeStamp for listing of the Business Email Orders whose expiry date is greater than expiry-date-start
expiry-date-end String Optional UNIX TimeStamp for listing of the Business Email Orders whose expiry date is less than expiry-date-end
order-by Array of Strings Optional One or more parameters by which you want to sort the Orders. Default is orderid.

Example:

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

HTTP Method

GET

Example Test URL Request

US Server


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

Response

Returns a hash map containing the below details of the Business Email Orders which match the search criteria:

  • Domain Name (entity.description)

  • Order Id (orders.orderid)

  • Customer Id (entity.customerid)

  • Order Addition Timestamp (orders.creationdt)

  • Order Creation Timestamp (orders.creationtime)

  • Expiry Timestamp (orders.endtime)

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

  • Product Name (entitytype.entitytypename)

  • Product Key (entitytype.entitytypekey)

  • GEO Location (hosting_group_info.location)

Subscribe to reseller