Skip to main content
Get Item API

Retrieve item details using a specific item_id.

Updated over a year ago

Overview

Retrieve item details using a specific item_id.

Request

Endpoint:

/v1/item

Method:

GET

Headers:

Authorization: <Your-API-Key>

When forming your request, include a JSON payload with the specific item_id you're interested in:

{
"item_id": "your_item_id"
}

Replace your_item_id with the actual ID of the collection you're inquiring about.

Response

Upon submitting the request, the API will provide details related to the given item.

Example Request Body

{
"item_id": "988ed94365aa4a74c30cd832"
}

Expected Response

{
"item_name": "The Classic Burger",
"description": "8 oz Beef Burger | Lettuce | Tomatoes | Cheddar
"price": "18",
"dietary": "Can be GF",
"allergies": "Dairy",
"status": "active"
}

If an item is currently unavailable or if it's been temporarily removed from the menu (often referred to as "86'd"), the status will be marked as "unavailable."

Did this answer your question?