Get category

Returns a single category from the active menu, including how it appears across channels, stores, and fulfillment types. Use this endpoint to render category headers, descriptions, and availability badges in your ordering UI.

Requires a Fire spark access token obtained through token exchange.

Path parameters

Parameter	Description
`id`	External category 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/categories/burgers?fulfillment_id=delivery&store_id=downtown&channel_id=app&brand_id=0001" \
  -H "Authorization: Bearer ACCESS_TOKEN"

Response

{
  "data": {
    "id": "burgers",
    "uid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "brand_id": "0001",
    "merchant_id": "22222222-2222-2222-2222-222222222222",
    "name": "Burgers",
    "description": "Hand-crafted burgers",
    "image_url": "https://cdn.example.com/mains.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",
                "availability": {
                  "status": "ACTIVE",
                  "schedules": [
                    { "day_of_week": "monday", "periods": [{ "start_time": "11:00:00", "end_time": "22:00:00" }] }
                  ],
                  "inactive_until": null
                },
                "items": [{ "type": "PRODUCT", "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }]
              }
            }
          }
        }
      }
    },
    "cms_template_id": null,
    "cms": null,
    "status": "ACTIVE"
  }
}

Category object

Field	Type	Description
`id`	string	External category 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 category description. Up to 500 characters. `null` when omitted.
`image_url`	string	Category image URL. `null` when omitted.
`channels`	object	Per-channel visibility and availability keyed by channel code.
`cms_template_id`	string (UUID)	CMS template linked to this category. `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:

Field	Required	Type	Description
`id`	Yes	string	External channel identifier.
`uid`	Yes	string (UUID)	Fire spark channel identifier.
`name`	Yes	string	Display name.
`stores`	Yes	object	Map of store codes to store configuration.

Each store entry:

Field	Required	Type	Description
`id`	Yes	string	External store identifier.
`uid`	Yes	string (UUID)	Fire spark store identifier.
`name`	Yes	string	Display name.
`fulfillment`	Yes	object	Map of fulfillment type codes to fulfillment configuration.

Each fulfillment entry:

Field	Required	Type	Description
`uid`	Yes	string (UUID)	Fire spark fulfillment identifier.
`id`	Yes	string	External fulfillment identifier.
`type`	Yes	string	Fulfillment type code (for example `DELIVERY`).
`name`	Yes	string	Display name.
`availability`	Yes	object	Category availability for this context. See availability.
`items`	No	array	Ordered category entries. Defaults to `[]`.

Each entry in items:

Field	Required	Type	Description
`type`	Yes	string	`CATEGORY` or `PRODUCT`.
`id`	Yes	string	External category or product identifier.

availability

Field	Required	Type	Description
`status`	Yes	string	`ACTIVE`, `INACTIVE`, or `HIDDEN`.
`schedules`	No	array \| null	Schedule entries with `day_of_week` and `periods`. `null` when there is no schedule restriction.
`inactive_until`	No	string	Optional ISO 8601 datetime when a temporary inactive state ends.

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 category.
`404`	Category not found in the active menu for this context.

API Documentation

Endpoints

Guides

Resources

Path parameters

Query parameters

Request

Response

Category object

Error responses

​Path parameters

​Query parameters

​Request

​Response

​Category object

​Error responses

Path parameters

Query parameters

Request

Response

Category object

Error responses