Merchant notifications

All routes require:

Authorization: Bearer mk_live_<your_key>

The caller must be able to access that store. A key with store scope SELECTED must include that store. Access mode FULL skips the scope list and still requires dashboard permission manageSettings. Access mode RESTRICTED must include notification:read and that same permission. This route exports GET only.

GET /api/merchant/v1/stores/{storeId}/notifications

Get notification settings

GET /api/merchant/v1/stores/{storeId}/notifications

Scope: notification:read. No body and no query parameters.

string

required

Store record id.

boolean

true when a Discord webhook URL is saved on the store.

string | null

null when no URL is saved. When one is saved, the value is the string [redacted].

object

One entry for every event id. Each entry is { "email": boolean, "discord": boolean }. With no saved config, email is true and discord is false for every id. A saved order.delivered entry is applied to order.completed when order.completed itself is absent. The response key is order.completed.

Show event ids

object

Order created.

object

Order completed.

object

Order pending.

object

Order undeliverable.

object

Product out of stock.

object

Low stock.

object

Feedback submitted.

object

Support ticket created.

object

Support ticket message.

{
  "hasDiscordWebhook": true,
  "discordWebhookUrl": "[redacted]",
  "events": {
    "order.created": { "email": true, "discord": false },
    "order.completed": { "email": true, "discord": true },
    "order.pending": { "email": true, "discord": false },
    "order.undeliverable": { "email": true, "discord": false },
    "inventory.out_of_stock": { "email": true, "discord": false },
    "inventory.low_stock": { "email": true, "discord": false },
    "review.added": { "email": true, "discord": false },
    "ticket.created": { "email": true, "discord": false },
    "ticket.response_added": { "email": true, "discord": false }
  }
}

curl https://dash.joinmarkt.com/api/merchant/v1/stores/STORE_ID/notifications \
  -H "Authorization: Bearer mk_live_<your_key>"

Errors

Failed responses use { "success": false, "error": "...", "code": "..." }. A 500 also includes errorId.

Status	Code	When
401	`UNAUTHORIZED`	Missing, invalid, or revoked token. `error` is `Unauthorized`. Expired keys use `API key expired`.
403	`FORBIDDEN`	Key cannot access this store, or `notification:read` / `manageSettings` is missing. `error` is `Forbidden`.
404	`NOT_FOUND`	`Store not found`
429	`RATE_LIMITED`	More than 120 requests in 60 seconds for this client IP, on the shared `merchant-api` bucket. The limit is checked before the key. `error` is `Too many requests`.
500	`INTERNAL_ERROR`	Unexpected failure. `error` is `Failed to load notifications`.

Get started

Analytics

Checkout

Dashboard

Merchant API

Merchant API playground

Orders

Public catalog

Reference

Webhooks

Get notification settings

Errors

​Get notification settings

​Errors

​Related

Get notification settings

Errors

Related