domorder

Domain Products

Getting the Reseller Pricing

Description

Gets the Reseller Slab Pricing.

Note

It is recommended you cache all pricing information to ensure you do not have to send API queries to the platform. As there are a huge number of products, the accompanying data may cause longer wait time than usual.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
reseller-id Integer Optional Reseller ID of the Reseller whose Slab Pricing has to be retrieved. By default, Pricing of the current user will be retrieved.

HTTP Method

GET

Example Test URL Request

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

Response

Returns a hash map with the Slab based Selling Price for the specified Reseller or the Reseller whose authorization details are used. The response structure will be:

Domain Names (TLDs)

"productkey":
{
"slab-order":
{
"pricing":
{
"action-name":
{
"tenure-in-years":"price"
}
}
"category":
{
"slab-category":
{
"name":"category-name",
"quantity":"category-quantity"
}
}
}
}

Example:


"domcno":
{
"0":
{
"pricing":
{
"addtransferdomain":
{
"1":"0.0"
},
"restoredomain":
{
"1":"0.0"
},
"addnewdomain":
{
"1":"0.0"
},
"renewdomain":
{
"1":"0.0"
}
},
"category":
{
"category2":
{
"name":"receipts",
"quantity":"0.0"
},
"category1":
{
"name":"hosting",
"quantity":"0.0"
}
}
}
}

Web Services


"hosting":
{
"productkey":
{
"bandid":
{
"pricing":
{
"action":0.0,
"ssl":0.0
}
"description":
{
"parameter":value
}
}
}
}

Example:


"hosting":
{
"email_plan":
{
"1":
{
"pricing":
{
"renew":0.0,
"add":0.0
},
"description":
{
"no_of_mail_accounts":5,
"default":false
}
}
},
"websitebuilder_plan":
{
"1":
{
"pricing":
{
"renew":0.0,
"add":0.0
},
"description":
{
"no_of_mail_accounts":1,
"default":true,
"webspace":100,
"noofpages":10
}
}
}
}

Single Domain Linux Hosting


"productkey":
{
"bandid":
{
"pricing":
{
"action":0.0,
"ssl":0.0
}
"description":
{
"parameter":value
}
}
}

Example:

US Server


"singledomainhostinglinuxus":
{
"1":
{
"pricing":
{
"renew":0.0,
"ssl":0.0,
"add":0.0
}
"description":
{
"no_of_mail_accounts":-1,
"default":true,
"bandwidth":-1,
"webspace":-1
}
}
}

UK Server


"singledomainhostinglinuxuk":
{
"1":
{
"pricing":
{
"renew":0.0,
"ssl":0.0,
"add":0.0
}
"description":
{
"no_of_mail_accounts":-1,
"default":true,
"bandwidth":-1,
"webspace":-1
}
}
}

India Server


"singledomainhostinglinuxin":
{
"1":
{
"pricing":
{
"renew":0.0,
"ssl":0.0,
"add":0.0
}
"description":
{
"no_of_mail_accounts":-1,
"default":true,
"bandwidth":-1,
"webspace":-1
}
}
}

Hong Kong Server


"singledomainhostinglinuxhk":
{
"1":
{
"pricing":
{
"renew":0.0,
"ssl":0.0,
"add":0.0
}
"description":
{
"no_of_mail_accounts":-1,
"default":true,
"bandwidth":-1,
"webspace":-1
}
}
}

Turkey Server


"singledomainhostinglinuxtr":
{
"1":
{
"pricing":
{
"renew":0.0,
"ssl":0.0,
"add":0.0
}
"description":
{
"no_of_mail_accounts":-1,
"default":true,
"bandwidth":-1,
"webspace":-1
}
}
}

Single Domain Windows Hosting


"productkey":
{
"bandid":
{
"pricing":
{
"action":0.0,
"ssl":0.0
}
"description":
{
"parameter":value
}
}
}

Example:

US Server


"singledomainhostingwindowsus":
{
"1":
{
"pricing":
{
"renew":0.0,
"ssl":0.0,
"add":0.0
}
"description":
{
"no_of_mail_accounts":-1,
"default":true,
"bandwidth":-1,
"webspace":-1
}
}
}

UK Server


"singledomainhostingwindowsuk":
{
"1":
{
"pricing":
{
"renew":0.0,
"ssl":0.0,
"add":0.0
}
"description":
{
"no_of_mail_accounts":-1,
"default":true,
"bandwidth":-1,
"webspace":-1
}
}
}

India Server


"singledomainhostingwindowsin":
{
"1":
{
"pricing":
{
"renew":0.0,
"ssl":0.0,
"add":0.0
}
"description":
{
"no_of_mail_accounts":-1,
"default":true,
"bandwidth":-1,
"webspace":-1
}
}
}

Hong Kong Server


"singledomainhostingwindowshk":
{
"1":
{
"pricing":
{
"renew":0.0,
"ssl":0.0,
"add":0.0
}
"description":
{
"no_of_mail_accounts":-1,
"default":true,
"bandwidth":-1,
"webspace":-1
}
}
}

Turkey Server


"singledomainhostingwindowstr":
{
"1":
{
"pricing":
{
"renew":0.0,
"ssl":0.0,
"add":0.0
}
"description":
{
"no_of_mail_accounts":-1,
"default":true,
"bandwidth":-1,
"webspace":-1
}
}
}

Multi Domain Linux Hosting


"productkey":
{
"planid":
{
"action":
{
"tenure-in-months":price
},
"ssl":price
}
}

Example:

US Server


"multidomainhosting":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

UK Server


"multidomainhostinglinuxuk":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

India Server


"multidomainhostinglinuxin":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

Hong Kong Server


"multidomainhostinglinuxhk":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

Turkey Server


"multidomainhostinglinuxtr":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

Multi Domain Windows Hosting


"productkey":
{
"planid":
{
"action":
{
"tenure-in-months":price
},
"ssl":price
}
}

Example:

US Server


"multidomainwindowshosting":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

UK Server


"multidomainwindowshostinguk":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

India Server


"multidomainwindowshostingin":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

Hong Kong Server


"multidomainwindowshostinghk":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

Turkey Server


"multidomainwindowshostingtr":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

Reseller Linux Hosting


"productkey":
{
"planid":
{
"action":
{
"tenure-in-months":price
},
"ssl":price
}
}

Example:

US Server


"resellerhosting":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

UK Server


"resellerhostinglinuxuk":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

India Server


