Properties | Flow Retail Docs

Flow Retail Docs

Visit our website API Documentation

Get property details

get

Gets the details for this property.

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

propertyUidstringrequired

Reference to a product property definition

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

Responses

application/json

objectoptional

A product property that extends the product with new data. It comes in three data types; TEXT, LIST or CHECKLIST.

get

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

200

Example response

{
  "createdAt": "2025-04-18T01:24:15.603Z",
  "propertyName": "text",
  "lastModifiedAt": "2025-04-18T01:24:15.603Z",
  "propertyUid": "text",
  "type": "TEXT",
  "externalId": "text"
}

Delete a property

delete

Deletes a property.

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

propertyUidstringrequired

Reference to a product property definition

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

Responses

delete

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

204

No Content

List property options

get

List all options available on this property.

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

propertyUidstringrequired

Reference to a product property definition

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

objectoptional

get

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

200

Example response

{
  "items": [
    {
      "createdAt": "2025-04-18T01:24:15.603Z",
      "lastModifiedAt": "2025-04-18T01:24:15.603Z",
      "propertyUid": "text",
      "propertyName": "text",
      "propertyOptionUid": "text",
      "propertyOptionName": "text",
      "externalId": "text"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Get property option details

get

Get details for the property option.

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

propertyUidstringrequired

Reference to a product property definition

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

propertyOptionUidstringrequired

Reference to an allowed option of a product property definition

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

Responses

application/json

objectoptional

An pre-defined, allowed value for a list or checklist property.

get

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

200

Example response

{
  "createdAt": "2025-04-18T01:24:15.603Z",
  "lastModifiedAt": "2025-04-18T01:24:15.603Z",
  "propertyUid": "text",
  "propertyName": "text",
  "propertyOptionUid": "text",
  "propertyOptionName": "text",
  "externalId": "text"
}

Delete a property option

delete

Delete a property option.

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

propertyUidstringrequired

Reference to a product property definition

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

propertyOptionUidstringrequired

Reference to an allowed option of a product property definition

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

Responses

delete

DELETE /v2/tenants/{tenantUid}/properties/{propertyUid}/options/{propertyOptionUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

No Content

List properties

get

List all properties.

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:

Responses

application/json

objectoptional

get

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

200

Example response

{
  "items": [
    {
      "createdAt": "2025-04-18T01:24:15.603Z",
      "propertyName": "text",
      "lastModifiedAt": "2025-04-18T01:24:15.603Z",
      "propertyUid": "text",
      "type": "TEXT",
      "externalId": "text"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Create a new property

post

Create a new property.

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

Body

A product property that extends the product with new data. It comes in three data types; TEXT, LIST or CHECKLIST.

propertyNamestringrequired

typestring · enumrequired

Describes the type of property a product can have.

ENUM	Description
TEXT	A single text line such as an URL to a product manual or a reminder to the cashier/salesperson.
SINGLESELECT	A list of values where a product can only have one at any given time.
MULTISELECT	A list of values where a product can have none or several at any given time.

Available options:

externalIdstringoptional

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

Responses

application/json

objectoptional

A product property that extends the product with new data. It comes in three data types; TEXT, LIST or CHECKLIST.

post

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

{
  "propertyName": "text",
  "type": "TEXT",
  "externalId": "text",
  "propertyUid": "text"
}

200

Example response

{
  "createdAt": "2025-04-18T01:24:15.603Z",
  "propertyName": "text",
  "lastModifiedAt": "2025-04-18T01:24:15.603Z",
  "propertyUid": "text",
  "type": "TEXT",
  "externalId": "text"
}

Search for properties

post

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

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

propertyNamestringoptional

typestring · enumoptional

Describes the type of property a product can have.

ENUM	Description
TEXT	A single text line such as an URL to a product manual or a reminder to the cashier/salesperson.
SINGLESELECT	A list of values where a product can only have one at any given time.
MULTISELECT	A list of values where a product can have none or several at any given time.

Available options:

externalIdstringoptional

Responses

application/json

objectoptional

post

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

{
  "propertyName": "text",
  "type": "TEXT",
  "externalId": "text"
}

200

Example response

{
  "items": [
    {
      "createdAt": "2025-04-18T01:24:15.603Z",
      "propertyName": "text",
      "lastModifiedAt": "2025-04-18T01:24:15.603Z",
      "propertyUid": "text",
      "type": "TEXT",
      "externalId": "text"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Update property details

put

Updates the details for this property.

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

propertyUidstringrequired

Reference to a product property definition

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

Body

Update name and externalId for a property

propertyNamestringoptional

externalIdstringoptional

Responses

application/json

objectoptional

A product property that extends the product with new data. It comes in three data types; TEXT, LIST or CHECKLIST.

put

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

{
  "propertyName": "text",
  "externalId": "text"
}

200

Example response

{
  "createdAt": "2025-04-18T01:24:15.603Z",
  "propertyName": "text",
  "lastModifiedAt": "2025-04-18T01:24:15.603Z",
  "propertyUid": "text",
  "type": "TEXT",
  "externalId": "text"
}

Create a new property option

post

Create a new option for this property.

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

propertyUidstringrequired

Reference to a product property definition

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

Body

all ofoptional

An pre-defined, allowed value for a list or checklist property.

Responses

application/json

objectoptional

An pre-defined, allowed value for a list or checklist property.

post

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

{
  "propertyOptionName": "text",
  "externalId": "text",
  "propertyOptionUid": "text"
}

200

Example response

{
  "createdAt": "2025-04-18T01:24:15.603Z",
  "lastModifiedAt": "2025-04-18T01:24:15.603Z",
  "propertyUid": "text",
  "propertyName": "text",
  "propertyOptionUid": "text",
  "propertyOptionName": "text",
  "externalId": "text"
}

Update property option details

put

Update details of the property option.

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

propertyUidstringrequired

Reference to a product property definition

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

propertyOptionUidstringrequired

Reference to an allowed option of a product property definition

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

Body

An pre-defined, allowed value for a list or checklist property.

propertyOptionNamestringrequired

externalIdstringoptional

Responses

application/json

objectoptional

An pre-defined, allowed value for a list or checklist property.

put

PUT /v2/tenants/{tenantUid}/properties/{propertyUid}/options/{propertyOptionUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 49

{
  "propertyOptionName": "text",
  "externalId": "text"
}

200

Example response

{
  "createdAt": "2025-04-18T01:24:15.603Z",
  "lastModifiedAt": "2025-04-18T01:24:15.603Z",
  "propertyUid": "text",
  "propertyName": "text",
  "propertyOptionUid": "text",
  "propertyOptionName": "text",
  "externalId": "text"
}