Skip to content

List an order's notifications

API v2 is in public beta: endpoints and fields can change before general availability. See the changelog

GET/preorders/orders/{id}/notifications

Costs 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

  • idstringRequired

    The order, by STOQ's order ID or the Shopify order ID.

Returns

  • confirmation_emailobject

    The preorder confirmation email.

    Show 3 child attributesHide child attributes
    • sent_countinteger

      How many times it was sent for this order.

    • last_sent_atstring

      When it was last sent (ISO 8601), or null when it never was.

    • last_triggered_bystring

      What sent it last, such as automatic or manual. Null when it was never sent.

  • confirmation_smsobject

    The preorder confirmation SMS.

    Show 3 child attributesHide child attributes
    • sent_countinteger

      How many times it was sent for this order.

    • last_sent_atnull

      When it was last sent (ISO 8601), or null when it never was.

    • last_triggered_bynull

      What sent it last, such as automatic or manual. Null when it was never sent.

  • shipping_update_emailobject

    The shipping update email.

    Show 3 child attributesHide child attributes
    • sent_countinteger

      How many times it was sent for this order.

    • last_sent_atnull

      When it was last sent (ISO 8601), or null when it never was.

    • last_triggered_bynull

      What sent it last, such as automatic or manual. Null when it was never sent.

Errors

404
not_found

The path is valid but nothing with that id exists in this store.

422
validation_failed

The 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.

GET/preorders/orders/{id}/notifications
curl "https://app.stoqapp.com/api/v2/external/preorders/orders/5f0c8a3e-6b2d-4f1a-9c7e-2d8b1a4e6f30/notifications" \
  -H "X-Auth-Token: $STOQ_API_KEY"
Response
{
  "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
  }
}