Item category events
The following webhook event is supported under Item category:
Item avaliability
Tango supports item availability 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. To learn more, check out our use case below.
Use 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. To achieve this dynamic catalog management, Acme utilizes the Tango ItemAvailability
webhook. The steps Acme follows are:
# | Steps | Description |
---|---|---|
1 | Import catalog Items | Acme imports catalog items into its system, including the utid and other relevant product details, using the GET {URI}/catalogs API endpoint. All items are initially marked as AVAILABLE. |
2 | Set up a webhook Event Listener | Acme sets up a webhook event listener to receive notifications whenever the ItemAvailability event occurs. |
3 | Integrate availability logic into the catalog | Acme integrates the availability logic into its catalog management system, ensuring that it can dynamically process the event notification status change. |
4 | Subscribe to the ItemAvailability Webhook | Acme subscribes to the Tango ItemAvailability webhook using the POST {URI}/webhooks . |
5 | Process the event (Event Handling) | Acme system processes the event when Acme receives an ItemAvailability webhook notification. |
6 | Update its dynamic catalog | Acme dynamically updates its online catalog based on the webhook notifications it receives. If an item is marked as AVAILABLE in the webhook event, it is displayed in the catalog. If it becomes UNAVAILABLE , DEGRADED , or DEPRECATED , the item is removed from the catalog or marked as out of stock depending on Acme’s business rules. |
7 | Display Real-time Catalog | Acme customers always see an up-to-date catalog, showing only those items that are currently available for redemption following this integration. |
Benefits of dynamic catalog
By leveraging Tango ItemAvailability
, you can achieve a dynamic and customer-centric catalog management system that benefits both your customers and business operations. Here are some of the benefits you are getting with ItemAvailability
:
- 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.
When creating a subscription for item availability, use POST {URI}/webhooks
and enter the following parameters:
Body Params | Type | Description |
---|---|---|
url | string | Enter the URL of your webhook listener. It must be a valid URL. (Required) |
categories | array of strings | Enter ITEM for categories. (Optional if you're specifying eventTypes.) |
eventTypes | array of strings | Enter ItemAvailability for eventTypes . (Optional if you're specifying categories.) |
List of item availability statuses
You can subscribe to the ItemAvailability
events to be notified when an item's status changes in your catalog. The following statuses are available for item availability and are returned byeventData.status
:
Availability 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. |
The following example is a response payload of ItemAvailability
:
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"
}
}
The following response messages are supported by webhook endpoints in Tango API:
- 200 Successful
- 400 Bad Request
- 401 Unauthorized
- 403 Forbidden
- 409 Conflict, Duplicate Exist
Updated about 12 hours ago