POST api/Store/GetStores

Request Information

URI Parameters

None.

Body Parameters

GetStoresRequest
NameDescriptionTypeAdditional information
Token

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Token": "sample string 1"
}

application/xml, text/xml

Sample:
<GetStoresRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Store">
  <Token xmlns="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Base">sample string 1</Token>
</GetStoresRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GetStoresResponse
NameDescriptionTypeAdditional information
Stores

Collection of Store

None.

ErrorCode

string

None.

ErrorMessage

string

None.

ErrorCategory

string

None.

Result

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "Stores": [
    {
      "StoreId": "sample string 1",
      "StoreName": "sample string 2",
      "MarketPlaceId": 3,
      "MarketPlaceName": "sample string 4",
      "MarketPlaceShortName": "sample string 5",
      "StoreStatus": 6,
      "ApiStatus": 7
    },
    {
      "StoreId": "sample string 1",
      "StoreName": "sample string 2",
      "MarketPlaceId": 3,
      "MarketPlaceName": "sample string 4",
      "MarketPlaceShortName": "sample string 5",
      "StoreStatus": 6,
      "ApiStatus": 7
    }
  ],
  "ErrorCode": "sample string 1",
  "ErrorMessage": "sample string 2",
  "ErrorCategory": "sample string 3",
  "Result": true
}

application/xml, text/xml

Sample:
<GetStoresResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Store">
  <ErrorCategory xmlns="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Base">sample string 3</ErrorCategory>
  <ErrorCode xmlns="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Base">sample string 1</ErrorCode>
  <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Base">sample string 2</ErrorMessage>
  <Result xmlns="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Base">true</Result>
  <Stores>
    <Store>
      <ApiStatus>7</ApiStatus>
      <MarketPlaceId>3</MarketPlaceId>
      <MarketPlaceName>sample string 4</MarketPlaceName>
      <MarketPlaceShortName>sample string 5</MarketPlaceShortName>
      <StoreId>sample string 1</StoreId>
      <StoreName>sample string 2</StoreName>
      <StoreStatus>6</StoreStatus>
    </Store>
    <Store>
      <ApiStatus>7</ApiStatus>
      <MarketPlaceId>3</MarketPlaceId>
      <MarketPlaceName>sample string 4</MarketPlaceName>
      <MarketPlaceShortName>sample string 5</MarketPlaceShortName>
      <StoreId>sample string 1</StoreId>
      <StoreName>sample string 2</StoreName>
      <StoreStatus>6</StoreStatus>
    </Store>
  </Stores>
</GetStoresResponse>