"resellerhostinglinuxin":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

Turkey Server


"resellerhostinglinuxtr":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

Reseller Windows Hosting


"productkey":
{
"planid":
{
"action":
{
"tenure-in-months":price
},
"ssl":price
}
}

Example:

US Server


"resellerwindowshosting":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

UK Server


"resellerwindowshostinguk":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

India Server


"resellerwindowshostingin":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

Turkey Server


"resellerwindowshostingtr":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

VPS Linux


"productkey":
{
"addons":
{
"addon1-name":price,
"addon2-name":price
},
"plans":
{
"planid":
{
"action":
{
"tenure-in-months":price
},
}
}
}

Example:


"vpslinuxus":
{
"addons":
{
"ssl":0.0,
"cpanel":0.0,
"whmcs":0.0
},
"plans":
{
"1":
{
"renew":
{
"1":0.0
},
"add":
{
"1":00.0
}
},
"2":
{
"renew":
{
"1":0.0
},
"add":
{
"1":0.0
}
}
}
}

Dedicated Linux


"productkey":
{
"addons":
{
"addon1-name":price,
"addon2-name":price
},
"plans":
{
"planid":
{
"action":
{
"tenure-in-months":price
},
}
}
}

Example:


"dedicatedserverlinuxus":
{
"addons":
{
"storage_1":0.0,
"cpanel":0.0,
"whmcs":0.0,
"ipaddress":0.0,
"storage_5":0.0,
"storage_4":0.0,
"storage_3":0.0,
"storage_2":0.0
},
"plans":
{
"105":
{
"renew":
{
"1":0.0
},
"add":
{
"1":0.0
}
},
"106":
{
"renew":
{
"1":0.0
},
"add":
{
"1":0.0
}
}
}
}

Enterprise Email


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

Example:

US Server


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

India Server


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

Digital Certificates


"productkey":
{
"slab-order":
{
"pricing":
{
"certtype":
{
"action":
{
"tenure-in-years":"price"
}
}
}
"category":
{
"slab-category":
{
"name":"category-name",
"quantity":"category-quantity"
}
}
}
}

Example:


"thawtecert":
{
"0":
{
"pricing":
{
"ssl":
{
"renew":
{
"2":"200.0",
"1":"100.0"
},
"add":
{
"2":"200.0",
"1":"100.0"
},
"additionallicense":
{
"2":"100.0",
"1":"100.0"
}
}
"fssl":
{
"renew":
{
"2":"200.0",
"1":"100.0"
},
"add":
{
"2":"200.0",
"1":"100.0"
},
"additionallicense":
{
"2":"100.0",
"1":"100.0"
}
}
"wild":
{
"renew":
{
"2":"200.0",
"1":"100.0"
},
"add":
{
"2":"200.0",
"1":"100.0"
},
"additionallicense":
{
"2":"100.0",
"1":"100.0"
}
}
"sgc":
{
"renew":
{
"2":"200.0",
"1":"100.0"
},
"add":
{
"2":"200.0",
"1":"100.0"
},
"additionallicense":
{
"2":"100.0",
"1":"100.0"
}
}
}
"category":
{
"category2":
{
"name":"receipts",
"quantity":"0.0"
},
"category1":
{
"name":"hosting",
"quantity":"0.0"
}
}
}
}

Getting the Customer Pricing

Description

Gets the generic Customer Pricing or a particular Customer's Cost Price if the Customer ID is provided.

Note

It is recommended you cache all pricing information to ensure you do not have to send API queries to the platform. As there are a huge number of products, the accompanying data may cause longer wait time than usual.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
customer-id Integer Optional Customer ID of the Customer whose Cost Price has to be retrieved. By default, generic Customer Pricing will be retrieved.

HTTP Method

GET

Example Test URL Request

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

Response

Returns a hash map with the generic Customer Pricing or the specified Customer's Cost Price. The response structure will be:

Domain Names (TLDs)


"productkey":
{
"action-name":
{
"tenure-in-years":"price"
}
}

Example:


"dotnet":
{
"addtransferdomain":
{
"1":"0.0"
},
"restoredomain":
{
"1":"0.0"
},
"addnewdomain":
{
"1":"0.0"
},
"renewdomain":
{
"1":"0.0"
}
}

Web Services


"hosting":
{
"planid":
{
"action":
{
"tenure-in-months":price
},
"ssl":0.0
}
}

Example:


"hosting":
{
"0":
{
"renew":
{
"12":0.0,
"24":0.0
},
"ssl":0.0,
"add":
{
"12":0.0,
"24":0.0
}
},
"1":
{
"renew":
{
"12":0.0,
"24":0.0
},
"add":
{
"12":0.0,
"24":0.0
}
}
}

Single Domain Linux Hosting


"productkey":
{
"planid":
{
"action":
{
"tenure-in-months":price
},
"ssl":price
}
}

Example:

US Server


"singledomainhostinglinuxus":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

UK Server


"singledomainhostinglinuxuk":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

India Server


"singledomainhostinglinuxin":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

Hong Kong Server


"singledomainhostinglinuxhk":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

Turkey Server


"singledomainhostinglinuxtr":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

Single Domain Windows Hosting


"productkey":
{
"planid":
{
"action":
{
"tenure-in-months":price
},
"ssl":price
}
}

Example:

US Server


"singledomainhostingwindowsus":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

UK Server


"singledomainhostingwindowsuk":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

India Server


"singledomainhostingwindowsin":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

Hong Kong Server


"singledomainhostingwindowshk":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

Turkey Server


"singledomainhostingwindowstr":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

Multi Domain Linux Hosting


"productkey":
{
"planid":
{
"action":
{
"tenure-in-months":price
},
"ssl":price
}
}

Example:

US Server


"multidomainhosting":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

UK Server


"multidomainhostinglinuxuk":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

India Server


"multidomainhostinglinuxin":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

Hong Kong Server


"multidomainhostinglinuxhk":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

Turkey Server


"multidomainhostinglinuxtr":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

Multi Domain Windows Hosting


"productkey":
{
"planid":
{
"action":
{
"tenure-in-months":price
},
"ssl":price
}
}

Example:

US Server


"multidomainwindowshosting":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

UK Server


"multidomainwindowshostinguk":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

India Server


"multidomainwindowshostingin":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

Hong Kong Server


"multidomainwindowshostinghk":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

Turkey Server


"multidomainwindowshostingtr":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

Reseller Linux Hosting


