Get the Details of a Business Email Order Using the API

When you want to retrieve the details of an existing Business Email order using the API. This article explains the required authentication parameters, order ID input, Business Email order information, email account details, order status information, and order response details.

Get Details

Description

Gets the details of an existing Business Email 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 details are to be fetched

HTTP Method

GET

Example Test URL Request

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

Response

Returns a hash map containing details of the Business Email Order as below:

Order Id (entityid)
Order Description (description)
Domain Name (domainname)
Current Order Status under the System (currentstatus) - value will be InActive, Active, Suspended, Pending Delete Restorable, Deleted or Archived
Product Category (productcategory)
Product Key (productkey)
Order Creation Date (creationtime)
Expiry Date (endtime)
Whether Order belongs to a Customer directly under the Reseller (isImmediateReseller)
Reseller Chain by Reseller Id (parentkey)
Customer Id Associated with the Order (customerid)
Number of Email Accounts (emailaccounts)
Whether Order Suspended due to Expiry (isOrderSuspendedUponExpiry)
Whether Order Suspended by Parent Reseller (orderSuspendedByParent)
Whether Order Deletion is Allowed (allowdeletion)
Whether Auto-Renewal is enabled (recurring)

Did you find this article helpful?