Title: Get the Order ID of a Google Workspace Order Using the API  
PrimaryCategory: Google Workspace  
Type: Procedural  
Tags: google workspace, api, order id, authentication, domain name  
Source UI Terms: None  
Source Reference: Get the Order ID of a Google Workspace Order Using the API  

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

Steps:  
1) Use the HTTP GET method to send a request to the appropriate API endpoint based on your region:  
   - For India, use: `https://test.httpapi.com/api/gapps/in/orderid.json?auth-userid=YOUR_USERID&amp;api-key=YOUR_APIKEY&amp;domain-name=YOUR_DOMAIN`  
   - For South East Asia &amp; Egypt, use: `https://test.httpapi.com/api/gapps/se/orderid.json?auth-userid=YOUR_USERID&amp;api-key=YOUR_APIKEY&amp;domain-name=YOUR_DOMAIN`  
   - For Rest of the World, use: `https://test.httpapi.com/api/gapps/gbl/orderid.json?auth-userid=YOUR_USERID&amp;api-key=YOUR_APIKEY&amp;domain-name=YOUR_DOMAIN`  
2) Replace `YOUR_USERID`, `YOUR_APIKEY`, and `YOUR_DOMAIN` with your actual authentication details and domain name.  
3) Submit the GET request.  
4) Receive the response containing the Order ID associated with the specified domain.  

Summary:  
You can retrieve the Google Workspace Order ID for a domain by sending a GET request with your authentication parameters and the domain name to the appropriate endpoint for your region.  

Evaluation Pairs:  
Q: What parameters are required to get the Google Workspace Order ID using the API?  
A: You need the authentication parameters auth-userid (integer) and api-key (string), plus the domain-name (string) for which the Order ID is requested.  

Q: Which HTTP method is used to retrieve the Google Workspace Order ID via the API?  
A: The GET method is used.  

Q: How do I choose the correct API URL endpoint for my region?  
A: Use the &quot;in&quot; endpoint for India, the &quot;se&quot; endpoint for South East Asia and Egypt, and the &quot;gbl&quot; endpoint for the rest of the world. Replace auth-userid, api-key, and domain-name accordingly in the URL.

<p>When you want to retrieve the associated Google Workspace order ID using the API. This article explains the required authentication parameters, domain name input, and order ID response information.</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">Get Order Id</span></h1>
<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>Description</h2>
<p>Gets the associated Google Workspace <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><strong>India</strong></p>
<p><code>https://test.httpapi.com/api/gapps/in/orderid.json?auth-userid=0&amp;api-key=key&amp;domain-name=domainname.com </code></p>
<p><strong>South East Asia &amp; Egypt</strong></p>
<p><code>https://test.httpapi.com/api/gapps/se/orderid.json?auth-userid=0&amp;api-key=key&amp;domain-name=domainname.com </code></p>
<p><strong>Rest of the World</strong></p>
<p><code>https://test.httpapi.com/api/gapps/gbl/orderid.json?auth-userid=0&amp;api-key=key&amp;domain-name=domainname.com </code></p>
<h2>Response</h2>
<p>Returns the <strong>Order Id</strong>  associated with the specific domain name.</p>
</div>
</div>
</div>
</div>
<div class="mychild-topics"> </div>
</div>
<div class="seedetailssection"> </div>

When you want to retrieve the associated Google Workspace order ID using the API. This article explains the required authentication parameters, domain name input, and order ID response information.

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.