Upsert menus

curl --request PUT \
  --url 'https://firespark.cloud/api/integrations/v1/menus?fulfillment_id=delivery&store_id=downtown&channel_id=app&brand_id=0001' \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -H "x-release-id: 2026-07-03-baseline" \
  -d '{
    "style": "DEFAULT",
    "products": [
      {
        "id": "burger-classic",
        "name": { "en_us": "Classic burger" },
        "description": { "en_us": "Angus beef patty with lettuce and tomato." },
        "image_url": "https://cdn.example.com/burger-classic.jpg",
        "bundled_items": [],
        "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": null,
          "out_of_stock_until": null
        },
        "metadata": {}
      },
      {
        "id": "soda",
        "name": { "en_us": "Soda" },
        "description": null,
        "image_url": null,
        "bundled_items": [],
        "pricing": {
          "minimum_quantity": 0,
          "maximum_quantity": 1,
          "is_tax_inclusive": true,
          "tax_rate": 0.15,
          "price": 0,
          "anchor_price": 0,
          "anchor_price_percentage": 0,
          "modifiers": [],
          "modifier_group_ids": []
        },
        "availability": {
          "status": "AVAILABLE",
          "schedules": null,
          "out_of_stock_until": null
        },
        "metadata": {}
      },
      {
        "id": "cola",
        "name": { "en_us": "Cola" },
        "description": null,
        "image_url": null,
        "bundled_items": [],
        "pricing": {
          "minimum_quantity": 0,
          "maximum_quantity": 1,
          "is_tax_inclusive": true,
          "tax_rate": 0.15,
          "price": 0,
          "anchor_price": 0,
          "anchor_price_percentage": 0,
          "modifiers": [],
          "modifier_group_ids": []
        },
        "availability": {
          "status": "AVAILABLE",
          "schedules": null,
          "out_of_stock_until": null
        },
        "metadata": {}
      }
    ],
    "categories": [
      {
        "id": "mains",
        "name": { "en_us": "Mains" },
        "description": { "en_us": "Burgers and sandwiches" },
        "items": [{ "type": "PRODUCT", "id": "burger-classic" }],
        "availability": {
          "status": "ACTIVE",
          "schedules": null,
          "inactive_until": null
        },
        "metadata": {}
      }
    ],
    "modifier_groups": [
      {
        "id": "choose-drink",
        "title": { "en_us": "Choose a drink" },
        "description": null,
        "display_type": "LIST",
        "modifier_ids": ["cola", "soda"],
        "minimum_quantity": 0,
        "maximum_quantity": 1,
        "charge_above_quantity": null,
        "metadata": {}
      }
    ],
    "menus": [
      {
        "id": "lunch-delivery",
        "name": { "en_us": "Lunch delivery menu" },
        "description": { "en_us": "Weekday lunch items for app delivery" },
        "schedules": null,
        "metadata": {},
        "category_ids": ["mains"],
        "status": "ACTIVE"
      }
    ]
  }'