"productkey":
{
"planid":
{
"action":
{
"tenure-in-months":price
},
"ssl":price
}
}

Example:

US Server


"resellerhosting":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

UK Server


"resellerhostinglinuxuk":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

India Server


"resellerhostinglinuxin":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

Turkey Server


"resellerhostinglinuxtr":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

Reseller Windows Hosting


"productkey":
{
"planid":
{
"action":
{
"tenure-in-months":price
},
"ssl":price
}
}

Example:

US Server


"resellerwindowshosting":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

UK Server


"resellerwindowshostinguk":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

India Server


"resellerwindowshostingin":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

Turkey Server


"resellerwindowshostingtr":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

VPS Linux


"productkey":
{
"addons":
{
"addon1-name":price,
"addon2-name":price
},
"plans":
{
"planid":
{
"action":
{
"tenure-in-months":price
},
}
}
}

Example:


"vpslinuxus":
{
"addons":
{
"ssl":0.0,
"cpanel":0.0,
"whmcs":0.0
},
"plans":
{
"1":
{
"renew":
{
"1":0.0
},
"add":
{
"1":0.0
}
},
"2":
{
"renew":
{
"1":0.0
},
"add":
{
"1":0.0
}
}
}
}

Dedicated Server Linux


"productkey":
{
"addons":
{
"addon1-name":price,
"addon2-name":price
},
"plans":
{
"planid":
{
"action":
{
"tenure-in-months":price
},
}
}
}

Example:


"dedicatedserverlinuxus":
{
"addons":
{
"storage_1":0.0,
"cpanel":0.0,
"whmcs":0.0,
"ipaddress":0.0,
"storage_5":0.0,
"storage_4":0.0,
"storage_3":0.0,
"storage_2":0.0
},
"plans":
{
"105":
{
"renew":
{
"1":0.0
},
"add":
{
"1":0.0
}
},
"106":
{
"renew":
{
"1":0.0
},
"add":
{
"1":0.0
}
}
}
}

Enterprise Email


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

Example:

US Server


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

India Server


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

Digital Certificates


"productkey":
{
"slab-order":
{
"pricing":
{
"certtype":
{
"action":
{
"tenure-in-years":"price"
}
}
}
"category":
{
"slab-category":
{
"name":"category-name",
"quantity":"category-quantity"
}
}
}
}

Example:


"thawtecert":
{
"0":
{
"pricing":
{
"ssl":
{
"renew":
{
"2":"200.0",
"1":"100.0"
},
"add":
{
"2":"200.0",
"1":"100.0"
},
"additionallicense":
{
"2":"100.0",
"1":"100.0"
}
}
"fssl":
{
"renew":
{
"2":"200.0",
"1":"100.0"
},
"add":
{
"2":"200.0",
"1":"100.0"
},
"additionallicense":
{
"2":"100.0",
"1":"100.0"
}
}
"wild":
{
"renew":
{
"2":"200.0",
"1":"100.0"
},
"add":
{
"2":"200.0",
"1":"100.0"
},
"additionallicense":
{
"2":"100.0",
"1":"100.0"
}
}
"sgc":
{
"renew":
{
"2":"200.0",
"1":"100.0"
},
"add":
{
"2":"200.0",
"1":"100.0"
},
"additionallicense":
{
"2":"100.0",
"1":"100.0"
}
}
}
"category":
{
"category2":
{
"name":"receipts",
"quantity":"0.0"
},
"category1":
{
"name":"hosting",
"quantity":"0.0"
}
}
}
}

Listing All Orders under your Reseller Account

Follow the below mentioned instructions to view all Orders within your Reseller account with :

  1. Login to your Control Panel. See details

  2. In the Menu, point to Products and then click List All Orders.

  3. This would list all Orders under your Reseller account. You may further tweak these results by submitting one or more of the following parameters:

    • Belonging to: You may choose to view Orders associated with a domain name or belonging to a Customer or a Sub-Reseller. Choose the appropriate option from the drop-down menu and mention either the domain name / Order ID or the Customer Username / ID or the Sub-Reseller Username / ID.

    • For Product: Select the desired Product from the drop-down menu.

      Note

      In order to search for Single Domain Linux Hosting and/or Single Domain Windows Hosting Orders, select the option as Single Domain Hosting.

      In order to search for Multi Domain Linux Hosting and/or Multi Domain Windows Hosting Orders, select the option as Multi Domain Hosting.

      Similarly, in order to search for Reseller Linux Hosting and/or Reseller Windows Hosting Orders, select the option as Reseller Hosting.

    • With Status: Select the status as Any, Active, InActive or Suspended.

    • Expiry: You may choose to list Orders based on their Expiry status. Select Any, Expired or Expiring in certain number of days.

    • Purchased between: You may choose to list Orders based on their purchase date. Select the Start Date and End Date to search within this date range.

    • Include Sub-Reseller's results: You may include in the list all Orders belonging to your Sub-Resellers, by selecting this check box.

Note

You may quickly list Orders belonging to your Customers, by selecting any of the below mentioned Auto Filters:

  • List all Orders: This will list all Orders.

  • Orders Expiring in next 30 days: This will list all Orders expiring in the next 30 days.

  • Expired Orders: This will list all expired Orders.

  • All Pending Orders: This will list all pending Orders.

The list of Orders that is displayed mentions domain names under the following sortable column heads:

  • Domain Name: This is the domain name of the Order. Clicking the domain name link of any Order will lead you to the Overview section. Clicking the Product specific tab in the Overview section will lead you to the Order Details view, from where you may manage this Order.

  • Product: This represents the Product category this Order belongs to. A single domain name may belong to multiple Product categories depending upon how many Products are purchased for the same.

    For example, yourdomain.com may be visible under both Domain Registration as well as another Product if that Product has been purchased for yourdomain.com.

  • Expiry: This indicates the Expiry Date of the Order. For Orders that have expired, the Expiry Date would be displayed in red.

  • Deletion: This indicates the Deletion Date of the Order. For Orders that have expired, the Deletion Date would be displayed in red.

  • Cust. ID: This is the Customer ID of the Customer managing that particular Order. If the Customer is your immediate Customer, then you may click the Customer ID to view and manage your Customer
    details.

  • Resell. ID: If the Order belongs to your Customer, then this would display You; else it would display that Sub-Reseller's ID whose Customer the Order belongs to. Besides the
    Sub-Reseller ID, you would be displayed an icon indicating that this Order belongs to your Sub-Reseller or his/her Sub-Reseller chain. You may view the entire Sub-Reseller chain the Order is associated with, by placing your mouse pointer over this icon.

