Notifications
Notifications
Search for notifications on a tenant
Reference to a tenant.
^[A-Za-z0-9-_]+The number of items per page in a result set.
Reference to a specific page in a result set.
Defines which field the resource list is sorted by.
| ENUM | Description |
|---|---|
| ASC | Sort in ascending order |
| DESC | Sort in descending order |
^[A-Za-z0-9-_]+^[A-Za-z0-9-_]+^[A-Za-z0-9-_]+^[A-Za-z0-9-_]+^[A-Za-z0-9-_]+^[A-Za-z0-9-_]+^[A-Za-z0-9-_]+^[A-Za-z0-9-_]+^[A-Za-z0-9-_]+Generic search. Searches both in messages an in recipient
Example response
POST /v2/tenants/{tenantUid}/notifications/search HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 398
{
"messageType": "EMAIL",
"recipient": "text",
"message": "text",
"state": "NOT_STARTED",
"errorText": "text",
"organizationUid": "text",
"storeUid": "text",
"customerUid": "text",
"orderUid": "text",
"serviceOrderUid": "text",
"tenantUserUid": "text",
"supplierUid": "text",
"receivementUid": "text",
"purchaseOrderUid": "text",
"fromDateTime": "2025-10-30T21:17:15.896Z",
"toDateTime": "2025-10-30T21:17:15.896Z",
"query": "text"
}Example response
{
"messageType": "EMAIL",
"recipient": "text",
"message": "text",
"subject": "text",
"state": "NOT_STARTED",
"errorText": "text",
"notificationUid": "text",
"customerUid": "text",
"orderUid": "text",
"serviceOrderUid": "text",
"serviceEventUid": "text",
"tenantUserUid": "text",
"supplierUid": "text",
"receivementUid": "text",
"purchaseOrderUid": "text",
"createdBy": "text",
"createdAt": "2025-10-30T21:17:15.896Z",
"lastModifiedBy": "text",
"lastModifiedAt": "2025-10-30T21:17:15.896Z"
}List notifications for a store
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a Store.
^[A-Za-z0-9-_]+The number of items per page in a result set.
Reference to a specific page in a result set.
Defines which field the resource list is sorted by.
| ENUM | Description |
|---|---|
| ASC | Sort in ascending order |
| DESC | Sort in descending order |
Example response
GET /v2/tenants/{tenantUid}/stores/{storeUid}/notifications HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Example response
{
"items": [
{
"messageType": "EMAIL",
"recipient": "text",
"message": "text",
"subject": "text",
"state": "NOT_STARTED",
"errorText": "text",
"notificationUid": "text",
"customerUid": "text",
"orderUid": "text",
"serviceOrderUid": "text",
"serviceEventUid": "text",
"tenantUserUid": "text",
"supplierUid": "text",
"receivementUid": "text",
"purchaseOrderUid": "text",
"createdBy": "text",
"createdAt": "2025-10-30T21:17:15.896Z",
"lastModifiedBy": "text",
"lastModifiedAt": "2025-10-30T21:17:15.896Z"
}
],
"paging": {
"pageNumber": 1,
"pageSize": 1,
"totalCount": 1
}
}Send notification to recipient. If any of the optional fields customerUid, orderUid and serviceOrderUid is given in request, the ids MUST refer to an existing uid in the flow database.
Either message-field or templateType field must be included in the request. If both are supplied, the content from the message-field will be used.
Suppling a templateType can require the field customerUid or orderUid to be included as well.
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a Store.
^[A-Za-z0-9-_]+The recipient must be a valid phone number
if the messageType is SMS,
and a valid email if the messageType is EMAIL
This is only valid for messageType EMAIL
The message that should be sent to the recipient
This must be a valid template type from the /metadata/templates endpoint
^[A-Za-z0-9-_]+^[A-Za-z0-9-_]+^[A-Za-z0-9-_]+^[A-Za-z0-9-_]+Example response
POST /v2/tenants/{tenantUid}/stores/{storeUid}/notifications HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 188
{
"messageType": "EMAIL",
"recipient": "text",
"subject": "text",
"message": "text",
"templateType": "text",
"notificationUid": "text",
"customerUid": "text",
"orderUid": "text",
"purchaseOrderUid": "text"
}Example response
{
"messageType": "EMAIL",
"recipient": "text",
"message": "text",
"subject": "text",
"state": "NOT_STARTED",
"errorText": "text",
"notificationUid": "text",
"customerUid": "text",
"orderUid": "text",
"serviceOrderUid": "text",
"serviceEventUid": "text",
"tenantUserUid": "text",
"supplierUid": "text",
"receivementUid": "text",
"purchaseOrderUid": "text",
"createdBy": "text",
"createdAt": "2025-10-30T21:17:15.896Z",
"lastModifiedBy": "text",
"lastModifiedAt": "2025-10-30T21:17:15.896Z"
}Last updated