curl --request PUT \
  --url 'https://firespark.cloud/api/integrations/v1/menus?fulfillment_id=delivery&store_id=downtown&channel_id=uber-eats&brand_id=0001' \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -H "x-release-id: 2026-07-03-uber" \
  -d '{
    "style": "UBER_EATS",
        "display_options": {
          "disable_item_instructions": true
        },
        "items": [
          {
            "id": "Coffee",
            "title": { "translations": { "en_us": "Coffee" } },
            "description": { "translations": { "en_us": "Deliciously roasted beans" } },
            "modifier_group_ids": { "ids": ["Add-milk"] },
            "price_info": { "price": 300 },
            "tax_info": { "tax_rate": 8 },
            "quantity_info": {}
          },
          {
            "id": "Milk",
            "title": { "translations": { "en_us": "Milk" } },
            "quantity_info": {
              "overrides": [
                {
                  "context_type": "MODIFIER_GROUP",
                  "context_value": "Add-milk",
                  "quantity": { "max_permitted": 1 }
                }
              ]
            },
            "price_info": {
              "price": 0,
              "overrides": [
                {
                  "context_type": "MODIFIER_GROUP",
                  "context_value": "Add-milk",
                  "price": 0
                }
              ]
            },
            "tax_info": { "tax_rate": 8 }
          }
        ],
        "categories": [
          {
            "id": "Drinks",
            "title": { "translations": { "en_us": "Drinks" } },
            "entities": [{ "type": "ITEM", "id": "Coffee" }]
          }
        ],
        "modifier_groups": [
          {
            "id": "Add-milk",
            "title": { "translations": { "en_us": "Add milk" } },
            "modifier_options": [{ "type": "ITEM", "id": "Milk" }],
            "quantity_info": { "quantity": { "max_permitted": 1 } },
            "display_type": null
          }
        ],
        "menus": [
          {
            "id": "All-day",
            "title": { "translations": { "en_us": "All day" } },
            "category_ids": ["Drinks"],
            "service_availability": [
              {
                "day_of_week": "monday",
                "time_periods": [{ "start_time": "00:00", "end_time": "23:59" }]
              },
              {
                "day_of_week": "tuesday",
                "time_periods": [{ "start_time": "00:00", "end_time": "23:59" }]
              },
              {
                "day_of_week": "wednesday",
                "time_periods": [{ "start_time": "00:00", "end_time": "23:59" }]
              },
              {
                "day_of_week": "thursday",
                "time_periods": [{ "start_time": "00:00", "end_time": "23:59" }]
              },
              {
                "day_of_week": "friday",
                "time_periods": [{ "start_time": "00:00", "end_time": "23:59" }]
              },
              {
                "day_of_week": "saturday",
                "time_periods": [{ "start_time": "00:00", "end_time": "23:59" }]
              },
              {
                "day_of_week": "sunday",
                "time_periods": [{ "start_time": "00:00", "end_time": "23:59" }]
              }
            ]
          }
        ]
      }'

{
  "data": [
    {
      "id": "<string>",
      "name": {
        "en_us": "Example"
      },
      "description": {
        "en_us": "Example"
      },
      "schedules": [
        {}
      ],
      "metadata": {},
      "cms_template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "category_ids": [
        "<string>"
      ]
    }
  ]
}

PUT

menus

curl --request PUT \
  --url 'https://firespark.cloud/api/integrations/v1/menus?fulfillment_id=delivery&store_id=downtown&channel_id=app&brand_id=0001' \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -H "x-release-id: 2026-07-03-baseline" \
  -d '{
    "style": "DEFAULT",
    "products": [
      {
        "id": "burger-classic",
        "name": { "en_us": "Classic burger" },
        "description": { "en_us": "Angus beef patty with lettuce and tomato." },
        "image_url": "https://cdn.example.com/burger-classic.jpg",
        "bundled_items": [],
        "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": null,
          "out_of_stock_until": null
        },
        "metadata": {}
      },
      {
        "id": "soda",
        "name": { "en_us": "Soda" },
        "description": null,
        "image_url": null,
        "bundled_items": [],
        "pricing": {
          "minimum_quantity": 0,
          "maximum_quantity": 1,
          "is_tax_inclusive": true,
          "tax_rate": 0.15,
          "price": 0,
          "anchor_price": 0,
          "anchor_price_percentage": 0,
          "modifiers": [],
          "modifier_group_ids": []
        },
        "availability": {
          "status": "AVAILABLE",
          "schedules": null,
          "out_of_stock_until": null
        },
        "metadata": {}
      },
      {
        "id": "cola",
        "name": { "en_us": "Cola" },
        "description": null,
        "image_url": null,
        "bundled_items": [],
        "pricing": {
          "minimum_quantity": 0,
          "maximum_quantity": 1,
          "is_tax_inclusive": true,
          "tax_rate": 0.15,
          "price": 0,
          "anchor_price": 0,
          "anchor_price_percentage": 0,
          "modifiers": [],
          "modifier_group_ids": []
        },
        "availability": {
          "status": "AVAILABLE",
          "schedules": null,
          "out_of_stock_until": null
        },
        "metadata": {}
      }
    ],
    "categories": [
      {
        "id": "mains",
        "name": { "en_us": "Mains" },
        "description": { "en_us": "Burgers and sandwiches" },
        "items": [{ "type": "PRODUCT", "id": "burger-classic" }],
        "availability": {
          "status": "ACTIVE",
          "schedules": null,
          "inactive_until": null
        },
        "metadata": {}
      }
    ],
    "modifier_groups": [
      {
        "id": "choose-drink",
        "title": { "en_us": "Choose a drink" },
        "description": null,
        "display_type": "LIST",
        "modifier_ids": ["cola", "soda"],
        "minimum_quantity": 0,
        "maximum_quantity": 1,
        "charge_above_quantity": null,
        "metadata": {}
      }
    ],
    "menus": [
      {
        "id": "lunch-delivery",
        "name": { "en_us": "Lunch delivery menu" },
        "description": { "en_us": "Weekday lunch items for app delivery" },
        "schedules": null,
        "metadata": {},
        "category_ids": ["mains"],
        "status": "ACTIVE"
      }
    ]
  }'

