reseller

is added when reseller has a customer specific business

Cancelling a Customer's Invoice and Debit Note

Description

This call allows you to cancel a customer's invoices or debit notes. It requires a minimum of one invoice id or debit note id

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
invoice-ids Array Of Integer Required Invoice Ids that are to be settled
debit-ids Array Of Integer Optional Debit Note Ids that are to be settled

HTTP Method

POST

Example Test URL Request

https://test.httpapi.com/api/billing/customer-transactions/cancel.xml?auth-userid=0&api-key=key&invoice-ids=0&invoice-ids=1&debit-ids=0&debit-ids=1

Response

Returns a hash map of the specified Transactions (invoices and / or debit notes) containing the below details:

  • Status (Success or Failed)

  • Error (only when the status is failed)

Returns the below details only in case of an invoice

  • Action Type (actiontype)

  • Description of the Action (actiontypedesc)

  • Order ID of the Invoice (entityid)

  • Action Status (actionstatus)

  • Description of the Action Status (actionstatusdesc)

Example

Request

https://test.httpapi.com/api/billing/customer-transactions/cancel.xml?auth-userid=0&api-key=key&invoice-ids=302789&debit-note-ids=25012

Response

{"25012":{"status":"Success"},"302789":{"actiontypedesc":"Addition of EE1 for 34543564564756.com for 1 month","actionstatus":"Failed","entityid":"574694","status":"Success","actiontype":"Add","description":" 34543564564756.com","actionstatusdesc":"Execution Cancelled"}}

Discounting an Invoice

Description

Adds a discount for a given invoice.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
invoice-id Integer Required Invoice id to be discounted
discount-without-tax Float Required Discount amount without tax
transaction-key String Required A unique Transaction key
role String Required reseller/customer

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/billing/customer-processdiscount.json?auth-userid=0&api-key=key&invoice-id=0&discount-without-tax=10.0&transaction-key=transaction-key-text&role=reseller

Response

Returns 'true' when successful.

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

"status":"ERROR","message":"Duplicate Transaction.This transaction already present in the system.

Get Domain Aliases

Description

Get domain aliases for the 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, Email Hosting, Legacy Web Hosting, Website Builder, Enterprise Email Order

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/mail/domain/aliases.json?auth-userid=0&api-key=key&order-id=0

Response

Returns a list of domain aliases for the order.

Forgot Password

Description

Generates a forgot password email and sends it to the customer's email address.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
username String Required Username of the customer

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/customers/forgot-password.xml?auth-userid=0&api-key=key&username=0

Response

Returns true (Boolean) if the forgot password email was sent.

Validate Upgrade/Downgrade

Description

Validates upgrade/downgrade for a particular CodeGuard 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 of the CodeGuard Order for which upgrade/downgrade needs to be validated
new-planid 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.

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/codeguard/validate-modify.json?auth-userid=0&api-key=key&order-id=0&new-planid=0

Response

Returns true (String) if upgrade/downgrade is validated successfully.

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

Get Upgrade/Downgrade Price

Description

Gets the applicable upgrade/downgrade price for a particular CodeGuard 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 of the CodeGuard Order 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/codeguard/modify-pricing.json?auth-userid=0&api-key=key&order-id=0&new-plan-id=0&months=0

Response

Returns the applicable upgrade/downgrade price for a particular CodeGuard Order.

Example:


