User

User

Get full account info

get

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

/account

Get full account information for a logged-in user. This will return information for all tenants the user has access to.

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Responses

200

User account response

application/json

globalRolesstring[]Required

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

get/account

HTTPcURLJavaScriptPython

GET /v2/account HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

User account response

{
  "globalRoles": [
    "text"
  ],
  "defaultTenantUid": "text",
  "tenants": [
    {
      "accountType": "FULL",
      "createdAt": "2026-07-16T14:18:41.110Z",
      "defaultStoreUid": "text",
      "displayName": "text",
      "email": "text",
      "externalId": "text",
      "firstname": "text",
      "lastAccessed": "2026-07-16T14:18:41.110Z",
      "lastModifiedAt": "2026-07-16T14:18:41.110Z",
      "lastname": "text",
      "mobile": "text",
      "status": "PENDING_INVITE",
      "storeAccess": [
        {
          "createdAt": "2026-07-16T14:18:41.110Z",
          "lastModifiedAt": "2026-07-16T14:18:41.110Z",
          "storeAccessUid": "text",
          "storeUid": "text",
          "storeRole": "ADMIN"
        }
      ],
      "tenantUid": "text",
      "tenantName": "text",
      "tenantRole": "ACCESS",
      "tenantUserUid": "text",
      "userCode": "text",
      "languageCode": "text",
      "permissions": {
        "tenant": [
          "text"
        ],
        "stores": [
          {
            "store": {
              "name": "text",
              "storeUid": "text",
              "organizationUid": "text",
              "organizationName": "text"
            },
            "permissions": [
              "text"
            ]
          }
        ],
        "organizations": [
          {
            "organization": {
              "name": "text",
              "organizationUid": "text"
            },
            "permissions": [
              "text"
            ]
          }
        ]
      }
    }
  ]
}

Login user

post

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

/account

Login as a tenant user

Requires a valid deviceToken

Authorizations

deviceToken

AuthorizationstringRequired

The devicetoken is only used for to attach devices and tie it to a tenant

Body

application/json

passwordstringRequired

userCodestringRequired

Responses

200

Example response

application/json

accessTokenstringRequired

post/account

HTTPcURLJavaScriptPython

POST /v2/account HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 37

{
  "password": "text",
  "userCode": "text"
}

200

Example response

{
  "accessToken": "text",
  "tenantUser": {
    "accountType": "FULL",
    "createdAt": "2026-07-16T14:18:41.110Z",
    "defaultStoreUid": "text",
    "displayName": "text",
    "email": "text",
    "externalId": "text",
    "firstname": "text",
    "lastAccessed": "2026-07-16T14:18:41.110Z",
    "lastModifiedAt": "2026-07-16T14:18:41.110Z",
    "lastname": "text",
    "mobile": "text",
    "status": "PENDING_INVITE",
    "storeAccess": [
      {
        "createdAt": "2026-07-16T14:18:41.110Z",
        "lastModifiedAt": "2026-07-16T14:18:41.110Z",
        "storeAccessUid": "text",
        "storeUid": "text",
        "storeRole": "ADMIN"
      }
    ],
    "tenantUid": "text",
    "tenantName": "text",
    "tenantRole": "ACCESS",
    "tenantUserUid": "text",
    "userCode": "text",
    "languageCode": "text",
    "permissions": {
      "tenant": [
        "text"
      ],
      "stores": [
        {
          "store": {
            "name": "text",
            "storeUid": "text",
            "organizationUid": "text",
            "organizationName": "text"
          },
          "permissions": [
            "text"
          ]
        }
      ],
      "organizations": [
        {
          "organization": {
            "name": "text",
            "organizationUid": "text"
          },
          "permissions": [
            "text"
          ]
        }
      ]
    }
  }
}

Update global account information

put

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

/account

Update global information about logged in user

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Body

application/json

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

Responses

200

User account response

application/json

globalRolesstring[]Required

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

put/account

HTTPcURLJavaScriptPython

PUT /v2/account HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 27

{
  "defaultTenantUid": "text"
}

200

User account response

