Item category events
Tango provides webhook events so your system can react automatically when the availability status of your catalog items change. The following event is supported under the ITEM category:
ItemAvaliability event
Item availability is a valuable resource, as it determines the availability of catalog items as they fluctuate. Subscribing to the ItemAvailability event type ensures you receive timely notifications when an item becomes unavailable or deprecated. Additionally, this event notification informs you when the item is available for purchase again. Using this webhook event, you can achieve a dynamic and customer-centric catalog system benefiting you and your customers as well as other advantages:
- Enhanced Customer Experience: Customers see a catalog that accurately reflects the availability of products in real-time, reducing frustration caused by out-of-stock items.
- Optimized Transactions: Acme can optimize its experience by only displaying items that are ready for redemption, potentially increasing conversion rates.
- Reduced Manual Effort: Manual catalog management is minimized since ItemAvailability status is automatically updated based on webhook notifications.
- Catalog Management: Acme gains better control over its catalog as items are added or removed as they become available or unavailable.
How to subscribe
To receive ItemAvailability events, create a webhook subscription. Once subscribed, your webhook endpoint will receive notifications any time an item’s availability changes:
POST {URI}/webhooks
eventTypes = ItemAvailability
categories= ITEMUse Case: Dynamic catalog
Acme, a wellness incentive company, aims to optimize its incentive reward catalog by displaying items only when they are available for redemption. Acme uses ItemAvailability webhook to keep its reward catalog up to date. By subscribing to real-time item availability events, Acme ensures that only currently available items are shown to users. This dynamic catalog approach improves user experience, reduces errors during redemption, and minimizes manual catalog maintenance.
To achieve dynamic catalog management, Acme follows the steps below:
- Imports Catalog Items via
GET {URI}/catalogs - Creates a Webhook Listener for their system to accept incoming
ItemAvailabilitynotifications. - Subscribes to the Webhook using
POST {URI}/webhookswith eventTypeItemAvailability. - Updates the Catalog: If an item is AVAILABLE, show the item in the catalog. If the item is UNAVAILABLE
,DEGRADED, orDEPRECATED, hide or display as "out of stock".
Statuses for ItemAvailability
The following statuses are returned in eventData.status when the ItemAvailability event is triggered:
| Status | Description |
|---|---|
| AVAILABLE | This item is available for ordering. |
| DEGRADED | This item is currently experiencing higher-than-usual errors. We are working to restore this item for you. We will have an update shortly. |
| UNAVAILABLE | This item is currently unavailable. We are working to restore this item for you. We will have an update shortly. |
| DEPRECATED | This item is permanently unavailable. |
Examples
Here is a response payload example of ItemAvailabilityevent:
Here is a response payload of itemAvailability:
{
"eventId": "2e3b91ba-4d6a-43b5-8e77-3b31e3f938b3",
"revision": 4,
"category": "ITEM",
"eventType": "ItemAvailability",
"eventOccurredAt": "2024-06-17T17:10:00.759273600Z",
"eventData": {
"utid": "U275066",
"status": "UNAVAILABLE"
}
}Updated 6 days ago
