Order Service

Product Agreement

Purpose
Each Product has agreements between the vendor and the customer. When a customer buys that product, it’s imperative that he agrees to conditions set forth by the vendor. It is considered a GOOD practice to show the customers this agreement rather than taking it for granted. This methods returns that agreement that the customer can see before ordering.

URL

  • LIVE URL:
https://api.thesslstore.com/rest/order/agreement
  • SANDBOX URL:
https://sandbox-wbapi.thesslstore.com/rest/order/agreement

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"",
		"TokenID":"String content",
		"TokenCode":"String content",
		"IsUsedForTokenSystem":true
	},
	"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,
	"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>
<TokenID>String content</TokenID>
<TokenCode>String content</TokenCode>
<IsUsedForTokenSystem>true</IsUsedForTokenSystem>
</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>
<SignatureHashAlgorithm>String content</SignatureHashAlgorithm>
</NewOrderRequest>

PARAMETERS
JSON :

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

XML:

<UserAgreementResponse>
<Agreement>String content</Agreement>
<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>
</UserAgreementResponse>

Fields Explanation

NAME FROM Type Description
AdminContact.AddressLine1 Request String Admin Contact Street AddressLine1
AdminContact.AddressLine2 Request String Admin Contact Street AddressLine1
AdminContact.City Request String Admin Contact City Name
AdminContact.Country Request String Admin Contact Country Name
AdminContact.Email Request String Admin Contact Email Address.
AdminContact.Fax Request String Admin Contact Fax Number.
AdminContact.FirstName Request String Admin Contact First Name.
AdminContact.LastName Request String Admin Contact Last Name.
AdminContact.OrganizationName Request String Admin Contact Organization Name.
AdminContact.Phone Request String Admin Contact Phone Number.
AdminContact.PostalCode Request String Admin Contact Postal Code
AdminContact.Region Request String Admin Contact Region Name
AdminContact.Title Request String Admin Contact Person’s title.
AuthRequest.AuthToken Request String This is an alpha-numeric token code provided to you by thesslstore.com. It is required in all requests.
AuthRequest.PartnerCode Request String This is an alpha-numeric code provided to you by thesslstore.com. It is required in all requests.
*Required for this request
AuthRequest.ReplayToken Request String This is an alpha-numeric-code provided by you in order request and thesslstore.com sent back in request.
AuthRequest.UserAgent Request String Browser’s user agent value provided by you for specific order.
AuthRequest.TokenID Request String Ignore. For future use.
AuthRequest.Tokencode Request String Ignore. For future use.
AuthRequest.IsUsedForTokenSystem Request Boolean Ignore. For future use.
NewOrderRequest.AddInstallationSupport Request String Indicates Purchase Installation Support for this order.
NewOrderRequest.ApproverEmail Request String This is the email of the Approver – in the Domain vetted line of products this is the person responsible for approving the order.
NewOrderRequest.CSR Request String Certificate Signing Request (Base-64 encoded, with or without the —–BEGIN xxxxx—– and —–END xxxxx—– header and footer)
NewOrderRequest.CustomOrderID Request String A Unique Number Provided by You.
NewOrderRequest.DomainName Request 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).
*Required for this request.
NewOrderRequest.EmailLanguageCode Request 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.FileAuthDVIndicator Request Boolean This value shows whether DV file authentication process is available or not.
NewOrderRequest.SignatureHashAlgorithm Request String Defines hashing algorithm for certificate.
NewOrderRequest.ExtraProductCodes Request String Coma separated product code for free products
NewOrderRequest.isCUOrder Request Boolean The IsCUOrder is the validated CU results for a specified order.
NewOrderRequest.isRenewalOrder Request Boolean Indicates that this order is a renewal order.
NewOrderRequest.isTrialOrder Request Boolean Indicates that this order is a Trial order.
NewOrderRequest.ProductCode Request String A code for the product that a particular request relates to. Note that a partner must have a valid contract for a product code for it to be valid in a request. Also, a product code must be valid for the context of the request.
NewOrderRequest.RelatedTheSSLStoreOrderID Request String Provide Old Order’s TheSSLStoreOrderID in Case of Renewal Order.
NewOrderRequest.ReserveSANCount Request String Allows a partner to limit the number of values that a customer can enter in the SAN Field of a certificates
NewOrderRequest.ServerCount Request String Number of Server Licenses
NewOrderRequest.SpecialInstructions Request String Special Instructions for the order
NewOrderRequest.ValidityPeriod Request String Validity Period (in months)
NewOrderRequest.WebServerType Request String This is from the OrderParameters structure. Designates the type of web server that an order is targeted for.
OrganisationInfo.Division Request String The OrganizationalUnit name from the CSR. Up to three comma-separated Ous may be contained in this parameter.
OrganisationInfo.DUNS Request String The Dunn and Bradstreet number for a company
OrganisationInfo.IncorporatingAgency Request String Incorporating Agency Name
OrganisationInfo.JurisdictionCity Request String Jurisdiction City Name
OrganisationInfo.JurisdictionCountry Request String Jurisdiction of Incorporation: Country
OrganisationInfo.JurisdictionRegion Request String Jurisdiction Region Name
OrganisationInfo.OrganizationName Request String The name of the Organization applying for the product. This applies to Organization Vetted products.
OrganisationInfo.RegistrationNumber Request String Company Registration Number
OrganizationAddress.AddressLine1 Request String Organization Street AddressLine1
OrganizationAddress.AddressLine2 Request String Organization Street AddressLine2
OrganizationAddress.AddressLine3 Request String Organization Street AddressLine3
OrganizationAddress.City Request String Organization City Name
OrganizationAddress.Country Request String Organization Country Name
OrganizationAddress.Fax Request String Organization Fax Number
OrganizationAddress.LocalityName Request String The Locality field from the CSR or Certificate
OrganizationAddress.Phone Request String Organization Phone Number
OrganizationAddress.PostalCode Request String Organization Postal Code
OrganizationAddress.Region Request String Organization Region Name
TechnicalContact.AddressLine1 Request String Technical Contact Street AddressLine1
TechnicalContact.AddressLine2 Request String Technical Contact Street AddressLine2
TechnicalContact.City Request String Technical Contact City Name
TechnicalContact.Country Request String Technical Contact Country Name
TechnicalContact.Email Request String Technical Contact Email Address.
TechnicalContact.Fax Request String Technical Contact Fax Number.
TechnicalContact.FirstName Request String Technical Contact First Name.
TechnicalContact.LastName Request String Technical Contact Last Name.
TechnicalContact.OrganizationName Request String Technical Contact Organization Name.
TechnicalContact.Phone Request String Technical Contact Phone Number.
TechnicalContact.PostalCode Request String Technical Contact Postal Code
TechnicalContact.Region Request String Technical Contact Region Name
TechnicalContact.Title Request String Technical Contact Person’s title.
UserAgreementResponse. Agreement Response String User Agreement string
AuthResponse. isError Response Boolean Returns False/true according to errorstatus into the response.
AuthResponse.Message Response string The Message given into the response.
AuthResponse.Timestamp Response Date The Date and time when user gets the response.
AuthResponse.ReplayToken Response string The value of the ReplayToken which provide by you in Order request
AuthResponse.InvokingPartnerCode Response string This is an alpha-numeric code provided to you by thesslstore.com. It is required in all requests.

New Order

Purpose
To order a new product by passing in all details like CSR etc, you need to call this method. Not all the fields are compulsory for all the products, so please refer the guidelines specified in “Field Explanation” below. You can also look up our wiki at https://www.thesslstore.com/restwiki/ to see the Request/Response payload for specific products.

URL

  • LIVE URL:
https://api.thesslstore.com/rest/order/neworder
  • SANDBOX URL:
https://sandbox-wbapi.thesslstore.com/rest/order/neworder

HTTP VERB
POST

PARAMETERS
JSON :

{
	"AuthRequest":{
		"PartnerCode":"String content",
		"AuthToken":"String content",
		"ReplayToken":"String content",
		"UserAgent":"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"
}

XML:

<NewOrderRequest>
<AuthRequest>
<PartnerCode>String content</PartnerCode>
<AuthToken>String content</AuthToken>
<ReplayToken>String content</ReplayToken>
<UserAgent>String content</UserAgent>
</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>
</NewOrderRequest>

RESPONSE
JSON :

{
	"AuthResponse":{
		"isError":true,
		"Message":["String content"],
		"Timestamp":"String content",
		"ReplayToken":"String content",
		"InvokingPartnerCode":"String content"
	},
	"PartnerOrderID":"String content",
	"CustomOrderID":"String content",
	"TheSSLStoreOrderID":"String content",
	"VendorOrderID":"String content",
	"RefundRequestID":"String content",
	"isRefundApproved":true,
	"TinyOrderLink":"String content",
	"OrderStatus":{
		"isTinyOrder":true,
		"isTinyOrderClaimed":true,
		"MajorStatus":"String content",
		"MinorStatus":"String content"
	},
	"OrderAmount":"String content",
	"CertificateStartDate":"String content",
	"CertificateEndDate":"String content",
	"CommonName":"String content",
	"DNSNames":"String content",
	"State":"String content",
	"Country":"String content",
	"Locality":"String content",
	"Organization":"String content",
	"OrganizationalUnit":"String content",
	"WebServerType":"String content",
	"ApproverEmail":"String content",
	"ProductName":"String content",
	"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"
	},
	"ReissueSuccessCode":"String content"
}

XML:

<OrderResponse>
  <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>
  <PartnerOrderID>String content</PartnerOrderID>
  <CustomOrderID>String content</CustomOrderID>
  <TheSSLStoreOrderID>String content</TheSSLStoreOrderID>
  <VendorOrderID>String content</VendorOrderID>
  <RefundRequestID>String content</RefundRequestID>
  <isRefundApproved>true</isRefundApproved>
  <TinyOrderLink>String content</TinyOrderLink>
  <OrderStatus>
    <isTinyOrder>true</isTinyOrder>
    <isTinyOrderClaimed>true</isTinyOrderClaimed>
    <MajorStatus>String content</MajorStatus>
    <MinorStatus>String content</MinorStatus>
  </OrderStatus>
  <OrderAmount>String content</OrderAmount>
  <CertificateStartDate>String content</CertificateStartDate>
  <CertificateEndDate>String content</CertificateEndDate>
  <CommonName>String content</CommonName>
  <DNSNames>String content</DNSNames>
  <State>String content</State>
  <Country>String content</Country>
  <Locality>String content</Locality>
  <Organization>String content</Organization>
  <OrganizationalUnit>String content</OrganizationalUnit>
  <WebServerType>String content</WebServerType>
  <ApproverEmail>String content</ApproverEmail>
  <ProductName>String content</ProductName>
  <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>
  <ReissueSuccessCode>String content</ReissueSuccessCode>
</OrderResponse>

Fields Explanation

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

*Required for this request
AuthRequest.PartnerCode Request string This is an alpha-numeric code provided to you by thesslstore.com. It is required in all requests.

*Required for this request
AuthRequest.ReplayToken Request string This is an alpha-numeric code provided by you in order request and thesslstore.com sent back in request.
AuthRequest.UserAgent Request string Browser’s user agent value provided by you for specific order.
NewOrderRequest.AddInstallationSupport Request Boolean Indicates Purchase Installation Support for this order.
NewOrderRequest.ApproverEmail Request 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
NewOrderRequest.CSR Request string Certificate Signing Request (Base-64 encoded, with or without the—–BEGIN xxxxx—– and —–END xxxxx—– header and footer)For Code Signing Certificates such as Apple, Adobe Air, Java and JavaSoft a SPKAC File should be supplied without the—BEGIN SPKAC— and the END one around the Base64 SPKAC.

SPKAC is an acronym that stands for Signed Public Key and Challenge. It is a format used to generate a certificate signing request used by Mozilla. If you add the <KEYGEN> tag on an HTML form (page) it displays a drop down where the user can select the keysize. When the form is submitted the SPKAC is generated. <keygen name=”someName”challenge=”challenge 123″>

https://developer.mozilla.org/En/HTML/Element/keygen

*Required for this request

NewOrderRequest.CustomOrderID Request string A Unique Number Provide by You.
NewOrderRequest.DomainName Request 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).

*Not supported for Org. Validated Symantec certs or for Comodo certs, only relevant for Multi-Domain SSL Certificates and Unified Communications Certificates
NewOrderRequest.EmailLanguageCode Request 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 string Used for free products like trust logo
NewOrderRequest.isCUOrder Request Boolean The IsCUOrder is the validated CU results for a specified order.
NewOrderRequest.isRenewalOrder Request Boolean Indicates that this order is a renewal order.
NewOrderRequest.isTrialOrder Request Boolean Indicates that this order is a Trial order.
NewOrderRequest.ProductCode Request string A code for the product that a particular request relates to. Note that a partner must have a valid contract for a product code for it to be valid in a request. Also, a product code must be valid for the context of the request.

*Required for this request.
NewOrderRequest.RelatedTheSSLStoreOrderID Request string Provide Old Order’s TheSSLStoreOrderID in Case of Renewal Order.

