StockInfo

Get stock list for a list of products and locations

post

/tenants/{tenantUid}/products/stock

Get product stock for one or several products. The result can be limited to only specific stores and warehouses.

Usage:

productUids OR productSkus is required. An error is returned if both fields are present in request.

storeUids OR warehouseUids is required. An error is returned if both fields are present in request.

Returns stock records for all warehouses in request or all warehouses for all stores in request.

Authorizations

AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters

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.

Body

productUidsstring[] · min: 1Optional

productSkusstring[] · min: 1Optional

storeUidsstring[] · min: 1Optional

warehouseUidsstring[] · min: 1Optional

Responses

200Success

application/json

post

/tenants/{tenantUid}/products/stock

POST /v2/tenants/{tenantUid}/products/stock HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 93

{
  "productUids": [
    "text"
  ],
  "productSkus": [
    "text"
  ],
  "storeUids": [
    "text"
  ],
  "warehouseUids": [
    "text"
  ]
}

200Success

{
  "items": [
    {
      "productUid": "text",
      "productName": "text",
      "productSku": "text",
      "totalQuantityReserved": 1,
      "totalQuantityStock": 1,
      "warehouseStockDetails": [
        {
          "locationLabel": "text",
          "maxStockLevel": 1,
          "minStockLevel": 1,
          "quantityReserved": 1,
          "quantityStock": 1,
          "storeUid": "text",
          "storeName": "text",
          "warehouseUid": "text",
          "warehouseName": "text"
        }
      ]
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Get all stock records for a store after a modification timestamp.

post

/tenants/{tenantUid}/stores/{storeUid}/stock

Get stock records for a store.

If no warehouseUids in request, the response contains stock records for all warehouses the storeUid in url has VIEW access to.

Else, the storeUid in url MUST have VIEW access all warehosueUids in request.

Returns stock records for all warehouses a store has VIEW asscess to.

Authorizations

AuthorizationstringRequired

Token received from the auth service

Path parameters

storeUidstringRequired

Reference to a Store.

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.

Body

modifiedAfterstring · date-timeRequired

warehouseUidsstring[]Optional

Responses

200Success

application/json

post

/tenants/{tenantUid}/stores/{storeUid}/stock

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

{
  "modifiedAfter": "2025-12-13T18:28:27.239Z",
  "warehouseUids": [
    "text"
  ]
}

200Success

{
  "items": [
    {
      "productUid": "text",
      "productName": "text",
      "productSku": "text",
      "totalQuantityReserved": 1,
      "totalQuantityStock": 1,
      "warehouseStockDetails": [
        {
          "locationLabel": "text",
          "maxStockLevel": 1,
          "minStockLevel": 1,
          "quantityReserved": 1,
          "quantityStock": 1,
          "storeUid": "text",
          "storeName": "text",
          "warehouseUid": "text",
          "warehouseName": "text"
        }
      ]
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Search product for a store with stockInfo

post

/tenants/{tenantUid}/stores/{storeUid}/products/search

Searches for products based on criteria set in the request body.

Returns a response with the stores price and stock availablitity.

If productGroupUid is set, productGroupScopes is omitted.

StoreProductDetails contains accumulated values for all warehouses the store owns and has VIEW access to.

Authorizations

AuthorizationstringRequired

Accesstoken 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-_]+

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

brandUidsstring[]Optional

exactMatchbooleanOptional

querystringOptional

productGroupUidsstring[]Optional

A list of product group UIDs that you want to include in the search

ENUM	Description
SALE	Sale product scope. Default
SERVICE	Service product scope
NO_SEARCH	Not visible in search scope

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

productUidsstring[]Optional

A list of product UIDs to search for

hideVariantsbooleanOptional

includeDiscontinuedbooleanOptional

ENUM	Description
STOCK	Price*quantity
NO_STOCK	No quantity
CONFIGURABLE	Master configurable product
FLOWGIFTCARD	Flow Giftcard product
NON_PHYSICAL	Non physical product
PACKAGE_FIXED	Packaged product with fixed content
PACKAGE_DYNAMIC	Packaged product with dynamic content

onlyInStockbooleanOptional

If true, returns only products with stocklevel > 0

hideNotAllowPurchasebooleanOptional

when true, only show products with allowPurchase = true

Responses

200

Product Store Search Response

application/json

post

/tenants/{tenantUid}/stores/{storeUid}/products/search

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

{
  "brandUids": [
    "text"
  ],
  "exactMatch": true,
  "query": "text",
  "productGroupUids": [
    "text"
  ],
  "productGroupScopes": [
    "SALE"
  ],
  "supplierUid": "text",
  "productUids": [
    "text"
  ],
  "hideVariants": true,
  "includeDiscontinued": true,
  "visibility": [
    "ALWAYS_VISIBLE"
  ],
  "productTypes": [
    "STOCK"
  ],
  "onlyInStock": true,
  "hideNotAllowPurchase": true
}

200

Product Store Search Response

{
  "items": [
    {
      "storeProductDetails": {
        "grossProfitAmount": 1,
        "grossProfitPercentage": 1,
        "costPrice": 1,
        "price": 1,
        "campaignPrice": 1,
        "campaignName": "text",
        "quantityReserved": 1,
        "quantityStock": 1,
        "quantityOrdered": 1
      },
      "allowAddon": true,
      "allowCredit": true,
      "allowPurchase": true,
      "allowQuantity": true,
      "allowSale": "YES",
      "allowSaleDate": "2025-12-13T18:28:27.239Z",
      "allowDelivery": "YES",
      "allowDeliveryDate": "2025-12-13T18:28:27.239Z",
      "availableForWeb": true,
      "brandUid": "text",
      "brandName": "text",
      "calculationFactor": 1,
      "categoryUids": [
        "text"
      ],
      "createdAt": "2025-12-13T18:28:27.239Z",
      "customerAgeRestriction": 1,
      "description": "text",
      "discontinuedFrom": "2025-12-13T18:28:27.239Z",
      "externalId": "text",
      "externalInfo": "text",
      "externalUrl": "text",
      "gtins": [
        {
          "gtin": "text",
          "primary": true,
          "type": "text"
        }
      ],
      "height": 1,
      "internalInfo": "text",
      "lastModifiedAt": "2025-12-13T18:28:27.239Z",
      "ledgerNumber": "text",
      "length": 1,
      "name": "text",
      "optionProperties": [
        {
          "productPropertyUid": "text",
          "propertyName": "text",
          "propertyOptionName": "text",
          "propertyType": "TEXT",
          "propertyText": "text",
          "propertyUid": "text",
          "propertyOptionUid": "text",
          "required": true
        }
      ],
      "priceOverride": true,
      "productGroupUid": "text",
      "productGroupPath": [
        {
          "name": "text",
          "parentUid": "text",
          "productGroupUid": "text"
        }
      ],
      "productUid": "text",
      "productType": "STOCK",
      "recommendedRetailPrice": 1,
      "requiredVariantPropertyUids": [
        "text"
      ],
      "serialNoRequired": "NO",
      "shortDescription": "text",
      "sku": "text",
      "manufacturerSku": "text",
      "suppliers": [
        {
          "name": "text",
          "supplierUid": "text"
        }
      ],
      "textProperties": [
        {
          "productPropertyUid": "text",
          "propertyName": "text",
          "propertyOptionName": "text",
          "propertyType": "TEXT",
          "propertyText": "text",
          "propertyUid": "text",
          "propertyOptionUid": "text",
          "required": true
        }
      ],
      "unitLabel": "text",
      "variantProductUids": [
        "text"
      ],
      "variantParentProductUid": "text",
      "vatCodeUid": "text",
      "weight": 1,
      "width": 1,
      "links": [
        {
          "productLinkUid": "text",
          "linkType": "INSURANCE",
          "productUid": "text"
        }
      ],
      "parents": [
        {
          "productLinkUid": "text",
          "linkType": "INSURANCE",
          "productUid": "text"
        }
      ],
      "requirements": {
        "requireCustomer": true,
        "requireCustomerMobile": true,
        "requireCustomerEmail": true,
        "requireCustomerDeliveryAddress": true
      },
      "coverImage": {
        "productMediaUid": "text",
        "mainUrl": "text",
        "thumbnailUrl": "text"
      },
      "imageCount": 1,
      "relevance": 1,
      "visibility": "ALWAYS_VISIBLE",
      "commission": 1,
      "productWarrantyUid": "text",
      "excludeFromStatistics": true,
      "purchasePrice": 1,
      "numberOfPieces": 1,
      "limitToStoreUids": [
        "text"
      ]
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Store product details with stockInfo

get

/tenants/{tenantUid}/stores/{storeUid}/products/{productUid}

Get store specific information about a product.

StoreProductDetails contains accumulated values for all warehouses the store owns and has VIEW access to.

Authorizations

AuthorizationstringRequired

Accesstoken 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-_]+

productUidstringRequired

Reference to a Product.

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

Responses

200

Store Product Response

application/json

Responseall of

StoreProductResponseSchema

get

/tenants/{tenantUid}/stores/{storeUid}/products/{productUid}

GET /v2/tenants/{tenantUid}/stores/{storeUid}/products/{productUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Store Product Response

{
  "storeProductDetails": {
    "grossProfitAmount": 1,
    "grossProfitPercentage": 1,
    "costPrice": 1,
    "price": 1,
    "campaignPrice": 1,
    "campaignName": "text",
    "quantityReserved": 1,
    "quantityStock": 1,
    "quantityOrdered": 1
  },
  "allowAddon": true,
  "allowCredit": true,
  "allowPurchase": true,
  "allowQuantity": true,
  "allowSale": "YES",
  "allowSaleDate": "2025-12-13T18:28:27.239Z",
  "allowDelivery": "YES",
  "allowDeliveryDate": "2025-12-13T18:28:27.239Z",
  "availableForWeb": true,
  "brandUid": "text",
  "brandName": "text",
  "calculationFactor": 1,
  "categoryUids": [
    "text"
  ],
  "createdAt": "2025-12-13T18:28:27.239Z",
  "customerAgeRestriction": 1,
  "description": "text",
  "discontinuedFrom": "2025-12-13T18:28:27.239Z",
  "externalId": "text",
  "externalInfo": "text",
  "externalUrl": "text",
  "gtins": [
    {
      "gtin": "text",
      "primary": true,
      "type": "text"
    }
  ],
  "height": 1,
  "internalInfo": "text",
  "lastModifiedAt": "2025-12-13T18:28:27.239Z",
  "ledgerNumber": "text",
  "length": 1,
  "name": "text",
  "optionProperties": [
    {
      "productPropertyUid": "text",
      "propertyName": "text",
      "propertyOptionName": "text",
      "propertyType": "TEXT",
      "propertyText": "text",
      "propertyUid": "text",
      "propertyOptionUid": "text",
      "required": true
    }
  ],
  "priceOverride": true,
  "productGroupUid": "text",
  "productGroupPath": [
    {
      "name": "text",
      "parentUid": "text",
      "productGroupUid": "text"
    }
  ],
  "productUid": "text",
  "productType": "STOCK",
  "recommendedRetailPrice": 1,
  "requiredVariantPropertyUids": [
    "text"
  ],
  "serialNoRequired": "NO",
  "shortDescription": "text",
  "sku": "text",
  "manufacturerSku": "text",
  "suppliers": [
    {
      "name": "text",
      "supplierUid": "text"
    }
  ],
  "textProperties": [
    {
      "productPropertyUid": "text",
      "propertyName": "text",
      "propertyOptionName": "text",
      "propertyType": "TEXT",
      "propertyText": "text",
      "propertyUid": "text",
      "propertyOptionUid": "text",
      "required": true
    }
  ],
  "unitLabel": "text",
  "variantProductUids": [
    "text"
  ],
  "variantParentProductUid": "text",
  "vatCodeUid": "text",
  "weight": 1,
  "width": 1,
  "links": [
    {
      "productLinkUid": "text",
      "linkType": "INSURANCE",
      "productUid": "text"
    }
  ],
  "parents": [
    {
      "productLinkUid": "text",
      "linkType": "INSURANCE",
      "productUid": "text"
    }
  ],
  "requirements": {
    "requireCustomer": true,
    "requireCustomerMobile": true,
    "requireCustomerEmail": true,
    "requireCustomerDeliveryAddress": true
  },
  "coverImage": {
    "productMediaUid": "text",
    "mainUrl": "text",
    "thumbnailUrl": "text"
  },
  "imageCount": 1,
  "relevance": 1,
  "visibility": "ALWAYS_VISIBLE",
  "commission": 1,
  "productWarrantyUid": "text",
  "excludeFromStatistics": true,
  "purchasePrice": 1,
  "numberOfPieces": 1,
  "limitToStoreUids": [
    "text"
  ]
}

List available stock for a store

get

/tenants/{tenantUid}/stores/{storeUid}/stock/{productUid}

Lists warehouses with available stock that the specified store has access to.

The list will only contain warehouses that the store has "VIEW" access to.

Authorizations

AuthorizationstringRequired

Accesstoken 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-_]+

productUidstringRequired

Reference to a Product.

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:

warehouseUidstringOptional

Filter by warehouse uid

Responses

200

Example response

Responsestring · binary

get

/tenants/{tenantUid}/stores/{storeUid}/stock/{productUid}

GET /v2/tenants/{tenantUid}/stores/{storeUid}/stock/{productUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

binary

List stock

get

/tenants/{tenantUid}/stores/{storeUid}/warehouses/{warehouseUid}/stock

Lists all stock on a warehouse. Use the Accept header to choose the response format

Available formats: json, PDF and spreadsheet (excel file).

Authorizations

AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters

warehouseUidstringRequired

Reference to a Warehouse.

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

storeUidstringRequired

Reference to a Store.

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:

productGroupUidsstring[]Optional

Reference to a list of productGroup Ids.

brandUidsstring[]Optional

Reference to a list of brand Ids.

Responses

200

Example response

Responsestring · binary

get

/tenants/{tenantUid}/stores/{storeUid}/warehouses/{warehouseUid}/stock

GET /v2/tenants/{tenantUid}/stores/{storeUid}/warehouses/{warehouseUid}/stock HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

binary

Get stock for product in specified warehouse

get

/tenants/{tenantUid}/stores/{storeUid}/warehouses/{warehouseUid}/stock/{productUid}

Returns stock for a particular product in the specified warehouse.

Authorizations

AuthorizationstringRequired

Accesstoken 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-_]+

warehouseUidstringRequired

Reference to a Warehouse.

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

productUidstringRequired

Reference to a Product.

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

Responses

200

Example response

application/json

get

/tenants/{tenantUid}/stores/{storeUid}/warehouses/{warehouseUid}/stock/{productUid}

GET /v2/tenants/{tenantUid}/stores/{storeUid}/warehouses/{warehouseUid}/stock/{productUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "averageCost": 1,
  "locationLabel": "text",
  "maxStockLevel": 1,
  "minStockLevel": 1,
  "price": 1,
  "productUid": "text",
  "productName": "text",
  "productSku": "text",
  "quantityReserved": 1,
  "quantityStock": 1,
  "warehouseUid": "text",
  "warehouseName": "text",
  "storeUid": "text",
  "storeName": "text"
}

PreviousServiceShipment NextStocktaking

Last updated 8 months ago

Was this helpful?