BizKitHub
DocsAPI ReferenceWarehouse/bff/warehouse/movement/list
getWarehouseAdmin BFF

/bff/warehouse/movement/list

List movements (audit log)

WarehousegetBffWarehouseMovementList

Parameters

11 query

Query parameters

· 11
warehouseIdstringOptional
Exampleexample_warehouseId
productIdstringOptional

Numeric product id (alternative to productCode).

Exampleexample_productId
productCodestringOptional

Product code (preferred over productId).

Exampleexample_productCode
productVariantIdstringOptional

Numeric variant id (alternative to productVariantCode).

Exampleexample_productVariantId
productVariantCodestringOptional

Variant code; requires productCode.

Exampleexample_productVariantCode
typestringOptional

inbound | outbound | transfer | adjustment | reservation | reservation_release | reservation_commit

Exampleexample_type
orderIdstringOptional

Filter movements coupled to one order (Tier 1 reservation/commit linkage).

Exampleexample_orderId
dateFromstringOptional

ISO datetime — lower bound (inclusive).

Exampleexample_dateFrom
dateTostringOptional

ISO datetime — upper bound (exclusive).

Exampleexample_dateTo
limitstringOptional
Exampleexample_limit
offsetstringOptional
Exampleexample_offset

Response schema

1 status code documented

200Success
itemsobject[]Required
Each array item:
idnumberRequired
type"inbound" | "outbound" | "transfer" | "adjustment" | "reservation" | "reservation_release" | "reservation_commit"Required
sourceWarehouseIdnumber | nullRequired
One of 2:
Variant 1
number
Variant 2
null
sourceWarehouseNamestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
sourceLocationIdnumber | nullRequired
One of 2:
Variant 1
number
Variant 2
null
sourceLocationCodestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
targetWarehouseIdnumber | nullRequired
One of 2:
Variant 1
number
Variant 2
null
targetWarehouseNamestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
targetLocationIdnumber | nullRequired
One of 2:
Variant 1
number
Variant 2
null
targetLocationCodestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
productIdnumber | nullRequired
One of 2:
Variant 1
number
Variant 2
null
productCodestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
productNamestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
productVariantIdnumber | nullRequired
One of 2:
Variant 1
number
Variant 2
null
variantCodestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
variantNamestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
virtualItemSkustring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
itemLabelstringRequired
quantitynumberRequired
notestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
performedByMemberIdnumber | nullRequired
One of 2:
Variant 1
number
Variant 2
null
performedByMemberNamestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
performedDatestringRequired
orderIdnumber | nullRequired
One of 2:
Variant 1
number
Variant 2
null
orderItemIdnumber | nullRequired
One of 2:
Variant 1
number
Variant 2
null
linkedMovementIdnumber | nullRequired
One of 2:
Variant 1
number
Variant 2
null
reservationIdnumber | nullRequired
One of 2:
Variant 1
number
Variant 2
null
stocktakeSessionIdnumber | nullRequired
One of 2:
Variant 1
number
Variant 2
null
expiresAtstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
itemCountnumberRequired

Response example

application/json
{
  "items": [
    {
      "id": 0,
      "itemLabel": "example_itemLabel",
      "quantity": 0,
      "performedDate": "example_performedDate"
    }
  ],
  "itemCount": 0
}

Request example

GET /bff/warehouse/movement/list

get
curl -X GET "https://api.bizkithub.com/bff/warehouse/movement/list?warehouseId=example_warehouseId&productId=example_productId&productCode=example_productCode&productVariantId=example_productVariantId&productVariantCode=example_productVariantCode&type=example_type&orderId=example_orderId&dateFrom=example_dateFrom&dateTo=example_dateTo&limit=example_limit&offset=example_offset" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key