curl --request PUT \
  --url 'https://firespark.cloud/api/integrations/v1/menus?fulfillment_id=delivery&store_id=downtown&channel_id=uber-eats&brand_id=0001' \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -H "x-release-id: 2026-07-03-uber" \
  -d '{
    "style": "UBER_EATS",
        "display_options": {
          "disable_item_instructions": true
        },
        "items": [
          {
            "id": "Coffee",
            "title": { "translations": { "en_us": "Coffee" } },
            "description": { "translations": { "en_us": "Deliciously roasted beans" } },
            "modifier_group_ids": { "ids": ["Add-milk"] },
            "price_info": { "price": 300 },
            "tax_info": { "tax_rate": 8 },
            "quantity_info": {}
          },
          {
            "id": "Milk",
            "title": { "translations": { "en_us": "Milk" } },
            "quantity_info": {
              "overrides": [
                {
                  "context_type": "MODIFIER_GROUP",
                  "context_value": "Add-milk",
                  "quantity": { "max_permitted": 1 }
                }
              ]
            },
            "price_info": {
              "price": 0,
              "overrides": [
                {
                  "context_type": "MODIFIER_GROUP",
                  "context_value": "Add-milk",
                  "price": 0
                }
              ]
            },
            "tax_info": { "tax_rate": 8 }
          }
        ],
        "categories": [
          {
            "id": "Drinks",
            "title": { "translations": { "en_us": "Drinks" } },
            "entities": [{ "type": "ITEM", "id": "Coffee" }]
          }
        ],
        "modifier_groups": [
          {
            "id": "Add-milk",
            "title": { "translations": { "en_us": "Add milk" } },
            "modifier_options": [{ "type": "ITEM", "id": "Milk" }],
            "quantity_info": { "quantity": { "max_permitted": 1 } },
            "display_type": null
          }
        ],
        "menus": [
          {
            "id": "All-day",
            "title": { "translations": { "en_us": "All day" } },
            "category_ids": ["Drinks"],
            "service_availability": [
              {
                "day_of_week": "monday",
                "time_periods": [{ "start_time": "00:00", "end_time": "23:59" }]
              },
              {
                "day_of_week": "tuesday",
                "time_periods": [{ "start_time": "00:00", "end_time": "23:59" }]
              },
              {
                "day_of_week": "wednesday",
                "time_periods": [{ "start_time": "00:00", "end_time": "23:59" }]
              },
              {
                "day_of_week": "thursday",
                "time_periods": [{ "start_time": "00:00", "end_time": "23:59" }]
              },
              {
                "day_of_week": "friday",
                "time_periods": [{ "start_time": "00:00", "end_time": "23:59" }]
              },
              {
                "day_of_week": "saturday",
                "time_periods": [{ "start_time": "00:00", "end_time": "23:59" }]
              },
              {
                "day_of_week": "sunday",
                "time_periods": [{ "start_time": "00:00", "end_time": "23:59" }]
              }
            ]
          }
        ]
      }'

{
  "data": [
    {
      "id": "<string>",
      "name": {
        "en_us": "Example"
      },
      "description": {
        "en_us": "Example"
      },
      "schedules": [
        {}
      ],
      "metadata": {},
      "cms_template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "category_ids": [
        "<string>"
      ]
    }
  ]
}