Clicking the domain name link corresponding to any Order will open up its Overview. Then click the Product specific tab to reach the Order Information view, from where you can perform any modifications to the Order.

Listing All Orders under your Customer Account

Follow the below mentioned instructions to view all Orders within your Customer account with :

  1. Login to your Control Panel. See details

  2. In the Menu, point to Manage Orders and then click List/Search Orders.

  3. This would list all Orders under your Customer account. You may further tweak these results by submitting one or more of the following parameters:

    • Name / Order ID: You may choose to view Orders associated with a domain name. Mention the domain name / Order ID here.

    • For Product: Select the desired Product from the drop-down menu.

      Note

      In order to search for Single Domain Linux Hosting and/or Single Domain Windows Hosting Orders, select the option as Single Domain Hosting.

      In order to search for Multi Domain Linux Hosting and/or Multi Domain Windows Hosting Orders, select the option as Multi Domain Hosting.

      Similarly, in order to search for Reseller Linux Hosting and/or Reseller Windows Hosting Orders, select the option as Reseller Hosting.

    • With Status: Select the status as Any, Active, InActive or Suspended.

    • Expiry: You may choose to list Orders based on their Expiry status. Select Any, Expired or Expiring in certain number of days.

    • Purchased between: You may choose to list Orders based on their purchase date. Select the Start Date and End Date to search within this date range.

Note

You may quickly list Orders by selecting any of the below mentioned Auto Filters:

  • List all Orders: This will list all Orders.

  • Orders Expiring in next 30 days: This will list all Orders expiring in the next 30 days.

  • Expired Orders: This will list all expired Orders.

  • All Pending Orders: This will list all pending Orders.

The list of Orders that is displayed mentions domain names under the following sortable column heads:

  • Domain Name: This is the domain name of the Order. Clicking the domain name link of any Order will lead you to the Order Details view, from where you may manage this Order.

  • Product: This represents the Product category this Order belongs to. A single domain name may belong to multiple Product categories depending upon how many Products are purchased for the same.

    For example, yourdomain.com may be visible under both Domain Registration as well as another Product if that Product has been purchased for yourdomain.com.

  • Expiry: This indicates the Expiry Date of the Order. For Orders that have expired, the Expiry Date would be displayed in red.

Clicking the domain name link corresponding to any Order will open up its Overview. Then click the Product specific tab to reach the Order Information view, from where you can perform any modifications to the Order.

Changing your Personal Identification Number (PIN)

When you sign up for a Customer Account with ,
an email containing the Account details will be sent to you. The Account details
include a numeric code known as Personal Identification Number (PIN).
The PIN will also be listed in the Customer
Profile Details view, which can be accessed by clicking the icon at the top right corner of the page and then
clicking Your Account & Security within your Customer Control Panel.
may request you to authenticate yourself through this PIN, when you request
support.

You can easily modify your Personal
Identification Number (PIN) by following the below
process:

  1. Login to your Control Panel. See details

  2. Click on the icon at the top right corner of the page and then click on Your Account & Security.

  3. On the Account & Security page, under the Security section, click on View / Change your PIN.

  4. In the modal window click on the Change link and enter a new PIN.

      Note

      You need to consider the following, in relation with your Personal Identification Number (PIN):

      • The PIN should consist of 4 numeric characters.

      • Change the PIN on a regular basis.

      • Avoid using a PIN that contains personal information (social security number, birth date, etc.).

      • Avoid using repeating (1111) or sequential (1234) numbers.

      • Do not disclose your PIN to any unauthorized person.

  5. Click on the Change PIN button to submit your change.

Home

Welcome to the Techzone India Support Knowledge Base. Here, we have listed detailed information regarding all our current Product and Service offerings and answers to possibly all your queries. The Techzone India Support KB has been divided into categories indicating a particular Interface or a particular Product/Service. These have been further logically divided into sub-categories and answers, detailing a particular action or query.

Note

In the event, you are unable to locate a particular answer, please make use of the Search box provided on the top-left of the page or inform our Support Team at http://billing.techzoneindia.com

Modifying the Privacy Protection Status

Description

Changes the Privacy Protection status of the specified Domain Registration 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 Domain Registration Order whose privacy protection you want to change.
protect-privacy Boolean Required Enable / Disable Privacy Protection service. Possible values are: true or false.
reason String Required The reason to enable / disable Privacy Protection.

HTTP Method

POST

Example Test URL Request

https://test.httpapi.com/api/domains/modify-privacy-protection.json?auth-userid=0&api-key=key&order-id=0&protect-privacy=true&reason=somereason

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 Privacy Protection Modification Action (actiontypedesc)

  • Action ID of the Privacy Protection Modification Action (eaqid)

  • Privacy Protection Modification Action Status (actionstatus)

  • Description of the Privacy Protection Modification Action Status (actionstatusdesc)

  • Invoice ID of the Privacy Protection Purchase Invoice (invoiceid)

  • Selling Currency of the Reseller (sellingcurrencysymbol)

  • Transaction Amount in the Selling Currency (sellingamount)

  • Unutilized Transaction Amount in the Selling Currency (unutilisedsellingamount)

Note

invoiceid, sellingcurrencysymbol, sellingamount, unutilisedsellingamount and customerid will be returned even if the Selling Price for Privacy Protection is set to zero, since a zero priced Invoice will be raised while enabling Privacy protection.

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

Check Availability

Description

Checks the availability of the specified domain name(s).

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
domain-name Array of Strings Required Domain name(s) that you need to check the availability for
tlds Array of Strings Required TLDs for which the domain name availability needs to be checked See details

HTTP Method

GET

Example Test URL Request


https://domaincheck.httpapi.com/api/domains/available.json?auth-userid=0&api-key=key&domain-name=domain1&domain-name=domain2&tlds=com&tlds=net

Response