{
  "globalRoles": [
    "text"
  ],
  "defaultTenantUid": "text",
  "tenants": [
    {
      "accountType": "FULL",
      "createdAt": "2026-07-16T14:18:41.110Z",
      "defaultStoreUid": "text",
      "displayName": "text",
      "email": "text",
      "externalId": "text",
      "firstname": "text",
      "lastAccessed": "2026-07-16T14:18:41.110Z",
      "lastModifiedAt": "2026-07-16T14:18:41.110Z",
      "lastname": "text",
      "mobile": "text",
      "status": "PENDING_INVITE",
      "storeAccess": [
        {
          "createdAt": "2026-07-16T14:18:41.110Z",
          "lastModifiedAt": "2026-07-16T14:18:41.110Z",
          "storeAccessUid": "text",
          "storeUid": "text",
          "storeRole": "ADMIN"
        }
      ],
      "tenantUid": "text",
      "tenantName": "text",
      "tenantRole": "ACCESS",
      "tenantUserUid": "text",
      "userCode": "text",
      "languageCode": "text",
      "permissions": {
        "tenant": [
          "text"
        ],
        "stores": [
          {
            "store": {
              "name": "text",
              "storeUid": "text",
              "organizationUid": "text",
              "organizationName": "text"
            },
            "permissions": [
              "text"
            ]
          }
        ],
        "organizations": [
          {
            "organization": {
              "name": "text",
              "organizationUid": "text"
            },
            "permissions": [
              "text"
            ]
          }
        ]
      }
    }
  ]
}

Get account info for a specific tenant

get

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

/tenants/{tenantUid}/account

Get tenant information about logged-in user

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

Responses

200

Tenant user respose

application/json

accountTypestring · enumRequired

ENUM	Description
FULL	Access to backoffice and onboarding of new devices
REGULAR	Can only login to already onboarded devices
SUPPORT	Support account
INTEGRATION	Computer integration account

Possible values:

createdAtstring · date-timeRequired

defaultStoreUidstringOptionalPattern: ^[A-Za-z0-9-_]*

displayNamestringRequired

emailstringRequired

externalIdstringRequired

firstnamestringRequired

lastAccessedstring · date-timeRequired

lastModifiedAtstring · date-timeRequired

lastnamestringRequired

mobilestringRequired

statusstring · enumRequiredPossible values:

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

tenantNamestringRequired

tenantRolestring · enumRequired

ENUM	Description
BLOCKED	Blocked from this tenant
ACCESS	Only access to the tenant.
ADMIN	Tenant admin, allow full access to tenant and can add users and new stores.
BACKOFFICE	Access to product, pricelists, etc.

Possible values:

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

userCodestringRequired

languageCodestringRequired

ISO 639-1 code for language

get/tenants/{tenantUid}/account

HTTPcURLJavaScriptPython

GET /v2/tenants/{tenantUid}/account HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Tenant user respose

{
  "accountType": "FULL",
  "createdAt": "2026-07-16T14:18:41.110Z",
  "defaultStoreUid": "text",
  "displayName": "text",
  "email": "text",
  "externalId": "text",
  "firstname": "text",
  "lastAccessed": "2026-07-16T14:18:41.110Z",
  "lastModifiedAt": "2026-07-16T14:18:41.110Z",
  "lastname": "text",
  "mobile": "text",
  "status": "PENDING_INVITE",
  "storeAccess": [
    {
      "createdAt": "2026-07-16T14:18:41.110Z",
      "lastModifiedAt": "2026-07-16T14:18:41.110Z",
      "storeAccessUid": "text",
      "storeUid": "text",
      "storeRole": "ADMIN"
    }
  ],
  "tenantUid": "text",
  "tenantName": "text",
  "tenantRole": "ACCESS",
  "tenantUserUid": "text",
  "userCode": "text",
  "languageCode": "text",
  "permissions": {
    "tenant": [
      "text"
    ],
    "stores": [
      {
        "store": {
          "name": "text",
          "storeUid": "text",
          "organizationUid": "text",
          "organizationName": "text"
        },
        "permissions": [
          "text"
        ]
      }
    ],
    "organizations": [
      {
        "organization": {
          "name": "text",
          "organizationUid": "text"
        },
        "permissions": [
          "text"
        ]
      }
    ]
  }
}

Generate accessToken from authToken

post

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

/tenants/{tenantUid}/account

Generate access token from auth token

Authorizations

authToken

AuthorizationstringRequired

Token received from the auth service

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

Responses

200

Tenant user respose

application/json