Creates or updates composed menus for the authenticated merchant. Send catalog entities once at the top level, then reference them from up to 10 menu definitions in the same request. Each menu in menus is matched by id. When no menu exists with that id for the merchant, Fire spark creates it. When one already exists, Fire spark updates the writable fields below. Omitted fields keep their current values on update. Scope the upsert with optional query parameters. Fire spark resolves organization and merchant context from your access token.

Requires an access token with the menus:write scope. See Token to obtain a token.

Menu id values are immutable. You cannot change an existing menu’s id through this endpoint — send the same id you use in your POS or RMS on every sync.

Headers

Header	Required	Description
`x-release-id`	No	Release identifier for this sync. Alphanumeric characters, `_`, and `-` only. 1–64 characters. When omitted, Fire spark generates a value like `v2026-07-10-21h`. Reuse the same value across scopes when rolling out one catalog version to many stores or channels. Each store, channel, and brand scope accepts a given release only once.
`x-force`	No	When `true` or `1`, menu changes in the dashboard and via API will be overwritten; otherwise, existing changes persist.
`x-publish`	No	Defaults to `true`. When `false` or `0`, the sync pauses before publishing so you can review and publish from the dashboard. With `x-force: true`, the pause happens before override pruning as well.

Query parameters

Parameter	Required	Description
`fulfillment_id`	No	External fulfillment identifier. Alphanumeric characters, `_`, and `-` only. 1–64 characters. When omitted, the upsert applies to all fulfillment types. See List fulfillment.
`store_id`	No	External store identifier. Alphanumeric characters, `_`, and `-` only. 1–64 characters. When omitted, the upsert applies to all stores.
`channel_id`	No	External channel identifier. Alphanumeric characters, `_`, and `-` only. 1–64 characters. When omitted, the upsert applies to all channels.
`brand_id`	No	External brand identifier. Alphanumeric characters, `_`, and `-` only. 1–64 characters. Omit or pass `__ANY__` for the merchant-wide default. When set, scopes the upsert to menus for this brand.

Omit scope query parameters for an optional merchant-wide default — useful when store, channel, or fulfillment is not chosen yet. Add fulfillment_id, store_id, channel_id, and/or brand_id to override that default for a specific selling context. Omit a scope parameter or pass __ANY__ to store the wildcard for that dimension. See Menu sync for the recommended baseline-and-override workflow.

Sync styles

The request body is a discriminated union on style. Fire spark validates each variant against a different schema.

Style	When to use
`DEFAULT`	Fire spark native format — owned channels such as app, web, or kiosk.
`UBER_EATS`	Uber Eats Menu API v2 format — push menus to Uber Eats without mapping fields yourself.

Send "style": "DEFAULT" or "style": "UBER_EATS" at the top level. Shared catalog entities and up to 10 menu definitions are sent in the same request for both styles.

Request

Switch between DEFAULT and UBER_EATS in the request examples panel to see both payload shapes. Both calls use PUT with scope query parameters (fulfillment_id, store_id, channel_id, brand_id).

