Get Available Stores

get
Get Available Stores

https://graph.whisk.com/v1/retailers
Returns list of available stores for a specified location.
Request
Response
Request
Path Parameters
country
optional
string
Country code in ISO 3166-1 alpha-2 format. E.g. GB, US, AU, etc.
zipcode
optional
string
Postal code
language
optional
string
Language supported by retailer in ISO 639-1 format. E.g. en, it, de. Default value: en.
Response
200: OK
{
"retailers": [
{
"id": "9dd9f254f3a3476a9801f7d9e236a0e3",
"name": "Tesco",
"displayName": "Tesco",
"country": "GB",
"currency": "GBP",
"logo": {
"url": "https://res.cloudinary.com/whisk/image/upload/whisk3/supermarket_select_dropdown/tesco-logo.png",
"width": 134,
"height": 36
},
"urls": {
"signupUrl": "https://secure.tesco.com/account/en-GB/register",
"forgotPasswordUrl": "https://secure.tesco.com/account/en-GB/forgotten-password",
"trolleyUrl": "https://www.tesco.com/groceries/en-GB/slots"
}
},
...
{
"id": "0d01dd723f484801bf0b7c26dc4f7985",
"name": "AmazonFresh",
"displayName": "Amazon Fresh",
"country": "GB",
"currency": "GBP",
"logo": {
"url": "https://whisk-res.cloudinary.com/image/upload/v1515760703/whisk3/supermarket_select_dropdown/amazon-fresh-2.png",
"width": 174,
"height": 36
}
}
]
}

To get available retailers for USor DE you need to specify a zip code so we will be able to verify available stores in the specified region.

You can use retailer identifiers for store transferring API and for cart API

If a country code was not specified, will be returned retailers available around the world.

Sample Request

curl "https://graph.whisk.com/v1/retailers?country=GB" \
-H "Accept: application/json" \
-H "Authorization: Token <Access-Token>"

Response

ATTRIBUTE

TYPE

DESCRIPTION

retailers

array [Retailer]

Retailer

ATTRIBUTE

TYPE

DESCRIPTION

id

string

name

string

displayName

string

country

string

currency

string

logo

ImageContainer

urls

RetailerUrls

Retailer Urls

ATTRIBUTE

TYPE

DESCRIPTION

signupUrl

string

forgotPasswordUrl

string

trolleyUrl

string