* Required for Midterm Upgrades only Symantec products
NewOrderRequest.ReserveSANCount Request string Allows a partner to limit the number of values that a customer can enter in the sAN Field of a certificates
*Required for SAN enabled certificates.
NewOrderRequest. DNSNames Request string A comma-separated list of Additional Domain Names.

* Up to 25 Values in SubjectAltName for TBID and for Comodo certs , up to 2004
NewOrderRequest.ServerCount Request string Number of Server Licenses
*Required for Org. Validated certs.
NewOrderRequest.SpecialInstructions Request string Special Instructions for the order
NewOrderRequest.ValidityPeriod Request string Validity Period (in month)
*Required for Org. Validated certs.
NewOrderRequest.WebServerType Request string This is from the OrderParameters structure. Designates the type of web server that an order is targeted for.
*Required for Org. Validated certs.
OrganisationInfo.Division Request string The OrganizationalUnit name from the CSR. Up to three comma-separated Ous may be contained in this parameter.
OrganisationInfo.DUNS Request string The Dunn and Bradstreet number for a company
OrganisationInfo.IncorporatingAgency Request string Incorporating Agency Name
OrganisationInfo.JurisdictionCity Request string Jurisdiction City Name
OrganisationInfo.JurisdictionCountry Request string Jurisdiction of Incorporation: Country
OrganisationInfo.JurisdictionRegion Request string Jurisdiction Region Name
OrganisationInfo.OrganizationName Request string The name of the Organization applying for the product. This applies to Organization Vetted products.
*Required for Org. Validated certs.
OrganisationInfo.RegistrationNumber Request string Company Registration Number
OrganizationAddress.AddressLine1 Request string Organization Street AddressLine1
*Required for Org. Validated certs.
OrganizationAddress.AddressLine2 Request string Organization Street AddressLine2
OrganizationAddress.AddressLine3 Request string Organization Street AddressLine3
OrganizationAddress.City Request string Organization City Name
OrganizationAddress.Country Request string Organization Country Name
*Required for Org. Validated certs.
OrganizationAddress.Fax Request string Organization Fax Number
OrganizationAddress.LocalityName Request string The Locality field from the CSR or Certificate
OrganizationAddress.Phone Request string Organization Phone Number
*Required for Org. Validated certs.
OrganizationAddress.PostalCode Request string Organization Postal Code
*Required for Org. Validated certs.
OrganizationAddress.Region Request string Organization Region Name
*Required for Org. Validated certs.
AdminContact.AddressLine1 Request string Admin Contact Street AddressLine1
AdminContact.AddressLine2 Request string Admin Contact Street AddressLine2
AdminContact.City Request string Admin Contact City Name
AdminContact.Country Request string Admin Contact Country Name
AdminContact.Email Request string Admin Contact Email Address.
*Required for Organization Vetted or EV products.
AdminContact.Fax Request string Admin Contact Fax Number.
AdminContact.FirstName Request string Admin Contact First Name.
*Required for Organization Vetted or EV products.
AdminContact.LastName Request string Admin Contact Last Name.
*Required for Organization Vetted or EV products.
AdminContact.OrganizationName Request string Admin Contact Organization Name.
AdminContact.Phone Request string Admin Contact Phone Number.
*Required for Organization Vetted or EV products.
AdminContact.PostalCode Request string Admin Contact Postal Code
AdminContact.Region Request string Admin Contact Region Name
AdminContact.Title Request string Admin Contact Person’s title.
*Required for Organization Vetted or EV products.
TechnicalContact.AddressLine1 Request string Technical Contact Street AddressLine1
TechnicalContact.AddressLine2 Request string Technical Contact Street AddressLine1
TechnicalContact.City Request string Technical Contact City Name
TechnicalContact.Country Request string Technical Contact Country Name
TechnicalContact.Email Request string Technical Contact Email Address.
*Required for Org. Validated certs.
TechnicalContact.Fax Request string Technical Contact Fax Number.
TechnicalContact.FirstName Request string Technical Contact First Name.
*Required for Org. Validated certs.
TechnicalContact.LastName
*Required for Org. Validated certs.
Request string Technical Contact Last Name.
TechnicalContact.OrganizationName Request string Technical Contact Organization Name.
TechnicalContact.Phone Request string Technical Contact Phone Number.
*Required for Org. Validated certs.
TechnicalContact.PostalCode Request string Technical Contact Postal Code
TechnicalContact.Region Request string Technical Contact Region Name
TechnicalContact.Title Request string Technical Contact Person’s title.
*Required for Org. Validated certs.
AuthResponse.InvokingPartnerCode Response string This is an alpha-numeric code provided to you by thesslstore.com.
AuthResponse.isError Response Boolean Return true if any error occurred during Order processing.
AuthResponse.ReplayToken Response string The value of the ReplayToken which provide by you in Order request.
AuthResponse.Timestamp Response string 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).
OrderResponse.CertificateEndDate Response string This is the date the end entity certificate will expire on.
OrderResponse.CertificateStartDate Response string This is the date the end entity certificate or seal will be valid from.
OrderResponse.CommonName Response string This field is part of the subject DN of the end entity certificate and distinguishes the certificate. For an SSL certificate this will most likely be the fully qualified domain name the certificate will be used to secure.
OrderResponse.Country Response string The value of the Country in the ParseCSRResponse
OrderResponse.CustomOrderID Response string A Number provide by you in request which is sent in response.
OrderResponse.DNSNames Response string Additional Domains Name
OrderResponse.isRefundApproved Response Boolean Return true if Refund request approved from thesslstore.com
OrderResponse.Locality Response string The value of the Locality in the ParseOrderResponse.
OrderResponse.OrderAmount Response string Total Order Amount
OrderResponse.Organization Response string The OrganizationalUnit name from the CSR. Up to three comma-separated Ous may be contained in this parameter.
OrderResponse.OrganizationalUnit Response string The OrganizationalUnit name from the CSR. Up to three comma-separated Ous may be contained in this parameter.
OrderResponse.PartnerOrderID Response string A Tracking Number for Orders that can be set by a partner. Typically this would be a partner’s internal order number. When calling one of the initiate order operations this field is optional. If not supplied by the client, a random unique PartnerOrderID is generated by GeoTrust. Certain subsequent operations, such as GetOrderByPartnerOrderID, require this value
OrderResponse.RefundRequestID Response string A Tracking Number for Orders that can be set by a TheSSLStore.com in case of you refund request of order.
OrderResponse.ReissueSuccessCode Response string The value of the Reissue Success Code in the ParseRefund Request Order Response.
OrderResponse.State Response string The value of the State in the ParseCSRResponse
OrderResponse.TheSSLStoreOrderID Response string A Tracking Number for Orders that can be set by a TheSSLStore.com
OrderResponse.TinyOrderLink Response string Field Description
OrderResponse.VendorOrderID Response string A Tracking Number for Orders that can be set by a Vendor.
OrderResponse.WebServerType Response string The value of the WebServerType in the ParseOrderResponse.
OrderStatus.isTinyOrder Response Boolean Return true in case of Inviteorder method.
OrderStatus.isTinyOrderClaimed Response Boolean Return true if you processed the TinyOrderLink.
OrderStatus.MajorStatus Response string PENDING – Order is in process. ACTIVE– Order has been completed. CANCELLED – Order has been completed and cancelled. INITIAL : Enrollment link is not claimed yet. EXPIRED – Order has been expired.
OrderStatus.MinorStatus Response string OrderStatusMinor provides specific status information unique to the workflow of the specific product.
AdminContact.FirstName Request string This is first name of admin contact of your order.
AdminContact.LastName Request string This is Last name of admin contact of your order.
AdminContact.Phone Request string This is Phone no of admin contact of your order.
AdminContact.Fax Request string This is Fax No of admin contact of your order.
AdminContact.Email Request string This is Email of admin contact of your order.
AdminContact.Title Request string This is Title of admin contact of your order.
AdminContact.OrganizationName Request string This is OrganizationName of admin contact of your order.
AdminContact.AddressLine1 Request string This is Address of admin contact of your order.
AdminContact.AddressLine2 Request string This is Address of admin contact of your order.
AdminContact.City Request string This is City of admin contact of your order.
AdminContact. Region Request string This is Region of admin contact of your order.
AdminContact. PostalCode Request string This is Postalcode of admin contact of your order.
AdminContact.Country Request string This is Country of admin contact of your order.
TechnicalContact.FirstName Request string This is First name of technical contact of your order.
TechnicalContact.LastName Request string This is Last name of technical contact of your order.
TechnicalContact.Phone Request string This is Phone no of technical contact of your order.
TechnicalContact.Fax Request string This is Fax No of technical contact of your order.
TechnicalContact.Email Request string This is Email of technical contact of your order.
TechnicalContact.Title Request string This is Title of technical contact of your order.
TechnicalContact.OrganizationName Request string This is OrganizationName of technical contact of your order.
TechnicalContact.AddressLine1 Request string This is Address of technical contact of your order.
TechnicalContact.AddressLine2 Request string This is Address of technical contact of your order.
TechnicalContact.City Request string This is City of technical contact of your order.
TechnicalContact.Region Request string This is Region of technical contact of your order.
TechnicalContact.PostalCode Request string This is Postalcode of technical contact of your order.
TechnicalContact.Country Request string This is Country of technical contact of your order.

Invite Order

Purpose
This is an alternate way of ordering when you don’t want to provide all the CSR, etc. steps on your front-end. With Invite Order, you can call minified version of New Order, while at the same time gaining complete Order Response including status. The Fullfillment URL that your customers will get will be a White-Branded site, where they can complete the Enrollment process. For some products you can also directly gain links in the VENDORS site, where the customer completes the SSL enrollment process.

URL

  • LIVE URL:
https://api.thesslstore.com/rest/order/inviteorder
  • SANDBOX URL:
https://sandbox-wbapi.thesslstore.com/rest/order/inviteorder

HTTP VERB
POST

PARAMETERS
JSON :

{
	"AuthRequest":{
		"PartnerCode":"String content",
		"AuthToken":"String content",
		"ReplayToken":"String content",
		"UserAgent":"String content"
	},
	"PreferVendorLink":true,
	"ProductCode":"String content",
	"ExtraProductCode":"String content",
	"ServerCount":2147483647,
	"RequestorEmail":"String content",
	"ExtraSAN":2147483647,
	"CustomOrderID":"String content",
	"ValidityPeriod":2147483647,
	"AddInstallationSupport":true,
	"EmailLanguageCode":"String content"
}

XML:

<TinyOrderRequest>
<AuthRequest>
<PartnerCode>String content</PartnerCode>
<AuthToken>String content</AuthToken>
<ReplayToken>String content</ReplayToken>
<UserAgent>String content</UserAgent>
</AuthRequest>
<PreferVendorLink>true</PreferVendorLink>
<ProductCode>String content</ProductCode>
<ExtraProductCode>String content</ExtraProductCode>
<ServerCount>2147483647</ServerCount>
<RequestorEmail>String content</RequestorEmail>
<ExtraSAN>2147483647</ExtraSAN>
<CustomOrderID>String content</CustomOrderID>
<ValidityPeriod>2147483647</ValidityPeriod>
<AddInstallationSupport>true</AddInstallationSupport>
<EmailLanguageCode>String content</EmailLanguageCode>
</TinyOrderRequest>

RESPONSE
JSON :

{
	"AuthResponse":{
		"isError":true,
		"Message":["String content"],
		"Timestamp":"String content",
		"ReplayToken":"String content",
		"InvokingPartnerCode":"String content"
	},
	"PartnerOrderID":"String content",
	"CustomOrderID":"String content",
	"TheSSLStoreOrderID":"String content",
	"VendorOrderID":"String content",
	"RefundRequestID":"String content",
	"isRefundApproved":true,
	"TinyOrderLink":"String content",
	"OrderStatus":{
		"isTinyOrder":true,
		"isTinyOrderClaimed":true,
		"MajorStatus":"String content",
		"MinorStatus":"String content"
	},
	"OrderAmount":"String content",
	"CertificateStartDate":"String content",
	"CertificateEndDate":"String content",
	"CommonName":"String content",
	"DNSNames":"String content",
	"State":"String content",
	"Country":"String content",
	"Locality":"String content",
	"Organization":"String content",
	"OrganizationalUnit":"String content",
	"WebServerType":"String content",
	"ApproverEmail":"String content",
	"ProductName":"String content",
	"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"
	},
	"ReissueSuccessCode":"String content"
}

XML:

