reseller

is added when reseller has a customer specific business

Get Order Id

Description

Gets the associated Enterprise Email Order Id from the 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 Id is to be fetched.

HTTP Method

GET

Example Test URL Request

US Server


https://test.httpapi.com/api/enterpriseemail/us/orderid.json?auth-userid=0&api-key=key&domain-name=domainname.com

Response

Returns the Order Id (Integer) associated with the specific domain name.

Get Details

Description

Gets the details of an existing Enterprise Order.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required The Order Id for which the details to be fetched.

HTTP Method

GET

Example Test URL Request

US Server


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

Response

Returns a hash map containing details of the Enterprise 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 Enterprise 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 The Order Id which is to be deleted.

HTTP Method

POST

Example Test URL Request

US Server


https://test.httpapi.com/api/enterpriseemail/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 Enterprise 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 Enterprise Email Order.

Parameters

Name Data Type Required / Optional
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required The Order Id 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/enterpriseemail/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 Enterprise 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 Enterprise Email Order.

Parameters

Name Data Type Required / Optional
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required The Order Id 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/enterpriseemail/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 Enterprise 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)

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

Note

invoiceid, sellingcurrencysymbol, sellingamount 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 Enterprise 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 The Order Id 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 Enterprise Email Order, if required.
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/enterpriseemail/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 Enterprise Email Order (entityid)

  • Action Type (actiontype)

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

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

  • Enterprise Email Order Renewal Action Status (actionstatus)

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

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

  • Selling Currency of the Reseller (sellingcurrencysymbol)

  • Selling Curreny Amount (sellingamount)

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

Note

invoiceid, sellingcurrencysymbol, sellingamount 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 Enterprise 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 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.
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/enterpriseemail/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 Domain Registration Order (entityid)

  • Action Type (actiontype)

  • Description of the Domain Registration Action (actiontypedesc)

  • Action Id of the Domain Registration Action (eaqid)

  • Domain Registration Action Status (actionstatus)

  • Description of the Domain Registration Action Status (actionstatusdesc)

  • Invoice Id of the Domain Registration Invoice (invoiceid)

  • Selling Currency of the Reseller (sellingcurrencysymbol)

  • Selling Price for Customers (sellingamount)

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

Note

invoiceid, sellingcurrencysymbol, sellingamount 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.