Notifications

scope: notifications

A unified feed of actionable items and activity across your organization. Pull notifications into your dashboard to stay on top of unpaid invoices, shipment updates, and system alerts.

Endpoints

GET

/v0/notifications

Get notifications — unified feed of actionable items and activity

Notification Types

Notifications are aggregated from multiple sources across the system. Each notification has a type indicating its source.

Type	Source	Examples
`invoice`	Unpaid and overdue invoices	Unpaid invoice, overdue invoice, invoice in collections
`shipment`	Shipment status changes and history	Shipment submitted, shipment forwarded, cancellation confirmed
`system`	Platform announcements and alerts	Maintenance windows, API changes, new features

Severity Levels

Each notification has a severity indicating how urgently it needs attention.

Severity	Meaning
`info`	Informational update — no action needed. Examples: shipment status changes, activity log.
`warning`	Needs attention soon. Examples: unpaid invoices approaching due date.
`action_required`	Immediate action needed. Examples: overdue invoices, invoices in collections.

Get Notifications

Returns a unified feed sorted by most recent first. Use query parameters to filter by notification type or severity level.

Query Parameters

Parameter	Type	Description
`type`	string	Filter by type: invoice, shipment, system
`severity`	string	Filter by severity: info, warning, action_required
`skip`	number	Number of records to skip (default: 0)
`take`	number	Number of records to return (default: 10, max: 10)

GET /v0/notifications?severity=action_required

[
  {
    "id": "invoice-5",
    "type": "invoice",
    "severity": "action_required",
    "title": "Overdue invoice: Outbound Shipment #22",
    "message": "Invoice for $17.50 was due on 2026-03-01. Please pay as soon as possible.",
    "resourceType": "invoice",
    "resourceId": "5",
    "createdAt": "2026-02-25T10:00:00.000Z"
  }
]

GET /v0/notifications?type=shipment

[
  {
    "id": "shipment-history-142",
    "type": "shipment",
    "severity": "info",
    "title": "Shipment #22 update",
    "message": "Shipment status changed to forwarded",
    "resourceType": "shipment",
    "resourceId": "22",
    "createdAt": "2026-03-04T14:30:00.000Z"
  },
  {
    "id": "shipment-history-140",
    "type": "shipment",
    "severity": "info",
    "title": "Shipment #22 update",
    "message": "Shipment submitted by customer",
    "resourceType": "shipment",
    "resourceId": "22",
    "createdAt": "2026-03-04T10:05:00.000Z"
  }
]

Response Fields

Parameter	Type	Description
`id`*	string	Unique notification ID (prefixed by source, e.g. invoice-5, shipment-history-142)
`type`*	enum	Notification category: invoice, shipment, system
`severity`*	enum	Severity: info, warning, action_required
`title`*	string	Short summary of the notification
`message`*	string	Detailed message with context
`resourceType`	string	Type of the linked resource (invoice, shipment) — use to deep-link in your UI
`resourceId`	string	ID of the linked resource — fetch full details via the corresponding API
`createdAt`*	ISO 8601	When the notification was generated

Error Responses

401Unauthorized

Missing or invalid access token. See Authentication.

403Missing required scope: notifications

Your OAuth token does not have the notifications scope.

Expanding over time

The notifications feed will grow to include more sources as new features are added to the platform — such as low stock alerts, support ticket updates, and system maintenance notices. The response shape will remain stable, with new type values added as needed.

Invoices

Recommendations