Title: Delete a SiteLock Order Using the API
PrimaryCategory: SiteLock
Type: Procedural
Tags: SiteLock, API, delete order, order management, authentication
Source UI Terms: auth-userid, api-key, order-id
Source Reference: Delete a SiteLock Order Using the API

Prerequisites:
- You must have valid API credentials (auth-userid and api-key).
- You must know the order ID of the SiteLock order you want to delete.

Steps:
1) Prepare a POST request to the SiteLock API endpoint for deleting orders.
2) Include the following required parameters in the request query string or body:
   - auth-userid: Your integer authentication user ID.
   - api-key: Your API key as a string.
   - order-id: The integer order ID of the SiteLock order to delete.
3) Send the POST request to the URL:  
   `https://test.httpapi.com/api/sitelock/delete.json?auth-userid=&amp;api-key=ℴ-id=`
4) Review the response which returns a hash map detailing:
   - Domain Name (description)
   - Order ID of the SiteLock order (entityid)
   - Action Type (actiontype)
   - Description of the delete action (actiontypedesc)
   - Action ID (eaqid)
   - Action status (actionstatus)
   - Description of action status (actionstatusdesc)
5) If an error occurs, the response includes a status key with value &quot;ERROR&quot; and an error message.

Warnings:
- Ensure you use the POST HTTP method, as other methods may not work.
- Deleting an order is irreversible; confirm the order ID before proceeding.

Summary:
This article explains how to delete an existing SiteLock order using the API by sending a POST request with required authentication and order ID parameters and interpreting the response.

Evaluation Pairs:
Q: What parameters are required to delete a SiteLock order using the API?  
A: The required parameters are auth-userid (integer), api-key (string), and order-id (integer).

Q: What HTTP method should be used to delete a SiteLock order via the API?  
A: Use the POST HTTP method.

Q: What will the API response include after a successful deletion request?  
A: It will include details such as domain name, order ID, action type and description, action ID, action status, and status description.

<p>When you want to delete an existing SiteLock order using the API. This article explains the required parameters and example API request to delete the order.</p>
<div class="region region-content">
<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">Delete</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><a name="heading_0"></a>Description</h2>
<p>Deletes an existing SiteLock 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">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">order-id</td><td colspan="1" rowspan="1">Integer</td><td colspan="1" rowspan="1">Required</td><td colspan="1" rowspan="1">The Order ID which is to be deleted</td></tr></tbody></table>
<h2><a name="heading_2"></a>HTTP Method</h2>
<p>POST</p>
<h2><a name="heading_3"></a>Example Test URL Request</h2>
<p><code>https://test.httpapi.com/api/sitelock/delete.json?auth-userid=0&amp;api-key=key&amp;order-id=0 </code></p>
<h2><a name="heading_4"></a>Response</h2>
<p>Returns a hash map containing the below details:</p>
<ul><li>
<p>Domain Name (description)</p>
</li><li>
<p>Order ID of the SiteLock Order (entityid)</p>
</li><li>
<p>Action Type (actiontype)</p>
</li><li>
<p>Description of the SiteLock Order Delete Action (actiontypedesc)</p>
</li><li>
<p>Action ID of the SiteLock Order Delete Action (eaqid)</p>
</li><li>
<p>SiteLock Order Delete Action Status (actionstatus)</p>
</li><li>
<p>Description of the SiteLock Order Delete Action Status (actionstatusdesc)</p>
</li></ul>
<p>In case of any errors, a <strong>status</strong> key with value as <em>ERROR</em> alongwith an error message will be returned.</p>
</div>
</div>
</div>
</div>
<div class="mychild-topics"> </div>
</div>
<div class="seedetailssection"> </div>

When you want to delete an existing SiteLock order using the API. This article explains the required parameters and example API request to delete the order.

Name	Data Type	Required / Optional	Description
auth-userid	Integer	Required	Authentication Parameter
api-key	String	Required	Authentication Parameter
order-id	Integer	Required	The Order ID which is to be deleted