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 following table lists parameters that you can encounter in a newline-delimited response. The MIME type for this format is text/plain.

Line

Possible Values

Line 1: Status Code

1: Successful request, payment required

0: Successful request

-1: The request was made over HTTP instead of HTTPS

-2: X is an unrecognised argument (such parameter doesn’t exist)

-3: The X argument is missing from the request

-4: The value of the X argument in the request is invalid (may also occur if a domain or email already exists)

-16: Permission denied (contact Sectigo Support to have your account enabled for the API)

-17: A GET request was made instead of POST

-18: This order has already been refunded

-20: The order has already been canceled

-42: Call limit reached, please try again later

-76: SiteLock partner account isn’t activated.

-115: No price found for product X (for example, if the days value is invalid)

-121: You cannot buy a lower tier add-on for this product

-121: Renew must be within the renewal period of the existing license (for example, if you try to renew outside the 30-days renewal period before the expiration date)

-122: Such domain or account (email) already exists

-124: SSL PLUS SiteLock Bundle can only be ordered together with an SSL certificate

Line 2: Order Number or Error Message

If Status Code >= 0, this parameter returns the order number. If Status Code < 0, an error message is returned (see possible values in Status Code), with marks the end of the reponse.

Line 3: Amount Debited or Amount Required

If Status Code = 0, Amount Debited is returned. If Status Code = 1, Amount Required (not including UK VAT, if required) is returned.

Line 4: Expected Delivery Time

This value has been deprecated and can be ignored.

Line 5: SSL certificate ID

The internal Certificate ID of the SSL certificate purchased by this order (up to 16 digits). Only returned if showCertificateID=Y was added to the request. The validation process for an EV certifcate (ID 240) generally takes a lot longer, compared to other SSL certificates.

Line 5 or 6: SSL Certificate State

The status of the SSL certificate purchased by this order. Only returned if showCertificateState=Y was passed with the request. For example, certificateStatus=1 Awaiting Validation (Full).

Line 5, 6, or 7: Unique Value

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

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.

Response parameters (when responseFormat=1)

The following table lists parameters that you can encounter in a URL-encoded response. The MIME type for this format is application/x-www-form-urlencoded.

Name Possible Values

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.

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.