Query Order

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/documentation/odata-version-2-0/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 :
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"
	},
	"StartDate":"\/Date(928164000000-0400)\/",
	"EndDate":"\/Date(928164000000-0400)\/",
	"SubUserID":"String content",
	"ProductCode":"String content"
}

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

<OrderQueryRequest>

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

<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.
AuthRequest.Token Request string Used for AutoInstallSSL Plugin. If you pass Token then our system will ignore TokenCode and TokenID.
AuthRequest.TokenID Request String Validate Order Parameters
AuthRequest.TokenCode Request String Validate Order Parameters
AuthRequest.IsUsedForTokenSystem Request Boolean Validate Order Parameters
OrderQueryRequest.EndDate Request String This is the End date that specify the order till date. For json format you need to pass date in following format “/Date(no. of milliseconds from the time stamp(01 Jan 1970 00:00:00 GMT) )/”
For eg.
EndDate = “/Date(1389744000000)/”
//15 Jan 2014 00:00:00 GMT
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. For json format you need to pass date in following format “/Date(no. of milliseconds from the time stamp(01 Jan 1970 00:00:00 GMT) )/”
For eg.
StartDate = “/Date(1389744000000)/”
//15 Jan 2014 00:00:00 GMT
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.