<OrderResponse>
<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>
<PartnerOrderID>String content</PartnerOrderID>
<CustomOrderID>String content</CustomOrderID>
<TheSSLStoreOrderID>String content</TheSSLStoreOrderID>
<VendorOrderID>String content</VendorOrderID>
<RefundRequestID>String content</RefundRequestID>
<isRefundApproved>true</isRefundApproved>
<TinyOrderLink>String content</TinyOrderLink>
<OrderStatus>
<isTinyOrder>true</isTinyOrder>
<isTinyOrderClaimed>true</isTinyOrderClaimed>
<MajorStatus>String content</MajorStatus>
<MinorStatus>String content</MinorStatus>
</OrderStatus>
<OrderAmount>String content</OrderAmount>
<CertificateStartDate>String content</CertificateStartDate>
<CertificateEndDate>String content</CertificateEndDate>
<CommonName>String content</CommonName>
<DNSNames>String content</DNSNames>
<State>String content</State>
<Country>String content</Country>
<Locality>String content</Locality>
<Organization>String content</Organization>
<OrganizationalUnit>String content</OrganizationalUnit>
<WebServerType>String content</WebServerType>
<ApproverEmail>String content</ApproverEmail>
<ProductName>String content</ProductName>
<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>
<ReissueSuccessCode>String content</ReissueSuccessCode>
</OrderResponse>

Fields Explanation

NAME FROM Type Description
AuthRequest.AuthToken Request String This is an alpha-numeric token code provided to you by thesslstore.com. It is required in all requests.
AuthRequest.PartnerCode Request String This is an alpha-numeric code provided to you by thesslstore.com. It is required in all requests.
AuthRequest.ReplayToken Request String This is an alpha-numeric code provided by you in order request and thesslstore.com sent back in request.
AuthRequest.UserAgent Request String Browser’s user agent value provided by you for specific order.
AuthResponse.InvokingPartnerCode Response String This is an alpha-numeric code provided to you by thesslstore.com.
AuthResponse.isError Response Boolean Return true if any error occurred during Order processing.
AuthResponse.ReplayToken Response String The value of the ReplayToken which provide by you in Order request.
AuthResponse.Timestamp Response String 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).
OrderResponse.CertificateEndDate Response String This is the date the end entity certificate will expire on.
OrderResponse.CertificateStartDate Response String This is the date the end entity certificate or seal will be valid from.
OrderResponse.CommonName Response String This field is part of the subject DN of the end entity certificate and distinguishes the certificate. For an SSL certificate this will most likely be the fully qualified domain name the certificate will be used to secure.
OrderResponse.Country Response String The value of the Country in the ParseCSRResponse
OrderResponse.CustomOrderID Response String A Number provide by you in request which is sent in response.
OrderResponse.DNSNames Response String Additional Domains Name
OrderResponse.isRefundApproved Response Boolean Return true if Refund request approved from thesslstore.com
OrderResponse.Locality Response String The value of the Locality in the ParseOrderResponse.
OrderResponse.OrderAmount Response String Total Order Amount
OrderResponse.Organization Response String The OrganizationalUnit name from the CSR. Up to three comma-separated Ous may be contained in this parameter.
OrderResponse.OrganizationalUnit Response String The OrganizationalUnit name from the CSR. Up to three comma-separated Ous may be contained in this parameter.
OrderResponse.PartnerOrderID Response String A Tracking Number for Orders that can be set by a partner. Typically this would be a partner’s internal order number. When calling one of the initiate order operations this field is optional. If not supplied by the client, a random unique PartnerOrderID is generated by GeoTrust. Certain subsequent operations, such as GetOrderByPartnerOrderID, require this value
OrderResponse.RefundRequestID Response String A Tracking Number for Orders that can be set by a TheSSLStore.com in case of you refund request of order.
OrderResponse.ReissueSuccessCode Response String The value of the Reissue Success Code in the ParseRefund Request Order Response.
OrderResponse.State Response String The value of the State in the ParseCSRResponse
OrderResponse.TheSSLStoreOrderID Response String A Tracking Number for Orders that can be set by a TheSSLStore.com
OrderResponse.TinyOrderLink Response String
OrderResponse.VendorOrderID Response String A Tracking Number for Orders that can be set by a Vendor.
OrderResponse.WebServerType Response String The value of the WebServerType in the ParseOrderResponse.
OrderStatus.isTinyOrder Response Boolean Return true in case of Inviteorder method.
OrderStatus.isTinyOrderClaimed Response Boolean Return true if you processed the TinyOrderLink.
OrderStatus.MajorStatus Response string PENDING – Order is in process. ACTIVE– Order has been completed. CANCELLED – Order has been completed and cancelled. INITIAL : Enrollment link is not claimed yet. EXPIRED – Order has been expired.
OrderStatus.MinorStatus Response string OrderStatusMinor provides specific status information unique to the workflow of the specific product.
TinyOrderRequest.AddInstallationSupport Request string Indicates Purchase Installation Support for this order.
TinyOrderRequest.CustomOrderID Request string A Unique Number Provide by You.
TinyOrderRequest.EmailLanguageCode Request string The language code to be used when sending e-mail messages for this order. (Right now, this is not supported) Default Value is “EN”.
TinyOrderRequest.ExtraProductCode Request string Field Description
TinyOrderRequest.ExtraSAN Request string Allows a partner to add additional numbers of values that a customer can enter in the SAN Field of a certificates
TinyOrderRequest.PreferVendorLink Request string Field Description
TinyOrderRequest.ProductCode Request string A code for the product that a particular request relates to. Note that a partner must have a valid contract for a product code for it to be valid in a request. Also, a product code must be valid for the context of the request.
TinyOrderRequest.RequestorEmail Request string This Email is Requestore EmailID
TinyOrderRequest.ServerCount Request string Number of Server Licenses
TinyOrderRequest.ValidityPeriod Request string Validity Period (in month)

Download Certificate

Purpose
You can download the certificate by passing in required parameters. The format of download is generally a zip file containing certificates. The contents of the zip file are BASE64 encoded.

URL

  • LIVE URL:
https://api.thesslstore.com/rest/order/download
  • SANDBOX URL:
https://sandbox-wbapi.thesslstore.com/rest/order/download

HTTP VERB
POST

PARAMETERS
JSON :

{
	"AuthRequest":{
		"PartnerCode":"String content",
		"AuthToken":"String content",
		"ReplayToken":"String content",
		"UserAgent":"String content"
	},
	"CustomOrderID":"String content",
	"TheSSLStoreOrderID":"String content",
	"ResendEmailType":"String content",
	"RefundReason":"String content",
	"RefundRequestID":"String content"
}

XML:

<OrderRequest>
<AuthRequest>
<PartnerCode>String content</PartnerCode>
<AuthToken>String content</AuthToken>
<ReplayToken>String content</ReplayToken>
<UserAgent>String content</UserAgent>
</AuthRequest>
<CustomOrderID>String content</CustomOrderID>
<TheSSLStoreOrderID>String content</TheSSLStoreOrderID>
<ResendEmailType>String content</ResendEmailType>
<RefundReason>String content</RefundReason>
<RefundRequestID>String content</RefundRequestID>
</OrderRequest>

RESPONSE
JSON:

{
	"AuthResponse":{
		"isError":true,
		"Message":["String content"],
		"Timestamp":"String content",
		"ReplayToken":"String content",
		"InvokingPartnerCode":"String content"
	},
	"PartnerOrderID":"String content",
	"CertificateStartDate":"String content",
	"CertificateEndDate":"String content",
	"CertificateStatus":"String content",
	"ValidationStatus":"String content",
	"Certificates":[{
		"FileName":"String content",
		"FileContent":"String content"
	}]
}

XML:

<DownloadCertificateResponse>
<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>
<PartnerOrderID>String content</PartnerOrderID>
<CertificateStartDate>String content</CertificateStartDate>
<CertificateEndDate>String content</CertificateEndDate>
<CertificateStatus>String content</CertificateStatus>
<ValidationStatus>String content</ValidationStatus>
<Certificates>
<Certificate>
<FileName>String content</FileName>
<FileContent>String content</FileContent>
</Certificate>
<Certificate>
<FileName>String content</FileName>
<FileContent>String content</FileContent>
</Certificate>
</Certificates>
</DownloadCertificateResponse>

Fields Explanation

NAME FROM Type Description
AuthRequest.AuthToken Request String This is an alpha-numeric token code provided to you by thesslstore.com. It is required in all requests.
AuthRequest.PartnerCode Request String This is an alpha-numeric code provided to you by thesslstore.com. It is required in all requests.
AuthRequest.ReplayToken Request String This is an alpha-numeric-code provided by you in order request and thesslstore.com sent back in request.
AuthRequest.UserAgent Request String Browser’s user agent value provided by you for specific order.
AuthResponse.InvokingPartnerCode Response String This is an alpha-numeric code provided to you by thesslstore.com.
AuthResponse.isError Response Boolean Return true if any error occurred during Order processing.
AuthResponse.ReplayToken Response String The value of the ReplayToken which provide by you in Order request.
AuthResponse.Timestamp Response String 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).
Certificate.FileContent Response This is Content regarding download certificate File
Certificate.FileName Response This is Certificate File name
DownloadCertificateResponse.CertificateEndDate Response System.String This is specify Date that Certificate will Expire
DownloadCertificateResponse.CertificateStartDate Response System.String This Date is specify Certificate Active this StartDate
DownloadCertificateResponse.CertificateStatus Response System.String Indicates the status of the end entity certificate ordered.
DownloadCertificateResponse.PartnerOrderID Response System.String PartnerOrderID is you supply at the time of Certificate Generate
DownloadCertificateResponse.ValidationStatus Response System.String DownloadCertificate validation Status like Awaiting , Issued, Revoked, and NO STATUS And Valid
OrderRequest.CustomOrderID Request System.String A Number provide by you in request which is sent in response.
*Required for this request. (Ignore if TheSSLStoreOrderID is passed.)
OrderRequest.RefundReason Request System.String RefundReason is that At time of cancelation Certificate we pass the reason about Cancel Certificate.
OrderRequest.RefundRequestID Request System.String This RefundRequestID about RefundRequest.
OrderRequest.ResendEmailType Request System.String This ResendEmail is Resend an Invite email that was previously extended
OrderRequest.TheSSLStoreOrderID Request System.String A Tracking Number for Orders that can be set by a TheSSLStore.com
*Required for this request.

Order Status

Purpose
Returns the Current Status of the Order. You can also check MajorStatus and MinorStatus for orders with EV products and it will return the current status of the document submission.

URL

  • LIVE URL:
https://api.thesslstore.com/rest/order/status
  • SANDBOX URL:
https://sandbox-wbapi.thesslstore.com/rest/order/status

HTTP VERB
POST

PARAMETERS
JSON :

{
	"AuthRequest":{
		"PartnerCode":"String content",
		"AuthToken":"String content",
		"ReplayToken":"String content",
		"UserAgent":"String content"
	},
	"CustomOrderID":"String content",
	"TheSSLStoreOrderID":"String content",
	"ResendEmailType":"String content",
	"RefundReason":"String content",
	"RefundRequestID":"String content"
}

XML:

<OrderRequest>
<AuthRequest>
<PartnerCode>String content</PartnerCode>
<AuthToken>String content</AuthToken>
<ReplayToken>String content</ReplayToken>
<UserAgent>String content</UserAgent>
</AuthRequest>
<CustomOrderID>String content</CustomOrderID>
<TheSSLStoreOrderID>String content</TheSSLStoreOrderID>
<ResendEmailType>String content</ResendEmailType>
<RefundReason>String content</RefundReason>
<RefundRequestID>String content</RefundRequestID>
</OrderRequest>

RESPONSE
JSON :

{
	"AuthResponse":{
		"isError":true,
		"Message":["String content"],
		"Timestamp":"String content",
		"ReplayToken":"String content",
		"InvokingPartnerCode":"String content"
	},
	"PartnerOrderID":"String content",
	"CustomOrderID":"String content",
	"TheSSLStoreOrderID":"String content",
	"VendorOrderID":"String content",
	"RefundRequestID":"String content",
	"isRefundApproved":true,
	"TinyOrderLink":"String content",
	"OrderStatus":{
		"isTinyOrder":true,
		"isTinyOrderClaimed":true,
		"MajorStatus":"String content",
		"MinorStatus":"String content"
	},
	"OrderAmount":"String content",
	"CertificateStartDate":"String content",
	"CertificateEndDate":"String content",
	"CommonName":"String content",
	"DNSNames":"String content",
	"State":"String content",
	"Country":"String content",
	"Locality":"String content",
	"Organization":"String content",
	"OrganizationalUnit":"String content",
	"WebServerType":"String content",
	"ApproverEmail":"String content",
	"ProductName":"String content",
	"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"
	},
	"ReissueSuccessCode":"String content"
}

XML:

<OrderResponse>
<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>
<PartnerOrderID>String content</PartnerOrderID>
<CustomOrderID>String content</CustomOrderID>
<TheSSLStoreOrderID>String content</TheSSLStoreOrderID>
<VendorOrderID>String content</VendorOrderID>
<RefundRequestID>String content</RefundRequestID>
<isRefundApproved>true</isRefundApproved>
<TinyOrderLink>String content</TinyOrderLink>
<OrderStatus>
<isTinyOrder>true</isTinyOrder>
<isTinyOrderClaimed>true</isTinyOrderClaimed>
<MajorStatus>String content</MajorStatus>
<MinorStatus>String content</MinorStatus>
</OrderStatus>
<OrderAmount>String content</OrderAmount>
<CertificateStartDate>String content</CertificateStartDate>
<CertificateEndDate>String content</CertificateEndDate>
<CommonName>String content</CommonName>
<DNSNames>String content</DNSNames>
<State>String content</State>
<Country>String content</Country>
<Locality>String content</Locality>
<Organization>String content</Organization>
<OrganizationalUnit>String content</OrganizationalUnit>
<WebServerType>String content</WebServerType>
<ApproverEmail>String content</ApproverEmail>
<ProductName>String content</ProductName>
<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>
<ReissueSuccessCode>String content</ReissueSuccessCode>
</OrderResponse>