Returns a hash map containing domain name availability status for the requested TLDs:

  • Domain Availability Status (status)

    • available - domain name available for registration

    • regthroughus - domain name currently registered through the Registrar whose connection is being used to check the availability of the domain name

    • regthroughothers - domain name currently registered through a Registrar other than the one whose connection is being used to check the availability of the domain name. If you wish to manage such a domain name through your Reseller / Registrar Account, you may pass a Domain Transfer API call. See details

    • unknown - returned, if for some reason, the Registry connections are not available. You should ideally re-check the domain name availability after some time.

      Note
      • In case of Donuts TLDs, domain name availability can be checked for a maximum of 5 domain names per Donuts TLD group in one API call. Including more than 5 domain names belonging to the same Donuts TLD group in an API call will return the status as unknown for all the domain names.

        Additional Information

        Donuts TLDs

      • In case of .CA TLD, domain name availability can be checked for a maximum of 15 strings in one API call. Including more than 15 strings in an API call will return the status as unknown for all the strings.

  • Trademark Claims Key (tm-claims-key) - will be returned only if the domain name is available and Trademark for that domain name is listed in the Trademark Clearinghouse database

  • Premium Names (costHash) - A hash map will be returned only if the
    domain is a premium name along with the pricing of the domain ("create",
    "renew", "transfer") and the selling currency symbol

  • Early Access Program (costHash) - A hash map will be returned only
    if the domain is in EAP along with the early access fee
    ("early_access_fee") and the selling currency symbol. The early access fee
    is the non-refundable component which needs to added to the selling price
    of the domain

  • Additional Information

    Trademark Claim Process

  • 3rd Level .UK domain name (ror) - will be returned for an available 2nd Level .UK domain name, if the corresponding 3rd Level .UK domain name already exists. Currently, a 2nd Level .UK domain name can only be registered by the person/entity that owns the 3rd Level .UK domain name, if it already exists.

    Note

    For .UK availability check, the API call need to have only one domain name. Otherwise, the ror parameter will not be returned in the result.

Register

Note

It is recommended, that you read TLD and their Contacts specific information, prior to continuing reading further:

Description

Registers a 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

Domain name that you need to Register.

For an Internationalized Domain Name, refer to the supported character sets mentioned below:

Note

The domain name used in the API call can be in Unicode (the native language) or in Punycode format.

Example: The domain name can be provided as ѯҋ111 (Unicode) or xn--111-dkd4l (Punycode).

domain-name=ѯҋ111
domain-name=xn--111-dkd4l

years Integer Required Number of years for which you wish to Register this domain name.
ns Array of Strings Required The Name Servers of the domain name.
customer-id Integer Required The Customer for whom you wish to Register this domain name.
reg-contact-id Integer Required The Registrant Contact of the domain name.
admin-contact-id Integer Required

The Administrative Contact of the domain name.

Note

Pass -1 for the following TLDs:

  • .EU

  • .NZ

  • .RU

  • .UK

tech-contact-id Integer Required

The Technical Contact of the domain name.

Note

Pass -1 for the following TLDs:

  • .EU

  • .NZ

  • .RU

  • .UK

billing-contact-id Integer Required

The Billing Contact of the domain name.

Note

Pass -1 for the following TLDs:

  • .AT

  • .BERLIN

  • .CA

  • .EU

  • .NL

  • .NZ

  • .RU

  • .UK

  • .LONDON

invoice-option String Required This will decide how the Customer Invoice will be handled. Set any of below mentioned Invoice Options for your Customer:
  • NoInvoice: This will not raise any Invoice. The Order will be executed.

  • PayInvoice: This will raise an Invoice and:

    • if there are sufficient funds in the Customer's Debit Account, then the Invoice will be paid and the Order will be executed.

    • if there are insufficient funds in the Customer's Debit Account, then the Order will remain pending in the system.

  • KeepInvoice: This will raise an Invoice for the Customer to pay later. The Order will be executed.

  • OnlyAdd: This will raise an Invoice for the Customer to pay later. The registration action request will remain pending.

purchase-privacy Boolean optional

Adds the Privacy Protection service for the domain name.

Privacy Protection is not supported for the following TLDs (extensions):

  • .ASIA

  • .AT

  • .AU

  • .CA

  • .CN

  • .ORG.CO, .MIL.CO, .GOV.CO, .EDU.CO

  • .DE

  • .ES

  • .EU

  • .HN

  • .IN

  • .NL

  • .NZ

  • .PRO

  • .RU

  • .SX

  • .TEL

  • .UK

  • .US

protect-privacy Boolean Optional

Enables / Disables the Privacy Protection setting for the domain name.

auto-renew Boolean Required

Enables / Disables the Auto Renewal setting for the domain name.

attr-name Map[name] Optional Mapping key of the extra details needed to register a domain name. Refer the description of attr-value.
attr-value Map[value] Optional

