Skip to main content

Sales — Events

Subscribe to sales events in your module's subscribers/ directory:

// src/modules/<your_module>/subscribers/order-created.ts
export const metadata = {
event: 'sales.order.created',
persistent: true,
id: 'your-module-order-created',
}

export default async function handler(payload, ctx) {
// React to new orders
}

CRUD events

EventDescription
sales.order.createdA new order was created
sales.order.updatedAn order was updated
sales.order.deletedAn order was deleted
sales.quote.createdA new quote was created
sales.quote.updatedA quote was updated
sales.quote.deletedA quote was deleted
sales.invoice.createdAn invoice was created
sales.invoice.updatedAn invoice was updated
sales.invoice.deletedAn invoice was deleted
sales.credit_memo.createdA credit memo was created
sales.credit_memo.updatedA credit memo was updated
sales.credit_memo.deletedA credit memo was deleted
sales.line.createdAn order line was created
sales.line.updatedAn order line was updated
sales.line.deletedAn order line was deleted
sales.payment.createdA payment was recorded
sales.payment.updatedA payment was updated
sales.payment.deletedA payment was deleted
sales.shipment.createdA shipment was created
sales.shipment.updatedA shipment was updated
sales.shipment.deletedA shipment was deleted
sales.return.createdA return was created
sales.return.updatedA return was updated
sales.return.deletedA return was deleted
sales.note.createdA note was created
sales.note.updatedA note was updated
sales.note.deletedA note was deleted
sales.channel.createdA sales channel was created
sales.channel.updatedA sales channel was updated
sales.channel.deletedA sales channel was deleted

Lifecycle events

These events fire during internal calculation pipelines. They are excluded from business rule triggers but can be subscribed to for custom pricing or tax logic.

EventDescription
sales.document.totals.calculatedDocument totals were recalculated
sales.document.calculate.beforeBefore document calculation pipeline
sales.document.calculate.afterAfter document calculation pipeline
sales.line.calculate.beforeBefore line calculation
sales.line.calculate.afterAfter line calculation
sales.tax.calculate.beforeBefore tax calculation
sales.tax.calculate.afterAfter tax calculation
sales.shipping.adjustments.apply.beforeBefore shipping adjustments are applied
sales.shipping.adjustments.apply.afterAfter shipping adjustments are applied
sales.payment.adjustments.apply.beforeBefore payment adjustments are applied
sales.payment.adjustments.apply.afterAfter payment adjustments are applied

See also