curl --request PUT \
  --url 'https://firespark.cloud/api/integrations/v1/menus?fulfillment_id=delivery&store_id=downtown&channel_id=app&brand_id=0001' \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -H "x-release-id: 2026-07-03-baseline" \
  -d '{
    "style": "DEFAULT",
    "products": [
      {
        "id": "burger-classic",
        "name": { "en_us": "Classic burger" },
        "description": { "en_us": "Angus beef patty with lettuce and tomato." },
        "image_url": "https://cdn.example.com/burger-classic.jpg",
        "bundled_items": [],
        "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": null,
          "out_of_stock_until": null
        },
        "metadata": {}
      },
      {
        "id": "soda",
        "name": { "en_us": "Soda" },
        "description": null,
        "image_url": null,
        "bundled_items": [],
        "pricing": {
          "minimum_quantity": 0,
          "maximum_quantity": 1,
          "is_tax_inclusive": true,
          "tax_rate": 0.15,
          "price": 0,
          "anchor_price": 0,
          "anchor_price_percentage": 0,
          "modifiers": [],
          "modifier_group_ids": []
        },
        "availability": {
          "status": "AVAILABLE",
          "schedules": null,
          "out_of_stock_until": null
        },
        "metadata": {}
      },
      {
        "id": "cola",
        "name": { "en_us": "Cola" },
        "description": null,
        "image_url": null,
        "bundled_items": [],
        "pricing": {
          "minimum_quantity": 0,
          "maximum_quantity": 1,
          "is_tax_inclusive": true,
          "tax_rate": 0.15,
          "price": 0,
          "anchor_price": 0,
          "anchor_price_percentage": 0,
          "modifiers": [],
          "modifier_group_ids": []
        },
        "availability": {
          "status": "AVAILABLE",
          "schedules": null,
          "out_of_stock_until": null
        },
        "metadata": {}
      }
    ],
    "categories": [
      {
        "id": "mains",
        "name": { "en_us": "Mains" },
        "description": { "en_us": "Burgers and sandwiches" },
        "items": [{ "type": "PRODUCT", "id": "burger-classic" }],
        "availability": {
          "status": "ACTIVE",
          "schedules": null,
          "inactive_until": null
        },
        "metadata": {}
      }
    ],
    "modifier_groups": [
      {
        "id": "choose-drink",
        "title": { "en_us": "Choose a drink" },
        "description": null,
        "display_type": "LIST",
        "modifier_ids": ["cola", "soda"],
        "minimum_quantity": 0,
        "maximum_quantity": 1,
        "charge_above_quantity": null,
        "metadata": {}
      }
    ],
    "menus": [
      {
        "id": "lunch-delivery",
        "name": { "en_us": "Lunch delivery menu" },
        "description": { "en_us": "Weekday lunch items for app delivery" },
        "schedules": null,
        "metadata": {},
        "category_ids": ["mains"],
        "status": "ACTIVE"
      }
    ]
  }'

curl --request PUT \
  --url 'https://firespark.cloud/api/integrations/v1/menus?fulfillment_id=delivery&store_id=downtown&channel_id=uber-eats&brand_id=0001' \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -H "x-release-id: 2026-07-03-uber" \
  -d '{
    "style": "UBER_EATS",
        "display_options": {
          "disable_item_instructions": true
        },
        "items": [
          {
            "id": "Coffee",
            "title": { "translations": { "en_us": "Coffee" } },
            "description": { "translations": { "en_us": "Deliciously roasted beans" } },
            "modifier_group_ids": { "ids": ["Add-milk"] },
            "price_info": { "price": 300 },
            "tax_info": { "tax_rate": 8 },
            "quantity_info": {}
          },
          {
            "id": "Milk",
            "title": { "translations": { "en_us": "Milk" } },
            "quantity_info": {
              "overrides": [
                {
                  "context_type": "MODIFIER_GROUP",
                  "context_value": "Add-milk",
                  "quantity": { "max_permitted": 1 }
                }
              ]
            },
            "price_info": {
              "price": 0,
              "overrides": [
                {
                  "context_type": "MODIFIER_GROUP",
                  "context_value": "Add-milk",
                  "price": 0
                }
              ]
            },
            "tax_info": { "tax_rate": 8 }
          }
        ],
        "categories": [
          {
            "id": "Drinks",
            "title": { "translations": { "en_us": "Drinks" } },
            "entities": [{ "type": "ITEM", "id": "Coffee" }]
          }
        ],
        "modifier_groups": [
          {
            "id": "Add-milk",
            "title": { "translations": { "en_us": "Add milk" } },
            "modifier_options": [{ "type": "ITEM", "id": "Milk" }],
            "quantity_info": { "quantity": { "max_permitted": 1 } },
            "display_type": null
          }
        ],
        "menus": [
          {
            "id": "All-day",
            "title": { "translations": { "en_us": "All day" } },
            "category_ids": ["Drinks"],
            "service_availability": [
              {
                "day_of_week": "monday",
                "time_periods": [{ "start_time": "00:00", "end_time": "23:59" }]
              },
              {
                "day_of_week": "tuesday",
                "time_periods": [{ "start_time": "00:00", "end_time": "23:59" }]
              },
              {
                "day_of_week": "wednesday",
                "time_periods": [{ "start_time": "00:00", "end_time": "23:59" }]
              },
              {
                "day_of_week": "thursday",
                "time_periods": [{ "start_time": "00:00", "end_time": "23:59" }]
              },
              {
                "day_of_week": "friday",
                "time_periods": [{ "start_time": "00:00", "end_time": "23:59" }]
              },
              {
                "day_of_week": "saturday",
                "time_periods": [{ "start_time": "00:00", "end_time": "23:59" }]
              },
              {
                "day_of_week": "sunday",
                "time_periods": [{ "start_time": "00:00", "end_time": "23:59" }]
              }
            ]
          }
        ]
      }'

