BizKitHub Developer Documentation

Parameters

8 query

Query parameters

· 8

warehouseIdstringOptional

Exampleexample_warehouseId

locationIdstringOptional

Exampleexample_locationId

productIdstringOptional

Exampleexample_productId

productVariantIdstringOptional

Exampleexample_productVariantId

searchstringOptional

Exampleexample_search

onlyPositivestringOptional

Exampleexample_onlyPositive

limitstringOptional

Exampleexample_limit

offsetstringOptional

Exampleexample_offset

Response schema

1 status code documented

200Success

itemsobject[]Required

Each array item:

idnumberRequired

warehouseIdnumberRequired

warehouseNamestringRequired

warehouseCodestringRequired

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

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

quantityReservednumberRequired

Active reservations against this cell (Tier 1 #1).

availablenumberRequired

quantity - quantityReserved.

lowStockThresholdnumber | nullRequired

One of 2:

Variant 1

number

Variant 2

null

insertedDatestringRequired

updatedDatestringRequired

itemCountnumberRequired

Response example

application/json

{
  "items": [
    {
      "id": 0,
      "warehouseId": 0,
      "warehouseName": "example_warehouseName",
      "warehouseCode": "example_warehouseCode",
      "itemLabel": "example_itemLabel",
      "quantity": 0,
      "quantityReserved": 0,
      "available": 0,
      "insertedDate": "example_insertedDate",
      "updatedDate": "example_updatedDate"
    }
  ],
  "itemCount": 0
}

/bff/warehouse/stock/list

Parameters

Query parameters

Response schema

Response example

Request example

Need an API key?