Customer groups

All relevant API endpoints for creating and editing customer groups.

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

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.flowretail.com/v2/tenants/{tenantUid}/customer-groups' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "customerGroupUid": "text"
  }'

201

201

{
  "customerGroupUid": "text",
  "name": "text",
  "createdBy": "text",
  "createdAt": "2025-04-04T03:09:52.484Z",
  "lastModifiedBy": "text",
  "lastModifiedAt": "2025-04-04T03:09:52.484Z"
}

Example response

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

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.flowretail.com/v2/tenants/{tenantUid}/customer-groups' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

{
  "items": [
    {
      "customerGroupUid": "text",
      "name": "text",
      "createdBy": "text",
      "createdAt": "2025-04-04T03:09:52.484Z",
      "lastModifiedBy": "text",
      "lastModifiedAt": "2025-04-04T03:09:52.484Z"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Example response

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

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.flowretail.com/v2/tenants/{tenantUid}/customer-groups/{customerGroupUid}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text"
  }'

200

200

{
  "customerGroupUid": "text",
  "name": "text",
  "createdBy": "text",
  "createdAt": "2025-04-04T03:09:52.484Z",
  "lastModifiedBy": "text",
  "lastModifiedAt": "2025-04-04T03:09:52.484Z"
}

Example response