Beta

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

Developers
Cru World Wine
API v1 · REST & MCP
Your bids

List your bids

Your own bids on every Cru site, newest first — the live ones unless you ask for others — priced in your market’s currency, with what matched and its orders.

GET/bidsLIVE
Required scopebids:readAuthentication requiredTry it

Query parameters

ALL OPTIONAL
PARAMETERDESCRIPTION
statusstring · CSV Comma-separated, e.g. matched,cancelled, from live, matched, complete, cancelled, expired and error, in any case. To see every bid, list all six: there is no all. Anything else is refused with VALIDATION_UNSUPPORTED_VALUE. Default: live
lwinstring · CSV · ≤ 20 Only these wines: up to 20 comma-separated 18-digit LWIN18 codes. Anything else is refused with VALIDATION_INVALID_VALUE.
client_refstring · ≤ 50 chars Only bids with this client_ref, in any case. Older bids may share one.
limitinteger · 1–250 Number of bids to return. A larger value is refused with VALIDATION_INVALID_VALUE, not reduced. Default: 50
offsetinteger · ≥ 0 Number of bids to skip. Default: 0
Live bids only, unless you ask

Without status, only live bids come back. Name the ones you want, such as status=matched,complete, or list all six to see every bid.

Response fields

200 OK · paged

data.bids, newest first. meta.pagination counts bids.

Each item in bids[]

codestring

Opaque bid code, the same one /market/bids shows for this bid.

client_refstring | null

Your own reference, if you gave one when placing the bid.

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.

pricenumber

Gross price per unit you offered — before Cru’s commission — in the currency of the market you called. A bid placed in another currency is converted at today’s rate, as My Bids on Cru shows it.

currencystring

The currency of the market you called, the same for every bid, so one listing never mixes currencies.

bid_currencystring

The currency the bid was placed in, which its price was converted from.

quantityinteger

Total units bid for.

quantity_matchedinteger

Units matched so far.

quantity_openinteger

Units still open: quantity less quantity_matched while live, otherwise 0.

order_numbersarray<string>

The Cru sales order numbers the bid matched into, oldest first. [] if none.

order_urlsarray<string>

Each order’s page on Cru Markets, in the same order as order_numbers, on the site the bid was placed on (its market), not the one you called.

statusstring

live, matched (awaiting invoice), complete, cancelled, expired or error. A live bid past its expiry reports expired.

renewableboolean

Whether POST /bids/{code}/renew takes the bid now. Your allowance is checked only on renewal.

marketstring | null

The Cru site the bid is on, such as uk or hk: the one it was placed on, or last changed through.

local_onlyboolean

Accepts only stock already on that site.

auto_transferboolean

Moves the wine into your storage on that site when the bid fills.

expires_ondate | null

YYYY-MM-DD.

created_atdatetime | null

RFC 3339 UTC.

updated_atdatetime | null

RFC 3339 UTC.

Errors

An lwin that is not 18-digit LWIN18 codes, or more than 20 of them, returns VALIDATION_INVALID_VALUE / 422. A client_ref over 50 characters returns VALIDATION_INVALID_VALUE / 422, and a status other than live, matched, complete, cancelled, expired or error VALIDATION_UNSUPPORTED_VALUE / 422. Missing or invalid credentials return AUTH_INVALID_CREDENTIALS / 401. A credential without bids:read gets AUTH_INSUFFICIENT_SCOPE / 403. View all error codes →

UP NEXT Retrieve one of your bids

API credentials

Enter the client key and secret issued by Cru. They are kept for this browser tab’s session — a reload keeps them, closing the tab or clearing them ends 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. Cloudflare Turnstile checks the form for bots (privacy policy).