notification - JS SDK Admin Reference

This documentation provides a reference to the sdk.admin.notification set of methods used to send requests to Medusa's Admin API routes.

retrieve#

This method retrieves a notification's details. It sends a request to the Get Notification API route.

Example#

To retrieve a notification by its ID:

Code
1sdk.admin.notification.retrieve("notif_123")2.then(({ notification }) => {3  console.log(notification)4})

To specify the fields and relations to retrieve:

Code
1sdk.admin.notification.retrieve("notif_123", {2  fields: "id,to"3})4.then(({ notification }) => {5  console.log(notification)6})

Learn more about the fields property in the API reference.

Parameters#

Returns#

list#

This method retrieves a paginated list of notifications. It sends a request to the List Notifications API route.

Example#

To retrieve the list of notifications:

Code
1sdk.admin.notification.list()2.then(({ notifications, count, limit, offset }) => {3  console.log(notifications)4})

To configure the pagination, pass the limit and offset query parameters.

For example, to retrieve only 10 items and skip 10 items:

Code
1sdk.admin.notification.list({2  limit: 10,3  offset: 104})5.then(({ notifications, count, limit, offset }) => {6  console.log(notifications)7})

Using the fields query parameter, you can specify the fields and relations to retrieve in each notification:

Code
1sdk.admin.notification.list({2  fields: "id,to"3})4.then(({ notifications, count, limit, offset }) => {5  console.log(notifications)6})

Learn more about the fields property in the API reference.

Parameters#

Returns#