Prices | Flow Retail Docs

Flow Retail Docs

Visit our website API Documentation

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

application/json

objectoptional

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-04-18T01:11:25.611Z",
  "externalId": "text",
  "lastModifiedAt": "2025-04-18T01:11:25.611Z",
  "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

delete

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

204

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

Available options:

Responses

application/json

objectoptional

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-04-18T01:11:25.611Z",
      "fromDate": "2025-04-18T01:11:25.611Z",
      "lastModifiedAt": "2025-04-18T01:11:25.611Z",
      "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

application/json

objectoptional

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-04-18T01:11:25.611Z",
  "fromDate": "2025-04-18T01:11:25.611Z",
  "lastModifiedAt": "2025-04-18T01:11:25.611Z",
  "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

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

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

Available options:

Responses

application/json

objectoptional

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-04-18T01:11:25.611Z",
      "externalId": "text",
      "lastModifiedAt": "2025-04-18T01:11:25.611Z",
      "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

Responses

application/json

objectoptional

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-04-18T01:11:25.611Z",
  "externalId": "text",
  "lastModifiedAt": "2025-04-18T01:11:25.611Z",
  "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

application/json

objectoptional

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-04-18T01:11:25.611Z",
  "externalId": "text",
  "lastModifiedAt": "2025-04-18T01:11:25.611Z",
  "name": "text",
  "pricelistUid": "text"
}

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

application/json

objectoptional

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-04-18T01:11:25.611Z",
  "price": 1,
  "productUid": "text",
  "priceUid": "text"
}

200

Example response

{
  "createdAt": "2025-04-18T01:11:25.611Z",
  "fromDate": "2025-04-18T01:11:25.611Z",
  "lastModifiedAt": "2025-04-18T01:11:25.611Z",
  "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

createobject[]optional

deleteobject[]optional

updateobject[]optional

upsertobject[]optional

Responses

application/json

objectoptional

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-04-18T01:11:25.611Z",
      "price": 1,
      "productUid": "text",
      "priceUid": "text"
    }
  ],
  "delete": [
    {
      "priceUid": "text"
    }
  ],
  "update": [],
  "upsert": [
    {
      "fromDate": "2025-04-18T01:11:25.611Z",
      "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

Available options:

Body

querystringoptional

brandUidsstring[]optional

productGroupUidsstring[]optional

Responses

application/json

objectoptional

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-04-18T01:11:25.611Z",
      "fromDate": "2025-04-18T01:11:25.611Z",
      "lastModifiedAt": "2025-04-18T01:11:25.611Z",
      "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
  }
}

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

application/json

objectoptional

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-04-18T01:11:25.611Z",
  "price": 1
}

200

Example response

{
  "createdAt": "2025-04-18T01:11:25.611Z",
  "fromDate": "2025-04-18T01:11:25.611Z",
  "lastModifiedAt": "2025-04-18T01:11:25.611Z",
  "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"
      }
    ]
  }
}