Getting Started
Event Reference
All available domain events with descriptions
Event Reference
This page lists every event type you can subscribe to via the Events API.
Orders
| Event | Description |
|---|---|
orderCreated | A new order has been created. Includes the full order document with line items, customer, totals, and payment info. |
orderUpdated | An order has been modified — status change, line item update, shipping info added, etc. |
orderDeleted | An order has been deleted. The payload includes the order ID and basic metadata. |
orderReadyForPickup | An order has been marked as ready for customer pickup at a physical location. |
Cart
| Event | Description |
|---|---|
cartCreated | A new shopping cart has been created. |
cartUpdated | A cart has been modified — items added/removed, customer set, shipping method changed, discount applied, etc. |
cartDeleted | A cart has been deleted (expired or manually removed). |
cartFullyPaid | A cart has been fully paid and is ready for order completion. |
cart.shared | A POS cart has been shared to a customer's device. The cart status becomes "shared" and is released from the POS register. See Cart Sharing Guide. |
cart.abandoned | A storefront cart has been inactive past the configured threshold (e.g. 1 hour). Triggers recovery email or SMS delivery via the configured integration worker. |
cart.shared payload
{
"cartId": "682a1f3c9b4e2d001a8c7f12",
"marketId": "se",
"recipient": {
"email": "anna@example.com",
"phone": null,
"name": "Anna Andersson"
},
"deliveryMethod": "email",
"cart": {
"totalAmountIncVat": 1299.00,
"currencyCode": "SEK",
"lineItemCount": 3,
"status": "shared"
},
"metadata": {
"source": "pos",
"sharedAt": "2025-01-15T10:34:22.000Z"
}
}
cart.abandoned payload
{
"cartId": "682a1f3c9b4e2d001a8c7f14",
"marketId": "se",
"tenantId": "tenant_abc123",
"customer": {
"email": "erik@example.com",
"name": "Erik Svensson"
},
"cart": {
"totalAmountIncVat": 549.00,
"currencyCode": "SEK",
"lineItemCount": 2,
"abandonedAt": "2025-01-15T09:00:00.000Z"
},
"recoveryUrl": "https://www.yourdomain.com/cart/682a1f3c9b4e2d001a8c7f14/recover?t=abc123hmac"
}
The
recoveryUrl in cart.abandoned contains an HMAC-signed token (?t=) that validates the recovery request server-side. The token is tied to the cart ID and your avvyrCartRecoverySecret environment variable.Products
| Event | Description |
|---|---|
productCreated | A new product has been created. Includes the full product document with variants, pricing, and attributes. |
productUpdated | A product has been modified — name, description, price, images, attributes, stock, etc. |
productDeleted | A product has been deleted. |
Transfers
| Event | Description |
|---|---|
transferCreated | A stock transfer between warehouses/locations has been created. |
transferUpdated | A stock transfer has been modified (quantity adjusted, status changed). |
transferDeleted | A stock transfer has been deleted. |
Purchases
| Event | Description |
|---|---|
purchaseCreated | A purchase order (buying from supplier) has been created. |
purchaseUpdated | A purchase order has been modified. |
purchaseDeleted | A purchase order has been deleted. |
Fulfillment
| Event | Description |
|---|---|
fulfillmentCreated | A fulfillment (packing/shipping job) has been created for an order. |
fulfillmentUpdated | A fulfillment has been modified (tracking number added, status changed). |
fulfillmentDeleted | A fulfillment has been deleted. |
Payload structure
Every event payload follows the same structure:
{
"_meta": {
"eventType": "orderCreated",
"entityType": "order",
"tenantId": "676140c4...",
"messageId": "unique-message-id",
"timestamp": "2025-06-15T14:30:00.000Z"
},
"data": {
// The full entity document at the time the event was fired
}
}
| Field | Description |
|---|---|
_meta.eventType | The event type (matches your subscription's eventType) |
_meta.entityType | The entity category (e.g. order, product, cart) |
_meta.tenantId | Your tenant ID |
_meta.messageId | Unique ID for this event — useful for deduplication |
_meta.timestamp | ISO 8601 timestamp of when the event was published |
data | The full entity document. Structure varies by entity type. |
Use the Management API Reference to explore the full schema for each entity type (orders, products, carts, etc.). The
data payload matches the document structure returned by the corresponding GET endpoint.