> For the complete documentation index, see [llms.txt](https://docs.stoqapp.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stoqapp.com/back-in-stock-api.md).

# 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.<br>

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.
   * Intent is unique to a customer, product variant & market.
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. **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
4. **Compliance & Privacy**:
   * Includes GDPR opt-in confirmation tracking
   * Tracks marketing preferences
   * Maintains unsubscribe status


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.stoqapp.com/back-in-stock-api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.