reseller

is added when reseller has a customer specific business

The Express Cart

The Express Cart is a power tool that is specially designed to help Resellers place Orders on behalf of their Customers. It encapsulates the purchase process in 3 simple steps and allows for easier and faster Order processing.

The Express Cart can be reached by clicking on the Buy button in the Reseller Control Panel on the top right. Alternatively, all Buy links within the Products menu default to the Express Cart for Resellers.

You can switch to SuperSite2 through the Go to Supersite >> link in the Express Cart tool.

You can place Orders within seconds through the Express Cart by simply:

  1. Selecting a Product

  2. Specifying the Customer information

  3. Selecting an Invoice option for this Customer

Selecting a Product

All the Products that you currently offer will be available within the drop down.

Note

Currently, the following Products are not supported in the Express Cart:

  • Dedicated Servers

  • Managed Servers

  • SiteLock

With the Express Cart, you can place a single Order at a time.

Domain Registration

The tool offers the essentials in terms of Domain Registration, where you can search for your desired keywords and extensions. You can choose to add Privacy Protection to the Order, as well.

Note

You must go to your SuperSite/custom Storefront if you want to:

  • see suggestions for your domain name

  • register Internationalized Domain Names (IDNs)

  • register domains under TLDs that require special nexus information

  • register premium names

  • register / transfer domain names in bulk

The default Name servers and Contact details are automatically used for domain registration.

Note

Make sure to Reload Your Cost Prices every time your Parent changes them. This way, you will be able to see your updated Cost Prices in the Express Cart.

Applying Discounts

For every Order, you can apply desired discounts in the cart itself. You can either enter an amount or a percentage.

  • If a discount is applied to the Order, a Credit Note for the corresponding amount is added to the Customer's account.

  • If a Product is already on promotion, the Reseller can still apply an additional discount. In this case, a similar Credit Note will be created.

Adding Funds

In case you are short on funds, you can click on the Add Funds link to replenish your balance. Once done, make sure to hit the Refresh Balance link so that your new balance gets updated on the Express Cart.

Specifying the Customer Information

Here, you can simply enter the email address of the Customer you are purchasing this Product for. If it is a new Customer, click on the Create Account button and add the necessary details to create a new Customer account.

Selecting an Invoice Option

You can either choose to cancel the Invoice or leave it pending for your Customer, by selecting one of these options:

  • Cancel Invoice - This will reverse the Invoice after creating it, by automatically adding a sales reversal Credit Note for the same amount. You can use this option when you’re using the system for billing, but collecting funds offline. This way, you can always keep track of your sales transactions and discounts, without having your Customer pay for the Invoice in the system.

  • Keep Invoice pending - This will create the Invoice and keep it pending till your Customer doesn’t pay for it in the system. You can use this option when you’re collecting funds online and require to suspend the Order, in case your payment doesn’t come through.

Once you place the Order, your total cost will automatically be deducted from your Account Balance and the Order will be activated for your Customer. System notifications will be sent to you and your Customer, as per your Email preferences.

Get Customer Pricing

Description

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

Response

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

The response structure for the CodeGuard product will be:


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

Example:


"codeguard":
{
"plans":
{
"229":
{
"renew":
{
"6":0.0
"12":0.0
"24":0.0
},
"add":
{
"6":0.0
"12":0.0
"24":0.0
}
},
"230":
{
"renew":
{
"6":0.0
"12":0.0
"24":0.0
},
"add":
{
"6":0.0
"12":0.0
"24":0.0
}
}
"231":
{
"renew":
{
"6":0.0
"12":0.0
"24":0.0
},
"add":
{
"6":0.0
"12":0.0
"24":0.0
}
}
"232":
{
"renew":
{
"6":0.0
"12":0.0
"24":0.0
},
"add":
{
"6":0.0
"12":0.0
"24":0.0
}
}
}
}

Search Orders

Description

