Webhook Events & Payloads - Spree Commerce documentation

Every webhook delivery sends a JSON envelope with the event metadata and a data object containing the serialized resource:

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "order.placed",
  "created_at": "2025-01-15T10:30:00Z",
  "data": { ... },
  "metadata": {
    "spree_version": "6.0.0"
  }
}

Field	Type	Description
`id`	string	Unique UUID for this event
`name`	string	Event name (e.g., `order.placed`)
`created_at`	string	ISO 8601 timestamp
`data`	object	Serialized resource (see payloads below)
`metadata`	object	Additional context: always the Spree version, plus event-specific keys such as `notify_customer` (fulfillment events — order events carry it in `data`) or `deprecated_alias_of`

Event payloads use the same Store API V3 serializers as the REST API. All id fields use prefixed IDs (e.g., or_m3Rp9wXz, prod_86Rf07xd4z). All monetary values are strings. All timestamps are ISO 8601. For details on creating webhook endpoints and verifying signatures, see Webhooks. For the event system and the subscriber pattern, see Events.

Event payloads include the same top-level attributes and unconditional associations as API responses. Associations that the API only returns when you ask for them with expand (like product variants, media, or custom fields) are not included in event payloads.

Renamed events

Spree 6.0 renamed several events. For one release, Spree sends the old name as well as the new one, so existing endpoints keep receiving deliveries. The old names stop in Spree 6.1 — subscribe to the new names.

Old name (sent until 6.1)	New name
`order.completed`	`order.placed`
`order.shipped`	`order.fulfilled`
`shipment.shipped`	`fulfillment.fulfilled`
`shipment.canceled`	`fulfillment.canceled`
`stock_item.created` / `.updated` / `.deleted`	`stock_level.created` / `.updated` / `.deleted`
`wished_item.created` / `.updated` / `.deleted`	`wishlist_item.created` / `.updated` / `.deleted`
`digital.created` / `.updated` / `.deleted`	`digital_asset.created` / `.updated` / `.deleted`

An order.completed delivery carries "deprecated_alias_of": "order.placed" in its metadata, so an endpoint subscribed to order.* can skip the duplicate. These events were removed in Spree 6.0 and are no longer sent:

order.resumed and fulfillment.resumed — a canceled order or fulfillment can no longer be resumed.
shipment.created and shipment.updated — use fulfillment.created and fulfillment.updated.
image.* — use media.*.
report.* — use saved_report.*.
reimbursement.*, return_authorization.*, return_item.* and customer_return.* — use the return.*, exchange.* and claim.* events.
post.* and post_category.*.

Order Events

Events: order.created, order.updated, order.deleted, order.placed, order.approved, order.canceled, order.paid, order.fulfilled, order.delivered, order.resend_confirmation_email, order.resend_digital_links_email

Event	When it fires
`order.placed`	A customer completed checkout, or an admin placed a draft order
`order.approved`	An admin approved an order that was flagged as risky
`order.canceled`	The order was canceled
`order.paid`	Payments cover the order total in full
`order.fulfilled`	Every fulfillment on the order was handed over to the customer or carrier
`order.delivered`	Every fulfillment on the order was delivered
`order.resend_confirmation_email`	An admin asked to send the order confirmation again
`order.resend_digital_links_email`	An admin asked to send the download links again

The order.placed and order.canceled payloads also contain a notify_customer boolean. It is false when whoever placed or canceled the order asked for the customer not to be emailed. Order payloads include nested items, fulfillments, payments, discounts, fees, billing_address, shipping_address, gift_card, and market.

