Notifications

Notifications

Search for notifications on a tenant

post

Search for notifications on a tenant

Authorizations

accessTokenauthTokenintegrationToken

Path parameters

tenantUidstringrequired

Reference to a tenant.

Pattern: ^[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

ENUM	Description
ASC	Sort in ascending order
DESC	Sort in descending order

Available options:

Body

messageTypestring · enumoptionalAvailable options:

recipientstringoptional

messagestringoptional

statestring · enumoptionalAvailable options:

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

application/json

objectoptional

post

HTTPcURLJavaScriptPython

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-04-18T01:27:37.225Z",
  "toDateTime": "2025-04-18T01:27:37.225Z",
  "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-04-18T01:27:37.225Z",
  "lastModifiedBy": "text",
  "lastModifiedAt": "2025-04-18T01:27:37.225Z"
}

List notifications for a store

get

List notifications for a store

Authorizations

authTokenintegrationToken

Path parameters

tenantUidstringrequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

storeUidstringrequired

Reference to a Store.

Pattern: ^[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

ENUM	Description
ASC	Sort in ascending order
DESC	Sort in descending order

Available options:

Responses

application/json

objectoptional

get

HTTPcURLJavaScriptPython

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-04-18T01:27:37.225Z",
      "lastModifiedBy": "text",
      "lastModifiedAt": "2025-04-18T01:27:37.225Z"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Send notification to recipient

post

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

accessTokenauthTokenintegrationToken

Path parameters

tenantUidstringrequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

storeUidstringrequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+

Body

messageTypestring · enumrequiredAvailable options:

recipientstringrequired

subjectstringoptional

messagestringrequired

notificationUidstringoptionalPattern: ^[A-Za-z0-9-_]+

customerUidstringoptionalPattern: ^[A-Za-z0-9-_]+

orderUidstringoptionalPattern: ^[A-Za-z0-9-_]+

purchaseOrderUidstringoptionalPattern: ^[A-Za-z0-9-_]+

Responses

application/json

objectoptional

post

HTTPcURLJavaScriptPython

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-04-18T01:27:37.225Z",
  "lastModifiedBy": "text",
  "lastModifiedAt": "2025-04-18T01:27:37.225Z"
}