POST retailers/search

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Text	string	Required
ClientLocation	GeoPointDto	None.
MapBounds	MapBoundsDto	None.
ShopInfoSuggestionType	ShopInfoSuggestionType	Required
ApiKey	globally unique identifier	Required
ApplicationVersion	integer	Required
Udid	string	Required
UserID	globally unique identifier	Required
ZoneID	integer	Required

Request Formats

application/json, text/json

Sample:

{
  "Text": "sample string 1",
  "ClientLocation": {
    "Latitude": 1.1,
    "Longitude": 2.1
  },
  "MapBounds": {
    "NorthEast": {
      "Latitude": 1.1,
      "Longitude": 2.1
    },
    "NorthWest": {
      "Latitude": 1.1,
      "Longitude": 2.1
    },
    "SouthEast": {
      "Latitude": 1.1,
      "Longitude": 2.1
    },
    "SouthWest": {
      "Latitude": 1.1,
      "Longitude": 2.1
    }
  },
  "ShopInfoSuggestionType": 0,
  "ApiKey": "14e3c2fe-7a5f-418e-92a9-2f2e2460bfb5",
  "ApplicationVersion": 3,
  "Udid": "sample string 4",
  "UserID": "b5e7f5f2-8a9d-488d-aa27-98ce91e7ec8c",
  "ZoneID": 6
}

application/xml, text/xml

Sample:

<RetailersSearchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Retailers">
  <ApiKey>14e3c2fe-7a5f-418e-92a9-2f2e2460bfb5</ApiKey>
  <ApplicationVersion>3</ApplicationVersion>
  <Udid>sample string 4</Udid>
  <UserID>b5e7f5f2-8a9d-488d-aa27-98ce91e7ec8c</UserID>
  <ZoneID>6</ZoneID>
  <ClientLocation xmlns:d2p1="http://schemas.datacontract.org/2004/07/agilys.myshopi.search.Core.DTOs">
    <d2p1:Latitude>1.1</d2p1:Latitude>
    <d2p1:Longitude>2.1</d2p1:Longitude>
  </ClientLocation>
  <MapBounds xmlns:d2p1="http://schemas.datacontract.org/2004/07/agilys.myshopi.search.Core.DTOs">
    <d2p1:NorthEast>
      <d2p1:Latitude>1.1</d2p1:Latitude>
      <d2p1:Longitude>2.1</d2p1:Longitude>
    </d2p1:NorthEast>
    <d2p1:NorthWest>
      <d2p1:Latitude>1.1</d2p1:Latitude>
      <d2p1:Longitude>2.1</d2p1:Longitude>
    </d2p1:NorthWest>
    <d2p1:SouthEast>
      <d2p1:Latitude>1.1</d2p1:Latitude>
      <d2p1:Longitude>2.1</d2p1:Longitude>
    </d2p1:SouthEast>
    <d2p1:SouthWest>
      <d2p1:Latitude>1.1</d2p1:Latitude>
      <d2p1:Longitude>2.1</d2p1:Longitude>
    </d2p1:SouthWest>
  </MapBounds>
  <ShopInfoSuggestionType>Unknown</ShopInfoSuggestionType>
  <Text>sample string 1</Text>
</RetailersSearchRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'RetailersSearchRequest'.

Response Information

Resource Description

RetailersSearchResult

Name	Type	Additional information
TotalCount	integer	None.
Shops	Collection of RetailersSearchItem	None.
Success	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "TotalCount": 1,
  "Shops": [
    {
      "Location": {
        "Latitude": 1.1,
        "Longitude": 2.1
      },
      "PinImageUrl": "sample string 1",
      "LeafletShopSlug": "sample string 2",
      "RetailerName": "sample string 3",
      "Street": "sample string 4",
      "City": "sample string 5",
      "Zip": "sample string 6",
      "RetailerSlug": "sample string 7"
    },
    {
      "Location": {
        "Latitude": 1.1,
        "Longitude": 2.1
      },
      "PinImageUrl": "sample string 1",
      "LeafletShopSlug": "sample string 2",
      "RetailerName": "sample string 3",
      "Street": "sample string 4",
      "City": "sample string 5",
      "Zip": "sample string 6",
      "RetailerSlug": "sample string 7"
    }
  ],
  "Success": true
}

application/xml, text/xml

Sample:

<RetailersSearchResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Retailers">
  <Shops>
    <RetailersSearchItem>
      <City>sample string 5</City>
      <LeafletShopSlug>sample string 2</LeafletShopSlug>
      <Location xmlns:d4p1="http://schemas.datacontract.org/2004/07/agilys.myshopi.search.Core.DTOs">
        <d4p1:Latitude>1.1</d4p1:Latitude>
        <d4p1:Longitude>2.1</d4p1:Longitude>
      </Location>
      <PinImageUrl>sample string 1</PinImageUrl>
      <RetailerName>sample string 3</RetailerName>
      <RetailerSlug>sample string 7</RetailerSlug>
      <Street>sample string 4</Street>
      <Zip>sample string 6</Zip>
    </RetailersSearchItem>
    <RetailersSearchItem>
      <City>sample string 5</City>
      <LeafletShopSlug>sample string 2</LeafletShopSlug>
      <Location xmlns:d4p1="http://schemas.datacontract.org/2004/07/agilys.myshopi.search.Core.DTOs">
        <d4p1:Latitude>1.1</d4p1:Latitude>
        <d4p1:Longitude>2.1</d4p1:Longitude>
      </Location>
      <PinImageUrl>sample string 1</PinImageUrl>
      <RetailerName>sample string 3</RetailerName>
      <RetailerSlug>sample string 7</RetailerSlug>
      <Street>sample string 4</Street>
      <Zip>sample string 6</Zip>
    </RetailersSearchItem>
  </Shops>
  <Success>true</Success>
  <TotalCount>1</TotalCount>
</RetailersSearchResult>