{
  "id": "or_m3Rp9wXz",
  "cart_id": "cart_k5nR8xLq",
  "number": "R123456789",
  "email": "customer@example.com",
  "customer_note": null,
  "po_number": null,
  "currency": "USD",
  "locale": "en",
  "total_quantity": 3,
  "coupon_code": null,
  "fulfillment_status": "fulfilled",
  "payment_status": "paid",
  "market_id": "mkt_2wMn9xPq",
  "channel_id": "ch_3xLq8nRt",
  "company_id": null,
  "company_name": null,
  "item_total": "89.99",
  "display_item_total": "$89.99",
  "delivery_total": "10.00",
  "display_delivery_total": "$10.00",
  "adjustment_total": "0.00",
  "display_adjustment_total": "$0.00",
  "discount_total": "0.00",
  "display_discount_total": "$0.00",
  "tax_total": "0.00",
  "display_tax_total": "$0.00",
  "included_tax_total": "0.00",
  "display_included_tax_total": "$0.00",
  "additional_tax_total": "0.00",
  "display_additional_tax_total": "$0.00",
  "fee_total": "0.00",
  "display_fee_total": "$0.00",
  "store_credit_total": "0.00",
  "display_store_credit_total": "$0.00",
  "gift_card_total": "0.00",
  "display_gift_card_total": "$0.00",
  "covered_by_store_credit": false,
  "total": "99.99",
  "display_total": "$99.99",
  "amount_due": "0.00",
  "display_amount_due": "$0.00",
  "completed_at": "2025-01-15T10:30:00Z",
  "withdrawal_period_ends_at": null,
  "within_withdrawal_period": false,
  "discounts": [],
  "fees": [],
  "items": [
    {
      "id": "li_7xRt4wPq",
      "variant_id": "variant_k5nR8xLq",
      "quantity": 2,
      "name": "Spree Tote Bag",
      "price": "29.99",
      "total": "59.98",
      "..."
    }
  ],
  "fulfillments": [
    {
      "id": "ful_9xPq4wMn",
      "number": "H123456789",
      "status": "fulfilled",
      "fulfillment_type": "shipping",
      "tracking": "1Z999AA10123456784",
      "..."
    }
  ],
  "payments": [
    {
      "id": "py_3wXz7mRp",
      "status": "completed",
      "amount": "99.99",
      "..."
    }
  ],
  "billing_address": { "id": "addr_1xPq2wMn", "..." },
  "shipping_address": { "id": "addr_2wMn3xPq", "..." },
  "gift_card": null,
  "market": { "id": "mkt_2wMn9xPq", "..." }
}

Cart Events

Events: cart.created, cart.updated, cart.deleted Carts publish their own events, separate from orders. Use them to follow carts that were never checked out. The payload is the same cart object the Store API returns. When a cart is checked out, the resulting order carries the cart’s ID in its cart_id field.

Order Group Events

Events: order_group.created, order_group.updated, order_group.deleted, order_group.completed When one checkout creates several orders (for example, one per seller), they belong to an order group. order_group.completed fires once every order in the group is placed. The payload includes the group’s number, email, currency, total, item_total, fulfillment_status, payment_status, completed_at, the addresses, and the nested orders.

Line Item Events

Events: line_item.created, line_item.updated, line_item.deleted Line item payloads include nested option_values and digital_links.

{
  "id": "li_7xRt4wPq",
  "variant_id": "variant_k5nR8xLq",
  "seller_id": null,
  "quantity": 2,
  "currency": "USD",
  "name": "Spree Tote Bag",
  "slug": "spree-tote-bag",
  "options_text": "Size: M, Color: Black",
  "preorder": false,
  "preorder_ships_at": null,
  "price": "29.99",
  "display_price": "$29.99",
  "total": "59.98",
  "display_total": "$59.98",
  "adjustment_total": "0.00",
  "display_adjustment_total": "$0.00",
  "additional_tax_total": "2.40",
  "display_additional_tax_total": "$2.40",
  "included_tax_total": "0.00",
  "display_included_tax_total": "$0.00",
  "discount_total": "-5.00",
  "display_discount_total": "-$5.00",
  "pre_tax_amount": "54.98",
  "display_pre_tax_amount": "$54.98",
  "discounted_amount": "54.98",
  "display_discounted_amount": "$54.98",
  "compare_at_amount": null,
  "display_compare_at_amount": null,
  "thumbnail_url": "https://cdn.example.com/images/tote-bag.jpg",
  "option_values": [
    { "id": "optval_2wMn9xPq", "name": "m", "label": "M", "..." }
  ],
  "digital_links": []
}

Payment Events

Events: payment.created, payment.updated, payment.deleted, payment.completed, payment.paid, payment.captured, payment.voided, payment.refunded Payment payloads include a nested payment_method and a source (a credit card, store credit, or other payment source).

{
  "id": "py_3wXz7mRp",
  "status": "completed",
  "number": "P123456",
  "amount": "99.99",
  "display_amount": "$99.99",
  "response_code": "ch_abc123",
  "payment_method_id": "pm_4xLq8nRt",
  "source_type": "credit_card",
  "source_id": "card_5wPq9mXz",
  "source": {
    "id": "card_5wPq9mXz",
    "..."
  },
  "payment_method": {
    "id": "pm_4xLq8nRt",
    "..."
  }
}

