Back in Stock API
Before diving into the API reference, it's important to understand the key term we use - Intent
Intents are essentially "waitlist requests" or "subscriptions" that customers create when they want to be notified with a back in stock alert.
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.
Intent is unique to a customer, product variant & market.
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
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
Compliance & Privacy:
Includes GDPR opt-in confirmation tracking
Tracks marketing preferences
Maintains unsubscribe status
Last updated