Validate Order Parameters

Purpose

Validate Order Parameters is an immutable operation where before submitting the order, you just confirm that everything is in order for that product. We recommend calling this before calling New Order to minimize any errors during New Order transactions.

LIVE URL:

https://api.thesslstore.com/rest/order/validate

SANDBOX URL:

https://sandbox-wbapi.thesslstore.com/rest/order/validate

HTTP VERB
POST

PARAMETERS
JSON :
Content-type: application/json; charset=utf-8;

{
	"AuthRequest":{
		"PartnerCode":"String content",
		"AuthToken":"String content",
		"ReplayToken":"String content",
		"UserAgent":"String content",
		"IPAddress":"String content",
		"IsUsedForTokenSystem":true,
		"Token":"String content"
	},
	"CustomOrderID":"String content",
	"ProductCode":"String content",
	"ExtraProductCodes":"String content",
	"OrganisationInfo":{
		"OrganizationName":"String content",
		"DUNS":"String content",
		"Division":"String content",
		"IncorporatingAgency":"String content",
		"RegistrationNumber":"String content",
		"JurisdictionCity":"String content",
		"JurisdictionRegion":"String content",
		"JurisdictionCountry":"String content",
		"OrganizationAddress":{
			"AddressLine1":"String content",
			"AddressLine2":"String content",
			"AddressLine3":"String content",
			"City":"String content",
			"Region":"String content",
			"PostalCode":"String content",
			"Country":"String content",
			"Phone":"String content",
			"Fax":"String content",
			"LocalityName":"String content"
		}
	},
	"ValidityPeriod":2147483647,
	"ServerCount":2147483647,
	"CSR":"String content",
	"DomainName":"String content",
	"WebServerType":"String content",
	"DNSNames":["String content"],
	"isCUOrder":true,
	"isRenewalOrder":true,
	"SpecialInstructions":"String content",
	"RelatedTheSSLStoreOrderID":"String content",
	"isTrialOrder":true,
	"AdminContact":{
		"FirstName":"String content",
		"LastName":"String content",
		"Phone":"String content",
		"Fax":"String content",
		"Email":"String content",
		"Title":"String content",
		"OrganizationName":"String content",
		"AddressLine1":"String content",
		"AddressLine2":"String content",
		"City":"String content",
		"Region":"String content",
		"PostalCode":"String content",
		"Country":"String content"
	},
	"TechnicalContact":{
		"FirstName":"String content",
		"LastName":"String content",
		"Phone":"String content",
		"Fax":"String content",
		"Email":"String content",
		"Title":"String content",
		"OrganizationName":"String content",
		"AddressLine1":"String content",
		"AddressLine2":"String content",
		"City":"String content",
		"Region":"String content",
		"PostalCode":"String content",
		"Country":"String content"
	},
	"ApproverEmail":"String content",
	"ReserveSANCount":2147483647,
	"AddInstallationSupport":true,
	"EmailLanguageCode":"String content",
	"FileAuthDVIndicator":true,
	"CNAMEAuthDVIndicator":true,
	"SignatureHashAlgorithm":"String content"
}

XML:
Content-type: application/xml; charset=utf-8;

<NewOrderRequest>

