/bff/warehouse/stocktake/create

Create stocktake session (Tier 1 #2)

WarehousepostBffWarehouseStocktakeCreate

Parameters

JSON body

Request body

application/json

warehouseIdnumberRequired

locationIdnumber | nullOptional

One of 2:

Variant 1

number

Variant 2

null

namestringRequired

Length: 1–∞

filterNotestring | nullOptional

One of 2:

Variant 1

string

Variant 2

null

lockScopebooleanOptional

snapshotbooleanOptional

notestring | nullOptional

One of 2:

Variant 1

string

Variant 2

null

startedByMemberIdnumber | nullOptional

One of 2:

Variant 1

number

Variant 2

null

Response schema

1 status code documented

200Success

successbooleanRequired

sessionIdnumberRequired

itemCountnumberRequired

Response example

application/json

{
  "success": false,
  "sessionId": 0,
  "itemCount": 0
}

Request example

POST /bff/warehouse/stocktake/create

post

curl -X POST "https://api.bizkithub.com/bff/warehouse/stocktake/create" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "warehouseId": 0,
  "name": "example_name",
  "lockScope": false,
  "snapshot": false
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key