Menu Object Updates

Stream-integrated DSPs have the option to support object-level updates. Normally, when an item is indicated out of stock by a merchant, we will push an entirely new menu payload with the updated state. This can be costly for large menus and can lead to unnecessary processing on the DSP side.

Our update webhook will send object stock updates for items, variations, and modifiers via the New Webhook Event webhook.

In the below payload example, an item is being set to out of stock (is_active: false), while a modifier is being set back in stock (is_active: true).

{
  "location_id": "example_location",
  "type": "location.update",
  "object_updates": {
    "items": [
      {
        "stream_id": "family1",
        "is_active": false
      }
    ],
    "variations": [],
    "modifiers": [
      {
        "stream_id": "modifier1",
        "is_active": true
      }
    ]
  }
}

NOTE: There is no menu specified within the payload. All matching objects should be updated across all menus for the location.

NOTE: In some instances, such as when an object goes back into stock, the stream_id of the object we send may not exist within any of your menus. In this case, your API should respond with a 404 error code, and we will fallback to a normal menu publish.