Events emitted by the checkout enhancers. Most fire on the SDK's internal event bus; the prospect-cart events fire as DOM CustomEvents on document.
// SDK event bus
window.next.on('order:completed', ({ order }) => {
console.log('Order created', order);
});
// DOM CustomEvents (prospect cart)
document.addEventListener('next:prospect-cart-created', (e) => {
console.log(e.detail.prospectCart);
});
| Event | When |
|---|
checkout:form-initialized | The checkout form finished initializing. Payload: { form } |
checkout:started | Submit handling has begun |
checkout:location-fields-shown | The shipping location block was revealed |
checkout:billing-location-fields-shown | The billing location block was revealed |
checkout:spreedly-ready | Spreedly iframe card fields are ready |
checkout:test-data-filled | Test data was auto-filled (debug mode) |
| Event | When |
|---|
payment:tokenized | The card was tokenized successfully |
payment:error | Payment or tokenization failed. Payload includes a message |
| Event | When |
|---|
order:completed | The order was created. Payload: { order } |
order:redirect-missing | Order created but no redirect URL could be resolved — cart and checkout state are left intact. Payload: { order } |
| Event | When |
|---|
express-checkout:initialized | A wallet button was rendered and wired. Payload: { method, element } |
express-checkout:started | An express payment began |
express-checkout:completed | The express order completed |
express-checkout:failed / express-checkout:error | The express payment failed |
method is one of paypal, apple_pay, google_pay.
| Event | When |
|---|
address:autocomplete-filled | An autocomplete suggestion filled the address fields. Payload: { type: 'shipping' | 'billing', components } |
Dispatched on document; read the payload from event.detail.
| Event | When | detail |
|---|
next:prospect-cart-created | A prospect cart was created | { cart, prospectCart } |
next:prospect-cart-abandoned | The visitor abandoned checkout | { prospectCart } |
next:prospect-cart-converted | The visitor completed the order | { prospectCart } |
