reseller

is added when reseller has a customer specific business

Get Modify/Upgrade Price

Description

Gets the applicable modify/upgrade price for a particular Web Services 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 OrderId for which the details are to be fetched.
new-plan-id Integer Required The new plan to which the Order is to be upgraded/downgraded. To fetch the plan details: plan-id etc., use this method.
months Integer Required The number of months (tenure) in the new plan for which the Order to be placed.

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/webservices/modify-pricing.json?auth-userid=0&api-key=key&order-id=0&new-plan-id=0&months=0

Response

Returns the applicable modify/ upgrade price for a particular Web Services Order.

Example:


{
"upgradecost":0.0,
"modifiedOrderPrice":0.0,
"endtime":"0000000000",
"modifyCostResult":"upgrade",
"remainingmonths":0,
"currentOrderPrice":0.0
}

where

  • currentOrderPrice: The current pricing of the Order for remaining months.

  • modifiedOrderPrice: New applicable pricing of the Order as per the new plan.

  • upgradecost: Actual price applicable i.e. modifiedOrderPrice - currentOrderPrice

Search Orders

Description

Gets a list and details of 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 Order(s) whose details need to be fetched.
reseller-id Array of Integers Optional Reseller Id(s) whose Orders need to be fetched.
customer-id Array of Integers Optional Customer Id(s) 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 Name of the Domain of the Web Services Order.
creation-date-start String Optional UNIX TimeStamp for listing of Orders whose Creation Date is greater than creation-date-start.
creation-date-end String Optional UNIX TimeStamp for listing of Orders whose Creation Date is less than creation-date-end.
expiry-date-start String Optional UNIX TimeStamp for listing of Orders whose expiry date is greater than expiry-date-start.
expiry-date-end String Optional UNIX TimeStamp for listing of 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 order id; it will fetch the second batch of 30 Orders sorted by orderid

HTTP Method

GET

Example Test URL Request


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

Response

Returns the list of the Orders which match the search criteria.

Get Customer Pricing

Description

Use this method to get details of the pricing for your plans.

Response

Returns a map with the prices of Web Services plans along with the prices of the other products.

The response structure for the Web Services will be:


"productkey":
{
"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
}
}
}

Get Active Plan Categories

Description

Gets the list of the active plan categories (under Web Services) of the reseller.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/webservices/active-plan-categories.json?auth-userid=0&api-key=key

Response

Returns the list of the active plan categories (under Web Services) of the reseller.

Get Plan Details

Description

Use this method to get details of your plans.

Response

Returns the details of the plans of Web Services along with the plan details of other Products of the reseller.

Example:

The response structure for the Web Services will be:


hosting

{

"plan-id(value)"

{

"plan details keys" => "plan details values"

}

}

Get Details

Description

Gets the details of an existing Web Services 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 OrderId for which the details to be fetched.

HTTP Method

GET

Example Test URL Request


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

Response

Returns the details of an existing Web Services order.

Delete

Description

Deletes an existing Web Services 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 OrderId which is to be deleted.

HTTP Method

POST

Example Test URL Request


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

Response

Returns a map of the execution details of the delete operation.

Modify/Upgrade

Description

Modifies/upgrades an existing Web Services 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-plan-id Integer Required The new Plan to which the order is to be upgraded/downgraded. To fetch the Plan details i.e. plan-id etc, use this method.
Note

  • The new Plan category can be websitebuilder_plan or email_plan.

  • The new Plan category can be linux_hosting_plan only if the current Plan category is linux_hosting_plan. Similarly, the new Plan category can be windows_hosting_plan only if the current Plan category is windows_hosting_plan. In all other cases, an exception will be thrown if the new Plan category is linux_hosting_plan or windows_hosting_plan.
months Integer Required The number of months in the new Plan for which the Order is to be placed.
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


https://test.httpapi.com/api/webservices/modify.json?auth-userid=0&api-key=key&order-id=0&new-plan-id=0&months=0&invoice-option=PayInvoice

Response

Returns a map of the execution details of the modify operation.

Renew

Description

Renews an existing Web Services 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 OrderId which is to be renewed.
months Integer Required The number of months for which the Order is to be renewed.
enable-ssl Boolean Optional Values can be: true or false (default). To learn more, click here.
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

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/webservices/renew.json?auth-userid=0&api-key=key&order-id=0&months=0&invoice-option=NoInvoice

Response

Returns a map of the execution details of the Renew operation.

Add

Description

Places a Web Services Order for the specified domain name. An Order can be either Email only or Website Builder.

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.
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.
Note

The Plan category can be websitebuilder_plan or email_plan. An exception will be thrown if the Plan category is linux_hosting_plan or windows_hosting_plan.
enable-ssl Boolean Optional Values can be: true or false (default). To learn more, click here.
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

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/webservices/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 map with the execution details of the Order addition.

Subscribe to reseller