Skip to main content
GET
/
locations
/
{locationId}
/
products
/
{productId}
Get a product with modifier tree
curl --request GET \
  --url https://api.craveup.com/api/v1/locations/{locationId}/products/{productId} \
  --header 'X-API-Key: <api-key>'
{
  "id": "prod_margherita",
  "name": "Margherita Pizza",
  "description": "Tomato, basil, mozzarella.",
  "availability": "AVAILABLE",
  "images": [
    "https://cdn.craveup.com/products/margherita.png"
  ],
  "price": "1800",
  "displayPrice": "$18.00",
  "currency": "usd",
  "locationId": "loc_456def",
  "modifierIds": [
    "mod_group_sauces"
  ],
  "modifiers": [
    {
      "id": "mod_group_sauces",
      "name": "Sauce Selection",
      "description": null,
      "rule": {
        "min": 0,
        "max": 2
      },
      "items": [
        {
          "id": "mod_item_bbq",
          "name": "BBQ Sauce",
          "price": "0.50",
          "maxQuantity": 2,
          "childGroups": []
        }
      ]
    }
  ]
}

Authorizations

​
X-API-Key
string
header
required

API Key required to authenticate requests

Path Parameters

​
locationId
string
required
​
productId
string
required

Response

Product retrieved successfully.

​
id
string
required
Example:

"prod_bbq_chicken"

​
name
string
required
Example:

"BBQ Chicken Pizza"

​
availability
string
required
Example:

"AVAILABLE"

​
price
string
required
Example:

"21.00"

​
displayPrice
string
required
Example:

"$21.00"

​
currency
string
required
Example:

"usd"

​
locationId
string
required
Example:

"loc_456def"

​
description
string | null
​
images
string[]
​
modifierIds
string[]
​
modifiers
object[]