GET v1/Stores/{storeIdentifier}/OnlineStatus?timeout={timeout}

GET Store Online Status

Checks to see if the store is online

URI template

v1/Stores/{storeIdentifier}/OnlineStatus?timeout={timeout}

Request Information

URI Parameters

Name	Type	Additional information	Description
storeIdentifier	integer	Required	Identifies the store to send the command to
timeout	integer	Default value is 30000	The timeout for this command

Body Parameters

None.

Response Information

Resource Description

A response object which contains a response from the Store API and whether the store is online or not

IsStoreOnlineResponse

Name	Type	Additional information	Description
IsStoreOnline	boolean	None.	True, if the store is online. False, if the store is offline or cannot be found.
StoreKey	string	None.	The store identifier this response is specific to.
ApiResult	StoreApiResponse	None.	The result returned by the Api

Response Formats

application/json, text/json

Sample:

{
  "IsStoreOnline": true,
  "StoreKey": "sample string 2",
  "ApiResult": {
    "$id": "2",
    "TransactionId": "57d2d634-4c83-4ba0-902a-1c1ab812d3e6",
    "ResultCode": 2,
    "ResultMessage": "sample string 3"
  }
}

application/xml, text/xml

Sample:

<IsStoreOnlineResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Responses.ResponseObjects.StoreResponses">
  <ApiResult xmlns:d2p1="http://schemas.datacontract.org/2004/07/StoreConnect.Responses" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Responses.ResponseObjects">
    <d2p1:ResultCode>2</d2p1:ResultCode>
    <d2p1:ResultMessage>sample string 3</d2p1:ResultMessage>
    <d2p1:TransactionId>57d2d634-4c83-4ba0-902a-1c1ab812d3e6</d2p1:TransactionId>
  </ApiResult>
  <IsStoreOnline>true</IsStoreOnline>
  <StoreKey>sample string 2</StoreKey>
</IsStoreOnlineResponse>