Stocktaking

Stocktaking

List all stocktakings

get

Lists all stocktakings for a warehouse.

Authorizations

accessTokenauthTokenintegrationToken

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

Available options:

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

Available options:

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

Available options:

Responses

application/json

objectoptional

get

HTTPcURLJavaScriptPython

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-04-18T01:09:48.749Z",
      "createdBy": "text",
      "description": "text",
      "lastModifiedAt": "2025-04-18T01:09:48.749Z",
      "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

accessTokenintegrationTokenauthToken

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

Available options:

withStockbooleanrequiredDefault: false

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

Responses

application/json

objectoptional

Stock Counting response schema

post

HTTPcURLJavaScriptPython

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: 77

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

200

Example response

{
  "createdAt": "2025-04-18T01:09:48.749Z",
  "createdBy": "text",
  "description": "text",
  "lastModifiedAt": "2025-04-18T01:09:48.749Z",
  "lastModifiedBy": "text",
  "status": "NOT_STARTED",
  "stocktakingUid": "text",
  "type": "FULL",
  "warehouseUid": "text",
  "withStock": true
}

Get stocktaking details

get

Get stocktaking details

Authorizations

accessTokenauthTokenintegrationToken

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

application/json

objectoptional

Stock Counting response schema

get

HTTPcURLJavaScriptPython

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-04-18T01:09:48.749Z",
  "createdBy": "text",
  "description": "text",
  "lastModifiedAt": "2025-04-18T01:09:48.749Z",
  "lastModifiedBy": "text",
  "status": "NOT_STARTED",
  "stocktakingUid": "text",
  "type": "FULL",
  "warehouseUid": "text",
  "withStock": true
}

Update stocktaking details

put

Update stocktaking for warehouse

Authorizations

accessTokenintegrationTokenauthToken

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

Available options:

Responses

application/json

objectoptional

Stock Counting response schema

put

HTTPcURLJavaScriptPython

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-04-18T01:09:48.749Z",
  "createdBy": "text",
  "description": "text",
  "lastModifiedAt": "2025-04-18T01:09:48.749Z",
  "lastModifiedBy": "text",
  "status": "NOT_STARTED",
  "stocktakingUid": "text",
  "type": "FULL",
  "warehouseUid": "text",
  "withStock": true
}

Delete a stocktaking

delete

Delete a stocktaking

Authorizations

accessTokenauthTokenintegrationToken

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

delete

HTTPcURLJavaScriptPython

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

accessTokenauthTokenintegrationToken

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

Available options:

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

application/json

objectoptional

StocktakingControlResponseSchema

get

HTTPcURLJavaScriptPython

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-04-18T01:09:48.749Z",
  "createdBy": "text",
  "description": "text",
  "totals": {
    "productsWithPositiveDiffCount": 1,
    "positiveDiffAmount": 1,
    "productsWithNegativeDiffCount": 1,
    "negativeDiffAmount": 1,
    "stockValueAtStart": 1,
    "stockValueRegistered": 1
  },
  "items": [
    {
      "costPrice": 1,
      "brandName": "text",
      "createdAt": "2025-04-18T01:09:48.749Z",
      "createdBy": "text",
      "name": "text",
      "note": "text",
      "productGroupName": "text",
      "productUid": "text",
      "quantityDiff": 1,
      "quantityRegistered": 1,
      "quantityStock": 1,
      "sku": "text",
      "stocktakingItemUid": "text"
    }
  ],
  "lastModifiedAt": "2025-04-18T01:09:48.749Z",
  "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

accessTokenauthTokenintegrationToken

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

Available options:

pageNumberintegeroptional

Reference to a specific page in a result set.

pageSizeintegeroptional

The number of items per page in a result set.

Responses

application/json

objectoptional

get

HTTPcURLJavaScriptPython

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-04-18T01:09:48.749Z",
      "createdBy": "text",
      "lastModifiedAt": "2025-04-18T01:09:48.749Z",
      "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

accessTokenintegrationTokenauthToken

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

application/json

objectoptional

post

HTTPcURLJavaScriptPython

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-04-18T01:09:48.749Z",
      "createdBy": "text",
      "lastModifiedAt": "2025-04-18T01:09:48.749Z",
      "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

accessTokenauthTokenintegrationToken

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

application/json

objectoptional

Items in a stocktaking

get

HTTPcURLJavaScriptPython

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-04-18T01:09:48.749Z",
  "createdBy": "text",
  "lastModifiedAt": "2025-04-18T01:09:48.749Z",
  "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

accessTokenauthTokenintegrationToken

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

application/json

objectoptional

Items in a stocktaking

put

HTTPcURLJavaScriptPython

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-04-18T01:09:48.749Z",
  "createdBy": "text",
  "lastModifiedAt": "2025-04-18T01:09:48.749Z",
  "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

accessTokenauthTokenintegrationToken

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

delete

HTTPcURLJavaScriptPython

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

accessTokenauthTokenintegrationToken

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

Available options:

pageNumberintegeroptional

Reference to a specific page in a result set.

pageSizeintegeroptional

The number of items per page in a result set.

Responses

application/json

objectoptional

get

HTTPcURLJavaScriptPython

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-04-18T01:09:48.749Z",
      "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

accessTokenauthTokenintegrationToken

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

itemsobject[]required

Schema for a stocktaking registration

Responses

post

HTTPcURLJavaScriptPython

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

accessTokenauthTokenintegrationToken

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

application/pdfapplication/vnd.openxmlformats-officedocument.spreadsheetml.sheet

string · binaryoptional

get

HTTPcURLJavaScriptPython

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