---
title: "order_details"
source_url: https://dev.digicert.com/certcentral-apis/custom-reports-api/order_details.html
api_method: QUERY
api_endpoint: "/services/v2/reports/query"
api_url: "https://www.digicert.com/services/v2/reports/query"
---

**QUERY** `https://www.digicert.com/services/v2/reports/query`

Use this query to get specific details for all certificate orders.


> **Info**
>
> To get specific details for a single certificate order, use [order_details_by_id query](https://dev.digicert.com/md/certcentral-apis/custom-reports-api/order_details_by_id.md).


## GraphQL

```graphql
{
    order_details(valid_till:"2020-10-26",limit:5,sort:["valid_from","DESC"]) {
        id
        common_name
        dns_names
        organization_id
        status
        valid_from
        valid_till
    }
}
```

## 200 OK

```json
{
    "data": {
        "order_details": [
            {
                "id": "123456",
                "common_name": "digicert.com",
                "dns_names": null,
                "organization_id": "112233",
                "status": "issued",
                "valid_from": "2019-10-04",
                "valid_till": "2020-10-08"
            },
            {
                "id": "123458",
                "common_name": "dev.digicert.com",
                "dns_names": null,
                "organization_id": "223344",
                "status": "issued",
                "valid_from": "2019-10-03",
                "valid_till": "2020-10-07"
            },
            {
                "id": "123443",
                "common_name": "example.com",
                "dns_names": "sub.example.com,www.example.com",
                "organization_id": "112233",
                "status": "revoked",
                "valid_from": "2019-10-02",
                "valid_till": "2020-10-06"
            },
            {
                "id": "123460",
                "common_name": "example.net",
                "dns_names": "www.example.net",
                "organization_id": "112233",
                "status": "issued",
                "valid_from": "2019-09-30",
                "valid_till": "2020-10-07"
            },
            {
                "id": "123424",
                "common_name": "example.org",
                "dns_names": "test.example.org,monitor.example.org,api.example.org",
                "organization_id": "334455",
                "status": "issued",
                "valid_from": "2019-09-27",
                "valid_till": "2020-10-01"
            }
        ]
    }
}
```

## Arguments

Include query arguments to filter, search, or manipulate data. Separate multiple arguments using commas. With the exception of **sort**, all arguments use a *key:value* format (e.g., `status:"issued"`).

### Filters

Use filter arguments to narrow query data to specified parameter values. Multiple filters can be used to further narrow results.

| Name | Req/Opt | Type | Description |
| --- | --- | --- | --- |
| id | optional | int | Order ID. |
| status | optional | string | Order status. See [Glossary – Order status](https://dev.digicert.com/md/certcentral-apis/services-api/glossary.md#order-status). |
| valid_from | optional | string | Date when certificate validity starts.<br>Format:<br> yyyy-MM-dd<br>Operator:<br> >= |
| valid_till | optional | string | Date when certificate validity ends.<br>Format:<br> yyyy-MM-dd<br>Operator:<br> <= |
| container_id | optional | string | Container ID. |
| organization_id | optional | string | Organization ID. |
| product_name_id | optional | string | Name ID of the product. See [Glossary – Product identifiers](https://dev.digicert.com/md/certcentral-apis/services-api/glossary.md). |
| serial_number | optional | string | Serial number of the certificate. |
| signature_hash | optional | string | Signature hash used to sign the certificate request. |
| user_id | optional | string | ID of the user that placed the order. |
| date_created | optional | string | Date the order was placed.<br>Format:<br> yyyy-MM-dd HH:mm:ss<br>Operator:<br> >= |
| ca_cert_id | optional | string | ID of the issuing certificate authority. |
| common_name | optional | string | Name secured by the certificate.<br>Use % for a like operator (e.g., common_name:"%example.com"). |
| dns_names | optional | string | List of additional names secured by the certificate. |
| locale | optional | string | Locale of the order. See [Glossary – Locale codes](https://dev.digicert.com/md/certcentral-apis/services-api/glossary.md#locale-codes). |
| thumbprint | optional | string | Thumbprint of the certificate. |
| email | optional | string | Customer order email. |
{.params-table}

### Search

Use search argument to find a specific string contained in searched fields.

| Name | Req/Opt | Type | Description |
| --- | --- | --- | --- |
| search | optional | string | Search specific fields for included string.<br>Use % for a like operator (e.g., search:"%example.com").<br>Searched fields: id, status, container_id, organization_id, product_name_id, additional_emails, organization_name, product_name, serial_number, user_id, common_name, email |
{.params-table}

### Sort and pagination

Use sort and pagination arguments to manipulate returned query results.

| Name | Req/Opt | Type | Description |
| --- | --- | --- | --- |
| sort | optional | array | Specify sort field and direction.<br>Format:<br> ["{{field}}","{{direction}}"]<br>Allowed values (field): valid_till, container_id, organization_id, product_name_id, serial_number, signature_hash, user_id, date_created, ca_cert_id, common_name, dns_names, locale, thumbprint, email<br>Allowed values (direction): ASC, DESC<br>Default:<br> ["id","DESC"] |
| offset | optional | int | Start list at the specified number for pagination.<br>Default:<br> 0 |
| limit | optional | int | Truncate list to the specified number for pagination.<br>Max: 1000 (default) |
{.params-table}

## Fields


> **Important**
>
> At least one field must be included in the request. If no fields are sent, a syntax error is returned.


> **Info**
>
> If no data exists for the field, a value of `null` is returned.


| Name | Type | Description |
| --- | --- | --- |
| account_id | string | Account ID associated with the order. |
| additional_emails | string | Additional email addresses on the order. |
| agreement_id | string | ID of the CSA agreed to. |
| auto_renew | string | Specify if the certificate should automatically renew.<br>Possible values: 0 (disabled), 1 (enabled) |
| ca_cert_id | string | ID of the issuing certificate authority. |
| certificate_tracker_id | string | Certificate ID. |
| common_name | string | Name secured by the certificate. |
| contacts_email | string | Organization contact email address. |
| container_id | string | Container ID of the order. |
| container_name | string | Container name of the order. |
| cost | string | Order cost. |
| csr | string | Certificate signing request (CSR). |
| custom_renewal_message | string | Custom message included in renewal notifications. |
| customer_order_id | string | Customer order ID. |
| date_created | string | Date the order was placed.<br>Format:<br> yyyy-MM-dd HH:mm:ss |
| dcv_method | string | Domain control validation method configured for the domain. See [Glossary – DCV methods](https://dev.digicert.com/md/certcentral-apis/services-api/glossary.md#dcv-methods). |
| disable_issuance_email | string | Specifies if issuance emails are sent.<br>Possible values: 0 (false), 1 (true) |
| disable_renewal_notifications | string | Specifies if renew notifications are enabled.<br>Possible values: 0 (false), 1 (true) |
| dns_names | string | Comma separated list of additional names secured by the certificate. |
| email | string | If certificate has an embedded email address (e.g., client certificates), returns the email address on the certificate. |
| firstname | string | First name of organization contact. |
| has_duplicates | int | Specifies if the certificate has duplicates.<br>Possible values: 0 (false), 1 (true) |
| id | string | Order ID. |
| is_out_of_contract | string | Contract status of the order.<br>Possible values: 0 (false), 1 (true) |
| is_renewed | string | Specifies if the order has been renewed.<br>Possible values: 0 (false), 1 (true) |
| issuer_common_name | string | Friendly name of the issuing certificate authority. |
| job_title | string | Job title of the organization contact. |
| lastname | string | Last name of the organization contact. |
| locale | string | Locale of the order. See [Glossary – Locale codes](https://dev.digicert.com/md/certcentral-apis/services-api/glossary.md#locale-codes). |
| metadata | string | Custom field details.<br>Format:<br> {{metadata_id}}<br> {{metadata_label}}<br> {{metadata_value}}<br>Data separator:<br> 0x1f |
| org_addr1 | string | Organization address. |
| org_addr2 | string |   |
| organization_city | string | City where the organization is located. |
| organization_country | string | Country where the organization is located. |
| organization_id | string | Organization ID associated with the order. |
| organization_name | string | Organization name. |
| organization_state | string | State where the organization is located. |
| organization_unit | string | Organization units on the certificate. |
| pay_type | string | Payment method used for the order.<br>Possible values: A (account balance), C (credit card) |
| plus_feature | string | Specifies if plus feature is enabled for the order.<br>Possible values: 0 (disabled), 1 (enabled) |
| product_id | string | ID of the product. |
| product_name | string | Display name of the product. See [Glossary – Product identifiers](https://dev.digicert.com/md/certcentral-apis/services-api/glossary.md). |
| product_name_id | string | Name ID of the product. See [Glossary – Product identifiers](https://dev.digicert.com/md/certcentral-apis/services-api/glossary.md). |
| product_type | string | Product type. See [Glossary – Product types](https://dev.digicert.com/md/certcentral-apis/services-api/glossary.md#section-idm33286470715138). |
| purchased_dns_names | string | Number of additional SANs purchased. |
| receipt_id | string | Receipt ID. |
| Renewed | string | Specifies if the order has been renewed.<br>Possible values: FALSE, TRUE |
| renewed_order_id | string | Order ID of the previous order. Returned only if order is a renewal. |
| serial_number | string | Serial number of the certificate. |
| server_platform_id | string | Server platform ID. See [Glossary – Server platforms](https://dev.digicert.com/md/certcentral-apis/services-api/glossary.md#server-platforms). |
| signature_hash | string | Signature hash used to sign the certificate request. |
| status | string | Order status. See [Glossary – Order status](https://dev.digicert.com/md/certcentral-apis/services-api/glossary.md#order-status). |
| telephone | string | Phone number of organization contact. |
| thumbprint | string | Thumbprint of the certificate. |
| user_assignments | string | ID of the user assigned to the order. |
| user_email | string | Email address of user that requested the certificate. |
| user_first_name | string | First name of user that requested the certificate. |
| user_id | string | ID of the user that placed the order. |
| user_last_name | string | Last name of user that requested the certificate. |
| valid_from | string | Date when certificate validity starts.<br>Format:<br> yyyy-MM-dd |
| valid_till | string | Date when certificate validity ends.<br>Format:<br> yyyy-MM-dd |
| validity_years | string | Number of years the certificate is valid. |
{.params-table}

## Response parameters

| Name | Type | Description |
| --- | --- | --- |
| data | object | Container for returned query data. |
| .. order_details | array | List of order objects containing queried fields. |
| .. .. *{{field}}* | - | Queried field and value. Returned fields dependent on sent query. |
{.params-table}