List bids on one wine
Every live bid on one wine, by LWIN18, as a single market: the bid book’s shape and filters, without paging.
Path parameter
REQUIRED| lwin18string · 18 digits | The wine’s LWIN18. Find one by name with GET /wines. |
Query parameters
ALL OPTIONAL| PARAMETER | DESCRIPTION |
|---|---|
| min_priceinteger · ≥ 0 | Lowest price to include, inclusive, in whole units of the market’s currency — 1200 is 1,200.00. Compared with each bid’s net price converted at the rate of the day it was placed, so near the limit a bid placed in another currency can fall either side of the price shown, which uses today’s. |
| max_priceinteger · ≥ 0 | Highest price to include, inclusive, in whole units of the market’s currency — 1200 is 1,200.00. Compared with each bid’s net price converted at the rate of the day it was placed, so near the limit a bid placed in another currency can fall either side of the price shown, which uses today’s. |
| depthinteger · ≥ 1 | How many bids to return per wine, in book order — bids placed on Cru first, newest first, then other venues’ bids by price, so depth=1 is not always the highest price. Omit it for every bid. Default: every level |
| landed_stock_onlyboolean | true for only bids that require stock that has already landed; false for only bids that do not. Omit it for both. Default: both |
| deliverable_warehousestring · CSV · ≤ 5 | Only bids that stock in any of these warehouses could fill: UK_DRAK, HK_KERRY, SG_TOLL, FR_DARTESS, US_NAPA. Case-insensitive. Pass a portfolio line’s warehouse.deliverable_warehouse_code to see the bids it can fill. Another code is refused with VALIDATION_INVALID_VALUE. |
| include_market_priceboolean | Add market_price — Cru’s market price for the wine, as a number — to each wine. Default: false |
| include_last_tradeboolean | Add last_trade — the last traded price and when — to each wine. Default: false |
When the wine has no live bids — or your filters remove them all — the answer is 200 with bids: [], and the wine is still described. Only a wine Cru does not know is NOT_FOUND / 404.
Response fields
200 OKdata.market is one market, exactly as an item of the bid book.
lwin18string
The 18-digit LWIN: wine, vintage and pack together. Match on all 18 digits.
wine_namestring | null
Cru’s name for the wine.
vintageinteger | null
The vintage year. 1000 means non-vintage.
pack_sizestring | null
Pack format, for example 6x75cl.
product_urlstring | null
The wine’s page on the Cru storefront for the market you called.
currencystring
ISO 4217 currency of every price in this market: the currency of the market you called.
market_pricenumber | null · optional
Only with include_market_price=true: Cru’s market price, in currency. Null when Cru has no price for the wine.
last_tradeobject | null · optional
Only with include_last_trade=true: price, and traded_at. Null when there is none.
Each item in bids[]
codestring
Opaque bid code: BID- and 43 more characters. Do not parse it. Your own bids carry the same code here and in /bids.
pricenumber | null
Net price per unit — what a seller receives after Cru’s commission — converted into the market’s currency at today’s rate, to 2 decimal places. null in the rare case Cru cannot price the bid.
quantityinteger
Units the bid still wants.
is_own_bidboolean
True when the bid is yours. Your own bids are listed, but you cannot sell into one.
expires_atdate | null
YYYY-MM-DD. For bids Cru carries from other venues this is always set two days ahead, not taken from the venue.
updated_atdatetime | null
Last change, RFC 3339 UTC.
requirementsobject
What stock must satisfy to fill the bid: condition_status (always verified — only Verified stock can fill a bid), landed_stock_only, and deliverable_warehouses — the warehouse codes whose stock can fill it.
Errors
A wine Cru does not know returns NOT_FOUND / 404, and an LWIN18 that is not 18 digits VALIDATION_INVALID_VALUE / 422. An unknown query parameter returns VALIDATION_UNKNOWN_PARAMETER / 400. A deliverable_warehouse that is not a Cru warehouse code, or more than 5 of them, returns VALIDATION_INVALID_VALUE / 422 too. A depth, min_price or max_price that is not a whole number in range returns VALIDATION_INVALID_VALUE / 422, and a landed_stock_only, include_market_price or include_last_trade other than true or false VALIDATION_UNSUPPORTED_VALUE / 422. Missing or invalid credentials return AUTH_INVALID_CREDENTIALS / 401. A credential without market:read gets AUTH_INSUFFICIENT_SCOPE / 403. View all error codes →