Add

KB Tags associated with this article:
Use all tags
KB Tags
eelite
reseller
Body

Description

Places an Business Email Order for the specified domain name.

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

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.

Note

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

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.