Notifications

Notifications

Search for notifications on a tenant

post

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/notifications/search

Search for notifications on a tenant

Required permissions: INTERNAL_PURCHASE_ORDER, PURCHASE_ORDER, RECEIVEMENT, RETURN_ORDER, SALES_ORDER, SERVICE_ORDER

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

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

Possible values:

Body

application/json

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

/tenants/{tenantUid}/notifications/search

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": "2026-02-12T19:52:07.498Z",
  "toDateTime": "2026-02-12T19:52:07.498Z",
  "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": "2026-02-12T19:52:07.498Z",
  "lastModifiedBy": "text",
  "lastModifiedAt": "2026-02-12T19:52:07.498Z"
}

List notifications for a store

get

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/stores/{storeUid}/notifications

List notifications for a store

Required permissions: INTERNAL_PURCHASE_ORDER, PURCHASE_ORDER, RECEIVEMENT, RETURN_ORDER, SALES_ORDER, SERVICE_ORDER

Authorizations

authTokenintegrationToken

AuthorizationstringRequired

Token received from the auth service

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

Possible values:

Responses

200

Example response

application/json

get

/tenants/{tenantUid}/stores/{storeUid}/notifications

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": "2026-02-12T19:52:07.498Z",
      "lastModifiedBy": "text",
      "lastModifiedAt": "2026-02-12T19:52:07.498Z"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Send notification to recipient

post

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/stores/{storeUid}/notifications

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.

Required permissions: INTERNAL_PURCHASE_ORDER, PURCHASE_ORDER, RECEIVEMENT, RETURN_ORDER, SALES_ORDER, SERVICE_ORDER

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

storeUidstringRequired

Reference to a Store.

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

Body

application/json

messageTypestring · enumRequiredPossible values:

recipientstringRequired

The recipient must be a valid phone number if the messageType is SMS, and a valid email if the messageType is EMAIL

subjectstringOptional

This is only valid for messageType EMAIL

messagestringOptional

The message that should be sent to the recipient

templateTypestringOptional

This must be a valid template type from the /metadata/templates endpoint

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

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

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

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

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

Responses

200

Example response

application/json

post

/tenants/{tenantUid}/stores/{storeUid}/notifications

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: 259

{
  "messageType": "EMAIL",
  "recipient": "text",
  "subject": "text",
  "message": "text",
  "templateType": "text",
  "templateData": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "notificationUid": "text",
  "customerUid": "text",
  "orderUid": "text",
  "purchaseOrderUid": "text",
  "receivementUid": "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": "2026-02-12T19:52:07.498Z",
  "lastModifiedBy": "text",
  "lastModifiedAt": "2026-02-12T19:52:07.498Z"
}