reseller

is added when reseller has a customer specific business

Setting a Default Contact

Description

Sets a default contact for the Customer.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
customer-id Integer Required The Customer for whom you want to set the Default Contacts
type Array of Strings Required Type of default contact to be returned. It can be one or more of following contacts types : Contact, CoopContact, UkContact, EuContact, CnContact, CoContact, CaContact, DeContact, EsContact.
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

HTTP Method

POST

Example Test URL


https://httpapi.com/api/contacts/modDefault.json?auth-userid=0&api-key=key&customer-id=0&type=Contact&reg-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0

Response

Returns a hash map containing the below details of the Default Contacts for each Contact Type requested:

  • registrantContactDetails / adminContactDetails / techContactDetails / billingContactDetails:

    • Contact ID (entity.entityid)

    • Name (contact.name)

    • Company (contact.company)

    • Contact Type (contact.type)

    • Email Address (contact.emailaddr)

    • Telephone Number Country Code (contact.telnocc)

    • Telephone Number (contact.telno)

    • First line of address of the Contact (contact.address1)

    • Second line of address of the Contact (contact.address2)

    • Third line of address of the Contact (contact.address3)

    • City (contact.city)

    • State (contact.state)

    • Country Code (contact.country)

    • ZIP Code (contact.zip)

    • Current Status in the System (entity.currentstatus)

    • Creation Date in the System (contact.creationdt)

    • Creation Date at the Registry (contact.timestamp)

    • Customer ID associated with the Contact (entity.customerid)

  • Registrant Contact ID (registrant)

  • Admin Contact ID (admin)

  • Tech Contact ID (tech)

  • Billing Contact ID (billing)

  • Contact Type (type)

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

Unlock

Description

Removes the Lock on the specified 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 Lock is to be removed

HTTP Method

POST

Example Test URL Request

https://httpapi.com/api/domains/reseller-lock/remove.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 Domain Registration Order (entityid)

  • Action Type (actiontype)

  • Description of the Order Unlock Action (actiontypedesc)

  • Action ID of the Order Unlock Action (eaqid)

  • Order Unlock Action Status (actionstatus)

  • Description of the Order Unlock Action Status (actionstatusdesc)

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

Lock

Description

Applies a Lock on the specified 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 on which the lock is to be applied
reason String Required The reason for the lock.

HTTP Method

POST

Example Test URL Request

https://httpapi.com/api/domains/reseller-lock/add.json?auth-userid=0&api-key=key&order-id=0&reason=reason-for-lock

Response

Returns a hash map containing the below details:

  • Domain Name (description)

  • Order ID of the Order to be locked (entityid)

  • Action Type (actiontype)

  • Description of the Order lock Action (actiontypedesc)

  • Action ID of the Order lock Action (eaqid)

  • Order lock Action Status (actionstatus)

  • Description of the Order lock Action Status (actionstatusdesc)

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

Change Primary Domain

Description

Changes the primary domain name for an existing Reseller Windows Hosting 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 which is to be modified.
new-domain-name String Required The new primary domain name.

HTTP Method

POST

Example Test URL Request

US Server


https://test.httpapi.com/api/resellerhosting/windows/us/change-domain-name.json?auth-userid=0&api-key=key&order-id=0&new-domain-name=domain.com

UK Server


https://test.httpapi.com/api/resellerhosting/windows/uk/change-domain-name.json?auth-userid=0&api-key=key&order-id=0&new-domain-name=domain.com

India Server


https://test.httpapi.com/api/resellerhosting/windows/in/change-domain-name.json?auth-userid=0&api-key=key&order-id=0&new-domain-name=domain.com

Turkey Server


https://test.httpapi.com/api/resellerhosting/windows/tr/change-domain-name.json?auth-userid=0&api-key=key&order-id=0&new-domain-name=domain.com

Response

Returns a map of the execution details of the change primary domain operation.

Change Primary Domain

Description

Changes the primary domain name for an existing Reseller Linux Hosting 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 which is to be modified.
new-domain-name String Required The new primary domain name.

HTTP Method

POST

Example Test URL Request

US Server


https://test.httpapi.com/api/resellerhosting/linux/us/change-domain-name.json?auth-userid=0&api-key=key&order-id=0&new-domain-name=domain.com

UK Server


https://test.httpapi.com/api/resellerhosting/linux/uk/change-domain-name.json?auth-userid=0&api-key=key&order-id=0&new-domain-name=domain.com

India Server


