ProductGroup

ProductGroup

List product groups

get

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/product-groups

List all product groups.

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

Query parameters

productGroupNamestringOptional

Reference to the name of a product group.

productGroupExternalIdstringOptional

External reference to a product group.

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:

productGroupParentUidstringOptional

Reference to parent UID, or blank to get the root categories

Responses

200

List of product groups

application/json

get/tenants/{tenantUid}/product-groups

HTTPcURLJavaScriptPython

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

200

List of product groups

{
  "items": [
    {
      "createdAt": "2026-07-20T03:49:45.422Z",
      "externalId": "text",
      "lastModifiedAt": "2026-07-20T03:49:45.422Z",
      "name": "text",
      "parentUid": "text",
      "productCount": 1,
      "productGroupUid": "text",
      "scope": "SALE"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Create new product group

post

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/product-groups

Creates a new product group.

If parentUid is set and no scope is set, the new product group inherits scope from parent.

Required permissions: PRODUCT_GROUP

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

Body

application/json

namestringRequired

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

externalIdstringOptional

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

scopestring · enum · min: 1Optional

ENUM	Description
SALE	Sale product scope. Default
SERVICE	Service product scope
NO_SEARCH	Not visible in search scope

Possible values:

Responses

200

Example response

application/json

createdAtstring · date-timeRequired

externalIdstringRequired

lastModifiedAtstring · date-timeRequired

namestringRequired

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

productCountintegerRequired

Number of products in this productGroup.

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

scopestring · enum · min: 1Required

ENUM	Description
SALE	Sale product scope. Default
SERVICE	Service product scope
NO_SEARCH	Not visible in search scope

Possible values:

post/tenants/{tenantUid}/product-groups

HTTPcURLJavaScriptPython

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

{
  "name": "text",
  "productGroupUid": "text",
  "externalId": "text",
  "parentUid": "text",
  "scope": "SALE"
}

200

Example response

{
  "createdAt": "2026-07-20T03:49:45.422Z",
  "externalId": "text",
  "lastModifiedAt": "2026-07-20T03:49:45.422Z",
  "name": "text",
  "parentUid": "text",
  "productCount": 1,
  "productGroupUid": "text",
  "scope": "SALE"
}

Get productgroup details

get

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/product-groups/{productGroupUid}

Get details for a product group.

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

productGroupUidstringRequired

Reference to a ProductGroup.

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

tenantUidstringRequired

Reference to a tenant.

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

Responses

200

Example response

application/json

createdAtstring · date-timeRequired

externalIdstringRequired

lastModifiedAtstring · date-timeRequired

namestringRequired

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

productCountintegerRequired

Number of products in this productGroup.

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

scopestring · enum · min: 1Required

ENUM	Description
SALE	Sale product scope. Default
SERVICE	Service product scope
NO_SEARCH	Not visible in search scope

Possible values:

get/tenants/{tenantUid}/product-groups/{productGroupUid}

HTTPcURLJavaScriptPython

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

200

Example response

{
  "createdAt": "2026-07-20T03:49:45.422Z",
  "externalId": "text",
  "lastModifiedAt": "2026-07-20T03:49:45.422Z",
  "name": "text",
  "parentUid": "text",
  "productCount": 1,
  "productGroupUid": "text",
  "scope": "SALE"
}

Update product group

put

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/product-groups/{productGroupUid}

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.

On parent UID field:

• Set to a valid product group UID to move under a new parent.

• Set to empty string to remove the parent and make the product group a root group.

• Omit to keep the current parent.

Required permissions: PRODUCT_GROUP

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

productGroupUidstringRequired

Reference to a ProductGroup.

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

tenantUidstringRequired

Reference to a tenant.

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

Body

application/json

namestringOptional

externalIdstringOptional

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

scopestring · enum · min: 1Optional

ENUM	Description
SALE	Sale product scope. Default
SERVICE	Service product scope
NO_SEARCH	Not visible in search scope

Possible values:

Responses

200

Example response

application/json

createdAtstring · date-timeRequired

externalIdstringRequired

lastModifiedAtstring · date-timeRequired

namestringRequired

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

productCountintegerRequired

Number of products in this productGroup.

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

scopestring · enum · min: 1Required

ENUM	Description
SALE	Sale product scope. Default
SERVICE	Service product scope
NO_SEARCH	Not visible in search scope

Possible values:

put/tenants/{tenantUid}/product-groups/{productGroupUid}

HTTPcURLJavaScriptPython

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

{
  "name": "text",
  "externalId": "text",
  "parentUid": "text",
  "scope": "SALE"
}

200

Example response

{
  "createdAt": "2026-07-20T03:49:45.422Z",
  "externalId": "text",
  "lastModifiedAt": "2026-07-20T03:49:45.422Z",
  "name": "text",
  "parentUid": "text",
  "productCount": 1,
  "productGroupUid": "text",
  "scope": "SALE"
}

Delete product group

delete

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/product-groups/{productGroupUid}

Deletes a product group. The product group has to be empty.

Required permissions: PRODUCT_GROUP

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

productGroupUidstringRequired

Reference to a ProductGroup.

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

tenantUidstringRequired

Reference to a tenant.

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

Responses

204

No Content

No content

403

Forbidden

404

Not Found

delete/tenants/{tenantUid}/product-groups/{productGroupUid}

HTTPcURLJavaScriptPython

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.

get

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/product-groups/{productGroupUid}/links

List all links for a product group.

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

productGroupUidstringRequired

Reference to a ProductGroup.

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

tenantUidstringRequired

Reference to a tenant.

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

Query parameters

productGroupLinkTypestring · enumOptional

Reference to a productGroupLinkType.

Possible values:

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/tenants/{tenantUid}/product-groups/{productGroupUid}/links

HTTPcURLJavaScriptPython

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

200

Example response

{
  "items": [
    {
      "productGroupLinkUid": "text",
      "linkType": "INSURANCE",
      "productUid": "text"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Create new link to a product group

post

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/product-groups/{productGroupUid}/links

Create new link to a product group

Required permissions: PRODUCT_GROUP

Authorizations

authTokenintegrationTokenaccessToken

AuthorizationstringRequired

Token received from the auth service

Path parameters

productGroupUidstringRequired

Reference to a ProductGroup.

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

tenantUidstringRequired

Reference to a tenant.

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

Body

application/json

linkTypestring · enumRequiredPossible values:

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

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

Responses

200

Example response

application/json

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

linkTypestring · enumRequiredPossible values:

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

post/tenants/{tenantUid}/product-groups/{productGroupUid}/links

HTTPcURLJavaScriptPython

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"
}

200

Example response

{
  "productGroupLinkUid": "text",
  "linkType": "INSURANCE",
  "productUid": "text"
}

Get Product Group link details

get

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/product-groups/{productGroupUid}/links/{productGroupLinkUid}

Get Product group link details

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

productGroupUidstringRequired

Reference to a ProductGroup.

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

tenantUidstringRequired

Reference to a tenant.

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

productGroupLinkUidstringRequired

Reference to a Product group link.

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

Responses

200

Example response

application/json

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

linkTypestring · enumRequiredPossible values:

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

get/tenants/{tenantUid}/product-groups/{productGroupUid}/links/{productGroupLinkUid}

HTTPcURLJavaScriptPython

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

200

Example response

{
  "productGroupLinkUid": "text",
  "linkType": "INSURANCE",
  "productUid": "text"
}

Delete a product group link

delete

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/product-groups/{productGroupUid}/links/{productGroupLinkUid}

Delete a product group link

Required permissions: PRODUCT_GROUP

Authorizations

authTokenintegrationTokenaccessToken

AuthorizationstringRequired

Token received from the auth service

Path parameters

productGroupUidstringRequired

Reference to a ProductGroup.

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

tenantUidstringRequired

Reference to a tenant.

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

productGroupLinkUidstringRequired

Reference to a Product group link.

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

Responses

204

No Content

No content

delete/tenants/{tenantUid}/product-groups/{productGroupUid}/links/{productGroupLinkUid}

HTTPcURLJavaScriptPython

DELETE /v2/tenants/{tenantUid}/product-groups/{productGroupUid}/links/{productGroupLinkUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

No Content

No content