Heads up, our devs are blazing ahead—docs are catching up, so some features might not be fully documented yet.
Visit our websiteAPI Documentation

CustomerGroup

CustomerGroup

List customer groups

get

List customer groups

Authorizations
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
Possible values:
Responses
200
Example response
application/json
get
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-07-30T18:10:06.447Z",
      "lastModifiedBy": "text",
      "lastModifiedAt": "2025-07-30T18:10:06.447Z"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Create customer group

post

Create customer group

Authorizations
Path parameters
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
Body
namestringRequired
customerGroupUidstringOptionalPattern: ^[A-Za-z0-9-_]*
Responses
201
Example response
application/json
Responseall of
and
post
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-07-30T18:10:06.447Z",
  "lastModifiedBy": "text",
  "lastModifiedAt": "2025-07-30T18:10:06.447Z"
}

Get customer group

get

Get customer group for UID.

Authorizations
Path parameters
tenantUidstringRequired

Reference to a tenant.

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

Reference to a customer group

Responses
200
Example response
application/json
Responseall of
and
get
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-07-30T18:10:06.447Z",
  "lastModifiedBy": "text",
  "lastModifiedAt": "2025-07-30T18:10:06.447Z"
}

Update customer group

put

Update customer group

Authorizations
Path parameters
tenantUidstringRequired

Reference to a tenant.

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

Reference to a customer group

Body
namestringOptional
Responses
200
Example response
application/json
Responseall of
and
put
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-07-30T18:10:06.447Z",
  "lastModifiedBy": "text",
  "lastModifiedAt": "2025-07-30T18:10:06.447Z"
}

Delete customer group

delete

Delete customer group

Authorizations
Path parameters
tenantUidstringRequired

Reference to a tenant.

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

Reference to a customer group

Responses
204
No Content
delete
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
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
Possible values:
Responses
200
CustomerListResponse
application/json
get
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-07-30T18:10:06.447Z",
      "customerUid": "text",
      "customerType": "COMPANY",
      "email": "text",
      "externalId": "text",
      "firstname": "text",
      "lastModifiedAt": "2025-07-30T18:10:06.447Z",
      "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-07-30T18:10:06.447Z",
          "lastModifiedAt": "2025-07-30T18:10:06.447Z",
          "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-07-30T18:10:06.447Z"
        }
      ],
      "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
Path parameters
tenantUidstringRequired

Reference to a tenant.

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

Reference to a customer group

Body
addCustomerUidsstring[]Optional
removeCustomerUidsstring[]Optional
Responses
204
No Content
put
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
PreviousCustomerContactNextDevice

Was this helpful?