Order report

  4 minute read  

GET https://www.digicert.com/services/v2/report/order?limit=3
Use this endpoint to get a CSV of all certificate orders.

Example requests and responses

curl -X GET \
  'https://www.digicert.com/services/v2/report/order?limit=3' \
  -H 'X-DC-DEVKEY: {{api_key}}'
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)
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))

}
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);
});

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.

NameReq/OptTypeDescription
filters[{{property_name}}]optionalstringFilters 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:
limitoptionalintTotal number of results to include in the response.
Max:
100,000
Default:
50,000
offsetoptionalintIndex of the first result to include in the response.
Default:
0

Response CSV columns

NameDescription
order_idOrder ID.
customer_order_idCustomer order ID.
date_createdDate the order was placed.
Format:
yyyy-MM-dd HH:mm:ss
container_idContainer ID of the order.
container_nameContainer name of the order.
statusOrder status.
Possible values: Returns pending, issued, rejected, revoked, waiting_pickup, reissue_pending, or canceled.
user_idID of the user that placed the order.
organization_idOrganization ID associated with the order.
organization_nameOrganization name.
organization_address_1Organization address.
organization_address_2
organization_cityCity where the organization is located.
organization_stateState where the organization is located.
organization_countryCountry where the organization is located.
organization_unitOrganization units on the certificate.
tech_first_nameTechnical contact first name.
tech_last_nameTechnical contact last name.
tech_emailTechnical contact email address.
tech_titleTechnical contact title.
tech_telephoneTechnical contact telephone number.
server_typeServer platform ID. See Glossary – Server platforms.
issuing_caIssuing certificate authority.
agreement_idID of the CSA agreed to.
validity_yearsNumber of years the certificate is valid.
signature_hashSignature hash used to sign the certificate request.
dcv_methodDomain control validation method configured for the domain. See Glossary – DCV methods.
common_nameName secured by the certificate.
plus_featureSpecifies if plus feature is enabled for the order.
Possible values: 0 (disabled), 1 (enabled)
dns_namesList of additional names secured by the certificate.
number_of_sansNumber of SANs secured by the certificate
server_licensesNumber of server licenses included with the certificate
product_idID of the product.
product_name_idName ID of the product. See Glossary – Product identifiers.
product_nameDisplay name of the product. See Glossary – Product identifiers.
product_typeProduct type. See Glossary – Product types.
emailIf applicable, email address on the certificate.
csrCertificate signing request (CSR).
valid_fromDate when certificate validity starts.
Format:
yyyy-MM-dd
valid_tillDate when certificate validity ends.
Format:
yyyy-MM-dd
certificate_tracker_idCertificate ID.
is_renewedSpecifies if the order has been renewed.
Possible values: 0 (false), 1 (true)
renewed_order_idOrder ID of the previous order. Returned only if order is a renewal.
receipt_idReceipt ID.
disable_issuance_emailSpecifies if issuance emails are sent.
Possible values: 0 (false), 1 (true)
pay_typePayment method used for the order.
Possible values: A (account balance), C (credit card), U (units)
is_out_of_contractContract status of the order.
Possible values: 0 (false), 1 (true)
disable_renewal_notificationsSpecifies if renew notifications are enabled.
Possible values: 0 (false), 1 (true)
additional_emailsAdditional email addresses on the order.
auto_renewSpecify if the certificate should automatically renew.
Possible values: 0 (disabled), 1 (enabled)
custom_renewal_messageCustom message included in renewal notifications.
thumbprintThumbprint of the certificate.
serial_numberSerial number of the certificate.
account_idAccount ID associated with the order.
user_first_nameFirst name of user that requested the certificate.
user_last_nameLast name of user that requested the certificate.
user_emailEmail address of user that requested the certificate.
user_assignmentsID of the user assigned to the order.
costOrder cost.
Possible values: $ based, unit based
metadataCustom field details.
Format:
{{metadata_id}}
{{metadata_label}}
{{metadata_value}}
Data separator:
0x1f
has_duplicatesSpecifies if the certificate has duplicates.
Possible values: 0 (false), 1 (true)