Stocktaking | Flow Retail Docs

List all stocktakings

get

Lists all stocktakings for 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-_]+

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:

stocktakingStatusQuerystring · enumOptional

ENUM	Description
NOT_STARTED	Stock counting not started
IN_PROGRESS	Stock counting is in progress. Registraions can be made.
COMPLETE	Stock counting is complete
DELETED	Stock counting is deleted, stock not adjusted
CONTROL	Stock counting is in control mode, no further registrations can be made

Possible values:

stocktakingTypeQuerystring · enumOptional

ENUM	Description
FULL	Stock counting containing all productUids in tenant
PARTIAL	Stock counting containing a list of specific producdIds
RECOUNT	Make a new stock taking with a set of productUids to be recounted

Possible values:

Responses

200

Example response

application/json

get

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

200

Example response

{
  "items": [
    {
      "createdAt": "2025-07-30T18:09:13.669Z",
      "createdBy": "text",
      "description": "text",
      "lastModifiedAt": "2025-07-30T18:09:13.669Z",
      "lastModifiedBy": "text",
      "status": "NOT_STARTED",
      "stocktakingUid": "text",
      "type": "FULL",
      "warehouseUid": "text",
      "withStock": true
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Create new stocktaking

post

Create new stocktaking for 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-_]+

Body

Stock Counting request schema

descriptionstringRequired

typestring · enumRequired

ENUM	Description
FULL	Stock counting containing all productUids in tenant
PARTIAL	Stock counting containing a list of specific producdIds
RECOUNT	Make a new stock taking with a set of productUids to be recounted

Possible values:

withStockbooleanRequiredDefault: false

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

Responses

200

Example response

application/json

post

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

{
  "description": "text",
  "type": "FULL",
  "withStock": false,
  "stocktakingUid": "text"
}

200

Example response

{
  "createdAt": "2025-07-30T18:09:13.669Z",
  "createdBy": "text",
  "description": "text",
  "lastModifiedAt": "2025-07-30T18:09:13.669Z",
  "lastModifiedBy": "text",
  "status": "NOT_STARTED",
  "stocktakingUid": "text",
  "type": "FULL",
  "warehouseUid": "text",
  "withStock": true
}

Get stocktaking details

get

Get stocktaking details

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

stocktakingUidstringRequired

Reference to a Stocktaking.

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

Responses

200

Example response

application/json

get

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

200

Example response

{
  "createdAt": "2025-07-30T18:09:13.669Z",
  "createdBy": "text",
  "description": "text",
  "lastModifiedAt": "2025-07-30T18:09:13.669Z",
  "lastModifiedBy": "text",
  "status": "NOT_STARTED",
  "stocktakingUid": "text",
  "type": "FULL",
  "warehouseUid": "text",
  "withStock": true
}

Update stocktaking details

put

Update stocktaking for 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-_]+

stocktakingUidstringRequired

Reference to a Stocktaking.

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

Body

descriptionstringRequired

statusstring · enumRequired

ENUM	Description
NOT_STARTED	Stock counting not started
IN_PROGRESS	Stock counting is in progress. Registraions can be made.
COMPLETE	Stock counting is complete
DELETED	Stock counting is deleted, stock not adjusted
CONTROL	Stock counting is in control mode, no further registrations can be made

Possible values:

Responses

200

Example response

application/json

put

PUT /v2/tenants/{tenantUid}/stores/{storeUid}/warehouses/{warehouseUid}/stocktakings/{stocktakingUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "description": "text",
  "status": "NOT_STARTED"
}

200

Example response

{
  "createdAt": "2025-07-30T18:09:13.669Z",
  "createdBy": "text",
  "description": "text",
  "lastModifiedAt": "2025-07-30T18:09:13.669Z",
  "lastModifiedBy": "text",
  "status": "NOT_STARTED",
  "stocktakingUid": "text",
  "type": "FULL",
  "warehouseUid": "text",
  "withStock": true
}

Delete a stocktaking

delete

Delete a stocktaking

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

stocktakingUidstringRequired

Reference to a Stocktaking.

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

Responses

204

No Content

delete

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

204

No Content

No content

Get a stocktaking control list

get

Get a stocktaking control list

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

stocktakingUidstringRequired

Reference to a Stocktaking.

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

Query parameters

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:

pageNumberintegerOptional

Reference to a specific page in a result set.

pageSizeintegerOptional

The number of items per page in a result set.

hasDiffbooleanOptional

Only return stocktaking items with diff

hasRegistrationsbooleanOptional

Only return stocktaking items with registrations

Responses

200

Example response

application/json

get

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

200

Example response

{
  "createdAt": "2025-07-30T18:09:13.669Z",
  "createdBy": "text",
  "description": "text",
  "totals": {
    "productsWithPositiveDiffCount": 1,
    "positiveDiffAmount": 1,
    "productsWithNegativeDiffCount": 1,
    "negativeDiffAmount": 1,
    "stockValueAtStart": 1,
    "stockValueRegistered": 1
  },
  "items": [
    {
      "costPrice": 1,
      "brandName": "text",
      "createdAt": "2025-07-30T18:09:13.669Z",
      "createdBy": "text",
      "name": "text",
      "note": "text",
      "productGroupName": "text",
      "productUid": "text",
      "quantityDiff": 1,
      "quantityRegistered": 1,
      "quantityStock": 1,
      "sku": "text",
      "stocktakingItemUid": "text"
    }
  ],
  "lastModifiedAt": "2025-07-30T18:09:13.669Z",
  "lastModifiedBy": "text",
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  },
  "status": "NOT_STARTED",
  "stocktakingUid": "text",
  "warehouseUid": "text",
  "withStock": true
}

Get item list for a stocktaking

get

Get item list for a stocktaking

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