Fields Explanation

NAME FROM Type Description
AuthRequest.AuthToken Request String This is an alpha-numeric code provided to you by thesslstore.com. It is required in all requests.
*Required for this request
AuthRequest.PartnerCode Request String This is an alpha-numeric token code provided to you by thesslstore.com. It is required in all requests.
*Required for this request
AuthRequest.ReplayToken Request String This is an alpha-numeric code provided by you in order request and thesslstore.com sent back in request.
AuthRequest.UserAgent Request String Browser’s user agent value provided by you for specific order.
OrderRequest.CustomOrderID Request String A Unique Number Provide by You.
*Required for this request (ignore if you passed ThesslstoreOrderID)
OrderRequest.RefundReason Request String This RefundReason is Reason regarding Purchased Certificate Cancel.
OrderRequest.RefundRequestID Request String This RefundRequestID about RefundRequest.
OrderRequest.ResendEmailType Request String This ResendEmail is Resend an Invite email that was previously extended
OrderRequest.TheSSLStoreOrderID Request String A Tracking Number for Orders that can be set by a TheSSLStore.com
*Required for this request (Ignore if you passed CustomOrderID)
AuthResponse.InvokingPartnerCode Response string This is an alpha-numeric code provided to you by thesslstore.com. It is required in all requests.
AuthResponse.isError Response string Returns False/true according to errorstatus into the response.
AuthResponse.ReplayToken Response string The value of the ReplayToken which provide by you in Order request
AuthResponse.Timestamp Response Date The Date and time when user gets the response.
OrderResponse.CertificateEndDate Response String This is the date the end entity certificate will expire on.
OrderResponse.CertificateStartDate Response String This is the date the end entity certificate or seal will be valid from.
OrderResponse.CommonName Response String This field is part of the subject DN of the end entity certificate and distinguishes the certificate. For an SSL certificate this will most likely be the fully qualified domain name the certificate will be used to secure.
OrderResponse.Country Response String The value of the Country in the ParseCSRResponse
OrderResponse.CustomOrderID Response String A Number provide by you in request which is sent in response.
OrderResponse.DNSNames Response String Additional Domains Name
OrderResponse.isRefundApproved Response Boolean Return true if Refund request approved from thesslstore.com
OrderResponse.Locality Response String The value of the Locality in the ParseOrderResponse.
OrderResponse.OrderAmount Response String Total Order Amount
OrderResponse.Organization Response String The OrganizationalUnit name from the CSR. Up to three comma-separated Ous may be contained in this parameter.
OrderResponse.OrganizationalUnit Response String The OrganizationalUnit name from the CSR. Up to three comma-separated Ous may be contained in this parameter.
OrderResponse.PartnerOrderID Response String A Tracking Number for Orders that can be set by a partner. Typically this would be a partner’s internal order number. When calling one of the initiate order operations this field is optional. If not supplied by the client, a random unique PartnerOrderID is generated by GeoTrust. Certain subsequent operations, such as GetOrderByPartnerOrderID, require this value
OrderResponse.RefundRequestID Response String A Tracking Number for Orders that can be set by a TheSSLStore.com in case of you request a refund of an order.
OrderResponse.ReissueSuccessCode Response String The value of the Reissue Success Code in the ParseRefund Request Order Response.
OrderResponse.State Response String The value of the State in the ParseCSRResponse
OrderResponse.TheSSLStoreOrderID Response String A Tracking Number for Orders that can be set by a TheSSLStore.com
OrderResponse.TinyOrderLink Response String
OrderResponse.VendorOrderID Response String A Tracking Number for Orders that can be set by a Vendor.
OrderResponse.WebServerType Response String The value of the WebServerType in the ParseOrderResponse.
OrderStatus.isTinyOrder Response String Return true in case of Inviteorder method.
OrderStatus.isTinyOrderClaimed Response String Return true if you processed the TinyOrderLink.
OrderStatus.MajorStatus Response String PENDING – Order is in process. ACTIVE– Order has been completed. CANCELLED – Order has been completed and cancelled. INITIAL : Enrollment link is not claimed yet. EXPIRED – Order has been expired.
OrderStatus.MinorStatus Response String OrderStatusMinor provides specific status information unique to the workflow of the specific product.
AdminContact. FirstName Request string This is first name of admin contact of your order.
AdminContact. LastName Response string This is Last name of admin contact of your order.
AdminContact. Phone Response string This is Phone no of admin contact of your order.
AdminContact. Fax Response string This is Fax No of admin contact of your order.
AdminContact. Email Response string This is Email of admin contact of your order.
AdminContact. Title Response string This is CertificateTitle of admin contact of your order.
AdminContact. OrganizationName Response string This is OrganizationName of admin contact of your order.
AdminContact. AddressLine1 Response string This is Address of admin contact of your order.
AdminContact. AddressLine2 Response string This is Address of admin contact of your order.
AdminContact. City Response string This is City of admin contact of your order.
AdminContact. Region Request string This is Region of admin contact of your order.
AdminContact. PostalCode Request string This is Postalcode of admin contact of your order.
AdminContact.Country Request string This is Country of admin contact of your order.
TechnicalContact.FirstName Request string This is First name of technical contact of your order.
TechnicalContact.LastName Request string This is Last name of technical contact of your order.
TechnicalContact.Phone Request string This is Phone no of technical contact of your order.
TechnicalContact.Fax Request string This is Fax No of technical contact of your order.
TechnicalContact.Email Request string This is Email of technical contact of your order.
TechnicalContact.Title Request string This is Title of technical contact of your order.
TechnicalContact.OrganizationName Request string This is OrganizationName of technical contact of your order.
TechnicalContact.AddressLine1 Request string This is Address of technical contact of your order.
TechnicalContact.AddressLine2 Request string This is Address of technical contact of your order.
TechnicalContact.City Request string This is City of technical contact of your order.
TechnicalContact.Region Request string This is Region of technical contact of your order.
TechnicalContact.PostalCode Request string This is Postalcode of technical contact of your order.
TechnicalContact.Country Request string This is Country of technical contact of your order.

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, so as to minimize any errors during New Order transactions.

URL

  • LIVE URL:
https://api.thesslstore.com/rest/order/validate
  • SANDBOX URL:
https://sandbox-wbapi.thesslstore.com/rest/order/validate

HTTP VERB
POST

PARAMETERS
JSON :

{
	"AuthRequest":{
		"PartnerCode":"String content",
		"AuthToken":"String content",
		"ReplayToken":"String content",
		"UserAgent":"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"
}

XML:

<NewOrderRequest>
<AuthRequest>
<PartnerCode>String content</PartnerCode>
<AuthToken>String content</AuthToken>
<ReplayToken>String content</ReplayToken>
<UserAgent>String content</UserAgent>
</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>
</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

NAME FROM Type Description
AuthRequest.AuthToken Request string This is an alpha-numeric token code provided to you by thesslstore.com. It is required in all requests.
*Required for this request
AuthRequest.PartnerCode Request string This is an alpha-numeric code provided to you by thesslstore.com. It is required in all requests.
*Required for this request
AuthRequest.ReplayToken Request string This is an alpha-numeric code provided by you in order request and thesslstore.com sent back in request.
AuthRequest.UserAgent Request string Browser’s user agent value provided by you for specific order.
NewOrderRequest.AddInstallationSupport Request Boolean Indicates Purchase Installation Support for this order.
NewOrderRequest.ApproverEmail Request string This is the email of the Approver – in the Domain vetted line of products this is the person responsible for approving the order.
NewOrderRequest.CSR Request string Certificate Signing Request (Base-64 encoded, with or without the —–BEGIN xxxxx—– and —–END xxxxx—– header and footer)
*Required for this request
NewOrderRequest.CustomOrderID Request string A Unique Number Provide by You.
NewOrderRequest.DomainName Request 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).
NewOrderRequest.EmailLanguageCode Request 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 string Field Description
NewOrderRequest.isCUOrder Request Boolean The IsCUOrder is the validated CU results for a specified order.
NewOrderRequest.isRenewalOrder Request Boolean Indicates that this order is a renewal order.
NewOrderRequest.isTrialOrder Request Boolean Indicates that this order is a Trial order.
NewOrderRequest.ProductCode Request string A code for the product that a particular request relates to. Note that a partner must have a valid contract for a product code for it to be valid in a request. Also, a product code must be valid for the context of the request.
*Required for this request
NewOrderRequest.RelatedTheSSLStoreOrderID Request string Provide Old Order’s TheSSLStoreOrderID in Case of Renewal Order.
NewOrderRequest.ReserveSANCount Request string Allows a partner to limit the number of values that a customer can enter in the sAN Field of a certificates
NewOrderRequest.ServerCount Request string Number of Server Licenses
*Required for this request
NewOrderRequest.SpecialInstructions Request string Special Instructions for the order
NewOrderRequest.ValidityPeriod Request string Validity Period (in month)
*Required for this request
NewOrderRequest.WebServerType Request string This is from the OrderParameters structure. Designates the type of web server that an order is targeted for.
*Required for this request
OrganisationInfo.Division Request string The OrganizationalUnit name from the CSR. Up to three comma-separated Ous may be contained in this parameter.
OrganisationInfo.DUNS Request string The Dunn and Bradstreet number for a company
OrganisationInfo.IncorporatingAgency Request string Incorporating Agency Name
OrganisationInfo.JurisdictionCity Request string Jurisdiction City Name
OrganisationInfo.JurisdictionCountry Request string Jurisdiction of Incorporation: Country
OrganisationInfo.JurisdictionRegion Request string Jurisdiction Region Name
OrganisationInfo.OrganizationName Request string The name of the Organization applying for the product. This applies to Organization Vetted products.
OrganisationInfo.RegistrationNumber Request string Company Registration Number
OrganizationAddress.AddressLine1 Request string Organization Street AddressLine1
OrganizationAddress.AddressLine2 Request string Organization Street AddressLine2
OrganizationAddress.AddressLine3 Request string Organization Street AddressLine3
OrganizationAddress.City Request string Organization City Name
OrganizationAddress.Country Request string Organization Country Name
OrganizationAddress.Fax Request string Organization Fax Number
OrganizationAddress.LocalityName Request string The Locality field from the CSR or Certificate
OrganizationAddress.Phone Request string Organization Phone Number
OrganizationAddress.PostalCode Request string Organization Postal Code
OrganizationAddress.Region Request string Organization Region Name
TechnicalContact.AddressLine1 Request string Technical Contact Street AddressLine1
TechnicalContact.AddressLine2 Request string Technical Contact Street AddressLine1
TechnicalContact.City Request string Technical Contact City Name
TechnicalContact.Country Request string Technical Contact Country Name
TechnicalContact.Email Request string Technical Contact Email Address.
TechnicalContact.Fax Request string Technical Contact Fax Number.
TechnicalContact.FirstName Request string Technical Contact First Name.
TechnicalContact.LastName Request string Technical Contact Last Name.
TechnicalContact.OrganizationName Request string Technical Contact Organization Name.
TechnicalContact.Phone Request string Technical Contact Phone Number.
TechnicalContact.PostalCode Request string Technical Contact Postal Code
TechnicalContact.Region Request string Technical Contact Region Name
TechnicalContact.Title Request string Technical Contact Person’s title.
AuthResponse.isError Response string Returns False/true according to errorstatus into the response.
AuthResponse.Message Response string The Message given into the response.
AuthResponse.Timestamp Response Date The Date and time when user gets the response.
AuthResponse.ReplayToken Response string The value of the ReplayToken which provide by you in Order request
AuthResponse.InvokingPartnerCode Response string This is an alpha-numeric code provided to you by thesslstore.com. It is required in all requests.
AdminContact.AddressLine1 Request string Admin Contact Street AddressLine1
AdminContact.AddressLine2 Request string Admin Contact Street AddressLine1
AdminContact.City Request string Admin Contact City Name
AdminContact.Country Request string Admin Contact Country Name
AdminContact.Email Request string Admin Contact Email Address.
AdminContact.Fax Request string Admin Contact Fax Number.
AdminContact.FirstName Request string Admin Contact First Name.
AdminContact.LastName Request string Admin Contact Last Name.
AdminContact.OrganizationName Request string Admin Contact Organization Name.
AdminContact.Phone Request string Admin Contact Phone Number.
AdminContact.PostalCode Request string Admin Contact Postal Code
AdminContact.Region Request string Admin Contact Region Name
AdminContact.Title Request string Admin Contact Person’s title.

Query Order

Purpose
At any time you can query your orders by specified parameters. Our Query syntax also supports ODATA format query so you can even query based on some parameters. For help regarding Odata syntax, please see http://www.odata.org/developers/protocols/uri-conventions#FilterSystemQueryOption. You can put filters on every field that is available in “Response” section of the Field Explanation section. For example, you can find a certificate for a domain name OR orders from a specific country and so on!