The source_type field is one of: "credit_card", "store_credit", "payment_source", or null.

Payment Session Events

Events: payment_session.created, payment_session.updated, payment_session.deleted, payment_session.processing, payment_session.completed, payment_session.failed, payment_session.canceled, payment_session.expired Payment session payloads include a nested payment_method, and a nested payment once one exists.

{
  "id": "ps_6nRt2xLq",
  "status": "pending",
  "amount": "99.99",
  "currency": "USD",
  "external_id": "pi_3abc123",
  "external_data": {},
  "customer_external_id": null,
  "order_id": null,
  "cart_id": "cart_k5nR8xLq",
  "payment_method_id": "pm_4xLq8nRt",
  "payment_method": {
    "id": "pm_4xLq8nRt",
    "..."
  },
  "expires_at": "2025-01-15T11:00:00Z"
}

Payment Setup Session Events

Events: payment_setup_session.created, payment_setup_session.updated, payment_setup_session.deleted, payment_setup_session.processing, payment_setup_session.completed, payment_setup_session.failed, payment_setup_session.canceled, payment_setup_session.expired Payment setup session payloads include a nested payment_method.

{
  "id": "pss_8mXz3wPq",
  "status": "pending",
  "external_id": "seti_abc123",
  "external_client_secret": "seti_abc123_secret_xyz",
  "external_data": {},
  "payment_method_id": "pm_4xLq8nRt",
  "payment_source_id": null,
  "payment_source_type": null,
  "customer_id": "cust_k5nR8xLq",
  "payment_method": {
    "id": "pm_4xLq8nRt",
    "..."
  }
}

Refund Events

Events: refund.created, refund.updated, refund.deleted

{
  "id": "re_7xRt4wPq",
  "amount": "29.99",
  "transaction_id": "txn_abc123",
  "payment_id": "py_3wXz7mRp",
  "refund_reason_id": "rr_2wMn9xPq",
  "originator_id": null,
  "originator_type": null
}

Fulfillment Events

Events: fulfillment.created, fulfillment.updated, fulfillment.deleted, fulfillment.fulfilled, fulfillment.delivered, fulfillment.canceled fulfillment.fulfilled fires when a fulfillment is handed over — shipped, collected, or made available for download. Its metadata contains notify_customer, which tells you whether the customer should be emailed about it. fulfillment.delivered carries the same key. Fulfillment payloads include nested deliveries, delivery_method, stock_location, and delivery_rates.

{
  "id": "ful_9xPq4wMn",
  "number": "H123456789",
  "status": "fulfilled",
  "fulfillment_type": "shipping",
  "tracking": "1Z999AA10123456784",
  "tracking_url": "https://www.ups.com/track?tracknum=1Z999AA10123456784",
  "pickup_point_data": null,
  "selected_delivery_rate_id": "dr_5wPq9mXz",
  "unpriced": false,
  "cost": "10.00",
  "display_cost": "$10.00",
  "total": "10.00",
  "display_total": "$10.00",
  "discount_total": "0.00",
  "display_discount_total": "$0.00",
  "additional_tax_total": "0.00",
  "display_additional_tax_total": "$0.00",
  "included_tax_total": "0.00",
  "display_included_tax_total": "$0.00",
  "tax_total": "0.00",
  "display_tax_total": "$0.00",
  "fulfilled_at": "2025-01-16T14:00:00Z",
  "delivered_at": null,
  "items": [
    { "item_id": "li_7xRt4wPq", "variant_id": "variant_k5nR8xLq", "quantity": 2 }
  ],
  "deliveries": [],
  "delivery_method": {
    "id": "dm_2wMn7xRt",
    "..."
  },
  "stock_location": {
    "id": "sloc_2wMn7xRt",
    "..."
  },
  "delivery_rates": []
}

Product Events

Events: product.created, product.updated, product.deleted, product.drafted, product.proposed, product.approved, product.rejected, product.activated, product.archived, product.out_of_stock, product.back_in_stock Product event payloads include pricing, stock status, and availability flags. Variants, media, option types, categories, and custom fields are not included.

