Product | Flow Retail Docs

Flow Retail Docs

Visit our website API Documentation

Get brand details

get

Get details for a brand.

Required permission: TENANT.ACCESS

Authorizations

Path parameters

brandUidstringrequired

Reference to a Brand.

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

tenantUidstringrequired

Reference to a tenant.

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

Responses

application/json

objectoptional

get

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

200

Brand

{
  "brandUid": "text",
  "createdAt": "2025-04-18T01:19:41.116Z",
  "externalId": "text",
  "lastModifiedAt": "2025-04-18T01:19:41.116Z",
  "name": "text"
}

Delete a brand

delete

Deletes the a brand.

Required permission: TENANT.BACKOFFICE

Authorizations

Path parameters

brandUidstringrequired

Reference to a Brand.

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

tenantUidstringrequired

Reference to a tenant.

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

Responses

delete

DELETE /v2/tenants/{tenantUid}/brands/{brandUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No Content

List products

get

Lists all products.

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

Query parameters

productNamestringoptional

Reference to the name of a product.

productBrandUidstringoptional

Reference to a Brand uid.

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

productGroupUidstringoptional

Reference to a ProductGroup uid.

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

productExternalIdstringoptional

External reference to a product.

productPropertyUidsstring[]optional

Reference to a list of propertyUids.

productPropertyOptionUidsstring[]optional

Reference to a list of property 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:

excludeVariantsbooleanoptional

Exclude product variants.

includeDiscontinuedbooleanoptional

Include discontinued products

visibilitystring · enum[]optional

Filter on visibility

hideNotAllowPurchasebooleanoptional

when true, only show products with allowPurchase = true

Responses

application/json

objectoptional

get

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

200

Example response

{
  "items": [
    {
      "allowAddon": true,
      "allowCredit": true,
      "allowPurchase": true,
      "allowQuantity": true,
      "allowSale": "YES",
      "allowSaleDate": "2025-04-18T01:19:41.116Z",
      "allowDelivery": "YES",
      "allowDeliveryDate": "2025-04-18T01:19:41.116Z",
      "availableForWeb": true,
      "brandUid": "text",
      "brandName": "text",
      "calculationFactor": 1,
      "categoryUids": [
        "text"
      ],
      "createdAt": "2025-04-18T01:19:41.116Z",
      "customerAgeRestriction": 1,
      "description": "text",
      "discontinuedFrom": "2025-04-18T01:19:41.116Z",
      "externalId": "text",
      "externalInfo": "text",
      "externalUrl": "text",
      "gtins": [
        {
          "gtin": "text",
          "primary": true,
          "type": "text"
        }
      ],
      "height": 1,
      "internalInfo": "text",
      "lastModifiedAt": "2025-04-18T01:19:41.116Z",
      "ledgerNumber": "text",
      "length": 1,
      "name": "text",
      "optionProperties": [
        {
          "productPropertyUid": "text",
          "propertyName": "text",
          "propertyOptionName": "text",
          "propertyType": "TEXT",
          "propertyText": "text",
          "propertyUid": "text",
          "propertyOptionUid": "text",
          "required": true
        }
      ],
      "priceOverride": true,
      "productGroupUid": "text",
      "productGroupPath": [
        {
          "name": "text",
          "parentUid": "text",
          "productGroupUid": "text"
        }
      ],
      "productUid": "text",
      "productType": "STOCK",
      "recommendedRetailPrice": 1,
      "requiredVariantPropertyUids": [
        "text"
      ],
      "serialNoRequired": "NO",
      "shortDescription": "text",
      "sku": "text",
      "manufacturerSku": "text",
      "suppliers": [
        {
          "name": "text",
          "supplierUid": "text"
        }
      ],
      "textProperties": [
        {
          "productPropertyUid": "text",
          "propertyName": "text",
          "propertyOptionName": "text",
          "propertyType": "TEXT",
          "propertyText": "text",
          "propertyUid": "text",
          "propertyOptionUid": "text",
          "required": true
        }
      ],
      "unitLabel": "text",
      "variantProductUids": [
        "text"
      ],
      "variantParentProductUid": "text",
      "vatCodeUid": "text",
      "weight": 1,
      "width": 1,
      "links": [
        {
          "productLinkUid": "text",
          "linkType": "INSURANCE",
          "productUid": "text"
        }
      ],
      "parents": [
        {
          "productLinkUid": "text",
          "linkType": "INSURANCE",
          "productUid": "text"
        }
      ],
      "requirements": {
        "requireCustomer": true,
        "requireCustomerMobile": true,
        "requireCustomerEmail": true,
        "requireCustomerDeliveryAddress": true
      },
      "coverImage": {
        "productMediaUid": "text",
        "mainUrl": "text",
        "thumbnailUrl": "text"
      },
      "imageCount": 1,
      "relevance": 1,
      "visibility": "ALWAYS_VISIBLE",
      "commission": 1,
      "productWarrantyUid": "text",
      "excludeFromStatistics": true,
      "purchasePrice": 1,
      "numberOfPieces": 1,
      "limitToStoreUids": [
        "text"
      ]
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Get product details

get

Get details for a product.

Authorizations

Path parameters

productUidstringrequired

Reference to a Product.

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

tenantUidstringrequired

Reference to a tenant.

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

Responses

application/json

objectoptional

get

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

200

Example response

{
  "allowAddon": true,
  "allowCredit": true,
  "allowPurchase": true,
  "allowQuantity": true,
  "allowSale": "YES",
  "allowSaleDate": "2025-04-18T01:19:41.116Z",
  "allowDelivery": "YES",
  "allowDeliveryDate": "2025-04-18T01:19:41.116Z",
  "availableForWeb": true,
  "brandUid": "text",
  "brandName": "text",
  "calculationFactor": 1,
  "categoryUids": [
    "text"
  ],
  "createdAt": "2025-04-18T01:19:41.116Z",
  "customerAgeRestriction": 1,
  "description": "text",
  "discontinuedFrom": "2025-04-18T01:19:41.116Z",
  "externalId": "text",
  "externalInfo": "text",
  "externalUrl": "text",
  "gtins": [
    {
      "gtin": "text",
      "primary": true,
      "type": "text"
    }
  ],
  "height": 1,
  "internalInfo": "text",
  "lastModifiedAt": "2025-04-18T01:19:41.116Z",
  "ledgerNumber": "text",
  "length": 1,
  "name": "text",
  "optionProperties": [
    {
      "productPropertyUid": "text",
      "propertyName": "text",
      "propertyOptionName": "text",
      "propertyType": "TEXT",
      "propertyText": "text",
      "propertyUid": "text",
      "propertyOptionUid": "text",
      "required": true
    }
  ],
  "priceOverride": true,
  "productGroupUid": "text",
  "productGroupPath": [
    {
      "name": "text",
      "parentUid": "text",
      "productGroupUid": "text"
    }
  ],
  "productUid": "text",
  "productType": "STOCK",
  "recommendedRetailPrice": 1,
  "requiredVariantPropertyUids": [
    "text"
  ],
  "serialNoRequired": "NO",
  "shortDescription": "text",
  "sku": "text",
  "manufacturerSku": "text",
  "suppliers": [
    {
      "name": "text",
      "supplierUid": "text"
    }
  ],
  "textProperties": [
    {
      "productPropertyUid": "text",
      "propertyName": "text",
      "propertyOptionName": "text",
      "propertyType": "TEXT",
      "propertyText": "text",
      "propertyUid": "text",
      "propertyOptionUid": "text",
      "required": true
    }
  ],
  "unitLabel": "text",
  "variantProductUids": [
    "text"
  ],
  "variantParentProductUid": "text",
  "vatCodeUid": "text",
  "weight": 1,
  "width": 1,
  "links": [
    {
      "productLinkUid": "text",
      "linkType": "INSURANCE",
      "productUid": "text"
    }
  ],
  "parents": [
    {
      "productLinkUid": "text",
      "linkType": "INSURANCE",
      "productUid": "text"
    }
  ],
  "requirements": {
    "requireCustomer": true,
    "requireCustomerMobile": true,
    "requireCustomerEmail": true,
    "requireCustomerDeliveryAddress": true
  },
  "coverImage": {
    "productMediaUid": "text",
    "mainUrl": "text",
    "thumbnailUrl": "text"
  },
  "imageCount": 1,
  "relevance": 1,
  "visibility": "ALWAYS_VISIBLE",
  "commission": 1,
  "productWarrantyUid": "text",
  "excludeFromStatistics": true,
  "purchasePrice": 1,
  "numberOfPieces": 1,
  "limitToStoreUids": [
    "text"
  ]
}

Delete a product

delete

Deletes a product.

Authorizations

Path parameters

productUidstringrequired

Reference to a Product.

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

tenantUidstringrequired

Reference to a tenant.

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

Responses

delete

DELETE /v2/tenants/{tenantUid}/products/{productUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

No Content

List all addons for a product and productLinkType

get

List all addons for a product and productLinkType

Authorizations

Path parameters

productUidstringrequired

Reference to a Product.

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

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:

productLinkTypestring · enumoptional

Reference to a productLinkType.

Available options:

Responses

application/json

objectoptional

get

GET /v2/tenants/{tenantUid}/products/{productUid}/addons HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "items": [
    {
      "productLinkType": "INSURANCE",
      "allowAddon": true,
      "allowCredit": true,
      "allowPurchase": true,
      "allowQuantity": true,
      "allowSale": "YES",
      "allowSaleDate": "2025-04-18T01:19:41.116Z",
      "allowDelivery": "YES",
      "allowDeliveryDate": "2025-04-18T01:19:41.116Z",
      "availableForWeb": true,
      "brandUid": "text",
      "brandName": "text",
      "calculationFactor": 1,
      "categoryUids": [
        "text"
      ],
      "createdAt": "2025-04-18T01:19:41.116Z",
      "customerAgeRestriction": 1,
      "description": "text",
      "discontinuedFrom": "2025-04-18T01:19:41.116Z",
      "externalId": "text",
      "externalInfo": "text",
      "externalUrl": "text",
      "gtins": [
        {
          "gtin": "text",
          "primary": true,
          "type": "text"
        }
      ],
      "height": 1,
      "internalInfo": "text",
      "lastModifiedAt": "2025-04-18T01:19:41.116Z",
      "ledgerNumber": "text",
      "length": 1,
      "name": "text",
      "optionProperties": [
        {
          "productPropertyUid": "text",
          "propertyName": "text",
          "propertyOptionName": "text",
          "propertyType": "TEXT",
          "propertyText": "text",
          "propertyUid": "text",
          "propertyOptionUid": "text",
          "required": true
        }
      ],
      "priceOverride": true,
      "productGroupUid": "text",
      "productGroupPath": [
        {
          "name": "text",
          "parentUid": "text",
          "productGroupUid": "text"
        }
      ],
      "productUid": "text",
      "productType": "STOCK",
      "recommendedRetailPrice": 1,
      "requiredVariantPropertyUids": [
        "text"
      ],
      "serialNoRequired": "NO",
      "shortDescription": "text",
      "sku": "text",
      "manufacturerSku": "text",
      "suppliers": [
        {
          "name": "text",
          "supplierUid": "text"
        }
      ],
      "textProperties": [
        {
          "productPropertyUid": "text",
          "propertyName": "text",
          "propertyOptionName": "text",
          "propertyType": "TEXT",
          "propertyText": "text",
          "propertyUid": "text",
          "propertyOptionUid": "text",
          "required": true
        }
      ],
      "unitLabel": "text",
      "variantProductUids": [
        "text"
      ],
      "variantParentProductUid": "text",
      "vatCodeUid": "text",
      "weight": 1,
      "width": 1,
      "links": [
        {
          "productLinkUid": "text",
          "linkType": "INSURANCE",
          "productUid": "text"
        }
      ],
      "parents": [
        {
          "productLinkUid": "text",
          "linkType": "INSURANCE",
          "productUid": "text"
        }
      ],
      "requirements": {
        "requireCustomer": true,
        "requireCustomerMobile": true,
        "requireCustomerEmail": true,
        "requireCustomerDeliveryAddress": true
      },
      "coverImage": {
        "productMediaUid": "text",
        "mainUrl": "text",
        "thumbnailUrl": "text"
      },
      "imageCount": 1,
      "relevance": 1,
      "visibility": "ALWAYS_VISIBLE",
      "commission": 1,
      "productWarrantyUid": "text",
      "excludeFromStatistics": true,
      "purchasePrice": 1,
      "numberOfPieces": 1,
      "limitToStoreUids": [
        "text"
      ]
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

List all links for a product.

get

List all links for a product.

Authorizations

Path parameters

productUidstringrequired

Reference to a Product.

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

tenantUidstringrequired

Reference to a tenant.

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

Query parameters

productLinkTypestring · enumoptional

Reference to a productLinkType.

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}/products/{productUid}/links HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

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

List all parent links for a product.

get

List all parent links for a product.

Authorizations

Path parameters

productUidstringrequired

Reference to a Product.

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

tenantUidstringrequired

Reference to a tenant.

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

Query parameters

productLinkTypestring · enumoptional

Reference to a productLinkType.

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}/products/{productUid}/links/parents HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

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

Get Product link details

get

Get Product link details

Authorizations

Path parameters

productUidstringrequired

Reference to a Product.

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

tenantUidstringrequired

Reference to a tenant.

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

productLinkUidstringrequired

Reference to a Product link.

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

Responses

application/json

all ofoptional

get

GET /v2/tenants/{tenantUid}/products/{productUid}/links/{productLinkUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

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

Delete a product link

delete

Delete a product link

Require role tenant admin

Authorizations

Path parameters

productUidstringrequired

Reference to a Product.

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

tenantUidstringrequired

Reference to a tenant.

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

productLinkUidstringrequired

Reference to a Product link.

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

Responses

delete

DELETE /v2/tenants/{tenantUid}/products/{productUid}/links/{productLinkUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

No Content

List brands

get

List all brands.

Required permission: TENANT.ACCESS

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

Query parameters

brandNamestringoptional

Reference to the name of a brand.

brandExternalIdstringoptional

External reference to a brand.

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}/brands HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "items": [
    {
      "brandUid": "text",
      "createdAt": "2025-04-18T01:19:41.116Z",
      "externalId": "text",
      "lastModifiedAt": "2025-04-18T01:19:41.116Z",
      "name": "text"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Create a new brand

post

Create a new brand.

Required permission: TENANT.BACKOFFICE

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}/brands HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "externalId": "text",
  "name": "text",
  "brandUid": "text"
}

200

Brand

{
  "brandUid": "text",
  "createdAt": "2025-04-18T01:19:41.116Z",
  "externalId": "text",
  "lastModifiedAt": "2025-04-18T01:19:41.116Z",
  "name": "text"
}

Search brands

post

Searches for brands based on criteria set in the request body. Required permission: TENANT.ACCESS

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

Available options:

Body

exactMatchbooleanoptional

querystringoptional

Responses

application/json

objectoptional

post

POST /v2/tenants/{tenantUid}/brands/search HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 34

{
  "exactMatch": true,
  "query": "text"
}

200

Example response

{
  "items": [
    {
      "brandUid": "text",
      "createdAt": "2025-04-18T01:19:41.116Z",
      "externalId": "text",
      "lastModifiedAt": "2025-04-18T01:19:41.116Z",
      "name": "text"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Update brand details

put

Update details for a brand. Partial updates are allowed.

Required permission: TENANT.BACKOFFICE

Authorizations

Path parameters

brandUidstringrequired

Reference to a Brand.

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

tenantUidstringrequired

Reference to a tenant.

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

Body

externalIdstringoptional

namestringrequired

Responses

application/json

objectoptional

put

PUT /v2/tenants/{tenantUid}/brands/{brandUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "externalId": "text",
  "name": "text"
}

200

Brand

{
  "brandUid": "text",
  "createdAt": "2025-04-18T01:19:41.116Z",
  "externalId": "text",
  "lastModifiedAt": "2025-04-18T01:19:41.116Z",
  "name": "text"
}

Create a new product

post

CONFIGURABLEproducts must have at least one required variant property UID.

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

Body

allowCreditbooleanoptional

allowPurchasebooleanoptional

allowQuantitybooleanoptional

allowSalestring · enumoptional

ENUM	Description
YES	Allow the product to be sold
NO	Do not allow the product to be sold
NOT_BEFORE_DATE	Do not allow the product to be sold before a specified date

Available options:

allowSaleDatestring · date-timeoptional

allowDeliverystring · enumoptional

ENUM	Description
YES	Allow the product to be delivered
NO	Do not allow the product to be delivered
NOT_BEFORE_DATE	Do not allow the product to be delivered before a specified date

Available options:

allowDeliveryDatestring · date-timeoptional

availableForWebbooleanoptional

The product is available for web sale

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

calculationFactorintegeroptional

customerAgeRestrictionintegeroptional

Age restriction for the customer. 0 = no restriction

categoryUidsstring[]optional

descriptionstringoptional

discontinuedFromstring · date-timeoptional

externalIdstringoptional

externalInfostringoptional

externalUrlstringoptional

gtinsobject[]optional

heightintegeroptional

internalInfostringoptional

ledgerNumberstringoptional

Ledger number must be a valid number with possible leading zeros

lengthintegeroptional

mediaobject[]optional

namestringrequired

priceOverridebooleanoptional

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

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

productTypestring · enum · min: 1required

ENUM	Description
STOCK	Price*quantity
NO_STOCK	No quantity
CONFIGURABLE	Master configurable product
FLOWGIFTCARD	Flow Giftcard product
NON_PHYSICAL	Non physical product
PACKAGE_FIXED	Packaged product with fixed content
PACKAGE_DYNAMIC	Packaged product with dynamic content

Available options:

optionPropertiesobject[]optional

Add a new product option to a product.

textPropertiesobject[]optional

Add a new product text property to a product.

recommendedRetailPriceintegeroptional

requiredVariantPropertyUidsstring[]optional

A list of propertyUids that are required for each variant of this product.

serialNoRequiredstring · enumoptional

ENUM	Description
NO	No Serial number required
ON_SALE	Can register serial number when selling a product (Serial number is optional)
ON_RECEIVE	Must register serial number when receiving and selling product (Serial number is required)

Available options:

shortDescriptionstringoptional

skustringrequired

manufacturerSkustringoptional

unitLabelstringoptional

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

weightintegeroptional

widthintegeroptional

requirementsobjectoptional

ProductRequirementRequestSchema

commissionintegeroptional

A commission to be paid to the supplier after delivery.

visibilitystring · enumoptionalAvailable options:

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

excludeFromStatisticsbooleanoptionalDefault: false

purchasePriceintegeroptional

numberOfPiecesintegeroptional

Indicates how many packages/parts the product consists of.

limitToStoreUidsstring[]optional

Limit the product to be used for a list of storeUids.

Responses

application/json

objectoptional

post

POST /v2/tenants/{tenantUid}/products HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1478

{
  "allowCredit": true,
  "allowPurchase": true,
  "allowQuantity": true,
  "allowSale": "YES",
  "allowSaleDate": "2025-04-18T01:19:41.116Z",
  "allowDelivery": "YES",
  "allowDeliveryDate": "2025-04-18T01:19:41.116Z",
  "availableForWeb": true,
  "brandUid": "text",
  "calculationFactor": 1,
  "customerAgeRestriction": 1,
  "categoryUids": [
    "text"
  ],
  "description": "text",
  "discontinuedFrom": "2025-04-18T01:19:41.116Z",
  "externalId": "text",
  "externalInfo": "text",
  "externalUrl": "text",
  "gtins": [
    {
      "gtin": "text",
      "primary": true,
      "type": "text"
    }
  ],
  "height": 1,
  "internalInfo": "text",
  "ledgerNumber": "text",
  "length": 1,
  "media": [
    {
      "mainUrl": "text",
      "thumbnailUrl": "text",
      "position": 1,
      "setAsCoverImage": true,
      "productMediaUid": "text"
    }
  ],
  "name": "text",
  "priceOverride": true,
  "productUid": "text",
  "productGroupUid": "text",
  "productType": "STOCK",
  "optionProperties": [
    {
      "propertyUid": "text",
      "propertyOptionUid": "text",
      "productPropertyUid": "text"
    }
  ],
  "textProperties": [
    {
      "propertyUid": "text",
      "propertyText": "text",
      "productPropertyUid": "text"
    }
  ],
  "recommendedRetailPrice": 1,
  "requiredVariantPropertyUids": [
    "text"
  ],
  "serialNoRequired": "NO",
  "shortDescription": "text",
  "sku": "text",
  "manufacturerSku": "text",
  "unitLabel": "text",
  "vatCodeUid": "text",
  "weight": 1,
  "width": 1,
  "requirements": {
    "requireCustomer": true,
    "requireCustomerMobile": true,
    "requireCustomerEmail": true,
    "requireCustomerDeliveryAddress": true
  },
  "commission": 1,
  "visibility": "ALWAYS_VISIBLE",
  "productWarrantyUid": "text",
  "excludeFromStatistics": true,
  "purchasePrice": 1,
  "numberOfPieces": 1,
  "limitToStoreUids": [
    "text"
  ]
}

200

Example response

{
  "allowAddon": true,
  "allowCredit": true,
  "allowPurchase": true,
  "allowQuantity": true,
  "allowSale": "YES",
  "allowSaleDate": "2025-04-18T01:19:41.116Z",
  "allowDelivery": "YES",
  "allowDeliveryDate": "2025-04-18T01:19:41.116Z",
  "availableForWeb": true,
  "brandUid": "text",
  "brandName": "text",
  "calculationFactor": 1,
  "categoryUids": [
    "text"
  ],
  "createdAt": "2025-04-18T01:19:41.116Z",
  "customerAgeRestriction": 1,
  "description": "text",
  "discontinuedFrom": "2025-04-18T01:19:41.116Z",
  "externalId": "text",
  "externalInfo": "text",
  "externalUrl": "text",
  "gtins": [
    {
      "gtin": "text",
      "primary": true,
      "type": "text"
    }
  ],
  "height": 1,
  "internalInfo": "text",
  "lastModifiedAt": "2025-04-18T01:19:41.116Z",
  "ledgerNumber": "text",
  "length": 1,
  "name": "text",
  "optionProperties": [
    {
      "productPropertyUid": "text",
      "propertyName": "text",
      "propertyOptionName": "text",
      "propertyType": "TEXT",
      "propertyText": "text",
      "propertyUid": "text",
      "propertyOptionUid": "text",
      "required": true
    }
  ],
  "priceOverride": true,
  "productGroupUid": "text",
  "productGroupPath": [
    {
      "name": "text",
      "parentUid": "text",
      "productGroupUid": "text"
    }
  ],
  "productUid": "text",
  "productType": "STOCK",
  "recommendedRetailPrice": 1,
  "requiredVariantPropertyUids": [
    "text"
  ],
  "serialNoRequired": "NO",
  "shortDescription": "text",
  "sku": "text",
  "manufacturerSku": "text",
  "suppliers": [
    {
      "name": "text",
      "supplierUid": "text"
    }
  ],
  "textProperties": [
    {
      "productPropertyUid": "text",
      "propertyName": "text",
      "propertyOptionName": "text",
      "propertyType": "TEXT",
      "propertyText": "text",
      "propertyUid": "text",
      "propertyOptionUid": "text",
      "required": true
    }
  ],
  "unitLabel": "text",
  "variantProductUids": [
    "text"
  ],
  "variantParentProductUid": "text",
  "vatCodeUid": "text",
  "weight": 1,
  "width": 1,
  "links": [
    {
      "productLinkUid": "text",
      "linkType": "INSURANCE",
      "productUid": "text"
    }
  ],
  "parents": [
    {
      "productLinkUid": "text",
      "linkType": "INSURANCE",
      "productUid": "text"
    }
  ],
  "requirements": {
    "requireCustomer": true,
    "requireCustomerMobile": true,
    "requireCustomerEmail": true,
    "requireCustomerDeliveryAddress": true
  },
  "coverImage": {
    "productMediaUid": "text",
    "mainUrl": "text",
    "thumbnailUrl": "text"
  },
  "imageCount": 1,
  "relevance": 1,
  "visibility": "ALWAYS_VISIBLE",
  "commission": 1,
  "productWarrantyUid": "text",
  "excludeFromStatistics": true,
  "purchasePrice": 1,
  "numberOfPieces": 1,
  "limitToStoreUids": [
    "text"
  ]
}

Search products

post

Searches for products based on criteria set in the request body.

If productGroupUid is set, productGroupScopes is omitted.

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

Available options:

Body

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

exactMatchbooleanoptional

productGroupUidsstring[]optional

Filter on product group UIDs

productGroupScopesstring · enum[]optional

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

querystringoptional

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

propertyUidsstring[]optional

Filter on property UIDs a product must be linked to

propertyOptionUidsstring[]optional

Filter on property option UIDs a product must be linked to

productUidsstring[]optional

A list of productUids to search for

hideVariantsbooleanoptional

Do not search in variant products.

visibilitystring · enum[]optional

Filter on product visibility

includeDiscontinuedbooleanoptional

productTypesstring · enum[]optional

ENUM	Description
STOCK	Price*quantity
NO_STOCK	No quantity
CONFIGURABLE	Master configurable product
FLOWGIFTCARD	Flow Giftcard product
NON_PHYSICAL	Non physical product
PACKAGE_FIXED	Packaged product with fixed content
PACKAGE_DYNAMIC	Packaged product with dynamic content

hideNotAllowPurchasebooleanoptional

when true, only show products with allowPurchase = true

Responses

application/json

objectoptional

post

POST /v2/tenants/{tenantUid}/products/search HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 340

{
  "brandUid": "text",
  "exactMatch": true,
  "productGroupUids": [
    "text"
  ],
  "productGroupScopes": [
    "SALE"
  ],
  "query": "text",
  "supplierUid": "text",
  "propertyUids": [
    "text"
  ],
  "propertyOptionUids": [
    "text"
  ],
  "productUids": [
    "text"
  ],
  "hideVariants": true,
  "visibility": [
    "ALWAYS_VISIBLE"
  ],
  "includeDiscontinued": true,
  "productTypes": [
    "STOCK"
  ],
  "hideNotAllowPurchase": true
}

200

Example response

{
  "items": [
    {
      "allowAddon": true,
      "allowCredit": true,
      "allowPurchase": true,
      "allowQuantity": true,
      "allowSale": "YES",
      "allowSaleDate": "2025-04-18T01:19:41.116Z",
      "allowDelivery": "YES",
      "allowDeliveryDate": "2025-04-18T01:19:41.116Z",
      "availableForWeb": true,
      "brandUid": "text",
      "brandName": "text",
      "calculationFactor": 1,
      "categoryUids": [
        "text"
      ],
      "createdAt": "2025-04-18T01:19:41.116Z",
      "customerAgeRestriction": 1,
      "description": "text",
      "discontinuedFrom": "2025-04-18T01:19:41.116Z",
      "externalId": "text",
      "externalInfo": "text",
      "externalUrl": "text",
      "gtins": [
        {
          "gtin": "text",
          "primary": true,
          "type": "text"
        }
      ],
      "height": 1,
      "internalInfo": "text",
      "lastModifiedAt": "2025-04-18T01:19:41.116Z",
      "ledgerNumber": "text",
      "length": 1,
      "name": "text",
      "optionProperties": [
        {
          "productPropertyUid": "text",
          "propertyName": "text",
          "propertyOptionName": "text",
          "propertyType": "TEXT",
          "propertyText": "text",
          "propertyUid": "text",
          "propertyOptionUid": "text",
          "required": true
        }
      ],
      "priceOverride": true,
      "productGroupUid": "text",
      "productGroupPath": [
        {
          "name": "text",
          "parentUid": "text",
          "productGroupUid": "text"
        }
      ],
      "productUid": "text",
      "productType": "STOCK",
      "recommendedRetailPrice": 1,
      "requiredVariantPropertyUids": [
        "text"
      ],
      "serialNoRequired": "NO",
      "shortDescription": "text",
      "sku": "text",
      "manufacturerSku": "text",
      "suppliers": [
        {
          "name": "text",
          "supplierUid": "text"
        }
      ],
      "textProperties": [
        {
          "productPropertyUid": "text",
          "propertyName": "text",
          "propertyOptionName": "text",
          "propertyType": "TEXT",
          "propertyText": "text",
          "propertyUid": "text",
          "propertyOptionUid": "text",
          "required": true
        }
      ],
      "unitLabel": "text",
      "variantProductUids": [
        "text"
      ],
      "variantParentProductUid": "text",
      "vatCodeUid": "text",
      "weight": 1,
      "width": 1,
      "links": [
        {
          "productLinkUid": "text",
          "linkType": "INSURANCE",
          "productUid": "text"
        }
      ],
      "parents": [
        {
          "productLinkUid": "text",
          "linkType": "INSURANCE",
          "productUid": "text"
        }
      ],
      "requirements": {
        "requireCustomer": true,
        "requireCustomerMobile": true,
        "requireCustomerEmail": true,
        "requireCustomerDeliveryAddress": true
      },
      "coverImage": {
        "productMediaUid": "text",
        "mainUrl": "text",
        "thumbnailUrl": "text"
      },
      "imageCount": 1,
      "relevance": 1,
      "visibility": "ALWAYS_VISIBLE",
      "commission": 1,
      "productWarrantyUid": "text",
      "excludeFromStatistics": true,
      "purchasePrice": 1,
      "numberOfPieces": 1,
      "limitToStoreUids": [
        "text"
      ]
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Print operations for products

post

Do product-specific prints

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

productUidstringrequired

Reference to a Product.

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

Body

The printerUid will be required when the peripheralUid is removed.

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

typestring · enum · min: 1required

ENUM	Description
BARCODE	Print barcode labels

Available options:

templatestringrequired

Must be a valid template name from /v2/metadata/labels

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

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

copiesintegeroptional

serialnumbersstring[]optional

Prints a label for each serial number, appending the serial number as barcode and plain text.

Responses

post

POST /v2/tenants/{tenantUid}/products/{productUid}/print HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 110

{
  "storeUid": "text",
  "type": "BARCODE",
  "template": "text",
  "printerUid": "text",
  "copies": 1,
  "serialnumbers": [
    "text"
  ]
}

204

No Content

Update product details

put

Partial updates are allowed. On CONFIGURABLEproducts, the required variant property UID's can only be changed while no variant products have been added.

Authorizations

Path parameters

productUidstringrequired

Reference to a Product.

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

tenantUidstringrequired

Reference to a tenant.

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

Body

allowCreditbooleanoptional

allowPurchasebooleanoptional

allowQuantitybooleanoptional

allowSalestring · enumoptional

ENUM	Description
YES	Allow the product to be sold
NO	Do not allow the product to be sold
NOT_BEFORE_DATE	Do not allow the product to be sold before a specified date

Available options:

allowSaleDatestring · date-timeoptional

allowDeliverystring · enumoptional

ENUM	Description
YES	Allow the product to be delivered
NO	Do not allow the product to be delivered
NOT_BEFORE_DATE	Do not allow the product to be delivered before a specified date

Available options:

allowDeliveryDatestring · date-timeoptional

availableForWebbooleanoptional

The product is available for web sale

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

calculationFactorintegeroptional

categoryUidsstring[]optional

customerAgeRestrictionintegeroptional

Age restriction for the customer. 0 = no restriction

descriptionstringoptional

discontinuedFromstring · date-time | nullableoptional

externalIdstringoptional

externalInfostringoptional

externalUrlstringoptional

gtinsobject[]optional

heightintegeroptional

internalInfostringoptional

ledgerNumberstringoptional

Ledger number must be a valid number with possible leading zeros

lengthintegeroptional

namestringoptional

priceOverridebooleanoptional

Allow to override the price on an order

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

recommendedRetailPriceintegeroptional

serialNoRequiredstring · enumoptional

ENUM	Description
NO	No Serial number required
ON_SALE	Can register serial number when selling a product (Serial number is optional)
ON_RECEIVE	Must register serial number when receiving and selling product (Serial number is required)

Available options:

requiredVariantPropertyUidsstring[]optional

shortDescriptionstringoptional

skustringoptional

manufacturerSkustringoptional

textPropertiesobject[]optional

Update a text property on a product.

unitLabelstringoptional

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

weightintegeroptional

widthintegeroptional

requirementsobjectoptional

ProductRequirementRequestSchema

coverImageobjectoptional

commissionintegeroptional

A commission to be paid to the supplier after delivery.

visibilitystring · enumoptionalAvailable options:

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

excludeFromStatisticsbooleanoptional

purchasePriceintegeroptional

numberOfPiecesintegeroptional

Indicates how many packages/parts the product consists of.

limitToStoreUidsstring[]optional

Limit the product to be used for a list of storeUids.

Responses

application/json

objectoptional

put

PUT /v2/tenants/{tenantUid}/products/{productUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1237

{
  "allowCredit": true,
  "allowPurchase": true,
  "allowQuantity": true,
  "allowSale": "YES",
  "allowSaleDate": "2025-04-18T01:19:41.116Z",
  "allowDelivery": "YES",
  "allowDeliveryDate": "2025-04-18T01:19:41.116Z",
  "availableForWeb": true,
  "brandUid": "text",
  "calculationFactor": 1,
  "categoryUids": [
    "text"
  ],
  "customerAgeRestriction": 1,
  "description": "text",
  "discontinuedFrom": "2025-04-18T01:19:41.116Z",
  "externalId": "text",
  "externalInfo": "text",
  "externalUrl": "text",
  "gtins": [
    {
      "gtin": "text",
      "primary": true,
      "type": "text"
    }
  ],
  "height": 1,
  "internalInfo": "text",
  "ledgerNumber": "text",
  "length": 1,
  "name": "text",
  "priceOverride": true,
  "productGroupUid": "text",
  "recommendedRetailPrice": 1,
  "serialNoRequired": "NO",
  "requiredVariantPropertyUids": [
    "text"
  ],
  "shortDescription": "text",
  "sku": "text",
  "manufacturerSku": "text",
  "textProperties": [
    {
      "propertyUid": "text",
      "propertyText": "text"
    }
  ],
  "unitLabel": "text",
  "vatCodeUid": "text",
  "weight": 1,
  "width": 1,
  "requirements": {
    "requireCustomer": true,
    "requireCustomerMobile": true,
    "requireCustomerEmail": true,
    "requireCustomerDeliveryAddress": true
  },
  "coverImage": {
    "productMediaUid": "text"
  },
  "commission": 1,
  "visibility": "ALWAYS_VISIBLE",
  "productWarrantyUid": "text",
  "excludeFromStatistics": true,
  "purchasePrice": 1,
  "numberOfPieces": 1,
  "limitToStoreUids": [
    "text"
  ]
}

200

Example response

{
  "allowAddon": true,
  "allowCredit": true,
  "allowPurchase": true,
  "allowQuantity": true,
  "allowSale": "YES",
  "allowSaleDate": "2025-04-18T01:19:41.116Z",
  "allowDelivery": "YES",
  "allowDeliveryDate": "2025-04-18T01:19:41.116Z",
  "availableForWeb": true,
  "brandUid": "text",
  "brandName": "text",
  "calculationFactor": 1,
  "categoryUids": [
    "text"
  ],
  "createdAt": "2025-04-18T01:19:41.116Z",
  "customerAgeRestriction": 1,
  "description": "text",
  "discontinuedFrom": "2025-04-18T01:19:41.116Z",
  "externalId": "text",
  "externalInfo": "text",
  "externalUrl": "text",
  "gtins": [
    {
      "gtin": "text",
      "primary": true,
      "type": "text"
    }
  ],
  "height": 1,
  "internalInfo": "text",
  "lastModifiedAt": "2025-04-18T01:19:41.116Z",
  "ledgerNumber": "text",
  "length": 1,
  "name": "text",
  "optionProperties": [
    {
      "productPropertyUid": "text",
      "propertyName": "text",
      "propertyOptionName": "text",
      "propertyType": "TEXT",
      "propertyText": "text",
      "propertyUid": "text",
      "propertyOptionUid": "text",
      "required": true
    }
  ],
  "priceOverride": true,
  "productGroupUid": "text",
  "productGroupPath": [
    {
      "name": "text",
      "parentUid": "text",
      "productGroupUid": "text"
    }
  ],
  "productUid": "text",
  "productType": "STOCK",
  "recommendedRetailPrice": 1,
  "requiredVariantPropertyUids": [
    "text"
  ],
  "serialNoRequired": "NO",
  "shortDescription": "text",
  "sku": "text",
  "manufacturerSku": "text",
  "suppliers": [
    {
      "name": "text",
      "supplierUid": "text"
    }
  ],
  "textProperties": [
    {
      "productPropertyUid": "text",
      "propertyName": "text",
      "propertyOptionName": "text",
      "propertyType": "TEXT",
      "propertyText": "text",
      "propertyUid": "text",
      "propertyOptionUid": "text",
      "required": true
    }
  ],
  "unitLabel": "text",
  "variantProductUids": [
    "text"
  ],
  "variantParentProductUid": "text",
  "vatCodeUid": "text",
  "weight": 1,
  "width": 1,
  "links": [
    {
      "productLinkUid": "text",
      "linkType": "INSURANCE",
      "productUid": "text"
    }
  ],
  "parents": [
    {
      "productLinkUid": "text",
      "linkType": "INSURANCE",
      "productUid": "text"
    }
  ],
  "requirements": {
    "requireCustomer": true,
    "requireCustomerMobile": true,
    "requireCustomerEmail": true,
    "requireCustomerDeliveryAddress": true
  },
  "coverImage": {
    "productMediaUid": "text",
    "mainUrl": "text",
    "thumbnailUrl": "text"
  },
  "imageCount": 1,
  "relevance": 1,
  "visibility": "ALWAYS_VISIBLE",
  "commission": 1,
  "productWarrantyUid": "text",
  "excludeFromStatistics": true,
  "purchasePrice": 1,
  "numberOfPieces": 1,
  "limitToStoreUids": [
    "text"
  ]
}

Create new product link

post

Create new product link

Require role tenant admin

Authorizations

Path parameters

productUidstringrequired

Reference to a Product.

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

tenantUidstringrequired

Reference to a tenant.

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

Body

linkTypestring · enumrequiredAvailable options:

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

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

Responses

application/json

all ofoptional

post

POST /v2/tenants/{tenantUid}/products/{productUid}/links HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 68

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

200

Example response

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

Get new generated SKU

post

Get new generated SKU.

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

Body

typestring · enumrequiredAvailable options:

Responses

application/json

objectoptional

post

POST /v2/tenants/{tenantUid}/products/sku HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "type": "NUMERIC"
}

201

Example response

{
  "generatedSku": "text",
  "type": "NUMERIC"
}