URL

  • LIVE URL:
https://api.thesslstore.com/rest/order/query
  • SANDBOX URL:
https://sandbox-wbapi.thesslstore.com/rest/order/query

HTTP VERB
POST

PARAMETERS
JSON :

{
	"AuthRequest":{
		"PartnerCode":"String content",
		"AuthToken":"String content",
		"ReplayToken":"String content",
		"UserAgent":"String content"
	},
	"StartDate":"\/Date(928129800000+0530)\/",
	"EndDate":"\/Date(928129800000+0530)\/",
	"SubUserID":"String content",
	"ProductCode":"String content"
}

XML:

<OrderQueryRequest>
<AuthRequest>
<PartnerCode>String content</PartnerCode>
<AuthToken>String content</AuthToken>
<ReplayToken>String content</ReplayToken>
<UserAgent>String content</UserAgent>
</AuthRequest>
<StartDate>1999-05-31T11:20:00</StartDate>
<EndDate>1999-05-31T11:20:00</EndDate>
<SubUserID>String content</SubUserID>
<ProductCode>String content</ProductCode>
</OrderQueryRequest>

PARAMETERS
JSON :

{
	"AuthResponse":{
		"isError":true,
		"Message":["String content"],
		"Timestamp":"String content",
		"ReplayToken":"String content",
		"InvokingPartnerCode":"String content"
	},
	"PartnerOrderID":"String content",
	"CustomOrderID":"String content",
	"TheSSLStoreOrderID":"String content",
	"VendorOrderID":"String content",
	"RefundRequestID":"String content",
	"isRefundApproved":true,
	"TinyOrderLink":"String content",
	"OrderStatus":{
		"isTinyOrder":true,
		"isTinyOrderClaimed":true,
		"MajorStatus":"String content",
		"MinorStatus":"String content"
	},
	"OrderAmount":"String content",
	"CertificateStartDate":"String content",
	"CertificateEndDate":"String content",
	"CommonName":"String content",
	"DNSNames":"String content",
	"State":"String content",
	"Country":"String content",
	"Locality":"String content",
	"Organization":"String content",
	"OrganizationalUnit":"String content",
	"WebServerType":"String content",
	"ReissueSuccessCode":"String content"
}

XML:

<OrderResponse>
<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>
<PartnerOrderID>String content</PartnerOrderID>
<CustomOrderID>String content</CustomOrderID>
<TheSSLStoreOrderID>String content</TheSSLStoreOrderID>
<VendorOrderID>String content</VendorOrderID>
<RefundRequestID>String content</RefundRequestID>
<isRefundApproved>true</isRefundApproved>
<TinyOrderLink>String content</TinyOrderLink>
<OrderStatus>
<isTinyOrder>true</isTinyOrder>
<isTinyOrderClaimed>true</isTinyOrderClaimed>
<MajorStatus>String content</MajorStatus>
<MinorStatus>String content</MinorStatus>
</OrderStatus>
<OrderAmount>String content</OrderAmount>
<CertificateStartDate>String content</CertificateStartDate>
<CertificateEndDate>String content</CertificateEndDate>
<CommonName>String content</CommonName>
<DNSNames>String content</DNSNames>
<State>String content</State>
<Country>String content</Country>
<Locality>String content</Locality>
<Organization>String content</Organization>
<OrganizationalUnit>String content</OrganizationalUnit>
<WebServerType>String content</WebServerType>
<ReissueSuccessCode>String content</ReissueSuccessCode>
</OrderResponse>

Fields Explanation

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

*Required for this request.
AuthRequest.PartnerCode Request String This is an alpha-numeric code provided to you by thesslstore.com. It is required in all requests.

*Required for this request.
AuthRequest.ReplayToken Request String This is an alpha-numeric code provided by you in order request and thesslstore.com sent back in request.
AuthRequest.UserAgent Request String Browser’s user agent value provided by you for specific order.
OrderQueryRequest.EndDate Request String This is the End date that specify the order till date
OrderQueryRequest.ProductCode Request String This Product Code that you pass in query
OrderQueryRequest.StartDate Request String This is the start date specify the order date
OrderQueryRequest.SubUserID Request String SubuserID we pass In query which we to get Data perticular Subuser’s ID
OrderResponse.CertificateEndDate Response string This is the date the end entity certificate will expire on.
OrderResponse.CertificateStartDate Response string This is the date the end entity certificate or seal will be valid from.
OrderResponse.CommonName Response string This field is part of the subject DN of the end entity certificate and distinguishes the certificate. For an SSL certificate this will most likely be the fully qualified domain name the certificate will be used to secure.
OrderResponse.Country Response string The value of the Country in the ParseCSRResponse
OrderResponse.CustomOrderID Response string A Number provide by you in request which is sent in response.
OrderResponse.DNSNames Response string Additional Domains Name
OrderResponse.isRefundApproved Response Boolean Return true if Refund request approved from thesslstore.com
OrderResponse.Locality Response string The value of the Locality in the ParseOrderResponse.
OrderResponse.OrderAmount Response string Total Order Amount
OrderResponse.Organization Response string The OrganizationalUnit name from the CSR. Up to three comma-separated Ous may be contained in this parameter.
OrderResponse.OrganizationalUnit Response string The OrganizationalUnit name from the CSR. Up to three comma-separated Ous may be contained in this parameter.
OrderResponse.PartnerOrderID Response string A Tracking Number for Orders that can be set by a partner. Typically this would be a partner’s internal order number. When calling one of the initiate order operations this field is optional. If not supplied by the client, a random unique PartnerOrderID is generated by GeoTrust. Certain subsequent operations, such as GetOrderByPartnerOrderID, require this value
OrderResponse.RefundRequestID Response string A Tracking Number for Orders that can be set by a TheSSLStore.com in case of you refund request of order.
OrderResponse.ReissueSuccessCode Response string The value of the Reissue Success Code in the ParseRefund Request Order Response.
OrderResponse.State Response string The value of the State in the ParseCSRResponse
OrderResponse.TheSSLStoreOrderID Response string A Tracking Number for Orders that can be set by a TheSSLStore.com
OrderResponse.TinyOrderLink Response string Field Description
OrderResponse.VendorOrderID Response string A Tracking Number for Orders that can be set by a Vendor.
OrderResponse.WebServerType Response string The value of the WebServerType in the ParseOrderResponse.
OrderStatus.isTinyOrder Response Boolean Return true in case of Inviteorder method.
OrderStatus.isTinyOrderClaimed Response Boolean Return true if you processed the TinyOrderLink.
OrderStatus.MajorStatus Response string PENDING – Order is in process. ACTIVE– Order has been completed. CANCELLED – Order has been completed and cancelled. INITIAL : Enrollment link is not claimed yet. EXPIRED – Order has been expired.
OrderStatus.MinorStatus Response string OrderStatusMinor provides specific status information unique to the workflow of the specific product.

Re-Issue

Purpose
To re-issue certificates, you need to call Re-Issue action. Re-Issue is used in scenarios where you want to change the certificate after it’s issued (e.g., to add additional servers, or additional Alternative names etc to the cert). You can also call re-issue during certificate life-time, if you have lost access to original certificate.

URL

  • LIVE URL:
https://api.thesslstore.com/rest/order/reissue
  • SANDBOX URL:
https://sandbox-wbapi.thesslstore.com/rest/order/reissue

HTTP VERB
POST

PARAMETERS
JSON :

{
	"AuthRequest":{
		"PartnerCode":"String content",
		"AuthToken":"String content",
		"ReplayToken":"String content",
		"UserAgent":"String content"
	},
	"TheSSLStoreOrderID":"String content",
	"CSR":"String content",
	"WebServerType":"String content",
	"DNSNames":["String content"],
	"isRenewalOrder":true,
	"SpecialInstructions":"String content",
	"EditSAN":[{
		"OldValue":"String content",
		"NewValue":"String content"
	}],
	"DeleteSAN":[{
		"OldValue":"String content",
		"NewValue":"String content"
	}],
	"AddSAN":[{
		"OldValue":"String content",
		"NewValue":"String content"
	}],
	"isWildCard":true,
	"ReissueEmail":"String content"
}

XML:

<ReissueOrderRequest>
<AuthRequest>
<PartnerCode>String content</PartnerCode>
<AuthToken>String content</AuthToken>
<ReplayToken>String content</ReplayToken>
<UserAgent>String content</UserAgent>
</AuthRequest>
<TheSSLStoreOrderID>String content</TheSSLStoreOrderID>
<CSR>String content</CSR>
<WebServerType>String content</WebServerType>
<DNSNames>
<string>String content</string>
<string>String content</string>
</DNSNames>
<isRenewalOrder>true</isRenewalOrder>
<SpecialInstructions>String content</SpecialInstructions>
<EditSAN>
<Pair>
<OldValue>String content</OldValue>
<NewValue>String content</NewValue>
</Pair>
<Pair>
<OldValue>String content</OldValue>
<NewValue>String content</NewValue>
</Pair>
</EditSAN>
<DeleteSAN>
<Pair>
<OldValue>String content</OldValue>
<NewValue>String content</NewValue>
</Pair>
<Pair>
<OldValue>String content</OldValue>
<NewValue>String content</NewValue>
</Pair>
</DeleteSAN>
<AddSAN>
<Pair>
<OldValue>String content</OldValue>
<NewValue>String content</NewValue>
</Pair>
<Pair>
<OldValue>String content</OldValue>
<NewValue>String content</NewValue>
</Pair>
</AddSAN>
<isWildCard>true</isWildCard>
<ReissueEmail>String content</ReissueEmail>
</ReissueOrderRequest>

RESPONSE
JSON :

{
	"AuthResponse":{
		"isError":true,
		"Message":["String content"],
		"Timestamp":"String content",
		"ReplayToken":"String content",
		"InvokingPartnerCode":"String content"
	},
	"PartnerOrderID":"String content",
	"CustomOrderID":"String content",
	"TheSSLStoreOrderID":"String content",
	"VendorOrderID":"String content",
	"RefundRequestID":"String content",
	"isRefundApproved":true,
	"TinyOrderLink":"String content",
	"OrderStatus":{
		"isTinyOrder":true,
		"isTinyOrderClaimed":true,
		"MajorStatus":"String content",
		"MinorStatus":"String content"
	},
	"OrderAmount":"String content",
	"CertificateStartDate":"String content",
	"CertificateEndDate":"String content",
	"CommonName":"String content",
	"DNSNames":"String content",
	"State":"String content",
	"Country":"String content",
	"Locality":"String content",
	"Organization":"String content",
	"OrganizationalUnit":"String content",
	"WebServerType":"String content",
	"ApproverEmail":"String content",

	"ProductName":"String content",
	"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"
	},
	"ReissueSuccessCode":"String content"
}

XML:

<OrderResponse>
<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>
<PartnerOrderID>String content</PartnerOrderID>
<CustomOrderID>String content</CustomOrderID>
<TheSSLStoreOrderID>String content</TheSSLStoreOrderID>
<VendorOrderID>String content</VendorOrderID>
<RefundRequestID>String content</RefundRequestID>
<isRefundApproved>true</isRefundApproved>
<TinyOrderLink>String content</TinyOrderLink>
<OrderStatus>
<isTinyOrder>true</isTinyOrder>
<isTinyOrderClaimed>true</isTinyOrderClaimed>
<MajorStatus>String content</MajorStatus>
<MinorStatus>String content</MinorStatus>
</OrderStatus>
<OrderAmount>String content</OrderAmount>
<CertificateStartDate>String content</CertificateStartDate>
<CertificateEndDate>String content</CertificateEndDate>
<CommonName>String content</CommonName>
<DNSNames>String content</DNSNames>
<State>String content</State>
<Country>String content</Country>
<Locality>String content</Locality>
<Organization>String content</Organization>
<OrganizationalUnit>String content</OrganizationalUnit>
<WebServerType>String content</WebServerType>
<ApproverEmail>String content</ApproverEmail>
<ProductName>String content</ProductName>
<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>
<ReissueSuccessCode>String content</ReissueSuccessCode>
</OrderResponse>

Fields Explanation

NAME FROM Type Description
AuthRequest.AuthToken Request System.String This is an alpha-numeric token code provided to you by thesslstore.com. It is required in all requests.
*Required for this request
AuthRequest.PartnerCode Request System.String This is an alpha-numeric code provided to you by thesslstore.com. It is required in all requests.
*Required for this request
AuthRequest.ReplayToken Request System.String This is an alpha-numeric code provided by you in order request and thesslstore.com sent back in request.
*Required for this request
AuthRequest.UserAgent Request System.String Browser’s user agent value provided by you for specific order.
Pair.AddSAN. NewValue Request System.String Add new SAN name.
Pair.AddSAN. OldValue Request System.String Ignore if passed
Pair.DeleteSAN.NewValue Request System.String Deleted San name.
Pair.DeleteSAN.OldValue System.String DIgnore if passed
Pair.EditSAN.OldValue Request string dns-name-to-change
Pair.EditSAN.NewValue Request string dns-name-new-value
ReissueOrderRequest.CSR Request string Certificate Signing Request (Base-64 encoded, with or without the —–BEGIN xxxxx—– and —–END xxxxx—– header and footer)

