asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

docs: fix events payloads (#14131)

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

4
www/apps/api-reference/specs/admin/paths/admin_collections.yaml
View File

@@ -1078,9 +1078,9 @@ post:
- name: product-collection.created
payload: |-
```ts
[{
{
id, // The ID of the product collection
}]
}
```
description: Emitted when product collections are created.
deprecated: false

8
www/apps/api-reference/specs/admin/paths/admin_collections_{id}.yaml
View File

@@ -162,9 +162,9 @@ post:
- name: product-collection.updated
payload: |-
```ts
[{
{
id, // The ID of the product collection
}]
}
```
description: Emitted when product collections are updated.
deprecated: false
@@ -219,9 +219,9 @@ delete:
- name: product-collection.deleted
payload: |-
```ts
[{
{
id, // The ID of the product collection
}]
}
```
description: Emitted when product collections are deleted.
deprecated: false

4
www/apps/api-reference/specs/admin/paths/admin_customers.yaml
View File

@@ -4349,9 +4349,9 @@ post:
- name: customer.created
payload: |-
```ts
[{
{
id, // The ID of the customer
}]
}
```
description: Emitted when a customer is created.
deprecated: false

8
www/apps/api-reference/specs/admin/paths/admin_customers_{id}.yaml
View File

@@ -198,9 +198,9 @@ post:
- name: customer.updated
payload: |-
```ts
[{
{
id, // The ID of the customer
}]
}
```
description: Emitted when a customer is updated.
deprecated: false
@@ -273,9 +273,9 @@ delete:
- name: customer.deleted
payload: |-
```ts
[{
{
id, // The ID of the customer
}]
}
```
description: Emitted when a customer is deleted.
deprecated: false

4
www/apps/api-reference/specs/admin/paths/admin_invites.yaml
View File

@@ -685,9 +685,9 @@ post:
- name: invite.created
payload: |-
```ts
[{
{
id, // The ID of the invite
}]
}
```
description: |-
Emitted when invites are created. You can listen to this event

4
www/apps/api-reference/specs/admin/paths/admin_invites_accept.yaml
View File

@@ -68,9 +68,9 @@ post:
- name: user.created
payload: |-
```ts
[{
{
id, // The ID of the user
}]
}
```
description: Emitted when users are created.
deprecated: false

4
www/apps/api-reference/specs/admin/paths/admin_invites_{id}.yaml
View File

@@ -134,9 +134,9 @@ delete:
- name: invite.deleted
payload: |-
```ts
[{
{
id, // The ID of the invite
}]
}
```
description: Emitted when invites are deleted.
deprecated: false

4
www/apps/api-reference/specs/admin/paths/admin_invites_{id}_resend.yaml
View File

@@ -67,9 +67,9 @@ post:
- name: invite.resent
payload: |-
```ts
[{
{
id, // The ID of the invite
}]
}
```
description: >-
Emitted when invites should be resent because their token was

4
www/apps/api-reference/specs/admin/paths/admin_orders_{id}_archive.yaml
View File

@@ -67,9 +67,9 @@ post:
- name: order.archived
payload: |-
```ts
[{
{
id, // The ID of the order
}]
}
```
description: Emitted when an order is archived.
deprecated: false

4
www/apps/api-reference/specs/admin/paths/admin_orders_{id}_complete.yaml
View File

@@ -82,9 +82,9 @@ post:
- name: order.completed
payload: |-
```ts
[{
{
id, // The ID of the order
}]
}
```
description: Emitted when orders are completed.
deprecated: false

4
www/apps/api-reference/specs/admin/paths/admin_product-categories.yaml
View File

@@ -801,9 +801,9 @@ post:
- name: product-category.created
payload: |-
```ts
[{
{
id, // The ID of the product category
}]
}
```
description: Emitted when product categories are created.
deprecated: false

8
www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}.yaml
View File

@@ -1206,9 +1206,9 @@ post:
- name: product-category.updated
payload: |-
```ts
[{
{
id, // The ID of the product category
}]
}
```
description: Emitted when product categories are updated.
deprecated: false
@@ -1263,9 +1263,9 @@ delete:
- name: product-category.deleted
payload: |-
```ts
[{
{
id, // The ID of the product category
}]
}
```
description: Emitted when product categories are deleted.
deprecated: false

4
www/apps/api-reference/specs/admin/paths/admin_product-tags.yaml
View File

@@ -642,9 +642,9 @@ post:
- name: product-tag.created
payload: |-
```ts
[{
{
id, // The ID of the product tag
}]
}
```
description: Emitted when product tags are created.
deprecated: false

8
www/apps/api-reference/specs/admin/paths/admin_product-tags_{id}.yaml
View File

@@ -138,9 +138,9 @@ post:
- name: product-tag.updated
payload: |-
```ts
[{
{
id, // The ID of the product tag
}]
}
```
description: Emitted when product tags are updated.
deprecated: false
@@ -195,9 +195,9 @@ delete:
- name: product-tag.deleted
payload: |-
```ts
[{
{
id, // The ID of the product tag
}]
}
```
description: Emitted when product tags are deleted.
deprecated: false

4
www/apps/api-reference/specs/admin/paths/admin_product-types.yaml
View File

@@ -642,9 +642,9 @@ post:
- name: product-type.created
payload: |-
```ts
[{
{
id, // The ID of the product type
}]
}
```
description: Emitted when product types are created.
deprecated: false

8
www/apps/api-reference/specs/admin/paths/admin_product-types_{id}.yaml
View File

