Order report

GET https://www.digicert.com/services/v2/report/order

Use this endpoint to get a CSV of all certificate orders.

Example requests and responses

Example 1. cURL

curl -X GET \
  'https://www.digicert.com/services/v2/report/order?limit=3' \
  -H 'X-DC-DEVKEY: {{api_key}}'

Example 2. Python

import requests

url = "https://www.digicert.com/services/v2/report/order"

querystring = {"limit":"3"}

payload = ""
headers = {'X-DC-DEVKEY': '{{api_key}}'}

response = requests.request("GET", url, data=payload, headers=headers, params=querystring)

print(response.text)

Example 3. Go

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://www.digicert.com/services/v2/report/order?limit=3"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-DC-DEVKEY", "{{api_key}}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example 4. NodeJS

var request = require("request");

var options = { method: 'GET',
  url: 'https://www.digicert.com/services/v2/report/order',
  qs: { limit: '3' },
  headers: { 'X-DC-DEVKEY': '{{api_key}}' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

Example 5. 200 OK

order_id,customer_order_id,date_created,container_id,container_name,status,user_id,organization_id,organization_name,organization_address_1,organization_address_2,organization_city,organization_state,organization_country,organization_unit,tech_first_name,tech_last_name,tech_email,tech_title,tech_telephone,server_type,issuing_ca,agreement_id,validity_years,signature_hash,dcv_method,common_name,plus_feature,dns_names,product_id,product_name_id,product_name,product_type,email,csr,valid_from,valid_till,certificate_tracker_id,is_renewed,renewed_order_id,receipt_id,disable_issuance_email,pay_type,is_out_of_contract,disable_renewal_notifications,additional_emails,auto_renew,custom_renewal_message,thumbprint,serial_number,account_id,user_first_name,user_last_name,user_email,user_assignments,cost,metadata,has_duplicates
"123456","","2018-10-26 10:15:33","112233","Will Smith","issued","123123","221133","Real Organization","123 Fake Street","","Lehi","Utah","us","IT department","Will","Smith","will.smith@example.com","Fresh Prince","8015555555","2","DigiCert Global Root CA","41","2","sha256","","example.com","1","example.com","1","ssl_plus","Standard SSL","ssl_certificate","","-----BEGIN CERTIFICATE REQUEST-----
...
-----END CERTIFICATE REQUEST-----
","2018-10-26","2020-10-30","111113","1","0","54323","0","A","1","0","","0","","123ABC","123ABC","4567890","Will","Smith","will.smith@example.com","123123","","","0"
"123455","","2018-11-16 13:14:26","112233","Will Smith","issued","123123","221133","Real Organization","123 Fake Street","","Lehi","Utah","us","Finance","Will","Smith","will.smith@example.com","Fresh Prince","8015555555","2","DigiCert Global Root CA","41","2","sha256","","example.org","1","example.org","1","ssl_plus","Standard SSL","ssl_certificate","","-----BEGIN CERTIFICATE REQUEST-----
...
-----END CERTIFICATE REQUEST-----
","2018-11-16","2020-11-20","111112","1","0","54322","0","A","1","1","","0","","123ABC","123ABC","4567890","Will","Smith","will.smith@example.com","123123","","","0"
"123454","","2018-11-16 13:19:16","112233","Will Smith","issued","257107","221133","Real Organization","123 Fake Street","","Lehi","Utah","us","Sales","Will","Smith","will.smith@example.com","Fresh Prince","8015555555","2","DigiCert Global Root CA","41","2","sha256","","*.example.org","1","*.example.org","2","ssl_wildcard","WildCard","ssl_certificate","","-----BEGIN CERTIFICATE REQUEST-----
...
-----END CERTIFICATE REQUEST-----
","2018-11-16","2020-11-20","111111","1","0","54321","0","A","1","0","","0","","123ABC","123ABC","4567890","Will","Smith","will.smith@example.com","123123","","","1"

Filters and URL query parameters

This endpoint supports filters and pagination. For general information and examples of the syntax to use when applying filters to the results, see Services API - Filters, sorting, and pagination parameters.

Name	Req/Opt	Type	Description
filters[`{{property_name}}`]	optional	string	Filters results by the specified property. Replace `{{property_name}}` in your request with the property to use for filtering. This endpoint supports filtering by the following properties: `filters[id]` `filters[common_name]` `filters[status]`: Use `pending`, `issued`, `rejected`, `revoked`, `waiting_pickup`, `reissue_pending`, or `canceled`. `filters[date_created]` `filters[valid_till]` `filters[organization_id]` `filters[user_id]` `filters[product_name_id]`: See Glossary – Product identifiers. `filters[is_renewed]`: Use `1` for true or `0` for false. `filters[container_id]`
limit	optional	int	Total number of results to include in the response. Max: `100,000` Default: `50,000`
offset	optional	int	Index of the first result to include in the response. Default: `0`

Name

Req/Opt

Type

Description

filters[{{property_name}}]

optional

string

Filters results by the specified property. Replace {{property_name}} in your request with the property to use for filtering. This endpoint supports filtering by the following properties:

filters[id]
filters[common_name]
filters[status]: Use pending, issued, rejected, revoked, waiting_pickup, reissue_pending, or canceled.
filters[date_created]
filters[valid_till]
filters[organization_id]
filters[user_id]
filters[product_name_id]: See Glossary – Product identifiers.
filters[is_renewed]: Use 1 for true or 0 for false.
filters[container_id]

limit

optional

int

Total number of results to include in the response.

Max: 100,000

Default: 50,000

offset

optional

int

Index of the first result to include in the response.

Default: 0

Response CSV columns

Notice

All column parameter values are wrapped in double quotes (").

Name	Description
order_id	Order ID.
customer_order_id	Customer order ID.
date_created	Date the order was placed. Format: `yyyy-MM-dd HH:mm:ss`
container_id	Container ID of the order.
container_name	Container name of the order.
status	Order status. Possible values: Returns `pending`, `issued`, `rejected`, `revoked`, `waiting_pickup`, `reissue_pending`, or `canceled`.
user_id	ID of the user that placed the order.
organization_id	Organization ID associated with the order.
organization_name	Organization name.
organization_address_1	Organization address.
organization_address_2
organization_city	City where the organization is located.
organization_state	State where the organization is located.
organization_country	Country where the organization is located.
organization_unit	Organization units on the certificate.
tech_first_name	Technical contact first name.
tech_last_name	Technical contact last name.
tech_email	Technical contact email address.
tech_title	Technical contact title.
tech_telephone	Technical contact telephone number.
server_type	Server platform ID. See Glossary – Server platforms.
issuing_ca	Issuing certificate authority.
agreement_id	ID of the CSA agreed to.
validity_years	Number of years the certificate is valid.
signature_hash	Signature hash used to sign the certificate request.
dcv_method	Domain control validation method configured for the domain. See Glossary – DCV methods.
common_name	Name secured by the certificate.
plus_feature	Specifies if plus feature is enabled for the order. Possible values: `0` (disabled), `1` (enabled)
dns_names	List of additional names secured by the certificate.
number_of_sans	Number of SANs secured by the certificate
server_licenses	Number of server licenses included with the certificate
product_id	ID of the product.
product_name_id	Name ID of the product. See Glossary – Product identifiers.
product_name	Display name of the product. See Glossary – Product identifiers.
product_type	Product type. See Glossary – Product types.
email	If applicable, email address on the certificate.
csr	Certificate signing request (CSR).
valid_from	Date when certificate validity starts. Format: `yyyy-MM-dd`
valid_till	Date when certificate validity ends. Format: `yyyy-MM-dd`
certificate_tracker_id	Certificate ID.
is_renewed	Specifies if the order has been renewed. Possible values: `0` (false), `1` (true)
renewed_order_id	Order ID of the previous order. Returned only if order is a renewal.
receipt_id	Receipt ID.
disable_issuance_email	Specifies if issuance emails are sent. Possible values: `0` (false), `1` (true)
pay_type	Payment method used for the order. Possible values: `A` (account balance), `C` (credit card), `U` (units)
is_out_of_contract	Contract status of the order. Possible values: `0` (false), `1` (true)
disable_renewal_notifications	Specifies if renew notifications are enabled. Possible values: `0` (false), `1` (true)
additional_emails	Additional email addresses on the order.
auto_renew	Specify if the certificate should automatically renew. Possible values: `0` (disabled), `1` (enabled)
custom_renewal_message	Custom message included in renewal notifications.
thumbprint	Thumbprint of the certificate.
serial_number	Serial number of the certificate.
account_id	Account ID associated with the order.
user_first_name	First name of user that requested the certificate.
user_last_name	Last name of user that requested the certificate.
user_email	Email address of user that requested the certificate.
user_assignments	ID of the user assigned to the order.
cost	Order cost. Possible values: $ based, unit based
metadata	Custom field details. Format: `{{metadata_id}}` `{{metadata_label}}` `{{metadata_value}}` Data separator: `0x1f`
has_duplicates	Specifies if the certificate has duplicates. Possible values: `0` (false), `1` (true)

In this section: