Search Store Items

GET
/v1beta/search?type=storeItem

Search store items by product name in specific store.

Parameters

ATTRIBUTETYPEDESCRIPTION
retailerId*string

Retailer identifier. (short names can be used)

q*string

Product name.

limitinteger

This is the maximum number of objects that may be returned.

Default value: 16
beforestring

This is the cursor to return data on a page before it.

afterstring

This is the cursor to return data from a next page.

Sample Request

curl "https://graph.whisk.com/v1beta/search?type=storeItem&retailerId=tesco&q=milk" \ -H "Accept: application/json" \ -H "Authorization: Token <Access-Token>"

Response

ATTRIBUTETYPEDESCRIPTION
items*array [CartProductOption]
paging*Paging

Store Item

ATTRIBUTETYPEDESCRIPTION
sku*string

store item identifier

name*string

store item name

quantity*CartProductQuantity

quantity of product items

price CartItemPrice

price for the quantity of products

images*array [ImageContainer]
urlstring

link to product page in store

Paging

ATTRIBUTETYPEDESCRIPTION
cursors*Cursors

Cursors

ATTRIBUTETYPEDESCRIPTION
afterstring
beforestring

Sample Response

{ "items": [ { "sku": "272103606", "name": "Alpro Hazelnut Fresh Milk Alternative Longlife Milk Alternative 1 L", "quantity": { "count": 1 }, "price": { "list": 1.8 }, "images": [ { "url": "https://img.tesco.com/Groceries/pi/866/5411188110866/IDShot_540x540.jpg" } ], "url": "https://www.tesco.com/groceries/en-GB/products/272103606" }, { "sku": "287971983", "name": "Arla Big Milk Whole Milk 2 Litre", "quantity": { "count": 1 }, "price": { "list": 2 }, "images": [ { "url": "https://img.tesco.com/Groceries/pi/179/5000181035179/IDShot_540x540.jpg" } ], "url": "https://www.tesco.com/groceries/en-GB/products/287971983" }, { "sku": "251314095", "name": "Tesco British Skimmed Milk 568Ml, 1 Pint", "quantity": { "count": 1 }, "price": { "list": 0.5 }, "images": [ { "url": "https://img.tesco.com/Groceries/pi/938/5031021057938/IDShot_540x540.jpg" } ], "url": "https://www.tesco.com/groceries/en-GB/products/251314095" }, { "sku": "251314158", "name": "Tesco British Semi Skimmed Milk 568 Ml, 1 Pint", "quantity": { "count": 1 }, "price": { "list": 0.5 }, "images": [ { "url": "https://img.tesco.com/Groceries/pi/952/5031021057952/IDShot_540x540.jpg" } ], "url": "https://www.tesco.com/groceries/en-GB/products/251314158" }, { "sku": "251314233", "name": "Tesco British Whole Milk 568Ml, 1 Pint", "quantity": { "count": 1 }, "price": { "list": 0.5 }, "images": [ { "url": "https://img.tesco.com/Groceries/pi/976/5031021057976/IDShot_540x540.jpg" } ], "url": "https://www.tesco.com/groceries/en-GB/products/251314233" }, { "sku": "251499687", "name": "Tesco Organic British Skimmed Milk 1.136L, 2 Pint", "quantity": { "count": 1 }, "price": { "list": 1.1 }, "images": [ { "url": "https://img.tesco.com/Groceries/pi/955/5050179761955/IDShot_540x540.jpg" } ], "url": "https://www.tesco.com/groceries/en-GB/products/251499687" }, { "sku": "251499710", "name": "Tesco Organic British Semi Skimmed Milk 1.136L, 2 Pint", "quantity": { "count": 1 }, "price": { "list": 1.1 }, "images": [ { "url": "https://img.tesco.com/Groceries/pi/979/5050179761979/IDShot_540x540.jpg" } ], "url": "https://www.tesco.com/groceries/en-GB/products/251499710" }, { "sku": "251499900", "name": "Tesco Organic British Whole Milk 1.136L, 2 Pint", "quantity": { "count": 1 }, "price": { "list": 1.1 }, "images": [ { "url": "https://img.tesco.com/Groceries/pi/051/5050179762051/IDShot_540x540.jpg" } ], "url": "https://www.tesco.com/groceries/en-GB/products/251499900" }, { "sku": "251499998", "name": "Tesco Organic British Semi Skimmed Milk 2.272L/4 Pints", "quantity": { "count": 1 }, "price": { "list": 1.84 }, "images": [ { "url": "https://img.tesco.com/Groceries/pi/099/5050179762099/IDShot_540x540.jpg" } ], "url": "https://www.tesco.com/groceries/en-GB/products/251499998" }, { "sku": "251500030", "name": "Tesco Organic British Whole Milk 2.272L/4 Pints", "quantity": { "count": 1 }, "price": { "list": 1.84 }, "images": [ { "url": "https://img.tesco.com/Groceries/pi/112/5050179762112/IDShot_540x540.jpg" } ], "url": "https://www.tesco.com/groceries/en-GB/products/251500030" } ], "paging": { "cursors": { "after": "eyJpZCI6IjI1MTUwMDAzMCIsImluZGV4Ijo5fQ==" } } }