# 5 Retrieving SSL Orders

##### *This is a series of articles dedicated to demonstrating how to get acquainted with [Openprovider SSL API methods](https://support.openprovider.eu/hc/en-us/sections/360004444873-SSL-API-Guides). If you want to go the beginning of this guide, please navigate to the article "[1 How to choose a product](https://openprovider.help/books/api-plugins/page/1-choosing-a-product)".*

*To get more information about our API in general, please [use our documentation portal](https://docs.openprovider.com/doc/all#operation/ListOrders) as your reference.*

<div id="bkmrk-using-the-previous%C2%A0m"><div>  
</div><div>Using the previous method "[4 Creating SSL Order](https://openprovider.help/books/api-plugins/page/4-creating-ssl-order)" we created an order with the ID assigned: "1".</div></div><div id="bkmrk-using-the-current-me">Using the current method we will retrieve all orders that are assigned with our reseller's account.  
You can retrieve a full list of certificates you have in a system, either active or not, that have specific handle assigned or (and) by name pattern.  
To get orders statuses updates immediately we would recommend you to use our [webhook system](https://dev-docs.op-staging.net/books/ssl-certificates/page/setting-up-ssl-webhook-notifications)[.](https://support.openprovider.eu/hc/en-us/articles/115015751808-Webhooks-for-SSL-events%7C)  
Please check input values below.</div><div id="bkmrk-use-endpoint-path-be"><div>![Entering Geo Fence icon](https://openprovider.help/uploads/images/gallery/2026-08/embedded-image-cbf3yt2v.png)Use endpoint path below. Base URL is determined by both the target environment and API version.</div><div>  
</div></div>```
<strong>GET <a href="https://docs.openprovider.com/doc/all#operation/ListOrders">{base_url}</a></strong>/ssl/orders
```

<div id="bkmrk-request-values-name-"><div id="bkmrk-request-values-name--1"><details><summary>REQUEST VALUES</summary>

<div><table><tbody><tr><th>### **Name**

</th><th>### **Type**

</th><th>### **Values**

</th><th>### **Description**

</th></tr><tr><td> limit</td><td> integer</td><td> Min 0, Max 1000.</td><td> A number of records that will be returned in the output.</td></tr><tr><td> offset</td><td> integer</td><td> Min 0, Max ♾️.</td><td> The argument is used to identify the starting point to return records.</td></tr><tr><td> order\_by.\[parameter\]

parameter:

\- common\_name

\- order\_date

\- status

\- active\_date

\- expiration\_date

\- product\_name

</td><td> string</td><td> asc/desc</td><td>Sorting order.</td></tr><tr><td> common\_name\_pattern</td><td> string</td><td> domain name pattern</td><td>The pattern of domain common name.</td></tr><tr><td> status</td><td> string</td><td> [ACT, PAI, REQ, REJ, FAI, EXP](https://openprovider.help/books/api-plugins/page/api-guides-glossary#order_status_list)</td><td>Current order status. </td></tr><tr><td> contact\_handle</td><td> string</td><td> One of the resellers handles (contacts).</td><td>Openprovider contact of the person assigned to an order  
(e.g. XY123456-ZW).</td></tr></tbody></table>

  
</div></details><details><summary>REQUEST EXAMPLE</summary>

```
curl -X GET \<br></br> 'https://api.openprovider.eu/v1beta/ssl/orders?status=PAI&order_by.order_date=asc' \<br></br> -H 'Authorization: Bearer ae460da9a7069714b32e29231a6a392c' \<br></br> -H 'Content-Type: application/json' \
```

</details><details><summary>RESPONSE EXAMPLE</summary>

```
{<br></br> "code": 0,<br></br> "data": {<br></br> "results": [<br></br> {<br></br> "active_date": "2019-01-01 00:00:01",<br></br> "additional_data": [<br></br> {<br></br> "dns_record": "ssl-123-domain.com",<br></br> "dns_value": "0453ff12343c6d5e24466832668aa13658e5893c917b9486d7c59a57270<br></br>  74c9c",<br></br> "domain": "ssl-123-domain.com",<br></br> "file_contents": "0453ff12343c6d5e24466832668aa13658e5893c917b9486d7c59a5<br></br>  727074c9c",<br></br> "file_location": "ssl-123-domain.com/.well-known/pki-validation<br></br>  /fileauth.txt",<br></br> "md5": "73d01a1232214f96ebf08d6f9d0af6f9",<br></br> "sha1": "0453ff12343c6d5e24466832668aa13658e5893c917b9486d7c59a5727074c9c",<br></br> "sha256": "0453ff12343c6d5e24466832668aa13658e5893c917b9486d7c59a5727074c9<br></br>  c"<br></br> }<br></br> ],<br></br> "administrative_handle": "<a href="https://openprovider.help/books/api-plugins/page/api-guides-glossary#handle">IA900531-NL</a>",<br></br> "autorenew": "off",<br></br> "billing_handle": "<a href="https://openprovider.help/books/api-plugins/page/api-guides-glossary#handle">IA900531-NL</a>",<br></br> "brand_name": "<a href="https://openprovider.help/books/api-plugins/page/appendix-openprovider-products-id">RapidSSL</a>",<br></br> "certificate": "",<br></br> "common_name": "ssl-123-domain.com",<br></br> "csr": "-----BEGIN CERTIFICATE REQUEST-----<br></br>MIIDNzCCAh8CAQAwgaUxCzAJBgNVBAYTAk5MMRYwFAYDVQQIEw1Ob29yZC1Ib2xs<br></br>YW5kMQ8wDQYDVQQHEwZIYWFsZW0xGjAYBgNVBAoTEU9wZW5wcm92aWRlciBCLlYu<br></br>MQswCQYDVQQLEwJJVDEbMBkGA1UEAxMSc3NsLTEyMy1kb21haW4uY29tMScwJQYJ<br></br>KoZIhvcNAQkBFhhhZG1pbkBzc2wtMTIzLWRvbWFpbi5jb20wggEiMA0GCSqGSIb3<br></br>DQEBAQUAA4IBDwAwggEKAoIBAQD4t7KW7vJ8Zjw9xZMo1iU4ez7pdPPglmSNNRAk<br></br>iJXzTda9cIYPjwxduUR7A8EsgxFT/jQ99Gmjyq85liSX45z88eT5a7f84alEfCui<br></br>MzZh9DUK6Y8nigATFnjOohJhkEXXay8K0fY7/DXD6dSqJYJkhqULedsvB64ofip0<br></br>0ab8PlgOkdphcLUxKOGcpt8xWpzgKpMTJJnmRVkI7rkikYAU7BWxtJ5tcg/lEFcl<br></br>ruh/WUxeBH6qJMZ5xHZ2Z1EWLjiVGb6Mw+sYBUky4WDX9xefv2wl48dEA3opWR9e<br></br>vTL/8Omo7xDk3vN4nEOAl9cT8gidVHuA+YOLMczLLrhP8LRPAgMBAAGgTDBKBgkq<br></br>hkiG9w0BCQ4xPTA7MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgXgMCEGA1UdEQQaMBiC<br></br>Fnd3dy5zc2wtMTIzLWRvbWFpbi5jb20wDQYJKoZIhvcNAQELBQADggEBAJVyt+D8<br></br>BDxcQhuT4kOd8A2u0a+T0PAXX7uJcu1AkJr1gMS6tym118nmjXLilgSsL3IarRq2<br></br>1taUMoxlyZuXe38IztCBuUxpKiZz6Ltx5yUrQZaFNNOVsHNjXHe5oajVA1f7dmoI<br></br>Ia3E/fpeHpoPzbWdTv1bfMHuAfHIRqVuTHG78T4fJh4JFXfyHfVbLUN5wc9D7oPo<br></br>amGOFSUZoY/HLwfGf1zJMqsF9HEreCVmhWGoIHknzKbIhe7sngzR1We3aafNAUOd<br></br>Q3gov4okpEI8yurKRrGSSo1ZzWqiIew5qEkm6gNGAwVWYgZ0kgadXjJQEBdx6deZ<br></br>4eJiaV7IwubPS78=<br></br>-----END CERTIFICATE REQUEST-----",<br></br> "domain_validation_methods": [<br></br> {<br></br> "host_name": "ssl-123-domain.com",<br></br> "method": "email"<br></br> }<br></br> ],<br></br> "domain_validation_statuses": {<br></br> "ca_operation": "request",<br></br> "ca_order_status": "in_progress",<br></br> "ca_status": "requested",<br></br> "status": "open"<br></br> },<br></br> "email_approver": "admin@ssl-123-domain.com",<br></br> "email_reissue": "admin@ssl-123-domain.com",<br></br> "expiration_date": "2020-01-01 00:00:01",<br></br> "features": "",<br></br> "host_names": [<br></br> "www.ssl-123-domain.com"<br></br> ],<br></br> "id": 1306772,<br></br> "intermediate_certificate": "",<br></br> "options": {<br></br> "features": ""<br></br> },<br></br> "order_date": "2019-01-01 00:00:01",<br></br> "organization_handle": "TH000001-NL",<br></br> "period": 1,<br></br> "product_id": 5,<br></br> "product_name": "<a href="https://openprovider.help/books/api-plugins/page/appendix-openprovider-products-id">RapidSSL</a>",<br></br> "root_certificate": "",<br></br> "software": "linux",<br></br> "sslinhva_order_id": "11111111-1111-1111-1111-111111111111",<br></br> "status": "REQ",<br></br> "technical_handle": "<a href="https://openprovider.help/books/api-plugins/page/api-guides-glossary#handle">IA900531-NL</a>",<br></br> "validation_method": "domain",<br></br> "vendor_order_id": 123456789,<br></br> "vendor_reference_id": 123456789<br></br> }<br></br> ],<br></br> "total": 10<br></br> },<br></br> "desc": ""<br></br>}
```

</details><details><summary>RESPONSE VALUES</summary>

<div><table><tbody><tr><th>### **Name**

</th><th>### **Values**

</th><th>### **Description**

</th></tr><tr><td>code

</td><td>Result code number.

</td><td>[API Result with code returned](https://openprovider.help/books/api-plugins/page/api-error-codes).  
0 = Success with no errors.

</td></tr><tr><td>**1. data**

</td><td>**SSL Orders list data.**</td><td>**Returns results with all required data.**</td></tr><tr><td>**1.1 results**</td><td>**An array of results.** </td><td>**Returns order(s) data.** </td></tr><tr><td>1.1.1 active data

</td><td>Date value with date stamp.</td><td>Date of order creation.</td></tr><tr><td>**1.1.2 additional data**</td><td>**Array with additional data.**</td><td>**Useful information with validation values that should be added, file locations, etc.**</td></tr><tr><td>1.1.1.2.1 [dns\_record](https://openprovider.help/books/api-plugins/page/api-guides-glossary#dns_record)</td><td>[DNS record](https://openprovider.help/books/api-plugins/page/api-guides-glossary#dns_record).</td><td>[DNS record](https://openprovider.help/books/api-plugins/page/api-guides-glossary#dns_record) should be added to host.</td></tr><tr><td>1.1.1.2.2 dns\_value</td><td>DNS values.</td><td>DNS values that should be added to host to process validation  
(e.g. random text string).</td></tr><tr><td>1.1.1.2.3 domain</td><td>Domain name as a string.</td><td>Domain hostname with what certificate is assigned with.</td></tr><tr><td>1.1.1.2.4 file\_contents</td><td>File contents as a string.</td><td>File contents that should be added to the host (an e.g. random string of text).</td></tr><tr><td>1.1.1.2.5 file\_location</td><td>File location as a string.</td><td>Indicates a location where the file should be added into an existing host.</td></tr><tr><td>1.1.1.2.6 [md5](https://openprovider.help/books/api-plugins/page/api-guides-glossary#md5)</td><td>MD5 checksum.</td><td>Order MD5 checksum.</td></tr><tr><td>1.1.1.2.7 [sha1](https://openprovider.help/books/api-plugins/page/api-guides-glossary#sha1)</td><td>SHA1 checksum.</td><td>Order [SHA1](https://openprovider.help/books/api-plugins/page/api-guides-glossary#sha1) checksum.</td></tr><tr><td>1.1.1.2.8 [sha256](https://openprovider.help/books/api-plugins/page/api-guides-glossary#sha2)</td><td>SHA256 checksum.</td><td>Order [SHA256](https://openprovider.help/books/api-plugins/page/api-guides-glossary#sha2) checksum. </td></tr><tr><td>1.1.2 administrative\_[handle](https://openprovider.help/books/api-plugins/page/api-guides-glossary#handle)</td><td>Openprovider [handle](https://openprovider.help/books/api-plugins/page/api-guides-glossary#handle).</td><td>Administrative [handle](https://openprovider.help/books/api-plugins/page/api-guides-glossary#handle).</td></tr><tr><td>1.1.3 autorenew</td><td>"On" or "Off"</td><td>If autorenew is enabled or not.</td></tr><tr><td>1.1.4 billing\_[handle](https://openprovider.help/books/api-plugins/page/api-guides-glossary#handle)</td><td>Openprovider billing [handle](https://openprovider.help/books/api-plugins/page/api-guides-glossary#handle).</td><td>Openprovider [handle](https://openprovider.help/books/api-plugins/page/api-guides-glossary#handle).</td></tr><tr><td>1.1.5 brand\_name</td><td>Certificate brand name (manufacturer).</td><td>Manufacturer string  
(e.g. Comodo or Symantec).</td></tr><tr><td>1.1.6 certificate</td><td>Certificate value (string).</td><td>Value of certificate.</td></tr><tr><td>1.1.7 common\_name</td><td>Domain common name.</td><td>Domain value (e.g. example.com).</td></tr><tr><td>1.1.8 [csr](https://openprovider.help/books/api-plugins/page/api-guides-glossary#csr)</td><td>[CSR](https://openprovider.help/books/api-plugins/page/api-guides-glossary#csr) value.</td><td>[CSR](https://openprovider.help/books/api-plugins/page/api-guides-glossary#csr) value returned.</td></tr><tr><td>**1.2 domain\_validation\_methods**</td><td>**An array of SSL Order Domain Validation Methods**</td></tr><tr><td>1.2.1 host\_name</td><td>Domain name.</td><td>The hostname of the domain in [Openprovider order](https://openprovider.help/books/api-plugins/page/api-guides-glossary#op_order_id).</td></tr><tr><td>1.2.2 method</td><td>Validation method value. </td><td>Validation method value (e.g. "https").</td></tr><tr><td>**1.3 domain\_validation\_statuses**</td><td>**Set of values returned.** </td><td>**Set of values related to the validation status of your order.** </td></tr><tr><td>1.3.1 [ca](https://openprovider.help/books/api-plugins/page/api-guides-glossary#ca)\_operation</td><td>Returns operation performed in [CA](https://openprovider.help/books/api-plugins/page/api-guides-glossary#ca).  
(e.g. "request").</td></tr><tr><td>1.3.2 [ca](https://openprovider.help/books/api-plugins/page/api-guides-glossary#ca)\_order\_status</td><td>[Certificate Authority](https://openprovider.help/books/api-plugins/page/api-guides-glossary#ca) order status.</td><td>Current order status (e.g. "in\_progress").</td></tr><tr><td> 1.3.3 ca\_status</td><td>Certificate Authority order operation status.</td><td>Current status of order operation processing inside [CA](https://openprovider.help/books/api-plugins/page/api-guides-glossary#ca).  
(e.g. "requested").

</td></tr><tr><td>1.3.4 status</td><td>The string value of current status.</td><td>Current order status (closed or open).</td></tr><tr><td><span class="param-name-content">1.4 email\_approver</span>

</td><td>Email address value. </td><td>Email value of approver email.</td></tr><tr><td>1.5 email\_reissue</td><td>Email address value.</td><td>Email value of email reissue approver.</td></tr><tr><td>1.6 expiration\_date</td><td>Date of order expiration.</td><td>Certificate expiration date  
(date stamp format).</td></tr><tr><td>1.7 features</td><td>Product features.</td><td>Indicates product features (if presented).</td></tr><tr><td>1.8 host\_names</td><td>An array of strings.</td><td>Host names.</td></tr><tr><td>1.9 id</td><td>Numberic value or [Openprovider order ID](https://openprovider.help/books/api-plugins/page/api-guides-glossary#op_order_id).</td><td>E.g. 1306772.</td></tr><tr><td>1.10 [intermediate\_certificate](https://openprovider.help/books/api-plugins/page/api-guides-glossary#intermediate_certificate)</td><td>[Intermediate certificate](https://openprovider.help/books/api-plugins/page/api-guides-glossary#intermediate_certificate) value as a string.</td><td>An [intermediate certificate](https://openprovider.help/books/api-plugins/page/api-guides-glossary#intermediate_certificate) is a certificate that used between the root and end-user certificate.</td></tr><tr><td>**1.11 options** </td><td>**SSL Order options.**</td></tr><tr><td>1.11.1 features</td><td>Features of the certificate.</td><td>The certificate features an optional parameter (if presented).</td></tr><tr><td>1.12 order\_date</td><td>Date of order creation.</td><td>Indicates timestamp when the order was created.</td></tr><tr><td>1.13 organization\_[handle](https://openprovider.help/books/api-plugins/page/api-guides-glossary#handle)</td><td>Contact ([handle](https://openprovider.help/books/api-plugins/page/api-guides-glossary#handle)) value from the reseller account.</td><td>Openprovider internal technical contact ([handle](https://openprovider.help/books/api-plugins/page/api-guides-glossary#handle)).</td></tr><tr><td>1.14 period</td><td>Period of a lifetime in years.</td><td>1 or 2 years.</td></tr><tr><td>1.15 [product\_id](https://openprovider.help/books/api-plugins/page/appendix-openprovider-products-id)</td><td>[Openprovider product ID](https://openprovider.help/books/api-plugins/page/appendix-openprovider-products-id). </td><td>Indicates the [product](https://openprovider.help/books/api-plugins/page/appendix-openprovider-products-id) ID used.</td></tr><tr><td>1.16 product\_name </td><td>SSL Product name.</td><td>Product name (e.g. RapidSSL).</td></tr><tr><td>1.17 [root\_certificate](https://openprovider.help/books/api-plugins/page/api-guides-glossary#root_certificate)</td><td>[Root certificate](https://openprovider.help/books/api-plugins/page/api-guides-glossary#root_certificate) string.</td><td>Value of [root certificate](https://openprovider.help/books/api-plugins/page/api-guides-glossary#root_certificate) as a string.</td></tr><tr><td>1.18 software</td><td>Windows or Linux.</td><td>Software used for server:  
e.g. Windows or Linux.</td></tr><tr><td>1.19 sslinhva\_order\_id</td><td>Internal Openprovider value.</td><td>Internal system Openprovider value of order.</td></tr><tr><td>1.20 status</td><td>[ACT, PAI, REQ, REJ, FAI, EXP](https://openprovider.help/books/api-plugins/page/api-guides-glossary#order_status_list)</td><td>Current order status.  
(e.g. ACT=active, PAI=purchased but not requested, REQ=requested but under internal validation, REJ=cancel operation requested for an order, FAI=order cancelled, EXP=expired order).

</td></tr><tr><td>1.21 technical\_[handle](https://openprovider.help/books/api-plugins/page/api-guides-glossary#handle)</td><td>Openprovider internal technical [handle](https://openprovider.help/books/api-plugins/page/api-guides-glossary#handle) (contact).</td><td>[Handle](https://openprovider.help/books/api-plugins/page/api-guides-glossary#handle) (contact) internal system value  
(e.g. "e.g. XY123456-ZW").</td></tr><tr><td>1.22 validation\_method</td><td>Value as a string.</td><td>Validation method (e.g. "domain").</td></tr><tr><td>1.23 vendor\_order\_id </td><td>Numeric value of internal order ID. </td><td>Internal vendor order ID (e.g. "123456789"). </td></tr><tr><td>1.24 vendor\_reference\_id</td><td>Numeric value of interbal vendor ID.</td><td>Internal vendor order ID (e.g. "123456789").</td></tr><tr><td>2. total</td><td>Numeric value of total results stored in system.</td><td>Numeric value returned.</td></tr><tr><td>desc</td><td>Description value as a string.</td><td>Description text returned (if presented).</td></tr><tr><td>maintenance</td><td>True or False.</td><td>The maintenance: True or False.</td></tr><tr><td>**warnings** </td><td>**An array of warning messages.**</td><td>****An array of boolean and string data returned** if Openprovider is under maintenance mode.**</td></tr><tr><td>2.1 code</td><td>Code digits.</td><td>Code value (digits).</td></tr><tr><td>2.2 data</td><td>Data values.</td><td>Data value returned.</td></tr><tr><td>2.3 desc</td><td>Description value.</td><td>Description value returned.</td></tr></tbody></table>

</div></details></div></div>**After we returned SSL Orders with details we can also [check a single exact order you want.](https://docs.openprovider.com/doc/all#operation/GetOrder)  
The next method we would be referring to is "[6 Updating SSL Order](https://openprovider.help/books/api-plugins/page/6-updating-ssl-order)" - that will help us to change some details of not yet active order.**