تاجر جني
Which API?
Merchant API For merchants: manage your own catalogue, orders and finances through the v2 Third-Party API. Application API For partner apps: browse Gini merchants and products, send customers to checkout and follow their orders.

New: Application API docs

Pick the API you are reading here — the Merchant API for your own store, the Application API for partner apps.

Merchant dashboard
API reference
Notifications

API documentation

Everything you need to integrate with the Gini v2 Third-Party API.

Getting started API reference Store API Finance API Settings API Insights API Wholesale API Resources
Profile Categories Products Attributes Product Variants Product Add-ons Discounts Orders Abandoned carts Reviews Notifications Collections Reels Influencers Exports Webhooks

Notifications

Your store's notification feed — the dashboard's notifications screen. Read the feed, count unread, mark read, and delete. Notifications are system-generated, so there is no create.

List notifications

Your notifications, newest first. Each returns id, type, the raw event data payload, read state and timestamps. Paginated.

GET /api/v2.0/third-party/notifications
Signed
Query parameters
Field Type Required Description
type string Optional Filter chip: all (default), unread, orders, stock, exports, errors.
search string Optional Free-text match across the notification payload.
per_page integer Optional Page size, default 20.
Notes
  • The type buckets are the same ones the dashboard's chips use, so ?type=orders returns exactly the Orders chip.
  • data is the raw event payload (order ids, export links, stock figures) — act on it rather than the dashboard's presentation.
Unread count

The number of unread notifications — the bell badge.

GET /api/v2.0/third-party/notifications/unread-count
Signed
Mark all read

Marks every unread notification read; returns how many were changed.

POST /api/v2.0/third-party/notifications/read-all
Signed
Mark one read

Marks a single notification read by its id. 404 if it is not yours.

POST /api/v2.0/third-party/notifications/{notification}/read
Signed
Delete

Removes a notification (and any report file attached to it). 404 if it is not yours.

DELETE /api/v2.0/third-party/notifications/{notification}
Signed
Mark several read

Mark a chosen set of notifications read in one call. Send an ids array of notification ids.

POST /api/v2.0/third-party/notifications/read
Signed
Delete several

Delete a chosen set of notifications (and their attached files) in one call. Send an ids array.

DELETE /api/v2.0/third-party/notifications
Signed
Previous Reviews Next Collections