Order

Attributes

Name	Type	Description
action	string	See Glossary - Order Action
status	string	See Glossary - Order Status
customer_id	integer	Order customer ID
billing_number	string	Invoicing identifier
order_reference	string	(optional) Purchase Order / Analytical Account reference
common_name	string	Ordered common name (null for non-SSL products)
sans	array	Ordered SANs
duration	string	Order duration
updated_at	string	Order update date
created_at	string	Order creation date
csr	string	(hidden) Order CSR (null for non-SSL products)
infos	object	(hidden) Product related order information
dcv	array	(hidden) List of domain names and tokens to be validated via DNS
x509	string	(hidden) Delivered order certificate X.509
cacert_inter	string	(hidden) Delivered order certificate intermediate certificate (X.509)
cacert_root	string	(hidden) Delivered order certificate root certificate (X.509)
pem	string	(hidden) Delivered order certificate in PEM format

tip

For (hidden) attributes, see Introduction - Fields

Relationships

Name	Resource type	Description
product	product	Product with which this order was created
certificate	certificate	(optional) Certificate associated with this order (eg: reissue, renew)
organization	organization	(optional) Organization related to this order (not present in revocations)
contacts	contact (list)	(optional) Contacts related to this order. (meta.contact_type add context to the relationship) (not present in revocations)
comments	comment (list)	Comments on this order

Sample

{
  "data": {
    "type": "order",
    "id": "ABC012",
    "links": {
      "self": "https://api.nameshield.net/ssl/v2/orders/ABC012"
    },
    "attributes": {
      "status": "CHECKED_OUT",
      "customer_id": 9954,
      "order_reference": null,
      "billing_number": "411D0SA80",
      "updated_at": "2023-06-07T08:57:25.000000Z",
      "created_at": "2023-04-11T22:14:10.000000Z",
      "action": "reissue",
      "common_name": "donnelly.com",
      "sans": [
        "debitis.donnelly.com",
        "illo.donnelly.com",
        "maxime.donnelly.com",
        "odio.donnelly.com",
        "aliquam.donnelly.com",
        "minima.donnelly.com",
        "rerum.donnelly.com",
        "et.donnelly.com"
      ],
      "duration": "1 year"
    },
    "relationships": {
      "product": {
        "links": {
          "related": "https://api.nameshield.net/ssl/v2/orders/ABC012/product"
        },
        "data": {
          "type": "product",
          "id": "1"
        }
      },
      "comments": {
        "links": {
          "related": "https://api.nameshield.net/ssl/v2/orders/ABC012/comments"
        },
        "data": []
      },
      "certificate": {
        "links": {
          "related": "https://api.nameshield.net/ssl/v2/orders/ABC012/certificate"
        },
        "data": {
          "type": "certificate",
          "id": "ABC012"
        }
      },
      "organization": {
        "links": {
          "related": "https://api.nameshield.net/ssl/v2/orders/ABC012/organization"
        },
        "data": {
          "type": "organization",
          "id": "ABC012"
        }
      },
      "contacts": {
        "links": {
          "related": "https://api.nameshield.net/ssl/v2/orders/ABC012/contacts"
        },
        "data": [
          {
            "type": "contact",
            "id": "ABC012",
            "meta": {
              "contact_type": "admin"
            }
          },
          {
            "type": "contact",
            "id": "ABC012",
            "meta": {
              "contact_type": "tech"
            }
          }
        ]
      }
    }
  }
}