Get product

Returns a single product from the active menu, including localized name and description, image, and per-channel pricing and availability. Use this endpoint for product detail pages or to hydrate cart line items.

Requires a Fire spark access token obtained through token exchange.

Path parameters

Parameter	Description
`id`	External product identifier. Alphanumeric characters, `_`, and `-` only. 1–64 characters.

Query parameters

Parameter	Required	Description
`fulfillment_id`	No	External fulfillment identifier.
`store_id`	No	External store identifier.
`channel_id`	No	External channel identifier.
`brand_id`	No	External brand identifier.

Request

curl "https://firespark.cloud/api/storefront/v1/menus/products/burger-classic?fulfillment_id=delivery&store_id=downtown&channel_id=app&brand_id=0001" \
  -H "Authorization: Bearer ACCESS_TOKEN"

Response

{
  "data": {
    "id": "burger-classic",
    "uid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "brand_id": "0001",
    "merchant_id": "22222222-2222-2222-2222-222222222222",
    "name": "Classic burger",
    "description": "Angus beef patty with lettuce and tomato.",
    "image_url": "https://cdn.example.com/burger-classic.jpg",
    "channels": {
      "APP": {
        "id": "app",
        "uid": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
        "name": "Mobile app",
        "stores": {
          "downtown": {
            "id": "downtown",
            "uid": "c3d4e5f6-a7b8-9012-cdef-123456789012",
            "name": "Downtown",
            "fulfillment": {
              "DELIVERY": {
                "uid": "d4e5f6a7-b8c9-0123-def4-567890abcdef",
                "id": "delivery",
                "type": "DELIVERY",
                "name": "Delivery",
                "pricing": {
                  "minimum_quantity": 1,
                  "maximum_quantity": 10,
                  "is_tax_inclusive": true,
                  "tax_rate": 0.15,
                  "price": 12.99,
                  "anchor_price": 14.99,
                  "anchor_price_percentage": 0.13,
                  "modifiers": [],
                  "modifier_group_ids": ["choose-drink"]
                },
                "availability": {
                  "status": "AVAILABLE",
                  "schedules": [
                    { "day_of_week": "monday", "periods": [{ "start_time": "11:00:00", "end_time": "22:00:00" }] }
                  ],
                  "out_of_stock_until": null
                },
                "bundled_items": []
              }
            }
          }
        }
      }
    },
    "cms_template_id": null,
    "cms": null,
    "status": "ACTIVE"
  }
}

Product object

Field	Type	Description
`id`	string	External product identifier.
`uid`	string (UUID)	Fire spark internal identifier.
`brand_id`	string \| null	External brand identifier. `null` when the resource is not brand-scoped.
`merchant_id`	string (UUID)	Fire spark merchant identifier.
`name`	string	Display name. 1–100 characters.
`description`	string	Optional description. Up to 500 characters. `null` when omitted.
`image_url`	string	Product image URL.
`channels`	object	Per-channel, per-store, per-fulfillment pricing and availability.
`cms_template_id`	string (UUID)	CMS template linked to this product. `null` when no template is assigned.
`cms`	object	Read-only. Resolved CMS template when assigned.
`status`	string	`ACTIVE` or `INACTIVE`.

channels

Map of channel codes. Each entry contains id, uid, name, and a stores map.Each store contains id, uid, name, and a fulfillment map keyed by fulfillment type code.Each fulfillment entry requires uid, id, type, name, pricing, and availability.

pricing

Field	Required	Type	Description
`minimum_quantity`	Yes	number	Minimum units per order. ≥ 0.
`maximum_quantity`	Yes	number	Maximum units per order. 0–1,000,000.
`is_tax_inclusive`	Yes	boolean	Whether `price` includes tax.
`tax_rate`	Yes	number	Tax rate as a decimal (for example `0.15` for 15%). 0–1.
`price`	Yes	number	List price. ≥ 0.
`anchor_price`	Yes	number	Reference price for strikethrough or comparison. ≥ 0.
`anchor_price_percentage`	Yes	number	Discount shown relative to `anchor_price`. 0–1.
`starting_price`	No	number \| null	Lowest price reachable once required modifiers are chosen. Show it as “From $X” when it is higher than `price`. `null` or absent means show `price`.
`modifiers`	No	array	Per-modifier pricing overrides. Defaults to `[]`.
`modifier_group_ids`	No	array	Modifier groups attached to this product. Defaults to `[]`.
`variant_group_ids`	No	array	Variant groups asked on this base product. Each id must exist in `variant_groups` and appear once. A product with variant groups can’t have `modifier_group_ids`. Defaults to `[]`. See Variants.
`variants`	No	array	When this product is a variant: one entry per base, each `{ "product_id": base id, "variant_group_option_ids": [...] }` with exactly one option from every group on the base. Defaults to `[]`.

Each fulfillment entry may also include bundled_items — items included in a bundle or combo:

Field	Required	Type	Description
`id`	Yes	string	External identifier of the bundled product.
`refund_price`	Yes	number	Refund amount when the customer removes this item. ≥ 0.
`included_quantity`	Yes	number	Units included by default. ≥ 0.

availability

Field	Required	Type	Description
`status`	Yes	string	`AVAILABLE`, `HIDDEN`, or `OUT_OF_STOCK`.
`schedules`	No	array \| null	Schedule entries with `day_of_week` and `periods`. `null` when there is no schedule restriction.
`out_of_stock_until`	No	string	Optional ISO 8601 datetime when the product returns to stock.

Each schedule entry contains day_of_week (monday through sunday) and a periods array. Each period has optional closed (default false), start_time, end_time, and optional start_date / end_date bounds.

Error responses

Status	Description
`401`	Missing or invalid access token.
`403`	Token does not have access to this product.
`404`	Product not found in the active menu for this context.

API Documentation

Endpoints

Guides

Resources

Path parameters

Query parameters

Request

Response

Product object

Error responses

​Path parameters

​Query parameters

​Request

​Response

​Product object

​Error responses

Path parameters

Query parameters

Request

Response

Product object

Error responses