{
"upgradecost":0.0,
"modifiedOrderPrice":0.0,
"endtime":"0000000000",
"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

Validate Upgrade

Description

Validates upgrade for a particular SiteLock 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 of the SiteLock Order for which upgrade needs to be validated
new-planid Integer Required The new plan to which the Order is to be upgraded. To fetch the plan details: plan-id etc., use this method.

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/sitelock/validate-modify.json?auth-userid=0&api-key=key&order-id=0&new-planid=0

Response

Returns true (String) if upgrade is validated successfully.

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

Get Upgrade Price

Description

Gets the applicable upgrade price for a particular SiteLock 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 of the SiteLock Order for which the details are to be fetched
new-plan-id Integer Required The new plan to which the Order is to be upgraded. To fetch the plan details: plan-id etc., use this method.

HTTP Method

GET

Example Test URL Request


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

Response

Returns the applicable upgrade price for a particular SiteLock Order.

Example:


{
"upgradecost":0.0,
"modifiedOrderPrice":0.0,
"endtime":"0000000000",
"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

Upgrade

Description

Upgrades an existing SiteLock 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 of the Order which is to be upgraded
new-plan-id Integer Required The new plan to which the Order is to be upgraded. To fetch the plan details i.e. plan-id etc, use this method.
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/sitelock/modify.json?auth-userid=0&api-key=key&order-id=0&new-plan-id=0&invoice-option=NoInvoice

Response

Returns a hash map containing the below details:

  • Domain Name (description)

  • Order ID of the SiteLock Order (entityid)

  • Action Type (actiontype)

  • Description of the SiteLock Order Upgrade Action (actiontypedesc)

  • Action ID of the SiteLock Order Upgrade Action (eaqid)

  • SiteLock Order Upgrade Action Status (actionstatus)

  • Description of the SiteLock Order Upgrade Action Status (actionstatusdesc)

  • Invoice ID of the SiteLock Order Upgrade Invoice (invoiceid)

  • Selling Currency of the Reseller (sellingcurrencysymbol)

  • Transaction Amount in the Selling Currency (sellingamount)

  • Unutilised Transaction Amount in the Selling Currency (unutilisedsellingamount)

  • Customer ID associated with the SiteLock 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.

Old SuperSite Deprecation

Over the past few months, firstfoot Interactive Pvt Ltd. has performed extensive system-wide upgrades to optimize its platform and enhance your business experience with us. As a part of these system upgrades, firstfoot Interactive Pvt Ltd. will soon be phasing out products and services that are approaching the end of their lifecycle.

The old SuperSite will be deprecated as of 15th November, 2014. As a prelude to this deprecation, firstfoot Interactive Pvt Ltd. stopped releasing new products and feature enhancements on the old SuperSite for over a year. A new and improved version, known as SuperSite 2, was introduced on 13th June, 2012 and all new products / features are being made available on this version only.

This article explains how you will be impacted due to the deprecation and the process of setting up your SuperSite 2.

Impact on Resellers using the old SuperSite

  • If you are using the old SuperSite, all your traffic will be automatically redirected to SuperSite 2 after the deprecation.

  • Your business logo as well as any product plans settings will be ported to SuperSite 2.

  • Any other customizations on your old SuperSite need to be replicated manually on your SuperSite 2 before the deprecation. Your old SuperSite files will be made available in the SuperSite 2 Admin Area for a short period of time, from where you can retrieve them, if required, after the deprecation.

  • Just like the old SuperSite, SuperSite 2 is fully customizable. You can easily alter the HTML and CSS to make it match your brand.

    Additional Information

    SuperSite 2 Customization

  • Also, you can use your own domain name and brand your SuperSite 2 URL with your company name.

    Additional Information

    Branding SuperSite 2 URL

About SuperSite 2

SuperSite 2 is designed to be a powerful storefront built with the latest design and UX trends. Important features of SuperSite 2 are:

  • A completely new look and feel with minimalistic & sophisticated design

  • An easy 3 step check-out process that makes it easier for your Customers to buy

  • Fast load times with quick check availability & search functions

  • A new upselling module that upsells relevant products to a Customer during check-out

  • Customizable landing page URLs, fat footer and keyword-rich content make SuperSite 2 more SEO friendly

  • Redesigned product pages with highlighted plans, comprehensive feature lists and FAQs

  • An improved Customer Sign-Up process with fewer fields and instant validation

  • Javascript based menu replaced with a new fat menu completely written in HTML and CSS for easier editing

  • Availability of different Language Packs

  • A fast AJAX based domain check availability feature

  • Multiple layouts to suit every business model

  • Automatic detection of visitor’s IP for displaying prices in local currency

  • Ability to offer coupons to your Customers via the Coupon Engine