Skip to main content
GET
Retrieve a product

Authorizations

x-api-key
string
header
required

Location/organization API key.

Path Parameters

location_id
string
required
catalog_id
string
required
product_id
string
required

Response

The product.

A sellable product. Internal SKU details are never exposed.

id
string
required
Pattern: ^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$
Example:

"burger-classic"

name
string
required
Example:

"Classic Burger"

category_id
string
required
Example:

"burgers"

price
object
required
modifier_group_ids
string[]
required
disabled
boolean
default:false
required

Whether the resource is hidden and cannot be ordered.

out_of_stock
boolean
default:false
required

Whether the resource is temporarily unavailable while remaining visible.

restrictions
object[]
required

Availability windows. The resource is available when any restriction matches.

Maximum array length: 100
price_overrides
object[]
required

Conditional prices. The matching override with the most specific conditions wins.

Maximum array length: 100
bundle_only
boolean
default:false
required

Whether the product can only be selected inside a bundle.

order
integer
required

Optional sort order. Omitted products are placed after explicitly ordered products in their category.

Required range: x >= 0
object
enum<string>
required
Available options:
product
created_at
string<date-time>
required
updated_at
string<date-time>
required
description
string | null
image_url
string<uri> | null