accountTypestring · enumRequired

ENUM	Description
FULL	Access to backoffice and onboarding of new devices
REGULAR	Can only login to already onboarded devices
SUPPORT	Support account
INTEGRATION	Computer integration account

Possible values:

createdAtstring · date-timeRequired

defaultStoreUidstringOptionalPattern: ^[A-Za-z0-9-_]*

displayNamestringRequired

emailstringRequired

externalIdstringRequired

firstnamestringRequired

lastAccessedstring · date-timeRequired

lastModifiedAtstring · date-timeRequired

lastnamestringRequired

mobilestringRequired

statusstring · enumRequiredPossible values:

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

tenantNamestringRequired

tenantRolestring · enumRequired

ENUM	Description
BLOCKED	Blocked from this tenant
ACCESS	Only access to the tenant.
ADMIN	Tenant admin, allow full access to tenant and can add users and new stores.
BACKOFFICE	Access to product, pricelists, etc.

Possible values:

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

userCodestringRequired

languageCodestringRequired

ISO 639-1 code for language

post/tenants/{tenantUid}/account

HTTPcURLJavaScriptPython

POST /v2/tenants/{tenantUid}/account HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Tenant user respose

{
  "accountType": "FULL",
  "createdAt": "2026-07-16T14:18:41.110Z",
  "defaultStoreUid": "text",
  "displayName": "text",
  "email": "text",
  "externalId": "text",
  "firstname": "text",
  "lastAccessed": "2026-07-16T14:18:41.110Z",
  "lastModifiedAt": "2026-07-16T14:18:41.110Z",
  "lastname": "text",
  "mobile": "text",
  "status": "PENDING_INVITE",
  "storeAccess": [
    {
      "createdAt": "2026-07-16T14:18:41.110Z",
      "lastModifiedAt": "2026-07-16T14:18:41.110Z",
      "storeAccessUid": "text",
      "storeUid": "text",
      "storeRole": "ADMIN"
    }
  ],
  "tenantUid": "text",
  "tenantName": "text",
  "tenantRole": "ACCESS",
  "tenantUserUid": "text",
  "userCode": "text",
  "languageCode": "text",
  "permissions": {
    "tenant": [
      "text"
    ],
    "stores": [
      {
        "store": {
          "name": "text",
          "storeUid": "text",
          "organizationUid": "text",
          "organizationName": "text"
        },
        "permissions": [
          "text"
        ]
      }
    ],
    "organizations": [
      {
        "organization": {
          "name": "text",
          "organizationUid": "text"
        },
        "permissions": [
          "text"
        ]
      }
    ]
  }
}

Update account info

put

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

/tenants/{tenantUid}/account

Update information about logged in user

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

Body

application/json

Update the tenant account

defaultStoreUidstringOptionalPattern: ^[A-Za-z0-9-_]*

displayNamestringOptional

emailstringOptional

firstnamestringOptional

lastnamestringOptional

mobilestringOptional

passwordstringOptional

languageCodestringOptional

ISO 639-1 code for language

Responses

200

Tenant user respose

application/json

accountTypestring · enumRequired

ENUM	Description
FULL	Access to backoffice and onboarding of new devices
REGULAR	Can only login to already onboarded devices
SUPPORT	Support account
INTEGRATION	Computer integration account

Possible values:

createdAtstring · date-timeRequired

defaultStoreUidstringOptionalPattern: ^[A-Za-z0-9-_]*

displayNamestringRequired

emailstringRequired

externalIdstringRequired

firstnamestringRequired

lastAccessedstring · date-timeRequired

lastModifiedAtstring · date-timeRequired

lastnamestringRequired

mobilestringRequired

statusstring · enumRequiredPossible values:

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

tenantNamestringRequired

tenantRolestring · enumRequired

ENUM	Description
BLOCKED	Blocked from this tenant
ACCESS	Only access to the tenant.
ADMIN	Tenant admin, allow full access to tenant and can add users and new stores.
BACKOFFICE	Access to product, pricelists, etc.

Possible values:

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

userCodestringRequired

languageCodestringRequired

ISO 639-1 code for language

put/tenants/{tenantUid}/account

HTTPcURLJavaScriptPython

PUT /v2/tenants/{tenantUid}/account HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 155

