Invite Order

Invite OrderPurpose
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 a minified version of New Order, while at the same time gaining complete Order Response including status. The fulfillment 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 vendor’s site, where the customer completes the SSL enrollment process.

LIVE URL:

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

SANDBOX URL:

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

HTTP VERB
POST

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

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

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

<TinyOrderRequest>
<AuthRequest>
<PartnerCode>String content</PartnerCode>
<AuthToken>String content</AuthToken>
<ReplayToken>String content</ReplayToken>
<UserAgent>String content</UserAgent>
<IPAddress>String content</IPAddress>
</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>
<SignatureHashAlgorithm>String content</SignatureHashAlgorithm>
<EmailLanguageCode>String content</EmailLanguageCode>
<PreferSendOrderEmails>String content</PreferSendOrderEmails>
</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",
		"AuthenticationStatuses":[{
			"AuthenticationStep":"String content",
			"Status":"String content",
			"LastUpdated":"String content"
		}],
		"AuthenticationComments":"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",
	"AuthFileName":"String content",
	"AuthFileContent":"String content",
	"PollStatus":"String content",
	"PollDate":"String content",
	"CustomerLoginName":"String content",
	"CustomerPassword":"String content",
	"CustomerID":2147483647,
	"TokenID":"String content",
	"TokenCode":"String content",
	"SiteSealurl":"String content",
	"CNAMEAuthName":"String content",
	"CNAMEAuthValue":"String content",
	"SignatureEncryptionAlgorithm":"String content",
	"SignatureHashAlgorithm":"String content",
	"VendorName":"String content",
	"SubVendorName":"String content",
	"Token":"String content",
	"SerialNumber":"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>
	<AuthenticationStatuses>
		<AuthenticationStatus>
			<AuthenticationStep>String content</AuthenticationStep>
			<Status>String content</Status>
			<LastUpdated>String content</LastUpdated>
		</AuthenticationStatus>
		<AuthenticationStatus>
			<AuthenticationStep>String content</AuthenticationStep>
			<Status>String content</Status>
			<LastUpdated>String content</LastUpdated>
		</AuthenticationStatus>
	</AuthenticationStatuses>
    <AuthenticationComments>String content</AuthenticationComments>
  </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>
  <AuthFileName>String content</AuthFileName>
  <AuthFileContent>String content</AuthFileContent>
  <PollStatus>String content</PollStatus>
  <PollDate>String content</PollDate>
  <CustomerLoginName>String content</CustomerLoginName>
  <CustomerPassword>String content</CustomerPassword>
  <CustomerID>2147483647</CustomerID>
  <TokenID>String content</TokenID>
  <TokenCode>String content</TokenCode>
  <SiteSealurl>String content</SiteSealurl>
  <CNAMEAuthName>String content</CNAMEAuthName>
  <CNAMEAuthValue>String content</CNAMEAuthValue>
  <SignatureEncryptionAlgorithm>String content</SignatureEncryptionAlgorithm>
  <SignatureHashAlgorithm>String content</SignatureHashAlgorithm>
  <VendorName>String content</VendorName>
  <SubVendorName>String content</SubVendorName>
  <Token>String content</Token>
  <SerialNumber>String content</SerialNumber>
</OrderResponse>

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

NAMEFROMField Req.TypeDescription

AuthRequest.AuthToken Request R String This is an alpha-numeric token code provided to you by thesslstore.com. It is required in all requests.
AuthRequest.PartnerCode Request R String This is an alpha-numeric code provided to you by thesslstore.com. It is required in all requests.
AuthRequest.ReplayToken Request O String This is an alpha-numeric code provided by you in order request and thesslstore.com sent back in request.
AuthRequest.UserAgent Request O String User Agent to identify the request coming from.
TinyOrderRequest.AddInstallationSupport Request O Boolean If reseller would like to purchase Installation support along with order. They have to pass true.
Default value is false.
TinyOrderRequest.CustomOrderID Request O* String A Unique Number Provide by You.

*If not passed in request then system automatically generates.