{
  "id": "prod_86Rf07xd4z",
  "name": "Spree Tote Bag",
  "slug": "spree-tote-bag",
  "description": "A beautiful tote bag",
  "description_html": "<p>A beautiful tote bag</p>",
  "meta_title": null,
  "meta_description": null,
  "meta_keywords": null,
  "variant_count": 3,
  "default_variant_id": "variant_k5nR8xLq",
  "buy_box_variant_id": null,
  "seller_id": null,
  "thumbnail_url": "https://cdn.example.com/images/tote-bag.jpg",
  "purchasable": true,
  "in_stock": true,
  "backorderable": false,
  "available": true,
  "preorder": false,
  "preorder_ships_at": null,
  "tags": ["summer", "accessories"],
  "price": {
    "id": "price_4wPq9mXz",
    "amount": "29.99",
    "amount_in_cents": 2999,
    "display_amount": "$29.99",
    "compare_at_amount": null,
    "compare_at_amount_in_cents": null,
    "display_compare_at_amount": null,
    "currency": "USD",
    "price_list_id": null
  },
  "original_price": null,
  "available_on": "2025-01-01T00:00:00Z"
}

Variant Events

Events: variant.created, variant.updated, variant.deleted Variant event payloads include pricing, stock status, and option_values. Media and custom fields are not included.

{
  "id": "variant_k5nR8xLq",
  "product_id": "prod_86Rf07xd4z",
  "seller_id": null,
  "sku": "SPR-TOTE-BLK",
  "options_text": "Size: M, Color: Black",
  "track_inventory": true,
  "media_count": 2,
  "thumbnail_url": "https://cdn.example.com/images/tote-bag-black.jpg",
  "purchasable": true,
  "in_stock": true,
  "backorderable": false,
  "preorder": false,
  "preorder_ships_at": null,
  "weight": 0.5,
  "height": 40.0,
  "width": 35.0,
  "depth": 10.0,
  "weight_unit": "kg",
  "dimensions_unit": "cm",
  "minimum_order_quantity": 1,
  "order_multiple": 1,
  "purchase_unit": "unit",
  "units_per_carton": null,
  "price": {
    "id": "price_4wPq9mXz",
    "amount": "29.99",
    "currency": "USD",
    "..."
  },
  "original_price": null,
  "option_values": [
    { "id": "optval_2wMn9xPq", "name": "m", "label": "M", "..." },
    { "id": "optval_3xLq8nRt", "name": "black", "label": "Black", "..." }
  ]
}

Price Events

Events: price.created, price.updated, price.deleted

{
  "id": "price_4wPq9mXz",
  "amount": "29.99",
  "amount_in_cents": 2999,
  "display_amount": "$29.99",
  "compare_at_amount": "39.99",
  "compare_at_amount_in_cents": 3999,
  "display_compare_at_amount": "$39.99",
  "currency": "USD",
  "price_list_id": null
}

Media Events

Events: media.created, media.updated, media.deleted Media events carry a short payload. Fetch the product or variant from the API when you need the image URLs.

{
  "id": "media_5mXz3wPq",
  "media_type": "image",
  "viewable_type": "product",
  "viewable_id": "prod_86Rf07xd4z",
  "position": 1,
  "alt": "Black tote bag front view",
  "created_at": "2025-01-01T00:00:00Z",
  "updated_at": "2025-01-01T00:00:00Z"
}

Stock Level Events

Events: stock_level.created, stock_level.updated, stock_level.deleted A stock level is the quantity of one variant at one stock location.

{
  "id": "sl_6nRt2xLq",
  "count_on_hand": 25,
  "backorderable": false,
  "stock_location_id": "sloc_2wMn7xRt",
  "variant_id": "variant_k5nR8xLq"
}

Stock Movement Events

Events: stock_movement.created, stock_movement.updated, stock_movement.deleted

{
  "id": "sm_7xRt4wPq",
  "quantity": -1,
  "kind": "shipped",
  "reason": null,
  "stock_level_id": "sl_6nRt2xLq",
  "created_at": "2025-01-15T10:30:00Z",
  "updated_at": "2025-01-15T10:30:00Z"
}

Stock Transfer Events

Events: stock_transfer.created, stock_transfer.updated, stock_transfer.deleted, stock_transfer.draft, stock_transfer.ready_to_ship, stock_transfer.shipped, stock_transfer.partially_received, stock_transfer.received, stock_transfer.over_received, stock_transfer.canceled