{
  "defaultStoreUid": "text",
  "displayName": "text",
  "email": "text",
  "firstname": "text",
  "lastname": "text",
  "mobile": "text",
  "password": "text",
  "languageCode": "text"
}

200

Tenant user respose

{
  "accountType": "FULL",
  "createdAt": "2026-07-16T14:18:41.110Z",
  "defaultStoreUid": "text",
  "displayName": "text",
  "email": "text",
  "externalId": "text",
  "firstname": "text",
  "lastAccessed": "2026-07-16T14:18:41.110Z",
  "lastModifiedAt": "2026-07-16T14:18:41.110Z",
  "lastname": "text",
  "mobile": "text",
  "status": "PENDING_INVITE",
  "storeAccess": [
    {
      "createdAt": "2026-07-16T14:18:41.110Z",
      "lastModifiedAt": "2026-07-16T14:18:41.110Z",
      "storeAccessUid": "text",
      "storeUid": "text",
      "storeRole": "ADMIN"
    }
  ],
  "tenantUid": "text",
  "tenantName": "text",
  "tenantRole": "ACCESS",
  "tenantUserUid": "text",
  "userCode": "text",
  "languageCode": "text",
  "permissions": {
    "tenant": [
      "text"
    ],
    "stores": [
      {
        "store": {
          "name": "text",
          "storeUid": "text",
          "organizationUid": "text",
          "organizationName": "text"
        },
        "permissions": [
          "text"
        ]
      }
    ],
    "organizations": [
      {
        "organization": {
          "name": "text",
          "organizationUid": "text"
        },
        "permissions": [
          "text"
        ]
      }
    ]
  }
}

Get tenant invitation information

get

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

/account/invite

Get information about invitation to a tenant

Header parameters

x-invite-tokenstringRequired

invite token

Responses

200

Example response

application/json

get/account/invite

HTTPcURLJavaScriptPython