https://test.httpapi.com/api/resellerhosting/linux/in/change-domain-name.json?auth-userid=0&api-key=key&order-id=0&new-domain-name=domain.com

Turkey Server


https://test.httpapi.com/api/resellerhosting/linux/tr/change-domain-name.json?auth-userid=0&api-key=key&order-id=0&new-domain-name=domain.com

Response

Returns a map of the execution details of the change primary domain operation.

Change Primary Domain

Description

Changes the primary domain name for an existing Multi Domain Windows Hosting order.

Parameters

Name Data Type Required / Optional
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required The OrderId which is to be modified.
new-domain-name String Required The new primary domain name.

HTTP Method

POST

Example Test URL Request

US, Texas Server


https://test.httpapi.com/api/multidomainhosting/windows/us/change-domain-name.json?auth-userid=0&api-key=key&order-id=0&new-domain-name=domain.com

US, California Server


https://test.httpapi.com/api/multidomainhosting/windows/us/ca/change-domain-name.json?auth-userid=0&api-key=key&order-id=0&new-domain-name=domain.com

UK Server


https://test.httpapi.com/api/multidomainhosting/windows/uk/change-domain-name.json?auth-userid=0&api-key=key&order-id=0&new-domain-name=domain.com

India Server


https://test.httpapi.com/api/multidomainhosting/windows/in/change-domain-name.json?auth-userid=0&api-key=key&order-id=0&new-domain-name=domain.com

Hong Kong Server


https://test.httpapi.com/api/multidomainhosting/windows/hk/change-domain-name.json?auth-userid=0&api-key=key&order-id=0&new-domain-name=domain.com

Turkey Server


https://test.httpapi.com/api/multidomainhosting/windows/tr/change-domain-name.json?auth-userid=0&api-key=key&order-id=0&new-domain-name=domain.com

Response

Returns a map of the execution details of the change primary domain operation.

Change Primary Domain

Description

Changes the primary domain name for an existing Multi Domain Linux Hosting order.

Parameters

Name Data Type Required / Optional
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required The OrderId which is to be modified.
new-domain-name String Required The new primary domain name.

HTTP Method

POST

Example Test URL Request

US, Texas Server


https://test.httpapi.com/api/multidomainhosting/linux/us/change-domain-name.json?auth-userid=0&api-key=key&order-id=0&new-domain-name=domain.com

US, California Server


https://test.httpapi.com/api/multidomainhosting/linux/us/ca/change-domain-name.json?auth-userid=0&api-key=key&order-id=0&new-domain-name=domain.com

UK Server


https://test.httpapi.com/api/multidomainhosting/linux/uk/change-domain-name.json?auth-userid=0&api-key=key&order-id=0&new-domain-name=domain.com

India Server


https://test.httpapi.com/api/multidomainhosting/linux/in/change-domain-name.json?auth-userid=0&api-key=key&order-id=0&new-domain-name=domain.com

Hong Kong Server


https://test.httpapi.com/api/multidomainhosting/linux/hk/change-domain-name.json?auth-userid=0&api-key=key&order-id=0&new-domain-name=domain.com

Turkey Server


https://test.httpapi.com/api/multidomainhosting/linux/tr/change-domain-name.json?auth-userid=0&api-key=key&order-id=0&new-domain-name=domain.com

Response

Returns a map of the execution details of the change primary domain operation.

Change Primary Domain

Description

Changes the primary domain name for an existing Single Domain Windows Hosting order.

Parameters

Name Data Type Required / Optional
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required The OrderId for which the primary domain is to be modified.
new-domain-name String Required The new primary domain name.

HTTP Method

POST

Example Test URL Request

US, Texas Server


https://test.httpapi.com/api/singledomainhosting/windows/us/change-domain-name.json?auth-userid=0&api-key=key&order-id=0&new-domain-name=domain.com

US, California Server


https://test.httpapi.com/api/singledomainhosting/windows/us/ca/change-domain-name.json?auth-userid=0&api-key=key&order-id=0&new-domain-name=domain.com

UK Server


https://test.httpapi.com/api/singledomainhosting/windows/uk/change-domain-name.json?auth-userid=0&api-key=key&order-id=0&new-domain-name=domain.com

India Server


https://test.httpapi.com/api/singledomainhosting/windows/in/change-domain-name.json?auth-userid=0&api-key=key&order-id=0&new-domain-name=domain.com

Hong Kong Server


