GET | /Stores | ||
---|---|---|---|
GET | /Stores/{BrandName} | ||
GET | /Stores/{BrandName}/{StoreFriendlyName} | ||
GET | /Stores/{BrandName}/Nearby |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | query | int | No | |
BrandName | path | string | No | |
StoreFriendlyName | path | string | No | |
RangeIds | query | IList<int> | No | |
Latitude | query | double | No | |
Longitude | query | double | No | |
Radius | query | int | No | |
PostCode | query | int | No | |
State | query | string | No | |
isRetailer | query | bool? | No | |
isTrader | query | bool? | No | |
IncludeRanges | query | bool? | No | |
DealerType | query | Dealer? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No | |
Id | form | int | No | |
Name | form | string | No | |
NameStripped | form | string | No | |
CalculatedNearbyDistanceKM | form | double? | No | |
Address | form | Address | No | |
Ranges | form | IList<RangeResponse> | No | |
Phone | form | string | No | |
form | string | No | ||
OpeningHours | form | string | No | |
Website | form | string | No | |
IsRetailer | form | bool | No | |
IsTrade | form | bool | No | |
IsShowRoom | form | bool | No | |
SEOAreaKeyword | form | string | No | |
AfterHoursContact | form | string | No | |
Description | form | string | No | |
Products | form | string | No | |
Services | form | string | No | |
AreaServicedNames | form | string[] | No | |
AreaServicedPostcodes | form | string[] | No | |
ImageUrl | form | string | No | |
IsCampaign | form | bool | No | |
CampaignDescription | form | string | No | |
CampaignOpeningHoursLine1 | form | string | No | |
CampaignOpeningHoursLine2 | form | string | No | |
CampaignOpeningHoursLine3 | form | string | No | |
ProductIds | form | string | No | |
ProductsExtraLists | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | |
Street | form | string | No | |
Suburb | form | string | No | |
Postcode | form | string | No | |
State | form | string | No | |
Lat | form | string | No | |
Long | form | string | No | |
City | form | string | No | |
Country | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No | |
Id | form | int | No | |
Name | form | string | No | |
NameStripped | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /csv/reply/Stores HTTP/1.1
Host: digital-prod-umbracosharedapi-appservice.azurewebsites.net
Content-Type: text/csv
Content-Length: length
{"id":0,"brandName":"String","storeFriendlyName":"String","latitude":0,"longitude":0,"radius":0,"postCode":0,"state":"String","isRetailer":false,"isTrader":false,"includeRanges":false,"dealerType":"0"}
HTTP/1.1 200 OK Content-Type: text/csv Content-Length: length {"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"id":0,"name":"String","nameStripped":"String","calculatedNearbyDistanceKM":0,"address":{"id":0,"street":"String","suburb":"String","postcode":"String","state":"String","lat":"String","long":"String","city":"String","country":"String"},"phone":"String","email":"String","openingHours":"String","website":"String","isRetailer":false,"isTrade":false,"isShowRoom":false,"seoAreaKeyword":"String","afterHoursContact":"String","description":"String","products":"String","services":"String","areaServicedNames":["String"],"areaServicedPostcodes":["String"],"imageUrl":"String","isCampaign":false,"campaignDescription":"String","campaignOpeningHoursLine1":"String","campaignOpeningHoursLine2":"String","campaignOpeningHoursLine3":"String","productIds":"String","productsExtraLists":"String"}