*Required for this request
ReissueOrderRequest.isRenewalOrder Request Boolean This specifies if this Order is a Renewal or not
ReissueOrderRequest.isWildCard Request string This specifies if this Order is a wildcard Certificate.
*Passed true for Wildcard Certificates
ReissueOrderRequest.TheSSLStoreOrderID Request string A Tracking Number for Orders that can be set by a TheSSLStore.com

*Required for this request.
ReissueOrderRequest.ReissueEmail Request string This reissue email specifies which email

*Required for this request
ReissueOrderRequest.SpecialInstructions Request string Special Instructions for the order
ReissueOrderRequest.WebServerType Request string The value of the WebServerType in the ParseOrderResponse.

*Required for this request
AuthResponse.InvokingPartnerCode Response System.String This is an alpha-numeric code provided to you by thesslstore.com.
AuthResponse.isError Response Boolean Return true if any error occurred during Order processing.
AuthResponse.ReplayToken Response string The value of the ReplayToken which provide by you in Order request.
AuthResponse.Timestamp Response string 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).
OrderResponse.CertificateEndDate Response string This is the date the end entity certificate will expire on.
OrderResponse.CertificateStartDate Response string This is the date the end entity certificate or seal will be valid from.
OrderResponse.CommonName Response string This field is part of the subject DN of the end entity certificate and distinguishes the certificate. For an SSL certificate this will most likely be the fully qualified domain name the certificate will be used to secure.
OrderResponse.Country Response string The value of the Country in the ParseCSRResponse
OrderResponse.CustomOrderID Response string A Number provide by you in request which is sent in response.
OrderResponse.DNSNames Response string Additional Domains Name
OrderResponse.isRefundApproved Response Boolean Return true if Refund request approved from thesslstore.com
OrderResponse.Locality Response string The value of the Locality in the ParseOrderResponse.
OrderResponse.OrderAmount Response string Total Order Amount
OrderResponse.Organization Response string The OrganizationalUnit name from the CSR. Up to three comma-separated Ous may be contained in this parameter.
OrderResponse.OrganizationalUnit Response string The OrganizationalUnit name from the CSR. Up to three comma-separated Ous may be contained in this parameter.
OrderResponse.TheSSLStoreOrderID Response string A Tracking Number for Orders that can be set by a TheSSLStore.com
OrderResponse.RefundRequestID Response string A Tracking Number for Orders that can be set by a TheSSLStore.com in case you request a refund of an order.
OrderResponse.ReissueSuccessCode Response string The value of the Reissue Success Code in the ParseRefund Request Order Response.
OrderResponse.State Response string The value of the State in the ParseCSRResponse
OrderResponse.TheSSLStoreOrderID Response string A Tracking Number for Orders that can be set by a TheSSLStore.com
OrderResponse.TinyOrderLink Response string Field Description
OrderResponse.VendorOrderID Response string A Tracking Number for Orders that can be set by a Vendor.
OrderResponse.WebServerType Response string The value of the WebServerType in the ParseOrderResponse.
OrderStatus.isTinyOrder Response Boolean Return true in case of Inviteorder method.
OrderStatus.isTinyOrderClaimed Response Boolean Return true if you processed the TinyOrderLink.
OrderStatus.MajorStatus Response string PENDING – Order is in process. ACTIVE– Order has been completed. CANCELLED – Order has been completed and cancelled. INITIAL : Enrollment link is not claimed yet. EXPIRED – Order has been expired.
OrderStatus.MinorStatus Response string OrderStatusMinor provides specific status information unique to the workflow of the specific product.
AdminContact. FirstName Request string This is first name of admin contact of your order.
AdminContact. LastName Response string This is Last name of admin contact of your order.
AdminContact. Phone Response string This is Phone no of admin contact of your order.
AdminContact. Fax Response string This is Fax No of admin contact of your order.
AdminContact. Email Response string This is Email of admin contact of your order.
AdminContact. Title Response string This is CertificateTitle of admin contact of your order.
AdminContact. OrganizationName Response string This is OrganizationName of admin contact of your order.
AdminContact. AddressLine1 Response string This is Address of admin contact of your order.
AdminContact. AddressLine2 Response string This is Address of admin contact of your order.
AdminContact. City Response string This is City of admin contact of your order.
AdminContact. Region Request string This is Region of admin contact of your order.
AdminContact. PostalCode Request string This is Postalcode of admin contact of your order.
AdminContact.Country Request string This is Country of admin contact of your order.
TechnicalContact.FirstName Request string This is First name of technical contact of your order.
TechnicalContact.LastName Request string This is Last name of technical contact of your order.
TechnicalContact.Phone Request string This is Phone no of technical contact of your order.
TechnicalContact.Fax Request string This is Fax No of technical contact of your order.
TechnicalContact.Email Request string This is Email of technical contact of your order.
TechnicalContact.Title Request string This is Title of technical contact of your order.
TechnicalContact.OrganizationName Request string This is OrganizationName of technical contact of your order.
TechnicalContact.AddressLine1 Request string This is Address of technical contact of your order.
TechnicalContact.AddressLine2 Request string This is Address of technical contact of your order.
TechnicalContact.City Request string This is City of technical contact of your order.
TechnicalContact.Region Request string This is Region of technical contact of your order.
TechnicalContact.PostalCode Request string This is Postalcode of technical contact of your order.
TechnicalContact.Country Request string This is Country of technical contact of your order.

Approves List

Purpose
For each certificate, there are limits to which email addresses can be accepted as “Approver Email”. This is the email that receives emails by the Vendors asking for their explicit permission to Approve the order. By Passing the parameters, you can get a list of such allowed email addresses. This is a must to complete the Certificate enrollment process.

URL

  • LIVE URL:
https://api.thesslstore.com/rest/order/approverlist
  • SANDBOX URL:
https://sandbox-wbapi.thesslstore.com/rest/order/approverlist/csr

HTTP VERB
POST

PARAMETERS
JSON :

{
	"AuthRequest":{
		"PartnerCode":"String content",
		"AuthToken":"String content",
		"ReplayToken":"String content",
		"UserAgent":"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"
}

XML:

<NewOrderRequest>
<AuthRequest>
<PartnerCode>String content</PartnerCode>
<AuthToken>String content</AuthToken>
<ReplayToken>String content</ReplayToken>
<UserAgent>String content</UserAgent>
</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>
</NewOrderRequest>

RESPONSE
Json:

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

XML:

<ApproverEmailListResponse>
<ApproverEmailList>
<string>String content</string>
<string>String content</string>
</ApproverEmailList>
<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>
</ApproverEmailListResponse>

Fields Explanation

NAME FROM Type Description
AdminContact.AddressLine1 Request string Admin Contact Street AddressLine1
AdminContact.AddressLine2 Request string Admin Contact Street AddressLine2
AdminContact.City Request string Admin Contact City Name
AdminContact.Country Request string Admin Contact Country Name
AdminContact.Email Request string Admin Contact Email Address.
AdminContact.Fax Request string Admin Contact Fax Number.
AdminContact.FirstName Request string Admin Contact First Name.
AdminContact.LastName Request string Admin Contact Last Name.
AdminContact.OrganizationName Request string Admin Contact Organization Name.
AdminContact.Phone Request string Admin Contact Phone Number.
AdminContact.PostalCode Request string Admin Contact Postal Code
AdminContact.Region Request string Admin Contact Region Name
AdminContact.Title Request string Admin Contact Person’s title.
AuthRequest.AuthToken Request string This is an alpha-numeric token code provided to you by thesslstore.com. It is required in all requests.
AuthRequest.PartnerCode Request string This is an alpha-numeric code provided to you by thesslstore.com. It is required in all requests.
AuthRequest.ReplayToken Request string This is an alpha-numeric code provided by you in order request and thesslstore.com sent back in request.
AuthRequest.UserAgent Request string Browser’s user agent value provided by you for specific order.
NewOrderRequest.AddInstallationSupport Request Boolean Indicates Purchase Installation Support for this order.
NewOrderRequest.ApproverEmail Request string This is the email of the Approver – in the Domain vetted line of products this is the person responsible for approving the order.
NewOrderRequest.CSR Request String Certificate Signing Request (Base-64 encoded, with or without the —–BEGIN xxxxx—– and —–END xxxxx—– header and footer)
NewOrderRequest.CustomOrderID Request String A Unique Number Provide by You.
NewOrderRequest.DomainName Request 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).
NewOrderRequest.EmailLanguageCode Request 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 String Coma separated product code for free products
NewOrderRequest.isCUOrder Request Boolean The IsCUOrder is the validated CU results for a specified order.
NewOrderRequest.isRenewalOrder Request Boolean Indicates that this order is a renewal order.
NewOrderRequest.isTrialOrder Request Boolean Indicates that this order is a Trial order.
NewOrderRequest.ProductCode Request String A code for the product that a particular request relates to. Note that a partner must have a valid contract for a product code for it to be valid in a request. Also, a product code must be valid for the context of the request.
NewOrderRequest.RelatedTheSSLStoreOrderID Request string Provide Old Order’s TheSSLStoreOrderID in Case of Renewal Order.
NewOrderRequest.ReserveSANCount Request string Allows a partner to limit the number of values that a customer can enter in the sAN Field of a certificates
NewOrderRequest.ServerCount Request String Number of Server Licenses
NewOrderRequest.SpecialInstructions Request string Special Instructions for the order
NewOrderRequest.ValidityPeriod Request String Validity Period (in month)
NewOrderRequest.WebServerType Request String This is from the OrderParameters structure. Designates the type of web server that an order is targeted for.
OrganisationInfo.Division Request string The OrganizationalUnit name from the CSR. Up to three comma-separated Ous may be contained in this parameter.
OrganisationInfo.DUNS Request string The Dunn and Bradstreet number for a company
OrganisationInfo.IncorporatingAgency Request string Incorporating Agency Name
OrganisationInfo.JurisdictionCity Request string Jurisdiction City Name
OrganisationInfo.JurisdictionCountry Request string Jurisdiction of Incorporation: Country
OrganisationInfo.JurisdictionRegion Request string Jurisdiction Region Name
OrganisationInfo.OrganizationName Request string The name of the Organization applying for the product. This applies to Organization Vetted products.
OrganisationInfo.RegistrationNumber Request string Company Registration Number
OrganizationAddress.AddressLine1 Request string Organization Street AddressLine1
OrganizationAddress.AddressLine2 Request string Organization Street AddressLine2
OrganizationAddress.AddressLine3 Request string Organization Street AddressLine3
OrganizationAddress.City Request string Organization City Name
OrganizationAddress.Country Request string Organization Country Name
OrganizationAddress.Fax Request string Organization Fax Number
OrganizationAddress.LocalityName Request string The Locality field from the CSR or Certificate
OrganizationAddress.Phone Request string Organization Phone Number
OrganizationAddress.PostalCode Request string Organization Postal Code
OrganizationAddress.Region Request string Organization Region Name
TechnicalContact.AddressLine1 Request string Technical Contact Street AddressLine1
TechnicalContact.AddressLine2 Request string Technical Contact Street AddressLine2
TechnicalContact.City Request string Technical Contact City Name
TechnicalContact.Country Request string Technical Contact Country Name
TechnicalContact.Email Request string Technical Contact Email Address.
TechnicalContact.Fax Request string Technical Contact Fax Number.
TechnicalContact.FirstName Request string Technical Contact First Name.
TechnicalContact.LastName Request string Technical Contact Last Name.
TechnicalContact.OrganizationName Request string Technical Contact Organization Name.
TechnicalContact.Phone Request string Technical Contact Phone Number.
TechnicalContact.PostalCode Request string Technical Contact Postal Code
TechnicalContact.Region Request string Technical Contact Region Name
TechnicalContact.Title Request string Technical Contact Person’s title.
ApproverEmailList Response String The array of approval emails.
AuthResponse. isError Response Boolean Returns False/true according to errorstatus into the response.
AuthResponse.Message Response string The Message given into the response.
AuthResponse.Timestamp Response Date The Date and time when user gets the response.
AuthResponse.ReplayToken Response string The value of the ReplayToken which provide by you in Order request
AuthResponse.InvokingPartnerCode Response string This is an alpha-numeric code provided to you by thesslstore.com. It is required in all requests.

Refund Request

Purpose
You can raise a Refund request on any order that qualifies for a Refund according to TheSSLstore.com guidelines.

URL

  • LIVE URL:
https://api.thesslstore.com/rest/order/refundrequest
  • SANDBOX URL:
https://sandbox-wbapi.thesslstore.com/rest/order/refundrequest

HTTP VERB
POST

PARAMETERS
JSON :

{
	"AuthRequest":{
		"PartnerCode":"String content",
		"AuthToken":"String content",
		"ReplayToken":"String content",
		"UserAgent":"String content"
	},
	"CustomOrderID":"String content",
	"TheSSLStoreOrderID":"String content",
	"ResendEmailType":"String content",
	"RefundReason":"String content",
	"RefundRequestID":"String content"
}

