Skip to main content
POST
Add a lot

Authorizations

Authorization
string
header
required

An API key from Settings, API keys. It starts with rc_live_.

Path Parameters

id
string
required

The auction's id.

Body

application/json
name
string
required
lot_number
string | null

Unique within the auction where given.

description
string | null
category
string | null

Your own word. Nothing is fixed.

starting_bid_cents
integer
bid_increment_cents
integer | null

Overrides the auction's for this lot.

fair_market_value_cents
integer | null

What the winner receives is worth, which their receipt states, and three answers are possible. Omit the field, or send null, to say nobody has worked it out: the receipt then says no value has been recorded. Send 0 to say the winner receives nothing of value - a statement you are making, and usually right for a donated service. Send a number for what the winner receives. Omitting it and sending 0 are NOT the same thing.

donor_person_id
string | null

Somebody already on your people list.

donor_credit
string | null

Only when it differs from their name on file.

photo_file_ids
string[]

Up to twelve of your image files, in the order shown; the first is the one on the lot's card. Upload with owner_type auction_item. A file that is not one of your images is refused, naming it.

status
enum<string>

unsold means the auction closed and nobody bid, which is different from withdrawn. Both are set by closing, not by hand.

Available options:
available,
withdrawn,
unsold,
sold
buy_now_cents
integer | null

The price anybody may take the lot at while the bidding is under it. Not under the opening bid or the reserve.

quantity
integer

How many there are. Above one, the lot is sold only at buy_now_cents, a unit or more at a time, with no bidding, and needs buy_now_cents. 1 to 1000; 1 unless set. Not fewer than have been bought.

reserve_cents
integer | null

The least you will sell it for. Never shown on your public site. Bidding that ends under it does not sell the lot, and the high bidder is told. Not on a lot of more than one.

closes_at
string | null

The lot's own close, as an instant. Null closes it with the auction.

fulfillment
enum<string>

How the lot reaches its winner. pickup unless set. Cannot change once the lot is ready, shipped or handed over. A Buy Now purchase goes the way its lot does.

Available options:
pickup,
shipping

Response

The lot.

name
string
required
lot_number
string | null

Unique within the auction where given.

description
string | null
category
string | null

Your own word. Nothing is fixed.

starting_bid_cents
integer
bid_increment_cents
integer | null

Overrides the auction's for this lot.

fair_market_value_cents
integer | null

What the winner receives is worth, which their receipt states, and three answers are possible. Omit the field, or send null, to say nobody has worked it out: the receipt then says no value has been recorded. Send 0 to say the winner receives nothing of value - a statement you are making, and usually right for a donated service. Send a number for what the winner receives. Omitting it and sending 0 are NOT the same thing.

donor_person_id
string | null

Somebody already on your people list.

donor_credit
string | null

Only when it differs from their name on file.

photo_file_ids
string[]

Up to twelve of your image files, in the order shown; the first is the one on the lot's card. Upload with owner_type auction_item. A file that is not one of your images is refused, naming it.

status
enum<string>

unsold means the auction closed and nobody bid, which is different from withdrawn. Both are set by closing, not by hand.

Available options:
available,
withdrawn,
unsold,
sold
buy_now_cents
integer | null

The price anybody may take the lot at while the bidding is under it. Not under the opening bid or the reserve.

quantity
integer

How many there are. Above one, the lot is sold only at buy_now_cents, a unit or more at a time, with no bidding, and needs buy_now_cents. 1 to 1000; 1 unless set. Not fewer than have been bought.

reserve_cents
integer | null

The least you will sell it for. Never shown on your public site. Bidding that ends under it does not sell the lot, and the high bidder is told. Not on a lot of more than one.

closes_at
string | null

The lot's own close, as an instant. Null closes it with the auction.

fulfillment
enum<string>

How the lot reaches its winner. pickup unless set. Cannot change once the lot is ready, shipped or handed over. A Buy Now purchase goes the way its lot does.

Available options:
pickup,
shipping
id
string
auction_id
string
created_at
string
updated_at
string
current_bid_cents
integer | null

What the lot stands at. Null until somebody has bid.

leading_bidder_id
string | null
bid_count
integer
winner_bidder_id
string | null
winning_bid_cents
integer | null

What the lot stood at when the bidding stopped.

closed_at
string | null

When closing decided this lot. Present on a lot with no bids too: closed and undecided are different things.

paid_at
string | null
collected_at
string | null
quantity_sold
integer
quantity_left
integer
reserve_met
boolean | null

Whether the bidding has reached the reserve. Null with no reserve.

reserve_not_met
boolean

The lot closed under its reserve and was not sold.

extended_until
string | null

Where a late bid has moved the lot's close.

bought_from_item_id
string | null

Set on a Buy Now purchase from a lot of several: the lot it was bought from. Such a purchase is a sold row of its own, on the winners list.

bought_quantity
integer | null
bought_now_at
string | null
ready_at
string | null

When a lot picked up was marked ready, and its winner told.

shipped_at
string | null

When a shipped lot was marked shipped, and its winner told.

tracking
string | null

The shipped lot's tracking number.