List external availability on products in basket

Checks the actual on hand status for the products in the basket in the customers back end system. If no backend is configured then this is equal to calling ListProductOnHandByBasket.

Request
query Parameters
basketId
required
integer <int32>

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 Body schema:

An Warehouse if OnHand for a specific store is wanted. If standard warehouse (web) is wanted just pass null.

StoreId
integer or null <int32>

The store internal id for the current store. Can be null if WarehouseId and LocationId are supplied.

WarehouseId
integer or null <int32>

The internal id for the warehouse. Can be null if StoreId is supplied.

LocationId
integer or null <int32>

The internal id for the warehouse location. Can be null if StoreId is supplied.

object <ProductsOnHand> (ProductsOnHand)
Responses
200

Success

400

Bad Request

Key: RemoteCallFailed. Gets raised when the remote call fails.

500

Internal Server Error

post/ShoppingService.svc/rest/ListExternalProductOnHandByBasket
Request samples
{
  • "StoreId": 0,
  • "WarehouseId": 0,
  • "LocationId": 0,
  • "OnHand": {
    }
}
Response samples
[
  • {
    }
]