Skip to content
SarvexDocs
Esc
↑↓navigate↵open⌘Jpreview

Order intent from a completed checkout (order already created)

RECEIVEserving.checkout.order_intent
Message
checkout_session_idstringrequired
order_idstringrequired

The order identifier returned by the connector's synchronous CheckoutComplete call — the order already exists at the merchant.

store_order_refstringrequired

The merchant store's own reference for the order (may equal order_id, depending on connector).

order_statusstringrequired

The order status as of creation (connector CheckoutComplete response), e.g. "completed".

line_itemsobject[]required
Show properties
Array of object
skustring
quantityinteger
totalmoneyrequired
Show properties
amount_minorintegerrequired
currencystringrequired
Headers
message_idstringrequired

Unique per message; consumers de-duplicate on this.

ordering_keystringrequired

The store_id. Guarantees per-store ordering; the catalog/serving tenant boundary (a store belongs to one merchant — see architecture §2a).

occurred_atstring<date-time>required
sequenceinteger<int64>

Monotonic per-connector sequence carried from the origin signal (ingest events only).

trace_idstring

Correlates a chain of events from one originating cause.

schema_versionstringrequired
Try it
Server
Payload

Live sending isn't possible for pubsub from a browser tab — copy the sample above and run it against your broker.

Message
{
  "checkout_session_id": "string",
  "order_id": "string",
  "store_order_ref": "string",
  "order_status": "string",
  "line_items": [
    {
      "sku": "string",
      "quantity": 0
    }
  ],
  "total": {
    "amount_minor": 0,
    "currency": "AUD"
  }
}