Medusa
Store APIAdmin API
Store APIAdmin API
Discord
Twitter
Linkedin
Github
  1. Notifications
  • Auth
    • Get Current User
      GET
    • User Logout
      DELETE
    • User Login
      POST
    • User Login (JWT)
      POST
  • Apps Oauth
    • Generate Token for App
      POST
    • List Applications
      GET
  • Batch Jobs
    • Cancel a Batch Job
      POST
    • Get a Batch Job
      GET
    • Confirm a Batch Job
      POST
    • List Batch Jobs
      GET
    • Create a Batch Job
      POST
  • Currencies
    • List Currency
      GET
    • Update a Currency
      POST
  • Customers
    • Create a Customer
      POST
    • List Customers
      GET
    • Update a Customer
      POST
    • Get a Customer
      GET
  • Customer Groups
    • Remove Customers from Group
      DELETE
    • Add Customers to Group
      POST
    • List Customers
      GET
    • Create a Customer Group
      POST
    • List Customer Groups
      GET
    • Get a Customer Group
      GET
    • Delete a Customer Group
      DELETE
    • Update a Customer Group
      POST
  • Discounts
    • Create a Condition
    • Create a Discount
    • List Discounts
    • Get a Condition
    • Update a Condition
    • Delete a Condition
    • Create a Dynamic Code
    • Remove Batch Resources
    • Add Batch Resources
    • Get Discount by Code
    • Delete a Dynamic Code
    • Add Region to Discount
    • Remove Region
    • Delete a Discount
    • Update a Discount
    • Get a Discount
  • Draft Orders
    • Create a Line Item
    • Delete a Line Item
    • Update a Line Item
    • Update a Draft Order
    • Delete a Draft Order
    • Get a Draft Order
    • Create a Draft Order
    • List Draft Orders
    • Mark Paid
  • Gift Cards
    • Create a Gift Card
    • List Gift Cards
    • Delete a Gift Card
    • Get a Gift Card
    • Update a Gift Card
  • Inventory Items
    • Create an Inventory Item
    • List Inventory Items
    • List Inventory Level
    • Create an Location Level
    • Update an Inventory Item
    • Get an Inventory Item
    • Delete an Inventory Item
    • Update a Location Level
    • Delete a Location Level
  • Invites
    • Lists Invites
    • Create an Invite
    • Delete an Invite
    • Accept an Invite
    • Resend an Invite
  • Notes
    • List Notes
    • Create a Note
    • Get a Note
    • Delete a Note
    • Update a Note
  • Notifications
    • Resend Notification
      POST
    • List Notifications
      GET
  • Orders
    • Create a Reservation
    • Cancel Claim's Fulfillment
    • Ship a Claim's Fulfillment
    • Cancel Swap's Fulfilmment
    • Get Order Reservations
    • Add a Shipping Method
    • Create a Refund
    • Get an Order
    • Update an Order
    • Create a Fulfillment
    • Cancel a Swap
    • List Orders
    • Create a Swap
    • Complete an Order
    • Create a Swap Fulfillment
    • Cancel a Claim
    • Process a Swap Payment
    • Ship a Fulfillment
    • Capture an Order's Payments
    • Archive Order
    • Update a Claim
    • Request a Return
    • Create a Claim Fulfillment
    • Ship a Swap's Fulfillment
    • Cancel a Fulfilmment
    • Create a Claim
    • Cancel an Order
  • Order Edits
    • Delete a Line Item Change
    • Add a Line Item
    • Upsert Line Item Change
    • Delete Line Item
    • Cancel an Order Edit
    • Delete an Order Edit
    • Get an Order Edit
    • Update an Order Edit
    • Request Confirmation
    • Create an OrderEdit
    • List Order Edits
    • Confirm an OrderEdit
  • Payments
    • Capture a Payment
    • Get Payment details
    • Refund Payment
  • Payment Collections
    • Delete a Payment Collection
    • Get a Payment Collection
    • Update Payment Collection
    • Mark Authorized
  • Product Collections
    • Add Products to Collection
    • Remove Products from Collection
    • Get a Collection
    • Update a Collection
    • Delete a Collection
    • List Collections
    • Create a Collection
  • Product Tags
    • List Product Tags
  • Product Types
    • List Product Types
  • Product Variants
    • Get Variant's Inventory
    • List Product Variants
    • Get a Product variant
  • Price Lists
    • Delete a Product's Prices
    • List Products
    • Delete a Variant's Prices
    • Get a Price List
    • Update a Price List
    • Delete a Price List
    • Add or Update Prices
    • Delete Prices
    • Create a Price List
    • List Price Lists
  • Products
    • List Product Types
    • List Tags Usage Number
    • List a Product's Variants
    • Create a Product Variant
    • Update a Product Variant
    • Delete a Product Variant
    • Add a Product Option
    • Set Metadata
    • Delete a Product Option
    • Update a Product Option
    • List Products
    • Create a Product
    • Delete a Product
    • Update a Product
    • Get a Product
  • Product Categories
    • Create a Product Category
    • List Product Categories
    • Update a Product Category
    • Delete a Product Category
    • Get a Product Category
    • Add Products to a Category
    • Remove Products from Category
  • Publishable Api Keys
    • List Sales Channels
    • Delete Publishable API Key
    • Get a Publishable API Key
    • Revoke a Publishable API Key
    • Remove Sales Channels
    • Add Sales Channels
    • Update Publishable API Key
    • List Publishable API keys
    • Create Publishable API Key
  • Reservations
    • Delete a Reservation
    • Update a Reservation
    • Get a Reservation
    • Create a Reservation
    • List Reservations
  • Regions
    • List Fulfillment Options
    • Add Country
    • Remove Fulfillment Provider
    • Remove Payment Provider
    • Add Payment Provider
    • Delete a Region
    • Update a Region
    • Get a Region
    • List Regions
    • Create a Region
    • Add Fulfillment Provider
    • Remove Country
  • Return Reasons
    • Get a Return Reason
    • Delete a Return Reason
    • Update a Return Reason
    • List Return Reasons
    • Create a Return Reason
  • Returns
    • Receive a Return
    • List Returns
    • Cancel a Return
  • Sales Channels
    • Remove Stock Location from Sales Channels.
    • Associate a Stock Location
    • Get a Sales Channel
    • Delete a Sales Channel
    • Update a Sales Channel
    • Remove Products from Sales Channel
    • Add Products to Sales Channel
    • Create a Sales Channel
    • List Sales Channels
  • Shipping Options
    • Update Shipping Option
    • Get a Shipping Option
    • Delete Shipping Option
    • List Shipping Options
    • Create Shipping Option
  • Shipping Profiles
    • List Shipping Profiles
    • Create a Shipping Profile
    • Delete a Shipping Profile
    • Update a Shipping Profile
    • Get a Shipping Profile
  • Stock Locations
    • Get a Stock Location
    • List Stock Locations
    • Create a Stock Location
    • Update a Stock Location
    • Delete a Stock Location
  • Store
    • List Payment Providers
    • Add a Currency Code
    • Remove a Currency
    • List Tax Providers
    • Update Store Details
    • Get Store details
  • Swaps
    • Get a Swap
    • List Swaps
  • Uploads
    • Upload Files
    • Delete an Uploaded File
    • Get a File's Download URL
    • Protected File Upload
  • Tax Rates
    • Add to Shipping Options
    • Remove Shipping Options from Rate
    • Create a Tax Rate
    • List Tax Rates
    • Add to Products
    • Remove Products from Rate
    • Delete a Tax Rate
    • Get a Tax Rate
    • Update a Tax Rate
    • Add to Product Types
    • Remove Product Types from Rate
  • Users
    • Reset Password
    • Request Password Reset
    • Get a User
    • Delete a User
    • Update a User
    • Create a User
    • List Users
  1. Notifications

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 Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET '{{BASE_URL}}/admin/notifications'
Response 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.
to
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
id
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
to
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
Previous
Resend Notification
Next
Create a Reservation
Built with