Skip to main content

Get orders by alternative order ID

GET https://www.digicert.com/services/v2/order/alternate/{{alternative_order_id}}

Use this endpoint to get a list of orders assigned the same alternative_order_id. Include the alternative_order_id value in the request URL.

For all matching orders the authenticated user has permission to view, the response includes:

  • Order ID

  • Certificate ID

  • Order status

Example requests and responses

Example 1. cURL
curl --request GET 'https://www.digicert.com/services/v2/order/alternate/{{alternative_order_id}}' \
--header 'X-DC-DEVKEY: {{api_key}}' \
--header 'Content-Type: application/json'

Example 2. Python
import requests
import json

url = "https://www.digicert.com/services/v2/order/alternate/{{alternative_order_id}}"

payload={}
headers = {
  'X-DC-DEVKEY': {{api_key}},
  'Content-Type': 'application/json'
}

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

print(response.text)

Example 3. Go
package main

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

func main() {

		url := "https://www.digicert.com/services/v2/order/alternate/{{alternative_order_id}}"
		method := "GET"

		client := &http.Client {
		}
		req, err := http.NewRequest(method, url, nil)

		if err != nil {
				fmt.Println(err)
				return
		}
		req.Header.Add("X-DC-DEVKEY", {{api_key}})
		req.Header.Add("Content-Type", "application/json")

		res, err := client.Do(req)
		if err != nil {
				fmt.Println(err)
				return
		}
		defer res.Body.Close()

		body, err := ioutil.ReadAll(res.Body)
		if err != nil {
				fmt.Println(err)
				return
		}
		fmt.Println(string(body))
}

Example 4. NodeJS
var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://www.digicert.com/services/v2/order/alternate/{{alternative_order_id}}',
  'headers': {
    'X-DC-DEVKEY': {{api_key}},
    'Content-Type': 'application/json'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

Path parameters

Name

Req/Opt

Description

alternative_order_id

required

Alternative order ID to search for.

URL query strings

Name

Req/Opt

Type

Description

offset

optional

integer

Index of the first result to include in the response.

Default: 0

limit

optional

integer

Total number of results to include in the response.

Max: 1000 (default)

Response parameters

Name

Type

Description

orders

array

List of objects with the order ID, certificate ID, and order status for orders that have the same alternative_order_id as the value provided in the request URL.

.. order_id

integer

Order ID.

.. certificate_id

integer

Certificate ID.

.. status

string

Order status.

Possible values: See Glossary – Order status

page

object

Object with pagination details.

See Structures – Page details object

In this section: