Trader prices and availabilities

Prices and/or availabilities

Prices and/or availabilities for one or more items can be requested by providing a list of items.

See: API endpoint

The request contains the following fields:

Field	Description
onlyAvailabilitiesPreferred (optional)	If set to true, prices are considered optional and might not be contained in the response. This can be used to check if an item is available before choosing a trader for the item. The server can choose not to calculate prices to save computation time. This is mutually exclusive with onlyPricesPreferred.
onlyPricesPreferred (optional)	If set to true, availabilities are considered optional and might not be contained in the response. This can be used to request prices after selecting a trader. The server can choose to not calculate availabilities to save computation time. This is mutually exclusive with onlyAvailabilitiesPreferred.
zipCode (required)	The zip code of the delivery area for checking the availabilities.
country (required)	The country code of the delivery area for checking the availabilities.
items (required and not empty)	A list of items to request prices and/or availabilities for. Note that the same item can be requested multiple times and that the response will contain every requested item. The order of the items in the response is not guaranteed to match the order of the items in the request. Every item must consist of the following fields: position A unique position number itemNumber The trader's item number of the item quantity This must match the trader's price quantity and is used to prevent returning incorrect prices. unit The unit of the item. For possible values refer to Mengeneinheiten . This is only used to validate that the unit matches in order to prevent returning incorrect prices.

Every response will contain the boolean fields success and error. If the request fails as a whole, the response will contain the field message.

A successful response will additionally contain the field items. Every item contains at least the fields position and itemNumber. If the request specified onlyPricesPreferred = true, the fields price and pricePerUnit will be present and filled. If the request specified onlyAvailabilitiesPreferred = true, the field stockInfo will be present and filled. If the request specified neither of the two, all aforementioned fields will be present and filled. priceScales, stockQuantity, and unit are optional and described below.

If requested items are unknown, prices can't be calculated, or some other problem occurs, the response will contain the fields error and message for these items.

The field priceScales contains a list of price scales. Every price scale consists of the fields quantity and pricePerUnit. The quantity is the minimum quantity to reach the price scale. If possible, the response will contain the fields stockQuantity and unit to specify the available quantity.

The field stockInfo can have the following values:

Value	Description
IN_STOCK	The item is in stock and can be dispatched immediately.
LOW_STOCK	The item might be out of stock soon.
REORDERED	The item is currently out of stock, but a new shipment is on its way.
MADE_TO_ORDER	This product is not meant to be in stock. Usually this means the item is low-volume that the supplier only produces it on-demand.
NO_LONGER_AVAILABLE	This item is not manufactured anymore, and the stock is empty.
OUT_OF_STOCK	The item is not in stock and cannot be dispatched immediately.
UNKNOWN	The stock info for this item is unknown.

Prices and availabilities for basket contexts

Prices and availabilities for one or more items can be requested by providing a list of items.

See: API endpoint

The request contains the following fields:

Field	Description
zipCode (required)	The zip code of the delivery area for checking the availabilities.
country (required)	The country code of the delivery area for checking the availabilities.
items (required and not empty)	A list of items to request prices and availabilities for. Note that the same item can be requested multiple times and that the response will contain every requested item. The order of the items in the response is not guaranteed to match the order of the items in the request. If the same item is requested multiple times, the sum of the quantities will be used to determine the active price scale. Every item must consist of the following fields: position A unique position number itemNumber The trader's item number of the item quantity The quantity for which the price should be calculated. priceQuantity This must match the trader's price quantity and is used to prevent returning incorrect prices. unit The unit of the item. For possible values refer to Mengeneinheiten . This is only used to validate that the unit matches in order to prevent returning incorrect prices.

Field

Description

zipCode
(required)

The zip code of the delivery area for checking the availabilities.

country
(required)

The country code of the delivery area for checking the availabilities.

items
(required and not empty)

A list of items to request prices and availabilities for.

Note that the same item can be requested multiple times and that the response will contain every requested item. The order of the items in the response is not guaranteed to match the order of the items in the request. If the same item is requested multiple times, the sum of the quantities will be used to determine the active price scale.

Every item must consist of the following fields:

position: A unique position number
itemNumber: The trader's item number of the item
quantity: The quantity for which the price should be calculated.
priceQuantity: This must match the trader's price quantity and is used to prevent returning incorrect prices.
unit: The unit of the item. For possible values refer to Mengeneinheiten . This is only used to validate that the unit matches in order to prevent returning incorrect prices.

Every response will contain the boolean fields success and error. If the request fails as a whole, the response will contain the field message.

A successful response will additionally contain the field items. Every item contains at least the fields position, itemNumber, price, pricePerUnit, and stockInfo. priceScales, stockQuantity, and unit are optional and described below.

A successful response can additionally contain the field costPositions. It can contain one or many cost positions, that would be applied if the given items would be ordered. It contains e.g. shipping costs. Cost positions contain the fields itemNumber, price and shortText.

If requested items are unknown, prices can't be calculated, or some other problem occurs, the response will contain the fields error and message for these items.

The field stockInfo can have the following values:

Value	Description
IN_STOCK	The item is in stock and can be dispatched immediately.
LOW_STOCK	The item might be out of stock soon, or is below the requested quantity.
REORDERED	The item is currently out of stock, but a new shipment is on its way.
MADE_TO_ORDER	This product is not meant to be in stock. Usually this means the item is low-volume that the supplier only produces it on-demand.
NO_LONGER_AVAILABLE	This item is not manufactured anymore, and the stock is empty.
OUT_OF_STOCK	The item is not in stock and cannot be dispatched immediately.
UNKNOWN	The stock info for this item is unknown.