docs: updated event reference to align with v1.3.3 (#1796)
This commit is contained in:
@@ -96,6 +96,115 @@ Object of the following format:
|
|||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
|
<tr>
|
||||||
|
<td>
|
||||||
|
|
||||||
|
`batch.pre_processed`
|
||||||
|
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
|
||||||
|
Triggered after the `preProcessBatchJob` of a batch job stategy is done executing.
|
||||||
|
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
Object of the following format:
|
||||||
|
|
||||||
|
```js
|
||||||
|
{
|
||||||
|
id //string ID of batch job
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
|
||||||
|
<tr>
|
||||||
|
<td>
|
||||||
|
|
||||||
|
`batch.confirmed`
|
||||||
|
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
|
||||||
|
Triggered after the batch job is done pre-processing and the batch job is not in dry-run mode.
|
||||||
|
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
Object of the following format:
|
||||||
|
|
||||||
|
```js
|
||||||
|
{
|
||||||
|
id //string ID of batch job
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
|
||||||
|
<tr>
|
||||||
|
<td>
|
||||||
|
|
||||||
|
`batch.processing`
|
||||||
|
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
Triggered when a batch job starts processing after it's confirmed.
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
Object of the following format:
|
||||||
|
|
||||||
|
```js
|
||||||
|
{
|
||||||
|
id //string ID of batch job
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
|
||||||
|
<tr>
|
||||||
|
<td>
|
||||||
|
|
||||||
|
`batch.completed`
|
||||||
|
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
Triggered when a batch job is done processing and is completed.
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
Object of the following format:
|
||||||
|
|
||||||
|
```js
|
||||||
|
{
|
||||||
|
id //string ID of batch job
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
|
||||||
|
<tr>
|
||||||
|
<td>
|
||||||
|
|
||||||
|
`batch.failed`
|
||||||
|
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
Triggered when an error occurs while running a batch job and the batch job fails.
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
Object of the following format:
|
||||||
|
|
||||||
|
```js
|
||||||
|
{
|
||||||
|
id //string ID of batch job
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
@@ -167,7 +276,7 @@ Triggered when a cart and data associated with it (payment sessions, shipping me
|
|||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
|
|
||||||
The entire cart as an object. You can refer to the [Cart entity](https://github.com/medusajs/medusa/blob/master/packages/medusa/src/models/cart.ts) for an idea of what fields to expect.
|
An object with at least the ID of the cart, however, in most cases the entire cart model is available. You can refer to the [Cart entity](https://github.com/medusajs/medusa/blob/master/packages/medusa/src/models/cart.ts) for an idea of what fields to expect.
|
||||||
|
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
@@ -915,7 +1024,7 @@ Object of the following format:
|
|||||||
```js
|
```js
|
||||||
{
|
{
|
||||||
id, //string ID of order
|
id, //string ID of order
|
||||||
no_notification //boolean indicating whether a notification should be sent or not
|
no_notification //(optional) boolean indicating whether a notification should be sent or not
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -1145,7 +1254,7 @@ Object of the following format:
|
|||||||
{
|
{
|
||||||
id, //string ID of order
|
id, //string ID of order
|
||||||
return_id, //string ID of return
|
return_id, //string ID of return
|
||||||
no_notification //boolean indicating whether a notification should be sent or not
|
no_notification //(optional) boolean indicating whether a notification should be sent or not
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -1340,6 +1449,15 @@ Triggered when a product and data associated with it (options, variant orders, e
|
|||||||
|
|
||||||
The entire product passed as an object. You can refer to the [Product entity](https://github.com/medusajs/medusa/blob/master/packages/medusa/src/models/product.ts) for an idea of what fields to expect.
|
The entire product passed as an object. You can refer to the [Product entity](https://github.com/medusajs/medusa/blob/master/packages/medusa/src/models/product.ts) for an idea of what fields to expect.
|
||||||
|
|
||||||
|
In one case, when the `/admin/products/{id}` endpoint is used to update the product, the payload is an object of the following format:
|
||||||
|
|
||||||
|
```js
|
||||||
|
{
|
||||||
|
id, //id of product
|
||||||
|
field //an array of field names that were updated
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
@@ -1459,7 +1577,7 @@ Object of the following format:
|
|||||||
{
|
{
|
||||||
id, //string ID of variant
|
id, //string ID of variant
|
||||||
product_id, //string ID of product
|
product_id, //string ID of product
|
||||||
metadata //object of additional data
|
metadata //object of the `metadata` field of the variant
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user