Ask the supplier what it can confirm for a product

Ask the supplier's own system how much of a product it can confirm for this store, and for when. Answers the question a salesperson has before promising anything to a customer: is this actually coming, and when.

The lookup goes out to the supplier live, so it costs a round trip. Ask for the products you need in one call rather than one call per product.

Every product in one call shares its fate. If the supplier rejects any one of the article numbers, the whole call fails and no forecast comes back for the others.

Only available to tenants configured for it. A tenant without the integration gets an error rather than an empty list, so a client can tell "not available here" apart from "nothing is coming".

Required permissions: SALES_ORDER

post

/tenants/{tenantUid}/stores/{storeUid}/supply-forecast

Authorizations

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

storeUidstringRequired

Reference to a Store.

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

Body

The products to ask about. All quantities are in hundredths (100 = 1 unit), matching the rest of the API.

Responses

200

Example response

application/json

post/tenants/{tenantUid}/stores/{storeUid}/supply-forecast

POST /v2/tenants/{tenantUid}/stores/{storeUid}/supply-forecast HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 77

{
  "products": [
    {
      "productUid": "text",
      "quantity": 1,
      "deliveryDate": "2026-01-01"
    }
  ]
}

200

Example response

{
  "items": [
    {
      "productUid": "text",
      "confirmedQuantity": 1,
      "confirmedDate": "2026-01-01"
    }
  ]
}