Ctrlk
User documentationRelease NotesRoadmapGo to websiteFlow Retail Admin
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Organization

Organization

List organizations

get
/tenants/{tenantUid}/organizations

List all organizations.

Required permissions: ORGANIZATION

Authorizations
AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters
tenantUidstringRequired

Reference to a tenant.

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

External reference to an organization.

organizationNamestringOptional

Reference to the name of an organization.

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
ENUMDescription
ASCSort in ascending order
DESCSort in descending order
Possible values:
Responses
200

Example response

application/json
get/tenants/{tenantUid}/organizations
GET /v2/tenants/{tenantUid}/organizations HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Example response

{
  "items": [
    {
      "address": "text",
      "city": "text",
      "countryCode": "text",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "email": "text",
      "externalId": "text",
      "isActive": true,
      "lastModifiedAt": "2026-01-01T00:00:00.000Z",
      "name": "text",
      "postalCode": "text",
      "phone": "text",
      "organizationUid": "text",
      "vatNumber": "text",
      "bankInfo": {
        "accountNumber": "text",
        "bankName": "text",
        "iban": "text",
        "swift": "text"
      },
      "websiteUrl": "text"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Create a new organization

post
/tenants/{tenantUid}/organizations

Creates a new organization.

Required permissions: ORGANIZATION

Authorizations
AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
Body
addressstringOptional
citystringOptional
countryCodestringOptional
emailstringOptional
externalIdstringOptional
isActivebooleanOptional
namestringRequired
phonestringOptional
postalCodestringOptional
vatNumberstringOptional

VAT identification number for value added tax reporting purposes.

websiteUrlstringOptional
organizationUidstringOptionalPattern: ^[A-Za-z0-9-_]+
Responses
200

Example response

application/json
addressstringRequired
citystringRequired
countryCodestringRequired
createdAtstring · date-timeRequired
emailstringRequired
externalIdstringRequired
isActivebooleanRequired
lastModifiedAtstring · date-timeRequired
namestringRequired
postalCodestringRequired
phonestringRequired
organizationUidstringRequiredPattern: ^[A-Za-z0-9-_]+
vatNumberstringRequired

VAT identification number for value added tax reporting purposes.

websiteUrlstringRequired
post/tenants/{tenantUid}/organizations
POST /v2/tenants/{tenantUid}/organizations HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 300

{
  "address": "text",
  "city": "text",
  "countryCode": "text",
  "email": "text",
  "externalId": "text",
  "isActive": true,
  "name": "text",
  "phone": "text",
  "postalCode": "text",
  "vatNumber": "text",
  "websiteUrl": "text",
  "bankInfo": {
    "accountNumber": "text",
    "bankName": "text",
    "iban": "text",
    "swift": "text"
  },
  "organizationUid": "text"
}
200

Example response

{
  "address": "text",
  "city": "text",
  "countryCode": "text",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "email": "text",
  "externalId": "text",
  "isActive": true,
  "lastModifiedAt": "2026-01-01T00:00:00.000Z",
  "name": "text",
  "postalCode": "text",
  "phone": "text",
  "organizationUid": "text",
  "vatNumber": "text",
  "bankInfo": {
    "accountNumber": "text",
    "bankName": "text",
    "iban": "text",
    "swift": "text"
  },
  "websiteUrl": "text"
}

Get organization details

get
/tenants/{tenantUid}/organizations/{organizationUid}

Get details for an organization.

Required permissions: ORGANIZATION

Authorizations
AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters
organizationUidstringRequired

Reference to an organization.

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

Reference to a tenant.

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

Example response

application/json
addressstringRequired
citystringRequired
countryCodestringRequired
createdAtstring · date-timeRequired
emailstringRequired
externalIdstringRequired
isActivebooleanRequired
lastModifiedAtstring · date-timeRequired
namestringRequired
postalCodestringRequired
phonestringRequired
organizationUidstringRequiredPattern: ^[A-Za-z0-9-_]+
vatNumberstringRequired

VAT identification number for value added tax reporting purposes.

websiteUrlstringRequired
get/tenants/{tenantUid}/organizations/{organizationUid}
GET /v2/tenants/{tenantUid}/organizations/{organizationUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Example response

{
  "address": "text",
  "city": "text",
  "countryCode": "text",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "email": "text",
  "externalId": "text",
  "isActive": true,
  "lastModifiedAt": "2026-01-01T00:00:00.000Z",
  "name": "text",
  "postalCode": "text",
  "phone": "text",
  "organizationUid": "text",
  "vatNumber": "text",
  "bankInfo": {
    "accountNumber": "text",
    "bankName": "text",
    "iban": "text",
    "swift": "text"
  },
  "websiteUrl": "text"
}

Update organization details

put
/tenants/{tenantUid}/organizations/{organizationUid}

Update details for an organization. Partial updates are allowed.

Required permissions: ORGANIZATION

Authorizations
AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters
organizationUidstringRequired

Reference to an organization.

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

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
Body
addressstringOptional
citystringOptional
countryCodestringOptional
emailstringOptional
externalIdstringOptional
isActivebooleanOptional
namestringRequired
phonestringOptional
postalCodestringOptional
vatNumberstringOptional

VAT identification number for value added tax reporting purposes.

websiteUrlstringOptional
Responses
201

Example response

application/json
addressstringRequired
citystringRequired
countryCodestringRequired
createdAtstring · date-timeRequired
emailstringRequired
externalIdstringRequired
isActivebooleanRequired
lastModifiedAtstring · date-timeRequired
namestringRequired
postalCodestringRequired
phonestringRequired
organizationUidstringRequiredPattern: ^[A-Za-z0-9-_]+
vatNumberstringRequired

VAT identification number for value added tax reporting purposes.

websiteUrlstringRequired
put/tenants/{tenantUid}/organizations/{organizationUid}
PUT /v2/tenants/{tenantUid}/organizations/{organizationUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 275

{
  "address": "text",
  "city": "text",
  "countryCode": "text",
  "email": "text",
  "externalId": "text",
  "isActive": true,
  "name": "text",
  "phone": "text",
  "postalCode": "text",
  "vatNumber": "text",
  "websiteUrl": "text",
  "bankInfo": {
    "accountNumber": "text",
    "bankName": "text",
    "iban": "text",
    "swift": "text"
  }
}
201

Example response

{
  "address": "text",
  "city": "text",
  "countryCode": "text",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "email": "text",
  "externalId": "text",
  "isActive": true,
  "lastModifiedAt": "2026-01-01T00:00:00.000Z",
  "name": "text",
  "postalCode": "text",
  "phone": "text",
  "organizationUid": "text",
  "vatNumber": "text",
  "bankInfo": {
    "accountNumber": "text",
    "bankName": "text",
    "iban": "text",
    "swift": "text"
  },
  "websiteUrl": "text"
}

Delete an organization

delete
/tenants/{tenantUid}/organizations/{organizationUid}

Deletes a organizations.

Required permissions: ORGANIZATION

Authorizations
AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters
organizationUidstringRequired

Reference to an organization.

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

Reference to a tenant.

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

No Content

No content
delete/tenants/{tenantUid}/organizations/{organizationUid}
DELETE /v2/tenants/{tenantUid}/organizations/{organizationUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
204

No Content

No content
PreviousOrderSettlementNextPaymentMethod

Last updated