CustomerGroup

CustomerGroup

List customer groups

get

List customer groups

Authorizations

accessTokenauthTokenintegrationToken

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

Available options:

Responses

application/json

objectoptional

get

HTTPcURLJavaScriptPython

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

200

Example response

{
  "items": [
    {
      "customerGroupUid": "text",
      "name": "text",
      "createdBy": "text",
      "createdAt": "2025-04-18T01:43:00.159Z",
      "lastModifiedBy": "text",
      "lastModifiedAt": "2025-04-18T01:43:00.159Z"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Create customer group

post

Create customer group

Authorizations

accessTokenauthTokenintegrationToken

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

Body

namestringrequired

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

Responses

application/json

all ofoptional

post

HTTPcURLJavaScriptPython

POST /v2/tenants/{tenantUid}/customer-groups HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 41

{
  "name": "text",
  "customerGroupUid": "text"
}

201

Example response

{
  "customerGroupUid": "text",
  "name": "text",
  "createdBy": "text",
  "createdAt": "2025-04-18T01:43:00.159Z",
  "lastModifiedBy": "text",
  "lastModifiedAt": "2025-04-18T01:43:00.159Z"
}

Get customer group

get

Get customer group for UID.

Authorizations

accessTokenauthTokenintegrationToken

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

customerGroupUidstringrequired

Reference to a customer group

Responses

application/json

all ofoptional

get

HTTPcURLJavaScriptPython

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

200

Example response

{
  "customerGroupUid": "text",
  "name": "text",
  "createdBy": "text",
  "createdAt": "2025-04-18T01:43:00.159Z",
  "lastModifiedBy": "text",
  "lastModifiedAt": "2025-04-18T01:43:00.159Z"
}

Update customer group

put

Update customer group

Authorizations

accessTokenauthTokenintegrationToken

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

customerGroupUidstringrequired

Reference to a customer group

Body

namestringoptional

Responses

application/json

all ofoptional

put

HTTPcURLJavaScriptPython

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

{
  "name": "text"
}

200

Example response

{
  "customerGroupUid": "text",
  "name": "text",
  "createdBy": "text",
  "createdAt": "2025-04-18T01:43:00.159Z",
  "lastModifiedBy": "text",
  "lastModifiedAt": "2025-04-18T01:43:00.159Z"
}

Delete customer group

delete

Delete customer group

Authorizations

accessTokenauthTokenintegrationToken

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

customerGroupUidstringrequired

Reference to a customer group

Responses

delete

HTTPcURLJavaScriptPython

DELETE /v2/tenants/{tenantUid}/customer-groups/{customerGroupUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

No Content

No Content

Get customer group with customers

get

Get customer group with list of customers.

Authorizations

accessTokenauthTokenintegrationToken

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

customerGroupUidstringrequired

Reference to a customer group

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

Available options:

Responses

application/json

objectoptional

get

HTTPcURLJavaScriptPython

GET /v2/tenants/{tenantUid}/customer-groups/{customerGroupUid}/customers HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

CustomerListResponse

{
  "items": [
    {
      "address": "text",
      "city": "text",
      "companyName": "text",
      "countryCode": "text",
      "createdAt": "2025-04-18T01:43:00.159Z",
      "customerUid": "text",
      "customerType": "COMPANY",
      "email": "text",
      "externalId": "text",
      "firstname": "text",
      "lastModifiedAt": "2025-04-18T01:43:00.159Z",
      "lastname": "text",
      "ledgerNumber": "text",
      "mobile": "text",
      "postalCode": "text",
      "pricelistUid": "text",
      "vatNumber": "text",
      "origin": "text",
      "addresses": [
        {
          "address": "text",
          "city": "text",
          "companyName": "text",
          "firstname": "text",
          "lastname": "text",
          "countryCode": "text",
          "email": "text",
          "phone": "text",
          "postalCode": "text",
          "type": "DELIVERY_ADDRESS",
          "customerAddressUid": "text",
          "displayName": "text"
        }
      ],
      "contacts": [
        {
          "firstname": "text",
          "lastname": "text",
          "email": "text",
          "mobile": "text",
          "createdAt": "2025-04-18T01:43:00.159Z",
          "lastModifiedAt": "2025-04-18T01:43:00.159Z",
          "customerContactUid": "text",
          "extensions": [
            {
              "extensionCode": "TWO_INVOICE",
              "organizationUid": "text"
            }
          ],
          "displayName": "text"
        }
      ],
      "extensions": [
        {
          "extensionCode": "TWO_INVOICE",
          "organizationUid": "text"
        }
      ],
      "consents": [
        {
          "consentUid": "text",
          "name": "text",
          "status": true,
          "source": "text",
          "createdAt": "2025-04-18T01:43:00.159Z"
        }
      ],
      "loyaltyId": "text",
      "displayName": "text",
      "credit": {
        "limit": 1,
        "balance": 1
      },
      "paymentTerms": 1,
      "internalNote": "text",
      "accountManager": {
        "tenantUserUid": "text",
        "displayName": "text",
        "userCode": "text"
      },
      "ehfEnabled": true,
      "customerGroupUids": [
        "text"
      ]
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Add or remove customer group customers

put

Add and/or remove customer group customers.

Authorizations

accessTokenauthTokenintegrationToken

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

customerGroupUidstringrequired

Reference to a customer group

Body

addCustomerUidsstring[]optional

removeCustomerUidsstring[]optional

Responses

put

HTTPcURLJavaScriptPython

PUT /v2/tenants/{tenantUid}/customer-groups/{customerGroupUid}/customers HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 58

{
  "addCustomerUids": [
    "text"
  ],
  "removeCustomerUids": [
    "text"
  ]
}

204

No Content

No Content