Notifications
Notifications
Search for notifications on a tenant
Authorizations
Path parameters
tenantUidstringRequiredPattern:
Reference to a tenant.
^[A-Za-z0-9-_]+Query parameters
pageSizeintegerOptional
The number of items per page in a result set.
pageNumberintegerOptional
Reference to a specific page in a result set.
sortBystringOptional
Defines which field the resource list is sorted by.
sortDirectionstring · enumOptional
Possible values:
| ENUM | Description |
|---|---|
| ASC | Sort in ascending order |
| DESC | Sort in descending order |
Body
messageTypestring · enumOptionalPossible values:
recipientstringOptional
messagestringOptional
statestring · enumOptionalPossible values:
errorTextstringOptional
organizationUidstringOptionalPattern:
^[A-Za-z0-9-_]+storeUidstringOptionalPattern:
^[A-Za-z0-9-_]+customerUidstringOptionalPattern:
^[A-Za-z0-9-_]+orderUidstringOptionalPattern:
^[A-Za-z0-9-_]+serviceOrderUidstringOptionalPattern:
^[A-Za-z0-9-_]+tenantUserUidstringOptionalPattern:
^[A-Za-z0-9-_]+supplierUidstringOptionalPattern:
^[A-Za-z0-9-_]+receivementUidstringOptionalPattern:
^[A-Za-z0-9-_]+purchaseOrderUidstringOptionalPattern:
^[A-Za-z0-9-_]+fromDateTimestring · date-timeOptional
toDateTimestring · date-timeOptional
querystringOptional
Generic search. Searches both in messages an in recipient
Responses
200
Example response
application/json
post
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-07-30T17:50:52.192Z",
"toDateTime": "2025-07-30T17:50:52.192Z",
"query": "text"
}200
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-07-30T17:50:52.192Z",
"lastModifiedBy": "text",
"lastModifiedAt": "2025-07-30T17:50:52.192Z"
}List notifications for a store
Authorizations
Path parameters
tenantUidstringRequiredPattern:
Reference to a tenant.
^[A-Za-z0-9-_]+storeUidstringRequiredPattern:
Reference to a Store.
^[A-Za-z0-9-_]+Query parameters
pageSizeintegerOptional
The number of items per page in a result set.
pageNumberintegerOptional
Reference to a specific page in a result set.
sortBystringOptional
Defines which field the resource list is sorted by.
sortDirectionstring · enumOptional
Possible values:
| ENUM | Description |
|---|---|
| ASC | Sort in ascending order |
| DESC | Sort in descending order |
Responses
200
Example response
application/json
get
GET /v2/tenants/{tenantUid}/stores/{storeUid}/notifications HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
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-07-30T17:50:52.192Z",
"lastModifiedBy": "text",
"lastModifiedAt": "2025-07-30T17:50:52.192Z"
}
],
"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.
Authorizations
Path parameters
tenantUidstringRequiredPattern:
Reference to a tenant.
^[A-Za-z0-9-_]+storeUidstringRequiredPattern:
Reference to a Store.
^[A-Za-z0-9-_]+Body
messageTypestring · enumRequiredPossible values:
recipientstringRequired
subjectstringOptional
messagestringRequired
notificationUidstringOptionalPattern:
^[A-Za-z0-9-_]+customerUidstringOptionalPattern:
^[A-Za-z0-9-_]+orderUidstringOptionalPattern:
^[A-Za-z0-9-_]+purchaseOrderUidstringOptionalPattern:
^[A-Za-z0-9-_]+Responses
200
Example response
application/json
post
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: 166
{
"messageType": "EMAIL",
"recipient": "text",
"subject": "text",
"message": "text",
"notificationUid": "text",
"customerUid": "text",
"orderUid": "text",
"purchaseOrderUid": "text"
}200
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-07-30T17:50:52.192Z",
"lastModifiedBy": "text",
"lastModifiedAt": "2025-07-30T17:50:52.192Z"
}Was this helpful?