Title: Get the Web Services Order ID Using the API  
PrimaryCategory: API  
Type: Procedural  
Tags: order_id, api, domain_name, authentication, get_request  
Source UI Terms: None  
Source Reference: Get the Web Services Order ID Using the API  

### Procedural

Prerequisites:
- Have your auth-userid (integer) and api-key (string) ready for authentication.
- Know the domain name (string) for which you want to fetch the order ID.

Steps:
1) Construct a GET request URL to the Web Services API endpoint:  
   `https://test.httpapi.com/api/webservices/orderid.json`
2) Add the following query parameters:  
   - `auth-userid`: Your user ID (integer, required)  
   - `api-key`: Your API key (string, required)  
   - `domain-name`: The domain name to fetch the Order ID for (string, required)
3) Send the GET request using the constructed URL.
4) Receive the response containing the associated Web Services Order Id for the specified domain name.

Warnings:
- Ensure all required parameters are included and correctly formatted.
- The HTTP method must be GET.

Summary:
You can retrieve the Web Services Order ID for a domain by sending a GET request with authentication parameters and the domain name to the designated API endpoint.

Evaluation Pairs:
Q: What parameters are required to get the Web Services Order ID using the API?  
A: You need to provide `auth-userid`, `api-key`, and `domain-name` as required parameters.

Q: Which HTTP method should be used to fetch the Order ID?  
A: The HTTP method must be GET.

Q: How is the domain specified in the API request?  
A: The domain is specified using the `domain-name` parameter in the GET request URL.

<p>When you want to retrieve the Web Services order ID associated with a domain name. This article explains the required parameters and API request format for fetching the associated Web Services order ID.</p>
<div class="region region-content">
<div class="hidden"> </div>
<div class="block block-core block-page-title-block" id="block-twostates-page-title">
<div class="content">
<h1 class="title page-title"><span class="field field--name-title field--type-string field--label-hidden">Getting Order Id</span></h1>
<div id="toc" style="display: block;">
<div id="toc_content"></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>Description</h2>
<p>Gets the associated Web Services <strong>Order Id</strong> from the domain name.</p>
<h2>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">Authentication Parameter</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">Authentication Parameter</td></tr><tr><td colspan="1" rowspan="1">domain-name</td><td colspan="1" rowspan="1">String</td><td colspan="1" rowspan="1">Required</td><td colspan="1" rowspan="1">The domain name for which the Order Id is to be fetched.</td></tr></tbody></table>
<h2>HTTP Method</h2>
<p>GET</p>
<h2>Example Test URL Request</h2>
<p><code><br>  https://test.httpapi.com/api/webservices/orderid.json?auth-userid=0&amp;api-key=key&amp;domain-name=domainname.asia<br> </code></p>
<h2>Response</h2>
<p>Returns the associated Web Services<strong> Order Id </strong>of the domain name.</p>
</div>
</div>
</div>
</div>
<div class="mychild-topics"> </div>
</div>
<div class="seedetailssection"> </div>

When you want to retrieve the Web Services order ID associated with a domain name. This article explains the required parameters and API request format for fetching the associated Web Services order ID.

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.