POST retailers/suggestions
Request Information
URI Parameters
None.
Body Parameters
RetailersSuggestionsRequestName | Description | 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": "8b528f57-1798-4485-8820-cd07042620f0", "ApplicationVersion": 3, "Udid": "sample string 4", "UserID": "57bd4025-3901-449f-b8bf-70d0dc5172b1", "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>8b528f57-1798-4485-8820-cd07042620f0</ApiKey> <ApplicationVersion>3</ApplicationVersion> <Udid>sample string 4</Udid> <UserID>57bd4025-3901-449f-b8bf-70d0dc5172b1</UserID> <ZoneID>6</ZoneID> <Prefix>sample string 1</Prefix> </RetailersSuggestionsRequest>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
RetailersSuggestionsResultName | 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>