Mapping value of the extra details required to register a domain name. This together with attr-name shall contain the extra details.

  • To register an Internationalized Domain Name:

    idnLanguageCode: While registering an IDN, you need to provide the corresponding language code:

    • .BHARAT: The language code needs to be mentioned as hin-deva.

      attr-name1=idnLanguageCode&attr-value1=hin-deva

    • .BIZ IDN: The language code depends upon the language whose characters are used in the domain name. Supported languages and the corresponding language codes are:

      • Chinese - zh

      • Danish - da

      • Finnish - fi

      • German - de

      • Hungarian - hu

      • Icelandic - is

      • Japanese - jp

      • Korean - ko

      • Lithuanian - lt

      • Latvian - lv

      • Norwegian - no

      • Polish - pl

      • Portuguese - pt

      • Spanish - es

      • Swedish - sv

      attr-name1=idnLanguageCode&attr-value1=ko

    • .CA IDN: The language code needs to be mentioned as fr.

      attr-name1=idnLanguageCode&attr-value1=fr

    • .CC / .TV IDN: The language code depends upon the language whose characters are used in the domain name. You can refer to the list of languages supported and the corresponding language code.

      attr-name1=idnLanguageCode&attr-value1=aze

    • .CO IDN: The language code depends upon the language whose characters are used in the domain name. Supported languages and the corresponding language codes are:

      • Chinese - zh

      • Danish - da

      • Finnish - fi

      • Icelandic - is

      • Japanese - jp

      • Korean - ko

      • Norwegian - no

      • Spanish - es

      • Swedish - sv

      attr-name1=idnLanguageCode&attr-value1=da

    • .COM / .NET IDN: The language code depends upon the language whose characters are used in the domain name. You can refer to the list of languages supported and the corresponding language code.

      attr-name1=idnLanguageCode&attr-value1=aze

    • .DE IDN: The language code needs to be mentioned as de.

      attr-name1=idnLanguageCode&attr-value1=de

    • .ES IDN: The language code needs to be mentioned as es.

      attr-name1=idnLanguageCode&attr-value1=es

    • .EU IDN: The language code needs to be mentioned as latin.

      attr-name1=idnLanguageCode&attr-value1=latin

    • .IN.NET IDN: The language code depends upon the language whose characters are used in the domain name. Supported languages and the corresponding language codes are:

      • Arabic - ara

      • Chinese - chi

      • Cyrillic - cyr

      • Greek - gre

      • Hebrew - heb

      • Japanese - jpn

      • Korean - kor

      • Lao - lao

      • Latin - lat

      • Thai - tha

      attr-name1=idnLanguageCode&attr-value1=jpn

    • .INFO IDN: The language code depends upon the language whose characters are used in the domain name. Supported languages and the corresponding language codes are:

      • Danish - da

      • German - de

      • Hungarian - hu

      • Icelandic - is

      • Korean - ko

      • Latvian - lv

      • Lithuanian - lt

      • Polish - pl

      • Spanish - es

      • Swedish - sv

      attr-name1=idnLanguageCode&attr-value1=ko

    • .NAME IDN: The language code depends upon the language whose characters are used in the domain name. You can refer to the list of languages supported and the corresponding language code.

      attr-name1=idnLanguageCode&attr-value1=aze

    • .ORG IDN: The language code depends upon the language whose characters are used in the domain name. Supported languages and the corresponding language codes are:

      • Chinese - zh-cn (for IDN.org domain name and .机构 domain name - the Chinese IDN for .org)

      • Cyrillic - ru (for .орг domain name - the Russian IDN for .org)

      • Danish - da

      • German - de

      • Hindi - hin-deva (for .संगठन domain name - the Hindi IDN for .org)

      • Hungarian - hu

      • Icelandic - is

      • Korean - ko

      • Latvian - lv

      • Lithuanian - lt

      • Polish - pl

      • Spanish - es

      • Swedish - sv

      attr-name1=idnLanguageCode&attr-value1=ko

    • .PW IDN: The language code depends upon the language whose characters are used in the domain name. Supported languages and the corresponding language codes are:

      • Arabic - ara

      • Chinese - chi

      • Cyrillic - cyr

      • Greek - gre

      • Hebrew - heb

      • Japanese - jpn

      • Korean - kor

      • Lao - lao

      • Latin - lat

      • Thai - tha

      attr-name1=idnLanguageCode&attr-value1=tha

    • .TEL IDN: The language code depends upon the language whose characters are used in the domain name. Supported languages and the corresponding language codes are:

      • Chinese - zh

      • Danish - da

      • French - fr

      • Finnish - fi

      • German - de

      • Hungarian - hu

      • Icelandic - is

      • Japanese - jp

      • Korean - ko

      • Latvian - lv

      • Lithuanian - lt

      • Norwegian - no

      • Polish - pl

      • Portuguese - pt

      • Russian - ru

      • Spanish - es

      • Swedish - sv

      attr-name1=idnLanguageCode&attr-value1=ko

    • CentralNic IDN: The language code depends upon the language whose characters are used in the domain name. Supported languages and the corresponding language codes are:

      • .EU.COM:

        • Arabic - ara

        • Cyrillic - cyr

        • Greek - gre

        • Hebrew - heb

        • Latin - lat

      • .GB.COM, .QC.COM, .DE.COM, .GB.NET, .NO.COM, .HU.COM, .UY.COM, .ZA.COM, .BR.COM, .SE.COM, .SE.NET, .UK.COM and .UK.NET:

        • Latin - lat

      • .AE.ORG and .SA.COM:

        • Arabic - ara

      • .KR.COM:

        • Korean - kor

      • .US.COM:

        • Arabic - ara

        • Chinese - chi

        • Cyrillic - cyr

        • Greek - gre

        • Hebrew - heb

        • Japanese - jpn

        • Latin - lat

      • .GR.COM:

        • Greek - gre

      • .JPN.COM:

        • Japanese - jpn

      • .CN.COM:

        • Chinese - chi

      • .RU.COM:

        • Cyrillic - cyr

      attr-name1=idnLanguageCode&attr-value1=lat

    • .在线 (Chinese IDN for .online): The language code needs to be mentioned as zh.

      attr-name1=idnLanguageCode&attr-value1=zh

    • .中文网 (Chinese IDN for .network): The language code needs to be mentioned as zh.

      attr-name1=idnLanguageCode&attr-value1=zh

  • To register a Domain Name in the Sunrise Phase:

    • phase: Mention the phase as sunrise.

      attr-name1=phase&attr-value1=sunrise

    • smd: Pass the content of the smd file as the value for this attr-name.

      attr-name2=smd&attr-value2=<smd_file_content>

  • To register a Domain Name in the Pre-Registration Phase:

    phase: Mention the phase as

    • prega for regular pre-registration

      attr-name1=phase&attr-value1=prega

    • landrush for priority pre-registration

      attr-name1=phase&attr-value1=landrush

  • To register a domain name that has a Trademark Claim:

    tm-claim: Mention the value for this additional parameter as accepted.

    attr-name1=tm-claim&attr-value1=accepted

  • To register a .ASIA domain name:

    cedcontactid: While registering a .ASIA domain name, 'Charter Eligibility Declaration Contact ID' is mandatory. This parameter represents the CED
    Contact ID. You may select any one of the Admin, Technical, Billing or Registrant Contacts as a value for this parameter.

    attr-name1=cedcontactid&attr-value1=0

  • To register a .AU domain name:

    • id-type: Mention the appropriate EligibilityID Type as the value for this attr-name. This is
      mandatory. See details

      Send either of the following as the attr-value:

      • ACN: This is the Registrant's Australian Company Number.

      • ABN: This is the Registrant's Australian Business Number.

      • VIC BN: This is the Registrant's Victoria Business Number.

      • NSW BN: This is the Registrant's New South Wales Business Number.

      • SA BN: This is the Registrant's South Australia Business Number.

      • NT BN: This is the Registrant's Northern Territory Business Number.

      • WA BN: This is the Registrant's Western Australia Business Number.

      • TAS BN: This is the Registrant's Tasmania Business Number.

      • ACT BN: This is the Registrant's Australian Capital Territory Business Number.

      • QLD BN: This is the Registrant's Queensland Business Number.

      • TM: This is the Registrant's Trademark number.

      • ARBN: This is the Registrant's Registrant's Australian Registered Body Number (ARBN).

      • Other

      attr-name1=id-type&attr-value1=ACN

    • id: Mention the appropriate ID as the value for this attr-name, depending upon the EligibilityID Type selected. This is
      mandatory. This may be
      either a number or string. See details

      attr-name2=id&attr-value2=079 009 340

    • policyReason: Mention the appropriate Eligibility Reason as the value for this attr-name. This is mandatory.
      See details

      attr-name3=policyReason&attr-value3=1

      Note

      Mention the attr-value3 as 1 to indicate Domain Name is an Exact Match OR Abbreviation OR Acronym of your Entity or Trading Name. and send
      2 to indicate Close and substantial connection between the domain name and the operations of your Entity.

    • isAUWarranty: You need to display and accept a warranty from the Registrant. When sending this attribute, it's value needs to be
      true. See details

      attr-name4=isAUWarranty&attr-value4=true

    • eligibilityType: This is mandatory for only the id-type values Trademark and Other. Mention the appropriate value as below.

      id-type eligibilityType
      Trademark Trademark Owner
      or
      Pending TM Owner
      Other Other

      attr-name5=eligibilityType&attr-value5=Trademark

    • eligibilityName: This is mandatory for only the id-type value Trademark. Mention the appropriate Eligibility Name (company name) as the value for this attr-name.
      See details

      attr-name6=eligibilityName&attr-value6=.AU DOMAIN ADMINISTRATION LIMITED

    • registrantName: This is mandatory for only the id-type values VIC BN, NSW BN, SA BN, NT BN, WA BN, TAS BN, ACT BN, QLD BN, Trademark and Other. Mention the appropriate Registrant Name as the value for this attr-name. This value needs to be the proprietor's name and the proprietor should be an individual.
      See details

      attr-name7=registrantName&attr-value7=RICHARD MARK


  • To register a .BR (third level) domain name:

    organisationId: Only Brazilian nationals or organizations can register .BR domains. Hence, a tax ID (CPF in case of an individual contact) or an organisation ID (CNPJ in case of a company contact) of the person/organisation needs to be supplied. The tax/organization ID must either not be currently registered in our database or it should be a transferred authority to the registrar through the .BR registry web interface.

    In addition, depending on the contact, you will need to specify the “type” as BrOrgContact (for the Registrant contact) or BrContact (for the Admin/Technical/Billing contact).

    A BrgOrgContact will need the following additional attributes:

    attr-name1=organisationId&attr-value1=123456

  • To register a .CN domain name:

    If the Registrant plans on hosting the domain name in China, he/she needs to ensure that he/she has a valid MIIT ICP Number and include the below parameters:

    • cnhosting: This parameter indicates that the domain name will be hosted in China. The value needs to be passed as true.

      attr-name1=cnhosting&attr-value1=true

    • cnhostingclause: Through this parameter, the Registrant agrees to the terms and conditions for hosting the domain name in China. The value needs to be passed as yes.

      attr-name2=cnhostingclause&attr-value2=yes

  • To register a .QUEBEC domain name:

    intended-use: This parameter indicates the intended use of the .QUEBEC domain name. For example, commercial use, statistic website, cultural, etc.

    attr-name1=intended-use&attr-value1=commercial use

  • To register a .TEL domain name:

    • whois-type: This parameter indicates whether the Registrant is an Individual or an Oragnization. The value needs to be passed as either Natural (for Individual) or Legal (for Oragnization).

      attr-name1=whois-type&attr-value1=Legal

    • publish: This parameter indicates whether the Contact Details associated with a .TEL domain name need to be published or excluded from the publicly available Whois database. The value needs to be passed as either Y or N.

      This parameter is required if whois-type parameter is Natural, otherwise is it Optional.

      attr-name2=publish&attr-value2=Y

    Note

    You may exclude the whois-type parameter itself from the API call, since it is optional. In that case,:

    • whois-type will be automatically set to Legal,

      AND

    • you need not pass the publish parameter.

  • To register a 2nd Level .UK domain name with a non UK Registrant Contact, specify an additional Service Contact: See details:

    service-contact: Mention the Contact ID of the Service Contact.

    attr-name1=service-contact&attr-value1=0

  • To register a .LAWYER, .ATTORNEY, .LTDA, .SRL domain name:

    REGULATORY BODY: The Regulatory Body information is collected during the registration process. This information is only required if the registrant is offering professional services related to the TLD

    attr-name1=regulatorybody&attr-value1=<regulatory-body-here>

  • To register a .AIRFORCE, .ARMY, .DEGREE, .ENGINEER, .GIVES, .MARKET, .MORTGAGE, .NAVY, .REHAB, .SOFTWARE, .VET, .VOTE, .VOTO domain name:

    TNC: stands for Terms and Conditions

    Any other value for attr-value1 except y or Y will result in an error "Please accept the Terms & Conditions".

    attr-name1=tnc&attr-value1=y

  • To register a .DENTIST domain name:

    TNC: stands for Terms and Conditions

    Any other value for attr-value1 except y or Y will result in an error "Please accept the Terms & Conditions".

    REGULATORY BODY: The Regulatory Body information is collected during the registration process. This information is only required if the registrant is offering professional services related to the TLD

    attr-name1=tnc&attr-value1=y&attr-name2=regulatorybody&attr-value2=<regulatory-body>

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/domains/register.xml?auth-userid=0&api-key=key&domain-name=domain.com&years=1&ns=ns1.domain.com&ns=ns2.domain.com&customer-id=0&reg-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0&invoice-option=KeepInvoice

