Get a Product Batch

This endpoint retrieves a list of products filtered by pagination and timestamp.

get
Get Product Batch

https://api.studio.whisk.com/products/v1/get/batch
You can append the following query parameters to the base URL to pull data from Whisk Studio:
Request
Response
Request
Headers
Authentication
required
string
Server token to authorize the API usage. For more information, see Authentication.
Query Parameters
paging.limit
optional
integer
The maximum number of products to retrieve.
paging.after
optional
string
This parameter is used for cursor-based pagination. It takes a product ID as its value and retrieves only those products that appear after it in the database. For example, 5ff905b3030cc211abb31fb7.
fields
optional
string
Any additional product details to retrieve. You can choose one or more of these supported values: - EXTRA_PRODUCT_FIELD_INVALID - EXTRA_PRODUCT_FIELD_NUTRITION For performance reasons, we recommend using this parameter only when required.
updated_at.min
optional
string
Date and time in Unix format to indicate that only those products get retrieved that were updated after it. For example, 1608886602824.
updated_at.max
optional
string
Date and time in Unix format to indicate that only those products get retrieved that were updated before it. For example, 1610999038495.
integration_id
required
string
An identifier to indicate the integration type. See Integration API for more
Response
200: OK
This is how a successful response looks.
{
"products": [
{
"id": "string",
"name": "string",
"gtin": "string",
"description": "string",
"brand": "string",
"created_at": "string",
"updated_at": "string",
"images": [
{
"url": "string",
"responsive": {
"url": "string",
"width": 0,
"height": 0
}
}
],
"language": "string",
"price": {
"rrp": {
"currency_code": "string",
"cents": "string"
}
},
"instructions": [
{
"text": "string",
"group": "string"
}
],
"ingredients": [
{
"text": "string",
"group": "string"
}
],
"url": "string",
"author": {
"id": "string",
"name": "string",
"image": {
"url": "string",
"responsive": {
"url": "string",
"width": 0,
"height": 0
}
}
},
"amount": {
"unit": "string",
"quantity": 0
},
"serving_size": {
"unit": "string",
"quantity": 0
},
"nutrition": [
{
"label": "string",
"code": "NUTRITION_CODE_INVALID",
"value": 0,
"unit": "NUTRITION_UNIT_INVALID"
}
],
"external_product_id": "string"
}
],
"paging": {
"total": "string",
"after": "string"
}
}
400: Bad Request
This failed response appears when error codes are found in the endpoint query.
{
"error_code": "REAL_CODES_ARE_IN_ENDPOINT_DESCRIPTION",
"message": "Additional details about error are not static and can be changed"
}
401: Unauthorized
This failed response appears due to API authentication failure. The possible error codes that may appear are: auth.tokenNotFound , auth.tokenExpired, auth.tokenInvalid, auth.tokenRequired.
{
"code": "auth.tokenNotFound"
}
500: Internal Server Error
This failed response appears when something is not right on Whisk's end. Please send a message to help@whisk.com, and be sure to include both the Request and Response data. We’ll get back to you soon.
This is unexpected response, something is wrong on our side, please contact: help@whisk.com

Sample Request and Response

Curl Request
Response
Curl Request
curl -X GET "https://api.studio.whisk.com/products/v1/get/batch?paging.limit=3&fields=EXTRA_PRODUCT_FIELD_NUTRITION&updated_at.max=1610999038495&integration_id=3a2b8cfd-27cd-4c81-ab79-e31e03e56c20"
-H "Accept: application/json"
-H "Authorization: Bearer <YOUR-API-ACCESS-KEY>"

Note: Whisk allows you to discover and understand its API capabilities on the Swagger interface with the ability to try out the API calls directly in your browser. You can call this endpoint here.

Response
{
"products": [
{
"id": "5febbcd1bc31826090025de5",
"name": "Bitchin' Sauce Original",
"gtin": "00123456789121",
"description": "The OG. Where Bitchin' began. Creamy lemon and garlic. Simple and Satisfying.",
"created_at": "1609284817642",
"updated_at": "1609284863384",
...
},
{
"id": "5ff905b3030cc211abb31fb7",
"name": "Hienz Ketchup",
"created_at": "1610155443277",
"updated_at": "1610155443277",
...
},
{
"id": "5fc68566968f2e51ce557699",
"name": "Boar's Head Naturally Smoked Bacon",
"created_at": "1606845798758",
"updated_at": "1608318685438",
...
}
],
"paging": {
"total": "15",
"after": "3"
}
}

Note: To understand the data structure of the recipe definition, see Product Object.