List an order's notifications
API v2 is in public beta: endpoints and fields can change before general availability. See the changelog
/preorders/orders/{id}/notificationsCosts 1 rate-limit point · Rate limits
Read which customer messages were sent for an order: confirmation email and SMS, shipping update email, with counts and when each was last sent.
Counts include the automatic send when the order comes in and every resend from the dashboard or the API, single or bulk; last_triggered_by is automatic or manual. An email counts once it is queued for sending, so a count does not prove delivery. An SMS counts only when the SMS provider accepted it. Check sent_count before POST /preorders/orders/:id/send_confirmation or .../send_sms_confirmation to avoid a duplicate. GET /preorders/orders/:id/timeline lists each send with its recipient.
Also searched asorder notificationswas the confirmation sentdid the customer get an emailwas the sms sent
Path parameters
idstringRequiredThe order, by STOQ's order ID or the Shopify order ID.
Returns
confirmation_emailobjectThe preorder confirmation email.
Show 3 child attributesHide child attributes
sent_countintegerHow many times it was sent for this order.
last_sent_atstringWhen it was last sent (ISO 8601), or null when it never was.
last_triggered_bystringWhat sent it last, such as automatic or manual. Null when it was never sent.
confirmation_smsobjectThe preorder confirmation SMS.
Show 3 child attributesHide child attributes
sent_countintegerHow many times it was sent for this order.
last_sent_atnullWhen it was last sent (ISO 8601), or null when it never was.
last_triggered_bynullWhat sent it last, such as automatic or manual. Null when it was never sent.
shipping_update_emailobjectThe shipping update email.
Show 3 child attributesHide child attributes
sent_countintegerHow many times it was sent for this order.
last_sent_atnullWhen it was last sent (ISO 8601), or null when it never was.
last_triggered_bynullWhat sent it last, such as automatic or manual. Null when it was never sent.
Errors
not_foundThe path is valid but nothing with that id exists in this store.
validation_failedThe request failed validation.
Any request can also fail with auth_invalid (401) or rate_limited (429).
Every error has the same shape: see Errors and the list of error codes.
curl "https://app.stoqapp.com/api/v2/external/preorders/orders/5f0c8a3e-6b2d-4f1a-9c7e-2d8b1a4e6f30/notifications" \
-H "X-Auth-Token: $STOQ_API_KEY"const res = await fetch("https://app.stoqapp.com/api/v2/external/preorders/orders/5f0c8a3e-6b2d-4f1a-9c7e-2d8b1a4e6f30/notifications", {
headers: {
"X-Auth-Token": process.env.STOQ_API_KEY,
},
});
const data = await res.json();import os
import requests
res = requests.get(
"https://app.stoqapp.com/api/v2/external/preorders/orders/5f0c8a3e-6b2d-4f1a-9c7e-2d8b1a4e6f30/notifications",
headers={"X-Auth-Token": os.environ["STOQ_API_KEY"]},
)
data = res.json()require "net/http"
require "json"
uri = URI("https://app.stoqapp.com/api/v2/external/preorders/orders/5f0c8a3e-6b2d-4f1a-9c7e-2d8b1a4e6f30/notifications")
req = Net::HTTP::Get.new(uri, "X-Auth-Token" => ENV["STOQ_API_KEY"])
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body){
"confirmation_email": {
"sent_count": 1,
"last_sent_at": "2026-01-15T09:30:00Z",
"last_triggered_by": "string"
},
"confirmation_sms": {
"sent_count": 1,
"last_sent_at": null,
"last_triggered_by": null
},
"shipping_update_email": {
"sent_count": 1,
"last_sent_at": null,
"last_triggered_by": null
}
}{
"errors": [
"Invalid API key"
],
"code": "auth_invalid",
"details": [
{
"code": "auth_invalid",
"message": "Invalid API key",
"path": null,
"value": null,
"expected": null
}
]
}{
"errors": [
"Offer not found"
],
"code": "not_found",
"details": [
{
"code": "not_found",
"message": "Offer not found",
"path": null,
"value": null,
"expected": null
}
]
}{
"errors": [
"name is required"
],
"code": "validation_failed",
"details": [
{
"code": "validation_failed",
"message": "name is required",
"path": null,
"value": null,
"expected": null
}
]
}{
"errors": [
"Rate limit exceeded"
],
"code": "rate_limited",
"details": [
{
"code": "rate_limited",
"message": "Rate limit exceeded",
"path": null,
"value": null,
"expected": null
}
]
}