Example Test URL Request for Registering a Domain Name with Privacy Protection


https://test.httpapi.com/api/domains/register.xml?auth-userid=0&api-key=key&domain-name=domain.com&years=1&ns=ns1.domain.com&ns=ns2.domain.com&customer-id=0&reg-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0&invoice-option=KeepInvoice&purchase-privacy=true

Example Test URL Request for Registering a Domain Name in the Sunrise Phase


https://test.httpapi.com/api/domains/register.xml?auth-userid=0&api-key=key&domain-name=domains1.bike&years=1&ns=ns1.domain.com&ns=ns2.domain.com&customerid=0&reg-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0&invoice-option=KeepInvoice&attr-name1=phase&attr-value1=sunrise&attr-name2=smd&attr-value2=<smd_file_content>

Example Test URL Request for Registering a .AU Domain Name


https://test.httpapi.com/api/domains/register.xml?auth-userid=0&api-key=key&domain-name=domain.net.au&years=2&ns=ns1.domain.com&ns=ns2.domain.com&customer-id=0&reg-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0&invoice-option=KeepInvoice&attr-name1=id-type&attr-value1=ACN&attr-name2=id&attr-value2=079 009 340&attr-name3=policyReason&attr-value3=1&attr-name4=isAUWarranty&attr-value4=true