Gets a list and details of the CodeGuard 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 IDs of the CodeGuard Orders whose details need to be fetched
reseller-id Array of Integers Optional Reseller IDs whose CodeGuard Orders need to be fetched
customer-id Array of Integers Optional Customer IDs whose CodeGuard 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, Suspended or Deleted
domain-name String Optional Name of the Domain of the CodeGuard Order
creation-date-start String Optional UNIX TimeStamp for listing of the CodeGuard Orders whose Creation Date is greater than creation-date-start
creation-date-end String Optional UNIX TimeStamp for listing of the CodeGuard Orders whose Creation Date is less than creation-date-end
expiry-date-start String Optional UNIX TimeStamp for listing of the CodeGuard Orders whose expiry date is greater than expiry-date-start
expiry-date-end String Optional UNIX TimeStamp for listing of the CodeGuard 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 orderid; it will fetch the second batch of 30 Orders sorted by orderid.

HTTP Method

GET

Example Test URL Request


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

Response

Returns a hash map containing the below details of the CodeGuard Orders which match the search criteria:

  • Domain Name (entity.description)

  • Order Id (orders.orderid)

  • Customer Id (entity.customerid)

  • Order Creation Timestamp (orders.creationtime)

  • Order Expiry Timestamp (orders.endtime)

  • Current Order Status (entity.currentstatus) - value will be InActive, Active, Suspended or Deleted

  • Product Name (entitytype.entitytypename)

  • Product Key (entitytype.entitytypekey)

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

Get Order Id

Description

Gets the associated CodeGuard Order ID from the 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 The domain name for which the Order ID is to be fetched

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/codeguard/orderid.json?auth-userid=0&api-key=key&domain-name=domainname.com

Response

Returns the associated CodeGuard Order ID (Integer) for the specified domain name.

Get Plan Details

Description

Use this method to get details of your plans.

Response

Returns details of the plans of the CodeGuard product, along with the plan details of other Products of the Reseller.

Example:

The response structure for the CodeGuard product will be:


"codeguard":
{
"plan-id":
{
"plan_name":"Plan Name",
"plan_status":"(Active or Paused)"
},
},

Get Details

Description

Gets the details of an existing 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 Order for which the details are to be fetched

HTTP Method

GET

Example Test URL Request


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

Response

Returns a hash map containing the below details:

  • Order ID (entityid)

  • Order Description (description)

  • Domain Name (domainname)

  • Current Order Status under the System (currentstatus) - value will be InActive, Active, Suspended or Deleted

  • Product key (productkey)

  • Product Category (productcategory)

  • Plan ID of the CodeGuard Plan (planid)

  • Status of the CodeGuard Plan (paused)

  • Order Creation Date (creationtime)

  • Expiry Date (endtime)

  • Whether Order belongs to a Customer directly under the Reseller (isImmediateReseller)

  • Reseller Chain by RID (parentkey)

  • Customer ID Associated with the Order (customerid)

  • Whether Order Suspended due to Expiry (isOrderSuspendedUponExpiry)

  • Whether Order Suspended by Parent Reseller (orderSuspendedByParent)

  • Whether Order Deletion is Allowed (allowdeletion)

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

Delete

Description

Deletes an existing 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 Order which is to be deleted

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/codeguard/delete.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 CodeGuard Order (entityid)

  • Action Type (actiontype)

  • Description of the CodeGuard Order Delete Action (actiontypedesc)

  • Action ID of the CodeGuard Order Delete Action (eaqid)

  • CodeGuard Order Delete Action Status (actionstatus)

  • Description of the CodeGuard Order Delete Action Status (actionstatusdesc)

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

Upgrade/Downgrade

Description

Upgrades/Downgrades an existing CodeGuard 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 of the Order which is to be upgraded/downgraded
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.
months Integer Required The number of months in the new plan for which the Order is to be upgraded/downgraded
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/codeguard/modify.json?auth-userid=0&api-key=key&order-id=0&new-plan-id=0&months=0&invoice-option=NoInvoice

Response

Returns a hash map containing the below details:

  • Domain Name (description)

  • Order ID of the CodeGuard Order (entityid)

  • Action Type (actiontype)

  • Description of the CodeGuard Order Upgrade/Downgrade Action (actiontypedesc)

  • Action ID of the CodeGuard Order Upgrade/Downgrade Action (eaqid)

  • CodeGuard Order Upgrade/Downgrade Action Status (actionstatus)

  • Description of the CodeGuard Order Upgrade/Downgrade Action Status (actionstatusdesc)

  • Invoice ID of the CodeGuard Order Upgrade/Downgrade 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 CodeGuard 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.