Title: Search and Get WordPress Hosting Order Details Using the API  
PrimaryCategory: API  
Type: Procedural  
Tags: wordpress hosting, api, order details, search, filters, request parameters  
Source UI Terms: auth-userid, api-key, order-id, domain-name, filter  
Source Reference: Search and Get WordPress Hosting Order Details Using the API

---

### Prerequisites:
- Have your Live Account Reseller Id (auth-userid) ready.
- Have your API key (api-key) available for authentication.

### Steps:
1) Construct an HTTP GET request to the API endpoint:
   ```
   https://test.httpapi.com/restapi/product/wordpresshostingusa
   ```
2) Include the following parameters in the URL query string:
   - `auth-userid` (Integer, Required): Your Live Account Reseller Id.
   - `api-key` (String, Required): Your API authentication key.
   - Optionally include `order-id` (Integer): The OrderId whose details you want to fetch.
   - Optionally include `domain-name` (String): The domain name to fetch order details for.
   - Optionally include `filter` (String): To filter orders by given values. Possible values are:
     - orderid
     - domainname
     - recurring
     - creationtime
     - addon_quantity
     - planid
     - productkey
     - productcategory
     - currentstatus
     - moneybackperiod
     - entitytypeid
     - customerid
     - endtime
     - isOrderSuspendedUponExpiry
     - parentkey

3) Send the GET request.

4) Receive a response containing the details of the requested WordPress Hosting order.

### Example Request URL:
```
https://test.httpapi.com/restapi/product/wordpresshostingusa?auth-userid=0&amp;api-key=keyℴ-id=0&amp;domain-name=domain.com&amp;filter=orderid
```

### Warnings:
- Ensure `auth-userid` and `api-key` are valid to authenticate the API call.
- Using filters improperly may lead to no results or unexpected data.

---

Summary:  
Use the provided HTTP GET API with your reseller ID and API key, optionally including order ID, domain name, and filter parameters, to retrieve details of existing WordPress Hosting orders.

---

Evaluation Pairs:

Q: What parameters are required to search for WordPress Hosting order details using the API?  
A: You must provide `auth-userid` (your reseller ID) and `api-key` to authenticate the API call.

Q: How can I filter the WordPress Hosting orders returned by the API?  
A: Use the optional `filter` parameter with values like orderid, domainname, recurring, creationtime, etc., to filter orders accordingly.

Q: What HTTP method should I use to request WordPress Hosting order details?  
A: Use the HTTP GET method to request order details from the API.

<p>When you want to search and retrieve WordPress Hosting order details using the API. This article explains supported search filters, request parameters, API request format, and response details for WordPress Hosting orders.</p>
<div class="region region-content">
<div class="block block-core block-page-title-block" id="block-twostates-page-title">
<div class="content">
<div id="toc" style="display: block;">
<div id="toc_content">
<p> </p>
</div>
</div>
</div>
</div>
<div class="node__content clearfix">
<div class="layout layout--onecol">
<div class="layout__region layout__region--content">
<div class="clearfix text-formatted field field--name-body field--type-text-with-summary field--label-hidden field__item">
<h2><a name="heading_0"></a>Description</h2>
<p>Gets the details of an existing Wordpress Hosting Order.</p>
<h2><a name="heading_1"></a>Parameters</h2>
<table class="codetable"><tbody><tr><th colspan="1" rowspan="1">Name</th><th colspan="1" rowspan="1">Data Type</th><th colspan="1" rowspan="1">Required / Optional</th><th colspan="1" rowspan="1">Description</th></tr><tr><td colspan="1" rowspan="1">auth-userid</td><td colspan="1" rowspan="1">Integer</td><td colspan="1" rowspan="1">Required</td><td colspan="1" rowspan="1">Your Live Account Reseller Id</td></tr><tr><td colspan="1" rowspan="1">api-key</td><td colspan="1" rowspan="1">String</td><td colspan="1" rowspan="1">Required</td><td colspan="1" rowspan="1">An alphanumeric code that can be used to authenticate your API calls</td></tr><tr><td colspan="1" rowspan="1">order-id</td><td colspan="1" rowspan="1">Integer</td><td colspan="1" rowspan="1">Optional</td><td colspan="1" rowspan="1">The OrderId for which the details are to be fetched.</td></tr><tr><td colspan="1" rowspan="1">domain-name</td><td colspan="1" rowspan="1">String</td><td colspan="1" rowspan="1">Optional</td><td colspan="1" rowspan="1">Domain name for which the details are to be fetched</td></tr><tr><td colspan="1" rowspan="1">filter</td><td colspan="1" rowspan="1">String</td><td colspan="1" rowspan="1">Optional</td><td colspan="1" rowspan="1">This parameter will filter the orders according to the values provided. Values can be: <i>orderid, domainname, recurring, creationtime, addon_quantity, planid, productkey, productcategory, currentstatus, moneybackperiod, entitytypeid, customerid, endtime, isOrderSuspendedUponExpiry, parentkey</i></td></tr></tbody></table>
<h2><a name="heading_2"></a>HTTP Method</h2>
<p>GET</p>
<h2><a name="heading_3"></a>Example Test URL Request</h2>
<p><code>https://test.httpapi.com/restapi/product/wordpresshostingusa?auth-userid=0&amp;api-key=key&amp;order-id=0&amp;domain-name=domain.com&amp;filter=orderid</code></p>
<h2><a name="heading_4"></a>Response</h2>
<p>Returns the details of an existing Wordpress Hosting order.</p>
</div>
</div>
</div>
</div>
<div class="mychild-topics"> </div>
</div>
<div class="seedetailssection"> </div>

When you want to search and retrieve WordPress Hosting order details using the API. This article explains supported search filters, request parameters, API request format, and response details for WordPress Hosting orders.

Name	Data Type	Required / Optional	Description
auth-userid	Integer	Required	Your Live Account Reseller Id
api-key	String	Required	An alphanumeric code that can be used to authenticate your API calls
order-id	Integer	Optional	The OrderId for which the details are to be fetched.
domain-name	String	Optional	Domain name for which the details are to be fetched
filter	String	Optional	This parameter will filter the orders according to the values provided. Values can be: orderid, domainname, recurring, creationtime, addon_quantity, planid, productkey, productcategory, currentstatus, moneybackperiod, entitytypeid, customerid, endtime, isOrderSuspendedUponExpiry, parentkey