Restore
Restores 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 that you want to restore |
invoice-option | String | Required | This will decide how the Customer Invoice will be handled. Set any of below mentioned Invoice Options for your Customer:
|
HTTP Method
POST
Example Test URL Request
https://test.httpapi.com/api/domains/restore.json?auth-userid=0&api-key=key&order-id=0&invoice-option=KeepInvoice
Response
Returns a hash map containing the below details:
-
Domain Name (description)
-
Order ID of the Domain Registration Order (entityid)
-
Action ID of the Domain Restoration Action (eaqid)
-
Description of the Domain Restoration Action (actiontypedesc)
-
Domain Restoration Action Status (actionstatus)
-
Description of the Domain Restoration Action Status (actionstatusdesc)
-
Invoice ID of the Domain Restoration Invoice (invoiceid)
-
Selling Currency of the Reseller (sellingcurrencysymbol)
-
Selling Price for Customers (sellingamount)
-
Customer ID associated with the Domain Registration Order (customerid)
invoiceid, sellingcurrencysymbol, sellingamount 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.