@@ -138,9 +138,9 @@ post:
- name: product-type.updated
payload: |-
```ts
[{
{
id, // The ID of the product type
}]
}
```
description: Emitted when product types are updated.
deprecated: false
@@ -195,9 +195,9 @@ delete:
- name: product-type.deleted
payload: |-
```ts
[{
{
id, // The ID of the product type
}]
}
```
description: Emitted when product types are deleted.
deprecated: false

8
www/apps/api-reference/specs/admin/paths/admin_products.yaml
View File

@@ -1368,18 +1368,18 @@ post:
- 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

16
www/apps/api-reference/specs/admin/paths/admin_products_batch.yaml
View File

@@ -66,36 +66,36 @@ post:
- 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

16
www/apps/api-reference/specs/admin/paths/admin_products_import.yaml
View File

@@ -50,36 +50,36 @@ post:
- 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

8
www/apps/api-reference/specs/admin/paths/admin_products_{id}.yaml
View File

@@ -149,9 +149,9 @@ post:
- name: product.updated
payload: |-
```ts
[{
{
id, // The ID of the product
}]
}
```
description: Emitted when products are updated.
deprecated: false
@@ -206,9 +206,9 @@ delete:
- name: product.deleted
payload: |-
```ts
[{
{
id, // The ID of the product
}]
}
```
description: Emitted when products are deleted.
deprecated: false

4
www/apps/api-reference/specs/admin/paths/admin_products_{id}_options.yaml
View File

@@ -285,9 +285,9 @@ post:
- name: product-option.created
payload: |-
```ts
[{
{
id, // The ID of the product option
}]
}
```
description: Emitted when product options are created.
deprecated: false

8
www/apps/api-reference/specs/admin/paths/admin_products_{id}_options_{option_id}.yaml
View File

@@ -163,9 +163,9 @@ post:
- name: product-option.updated
payload: |-
```ts
[{
{
id, // The ID of the product option
}]
}
```
description: Emitted when product options are updated.
deprecated: false
@@ -250,9 +250,9 @@ delete:
- name: product-option.deleted
payload: |-
```ts
[{
{
id, // The ID of the product option
}]
}
```
description: Emitted when product options are deleted.
deprecated: false

4
www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants.yaml
View File

@@ -746,9 +746,9 @@ post:
- name: product-variant.created
payload: |-
```ts
[{
{
id, // The ID of the product variant
}]
}
```
description: Emitted when product variants are created.
deprecated: false

12
www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_batch.yaml
View File

@@ -73,27 +73,27 @@ post:
- 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

8
www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}.yaml
View File

@@ -164,9 +164,9 @@ post:
- name: product-variant.updated
payload: |-
```ts
[{
{
id, // The ID of the product variant
}]
}
```
description: Emitted when product variants are updated.
deprecated: false
@@ -248,9 +248,9 @@ delete:
- name: product-variant.deleted
payload: |-
```ts
[{
{
id, // The ID of the product variant
}]
}
```
description: Emitted when product variants are deleted.
deprecated: false

4
www/apps/api-reference/specs/admin/paths/admin_regions.yaml
View File

@@ -687,9 +687,9 @@ post:
- name: region.created
payload: |-
```ts
[{
{
id, // The ID of the region
}]
}
```
description: Emitted when regions are created.
deprecated: false

8
www/apps/api-reference/specs/admin/paths/admin_regions_{id}.yaml
View File

@@ -138,9 +138,9 @@ post:
- name: region.updated
payload: |-
```ts
[{
{
id, // The ID of the region
}]
}
```
description: Emitted when regions are updated.
deprecated: false
@@ -214,9 +214,9 @@ delete:
- name: region.deleted
payload: |-
```ts
[{
{
id, // The ID of the region
}]
}
```
description: Emitted when regions are deleted.
deprecated: false

4
www/apps/api-reference/specs/admin/paths/admin_sales-channels.yaml
View File

@@ -725,9 +725,9 @@ post:
- name: sales-channel.created
payload: |-
```ts
[{
{
id, // The ID of the sales channel
}]
}
```
description: Emitted when sales channels are created.
deprecated: false

8
www/apps/api-reference/specs/admin/paths/admin_sales-channels_{id}.yaml
View File

@@ -138,9 +138,9 @@ post:
- name: sales-channel.updated
payload: |-
```ts
[{
{
id, // The ID of the sales channel
}]
}
```
description: Emitted when sales channels are updated.
deprecated: false
@@ -195,9 +195,9 @@ delete:
- name: sales-channel.deleted
payload: |-
```ts
[{
{
id, // The ID of the sales channel
}]
}
```
description: Emitted when sales channels are deleted.
deprecated: false

4
www/apps/api-reference/specs/admin/paths/admin_shipping-option-types.yaml
View File

@@ -674,9 +674,9 @@ post:
- 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

8
www/apps/api-reference/specs/admin/paths/admin_shipping-option-types_{id}.yaml
View File

@@ -143,9 +143,9 @@ post:
- 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
@@ -203,9 +203,9 @@ delete:
- 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

8
www/apps/api-reference/specs/admin/paths/admin_users_{id}.yaml
View File

@@ -136,9 +136,9 @@ post:
- name: user.updated
payload: |-
```ts
[{
{
id, // The ID of the user
}]
}
```
description: Emitted when users are updated.
deprecated: false
@@ -192,9 +192,9 @@ delete:
- name: user.deleted
payload: |-
```ts
[{
{
id, // The ID of the user
}]
}
```
description: Emitted when users are deleted.
deprecated: false