Back in Stock API

Intents are essentially "waitlist requests" or "back-in-stock notifications" that customers create when they want to be notified about product availability.

1. Core Purpose:

   • When a product is out of stock, customers can sign up to be notified when it becomes available again

   • Each intent represents a single customer's request to be notified about a specific product variant

2. What data is present in an Intent?

   • Customer Information: Each intent contains customer details like email, phone, and name

   • Product Information: Shopify product and product variant IDs

   • Notification Preference: Specifies how the customer wants to be notified (email or SMS)

   • Quantity: How many units the customer is interested in when the product is back in stock

3. Types of Intents:

   • restock: For products that are currently out of stock

   • wishlist_reminder: For products that customers have saved for later

4. Lifecycle of an Intent:

   • Created when a customer signs up for notifications

   • Can be notified when the product becomes available

   • Can be blocked from sending notifications

   • Can be unsubscribed by the customer

   • Tracks notification history and opt-in status

5. Compliance & Privacy:

   • Includes GDPR opt-in confirmation tracking

   • Tracks marketing preferences

   • Maintains unsubscribe status