Warehouse

PreviousUser NextWebhooks

Was this helpful?

List warehouse access

get

Lists all warehouses this store has access to.

Authorizations

Path parameters

storeUidstringrequired

Reference to a Store.

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

tenantUidstringrequired

Reference to a tenant.

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

Query parameters

warehouseRolestring · enumoptional

Reference to a warehouse role

ENUM	Description
DELIVER
MOVE
RECEIVE
RESERVE
RETURN
VIEW

Available options:

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}/stores/{storeUid}/warehouses/access HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "items": [
    {
      "role": "DELIVER",
      "storeUid": "text",
      "storeName": "text",
      "warehouseUid": "text",
      "warehouseName": "text",
      "warehouseAccessUid": "text"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Get warehouse details

get

Get details a warehouse.

Authorizations

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

Responses

application/json

objectoptional

get

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

200

Example response

{
  "createdAt": "2025-04-18T01:27:41.354Z",
  "externalId": "text",
  "lastModifiedAt": "2025-04-18T01:27:41.354Z",
  "name": "text",
  "warehouseUid": "text",
  "accessList": [
    {
      "role": "DELIVER",
      "storeUid": "text",
      "storeName": "text",
      "warehouseUid": "text",
      "warehouseName": "text",
      "warehouseAccessUid": "text"
    }
  ]
}

Delete a warehouse

delete

Deletes a warehouse.

Authorizations

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

Responses

delete

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

204

No Content

Revoke warehouse access

delete

Revokes access for a store to a warehouse.

Authorizations

Path parameters

storeUidstringrequired

Reference to a Store.

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

warehouseAccessUidstringrequired

Reference to details about a stores access level to a warehouse.

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

warehouseUidstringrequired

Reference to a Warehouse.

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

tenantUidstringrequired

Reference to a tenant.

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

Responses

delete

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

204

No Content

Get stock for product in specified warehouse

get

Returns stock for a particular product in the specified warehouse.

Authorizations

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

application/json

objectoptional

get

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"
}

List all serial number information for a product in a warehouse

get

List all serial number information for a product in a warehouse

Authorizations

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

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:

Responses

application/json

objectoptional

get

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

200

Example response

{
  "items": [
    {
      "costPrice": 1,
      "createdAt": "2025-04-18T01:27:41.354Z",
      "deliveredAt": "2025-04-18T01:27:41.354Z",
      "lastModifiedAt": "2025-04-18T01:27:41.354Z",
      "origin": "RECEIVE",
      "receivedAt": "2025-04-18T01:27:41.354Z",
      "serialnumber": "text"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Check availability on a serial number for warehouse and product.

get

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.

Authorizations

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

serialnumberstringrequired

Reference to a serialnumber.

Query parameters

availabilityTypestring · enumoptional

ENUM	Description
RECEIVE - Check for receive serial number
DELIVER - Check for deliver serial number

Available options:

Responses

get

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: */*

200

No Content

List warehouses

get

List all warehouses.

Authorizations

Path parameters

storeUidstringrequired

Reference to a Store.

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

tenantUidstringrequired

Reference to a tenant.

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

Query parameters

warehouseExternalIdstringoptional

External reference to a warehouse.

warehouseNamestringoptional

Reference to the name of a warehouse.

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}/stores/{storeUid}/warehouses HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "items": [
    {
      "createdAt": "2025-04-18T01:27:41.354Z",
      "externalId": "text",
      "lastModifiedAt": "2025-04-18T01:27:41.354Z",
      "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

post

Create a new warehouse.

Authorizations

Path parameters

storeUidstringrequired

Reference to a Store.

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

tenantUidstringrequired

Reference to a tenant.

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

Body

all ofoptional

Responses

application/json

objectoptional

post

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"
}

200

Example response

{
  "createdAt": "2025-04-18T01:27:41.354Z",
  "externalId": "text",
  "lastModifiedAt": "2025-04-18T01:27:41.354Z",
  "name": "text",
  "warehouseUid": "text",
  "accessList": [
    {
      "role": "DELIVER",
      "storeUid": "text",
      "storeName": "text",
      "warehouseUid": "text",
      "warehouseName": "text",
      "warehouseAccessUid": "text"
    }
  ]
}

Update warehouse details

put

Update details for a warehouse. Partial updates are allowed.

Authorizations

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

Body

externalIdstringoptional

namestringrequired

Responses

application/json

objectoptional

put

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"
}

200

Example response

{
  "createdAt": "2025-04-18T01:27:41.354Z",
  "externalId": "text",
  "lastModifiedAt": "2025-04-18T01:27:41.354Z",
  "name": "text",
  "warehouseUid": "text",
  "accessList": [
    {
      "role": "DELIVER",
      "storeUid": "text",
      "storeName": "text",
      "warehouseUid": "text",
      "warehouseName": "text",
      "warehouseAccessUid": "text"
    }
  ]
}

Grant warehouse access

post

Grants access for a store to a warehouse.

Authorizations

Path parameters

storeUidstringrequired

Reference to a Store.

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

warehouseUidstringrequired

Reference to a Warehouse.

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

tenantUidstringrequired

Reference to a tenant.

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

Body

rolestring · enumrequired

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.

Available options:

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

Responses

application/json

objectoptional

post

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"
}

200

Example response

{
  "role": "DELIVER",
  "storeUid": "text",
  "warehouse": {
    "createdAt": "2025-04-18T01:27:41.354Z",
    "externalId": "text",
    "lastModifiedAt": "2025-04-18T01:27:41.354Z",
    "name": "text",
    "warehouseUid": "text",
    "accessList": [
      {
        "role": "DELIVER",
        "storeUid": "text",
        "storeName": "text",
        "warehouseUid": "text",
        "warehouseName": "text",
        "warehouseAccessUid": "text"
      }
    ]
  },
  "warehouseAccessUid": "text"
}

BATCH Set stock for a list of products in a warehouse

put

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.

Authorizations

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

Body

upsertobject[] · max: 1000required

Responses

objectoptional

put

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
    }
  ]
}

Set stock for product in specified warehouse

put

Authorizations

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

Body

averageCostintegeroptional

set new average cost

quantityintegeroptional

set new stock quantity

changeQuantityintegeroptional

make stock adjustment

reasonstringrequired

serialnumbersstring[]optional

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"

Responses

application/json

object | nullableoptional

put

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"
  ]
}

200

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

put

Update details for a product on a warehouse

Authorizations

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

Body

locationLabelstringoptional

maxStockLevelintegeroptional

minStockLevelintegeroptional

Responses

application/json

objectoptional

put

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
}

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"
}

Search in stock logs for product in specified warehouse

post

Returns stock logs for a particular product in the specified warehouse.

Authorizations

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

Query parameters

pageNumberintegeroptional

Reference to a specific page in a result set.

pageSizeintegeroptional

The number of items per page in a result set.

Body

fromDateTimestring · date-timeoptional

serialnumberstringoptional

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

toDateTimestring · date-timeoptional

Responses

application/json

objectoptional

post

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-04-18T01:27:41.354Z",
  "serialnumber": "text",
  "tenantUserUid": "text",
  "toDateTime": "2025-04-18T01:27:41.354Z"
}

200

Example response

{
  "items": [
    {
      "costDelta": 1,
      "costNew": 1,
      "costOrigin": 1,
      "costTransaction": 1,
      "createdAt": "2025-04-18T01:27:41.354Z",
      "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 from one warehouse to another

post

Move stock for a product to another warehouse.

The response will show the stock details for the warehouse you are moving from

Authorizations

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

Body

quantityintegerrequired

serialnumbersstring[]optional

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

Responses

application/json

objectoptional

post

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"
}

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"
}

Warehouse stock history

post

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.

Authorizations

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.

Body

all ofoptional

Responses

application/json

objectoptional

post

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-04-18T01:27:41.354Z",
  "toDateTime": "2025-04-18T01:27:41.354Z",
  "warehouseUids": [
    "text"
  ],
  "transactionTypes": [
    "RECEIVE"
  ]
}

200

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-04-18T01:27:41.354Z",
      "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
  }
}