User

PreviousTimeslots NextWarehouse

Was this helpful?

Get account info for a specific tenant

get

Get tenant information about logged-in user

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

Responses

application/json

objectoptional

get

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": "2025-04-18T01:01:59.938Z",
  "defaultStoreUid": "text",
  "displayName": "text",
  "email": "text",
  "externalId": "text",
  "firstname": "text",
  "lastAccessed": "2025-04-18T01:01:59.938Z",
  "lastModifiedAt": "2025-04-18T01:01:59.938Z",
  "lastname": "text",
  "mobile": "text",
  "status": "PENDING_INVITE",
  "storeAccess": [
    {
      "createdAt": "2025-04-18T01:01:59.938Z",
      "lastModifiedAt": "2025-04-18T01:01:59.938Z",
      "storeAccessUid": "text",
      "storeUid": "text",
      "storeRole": "ADMIN"
    }
  ],
  "tenantUid": "text",
  "tenantRole": "ACCESS",
  "tenantUserUid": "text",
  "userCode": "text",
  "languageCode": "text"
}

Generate accessToken from authToken

post

Generate access token from auth token

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

Responses

application/json

objectoptional

post

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": "2025-04-18T01:01:59.938Z",
  "defaultStoreUid": "text",
  "displayName": "text",
  "email": "text",
  "externalId": "text",
  "firstname": "text",
  "lastAccessed": "2025-04-18T01:01:59.938Z",
  "lastModifiedAt": "2025-04-18T01:01:59.938Z",
  "lastname": "text",
  "mobile": "text",
  "status": "PENDING_INVITE",
  "storeAccess": [
    {
      "createdAt": "2025-04-18T01:01:59.938Z",
      "lastModifiedAt": "2025-04-18T01:01:59.938Z",
      "storeAccessUid": "text",
      "storeUid": "text",
      "storeRole": "ADMIN"
    }
  ],
  "tenantUid": "text",
  "tenantRole": "ACCESS",
  "tenantUserUid": "text",
  "userCode": "text",
  "languageCode": "text"
}

Get tenant invitation information

get

Get information about invitation to a tenant

Header parameters

x-invite-tokenstringrequired

invite token

Responses

application/json

objectoptional

get

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"
  }
}

Get full account info

get

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

Authorizations

Responses

application/json

objectoptional

get

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": "2025-04-18T01:01:59.938Z",
      "defaultStoreUid": "text",
      "displayName": "text",
      "email": "text",
      "externalId": "text",
      "firstname": "text",
      "lastAccessed": "2025-04-18T01:01:59.938Z",
      "lastModifiedAt": "2025-04-18T01:01:59.938Z",
      "lastname": "text",
      "mobile": "text",
      "status": "PENDING_INVITE",
      "storeAccess": [
        {
          "createdAt": "2025-04-18T01:01:59.938Z",
          "lastModifiedAt": "2025-04-18T01:01:59.938Z",
          "storeAccessUid": "text",
          "storeUid": "text",
          "storeRole": "ADMIN"
        }
      ],
      "tenantUid": "text",
      "tenantRole": "ACCESS",
      "tenantUserUid": "text",
      "userCode": "text",
      "languageCode": "text"
    }
  ]
}

Login user

post

Requires a valid deviceToken

Authorizations

Body

passwordstringrequired

userCodestringrequired

Responses

application/json

objectoptional

post

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": "2025-04-18T01:01:59.938Z",
    "defaultStoreUid": "text",
    "displayName": "text",
    "email": "text",
    "externalId": "text",
    "firstname": "text",
    "lastAccessed": "2025-04-18T01:01:59.938Z",
    "lastModifiedAt": "2025-04-18T01:01:59.938Z",
    "lastname": "text",
    "mobile": "text",
    "status": "PENDING_INVITE",
    "storeAccess": [
      {
        "createdAt": "2025-04-18T01:01:59.938Z",
        "lastModifiedAt": "2025-04-18T01:01:59.938Z",
        "storeAccessUid": "text",
        "storeUid": "text",
        "storeRole": "ADMIN"
      }
    ],
    "tenantUid": "text",
    "tenantRole": "ACCESS",
    "tenantUserUid": "text",
    "userCode": "text",
    "languageCode": "text"
  }
}

Update global account information

put

Update global information about logged in user

Authorizations

Body

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

Responses

application/json

objectoptional

put

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": "2025-04-18T01:01:59.938Z",
      "defaultStoreUid": "text",
      "displayName": "text",
      "email": "text",
      "externalId": "text",
      "firstname": "text",
      "lastAccessed": "2025-04-18T01:01:59.938Z",
      "lastModifiedAt": "2025-04-18T01:01:59.938Z",
      "lastname": "text",
      "mobile": "text",
      "status": "PENDING_INVITE",
      "storeAccess": [
        {
          "createdAt": "2025-04-18T01:01:59.938Z",
          "lastModifiedAt": "2025-04-18T01:01:59.938Z",
          "storeAccessUid": "text",
          "storeUid": "text",
          "storeRole": "ADMIN"
        }
      ],
      "tenantUid": "text",
      "tenantRole": "ACCESS",
      "tenantUserUid": "text",
      "userCode": "text",
      "languageCode": "text"
    }
  ]
}

Update account info

put

Update information about logged in user

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

Body

Update the tenant account

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

displayNamestringoptional

emailstringoptional

firstnamestringoptional

lastnamestringoptional

mobilestringoptional

passwordstringoptional

languageCodestringoptional

ISO 639-1 code for language

Responses

application/json

objectoptional

put

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": "2025-04-18T01:01:59.938Z",
  "defaultStoreUid": "text",
  "displayName": "text",
  "email": "text",
  "externalId": "text",
  "firstname": "text",
  "lastAccessed": "2025-04-18T01:01:59.938Z",
  "lastModifiedAt": "2025-04-18T01:01:59.938Z",
  "lastname": "text",
  "mobile": "text",
  "status": "PENDING_INVITE",
  "storeAccess": [
    {
      "createdAt": "2025-04-18T01:01:59.938Z",
      "lastModifiedAt": "2025-04-18T01:01:59.938Z",
      "storeAccessUid": "text",
      "storeUid": "text",
      "storeRole": "ADMIN"
    }
  ],
  "tenantUid": "text",
  "tenantRole": "ACCESS",
  "tenantUserUid": "text",
  "userCode": "text",
  "languageCode": "text"
}

Accept tenant invitation

put

Accept invitation to a tenant

Authorizations

Body

Accept an invitation

inviteTokenstringrequired

Responses

application/json

objectoptional

put

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": "2025-04-18T01:01:59.938Z",
  "defaultStoreUid": "text",
  "displayName": "text",
  "email": "text",
  "externalId": "text",
  "firstname": "text",
  "lastAccessed": "2025-04-18T01:01:59.938Z",
  "lastModifiedAt": "2025-04-18T01:01:59.938Z",
  "lastname": "text",
  "mobile": "text",
  "status": "PENDING_INVITE",
  "storeAccess": [
    {
      "createdAt": "2025-04-18T01:01:59.938Z",
      "lastModifiedAt": "2025-04-18T01:01:59.938Z",
      "storeAccessUid": "text",
      "storeUid": "text",
      "storeRole": "ADMIN"
    }
  ],
  "tenantUid": "text",
  "tenantRole": "ACCESS",
  "tenantUserUid": "text",
  "userCode": "text",
  "languageCode": "text"
}