POST retailers/suggestions

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Prefix	string	Required Max length: 32 Min length: 3
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:

{
  "Prefix": "sample string 1",
  "ApiKey": "586ad38d-c285-4cd8-8d04-0cc8024fa693",
  "ApplicationVersion": 3,
  "Udid": "sample string 4",
  "UserID": "05071f88-2bca-4c55-9787-2cbd886f618e",
  "ZoneID": 6
}

application/xml, text/xml

Sample:

<RetailersSuggestionsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Retailers">
  <ApiKey>586ad38d-c285-4cd8-8d04-0cc8024fa693</ApiKey>
  <ApplicationVersion>3</ApplicationVersion>
  <Udid>sample string 4</Udid>
  <UserID>05071f88-2bca-4c55-9787-2cbd886f618e</UserID>
  <ZoneID>6</ZoneID>
  <Prefix>sample string 1</Prefix>
</RetailersSuggestionsRequest>

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 'RetailersSuggestionsRequest'.

Response Information

Resource Description

RetailersSuggestionsResult

Name	Description	Type	Additional information
Suggestions		Collection of RetailersSuggestionItem	None.
Success		boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "Suggestions": [
    {
      "Text": "sample string 1",
      "ShopInfoSuggestionType": 0
    },
    {
      "Text": "sample string 1",
      "ShopInfoSuggestionType": 0
    }
  ],
  "Success": true
}

application/xml, text/xml

Sample:

<RetailersSuggestionsResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Retailers">
  <Success>true</Success>
  <Suggestions>
    <RetailersSuggestionItem>
      <ShopInfoSuggestionType>Unknown</ShopInfoSuggestionType>
      <Text>sample string 1</Text>
    </RetailersSuggestionItem>
    <RetailersSuggestionItem>
      <ShopInfoSuggestionType>Unknown</ShopInfoSuggestionType>
      <Text>sample string 1</Text>
    </RetailersSuggestionItem>
  </Suggestions>
</RetailersSuggestionsResult>