stocktakingUidstringRequired

Reference to a Stocktaking.

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

Query parameters

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:

pageNumberintegerOptional

Reference to a specific page in a result set.

pageSizeintegerOptional

The number of items per page in a result set.

Responses

200

Example response

application/json

get

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

200

Example response

{
  "items": [
    {
      "createdAt": "2025-07-30T18:09:13.669Z",
      "createdBy": "text",
      "lastModifiedAt": "2025-07-30T18:09:13.669Z",
      "lastModifiedBy": "text",
      "note": "text",
      "product": {
        "brandName": "text",
        "gtins": [
          "text"
        ],
        "name": "text",
        "productGroupName": "text",
        "productUid": "text",
        "serialNoRequired": "NO",
        "sku": "text"
      },
      "serialnumbers": [
        "text"
      ],
      "stocktakingItemUid": "text"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Add productUids to a stocktaking

post

Add productUids to a stocktaking

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

stocktakingUidstringRequired

Reference to a Stocktaking.

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

Body

productUidsstring[]Required

List of productUids to be added to a stocktaking

Responses

200

Example response

application/json

post

POST /v2/tenants/{tenantUid}/stores/{storeUid}/warehouses/{warehouseUid}/stocktakings/{stocktakingUid}/items HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "productUids": [
    "text"
  ]
}

200

Example response

{
  "items": [
    {
      "createdAt": "2025-07-30T18:09:13.669Z",
      "createdBy": "text",
      "lastModifiedAt": "2025-07-30T18:09:13.669Z",
      "lastModifiedBy": "text",
      "note": "text",
      "product": {
        "brandName": "text",
        "gtins": [
          "text"
        ],
        "name": "text",
        "productGroupName": "text",
        "productUid": "text",
        "serialNoRequired": "NO",
        "sku": "text"
      },
      "serialnumbers": [
        "text"
      ],
      "stocktakingItemUid": "text"
    }
  ]
}

Get an item on a stocktaking

get

Get details for a specific item on a stocktaking

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

stocktakingUidstringRequired

Reference to a Stocktaking.

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

stocktakingItemUidstringRequired

Reference to a Stocktaking item id.

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

Responses

200Success

application/json

get

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

200Success

{
  "createdAt": "2025-07-30T18:09:13.669Z",
  "createdBy": "text",
  "lastModifiedAt": "2025-07-30T18:09:13.669Z",
  "lastModifiedBy": "text",
  "note": "text",
  "product": {
    "brandName": "text",
    "gtins": [
      "text"
    ],
    "name": "text",
    "productGroupName": "text",
    "productUid": "text",
    "serialNoRequired": "NO",
    "sku": "text"
  },
  "serialnumbers": [
    "text"
  ],
  "stocktakingItemUid": "text"
}

Update an item on a stocktaking

put

Update note on a stock taking item

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

stocktakingUidstringRequired

Reference to a Stocktaking.

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

stocktakingItemUidstringRequired

Reference to a Stocktaking item id.

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

Body

Update a stocktaking item

notestringRequired

Responses

200Success

application/json

put

PUT /v2/tenants/{tenantUid}/stores/{storeUid}/warehouses/{warehouseUid}/stocktakings/{stocktakingUid}/items/{stocktakingItemUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "note": "text"
}

200Success

{
  "createdAt": "2025-07-30T18:09:13.669Z",
  "createdBy": "text",
  "lastModifiedAt": "2025-07-30T18:09:13.669Z",
  "lastModifiedBy": "text",
  "note": "text",
  "product": {
    "brandName": "text",
    "gtins": [
      "text"
    ],
    "name": "text",
    "productGroupName": "text",
    "productUid": "text",
    "serialNoRequired": "NO",
    "sku": "text"
  },
  "serialnumbers": [
    "text"
  ],
  "stocktakingItemUid": "text"
}

Delete an item from a stocktaking

delete

Delete an item from a stocktaking with all registrations

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

stocktakingUidstringRequired

Reference to a Stocktaking.

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

stocktakingItemUidstringRequired

Reference to a Stocktaking item id.

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

Responses

204

No Content

delete

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

204

No Content

No content

Get all registrations for a stocktaking item

get

Get all registrations for a stocktaking item

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

stocktakingUidstringRequired

Reference to a Stocktaking.

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

stocktakingItemUidstringRequired

Reference to a Stocktaking item id.

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

Query parameters

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:

pageNumberintegerOptional

Reference to a specific page in a result set.

pageSizeintegerOptional

The number of items per page in a result set.

Responses

200

Example response

application/json

get

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

200

Example response

{
  "items": [
    {
      "stocktakingRegistrationUid": "text",
      "createdAt": "2025-07-30T18:09:13.669Z",
      "createdBy": "text",
      "quantity": 1,
      "serialnumber": "text",
      "note": "text"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Make a stocktaking registration

post

A stocktaking registration can only be done while stocktaking has status IN_PROGRESS.

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

stocktakingUidstringRequired

Reference to a Stocktaking.

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

Body

Schema for a list of stocktaking registrations

Responses

204

OK

post

POST /v2/tenants/{tenantUid}/stores/{storeUid}/warehouses/{warehouseUid}/stocktakings/{stocktakingUid}/register HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 82

{
  "items": [
    {
      "productUid": "text",
      "quantity": 1,
      "serialnumber": "text",
      "note": "text"
    }
  ]
}

204

OK

No content

Download stocktaking report

get

Report for a COMPLETE Stocktaking

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

stocktakingUidstringRequired

Reference to a Stocktaking.

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

Query parameters

hasDiffbooleanOptional

Only return stocktaking items with diff

hasRegistrationsbooleanOptional

Only return stocktaking items with registrations

Responses

200

Example response

Responsestring · binary

get

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

200

Example response

binary