Beta

The Partner Trading API v1 is in beta — endpoints and response shapes may still change.

Developers
Cru World Wine
API v1 · Read access
Market data

Retrieve a market bid

Retrieve one live bid by its opaque code. Wine identity, price, quantity, and fulfilment requirements are returned together in a single flat object.

GET/market/bids/{code}LIVE
Required scopemarket:readAuthentication requiredTry it
Reconfirm before you act

A missing, expired, own, or malformed bid returns the same R003 / 404 response. A null expiry means unknown, not that the price is valid indefinitely.

How this call works

4 STEPS
  1. Your server

    Pass the code exactly as it was given

    GET/market/bids/{code}

    Codes are opaque: do not parse one, do not shorten one, and URL-encode it as a single path segment. Allow at least 128 characters wherever you store it.

  2. Cru

    Cru returns the bid, flattened

    Wine identity and the price level arrive together in one object rather than nested, because there is only ever one of each here.

    KEEPprice, quantity, expires_at, requirements

  3. Your server

    Treat 404 as “no longer available”

    Missing, expired, filled, your own and malformed all return the same R003 / 404. None of them are worth distinguishing: in every case, go back to the book.

  4. Your server

    Check the requirements against your stock

    local_website_only, landed_stock_only and warehouse_id decide whether what you hold can fill this bid. A null expires_at means unknown, not unlimited.

    KEEPrequirements

Path parameter

REQUIRED
codestringUse the opaque code from a bid in GET /market/bids. URL-encode it as a single path segment.

Response fields

200 OK

Fields returned in the data object.

lwin18string

Full wine, vintage and pack identifier. Match against LWIN18, not LWIN11.

wine_namestring

Cru’s preferred wine name.

vintageinteger | null

The vintage year, or null when unavailable.

pack_sizestring | null

Pack format, for example 6x75cl.

product_urlstring | null

Product URL on the selected market storefront.

condition_statusstring | null

Condition of the stock traded in this market.

currencystring

ISO 4217 currency for every price within this market.

codestring

Opaque bid identifier. Do not parse it or assume a fixed length; allocate at least 128 characters when storing it.

priceinteger

Price in minor units, net of Cru’s commission: the amount a seller receives.

quantityinteger

Displayed quantity available to fill.

is_own_bidboolean

Whether this is your own liquidity. You cannot fill your own bid.

expires_atdate | null

YYYY-MM-DD. Null means the expiry is unknown.

updated_atdatetime

Last update in RFC 3339 UTC.

requirementsobject

local_website_only (same website), landed_stock_only (not in transit), warehouse_id (delivery warehouse, when set).

Errors

An unavailable bid returns R003 / 404. Missing credentials return A001 / 401. Insufficient scope returns A003 / 403. View all error codes →

UP NEXT Build with the PHP SDK

API credentials

Enter the client key and secret issued by Cru. They are kept in memory until you reload or clear them.

Credentials are never included in copied examples, and are redacted from anything the console prints back.

Request API access

Tell us who you are and what you want to build. Cru issues a client key and secret for your organisation, scoped to what you need.

Markets you trade in (choose one or more)

We use what you send here to reply about API access, and for nothing else.