Dulux Group API Service

<back to all web services

Stores

The following routes are available for this service:
GET/Stores
GET/Stores/{BrandName}
GET/Stores/{BrandName}/{StoreFriendlyName}
GET/Stores/{BrandName}/Nearby
Stores Parameters:
NameParameterData TypeRequiredDescription
IdqueryintNo
BrandNamepathstringNo
StoreFriendlyNamepathstringNo
RangeIdsqueryIList<int>No
LatitudequerydoubleNo
LongitudequerydoubleNo
RadiusqueryintNo
PostCodequeryintNo
StatequerystringNo
isRetailerquerybool?No
isTraderquerybool?No
IncludeRangesquerybool?No
DealerTypequeryDealer?No
StoreResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
IdformintNo
NameformstringNo
NameStrippedformstringNo
CalculatedNearbyDistanceKMformdouble?No
AddressformAddressNo
RangesformIList<RangeResponse>No
PhoneformstringNo
EmailformstringNo
OpeningHoursformstringNo
WebsiteformstringNo
IsRetailerformboolNo
IsTradeformboolNo
IsShowRoomformboolNo
SEOAreaKeywordformstringNo
AfterHoursContactformstringNo
DescriptionformstringNo
ProductsformstringNo
ServicesformstringNo
AreaServicedNamesformstring[]No
AreaServicedPostcodesformstring[]No
ImageUrlformstringNo
IsCampaignformboolNo
CampaignDescriptionformstringNo
CampaignOpeningHoursLine1formstringNo
CampaignOpeningHoursLine2formstringNo
CampaignOpeningHoursLine3formstringNo
ProductIdsformstringNo
ProductsExtraListsformstringNo
Address Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
StreetformstringNo
SuburbformstringNo
PostcodeformstringNo
StateformstringNo
LatformstringNo
LongformstringNo
CityformstringNo
CountryformstringNo
RangeResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
IdformintNo
NameformstringNo
NameStrippedformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /jsv/reply/Stores HTTP/1.1 
Host: digital-prod-umbracosharedapi-appservice.azurewebsites.net 
Content-Type: text/jsv
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/jsv
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
}