<AuthRequest>
<PartnerCode>String content</PartnerCode>
<AuthToken>String content</AuthToken>
<ReplayToken>String content</ReplayToken>
<UserAgent>String content</UserAgent>
<IPAddress>String content</IPAddress>
<IsUsedForTokenSystem>true</IsUsedForTokenSystem>
<Token>String content</Token>
</AuthRequest>
<CustomOrderID>String content</CustomOrderID>
<ProductCode>String content</ProductCode>
<ExtraProductCodes>String content</ExtraProductCodes>
<OrganisationInfo>
<OrganizationName>String content</OrganizationName>
<DUNS>String content</DUNS>
<Division>String content</Division>
<IncorporatingAgency>String content</IncorporatingAgency>
<RegistrationNumber>String content</RegistrationNumber>
<JurisdictionCity>String content</JurisdictionCity>
<JurisdictionRegion>String content</JurisdictionRegion>
<JurisdictionCountry>String content</JurisdictionCountry>
<OrganizationAddress>
<AddressLine1>String content</AddressLine1>
<AddressLine2>String content</AddressLine2>
<AddressLine3>String content</AddressLine3>
<City>String content</City>
<Region>String content</Region>
<PostalCode>String content</PostalCode>
<Country>String content</Country>
<Phone>String content</Phone>
<Fax>String content</Fax>
<LocalityName>String content</LocalityName>
</OrganizationAddress>
</OrganisationInfo>
<ValidityPeriod>2147483647</ValidityPeriod>
<ServerCount>2147483647</ServerCount>
<CSR>String content</CSR>
<DomainName>String content</DomainName>
<WebServerType>String content</WebServerType>
<DNSNames>
<string>String content</string>
<string>String content</string>
</DNSNames>
<isCUOrder>true</isCUOrder>
<isRenewalOrder>true</isRenewalOrder>
<SpecialInstructions>String content</SpecialInstructions>
<RelatedTheSSLStoreOrderID>String content</RelatedTheSSLStoreOrderID>
<isTrialOrder>true</isTrialOrder>
<AdminContact>
<FirstName>String content</FirstName>
<LastName>String content</LastName>
<Phone>String content</Phone>
<Fax>String content</Fax>
<Email>String content</Email>
<Title>String content</Title>
<OrganizationName>String content</OrganizationName>
<AddressLine1>String content</AddressLine1>
<AddressLine2>String content</AddressLine2>
<City>String content</City>
<Region>String content</Region>
<PostalCode>String content</PostalCode>
<Country>String content</Country>
</AdminContact>
<TechnicalContact>
<FirstName>String content</FirstName>
<LastName>String content</LastName>
<Phone>String content</Phone>
<Fax>String content</Fax>
<Email>String content</Email>
<Title>String content</Title>
<OrganizationName>String content</OrganizationName>
<AddressLine1>String content</AddressLine1>
<AddressLine2>String content</AddressLine2>
<City>String content</City>
<Region>String content</Region>
<PostalCode>String content</PostalCode>
<Country>String content</Country>
</TechnicalContact>
<ApproverEmail>String content</ApproverEmail>
<ReserveSANCount>2147483647</ReserveSANCount>
<AddInstallationSupport>true</AddInstallationSupport>
<EmailLanguageCode>String content</EmailLanguageCode>
<FileAuthDVIndicator>true</FileAuthDVIndicator>
<CNAMEAuthDVIndicator>true</CNAMEAuthDVIndicator>
<SignatureHashAlgorithm>String content</SignatureHashAlgorithm>
</NewOrderRequest>

PARAMETERS
JSON :

{
	"isError":true,
	"Message":["String content"],
	"Timestamp":"String content",
	"ReplayToken":"String content",
	"InvokingPartnerCode":"String content"
}

XML:

<AuthResponse>
<isError>true</isError>
<Message>
<string>String content</string>
<string>String content</string>
</Message>
<Timestamp>String content</Timestamp>
<ReplayToken>String content</ReplayToken>
<InvokingPartnerCode>String content</InvokingPartnerCode>
</AuthResponse>

Fields Explanation
• R – Required
• O – Optional
• I – Ignore (not applicable)

NAME FROM Field Req. Type Description
AuthRequest.AuthToken Request R String This is an alpha-numeric token code provided to you by thesslstore.com. It is required in all requests.

Optional if Token is specified.

AuthRequest.PartnerCode Request R String This is an alpha-numeric code provided to you by thesslstore.com. It is required in all requests.

Optional if Token is specified.

AuthRequest.ReplayToken Request O String This is an alpha-numeric code provided by you in order request and thesslstore.com sent back in request.
AuthRequest.UserAgent Request O String User Agent to identify the request coming from.
AuthRequest.Token Request R* String This is an alpha-numeric code.

* This is Required only if you have set IsUsedForTokenSystem is true.