{
  "id": "st_8mXz3wPq",
  "number": "T123456789",
  "reference": "Warehouse rebalance",
  "source_location_id": "sloc_2wMn7xRt",
  "destination_location_id": "sloc_9xPq4wMn",
  "created_at": "2025-01-15T10:00:00Z",
  "updated_at": "2025-01-15T10:00:00Z"
}

Customer Events

Events: user.created, user.updated, user.deleted, customer.anonymized, customer.password_reset_requested, customer.password_reset Customer lifecycle events use the user prefix. Customer payloads include nested addresses, default_billing_address, default_shipping_address, newsletter_subscriber, and customer_groups.

{
  "id": "cust_k5nR8xLq",
  "email": "customer@example.com",
  "first_name": "John",
  "last_name": "Doe",
  "full_name": "John Doe",
  "phone": null,
  "accepts_email_marketing": true,
  "email_marketing_consent_updated_at": "2025-01-01T00:00:00Z",
  "available_store_credit_total": "0.0",
  "display_available_store_credit_total": "$0.00",
  "addresses": [],
  "default_billing_address": null,
  "default_shipping_address": null,
  "newsletter_subscriber": null,
  "customer_groups": []
}

Promotion Events

Events: promotion.created, promotion.updated, promotion.deleted

{
  "id": "promo_2wMn9xPq",
  "name": "Summer Sale 20% Off",
  "description": "20% off all summer items",
  "code": "SUMMER20"
}

Gift Card Events

Events: gift_card.created, gift_card.updated, gift_card.deleted, gift_card.partially_redeemed, gift_card.redeemed, gift_card.canceled

{
  "id": "gc_4xLq8nRt",
  "code": "HOLIDAY-8F3K2M",
  "status": "partially_redeemed",
  "amount": "50.0",
  "amount_used": "15.0",
  "amount_authorized": "0.0",
  "amount_remaining": "35.0",
  "display_amount": "$50.00",
  "display_amount_used": "$15.00",
  "display_amount_remaining": "$35.00",
  "currency": "USD",
  "expired": false,
  "active": true,
  "expires_at": "2026-01-01",
  "redeemed_at": null
}

Gift Card Batch Events

Events: gift_card_batch.created, gift_card_batch.updated, gift_card_batch.deleted

{
  "id": "gcb_5wPq9mXz",
  "codes_count": 100,
  "amount": "25.0",
  "currency": "USD",
  "prefix": "HOLIDAY",
  "expires_at": "2026-12-31",
  "created_by_id": "adm_8mXz3wPq",
  "created_at": "2025-01-01T00:00:00Z",
  "updated_at": "2025-01-01T00:00:00Z"
}

Store Credit Events

Events: store_credit.created, store_credit.updated, store_credit.deleted

{
  "id": "credit_6nRt2xLq",
  "amount": "100.0",
  "amount_used": "25.0",
  "amount_remaining": "75.0",
  "display_amount": "$100.00",
  "display_amount_used": "$25.00",
  "display_amount_remaining": "$75.00",
  "currency": "USD"
}

Return Events

Events: return.created, return.updated, return.deleted, return.requested, return.approved, return.received, return.refunded, return.canceled The returned items are not included. Fetch the return from the API with expand=return_line_items when you need them.

{
  "id": "ret_8mXz3wPq",
  "number": "RET123456789",
  "status": "received",
  "order_id": "or_m3Rp9wXz",
  "reason_id": "rar_9xPq4wMn",
  "refund_total": "0.0",
  "display_refund_total": "$0.00",
  "approved_at": "2025-01-18T10:00:00Z",
  "received_at": "2025-01-20T10:00:00Z",
  "refunded_at": null,
  "canceled_at": null
}

Exchange Events

Events: exchange.created, exchange.updated, exchange.deleted, exchange.requested, exchange.approved, exchange.received, exchange.fulfilled, exchange.canceled

{
  "id": "exch_4xLq8nRt",
  "number": "EX123456789",
  "status": "approved",
  "order_id": "or_m3Rp9wXz",
  "reason_id": "rar_9xPq4wMn",
  "price_difference": "0.0",
  "display_price_difference": "$0.00",
  "approved_at": "2025-01-18T10:00:00Z",
  "received_at": null,
  "fulfilled_at": null,
  "canceled_at": null
}

