Order Status

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 :
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",
		"IPAddress":"String content",
		"IsUsedForTokenSystem":true,
		"Token":"String content"
	},
	"CustomOrderID":"String content",
	"TheSSLStoreOrderID":"String content",
	"ResendEmailType":"String content",
	"ResendEmail":"String content",
	"RefundReason":"String content",
	"RefundRequestID":"String content",
	"ApproverMethod":"String content",
	"DomainNames":"String content",
	"SerialNumber":"String content"

}

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

<OrderRequest>

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

<IPAddress>String content</IPAddress>

<IsUsedForTokenSystem>true</IsUsedForTokenSystem>

<Token>String content</Token>

</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>

<ApproverMethod>String content</ApproverMethod>

<DomainNames>String content</DomainNames>

<SerialNumber>String content</SerialNumber>

</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",
		"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",
	"SANCount":2147483647,
	"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>

<SANCount>2147483647</SANCount>

<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

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.
AuthRequest.Token Request string Used for AutoInstallSSL Plugin. If you pass Token then our system will ignore TokenCode and TokenID.
AuthRequest.TokenID Request string Used for AutoInstallSSL Plugin. If you passed Token then this field is optional.
AuthRequest.TokenCode Request string Used for AutoInstallSSL Plugin. If you passed Token then this field is optional.
AuthRequest.IsUsedForTokenSystem Request Boolean Used for AutoInstallSSL Plugin
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.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.AuthFileName Response String This value is provided by vendor and contains file name value for DV File Authentication Process.
OrderResponse.AuthFileContent Response String This value is provided by vendor and contains content for DV File Authentication Process.
OrderResponse.PollStatus Response String The polling status of the authentication file used to support automated DV authentication.
OrderResponse. PollDate Response String The polling date of the authentication file used to support automated DV authentication.
OrderResponse.CustomerLoginName Response String Unique case sensitive UserName for comodo and trustwave product only.
OrderResponse.CustomerPassword Response String Unique case sensitive Password for comodo and trustwave product only.
OrderResponse.TokenID Response 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.
OrderResponse.TokenCode Response 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.
OrderResponse.Token Response 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 String Static site seal url.
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.