Get a Product

This endpoint retrieves product information using the product identifier.

get
Get Product

https://api.studio.whisk.com/products/v1/get
You can append the following query parameters to the base URL to pull data of any particular product from Whisk Studio:
Request
Response
Request
Headers
Authentication
required
string
Server token to authorize the API usage. For more information, see Authentication.
Query Parameters
product_id
required
string
The product identifier. For example, 5fb83b7cdc54e606d155613e.
fields
optional
array
Any additional recipe details to retrieve. You can choose one or more of these supported values: - EXTRA_PRODUCT_FIELD_INVALID - PRODUCT_EXTRA_FIELD_NUTRITION For performance reasons, we recommend using this parameter only when required.
integration_id
required
string
An identifier to indicate the integration type. See Integration API for more information.
Response
200: OK
This is how a successful response looks.
{
"product": {
"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"
}
}
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?product_id=5fb83b7cdc54e606d155613e&fields=EXTRA_PRODUCT_FIELD_NUTRITION&integration_id=a8dd7887-f752-4783-8724-16467a6665ef"
-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
{
"product": {
"id": "5fb83b7cdc54e606d155613e",
"name": "Sabra Classic Guacamole",
"description": "It's always "fiesta o'clock" with the fresh taste of our guacamole, made with Mexican-grown Hass avocados. Our authentic recipe is flavorful and chunky--just like homemade.",
"created_at": "1605909372473",
"updated_at": "1605909372473",
"images": [
{
"url":"https://img.cjthemarket.com/images/file/product/973/20191226105710715.jpg",
"responsive": {
"url": "https://whisk-res.cloudinary.com/image/upload/v1605909200/v3/user-recipes/it1mlzs2ab34tdhfsfxk.png",
"width": 640,
"height": 640
}
}
],
"language": "en",
"ingredients": [
{
"text": "Hass Avocado, Onion, Tomato, Jalapeno Pepper, Salt, Garlic, Lime Juice Concentrate, Dehydrated Onion, Cilantro, Ascorbic Acid (added to maintain freshness)."
}
],
"url": "https://sabra.com/dips/guacamole/classic-guacamole.html",
"nutrition": [
{
"label": "Energy",
"code": "NUTRITION_CODE_ENERC_KCAL",
"unit": "NUTRITION_UNIT_KCAL"
},
...
]
}
}

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