Default
Uber Eats

Fire spark native payload. Products, categories, and modifier groups use Fire spark field names (name, pricing, items, and so on).

Uber Eats Menu API v2 payload. Top-level products become items; localized strings use a translations object. Prices are integer cents in price_info.price.See Uber’s example menu payloads for nested modifiers, bundled items, tax labels, and other advanced fields.

Request body

Default
Uber Eats

Field	Required	Description
`style`	Yes	Must be `"DEFAULT"`.
`products`	Yes	Product definitions shared across menus in this request. At least 1 entry. At most 1000.
`categories`	Yes	Category definitions shared across menus in this request. At least 1 entry. At most 100.
`modifier_groups`	No	Modifier group definitions. Omit or set `null` when unused. At most 1000 when provided.
`recommendations`	No	Recommendation catalog shared across menus in this request. At most 1000 when provided. Defaults to `[]`.
`menus`	Yes	Menu definitions to create or update. At least 1 entry. At most 10.

Each object in menus accepts these writable fields:

Field	Required on create	Description
`id`	Yes	External menu identifier. Upsert key. Immutable after creation.
`name`	Yes	Localized display name keyed by locale (for example `en_us`). Each value is 1–1024 characters.
`description`	No	Localized description keyed by locale. `null` when omitted. Each value is 1–1024 characters.
`schedules`	No	Weekly schedule entries. `null` or omitted for 24/7. When set, must include all 7 weekdays with non-overlapping periods. See Validation rules.
`metadata`	No	Partner-specific metadata. Defaults to `{}`.
`category_ids`	Yes	Category ids to include in this menu. At least 1 entry. At most 100.
`status`	Yes	`ACTIVE` or `INACTIVE`.

products

Each product in the request body:

Field	Required	Type	Description

| id | Yes | string | External product identifier. | | name | Yes | object | Localized display name keyed by locale (for example en_us). | | description | No | object | null | Localized description. null when omitted. | | image_url | No | string | Product image URL. null when omitted. | | bundled_items | No | array | Items included in a bundle or combo. Defaults to []. | | pricing | Yes | object | Price, tax, quantity limits, and modifier configuration. See pricing. | | availability | Yes | object | Product availability. See fields below. | | labels | No | string[] | Short labels for Dashboard filters and quick selection. At most 64 strings (1–128 characters each). Defaults to []. | | tags | No | object | Key/value tags for advanced custom rules. Values may be boolean, string, or number. Defaults to {}. See Custom rules. | | metadata | No | object | Partner-specific metadata. Defaults to {}. |Each availability object:

Field	Required	Type	Description
`status`	Yes	string	`AVAILABLE`, `UNAVAILABLE`, or `OUT_OF_STOCK`.
`schedules`	No	array \| null	Weekly schedule entries. `null` or omitted for no restriction. When set, must include all 7 weekdays. See Validation rules.
`out_of_stock_until`	No	string	Optional ISO 8601 datetime when the product returns to stock.

Each bundled_items entry:

Field	Required	Type	Description

Example product

{
  "id": "burger-classic",
  "name": { "en_us": "Classic burger" },
  "description": { "en_us": "Angus beef patty with lettuce and tomato." },
  "image_url": "https://cdn.example.com/burger-classic.jpg",
  "bundled_items": [],
  "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": null,
    "out_of_stock_until": null
  },
  "metadata": {}
}

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

