ProductGroup
ProductGroup
List all product groups.
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to the name of a product group.
External reference to a product group.
Reference to a specific page in a result set.
The number of items per page in a result set.
Defines which field the resource list is sorted by.
| ENUM | Description |
|---|---|
| ASC | Sort in ascending order |
| DESC | Sort in descending order |
List of product groups
GET /v2/tenants/{tenantUid}/product-groups HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
List of product groups
{
"items": [
{
"createdAt": "2025-09-13T06:17:16.033Z",
"externalId": "text",
"lastModifiedAt": "2025-09-13T06:17:16.033Z",
"name": "text",
"parentUid": "text",
"productCount": 1,
"productGroupUid": "text",
"scope": "SALE"
}
],
"paging": {
"pageNumber": 1,
"pageSize": 1,
"totalCount": 1
}
}Creates a new product group.
If parentUid is set and no scope is set, the new product group inherits scope from parent.
Reference to a tenant.
^[A-Za-z0-9-_]+Example response
POST /v2/tenants/{tenantUid}/product-groups HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 94
{
"externalId": "text",
"name": "text",
"parentUid": "text",
"scope": "SALE",
"productGroupUid": "text"
}Example response
{
"createdAt": "2025-09-13T06:17:16.033Z",
"externalId": "text",
"lastModifiedAt": "2025-09-13T06:17:16.033Z",
"name": "text",
"parentUid": "text",
"productCount": 1,
"productGroupUid": "text",
"scope": "SALE"
}Get details for a product group.
Reference to a ProductGroup.
^[A-Za-z0-9-_]+Reference to a tenant.
^[A-Za-z0-9-_]+Example response
GET /v2/tenants/{tenantUid}/product-groups/{productGroupUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Example response
{
"createdAt": "2025-09-13T06:17:16.033Z",
"externalId": "text",
"lastModifiedAt": "2025-09-13T06:17:16.033Z",
"name": "text",
"parentUid": "text",
"productCount": 1,
"productGroupUid": "text",
"scope": "SALE"
}Update details for a product group. Partial updates are allowed.
If scope is set and different from current scope, the scope is changed for product group and all children for this product group.
Reference to a ProductGroup.
^[A-Za-z0-9-_]+Reference to a tenant.
^[A-Za-z0-9-_]+^[A-Za-z0-9-_]*| ENUM | Description |
|---|---|
| SALE | Sale product scope. Default |
| SERVICE | Service product scope |
| NO_SEARCH | Not visible in search scope |
Example response
PUT /v2/tenants/{tenantUid}/product-groups/{productGroupUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 69
{
"externalId": "text",
"name": "text",
"parentUid": "text",
"scope": "SALE"
}Example response
{
"createdAt": "2025-09-13T06:17:16.033Z",
"externalId": "text",
"lastModifiedAt": "2025-09-13T06:17:16.033Z",
"name": "text",
"parentUid": "text",
"productCount": 1,
"productGroupUid": "text",
"scope": "SALE"
}Deletes a product group. The product group has to be empty.
Reference to a ProductGroup.
^[A-Za-z0-9-_]+Reference to a tenant.
^[A-Za-z0-9-_]+No Content
No content
Forbidden
Not Found
DELETE /v2/tenants/{tenantUid}/product-groups/{productGroupUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
List all links for a product group.
Reference to a ProductGroup.
^[A-Za-z0-9-_]+Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a productGroupLinkType.
Reference to a specific page in a result set.
The number of items per page in a result set.
Defines which field the resource list is sorted by.
| ENUM | Description |
|---|---|
| ASC | Sort in ascending order |
| DESC | Sort in descending order |
Example response
GET /v2/tenants/{tenantUid}/product-groups/{productGroupUid}/links HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Example response
{
"items": [
{
"productGroupLinkUid": "text",
"linkType": "INSURANCE",
"productUid": "text"
}
],
"paging": {
"pageNumber": 1,
"pageSize": 1,
"totalCount": 1
}
}Create new link to a product group
Require role tenant admin
Reference to a ProductGroup.
^[A-Za-z0-9-_]+Reference to a tenant.
^[A-Za-z0-9-_]+^[A-Za-z0-9-_]+^[A-Za-z0-9-_]+Example response
POST /v2/tenants/{tenantUid}/product-groups/{productGroupUid}/links HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 73
{
"linkType": "INSURANCE",
"productGroupLinkUid": "text",
"productUid": "text"
}Example response
{
"productGroupLinkUid": "text",
"linkType": "INSURANCE",
"productUid": "text"
}Get Product group link details
Reference to a ProductGroup.
^[A-Za-z0-9-_]+Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a Product group link.
^[A-Za-z0-9-_]+Example response
GET /v2/tenants/{tenantUid}/product-groups/{productGroupUid}/links/{productGroupLinkUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Example response
{
"productGroupLinkUid": "text",
"linkType": "INSURANCE",
"productUid": "text"
}Delete a product group link
Require role tenant admin
Reference to a ProductGroup.
^[A-Za-z0-9-_]+Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a Product group link.
^[A-Za-z0-9-_]+No Content
No content
DELETE /v2/tenants/{tenantUid}/product-groups/{productGroupUid}/links/{productGroupLinkUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No Content
No content
Was this helpful?