Warehouse
Warehouse
List all warehouses.
Reference to a Store.
^[A-Za-z0-9-_]+Reference to a tenant.
^[A-Za-z0-9-_]+External reference to a warehouse.
Reference to the name of a warehouse.
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}/stores/{storeUid}/warehouses HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Example response
{
"items": [
{
"createdAt": "2025-08-11T18:08:31.789Z",
"externalId": "text",
"lastModifiedAt": "2025-08-11T18:08:31.789Z",
"name": "text",
"warehouseUid": "text",
"accessList": [
{
"role": "DELIVER",
"storeUid": "text",
"storeName": "text",
"warehouseUid": "text",
"warehouseName": "text",
"warehouseAccessUid": "text"
}
]
}
],
"paging": {
"pageNumber": 1,
"pageSize": 1,
"totalCount": 1
}
}Create a new warehouse.
Reference to a Store.
^[A-Za-z0-9-_]+Reference to a tenant.
^[A-Za-z0-9-_]+Example response
POST /v2/tenants/{tenantUid}/stores/{storeUid}/warehouses HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 57
{
"externalId": "text",
"name": "text",
"warehouseUid": "text"
}Example response
{
"createdAt": "2025-08-11T18:08:31.789Z",
"externalId": "text",
"lastModifiedAt": "2025-08-11T18:08:31.789Z",
"name": "text",
"warehouseUid": "text",
"accessList": [
{
"role": "DELIVER",
"storeUid": "text",
"storeName": "text",
"warehouseUid": "text",
"warehouseName": "text",
"warehouseAccessUid": "text"
}
]
}Lists all warehouses this store has access to.
Reference to a Store.
^[A-Za-z0-9-_]+Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a warehouse role
| ENUM | Description |
|---|---|
| DELIVER | |
| MOVE | |
| RECEIVE | |
| RESERVE | |
| RETURN | |
| VIEW |
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}/stores/{storeUid}/warehouses/access HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Example response
{
"items": [
{
"role": "DELIVER",
"storeUid": "text",
"storeName": "text",
"warehouseUid": "text",
"warehouseName": "text",
"warehouseAccessUid": "text"
}
],
"paging": {
"pageNumber": 1,
"pageSize": 1,
"totalCount": 1
}
}Get details a warehouse.
Reference to a Warehouse.
^[A-Za-z0-9-_]+Reference to a Store.
^[A-Za-z0-9-_]+Reference to a tenant.
^[A-Za-z0-9-_]+Example response
GET /v2/tenants/{tenantUid}/stores/{storeUid}/warehouses/{warehouseUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Example response
{
"createdAt": "2025-08-11T18:08:31.789Z",
"externalId": "text",
"lastModifiedAt": "2025-08-11T18:08:31.789Z",
"name": "text",
"warehouseUid": "text",
"accessList": [
{
"role": "DELIVER",
"storeUid": "text",
"storeName": "text",
"warehouseUid": "text",
"warehouseName": "text",
"warehouseAccessUid": "text"
}
]
}Update details for a warehouse. Partial updates are allowed.
Reference to a Warehouse.
^[A-Za-z0-9-_]+Reference to a Store.
^[A-Za-z0-9-_]+Reference to a tenant.
^[A-Za-z0-9-_]+Example response
PUT /v2/tenants/{tenantUid}/stores/{storeUid}/warehouses/{warehouseUid} 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-08-11T18:08:31.789Z",
"externalId": "text",
"lastModifiedAt": "2025-08-11T18:08:31.789Z",
"name": "text",
"warehouseUid": "text",
"accessList": [
{
"role": "DELIVER",
"storeUid": "text",
"storeName": "text",
"warehouseUid": "text",
"warehouseName": "text",
"warehouseAccessUid": "text"
}
]
}Deletes a warehouse.
Reference to a Warehouse.
^[A-Za-z0-9-_]+Reference to a Store.
^[A-Za-z0-9-_]+Reference to a tenant.
^[A-Za-z0-9-_]+No Content
DELETE /v2/tenants/{tenantUid}/stores/{storeUid}/warehouses/{warehouseUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No Content
No content
Grants access for a store to a warehouse.
Reference to a Store.
^[A-Za-z0-9-_]+Reference to a Warehouse.
^[A-Za-z0-9-_]+Reference to a tenant.
^[A-Za-z0-9-_]+| ENUM | Description |
|---|---|
| DELIVER | Can deliver products using stock from this warehouse. |
| MOVE | Can move stock to and from this warehouse. |
| RECEIVE | Can receive purchase orders to this warehouse. |
| RESERVE | Can make stock reservations from this warehouse. |
| RETURN | Can return stock to this warehouse. |
| VIEW | Only able to view quantity. |
^[A-Za-z0-9-_]+Example response
POST /v2/tenants/{tenantUid}/stores/{storeUid}/warehouses/{warehouseUid}/access HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 36
{
"role": "DELIVER",
"storeUid": "text"
}Example response
{
"role": "DELIVER",
"storeUid": "text",
"warehouse": {
"createdAt": "2025-08-11T18:08:31.789Z",
"externalId": "text",
"lastModifiedAt": "2025-08-11T18:08:31.789Z",
"name": "text",
"warehouseUid": "text",
"accessList": [
{
"role": "DELIVER",
"storeUid": "text",
"storeName": "text",
"warehouseUid": "text",
"warehouseName": "text",
"warehouseAccessUid": "text"
}
]
},
"warehouseAccessUid": "text"
}Revokes access for a store to a warehouse.
Reference to a Store.
^[A-Za-z0-9-_]+Reference to details about a stores access level to a warehouse.
^[A-Za-z0-9-_]+Reference to a Warehouse.
^[A-Za-z0-9-_]+Reference to a tenant.
^[A-Za-z0-9-_]+No Content
DELETE /v2/tenants/{tenantUid}/stores/{storeUid}/warehouses/{warehouseUid}/access/{warehouseAccessUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No Content
No content
Change stock for a list of products in a warehouse (max 1000 entries).
The request contains two quantity fields quantity and changeQuantity.
Both may not be set in the same entry.
Use quantity to set a new total stock for the product.
Use changeQuantity to adjust the product's stock by a positive or negative number to
increase or decrease stock.
Use averageCost to perform new calculation of stock average cost.
At least one of these three fields must be set on each entry.
If an error is returned, no changes have been made, all changes are rolled back. The error is a description of the first error met.
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a Store.
^[A-Za-z0-9-_]+Reference to a Warehouse.
^[A-Za-z0-9-_]+The success field indicate how many of the products that where successfully updated. The errors field will contain the products that failed to update.
The success field indicate how many of the products that where successfully updated. The errors field will contain the products that failed to update.
PUT /v2/tenants/{tenantUid}/stores/{storeUid}/warehouses/{warehouseUid}/stock/batch HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 123
{
"upsert": [
{
"productUid": "text",
"averageCost": 1,
"quantity": 1,
"changeQuantity": 1,
"reason": "text",
"serialnumbers": [
"text"
]
}
]
}{
"upsert": [
{
"errors": [
{
"errorCode": "text",
"message": "text",
"productUid": "text"
}
],
"success": 1
}
]
}The request contains two quantity fields quantity and changeQuantity.
Both may not be set in the same entry.
Use quantity to set a new total stock for the product.
Use changeQuantity to adjust the product's stock by a positive or negative number to
increase or decrease stock.
Use averageCost to perform new calculation of stock average cost.
At least one of these three fields must be set on each entry.
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a Store.
^[A-Za-z0-9-_]+Reference to a Warehouse.
^[A-Za-z0-9-_]+Reference to a Product.
^[A-Za-z0-9-_]+set new average cost
set new stock quantity
make stock adjustment
Array of strings to identify serial numbers for the quantity in stock. Length of array must match the quantity value. This field is required when product has serialNoRequired = "ON_RECEIVE"
Example response
PUT /v2/tenants/{tenantUid}/stores/{storeUid}/warehouses/{warehouseUid}/stock/{productUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 90
{
"averageCost": 1,
"quantity": 1,
"changeQuantity": 1,
"reason": "text",
"serialnumbers": [
"text"
]
}Example response
{
"averageCost": 1,
"locationLabel": "text",
"maxStockLevel": 1,
"minStockLevel": 1,
"productUid": "text",
"productSku": "text",
"quantityReserved": 1,
"quantityStock": 1,
"warehouseUid": "text",
"warehouseName": "text",
"storeUid": "text",
"storeName": "text"
}Update details for a product on a warehouse
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a Store.
^[A-Za-z0-9-_]+Reference to a Warehouse.
^[A-Za-z0-9-_]+Reference to a Product.
^[A-Za-z0-9-_]+Example response
PUT /v2/tenants/{tenantUid}/stores/{storeUid}/warehouses/{warehouseUid}/stock/{productUid}/details HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 60
{
"locationLabel": "text",
"maxStockLevel": 1,
"minStockLevel": 1
}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"
}Returns stock logs for a particular product in the specified warehouse.
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a Store.
^[A-Za-z0-9-_]+Reference to a Warehouse.
^[A-Za-z0-9-_]+Reference to a Product.
^[A-Za-z0-9-_]+Reference to a specific page in a result set.
The number of items per page in a result set.
^[A-Za-z0-9-_]+Example response
POST /v2/tenants/{tenantUid}/stores/{storeUid}/warehouses/{warehouseUid}/stock/{productUid}/logs/search HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 128
{
"fromDateTime": "2025-08-11T18:08:31.789Z",
"serialnumber": "text",
"tenantUserUid": "text",
"toDateTime": "2025-08-11T18:08:31.789Z"
}Example response
{
"items": [
{
"costDelta": 1,
"costNew": 1,
"costOrigin": 1,
"costTransaction": 1,
"createdAt": "2025-08-11T18:08:31.789Z",
"quantityDelta": 1,
"quantityNew": 1,
"quantityNotAvailable": 1,
"quantityOrigin": 1,
"reference": 1,
"serialnumber": "text",
"tenantUserUid": "text",
"tenantUserName": "text",
"transactionType": "RECEIVE"
}
],
"paging": {
"pageNumber": 1,
"pageSize": 1,
"totalCount": 1
}
}Move stock for a product to another warehouse.
The response will show the stock details for the warehouse you are moving from
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a Store.
^[A-Za-z0-9-_]+Reference to a Warehouse.
^[A-Za-z0-9-_]+Reference to a Product.
^[A-Za-z0-9-_]+^[A-Za-z0-9-_]+Example response
POST /v2/tenants/{tenantUid}/stores/{storeUid}/warehouses/{warehouseUid}/stock/{productUid}/move HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 61
{
"quantity": 1,
"serialnumbers": [
"text"
],
"warehouseUid": "text"
}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"
}List all serial number information for a product in a warehouse
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a Store.
^[A-Za-z0-9-_]+Reference to a Warehouse.
^[A-Za-z0-9-_]+Reference to a Product.
^[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
GET /v2/tenants/{tenantUid}/stores/{storeUid}/warehouses/{warehouseUid}/stock/{productUid}/serialnumbers HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Example response
{
"items": [
{
"costPrice": 1,
"createdAt": "2025-08-11T18:08:31.789Z",
"deliveredAt": "2025-08-11T18:08:31.789Z",
"lastModifiedAt": "2025-08-11T18:08:31.789Z",
"origin": "RECEIVE",
"receivedAt": "2025-08-11T18:08:31.789Z",
"serialnumber": "text"
}
],
"paging": {
"pageNumber": 1,
"pageSize": 1,
"totalCount": 1
}
}For products with SerialNoRequired = ON_RECEIVE. when availabilityType is not set, or DELIVER: Check if a serialnumber is in stock for a productUid and warehouseUid. Returns 200 if in stock, else 404. 200 is returned for all other products. when availabilityType = RECEIVE: Check if a serialnumber is NOT in stock for a productUid and warehouseUid. Returns 200 if not in stock, else 400. 200 is returned for all other products.
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a Store.
^[A-Za-z0-9-_]+Reference to a Warehouse.
^[A-Za-z0-9-_]+Reference to a Product.
^[A-Za-z0-9-_]+Reference to a serialnumber.
| ENUM | Description |
|---|---|
| RECEIVE - Check for receive serial number | |
| DELIVER - Check for deliver serial number |
OK
GET /v2/tenants/{tenantUid}/stores/{storeUid}/warehouses/{warehouseUid}/stock/{productUid}/serialnumbers/{serialnumber} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
No content
Get stock logs filtered by warehouse and transaction types in a defined time period for your store. When no warehouse or transaction type is set you will get logs for all transaction types for all your warehouses.
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a Store.
^[A-Za-z0-9-_]+Reference to a specific page in a result set.
The number of items per page in a result set.
Example response
POST /v2/tenants/{tenantUid}/stores/{storeUid}/warehouses/logs/search HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 139
{
"fromDateTime": "2025-08-11T18:08:31.789Z",
"toDateTime": "2025-08-11T18:08:31.789Z",
"warehouseUids": [
"text"
],
"transactionTypes": [
"RECEIVE"
]
}Example response
{
"items": [
{
"storeUid": "text",
"storeName": "text",
"warehouseUid": "text",
"warehouseName": "text",
"productUId": "text",
"productSku": "text",
"productName": "text",
"costDelta": 1,
"costNew": 1,
"costOrigin": 1,
"costTransaction": 1,
"createdAt": "2025-08-11T18:08:31.789Z",
"quantityDelta": 1,
"quantityNew": 1,
"quantityNotAvailable": 1,
"quantityOrigin": 1,
"reference": 1,
"serialnumber": "text",
"tenantUserUid": "text",
"tenantUserName": "text",
"transactionType": "RECEIVE"
}
],
"paging": {
"pageNumber": 1,
"pageSize": 1,
"totalCount": 1
}
}Was this helpful?