Properties
Properties
List all properties.
Reference to a tenant.
^[A-Za-z0-9-_]+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}/properties HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Example response
{
"items": [
{
"createdAt": "2025-10-29T00:34:24.661Z",
"propertyName": "text",
"lastModifiedAt": "2025-10-29T00:34:24.661Z",
"propertyUid": "text",
"type": "TEXT",
"externalId": "text"
}
],
"paging": {
"pageNumber": 1,
"pageSize": 1,
"totalCount": 1
}
}Create a new property.
Reference to a tenant.
^[A-Za-z0-9-_]+A product property that extends the product with new data. It comes in three data types; TEXT, LIST or CHECKLIST.
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. |
^[A-Za-z0-9-_]+Example response
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"
}Example response
{
"createdAt": "2025-10-29T00:34:24.661Z",
"propertyName": "text",
"lastModifiedAt": "2025-10-29T00:34:24.661Z",
"propertyUid": "text",
"type": "TEXT",
"externalId": "text"
}Searches for properties based on criteria set in the request body.
Reference to a tenant.
^[A-Za-z0-9-_]+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 |
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. |
Example response
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"
}Example response
{
"items": [
{
"createdAt": "2025-10-29T00:34:24.661Z",
"propertyName": "text",
"lastModifiedAt": "2025-10-29T00:34:24.661Z",
"propertyUid": "text",
"type": "TEXT",
"externalId": "text"
}
],
"paging": {
"pageNumber": 1,
"pageSize": 1,
"totalCount": 1
}
}Gets the details for this property.
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a product property definition
^[A-Za-z0-9-_]+Example response
GET /v2/tenants/{tenantUid}/properties/{propertyUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Example response
{
"createdAt": "2025-10-29T00:34:24.661Z",
"propertyName": "text",
"lastModifiedAt": "2025-10-29T00:34:24.661Z",
"propertyUid": "text",
"type": "TEXT",
"externalId": "text"
}Updates the details for this property.
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a product property definition
^[A-Za-z0-9-_]+Update name and externalId for a property
Example response
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"
}Example response
{
"createdAt": "2025-10-29T00:34:24.661Z",
"propertyName": "text",
"lastModifiedAt": "2025-10-29T00:34:24.661Z",
"propertyUid": "text",
"type": "TEXT",
"externalId": "text"
}Deletes a property.
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a product property definition
^[A-Za-z0-9-_]+No Content
No content
DELETE /v2/tenants/{tenantUid}/properties/{propertyUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No Content
No content
List all options available on this property.
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a product property definition
^[A-Za-z0-9-_]+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}/properties/{propertyUid}/options HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Example response
{
"items": [
{
"createdAt": "2025-10-29T00:34:24.661Z",
"lastModifiedAt": "2025-10-29T00:34:24.661Z",
"propertyUid": "text",
"propertyName": "text",
"propertyOptionUid": "text",
"propertyOptionName": "text",
"externalId": "text"
}
],
"paging": {
"pageNumber": 1,
"pageSize": 1,
"totalCount": 1
}
}Create a new option for this property.
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a product property definition
^[A-Za-z0-9-_]+Example response
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"
}Example response
{
"createdAt": "2025-10-29T00:34:24.661Z",
"lastModifiedAt": "2025-10-29T00:34:24.661Z",
"propertyUid": "text",
"propertyName": "text",
"propertyOptionUid": "text",
"propertyOptionName": "text",
"externalId": "text"
}Get property option details
Get details for the property option.
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a product property definition
^[A-Za-z0-9-_]+Reference to an allowed option of a product property definition
^[A-Za-z0-9-_]+Example response
GET /v2/tenants/{tenantUid}/properties/{propertyUid}/options/{propertyOptionUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Example response
{
"createdAt": "2025-10-29T00:34:24.661Z",
"lastModifiedAt": "2025-10-29T00:34:24.661Z",
"propertyUid": "text",
"propertyName": "text",
"propertyOptionUid": "text",
"propertyOptionName": "text",
"externalId": "text"
}Update property option details
Update details of the property option.
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a product property definition
^[A-Za-z0-9-_]+Reference to an allowed option of a product property definition
^[A-Za-z0-9-_]+An pre-defined, allowed value for a list or checklist property.
Example response
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"
}Example response
{
"createdAt": "2025-10-29T00:34:24.661Z",
"lastModifiedAt": "2025-10-29T00:34:24.661Z",
"propertyUid": "text",
"propertyName": "text",
"propertyOptionUid": "text",
"propertyOptionName": "text",
"externalId": "text"
}Delete a property option
Delete a property option.
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a product property definition
^[A-Za-z0-9-_]+Reference to an allowed option of a product property definition
^[A-Za-z0-9-_]+No Content
No content
DELETE /v2/tenants/{tenantUid}/properties/{propertyUid}/options/{propertyOptionUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No Content
No content
Was this helpful?