ProductGroup

PreviousProduct NextProductMedia

Was this helpful?

Get productgroup details

get

Get details for a product group.

Authorizations

Path parameters

productGroupUidstringrequired

Reference to a ProductGroup.

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

tenantUidstringrequired

Reference to a tenant.

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

Responses

application/json

objectoptional

get

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

200

Example response

{
  "createdAt": "2025-04-18T01:37:26.090Z",
  "externalId": "text",
  "lastModifiedAt": "2025-04-18T01:37:26.090Z",
  "name": "text",
  "parentUid": "text",
  "productCount": 1,
  "productGroupUid": "text",
  "scope": "SALE"
}

Delete product group

delete

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

Authorizations

Path parameters

productGroupUidstringrequired

Reference to a ProductGroup.

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

tenantUidstringrequired

Reference to a tenant.

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

Responses

delete

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

List all links for a product group.

Authorizations

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.

Available options:

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

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

Get Product Group link details

get

Get Product group link details

Authorizations

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

application/json

all ofoptional

get

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

Delete a product group link

Require role tenant admin

Authorizations

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

delete

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

List product groups

get

List all product groups.

Authorizations

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

Available options:

productGroupScopesstring · enum[]optional

Filter by scope

Responses

application/json

objectoptional

get

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": "2025-04-18T01:37:26.090Z",
      "externalId": "text",
      "lastModifiedAt": "2025-04-18T01:37:26.090Z",
      "name": "text",
      "parentUid": "text",
      "productCount": 1,
      "productGroupUid": "text",
      "scope": "SALE"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Create new product group

post

Creates a new product group.

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

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

Body

all ofoptional

Responses

application/json

objectoptional

post

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

200

Example response

{
  "createdAt": "2025-04-18T01:37:26.090Z",
  "externalId": "text",
  "lastModifiedAt": "2025-04-18T01:37:26.090Z",
  "name": "text",
  "parentUid": "text",
  "productCount": 1,
  "productGroupUid": "text",
  "scope": "SALE"
}

Update product group

put

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.

Authorizations

Path parameters

productGroupUidstringrequired

Reference to a ProductGroup.

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

tenantUidstringrequired

Reference to a tenant.

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

Body

externalIdstringoptional

namestringrequired

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

Available options:

Responses

application/json

objectoptional

put

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

200

Example response

{
  "createdAt": "2025-04-18T01:37:26.090Z",
  "externalId": "text",
  "lastModifiedAt": "2025-04-18T01:37:26.090Z",
  "name": "text",
  "parentUid": "text",
  "productCount": 1,
  "productGroupUid": "text",
  "scope": "SALE"
}

Create new link to a product group

post

Create new link to a product group

Require role tenant admin

Authorizations

Path parameters

productGroupUidstringrequired

Reference to a ProductGroup.

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

tenantUidstringrequired

Reference to a tenant.

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

Body

linkTypestring · enumrequiredAvailable options:

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

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

Responses

application/json

all ofoptional

post

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