Skip to main content
GET
/
api
/
v1
/
locations
/
{locationId}
/
products
Get Products by Location
curl --request GET \
  --url https://api.cravejs.com/api/v1/locations/{locationId}/products \
  --header 'X-API-Key: <api-key>'
[
  {
    "id": "64a7b8c9d1e2f3a4b5c6d7e8",
    "name": "Margherita Pizza",
    "availability": "available",
    "description": "Fresh mozzarella, basil, and tomato sauce on our signature crust",
    "price": "16.99",
    "images": [
      "https://example.com/images/margherita-pizza.jpg"
    ],
    "modifierIds": [
      "64a7b8c9d1e2f3a4b5c6d7e9",
      "64a7b8c9d1e2f3a4b5c6d7ea"
    ],
    "modifiers": []
  },
  {
    "id": "64a7b8c9d1e2f3a4b5c6d7eb",
    "name": "Pepperoni Pizza",
    "availability": "available",
    "description": "Classic pepperoni with mozzarella cheese and tomato sauce",
    "price": "18.99",
    "images": [
      "https://example.com/images/pepperoni-pizza.jpg"
    ],
    "modifierIds": [
      "64a7b8c9d1e2f3a4b5c6d7e9",
      "64a7b8c9d1e2f3a4b5c6d7ea"
    ],
    "modifiers": []
  },
  {
    "id": "64a7b8c9d1e2f3a4b5c6d7ec",
    "name": "Caesar Salad",
    "availability": "available",
    "description": "Crisp romaine lettuce, parmesan cheese, croutons, and our house-made Caesar dressing",
    "price": "12.99",
    "images": [],
    "modifierIds": [
      "64a7b8c9d1e2f3a4b5c6d7ed"
    ],
    "modifiers": []
  }
]

​
Path Parameters

​
locationId
string
required
The unique identifier for the restaurant location

​
Query Parameters

​
productIds
string
Comma-separated list of product IDs to retrieve (optional)
Example: prod_123,prod_456,prod_789

​
Headers

​
X-API-Key
string
required
Storefront API key for authentication
[
  {
    "id": "64a7b8c9d1e2f3a4b5c6d7e8",
    "name": "Margherita Pizza",
    "availability": "available",
    "description": "Fresh mozzarella, basil, and tomato sauce on our signature crust",
    "price": "16.99",
    "images": [
      "https://example.com/images/margherita-pizza.jpg"
    ],
    "modifierIds": [
      "64a7b8c9d1e2f3a4b5c6d7e9",
      "64a7b8c9d1e2f3a4b5c6d7ea"
    ],
    "modifiers": []
  },
  {
    "id": "64a7b8c9d1e2f3a4b5c6d7eb",
    "name": "Pepperoni Pizza",
    "availability": "available",
    "description": "Classic pepperoni with mozzarella cheese and tomato sauce",
    "price": "18.99",
    "images": [
      "https://example.com/images/pepperoni-pizza.jpg"
    ],
    "modifierIds": [
      "64a7b8c9d1e2f3a4b5c6d7e9",
      "64a7b8c9d1e2f3a4b5c6d7ea"
    ],
    "modifiers": []
  },
  {
    "id": "64a7b8c9d1e2f3a4b5c6d7ec",
    "name": "Caesar Salad",
    "availability": "available",
    "description": "Crisp romaine lettuce, parmesan cheese, croutons, and our house-made Caesar dressing",
    "price": "12.99",
    "images": [],
    "modifierIds": [
      "64a7b8c9d1e2f3a4b5c6d7ed"
    ],
    "modifiers": []
  }
]

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
locationId
string
required

The unique identifier for the restaurant location

Query Parameters

​
productIds
string

Comma-separated list of product IDs to retrieve. If not provided, returns all products.

Response

Products retrieved successfully.

​
id
string

Unique identifier for the product

​
name
string

Product name

​
description
string

Product description

​
price
string

Product price

​
availability
enum<string>

Product availability status

Available options:
available,
unavailable
​
images
string[]

Array of product image URLs

​
modifierIds
string[]

Array of modifier group IDs

​
modifiers
object[]

Array of modifier objects