BizKitHub Developer Documentation

Parameters

4 query

Query parameters

· 4

warehouseIdstringOptional

Exampleexample_warehouseId

statusstringOptional

draft | in_progress | review | approved | cancelled

Exampleexample_status

limitstringOptional

Exampleexample_limit

offsetstringOptional

Exampleexample_offset

Response schema

1 status code documented

200Success

itemsobject[]Required

Each array item:

idnumberRequired

warehouseIdnumberRequired

warehouseNamestringRequired

locationIdnumber | nullRequired

One of 2:

Variant 1

number

Variant 2

null

locationCodestring | nullRequired

One of 2:

Variant 1

string

Variant 2

null

locationNamestring | nullRequired

One of 2:

Variant 1

string

Variant 2

null

namestringRequired

statusstringRequired

lockScopebooleanRequired

filterNotestring | nullRequired

One of 2:

Variant 1

string

Variant 2

null

notestring | nullRequired

One of 2:

Variant 1

string

Variant 2

null

startedByMemberIdnumber | nullRequired

One of 2:

Variant 1

number

Variant 2

null

startedByMemberNamestring | nullRequired

One of 2:

Variant 1

string

Variant 2

null

startedDatestring | nullRequired

One of 2:

Variant 1

string

Variant 2

null

submittedDatestring | nullRequired

One of 2:

Variant 1

string

Variant 2

null

approvedDatestring | nullRequired

One of 2:

Variant 1

string

Variant 2

null

cancelledDatestring | nullRequired

One of 2:

Variant 1

string

Variant 2

null

insertedDatestringRequired

updatedDatestringRequired

itemCountnumberRequired

countedItemCountnumberRequired

discrepancyCountnumberRequired

totalAbsDiscrepancynumberRequired

itemCountnumberRequired

Response example

application/json

{
  "items": [
    {
      "id": 0,
      "warehouseId": 0,
      "warehouseName": "example_warehouseName",
      "name": "example_name",
      "status": "example_status",
      "lockScope": false,
      "insertedDate": "example_insertedDate",
      "updatedDate": "example_updatedDate",
      "itemCount": 0,
      "countedItemCount": 0,
      "discrepancyCount": 0,
      "totalAbsDiscrepancy": 0
    }
  ],
  "itemCount": 0
}

/bff/warehouse/stocktake/list

Parameters

Query parameters

Response schema

Response example

Request example

Need an API key?