Item Sold Out Events API

The Item Sold Out Events API tracks instances where items are marked as sold out at specific locations. It provides detailed information about the reasons for sold-out events, timestamps, and the actions taken to resolve them. This API is particularly valuable for inventory management and operational analysis.

Example Response

After a successful call, the API will return a response similar to the below structure.

[
    {
        "reason": "Bulk update request",
        "item_id": "MenuItem:Hot_Sauce",
        "log_push_event_id": null,
        "created_at": "2024-02-17T11:23:39.865Z",
        "item_name": "Hot Sauce",
        "location_id": 240841,
        "updated_at": "2024-02-17T11:23:39.865Z",
        "user_id": 13266,
        "offline_hours": null,
        "suspended_until": null,
        "id": 365928997,
        "superseded": true,
        "next_pushed_event_id": null,
        "status": "online",
        "external_store_id": "13226"
    }
  ]

Field Descriptions

Field Name	Description
`reason`	Reason for the item being marked as sold out (e.g., bulk update request).
`item_id`	Unique identifier for the item.
`log_push_event_id`	Identifier for the related log push event.
`created_at`	Timestamp when the item was marked as sold out.
`item_name`	Name of the sold-out item.
`location_id`	Identifier for the location where the item was marked sold out.
`updated_at`	Timestamp when the record was last updated.
`user_id`	Identifier of the user who updated the record.
`offline_hours`	Number of hours the item was offline.
`suspended_until`	Timestamp indicating when the item is expected to be restocked (if applicable).
`id`	Unique identifier for the sold-out event record.
`superseded`	Indicates whether the record has been superseded (true or false).
`next_pushed_event_id`	Identifier for the next pushed event in the log (if any).
`status`	Current status of the item (e.g., online, offline).
`external_store_id`	Identifier for the external store associated with the item.

This API aids in comprehensive tracking of item availability and is crucial for ensuring effective stock management and minimizing operational disruptions.