AuthRequest.IsUsedForTokenSystem Request R Boolean There are only two possible values true or false. Mostly this field used for AutoInstallSSL Plugin.
NewOrderRequest.AddInstallationSupport Request O Boolean If reseller would like to purchase Installation support along with order. They have to pass true. Default value is false.
NewOrderRequest.ApproverEmail Request R* String This is the email of the Approver – in the Domain vetted line of products this is the person responsible for approving the order.

*Required for Domain Vetted products ,True BusinessID with EV and Comodo Certs

Note: You must have to call /order/approverlist/ API method before passing the value in ApproverEmail field for COMODO Products.

NewOrderRequest.CSR Request R String Certificate Signing Request (Base-64 encoded, with or without the —–BEGIN xxxxx—– and —–END xxxxx—– header and footer)
NewOrderRequest.CustomOrderID Request O* String A Unique Number Provide by You.

*If not passed in request then system automatically generates.

NewOrderRequest.DomainName Request O* String The domain name for an Order. For an SSL Order this can be a fully qualified Domain (e.g., www.thesslstore.com) or possibly a wildcard domain (e.g., *.geotrust.com).

*Only Required for Certum SSL Certificate Products.

NewOrderRequest.EmailLanguageCode Request O String The language code to be used when sending e-mail messages for this order. (right Now is not supported) Default Value is “EN”.
NewOrderRequest.ExtraProductCodes Request O String Comma separated product code for free products, like trust logo.
NewOrderRequest.isCUOrder Request R Boolean The IsCUOrder is the validated CU results for a specified order. There are only two possible values true or false. Default Value is false.
NewOrderRequest.isRenewalOrder Request R Boolean Indicates that this order is a renewal order. There are only two possible values true or false. Default Value is false.
NewOrderRequest.isTrialOrder Request R Boolean Indicates that this order is a Trial order. There are only two possible values true or false. Default Value is false.
NewOrderRequest.ProductCode Request R String Product code that you want SSL Certificate for.
NewOrderRequest.RelatedTheSSLStoreOrderID Request O* String Provide Old Order’s TheSSLStoreOrderID in Case of Renewal Order.

* Required for Midterm Upgrades only Symantec products.

NewOrderRequest.ReserveSANCount Request O* String Allows a partner to limit the number of values that a customer can enter in the sAN Field of a certificates.

* Only relevant for Multi-Domain SSL Certificates.

NewOrderRequest.DNSNames Request O* String A comma-separated list of Additional Domain Names.

* Only relevant for Multi-Domain SSL Certificates.

NewOrderRequest.ServerCount Request R String Number of Server Licenses.
Possible value is between 1 to 100 for Comodo WildCard product and Symantec Products.
NewOrderRequest.SpecialInstructions Request O String Special Instructions for the order.
NewOrderRequest.ValidityPeriod Request R String Validity Period (in month)
*Required for this request
NewOrderRequest.WebServerType Request R String This is from the OrderParameters structure. Designates the type of web server that an order is targeted for.
NewOrderRequest.FileAuthDVIndicator Request R Boolean USED For DV File Authentication. Only for Symantec/Comodo Domain Vetted Products. You need to pass value true.
NewOrderRequest.SignatureHashAlgorithm Request O Boolean This defines the certificate hashing algorithm.
Possible values for Symantec, GeoTrust, Thawte, RapidSSL Products:
1) SHA2-256 (Default value)
2) SHA1

Possible values for Comodo Products:
1) NO_PREFERENCE
2) INFER_FROM_CSR
3) PREFER_SHA2 (Default value)
4) PREFER_SHA1
5) REQUIRE_SHA2

Not Applicable for Certum Products.

OrganisationInfo.Division Request R* String The OrganizationalUnit name from the CSR. Up to three comma-separated values may be contained in this parameter.

* Required for Org. Validated certs.

OrganisationInfo.DUNS Request R* String The DUN and Bradstreet number for a company.

* Required for Org. Validated certs.

OrganisationInfo.IncorporatingAgency Request O String Incorporating Agency Name.
OrganisationInfo.JurisdictionCity Request O String Jurisdiction City Name.
OrganisationInfo.JurisdictionCountry Request O String Jurisdiction of Incorporation: Country
OrganisationInfo.JurisdictionRegion Request O String Jurisdiction Region Name.
OrganisationInfo.OrganizationName Request R* String The name of the Organization applying for the product. This applies to Organization Vetted products.