Claim Events

Events: claim.created, claim.updated, claim.deleted, claim.opened, claim.approved, claim.resolved, claim.denied, claim.canceled The resolution field is refund, replacement, refund_and_replacement, or null until the claim is resolved.

{
  "id": "claim_2wMn9xPq",
  "number": "CLM123456789",
  "status": "resolved",
  "resolution": "refund",
  "order_id": "or_m3Rp9wXz",
  "reason_id": "clr_3xLq8nRt",
  "refund_total": "29.99",
  "display_refund_total": "$29.99",
  "approved_at": "2025-01-18T10:00:00Z",
  "resolved_at": "2025-01-19T10:00:00Z",
  "denied_at": null,
  "canceled_at": null
}

Wishlist Events

Events: wishlist.created, wishlist.updated, wishlist.deleted Wishlist items are not included in wishlist event payloads.

{
  "id": "wl_5wPq9mXz",
  "name": "My Wishlist",
  "token": "abc123def456",
  "is_default": true,
  "is_private": true
}

Wishlist Item Events

Events: wishlist_item.created, wishlist_item.updated, wishlist_item.deleted Wishlist item payloads include a nested variant.

{
  "id": "wi_6nRt2xLq",
  "variant_id": "variant_k5nR8xLq",
  "product_id": "prod_86Rf07xd4z",
  "wishlist_id": "wl_5wPq9mXz",
  "quantity": 1,
  "variant": {
    "id": "variant_k5nR8xLq",
    "..."
  }
}

Events: newsletter_subscriber.created, newsletter_subscriber.updated, newsletter_subscriber.deleted, newsletter_subscriber.subscription_requested, newsletter_subscriber.verified, newsletter_subscriber.unsubscribe_requested

{
  "id": "sub_2wMn9xPq",
  "email": "subscriber@example.com",
  "verified": true,
  "verified_at": "2025-01-02T10:00:00Z",
  "customer_id": "cust_k5nR8xLq",
  "created_at": "2025-01-01T00:00:00Z",
  "updated_at": "2025-01-02T10:00:00Z"
}

Digital Asset Events

Events: digital_asset.created, digital_asset.updated, digital_asset.deleted

{
  "id": "dig_3xLq8nRt",
  "variant_id": "variant_k5nR8xLq",
  "filename": "ebook.pdf",
  "content_type": "application/pdf"
}

Digital Link Events

Events: digital_link.created, digital_link.updated, digital_link.deleted, digital_link.downloaded digital_link.downloaded fires each time a customer successfully downloads the file, after the access counter has been incremented.

{
  "id": "dl_4xLq8nRt",
  "access_counter": 3,
  "filename": "ebook.pdf",
  "content_type": "application/pdf",
  "download_url": "/api/v3/store/digital_links/abc123",
  "expires_at": "2025-01-22T10:30:00Z",
  "authorizable": true,
  "expired": false,
  "access_limit_exceeded": false
}

Import Events

Events: import.created, import.updated, import.deleted, import.progress, import.completed

{
  "id": "imp_5wPq9mXz",
  "number": "IM123456789",
  "type": "products",
  "status": "completed",
  "store_id": "store_9xPq2wMn",
  "seller_id": null,
  "owner_type": "store",
  "owner_id": "store_9xPq2wMn",
  "user_id": "adm_8mXz3wPq",
  "rows_count": 150,
  "created_at": "2025-01-15T10:00:00Z",
  "updated_at": "2025-01-15T10:05:00Z"
}

Import Row Events

Events: import_row.completed, import_row.failed

{
  "id": "imrow_6nRt2xLq",
  "import_id": "imp_5wPq9mXz",
  "row_number": 42,
  "status": "completed",
  "validation_errors": [],
  "item_type": "product",
  "item_id": "prod_86Rf07xd4z",
  "created_at": "2025-01-15T10:01:00Z",
  "updated_at": "2025-01-15T10:01:00Z"
}

Export Events

Events: export.created, export.updated, export.deleted

{
  "id": "exp_7xRt4wPq",
  "number": "EF123456789",
  "type": "products",
  "format": "csv",
  "user_id": "adm_8mXz3wPq",
  "created_at": "2025-01-15T10:00:00Z",
  "updated_at": "2025-01-15T10:02:00Z"
}

