Organization

PreviousNotifications NextOrder

Was this helpful?

Get organization details

get

Get details for an organization.

Authorizations

Path parameters

organizationUidstringrequired

Reference to an organization.

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

tenantUidstringrequired

Reference to a tenant.

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

Responses

application/json

objectoptional

get

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": "2025-04-18T01:24:02.031Z",
  "email": "text",
  "externalId": "text",
  "isActive": true,
  "lastModifiedAt": "2025-04-18T01:24:02.031Z",
  "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

Deletes a organizations.

Authorizations

Path parameters

organizationUidstringrequired

Reference to an organization.

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

tenantUidstringrequired

Reference to a tenant.

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

Responses

delete

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

204

No Content

List organizations

get

List all organizations.

Authorizations

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

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

Available options:

Responses

application/json

objectoptional

get

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": "2025-04-18T01:24:02.031Z",
      "email": "text",
      "externalId": "text",
      "isActive": true,
      "lastModifiedAt": "2025-04-18T01:24:02.031Z",
      "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

Creates a new organization.

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

Body

all ofoptional

Responses

application/json

objectoptional

post

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": "2025-04-18T01:24:02.031Z",
  "email": "text",
  "externalId": "text",
  "isActive": true,
  "lastModifiedAt": "2025-04-18T01:24:02.031Z",
  "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

Update details for an organization. Partial updates are allowed.

Authorizations

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

bankInfoobjectoptional

Responses

application/json

objectoptional

put

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": "2025-04-18T01:24:02.031Z",
  "email": "text",
  "externalId": "text",
  "isActive": true,
  "lastModifiedAt": "2025-04-18T01:24:02.031Z",
  "name": "text",
  "postalCode": "text",
  "phone": "text",
  "organizationUid": "text",
  "vatNumber": "text",
  "bankInfo": {
    "accountNumber": "text",
    "bankName": "text",
    "iban": "text",
    "swift": "text"
  },
  "websiteUrl": "text"
}