Creating an order

This endpoint allows you to create an order

info

POST /ssl/v2/orders

New order requests must follow the JSON:API specification. Which means the request body will follow this format:

{
  "data": {
    "type": "order",
    "attributes": {
      // order attributes
    },
    "relationships": {
      // order relationships
    }
  }
}

Attributes

Name	Type	Description
action	string	See Glossary - Order Action
csr	string	Order CSR
duration	string	Order duration
infos	object	(optional) Product related order information
infos.validation_method	string	(optional) See Glossary - Domain Control Validation Method default value : VALIDATE_DNS
infos.web_server	string	(optional) See Glossary - Web Servers default value : others
customer_id	integer	(optional) Order customer ID
billing_number	string	(optional) Invoicing identifier
order_reference	string	(optional) Purchase Order / Analytical Account reference

Relationships

Name	Resource type	Description
product	product	(creation only) Product to order from
certificate	certificate	(empty on creation) Certificate associated with this order (eg: reissue, renew)
organization	organization	Organization related to this order
contacts	contact (list)	(optional if the organisation has a default contact) Contacts related to this order. (meta.contact_type must indicate admin and tech contacts)

Sample request body

{
  "data": {
    "attributes": {
      "action": "renew",
      "csr": "-----BEGIN CERTIFICATE REQUEST-----",
      "duration": "1 year",
      "infos": {
        "validation_method": "VALIDATE_DNS",
        "web_server": "others"
      }
    },
    "relationships": {
      "certificate": {
        "data": {
          "type": "certificate",
          "id": "ABC012"
        }
      },
      "organization": {
        "data": {
          "type": "organization",
          "id": "ABC012"
        }
      },
      "contacts": {
        "data": [
          {
            "type": "contact",
            "id": "ABC012",
            "meta": {
              "contact_type": "admin"
            }
          },
          {
            "type": "contact",
            "id": "ABC012",
            "meta": {
              "contact_type": "tech"
            }
          }
        ]
      }
    }
  }
}