Invitation Events

Events: invitation.created, invitation.resent, invitation.accepted

{
  "id": "inv_9xPq4wMn",
  "email": "newadmin@example.com",
  "status": "pending",
  "resource_type": "store",
  "resource_id": "store_9xPq2wMn",
  "inviter_type": "admin_user",
  "inviter_id": "adm_8mXz3wPq",
  "invitee_type": null,
  "invitee_id": null,
  "role_id": "role_2wMn9xPq",
  "expires_at": "2025-02-15T10:00:00Z",
  "accepted_at": null,
  "created_at": "2025-01-15T10:00:00Z",
  "updated_at": "2025-01-15T10:00:00Z"
}

Other Events

These resources publish events too. Their payloads use the same serializers as the matching API responses.

Resource	Events
Delivery (a tracked parcel within a fulfillment)	`delivery.created`, `delivery.updated`, `delivery.deleted`
Shipping label	`shipping_label.created`, `shipping_label.updated`, `shipping_label.deleted`, `shipping_label.purchased`, `shipping_label.refunded`
Stock reservation	`stock_reservation.created`, `stock_reservation.updated`, `stock_reservation.deleted`
Purchase order	`purchase_order.created`, `purchase_order.updated`, `purchase_order.deleted`, `purchase_order.draft`, `purchase_order.ordered`, `purchase_order.partially_received`, `purchase_order.received`, `purchase_order.over_received`, `purchase_order.canceled`
Stock receipt	`stock_receipt.created`, `stock_receipt.updated`, `stock_receipt.deleted`
Supplier	`supplier.created`, `supplier.updated`, `supplier.deleted`
Catalog	`catalog.created`, `catalog.updated`, `catalog.deleted`
Saved report	`saved_report.created`, `saved_report.updated`, `saved_report.deleted`
Data request (customer data export or erasure)	`data_request.created`, `data_request.updated`, `data_request.deleted`, `data_request.completed`
Company	`company.created`, `company.updated`, `company.deleted`
Company invitation	`company_invitation.created`, `company_invitation.updated`, `company_invitation.deleted`, `company_invitation.accepted`, `company_invitation.revoked`
Tax identifier	`tax_identifier.number_changed`
Tax exemption certificate	`tax_exemption_certificate.verified`
Seller	`seller.created`, `seller.updated`, `seller.deleted`, `seller.invited`, `seller.onboarding_started`, `seller.submitted_for_review`, `seller.approved`, `seller.rejected`, `seller.suspended`, `seller.onboarding_reopened`
Seller requirement submission	`seller_requirement_submission.created`, `seller_requirement_submission.updated`, `seller_requirement_submission.deleted`, `seller_requirement_submission.accepted`, `seller_requirement_submission.rejected`, `seller_requirement_submission.waived`
Seller payout	`seller_payout.completed`
Product submission	`product_submission.created`, `product_submission.updated`, `product_submission.deleted`

​Renamed events

​Order Events

​Cart Events

​Order Group Events

​Line Item Events

​Payment Events

​Payment Session Events

​Payment Setup Session Events

​Refund Events

​Fulfillment Events

​Product Events

​Variant Events

​Price Events

​Media Events

​Stock Level Events

​Stock Movement Events

​Stock Transfer Events

​Customer Events

​Promotion Events

​Gift Card Events

​Gift Card Batch Events

​Store Credit Events

​Return Events

​Exchange Events

​Claim Events

​Wishlist Events

​Wishlist Item Events

​Newsletter Subscriber Events

​Digital Asset Events

​Digital Link Events

​Import Events

​Import Row Events

​Export Events

​Invitation Events

​Other Events

Renamed events

Order Events

Cart Events

Order Group Events

Line Item Events

Payment Events

Payment Session Events

Payment Setup Session Events

Refund Events

Fulfillment Events

Product Events

Variant Events

Price Events

Media Events

Stock Level Events

Stock Movement Events

Stock Transfer Events

Customer Events

Promotion Events

Gift Card Events

Gift Card Batch Events

Store Credit Events

Return Events

Exchange Events

Claim Events

Wishlist Events

Wishlist Item Events

Newsletter Subscriber Events

Digital Asset Events

Digital Link Events

Import Events

Import Row Events

Export Events

Invitation Events

Other Events