Knowledge Base
Categories: SSL Certificates API
Search SSL Certificate Orders Using the API
When you want to search SSL Certificate orders using the API. This article explains available search filters, sorting options, pagination parameters, order status filters, and response details for matching SSL Certificate orders.
Description
Gets a list of SSL Certificate orders matching the search criteria, along with the details.
Parameters
| Name | Data Type | Required / Optional | Description |
|---|---|---|---|
| auth-userid | Integer | Required | Authentication Parameter |
| api-key | String | Required | Authentication Parameter |
| no-of-records | Integer | Required | Number of orders to be fetched. This should be a value between 10 to 500. |
| page-no | Integer | Required | Page number for which details are to be fetched. |
| order-id | Array of Integers | Optional | Order ID(s) of the SSL Certificate Order(s) whose details need to be fetched |
| reseller-id | Array of Integers | Optional | Reseller Id(s) of the Reseller(s) whose Orders need to be fetched |
| customer-id | Array of Integers | Optional | Customer Id(s) of the Customer(s) whose Orders need to be fetched |
| show-child-orders | Boolean | Optional | Fetch Sub-Reseller's orders as well |
| status | Array of Strings | Optional | Active, Deleted etc. |
| domain-name | String | Optional | Domain name associated with the SSL Certificate Order |
| creation-date-start | String | Optional | UNIX TimeStamp for listing of SSL Certificate orders whose creation date is greater than creation-date-start. |
| creation-date-end | String | Optional | UNIX TimeStamp for listing of SSL Certificate orders whose creation date is less than creation-date-end. |
| expiry-date-start | String | Optional | UNIX TimeStamp for listing of SSL Certificate orders whose expiry date is greater than expiry-date-start. |
| expiry-date-end | String | Optional | UNIX TimeStamp for listing of SSL certificate orders whose expiry date is less than expiry-date-end. |
| order-by | Array of Strings | Optional | One or more parameters by which you want to sort the Orders. Default is orderid.
Example: If page-no is 1, no-of-records is 30 and order-by is orderid; it will fetch the first 30 Orders which suit the search criteria sorted by orderid. If page-no is 2, no-of-records is 30 and order-by is orderid; it will fetch the second batch of 30 Orders sorted by orderid. |
HTTP Method
GET
Example Test URL Request
https://test.httpapi.com/api/sslcert/search.json?auth-userid=0&api-key=key&order-id=0&reseller-id=1&customer-id=1&show-child-orders=true&status=active&domain-name=yourdomain.com&creation-date-start=1415463675&creation-date-end=12345678&expiry-date-start=109678457&expiry-date-end=98765432&no-of-records=1&page-no=2&order-by=reseller-id
Response
Returns the details of the SSL Certificate orders which match the search criteria.
Did you find this article helpful?