Products

Bulk List Stock

Fetches stock data for a set list of products.

PUT

/v1/products/variations/stocks_v2

Bulk List Stock

curl --request PUT \
  --url 'https://public-api.bladepro.io/v1/products/variations/stocks_v2?expand=%3Cstring%3E' \
  --header 'Content-Type: application/json' \
  --data '
{
  "product_variation_id": "<any>",
  "warehouse_code": "<string>"
}
'

{
  "data": [
    {
      "expected": 1,
      "on_hand": {
        "available": 1,
        "committed": {
          "allocated": 1,
          "committed_total": 1,
          "picked": 1
        },
        "on_hand_total": 1,
        "under_investigation": 1,
        "unsaleable": {
          "batch_reserved": 1,
          "expired": 1,
          "goodsin_processing": 1,
          "quarantine": 1,
          "returns_processing": 1,
          "ring_fenced": 1,
          "stock_processing": 1,
          "unsaleable_total": 1
        }
      },
      "product_variation_id": 1,
      "warehouse_code": "CHR",
      "warehouse_id": 1,
      "warehouse_name": "Christchurch"
    }
  ],
  "meta": {
    "request_reference": "233f2gjwz-c893v86"
  }
}

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

Query Parameters

expandstringquery

Usage: expand=*

Expand on_hand, on_hand.committed, on_hand.unsaleable

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

expectednumber

Stock Expected

on_handobject

Stock On Hand.

Show child attributes

product_variation_idnumber

Product variation ID.

warehouse_codestring

Warehouse code.

warehouse_idnumber

Warehouse ID.

warehouse_namestring

Warehouse name.

Still need help? Share an idea