Check salable quantities

Adobe Commerce provides several endpoints that allow you to check whether a product from a specified stock is salable and the available quantity.

Service names:

Copy
inventorySalesApiGetProductSalabilityV1
inventorySalesApiIsProductSalableV1
inventorySalesApiAreProductsSalableV1
inventorySalesApiIsProductSalableForRequestedQtyV1
inventorySalesApiStockResolverV1
Copied to your clipboard
inventorySalesApiGetProductSalabilityV1
inventorySalesApiIsProductSalableV1
inventorySalesApiAreProductsSalableV1
inventorySalesApiIsProductSalableForRequestedQtyV1
inventorySalesApiStockResolverV1

REST endpoints:

Copy
GET /V1/inventory/get-product-salable-quantity/:sku/:stockId
GET /V1/inventory/is-product-salable/:sku/:stockId
GET /V1/inventory/are-products-salable/:skus[]/:stockId
GET /V1/inventory/is-product-salable-for-requested-qty/:sku/:stockId/:requestedQty
GET /V1/inventory/stock-resolver/:type/:code
Copied to your clipboard
GET /V1/inventory/get-product-salable-quantity/:sku/:stockId
GET /V1/inventory/is-product-salable/:sku/:stockId
GET /V1/inventory/are-products-salable/:skus[]/:stockId
GET /V1/inventory/is-product-salable-for-requested-qty/:sku/:stockId/:requestedQty
GET /V1/inventory/stock-resolver/:type/:code

Path parameters:

Check the available quantity of a salable product

This call returns the available quantity of a product assigned to the specified stock ID.

Sample Usage:

GET <host>/rest/<store_code>/V1/inventory/get-product-salable-quantity/sp2/2

Payload:

None

Response:

An integer indicating the salable quantity of the product, such as 75.

Check whether a product is salable

This call returns a boolean value that indicates whether the product from the specified stock is salable.

Sample Usage:

GET <host>/rest/<store_code>/V1/inventory/is-product-salable/sp2/2

Payload:

None

Response:

true or false

Check whether products in the list are salable

This call returns boolean values that indicate whether the products provided in the SKU parameter are salable from the specified stock.

Sample Usage:

GET <host>/rest/<store_code>/V1/inventory/are-products-salable/?skus[0]=Prod1&skus[1]=Prod2&stockId=2

Payload:

None

Response:

Copy
[
  {
    "sku": "Prod1",
    "stock_id": 2,
    "salable": true
  },
  {
    "sku": "Prod2",
    "stock_id": 2,
    "salable": false
  }
]
Copied to your clipboard
[
  {
    "sku": "Prod1",
    "stock_id": 2,
    "salable": true
  },
  {
    "sku": "Prod2",
    "stock_id": 2,
    "salable": false
  }
]

Check whether a product is salable for a specified quantity

This call indicates whether a product is salable for the specified quantity and stock ID.

Sample Usage:

GET <host>/rest/<store_code>/V1/inventory/is-product-salable-for-requested-qty/sp2/2/30

Payload:

None

Response:

Copy
{
  "salable": true,
  "errors": []
}
Copied to your clipboard
{
  "salable": true,
  "errors": []
}

Get the stock ID and name for a sales channel

This call returns the stock ID associated with the specified sales channel type and name.

Sample Usage:

GET <host>/rest/<store_code>/V1/inventory/stock-resolver/website/na_site

Payload:

None

Response:

Copy
{
  "stock_id": 2,
  "name": "North America Stock",
  "extension_attributes": {
    "sales_channels": [
      {
        "type": "website",
        "code": "na_site"
      }
    ]
  }
}
Copied to your clipboard
{
  "stock_id": 2,
  "name": "North America Stock",
  "extension_attributes": {
    "sales_channels": [
      {
        "type": "website",
        "code": "na_site"
      }
    ]
  }
}

Last updated 9/8/2023

Was this helpful?

Yes

No