docs: fix events payloads (#14131)

This commit is contained in:
Shahed Nasser
2025-11-26 16:12:00 +02:00
committed by GitHub
parent c1ede88a7e
commit c3cebdfe80
139 changed files with 1057 additions and 904 deletions
@@ -64,9 +64,9 @@
* - name: product-collection.deleted
* payload: |-
* ```ts
* [{
* {
* id, // The ID of the product collection
* }]
* }
* ```
* description: Emitted when product collections are deleted.
* deprecated: false
@@ -82,9 +82,9 @@
* - name: customer.deleted
* payload: |-
* ```ts
* [{
* {
* id, // The ID of the customer
* }]
* }
* ```
* description: Emitted when a customer is deleted.
* deprecated: false
@@ -81,9 +81,9 @@
* - name: invite.deleted
* payload: |-
* ```ts
* [{
* {
* id, // The ID of the invite
* }]
* }
* ```
* description: Emitted when invites are deleted.
* deprecated: false
@@ -64,9 +64,9 @@
* - name: product-category.deleted
* payload: |-
* ```ts
* [{
* {
* id, // The ID of the product category
* }]
* }
* ```
* description: Emitted when product categories are deleted.
* deprecated: false
@@ -64,9 +64,9 @@
* - name: product-tag.deleted
* payload: |-
* ```ts
* [{
* {
* id, // The ID of the product tag
* }]
* }
* ```
* description: Emitted when product tags are deleted.
* deprecated: false
@@ -64,9 +64,9 @@
* - name: product-type.deleted
* payload: |-
* ```ts
* [{
* {
* id, // The ID of the product type
* }]
* }
* ```
* description: Emitted when product types are deleted.
* deprecated: false
@@ -64,9 +64,9 @@
* - name: product.deleted
* payload: |-
* ```ts
* [{
* {
* id, // The ID of the product
* }]
* }
* ```
* description: Emitted when products are deleted.
* deprecated: false
@@ -86,9 +86,9 @@
* - name: product-option.deleted
* payload: |-
* ```ts
* [{
* {
* id, // The ID of the product option
* }]
* }
* ```
* description: Emitted when product options are deleted.
* deprecated: false
@@ -83,9 +83,9 @@
* - name: product-variant.deleted
* payload: |-
* ```ts
* [{
* {
* id, // The ID of the product variant
* }]
* }
* ```
* description: Emitted when product variants are deleted.
* deprecated: false
@@ -83,9 +83,9 @@
* - name: region.deleted
* payload: |-
* ```ts
* [{
* {
* id, // The ID of the region
* }]
* }
* ```
* description: Emitted when regions are deleted.
* deprecated: false
@@ -64,9 +64,9 @@
* - name: sales-channel.deleted
* payload: |-
* ```ts
* [{
* {
* id, // The ID of the sales channel
* }]
* }
* ```
* description: Emitted when sales channels are deleted.
* deprecated: false
@@ -65,9 +65,9 @@
* - name: shipping-option-type.deleted
* payload: |-
* ```ts
* [{
* {
* id, // The ID of the shipping option type
* }]
* }
* ```
* description: Emitted when shipping option types are deleted.
* deprecated: false
@@ -61,9 +61,9 @@
* - name: user.deleted
* payload: |-
* ```ts
* [{
* {
* id, // The ID of the user
* }]
* }
* ```
* description: Emitted when users are deleted.
* deprecated: false
@@ -105,9 +105,9 @@
* - name: product-collection.created
* payload: |-
* ```ts
* [{
* {
* id, // The ID of the product collection
* }]
* }
* ```
* description: Emitted when product collections are created.
* deprecated: false
@@ -108,9 +108,9 @@
* - name: product-collection.updated
* payload: |-
* ```ts
* [{
* {
* id, // The ID of the product collection
* }]
* }
* ```
* description: Emitted when product collections are updated.
* deprecated: false
@@ -129,9 +129,9 @@
* - name: customer.created
* payload: |-
* ```ts
* [{
* {
* id, // The ID of the customer
* }]
* }
* ```
* description: Emitted when a customer is created.
* deprecated: false
@@ -135,9 +135,9 @@
* - name: customer.updated
* payload: |-
* ```ts
* [{
* {
* id, // The ID of the customer
* }]
* }
* ```
* description: Emitted when a customer is updated.
* deprecated: false
@@ -92,9 +92,9 @@
* - name: invite.created
* payload: |-
* ```ts
* [{
* {
* id, // The ID of the invite
* }]
* }
* ```
* description: |-
* Emitted when invites are created. You can listen to this event
@@ -74,9 +74,9 @@
* - name: invite.resent
* payload: |-
* ```ts
* [{
* {
* id, // The ID of the invite
* }]
* }
* ```
* description: |-
* Emitted when invites should be resent because their token was
@@ -95,9 +95,9 @@
* - name: user.created
* payload: |-
* ```ts
* [{
* {
* id, // The ID of the user
* }]
* }
* ```
* description: Emitted when users are created.
* deprecated: false
@@ -80,9 +80,9 @@
* - name: order.archived
* payload: |-
* ```ts
* [{
* {
* id, // The ID of the order
* }]
* }
* ```
* description: Emitted when an order is archived.
* deprecated: false
@@ -90,9 +90,9 @@
* - name: order.completed
* payload: |-
* ```ts
* [{
* {
* id, // The ID of the order
* }]
* }
* ```
* description: Emitted when orders are completed.
* deprecated: false
@@ -107,9 +107,9 @@
* - name: product-category.created
* payload: |-
* ```ts
* [{
* {
* id, // The ID of the product category
* }]
* }
* ```
* description: Emitted when product categories are created.
* deprecated: false
@@ -112,9 +112,9 @@
* - name: product-category.updated
* payload: |-
* ```ts
* [{
* {
* id, // The ID of the product category
* }]
* }
* ```
* description: Emitted when product categories are updated.
* deprecated: false
@@ -82,9 +82,9 @@
* - name: product-tag.created
* payload: |-
* ```ts
* [{
* {
* id, // The ID of the product tag
* }]
* }
* ```
* description: Emitted when product tags are created.
* deprecated: false
@@ -87,9 +87,9 @@
* - name: product-tag.updated
* payload: |-
* ```ts
* [{
* {
* id, // The ID of the product tag
* }]
* }
* ```
* description: Emitted when product tags are updated.
* deprecated: false
@@ -82,9 +82,9 @@
* - name: product-type.created
* payload: |-
* ```ts
* [{
* {
* id, // The ID of the product type
* }]
* }
* ```
* description: Emitted when product types are created.
* deprecated: false
@@ -87,9 +87,9 @@
* - name: product-type.updated
* payload: |-
* ```ts
* [{
* {
* id, // The ID of the product type
* }]
* }
* ```
* description: Emitted when product types are updated.
* deprecated: false
@@ -109,18 +109,18 @@
* - name: product-variant.created
* payload: |-
* ```ts
* [{
* {
* id, // The ID of the product variant
* }]
* }
* ```
* description: Emitted when product variants are created.
* deprecated: false
* - name: product.created
* payload: |-
* ```ts
* [{
* {
* id, // The ID of the product
* }]
* }
* ```
* description: Emitted when products are created.
* deprecated: false
@@ -91,9 +91,9 @@
* - name: product.updated
* payload: |-
* ```ts
* [{
* {
* id, // The ID of the product
* }]
* }
* ```
* description: Emitted when products are updated.
* deprecated: false
@@ -103,9 +103,9 @@
* - name: product-option.created
* payload: |-
* ```ts
* [{
* {
* id, // The ID of the product option
* }]
* }
* ```
* description: Emitted when product options are created.
* deprecated: false
@@ -102,9 +102,9 @@
* - name: product-option.updated
* payload: |-
* ```ts
* [{
* {
* id, // The ID of the product option
* }]
* }
* ```
* description: Emitted when product options are updated.
* deprecated: false
@@ -106,9 +106,9 @@
* - name: product-variant.created
* payload: |-
* ```ts
* [{
* {
* id, // The ID of the product variant
* }]
* }
* ```
* description: Emitted when product variants are created.
* deprecated: false
@@ -102,9 +102,9 @@
* - name: product-variant.updated
* payload: |-
* ```ts
* [{
* {
* id, // The ID of the product variant
* }]
* }
* ```
* description: Emitted when product variants are updated.
* deprecated: false
@@ -99,27 +99,27 @@
* - name: product-variant.updated
* payload: |-
* ```ts
* [{
* {
* id, // The ID of the product variant
* }]
* }
* ```
* description: Emitted when product variants are updated.
* deprecated: false
* - name: product-variant.created
* payload: |-
* ```ts
* [{
* {
* id, // The ID of the product variant
* }]
* }
* ```
* description: Emitted when product variants are created.
* deprecated: false
* - name: product-variant.deleted
* payload: |-
* ```ts
* [{
* {
* id, // The ID of the product variant
* }]
* }
* ```
* description: Emitted when product variants are deleted.
* deprecated: false
@@ -104,36 +104,36 @@
* - name: product-variant.created
* payload: |-
* ```ts
* [{
* {
* id, // The ID of the product variant
* }]
* }
* ```
* description: Emitted when product variants are created.
* deprecated: false
* - name: product.updated
* payload: |-
* ```ts
* [{
* {
* id, // The ID of the product
* }]
* }
* ```
* description: Emitted when products are updated.
* deprecated: false
* - name: product.created
* payload: |-
* ```ts
* [{
* {
* id, // The ID of the product
* }]
* }
* ```
* description: Emitted when products are created.
* deprecated: false
* - name: product.deleted
* payload: |-
* ```ts
* [{
* {
* id, // The ID of the product
* }]
* }
* ```
* description: Emitted when products are deleted.
* deprecated: false
@@ -64,36 +64,36 @@
* - name: product-variant.created
* payload: |-
* ```ts
* [{
* {
* id, // The ID of the product variant
* }]
* }
* ```
* description: Emitted when product variants are created.
* deprecated: false
* - name: product.updated
* payload: |-
* ```ts
* [{
* {
* id, // The ID of the product
* }]
* }
* ```
* description: Emitted when products are updated.
* deprecated: false
* - name: product.created
* payload: |-
* ```ts
* [{
* {
* id, // The ID of the product
* }]
* }
* ```
* description: Emitted when products are created.
* deprecated: false
* - name: product.deleted
* payload: |-
* ```ts
* [{
* {
* id, // The ID of the product
* }]
* }
* ```
* description: Emitted when products are deleted.
* deprecated: false
@@ -84,9 +84,9 @@
* - name: region.created
* payload: |-
* ```ts
* [{
* {
* id, // The ID of the region
* }]
* }
* ```
* description: Emitted when regions are created.
* deprecated: false
@@ -87,9 +87,9 @@
* - name: region.updated
* payload: |-
* ```ts
* [{
* {
* id, // The ID of the region
* }]
* }
* ```
* description: Emitted when regions are updated.
* deprecated: false
@@ -83,9 +83,9 @@
* - name: sales-channel.created
* payload: |-
* ```ts
* [{
* {
* id, // The ID of the sales channel
* }]
* }
* ```
* description: Emitted when sales channels are created.
* deprecated: false
@@ -91,9 +91,9 @@
* - name: sales-channel.updated
* payload: |-
* ```ts
* [{
* {
* id, // The ID of the sales channel
* }]
* }
* ```
* description: Emitted when sales channels are updated.
* deprecated: false
@@ -86,9 +86,9 @@
* - name: shipping-option-type.created
* payload: |-
* ```ts
* [{
* {
* id, // The ID of the shipping option type
* }]
* }
* ```
* description: Emitted when shipping option types are created.
* deprecated: false
@@ -85,9 +85,9 @@
* - name: shipping-option-type.updated
* payload: |-
* ```ts
* [{
* {
* id, // The ID of the shipping option type
* }]
* }
* ```
* description: Emitted when shipping option types are updated.
* deprecated: false
@@ -88,9 +88,9 @@
* - name: user.updated
* payload: |-
* ```ts
* [{
* {
* id, // The ID of the user
* }]
* }
* ```
* description: Emitted when users are updated.
* deprecated: false