https://test.httpapi.com/api/singledomainhosting/windows/hk/change-domain-name.json?auth-userid=0&api-key=key&order-id=0&new-domain-name=domain.com

Turkey Server


https://test.httpapi.com/api/singledomainhosting/windows/tr/change-domain-name.json?auth-userid=0&api-key=key&order-id=0&new-domain-name=domain.com

Response

Returns a map of the execution details of the change primary domain operation.

Change Primary Domain

Description

Changes the primary domain name for an existing Single Domain Linux Hosting Order.

Parameters

Name Data Type Required / Optional
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required The OrderId for which the primary domain is to be changed.
new-domain-name String Required The new primary domain name.

HTTP Method

POST

Example Test URL Request

US, Texas Server


https://test.httpapi.com/api/singledomainhosting/linux/us/change-domain-name.json?auth-userid=0&api-key=key&order-id=0&new-domain-name=domain.com

US, California Server


https://test.httpapi.com/api/singledomainhosting/linux/us/ca/change-domain-name.json?auth-userid=0&api-key=key&order-id=0&new-domain-name=domain.com


UK Server


https://test.httpapi.com/api/singledomainhosting/linux/uk/change-domain-name.json?auth-userid=0&api-key=key&order-id=0&new-domain-name=domain.com

India Server


https://test.httpapi.com/api/singledomainhosting/linux/in/change-domain-name.json?auth-userid=0&api-key=key&order-id=0&new-domain-name=domain.com

Hong Kong Server


https://test.httpapi.com/api/singledomainhosting/linux/hk/change-domain-name.json?auth-userid=0&api-key=key&order-id=0&new-domain-name=domain.com

Turkey Server


https://test.httpapi.com/api/singledomainhosting/linux/tr/change-domain-name.json?auth-userid=0&api-key=key&order-id=0&new-domain-name=domain.com

Response

Returns a map of the execution details of the change primary domain operation.

Changes to Billing Engine

We have made some changes to how the billing instruments (Invoice, Receipt, Credit Note and Debit Note) work in the system.



Serial Numbering

  • Invoices, Credit Notes, Receipts and Debit Transactions will now have their own Serial numbered ID for each Reseller. The IDs will be called Invoice ID, Credit Note ID, Receipt ID and Debit ID respectively.
  • The Transaction ID will not be added to the Print view and downloaded PDF. However, the Transaction ID will be maintained as a unique map to a transaction throughout the system.
  • The serialised ID will be seen in the Print View and the PDF.
  • In the List Transactions Page, there will be an additional column titled “Billing ID”, where the serialised ID (Invoice ID, Credit Note ID, Receipt ID and Debit ID), for each transaction type will be displayed.
Note

The Serialised Billing IDs will be applicable only to new transactions. The existing transactions in the system will not be updated with a Serialised Billing ID.


Changes to Invoices and introduction of Pending Invoices

  • What is a Pending Invoice?
    • Pending Invoices are those Invoices which have not been paid for, or the Service hasn’t been provided.
    • Pending Invoices do not have an Invoice ID (hence the dashes against them in the Billing ID column). They do however have a Transaction ID, which will show up in the Print view and PDF.

  • What is the difference between a Pending Invoice and an Invoice?
    • A Transaction will be labelled as an Invoice when a full payment has been made, or the Service has been rendered. The latter case would apply if a Reseller chooses to activate the Order without a payment coming in from the Customer. This transaction will be tagged as an Invoice and not a “Pending Invoice”.
    • Invoices will have their own serialised Invoice ID, where as a Pending Invoice will take the Transaction ID.

  • When a full payment does come in for a Pending Invoice or if the Order was activated (whichever comes first):
    • The Pending Invoice will be tagged as an Invoice.
    • This new Invoice will have an Invoice ID.
    • The date on the Invoice will be the date the payment was made or when the Order was activated (whichever came first).



Changes to Credit Notes

  • All Credit Notes need to be associated with an Invoice and will have the associated Invoice ID on them.
  • Credit Notes can only be raised directly from the Invoice and not via the add funds button.
  • Credit Notes will have their own serialised Credit Note ID per Reseller.



Changes to Receipts

  • Receipts will have their own serialised Receipt ID.
  • While adding a Receipt you can choose a sub-type from a dropdown. These sub-types were earlier used for a Credit Notes, but have been moved over to Receipts.



Changes to Debit Notes

  • Debit Notes will be called Debit Transactions.
  • Debit Transactions will have their own serialised Debit ID.
  • In the List Transactions page, Debit Transactions will be listed as Debit.