Prices
Prices
List all pricelists.
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to the name of a pricelist.
External reference to a pricelist.
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}/pricelists HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Example response
{
"items": [
{
"createdAt": "2025-10-30T21:27:28.128Z",
"externalId": "text",
"lastModifiedAt": "2025-10-30T21:27:28.128Z",
"name": "text",
"pricelistUid": "text"
}
],
"paging": {
"pageNumber": 1,
"pageSize": 1,
"totalCount": 1
}
}Create a new pricelist.
Reference to a tenant.
^[A-Za-z0-9-_]+Example response
POST /v2/tenants/{tenantUid}/pricelists HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 57
{
"externalId": "text",
"name": "text",
"pricelistUid": "text"
}Example response
{
"createdAt": "2025-10-30T21:27:28.128Z",
"externalId": "text",
"lastModifiedAt": "2025-10-30T21:27:28.128Z",
"name": "text",
"pricelistUid": "text"
}Get pricelist details.
Reference to a Pricelist.
^[A-Za-z0-9-_]+Reference to a tenant.
^[A-Za-z0-9-_]+Example response
GET /v2/tenants/{tenantUid}/pricelists/{pricelistUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Example response
{
"createdAt": "2025-10-30T21:27:28.128Z",
"externalId": "text",
"lastModifiedAt": "2025-10-30T21:27:28.128Z",
"name": "text",
"pricelistUid": "text"
}Update pricelist details.
Reference to a Pricelist.
^[A-Za-z0-9-_]+Reference to a tenant.
^[A-Za-z0-9-_]+Example response
PUT /v2/tenants/{tenantUid}/pricelists/{pricelistUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 35
{
"externalId": "text",
"name": "text"
}Example response
{
"createdAt": "2025-10-30T21:27:28.128Z",
"externalId": "text",
"lastModifiedAt": "2025-10-30T21:27:28.128Z",
"name": "text",
"pricelistUid": "text"
}Deletes a pricelist and all associated prices.
Reference to a Pricelist.
^[A-Za-z0-9-_]+Reference to a tenant.
^[A-Za-z0-9-_]+No Content
No content
DELETE /v2/tenants/{tenantUid}/pricelists/{pricelistUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No Content
No content
Lists all prices on a pricelist.
Reference to a Pricelist.
^[A-Za-z0-9-_]+Reference to a tenant.
^[A-Za-z0-9-_]+External reference to a product.
Reference to a product uid.
^[A-Za-z0-9-_]+reference to a product sku.
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}/pricelists/{pricelistUid}/prices HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Example response
{
"items": [
{
"createdAt": "2025-10-30T21:27:28.128Z",
"lastModifiedAt": "2025-10-30T21:27:28.128Z",
"fromDate": "2025-10-30T21:27:28.128Z",
"toDate": "2025-10-30T21:27:28.128Z",
"price": 1,
"priceUid": "text",
"pricelistUid": "text",
"productExternalId": "text",
"productUid": "text",
"productName": "text",
"productRecommendedRetailPrice": 1,
"productSku": "text",
"brand": {
"brandUid": "text",
"name": "text"
},
"productGroup": {
"productGroupUid": "text",
"name": "text",
"path": [
{
"name": "text",
"parentUid": "text",
"productGroupUid": "text"
}
]
}
}
],
"paging": {
"pageNumber": 1,
"pageSize": 1,
"totalCount": 1
}
}Creates a new price for a product on a pricelist.
One product in a pricelist can have one price with no toDate. This is regarded as a fallback price if no price is found with a fromDate >= now() and toDate <= now()
No prices for one product can overlap in time.
Reference to a Pricelist.
^[A-Za-z0-9-_]+Reference to a tenant.
^[A-Za-z0-9-_]+Optional. Will be set to current time if it is not in the request
Optional. Set to null if not in request.
^[A-Za-z0-9-_]+^[A-Za-z0-9-_]+Example response
POST /v2/tenants/{tenantUid}/pricelists/{pricelistUid}/prices HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 123
{
"fromDate": "2025-10-30T21:27:28.128Z",
"toDate": "2025-10-30T21:27:28.128Z",
"price": 1,
"productUid": "text",
"priceUid": "text"
}Example response
{
"createdAt": "2025-10-30T21:27:28.128Z",
"lastModifiedAt": "2025-10-30T21:27:28.128Z",
"fromDate": "2025-10-30T21:27:28.128Z",
"toDate": "2025-10-30T21:27:28.128Z",
"price": 1,
"priceUid": "text",
"pricelistUid": "text",
"productExternalId": "text",
"productUid": "text",
"productName": "text",
"productRecommendedRetailPrice": 1,
"productSku": "text",
"brand": {
"brandUid": "text",
"name": "text"
},
"productGroup": {
"productGroupUid": "text",
"name": "text",
"path": [
{
"name": "text",
"parentUid": "text",
"productGroupUid": "text"
}
]
}
}Creates prices on a pricelist. One product in a pricelist can have one price with no toDate. This is regarded as a fallback price if no price is found with a fromDate >= now() and toDate <= now()
No prices for one product can overlap in time.
Items in:
create : will be created. if fromDate is not set in request, current timestamp will be set on price record
update : will be updated.
delete: will be deleted.
upsert: will create or update if needed. if fromDate is not set in request, an update on current price will be executed.
The response http status is either:
200: all items in request was processed successfully,
207: one or more item was processed with an error.
Reference to a Pricelist.
^[A-Za-z0-9-_]+Reference to a tenant.
^[A-Za-z0-9-_]+Response for PriceBatchRequest. 200: All items in request was processed with no errors 207: One or more items in request returned an error
Response for PriceBatchRequest. 200: All items in request was processed with no errors 207: One or more items in request returned an error
POST /v2/tenants/{tenantUid}/pricelists/{pricelistUid}/prices/batch HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 417
{
"create": [
{
"fromDate": "2025-10-30T21:27:28.128Z",
"toDate": "2025-10-30T21:27:28.128Z",
"price": 1,
"productUid": "text",
"priceUid": "text"
}
],
"delete": [
{
"priceUid": "text"
}
],
"update": [
{
"fromDate": "2025-10-30T21:27:28.128Z",
"toDate": "2025-10-30T21:27:28.128Z",
"price": 1,
"priceUid": "text"
}
],
"upsert": [
{
"fromDate": "2025-10-30T21:27:28.128Z",
"toDate": "2025-10-30T21:27:28.128Z",
"price": 1,
"productUid": "text",
"priceUid": "text"
}
]
}{
"create": {
"errors": [
{
"errorCode": "text",
"message": "text",
"productUid": "text"
}
],
"success": 1
},
"delete": {
"errors": [
{
"errorCode": "text",
"message": "text",
"priceUid": "text"
}
],
"success": 1
},
"update": {
"errors": [
{
"errorCode": "text",
"message": "text",
"priceUid": "text"
}
],
"success": 1
},
"upsert": {
"errors": [
{
"errorCode": "text",
"message": "text",
"productUid": "text"
}
],
"success": 1
}
}The search answers the question: Give all prices that have products with brand in brandUids AND productGroup in groupUids AND that have product SKU/name, brand name or productGroup name which contains the query words.
Reference to a Pricelist.
^[A-Za-z0-9-_]+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
Response for PriceBatchRequest. 200: All items in request was processed with no errors 207: One or more items in request returned an error
POST /v2/tenants/{tenantUid}/pricelists/{pricelistUid}/prices/search HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 65
{
"query": "text",
"brandUids": [
"text"
],
"productGroupUids": [
"text"
]
}{
"items": [
{
"createdAt": "2025-10-30T21:27:28.128Z",
"lastModifiedAt": "2025-10-30T21:27:28.128Z",
"fromDate": "2025-10-30T21:27:28.128Z",
"toDate": "2025-10-30T21:27:28.128Z",
"price": 1,
"priceUid": "text",
"pricelistUid": "text",
"productExternalId": "text",
"productUid": "text",
"productName": "text",
"productRecommendedRetailPrice": 1,
"productSku": "text",
"brand": {
"brandUid": "text",
"name": "text"
},
"productGroup": {
"productGroupUid": "text",
"name": "text",
"path": [
{
"name": "text",
"parentUid": "text",
"productGroupUid": "text"
}
]
}
}
],
"paging": {
"pageNumber": 1,
"pageSize": 1,
"totalCount": 1
}
}Get details for a price.
Reference to a Pricelist.
^[A-Za-z0-9-_]+Reference to a Price.
^[A-Za-z0-9-_]+Reference to a tenant.
^[A-Za-z0-9-_]+Example response
GET /v2/tenants/{tenantUid}/pricelists/{pricelistUid}/prices/{priceUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Example response
{
"createdAt": "2025-10-30T21:27:28.128Z",
"lastModifiedAt": "2025-10-30T21:27:28.128Z",
"fromDate": "2025-10-30T21:27:28.128Z",
"toDate": "2025-10-30T21:27:28.128Z",
"price": 1,
"priceUid": "text",
"pricelistUid": "text",
"productExternalId": "text",
"productUid": "text",
"productName": "text",
"productRecommendedRetailPrice": 1,
"productSku": "text",
"brand": {
"brandUid": "text",
"name": "text"
},
"productGroup": {
"productGroupUid": "text",
"name": "text",
"path": [
{
"name": "text",
"parentUid": "text",
"productGroupUid": "text"
}
]
}
}Update details for a price.
Reference to a Pricelist.
^[A-Za-z0-9-_]+Reference to a Price.
^[A-Za-z0-9-_]+Reference to a tenant.
^[A-Za-z0-9-_]+Optional. Will be set to current time if it is not in the request
Optional. Set to null if not in request.
Example response
PUT /v2/tenants/{tenantUid}/pricelists/{pricelistUid}/prices/{priceUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 85
{
"fromDate": "2025-10-30T21:27:28.128Z",
"toDate": "2025-10-30T21:27:28.128Z",
"price": 1
}Example response
{
"createdAt": "2025-10-30T21:27:28.128Z",
"lastModifiedAt": "2025-10-30T21:27:28.128Z",
"fromDate": "2025-10-30T21:27:28.128Z",
"toDate": "2025-10-30T21:27:28.128Z",
"price": 1,
"priceUid": "text",
"pricelistUid": "text",
"productExternalId": "text",
"productUid": "text",
"productName": "text",
"productRecommendedRetailPrice": 1,
"productSku": "text",
"brand": {
"brandUid": "text",
"name": "text"
},
"productGroup": {
"productGroupUid": "text",
"name": "text",
"path": [
{
"name": "text",
"parentUid": "text",
"productGroupUid": "text"
}
]
}
}Deletes a price on a pricelist.
Reference to a Pricelist.
^[A-Za-z0-9-_]+Reference to a Price.
^[A-Za-z0-9-_]+Reference to a tenant.
^[A-Za-z0-9-_]+No Content
No content
DELETE /v2/tenants/{tenantUid}/pricelists/{pricelistUid}/prices/{priceUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No Content
No content
Last updated