Warehouse

List warehouses

get

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

List all warehouses.

Authorizations

AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

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

Possible values:

Responses

200

Example response

application/json

get

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

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-12-14T03:09:37.980Z",
      "externalId": "text",
      "lastModifiedAt": "2025-12-14T03:09:37.980Z",
      "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

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

Create a new warehouse.

Authorizations

AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters

storeUidstringRequired

Reference to a Store.

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

tenantUidstringRequired

Reference to a tenant.

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

Body

and

Responses

200

Example response

application/json

post

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

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-12-14T03:09:37.980Z",
  "externalId": "text",
  "lastModifiedAt": "2025-12-14T03:09:37.980Z",
  "name": "text",
  "warehouseUid": "text",
  "accessList": [
    {
      "role": "DELIVER",
      "storeUid": "text",
      "storeName": "text",
      "warehouseUid": "text",
      "warehouseName": "text",
      "warehouseAccessUid": "text"
    }
  ]
}

List warehouse access

get

/tenants/{tenantUid}/stores/{storeUid}/warehouses/access

Lists all warehouses this store has access to.

Authorizations

AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

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

Possible values:

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:

Responses

200

Example response

application/json

get

/tenants/{tenantUid}/stores/{storeUid}/warehouses/access

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

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

Get details a warehouse.

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

Responses

200

Example response

application/json

get

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

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-12-14T03:09:37.980Z",
  "externalId": "text",
  "lastModifiedAt": "2025-12-14T03:09:37.980Z",
  "name": "text",
  "warehouseUid": "text",
  "accessList": [
    {
      "role": "DELIVER",
      "storeUid": "text",
      "storeName": "text",
      "warehouseUid": "text",
      "warehouseName": "text",
      "warehouseAccessUid": "text"
    }
  ]
}

Update warehouse details

put

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

Update details for a warehouse. Partial updates are allowed.

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

Body

externalIdstringOptional

namestringRequired

Responses

200

Example response

application/json

put

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

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-12-14T03:09:37.980Z",
  "externalId": "text",
  "lastModifiedAt": "2025-12-14T03:09:37.980Z",
  "name": "text",
  "warehouseUid": "text",
  "accessList": [
    {
      "role": "DELIVER",
      "storeUid": "text",
      "storeName": "text",
      "warehouseUid": "text",
      "warehouseName": "text",
      "warehouseAccessUid": "text"
    }
  ]
}

Delete a warehouse

delete

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

Deletes a warehouse.

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

Responses

204

No Content

No content

delete

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

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

204

No Content

No content

Grant warehouse access

post

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

Grants access for a store to a warehouse.

Authorizations

AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

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.

Possible values:

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

Responses

200

Example response

application/json

post

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

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-12-14T03:09:37.980Z",
    "externalId": "text",
    "lastModifiedAt": "2025-12-14T03:09:37.980Z",
    "name": "text",
    "warehouseUid": "text",
    "accessList": [
      {
        "role": "DELIVER",
        "storeUid": "text",
        "storeName": "text",
        "warehouseUid": "text",
        "warehouseName": "text",
        "warehouseAccessUid": "text"
      }
    ]
  },
  "warehouseAccessUid": "text"
}

Revoke warehouse access

delete

/tenants/{tenantUid}/stores/{storeUid}/warehouses/{warehouseUid}/access/{warehouseAccessUid}

Revokes access for a store to a warehouse.

Authorizations

AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

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

204

No Content

No content

delete

/tenants/{tenantUid}/stores/{storeUid}/warehouses/{warehouseUid}/access/{warehouseAccessUid}

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

No content

BATCH Set stock for a list of products in a warehouse

put

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

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

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

Body

Responses

200

The success field indicate how many of the products that where successfully updated. The errors field will contain the products that failed to update.

207

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

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

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

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

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

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

200

Example response

application/json

put

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

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

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

Update details for a product on a warehouse

Authorizations

AuthorizationstringRequired

Token received from the auth service

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

200

Example response

application/json

put

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

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

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

Returns stock logs 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-_]+

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

200

Example response

application/json

post

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

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-12-14T03:09:37.980Z",
  "serialnumber": "text",
  "tenantUserUid": "text",
  "toDateTime": "2025-12-14T03:09:37.980Z"
}

200

Example response

{
  "items": [
    {
      "costDelta": 1,
      "costNew": 1,
      "costOrigin": 1,
      "costTransaction": 1,
      "createdAt": "2025-12-14T03:09:37.980Z",
      "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

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

Move stock for a product to another warehouse.

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

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

Body

quantityintegerRequired

serialnumbersstring[]Optional

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

Responses

200

Example response

application/json

post

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

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

List all serial number information for a product in a warehouse

get

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

List all serial number information for a product in a 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-_]+

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:

Responses

200

Example response

application/json

get

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

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-12-14T03:09:37.980Z",
      "deliveredAt": "2025-12-14T03:09:37.980Z",
      "lastModifiedAt": "2025-12-14T03:09:37.980Z",
      "origin": "RECEIVE",
      "receivedAt": "2025-12-14T03:09:37.980Z",
      "serialnumber": "text"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Check availability on a serial number for warehouse and product.

get

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

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

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

serialnumberstringRequired

Reference to a serialnumber.

Query parameters

availabilityTypestring · enumOptional

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

Possible values:

Responses

200

get

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

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

Warehouse stock history

post

/tenants/{tenantUid}/stores/{storeUid}/warehouses/logs/search

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

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.

Body

Responses

200

Example response

application/json

post

/tenants/{tenantUid}/stores/{storeUid}/warehouses/logs/search

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-12-14T03:09:37.980Z",
  "toDateTime": "2025-12-14T03:09:37.980Z",
  "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-12-14T03:09:37.980Z",
      "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
  }
}

PreviousUser NextWebhooks

Last updated 8 months ago

Was this helpful?