Field	Required	Type	Description
`status`	Yes	string	`ACTIVE`, `INACTIVE`, or `HIDDEN`.
`schedules`	No	array \| null	Weekly schedule entries. `null` or omitted for no restriction. When set, must include all 7 weekdays. See Validation rules.
`inactive_until`	No	string	Optional ISO 8601 datetime when the category becomes active again.

Field	Required	Type	Description
`id`	Yes	string	External recommendation identifier. Must be unique in the request.
`title`	Yes	object	Localized display name keyed by locale.
`description`	No	object \| null	Localized description. `null` when omitted.
`type`	Yes	string	`UPSELL`, `CROSS_SELL`, or `DOWNSELL`.
`target_product_id`	Yes	string	Product `id` to recommend. Must exist in `products`.
`metadata`	No	object	Partner-specific metadata. Defaults to `{}`.

Field	Required	Type	Description
`recommendation_id`	Yes	string	Must match an `id` from top-level `recommendations`.
`default_quantity`	No	number	Pre-selected quantity for the recommended product on this parent line. Defaults to `0`. Independent from `default_quantity` on `pricing.modifiers`.

Field	Required	Description
`style`	Yes	Must be `"UBER_EATS"`.
`items`	Yes	Items and modifier options. Products and modifiers share this array. At least 1 entry. At most 1000.
`categories`	Yes	Category definitions with `entities` referencing item IDs. At least 1 entry. At most 100.
`modifier_groups`	No	Modifier group definitions. Omit or set `null` when no groups are used. At most 1000 when provided.
`recommendations`	No	Recommendation catalog. Same shape as `DEFAULT` after mapping. At most 1000 when provided. Defaults to `[]`.
`menus`	Yes	Menu definitions to create or update. At least 1 entry. At most 10.
`menu_type`	No	`MENU_TYPE_FULFILLMENT_DELIVERY`, `MENU_TYPE_FULFILLMENT_PICK_UP`, or `MENU_TYPE_FULFILLMENT_DINE_IN`. Defaults to delivery.
`display_options`	No	Store-level display settings such as `disable_item_instructions`.

MultiLanguageText

Localized strings wrap values in translations:

{
  "translations": {
    "en_us": "Coffee"
  }
}

items

Each item in the request body. Top-level products and modifier options are both items.

Field	Required	Type	Description

| id | Yes | string | Unique item identifier from your POS or RMS. | | title | Yes | object | Required MultiLanguageText. | | description | No | object | Optional MultiLanguageText. | | image_url | No | string | Public image URL. Optional. | | external_data | No | string | Partner metadata (max 1024 characters). Optional. | | price_info | No | object | Price in cents plus optional context overrides. See price_info. | | quantity_info | No | object | Quantity constraints and modifier-context overrides. Optional. | | modifier_group_ids | No | object | { "ids": [...] } with optional context overrides. Optional. | | tax_info | No | object | tax_rate, vat_rate_percentage, or mx_ieps_rate. Optional. | | suspension_info | No | object | Out-of-stock suspension rules. Optional. | | bundled_items | No | array | Items always included in a combo. Optional. | | dish_info | No | object | Dietary labels and classifications. Optional. | | visibility_info | No | object | Time windows when the item is visible. Optional. | | tax_label_info | No | object | Tax classification labels. Optional. | | product_info | No | object | GTIN, PLU, or merchant product identifiers. Optional. | | selling_info | No | object | Sold-by-weight or sold-by-unit configuration. Optional. |

Example item

{
  "id": "Coffee",
  "title": { "translations": { "en_us": "Coffee" } },
  "description": { "translations": { "en_us": "Deliciously roasted beans" } },
  "modifier_group_ids": { "ids": ["Add-milk"] },
  "price_info": { "price": 300 },
  "tax_info": { "tax_rate": 8 },
  "quantity_info": {}
}

Response

The endpoint returns asynchronously. Fire spark starts a background menu sync and responds immediately.

Status	When	Body
`201`	Sync accepted and queued	`{ "message": "Sync accepted: …" }` — counts of products, menus, categories, and modifier groups received
`202`	A sync is already running for the same store, channel, and brand	`{ "message": "Sync already in progress for this store/channel.", "runId": "…" }` — `runId` identifies the active workflow run
`409`	A sync is already in progress or completed for the same release and scope	`{ "message": "Sync already exists for this release and scope.", "menuSyncId": "…" }` — retry with the same `x-release-id` only if the prior sync `FAILED` or was `CANCELLED`