Example Test URL Request for Registering a .CN Domain Name


https://test.httpapi.com/api/domains/register.xml?auth-userid=0&api-key=key&domain-name=domain.cn&years=1&ns=ns1.domain.com&ns=ns2.domain.com&customer-id=0&reg-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0&invoice-option=KeepInvoice&attr-name1=cnhosting&attr-value1=true&attr-name2=cnhostingclause&attr-value2=yes

Example Test URL Request for Registering a .COM IDN


https://test.httpapi.com/api/domains/register.xml?auth-userid=0&api-key=key&domain-name=ѯҋ112.com&years=1&ns=ns1.domain.com&ns=ns2.domain.com&customer-id=0&reg-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0&invoice-option=KeepInvoice&attr-name1=idnLanguageCode&attr-value1=aze

Example Test URL Request for Registering a .TEL Domain Name


https://test.httpapi.com/api/domains/register.xml?auth-userid=0&api-key=key&domain-name=domain.tel&years=1&ns=ns1.domain.com&ns=ns2.domain.com&customer-id=0&reg-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0&invoice-option=KeepInvoice&attr-name1=whois-type&attr-value1=Natural&attr-name2=publish&attr-value2=N

Example Test URL Request for Registry Premium domain registration


https://test.httpapi.com/api/domains/register.xml?auth-userid=0&api-key=key&domain-name=domain.com&years=1&ns=ns1.domain.com&ns=ns2.domain.com&customer-id=0&reg-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0&invoice-option=KeepInvoice
&attr-name1=premium&attr-value1=true

Example Test URL Request for domain registration in EAP


https://test.httpapi.com/api/domains/register.xml?auth-userid=0&api-key=key&domain-name=domain.com&years=1&ns=ns1.domain.com&ns=ns2.domain.com&customer-id=0&reg-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0&invoice-option=KeepInvoice&attr-name1=eap&attr-value1=true

Example Test URL Request for Registry Premium domain registration in EAP


https://test.httpapi.com/api/domains/register.xml?auth-userid=0&api-key=key&domain-name=domain.com&years=1&ns=ns1.domain.com&ns=ns2.domain.com&customer-id=0&reg-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0&invoice-option=KeepInvoice&attr-name1=premium&attr-value1=true&attr-name2=eap&attr-value2=true

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)

  • Transaction Amount in the Selling Currency (sellingamount)

  • Unutilized Transaction Amount in the Selling Currency (unutilisedsellingamount)

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

  • Privacy Protection Details (privacydetails)

    • Domain Name (description)

    • Order ID of the Domain Registration Order (entityid)

    • Action Type (actiontype)

    • Description of the Privacy Protection Purchase Action (actiontypedesc)

    • Action ID of the Privacy Protection Purchase Action (eaqid)

    • Privacy Protection Purchase Action Status (actionstatus)

    • Description of the Privacy Protection Purchase Action Status (actionstatusdesc)

    • Invoice ID of the Privacy Protection Purchase Invoice (invoiceid)

    • Selling Currency of the Reseller (sellingcurrencysymbol)

    • Transaction Amount in the Selling Currency (sellingamount)

    • Unutilized Transaction Amount in the Selling Currency (unutilisedsellingamount)

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

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

  • Details under privacydetails will be returned only if purchase-privacy is set to true in the Domain Registration API call

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

Domains

Note

It is recommended, that you read TLD and their Contacts specific information, prior to continuing reading further:

Check Availability

Checks the availability of specified domain name(s).

Check Availability - IDN

Checks the availability of the specified Internationalized Domain Name(s) (IDN).

Check Availability - Premium Domains

Checks the availability of Premium Domain Names based on the specified keyword.

Suggest Names

Suggests domain names for the given keyword.

Register

Registers a specified domain name.

Transfer

Transfers a specified domain name to you.

Validating a Transfer Request

Checks if a transfer request is valid for the specified domain name.

Renew

Renews the specified Domain Registration Order for multiple years.

Search

Gets a list of Domain Registration Orders, which suit the Search criteria, along with the details.

Get Customer Default Name Servers

Gets a list of the default Name Servers for the Customer.

Get Order Id

Gets the Order Id of a Registered domain name.

Get Registration Order Details

Gets the details of a Domain Registration Order.

Modify Name Servers

Modifies the Name Servers of the specified Domain Registration Order.

Add Child Name Server

Adds Child Name Servers for the specified Domain Registration Order.

Modify Child Name Server Host Name

Modifies the name of the Child Name Server of the specified Domain Registration Order.

Modify Child Name Server IP Address

Modifies the IP addresses associated with the specified Child Name Server of the specified Domain Registration Order.

Deleting Child Name Server IP Address

Deletes the IP address associated with the specified Child Name Server of the particular Domain Registration Order.

Modify Contacts

Modifies the Contacts of the specified Domain Registration Order.

Modify Privacy Protection Status

Changes the Privacy Protection status of the specified Domain Registration Order.

Modify Auth-Code

Modifies the Auth-Code of the specified Domain Registration Order.

Apply Theft Protection Lock

Applies the Theft Protection lock on the specified Order.

Remove Theft Protection Lock

Removes the Theft Protection lock on the specified Order.

Get the List of Locks Applied on a Domain Name

Gets the list of locks applied on a Domain Registration Order.

Get TEL CTH Login Details

Gets the CTH Login Details for the specified .TEL Domain Registration Order.

Modify TEL Whois Preference

Modifies the Whois preference of the .TEL Domain Registration Order.

Resend Transfer Approval Mail

Resends the Transfer Approval mail for the specified Order.

Release a UK Domain Name

Releases (transfer-out) the specified .UK domain name to the specified Registrar tag.

Cancel Transfer

Cancels the Transfer-In Order that is awaiting Admin approval.

Suspend

Applies the Suspension on the specified Domain Registration Order.

Unsuspend

Removes the Suspension on the specified Domain Registration Order.

Delete

Deletes the specified Domain Registration Order.

Restore

Restores the specified Domain Registration Order.

Rechecking NS with .DE Registry

Recheck zone configuration with .de registry of the expired .DE Domain Registration Order.

Associating/Dissociating .XXX Membership Token/ID

Allows associating/dissociating the Membership Token/ID provided by the .XXX Registry, to a Domain Registration Order.