Skip to main content
GET
Confirm your deployment before running this request. This page describes an API contract; a published reference does not establish hosted availability. Check the dated host report and obtain your deployment URL and credentials. Replace the example host if your provisioned service uses a different URL.
Each frame carries a monotonic id. Supports:
  • ?filter=order.* — event type filtering (prefix match with wildcard).
  • Last-Event-ID request header (or ?last_event_id=) — replays buffered events with a greater id from a bounded server-side ring before resuming the live stream. The header takes precedence over the query parameter.
If the requested resume id has already been evicted from the bounded buffer (a gap), a single event: stream_reset frame is emitted before whatever remains is replayed, signaling the client to reconcile state out-of-band.

Query parameters

string
Optional event type filter (e.g. order.*).
integer (int64)
Resume the stream after this event id. Equivalent to the standard SSE Last-Event-ID request header; the header takes precedence when both are supplied. Events with a greater id are replayed from the bounded server-side buffer before the live stream resumes.

Response

Returns text/event-stream — Server-Sent Events stream of commerce events. Each frame carries a monotonic id; clients may resume after a drop via the Last-Event-ID header. On a replay gap a stream_reset frame is emitted first.

Status codes

Using this contract

Read the source OpenAPI document for declared schemas and alternatives. This page also includes documented corrections from the spec overlays. Example IDs and values are illustrative; replace them with records from your workspace.
Last modified on September 21, 2026