[GET] List subscribed products
* Authentication
Required Authorization: Bearer ••••••••••••••••••••••••••••••••••••
Limit throttle:60,1
Request
Retrieve the variants customers have signed up for, one row per variant, with how many customers are waiting, have been sent the restock email, failed, or unsubscribed. Supports pagination, search, filters and sorting.
Endpoint GET - /shop-api/back-in-stock/products?page=1&per_page=10
| Params | Type | Required |
|---|---|---|
| page | number | no |
| per_page | number | no |
| query | string | no |
| state | string | no |
| stock | string | no |
| sort | string | no |
page— page number, from1. Default1.per_page— variants per page,1to100. Default10.query— search by product title, variant title or SKU.state— one of:all(default)ready— has customers waiting and the variant is back in stockwaiting— has customers waiting and the variant is still out of stocknotified— no customer is waiting any moreproblem— at least one restock email failed to send
stock—all(default),in_stock,out_of_stock.sort— up to 3 keys separated by commas, each written askey:ascorkey:desc. Keys:product,waiting,notified,subscribers,last_added. Default: most subscribers first. Example:waiting:desc,last_added:desc.
Only sign-ups with an email address are counted.
GET /shop-api/back-in-stock/products?page=1&per_page=10&state=waiting&sort=waiting:desc HTTP/1.1Host: preorder.globo.ioAuthorization: ************const myHeaders = new Headers();myHeaders.append("Authorization", "************");const requestOptions = { method: "GET", headers: myHeaders, redirect: "follow"};fetch("https://preorder.globo.io/shop-api/back-in-stock/products?page=1&per_page=10&state=waiting&sort=waiting:desc", requestOptions) .then((response) => response.text()) .then((result) => console.log(result)) .catch((error) => console.error(error));$curl = curl_init();curl_setopt_array($curl, array( CURLOPT_URL => 'https://preorder.globo.io/shop-api/back-in-stock/products?page=1&per_page=10&state=waiting&sort=waiting:desc', CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => '', CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => 'GET', CURLOPT_HTTPHEADER => array( 'Authorization: ************' ),));$response = curl_exec($curl);curl_close($curl);echo $response;Success response 200
waiting, sent, failed and unsubscribed never overlap and always add up to subscribers.
{ "success": true, "data": [ { "product_id": 1234567890, // Shopify product ID without gid://shopify/Product/ "variant_id": 9876543210, // Shopify variant ID without gid://shopify/ProductVariant/ "product_title": "Product Name", "variant_title": "Size M / Blue", // "Default Title" if the product has no variants "sku": "SKU-001", // nullable "inventory_available": 0, // Latest available quantity recorded for the variant, null if not recorded yet "state": "waiting", // ready => waiting customers + in stock, waiting => waiting customers + out of stock, notified => nobody waiting "subscribers": 41, // Total sign-ups for this variant "waiting": 39, // Not sent the restock email yet "sent": 1, // Restock email sent "failed": 1, // Restock email failed to send "unsubscribed": 0, // Unsubscribed before the restock email was sent "opened": 0, // Customers who opened the restock email "clicked": 0, // Customers who clicked the restock email "last_subscribed_at": "2026-07-03 10:00:00", // Latest sign-up "last_sent_at": "2026-07-05 08:30:00" // Latest restock email, null if none sent } ], "pagination": { "total": 25, // Total variants "per_page": 10, "current_page": 1, "last_page": 3, "from": 1, // null if the page is empty "to": 10 // null if the page is empty }}Failed
{ "success" => false, "message" => "The selected state is invalid."}| Message | When |
|---|---|
The page must be at least 1. |
page is lower than 1 |
The per page may not be greater than 100. |
per_page is out of range |
The selected state is invalid. |
state is not one of the values above |
The selected stock is invalid. |
stock is not one of the values above |
Something went wrong |
Unexpected error |
Was this helpful?
Thanks for your feedback! Tell us what was missing
Report an issue