XML:

<OrderRequest>
<AuthRequest>
<PartnerCode>String content</PartnerCode>
<AuthToken>String content</AuthToken>
<ReplayToken>String content</ReplayToken>
<UserAgent>String content</UserAgent>
</AuthRequest>
<CustomOrderID>String content</CustomOrderID>
<TheSSLStoreOrderID>String content</TheSSLStoreOrderID>
<ResendEmailType>String content</ResendEmailType>
<RefundReason>String content</RefundReason>
<RefundRequestID>String content</RefundRequestID>
</OrderRequest>

RESPONSE
JSON :

{
	"AuthResponse":{
		"isError":true,
		"Message":["String content"],
		"Timestamp":"String content",
		"ReplayToken":"String content",
		"InvokingPartnerCode":"String content"
	},
	"PartnerOrderID":"String content",
	"CustomOrderID":"String content",
	"TheSSLStoreOrderID":"String content",
	"VendorOrderID":"String content",
	"RefundRequestID":"String content",
	"isRefundApproved":true,
	"TinyOrderLink":"String content",
	"OrderStatus":{
		"isTinyOrder":true,
		"isTinyOrderClaimed":true,
		"MajorStatus":"String content",
		"MinorStatus":"String content"
	},
	"OrderAmount":"String content",
	"CertificateStartDate":"String content",
	"CertificateEndDate":"String content",
	"CommonName":"String content",
	"DNSNames":"String content",
	"State":"String content",
	"Country":"String content",
	"Locality":"String content",
	"Organization":"String content",
	"OrganizationalUnit":"String content",
	"WebServerType":"String content",
	"ApproverEmail":"String content",
	"ProductName":"String content",
	"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"
	},
	"ReissueSuccessCode":"String content"
}

XML:

<OrderResponse>
<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>
<PartnerOrderID>String content</PartnerOrderID>
<CustomOrderID>String content</CustomOrderID>
<TheSSLStoreOrderID>String content</TheSSLStoreOrderID>
<VendorOrderID>String content</VendorOrderID>
<RefundRequestID>String content</RefundRequestID>
<isRefundApproved>true</isRefundApproved>
<TinyOrderLink>String content</TinyOrderLink>
<OrderStatus>
<isTinyOrder>true</isTinyOrder>
<isTinyOrderClaimed>true</isTinyOrderClaimed>
<MajorStatus>String content</MajorStatus>
<MinorStatus>String content</MinorStatus>
</OrderStatus>
<OrderAmount>String content</OrderAmount>
<CertificateStartDate>String content</CertificateStartDate>
<CertificateEndDate>String content</CertificateEndDate>
<CommonName>String content</CommonName>
<DNSNames>String content</DNSNames>
<State>String content</State>
<Country>String content</Country>
<Locality>String content</Locality>
<Organization>String content</Organization>
<OrganizationalUnit>String content</OrganizationalUnit>
<WebServerType>String content</WebServerType>
<ApproverEmail>String content</ApproverEmail>
<ProductName>String content</ProductName>
<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>
<ReissueSuccessCode>String content</ReissueSuccessCode>
</OrderResponse>

Fields Explanation

NAME FROM Type Description
AuthRequest.AuthToken Request String This is an alpha-numeric code provided to you by thesslstore.com. It is required in all requests.
*Required for this request.
*Required for this request.
AuthRequest.PartnerCode Request String This is an alpha-numeric token code provided to you by thesslstore.com. It is required in all requests.
*Required for this request.
*Required for this request.
AuthRequest.ReplayToken Request String This is an alpha-numeric code provided by you in order request and thesslstore.com sent back in request.
AuthRequest.UserAgent Request String Browser’s user agent value provided by you for specific order.
TinyOrderRequest.AddInstallationSupport Request String Indicates Purchase Installation Support for this order.
TinyOrderRequest.CustomOrderID Request String A Unique Number Provide by You.
TinyOrderRequest.EmailLanguageCode Request String The language code to be used when sending e-mail messages for this order. (Right now, this is not supported) Default Value is “EN”.
TinyOrderRequest.ExtraProductCode Request String Ignore for this request.
TinyOrderRequest.ExtraSAN Request String Allows a partner to add additional numbers of values that a customer can enter in the SAN Field of a certificates

*Required for SAN products
TinyOrderRequest.PreferVendorLink Request String If passed “TRUE” than TinyOrderLink generate from Vendor but only for Symantec certs. If passed “false” than TinyOrderLink generate from TheSSLStore.com.
TinyOrderRequest.ProductCode Request String A code for the product that a particular request relates to. Note that a partner must have a valid contract for a product code for it to be valid in a request. Also, a product code must be valid for the context of the request.

*Required for this request.
TinyOrderRequest.RequestorEmail Request String This Email is Requestore EmailID

*Required for this request.
TinyOrderRequest.ServerCount Request String Number of Server Licenses

*Required for this request.
TinyOrderRequest.ValidityPeriod Request String Validity Period (in month)

*Required for this request.
AuthResponse.InvokingPartnerCode Response String This is an alpha-numeric code provided to you by thesslstore.com.
AuthResponse.isError Response Boolean Return true if any error occurred during Order processing.
AuthResponse.ReplayToken Response String The value of the ReplayToken which provide by you in Order request.
AuthResponse.Timestamp Response String 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).
OrderRequest.CustomOrderID Request String A Unique Number Provide by You.
*Required for this request (ignore if you passed ThesslstoreOrderID)
OrderRequest.RefundReason Request String This RefundReason is Reason regarding Purchased Certificate Cancel.
*Required for this request.
OrderRequest.RefundRequestID Request String This RefundRequestID about RefundRequest.
**Ignore for this request.
OrderRequest.ResendEmailType Request String This ResendEmail is Resend an Invite email that was previously extended
OrderRequest.TheSSLStoreOrderID Request String A Tracking Number for Orders that can be set by a TheSSLStore.com
*Required for this request. (Ignore if you passed CustomOrderID)
OrderResponse.CertificateEndDate Response String This is the date the end entity certificate will expire on.
OrderResponse.CertificateStartDate Response String This is the date the end entity certificate or seal will be valid from.
OrderResponse.CommonName Response String This field is part of the subject DN of the end entity certificate and distinguishes the certificate. For an SSL certificate this will most likely be the fully qualified domain name the certificate will be used to secure.
OrderResponse.Country Response String The value of the Country in the ParseCSRResponse
OrderResponse.CustomOrderID Response String A Number provide by you in request which is sent in response.
OrderResponse.DNSNames Response String Additional Domains Name
OrderResponse.isRefundApproved Response Boolean Return true if Refund request approved from thesslstore.com
OrderResponse.Locality Response String The value of the Locality in the ParseOrderResponse.
OrderResponse.OrderAmount Response String Total Order Amount
OrderResponse.Organization Response String The OrganizationalUnit name from the CSR. Up to three comma-separated Ous may be contained in this parameter.
OrderResponse.OrganizationalUnit Response String The OrganizationalUnit name from the CSR. Up to three comma-separated Ous may be contained in this parameter.
OrderResponse.PartnerOrderID Response String A Tracking Number for Orders that can be set by a partner. Typically this would be a partner’s internal order number. When calling one of the initiate order operations this field is optional. If not supplied by the client, a random unique PartnerOrderID is generated by GeoTrust. Certain subsequent operations, such as GetOrderByPartnerOrderID, require this value
OrderResponse.RefundRequestID Response String A Tracking Number for Orders that can be set by a TheSSLStore.com in case you request a refund of an order.
OrderResponse.ReissueSuccessCode Response String The value of the Reissue Success Code in the ParseRefund Request Order Response.
OrderResponse.State Response String The value of the State in the ParseCSRResponse
OrderResponse.TheSSLStoreOrderID Response String A Tracking Number for Orders that can be set by a TheSSLStore.com
OrderResponse.TinyOrderLink Response String Field Description
OrderResponse.VendorOrderID Response String A Tracking Number for Orders that can be set by a Vendor.
OrderResponse.WebServerType Response String The value of the WebServerType in the ParseOrderResponse.
OrderStatus.isTinyOrder Response Boolean Return true in case of Inviteorder method.
OrderStatus.isTinyOrderClaimed Response Boolean Return true if you processed the TinyOrderLink.
OrderStatus.MajorStatus Response String PENDING – Order is in process. ACTIVE– Order has been completed. CANCELLED – Order has been completed and cancelled. INITIAL : Enrollment link is not claimed yet. EXPIRED – Order has been expired.
OrderStatus.MinorStatus Response String OrderStatusMinor provides specific status information unique to the workflow of the specific product.
AdminContact. FirstName Response String This is first name of admin contact of your order.
AdminContact. LastName Response String This is Last name of admin contact of your order.
AdminContact. Phone Response String This is Phone no of admin contact of your order.
AdminContact. Fax Response String This is Fax No of admin contact of your order.
AdminContact. Email Response String This is Email of admin contact of your order.
AdminContact. Title Response String This is Title of admin contact of your order.
AdminContact. OrganizationName Response String This is OrganizationName of admin contact of your order.
AdminContact. AddressLine1 Response String This is Address of admin contact of your order.
AdminContact. AddressLine2 Response String This is Address of admin contact of your order.
AdminContact. City Response String This is City of admin contact of your order.
AdminContact. Region Response String This is Region of admin contact of your order.
AdminContact. PostalCode Response String This is Postalcode of admin contact of your order.
AdminContact. Country Response String This is Country of admin contact of your order.
TechnicalContact. FirstName Response String This is first name of technical contact of your order.
TechnicalContact. LastName Response String This is Last name of technical contact of your order.
TechnicalContact. Phone Response String This is Phone no of technical contact of your order.
TechnicalContact. Fax Response String This is Fax No of technical contact of your order.
TechnicalContact. Email Response String This is Email of technical contact of your order.
TechnicalContact. Title Response String This is Title of technical contact of your order.
TechnicalContact. OrganizationName Response String This is OrganizationName of technical contact of your order.
TechnicalContact. AddressLine1 Response String This is Address of technical contact of your order.
TechnicalContact. AddressLine2 Response String This is Address of technical contact of your order.
TechnicalContact. City Response String This is City of technical contact of your order.
TechnicalContact. Region Response String This is Region of technical contact of your order.
TechnicalContact. PostalCode Response String This is Postalcode of technical contact of your order.
TechnicalContact. Country Response String This is Country of technical contact of your order.

Refund Status

Purpose
Since Refund is manual process in some cases, you can check the status of your refund request at any time.

URL

  • LIVE URL:
https://api.thesslstore.com/rest/order/refundstatus
  • SANDBOX URL:
https://sandbox-wbapi.thesslstore.com/rest/order/refundstatus

HTTP VERB
POST

PARAMETERS
JSON :

{
	"AuthRequest":{
		"PartnerCode":"String content",
		"AuthToken":"String content",
		"ReplayToken":"String content",
		"UserAgent":"String content"
	},
	"CustomOrderID":"String content",
	"TheSSLStoreOrderID":"String content",
	"ResendEmailType":"String content",
	"RefundReason":"String content",
	"RefundRequestID":"String content"
}

XML:

<OrderRequest>
<AuthRequest>
<PartnerCode>String content</PartnerCode>
<AuthToken>String content</AuthToken>
<ReplayToken>String content</ReplayToken>
<UserAgent>String content</UserAgent>
</AuthRequest>
<CustomOrderID>String content</CustomOrderID>
<TheSSLStoreOrderID>String content</TheSSLStoreOrderID>
<ResendEmailType>String content</ResendEmailType>
<RefundReason>String content</RefundReason>
<RefundRequestID>String content</RefundRequestID>
</OrderRequest>

RESPONSE
JSON :

{
	"AuthResponse":{
		"isError":true,
		"Message":["String content"],
		"Timestamp":"String content",
		"ReplayToken":"String content",
		"InvokingPartnerCode":"String content"
	},
	"PartnerOrderID":"String content",
	"CustomOrderID":"String content",
	"TheSSLStoreOrderID":"String content",
	"VendorOrderID":"String content",
	"RefundRequestID":"String content",
	"isRefundApproved":true,
	"TinyOrderLink":"String content",
	"OrderStatus":{
		"isTinyOrder":true,
		"isTinyOrderClaimed":true,
		"MajorStatus":"String content",
		"MinorStatus":"String content"
	},
	"OrderAmount":"String content",
	"CertificateStartDate":"String content",
	"CertificateEndDate":"String content",
	"CommonName":"String content",
	"DNSNames":"String content",
	"State":"String content",
	"Country":"String content",
	"Locality":"String content",
	"Organization":"String content",
	"OrganizationalUnit":"String content",
	"WebServerType":"String content",
	"ApproverEmail":"String content",
	"ProductName":"String content",
	"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"
	},
	"ReissueSuccessCode":"String content"

}

XML:

