Skip to main content

Sales — Commands

The sales module registers the following commands on the command bus. You can intercept them via command interceptors or dispatch them from your own module.

Channels

Command IDDescription
sales.channels.createCreate a sales channel
sales.channels.updateUpdate a sales channel
sales.channels.deleteDelete a sales channel

Documents

Command IDDescription
sales.document-addresses.createAdd an address to a sales document
sales.document-addresses.updateUpdate an address on a sales document
sales.document-addresses.deleteRemove an address from a sales document

Notes

Command IDDescription
sales.notes.createCreate a note on a sales document
sales.notes.updateUpdate a note
sales.notes.deleteDelete a note

Payments

Command IDDescription
sales.payments.createRecord a payment
sales.payments.updateUpdate a payment
sales.payments.deleteDelete a payment
sales.payment-methods.createCreate a payment method
sales.payment-methods.updateUpdate a payment method
sales.payment-methods.deleteDelete a payment method

Shipments

Command IDDescription
sales.shipments.createCreate a shipment
sales.shipments.updateUpdate a shipment
sales.shipments.deleteDelete a shipment
sales.shipping-methods.createCreate a shipping method
sales.shipping-methods.updateUpdate a shipping method
sales.shipping-methods.deleteDelete a shipping method
sales.delivery-windows.createCreate a delivery window
sales.delivery-windows.updateUpdate a delivery window
sales.delivery-windows.deleteDelete a delivery window

Returns

Command IDDescription
sales.returns.createCreate a return for an order

Configuration

Command IDDescription
sales.settings.saveSave sales module settings
sales.tax-rates.createCreate a tax rate
sales.tax-rates.updateUpdate a tax rate
sales.tax-rates.deleteDelete a tax rate
sales.tags.createCreate a document tag
sales.tags.updateUpdate a document tag
sales.tags.deleteDelete a document tag

See also