1. Introduction
  2. Order Management
  3. Sample Code
  4. Errors and Troubleshooting
  5. Appendix
  6. Print-Friendly Documentation

Order Management - View Order Details

Once the certificate order has been created, periodically view the order details to check the order status.

This endpoint will return an Etag header that can be used on subsequent calls. If nothing has changed, a 304 response will be returned.

Request Endpoint

MethodURL
GEThttps://api.digicert.com/order/{order_id}

Response

Parameter NameData TypeDescription
certificate_details[collection]Container for certificate details
order_id[integer]Unique identifier for certificate order.
status[string]Status of order. Usually 'pending issuance' or 'issued'.
product_name[string]Product name of order.
validity[string]Validity Period of order. Usually 1, 2 or 3 Year(s).
is_renewal[boolean]Identifies the order as a renewal or new order. True if order is a renewal, false if order is new.
renewed_order_id[integer]If this order is a renewal of a previous order, returns the previous order's id in this parameter
org_unit[string]The OU field of the certificate.
business_unit[string]The business unit that requested the certificate
common_name[string]The Common Name field of the certificate.
sans[collection]A collection that contains one or more SANs, (if any).
san[string]A Subject Alternative Name (SAN) of the certificate.
order_date[datetime]The date the original certificate was ordered. Format: d M Y. Example: 19 JAN 2012
valid_from[datetime]The start date of the certificate's validity (if issued). Format: d M Y. Example: 19 JAN 2012
valid_till[datetime]The end date of the certificate's validity (if issued). Format: d M Y. Example: 19 JAN 2013
server_type[string]The server software type of the order.
server_type_name[string]Name of the server software type of the order.
site_seal_token[string]Eight-character site seal token.
pending_reissue[collection]If there is a pending reissue, this section will be populated.
common_name[string]The Common Name in the current pending reissue.
sans[collection]A collection that contains one or more SANs, (if any).
san[string]A Subject Alternative Name (SAN) of the pending reissue.
receipt[collection]Once the certificate has been issued, a receipt is generated
order_total[float]The total paid for the order

Sample Request

Endpoint

https://api.digicert.com/order/222307

Headers

Accept: application/vnd.digicert.rest-v1+json
Authorization: Basic MDAxMDA3OnNreWZhbGw=
User-Agent: MyAPIConsumer/0.42

Body

None

Sample Response

Note that with this sample request, it would return JSON. Including XML for comparison.

Status Code: 200

Headers

Content-Length: 678
Content-Type: application/vnd.digicert.rest-v1+json
Etag: "eac8e208119b9d690be0e2c6981f3c5e"

Body

JSON (application/vnd.digicert.rest-v1+json)XML (application/vnd.digicert.rest-v1+xml)
{
  "certificate_details":{
    "order_id":"00222307",
    "status":"issued",
    "product_name":"Multi-Domain SSL",
    "validity":"1 Year(s)",
    "is_renewal":"true",
    "renewed_order_id":"00222301",
    "org_unit":"",
    "business_unit":"Some Business Unit",
    "common_name":"www.example.com",
    "sans":[
       "a.example.com"
    ],
    "order_date":"03-FEB-2012",
    "valid_from":"03-FEB-2012",
    "valid_till":"07-FEB-2013",
    "server_type":"2",
    "server_type_name":"Apache"
  },
  "pending_reissue":{
    "common_name":"www.example.com",
    "sans":[
       "a.example.com",
       "b.example.com"
    ]
  },
  "receipt":{
    "order_total":"175.00"
  }
}
<response>
  <certificate_details>
    <order_id>00222307</order_id>
    <product_name>Multi-Domain SSL</product_name>
    <validity>1 Year(s)</validity>
    <is_renewal>true</is_renewal>
    <renewed_order_id>00222301</renewed_order_id>
    <org_unit></org_unit>
    <business_unit>Some Business Unit</business_unit>
      <common_name>www.example.com</common_name>
      <sans>
        <san>a.example.com</san>
      </sans>
      <status>issued</status>
      <order_date>03-FEB-2012</order_date>
      <valid_from>03-FEB-2012</valid_from>
      <valid_till>07-FEB-2013</valid_till>
      <server_type>2</server_type>
      <server_type_name>Apache</server_type_name>
    </certificate_details>
    <pending_reissue>
      <common_name>www.example.com</common_name>
      <sans>
        <san>a.example.com</san>
        <san>b.example.com</san>
      </sans>
    </pending_reissue>
    <receipt>
      <order_total>175.00</order_total>
    </receipt>
</response>