API referenceStorefront growth
Back-in-stock requests from buyers
AuthorizationBearer <token>
API key from Settings → API keys
In: header
Path Parameters
storeId*string
Query Parameters
page?integer
Range
1 <= value <= 9007199254740991Default
1perPage?integer
Range
1 <= value <= 200Default
25state?string
Value in
- "waiting"
- "notified"
- "unsubscribed"
productId?string
Match
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Format
uuidq?string
Length
length <= 200Response Body
application/json
application/json
curl -X GET "https://example.com/v1/stores/string/stock-alerts"{ "data": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "email": "string", "state": "waiting", "productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113", "productName": "string", "variantId": "d53feca7-c65b-4741-aca7-827a42d686bf", "variantName": "string", "createdAt": "string", "notifiedAt": "string" } ], "pagination": { "page": -9007199254740991, "perPage": -9007199254740991, "total": -9007199254740991 }}