GET /v2/account/invite HTTP/1.1
Host: api.flowretail.com
x-invite-token: text
Accept: */*

200

Example response

{
  "tenant": {
    "name": "text"
  },
  "user": {
    "displayName": "text",
    "email": "text",
    "firstname": "text",
    "lastname": "text",
    "mobile": "text",
    "status": "text"
  }
}

Accept tenant invitation

put

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

/account/invite

Accept invitation to a tenant

Authorizations

authToken

AuthorizationstringRequired

Token received from the auth service

Body

application/json

Accept an invitation

inviteTokenstringRequired

Responses

200

Tenant user respose

application/json

accountTypestring · enumRequired

ENUM	Description
FULL	Access to backoffice and onboarding of new devices
REGULAR	Can only login to already onboarded devices
SUPPORT	Support account
INTEGRATION	Computer integration account

Possible values:

createdAtstring · date-timeRequired

defaultStoreUidstringOptionalPattern: ^[A-Za-z0-9-_]*

displayNamestringRequired

emailstringRequired

externalIdstringRequired

firstnamestringRequired

lastAccessedstring · date-timeRequired

lastModifiedAtstring · date-timeRequired

lastnamestringRequired

mobilestringRequired

statusstring · enumRequiredPossible values:

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

tenantNamestringRequired

tenantRolestring · enumRequired

ENUM	Description
BLOCKED	Blocked from this tenant
ACCESS	Only access to the tenant.
ADMIN	Tenant admin, allow full access to tenant and can add users and new stores.
BACKOFFICE	Access to product, pricelists, etc.

Possible values:

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

userCodestringRequired

languageCodestringRequired

ISO 639-1 code for language

put/account/invite

HTTPcURLJavaScriptPython

PUT /v2/account/invite HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 22

{
  "inviteToken": "text"
}

200

Tenant user respose

{
  "accountType": "FULL",
  "createdAt": "2026-07-16T14:18:41.110Z",
  "defaultStoreUid": "text",
  "displayName": "text",
  "email": "text",
  "externalId": "text",
  "firstname": "text",
  "lastAccessed": "2026-07-16T14:18:41.110Z",
  "lastModifiedAt": "2026-07-16T14:18:41.110Z",
  "lastname": "text",
  "mobile": "text",
  "status": "PENDING_INVITE",
  "storeAccess": [
    {
      "createdAt": "2026-07-16T14:18:41.110Z",
      "lastModifiedAt": "2026-07-16T14:18:41.110Z",
      "storeAccessUid": "text",
      "storeUid": "text",
      "storeRole": "ADMIN"
    }
  ],
  "tenantUid": "text",
  "tenantName": "text",
  "tenantRole": "ACCESS",
  "tenantUserUid": "text",
  "userCode": "text",
  "languageCode": "text",
  "permissions": {
    "tenant": [
      "text"
    ],
    "stores": [
      {
        "store": {
          "name": "text",
          "storeUid": "text",
          "organizationUid": "text",
          "organizationName": "text"
        },
        "permissions": [
          "text"
        ]
      }
    ],
    "organizations": [
      {
        "organization": {
          "name": "text",
          "organizationUid": "text"
        },
        "permissions": [
          "text"
        ]
      }
    ]
  }
}

List subscribers

get

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

/tenants/{tenantUid}/stores/{storeUid}/subscribers

List subscribers for a store.

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-_]+

Query parameters

pageNumberintegerOptional

Reference to a specific page in a result set.

pageSizeintegerOptional

The number of items per 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:

subscriptionTypestring · enumOptional

Reference to subscription type

Possible values:

tenantUserUidsstring[]Optional

Filter on tenant users

Responses

200

Example response

application/json

get/tenants/{tenantUid}/stores/{storeUid}/subscribers

HTTPcURLJavaScriptPython

GET /v2/tenants/{tenantUid}/stores/{storeUid}/subscribers HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "items": [
    {
      "subscriberUid": "text",
      "subscription": {
        "type": "SALES_SUMMARY_REPORT",
        "name": "text"
      },
      "tenantUser": {
        "tenantUserUid": "text",
        "displayName": "text",
        "email": "text"
      },
      "createdAt": "2026-07-16T14:18:41.110Z",
      "createdBy": "text"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Create subscriber

post

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

/tenants/{tenantUid}/stores/{storeUid}/subscribers

Create new subscriber.

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

subscriberUidstringOptionalPattern: ^[A-Za-z0-9-_]*

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

subscriptionTypestring · enumRequiredPossible values:

Responses

201

Example response

application/json

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

createdAtstring · date-timeRequired

createdBystringRequired

post/tenants/{tenantUid}/stores/{storeUid}/subscribers

HTTPcURLJavaScriptPython

POST /v2/tenants/{tenantUid}/stores/{storeUid}/subscribers HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 89

{
  "subscriberUid": "text",
  "tenantUserUid": "text",
  "subscriptionType": "SALES_SUMMARY_REPORT"
}

201

Example response

{
  "subscriberUid": "text",
  "subscription": {
    "type": "SALES_SUMMARY_REPORT",
    "name": "text"
  },
  "tenantUser": {
    "tenantUserUid": "text",
    "displayName": "text",
    "email": "text"
  },
  "createdAt": "2026-07-16T14:18:41.110Z",
  "createdBy": "text"
}

Get subscriber

get

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

/tenants/{tenantUid}/stores/{storeUid}/subscribers/{subscriberUid}

Get a subscriber.

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-_]+

subscriberUidstringRequired

Reference to a subscriber

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

Responses

200

Example response

application/json

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

createdAtstring · date-timeRequired

createdBystringRequired

get/tenants/{tenantUid}/stores/{storeUid}/subscribers/{subscriberUid}

HTTPcURLJavaScriptPython

GET /v2/tenants/{tenantUid}/stores/{storeUid}/subscribers/{subscriberUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "subscriberUid": "text",
  "subscription": {
    "type": "SALES_SUMMARY_REPORT",
    "name": "text"
  },
  "tenantUser": {
    "tenantUserUid": "text",
    "displayName": "text",
    "email": "text"
  },
  "createdAt": "2026-07-16T14:18:41.110Z",
  "createdBy": "text"
}

Delete subscriber

delete

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

/tenants/{tenantUid}/stores/{storeUid}/subscribers/{subscriberUid}

Delete a subscriber.

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-_]+

subscriberUidstringRequired

Reference to a subscriber

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

Responses

204

No Content

No content

delete/tenants/{tenantUid}/stores/{storeUid}/subscribers/{subscriberUid}

HTTPcURLJavaScriptPython

DELETE /v2/tenants/{tenantUid}/stores/{storeUid}/subscribers/{subscriberUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

No Content

No content