ShopEazydevelopers
API referenceMerchant API BetaNotifications

The store's notification feed

Beta
Credentials
  • OAuth access token
Scopes
store:read
GET
/v1/merchant/stores/{storeId}/notifications

Access: OAuth scope store:read; not write-gated.

Paged: { items, nextCursor }, limit (default 30, at most 100) and an opaque cursor. It pages through the newest 100.

Authorization

merchantOAuth store:read
headerAuthorizationBearer <token>

OAuth 2.1 (authorization code + PKCE S256, public clients, dynamic registration) for connected AI apps. Effective power is scopes granted AND the person's role today AND the plan. orders:refund, billing:write and team:write are opt-in on the consent screen. Write implies read for marketing:read and messages:read, so a grant holding marketing:write passes a marketing:read check, and messages:send passes messages:read.

Scope: store:read

Path Parameters

storeId*string

A store the person can reach. Any other id answers 404, never 403.

Query Parameters

cursor?string

The nextCursor of the previous page, unchanged. A cursor that is not one we gave you is 400 bad_request.

limit?integer

Page size: default 30, at most 100 (more is 100; a missing or unusable value is 30).

Range1 <= value <= 100
Default30

Response Body

OK

application/json
  1. response
data*
Example Request
curl -X GET 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/notifications' \  -H 'Authorization: Bearer <access_token>'
Example Response
{  "data": {    "items": [      {        "id": "MRJybF23xZQngcOpWbt6",        "type": "member",        "title": "Membership revoked",        "body": "Thandi Mokoena · via API",        "href": "/members",        "createdAt": 1792924405314,        "read": false      },      {        "id": "IPyCgwZyp3hJWJRIWWqH",        "type": "member",        "title": "Membership approved",        "body": "Thandi Mokoena · via API",        "href": "/members",        "createdAt": 1792924404834,        "read": false      },      {        "id": "Dnv13UyYFjKZlgsZnCLV",        "type": "member",        "title": "New membership application",        "body": "Thandi Mokoena",        "href": "/members",        "createdAt": 1792924403861,        "read": false      }    ],    "nextCursor": null  }}