Products

Bulk List Stock with Batch Codes

Fetches batch stock data for a set list of products.

PUT

/v1/products/variations/stocks/batch_code

curl --request PUT \
  --url https://public-api.bladepro.io/v1/products/variations/stocks/batch_code \
  --header 'Content-Type: application/json' \
  --data '
{
  "product_variation_id": "<any>",
  "warehouse_code": "<string>"
}
'

{
  "data": [
    {
      "allocated": 10,
      "available": 121,
      "batch_code": "1234",
      "expected": 100,
      "misc": 34,
      "product_variation_id": 1,
      "saleable": 134,
      "total": 156,
      "total_saleable": 140,
      "under_investigation": 1,
      "warehouse_code": "CHR",
      "warehouse_id": 1,
      "warehouse_name": "Christchurch"
    }
  ],
  "meta": {
    "request_reference": "233f2gjwz-c893v86"
  }
}

Scope(s): APP::PRODUCTS::READ

Body

product_variation_idanyrequired

List of product variation ID's.

warehouse_codestring

Warehouse code to limit the results to. If omitted or null, it won't be applied as a filter.

Response

successful operation

allocatednumber

Allocated units.

availablenumber

Available units.

batch_codestring

Natch code.

expectednumber

Expected units.

miscnumber

Misc units.

product_variation_idnumber

Product variation ID.

saleablenumber

Saleable units.

totalnumber

Total number of units available.

total_saleablenumber

Total number of units saleable.

under_investigationnumber

Stock under investigation.

warehouse_codestring

Warehouse code.

warehouse_idnumber

Warehouse ID.

warehouse_namestring

Warehouse name.

Still need help? Share an idea