TinyOrderRequest.EmailLanguageCode Request O 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 I String Field Description
TinyOrderRequest.ExtraSAN Request R* 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 R String In case of passing true, it will generate invite link only for Symantec certs. In case of false it will generate invite link from TheSSLStore.com. For AutoInstall™ plugin you need to pass false.
TinyOrderRequest.ProductCode Request R 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 R String This Email is Requestore Email ID.
TinyOrderRequest.ServerCount Request R String Number of Server Licenses.
TinyOrderRequest.ValidityPeriod Request R String Validity Period (in month)
AuthResponse.InvokingPartnerCode Response N/A String This is an alpha-numeric code provided to you by thesslstore.com.
AuthResponse.isError Response N/A Boolean Return true if any error occurred during Order processing.
AuthResponse.ReplayToken Response N/A String The value of the ReplayToken which provide by you in Order request.
AuthResponse.Timestamp Response N/A 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 N/A String This is the date the end entity certificate will expire on.
OrderResponse.CertificateStartDate Response N/A String This is the date the end entity certificate or seal will be valid from.
OrderResponse.CommonName Response N/A 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 N/A String The value of the Country in the ParseCSRResponse
OrderResponse.CustomOrderID Response N/A String A Number provide by you in request which is sent in response.
OrderResponse.DNSNames Response N/A String Additional Domains Name
OrderResponse.isRefundApproved Response N/A Boolean Return true if Refund request approved from thesslstore.com
OrderResponse.Locality Response N/A String The value of the Locality in the ParseOrderResponse.
OrderResponse.OrderAmount Response N/A String Total Order Amount
OrderResponse.Organization Response N/A String The OrganizationalUnit name from the CSR. Up to three comma-separated Ous may be contained in this parameter.
OrderResponse.OrganizationalUnit Response N/A String The OrganizationalUnit name from the CSR. Up to three comma-separated Ous may be contained in this parameter.
OrderResponse.PartnerOrderID Response N/A 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 N/A 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 N/A String The value of the Reissue Success Code in the ParseRefund Request Order Response.
OrderResponse.AuthFileName Response N/A String This value is provided by vendor and contains file name value for DV File Authentication Process.
OrderResponse.AuthFileContent Response N/A String This value is provided by vendor and contains content for DV File Authentication Process.
OrderResponse.PollStatus Response N/A String The polling status of the authentication file used to support automated DV authentication.
OrderResponse.PollDate Response N/A String The polling date of the authentication file used to support automated DV authentication.
OrderResponse.CustomerLoginName Response N/A String Unique case sensitive UserName for comodo and trustwave product only.
OrderResponse.CustomerPassword Response N/A String Unique case sensitive Password for comodo and trustwave product only.
OrderResponse.TokenID Response N/A String This call is only used with our AutoInstall SSL™ plugin. Your customer will need this Token ID to initiate the AutoInstall SSL™ process after their SSL purchase has been made. This will need to be input into the Token ID field within the AutoInstall SSL™ interface. If you passed Token then this field is optional.
OrderResponse.TokenCode Response N/A String This call is only used with our AutoInstall SSL™ plugin. Your customer will need this Token Code to initiate the AutoInstall SSL™ process after their SSL purchase has been made. This will need to be input into the Token Code field within the AutoInstall SSL™ interface. If you passed Token then this field is optional.
OrderResponse.Token Response N/A String This call is only used with our AutoInstall SSL™ plugin. Your customer will need this Token to initiate the AutoInstall SSL™ process after their SSL purchase has been made. This will need to be input into the Token field within the AutoInstall SSL™ interface. If you pass Token then our system will ignore TokenCode and TokenID.
OrderResponse.SiteSealURL Response N/A String Static siteseal url.
OrderResponse.State Response N/A String The value of the State in the ParseCSRResponse
OrderResponse.TheSSLStoreOrderID Response N/A String A Tracking Number for Orders that can be set by a TheSSLStore.com
OrderResponse.TinyOrderLink Response N/A String A url for process invite order.
OrderResponse.VendorOrderID Response N/A String A Tracking Number for Orders that can be set by a Vendor.
OrderResponse.WebServerType Response N/A String The value of the WebServerType in the ParseOrderResponse.
OrderStatus.isTinyOrder Response N/A Boolean Return true in case of Inviteorder method.
OrderStatus.isTinyOrderClaimed Response N/A Boolean Return true if you processed the TinyOrderLink.
OrderStatus.MajorStatus Response N/A 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 N/A String OrderStatusMinor provides specific status information unique to the workflow of the specific product.