# List availability on products in basket

Lists OnHand data based on basket items. Only deliverable items will be regarded. The result is a list of ProductOnHand where each product has a list of warehoues matching the warehouse specification passed in. ProductOnHand.Variants will always be null when getting this data for a basket. OnHand for each warehouse will always be returned whether or not the warehouse has the item or not. OnHand.IsActive = false indicates the item does not exist at the warehouse so only active OnHands should be used when checking availability.

Endpoint: POST /ListProductOnHandByBasket
Version: 1.1

## Query parameters:

  - `basketId` (integer, required)
    The internal basket id.

  - `pricelistSeed` (string)
    A comma separated list of internal pricelist ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.

  - `cultureCode` (string)
    Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

  - `currencyId` (string)
    Ignored.

## Request fields (application/json):

  - `StoreId` (integer,null)
    The store internal id for the current store. Can be null if WarehouseId and LocationId are supplied.

  - `WarehouseId` (integer,null)
    The internal id for the warehouse. Can be null if StoreId is supplied.

  - `LocationId` (integer,null)
    The internal id for the warehouse location. Can be null if StoreId is supplied.

  - `OnHand` (object)

  - `OnHand.Value` (number)
    The aggregated value from all warehouses and locations in the current context (Web, Supplier or Store).

  - `OnHand.IncomingValue` (number)
    The incoming quantity on the next delivery.

  - `OnHand.NextDeliveryDate` (string,null)
    The next delivery data from supplier to client warehouse.

  - `OnHand.LeadtimeDayCount` (integer,null)
    The number of days it takes to ship from the supplier.

  - `OnHand.LastChecked` (string,null)
    When onHand info was last checked. Null if never.

  - `OnHand.IsActive` (boolean)
    Indicate if the product is stocked in a store.

  - `OnHand.IsReturnable` (boolean)
    Indicate if the product is returnable in a store.

  - `OnHand.Info` (array)
    List of IdValues for the OnHand data for this sku warehouse location combination. This will always be null unless fetched with any of the ProductOnHand methods.

  - `OnHand.Info.Id` (integer)
    The internal Id of the Entity. This Id might be different in different tiers such as Stage and Production. Use Code if hard coding is required.

  - `OnHand.Info.Value` (string)
    The Value of the Entity. MaxLength: max.

  - `OnHand.Info.Code` (string)
    The Code of the Entity, if existing. Use this value when hard coding is required. MaxLength: 255.

## Response 200 fields (application/json):

  - `ProductId` (integer)
    The product internal id for the current product/variant. If the entity is fetched by productId it will be that productId. If the product is fetched by partNo it will be the productId for that variant.

  - `Warehouses` (array)
    A list of warehouses with OnHand for the product.

  - `Warehouses.StoreId` (integer,null)
    The store internal id for the current store. Can be null if WarehouseId and LocationId are supplied.

  - `Warehouses.WarehouseId` (integer,null)
    The internal id for the warehouse. Can be null if StoreId is supplied.

  - `Warehouses.LocationId` (integer,null)
    The internal id for the warehouse location. Can be null if StoreId is supplied.

  - `Warehouses.OnHand` (object)

  - `Warehouses.OnHand.Value` (number)
    The aggregated value from all warehouses and locations in the current context (Web, Supplier or Store).

  - `Warehouses.OnHand.IncomingValue` (number)
    The incoming quantity on the next delivery.

  - `Warehouses.OnHand.NextDeliveryDate` (string,null)
    The next delivery data from supplier to client warehouse.

  - `Warehouses.OnHand.LeadtimeDayCount` (integer,null)
    The number of days it takes to ship from the supplier.

  - `Warehouses.OnHand.LastChecked` (string,null)
    When onHand info was last checked. Null if never.

  - `Warehouses.OnHand.IsActive` (boolean)
    Indicate if the product is stocked in a store.

  - `Warehouses.OnHand.IsReturnable` (boolean)
    Indicate if the product is returnable in a store.

  - `Warehouses.OnHand.Info` (array)
    List of IdValues for the OnHand data for this sku warehouse location combination. This will always be null unless fetched with any of the ProductOnHand methods.

  - `Warehouses.OnHand.Info.Id` (integer)
    The internal Id of the Entity. This Id might be different in different tiers such as Stage and Production. Use Code if hard coding is required.

  - `Warehouses.OnHand.Info.Value` (string)
    The Value of the Entity. MaxLength: max.

  - `Warehouses.OnHand.Info.Code` (string)
    The Code of the Entity, if existing. Use this value when hard coding is required. MaxLength: 255.

  - `Variants` (array)
    An optional list of ProductOnHand for all variants if fetched by productId. Null when fetched for a variant or a basket.