Response parameters

The AutoApplyOrder API can be instructed to return newline-delimited parameters or URL-encoded parameters in the response, by specifying responseFormat=0 or responseFormat=1. If omitted, the value defaults to 0.

The modifyThirdPartyDetails API only returns URL-encoded response.

Example of a newline-delimited response
0
3040824
210.00
1
TnerFu0d
Example of a URL-encoded response
errorCode=0&orderNumber=3040824&totalCost=210.00&expectedDeliveryTime=1&uniqueValue=TnerFu0d

Response parameters (when responseFormat=0)

The MIME type will be text/plain for responseFormat=0 (by default).

The first line of the response represents a status code.

Whether 0 or 1 is returned for successful orders depends on how your account is configured with Sectigo. Usually, you will take payment from your customer and Sectigo will debit your account funds when you place the order. However, in special circumstances it can be arranged for Sectigo to take payment from your customer on your behalf.
Line Description Possible Values

Line 1

The status code.

  • 0 for successful

  • 1 for successful with pending validation, and negative values for various errors

Line 2

The second line contains an order number.

Integer

Line 3

  • If the status code = 0, it contains the debited amount.

  • If the status code = 1, it contains the required amount, not including UK VAT if required.

Amount in your account’s native currency without a currency symbol.

Line 4

The expected delivery time.

This value has been deprecated and can be ignored.

Line 5

The SSL certificate ID, up to 16 digits. Returned if showCertificateID=Y was added to the request.

The internal certificate ID of the SSL certificate purchased by this order.

240 = This order is for an EV certificate. The validation process for EV certificates typically takes longer than for other SSL certificates.

Line 5 or 6

The SSL certificate state. Returned if showCertificateState=Y.

Line 5, 6 or 7

The unique value. Returned if the uniqueValue parameter was passed in to this API, or if uniqueValue has been generated by Sectigo for this order.

A unique alphanumeric value up to 20 characters long.

Line 8

The eighth line includes slUserID. Returned if a SiteLock license is the only product ordered.

The SiteLock user ID up to 16 integers long.

Line 9

The ninth line includes slSiteID. Returned if a SiteLock license is the only product ordered.

The SiteLock site ID, represented with string.

Response parameters (when responseFormat=1)

Most of Sectigo’s APIs use URL-encoding for responses. AutoApplyOrder can be instructed to return responses in the same format by specifying responseFormat=1 in the request.

The MIME type will be application/x-www-form-urlencoded for responseFormat=1.

The following table displays the various parameters that can appear for responseFormat=1.

Name Possible Values

errorCode

The status code, 0 for successful (see the preceding table)

errorMessage

The error message—​only present when errorCode is less than 0.

orderNumber

The order number—​only present when errorCode=0.

totalCost

The amount, in your account’s native currency, without the currency symbol. Only present when errorCode=0.

expectedDeliveryTime

This value has been deprecated and can be ignored.

certificateID

The internal Certificate ID of the SSL certificate purchased by this order. Only present when errorCode=0, and showCertificateState=Y was passed with the request.

certificateStatus

The status of the SSL certificate purchased by this order. Only returned when errorCode=0, and showCertificateState=Y was passed with the request.

uniqueValue

A unique alphanumeric value up to 20 characters long. Only returned when errorCode=0, and the uniqueValue parameter was passed in to this API, or when a uniqueValue has been generated by Sectigo for this order.

Error codes

The following table outlines error responses returned by the AutoApplyOrder API endpoint. Each error response consists of an errorCode and an errorMessage indicating why the request failed.

Error Code

Error Message

Description

-1

Request was not made over HTTPS!

The request was made over HTTP instead of HTTPS

-2

'xxxx' is an unrecognized argument!

The provided argument is not recognized.

-4

The value of the 'xxxx' argument is invalid!

The argument value does not meet validation requirements.

-16

Permission denied! Contact Sectigo Support to have your account enabled for the !AutoApplyOrder API.

The user does not have permission to access the AutoApplyOrder API.

-17

Request used GET rather than POST!

The request method should be POST.

-18

The CSR’s Common Name may not be a Fully-Qualified Domain Name!

Common Names must not be a fully qualified domain name (FQDN).

-20

The order has already been canceled!

The order has already been canceled and cannot be modified.

-42

Call limit reached, please try again later!

The API call limit has been reached, please try again later.

-76

SiteLock partner account isn’t activated!

The SiteLock partner account is not activated. Please contact Sectigo support to resolve this issue.

-115

No price found for 'xxx'! Contact Support!

No price information available for the specified item.

-121

"TAX" value is deprecated. The value "TIN" should be used instead'

Semantic error. TAX is no longer a valid value. Use TIN instead.

-121

Wrong format of 'xxxx' identifier.

Semantic error. The format of the provided identifier is incorrect.

-121

Wrong country code value in 'xxxx' identifier.

Semantic error. The country code in the provided identifier is incorrect.

-122

A generic error that shows the SiteLock synchronous sync errors

A generic error indicating a SiteLock synchronous synchronization issue.

-124

SiteLock Monitor can only be ordered together with SSL product

SiteLock Monitor must be ordered in conjunction with an SSL product.