List Notifications

GET

/admin/notifications

Notifications

Retrieve a list of notifications. The notifications can be filtered by fields such as event_name or resource_type. The notifications can also be paginated.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.medusa-commerce.com/admin/notifications'

Response Example

200 - Example 1

{
  "count": 0,
  "offset": 0,
  "limit": 0,
  "notifications": [
    {
      "id": "noti_01G53V9Y6CKMCGBM1P0X7C28RX",
      "event_name": "order.placed",
      "resource_type": "order",
      "resource_id": "order_01G8TJSYT9M6AVS5N4EMNFS1EK",
      "customer_id": "cus_01G2SG30J8C85S4A5CHM2S1NS2",
      "to": "user@example.com",
      "parent_id": "noti_01G53V9Y6CKMCGBM1P0X7C28RX",
      "parent_notification": {},
      "provider_id": "sengrid",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "data": {},
      "resends": [
        {}
      ],
      "provider": {
        "id": "sendgrid",
        "is_installed": true
      },
      "customer": {
        "id": "cus_01G2SG30J8C85S4A5CHM2S1NS2",
        "email": "user@example.com",
        "first_name": "Arno",
        "last_name": "Willms",
        "billing_address_id": "addr_01G8ZH853YPY9B94857DY91YGW",
        "phone": 16128234334802,
        "has_account": false,
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z",
        "deleted_at": "2019-08-24T14:15:22Z",
        "orders": [
          {}
        ],
        "metadata": {
          "car": "white"
        },
        "groups": [
          {
            "id": "cgrp_01G8ZH853Y6TFXWPG5EYE81X63",
            "name": "VIP",
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z",
            "deleted_at": "2019-08-24T14:15:22Z",
            "customers": [
              {}
            ],
            "price_lists": [
              {}
            ],
            "metadata": {
              "car": "white"
            }
          }
        ],
        "billing_address": {
          "id": "addr_01G8ZC9VS1XVE149MGH2J7QSSH",
          "customer_id": "cus_01G2SG30J8C85S4A5CHM2S1NS2",
          "customer": {},
          "company": "Acme",
          "first_name": "Arno",
          "last_name": "Willms",
          "address_1": "14433 Kemmer Court",
          "address_2": "Suite 369",
          "city": "South Geoffreyview",
          "province": "Kentucky",
          "postal_code": 72093,
          "phone": 16128234334802,
          "created_at": "2019-08-24T14:15:22Z",
          "updated_at": "2019-08-24T14:15:22Z",
          "deleted_at": "2019-08-24T14:15:22Z",
          "country_code": "st",
          "metadata": {
            "car": "white"
          },
          "country": {
            "id": 109,
            "name": "ITALY",
            "display_name": "Italy",
            "region_id": "reg_01G1G5V26T9H8Y0M4JNE3YGA4G",
            "region": {},
            "iso_2": "it",
            "iso_3": "ita",
            "num_code": 380
          }
        },
        "shipping_addresses": [
          {
            "id": "addr_01G8ZC9VS1XVE149MGH2J7QSSH",
            "customer_id": "cus_01G2SG30J8C85S4A5CHM2S1NS2",
            "customer": {},
            "company": "Acme",
            "first_name": "Arno",
            "last_name": "Willms",
            "address_1": "14433 Kemmer Court",
            "address_2": "Suite 369",
            "city": "South Geoffreyview",
            "province": "Kentucky",
            "postal_code": 72093,
            "phone": 16128234334802,
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z",
            "deleted_at": "2019-08-24T14:15:22Z",
            "country_code": "st",
            "metadata": {
              "car": "white"
            },
            "country": {
              "id": 109,
              "name": "ITALY",
              "display_name": "Italy",
              "region_id": "reg_01G1G5V26T9H8Y0M4JNE3YGA4G",
              "region": {},
              "iso_2": "it",
              "iso_3": "ita",
              "num_code": 380
            }
          }
        ]
      }
    }
  ]
}

Request

Query Params

offset

integer

optional

The number of inventory items to skip when retrieving the inventory items.

limit

integer

optional

Limit the number of notifications returned.

fields

string

optional

Comma-separated fields that should be included in each returned notification.

expand

string

optional

Comma-separated relations that should be expanded in each returned notification.

event_name

string

optional

Filter by the name of the event that triggered sending this notification.

resource_type

string

optional

Filter by the resource type.

resource_id

string

optional

Filter by the resource ID.

string

optional

Filter by the address that the Notification was sent to. This will usually be an email address, but it can also represent other addresses such as a chat bot user id.

include_resends

string

optional

A boolean indicating whether the result set should include resent notifications or not

Responses

🟢200OK

application/json

Body

count

integer

optional

The total number of notifications

offset

integer

optional

The number of notifications skipped when retrieving the notifications.

limit

integer

optional

The number of notifications per page

notifications

array[object (Notification) {15}]

required

an array of notifications

string

required

The notification's ID

Example:

noti_01G53V9Y6CKMCGBM1P0X7C28RX

event_name

string | null

required

The name of the event that the notification was sent for.

Example:

order.placed

resource_type

string

required

The type of resource that the Notification refers to.

Example:

order

resource_id

string

required

The ID of the resource that the Notification refers to.

Example:

order_01G8TJSYT9M6AVS5N4EMNFS1EK

customer_id

string | null

required

The ID of the customer that this notification was sent to.

Example:

cus_01G2SG30J8C85S4A5CHM2S1NS2

string

required

The address that the Notification was sent to. This will usually be an email address, but can represent other addresses such as a chat bot user ID.

Example:

user@example.com

parent_id

string | null

required

The notification's parent ID

Example:

noti_01G53V9Y6CKMCGBM1P0X7C28RX

parent_notification

object | null

optional

The details of the parent notification.

provider_id

string | null

required

The ID of the notification provider used to send the notification.

Example:

sengrid

created_at

string <date-time>

required

The date with timezone at which the resource was created.

updated_at

string <date-time>

required

The date with timezone at which the resource was updated.

data

object

required

The data that the Notification was sent with. This contains all the data necessary for the Notification Provider to initiate a resend.

Example:

{}

resends

array [object]

optional

The details of all resends of the notification.

provider

object (Notification Provider)

optional

A notification provider represents a notification service installed in the Medusa backend, either through a plugin or backend customizations. It holds the notification service's installation status.

customer

object (Customer)

optional

A customer can make purchases in your store and manage their profile.

🟠400Client Error or Multiple Errors

🟠401User is not authorized. Must log in first

🟠404Not Found Error

🟠409Invalid State Error

🟠422Invalid Request Error

🔴500Server Error

Modified at 2023-10-10 11:56:36

Resend Notification

Create a Reservation