Treat 202 as success: the catalog is already being processed. Retry only after the current sync finishes or fails. Treat 409 as success when replaying a release that already completed successfully. If the prior sync for that release and scope FAILED or was CANCELLED, send the same x-release-id again.

Rate limits

GET and PUT /api/integrations/v1/menus share a limit of 10 requests per 10 seconds per merchant. The limit key is the merchant_id from your access token. Send one request at a time per merchant — wait for each response before starting the next. Do not parallelize menu upserts or reads for the same merchant. Every response includes rate limit headers so you know when you can send the next request:

Header	Description
`X-RateLimit-Limit`	Maximum requests allowed per window (`10`)
`X-RateLimit-Reset`	Seconds until the current window resets (`10`)
`X-RateLimit-Remaining`	Requests remaining in the current window — present on `429` (`0`)
`Retry-After`	Seconds to wait before retrying — present only on `429` responses

When you exceed the limit, the API returns 429 Too Many Requests. Wait Retry-After seconds (or X-RateLimit-Reset) before sending another request for that merchant.

Error responses

| Status | Description | | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | | 400 | Validation error — invalid field values, missing required fields, or invalid weekly schedule shape. See Validation rules. | | 401 | Missing or invalid access token. | | 403 | Token does not include the menus:write scope. | | 409 | Referenced store, channel, or fulfillment does not exist for this merchant, or a sync already exists for this release and scope. | | 429 | Rate limit exceeded — wait for Retry-After / X-RateLimit-Reset before retrying. See Rate limits. | |

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-release-id

string

Optional release identifier for this sync. Alphanumeric characters, _, and - only. 1–64 characters. When omitted, Fire spark generates a value like v2026-07-10-21h. Reuse the same value across scopes in a multi-scope rollout. Each scope accepts a given release only once while a sync is processing or after it succeeds; failed or cancelled syncs do not block retries.

Required string length: 1 - 64

Pattern: ^[a-zA-Z0-9_-]+$

x-force

enum<string>

When true or 1, menu changes in the dashboard and via API will be overwritten; otherwise, existing changes persist.

Available options:

true,

false,

1,

0

x-publish

enum<string>

default:true

Defaults to true. When false or 0, the sync pauses before publishing so you can review and publish from the dashboard. With x-force true, the pause happens before override pruning as well.

Available options:

true,

false,

1,

0

Query Parameters

fulfillment_id

string

External fulfillment identifier used to scope the upsert. Omit or pass ANY for all fulfillment types.

Required string length: 1 - 64

Pattern: ^[a-zA-Z0-9_-]+$

store_id

string

External store identifier used to scope the upsert.

Required string length: 1 - 64

Pattern: ^[a-zA-Z0-9_-]+$

channel_id

string

External channel identifier used to scope the upsert.

Required string length: 1 - 64

Pattern: ^[a-zA-Z0-9_-]+$

brand_id

string

Scope the upsert to menus for this brand. Omit or pass ANY for the merchant-wide default.

Required string length: 1 - 64

Pattern: ^[a-zA-Z0-9_-]+$

Body

application/json

Composed menu payload. Use style DEFAULT or UBER_EATS.

Option 1
Option 2

style

enum<string>

required

Available options:

DEFAULT

products

object[]

required

Required array length: 1 - 1000 elements

Show child attributes

Response

200 - application/json

data

object[]

Show child attributes

List menus Update product

API Documentation

Endpoints

Guides

Resources

Headers

Query parameters

Sync styles

Request

Request body

Menu fields

Menu fields

MultiLanguageText

Response

Rate limits

Error responses

Authorizations

Headers

Query Parameters

Body

Response

​Headers

​Query parameters

​Sync styles

​Request

​Request body

​Menu fields

​Menu fields

​MultiLanguageText

​Response

​Rate limits

​Error responses

Authorizations

Headers

Query Parameters

Body

Response

Headers

Query parameters

Sync styles

Request

Request body

Menu fields

Menu fields

MultiLanguageText

Response

Rate limits

Error responses