Heads up, our devs are blazing ahead—docs are catching up, so some features might not be fully documented yet.
Visit our websiteAPI Documentation

Prices

Prices

List pricelists

get

List all pricelists.

Authorizations
Path parameters
tenantUidstringRequired

Reference to a tenant.

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

Reference to the name of a pricelist.

pricelistExternalIdstringOptional

External reference to a pricelist.

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
Possible values:
Responses
200
Example response
application/json
get
GET /v2/tenants/{tenantUid}/pricelists HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Example response

{
  "items": [
    {
      "createdAt": "2025-07-30T18:11:59.469Z",
      "externalId": "text",
      "lastModifiedAt": "2025-07-30T18:11:59.469Z",
      "name": "text",
      "pricelistUid": "text"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Create a new pricelist

post

Create a new pricelist.

Authorizations
Path parameters
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
Body
all ofOptional
and
Responses
200
Example response
application/json
post
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"
}
200

Example response

{
  "createdAt": "2025-07-30T18:11:59.469Z",
  "externalId": "text",
  "lastModifiedAt": "2025-07-30T18:11:59.469Z",
  "name": "text",
  "pricelistUid": "text"
}

Get pricelist details

get

Get pricelist details.

Authorizations
Path parameters
pricelistUidstringRequired

Reference to a Pricelist.

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

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
Responses
200
Example response
application/json
get
GET /v2/tenants/{tenantUid}/pricelists/{pricelistUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Example response

{
  "createdAt": "2025-07-30T18:11:59.469Z",
  "externalId": "text",
  "lastModifiedAt": "2025-07-30T18:11:59.469Z",
  "name": "text",
  "pricelistUid": "text"
}

Update pricelist details

put

Update pricelist details.

Authorizations
Path parameters
pricelistUidstringRequired

Reference to a Pricelist.

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

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
Body
externalIdstringOptional
namestringOptional
Responses
200
Example response
application/json
put
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"
}
200

Example response

{
  "createdAt": "2025-07-30T18:11:59.469Z",
  "externalId": "text",
  "lastModifiedAt": "2025-07-30T18:11:59.469Z",
  "name": "text",
  "pricelistUid": "text"
}

Delete a pricelist

delete

Deletes a pricelist and all associated prices.

Authorizations
Path parameters
pricelistUidstringRequired

Reference to a Pricelist.

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

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
Responses
204
No Content
delete
DELETE /v2/tenants/{tenantUid}/pricelists/{pricelistUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
204

No Content

No content

List prices

get

Lists all prices on a pricelist.

Authorizations
Path parameters
pricelistUidstringRequired

Reference to a Pricelist.

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

Reference to a tenant.

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

External reference to a product.

priceProductUidstringOptional

Reference to a product uid.

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

reference to a product sku.

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
Possible values:
Responses
200
Example response
application/json
get
GET /v2/tenants/{tenantUid}/pricelists/{pricelistUid}/prices HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Example response

{
  "items": [
    {
      "createdAt": "2025-07-30T18:11:59.469Z",
      "fromDate": "2025-07-30T18:11:59.469Z",
      "lastModifiedAt": "2025-07-30T18:11:59.469Z",
      "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
  }
}

Create a new price

post

Creates a new price for a product on a pricelist.

Authorizations
Path parameters
pricelistUidstringRequired

Reference to a Pricelist.

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

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
Body
fromDatestring · date-timeOptional
priceintegerRequired
productUidstringRequiredPattern: ^[A-Za-z0-9-_]+
priceUidstringOptionalPattern: ^[A-Za-z0-9-_]+
Responses
200
Example response
application/json
post
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: 87

{
  "fromDate": "2025-07-30T18:11:59.469Z",
  "price": 1,
  "productUid": "text",
  "priceUid": "text"
}
200

Example response

{
  "createdAt": "2025-07-30T18:11:59.469Z",
  "fromDate": "2025-07-30T18:11:59.469Z",
  "lastModifiedAt": "2025-07-30T18:11:59.469Z",
  "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"
      }
    ]
  }
}

BATCH Create prices on a pricelist.

post

Creates prices on a pricelist. 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.

Authorizations
Path parameters
pricelistUidstringRequired

Reference to a Pricelist.

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

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
Body
Responses
200
Response for PriceBatchRequest. 200: All items in request was processed with no errors 207: One or more items in request returned an error
application/json
post
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: 242

{
  "create": [
    {
      "fromDate": "2025-07-30T18:11:59.469Z",
      "price": 1,
      "productUid": "text",
      "priceUid": "text"
    }
  ],
  "delete": [
    {
      "priceUid": "text"
    }
  ],
  "update": [],
  "upsert": [
    {
      "fromDate": "2025-07-30T18:11:59.469Z",
      "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
  }
}

Search for prices in a price list

post

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.

Authorizations
Path parameters
pricelistUidstringRequired

Reference to a Pricelist.

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
Possible values:
Body
querystringOptional
brandUidsstring[]Optional
productGroupUidsstring[]Optional
Responses
200
Example response
application/json
post
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-07-30T18:11:59.469Z",
      "fromDate": "2025-07-30T18:11:59.469Z",
      "lastModifiedAt": "2025-07-30T18:11:59.469Z",
      "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 price details

get

Get details for a price.

Authorizations
Path parameters
pricelistUidstringRequired

Reference to a Pricelist.

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

Reference to a Price.

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

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
Responses
200
Example response
application/json
get
GET /v2/tenants/{tenantUid}/pricelists/{pricelistUid}/prices/{priceUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Example response

{
  "createdAt": "2025-07-30T18:11:59.469Z",
  "fromDate": "2025-07-30T18:11:59.469Z",
  "lastModifiedAt": "2025-07-30T18:11:59.469Z",
  "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 price details

put

Update details for a price.

Authorizations
Path parameters
pricelistUidstringRequired

Reference to a Pricelist.

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

Reference to a Price.

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

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
Body
fromDatestring · date-timeOptional
priceintegerRequired
Responses
200
Example response
application/json
put
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: 49

{
  "fromDate": "2025-07-30T18:11:59.469Z",
  "price": 1
}
200

Example response

{
  "createdAt": "2025-07-30T18:11:59.469Z",
  "fromDate": "2025-07-30T18:11:59.469Z",
  "lastModifiedAt": "2025-07-30T18:11:59.469Z",
  "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"
      }
    ]
  }
}

Delete a price

delete

Deletes a price on a pricelist.

Authorizations
Path parameters
pricelistUidstringRequired

Reference to a Pricelist.

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

Reference to a Price.

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

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
Responses
204
No Content
delete
DELETE /v2/tenants/{tenantUid}/pricelists/{pricelistUid}/prices/{priceUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
204

No Content

No content
PreviousPrePaymentNextPrinter

Was this helpful?