* Required for Org. Validated certs.

OrganisationInfo.RegistrationNumber Request R* String Company Registration Number.

* Required for Org. Validated certs.

OrganizationAddress.AddressLine1 Request R* String Organization Street AddressLine1.

* Required for Org. Validated certs.

OrganizationAddress.AddressLine2 Request O String Organization Street AddressLine2.
OrganizationAddress.AddressLine3 Request O String Organization Street AddressLine3.
OrganizationAddress.City Request R* String Organization City Name.

* Required for Org. Validated certs.

OrganizationAddress.Country Request R* String Organization Country Name.

* Required for Org. Validated certs.

OrganizationAddress.Fax Request O String Organization Fax Number.
OrganizationAddress.LocalityName Request O String The Locality field from the CSR or Certificate.
OrganizationAddress.Phone Request R* String Organization Phone Number.
Please don’t use any special characters in phone number like space,+(plus), -, .(dot) etc.
Phone number should be only numbers.

* Required for Org. Validated certs.

OrganizationAddress.PostalCode Request R* String Organization Postal Code.

* Required for Org. Validated certs.

OrganizationAddress.Region Request R* String Organization Region Name.

* Required for Org. Validated certs.

AdminContact.AddressLine1 Request R String Admin Contact Street AddressLine1
AdminContact.AddressLine2 Request O String Admin Contact Street AddressLine2.
AdminContact.City Request R String Admin Contact City Name.
AdminContact.Country Request R String Admin Contact Country Name.
AdminContact.Email Request R String Admin Contact Email Address.
AdminContact.Fax Request O String Admin Contact Fax Number.
AdminContact.FirstName Request R String Admin Contact First Name.
AdminContact.LastName Request R String Admin Contact Last Name.
AdminContact.OrganizationName Request R String Admin Contact Organization Name.
AdminContact.Phone Request R String Admin Contact Phone Number.
Please don’t use any special characters in phone number like space,+(plus), -, .(dot) etc.
Phone number should be only numbers.
AdminContact.PostalCode Request R String Admin Contact Postal Code.
AdminContact.Region Request R String Admin Contact Region Name.
AdminContact.Title Request R* String Admin Contact Person’s title.

*Required for SYMANTEC products.

TechnicalContact.AddressLine1 Request R String Technical Contact Street AddressLine1.
TechnicalContact.AddressLine2 Request O String Technical Contact Street AddressLine2.
TechnicalContact.City Request R String Technical Contact City Name.
TechnicalContact.Country Request R String Technical Contact Country Name.
TechnicalContact.Email Request R String Technical Contact Email Address.
TechnicalContact.Fax Request O String Technical Contact Fax Number.
TechnicalContact.FirstName Request R String Technical Contact First Name.
TechnicalContact.LastName Request R String Technical Contact Last Name.
TechnicalContact.OrganizationName Request O String Technical Contact Organization Name.
TechnicalContact.Phone Request R String Technical Contact Phone Number.
Please don’t use any special characters in phone number like space,+(plus), -, .(dot) etc.
Phone number should be only numbers.
TechnicalContact.PostalCode Request R String Technical Contact Postal Code.
TechnicalContact.Region Request String Technical Contact Region Name
TechnicalContact.Title Request R* String Technical Contact Person’s title.

*Required for SYMANTEC products.

AuthResponse.isError Response N/A Boolean Returns False/true according to errorstatus into the response.
AuthResponse.Message Response N/A String The Message given into the response.
AuthResponse.Timestamp Response N/A Date The Date and time when user gets the response. A date timestamp used in a variety of contexts. Note that the XML format is: YYYY-DD-MMTHH:MM:SS:000Z (for example, 2001-01-01T24:00:00:000Z is for Jan 1, 2001 at midnight).
AuthResponse.ReplayToken Response N/A String The value of the ReplayToken which provide by you in Order request.
AuthResponse.InvokingPartnerCode Response N/A String This is an alpha-numeric code provided to you by thesslstore.com.