<OrderResponse>
<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>
<PartnerOrderID>String content</PartnerOrderID>
<CustomOrderID>String content</CustomOrderID>
<TheSSLStoreOrderID>String content</TheSSLStoreOrderID>
<VendorOrderID>String content</VendorOrderID>
<RefundRequestID>String content</RefundRequestID>
<isRefundApproved>true</isRefundApproved>
<TinyOrderLink>String content</TinyOrderLink>
<OrderStatus>
<isTinyOrder>true</isTinyOrder>
<isTinyOrderClaimed>true</isTinyOrderClaimed>
<MajorStatus>String content</MajorStatus>
<MinorStatus>String content</MinorStatus>
</OrderStatus>
<OrderAmount>String content</OrderAmount>
<CertificateStartDate>String content</CertificateStartDate>
<CertificateEndDate>String content</CertificateEndDate>
<CommonName>String content</CommonName>
<DNSNames>String content</DNSNames>
<State>String content</State>
<Country>String content</Country>
<Locality>String content</Locality>
<Organization>String content</Organization>
<OrganizationalUnit>String content</OrganizationalUnit>
<WebServerType>String content</WebServerType>
<ApproverEmail>String content</ApproverEmail>
<ProductName>String content</ProductName>
<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>
<ReissueSuccessCode>String content</ReissueSuccessCode>
</OrderResponse>

Fields Explanation

AuthRequest.AuthToken

Request

String

This is an alpha-numeric code provided to you by thesslstore.com. It is required in all requests.


*Required for this request

AuthRequest.PartnerCode

Request

String

This is an alpha-numeric token code provided to you by thesslstore.com. It is required in all requests.


*Required for this request

AuthRequest.ReplayToken

Request

String

This is an alpha-numeric code provided by you in order request and thesslstore.com sent back in request.

AuthRequest.UserAgent

Request

String

Browser’s user agent value provided by you for a specific order.

AuthResponse.InvokingPartnerCode

Response

String

This is an alpha-numeric code provided to you by thesslstore.com.

AuthResponse.isError

Response

Boolean

Return true if any error occurred during Order processing.

AuthResponse.ReplayToken

Response

String

The value of the ReplayToken which provide by you in Order request.

AuthResponse.Timestamp

Response

String

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).

OrderRequest.CustomOrderID

Request

String

A Unique Number Provide by You.

OrderRequest.RefundReason

Request

String

This RefundReason is Reason regarding Purchased Certificate Cancel.


*Ignore for this request

OrderRequest.RefundRequestID

Request

String

This RefundRequestID about RefundRequest.


**Required for this request

OrderRequest.ResendEmailType

Request

String

This ResendEmail is Resend an Invite email that was previously extended

OrderRequest.TheSSLStoreOrderID

Request

String

A Tracking Number for Orders that can be set by a TheSSLStore.com

OrderResponse.CertificateEndDate

Response

String

This is the date the end entity certificate will expire on.

OrderResponse.CertificateStartDate

Response

String

This is the date the end entity certificate or seal will be valid from.

OrderResponse.CommonName

Response

String

This field is part of the subject DN of the end entity certificate and distinguishes the certificate. For an SSL certificate this will most likely be the fully qualified domain name the certificate will be used to secure.

OrderResponse.Country

Response

String

The value of the Country in the ParseCSRResponse

OrderResponse.CustomOrderID

Response

String

A Number provide by you in request which is sent in response.

OrderResponse.DNSNames

Response

String

Additional Domains Name

OrderResponse.isRefundApproved

Response

Boolean

Return true if Refund request approved from thesslstore.com

OrderResponse.Locality

Response

String

The value of the Locality in the ParseOrderResponse.

OrderResponse.OrderAmount

Response

String

Total Order Amount

OrderResponse.Organization

Response

String

The OrganizationalUnit name from the CSR. Up to three comma-separated Ous may be contained in this parameter.

OrderResponse.OrganizationalUnit

Response

String

The OrganizationalUnit name from the CSR. Up to three comma-separated Ous may be contained in this parameter.

OrderResponse.PartnerOrderID

Response

String

A Tracking Number for Orders that can be set by a partner. Typically this would be a partner’s internal order number. When calling one of the initiate order operations this field is optional. If not supplied by the client, a random unique PartnerOrderID is generated by GeoTrust. Certain subsequent operations, such as GetOrderByPartnerOrderID, require this value

OrderResponse.RefundRequestID

Response

String

A Tracking Number for Orders that can be set by a TheSSLStore.com in case you request a refund of an order.

OrderResponse.ReissueSuccessCode

Response

String

The value of the Reissue Success Code in the ParseRefund Request Order Response.

OrderResponse.State

Response

String

The value of the State in the ParseCSRResponse

OrderResponse.TheSSLStoreOrderID

Response

String

A Tracking Number for Orders that can be set by a TheSSLStore.com

OrderResponse.TinyOrderLink

Response

String

Field Description

OrderResponse.VendorOrderID

Response

String

A Tracking Number for Orders that can be set by a Vendor.

OrderResponse.WebServerType

Response

String

The value of the WebServerType in the ParseOrderResponse.

OrderStatus.isTinyOrder

Response

Boolean

Return true in case of Inviteorder method.

OrderStatus.isTinyOrderClaimed

Response

Boolean

Return true if you processed the TinyOrderLink.

OrderStatus.MajorStatus

Response

String

PENDING – Order is in process. ACTIVE– Order has been completed. CANCELLED – Order has been completed and cancelled. INITIAL : Enrollment link is not claimed yet. EXPIRED – Order has been expired.

OrderStatus.MinorStatus

Response

String

OrderStatusMinor provides specific status information unique to the workflow of the specific product.

AdminContact. FirstName Response String This is first name of admin contact of your order.
AdminContact. LastName Response String This is Last name of admin contact of your order.
AdminContact. Phone Response String This is Phone no of admin contact of your order.
AdminContact. Fax Response String This is Fax No of admin contact of your order.
AdminContact. Email Response String This is Email of admin contact of your order.
AdminContact. Title Response String This is Title of admin contact of your order.
AdminContact. OrganizationName Response String This is OrganizationName of admin contact of your order.
AdminContact. AddressLine1 Response String This is Address of admin contact of your order.
AdminContact. AddressLine2 Response String This is Address of admin contact of your order.
AdminContact. City Response String This is City of admin contact of your order.
AdminContact. Region Response String This is Region of admin contact of your order.
AdminContact. PostalCode Response String This is Postalcode of admin contact of your order.
AdminContact. Country Response String This is Country of admin contact of your order.
TechnicalContact. FirstName Response String This is first name of technical contact of your order.
TechnicalContact. LastName Response String This is Last name of technical contact of your order.
TechnicalContact. Phone Response String This is Phone no of technical contact of your order.
TechnicalContact. Fax Response String This is Fax No of technical contact of your order.
TechnicalContact. Email Response String This is Email of technical contact of your order.
TechnicalContact. Title Response String This is Title of technical contact of your order.
TechnicalContact. OrganizationName Response String This is OrganizationName of technical contact of your order.
TechnicalContact. AddressLine1 Response String This is Address of technical contact of your order.
TechnicalContact. AddressLine2 Response String This is Address of technical contact of your order.
TechnicalContact. City Response String This is City of technical contact of your order.
TechnicalContact. Region Response String This is Region of technical contact of your order.
TechnicalContact. PostalCode Response String This is Postalcode of technical contact of your order.
TechnicalContact. Country Response String This is Country of technical contact of your order.

Resend Email

Purpose
Resends Email : Approver Email OR Invite Order link depending on paratmers passed here.

URL

  • LIVE URL:
https://api.thesslstore.com/rest/order/resend
  • SANDBOX URL:
https://sandbox-wbapi.thesslstore.com/rest/order/resend

HTTP VERB
POST

PARAMETERS
JSON :

{
	"AuthRequest":{
		"PartnerCode":"String content",
		"AuthToken":"String content",
		"ReplayToken":"String content",
		"UserAgent":"String content"
	},
	"CustomOrderID":"String content",
	"TheSSLStoreOrderID":"String content",
	"ResendEmailType":"String content",
	"RefundReason":"String content",
	"RefundRequestID":"String content"
}

XML:

<OrderRequest>
<AuthRequest>
<PartnerCode>String content</PartnerCode>
<AuthToken>String content</AuthToken>
<ReplayToken>String content</ReplayToken>
<UserAgent>String content</UserAgent>
</AuthRequest>
<CustomOrderID>String content</CustomOrderID>
<TheSSLStoreOrderID>String content</TheSSLStoreOrderID>
<ResendEmailType>String content</ResendEmailType>
<RefundReason>String content</RefundReason>
<RefundRequestID>String content</RefundRequestID>
</OrderRequest>

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

NAME FROM Type Description
AuthRequest.AuthToken Request String This is an alpha-numeric code provided to you by thesslstore.com. It is required in all requests.
*Required for this request
AuthRequest.PartnerCode Request String This is an alpha-numeric token code provided to you by thesslstore.com. It is required in all requests.
*Required for this request
AuthRequest.ReplayToken Request String This is an alpha-numeric code provided by you in order request and thesslstore.com sent back in request.
AuthRequest.UserAgent Request String Browser’s user agent value provided by you for specific order.
OrderRequest.CustomOrderID Request String A Unique Number Provide by You.
*Required for this request (ignore if you passed ThesslstoreOrderID)
OrderRequest.RefundReason Request String This RefundReason is Reason regarding Purchased Certificate Cancel.
OrderRequest.RefundRequestID Request String This RefundRequestID about RefundRequest.
OrderRequest.ResendEmailType Request String This ResendEmail is Resend an Invite email that was previously extended
*Supported values: InviteEmail, ApproverEmail, PickUpEmail, FulfillmentEmail, PhoneAuthEmail. Required for Symantec certs.
OrderRequest.TheSSLStoreOrderID Request String A Tracking Number for Orders that can be set by a TheSSLStore.com
*Required for this request (Ignore if you passed CustomOrderID)
AuthResponse.isError Response string Returns False/true according to errorstatus into the response.
AuthResponse.Message Response string The Message given into the response.
AuthResponse.Timestamp Response Date The Date and time when user gets the response.
AuthResponse.ReplayToken Response string The value of the ReplayToken which provide by you in Order request
AuthResponse.InvokingPartnerCode Response string This is an alpha-numeric code provided to you by thesslstore.com. It is required in all requests.

Change Approval Email

Purpose
Change Approval Email : Approver Email you can change for any of your order.

URL

  • LIVE URL:
https://api.thesslstore.com/order/changeapproveremail/

HTTP VERB
POST

PARAMETERS
JSON :

{
	"AuthRequest":{
		"PartnerCode":"String content",
		"AuthToken":"String content",
		"ReplayToken":"String content",
		"UserAgent":"String content"
	},
	"CustomOrderID":"String content",
	"TheSSLStoreOrderID":"String content",
	"ResendEmailType":"String content",
	"ResendEmail":"String content",
	"RefundReason":"String content",
	"RefundRequestID":"String content"
}

XML:

<OrderRequest>
<AuthRequest>
<PartnerCode>String content</PartnerCode>
<AuthToken>String content</AuthToken>
<ReplayToken>String content</ReplayToken>
<UserAgent>String content</UserAgent>
</AuthRequest>
<CustomOrderID>String content</CustomOrderID>
<TheSSLStoreOrderID>String content</TheSSLStoreOrderID>
<ResendEmailType>String content</ResendEmailType>
<ResendEmail>String content</ResendEmail>
<RefundReason>String content</RefundReason>
<RefundRequestID>String content</RefundRequestID>
</OrderRequest>

RESPONSE
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

NAME FROM Type Description
AuthRequest.AuthToken Request String This is an alpha-numeric code provided to you by thesslstore.com. It is required in all requests.
*Required for this request
AuthRequest.PartnerCode Request String This is an alpha-numeric token code provided to you by thesslstore.com. It is required in all requests.
*Required for this request
AuthRequest.ReplayToken Request String This is an alpha-numeric code provided by you in order request and thesslstore.com sent back in request.
AuthRequest.UserAgent Request String Browser’s user agent value provided by you for specific order.
OrderRequest.CustomOrderID Request String A Unique Number Provide by You.
*Required for this request (ignore if you passed ThesslstoreOrderID)
OrderRequest.RefundReason Request String This RefundReason is Reason regarding Purchased Certificate Cancel.
OrderRequest.RefundRequestID Request String This RefundRequestID about RefundRequest.
OrderRequest.ResendEmailType Request String This ResendEmail is Resend an Invite email that was previously extended
OrderRequest.ResendEmail Request String You can change your approval email by specifying here new resend email

*Required for this request.
OrderRequest.TheSSLStoreOrderID Request String A Tracking Number for Orders that can be set by a TheSSLStore.com
*Required for this request (Ignore if you passed CustomOrderID)
AuthResponse.isError Response string Returns False/true according to errorstatus into the response.
AuthResponse.Message Response string The Message given into the response.
AuthResponse.Timestamp Response Date The Date and time when user gets the response.
AuthResponse.ReplayToken Response string The value of the ReplayToken which provide by you in Order request
AuthResponse.InvokingPartnerCode Response string This is an alpha-numeric code provided to you by thesslstore.com. It is required in all requests.